[Summary view] [Print] [Text view]

   1  <?php
   2  // This file is part of Moodle - http://moodle.org/
   3  //
   4  // Moodle is free software: you can redistribute it and/or modify
   5  // it under the terms of the GNU General Public License as published by
   6  // the Free Software Foundation, either version 3 of the License, or
   7  // (at your option) any later version.
   8  //
   9  // Moodle is distributed in the hope that it will be useful,
  10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  // GNU General Public License for more details.
  13  //
  14  // You should have received a copy of the GNU General Public License
  15  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16  
  17  /**
  18   * Form for editing a users profile
  19   *
  20   * @copyright 1999 Martin Dougiamas  http://dougiamas.com
  21   * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  22   * @package core_user
  23   */
  24  
  25  if (!defined('MOODLE_INTERNAL')) {
  26      die('Direct access to this script is forbidden.');    //  It must be included from a Moodle page.
  27  }
  28  
  29  require_once($CFG->dirroot.'/lib/formslib.php');
  30  
  31  /**
  32   * Class user_editadvanced_form.
  33   *
  34   * @copyright 1999 Martin Dougiamas  http://dougiamas.com
  35   * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  36   */
  37  class user_editadvanced_form extends moodleform {
  38  
  39      /**
  40       * Define the form.
  41       */
  42      public function definition() {
  43          global $USER, $CFG, $COURSE;
  44  
  45          $mform = $this->_form;
  46          $editoroptions = null;
  47          $filemanageroptions = null;
  48  
  49          if (!is_array($this->_customdata)) {
  50              throw new coding_exception('invalid custom data for user_edit_form');
  51          }
  52          $editoroptions = $this->_customdata['editoroptions'];
  53          $filemanageroptions = $this->_customdata['filemanageroptions'];
  54          $user = $this->_customdata['user'];
  55          $userid = $user->id;
  56  
  57          // Accessibility: "Required" is bad legend text.
  58          $strgeneral  = get_string('general');
  59          $strrequired = get_string('required');
  60  
  61          // Add some extra hidden fields.
  62          $mform->addElement('hidden', 'id');
  63          $mform->setType('id', core_user::get_property_type('id'));
  64          $mform->addElement('hidden', 'course', $COURSE->id);
  65          $mform->setType('course', PARAM_INT);
  66  
  67          // Print the required moodle fields first.
  68          $mform->addElement('header', 'moodle', $strgeneral);
  69  
  70          $auths = core_component::get_plugin_list('auth');
  71          $enabled = get_string('pluginenabled', 'core_plugin');
  72          $disabled = get_string('plugindisabled', 'core_plugin');
  73          $authoptions = array($enabled => array(), $disabled => array());
  74          $cannotchangepass = array();
  75          $cannotchangeusername = array();
  76          foreach ($auths as $auth => $unused) {
  77              $authinst = get_auth_plugin($auth);
  78  
  79              if (!$authinst->is_internal()) {
  80                  $cannotchangeusername[] = $auth;
  81              }
  82  
  83              $passwordurl = $authinst->change_password_url();
  84              if (!($authinst->can_change_password() && empty($passwordurl))) {
  85                  if ($userid < 1 and $authinst->is_internal()) {
  86                      // This is unlikely but we can not create account without password
  87                      // when plugin uses passwords, we need to set it initially at least.
  88                  } else {
  89                      $cannotchangepass[] = $auth;
  90                  }
  91              }
  92              if (is_enabled_auth($auth)) {
  93                  $authoptions[$enabled][$auth] = get_string('pluginname', "auth_{$auth}");
  94              } else {
  95                  $authoptions[$disabled][$auth] = get_string('pluginname', "auth_{$auth}");
  96              }
  97          }
  98  
  99          $mform->addElement('text', 'username', get_string('username'), 'size="20"');
 100          $mform->addHelpButton('username', 'username', 'auth');
 101          $mform->setType('username', core_user::get_property_type('username'));
 102  
 103          if ($userid !== -1) {
 104              $mform->disabledIf('username', 'auth', 'in', $cannotchangeusername);
 105          }
 106  
 107          $mform->addElement('selectgroups', 'auth', get_string('chooseauthmethod', 'auth'), $authoptions);
 108          $mform->addHelpButton('auth', 'chooseauthmethod', 'auth');
 109  
 110          $mform->addElement('advcheckbox', 'suspended', get_string('suspended', 'auth'));
 111          $mform->addHelpButton('suspended', 'suspended', 'auth');
 112  
 113          $mform->addElement('checkbox', 'createpassword', get_string('createpassword', 'auth'));
 114          $mform->disabledIf('createpassword', 'auth', 'in', $cannotchangepass);
 115  
 116          if (!empty($CFG->passwordpolicy)) {
 117              $mform->addElement('static', 'passwordpolicyinfo', '', print_password_policy());
 118          }
 119          $mform->addElement('passwordunmask', 'newpassword', get_string('newpassword'), 'size="20"');
 120          $mform->addHelpButton('newpassword', 'newpassword');
 121          $mform->setType('newpassword', core_user::get_property_type('password'));
 122          $mform->disabledIf('newpassword', 'createpassword', 'checked');
 123  
 124          $mform->disabledIf('newpassword', 'auth', 'in', $cannotchangepass);
 125  
 126          $mform->addElement('advcheckbox', 'preference_auth_forcepasswordchange', get_string('forcepasswordchange'));
 127          $mform->addHelpButton('preference_auth_forcepasswordchange', 'forcepasswordchange');
 128          $mform->disabledIf('preference_auth_forcepasswordchange', 'createpassword', 'checked');
 129  
 130          // Shared fields.
 131          useredit_shared_definition($mform, $editoroptions, $filemanageroptions, $user);
 132  
 133          // Next the customisable profile fields.
 134          profile_definition($mform, $userid);
 135  
 136          if ($userid == -1) {
 137              $btnstring = get_string('createuser');
 138          } else {
 139              $btnstring = get_string('updatemyprofile');
 140          }
 141  
 142          $this->add_action_buttons(false, $btnstring);
 143  
 144          $this->set_data($user);
 145      }
 146  
 147      /**
 148       * Extend the form definition after data has been parsed.
 149       */
 150      public function definition_after_data() {
 151          global $USER, $CFG, $DB, $OUTPUT;
 152  
 153          $mform = $this->_form;
 154  
 155          // Trim required name fields.
 156          foreach (useredit_get_required_name_fields() as $field) {
 157              $mform->applyFilter($field, 'trim');
 158          }
 159  
 160          if ($userid = $mform->getElementValue('id')) {
 161              $user = $DB->get_record('user', array('id' => $userid));
 162          } else {
 163              $user = false;
 164          }
 165  
 166          // User can not change own auth method.
 167          if ($userid == $USER->id) {
 168              $mform->hardFreeze('auth');
 169              $mform->hardFreeze('preference_auth_forcepasswordchange');
 170          }
 171  
 172          // Admin must choose some password and supply correct email.
 173          if (!empty($USER->newadminuser)) {
 174              $mform->addRule('newpassword', get_string('required'), 'required', null, 'client');
 175              if ($mform->elementExists('suspended')) {
 176                  $mform->removeElement('suspended');
 177              }
 178          }
 179  
 180          // Require password for new users.
 181          if ($userid > 0) {
 182              if ($mform->elementExists('createpassword')) {
 183                  $mform->removeElement('createpassword');
 184              }
 185          }
 186  
 187          if ($user and is_mnet_remote_user($user)) {
 188              // Only local accounts can be suspended.
 189              if ($mform->elementExists('suspended')) {
 190                  $mform->removeElement('suspended');
 191              }
 192          }
 193          if ($user and ($user->id == $USER->id or is_siteadmin($user))) {
 194              // Prevent self and admin mess ups.
 195              if ($mform->elementExists('suspended')) {
 196                  $mform->hardFreeze('suspended');
 197              }
 198          }
 199  
 200          // Print picture.
 201          if (empty($USER->newadminuser)) {
 202              if ($user) {
 203                  $context = context_user::instance($user->id, MUST_EXIST);
 204                  $fs = get_file_storage();
 205                  $hasuploadedpicture = ($fs->file_exists($context->id, 'user', 'icon', 0, '/', 'f2.png') || $fs->file_exists($context->id, 'user', 'icon', 0, '/', 'f2.jpg'));
 206                  if (!empty($user->picture) && $hasuploadedpicture) {
 207                      $imagevalue = $OUTPUT->user_picture($user, array('courseid' => SITEID, 'size' => 64));
 208                  } else {
 209                      $imagevalue = get_string('none');
 210                  }
 211              } else {
 212                  $imagevalue = get_string('none');
 213              }
 214              $imageelement = $mform->getElement('currentpicture');
 215              $imageelement->setValue($imagevalue);
 216  
 217              if ($user && $mform->elementExists('deletepicture') && !$hasuploadedpicture) {
 218                  $mform->removeElement('deletepicture');
 219              }
 220          }
 221  
 222          // Next the customisable profile fields.
 223          profile_definition_after_data($mform, $userid);
 224      }
 225  
 226      /**
 227       * Validate the form data.
 228       * @param array $usernew
 229       * @param array $files
 230       * @return array|bool
 231       */
 232      public function validation($usernew, $files) {
 233          global $CFG, $DB;
 234  
 235          $usernew = (object)$usernew;
 236          $usernew->username = trim($usernew->username);
 237  
 238          $user = $DB->get_record('user', array('id' => $usernew->id));
 239          $err = array();
 240  
 241          if (!$user and !empty($usernew->createpassword)) {
 242              if ($usernew->suspended) {
 243                  // Show some error because we can not mail suspended users.
 244                  $err['suspended'] = get_string('error');
 245              }
 246          } else {
 247              if (!empty($usernew->newpassword)) {
 248                  $errmsg = ''; // Prevent eclipse warning.
 249                  if (!check_password_policy($usernew->newpassword, $errmsg)) {
 250                      $err['newpassword'] = $errmsg;
 251                  }
 252              } else if (!$user) {
 253                  $auth = get_auth_plugin($usernew->auth);
 254                  if ($auth->is_internal()) {
 255                      // Internal accounts require password!
 256                      $err['newpassword'] = get_string('required');
 257                  }
 258              }
 259          }
 260  
 261          if (empty($usernew->username)) {
 262              // Might be only whitespace.
 263              $err['username'] = get_string('required');
 264          } else if (!$user or $user->username !== $usernew->username) {
 265              // Check new username does not exist.
 266              if ($DB->record_exists('user', array('username' => $usernew->username, 'mnethostid' => $CFG->mnet_localhost_id))) {
 267                  $err['username'] = get_string('usernameexists');
 268              }
 269              // Check allowed characters.
 270              if ($usernew->username !== core_text::strtolower($usernew->username)) {
 271                  $err['username'] = get_string('usernamelowercase');
 272              } else {
 273                  if ($usernew->username !== core_user::clean_field($usernew->username, 'username')) {
 274                      $err['username'] = get_string('invalidusername');
 275                  }
 276              }
 277          }
 278  
 279          if (!$user or (isset($usernew->email) && $user->email !== $usernew->email)) {
 280              if (!validate_email($usernew->email)) {
 281                  $err['email'] = get_string('invalidemail');
 282              } else if (empty($CFG->allowaccountssameemail)
 283                      and $DB->record_exists('user', array('email' => $usernew->email, 'mnethostid' => $CFG->mnet_localhost_id))) {
 284                  $err['email'] = get_string('emailexists');
 285              }
 286          }
 287  
 288          // Next the customisable profile fields.
 289          $err += profile_validation($usernew, $files);
 290  
 291          if (count($err) == 0) {
 292              return true;
 293          } else {
 294              return $err;
 295          }
 296      }
 297  }
 298  
 299