2 * Administrative screen for site-wide configuration
4 * Copyright (c) 1996-2021 by the citadel.org team
6 * This program is open source software. You can redistribute it and/or
7 * modify it under the terms of the GNU General Public License, version 3.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
16 #include "webserver.h"
19 * Expiry policy for the autopurger
21 #define EXPIRE_NEXTLEVEL 0 /* Inherit expiration policy */
22 #define EXPIRE_MANUAL 1 /* Don't expire messages at all */
23 #define EXPIRE_NUMMSGS 2 /* Keep only latest n messages */
24 #define EXPIRE_AGE 3 /* Expire messages after n days */
26 CtxType CTX_SRVLOG = CTX_NONE;
28 HashList *ZoneHash = NULL;
30 ConstStr ExpirePolicyString = {CStrOf(roompolicy) };
32 ConstStr ExpirePolicyStrings[][2] = {
33 { { CStrOf(roompolicy) } , { strof(roompolicy) "_value", sizeof(strof(roompolicy) "_value") - 1 } },
34 { { CStrOf(floorpolicy) } , { strof(floorpolicy) "_value", sizeof(strof(floorpolicy) "_value") - 1 } },
35 { { CStrOf(sitepolicy) } , { strof(sitepolicy) "_value", sizeof(strof(sitepolicy) "_value") - 1 } },
36 { { CStrOf(mailboxespolicy)} , { strof(mailboxespolicy)"_value", sizeof(strof(mailboxespolicy)"_value") - 1 } }
39 void LoadExpirePolicy(GPEXWhichPolicy which)
43 const char *Pos = NULL;
45 serv_printf("GPEX %s", ExpirePolicyStrings[which][0].Key);
47 StrBuf_ServGetln(Buf);
48 if (GetServerStatus(Buf, &State) == 2) {
49 Pos = ChrPtr(Buf) + 4;
50 WC->Policy[which].expire_mode = StrBufExtractNext_long(Buf, &Pos, '|');
51 WC->Policy[which].expire_value = StrBufExtractNext_long(Buf, &Pos, '|');
53 else if (State == 550)
54 AppendImportantMessage(_("Higher access is required to access this function."), -1);
58 void SaveExpirePolicyFromHTTP(GPEXWhichPolicy which)
63 serv_printf("SPEX %s|%d|%d",
64 ExpirePolicyStrings[which][0].Key,
65 ibcstr( ExpirePolicyStrings[which][1] ),
66 ibcstr( ExpirePolicyStrings[which][1] ) );
69 StrBuf_ServGetln(Buf);
70 GetServerStatus(Buf, &State);
72 AppendImportantMessage(_("Higher access is required to access this function."), -1);
76 int ConditionalExpire(StrBuf *Target, WCTemplputParams *TP)
78 GPEXWhichPolicy which;
81 which = GetTemplateTokenNumber(Target, TP, 2, 0);
82 CompareWith = GetTemplateTokenNumber(Target, TP, 3, 0);
84 LoadExpirePolicy(which);
86 return WC->Policy[which].expire_mode == CompareWith;
89 void tmplput_ExpireValue(StrBuf *Target, WCTemplputParams *TP)
91 GPEXWhichPolicy which;
93 which = GetTemplateTokenNumber(Target, TP, 0, 0);
94 LoadExpirePolicy(which);
95 StrBufAppendPrintf(Target, "%d", WC->Policy[which].expire_value);
99 void tmplput_ExpireMode(StrBuf *Target, WCTemplputParams *TP)
101 GPEXWhichPolicy which;
103 which = GetTemplateTokenNumber(Target, TP, 2, 0);
104 LoadExpirePolicy(which);
105 StrBufAppendPrintf(Target, "%d", WC->Policy[which].expire_mode);
109 void LoadZoneFiles(void)
114 const char *this_zone;
117 ZoneHash = NewHash(1, NULL);
118 ZName = NewStrBufPlain(HKEY("UTC"));
119 Put(ZoneHash, HKEY("UTC"), ZName, HFreeStrBuf);
120 zones = icaltimezone_get_builtin_timezones();
121 for (z = 0; z < zones->num_elements; ++z) {
122 /* syslog(LOG_DEBUG, "Location: %-40s tzid: %s\n",
123 icaltimezone_get_location(icalarray_element_at(zones, z)),
124 icaltimezone_get_tzid(icalarray_element_at(zones, z))
126 this_zone = icaltimezone_get_location(icalarray_element_at(zones, z));
127 len = strlen(this_zone);
128 ZName = NewStrBufPlain(this_zone, len);
129 Put(ZoneHash, this_zone, len, ZName, HFreeStrBuf);
131 SortByHashKey(ZoneHash, 0);
135 typedef struct _CfgMapping {
149 CfgMapping ServerConfig[] = {
150 {CFG_STR, 0, 0, "", HKEY("c_nodename")},
151 {CFG_STR, 0, 0, "", HKEY("c_fqdn")},
152 {CFG_STR, 0, 0, "", HKEY("c_humannode")},
153 {CFG_STR, 0, 0, "", HKEY("c_phonenum")},
154 {CFG_YES, 0, 0, "", HKEY("c_creataide")},
155 {CFG_STR, 0, 0, "", HKEY("c_sleeping")},
156 {CFG_STR, 0, 0, "", HKEY("c_initax")},
157 {CFG_YES, 0, 0, "", HKEY("c_regiscall")},
158 {CFG_YES, 0, 0, "", HKEY("c_twitdetect")},
159 {CFG_STR, 0, 0, "", HKEY("c_twitroom")},
160 {CFG_STR, 0, 0, "", HKEY("c_moreprompt")},
161 {CFG_YES, 0, 0, "", HKEY("c_restrict")},
162 {CFG_STR, 0, 0, "", HKEY("c_bbs_city")},
163 {CFG_STR, 0, 0, "", HKEY("c_sysadm")},
164 {CFG_STR, 0, 0, "", HKEY("c_maxsessions")},
165 {CFG_STR, 0, 0, "", HKEY("reserved1")},
166 {CFG_STR, 0, 0, "", HKEY("c_userpurge")},
167 {CFG_STR, 0, 0, "", HKEY("c_roompurge")},
168 {CFG_STR, 0, 0, "", HKEY("c_logpages")},
169 {CFG_STR, 0, 0, "", HKEY("c_createax")},
170 {CFG_STR, 0, 0, "", HKEY("c_maxmsglen")},
171 {CFG_STR, 0, 0, "", HKEY("c_min_workers")},
172 {CFG_STR, 0, 0, "", HKEY("c_max_workers")},
173 {CFG_STR, 0, 0, "", HKEY("c_pop3_port")},
174 {CFG_STR, 0, 0, "", HKEY("c_smtp_port")},
175 {CFG_INT, CFG_SMTP_FROM_FILTERALL, CFG_SMTP_FROM_REJECT, "0", HKEY("c_rfc822_strict_from")},
176 {CFG_YES, 0, 0, "", HKEY("c_aide_zap")},
177 {CFG_STR, 0, 0, "", HKEY("c_imap_port")},
178 {CFG_STR, 0, 0, "", HKEY("c_net_freq")},
179 {CFG_YES, 0, 0, "", HKEY("c_disable_newu")},
180 {CFG_STR, 0, 0, "", HKEY("reserved2")},
181 {CFG_STR, 0, 0, "", HKEY("c_purge_hour")},
182 {CFG_STR, 0, 0, "", HKEY("c_ldap_host")},
183 {CFG_STR, 0, 0, "", HKEY("c_ldap_port")},
184 {CFG_STR, 0, 0, "", HKEY("c_ldap_base_dn")},
185 {CFG_STR, 0, 0, "", HKEY("c_ldap_bind_dn")},
186 {CFG_STR, 0, 0, "", HKEY("c_ldap_bind_pw")},
187 {CFG_STR, 0, 0, "", HKEY("c_ip_addr")},
188 {CFG_STR, 0, 0, "", HKEY("c_msa_port")},
189 {CFG_STR, 0, 0, "", HKEY("c_imaps_port")},
190 {CFG_STR, 0, 0, "", HKEY("c_pop3s_port")},
191 {CFG_STR, 0, 0, "", HKEY("c_smtps_port")},
192 {CFG_YES, 0, 0, "", HKEY("c_enable_fulltext")},
193 {CFG_YES, 0, 0, "", HKEY("c_auto_cull")},
194 {CFG_YES, 0, 0, "", HKEY("reserved3")},
195 {CFG_YES, 0, 0, "", HKEY("c_allow_spoofing")},
196 {CFG_YES, 0, 0, "", HKEY("c_journal_email")},
197 {CFG_YES, 0, 0, "", HKEY("c_journal_pubmsgs")},
198 {CFG_STR, 0, 0, "", HKEY("c_journal_dest")},
199 {CFG_STR, 0, 0, "", HKEY("c_default_cal_zone")},
200 {CFG_STR, 0, 0, "", HKEY("c_pftcpdict_port")},
201 {CFG_STR, 0, 0, "", HKEY("c_mgesve_port")},
202 {CFG_STR, 0, 0, "", HKEY("c_auth_mode")},
203 {CFG_STR, 0, 0, "", HKEY("c_funambol_host")},
204 {CFG_STR, 0, 0, "", HKEY("c_funambol_port")},
205 {CFG_STR, 0, 0, "", HKEY("c_funambol_source")},
206 {CFG_STR, 0, 0, "", HKEY("c_funambol_auth")},
207 {CFG_YES, 0, 0, "", HKEY("c_rbl_at_greeting")},
208 {CFG_STR, 0, 0, "", HKEY("c_master_user")},
209 {CFG_STR, 0, 0, "", HKEY("c_master_pass")},
210 {CFG_STR, 0, 0, "", HKEY("c_pager_program")},
211 {CFG_YES, 0, 0, "", HKEY("c_imap_keep_from")},
212 {CFG_STR, 0, 0, "", HKEY("c_xmpp_c2s_port")},
213 {CFG_STR, 0, 0, "", HKEY("c_xmpp_s2s_port")},
214 {CFG_STR, 0, 0, "", HKEY("c_pop3_fetch")},
215 {CFG_STR, 0, 0, "", HKEY("c_pop3_fastest")},
216 {CFG_YES, 0, 0, "", HKEY("c_spam_flag_only")},
217 {CFG_YES, 0, 0, "", HKEY("c_guest_logins")},
218 {CFG_STR, 0, 0, "", HKEY("c_port_number")},
219 {CFG_STR, 0, 0, "", HKEY("c_ctdluid")},
220 {CFG_STR, 0, 0, "", HKEY("c_nntp_port")},
221 {CFG_STR, 0, 0, "", HKEY("c_nntps_port")}
227 * display all configuration items
229 void load_siteconfig(void)
236 if (WC->ServCfg == NULL)
237 WC->ServCfg = NewHash(1, NULL);
242 serv_printf("CONF get");
243 StrBuf_ServGetln(Buf);
244 if (GetServerStatus(Buf, NULL) != 1) {
245 StrBufCutLeft(Buf, 4);
246 AppendImportantMessage(SKEY(Buf));
252 while (len = StrBuf_ServGetln(Buf),
254 ((len != 3) || strcmp(ChrPtr(Buf), "000")))
256 if (i < (sizeof(ServerConfig) / sizeof(CfgMapping)))
268 syslog(LOG_WARNING, "The server sent more configuration data than this version of webcit is capable of changing. Unknown configuration values will remain unchanged.");
275 LoadExpirePolicy(roompolicy);
276 LoadExpirePolicy(floorpolicy);
277 LoadExpirePolicy(mailboxespolicy);
278 LoadExpirePolicy(sitepolicy);
284 * parse siteconfig changes
286 void siteconfig(void)
291 if (strlen(bstr("ok_button")) == 0) {
296 serv_printf("CONF set");
297 StrBuf_ServGetln(Line);
298 if (GetServerStatusMsg(Line, NULL, 1, 4) != 4) {
306 for (i=0; i < (sizeof(ServerConfig) / sizeof(CfgMapping)); i ++)
308 switch (ServerConfig[i].type) {
311 serv_putbuf(SBstr(ServerConfig[i].Key, ServerConfig[i].len));
314 serv_puts(YesBstr(ServerConfig[i].Key,
315 ServerConfig[i].len) ?
319 serv_puts(YesBstr(ServerConfig[i].Key,
320 ServerConfig[i].len) ?
324 value = IBstr(ServerConfig[i].Key,
325 ServerConfig[i].len);
326 if ((value < ServerConfig[i].min) ||
327 (value > ServerConfig[i].max))
328 value = atol(ServerConfig[i].defval);
329 serv_printf("%d", value);
335 SaveExpirePolicyFromHTTP(sitepolicy);
336 SaveExpirePolicyFromHTTP(mailboxespolicy);
338 FreeStrBuf(&WC->serv_info->serv_default_cal_zone);
339 WC->serv_info->serv_default_cal_zone = NewStrBufDup(sbstr("c_default_cal_zone"));
341 AppendImportantMessage(_("Your system configuration has been updated."), -1);
342 DeleteHash(&WC->ServCfg);
347 // if WebCit Classic wasn't obsolete we would replace this with a "CONF GETVAL" type of thing
348 void tmplput_servcfg(StrBuf *Target, WCTemplputParams *TP)
354 if (WC->ServCfg == NULL)
356 GetHash(WC->ServCfg, TKEY(0), &vBuf);
357 Buf = (StrBuf*) vBuf;
358 StrBufAppendTemplate(Target, TP, Buf, 1);
362 int ConditionalServCfg(StrBuf *Target, WCTemplputParams *TP)
368 if (WC->ServCfg == NULL)
370 GetHash(WC->ServCfg, TKEY(2), &vBuf);
371 if (vBuf == NULL) return 0;
372 Buf = (StrBuf*) vBuf;
373 if (TP->Tokens->nParameters == 3) {
376 else if (IS_NUMBER(TP->Tokens->Params[3]->Type))
377 return (StrTol(Buf) == GetTemplateTokenNumber (Target, TP, 3, 0));
383 GetTemplateTokenString(Target, TP, 3, &pch, &len);
385 return ((len == StrLength(Buf)) &&
386 (strcmp(pch, ChrPtr(Buf)) == 0));
393 int ConditionalServCfgCTXStrBuf(StrBuf *Target, WCTemplputParams *TP)
397 StrBuf *ZoneToCheck = (StrBuf*) CTX(CTX_STRBUF);
399 if ((WC->is_aide) || (ZoneToCheck == NULL)) {
400 if (WC->ServCfg == NULL)
402 GetHash(WC->ServCfg, TKEY(2), &vBuf);
403 if (vBuf == NULL) return 0;
404 Buf = (StrBuf*) vBuf;
406 return strcmp(ChrPtr(Buf), ChrPtr(ZoneToCheck)) == 0;
411 /*----------------------------------------------------------------------------*
412 * Displaying Logging *
413 *----------------------------------------------------------------------------*/
414 typedef struct __LogStatusStruct {
419 void DeleteLogStatusStruct(void *v)
421 LogStatusStruct *Stat = (LogStatusStruct*)v;
423 FreeStrBuf(&Stat->Name);
427 void tmplput_servcfg_LogName(StrBuf *Target, WCTemplputParams *TP)
429 LogStatusStruct *Stat = (LogStatusStruct*) CTX(CTX_SRVLOG);
430 StrBufAppendTemplate(Target, TP, Stat->Name, 1);
433 int ConditionalServCfgThisLogEnabled(StrBuf *Target, WCTemplputParams *TP)
435 LogStatusStruct *Stat = (LogStatusStruct*) CTX(CTX_SRVLOG);
439 HashList *iterate_GetSrvLogEnable(StrBuf *Target, WCTemplputParams *TP)
441 HashList *Hash = NULL;
443 LogStatusStruct *Stat;
451 StrBuf_ServGetln(Buf);
452 if (GetServerStatus(Buf, NULL) == 1) {
453 Hash = NewHash(1, Flathash);
455 len = StrBuf_ServGetln(Buf);
458 !strcmp(ChrPtr(Buf), "000")))
463 Stat = (LogStatusStruct*) malloc (sizeof(LogStatusStruct));
465 Stat->Name = NewStrBufPlain(NULL, len);
466 StrBufExtract_NextToken(Stat->Name, Buf, &Pos, '|');
467 Stat->Enable = StrBufExtractNext_int(Buf, &Pos, '|');
469 Put(Hash, IKEY(num_logs), Stat, DeleteLogStatusStruct);
479 InitModule_SITECONFIG
482 RegisterCTX(CTX_SRVLOG);
483 WebcitAddUrlHandler(HKEY("siteconfig"), "", 0, siteconfig, CTX_NONE);
485 RegisterNamespace("SERV:CFG", 1, 2, tmplput_servcfg, NULL, CTX_NONE);
486 RegisterConditional("COND:SERVCFG", 3, ConditionalServCfg, CTX_NONE);
487 RegisterConditional("COND:SERVCFG:CTXSTRBUF", 4, ConditionalServCfgCTXStrBuf, CTX_STRBUF);
488 RegisterIterator("PREF:ZONE", 0, ZoneHash, NULL, NULL, NULL, CTX_STRBUF, CTX_NONE, IT_NOFLAG);
490 REGISTERTokenParamDefine(roompolicy);
491 REGISTERTokenParamDefine(floorpolicy);
492 REGISTERTokenParamDefine(sitepolicy);
493 REGISTERTokenParamDefine(mailboxespolicy);
495 REGISTERTokenParamDefine(EXPIRE_NEXTLEVEL);
496 REGISTERTokenParamDefine(EXPIRE_MANUAL);
497 REGISTERTokenParamDefine(EXPIRE_NUMMSGS);
498 REGISTERTokenParamDefine(EXPIRE_AGE);
500 REGISTERTokenParamDefine(CFG_SMTP_FROM_FILTERALL);
501 REGISTERTokenParamDefine(CFG_SMTP_FROM_NOFILTER);
502 REGISTERTokenParamDefine(CFG_SMTP_FROM_CORRECT);
503 REGISTERTokenParamDefine(CFG_SMTP_FROM_REJECT);
505 RegisterConditional("COND:EXPIRE:MODE", 2, ConditionalExpire, CTX_NONE);
506 RegisterNamespace("EXPIRE:VALUE", 1, 2, tmplput_ExpireValue, NULL, CTX_NONE);
507 RegisterNamespace("EXPIRE:MODE", 1, 2, tmplput_ExpireMode, NULL, CTX_NONE);
509 RegisterConditional("COND:SERVCFG:THISLOGENABLE", 4, ConditionalServCfgThisLogEnabled, CTX_SRVLOG);
510 RegisterIterator("SERVCFG:LOGENABLE", 0, NULL, iterate_GetSrvLogEnable, NULL, DeleteHash, CTX_SRVLOG, CTX_NONE, IT_NOFLAG);
511 RegisterNamespace("SERVCFG:LOGNAME", 0, 1, tmplput_servcfg_LogName, NULL, CTX_SRVLOG);
515 ServerStartModule_SITECONFIG
522 ServerShutdownModule_SITECONFIG
525 DeleteHash(&ZoneHash);
530 SessionDestroyModule_SITECONFIG
533 DeleteHash(&sess->ServCfg);