mirror of
https://github.com/moodle/moodle.git
synced 2025-08-05 17:06:53 +02:00
c4ad1bf2f6
The patch adds ability to filter the list of token by the token value, the user and the service. Also the button to create a new token is made more prominent and easier to spot.
289 lines
11 KiB
PHP
289 lines
11 KiB
PHP
<?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/>.
|
|
|
|
/**
|
|
* Contains the class used for the displaying the tokens table.
|
|
*
|
|
* @package core_webservice
|
|
* @copyright 2017 John Okely <john@moodle.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
namespace core_webservice;
|
|
|
|
defined('MOODLE_INTERNAL') || die;
|
|
|
|
require_once($CFG->libdir . '/tablelib.php');
|
|
require_once($CFG->dirroot . '/webservice/lib.php');
|
|
require_once($CFG->dirroot . '/user/lib.php');
|
|
|
|
/**
|
|
* Class for the displaying the participants table.
|
|
*
|
|
* @package core_webservice
|
|
* @copyright 2017 John Okely <john@moodle.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class token_table extends \table_sql {
|
|
|
|
/**
|
|
* @var bool $showalltokens Whether or not the user is able to see all tokens.
|
|
*/
|
|
protected $showalltokens;
|
|
|
|
/** @var bool $hasviewfullnames Does the user have the viewfullnames capability. */
|
|
protected $hasviewfullnames;
|
|
|
|
/** @var object */
|
|
protected $filterdata;
|
|
|
|
/**
|
|
* Sets up the table.
|
|
*
|
|
* @param int $id The id of the table
|
|
* @param object $filterdata The data submitted by the {@see token_filter}.
|
|
*/
|
|
public function __construct($id, $filterdata = null) {
|
|
parent::__construct($id);
|
|
|
|
// Get the context.
|
|
$context = \context_system::instance();
|
|
|
|
// Can we see tokens created by all users?
|
|
$this->showalltokens = has_capability('moodle/webservice:managealltokens', $context);
|
|
$this->hasviewfullnames = has_capability('moodle/site:viewfullnames', $context);
|
|
|
|
// Filter form values.
|
|
$this->filterdata = $filterdata;
|
|
|
|
// Define the headers and columns.
|
|
$headers = [];
|
|
$columns = [];
|
|
|
|
$headers[] = get_string('token', 'webservice');
|
|
$columns[] = 'token';
|
|
$headers[] = get_string('user');
|
|
$columns[] = 'fullname';
|
|
$headers[] = get_string('service', 'webservice');
|
|
$columns[] = 'name';
|
|
$headers[] = get_string('iprestriction', 'webservice');
|
|
$columns[] = 'iprestriction';
|
|
$headers[] = get_string('validuntil', 'webservice');
|
|
$columns[] = 'validuntil';
|
|
if ($this->showalltokens) {
|
|
// Only need to show creator if you can see tokens created by other people.
|
|
$headers[] = get_string('tokencreator', 'webservice');
|
|
$columns[] = 'creatorlastname'; // So we can have semi-useful sorting. Table SQL doesn't two fullname collumns.
|
|
}
|
|
$headers[] = get_string('operation', 'webservice');
|
|
$columns[] = 'operation';
|
|
|
|
$this->define_columns($columns);
|
|
$this->define_headers($headers);
|
|
|
|
$this->no_sorting('operation');
|
|
$this->no_sorting('token');
|
|
$this->no_sorting('iprestriction');
|
|
|
|
$this->set_attribute('id', $id);
|
|
}
|
|
|
|
/**
|
|
* Generate the operation column.
|
|
*
|
|
* @param \stdClass $data Data for the current row
|
|
* @return string Content for the column
|
|
*/
|
|
public function col_operation($data) {
|
|
$tokenpageurl = new \moodle_url(
|
|
"/admin/webservice/tokens.php",
|
|
[
|
|
"sesskey" => sesskey(),
|
|
"action" => "delete",
|
|
"tokenid" => $data->id
|
|
]
|
|
);
|
|
return \html_writer::link($tokenpageurl, get_string("delete"));
|
|
}
|
|
|
|
/**
|
|
* Generate the validuntil column.
|
|
*
|
|
* @param \stdClass $data Data for the current row
|
|
* @return string Content for the column
|
|
*/
|
|
public function col_validuntil($data) {
|
|
if (empty($data->validuntil)) {
|
|
return '';
|
|
} else {
|
|
return userdate($data->validuntil, get_string('strftimedatetime', 'langconfig'));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Generate the fullname column. Also includes capabilities the user is missing for the webservice (if any)
|
|
*
|
|
* @param \stdClass $data Data for the current row
|
|
* @return string Content for the column
|
|
*/
|
|
public function col_fullname($data) {
|
|
global $OUTPUT;
|
|
|
|
$userprofilurl = new \moodle_url('/user/profile.php', ['id' => $data->userid]);
|
|
$content = \html_writer::link($userprofilurl, fullname($data, $this->hasviewfullnames));
|
|
|
|
// Make up list of capabilities that the user is missing for the given webservice.
|
|
$webservicemanager = new \webservice();
|
|
$usermissingcaps = $webservicemanager->get_missing_capabilities_by_users([['id' => $data->userid]], $data->serviceid);
|
|
|
|
if (!is_siteadmin($data->userid) && array_key_exists($data->userid, $usermissingcaps)) {
|
|
$count = \html_writer::span(count($usermissingcaps[$data->userid]), 'badge badge-danger');
|
|
$links = array_map(function($capname) {
|
|
return get_capability_docs_link((object)['name' => $capname]) . \html_writer::div($capname, 'text-muted');
|
|
}, $usermissingcaps[$data->userid]);
|
|
$list = \html_writer::alist($links);
|
|
$help = $OUTPUT->help_icon('missingcaps', 'webservice');
|
|
$content .= print_collapsible_region(\html_writer::div($list . $help, 'missingcaps'), 'small',
|
|
\html_writer::random_id('usermissingcaps'), get_string('usermissingcaps', 'webservice', $count), '', true, true);
|
|
}
|
|
|
|
return $content;
|
|
}
|
|
|
|
/**
|
|
* Generate the token column.
|
|
*
|
|
* @param \stdClass $data Data for the current row
|
|
* @return string Content for the column
|
|
*/
|
|
public function col_token($data) {
|
|
global $USER;
|
|
// Hide the token if it wasn't created by the current user.
|
|
if ($data->creatorid != $USER->id) {
|
|
return \html_writer::tag('small', get_string('onlyseecreatedtokens', 'core_webservice'), ['class' => 'text-muted']);
|
|
}
|
|
|
|
return $data->token;
|
|
}
|
|
|
|
/**
|
|
* Generate the creator column.
|
|
*
|
|
* @param \stdClass $data
|
|
* @return string
|
|
*/
|
|
public function col_creatorlastname($data) {
|
|
// We have loaded all the name fields for the creator, with the 'creator' prefix.
|
|
// So just remove the prefix and make up a user object.
|
|
$user = [];
|
|
foreach ($data as $key => $value) {
|
|
if (strpos($key, 'creator') !== false) {
|
|
$newkey = str_replace('creator', '', $key);
|
|
$user[$newkey] = $value;
|
|
}
|
|
}
|
|
|
|
$creatorprofileurl = new \moodle_url('/user/profile.php', ['id' => $data->creatorid]);
|
|
return \html_writer::link($creatorprofileurl, fullname((object)$user, $this->hasviewfullnames));
|
|
}
|
|
|
|
/**
|
|
* This function is used for the extra user fields.
|
|
*
|
|
* These are being dynamically added to the table so there are no functions 'col_<userfieldname>' as
|
|
* the list has the potential to increase in the future and we don't want to have to remember to add
|
|
* a new method to this class. We also don't want to pollute this class with unnecessary methods.
|
|
*
|
|
* @param string $colname The column name
|
|
* @param \stdClass $data
|
|
* @return string
|
|
*/
|
|
public function other_cols($colname, $data) {
|
|
return s($data->{$colname});
|
|
}
|
|
|
|
/**
|
|
* Query the database for results to display in the table.
|
|
*
|
|
* Note: Initial bars are not implemented for this table because it includes user details twice and the initial bars do not work
|
|
* when the user table is included more than once.
|
|
*
|
|
* @param int $pagesize size of page for paginated displayed table.
|
|
* @param bool $useinitialsbar Not implemented. Please pass false.
|
|
*/
|
|
public function query_db($pagesize, $useinitialsbar = false) {
|
|
global $DB, $USER;
|
|
|
|
if ($useinitialsbar) {
|
|
debugging('Initial bar not implemented yet. Call out($pagesize, false)');
|
|
}
|
|
|
|
$userfieldsapi = \core\user_fields::for_name();
|
|
$usernamefields = $userfieldsapi->get_sql('u', false, '', '', false)->selects;
|
|
$creatorfields = $userfieldsapi->get_sql('c', false, 'creator', '', false)->selects;
|
|
|
|
$params = ['tokenmode' => EXTERNAL_TOKEN_PERMANENT];
|
|
|
|
$selectfields = "SELECT t.id, t.token, t.iprestriction, t.validuntil, t.creatorid,
|
|
u.id AS userid, $usernamefields,
|
|
s.id AS serviceid, s.name,
|
|
$creatorfields ";
|
|
|
|
$selectcount = "SELECT COUNT(t.id) ";
|
|
|
|
$sql = " FROM {external_tokens} t
|
|
JOIN {user} u ON u.id = t.userid
|
|
JOIN {external_services} s ON s.id = t.externalserviceid
|
|
JOIN {user} c ON c.id = t.creatorid
|
|
WHERE t.tokentype = :tokenmode";
|
|
|
|
if (!$this->showalltokens) {
|
|
// Only show tokens created by the current user.
|
|
$sql .= " AND t.creatorid = :userid";
|
|
$params['userid'] = $USER->id;
|
|
}
|
|
|
|
if ($this->filterdata->token !== '') {
|
|
$sql .= " AND " . $DB->sql_like("t.token", ":token");
|
|
$params['token'] = "%" . $DB->sql_like_escape($this->filterdata->token) . "%";
|
|
}
|
|
|
|
if (!empty($this->filterdata->users)) {
|
|
list($sqlusers, $paramsusers) = $DB->get_in_or_equal($this->filterdata->users, SQL_PARAMS_NAMED, 'user');
|
|
$sql .= " AND t.userid {$sqlusers}";
|
|
$params += $paramsusers;
|
|
}
|
|
|
|
if (!empty($this->filterdata->services)) {
|
|
list($sqlservices, $paramsservices) = $DB->get_in_or_equal($this->filterdata->services, SQL_PARAMS_NAMED, 'service');
|
|
$sql .= " AND s.id {$sqlservices}";
|
|
$params += $paramsservices;
|
|
}
|
|
|
|
$sort = $this->get_sql_sort();
|
|
$sortsql = '';
|
|
|
|
if ($sort) {
|
|
$sortsql = " ORDER BY {$sort}";
|
|
}
|
|
|
|
$total = $DB->count_records_sql($selectcount . $sql, $params);
|
|
$this->pagesize($pagesize, $total);
|
|
|
|
$this->rawdata = $DB->get_recordset_sql($selectfields . $sql . $sortsql, $params, $this->get_page_start(),
|
|
$this->get_page_size());
|
|
}
|
|
}
|