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         "en_US",
  21         "ar_AE",
  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         ""
  45 };
  46
  47 const char **AvailLangLoaded;
  48 long nLocalesLoaded = 0;
  49
  50 #ifdef HAVE_USELOCALE
  51 locale_t *wc_locales; /* here we keep the parsed stuff */
  52 #endif
  53
  54 /* Keep information about one locale */
  55 typedef struct _lang_pref {
  56         char lang[16];          /* the language locale string */
  57         char region[16];        /* the region locale string */
  58         long priority;          /* which priority does it have */
  59         int availability;       /* do we know it? */
  60         int selectedlang;       /* is this the selected language? */
  61 } LangStruct;
  62
  63 /* parse browser locale header
  64  *
  65  * seems as most browsers just do a one after comma value even if more than 10 locales are available. Sample strings:
  66  * opera:
  67  * 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
  68  * Firefox
  69  * Accept-Language: 'de-de,en-us;q=0.7,en;q=0.3'
  70  * Accept-Language: de,en-ph;q=0.8,en-us;q=0.5,de-at;q=0.3
  71  * 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
  72  */
  73
  74 void httplang_to_locale(StrBuf *LocaleString, wcsession *sess)
  75 {
  76         LangStruct wanted_locales[SEARCH_LANG];
  77         LangStruct *ls;
  78
  79         long len;
  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,
 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,
 136                                       ChrPtr(SBuf),
 137                                       1, '-',
 138                                       sizeof(ls->region)
 139                         );
 140                 }
 141                 else { /* no ara code? use lang code */
 142                         blen = strlen(ls->lang);
 143                         memcpy(ls->region, 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,
 156                          sizeof(lbuf),
 157                          "%s_%s",
 158                          ls->lang,
 159                          ls->region);
 160
 161                 /* check if we have this lang */
 162                 ls->availability = 1;
 163                 ls->selectedlang = -1;
 164                 len = strlen(ls->lang);
 165                 for (j = 0; j < nLocalesLoaded; j++) {
 166                         int result;
 167                         /* match against the LANG part */
 168                         result = strncasecmp(ls->lang, AvailLangLoaded[j], len);
 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, 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                 ) {
 192                         nBest = ls->selectedlang;
 193                         av = ls->availability;
 194                         prio = ls->priority;
 195                 }
 196         }
 197         if (nBest == -1) {
 198                 /* fall back to C */
 199                 nBest=0;
 200         }
 201         sess->selected_language = nBest;
 202         syslog(LOG_DEBUG, "language found: %s", AvailLangLoaded[sess->selected_language]);
 203         FreeStrBuf(&Buf);
 204         FreeStrBuf(&SBuf);
 205 }
 206
 207
 208 /*
 209  * show the language chooser on the login dialog
 210  * depending on the browser locale change the sequence of the
 211  * language chooser.
 212  */
 213 void tmplput_offer_languages(StrBuf *Target, WCTemplputParams *TP)
 214 {
 215         int i;
 216 #ifndef HAVE_USELOCALE
 217         char *Lang = getenv("LANG");
 218
 219         if (Lang == NULL)
 220                 Lang = "C";
 221 #endif
 222
 223         if (nLocalesLoaded == 1) {
 224                 wc_printf("<p>%s</p>", AvailLangLoaded[0]);
 225                 return;
 226         }
 227
 228         wc_printf("<select name=\"language\" id=\"lname\" size=\"1\" onChange=\"switch_to_lang($('lname').value);\">\n");
 229
 230         for (i=0; i < nLocalesLoaded; ++i) {
 231 #ifndef HAVE_USELOCALE
 232                 if (strcmp(AvailLangLoaded[i], Lang) == 0)
 233 #endif
 234                 wc_printf("<option %s value=%s>%s</option>\n",
 235                         ((WC->selected_language == i) ? "selected" : ""),
 236                         AvailLangLoaded[i],
 237                         AvailLangLoaded[i]
 238                 );
 239         }
 240
 241         wc_printf("</select>\n");
 242 }
 243
 244 /*
 245  * Set the selected language for this session.
 246  */
 247 void set_selected_language(const char *lang) {
 248 #ifdef HAVE_USELOCALE
 249         int i;
 250         for (i = 0; i<nLocalesLoaded; ++i) {
 251                 if (!strcasecmp(lang, AvailLangLoaded[i])) {
 252                         WC->selected_language = i;
 253                         break;
 254                 }
 255         }
 256 #endif
 257 }
 258
 259 /*
 260  * Activate the selected language for this session.
 261  */
 262 void go_selected_language(void) {
 263 #ifdef HAVE_USELOCALE
 264         wcsession *WCC = WC;
 265         if (WCC->selected_language < 0)
 266         {
 267                 httplang_to_locale(WCC->Hdr->HR.browser_language, WCC);
 268                 if (WCC->selected_language < 0)
 269                         return;
 270         }
 271         uselocale(wc_locales[WCC->selected_language]);  /* switch locales */
 272         textdomain(textdomain(NULL));                   /* clear the cache */
 273 #else
 274         char *language;
 275
 276         language = getenv("LANG");
 277         setlocale(LC_MESSAGES, language);
 278 #endif
 279 }
 280
 281 /*
 282  * Deactivate the selected language for this session.
 283  */
 284 void stop_selected_language(void) {
 285 #ifdef HAVE_USELOCALE
 286         uselocale(LC_GLOBAL_LOCALE);                    /* switch locales */
 287         textdomain(textdomain(NULL));                   /* clear the cache */
 288 #endif
 289 }
 290
 291 #ifdef HAVE_USELOCALE
 292         locale_t Empty_Locale;
 293 #endif
 294
 295 /*
 296  * Create a locale_t for each available language
 297  */
 298 void initialize_locales(void) {
 299         int nLocales;
 300         int i;
 301         char buf[32];
 302         char *language = NULL;
 303
 304         nLocales = 0;
 305         while (!IsEmptyStr(AvailLang[nLocales]))
 306                 nLocales++;
 307
 308         language = getenv("WEBCIT_LANG");
 309         if ((language) && (!IsEmptyStr(language)) && (strcmp(language, "UNLIMITED") != 0)) {
 310                 syslog(LOG_INFO, "Nailing locale to %s", language);
 311         }
 312         else language = NULL;
 313
 314         AvailLangLoaded = malloc (sizeof(char*) * nLocales);
 315         memset(AvailLangLoaded, 0, sizeof(char*) * nLocales);
 316 #ifdef HAVE_USELOCALE
 317         wc_locales = malloc (sizeof(locale_t) * nLocales);
 318         memset(wc_locales,0, sizeof(locale_t) * nLocales);
 319         /* create default locale */
 320         Empty_Locale = newlocale(LC_ALL_MASK, NULL, NULL);
 321 #endif
 322
 323         for (i = 0; i < nLocales; ++i) {
 324                 if ((language != NULL) && (strcmp(AvailLang[i], language) != 0))
 325                         continue;
 326                 if (i == 0) {
 327                         sprintf(buf, "C");      /* locale 0 (C) is ascii, not utf-8 */
 328
 329                 }
 330                 else {
 331                         sprintf(buf, "%s.UTF8", AvailLang[i]);
 332                 }
 333 #ifdef HAVE_USELOCALE
 334                 wc_locales[nLocalesLoaded] = newlocale(
 335                         (LC_MESSAGES_MASK|LC_TIME_MASK),
 336                         buf,
 337                         (((i > 0) && (wc_locales[0] != NULL)) ? wc_locales[0] : Empty_Locale)
 338                 );
 339                 if (wc_locales[nLocalesLoaded] == NULL) {
 340                         syslog(LOG_NOTICE, "locale for %s disabled: %s", buf, strerror(errno));
 341                 }
 342                 else {
 343                         syslog(LOG_INFO, "Found locale: %s - %s", buf, AvailLang[i]);
 344                         AvailLangLoaded[nLocalesLoaded] = AvailLang[i];
 345                         nLocalesLoaded++;
 346                 }
 347 #else
 348                 if ((language != NULL) && (strcmp(language, AvailLang[i]) == 0)) {
 349                         setenv("LANG", buf, 1);
 350                         AvailLangLoaded[nLocalesLoaded] = AvailLang[i];
 351                         setlocale(LC_MESSAGES, AvailLang[i]);
 352                         nLocalesLoaded++;
 353                 }
 354                 else if (nLocalesLoaded == 0) {
 355                         setenv("LANG", buf, 1);
 356                         AvailLangLoaded[nLocalesLoaded] = AvailLang[i];
 357                         nLocalesLoaded++;
 358                 }
 359 #endif
 360         }
 361         if ((language != NULL) && (nLocalesLoaded == 0)) {
 362                 syslog(LOG_WARNING, "Your selected locale [%s] isn't available on your system. falling back to C", language);
 363 #ifdef HAVE_USELOCALE
 364                 wc_locales[0] = newlocale(
 365                         (LC_MESSAGES_MASK|LC_TIME_MASK),
 366                         AvailLang[0],
 367                         Empty_Locale
 368                 );
 369 #else
 370                 setlocale(LC_MESSAGES, AvailLang[0]);
 371                 setenv("LANG", AvailLang[0], 1);
 372 #endif
 373                 AvailLangLoaded[0] = AvailLang[0];
 374                 nLocalesLoaded = 1;
 375         }
 376
 377 #ifdef ENABLE_NLS
 378         setlocale(LC_ALL, "");
 379         syslog(LOG_DEBUG, "Text domain: %s", textdomain("webcit"));
 380         syslog(LOG_DEBUG, "Text domain Charset: %s", bind_textdomain_codeset("webcit", "UTF8"));
 381         syslog(LOG_DEBUG, "Message catalog directory: %s", bindtextdomain(textdomain(NULL), LOCALEDIR"/locale"));
 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         }
 397         free(wc_locales);
 398 #endif
 399         free(AvailLangLoaded);
 400 }
 401
 402 #else   /* ENABLE_NLS */
 403 const char *AvailLang[] = {
 404         "C",
 405         ""
 406 };
 407
 408 /* dummy for non NLS enabled systems */
 409 void
 410 ServerShutdownModule_GETTEXT
 411 (void)
 412 {
 413 }
 414
 415
 416 void tmplput_offer_languages(StrBuf *Target, WCTemplputParams *TP)
 417 {
 418         wc_printf("English (US)");
 419 }
 420
 421 /* dummy for non NLS enabled systems */
 422 void set_selected_language(const char *lang) {
 423 }
 424
 425 /* dummy for non NLS enabled systems */
 426 void go_selected_language(void) {
 427 }
 428
 429 /* dummy for non NLS enabled systems */
 430 void stop_selected_language(void) {
 431 }
 432
 433 void initialize_locales(void) {
 434 }
 435
 436 #endif  /* ENABLE_NLS */
 437
 438 void TmplGettext(StrBuf *Target, WCTemplputParams *TP)
 439 {
 440         const char *Text = _(TP->Tokens->Params[0]->Start);
 441
 442         StrBufAppendTemplateStr(Target, TP, Text, 1);
 443 }
 444
 445
 446 /*
 447  * Returns the language currently in use.
 448  * This function returns a static string, so don't do anything stupid please.
 449  */
 450 const char *get_selected_language(void) {
 451 #ifdef ENABLE_NLS
 452 #ifdef HAVE_USELOCALE
 453         return AvailLangLoaded[WC->selected_language];
 454 #else
 455         return "en";
 456 #endif
 457 #else
 458         return "en";
 459 #endif
 460 }
 461
 462
 463 void Header_HandleAcceptLanguage(StrBuf *Line, ParsedHttpHdrs *hdr)
 464 {
 465         hdr->HR.browser_language = Line;
 466 }
 467
 468
 469 void
 470 InitModule_GETTEXT
 471 (void)
 472 {
 473         initialize_locales();
 474
 475         RegisterHeaderHandler(HKEY("ACCEPT-LANGUAGE"),
 476                               Header_HandleAcceptLanguage);
 477
 478         RegisterNamespace("LANG:SELECT", 0, 0,
 479                           tmplput_offer_languages, NULL, CTX_NONE);
 480 }
 481
 482
 483 void
 484 SessionNewModule_GETTEXT
 485 (wcsession *sess)
 486 {
 487 #ifdef ENABLE_NLS
 488         if (    (sess != NULL)
 489                 && (!sess->Hdr->HR.Static)
 490                 && (sess->Hdr->HR.browser_language != NULL)
 491         ) {
 492                 httplang_to_locale(sess->Hdr->HR.browser_language, sess);
 493         }
 494 #endif
 495 }
 496
 497 void
 498 SessionAttachModule_GETTEXT
 499 (wcsession *sess)
 500 {
 501 #ifdef ENABLE_NLS
 502         go_selected_language();                                 /* set locale */
 503 #endif
 504 }
 505
 506 void
 507 SessionDestroyModule_GETTEXT
 508 (wcsession *sess)
 509 {
 510 #ifdef ENABLE_NLS
 511         stop_selected_language();                               /* unset locale */
 512 #endif
 513 }