indent -kr -i8 -brf -bbb -fnc -l132 -nce on all of webcit-classic
[citadel.git] / webcit / siteconfig.c
1
2 /*
3  * Administrative screen for site-wide configuration
4  *
5  * Copyright (c) 1996-2021 by the citadel.org team
6  *
7  * This program is open source software.  You can redistribute it and/or
8  * modify it under the terms of the GNU General Public License, version 3.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  */
15
16 #include "webcit.h"
17 #include "webserver.h"
18
19 /*
20  * Expiry policy for the autopurger
21  */
22 #define EXPIRE_NEXTLEVEL        0       /* Inherit expiration policy    */
23 #define EXPIRE_MANUAL           1       /* Don't expire messages at all */
24 #define EXPIRE_NUMMSGS          2       /* Keep only latest n messages  */
25 #define EXPIRE_AGE              3       /* Expire messages after n days */
26
27 CtxType CTX_SRVLOG = CTX_NONE;
28
29 HashList *ZoneHash = NULL;
30
31 ConstStr ExpirePolicyString = { CStrOf(roompolicy) };
32
33 ConstStr ExpirePolicyStrings[][2] = {
34         { { CStrOf(roompolicy)}, { strof(roompolicy) "_value", sizeof(strof(roompolicy) "_value") - 1}
35           },
36         { { CStrOf(floorpolicy)}, { strof(floorpolicy) "_value", sizeof(strof(floorpolicy) "_value") - 1}
37           },
38         { { CStrOf(sitepolicy)}, { strof(sitepolicy) "_value", sizeof(strof(sitepolicy) "_value") - 1}
39           },
40         { { CStrOf(mailboxespolicy)}, { strof(mailboxespolicy) "_value", sizeof(strof(mailboxespolicy) "_value") - 1}
41           }
42 };
43
44
45 void LoadExpirePolicy(GPEXWhichPolicy which) {
46         StrBuf *Buf;
47         long State;
48         const char *Pos = NULL;
49
50         serv_printf("GPEX %s", ExpirePolicyStrings[which][0].Key);
51         Buf = NewStrBuf();
52         StrBuf_ServGetln(Buf);
53         if (GetServerStatus(Buf, &State) == 2) {
54                 Pos = ChrPtr(Buf) + 4;
55                 WC->Policy[which].expire_mode = StrBufExtractNext_long(Buf, &Pos, '|');
56                 WC->Policy[which].expire_value = StrBufExtractNext_long(Buf, &Pos, '|');
57         }
58         else if (State == 550)
59                 AppendImportantMessage(_("Higher access is required to access this function."), -1);
60         FreeStrBuf(&Buf);
61 }
62
63
64 void SaveExpirePolicyFromHTTP(GPEXWhichPolicy which) {
65         StrBuf *Buf;
66         long State;
67
68         serv_printf("SPEX %s|%d|%d",
69                     ExpirePolicyStrings[which][0].Key,
70                     ibcstr(ExpirePolicyStrings[which][1]), ibcstr(ExpirePolicyStrings[which][1]));
71
72         Buf = NewStrBuf();
73         StrBuf_ServGetln(Buf);
74         GetServerStatus(Buf, &State);
75         if (State == 550)
76                 AppendImportantMessage(_("Higher access is required to access this function."), -1);
77         FreeStrBuf(&Buf);
78 }
79
80
81 int ConditionalExpire(StrBuf * Target, WCTemplputParams * TP) {
82         GPEXWhichPolicy which;
83         int CompareWith;
84
85         which = GetTemplateTokenNumber(Target, TP, 2, 0);
86         CompareWith = GetTemplateTokenNumber(Target, TP, 3, 0);
87
88         LoadExpirePolicy(which);
89
90         return WC->Policy[which].expire_mode == CompareWith;
91 }
92
93
94 void tmplput_ExpireValue(StrBuf * Target, WCTemplputParams * TP) {
95         GPEXWhichPolicy which;
96
97         which = GetTemplateTokenNumber(Target, TP, 0, 0);
98         LoadExpirePolicy(which);
99         StrBufAppendPrintf(Target, "%d", WC->Policy[which].expire_value);
100 }
101
102
103 void tmplput_ExpireMode(StrBuf * Target, WCTemplputParams * TP) {
104         GPEXWhichPolicy which;
105
106         which = GetTemplateTokenNumber(Target, TP, 2, 0);
107         LoadExpirePolicy(which);
108         StrBufAppendPrintf(Target, "%d", WC->Policy[which].expire_mode);
109 }
110
111
112 void LoadZoneFiles(void) {
113         icalarray *zones;
114         int z;
115         long len;
116         const char *this_zone;
117         StrBuf *ZName;
118
119         ZoneHash = NewHash(1, NULL);
120         ZName = NewStrBufPlain(HKEY("UTC"));
121         Put(ZoneHash, HKEY("UTC"), ZName, HFreeStrBuf);
122         zones = icaltimezone_get_builtin_timezones();
123         for (z = 0; z < zones->num_elements; ++z) {
124                 /* syslog(LOG_DEBUG, "Location: %-40s tzid: %s\n",
125                    icaltimezone_get_location(icalarray_element_at(zones, z)),
126                    icaltimezone_get_tzid(icalarray_element_at(zones, z))
127                    ); */
128                 this_zone = icaltimezone_get_location(icalarray_element_at(zones, z));
129                 len = strlen(this_zone);
130                 ZName = NewStrBufPlain(this_zone, len);
131                 Put(ZoneHash, this_zone, len, ZName, HFreeStrBuf);
132         }
133         SortByHashKey(ZoneHash, 0);
134 }
135
136
137 typedef struct _CfgMapping {
138         int type;
139         int min;
140         int max;
141         const char *defval;
142         const char *Key;
143         long len;
144 } CfgMapping;
145
146 #define CFG_STR 1
147 #define CFG_YES 2
148 #define CFG_NO 3
149 #define CFG_INT 4
150
151 CfgMapping ServerConfig[] = {
152         { CFG_STR, 0, 0, "", HKEY("c_nodename") },
153         { CFG_STR, 0, 0, "", HKEY("c_fqdn") },
154         { CFG_STR, 0, 0, "", HKEY("c_humannode") },
155         { CFG_STR, 0, 0, "", HKEY("c_phonenum") },
156         { CFG_YES, 0, 0, "", HKEY("c_creataide") },
157         { CFG_STR, 0, 0, "", HKEY("c_sleeping") },
158         { CFG_STR, 0, 0, "", HKEY("c_initax") },
159         { CFG_YES, 0, 0, "", HKEY("c_regiscall") },
160         { CFG_YES, 0, 0, "", HKEY("c_twitdetect") },
161         { CFG_STR, 0, 0, "", HKEY("c_twitroom") },
162         { CFG_STR, 0, 0, "", HKEY("c_moreprompt") },
163         { CFG_YES, 0, 0, "", HKEY("c_restrict") },
164         { CFG_STR, 0, 0, "", HKEY("c_bbs_city") },
165         { CFG_STR, 0, 0, "", HKEY("c_sysadm") },
166         { CFG_STR, 0, 0, "", HKEY("c_maxsessions") },
167         { CFG_STR, 0, 0, "", HKEY("reserved1") },
168         { CFG_STR, 0, 0, "", HKEY("c_userpurge") },
169         { CFG_STR, 0, 0, "", HKEY("c_roompurge") },
170         { CFG_STR, 0, 0, "", HKEY("c_logpages") },
171         { CFG_STR, 0, 0, "", HKEY("c_createax") },
172         { CFG_STR, 0, 0, "", HKEY("c_maxmsglen") },
173         { CFG_STR, 0, 0, "", HKEY("c_min_workers") },
174         { CFG_STR, 0, 0, "", HKEY("c_max_workers") },
175         { CFG_STR, 0, 0, "", HKEY("c_pop3_port") },
176         { CFG_STR, 0, 0, "", HKEY("c_smtp_port") },
177         { CFG_INT, CFG_SMTP_FROM_FILTERALL, CFG_SMTP_FROM_REJECT, "0", HKEY("c_rfc822_strict_from") },
178         { CFG_YES, 0, 0, "", HKEY("c_aide_zap") },
179         { CFG_STR, 0, 0, "", HKEY("c_imap_port") },
180         { CFG_STR, 0, 0, "", HKEY("c_net_freq") },
181         { CFG_YES, 0, 0, "", HKEY("c_disable_newu") },
182         { CFG_STR, 0, 0, "", HKEY("reserved2") },
183         { CFG_STR, 0, 0, "", HKEY("c_purge_hour") },
184         { CFG_STR, 0, 0, "", HKEY("c_ldap_host") },
185         { CFG_STR, 0, 0, "", HKEY("c_ldap_port") },
186         { CFG_STR, 0, 0, "", HKEY("c_ldap_base_dn") },
187         { CFG_STR, 0, 0, "", HKEY("c_ldap_bind_dn") },
188         { CFG_STR, 0, 0, "", HKEY("c_ldap_bind_pw") },
189         { CFG_STR, 0, 0, "", HKEY("c_ip_addr") },
190         { CFG_STR, 0, 0, "", HKEY("c_msa_port") },
191         { CFG_STR, 0, 0, "", HKEY("c_imaps_port") },
192         { CFG_STR, 0, 0, "", HKEY("c_pop3s_port") },
193         { CFG_STR, 0, 0, "", HKEY("c_smtps_port") },
194         { CFG_YES, 0, 0, "", HKEY("c_enable_fulltext") },
195         { CFG_YES, 0, 0, "", HKEY("c_auto_cull") },
196         { CFG_YES, 0, 0, "", HKEY("reserved3") },
197         { CFG_YES, 0, 0, "", HKEY("c_allow_spoofing") },
198         { CFG_YES, 0, 0, "", HKEY("c_journal_email") },
199         { CFG_YES, 0, 0, "", HKEY("c_journal_pubmsgs") },
200         { CFG_STR, 0, 0, "", HKEY("c_journal_dest") },
201         { CFG_STR, 0, 0, "", HKEY("c_default_cal_zone") },
202         { CFG_STR, 0, 0, "", HKEY("c_pftcpdict_port") },
203         { CFG_STR, 0, 0, "", HKEY("c_mgesve_port") },
204         { CFG_STR, 0, 0, "", HKEY("c_auth_mode") },
205         { CFG_STR, 0, 0, "", HKEY("c_funambol_host") },
206         { CFG_STR, 0, 0, "", HKEY("c_funambol_port") },
207         { CFG_STR, 0, 0, "", HKEY("c_funambol_source") },
208         { CFG_STR, 0, 0, "", HKEY("c_funambol_auth") },
209         { CFG_YES, 0, 0, "", HKEY("c_rbl_at_greeting") },
210         { CFG_STR, 0, 0, "", HKEY("c_master_user") },
211         { CFG_STR, 0, 0, "", HKEY("c_master_pass") },
212         { CFG_STR, 0, 0, "", HKEY("c_pager_program") },
213         { CFG_YES, 0, 0, "", HKEY("c_imap_keep_from") },
214         { CFG_STR, 0, 0, "", HKEY("c_xmpp_c2s_port") },
215         { CFG_STR, 0, 0, "", HKEY("c_xmpp_s2s_port") },
216         { CFG_STR, 0, 0, "", HKEY("c_pop3_fetch") },
217         { CFG_STR, 0, 0, "", HKEY("c_pop3_fastest") },
218         { CFG_YES, 0, 0, "", HKEY("c_spam_flag_only") },
219         { CFG_YES, 0, 0, "", HKEY("c_guest_logins") },
220         { CFG_STR, 0, 0, "", HKEY("c_port_number") },
221         { CFG_STR, 0, 0, "", HKEY("c_ctdluid") },
222         { CFG_STR, 0, 0, "", HKEY("c_nntp_port") },
223         { CFG_STR, 0, 0, "", HKEY("c_nntps_port") }
224 };
225
226
227 /*
228  *  display all configuration items
229  */
230 void load_siteconfig(void) {
231         StrBuf *Buf;
232         HashList *Cfg;
233         long len;
234         int i, j;
235
236         if (WC->ServCfg == NULL)
237                 WC->ServCfg = NewHash(1, NULL);
238         Cfg = WC->ServCfg;
239
240         Buf = NewStrBuf();
241
242         serv_printf("CONF get");
243         StrBuf_ServGetln(Buf);
244         if (GetServerStatus(Buf, NULL) != 1) {
245                 StrBufCutLeft(Buf, 4);
246                 AppendImportantMessage(SKEY(Buf));
247                 FreeStrBuf(&Buf);
248                 return;
249
250         }
251         j = i = 0;
252         while (len = StrBuf_ServGetln(Buf), (len >= 0) && ((len != 3) || strcmp(ChrPtr(Buf), "000"))) {
253                 if (i < (sizeof(ServerConfig) / sizeof(CfgMapping))) {
254                         Put(Cfg, ServerConfig[i].Key, ServerConfig[i].len, Buf, HFreeStrBuf);
255                         i++;
256                         Buf = NewStrBuf();
257                 }
258                 else {
259                         if (j == 0) {
260                                 syslog(LOG_WARNING,
261                                        "The server sent more configuration data than this version of webcit is capable of changing.  Unknown configuration values will remain unchanged.");
262                         }
263                         j++;
264                 }
265         }
266         FreeStrBuf(&Buf);
267
268         LoadExpirePolicy(roompolicy);
269         LoadExpirePolicy(floorpolicy);
270         LoadExpirePolicy(mailboxespolicy);
271         LoadExpirePolicy(sitepolicy);
272 }
273
274
275 /*
276  * parse siteconfig changes 
277  */
278 void siteconfig(void) {
279         int i, value;
280         StrBuf *Line;
281
282         if (strlen(bstr("ok_button")) == 0) {
283                 display_aide_menu();
284                 return;
285         }
286         Line = NewStrBuf();
287         serv_printf("CONF set");
288         StrBuf_ServGetln(Line);
289         if (GetServerStatusMsg(Line, NULL, 1, 4) != 4) {
290                 display_aide_menu();
291                 FreeStrBuf(&Line);
292                 return;
293         }
294
295         FreeStrBuf(&Line);
296
297         for (i = 0; i < (sizeof(ServerConfig) / sizeof(CfgMapping)); i++) {
298                 switch (ServerConfig[i].type) {
299                 default:
300                 case CFG_STR:
301                         serv_putbuf(SBstr(ServerConfig[i].Key, ServerConfig[i].len));
302                         break;
303                 case CFG_YES:
304                         serv_puts(YesBstr(ServerConfig[i].Key, ServerConfig[i].len) ? "1" : "0");
305                         break;
306                 case CFG_NO:
307                         serv_puts(YesBstr(ServerConfig[i].Key, ServerConfig[i].len) ? "0" : "1");
308                         break;
309                 case CFG_INT:
310                         value = IBstr(ServerConfig[i].Key, ServerConfig[i].len);
311                         if ((value < ServerConfig[i].min) || (value > ServerConfig[i].max))
312                                 value = atol(ServerConfig[i].defval);
313                         serv_printf("%d", value);
314                         break;
315                 }
316         }
317         serv_puts("000");
318
319         SaveExpirePolicyFromHTTP(sitepolicy);
320         SaveExpirePolicyFromHTTP(mailboxespolicy);
321
322         FreeStrBuf(&WC->serv_info->serv_default_cal_zone);
323         WC->serv_info->serv_default_cal_zone = NewStrBufDup(sbstr("c_default_cal_zone"));
324
325         AppendImportantMessage(_("Your system configuration has been updated."), -1);
326         DeleteHash(&WC->ServCfg);
327         display_aide_menu();
328 }
329
330
331 // if WebCit Classic wasn't obsolete we would replace this with a "CONF GETVAL" type of thing
332 void tmplput_servcfg(StrBuf * Target, WCTemplputParams * TP) {
333         void *vBuf;
334         StrBuf *Buf;
335
336         if (WC->is_aide) {
337                 if (WC->ServCfg == NULL)
338                         load_siteconfig();
339                 GetHash(WC->ServCfg, TKEY(0), &vBuf);
340                 Buf = (StrBuf *) vBuf;
341                 StrBufAppendTemplate(Target, TP, Buf, 1);
342         }
343 }
344
345
346 int ConditionalServCfg(StrBuf * Target, WCTemplputParams * TP) {
347         void *vBuf;
348         StrBuf *Buf;
349
350         if (WC->is_aide) {
351                 if (WC->ServCfg == NULL)
352                         load_siteconfig();
353                 GetHash(WC->ServCfg, TKEY(2), &vBuf);
354                 if (vBuf == NULL)
355                         return 0;
356                 Buf = (StrBuf *) vBuf;
357                 if (TP->Tokens->nParameters == 3) {
358                         return 1;
359                 }
360                 else if (IS_NUMBER(TP->Tokens->Params[3]->Type))
361                         return (StrTol(Buf) == GetTemplateTokenNumber(Target, TP, 3, 0));
362                 else {
363                         const char *pch;
364                         long len;
365
366                         GetTemplateTokenString(Target, TP, 3, &pch, &len);
367
368                         return ((len == StrLength(Buf)) && (strcmp(pch, ChrPtr(Buf)) == 0));
369                 }
370
371         }
372         else
373                 return 0;
374 }
375
376 int ConditionalServCfgCTXStrBuf(StrBuf * Target, WCTemplputParams * TP) {
377         void *vBuf;
378         StrBuf *Buf;
379         StrBuf *ZoneToCheck = (StrBuf *) CTX(CTX_STRBUF);
380
381         if ((WC->is_aide) || (ZoneToCheck == NULL)) {
382                 if (WC->ServCfg == NULL)
383                         load_siteconfig();
384                 GetHash(WC->ServCfg, TKEY(2), &vBuf);
385                 if (vBuf == NULL)
386                         return 0;
387                 Buf = (StrBuf *) vBuf;
388
389                 return strcmp(ChrPtr(Buf), ChrPtr(ZoneToCheck)) == 0;
390         }
391         else
392                 return 0;
393 }
394
395 /*----------------------------------------------------------------------------*
396  *              Displaying Logging                                            *
397  *----------------------------------------------------------------------------*/
398 typedef struct __LogStatusStruct {
399         int Enable;
400         StrBuf *Name;
401 } LogStatusStruct;
402
403 void DeleteLogStatusStruct(void *v) {
404         LogStatusStruct *Stat = (LogStatusStruct *) v;
405
406         FreeStrBuf(&Stat->Name);
407         free(Stat);
408 }
409
410 void tmplput_servcfg_LogName(StrBuf * Target, WCTemplputParams * TP) {
411         LogStatusStruct *Stat = (LogStatusStruct *) CTX(CTX_SRVLOG);
412         StrBufAppendTemplate(Target, TP, Stat->Name, 1);
413 }
414
415
416
417 int ConditionalServCfgThisLogEnabled(StrBuf * Target, WCTemplputParams * TP) {
418         LogStatusStruct *Stat = (LogStatusStruct *) CTX(CTX_SRVLOG);
419         return Stat->Enable;
420 }
421
422 HashList *iterate_GetSrvLogEnable(StrBuf * Target, WCTemplputParams * TP) {
423         HashList *Hash = NULL;
424         StrBuf *Buf;
425         LogStatusStruct *Stat;
426         const char *Pos;
427         int Done = 0;
428         long len;
429         int num_logs = 0;
430
431         serv_puts("LOGP");
432         Buf = NewStrBuf();
433         StrBuf_ServGetln(Buf);
434         if (GetServerStatus(Buf, NULL) == 1) {
435                 Hash = NewHash(1, Flathash);
436                 while (!Done) {
437                         len = StrBuf_ServGetln(Buf);
438                         if ((len < 0) || ((len == 3) && !strcmp(ChrPtr(Buf), "000"))) {
439                                 Done = 1;
440                                 break;
441                         }
442                         Stat = (LogStatusStruct *) malloc(sizeof(LogStatusStruct));
443                         Pos = NULL;
444                         Stat->Name = NewStrBufPlain(NULL, len);
445                         StrBufExtract_NextToken(Stat->Name, Buf, &Pos, '|');
446                         Stat->Enable = StrBufExtractNext_int(Buf, &Pos, '|');
447
448                         Put(Hash, IKEY(num_logs), Stat, DeleteLogStatusStruct);
449                         num_logs++;
450                 }
451         }
452         FreeStrBuf(&Buf);
453         return Hash;
454 }
455
456
457 void InitModule_SITECONFIG(void) {
458         RegisterCTX(CTX_SRVLOG);
459         WebcitAddUrlHandler(HKEY("siteconfig"), "", 0, siteconfig, CTX_NONE);
460
461         RegisterNamespace("SERV:CFG", 1, 2, tmplput_servcfg, NULL, CTX_NONE);
462         RegisterConditional("COND:SERVCFG", 3, ConditionalServCfg, CTX_NONE);
463         RegisterConditional("COND:SERVCFG:CTXSTRBUF", 4, ConditionalServCfgCTXStrBuf, CTX_STRBUF);
464         RegisterIterator("PREF:ZONE", 0, ZoneHash, NULL, NULL, NULL, CTX_STRBUF, CTX_NONE, IT_NOFLAG);
465
466         REGISTERTokenParamDefine(roompolicy);
467         REGISTERTokenParamDefine(floorpolicy);
468         REGISTERTokenParamDefine(sitepolicy);
469         REGISTERTokenParamDefine(mailboxespolicy);
470
471         REGISTERTokenParamDefine(EXPIRE_NEXTLEVEL);
472         REGISTERTokenParamDefine(EXPIRE_MANUAL);
473         REGISTERTokenParamDefine(EXPIRE_NUMMSGS);
474         REGISTERTokenParamDefine(EXPIRE_AGE);
475
476         REGISTERTokenParamDefine(CFG_SMTP_FROM_FILTERALL);
477         REGISTERTokenParamDefine(CFG_SMTP_FROM_NOFILTER);
478         REGISTERTokenParamDefine(CFG_SMTP_FROM_CORRECT);
479         REGISTERTokenParamDefine(CFG_SMTP_FROM_REJECT);
480
481         RegisterConditional("COND:EXPIRE:MODE", 2, ConditionalExpire, CTX_NONE);
482         RegisterNamespace("EXPIRE:VALUE", 1, 2, tmplput_ExpireValue, NULL, CTX_NONE);
483         RegisterNamespace("EXPIRE:MODE", 1, 2, tmplput_ExpireMode, NULL, CTX_NONE);
484         RegisterConditional("COND:SERVCFG:THISLOGENABLE", 4, ConditionalServCfgThisLogEnabled, CTX_SRVLOG);
485         RegisterIterator("SERVCFG:LOGENABLE", 0, NULL, iterate_GetSrvLogEnable, NULL, DeleteHash, CTX_SRVLOG, CTX_NONE, IT_NOFLAG);
486         RegisterNamespace("SERVCFG:LOGNAME", 0, 1, tmplput_servcfg_LogName, NULL, CTX_SRVLOG);
487 }
488
489 void ServerStartModule_SITECONFIG(void) {
490         LoadZoneFiles();
491 }
492
493 void ServerShutdownModule_SITECONFIG(void) {
494         DeleteHash(&ZoneHash);
495 }
496
497
498 void SessionDestroyModule_SITECONFIG(wcsession * sess) {
499         DeleteHash(&sess->ServCfg);
500 }