first commit

admin/classes/reportbuilder/datasource/task_logs.php

@@ -0,0 +1,128 @@
+<?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/>.
+
+declare(strict_types=1);
+
+namespace core_admin\reportbuilder\datasource;
+
+use core_admin\reportbuilder\local\entities\task_log;
+use core_reportbuilder\datasource;
+use core_reportbuilder\local\entities\user;
+use core_reportbuilder\local\filters\select;
+
+/**
+ * Task logs datasource
+ *
+ * @package     core_admin
+ * @copyright   2022 Paul Holden <paulh@moodle.com>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class task_logs extends datasource {
+
+    /**
+     * Return user friendly name of the report source
+     *
+     * @return string
+     */
+    public static function get_name(): string {
+        return get_string('tasklogs', 'core_admin');
+    }
+
+    /**
+     * Initialise report
+     */
+    protected function initialise(): void {
+        $tasklogentity = new task_log();
+
+        $tasklogalias = $tasklogentity->get_table_alias('task_log');
+        $this->set_main_table('task_log', $tasklogalias);
+
+        $this->add_entity($tasklogentity);
+
+        // Join the user entity to represent the associated user.
+        $userentity = new user();
+        $useralias = $userentity->get_table_alias('user');
+        $this->add_entity($userentity->add_join("
+            LEFT JOIN {user} {$useralias}
+                   ON {$useralias}.id = {$tasklogalias}.userid")
+        );
+
+        // Add report elements from each of the entities we added to the report.
+        $this->add_all_from_entities();
+    }
+
+    /**
+     * Return the columns that will be added to the report upon creation
+     *
+     * @return string[]
+     */
+    public function get_default_columns(): array {
+        return [
+            'task_log:name',
+            'task_log:starttime',
+            'task_log:duration',
+            'task_log:result',
+        ];
+    }
+
+    /**
+     * Return the column sorting that will be added to the report upon creation
+     *
+     * @return int[]
+     */
+    public function get_default_column_sorting(): array {
+        return [
+            'task_log:starttime' => SORT_DESC,
+        ];
+    }
+
+    /**
+     * Return the filters that will be added to the report upon creation
+     *
+     * @return string[]
+     */
+    public function get_default_filters(): array {
+        return [
+            'task_log:timestart',
+            'task_log:result',
+        ];
+    }
+
+    /**
+     * Return the conditions that will be added to the report upon creation
+     *
+     * @return string[]
+     */
+    public function get_default_conditions(): array {
+        return [
+            'task_log:type',
+            'task_log:timestart',
+            'task_log:result',
+        ];
+    }
+
+    /**
+     * Return the condition values that will be set for the report upon creation
+     *
+     * @return array
+     */
+    public function get_default_condition_values(): array {
+        return [
+            'task_log:type_operator' => select::EQUAL_TO,
+            'task_log:type_value' => \core\task\database_logger::TYPE_SCHEDULED,
+        ];
+    }
+}

admin/classes/reportbuilder/local/entities/task_log.php

@@ -0,0 +1,429 @@
+<?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/>.
+
+namespace core_admin\reportbuilder\local\entities;
+
+use core_reportbuilder\local\filters\date;
+use core_reportbuilder\local\filters\duration;
+use core_reportbuilder\local\filters\number;
+use core_reportbuilder\local\filters\select;
+use core_reportbuilder\local\filters\text;
+use core_reportbuilder\local\filters\autocomplete;
+use core_reportbuilder\local\helpers\format;
+use lang_string;
+use core_reportbuilder\local\entities\base;
+use core_reportbuilder\local\report\column;
+use core_reportbuilder\local\report\filter;
+use stdClass;
+use core_collator;
+
+/**
+ * Task log entity class implementation
+ *
+ * @package    core_admin
+ * @copyright  2021 David Matamoros <davidmc@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class task_log extends base {
+
+    /** @var int Result success */
+    protected const SUCCESS = 0;
+
+    /** @var int Result failed */
+    protected const FAILED = 1;
+
+    /**
+     * Database tables that this entity uses
+     *
+     * @return string[]
+     */
+    protected function get_default_tables(): array {
+        return [
+            'task_log',
+        ];
+    }
+
+    /**
+     * The default title for this entity in the list of columns/conditions/filters in the report builder
+     *
+     * @return lang_string
+     */
+    protected function get_default_entity_title(): lang_string {
+        return new lang_string('entitytasklog', 'admin');
+    }
+
+    /**
+     * Initialise the entity
+     *
+     * @return base
+     */
+    public function initialise(): base {
+        $columns = $this->get_all_columns();
+        foreach ($columns as $column) {
+            $this->add_column($column);
+        }
+
+        // All the filters defined by the entity can also be used as conditions.
+        $filters = $this->get_all_filters();
+        foreach ($filters as $filter) {
+            $this
+                ->add_filter($filter)
+                ->add_condition($filter);
+        }
+
+        return $this;
+    }
+
+    /**
+     * Returns list of all available columns
+     *
+     * @return column[]
+     */
+    protected function get_all_columns(): array {
+        global $DB;
+
+        $tablealias = $this->get_table_alias('task_log');
+
+        // Name column.
+        $columns[] = (new column(
+            'name',
+            new lang_string('name'),
+            $this->get_entity_name()
+        ))
+            ->add_joins($this->get_joins())
+            ->set_type(column::TYPE_TEXT)
+            ->add_field("$tablealias.classname")
+            ->set_is_sortable(true)
+            ->add_callback(static function(string $classname): string {
+                $output = '';
+                if (class_exists($classname)) {
+                    $task = new $classname;
+                    if ($task instanceof \core\task\task_base) {
+                        $output = $task->get_name();
+                    }
+                }
+                $output .= \html_writer::tag('div', "\\{$classname}", [
+                    'class' => 'small text-muted',
+                ]);
+                return $output;
+            });
+
+        // Component column.
+        $columns[] = (new column(
+            'component',
+            new lang_string('plugin'),
+            $this->get_entity_name()
+        ))
+            ->add_joins($this->get_joins())
+            ->set_type(column::TYPE_TEXT)
+            ->add_field("{$tablealias}.component")
+            ->set_is_sortable(true);
+
+        // Type column.
+        $columns[] = (new column(
+            'type',
+            new lang_string('tasktype', 'admin'),
+            $this->get_entity_name()
+        ))
+            ->add_joins($this->get_joins())
+            ->set_type(column::TYPE_TEXT)
+            ->add_field("{$tablealias}.type")
+            ->set_is_sortable(true)
+            ->add_callback(static function($value): string {
+                if (\core\task\database_logger::TYPE_SCHEDULED === (int) $value) {
+                    return get_string('task_type:scheduled', 'admin');
+                }
+                return get_string('task_type:adhoc', 'admin');
+            });
+
+        // Start time column.
+        $columns[] = (new column(
+            'starttime',
+            new lang_string('task_starttime', 'admin'),
+            $this->get_entity_name()
+        ))
+            ->add_joins($this->get_joins())
+            ->set_type(column::TYPE_TIMESTAMP)
+            ->add_field("{$tablealias}.timestart")
+            ->set_is_sortable(true)
+            ->add_callback([format::class, 'userdate'], get_string('strftimedatetimeshortaccurate', 'core_langconfig'));
+
+        // End time column.
+        $columns[] = (new column(
+            'endtime',
+            new lang_string('task_endtime', 'admin'),
+            $this->get_entity_name()
+        ))
+            ->add_joins($this->get_joins())
+            ->set_type(column::TYPE_TIMESTAMP)
+            ->add_field("{$tablealias}.timeend")
+            ->set_is_sortable(true)
+            ->add_callback([format::class, 'userdate'], get_string('strftimedatetimeshortaccurate', 'core_langconfig'));
+
+        // Duration column.
+        $columns[] = (new column(
+            'duration',
+            new lang_string('task_duration', 'admin'),
+            $this->get_entity_name()
+        ))
+            ->add_joins($this->get_joins())
+            ->set_type(column::TYPE_FLOAT)
+            ->add_field("{$tablealias}.timeend - {$tablealias}.timestart", 'duration')
+            ->set_is_sortable(true)
+            ->add_callback(static function(float $value): string {
+                $duration = round($value, 2);
+                if (empty($duration)) {
+                    // The format_time function returns 'now' when the difference is exactly 0.
+                    // Note: format_time performs concatenation in exactly this fashion so we should do this for consistency.
+                    return '0 ' . get_string('secs', 'moodle');
+                }
+                return format_time($duration);
+            });
+
+        // Hostname column.
+        $columns[] = (new column(
+            'hostname',
+            new lang_string('hostname', 'admin'),
+            $this->get_entity_name()
+        ))
+            ->add_joins($this->get_joins())
+            ->set_type(column::TYPE_TEXT)
+            ->add_field("$tablealias.hostname")
+            ->set_is_sortable(true);
+
+        // PID column.
+        $columns[] = (new column(
+            'pid',
+            new lang_string('pid', 'admin'),
+            $this->get_entity_name()
+        ))
+            ->add_joins($this->get_joins())
+            ->set_type(column::TYPE_INTEGER)
+            ->add_field("{$tablealias}.pid")
+            ->set_is_sortable(true)
+            // Although this is an integer column, it doesn't make sense to perform numeric aggregation on it.
+            ->set_disabled_aggregation(['avg', 'count', 'countdistinct', 'max', 'min', 'sum']);
+
+        // Database column.
+        $columns[] = (new column(
+            'database',
+            new lang_string('task_dbstats', 'admin'),
+            $this->get_entity_name()
+        ))
+            ->add_joins($this->get_joins())
+            ->set_type(column::TYPE_INTEGER)
+            ->add_fields("{$tablealias}.dbreads, {$tablealias}.dbwrites")
+            ->set_is_sortable(true, ["{$tablealias}.dbreads", "{$tablealias}.dbwrites"])
+            ->add_callback(static function(int $value, stdClass $row): string {
+                $output = '';
+                $output .= \html_writer::div(get_string('task_stats:dbreads', 'admin', $row->dbreads));
+                $output .= \html_writer::div(get_string('task_stats:dbwrites', 'admin', $row->dbwrites));
+                return $output;
+            })
+            // Although this is an integer column, it doesn't make sense to perform numeric aggregation on it.
+            ->set_disabled_aggregation(['avg', 'count', 'countdistinct', 'max', 'min', 'sum']);
+
+        // Database reads column.
+        $columns[] = (new column(
+            'dbreads',
+            new lang_string('task_dbreads', 'admin'),
+            $this->get_entity_name()
+        ))
+            ->add_joins($this->get_joins())
+            ->set_type(column::TYPE_INTEGER)
+            ->add_fields("{$tablealias}.dbreads")
+            ->set_is_sortable(true);
+
+        // Database writes column.
+        $columns[] = (new column(
+            'dbwrites',
+            new lang_string('task_dbwrites', 'admin'),
+            $this->get_entity_name()
+        ))
+            ->add_joins($this->get_joins())
+            ->set_type(column::TYPE_INTEGER)
+            ->add_fields("{$tablealias}.dbwrites")
+            ->set_is_sortable(true);
+
+        // Result column.
+        $columns[] = (new column(
+            'result',
+            new lang_string('task_result', 'admin'),
+            $this->get_entity_name()
+        ))
+            ->add_joins($this->get_joins())
+            ->set_type(column::TYPE_BOOLEAN)
+            // For accurate aggregation, we need to return boolean success = true by xor'ing the field value.
+            ->add_field($DB->sql_bitxor("{$tablealias}.result", 1), 'success')
+            ->set_is_sortable(true)
+            ->add_callback(static function(bool $success): string {
+                if (!$success) {
+                    return get_string('task_result:failed', 'admin');
+                }
+                return get_string('success');
+            });
+
+        return $columns;
+    }
+
+    /**
+     * Return list of all available filters
+     *
+     * @return filter[]
+     */
+    protected function get_all_filters(): array {
+        global $DB;
+
+        $tablealias = $this->get_table_alias('task_log');
+
+        // Name filter (Filter by classname).
+        $filters[] = (new filter(
+            autocomplete::class,
+            'name',
+            new lang_string('classname', 'tool_task'),
+            $this->get_entity_name(),
+            "{$tablealias}.classname"
+        ))
+            ->add_joins($this->get_joins())
+            ->set_options_callback(static function(): array {
+                global $DB;
+                $classnames = $DB->get_fieldset_sql('SELECT DISTINCT classname FROM {task_log} ORDER BY classname ASC');
+
+                $options = [];
+                foreach ($classnames as $classname) {
+                    if (class_exists($classname)) {
+                        $task = new $classname;
+                        $options[$classname] = $task->get_name();
+                    }
+                }
+
+                core_collator::asort($options);
+                return $options;
+            });
+
+        // Component filter.
+        $filters[] = (new filter(
+            text::class,
+            'component',
+            new lang_string('plugin'),
+            $this->get_entity_name(),
+            "{$tablealias}.component"
+        ))
+            ->add_joins($this->get_joins());
+
+        // Type filter.
+        $filters[] = (new filter(
+            select::class,
+            'type',
+            new lang_string('tasktype', 'admin'),
+            $this->get_entity_name(),
+            "{$tablealias}.type"
+        ))
+            ->add_joins($this->get_joins())
+            ->set_options([
+                \core\task\database_logger::TYPE_ADHOC => new lang_string('task_type:adhoc', 'admin'),
+                \core\task\database_logger::TYPE_SCHEDULED => new lang_string('task_type:scheduled', 'admin'),
+            ]);
+
+        // Output filter (Filter by task output).
+        $filters[] = (new filter(
+            text::class,
+            'output',
+            new lang_string('task_logoutput', 'admin'),
+            $this->get_entity_name(),
+            $DB->sql_cast_to_char("{$tablealias}.output")
+        ))
+            ->add_joins($this->get_joins());
+
+        // Start time filter.
+        $filters[] = (new filter(
+            date::class,
+            'timestart',
+            new lang_string('task_starttime', 'admin'),
+            $this->get_entity_name(),
+            "{$tablealias}.timestart"
+        ))
+            ->add_joins($this->get_joins())
+            ->set_limited_operators([
+                date::DATE_ANY,
+                date::DATE_RANGE,
+                date::DATE_PREVIOUS,
+                date::DATE_CURRENT,
+            ]);
+
+        // End time.
+        $filters[] = (new filter(
+            date::class,
+            'timeend',
+            new lang_string('task_endtime', 'admin'),
+            $this->get_entity_name(),
+            "{$tablealias}.timeend"
+        ))
+            ->add_joins($this->get_joins())
+            ->set_limited_operators([
+                date::DATE_ANY,
+                date::DATE_RANGE,
+                date::DATE_PREVIOUS,
+                date::DATE_CURRENT,
+            ]);
+
+        // Duration filter.
+        $filters[] = (new filter(
+            duration::class,
+            'duration',
+            new lang_string('task_duration', 'admin'),
+            $this->get_entity_name(),
+            "{$tablealias}.timeend - {$tablealias}.timestart"
+        ))
+            ->add_joins($this->get_joins());
+
+        // Database reads.
+        $filters[] = (new filter(
+            number::class,
+            'dbreads',
+            new lang_string('task_dbreads', 'admin'),
+            $this->get_entity_name(),
+            "{$tablealias}.dbreads"
+        ))
+            ->add_joins($this->get_joins());
+
+        // Database writes.
+        $filters[] = (new filter(
+            number::class,
+            'dbwrites',
+            new lang_string('task_dbwrites', 'admin'),
+            $this->get_entity_name(),
+            "{$tablealias}.dbwrites"
+        ))
+            ->add_joins($this->get_joins());
+
+        // Result filter.
+        $filters[] = (new filter(
+            select::class,
+            'result',
+            new lang_string('task_result', 'admin'),
+            $this->get_entity_name(),
+            "{$tablealias}.result"
+        ))
+            ->add_joins($this->get_joins())
+            ->set_options([
+                self::SUCCESS => get_string('success'),
+                self::FAILED => get_string('task_result:failed', 'admin'),
+            ]);
+
+        return $filters;
+    }
+}

admin/classes/reportbuilder/local/filters/courserole.php

@@ -0,0 +1,108 @@
+<?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/>.
+
+declare(strict_types=1);
+
+namespace core_admin\reportbuilder\local\filters;
+
+use core\context\system;
+use core_course_category;
+use MoodleQuickForm;
+use core_reportbuilder\local\filters\base;
+use core_reportbuilder\local\helpers\database;
+
+/**
+ * Course role report filter (by role, category, course)
+ *
+ * The provided filter field SQL must refer/return an expression for the user ID (e.g. "{$user}.id")
+ *
+ * @package     core_admin
+ * @copyright   2023 Paul Holden <paulh@moodle.com>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class courserole extends base {
+
+    /**
+     * Setup form
+     *
+     * @param MoodleQuickForm $mform
+     */
+    public function setup_form(MoodleQuickForm $mform): void {
+        $elements = [];
+
+        // Role.
+        $elements['role'] = $mform->createElement('select', "{$this->name}_role", get_string('rolefullname', 'core_role'),
+            [0 => get_string('anyrole', 'core_filters')] + get_default_enrol_roles(system::instance()));
+
+        // Category.
+        $elements['category'] = $mform->createElement('select', "{$this->name}_category", get_string('category'),
+            [0 => get_string('anycategory', 'core_filters')] + core_course_category::make_categories_list());
+
+        // Course.
+        $elements['course'] = $mform->createElement('text', "{$this->name}_course", get_string('shortnamecourse'));
+        $mform->setType("{$this->name}_course", PARAM_RAW_TRIMMED);
+
+        $mform->addGroup($elements, "{$this->name}_group", $this->get_header(), '', false)
+            ->setHiddenLabel(true);
+    }
+
+    /**
+     * Return filter SQL
+     *
+     * @param array $values
+     * @return array
+     */
+    public function get_sql_filter(array $values): array {
+        [$fieldsql, $params] = $this->filter->get_field_sql_and_params();
+
+        [$contextalias, $rolealias, $coursealias] = database::generate_aliases(3);
+        [$roleparam, $categoryparam, $courseparam] = database::generate_param_names(3);
+
+        // Role.
+        $role = (int) ($values["{$this->name}_role"] ?? 0);
+        if ($role > 0) {
+            $selects[] = "{$rolealias}.roleid = :{$roleparam}";
+            $params[$roleparam] = $role;
+        }
+
+        // Category.
+        $category = (int) ($values["{$this->name}_category"] ?? 0);
+        if ($category > 0) {
+            $selects[] = "{$coursealias}.category = :{$categoryparam}";
+            $params[$categoryparam] = $category;
+        }
+
+        // Course.
+        $course = trim($values["{$this->name}_course"] ?? '');
+        if ($course !== '') {
+            $selects[] = "{$coursealias}.shortname = :{$courseparam}";
+            $params[$courseparam] = $course;
+        }
+
+        // Filter values are not set.
+        if (empty($selects)) {
+            return ['', []];
+        }
+
+        return ["{$fieldsql} IN (
+            SELECT {$rolealias}.userid
+              FROM {role_assignments} {$rolealias}
+              JOIN {context} {$contextalias} ON {$contextalias}.id = {$rolealias}.contextid AND {$contextalias}.contextlevel = 50
+              JOIN {course} {$coursealias} ON {$coursealias}.id = {$contextalias}.instanceid
+             WHERE " . implode(' AND ', $selects)  . "
+        )", $params];
+    }
+}

admin/classes/reportbuilder/local/systemreports/task_logs.php

@@ -0,0 +1,159 @@
+<?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/>.
+
+namespace core_admin\reportbuilder\local\systemreports;
+
+use context_system;
+use core_admin\reportbuilder\local\entities\task_log;
+use core_reportbuilder\local\entities\user;
+use core_reportbuilder\local\report\action;
+use lang_string;
+use moodle_url;
+use pix_icon;
+use core_reportbuilder\system_report;
+
+/**
+ * Task logs system report class implementation
+ *
+ * @package    core_admin
+ * @copyright  2021 David Matamoros <davidmc@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class task_logs extends system_report {
+
+    /**
+     * Initialise report, we need to set the main table, load our entities and set columns/filters
+     */
+    protected function initialise(): void {
+        // Our main entity, it contains all of the column definitions that we need.
+        $entitymain = new task_log();
+        $entitymainalias = $entitymain->get_table_alias('task_log');
+
+        $this->set_main_table('task_log', $entitymainalias);
+        $this->add_entity($entitymain);
+
+        // Any columns required by actions should be defined here to ensure they're always available.
+        $this->add_base_fields("{$entitymainalias}.id");
+
+        // We can join the "user" entity to our "main" entity and use the fullname column from the user entity.
+        $entityuser = new user();
+        $entituseralias = $entityuser->get_table_alias('user');
+        $this->add_entity($entityuser->add_join(
+            "LEFT JOIN {user} {$entituseralias} ON {$entituseralias}.id = {$entitymainalias}.userid"
+        ));
+
+        // Now we can call our helper methods to add the content we want to include in the report.
+        $this->add_columns();
+        $this->add_filters();
+        $this->add_actions();
+
+        // Set if report can be downloaded.
+        $this->set_downloadable(true, get_string('tasklogs', 'admin'));
+    }
+
+    /**
+     * Validates access to view this report
+     *
+     * @return bool
+     */
+    protected function can_view(): bool {
+        return has_capability('moodle/site:config', context_system::instance());
+    }
+
+    /**
+     * Get the visible name of the report
+     *
+     * @return string
+     */
+    public static function get_name(): string {
+        return get_string('entitytasklog', 'admin');
+    }
+
+    /**
+     * Adds the columns we want to display in the report
+     *
+     * They are all provided by the entities we previously added in the {@see initialise} method, referencing each by their
+     * unique identifier
+     */
+    public function add_columns(): void {
+        $columns = [
+            'task_log:name',
+            'task_log:type',
+            'user:fullname',
+            'task_log:starttime',
+            'task_log:duration',
+            'task_log:hostname',
+            'task_log:pid',
+            'task_log:database',
+            'task_log:result',
+        ];
+
+        $this->add_columns_from_entities($columns);
+
+        // It's possible to override the display name of a column, if you don't want to use the value provided by the entity.
+        if ($column = $this->get_column('user:fullname')) {
+            $column->set_title(new lang_string('user', 'admin'));
+        }
+
+        // It's possible to set a default initial sort direction for one column.
+        $this->set_initial_sort_column('task_log:starttime', SORT_DESC);
+    }
+
+    /**
+     * Adds the filters we want to display in the report
+     *
+     * They are all provided by the entities we previously added in the {@see initialise} method, referencing each by their
+     * unique identifier
+     */
+    protected function add_filters(): void {
+        $filters = [
+            'task_log:name',
+            'task_log:type',
+            'task_log:output',
+            'task_log:result',
+            'task_log:timestart',
+            'task_log:duration',
+        ];
+
+        $this->add_filters_from_entities($filters);
+    }
+
+    /**
+     * Add the system report actions. An extra column will be appended to each row, containing all actions added here
+     *
+     * Note the use of ":id" placeholder which will be substituted according to actual values in the row
+     */
+    protected function add_actions(): void {
+
+        // Action to view individual task log on a popup window.
+        $this->add_action((new action(
+            new moodle_url('/admin/tasklogs.php', ['logid' => ':id']),
+            new pix_icon('e/search', ''),
+            [],
+            true,
+            new lang_string('view'),
+        )));
+
+        // Action to download individual task log.
+        $this->add_action((new action(
+            new moodle_url('/admin/tasklogs.php', ['logid' => ':id', 'download' => true]),
+            new pix_icon('t/download', ''),
+            [],
+            false,
+            new lang_string('download'),
+        )));
+    }
+}

admin/classes/reportbuilder/local/systemreports/users.php

@@ -0,0 +1,417 @@
+<?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/>.
+
+namespace core_admin\reportbuilder\local\systemreports;
+
+use core_admin\reportbuilder\local\filters\courserole;
+use core\context\system;
+use core_cohort\reportbuilder\local\entities\cohort;
+use core_cohort\reportbuilder\local\entities\cohort_member;
+use core_reportbuilder\local\entities\user;
+use core_reportbuilder\local\filters\boolean_select;
+use core_reportbuilder\local\helpers\database;
+use core_reportbuilder\local\helpers\user_profile_fields;
+use core_reportbuilder\local\report\action;
+use core_reportbuilder\local\report\filter;
+use core_reportbuilder\system_report;
+use core_role\reportbuilder\local\entities\role;
+use core_user\fields;
+use lang_string;
+use moodle_url;
+use pix_icon;
+
+defined('MOODLE_INTERNAL') || die();
+
+require_once($CFG->libdir.'/adminlib.php');
+require_once($CFG->libdir.'/authlib.php');
+require_once($CFG->libdir.'/enrollib.php');
+require_once($CFG->dirroot.'/user/lib.php');
+
+/**
+ * Browse users system report class implementation
+ *
+ * @package    core_admin
+ * @copyright  2023 David Carrillo <davidmc@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class users extends system_report {
+
+    /**
+     * Initialise report, we need to set the main table, load our entities and set columns/filters
+     */
+    protected function initialise(): void {
+        global $CFG;
+
+        // Our main entity, it contains all of the column definitions that we need.
+        $entityuser = new user();
+        $entityuseralias = $entityuser->get_table_alias('user');
+
+        $this->set_main_table('user', $entityuseralias);
+        $this->add_entity($entityuser);
+
+        // Any columns required by actions should be defined here to ensure they're always available.
+        $fullnamefields = array_map(fn($field) => "{$entityuseralias}.{$field}", fields::get_name_fields());
+        $this->add_base_fields("{$entityuseralias}.id, {$entityuseralias}.confirmed, {$entityuseralias}.mnethostid,
+            {$entityuseralias}.suspended, {$entityuseralias}.username, " . implode(', ', $fullnamefields));
+
+        if ($this->get_parameter('withcheckboxes', false, PARAM_BOOL)) {
+            $canviewfullnames = has_capability('moodle/site:viewfullnames', \context_system::instance());
+            $this->set_checkbox_toggleall(static function(\stdClass $row) use ($canviewfullnames): array {
+                return [$row->id, fullname($row, $canviewfullnames)];
+            });
+        }
+
+        $paramguest = database::generate_param_name();
+        $this->add_base_condition_sql("{$entityuseralias}.deleted <> 1 AND {$entityuseralias}.id <> :{$paramguest}",
+            [$paramguest => $CFG->siteguest]);
+
+        $entitycohortmember = new cohort_member();
+        $entitycohortmemberalias = $entitycohortmember->get_table_alias('cohort_members');
+        $this->add_entity($entitycohortmember
+            ->add_joins($entitycohortmember->get_joins())
+            ->add_join("LEFT JOIN {cohort_members} {$entitycohortmemberalias}
+                ON {$entityuseralias}.id = {$entitycohortmemberalias}.userid")
+        );
+
+        $entitycohort = new cohort();
+        $entitycohortalias = $entitycohort->get_table_alias('cohort');
+        $this->add_entity($entitycohort
+            ->add_joins($entitycohort->get_joins())
+            ->add_joins($entitycohortmember->get_joins())
+            ->add_join("LEFT JOIN {cohort} {$entitycohortalias}
+                ON {$entitycohortalias}.id = {$entitycohortmemberalias}.cohortid")
+        );
+
+        // Join the role entity (Needed for the system role filter).
+        $roleentity = new role();
+        $role = $roleentity->get_table_alias('role');
+        $this->add_entity($roleentity
+            ->add_join("LEFT JOIN (
+                SELECT DISTINCT r0.id, ras.userid
+                FROM {role} r0
+                JOIN {role_assignments} ras ON ras.roleid = r0.id
+                WHERE ras.contextid = ".SYSCONTEXTID."
+             ) {$role} ON {$role}.userid = {$entityuseralias}.id")
+        );
+
+        // Now we can call our helper methods to add the content we want to include in the report.
+        $this->add_columns();
+        $this->add_filters();
+        $this->add_actions();
+
+        // Set if report can be downloaded.
+        $this->set_downloadable(true);
+    }
+
+    /**
+     * Validates access to view this report
+     *
+     * @return bool
+     */
+    protected function can_view(): bool {
+        return has_any_capability(['moodle/user:update', 'moodle/user:delete'], system::instance());
+    }
+
+    /**
+     * Adds the columns we want to display in the report
+     *
+     * They are all provided by the entities we previously added in the {@see initialise} method, referencing each by their
+     * unique identifier
+     */
+    public function add_columns(): void {
+        $entityuser = $this->get_entity('user');
+        $entityuseralias = $entityuser->get_table_alias('user');
+
+        $this->add_column($entityuser->get_column('fullnamewithpicturelink'));
+
+        // Include identity field columns.
+        $identitycolumns = $entityuser->get_identity_columns($this->get_context());
+        foreach ($identitycolumns as $identitycolumn) {
+            $this->add_column($identitycolumn);
+        }
+
+        // Add "Last access" column.
+        $this->add_column(($entityuser->get_column('lastaccess'))
+            ->set_callback(static function ($value, \stdClass $row): string {
+                if ($row->lastaccess) {
+                    return format_time(time() - $row->lastaccess);
+                }
+                return get_string('never');
+            })
+        );
+
+        if ($column = $this->get_column('user:fullnamewithpicturelink')) {
+            $column
+                ->add_fields("{$entityuseralias}.suspended, {$entityuseralias}.confirmed")
+                ->add_callback(static function(string $fullname, \stdClass $row): string {
+                    if ($row->suspended) {
+                        $fullname .= ' ' . \html_writer::tag('span', get_string('suspended', 'moodle'),
+                            ['class' => 'badge badge-secondary ml-1']);
+                    }
+                    if (!$row->confirmed) {
+                        $fullname .= ' ' . \html_writer::tag('span', get_string('confirmationpending', 'admin'),
+                            ['class' => 'badge badge-danger ml-1']);
+                    }
+                    return $fullname;
+                });
+        }
+
+        $this->set_initial_sort_column('user:fullnamewithpicturelink', SORT_ASC);
+        $this->set_default_no_results_notice(new lang_string('nousersfound', 'moodle'));
+    }
+
+    /**
+     * Adds the filters we want to display in the report
+     *
+     * They are all provided by the entities we previously added in the {@see initialise} method, referencing each by their
+     * unique identifier
+     */
+    protected function add_filters(): void {
+        $entityuser = $this->get_entity('user');
+        $entityuseralias = $entityuser->get_table_alias('user');
+
+        $filters = [
+            'user:fullname',
+            'user:firstname',
+            'user:lastname',
+            'user:username',
+            'user:idnumber',
+            'user:email',
+            'user:department',
+            'user:institution',
+            'user:city',
+            'user:country',
+            'user:confirmed',
+            'user:suspended',
+            'user:timecreated',
+            'user:lastaccess',
+            'user:timemodified',
+            'user:auth',
+            'user:lastip',
+            'cohort:idnumber',
+            'role:name',
+        ];
+        $this->add_filters_from_entities($filters);
+
+        // Enrolled in any course filter.
+        $ue = database::generate_alias();
+        [$now1, $now2] = database::generate_param_names(2);
+        $now = time();
+        $sql = "CASE WHEN ({$entityuseralias}.id IN (
+            SELECT userid FROM {user_enrolments} {$ue}
+            WHERE {$ue}.status = " . ENROL_USER_ACTIVE . "
+            AND ({$ue}.timestart = 0 OR {$ue}.timestart < :{$now1})
+            AND ({$ue}.timeend = 0 OR {$ue}.timeend > :{$now2})
+            )) THEN 1 ELSE 0 END";
+
+        $this->add_filter((new filter(
+            boolean_select::class,
+            'enrolledinanycourse',
+            new lang_string('anycourses', 'filters'),
+            $this->get_entity('user')->get_entity_name(),
+        ))
+            ->set_field_sql($sql, [
+                $now1 => $now,
+                $now2 => $now,
+            ])
+        );
+
+        // Course role filter.
+        $this->add_filter((new filter(
+            courserole::class,
+            'courserole',
+            new lang_string('courserole', 'filters'),
+            $this->get_entity('user')->get_entity_name(),
+        ))
+            ->set_field_sql("{$entityuseralias}.id")
+        );
+
+        // Add user profile fields filters.
+        $userprofilefields = new user_profile_fields($entityuseralias . '.id', $entityuser->get_entity_name());
+        foreach ($userprofilefields->get_filters() as $filter) {
+            $this->add_filter($filter);
+        }
+
+        // Set options for system role filter.
+        if ($filter = $this->get_filter('role:name')) {
+            $filter
+                ->set_header(new lang_string('globalrole', 'role'))
+                ->set_options(get_assignable_roles(system::instance()));
+        }
+    }
+
+    /**
+     * Add the system report actions. An extra column will be appended to each row, containing all actions added here
+     *
+     * Note the use of ":id" placeholder which will be substituted according to actual values in the row
+     */
+    protected function add_actions(): void {
+        global $DB, $USER;
+
+        $contextsystem = system::instance();
+
+        // Action to edit users.
+        $this->add_action((new action(
+            new moodle_url('/user/editadvanced.php', ['id' => ':id', 'course' => get_site()->id]),
+            new pix_icon('t/edit', ''),
+            [],
+            false,
+            new lang_string('edit', 'moodle'),
+        ))->add_callback(static function(\stdclass $row) use ($USER, $contextsystem): bool {
+            return has_capability('moodle/user:update', $contextsystem) && (is_siteadmin($USER) || !is_siteadmin($row));
+        }));
+
+        // Action to suspend users (non mnet remote users).
+        $this->add_action((new action(
+            new moodle_url('/admin/user.php', ['suspend' => ':id', 'sesskey' => sesskey()]),
+            new pix_icon('t/show', ''),
+            [],
+            false,
+            new lang_string('suspenduser', 'admin'),
+        ))->add_callback(static function(\stdclass $row) use ($USER, $contextsystem): bool {
+            return has_capability('moodle/user:update', $contextsystem) && !$row->suspended && !is_mnet_remote_user($row) &&
+                !($row->id == $USER->id || is_siteadmin($row));
+        }));
+
+        // Action to unsuspend users (non mnet remote users).
+        $this->add_action((new action(
+            new moodle_url('/admin/user.php', ['unsuspend' => ':id', 'sesskey' => sesskey()]),
+            new pix_icon('t/hide', ''),
+            [],
+            false,
+            new lang_string('unsuspenduser', 'admin'),
+        ))->add_callback(static function(\stdclass $row) use ($USER, $contextsystem): bool {
+            return has_capability('moodle/user:update', $contextsystem) && $row->suspended && !is_mnet_remote_user($row) &&
+                !($row->id == $USER->id || is_siteadmin($row));
+        }));
+
+        // Action to unlock users (non mnet remote users).
+        $this->add_action((new action(
+            new moodle_url('/admin/user.php', ['unlock' => ':id', 'sesskey' => sesskey()]),
+            new pix_icon('t/unlock', ''),
+            [],
+            false,
+            new lang_string('unlockaccount', 'admin'),
+        ))->add_callback(static function(\stdclass $row) use ($contextsystem): bool {
+            return has_capability('moodle/user:update', $contextsystem) && !is_mnet_remote_user($row) &&
+                login_is_lockedout($row);
+        }));
+
+        // Action to suspend users (mnet remote users).
+        $this->add_action((new action(
+            new moodle_url('/admin/user.php', ['acl' => ':id', 'sesskey' => sesskey(), 'accessctrl' => 'deny']),
+            new pix_icon('t/show', ''),
+            [],
+            false,
+            new lang_string('denyaccess', 'mnet'),
+        ))->add_callback(static function(\stdclass $row) use ($DB, $contextsystem): bool {
+            if (!$accessctrl = $DB->get_field(table: 'mnet_sso_access_control', return: 'accessctrl',
+                conditions: ['username' => $row->username, 'mnet_host_id' => $row->mnethostid]
+            )) {
+                $accessctrl = 'allow';
+            }
+
+            return has_capability('moodle/user:update', $contextsystem) && !$row->suspended &&
+                is_mnet_remote_user($row) && $accessctrl == 'allow';
+        }));
+
+        // Action to unsuspend users (mnet remote users).
+        $this->add_action((new action(
+            new moodle_url('/admin/user.php', ['acl' => ':id', 'sesskey' => sesskey(), 'accessctrl' => 'allow']),
+            new pix_icon('t/hide', ''),
+            [],
+            false,
+            new lang_string('allowaccess', 'mnet'),
+        ))->add_callback(static function(\stdclass $row) use ($DB, $contextsystem): bool {
+            if (!$accessctrl = $DB->get_field(table: 'mnet_sso_access_control', return: 'accessctrl',
+                conditions: ['username' => $row->username, 'mnet_host_id' => $row->mnethostid]
+            )) {
+                $accessctrl = 'allow';
+            }
+
+            return has_capability('moodle/user:update', $contextsystem) && !$row->suspended &&
+                is_mnet_remote_user($row) && $accessctrl == 'deny';
+        }));
+
+        // Action to delete users.
+        $this->add_action((new action(
+            new moodle_url('/admin/user.php', ['delete' => ':id', 'sesskey' => sesskey()]),
+            new pix_icon('t/delete', ''),
+            [
+                'class' => 'text-danger',
+                'data-modal' => 'confirmation',
+                'data-modal-title-str' => json_encode(['deleteuser', 'admin']),
+                'data-modal-content-str' => ':deletestr',
+                'data-modal-yes-button-str' => json_encode(['delete', 'core']),
+                'data-modal-destination' => ':deleteurl',
+
+            ],
+            false,
+            new lang_string('delete', 'moodle'),
+        ))->add_callback(static function(\stdclass $row) use ($USER, $contextsystem): bool {
+
+            // Populate deletion modal attributes.
+            $row->deletestr = json_encode([
+                'deletecheckfull',
+                'moodle',
+                fullname($row, true),
+            ]);
+
+            $row->deleteurl = (new moodle_url('/admin/user.php', [
+                'delete' => $row->id,
+                'confirm' => md5($row->id),
+                'sesskey' => sesskey(),
+            ]))->out(false);
+
+            return has_capability('moodle/user:delete', $contextsystem) &&
+                !is_mnet_remote_user($row) && $row->id != $USER->id && !is_siteadmin($row);
+        }));
+
+        $this->add_action_divider();
+
+        // Action to confirm users.
+        $this->add_action((new action(
+            new moodle_url('/admin/user.php', ['confirmuser' => ':id', 'sesskey' => sesskey()]),
+            new pix_icon('t/check', ''),
+            [],
+            false,
+            new lang_string('confirmaccount', 'moodle'),
+        ))->add_callback(static function(\stdclass $row) use ($contextsystem): bool {
+            return has_capability('moodle/user:update', $contextsystem) && !$row->confirmed;
+        }));
+
+        // Action to resend email.
+        $this->add_action((new action(
+            new moodle_url('/admin/user.php', ['resendemail' => ':id', 'sesskey' => sesskey()]),
+            new pix_icon('t/email', ''),
+            [],
+            false,
+            new lang_string('resendemail', 'moodle'),
+        ))->add_callback(static function(\stdclass $row): bool {
+            return !$row->confirmed && !is_mnet_remote_user($row);
+        }));
+    }
+
+    /**
+     * Row class
+     *
+     * @param \stdClass $row
+     * @return string
+     */
+    public function get_row_class(\stdClass $row): string {
+        return $row->suspended ? 'text-muted' : '';
+    }
+}