MDL-76867 core: Add plugintype_supports_disabling to plugininfo

This commit is contained in:
Andrew Nicols
2023-03-14 08:34:42 +08:00
parent 6809289cf4
commit fdb1df2bfd
27 changed files with 240 additions and 0 deletions
@@ -33,6 +33,10 @@ use part_of_admin_tree;
*/
class logstore extends base {
public static function plugintype_supports_disabling(): bool {
return true;
}
public function is_enabled() {
$enabled = get_config('tool_log', 'enabled_stores');
if (!$enabled) {
+5
View File
@@ -35,6 +35,11 @@ use part_of_admin_tree;
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class antivirus extends base {
public static function plugintype_supports_disabling(): bool {
return true;
}
/**
* Finds all enabled plugins, the result may include missing plugins.
* @return array|null of enabled plugins $pluginname=>$pluginname, null means unknown
+5
View File
@@ -31,6 +31,11 @@ use part_of_admin_tree;
* Class for authentication plugins
*/
class auth extends base {
public static function plugintype_supports_disabling(): bool {
return true;
}
public function is_uninstall_allowed() {
global $DB;
+5
View File
@@ -33,6 +33,11 @@ use admin_settingpage;
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class availability extends base {
public static function plugintype_supports_disabling(): bool {
return true;
}
public static function get_enabled_plugins() {
global $DB;
+9
View File
@@ -71,6 +71,15 @@ abstract class base {
/** @var array|null array of {@link \core\update\info} for this plugin */
protected $availableupdates;
/**
* Whether this plugintype supports its plugins being disabled.
*
* @return bool
*/
public static function plugintype_supports_disabling(): bool {
return false;
}
/**
* Finds all enabled plugins, the result may include missing plugins.
* @return array|null of enabled plugins $pluginname=>$pluginname, null means unknown
+5
View File
@@ -31,6 +31,11 @@ use part_of_admin_tree;
* Class for page side blocks
*/
class block extends base {
public static function plugintype_supports_disabling(): bool {
return true;
}
/**
* Finds all enabled plugins, the result may include missing plugins.
* @return array|null of enabled plugins $pluginname=>$pluginname, null means unknown
+3
View File
@@ -32,6 +32,9 @@ namespace core\plugininfo;
*/
class contenttype extends base {
public static function plugintype_supports_disabling(): bool {
return true;
}
/**
* Defines if there should be a way to uninstall the plugin via the administration UI.
+4
View File
@@ -35,6 +35,10 @@ use moodle_url;
*/
class customfield extends base {
public static function plugintype_supports_disabling(): bool {
return true;
}
/**
* Allow uninstall
* @return bool
+4
View File
@@ -37,6 +37,10 @@ use part_of_admin_tree;
*/
class dataformat extends base {
public static function plugintype_supports_disabling(): bool {
return true;
}
/**
* Display name
*/
+5
View File
@@ -32,6 +32,11 @@ defined('MOODLE_INTERNAL') || die();
* Class for HTML editors
*/
class editor extends base {
public static function plugintype_supports_disabling(): bool {
return true;
}
/**
* Finds all enabled plugins, the result may include missing plugins.
* @return array|null of enabled plugins $pluginname=>$pluginname, null means unknown
+5
View File
@@ -31,6 +31,11 @@ use part_of_admin_tree;
* Class for enrolment plugins
*/
class enrol extends base {
public static function plugintype_supports_disabling(): bool {
return true;
}
/**
*
* Finds all enabled plugins, the result may include missing plugins.
+4
View File
@@ -32,6 +32,10 @@ namespace core\plugininfo;
*/
class fileconverter extends base {
public static function plugintype_supports_disabling(): bool {
return true;
}
/**
* Should there be a way to uninstall the plugin via the administration UI.
*
+4
View File
@@ -32,6 +32,10 @@ use part_of_admin_tree;
*/
class filter extends base {
public static function plugintype_supports_disabling(): bool {
return true;
}
public function init_display_name() {
if (!get_string_manager()->string_exists('filtername', $this->component)) {
$this->displayname = '[filtername,' . $this->component . ']';
+4
View File
@@ -32,6 +32,10 @@ namespace core\plugininfo;
*/
class media extends base {
public static function plugintype_supports_disabling(): bool {
return true;
}
public function is_uninstall_allowed() {
return true;
}
+5
View File
@@ -31,6 +31,11 @@ use part_of_admin_tree;
* Class for messaging processors
*/
class message extends base {
public static function plugintype_supports_disabling(): bool {
return true;
}
/**
* Finds all enabled plugins, the result may include missing plugins.
* @return array|null of enabled plugins $pluginname=>$pluginname, null means unknown
+5
View File
@@ -31,6 +31,11 @@ use part_of_admin_tree;
* Class for activity modules
*/
class mod extends base {
public static function plugintype_supports_disabling(): bool {
return true;
}
/**
* Finds all enabled plugins, the result may include missing plugins.
* @return array|null of enabled plugins $pluginname=>$pluginname, null means unknown
+5
View File
@@ -31,6 +31,11 @@ namespace core\plugininfo;
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class paygw extends base {
public static function plugintype_supports_disabling(): bool {
return true;
}
public function is_uninstall_allowed() {
return true;
}
+5
View File
@@ -29,6 +29,11 @@ use moodle_url;
* Class for portfolios
*/
class portfolio extends base {
public static function plugintype_supports_disabling(): bool {
return true;
}
/**
* Finds all enabled plugins, the result may include missing plugins.
* @return array|null of enabled plugins $pluginname=>$pluginname, null means unknown
+4
View File
@@ -35,6 +35,10 @@ namespace core\plugininfo;
*/
class qbank extends base {
public static function plugintype_supports_disabling(): bool {
return true;
}
public function is_uninstall_allowed(): bool {
if (in_array($this->name, \core_plugin_manager::standard_plugins_list('qbank'))) {
return false;
+5
View File
@@ -30,6 +30,11 @@ use moodle_url;
* Class for question behaviours.
*/
class qbehaviour extends base {
public static function plugintype_supports_disabling(): bool {
return true;
}
/**
* Finds all enabled plugins, the result may include missing plugins.
* @return array|null of enabled plugins $pluginname=>$pluginname, null means unknown
+5
View File
@@ -32,6 +32,11 @@ use part_of_admin_tree;
* Class for question types
*/
class qtype extends base {
public static function plugintype_supports_disabling(): bool {
return true;
}
/**
* Finds all enabled plugins, the result may include missing plugins.
* @return array|null of enabled plugins $pluginname=>$pluginname, null means unknown
+4
View File
@@ -44,6 +44,10 @@ class repository extends base {
/** @var int Repository state, when it's disabled. */
public const REPOSITORY_DISABLED = -1;
public static function plugintype_supports_disabling(): bool {
return true;
}
/**
* Finds all enabled plugins, the result may include missing plugins.
* @return array|null of enabled plugins $pluginname=>$pluginname, null means unknown
+5
View File
@@ -30,6 +30,11 @@ use part_of_admin_tree;
* Class for webservice protocols
*/
class webservice extends base {
public static function plugintype_supports_disabling(): bool {
return true;
}
/**
* Finds all enabled plugins, the result may include missing plugins.
* @return array of enabled plugins $pluginname => $pluginname
@@ -27,6 +27,10 @@ use moodle_url;
*/
class tiny extends \core\plugininfo\base {
public static function plugintype_supports_disabling(): bool {
return true;
}
/**
* These subplugins can be uninstalled.
*
@@ -94,6 +98,53 @@ class tiny extends \core\plugininfo\base {
* @return null|string the settings section name.
*/
public function get_settings_section_name(): ?string {
if (!file_exists($this->full_path('settings.php'))) {
return null;
}
return "tiny_{$this->name}_settings";
}
public static function get_enabled_plugins(): array {
$pluginmanager = \core_plugin_manager::instance();
$plugins = $pluginmanager->get_installed_plugins('tiny');
if (!$plugins) {
return [];
}
// Filter to return only enabled plugins.
$enabled = [];
foreach (array_keys($plugins) as $pluginname) {
$disabled = get_config("tiny_{$pluginname}", 'disabled');
if (empty($disabled)) {
$enabled[$pluginname] = $pluginname;
}
}
return $enabled;
}
public static function enable_plugin(string $plugin, int $enabled): bool {
$pluginname = "tiny_{$plugin}";
$oldvalue = !empty(get_config($pluginname, 'disabled'));
$disabled = empty($enabled);
$haschanged = false;
// Only set value if there is no config setting or if the value is different from the previous one.
if (!$oldvalue && $disabled) {
set_config('disabled', $disabled, $pluginname);
$haschanged = true;
} else if ($oldvalue && !$disabled) {
unset_config('disabled', $pluginname);
$haschanged = true;
}
if ($haschanged) {
add_to_config_log('disabled', $oldvalue, $disabled, $pluginname);
\core_plugin_manager::reset_caches();
}
return $haschanged;
}
}
@@ -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/>.
declare(strict_types=1);
namespace editor_tiny\plugininfo;
use advanced_testcase;
/**
* Unit tests for the editor_tiny\tiny plugininfo class.
*
* @package editor_tiny
* @covers \editor_tiny\plugininfo\tiny
* @copyright 2023 Andrew Lyons <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class tiny_test extends advanced_testcase {
/**
* Uninstall is allowed of TinyMCE plugins.
*
* @covers ::is_uninstall_allowed
*/
public function test_is_uninstall_allowed(): void {
$instance = new tiny();
$this->assertTrue($instance->is_uninstall_allowed());
}
/**
* Check the manage URL.
*
* @covers ::get_manage_url
*/
public function test_get_manage_url(): void {
$this->assertInstanceOf(\moodle_url::class, tiny::get_manage_url());
}
/**
* Test the get_enabled_plugins method.
*
* @covers ::get_enabled_plugin
*/
public function test_get_enabled_plugins(): void {
$this->resetAfterTest();
$plugins = tiny::get_enabled_plugins();
$this->assertArrayHasKey('recordrtc', $plugins);
$this->assertArrayHasKey('media', $plugins);
$this->assertArrayHasKey('autosave', $plugins);
$this->assertArrayHasKey('h5p', $plugins);
// Disable a plugin.
tiny::enable_plugin('h5p', 0);
$plugins = tiny::get_enabled_plugins();
$this->assertArrayHasKey('recordrtc', $plugins);
$this->assertArrayHasKey('media', $plugins);
$this->assertArrayHasKey('autosave', $plugins);
$this->assertArrayNotHasKey('h5p', $plugins);
}
}
@@ -29,6 +29,9 @@ use moodle_url;
*/
class assignfeedback extends base {
public static function plugintype_supports_disabling(): bool {
return true;
}
/**
* Finds all enabled plugins, the result may include missing plugins.
@@ -29,6 +29,9 @@ use moodle_url;
*/
class assignsubmission extends base {
public static function plugintype_supports_disabling(): bool {
return true;
}
/**
* Finds all enabled plugins, the result may include missing plugins.