1853fa4eed6e04a42079907ddb5e7f3a8c100f3e
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->first_name
, $this->last_name
,
134 $this->full_name
, $this->short_name
,
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 __get($name)
200 if (property_exists($this, $name)) {
204 if (isset($this->data
[$name])) {
205 return $this->data
[$name];
211 public function __isset($name)
213 return property_exists($this, $name) ||
isset($this->data
[$name]);
216 public function setVisibilityLevel($visibility)
218 if ($visibility != self
::VISIBILITY_PRIVATE
219 && $visibility != self
::VISIBILITY_AX
220 && $visibility != self
::VISIBILITY_PUBLIC
) {
221 Platal
::page()->kill("Visibility invalide: " . $visibility);
223 $this->visibility
= self
::$v_values[$visibility];
224 if ($this->mobile
&& !in_array($this->mobile_pub
, $this->visibility
)) {
225 unset($this->data
['mobile']);
232 public function getPhoto($fallback = true
)
234 /* TODO: migrate photo table to profile_photo, change uid to pid
237 if ($this->visibility
) {
238 $cond = ' AND pub IN ' . XDB
::formatArray($this->visibility
);
240 $res = XDB
::query('SELECT *
242 WHERE attachmime IN (\'jpeg\', \'png\')
243 ' . $cond . ' AND pid = {?}',
245 if ($res->numRows() > 0) {
246 $photo = $res->fetchOneAssoc();
247 return PlImage
::fromData($photo['attach'], 'image/' . $photo['attachmime'],
248 $photo['x'], $photo['y']);
249 } else if ($fallback) {
250 return PlImage
::fromFile(dirname(__FILE__
).'/../htdocs/images/none.png',
258 public function getAddresses($flags, $limit = null
)
260 $where = XDB
::format('pa.pid = {?}', $this->id());
261 if ($flags & self
::ADDRESS_MAIN
) {
262 $where .= ' AND FIND_IN_SET(\'current\', pa.flags)';
264 if ($flags & self
::ADDRESS_POSTAL
) {
265 $where .= ' AND FIND_IN_SET(\'mail\', pa.flags)';
267 if ($this->visibility
) {
268 $where .= ' AND pa.pub IN ' . XDB
::formatArray($this->visibility
);
271 if ($flags & self
::ADDRESS_PRO
) {
274 if ($flags & self
::ADDRESS_PERSO
) {
277 if (count($type) > 0) {
278 $where .= ' AND pa.type IN ' . XDB
::formatArray($type);
280 $limit = is_null($limit) ?
'' : XDB
::format('LIMIT {?}', (int)$limit);
281 return XDB
::iterator('SELECT pa.text, pa.postalCode, pa.type, pa.latitude, pa.longitude,
282 gl.name AS locality, gas.name AS subAdministrativeArea,
283 ga.name AS administrativeArea, gc.countryFR AS country,
284 ppfix.display_tel AS fixed_tel, ppfax.display_tel AS fax_tel,
285 FIND_IN_SET(\'current\', pa.flags) AS current,
286 FIND_IN_SET(\'temporary\', pa.flags) AS temporary,
287 FIND_IN_SET(\'secondary\', pa.flags) AS secondary,
288 FIND_IN_SET(\'mail\', pa.flags) AS mail, pa.type
289 FROM profile_addresses AS pa
290 LEFT JOIN geoloc_localities AS gl ON (gl.id = pa.localityId)
291 LEFT JOIN geoloc_administrativeareas AS ga ON (ga.id = pa.administrativeAreaId)
292 LEFT JOIN geoloc_administrativeareas AS gas ON (gas.id = pa.subAdministrativeAreaId)
293 LEFT JOIN geoloc_countries AS gc ON (gc.iso_3166_1_a2 = pa.countryId)
294 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\')
295 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\')
301 public function getMainAddress()
303 $it = $this->getAddresses(self
::ADDRESS_PERSO | self
::ADDRESS_MAIN
);
304 if ($it->total() == 0) {
314 public function getEducations($flags, $limit = null
)
316 $where = XDB
::format('pe.pid = {?}', $this->id());
317 if ($flags & self
::EDUCATION_MAIN
) {
318 $where .= ' AND FIND_IN_SET(\'primary\', pe.flags)';
319 } else if ($flags & self
::EDUCATION_EXTRA
) {
320 $where .= ' AND NOT FIND_IN_SET(\'primary\', pe.flags)';
321 } else if ($flags & self
::EDUCATION_FINISHED
) {
322 $where .= ' AND pe.grad_year <= YEAR(CURDATE())';
323 } else if ($flags & self
::EDUCATION_CURRENT
) {
324 $where .= ' AND pe.grad_year > YEAR(CURDATE())';
326 $limit = is_null($limit) ?
'' : XDB
::format('LIMIT {?}', (int)$limit);
327 return XDB
::iterator('SELECT pe.entry_year, pe.grad_year, pe.program,
328 pee.name AS school, pee.abbreviation AS school_short, pee.url AS school_url, gc.countryFR AS country,
329 pede.degree, pede.abbreviation AS degree_short, pede.level AS degree_level, pefe.field,
330 FIND_IN_SET(\'primary\', pe.flags) AS prim
331 FROM profile_education AS pe
332 INNER JOIN profile_education_enum AS pee ON (pe.eduid = pee.id)
333 LEFT JOIN geoloc_countries AS gc ON (gc.iso_3166_1_a2 = pee.country)
334 INNER JOIN profile_education_degree_enum AS pede ON (pe.degreeid = pede.id)
335 LEFT JOIN profile_education_field_enum AS pefe ON (pe.fieldid = pefe.id)
337 ORDER BY NOT FIND_IN_SET(\'primary\', pe.flags), pe.entry_year, pe.id
341 public function getExtraEducations($limit = null
)
343 return $this->getEducations(self
::EDUCATION_EXTRA
, $limit);
350 public function getNetworking($flags, $limit = null
)
352 $where = XDB
::format('pn.pid = {?}', $this->id());
353 if ($flags & self
::NETWORKING_WEB
) {
354 $where .= ' AND pn.network_type = 0'; // XXX hardcoded reference to web site index
356 if ($this->visibility
) {
357 $where .= ' AND pn.pub IN ' . XDB
::formatArray($this->visibility
);
359 $limit = is_null($limit) ?
'' : XDB
::format('LIMIT {?}', (int)$limit);
360 return XDB
::iterator('SELECT pne.name, pne.icon,
361 IF (LENGTH(pne.link) > 0, REPLACE(pne.link, \'%s\', pn.address),
362 pn.address) AS address
363 FROM profile_networking AS pn
364 INNER JOIN profile_networking_enum AS pne ON (pn.network_type = pne.network_type)
366 ORDER BY pn.network_type, pn.nwid
370 public function getWebSite()
372 $site = $this->getNetworking(self
::NETWORKING_WEB
, 1);
373 if ($site->total() != 1) {
376 $site = $site->next();
377 return $site['address'];
384 public function getJobs($flags, $limit = null
)
386 $where = XDB
::format('pj.pid = {?}', $this->id());
388 if ($this->visibility
) {
389 $where .= ' AND pj.pub IN ' . XDB
::formatArray($this->visibility
);
390 $cond = 'pj.email_pub IN ' . XDB
::formatArray($this->visibility
);
392 $limit = is_null($limit) ?
'' : XDB
::format('LIMIT {?}', (int)$limit);
393 return XDB
::iterator('SELECT pje.name, pje.acronym, pje.url, pje.email, pje.NAF_code,
394 pj.description, pj.url AS user_site,
395 IF (' . $cond . ', pj.email, NULL) AS user_email,
396 pjse.name AS sector, pjsse.name AS subsector,
397 pjssse.name AS subsubsector
398 FROM profile_job AS pj
399 INNER JOIN profile_job_enum AS pje ON (pje.id = pj.jobid)
400 LEFT JOIN profile_job_sector_enum AS pjse ON (pjse.id = pj.sectorid)
401 LEFT JOIN profile_job_subsector_enum AS pjsse ON (pjsse.id = pj.subsectorid)
402 LEFT JOIN profile_job_subsubsector_enum AS pjssse ON (pjssse.id = pj.subsubsectorid)
408 public function getMailJob()
410 $job = $this->getJobs(self
::JOBS_MAIN
, 1);
411 if ($job->total() != 1) {
419 public function getBinets()
421 return XDB
::fetchColumn('SELECT binet_id
423 WHERE pid = {?}', $this->id());
427 public function owner()
429 return User
::getSilent($this);
432 private static function fetchProfileData(array $pids, $respect_order = true
)
434 if (count($pids) == 0) {
438 if ($respect_order) {
439 $order = 'ORDER BY ' . XDB
::formatCustomOrder('p.pid', $pids);
444 return XDB
::Iterator('SELECT p.*, p.sex = \'female\' AS sex, pe.entry_year, pe.grad_year,
445 pn_f.name AS firstname, pn_l.name AS lastname, pn_n.name AS nickname,
446 IF(pn_uf.name IS NULL, pn_f.name, pn_uf.name) AS firstname_ordinary,
447 IF(pn_ul.name IS NULL, pn_l.name, pn_ul.name) AS lastname_ordinary,
448 pd.promo AS promo, pd.short_name, pd.directory_name AS full_name,
449 pd.directory_name, pp.display_tel AS mobile, pp.pub AS mobile_pub,
450 ph.attach IS NOT NULL AS has_photo, ph.pub AS photo_pub,
451 p.last_change < DATE_SUB(NOW(), INTERVAL 365 DAY) AS is_old,
454 INNER JOIN profile_display AS pd ON (pd.pid = p.pid)
455 INNER JOIN profile_education AS pe ON (pe.pid = p.pid AND FIND_IN_SET(\'primary\', pe.flags))
456 INNER JOIN profile_name AS pn_f ON (pn_f.pid = p.pid
457 AND pn_f.typeid = ' . self
::getNameTypeId('firstname', true
) . ')
458 INNER JOIN profile_name AS pn_l ON (pn_l.pid = p.pid
459 AND pn_l.typeid = ' . self
::getNameTypeId('lastname', true
) . ')
460 LEFT JOIN profile_name AS pn_uf ON (pn_uf.pid = p.pid
461 AND pn_uf.typeid = ' . self
::getNameTypeId('firstname_ordinary', true
) . ')
462 LEFT JOIN profile_name AS pn_ul ON (pn_ul.pid = p.pid
463 AND pn_ul.typeid = ' . self
::getNameTypeId('lastname_ordinary', true
) . ')
464 LEFT JOIN profile_name AS pn_n ON (pn_n.pid = p.pid
465 AND pn_n.typeid = ' . self
::getNameTypeId('nickname', true
) . ')
466 LEFT JOIN profile_phones AS pp ON (pp.pid = p.pid AND pp.link_type = \'user\' AND tel_type = \'mobile\')
467 LEFT JOIN profile_photos AS ph ON (ph.pid = p.pid)
468 LEFT JOIN account_profiles AS ap ON (ap.pid = p.pid AND FIND_IN_SET(\'owner\', ap.perms))
469 WHERE p.pid IN ' . XDB
::formatArray($pids) . '
474 public static function getPID($login)
476 if ($login instanceof PlUser
) {
477 return XDB
::fetchOneCell('SELECT pid
478 FROM account_profiles
479 WHERE uid = {?} AND FIND_IN_SET(\'owner\', perms)',
481 } else if (ctype_digit($login)) {
482 return XDB
::fetchOneCell('SELECT pid
484 WHERE pid = {?}', $login);
486 return XDB
::fetchOneCell('SELECT pid
488 WHERE hrpid = {?}', $login);
492 public static function getPIDsFromUIDs($uids, $respect_order = true
)
494 if ($respect_order) {
495 $order = 'ORDER BY ' . XDB
::formatCustomOrder('uid', $uids);
499 return XDB
::fetchAllAssoc('uid', 'SELECT ap.uid, ap.pid
500 FROM account_profiles AS ap
501 WHERE FIND_IN_SET(\'owner\', ap.perms)
502 AND ap.uid IN ' . XDB
::formatArray($uids) .'
506 /** Return the profile associated with the given login.
508 public static function get($login)
510 if (is_array($login)) {
511 return new Profile($login);
513 $pid = self
::getPID($login);
514 if (!is_null($pid)) {
515 $it = self
::iterOverPIDs(array($pid), false
);
518 /* Let say we can identify a profile using the identifiers of its owner.
520 if (!($login instanceof PlUser
)) {
521 $user = User
::getSilent($login);
522 if ($user && $user->hasProfile()) {
523 return $user->profile();
530 public static function iterOverUIDs($uids, $respect_order = true
)
532 return self
::iterOverPIDs(self
::getPIDsFromUIDs($uids), $respect_order);
535 public static function iterOverPIDs($pids, $respect_order = true
)
537 return new ProfileIterator(self
::fetchProfileData($pids, $respect_order));
540 /** Return profiles for the list of pids.
542 public static function getBulkProfilesWithPIDs(array $pids)
544 if (count($pids) == 0) {
547 $it = self
::iterOverPIDs($pids);
549 while ($p = $it->next()) {
550 $profiles[$p->id()] = $p;
555 /** Return profiles for uids.
557 public static function getBulkProfilesWithUIDS(array $uids)
559 if (count($uids) == 0) {
562 return self
::getBulkProfilesWithPIDs(self
::getPIDsFromUIDs($uids));
565 public static function isDisplayName($name)
567 return $name == self
::DN_FULL ||
$name == self
::DN_DISPLAY
568 ||
$name == self
::DN_YOURSELF ||
$name == self
::DN_DIRECTORY
569 ||
$name == self
::DN_PRIVATE ||
$name == self
::DN_PUBLIC
570 ||
$name == self
::DN_SHORT ||
$name == self
::DN_SORT
;
573 public static function getNameTypeId($type, $for_sql = false
)
575 if (!S
::has('name_types')) {
576 $table = XDB
::fetchAllAssoc('type', 'SELECT id, type
577 FROM profile_name_enum');
578 S
::set('name_types', $table);
580 $table = S
::v('name_types');
583 return XDB
::escape($table[$type]);
585 return $table[$type];
589 public static function rebuildSearchTokens($pid)
591 XDB
::execute('DELETE FROM search_name
594 $keys = XDB
::iterator("SELECT CONCAT(n.particle, n.name) AS name, e.score,
595 FIND_IN_SET('public', e.flags) AS public
596 FROM profile_name AS n
597 INNER JOIN profile_name_enum AS e ON (n.typeid = e.id)
601 foreach ($keys as $i => $key) {
602 if ($key['name'] == '') {
605 $toks = preg_split('/[ \'\-]+/', $key['name']);
609 $token = strtolower(replace_accent(array_pop($toks) . $token));
610 $score = ($toks ?
0 : 10 +
$first) * ($key['score'] / 10);
611 XDB
::execute('REPLACE INTO search_name (token, uid, soundex, score, flags)
612 VALUES ({?}, {?}, {?}, {?}, {?})',
613 $token, $uid, soundex_fr($token), $score, $key['public']);
619 /** The school identifier consists of 6 digits. The first 3 represent the
620 * promotion entry year. The last 3 indicate the student's rank.
622 * Our identifier consists of 8 digits and both half have the same role.
623 * This enables us to deal with bigger promotions and with a wider range
626 * getSchoolId returns a school identifier given one of ours.
627 * getXorgId returns a X.org identifier given a school identifier.
629 public static function getSchoolId($xorgId)
631 if (!preg_match('/^[0-9]{8}$/', $xorgId)) {
635 $year = intval(substr($xorgId, 0, 4));
636 $rank = intval(substr($xorgId, 5, 3));
639 } elseif ($year < 2000) {
640 $year = intval(substr(1900 - $year, 1, 3));
641 return sprintf('%02u0%03u', $year, $rank);
643 $year = intval(substr(1900 - $year, 1, 3));
644 return sprintf('%03u%03u', $year, $rank);
648 public static function getXorgId($schoolId)
650 if (!preg_match('/^[0-9]{6}$/', $xorgId)) {
654 $year = intval(substr($schoolId, 0, 3));
655 $rank = intval(substr($schoolId, 3, 3));
663 return sprintf('%04u%04u', 1900 +
$year, $rank);
668 /** Iterator over a set of Profiles
669 * @param an XDB::Iterator obtained from a Profile::fetchProfileData
671 class ProfileIterator
implements PlIterator
675 public function __construct($dbiter)
677 $this->dbiter
= $dbiter;
680 public function next()
682 $data = $this->dbiter
->next();
686 return Profile
::get($data);
690 public function total()
692 return $this->dbiter
->total();
695 public function first()
697 return $this->dbiter
->first();
700 public function last()
702 return $this->dbiter
->last();
706 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8: