webcit/gettext.c

   1 /*
   2  * Copyright (c) 1996-2011 by the citadel.org team
   3  *
   4  * This program is open source software.  You can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License as
   6  * published by the Free Software Foundation; either version 3 of the
   7  * License, or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  17  */
  18
  19 #include "webcit.h"
  20 #include "webserver.h"
  21 #define SEARCH_LANG 20          /* how many langs should we parse? */
  22
  23 #ifdef ENABLE_NLS
  24 /* actual supported locales */
  25 const char *AvailLang[] = {
  26         "C",
  27         "bg_BG",
  28         "cs_CZ",
  29         "en_US",
  30         "da_DK",
  31         "de_DE",
  32         "el_GR",
  33         "en_GB",
  34         "es_ES",
  35         "et_EE",
  36         "fi_FI",
  37         "fr_FR",
  38         "hu_HU",
  39         "it_IT",
  40         "nl_NL",
  41         "pt_BR",
  42         "ru_RU",
  43         "zh_CN",
  44         "he_IL",
  45         "kk_KK",
  46         "ro_RO",
  47         "sl_SL",
  48         "tr_TR",
  49         ""
  50 };
  51
  52 const char **AvailLangLoaded;
  53 long nLocalesLoaded = 0;
  54
  55 #ifdef HAVE_USELOCALE
  56 locale_t *wc_locales; /**< here we keep the parsed stuff */
  57 #endif
  58
  59 /* Keep information about one locale */
  60 typedef struct _lang_pref{
  61         char lang[16];          /**< the language locale string */
  62         char region[16];        /**< the region locale string */
  63         long priority;          /**< which priority does it have */
  64         int availability;       /**< do we know it? */
  65         int selectedlang;       /**< is this the selected language? */
  66 } LangStruct;
  67
  68 /* parse browser locale header
  69  *
  70  * seems as most browsers just do a one after comma value even if more than 10 locales are available. Sample strings:
  71  * opera:
  72  * 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
  73  * Firefox
  74  * Accept-Language: 'de-de,en-us;q=0.7,en;q=0.3'
  75  * Accept-Language: de,en-ph;q=0.8,en-us;q=0.5,de-at;q=0.3
  76  * 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
  77  */
  78
  79 void httplang_to_locale(StrBuf *LocaleString, wcsession *sess)
  80 {
  81         LangStruct wanted_locales[SEARCH_LANG];
  82         LangStruct *ls;
  83
  84         int i = 0;
  85         int j = 0;
  86         /* size_t len = strlen(LocaleString); */
  87         long prio;
  88         int av;
  89         int nBest;
  90         int nParts;
  91         StrBuf *Buf = NULL;
  92         StrBuf *SBuf = NULL;
  93
  94         nParts = StrBufNum_tokens(LocaleString, ',');
  95         for (i=0; ((i<nParts) && (i < SEARCH_LANG)); i++)
  96         {
  97                 char lbuf[32];
  98                 int blen;
  99
 100                 if (Buf == NULL) {
 101                         Buf = NewStrBuf();
 102                         SBuf = NewStrBuf();
 103                 }
 104                 else {
 105                         FlushStrBuf(Buf);
 106                         FlushStrBuf(SBuf);
 107                 }
 108
 109                 ls = &wanted_locales[i];
 110
 111                 StrBufExtract_token(Buf, LocaleString, i, ',');
 112                 /** we are searching, if this list item has something like ;q=n*/
 113                 if (StrBufNum_tokens(Buf, '=') > 1) {
 114                         int sbuflen, k;
 115                         StrBufExtract_token(SBuf, Buf, 1, '=');
 116                         sbuflen = StrLength(SBuf);
 117                         for (k = 0; k < sbuflen; k++)
 118                                 if (ChrPtr(SBuf)[k] == '.')
 119                                         StrBufPeek(SBuf, NULL, k, '0');
 120                         ls->priority = StrTol(SBuf);
 121                 }
 122                 else {
 123                         ls->priority = 1000;
 124                 }
 125
 126                 /** get the locale part */
 127                 StrBufExtract_token(SBuf, Buf, 0, ';');
 128
 129                 /** get the lang part, which should be allways there */
 130                 extract_token(&ls->lang[0],
 131                               ChrPtr(SBuf),
 132                               0, '-',
 133                               sizeof(ls->lang));
 134
 135                 /** get the area code if any. */
 136                 if (StrBufNum_tokens(SBuf, '-') > 1) {
 137                         extract_token(&ls->region[0],
 138                                       ChrPtr(SBuf),
 139                                       1, '-',
 140                                       sizeof(ls->region));
 141                 }
 142                 else { /** no ara code? use lang code */
 143                         blen=strlen(&ls->lang[0]);
 144                         memcpy(&ls->region[0], ls->lang, blen);
 145                         ls->region[blen] = '\0';
 146                 }
 147
 148                 /* area codes are uppercase */
 149                 blen = strlen(&ls->region[0]);
 150                 for (j = 0; j < blen; j++)
 151                 {
 152                         int chars;
 153                         chars = toupper(ls->region[j]);
 154                         ls->region[j] = (char)chars;/** \todo ?! */
 155                 }
 156                 snprintf(&lbuf[0],
 157                          sizeof(lbuf),
 158                          "%s_%s",
 159                          &ls->lang[0],
 160                          &ls->region[0]);
 161
 162                 /** check if we have this lang */
 163                 ls->availability = 1;
 164                 ls->selectedlang = -1;
 165                 for (j = 0; j < nLocalesLoaded; j++) {
 166                         int result;
 167                         /** match against the LANG part */
 168                         result = strcasecmp(&ls->lang[0], AvailLangLoaded[j]);
 169                         if ((result < 0) && (result < ls->availability)){
 170                                 ls->availability = result;
 171                                 ls->selectedlang = j;
 172                         }
 173                         /** match against lang and locale */
 174                         if (0 == strcasecmp(&lbuf[0], AvailLangLoaded[j])){
 175                                 ls->availability = 0;
 176                                 ls->selectedlang = j;
 177                                 j = nLocalesLoaded;
 178                         }
 179                 }
 180         }
 181
 182         prio = 0;
 183         av = -1000;
 184         nBest = -1;
 185         for (i = 0; ((i < nParts) && (i<SEARCH_LANG)); i++) {
 186                 ls = &wanted_locales[i];
 187                 if ((ls->availability <= 0) &&
 188                     (av < ls->availability) &&
 189                     (prio < ls->priority) &&
 190                     (ls->selectedlang != -1)) {
 191                         nBest = ls->selectedlang;
 192                         av = ls->availability;
 193                         prio = ls->priority;
 194                 }
 195         }
 196         if (nBest == -1) {
 197                 /** fall back to C */
 198                 nBest=0;
 199         }
 200         sess->selected_language = nBest;
 201         syslog(9, "language found: %s\n", AvailLangLoaded[WC->selected_language]);
 202         FreeStrBuf(&Buf);
 203         FreeStrBuf(&SBuf);
 204 }
 205
 206 /*
 207  * show the language chooser on the login dialog
 208  * depending on the browser locale change the sequence of the
 209  * language chooser.
 210  */
 211 void tmplput_offer_languages(StrBuf *Target, WCTemplputParams *TP)
 212 {
 213         int i;
 214 #ifndef HAVE_USELOCALE
 215         char *Lang = getenv("LANG");
 216
 217         if (Lang == NULL)
 218                 Lang = "C";
 219 #endif
 220
 221
 222         if (nLocalesLoaded == 1) {
 223                 wc_printf("<p>%s</p>", AvailLangLoaded[0]);
 224                 return;
 225         }
 226
 227         wc_printf("<select name=\"language\" id=\"lname\" size=\"1\" onChange=\"switch_to_lang($('lname').value);\">\n");
 228
 229         for (i=0; i < nLocalesLoaded; ++i) {
 230 #ifndef HAVE_USELOCALE
 231                 if (strcmp(AvailLangLoaded[i], Lang) == 0)
 232 #endif
 233                 wc_printf("<option %s value=%s>%s</option>\n",
 234                         ((WC->selected_language == i) ? "selected" : ""),
 235                         AvailLangLoaded[i],
 236                         AvailLangLoaded[i]
 237                 );
 238         }
 239
 240         wc_printf("</select>\n");
 241 }
 242
 243 /*
 244  * Set the selected language for this session.
 245  */
 246 void set_selected_language(const char *lang) {
 247 #ifdef HAVE_USELOCALE
 248         int i;
 249         for (i = 0; i<nLocalesLoaded; ++i) {
 250                 if (!strcasecmp(lang, AvailLangLoaded[i])) {
 251                         WC->selected_language = i;
 252                         break;
 253                 }
 254         }
 255 #endif
 256 }
 257
 258 /*
 259  * Activate the selected language for this session.
 260  */
 261 void go_selected_language(void) {
 262 #ifdef HAVE_USELOCALE
 263         wcsession *WCC = WC;
 264         if (WCC->selected_language < 0) return;
 265         uselocale(wc_locales[WCC->selected_language]);  /** switch locales */
 266         textdomain(textdomain(NULL));                   /** clear the cache */
 267 #else
 268         char *language;
 269
 270         language = getenv("LANG");
 271         setlocale(LC_MESSAGES, language);
 272 #endif
 273 }
 274
 275 /*
 276  * Deactivate the selected language for this session.
 277  */
 278 void stop_selected_language(void) {
 279 #ifdef HAVE_USELOCALE
 280         uselocale(LC_GLOBAL_LOCALE);                    /** switch locales */
 281         textdomain(textdomain(NULL));                   /** clear the cache */
 282 #endif
 283 }
 284
 285 #ifdef HAVE_USELOCALE
 286         locale_t Empty_Locale;
 287 #endif
 288
 289 /*
 290  * Create a locale_t for each available language
 291  */
 292 void initialize_locales(void) {
 293         int nLocales;
 294         int i;
 295         char buf[32];
 296         char *language = NULL;
 297
 298         nLocales = 0;
 299         while (!IsEmptyStr(AvailLang[nLocales]))
 300                 nLocales++;
 301
 302         language = getenv("WEBCIT_LANG");
 303         if ((language) && (!IsEmptyStr(language)) && (strcmp(language, "UNLIMITED") != 0)) {
 304                 syslog(9, "Nailing locale to %s\n", language);
 305         }
 306         else language = NULL;
 307
 308         AvailLangLoaded = malloc (sizeof(char*) * nLocales);
 309         memset(AvailLangLoaded, 0, sizeof(char*) * nLocales);
 310 #ifdef HAVE_USELOCALE
 311         wc_locales = malloc (sizeof(locale_t) * nLocales);
 312         memset(wc_locales,0, sizeof(locale_t) * nLocales);
 313         /* create default locale */
 314         Empty_Locale = newlocale(LC_ALL_MASK, NULL, NULL);
 315 #endif
 316
 317
 318
 319
 320         for (i = 0; i < nLocales; ++i) {
 321                 if ((language != NULL) && (strcmp(AvailLang[i], language) != 0))
 322                         continue;
 323                 if (i == 0) {
 324                         sprintf(buf, "%s", AvailLang[i]);       /* locale 0 (C) is ascii, not utf-8 */
 325                 }
 326                 else {
 327                         sprintf(buf, "%s.UTF8", AvailLang[i]);
 328                 }
 329 #ifdef HAVE_USELOCALE
 330                 wc_locales[nLocalesLoaded] = newlocale(
 331                         (LC_MESSAGES_MASK|LC_TIME_MASK),
 332                         buf,
 333                         (((i > 0) && (wc_locales[0] != NULL)) ? wc_locales[0] : Empty_Locale)
 334                 );
 335                 if (wc_locales[nLocalesLoaded] == NULL) {
 336                         syslog(1, "locale for "LOCALEDIR"locale/%s: %s; disabled\n",
 337                                 buf,
 338                                 strerror(errno)
 339                         );
 340                 }
 341                 else {
 342                         syslog(3, "Found locale: %s\n", buf);
 343                         AvailLangLoaded[nLocalesLoaded] = AvailLang[i];
 344                         nLocalesLoaded++;
 345                 }
 346 #else
 347                 if ((language != NULL) && (strcmp(language, AvailLang[i]) == 0)) {
 348                         setenv("LANG", buf, 1);
 349                         AvailLangLoaded[nLocalesLoaded] = AvailLang[i];
 350                         setlocale(LC_MESSAGES, AvailLang[i]);
 351                         nLocalesLoaded++;
 352                 }
 353                 else if (nLocalesLoaded == 0) {
 354                         setenv("LANG", buf, 1);
 355                         AvailLangLoaded[nLocalesLoaded] = AvailLang[i];
 356                         nLocalesLoaded++;
 357                 }
 358 #endif
 359         }
 360         if ((language != NULL) && (nLocalesLoaded == 0)) {
 361                 syslog(1, "Your selected locale [%s] isn't available on your system. falling back to C\n", language);
 362 #ifdef HAVE_USELOCALE
 363                 wc_locales[0] = newlocale(
 364                         (LC_MESSAGES_MASK|LC_TIME_MASK),
 365                         AvailLang[0],
 366                         Empty_Locale);
 367 #else
 368                 setlocale(LC_MESSAGES, AvailLang[0]);
 369                 setenv("LANG", AvailLang[0], 1);
 370 #endif
 371                 AvailLangLoaded[0] = AvailLang[0];
 372                 nLocalesLoaded = 1;
 373         }
 374
 375 #ifdef ENABLE_NLS
 376         /*locale = */setlocale(LC_ALL, "");
 377
 378         syslog(9, "Message catalog directory: %s\n", bindtextdomain("webcit", LOCALEDIR"/locale"));
 379         syslog(9, "Text domain: %s\n", textdomain("webcit"));
 380         syslog(9, "Text domain Charset: %s\n", bind_textdomain_codeset("webcit","UTF8"));
 381
 382 #endif
 383 }
 384
 385
 386 void
 387 ServerShutdownModule_GETTEXT
 388 (void)
 389 {
 390 #ifdef HAVE_USELOCALE
 391         int i;
 392         for (i = 0; i < nLocalesLoaded; ++i) {
 393                 if (Empty_Locale != wc_locales[i])
 394                         freelocale(wc_locales[i]);
 395         }
 396         free(wc_locales);
 397 #endif
 398         free(AvailLangLoaded);
 399 }
 400
 401 #else   /* ENABLE_NLS */
 402 const char *AvailLang[] = {
 403         "C", ""};
 404
 405 /* dummy for non NLS enabled systems */
 406 void tmplput_offer_languages(StrBuf *Target, WCTemplputParams *TP)
 407 {
 408         wc_printf("English (US)");
 409 }
 410
 411 /* dummy for non NLS enabled systems */
 412 void set_selected_language(const char *lang) {
 413 }
 414
 415 /* dummy for non NLS enabled systems */
 416 void go_selected_language(void) {
 417 }
 418
 419 /* dummy for non NLS enabled systems */
 420 void stop_selected_language(void) {
 421 }
 422
 423 void initialize_locales(void) {
 424 }
 425
 426 #endif  /* ENABLE_NLS */
 427
 428
 429 void TmplGettext(StrBuf *Target, WCTemplputParams *TP)
 430 {
 431         StrBufAppendBufPlain(Target, _(TP->Tokens->Params[0]->Start), -1, 0);
 432 }
 433
 434
 435 /*
 436  * Returns the language currently in use.
 437  * This function returns a static string, so don't do anything stupid please.
 438  */
 439 const char *get_selected_language(void) {
 440 #ifdef ENABLE_NLS
 441 #ifdef HAVE_USELOCALE
 442         return AvailLang[WC->selected_language];
 443 #else
 444         return "en";
 445 #endif
 446 #else
 447         return "en";
 448 #endif
 449 }
 450
 451
 452 void Header_HandleAcceptLanguage(StrBuf *Line, ParsedHttpHdrs *hdr)
 453 {
 454         hdr->HR.browser_language = Line;
 455 }
 456
 457
 458 void
 459 InitModule_GETTEXT
 460 (void)
 461 {
 462         initialize_locales();
 463
 464         RegisterHeaderHandler(HKEY("ACCEPT-LANGUAGE"),
 465                               Header_HandleAcceptLanguage);
 466
 467         RegisterNamespace("LANG:SELECT", 0, 0,
 468                           tmplput_offer_languages, NULL, CTX_NONE);
 469 }
 470
 471
 472 void
 473 SessionNewModule_GETTEXT
 474 (wcsession *sess)
 475 {
 476 #ifdef ENABLE_NLS
 477         if (    (sess != NULL)
 478                 && (!sess->Hdr->HR.Static)
 479                 && (sess->Hdr->HR.browser_language != NULL)
 480         ) {
 481                 httplang_to_locale(sess->Hdr->HR.browser_language, sess);
 482         }
 483 #endif
 484 }
 485
 486 void
 487 SessionAttachModule_GETTEXT
 488 (wcsession *sess)
 489 {
 490 #ifdef ENABLE_NLS
 491         go_selected_language();                                 /* set locale */
 492 #endif
 493 }
 494
 495 void
 496 SessionDestroyModule_GETTEXT
 497 (wcsession *sess)
 498 {
 499 #ifdef ENABLE_NLS
 500         stop_selected_language();                               /* unset locale */
 501 #endif
 502 }