1fdccf96211d8d558919eabde3c0145f45b4b769
[mmh] / sbr / seq_read.c
1 /*
2 ** seq_read.c -- read the .mh_sequence file and
3 **            -- initialize sequence information
4 **
5 ** This code is Copyright (c) 2002, by the authors of nmh.  See the
6 ** COPYRIGHT file in the root directory of the nmh distribution for
7 ** complete copyright information.
8 */
9
10 #include <sysexits.h>
11 #include <h/mh.h>
12 #include <h/utils.h>
13
14 /*
15 ** static prototypes
16 */
17 static int seq_init(struct msgs *, char *, char *);
18 static void seq_public(struct msgs *);
19 static void seq_private(struct msgs *);
20
21
22 /*
23 ** Get the sequence information for this folder from
24 ** .mh_sequences (or equivalent specified in .mh_profile)
25 ** or context file (for private sequences).
26 */
27
28 void
29 seq_read(struct msgs *mp)
30 {
31         /*
32         ** Initialize the list of sequence names.  Go ahead and
33         ** add the cur sequence to the list of sequences.
34         */
35         mp->msgattrs[0] = mh_xstrdup(seq_cur);
36         mp->msgattrs[1] = NULL;
37         make_all_public(mp);  /* initially, make all public */
38
39         /* If folder is empty, don't scan for sequence information */
40         if (mp->nummsg == 0)
41                 return;
42
43         /* Initialize the public sequences */
44         seq_public(mp);
45
46         /* Initialize the private sequences */
47         seq_private(mp);
48 }
49
50
51 /*
52 ** read folder's sequences file for public sequences
53 */
54
55 static void
56 seq_public(struct msgs *mp)
57 {
58         enum state state;
59         struct field f = {{0}};
60         char seqfile[PATH_MAX];
61         FILE *fp;
62
63         /*
64         ** If public sequences are disabled (e.g. the user has defined
65         ** an empty `Mh-Sequences' profile entry), then just return.
66         */
67         if (mh_seq == NULL || *mh_seq == '\0')
68                 return;
69
70         /* get filename of sequence file */
71         snprintf(seqfile, sizeof(seqfile), "%s/%s", mp->foldpath, mh_seq);
72
73         if ((fp = lkfopen(seqfile, "r")) == NULL)
74                 return;
75
76         /* Use m_getfld to scan sequence file */
77         for (state = FLD2;;) {
78                 switch (state = m_getfld2(state, &f, fp)) {
79                 case FLD2:
80                         seq_init(mp, mh_xstrdup(f.name), trimcpy(f.value));
81                         continue;
82
83                 case BODY2:
84                         adios(EX_CONFIG, NULL, "no blank lines are permitted in %s",
85                                         seqfile);
86                         /* FALL */
87
88                 case FILEEOF2:
89                         break;
90
91                 default:
92                         adios(EX_CONFIG, NULL, "%s is poorly formatted", seqfile);
93                 }
94                 break;
95         }
96
97         lkfclose(fp, seqfile);
98 }
99
100
101 /*
102 ** Scan profile/context list for private sequences.
103 **
104 ** We search the context list for all keys that look like
105 ** "atr-seqname-folderpath", and add them as private sequences.
106 */
107
108 static void
109 seq_private(struct msgs *mp)
110 {
111         int i, j, alen, plen;
112         char *cp;
113         struct node *np;
114
115         alen = strlen("atr-");
116         plen = strlen(mp->foldpath) + 1;
117
118         for (np = m_defs; np; np = np->n_next) {
119                 if (strncmp(np->n_name, "atr-", alen)==0 &&
120                                 (j = strlen(np->n_name) - plen) > alen &&
121                                 *(np->n_name + j) == '-' &&
122                                 strcmp(mp->foldpath, np->n_name + j + 1)==0) {
123                         cp = mh_xstrdup(np->n_name + alen);
124                         *(cp + j - alen) = '\0';
125                         if ((i = seq_init(mp, cp, mh_xstrdup(np->n_field))) != -1)
126                                 make_seq_private(mp, i);
127                 }
128         }
129 }
130
131
132 /*
133 ** Add the name of sequence to the list of folder sequences.
134 ** Then parse the list of message ranges for this
135 ** sequence, and setup the various bit flags for each
136 ** message in the sequence.
137 **
138 ** Return internal index for the sequence if successful.
139 ** Return -1 on error.
140 */
141
142 static int
143 seq_init(struct msgs *mp, char *name, char *field)
144 {
145         unsigned int i;
146         int j, k, is_current;
147         char *cp, **ap;
148
149         /*
150         ** Check if this is the cur sequence,
151         ** so we can do some special things.
152         */
153         is_current = (strcmp(seq_cur, name)==0);
154
155         /*
156         ** Search for this sequence name to see if we've seen
157         ** it already.  If we've seen this sequence before,
158         ** then clear the bit for this sequence from all the
159         ** mesages in this folder.
160         */
161         for (i = 0; mp->msgattrs[i]; i++) {
162                 if (strcmp(mp->msgattrs[i], name)==0) {
163                         for (j = mp->lowmsg; j <= mp->hghmsg; j++)
164                                 clear_sequence(mp, i, j);
165                         break;
166                 }
167         }
168
169         /* Return error, if too many sequences */
170         if (i >= NUMATTRS) {
171                 mh_free0(&name);
172                 mh_free0(&field);
173                 return -1;
174         }
175
176         /*
177         ** If we've already seen this sequence name, just free the
178         ** name string.  Else add it to the list of sequence names.
179         */
180         if (mp->msgattrs[i]) {
181                 mh_free0(&name);
182         } else {
183                 mp->msgattrs[i] = name;
184                 mp->msgattrs[i + 1] = NULL;
185         }
186
187         /*
188         ** Split up the different message ranges at whitespace
189         */
190         for (ap = brkstring(field, " ", "\n"); *ap; ap++) {
191                 if ((cp = strchr(*ap, '-')))
192                         *cp++ = '\0';
193                 if ((j = m_atoi(*ap)) > 0) {
194                         k = cp ? m_atoi(cp) : j;
195
196                         /*
197                         ** Keep mp->curmsg and cur sequence in sync.  Unlike
198                         ** other sequences, this message doesn't need to exist.
199                         ** Think about the series of command (rmm; next) to
200                         ** understand why this can be the case.  But if it does
201                         ** exist, we will still set the bit flag for it like
202                         ** other sequences.
203                         */
204                         if (is_current)
205                                 mp->curmsg = j;
206                         /*
207                         ** We iterate through messages in this range
208                         ** and flip on bit for this sequence.
209                         */
210                         for (; j <= k; j++) {
211                                 if (j >= mp->lowmsg && j <= mp->hghmsg &&
212                                                 does_exist(mp, j))
213                                         add_sequence(mp, i, j);
214                         }
215                 }
216         }
217
218         mh_free0(&field);  /* free string containing message ranges */
219         return i;
220 }