* Doxygen groups. Sorted the files into groups. so now we have a nice structure
[citadel.git] / webcit / gettext.c
index 4d44e533a083d3b5148d88f6ddabbe1f4ba12d18..453633cd1b327904e697e7d4b00edcec3ab2d33c 100644 (file)
+/*
+ * $Id
+ */
+/**
+ * \defgroup LocaleHeaderParser Parse the browser http locale headers and set the NLS stuff.
+ * \ingroup WebcitHttpServer 
+ */
+/*@{*/
+/** we need _GNU_SOURCE for various functions arround the NLS-Stuff */
 #define _GNU_SOURCE
 #include "webcit.h"
 #include "webserver.h"
 
 #ifdef ENABLE_NLS
 
-#define NUM_LANGS 3
-static const char *AvailLang[NUM_LANGS] = {
+#define NUM_LANGS 5 /**< how many different locales do we know? */
+#define SEARCH_LANG 20 /**< how many langs should we parse? */
+
+/** actual supported locales */
+char *AvailLang[NUM_LANGS] = {
+       "C",
        "en_US",
        "de_DE",
-       "it_IT"
+       "it_IT",
+       "en_GB"
 };
 
-locale_t wc_locales[NUM_LANGS];
+locale_t wc_locales[NUM_LANGS]; /**< here we keep the parsed stuff */
 
+/** Keep information about one locale */
 typedef struct _lang_pref{
-       char lang[16];
-       char region[16];
-       char *match;
-       double Priority;
+       char lang[16];          /**< the language locale string */
+       char region[16];        /**< the region locale string */
+       long priority;          /**< which priority does it have */
+       int availability;       /**< do we know it? */
+       int selectedlang;       /**< is this the selected language? */
 } LangStruct;
 
-/* TODO: we skip the language weightening so far. */
-/* Accept-Language: 'de-de,en-us;q=0.7,en;q=0.3' */
-/* Accept-Language: de,en-ph;q=0.8,en-us;q=0.5,de-at;q=0.3 */
-void httplang_to_locale(const char *LocaleString)
+/* \brief parse browser locale header 
+ * seems as most browsers just do a one after coma value even if more than 10 locales are available. Sample strings:
+ * opera: 
+ * Accept-Language: sq;q=1.0,de;q=0.9,as;q=0.8,ar;q=0.7,bn;q=0.6,zh-cn;q=0.5,kn;q=0.4,ch;q=0.3,fo;q=0.2,gn;q=0.1,ce;q=0.1,ie;q=0.1 
+ * Firefox 
+ * Accept-Language: 'de-de,en-us;q=0.7,en;q=0.3' 
+ * Accept-Language: de,en-ph;q=0.8,en-us;q=0.5,de-at;q=0.3 
+ * Accept-Language: de,en-us;q=0.9,it;q=0.9,de-de;q=0.8,en-ph;q=0.7,de-at;q=0.7,zh-cn;q=0.6,cy;q=0.5,ar-om;q=0.5,en-tt;q=0.4,xh;q=0.3,nl-be;q=0.3,cs;q=0.2,sv;q=0.1,tk;q=0.1 
+ * \param LocaleString the string from the browser http headers
+ */
+
+void httplang_to_locale(char *LocaleString)
 {
-       char *locale = "C";
-       LangStruct wanted_locales[20];
+       LangStruct wanted_locales[SEARCH_LANG];
+       LangStruct *ls;
+
        int i = 0;
        int j = 0;
        size_t len = strlen(LocaleString);
-       int nFound = 0;
+       long prio;
+       int av;
+       int nBest;
        int nParts;
-       const int nAvail = 1; /* Number of members in AvailLang */
        char *search = (char *) malloc(len);
-       locale_t my_Locale;
-       locale_t my_Empty_Locale;
-
+       // locale_t my_Locale;
+       // locale_t my_Empty_Locale;
+       
        memcpy(search, LocaleString, len);
        search[len] = '\0';
        nParts=num_tokens(search,',');
-       for (i=0; ((i<nParts)&&(i<10)); i++)
-       {
-               char buf[16];
-               char sbuf[16];
-               int blen;
-
-               extract_token(&buf[0],search, 0,',',16);
-               /* we are searching, if this list item has something like ;q=n*/
-               if (num_tokens(&buf[0],'=')>1) {
-                       extract_token(&sbuf[0],&buf[0], 1,'=',16);
-                       wanted_locales[i].Priority=atof(&sbuf[0]);
-               }
-               else {
-                       wanted_locales[i].Priority=1.0;
-               }
-               /* get the locale part */
-               extract_token(&sbuf[0],&buf[0],0,';',16);
-               /* get the lang part, which should be allways there */
-               extract_token(&wanted_locales[i].lang[0],&sbuf[0],0,'-',16);
-               /* get the area code if any. */
-               if (num_tokens(&sbuf[0],'-')>1) {
-                       extract_token(&wanted_locales[i].region[0],&sbuf[0],1,'-',16);
-               }
-               else { /* no ara code? use lang code */
-                       blen=strlen(&wanted_locales[i].lang[0]);
-                       memcpy(&wanted_locales[i].region[0], wanted_locales[i].lang,blen);
-                       wanted_locales[i].region[blen]='\0';
-               } /* area codes are uppercase */
-               blen=strlen(&wanted_locales[i].region[0]);
-               for (j=0; j<blen; j++)
-                       {
-                               int chars=toupper(wanted_locales[i].region[j]);
-                               wanted_locales[i].region[j]=(char)chars;/*todo ?! */
+       for (i=0; ((i<nParts)&&(i<SEARCH_LANG)); i++)
+        {
+                       char buf[16];
+                       char sbuf[16];
+                       char lbuf[16];
+                       int blen;
+                       
+                       ls=&wanted_locales[i];
+
+                       extract_token(&buf[0],search, i,',',16);
+                       /** we are searching, if this list item has something like ;q=n*/
+                       if (num_tokens(&buf[0],'=')>1) {
+                               int sbuflen, k;
+                               extract_token(&sbuf[0],&buf[0], 1,'=',16);
+                               sbuflen=strlen(&sbuf[0]);
+                               for (k=0; k<sbuflen; k++) if (sbuf[k]=='.') sbuf[k]='0';
+                               ls->priority=atol(&sbuf[0]);
                        }
-       }
-
-       /* todo: weight  */
-       if (nFound > 0) {
-               for (i = 0; i <= nFound; i++) {
-                       for (j = 0; j < nAvail; j++) {
-                               int ret = strncasecmp(&wanted_locales[i].lang[0],
-                                                                         AvailLang[j],
-                                                                         strlen(&wanted_locales[i].lang[0]));
-                               if (!ret) {
-                                       locale = (char *) AvailLang[j]; //wanted_locales[i];
-                                       i = nFound + 1;
-                                       j = nAvail + 1;
-                                       continue;
+                       else {
+                               ls->priority=1000;
+                       }
+                       /** get the locale part */
+                       extract_token(&sbuf[0],&buf[0],0,';',16);
+                       /** get the lang part, which should be allways there */
+                       extract_token(&ls->lang[0],&sbuf[0],0,'-',16);
+                       /** get the area code if any. */
+                       if (num_tokens(&sbuf[0],'-')>1) {
+                               extract_token(&ls->region[0],&sbuf[0],1,'-',16);
+                       }
+                       else { /** no ara code? use lang code */
+                               blen=strlen(&ls->lang[0]);
+                               memcpy(&ls->region[0], ls->lang,blen);
+                               ls->region[blen]='\0';
+                       } /** area codes are uppercase */
+                       blen=strlen(&ls->region[0]);
+                       for (j=0; j<blen; j++)
+                               {
+                                       int chars=toupper(ls->region[j]);
+                                       ls->region[j]=(char)chars;/** \todo ?! */
+                               }
+                       sprintf(&lbuf[0],"%s_%s",&ls->lang[0],&ls->region[0]);
+                       
+                       /** check if we have this lang */
+                       ls->availability=1;
+                       ls->selectedlang=-1;
+                       for (j=0; j<NUM_LANGS; j++) {
+                               int result;
+                               /** match against the LANG part */
+                               result=strcasecmp(&ls->lang[0], AvailLang[j]);
+                               if ((result<0)&&(result<ls->availability)){
+                                       ls->availability=result;
+                                       ls->selectedlang=j;
+                               }
+                               /** match against lang and locale */
+                               if (0==strcasecmp(&lbuf[0], AvailLang[j])){
+                                       ls->availability=0;
+                                       ls->selectedlang=j;
+                                       j=NUM_LANGS;
                                }
-                               
                        }
-               }
-       }
-
-       len = strlen(locale);
-       memcpy(search, locale, len);
-       memcpy(&search[len], ".UTF8", 5);
-       search[len + 5] = '\0';
-       my_Empty_Locale = newlocale(LC_ALL_MASK, NULL, NULL);   /* create default locale */
-       my_Locale = newlocale(LC_MESSAGES_MASK /*|LC_TIME_MASK FIXME */ ,
-                             search, my_Empty_Locale);
-
-       uselocale(my_Locale);
-       //      freelocale(my_Locale);
-       //      freelocale(my_Empty_Locale);
-       free(search);
-}
-
-
-
-/*
-       // the web browser sends '-', we need '_' 
-
-               for (i = 0; i < len; i++)
-               if (search[i] == '-')
-                       search[i] = '_';
-
-       nFound=i;
-       nParts=num_tokens(search,',');
-       if (nParts>0)
-               {
-                       extract_token(prefers,search, 1,';',len);
-                       extract_token(langs,search, 0,';',len);
-               }
-       else
+        }
+       
+       prio=0;
+       av=-1000;
+       nBest=-1;
+       for (i=0; ((i<nParts)&&(i<SEARCH_LANG)); i++)
                {
-                       free(prefers);
-                       prefers=NULL;
-                       memcpy(search, len);
-                       search[len] = '\0';
-               }
-       i = 0;
-       while ( !done && (nFound < 10)) {
-               if ((search[i] == ',') || (search[i] == ';') || (search[i] == '\0'))
-               {
-                       if ((search[i] == ';') || (search[i] == '\0'))
-                               done = 1;
-                       search[i] = '\0';
-                       wanted_locales[nFound] = (char *) &search[j];
-                       j = i + 1;
-                       nFound++;
+                       ls=&wanted_locales[i];
+                       if ((ls->availability<=0)&& 
+                               (av<ls->availability)&&
+                               (prio<ls->priority)&&
+                               (ls->selectedlang!=-1)){
+                               nBest=ls->selectedlang;
+                               av=ls->availability;
+                               prio=ls->priority;
+                       }
                }
+       if (nBest==-1) /** fall back to C */
+               nBest=0;
+       WC->selected_language=nBest;
+       lprintf(9, "language found: %s\n", AvailLang[WC->selected_language]);
+       //      set_selected_language(selected_locale);
+}
 
-               i++;
-       }
-*/
-
-
-
+/* TODO: we skip the language weightening so far. */
+/* Accept-Language: 'de-de,en-us;q=0.7,en;q=0.3' */
+/* Accept-Language: de,en-ph;q=0.8,en-us;q=0.5,de-at;q=0.3 */
+//void httplang_to_locale(char *LocaleString)
+//{
+//     char selected_locale[16];
+//     int i, j;
+//     char lang[64];
+//     int num_accept = 0;
+//
+//     lprintf(9, "languageAccept: %s\n", LocaleString);
+//
+//     strcpy(selected_locale, "C");
+//     num_accept = num_tokens(LocaleString, ',');
+//
+//     for (i=num_accept-1; i>=0; --i) {
+//             extract_token(lang, LocaleString, i, ',', sizeof lang);
+//
+//             /* Strip out the weights; we don't use them.  Also convert
+//              * hyphens to underscores.
+//              */
+//             for (j=0; j<strlen(lang); ++j) {
+//                     if (lang[j] == '-') lang[j] = '_';
+//                     if (lang[j] == ';') lang[j] = 0;
+//             }
+//
+//             for (j=0; j<NUM_LANGS; ++j) {
+//                     if (!strncasecmp(lang, AvailLang[j], strlen(lang))) {
+//                             strcpy(selected_locale, AvailLang[j]);
+//                     }
+//             }
+//     }
+//
+//     lprintf(9, "language found: %s\n", selected_locale);
+//     set_selected_language(selected_locale);
+//}
+
+
+/**
+ * \brief show the language chooser on the login dialog
+ * depending on the browser locale change the sequence of the 
+ * language chooser.
+ */
 void offer_languages(void) {
        int i;
 
        wprintf("<select name=\"language\" size=\"1\">\n");
 
        for (i=0; i < NUM_LANGS; ++i) {
-               wprintf("<option value=%s>%s</option>\n", AvailLang[i], AvailLang[i]);
+               wprintf("<option %s value=%s>%s</option>\n",
+                       ((WC->selected_language == i) ? "selected" : ""),
+                       AvailLang[i],
+                       AvailLang[i]
+               );
        }
 
        wprintf("</select>\n");
 }
 
-/*
- * Set the selected language for this session.
+/**
+ * \brief Set the selected language for this session.
+ * \param lang the locale to set.
  */
 void set_selected_language(char *lang) {
        int i;
@@ -174,17 +223,26 @@ void set_selected_language(char *lang) {
        }
 }
 
-/*
- * Activate the selected language for this session.
+/**
+ * \brief Activate the selected language for this session.
  */
 void go_selected_language(void) {
-       lprintf(9, "uselocale(%d)\n", WC->selected_language);
-       uselocale(wc_locales[WC->selected_language]);
+       if (WC->selected_language < 0) return;
+       uselocale(wc_locales[WC->selected_language]);   /** switch locales */
+       textdomain(textdomain(NULL));                   /** clear the cache */
+}
+
+/**
+ * \brief Deactivate the selected language for this session.
+ */
+void stop_selected_language(void) {
+       uselocale(LC_GLOBAL_LOCALE);                    /** switch locales */
+       textdomain(textdomain(NULL));                   /** clear the cache */
 }
 
 
-/*
- * Create a locale_t for each available language
+/**
+ * \brief Create a locale_t for each available language
  */
 void initialize_locales(void) {
        int i;
@@ -205,15 +263,24 @@ void initialize_locales(void) {
 
 
 #else  /* ENABLE_NLS */
-
+/** \brief dummy for non NLS enabled systems */
 void offer_languages(void) {
        wprintf("English (US)");
 }
 
+/** \brief dummy for non NLS enabled systems */
 void set_selected_language(char *lang) {
 }
 
+/** \brief dummy for non NLS enabled systems */
 void go_selected_language(void) {
 }
 
+/** \brief dummy for non NLS enabled systems */
+void stop_selected_language(void) {
+}
+
 #endif /* ENABLE_NLS */
+
+
+/*@}*/