source: spip-zone/_plugins_/trad-lang/trunk/salvatore/ecriveur.php @ 120927

Last change on this file since 120927 was 120927, checked in by Cerdic, 15 months ago

ne mettre a commiter que les fichiers effectivement modifies

  • Property svn:eol-style set to native
File size: 17.1 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        $file_commit_infos = $dir_module . '/' . $module . '.commit.json';
120        if (file_exists($file_commit_infos)) {
121                salvatore_fail("[Ecriveur] Erreur sur $module", "Erreur : il y a deja un fichier $file_commit_infos avec des commits en attente");
122        }
123
124
125        $xml_infos = $commit_infos = array();
126        $liste_lang = $liste_lang_non_exportees = $liste_lang_a_supprimer = array();
127
128        $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');
129        $minimal = ceil((($count_trad_reference*$seuil_export)/100));
130        salvatore_log("Minimal = $minimal ($seuil_export %)");
131
132        $langues = sql_allfetsel('lang,COUNT(*) as count', 'spip_tradlangs', 'id_tradlang_module=' . intval($id_tradlang_module) . " AND statut != 'NEW' AND statut != 'attic'", 'lang', 'lang');
133        foreach ($langues as $langue){
134                /**
135                 * Le fichier est il suffisamment traduit
136                 */
137                if ($langue['count']>=$minimal){
138                        $liste_lang[] = $langue['lang'];
139                        $commit_infos[$langue['lang']] = array();
140                } 
141                else {
142                        /**
143                         * Le fichier n'est pas suffisamment traduit et n'existe pas, on ne fera donc rien
144                         */
145                        if (!file_exists($dir_module . '/' . $module . '_' . $langue['lang'] . '.php')){
146                                $liste_lang_non_exportees[] = $langue['lang'];
147                        } else {
148                                /**
149                                 * Il n'est pas suffisamment traduit, cependant, il existe déjà
150                                 * On ne va donc pas le supprimer à la barbare, mais on le met à jour quand même
151                                 */
152                                $liste_lang[] = $langue['lang'];
153                                $commit_infos[$langue['lang']] = array();
154                                $liste_lang_a_supprimer[] = $langue['lang'];
155                                $percent = (($langue['count']/$count_trad_reference)*100);
156                                if ($percent<($seuil_export-15)){
157                                        $commit_infos[$langue['lang']]['message'] = "La langue '" . $langue['lang'] . "' devrait être supprimée car trop peu traduite (" . number_format($percent, 2) . " %)\n";
158                                }
159                        }
160                }
161        }
162
163        // traiter chaque langue
164        foreach ($liste_lang as $lang){
165                salvatore_log("Generation de la langue $lang");
166                $indent = "\t";
167
168                $php_lines = $chaines = $id_tradlangs = array();
169                $initiale = '';
170
171                // On ne prend que les MODIF, les RELIRE et les OK pour ne pas rendre les sites multilingues en français
172                $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');
173                $id_tradlangs = array_column($chaines, 'id_tradlang');
174                $chaines = array_combine(array_column($chaines, 'id'), $chaines);
175                ksort($chaines);
176
177                $total_chaines = ['OK' => 0, 'MODIF' => 0, 'RELIRE' => 0];
178                foreach ($chaines as $chaine){
179                        $total_chaines[$chaine['statut']]++;
180
181                        $comment = salvatore_clean_comment($chaine['comm']);
182
183                        if ($initiale!==strtoupper($chaine['id'][0])){
184                                $initiale = strtoupper($chaine['id'][0]);
185                                $php_lines[] = "\n$indent// $initiale";
186                        }
187
188                        if (strlen($chaine['statut']) and ($chaine['statut']!=='OK')){
189                                $comment .= ' ' . $chaine['statut'];
190                        }
191                        if ($comment){
192                                $comment = ' # ' . trim($comment); // on rajoute les commentaires ?
193                        }
194
195                        // nettoyger la chaine de langue et calcul du md5
196                        $str = salvatore_nettoyer_chaine_langue($chaine['str'], $lang);
197                        $newmd5 = md5($str);
198
199                        /**
200                         * Si le md5 ou la chaine à changé, on la met à jour dans la base
201                         */
202                        if (($chaine['md5']!==$newmd5) || ($str!=$chaine['str'])){
203                                $r = sql_updateq('spip_tradlangs', array('md5' => $newmd5, 'str' => $str), 'id_tradlang=' . intval($chaine['id_tradlang']));
204                        }
205
206                        $php_lines[] = $indent . var_export($chaine['id'], 1) . ' => ' . var_export($str, 1) . ',' . $comment;
207                }
208
209                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");
210                $file_name = salvatore_exporter_fichier_php($dir_module, $module, $lang, $php_lines, $url_trad_module, ($lang==$lang_ref) ? $url_repo : false);
211
212                // noter la langue et les traducteurs pour lang/module.xml
213                $people_unique = array();
214                $xml_infos[$lang] = array(
215                        'traducteurs' => array(),
216                        'traduits' => $total_chaines['OK'],
217                        'modifs' => $total_chaines['MODIF'],
218                        'relire' => $total_chaines['RELIRE'],
219                );
220                if (defined('_ID_AUTEUR_SALVATORE') and intval(_ID_AUTEUR_SALVATORE)>0){
221                        $people_unique[] = _ID_AUTEUR_SALVATORE;
222                }
223
224                // ici on prend tous les statut de chaine (?)
225                $traducteurs = sql_allfetsel('DISTINCT(traducteur)', 'spip_tradlangs', 'id_tradlang_module=' . intval($id_tradlang_module) . ' AND lang=' . sql_quote($lang));
226                foreach ($traducteurs as $t){
227                        $traducteurs_lang = explode(',', $t['traducteur']);
228                        foreach ($traducteurs_lang as $traducteur){
229                                if (!in_array($traducteur, $people_unique)){
230                                        $traducteur_supp = array();
231                                        if (is_numeric($traducteur) and $id_auteur = intval($traducteur)){
232                                                $traducteur_supp['nom'] = extraire_multi(sql_getfetsel('nom', 'spip_auteurs', 'id_auteur = ' . $id_auteur));
233                                                $traducteur_supp['lien'] = url_absolue(generer_url_entite($id_auteur, 'auteur'), $url_site);
234                                        } elseif (trim(strlen($traducteur))>0) {
235                                                $traducteur_supp['nom'] = trim($traducteur);
236                                                $traducteur_supp['lien'] = '';
237                                        }
238                                        if (isset($traducteur_supp['nom'])){
239                                                $xml_infos[$lang]['traducteurs'][strtolower($traducteur_supp['nom'])] = $traducteur_supp;
240                                        }
241                                        $people_unique[] = $traducteur;
242                                }
243                        }
244                }
245                unset($people_unique);
246
247                if (salvatore_file_need_commit(basename($file_name), $source, $dir_depots)){
248
249                        $commit_infos[$lang]['lang'] = $lang;
250                        $commit_infos[$lang]['file_name'] = basename($file_name);
251                        $commit_infos[$lang]['lastmodified'] = salvatore_read_lastmodified_file(basename($file_name), $source, $dir_depots);
252                        $commit_infos[$lang]['must_add'] = false;
253
254                        if ($row_module['limite_trad']==0){
255                                $commit_infos[$lang]['must_add'] = true;
256                        } elseif (!in_array($module, array('ecrire', 'spip', 'public'))) {
257                                if ((intval(($xml_infos[$lang]['traduits']/$count_trad_reference)*100)>$seuil_export)){
258                                        $commit_infos[$lang]['must_add'] = true;
259                                }
260                        }
261
262                        // trouver le commiteur si c'est un fichier deja versionne ou a ajouter
263                        if ($commit_infos[$lang]['lastmodified'] or $commit_infos[$lang]['must_add']){
264                                $where = [
265                                        "objet='tradlang'",
266                                        sql_in('id_objet', $id_tradlangs),
267                                        "id_auteur != '-1'",
268                                        'id_auteur !=' . intval(_ID_AUTEUR_SALVATORE),
269                                ];
270                                if ($commit_infos[$lang]['lastmodified']){
271                                        $where[] = "date>" . sql_quote(date('Y-m-d H:i:s', $commit_infos[$lang]['lastmodified']));
272                                }
273                                $auteur_versions = sql_allfetsel('DISTINCT id_auteur', 'spip_versions', $where);
274                                if (count($auteur_versions)==1){
275                                        $auteur = sql_fetsel('nom,email', 'spip_auteurs', 'id_auteur = ' . intval($auteur_versions[0]['id_auteur']));
276                                        if ($auteur and $auteur['email']){
277                                                $commit_infos[$lang]['author'] = $auteur['email'];
278                                                if ($auteur['nom']){
279                                                        $commit_infos[$lang]['author'] = $auteur['nom'] . " <" . $commit_infos[$lang]['author'] . ">";
280                                                }
281                                                salvatore_log("Le commiteur pour la langue $lang : " . $commit_infos[$lang]['author']);
282                                        }
283                                }
284                        }
285                } else {
286                        unset($commit_infos[$lang]);
287                }
288
289        }
290
291        // le fichier XML recapitulatif
292        $indent = "\t";
293        $xml = "<traduction
294{$indent}module=\"$module\"
295{$indent}id=\"".$row_module['dir_module']."\"
296{$indent}gestionnaire=\"salvatore\"
297{$indent}url=\"$url_site\"
298{$indent}source=\"$url_repo\"
299{$indent}reference=\"$lang_ref\">\n";
300        foreach ($xml_infos as $lang => $info){
301                $detail = "";
302                if ($info['traduits'] > 0) {
303                        $detail = " 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) . "\"";
304                }
305                if (count($info['traducteurs'])>0){
306                        $xml .= "$indent<langue code=\"$lang\" url=\"" . parametre_url($url_trad_module, 'lang_cible', $lang) . "\"{$detail}>\n";
307                        ksort($info['traducteurs']);
308                        foreach ($info['traducteurs'] as $nom => $people){
309                                $xml .= $indent . $indent . '<traducteur nom="' . entites_html($people['nom']) . '" lien="' . entites_html($people['lien']) . "\" />\n";
310                        }
311                        $xml .= "$indent</langue>\n";
312                } else {
313                        $xml .= "$indent<langue code=\"$lang\" url=\"" . parametre_url($url_trad_module, 'lang_cible', $lang) . "\"{$detail} />\n";
314                }
315        }
316        $xml .= "</traduction>\n";
317        $file_xml = $dir_module . '/' . $module . '.xml';
318        file_put_contents($file_xml, $xml);
319        if (salvatore_file_need_commit(basename($file_xml), $source, $dir_depots)){
320                $commit_infos['.xml'] = array(
321                        'file_name' => basename($file_xml),
322                        'lastmodified' => salvatore_read_lastmodified_file(basename($file_xml), $source, $dir_depots),
323                        'must_add' => true,
324                );
325        }
326
327
328        if (isset($liste_lang_non_exportees) and (count($liste_lang_non_exportees)>0)){
329                salvatore_log("Les langues suivantes ne sont pas exportées car trop peu traduites : " . implode(', ', $liste_lang_non_exportees));
330        }
331        if (isset($liste_lang_a_supprimer) and (count($liste_lang_a_supprimer)>0)){
332                salvatore_log("<error>Les langues suivantes devraient être supprimées car trop peu traduites : " . implode(', ', $liste_lang_a_supprimer)."</error>");
333        }
334
335        $nb_to_commit = 0;
336        // et on ecrit un json pour que le pousseur sache quoi commit
337        if (count($commit_infos)) {
338                $nb_to_commit = count($commit_infos);
339                if ($message_commit) {
340                        $commit_infos['.message'] = $message_commit;
341                }
342                file_put_contents($file_commit_infos, json_encode($commit_infos));
343        }
344
345        $log = salvatore_read_status_modif($module, $source, $dir_depots);
346        salvatore_log($log);
347        return $nb_to_commit;
348}
349
350/**
351 * Nettoyer le commentaire avant ecriture dans le PHP
352 * @param $comment
353 * @return mixed|string
354 */
355function salvatore_clean_comment($comment) {
356        if (strlen(trim($comment))>1){
357                // On remplace les sauts de lignes des commentaires sinon ça crée des erreurs php
358                $comment = str_replace(array("\r\n", "\n", "\r"), ' ', $comment);
359                // Conversion des commentaires en utf-8
360                $comment = unicode_to_utf_8(html_entity_decode(preg_replace('/&([lg]t;)/S', '&amp;\1', $comment), ENT_NOQUOTES, 'utf-8'));
361                return $comment;
362        }
363        return '';
364}
365
366
367/**
368 * Generer un fichier de langue a partir de ses lignes php
369 * @param string $dir_module
370 * @param string $module
371 * @param string $lang
372 * @param array $php_lines
373 * @param string $url_trad_module
374 * @param $origin
375 * @return string
376 */
377function salvatore_exporter_fichier_php($dir_module, $module, $lang, $php_lines, $url_trad_module, $origin) {
378        $file_name = $dir_module . '/' . $module . '_' . $lang . '.php';
379        $file_content = '<' . '?php
380// This is a SPIP language file  --  Ceci est un fichier langue de SPIP
381';
382        if ($origin) {
383                $file_content .= '// Fichier source, a modifier dans ' . $origin;
384        }
385        else {
386                $url_trad_module = parametre_url($url_trad_module, 'lang_cible', $lang, '&');
387                $file_content .= '// extrait automatiquement de ' . $url_trad_module . '
388// ** ne pas modifier le fichier **
389';
390        }
391
392        // historiquement les fichiers de lang de spip_loader ne peuvent pas etre securises
393        if ($module !== 'tradloader') {
394                $file_content .= "\nif (!defined('_ECRIRE_INC_VERSION')) {
395        return;
396}\n\n";
397        }
398
399        # supprimer la virgule du dernier item
400        $php_lines[count($php_lines)-1] = preg_replace('/,([^,]*)$/', '\1', $php_lines[count($php_lines)-1]);
401
402        $file_content .=
403                '$GLOBALS[$GLOBALS[\'idx_lang\']] = array(' . "\n"
404                . implode("\n", $php_lines)
405          . "\n);\n";
406        file_put_contents($file_name, $file_content);
407        return $file_name;
408}
409
410
411/**
412 * Lire la date de derniere modif d'un fichier de langue
413 * @param string $file_name
414 * @param array $source
415 * @param string $dir_depots
416 * @return false|int
417 */
418function salvatore_read_lastmodified_file($file_name, $source, $dir_depots) {
419
420        $file_path_relative = $file_name;
421        if ($source['dir']) {
422                $file_path_relative = $source['dir'] . DIRECTORY_SEPARATOR . $file_path_relative;
423        }
424
425        $vcs_lastmodified_file = salvatore_vcs_function($source['methode'],  "lastmodified_file");
426        return $vcs_lastmodified_file($dir_depots . $source['dir_checkout'], $file_path_relative);
427}
428
429
430/**
431 * Afficher le status des fichiers modifies pour un module
432 * @param string $module
433 * @param array $source
434 * @param $dir_depots
435 * @return string
436 */
437function salvatore_read_status_modif($module, $source, $dir_depots) {
438        $pre = "";
439        if ($source['dir']) {
440                $pre = $source['dir'] . DIRECTORY_SEPARATOR;
441        }
442        $files_list = [$pre . $module . '_*', $pre . $module . '.xml'];
443
444        $vcs_status_file = salvatore_vcs_function($source['methode'],  "status_file");
445        return $vcs_status_file($dir_depots . $source['dir_checkout'], $files_list);
446}
447
448
449/**
450 * Recuperer le status d'un fichier pour voir si vide ou si modifie/nouveau
451 * @param string $file
452 * @param array $source
453 * @param $dir_depots
454 * @return string
455 */
456function salvatore_file_need_commit($file, $source, $dir_depots) {
457        $pre = "";
458        if ($source['dir']) {
459                $pre = $source['dir'] . DIRECTORY_SEPARATOR;
460        }
461
462        $vcs_status_file = salvatore_vcs_function($source['methode'],  "status_file");
463        $status = $vcs_status_file($dir_depots . $source['dir_checkout'], $pre . $file);
464        return (strlen(trim($status)) ? true : false);
465}
Note: See TracBrowser for help on using the repository browser.