www/plugins/formidable_1_0/inc/formidable.php

   1 <?php
   2
   3 // Sécurité
   4 if (!defined("_ECRIRE_INC_VERSION")) return;
   5
   6 /*
   7  * Liste tous les traitements configurables (ayant une description)
   8  *
   9  * @return array Un tableau listant des saisies et leurs options
  10  */
  11 function traitements_lister_disponibles(){
  12     static $traitements = null;
  13
  14     if (is_null($traitements)){
  15         $traitements = array();
  16         $liste = find_all_in_path('traiter/', '.+[.]yaml$');
  17
  18         if (count($liste)){
  19             foreach ($liste as $fichier=>$chemin){
  20                 $type_traitement = preg_replace(',[.]yaml$,i', '', $fichier);
  21                 $dossier = str_replace($fichier, '', $chemin);
  22                 // On ne garde que les traitements qui ont bien la fonction
  23                 if (charger_fonction($type_traitement, 'traiter', true)
  24                     and (
  25                         is_array($traitement = traitements_charger_infos($type_traitement))
  26                     )
  27                 ){
  28                     $traitements[$type_traitement] = $traitement;
  29                 }
  30             }
  31         }
  32     }
  33
  34     return $traitements;
  35 }
  36
  37 /**
  38  * Charger les informations contenues dans le yaml d'un traitement
  39  *
  40  * @param string $type_saisie Le type de la saisie
  41  * @return array Un tableau contenant le YAML décodé
  42  */
  43 function traitements_charger_infos($type_traitement){
  44     include_spip('inc/yaml');
  45     $fichier = find_in_path("traiter/$type_traitement.yaml");
  46     $traitement = yaml_decode_file($fichier);
  47
  48     if (is_array($traitement)) {
  49         $traitement += array('titre' => '', 'description' => '', 'icone' => '');
  50         $traitement['titre'] = $traitement['titre'] ? _T_ou_typo($traitement['titre']) : $type_traitement;
  51         $traitement['description'] = $traitement['description'] ? _T_ou_typo($traitement['description']) : '';
  52         $traitement['icone'] = $traitement['icone'] ? find_in_path($traitement['icone']) : '';
  53     }
  54     return $traitement;
  55 }
  56
  57 /*
  58  * Liste tous les types d'échanges (export et import) existant pour les formulaires
  59  *
  60  * @return array Retourne un tableau listant les types d'échanges
  61  */
  62 function echanges_formulaire_lister_disponibles(){
  63     // On va chercher toutes les fonctions existantes
  64     $liste = find_all_in_path('echanger/formulaire/', '.+[.]php$');
  65     $types_echange = array('exporter'=>array(), 'importer'=>array());
  66     if (count($liste)){
  67         foreach ($liste as $fichier=>$chemin){
  68             $type_echange = preg_replace(',[.]php$,i', '', $fichier);
  69             $dossier = str_replace($fichier, '', $chemin);
  70             // On ne garde que les échanges qui ont bien la fonction
  71             if ($f = charger_fonction('exporter', "echanger/formulaire/$type_echange", true)){
  72                 $types_echange['exporter'][$type_echange] = $f;
  73             }
  74             if ($f = charger_fonction('importer', "echanger/formulaire/$type_echange", true)){
  75                 $types_echange['importer'][$type_echange] = $f;
  76             }
  77         }
  78     }
  79     return $types_echange;
  80 }
  81
  82 /*
  83  * Génère le nom du cookie qui sera utilisé par le plugin lors d'une réponse
  84  * par un visiteur non-identifié.
  85  *
  86  * @param int $id_formulaire L'identifiant du formulaire
  87  * @return string Retourne le nom du cookie
  88  */
  89 function formidable_generer_nom_cookie($id_formulaire){
  90     return $GLOBALS['cookie_prefix'].'cookie_formidable_'.$id_formulaire;
  91 }
  92
  93 /*
  94  * Vérifie si le visiteur a déjà répondu à un formulaire
  95  *
  96  * @param int $id_formulaire L'identifiant du formulaire
  97  * @param string $choix_identification Comment verifier une reponse. Priorite sur 'cookie' ou sur 'id_auteur'
  98  * @param string $anonymisation : vaut '' si le formulaire n'est pas anonymisé, sinon c'est la variable d'anonymisation
  99  * @return unknown_type Retourne un tableau contenant les id des réponses si elles existent, sinon false
 100  */
 101 function formidable_verifier_reponse_formulaire($id_formulaire, $choix_identification='cookie', $anonymisation=''){
 102     global $auteur_session;
 103     $id_auteur = $auteur_session ? intval($auteur_session['id_auteur']) : 0;
 104     $nom_cookie = formidable_generer_nom_cookie($id_formulaire);
 105     $cookie = isset($_COOKIE[$nom_cookie]) ? $_COOKIE[$nom_cookie] : false;
 106
 107     $anonymiser = ($anonymisation == '') ? false : true;
 108     if ($anonymiser) $anonymiser_variable = $anonymisation;
 109
 110     // traitement de l'anonymisation
 111     if ($anonymiser) {
 112         // mod de l'id_auteur
 113         $variables_anonymisation =
 114                 $GLOBALS['formulaires']['variables_anonymisation'][$anonymiser_variable];
 115         $id = eval("return $variables_anonymisation;");
 116         $id_auteur = formidable_scramble($id);
 117     }
 118     // ni cookie ni id, on ne peut rien faire
 119     if (!$cookie and !$id_auteur) {
 120         return false;
 121     }
 122
 123     // priorite sur le cookie
 124     if ($choix_identification == 'cookie' or !$choix_identification) {
 125         if ($cookie)
 126             $where = '(cookie='.sql_quote($cookie).($id_auteur ? ' OR id_auteur='.$id_auteur.')' : ')');
 127         else
 128             $where = 'id_auteur='.$id_auteur;
 129     }
 130
 131     // sinon sur l'id_auteur
 132     else {
 133         if ($id_auteur)
 134             $where = 'id_auteur='.$id_auteur;
 135         else
 136             $where = '(cookie='.sql_quote($cookie).($id_auteur ? ' OR id_auteur='.$id_auteur.')' : ')');
 137     }
 138
 139     $reponses = sql_allfetsel(
 140         'id_formulaires_reponse',
 141         'spip_formulaires_reponses',
 142         array(
 143             array('=', 'id_formulaire', intval($id_formulaire)),
 144             array('=', 'statut', sql_quote('publie')),
 145             $where
 146         ),
 147         '',
 148         'date'
 149     );
 150
 151     if (is_array($reponses))
 152         return array_map('reset', $reponses);
 153     else
 154         return false;
 155 }
 156
 157 /*
 158  * Génère la vue d'analyse de toutes les réponses à une saisie
 159  *
 160  * @param array $saisie Un tableau décrivant une saisie
 161  * @param array $env L'environnement, contenant normalement la réponse à la saisie
 162  * @return string Retour le HTML des vues
 163  */
 164 function formidable_analyser_saisie($saisie, $valeurs=array(), $reponses_total=0, $format_brut=false) {
 165     // Si le paramètre n'est pas bon ou que c'est un conteneur, on génère du vide
 166     if (!is_array($saisie) or (isset($saisie['saisies']) and $saisie['saisies']))
 167         return '';
 168
 169     $contexte = array('reponses_total'=>$reponses_total);
 170
 171     // On sélectionne le type de saisie
 172     $contexte['type_saisie'] = $saisie['saisie'];
 173
 174     // Peut-être des transformations à faire sur les options textuelles
 175     $options = $saisie['options'];
 176     foreach ($options as $option => $valeur){
 177         $options[$option] = _T_ou_typo($valeur, 'multi');
 178     }
 179
 180     // On ajoute les options propres à la saisie
 181     $contexte = array_merge($contexte, $options);
 182
 183     // On récupère toutes les valeurs du champ
 184     if (isset($valeurs[$contexte['nom']]) and $valeurs[$contexte['nom']] and is_array($valeurs[$contexte['nom']])){
 185         $contexte['valeurs'] = $valeurs[$contexte['nom']];
 186     }
 187     else{
 188         $contexte['valeurs'] = array();
 189     }
 190
 191     // On génère la saisie
 192     if ($format_brut) {
 193         return analyser_saisie($contexte);
 194     } else {
 195         return recuperer_fond(
 196             'saisies-analyses/_base',
 197             $contexte
 198         );
 199     }
 200 }
 201
 202 /*
 203  * Renvoie une ligne de réponse sous la forme d'un tableau
 204  *
 205  * @param array $saisie Un tableau décrivant une saisie
 206  * @return array Tableau contenant une ligne
 207  */
 208 function analyser_saisie($saisie) {
 209     if (!isset($saisie['type_saisie']) or $saisie['type_saisie'] == '')
 210         return '';
 211
 212     $ligne = array();
 213
 214     switch($saisie['type_saisie']) {
 215         case 'selecteur_rubrique' :
 216         case 'selecteur_rubrique_article' :
 217         case 'selecteur_article' :
 218             $ligne['plein'] = count(array_filter($saisie['valeurs']));
 219             $ligne['vide'] = count(array_diff_key($saisie['valeurs']
 220                 , array_filter($saisie['valeurs'])));
 221         break;
 222         case 'radio' :
 223         case 'selection' :
 224         case 'selection_multiple' :
 225         case 'checkbox' :
 226             $stats = array();
 227             foreach($saisie['valeurs'] as $valeur) {
 228                 if (is_array($valeur)) {
 229                     foreach($valeur as $choix) {
 230                         if (isset($stats["choix-$choix"]))
 231                             $stats["choix-$choix"]++;
 232                         else $stats["choix-$choix"] = 1;
 233                     }
 234                 } else {
 235                     if (isset($stats["choix-$valeur"]))
 236                             $stats["choix-$valeur"]++;
 237                         else $stats["choix-$valeur"] = 1;
 238                 }
 239             }
 240             $datas = is_string($saisie['datas'])
 241                 ? saisies_chaine2tableau($saisie['datas'])
 242                 : $saisie['datas'];
 243             foreach($datas as $key => $val) {
 244                 $nb = (isset($stats["choix-$key"]))
 245                     ? $stats["choix-$key"]
 246                     : 0;
 247                 $ligne[$val] = $nb;
 248             }
 249         break;
 250         case 'destinataires' :
 251             $stats = array();
 252             foreach($saisie['valeurs'] as $valeur) {
 253                 foreach($valeur as $choix) {
 254                     if (isset($stats["choix-$choix"]))
 255                         $stats["choix-$choix"]++;
 256                     else $stats["choix-$choix"] = 1;
 257                 }
 258             }
 259             foreach($stats as $key => $val) {
 260                 $key = str_replace('choix-', '', $key);
 261                 if ($key == '') $key = '<valeur vide>';
 262                 $auteur = sql_getfetsel('nom','spip_auteurs',"id_auteur=$key");
 263                 $ligne[$auteur] = $val;
 264             }
 265         break;
 266     }
 267
 268     $vide = 0;
 269     foreach($saisie['valeurs'] as $valeur) {
 270         if ($valeur == '') $vide++;
 271         switch($saisie['type_saisie']) {
 272             case 'case' :
 273             case 'oui_non' :
 274                 if(isset($ligne['oui']) == false) $ligne['oui'] = 0;
 275                 if(isset($ligne['non']) == false) $ligne['non'] = 0;
 276                 if ($valeur) $ligne['oui']++; else $ligne['non']++;
 277             break;
 278             case 'input' :
 279             case 'hidden' :
 280             case 'explication' :
 281             break;
 282         }
 283     }
 284     $ligne['sans_reponse'] = $vide;
 285     $ligne['header'] = $saisie['label'] != ''
 286         ? $saisie['label']
 287         : $saisie['type_saisie'];
 288
 289     return $ligne;
 290 }
 291
 292
 293 /**
 294  * Tente de déserialiser un texte
 295  *
 296  * Si le paramètre est un tableau, retourne le tableau,
 297  * Si c'est une chaîne, tente de la désérialiser, sinon
 298  * retourne la chaîne.
 299  *
 300  * @filtre tenter_unserialize
 301  *
 302  * @param string|array $texte
 303  *     Le texte (possiblement sérializé) ou un tableau
 304  * @return array|string
 305  *     Tableau, texte désérializé ou texte
 306 **/
 307 function filtre_tenter_unserialize_dist($texte) {
 308     if (is_array($texte)) {
 309         return $texte;
 310     }
 311     if ($tmp = @unserialize($texte)) {
 312         return $tmp;
 313     }
 314     return $texte;
 315 }
 316
 317
 318 /**
 319  * Retourne un texte du nombre de réponses
 320  *
 321  * @param int $nb
 322  *     Nombre de réponses
 323  * @return string
 324  *     Texte indiquant le nombre de réponses
 325 **/
 326 function titre_nb_reponses($nb) {
 327     if (!$nb) return _T('formidable:reponse_aucune');
 328     if ($nb == 1) return _T('formidable:reponse_une');
 329     return _T('formidable:reponses_nb', array('nb' => $nb));
 330 }
 331
 332 /**
 333  * Transforme le hash MD5 en une valeur numérique unique
 334  *
 335  * trouvé ici : http://stackoverflow.com/questions/1422725/represent-md5-hash-as-an-integer
 336  * @param string $hex_str La valeur alphanumérique à transformer
 337  * @return string Valeur numérique
 338 */
 339 function md5_hex_to_dec($hex_str) {
 340     $arr = str_split($hex_str, 4);
 341     foreach ($arr as $grp) {
 342         $dec[] = str_pad(hexdec($grp), 5, '0', STR_PAD_LEFT);
 343     }
 344
 345     /* on s'assure que $result ne commence pas par un zero */
 346     $result = implode('', $dec);
 347     for ($cpt = 0 ; $cpt < strlen($result) ; $cpt++) {
 348         if ($result[$cpt] != '0') break;
 349     }
 350     $result = substr($result, $cpt);
 351     return $result;
 352 }
 353
 354 /**
 355  * Transforme un login en une valeur numérique de 19 caractères
 356  *
 357  * NOTE: il devient impossible de retrouver la valeur d'origine car le HASH
 358  * est coupé à 19cars et est donc incomplet. L'unicité n'est pas garantie mais
 359  * les chances pour que deux logins tombent sur le même HASH sont de 1 sur
 360  * 10 milliards de milliards
 361  * A la fin, on recherche et supprime les éventuels zéros de début
 362  * @param string $login Login à transformer
 363  * @param string $passwd Chaîne 'secrète' ajoutée au login et id_formulaire pour éviter
 364  *  les recoupements d'identité entre plusieurs formulaires
 365  * @return string Un nombre de 19 chiffres
 366 */
 367 function formidable_scramble($login, $passwd = '') {
 368     $id_form = (isset($flux['args']['id_form']) ? $flux['args']['id_form'] : '');
 369     if ($passwd == '')
 370         $passwd = $GLOBALS['formulaires']['passwd']['interne'];
 371     $login_md5 = md5("$login$passwd$id_form");
 372     $login_num = md5_hex_to_dec($login_md5);
 373     $login_num = substr($login_num, 0, 19);
 374
 375     return $login_num;
 376 }
 377
 378 ?>