Improve the PlView code, adding comments.
[platal.git] / modules / search.php
1 <?php
2 /***************************************************************************
3 * Copyright (C) 2003-2010 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 class SearchModule extends PLModule
23 {
24 function handlers()
25 {
26 return array(
27 'search' => $this->make_hook('quick', AUTH_PUBLIC),
28 'search/adv' => $this->make_hook('advanced', AUTH_COOKIE, 'directory_ax'),
29 'advanced_search.php' => $this->make_hook('redir_advanced', AUTH_PUBLIC),
30 'search/autocomplete' => $this->make_hook('autocomplete', AUTH_COOKIE, 'directory_ax', NO_AUTH),
31 'search/list' => $this->make_hook('list', AUTH_COOKIE, 'directory_ax', NO_AUTH),
32 );
33 }
34
35 function handler_redir_advanced(&$page, $mode = null)
36 {
37 pl_redirect('search/adv');
38 exit;
39 }
40
41 function form_prepare()
42 {
43 Platal::page()->assign('formulaire',1);
44 }
45
46 /**
47 * $model: The way of presenting the results: minifiche, trombi, geoloc.
48 * $byletter: Show only names beginning with this letter
49 */
50 function handler_quick(&$page, $model = null, $byletter = null)
51 {
52 global $globals;
53
54 if (Env::has('quick') || $model == 'geoloc') {
55 $quick = Env::t('quick');
56 if (S::logged() && !Env::has('page')) {
57 S::logger()->log('search', 'quick=' . $quick);
58 }
59
60 if ($quick == '') {
61 $page->trigWarning('Aucun critère de recherche n\'est spécifié.');
62 $page->changeTpl('search/index.tpl');
63 $page->setTitle('Annuaire');
64 $page->assign('formulaire', 1);
65 $page->addJsLink('ajax.js');
66 return;
67 }
68
69 $list = 'profile|prf|fiche|fic|referent|ref|mentor';
70 if (S::admin()) {
71 $list .= '|admin|adm|ax';
72 }
73 if (preg_match('/^(' . $list . '):([-a-z]+(\.[-a-z]+(\.\d{2,4})?)?)$/', replace_accent($quick), $matches)) {
74 $login = $matches[2];
75 switch($matches[1]) {
76 case 'admin': case 'adm':
77 $base = 'admin/user/';
78 break;
79 case 'ax':
80 $base = 'profile/ax/';
81 break;
82 case 'profile': case 'prf': case 'fiche': case 'fic':
83 $base = 'profile/';
84 break;
85 case 'referent': case 'ref': case 'mentor':
86 $base = 'referent/';
87 break;
88 }
89
90 $user = User::getSilent($login);
91 if ($user) {
92 pl_redirect($base . $user->login());
93 }
94 $_REQUEST['quick'] = $login;
95 $_GET['quick'] = $login;
96 } elseif (strpos($quick, 'doc:') === 0) {
97 $url = 'Docs/Recherche?';
98 $url .= 'action=search&q=' . urlencode(substr($quick, 4));
99 $url .= '&group=' . urlencode('-Equipe,-Main,-PmWiki,-Site,-Review');
100 pl_redirect($url);
101 } elseif (strpos($quick, 'trombi:') === 0) {
102 $promo = substr($quick, 7);
103 $res = XDB::query("SELECT diminutif
104 FROM groups
105 WHERE cat = 'Promotions' AND diminutif = {?}",
106 $promo);
107 if ($res->numRows() == 0) {
108 $page->trigWarning("La promotion demandée n'est pas valide: $promo");
109 } else {
110 http_redirect('http://www.polytechnique.net/login/' . $promo . '/annuaire/trombi');
111 }
112 }
113
114 $page->assign('formulaire', 0);
115
116 require_once 'userset.inc.php';
117 $view = new SearchSet(true);
118 $view->addMod('minifiche', 'Mini-fiches', true, array('with_score' => true, 'starts_with' => $byletter));
119 if (S::logged() && !Env::i('nonins')) {
120 $view->addMod('trombi', 'Trombinoscope', false, array('with_promo' => true, 'with_score' => true));
121 // TODO: Reactivate when the new map is completed.
122 // $view->addMod('geoloc', 'Planisphère', false, array('with_annu' => 'search/adv'));
123 }
124 $view->apply('search', $page, $model);
125
126 $nb_tot = $view->count();
127 $page->assign('search_results_nb', $nb_tot);
128 if (!S::logged() && $nb_tot > $globals->search->public_max) {
129 $page->trigError('Votre recherche a généré trop de résultats pour un affichage public.');
130 } elseif ($nb_tot > $globals->search->private_max) {
131 $page->trigError('Recherche trop générale. Une <a href="search/adv">recherche avancée</a> permet de préciser la recherche.');
132 } elseif (empty($nb_tot)) {
133 $page->trigError('Il n\'existe personne correspondant à ces critères dans la base !');
134 }
135 } else {
136 $page->assign('formulaire',1);
137 $page->addJsLink('ajax.js');
138 }
139
140 $page->changeTpl('search/index.tpl');
141 $page->setTitle('Annuaire');
142 }
143
144 /** $model is the way of presenting the results: minifiche, trombi, geoloc.
145 */
146 function handler_advanced(&$page, $model = null, $byletter = null)
147 {
148 global $globals;
149 require_once 'geocoding.inc.php';
150 $page->assign('advanced',1);
151 $page->addJsLink('jquery.autocomplete.js');
152
153 if (!Env::has('rechercher') && $model != 'geoloc') {
154 $this->form_prepare();
155 } else {
156 if (!Env::has('page')) {
157 S::logger()->log('search', 'adv=' . var_export($_GET, true));
158 }
159
160 require_once 'userset.inc.php';
161 $view = new SearchSet(false);
162 $view->addMod('minifiche', 'Mini-fiches', true, array('starts_with' => $byletter));
163 $view->addMod('trombi', 'Trombinoscope', false, array('with_promo' => true));
164 // TODO: Reactivate when the new map is completed.
165 // $view->addMod('geoloc', 'Planisphère', false, array('with_annu' => 'search/adv'));
166 $view->apply('search/adv', $page, $model);
167
168 $nb_tot = $view->count();
169 if ($nb_tot > $globals->search->private_max) {
170 $this->form_prepare();
171 $page->trigError('Recherche trop générale.');
172 } else if ($nb_tot == 0) {
173 $this->form_prepare();
174 $page->trigError('Il n\'existe personne correspondant à ces critères dans la base !');
175 }
176 }
177
178 $page->changeTpl('search/index.tpl', $model == 'mini' ? SIMPLE : SKINNED);
179 $page->addJsLink('ajax.js');
180 $page->assign('public_directory',0);
181 }
182
183 function handler_autocomplete(&$page, $type = null)
184 {
185 // Autocompletion : according to type required, return
186 // a list of results matching with the number of matches.
187 // The output format is :
188 // result1|nb1
189 // result2|nb2
190 // ...
191 pl_content_headers("text/plain");
192 $q = preg_replace(array('/\*+$/', // always look for $q*
193 '/([\^\$\[\]])/', // escape special regexp char
194 '/\*/'), // replace joker by regexp joker
195 array('',
196 '\\\\\1',
197 '.*'),
198 Env::s('q'));
199 if (!$q) exit();
200
201 // try to look in cached results
202 $cache = XDB::query('SELECT result
203 FROM search_autocomplete
204 WHERE name = {?} AND
205 query = {?} AND
206 generated > NOW() - INTERVAL 1 DAY',
207 $type, $q);
208 if ($res = $cache->fetchOneCell()) {
209 echo $res;
210 die();
211 }
212
213 $enums = array(
214 'binetTxt' => DirEnum::BINETS,
215 'groupexTxt' => DirEnum::GROUPESX,
216 'sectionTxt' => DirEnum::SECTIONS,
217 'networking_typeTxt' => DirEnum::NETWORKS,
218 'city' => DirEnum::LOCALITIES,
219 'countryTxt' => DirEnum::COUNTRIES,
220 'entreprise' => DirEnum::COMPANIES,
221 'secteurTxt' => DirEnum::SECTORS,
222 'description' => DirEnum::JOBDESCRIPTION,
223 'nationaliteTxt' => DirEnum::NATIONALITIES,
224 'schoolTxt' => DirEnum::EDUSCHOOLS,
225 );
226 if (!array_key_exists($type, $enums)) {
227 exit();
228 }
229
230 $enum = $enums[$type];
231
232 $list = DirEnum::getAutoComplete($enum, $q);
233 $nbResults = 0;
234 $res = "";
235 while ($result = $list->next()) {
236 $nbResults++;
237 if ($nbResults == 11) {
238 $res .= $q."|-1\n";
239 } else {
240 $res .= $result['field'].'|';
241 if (isset($result['nb'])) {
242 $res .= $result['nb'];
243 }
244 if (isset($result['id'])) {
245 $res .= '|'.$result['id'];
246 }
247 $res .= "\n";
248 }
249 }
250 XDB::query('REPLACE INTO search_autocomplete
251 VALUES ({?}, {?}, {?}, NOW())',
252 $type, $q, $res);
253 echo $res;
254 exit();
255 }
256
257 function handler_list(&$page, $type = null, $idVal = null)
258 {
259 $page->assign('name', $type);
260 $page->assign('with_text_value', true);
261 $page->assign('onchange', "document.forms.recherche.{$type}Txt.value = this.options[this.selectedIndex].text");
262
263 // Give the list of all values possible of type and builds a select input for it
264 $ids = null;
265
266 switch ($type) {
267 case 'binet':
268 $ids = DirEnum::getOptionsIter(DirEnum::BINETS);
269 break;
270 case 'networking_type':
271 $ids = DirEnum::getOptionsIter(DirEnum::NETWORKS);
272 break;
273 case 'country':
274 $ids = DirEnum::getOptionsIter(DirEnum::COUNTRIES);
275 $page->assign('onchange', 'changeCountry(this.value)');
276 break;
277 case 'diploma':
278 if (Env::has('school') && Env::i('school') != 0) {
279 $ids = DirEnum::getOptionsIter(DirEnum::EDUDEGREES, Env::i('school'));
280 } else {
281 $ids = DirEnum::getOptionsIter(DirEnum::EDUDEGREES);
282 }
283 break;
284 case 'groupex':
285 $ids = DirEnum::getOptionsIter(DirEnum::GROUPESX);
286 break;
287 case 'nationalite':
288 $ids = DirEnum::getOptionsIter(DirEnum::NATIONALITIES);
289 break;
290 case 'region':
291 if (Env::has('country')) {
292 $ids = DirEnum::getOptionsIter(DirEnum::ADMINAREAS, Env::v('country'));
293 } else {
294 $ids = DirEnum::getOptionsIter(DirEnum::ADMINAREAS);
295 }
296 break;
297 case 'school':
298 $ids = DirEnum::getOptionsIter(DirEnum::EDUSCHOOLS);
299 $page->assign('onchange', 'changeSchool(this.value)');
300 break;
301 case 'section':
302 $ids = DirEnum::getOptionsIter(DirEnum::SECTIONS);
303 break;
304 case 'secteur':
305 $ids = DirEnum::getOptionsIter(DirEnum::SECTORS);
306 break;
307 default: exit();
308 }
309 if (isset($idVal)) {
310 pl_content_headers("text/plain");
311 echo $ids[$idVal];
312 exit();
313 }
314 pl_content_headers("text/xml");
315 $page->changeTpl('include/field.select.tpl', NO_SKIN);
316 $page->assign('list', $ids);
317 }
318 }
319
320 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
321 ?>