Updates fusionax scripts for better compliance.

[platal.git] / modules / fusionax.php

<?php
/***************************************************************************
 *  Copyright (C) 2003-2007 Polytechnique.org                              *
 *  http://opensource.polytechnique.org/                                   *
 *                                                                         *
 *  This program is free software; you can redistribute it and/or modify   *
 *  it under the terms of the GNU General Public License as published by   *
 *  the Free Software Foundation; either version 2 of the License, or      *
 *  (at your option) any later version.                                    *
 *                                                                         *
 *  This program is distributed in the hope that it will be useful,        *
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of         *
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
 *  GNU General Public License for more details.                           *
 *                                                                         *
 *  You should have received a copy of the GNU General Public License      *
 *  along with this program; if not, write to the Free Software            *
 *  Foundation, Inc.,                                                      *
 *  59 Temple Place, Suite 330, Boston, MA  02111-1307  USA                *
 ***************************************************************************/

/**
 * @brief Module to merge data from AX database
 *
 * Module to import data from another database of alumni that had
 * different schemas. The organization that used this db is called AX
 * hence the name of this module.
 *
 * Datas are stored in an external server and you need a private key
 * to connect to their server.
 */
class FusionAxModule extends PLModule{

    /// path ok private key file to connect to AX server
    var $ax_xorg_rsa_key;

    function __construct()
    {
        /*$this->ax_xorg_rsa_key =
            dirname(__FILE__).'/../configs/ax_xorg_rsa.pem';*/
    }

    function handlers()
    {
        return array(
            'fusionax'          => $this->make_hook('index', AUTH_MDP, 'admin'),
            'fusionax/import'   => $this->make_hook('import', AUTH_MDP,'admin'),
            'fusionax/ids'      => $this->make_hook('ids', AUTH_MDP, 'admin'),
            'fusionax/misc'     => $this->make_hook('misc', AUTH_MDP, 'admin'),
        );
    }


    function handler_index(&$page)
    {
        global $globals;
        $page->changeTpl('fusionax/index.tpl');
        $page->assign('xorg_title','Polytechnique.org - Fusion des annuaires');
        if (isset($globals->fusionax) && 
            isset($globals->fusionax->LastUpdate)) {
            $page->assign(
                'lastimport', 
                date("d-m-Y",$globals->fusionax->LastUpdate));
        } 
    }

    /** Import de l'annuaire de l'AX depuis l'export situé sur leur serveur */
    function handler_import(&$page, $action = 'index', $fileSQL = '')
    {
        if ($action == 'index') {
            $page->changeTpl('fusionax/import.tpl');
            $page->addJsLink('jquery.js');
            global $globals;
            if (isset($globals->fusionax) &&
                isset($globals->fusionax->LastUpdate)) {
                $page->assign(
                    'lastimport',
                    "le ".date("d/m/Y à H:i",$globals->fusionax->LastUpdate));
            }
            /*if (!file_exists($this->ax_xorg_rsa_key)) {
                $page->assign(
                    'keymissing',
                    $this->ax_xorg_rsa_key);
            }*/
            return;
        }

        // toutes les actions sont faites en ajax en utilisant jquery
        header("Content-type: text/javascript; charset=utf-8");

        // log des actions
        $report = array();

        // création d'un fichier temporaire si nécessaire
        if (Env::has('tmpdir')) {
            $tmpdir = Env::v('tmpdir');
        } else {
            $tmpdir = tempnam('/tmp', 'fusionax');
            unlink($tmpdir);
            mkdir($tmpdir);
            chmod($tmpdir, 0700);
            // copie la clef d'authentification (paire de clef RSA dont la
            // partie publique est sur polytechniciens.com)
            /*if (!copy(
                $this->ax_xorg_rsa_key,
                $tmpdir.'/ax_xorg_rsa'))
                $report[] = 'Impossible de copier la clef pour se logger '.
                    'au serveur AX';
            chmod($tmpdir.'/ax_xorg_rsa', 0600);*/
        }

        $modulepath = realpath(dirname(__FILE__).'/fusionax/').'/';
        $olddir = getcwd();
        chdir($tmpdir);

        if ($action == 'launch') {
            // lancement : connexion en ssh et récupération du fichier depuis
            // polyechniciens.com, décompression de l'archive et séparation en
            // fichiers par tables
            exec($modulepath.'import-ax.sh', $report);
            $report[] = utf8_decode('Récupération du fichier terminé.');
            $report[] = 'Import dans la base en cours...';
            $next = 'integrateSQL';
        } else if ($action == 'integrateSQL') {
            // intégration des données dans la base MySQL
            // liste des fichiers sql à exécuter
            $filesSQL = array(
                'Activites.sql',
                'Adresses.sql',
                'Anciens.sql',
                'Formations.sql',
                'Entreprises.sql');
            if ($fileSQL != '') {
                // récupère le contenu du fichier sql
                $queries = explode(';',file_get_contents($modulepath.$fileSQL));
                foreach ($queries as $q) if (trim($q)) {
                    // coupe le fichier en requêtes individuelles
                    if (substr($q,0,2) == '--') {
                        // affiche les commentaires dans le report
                        $lines = explode("\n",$q);
                        $l = $lines[0];
                        $report[] = addslashes(utf8_decode($l));
                    }
                    // exécute la requête
                    XDB::execute($q);
                }
                // trouve le prochain fichier à exécuter
                $trans = array_flip($filesSQL);
                $nextfile = $trans[$fileSQL] + 1;
            } else {
                $nextfile = 0;
            }
            if (!isset($filesSQL[$nextfile])) {
                // tous les fichiers ont été exécutés, on passe à l'étape
                // suivante
                $next = 'clean';
            } else {
                // on passe au fichier suivant
                $next = 'integrateSQL/'.$filesSQL[$nextfile];
            }
        } else if ($action == 'clean') {
            // nettoyage du fichier temporaire
            chdir($olddir);
            exec("rm -rf $tmpdir", $report);
            $report[] = 'Fin de l\'import';
            global $globals;
            // met à jour la date de dernier import
            $globals->change_dynamic_config(
                array('LastUpdate' => time()),
                'FusionAx');
        }
        $tmpdir = getcwd();
        chdir($olddir);
        foreach($report as $t)
            // affiche les lignes de report
            echo "$('#fusionax_import').append('".utf8_encode($t)."<br/>');\n";
        if (isset($next)) {
            // lance le prochain script s'il y en a un
            echo "$.getScript('fusionax/import/".$next."?tmpdir=".
                urlencode($tmpdir)."');";
        }
        // exit pour ne pas afficher la page template par défaut
        exit;
    }

    /** Lier les identifiants d'un ancien dans les deux annuaires
     * @param user_id identifiant dans l'annuaire X.org
     * @param matricule_ax identifiant dans l'annuaire de l'AX
     * @return 0 si la liaison a échoué, 1 sinon
     */
    private static function link_by_ids($user_id, $matricule_ax)
    {
        if (!XDB::execute("
        UPDATE fusionax_import AS i 
            INNER JOIN fusionax_xorg_anciens AS u 
            SET
                u.matricule_ax = i.id_ancien,
                i.user_id = u.user_id,
                i.date_match_id = NOW()
            WHERE
            i.id_ancien = {?} AND u.user_id = {?} AND (
                u.matricule_ax != {?} OR u.matricule_ax IS NULL OR
                i.user_id != {?} OR i.user_id IS NULL)",
            $matricule_ax,
            $user_id,
            $matricule_ax,
            $user_id))
        {
            return 0;
        }
        return XDB::affectedRows() / 2;  
    }

    /** Recherche automatique d'anciens à lier entre les deux annuaires
     * @param limit nombre d'anciens à trouver au max
     * @param sure si true, ne trouve que des anciens qui sont quasi sûrs
     * @return un XOrgDBIterator sur les entrées avec display_name, promo,
     * user_id, id_ancien et display_name_ax
     */
    private static function find_easy_to_link($limit = 10, $sure = false)
    {
        $easy_to_link = XDB::iterator("
        SELECT 
            xorg.display_name, xorg.promo, xorg.user_id, ax.id_ancien,
            CONCAT(ax.prenom,' ',ax.nom_complet,' (X ',ax.promotion_etude,')')
                 AS display_name_ax,
            COUNT(*) AS nbMatches
        FROM fusionax_anciens AS ax
        INNER JOIN fusionax_import AS i ON (
            i.id_ancien = ax.id_ancien AND i.user_id IS NULL)
        LEFT JOIN fusionax_xorg_anciens AS xorg ON (
            xorg.matricule_ax IS NULL AND 
            ax.Nom_complet = xorg.nom AND
            ax.prenom = xorg.prenom AND
            xorg.promo = ax.promotion_etude)
        GROUP BY xorg.user_id
        HAVING
            xorg.user_id IS NOT NULL AND
            nbMatches = 1
            ".($limit?('LIMIT '.$limit):''));
        if ($easy_to_link->total() > 0 || $sure) {
            return $easy_to_link;
        }
        return XDB::iterator(" 
        SELECT 
            xorg.display_name, xorg.promo, xorg.user_id, ax.id_ancien,
            CONCAT(ax.prenom,' ',ax.nom_complet,' (X ',ax.promotion_etude,')')
                 AS display_name_ax,
            COUNT(*) AS nbMatches
        FROM fusionax_anciens AS ax
        INNER JOIN fusionax_import AS i ON (
            i.id_ancien = ax.id_ancien AND i.user_id IS NULL)
        LEFT JOIN fusionax_xorg_anciens AS xorg ON (
            xorg.matricule_ax IS NULL AND 
            (ax.Nom_complet = xorg.nom
                 OR ax.Nom_complet LIKE CONCAT(xorg.nom,' %')
                 OR ax.Nom_complet LIKE CONCAT(xorg.nom,'-%')
                 OR ax.Nom_usuel = xorg.nom
                 OR xorg.nom LIKE CONCAT('% ',ax.Nom_complet)) AND
            xorg.promo < ax.promotion_etude + 2 AND
            xorg.promo > ax.promotion_etude - 2)
        GROUP BY xorg.user_id
        HAVING
            xorg.user_id IS NOT NULL AND
            nbMatches = 1
        ".($limit?('LIMIT '.$limit):''));
    }

    /** Module de mise en correspondance les ids */
    function handler_ids(
        &$page,
        $part = 'main',
        $user_id = null,
        $matricule_ax = null)
    {
        global $globals;
        $page->addJsLink('jquery.js');

        $page->assign(
            'xorg_title',
            'Polytechnique.org - Fusion - Mise en correspondance simple');
        if ($part == 'missingInAX')
        {
            // locate all persons from this database that are not in AX's
            $page->changeTpl('fusionax/idsMissingInAx.tpl');
            $missingInAX = XDB::iterator("SELECT 
                u.promo, u.user_id, u.display_name
                FROM fusionax_xorg_anciens AS u
                    WHERE u.matricule_ax IS NULL
                    LIMIT 20");
            $page->assign('missingInAX', $missingInAX);
            return;
        }
        if ($part == 'missingInXorg')
        {
            // locate all persons from AX's database that are not here
            $page->changeTpl('fusionax/idsMissingInXorg.tpl');
            $missingInXorg = XDB::iterator("SELECT
                a.promotion_etude AS promo,
                CONCAT(a.prenom, ' ',a.Nom_usuel) AS display_name,
                a.id_ancien 
                FROM fusionax_import 
                    INNER JOIN fusionax_anciens AS a USING (id_ancien)
                    WHERE fusionax_import.user_id IS NULL
                    LIMIT 20");
            $page->assign('missingInXorg', $missingInXorg);
            return;
        }
        if ($part == 'link')
        {
            FusionAxModule::link_by_ids($user_id,$matricule_ax);
            exit;
        }
        if ($part == 'linknext')
        {
            $linksToDo = FusionAxModule::find_easy_to_link(10);
            while ($l = $linksToDo->next())
            {
                FusionAxModule::link_by_ids($l['user_id'],$l['id_ancien']);
            }
            pl_redirect('fusionax/ids#autolink');
        }
        if ($part == 'linkall')
        {
            $linksToDo = FusionAxModule::find_easy_to_link(0);
            while ($l = $linksToDo->next())
            {
                FusionAxModule::link_by_ids($l['user_id'],$l['id_ancien']);
            }
        }
        {
            $page->changeTpl('fusionax/ids.tpl');
            $missingInAX = XDB::query(
                'SELECT COUNT(*)
                FROM fusionax_xorg_anciens AS u
                WHERE u.matricule_ax IS NULL');
            if ($missingInAX)
            {
                $page->assign('nbMissingInAX', $missingInAX->fetchOneCell());
            }
            $missingInXorg = XDB::query(
                'SELECT COUNT(*)
                FROM fusionax_import AS i
                WHERE i.user_id IS NULL');
            if ($missingInXorg)
            {
                $page->assign(
                    'nbMissingInXorg',
                    $missingInXorg->fetchOneCell());
            }
            $easyToLink = FusionAxModule::find_easy_to_link(10);
            if ($easyToLink->total() > 0)
            { 
                $page->assign('easyToLink', $easyToLink);
            }
        }
    }

    function handler_misc(&$page)
    {
        $page->changeTpl('fusionax/misc.tpl');
        // deceased
        $deceasedErrorsSql = XDB::query(
            'SELECT COUNT(*) FROM fusionax_deceased');
        $page->assign('deceasedErrors',$deceasedErrorsSql->fetchOneCell());
        $page->assign('deceasedMissingInXorg',XDB::iterator(
            'SELECT
                d.user_id,d.id_ancien,d.nom,d.prenom,d.promo,d.deces_ax,
                CONCAT(d.prenom, " ", d.nom) AS display_name
            FROM fusionax_deceased AS d
            WHERE d.deces_xorg = "0000-00-00"
            LIMIT 10'));
        $page->assign('deceasedMissingInAX',XDB::iterator(
            'SELECT
                d.user_id,d.id_ancien,d.nom,d.prenom,d.promo,d.deces_xorg,
                CONCAT(d.prenom, " ", d.nom) AS display_name
            FROM fusionax_deceased AD d
            WHERE d.deces_ax = "0000-00-00"
            LIMIT 10'));
        $page->assign('deceasedDifferent',XDB::iterator(
            'SELECT
                d.user_id,d.id_ancien,d.nom,d.prenom,d.promo,
                d.deces_ax,d.deces_xorg,
                CONCAT(d.prenom, " ", d.nom) AS display_name
            FROM fusionax_deceased AS d
            WHERE d.deces_xorg != "0000-00-00" AND d.deces_ax != "0000-00-00"
            LIMIT 10'));
    }
}

// vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:?>