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