mirror of
https://github.com/moodle/moodle.git
synced 2025-01-19 06:18:28 +01:00
477 lines
16 KiB
PHP
477 lines
16 KiB
PHP
<?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/>.
|
|
|
|
/**
|
|
* This file contains the classes for the admin settings of the assign module.
|
|
*
|
|
* @package mod_assign
|
|
* @copyright 2012 NetSpot {@link http://www.netspot.com.au}
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
/** Include adminlib.php */
|
|
require_once($CFG->libdir . '/adminlib.php');
|
|
|
|
/**
|
|
* Admin external page that displays a list of the installed submission plugins.
|
|
*
|
|
* @package mod_assign
|
|
* @copyright 2012 NetSpot {@link http://www.netspot.com.au}
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class assign_admin_page_manage_assign_plugins extends admin_externalpage {
|
|
|
|
/** @var string the name of plugin subtype */
|
|
private $subtype = '';
|
|
|
|
/**
|
|
* The constructor - calls parent constructor
|
|
*
|
|
* @param string $subtype
|
|
*/
|
|
public function __construct($subtype) {
|
|
$this->subtype = $subtype;
|
|
parent::__construct('manage' . $subtype . 'plugins', get_string('manage' . $subtype . 'plugins', 'assign'),
|
|
new moodle_url('/mod/assign/adminmanageplugins.php', array('subtype'=>$subtype)));
|
|
}
|
|
|
|
/**
|
|
* Search plugins for the specified string
|
|
*
|
|
* @param string $query The string to search for
|
|
* @return array
|
|
*/
|
|
public function search($query) {
|
|
if ($result = parent::search($query)) {
|
|
return $result;
|
|
}
|
|
|
|
$found = false;
|
|
$textlib = new textlib();
|
|
|
|
foreach (get_plugin_list($this->subtype) as $name => $notused) {
|
|
if (strpos($textlib::strtolower(get_string('pluginname', $this->subtype . '_' . $name)),
|
|
$query) !== false) {
|
|
$found = true;
|
|
break;
|
|
}
|
|
}
|
|
if ($found) {
|
|
$result = new stdClass();
|
|
$result->page = $this;
|
|
$result->settings = array();
|
|
return array($this->name => $result);
|
|
} else {
|
|
return array();
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Class that handles the display and configuration of the list of submission plugins.
|
|
*
|
|
* @package mod_assign
|
|
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class assign_plugin_manager {
|
|
|
|
/** @var object the url of the manage submission plugin page */
|
|
private $pageurl;
|
|
/** @var string any error from the current action */
|
|
private $error = '';
|
|
/** @var string either submission or feedback */
|
|
private $subtype = '';
|
|
|
|
/**
|
|
* Constructor for this assignment plugin manager
|
|
* @param string $subtype - either assignsubmission or assignfeedback
|
|
*/
|
|
public function __construct($subtype) {
|
|
$this->pageurl = new moodle_url('/mod/assign/adminmanageplugins.php', array('subtype'=>$subtype));
|
|
$this->subtype = $subtype;
|
|
}
|
|
|
|
|
|
/**
|
|
* Return a list of plugins sorted by the order defined in the admin interface
|
|
*
|
|
* @return array The list of plugins
|
|
*/
|
|
public function get_sorted_plugins_list() {
|
|
$names = get_plugin_list($this->subtype);
|
|
|
|
$result = array();
|
|
|
|
foreach ($names as $name => $path) {
|
|
$idx = get_config($this->subtype . '_' . $name, 'sortorder');
|
|
if (!$idx) {
|
|
$idx = 0;
|
|
}
|
|
while (array_key_exists($idx, $result)) $idx +=1;
|
|
$result[$idx] = $name;
|
|
}
|
|
ksort($result);
|
|
|
|
return $result;
|
|
}
|
|
|
|
|
|
/**
|
|
* Util function for writing an action icon link
|
|
*
|
|
* @param string $action URL parameter to include in the link
|
|
* @param string $plugintype URL parameter to include in the link
|
|
* @param string $icon The key to the icon to use (e.g. 't/up')
|
|
* @param string $alt The string description of the link used as the title and alt text
|
|
* @return string The icon/link
|
|
*/
|
|
private function format_icon_link($action, $plugintype, $icon, $alt) {
|
|
global $OUTPUT;
|
|
|
|
return $OUTPUT->action_icon(new moodle_url($this->pageurl,
|
|
array('action' => $action, 'plugin'=> $plugintype, 'sesskey' => sesskey())),
|
|
new pix_icon($icon, $alt, 'moodle', array('title' => $alt)),
|
|
null, array('title' => $alt)) . ' ';
|
|
}
|
|
|
|
/**
|
|
* Write the HTML for the submission plugins table.
|
|
*
|
|
* @return None
|
|
*/
|
|
private function view_plugins_table() {
|
|
global $OUTPUT, $CFG;
|
|
/** Include tablelib.php */
|
|
require_once($CFG->libdir . '/tablelib.php');
|
|
|
|
// Set up the table.
|
|
$this->view_header();
|
|
$table = new flexible_table($this->subtype . 'pluginsadminttable');
|
|
$table->define_baseurl($this->pageurl);
|
|
$table->define_columns(array('pluginname', 'version', 'hideshow', 'order',
|
|
'delete', 'settings'));
|
|
$table->define_headers(array(get_string($this->subtype . 'pluginname', 'assign'),
|
|
get_string('version'), get_string('hideshow', 'assign'),
|
|
get_string('order'), get_string('delete'), get_string('settings')));
|
|
$table->set_attribute('id', $this->subtype . 'plugins');
|
|
$table->set_attribute('class', 'generaltable generalbox boxaligncenter boxwidthwide');
|
|
$table->setup();
|
|
|
|
|
|
$plugins = $this->get_sorted_plugins_list();
|
|
$shortsubtype = substr($this->subtype, strlen('assign'));
|
|
|
|
foreach ($plugins as $idx => $plugin) {
|
|
$row = array();
|
|
|
|
$row[] = get_string('pluginname', $this->subtype . '_' . $plugin);
|
|
$row[] = get_config($this->subtype . '_' . $plugin, 'version');
|
|
|
|
$visible = !get_config($this->subtype . '_' . $plugin, 'disabled');
|
|
|
|
if ($visible) {
|
|
$row[] = $this->format_icon_link('hide', $plugin, 'i/hide', get_string('disable'));
|
|
} else {
|
|
$row[] = $this->format_icon_link('show', $plugin, 'i/show', get_string('enable'));
|
|
}
|
|
|
|
$movelinks = '';
|
|
if (!$idx == 0) {
|
|
$movelinks .= $this->format_icon_link('moveup', $plugin, 't/up', get_string('up'));
|
|
} else {
|
|
$movelinks .= $OUTPUT->spacer(array('width'=>15));
|
|
}
|
|
if ($idx != count($plugins) - 1) {
|
|
$movelinks .= $this->format_icon_link('movedown', $plugin, 't/down', get_string('down'));
|
|
}
|
|
$row[] = $movelinks;
|
|
|
|
if ($row[1] != '') {
|
|
$row[] = $this->format_icon_link('delete', $plugin, 't/delete', get_string('delete'));
|
|
} else {
|
|
$row[] = ' ';
|
|
}
|
|
if ($row[1] != '' && file_exists($CFG->dirroot . '/mod/assign/' . $shortsubtype . '/' . $plugin . '/settings.php')) {
|
|
$row[] = html_writer::link(new moodle_url('/admin/settings.php',
|
|
array('section' => $this->subtype . '_' . $plugin)), get_string('settings'));
|
|
} else {
|
|
$row[] = ' ';
|
|
}
|
|
$table->add_data($row);
|
|
}
|
|
|
|
|
|
$table->finish_output();
|
|
$this->view_footer();
|
|
}
|
|
|
|
/**
|
|
* Write the page header
|
|
*
|
|
* @return None
|
|
*/
|
|
private function view_header() {
|
|
global $OUTPUT;
|
|
admin_externalpage_setup('manage' . $this->subtype . 'plugins');
|
|
// Print the page heading.
|
|
echo $OUTPUT->header();
|
|
echo $OUTPUT->heading(get_string('manage' . $this->subtype . 'plugins', 'assign'));
|
|
}
|
|
|
|
/**
|
|
* Write the page footer
|
|
*
|
|
* @return None
|
|
*/
|
|
private function view_footer() {
|
|
global $OUTPUT;
|
|
echo $OUTPUT->footer();
|
|
}
|
|
|
|
/**
|
|
* Check this user has permission to edit the list of installed plugins
|
|
*
|
|
* @return None
|
|
*/
|
|
private function check_permissions() {
|
|
// Check permissions.
|
|
require_login();
|
|
$systemcontext = context_system::instance();
|
|
require_capability('moodle/site:config', $systemcontext);
|
|
}
|
|
|
|
/**
|
|
* Delete the database and files associated with this plugin.
|
|
*
|
|
* @param string $plugin - The type of the plugin to delete
|
|
* @return string the name of the next page to display
|
|
*/
|
|
public function delete_plugin($plugin) {
|
|
global $CFG, $DB, $OUTPUT;
|
|
$confirm = optional_param('confirm', null, PARAM_BOOL);
|
|
|
|
if ($confirm) {
|
|
// Delete any configuration records.
|
|
if (!unset_all_config_for_plugin($this->subtype . '_' . $plugin)) {
|
|
$this->error = $OUTPUT->notification(get_string('errordeletingconfig', 'admin', $this->subtype . '_' . $plugin));
|
|
}
|
|
|
|
|
|
// Should be covered by the previous function - but just in case
|
|
unset_config('disabled', $this->subtype . '_' . $plugin);
|
|
unset_config('sortorder', $this->subtype . '_' . $plugin);
|
|
|
|
// delete the plugin specific config settings
|
|
$DB->delete_records('assign_plugin_config', array('plugin'=>$plugin, 'subtype'=>$this->subtype));
|
|
|
|
// Then the tables themselves
|
|
$shortsubtype = substr($this->subtype, strlen('assign'));
|
|
drop_plugin_tables($this->subtype . '_' . $plugin, $CFG->dirroot . '/mod/assign/' . $shortsubtype . '/' .$plugin. '/db/install.xml', false);
|
|
|
|
// Remove event handlers and dequeue pending events
|
|
events_uninstall($this->subtype . '_' . $plugin);
|
|
|
|
// the page to display
|
|
return 'plugindeleted';
|
|
} else {
|
|
// the page to display
|
|
return 'confirmdelete';
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* Show the page that gives the details of the plugin that was just deleted
|
|
*
|
|
* @param string $plugin - The plugin that was just deleted
|
|
* @return None
|
|
*/
|
|
private function view_plugin_deleted($plugin) {
|
|
global $OUTPUT;
|
|
$this->view_header();
|
|
echo $OUTPUT->heading(get_string('deletingplugin', 'assign', get_string('pluginname', $this->subtype . '_' . $plugin)));
|
|
echo $this->error;
|
|
echo $OUTPUT->notification(get_string('plugindeletefiles', 'moodle', array('name'=>get_string('pluginname', $this->subtype . '_' . $plugin), 'directory'=>('/mod/assign/' . $this->subtype . '/'.$plugin))));
|
|
echo $OUTPUT->continue_button($this->pageurl);
|
|
$this->view_footer();
|
|
}
|
|
|
|
/**
|
|
* Show the page that asks the user to confirm they want to delete a plugin
|
|
*
|
|
* @param string $plugin - The plugin that will be deleted
|
|
* @return None
|
|
*/
|
|
private function view_confirm_delete($plugin) {
|
|
global $OUTPUT;
|
|
$this->view_header();
|
|
echo $OUTPUT->heading(get_string('deletepluginareyousure', 'assign', get_string('pluginname', $this->subtype . '_' . $plugin)));
|
|
echo $OUTPUT->confirm(get_string('deletepluginareyousuremessage', 'assign', get_string('pluginname', $this->subtype . '_' . $plugin)),
|
|
new moodle_url($this->pageurl, array('action' => 'delete', 'plugin'=>$plugin, 'confirm' => 1)),
|
|
$this->pageurl);
|
|
$this->view_footer();
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
* Hide this plugin
|
|
*
|
|
* @param string $plugin - The plugin to hide
|
|
* @return string The next page to display
|
|
*/
|
|
public function hide_plugin($plugin) {
|
|
set_config('disabled', 1, $this->subtype . '_' . $plugin);
|
|
return 'view';
|
|
}
|
|
|
|
/**
|
|
* Change the order of this plugin
|
|
*
|
|
* @param string $plugintomove - The plugin to move
|
|
* @param string $dir - up or down
|
|
* @return string The next page to display
|
|
*/
|
|
public function move_plugin($plugintomove, $dir) {
|
|
// get a list of the current plugins
|
|
$plugins = $this->get_sorted_plugins_list();
|
|
|
|
$currentindex = 0;
|
|
|
|
// throw away the keys
|
|
|
|
$plugins = array_values($plugins);
|
|
|
|
// find this plugin in the list
|
|
foreach ($plugins as $key => $plugin) {
|
|
if ($plugin == $plugintomove) {
|
|
$currentindex = $key;
|
|
break;
|
|
}
|
|
}
|
|
|
|
// make the switch
|
|
if ($dir == 'up') {
|
|
if ($currentindex > 0) {
|
|
$tempplugin = $plugins[$currentindex - 1];
|
|
$plugins[$currentindex - 1] = $plugins[$currentindex];
|
|
$plugins[$currentindex] = $tempplugin;
|
|
}
|
|
} else if ($dir == 'down') {
|
|
if ($currentindex < (count($plugins) - 1)) {
|
|
$tempplugin = $plugins[$currentindex + 1];
|
|
$plugins[$currentindex + 1] = $plugins[$currentindex];
|
|
$plugins[$currentindex] = $tempplugin;
|
|
}
|
|
}
|
|
|
|
// save the new normal order
|
|
foreach ($plugins as $key => $plugin) {
|
|
set_config('sortorder', $key, $this->subtype . '_' . $plugin);
|
|
}
|
|
return 'view';
|
|
}
|
|
|
|
|
|
/**
|
|
* Show this plugin
|
|
*
|
|
* @param string $plugin - The plugin to show
|
|
* @return string The next page to display
|
|
*/
|
|
public function show_plugin($plugin) {
|
|
set_config('disabled', 0, $this->subtype . '_' . $plugin);
|
|
return 'view';
|
|
}
|
|
|
|
|
|
/**
|
|
* This is the entry point for this controller class
|
|
*
|
|
* @param string $action - The action to perform
|
|
* @param string $plugin - Optional name of a plugin type to perform the action on
|
|
* @return None
|
|
*/
|
|
public function execute($action, $plugin) {
|
|
if ($action == null) {
|
|
$action = 'view';
|
|
}
|
|
|
|
$this->check_permissions();
|
|
|
|
// process
|
|
if ($action == 'delete' && $plugin != null) {
|
|
$action = $this->delete_plugin($plugin);
|
|
} else if ($action == 'hide' && $plugin != null) {
|
|
$action = $this->hide_plugin($plugin);
|
|
} else if ($action == 'show' && $plugin != null) {
|
|
$action = $this->show_plugin($plugin);
|
|
} else if ($action == 'moveup' && $plugin != null) {
|
|
$action = $this->move_plugin($plugin, 'up');
|
|
} else if ($action == 'movedown' && $plugin != null) {
|
|
$action = $this->move_plugin($plugin, 'down');
|
|
}
|
|
|
|
|
|
// view
|
|
if ($action == 'confirmdelete' && $plugin != null) {
|
|
$this->view_confirm_delete($plugin);
|
|
} else if ($action == 'plugindeleted' && $plugin != null) {
|
|
$this->view_plugin_deleted($plugin);
|
|
} else if ($action == 'view') {
|
|
$this->view_plugins_table();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* This function adds plugin pages to the navigation menu
|
|
*
|
|
* @static
|
|
* @param string $subtype - The type of plugin (submission or feedback)
|
|
* @param part_of_admin_tree $admin - The handle to the admin menu
|
|
* @param admin_settingpage $settings - The handle to current node in the navigation tree
|
|
* @param stdClass $module - The handle to the current module
|
|
* @return None
|
|
*/
|
|
static function add_admin_assign_plugin_settings($subtype, part_of_admin_tree $admin, admin_settingpage $settings, stdClass $module) {
|
|
global $CFG;
|
|
|
|
$plugins = get_plugin_list_with_file($subtype, 'settings.php', false);
|
|
$pluginsbyname = array();
|
|
foreach ($plugins as $plugin => $plugindir) {
|
|
$pluginname = get_string('pluginname', $subtype . '_'.$plugin);
|
|
$pluginsbyname[$pluginname] = $plugin;
|
|
}
|
|
ksort($pluginsbyname);
|
|
|
|
foreach ($pluginsbyname as $pluginname => $plugin) {
|
|
$settings = new admin_settingpage($subtype . '_'.$plugin,
|
|
$pluginname, 'moodle/site:config', !$module->visible);
|
|
if ($admin->fulltree) {
|
|
$shortsubtype = substr($subtype, strlen('assign'));
|
|
include($CFG->dirroot . "/mod/assign/$shortsubtype/$plugin/settings.php");
|
|
}
|
|
|
|
$admin->add($subtype . 'plugins', $settings);
|
|
}
|
|
|
|
}
|
|
}
|