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

Last change on this file since 119832 was 119832, checked in by Cerdic, 2 years ago

factorisation de code et renommage variable

  • Property svn:eol-style set to native
File size: 13.8 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                if (!isset($GLOBALS['idx_lang'])){
80                        $GLOBALS['idx_lang'] = 0;
81                }
82
83                // verifications des repertoires
84                foreach ([_DIR_SALVATORE, _DIR_SALVATORE_TRADUCTIONS, _DIR_SALVATORE_MODULES, _DIR_SALVATORE_DEPOTS, _DIR_SALVATORE_TMP] as $dir){
85                        salvatore_check_dir($dir);
86                }
87                $initialized = true;
88        }
89}
90
91
92/**
93 * chargement du fichier traductions.txt
94 * Construit une liste de modules avec pour chacun un tableau associatif
95 *
96 * @param string $fichier_traductions
97 * @return array
98 * @throws Exception
99 */
100function salvatore_charger_fichier_traductions($fichier_traductions = null){
101
102        salvatore_init();
103        if (is_null($fichier_traductions)){
104                $fichier_traductions = _DIR_SALVATORE_TRADUCTIONS . 'traductions.txt';
105        }
106        salvatore_check_file($fichier_traductions);
107
108        $lignes = file($fichier_traductions);
109        $lignes = array_map('trim', $lignes);
110        $lignes = array_filter($lignes);
111
112        $liste_trad = array();
113        foreach ($lignes as $ligne){
114                if ($ligne[0]!=='#'){
115                        $liste = explode(';', trim($ligne));
116                        $methode = $url = $branche = $dir = $module = $lang = '';
117
118                        // deprecated ancien format, forcement en svn
119                        // liste courte de type
120                        // url;module;lang
121                        if (count($liste)<=3){
122                                $methode = 'svn';
123                                $branche = '';
124                                $url = $liste[0];
125                                if (empty($liste[1])){
126                                        $module = preg_replace('#.*/(.*)$#', '$1', $url);
127                                } else {
128                                        $module = $liste[1];
129                                }
130                                if (empty($liste[2])){
131                                        $lang = 'fr';
132                                } else {
133                                        $lang = $liste[2];
134                                }
135                        }
136                        // format complet et explicite de 6 valeurs
137                        // seule les valeurs pour branche et dir peuvent etre vide (branche master par defaut en git)
138                        // svn;url;;;module;lang
139                        // git;url;master;subdir/tolang;module;lang
140                        else {
141                                list($methode, $url, $branche, $dir, $module, $lang) = $liste;
142                        }
143                        $methode = trim($methode);
144                        $url = trim($url);
145                        $url = rtrim($url, '/'); // homogeneiser
146                        $dir = trim($dir);
147                        $dir = trim($dir, '/'); // homogeneiser
148                        $branche = trim($branche);
149                        $module = trim($module);
150                        $lang = trim($lang);
151
152                        if ($methode
153                                and $url
154                                and $module
155                                and $lang){
156                                // que fait la $GLOBALS['modules'] ?
157                                if (empty($GLOBALS['modules']) or in_array($module, $GLOBALS['modules'])){
158                                        // definir un dir checkout unique meme si plusieurs modules de meme nom dans differents repos
159                                        $d = explode('/', $url);
160                                        while (count($d) and in_array(end($d), ['', 'lang', 'trunk', 'ecrire'])){
161                                                array_pop($d);
162                                        }
163                                        $source = '';
164                                        if (end($d)){
165                                                $source = basename(end($d), '.git');
166                                                $source = '--' . preg_replace(',[^\w-],', '_', $source);
167                                        }
168                                        $dir_module = "{$module}{$source}-" . substr(md5("$methode:$url:$branche:$dir"), 0, 5);
169                                        $dir_checkout = preg_replace(",\W+,", "-", "$methode-$url") . ($branche ? "--$branche-" : "-") . substr(md5("$methode:$url:$branche"), 0, 5);
170
171                                        $liste_trad[] = [
172                                                'methode' => $methode,
173                                                'url' => $url,
174                                                'branche' => $branche,
175                                                'dir' => $dir,
176                                                'module' => $module,
177                                                'lang' => $lang,
178                                                'dir_module' => $dir_module,
179                                                'dir_checkout' => $dir_checkout,
180                                        ];
181                                }
182                        } else {
183                                salvatore_log("Fichier $fichier_traductions, IGNORE ligne incomplete : $ligne");
184                        }
185                }
186        }
187        return $liste_trad;
188}
189
190/**
191 * Extraire la lang d'un fichier de langue d'un module donne
192 * @param string $module
193 * @param string $fichier_lang
194 * @return array|mixed|string|string[]
195 */
196function salvatore_get_lang_from($module, $fichier_lang) {
197        $lang = str_replace($module, '__', basename($fichier_lang, '.php'));
198        $lang = explode('___', $lang, 2);
199        $lang = end($lang);
200
201        return $lang;
202}
203
204/**
205 * URL du gestionnaire trad-lang exportee dans les xml
206 * @return mixed
207 */
208function salvatore_get_self_url() {
209        $url_gestionnaire = $GLOBALS['meta']['adresse_site'];
210        if (defined('_SALVATORE_TEST_URL_GESTIONNAIRE')) {
211                $url_gestionnaire = _SALVATORE_TEST_URL_GESTIONNAIRE;
212        }
213        return $url_gestionnaire;
214}
215
216/**
217 * Verifier si un module de langue est gere par ce salvatore
218 * @param $dir_module
219 * @param $module
220 * @return string
221 *   l'autre gestionnaire de trad si c'est pas nous
222 *   chaine vide si c'est bien nous qui gerons
223 */
224function salvatore_verifier_gestionnaire_traduction($dir_module, $module) {
225
226        /**
227         * On teste ici si le fichier est géré par un autre salvatore
228         * Si oui on empeche son import en le signifiant
229         */
230        if ($t = salvatore_lire_gestionnaire_traduction($dir_module, $module)){
231                $url = extraire_attribut($t, 'url');
232                $gestionnaire = extraire_attribut($t, 'gestionnaire');
233                $url_gestionnaire = salvatore_get_self_url();
234                if ($gestionnaire !== 'salvatore'
235                  or protocole_implicite($url) !== protocole_implicite($url_gestionnaire)) {
236                        return "$gestionnaire@$url";
237                }
238        }
239
240        return '';
241}
242
243/**
244 * Lire la balise <traduction> du fichier .xml
245 * @param string $dir_module
246 * @param string $module
247 * @return string
248 */
249function salvatore_lire_gestionnaire_traduction($dir_module, $module) {
250        $xml_file = $dir_module . '/' . $module . '.xml';
251        /**
252         * On teste ici si le fichier est géré par un autre salvatore
253         * Si oui on empeche son import en le signifiant
254         */
255        if (file_exists($xml_file)){
256                $xml_content = spip_xml_load($xml_file);
257                if (is_array($xml_content)){
258                        // normalement on a qu'une balise <traduction...> englobante, donc on prend la premiere qu'on trouve
259                        if (spip_xml_match_nodes('/^traduction/', $xml_content, $matches)
260                          and $nodes = array_keys($matches)
261                          and $node = reset($nodes)) {
262                                return "<$node>";
263                        }
264                }
265        }
266        return '';
267}
268
269/**
270 * Retrouver la ligne de spip_tradlang_modules qui correspond a un dir_module/module, meme en cas de chanchement de repo (url/branches)
271 * Attention : ca veut dire que si on branche et qu'on veut traduire 2 branches d'un meme module
272 * il faut supprimer le fichier xml de la nouvelle branche pour qu'elle soit bien ajoutee a trad-lang
273 * et eviter qu'on pense que c'est un renommage
274 *
275 * @param $dir_module
276 * @param $module
277 * @return array|bool
278 */
279function salvatore_retrouver_tradlang_module($dir_module, $module) {
280        $base_dir_module = basename($dir_module);
281        if ($row_module = sql_fetsel('*', 'spip_tradlang_modules', 'dir_module = ' . sql_quote($base_dir_module))) {
282                return $row_module;
283        }
284        // peut-etre c'est un module qui a change d'url repo, et donc son dir_module a change ?
285        // TODO : ecrire dir_module dans dir=".." de la balise <traduction>
286        if ($t = salvatore_lire_gestionnaire_traduction($dir_module, $module)
287          and $old_dir_module = extraire_attribut($t, 'dir')
288          and $old_dir_module !== $base_dir_module){
289
290                if ($row_module = sql_fetsel('*', 'spip_tradlang_modules', 'dir_module = ' . sql_quote($old_dir_module))) {
291                        return $row_module;
292                }
293        }
294
295        return false;
296}
297
298/**
299 * Ajouter les credentials user/pass sur les urls de repo
300 * @param string $methode
301 * @param string $url_repository
302 * @param string $module
303 * @return string
304 */
305function salvatore_set_credentials($methode, $url_repository, $module){
306        global $domaines_exceptions, $domaines_exceptions_credentials,
307               $SVNUSER, $SVNPASSWD,
308               $GITUSER, $GITPASSWD;
309
310        // on ne sait pas mettre des credentials si c'est du ssh
311        if (strpos($url_repository, '://')!==false){
312                $user = $pass = false;
313                $parts = parse_url($url_repository);
314                if (empty($parts['user']) and empty($parts['pass'])){
315                        $host = $parts['host'];
316                        require_once(_DIR_ETC . 'salvatore_passwd.inc');
317
318                        if (!empty($domaines_exceptions)
319                                and is_array($domaines_exceptions)
320                                and in_array($host, $domaines_exceptions)){
321                                // on est dans une exception
322
323                                /**
324                                 * Est-ce que cette exception dispose de credentials (Github?)
325                                 */
326                                if (is_array($domaines_exceptions_credentials)
327                                        and !empty($domaines_exceptions_credentials[$host])){
328                                        $user = $domaines_exceptions_credentials[$host]['user'];
329                                        $pass = $domaines_exceptions_credentials[$host]['pass'];
330                                }
331
332                        } else {
333                                // un truc perso pour un module en particulier ?
334                                if (isset(${$module . '_user'})){
335                                        $user = ${$module . '_user'};
336                                        $pass = ${$module . '_passwd'};
337                                } elseif ($methode==='svn' and isset($SVNUSER)) {
338                                        $user = $SVNUSER;
339                                        $pass = $SVNPASSWD;
340                                } elseif ($methode==='git' and isset($GITUSER)) {
341                                        $user = $GITUSER;
342                                        $pass = $GITPASSWD;
343                                }
344                        }
345
346                        if ($user and $pass){
347                                $url_repository = str_replace("://$host", "://" . urlencode($user) . ":" . urlencode($pass) . "@$host", $url_repository);
348                        }
349                }
350
351        }
352
353        return $url_repository;
354}
355
356
357/**
358 * Verifier qu'un repertoire existe
359 * @param $dir
360 * @throws Exception
361 */
362function salvatore_check_dir($dir){
363        if (!is_dir($dir)){
364                throw new Exception("Erreur : le répertoire $dir n'existe pas");
365        }
366}
367
368/**
369 * Verifier qu'un fichier existe
370 * @param $file
371 * @throws Exception
372 */
373function salvatore_check_file($file){
374        if (!file_exists($file)){
375                throw new Exception("Erreur : Le fichier $file est introuvable");
376        }
377}
378
379/**
380 * Loger
381 * @param string $msg
382 * @param string|array $display_function
383 */
384function salvatore_log($msg = '', $display_function = null){
385        static $function = null;
386
387        if ($display_function and is_callable($display_function)){
388                $function = $display_function;
389        }
390
391        if (defined('_DEBUG_TRAD_LANG')
392                and _DEBUG_TRAD_LANG
393                and $msg){
394                if ($function){
395                        call_user_func($function, rtrim($msg));
396                } else {
397                        // fallback : utiliser echo mais enlever les balises de formatage symphony
398                        $msg = str_replace(["<info>", "</info>", "<error>", "</error>", "<comment>", "</comment>", "<question>", "</question>", "</>"], "", $msg);
399                        echo rtrim($msg) . "\n";
400                }
401        }
402}
403
404/**
405 * Echec sur erreur : on envoie un mail si possible et on echoue en lançant une exception
406 * @param $sujet
407 * @param $corps
408 * @throws Exception
409 */
410function salvatore_fail($sujet, $corps){
411        $corps = rtrim($corps) . "\n\n";
412        salvatore_envoyer_mail($sujet, $corps);
413        throw new Exception($corps);
414}
415
416/**
417 * @param string $sujet
418 * @param string $corps
419 */
420function salvatore_envoyer_mail($sujet = 'Erreur', $corps = ''){
421        if (defined('_EMAIL_ERREURS') and _EMAIL_ERREURS
422                and defined('_EMAIL_SALVATORE') and _EMAIL_SALVATORE){
423                $envoyer_mail = charger_fonction('envoyer_mail', 'inc');
424                $destinataire = _EMAIL_ERREURS;
425                $from = _EMAIL_SALVATORE;
426                $envoyer_mail($destinataire, $sujet, $corps, $from);
427                salvatore_log("Un email a été envoyé à l'adresse : " . _EMAIL_ERREURS . "\n");
428        }
429}
430
431
432/**
433 * Verifier que la base de salvatore a bien ete mise a jour
434 * pour ajouter le dir_module qui est la cle unique a la place de module
435 * lancer
436 * spip salvatore:upgrade --traductions=...
437 * avec le bon fichier de traduction pour mettre à jour la base de salvatore avant de pouvoir lancer a nouveau le lecteur ou l'ecriveur
438 */
439function salvatore_verifier_base_upgradee() {
440
441        $schema_declare = filtre_info_plugin_dist('tradlang', 'schema');
442        $schema_base = $GLOBALS['meta']['tradlang_base_version'];
443        if ($schema_base !== $schema_declare) {
444                throw new Exception("Schema de base pas a jour ($schema_base vs $schema_declare). Lancez la commande \nspip salvatore:upgrade --help");
445        }
446
447        $trouver_table = charger_fonction('trouver_table', 'base');
448        $desc = $trouver_table('spip_tradlang_modules');
449
450        // est-ce que le champ a ete cree ?
451        if (!isset($desc['field']['dir_module'])) {
452                throw new Exception("Pas de champ dir_module dans la base spip_tradlang_modules. Lancez la commande \nspip salvatore:upgrade --help");
453        }
454
455        // 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)
456        $nb = sql_countsel('spip_tradlang_modules', "dir_module='' OR dir_module=module");
457        if ($nb>0) {
458                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");
459        }
460
461}
Note: See TracBrowser for help on using the repository browser.