Fix gettext and prepare French translation

sources/config.php

@@ -18,57 +18,56 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-// Limonade configuration
+// Framework configuration
 function configure() {
-    option('env', ENV_PRODUCTION);
-    option('debug', false);
-    option('base_uri', '<TPL:NGINX_LOCATION>/');
-    layout("layout.html.php");
-    define('PUBLIC_DIR', '<TPL:NGINX_LOCATION>/public');
-}
+  option('env', ENV_PRODUCTION);
+  option('debug', false);
+  option('base_uri', '<TPL:NGINX_LOCATION>/');
 
-// Not found page
-function not_found($errno, $errstr, $errfile=null, $errline=null) {
-    $msg = h(rawurldecode($errstr));
-    return render($msg, 'error_layout.html.php');
-}
+  layout('layout.html.php');
 
-function T_($string) {
-    return gettext($string);
+  define('PUBLIC_DIR', '<TPL:NGINX_LOCATION>/public');
 }
 
 // Before routing
 function before($route) {
-     /**
-     * * Locale
-     * */
-    if (!isset($_SESSION['locale'])) {
-        $locale = explode(',',$_SERVER['HTTP_ACCEPT_LANGUAGE']);
-        $_SESSION['locale'] = strtolower(substr(chop($locale[0]),0,2));
-    }
-    $textdomain="localization";
-    putenv('LANGUAGE='.$_SESSION['locale']);
-    putenv('LANG='.$_SESSION['locale']);
-    putenv('LC_ALL='.$_SESSION['locale']);
-    putenv('LC_MESSAGES='.$_SESSION['locale']);
-    setlocale(LC_ALL,$_SESSION['locale']);
-    setlocale(LC_CTYPE,$_SESSION['locale']);
-    $locales_dir = dirname(__FILE__).'/../i18n';
-    bindtextdomain($textdomain,$locales_dir);
-    bind_textdomain_codeset($textdomain, 'UTF-8');
-    textdomain($textdomain);
-    // Set the $locale variable in template
-    set('locale', $_SESSION['locale']);
+  $lang_mapping = array(
+    'fr' => 'fr_FR'
+  );
+
+  if(!isset($_SESSION['locale'])) {
+    $locale = explode(',', $_SERVER['HTTP_ACCEPT_LANGUAGE']);
+    $_SESSION['locale'] = strtolower(substr(chop($locale[0]), 0, 2));
+  }
+
+  $lang = $_SESSION['locale'];
+
+  // Convert simple language code into full language code
+  if(array_key_exists($lang, $lang_mapping)) {
+    $lang = $lang_mapping[$lang];
+  }
+
+  $lang = "$lang.utf8";
+  $textdomain = "localization";
+
+  putenv("LANGUAGE=$lang");
+  putenv("LANG=$lang");
+  putenv("LC_ALL=$lang");
+  putenv("LC_MESSAGES=$lang");
+
+  setlocale(LC_ALL, $lang);
+  setlocale(LC_CTYPE, $lang);
+
+  $locales_dir = dirname(__FILE__).'/i18n';
+
+  bindtextdomain($textdomain, $locales_dir);
+  bind_textdomain_codeset($textdomain, 'UTF-8');
+  textdomain($textdomain);
+
+  set('locale', $lang);
 }
 
 // After routing
 function after($output, $route) {
-    /*
-    $time = number_format( (float)substr(microtime(), 0, 10) - LIM_START_MICROTIME, 6);
-    $output .= "\n<!-- page rendered in $time sec., on ".date(DATE_RFC822)." -->\n";
-    $output .= "<!-- for route\n";
-    $output .= print_r($route, true);
-    $output .= "-->";
-    */
-    return $output;
+  return $output;
 }

sources/controller.php

@@ -91,15 +91,15 @@ dispatch_put('/settings', function() {
       $_POST['opt_name'] = htmlentities(str_replace('"', '', $_POST['opt_name']));
 
       if(empty($_POST['opt_name'])) {
-        throw new Exception(T_('The name cannot be empty'));
+        throw new Exception(_('The name cannot be empty'));
       }
 
       if($_POST['wifi_device_id'] == -1) {
-        throw new Exception(T_('You need to select an associated hotspot'));
+        throw new Exception(_('You need to select an associated hotspot'));
       }
 
     } catch(Exception $e) {
-      flash('error', T_('PirateBox')." $id: ".$e->getMessage().' ('.T_('configuration not updated').').');
+      flash('error', _('PirateBox')." $id: ".$e->getMessage().' ('._('configuration not updated').').');
       goto redirect;
     }
   }
@@ -118,13 +118,13 @@ dispatch_put('/settings', function() {
     $retcode = start_service();
 
     if($retcode == 0) {
-      flash('success', T_('Configuration updated and service successfully reloaded'));
+      flash('success', _('Configuration updated and service successfully reloaded'));
     } else {
-      flash('error', T_('Configuration updated but service reload failed'));
+      flash('error', _('Configuration updated but service reload failed'));
     }
 
   } else {
-      flash('success', T_('Service successfully disabled'));
+      flash('success', _('Service successfully disabled'));
   }
 
   redirect:
@@ -154,18 +154,14 @@ dispatch('/status', function() {
 });
 
 dispatch('/lang/:locale', function($locale = 'en') {
-  switch ($locale) {
+  switch($locale) {
     case 'fr':
       $_SESSION['locale'] = 'fr';
-      break;
+    break;
 
     default:
       $_SESSION['locale'] = 'en';
   }
 
-  if(!empty($_GET['redirect_to'])) {
-    redirect_to($_GET['redirect_to']);
-  } else {
-    redirect_to('/');
-  }
+  redirect_to('/');
 });

sources/i18n/README

@@ -1,3 +0,0 @@
-Add a "localization.pot" to this directory, and one folder per translated language, containing the po a LC_MESSAGE directory (with the .mo)
-
-See: https://github.com/YunoHost/admin_v1/tree/master/i18n

sources/i18n/README.md

@@ -0,0 +1,45 @@
+## Force language
+
+The default language of the web admin depends on your browser language.
+
+You can force a language by using (e.g. for French):
+```
+/piratebox/?/lang/fr
+```
+
+English is the default language when the browser language is not available.
+
+## Update the default string list
+
+Updating the pot file from template files:
+```
+xgettext sources/views/* -o sources/i18n/localization.pot
+```
+
+## Add a new language
+
+Create a new directory path (e.g. for French):
+```
+mkdir -p sources/i18n/fr_FR/LC_MESSAGES/
+```
+
+Generate the po file:
+```
+msginit --locale=fr_FR.UTF-8 --no-translator -i sources/i18n/localization.pot -o sources/i18n/fr_FR/LC_MESSAGES/localization.po
+```
+
+You can use poedit for translating the po:
+```
+poedit sources/i18n/fr_FR/LC_MESSAGES/localization.po
+```
+
+With poedit, just save your modifications with the button and the *localization.mo* (compiled version of the po) file will automatically be created or updated.
+
+If you edited the po by hand, you have to compile the mo file:
+```
+msgfmt sources/i18n/fr_FR/localization.po -o sources/i18n/fr_FR/LC_MESSAGES/localization.mo
+```
+
+Change the default language of your browser, and test this new translation.
+
+You should add the locale to the list at the end of *sources/controller.php*.

sources/i18n/fr_FR/LC_MESSAGES/localization.po

@@ -0,0 +1,103 @@
+# French translations for PACKAGE package.
+# Copyright (C) 2015 THE PACKAGE'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the PACKAGE package.
+# Automatically generated, 2015.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2015-07-08 19:58+0200\n"
+"PO-Revision-Date: 2015-07-08 19:58+0200\n"
+"Last-Translator: Automatically generated\n"
+"Language-Team: none\n"
+"Language: fr\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=ASCII\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=2; plural=(n > 1);\n"
+
+#: sources/views/layout.html.php:27 sources/views/settings.html.php:80
+msgid "PirateBox"
+msgstr ""
+
+#: sources/views/layout.html.php:49
+msgid "Error"
+msgstr ""
+
+#: sources/views/layout.html.php:54 sources/views/settings.html.php:60
+msgid "Notice"
+msgstr ""
+
+#: sources/views/layout.html.php:66
+msgid "Any problem? Contribute!"
+msgstr ""
+
+#: sources/views/settings.html.php:20
+msgid "PirateBox Configuration"
+msgstr ""
+
+#: sources/views/settings.html.php:22 sources/views/settings.html.php:24
+msgid ""
+"This is a fast status. Click on More details to show the complete status."
+msgstr ""
+
+#: sources/views/settings.html.php:22
+msgid "Running"
+msgstr ""
+
+#: sources/views/settings.html.php:24
+msgid "Not Running"
+msgstr ""
+
+#: sources/views/settings.html.php:27
+msgid "Loading complete status may take a few minutes. Be patient."
+msgstr ""
+
+#: sources/views/settings.html.php:27
+msgid "More details"
+msgstr ""
+
+#: sources/views/settings.html.php:43
+msgid "Service"
+msgstr ""
+
+#: sources/views/settings.html.php:48
+msgid "PirateBox Enabled"
+msgstr ""
+
+#: sources/views/settings.html.php:60
+msgid "You need to select an associated hotspot."
+msgstr ""
+
+#: sources/views/settings.html.php:64
+msgid "Associated Hotspot"
+msgstr ""
+
+#: sources/views/settings.html.php:68
+msgid "None"
+msgstr ""
+
+#: sources/views/settings.html.php:85
+msgid "Name"
+msgstr ""
+
+#: sources/views/settings.html.php:92
+msgid "Renaming Allowed"
+msgstr ""
+
+#: sources/views/settings.html.php:101
+msgid "Deleting Allowed"
+msgstr ""
+
+#: sources/views/settings.html.php:110
+msgid "Chat Enabled"
+msgstr ""
+
+#: sources/views/settings.html.php:122
+msgid "Reloading may take a few minutes. Be patient."
+msgstr ""
+
+#: sources/views/settings.html.php:122
+msgid "Save and reload"
+msgstr ""

sources/i18n/localization.pot

@@ -0,0 +1,103 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the PACKAGE package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2015-07-08 19:58+0200\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"Language: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=CHARSET\n"
+"Content-Transfer-Encoding: 8bit\n"
+
+#: sources/views/layout.html.php:27 sources/views/settings.html.php:80
+msgid "PirateBox"
+msgstr ""
+
+#: sources/views/layout.html.php:49
+msgid "Error"
+msgstr ""
+
+#: sources/views/layout.html.php:54 sources/views/settings.html.php:60
+msgid "Notice"
+msgstr ""
+
+#: sources/views/layout.html.php:66
+msgid "Any problem? Contribute!"
+msgstr ""
+
+#: sources/views/settings.html.php:20
+msgid "PirateBox Configuration"
+msgstr ""
+
+#: sources/views/settings.html.php:22 sources/views/settings.html.php:24
+msgid ""
+"This is a fast status. Click on More details to show the complete status."
+msgstr ""
+
+#: sources/views/settings.html.php:22
+msgid "Running"
+msgstr ""
+
+#: sources/views/settings.html.php:24
+msgid "Not Running"
+msgstr ""
+
+#: sources/views/settings.html.php:27
+msgid "Loading complete status may take a few minutes. Be patient."
+msgstr ""
+
+#: sources/views/settings.html.php:27
+msgid "More details"
+msgstr ""
+
+#: sources/views/settings.html.php:43
+msgid "Service"
+msgstr ""
+
+#: sources/views/settings.html.php:48
+msgid "PirateBox Enabled"
+msgstr ""
+
+#: sources/views/settings.html.php:60
+msgid "You need to select an associated hotspot."
+msgstr ""
+
+#: sources/views/settings.html.php:64
+msgid "Associated Hotspot"
+msgstr ""
+
+#: sources/views/settings.html.php:68
+msgid "None"
+msgstr ""
+
+#: sources/views/settings.html.php:85
+msgid "Name"
+msgstr ""
+
+#: sources/views/settings.html.php:92
+msgid "Renaming Allowed"
+msgstr ""
+
+#: sources/views/settings.html.php:101
+msgid "Deleting Allowed"
+msgstr ""
+
+#: sources/views/settings.html.php:110
+msgid "Chat Enabled"
+msgstr ""
+
+#: sources/views/settings.html.php:122
+msgid "Reloading may take a few minutes. Be patient."
+msgstr ""
+
+#: sources/views/settings.html.php:122
+msgid "Save and reload"
+msgstr ""

sources/views/layout.html.php

@@ -24,7 +24,7 @@
 <!--[if IE 8]> <html class="no-js lt-ie9" lang="en"> <![endif]-->
 <!--[if gt IE 8]><!--> <html class="no-js" lang="<?= $locale ?>"> <!--<![endif]-->
 <head>
-  <title><?= T_("PirateBox") ?><?= isset($title) ? " | $title" : '' ?></title>
+  <title><?= _("PirateBox") ?><?= isset($title) ? " | $title" : '' ?></title>
 
   <meta charset="utf-8">
   <meta name="viewport" content="width=device-width">
@@ -46,12 +46,12 @@
     <?php if(isset($flash['error'])): ?>
       <div class="alert alert-dismissible alert-danger fade in" style="margin-top: 20px" role="alert">
         <button type="button" class="close" data-dismiss="alert"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
-        <strong><?= T_('Error') ?>:</strong> <?= $flash['error'] ?>
+        <strong><?= _('Error') ?>:</strong> <?= $flash['error'] ?>
       </div>
     <?php elseif(isset($flash['notice'])): ?>
       <div class="alert alert-dismissible alert-info fade in" style="margin-top: 20px" role="alert">
         <button type="button" class="close" data-dismiss="alert"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
-        <strong><?= T_('Notice') ?>:</strong> <?= $flash['notice'] ?>
+        <strong><?= _('Notice') ?>:</strong> <?= $flash['notice'] ?>
       </div>
     <?php elseif(isset($flash['success'])): ?>
       <div class="alert alert-dismissible alert-success fade in" style="margin-top: 20px" role="alert">
@@ -63,7 +63,7 @@
     <?= $content ?>
 
     <hr />
-    <div id="github"><a href="https://github.com/labriqueinternet/piratebox_ynh"><?= T_('Any problem? Contribute!') ?></a> - AGPL 3.0</div>
+    <div id="github"><a href="https://github.com/labriqueinternet/piratebox_ynh"><?= _('Any problem? Contribute!') ?></a> - AGPL 3.0</div>
   </div>
 </body>
 

sources/views/settings.html.php

@@ -17,14 +17,14 @@
   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<h2><?= T_("PirateBox Configuration") ?></h2>
+<h2><?= _("PirateBox Configuration") ?></h2>
 <?php if($faststatus): ?>
-  <span class="label label-success" data-toggle="tooltip" data-title="<?= T_('This is a fast status. Click on More details to show the complete status.') ?>"><?= T_('Running') ?></span>
+  <span class="label label-success" data-toggle="tooltip" data-title="<?= _('This is a fast status. Click on More details to show the complete status.') ?>"><?= _('Running') ?></span>
 <?php else: ?>
-  <span class="label label-danger" data-toggle="tooltip" data-title="<?= T_('This is a fast status. Click on More details to show the complete status.') ?>"><?= T_('Not Running') ?></span>
+  <span class="label label-danger" data-toggle="tooltip" data-title="<?= _('This is a fast status. Click on More details to show the complete status.') ?>"><?= _('Not Running') ?></span>
 <?php endif; ?>
 
- &nbsp; <img src="public/img/loading.gif" id="status-loading" alt="Loading..." /><a href="#" id="statusbtn" data-toggle="tooltip" data-title="<?= T_('Loading complete status may take a few minutes. Be patient.') ?>"><?= T_('More details') ?></a> &middot; <a href="http://<?= $opt_domain ?>:4280">PirateBox</a>
+ &nbsp; <img src="public/img/loading.gif" id="status-loading" alt="Loading..." /><a href="#" id="statusbtn" data-toggle="tooltip" data-title="<?= _('Loading complete status may take a few minutes. Be patient.') ?>"><?= _('More details') ?></a> &middot; <a href="http://<?= $opt_domain ?>:4280">PirateBox</a>
 
 <div id="status" class="alert alert-dismissible alert-info fade in" style="margin-top: 10px" role="alert">
   <button type="button" class="close"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
@@ -40,12 +40,12 @@
 
       <div class="panel panel-default">
         <div class="panel-heading">
-          <h3 class="panel-title"><?= T_("Service") ?></h3>
+          <h3 class="panel-title"><?= _("Service") ?></h3>
         </div>
 
         <div style="padding: 14px 14px 0 10px">
           <div class="form-group">
-            <label for="service_enabled" class="col-sm-3 control-label"><?= T_('PirateBox Enabled') ?></label>
+            <label for="service_enabled" class="col-sm-3 control-label"><?= _('PirateBox Enabled') ?></label>
             <div class="col-sm-9 input-group-btn">
               <div class="input-group">
                 <input type="checkbox" class="form-control switch" name="service_enabled" id="service_enabled" value="1" <?= $service_enabled == 1 ? 'checked="checked"' : '' ?> />
@@ -57,15 +57,15 @@
             <?php if($wifi_device_id == -1): ?>
               <div class="alert alert-dismissible alert-warning fade in" style="margin: 2px 16px 17px" role="alert">
                 <button type="button" class="close" data-dismiss="alert"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
-                <strong><?= T_('Notice') ?>:</strong> <?= T_("You need to select an associated hotspot.") ?>
+                <strong><?= _('Notice') ?>:</strong> <?= _("You need to select an associated hotspot.") ?>
               </div>
             <?php endif; ?>
 
-            <label for="wifi_device_id" class="col-sm-3 control-label"><?= T_('Associated Hotspot') ?></label>
+            <label for="wifi_device_id" class="col-sm-3 control-label"><?= _('Associated Hotspot') ?></label>
             <div class="col-sm-9 input-group-btn">
               <div class="input-group">
                   <input type="text" name="wifi_device_id" id="wifi_device_id" value="<?= $wifi_device_id ?>" style="display: none" />
-                  <button type="button" class="btn btn-default dropdown-toggle" data-toggle="dropdown"><?= empty($wifi_ssid) ? '<em>'.T_("None").'</em>' : $wifi_ssid ?> <span class="caret"></span></button>
+                  <button type="button" class="btn btn-default dropdown-toggle" data-toggle="dropdown"><?= empty($wifi_ssid) ? '<em>'._("None").'</em>' : $wifi_ssid ?> <span class="caret"></span></button>
                   <ul class="dropdown-menu dropdown-menu-left" id="deviceidlist" role="menu">
                     <?= $wifi_ssid_list ?>
                   </ul>
@@ -77,19 +77,19 @@
 
       <div class="panel panel-default enabled" <?= $service_enabled == 0 ? 'style="display: none"' : '' ?>>
         <div class="panel-heading">
-          <h3 class="panel-title"><?= T_("PirateBox") ?></h3>
+          <h3 class="panel-title"><?= _("PirateBox") ?></h3>
         </div>
 
         <div style="padding: 14px 14px 0 10px">
           <div class="form-group">
-            <label for="opt_name" class="col-sm-3 control-label"><?= T_('Name') ?></label>
+            <label for="opt_name" class="col-sm-3 control-label"><?= _('Name') ?></label>
             <div class="col-sm-9">
               <input type="text" class="form-control" name="opt_name" id="opt_name" placeholder="PirateBox" value="<?= htmlentities($opt_name) ?>" />
             </div>
           </div>
 
           <div class="form-group">
-            <label for="opt_renaming" class="col-sm-3 control-label"><?= T_('Renaming Allowed') ?></label>
+            <label for="opt_renaming" class="col-sm-3 control-label"><?= _('Renaming Allowed') ?></label>
             <div class="col-sm-9 input-group-btn">
               <div class="input-group">
                 <input type="checkbox" class="form-control switch" name="opt_renaming" id="opt_renaming" value="1" <?= $opt_renaming == 1 ? 'checked="checked"' : '' ?> />
@@ -98,7 +98,7 @@
           </div>
 
           <div class="form-group">
-            <label for="opt_deleting" class="col-sm-3 control-label"><?= T_('Deleting Allowed') ?></label>
+            <label for="opt_deleting" class="col-sm-3 control-label"><?= _('Deleting Allowed') ?></label>
             <div class="col-sm-9 input-group-btn">
               <div class="input-group">
                 <input type="checkbox" class="form-control switch" name="opt_deleting" id="opt_deleting" value="1" <?= $opt_deleting == 1 ? 'checked="checked"' : '' ?> />
@@ -107,7 +107,7 @@
           </div>
 
           <div class="form-group">
-            <label for="opt_chat" class="col-sm-3 control-label"><?= T_('Chat Enabled') ?></label>
+            <label for="opt_chat" class="col-sm-3 control-label"><?= _('Chat Enabled') ?></label>
             <div class="col-sm-9 input-group-btn">
               <div class="input-group">
                 <input type="checkbox" class="form-control switch" name="opt_chat" id="opt_chat" value="1" <?= $opt_chat == 1 ? 'checked="checked"' : '' ?> />
@@ -119,7 +119,7 @@
 
       <div class="form-group">
         <div style="text-align: center">
-          <button type="submit" class="btn btn-default" data-toggle="tooltip" id="save" data-title="<?= T_('Reloading may take a few minutes. Be patient.') ?>"><?= T_('Save and reload') ?></button> <img src="public/img/loading.gif" id="save-loading" alt="Loading..." />
+          <button type="submit" class="btn btn-default" data-toggle="tooltip" id="save" data-title="<?= _('Reloading may take a few minutes. Be patient.') ?>"><?= _('Save and reload') ?></button> <img src="public/img/loading.gif" id="save-loading" alt="Loading..." />
         </div>
       </div>
     </form>