modules/search/classes.inc.php

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