first commit

admin/classes/local/externalpage/accesscallback.php

@@ -0,0 +1,71 @@
+<?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/>.
+
+/**
+ * External admin page class that allows a callback to be provided to determine whether page can be accessed
+ *
+ * @package     core_admin
+ * @copyright   2019 Marina Glancy
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace core_admin\local\externalpage;
+
+use admin_externalpage;
+
+defined('MOODLE_INTERNAL') || die();
+
+require_once("{$CFG->libdir}/adminlib.php");
+
+/**
+ * Admin externalpage class
+ *
+ * @package     core_admin
+ * @copyright   2019 Marina Glancy
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class accesscallback extends admin_externalpage {
+
+    /** @var callable $accesscheckcallback */
+    protected $accesscheckcallback;
+
+    /**
+     * Class constructor
+     *
+     * @param string $name
+     * @param string $visiblename
+     * @param string $url
+     * @param callable $accesscheckcallback The callback method that will be executed to check whether user has access to
+     *     this page. The setting instance ($this) is passed as an argument to the callback. Should return boolean value
+     * @param bool $hidden
+     */
+    public function __construct(string $name, string $visiblename, string $url, callable $accesscheckcallback,
+            bool $hidden = false) {
+
+        $this->accesscheckcallback = $accesscheckcallback;
+
+        parent::__construct($name, $visiblename, $url, [], $hidden);
+    }
+
+    /**
+     * Determines if the current user has access to this external page based on access callback
+     *
+     * @return bool
+     */
+    public function check_access() {
+        return ($this->accesscheckcallback)($this);
+    }
+}

admin/classes/local/settings/autocomplete.php

@@ -0,0 +1,206 @@
+<?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/>.
+
+/**
+ * Auto complete admin setting.
+ *
+ * @package    core_admin
+ * @copyright  2020 The Open University
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace core_admin\local\settings;
+
+defined('MOODLE_INTERNAL') || die();
+
+require_once($CFG->libdir . '/adminlib.php');
+/**
+ * Auto complete setting class.
+ *
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @copyright 2020 The Open University
+ */
+class autocomplete extends \admin_setting_configmultiselect {
+    /** @var boolean Should we allow typing new entries to the field? */
+    protected $tags = false;
+    /** @var string Name of an AMD module to send/process ajax requests. */
+    protected $ajax = '';
+    /** @var string Placeholder text for an empty list. */
+    protected $placeholder = '';
+    /** @var bool Whether the search has to be case-sensitive. */
+    protected $casesensitive = false;
+    /** @var bool Show suggestions by default - but this can be turned off. */
+    protected $showsuggestions = true;
+    /** @var string String that is shown when there are no selections. */
+    protected $noselectionstring = '';
+    /** @var string Delimiter to store values in database. */
+    protected $delimiter = ',';
+    /** @var string Should be multiple choices? */
+    protected $multiple = true;
+    /** @var string The link to manage choices. */
+    protected $manageurl = true;
+    /** @var string The text to display in manage link. */
+    protected $managetext = true;
+
+    /**
+     * Constructor
+     *
+     * @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting'
+     * for ones in config_plugins.
+     * @param string $visiblename localised
+     * @param string $description long localised info
+     * @param array $defaultsetting array of selected items
+     * @param array $choices options for autocomplete field
+     * @param array $attributes settings for autocomplete field
+     */
+    public function __construct($name, $visiblename, $description, $defaultsetting, $choices, $attributes = null) {
+
+        if ($attributes === null) {
+            $attributes = [];
+        }
+
+        $this->placeholder = get_string('search');
+        $this->noselectionstring = get_string('noselection', 'form');
+        $defaultattributes = [
+                'tags',
+                'showsuggestions',
+                'placeholder',
+                'noselectionstring',
+                'ajax',
+                'casesensitive',
+                'delimiter',
+                'multiple',
+                'manageurl',
+                'managetext'
+        ];
+
+        foreach ($defaultattributes as $attributename) {
+            if (isset($attributes[$attributename])) {
+                $this->$attributename = $attributes[$attributename];
+            }
+        }
+
+        parent::__construct($name, $visiblename, $description, $defaultsetting, $choices);
+    }
+
+    /**
+     * Returns the select setting(s)
+     *
+     * @return mixed null or array. Null if no settings else array of setting(s)
+     */
+    public function get_setting() {
+        $result = $this->config_read($this->name);
+        if (is_null($result)) {
+            return null;
+        }
+        if ($result === '') {
+            return [];
+        }
+        return explode($this->delimiter, $result);
+    }
+
+    /**
+     * Saves setting(s) provided through $data
+     *
+     * @param array $data
+     */
+    public function write_setting($data) {
+        if (!is_array($data)) {
+            return ''; // Ignore it.
+        }
+        if (!$this->load_choices() || empty($this->choices)) {
+            return '';
+        }
+
+        unset($data['xxxxx']);
+
+        $save = [];
+        foreach ($data as $value) {
+            if (!array_key_exists($value, $this->choices)) {
+                continue; // Ignore it.
+            }
+            $save[] = $value;
+        }
+
+        return ($this->config_write($this->name, implode($this->delimiter, $save)) ? '' : get_string('errorsetting', 'admin'));
+    }
+
+    /**
+     * Returns XHTML autocomplete field
+     *
+     * @param array $data Array of values to select by default
+     * @param string $query
+     * @return string XHTML autocomplete field
+     */
+    public function output_html($data, $query = '') {
+        global $OUTPUT;
+
+        if (!$this->load_choices() or empty($this->choices)) {
+            return '';
+        }
+
+        $default = $this->get_defaultsetting();
+        if (empty($default)) {
+            $default = [];
+        }
+
+        if (is_null($data)) {
+            $data = [];
+        }
+
+        $context = [
+                'id' => $this->get_id(),
+                'name' => $this->get_full_name()
+        ];
+
+        $defaults = [];
+        $options = [];
+        $template = 'core_admin/local/settings/autocomplete';
+
+        foreach ($this->choices as $value => $name) {
+            if (in_array($value, $default)) {
+                $defaults[] = $name;
+            }
+            $options[] = [
+                    'value' => $value,
+                    'text' => $name,
+                    'selected' => in_array($value, $data),
+                    'disabled' => false
+            ];
+        }
+
+        $context['options'] = $options;
+        $context['tags'] = $this->tags;
+        $context['placeholder'] = $this->placeholder;
+        $context['casesensitive'] = $this->casesensitive;
+        $context['multiple'] = $this->multiple;
+        $context['showsuggestions'] = $this->showsuggestions;
+        $context['manageurl'] = $this->manageurl;
+        $context['managetext'] = $this->managetext;
+
+        if (is_null($default)) {
+            $defaultinfo = null;
+        } if (!empty($defaults)) {
+            $defaultinfo = implode(', ', $defaults);
+        } else {
+            $defaultinfo = get_string('none');
+        }
+
+        $element = $OUTPUT->render_from_template($template, $context);
+
+        return format_admin_setting($this, $this->visiblename, $element, $this->description, true, '', $defaultinfo, $query);
+    }
+}

admin/classes/local/settings/filesize.php

@@ -0,0 +1,197 @@
+<?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/>.
+
+/**
+ * File size admin setting.
+ *
+ * @package    core_admin
+ * @copyright  2019 Shamim Rezaie <shamim@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace core_admin\local\settings;
+
+defined('MOODLE_INTERNAL') || die();
+
+require_once($CFG->libdir . '/adminlib.php');
+
+/**
+ * An admin setting to support entering and displaying of file sizes in Bytes, KB, MB or GB.
+ *
+ * @copyright   2019 Shamim Rezaie <shamim@moodle.com>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class filesize extends \admin_setting {
+
+    /** @var int The byte unit. Number of bytes in a byte */
+    const UNIT_B = 1;
+
+    /** @var int The kilobyte unit (number of bytes in a kilobyte) */
+    const UNIT_KB = 1024;
+
+    /** @var int The megabyte unit (number of bytes in a megabyte) */
+    const UNIT_MB = 1048576;
+
+    /** @var int The gigabyte unit (number of bytes in a gigabyte) */
+    const UNIT_GB = 1073741824;
+
+    /** @var int default size unit */
+    protected $defaultunit;
+
+    /**
+     * Constructor
+     *
+     * @param string    $name           unique ascii name, either 'mysetting' for settings that in config,
+     *                                  or 'myplugin/mysetting' for ones in config_plugins.
+     * @param string    $visiblename    localised name
+     * @param string    $description    localised long description
+     * @param int|null  $defaultvalue   Value of the settings in bytes
+     * @param int|null  $defaultunit    GB, MB, etc. (in bytes)
+     */
+    public function __construct(string $name, string $visiblename, string $description,
+            int $defaultvalue = null, int $defaultunit = null) {
+
+        $defaultsetting = self::parse_bytes($defaultvalue);
+
+        if ($defaultunit && array_key_exists($defaultunit, self::get_units())) {
+            $this->defaultunit = $defaultunit;
+        } else {
+            $this->defaultunit = self::UNIT_MB;
+        }
+        parent::__construct($name, $visiblename, $description, $defaultsetting);
+    }
+
+    /**
+     * Returns selectable units.
+     *
+     * @return  array
+     */
+    protected static function get_units(): array {
+        return [
+            self::UNIT_GB => get_string('sizegb'),
+            self::UNIT_MB => get_string('sizemb'),
+            self::UNIT_KB => get_string('sizekb'),
+            self::UNIT_B  => get_string('sizeb'),
+        ];
+    }
+
+    /**
+     * Converts bytes to some more user friendly string.
+     *
+     * @param   int     $bytes  The number of bytes we want to convert from
+     * @return  string
+     */
+    protected static function get_size_text(int $bytes): string {
+        if (empty($bytes)) {
+            return get_string('none');
+        }
+        return display_size($bytes, 0);
+    }
+
+    /**
+     * Finds suitable units for given file size.
+     *
+     * @param   int     $bytes  The number of bytes
+     * @return  array           Parsed file size in the format of ['v' => value, 'u' => unit]
+     */
+    protected static function parse_bytes(int $bytes): array {
+        foreach (self::get_units() as $unit => $unused) {
+            if ($bytes % $unit === 0) {
+                return ['v' => (int)($bytes / $unit), 'u' => $unit];
+            }
+        }
+        return ['v' => (int)$bytes, 'u' => self::UNIT_B];
+    }
+
+    /**
+     * Get the selected file size as array.
+     *
+     * @return  array|null  An array containing 'v' => xx, 'u' => xx, or null if not set
+     */
+    public function get_setting(): ?array {
+        $bytes = $this->config_read($this->name);
+        if (is_null($bytes)) {
+            return null;
+        }
+        $bytes = intval($bytes);
+
+        return self::parse_bytes($bytes);
+    }
+
+    /**
+     * Store the file size as bytes.
+     *
+     * @param   array   $data   Must be form 'h' => xx, 'm' => xx
+     * @return  string          The error string if any
+     */
+    public function write_setting($data): string {
+        if (!is_array($data)) {
+            return '';
+        }
+
+        if (!is_numeric($data['v']) || $data['v'] < 0) {
+            return get_string('errorsetting', 'admin');
+        }
+
+        // Calculate size in bytes, ensuring we don't overflow PHP_INT_MAX.
+        $bytes = $data['v'] * $data['u'];
+        $result = (is_int($bytes) && $this->config_write($this->name, $bytes));
+
+        return ($result ? '' : get_string('errorsetting', 'admin'));
+    }
+
+    /**
+     * Returns file size text+select fields.
+     *
+     * @param   array   $data   The current setting value. Must be form 'v' => xx, 'u' => xx.
+     * @param   string  $query  Admin search query to be highlighted.
+     * @return  string          File size text+select fields and wrapping div(s).
+     */
+    public function output_html($data, $query = ''): string {
+        global $OUTPUT;
+
+        $default = $this->get_defaultsetting();
+        if (is_number($default)) {
+            $defaultinfo = self::get_size_text($default);
+        } else if (is_array($default)) {
+            $defaultinfo = self::get_size_text($default['v'] * $default['u']);
+        } else {
+            $defaultinfo = null;
+        }
+
+        $inputid = $this->get_id() . 'v';
+        $units = self::get_units();
+        $defaultunit = $this->defaultunit;
+
+        $context = (object) [
+            'id' => $this->get_id(),
+            'name' => $this->get_full_name(),
+            'value' => $data['v'],
+            'readonly' => $this->is_readonly(),
+            'options' => array_map(function($unit, $title) use ($data, $defaultunit) {
+                return [
+                    'value' => $unit,
+                    'name' => $title,
+                    'selected' => ($data['v'] == 0 && $unit == $defaultunit) || $unit == $data['u']
+                ];
+            }, array_keys($units), $units)
+        ];
+
+        $element = $OUTPUT->render_from_template('core_admin/setting_configfilesize', $context);
+
+        return format_admin_setting($this, $this->visiblename, $element, $this->description, $inputid, '', $defaultinfo, $query);
+    }
+}

admin/classes/local/settings/linkable_settings_page.php

@@ -0,0 +1,37 @@
+<?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/>.
+
+/**
+ * A settings page which can be viewed with a link directly.
+ *
+ * @package    core_admin
+ * @copyright  2021 Andrew Lyons <andrew@nicols.co.uk>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace core_admin\local\settings;
+
+use moodle_url;
+
+interface linkable_settings_page {
+
+    /**
+     * Get the URL to view this settings page.
+     *
+     * @return moodle_url
+     */
+    public function get_settings_page_url(): moodle_url;
+}

admin/classes/local/settings/manage_payment_gateway_plugins.php

@@ -0,0 +1,74 @@
+<?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/>.
+
+/**
+ * Payment gateway admin setting.
+ *
+ * @package    core_admin
+ * @copyright  2020 Shamim Rezaie <shamim@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace core_admin\local\settings;
+
+/**
+ * Generic class for managing plugins in a table that allows re-ordering and enable/disable of each plugin.
+ */
+class manage_payment_gateway_plugins extends \admin_setting_manage_plugins {
+    /**
+     * Get the admin settings section title (use get_string).
+     *
+     * @return string
+     */
+    public function get_section_title() {
+        return get_string('type_paygw_plural', 'plugin');
+    }
+
+    /**
+     * Get the type of plugin to manage.
+     *
+     * @return string
+     */
+    public function get_plugin_type() {
+        return 'paygw';
+    }
+
+    /**
+     * Get the name of the second column.
+     *
+     * @return string
+     */
+    public function get_info_column_name() {
+        return get_string('supportedcurrencies', 'core_payment');
+    }
+
+    /**
+     * Get the type of plugin to manage.
+     *
+     * @param plugininfo The plugin info class.
+     * @return string
+     */
+    public function get_info_column($plugininfo) {
+        $codes = $plugininfo->get_supported_currencies();
+
+        $currencies = [];
+        foreach ($codes as $c) {
+            $currencies[$c] = new \lang_string($c, 'core_currencies');
+        }
+
+        return implode(get_string('listsep', 'langconfig') . ' ', $currencies);
+    }
+}

admin/classes/local/settings/setting_scheduled_task_status.php

@@ -0,0 +1,121 @@
+<?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/>.
+
+/**
+ * Admin setting to show current scheduled task's status.
+ *
+ * @package core
+ * @copyright 2021 Universitat Rovira i Virgili
+ * @author Jordi Pujol-Ahulló <jpahullo@gmail.com>
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace core_admin\local\settings;
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+require_once($CFG->libdir . '/adminlib.php');
+require_once($CFG->libdir . '/moodlelib.php');
+
+use admin_setting_description;
+use core\task\manager;
+use core\task\scheduled_task;
+use html_writer;
+use lang_string;
+use moodle_url;
+use stdClass;
+
+/**
+ * This admin setting tells whether a given scheduled task is enabled, providing a link to its configuration page.
+ *
+ * The goal of this setting is to help contextualizing the configuration settings with related scheduled task status,
+ * providing the big picture of that part of the system.
+ *
+ * @package core
+ * @copyright 2021 Universitat Rovira i Virgili
+ * @author Jordi Pujol-Ahulló <jpahullo@gmail.com>
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class setting_scheduled_task_status extends admin_setting_description {
+    /**
+     * @var string fully qualified class name of a scheduled task.
+     */
+    private $classname;
+    /**
+     * @var string additional text to append to the description.
+     */
+    private $extradescription;
+
+    /**
+     * setting_scheduled_task_status constructor.
+     * @param string $name unique setting name.
+     * @param string $scheduledtaskclassname full classpath class name of the scheduled task.
+     * @param string $extradescription extra detail to append to the scheduled task status to add context in the setting
+     * page.
+     */
+    public function __construct(string $name, string $scheduledtaskclassname, string $extradescription = '') {
+        $visiblename = new lang_string('task_status', 'admin');
+        $this->classname = $scheduledtaskclassname;
+        $this->extradescription = $extradescription;
+
+        parent::__construct($name, $visiblename, '');
+    }
+
+    /**
+     * Calculates lazily the content of the description.
+     * @param mixed $data nothing expected in this case.
+     * @param string $query nothing expected in this case.
+     * @return string the HTML content to print for this setting.
+     */
+    public function output_html($data, $query = ''): string {
+        if (empty($this->description)) {
+            $this->description = $this->get_task_description();
+        }
+
+        return parent::output_html($data, $query);
+    }
+
+    /**
+     * Returns the HTML to print as the description.
+     * @return string description to be printed.
+     */
+    private function get_task_description(): string {
+        $task = manager::get_scheduled_task($this->classname);
+        if ($task->is_enabled()) {
+            $taskenabled = get_string('enabled', 'admin');
+        } else {
+            $taskenabled = get_string('disabled', 'admin');
+        }
+        $taskenabled = strtolower($taskenabled);
+        $gotourl = new moodle_url(
+            '/admin/tool/task/scheduledtasks.php',
+            [],
+            scheduled_task::get_html_id($this->classname)
+        );
+        if (!empty($this->extradescription)) {
+            $this->extradescription = '<br />' . $this->extradescription;
+        }
+
+        $taskdetail = new stdClass();
+        $taskdetail->class = $this->classname;
+        $taskdetail->name = $task->get_name();
+        $taskdetail->status = $taskenabled;
+        $taskdetail->gotourl = $gotourl->out(false);
+        $taskdetail->extradescription = $this->extradescription;
+
+        return html_writer::tag('p', get_string('task_status_desc', 'admin', $taskdetail));
+    }
+}