source: spip-zone/_plugins_/formidable/trunk/inc/formidable.php @ 115440

Last change on this file since 115440 was 115440, checked in by maieul@…, 18 months ago

Suite question de Florence Henry sur contrib, ajout d'une nouvelle
méthode d'identification de la réponse à éditer : par passage explicite
de l'identifiant, sans tenir compte ni du cookie, ni de l'id_auteur.

File size: 18.3 KB
Line 
1<?php
2
3// Sécurité
4if (!defined('_ECRIRE_INC_VERSION')) {
5        return;
6}
7
8/*
9 * Liste tous les traitements configurables (ayant une description)
10 *
11 * @return array Un tableau listant des saisies et leurs options
12 */
13function traitements_lister_disponibles() {
14        static $traitements = null;
15
16        if (is_null($traitements)) {
17                $traitements = array();
18                $liste = find_all_in_path('traiter/', '.+[.]yaml$');
19                ksort($liste);
20
21                if (count($liste)) {
22                        foreach ($liste as $fichier => $chemin) {
23                                $type_traitement = preg_replace(',[.]yaml$,i', '', $fichier);
24                                // On ne garde que les traitements qui ont bien la fonction
25                                if (charger_fonction($type_traitement, 'traiter', true)
26                                        and (
27                                                is_array($traitement = traitements_charger_infos($type_traitement))
28                                        )
29                                ) {
30                                        $traitements[$type_traitement] = $traitement;
31                                }
32                        }
33                }
34        }
35
36        return $traitements;
37}
38
39/**
40 * Charger les informations contenues dans le yaml d'un traitement
41 *
42 * @param string $type_saisie Le type de la saisie
43 * @return array Un tableau contenant le YAML décodé
44 */
45function traitements_charger_infos($type_traitement) {
46        include_spip('inc/yaml');
47        $fichier = find_in_path("traiter/$type_traitement.yaml");
48        $traitement = yaml_decode_file($fichier);
49
50        if (is_array($traitement)) {
51                $traitement += array('titre' => '', 'description' => '', 'icone' => '');
52                $traitement['titre'] = $traitement['titre'] ? _T_ou_typo($traitement['titre']) : $type_traitement;
53                $traitement['description'] = $traitement['description'] ? _T_ou_typo($traitement['description']) : '';
54                $traitement['icone'] = $traitement['icone'] ? find_in_path($traitement['icone']) : '';
55        }
56        return $traitement;
57}
58
59/*
60 * Liste tous les types d'échanges (export et import) existant pour les formulaires
61 *
62 * @return array Retourne un tableau listant les types d'échanges
63 */
64function echanges_formulaire_lister_disponibles() {
65        // On va chercher toutes les fonctions existantes
66        $liste = find_all_in_path('echanger/formulaire/', '.+[.]php$');
67        $types_echange = array('exporter' => array(), 'importer' => array());
68        if (count($liste)) {
69                foreach ($liste as $fichier => $chemin) {
70                        $type_echange = preg_replace(',[.]php$,i', '', $fichier);
71
72                        // On ne garde que les échanges qui ont bien la fonction
73                        if ($f = charger_fonction('exporter', "echanger/formulaire/$type_echange", true)) {
74                                $types_echange['exporter'][$type_echange] = $f;
75                        }
76                        if ($f = charger_fonction('importer', "echanger/formulaire/$type_echange", true)) {
77                                $types_echange['importer'][$type_echange] = $f;
78                        }
79                }
80        }
81        return $types_echange;
82}
83
84/*
85 * Génère le nom du cookie qui sera utilisé par le plugin lors d'une réponse
86 * par un visiteur non-identifié.
87 *
88 * @param int $id_formulaire L'identifiant du formulaire
89 * @return string Retourne le nom du cookie
90 */
91function formidable_generer_nom_cookie($id_formulaire) {
92        return $GLOBALS['cookie_prefix'].'cookie_formidable_'.$id_formulaire;
93}
94
95
96/*
97 * Trouver la réponse à éditer pour un formulaire donné,
98 * dans un contexte donné
99 * en fonction de la configuration du formulaire.
100 * @param int $id_formulaire L'identifiant du formulaire
101 * @param int $id_formulaires_reponse L'identifant de réponse passé au moment de l'appel du formulaire
102 * @param array $options Les options d'enregistrement du formulaire
103 * @param boolean $verifier_est_auteur si égal à true, on vérifie si $id_formulaires_reponse est passé que l'auteur connecté est bien l'auteur de la réponse passée en argument
104 * @return int $id_formulaires_reponse L'identifiant de la réponse à modifier effectivement.
105 *
106 */
107function formidable_trouver_reponse_a_editer($id_formulaire, $id_formulaires_reponse, $options, $verifier_est_auteur = false) {
108        // Si on passe un identifiant de reponse, on edite cette reponse si elle existe
109        if ($id_formulaires_reponse = intval($id_formulaires_reponse) and ($verifier_est_auteur == false or $options['identification'] == 'id_reponse')) {
110                return $id_formulaires_reponse;
111        } else {
112                // calcul des paramètres d'anonymisation
113
114                $reponses = formidable_verifier_reponse_formulaire(
115                        $id_formulaire,
116                        $options['identification'],
117                        $options['variable_php']
118                );
119
120                //A-t-on demandé de vérifier que l'auteur soit bien celui de la réponse?
121                if ($id_formulaires_reponse = intval($id_formulaires_reponse)
122                        and $verifier_est_auteur == true) {
123                        if (!is_array($reponses) or in_array($id_formulaires_reponse, $reponses) == false) {
124                                $id_formulaires_reponse = false;
125                        }
126                        return $id_formulaires_reponse;
127                }
128
129                // Si multiple = non mais que c'est modifiable, alors on va chercher
130                // la dernière réponse si elle existe
131                if ($options
132                        and !$options['multiple']
133                        and $options['modifiable']
134                        and is_array($reponses)
135                        ) {
136                                $id_formulaires_reponse = array_pop($reponses);
137                }
138        }
139        return $id_formulaires_reponse;
140}
141
142/*
143 * Vérifie si le visiteur a déjà répondu à un formulaire
144 *
145 * @param int $id_formulaire L'identifiant du formulaire
146 * @param string $choix_identification Comment verifier une reponse. Priorite sur 'cookie' ou sur 'id_auteur'
147 * @param string $variable_php_identification : la variable php servant à identifier une réponse
148 * @return unknown_type Retourne un tableau contenant les id des réponses si elles existent, sinon false
149 */
150function formidable_verifier_reponse_formulaire($id_formulaire, $choix_identification = 'cookie', $variable_php_identification = '') {
151        global $auteur_session;
152        $id_auteur = $auteur_session ? intval($auteur_session['id_auteur']) : 0;
153        $nom_cookie = formidable_generer_nom_cookie($id_formulaire);
154        $cookie = isset($_COOKIE[$nom_cookie]) ? $_COOKIE[$nom_cookie] : false;
155        $variable_php_identification = formidable_variable_php_identification($variable_php_identification, $id_formulaire);
156
157        // ni cookie ni id, ni variable_php,  on ne peut rien faire
158        if (!$cookie and !$id_auteur and !$variable_php_identification) {
159                return false;
160        }
161
162
163        // Determiner les différentes clauses $WHERE possible en fonction de ce qu'on a
164        $where_id_auteur = '';
165        $where_cookie = '';
166        $where_variable_php = '';
167        if ($id_auteur) {
168                $where_id_auteur = 'id_auteur='.$id_auteur;
169        }
170        if ($cookie) {
171                $where_cookie = 'cookie='.sql_quote($cookie);
172        }
173        if ($variable_php_identification) {
174                $where_variable_php = 'variable_php='.$variable_php_identification;
175        }
176
177        // Comment identifie-t-on? Attention, le choix d'identification indique une PRIORITE, donc cela veut dire que les autres méthodes peuvent venir après
178        if ($choix_identification == 'cookie' or !$choix_identification) {
179                if ($cookie) {
180                        $where = array($where_cookie);
181                } else {
182                        $where = array($where_id_auteur, $where_variable_php);
183                }
184        } elseif ($choix_identification == 'id_auteur') {
185                if ($id_auteur) {
186                        $where = array($where_id_auteur);
187                } else {
188                        $where = array($where_cookie, $where_variable_php);
189                }
190        } elseif ($choix_identification == 'variable_php') {
191                if ($variable_php_identification) {
192                        $where = array($where_variable_php);
193                } else {
194                        $where = array($where_cookie, $where_id_auteur);
195                }
196        }
197        $where = array_filter($where);//Supprimer les wheres null
198        $where = implode($where, ' OR ');
199
200        $reponses = sql_allfetsel(
201                'id_formulaires_reponse',
202                'spip_formulaires_reponses',
203                array(
204                        array('=', 'id_formulaire', intval($id_formulaire)),
205                        array('=', 'statut', sql_quote('publie')),
206                        $where
207                ),
208                '',
209                'date'
210        );
211
212        if (is_array($reponses)) {
213                return array_map('reset', $reponses);
214        } else {
215                return false;
216        }
217}
218
219/*
220 * Génère la vue d'analyse de toutes les réponses à une saisie
221 *
222 * @param array $saisie Un tableau décrivant une saisie
223 * @param array $env L'environnement, contenant normalement la réponse à la saisie
224 * @return string Retour le HTML des vues
225 */
226function formidable_analyser_saisie($saisie, $valeurs = array(), $reponses_total = 0, $format_brut = false) {
227        // Si le paramètre n'est pas bon ou que c'est un conteneur, on génère du vide
228        if (!is_array($saisie) or (isset($saisie['saisies']) and $saisie['saisies'])) {
229                return '';
230        }
231
232        $contexte = array('reponses_total'=>$reponses_total);
233
234        // On sélectionne le type de saisie
235        $contexte['type_saisie'] = $saisie['saisie'];
236
237        // Peut-être des transformations à faire sur les options textuelles
238        $options = $saisie['options'];
239        foreach ($options as $option => $valeur) {
240                $options[$option] = _T_ou_typo($valeur, 'multi');
241        }
242
243        // On ajoute les options propres à la saisie
244        $contexte = array_merge($contexte, $options);
245
246        // On récupère toutes les valeurs du champ
247        if (isset($valeurs[$contexte['nom']])
248                and $valeurs[$contexte['nom']]
249                and is_array($valeurs[$contexte['nom']])) {
250                $contexte['valeurs'] = $valeurs[$contexte['nom']];
251        } else {
252                $contexte['valeurs'] = array();
253        }
254
255        // On génère la saisie
256        if ($format_brut) {
257                return analyser_saisie($contexte);
258        } else {
259                return recuperer_fond(
260                        'saisies-analyses/_base',
261                        $contexte
262                );
263        }
264}
265
266/*
267 * Renvoie une ligne de réponse sous la forme d'un tableau
268 *
269 * @param array $saisie Un tableau décrivant une saisie
270 * @return array Tableau contenant une ligne
271 */
272function analyser_saisie($saisie) {
273        if (!isset($saisie['type_saisie']) or $saisie['type_saisie'] == '') {
274                return '';
275        }
276
277        $ligne = array();
278
279        switch ($saisie['type_saisie']) {
280                case 'selecteur_rubrique':
281                case 'selecteur_rubrique_article':
282                case 'selecteur_article':
283                        $ligne['plein'] = count(array_filter($saisie['valeurs']));
284                        $ligne['vide'] = count(array_diff_key($saisie['valeurs'], array_filter($saisie['valeurs'])));
285                        break;
286                case 'radio':
287                case 'selection':
288                case 'selection_multiple':
289                case 'choix_couleur':
290                case 'checkbox':
291                        $stats = array();
292                        foreach ($saisie['valeurs'] as $valeur) {
293                                if (is_array($valeur)) {
294                                        foreach ($valeur as $choix) {
295                                                if (isset($stats["choix-$choix"])) {
296                                                        $stats["choix-$choix"]++;
297                                                } else {
298                                                        $stats["choix-$choix"] = 1;
299                                                }
300                                        }
301                                } else {
302                                        if (isset($stats["choix-$valeur"])) {
303                                                $stats["choix-$valeur"]++;
304                                        } else {
305                                                $stats["choix-$valeur"] = 1;
306                                        }
307                                }
308                        }
309                        $datas = is_string($saisie['datas'])
310                                ? saisies_chaine2tableau(saisies_aplatir_chaine($saisie['datas']))
311                                : $saisie['datas'];
312                        foreach ($datas as $key => $val) {
313                                $nb = (isset($stats["choix-$key"]))
314                                        ? $stats["choix-$key"]
315                                        : 0;
316                                $ligne[$val] = $nb;
317                        }
318                        break;
319                case 'destinataires':
320                        $stats = array();
321                        foreach ($saisie['valeurs'] as $valeur) {
322                                foreach ($valeur as $choix) {
323                                        if (isset($stats["choix-$choix"])) {
324                                                $stats["choix-$choix"]++;
325                                        } else {
326                                                $stats["choix-$choix"] = 1;
327                                        }
328                                }
329                        }
330                        foreach ($stats as $key => $val) {
331                                $key = str_replace('choix-', '', $key);
332                                if ($key == '') {
333                                        $key = '<valeur vide>';
334                                }
335                                $auteur = sql_getfetsel('nom', 'spip_auteurs', "id_auteur=$key");
336                                $ligne[$auteur] = $val;
337                        }
338                        break;
339        }
340
341        $vide = 0;
342        foreach ($saisie['valeurs'] as $valeur) {
343                if ($valeur == '') {
344                        $vide++;
345                }
346                switch ($saisie['type_saisie']) {
347                        case 'case':
348                        case 'oui_non':
349                                if (isset($ligne['oui']) == false) {
350                                        $ligne['oui'] = 0;
351                                }
352                                if (isset($ligne['non']) == false) {
353                                        $ligne['non'] = 0;
354                                }
355                                if ($valeur) {
356                                        $ligne['oui']++;
357                                } else {
358                                        $ligne['non']++;
359                                }
360                                break;
361                        case 'input':
362                        case 'hidden':
363                        case 'explication':
364                                break;
365                }
366        }
367        $ligne['sans_reponse'] = $vide;
368        $ligne['header'] = $saisie['label'] != ''
369                ? $saisie['label']
370                : $saisie['type_saisie'];
371
372        return $ligne;
373}
374
375
376/**
377 * Tente de déserialiser un texte
378 *
379 * Si le paramètre est un tableau, retourne le tableau,
380 * Si c'est une chaîne, tente de la désérialiser, sinon
381 * retourne la chaîne.
382 *
383 * @filtre
384 *
385 * @param string|array $texte
386 *       Le texte (possiblement sérializé) ou un tableau
387 * @return array|string
388 *       Tableau, texte désérializé ou texte
389**/
390function filtre_tenter_unserialize_dist($texte) {
391        if (is_array($texte)) {
392                return $texte;
393        }
394        if ($tmp = @unserialize($texte)) {
395                return $tmp;
396        }
397        return $texte;
398}
399
400
401/**
402 * Retourne un texte du nombre de réponses
403 *
404 * @param int $nb
405 *       Nombre de réponses
406 * @return string
407 *       Texte indiquant le nombre de réponses
408**/
409function titre_nb_reponses($nb) {
410        if (!$nb) {
411                return _T('formidable:reponse_aucune');
412        }
413        if ($nb == 1) {
414                return _T('formidable:reponse_une');
415        }
416        return _T('formidable:reponses_nb', array('nb' => $nb));
417}
418
419/**
420 * Transforme le hash MD5 en une valeur numérique unique
421 *
422 * trouvé ici : http://stackoverflow.com/questions/1422725/represent-md5-hash-as-an-integer
423 * @param string $hex_str La valeur alphanumérique à transformer
424 * @return string Valeur numérique
425*/
426function md5_hex_to_dec($hex_str) {
427        $arr = str_split($hex_str, 4);
428        $dec = array();
429        foreach ($arr as $grp) {
430                $dec[] = str_pad(hexdec($grp), 5, '0', STR_PAD_LEFT);
431        }
432
433        /* on s'assure que $result ne commence pas par un zero */
434        $result = implode('', $dec);
435        for ($cpt = 0; $cpt < strlen($result); $cpt++) {
436                if ($result[$cpt] != '0') {
437                        break;
438                }
439        }
440        $result = substr($result, $cpt);
441        return $result;
442}
443
444/**
445 * Transforme un login en une valeur numérique de 19 caractères
446 *
447 * NOTE: il devient impossible de retrouver la valeur d'origine car le HASH
448 * est coupé à 19cars et est donc incomplet. L'unicité n'est pas garantie mais
449 * les chances pour que deux logins tombent sur le même HASH sont de 1 sur
450 * 10 milliards de milliards
451 * A la fin, on recherche et supprime les éventuels zéros de début
452 * @param string $login Login à transformer
453 * @param string $id_form ID du formulaire concerné
454 * @return string Un nombre de 19 chiffres
455*/
456function formidable_scramble($login, $id_form) {
457        if (isset($GLOBALS['formulaires']['passwd']['interne']) == false) {
458                $passwd = $GLOBALS['formulaires']['passwd']['interne'];
459        } else {
460                $passwd = 'palabresecreta';
461        }
462        $login_md5 = md5("$login$passwd$id_form");
463        $login_num = md5_hex_to_dec($login_md5);
464        $login_num = substr($login_num, 0, 19);
465
466        return $login_num;
467}
468
469/**
470 * Dans une chaîne, remplace les @raccourci@
471 * par la valeur saisie.
472 * @param string $chaine la chaîne à transformer
473 * @param array $saisies la liste des saisies du formulaire
474 * @param bool|string $brut=false, pour indiquer si on veut utiliser les valeurs brutes;
475 * @param string|bool $sans_reponse chaine à afficher si pas de réponse. Si true, prend la chaîne par défaut
476 * @return string la chaîne transformée
477 */
478function formidable_raccourcis_arobases_2_valeurs_champs($chaine, $saisies, $brut=false, $sans_reponse = true) {
479        list($valeurs,$valeurs_libellees) = formidable_tableau_valeurs_saisies($saisies, $sans_reponse);
480        $a_remplacer = array();
481        if (preg_match_all('/@[\w]+@/', $chaine, $a_remplacer)) {
482                $a_remplacer = $a_remplacer[0];
483                foreach ($a_remplacer as $cle => $val) {
484                        $a_remplacer[$cle] = trim($val, '@');
485                }
486                $a_remplacer = array_flip($a_remplacer);
487                if ($brut) {
488                        $a_remplacer = array_intersect_key($valeurs, $a_remplacer);
489                }
490                else {
491                        $a_remplacer = array_intersect_key($valeurs_libellees, $a_remplacer);
492                }
493                $a_remplacer = array_merge($a_remplacer, array('nom_site_spip' => lire_config("nom_site")));
494        }
495        return trim(_L($chaine, $a_remplacer));
496}
497/**
498 * Récupère l'ensemble des valeurs postée dans un formulaires
499 * Les retourne sous deux formes : brutes et libellés (par ex. pour les @select@
500 * @param array $saisies les saisies du formulaires
501 * @param string|bool $sans_reponse chaine à afficher si pas de réponse. Si true, prend la chaîne par défaut
502 * @return array (brutes, libellées)
503 * On met les résultats en statiques pour gagner un peu de temps
504 */
505function formidable_tableau_valeurs_saisies($saisies, $sans_reponse = true) {
506        if (isset($valeurs)) {
507                return array($valeurs,$valeurs_libellees);
508        }
509        // On parcourt les champs pour générer le tableau des valeurs
510        static $valeurs = array();
511        static $valeurs_libellees = array();
512        if ($sans_reponse === true) {
513                $sans_reponse =  _T('saisies:sans_reponse');
514        }
515        include_spip('inc/saisies_afficher_si');
516        $saisies_apres_afficher_si = saisies_verifier_afficher_si($saisies);
517        $saisies_fichiers = saisies_lister_avec_type($saisies, 'fichiers');
518        $saisies_par_nom = saisies_lister_par_nom($saisies);
519        $saisies_par_nom_apres_afficher_si = saisies_lister_par_nom($saisies_apres_afficher_si);
520        $champs = saisies_lister_champs($saisies);
521
522
523        // On n'utilise pas formulaires_formidable_fichiers,
524        // car celui-ci retourne les saisies fichiers du formulaire dans la base… or, on sait-jamais,
525        // il peut y avoir eu une modification entre le moment où l'utilisateur a vu le formulaire et maintenant
526        foreach ($champs as $champ) {
527                if (array_key_exists($champ, $saisies_fichiers)) {// si on a affaire à une saisie de type fichiers, on considère qu'il n'y pas vraiment de valeur brute
528                } elseif ($saisies_par_nom[$champ]['saisie'] == 'explication') {
529                        $valeurs[$champ] = $saisies_par_nom_apres_afficher_si[$champ]['options']['texte'];
530                        $valeurs_libellees[$champ] =  $valeurs[$champ];
531                }       else {
532                        // On récupère la valeur postée
533                        $valeurs[$champ] = _request($champ);
534                        $valeurs_libellees[$champ] = formidable_nettoyer_saisie_vue(recuperer_fond(
535                                'saisies-vues/_base',
536                                array_merge(
537                                        array(
538                                                'type_saisie' => $saisies_par_nom[$champ]['saisie'],
539                                                'valeur' => $valeurs[$champ],
540                                                'valeur_uniquement' => 'oui',
541                                                'sans_reponse' => $sans_reponse
542                                        ),
543                                        $saisies_par_nom[$champ]['options']
544                                )
545                        ));
546                }
547        }
548        return array($valeurs, $valeurs_libellees);
549}
550
551/**
552 * Retourne la valeur "scrambelisée" de la variable PHP d'identification.
553 * pour les deux variables proposés par formidable, recherche directement dans $_SERVER
554 * sinon utilise un eval() si une autre variable a été défini en global.
555 * Mais peu probable que le cas se présente, car pas d'interface dans le .yaml pour proposer d'autres variables que celle définies par formidable
556 * @param string $nom_variable le nom de la variable
557 * @param string $id_formulaire le formulaire concerné
558 * @return string
559 */
560function formidable_variable_php_identification($nom_variable, $id_formulaire) {
561        //Pour compat ascendante
562        if (isset($GLOBALS['formulaires']['variables_anonymisation'])) {
563                $nom_variable = $GLOBALS['formulaires']['variables_anonymisation'][$nom_variable];
564                $valeur_variable = eval ("return $nom_variable;");
565        }
566
567        if (in_array($nom_variable, array("remote_user", "php_auth_user"))) {
568                $nom_variable = strtoupper($nom_variable);
569                $valeur_variable = isset($_SERVER[$nom_variable]) ? $_SERVER[$nom_variable] : 0;
570        }  else {
571                $valeur_variable = 0;
572        }
573
574        if ($valeur_variable) {
575                $valeur_variable = formidable_scramble($valeur_variable, $id_formulaire);
576        }
577        return $valeur_variable;
578}
Note: See TracBrowser for help on using the repository browser.