4 * Manage user preferences with a little help from the Citadel server.
12 HashList *PreferenceHooks;
14 typedef struct _PrefDef {
21 typedef struct _Preference {
31 void DestroyPrefDef(void *vPrefDef)
33 PrefDef *Prefdef = (PrefDef*) vPrefDef;
34 FreeStrBuf(&Prefdef->Setting);
38 void DestroyPreference(void *vPref)
40 Preference *Pref = (Preference*) vPref;
41 FreeStrBuf(&Pref->Key);
42 FreeStrBuf(&Pref->Val);
43 FreeStrBuf(&Pref->DeQPed);
47 void RegisterPreference(const char *Setting, long SettingLen,
52 PrefDef *Newpref = (PrefDef*) malloc(sizeof(PrefDef));
53 Newpref->Setting = NewStrBufPlain(Setting, SettingLen);
54 Newpref->PrefStr = PrefStr;
56 Newpref->OnLoad = OnLoad;
57 Put(PreferenceHooks, Setting, SettingLen, Newpref, DestroyPrefDef);
60 const char *PrefGetLocalStr(const char *Setting, long len)
63 if (GetHash(PreferenceHooks, Setting, len, &hash_value) != 0) {
64 PrefDef *Newpref = (PrefDef*) hash_value;
65 return _(Newpref->PrefStr);
72 inline const char *PrintPref(void *vPref)
74 Preference *Pref = (Preference*) vPref;
75 if (Pref->DeQPed != NULL)
76 return ChrPtr(Pref->DeQPed);
78 return ChrPtr(Pref->Val);
82 void GetPrefTypes(HashList *List)
92 It = GetNewHashPos(List, 0);
93 while (GetNextHashPos(List, It, &len, &Key, &vSetting))
95 Setting = (Preference*) vSetting;
96 if (GetHash(PreferenceHooks, SKEY(Setting->Key), &vPrefDef) &&
99 PrefType = (PrefDef*) vPrefDef;
100 Setting->Type = PrefType;
101 if (PrefType->OnLoad != NULL)
102 PrefType->OnLoad(Setting->Val, Setting->lval);
107 void ParsePref(HashList **List, StrBuf *ReadBuf)
110 Preference *Data = NULL;
111 Preference *LastData = NULL;
114 while (StrBuf_ServGetln(ReadBuf),
115 strcmp(ChrPtr(ReadBuf), "000"))
117 if ((ChrPtr(ReadBuf)[0] == ' ') &&
119 StrBufAppendBuf(Data->Val, ReadBuf, 1);
122 LastData = Data = malloc(sizeof(Preference));
123 memset(Data, 0, sizeof(Preference));
124 Data->Key = NewStrBuf();
125 Data->Val = NewStrBuf();
126 StrBufExtract_token(Data->Key, ReadBuf, 0, '|');
127 StrBufExtract_token(Data->Val, ReadBuf, 1, '|');
128 if (!IsEmptyStr(ChrPtr(Data->Key)))
138 lprintf(1, "ignoring spurious preference line: [%s]\n",
140 DestroyPreference(Data);
150 * display preferences dialog
152 void load_preferences(void)
158 if (goto_config_room() != 0) return; /* oh well. */
160 ReadBuf = NewStrBuf();
161 serv_puts("MSGS ALL|0|1");
162 StrBuf_ServGetln(ReadBuf);
163 if (GetServerStatus(ReadBuf, NULL) == 8) {
164 serv_puts("subj|__ WebCit Preferences __");
167 while (serv_getln(buf, sizeof buf), strcmp(buf, "000")) {
172 serv_printf("MSG0 %ld", msgnum);
173 StrBuf_ServGetln(ReadBuf);
174 if (GetServerStatus(ReadBuf, NULL) == 1) {
175 while (StrBuf_ServGetln(ReadBuf),
176 (strcmp(ChrPtr(ReadBuf), "text") &&
177 strcmp(ChrPtr(ReadBuf), "000"))) {
179 if (!strcmp(ChrPtr(ReadBuf), "text")) {
180 ParsePref(&WC->hash_prefs, ReadBuf);
185 /* Go back to the room we're supposed to be in */
186 serv_printf("GOTO %s", ChrPtr(WC->wc_roomname));
187 StrBuf_ServGetln(ReadBuf);
188 GetServerStatus(ReadBuf, NULL);
189 FreeStrBuf(&ReadBuf);
193 * \brief Goto the user's configuration room, creating it if necessary.
194 * \return 0 on success or nonzero upon failure.
196 int goto_config_room(void) {
199 serv_printf("GOTO %s", USERCONFIGROOM);
200 serv_getln(buf, sizeof buf);
201 if (buf[0] != '2') { /* try to create the config room if not there */
202 serv_printf("CRE8 1|%s|4|0", USERCONFIGROOM);
203 serv_getln(buf, sizeof buf);
204 serv_printf("GOTO %s", USERCONFIGROOM);
205 serv_getln(buf, sizeof buf);
206 if (buf[0] != '2') return(1);
211 void WritePrefsToServer(HashList *Hash)
218 StrBuf *SubBuf = NULL;
220 Hash = WC->hash_prefs;
221 #ifdef DBG_PREFS_HASH
222 dbg_PrintHash(Hash, PrintPref, NULL);
224 HashPos = GetNewHashPos(Hash, 0);
225 while (GetNextHashPos(Hash, HashPos, &len, &Key, &vPref)!=0)
230 Pref = (Preference*) vPref;
231 nchars = StrLength(Pref->Val);
234 size_t offset, nchars;
236 SubBuf = NewStrBuf();
245 nchars = StrBufSub(SubBuf, Pref->Val, offset, nchars);
248 serv_printf("%s|%s", ChrPtr(Pref->Key), ChrPtr(SubBuf));
250 serv_printf(" %s", ChrPtr(SubBuf));
253 nchars = StrLength(Pref->Val) - offset;
259 serv_printf("%s|%s", ChrPtr(Pref->Key), ChrPtr(Pref->Val));
263 DeleteHashPos(&HashPos);
267 * \brief save the modifications
269 void save_preferences(void)
274 if (goto_config_room() != 0) return; /* oh well. */
275 serv_puts("MSGS ALL|0|1");
276 serv_getln(buf, sizeof buf);
278 serv_puts("subj|__ WebCit Preferences __");
281 while (serv_getln(buf, sizeof buf), strcmp(buf, "000")) {
286 serv_printf("DELE %ld", msgnum);
287 serv_getln(buf, sizeof buf);
290 serv_printf("ENT0 1||0|1|__ WebCit Preferences __|");
291 serv_getln(buf, sizeof buf);
294 WritePrefsToServer(WC->hash_prefs);
299 /** Go back to the room we're supposed to be in */
300 serv_printf("GOTO %s", ChrPtr(WC->wc_roomname));
301 serv_getln(buf, sizeof buf);
305 * \brief query the actual setting of key in the citadel database
306 * \param key config key to query
307 * \param keylen length of the key string
308 * \param value StrBuf-value to the key to get
311 int get_pref_backend(const char *key, size_t keylen, Preference **Pref)
313 void *hash_value = NULL;
314 #ifdef DBG_PREFS_HASH
315 dbg_PrintHash(WC->hash_prefs, PrintPref, NULL);
317 if (GetHash(WC->hash_prefs, key, keylen, &hash_value) == 0) {
322 *Pref = (Preference*) hash_value;
327 int get_PREFERENCE(const char *key, size_t keylen, StrBuf **value)
332 Ret = get_pref_backend(key, keylen, &Pref);
341 * \brief Write a key into the webcit preferences database for this user
343 * \params key key whichs value is to be modified
344 * \param keylen length of the key string
345 * \param value value to set
346 * \param save_to_server 1 = flush all data to the server, 0 = cache it for now
348 void set_preference_backend(const char *key, size_t keylen,
358 Pref = (Preference*) malloc(sizeof(Preference));
359 memset(Pref, 0, sizeof(Preference));
360 Pref->Key = NewStrBufPlain(key, keylen);
362 if ((PrefType == NULL) &&
363 GetHash(PreferenceHooks, SKEY(Pref->Key), &vPrefDef) &&
365 PrefType = (PrefDef*) vPrefDef;
367 if (PrefType != NULL)
369 Pref->Type = PrefType;
370 if (Pref->Type->Type != lPrefType)
371 lprintf(1, "warning: saving preference with wrong type [%s] %ld != %ld \n",
372 key, Pref->Type->Type, lPrefType);
373 switch (Pref->Type->Type)
382 if (Pref->Val == NULL)
383 Pref->Val = NewStrBufPlain(NULL, 64);
384 StrBufPrintf(Pref->Val, "%ld", lvalue);
388 Pref->DeQPed = value;
389 Pref->Val = NewStrBufPlain(NULL, StrLength(Pref->DeQPed) * 3);
390 StrBufEUid_escapize(Pref->Val, Pref->DeQPed);
396 Pref->Val = NewStrBufPlain(HKEY("yes"));
398 Pref->Val = NewStrBufPlain(HKEY("no"));
402 if (Pref->Type->OnLoad != NULL)
403 Pref->Type->OnLoad(Pref->Val, Pref->lval);
415 if (Pref->Val == NULL)
416 Pref->Val = NewStrBufPlain(NULL, 64);
417 StrBufPrintf(Pref->Val, "%ld", lvalue);
421 Pref->DeQPed = value;
422 Pref->Val = NewStrBufPlain(NULL, StrLength(Pref->DeQPed) * 3);
423 StrBufEUid_escapize(Pref->Val, Pref->DeQPed);
429 Pref->Val = NewStrBufPlain(HKEY("yes"));
431 Pref->Val = NewStrBufPlain(HKEY("no"));
436 Put(WC->hash_prefs, key, keylen, Pref, DestroyPreference);
438 if (save_to_server) WC->SavePrefsToServer = 1;
441 void set_PREFERENCE(const char *key, size_t keylen, StrBuf *value, int save_to_server)
443 set_preference_backend(key, keylen, 0, value, PRF_STRING, save_to_server, NULL);
446 int get_PREF_LONG(const char *key, size_t keylen, long *value, long Default)
451 Ret = get_pref_backend(key, keylen, &Pref);
460 *value = Pref->lval = atol(ChrPtr(Pref->Val));
467 void set_PREF_LONG(const char *key, size_t keylen, long value, int save_to_server)
469 set_preference_backend(key, keylen, value, NULL, PRF_INT, save_to_server, NULL);
472 int get_PREF_YESNO(const char *key, size_t keylen, int *value, int Default)
477 Ret = get_pref_backend(key, keylen, &Pref);
486 *value = Pref->lval = strcmp(ChrPtr(Pref->Val), "yes") == 0;
492 void set_PREF_YESNO(const char *key, size_t keylen, long value, int save_to_server)
494 set_preference_backend(key, keylen, value, NULL, PRF_YESNO, save_to_server, NULL);
497 int get_room_prefs_backend(const char *key, size_t keylen,
503 pref_name = NewStrBufPlain (HKEY("ROOM:"));
504 StrBufAppendBuf(pref_name, WC->wc_roomname, 0);
505 StrBufAppendBufPlain(pref_name, HKEY(":"), 0);
506 StrBufAppendBufPlain(pref_name, key, keylen, 0);
507 Ret = get_pref_backend(SKEY(pref_name), Pref);
508 FreeStrBuf(&pref_name);
513 const StrBuf *get_X_PREFS(const char *key, size_t keylen,
514 const char *xkey, size_t xkeylen)
520 pref_name = NewStrBufPlain (HKEY("XPREF:"));
521 StrBufAppendBufPlain(pref_name, xkey, xkeylen, 0);
522 StrBufAppendBufPlain(pref_name, HKEY(":"), 0);
523 StrBufAppendBufPlain(pref_name, key, keylen, 0);
525 ret = get_pref_backend(SKEY(pref_name), &Prf);
526 FreeStrBuf(&pref_name);
533 void set_X_PREFS(const char *key, size_t keylen, const char *xkey, size_t xkeylen, StrBuf *value, int save_to_server)
537 pref_name = NewStrBufPlain (HKEY("XPREF:"));
538 StrBufAppendBufPlain(pref_name, xkey, xkeylen, 0);
539 StrBufAppendBufPlain(pref_name, HKEY(":"), 0);
540 StrBufAppendBufPlain(pref_name, key, keylen, 0);
542 set_preference_backend(SKEY(pref_name), 0, value, PRF_STRING, save_to_server, NULL);
543 FreeStrBuf(&pref_name);
547 StrBuf *get_ROOM_PREFS(const char *key, size_t keylen)
552 Ret = get_room_prefs_backend(key, keylen, &Pref);
561 void set_ROOM_PREFS(const char *key, size_t keylen, StrBuf *value, int save_to_server)
565 pref_name = NewStrBufPlain (HKEY("ROOM:"));
566 StrBufAppendBuf(pref_name, WC->wc_roomname, 0);
567 StrBufAppendBufPlain(pref_name, HKEY(":"), 0);
568 StrBufAppendBufPlain(pref_name, key, keylen, 0);
569 set_preference_backend(SKEY(pref_name), 0, value, PRF_STRING, save_to_server, NULL);
570 FreeStrBuf(&pref_name);
574 void GetPreferences(HashList *Setting)
586 Tmp = WCC->hash_prefs;
587 WCC->hash_prefs = Setting;
589 It = GetNewHashPos(PreferenceHooks, 0);
590 while (GetNextHashPos(PreferenceHooks, It, &len, &Key, &vSetting)) {
591 PrefType = (PrefDef*) vSetting;
593 if (!HaveBstr(SKEY(PrefType->Setting)))
595 switch (PrefType->Type) {
597 Buf = NewStrBufDup(SBstr(SKEY(PrefType->Setting)));
598 set_preference_backend(SKEY(PrefType->Setting),
606 lval = LBstr(SKEY(PrefType->Setting));
607 set_preference_backend(SKEY(PrefType->Setting),
615 Buf = NewStrBufDup(SBstr(SKEY(PrefType->Setting)));
616 set_preference_backend(SKEY(PrefType->Setting),
624 lval = YesBstr(SKEY(PrefType->Setting));
625 set_preference_backend(SKEY(PrefType->Setting),
634 WCC->hash_prefs = Tmp;
639 * \brief Commit new preferences and settings
641 void set_preferences(void)
643 if (!havebstr("change_button")) {
644 safestrncpy(WC->ImportantMessage,
645 _("Cancelled. No settings were changed."),
646 sizeof WC->ImportantMessage);
650 GetPreferences(WC->hash_prefs);
655 void tmplput_CFG_Value(StrBuf *Target, WCTemplputParams *TP)
658 if (get_pref_backend(TKEY(0), &Pref))
660 if (Pref->Type == NULL) {
661 StrBufAppendTemplate(Target, TP, Pref->Val, 1);
663 switch (Pref->Type->Type)
666 StrBufAppendTemplate(Target, TP, Pref->Val, 1);
669 if (Pref->decoded != 1) {
670 if (Pref->Val == NULL)
671 Pref->Val = NewStrBufPlain(NULL, 64);
672 StrBufPrintf(Pref->Val, "%ld", Pref->lval);
675 StrBufAppendTemplate(Target, TP, Pref->Val, 1);
678 if (Pref->decoded != 1) {
679 if (Pref->DeQPed == NULL)
680 Pref->DeQPed = NewStrBufPlain(NULL, StrLength(Pref->Val));
682 StrBufEUid_unescapize(Pref->DeQPed, Pref->Val);
685 StrBufAppendTemplate(Target, TP, Pref->DeQPed, 1);
688 if (Pref->decoded != 1) {
689 Pref->lval = strcmp(ChrPtr(Pref->Val), "yes") == 0;
692 StrBufAppendTemplate(Target, TP, Pref->Val, 1);
698 void tmplput_CFG_Descr(StrBuf *Target, WCTemplputParams *TP)
700 const char *SettingStr;
701 SettingStr = PrefGetLocalStr(TKEY(0));
702 if (SettingStr != NULL)
703 StrBufAppendBufPlain(Target, SettingStr, -1, 0);
705 void tmplput_CFG_RoomValue(StrBuf *Target, WCTemplputParams *TP)
707 StrBuf *pref = get_ROOM_PREFS(TKEY(0));
709 StrBufAppendBuf(Target, pref, 0);
711 int ConditionalHasRoomPreference(StrBuf *Target, WCTemplputParams *TP)
713 if (get_ROOM_PREFS(TP->Tokens->Params[0]->Start,
714 TP->Tokens->Params[0]->len) != NULL)
719 void CfgZoneTempl(StrBuf *TemplBuffer, WCTemplputParams *TP)
721 StrBuf *Zone = (StrBuf*) CTX;
723 SVPutBuf("ZONENAME", Zone, 1);
726 int ConditionalPreference(StrBuf *Target, WCTemplputParams *TP)
730 if (!get_PREFERENCE(TKEY(2), &Pref))
733 if (TP->Tokens->nParameters == 3) {
736 else if (TP->Tokens->Params[3]->Type == TYPE_STR)
737 return ((TP->Tokens->Params[3]->len == StrLength(Pref)) &&
738 (strcmp(TP->Tokens->Params[3]->Start, ChrPtr(Pref)) == 0));
740 return (StrTol(Pref) == TP->Tokens->Params[3]->lvalue);
743 int ConditionalHasPreference(StrBuf *Target, WCTemplputParams *TP)
747 if (!get_PREFERENCE(TKEY(2), &Pref) ||
755 /********************************************************************************
756 * preferences stored discrete in citserver
757 ********************************************************************************/
758 HashList *GetGVEAHash(StrBuf *Target, WCTemplputParams *TP)
761 HashList *List = NULL;
768 StrBuf_ServGetln(Rcp);
769 if (GetServerStatus(Rcp, NULL) == 1) {
771 List = NewHash(1, NULL);
772 while (!Done && (StrBuf_ServGetln(Rcp)>=0)) {
773 if ( (StrLength(Rcp)==3) &&
774 !strcmp(ChrPtr(Rcp), "000"))
779 i = snprintf(N, sizeof(N), "%d", n);
781 Put(List, N, i, Rcp, HFreeStrBuf);
790 void DeleteGVEAHash(HashList **KillMe)
795 HashList *GetGVSNHash(StrBuf *Target, WCTemplputParams *TP)
798 HashList *List = NULL;
805 StrBuf_ServGetln(Rcp);
806 if (GetServerStatus(Rcp, NULL) == 1) {
808 List = NewHash(1, NULL);
809 while (!Done && (StrBuf_ServGetln(Rcp)>=0)) {
810 if ( (StrLength(Rcp)==3) &&
811 !strcmp(ChrPtr(Rcp), "000"))
816 i = snprintf(N, sizeof(N), "%d", n);
818 Put(List, N, i, Rcp, HFreeStrBuf);
827 void DeleteGVSNHash(HashList **KillMe)
836 * Offer to make any page the user's "start page."
838 void offer_start_page(StrBuf *Target, WCTemplputParams *TP)
840 wprintf("<a href=\"change_start_page?startpage=");
841 urlescputs(ChrPtr(WC->this_page));
843 wprintf(_("Make this my start page"));
846 wprintf("<br/><a href=\"rss?room=");
847 urlescputs(ChrPtr(WC->wc_roomname));
848 wprintf("\" title=\"RSS 2.0 feed for ");
849 escputs(ChrPtr(WC->wc_roomname));
850 wprintf("\"><img alt=\"RSS\" border=\"0\" src=\"static/xml_button.gif\"/></a>\n");
856 * Change the user's start page
858 void change_start_page(void)
860 if (!havebstr("startpage")) {
861 set_preference_backend(HKEY("startpage"),
863 NewStrBufPlain(HKEY("")),
867 safestrncpy(WC->ImportantMessage,
868 _("You no longer have a start page selected."),
869 sizeof( WC->ImportantMessage));
874 set_preference_backend(HKEY("startpage"),
876 NewStrBufDup(sbstr("startpage")),
881 output_headers(1, 1, 0, 0, 0, 0);
882 do_template("newstartpage", NULL);
888 InitModule_PREFERENCES
891 WebcitAddUrlHandler(HKEY("set_preferences"), set_preferences, 0);
892 WebcitAddUrlHandler(HKEY("change_start_page"), change_start_page, 0);
895 RegisterNamespace("OFFERSTARTPAGE", 0, 0, offer_start_page, CTX_NONE);
896 RegisterNamespace("PREF:ROOM:VALUE", 1, 2, tmplput_CFG_RoomValue, CTX_NONE);
897 RegisterNamespace("PREF:VALUE", 1, 2, tmplput_CFG_Value, CTX_NONE);
898 RegisterNamespace("PREF:DESCR", 1, 1, tmplput_CFG_Descr, CTX_NONE);
899 RegisterIterator("PREF:ZONE", 0, ZoneHash, NULL, CfgZoneTempl, NULL, CTX_PREF, CTX_NONE, IT_NOFLAG);
901 RegisterConditional(HKEY("COND:PREF"), 4, ConditionalPreference, CTX_NONE);
902 RegisterConditional(HKEY("COND:PREF:SET"), 4, ConditionalHasPreference, CTX_NONE);
903 RegisterConditional(HKEY("COND:ROOM:SET"), 4, ConditionalHasRoomPreference, CTX_NONE);
905 RegisterIterator("PREF:VALID:EMAIL:ADDR", 0, NULL,
906 GetGVEAHash, NULL, DeleteGVEAHash, CTX_STRBUF, CTX_NONE, IT_NOFLAG);
907 RegisterIterator("PREF:VALID:EMAIL:NAME", 0, NULL,
908 GetGVSNHash, NULL, DeleteGVSNHash, CTX_STRBUF, CTX_NONE, IT_NOFLAG);