classes/profile.php

   1 <?php
   2 /***************************************************************************
   3  *  Copyright (C) 2003-2011 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 Profile
  23 {
  24
  25     /* name tokens */
  26     const LASTNAME  = 'lastname';
  27     const FIRSTNAME = 'firstname';
  28     const NICKNAME  = 'nickname';
  29     const PSEUDONYM = 'pseudonym';
  30     const NAME      = 'name';
  31     /* name variants */
  32     const VN_MARITAL  = 'marital';
  33     const VN_ORDINARY = 'ordinary';
  34     const VN_OTHER    = 'other';
  35     const VN_INI      = 'ini';
  36     /* display names */
  37     const DN_FULL      = 'directory_name';
  38     const DN_DISPLAY   = 'yourself';
  39     const DN_YOURSELF  = 'yourself';
  40     const DN_DIRECTORY = 'directory_name';
  41     const DN_PRIVATE   = 'private_name';
  42     const DN_PUBLIC    = 'public_name';
  43     const DN_SHORT     = 'short_name';
  44     const DN_SORT      = 'sort_name';
  45     /* education related names */
  46     const EDU_X    = 'École polytechnique';
  47     const DEGREE_X = 'Ingénieur';
  48     const DEGREE_M = 'Master';
  49     const DEGREE_D = 'Doctorat';
  50
  51     static public $name_variants = array(
  52             self::LASTNAME => array(self::VN_MARITAL, self::VN_ORDINARY),
  53             self::FIRSTNAME => array(self::VN_ORDINARY, self::VN_INI, self::VN_OTHER)
  54         );
  55
  56     const ADDRESS_MAIN       = 0x00000001;
  57     const ADDRESS_PERSO      = 0x00000002;
  58     const ADDRESS_PRO        = 0x00000004;
  59     const ADDRESS_ALL        = 0x00000006;
  60     const ADDRESS_POSTAL     = 0x00000008;
  61
  62     const EDUCATION_MAIN     = 0x00000010;
  63     const EDUCATION_EXTRA    = 0x00000020;
  64     const EDUCATION_ALL      = 0x00000040;
  65     const EDUCATION_FINISHED = 0x00000080;
  66     const EDUCATION_CURRENT  = 0x00000100;
  67
  68     const JOBS_MAIN          = 0x00001000;
  69     const JOBS_ALL           = 0x00002000;
  70     const JOBS_FINISHED      = 0x00004000;
  71     const JOBS_CURRENT       = 0x00008000;
  72
  73     const NETWORKING_ALL     = 0x00070000;
  74     const NETWORKING_WEB     = 0x00010000;
  75     const NETWORKING_IM      = 0x00020000;
  76     const NETWORKING_SOCIAL  = 0x00040000;
  77
  78     const PHONE_LINK_JOB     = 0x00100000;
  79     const PHONE_LINK_ADDRESS = 0x00200000;
  80     const PHONE_LINK_PROFILE = 0x00400000;
  81     const PHONE_LINK_COMPANY = 0x00800000;
  82     const PHONE_LINK_ANY     = 0x00F00000;
  83
  84     const PHONE_TYPE_FAX     = 0x01000000;
  85     const PHONE_TYPE_FIXED   = 0x02000000;
  86     const PHONE_TYPE_MOBILE  = 0x04000000;
  87     const PHONE_TYPE_ANY     = 0x07000000;
  88
  89     const PHONE_ANY          = 0x07F00000;
  90
  91     const FETCH_ADDRESSES      = 0x000001;
  92     const FETCH_CORPS          = 0x000002;
  93     const FETCH_EDU            = 0x000004;
  94     const FETCH_JOBS           = 0x000008;
  95     const FETCH_MEDALS         = 0x000010;
  96     const FETCH_NETWORKING     = 0x000020;
  97     const FETCH_MENTOR_COUNTRY = 0x000080;
  98     const FETCH_PHONES         = 0x000100;
  99     const FETCH_JOB_TERMS      = 0x000200;
 100     const FETCH_MENTOR_TERMS   = 0x000400;
 101
 102     const FETCH_MINIFICHES   = 0x00012D; // FETCH_ADDRESSES | FETCH_EDU | FETCH_JOBS | FETCH_NETWORKING | FETCH_PHONES
 103
 104     const FETCH_ALL          = 0x0007FF; // OR of FETCH_*
 105
 106     static public $descriptions = array(
 107         'search_names'    => 'Noms',
 108         'nationality1'    => 'Nationalité',
 109         'nationality2'    => '2e nationalité',
 110         'nationality3'    => '3e nationalité',
 111         'promo_display'   => 'Promotion affichée',
 112         'email_directory' => 'Email annuaire papier',
 113         'networking'      => 'Messageries…',
 114         'tels'            => 'Téléphones',
 115         'edus'            => 'Formations',
 116         'promo'           => 'Promotion de sortie',
 117         'birthdate'       => 'Date de naissance',
 118         'yourself'        => 'Nom affiché',
 119         'freetext'        => 'Commentaire',
 120         'freetext_pub'    => 'Affichage du commentaire',
 121         'photo'           => 'Photographie',
 122         'photo_pub'       => 'Affichage de la photographie',
 123         'addresses'       => 'Adresses',
 124         'corps'           => 'Corps',
 125         'cv'              => 'CV',
 126         'jobs'            => 'Emplois',
 127         'section'         => 'Section',
 128         'binets'          => 'Binets',
 129         'medals'          => 'Décorations',
 130         'medals_pub'      => 'Affichage des décorations',
 131         'competences'     => 'Compétences',
 132         'langues'         => 'Langues',
 133         'expertise'       => 'Expertises (mentoring)',
 134         'terms'           => 'Compétences (mentoring)',
 135         'countries'       => 'Pays (mentoring)'
 136     );
 137
 138     private $fetched_fields  = 0x000000;
 139
 140     private $pid;
 141     private $hrpid;
 142     private $owner;
 143     private $owner_fetched = false;
 144     private $data = array();
 145
 146     private $visibility = null;
 147
 148
 149     private function __construct(array $data)
 150     {
 151         $this->data = $data;
 152         $this->pid = $this->data['pid'];
 153         $this->hrpid = $this->data['hrpid'];
 154         $this->visibility = new ProfileVisibility();
 155     }
 156
 157     public function id()
 158     {
 159         return $this->pid;
 160     }
 161
 162     public function hrid()
 163     {
 164         return $this->hrpid;
 165     }
 166
 167     public function owner()
 168     {
 169         if ($this->owner == null && !$this->owner_fetched) {
 170             $this->owner_fetched = true;
 171             $this->owner = User::getSilent($this);
 172         }
 173         return $this->owner;
 174     }
 175
 176     public function isActive()
 177     {
 178         if ($this->owner()) {
 179             return $this->owner->isActive();
 180         }
 181         return false;
 182     }
 183
 184     public function promo()
 185     {
 186         return $this->promo;
 187     }
 188
 189     public function yearpromo()
 190     {
 191         return intval(substr($this->promo, 1, 4));
 192     }
 193
 194     /** Check if user is an orange (associated with several promos)
 195      */
 196     public function isMultiPromo()
 197     {
 198         return $this->grad_year != $this->entry_year + $this->mainEducationDuration();
 199     }
 200
 201     /** Returns an array with all associated promo years.
 202      */
 203     public function yearspromo()
 204     {
 205         $promos = array();
 206         $d = -$this->deltaPromoToGradYear();
 207         for ($g = $this->entry_year + $this->mainEducationDuration(); $g <= $this->grad_year; ++$g) {
 208             $promos[] = $g + $d;
 209         }
 210         return $promos;
 211     }
 212
 213     public function mainEducation()
 214     {
 215         if (empty($this->promo)) {
 216             return null;
 217         } else {
 218             return $this->promo{0};
 219         }
 220     }
 221
 222     public function mainGrade()
 223     {
 224         switch ($this->mainEducation()) {
 225           case 'X':
 226             return UserFilter::GRADE_ING;
 227           case 'M':
 228             return UserFilter::GRADE_MST;
 229           case 'D':
 230             return UserFilter::GRADE_PHD;
 231           default:
 232             return null;
 233         }
 234     }
 235
 236     public function mainEducationDuration()
 237     {
 238         switch ($this->mainEducation()) {
 239           case 'X':
 240             return 3;
 241           case 'M':
 242             return 2;
 243           case 'D':
 244             return 3;
 245           default:
 246             return 0;
 247         }
 248     }
 249
 250     /** Number of years between the promotion year until the
 251      * graduation year. In standard schools it's 0, but for
 252      * Polytechnique the promo year is the entry year.
 253      */
 254     public function deltaPromoToGradYear()
 255     {
 256         if ($this->mainEducation() == 'X') {
 257             return $this->mainEducationDuration();
 258         }
 259         return 0;
 260     }
 261
 262     /** Print a name with the given formatting:
 263      * %s = • for women
 264      * %f = firstname
 265      * %l = lastname
 266      * %F = fullname
 267      * %S = shortname
 268      * %p = promo
 269      */
 270     public function name($format)
 271     {
 272         return str_replace(array('%s', '%f', '%l', '%F', '%S', '%p'),
 273                            array($this->isFemale() ? '•' : '',
 274                                  $this->firstName(), $this->lastName(),
 275                                  $this->fullName(), $this->shortName(),
 276                                  $this->promo()), $format);
 277     }
 278
 279     public function fullName($with_promo = false)
 280     {
 281         if ($with_promo) {
 282             return $this->full_name . ' (' . $this->promo . ')';
 283         }
 284         return $this->full_name;
 285     }
 286
 287     public function shortName($with_promo = false)
 288     {
 289         if ($with_promo) {
 290             return $this->short_name . ' (' . $this->promo . ')';
 291         }
 292         return $this->short_name;
 293     }
 294
 295     public function firstName()
 296     {
 297         return $this->firstname;
 298     }
 299
 300     public function firstNames()
 301     {
 302         return $this->nameVariants(self::FIRSTNAME);
 303     }
 304
 305     public function lastName()
 306     {
 307         return $this->lastname;
 308     }
 309
 310     public function lastNames()
 311     {
 312         return $this->nameVariants(self::LASTNAME);
 313     }
 314
 315     public function isFemale()
 316     {
 317         return $this->sex == PlUser::GENDER_FEMALE;
 318     }
 319
 320     public function isDead()
 321     {
 322         return ($this->deathdate != null);
 323     }
 324
 325     public function displayEmail()
 326     {
 327         $o = $this->owner();
 328         if ($o != null) {
 329             return $o->bestEmail();
 330         } else {
 331             return $this->email_directory;
 332         }
 333     }
 334
 335     public function data()
 336     {
 337         $this->first_name;
 338         return $this->data;
 339     }
 340
 341     private function nameVariants($type)
 342     {
 343         $vals = array($this->$type);
 344         foreach (self::$name_variants[$type] as $var) {
 345             $vartype = $type . '_' . $var;
 346             $varname = $this->$vartype;
 347             if ($varname != null && $varname != "") {
 348                 $vals[] = $varname;
 349             }
 350         }
 351         return array_unique($vals);
 352     }
 353
 354     public function nationalities()
 355     {
 356         $nats = array();
 357         $countries = DirEnum::getOptions(DirEnum::COUNTRIES);
 358         if ($this->nationality1) {
 359             $nats[$this->nationality1] = $countries[$this->nationality1];
 360         }
 361         if ($this->nationality2) {
 362             $nats[$this->nationality2] = $countries[$this->nationality2];
 363         }
 364         if ($this->nationality3) {
 365             $nats[$this->nationality3] = $countries[$this->nationality3];
 366         }
 367         return $nats;
 368     }
 369
 370     public function __get($name)
 371     {
 372         if (property_exists($this, $name)) {
 373             return $this->$name;
 374         }
 375
 376         if (isset($this->data[$name])) {
 377             return $this->data[$name];
 378         }
 379
 380         return null;
 381     }
 382
 383     public function __isset($name)
 384     {
 385         return property_exists($this, $name) || isset($this->data[$name]);
 386     }
 387
 388     public function __unset($name)
 389     {
 390         if (property_exists($this, $name)) {
 391             $this->$name = null;
 392         } else {
 393             unset($this->data[$name]);
 394         }
 395     }
 396
 397
 398     /**
 399      * Clears a profile.
 400      *  *always deletes in: profile_addresses, profile_binets, profile_job,
 401      *      profile_langskills, profile_mentor, profile_networking,
 402      *      profile_phones, profile_skills, watch_profile
 403      *  *always keeps in: profile_corps, profile_display, profile_education,
 404      *      profile_medals, profile_name, profile_photos, search_name
 405      *  *modifies: profiles
 406      */
 407     public function clear()
 408     {
 409         $tables = array(
 410             'profile_job', 'profile_langskills', 'profile_mentor',
 411             'profile_networking', 'profile_skills', 'watch_profile',
 412             'profile_phones', 'profile_addresses', 'profile_binets');
 413
 414         foreach ($tables as $t) {
 415             XDB::execute('DELETE FROM  ' . $t . '
 416                                 WHERE  pid = {?}',
 417                                 $this->id());
 418         }
 419
 420         XDB::execute("UPDATE  profiles
 421                          SET  cv = NULL, freetext = NULL, freetext_pub = 'private',
 422                               medals_pub = 'private', alias_pub = 'private',
 423                               email_directory = NULL
 424                        WHERE  pid = {?}",
 425                      $this->id());
 426     }
 427
 428     /** Sets the level of visibility of the profile
 429      * Sets $this->visibility to a list of valid visibilities.
 430      * @param one of the self::VIS_* values
 431      */
 432     public function setVisibilityLevel($visibility)
 433     {
 434         $this->visibility->setLevel($visibility);
 435     }
 436
 437     /** Determine whether an item with visibility $visibility can be displayed
 438      * with the current level of visibility of the profile
 439      * @param $visibility The level of visibility to be checked
 440      */
 441     public function isVisible($visibility)
 442     {
 443         return $this->visibility->isVisible($visibility);
 444     }
 445
 446     /** Stores the list of fields which have already been fetched for this Profile
 447      */
 448     public function setFetchedFields($fields)
 449     {
 450         if (($fields | self::FETCH_ALL) != self::FETCH_ALL) {
 451             Platal::page()->kill("Invalid fetched fields: $fields");
 452         }
 453
 454         $this->fetched_fields = $fields;
 455     }
 456
 457     /** Have we already fetched this field ?
 458      */
 459     private function fetched($field)
 460     {
 461         if (!array_key_exists($field, ProfileField::$fields)) {
 462             Platal::page()->kill("Invalid field: $field");
 463         }
 464
 465         return ($this->fetched_fields & $field);
 466     }
 467
 468     /** If not already done, fetches data for the given field
 469      * @param $field One of the Profile::FETCH_*
 470      * @return A ProfileField, or null
 471      */
 472     private function getProfileField($field)
 473     {
 474         if (!array_key_exists($field, ProfileField::$fields)) {
 475             Platal::page()->kill("Invalid field: $field");
 476         }
 477         if ($this->fetched($field)) {
 478             return null;
 479         } else {
 480             $this->fetched_fields = $this->fetched_fields | $field;
 481         }
 482
 483         $cls = ProfileField::$fields[$field];
 484
 485         return ProfileField::getForPID($cls, $this->id(), $this->visibility);
 486     }
 487
 488     /** Consolidates internal data (addresses, phones, jobs)
 489      */
 490     private function consolidateFields()
 491     {
 492         // Link phones to addresses
 493         if ($this->phones != null) {
 494             if ($this->addresses != null) {
 495                 $this->addresses->addPhones($this->phones);
 496             }
 497
 498             if ($this->jobs != null) {
 499                 $this->jobs->addPhones($this->phones);
 500             }
 501         }
 502
 503         // Link addresses to jobs
 504         if ($this->addresses != null && $this->jobs != null) {
 505             $this->jobs->addAddresses($this->addresses);
 506         }
 507
 508         // Link jobterms to jobs
 509         if ($this->jobs != null && $this->jobterms != null) {
 510             $this->jobs->addJobTerms($this->jobterms);
 511         }
 512     }
 513
 514     /* Photo
 515      */
 516     private $photo = null;
 517     public function getPhoto($fallback = true, $data = false)
 518     {
 519         if ($this->has_photo) {
 520             if ($data && ($this->photo == null || $this->photo->mimeType == null)) {
 521                 $res = XDB::fetchOneAssoc('SELECT  attach, attachmime, x, y, last_update
 522                                              FROM  profile_photos
 523                                             WHERE  pid = {?}', $this->pid);
 524                 $this->photo = PlImage::fromData($res['attach'], 'image/' .$res['attachmime'], $res['x'], $res['y'], $res['last_update']);
 525             } else if ($this->photo == null) {
 526                 $this->photo = PlImage::fromData(null, null, $this->photo_width, $this->photo_height);
 527             }
 528             return $this->photo;
 529         } else if ($fallback) {
 530             return PlImage::fromFile(dirname(__FILE__).'/../htdocs/images/none.png',
 531                                      'image/png');
 532         }
 533         return null;
 534     }
 535
 536     /* Addresses
 537      */
 538     private $addresses = null;
 539     public function setAddresses(ProfileAddresses $addr)
 540     {
 541         $this->addresses = $addr;
 542         $this->consolidateFields();
 543     }
 544
 545     private function fetchAddresses()
 546     {
 547         if ($this->addresses == null  && !$this->fetched(self::FETCH_ADDRESSES)) {
 548             $addr = $this->getProfileField(self::FETCH_ADDRESSES);
 549             if ($addr) {
 550                 $this->setAddresses($addr);
 551                 $this->fetchPhones();
 552             }
 553         }
 554     }
 555
 556     public function getAddresses($flags, $limit = null)
 557     {
 558         $this->fetchAddresses();
 559
 560         if ($this->addresses == null) {
 561             return array();
 562         }
 563         return $this->addresses->get($flags, $limit);
 564     }
 565
 566     public function iterAddresses($flags, $limit = null)
 567     {
 568         return PlIteratorUtils::fromArray($this->getAddresses($flags, $limit), 1, true);
 569     }
 570
 571     public function getMainAddress()
 572     {
 573         $main = $this->getAddresses(self::ADDRESS_MAIN);
 574         $perso = $this->getAddresses(self::ADDRESS_PERSO);
 575
 576         if (count($main)) {
 577             return array_pop($main);
 578         } else if (count($perso)) {
 579             return array_pop($perso);
 580         } else {
 581             return null;
 582         }
 583     }
 584
 585     /* Phones
 586      */
 587     private $phones = null;
 588     public function setPhones(ProfilePhones $phones)
 589     {
 590         $this->phones = $phones;
 591         $this->consolidateFields();
 592     }
 593
 594     private function fetchPhones()
 595     {
 596         if ($this->phones == null && !$this->fetched(self::FETCH_PHONES)) {
 597             $phones = $this->getProfileField(self::FETCH_PHONES);
 598             if (isset($phones)) {
 599                 $this->setPhones($phones);
 600             }
 601         }
 602     }
 603
 604     public function getPhones($flags, $limit = null)
 605     {
 606         $this->fetchPhones();
 607         if ($this->phones == null) {
 608             return array();
 609         }
 610         return $this->phones->get($flags, $limit);
 611     }
 612
 613     /* Educations
 614      */
 615     private $educations = null;
 616     public function setEducations(ProfileEducation $edu)
 617     {
 618         $this->educations = $edu;
 619     }
 620
 621     public function getEducations($flags, $limit = null)
 622     {
 623         if ($this->educations == null && !$this->fetched(self::FETCH_EDU)) {
 624             $this->setEducations($this->getProfileField(self::FETCH_EDU));
 625         }
 626
 627         if ($this->educations == null) {
 628             return array();
 629         }
 630         return $this->educations->get($flags, $limit);
 631     }
 632
 633     public function getExtraEducations($limit = null)
 634     {
 635         return $this->getEducations(self::EDUCATION_EXTRA, $limit);
 636     }
 637
 638     /* Corps
 639      */
 640     private $corps = null;
 641     public function setCorps(ProfileCorps $corps)
 642     {
 643         $this->corps = $corps;
 644     }
 645
 646     public function getCorps()
 647     {
 648         if ($this->corps == null && !$this->fetched(self::FETCH_CORPS)) {
 649             $this->setCorps($this->getProfileField(self::FETCH_CORPS));
 650         }
 651         return $this->corps;
 652     }
 653
 654     /** Networking
 655      */
 656     private $networks = null;
 657     public function setNetworking(ProfileNetworking $nw)
 658     {
 659         $this->networks = $nw;
 660     }
 661
 662     public function getNetworking($flags, $limit = null)
 663     {
 664         if ($this->networks == null && !$this->fetched(self::FETCH_NETWORKING)) {
 665             $nw = $this->getProfileField(self::FETCH_NETWORKING);
 666             if ($nw) {
 667                 $this->setNetworking($nw);
 668             }
 669         }
 670         if ($this->networks == null) {
 671             return array();
 672         }
 673         return $this->networks->get($flags, $limit);
 674     }
 675
 676     public function getWebSite()
 677     {
 678         $site = $this->getNetworking(self::NETWORKING_WEB, 1);
 679         if (count($site) != 1) {
 680             return null;
 681         }
 682         $site = array_pop($site);
 683         return $site;
 684     }
 685
 686
 687     /** Jobs
 688      */
 689     private $jobs = null;
 690     public function setJobs(ProfileJobs $jobs)
 691     {
 692         $this->jobs = $jobs;
 693         $this->consolidateFields();
 694     }
 695
 696     private function fetchJobs()
 697     {
 698         if ($this->jobs == null && !$this->fetched(self::FETCH_JOBS)) {
 699             $jobs = $this->getProfileField(self::FETCH_JOBS);
 700             if ($jobs) {
 701                 $this->setJobs($jobs);
 702                 $this->fetchAddresses();
 703             }
 704         }
 705     }
 706
 707     public function getJobs($flags, $limit = null)
 708     {
 709         $this->fetchJobs();
 710
 711         if ($this->jobs == null) {
 712             return array();
 713         }
 714         return $this->jobs->get($flags, $limit);
 715     }
 716
 717     public function getMainJob()
 718     {
 719         $job = $this->getJobs(self::JOBS_MAIN, 1);
 720         if (count($job) != 1) {
 721             return null;
 722         }
 723         return array_pop($job);
 724     }
 725
 726     /** JobTerms
 727      */
 728     private $jobterms = null;
 729     public function setJobTerms(ProfileJobTerms $jobterms)
 730     {
 731         $this->jobterms = $jobterms;
 732         $this->consolidateFields();
 733     }
 734
 735     private $mentor_countries = null;
 736     public function setMentoringCountries(ProfileMentoringCountries $countries)
 737     {
 738         $this->mentor_countries = $countries;
 739     }
 740
 741     public function getMentoringCountries()
 742     {
 743         if ($this->mentor_countries == null && !$this->fetched(self::FETCH_MENTOR_COUNTRY)) {
 744             $this->setMentoringCountries($this->getProfileField(self::FETCH_MENTOR_COUNTRY));
 745         }
 746
 747         if ($this->mentor_countries == null) {
 748             return array();
 749         } else {
 750             return $this->mentor_countries->countries;
 751         }
 752     }
 753
 754     /** List of job terms to specify mentoring */
 755     private $mentor_terms = null;
 756     /**
 757      * set job terms to specify mentoring
 758      * @param $terms a ProfileMentoringTerms object listing terms only for this profile
 759      */
 760     public function setMentoringTerms(ProfileMentoringTerms $terms)
 761     {
 762         $this->mentor_terms = $terms;
 763     }
 764     /**
 765      * get all job terms that specify mentoring
 766      * @return an array of JobTerms objects
 767      */
 768     public function getMentoringTerms()
 769     {
 770         if ($this->mentor_terms == null && !$this->fetched(self::FETCH_MENTOR_TERMS)) {
 771             $this->setMentoringTerms($this->getProfileField(self::FETCH_MENTOR_TERMS));
 772         }
 773
 774         if ($this->mentor_terms == null) {
 775             return array();
 776         } else {
 777             return $this->mentor_terms->get();
 778         }
 779     }
 780
 781
 782     /* Binets
 783      */
 784     public function getBinets()
 785     {
 786         if ($this->visibility->isVisible(ProfileVisibility::VIS_PRIVATE)) {
 787             return XDB::fetchColumn('SELECT  binet_id
 788                                        FROM  profile_binets
 789                                       WHERE  pid = {?}', $this->id());
 790         } else {
 791             return array();
 792         }
 793     }
 794     public function getBinetsNames()
 795     {
 796         if ($this->visibility->isVisible(ProfileVisibility::VIS_PRIVATE)) {
 797             return XDB::fetchColumn('SELECT  text
 798                                        FROM  profile_binets AS pb
 799                                   LEFT JOIN  profile_binet_enum AS pbe ON (pbe.id = pb.binet_id)
 800                                       WHERE  pb.pid = {?}', $this->id());
 801         } else {
 802             return array();
 803         }
 804     }
 805
 806     /* Medals
 807      */
 808     private $medals = null;
 809     public function setMedals(ProfileMedals $medals)
 810     {
 811         $this->medals = $medals;
 812     }
 813
 814     public function getMedals()
 815     {
 816         if ($this->medals == null && !$this->fetched(self::FETCH_MEDALS)) {
 817             $this->setMedals($this->getProfileField(self::FETCH_MEDALS));
 818         }
 819         if ($this->medals == null) {
 820             return array();
 821         }
 822         return $this->medals->medals;
 823     }
 824
 825     public function compareNames($firstname, $lastname)
 826     {
 827         $_lastname  = mb_strtoupper($this->lastName());
 828         $_firstname = mb_strtoupper($this->firstName());
 829         $lastname   = mb_strtoupper($lastname);
 830         $firstname  = mb_strtoupper($firstname);
 831
 832         $isOk  = (mb_strtoupper($_firstname) == mb_strtoupper($firstname));
 833         $tokens = preg_split("/[ \-']/", $lastname, -1, PREG_SPLIT_NO_EMPTY);
 834         $maxlen = 0;
 835
 836         foreach ($tokens as $str) {
 837             $isOk &= (strpos($_lastname, $str) !== false);
 838             $maxlen = max($maxlen, strlen($str));
 839         }
 840
 841         return ($isOk && ($maxlen > 2 || $maxlen == strlen($_lastname)));
 842     }
 843
 844     private static function fetchProfileData(array $pids, $respect_order = true, $fields = 0x0000, $visibility = null)
 845     {
 846         if (count($pids) == 0) {
 847             return null;
 848         }
 849
 850         if ($respect_order) {
 851             $order = 'ORDER BY  ' . XDB::formatCustomOrder('p.pid', $pids);
 852         } else {
 853             $order = '';
 854         }
 855
 856         $visibility = new ProfileVisibility($visibility);
 857
 858         $it = XDB::Iterator('SELECT  p.pid, p.hrpid, p.xorg_id, p.ax_id, p.birthdate, p.birthdate_ref,
 859                                      p.next_birthday, p.deathdate, p.deathdate_rec, p.sex = \'female\' AS sex,
 860                                      IF ({?}, p.cv, NULL) AS cv, p.medals_pub, p.alias_pub, p.email_directory,
 861                                      p.last_change, p.nationality1, p.nationality2, p.nationality3,
 862                                      IF (p.freetext_pub IN {?}, p.freetext, NULL) AS freetext,
 863                                      pe.entry_year, pe.grad_year,
 864                                      IF ({?}, pse.text, NULL) AS section,
 865                                      pn_f.name AS firstname, pn_l.name AS lastname,
 866                                      IF( {?}, pn_n.name, NULL) AS nickname,
 867                                      IF(pn_uf.name IS NULL, pn_f.name, pn_uf.name) AS firstname_ordinary,
 868                                      IF(pn_ul.name IS NULL, pn_l.name, pn_ul.name) AS lastname_ordinary,
 869                                      pd.yourself, pd.promo, pd.short_name, pd.public_name AS full_name,
 870                                      pd.directory_name, pd.public_name, pd.private_name,
 871                                      IF(pp.pub IN {?}, pp.display_tel, NULL) AS mobile,
 872                                      (ph.pub IN {?} AND ph.attach IS NOT NULL) AS has_photo,
 873                                      ph.x AS photo_width, ph.y AS photo_height,
 874                                      p.last_change < DATE_SUB(NOW(), INTERVAL 365 DAY) AS is_old,
 875                                      pm.expertise AS mentor_expertise,
 876                                      ap.uid AS owner_id
 877                                FROM  profiles AS p
 878                          INNER JOIN  profile_display AS pd ON (pd.pid = p.pid)
 879                          INNER JOIN  profile_education AS pe ON (pe.pid = p.pid AND FIND_IN_SET(\'primary\', pe.flags))
 880                           LEFT JOIN  profile_section_enum AS pse ON (pse.id = p.section)
 881                          INNER JOIN  profile_name AS pn_f ON (pn_f.pid = p.pid
 882                                                               AND pn_f.typeid = ' . self::getNameTypeId('firstname', true) . ')
 883                          INNER JOIN  profile_name AS pn_l ON (pn_l.pid = p.pid
 884                                                               AND pn_l.typeid = ' . self::getNameTypeId('lastname', true) . ')
 885                           LEFT JOIN  profile_name AS pn_uf ON (pn_uf.pid = p.pid
 886                                                                AND pn_uf.typeid = ' . self::getNameTypeId('firstname_ordinary', true) . ')
 887                           LEFT JOIN  profile_name AS pn_ul ON (pn_ul.pid = p.pid
 888                                                                AND pn_ul.typeid = ' . self::getNameTypeId('lastname_ordinary', true) . ')
 889                           LEFT JOIN  profile_name AS pn_n ON (pn_n.pid = p.pid
 890                                                               AND pn_n.typeid = ' . self::getNameTypeId('nickname', true) . ')
 891                           LEFT JOIN  profile_phones AS pp ON (pp.pid = p.pid AND pp.link_type = \'user\' AND tel_type = \'mobile\')
 892                           LEFT JOIN  profile_photos AS ph ON (ph.pid = p.pid)
 893                           LEFT JOIN  profile_mentor AS pm ON (pm.pid = p.pid)
 894                           LEFT JOIN  account_profiles AS ap ON (ap.pid = p.pid AND FIND_IN_SET(\'owner\', ap.perms))
 895                               WHERE  p.pid IN {?}
 896                            GROUP BY  p.pid
 897                                      ' . $order,
 898                            $visibility->isVisible(ProfileVisibility::VIS_PRIVATE), // CV
 899                            $visibility->levels(), // freetext
 900                            $visibility->isVisible(ProfileVisibility::VIS_PRIVATE), // section
 901                            $visibility->isVisible(ProfileVisibility::VIS_PRIVATE), // nickname
 902                            $visibility->levels(), // mobile
 903                            $visibility->levels(), // photo
 904                            $pids
 905                        );
 906         return new ProfileIterator($it, $pids, $fields, $visibility);
 907     }
 908
 909     public static function getPID($login)
 910     {
 911         if ($login instanceof PlUser) {
 912             return XDB::fetchOneCell('SELECT  pid
 913                                         FROM  account_profiles
 914                                        WHERE  uid = {?} AND FIND_IN_SET(\'owner\', perms)',
 915                                      $login->id());
 916         } else if (ctype_digit($login)) {
 917             return XDB::fetchOneCell('SELECT  pid
 918                                         FROM  profiles
 919                                        WHERE  pid = {?}', $login);
 920         } else {
 921             return XDB::fetchOneCell('SELECT  pid
 922                                         FROM  profiles
 923                                        WHERE  hrpid = {?}', $login);
 924         }
 925     }
 926
 927     public static function getPIDsFromUIDs($uids, $respect_order = true)
 928     {
 929         if ($respect_order) {
 930             $order = 'ORDER BY ' . XDB::formatCustomOrder('uid', $uids);
 931         } else {
 932             $order = '';
 933         }
 934         return XDB::fetchAllAssoc('uid', 'SELECT  ap.uid, ap.pid
 935                                             FROM  account_profiles AS ap
 936                                            WHERE  FIND_IN_SET(\'owner\', ap.perms)
 937                                                   AND ap.uid IN ' . XDB::formatArray($uids) .'
 938                                                ' . $order);
 939     }
 940
 941     /** Return the profile associated with the given login.
 942      */
 943     public static function get($login, $fields = 0x0000, $visibility = null)
 944     {
 945         if (is_array($login)) {
 946             $pf = new Profile($login);
 947             $pf->setVisibilityLevel($visibility);
 948             return $pf;
 949         }
 950         $pid = self::getPID($login);
 951         if (!is_null($pid)) {
 952             $it = self::iterOverPIDs(array($pid), false, $fields, $visibility);
 953             return $it->next();
 954         } else {
 955             /* Let say we can identify a profile using the identifiers of its owner.
 956              */
 957             if (!($login instanceof PlUser)) {
 958                 $user = User::getSilent($login);
 959                 if ($user && $user->hasProfile()) {
 960                     return $user->profile();
 961                 }
 962             }
 963             return null;
 964         }
 965     }
 966
 967     public static function iterOverUIDs($uids, $respect_order = true, $fields = 0x0000, $visibility = null)
 968     {
 969         return self::iterOverPIDs(self::getPIDsFromUIDs($uids), $respect_order, $fields, $visibility);
 970     }
 971
 972     public static function iterOverPIDs($pids, $respect_order = true, $fields = 0x0000, $visibility = null)
 973     {
 974         return self::fetchProfileData($pids, $respect_order, $fields, $visibility);
 975     }
 976
 977     /** Return profiles for the list of pids.
 978      */
 979     public static function getBulkProfilesWithPIDs(array $pids, $fields = 0x0000, $visibility = null)
 980     {
 981         if (count($pids) == 0) {
 982             return array();
 983         }
 984         $it = self::iterOverPIDs($pids, true, $fields, $visibility);
 985         $profiles = array();
 986         while ($p = $it->next()) {
 987             $profiles[$p->id()] = $p;
 988         }
 989         return $profiles;
 990     }
 991
 992     /** Return profiles for uids.
 993      */
 994     public static function getBulkProfilesWithUIDS(array $uids, $fields = 0x000, $visibility = null)
 995     {
 996         if (count($uids) == 0) {
 997             return array();
 998         }
 999         return self::getBulkProfilesWithPIDs(self::getPIDsFromUIDs($uids), $fields, $visibility);
1000     }
1001
1002     public static function isDisplayName($name)
1003     {
1004         return $name == self::DN_FULL || $name == self::DN_DISPLAY
1005             || $name == self::DN_YOURSELF || $name == self::DN_DIRECTORY
1006             || $name == self::DN_PRIVATE || $name == self::DN_PUBLIC
1007             || $name == self::DN_SHORT || $name == self::DN_SORT;
1008     }
1009
1010     /** Returns the closest "accounts only" name type for $name
1011      */
1012     public static function getAccountEquivalentName($name)
1013     {
1014         switch ($name)
1015         {
1016         case self::DN_DIRECTORY:
1017         case self::DN_SORT:
1018             return 'directory_name';
1019         case self::DN_FULL:
1020         case self::DN_PUBLIC:
1021             return 'full_name';
1022         case self::DN_PRIVATE:
1023         case self::DN_SHORT:
1024         case self::DN_YOURSELF:
1025         default:
1026             return 'display_name';
1027         }
1028     }
1029
1030     public static function getNameTypeId($type, $for_sql = false)
1031     {
1032         if (!S::has('name_types')) {
1033             $table = XDB::fetchAllAssoc('type', 'SELECT  id, type
1034                                                    FROM  profile_name_enum');
1035             S::set('name_types', $table);
1036         } else {
1037             $table = S::v('name_types');
1038         }
1039         if ($for_sql) {
1040             return XDB::escape($table[$type]);
1041         } else {
1042             return $table[$type];
1043         }
1044     }
1045
1046     public static function rebuildSearchTokens($pids, $transaction = true)
1047     {
1048         if (!is_array($pids)) {
1049             $pids = array($pids);
1050         }
1051         $keys = XDB::iterator("(SELECT  n.pid AS pid, n.name AS name, e.score AS score,
1052                                         IF(FIND_IN_SET('public', e.flags), 'public', '') AS public
1053                                   FROM  profile_name      AS n
1054                             INNER JOIN  profile_name_enum AS e ON (n.typeid = e.id)
1055                                  WHERE  n.pid IN {?} AND NOT FIND_IN_SET('not_displayed', e.flags))
1056                                  UNION
1057                                 (SELECT  n.pid AS pid, n.particle AS name, 0 AS score,
1058                                          IF(FIND_IN_SET('public', e.flags), 'public', '') AS public
1059                                    FROM  profile_name      AS n
1060                              INNER JOIN  profile_name_enum AS e ON (n.typeid = e.id)
1061                                   WHERE  n.pid IN {?} AND NOT FIND_IN_SET('not_displayed', e.flags))
1062                                ",
1063                               $pids, $pids);
1064         $names = array();
1065         while ($key = $keys->next()) {
1066             if ($key['name'] == '') {
1067                 continue;
1068             }
1069             $pid   = $key['pid'];
1070             $toks  = preg_split('/[ \'\-]+/', strtolower(replace_accent($key['name'])),
1071                                 -1, PREG_SPLIT_NO_EMPTY);
1072             $toks = array_reverse($toks);
1073
1074             /* Split the score between the tokens to avoid the user to be over-rated.
1075              * Let says my user name is "Machin-Truc Bidule" and I also have a user named
1076              * 'Machin Truc'. Distributing the score force "Machin Truc" to be displayed
1077              * before "Machin-Truc" for both "Machin Truc" and "Machin" searches.
1078              */
1079             $eltScore = ceil(((float)$key['score'])/((float)count($toks)));
1080             $token = '';
1081             foreach ($toks as $tok) {
1082                 $token = $tok . $token;
1083                 $names["$pid-$token"] = XDB::format('({?}, {?}, {?}, {?}, {?})',
1084                                                     $token, $pid, soundex_fr($token),
1085                                                     $eltScore, $key['public']);
1086             }
1087         }
1088         if ($transaction) {
1089             XDB::startTransaction();
1090         }
1091         XDB::execute('DELETE FROM  search_name
1092                             WHERE  pid IN {?}',
1093                      $pids);
1094         if (count($names) > 0) {
1095             XDB::rawExecute('INSERT INTO  search_name (token, pid, soundex, score, flags)
1096                                   VALUES  ' . implode(', ', $names));
1097         }
1098         if ($transaction) {
1099             XDB::commit();
1100         }
1101     }
1102
1103     /** The school identifier consists of 6 digits. The first 3 represent the
1104      * promotion entry year. The last 3 indicate the student's rank.
1105      *
1106      * Our identifier consists of 8 digits and both half have the same role.
1107      * This enables us to deal with bigger promotions and with a wider range
1108      * of promotions.
1109      *
1110      * getSchoolId returns a school identifier given one of ours.
1111      * getXorgId returns a X.org identifier given a school identifier.
1112      */
1113     public static function getSchoolId($xorgId)
1114     {
1115         if (!preg_match('/^[0-9]{8}$/', $xorgId)) {
1116             return null;
1117         }
1118
1119         $year = intval(substr($xorgId, 0, 4));
1120         $rank = intval(substr($xorgId, 5, 3));
1121         if ($year < 1996) {
1122             return null;
1123         } elseif ($year < 2000) {
1124             $year = intval(substr(1900 - $year, 1, 3));
1125             return sprintf('%02u0%03u', $year, $rank);
1126         } else {
1127             $year = intval(substr(1900 - $year, 1, 3));
1128             return sprintf('%03u%03u', $year, $rank);
1129         }
1130     }
1131
1132     public static function getXorgId($schoolId)
1133     {
1134         if (!preg_match('/^[0-9]{6}$/', $schoolId)) {
1135             return null;
1136         }
1137
1138         $year = intval(substr($schoolId, 0, 3));
1139         $rank = intval(substr($schoolId, 3, 3));
1140
1141         if ($year > 200) {
1142             $year /= 10;
1143         }
1144         if ($year < 96) {
1145             return null;
1146         } else {
1147             return sprintf('%04u%04u', 1900 + $year, $rank);
1148         }
1149     }
1150 }
1151
1152
1153 /** Iterator over a set of Profiles
1154  */
1155 class ProfileIterator implements PlIterator
1156 {
1157     private $iterator = null;
1158     private $fields;
1159     private $visibility;
1160
1161     const FETCH_ALL    = 0x000033F; // FETCH_ADDRESSES | FETCH_CORPS | FETCH_EDU | FETCH_JOBS | FETCH_MEDALS | FETCH_NETWORKING | FETCH_PHONES | FETCH_JOB_TERMS
1162
1163     public function __construct(PlIterator $it, array $pids, $fields = 0x0000, ProfileVisibility $visibility = null)
1164     {
1165         require_once 'profilefields.inc.php';
1166
1167         if ($visibility == null) {
1168             $visibility = new ProfileVisibility();
1169         }
1170
1171         $this->fields = $fields;
1172         $this->visibility = $visibility;
1173
1174         $subits = array();
1175         $callbacks = array();
1176
1177         $subits[0] = $it;
1178         $callbacks[0] = PlIteratorUtils::arrayValueCallback('pid');
1179         $cb = PlIteratorUtils::objectPropertyCallback('pid');
1180
1181         $fields = $fields & self::FETCH_ALL;
1182         for ($field = 1; $field < $fields; $field *= 2) {
1183             if (($fields & $field) ) {
1184                 $callbacks[$field] = $cb;
1185                 $subits[$field] = new ProfileFieldIterator($field, $pids, $visibility);
1186             }
1187         }
1188
1189         $this->iterator = PlIteratorUtils::parallelIterator($subits, $callbacks, 0);
1190     }
1191
1192     private function hasData($field, $vals)
1193     {
1194         return ($this->fields & $field) && ($vals[$field] != null);
1195     }
1196
1197     private function fillProfile(array $vals)
1198     {
1199         $pf = Profile::get($vals[0]);
1200         $pf->setVisibilityLevel($this->visibility->level());
1201         $pf->setFetchedFields($this->fields);
1202
1203         if ($this->hasData(Profile::FETCH_PHONES, $vals)) {
1204             $pf->setPhones($vals[Profile::FETCH_PHONES]);
1205         }
1206         if ($this->hasData(Profile::FETCH_ADDRESSES, $vals)) {
1207             $pf->setAddresses($vals[Profile::FETCH_ADDRESSES]);
1208         }
1209         if ($this->hasData(Profile::FETCH_JOBS, $vals)) {
1210             $pf->setJobs($vals[Profile::FETCH_JOBS]);
1211         }
1212         if ($this->hasData(Profile::FETCH_JOB_TERMS, $vals)) {
1213             $pf->setJobTerms($vals[Profile::FETCH_JOB_TERMS]);
1214         }
1215
1216         if ($this->hasData(Profile::FETCH_CORPS, $vals)) {
1217             $pf->setCorps($vals[Profile::FETCH_CORPS]);
1218         }
1219         if ($this->hasData(Profile::FETCH_EDU, $vals)) {
1220             $pf->setEducations($vals[Profile::FETCH_EDU]);
1221         }
1222         if ($this->hasData(Profile::FETCH_MEDALS, $vals)) {
1223             $pf->setMedals($vals[Profile::FETCH_MEDALS]);
1224         }
1225         if ($this->hasData(Profile::FETCH_NETWORKING, $vals)) {
1226             $pf->setNetworking($vals[Profile::FETCH_NETWORKING]);
1227         }
1228
1229         return $pf;
1230     }
1231
1232     public function next()
1233     {
1234         $vals = $this->iterator->next();
1235         if ($vals == null) {
1236             return null;
1237         }
1238         return $this->fillProfile($vals);
1239     }
1240
1241     public function first()
1242     {
1243         return $this->iterator->first();
1244     }
1245
1246     public function last()
1247     {
1248         return $this->iterator->last();
1249     }
1250
1251     public function total()
1252     {
1253         return $this->iterator->total();
1254     }
1255 }
1256
1257 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
1258 ?>