<?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/>.
/**
* Defines classes used for plugin info.
*
* @package core
* @copyright 2011 David Mudrak <david@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace core\plugininfo;
< use moodle_url, part_of_admin_tree, admin_settingpage, admin_externalpage;
<
< defined('MOODLE_INTERNAL') || die();
> use admin_settingpage;
> use moodle_url;
> use part_of_admin_tree;
/**
* Class for text filters
*/
class filter extends base {
> public static function plugintype_supports_disabling(): bool {
public function init_display_name() {
> return true;
if (!get_string_manager()->string_exists('filtername', $this->component)) {
> }
$this->displayname = '[filtername,' . $this->component . ']';
>
} else {
$this->displayname = get_string('filtername', $this->component);
}
}
/**
* Finds all enabled plugins, the result may include missing plugins.
* @return array|null of enabled plugins $pluginname=>$pluginname, null means unknown
*/
public static function get_enabled_plugins() {
global $DB, $CFG;
require_once("$CFG->libdir/filterlib.php");
$enabled = array();
$filters = $DB->get_records_select('filter_active', "active <> :disabled AND contextid = :contextid", array(
'disabled' => TEXTFILTER_DISABLED, 'contextid' => \context_system::instance()->id), 'filter ASC', 'id, filter');
foreach ($filters as $filter) {
$enabled[$filter->filter] = $filter->filter;
}
return $enabled;
}
> /**
public function get_settings_section_name() {
> * Enable or disable a plugin.
return 'filtersetting' . $this->name;
> * When possible, the change will be stored into the config_log table, to let admins check when/who has modified it.
}
> *
> * @param string $pluginname The plugin name to enable/disable.
public function load_settings(part_of_admin_tree $adminroot, $parentnodename, $hassiteconfig) {
> * @param int $enabled Whether the pluginname should be TEXTFILTER_ON, TEXTFILTER_OFF or TEXTFILTER_DISABLED.
global $CFG, $USER, $DB, $OUTPUT, $PAGE; // In case settings.php wants to refer to them.
> *
$ADMIN = $adminroot; // May be used in settings.php.
> * @return bool It always return true because we don't know if the value has changed or not. That way, we guarantee any action
$plugininfo = $this; // Also can be used inside settings.php.
> * required if it's changed will be executed.
$filter = $this; // Also can be used inside settings.php.
> */
> public static function enable_plugin(string $pluginname, int $enabled): bool {
if (!$this->is_installed_and_upgraded()) {
> global $CFG;
return;
> require_once("$CFG->libdir/filterlib.php");
}
> require_once("$CFG->libdir/weblib.php");
>
if (!$hassiteconfig) {
> filter_set_global_state($pluginname, $enabled);
return;
> if ($enabled == TEXTFILTER_DISABLED) {
}
> filter_set_applies_to_strings($pluginname, false);
if (file_exists($this->full_path('settings.php'))) {
> }
$fullpath = $this->full_path('settings.php');
>
} else if (file_exists($this->full_path('filtersettings.php'))) {
> reset_text_filters_cache();
$fullpath = $this->full_path('filtersettings.php');
> \core_plugin_manager::reset_caches();
} else {
>
return;
> return true;
}
> }
>
$section = $this->get_settings_section_name();
> /**
$settings = new admin_settingpage($section, $this->displayname, 'moodle/site:config', $this->is_enabled() === false);
> * Returns current status for a pluginname.
include($fullpath); // This may also set $settings to null.
> *
> * Filters have different values for enabled/disabled plugins so the current value needs to be calculated in a
if ($settings) {
> * different way than the default method in the base class.
$ADMIN->add($parentnodename, $settings);
> *
}
> * @param string $pluginname The plugin name to check.
}
> * @return int The current status (enabled, disabled...) of $pluginname.
> */
public function is_uninstall_allowed() {
> public static function get_enabled_plugin(string $pluginname): int {
return true;
> global $DB, $CFG;
}
> require_once("$CFG->libdir/filterlib.php");
>
/**
> $conditions = ['filter' => $pluginname, 'contextid' => \context_system::instance()->id];
* Return URL used for management of plugins of this type.
> $record = $DB->get_record('filter_active', $conditions, 'active');
* @return moodle_url
>
*/
> return $record ? (int) $record->active : TEXTFILTER_DISABLED;
public static function get_manage_url() {
> }
return new moodle_url('/admin/filters.php');
>
}
> /** @var \admin_root $ADMIN */
/**
* Pre-uninstall hook.
*
* This is intended for disabling of plugin, some DB table purging, etc.
*
* NOTE: to be called from uninstall_plugin() only.
* @private
*/
public function uninstall_cleanup() {
global $DB, $CFG;
$DB->delete_records('filter_active', array('filter' => $this->name));
$DB->delete_records('filter_config', array('filter' => $this->name));
if (empty($CFG->filterall)) {
$stringfilters = array();
} else if (!empty($CFG->stringfilters)) {
$stringfilters = explode(',', $CFG->stringfilters);
$stringfilters = array_combine($stringfilters, $stringfilters);
} else {
$stringfilters = array();
}
unset($stringfilters[$this->name]);
set_config('stringfilters', implode(',', $stringfilters));
set_config('filterall', !empty($stringfilters));
parent::uninstall_cleanup();
}
}