mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-04-13 20:42:22 +02:00
Code Issues Projects Releases Wiki Activity

Merge branch 'MDL-29693' of https://github.com/paulholden/moodle

Browse Source
This commit is contained in:
Sara Arjona 2019-12-04 11:40:22 +01:00
commit 04b52780eb
7 changed files with 387 additions and 97 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
report/configlog/classes/form/search.php Normal file
View File

@ -0,0 +1,72 @@
<?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/>.
/**
* Report search form class.
*
* @package report_configlog
* @copyright 2019 Paul Holden (paulh@moodle.com)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace report_configlog\form;
defined('MOODLE_INTERNAL') || die();
require_once($CFG->libdir . '/formslib.php');
/**
* Report search form class.
*
* @package report_configlog
* @copyright 2019 Paul Holden (paulh@moodle.com)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class search extends \moodleform {
/**
* Form definition
*
* @return void
*/
public function definition() {
$mform = $this->_form;
// By default just show the 'setting' field.
$mform->addElement('header', 'heading', get_string('search'));
$mform->addElement('text', 'setting', get_string('setting', 'report_configlog'));
$mform->setType('setting', PARAM_TEXT);
// Rest of the search fields.
$mform->addElement('text', 'value', get_string('value', 'report_configlog'));
$mform->setType('value', PARAM_TEXT);
$mform->addHelpButton('value', 'value', 'report_configlog');
$mform->setAdvanced('value', true);
$mform->addElement('text', 'user', get_string('user', 'report_configlog'));
$mform->setType('user', PARAM_TEXT);
$mform->addHelpButton('user', 'user', 'report_configlog');
$mform->setAdvanced('user', true);
$mform->addElement('date_selector', 'datefrom', get_string('datefrom', 'report_configlog'), ['optional' => true]);
$mform->setAdvanced('datefrom', true);
$mform->addElement('date_selector', 'dateto', get_string('dateto', 'report_configlog'), ['optional' => true]);
$mform->setAdvanced('dateto', true);
$this->add_action_buttons(false, get_string('search'));
}
}

57
report/configlog/classes/output/renderer.php Normal file
View File

@ -0,0 +1,57 @@
<?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/>.
/**
* Plugin renderer class.
*
* @package report_configlog
* @copyright 2019 Paul Holden (pholden@greenhead.ac.uk)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace report_configlog\output;
defined('MOODLE_INTERNAL') || die();
/**
* Plugin renderer class.
*
* @package report_configlog
* @copyright 2019 Paul Holden (pholden@greenhead.ac.uk)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class renderer extends \plugin_renderer_base {
/** @var int Page size for displaying report table. */
const REPORT_TABLE_PAGESIZE = 30;
/**
* Return output to be rendered to page
*
* @param report_table $table
* @return string HTML rendered table
*/
protected function render_report_table(report_table $table) {
ob_start();
$table->out(self::REPORT_TABLE_PAGESIZE, false);
$output = ob_get_contents();
ob_end_clean();
return $output;
}
}

175
report/configlog/classes/output/report_table.php Normal file
View File

@ -0,0 +1,175 @@
<?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/>.
/**
* Report table class.
*
* @package report_configlog
* @copyright 2019 Paul Holden (pholden@greenhead.ac.uk)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace report_configlog\output;
defined('MOODLE_INTERNAL') || die();
require_once($CFG->libdir . '/searchlib.php');
require_once($CFG->libdir . '/tablelib.php');
/**
* Report table class.
*
* @package report_configlog
* @copyright 2019 Paul Holden (pholden@greenhead.ac.uk)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class report_table extends \table_sql implements \renderable {
/** @var string $search */
protected $search;
/**
* Constructor
*
* @param string $search
*/
public function __construct(string $search) {
parent::__construct('report-configlog-report-table');
$this->search = trim($search);
// Define columns.
$columns = [
'timemodified' => get_string('timemodified', 'report_configlog'),
'fullname' => get_string('name'),
'plugin' => get_string('plugin', 'report_configlog'),
'name' => get_string('setting', 'report_configlog'),
'value' => get_string('valuenew', 'report_configlog'),
'oldvalue' => get_string('valueold', 'report_configlog'),
];
$this->define_columns(array_keys($columns));
$this->define_headers(array_values($columns));
// Table configuration.
$this->set_attribute('id', $this->uniqueid);
$this->set_attribute('cellspacing', '0');
$this->sortable(true, 'timemodified', SORT_DESC);
$this->initialbars(false);
$this->collapsible(false);
$this->useridfield = 'userid';
// Initialize table SQL properties.
$this->init_sql();
}
/**
* Initializes table SQL properties
*
* @return void
*/
protected function init_sql() {
global $DB;
$userfields = get_all_user_name_fields(true, 'u');
$fields = 'cl.id, cl.timemodified, cl.plugin, cl.name, cl.value, cl.oldvalue, cl.userid, ' . $userfields;
$from = '{config_log} cl
JOIN {user} u ON u.id = cl.userid';
// Report search.
$where = '1=1';
$params = [];
if (!empty($this->search)) {
// Clean quotes, allow search by 'setting:' prefix.
$searchstring = str_replace(["\\\"", 'setting:'], ["\"", 'subject:'], $this->search);
$parser = new \search_parser();
$lexer = new \search_lexer($parser);
if ($lexer->parse($searchstring)) {
$parsearray = $parser->get_parsed_array();
// Data fields should contain both value/oldvalue.
$datafields = $DB->sql_concat_join("':'", ['cl.value', 'cl.oldvalue']);
list($where, $params) = search_generate_SQL($parsearray, $datafields, 'cl.name', 'cl.userid', 'u.id',
'u.firstname', 'u.lastname', 'cl.timemodified', 'cl.id');
}
}
$this->set_sql($fields, $from, $where, $params);
$this->set_count_sql('SELECT COUNT(1) FROM ' . $from . ' WHERE ' . $where, $params);
}
/**
* Cross DB text-compatible sorting for value/oldvalue fields
*
* @return string
*/
public function get_sql_sort() {
global $DB;
$sort = preg_replace_callback('/\b(value|oldvalue)\b/', function(array $matches) use ($DB) {
return $DB->sql_order_by_text($matches[1], 255);
}, parent::get_sql_sort());
return $sort;
}
/**
* Format report timemodified field
*
* @param stdClass $row
* @return string
*/
public function col_timemodified(\stdClass $row) {
return userdate($row->timemodified);
}
/**
* Format report plugin field
*
* @param stdClass $row
* @return string
*/
public function col_plugin(\stdClass $row) {
return $row->plugin ?? 'core';
}
/**
* Format report value field
*
* @param stdClass $row
* @return string
*/
public function col_value(\stdClass $row) {
return $this->format_text($row->value, FORMAT_PLAIN);
}
/**
* Format report old value field
*
* @param stdClass $row
* @return string
*/
public function col_oldvalue(\stdClass $row) {
return $this->format_text($row->oldvalue, FORMAT_PLAIN);;
}
}

128
report/configlog/index.php
View File

@ -26,111 +26,51 @@
require(__DIR__.'/../../config.php');
require_once($CFG->libdir.'/adminlib.php');
// page parameters
$page = optional_param('page', 0, PARAM_INT);
$perpage = optional_param('perpage', 30, PARAM_INT); // how many per page
$sort = optional_param('sort', 'timemodified', PARAM_ALPHA);
$dir = optional_param('dir', 'DESC', PARAM_ALPHA);
admin_externalpage_setup('reportconfiglog', '', null, '', array('pagelayout'=>'report'));
echo $OUTPUT->header();
echo $OUTPUT->header();
echo $OUTPUT->heading(get_string('configlog', 'report_configlog'));
$changescount = $DB->count_records('config_log');
$mform = new \report_configlog\form\search();
$columns = array('firstname' => get_string('firstname'),
'lastname' => get_string('lastname'),
'timemodified' => get_string('timemodified', 'report_configlog'),
'plugin' => get_string('plugin', 'report_configlog'),
'name' => get_string('setting', 'report_configlog'),
'value' => get_string('value', 'report_configlog'),
'oldvalue' => get_string('oldvalue', 'report_configlog'),
);
$hcolumns = array();
if (!isset($columns[$sort])) {
$sort = 'lastname';
/** @var cache_session $cache */
$cache = cache::make_from_params(cache_store::MODE_SESSION, 'report_customlog', 'search');
if ($cachedata = $cache->get('data')) {
$mform->set_data($cachedata);
}
foreach ($columns as $column=>$strcolumn) {
if ($sort != $column) {
$columnicon = '';
if ($column == 'lastaccess') {
$columndir = 'DESC';
} else {
$columndir = 'ASC';
}
} else {
$columndir = $dir == 'ASC' ? 'DESC':'ASC';
if ($column == 'lastaccess') {
$columnicon = $dir == 'ASC' ? 'up':'down';
} else {
$columnicon = $dir == 'ASC' ? 'down':'up';
}
$columnicon = $OUTPUT->pix_icon('t/' . $columnicon, '');
$searchclauses = [];
// Check if we have a form submission, or a cached submission.
$data = ($mform->is_submitted() ? $mform->get_data() : fullclone($cachedata));
if ($data instanceof stdClass) {
if (!empty($data->value)) {
$searchclauses[] = $data->value;
}
$hcolumns[$column] = "<a href=\"index.php?sort=$column&amp;dir=$columndir&amp;page=$page&amp;perpage=$perpage\">".$strcolumn."</a>$columnicon";
}
$baseurl = new moodle_url('index.php', array('sort' => $sort, 'dir' => $dir, 'perpage' => $perpage));
echo $OUTPUT->paging_bar($changescount, $page, $perpage, $baseurl);
$override = new stdClass();
$override->firstname = 'firstname';
$override->lastname = 'lastname';
$fullnamelanguage = get_string('fullnamedisplay', '', $override);
if (($CFG->fullnamedisplay == 'firstname lastname') or
($CFG->fullnamedisplay == 'firstname') or
($CFG->fullnamedisplay == 'language' and $fullnamelanguage == 'firstname lastname' )) {
$fullnamedisplay = $hcolumns['firstname'].' / '.$hcolumns['lastname'];
} else { // ($CFG->fullnamedisplay == 'language' and $fullnamelanguage == 'lastname firstname')
$fullnamedisplay = $hcolumns['lastname'].' / '.$hcolumns['firstname'];
}
$table = new html_table();
$table->head = array($hcolumns['timemodified'], $fullnamedisplay, $hcolumns['plugin'], $hcolumns['name'], $hcolumns['value'], $hcolumns['oldvalue']);
$table->colclasses = array('leftalign date', 'leftalign name', 'leftalign plugin', 'leftalign setting', 'leftalign newvalue', 'leftalign originalvalue');
$table->id = 'configchanges';
$table->attributes['class'] = 'admintable generaltable';
$table->data = array();
if ($sort == 'firstname' or $sort == 'lastname') {
$orderby = "u.$sort $dir";
} else if ($sort == 'value' or $sort == 'oldvalue') {
// cross-db text-compatible sorting.
$orderby = $DB->sql_order_by_text("cl.$sort", 255) . ' ' . $dir;
} else {
$orderby = "cl.$sort $dir";
}
$ufields = user_picture::fields('u');
$sql = "SELECT $ufields,
cl.timemodified, cl.plugin, cl.name, cl.value, cl.oldvalue
FROM {config_log} cl
JOIN {user} u ON u.id = cl.userid
ORDER BY $orderby";
$rs = $DB->get_recordset_sql($sql, array(), $page*$perpage, $perpage);
foreach ($rs as $log) {
$row = array();
$row[] = userdate($log->timemodified);
$row[] = fullname($log);
if (is_null($log->plugin)) {
$row[] = 'core';
} else {
$row[] = $log->plugin;
if (!empty($data->setting)) {
$searchclauses[] = "setting:{$data->setting}";
}
if (!empty($data->user)) {
$searchclauses[] = "user:{$data->user}";
}
if (!empty($data->datefrom)) {
$searchclauses[] = "datefrom:{$data->datefrom}";
}
if (!empty($data->dateto)) {
$dateto = $data->dateto + DAYSECS - 1;
$searchclauses[] = "dateto:{$dateto}";
}
$row[] = $log->name;
$row[] = s($log->value);
$row[] = s($log->oldvalue);
$table->data[] = $row;
// Cache form submission so that it is preserved while paging through the report.
unset($data->submitbutton);
$cache->set('data', $data);
}
$rs->close();
echo html_writer::table($table);
$mform->display();
echo $OUTPUT->footer();
$table = new \report_configlog\output\report_table(implode(' ', $searchclauses));
$table->define_baseurl($PAGE->url);
echo $PAGE->get_renderer('report_configlog')->render($table);
echo $OUTPUT->footer();

10
report/configlog/lang/en/report_configlog.php
View File

@ -24,10 +24,16 @@
*/
$string['configlog'] = 'Config changes';
$string['oldvalue'] = 'Original value';
$string['datefrom'] = 'Date from';
$string['dateto'] = 'Date to';
$string['plugin'] = 'Plugin';
$string['pluginname'] = 'Config changes';
$string['setting'] = 'Setting';
$string['timemodified'] = 'Date';
$string['value'] = 'New value';
$string['user'] = 'User';
$string['user_help'] = 'Search by user first name or surname';
$string['value'] = 'Value';
$string['value_help'] = 'Search by new or original value of the configuration';
$string['valuenew'] = 'New value';
$string['valueold'] = 'Original value';
$string['privacy:metadata'] = 'The Config changes plugin does not store any personal data.';

40
report/configlog/tests/behat/view_report.feature Normal file
View File

@ -0,0 +1,40 @@
@report @report_configlog
Feature: In a report, admin can see configuration changes
In order see configuration changes
As an admin
I need to view the configuration changes report and use search to filter the report
# Set some config values so the report contains known data.
Background:
Given I log in as "admin"
And I change the window size to "large"
And I set the following administration settings values:
| Initial number of overall feedback fields | 5 |
| Maximum folder download size | 2048 |
| Default city | Perth |
@javascript
Scenario: Display configuration changes report
When I navigate to "Reports > Config changes" in site administration
Then the following should exist in the "report-configlog-report-table" table:
| User | Plugin | Setting | New value | Original value |
| Admin User | quiz | initialnumfeedbacks | 5 | 2 |
| Admin User | folder | maxsizetodownload | 2048 | 0 |
| Admin User | core | defaultcity | Perth | |
@javascript
Scenario Outline: Search configuration changes report
When I navigate to "Reports > Config changes" in site administration
And I click on "Show more..." "link"
And I set the field "<field>" to "<search>"
And I click on "Search" "button" in the "#fitem_id_submitbutton" "css_element"
Then the following should exist in the "report-configlog-report-table" table:
| Plugin | Setting | New value |
| <plugin> | <setting> | <value> |
And I should not see "<excluded>" in the "report-configlog-report-table" "table"
Examples:
| field | search | plugin | setting | value | excluded |
| Setting | initialnumfeedbacks | quiz | initialnumfeedbacks | 5 | maxsizetodownload |
| Setting | maxsizetodownload | folder | maxsizetodownload | 2048 | initialnumfeedbacks |
| Value | Perth | core | defaultcity | Perth | maxsizetodownload |
| User | Admin | core | defaultcity | Perth | zzzzzzzzz |

2
report/configlog/version.php
View File

@ -25,6 +25,6 @@
defined('MOODLE_INTERNAL') || die;
$plugin->version = 2019111800; // The current plugin version (Date: YYYYMMDDXX)
$plugin->version = 2019120200; // The current plugin version (Date: YYYYMMDDXX)
$plugin->requires = 2019111200; // Requires this Moodle version
$plugin->component = 'report_configlog'; // Full name of the plugin (used for diagnostics)