xbright’s world - Programmation et bidouillages

Internationaliser votre application PHP avec gettext

xbright — Sun, 08 Jun 2008 22:54:00 +0400

Développer une application, c'est bien. La distribuer où l'utiliser, c'est mieux. Cependant, tout le monde ne parle pas votre langue, d'où l'intérêt de l'internationaliser (et paf, une introduction toute pourrie \o/). Dans ce billet, je vous présenterai donc comment j'utilise gettext dans CodingTeam, afin de traduire l'application.

Traduire une application se fait généralement à l'aide d'outils dédiés comme gettext. Vous écrivez votre code en mettant tous vos textes traduisibles d'une certaine manière et il va aller les chercher pour en faire un fichier modèle (pot), qui servira ensuite à générer des fichiers de langue (po).
En PHP et comme dans beaucoup d'autres langages, il y a déjà quelque chose de tout préparé, ce qui permet de l'utiliser directement, sans rien installer d'autre.

Ma façon d'utiliser gettext est inspirée de la lecture de bon nombre d'articles sur le net. En gros, j'utilise ce code pour charger gettext :

setlocale(LC_ALL, $lang.'.UTF-8');

bindtextdomain('nomdedomaine', 'i18n');
textdomain('nomdedomaine');
bind_textdomain_codeset('nomdedomaine', 'UTF-8');

Dans cet exemple, $lang doit valoir quelque chose comme en_GB ou fr_FR et nomdedomaine devrait être le nom de votre application.
Dans le répertoire i18n, il devrait se trouver un dossier fr_FR contenant un autre dossier LC_MESSAGES qui accueillera le binaire produit par gettext (mo).

De même, on peut faire en sorte que la langue soit enregistrée par l'utilisateur, donnée dans l'URL, lue depuis l'en-tête adéquate... Voilà une manière assez rapide^Wmoche et ne respectant pas les spécifications, de se baser sur la langue du navigateur :

$langlist = array('fr' => 'fr_FR', 'en' => 'en_GB');
$accept_language = explode(',', $_SERVER['HTTP_ACCEPT_LANGUAGE']);

foreach ($accept_language as $value) 
{
    $choice = mb_substr($value, 0, 2); 

    if (array_key_exists($choice, $langlist))
    {
           $lang = $langlist[$choice];
            break;
    }

}

if (empty($lang))
    $lang = 'en_GB';

À noter qu'il n'y a pas besoin de générer de .po/.mo pour la langue dans laquelle vous écrivez vos textes au sein de votre application vu qu'ils sont chargés par défaut si gettext n'arrive pas à trouver les traductions qui vont bien.

Pour créer le modèle, j'utilise ce script, qui est bien sûr adaptable. Dès que j'ai créé le .pot, je peux lancer cet autre script qui va me créer le fichier de traduction pour la langue que je désire. Une fois que j'ai traduit toutes les chaines, il me reste à lancer ce dernier script pour générer le binaire !

C'est là qu'on arrive au point relativement intéressant de ce billet (l'avant-ici a des airs de déjà-vu). J'ai toujours utilisé la fonction _() ou gettext() couplée à sprintf() afin de remplacer des éléments par d'autres. Exemple, si je veux traduire « Toto a mangé 4 bananes », j'écris : sprintf(_('Toto a mangé %d bananes'), 4); jusqu'au jour où je me suis rendu compte que si je voulais insérer plusieurs éléments dans la chaine tout en les nommant (afin de pouvoir changer leur ordre), j'allais au devant d'une syntaxe affreuse, repoussante, ~~typiquement-php,~~ à jeter par la fenêtre : sprintf(_('Le %2$s achète %1$d bananes.'), 42, 'monsieur'); !
%2$s, %1$s ! Mais qui est allé pondre cette horreur ?

Nostalgique de la façon bien plus propre de remplacer des occurrences dans des chaines en Python, j'ai donc écrit cette fonction, que je vous partage. Et j'espère qu'elle vous sera utile. En tout cas, c'est bien plus facile de ne pas se tromper, le traducteur a en face de lui quelque chose qui a une signification et ça ne fait pas tâche.

/**
 * Translate a string and add arguments
 *
 * Gets the translated string from gettext and add arguments in it with
 * the Python way instead of the *ugly* PHP way (sprintf).
 *
 * @param $str
 *   The string to be translated.
 * @param $args
 *   All arguments to be added.
 * @return
 *   The translated and formatted string.
 */
function i18n($str, $args=array())
{
    // Get the translated string
    $str = gettext($str);

    // Add arguments to the string if exist
    if (count($args) > 0)
        // Fetching all arguments
        foreach ($args as $key => $value)
        {
            // Decimal value
            if (is_numeric($value))
                $type = 'd';
            // String value
            elseif (is_string($value))
                $type = 's';

            // Replace
            $str = str_replace('%('.$key.')'.$type, $value, $str);
        }

    // Return the translated string with arguments
    return $str;
}

Code Bar : nouvelle édition du bar virtuel \o/

xbright — Sat, 19 Apr 2008 23:01:00 +0400

Comme Omega l'a anoncé il y a quelques jours, le Code Bar va de nouveau avoir lieu sur le salon programmation@chat.jabberfr.org du samedi 26 avril au dimanche 27 avril 2008, de 12 heures UTC à 12 heures UTC (ça donne 14 heures à Paris et 16 heures dans des contrées plus accueillantes).

Pour ceux qui ne connaissent pas le principe de cette rencontre virtuelle, une page de wiki a été mise en place : http://trac.last-exile.org/code_bar/. Le but est donc de se rencontrer sur le salon Jabber francophone dédié à la programmation, de découvrir des (nouvelles ?) choses via les cours d'Emacs Lisp ou de Haskell et de travailler ensemble sur des petits projets libres. Cette fois ci, sont retenus un moteur de MUD sous forme de composant Jabber, un RandomChat (un truc séduisant pour que les djeunz pensent faire des rencontres anonymes tout en parlant à leur voisin, satyre et pervers sexuel à ses heures perdues) ainsi qu'un certain Zadolbator (un composant Jabber qui envoie des notifications et qui, accessoirement, possède un nom imprononçable).

De toute évidence, ce Code Bar est encore très axé sur les technologies liées à Jabber, on rappelle que le projet phare de la première édition du Code Bar était Gajim (et non pas CodingTeam, malheureusement ;'(). On remarque aussi que 2 projets sur 3 sont aussi des projets en Python, alors que le composant-au-nom-bizarre, lui, est en Ruby.
Et, si les fans de Jabber se sentaient encore un peu lésés, il y a aura même Nÿco qui vantera la contribution sur le wiki de JabberFR.org (rien n'est encore sûr) !

Bien entendu, vous n'êtes pas obligé de venir pour faire le tour de la pendule, il n'y a pas vraiment d'obligations à ce niveau (même si d'un point de vue organisationnel, notamment pour les cours - qui auront lieux à des heures fixes, c'est mieux d'arriver plutot tôt que tard). Si vous n'avez pas encore de client Jabber, installez-en un.
Pour ceux qui n'ont pas de compte Jabber, il existe aussi une interface web pour se connecter au salon : http://chat.jabberfr.org/muckl_int/index.php?room=programmation !

Le programme pour ce prochain Code Bar est donc bien rempli et n'attends plus que les patcheurs/codeurs fous que vous êtes et qui n'attendent qu'un peu de projets exotiques pour vous lancer. Alors, à samedi \o_

Mon petit compte rendu de ce premier Code Bar.

xbright — Sun, 03 Jun 2007 07:39:00 +0400

Depuis hier après midi jusqu'à aujourd'hui, se tenait la première édition du Code Bar sur Jabber !

Tout comme l'avait préparé les organisateurs Omega et Elghinn sur le salon programmation@chat.jabberfr.org. Cette soirée (nuit ?) s'est donc déroulée dans la bonne humeur et a été productive.

Voilà un log de tous les commit effectués sur le SVN de l'occasion (deux projets étaient proposés pour cette première édition : Gajim et CodingTeam). Il y en a eu plus d'une cinquantaine, pour - au mieux de la soirée - une vingtaine de connectés au salon, dont seulement 7 avaient un accès en écriture au dépôt SVN.

Concernant Gajim, les principaux développements ont été l'amélioration du support de PEP, des travaux divers sur le trunk où encore - j'y ai un peu participé - sur une branche à part nommée chat2muc : pour transformer un chat normal en salon de discussion, XEP-0045). Bien entendu, nous n'avons pas terminé cette intégration, et nous la continuons sur le salon gajim-chat2muc@conference.codingteam.net !

CodingTeam a bénéficié de l'aide de quelques uns aussi via le dépôt mis en place pour l'occasion sur le serveur de Elghinn.
Ainsi, l'intégration Jabber dans la forge a été travaillée et j'ai synchronisé le travail effectué avec le trunk officiel !

Historiques des salons :

Merci donc à tous les participants pour le coup de pouce aux projets ;-)

Une soirée coding ouverte à tous !

xbright — Wed, 23 May 2007 18:16:00 +0400

Le samedi 2 juin, sera organisé une soirée coding sur Jabber !

En effet, sur le salon programmation@chat.jabberfr.org l'après midi et la soirée (voire la nuit, plutôt) seront consacrées à la programmation.

La tête d'affiche pour cette première édition : Gajim ! Ainsi, le principal objectif est la correction de bug ainsi que l'implémentation de nouvelles fonctionnalités dans Gajim. D'ailleurs, le développeur principal, Asterix, sera présent ce soir !

Voici les objectifs que l'on peut trouver sur le wiki :

Implémentation de PEP (http://www.xmpp.org/extensions/xep-0163.html) notamment pour l'affichage de la musique en cours
Ajout des groupes en « cascade » (nested groups) dans le roster (http://www.xmpp.org/extensions/xep-0083.html et http://trac.gajim.org/ticket/1381)

Pour ceux qui n'aiment pas Python, ou qui n'aiment pas Gajim, d'autres projets pourront être abordés ce soir là, comme indiqué sur le wiki :

Intégrer Jabber dans CodingTeam (forge codée en PHP)

Donc, si l'envie vous en prend, vous pourrez même donner un petit coup de main à CodingTeam :-)
Le Roi de la pluie en parle !

Compter les utilisateurs connectés et enregistrés avec ejabberd

xbright — Sun, 20 May 2007 15:16:00 +0400

Eh bien, voilà un billet un peu technique, ça manquait !

La problématique est la suivante : on a installé un serveur Jabber ejabberd (au passage, c'est une grossière erreur, ce serveur est en ERLANG, et j'me rend compte après coup que j'y suis allergique) sans se prendre la tête. Donc, ce ejabberd a décidé d'utiliser la base de données mnesia (un truc inconnu qui est un pote à ERLANG, justement).

Alors, je vous laisse chercher longtemps pour faire une requette PHP là dedans...

Heureusement, je suis tombé sur un truc formidable, tout à l'heure : mod_ctlextra, en faisant une n-ième recherche sur leur site officiel.

Bref, ce module ajoute pleins de fonctions inutiles, dont :

stats registeredusers number of registered users
stats onlineusers number of logged users

De plus, l'installation a été très simple sur lanoiraude :

On commence par se placer dans un répertoire qui servira pour récupérer la copie courante de ce module.

svn co https://svn.process-one.net/ejabberd-modules

Ensuite, on va dans le répertoire de ce module :

cd ejabberd-modules/mod_ctlextra/trunk

On va construire le bidule :

./build.sh

Ensuite, dans le dossier ebin, on tombe sur le fichier intéressant mod_ctlextra.beam ! On le met dans /var/lib/ejabberd et il n'y a plus qu'à ajouter ça au ejabberd.cfg :

  {mod_ctlextra, []},

(Oui, Jérémy, cette syntaxe de malade, c'est du ERLANG !)

Et voilà, il ne nous reste plus qu'à redémarrer le serveur pour bénéficier de ces nouvelles commandes ultra pratiques !
Ensuite, un petit peu de Python, un petit tour dans crontab et on obtient ça : stat.txt ! _o/

Créer des fils RSS avec mise en cache

xbright — Fri, 06 Apr 2007 14:19:00 +0400

Voilà un petit script que j'ai codé pour CodingTeam et qui peut être utile; c'est pourquoi je le met à disposition.

Les fils RSS sont à la mode en ce moment et permettent, depuis un aggrégateur, d'obtenir les dernières actualités d'autant de sites que l'on désire.
En plus, c'est très simple de générer un fil de ce type en PHP (là ou ça se corse un peu c'est pour convertir une date d/m/Y et une heure H:i:s en RFC822).

Commencez par mettre ce code entre les <head></head> de la page proposant l'abonnement :

<link rel="alternate" type="application/rss+xml" title="RSS 2.0" href="rss.php" />

Dans le répertoire où se trouve ce script, vous devez aussi avoir un dossier /cache en chmod 777 afin que l'application puisse y écrire.
Pour renouveller le cache, il suffit d'ajouter dans votre code (par exemple, lorsqu'un nouvel article est posté) :

<?php
     unlink("cache/cache-rss.php");
?>

Le script de base du cache a été trouvé sur WebRankInfo et je l'ai adapté à la situation : Mise en cache des pages PHP !

Le voici dans sa version originale :

<?php
$urldemandee=$_SERVER['REQUEST_URI'];
$urldemandee=ereg_replace('/','-',$urldemandee);
$fichierCache="cache/cache".$urldemandee;
if (@filemtime($fichierCache)<time()-(3600*24*360)) {
   ob_start(); 

header("Content-Type: text/xml;charset=utf-8");
require_once("../include/config.inc.php");
require_once("../include/bbcode.inc.php");


echo '<rss version="2.0">
<channel>
<title>CodingTeam - Forum</title>
<link>http://www.codingteam.net</link>
<description>Les derniers messages postés dans le forum.</description>
<language>fr-FR</language>
';

  $sql = mysql_query("SELECT * FROM forum_sujet ORDER BY id DESC LIMIT 5") or die (mysql_error());
  while ($row = mysql_fetch_array($sql))
    {
$dd = explode('/',$row['date']);
$dc = explode(':',$row['heure']);

echo '
<item>
<title>'.utf8_encode($row['titre']).'</title>
<link>'.$racine.'/forumvoir,'.$row['cat'].','.$row['id'].'.html</link>
<pubDate>'.date(DATE_RFC822, mktime($dc[0], $dc[1], $dc[2], $dd[1], $dd[0], $dd[2])).'</pubDate>
<description>'.htmlentities(bb_parse($row['message'])).'</description>
<author>'.$row['auteur'].'</author>
</item>
';
    }

echo '
</channel>
</rss>';

   $contenuCache = ob_get_contents();
   ob_end_flush();
   $fd = fopen($fichierCache, "w");
   if ($fd) {
      fwrite($fd,$contenuCache);
      fclose($fd);
     }
} else {
  include ($fichierCache);
}
?>

Créer des dépôts facilement sur un serveur SVN

xbright — Wed, 21 Mar 2007 13:14:00 +0400

Deux petits scripts très pratique pour ajouter des dépôts sur votre serveur Subversion et pour ajouter des utilisateurs en écriture, par la suite.

Ce sont les scripts utilisés pour le serveur de CodingTeam !

Pour installer Subversion sur ma Debian, je n'ai eu qu'à faire :

apt-get install libapache2-svn subversion subversion-tools

Pour ajouter un dépôt à mon serveur SVN, voici le script (très facilement modifiable pour votre utilisation) :

#!/usr/bin/env python
# -*- coding: UTF8 -*-

###
#
# svn-create.py is the legal property of Erwan Briand <xbright2005@gmail.com>
# Copyright (c) 2007 Erwan Briand
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 as
# published by the Free Software Foundation
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#
###

import os

base = "http://svn.codingteam.net"
svn_repository = "/var/www/code/"
svn_msg = "[CodingTeam] Subversion : "
svn_suffix = "/src"
apache_config = "/etc/apache2/projectalias.conf"

print "#################################################"
print "Créer un dépôt SVN sur CodingTeam"
print "#################################################"

try:
        nom_projet = raw_input("Nom du projet : ")

        ## Création du projet
        os.system("mkdir " + svn_repository + nom_projet)
        os.system("chown www-data " + svn_repository + nom_projet)
        os.system(" su www-data -c \"svnadmin create " + svn_repository + nom_projet + svn_suffix + "\" ")
        print "\nCréation du projet\t\t\t\t[OK]"

        ## Configuration du serveur
        file = open(apache_config,"a")
        file.write("##### Serveur pour " + nom_projet + "\n")
        file.write("<Location /code/" + nom_projet + ">\n")
        file.write("  DAV svn\n")
        file.write("  DavDepthInfinity on\n")
        file.write("  SVNPath " + svn_repository + nom_projet + svn_suffix + "\n")
        file.write("  AuthType Basic\n")
        file.write("  AuthName \"" + svn_msg + nom_projet + "\"\n")
        file.write("  AuthUserFile "+ svn_repository + nom_projet +"/.dav_svn.passwd\n")
        file.write("  <LimitExcept GET PROPFIND OPTIONS REPORT>\n")
        file.write("    Require valid-user\n")
        file.write("  </LimitExcept>\n")
        file.write("</Location>\n\n")
        file.close()
        print "\nConfiguration du serveur (VirtualHost)\t\t[OK]"

        ## Ajout des droits
        admin_projet = raw_input("\nNom de l'administrateur : ")
        os.system(" su www-data -c \"htpasswd2 -c -m "+ svn_repository + nom_projet +"/.dav_svn.passwd " + admin_projet + "\" ")
        #print "Pour ajouter des droits par la suite, il faudra exécuter cette commande :"
        #print "=>\tsu www-data -c \"htpasswd2 -m "+ svn_repository + nom_projet +"/.dav_svn.passwd user\" "
        print "\nAjout des droits\t\t\t\t[OK]"

        ## Redémarrage du serveur Apache
        print ""
        os.system("/etc/init.d/apache2 force-reload")
        print "\nRedémarrage du serveur\t\t\t\t[OK]"

        print "\n\n"
        print "Dépôt Subversion\t\t\t[Créé]"
        print "Nom du serveur\t\t\t\t" + nom_projet
        print "Nom de l'administrateur\t\t\t" + admin_projet
        print "Adresse du dépôt\t\t\t" + base + "/" + nom_projet
        print "\nTravail effectué."

except:
        print "\nErreur ! Abandon."

Enfin, pour ajouter un utilisateur en écriture à un dépôt :

#!/usr/bin/env python
# -*- coding: UTF8 -*-

###
#
# svn-adduser.py is the legal property of Erwan Briand <xbright2005@gmail.com>
# Copyright (c) 2007 Erwan Briand
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 as
# published by the Free Software Foundation
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#
###

import os

svn_repository = "/var/www/code/"

print "#################################################"
print "Ajouter un utilisateur à un dépôt SVN"
print "#################################################"

try:
    nom_projet = raw_input("Nom du projet : ")

    if os.path.isdir(svn_repository + nom_projet) == False:
        print "\nErreur ! Abandon."
    else:

        ## Ajout des droits
        admin_projet = raw_input("\nNom de l'utilisateur : ")
        os.system(" su www-data -c \"htpasswd2 -m "+ svn_repository + nom_projet +"/.dav_svn.passwd " + admin_projet + "\" ")
        print "\nAjout des droits\t\t\t\t[OK]"
    
        print "\n\n"
        print "Dépôt Subversion\t\t\t[Modifié]"
        print "Nom du dépôt\t\t\t\t" + nom_projet
        print "Nouvel utilisateur\t\t\t" + admin_projet
        print "\nTravail effectué."

except:
    print "\nErreur ! Abandon."

Voilà, en espérant que ces scripts puissent vous servir ;)

En effet, j'ai eu du mal à trouver de la bonne doc pour administrer un serveur Subversion et ces scripts me permettent en fait d'optimiser ce très bon How To : Subversion in Debian !