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         ""
  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                         ls->priority = StrTol(SBuf);
 115                 }
 116                 else {
 117                         ls->priority = 1000;
 118                 }
 119
 120                 /** get the locale part */
 121                 StrBufExtract_token(SBuf, Buf, 0, ';');
 122
 123                 /** get the lang part, which should be allways there */
 124                 extract_token(&ls->lang[0],
 125                               ChrPtr(SBuf),
 126                               0, '-',
 127                               sizeof(ls->lang));
 128
 129                 /** get the area code if any. */
 130                 if (StrBufNum_tokens(SBuf, '-') > 1) {
 131                         extract_token(&ls->region[0],
 132                                       ChrPtr(SBuf),
 133                                       1, '-',
 134                                       sizeof(ls->region));
 135                 }
 136                 else { /** no ara code? use lang code */
 137                         blen=strlen(&ls->lang[0]);
 138                         memcpy(&ls->region[0], ls->lang, blen);
 139                         ls->region[blen] = '\0';
 140                 }
 141
 142                 /* area codes are uppercase */
 143                 blen = strlen(&ls->region[0]);
 144                 for (j = 0; j < blen; j++)
 145                 {
 146                         int chars;
 147                         chars = toupper(ls->region[j]);
 148                         ls->region[j] = (char)chars;/** \todo ?! */
 149                 }
 150                 snprintf(&lbuf[0],
 151                          sizeof(lbuf),
 152                          "%s_%s",
 153                          &ls->lang[0],
 154                          &ls->region[0]);
 155
 156                 /** check if we have this lang */
 157                 ls->availability = 1;
 158                 ls->selectedlang = -1;
 159                 for (j = 0; j < nLocalesLoaded; j++) {
 160                         int result;
 161                         /** match against the LANG part */
 162                         result = strcasecmp(&ls->lang[0], AvailLangLoaded[j]);
 163                         if ((result < 0) && (result < ls->availability)){
 164                                 ls->availability = result;
 165                                 ls->selectedlang = j;
 166                         }
 167                         /** match against lang and locale */
 168                         if (0 == strcasecmp(&lbuf[0], AvailLangLoaded[j])){
 169                                 ls->availability = 0;
 170                                 ls->selectedlang = j;
 171                                 j = nLocalesLoaded;
 172                         }
 173                 }
 174         }
 175
 176         prio = 0;
 177         av = -1000;
 178         nBest = -1;
 179         for (i = 0; ((i < nParts) && (i<SEARCH_LANG)); i++) {
 180                 ls = &wanted_locales[i];
 181                 if ((ls->availability <= 0) &&
 182                     (av < ls->availability) &&
 183                     (prio < ls->priority) &&
 184                     (ls->selectedlang != -1)) {
 185                         nBest = ls->selectedlang;
 186                         av = ls->availability;
 187                         prio = ls->priority;
 188                 }
 189         }
 190         if (nBest == -1) {
 191                 /** fall back to C */
 192                 nBest=0;
 193         }
 194         sess->selected_language = nBest;
 195         syslog(9, "language found: %s\n", AvailLangLoaded[WC->selected_language]);
 196         FreeStrBuf(&Buf);
 197         FreeStrBuf(&SBuf);
 198 }
 199
 200 /*
 201  * show the language chooser on the login dialog
 202  * depending on the browser locale change the sequence of the
 203  * language chooser.
 204  */
 205 void tmplput_offer_languages(StrBuf *Target, WCTemplputParams *TP)
 206 {
 207         int i;
 208 #ifndef HAVE_USELOCALE
 209         char *Lang = getenv("LANG");
 210
 211         if (Lang == NULL)
 212                 Lang = "C";
 213 #endif
 214
 215
 216         if (nLocalesLoaded == 1) {
 217                 wc_printf("<p>%s</p>", AvailLangLoaded[0]);
 218                 return;
 219         }
 220
 221         wc_printf("<select name=\"language\" id=\"lname\" size=\"1\" onChange=\"switch_to_lang($('lname').value);\">\n");
 222
 223         for (i=0; i < nLocalesLoaded; ++i) {
 224 #ifndef HAVE_USELOCALE
 225                 if (strcmp(AvailLangLoaded[i], Lang) == 0)
 226 #endif
 227                 wc_printf("<option %s value=%s>%s</option>\n",
 228                         ((WC->selected_language == i) ? "selected" : ""),
 229                         AvailLangLoaded[i],
 230                         AvailLangLoaded[i]
 231                 );
 232         }
 233
 234         wc_printf("</select>\n");
 235 }
 236
 237 /*
 238  * Set the selected language for this session.
 239  */
 240 void set_selected_language(const char *lang) {
 241 #ifdef HAVE_USELOCALE
 242         int i;
 243         for (i = 0; i<nLocalesLoaded; ++i) {
 244                 if (!strcasecmp(lang, AvailLangLoaded[i])) {
 245                         WC->selected_language = i;
 246                 }
 247         }
 248 #endif
 249 }
 250
 251 /*
 252  * Activate the selected language for this session.
 253  */
 254 void go_selected_language(void) {
 255 #ifdef HAVE_USELOCALE
 256         wcsession *WCC = WC;
 257         if (WCC->selected_language < 0) return;
 258         uselocale(wc_locales[WCC->selected_language]);  /** switch locales */
 259         textdomain(textdomain(NULL));                   /** clear the cache */
 260 #else
 261         char *language;
 262
 263         language = getenv("LANG");
 264         setlocale(LC_MESSAGES, language);
 265 #endif
 266 }
 267
 268 /*
 269  * Deactivate the selected language for this session.
 270  */
 271 void stop_selected_language(void) {
 272 #ifdef HAVE_USELOCALE
 273         uselocale(LC_GLOBAL_LOCALE);                    /** switch locales */
 274         textdomain(textdomain(NULL));                   /** clear the cache */
 275 #endif
 276 }
 277
 278 #ifdef HAVE_USELOCALE
 279         locale_t Empty_Locale;
 280 #endif
 281
 282 /*
 283  * Create a locale_t for each available language
 284  */
 285 void initialize_locales(void) {
 286         int nLocales;
 287         int i;
 288         char buf[32];
 289         char *language = NULL;
 290         char *locale;
 291
 292
 293         nLocales = 0;
 294         while (!IsEmptyStr(AvailLang[nLocales]))
 295                 nLocales++;
 296
 297         language = getenv("WEBCIT_LANG");
 298         if ((language) && (!IsEmptyStr(language)) && (strcmp(language, "UNLIMITED") != 0)) {
 299                 syslog(9, "Nailing locale to %s\n", language);
 300         }
 301         else language = NULL;
 302
 303         AvailLangLoaded = malloc (sizeof(char*) * nLocales);
 304         memset(AvailLangLoaded, 0, sizeof(char*) * nLocales);
 305 #ifdef HAVE_USELOCALE
 306         wc_locales = malloc (sizeof(locale_t) * nLocales);
 307         memset(wc_locales,0, sizeof(locale_t) * nLocales);
 308         /* create default locale */
 309         Empty_Locale = newlocale(LC_ALL_MASK, NULL, NULL);
 310 #endif
 311
 312
 313
 314
 315         for (i = 0; i < nLocales; ++i) {
 316                 if ((language != NULL) && (strcmp(AvailLang[i], language) != 0))
 317                         continue;
 318                 if (i == 0) {
 319                         sprintf(buf, "%s", AvailLang[i]);       /* locale 0 (C) is ascii, not utf-8 */
 320                 }
 321                 else {
 322                         sprintf(buf, "%s.UTF8", AvailLang[i]);
 323                 }
 324 #ifdef HAVE_USELOCALE
 325                 wc_locales[nLocalesLoaded] = newlocale(
 326                         (LC_MESSAGES_MASK|LC_TIME_MASK),
 327                         buf,
 328                         (((i > 0) && (wc_locales[0] != NULL)) ? wc_locales[0] : Empty_Locale)
 329                 );
 330                 if (wc_locales[nLocalesLoaded] == NULL) {
 331                         syslog(1, "locale for "LOCALEDIR"locale/%s: %s; disabled\n",
 332                                 buf,
 333                                 strerror(errno)
 334                         );
 335                 }
 336                 else {
 337                         syslog(3, "Found locale: %s\n", buf);
 338                         AvailLangLoaded[nLocalesLoaded] = AvailLang[i];
 339                         nLocalesLoaded++;
 340                 }
 341 #else
 342                 if ((language != NULL) && (strcmp(language, AvailLang[i]) == 0)) {
 343                         setenv("LANG", buf, 1);
 344                         AvailLangLoaded[nLocalesLoaded] = AvailLang[i];
 345                         setlocale(LC_MESSAGES, AvailLang[i]);
 346                         nLocalesLoaded++;
 347                 }
 348                 else if (nLocalesLoaded == 0) {
 349                         setenv("LANG", buf, 1);
 350                         AvailLangLoaded[nLocalesLoaded] = AvailLang[i];
 351                         nLocalesLoaded++;
 352                 }
 353 #endif
 354         }
 355         if ((language != NULL) && (nLocalesLoaded == 0)) {
 356                 syslog(1, "Your selected locale [%s] isn't available on your system. falling back to C\n", language);
 357 #ifdef HAVE_USELOCALE
 358                 wc_locales[0] = newlocale(
 359                         (LC_MESSAGES_MASK|LC_TIME_MASK),
 360                         AvailLang[0],
 361                         Empty_Locale);
 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         locale = setlocale(LC_ALL, "");
 372
 373         syslog(9, "Message catalog directory: %s\n", bindtextdomain("webcit", LOCALEDIR"/locale"));
 374         syslog(9, "Text domain: %s\n", textdomain("webcit"));
 375         syslog(9, "Text domain Charset: %s\n", bind_textdomain_codeset("webcit","UTF8"));
 376
 377 #endif
 378 }
 379
 380
 381 void
 382 ServerShutdownModule_GETTEXT
 383 (void)
 384 {
 385 #ifdef HAVE_USELOCALE
 386         int i;
 387         for (i = 0; i < nLocalesLoaded; ++i) {
 388                 if (Empty_Locale != wc_locales[i])
 389                         freelocale(wc_locales[i]);
 390         }
 391         free(wc_locales);
 392 #endif
 393         free(AvailLangLoaded);
 394 }
 395
 396 #else   /* ENABLE_NLS */
 397 const char *AvailLang[] = {
 398         "C", ""};
 399
 400 /* dummy for non NLS enabled systems */
 401 void tmplput_offer_languages(StrBuf *Target, WCTemplputParams *TP)
 402 {
 403         wc_printf("English (US)");
 404 }
 405
 406 /* dummy for non NLS enabled systems */
 407 void set_selected_language(const char *lang) {
 408 }
 409
 410 /* dummy for non NLS enabled systems */
 411 void go_selected_language(void) {
 412 }
 413
 414 /* dummy for non NLS enabled systems */
 415 void stop_selected_language(void) {
 416 }
 417
 418 void initialize_locales(void) {
 419 }
 420
 421 #endif  /* ENABLE_NLS */
 422
 423
 424 void TmplGettext(StrBuf *Target, WCTemplputParams *TP)
 425 {
 426         StrBufAppendBufPlain(Target, _(TP->Tokens->Params[0]->Start), -1, 0);
 427 }
 428
 429
 430 /*
 431  * Returns the language currently in use.
 432  * This function returns a static string, so don't do anything stupid please.
 433  */
 434 const char *get_selected_language(void) {
 435 #ifdef ENABLE_NLS
 436 #ifdef HAVE_USELOCALE
 437         return AvailLang[WC->selected_language];
 438 #else
 439         return "en";
 440 #endif
 441 #else
 442         return "en";
 443 #endif
 444 }
 445
 446
 447 void Header_HandleAcceptLanguage(StrBuf *Line, ParsedHttpHdrs *hdr)
 448 {
 449         hdr->HR.browser_language = Line;
 450 }
 451
 452
 453 void
 454 InitModule_GETTEXT
 455 (void)
 456 {
 457         initialize_locales();
 458
 459         RegisterHeaderHandler(HKEY("ACCEPT-LANGUAGE"),
 460                               Header_HandleAcceptLanguage);
 461
 462         RegisterNamespace("LANG:SELECT", 0, 0,
 463                           tmplput_offer_languages, NULL, CTX_NONE);
 464 }
 465
 466
 467 void
 468 SessionNewModule_GETTEXT
 469 (wcsession *sess)
 470 {
 471 #ifdef ENABLE_NLS
 472         if (!sess->Hdr->HR.Static &&
 473             (sess->Hdr->HR.browser_language != NULL)) {
 474                 httplang_to_locale(sess->Hdr->HR.browser_language, sess);
 475         }
 476 #endif
 477 }
 478
 479 void
 480 SessionAttachModule_GETTEXT
 481 (wcsession *sess)
 482 {
 483 #ifdef ENABLE_NLS
 484         go_selected_language();                                 /* set locale */
 485 #endif
 486 }
 487
 488 void
 489 SessionDestroyModule_GETTEXT
 490 (wcsession *sess)
 491 {
 492 #ifdef ENABLE_NLS
 493         stop_selected_language();                               /* unset locale */
 494 #endif
 495 }