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