if StrBuf_ServGetln() is called in a loop, its return value has to be checked for...
[citadel.git] / webcit / preferences.c
index 0fdb07d41ee5eade9503ca503861136df23c1942..02b9102b5872c9b4a8ef7baa21b016f4fbc57150 100644 (file)
@@ -1,8 +1,5 @@
 /*
- * $Id$
- *
  * Manage user preferences with a little help from the Citadel server.
- *
  */
 
 #include "webcit.h"
@@ -10,9 +7,10 @@
 #include "groupdav.h"
 
 HashList *PreferenceHooks;
+extern HashList *HandlerHash;
 
 typedef struct _PrefDef {
-       long Type;
+       ePrefType eType;
        StrBuf *Setting;
        const char *PrefStr;
        PrefEvalFunc OnLoad;
@@ -20,9 +18,11 @@ typedef struct _PrefDef {
 } PrefDef;
 
 typedef struct _Preference {
+       PrefDef *Type;
+       ePrefType eFlatPrefType;
+
        StrBuf *Key;
        StrBuf *Val;
-       PrefDef *Type;
 
        long lval;
        long decoded;
@@ -48,14 +48,14 @@ void DestroyPreference(void *vPref)
 }
 void _RegisterPreference(const char *Setting, long SettingLen, 
                         const char *PrefStr, 
-                        long Type, 
+                        ePrefType Type, 
                         PrefEvalFunc OnLoad, 
                         const char *OnLoadName)
 {
        PrefDef *Newpref = (PrefDef*) malloc(sizeof(PrefDef));
        Newpref->Setting = NewStrBufPlain(Setting, SettingLen);
        Newpref->PrefStr = PrefStr;
-       Newpref->Type = Type;
+       Newpref->eType = Type;
        Newpref->OnLoad = OnLoad;
        if (Newpref->OnLoad != NULL) {
                Newpref->OnLoadName = NewStrBufPlain(OnLoadName, -1);
@@ -106,15 +106,17 @@ void GetPrefTypes(HashList *List)
                {
                        PrefType = (PrefDef*) vPrefDef;
                        Pref->Type = PrefType;
+                       Pref->eFlatPrefType = Pref->Type->eType;
 
-                       lprintf(1, "Loading [%s]with type [%ld] [\"%s\"]\n",
+                       syslog(1, "Loading [%s]with type [%ld] [\"%s\"]\n",
                                ChrPtr(Pref->Key),
-                               Pref->Type->Type,
+                               Pref->Type->eType,
                                ChrPtr(Pref->Val));
 
-                       switch (Pref->Type->Type)
+                       switch (Pref->Type->eType)
                        {
-
+                       case PRF_UNSET: /* WHUT? */
+                               break;
                        case PRF_STRING:
                                break;
                        case PRF_INT:
@@ -134,7 +136,7 @@ void GetPrefTypes(HashList *List)
 
                        if (PrefType->OnLoad != NULL){
 
-                               lprintf(1, "Loading with: -> %s(\"%s\", %ld)\n",
+                               syslog(1, "Loading with: -> %s(\"%s\", %ld)\n",
                                        ChrPtr(PrefType->OnLoadName),
                                        ChrPtr(Pref->Val),
                                        Pref->lval);
@@ -152,7 +154,8 @@ void ParsePref(HashList **List, StrBuf *ReadBuf)
        Preference *LastData = NULL;
                                
        while (!Done) {
-               StrBuf_ServGetln(ReadBuf);
+               if (StrBuf_ServGetln(ReadBuf) < 0)
+                       break;
                if ( (StrLength(ReadBuf)==3) && 
                     !strcmp(ChrPtr(ReadBuf), "000")) {
                        Done = 1;
@@ -180,7 +183,7 @@ void ParsePref(HashList **List, StrBuf *ReadBuf)
                        else 
                        {
                                StrBufTrim(ReadBuf);
-                               lprintf(1, "ignoring spurious preference line: [%s]\n", 
+                               syslog(1, "ignoring spurious preference line: [%s]\n", 
                                        ChrPtr(ReadBuf));
                                DestroyPreference(Data);
                                LastData = NULL;
@@ -197,14 +200,18 @@ void ParsePref(HashList **List, StrBuf *ReadBuf)
  */
 void load_preferences(void) 
 {
+       folder Room;
        wcsession *WCC = WC;
        int Done = 0;
        StrBuf *ReadBuf;
        long msgnum = 0L;
        
+       memset(&Room, 0, sizeof(folder));
        ReadBuf = NewStrBufPlain(NULL, SIZ * 4);
-       if (goto_config_room(ReadBuf) != 0) {
+       if (goto_config_room(ReadBuf, &Room) != 0) {
                FreeStrBuf(&ReadBuf);
+               FlushFolder(&Room);
+
                return; /* oh well. */
        }
 
@@ -215,7 +222,7 @@ void load_preferences(void)
                serv_puts("000");
        }
        while (!Done &&
-              StrBuf_ServGetln(ReadBuf)) {
+              (StrBuf_ServGetln(ReadBuf) >= 0)) {
                if ( (StrLength(ReadBuf)==3) && 
                     !strcmp(ChrPtr(ReadBuf), "000")) {
                        Done = 1;
@@ -228,7 +235,7 @@ void load_preferences(void)
                serv_printf("MSG0 %ld", msgnum);
                StrBuf_ServGetln(ReadBuf);
                if (GetServerStatus(ReadBuf, NULL) == 1) {
-                       while (StrBuf_ServGetln(ReadBuf),
+                       while ((StrBuf_ServGetln(ReadBuf) >= 0) && 
                               (strcmp(ChrPtr(ReadBuf), "text") && 
                                strcmp(ChrPtr(ReadBuf), "000"))) {
                        }
@@ -239,19 +246,20 @@ void load_preferences(void)
        }
 
        /* Go back to the room we're supposed to be in */
-       if (StrLength(WCC->wc_roomname) > 0) {
-               serv_printf("GOTO %s", ChrPtr(WCC->wc_roomname));
+       if (StrLength(WCC->CurRoom.name) > 0) {
+               serv_printf("GOTO %s", ChrPtr(WCC->CurRoom.name));
                StrBuf_ServGetln(ReadBuf);
                GetServerStatus(ReadBuf, NULL);
        }
        FreeStrBuf(&ReadBuf);
+       FlushFolder(&Room);
 }
 
 /*
  * Goto the user's configuration room, creating it if necessary.
  * returns 0 on success or nonzero upon failure.
  */
-int goto_config_room(StrBuf *Buf) 
+int goto_config_room(StrBuf *Buf, folder *Room
 {
        serv_printf("GOTO %s", USERCONFIGROOM);
        StrBuf_ServGetln(Buf);
@@ -266,6 +274,7 @@ int goto_config_room(StrBuf *Buf)
                        return(1);
                }
        }
+       ParseGoto(Room, Buf);
        return(0);
 }
 
@@ -330,16 +339,36 @@ void WritePrefsToServer(HashList *Hash)
  */
 void save_preferences(void) 
 {
+       folder Room;
        wcsession *WCC = WC;
        int Done = 0;
        StrBuf *ReadBuf;
        long msgnum = 0L;
        
        ReadBuf = NewStrBuf();
-       if (goto_config_room(ReadBuf) != 0) {
+       memset(&Room, 0, sizeof(folder));
+       if (goto_config_room(ReadBuf, &Room) != 0) {
                FreeStrBuf(&ReadBuf);
+               FlushFolder(&Room);
+
                return; /* oh well. */
        }
+
+       /* make shure the config room has the right type, else it might reject our config */
+       if (Room.view != VIEW_BBS) {
+               serv_printf("VIEW %d", VIEW_BBS);
+               StrBuf_ServGetln(ReadBuf);
+               if (GetServerStatus(ReadBuf, NULL) != 2) {
+                       /* UPS? */
+               }
+               else if (goto_config_room(ReadBuf, &Room) != 0) {
+                       FreeStrBuf(&ReadBuf);
+                       FlushFolder(&Room);
+                       
+                       return; /* oh well. */
+               }
+       }
+
        serv_puts("MSGS ALL|0|1");
        StrBuf_ServGetln(ReadBuf);
        if (GetServerStatus(ReadBuf, NULL) == 8) {
@@ -347,7 +376,7 @@ void save_preferences(void)
                serv_puts("000");
        }
        while (!Done &&
-              StrBuf_ServGetln(ReadBuf)) {
+              (StrBuf_ServGetln(ReadBuf) >= 0)) {
                if ( (StrLength(ReadBuf)==3) && 
                     !strcmp(ChrPtr(ReadBuf), "000")) {
                        Done = 1;
@@ -372,12 +401,13 @@ void save_preferences(void)
        }
 
        /** Go back to the room we're supposed to be in */
-       if (StrLength(WCC->wc_roomname) > 0) {
-               serv_printf("GOTO %s", ChrPtr(WCC->wc_roomname));
+       if (StrLength(WCC->CurRoom.name) > 0) {
+               serv_printf("GOTO %s", ChrPtr(WCC->CurRoom.name));
                StrBuf_ServGetln(ReadBuf);
                GetServerStatus(ReadBuf, NULL);
        }
        FreeStrBuf(&ReadBuf);
+       FlushFolder(&Room);
 }
 
 /**
@@ -416,6 +446,63 @@ int get_PREFERENCE(const char *key, size_t keylen, StrBuf **value)
        return Ret;
 }
 
+/**
+ * \brief      Write a key into the webcit preferences database for this user
+ *
+ * \params     key             key whichs value is to be modified
+ * \param keylen length of the key string
+ * \param      value           value to set
+ * \param      save_to_server  1 = flush all data to the server, 0 = cache it for now
+ */
+long compare_preference(const Preference *PrefA, 
+                       const Preference *PrefB)
+{
+       ePrefType TypeA, TypeB;
+
+       if (PrefA->Type != NULL)
+               TypeA = PrefA->Type->eType;
+       else 
+               TypeA = PrefA->eFlatPrefType;
+
+       if (PrefB->Type != NULL)
+               TypeB = PrefB->Type->eType;
+       else 
+               TypeB = PrefB->eFlatPrefType;
+
+       if ((TypeA != PRF_UNSET) && 
+           (TypeB != PRF_UNSET) && 
+           (TypeA != TypeB))
+       {
+               if (TypeA > TypeB)
+                       return 1;
+               else /* (PrefA->Type < PrefB->Type) */
+                       return -1;
+       }
+
+       if (TypeB == PRF_UNSET)
+               TypeA = PRF_UNSET;
+                   
+       switch (TypeA)
+       {
+       default:
+       case PRF_UNSET:
+       case PRF_STRING:
+               return strcmp(ChrPtr(PrefA->Val), 
+                             ChrPtr(PrefB->Val));
+       case PRF_YESNO:
+       case PRF_INT:
+               if (PrefA->lval == PrefB->lval)
+                       return 0;
+               else if (PrefA->lval > PrefB->lval)
+                       return 1;
+               else
+                       return -1;
+       case PRF_QP_STRING:
+               return strcmp(ChrPtr(PrefA->DeQPed), 
+                             ChrPtr(PrefB->DeQPed));
+       }
+}
+
 /**
  * \brief      Write a key into the webcit preferences database for this user
  *
@@ -433,6 +520,7 @@ void set_preference_backend(const char *key, size_t keylen,
 {
        wcsession *WCC = WC;
        void *vPrefDef;
+       void *vPrefB;
        Preference *Pref;
 
        Pref = (Preference*) malloc(sizeof(Preference));
@@ -447,11 +535,13 @@ void set_preference_backend(const char *key, size_t keylen,
        if (PrefType != NULL)
        {
                Pref->Type = PrefType;
-               if (Pref->Type->Type != lPrefType)
-                       lprintf(1, "warning: saving preference with wrong type [%s] %ld != %ld \n",
-                               key, Pref->Type->Type, lPrefType);
-               switch (Pref->Type->Type)
+               Pref->eFlatPrefType = PrefType->eType;
+               if (Pref->Type->eType != lPrefType)
+                       syslog(1, "warning: saving preference with wrong type [%s] %ld != %ld \n",
+                               key, Pref->Type->eType, lPrefType);
+               switch (Pref->Type->eType)
                {
+               case PRF_UNSET: /* default to string... */
                case PRF_STRING:
                        Pref->Val = value;
                        Pref->decoded = 1;
@@ -483,6 +573,7 @@ void set_preference_backend(const char *key, size_t keylen,
                        Pref->Type->OnLoad(Pref->Val, Pref->lval);
        }
        else {
+               Pref->eFlatPrefType = lPrefType;
                switch (lPrefType)
                {
                case PRF_STRING:
@@ -513,6 +604,13 @@ void set_preference_backend(const char *key, size_t keylen,
                        break;
                }
        }
+
+       if ((save_to_server != 0) && 
+           GetHash(WCC->hash_prefs, key, keylen, &vPrefB) && 
+           (vPrefB != NULL) && 
+           (compare_preference (Pref, vPrefB) == 0))
+               save_to_server = 0;
+
        Put(WCC->hash_prefs, key, keylen, Pref, DestroyPreference);
        
        if (save_to_server) WCC->SavePrefsToServer = 1;
@@ -581,7 +679,7 @@ int get_room_prefs_backend(const char *key, size_t keylen,
        int Ret;
 
        pref_name = NewStrBufPlain (HKEY("ROOM:"));
-       StrBufAppendBuf(pref_name, WC->wc_roomname, 0);
+       StrBufAppendBuf(pref_name, WC->CurRoom.name, 0);
        StrBufAppendBufPlain(pref_name, HKEY(":"), 0);
        StrBufAppendBufPlain(pref_name, key, keylen, 0);
        Ret = get_pref_backend(SKEY(pref_name), Pref);
@@ -624,6 +722,28 @@ void set_X_PREFS(const char *key, size_t keylen, const char *xkey, size_t xkeyle
 }
 
 
+long get_ROOM_PREFS_LONG(const char *key, size_t keylen, long *value, long Default)
+{
+       Preference *Pref;
+       int Ret;
+
+       Ret = get_room_prefs_backend(key, keylen, &Pref);
+
+       if (Ret == 0) {
+               *value = Default;
+               return 0;
+       }
+
+       if (Pref->decoded)
+               *value = Pref->lval;
+       else {
+               *value = Pref->lval = atol(ChrPtr(Pref->Val));
+               Pref->decoded = 1;
+       }
+       return Ret;
+}
+
+
 StrBuf *get_ROOM_PREFS(const char *key, size_t keylen)
 {
        Preference *Pref;
@@ -643,7 +763,7 @@ void set_ROOM_PREFS(const char *key, size_t keylen, StrBuf *value, int save_to_s
        StrBuf *pref_name;
        
        pref_name = NewStrBufPlain (HKEY("ROOM:"));
-       StrBufAppendBuf(pref_name, WC->wc_roomname, 0);
+       StrBufAppendBuf(pref_name, WC->CurRoom.name, 0);
        StrBufAppendBufPlain(pref_name, HKEY(":"), 0);
        StrBufAppendBufPlain(pref_name, key, keylen, 0);
        set_preference_backend(SKEY(pref_name), 0, value, PRF_STRING, save_to_server, NULL);
@@ -672,7 +792,8 @@ void GetPreferences(HashList *Setting)
 
                if (!HaveBstr(SKEY(PrefType->Setting)))
                        continue;
-               switch (PrefType->Type) {
+               switch (PrefType->eType) {
+               case PRF_UNSET:
                case PRF_STRING:
                        Buf = NewStrBufDup(SBstr(SKEY(PrefType->Setting)));
                        set_preference_backend(SKEY(PrefType->Setting),
@@ -741,8 +862,9 @@ void tmplput_CFG_Value(StrBuf *Target, WCTemplputParams *TP)
                if (Pref->Type == NULL) {
                        StrBufAppendTemplate(Target, TP, Pref->Val, 1);
                }
-               switch (Pref->Type->Type)
+               switch (Pref->Type->eType)
                {
+               case PRF_UNSET: /* default to string... */
                case PRF_STRING:
                        StrBufAppendTemplate(Target, TP, Pref->Val, 1);
                        break;
@@ -783,6 +905,16 @@ void tmplput_CFG_Descr(StrBuf *Target, WCTemplputParams *TP)
        if (SettingStr != NULL) 
                StrBufAppendBufPlain(Target, SettingStr, -1, 0);
 }
+void tmplput_CFG_RoomValueLong(StrBuf *Target, WCTemplputParams *TP)
+{
+       long lvalue;
+       long defval = 0;
+
+       if (HAVE_PARAM(1))
+               defval = GetTemplateTokenNumber(Target, TP, 1, 0);
+       get_ROOM_PREFS_LONG(TKEY(0), &lvalue, defval);
+       StrBufAppendPrintf(Target, "%ld", lvalue);
+}
 void tmplput_CFG_RoomValue(StrBuf *Target, WCTemplputParams *TP)
 {
        StrBuf *pref = get_ROOM_PREFS(TKEY(0));
@@ -805,14 +937,23 @@ int ConditionalPreference(StrBuf *Target, WCTemplputParams *TP)
        if (!get_PREFERENCE(TKEY(2), &Pref)) 
                return 0;
        
-       if (TP->Tokens->nParameters == 3) {
+       if (!HAVE_PARAM(3)) {
                return 1;
        }
-       else if (TP->Tokens->Params[3]->Type == TYPE_STR)
-               return ((TP->Tokens->Params[3]->len == StrLength(Pref)) &&
-                       (strcmp(TP->Tokens->Params[3]->Start, ChrPtr(Pref)) == 0));
+       else if (IS_NUMBER(TP->Tokens->Params[3]->Type))
+       {
+               return StrTol(Pref) == GetTemplateTokenNumber (Target, TP, 3, 0);
+       }
        else 
-               return (StrTol(Pref) == TP->Tokens->Params[3]->lvalue);
+       {
+               const char *pch;
+               long len;
+               
+               GetTemplateTokenString(Target, TP, 3, &pch, &len);
+               
+               return ((len == StrLength(Pref)) &&
+                       (strcmp(pch, ChrPtr(Pref)) == 0));
+       }
 }
 
 int ConditionalHasPreference(StrBuf *Target, WCTemplputParams *TP)
@@ -908,22 +1049,17 @@ void DeleteGVSNHash(HashList **KillMe)
 
 
 /*
- * Offer to make any page the user's "start page."
+ * Offer to make any page the user's "start page" (only if logged in)
  */
 void offer_start_page(StrBuf *Target, WCTemplputParams *TP)
 {
-       wprintf("<a href=\"change_start_page?startpage=");
-       urlescputs(ChrPtr(WC->Hdr->this_page));
-       wprintf("\">");
-       wprintf(_("Make this my start page"));
-       wprintf("</a>");
-#ifdef TECH_PREVIEW
-       wprintf("<br/><a href=\"rss?room=");
-       urlescputs(ChrPtr(WC->wc_roomname));
-       wprintf("\" title=\"RSS 2.0 feed for ");
-       escputs(ChrPtr(WC->wc_roomname));
-       wprintf("\"><img alt=\"RSS\" border=\"0\" src=\"static/xml_button.gif\" width=\"36\" height=\"14\" /></a>\n");
-#endif
+       if (WC->logged_in) {
+               wc_printf("<a href=\"change_start_page?startpage=");
+               urlescputs(ChrPtr(WC->Hdr->this_page));
+               wc_printf("\">");
+               wc_printf(_("Make this my start page"));
+               wc_printf("</a>");
+       };
 }
 
 
@@ -932,23 +1068,50 @@ void offer_start_page(StrBuf *Target, WCTemplputParams *TP)
  */
 void change_start_page(void) 
 {
-       if (!havebstr("startpage")) {
+       wcsession *WCC = WC;
+       const char *pch;
+       void *vHandler;
+       int ProhibitSave = 0;
+       const StrBuf *pStartPage = sbstr("startpage");
+
+       if (pStartPage != NULL) {
+               pch = strchr(ChrPtr(pStartPage), '?');
+
+               if ((pch != NULL) && (
+                           GetHash(HandlerHash, ChrPtr(pStartPage), pch - ChrPtr(pStartPage), &vHandler), 
+                           (vHandler != NULL) &&
+                           ((((WebcitHandler*)vHandler)->Flags & PROHIBIT_STARTPAGE) != 0)))
+               { /* OK, This handler doesn't want to be set as start page, prune it. */
+                       ProhibitSave = 1;
+               }
+       }
+
+       if ((pStartPage == NULL) || 
+           (ProhibitSave == 1))
+       {
                set_preference_backend(HKEY("startpage"), 
                                       0, 
                                       NewStrBufPlain(HKEY("")),
                                       PRF_STRING,
                                       1, 
                                       NULL);
-               safestrncpy(WC->ImportantMessage,
-                           _("You no longer have a start page selected."),
-                           sizeof( WC->ImportantMessage));
+               if (ProhibitSave == 1)
+                       StrBufAppendBufPlain(WCC->ImportantMsg,
+                                            _("This isn't allowed to become the start page."),
+                                            -1, 0);
+               else
+                       StrBufAppendBufPlain(WCC->ImportantMsg,
+                                            _("You no longer have a start page selected."),
+                                            -1, 0);
                display_main_menu();
                return;
        }
 
+
+
        set_preference_backend(HKEY("startpage"), 
                               0, 
-                              NewStrBufDup(sbstr("startpage")),
+                              NewStrBufDup(pStartPage),
                               PRF_STRING,
                               1, 
                               NULL);
@@ -962,6 +1125,7 @@ void change_start_page(void)
 void LoadStartpage(StrBuf *URL, long lvalue)
 {
        const char *pch;
+       void *vHandler;
        pch = strchr(ChrPtr(URL), '?');
        if (pch == NULL) {
                /* purge the sins of the past... */
@@ -971,6 +1135,13 @@ void LoadStartpage(StrBuf *URL, long lvalue)
                        WC->SavePrefsToServer = 1;
                }
        }
+       else if (GetHash(HandlerHash, ChrPtr(URL), pch - ChrPtr(URL), &vHandler), 
+                (vHandler != NULL) &&
+                ((((WebcitHandler*)vHandler)->Flags & PROHIBIT_STARTPAGE) != 0))
+       { /* OK, This handler doesn't want to be set as start page, prune it. */
+               FlushStrBuf(URL);
+               WC->SavePrefsToServer = 1;
+       }
 }
 
 
@@ -978,15 +1149,17 @@ void
 InitModule_PREFERENCES
 (void)
 {
-       WebcitAddUrlHandler(HKEY("set_preferences"), set_preferences, 0);
-       WebcitAddUrlHandler(HKEY("change_start_page"), change_start_page, 0);
+       WebcitAddUrlHandler(HKEY("set_preferences"), "", 0, set_preferences, 0);
+       WebcitAddUrlHandler(HKEY("change_start_page"), "", 0, change_start_page, 0);
 
        RegisterPreference("startpage", _("Prefered startpage"), PRF_STRING, LoadStartpage);
 
-       RegisterNamespace("OFFERSTARTPAGE", 0, 0, offer_start_page, CTX_NONE);
-       RegisterNamespace("PREF:ROOM:VALUE", 1, 2, tmplput_CFG_RoomValue,  CTX_NONE);
-       RegisterNamespace("PREF:VALUE", 1, 2, tmplput_CFG_Value, CTX_NONE);
-       RegisterNamespace("PREF:DESCR", 1, 1, tmplput_CFG_Descr, CTX_NONE);
+       RegisterNamespace("OFFERSTARTPAGE", 0, 0, offer_start_page, NULL, CTX_NONE);
+       RegisterNamespace("PREF:ROOM:VALUE", 1, 2, tmplput_CFG_RoomValue,  NULL, CTX_NONE);
+       RegisterNamespace("PREF:ROOM:VALUE:INT", 1, 2, tmplput_CFG_RoomValueLong,  NULL, CTX_NONE);
+       RegisterNamespace("PREF:VALUE", 1, 2, tmplput_CFG_Value, NULL, CTX_NONE);
+       
+       RegisterNamespace("PREF:DESCR", 1, 1, tmplput_CFG_Descr, NULL, CTX_NONE);
 
        RegisterConditional(HKEY("COND:PREF"), 4, ConditionalPreference, CTX_NONE);
        RegisterConditional(HKEY("COND:PREF:SET"), 4, ConditionalHasPreference, CTX_NONE);