Switch last uses of VCard to Profile system
[platal.git] / classes / profile.php
CommitLineData
e7b93962
FB
1<?php
2/***************************************************************************
d4c08d89 3 * Copyright (C) 2003-2010 Polytechnique.org *
e7b93962
FB
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
22class Profile
23{
f5642983
FB
24 static private $v_values = array('public' => array('public'),
25 'ax' => array('ax', 'public'),
26 'private' => array('private', 'ax', 'public'));
913a4e90 27
f5642983
FB
28 const VISIBILITY_PUBLIC = 'public';
29 const VISIBILITY_AX = 'ax';
30 const VISIBILITY_PRIVATE = 'private';
31
913a4e90
RB
32 /* name tokens */
33 const LASTNAME = 'lastname';
34 const FIRSTNAME = 'firstname';
35 const NICKNAME = 'nickname';
36 const PSEUDONYM = 'pseudonym';
37 const NAME = 'name';
38 /* name variants */
39 const VN_MARITAL = 'marital';
40 const VN_ORDINARY = 'ordinary';
41 const VN_OTHER = 'other';
42 const VN_INI = 'ini';
43 /* display names */
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
53 static public $name_variants = array(
54 self::LASTNAME => array(self::VN_MARITAL, self::VN_ORDINARY),
55 self::FIRSTNAME => array(self::VN_ORDINARY, self::VN_INI, self::VN_OTHER)
56 );
57
f5642983
FB
58 const ADDRESS_MAIN = 0x000001;
59 const ADDRESS_PERSO = 0x000002;
60 const ADDRESS_PRO = 0x000004;
61 const ADDRESS_ALL = 0x000006;
62 const ADDRESS_POSTAL = 0x000008;
63
64 const EDUCATION_MAIN = 0x000010;
4bc5b8f0
FB
65 const EDUCATION_EXTRA = 0x000020;
66 const EDUCATION_ALL = 0x000040;
67 const EDUCATION_FINISHED = 0x000080;
68 const EDUCATION_CURRENT = 0x000100;
f5642983 69
4bc5b8f0
FB
70 const JOBS_MAIN = 0x001000;
71 const JOBS_ALL = 0x002000;
72 const JOBS_FINISHED = 0x004000;
73 const JOBS_CURRENT = 0x008000;
f5642983 74
04a94b1d
FB
75 const NETWORKING_ALL = 0x000000;
76 const NETWORKING_WEB = 0x010000;
77 const NETWORKING_IM = 0x020000;
78 const NETWORKING_SOCIAL = 0x040000;
79
e7b93962
FB
80 private $pid;
81 private $hrpid;
3e53a496
FB
82 private $data = array();
83
f5642983
FB
84 private $visibility = null;
85
b774ddab 86 private function __construct(array $data)
e7b93962 87 {
b774ddab 88 $this->data = $data;
832e6fcb
FB
89 $this->pid = $this->data['pid'];
90 $this->hrpid = $this->data['hrpid'];
f74fb084
FB
91 if (!S::logged()) {
92 $this->setVisibilityLevel(self::VISIBILITY_PUBLIC);
93 }
e7b93962
FB
94 }
95
96 public function id()
97 {
98 return $this->pid;
99 }
100
101 public function hrid()
102 {
103 return $this->hrpid;
104 }
105
d5e60905
FB
106 public function promo()
107 {
108 return $this->promo;
109 }
110
94b72319
FB
111 /** Print a name with the given formatting:
112 * %s = • for women
113 * %f = firstname
114 * %l = lastname
115 * %F = fullname
116 * %S = shortname
117 * %p = promo
118 */
119 public function name($format)
120 {
121 return str_replace(array('%s', '%f', '%l', '%F', '%S', '%p'),
122 array($this->isFemale() ? '•' : '',
123 $this->first_name, $this->last_name,
124 $this->full_name, $this->short_name,
125 $this->promo), $format);
126 }
127
128 public function fullName($with_promo = false)
129 {
130 if ($with_promo) {
131 return $this->full_name . ' (' . $this->promo . ')';
132 }
133 return $this->full_name;
134 }
135
136 public function shortName($with_promo = false)
137 {
138 if ($with_promo) {
139 return $this->short_name . ' (' . $this->promo . ')';
140 }
141 return $this->short_name;
142 }
143
144 public function firstName()
145 {
08c91036 146 return $this->firstname;
94b72319
FB
147 }
148
5c005b37
RB
149 public function firstNames()
150 {
151 return $this->nameVariants(self::FIRSTNAME);
152 }
153
94b72319
FB
154 public function lastName()
155 {
08c91036 156 return $this->lastname;
94b72319
FB
157 }
158
5c005b37
RB
159 public function lastNames()
160 {
161 return $this->nameVariants(self::LASTNAME);
162 }
163
94b72319
FB
164 public function isFemale()
165 {
166 return $this->sex == PlUser::GENDER_FEMALE;
167 }
168
169 public function data()
170 {
171 $this->first_name;
172 return $this->data;
173 }
174
5c005b37
RB
175 private function nameVariants($type)
176 {
177 $vals = array($this->$type);
178 foreach (self::$name_variants[$type] as $var) {
179 $vartype = $type . '_' . $var;
180 $varname = $this->$vartype;
181 if ($varname != null && $varname != "") {
182 $vals[] = $varname;
183 }
184 }
185 return array_unique($vals);
186 }
187
3e53a496
FB
188 public function __get($name)
189 {
190 if (property_exists($this, $name)) {
191 return $this->$name;
192 }
193
3e53a496
FB
194 if (isset($this->data[$name])) {
195 return $this->data[$name];
196 }
197
198 return null;
199 }
200
201 public function __isset($name)
202 {
203 return property_exists($this, $name) || isset($this->data[$name]);
204 }
205
f5642983
FB
206 public function setVisibilityLevel($visibility)
207 {
208 if ($visibility != self::VISIBILITY_PRIVATE
209 && $visibility != self::VISIBILITY_AX
210 && $visibility != self::VISIBILITY_PUBLIC) {
211 Platal::page()->kill("Visibility invalide: " . $visibility);
212 }
213 $this->visibility = self::$v_values[$visibility];
5c005b37 214 if ($this->mobile && !in_array($this->mobile_pub, $this->visibility)) {
46e9eb99
FB
215 unset($this->data['mobile']);
216 }
f5642983
FB
217 }
218
4bc5b8f0 219
833a6e86
FB
220 /* Photo
221 */
222 public function getPhoto($fallback = true)
223 {
224 /* TODO: migrate photo table to profile_photo, change uid to pid
225 */
226 $cond = '';
227 if ($this->visibility) {
228 $cond = ' AND pub IN ' . XDB::formatArray($this->visibility);
229 }
230 $res = XDB::query('SELECT *
231 FROM photo
232 WHERE attachmime IN (\'jpeg\', \'png\')
233 ' . $cond . ' AND uid = {?}',
234 $this->id());
235 if ($res->numRows() > 0) {
236 $photo = $res->fetchOneAssoc();
237 return PlImage::fromData($photo['attach'], 'image/' . $photo['attachmime'],
238 $photo['x'], $photo['y']);
239 } else if ($fallback) {
240 return PlImage::fromFile(dirname(__FILE__).'/../htdocs/images/none.png',
241 'image/png');
242 }
243 return null;
244 }
245
4bc5b8f0
FB
246 /* Addresses
247 */
248 public function getAddresses($flags, $limit = null)
f5642983
FB
249 {
250 $where = XDB::format('pa.pid = {?}', $this->id());
251 if ($flags & self::ADDRESS_MAIN) {
252 $where .= ' AND FIND_IN_SET(\'current\', pa.flags)';
253 }
254 if ($flags & self::ADDRESS_POSTAL) {
255 $where .= ' AND FIND_IN_SET(\'mail\', pa.flags)';
256 }
257 if ($this->visibility) {
258 $where .= ' AND pa.pub IN ' . XDB::formatArray($this->visibility);
259 }
260 $type = array();
261 if ($flags & self::ADDRESS_PRO) {
262 $type[] = 'job';
263 }
264 if ($flags & self::ADDRESS_PERSO) {
265 $type[] = 'home';
266 }
267 if (count($type) > 0) {
268 $where .= ' AND pa.type IN ' . XDB::formatArray($type);
269 }
4bc5b8f0 270 $limit = is_null($limit) ? '' : XDB::format('LIMIT {?}', (int)$limit);
f5642983
FB
271 return XDB::iterator('SELECT pa.text, pa.postalCode, pa.type, pa.latitude, pa.longitude,
272 gl.name AS locality, gas.name AS subAdministrativeArea,
273 ga.name AS administrativeArea, gc.countryFR AS country,
6b83ce06 274 ppfix.display_tel AS fixed_tel, ppfax.display_tel AS fax_tel,
f5642983
FB
275 FIND_IN_SET(\'current\', pa.flags) AS current,
276 FIND_IN_SET(\'temporary\', pa.flags) AS temporary,
277 FIND_IN_SET(\'secondary\', pa.flags) AS secondary,
278 FIND_IN_SET(\'mail\', pa.flags) AS mail, pa.type
279 FROM profile_addresses AS pa
280 LEFT JOIN geoloc_localities AS gl ON (gl.id = pa.localityId)
281 LEFT JOIN geoloc_administrativeareas AS ga ON (ga.id = pa.administrativeAreaId)
282 LEFT JOIN geoloc_administrativeareas AS gas ON (gas.id = pa.subAdministrativeAreaId)
283 LEFT JOIN geoloc_countries AS gc ON (gc.iso_3166_1_a2 = pa.countryId)
6b83ce06
RB
284 LEFT JOIN profile_phones AS ppfix ON (ppfix.link_type = \'address\' AND ppfix.uid = pa.pid AND ppfix.link_id = pa.id AND ppfix.tel_type = \'fixed\')
285 LEFT JOIN profile_phones AS ppfax ON (ppfax.link_type = \'address\' AND ppfax.uid = pa.pid AND ppfax.link_id = pa.id AND ppfax.tel_type = \'fax\')
4bc5b8f0
FB
286 WHERE ' . $where . '
287 ORDER BY pa.id
288 ' . $limit);
f5642983
FB
289 }
290
291 public function getMainAddress()
292 {
293 $it = $this->getAddresses(self::ADDRESS_PERSO | self::ADDRESS_MAIN);
294 if ($it->total() == 0) {
295 return null;
296 } else {
297 return $it->next();
298 }
299 }
3e53a496 300
4bc5b8f0
FB
301
302 /* Educations
303 */
304 public function getEducations($flags, $limit = null)
305 {
306 $where = XDB::format('pe.uid = {?}', $this->id());
307 if ($flags & self::EDUCATION_MAIN) {
308 $where .= ' AND FIND_IN_SET(\'primary\', pe.flags)';
309 } else if ($flags & self::EDUCATION_EXTRA) {
310 $where .= ' AND NOT FIND_IN_SET(\'primary\', pe.flags)';
311 } else if ($flags & self::EDUCATION_FINISHED) {
312 $where .= ' AND pe.grad_year <= YEAR(CURDATE())';
313 } else if ($flags & self::EDUCATION_CURRENT) {
314 $where .= ' AND pe.grad_year > YEAR(CURDATE())';
315 }
316 $limit = is_null($limit) ? '' : XDB::format('LIMIT {?}', (int)$limit);
317 return XDB::iterator('SELECT pe.entry_year, pe.grad_year, pe.program,
318 pee.name AS school, pee.abbreviation AS school_short, pee.url AS school_url, gc.countryFR AS country,
319 pede.degree, pede.abbreviation AS degree_short, pede.level AS degree_level, pefe.field,
320 FIND_IN_SET(\'primary\', pe.flags) AS prim
321 FROM profile_education AS pe
322 INNER JOIN profile_education_enum AS pee ON (pe.eduid = pee.id)
323 LEFT JOIN geoloc_countries AS gc ON (gc.iso_3166_1_a2 = pee.country)
324 INNER JOIN profile_education_degree_enum AS pede ON (pe.degreeid = pede.id)
325 LEFT JOIN profile_education_field_enum AS pefe ON (pe.fieldid = pefe.id)
326 WHERE ' . $where . '
327 ORDER BY NOT FIND_IN_SET(\'primary\', pe.flags), pe.entry_year, pe.id
328 ' . $limit);
329 }
330
331 public function getExtraEducations($limit = null)
332 {
333 return $this->getEducations(self::EDUCATION_EXTRA, $limit);
334 }
335
336
04a94b1d
FB
337 /** Networking
338 */
339
340 public function getNetworking($flags, $limit = null)
341 {
342 $where = XDB::format('pn.uid = {?}', $this->id());
343 if ($flags & self::NETWORKING_WEB) {
344 $where .= ' AND pn.network_type = 0'; // XXX hardcoded reference to web site index
345 }
346 if ($this->visibility) {
347 $where .= ' AND pn.pub IN ' . XDB::formatArray($this->visibility);
348 }
349 $limit = is_null($limit) ? '' : XDB::format('LIMIT {?}', (int)$limit);
350 return XDB::iterator('SELECT pne.name, pne.icon,
351 IF (LENGTH(pne.link) > 0, REPLACE(pne.link, \'%s\', pn.address),
352 pn.address) AS address
353 FROM profile_networking AS pn
354 INNER JOIN profile_networking_enum AS pne ON (pn.network_type = pne.network_type)
355 WHERE ' . $where . '
356 ORDER BY pn.network_type, pn.nwid
357 ' . $limit);
358 }
359
360 public function getWebSite()
361 {
362 $site = $this->getNetworking(self::NETWORKING_WEB, 1);
363 if ($site->total() != 1) {
364 return null;
365 }
366 $site = $site->next();
367 return $site['address'];
368 }
369
370
e718bd18
FB
371 /** Jobs
372 */
373
374 public function getJobs($flags, $limit = null)
375 {
376 $where = XDB::format('pj.uid = {?}', $this->id());
377 $cond = 'TRUE';
378 if ($this->visibility) {
379 $where .= ' AND pj.pub IN ' . XDB::formatArray($this->visibility);
380 $cond = 'pj.email_pub IN ' . XDB::formatArray($this->visibility);
381 }
382 $limit = is_null($limit) ? '' : XDB::format('LIMIT {?}', (int)$limit);
383 return XDB::iterator('SELECT pje.name, pje.acronym, pje.url, pje.email, pje.NAF_code,
384 pj.description, pj.url AS user_site,
385 IF (' . $cond . ', pj.email, NULL) AS user_email,
83ff5281
SJ
386 pjse.name AS sector, pjsse.name AS subsector,
387 pjssse.name AS subsubsector
e718bd18
FB
388 FROM profile_job AS pj
389 INNER JOIN profile_job_enum AS pje ON (pje.id = pj.jobid)
e718bd18
FB
390 LEFT JOIN profile_job_sector_enum AS pjse ON (pjse.id = pj.sectorid)
391 LEFT JOIN profile_job_subsector_enum AS pjsse ON (pjsse.id = pj.subsectorid)
392 LEFT JOIN profile_job_subsubsector_enum AS pjssse ON (pjssse.id = pj.subsubsectorid)
393 WHERE ' . $where . '
394 ORDER BY pj.id
395 ' . $limit);
396 }
397
398 public function getMailJob()
399 {
400 $job = $this->getJobs(self::JOBS_MAIN, 1);
401 if ($job->total() != 1) {
402 return null;
403 }
404 return $job->next();
405 }
406
5c005b37
RB
407 /* Binets
408 */
409 public function getBinets()
410 {
411 return XDB::fetchColumn('SELECT binet_id
412 FROM binets_ins
413 WHERE user_id = {?}', $this->id());
414 }
415
e718bd18 416
e7b93962
FB
417 public function owner()
418 {
419 return User::getSilent($this);
420 }
421
b774ddab
FB
422 private static function fetchProfileData(array $pids)
423 {
424 if (count($pids) == 0) {
425 return array();
426 }
427 return XDB::fetchAllAssoc('SELECT p.*, p.sex = \'female\' AS sex, pe.entry_year, pe.grad_year,
428 pn_f.name AS firstname, pn_l.name AS lastname, pn_n.name AS nickname,
5c005b37
RB
429 IF(pn_uf.name IS NULL, pn_f.name, pn_uf.name) AS firstname_ordinary,
430 IF(pn_ul.name IS NULL, pn_l.name, pn_ul.name) AS lastname_ordinary,
46e9eb99 431 pd.promo AS promo, pd.short_name, pd.directory_name AS full_name,
5c005b37
RB
432 pd.directory_name, pp.display_tel AS mobile, pp.pub AS mobile_pub,
433 ph.pub AS photo_pub
b774ddab
FB
434 FROM profiles AS p
435 INNER JOIN profile_display AS pd ON (pd.pid = p.pid)
436 INNER JOIN profile_education AS pe ON (pe.uid = p.pid AND FIND_IN_SET(\'primary\', pe.flags))
437 INNER JOIN profile_name AS pn_f ON (pn_f.pid = p.pid
767025be 438 AND pn_f.typeid = ' . self::getNameTypeId('firstname', true) . ')
b774ddab 439 INNER JOIN profile_name AS pn_l ON (pn_l.pid = p.pid
767025be 440 AND pn_l.typeid = ' . self::getNameTypeId('lastname', true) . ')
b774ddab 441 LEFT JOIN profile_name AS pn_uf ON (pn_uf.pid = p.pid
767025be 442 AND pn_uf.typeid = ' . self::getNameTypeId('firstname_ordinary', true) . ')
b774ddab 443 LEFT JOIN profile_name AS pn_ul ON (pn_ul.pid = p.pid
767025be 444 AND pn_ul.typeid = ' . self::getNameTypeId('lastname_ordinary', true) . ')
46e9eb99 445 LEFT JOIN profile_name AS pn_n ON (pn_n.pid = p.pid
b774ddab 446 AND pn_n.typeid = ' . self::getNameTypeId('nickname', true) . ')
46e9eb99 447 LEFT JOIN profile_phones AS pp ON (pp.uid = p.pid AND pp.link_type = \'user\' AND tel_type = \'mobile\')
833a6e86 448 LEFT JOIN photo AS ph ON (ph.uid = p.pid)
b774ddab
FB
449 WHERE p.pid IN ' . XDB::formatArray($pids) . '
450 GROUP BY p.pid');
451 }
452
453 public static function getPID($login)
454 {
455 if ($login instanceof PlUser) {
456 return XDB::fetchOneCell('SELECT pid
457 FROM account_profiles
458 WHERE uid = {?} AND FIND_IN_SET(\'owner\', perms)',
459 $login->id());
460 } else if (ctype_digit($login)) {
461 return XDB::fetchOneCell('SELECT pid
462 FROM profiles
463 WHERE pid = {?}', $login);
464 } else {
465 return XDB::fetchOneCell('SELECT pid
466 FROM profiles
467 WHERE hrpid = {?}', $login);
468 }
469 }
470
471
e7b93962
FB
472 /** Return the profile associated with the given login.
473 */
a3118782
FB
474 public static function get($login)
475 {
b774ddab
FB
476 $pid = self::getPID($login);
477 if (!is_null($pid)) {
478 $data = self::fetchProfileData(array($pid));
479 return new Profile(array_pop($data));
480 } else {
efe597c5
FB
481 /* Let say we can identify a profile using the identifiers of its owner.
482 */
455ea0c9
FB
483 if (!($login instanceof PlUser)) {
484 $user = User::getSilent($login);
485 if ($user && $user->hasProfile()) {
486 return $user->profile();
487 }
efe597c5 488 }
3e53a496 489 return null;
e7b93962
FB
490 }
491 }
a3118782 492
b774ddab
FB
493 /** Return profiles for the list of pids.
494 */
495 public static function getBulkProfilesWithPIDs(array $pids)
496 {
497 if (count($pids) == 0) {
498 return array();
499 }
500 $data = self::fetchProfileData($pids);
501 $inv = array_flip($pids);
502 $profiles = array();
503 foreach ($data AS $p) {
504 $p = new Profile($p);
505 $key = $inv[$p->id()];
506 $profiles[$key] = $p;
507 }
508 return $profiles;
509 }
510
511 /** Return profiles for uids.
512 */
513 public static function getBulkProfilesWithUIDS(array $uids)
514 {
515 if (count($uids) == 0) {
516 return array();
517 }
518 $table = XDB::fetchAllAssoc('uid', 'SELECT ap.uid, ap.pid
519 FROM account_profiles AS ap
520 WHERE FIND_IN_SET(\'owner\', ap.perms)
521 AND ap.uid IN ' . XDB::formatArray($uids));
522 return self::getBulkProfilesWithPIDs($table);
523 }
524
913a4e90
RB
525 public static function isDisplayName($name)
526 {
527 return $name == self::DN_FULL || $name == self::DN_DISPLAY
528 || $name == self::DN_YOURSELF || $name == self::DN_DIRECTORY
529 || $name == self::DN_PRIVATE || $name == self::DN_PUBLIC
530 || $name == self::DN_SHORT || $name == self::DN_SORT;
531 }
532
a3118782
FB
533 public static function getNameTypeId($type, $for_sql = false)
534 {
535 if (!S::has('name_types')) {
eb6207f7 536 $table = XDB::fetchAllAssoc('type', 'SELECT id, type
32742f84 537 FROM profile_name_enum');
a3118782
FB
538 S::set('name_types', $table);
539 } else {
540 $table = S::v('name_types');
541 }
542 if ($for_sql) {
543 return XDB::escape($table[$type]);
544 } else {
545 return $table[$type];
546 }
547 }
e7b93962
FB
548}
549
550// vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
551?>