MDL-65959 badge: Enable OB2.1 *connection* with cross domain ability
[moodle.git] / badges / mybackpack.php
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/>.
17 /**
18  * User backpack settings page.
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  */
27 require_once(__DIR__ . '/../config.php');
28 require_once($CFG->libdir . '/badgeslib.php');
30 require_login();
32 if (empty($CFG->enablebadges)) {
33     print_error('badgesdisabled', 'badges');
34 }
36 $context = context_user::instance($USER->id);
37 require_capability('moodle/badges:manageownbadges', $context);
39 $disconnect = optional_param('disconnect', false, PARAM_BOOL);
41 if (empty($CFG->badges_allowexternalbackpack)) {
42     redirect($CFG->wwwroot);
43 }
45 $PAGE->set_url(new moodle_url('/badges/mybackpack.php'));
46 $PAGE->set_context($context);
48 $title = get_string('backpackdetails', 'badges');
49 $PAGE->set_title($title);
50 $PAGE->set_heading(fullname($USER));
51 $PAGE->set_pagelayout('standard');
53 $backpack = $DB->get_record('badge_backpack', array('userid' => $USER->id));
54 $badgescache = cache::make('core', 'externalbadges');
56 if ($disconnect && $backpack) {
57     require_sesskey();
58     $sitebackpack = badges_get_site_backpack($backpack->externalbackpackid);
59     if ($sitebackpack->apiversion == OPEN_BADGES_V2P1) {
60         $bp = new \core_badges\backpack_api2p1($sitebackpack);
61         $bp->disconnect_backpack($backpack);
62         redirect(new moodle_url('/badges/mybackpack.php'), get_string('backpackdisconnected', 'badges'), null,
63             \core\output\notification::NOTIFY_SUCCESS);
64     } else {
65         // If backpack is connected, need to select collections.
66         $bp = new \core_badges\backpack_api($sitebackpack, $backpack);
67         $bp->disconnect_backpack($USER->id, $backpack->id);
68         redirect(new moodle_url('/badges/mybackpack.php'));
69     }
70 }
71 $warning = '';
72 if ($backpack) {
74     $sitebackpack = badges_get_site_backpack($backpack->externalbackpackid);
76     // If backpack is connected, need to select collections.
77     $bp = new \core_badges\backpack_api($sitebackpack, $backpack);
78     $request = $bp->get_collections();
79     $groups = $request;
80     if (isset($request->groups)) {
81         $groups = $request->groups;
82     }
83     if (empty($groups)) {
84         $err = get_string('error:nogroupssummary', 'badges');
85         $err .= get_string('error:nogroupslink', 'badges', $sitebackpack->backpackweburl);
86         $params['nogroups'] = $err;
87     } else {
88         $params['groups'] = $groups;
89     }
90     $params['email'] = $backpack->email;
91     $params['selected'] = $bp->get_collection_record($backpack->id);
92     $params['backpackweburl'] = $sitebackpack->backpackweburl;
93     $form = new \core_badges\form\collections(new moodle_url('/badges/mybackpack.php'), $params);
95     if ($form->is_cancelled()) {
96         redirect(new moodle_url('/badges/mybadges.php'));
97     } else if ($data = $form->get_data()) {
98         if (empty($data->group)) {
99             redirect(new moodle_url('/badges/mybadges.php'));
100         } else {
101             $groups = array_filter($data->group);
102         }
103         $bp->set_backpack_collections($backpack->id, $groups);
104         redirect(new moodle_url('/badges/mybadges.php'));
105     }
106 } else {
107     // If backpack is not connected, need to connect first.
108     // To create a new connection to the backpack, first we need to verify the user's email address:
109     // 1. User enters email and clicks 'Connect to backpack'.
110     // 2. After cross-checking the email address against the backpack provider, an email is sent to the specified address,
111     // and the email and secret are stored in user preferences. These will be cleared upon successful verification.
112     // 3. User clicks verification link in the email to confirm the backpack connection.
113     // 4. User redirected to the mybackpack page.
114     // While the verification process is pending, the edit_backpack_form form will present the user with options to resend the
115     // verification email, and to cancel the current verification attempt and start over.
117     // To pass through the current state of the verification attempt to the form.
118     $params['email'] = get_user_preferences('badges_email_verify_address');
119     $params['backpackpassword'] = get_user_preferences('badges_email_verify_password');
120     $params['backpackid'] = get_user_preferences('badges_email_verify_backpackid');
122     $form = new \core_badges\form\backpack(new moodle_url('/badges/mybackpack.php'), $params);
123     $data = $form->get_submitted_data();
124     if ($form->is_cancelled()) {
125         redirect(new moodle_url('/badges/mybadges.php'));
126     } else if (badges_open_badges_backpack_api($data->externalbackpackid) == OPEN_BADGES_V2P1) {
127         // If backpack is version 2.1 to redirect on the backpack site to login.
128         // User input username/email/password on the backpack site
129         // After confirm the scopes.
130         redirect(new moodle_url('/badges/backpack-connect.php', ['backpackid' => $data->externalbackpackid]));
131     } else if ($data = $form->get_data()) {
132         // The form may have been submitted under one of the following circumstances:
133         // 1. After clicking 'Connect to backpack'. We'll have $data->email.
134         // 2. After clicking 'Resend verification email'. We'll have $data->email.
135         // 3. After clicking 'Connect using a different email' to cancel the verification process. We'll have $data->revertbutton.
137         if (isset($data->revertbutton)) {
138             badges_disconnect_user_backpack($USER->id);
139             redirect(new moodle_url('/badges/mybackpack.php'));
140         } else if (isset($data->backpackemail)) {
141             if (badges_send_verification_email($data->backpackemail, $data->externalbackpackid, $data->password)) {
142                 $a = get_user_preferences('badges_email_verify_backpackid');
143                 redirect(new moodle_url('/badges/mybackpack.php'),
144                     get_string('backpackemailverifypending', 'badges', $data->backpackemail),
145                     null, \core\output\notification::NOTIFY_INFO);
146             } else {
147                 print_error ('backpackcannotsendverification', 'badges');
148             }
149         }
150     }
153 echo $OUTPUT->header();
154 echo $OUTPUT->heading($title);
155 echo $warning;
156 $form->display();
157 echo $OUTPUT->footer();