MDL-65959 badges: Update the implementation to use admin set backpack
[moodle.git] / badges / classes / form / backpack.php
CommitLineData
27806552
YB
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 class for mybackpack.php
19 *
20 * @package core
21 * @subpackage badges
22 * @copyright 2012 onwards Totara Learning Solutions Ltd {@link http://www.totaralms.com/}
23 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24 * @author Yuliya Bozhko <yuliya.bozhko@totaralms.com>
25 */
26
aae219ac
DW
27namespace core_badges\form;
28
27806552
YB
29defined('MOODLE_INTERNAL') || die();
30
31require_once($CFG->libdir . '/formslib.php');
32require_once($CFG->libdir . '/badgeslib.php');
33
aae219ac
DW
34use html_writer;
35use moodleform;
36use stdClass;
37
27806552
YB
38/**
39 * Form to edit backpack initial details.
40 *
41 */
1c4620bc 42class backpack extends external_backpack {
27806552
YB
43
44 /**
45 * Defines the form
46 */
47 public function definition() {
aae219ac 48 global $USER, $PAGE, $OUTPUT, $CFG;
27806552 49 $mform = $this->_form;
3cae9421 50 $this->_customdata['userbackpack'] = 1;
27806552 51
f6ebcd34 52 $mform->addElement('html', html_writer::tag('span', '', array('class' => 'notconnected', 'id' => 'connection-error')));
e2805314
YB
53 $mform->addElement('header', 'backpackheader', get_string('backpackconnection', 'badges'));
54 $mform->addHelpButton('backpackheader', 'backpackconnection', 'badges');
27806552
YB
55 $mform->addElement('hidden', 'userid', $USER->id);
56 $mform->setType('userid', PARAM_INT);
3cae9421 57 $freeze = [];
091eaab0
JD
58 if (isset($this->_customdata['email'])) {
59 // Email will be passed in when we're in the process of verifying the user's email address,
60 // so set the connection status, lock the email field, and provide options to resend the verification
61 // email or cancel the verification process entirely and start over.
3cae9421
PD
62 $freeze = ['backpackemail'];
63 $mform->addElement('hidden', 'password', $this->_customdata['backpackpassword']);
64 $mform->setType('password', PARAM_RAW);
65 $mform->addElement('hidden', 'externalbackpackid', $this->_customdata['backpackid']);
66 $mform->setType('externalbackpackid', PARAM_INT);
091eaab0
JD
67 $status = html_writer::tag('span', get_string('backpackemailverificationpending', 'badges'),
68 array('class' => 'notconnected', 'id' => 'connection-status'));
1c4620bc 69 } else {
3cae9421
PD
70 $sitebackpacks = badges_get_site_backpacks();
71 $choices = [];
72 $restrictedoptions = [];
73 foreach ($sitebackpacks as $backpack) {
74 $choices[$backpack->id] = $backpack->backpackweburl;
75 if ($backpack->apiversion == OPEN_BADGES_V2P1) {
76 $restrictedoptions[] = $backpack->id;
77 }
78 }
79 $mform->addElement('select', 'externalbackpackid', get_string('backpackprovider', 'badges'), $choices);
80 $mform->setType('externalbackpackid', PARAM_INT);
81 $mform->setDefault('externalbackpackid', $CFG->badges_site_backpack);
82 $mform->hideIf('password', 'externalbackpackid', 'in', $restrictedoptions);
83 $mform->hideIf('backpackemail', 'externalbackpackid', 'in', $restrictedoptions);
84
1c4620bc
P
85 $status = html_writer::tag('span', get_string('notconnected', 'badges'),
86 array('class' => 'notconnected', 'id' => 'connection-status'));
87 }
88 $mform->addElement('static', 'status', get_string('status'), $status);
89
3cae9421 90 $this->add_auth_fields($this->_customdata['email'] ?? $USER->email, !isset($this->_customdata['email']));
1c4620bc 91
1c4620bc 92 $mform->setDisableShortforms(false);
3cae9421
PD
93
94 // Freeze any elemnts after definition.
95 if ($freeze) {
96 $mform->freeze($freeze);
97 }
98 $this->add_action_buttons();
1c4620bc
P
99 }
100
101 /**
102 * Override add_action_buttons
103 *
104 * @param bool $cancel
105 * @param null|text $submitlabel
106 */
107 public function add_action_buttons($cancel = true, $submitlabel = null) {
3cae9421
PD
108 $mform = $this->_form;
109 if (isset($this->_customdata['email'])) {
091eaab0
JD
110 $buttonarray = [];
111 $buttonarray[] = &$mform->createElement('submit', 'submitbutton',
112 get_string('backpackconnectionresendemail', 'badges'));
113 $buttonarray[] = &$mform->createElement('submit', 'revertbutton',
114 get_string('backpackconnectioncancelattempt', 'badges'));
115 $mform->addGroup($buttonarray, 'buttonar', '', [''], false);
116 $mform->closeHeaderBefore('buttonar');
117 } else {
118 // Email isn't present, so provide an input element to get it and a button to start the verification process.
1c4620bc 119 parent::add_action_buttons(false, get_string('backpackconnectionconnect', 'badges'));
091eaab0 120 }
e2805314
YB
121 }
122
123 /**
124 * Validates form data
125 */
126 public function validation($data, $files) {
15a00bea
TT
127 global $CFG;
128
e2805314 129 $errors = parent::validation($data, $files);
15a00bea
TT
130 if (badges_open_badges_backpack_api() == OPEN_BADGES_V2P1) {
131 return $errors;
132 }
091eaab0
JD
133 // We don't need to verify the email address if we're clearing a pending email verification attempt.
134 if (!isset($data['revertbutton'])) {
135 $check = new stdClass();
1c4620bc
P
136 $check->email = $data['backpackemail'];
137 $check->password = $data['password'];
3cae9421
PD
138 $sitebackpack = badges_get_site_backpack($data['externalbackpackid']);
139 $bp = new \core_badges\backpack_api($sitebackpack, $check);
091eaab0 140
aae219ac
DW
141 $result = $bp->authenticate();
142 if ($result === false || !empty($result->error)) {
1c4620bc 143 $errors['backpackemail'] = get_string('backpackconnectionunexpectedresult', 'badges');
7444ba74
DW
144 $msg = $bp->get_authentication_error();
145 if (!empty($msg)) {
1c4620bc
P
146 $errors['backpackemail'] .= '<br/><br/>';
147 $errors['backpackemail'] .= get_string('backpackconnectionunexpectedmessage', 'badges', $msg);
7444ba74 148 }
091eaab0 149 }
e2805314
YB
150 }
151 return $errors;
27806552
YB
152 }
153}