2 * Administrative screen for site-wide configuration
4 * Copyright (c) 1996-2024 by the citadel.org team
6 * This program is open source software. Use, duplication, or disclosure
7 * are subject to the terms of the GNU General Public License version 3.
14 * Expiry policy for the autopurger
16 #define EXPIRE_NEXTLEVEL 0 /* Inherit expiration policy */
17 #define EXPIRE_MANUAL 1 /* Don't expire messages at all */
18 #define EXPIRE_NUMMSGS 2 /* Keep only latest n messages */
19 #define EXPIRE_AGE 3 /* Expire messages after n days */
21 CtxType CTX_SRVLOG = CTX_NONE;
23 HashList *ZoneHash = NULL;
25 ConstStr ExpirePolicyString = {CStrOf(roompolicy) };
27 ConstStr ExpirePolicyStrings[][2] = {
28 { { CStrOf(roompolicy) } , { strof(roompolicy) "_value", sizeof(strof(roompolicy) "_value") - 1 } },
29 { { CStrOf(floorpolicy) } , { strof(floorpolicy) "_value", sizeof(strof(floorpolicy) "_value") - 1 } },
30 { { CStrOf(sitepolicy) } , { strof(sitepolicy) "_value", sizeof(strof(sitepolicy) "_value") - 1 } },
31 { { CStrOf(mailboxespolicy)} , { strof(mailboxespolicy)"_value", sizeof(strof(mailboxespolicy)"_value") - 1 } }
35 void LoadExpirePolicy(GPEXWhichPolicy which) {
38 const char *Pos = NULL;
40 serv_printf("GPEX %s", ExpirePolicyStrings[which][0].Key);
42 StrBuf_ServGetln(Buf);
43 if (GetServerStatus(Buf, &State) == 2) {
44 Pos = ChrPtr(Buf) + 4;
45 WC->Policy[which].expire_mode = StrBufExtractNext_long(Buf, &Pos, '|');
46 WC->Policy[which].expire_value = StrBufExtractNext_long(Buf, &Pos, '|');
48 else if (State == 550)
49 AppendImportantMessage(_("Higher access is required to access this function."), -1);
54 void SaveExpirePolicyFromHTTP(GPEXWhichPolicy which) {
58 serv_printf("SPEX %s|%d|%d",
59 ExpirePolicyStrings[which][0].Key,
60 ibcstr( ExpirePolicyStrings[which][1] ),
61 ibcstr( ExpirePolicyStrings[which][1] ) );
64 StrBuf_ServGetln(Buf);
65 GetServerStatus(Buf, &State);
67 AppendImportantMessage(_("Higher access is required to access this function."), -1);
72 int ConditionalExpire(StrBuf *Target, WCTemplputParams *TP) {
73 GPEXWhichPolicy which;
76 which = GetTemplateTokenNumber(Target, TP, 2, 0);
77 CompareWith = GetTemplateTokenNumber(Target, TP, 3, 0);
79 LoadExpirePolicy(which);
81 return WC->Policy[which].expire_mode == CompareWith;
85 void tmplput_ExpireValue(StrBuf *Target, WCTemplputParams *TP) {
86 GPEXWhichPolicy which;
88 which = GetTemplateTokenNumber(Target, TP, 0, 0);
89 LoadExpirePolicy(which);
90 StrBufAppendPrintf(Target, "%d", WC->Policy[which].expire_value);
94 void tmplput_ExpireMode(StrBuf *Target, WCTemplputParams *TP) {
95 GPEXWhichPolicy which;
97 which = GetTemplateTokenNumber(Target, TP, 2, 0);
98 LoadExpirePolicy(which);
99 StrBufAppendPrintf(Target, "%d", WC->Policy[which].expire_mode);
103 void LoadZoneFiles(void) {
107 const char *this_zone;
110 ZoneHash = NewHash(1, NULL);
111 ZName = NewStrBufPlain(HKEY("UTC"));
112 Put(ZoneHash, HKEY("UTC"), ZName, HFreeStrBuf);
113 zones = icaltimezone_get_builtin_timezones();
114 for (z = 0; z < zones->num_elements; ++z) {
115 /* syslog(LOG_DEBUG, "Location: %-40s tzid: %s\n",
116 icaltimezone_get_location(icalarray_element_at(zones, z)),
117 icaltimezone_get_tzid(icalarray_element_at(zones, z))
119 this_zone = icaltimezone_get_location(icalarray_element_at(zones, z));
120 len = strlen(this_zone);
121 ZName = NewStrBufPlain(this_zone, len);
122 Put(ZoneHash, this_zone, len, ZName, HFreeStrBuf);
124 SortByHashKey(ZoneHash, 0);
128 typedef struct _CfgMapping {
142 CfgMapping ServerConfig[] = {
143 {CFG_STR, 0, 0, "", HKEY("c_nodename")},
144 {CFG_STR, 0, 0, "", HKEY("c_fqdn")},
145 {CFG_STR, 0, 0, "", HKEY("c_humannode")},
146 {CFG_STR, 0, 0, "", HKEY("c_phonenum")},
147 {CFG_YES, 0, 0, "", HKEY("c_creataide")},
148 {CFG_STR, 0, 0, "", HKEY("c_sleeping")},
149 {CFG_STR, 0, 0, "", HKEY("c_initax")},
150 {CFG_YES, 0, 0, "", HKEY("c_regiscall")},
151 {CFG_YES, 0, 0, "", HKEY("c_twitdetect")},
152 {CFG_STR, 0, 0, "", HKEY("c_twitroom")},
153 {CFG_STR, 0, 0, "", HKEY("c_moreprompt")},
154 {CFG_YES, 0, 0, "", HKEY("c_restrict")},
155 {CFG_STR, 0, 0, "", HKEY("c_bbs_city")},
156 {CFG_STR, 0, 0, "", HKEY("c_sysadm")},
157 {CFG_STR, 0, 0, "", HKEY("c_maxsessions")},
158 {CFG_STR, 0, 0, "", HKEY("reserved1")},
159 {CFG_STR, 0, 0, "", HKEY("c_userpurge")},
160 {CFG_STR, 0, 0, "", HKEY("c_roompurge")},
161 {CFG_STR, 0, 0, "", HKEY("c_logpages")},
162 {CFG_STR, 0, 0, "", HKEY("c_createax")},
163 {CFG_STR, 0, 0, "", HKEY("c_maxmsglen")},
164 {CFG_STR, 0, 0, "", HKEY("c_min_workers")},
165 {CFG_STR, 0, 0, "", HKEY("c_max_workers")},
166 {CFG_STR, 0, 0, "", HKEY("c_pop3_port")},
167 {CFG_STR, 0, 0, "", HKEY("c_smtp_port")},
168 {CFG_INT, CFG_SMTP_FROM_FILTERALL, CFG_SMTP_FROM_REJECT, "0", HKEY("c_rfc822_strict_from")},
169 {CFG_YES, 0, 0, "", HKEY("c_aide_zap")},
170 {CFG_STR, 0, 0, "", HKEY("c_imap_port")},
171 {CFG_STR, 0, 0, "", HKEY("c_net_freq")},
172 {CFG_YES, 0, 0, "", HKEY("c_disable_newu")},
173 {CFG_STR, 0, 0, "", HKEY("reserved2")},
174 {CFG_STR, 0, 0, "", HKEY("c_purge_hour")},
175 {CFG_STR, 0, 0, "", HKEY("c_ldap_host")},
176 {CFG_STR, 0, 0, "", HKEY("c_ldap_port")},
177 {CFG_STR, 0, 0, "", HKEY("c_ldap_base_dn")},
178 {CFG_STR, 0, 0, "", HKEY("c_ldap_bind_dn")},
179 {CFG_STR, 0, 0, "", HKEY("c_ldap_bind_pw")},
180 {CFG_STR, 0, 0, "", HKEY("c_ip_addr")},
181 {CFG_STR, 0, 0, "", HKEY("c_msa_port")},
182 {CFG_STR, 0, 0, "", HKEY("c_imaps_port")},
183 {CFG_STR, 0, 0, "", HKEY("c_pop3s_port")},
184 {CFG_STR, 0, 0, "", HKEY("c_smtps_port")},
185 {CFG_YES, 0, 0, "", HKEY("c_enable_fulltext")},
186 {CFG_YES, 0, 0, "", HKEY("c_auto_cull")},
187 {CFG_YES, 0, 0, "", HKEY("reserved3")},
188 {CFG_YES, 0, 0, "", HKEY("c_allow_spoofing")},
189 {CFG_YES, 0, 0, "", HKEY("c_journal_email")},
190 {CFG_YES, 0, 0, "", HKEY("c_journal_pubmsgs")},
191 {CFG_STR, 0, 0, "", HKEY("c_journal_dest")},
192 {CFG_STR, 0, 0, "", HKEY("c_default_cal_zone")},
193 {CFG_STR, 0, 0, "", HKEY("c_pftcpdict_port")},
194 {CFG_STR, 0, 0, "", HKEY("c_mgesve_port")},
195 {CFG_STR, 0, 0, "", HKEY("c_auth_mode")},
196 {CFG_STR, 0, 0, "", HKEY("c_funambol_host")},
197 {CFG_STR, 0, 0, "", HKEY("c_funambol_port")},
198 {CFG_STR, 0, 0, "", HKEY("c_funambol_source")},
199 {CFG_STR, 0, 0, "", HKEY("c_funambol_auth")},
200 {CFG_YES, 0, 0, "", HKEY("c_rbl_at_greeting")},
201 {CFG_STR, 0, 0, "", HKEY("c_master_user")},
202 {CFG_STR, 0, 0, "", HKEY("c_master_pass")},
203 {CFG_STR, 0, 0, "", HKEY("c_pager_program")},
204 {CFG_YES, 0, 0, "", HKEY("c_imap_keep_from")},
205 {CFG_STR, 0, 0, "", HKEY("c_xmpp_c2s_port")},
206 {CFG_STR, 0, 0, "", HKEY("c_xmpp_s2s_port")},
207 {CFG_STR, 0, 0, "", HKEY("c_pop3_fetch")},
208 {CFG_STR, 0, 0, "", HKEY("c_pop3_fastest")},
209 {CFG_YES, 0, 0, "", HKEY("c_spam_flag_only")},
210 {CFG_YES, 0, 0, "", HKEY("c_guest_logins")},
211 {CFG_STR, 0, 0, "", HKEY("c_port_number")},
212 {CFG_STR, 0, 0, "", HKEY("c_ctdluid")},
213 {CFG_STR, 0, 0, "", HKEY("c_nntp_port")},
214 {CFG_STR, 0, 0, "", HKEY("c_nntps_port")},
215 {CFG_YES, 0, 0, "", HKEY("smtp_advertise_starttls")}
220 * display all configuration items
222 void load_siteconfig(void) {
228 if (WC->ServCfg == NULL)
229 WC->ServCfg = NewHash(1, NULL);
234 serv_printf("CONF get");
235 StrBuf_ServGetln(Buf);
236 if (GetServerStatus(Buf, NULL) != 1) {
237 StrBufCutLeft(Buf, 4);
238 AppendImportantMessage(SKEY(Buf));
244 while (len = StrBuf_ServGetln(Buf),
246 ((len != 3) || strcmp(ChrPtr(Buf), "000")))
248 if (i < (sizeof(ServerConfig) / sizeof(CfgMapping)))
260 syslog(LOG_WARNING, "The server sent more configuration data than this version of webcit is capable of changing. Unknown configuration values will remain unchanged.");
267 LoadExpirePolicy(roompolicy);
268 LoadExpirePolicy(floorpolicy);
269 LoadExpirePolicy(mailboxespolicy);
270 LoadExpirePolicy(sitepolicy);
275 * parse siteconfig changes
277 void siteconfig(void) {
281 if (strlen(bstr("ok_button")) == 0) {
286 serv_printf("CONF set");
287 StrBuf_ServGetln(Line);
288 if (GetServerStatusMsg(Line, NULL, 1, 4) != 4) {
296 for (i=0; i < (sizeof(ServerConfig) / sizeof(CfgMapping)); i ++)
298 switch (ServerConfig[i].type) {
301 serv_putbuf(SBstr(ServerConfig[i].Key, ServerConfig[i].len));
304 serv_puts(YesBstr(ServerConfig[i].Key,
305 ServerConfig[i].len) ?
309 serv_puts(YesBstr(ServerConfig[i].Key,
310 ServerConfig[i].len) ?
314 value = IBstr(ServerConfig[i].Key,
315 ServerConfig[i].len);
316 if ((value < ServerConfig[i].min) ||
317 (value > ServerConfig[i].max))
318 value = atol(ServerConfig[i].defval);
319 serv_printf("%d", value);
325 SaveExpirePolicyFromHTTP(sitepolicy);
326 SaveExpirePolicyFromHTTP(mailboxespolicy);
328 FreeStrBuf(&WC->serv_info->serv_default_cal_zone);
329 WC->serv_info->serv_default_cal_zone = NewStrBufDup(sbstr("c_default_cal_zone"));
331 AppendImportantMessage(_("Your system configuration has been updated."), -1);
332 DeleteHash(&WC->ServCfg);
337 // if WebCit Classic wasn't obsolete we would replace this with a "CONF GETVAL" type of thing
338 void tmplput_servcfg(StrBuf *Target, WCTemplputParams *TP) {
343 if (WC->ServCfg == NULL)
345 GetHash(WC->ServCfg, TKEY(0), &vBuf);
346 Buf = (StrBuf*) vBuf;
347 StrBufAppendTemplate(Target, TP, Buf, 1);
352 int ConditionalServCfg(StrBuf *Target, WCTemplputParams *TP) {
357 if (WC->ServCfg == NULL)
359 GetHash(WC->ServCfg, TKEY(2), &vBuf);
360 if (vBuf == NULL) return 0;
361 Buf = (StrBuf*) vBuf;
362 if (TP->Tokens->nParameters == 3) {
365 else if (IS_NUMBER(TP->Tokens->Params[3]->Type))
366 return (StrTol(Buf) == GetTemplateTokenNumber (Target, TP, 3, 0));
372 GetTemplateTokenString(Target, TP, 3, &pch, &len);
374 return ((len == StrLength(Buf)) &&
375 (strcmp(pch, ChrPtr(Buf)) == 0));
382 int ConditionalServCfgCTXStrBuf(StrBuf *Target, WCTemplputParams *TP) {
385 StrBuf *ZoneToCheck = (StrBuf*) CTX(CTX_STRBUF);
387 if ((WC->is_aide) || (ZoneToCheck == NULL)) {
388 if (WC->ServCfg == NULL)
390 GetHash(WC->ServCfg, TKEY(2), &vBuf);
391 if (vBuf == NULL) return 0;
392 Buf = (StrBuf*) vBuf;
394 return strcmp(ChrPtr(Buf), ChrPtr(ZoneToCheck)) == 0;
399 /*----------------------------------------------------------------------------*
400 * Displaying Logging *
401 *----------------------------------------------------------------------------*/
402 typedef struct __LogStatusStruct {
407 void DeleteLogStatusStruct(void *v)
409 LogStatusStruct *Stat = (LogStatusStruct*)v;
411 FreeStrBuf(&Stat->Name);
415 void tmplput_servcfg_LogName(StrBuf *Target, WCTemplputParams *TP)
417 LogStatusStruct *Stat = (LogStatusStruct*) CTX(CTX_SRVLOG);
418 StrBufAppendTemplate(Target, TP, Stat->Name, 1);
423 int ConditionalServCfgThisLogEnabled(StrBuf *Target, WCTemplputParams *TP)
425 LogStatusStruct *Stat = (LogStatusStruct*) CTX(CTX_SRVLOG);
429 HashList *iterate_GetSrvLogEnable(StrBuf *Target, WCTemplputParams *TP)
431 HashList *Hash = NULL;
433 LogStatusStruct *Stat;
441 StrBuf_ServGetln(Buf);
442 if (GetServerStatus(Buf, NULL) == 1) {
443 Hash = NewHash(1, Flathash);
445 len = StrBuf_ServGetln(Buf);
448 !strcmp(ChrPtr(Buf), "000")))
453 Stat = (LogStatusStruct*) malloc (sizeof(LogStatusStruct));
455 Stat->Name = NewStrBufPlain(NULL, len);
456 StrBufExtract_NextToken(Stat->Name, Buf, &Pos, '|');
457 Stat->Enable = StrBufExtractNext_int(Buf, &Pos, '|');
459 Put(Hash, IKEY(num_logs), Stat, DeleteLogStatusStruct);
469 InitModule_SITECONFIG
472 RegisterCTX(CTX_SRVLOG);
473 WebcitAddUrlHandler(HKEY("siteconfig"), "", 0, siteconfig, CTX_NONE);
475 RegisterNamespace("SERV:CFG", 1, 2, tmplput_servcfg, NULL, CTX_NONE);
476 RegisterConditional("COND:SERVCFG", 3, ConditionalServCfg, CTX_NONE);
477 RegisterConditional("COND:SERVCFG:CTXSTRBUF", 4, ConditionalServCfgCTXStrBuf, CTX_STRBUF);
478 RegisterIterator("PREF:ZONE", 0, ZoneHash, NULL, NULL, NULL, CTX_STRBUF, CTX_NONE, IT_NOFLAG);
480 REGISTERTokenParamDefine(roompolicy);
481 REGISTERTokenParamDefine(floorpolicy);
482 REGISTERTokenParamDefine(sitepolicy);
483 REGISTERTokenParamDefine(mailboxespolicy);
485 REGISTERTokenParamDefine(EXPIRE_NEXTLEVEL);
486 REGISTERTokenParamDefine(EXPIRE_MANUAL);
487 REGISTERTokenParamDefine(EXPIRE_NUMMSGS);
488 REGISTERTokenParamDefine(EXPIRE_AGE);
490 REGISTERTokenParamDefine(CFG_SMTP_FROM_FILTERALL);
491 REGISTERTokenParamDefine(CFG_SMTP_FROM_NOFILTER);
492 REGISTERTokenParamDefine(CFG_SMTP_FROM_CORRECT);
493 REGISTERTokenParamDefine(CFG_SMTP_FROM_REJECT);
495 RegisterConditional("COND:EXPIRE:MODE", 2, ConditionalExpire, CTX_NONE);
496 RegisterNamespace("EXPIRE:VALUE", 1, 2, tmplput_ExpireValue, NULL, CTX_NONE);
497 RegisterNamespace("EXPIRE:MODE", 1, 2, tmplput_ExpireMode, NULL, CTX_NONE);
498 RegisterConditional("COND:SERVCFG:THISLOGENABLE", 4, ConditionalServCfgThisLogEnabled, CTX_SRVLOG);
499 RegisterIterator("SERVCFG:LOGENABLE", 0, NULL, iterate_GetSrvLogEnable, NULL, DeleteHash, CTX_SRVLOG, CTX_NONE, IT_NOFLAG);
500 RegisterNamespace("SERVCFG:LOGNAME", 0, 1, tmplput_servcfg_LogName, NULL, CTX_SRVLOG);
504 ServerStartModule_SITECONFIG
511 ServerShutdownModule_SITECONFIG
514 DeleteHash(&ZoneHash);
519 SessionDestroyModule_SITECONFIG
522 DeleteHash(&sess->ServCfg);