modules/profile/page.inc.php

   1 <?php
   2 /***************************************************************************
   3  *  Copyright (C) 2003-2014 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), Visibility::get(Visibility::VIEW_ADMIN));
 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         } else {
 122             $phones = Phone::formatFormArray($value, $success);
 123             if (!$success) {
 124                 Platal::page()->trigError('Numéro de téléphone invalide');
 125             }
 126             return $phones;
 127         }
 128     }
 129
 130     public function save(ProfilePage $page, $field, $value)
 131     {
 132         Phone::deletePhones($page->pid(), Phone::LINK_PROFILE, null, S::user()->isMe($page->owner) || S::admin());
 133         Phone::savePhones($value, $page->pid(), Phone::LINK_PROFILE);
 134     }
 135
 136     public function getText($value)
 137     {
 138         return Phone::formArrayToString($value);
 139     }
 140 }
 141
 142 class ProfileSettingPub extends ProfileNoSave
 143 {
 144     public function value(ProfilePage $page, $field, $value, &$success)
 145     {
 146         $success = true;
 147         if (is_null($value)) {
 148             return isset($page->values[$field]) ? $page->values[$field] : S::v($field);
 149         }
 150         if (!$value) {
 151             $value = 'private';
 152         } elseif ($value == 'on') { // Checkbox
 153             $value = 'public';
 154         }
 155         return $value;
 156     }
 157
 158     public function getText($value) {
 159         static $pubs = array('public' => 'publique', 'ax' => 'annuaire AX', 'private' => 'privé');
 160         return $pubs[$value];
 161     }
 162 }
 163
 164 class ProfileSettingBool extends ProfileNoSave
 165 {
 166     public function value(ProfilePage $page, $field, $value, &$success)
 167     {
 168         $success = true;
 169         if (is_null($value)) {
 170             $value = isset($page->values[$field]) ? $page->values[$field] : null;
 171         }
 172         return $value ? "1" : "";
 173     }
 174 }
 175
 176 class ProfileSettingDate extends ProfileNoSave
 177 {
 178     private $allowEmpty;
 179
 180     public function __construct($allowEmpty = false)
 181     {
 182         $this->allowEmpty = $allowEmpty;
 183     }
 184
 185     public function value(ProfilePage $page, $field, $value, &$success)
 186     {
 187         $success = true;
 188         if (is_null($value)) {
 189             $value = preg_replace('/(\d{4})-(\d{2})-(\d{2})/', '\3/\2/\1', @$page->values[$field]);
 190         } else {
 191             $value = trim($value);
 192             if (empty($value) && $this->allowEmpty) {
 193                 return null;
 194             }
 195             $success = preg_match('@(\d{2})/(\d{2})/(\d{4})@', $value, $matches);
 196             if (!$success) {
 197                 Platal::page()->trigError("Les dates doivent être au format jj/mm/aaaa");
 198             } else {
 199                 $day   = (int)$matches[1];
 200                 $month = (int)$matches[2];
 201                 $year  = (int)$matches[3];
 202                 $success = ($day > 0 && $day <= 31) && ($month > 0 && $month <= 12) && ($year > 1900 && $year <= 2020);
 203                 if (!$success) {
 204                     Platal::page()->trigError("La date n'a pas une valeur valide");
 205                 }
 206             }
 207         }
 208         return $value;
 209     }
 210
 211     public static function toSQLDate($value)
 212     {
 213         return preg_replace('@(\d{2})/(\d{2})/(\d{4})@', '\3-\2-\1', $value);
 214     }
 215 }
 216
 217 abstract class ProfilePage implements PlWizardPage
 218 {
 219     protected $wizard;
 220     protected $pg_template;
 221     protected $settings = array();  // A set ProfileSetting objects
 222     protected $errors   = array();  // A set of boolean with the value check errors
 223     protected $changed  = array();  // A set of boolean indicating wether the value has been changed
 224     protected $watched  = array();  // A set of boolean indicating the fields that are watched
 225
 226     public $orig     = array();
 227     public $values   = array();
 228     public $profile  = null;
 229     public $owner    = null;
 230
 231     public function __construct(PlWizard $wiz)
 232     {
 233         $this->wizard =& $wiz;
 234         $this->profile = $this->wizard->getUserData('profile');
 235         $this->owner   = $this->wizard->getUserData('owner');
 236     }
 237
 238     protected function _fetchData()
 239     {
 240     }
 241
 242     protected function fetchData()
 243     {
 244         if (count($this->orig) > 0) {
 245             $this->values = $this->orig;
 246             return;
 247         }
 248
 249         $this->_fetchData();
 250         foreach ($this->settings as $field=>&$setting) {
 251             $success = false;
 252             if (!is_null($setting)) {
 253                 $this->values[$field] = $setting->value($this, $field, null, $success);
 254             } else if (!isset($this->values[$field])) {
 255                 $this->values[$field] = S::v($field);
 256             }
 257             $this->errors[$field] = false;
 258         }
 259         $this->orig = $this->values;
 260     }
 261
 262     protected function _saveData()
 263     {
 264     }
 265
 266     public function saveData()
 267     {
 268         require_once 'notifs.inc.php';
 269         $changedFields = array();
 270         foreach ($this->settings as $field=>&$setting) {
 271             if ($this->changed[$field]) {
 272                 if (!is_null($setting)) {
 273                     $changedFields[$field] = array(
 274                         preg_replace('/(\r\n|\n|\r)/', ' - ', $setting->getText($this->orig[$field])),
 275                         preg_replace('/(\r\n|\n|\r)/', ' - ', $setting->getText($this->values[$field])),
 276                     );
 277                 } else {
 278                     $changedFields[$field] = array(
 279                         preg_replace('/(\r\n|\n|\r)/', ' - ', $this->orig[$field]),
 280                         preg_replace('/(\r\n|\n|\r)/', ' - ', $this->values[$field]),
 281                     );
 282                 }
 283                 if (!is_null($setting)) {
 284                     $setting->save($this, $field, $this->values[$field]);
 285                 }
 286                 if (isset($this->watched[$field]) && $this->watched[$field]) {
 287                     WatchProfileUpdate::register($this->profile, $field);
 288                 }
 289             }
 290         }
 291         $this->_saveData();
 292
 293         // Update the last modification date
 294         XDB::execute('UPDATE  profiles
 295                          SET  last_change = NOW()
 296                        WHERE  pid = {?}', $this->pid());
 297         global $platal;
 298         S::logger()->log('profil', $platal->pl_self(2));
 299
 300         /** Stores all profile modifications for active users in order to:
 301          *  -daily notify the user in case of third party edition,
 302          *  -display the modification to the secretaries for verification in
 303          *  case of an edition made by the user.
 304          */
 305         $owner = $this->profile->owner();
 306         $user = S::user();
 307         if ($owner->isActive()) {
 308             foreach ($changedFields as $field => $values) {
 309                 if (in_array($field, Profile::$descriptions)) {
 310                     XDB::execute('INSERT INTO  profile_modifications (pid, uid, field, oldText, newText, type, timestamp)
 311                                        VALUES  ({?}, {?}, {?}, {?}, {?}, {?}, NOW())
 312                       ON DUPLICATE KEY UPDATE  uid = VALUES(uid), oldText = IF(VALUES(type) != type, VALUES(oldText), oldText),
 313                                                newText = VALUES(newText), type = VALUES(type), timestamp = NOW()',
 314                                  $this->pid(), $user->id(), Profile::$descriptions[$field], $values[0], $values[1],
 315                                  ($owner->id() == $user->id()) ? 'self' : 'third_party');
 316                 }
 317             }
 318         }
 319         return true;
 320     }
 321
 322     protected function checkChanges()
 323     {
 324         $newvalues = $this->values;
 325         $this->values = array();
 326         $this->fetchData();
 327         $this->values = $newvalues;
 328         $changes = false;
 329         foreach ($this->settings as $field=>&$setting) {
 330             if ($this->orig[$field] != $this->values[$field]) {
 331                 $this->changed[$field] = true;
 332                 $changes = true;
 333             } else {
 334                 $this->changed[$field] = false;
 335             }
 336         }
 337         return $changes;
 338     }
 339
 340     protected function markChange()
 341     {
 342     }
 343
 344     public function template()
 345     {
 346         return 'profile/base.tpl';
 347     }
 348
 349     public function pid()
 350     {
 351         return $this->profile->id();
 352     }
 353
 354     public function hrpid()
 355     {
 356         return $this->profile->hrpid();
 357     }
 358
 359     protected function _prepare(PlPage $page, $id)
 360     {
 361     }
 362
 363     public function prepare(PlPage $page, $id)
 364     {
 365         if (count($this->values) == 0) {
 366             $this->fetchData();
 367         }
 368         foreach ($this->values as $field=>&$value) {
 369             $page->assign($field, $value);
 370         }
 371         $this->_prepare($page, $id);
 372         $page->assign('profile', $this->profile);
 373         $page->assign('owner', $this->owner);
 374         $page->assign('profile_page', $this->pg_template);
 375         $page->assign('errors', $this->errors);
 376     }
 377
 378     public function process(&$global_success)
 379     {
 380         $global_success = true;
 381         $this->fetchData();
 382         foreach ($this->settings as $field=>&$setting) {
 383             $success = false;
 384             if (!is_null($setting)) {
 385                 $this->values[$field] = $setting->value($this, $field, Post::v($field, ''), $success);
 386             } else {
 387                 $success = true;
 388                 $this->values[$field] = Post::v($field, '');
 389             }
 390             $this->errors[$field] = !$success;
 391             $global_success = $global_success && $success;
 392         }
 393         if ($global_success) {
 394             if ($this->checkChanges()) {
 395                 /* Save changes atomically to avoid inconsistent state
 396                  * in case of error.
 397                  */
 398                 if (!XDB::runTransaction(array($this, 'saveData'))) {
 399                     $global_success = false;
 400                     return PlWizard::CURRENT_PAGE;
 401                 }
 402                 $this->markChange();
 403             }
 404             // XXX: removes this code once all merge related issues have been fixed.
 405             static $issues = array(0 => array('name', 'promo', 'phone', 'education'), 1 => array('address'), 2 => array('job'));
 406             if (isset($issues[Post::i('valid_page')])) {
 407                 foreach ($issues[Post::i('valid_page')] as $issue) {
 408                     XDB::execute("UPDATE  profile_merge_issues
 409                                      SET  issues = REPLACE(issues, {?}, '')
 410                                    WHERE  pid = {?}",
 411                                  $issue, $this->pid());
 412                 }
 413             }
 414             return Post::has('next_page') ? PlWizard::NEXT_PAGE : PlWizard::CURRENT_PAGE;
 415         }
 416         $text = "Certains champs n'ont pas pu être validés, merci de corriger les informations "
 417               . (S::user()->isMe($this->owner) ? "de ton profil et de revalider ta demande."
 418                                                : "du profil et de revalider ta demande.");
 419         Platal::page()->trigError($text);
 420         return PlWizard::CURRENT_PAGE;
 421     }
 422
 423     public function success()
 424     {
 425         if (S::user()->isMe($this->owner)) {
 426             return 'Ton profil a bien été mis à jour.';
 427         } else {
 428             return 'Le profil a bien été mis à jour.';
 429         }
 430     }
 431 }
 432
 433 require_once dirname(__FILE__) . '/general.inc.php';
 434 require_once dirname(__FILE__) . '/addresses.inc.php';
 435 require_once dirname(__FILE__) . '/groups.inc.php';
 436 require_once dirname(__FILE__) . '/decos.inc.php';
 437 require_once dirname(__FILE__) . '/jobs.inc.php';
 438 require_once dirname(__FILE__) . '/mentor.inc.php';
 439 require_once dirname(__FILE__) . '/deltaten.inc.php';
 440
 441 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker fenc=utf-8:
 442 ?>