Subversion Repositories Applications.referentiel

<?php
// Encodage : UTF-8
// +-------------------------------------------------------------------------------------------------------------------+
/**
* Versionnage de référentiels de nomenclature et taxonomie
*
* Description : classe permettant de versionner les référentiels selon le manuel technique
* Utilisation : php script.php versionnage -p bdnff -a tout
*
//Auteur original :
* @author       Jean-Pascal MILCENT <jpm@tela-botanica.org>
* @copyright    Tela-Botanica 1999-2010
* @link                 http://www.tela-botanica.org/wikini/RTaxMethodo/wakka.php?wiki=MaNuel
* @licence              GPL v3 & CeCILL v2
* @version              $Id$
*/
// +-------------------------------------------------------------------------------------------------------------------+
// TODO : supprimer l'utilisation du paramêtres 'p' et chercher les infos depuis la bdd
class Versionnage extends ScriptCommande {
        
        const SCRIPT_NOM = 'versionnage';
        const MANUEL_VERSION = "2.1";
        
        private $projet = null;
        private $traitement = null;
        private $meta = null;
        private $version_courante = null;
        private $messages = null;
        private $manuel = null;
        private $manuel_nom = null;
        private $manuel_chemin = null;
        private $zip_chemin_dossier = null;
        private $zip_chemin_fichier = null;
        private $zip_chemin_dossier_partiel = null;
        private $zip_chemin_fichier_partiel = null;
        
        private $noms = null;
        private $noms_precedents = null;
        private $noms_stat = null;
        private $champs_ordre = null;
        private $champs_nom = null;
        private $champs_nom_partiel = null;
        private $champs_diff = null;
        private $diff_champs_nom = null;
        private $diff_modif_types = null;
        private $signature_md5 = null;
        private $signature_md5_partiel = null;
        
        private $resultatDao = null;
        private $traitementDao = null;
        private $metaDao = null;
        private $tableStructureDao = null;
        private $referentielDao = null;
        
        public function executer() {
                // Récupération du dernier traitement demandé
                $this->traitementDao = new TraitementDao();
                $this->traitement = $this->traitementDao->getDernierTraitement('tout', self::SCRIPT_NOM);
                if (isset($this->traitement)) {
                        $this->projet = $this->traitement['referentiel_code']; // Récupération du nom de projet
                        Debug::printr($this->traitement);
                        // Écriture de la date de début du traitement
                        Debug::printr('Debute:'.$this->traitementDao->debuterTraitement($this->traitement['id_traitement']));
                        
                        // Nettoyage des traitements obsolètes
                        $traitements_obsoletes = $this->traitementDao->getTraitementsObsoletes($this->projet, self::SCRIPT_NOM);
                        if (isset($traitements_obsoletes)) {
                                Debug::printr('Supp. obsoletes:'.$this->traitementDao->supprimer($traitements_obsoletes));
                        }
                        
                        // Lancement du test demandé
                        $cmd = $this->getParam('a');
                switch ($cmd) {
                                case 'tout' :
                                        $this->initialiserScript();
                                        Debug::printr('Départ lancement versionnage:');
                                        $this->lancerVersionnage();
                                        break;
                                default :
                                        $this->traiterErreur('Erreur : la commande "%s" n\'existe pas!', array($cmd));
                        }
                        // Écriture de la date de fin du traitement
                        Debug::printr('Termine:'.$this->traitementDao->terminerTraitement($this->traitement['id_traitement']));
                }
    }
        
    private function initialiserScript() {
                $this->metaDao = new MetaDao();
                $this->resultatDao = new ResultatDao();
                $this->referentielDao = new ReferentielDao();
                
                $this->manuel_nom = 'mtpr_v'.str_replace('.', '_', self::MANUEL_VERSION).'.pdf';
                $this->manuel_chemin = Config::get('chemin_appli').DS.'..'.DS.'configurations'.DS;
                
                $manuel_config_nom = 'referentiel_v'.self::MANUEL_VERSION.'.ini';
                $this->manuel = parse_ini_file($this->manuel_chemin.$manuel_config_nom);
        }
        
    public function lancerVersionnage() {
                $this->chargerTraitementParametre();
                $this->initialiserNomVersionCOurante();
                $this->initialiserCheminsZip();
                $this->creerDossiersZip();
                $this->archiver();
        $this->chargerNomsATraiter();
        $this->analyserNomsATraiter();
                $this->creerFichiers();
                $this->nettoyerFichiers();
                $this->traiterMessages();
        }
        
        private function chargerTraitementParametre() {
                $this->meta = unserialize($this->traitement['script_parametres']);
        }
        
        private function archiver() {
                $ok = $this->referentielDao->archiver($this->projet, $this->meta['version']);
                if ($ok) {
                        $m = "L'archivage de la version '{$this->meta['version']}' du référentiel '{$this->projet}' a réussi";
                        $this->ajouterMessage($m);
                } else {
                        $m = "L'archivage de la version '{$this->meta['version']}' du référentiel '{$this->projet}' a échoué";
                        $this->ajouterMessage($m);
                }
        }
        
        private function initialiserNomVersionCOurante() {
                $this->version_courante = strtolower($this->projet).'_v'.str_replace('.', '_', $this->meta['version']);
                Debug::printr("Nom archive courante :".$this->version_courante);
        }
        
        private function initialiserCheminsZip() {
                $this->zip_chemin_dossier = Config::get('chemin_referentiel_zip').$this->version_courante.DIRECTORY_SEPARATOR;
                $this->zip_chemin_fichier = Config::get('chemin_referentiel_zip').$this->version_courante.'.zip';
                $this->zip_chemin_dossier_partiel = Config::get('chemin_referentiel_zip').$this->version_courante.'_partiel'.DIRECTORY_SEPARATOR;
                $this->zip_chemin_fichier_partiel = Config::get('chemin_referentiel_zip').$this->version_courante.'_partiel.zip';
        }
        
        private function creerDossiersZip() {
                $recursivite = true;
                if (mkdir($this->zip_chemin_dossier, 0777, $recursivite) === false) {
                        $this->ajouterMessage("La création du dossier '$this->zip_chemin_dossier' devant contenir les fichiers a échouée.");
                }
                if (mkdir($this->zip_chemin_dossier_partiel, 0777, $recursivite) === false) {
                        $this->ajouterMessage("La création du dossier '$this->zip_chemin_dossier_partiel' devant contenir les fichiers partiels a échouée.");
                }
        }
        
        private function chargerNomsATraiter() {
                $this->noms = $this->referentielDao->getTout($this->version_courante);
        }
        
        private function analyserNomsATraiter() {
                $this->noms_stat['combinaison'] = $this->getNombreCombinaison();
                $this->noms_stat['taxon'] = $this->getNombreTaxon();
                Debug::printr("Stats :".print_r($this->noms_stat, true));
        }
        
        private function getNombreCombinaison() {
                return count($this->noms);
        }
        
        private function getNombreTaxon() {
                $nbre = 0;
                foreach ($this->noms as $nom) {
                        if ($nom['num_nom_retenu'] == $nom['num_nom']) {
                                $nbre++;
                        }
                }
                return $nbre;
        }
        
        private function creerFichiers() {
                // Respecter l'ordre de traitement : BDNT puis DIFF puis META
                $donnees =& $this->creerFichierBdnt();
                $this->creerFichierBdntPartiel($donnees);
                $donnees = null;
                $donnees =& $this->creerFichierDiff();
                $this->creerFichierDiffPartiel($donnees);
                $donnees = null;
                $donnees =& $this->creerFichierMeta();
                $this->creerFichierMetaPartiel($donnees);
                $donnees = null;
                $this->nettoyerMemoire();
                $this->copierManuel();
                $this->creerFichiersZip();
        }
        
        private function creerFichierBdnt() {
                reset($this->noms);
                Debug::printr("Element courrant du tableau des noms : ".count($this->noms).'-'.print_r(current($this->noms),true));
                
                $this->determinerOrdreDesChamps();
                $this->definirNomDesChamps();
                $this->definirNomDesChampsDiff();
                
                $donnees = array();
                $donnees['champs'] = $this->champs_nom;
                foreach ($this->noms as $id => &$nom) {
                        $infos = array();
                        foreach ($this->champs_ordre as $champ => $ordre) {
                                if (isset($nom[$champ])) {
                                        $infos[$champ] = trim($nom[$champ]);
                                } else {
                                        $e = "Le champ '$champ' n'a pas été trouvé dans les données du nom : $id.";
                                        $this->ajouterMessage($e);
                                }
                        }
                        $infos = $this->remplacerTabulation($infos);
                        $infos = $this->remplacerSautsDeLigne($infos);
                        $donnees['noms'][$id] = $infos;
                }
                Debug::printr("Dernier element du tableau des noms [trié] : ".print_r($infos,true));
                $bdnt_tsv =& $this->getVue('versionnage/squelettes/bdnt', &$donnees, '.tpl.tsv');
                $this->ecrireFichierBdnt($bdnt_tsv);
                return $donnees;
        }
        
        private function determinerOrdreDesChamps() {
                $champs_ordre = explode(',', $this->manuel['champs']);
                $champs_ordre = array_flip($champs_ordre);
                $nom_courant = current($this->noms);
                $champs_ordre = $this->attribuerOrdreChampsSupplémentaires($champs_ordre, $nom_courant);
                asort($champs_ordre);
                $this->champs_ordre = $champs_ordre;
                Debug::printr("Ordre des champs : ".print_r($this->champs_ordre,true));
        }
        
        private function attribuerOrdreChampsSupplémentaires($champs_ordre, $nom) {
                foreach ($nom as $champ => $info) {
                        if (!isset($champs_ordre[$champ])) {
                                $champs_ordre[$champ] = count($champs_ordre);
                        }
                }
                return $champs_ordre;
        }
        
        private function definirNomDesChamps() {
                $this->champs_nom = array_flip($this->champs_ordre);
        }
        
        private function definirNomDesChampsDiff() {
                $this->champs_diff = explode(',', $this->manuel['champs_diff']);
                $this->diff_champs_nom = array_merge($this->champs_nom, $this->champs_diff);
        }
        
        private function ajouterMessage($message) {
                $titre = self::SCRIPT_NOM.' #'.$this->traitement['id_traitement'];
                $this->messages[] = array('message' => $message, 'resultat' => true);
        }
        
        private function remplacerTabulation($doc) {
                if (is_string($doc)) {
                        $doc = str_replace("\t", ' ', $doc);
                } else if (is_array($doc) && count($doc) > 0) {
                        foreach ($doc as $cle => $valeur) {
                                $doc[$cle] = $this->remplacerTabulation($valeur);
                        }
                }
                return $doc;
        }
        
        private function remplacerSautsDeLigne($doc) {
                if (is_string($doc)) {
                        $a_remplacer = array("\r", "\n");
                        $doc = str_replace($a_remplacer, ' ', $doc);
                } else if (is_array($doc) && count($doc) > 0) {
                        foreach ($doc as $cle => $valeur) {
                                $doc[$cle] = $this->remplacerSautsDeLigne($valeur);
                        }
                }
                return $doc;
        }
        
        private function ecrireFichierBdnt(&$contenu) {
                $fichier_nom = $this->getBaseNomFichier().$this->manuel['ext_fichier_bdnt'];
                $fichier_chemin = $this->zip_chemin_dossier.$fichier_nom;
                
                if ($this->ecrireFichier($fichier_chemin, $contenu)) {
                        $this->ajouterMessage("Écriture du fichier bdnt réussie.");
                        $this->signature_md5 = md5_file($fichier_chemin);
                        $this->ajouterMessage("Signature MD5 du fichier bdnt :".$this->signature_md5);
                        $this->ajouterMessage("Nombre de combinaisons traitées : ".$this->noms_stat['combinaison']);
                }
        }
        
        private function getBaseNomFichier() {
                return strtolower($this->meta['acronyme'].'_v'.$this->meta['version']);
        }
                
        private function creerFichierBdntPartiel(&$donnees) {
                $this->definirChampsPartiel();
                Debug::printr(current($donnees['noms']));
                $donnees['champs_partiel'] = $this->champs_nom_partiel;
                $donnees['dernier_champ'] = end($this->champs_nom_partiel);
                $bdnt_partielle_tsv =& $this->getVue('versionnage/squelettes/bdnt_partiel', &$donnees, '.tpl.tsv');
                $this->ecrireFichierBdntPartielle($bdnt_partielle_tsv);
        }
        
        private function definirChampsPartiel() {
                $this->champs_nom_partiel = explode(',', $this->manuel['champs_partiel']);
                Debug::printr("Champs partiels : ".print_r($this->champs_nom_partiel,true));
        }
        
        private function ecrireFichierBdntPartielle(&$contenu) {
                $fichier_nom = $this->getBaseNomFichier().$this->manuel['ext_fichier_bdnt'];
                $fichier_chemin = $this->zip_chemin_dossier_partiel.$fichier_nom;
                
                if ($this->ecrireFichier($fichier_chemin, $contenu)) {
                        $this->ajouterMessage("Écriture du fichier de la bdnt partielle réussie.");
                        $this->signature_md5_partiel = md5_file($fichier_chemin);
                        $this->ajouterMessage("Signature MD5 du fichier bdnt partiel :".$this->signature_md5_partiel);
                        $this->ajouterMessage("Nombre de combinaisons traitées : ".$this->noms_stat['combinaison']);
                }
        }
        
        private function ecrireFichier($fichier_chemin, &$contenu) {
                $retour = true;
                if (file_put_contents($fichier_chemin, $contenu) == false) {
                        $e = "Une erreur est survenu lors de l'écriture du fichier : $fichier_chemin";
                        $this->ajouterMessage($e);
                        $retour = false;
                }
                $contenu = null;
                return $retour;
        }
        
        private function creerFichierDiff() {
                $donnees = array();
                $derniere_meta = $this->metaDao->getDerniere($this->projet);
                if (is_null($derniere_meta === false)) {
                        $this->ajouterMessage("Un problème est survenu lors de la récupération des métadonnées précédentes.");
                } else if (is_null($derniere_meta)) {
                        $this->ajouterMessage("Premier versionnage pour ce projet, aucun fichier différentiel ne sera créé.");
                } else {
                        $code_projet_precedent = strtolower($derniere_meta['code']).'_v'.str_replace('.', '_', $derniere_meta['version']);
                        if ($code_projet_precedent == $this->version_courante) {
                                $e = "La code de la version préalablement versionnée ($code_projet_precedent) est le même que celui ".
                                        "de la demande actuel ({$this->version_courante}) pour ce projet, aucun fichier différentiel ne sera créé.";
                                $this->ajouterMessage($e);
                        } else {
                                $this->noms_precedents = $this->referentielDao->getTout($code_projet_precedent);
                                $donnees['diff'] = $this->realiserDiff();
                                $donnees['champs'] = $this->diff_champs_nom;
                                $diff_tsv =& $this->getVue('versionnage/squelettes/diff', &$donnees, '.tpl.tsv');
                                $this->ecrireFichierDiff($diff_tsv);
                        }
                }
                return $donnees;
        }
        
        private function realiserDiff() {
                $this->chargerTableauChampsModifTypes();
                $this->noms_stat['modification'] = 0;
                
                $diff = array();
                foreach ($this->noms as $id => $nom) {
                        $this->noms[$id] = null;
                        $infos = array();
                        if (!isset($this->noms_precedents[$id])) {
                                $infos = $this->traiterDiffAjout($nom);
                        } else {
                                $nom_precedent = $this->noms_precedents[$id];
                                $this->noms_precedents[$id] = null;
                                $infos = $this->traiterDiffModif($nom, $nom_precedent);
                        }
                        
                        if (count($infos) > 0) {
                                $infos = $this->remplacerTabulation($infos);
                                $infos = $this->remplacerSautsDeLigne($infos);
                                $diff[$id] = $infos;
                        }
                }
                return $diff;
        }
        
        private function traiterDiffAjout(&$nom) {
                $infos = $nom;
                $infos['modification_type'] = 'A';
                $infos['modification_type_1'] = '0';
                $infos['modification_type_2'] = '0';
                $infos['modification_type_3'] = '0';
                $this->noms_stat['modification']++;
                return $infos;
        }
        
        private function traiterDiffModif(&$nom, &$nom_precedent) {
                $infos = array();
                $nom_diff = array_diff_assoc($nom, $nom_precedent);             $bdnt_partielle_tsv = 'trest';
                if (count($nom_diff) > 0) {
                        $modif['modification_type'] = 'M';
                        $modif['modification_type_1'] = '0';
                        $modif['modification_type_2'] = '0';
                        $modif['modification_type_3'] = '0';
                        
                        foreach ($this->champs_nom as $champ) {
                                if (isset($nom_diff[$champ])) {
                                        $infos[$champ] = $nom_diff[$champ];
                                        $type = $this->getDiffType($champ);
                                        $modif['modification_type_'.$type] = '1';
                                } else {
                                        if ($champ == 'num_nom') {
                                                $infos[$champ] = $nom[$champ];
                                        } else {
                                                $infos[$champ] = '';
                                        }
                                }
                        }
                        
                        foreach ($modif as $cle => $val) {
                                $infos[$cle] = $val;
                        }
                        
                        $this->noms_stat['modification']++;
                }
                return $infos;
        }
        
        private function chargerTableauChampsModifTypes() {
                $champs = explode(',', $this->manuel['champs_diff_type']);
                foreach ($champs as $champ) {
                        list($champ_nom, $type) = explode('=', trim($champ));
                        $this->diff_modif_types[$champ_nom] = $type;
                }
        }
        
        private function getDiffType($champ_nom) {
                $type = isset($this->diff_modif_types[$champ_nom]) ? $this->diff_modif_types[$champ_nom] : '3';
                return $type;
        }
        
        private function ecrireFichierDiff(&$contenu) {
                $fichier_nom = $this->getBaseNomFichier().$this->manuel['ext_fichier_diff'];
                $fichier_chemin = $this->zip_chemin_dossier.$fichier_nom;
                
                if ($this->ecrireFichier($fichier_chemin, $contenu)) {
                        $this->ajouterMessage("Écriture du fichier diff réussie.");
                }
        }
        
        private function creerFichierDiffPartiel(&$donnees) {
                if (count($donnees) > 0) {
                        $donnees['champs_partiel_diff'] = array_merge($this->champs_nom_partiel, $this->champs_diff);
                        $donnees['dernier_champ'] = end($donnees['champs_partiel_diff']);
                        $diff_tsv_partiel =& $this->getVue('versionnage/squelettes/diff_partiel', &$donnees, '.tpl.tsv');
                        $this->ecrireFichierDiffPartiel($diff_tsv_partiel);
                }
        }
        
        private function ecrireFichierDiffPartiel(&$contenu) {
                $fichier_nom = $this->getBaseNomFichier().$this->manuel['ext_fichier_diff'];
                $fichier_chemin = $this->zip_chemin_dossier_partiel.$fichier_nom;
                
                if ($this->ecrireFichier($fichier_chemin, $contenu)) {
                        $this->ajouterMessage("Écriture du fichier diff partiel réussie.");
                }
        }
        
        private function creerFichierMeta() {
                $donnees = array();
                $donnees = $this->meta;
                $donnees['stats'] = $this->noms_stat;
                $donnees['signature'] = $this->signature_md5;
                
                $donnees = $this->remplacerTabulation($donnees);
                $donnees = $this->remplacerSautsDeLigne($donnees);
                
                $meta_tsv =& $this->getVue('versionnage/squelettes/meta', &$donnees, '.tpl.tsv');
                $this->ecrireFichierMeta($meta_tsv);
                return $donnees;
        }
        
        private function ecrireFichierMeta(&$contenu) {
                $fichier_nom = $this->getBaseNomFichier().$this->manuel['ext_fichier_meta'];
                $fichier_chemin = $this->zip_chemin_dossier.$fichier_nom;
                
                if ($this->ecrireFichier($fichier_chemin, $contenu)) {
                        $this->ajouterMessage("Écriture du fichier meta réussie.");
                        $this->archiverMetadonnees();
                }
        }
        
        private function creerFichierMetaPartiel(&$donnees) {
                $donnees['signature'] = $this->signature_md5_partiel;
                $meta_tsv_partiel =& $this->getVue('versionnage/squelettes/meta', &$donnees, '.tpl.tsv');
                $this->ecrireFichierMetaPartiel($meta_tsv_partiel);
        }
        
        private function ecrireFichierMetaPartiel(&$contenu) {
                $fichier_nom = $this->getBaseNomFichier().$this->manuel['ext_fichier_meta'];
                $fichier_chemin = $this->zip_chemin_dossier_partiel.$fichier_nom;
                
                if ($this->ecrireFichier($fichier_chemin, $contenu)) {
                        $this->ajouterMessage("Écriture du fichier meta partiel réussie.");
                }
        }
        
        private function archiverMetadonnees() {
                $metadonnees = $this->meta;
                $metadonnees['code'] = $this->meta['acronyme'];
                unset($metadonnees['acronyme']);
                $metadonnees['domaine_taxo'] = $this->meta['dom_tax'];
                unset($metadonnees['dom_tax']);
                $metadonnees['domaine_geo'] = $this->meta['dom_geo'];
                unset($metadonnees['dom_geo']);
                $metadonnees['domaine_nom'] = $this->meta['dom_code'];
                unset($metadonnees['dom_code']);
                $metadonnees['auteur'] = $this->meta['auteur_principal'];
                unset($metadonnees['auteur_principal']);
                $metadonnees['date_production'] = $this->meta['date_prod'];
                unset($metadonnees['date_prod']);
                $metadonnees['droit'] = $this->meta['copyright'];
                unset($metadonnees['copyright']);
                
                $ok = $this->metaDao->ajouter($metadonnees);
                if ($ok === false) {
                        $this->ajouterMessage("L'archivage des métadonnées a échoué.");
                }
        }
        
        private function nettoyerMemoire() {
                $this->noms = null;
                $this->noms_precedents = null;
                $this->noms_stat = null; 
        }
        
        private function copierManuel() {
                $fichier_source = $this->manuel_chemin.$this->manuel_nom;
                $fichiers_destination[] = $this->zip_chemin_dossier.$this->manuel_nom;
                $fichiers_destination[] = $this->zip_chemin_dossier_partiel.$this->manuel_nom;
                foreach ($fichiers_destination as $destination) {
                        if (copy($fichier_source, $destination) === false) {
                                $this->ajouterMessage("La copie du manuel vers '$destination' a échouée.");
                        }
                }
        }
        
        private function creerFichiersZip() {
                $this->zipper($this->zip_chemin_fichier, $this->zip_chemin_dossier);
                $this->zipper($this->zip_chemin_fichier_partiel, $this->zip_chemin_dossier_partiel);
        }
        
        private function zipper($fichier_zip, $dossier_a_zipper) {
                $zip = new PclZip($fichier_zip);
                if ($zip->add($dossier_a_zipper, PCLZIP_OPT_REMOVE_ALL_PATH) == 0) {
                        $e = "La création du fichier zip '$fichier_zip' a échoué avec l'erreur : ".$zip->errorInfo(true);
                        $this->ajouterMessage($e);
                }
        }
        
        private function nettoyerFichiers() {
                Fichier::supprimerDossier($this->zip_chemin_dossier);
                Fichier::supprimerDossier($this->zip_chemin_dossier_partiel);
        }
        
        private function traiterMessages() {
                if (isset($this->messages)) {
                        $num_message = 1;
                        foreach ($this->messages as $message) {
                                $message['nom'] = 'Message #'.$num_message++;
                                $this->resultatDao->ajouter($this->traitement['id_traitement'], $message);
                        }
                }
        }
}
?>