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 StrBufExtract_token(Data->Key, ReadBuf, 0, '|');
125 StrBufExtract_token(Data->Val, ReadBuf, 1, '|');
126 if (!IsEmptyStr(ChrPtr(Data->Key)))
136 lprintf(1, "ignoring spurious preference line: [%s]\n",
138 DestroyPreference(Data);
148 * display preferences dialog
150 void load_preferences(void)
156 if (!goto_config_room())
159 ReadBuf = NewStrBuf();
160 serv_puts("MSGS ALL|0|1");
161 StrBuf_ServGetln(ReadBuf);
162 if (GetServerStatus(ReadBuf, NULL) == 8) {
163 serv_puts("subj|__ WebCit Preferences __");
166 while (serv_getln(buf, sizeof buf), strcmp(buf, "000")) {
171 serv_printf("MSG0 %ld", msgnum);
172 StrBuf_ServGetln(ReadBuf);
173 if (GetServerStatus(ReadBuf, NULL) == 1) {
174 while (StrBuf_ServGetln(ReadBuf),
175 (strcmp(ChrPtr(ReadBuf), "text") &&
176 strcmp(ChrPtr(ReadBuf), "000"))) {
178 if (!strcmp(ChrPtr(ReadBuf), "text")) {
179 ParsePref(&WC->hash_prefs, ReadBuf);
184 /* Go back to the room we're supposed to be in */
185 serv_printf("GOTO %s", ChrPtr(WC->wc_roomname));
186 StrBuf_ServGetln(ReadBuf);
187 GetServerStatus(ReadBuf, NULL);
188 FreeStrBuf(&ReadBuf);
192 * \brief Goto the user's configuration room, creating it if necessary.
193 * \return 0 on success or nonzero upon failure.
195 int goto_config_room(void) {
198 serv_printf("GOTO %s", USERCONFIGROOM);
199 serv_getln(buf, sizeof buf);
200 if (buf[0] != '2') { /* try to create the config room if not there */
201 serv_printf("CRE8 1|%s|4|0", USERCONFIGROOM);
202 serv_getln(buf, sizeof buf);
203 serv_printf("GOTO %s", USERCONFIGROOM);
204 serv_getln(buf, sizeof buf);
205 if (buf[0] != '2') return(1);
210 void WritePrefsToServer(HashList *Hash)
217 StrBuf *SubBuf = NULL;
219 Hash = WC->hash_prefs;
220 #ifdef DBG_PREFS_HASH
221 dbg_PrintHash(Hash, PrintPref, NULL);
223 HashPos = GetNewHashPos(Hash, 0);
224 while (GetNextHashPos(Hash, HashPos, &len, &Key, &vPref)!=0)
229 Pref = (Preference*) vPref;
230 nchars = StrLength(Pref->Val);
233 size_t offset, nchars;
235 SubBuf = NewStrBuf();
244 nchars = StrBufSub(SubBuf, Pref->Val, offset, nchars);
247 serv_printf("%s|%s", ChrPtr(Pref->Key), ChrPtr(SubBuf));
249 serv_printf(" %s", ChrPtr(SubBuf));
252 nchars = StrLength(Pref->Val) - offset;
258 serv_printf("%s|%s", ChrPtr(Pref->Key), ChrPtr(Pref->Val));
262 DeleteHashPos(&HashPos);
266 * \brief save the modifications
268 void save_preferences(void)
273 if (goto_config_room() != 0) return; /* oh well. */
274 serv_puts("MSGS ALL|0|1");
275 serv_getln(buf, sizeof buf);
277 serv_puts("subj|__ WebCit Preferences __");
280 while (serv_getln(buf, sizeof buf), strcmp(buf, "000")) {
285 serv_printf("DELE %ld", msgnum);
286 serv_getln(buf, sizeof buf);
289 serv_printf("ENT0 1||0|1|__ WebCit Preferences __|");
290 serv_getln(buf, sizeof buf);
293 WritePrefsToServer(WC->hash_prefs);
298 /** Go back to the room we're supposed to be in */
299 serv_printf("GOTO %s", ChrPtr(WC->wc_roomname));
300 serv_getln(buf, sizeof buf);
304 * \brief query the actual setting of key in the citadel database
305 * \param key config key to query
306 * \param keylen length of the key string
307 * \param value StrBuf-value to the key to get
310 int get_pref_backend(const char *key, size_t keylen, Preference **Pref)
312 void *hash_value = NULL;
313 #ifdef DBG_PREFS_HASH
314 dbg_PrintHash(WC->hash_prefs, PrintPref, NULL);
316 if (GetHash(WC->hash_prefs, key, keylen, &hash_value) == 0) {
321 *Pref = (Preference*) hash_value;
326 int get_PREFERENCE(const char *key, size_t keylen, StrBuf **value)
331 Ret = get_pref_backend(key, keylen, &Pref);
340 * \brief Write a key into the webcit preferences database for this user
342 * \params key key whichs value is to be modified
343 * \param keylen length of the key string
344 * \param value value to set
345 * \param save_to_server 1 = flush all data to the server, 0 = cache it for now
347 void set_preference_backend(const char *key, size_t keylen,
357 Pref = (Preference*) malloc(sizeof(Preference));
358 memset(Pref, 0, sizeof(Preference));
359 Pref->Key = NewStrBufPlain(key, keylen);
361 if ((PrefType == NULL) &&
362 GetHash(PreferenceHooks, SKEY(Pref->Key), &vPrefDef) &&
364 PrefType = (PrefDef*) vPrefDef;
366 if (PrefType != NULL)
368 Pref->Type = PrefType;
369 if (Pref->Type->Type != lPrefType)
370 lprintf(1, "warning: saving preference with wrong type [%s] %ld != %ld \n",
371 key, Pref->Type->Type, lPrefType);
372 switch (Pref->Type->Type)
381 if (Pref->Val == NULL)
382 Pref->Val = NewStrBufPlain(NULL, 64);
383 StrBufPrintf(Pref->Val, "%ld", lvalue);
387 Pref->DeQPed = value;
388 Pref->Val = NewStrBufPlain(NULL, StrLength(Pref->DeQPed) * 3);
389 StrBufEUid_escapize(Pref->Val, Pref->DeQPed);
395 Pref->Val = NewStrBufPlain(HKEY("yes"));
397 Pref->Val = NewStrBufPlain(HKEY("no"));
401 if (Pref->Type->OnLoad != NULL)
402 Pref->Type->OnLoad(Pref->Val, Pref->lval);
414 if (Pref->Val == NULL)
415 Pref->Val = NewStrBufPlain(NULL, 64);
416 StrBufPrintf(Pref->Val, "%ld", lvalue);
420 Pref->DeQPed = value;
421 Pref->Val = NewStrBufPlain(NULL, StrLength(Pref->DeQPed) * 3);
422 StrBufEUid_escapize(Pref->Val, Pref->DeQPed);
428 Pref->Val = NewStrBufPlain(HKEY("yes"));
430 Pref->Val = NewStrBufPlain(HKEY("no"));
435 Put(WC->hash_prefs, key, keylen, Pref, DestroyPreference);
437 if (save_to_server) WC->SavePrefsToServer = 1;
440 void set_PREFERENCE(const char *key, size_t keylen, StrBuf *value, int save_to_server)
442 set_preference_backend(key, keylen, 0, value, PRF_STRING, save_to_server, NULL);
445 int get_PREF_LONG(const char *key, size_t keylen, long *value, long Default)
450 Ret = get_pref_backend(key, keylen, &Pref);
459 *value = Pref->lval = atol(ChrPtr(Pref->Val));
466 void set_PREF_LONG(const char *key, size_t keylen, long value, int save_to_server)
468 set_preference_backend(key, keylen, value, NULL, PRF_INT, save_to_server, NULL);
471 int get_PREF_YESNO(const char *key, size_t keylen, int *value, int Default)
476 Ret = get_pref_backend(key, keylen, &Pref);
485 *value = Pref->lval = strcmp(ChrPtr(Pref->Val), "yes") == 0;
491 void set_PREF_YESNO(const char *key, size_t keylen, long value, int save_to_server)
493 set_preference_backend(key, keylen, value, NULL, PRF_YESNO, save_to_server, NULL);
496 int get_room_prefs_backend(const char *key, size_t keylen, Preference **Pref)
501 pref_name = NewStrBuf ();
502 StrBufPrintf(pref_name, "%s:%s", key, ChrPtr(WC->wc_roomname));
503 Ret = get_pref_backend(SKEY(pref_name), Pref);
504 FreeStrBuf(&pref_name);
509 StrBuf *get_ROOM_PREFS(const char *key, size_t keylen)
514 Ret = get_room_prefs_backend(key, keylen, &Pref);
523 void set_ROOM_PREFS(const char *key, size_t keylen, StrBuf *value, int save_to_server)
527 pref_name = NewStrBuf ();
528 StrBufPrintf(pref_name, "%s:%s", key, ChrPtr(WC->wc_roomname));
529 set_preference_backend(SKEY(pref_name), 0, value, PRF_STRING, save_to_server, NULL);
530 FreeStrBuf(&pref_name);
534 void GetPreferences(HashList *Setting)
546 Tmp = WCC->hash_prefs;
547 WCC->hash_prefs = Setting;
549 It = GetNewHashPos(PreferenceHooks, 0);
550 while (GetNextHashPos(PreferenceHooks, It, &len, &Key, &vSetting)) {
551 PrefType = (PrefDef*) vSetting;
553 if (!HaveBstr(SKEY(PrefType->Setting)))
555 switch (PrefType->Type) {
557 Buf = NewStrBufDup(SBstr(SKEY(PrefType->Setting)));
558 set_preference_backend(SKEY(PrefType->Setting),
566 lval = LBstr(SKEY(PrefType->Setting));
567 set_preference_backend(SKEY(PrefType->Setting),
575 Buf = NewStrBufDup(SBstr(SKEY(PrefType->Setting)));
576 set_preference_backend(SKEY(PrefType->Setting),
584 lval = YesBstr(SKEY(PrefType->Setting));
585 set_preference_backend(SKEY(PrefType->Setting),
594 WCC->hash_prefs = Tmp;
599 * \brief Commit new preferences and settings
601 void set_preferences(void)
603 if (!havebstr("change_button")) {
604 safestrncpy(WC->ImportantMessage,
605 _("Cancelled. No settings were changed."),
606 sizeof WC->ImportantMessage);
610 GetPreferences(WC->hash_prefs);
615 void tmplput_CFG_Value(StrBuf *Target, WCTemplputParams *TP)
618 if (get_pref_backend(TKEY(0), &Pref))
620 if (Pref->Type == NULL) {
621 StrBufAppendTemplate(Target, TP, Pref->Val, 1);
623 switch (Pref->Type->Type)
626 StrBufAppendTemplate(Target, TP, Pref->Val, 1);
629 if (Pref->decoded != 1) {
630 if (Pref->Val == NULL)
631 Pref->Val = NewStrBufPlain(NULL, 64);
632 StrBufPrintf(Pref->Val, "%ld", Pref->lval);
635 StrBufAppendTemplate(Target, TP, Pref->Val, 1);
638 if (Pref->decoded != 1) {
639 if (Pref->DeQPed == NULL)
640 Pref->DeQPed = NewStrBufPlain(NULL, StrLength(Pref->Val));
642 StrBufEUid_unescapize(Pref->DeQPed, Pref->Val);
645 StrBufAppendTemplate(Target, TP, Pref->DeQPed, 1);
648 if (Pref->decoded != 1) {
649 Pref->lval = strcmp(ChrPtr(Pref->Val), "yes") == 0;
652 StrBufAppendTemplate(Target, TP, Pref->Val, 1);
658 void tmplput_CFG_Descr(StrBuf *Target, WCTemplputParams *TP)
660 const char *SettingStr;
661 SettingStr = PrefGetLocalStr(TKEY(0));
662 if (SettingStr != NULL)
663 StrBufAppendBufPlain(Target, SettingStr, -1, 0);
665 void tmplput_CFG_RoomValue(StrBuf *Target, WCTemplputParams *TP)
667 StrBuf *pref = get_ROOM_PREFS(TKEY(0));
669 StrBufAppendBuf(Target, pref, 0);
671 int ConditionalHasRoomPreference(StrBuf *Target, WCTemplputParams *TP)
673 if (get_ROOM_PREFS(TP->Tokens->Params[0]->Start,
674 TP->Tokens->Params[0]->len) != NULL)
679 void CfgZoneTempl(StrBuf *TemplBuffer, WCTemplputParams *TP)
681 StrBuf *Zone = (StrBuf*) CTX;
683 SVPutBuf("ZONENAME", Zone, 1);
686 int ConditionalPreference(StrBuf *Target, WCTemplputParams *TP)
690 if (!get_PREFERENCE(TKEY(2), &Pref))
693 if (TP->Tokens->nParameters == 3) {
696 else if (TP->Tokens->Params[3]->Type == TYPE_STR)
697 return ((TP->Tokens->Params[3]->len == StrLength(Pref)) &&
698 (strcmp(TP->Tokens->Params[3]->Start, ChrPtr(Pref)) == 0));
700 return (StrTol(Pref) == TP->Tokens->Params[3]->lvalue);
703 int ConditionalHasPreference(StrBuf *Target, WCTemplputParams *TP)
707 if (!get_PREFERENCE(TKEY(2), &Pref) ||
715 /********************************************************************************
716 * preferences stored discrete in citserver
717 ********************************************************************************/
718 HashList *GetGVEAHash(StrBuf *Target, WCTemplputParams *TP)
721 HashList *List = NULL;
728 StrBuf_ServGetln(Rcp);
729 if (GetServerStatus(Rcp, NULL) == 1) {
731 List = NewHash(1, NULL);
732 while (!Done && (StrBuf_ServGetln(Rcp)>=0)) {
733 if ( (StrLength(Rcp)==3) &&
734 !strcmp(ChrPtr(Rcp), "000"))
739 i = snprintf(N, sizeof(N), "%d", n);
741 Put(List, N, i, Rcp, HFreeStrBuf);
750 void DeleteGVEAHash(HashList **KillMe)
755 HashList *GetGVSNHash(StrBuf *Target, WCTemplputParams *TP)
758 HashList *List = NULL;
765 StrBuf_ServGetln(Rcp);
766 if (GetServerStatus(Rcp, NULL) == 1) {
768 List = NewHash(1, NULL);
769 while (!Done && (StrBuf_ServGetln(Rcp)>=0)) {
770 if ( (StrLength(Rcp)==3) &&
771 !strcmp(ChrPtr(Rcp), "000"))
776 i = snprintf(N, sizeof(N), "%d", n);
778 Put(List, N, i, Rcp, HFreeStrBuf);
787 void DeleteGVSNHash(HashList **KillMe)
796 * Offer to make any page the user's "start page."
798 void offer_start_page(StrBuf *Target, WCTemplputParams *TP)
800 wprintf("<a href=\"change_start_page?startpage=");
801 urlescputs(WC->this_page);
803 wprintf(_("Make this my start page"));
806 wprintf("<br/><a href=\"rss?room=");
807 urlescputs(ChrPtr(WC->wc_roomname));
808 wprintf("\" title=\"RSS 2.0 feed for ");
809 escputs(ChrPtr(WC->wc_roomname));
810 wprintf("\"><img alt=\"RSS\" border=\"0\" src=\"static/xml_button.gif\"/></a>\n");
816 * Change the user's start page
818 void change_start_page(void)
820 if (!havebstr("startpage")) {
821 set_preference_backend(HKEY("startpage"),
823 NewStrBufPlain(HKEY("")),
827 safestrncpy(WC->ImportantMessage,
828 _("You no longer have a start page selected."),
829 sizeof( WC->ImportantMessage));
834 set_preference_backend(HKEY("startpage"),
836 NewStrBufDup(sbstr("startpage")),
841 output_headers(1, 1, 0, 0, 0, 0);
842 do_template("newstartpage", NULL);
848 InitModule_PREFERENCES
851 WebcitAddUrlHandler(HKEY("set_preferences"), set_preferences, 0);
852 WebcitAddUrlHandler(HKEY("change_start_page"), change_start_page, 0);
855 RegisterNamespace("OFFERSTARTPAGE", 0, 0, offer_start_page, CTX_NONE);
856 RegisterNamespace("PREF:ROOM:VALUE", 1, 2, tmplput_CFG_RoomValue, CTX_NONE);
857 RegisterNamespace("PREF:VALUE", 1, 2, tmplput_CFG_Value, CTX_NONE);
858 RegisterNamespace("PREF:DESCR", 1, 1, tmplput_CFG_Descr, CTX_NONE);
859 RegisterIterator("PREF:ZONE", 0, ZoneHash, NULL, CfgZoneTempl, NULL, CTX_PREF, CTX_NONE, IT_NOFLAG);
861 RegisterConditional(HKEY("COND:PREF"), 4, ConditionalPreference, CTX_NONE);
862 RegisterConditional(HKEY("COND:PREF:SET"), 4, ConditionalHasPreference, CTX_NONE);
863 RegisterConditional(HKEY("COND:ROOM:SET"), 4, ConditionalHasRoomPreference, CTX_NONE);
865 RegisterIterator("PREF:VALID:EMAIL:ADDR", 0, NULL,
866 GetGVEAHash, NULL, DeleteGVEAHash, CTX_STRBUF, CTX_NONE, IT_NOFLAG);
867 RegisterIterator("PREF:VALID:EMAIL:NAME", 0, NULL,
868 GetGVSNHash, NULL, DeleteGVSNHash, CTX_STRBUF, CTX_NONE, IT_NOFLAG);