[Summary view]

Differences Between: [Versions 310 and 403] [Versions 311 and 403] [Versions 39 and 403] [Versions 400 and 403] [Versions 401 and 403] [Versions 402 and 403]

   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   * External backpack form
  19   *
  20   * @package    core_badges
  21   * @copyright  2019 Damyon Wiese
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core_badges\form;
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  require_once($CFG->libdir.'/formslib.php');
  29  
  30  /**
  31   * Backpack form class.
  32   *
  33   * @package    core_badges
  34   * @copyright  2019 Damyon Wiese
  35   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  36   */
  37  class external_backpack extends \moodleform {
  38  
  39      /**
  40       * Create the form.
  41       *
  42       */
  43      public function definition() {
  44          global $CFG;
  45  
  46          $mform = $this->_form;
  47          $backpack = false;
  48  
  49          if (isset($this->_customdata['externalbackpack'])) {
  50              $backpack = $this->_customdata['externalbackpack'];
  51          }
  52  
  53          $mform->addElement('hidden', 'action', 'edit');
  54          $mform->setType('action', PARAM_ALPHA);
  55  
  56          $apiversions = badges_get_badge_api_versions();
  57          $mform->addElement('select', 'apiversion', get_string('apiversion', 'core_badges'), $apiversions);
  58          $mform->setType('apiversion', PARAM_RAW);
  59          $mform->setDefault('apiversion', OPEN_BADGES_V2P1);
  60          $mform->addRule('apiversion', null, 'required', null, 'client');
  61  
  62          $mform->addElement('text', 'backpackweburl', get_string('backpackweburl', 'core_badges'));
  63          $mform->setType('backpackweburl', PARAM_URL);
  64          $mform->addRule('backpackweburl', null, 'required', null, 'client');
  65          $mform->addRule('backpackweburl', get_string('maximumchars', '', 255), 'maxlength', 255, 'client');
  66  
  67          $mform->addElement('text', 'backpackapiurl',  get_string('backpackapiurl', 'core_badges'));
  68          $mform->setType('backpackapiurl', PARAM_URL);
  69          $mform->addRule('backpackapiurl', get_string('maximumchars', '', 255), 'maxlength', 255, 'client');
  70  
  71          $mform->addElement('hidden', 'id', ($backpack->id ?? null));
  72          $mform->setType('id', PARAM_INT);
  73          $mform->addElement('hidden', 'badgebackpack', 0);
  74          $mform->setType('badgebackpack', PARAM_INT);
  75          $mform->addElement('hidden', 'userid', 0);
  76          $mform->setType('userid', PARAM_INT);
  77          $mform->addElement('hidden', 'backpackuid', 0);
  78          $mform->setType('backpackuid', PARAM_INT);
  79  
  80          $mform->addElement('advcheckbox', 'includeauthdetails', null, get_string('includeauthdetails', 'core_badges'));
  81          if (!empty($backpack->backpackemail) || !empty($backpack->password)) {
  82              $mform->setDefault('includeauthdetails', 1);
  83          }
  84  
  85          $issuercontact = $CFG->badges_defaultissuercontact;
  86          $this->add_auth_fields($issuercontact);
  87  
  88          if ($backpack) {
  89              $this->set_data($backpack);
  90          }
  91  
  92          $mform->hideIf('includeauthdetails', 'apiversion', 'in', [OPEN_BADGES_V2P1]);
  93          $mform->hideIf('backpackemail', 'includeauthdetails');
  94          $mform->hideIf('backpackemail', 'apiversion', 'in', [OPEN_BADGES_V2P1]);
  95          $mform->hideIf('password', 'includeauthdetails');
  96          $mform->hideIf('password', 'apiversion', 'in', [OPEN_BADGES_V1, OPEN_BADGES_V2P1]);
  97          $mform->hideIf('backpackapiurl', 'apiversion', 'in', [OPEN_BADGES_V1, OPEN_BADGES_V2P1]);
  98  
  99          // Disable short forms.
 100          $mform->setDisableShortforms();
 101  
 102          $this->add_action_buttons();
 103      }
 104  
 105      /**
 106       * Validate the data from the form.
 107       *
 108       * @param  array $data form data
 109       * @param  array $files form files
 110       * @return array An array of error messages.
 111       */
 112      public function validation($data, $files) {
 113          $errors = parent::validation($data, $files);
 114  
 115          // Ensure backpackapiurl and backpackweburl are valid URLs.
 116          $isobv21 = isset($data['apiversion']) && $data['apiversion'] == OPEN_BADGES_V2P1;
 117          if (!$isobv21) {
 118              if (empty($data['backpackapiurl'])) {
 119                  $errors['backpackapiurl'] = get_string('err_required', 'form');
 120              } else if (!preg_match('@^https?://.+@', $data['backpackapiurl'])) {
 121                  $errors['backpackapiurl'] = get_string('invalidurl', 'badges');
 122              }
 123          }
 124          if (!empty($data['backpackweburl']) && !preg_match('@^https?://.+@', $data['backpackweburl'])) {
 125              $errors['backpackweburl'] = get_string('invalidurl', 'badges');
 126          }
 127  
 128          return $errors;
 129      }
 130  
 131      /**
 132       * Return submitted data if properly submitted or returns NULL if validation fails or
 133       * if there is no submitted data.
 134       *
 135       * @return object|void
 136       */
 137      public function get_data() {
 138          $data = parent::get_data();
 139          if ($data ) {
 140              if ((isset($data->includeauthdetails) && !$data->includeauthdetails)
 141                  || (isset($data->apiversion) && $data->apiversion == 2.1)) {
 142                  $data->backpackemail = "";
 143                  $data->password = "";
 144              }
 145  
 146              if ((isset($data->apiversion) && $data->apiversion == 1)) {
 147                  $data->password = "";
 148              }
 149          }
 150  
 151          return $data;
 152      }
 153  
 154      /**
 155       * Add backpack specific auth details.
 156       *
 157       * @param string|null $email The email addressed provided or null if it's new.
 158       * @param bool $includepassword Include the password field. Defaults to true
 159       * @throws \coding_exception
 160       */
 161      protected function add_auth_fields(?string $email, bool $includepassword = true) {
 162          $mform = $this->_form;
 163          $emailstring = get_string('email');
 164          $passwordstring = get_string('password');
 165          $showpasswordhelp = false;
 166          if (!isset($this->_customdata['userbackpack'])) {
 167              $emailstring = get_string('defaultissuercontact', 'core_badges');
 168              $passwordstring = get_string('defaultissuerpassword', 'core_badges');
 169              $showpasswordhelp = true;
 170          }
 171  
 172          $mform->addElement('text', 'backpackemail', $emailstring);
 173          $mform->setType('backpackemail', PARAM_EMAIL);
 174          $mform->setDefault('backpackemail', $email);
 175  
 176          if ($includepassword) {
 177              $mform->addElement('passwordunmask', 'password', $passwordstring);
 178              $mform->setType('password', PARAM_RAW);
 179              if ($showpasswordhelp) {
 180                  $mform->addHelpButton('password', 'defaultissuerpassword', 'badges');
 181              }
 182          }
 183      }
 184  }