move the rest of the places to use AppendImportantMessage() or GetServerStatusMsg()
[citadel.git] / webcit / preferences.c
index aeca0028a1ee73567dd0e473e72d48f909d9a555..28f0b841647af180bc71622ceab1ad3b7fccb111 100644 (file)
@@ -1,18 +1,33 @@
 /*
- * $Id$
- *
  * Manage user preferences with a little help from the Citadel server.
  *
+ * Copyright (c) 1996-2011 by the citadel.org team
+ *
+ * This program is open source software.  You can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  */
 
+
 #include "webcit.h"
 #include "webserver.h"
 #include "groupdav.h"
 
 HashList *PreferenceHooks;
+extern HashList *HandlerHash;
 
 typedef struct _PrefDef {
-       long Type;
+       ePrefType eType;
        StrBuf *Setting;
        const char *PrefStr;
        PrefEvalFunc OnLoad;
@@ -20,9 +35,11 @@ typedef struct _PrefDef {
 } PrefDef;
 
 typedef struct _Preference {
+       PrefDef *Type;
+       ePrefType eFlatPrefType;
+
        StrBuf *Key;
        StrBuf *Val;
-       PrefDef *Type;
 
        long lval;
        long decoded;
@@ -48,14 +65,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 +123,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 [%d] [\"%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 +153,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 +171,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 +200,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;
@@ -219,7 +239,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;
@@ -232,7 +252,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"))) {
                        }
@@ -350,8 +370,21 @@ void save_preferences(void)
 
                return; /* oh well. */
        }
-//void do_change_view(int newview) {
 
+       /* 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);
@@ -360,7 +393,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;
@@ -430,6 +463,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
  *
@@ -447,6 +537,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));
@@ -461,11 +552,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] %d != %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;
@@ -497,6 +590,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:
@@ -527,6 +621,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;
@@ -708,7 +809,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),
@@ -758,9 +860,7 @@ void GetPreferences(HashList *Setting)
 void set_preferences(void)
 {      
        if (!havebstr("change_button")) {
-               safestrncpy(WC->ImportantMessage, 
-                           _("Cancelled.  No settings were changed."),
-                           sizeof WC->ImportantMessage);
+               AppendImportantMessage(_("Cancelled.  No settings were changed."), -1);
                display_main_menu();
                return;
        }
@@ -777,8 +877,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;
@@ -854,11 +955,20 @@ int ConditionalPreference(StrBuf *Target, WCTemplputParams *TP)
        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)
@@ -954,15 +1064,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)
 {
-       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>");
+       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>");
+       };
 }
 
 
@@ -971,29 +1083,52 @@ 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)
+                       AppendImportantMessage(_("This isn't allowed to become the start page."), -1);
+               else
+                       AppendImportantMessage(_("You no longer have a start page selected."), -1);
                display_main_menu();
                return;
        }
 
+
+
        set_preference_backend(HKEY("startpage"), 
                               0, 
-                              NewStrBufDup(sbstr("startpage")),
+                              NewStrBufDup(pStartPage),
                               PRF_STRING,
                               1, 
                               NULL);
 
        output_headers(1, 1, 0, 0, 0, 0);
-       do_template("newstartpage", NULL);
+       do_template("newstartpage");
        wDumpContent(1);
 }
 
@@ -1001,6 +1136,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... */
@@ -1010,6 +1146,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;
+       }
 }