Puts «» around prenom.nom.

[platal.git] / include / validations.inc.php

<?php
/***************************************************************************
 *  Copyright (C) 2003-2009 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                *
 ***************************************************************************/

define('SIZE_MAX', 32768);

global $globals;
require_once $globals->spoolroot . '/core/classes/xdb.php';

/**
 * Iterator class, that lists objects through the database
 */
class ValidateIterator extends XOrgDBIterator
{
    // {{{ constuctor

    public function __construct ()
    {
        parent::__construct('SELECT data, DATE_FORMAT(stamp, "%Y%m%d%H%i%s") FROM requests ORDER BY stamp', MYSQL_NUM);
    }

    // }}}
    // {{{ function next()

    public function next ()
    {
        if (list($result, $stamp) = parent::next()) {
            $result = Validate::unserialize($result);
            $result->stamp = $stamp;
            return($result);
        } else {
            return null;
        }
    }

    // }}}
}

/** classe "virtuelle" à dériver pour chaque nouvelle implémentation
 */
abstract class Validate
{
    // {{{ properties

    public $user;

    public $stamp;
    public $unique;
    // enable the refuse button
    public $refuse = true;

    public $type;
    public $comments = Array();
    // the validations rules : comments for admins
    public $rules = "Mieux vaut laisser une demande de validation à un autre admin que de valider une requête illégale ou que de refuser une demande légitime";

    // }}}
    // {{{ constructor

    /** constructeur
     * @param       $_user      user object
     * @param       $_unique    requête pouvant être multiple ou non
     * @param       $_type      type de la donnée comme dans le champ type de x4dat.requests
     */
    public function __construct(User &$_user, $_unique, $_type)
    {
        $this->user   = &$_user;
        $this->stamp  = date('YmdHis');
        $this->unique = $_unique;
        $this->type   = $_type;
    }

    // }}}
    // {{{ function submit()

    /** fonction à utiliser pour envoyer les données à la modération
     * cette fonction supprimme les doublons sur un couple ($user,$type) si $this->unique est vrai
     */
    public function submit()
    {
        if ($this->unique) {
            XDB::execute('DELETE FROM requests WHERE user_id={?} AND type={?}', $this->user->id(), $this->type);
        }

        $this->stamp = date('YmdHis');
        XDB::execute('INSERT INTO requests (user_id, type, data, stamp) VALUES ({?}, {?}, {?}, {?})',
                $this->user->id(), $this->type, $this, $this->stamp);

        global $globals;
        $globals->updateNbValid();
        return true;
    }

    // }}}
    // {{{ function update()

    protected function update()
    {
        XDB::execute('UPDATE requests SET data={?}, stamp=stamp
                       WHERE user_id={?} AND type={?} AND stamp={?}',
                     $this, $this->user->id(), $this->type, $this->stamp);
        return true;
    }

    // }}}
    // {{{ function clean()

    /** fonction à utiliser pour nettoyer l'entrée de la requête dans la table requests
     * attention, tout est supprimé si c'est un unique
     */
    public function clean()
    {
        global $globals;

        if ($this->unique) {
            $success = XDB::execute('DELETE FROM requests WHERE user_id={?} AND type={?}',
                                    $this->user->id(), $this->type);
        } else {
            $success =  XDB::execute('DELETE FROM requests WHERE user_id={?} AND type={?} AND stamp={?}',
                                      $this->user->id(), $this->type, $this->stamp);
        }
        $globals->updateNbValid();
        return $success;
    }

    // }}}
    // {{{ function handle_formu()

    /** fonction à réaliser en cas de validation du formulaire
     */
    public function handle_formu()
    {
        if (Env::has('delete')) {
            $this->clean();
            $this->trigSuccess('Requête supprimée');
            return true;
        }

        // mise à jour des informations
        if (Env::has('edit')) {
            if ($this->handle_editor()) {
                $this->update();
                $this->trigSuccess('Requête mise à jour');
                return true;
            }
            return false;
        }

        // ajout d'un commentaire
        if (Env::has('hold') && Env::has('comm')) {
            $formid = Env::i('formid');
            foreach ($this->comments as $comment) {
                if ($comment[2] === $formid) {
                    return true;
                }
            }
            if (!strlen(trim(Env::v('comm')))) {
                return true;
            }
            $this->comments[] = Array(S::user()->login(), Env::v('comm'), $formid);

            // envoi d'un mail à hotliners
            global $globals;
            $mailer = new PlMailer();
            $mailer->setSubject("Commentaires de validation {$this->type}");
            $mailer->setFrom("validation+{$this->type}@{$globals->mail->domain}");
            $mailer->addTo($globals->core->admin_email);

            $body = "Validation {$this->type} pour {$this->user->login()}\n\n"
              . S::user()->login() . " a ajouté le commentaire :\n\n"
              . Env::v('comm') . "\n\n"
              . "cf la discussion sur : " . $globals->baseurl . "/admin/validate";

            $mailer->setTxtBody(wordwrap($body));
            $mailer->send();

            $this->update();
            $this->trigSuccess('Commentaire ajouté');
            return true;
        }

        if (Env::has('accept')) {
            if ($this->commit()) {
                $this->sendmail(true);
                $this->clean();
                $this->trigSuccess('Email de validation envoyé');
                return true;
            } else {
                $this->trigError('Erreur lors de la validation');
                return false;
            }
        }

        if (Env::has('refuse')) {
            if (Env::v('comm')) {
                $this->sendmail(false);
                $this->clean();
                $this->trigSuccess('Email de refus envoyé');
                return true;
            } else {
                $this->trigError('pas de motivation pour le refus !!!');
            }
        }

        return false;
    }

    // }}}
    // {{{ function sendmail

    protected function sendmail($isok)
    {
        global $globals;
        $mailer = new PlMailer();
        $mailer->setSubject($this->_mail_subj());
        $mailer->setFrom("validation+{$this->type}@{$globals->mail->domain}");
        $mailer->addTo("\"{$this->user->fullName()}\" <{$this->user->bestEmail()}>");
        $mailer->addCc("validation+{$this->type}@{$globals->mail->domain}");

        $body = ($this->user->isFemale() ? "Chère camarade,\n\n" : "Cher camarade,\n\n")
              . $this->_mail_body($isok)
              . (Env::has('comm') ? "\n\n" . Env::v('comm') : '')
              . "\n\nCordialement,\n-- \nL'équipe de Polytechnique.org\n"
              . $this->_mail_ps($isok);

        $mailer->setTxtBody(wordwrap($body));
        $mailer->send();
    }

    // }}}
    // {{{ function trig()

    protected function trigError($msg)
    {
        Platal::page()->trigError($msg);
    }

    protected function trigWarning($msg)
    {
        Platal::page()->trigWarning($msg);
    }

    protected function trigSuccess($msg)
    {
        Platal::page()->trigSuccess($msg);
    }

    // }}}
    // {{{ function get_typed_request()

    /** fonction statique qui renvoie la requête de l'utilisateur d'id $uidau timestamp $t
     * @param   $uid    l'id de l'utilisateur concerné
     * @param   $type   le type de la requête
     * @param   $stamp  le timestamp de la requête
     *
     * XXX fonction "statique" XXX
     * à utiliser uniquement pour récupérer un objet dans la BD avec Validate::get_typed_request(...)
     */
    static public function get_typed_request($uid, $type, $stamp = -1)
    {
        if ($stamp == -1) {
            $res = XDB::query('SELECT data FROM requests WHERE user_id={?} and type={?}', $uid, $type);
        } else {
            $res = XDB::query('SELECT data, DATE_FORMAT(stamp, "%Y%m%d%H%i%s") FROM requests WHERE user_id={?} AND type={?} and stamp={?}', $uid, $type, $stamp);
        }
        if ($result = $res->fetchOneCell()) {
            $result = Validate::unserialize($result);
        } else {
            $result = false;
        }
        return($result);
    }

    // }}}
    // {{{ function get_request_by_id()

    static public function get_request_by_id($id)
    {
        list($uid, $type, $stamp) = explode('_', $id, 3);
        return Validate::get_typed_request($uid, $type, $stamp);
    }

    // }}}
    // {{{ function get_typed_requests()

    /** same as get_typed_request() but return an array of objects
     */
    static public function get_typed_requests($uid, $type)
    {
        $res = XDB::iterRow('SELECT data FROM requests WHERE user_id={?} and type={?}', $uid, $type);
        $array = array();
        while (list($data) = $res->next()) {
            $array[] = Validate::unserialize($data);
        }
        return $array;
    }

    // }}}
    // {{{ function get_typed_requests_count()

    /** same as get_typed_requests() but return the count of available requests.
     */
    static public function get_typed_requests_count($uid, $type)
    {
        $res = XDB::query('SELECT COUNT(data) FROM requests WHERE user_id={?} and type={?}', $uid, $type);
        return $res->fetchOneCell();
    }

    // }}}
    // {{{ function _mail_body

    abstract protected function _mail_body($isok);

    // }}}
    // {{{ function _mail_subj

    abstract protected function _mail_subj();

    // }}}
    // {{{ function _mail_ps

    protected function _mail_ps($isok)
    {
        return '';
    }

    // }}}
    // {{{ function commit()

    /** fonction à utiliser pour insérer les données dans x4dat
     */
    abstract public function commit();

    // }}}
    // {{{ function formu()

    /** nom du template qui contient le formulaire */
    abstract public function formu();

    // }}}
    // {{{ function editor()

    /** nom du formulaire d'édition */
    public function editor()
    {
        return null;
    }

    // }}}
    // {{{ function answers()

    /** automatic answers table for this type of validation */
    public function answers()
    {
        static $answers_table;
        if (!isset($answers_table[$this->type])) {
            $r = XDB::query("SELECT id, title, answer FROM requests_answers WHERE category = {?}", $this->type);
            $answers_table[$this->type] = $r->fetchAllAssoc();
        }
        return $answers_table[$this->type];
    }

    // }}}
    // {{{ function id()

    public function id()
    {
        return $this->user->id() . '_' . $this->type . '_' . $this->stamp;
    }

    // }}}
    // {{{ function ruleText()

    public function ruleText()
    {
        return str_replace('\'', '\\\'', $this->rules);
    }

    // }}}
    // {{{ function unserialize()
    public static function unserialize($data)
    {
        $obj = unserialize($data);
        /* XXX: Temporary for hruid migration */
        if (!isset($obj->user) || !is_object($obj)) {
            $obj->user =& User::get($obj->forlife);
        }
        /* XXX: End temporary block */
        return $obj;
    }
}

foreach (glob(dirname(__FILE__).'/validations/*.inc.php') as $file) {
    require_once($file);
}

/* vim: set expandtab shiftwidth=4 tabstop=4 softtabstop=4 foldmethod=marker enc=utf-8: */
?>