Fix a few ProfileFields (Medals, Corps)
[platal.git] / include / profilefields.inc.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 ProfileField
23 /** To store a "field" from the profile
24 * Provides functions for loading a batch of such data
25 */
26 abstract class ProfileField
27 {
28 /** The profile to which this field belongs
29 */
30 public $pid;
31
32 /** Fetches data from the database for the given pids, compatible with
33 * the visibility context.
34 * @param $pids An array of pids
35 * @param $visibility The level of visibility fetched fields must have
36 * @return a PlIterator yielding data suitable for a "new ProfileBlah($data)"
37 * XXX MUST be reimplemented for each kind of ProfileField
38 */
39 public static function fetchData(array $pids, $visibility)
40 {
41 return PlIteratorUtils::emptyIterator();
42 }
43
44 public static function buildForPID($cls, $pid, $visibility)
45 {
46 $res = self::buildFromPIDs($cls, array($pid), $visibility);
47 return array_pop($res);
48 }
49
50 /** Build a list of ProfileFields from a set of pids
51 * @param $cls The name of the field to create ('ProfileMedals', ...)
52 * @param $pids An array of pids
53 * @param $visibility An array of allowed visibility contexts
54 * @return An array of $pid => ProfileField
55 */
56 public static function buildFromPIDs($cls, array $pids, $visibility)
57 {
58 $it = new ProfileFieldIterator($cls, $pids, $visibility);
59 $res = array();
60 while ($pf = $it->next()) {
61 $res[$pf->pid] = $pf;
62 }
63 return $res;
64 }
65
66 public static function getForPID($cls, $pid, $visibility)
67 {
68 $it = new ProfileFieldIterator($cls, array($pid), $visibility);
69 return $it->next();
70 }
71 }
72 // }}}
73
74 // {{{ class ProfileFieldIterator
75 class ProfileFieldIterator implements PlIterator
76 {
77 private $data;
78 private $cls;
79
80 public function __construct($cls, array $pids, $visibility)
81 {
82 $this->data = call_user_func(array($cls, 'fetchData'), $pids, $visibility);
83 $this->cls = $cls;
84 }
85
86 public function next()
87 {
88 $d = $this->data->next();
89 if ($d == null) {
90 return null;
91 } else {
92 $cls = $this->cls;
93 return new $cls($d);
94 }
95 }
96
97 public function total()
98 {
99 return $this->data->total();
100 }
101
102 public function first()
103 {
104 return $this->data->first();
105 }
106
107 public function last()
108 {
109 return $this->data->last();
110 }
111 }
112 // }}}
113
114 // {{{ class Phone
115 class Phone
116 {
117 const TYPE_FAX = 'fax';
118 const TYPE_FIXED = 'fixed';
119 const TYPE_MOBILE = 'mobile';
120 public $type;
121
122 public $search;
123 public $display;
124 public $comment = '';
125
126 const LINK_JOB = 'job';
127 const LINK_ADDRESS = 'address';
128 const LINK_PROFILE = 'user';
129 const LINK_COMPANY = 'hq';
130 public $link_type;
131 public $link_id;
132
133 /** Fields are :
134 * $type, $search, $display, $link_type, $link_id, $comment, $pid, $id
135 */
136 public function __construct($data)
137 {
138 foreach ($data as $key => $val) {
139 $this->$key = $val;
140 }
141 }
142 }
143 // }}}
144 // {{{ class Company
145 class Company
146 {
147 public $id;
148 public $name;
149 public $acronym;
150 public $url;
151 public $phone = null;
152 public $address = null;
153
154 /** Fields are:
155 * $id, $name, $acronym, $url
156 */
157 public function __construct($data)
158 {
159 foreach ($data as $key => $val) {
160 $this->$key = $val;
161 }
162 }
163
164 public function setPhone(Phone &$phone)
165 {
166 if ($phone->link_type == Phone::LINK_COMPANY && $phone->link_id == $this->id) {
167 $this->phone = $phone;
168 }
169 }
170
171 public function setAddress(Address &$address)
172 {
173 if ($address->link_type == Address::LINK_COMPANY && $address->link_id == $this->id) {
174 $this->address = $address;
175 }
176 }
177
178 }
179 // }}}
180 // {{{ class Job
181 class Job
182 {
183 public $pid;
184 public $id;
185
186 public $company = null;
187 private $phones = array();
188 private $address = null;
189
190 public $jobid;
191
192 public $description;
193 public $user_site;
194 public $user_email;
195
196 public $sector;
197 public $subsector;
198 public $subsubsector;
199
200 /** Fields are:
201 * pid, id, company_id, description, url, email
202 */
203 public function __construct($data)
204 {
205 foreach ($data as $key => $val) {
206 $this->$key = $val;
207 }
208 $this->company = CompanyList::get($this->jobid);
209 }
210
211 public function phones()
212 {
213 return $this->phones;
214 }
215
216 public function addPhone(Phone &$phone)
217 {
218 if ($phone->link_type == Phone::LINK_JOB && $phone->link_id == $this->id && $phone->pid == $this->pid) {
219 $this->phones[] = $phone;
220 }
221 }
222
223 public function setAddress(Address $address)
224 {
225 if ($address->link_id == Address::LINK_JOB && $address->link_id == $this->id && $address->pid == $this->pid) {
226 $this->address = $address;
227 }
228 }
229 }
230 // }}}
231 // {{{ class Address
232 class Address
233 {
234 const LINK_JOB = 'job';
235 const LINK_COMPANY = 'hq';
236 const LINK_PROFILE = 'home';
237
238 public $flags;
239 public $link_id;
240 public $link_type;
241
242 public $text;
243 public $postalCode;
244 public $latitude;
245 public $longitude;
246
247 public $locality;
248 public $subAdministrativeArea;
249 public $administrativeArea;
250 public $country;
251
252 private $phones = array();
253
254 /** Fields are:
255 * pîd, id, link_id, link_type, flags, text, postcode, country
256 */
257 public function __construct($data)
258 {
259 foreach ($data as $key => $val) {
260 $this->$key = $val;
261 }
262 }
263
264 public function addPhone(Phone &$phone)
265 {
266 if ($phone->link_type == Phone::LINK_ADDRESS && $phone->link_id == $this->id && $phone->pid == $this->pid) {
267 $this->phones[] = $phone;
268 }
269 }
270
271 public function phones()
272 {
273 return $this->phones;
274 }
275
276 public function hasFlags($flags)
277 {
278 return $flags & $this->flags;
279 }
280 }
281 // }}}
282 // {{{ class Education
283 class Education
284 {
285 public $id;
286 public $pid;
287
288 public $entry_year;
289 public $grad_year;
290 public $program;
291 public $flags;
292
293 public $school;
294 public $school_short;
295 public $school_url;
296 public $country;
297
298 public $degree;
299 public $degree_short;
300 public $degree_level;
301
302 public function __construct(array $data)
303 {
304 foreach ($data as $key => $val) {
305 $this->$key = $val;
306 }
307 $this->flags = new PlFlagSet($this->flags);
308 }
309 }
310 // }}}
311
312 // {{{ class ProfileEducation [ Field ]
313 class ProfileEducation extends ProfileField
314 {
315 private $educations = array();
316
317 public function __construct(PlInnerSubIterator $it)
318 {
319 $this->pid = $it->value();
320 $this->visibility = Profile::VISIBILITY_PUBLIC;
321 while ($edu = $it->next()) {
322 $this->educations[$edu['id']] = new Education($edu);
323 }
324 }
325
326 public function get($flags, $limit)
327 {
328 $educations = array();
329 $year = getdate();
330 $year = $year['year'];
331 $nb = 0;
332 foreach ($this->educations as $id => $edu) {
333 if (
334 (($flags & Profile::EDUCATION_MAIN) && $edu->flags->hasFlag('primary'))
335 ||
336 (($flags & Profile::EDUCATION_EXTRA) && !$edu->flags->hasFlag('primary'))
337 ||
338 (($flags & Profile::EDUCATION_FINISHED) && $edu->grad_year <= $year)
339 ||
340 (($flags & Profile::EDUCATION_CURRENT) && $edu->grad_year > $year)
341 ) {
342 $educations[$id] = $edu;
343 ++$nb;
344 }
345 if ($limit != null && $nb >= $limit) {
346 break;
347 }
348 }
349 return PlIteratorUtils::fromArray($educations, 1, true);
350 }
351
352 public static function fetchData(array $pids, $visibility)
353 {
354 $data = XDB::iterator('SELECT pe.id, pe.pid,
355 pe.entry_year, pe.grad_year, pe.program, pe.flags,
356 pee.name AS school, pee.abbreviation AS school_short,
357 pee.url AS school_url, gc.countryFR AS country,
358 pede.degree, pede.abbreviation AS degree_short, pede.level AS degree_level,
359 pefe.field
360 FROM profile_education AS pe
361 LEFT JOIN profile_education_enum AS pee ON (pee.id = pe.eduid)
362 LEFT JOIN geoloc_countries AS gc ON (gc.iso_3166_1_a2 = pee.country)
363 LEFT JOIN profile_education_degree_enum AS pede ON (pede.id = pe.degreeid)
364 LEFT JOIN profile_education_field_enum AS pefe ON (pefe.id = pe.fieldid)
365 WHERE pe.pid IN {?}
366 ORDER BY ' . XDB::formatCustomOrder('pid', $pids) . ',
367 NOT FIND_IN_SET(\'primary\', pe.flags), pe.entry_year, pe.id',
368 $pids);
369
370 return PlIteratorUtils::subIterator($data, PlIteratorUtils::arrayValueCallback('pid'));
371 }
372 }
373 // }}}
374 // {{{ class ProfileMedals [ Field ]
375 class ProfileMedals extends ProfileField
376 {
377 public $medals = array();
378
379 public function __construct(PlInnerSubIterator $it)
380 {
381 $this->pid = $it->value();
382 while ($medal = $it->next()) {
383 $this->medals[$medal['mid']] = $medal['gid'];
384 }
385 }
386
387 public static function fetchData(array $pids, $visibility)
388 {
389 $data = XDB::iterator('SELECT pm.pid, pm.mid, pm.gid
390 FROM profile_medals AS pm
391 LEFT JOIN profiles AS p ON (pm.pid = p.pid)
392 WHERE pm.pid IN {?} AND p.medals_pub IN {?}
393 ORDER BY ' . XDB::formatCustomOrder('pm.pid', $pids),
394 $pids, $visibility);
395
396 return PlIteratorUtils::subIterator($data, PlIteratorUtils::arrayValueCallback('pid'));
397 }
398 }
399 // }}}
400 // {{{ class ProfileNetworking [ Field ]
401 class ProfileNetworking extends ProfileField
402 {
403 private $networks = array();
404
405 public function __construct(PlIterator $it)
406 {
407 while ($network = $it->next()) {
408 $this->networks[$network['nwid']] = $network['address'];
409 }
410 }
411
412 public static function fetchData(array $pids, $visibility)
413 {
414 $data = XDB::iterator('SELECT pid, nwid, address, network_type
415 FROM profile_networking
416 WHERE pid IN {?} AND pub IN {?}
417 ORDER BY ' . XDB::formatCustomOrder('pid', $pids) . ',
418 network_type, nwid',
419 $pids, $visibility);
420
421 return PlIteratorUtils::subIterator($data, PlIteratorUtils::arrayValueCallback('pid'));
422 }
423
424 public function get($flags, $limit = null)
425 {
426 $nws = array();
427 $nb = 0;
428 foreach ($this->networks as $id => $nw) {
429 // XXX hardcoded reference to web site index
430 if (
431 (($flags & self::NETWORKING_WEB) && $nw['network_type'] == 0)
432 ||
433 (! ($flags & self::NETWORKING_WEB))
434 ) {
435 $nws[$id] = $nw;
436 ++$nb;
437 }
438 if ($nb >= $limit) {
439 break;
440 }
441 }
442 return PlIteratorUtils::fromArray($nws, 1, true);
443 }
444 }
445 // }}}
446 // {{{ class ProfilePhoto [ Field ]
447 class ProfilePhoto extends ProfileField
448 {
449 public $pic;
450
451 public function __construct(array $data)
452 {
453 if ($data == null || count($data) == 0) {
454 $this->pic = null;
455 } else {
456 $this->pid = $data['pid'];
457 $this->pic = PlImage::fromDATA($data['attach'],
458 $data['attachmime'],
459 $data['x'],
460 $data['y']);
461 }
462 }
463
464 public static function fetchData(array $pids, $visibility)
465 {
466 $data = XDB::iterator('SELECT *
467 FROM profile_photos
468 WHERE pid IN {?} AND attachmime IN (\'jpeg\', \'png\') AND pub IN {?}
469 ORDER BY ' . XDB::formatCustomOrder('pid', $pids),
470 $pids, $visibility);
471
472 return $data;
473 }
474 }
475 // }}}
476 // {{{ class ProfileCorps [ Field ]
477 class ProfileCorps extends ProfileField
478 {
479 public $original;
480 public $current;
481 public $rank;
482
483 public function __construct(array $data)
484 {
485 $this->original = $data['original_corpsid'];
486 $this->current = $data['current_corpsid'];
487 $this->rank = $data['rankid'];
488 $this->visibility = $data['corps_pub'];
489 }
490
491 public static function fetchData(array $pids, $visibility)
492 {
493 $data = XDB::iterator('SELECT pid, original_corpsid, current_corpsid,
494 rankid
495 FROM profile_corps
496 WHERE pid IN {?} AND corps_pub IN {?}
497 ORDER BY ' . XDB::formatCustomOrder('pid', $pids),
498 $pids, $visibility);
499
500 return $data;
501 }
502 }
503 // }}}
504
505 /** Loading of data for a Profile :
506 * 1) load jobs, addresses, phones
507 * 2) attach phones to addresses, jobs and profiles
508 * 3) attach addresses to jobs and profiles
509 */
510
511 // {{{ class ProfileAddresses [ Field ]
512 class ProfileAddresses extends ProfileField
513 {
514 private $addresses = array();
515
516 public function __construct(PlIterator $it)
517 {
518 if ($it instanceof PlInnerSubIterator) {
519 $this->pid = $it->value();
520 }
521
522 while ($addr = $it->next()) {
523 $this->addresses[] = new Address($addr);
524 }
525 }
526
527 public function get($flags, $limit = null)
528 {
529 $res = array();
530 $nb = 0;
531 foreach ($this->addresses as $addr) {
532 if ($addr->hasFlags($flags)) {
533 $res[] = $addr;
534 $nb++;
535 }
536 if ($limit != null && $nb == $limit) {
537 break;
538 }
539 }
540 return PlIteratorUtils::fromArray($res, 1, true);
541 }
542
543 public static function fetchData(array $pids, $visibility)
544 {
545 $data = XDB::iterator('SELECT pa.id, pa.pid, pa.flags, pa.type AS link_type,
546 IF(pa.type = \'home\', pid, jobid) AS link_id,
547 pa.text, pa.postalCode, pa.latitude, pa.longitude,
548 gl.name AS locality, gas.name AS subAdministrativeArea,
549 ga.name AS administrativeArea, gc.countryFR AS country
550 FROM profile_addresses AS pa
551 LEFT JOIN geoloc_localities AS gl ON (gl.id = pa.localityId)
552 LEFT JOIN geoloc_administrativeareas AS ga ON (ga.id = pa.administrativeAreaId)
553 LEFT JOIN geoloc_administrativeareas AS gas ON (gas.id = pa.subAdministrativeAreaId)
554 LEFT JOIN geoloc_countries AS gc ON (gc.iso_3166_1_a2 = pa.countryId)
555 WHERE pa.pid in {?} AND pa.pub IN {?}
556 ORDER BY ' . XDB::formatCustomOrder('pid', $pids),
557 $pids, $visibility);
558
559 return PlIteratorUtils::subIterator($data, PlIteratorUtils::arrayValueCallback('pid'));
560 }
561
562 public function addPhones(ProfilePhones $phones)
563 {
564 $p = $phones->get(0);
565 while ($phone = $p->next()) {
566 if ($phone->link_type == Phone::LINK_ADDRESS && array_key_exists($phone->link_id, $this->addresses)) {
567 $this->addresses[$phone->link_id]->addPhone($phone);
568 }
569 }
570 }
571 }
572 // }}}
573 // {{{ class ProfilePhones [ Field ]
574 class ProfilePhones extends ProfileField
575 {
576 private $phones = array();
577
578 public function __construct(PlInnerSubIterator $it)
579 {
580 $this->pid = $it->value();
581 while ($phone = $it->next()) {
582 $this->phones[] = new Phone($phone);
583 }
584 }
585
586 public function get($flags, $limit = null)
587 {
588 $phones = array();
589 $nb = 0;
590 foreach ($this->phones as $id => $phone) {
591 $phones[$id] = $phone;
592 ++$nb;
593 if ($limit != null && $nb == $limit) {
594 break;
595 }
596 }
597 return PlIteratorUtils::fromArray($phones, 1, true);
598 }
599
600 public static function fetchData(array $pids, $visibility)
601 {
602 $data = XDB::iterator('SELECT tel_type AS type, search_tel AS search, display_tel AS display, link_type, comment
603 FROM profile_phones
604 WHERE pid IN {?} AND pub IN {?}
605 ORDER BY ' . XDB::formatCustomOrder('pid', $pids),
606 $pids, $visibility);
607 return PlIteratorUtils::subIterator($data, PlIteratorUtils::arrayValueCallback('pid'));
608 }
609 }
610 // }}}
611 // {{{ class ProfileJobs [ Field ]
612 class ProfileJobs extends ProfileField
613 {
614 private $jobs = array();
615
616 public function __construct(PlInnerSubIterator $jobs)
617 {
618 $this->pid = $jobs->value();
619 while ($job = $jobs->next()) {
620 $this->jobs[$job['id']] = new Job($job);
621 }
622 }
623
624 public static function fetchData(array $pids, $visibility)
625 {
626 CompanyList::preload($pids);
627 $data = XDB::iterator('SELECT pj.id, pj.pid, pj.description, pj.url as user_site,
628 IF(pj.email_pub IN {?}, pj.email, NULL) AS user_email,
629 pj.jobid, pjse.name AS sector, pjsse.name AS subsector,
630 pjssse.name AS subsubsector
631 FROM profile_job AS pj
632 LEFT JOIN profile_job_sector_enum AS pjse ON (pjse.id = pj.sectorid)
633 LEFT JOIN profile_job_subsector_enum AS pjsse ON (pjsse.id = pj.subsectorid)
634 LEFT JOIN profile_job_subsubsector_enum AS pjssse ON (pjssse.id = pj.subsubsectorid)
635 WHERE pj.pid IN {?} AND pj.pub IN {?}
636 ORDER BY ' . XDB::formatCustomOrder('pid', $pids) . ',
637 pj.id',
638 $visibility, $pids, $visibility);
639 return PlIteratorUtils::subIterator($data, PlIteratorUtils::arrayValueCallback('pid'));
640 }
641
642 public function get($flags, $limit = null)
643 {
644 $jobs = array();
645 $nb = 0;
646 foreach ($this->jobs as $id => $job) {
647 $jobs[$id] = $job;
648 ++$nb;
649 if ($limit != null && $nb >= $limit) {
650 break;
651 }
652 }
653 return PlIteratorUtils::fromArray($jobs, 1, true);
654 }
655
656 public function addPhones(ProfilePhones $phones)
657 {
658 $p = $phones->get(0);
659 while ($phone = $p->next()) {
660 if ($phone->link_type == Phone::LINK_JOB && array_key_exists($phone->link_id, $this->jobs)) {
661 $this->jobs[$phone->link_id]->addPhones($phone);
662 }
663 }
664 }
665
666 public static function addAddresses(ProfileAddresses $addresses)
667 {
668 $a = $addresses->get(Profile::ADDRESS_PRO);
669 while ($address = $a->next()) {
670 if ($address->link_type == Address::LINK_JOB && array_key_exists($address->link_id, $this->jobs)) {
671 $this->jobs[$address->link_id]->setAddress($address);
672 }
673 }
674 }
675
676 public static function addCompanies(array $companies)
677 {
678 foreach ($this->jobs as $job)
679 {
680 $job->company = $companies[$job->jobid];
681 }
682 }
683 }
684 // }}}
685
686 // {{{ class CompanyList
687 class CompanyList
688 {
689 static private $fullload = false;
690 static private $companies = array();
691
692 static public function preload($pids = array())
693 {
694 if (self::$fullload) {
695 return;
696 }
697 // Load raw data
698 if (count($pids)) {
699 $join = 'LEFT JOIN profile_job ON (profile_job.jobid = pje.id)';
700 $where = 'WHERE profile_job.pid IN ' . XDB::formatArray($pids);
701 } else {
702 $join = '';
703 $where = '';
704 }
705
706 $it = XDB::iterator('SELECT pje.id, pje.name, pje.acronym, pje.url,
707 pa.flags, pa.text, pa.postalCode, pa.countryId,
708 pa.type, pa.pub
709 FROM profile_job_enum AS pje
710 LEFT JOIN profile_addresses AS pa ON (pje.id = pa.jobid AND pa.type = \'hq\')
711 ' . $join . '
712 ' . $where);
713 while ($row = $it->next()) {
714 $cp = new Company($row);
715 $addr = new Address($row);
716 $cp->setAddress($addr);
717 self::$companies[$row['id']] = $cp;
718 }
719
720 // TODO: add phones to addresses
721 if (count($pids) == 0) {
722 self::$fullload = true;
723 }
724 }
725
726 static public function get($id)
727 {
728 if (!array_key_exists($id, self::$companies)) {
729 self::preload();
730 }
731 return self::$companies[$id];
732 }
733 }
734
735 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
736 ?>