Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
<?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/>.

/**
 * OAuth 2 Configuration page.
 *
 * @package    tool_oauth2
 * @copyright  2017 Damyon Wiese <damyon@moodle.com>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

require_once(__DIR__ . '/../../../config.php');
require_once($CFG->libdir.'/adminlib.php');
require_once($CFG->libdir.'/tablelib.php');

$PAGE->set_url('/admin/tool/oauth2/issuers.php');
$PAGE->set_context(context_system::instance());
$PAGE->set_pagelayout('admin');
$strheading = get_string('pluginname', 'tool_oauth2');
$PAGE->set_title($strheading);
$PAGE->set_heading($strheading);

require_admin();

$renderer = $PAGE->get_renderer('tool_oauth2');

$action = optional_param('action', '', PARAM_ALPHAEXT);
$issuerid = optional_param('id', '', PARAM_RAW);
$issuer = null;
$mform = null;

if ($issuerid) {
    $issuer = \core\oauth2\api::get_issuer($issuerid);
    if (!$issuer) {
< print_error('invaliddata');
> throw new \moodle_exception('invaliddata');
} } if ($action == 'edit') { if ($issuer) { $PAGE->navbar->add(get_string('editissuer', 'tool_oauth2', s($issuer->get('name')))); } else {
< $PAGE->navbar->add(get_string('createnewissuer', 'tool_oauth2'));
> $PAGE->navbar->add(get_string('createnewservice', 'tool_oauth2') . ' ' . get_string('custom_service', 'tool_oauth2'));
}
< $showrequireconfirm = false; < if (!empty($issuerid)) { < // Show the "Require confirmation email" checkbox for trusted issuers like Google, Facebook and Microsoft. < $likefacebook = $DB->sql_like('url', ':facebook'); < $likegoogle = $DB->sql_like('url', ':google'); < $likemicrosoft = $DB->sql_like('url', ':microsoft'); < $params = [ < 'issuerid' => $issuerid, < 'facebook' => '%facebook%', < 'google' => '%google%', < 'microsoft' => '%microsoft%', < ]; < $select = "issuerid = :issuerid AND ($likefacebook OR $likegoogle OR $likemicrosoft)"; < // We're querying from the oauth2_endpoint table because the base URLs of FB and Microsoft can be empty in the issuer table. < $showrequireconfirm = $DB->record_exists_select('oauth2_endpoint', $select, $params); < } < < $mform = new \tool_oauth2\form\issuer(null, ['persistent' => $issuer, 'showrequireconfirm' => $showrequireconfirm]);
> $mform = new \tool_oauth2\form\issuer(null, ['persistent' => $issuer]);
} if ($mform && $mform->is_cancelled()) { redirect(new moodle_url('/admin/tool/oauth2/issuers.php')); } else if ($action == 'edit') { if ($data = $mform->get_data()) { try { if (!empty($data->id)) { core\oauth2\api::update_issuer($data); } else { core\oauth2\api::create_issuer($data); } redirect($PAGE->url, get_string('changessaved'), null, \core\output\notification::NOTIFY_SUCCESS); } catch (Exception $e) { redirect($PAGE->url, $e->getMessage(), null, \core\output\notification::NOTIFY_ERROR); } } else { echo $OUTPUT->header(); if ($issuer) { echo $OUTPUT->heading(get_string('editissuer', 'tool_oauth2', s($issuer->get('name')))); } else {
< echo $OUTPUT->heading(get_string('createnewissuer', 'tool_oauth2'));
> echo $OUTPUT->heading(get_string('createnewservice', 'tool_oauth2') . ' ' . get_string('custom_service', 'tool_oauth2'));
} $mform->display(); echo $OUTPUT->footer(); } } else if ($action == 'savetemplate') {
< $type = required_param('type', PARAM_ALPHA); < $mform = new \tool_oauth2\form\issuer(null, ['persistent' => $issuer, 'type' => $type]);
> $type = required_param('type', PARAM_ALPHANUM); > $mform = new \tool_oauth2\form\issuer(null, [ > 'persistent' => $issuer, > 'type' => $type, > 'showrequireconfirm' => true, // Ensure the "requireconfirmation" field is included in form data. > ]);
if ($mform->is_cancelled()) { redirect(new moodle_url('/admin/tool/oauth2/issuers.php')); } if ($mform->is_submitted() && $data = $mform->get_data()) { $issuer = new core\oauth2\issuer(0, $data); $issuer->create(); $issuer = core\oauth2\api::create_endpoints_for_standard_issuer($type, $issuer); redirect($PAGE->url, get_string('changessaved'), null, \core\output\notification::NOTIFY_SUCCESS); } else { echo $OUTPUT->header();
> echo $OUTPUT->heading(get_string('createnewservice', 'tool_oauth2') . ' ' . get_string($type . '_service', 'tool_oauth2'));
$mform->display(); echo $OUTPUT->footer(); } } else if ($action == 'edittemplate') {
< $type = required_param('type', PARAM_ALPHA);
> $type = required_param('type', PARAM_ALPHANUM);
$docs = required_param('docslink', PARAM_ALPHAEXT);
< $showrequireconfirm = optional_param('showrequireconfirm', false, PARAM_BOOL);
require_sesskey(); $issuer = core\oauth2\api::init_standard_issuer($type);
< $mform = new \tool_oauth2\form\issuer(null, ['persistent' => $issuer, 'type' => $type, < 'showrequireconfirm' => $showrequireconfirm]);
> $mform = new \tool_oauth2\form\issuer(null, ['persistent' => $issuer, 'type' => $type]);
> $PAGE->navbar->add(get_string('createnewservice', 'tool_oauth2') . ' ' . get_string($type . '_service', 'tool_oauth2'));
echo $OUTPUT->header();
> echo $OUTPUT->heading(get_string('createnewservice', 'tool_oauth2') . ' ' . get_string($type . '_service', 'tool_oauth2'));
$mform->display(); echo $OUTPUT->footer(); } else if ($action == 'enable') { require_sesskey(); core\oauth2\api::enable_issuer($issuerid); redirect($PAGE->url, get_string('issuerenabled', 'tool_oauth2'), null, \core\output\notification::NOTIFY_SUCCESS); } else if ($action == 'disable') { require_sesskey(); core\oauth2\api::disable_issuer($issuerid); redirect($PAGE->url, get_string('issuerdisabled', 'tool_oauth2'), null, \core\output\notification::NOTIFY_SUCCESS); } else if ($action == 'delete') { if (!optional_param('confirm', false, PARAM_BOOL)) { $continueparams = ['action' => 'delete', 'id' => $issuerid, 'sesskey' => sesskey(), 'confirm' => true]; $continueurl = new moodle_url('/admin/tool/oauth2/issuers.php', $continueparams); $cancelurl = new moodle_url('/admin/tool/oauth2/issuers.php'); echo $OUTPUT->header(); echo $OUTPUT->confirm(get_string('deleteconfirm', 'tool_oauth2', s($issuer->get('name'))), $continueurl, $cancelurl); echo $OUTPUT->footer(); } else { require_sesskey(); core\oauth2\api::delete_issuer($issuerid); redirect($PAGE->url, get_string('issuerdeleted', 'tool_oauth2'), null, \core\output\notification::NOTIFY_SUCCESS); } } else if ($action == 'auth') { if (!optional_param('confirm', false, PARAM_BOOL)) { $continueparams = ['action' => 'auth', 'id' => $issuerid, 'sesskey' => sesskey(), 'confirm' => true]; $continueurl = new moodle_url('/admin/tool/oauth2/issuers.php', $continueparams); $cancelurl = new moodle_url('/admin/tool/oauth2/issuers.php'); echo $OUTPUT->header(); echo $OUTPUT->confirm(get_string('authconfirm', 'tool_oauth2', s($issuer->get('name'))), $continueurl, $cancelurl); echo $OUTPUT->footer(); } else { require_sesskey(); $params = ['sesskey' => sesskey(), 'id' => $issuerid, 'action' => 'auth', 'confirm' => true, 'response' => true]; if (core\oauth2\api::connect_system_account($issuer, new moodle_url('/admin/tool/oauth2/issuers.php', $params))) { redirect($PAGE->url, get_string('authconnected', 'tool_oauth2'), null, \core\output\notification::NOTIFY_SUCCESS); } else { redirect($PAGE->url, get_string('authnotconnected', 'tool_oauth2'), null, \core\output\notification::NOTIFY_ERROR); } } } else if ($action == 'moveup') { require_sesskey(); core\oauth2\api::move_up_issuer($issuerid); redirect($PAGE->url); } else if ($action == 'movedown') { require_sesskey(); core\oauth2\api::move_down_issuer($issuerid); redirect($PAGE->url); } else { echo $OUTPUT->header(); echo $OUTPUT->heading(get_string('pluginname', 'tool_oauth2')); echo $OUTPUT->doc_link('OAuth2_Services', get_string('serviceshelp', 'tool_oauth2'));
< $issuers = core\oauth2\api::get_all_issuers();
> $issuers = core\oauth2\api::get_all_issuers(true);
echo $renderer->issuers_table($issuers);
> echo $renderer->container_start(); // Google template. > echo get_string('createnewservice', 'tool_oauth2') . ' '; $docs = 'admin/tool/oauth2/issuers/google'; >
< $params = ['action' => 'edittemplate', 'type' => 'google', 'sesskey' => sesskey(), 'docslink' => $docs, < 'showrequireconfirm' => true];
> $params = ['action' => 'edittemplate', 'type' => 'google', 'sesskey' => sesskey(), 'docslink' => $docs];
$addurl = new moodle_url('/admin/tool/oauth2/issuers.php', $params);
< echo $renderer->single_button($addurl, get_string('createnewgoogleissuer', 'tool_oauth2'));
> echo $renderer->single_button($addurl, get_string('google_service', 'tool_oauth2'));
// Microsoft template. $docs = 'admin/tool/oauth2/issuers/microsoft';
< $params = ['action' => 'edittemplate', 'type' => 'microsoft', 'sesskey' => sesskey(), 'docslink' => $docs, < 'showrequireconfirm' => true];
> $params = ['action' => 'edittemplate', 'type' => 'microsoft', 'sesskey' => sesskey(), 'docslink' => $docs];
$addurl = new moodle_url('/admin/tool/oauth2/issuers.php', $params);
< echo $renderer->single_button($addurl, get_string('createnewmicrosoftissuer', 'tool_oauth2'));
> echo $renderer->single_button($addurl, get_string('microsoft_service', 'tool_oauth2'));
// Facebook template. $docs = 'admin/tool/oauth2/issuers/facebook';
< $params = ['action' => 'edittemplate', 'type' => 'facebook', 'sesskey' => sesskey(), 'docslink' => $docs, < 'showrequireconfirm' => true];
> $params = ['action' => 'edittemplate', 'type' => 'facebook', 'sesskey' => sesskey(), 'docslink' => $docs];
$addurl = new moodle_url('/admin/tool/oauth2/issuers.php', $params);
< echo $renderer->single_button($addurl, get_string('createnewfacebookissuer', 'tool_oauth2'));
> echo $renderer->single_button($addurl, get_string('facebook_service', 'tool_oauth2'));
// Nextcloud template. $docs = 'admin/tool/oauth2/issuers/nextcloud'; $params = ['action' => 'edittemplate', 'type' => 'nextcloud', 'sesskey' => sesskey(), 'docslink' => $docs]; $addurl = new moodle_url('/admin/tool/oauth2/issuers.php', $params);
< echo $renderer->single_button($addurl, get_string('createnewnextcloudissuer', 'tool_oauth2'));
> echo $renderer->single_button($addurl, get_string('nextcloud_service', 'tool_oauth2')); > > // IMS Open Badges Connect template. > $docs = 'admin/tool/oauth2/issuers/imsobv2p1'; > $params = ['action' => 'edittemplate', 'type' => 'imsobv2p1', 'sesskey' => sesskey(), 'docslink' => $docs]; > $addurl = new moodle_url('/admin/tool/oauth2/issuers.php', $params); > echo $renderer->single_button($addurl, get_string('imsobv2p1_service', 'tool_oauth2'));
// Linkedin template. $docs = 'admin/tool/oauth2/issuers/linkedin'; $params = ['action' => 'edittemplate', 'type' => 'linkedin', 'sesskey' => sesskey(), 'docslink' => $docs]; $addurl = new moodle_url('/admin/tool/oauth2/issuers.php', $params); echo $renderer->single_button($addurl, get_string('linkedin_service', 'tool_oauth2'));
> // Clever template. // Generic issuer. > $docs = 'admin/tool/oauth2/issuers/clever'; $addurl = new moodle_url('/admin/tool/oauth2/issuers.php', ['action' => 'edit']); > $params = ['action' => 'edittemplate', 'type' => 'clever', 'sesskey' => sesskey(), 'docslink' => $docs]; echo $renderer->single_button($addurl, get_string('createnewissuer', 'tool_oauth2')); > $addurl = new moodle_url('/admin/tool/oauth2/issuers.php', $params); > echo $renderer->single_button($addurl, get_string('clever_service', 'tool_oauth2')); echo $OUTPUT->footer(); >
< echo $renderer->single_button($addurl, get_string('createnewissuer', 'tool_oauth2'));
> echo $renderer->single_button($addurl, get_string('custom_service', 'tool_oauth2'));
}
> echo $renderer->container_end();
<