Proyectos de Subversion Moodle

<?php

// This file is part of Moodle - http://moodle.org/

//

// Moodle is free software: you can redistribute it and/or modify

// it under the terms of the GNU General Public License as published by

// the Free Software Foundation, either version 3 of the License, or

// (at your option) any later version.

//

// Moodle is distributed in the hope that it will be useful,

// but WITHOUT ANY WARRANTY; without even the implied warranty of

// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

// GNU General Public License for more details.

//

// You should have received a copy of the GNU General Public License

// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**

 * External backpack form

 *

 * @package    core_badges

 * @copyright  2019 Damyon Wiese

 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

 */

namespace core_badges\form;

defined('MOODLE_INTERNAL') || die();

require_once($CFG->libdir.'/formslib.php');

/**

 * Backpack form class.

 *

 * @package    core_badges

 * @copyright  2019 Damyon Wiese

 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

 */

class external_backpack extends \moodleform {

    /**

     * Create the form.

     *

     */

    public function definition() {

        global $CFG;

        $mform = $this->_form;

        $backpack = false;

        if (isset($this->_customdata['externalbackpack'])) {

            $backpack = $this->_customdata['externalbackpack'];

        }

        $mform->addElement('hidden', 'action', 'edit');

        $mform->setType('action', PARAM_ALPHA);

        $apiversions = badges_get_badge_api_versions();

        $mform->addElement('select', 'apiversion', get_string('apiversion', 'core_badges'), $apiversions);

        $mform->setType('apiversion', PARAM_RAW);

        $mform->setDefault('apiversion', OPEN_BADGES_V2P1);

        $mform->addRule('apiversion', null, 'required', null, 'client');

        $mform->addElement('text', 'backpackweburl', get_string('backpackweburl', 'core_badges'));

        $mform->setType('backpackweburl', PARAM_URL);

        $mform->addRule('backpackweburl', null, 'required', null, 'client');

        $mform->addRule('backpackweburl', get_string('maximumchars', '', 255), 'maxlength', 255, 'client');

        $mform->addElement('text', 'backpackapiurl',  get_string('backpackapiurl', 'core_badges'));

        $mform->setType('backpackapiurl', PARAM_URL);

        $mform->addRule('backpackapiurl', get_string('maximumchars', '', 255), 'maxlength', 255, 'client');

        $mform->addElement('hidden', 'id', ($backpack->id ?? null));

        $mform->setType('id', PARAM_INT);

        $mform->addElement('hidden', 'badgebackpack', 0);

        $mform->setType('badgebackpack', PARAM_INT);

        $mform->addElement('hidden', 'userid', 0);

        $mform->setType('userid', PARAM_INT);

        $mform->addElement('hidden', 'backpackuid', 0);

        $mform->setType('backpackuid', PARAM_INT);

        $mform->addElement('advcheckbox', 'includeauthdetails', null, get_string('includeauthdetails', 'core_badges'));

        if (!empty($backpack->backpackemail) || !empty($backpack->password)) {

            $mform->setDefault('includeauthdetails', 1);

        }

        $issuercontact = $CFG->badges_defaultissuercontact;

        $this->add_auth_fields($issuercontact);

        if ($backpack) {

            $this->set_data($backpack);

        }

        $mform->hideIf('includeauthdetails', 'apiversion', 'in', [OPEN_BADGES_V2P1]);

        $mform->hideIf('backpackemail', 'includeauthdetails');

        $mform->hideIf('backpackemail', 'apiversion', 'in', [OPEN_BADGES_V2P1]);

        $mform->hideIf('password', 'includeauthdetails');

        $mform->hideIf('password', 'apiversion', 'in', [OPEN_BADGES_V1, OPEN_BADGES_V2P1]);

        $mform->hideIf('backpackapiurl', 'apiversion', 'in', [OPEN_BADGES_V1, OPEN_BADGES_V2P1]);

        // Disable short forms.

        $mform->setDisableShortforms();

        $this->add_action_buttons();

    }

    /**

     * Validate the data from the form.

     *

     * @param  array $data form data

     * @param  array $files form files

     * @return array An array of error messages.

     */

    public function validation($data, $files) {

        $errors = parent::validation($data, $files);

        // Ensure backpackapiurl and backpackweburl are valid URLs.

        $isobv21 = isset($data['apiversion']) && $data['apiversion'] == OPEN_BADGES_V2P1;

        if (!$isobv21) {

            if (empty($data['backpackapiurl'])) {

                $errors['backpackapiurl'] = get_string('err_required', 'form');

            } else if (!preg_match('@^https?://.+@', $data['backpackapiurl'])) {

                $errors['backpackapiurl'] = get_string('invalidurl', 'badges');

            }

        }

        if (!empty($data['backpackweburl']) && !preg_match('@^https?://.+@', $data['backpackweburl'])) {

            $errors['backpackweburl'] = get_string('invalidurl', 'badges');

        }

        return $errors;

    }

    /**

     * Return submitted data if properly submitted or returns NULL if validation fails or

     * if there is no submitted data.

     *

     * @return object|void

     */

    public function get_data() {

        $data = parent::get_data();

        if ($data ) {

            if ((isset($data->includeauthdetails) && !$data->includeauthdetails)

                || (isset($data->apiversion) && $data->apiversion == 2.1)) {

                $data->backpackemail = "";

                $data->password = "";

            }

            if ((isset($data->apiversion) && $data->apiversion == 1)) {

                $data->password = "";

            }

        }

        return $data;

    }

    /**

     * Add backpack specific auth details.

     *

     * @param string|null $email The email addressed provided or null if it's new.

     * @param bool $includepassword Include the password field. Defaults to true

     * @throws \coding_exception

     */

    protected function add_auth_fields(?string $email, bool $includepassword = true) {

        $mform = $this->_form;

        $emailstring = get_string('email');

        $passwordstring = get_string('password');

        $showpasswordhelp = false;

        if (!isset($this->_customdata['userbackpack'])) {

            $emailstring = get_string('defaultissuercontact', 'core_badges');

            $passwordstring = get_string('defaultissuerpassword', 'core_badges');

            $showpasswordhelp = true;

        }

        $mform->addElement('text', 'backpackemail', $emailstring);

        $mform->setType('backpackemail', PARAM_EMAIL);

        $mform->setDefault('backpackemail', $email);

        if ($includepassword) {

            $mform->addElement('passwordunmask', 'password', $passwordstring);

            $mform->setType('password', PARAM_RAW);

            if ($showpasswordhelp) {

                $mform->addHelpButton('password', 'defaultissuerpassword', 'badges');

            }

        }

    }

}