[SPIP][PLUGINS] v3.0-->v3.2
[lhc/web/www.git] / www / ecrire / inc / rechercher.php
index f5ecc4b..0cf0452 100644 (file)
@@ -3,57 +3,75 @@
 /***************************************************************************\
  *  SPIP, Systeme de publication pour l'internet                           *
  *                                                                         *
- *  Copyright (c) 2001-2016                                                *
+ *  Copyright (c) 2001-2017                                                *
  *  Arnaud Martin, Antoine Pitrou, Philippe Riviere, Emmanuel Saint-James  *
  *                                                                         *
  *  Ce programme est un logiciel libre distribue sous licence GNU/GPL.     *
  *  Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne.   *
 \***************************************************************************/
 
+/**
+ * Gestion des recherches
+ *
+ * @package SPIP\Core\Recherche
+ **/
 
-if (!defined('_ECRIRE_INC_VERSION')) return;
+if (!defined('_ECRIRE_INC_VERSION')) {
+       return;
+}
 
 
-// Donne la liste des champs/tables ou l'on sait chercher/remplacer
-// avec un poids pour le score
-// http://doc.spip.org/@liste_des_champs
+/**
+ * Donne la liste des champs/tables où l'on sait chercher / remplacer
+ * avec un poids pour le score
+ *
+ * Utilise l'information `rechercher_champs` sur la déclaration
+ * des objets éditoriaux.
+ *
+ * @pipeline_appel rechercher_liste_des_champs
+ * @uses lister_tables_objets_sql()
+ *
+ * @return array Couples (type d'objet => Couples (champ => score))
+ */
 function liste_des_champs() {
-       static $liste=null;
+       static $liste = null;
        if (is_null($liste)) {
                $liste = array();
                // recuperer les tables_objets_sql declarees
                include_spip('base/objets');
                $tables_objets = lister_tables_objets_sql();
-               foreach($tables_objets as $t=>$infos){
-                       if ($infos['rechercher_champs']){
+               foreach ($tables_objets as $t => $infos) {
+                       if ($infos['rechercher_champs']) {
                                $liste[$infos['type']] = $infos['rechercher_champs'];
                        }
                }
                // puis passer dans le pipeline
                $liste = pipeline('rechercher_liste_des_champs', $liste);
        }
+
        return $liste;
 }
 
 
 // Recherche des auteurs et mots-cles associes
 // en ne regardant que le titre ou le nom
-// http://doc.spip.org/@liste_des_jointures
+// http://code.spip.net/@liste_des_jointures
 function liste_des_jointures() {
-       static $liste=null;
+       static $liste = null;
        if (is_null($liste)) {
                $liste = array();
                // recuperer les tables_objets_sql declarees
                include_spip('base/objets');
                $tables_objets = lister_tables_objets_sql();
-               foreach($tables_objets as $t=>$infos){
-                       if ($infos['rechercher_jointures']){
+               foreach ($tables_objets as $t => $infos) {
+                       if ($infos['rechercher_jointures']) {
                                $liste[$infos['type']] = $infos['rechercher_jointures'];
                        }
                }
                // puis passer dans le pipeline
                $liste = pipeline('rechercher_liste_des_jointures', $liste);
        }
+
        return $liste;
 }
 
@@ -62,12 +80,14 @@ function expression_recherche($recherche, $options) {
        // (meme si utilisee dans plusieurs boucles)
        static $expression = array();
        $key = serialize(array($recherche, $options['preg_flags']));
-       if (isset($expression[$key]))
+       if (isset($expression[$key])) {
                return $expression[$key];
+       }
 
        $u = $GLOBALS['meta']['pcre_u'];
-       if ($u AND strpos($options['preg_flags'],$u)===false)
+       if ($u and strpos($options['preg_flags'], $u) === false) {
                $options['preg_flags'] .= $u;
+       }
        include_spip('inc/charsets');
        $recherche = trim($recherche);
 
@@ -75,70 +95,90 @@ function expression_recherche($recherche, $options) {
        if (substr($recherche, 0, 1) == '/' and substr($recherche, -1, 1) == '/' and strlen($recherche) > 2) {
                // c'est une preg
                $recherche_trans = translitteration($recherche);
-               $preg = $recherche_trans.$options['preg_flags'];
+               $preg = $recherche_trans . $options['preg_flags'];
                $is_preg = true;
-       }
-       else{
-               // s'il y a plusieurs mots il faut les chercher tous : oblige REGEXP
+       } else {
+               // s'il y a plusieurs mots il faut les chercher tous : oblige REGEXP,
                // sauf ceux de moins de 4 lettres (on supprime ainsi 'le', 'les', 'un',
                // 'une', 'des' ...)
-               if (preg_match(",\s+,".$u, $recherche)){
+
+               // attention : plusieurs mots entre guillemets sont a rechercher tels quels
+               $recherche_trans = $recherche_mod = $recherche;
+
+               // les expressions entre " " sont un mot a chercher tel quel
+               // -> on remplace les espaces par un \x1 et on enleve les guillemets
+               if (preg_match(',["][^"]+["],Uims', $recherche_mod, $matches)) {
+                       foreach ($matches as $match) {
+                               $word = preg_replace(",\s+,Uims", "\x1", $match);
+                               $word = trim($word, '"');
+                               $recherche_mod = str_replace($match, $word, $recherche_mod);
+                       }
+               }
+
+               if (preg_match(",\s+," . $u, $recherche_mod)) {
                        $is_preg = true;
+
                        $recherche_inter = '|';
-                       $recherche_mots = explode(' ', $recherche);
+                       $recherche_mots = explode(' ', $recherche_mod);
                        $min_long = defined('_RECHERCHE_MIN_CAR') ? _RECHERCHE_MIN_CAR : 4;
                        foreach ($recherche_mots as $mot) {
                                if (strlen($mot) >= $min_long) {
-                                       $recherche_inter .= $mot.' ';
+                                       // echapper les caracteres de regexp qui sont eventuellement dans la recherche
+                                       $recherche_inter .= preg_quote($mot) . ' ';
                                }
                        }
+                       $recherche_inter = str_replace("\x1", '\s', $recherche_inter);
+
                        // mais on cherche quand même l'expression complète, même si elle
                        // comporte des mots de moins de quatre lettres
-                       $recherche = rtrim($recherche.preg_replace(',\s+,'.$u, '|', $recherche_inter), '|');
+                       $recherche = rtrim(preg_quote($recherche) . preg_replace(',\s+,' . $u, '|', $recherche_inter), '|');
                        $recherche_trans = translitteration($recherche);
                }
 
-               $preg = '/'.str_replace('/', '\\/', $recherche_trans).'/' . $options['preg_flags'];
+               $preg = '/' . str_replace('/', '\\/', $recherche_trans) . '/' . $options['preg_flags'];
        }
 
        // Si la chaine est inactive, on va utiliser LIKE pour aller plus vite
        // ou si l'expression reguliere est invalide
        if (!$is_preg
-         OR (@preg_match($preg,'')===FALSE) ) {
+               or (@preg_match($preg, '') === false)
+       ) {
                $methode = 'LIKE';
                $u = $GLOBALS['meta']['pcre_u'];
+
+               // echapper les % et _
+               $q = str_replace(array('%', '_'), array('\%', '\_'), trim($recherche));
+
                // eviter les parentheses et autres caractères qui interferent avec pcre par la suite (dans le preg_match_all) s'il y a des reponses
-               $recherche = str_replace(
-                       array('(',')','?','[', ']', '+', '*', '/'),
-                       array('\(','\)','[?]', '\[', '\]', '\+', '\*', '\/'),
-                       $recherche);
+               $recherche = preg_quote($recherche, '/');
                $recherche_trans = translitteration($recherche);
                $recherche_mod = $recherche_trans;
 
-               // echapper les % et _
-               $q = str_replace(array('%','_'), array('\%', '\_'), trim($recherche));
                // les expressions entre " " sont un mot a chercher tel quel
                // -> on remplace les espaces par un _ et on enleve les guillemets
-               if (preg_match(',["][^"]+["],Uims',$q,$matches)){
-                       foreach($matches as $match){
-                               // corriger le like dans le $q
-                               $word = preg_replace(",\s+,Uims","_",$match);
-                               $word = trim($word,'"');
-                               $q = str_replace($match,$word,$q);
-                               // corriger la regexp
-                               $word = preg_replace(",\s+,Uims","[\s]",$match);
-                               $word = trim($word,'"');
-                               $recherche_mod = str_replace($match,$word,$recherche_mod);
+               // corriger le like dans le $q
+               if (preg_match(',["][^"]+["],Uims', $q, $matches)) {
+                       foreach ($matches as $match) {
+                               $word = preg_replace(",\s+,Uims", "_", $match);
+                               $word = trim($word, '"');
+                               $q = str_replace($match, $word, $q);
+                       }
+               }
+               // corriger la regexp
+               if (preg_match(',["][^"]+["],Uims', $recherche_mod, $matches)) {
+                       foreach ($matches as $match) {
+                               $word = preg_replace(",\s+,Uims", "[\s]", $match);
+                               $word = trim($word, '"');
+                               $recherche_mod = str_replace($match, $word, $recherche_mod);
                        }
                }
                $q = sql_quote(
                        "%"
-                       . preg_replace(",\s+,".$u, "%", $q)
+                       . preg_replace(",\s+," . $u, "%", $q)
                        . "%"
                );
 
-               $preg = '/'.preg_replace(",\s+,".$u, ".+", trim($recherche_mod)).'/' . $options['preg_flags'];
-
+               $preg = '/' . preg_replace(",\s+," . $u, ".+", trim($recherche_mod)) . '/' . $options['preg_flags'];
        } else {
                $methode = 'REGEXP';
                $q = sql_quote(trim($recherche, '/'));
@@ -147,12 +187,13 @@ function expression_recherche($recherche, $options) {
        // tous les caracteres transliterables de $q sont remplaces par un joker
        // permet de matcher en SQL meme si on est sensible aux accents (SQLite)
        $q_t = $q;
-       for($i = 0;$i<spip_strlen($q);$i++){
-               $char = spip_substr($q,$i,1);
+       for ($i = 0; $i < spip_strlen($q); $i++) {
+               $char = spip_substr($q, $i, 1);
                if (!is_ascii($char)
-                 AND $char_t = translitteration($char)
-                 AND $char_t !== $char){
-                       $q_t = str_replace($char,$is_preg?".":"_", $q_t);
+                       and $char_t = translitteration($char)
+                       and $char_t !== $char
+               ) {
+                       $q_t = str_replace($char, $is_preg ? "." : "_", $q_t);
                }
        }
 
@@ -161,46 +202,68 @@ function expression_recherche($recherche, $options) {
        // fix : SQLite 3 est sensible aux accents, on jokerise les caracteres
        // les plus frequents qui peuvent etre accentues
        // (oui c'est tres dicustable...)
-       if (isset($GLOBALS['connexions'][$options['serveur']?$options['serveur']:0]['type'])
-         AND strncmp($GLOBALS['connexions'][$options['serveur']?$options['serveur']:0]['type'],'sqlite',6)==0){
-               $q_t = strtr($q,"aeuioc",$is_preg?"......":"______");
+       if (isset($GLOBALS['connexions'][$options['serveur'] ? $options['serveur'] : 0]['type'])
+               and strncmp($GLOBALS['connexions'][$options['serveur'] ? $options['serveur'] : 0]['type'], 'sqlite', 6) == 0
+       ) {
+               $q_t = strtr($q, "aeuioc", $is_preg ? "......" : "______");
                // si il reste au moins un char significatif...
-               if (preg_match(",[^'%_.],",$q_t))
+               if (preg_match(",[^'%_.],", $q_t)) {
                        $q = $q_t;
+               }
        }
 
        return $expression[$key] = array($methode, $q, $preg);
 }
 
 
-// Effectue une recherche sur toutes les tables de la base de donnees
-// options :
-// - toutvoir pour eviter autoriser(voir)
-// - flags pour eviter les flags regexp par defaut (UimsS)
-// - champs pour retourner les champs concernes
-// - score pour retourner un score
-// On peut passer les tables, ou une chaine listant les tables souhaitees
-// http://doc.spip.org/@recherche_en_base
-function recherche_en_base($recherche='', $tables=NULL, $options=array(), $serveur='') {
+
+/**
+ * Effectue une recherche sur toutes les tables de la base de données
+ *
+ * @uses liste_des_champs()
+ * @uses inc_recherche_to_array_dist()
+ *
+ * @param string $recherche
+ *     Le terme de recherche
+ * @param null|array|string $tables
+ *     - null : toutes les tables acceptant des recherches
+ *     - array : liste des tables souhaitées
+ *     - string : une chaîne listant les tables souhaitées, séparées par des virgules (préférer array cependant)
+ * @param array $options {
+ *     @var $toutvoir pour éviter autoriser(voir)
+ *     @var $flags pour éviter les flags regexp par défaut (UimsS)
+ *     @var $champs pour retourner les champs concernés
+ *     @var $score pour retourner un score
+ * }
+ * @param string $serveur
+ * @return array
+ */
+function recherche_en_base($recherche = '', $tables = null, $options = array(), $serveur = '') {
        include_spip('base/abstract_sql');
 
        if (!is_array($tables)) {
                $liste = liste_des_champs();
 
                if (is_string($tables)
-               AND $tables != '') {
+                       and $tables != ''
+               ) {
                        $toutes = array();
-                       foreach(explode(',', $tables) as $t)
-                               if (isset($liste[$t]))
+                       foreach (explode(',', $tables) as $t) {
+                               $t = trim($t);
+                               if (isset($liste[$t])) {
                                        $toutes[$t] = $liste[$t];
+                               }
+                       }
                        $tables = $toutes;
                        unset($toutes);
-               } else
+               } else {
                        $tables = $liste;
+               }
        }
 
-       if (!strlen($recherche) OR !count($tables))
+       if (!strlen($recherche) or !count($tables)) {
                return array();
+       }
 
        include_spip('inc/autoriser');
 
@@ -213,7 +276,7 @@ function recherche_en_base($recherche='', $tables=NULL, $options=array(), $serve
                'matches' => false,
                'jointures' => false,
                'serveur' => $serveur
-               ),
+       ),
                $options
        );
 
@@ -225,11 +288,12 @@ function recherche_en_base($recherche='', $tables=NULL, $options=array(), $serve
        //      id1 = { 'score' => x, attrs => { } },
        //      id2 = { 'score' => x, attrs => { } },
        // }
-       include_spip('inc/memoization');
+
        foreach ($tables as $table => $champs) {
                # lock via memoization, si dispo
-               if (function_exists('cache_lock'))
-                       cache_lock($lock = 'recherche '.$table.' '.$recherche);
+               if (function_exists('cache_lock')) {
+                       cache_lock($lock = 'recherche ' . $table . ' ' . $recherche);
+               }
 
                spip_timer('rech');
 
@@ -242,10 +306,12 @@ function recherche_en_base($recherche='', $tables=NULL, $options=array(), $serve
                ##var_dump($results[$table]);
 
 
-               spip_log("recherche $table ($recherche) : ".count($results[$table])." resultats ".spip_timer('rech'),'recherche');
+               spip_log("recherche $table ($recherche) : " . count($results[$table]) . " resultats " . spip_timer('rech'),
+                       'recherche');
 
-               if (isset($lock))
+               if (isset($lock)) {
                        cache_unlock($lock);
+               }
        }
 
        return $results;
@@ -253,48 +319,52 @@ function recherche_en_base($recherche='', $tables=NULL, $options=array(), $serve
 
 
 // Effectue une recherche sur toutes les tables de la base de donnees
-// http://doc.spip.org/@remplace_en_base
-function remplace_en_base($recherche='', $remplace=NULL, $tables=NULL, $options=array()) {
+// http://code.spip.net/@remplace_en_base
+function remplace_en_base($recherche = '', $remplace = null, $tables = null, $options = array()) {
        include_spip('inc/modifier');
 
        // options par defaut
        $options = array_merge(array(
                'preg_flags' => 'UimsS',
                'toutmodifier' => false
-               ),
+       ),
                $options
        );
        $options['champs'] = true;
 
 
-       if (!is_array($tables))
+       if (!is_array($tables)) {
                $tables = liste_des_champs();
+       }
 
        $results = recherche_en_base($recherche, $tables, $options);
 
-       $preg = '/'.str_replace('/', '\\/', $recherche).'/' . $options['preg_flags'];
+       $preg = '/' . str_replace('/', '\\/', $recherche) . '/' . $options['preg_flags'];
 
        foreach ($results as $table => $r) {
                $_id_table = id_table_objet($table);
                foreach ($r as $id => $x) {
                        if ($options['toutmodifier']
-                       OR autoriser('modifier', $table, $id)) {
+                               or autoriser('modifier', $table, $id)
+                       ) {
                                $modifs = array();
                                foreach ($x['champs'] as $key => $val) {
-                                       if ($key == $_id_table) next;
+                                       if ($key == $_id_table) {
+                                               next;
+                                       }
                                        $repl = preg_replace($preg, $remplace, $val);
-                                       if ($repl <> $val)
+                                       if ($repl <> $val) {
                                                $modifs[$key] = $repl;
+                                       }
                                }
-                               if ($modifs)
+                               if ($modifs) {
                                        objet_modifier_champs($table, $id,
                                                array(
                                                        'champs' => array_keys($modifs),
                                                ),
                                                $modifs);
+                               }
                        }
                }
        }
 }
-
-?>