1b657c8626e58eb0124ea7f314f8ab65b1f6ea06
2 /***************************************************************************
3 * Copyright (C) 2003-2010 Polytechnique.org *
4 * http://opensource.polytechnique.org/ *
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. *
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. *
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 *
19 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA *
20 ***************************************************************************/
24 static private $v_values = array('public' => array('public'),
25 'ax' => array('ax', 'public'),
26 'private' => array('private', 'ax', 'public'));
28 const VISIBILITY_PUBLIC
= 'public';
29 const VISIBILITY_AX
= 'ax';
30 const VISIBILITY_PRIVATE
= 'private';
33 const LASTNAME
= 'lastname';
34 const FIRSTNAME
= 'firstname';
35 const NICKNAME
= 'nickname';
36 const PSEUDONYM
= 'pseudonym';
39 const VN_MARITAL
= 'marital';
40 const VN_ORDINARY
= 'ordinary';
41 const VN_OTHER
= 'other';
44 const DN_FULL
= 'directory_name';
45 const DN_DISPLAY
= 'yourself';
46 const DN_YOURSELF
= 'yourself';
47 const DN_DIRECTORY
= 'directory_name';
48 const DN_PRIVATE
= 'private_name';
49 const DN_PUBLIC
= 'public_name';
50 const DN_SHORT
= 'short_name';
51 const DN_SORT
= 'sort_name';
52 /* education related names */
53 const EDU_X
= 'École polytechnique';
54 const DEGREE_X
= 'Ingénieur';
55 const DEGREE_M
= 'Master';
56 const DEGREE_D
= 'Doctorat';
58 static public $name_variants = array(
59 self
::LASTNAME
=> array(self
::VN_MARITAL
, self
::VN_ORDINARY
),
60 self
::FIRSTNAME
=> array(self
::VN_ORDINARY
, self
::VN_INI
, self
::VN_OTHER
)
63 const ADDRESS_MAIN
= 0x000001;
64 const ADDRESS_PERSO
= 0x000002;
65 const ADDRESS_PRO
= 0x000004;
66 const ADDRESS_ALL
= 0x000006;
67 const ADDRESS_POSTAL
= 0x000008;
69 const EDUCATION_MAIN
= 0x000010;
70 const EDUCATION_EXTRA
= 0x000020;
71 const EDUCATION_ALL
= 0x000040;
72 const EDUCATION_FINISHED
= 0x000080;
73 const EDUCATION_CURRENT
= 0x000100;
75 const JOBS_MAIN
= 0x001000;
76 const JOBS_ALL
= 0x002000;
77 const JOBS_FINISHED
= 0x004000;
78 const JOBS_CURRENT
= 0x008000;
80 const NETWORKING_ALL
= 0x000000;
81 const NETWORKING_WEB
= 0x010000;
82 const NETWORKING_IM
= 0x020000;
83 const NETWORKING_SOCIAL
= 0x040000;
87 private $data = array();
89 private $visibility = null
;
91 private function __construct(array $data)
94 $this->pid
= $this->data
['pid'];
95 $this->hrpid
= $this->data
['hrpid'];
97 $this->setVisibilityLevel(self
::VISIBILITY_PUBLIC
);
106 public function hrid()
111 public function promo()
116 public function yearpromo()
118 return intval(substr($this->promo
, 1, 4));
121 /** Print a name with the given formatting:
129 public function name($format)
131 return str_replace(array('%s', '%f', '%l', '%F', '%S', '%p'),
132 array($this->isFemale() ?
'•' : '',
133 $this->firstName(), $this->lastName(),
134 $this->fullName(), $this->shortName(),
135 $this->promo()), $format);
138 public function fullName($with_promo = false
)
141 return $this->full_name
. ' (' . $this->promo
. ')';
143 return $this->full_name
;
146 public function shortName($with_promo = false
)
149 return $this->short_name
. ' (' . $this->promo
. ')';
151 return $this->short_name
;
154 public function firstName()
156 return $this->firstname
;
159 public function firstNames()
161 return $this->nameVariants(self
::FIRSTNAME
);
164 public function lastName()
166 return $this->lastname
;
169 public function lastNames()
171 return $this->nameVariants(self
::LASTNAME
);
174 public function isFemale()
176 return $this->sex
== PlUser
::GENDER_FEMALE
;
179 public function data()
185 private function nameVariants($type)
187 $vals = array($this->$type);
188 foreach (self
::$name_variants[$type] as $var) {
189 $vartype = $type . '_' . $var;
190 $varname = $this->$vartype;
191 if ($varname != null
&& $varname != "") {
195 return array_unique($vals);
198 public function nationalities()
201 if ($this->nationality1
) {
202 $nats[] = $this->nationality1
;
204 if ($this->nationality2
) {
205 $nats[] = $this->nationality2
;
207 if ($this->nationality3
) {
208 $nats[] = $this->nationality3
;
213 public function __get($name)
215 if (property_exists($this, $name)) {
219 if (isset($this->data
[$name])) {
220 return $this->data
[$name];
226 public function __isset($name)
228 return property_exists($this, $name) ||
isset($this->data
[$name]);
231 /** Sets the level of visibility of the profile
232 * Sets $this->visibility to a list of valid visibilities.
233 * @param one of the self::VISIBILITY_* values
235 public function setVisibilityLevel($visibility)
237 if ($visibility != self
::VISIBILITY_PRIVATE
238 && $visibility != self
::VISIBILITY_AX
239 && $visibility != self
::VISIBILITY_PUBLIC
) {
240 Platal
::page()->kill("Visibility invalide: " . $visibility);
242 $this->visibility
= self
::$v_values[$visibility];
243 if ($this->mobile
&& !in_array($this->mobile_pub
, $this->visibility
)) {
244 unset($this->data
['mobile']);
248 /** Determine whether an item with visibility $visibility can be displayed
249 * with the current level of visibility of the profile
250 * @param $visibility The level of visibility to be checked
252 public function isVisible($visibility)
254 return in_array($visibility, $this->visibility
);
259 public function getPhoto($fallback = true
)
262 if ($this->visibility
) {
263 $cond = XDB
::format(' AND pub IN {?}', $this->visibility
);
265 $res = XDB
::query("SELECT *
267 WHERE attachmime IN ('jpeg', 'png')
268 " . $cond . ' AND pid = {?}',
270 if ($res->numRows() > 0) {
271 $photo = $res->fetchOneAssoc();
272 return PlImage
::fromData($photo['attach'], 'image/' . $photo['attachmime'],
273 $photo['x'], $photo['y']);
274 } else if ($fallback) {
275 return PlImage
::fromFile(dirname(__FILE__
).'/../htdocs/images/none.png',
283 public function getAddresses($flags, $limit = null
)
285 $where = XDB
::format('pa.pid = {?}', $this->id());
286 if ($flags & self
::ADDRESS_MAIN
) {
287 $where .= ' AND FIND_IN_SET(\'current\', pa.flags)';
289 if ($flags & self
::ADDRESS_POSTAL
) {
290 $where .= ' AND FIND_IN_SET(\'mail\', pa.flags)';
292 if ($this->visibility
) {
293 $where .= XDB
::format(' AND pa.pub IN {?}', $this->visibility
);
296 if ($flags & self
::ADDRESS_PRO
) {
299 if ($flags & self
::ADDRESS_PERSO
) {
302 if (count($type) > 0) {
303 $where .= XDB
::format(' AND pa.type IN {?}', $type);
305 $limit = is_null($limit) ?
'' : XDB
::format('LIMIT {?}', (int)$limit);
306 return XDB
::iterator('SELECT pa.text, pa.postalCode, pa.type, pa.latitude, pa.longitude,
307 gl.name AS locality, gas.name AS subAdministrativeArea,
308 ga.name AS administrativeArea, gc.countryFR AS country,
309 ppfix.display_tel AS fixed_tel, ppfax.display_tel AS fax_tel,
310 FIND_IN_SET(\'current\', pa.flags) AS current,
311 FIND_IN_SET(\'temporary\', pa.flags) AS temporary,
312 FIND_IN_SET(\'secondary\', pa.flags) AS secondary,
313 FIND_IN_SET(\'mail\', pa.flags) AS mail, pa.type
314 FROM profile_addresses AS pa
315 LEFT JOIN geoloc_localities AS gl ON (gl.id = pa.localityId)
316 LEFT JOIN geoloc_administrativeareas AS ga ON (ga.id = pa.administrativeAreaId)
317 LEFT JOIN geoloc_administrativeareas AS gas ON (gas.id = pa.subAdministrativeAreaId)
318 LEFT JOIN geoloc_countries AS gc ON (gc.iso_3166_1_a2 = pa.countryId)
319 LEFT JOIN profile_phones AS ppfix ON (ppfix.link_type = \'address\' AND ppfix.pid = pa.pid AND ppfix.link_id = pa.id AND ppfix.tel_type = \'fixed\')
320 LEFT JOIN profile_phones AS ppfax ON (ppfax.link_type = \'address\' AND ppfax.pid = pa.pid AND ppfax.link_id = pa.id AND ppfax.tel_type = \'fax\')
326 public function getMainAddress()
328 $it = $this->getAddresses(self
::ADDRESS_PERSO | self
::ADDRESS_MAIN
);
329 if ($it->total() == 0) {
339 public function getEducations($flags, $limit = null
)
341 $where = XDB
::format('pe.pid = {?}', $this->id());
342 if ($flags & self
::EDUCATION_MAIN
) {
343 $where .= ' AND FIND_IN_SET(\'primary\', pe.flags)';
344 } else if ($flags & self
::EDUCATION_EXTRA
) {
345 $where .= ' AND NOT FIND_IN_SET(\'primary\', pe.flags)';
346 } else if ($flags & self
::EDUCATION_FINISHED
) {
347 $where .= ' AND pe.grad_year <= YEAR(CURDATE())';
348 } else if ($flags & self
::EDUCATION_CURRENT
) {
349 $where .= ' AND pe.grad_year > YEAR(CURDATE())';
351 $limit = is_null($limit) ?
'' : XDB
::format('LIMIT {?}', (int)$limit);
352 return XDB
::iterator('SELECT pe.entry_year, pe.grad_year, pe.program,
353 pee.name AS school, pee.abbreviation AS school_short, pee.url AS school_url, gc.countryFR AS country,
354 pede.degree, pede.abbreviation AS degree_short, pede.level AS degree_level, pefe.field,
355 FIND_IN_SET(\'primary\', pe.flags) AS prim
356 FROM profile_education AS pe
357 INNER JOIN profile_education_enum AS pee ON (pe.eduid = pee.id)
358 LEFT JOIN geoloc_countries AS gc ON (gc.iso_3166_1_a2 = pee.country)
359 INNER JOIN profile_education_degree_enum AS pede ON (pe.degreeid = pede.id)
360 LEFT JOIN profile_education_field_enum AS pefe ON (pe.fieldid = pefe.id)
362 ORDER BY NOT FIND_IN_SET(\'primary\', pe.flags), pe.entry_year, pe.id
366 public function getExtraEducations($limit = null
)
368 return $this->getEducations(self
::EDUCATION_EXTRA
, $limit);
375 public function getNetworking($flags, $limit = null
)
377 $where = XDB
::format('pn.pid = {?}', $this->id());
378 if ($flags & self
::NETWORKING_WEB
) {
379 $where .= ' AND pn.network_type = 0'; // XXX hardcoded reference to web site index
381 if ($this->visibility
) {
382 $where .= XDB
::format(' AND pn.pub IN {?}', $this->visibility
);
384 $limit = is_null($limit) ?
'' : XDB
::format('LIMIT {?}', (int)$limit);
385 return XDB
::iterator('SELECT pne.name, pne.icon,
386 IF (LENGTH(pne.link) > 0, REPLACE(pne.link, \'%s\', pn.address),
387 pn.address) AS address
388 FROM profile_networking AS pn
389 INNER JOIN profile_networking_enum AS pne ON (pn.network_type = pne.network_type)
391 ORDER BY pn.network_type, pn.nwid
395 public function getWebSite()
397 $site = $this->getNetworking(self
::NETWORKING_WEB
, 1);
398 if ($site->total() != 1) {
401 $site = $site->next();
402 return $site['address'];
409 public function getJobs($flags, $limit = null
)
411 $where = XDB
::format('pj.pid = {?}', $this->id());
413 if ($this->visibility
) {
414 $where .= XDB
::format(' AND pj.pub IN {?}', $this->visibility
);
415 $cond = XDB
::format('pj.email_pub IN {?}', $this->visibility
);
417 $limit = is_null($limit) ?
'' : XDB
::format('LIMIT {?}', (int)$limit);
418 return XDB
::iterator('SELECT pje.name, pje.acronym, pje.url, pje.email, pje.NAF_code,
419 pj.description, pj.url AS user_site,
420 IF (' . $cond . ', pj.email, NULL) AS user_email,
421 pjse.name AS sector, pjsse.name AS subsector,
422 pjssse.name AS subsubsector
423 FROM profile_job AS pj
424 INNER JOIN profile_job_enum AS pje ON (pje.id = pj.jobid)
425 LEFT JOIN profile_job_sector_enum AS pjse ON (pjse.id = pj.sectorid)
426 LEFT JOIN profile_job_subsector_enum AS pjsse ON (pjsse.id = pj.subsectorid)
427 LEFT JOIN profile_job_subsubsector_enum AS pjssse ON (pjssse.id = pj.subsubsectorid)
433 public function getMailJob()
435 $job = $this->getJobs(self
::JOBS_MAIN
, 1);
436 if ($job->total() != 1) {
444 public function getBinets()
446 return XDB
::fetchColumn('SELECT binet_id
448 WHERE pid = {?}', $this->id());
452 public function owner()
454 return User
::getSilent($this);
457 public function compareNames($firstname, $lastname)
459 $_lastname = mb_strtoupper($this->lastName());
460 $_firstname = mb_strtoupper($this->firstName());
461 $lastname = mb_strtoupper($lastname);
462 $firstname = mb_strtoupper($firstname);
464 $isOk = (mb_strtoupper($_firstname) == mb_strtoupper($firstname));
465 $tokens = preg_split("/[ \-']/", $lastname, -1, PREG_SPLIT_NO_EMPTY
);
468 foreach ($tokens as $str) {
469 $isOk &= (strpos($_lastname, $str) !== false
);
470 $maxlen = max($maxlen, strlen($str));
473 return ($isOk && ($maxlen > 2 ||
$maxlen == strlen($_lastname)));
476 private static function fetchProfileData(array $pids, $respect_order = true
)
478 if (count($pids) == 0) {
482 if ($respect_order) {
483 $order = 'ORDER BY ' . XDB
::formatCustomOrder('p.pid', $pids);
488 return XDB
::Iterator('SELECT p.*, p.sex = \'female\' AS sex, pe.entry_year, pe.grad_year,
489 pn_f.name AS firstname, pn_l.name AS lastname, pn_n.name AS nickname,
490 IF(pn_uf.name IS NULL, pn_f.name, pn_uf.name) AS firstname_ordinary,
491 IF(pn_ul.name IS NULL, pn_l.name, pn_ul.name) AS lastname_ordinary,
492 pd.promo AS promo, pd.short_name, pd.directory_name AS full_name,
493 pd.directory_name, pp.display_tel AS mobile, pp.pub AS mobile_pub,
494 ph.attach IS NOT NULL AS has_photo, ph.pub AS photo_pub,
495 p.last_change < DATE_SUB(NOW(), INTERVAL 365 DAY) AS is_old,
498 INNER JOIN profile_display AS pd ON (pd.pid = p.pid)
499 INNER JOIN profile_education AS pe ON (pe.pid = p.pid AND FIND_IN_SET(\'primary\', pe.flags))
500 INNER JOIN profile_name AS pn_f ON (pn_f.pid = p.pid AND pn_f.typeid = {?})
501 INNER JOIN profile_name AS pn_l ON (pn_l.pid = p.pid AND pn_l.typeid = {?})
502 LEFT JOIN profile_name AS pn_uf ON (pn_uf.pid = p.pid AND pn_uf.typeid = {?})
503 LEFT JOIN profile_name AS pn_ul ON (pn_ul.pid = p.pid AND pn_ul.typeid = {?})
504 LEFT JOIN profile_name AS pn_n ON (pn_n.pid = p.pid AND pn_n.typeid = {?})
505 LEFT JOIN profile_phones AS pp ON (pp.pid = p.pid AND pp.link_type = \'user\' AND tel_type = \'mobile\')
506 LEFT JOIN profile_photos AS ph ON (ph.pid = p.pid)
507 LEFT JOIN account_profiles AS ap ON (ap.pid = p.pid AND FIND_IN_SET(\'owner\', ap.perms))
510 ' . $order, self
::getNameTypeId('firstname'),
511 self
::getNameTypeId('lastname'), self
::getNameTypeId('firstname_ordinary'),
512 self
::getNameTypeId('lastname_ordinary'), self
::getNameTypeId('nickname'), $pids);
515 public static function getPID($login)
517 if ($login instanceof PlUser
) {
518 return XDB
::fetchOneCell('SELECT pid
519 FROM account_profiles
520 WHERE uid = {?} AND FIND_IN_SET(\'owner\', perms)',
522 } else if (ctype_digit($login)) {
523 return XDB
::fetchOneCell('SELECT pid
525 WHERE pid = {?}', $login);
527 return XDB
::fetchOneCell('SELECT pid
529 WHERE hrpid = {?}', $login);
533 public static function getPIDsFromUIDs($uids, $respect_order = true
)
535 if ($respect_order) {
536 $order = 'ORDER BY ' . XDB
::formatCustomOrder('uid', $uids);
540 return XDB
::fetchAllAssoc('uid', 'SELECT ap.uid, ap.pid
541 FROM account_profiles AS ap
542 WHERE FIND_IN_SET(\'owner\', ap.perms)
547 /** Return the profile associated with the given login.
549 public static function get($login)
551 if (is_array($login)) {
552 return new Profile($login);
554 $pid = self
::getPID($login);
555 if (!is_null($pid)) {
556 $it = self
::iterOverPIDs(array($pid), false
);
559 /* Let say we can identify a profile using the identifiers of its owner.
561 if (!($login instanceof PlUser
)) {
562 $user = User
::getSilent($login);
563 if ($user && $user->hasProfile()) {
564 return $user->profile();
571 public static function iterOverUIDs($uids, $respect_order = true
)
573 return self
::iterOverPIDs(self
::getPIDsFromUIDs($uids), $respect_order);
576 public static function iterOverPIDs($pids, $respect_order = true
)
578 return new ProfileIterator(self
::fetchProfileData($pids, $respect_order));
581 /** Return profiles for the list of pids.
583 public static function getBulkProfilesWithPIDs(array $pids)
585 if (count($pids) == 0) {
588 $it = self
::iterOverPIDs($pids);
590 while ($p = $it->next()) {
591 $profiles[$p->id()] = $p;
596 /** Return profiles for uids.
598 public static function getBulkProfilesWithUIDS(array $uids)
600 if (count($uids) == 0) {
603 return self
::getBulkProfilesWithPIDs(self
::getPIDsFromUIDs($uids));
606 public static function isDisplayName($name)
608 return $name == self
::DN_FULL ||
$name == self
::DN_DISPLAY
609 ||
$name == self
::DN_YOURSELF ||
$name == self
::DN_DIRECTORY
610 ||
$name == self
::DN_PRIVATE ||
$name == self
::DN_PUBLIC
611 ||
$name == self
::DN_SHORT ||
$name == self
::DN_SORT
;
614 public static function getNameTypeId($type)
616 if (!S
::has('name_types')) {
617 $table = new PlDict(XDB
::fetchAllAssoc('type', 'SELECT id, type
618 FROM profile_name_enum'));
619 S
::set('name_types', $table);
621 $table = S
::v('name_types');
623 return $table->i($type);
626 public static function rebuildSearchTokens($pid)
628 XDB
::execute('DELETE FROM search_name
631 $keys = XDB
::iterator("SELECT CONCAT(n.particle, n.name) AS name, e.score,
632 FIND_IN_SET('public', e.flags) AS public
633 FROM profile_name AS n
634 INNER JOIN profile_name_enum AS e ON (n.typeid = e.id)
638 foreach ($keys as $i => $key) {
639 if ($key['name'] == '') {
642 $toks = preg_split('/[ \'\-]+/', $key['name']);
646 $token = strtolower(replace_accent(array_pop($toks) . $token));
647 $score = ($toks ?
0 : 10 +
$first) * ($key['score'] / 10);
648 XDB
::execute('REPLACE INTO search_name (token, pid, soundex, score, flags)
649 VALUES ({?}, {?}, {?}, {?}, {?})',
650 $token, $pid, soundex_fr($token), $score, $key['public']);
656 /** The school identifier consists of 6 digits. The first 3 represent the
657 * promotion entry year. The last 3 indicate the student's rank.
659 * Our identifier consists of 8 digits and both half have the same role.
660 * This enables us to deal with bigger promotions and with a wider range
663 * getSchoolId returns a school identifier given one of ours.
664 * getXorgId returns a X.org identifier given a school identifier.
666 public static function getSchoolId($xorgId)
668 if (!preg_match('/^[0-9]{8}$/', $xorgId)) {
672 $year = intval(substr($xorgId, 0, 4));
673 $rank = intval(substr($xorgId, 5, 3));
676 } elseif ($year < 2000) {
677 $year = intval(substr(1900 - $year, 1, 3));
678 return sprintf('%02u0%03u', $year, $rank);
680 $year = intval(substr(1900 - $year, 1, 3));
681 return sprintf('%03u%03u', $year, $rank);
685 public static function getXorgId($schoolId)
687 if (!preg_match('/^[0-9]{6}$/', $schoolId)) {
691 $year = intval(substr($schoolId, 0, 3));
692 $rank = intval(substr($schoolId, 3, 3));
700 return sprintf('%04u%04u', 1900 +
$year, $rank);
705 /** Iterator over a set of Profiles
706 * @param an XDB::Iterator obtained from a Profile::fetchProfileData
708 class ProfileIterator
implements PlIterator
712 public function __construct($dbiter)
714 $this->dbiter
= $dbiter;
717 public function next()
719 $data = $this->dbiter
->next();
723 return Profile
::get($data);
727 public function total()
729 return $this->dbiter
->total();
732 public function first()
734 return $this->dbiter
->first();
737 public function last()
739 return $this->dbiter
->last();
743 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8: