source: spip-zone/_plugins_/trad-lang/trunk/inc/salvatore_ecriveur.php @ 119837

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

fin refactoring ecriveur pour support git/svn/multimodules, a debug

  • Property svn:eol-style set to native
File size: 17.3 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-2020
21        Florent Jugla <florent.jugla@eledo.com>,
22        Philippe Riviere <fil@rezo.net>,
23        Chryjs <chryjs!@!free!.!fr>,
24        kent1 <kent1@arscenic.info>
25        Cerdic <cedric@yterium.com>
26*/
27
28include_spip('base/abstract_sql');
29include_spip('inc/charsets');
30include_spip('inc/config');
31include_spip('inc/filtres');
32include_spip('inc/texte');
33include_spip('inc/xml');
34include_spip('inc/lang_liste');
35include_spip('inc/session');
36
37
38/**
39 * @param array $liste_sources
40 * @param string $message_commit
41 * @param string $dir_modules
42 * @param string $dir_depots
43 * @throws Exception
44 */
45function salvatore_ecrire($liste_sources, $message_commit='', $dir_modules = null, $dir_depots=null){
46        include_spip('inc/salvatore');
47        salvatore_init();
48
49        // on va lire dans la base, il faut qu'elle soit a jour
50        salvatore_verifier_base_upgradee();
51
52        if (is_null($dir_modules)){
53                $dir_modules = _DIR_SALVATORE_MODULES;
54        }
55        salvatore_check_dir($dir_modules);
56
57        if (is_null($dir_depots)) {
58                $dir_depots = _DIR_SALVATORE_DEPOTS;
59        }
60        salvatore_check_dir($dir_depots);
61
62        $url_gestionnaire = salvatore_get_self_url();
63
64        foreach ($liste_sources as $source){
65                salvatore_log("\n<info>--- Module " . $source['module'] . " | " . $source['dir_module'] . " | " . $source['url'] . "</info>");
66
67                $module = $source['module'];
68                $dir_module = $dir_modules . $source['dir_module'];
69
70                if ($autre_gestionnaire = salvatore_verifier_gestionnaire_traduction($dir_module, $module)){
71                        salvatore_fail("[Ecriveur] Erreur sur $module", "Erreur : export impossible, le fichier est traduit autre part : $autre_gestionnaire\n");
72                }
73
74                $id_tradlang_module = sql_getfetsel('id_tradlang_module', 'spip_tradlang_modules', 'dir_module = ' . sql_quote($source['dir_module']));
75                if (!$id_tradlang_module) {
76                        salvatore_fail("[Ecriveur] Erreur sur $module", "Erreur : export impossible, le module n'est pas en base\n");
77                }
78                else {
79                        // url de l'interface de traduction d'un module
80                        $url_trad_module = url_absolue(generer_url_entite($id_tradlang_module, 'tradlang_module'), $url_gestionnaire);
81                        salvatore_exporter_module($id_tradlang_module, $source, $url_gestionnaire, $url_trad_module, $dir_modules, $dir_depots, $message_commit);
82                }
83        }
84}
85
86/**
87 * Genere les fichiers de traduction d'un module
88 *
89 * @param int $id_tradlang_module
90 * @param array $source
91 * @param string $url_site
92 * @param string $url_trad_module
93 * @param string $dir_modules
94 * @param string $dir_depots
95 * @param string $message_commit
96 * @return false|int
97 */
98function salvatore_exporter_module($id_tradlang_module, $source, $url_site, $url_trad_module, $dir_modules, $dir_depots, $message_commit = ''){
99
100        $url_repo = $source['url'];
101
102        $row_module = sql_fetsel('*', 'spip_tradlang_modules', 'id_tradlang_module=' . intval($id_tradlang_module));
103        if (!$row_module) {
104                $module = $source['module'];
105                salvatore_log("<error>Le module #$id_tradlang_module $module n'existe pas</error>");
106                return false;
107        }
108        $lang_ref = $row_module['lang_mere'];
109        $dir_module = $dir_modules . $row_module['dir_module'];
110        $module = $row_module['module'];
111
112        if (is_numeric($row_module['limite_trad']) and $row_module['limite_trad']>0){
113                $seuil_export = $row_module['limite_trad'];
114        }
115        else {
116                $seuil_export = lire_config('tradlang/seuil_export_tradlang', _SALVATORE_SEUIL_EXPORT);
117        }
118
119
120        $xml_infos = $commit_infos = array();
121        $liste_lang = $liste_lang_non_exportees = $liste_lang_a_supprimer = array();
122
123        $count_trad_reference = sql_countsel('spip_tradlangs', 'id_tradlang_module=' . intval($id_tradlang_module) . ' AND lang=' . sql_quote($row_module['lang_mere']) . " AND statut='OK'", 'id');
124        $minimal = ceil((($count_trad_reference*$seuil_export)/100));
125        salvatore_log("Minimal = $minimal ($seuil_export %)");
126
127        $langues = sql_allfetsel('lang,COUNT(*) as count', 'spip_tradlangs', 'id_tradlang_module=' . intval($id_tradlang_module) . " AND statut != 'NEW' AND statut != 'attic'", 'lang', 'lang');
128        foreach ($langues as $langue){
129                /**
130                 * Le fichier est il suffisamment traduit
131                 */
132                if ($langue['count']>=$minimal){
133                        $liste_lang[] = $langue['lang'];
134                        $commit_infos[$langue['lang']] = array();
135                } 
136                else {
137                        /**
138                         * Le fichier n'est pas suffisamment traduit et n'existe pas, on ne fera donc rien
139                         */
140                        if (!file_exists($dir_module . '/' . $module . '_' . $langue['lang'] . '.php')){
141                                $liste_lang_non_exportees[] = $langue['lang'];
142                        } else {
143                                /**
144                                 * Il n'est pas suffisamment traduit, cependant, il existe déjà
145                                 * On ne va donc pas le supprimer à la barbare, mais on le met à jour quand même
146                                 */
147                                $liste_lang[] = $langue['lang'];
148                                $commit_infos[$langue['lang']] = array();
149                                $liste_lang_a_supprimer[] = $langue['lang'];
150                                $percent = (($langue['count']/$count_trad_reference)*100);
151                                if ($percent<($seuil_export-15)){
152                                        $commit_infos[$langue['lang']]['message'] = "La langue '" . $langue['lang'] . "' devrait être supprimée car trop peu traduite (" . number_format($percent, 2) . " %)\n";
153                                }
154                        }
155                }
156        }
157
158        // traiter chaque langue
159        foreach ($liste_lang as $lang){
160                salvatore_log("Generation de la langue $lang");
161                $indent = "\t";
162
163                $php_lines = $chaines = $id_tradlangs = array();
164                $initiale = '';
165
166                // On ne prend que les MODIF, les RELIRE et les OK pour ne pas rendre les sites multilingues en français
167                $chaines = sql_allfetsel('id_tradlang,id,str,comm,statut,md5', 'spip_tradlangs', 'id_tradlang_module=' . intval($id_tradlang_module) . ' AND lang=' . sql_quote($lang) . " AND statut!='NEW' AND statut!='attic'", 'id');
168                $id_tradlangs = array_column($chaines, 'id_tradlang');
169                $chaines = array_combine(array_column($chaines, 'id'), $chaines);
170                ksort($chaines);
171
172                $total_chaines = ['OK' => 0, 'MODIF' => 0, 'RELIRE' => 0];
173                foreach ($chaines as $chaine){
174                        $total_chaines[$chaine['statut']]++;
175
176                        $comment = salvatore_clean_comment($chaine['comm']);
177
178                        if ($initiale !== strtoupper($chaine['id'][0])){
179                                $initiale = strtoupper($chaine['id'][0]);
180                                $php_lines[] = "\n$indent// $initiale";
181                        }
182
183                        if (strlen($chaine['statut']) and ($chaine['statut']!=='OK')){
184                                $comment .= ' ' . $chaine['statut'];
185                        }
186                        if ($comment){
187                                $comment = ' # ' . trim($comment); // on rajoute les commentaires ?
188                        }
189
190                        // nettoyger la chaine de langue et calcul du md5
191                        $str = salvatore_nettoyer_chaine_langue($chaine['str'], $lang);
192                        $newmd5 = md5($str);
193
194                        /**
195                         * Si le md5 ou la chaine à changé, on la met à jour dans la base
196                         */
197                        if (($chaine['md5']!==$newmd5) || ($str!=$chaine['str'])){
198                                $r = sql_updateq('spip_tradlangs', array('md5' => $newmd5, 'str' => $str), 'id_tradlang=' . intval($chaine['id_tradlang']));
199                        }
200
201                        $php_lines[] = $indent . var_export($chaine['id'], 1) . ' => ' . var_export($str, 1) . ',' . $comment;
202                }
203
204                salvatore_log(" - traduction (".$total_chaines['OK']."/$count_trad_reference OK | ".$total_chaines['RELIRE']."/$count_trad_reference RELIRE | ".$total_chaines['MODIF']."/$count_trad_reference MODIFS), export");
205                $file_name = salvatore_exporter_fichier_php($dir_module, $module, $lang, $php_lines, $url_trad_module, ($lang==$lang_ref) ? $url_repo : false);
206
207                // noter la langue et les traducteurs pour lang/module.xml
208                $people_unique = array();
209                $xml_infos[$lang] = array(
210                        'traducteurs' => array(),
211                        'traduits' => $total_chaines['OK'],
212                        'modifs' => $total_chaines['MODIF'],
213                        'relire' => $total_chaines['RELIRE'],
214                );
215                if (defined('_ID_AUTEUR_SALVATORE') and intval(_ID_AUTEUR_SALVATORE)>0){
216                        $people_unique[] = _ID_AUTEUR_SALVATORE;
217                }
218
219                // ici on prend tous les statut de chaine (?)
220                $traducteurs = sql_allfetsel('DISTINCT(traducteur)', 'spip_tradlangs', 'id_tradlang_module=' . intval($id_tradlang_module) . ' AND lang=' . sql_quote($lang));
221                foreach ($traducteurs as $t){
222                        $traducteurs_lang = explode(',', $t['traducteur']);
223                        foreach ($traducteurs_lang as $traducteur){
224                                if (!in_array($traducteur, $people_unique)){
225                                        $traducteur_supp = array();
226                                        if (is_numeric($traducteur) and $id_auteur = intval($traducteur)){
227                                                $traducteur_supp['nom'] = extraire_multi(sql_getfetsel('nom', 'spip_auteurs', 'id_auteur = ' . $id_auteur));
228                                                $traducteur_supp['lien'] = url_absolue(generer_url_entite($id_auteur, 'auteur'), $url_site);
229                                        } elseif (trim(strlen($traducteur))>0) {
230                                                $traducteur_supp['nom'] = trim($traducteur);
231                                                $traducteur_supp['lien'] = '';
232                                        }
233                                        if (isset($traducteur_supp['nom'])){
234                                                $xml_infos[$lang]['traducteurs'][strtolower($traducteur_supp['nom'])] = $traducteur_supp;
235                                        }
236                                        $people_unique[] = $traducteur;
237                                }
238                        }
239                }
240                unset($people_unique);
241
242                $commit_infos[$lang]['file_name'] = basename($file_name);
243                $commit_infos[$lang]['lastmodified'] = salvatore_read_lastmodified_file(basename($file_name), $source, $dir_depots);
244                $commit_infos[$lang]['must_add'] = false;
245
246                if ($row_module['limite_trad']==0){
247                        $commit_infos[$lang]['must_add'] = true;
248                } elseif (!in_array($module, array('ecrire', 'spip', 'public'))) {
249                        if ((intval(($xml_infos[$lang]['traduits']/$count_trad_reference)*100)>$seuil_export)){
250                                $commit_infos[$lang]['must_add'] = true;
251                        }
252                }
253
254                // trouver le commiteur si c'est un fichier deja versionne ou a ajouter
255                if ($commit_infos[$lang]['lastmodified'] or $commit_infos[$lang]['must_add']) {
256                        $where = [
257                                "objet='tradlang'",
258                                sql_in('id_objet', $id_tradlangs),
259                                "id_auteur != '-1'",
260                                'id_auteur !=' . intval(_ID_AUTEUR_SALVATORE),
261                        ];
262                        if ($commit_infos[$lang]['lastmodified']) {
263                                $where[] = "date>".sql_quote(date('Y-m-d H:i:s', $commit_infos[$lang]['lastmodified']));
264                        }
265                        $auteur_versions = sql_allfetsel('DISTINCT id_auteur', 'spip_versions',  $where);
266                        if (count($auteur_versions)==1){
267                                $email = sql_getfetsel('email', 'spip_auteurs', 'id_auteur = ' . intval($auteur_versions[0]['id_auteur']));
268                                if ($email){
269                                        $commit_infos[$lang]['author'] = $email;
270                                        salvatore_log("Le commiteur pour la langue $lang : $email");
271                                }
272                        }
273                }
274        }
275
276        // le fichier XML recapitulatif
277        $indent = "\t";
278        $xml = "<traduction
279{$indent}module=\"$module\" 
280{$indent}dir_module=\"".$row_module['dir_module']."\"
281{$indent}gestionnaire=\"salvatore\"
282{$indent}url=\"$url_site\"
283{$indent}source=\"$url_repo\"
284{$indent}reference=\"$lang_ref\">\n";
285        foreach ($xml_infos as $lang => $info){
286                if (count($info['traducteurs']>0)){
287                        $xml .= "$indent<langue code=\"$lang\" url=\"" . parametre_url($url_trad_module, 'lang_cible', $lang) . "\" total=\"$count_trad_reference\" traduits=\"" . $info['traduits'] . '" relire="' . $info['relire'] . '" modifs="' . $info['modifs'] . '" nouveaux="' . ($count_trad_reference-($info['modifs']+$info['traduits']+$info['relire'])) . '" pourcent="' . number_format((($info['traduits']/$count_trad_reference)*100), 2) . "\">\n";
288                        ksort($info['traducteurs']);
289                        foreach ($info['traducteurs'] as $nom => $people){
290                                $xml .= $indent . $indent . '<traducteur nom="' . entites_html($people['nom']) . '" lien="' . entites_html($people['lien']) . "\" />\n";
291                        }
292                        $xml .= "$indent</langue>\n";
293                } else {
294                        $xml .= "$indent<langue code=\"$lang\" url=\"" . parametre_url($url_trad_module, 'lang_cible', $lang) . "\" />\n";
295                }
296        }
297        $xml .= "</traduction>\n";
298        file_put_contents($dir_module . '/' . $module . '.xml', $xml);
299
300
301        if (isset($liste_lang_non_exportees) and (count($liste_lang_non_exportees)>0)){
302                salvatore_log("Les langues suivantes ne sont pas exportées car trop peu traduites:");
303                salvatore_log(implode(', ', $liste_lang_non_exportees));
304        }
305        if (isset($liste_lang_a_supprimer) and (count($liste_lang_a_supprimer)>0)){
306                salvatore_log("Les langues suivantes devraient être supprimées car trop peu traduites:");
307                salvatore_log(implode(', ', $liste_lang_a_supprimer));
308        }
309
310        $nb_to_commit = 0;
311        // et on ecrit un json pour que le pousseur sache quoi commit
312        if (count($commit_infos)) {
313                $nb_to_commit = count($commit_infos);
314                if ($message_commit) {
315                        $commit_infos['message'] = $message_commit;
316                }
317                file_put_contents($dir_module . '/' . $module . '.commit.json', json_encode($commit_infos));
318        }
319
320        $log = salvatore_read_status_modif($module, $source, $dir_depots);
321        salvatore_log($log);
322        return $nb_to_commit;
323}
324
325/**
326 * Nettoyer le commentaire avant ecriture dans le PHP
327 * @param $comment
328 * @return mixed|string
329 */
330function salvatore_clean_comment($comment) {
331        if (strlen(trim($comment))>1){
332                // On remplace les sauts de lignes des commentaires sinon ça crée des erreurs php
333                $comment = str_replace(array("\r\n", "\n", "\r"), ' ', $comment);
334                // Conversion des commentaires en utf-8
335                $comment = unicode_to_utf_8(html_entity_decode(preg_replace('/&([lg]t;)/S', '&amp;\1', $comment), ENT_NOQUOTES, 'utf-8'));
336                return $comment;
337        }
338        return '';
339}
340
341
342/**
343 * Generer un fichier de langue a partir de ses lignes php
344 * @param string $dir_module
345 * @param string $module
346 * @param string $lang
347 * @param array $php_lines
348 * @param string $url_trad_module
349 * @param $origin
350 * @return string
351 */
352function salvatore_exporter_fichier_php($dir_module, $module, $lang, $php_lines, $url_trad_module, $origin) {
353        $file_name = $dir_module . '/' . $module . '_' . $lang . '.php';
354        $file_content = '<' . '?php
355// This is a SPIP language file  --  Ceci est un fichier langue de SPIP
356';
357        if ($origin) {
358                $file_content .= '// Fichier source, a modifier dans ' . $origin;
359        }
360        else {
361                $file_content .= '// extrait automatiquement de ' . $url_trad_module . '
362// ** ne pas modifier le fichier **
363';
364        }
365
366        // historiquement les fichiers de lang de spip_loader ne peuvent pas etre securises
367        if ($module !== 'tradloader') {
368                $file_content .= "if (!defined('_ECRIRE_INC_VERSION')) {
369        return;
370}\n\n";
371        }
372
373        # supprimer la virgule du dernier item
374        $php_lines[count($php_lines)-1] = preg_replace('/,([^,]*)$/', '\1', $php_lines[count($php_lines)-1]);
375
376        $file_content .= implode("\n", $php_lines);
377        file_put_contents($file_name, $file_content);
378        return $file_name;
379}
380
381
382/**
383 * Lire la date de derniere modif d'un fichier de langue
384 * @param string $file_name
385 * @param array $source
386 * @param string $dir_depots
387 * @return false|int
388 */
389function salvatore_read_lastmodified_file($file_name, $source, $dir_depots) {
390
391        $file_path_relative = $file_name;
392        if ($source['dir']) {
393                $file_path_relative = $source['dir'] . DIRECTORY_SEPARATOR . $file_path_relative;
394        }
395        $file_path = $dir_depots . $source['dir_checkout'] . DIRECTORY_SEPARATOR . $file_path_relative;
396
397        $lastmodified = 0;
398        switch ($source['methode']) {
399                case 'git':
400                        $d = getcwd();
401                        chdir($dir_depots . $source['dir_checkout']);
402                        $lastmodified = exec("git log -1 -c --pretty=tformat:'%ct' $file_path_relative | head -1");
403                        $lastmodified = intval(trim($lastmodified));
404                        chdir($d);
405                        break;
406                case 'svn':
407                        $lastmodified = exec('env LC_MESSAGES=en_US.UTF-8 svn info ' . $file_path . "| awk '/^Last Changed Date/ { print $4 \" \" $5 }'");
408                        $lastmodified = strtotime($lastmodified);
409                        break;
410        }
411
412        return $lastmodified;
413}
414
415
416/**
417 * Afficher le status des fichiers modifies pour un module
418 * @param string $module
419 * @param array $source
420 * @param $dir_depots
421 * @return string
422 */
423function salvatore_read_status_modif($module, $source, $dir_depots) {
424        $pre = "";
425        if ($source['dir']) {
426                $pre = $source['dir'] . DIRECTORY_SEPARATOR;
427        }
428        $files_list = [$pre . $module . '_*', $pre . $module . '.xml'];
429        $files_list = implode(' ', $files_list);
430
431        $d = getcwd();
432        chdir($dir_depots . $source['dir_checkout']);
433        $output = array();
434        switch ($source['methode']) {
435                case 'git':
436                        exec("git status $files_list 2>&1", $output);
437                        break;
438                case 'svn':
439                        exec("svn status $files_list 2>&1", $output);
440                        break;
441        }
442        chdir($d);
443        return implode("\n", $output);
444}
445
446/*
447if ($row_module['limite_trad']==0){
448        foreach ($liste_lang as $lang){
449                passthru('svn add ' . _DIR_SALVATORE_TMP . $module . '/' . $module . "_$lang.php* 2> /dev/null") ? salvatore_log("$log\n") : '';
450        }
451} elseif (!in_array($module, array('ecrire', 'spip', 'public'))) {
452        salvatore_log('Limite trad = ' . $seuil_export);
453        foreach ($liste_lang as $lang){
454                if ((intval(($xml_infos[$lang]['traduits']/$count_trad_reference)*100)>$seuil_export)
455                        and (substr(exec('svn status ' . _DIR_SALVATORE_TMP . $module . '/' . $module . "_$lang.php"), 0, 1)=='?')){
456                        passthru('svn add ' . _DIR_SALVATORE_TMP . $module . '/' . $module . "_$lang.php* 2> /dev/null") ? salvatore_log("$log\n") : '';
457                }
458        }
459}
460*/
461
462/*
463
464                if (substr(exec('svn status ' . _DIR_SALVATORE_TMP . $module . '/' . $module . '_' . $lang . '.php'), 0, 1)=='?'){
465                        if ($row_module['limite_trad']==0){
466                                passthru('svn add ' . _DIR_SALVATORE_TMP . $module . '/' . $module . "_$lang.php 2> /dev/null") ? salvatore_log("$log\n") : '';
467                        } elseif (!in_array($module, array('ecrire', 'spip', 'public'))) {
468                                if ((intval(($xml_infos[$lang]['traduits']/$count_trad_reference)*100)>$seuil_export)){
469                                        passthru('svn add ' . _DIR_SALVATORE_TMP . $module . '/' . $module . "_$lang.php* 2> /dev/null") ? salvatore_log("$log\n") : '';
470                                }
471                        }
472                }
473
474
475 */
Note: See TracBrowser for help on using the repository browser.