Fix spelling and encoding errors in manpages and an error message
[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         int state;
59         char *cp, seqfile[PATH_MAX];
60         char name[NAMESZ], field[BUFSIZ];
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 = FLD;;) {
78                 switch (state = m_getfld(state, name, field, sizeof(field),
79                                 fp)) {
80                 case FLD:
81                 case FLDPLUS:
82                         if (state == FLDPLUS) {
83                                 cp = mh_xstrdup(field);
84                                 while (state == FLDPLUS) {
85                                         state = m_getfld(state, name, field,
86                                                         sizeof(field), fp);
87                                         cp = add(field, cp);
88                                 }
89                                 seq_init(mp, mh_xstrdup(name), trimcpy(cp));
90                                 mh_free0(&cp);
91                         } else {
92                                 seq_init(mp, mh_xstrdup(name), trimcpy(field));
93                         }
94                         continue;
95
96                 case BODY:
97                         adios(EX_CONFIG, NULL, "no blank lines are permitted in %s",
98                                         seqfile);
99                         /* fall */
100
101                 case FILEEOF:
102                         break;
103
104                 default:
105                         adios(EX_CONFIG, NULL, "%s is poorly formatted", seqfile);
106                 }
107                 break;  /* break from for loop */
108         }
109
110         lkfclose(fp, seqfile);
111 }
112
113
114 /*
115 ** Scan profile/context list for private sequences.
116 **
117 ** We search the context list for all keys that look like
118 ** "atr-seqname-folderpath", and add them as private sequences.
119 */
120
121 static void
122 seq_private(struct msgs *mp)
123 {
124         int i, j, alen, plen;
125         char *cp;
126         struct node *np;
127
128         alen = strlen("atr-");
129         plen = strlen(mp->foldpath) + 1;
130
131         for (np = m_defs; np; np = np->n_next) {
132                 if (strncmp(np->n_name, "atr-", alen)==0 &&
133                                 (j = strlen(np->n_name) - plen) > alen &&
134                                 *(np->n_name + j) == '-' &&
135                                 strcmp(mp->foldpath, np->n_name + j + 1)==0) {
136                         cp = mh_xstrdup(np->n_name + alen);
137                         *(cp + j - alen) = '\0';
138                         if ((i = seq_init(mp, cp, mh_xstrdup(np->n_field))) != -1)
139                                 make_seq_private(mp, i);
140                 }
141         }
142 }
143
144
145 /*
146 ** Add the name of sequence to the list of folder sequences.
147 ** Then parse the list of message ranges for this
148 ** sequence, and setup the various bit flags for each
149 ** message in the sequence.
150 **
151 ** Return internal index for the sequence if successful.
152 ** Return -1 on error.
153 */
154
155 static int
156 seq_init(struct msgs *mp, char *name, char *field)
157 {
158         unsigned int i;
159         int j, k, is_current;
160         char *cp, **ap;
161
162         /*
163         ** Check if this is the cur sequence,
164         ** so we can do some special things.
165         */
166         is_current = (strcmp(seq_cur, name)==0);
167
168         /*
169         ** Search for this sequence name to see if we've seen
170         ** it already.  If we've seen this sequence before,
171         ** then clear the bit for this sequence from all the
172         ** mesages in this folder.
173         */
174         for (i = 0; mp->msgattrs[i]; i++) {
175                 if (strcmp(mp->msgattrs[i], name)==0) {
176                         for (j = mp->lowmsg; j <= mp->hghmsg; j++)
177                                 clear_sequence(mp, i, j);
178                         break;
179                 }
180         }
181
182         /* Return error, if too many sequences */
183         if (i >= NUMATTRS) {
184                 mh_free0(&name);
185                 mh_free0(&field);
186                 return -1;
187         }
188
189         /*
190         ** If we've already seen this sequence name, just free the
191         ** name string.  Else add it to the list of sequence names.
192         */
193         if (mp->msgattrs[i]) {
194                 mh_free0(&name);
195         } else {
196                 mp->msgattrs[i] = name;
197                 mp->msgattrs[i + 1] = NULL;
198         }
199
200         /*
201         ** Split up the different message ranges at whitespace
202         */
203         for (ap = brkstring(field, " ", "\n"); *ap; ap++) {
204                 if ((cp = strchr(*ap, '-')))
205                         *cp++ = '\0';
206                 if ((j = m_atoi(*ap)) > 0) {
207                         k = cp ? m_atoi(cp) : j;
208
209                         /*
210                         ** Keep mp->curmsg and cur sequence in sync.  Unlike
211                         ** other sequences, this message doesn't need to exist.
212                         ** Think about the series of command (rmm; next) to
213                         ** understand why this can be the case.  But if it does
214                         ** exist, we will still set the bit flag for it like
215                         ** other sequences.
216                         */
217                         if (is_current)
218                                 mp->curmsg = j;
219                         /*
220                         ** We iterate through messages in this range
221                         ** and flip on bit for this sequence.
222                         */
223                         for (; j <= k; j++) {
224                                 if (j >= mp->lowmsg && j <= mp->hghmsg &&
225                                                 does_exist(mp, j))
226                                         add_sequence(mp, i, j);
227                         }
228                 }
229         }
230
231         mh_free0(&field);  /* free string containing message ranges */
232         return i;
233 }