modules/search/classes.inc.php

   1 <?php
   2 /***************************************************************************
   3  *  Copyright (C) 2003-2008 Polytechnique.org                              *
   4  *  http://opensource.polytechnique.org/                                   *
   5  *                                                                         *
   6  *  This program is free software; you can redistribute it and/or modify   *
   7  *  it under the terms of the GNU General Public License as published by   *
   8  *  the Free Software Foundation; either version 2 of the License, or      *
   9  *  (at your option) any later version.                                    *
  10  *                                                                         *
  11  *  This program is distributed in the hope that it will be useful,        *
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of         *
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
  14  *  GNU General Public License for more details.                           *
  15  *                                                                         *
  16  *  You should have received a copy of the GNU General Public License      *
  17  *  along with this program; if not, write to the Free Software            *
  18  *  Foundation, Inc.,                                                      *
  19  *  59 Temple Place, Suite 330, Boston, MA  02111-1307  USA                *
  20  ***************************************************************************/
  21
  22 // {{{ Global variables used for the search Queries
  23
  24 @$globals->search->result_fields = '
  25     u.user_id, u.promo, u.matricule, u.matricule_ax,
  26     if(u.nom_usage=\'\', u.nom, u.nom_usage) AS NomSortKey,
  27     u.nom_usage,u.date,
  28     u.deces!=0 AS dcd,u.deces,
  29     u.perms IN (\'admin\',\'user\', \'disabled\') AS inscrit,
  30     u.perms != \'pending\' AS wasinscrit,
  31     FIND_IN_SET(\'femme\', u.flags) AS sexe,
  32     a.alias AS forlife,
  33     ad0.text AS app0text, ad0.url AS app0url, ai0.type AS app0type,
  34     ad1.text AS app1text, ad1.url AS app1url, ai1.type AS app1type,
  35     es.label AS secteur, ef.fonction_fr AS fonction,
  36     IF(n1.nat=\'\',n1.pays,n1.nat) AS nat1, n1.a2 AS iso3166_1,
  37     IF(n2.nat=\'\',n2.pays,n2.nat) AS nat2, n2.a2 AS iso3166_2,
  38     IF(n3.nat=\'\',n3.pays,n3.nat) AS nat3, n3.a2 AS iso3166_3,
  39     (COUNT(em.email) > 0 OR FIND_IN_SET("googleapps", u.mail_storage) > 0) AS actif,';
  40 // hide private information if not logged
  41 if (S::logged())
  42     $globals->search->result_fields .='
  43         q.profile_freetext AS freetext,
  44         adr.city, gp.pays AS countrytxt, gr.name AS region,
  45         e.entreprise,
  46         nw.address AS networking_address,
  47         nwe.name AS networking_name,';
  48 else
  49     $globals->search->result_fields .="
  50         IF(q.profile_freetext_pub='public', q.profile_freetext, '') AS freetext,
  51         IF(adr.pub='public', adr.city, '') AS city,
  52         IF(adr.pub='public', gp.pays, '') AS countrytxt,
  53         IF(adr.pub='public', gr.name, '') AS region,
  54         IF(e.pub='public', e.entreprise, '') AS entreprise,
  55         IF(nw.pub='public', nw.address, '') AS networking_address,
  56         IF(nw.pub='public', nwe.name, '') AS networking_name,";
  57 @$globals->search->result_where_statement = '
  58     LEFT JOIN  applis_ins              AS ai0 ON (u.user_id = ai0.uid AND ai0.ordre = 0)
  59     LEFT JOIN  applis_def              AS ad0 ON (ad0.id = ai0.aid)
  60     LEFT JOIN  applis_ins              AS ai1 ON (u.user_id = ai1.uid AND ai1.ordre = 1)
  61     LEFT JOIN  applis_def              AS ad1 ON (ad1.id = ai1.aid)
  62     LEFT JOIN  entreprises             AS e   ON (e.entrid = 0 AND e.uid = u.user_id)
  63     LEFT JOIN  emploi_secteur          AS es  ON (e.secteur = es.id)
  64     LEFT JOIN  fonctions_def           AS ef  ON (e.fonction = ef.id)
  65     LEFT JOIN  geoloc_pays             AS n1  ON (u.nationalite = n1.a2)
  66     LEFT JOIN  geoloc_pays             AS n2  ON (u.nationalite2 = n2.a2)
  67     LEFT JOIN  geoloc_pays             AS n3  ON (u.nationalite3 = n3.a2)
  68     LEFT JOIN  adresses                AS adr ON (u.user_id = adr.uid AND FIND_IN_SET(\'active\',adr.statut))
  69     LEFT JOIN  geoloc_pays             AS gp  ON (adr.country = gp.a2)
  70     LEFT JOIN  geoloc_region           AS gr  ON (adr.country = gr.a2 AND adr.region = gr.region)
  71     LEFT JOIN  emails                  AS em  ON (em.uid = u.user_id AND em.flags = \'active\')
  72     LEFT JOIN  profile_networking      AS nw  ON (nw.uid = u.user_id)
  73     LEFT JOIN  profile_networking_enum AS nwe ON (nwe.network_type = nw.network_type)';
  74
  75 // }}}
  76 // {{{ class ThrowError
  77
  78 /** handle errors for end-users queries
  79  * assign the error message and runs the templates
  80  *
  81  * @author Jean-Sebastien Bedo
  82  */
  83 class ThrowError
  84 {
  85     public static $throwHook = array('ThrowError', 'defaultHandler');
  86
  87     /** constuctor
  88      * @param  $explain string  the error (in natural language)
  89      */
  90     public function __construct($explain)
  91     {
  92         call_user_func(ThrowError::$throwHook, $explain);
  93     }
  94
  95     /** defaut error handler
  96      */
  97     private static function defaultHandler($explain)
  98     {
  99         global $globals;
 100         $page =& Platal::page();
 101         $page->changeTpl('search/index.tpl');
 102         $page->setTitle('Polytechnique.org - Annuaire');
 103         $page->assign('baseurl', $globals->baseurl);
 104         $page->trigError($explain);
 105         $page->run();
 106     }
 107 }
 108
 109 // }}}
 110 // {{{ class SField                                     [Base class]
 111
 112 /** classe de base représentant un champ de recherche
 113  * (correspond à un champ du formulaire mais peut être à plusieurs champs de la bdd)
 114  * interface étendue pour chaque type de champ particulier
 115  */
 116 class SField
 117 {
 118     // {{{ properties
 119
 120     /** le nom du champ dans le formulaire HTML */
 121     var $fieldFormName;
 122     /** champs de la bdd correspondant à ce champ sous forme d'un tableau */
 123     var $fieldDbName;
 124     /** champ résultat dans la requête MySQL correspondant à ce champ
 125      * (alias utilisé pour la clause ORDER BY) */
 126     var $fieldResultName;
 127     /** valeur du champ instanciée par l'utilisateur */
 128     var $value;
 129
 130     // }}}
 131     // {{{ constructor
 132
 133     /** constructeur
 134      * (récupère la requête de l'utilisateur pour ce champ) */
 135     function SField($_fieldFormName, $_fieldDbName='', $_fieldResultName='')
 136     {
 137         $this->fieldFormName   = $_fieldFormName;
 138         $this->fieldDbName     = $_fieldDbName;
 139         $this->fieldResultName = $_fieldResultName;
 140         $this->get_request();
 141     }
 142
 143     // }}}
 144     // {{{ function get_request()
 145
 146     /** récupérer la requête de l'utilisateur
 147      * on met une chaîne vide si le champ n'a pas été complété */
 148     function get_request()
 149     {
 150         $this->value = trim(Env::v($this->fieldFormName));
 151     }
 152
 153     // }}}
 154     // {{{ function get_where_statement()
 155
 156     /** récupérer la clause correspondant au champ dans la clause WHERE de la requête
 157      * on parcourt l'ensemble des champs de la bdd de $fieldDbName et on associe
 158      * à chacun d'entre eux une clause spécifique
 159      * la clause totale et la disjonction de ces clauses spécifiques */
 160     function get_where_statement()
 161     {
 162         if ($this->value=='') {
 163             return false;
 164         }
 165         $res = implode(' OR ', array_filter(array_map(array($this, 'get_single_where_statement'), $this->fieldDbName)));
 166         return empty($res) ? '' : "($res)";
 167     }
 168
 169     // }}}
 170     // {{{ function get_order_statement()
 171
 172     /** récupérer la clause correspondant au champ dans la clause ORDER BY de la requête
 173      * utilisé par exemple pour placer d'abord le nom égal à la requête avant les approximations */
 174     function get_order_statement()
 175     {
 176         return false;
 177     }
 178
 179     // }}}
 180     // {{{ function get_select_statement()
 181
 182     function get_select_statement()
 183     {
 184         return false;
 185     }
 186
 187     // }}}
 188     // {{{ function get_url()
 189
 190     /** récupérer le bout d'URL correspondant aux paramètres permettant d'imiter une requête d'un
 191      * utilisateur assignant la valeur $this->value à ce champ */
 192     function get_url()
 193     {
 194         if (empty($this->value)) {
 195             return false;
 196         } else {
 197             return $this->fieldFormName.'='.urlencode($this->value);
 198         }
 199     }
 200
 201     // }}}
 202 }
 203
 204 // }}}
 205 // {{{ class QuickSearch                                [Google Like]
 206
 207 class QuickSearch extends SField
 208 {
 209     // {{{ properties
 210
 211     /** stores tokens */
 212     var $strings;
 213     /** stores numerical ranges */
 214     var $ranges;
 215     /** stores admin searches */
 216     var $email;
 217     var $ip;
 218     /** stores phone number */
 219     var $phone;
 220
 221     // }}}
 222     // {{{ constructor
 223
 224     function QuickSearch($_fieldFormName)
 225     {
 226         $this->fieldFormName = $_fieldFormName;
 227         $this->get_request();
 228         if (preg_match(":[\]\[{}~/§_`|%$^=+]|\*\*:u", $this->value)) {
 229             new ThrowError('Un champ contient un caractère interdit rendant la recherche impossible.');
 230         }
 231     }
 232
 233     // }}}
 234     // {{{ function isempty()
 235
 236     function isempty()
 237     {
 238         return empty($this->strings) && empty($this->ranges) && empty($this->email) && empty($this->ip) && empty($this->phone);
 239     }
 240
 241     // }}}
 242     // {{{ function get_request()
 243
 244     function get_request()
 245     {
 246         parent::get_request();
 247         $s = replace_accent(trim($this->value));
 248         $r = $s = str_replace('*','%',$s);
 249
 250         if (S::has_perms() && strpos($s, '@') !== false) {
 251             $this->email = $s;
 252         } else if (S::has_perms() && preg_match('/[0-9]+\.([0-9]+|%)\.([0-9]+|%)\.([0-9]+|%)/', $s)) {
 253             $this->ip = $s;
 254         }
 255         if ($this->email || $this->ip) {
 256             $this->strings = $this->ranges = array();
 257             return;
 258         }
 259
 260         $s = preg_replace('!\d+!', ' ', $s);
 261         $this->strings = preg_split("![^a-zA-Z%]+!",$s, -1, PREG_SPLIT_NO_EMPTY);
 262         if (count($this->strings) > 5) {
 263             Platal::page()->trigWarning("Tu as indiqué trop d'éléments dans ta recherche, seuls les 5 premiers seront pris en compte");
 264             $this->strings = array_slice($this->strings, 0, 5);
 265         }
 266
 267         $s = preg_replace('! *- *!', '-', $r);
 268         $s = preg_replace('!([<>]) *!', ' \1', $s);
 269         $s = preg_replace('![^0-9\-><]!', ' ', $s);
 270         $s = preg_replace('![<>\-] !', '', $s);
 271         $ranges = preg_split('! +!', $s, -1, PREG_SPLIT_NO_EMPTY);
 272         $this->ranges=Array();
 273         foreach ($ranges as $r) {
 274             if (preg_match('!^([<>]\d{4}|\d{4}(-\d{4})?)$!', $r)) $this->ranges[] = $r;
 275         }
 276
 277         $t = preg_replace('!(\d{4}-\d{4}|>\d{4}|<\d{4})!', '', $s);
 278         $t = preg_replace('![<>\- ]!', '', $t);
 279         if (strlen($t) > 4) {
 280             $this->phone = $t;
 281         }
 282     }
 283
 284     // }}}
 285     // {{{ function get_where_statement()
 286
 287     function get_where_statement()
 288     {
 289         $where = Array();
 290         foreach ($this->strings as $i => $s) {
 291             if (Env::i('with_soundex') && strlen($s) > 1) {
 292                 $t = soundex_fr($s);
 293                 $where[] = "sn$i.soundex = '$t'";
 294             } elseif (Env::i('exact')) {
 295                 $where[] = "sn$i.token = '$s'";
 296             } else {
 297                 $t = str_replace('*', '%', $s).'%';
 298                 $t = str_replace('%%', '%', $t);
 299                 $where[] = "sn$i.token LIKE '$t'";
 300             }
 301         }
 302
 303         $wherep = Array();
 304         foreach ($this->ranges as $r) {
 305             if (preg_match('!^\d{4}$!', $r)) {
 306                 $wherep[] = "u.promo=$r";
 307             } elseif (preg_match('!^(\d{4})-(\d{4})$!', $r, $matches)) {
 308                 $p1=min(intval($matches[1]), intval($matches[2]));
 309                 $p2=max(intval($matches[1]), intval($matches[2]));
 310                 $wherep[] = "(u.promo>=$p1 AND u.promo<=$p2)";
 311             } elseif (preg_match('!^<(\d{4})!', $r, $matches)) {
 312                 $wherep[] = "u.promo<={$matches[1]}";
 313             } elseif (preg_match('!^>(\d{4})!', $r, $matches)) {
 314                 $wherep[] = "u.promo>={$matches[1]}";
 315             }
 316         }
 317         if (!empty($wherep)) {
 318             $where[] = '('.join(' OR ',$wherep).')';
 319         }
 320         if (!empty($this->email)) {
 321             $where[] = 'ems.email = ' . XDB::escape($this->email);
 322         }
 323         if (!empty($this->ip)) {
 324             $ip = ip_to_uint($this->ip);
 325             $where[] = "( ls.ip = $ip OR ls.forward_ip = $ip ) AND ls.suid = 0";
 326         }
 327         if (!empty($this->phone)){
 328             require_once("profil.func.inc.php");
 329             $phone = format_phone_number($this->phone) . "%";
 330             $where[] = 't.search_tel LIKE ' . XDB::escape($phone);
 331         }
 332
 333         return join(" AND ", $where);
 334     }
 335
 336     // }}}
 337     // {{{ get_select_statement
 338     function get_select_statement()
 339     {
 340         $join = "";
 341         $and  = '';
 342         $uniq = '';
 343         foreach ($this->strings as $i => $s) {
 344             if (!S::logged()) {
 345                 $and = "AND FIND_IN_SET('public', sn$i.flags)";
 346             }
 347             $myu  = str_replace('snv', "sn$i", $uniq);
 348             $join .= "INNER JOIN search_name AS sn$i ON (u.user_id = sn$i.uid $and$myu)\n";
 349             $uniq .= " AND sn$i.token != snv.token";
 350         }
 351         if (!empty($this->email)) {
 352             $join .= "LEFT JOIN emails AS ems ON (ems.uid = u.user_id)";
 353         }
 354         if (!empty($this->ip)) {
 355             $join .= "INNER JOIN logger.sessions AS ls ON (ls.uid = u.user_id)\n";
 356         }
 357         if (!empty($this->phone)) {
 358             if (!S::logged()) {
 359                 $join .= "INNER JOIN profile_phones AS t ON (t.uid = u.user_id AND t.pub = 'public')";
 360             } else {
 361                 $join .= "INNER JOIN profile_phones AS t ON (t.uid = u.user_id)";
 362             }
 363         }
 364         return $join;
 365     }
 366     // }}}
 367     // {{{ function get_order_statement()
 368
 369     function get_order_statement()
 370     {
 371         return false;
 372     }
 373
 374     // }}}
 375     // {{{ function get_score_statement
 376
 377     function get_score_statement()
 378     {
 379         $sum = array('0');
 380         foreach ($this->strings as $i => $s) {
 381             $sum[] .= "SUM(sn$i.score + IF('$s'=sn$i.token,5,0))";
 382         }
 383         return join('+', $sum).' AS score';
 384     }
 385
 386     // }}}
 387 }
 388
 389 // }}}
 390 // {{{ class NumericSField                              [Integer fields]
 391
 392 /** classe de champ numérique entier (offset par exemple)
 393  */
 394 class NumericSField extends SField
 395 {
 396     // {{{ constructor
 397
 398     /** constructeur
 399      * (récupère la requête de l'utilisateur pour ce champ) */
 400     function NumericSField($_fieldFormName)
 401     {
 402         $this->fieldFormName = $_fieldFormName;
 403         $this->get_request();
 404     }
 405
 406     // }}}
 407     // {{{ function get_request()
 408
 409     /** récupère la requête de l'utilisateur et échoue s'il ne s'agit pas d'un entier */
 410     function get_request()
 411     {
 412         parent::get_request();
 413         if (empty($this->value)) {
 414             $this->value = 0;
 415         }
 416         if (!preg_match("/^[0-9]+$/", $this->value)) {
 417             new ThrowError('Un champ numérique contient des caractères alphanumériques.');
 418         }
 419     }
 420
 421     // }}}
 422 }
 423
 424 // }}}
 425 // {{{ class RefSField                                  [ ??? ]
 426
 427 class RefSField extends SField
 428 {
 429     // {{{ properties
 430
 431     var $refTable;
 432     var $refAlias;
 433     var $refCondition;
 434     var $exact = true;
 435
 436     // }}}
 437     // {{{ constructor
 438
 439     function RefSField($_fieldFormName, $_fieldDbName='', $_refTable, $_refAlias, $_refCondition, $_exact=true)
 440     {
 441         $this->fieldFormName = $_fieldFormName;
 442         $this->fieldDbName   = $_fieldDbName;
 443         $this->refTable      = $_refTable;
 444         $this->refAlias      = $_refAlias;
 445         $this->refCondition  = $_refCondition;
 446         $this->exact         = $_exact;
 447         $this->get_request();
 448     }
 449
 450     // }}}
 451     // {{{ function get_request()
 452
 453     function get_request() {
 454         parent::get_request();
 455         if ($this->value=='00' || $this->value=='0') {
 456             $this->value='';
 457         }
 458     }
 459
 460     // }}}
 461     // {{{ function too_large()
 462
 463     function too_large()
 464     {
 465         return ($this->value=='');
 466     }
 467
 468     // }}}
 469     // {{{ function compare()
 470
 471     function compare()
 472     {
 473         $val = addslashes($this->value);
 474         if (Env::i('exact')) return "='$val'";
 475         return $this->exact ? "='$val'" : " LIKE '%$val%'";
 476     }
 477
 478     // }}}
 479     // {{{ function get_single_match_statement()
 480
 481     function get_single_match_statement($field)
 482     {
 483         return $field.$this->compare();
 484     }
 485
 486     // }}}
 487     // {{{ function get_single_where_statement()
 488
 489     function get_single_where_statement($field)
 490     {
 491         return $this->refTable=='' ? $this->get_single_match_statement($field) : false;
 492     }
 493
 494     // }}}
 495     // {{{ function get_select_statement()
 496
 497     function get_select_statement()
 498     {
 499         if ($this->value=='' || $this->refTable=='') {
 500             return false;
 501         }
 502         $res = implode(' OR ', array_filter(array_map(array($this, 'get_single_match_statement'), $this->fieldDbName)));
 503         if (is_array($this->refTable)) {
 504            foreach ($this->refTable as $i => $refT)
 505                $last = $i;
 506            $inner = "";
 507             foreach ($this->refTable as $i => $refT)
 508                 $inner .= " INNER JOIN {$refT} AS {$this->refAlias[$i]} ON ({$this->refCondition[$i]} ".(($i == $last)?"AND ($res) ":"").")\n";
 509             return $inner;
 510         } else {
 511             return "INNER JOIN {$this->refTable} AS {$this->refAlias} ON ({$this->refCondition} AND ($res) )";
 512         }
 513     }
 514
 515     // }}}
 516 }
 517
 518 // }}}
 519
 520 // {{{ class RefSFieldMultipleTable
 521 class PhoneSField extends RefSField
 522 {
 523     function PhoneSField($_fieldFormName, $_fieldDbName='', $_refTable, $_refAlias, $_refCondition)
 524     {
 525         $this->RefSField($_fieldFormName, $_fieldDbName, $_refTable, $_refAlias, $_refCondition, true);
 526     }
 527
 528     function get_request()
 529     {
 530         require_once("profil.func.inc.php");
 531         $this->value = trim(Env::v($this->fieldFormName));
 532         $this->value = format_phone_number($this->value);
 533     }
 534
 535     function compare()
 536     {
 537         return " LIKE '" . addslashes($this->value) . "%'";
 538     }
 539 }
 540
 541 class IndexSField extends RefSField
 542 {
 543     function IndexSField($_fieldFormName, $_fieldDbName='', $_refTable, $_refAlias, $_refCondition)
 544     {
 545         $this->RefSField($_fieldFormName, $_fieldDbName, $_refTable, $_refAlias, $_refCondition, true);
 546     }
 547
 548     function get_request()
 549     {
 550         $this->value = trim(Env::v($this->fieldFormName));
 551     }
 552 }
 553
 554 class MapSField extends RefSField
 555 {
 556     var $mapId;
 557
 558     function MapSField($_fieldFormName, $_fieldDbName='', $_refTable, $_refAlias, $_refCondition, $_mapId=false)
 559     {
 560         if ($_mapId === false)
 561             $this->mapId = Env::v($_fieldFormName, '');
 562         else
 563             $this->mapId = $_mapId;
 564         $this->value =  $this->mapId;
 565         $this->RefSField($_fieldFormName, $_fieldDbName, $_refTable, $_refAlias, $_refCondition, true, false);
 566     }
 567
 568     function get_select_statement()
 569     {
 570         if ($this->mapId === '') return false;
 571         $res = implode(' OR ', array_filter(array_map(array($this, 'get_single_match_statement'), $this->fieldDbName)));
 572         foreach ($this->refTable as $i => $refT)
 573             $last = $i;
 574         $inner = "";
 575         foreach ($this->refTable as $i => $refT)
 576             $inner .= " INNER JOIN {$refT} AS {$this->refAlias[$i]} ON ({$this->refCondition[$i]} ".(($i == $last)?"AND ($res) ":"").")";
 577         return $inner;
 578     }
 579     function get_request()
 580     {
 581         $this->value = $this->mapId;
 582     }
 583 }
 584
 585 // {{{ class RefWithSoundexSField                       [ ??? ]
 586
 587 class RefWithSoundexSField extends RefSField
 588 {
 589     // {{{ function compare()
 590
 591     function compare()
 592     {
 593         return "='".soundex_fr($this->value)."'";
 594     }
 595
 596     // }}}
 597 }
 598
 599 // }}}
 600 // {{{ class StringSField                               [String fields]
 601
 602 /** classe de champ texte (nom par exemple)
 603  */
 604 class StringSField extends SField
 605 {
 606     // {{{ function get_request()
 607
 608     /** récupère la requête de l'utilisateur et échoue si la chaîne contient des caractères
 609      * interdits */
 610     function get_request()
 611     {
 612         parent::get_request();
 613         if (preg_match(":[\]\[<>{}~/§_`|%$^=+]|\*\*:u", $this->value)) {
 614             new ThrowError('Un champ contient un caractère interdit rendant la recherche impossible.');
 615         }
 616     }
 617
 618     // }}}
 619     // {{{ function length()
 620
 621     /** donne la longueur de la requête de l'utilisateur
 622      * (au sens strict i.e. pas d'* ni d'espace ou de trait d'union -> les contraintes réellement
 623      * imposées par l'utilisateur) */
 624     function length()
 625     {
 626         $cleaned = replace_accent(strtolower($this->value));
 627         $length  = strlen(ereg_replace('[a-z0-9]', '', $cleaned));
 628         return strlen($this->value) - $length;
 629     }
 630
 631     // }}}
 632     // {{{ function too_large()
 633
 634     function too_large()
 635     {
 636         return ($this->length()<2);
 637     }
 638
 639     // }}}
 640     // {{{ function get_single_where_statement()
 641
 642     /** clause WHERE correspondant à un champ de la bdd et à ce champ de formulaire
 643      * @param field nom de champ de la bdd concerné par la clause */
 644     function get_single_where_statement($field)
 645     {
 646         $val = addslashes($this->value);
 647         if (Env::i('exact')) return "$field = '$val'";
 648         $regexp = strtr($val, '-*', '_%');
 649         return "$field LIKE '$regexp%'";
 650     }
 651
 652     // }}}
 653     // {{{ function get_order_statement()
 654
 655     /** clause ORDER BY correspondant à ce champ de formulaire */
 656     function get_order_statement()
 657     {
 658         if ($this->value!='' && $this->fieldResultName!='') {
 659             return "{$this->fieldResultName}!='".addslashes($this->value)."'";
 660         } else {
 661             return false;
 662         }
 663     }
 664
 665     // }}}
 666 }
 667
 668 // }}}
 669 // {{{ class NameSField                                 [Names : serach 'n%' + '% b']
 670
 671 /** classe pour les noms : on cherche en plus du like 'foo%' le like '% foo' (particules)
 672 +*/
 673 class NameSField extends StringSField
 674 {
 675     // {{{ function get_single_where_statement()
 676
 677     function get_single_where_statement($field)
 678     {
 679         $val = addslashes($this->value);
 680         if (Env::i('exact')) return "$field = '$val'";
 681         $regexp = strtr($val, '-*', '_%');
 682         return "$field LIKE '$regexp%' OR $field LIKE '% $regexp%' OR $field LIKE '%-$regexp%'";
 683     }
 684
 685     // }}}
 686     // {{{ function get_order_statement()
 687
 688     function get_order_statement()
 689     {
 690         if ($this->value!='' && $this->fieldResultName!='') {
 691             return "{$this->fieldResultName} NOT LIKE '".addslashes($this->value)."'";
 692         } else {
 693             return false;
 694         }
 695     }
 696
 697     // }}}
 698 }
 699
 700 // }}}
 701 // {{{ class StringWithSoundexSField                    [Strings + soundex]
 702
 703 /** classe de champ texte avec soundex (nom par exemple)
 704  */
 705 class StringWithSoundexSField extends StringSField
 706 {
 707     // {{{ function get_single_where_statement()
 708
 709     /** clause WHERE correspondant à un champ de la bdd et à ce champ de formulaire
 710      * @param field nom de champ de la bdd concerné par la clause */
 711     function get_single_where_statement($field) {
 712         return $field.'="'.soundex_fr($this->value).'"';
 713     }
 714
 715     // }}}
 716 }
 717
 718 // }}}
 719 // {{{ class PromoSField                                [Prom field]
 720
 721 /** classe de champ de promotion */
 722 class PromoSField extends SField
 723 {
 724     // {{{ properties
 725
 726     /** opérateur de comparaison (<,>,=) de la promo utilisé pour ce champ de formulaire */
 727     var $compareField;
 728
 729     // }}}
 730     // {{{ constructor
 731
 732     /** constructeur
 733      * compareField est un champ de formulaire très simple qui ne sert qu'à la construction de la
 734      * clause WHERE de la promo */
 735     function PromoSField($_fieldFormName, $_compareFieldFormName, $_fieldDbName, $_fieldResultName)
 736     {
 737         parent::SField($_fieldFormName, $_fieldDbName, $_fieldResultName);
 738         $this->compareField = new SField($_compareFieldFormName);
 739     }
 740
 741     // }}}
 742     // {{{ function get_request()
 743
 744     /** récupère la requête utilisateur et échoue si le champ du formulaire ne représente pas une
 745      * promotion (nombre à 4 chiffres) */
 746     function get_request()
 747     {
 748         parent::get_request();
 749         if (preg_match('/^[0-9]{2}$/', $this->value)){
 750             $this->value = intval($this->value) + 1900;
 751         }
 752         if (!(empty($this->value) or preg_match('/^[0-9]{4}$/', $this->value))) {
 753             new ThrowError('La promotion est une année à quatre chiffres.');
 754         }
 755     }
 756
 757     // }}}
 758     // {{{ function is_a_single_promo()
 759
 760     /** teste si la requête est de la forme =promotion -> contrainte forte imposée -> elle suffit
 761      * pour autoriser un affichage des résultats alors que <promotion est insuffisant */
 762     function is_a_single_promo()
 763     {
 764         return ($this->compareField->value=='=' && $this->value!='');
 765     }
 766
 767     // }}}
 768     // {{{ function too_large()
 769
 770     function too_large()
 771     {
 772         return !$this->is_a_single_promo();
 773     }
 774
 775     // }}}
 776     // {{{ function get_single_where_statement()
 777
 778     /** clause WHERE correspondant à ce champ */
 779     function get_single_where_statement($field)
 780     {
 781         return $field.$this->compareField->value.$this->value;
 782     }
 783
 784     // }}}
 785     // {{{ function get_url()
 786
 787     /** récupérer le bout d'URL correspondant aux paramètres permettant d'imiter une requête
 788      * d'un utilisateur assignant la valeur $this->value à ce champ et assignant l'opérateur de
 789      * comparaison adéquat */
 790     function get_url()
 791     {
 792         if (!($u=parent::get_url())) {
 793             return false;
 794         }
 795         return $u.'&amp;'.$this->compareField->get_url();
 796     }
 797
 798     // }}}
 799 }
 800
 801 // }}}
 802 // {{{ class SFieldGroup                                [Group fields]
 803
 804 /** classe groupant des champs de formulaire de recherche */
 805 class SFieldGroup
 806 {
 807     // {{{ properties
 808
 809     /** tableau des classes correspondant aux champs groupés */
 810     var $fields;
 811     /** type de groupe : ET ou OU */
 812     var $and;
 813
 814     // }}}
 815     // {{{ constuctor
 816
 817     /** constructeur */
 818     function SFieldGroup($_and, $_fields)
 819     {
 820         $this->fields = $_fields;
 821         $this->and    = $_and;
 822         foreach ($this->fields as $key=>&$field) {
 823             if (is_null($field)) {
 824                 unset($this->fields[$key]);
 825             }
 826         }
 827     }
 828
 829     // }}}
 830     // {{{ function too_large()
 831
 832     function too_large()
 833     {
 834         $b = true;
 835         for ($i=0 ; $b && $i<count($this->fields) ; $i++) {
 836             if (!is_null($this->fields[$i])) {
 837                 $b = $b && $this->fields[$i]->too_large();
 838             }
 839         }
 840         return $b;
 841     }
 842
 843     // }}}
 844     // {{{ function field_get_select()
 845
 846     function field_get_select($f)
 847     {
 848         return $f->get_select_statement();
 849     }
 850
 851     // }}}
 852     // {{{ function field_get_where()
 853
 854     /** récupérer la clause WHERE d'un objet champ de recherche */
 855     function field_get_where($f)
 856     {
 857         return $f->get_where_statement();
 858     }
 859
 860     // }}}
 861     // {{{ function field_get_order()
 862
 863     /** récupérer la clause ORDER BY d'un objet champ de recherche */
 864     function field_get_order($f)
 865     {
 866         return $f->get_order_statement();
 867     }
 868
 869     // }}}
 870     // {{{ function field_get_url()
 871
 872     /** récupérer le bout d'URL correspondant à un objet champ de recherche */
 873     function field_get_url($f)
 874     {
 875         return $f->get_url();
 876     }
 877
 878     // }}}
 879     // {{{ function get_select_statement()
 880
 881     function get_select_statement()
 882     {
 883         return implode(' ', array_filter(array_map(array($this, 'field_get_select'), $this->fields)));
 884     }
 885
 886     // }}}
 887     // {{{ function get_where_statement()
 888
 889     /** récupérer la clause WHERE du groupe de champs = conjonction (ET) ou disjonction (OU) de
 890      * clauses des champs élémentaires */
 891     function get_where_statement()
 892     {
 893         $joinText = $this->and ? ' AND ' : ' OR ';
 894         $res = implode($joinText, array_filter(array_map(array($this, 'field_get_where'), $this->fields)));
 895         return $res == '' ? '' : "($res)";
 896     }
 897
 898     // }}}
 899     // {{{ function get_order_statement()
 900
 901     /** récupérer la clause ORDER BY du groupe de champs = conjonction (ET) ou disjonction (OU) de
 902      * clauses des champs élémentaires */
 903     function get_order_statement()
 904     {
 905         $order = array_filter(array_map(array($this, 'field_get_order'), $this->fields));
 906         return count($order)>0 ? implode(',', $order) : false;
 907     }
 908
 909     // }}}
 910     // {{{ function get_url()
 911
 912     /** récupérer le bout d'URL correspondant à ce groupe de champs = concaténation des bouts d'URL
 913      * des champs élémentaires */
 914     function get_url($others=Array())
 915     {
 916         $url = array_filter(array_map(array($this, 'field_get_url'), $this->fields));
 917         foreach ($url as $key=>$val) {
 918             if (empty($val)) {
 919                 unset($url[$key]);
 920             }
 921         }
 922         foreach ($others as $key=>$val) {
 923             if (!empty($val)) {
 924                 $url[] = "$key=$val";
 925             }
 926         }
 927         return count($url)>0 ? implode('&amp;', $url) : false;
 928     }
 929
 930     // }}}
 931 }
 932
 933 // }}}
 934
 935 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
 936 ?>