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;
85 const FETCH_ADDRESSES
= 0x00001;
86 const FETCH_CORPS
= 0x00002;
87 const FETCH_EDU
= 0x00004;
88 const FETCH_JOBS
= 0x00008;
89 const FETCH_MEDALS
= 0x00010;
90 const FETCH_NETWORKING
= 0x00020;
91 const FETCH_PHONES
= 0x00040;
92 const FETCH_PHOTO
= 0x00080;
94 const FETCH_ALL
= 0x000FF;
98 private $data = array();
100 private $visibility = null
;
102 private function __construct(array $data)
105 $this->pid
= $this->data
['pid'];
106 $this->hrpid
= $this->data
['hrpid'];
108 $this->setVisibilityLevel(self
::VISIBILITY_PUBLIC
);
112 static private $contexts = array();
114 /** Returns the best visibility context toward $visibility
115 * @param $visibility A wished visibility level
116 * @return An array of compatible visibilities
118 * if $visibility is null, the best visibility is returned
120 static public function getVisibilityContext($visibility = null
)
122 if (array_key_exists($visibility, self
::$contexts)) {
123 return self
::$contexts[$visibility];
126 $asked_vis = $visibility;
129 $minvis = self
::VISIBILITY_PRIVATE
;
131 $minvis = self
::VISIBILITY_PUBLIC
;
133 if ($visibility == null
) {
134 $visibility = $minvis;
137 if ($minvis == self
::VISIBILITY_PUBLIC
) {
138 $visibility = self
::VISIBILITY_PUBLIC
;
141 $visibility = self
::$v_values[$visibility];
142 self
::$contexts[$asked_vis] = $visibility;
152 public function hrid()
157 public function promo()
162 public function yearpromo()
164 return intval(substr($this->promo
, 1, 4));
167 /** Print a name with the given formatting:
175 public function name($format)
177 return str_replace(array('%s', '%f', '%l', '%F', '%S', '%p'),
178 array($this->isFemale() ?
'•' : '',
179 $this->firstName(), $this->lastName(),
180 $this->fullName(), $this->shortName(),
181 $this->promo()), $format);
184 public function fullName($with_promo = false
)
187 return $this->full_name
. ' (' . $this->promo
. ')';
189 return $this->full_name
;
192 public function shortName($with_promo = false
)
195 return $this->short_name
. ' (' . $this->promo
. ')';
197 return $this->short_name
;
200 public function firstName()
202 return $this->firstname
;
205 public function firstNames()
207 return $this->nameVariants(self
::FIRSTNAME
);
210 public function lastName()
212 return $this->lastname
;
215 public function lastNames()
217 return $this->nameVariants(self
::LASTNAME
);
220 public function isFemale()
222 return $this->sex
== PlUser
::GENDER_FEMALE
;
225 public function data()
231 private function nameVariants($type)
233 $vals = array($this->$type);
234 foreach (self
::$name_variants[$type] as $var) {
235 $vartype = $type . '_' . $var;
236 $varname = $this->$vartype;
237 if ($varname != null
&& $varname != "") {
241 return array_unique($vals);
244 public function nationalities()
247 if ($this->nationality1
) {
248 $nats[] = $this->nationality1
;
250 if ($this->nationality2
) {
251 $nats[] = $this->nationality2
;
253 if ($this->nationality3
) {
254 $nats[] = $this->nationality3
;
259 public function __get($name)
261 if (property_exists($this, $name)) {
265 if (isset($this->data
[$name])) {
266 return $this->data
[$name];
272 public function __isset($name)
274 return property_exists($this, $name) ||
isset($this->data
[$name]);
277 /** Sets the level of visibility of the profile
278 * Sets $this->visibility to a list of valid visibilities.
279 * @param one of the self::VISIBILITY_* values
281 public function setVisibilityLevel($visibility)
283 if ($visibility != self
::VISIBILITY_PRIVATE
284 && $visibility != self
::VISIBILITY_AX
285 && $visibility != self
::VISIBILITY_PUBLIC
) {
286 Platal
::page()->kill("Visibility invalide: " . $visibility);
288 $this->visibility
= self
::$v_values[$visibility];
289 if ($this->mobile
&& !in_array($this->mobile_pub
, $this->visibility
)) {
290 unset($this->data
['mobile']);
294 /** Determine whether an item with visibility $visibility can be displayed
295 * with the current level of visibility of the profile
296 * @param $visibility The level of visibility to be checked
298 public function isVisible($visibility)
300 return in_array($visibility, $this->visibility
);
303 public static function getCompatibleVisibilities($visibility)
305 return self
::$v_values[$visibility];
308 private function getProfileField($cls)
310 return ProfileField
::getForPID($cls, $this->id(), $this->visibility
);
313 /** Consolidates internal data (addresses, phones, jobs)
315 private function consolidateFields()
317 if ($this->phones
!= null
) {
318 if ($this->addresses
!= null
) {
319 $this->addresses
->addPhones($this->phones
);
322 if ($this->jobs
!= null
) {
323 $this->jobs
->addPhones($this->phones
);
327 if ($this->addresses
!= null
&& $this->jobs
!= null
) {
328 $this->jobs
->addAddresses($this->addresses
);
334 private $photo = null
;
335 public function setPhoto(ProfilePhoto
$photo)
337 $this->photo
= $photo;
340 public function getPhoto($fallback = true
)
342 if ($this->photo
== null
) {
343 $this->setPhoto($this->getProfileField('ProfilePhoto'));
346 if ($this->photo
!= null
) {
347 return $this->photo
->pic
;
348 } else if ($fallback) {
349 return PlImage
::fromFile(dirname(__FILE__
).'/../htdocs/images/none.png',
357 private $addresses = null
;
358 public function setAddresses(ProfileAddresses
$addr)
360 $this->addresses
= $addr;
361 $this->consolidateFields();
364 public function getAddresses($flags, $limit = null
)
366 if ($this->addresses
== null
) {
367 $this->setAddresses($this->getProfileField('ProfileAddresses'));
369 return $this->addresses
->get($flags, $limit);
372 public function getMainAddress()
374 $it = $this->getAddresses(self
::ADDRESS_PERSO | self
::ADDRESS_MAIN
);
375 if ($it->total() == 0) {
385 private $educations = null
;
386 public function setEducations(ProfileEducation
$edu)
388 $this->educations
= $edu;
391 public function getEducations($flags, $limit = null
)
393 if ($this->educations
== null
) {
394 $this->setEducations($this->getProfileField('ProfileEducation'));
396 return $this->educations
->get($flags, $limit);
399 public function getExtraEducations($limit = null
)
401 return $this->getEducations(self
::EDUCATION_EXTRA
, $limit);
407 private $networks = null
;
408 public function setNetworking(ProfileNetworking
$nw)
410 $this->networks
= $nw;
413 public function getNetworking($flags, $limit = null
)
415 if ($this->networks
== null
) {
416 $this->setNetworking($this->getProfileField('ProfileNetworking'));
418 return $this->networks
->get($flags, $limit);
421 public function getWebSite()
423 $site = $this->getNetworking(self
::NETWORKING_WEB
, 1);
424 if ($site->total() != 1) {
427 $site = $site->next();
428 return $site['address'];
434 private $jobs = null
;
435 public function setJobs(ProfileJobs
$jobs)
438 $this->consolidateFields();
441 public function getJobs($flags, $limit = null
)
443 if ($this->jobs
== null
) {
444 $this->setJobs($this->getProfileField('ProfileJobs'));
447 return $this->jobs
->get($flags, $limit);
450 public function getMailJob()
452 $job = $this->getJobs(self
::JOBS_MAIN
, 1);
453 if ($job->total() != 1) {
461 public function getBinets()
463 return XDB
::fetchColumn('SELECT binet_id
465 WHERE pid = {?}', $this->id());
469 public function owner()
471 return User
::getSilent($this);
474 public function compareNames($firstname, $lastname)
476 $_lastname = mb_strtoupper($this->lastName());
477 $_firstname = mb_strtoupper($this->firstName());
478 $lastname = mb_strtoupper($lastname);
479 $firstname = mb_strtoupper($firstname);
481 $isOk = (mb_strtoupper($_firstname) == mb_strtoupper($firstname));
482 $tokens = preg_split("/[ \-']/", $lastname, -1, PREG_SPLIT_NO_EMPTY
);
485 foreach ($tokens as $str) {
486 $isOk &= (strpos($_lastname, $str) !== false
);
487 $maxlen = max($maxlen, strlen($str));
490 return ($isOk && ($maxlen > 2 ||
$maxlen == strlen($_lastname)));
493 private static function fetchProfileData(array $pids, $respect_order = true
, $fields = 0x0000, $visibility = null
)
495 if (count($pids) == 0) {
499 if ($respect_order) {
500 $order = 'ORDER BY ' . XDB
::formatCustomOrder('p.pid', $pids);
506 $it = XDB
::Iterator('SELECT p.*, p.sex = \'female\' AS sex, pe.entry_year, pe.grad_year,
507 pn_f.name AS firstname, pn_l.name AS lastname, pn_n.name AS nickname,
508 IF(pn_uf.name IS NULL, pn_f.name, pn_uf.name) AS firstname_ordinary,
509 IF(pn_ul.name IS NULL, pn_l.name, pn_ul.name) AS lastname_ordinary,
510 pd.promo AS promo, pd.short_name, pd.directory_name AS full_name,
511 pd.directory_name, pp.display_tel AS mobile, pp.pub AS mobile_pub,
512 ph.attach IS NOT NULL AS has_photo, ph.pub AS photo_pub,
513 p.last_change < DATE_SUB(NOW(), INTERVAL 365 DAY) AS is_old,
516 INNER JOIN profile_display AS pd ON (pd.pid = p.pid)
517 INNER JOIN profile_education AS pe ON (pe.pid = p.pid AND FIND_IN_SET(\'primary\', pe.flags))
518 INNER JOIN profile_name AS pn_f ON (pn_f.pid = p.pid
519 AND pn_f.typeid = ' . self
::getNameTypeId('firstname', true
) . ')
520 INNER JOIN profile_name AS pn_l ON (pn_l.pid = p.pid
521 AND pn_l.typeid = ' . self
::getNameTypeId('lastname', true
) . ')
522 LEFT JOIN profile_name AS pn_uf ON (pn_uf.pid = p.pid
523 AND pn_uf.typeid = ' . self
::getNameTypeId('firstname_ordinary', true
) . ')
524 LEFT JOIN profile_name AS pn_ul ON (pn_ul.pid = p.pid
525 AND pn_ul.typeid = ' . self
::getNameTypeId('lastname_ordinary', true
) . ')
526 LEFT JOIN profile_name AS pn_n ON (pn_n.pid = p.pid
527 AND pn_n.typeid = ' . self
::getNameTypeId('nickname', true
) . ')
528 LEFT JOIN profile_phones AS pp ON (pp.pid = p.pid AND pp.link_type = \'user\' AND tel_type = \'mobile\')
529 LEFT JOIN profile_photos AS ph ON (ph.pid = p.pid)
530 LEFT JOIN account_profiles AS ap ON (ap.pid = p.pid AND FIND_IN_SET(\'owner\', ap.perms))
531 WHERE p.pid IN ' . XDB
::formatArray($pids) . '
534 return new ProfileIterator($it, $pids, $fields, $visibility);
537 public static function getPID($login)
539 if ($login instanceof PlUser
) {
540 return XDB
::fetchOneCell('SELECT pid
541 FROM account_profiles
542 WHERE uid = {?} AND FIND_IN_SET(\'owner\', perms)',
544 } else if (ctype_digit($login)) {
545 return XDB
::fetchOneCell('SELECT pid
547 WHERE pid = {?}', $login);
549 return XDB
::fetchOneCell('SELECT pid
551 WHERE hrpid = {?}', $login);
555 public static function getPIDsFromUIDs($uids, $respect_order = true
)
557 if ($respect_order) {
558 $order = 'ORDER BY ' . XDB
::formatCustomOrder('uid', $uids);
562 return XDB
::fetchAllAssoc('uid', 'SELECT ap.uid, ap.pid
563 FROM account_profiles AS ap
564 WHERE FIND_IN_SET(\'owner\', ap.perms)
565 AND ap.uid IN ' . XDB
::formatArray($uids) .'
569 /** Return the profile associated with the given login.
571 public static function get($login, $fields = 0x0000, $visibility = null
)
573 if (is_array($login)) {
574 return new Profile($login);
576 $pid = self
::getPID($login);
577 if (!is_null($pid)) {
578 $it = self
::iterOverPIDs(array($pid), false
, $fields, $visibility);
581 /* Let say we can identify a profile using the identifiers of its owner.
583 if (!($login instanceof PlUser
)) {
584 $user = User
::getSilent($login);
585 if ($user && $user->hasProfile()) {
586 return $user->profile();
593 public static function iterOverUIDs($uids, $respect_order = true
, $fields = 0x0000, $visibility = null
)
595 return self
::iterOverPIDs(self
::getPIDsFromUIDs($uids), $respect_order, $fields, $visibility);
598 public static function iterOverPIDs($pids, $respect_order = true
, $fields = 0x0000, $visibility = null
)
600 return self
::fetchProfileData($pids, $respect_order, $fields, $visibility);
603 /** Return profiles for the list of pids.
605 public static function getBulkProfilesWithPIDs(array $pids, $fields = self
::FETCH_ADDRESSES
, $visibility = null
)
607 if (count($pids) == 0) {
610 $it = self
::iterOverPIDs($pids, true
, $fields, $visibility);
612 while ($p = $it->next()) {
613 $profiles[$p->id()] = $p;
618 /** Return profiles for uids.
620 public static function getBulkProfilesWithUIDS(array $uids, $fields = 0x000, $visibility = null
)
622 if (count($uids) == 0) {
625 return self
::getBulkProfilesWithPIDs(self
::getPIDsFromUIDs($uids), $fields, $visibility);
628 public static function isDisplayName($name)
630 return $name == self
::DN_FULL ||
$name == self
::DN_DISPLAY
631 ||
$name == self
::DN_YOURSELF ||
$name == self
::DN_DIRECTORY
632 ||
$name == self
::DN_PRIVATE ||
$name == self
::DN_PUBLIC
633 ||
$name == self
::DN_SHORT ||
$name == self
::DN_SORT
;
636 public static function getNameTypeId($type, $for_sql = false
)
638 if (!S
::has('name_types')) {
639 $table = XDB
::fetchAllAssoc('type', 'SELECT id, type
640 FROM profile_name_enum');
641 S
::set('name_types', $table);
643 $table = S
::v('name_types');
646 return XDB
::escape($table[$type]);
648 return $table[$type];
652 public static function rebuildSearchTokens($pid)
654 XDB
::execute('DELETE FROM search_name
657 $keys = XDB
::iterator("SELECT CONCAT(n.particle, n.name) AS name, e.score,
658 FIND_IN_SET('public', e.flags) AS public
659 FROM profile_name AS n
660 INNER JOIN profile_name_enum AS e ON (n.typeid = e.id)
664 foreach ($keys as $i => $key) {
665 if ($key['name'] == '') {
668 $toks = preg_split('/[ \'\-]+/', $key['name']);
672 $token = strtolower(replace_accent(array_pop($toks) . $token));
673 $score = ($toks ?
0 : 10 +
$first) * ($key['score'] / 10);
674 XDB
::execute('REPLACE INTO search_name (token, pid, soundex, score, flags)
675 VALUES ({?}, {?}, {?}, {?}, {?})',
676 $token, $pid, soundex_fr($token), $score, $key['public']);
682 /** The school identifier consists of 6 digits. The first 3 represent the
683 * promotion entry year. The last 3 indicate the student's rank.
685 * Our identifier consists of 8 digits and both half have the same role.
686 * This enables us to deal with bigger promotions and with a wider range
689 * getSchoolId returns a school identifier given one of ours.
690 * getXorgId returns a X.org identifier given a school identifier.
692 public static function getSchoolId($xorgId)
694 if (!preg_match('/^[0-9]{8}$/', $xorgId)) {
698 $year = intval(substr($xorgId, 0, 4));
699 $rank = intval(substr($xorgId, 5, 3));
702 } elseif ($year < 2000) {
703 $year = intval(substr(1900 - $year, 1, 3));
704 return sprintf('%02u0%03u', $year, $rank);
706 $year = intval(substr(1900 - $year, 1, 3));
707 return sprintf('%03u%03u', $year, $rank);
711 public static function getXorgId($schoolId)
713 if (!preg_match('/^[0-9]{6}$/', $schoolId)) {
717 $year = intval(substr($schoolId, 0, 3));
718 $rank = intval(substr($schoolId, 3, 3));
726 return sprintf('%04u%04u', 1900 +
$year, $rank);
732 /** Iterator over a set of Profiles
734 class ProfileIterator
implements PlIterator
736 private $iterator = null
;
739 public function __construct(PlIterator
$it, array $pids, $fields = 0x0000, $visibility = null
)
741 require_once 'profilefields.inc.php';
742 $visibility = Profile
::getVisibilityContext($visibility);
743 $this->fields
= $fields;
746 $callbacks = array();
749 $callbacks[0] = PlIteratorUtils
::arrayValueCallback('pid');
750 $cb = PlIteratorUtils
::objectPropertyCallback('pid');
752 if ($fields & Profile
::FETCH_ADDRESSES
) {
753 $callbacks[Profile
::FETCH_ADDRESSES
] = $cb;
754 $subits[Profile
::FETCH_ADDRESSES
] = new ProfileFieldIterator('ProfileAddresses', $pids, $visibility);
757 if ($fields & Profile
::FETCH_CORPS
) {
758 $callbacks[Profile
::FETCH_CORPS
] = $cb;
759 $subits[Profile
::FETCH_CORPS
] = new ProfileFieldIterator('ProfileCorps', $pids, $visibility);
762 if ($fields & Profile
::FETCH_EDU
) {
763 $callbacks[Profile
::FETCH_EDU
] = $cb;
764 $subits[Profile
::FETCH_EDU
] = new ProfileFieldIterator('ProfileEducation', $pids, $visibility);
767 if ($fields & Profile
::FETCH_JOBS
) {
768 $callbacks[Profile
::FETCH_JOBS
] = $cb;
769 $subits[Profile
::FETCH_JOBS
] = new ProfileFieldIterator('ProfileJobs', $pids, $visibility);
772 if ($fields & Profile
::FETCH_MEDALS
) {
773 $callbacks[Profile
::FETCH_MEDALS
] = $cb;
774 $subits[Profile
::FETCH_MEDALS
] = new ProfileFieldIterator('ProfileMedals', $pids, $visibility);
777 if ($fields & Profile
::FETCH_NETWORKING
) {
778 $callbacks[Profile
::FETCH_NETWORKING
] = $cb;
779 $subits[Profile
::FETCH_NETWORKING
] = new ProfileFieldIterator('ProfileNetworking', $pids, $visibility);
782 if ($fields & Profile
::FETCH_PHONES
) {
783 $callbacks[Profile
::FETCH_PHONES
] = $cb;
784 $subits[Profile
::FETCH_PHONES
] = new ProfileFieldIterator('ProfilePhones', $pids, $visibility);
787 if ($fields & Profile
::FETCH_PHOTO
) {
788 $callbacks[Profile
::FETCH_PHOTO
] = $cb;
789 $subits[Profile
::FETCH_PHOTO
] = new ProfileFieldIterator('ProfilePhoto', $pids, $visibility);
792 $this->iterator
= PlIteratorUtils
::parallelIterator($subits, $callbacks, 0);
795 private function hasData($flag, $vals)
797 return ($this->fields
& $flag) && ($vals[$flag] != null
);
800 private function fillProfile(array $vals)
802 $pf = Profile
::get($vals[0]);
803 if ($this->hasData(Profile
::FETCH_PHONES
, $vals)) {
804 $pf->setPhones($vals[Profile
::FETCH_PHONES
]);
806 if ($this->hasData(Profile
::FETCH_ADDRESSES
, $vals)) {
807 $pf->setAddresses($vals[Profile
::FETCH_ADDRESSES
]);
809 if ($this->hasData(Profile
::FETCH_JOBS
, $vals)) {
810 $pf->setJobs($vals[Profile
::FETCH_JOBS
]);
813 if ($this->hasData(Profile
::FETCH_CORPS
, $vals)) {
814 $pf->setCorps($vals[Profile
::FETCH_CORPS
]);
816 if ($this->hasData(Profile
::FETCH_EDU
, $vals)) {
817 $pf->setEdu($vals[Profile
::FETCH_EDU
]);
819 if ($this->hasData(Profile
::FETCH_MEDALS
, $vals)) {
820 $pf->setMedals($vals[Profile
::FETCH_MEDALS
]);
822 if ($this->hasData(Profile
::FETCH_NETWORKING
, $vals)) {
823 $pf->setNetworking($vals[Profile
::FETCH_NETWORKING
]);
825 if ($this->hasData(Profile
::FETCH_PHOTO
, $vals)) {
826 $pf->setPhoto($vals[Profile
::FETCH_PHOTO
]);
832 public function next()
834 $vals = $this->iterator
->next();
838 return $this->fillProfile($vals);
841 public function first()
843 return $this->iterator
->first();
846 public function last()
848 return $this->iterator
->last();
851 public function total()
853 return $this->iterator
->total();
857 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8: