modules/profile/page.inc.php

   1 <?php
   2 /***************************************************************************
   3  *  Copyright (C) 2003-2010 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 interface ProfileSetting
  23 {
  24     /** Get a field and a value, check that the given value is
  25      * valid, if not, return a corrected value. If no valid value can be
  26      * computed from the input data, the success flag is set to false.
  27      *
  28      * If value is null, the default value should be returned.
  29      * TODO: check this does not conflict with some possible values.
  30      *
  31      * Whatever happen, this function must always returns the function to
  32      * show on the page to the user.
  33      */
  34     public function value(ProfilePage &$page, $field, $value, &$success);
  35
  36     /** Save the new value for the given field.
  37      */
  38     public function save(ProfilePage &$page, $field, $new_value);
  39
  40     /** Get text from the value.
  41      */
  42     public function getText($value);
  43 }
  44
  45 abstract class ProfileNoSave implements ProfileSetting
  46 {
  47     public function save(ProfilePage &$page, $field, $new_value) { }
  48
  49     public function getText($value) {
  50         return $value;
  51     }
  52 }
  53
  54 class ProfileSettingWeb extends ProfileNoSave
  55 {
  56     public function value(ProfilePage &$page, $field, $value, &$success)
  57     {
  58         if (is_null($value)) {
  59             return isset($page->values[$field]) ? $page->values[$field] : S::v($field);
  60         }
  61         $value = trim($value);
  62         $success = empty($value) || preg_match("{^(https?|ftp)://[a-zA-Z0-9._%#+/?=&~-]+$}i", $value);
  63         if (!$success) {
  64             Platal::page()->trigError('URL Incorrecte : une url doit commencer par http:// ou https:// ou ftp://'
  65                                     . ' et ne pas contenir de caractères interdits');
  66         }
  67         return $value;
  68     }
  69 }
  70
  71 class ProfileSettingEmail extends ProfileNoSave
  72 {
  73     public function value(ProfilePage &$page, $field, $value, &$success)
  74     {
  75         if (is_null($value)) {
  76             return isset($page->values[$field]) ? $page->values[$field] : S::v($field);
  77         }
  78         $value = trim($value);
  79         $success = empty($value) || isvalid_email($value);
  80         if (!$success) {
  81             Platal::page()->trigError('Adresse Email invalide');
  82         }
  83         return $value;
  84     }
  85 }
  86
  87 class ProfileSettingNumber extends ProfileNoSave
  88 {
  89     public function value(ProfilePage &$page, $field, $value, &$success)
  90     {
  91         if (is_null($value)) {
  92             return isset($page->values[$field]) ? $page->values[$field] : S::v($field);
  93         }
  94         $value = trim($value);
  95         $success = empty($value) || is_numeric($value);
  96         if (!$success) {
  97             Platal::page()->trigError('Numéro invalide');
  98         }
  99         return $value;
 100     }
 101 }
 102
 103 class ProfileSettingPhones implements ProfileSetting
 104 {
 105     public function value(ProfilePage &$page, $field, $value, &$success)
 106     {
 107         $success = true;
 108         $phones = array();
 109
 110         if (is_null($value)) {
 111             $it = Phone::iterate(array($page->pid()), array(Phone::LINK_PROFILE), array(0));
 112             while ($phone = $it->next()) {
 113                 $success = ($phone->format() && $success);
 114                 $phones[] = $phone->toFormArray();
 115             }
 116             if (count($phones) == 0) {
 117                 $phone = new Phone();
 118                 $phones[] = $phone->toFormArray();
 119             }
 120             return $phones;
 121         }
 122
 123         return Phone::formatFormArray($value, $success);
 124     }
 125
 126     public function save(ProfilePage &$page, $field, $value)
 127     {
 128         Phone::deletePhones($page->pid(), Phone::LINK_PROFILE);
 129         Phone::savePhones($value, $page->pid(), Phone::LINK_PROFILE);
 130     }
 131
 132     public function getText($value) {
 133         return Phone::formArrayToString($value);
 134     }
 135 }
 136
 137 class ProfileSettingPub extends ProfileNoSave
 138 {
 139     public function value(ProfilePage &$page, $field, $value, &$success)
 140     {
 141         $success = true;
 142         if (is_null($value)) {
 143             return isset($page->values[$field]) ? $page->values[$field] : S::v($field);
 144         }
 145         if (!$value) {
 146             $value = 'private';
 147         } elseif ($value == 'on') { // Checkbox
 148             $value = 'public';
 149         }
 150         return $value;
 151     }
 152
 153     public function getText($value) {
 154         return $value;
 155     }
 156 }
 157
 158 class ProfileSettingBool extends ProfileNoSave
 159 {
 160     public function value(ProfilePage &$page, $field, $value, &$success)
 161     {
 162         $success = true;
 163         if (is_null($value)) {
 164             $value = isset($page->values[$field]) ? $page->values[$field] : null;
 165         }
 166         return $value ? "1" : "";
 167     }
 168 }
 169
 170 class ProfileSettingDate extends ProfileNoSave
 171 {
 172     public function value(ProfilePage &$page, $field, $value, &$success)
 173     {
 174         $success = true;
 175         if (is_null($value)) {
 176             $value = preg_replace('/(\d{4})-(\d{2})-(\d{2})/', '\3/\2/\1', @$page->values[$field]);
 177         } else {
 178             $success = preg_match('@(\d{2})/(\d{2})/(\d{4})@', $value, $matches);
 179             if (!$success) {
 180                 Platal::page()->trigError("Les dates doivent être au format jj/mm/aaaa");
 181            } else {
 182                 $day   = (int)$matches[1];
 183                 $month = (int)$matches[2];
 184                 $year  = (int)$matches[3];
 185                 $success = ($day > 0 && $day <= 31) && ($month > 0 && $month <= 12) && ($year > 1900 && $year <= 2020);
 186                 if (!$success) {
 187                     Platal::page()->trigError("La date n'a pas une valeur valide");
 188                 }
 189             }
 190         }
 191         return $value;
 192     }
 193 }
 194
 195 abstract class ProfileSettingGeocoding implements ProfileSetting
 196 {
 197     protected function geocodeAddress(array &$address, &$success)
 198     {
 199         require_once 'geocoding.inc.php';
 200         $success = true;
 201         if (isset($address['changed']) && $address['changed'] == 1) {
 202             $gmapsGeocoder = new GMapsGeocoder();
 203             $address = $gmapsGeocoder->getGeocodedAddress($address);
 204             if (isset($address['geoloc'])) {
 205                 $success = false;
 206             }
 207         } elseif (@$address['changed'] && !@$address['text']) {
 208             $address = empty_address();
 209             $address['pub'] = 'private';
 210         }
 211         if (isset($address['geoloc_choice']) && ($address['geoloc_choice'] == 0)) {
 212             $mailer = new PlMailer('geoloc/geoloc.mail.tpl');
 213             $mailer->assign('text', $address['text']);
 214             $mailer->assign('geoloc', $address['geoloc']);
 215             $mailer->send();
 216             $gmapsGeocoder = new GMapsGeocoder();
 217             $address = $gmapsGeocoder->stripGeocodingFromAddress($address);
 218         }
 219     }
 220
 221     public function getText($value) {
 222         return $value;
 223     }
 224 }
 225
 226
 227 abstract class ProfilePage implements PlWizardPage
 228 {
 229     protected $wizard;
 230     protected $pg_template;
 231     protected $settings = array();  // A set ProfileSetting objects
 232     protected $errors   = array();  // A set of boolean with the value check errors
 233     protected $changed  = array();  // A set of boolean indicating wether the value has been changed
 234     protected $watched  = array();  // A set of boolean indicating the fields that are watched
 235
 236     public $orig     = array();
 237     public $values   = array();
 238     public $profile  = null;
 239     public $owner    = null;
 240
 241     public function __construct(PlWizard &$wiz)
 242     {
 243         $this->wizard =& $wiz;
 244         $this->profile = $this->wizard->getUserData('profile');
 245         $this->owner   = $this->wizard->getUserData('owner');
 246     }
 247
 248     protected function _fetchData()
 249     {
 250     }
 251
 252     protected function fetchData()
 253     {
 254         if (count($this->orig) > 0) {
 255             $this->values = $this->orig;
 256             return;
 257         }
 258
 259         $this->_fetchData();
 260         foreach ($this->settings as $field=>&$setting) {
 261             $success = false;
 262             if (!is_null($setting)) {
 263                 $this->values[$field] = $setting->value($this, $field, null, $success);
 264             } else if (!isset($this->values[$field])) {
 265                 $this->values[$field] = S::v($field);
 266             }
 267             $this->errors[$field] = false;
 268         }
 269         $this->orig = $this->values;
 270     }
 271
 272     protected function _saveData()
 273     {
 274     }
 275
 276     protected function saveData()
 277     {
 278         require_once 'notifs.inc.php';
 279         $changedFields = array();
 280         foreach ($this->settings as $field=>&$setting) {
 281             if ($this->changed[$field]) {
 282                 if (!is_null($setting)) {
 283                     $changedFields[$field] = array(
 284                         str_replace("\n", " - ", $setting->getText($this->orig[$field])),
 285                         str_replace("\n", " - ", $setting->getText($this->values[$field])),
 286                     );
 287                 } else {
 288                     $changedFields[$field] = array(
 289                         str_replace("\n", " - ", $this->orig[$field]),
 290                         str_replace("\n", " - ", $this->values[$field]),
 291                     );
 292                 }
 293                 if (!is_null($setting)) {
 294                     $setting->save($this, $field, $this->values[$field]);
 295                 }
 296                 if (isset($this->watched[$field]) && $this->watched[$field]) {
 297                     WatchProfileUpdate::register($this->profile, $field);
 298                 }
 299             }
 300         }
 301         $this->_saveData();
 302
 303         // Update the last modification date
 304         XDB::execute('UPDATE  profiles
 305                          SET  last_change = NOW()
 306                        WHERE  pid = {?}', $this->pid());
 307         global $platal;
 308         S::logger()->log('profil', $platal->pl_self(2));
 309
 310         /** If the update was made by a third party and the profile corresponds
 311          * to a registered user, stores both former and new text.
 312          * This will be daily sent to the user.
 313          */
 314         $owner = $this->profile->owner();
 315         $user = S::user();
 316         if ($owner->isActive() && $owner->id() != $user->id()) {
 317             foreach ($changedFields as $field => $values) {
 318                 XDB::execute('REPLACE INTO  profile_modifications (pid, uid, field, oldText, newText)
 319                                     VALUES  ({?}, {?}, {?}, {?}, {?})',
 320                              $this->pid(), $user->id(), $field, $values[0], $values[1]);
 321             }
 322         }
 323     }
 324
 325     protected function checkChanges()
 326     {
 327         $newvalues = $this->values;
 328         $this->values = array();
 329         $this->fetchData();
 330         $this->values = $newvalues;
 331         $changes = false;
 332         foreach ($this->settings as $field=>&$setting) {
 333             if ($this->orig[$field] != $this->values[$field]) {
 334                 $this->changed[$field] = true;
 335                 $changes = true;
 336             } else {
 337                 $this->changed[$field] = false;
 338             }
 339         }
 340         return $changes;
 341     }
 342
 343     protected function markChange()
 344     {
 345     }
 346
 347     public function template()
 348     {
 349         return 'profile/base.tpl';
 350     }
 351
 352     public function pid()
 353     {
 354         return $this->profile->id();
 355     }
 356
 357     public function hrpid()
 358     {
 359         return $this->profile->hrpid();
 360     }
 361
 362     protected function _prepare(PlPage &$page, $id)
 363     {
 364     }
 365
 366     public function prepare(PlPage &$page, $id)
 367     {
 368         if (count($this->values) == 0) {
 369             $this->fetchData();
 370         }
 371         foreach ($this->values as $field=>&$value) {
 372             $page->assign($field, $value);
 373         }
 374         $this->_prepare($page, $id);
 375         $page->assign('profile', $this->profile);
 376         $page->assign('owner', $this->owner);
 377         $page->assign('profile_page', $this->pg_template);
 378         $page->assign('errors', $this->errors);
 379     }
 380
 381     public function process(&$global_success)
 382     {
 383         $global_success = true;
 384         $this->fetchData();
 385         foreach ($this->settings as $field=>&$setting) {
 386             $success = false;
 387             if (!is_null($setting)) {
 388                 $this->values[$field] = $setting->value($this, $field, Post::v($field, ''), $success);
 389             } else {
 390                 $success = true;
 391                 $this->values[$field] = Post::v($field, '');
 392             }
 393             $this->errors[$field] = !$success;
 394             $global_success = $global_success && $success;
 395         }
 396         if ($global_success) {
 397             if ($this->checkChanges()) {
 398                 $this->saveData();
 399                 $this->markChange();
 400             }
 401             return Post::has('next_page') ? PlWizard::NEXT_PAGE : PlWizard::CURRENT_PAGE;
 402         }
 403         Platal::page()->trigError("Certains champs n'ont pas pu être validés, merci de corriger les informations "
 404                                 . "de ton profil et de revalider ta demande.");
 405         return PlWizard::CURRENT_PAGE;
 406     }
 407
 408     public function success()
 409     {
 410         return 'Ton profil a bien été mis à jour.';
 411     }
 412 }
 413
 414 require_once dirname(__FILE__) . '/general.inc.php';
 415 require_once dirname(__FILE__) . '/addresses.inc.php';
 416 require_once dirname(__FILE__) . '/groups.inc.php';
 417 require_once dirname(__FILE__) . '/decos.inc.php';
 418 require_once dirname(__FILE__) . '/jobs.inc.php';
 419 require_once dirname(__FILE__) . '/skills.inc.php';
 420 require_once dirname(__FILE__) . '/mentor.inc.php';
 421
 422 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
 423 ?>