From 9bc9204a522857da3af929f3a6a30c658a2fb230 Mon Sep 17 00:00:00 2001 From: Andrew Nicols Date: Mon, 20 Feb 2023 11:35:55 +0800 Subject: [PATCH] MDL-76867 core_admin: Migrate admin tool management to plugin management --- .../table/tool_plugin_management_table.php | 50 +++++++++ admin/settings/plugins.php | 10 +- admin/tools.php | 104 ------------------ 3 files changed, 58 insertions(+), 106 deletions(-) create mode 100644 admin/classes/table/tool_plugin_management_table.php delete mode 100644 admin/tools.php diff --git a/admin/classes/table/tool_plugin_management_table.php b/admin/classes/table/tool_plugin_management_table.php new file mode 100644 index 00000000000..5ea67fa39f4 --- /dev/null +++ b/admin/classes/table/tool_plugin_management_table.php @@ -0,0 +1,50 @@ +. + +namespace core_admin\table; + +use moodle_url; + +/** + * Tiny admin settings. + * + * @package core_admin + * @copyright 2023 Andrew Lyons + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +class tool_plugin_management_table extends \core_admin\table\plugin_management_table { + protected function get_plugintype(): string { + return 'tool'; + } + + public function guess_base_url(): void { + $this->define_baseurl( + new moodle_url('/admin/tools.php') + ); + } + + protected function get_column_list(): array { + $columns = parent::get_column_list(); + + unset($columns['settings']); + + return $columns; + } + + protected function get_action_url(array $params = []): moodle_url { + return new moodle_url('/admin/tool.php', $params); + } +} diff --git a/admin/settings/plugins.php b/admin/settings/plugins.php index cc8b352aabd..6dea7778773 100644 --- a/admin/settings/plugins.php +++ b/admin/settings/plugins.php @@ -728,8 +728,14 @@ if ($hassiteconfig) { /// Add all admin tools if ($hassiteconfig) { $ADMIN->add('modules', new admin_category('tools', new lang_string('tools', 'admin'))); - $ADMIN->add('tools', new admin_externalpage('managetools', new lang_string('toolsmanage', 'admin'), - $CFG->wwwroot . '/' . $CFG->admin . '/tools.php')); + $settingspage = new admin_settingpage('toolsmanagement', new lang_string('toolsmanage', 'admin')); + $ADMIN->add('tools', $settingspage); + $settingspage->add(new \core_admin\admin\admin_setting_plugin_manager( + 'tool', + \core_admin\table\tool_plugin_management_table::class, + 'managetools', + new lang_string('toolsmanage', 'admin') + )); } // Now add various admin tools. diff --git a/admin/tools.php b/admin/tools.php deleted file mode 100644 index e0559eec778..00000000000 --- a/admin/tools.php +++ /dev/null @@ -1,104 +0,0 @@ -. - -/** - * Provides an overview of installed admin tools - * - * Displays the list of found admin tools, their version (if found) and - * a link to uninstall the admin tool. - * - * The code is based on admin/localplugins.php by David Mudrak. - * - * @package admin - * @copyright 2011 Petr Skoda {@link http://skodak.org} - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later - */ - -require_once(__DIR__ . '/../config.php'); -require_once($CFG->libdir.'/adminlib.php'); -require_once($CFG->libdir.'/tablelib.php'); - -admin_externalpage_setup('managetools'); - -echo $OUTPUT->header(); -echo $OUTPUT->heading(get_string('tools', 'admin')); - -/// Print the table of all installed tool plugins - -$struninstall = get_string('uninstallplugin', 'core_admin'); - -$table = new flexible_table('toolplugins_administration_table'); -$table->define_columns(array('name', 'version', 'uninstall')); -$table->define_headers(array(get_string('plugin'), get_string('version'), $struninstall)); -$table->define_baseurl($PAGE->url); -$table->set_attribute('id', 'toolplugins'); -$table->set_attribute('class', 'admintable generaltable'); -$table->setup(); - -$plugins = array(); -foreach (core_component::get_plugin_list('tool') as $plugin => $plugindir) { - if (get_string_manager()->string_exists('pluginname', 'tool_' . $plugin)) { - $strpluginname = get_string('pluginname', 'tool_' . $plugin); - } else { - $strpluginname = $plugin; - } - $plugins[$plugin] = $strpluginname; -} -core_collator::asort($plugins); - -$like = $DB->sql_like('plugin', '?', true, true, false, '|'); -$params = array('tool|_%'); -$installed = $DB->get_records_select('config_plugins', "$like AND name = 'version'", $params); -$versions = array(); -foreach ($installed as $config) { - $name = preg_replace('/^tool_/', '', $config->plugin); - $versions[$name] = $config->value; - if (!isset($plugins[$name])) { - $plugins[$name] = $name; - } -} - -foreach ($plugins as $plugin => $name) { - $uninstall = ''; - if ($uninstallurl = core_plugin_manager::instance()->get_uninstall_url('tool_'.$plugin, 'manage')) { - $uninstall = html_writer::link($uninstallurl, $struninstall); - } - - if (!isset($versions[$plugin])) { - if (file_exists("$CFG->dirroot/$CFG->admin/tool/$plugin/version.php")) { - // not installed yet - $version = '?'; - } else { - // no version info available - $version = '-'; - } - } else { - $version = $versions[$plugin]; - if (file_exists("$CFG->dirroot/$CFG->admin/tool/$plugin")) { - $version = $versions[$plugin]; - } else { - // somebody removed plugin without uninstall - $name = ''.$name.' ('.get_string('missingfromdisk').')'; - $version = $versions[$plugin]; - } - } - - $table->add_data(array($name, $version, $uninstall)); -} - -$table->print_html(); - -echo $OUTPUT->footer();