4 * Manage user preferences with a little help from the Citadel server.
12 HashList *PreferenceHooks;
14 typedef struct _PrefDef {
22 typedef struct _Preference {
32 void DestroyPrefDef(void *vPrefDef)
34 PrefDef *Prefdef = (PrefDef*) vPrefDef;
35 FreeStrBuf(&Prefdef->Setting);
36 FreeStrBuf(&Prefdef->OnLoadName);
40 void DestroyPreference(void *vPref)
42 Preference *Pref = (Preference*) vPref;
43 FreeStrBuf(&Pref->Key);
44 FreeStrBuf(&Pref->Val);
45 FreeStrBuf(&Pref->DeQPed);
49 void _RegisterPreference(const char *Setting, long SettingLen,
53 const char *OnLoadName)
55 PrefDef *Newpref = (PrefDef*) malloc(sizeof(PrefDef));
56 Newpref->Setting = NewStrBufPlain(Setting, SettingLen);
57 Newpref->PrefStr = PrefStr;
59 Newpref->OnLoad = OnLoad;
60 if (Newpref->OnLoad != NULL) {
61 Newpref->OnLoadName = NewStrBufPlain(OnLoadName, -1);
64 Newpref->OnLoadName = NULL;
65 Put(PreferenceHooks, Setting, SettingLen, Newpref, DestroyPrefDef);
68 const char *PrefGetLocalStr(const char *Setting, long len)
71 if (GetHash(PreferenceHooks, Setting, len, &hash_value) != 0) {
72 PrefDef *Newpref = (PrefDef*) hash_value;
73 return _(Newpref->PrefStr);
80 inline const char *PrintPref(void *vPref)
82 Preference *Pref = (Preference*) vPref;
83 if (Pref->DeQPed != NULL)
84 return ChrPtr(Pref->DeQPed);
86 return ChrPtr(Pref->Val);
90 void GetPrefTypes(HashList *List)
100 It = GetNewHashPos(List, 0);
101 while (GetNextHashPos(List, It, &len, &Key, &vSetting))
103 Pref = (Preference*) vSetting;
104 if (GetHash(PreferenceHooks, SKEY(Pref->Key), &vPrefDef) &&
107 PrefType = (PrefDef*) vPrefDef;
108 Pref->Type = PrefType;
110 lprintf(1, "Loading [%s]with type [%ld] [\"%s\"]\n",
115 switch (Pref->Type->Type)
121 Pref->lval = StrTol(Pref->Val);
125 Pref->DeQPed = NewStrBufPlain(NULL, StrLength(Pref->Val));
126 StrBufEUid_unescapize(Pref->DeQPed, Pref->Val);
130 Pref->lval = strcmp(ChrPtr(Pref->Val), "yes") == 0;
135 if (PrefType->OnLoad != NULL){
137 lprintf(1, "Loading with: -> %s(\"%s\", %ld)\n",
138 ChrPtr(PrefType->OnLoadName),
141 PrefType->OnLoad(Pref->Val, Pref->lval);
148 void ParsePref(HashList **List, StrBuf *ReadBuf)
150 Preference *Data = NULL;
151 Preference *LastData = NULL;
153 while (StrBuf_ServGetln(ReadBuf),
154 strcmp(ChrPtr(ReadBuf), "000"))
156 if ((ChrPtr(ReadBuf)[0] == ' ') &&
158 StrBufAppendBuf(Data->Val, ReadBuf, 1);
161 LastData = Data = malloc(sizeof(Preference));
162 memset(Data, 0, sizeof(Preference));
163 Data->Key = NewStrBuf();
164 Data->Val = NewStrBuf();
165 StrBufExtract_token(Data->Key, ReadBuf, 0, '|');
166 StrBufExtract_token(Data->Val, ReadBuf, 1, '|');
167 if (!IsEmptyStr(ChrPtr(Data->Key)))
177 lprintf(1, "ignoring spurious preference line: [%s]\n",
179 DestroyPreference(Data);
189 * display preferences dialog
191 void load_preferences(void)
197 if (goto_config_room() != 0) return; /* oh well. */
199 ReadBuf = NewStrBuf();
200 serv_puts("MSGS ALL|0|1");
201 StrBuf_ServGetln(ReadBuf);
202 if (GetServerStatus(ReadBuf, NULL) == 8) {
203 serv_puts("subj|__ WebCit Preferences __");
207 StrBuf_ServGetln(ReadBuf)) {
208 if ( (StrLength(ReadBuf)==3) &&
209 !strcmp(ChrPtr(ReadBuf), "000")) {
213 msgnum = StrTol(ReadBuf);
217 serv_printf("MSG0 %ld", msgnum);
218 StrBuf_ServGetln(ReadBuf);
219 if (GetServerStatus(ReadBuf, NULL) == 1) {
220 while (StrBuf_ServGetln(ReadBuf),
221 (strcmp(ChrPtr(ReadBuf), "text") &&
222 strcmp(ChrPtr(ReadBuf), "000"))) {
224 if (!strcmp(ChrPtr(ReadBuf), "text")) {
225 ParsePref(&WC->hash_prefs, ReadBuf);
230 /* Go back to the room we're supposed to be in */
231 serv_printf("GOTO %s", ChrPtr(WC->wc_roomname));
232 StrBuf_ServGetln(ReadBuf);
233 GetServerStatus(ReadBuf, NULL);
234 FreeStrBuf(&ReadBuf);
238 * \brief Goto the user's configuration room, creating it if necessary.
239 * \return 0 on success or nonzero upon failure.
241 int goto_config_room(void) {
244 serv_printf("GOTO %s", USERCONFIGROOM);
245 serv_getln(buf, sizeof buf);
246 if (buf[0] != '2') { /* try to create the config room if not there */
247 serv_printf("CRE8 1|%s|4|0", USERCONFIGROOM);
248 serv_getln(buf, sizeof buf);
249 serv_printf("GOTO %s", USERCONFIGROOM);
250 serv_getln(buf, sizeof buf);
251 if (buf[0] != '2') return(1);
256 void WritePrefsToServer(HashList *Hash)
263 StrBuf *SubBuf = NULL;
265 Hash = WC->hash_prefs;
266 #ifdef DBG_PREFS_HASH
267 dbg_PrintHash(Hash, PrintPref, NULL);
269 HashPos = GetNewHashPos(Hash, 0);
270 while (GetNextHashPos(Hash, HashPos, &len, &Key, &vPref)!=0)
275 Pref = (Preference*) vPref;
276 nchars = StrLength(Pref->Val);
279 size_t offset, nchars;
281 SubBuf = NewStrBuf();
290 nchars = StrBufSub(SubBuf, Pref->Val, offset, nchars);
293 serv_printf("%s|%s", ChrPtr(Pref->Key), ChrPtr(SubBuf));
295 serv_printf(" %s", ChrPtr(SubBuf));
298 nchars = StrLength(Pref->Val) - offset;
304 serv_printf("%s|%s", ChrPtr(Pref->Key), ChrPtr(Pref->Val));
308 DeleteHashPos(&HashPos);
312 * \brief save the modifications
314 void save_preferences(void)
320 ReadBuf = NewStrBuf();
321 if (goto_config_room() != 0) return; /* oh well. */
322 serv_puts("MSGS ALL|0|1");
323 StrBuf_ServGetln(ReadBuf);
324 if (GetServerStatus(ReadBuf, NULL) == 8) {
325 serv_puts("subj|__ WebCit Preferences __");
329 StrBuf_ServGetln(ReadBuf)) {
330 if ( (StrLength(ReadBuf)==3) &&
331 !strcmp(ChrPtr(ReadBuf), "000")) {
335 msgnum = StrTol(ReadBuf);
339 serv_printf("DELE %ld", msgnum);
340 StrBuf_ServGetln(ReadBuf);
341 GetServerStatus(ReadBuf, NULL);
344 serv_printf("ENT0 1||0|1|__ WebCit Preferences __|");
345 StrBuf_ServGetln(ReadBuf);
346 if (GetServerStatus(ReadBuf, NULL) == 4) {
348 WritePrefsToServer(WC->hash_prefs);
353 /** Go back to the room we're supposed to be in */
354 serv_printf("GOTO %s", ChrPtr(WC->wc_roomname));
355 StrBuf_ServGetln(ReadBuf);
356 FreeStrBuf(&ReadBuf);
360 * \brief query the actual setting of key in the citadel database
361 * \param key config key to query
362 * \param keylen length of the key string
363 * \param value StrBuf-value to the key to get
366 int get_pref_backend(const char *key, size_t keylen, Preference **Pref)
368 void *hash_value = NULL;
369 #ifdef DBG_PREFS_HASH
370 dbg_PrintHash(WC->hash_prefs, PrintPref, NULL);
372 if (GetHash(WC->hash_prefs, key, keylen, &hash_value) == 0) {
377 *Pref = (Preference*) hash_value;
382 int get_PREFERENCE(const char *key, size_t keylen, StrBuf **value)
387 Ret = get_pref_backend(key, keylen, &Pref);
396 * \brief Write a key into the webcit preferences database for this user
398 * \params key key whichs value is to be modified
399 * \param keylen length of the key string
400 * \param value value to set
401 * \param save_to_server 1 = flush all data to the server, 0 = cache it for now
403 void set_preference_backend(const char *key, size_t keylen,
413 Pref = (Preference*) malloc(sizeof(Preference));
414 memset(Pref, 0, sizeof(Preference));
415 Pref->Key = NewStrBufPlain(key, keylen);
417 if ((PrefType == NULL) &&
418 GetHash(PreferenceHooks, SKEY(Pref->Key), &vPrefDef) &&
420 PrefType = (PrefDef*) vPrefDef;
422 if (PrefType != NULL)
424 Pref->Type = PrefType;
425 if (Pref->Type->Type != lPrefType)
426 lprintf(1, "warning: saving preference with wrong type [%s] %ld != %ld \n",
427 key, Pref->Type->Type, lPrefType);
428 switch (Pref->Type->Type)
437 if (Pref->Val == NULL)
438 Pref->Val = NewStrBufPlain(NULL, 64);
439 StrBufPrintf(Pref->Val, "%ld", lvalue);
443 Pref->DeQPed = value;
444 Pref->Val = NewStrBufPlain(NULL, StrLength(Pref->DeQPed) * 3);
445 StrBufEUid_escapize(Pref->Val, Pref->DeQPed);
451 Pref->Val = NewStrBufPlain(HKEY("yes"));
453 Pref->Val = NewStrBufPlain(HKEY("no"));
457 if (Pref->Type->OnLoad != NULL)
458 Pref->Type->OnLoad(Pref->Val, Pref->lval);
470 if (Pref->Val == NULL)
471 Pref->Val = NewStrBufPlain(NULL, 64);
472 StrBufPrintf(Pref->Val, "%ld", lvalue);
476 Pref->DeQPed = value;
477 Pref->Val = NewStrBufPlain(NULL, StrLength(Pref->DeQPed) * 3);
478 StrBufEUid_escapize(Pref->Val, Pref->DeQPed);
484 Pref->Val = NewStrBufPlain(HKEY("yes"));
486 Pref->Val = NewStrBufPlain(HKEY("no"));
491 Put(WC->hash_prefs, key, keylen, Pref, DestroyPreference);
493 if (save_to_server) WC->SavePrefsToServer = 1;
496 void set_PREFERENCE(const char *key, size_t keylen, StrBuf *value, int save_to_server)
498 set_preference_backend(key, keylen, 0, value, PRF_STRING, save_to_server, NULL);
501 int get_PREF_LONG(const char *key, size_t keylen, long *value, long Default)
506 Ret = get_pref_backend(key, keylen, &Pref);
515 *value = Pref->lval = atol(ChrPtr(Pref->Val));
522 void set_PREF_LONG(const char *key, size_t keylen, long value, int save_to_server)
524 set_preference_backend(key, keylen, value, NULL, PRF_INT, save_to_server, NULL);
527 int get_PREF_YESNO(const char *key, size_t keylen, int *value, int Default)
532 Ret = get_pref_backend(key, keylen, &Pref);
541 *value = Pref->lval = strcmp(ChrPtr(Pref->Val), "yes") == 0;
547 void set_PREF_YESNO(const char *key, size_t keylen, long value, int save_to_server)
549 set_preference_backend(key, keylen, value, NULL, PRF_YESNO, save_to_server, NULL);
552 int get_room_prefs_backend(const char *key, size_t keylen,
558 pref_name = NewStrBufPlain (HKEY("ROOM:"));
559 StrBufAppendBuf(pref_name, WC->wc_roomname, 0);
560 StrBufAppendBufPlain(pref_name, HKEY(":"), 0);
561 StrBufAppendBufPlain(pref_name, key, keylen, 0);
562 Ret = get_pref_backend(SKEY(pref_name), Pref);
563 FreeStrBuf(&pref_name);
568 const StrBuf *get_X_PREFS(const char *key, size_t keylen,
569 const char *xkey, size_t xkeylen)
575 pref_name = NewStrBufPlain (HKEY("XPREF:"));
576 StrBufAppendBufPlain(pref_name, xkey, xkeylen, 0);
577 StrBufAppendBufPlain(pref_name, HKEY(":"), 0);
578 StrBufAppendBufPlain(pref_name, key, keylen, 0);
580 ret = get_pref_backend(SKEY(pref_name), &Prf);
581 FreeStrBuf(&pref_name);
588 void set_X_PREFS(const char *key, size_t keylen, const char *xkey, size_t xkeylen, StrBuf *value, int save_to_server)
592 pref_name = NewStrBufPlain (HKEY("XPREF:"));
593 StrBufAppendBufPlain(pref_name, xkey, xkeylen, 0);
594 StrBufAppendBufPlain(pref_name, HKEY(":"), 0);
595 StrBufAppendBufPlain(pref_name, key, keylen, 0);
597 set_preference_backend(SKEY(pref_name), 0, value, PRF_STRING, save_to_server, NULL);
598 FreeStrBuf(&pref_name);
602 StrBuf *get_ROOM_PREFS(const char *key, size_t keylen)
607 Ret = get_room_prefs_backend(key, keylen, &Pref);
616 void set_ROOM_PREFS(const char *key, size_t keylen, StrBuf *value, int save_to_server)
620 pref_name = NewStrBufPlain (HKEY("ROOM:"));
621 StrBufAppendBuf(pref_name, WC->wc_roomname, 0);
622 StrBufAppendBufPlain(pref_name, HKEY(":"), 0);
623 StrBufAppendBufPlain(pref_name, key, keylen, 0);
624 set_preference_backend(SKEY(pref_name), 0, value, PRF_STRING, save_to_server, NULL);
625 FreeStrBuf(&pref_name);
629 void GetPreferences(HashList *Setting)
641 Tmp = WCC->hash_prefs;
642 WCC->hash_prefs = Setting;
644 It = GetNewHashPos(PreferenceHooks, 0);
645 while (GetNextHashPos(PreferenceHooks, It, &len, &Key, &vSetting)) {
646 PrefType = (PrefDef*) vSetting;
648 if (!HaveBstr(SKEY(PrefType->Setting)))
650 switch (PrefType->Type) {
652 Buf = NewStrBufDup(SBstr(SKEY(PrefType->Setting)));
653 set_preference_backend(SKEY(PrefType->Setting),
661 lval = LBstr(SKEY(PrefType->Setting));
662 set_preference_backend(SKEY(PrefType->Setting),
670 Buf = NewStrBufDup(SBstr(SKEY(PrefType->Setting)));
671 set_preference_backend(SKEY(PrefType->Setting),
679 lval = YesBstr(SKEY(PrefType->Setting));
680 set_preference_backend(SKEY(PrefType->Setting),
689 WCC->hash_prefs = Tmp;
695 * \brief Commit new preferences and settings
697 void set_preferences(void)
699 if (!havebstr("change_button")) {
700 safestrncpy(WC->ImportantMessage,
701 _("Cancelled. No settings were changed."),
702 sizeof WC->ImportantMessage);
706 GetPreferences(WC->hash_prefs);
711 void tmplput_CFG_Value(StrBuf *Target, WCTemplputParams *TP)
714 if (get_pref_backend(TKEY(0), &Pref))
716 if (Pref->Type == NULL) {
717 StrBufAppendTemplate(Target, TP, Pref->Val, 1);
719 switch (Pref->Type->Type)
722 StrBufAppendTemplate(Target, TP, Pref->Val, 1);
725 if (Pref->decoded != 1) {
726 if (Pref->Val == NULL)
727 Pref->Val = NewStrBufPlain(NULL, 64);
728 StrBufPrintf(Pref->Val, "%ld", Pref->lval);
731 StrBufAppendTemplate(Target, TP, Pref->Val, 1);
734 if (Pref->decoded != 1) {
735 if (Pref->DeQPed == NULL)
736 Pref->DeQPed = NewStrBufPlain(NULL, StrLength(Pref->Val));
738 StrBufEUid_unescapize(Pref->DeQPed, Pref->Val);
741 StrBufAppendTemplate(Target, TP, Pref->DeQPed, 1);
744 if (Pref->decoded != 1) {
745 Pref->lval = strcmp(ChrPtr(Pref->Val), "yes") == 0;
748 StrBufAppendTemplate(Target, TP, Pref->Val, 1);
754 void tmplput_CFG_Descr(StrBuf *Target, WCTemplputParams *TP)
756 const char *SettingStr;
757 SettingStr = PrefGetLocalStr(TKEY(0));
758 if (SettingStr != NULL)
759 StrBufAppendBufPlain(Target, SettingStr, -1, 0);
761 void tmplput_CFG_RoomValue(StrBuf *Target, WCTemplputParams *TP)
763 StrBuf *pref = get_ROOM_PREFS(TKEY(0));
765 StrBufAppendBuf(Target, pref, 0);
767 int ConditionalHasRoomPreference(StrBuf *Target, WCTemplputParams *TP)
769 if (get_ROOM_PREFS(TP->Tokens->Params[0]->Start,
770 TP->Tokens->Params[0]->len) != NULL)
775 void CfgZoneTempl(StrBuf *TemplBuffer, WCTemplputParams *TP)
777 StrBuf *Zone = (StrBuf*) CTX;
779 SVPutBuf("ZONENAME", Zone, 1);
782 int ConditionalPreference(StrBuf *Target, WCTemplputParams *TP)
786 if (!get_PREFERENCE(TKEY(2), &Pref))
789 if (TP->Tokens->nParameters == 3) {
792 else if (TP->Tokens->Params[3]->Type == TYPE_STR)
793 return ((TP->Tokens->Params[3]->len == StrLength(Pref)) &&
794 (strcmp(TP->Tokens->Params[3]->Start, ChrPtr(Pref)) == 0));
796 return (StrTol(Pref) == TP->Tokens->Params[3]->lvalue);
799 int ConditionalHasPreference(StrBuf *Target, WCTemplputParams *TP)
803 if (!get_PREFERENCE(TKEY(2), &Pref) ||
811 /********************************************************************************
812 * preferences stored discrete in citserver
813 ********************************************************************************/
814 HashList *GetGVEAHash(StrBuf *Target, WCTemplputParams *TP)
817 HashList *List = NULL;
824 StrBuf_ServGetln(Rcp);
825 if (GetServerStatus(Rcp, NULL) == 1) {
827 List = NewHash(1, NULL);
828 while (!Done && (StrBuf_ServGetln(Rcp)>=0)) {
829 if ( (StrLength(Rcp)==3) &&
830 !strcmp(ChrPtr(Rcp), "000"))
835 i = snprintf(N, sizeof(N), "%d", n);
837 Put(List, N, i, Rcp, HFreeStrBuf);
846 void DeleteGVEAHash(HashList **KillMe)
851 HashList *GetGVSNHash(StrBuf *Target, WCTemplputParams *TP)
854 HashList *List = NULL;
861 StrBuf_ServGetln(Rcp);
862 if (GetServerStatus(Rcp, NULL) == 1) {
864 List = NewHash(1, NULL);
865 while (!Done && (StrBuf_ServGetln(Rcp)>=0)) {
866 if ( (StrLength(Rcp)==3) &&
867 !strcmp(ChrPtr(Rcp), "000"))
872 i = snprintf(N, sizeof(N), "%d", n);
874 Put(List, N, i, Rcp, HFreeStrBuf);
883 void DeleteGVSNHash(HashList **KillMe)
892 * Offer to make any page the user's "start page."
894 void offer_start_page(StrBuf *Target, WCTemplputParams *TP)
896 wprintf("<a href=\"change_start_page?startpage=");
897 urlescputs(ChrPtr(WC->this_page));
899 wprintf(_("Make this my start page"));
902 wprintf("<br/><a href=\"rss?room=");
903 urlescputs(ChrPtr(WC->wc_roomname));
904 wprintf("\" title=\"RSS 2.0 feed for ");
905 escputs(ChrPtr(WC->wc_roomname));
906 wprintf("\"><img alt=\"RSS\" border=\"0\" src=\"static/xml_button.gif\"/></a>\n");
912 * Change the user's start page
914 void change_start_page(void)
916 if (!havebstr("startpage")) {
917 set_preference_backend(HKEY("startpage"),
919 NewStrBufPlain(HKEY("")),
923 safestrncpy(WC->ImportantMessage,
924 _("You no longer have a start page selected."),
925 sizeof( WC->ImportantMessage));
930 set_preference_backend(HKEY("startpage"),
932 NewStrBufDup(sbstr("startpage")),
937 output_headers(1, 1, 0, 0, 0, 0);
938 do_template("newstartpage", NULL);
944 InitModule_PREFERENCES
947 WebcitAddUrlHandler(HKEY("set_preferences"), set_preferences, 0);
948 WebcitAddUrlHandler(HKEY("change_start_page"), change_start_page, 0);
951 RegisterNamespace("OFFERSTARTPAGE", 0, 0, offer_start_page, CTX_NONE);
952 RegisterNamespace("PREF:ROOM:VALUE", 1, 2, tmplput_CFG_RoomValue, CTX_NONE);
953 RegisterNamespace("PREF:VALUE", 1, 2, tmplput_CFG_Value, CTX_NONE);
954 RegisterNamespace("PREF:DESCR", 1, 1, tmplput_CFG_Descr, CTX_NONE);
955 RegisterIterator("PREF:ZONE", 0, ZoneHash, NULL, CfgZoneTempl, NULL, CTX_PREF, CTX_NONE, IT_NOFLAG);
957 RegisterConditional(HKEY("COND:PREF"), 4, ConditionalPreference, CTX_NONE);
958 RegisterConditional(HKEY("COND:PREF:SET"), 4, ConditionalHasPreference, CTX_NONE);
959 RegisterConditional(HKEY("COND:ROOM:SET"), 4, ConditionalHasRoomPreference, CTX_NONE);
961 RegisterIterator("PREF:VALID:EMAIL:ADDR", 0, NULL,
962 GetGVEAHash, NULL, DeleteGVEAHash, CTX_STRBUF, CTX_NONE, IT_NOFLAG);
963 RegisterIterator("PREF:VALID:EMAIL:NAME", 0, NULL,
964 GetGVSNHash, NULL, DeleteGVSNHash, CTX_STRBUF, CTX_NONE, IT_NOFLAG);