source: spip-zone/_plugins_/trad-lang/trunk/inc/salvatore.php @ 119847

Last change on this file since 119847 was 119847, checked in by Cerdic, 9 months ago

refactoring pousseur suite (wip)

  • Property svn:eol-style set to native
File size: 16.7 KB
Line 
1<?php
2
3/*
4    This file is part of Salvatore, the translation robot of Trad-lang (SPIP)
5
6    Salvatore is free software; you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 2 of the License, or
9    (at your option) any later version.
10
11    Trad-Lang is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15
16    You should have received a copy of the GNU General Public License
17    along with Trad-Lang; if not, write to the Free Software
18    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19
20    Copyright 2003-2013
21        Florent Jugla <florent.jugla@eledo.com>,
22        Philippe Riviere <fil@rezo.net>,
23        Chryjs <chryjs!@!free!.!fr>,
24                kent1 <kent1@arscenic.info>
25*/
26
27
28/**
29 * initialiser salvatore si besoin
30 * peut etre appelle plusieurs fois
31 * @param string|array $log_function
32 * @throws Exception
33 */
34function salvatore_init($log_function = null){
35        static $initialized;
36
37        // set log function if any
38        if ($log_function){
39                salvatore_log('', $log_function);
40        }
41
42        if (is_null($initialized)){
43                @ini_set('memory_limit', '50M');
44                if (!defined('_DEBUG_TRAD_LANG')){
45                        define('_DEBUG_TRAD_LANG', 1); // undef si on ne veut pas de messages
46                }
47
48                if (!defined('_DIR_SALVATORE')){
49                        define('_DIR_SALVATORE', _DIR_RACINE . 'salvatore/');
50                }
51
52                if (!defined('_DIR_SALVATORE_TRADUCTIONS')){
53                        define('_DIR_SALVATORE_TRADUCTIONS', _DIR_SALVATORE . 'traductions/');
54                }
55
56                if (!defined('_DIR_SALVATORE_TMP')){
57                        define('_DIR_SALVATORE_TMP', _DIR_SALVATORE . 'tmp/');
58                }
59
60                if (!defined('_DIR_SALVATORE_MODULES')){
61                        define('_DIR_SALVATORE_MODULES', _DIR_SALVATORE . 'modules/');
62                }
63
64                if (!defined('_DIR_SALVATORE_DEPOTS')){
65                        define('_DIR_SALVATORE_DEPOTS', _DIR_SALVATORE . 'depots/');
66                }
67
68                if (defined('_ID_AUTEUR_SALVATORE') and is_numeric(_ID_AUTEUR_SALVATORE)){
69                        $GLOBALS['visiteur_session'] = array();
70                        $GLOBALS['visiteur_session']['id_auteur'] = _ID_AUTEUR_SALVATORE;
71                        // TODO : charger une session complete ?
72                }
73
74                // par defaut on relit les fichiers si modifies depuis moins de 1J
75                if (!defined('_SALVATORE_LECTEUR_REFRESH_DELAY')){
76                        define('_SALVATORE_LECTEUR_REFRESH_DELAY', 24 * 3600);
77                }
78
79                // pourcentage de traduction a partir duquel on exporte la langue
80                if (!defined('_SALVATORE_SEUIL_EXPORT')) {
81                        define('_SALVATORE_SEUIL_EXPORT', 50);
82                }
83
84                if (!defined('_SALVATORE_AUTHOR_COMMITS')) {
85                        define('_SALVATORE_AUTHOR_COMMITS', 'salvatore@rezo.net');
86                }
87
88                if (!defined('_SALVATORE_SVN_PROPSET')) {
89                        define('_SALVATORE_SVN_PROPSET', true);
90                }
91
92
93                if (!isset($GLOBALS['idx_lang'])){
94                        $GLOBALS['idx_lang'] = 0;
95                }
96
97                // verifications des repertoires
98                foreach ([_DIR_SALVATORE, _DIR_SALVATORE_TRADUCTIONS, _DIR_SALVATORE_MODULES, _DIR_SALVATORE_DEPOTS, _DIR_SALVATORE_TMP] as $dir){
99                        salvatore_check_dir($dir);
100                }
101                $initialized = true;
102        }
103}
104
105
106/**
107 * chargement du fichier traductions.txt
108 * Construit une liste de modules avec pour chacun un tableau associatif
109 *
110 * @param string $fichier_traductions
111 * @return array
112 * @throws Exception
113 */
114function salvatore_charger_fichier_traductions($fichier_traductions = null){
115
116        salvatore_init();
117        if (is_null($fichier_traductions)){
118                $fichier_traductions = _DIR_SALVATORE_TRADUCTIONS . 'traductions.txt';
119        }
120        salvatore_check_file($fichier_traductions);
121
122        $lignes = file($fichier_traductions);
123        $lignes = array_map('trim', $lignes);
124        $lignes = array_filter($lignes);
125
126        $liste_trad = array();
127        foreach ($lignes as $ligne){
128                if ($ligne[0]!=='#'){
129                        $liste = explode(';', trim($ligne));
130                        $methode = $url = $branche = $dir = $module = $lang = '';
131
132                        // deprecated ancien format, forcement en svn
133                        // liste courte de type
134                        // url;module;lang
135                        if (count($liste)<=3){
136                                $methode = 'svn';
137                                $branche = '';
138                                $url = $liste[0];
139                                if (empty($liste[1])){
140                                        $module = preg_replace('#.*/(.*)$#', '$1', $url);
141                                } else {
142                                        $module = $liste[1];
143                                }
144                                if (empty($liste[2])){
145                                        $lang = 'fr';
146                                } else {
147                                        $lang = $liste[2];
148                                }
149                        }
150                        // format complet et explicite de 6 valeurs
151                        // seule les valeurs pour branche et dir peuvent etre vide (branche master par defaut en git)
152                        // svn;url;;;module;lang
153                        // git;url;master;subdir/tolang;module;lang
154                        else {
155                                list($methode, $url, $branche, $dir, $module, $lang) = $liste;
156                        }
157                        $methode = trim($methode);
158                        $url = trim($url);
159                        $url = rtrim($url, '/'); // homogeneiser
160                        $dir = trim($dir);
161                        $dir = trim($dir, '/'); // homogeneiser
162                        $branche = trim($branche);
163                        $module = trim($module);
164                        $lang = trim($lang);
165
166                        if ($methode
167                                and $url
168                                and $module
169                                and $lang){
170                                // que fait la $GLOBALS['modules'] ?
171                                if (empty($GLOBALS['modules']) or in_array($module, $GLOBALS['modules'])){
172                                        // definir un dir checkout unique meme si plusieurs modules de meme nom dans differents repos
173                                        $d = explode('/', $url);
174                                        while (count($d) and in_array(end($d), ['', 'lang', 'trunk', 'ecrire'])){
175                                                array_pop($d);
176                                        }
177                                        $source = '';
178                                        if (end($d)){
179                                                $source = basename(end($d), '.git');
180                                                $source = '--' . preg_replace(',[^\w-],', '_', $source);
181                                        }
182                                        $dir_module = "{$module}{$source}-" . substr(md5("$methode:$url:$branche:$dir"), 0, 5);
183                                        $dir_checkout = preg_replace(",\W+,", "-", "$methode-$url") . ($branche ? "--$branche-" : "-") . substr(md5("$methode:$url:$branche"), 0, 5);
184
185                                        $liste_trad[] = [
186                                                'methode' => $methode,
187                                                'url' => $url,
188                                                'branche' => $branche,
189                                                'dir' => $dir,
190                                                'module' => $module,
191                                                'lang' => $lang,
192                                                'dir_module' => $dir_module,
193                                                'dir_checkout' => $dir_checkout,
194                                        ];
195                                }
196                        } else {
197                                salvatore_log("Fichier $fichier_traductions, IGNORE ligne incomplete : $ligne");
198                        }
199                }
200        }
201        return $liste_trad;
202}
203
204/**
205 * Filtrer la liste complete pour ne garder que un ou plusieurs modules specifiques
206 * @param array $liste_trad
207 * @param string|array $modules
208 * @return array
209 */
210function salvatore_filtrer_liste_traductions($liste_trad, $modules) {
211        if (is_string($modules)) {
212                $modules = explode(',', $modules);
213        }
214        $modules = array_map('trim', $modules);
215        $liste_filtree = array();
216        foreach ($liste_trad as $trad) {
217                if (in_array($trad['module'], $modules)) {
218                        $liste_filtree[] = $trad;
219                }
220        }
221        return $liste_filtree;
222}
223
224/**
225 * Extraire la lang d'un fichier de langue d'un module donne
226 * @param string $module
227 * @param string $fichier_lang
228 * @return array|mixed|string|string[]
229 */
230function salvatore_get_lang_from($module, $fichier_lang) {
231        $lang = str_replace($module, '__', basename($fichier_lang, '.php'));
232        $lang = explode('___', $lang, 2);
233        $lang = end($lang);
234
235        return $lang;
236}
237
238/**
239 * URL du gestionnaire trad-lang exportee dans les xml
240 * @return mixed
241 */
242function salvatore_get_self_url() {
243        $url_gestionnaire = $GLOBALS['meta']['adresse_site'];
244        if (defined('_SALVATORE_TEST_URL_GESTIONNAIRE')) {
245                $url_gestionnaire = _SALVATORE_TEST_URL_GESTIONNAIRE;
246        }
247        return $url_gestionnaire;
248}
249
250/**
251 * Verifier si un module de langue est gere par ce salvatore
252 * @param $dir_module
253 * @param $module
254 * @return string
255 *   l'autre gestionnaire de trad si c'est pas nous
256 *   chaine vide si c'est bien nous qui gerons
257 */
258function salvatore_verifier_gestionnaire_traduction($dir_module, $module) {
259
260        /**
261         * On teste ici si le fichier est géré par un autre salvatore
262         * Si oui on empeche son import en le signifiant
263         */
264        if ($t = salvatore_lire_gestionnaire_traduction($dir_module, $module)){
265                $url = extraire_attribut($t, 'url');
266                $gestionnaire = extraire_attribut($t, 'gestionnaire');
267                $url_gestionnaire = salvatore_get_self_url();
268                if ($gestionnaire !== 'salvatore'
269                  or protocole_implicite($url) !== protocole_implicite($url_gestionnaire)) {
270                        return "$gestionnaire@$url";
271                }
272        }
273
274        return '';
275}
276
277/**
278 * Lire la balise <traduction> du fichier .xml
279 * @param string $dir_module
280 * @param string $module
281 * @return string
282 */
283function salvatore_lire_gestionnaire_traduction($dir_module, $module) {
284        $xml_file = $dir_module . '/' . $module . '.xml';
285        /**
286         * On teste ici si le fichier est géré par un autre salvatore
287         * Si oui on empeche son import en le signifiant
288         */
289        if (file_exists($xml_file)){
290                $xml_content = spip_xml_load($xml_file);
291                if (is_array($xml_content)){
292                        // normalement on a qu'une balise <traduction...> englobante, donc on prend la premiere qu'on trouve
293                        if (spip_xml_match_nodes('/^traduction/', $xml_content, $matches)
294                          and $nodes = array_keys($matches)
295                          and $node = reset($nodes)) {
296                                return "<$node>";
297                        }
298                }
299        }
300        return '';
301}
302
303/**
304 * Retrouver la ligne de spip_tradlang_modules qui correspond a un dir_module/module, meme en cas de chanchement de repo (url/branches)
305 * Attention : ca veut dire que si on branche et qu'on veut traduire 2 branches d'un meme module
306 * il faut supprimer le fichier xml de la nouvelle branche pour qu'elle soit bien ajoutee a trad-lang
307 * et eviter qu'on pense que c'est un renommage
308 *
309 * @param $dir_module
310 * @param $module
311 * @return array|bool
312 */
313function salvatore_retrouver_tradlang_module($dir_module, $module) {
314        $base_dir_module = basename($dir_module);
315        if ($row_module = sql_fetsel('*', 'spip_tradlang_modules', 'dir_module = ' . sql_quote($base_dir_module))) {
316                return $row_module;
317        }
318        // peut-etre c'est un module qui a change d'url repo, et donc son dir_module a change ?
319        // TODO : ecrire dir_module dans dir=".." de la balise <traduction>
320        if ($t = salvatore_lire_gestionnaire_traduction($dir_module, $module)
321          and $old_dir_module = extraire_attribut($t, 'dir')
322          and $old_dir_module !== $base_dir_module){
323
324                if ($row_module = sql_fetsel('*', 'spip_tradlang_modules', 'dir_module = ' . sql_quote($old_dir_module))) {
325                        return $row_module;
326                }
327        }
328
329        return false;
330}
331
332/**
333 * Ajouter les credentials user/pass sur les urls de repo
334 * @param string $methode
335 * @param string $url_repository
336 * @param string $module
337 * @return string
338 */
339function salvatore_set_credentials($methode, $url_repository, $module){
340        global $domaines_exceptions, $domaines_exceptions_credentials,
341               $SVNUSER, $SVNPASSWD,
342               $GITUSER, $GITPASSWD;
343
344        // on ne sait pas mettre des credentials si c'est du ssh
345        if (strpos($url_repository, '://')!==false){
346                $user = $pass = false;
347                $parts = parse_url($url_repository);
348                if (empty($parts['user']) and empty($parts['pass'])){
349                        $host = $parts['host'];
350                        require_once(_DIR_ETC . 'salvatore_passwd.inc');
351
352                        if (!empty($domaines_exceptions)
353                                and is_array($domaines_exceptions)
354                                and in_array($host, $domaines_exceptions)){
355                                // on est dans une exception
356
357                                /**
358                                 * Est-ce que cette exception dispose de credentials (Github?)
359                                 */
360                                if (is_array($domaines_exceptions_credentials)
361                                        and !empty($domaines_exceptions_credentials[$host])){
362                                        $user = $domaines_exceptions_credentials[$host]['user'];
363                                        $pass = $domaines_exceptions_credentials[$host]['pass'];
364                                }
365
366                        } else {
367                                // un truc perso pour un module en particulier ?
368                                if (isset(${$module . '_user'})){
369                                        $user = ${$module . '_user'};
370                                        $pass = ${$module . '_passwd'};
371                                } elseif ($methode==='svn' and isset($SVNUSER)) {
372                                        $user = $SVNUSER;
373                                        $pass = $SVNPASSWD;
374                                } elseif ($methode==='git' and isset($GITUSER)) {
375                                        $user = $GITUSER;
376                                        $pass = $GITPASSWD;
377                                }
378                        }
379
380                        if ($user and $pass){
381                                $url_repository = str_replace("://$host", "://" . urlencode($user) . ":" . urlencode($pass) . "@$host", $url_repository);
382                        }
383                }
384
385        }
386
387        return $url_repository;
388}
389
390
391/**
392 * Verifier qu'un repertoire existe
393 * @param $dir
394 * @throws Exception
395 */
396function salvatore_check_dir($dir){
397        if (!is_dir($dir)){
398                throw new Exception("Erreur : le répertoire $dir n'existe pas");
399        }
400}
401
402/**
403 * Verifier qu'un fichier existe
404 * @param $file
405 * @throws Exception
406 */
407function salvatore_check_file($file){
408        if (!file_exists($file)){
409                throw new Exception("Erreur : Le fichier $file est introuvable");
410        }
411}
412
413/**
414 * Loger
415 * @param string $msg
416 * @param string|array $display_function
417 */
418function salvatore_log($msg = '', $display_function = null){
419        static $function = null;
420
421        if ($display_function and is_callable($display_function)){
422                $function = $display_function;
423        }
424
425        if (defined('_DEBUG_TRAD_LANG')
426                and _DEBUG_TRAD_LANG
427                and $msg){
428                if ($function){
429                        call_user_func($function, rtrim($msg));
430                } else {
431                        // fallback : utiliser echo mais enlever les balises de formatage symphony
432                        $msg = str_replace(["<info>", "</info>", "<error>", "</error>", "<comment>", "</comment>", "<question>", "</question>", "</>"], "", $msg);
433                        echo rtrim($msg) . "\n";
434                }
435        }
436}
437
438/**
439 * Echec sur erreur : on envoie un mail si possible et on echoue en lançant une exception
440 * @param $sujet
441 * @param $corps
442 * @throws Exception
443 */
444function salvatore_fail($sujet, $corps){
445        $corps = rtrim($corps) . "\n\n";
446        salvatore_envoyer_mail($sujet, $corps);
447        throw new Exception($corps);
448}
449
450/**
451 * @param string $sujet
452 * @param string $corps
453 */
454function salvatore_envoyer_mail($sujet = 'Erreur', $corps = ''){
455        if (defined('_EMAIL_ERREURS') and _EMAIL_ERREURS
456                and defined('_EMAIL_SALVATORE') and _EMAIL_SALVATORE){
457                $envoyer_mail = charger_fonction('envoyer_mail', 'inc');
458                $destinataire = _EMAIL_ERREURS;
459                $from = _EMAIL_SALVATORE;
460                $envoyer_mail($destinataire, $sujet, $corps, $from);
461                salvatore_log("Un email a été envoyé à l'adresse : " . _EMAIL_ERREURS . "\n");
462        }
463}
464
465
466/**
467 * Verifier que la base de salvatore a bien ete mise a jour
468 * pour ajouter le dir_module qui est la cle unique a la place de module
469 * lancer
470 * spip salvatore:upgrade --traductions=...
471 * avec le bon fichier de traduction pour mettre à jour la base de salvatore avant de pouvoir lancer a nouveau le lecteur ou l'ecriveur
472 */
473function salvatore_verifier_base_upgradee() {
474
475        $schema_declare = filtre_info_plugin_dist('tradlang', 'schema');
476        $schema_base = $GLOBALS['meta']['tradlang_base_version'];
477        if ($schema_base !== $schema_declare) {
478                throw new Exception("Schema de base pas a jour ($schema_base vs $schema_declare). Lancez la commande \nspip salvatore:upgrade --help");
479        }
480
481        $trouver_table = charger_fonction('trouver_table', 'base');
482        $desc = $trouver_table('spip_tradlang_modules');
483
484        // est-ce que le champ a ete cree ?
485        if (!isset($desc['field']['dir_module'])) {
486                throw new Exception("Pas de champ dir_module dans la base spip_tradlang_modules. Lancez la commande \nspip salvatore:upgrade --help");
487        }
488
489        // est-ce que tous les modules en base on bien eu un dir_module affecte (et ni vide ni =module qui est la valeur par defaut lors de l'upgrade de base)
490        $nb = sql_countsel('spip_tradlang_modules', "dir_module='' OR dir_module=module");
491        if ($nb>0) {
492                throw new Exception("Le champ dir_module de spip_tradlang_modules n'est pas renseigne pour tous les modules. Lancez la commande \nspip salvatore:upgrade --help");
493        }
494
495}
496
497/**
498 * Nettoyer la chaine de langue (venant du fichier PHP en lecture ou de la base en ecriture)
499 * @param string $chaine
500 * @param string $lang
501 * @return string
502 */
503function salvatore_nettoyer_chaine_langue($chaine, $lang){
504        static $typographie_functions = array();
505
506        if (!isset($typographie_functions[$lang])){
507                $typo = (in_array($lang, array('eo', 'fr', 'cpf')) || strncmp($lang, 'fr_', 3)==0) ? 'fr' : 'en';
508                $typographie_functions[$lang] = charger_fonction($typo, 'typographie');
509        }
510
511        /**
512         * On enlève les sauts de lignes windows pour des sauts de ligne linux
513         */
514
515        $chaine = str_replace("\r\n", "\n", $chaine);
516
517        /**
518         * protection dans les balises genre <a href="..." ou <img src="..."
519         * cf inc/filtres
520         */
521        if (preg_match_all(_TYPO_BALISE, $chaine, $regs, PREG_SET_ORDER)){
522                foreach ($regs as $reg){
523                        $insert = $reg[0];
524                        // hack: on transforme les caracteres a proteger en les remplacant
525                        // par des caracteres "illegaux". (cf corriger_caracteres())
526                        $insert = strtr($insert, _TYPO_PROTEGER, _TYPO_PROTECTEUR);
527                        $chaine = str_replace($reg[0], $insert, $chaine);
528                }
529        }
530
531        /**
532         * Protéger le contenu des balises <html> <code> <cadre> <frame> <tt> <pre>
533         */
534        define('_PROTEGE_BLOCS_HTML', ',<(html|code|cadre|pre|tt)(\s[^>]*)?>(.*)</\1>,UimsS');
535        if ((strpos($chaine, '<')!==false) and preg_match_all(_PROTEGE_BLOCS_HTML, $chaine, $matches, PREG_SET_ORDER)){
536                foreach ($matches as $reg){
537                        $insert = $reg[0];
538                        // hack: on transforme les caracteres a proteger en les remplacant
539                        // par des caracteres "illegaux". (cf corriger_caracteres())
540                        $insert = strtr($insert, _TYPO_PROTEGER, _TYPO_PROTECTEUR);
541                        $chaine = str_replace($reg[0], $insert, $chaine);
542                }
543        }
544
545        /**
546         * On applique la typographie de la langue
547         */
548        $chaine = $typographie_functions[$lang]($chaine);
549
550        /**
551         * On remet les caractères normaux sur les caractères illégaux
552         */
553        $chaine = strtr($chaine, _TYPO_PROTECTEUR, _TYPO_PROTEGER);
554
555        $chaine = unicode_to_utf_8(html_entity_decode(preg_replace('/&([lg]t;)/S', '&amp;\1', $chaine), ENT_NOQUOTES, 'utf-8'));
556
557        return $chaine;
558}
Note: See TracBrowser for help on using the repository browser.