webcit/gettext.c

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