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