mirror of
https://github.com/moodle/moodle.git
synced 2025-01-18 22:08:20 +01:00
8585 lines
294 KiB
PHP
8585 lines
294 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/>.
|
|
|
|
/**
|
|
* Functions and classes used during installation, upgrades and for admin settings.
|
|
*
|
|
* ADMIN SETTINGS TREE INTRODUCTION
|
|
*
|
|
* This file performs the following tasks:
|
|
* -it defines the necessary objects and interfaces to build the Moodle
|
|
* admin hierarchy
|
|
* -it defines the admin_externalpage_setup()
|
|
*
|
|
* ADMIN_SETTING OBJECTS
|
|
*
|
|
* Moodle settings are represented by objects that inherit from the admin_setting
|
|
* class. These objects encapsulate how to read a setting, how to write a new value
|
|
* to a setting, and how to appropriately display the HTML to modify the setting.
|
|
*
|
|
* ADMIN_SETTINGPAGE OBJECTS
|
|
*
|
|
* The admin_setting objects are then grouped into admin_settingpages. The latter
|
|
* appear in the Moodle admin tree block. All interaction with admin_settingpage
|
|
* objects is handled by the admin/settings.php file.
|
|
*
|
|
* ADMIN_EXTERNALPAGE OBJECTS
|
|
*
|
|
* There are some settings in Moodle that are too complex to (efficiently) handle
|
|
* with admin_settingpages. (Consider, for example, user management and displaying
|
|
* lists of users.) In this case, we use the admin_externalpage object. This object
|
|
* places a link to an external PHP file in the admin tree block.
|
|
*
|
|
* If you're using an admin_externalpage object for some settings, you can take
|
|
* advantage of the admin_externalpage_* functions. For example, suppose you wanted
|
|
* to add a foo.php file into admin. First off, you add the following line to
|
|
* admin/settings/first.php (at the end of the file) or to some other file in
|
|
* admin/settings:
|
|
* <code>
|
|
* $ADMIN->add('userinterface', new admin_externalpage('foo', get_string('foo'),
|
|
* $CFG->wwwdir . '/' . '$CFG->admin . '/foo.php', 'some_role_permission'));
|
|
* </code>
|
|
*
|
|
* Next, in foo.php, your file structure would resemble the following:
|
|
* <code>
|
|
* require(dirname(dirname(dirname(__FILE__))).'/config.php');
|
|
* require_once($CFG->libdir.'/adminlib.php');
|
|
* admin_externalpage_setup('foo');
|
|
* // functionality like processing form submissions goes here
|
|
* echo $OUTPUT->header();
|
|
* // your HTML goes here
|
|
* echo $OUTPUT->footer();
|
|
* </code>
|
|
*
|
|
* The admin_externalpage_setup() function call ensures the user is logged in,
|
|
* and makes sure that they have the proper role permission to access the page.
|
|
* It also configures all $PAGE properties needed for navigation.
|
|
*
|
|
* ADMIN_CATEGORY OBJECTS
|
|
*
|
|
* Above and beyond all this, we have admin_category objects. These objects
|
|
* appear as folders in the admin tree block. They contain admin_settingpage's,
|
|
* admin_externalpage's, and other admin_category's.
|
|
*
|
|
* OTHER NOTES
|
|
*
|
|
* admin_settingpage's, admin_externalpage's, and admin_category's all inherit
|
|
* from part_of_admin_tree (a pseudointerface). This interface insists that
|
|
* a class has a check_access method for access permissions, a locate method
|
|
* used to find a specific node in the admin tree and find parent path.
|
|
*
|
|
* admin_category's inherit from parentable_part_of_admin_tree. This pseudo-
|
|
* interface ensures that the class implements a recursive add function which
|
|
* accepts a part_of_admin_tree object and searches for the proper place to
|
|
* put it. parentable_part_of_admin_tree implies part_of_admin_tree.
|
|
*
|
|
* Please note that the $this->name field of any part_of_admin_tree must be
|
|
* UNIQUE throughout the ENTIRE admin tree.
|
|
*
|
|
* The $this->name field of an admin_setting object (which is *not* part_of_
|
|
* admin_tree) must be unique on the respective admin_settingpage where it is
|
|
* used.
|
|
*
|
|
* Original author: Vincenzo K. Marcovecchio
|
|
* Maintainer: Petr Skoda
|
|
*
|
|
* @package core
|
|
* @subpackage admin
|
|
* @copyright 1999 onwards Martin Dougiamas http://dougiamas.com
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
/// Add libraries
|
|
require_once($CFG->libdir.'/ddllib.php');
|
|
require_once($CFG->libdir.'/xmlize.php');
|
|
require_once($CFG->libdir.'/messagelib.php');
|
|
|
|
define('INSECURE_DATAROOT_WARNING', 1);
|
|
define('INSECURE_DATAROOT_ERROR', 2);
|
|
|
|
/**
|
|
* Automatically clean-up all plugin data and remove the plugin DB tables
|
|
*
|
|
* NOTE: do not call directly, use new /admin/plugins.php?uninstall=component instead!
|
|
*
|
|
* @param string $type The plugin type, eg. 'mod', 'qtype', 'workshopgrading' etc.
|
|
* @param string $name The plugin name, eg. 'forum', 'multichoice', 'accumulative' etc.
|
|
* @uses global $OUTPUT to produce notices and other messages
|
|
* @return void
|
|
*/
|
|
function uninstall_plugin($type, $name) {
|
|
global $CFG, $DB, $OUTPUT;
|
|
|
|
// This may take a long time.
|
|
@set_time_limit(0);
|
|
|
|
// Recursively uninstall all subplugins first.
|
|
$subplugintypes = core_component::get_plugin_types_with_subplugins();
|
|
if (isset($subplugintypes[$type])) {
|
|
$base = core_component::get_plugin_directory($type, $name);
|
|
if (file_exists("$base/db/subplugins.php")) {
|
|
$subplugins = array();
|
|
include("$base/db/subplugins.php");
|
|
foreach ($subplugins as $subplugintype=>$dir) {
|
|
$instances = core_component::get_plugin_list($subplugintype);
|
|
foreach ($instances as $subpluginname => $notusedpluginpath) {
|
|
uninstall_plugin($subplugintype, $subpluginname);
|
|
}
|
|
}
|
|
}
|
|
|
|
}
|
|
|
|
$component = $type . '_' . $name; // eg. 'qtype_multichoice' or 'workshopgrading_accumulative' or 'mod_forum'
|
|
|
|
if ($type === 'mod') {
|
|
$pluginname = $name; // eg. 'forum'
|
|
if (get_string_manager()->string_exists('modulename', $component)) {
|
|
$strpluginname = get_string('modulename', $component);
|
|
} else {
|
|
$strpluginname = $component;
|
|
}
|
|
|
|
} else {
|
|
$pluginname = $component;
|
|
if (get_string_manager()->string_exists('pluginname', $component)) {
|
|
$strpluginname = get_string('pluginname', $component);
|
|
} else {
|
|
$strpluginname = $component;
|
|
}
|
|
}
|
|
|
|
echo $OUTPUT->heading($pluginname);
|
|
|
|
$plugindirectory = get_plugin_directory($type, $name);
|
|
$uninstalllib = $plugindirectory . '/db/uninstall.php';
|
|
if (file_exists($uninstalllib)) {
|
|
require_once($uninstalllib);
|
|
$uninstallfunction = 'xmldb_' . $pluginname . '_uninstall'; // eg. 'xmldb_workshop_uninstall()'
|
|
if (function_exists($uninstallfunction)) {
|
|
if (!$uninstallfunction()) {
|
|
echo $OUTPUT->notification('Encountered a problem running uninstall function for '. $pluginname);
|
|
}
|
|
}
|
|
}
|
|
|
|
if ($type === 'mod') {
|
|
// perform cleanup tasks specific for activity modules
|
|
|
|
if (!$module = $DB->get_record('modules', array('name' => $name))) {
|
|
print_error('moduledoesnotexist', 'error');
|
|
}
|
|
|
|
// delete all the relevant instances from all course sections
|
|
if ($coursemods = $DB->get_records('course_modules', array('module' => $module->id))) {
|
|
foreach ($coursemods as $coursemod) {
|
|
if (!delete_mod_from_section($coursemod->id, $coursemod->section)) {
|
|
echo $OUTPUT->notification("Could not delete the $strpluginname with id = $coursemod->id from section $coursemod->section");
|
|
}
|
|
}
|
|
}
|
|
|
|
// clear course.modinfo for courses that used this module
|
|
$sql = "UPDATE {course}
|
|
SET modinfo=''
|
|
WHERE id IN (SELECT DISTINCT course
|
|
FROM {course_modules}
|
|
WHERE module=?)";
|
|
$DB->execute($sql, array($module->id));
|
|
|
|
// delete all the course module records
|
|
$DB->delete_records('course_modules', array('module' => $module->id));
|
|
|
|
// delete module contexts
|
|
if ($coursemods) {
|
|
foreach ($coursemods as $coursemod) {
|
|
if (!delete_context(CONTEXT_MODULE, $coursemod->id)) {
|
|
echo $OUTPUT->notification("Could not delete the context for $strpluginname with id = $coursemod->id");
|
|
}
|
|
}
|
|
}
|
|
|
|
// delete the module entry itself
|
|
$DB->delete_records('modules', array('name' => $module->name));
|
|
|
|
// cleanup the gradebook
|
|
require_once($CFG->libdir.'/gradelib.php');
|
|
grade_uninstalled_module($module->name);
|
|
|
|
// Perform any custom uninstall tasks
|
|
if (file_exists($CFG->dirroot . '/mod/' . $module->name . '/lib.php')) {
|
|
require_once($CFG->dirroot . '/mod/' . $module->name . '/lib.php');
|
|
$uninstallfunction = $module->name . '_uninstall';
|
|
if (function_exists($uninstallfunction)) {
|
|
debugging("{$uninstallfunction}() has been deprecated. Use the plugin's db/uninstall.php instead", DEBUG_DEVELOPER);
|
|
if (!$uninstallfunction()) {
|
|
echo $OUTPUT->notification('Encountered a problem running uninstall function for '. $module->name.'!');
|
|
}
|
|
}
|
|
}
|
|
|
|
} else if ($type === 'enrol') {
|
|
// NOTE: this is a bit brute force way - it will not trigger events and hooks properly
|
|
// nuke all role assignments
|
|
role_unassign_all(array('component'=>$component));
|
|
// purge participants
|
|
$DB->delete_records_select('user_enrolments', "enrolid IN (SELECT id FROM {enrol} WHERE enrol = ?)", array($name));
|
|
// purge enrol instances
|
|
$DB->delete_records('enrol', array('enrol'=>$name));
|
|
// tweak enrol settings
|
|
if (!empty($CFG->enrol_plugins_enabled)) {
|
|
$enabledenrols = explode(',', $CFG->enrol_plugins_enabled);
|
|
$enabledenrols = array_unique($enabledenrols);
|
|
$enabledenrols = array_flip($enabledenrols);
|
|
unset($enabledenrols[$name]);
|
|
$enabledenrols = array_flip($enabledenrols);
|
|
if (is_array($enabledenrols)) {
|
|
set_config('enrol_plugins_enabled', implode(',', $enabledenrols));
|
|
}
|
|
}
|
|
|
|
} else if ($type === 'block') {
|
|
if ($block = $DB->get_record('block', array('name'=>$name))) {
|
|
// Inform block it's about to be deleted
|
|
if (file_exists("$CFG->dirroot/blocks/$block->name/block_$block->name.php")) {
|
|
$blockobject = block_instance($block->name);
|
|
if ($blockobject) {
|
|
$blockobject->before_delete(); //only if we can create instance, block might have been already removed
|
|
}
|
|
}
|
|
|
|
// First delete instances and related contexts
|
|
$instances = $DB->get_records('block_instances', array('blockname' => $block->name));
|
|
foreach($instances as $instance) {
|
|
blocks_delete_instance($instance);
|
|
}
|
|
|
|
// Delete block
|
|
$DB->delete_records('block', array('id'=>$block->id));
|
|
}
|
|
} else if ($type === 'format') {
|
|
if (($defaultformat = get_config('moodlecourse', 'format')) && $defaultformat !== $name) {
|
|
$courses = $DB->get_records('course', array('format' => $name), 'id');
|
|
$data = (object)array('id' => null, 'format' => $defaultformat);
|
|
foreach ($courses as $record) {
|
|
$data->id = $record->id;
|
|
update_course($data);
|
|
}
|
|
}
|
|
$DB->delete_records('course_format_options', array('format' => $name));
|
|
}
|
|
|
|
// perform clean-up task common for all the plugin/subplugin types
|
|
|
|
//delete the web service functions and pre-built services
|
|
require_once($CFG->dirroot.'/lib/externallib.php');
|
|
external_delete_descriptions($component);
|
|
|
|
// delete calendar events
|
|
$DB->delete_records('event', array('modulename' => $pluginname));
|
|
|
|
// delete all the logs
|
|
$DB->delete_records('log', array('module' => $pluginname));
|
|
|
|
// delete log_display information
|
|
$DB->delete_records('log_display', array('component' => $component));
|
|
|
|
// delete the module configuration records
|
|
unset_all_config_for_plugin($pluginname);
|
|
|
|
// delete message provider
|
|
message_provider_uninstall($component);
|
|
|
|
// delete message processor
|
|
if ($type === 'message') {
|
|
message_processor_uninstall($name);
|
|
}
|
|
|
|
// delete the plugin tables
|
|
$xmldbfilepath = $plugindirectory . '/db/install.xml';
|
|
drop_plugin_tables($component, $xmldbfilepath, false);
|
|
if ($type === 'mod' or $type === 'block') {
|
|
// non-frankenstyle table prefixes
|
|
drop_plugin_tables($name, $xmldbfilepath, false);
|
|
}
|
|
|
|
// delete the capabilities that were defined by this module
|
|
capabilities_cleanup($component);
|
|
|
|
// remove event handlers and dequeue pending events
|
|
events_uninstall($component);
|
|
|
|
// Delete all remaining files in the filepool owned by the component.
|
|
$fs = get_file_storage();
|
|
$fs->delete_component_files($component);
|
|
|
|
// Finally purge all caches.
|
|
purge_all_caches();
|
|
|
|
echo $OUTPUT->notification(get_string('success'), 'notifysuccess');
|
|
}
|
|
|
|
/**
|
|
* Returns the version of installed component
|
|
*
|
|
* @param string $component component name
|
|
* @param string $source either 'disk' or 'installed' - where to get the version information from
|
|
* @return string|bool version number or false if the component is not found
|
|
*/
|
|
function get_component_version($component, $source='installed') {
|
|
global $CFG, $DB;
|
|
|
|
list($type, $name) = normalize_component($component);
|
|
|
|
// moodle core or a core subsystem
|
|
if ($type === 'core') {
|
|
if ($source === 'installed') {
|
|
if (empty($CFG->version)) {
|
|
return false;
|
|
} else {
|
|
return $CFG->version;
|
|
}
|
|
} else {
|
|
if (!is_readable($CFG->dirroot.'/version.php')) {
|
|
return false;
|
|
} else {
|
|
$version = null; //initialize variable for IDEs
|
|
include($CFG->dirroot.'/version.php');
|
|
return $version;
|
|
}
|
|
}
|
|
}
|
|
|
|
// activity module
|
|
if ($type === 'mod') {
|
|
if ($source === 'installed') {
|
|
return $DB->get_field('modules', 'version', array('name'=>$name));
|
|
} else {
|
|
$mods = get_plugin_list('mod');
|
|
if (empty($mods[$name]) or !is_readable($mods[$name].'/version.php')) {
|
|
return false;
|
|
} else {
|
|
$module = new stdclass();
|
|
include($mods[$name].'/version.php');
|
|
return $module->version;
|
|
}
|
|
}
|
|
}
|
|
|
|
// block
|
|
if ($type === 'block') {
|
|
if ($source === 'installed') {
|
|
return $DB->get_field('block', 'version', array('name'=>$name));
|
|
} else {
|
|
$blocks = get_plugin_list('block');
|
|
if (empty($blocks[$name]) or !is_readable($blocks[$name].'/version.php')) {
|
|
return false;
|
|
} else {
|
|
$plugin = new stdclass();
|
|
include($blocks[$name].'/version.php');
|
|
return $plugin->version;
|
|
}
|
|
}
|
|
}
|
|
|
|
// all other plugin types
|
|
if ($source === 'installed') {
|
|
return get_config($type.'_'.$name, 'version');
|
|
} else {
|
|
$plugins = get_plugin_list($type);
|
|
if (empty($plugins[$name])) {
|
|
return false;
|
|
} else {
|
|
$plugin = new stdclass();
|
|
include($plugins[$name].'/version.php');
|
|
return $plugin->version;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Delete all plugin tables
|
|
*
|
|
* @param string $name Name of plugin, used as table prefix
|
|
* @param string $file Path to install.xml file
|
|
* @param bool $feedback defaults to true
|
|
* @return bool Always returns true
|
|
*/
|
|
function drop_plugin_tables($name, $file, $feedback=true) {
|
|
global $CFG, $DB;
|
|
|
|
// first try normal delete
|
|
if (file_exists($file) and $DB->get_manager()->delete_tables_from_xmldb_file($file)) {
|
|
return true;
|
|
}
|
|
|
|
// then try to find all tables that start with name and are not in any xml file
|
|
$used_tables = get_used_table_names();
|
|
|
|
$tables = $DB->get_tables();
|
|
|
|
/// Iterate over, fixing id fields as necessary
|
|
foreach ($tables as $table) {
|
|
if (in_array($table, $used_tables)) {
|
|
continue;
|
|
}
|
|
|
|
if (strpos($table, $name) !== 0) {
|
|
continue;
|
|
}
|
|
|
|
// found orphan table --> delete it
|
|
if ($DB->get_manager()->table_exists($table)) {
|
|
$xmldb_table = new xmldb_table($table);
|
|
$DB->get_manager()->drop_table($xmldb_table);
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Returns names of all known tables == tables that moodle knows about.
|
|
*
|
|
* @return array Array of lowercase table names
|
|
*/
|
|
function get_used_table_names() {
|
|
$table_names = array();
|
|
$dbdirs = get_db_directories();
|
|
|
|
foreach ($dbdirs as $dbdir) {
|
|
$file = $dbdir.'/install.xml';
|
|
|
|
$xmldb_file = new xmldb_file($file);
|
|
|
|
if (!$xmldb_file->fileExists()) {
|
|
continue;
|
|
}
|
|
|
|
$loaded = $xmldb_file->loadXMLStructure();
|
|
$structure = $xmldb_file->getStructure();
|
|
|
|
if ($loaded and $tables = $structure->getTables()) {
|
|
foreach($tables as $table) {
|
|
$table_names[] = strtolower($table->getName());
|
|
}
|
|
}
|
|
}
|
|
|
|
return $table_names;
|
|
}
|
|
|
|
/**
|
|
* Returns list of all directories where we expect install.xml files
|
|
* @return array Array of paths
|
|
*/
|
|
function get_db_directories() {
|
|
global $CFG;
|
|
|
|
$dbdirs = array();
|
|
|
|
/// First, the main one (lib/db)
|
|
$dbdirs[] = $CFG->libdir.'/db';
|
|
|
|
/// Then, all the ones defined by get_plugin_types()
|
|
$plugintypes = get_plugin_types();
|
|
foreach ($plugintypes as $plugintype => $pluginbasedir) {
|
|
if ($plugins = get_plugin_list($plugintype)) {
|
|
foreach ($plugins as $plugin => $plugindir) {
|
|
$dbdirs[] = $plugindir.'/db';
|
|
}
|
|
}
|
|
}
|
|
|
|
return $dbdirs;
|
|
}
|
|
|
|
/**
|
|
* Try to obtain or release the cron lock.
|
|
* @param string $name name of lock
|
|
* @param int $until timestamp when this lock considered stale, null means remove lock unconditionally
|
|
* @param bool $ignorecurrent ignore current lock state, usually extend previous lock, defaults to false
|
|
* @return bool true if lock obtained
|
|
*/
|
|
function set_cron_lock($name, $until, $ignorecurrent=false) {
|
|
global $DB;
|
|
if (empty($name)) {
|
|
debugging("Tried to get a cron lock for a null fieldname");
|
|
return false;
|
|
}
|
|
|
|
// remove lock by force == remove from config table
|
|
if (is_null($until)) {
|
|
set_config($name, null);
|
|
return true;
|
|
}
|
|
|
|
if (!$ignorecurrent) {
|
|
// read value from db - other processes might have changed it
|
|
$value = $DB->get_field('config', 'value', array('name'=>$name));
|
|
|
|
if ($value and $value > time()) {
|
|
//lock active
|
|
return false;
|
|
}
|
|
}
|
|
|
|
set_config($name, $until);
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Test if and critical warnings are present
|
|
* @return bool
|
|
*/
|
|
function admin_critical_warnings_present() {
|
|
global $SESSION;
|
|
|
|
if (!has_capability('moodle/site:config', context_system::instance())) {
|
|
return 0;
|
|
}
|
|
|
|
if (!isset($SESSION->admin_critical_warning)) {
|
|
$SESSION->admin_critical_warning = 0;
|
|
if (is_dataroot_insecure(true) === INSECURE_DATAROOT_ERROR) {
|
|
$SESSION->admin_critical_warning = 1;
|
|
}
|
|
}
|
|
|
|
return $SESSION->admin_critical_warning;
|
|
}
|
|
|
|
/**
|
|
* Detects if float supports at least 10 decimal digits
|
|
*
|
|
* Detects if float supports at least 10 decimal digits
|
|
* and also if float-->string conversion works as expected.
|
|
*
|
|
* @return bool true if problem found
|
|
*/
|
|
function is_float_problem() {
|
|
$num1 = 2009010200.01;
|
|
$num2 = 2009010200.02;
|
|
|
|
return ((string)$num1 === (string)$num2 or $num1 === $num2 or $num2 <= (string)$num1);
|
|
}
|
|
|
|
/**
|
|
* Try to verify that dataroot is not accessible from web.
|
|
*
|
|
* Try to verify that dataroot is not accessible from web.
|
|
* It is not 100% correct but might help to reduce number of vulnerable sites.
|
|
* Protection from httpd.conf and .htaccess is not detected properly.
|
|
*
|
|
* @uses INSECURE_DATAROOT_WARNING
|
|
* @uses INSECURE_DATAROOT_ERROR
|
|
* @param bool $fetchtest try to test public access by fetching file, default false
|
|
* @return mixed empty means secure, INSECURE_DATAROOT_ERROR found a critical problem, INSECURE_DATAROOT_WARNING might be problematic
|
|
*/
|
|
function is_dataroot_insecure($fetchtest=false) {
|
|
global $CFG;
|
|
|
|
$siteroot = str_replace('\\', '/', strrev($CFG->dirroot.'/')); // win32 backslash workaround
|
|
|
|
$rp = preg_replace('|https?://[^/]+|i', '', $CFG->wwwroot, 1);
|
|
$rp = strrev(trim($rp, '/'));
|
|
$rp = explode('/', $rp);
|
|
foreach($rp as $r) {
|
|
if (strpos($siteroot, '/'.$r.'/') === 0) {
|
|
$siteroot = substr($siteroot, strlen($r)+1); // moodle web in subdirectory
|
|
} else {
|
|
break; // probably alias root
|
|
}
|
|
}
|
|
|
|
$siteroot = strrev($siteroot);
|
|
$dataroot = str_replace('\\', '/', $CFG->dataroot.'/');
|
|
|
|
if (strpos($dataroot, $siteroot) !== 0) {
|
|
return false;
|
|
}
|
|
|
|
if (!$fetchtest) {
|
|
return INSECURE_DATAROOT_WARNING;
|
|
}
|
|
|
|
// now try all methods to fetch a test file using http protocol
|
|
|
|
$httpdocroot = str_replace('\\', '/', strrev($CFG->dirroot.'/'));
|
|
preg_match('|(https?://[^/]+)|i', $CFG->wwwroot, $matches);
|
|
$httpdocroot = $matches[1];
|
|
$datarooturl = $httpdocroot.'/'. substr($dataroot, strlen($siteroot));
|
|
make_upload_directory('diag');
|
|
$testfile = $CFG->dataroot.'/diag/public.txt';
|
|
if (!file_exists($testfile)) {
|
|
file_put_contents($testfile, 'test file, do not delete');
|
|
}
|
|
$teststr = trim(file_get_contents($testfile));
|
|
if (empty($teststr)) {
|
|
// hmm, strange
|
|
return INSECURE_DATAROOT_WARNING;
|
|
}
|
|
|
|
$testurl = $datarooturl.'/diag/public.txt';
|
|
if (extension_loaded('curl') and
|
|
!(stripos(ini_get('disable_functions'), 'curl_init') !== FALSE) and
|
|
!(stripos(ini_get('disable_functions'), 'curl_setop') !== FALSE) and
|
|
($ch = @curl_init($testurl)) !== false) {
|
|
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
|
|
curl_setopt($ch, CURLOPT_HEADER, false);
|
|
$data = curl_exec($ch);
|
|
if (!curl_errno($ch)) {
|
|
$data = trim($data);
|
|
if ($data === $teststr) {
|
|
curl_close($ch);
|
|
return INSECURE_DATAROOT_ERROR;
|
|
}
|
|
}
|
|
curl_close($ch);
|
|
}
|
|
|
|
if ($data = @file_get_contents($testurl)) {
|
|
$data = trim($data);
|
|
if ($data === $teststr) {
|
|
return INSECURE_DATAROOT_ERROR;
|
|
}
|
|
}
|
|
|
|
preg_match('|https?://([^/]+)|i', $testurl, $matches);
|
|
$sitename = $matches[1];
|
|
$error = 0;
|
|
if ($fp = @fsockopen($sitename, 80, $error)) {
|
|
preg_match('|https?://[^/]+(.*)|i', $testurl, $matches);
|
|
$localurl = $matches[1];
|
|
$out = "GET $localurl HTTP/1.1\r\n";
|
|
$out .= "Host: $sitename\r\n";
|
|
$out .= "Connection: Close\r\n\r\n";
|
|
fwrite($fp, $out);
|
|
$data = '';
|
|
$incoming = false;
|
|
while (!feof($fp)) {
|
|
if ($incoming) {
|
|
$data .= fgets($fp, 1024);
|
|
} else if (@fgets($fp, 1024) === "\r\n") {
|
|
$incoming = true;
|
|
}
|
|
}
|
|
fclose($fp);
|
|
$data = trim($data);
|
|
if ($data === $teststr) {
|
|
return INSECURE_DATAROOT_ERROR;
|
|
}
|
|
}
|
|
|
|
return INSECURE_DATAROOT_WARNING;
|
|
}
|
|
|
|
/**
|
|
* Enables CLI maintenance mode by creating new dataroot/climaintenance.html file.
|
|
*/
|
|
function enable_cli_maintenance_mode() {
|
|
global $CFG;
|
|
|
|
if (file_exists("$CFG->dataroot/climaintenance.html")) {
|
|
unlink("$CFG->dataroot/climaintenance.html");
|
|
}
|
|
|
|
if (isset($CFG->maintenance_message) and !html_is_blank($CFG->maintenance_message)) {
|
|
$data = $CFG->maintenance_message;
|
|
$data = bootstrap_renderer::early_error_content($data, null, null, null);
|
|
$data = bootstrap_renderer::plain_page(get_string('sitemaintenance', 'admin'), $data);
|
|
|
|
} else if (file_exists("$CFG->dataroot/climaintenance.template.html")) {
|
|
$data = file_get_contents("$CFG->dataroot/climaintenance.template.html");
|
|
|
|
} else {
|
|
$data = get_string('sitemaintenance', 'admin');
|
|
$data = bootstrap_renderer::early_error_content($data, null, null, null);
|
|
$data = bootstrap_renderer::plain_page(get_string('sitemaintenance', 'admin'), $data);
|
|
}
|
|
|
|
file_put_contents("$CFG->dataroot/climaintenance.html", $data);
|
|
chmod("$CFG->dataroot/climaintenance.html", $CFG->filepermissions);
|
|
}
|
|
|
|
/// CLASS DEFINITIONS /////////////////////////////////////////////////////////
|
|
|
|
|
|
/**
|
|
* Interface for anything appearing in the admin tree
|
|
*
|
|
* The interface that is implemented by anything that appears in the admin tree
|
|
* block. It forces inheriting classes to define a method for checking user permissions
|
|
* and methods for finding something in the admin tree.
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
interface part_of_admin_tree {
|
|
|
|
/**
|
|
* Finds a named part_of_admin_tree.
|
|
*
|
|
* Used to find a part_of_admin_tree. If a class only inherits part_of_admin_tree
|
|
* and not parentable_part_of_admin_tree, then this function should only check if
|
|
* $this->name matches $name. If it does, it should return a reference to $this,
|
|
* otherwise, it should return a reference to NULL.
|
|
*
|
|
* If a class inherits parentable_part_of_admin_tree, this method should be called
|
|
* recursively on all child objects (assuming, of course, the parent object's name
|
|
* doesn't match the search criterion).
|
|
*
|
|
* @param string $name The internal name of the part_of_admin_tree we're searching for.
|
|
* @return mixed An object reference or a NULL reference.
|
|
*/
|
|
public function locate($name);
|
|
|
|
/**
|
|
* Removes named part_of_admin_tree.
|
|
*
|
|
* @param string $name The internal name of the part_of_admin_tree we want to remove.
|
|
* @return bool success.
|
|
*/
|
|
public function prune($name);
|
|
|
|
/**
|
|
* Search using query
|
|
* @param string $query
|
|
* @return mixed array-object structure of found settings and pages
|
|
*/
|
|
public function search($query);
|
|
|
|
/**
|
|
* Verifies current user's access to this part_of_admin_tree.
|
|
*
|
|
* Used to check if the current user has access to this part of the admin tree or
|
|
* not. If a class only inherits part_of_admin_tree and not parentable_part_of_admin_tree,
|
|
* then this method is usually just a call to has_capability() in the site context.
|
|
*
|
|
* If a class inherits parentable_part_of_admin_tree, this method should return the
|
|
* logical OR of the return of check_access() on all child objects.
|
|
*
|
|
* @return bool True if the user has access, false if she doesn't.
|
|
*/
|
|
public function check_access();
|
|
|
|
/**
|
|
* Mostly useful for removing of some parts of the tree in admin tree block.
|
|
*
|
|
* @return True is hidden from normal list view
|
|
*/
|
|
public function is_hidden();
|
|
|
|
/**
|
|
* Show we display Save button at the page bottom?
|
|
* @return bool
|
|
*/
|
|
public function show_save();
|
|
}
|
|
|
|
|
|
/**
|
|
* Interface implemented by any part_of_admin_tree that has children.
|
|
*
|
|
* The interface implemented by any part_of_admin_tree that can be a parent
|
|
* to other part_of_admin_tree's. (For now, this only includes admin_category.) Apart
|
|
* from ensuring part_of_admin_tree compliancy, it also ensures inheriting methods
|
|
* include an add method for adding other part_of_admin_tree objects as children.
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
interface parentable_part_of_admin_tree extends part_of_admin_tree {
|
|
|
|
/**
|
|
* Adds a part_of_admin_tree object to the admin tree.
|
|
*
|
|
* Used to add a part_of_admin_tree object to this object or a child of this
|
|
* object. $something should only be added if $destinationname matches
|
|
* $this->name. If it doesn't, add should be called on child objects that are
|
|
* also parentable_part_of_admin_tree's.
|
|
*
|
|
* $something should be appended as the last child in the $destinationname. If the
|
|
* $beforesibling is specified, $something should be prepended to it. If the given
|
|
* sibling is not found, $something should be appended to the end of $destinationname
|
|
* and a developer debugging message should be displayed.
|
|
*
|
|
* @param string $destinationname The internal name of the new parent for $something.
|
|
* @param part_of_admin_tree $something The object to be added.
|
|
* @return bool True on success, false on failure.
|
|
*/
|
|
public function add($destinationname, $something, $beforesibling = null);
|
|
|
|
}
|
|
|
|
|
|
/**
|
|
* The object used to represent folders (a.k.a. categories) in the admin tree block.
|
|
*
|
|
* Each admin_category object contains a number of part_of_admin_tree objects.
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_category implements parentable_part_of_admin_tree {
|
|
|
|
/** @var mixed An array of part_of_admin_tree objects that are this object's children */
|
|
public $children;
|
|
/** @var string An internal name for this category. Must be unique amongst ALL part_of_admin_tree objects */
|
|
public $name;
|
|
/** @var string The displayed name for this category. Usually obtained through get_string() */
|
|
public $visiblename;
|
|
/** @var bool Should this category be hidden in admin tree block? */
|
|
public $hidden;
|
|
/** @var mixed Either a string or an array or strings */
|
|
public $path;
|
|
/** @var mixed Either a string or an array or strings */
|
|
public $visiblepath;
|
|
|
|
/** @var array fast lookup category cache, all categories of one tree point to one cache */
|
|
protected $category_cache;
|
|
|
|
/**
|
|
* Constructor for an empty admin category
|
|
*
|
|
* @param string $name The internal name for this category. Must be unique amongst ALL part_of_admin_tree objects
|
|
* @param string $visiblename The displayed named for this category. Usually obtained through get_string()
|
|
* @param bool $hidden hide category in admin tree block, defaults to false
|
|
*/
|
|
public function __construct($name, $visiblename, $hidden=false) {
|
|
$this->children = array();
|
|
$this->name = $name;
|
|
$this->visiblename = $visiblename;
|
|
$this->hidden = $hidden;
|
|
}
|
|
|
|
/**
|
|
* Returns a reference to the part_of_admin_tree object with internal name $name.
|
|
*
|
|
* @param string $name The internal name of the object we want.
|
|
* @param bool $findpath initialize path and visiblepath arrays
|
|
* @return mixed A reference to the object with internal name $name if found, otherwise a reference to NULL.
|
|
* defaults to false
|
|
*/
|
|
public function locate($name, $findpath=false) {
|
|
if (!isset($this->category_cache[$this->name])) {
|
|
// somebody much have purged the cache
|
|
$this->category_cache[$this->name] = $this;
|
|
}
|
|
|
|
if ($this->name == $name) {
|
|
if ($findpath) {
|
|
$this->visiblepath[] = $this->visiblename;
|
|
$this->path[] = $this->name;
|
|
}
|
|
return $this;
|
|
}
|
|
|
|
// quick category lookup
|
|
if (!$findpath and isset($this->category_cache[$name])) {
|
|
return $this->category_cache[$name];
|
|
}
|
|
|
|
$return = NULL;
|
|
foreach($this->children as $childid=>$unused) {
|
|
if ($return = $this->children[$childid]->locate($name, $findpath)) {
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (!is_null($return) and $findpath) {
|
|
$return->visiblepath[] = $this->visiblename;
|
|
$return->path[] = $this->name;
|
|
}
|
|
|
|
return $return;
|
|
}
|
|
|
|
/**
|
|
* Search using query
|
|
*
|
|
* @param string query
|
|
* @return mixed array-object structure of found settings and pages
|
|
*/
|
|
public function search($query) {
|
|
$result = array();
|
|
foreach ($this->children as $child) {
|
|
$subsearch = $child->search($query);
|
|
if (!is_array($subsearch)) {
|
|
debugging('Incorrect search result from '.$child->name);
|
|
continue;
|
|
}
|
|
$result = array_merge($result, $subsearch);
|
|
}
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* Removes part_of_admin_tree object with internal name $name.
|
|
*
|
|
* @param string $name The internal name of the object we want to remove.
|
|
* @return bool success
|
|
*/
|
|
public function prune($name) {
|
|
|
|
if ($this->name == $name) {
|
|
return false; //can not remove itself
|
|
}
|
|
|
|
foreach($this->children as $precedence => $child) {
|
|
if ($child->name == $name) {
|
|
// clear cache and delete self
|
|
while($this->category_cache) {
|
|
// delete the cache, but keep the original array address
|
|
array_pop($this->category_cache);
|
|
}
|
|
unset($this->children[$precedence]);
|
|
return true;
|
|
} else if ($this->children[$precedence]->prune($name)) {
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Adds a part_of_admin_tree to a child or grandchild (or great-grandchild, and so forth) of this object.
|
|
*
|
|
* By default the new part of the tree is appended as the last child of the parent. You
|
|
* can specify a sibling node that the new part should be prepended to. If the given
|
|
* sibling is not found, the part is appended to the end (as it would be by default) and
|
|
* a developer debugging message is displayed.
|
|
*
|
|
* @throws coding_exception if the $beforesibling is empty string or is not string at all.
|
|
* @param string $destinationame The internal name of the immediate parent that we want for $something.
|
|
* @param mixed $something A part_of_admin_tree or setting instance to be added.
|
|
* @param string $beforesibling The name of the parent's child the $something should be prepended to.
|
|
* @return bool True if successfully added, false if $something can not be added.
|
|
*/
|
|
public function add($parentname, $something, $beforesibling = null) {
|
|
$parent = $this->locate($parentname);
|
|
if (is_null($parent)) {
|
|
debugging('parent does not exist!');
|
|
return false;
|
|
}
|
|
|
|
if ($something instanceof part_of_admin_tree) {
|
|
if (!($parent instanceof parentable_part_of_admin_tree)) {
|
|
debugging('error - parts of tree can be inserted only into parentable parts');
|
|
return false;
|
|
}
|
|
if (debugging('', DEBUG_DEVELOPER) && !is_null($this->locate($something->name))) {
|
|
// The name of the node is already used, simply warn the developer that this should not happen.
|
|
// It is intentional to check for the debug level before performing the check.
|
|
debugging('Duplicate admin page name: ' . $something->name, DEBUG_DEVELOPER);
|
|
}
|
|
if (is_null($beforesibling)) {
|
|
// Append $something as the parent's last child.
|
|
$parent->children[] = $something;
|
|
} else {
|
|
if (!is_string($beforesibling) or trim($beforesibling) === '') {
|
|
throw new coding_exception('Unexpected value of the beforesibling parameter');
|
|
}
|
|
// Try to find the position of the sibling.
|
|
$siblingposition = null;
|
|
foreach ($parent->children as $childposition => $child) {
|
|
if ($child->name === $beforesibling) {
|
|
$siblingposition = $childposition;
|
|
break;
|
|
}
|
|
}
|
|
if (is_null($siblingposition)) {
|
|
debugging('Sibling '.$beforesibling.' not found', DEBUG_DEVELOPER);
|
|
$parent->children[] = $something;
|
|
} else {
|
|
$parent->children = array_merge(
|
|
array_slice($parent->children, 0, $siblingposition),
|
|
array($something),
|
|
array_slice($parent->children, $siblingposition)
|
|
);
|
|
}
|
|
}
|
|
if ($something instanceof admin_category) {
|
|
if (isset($this->category_cache[$something->name])) {
|
|
debugging('Duplicate admin category name: '.$something->name);
|
|
} else {
|
|
$this->category_cache[$something->name] = $something;
|
|
$something->category_cache =& $this->category_cache;
|
|
foreach ($something->children as $child) {
|
|
// just in case somebody already added subcategories
|
|
if ($child instanceof admin_category) {
|
|
if (isset($this->category_cache[$child->name])) {
|
|
debugging('Duplicate admin category name: '.$child->name);
|
|
} else {
|
|
$this->category_cache[$child->name] = $child;
|
|
$child->category_cache =& $this->category_cache;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
return true;
|
|
|
|
} else {
|
|
debugging('error - can not add this element');
|
|
return false;
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* Checks if the user has access to anything in this category.
|
|
*
|
|
* @return bool True if the user has access to at least one child in this category, false otherwise.
|
|
*/
|
|
public function check_access() {
|
|
foreach ($this->children as $child) {
|
|
if ($child->check_access()) {
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Is this category hidden in admin tree block?
|
|
*
|
|
* @return bool True if hidden
|
|
*/
|
|
public function is_hidden() {
|
|
return $this->hidden;
|
|
}
|
|
|
|
/**
|
|
* Show we display Save button at the page bottom?
|
|
* @return bool
|
|
*/
|
|
public function show_save() {
|
|
foreach ($this->children as $child) {
|
|
if ($child->show_save()) {
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Root of admin settings tree, does not have any parent.
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_root extends admin_category {
|
|
/** @var array List of errors */
|
|
public $errors;
|
|
/** @var string search query */
|
|
public $search;
|
|
/** @var bool full tree flag - true means all settings required, false only pages required */
|
|
public $fulltree;
|
|
/** @var bool flag indicating loaded tree */
|
|
public $loaded;
|
|
/** @var mixed site custom defaults overriding defaults in settings files*/
|
|
public $custom_defaults;
|
|
|
|
/**
|
|
* @param bool $fulltree true means all settings required,
|
|
* false only pages required
|
|
*/
|
|
public function __construct($fulltree) {
|
|
global $CFG;
|
|
|
|
parent::__construct('root', get_string('administration'), false);
|
|
$this->errors = array();
|
|
$this->search = '';
|
|
$this->fulltree = $fulltree;
|
|
$this->loaded = false;
|
|
|
|
$this->category_cache = array();
|
|
|
|
// load custom defaults if found
|
|
$this->custom_defaults = null;
|
|
$defaultsfile = "$CFG->dirroot/local/defaults.php";
|
|
if (is_readable($defaultsfile)) {
|
|
$defaults = array();
|
|
include($defaultsfile);
|
|
if (is_array($defaults) and count($defaults)) {
|
|
$this->custom_defaults = $defaults;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Empties children array, and sets loaded to false
|
|
*
|
|
* @param bool $requirefulltree
|
|
*/
|
|
public function purge_children($requirefulltree) {
|
|
$this->children = array();
|
|
$this->fulltree = ($requirefulltree || $this->fulltree);
|
|
$this->loaded = false;
|
|
//break circular dependencies - this helps PHP 5.2
|
|
while($this->category_cache) {
|
|
array_pop($this->category_cache);
|
|
}
|
|
$this->category_cache = array();
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Links external PHP pages into the admin tree.
|
|
*
|
|
* See detailed usage example at the top of this document (adminlib.php)
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_externalpage implements part_of_admin_tree {
|
|
|
|
/** @var string An internal name for this external page. Must be unique amongst ALL part_of_admin_tree objects */
|
|
public $name;
|
|
|
|
/** @var string The displayed name for this external page. Usually obtained through get_string(). */
|
|
public $visiblename;
|
|
|
|
/** @var string The external URL that we should link to when someone requests this external page. */
|
|
public $url;
|
|
|
|
/** @var string The role capability/permission a user must have to access this external page. */
|
|
public $req_capability;
|
|
|
|
/** @var object The context in which capability/permission should be checked, default is site context. */
|
|
public $context;
|
|
|
|
/** @var bool hidden in admin tree block. */
|
|
public $hidden;
|
|
|
|
/** @var mixed either string or array of string */
|
|
public $path;
|
|
|
|
/** @var array list of visible names of page parents */
|
|
public $visiblepath;
|
|
|
|
/**
|
|
* Constructor for adding an external page into the admin tree.
|
|
*
|
|
* @param string $name The internal name for this external page. Must be unique amongst ALL part_of_admin_tree objects.
|
|
* @param string $visiblename The displayed name for this external page. Usually obtained through get_string().
|
|
* @param string $url The external URL that we should link to when someone requests this external page.
|
|
* @param mixed $req_capability The role capability/permission a user must have to access this external page. Defaults to 'moodle/site:config'.
|
|
* @param boolean $hidden Is this external page hidden in admin tree block? Default false.
|
|
* @param stdClass $context The context the page relates to. Not sure what happens
|
|
* if you specify something other than system or front page. Defaults to system.
|
|
*/
|
|
public function __construct($name, $visiblename, $url, $req_capability='moodle/site:config', $hidden=false, $context=NULL) {
|
|
$this->name = $name;
|
|
$this->visiblename = $visiblename;
|
|
$this->url = $url;
|
|
if (is_array($req_capability)) {
|
|
$this->req_capability = $req_capability;
|
|
} else {
|
|
$this->req_capability = array($req_capability);
|
|
}
|
|
$this->hidden = $hidden;
|
|
$this->context = $context;
|
|
}
|
|
|
|
/**
|
|
* Returns a reference to the part_of_admin_tree object with internal name $name.
|
|
*
|
|
* @param string $name The internal name of the object we want.
|
|
* @param bool $findpath defaults to false
|
|
* @return mixed A reference to the object with internal name $name if found, otherwise a reference to NULL.
|
|
*/
|
|
public function locate($name, $findpath=false) {
|
|
if ($this->name == $name) {
|
|
if ($findpath) {
|
|
$this->visiblepath = array($this->visiblename);
|
|
$this->path = array($this->name);
|
|
}
|
|
return $this;
|
|
} else {
|
|
$return = NULL;
|
|
return $return;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* This function always returns false, required function by interface
|
|
*
|
|
* @param string $name
|
|
* @return false
|
|
*/
|
|
public function prune($name) {
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Search using query
|
|
*
|
|
* @param string $query
|
|
* @return mixed array-object structure of found settings and pages
|
|
*/
|
|
public function search($query) {
|
|
$found = false;
|
|
if (strpos(strtolower($this->name), $query) !== false) {
|
|
$found = true;
|
|
} else if (strpos(textlib::strtolower($this->visiblename), $query) !== false) {
|
|
$found = true;
|
|
}
|
|
if ($found) {
|
|
$result = new stdClass();
|
|
$result->page = $this;
|
|
$result->settings = array();
|
|
return array($this->name => $result);
|
|
} else {
|
|
return array();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Determines if the current user has access to this external page based on $this->req_capability.
|
|
*
|
|
* @return bool True if user has access, false otherwise.
|
|
*/
|
|
public function check_access() {
|
|
global $CFG;
|
|
$context = empty($this->context) ? context_system::instance() : $this->context;
|
|
foreach($this->req_capability as $cap) {
|
|
if (has_capability($cap, $context)) {
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Is this external page hidden in admin tree block?
|
|
*
|
|
* @return bool True if hidden
|
|
*/
|
|
public function is_hidden() {
|
|
return $this->hidden;
|
|
}
|
|
|
|
/**
|
|
* Show we display Save button at the page bottom?
|
|
* @return bool
|
|
*/
|
|
public function show_save() {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Used to group a number of admin_setting objects into a page and add them to the admin tree.
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_settingpage implements part_of_admin_tree {
|
|
|
|
/** @var string An internal name for this external page. Must be unique amongst ALL part_of_admin_tree objects */
|
|
public $name;
|
|
|
|
/** @var string The displayed name for this external page. Usually obtained through get_string(). */
|
|
public $visiblename;
|
|
|
|
/** @var mixed An array of admin_setting objects that are part of this setting page. */
|
|
public $settings;
|
|
|
|
/** @var string The role capability/permission a user must have to access this external page. */
|
|
public $req_capability;
|
|
|
|
/** @var object The context in which capability/permission should be checked, default is site context. */
|
|
public $context;
|
|
|
|
/** @var bool hidden in admin tree block. */
|
|
public $hidden;
|
|
|
|
/** @var mixed string of paths or array of strings of paths */
|
|
public $path;
|
|
|
|
/** @var array list of visible names of page parents */
|
|
public $visiblepath;
|
|
|
|
/**
|
|
* see admin_settingpage for details of this function
|
|
*
|
|
* @param string $name The internal name for this external page. Must be unique amongst ALL part_of_admin_tree objects.
|
|
* @param string $visiblename The displayed name for this external page. Usually obtained through get_string().
|
|
* @param mixed $req_capability The role capability/permission a user must have to access this external page. Defaults to 'moodle/site:config'.
|
|
* @param boolean $hidden Is this external page hidden in admin tree block? Default false.
|
|
* @param stdClass $context The context the page relates to. Not sure what happens
|
|
* if you specify something other than system or front page. Defaults to system.
|
|
*/
|
|
public function __construct($name, $visiblename, $req_capability='moodle/site:config', $hidden=false, $context=NULL) {
|
|
$this->settings = new stdClass();
|
|
$this->name = $name;
|
|
$this->visiblename = $visiblename;
|
|
if (is_array($req_capability)) {
|
|
$this->req_capability = $req_capability;
|
|
} else {
|
|
$this->req_capability = array($req_capability);
|
|
}
|
|
$this->hidden = $hidden;
|
|
$this->context = $context;
|
|
}
|
|
|
|
/**
|
|
* see admin_category
|
|
*
|
|
* @param string $name
|
|
* @param bool $findpath
|
|
* @return mixed Object (this) if name == this->name, else returns null
|
|
*/
|
|
public function locate($name, $findpath=false) {
|
|
if ($this->name == $name) {
|
|
if ($findpath) {
|
|
$this->visiblepath = array($this->visiblename);
|
|
$this->path = array($this->name);
|
|
}
|
|
return $this;
|
|
} else {
|
|
$return = NULL;
|
|
return $return;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Search string in settings page.
|
|
*
|
|
* @param string $query
|
|
* @return array
|
|
*/
|
|
public function search($query) {
|
|
$found = array();
|
|
|
|
foreach ($this->settings as $setting) {
|
|
if ($setting->is_related($query)) {
|
|
$found[] = $setting;
|
|
}
|
|
}
|
|
|
|
if ($found) {
|
|
$result = new stdClass();
|
|
$result->page = $this;
|
|
$result->settings = $found;
|
|
return array($this->name => $result);
|
|
}
|
|
|
|
$found = false;
|
|
if (strpos(strtolower($this->name), $query) !== false) {
|
|
$found = true;
|
|
} else if (strpos(textlib::strtolower($this->visiblename), $query) !== false) {
|
|
$found = true;
|
|
}
|
|
if ($found) {
|
|
$result = new stdClass();
|
|
$result->page = $this;
|
|
$result->settings = array();
|
|
return array($this->name => $result);
|
|
} else {
|
|
return array();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* This function always returns false, required by interface
|
|
*
|
|
* @param string $name
|
|
* @return bool Always false
|
|
*/
|
|
public function prune($name) {
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* adds an admin_setting to this admin_settingpage
|
|
*
|
|
* not the same as add for admin_category. adds an admin_setting to this admin_settingpage. settings appear (on the settingpage) in the order in which they're added
|
|
* n.b. each admin_setting in an admin_settingpage must have a unique internal name
|
|
*
|
|
* @param object $setting is the admin_setting object you want to add
|
|
* @return bool true if successful, false if not
|
|
*/
|
|
public function add($setting) {
|
|
if (!($setting instanceof admin_setting)) {
|
|
debugging('error - not a setting instance');
|
|
return false;
|
|
}
|
|
|
|
$this->settings->{$setting->name} = $setting;
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* see admin_externalpage
|
|
*
|
|
* @return bool Returns true for yes false for no
|
|
*/
|
|
public function check_access() {
|
|
global $CFG;
|
|
$context = empty($this->context) ? context_system::instance() : $this->context;
|
|
foreach($this->req_capability as $cap) {
|
|
if (has_capability($cap, $context)) {
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* outputs this page as html in a table (suitable for inclusion in an admin pagetype)
|
|
* @return string Returns an XHTML string
|
|
*/
|
|
public function output_html() {
|
|
$adminroot = admin_get_root();
|
|
$return = '<fieldset>'."\n".'<div class="clearer"><!-- --></div>'."\n";
|
|
foreach($this->settings as $setting) {
|
|
$fullname = $setting->get_full_name();
|
|
if (array_key_exists($fullname, $adminroot->errors)) {
|
|
$data = $adminroot->errors[$fullname]->data;
|
|
} else {
|
|
$data = $setting->get_setting();
|
|
// do not use defaults if settings not available - upgrade settings handles the defaults!
|
|
}
|
|
$return .= $setting->output_html($data);
|
|
}
|
|
$return .= '</fieldset>';
|
|
return $return;
|
|
}
|
|
|
|
/**
|
|
* Is this settings page hidden in admin tree block?
|
|
*
|
|
* @return bool True if hidden
|
|
*/
|
|
public function is_hidden() {
|
|
return $this->hidden;
|
|
}
|
|
|
|
/**
|
|
* Show we display Save button at the page bottom?
|
|
* @return bool
|
|
*/
|
|
public function show_save() {
|
|
foreach($this->settings as $setting) {
|
|
if (empty($setting->nosave)) {
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Admin settings class. Only exists on setting pages.
|
|
* Read & write happens at this level; no authentication.
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
abstract class admin_setting {
|
|
/** @var string unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins. */
|
|
public $name;
|
|
/** @var string localised name */
|
|
public $visiblename;
|
|
/** @var string localised long description in Markdown format */
|
|
public $description;
|
|
/** @var mixed Can be string or array of string */
|
|
public $defaultsetting;
|
|
/** @var string */
|
|
public $updatedcallback;
|
|
/** @var mixed can be String or Null. Null means main config table */
|
|
public $plugin; // null means main config table
|
|
/** @var bool true indicates this setting does not actually save anything, just information */
|
|
public $nosave = false;
|
|
/** @var bool if set, indicates that a change to this setting requires rebuild course cache */
|
|
public $affectsmodinfo = false;
|
|
/** @var array of admin_setting_flag - These are extra checkboxes attached to a setting. */
|
|
private $flags = array();
|
|
|
|
/**
|
|
* 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 mixed $defaultsetting string or array depending on implementation
|
|
*/
|
|
public function __construct($name, $visiblename, $description, $defaultsetting) {
|
|
$this->parse_setting_name($name);
|
|
$this->visiblename = $visiblename;
|
|
$this->description = $description;
|
|
$this->defaultsetting = $defaultsetting;
|
|
}
|
|
|
|
/**
|
|
* Generic function to add a flag to this admin setting.
|
|
*
|
|
* @param bool $enabled - One of self::OPTION_ENABLED or self::OPTION_DISABLED
|
|
* @param bool $default - The default for the flag
|
|
* @param string $shortname - The shortname for this flag. Used as a suffix for the setting name.
|
|
* @param string $displayname - The display name for this flag. Used as a label next to the checkbox.
|
|
*/
|
|
protected function set_flag_options($enabled, $default, $shortname, $displayname) {
|
|
if (empty($this->flags[$shortname])) {
|
|
$this->flags[$shortname] = new admin_setting_flag($enabled, $default, $shortname, $displayname);
|
|
} else {
|
|
$this->flags[$shortname]->set_options($enabled, $default);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Set the enabled options flag on this admin setting.
|
|
*
|
|
* @param bool $enabled - One of self::OPTION_ENABLED or self::OPTION_DISABLED
|
|
* @param bool $default - The default for the flag
|
|
*/
|
|
public function set_enabled_flag_options($enabled, $default) {
|
|
$this->set_flag_options($enabled, $default, 'enabled', new lang_string('enabled', 'core_admin'));
|
|
}
|
|
|
|
/**
|
|
* Set the advanced options flag on this admin setting.
|
|
*
|
|
* @param bool $enabled - One of self::OPTION_ENABLED or self::OPTION_DISABLED
|
|
* @param bool $default - The default for the flag
|
|
*/
|
|
public function set_advanced_flag_options($enabled, $default) {
|
|
$this->set_flag_options($enabled, $default, 'adv', new lang_string('advanced'));
|
|
}
|
|
|
|
|
|
/**
|
|
* Set the locked options flag on this admin setting.
|
|
*
|
|
* @param bool $enabled - One of self::OPTION_ENABLED or self::OPTION_DISABLED
|
|
* @param bool $default - The default for the flag
|
|
*/
|
|
public function set_locked_flag_options($enabled, $default) {
|
|
$this->set_flag_options($enabled, $default, 'locked', new lang_string('locked', 'core_admin'));
|
|
}
|
|
|
|
/**
|
|
* Get the currently saved value for a setting flag
|
|
*
|
|
* @param admin_setting_flag $flag - One of the admin_setting_flag for this admin_setting.
|
|
* @return bool
|
|
*/
|
|
public function get_setting_flag_value(admin_setting_flag $flag) {
|
|
$value = $this->config_read($this->name . '_' . $flag->get_shortname());
|
|
if (!isset($value)) {
|
|
$value = $flag->get_default();
|
|
}
|
|
|
|
return !empty($value);
|
|
}
|
|
|
|
/**
|
|
* Get the list of defaults for the flags on this setting.
|
|
*
|
|
* @param array of strings describing the defaults for this setting. This is appended to by this function.
|
|
*/
|
|
public function get_setting_flag_defaults(& $defaults) {
|
|
foreach ($this->flags as $flag) {
|
|
if ($flag->is_enabled() && $flag->get_default()) {
|
|
$defaults[] = $flag->get_displayname();
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Output the input fields for the advanced and locked flags on this setting.
|
|
*
|
|
* @param bool $adv - The current value of the advanced flag.
|
|
* @param bool $locked - The current value of the locked flag.
|
|
* @return string $output - The html for the flags.
|
|
*/
|
|
public function output_setting_flags() {
|
|
$output = '';
|
|
|
|
foreach ($this->flags as $flag) {
|
|
if ($flag->is_enabled()) {
|
|
$output .= $flag->output_setting_flag($this);
|
|
}
|
|
}
|
|
|
|
if (!empty($output)) {
|
|
return html_writer::tag('span', $output, array('class' => 'adminsettingsflags'));
|
|
}
|
|
return $output;
|
|
}
|
|
|
|
/**
|
|
* Write the values of the flags for this admin setting.
|
|
*
|
|
* @param array $data - The data submitted from the form or null to set the default value for new installs.
|
|
* @return bool - true if successful.
|
|
*/
|
|
public function write_setting_flags($data) {
|
|
$result = true;
|
|
foreach ($this->flags as $flag) {
|
|
$result = $result && $flag->write_setting_flag($this, $data);
|
|
}
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* Set up $this->name and potentially $this->plugin
|
|
*
|
|
* Set up $this->name and possibly $this->plugin based on whether $name looks
|
|
* like 'settingname' or 'plugin/settingname'. Also, do some sanity checking
|
|
* on the names, that is, output a developer debug warning if the name
|
|
* contains anything other than [a-zA-Z0-9_]+.
|
|
*
|
|
* @param string $name the setting name passed in to the constructor.
|
|
*/
|
|
private function parse_setting_name($name) {
|
|
$bits = explode('/', $name);
|
|
if (count($bits) > 2) {
|
|
throw new moodle_exception('invalidadminsettingname', '', '', $name);
|
|
}
|
|
$this->name = array_pop($bits);
|
|
if (!preg_match('/^[a-zA-Z0-9_]+$/', $this->name)) {
|
|
throw new moodle_exception('invalidadminsettingname', '', '', $name);
|
|
}
|
|
if (!empty($bits)) {
|
|
$this->plugin = array_pop($bits);
|
|
if ($this->plugin === 'moodle') {
|
|
$this->plugin = null;
|
|
} else if (!preg_match('/^[a-zA-Z0-9_]+$/', $this->plugin)) {
|
|
throw new moodle_exception('invalidadminsettingname', '', '', $name);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns the fullname prefixed by the plugin
|
|
* @return string
|
|
*/
|
|
public function get_full_name() {
|
|
return 's_'.$this->plugin.'_'.$this->name;
|
|
}
|
|
|
|
/**
|
|
* Returns the ID string based on plugin and name
|
|
* @return string
|
|
*/
|
|
public function get_id() {
|
|
return 'id_s_'.$this->plugin.'_'.$this->name;
|
|
}
|
|
|
|
/**
|
|
* @param bool $affectsmodinfo If true, changes to this setting will
|
|
* cause the course cache to be rebuilt
|
|
*/
|
|
public function set_affects_modinfo($affectsmodinfo) {
|
|
$this->affectsmodinfo = $affectsmodinfo;
|
|
}
|
|
|
|
/**
|
|
* Returns the config if possible
|
|
*
|
|
* @return mixed returns config if successful else null
|
|
*/
|
|
public function config_read($name) {
|
|
global $CFG;
|
|
if (!empty($this->plugin)) {
|
|
$value = get_config($this->plugin, $name);
|
|
return $value === false ? NULL : $value;
|
|
|
|
} else {
|
|
if (isset($CFG->$name)) {
|
|
return $CFG->$name;
|
|
} else {
|
|
return NULL;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Used to set a config pair and log change
|
|
*
|
|
* @param string $name
|
|
* @param mixed $value Gets converted to string if not null
|
|
* @return bool Write setting to config table
|
|
*/
|
|
public function config_write($name, $value) {
|
|
global $DB, $USER, $CFG;
|
|
|
|
if ($this->nosave) {
|
|
return true;
|
|
}
|
|
|
|
// make sure it is a real change
|
|
$oldvalue = get_config($this->plugin, $name);
|
|
$oldvalue = ($oldvalue === false) ? null : $oldvalue; // normalise
|
|
$value = is_null($value) ? null : (string)$value;
|
|
|
|
if ($oldvalue === $value) {
|
|
return true;
|
|
}
|
|
|
|
// store change
|
|
set_config($name, $value, $this->plugin);
|
|
|
|
// Some admin settings affect course modinfo
|
|
if ($this->affectsmodinfo) {
|
|
// Clear course cache for all courses
|
|
rebuild_course_cache(0, true);
|
|
}
|
|
|
|
add_to_config_log($name, $oldvalue, $value, $this->plugin);
|
|
|
|
return true; // BC only
|
|
}
|
|
|
|
/**
|
|
* Returns current value of this setting
|
|
* @return mixed array or string depending on instance, NULL means not set yet
|
|
*/
|
|
public abstract function get_setting();
|
|
|
|
/**
|
|
* Returns default setting if exists
|
|
* @return mixed array or string depending on instance; NULL means no default, user must supply
|
|
*/
|
|
public function get_defaultsetting() {
|
|
$adminroot = admin_get_root(false, false);
|
|
if (!empty($adminroot->custom_defaults)) {
|
|
$plugin = is_null($this->plugin) ? 'moodle' : $this->plugin;
|
|
if (isset($adminroot->custom_defaults[$plugin])) {
|
|
if (array_key_exists($this->name, $adminroot->custom_defaults[$plugin])) { // null is valid value here ;-)
|
|
return $adminroot->custom_defaults[$plugin][$this->name];
|
|
}
|
|
}
|
|
}
|
|
return $this->defaultsetting;
|
|
}
|
|
|
|
/**
|
|
* Store new setting
|
|
*
|
|
* @param mixed $data string or array, must not be NULL
|
|
* @return string empty string if ok, string error message otherwise
|
|
*/
|
|
public abstract function write_setting($data);
|
|
|
|
/**
|
|
* Return part of form with setting
|
|
* This function should always be overwritten
|
|
*
|
|
* @param mixed $data array or string depending on setting
|
|
* @param string $query
|
|
* @return string
|
|
*/
|
|
public function output_html($data, $query='') {
|
|
// should be overridden
|
|
return;
|
|
}
|
|
|
|
/**
|
|
* Function called if setting updated - cleanup, cache reset, etc.
|
|
* @param string $functionname Sets the function name
|
|
* @return void
|
|
*/
|
|
public function set_updatedcallback($functionname) {
|
|
$this->updatedcallback = $functionname;
|
|
}
|
|
|
|
/**
|
|
* Execute postupdatecallback if necessary.
|
|
* @param mixed $original original value before write_setting()
|
|
* @return bool true if changed, false if not.
|
|
*/
|
|
public function post_write_settings($original) {
|
|
// Comparison must work for arrays too.
|
|
if (serialize($original) === serialize($this->get_setting())) {
|
|
return false;
|
|
}
|
|
|
|
$callbackfunction = $this->updatedcallback;
|
|
if (!empty($callbackfunction) and function_exists($callbackfunction)) {
|
|
$callbackfunction($this->get_full_name());
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Is setting related to query text - used when searching
|
|
* @param string $query
|
|
* @return bool
|
|
*/
|
|
public function is_related($query) {
|
|
if (strpos(strtolower($this->name), $query) !== false) {
|
|
return true;
|
|
}
|
|
if (strpos(textlib::strtolower($this->visiblename), $query) !== false) {
|
|
return true;
|
|
}
|
|
if (strpos(textlib::strtolower($this->description), $query) !== false) {
|
|
return true;
|
|
}
|
|
$current = $this->get_setting();
|
|
if (!is_null($current)) {
|
|
if (is_string($current)) {
|
|
if (strpos(textlib::strtolower($current), $query) !== false) {
|
|
return true;
|
|
}
|
|
}
|
|
}
|
|
$default = $this->get_defaultsetting();
|
|
if (!is_null($default)) {
|
|
if (is_string($default)) {
|
|
if (strpos(textlib::strtolower($default), $query) !== false) {
|
|
return true;
|
|
}
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* An additional option that can be applied to an admin setting.
|
|
* The currently supported options are 'ADVANCED' and 'LOCKED'.
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_flag {
|
|
/** @var bool Flag to indicate if this option can be toggled for this setting */
|
|
private $enabled = false;
|
|
/** @var bool Flag to indicate if this option defaults to true or false */
|
|
private $default = false;
|
|
/** @var string Short string used to create setting name - e.g. 'adv' */
|
|
private $shortname = '';
|
|
/** @var string String used as the label for this flag */
|
|
private $displayname = '';
|
|
/** @const Checkbox for this flag is displayed in admin page */
|
|
const ENABLED = true;
|
|
/** @const Checkbox for this flag is not displayed in admin page */
|
|
const DISABLED = false;
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param bool $enabled Can this option can be toggled.
|
|
* Should be one of admin_setting_flag::ENABLED or admin_setting_flag::DISABLED.
|
|
* @param bool $default The default checked state for this setting option.
|
|
* @param string $shortname The shortname of this flag. Currently supported flags are 'locked' and 'adv'
|
|
* @param string $displayname The displayname of this flag. Used as a label for the flag.
|
|
*/
|
|
public function __construct($enabled, $default, $shortname, $displayname) {
|
|
$this->shortname = $shortname;
|
|
$this->displayname = $displayname;
|
|
$this->set_options($enabled, $default);
|
|
}
|
|
|
|
/**
|
|
* Update the values of this setting options class
|
|
*
|
|
* @param bool $enabled Can this option can be toggled.
|
|
* Should be one of admin_setting_flag::ENABLED or admin_setting_flag::DISABLED.
|
|
* @param bool $default The default checked state for this setting option.
|
|
*/
|
|
public function set_options($enabled, $default) {
|
|
$this->enabled = $enabled;
|
|
$this->default = $default;
|
|
}
|
|
|
|
/**
|
|
* Should this option appear in the interface and be toggleable?
|
|
*
|
|
* @return bool Is it enabled?
|
|
*/
|
|
public function is_enabled() {
|
|
return $this->enabled;
|
|
}
|
|
|
|
/**
|
|
* Should this option be checked by default?
|
|
*
|
|
* @return bool Is it on by default?
|
|
*/
|
|
public function get_default() {
|
|
return $this->default;
|
|
}
|
|
|
|
/**
|
|
* Return the short name for this flag. e.g. 'adv' or 'locked'
|
|
*
|
|
* @return string
|
|
*/
|
|
public function get_shortname() {
|
|
return $this->shortname;
|
|
}
|
|
|
|
/**
|
|
* Return the display name for this flag. e.g. 'Advanced' or 'Locked'
|
|
*
|
|
* @return string
|
|
*/
|
|
public function get_displayname() {
|
|
return $this->displayname;
|
|
}
|
|
|
|
/**
|
|
* Save the submitted data for this flag - or set it to the default if $data is null.
|
|
*
|
|
* @param admin_setting $setting - The admin setting for this flag
|
|
* @param array $data - The data submitted from the form or null to set the default value for new installs.
|
|
* @return bool
|
|
*/
|
|
public function write_setting_flag(admin_setting $setting, $data) {
|
|
$result = true;
|
|
if ($this->is_enabled()) {
|
|
if (!isset($data)) {
|
|
$value = $this->get_default();
|
|
} else {
|
|
$value = !empty($data[$setting->get_full_name() . '_' . $this->get_shortname()]);
|
|
}
|
|
$result = $setting->config_write($setting->name . '_' . $this->get_shortname(), $value);
|
|
}
|
|
|
|
return $result;
|
|
|
|
}
|
|
|
|
/**
|
|
* Output the checkbox for this setting flag. Should only be called if the flag is enabled.
|
|
*
|
|
* @param admin_setting $setting - The admin setting for this flag
|
|
* @return string - The html for the checkbox.
|
|
*/
|
|
public function output_setting_flag(admin_setting $setting) {
|
|
$value = $setting->get_setting_flag_value($this);
|
|
$output = ' <input type="checkbox" class="form-checkbox" ' .
|
|
' id="' . $setting->get_id() . '_' . $this->get_shortname() . '" ' .
|
|
' name="' . $setting->get_full_name() . '_' . $this->get_shortname() . '" ' .
|
|
' value="1" ' . ($value ? 'checked="checked"' : '') . ' />' .
|
|
' <label for="' . $setting->get_id() . '_' . $this->get_shortname() . '">' .
|
|
$this->get_displayname() .
|
|
' </label> ';
|
|
return $output;
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* No setting - just heading and text.
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_heading extends admin_setting {
|
|
|
|
/**
|
|
* not a setting, just text
|
|
* @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting' for ones in config_plugins.
|
|
* @param string $heading heading
|
|
* @param string $information text in box
|
|
*/
|
|
public function __construct($name, $heading, $information) {
|
|
$this->nosave = true;
|
|
parent::__construct($name, $heading, $information, '');
|
|
}
|
|
|
|
/**
|
|
* Always returns true
|
|
* @return bool Always returns true
|
|
*/
|
|
public function get_setting() {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Always returns true
|
|
* @return bool Always returns true
|
|
*/
|
|
public function get_defaultsetting() {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Never write settings
|
|
* @return string Always returns an empty string
|
|
*/
|
|
public function write_setting($data) {
|
|
// do not write any setting
|
|
return '';
|
|
}
|
|
|
|
/**
|
|
* Returns an HTML string
|
|
* @return string Returns an HTML string
|
|
*/
|
|
public function output_html($data, $query='') {
|
|
global $OUTPUT;
|
|
$return = '';
|
|
if ($this->visiblename != '') {
|
|
$return .= $OUTPUT->heading($this->visiblename, 3, 'main');
|
|
}
|
|
if ($this->description != '') {
|
|
$return .= $OUTPUT->box(highlight($query, markdown_to_html($this->description)), 'generalbox formsettingheading');
|
|
}
|
|
return $return;
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* The most flexibly setting, user is typing text
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_configtext extends admin_setting {
|
|
|
|
/** @var mixed int means PARAM_XXX type, string is a allowed format in regex */
|
|
public $paramtype;
|
|
/** @var int default field size */
|
|
public $size;
|
|
|
|
/**
|
|
* Config text 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 string $defaultsetting
|
|
* @param mixed $paramtype int means PARAM_XXX type, string is a allowed format in regex
|
|
* @param int $size default field size
|
|
*/
|
|
public function __construct($name, $visiblename, $description, $defaultsetting, $paramtype=PARAM_RAW, $size=null) {
|
|
$this->paramtype = $paramtype;
|
|
if (!is_null($size)) {
|
|
$this->size = $size;
|
|
} else {
|
|
$this->size = ($paramtype === PARAM_INT) ? 5 : 30;
|
|
}
|
|
parent::__construct($name, $visiblename, $description, $defaultsetting);
|
|
}
|
|
|
|
/**
|
|
* Return the setting
|
|
*
|
|
* @return mixed returns config if successful else null
|
|
*/
|
|
public function get_setting() {
|
|
return $this->config_read($this->name);
|
|
}
|
|
|
|
public function write_setting($data) {
|
|
if ($this->paramtype === PARAM_INT and $data === '') {
|
|
// do not complain if '' used instead of 0
|
|
$data = 0;
|
|
}
|
|
// $data is a string
|
|
$validated = $this->validate($data);
|
|
if ($validated !== true) {
|
|
return $validated;
|
|
}
|
|
return ($this->config_write($this->name, $data) ? '' : get_string('errorsetting', 'admin'));
|
|
}
|
|
|
|
/**
|
|
* Validate data before storage
|
|
* @param string data
|
|
* @return mixed true if ok string if error found
|
|
*/
|
|
public function validate($data) {
|
|
// allow paramtype to be a custom regex if it is the form of /pattern/
|
|
if (preg_match('#^/.*/$#', $this->paramtype)) {
|
|
if (preg_match($this->paramtype, $data)) {
|
|
return true;
|
|
} else {
|
|
return get_string('validateerror', 'admin');
|
|
}
|
|
|
|
} else if ($this->paramtype === PARAM_RAW) {
|
|
return true;
|
|
|
|
} else {
|
|
$cleaned = clean_param($data, $this->paramtype);
|
|
if ("$data" === "$cleaned") { // implicit conversion to string is needed to do exact comparison
|
|
return true;
|
|
} else {
|
|
return get_string('validateerror', 'admin');
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Return an XHTML string for the setting
|
|
* @return string Returns an XHTML string
|
|
*/
|
|
public function output_html($data, $query='') {
|
|
$default = $this->get_defaultsetting();
|
|
|
|
return format_admin_setting($this, $this->visiblename,
|
|
'<div class="form-text defaultsnext"><input type="text" size="'.$this->size.'" id="'.$this->get_id().'" name="'.$this->get_full_name().'" value="'.s($data).'" /></div>',
|
|
$this->description, true, '', $default, $query);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* General text area without html editor.
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_configtextarea extends admin_setting_configtext {
|
|
private $rows;
|
|
private $cols;
|
|
|
|
/**
|
|
* @param string $name
|
|
* @param string $visiblename
|
|
* @param string $description
|
|
* @param mixed $defaultsetting string or array
|
|
* @param mixed $paramtype
|
|
* @param string $cols The number of columns to make the editor
|
|
* @param string $rows The number of rows to make the editor
|
|
*/
|
|
public function __construct($name, $visiblename, $description, $defaultsetting, $paramtype=PARAM_RAW, $cols='60', $rows='8') {
|
|
$this->rows = $rows;
|
|
$this->cols = $cols;
|
|
parent::__construct($name, $visiblename, $description, $defaultsetting, $paramtype);
|
|
}
|
|
|
|
/**
|
|
* Returns an XHTML string for the editor
|
|
*
|
|
* @param string $data
|
|
* @param string $query
|
|
* @return string XHTML string for the editor
|
|
*/
|
|
public function output_html($data, $query='') {
|
|
$default = $this->get_defaultsetting();
|
|
|
|
$defaultinfo = $default;
|
|
if (!is_null($default) and $default !== '') {
|
|
$defaultinfo = "\n".$default;
|
|
}
|
|
|
|
return format_admin_setting($this, $this->visiblename,
|
|
'<div class="form-textarea" ><textarea rows="'. $this->rows .'" cols="'. $this->cols .'" id="'. $this->get_id() .'" name="'. $this->get_full_name() .'" spellcheck="true">'. s($data) .'</textarea></div>',
|
|
$this->description, true, '', $defaultinfo, $query);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* General text area with html editor.
|
|
*/
|
|
class admin_setting_confightmleditor extends admin_setting_configtext {
|
|
private $rows;
|
|
private $cols;
|
|
|
|
/**
|
|
* @param string $name
|
|
* @param string $visiblename
|
|
* @param string $description
|
|
* @param mixed $defaultsetting string or array
|
|
* @param mixed $paramtype
|
|
*/
|
|
public function __construct($name, $visiblename, $description, $defaultsetting, $paramtype=PARAM_RAW, $cols='60', $rows='8') {
|
|
$this->rows = $rows;
|
|
$this->cols = $cols;
|
|
parent::__construct($name, $visiblename, $description, $defaultsetting, $paramtype);
|
|
editors_head_setup();
|
|
}
|
|
|
|
/**
|
|
* Returns an XHTML string for the editor
|
|
*
|
|
* @param string $data
|
|
* @param string $query
|
|
* @return string XHTML string for the editor
|
|
*/
|
|
public function output_html($data, $query='') {
|
|
$default = $this->get_defaultsetting();
|
|
|
|
$defaultinfo = $default;
|
|
if (!is_null($default) and $default !== '') {
|
|
$defaultinfo = "\n".$default;
|
|
}
|
|
|
|
$editor = editors_get_preferred_editor(FORMAT_HTML);
|
|
$editor->use_editor($this->get_id(), array('noclean'=>true));
|
|
|
|
return format_admin_setting($this, $this->visiblename,
|
|
'<div class="form-textarea"><textarea rows="'. $this->rows .'" cols="'. $this->cols .'" id="'. $this->get_id() .'" name="'. $this->get_full_name() .'" spellcheck="true">'. s($data) .'</textarea></div>',
|
|
$this->description, true, '', $defaultinfo, $query);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Password field, allows unmasking of password
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_configpasswordunmask extends admin_setting_configtext {
|
|
/**
|
|
* 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 string $defaultsetting default password
|
|
*/
|
|
public function __construct($name, $visiblename, $description, $defaultsetting) {
|
|
parent::__construct($name, $visiblename, $description, $defaultsetting, PARAM_RAW, 30);
|
|
}
|
|
|
|
/**
|
|
* Returns XHTML for the field
|
|
* Writes Javascript into the HTML below right before the last div
|
|
*
|
|
* @todo Make javascript available through newer methods if possible
|
|
* @param string $data Value for the field
|
|
* @param string $query Passed as final argument for format_admin_setting
|
|
* @return string XHTML field
|
|
*/
|
|
public function output_html($data, $query='') {
|
|
$id = $this->get_id();
|
|
$unmask = get_string('unmaskpassword', 'form');
|
|
$unmaskjs = '<script type="text/javascript">
|
|
//<![CDATA[
|
|
var is_ie = (navigator.userAgent.toLowerCase().indexOf("msie") != -1);
|
|
|
|
document.getElementById("'.$id.'").setAttribute("autocomplete", "off");
|
|
|
|
var unmaskdiv = document.getElementById("'.$id.'unmaskdiv");
|
|
|
|
var unmaskchb = document.createElement("input");
|
|
unmaskchb.setAttribute("type", "checkbox");
|
|
unmaskchb.setAttribute("id", "'.$id.'unmask");
|
|
unmaskchb.onchange = function() {unmaskPassword("'.$id.'");};
|
|
unmaskdiv.appendChild(unmaskchb);
|
|
|
|
var unmasklbl = document.createElement("label");
|
|
unmasklbl.innerHTML = "'.addslashes_js($unmask).'";
|
|
if (is_ie) {
|
|
unmasklbl.setAttribute("htmlFor", "'.$id.'unmask");
|
|
} else {
|
|
unmasklbl.setAttribute("for", "'.$id.'unmask");
|
|
}
|
|
unmaskdiv.appendChild(unmasklbl);
|
|
|
|
if (is_ie) {
|
|
// ugly hack to work around the famous onchange IE bug
|
|
unmaskchb.onclick = function() {this.blur();};
|
|
unmaskdiv.onclick = function() {this.blur();};
|
|
}
|
|
//]]>
|
|
</script>';
|
|
return format_admin_setting($this, $this->visiblename,
|
|
'<div class="form-password"><input type="password" size="'.$this->size.'" id="'.$id.'" name="'.$this->get_full_name().'" value="'.s($data).'" /><div class="unmask" id="'.$id.'unmaskdiv"></div>'.$unmaskjs.'</div>',
|
|
$this->description, true, '', NULL, $query);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Empty setting used to allow flags (advanced) on settings that can have no sensible default.
|
|
* Note: Only advanced makes sense right now - locked does not.
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_configempty extends admin_setting_configtext {
|
|
|
|
/**
|
|
* @param string $name
|
|
* @param string $visiblename
|
|
* @param string $description
|
|
*/
|
|
public function __construct($name, $visiblename, $description) {
|
|
parent::__construct($name, $visiblename, $description, '', PARAM_RAW);
|
|
}
|
|
|
|
/**
|
|
* Returns an XHTML string for the hidden field
|
|
*
|
|
* @param string $data
|
|
* @param string $query
|
|
* @return string XHTML string for the editor
|
|
*/
|
|
public function output_html($data, $query='') {
|
|
return format_admin_setting($this,
|
|
$this->visiblename,
|
|
'<div class="form-empty" >' .
|
|
'<input type="hidden"' .
|
|
' id="'. $this->get_id() .'"' .
|
|
' name="'. $this->get_full_name() .'"' .
|
|
' value=""/></div>',
|
|
$this->description,
|
|
true,
|
|
'',
|
|
get_string('none'),
|
|
$query);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Path to directory
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_configfile extends admin_setting_configtext {
|
|
/**
|
|
* 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 string $defaultdirectory default directory location
|
|
*/
|
|
public function __construct($name, $visiblename, $description, $defaultdirectory) {
|
|
parent::__construct($name, $visiblename, $description, $defaultdirectory, PARAM_RAW, 50);
|
|
}
|
|
|
|
/**
|
|
* Returns XHTML for the field
|
|
*
|
|
* Returns XHTML for the field and also checks whether the file
|
|
* specified in $data exists using file_exists()
|
|
*
|
|
* @param string $data File name and path to use in value attr
|
|
* @param string $query
|
|
* @return string XHTML field
|
|
*/
|
|
public function output_html($data, $query='') {
|
|
$default = $this->get_defaultsetting();
|
|
|
|
if ($data) {
|
|
if (file_exists($data)) {
|
|
$executable = '<span class="pathok">✔</span>';
|
|
} else {
|
|
$executable = '<span class="patherror">✘</span>';
|
|
}
|
|
} else {
|
|
$executable = '';
|
|
}
|
|
|
|
return format_admin_setting($this, $this->visiblename,
|
|
'<div class="form-file defaultsnext"><input type="text" size="'.$this->size.'" id="'.$this->get_id().'" name="'.$this->get_full_name().'" value="'.s($data).'" />'.$executable.'</div>',
|
|
$this->description, true, '', $default, $query);
|
|
}
|
|
/**
|
|
* checks if execpatch has been disabled in config.php
|
|
*/
|
|
public function write_setting($data) {
|
|
global $CFG;
|
|
if (!empty($CFG->preventexecpath)) {
|
|
return '';
|
|
}
|
|
return parent::write_setting($data);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Path to executable file
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_configexecutable extends admin_setting_configfile {
|
|
|
|
/**
|
|
* Returns an XHTML field
|
|
*
|
|
* @param string $data This is the value for the field
|
|
* @param string $query
|
|
* @return string XHTML field
|
|
*/
|
|
public function output_html($data, $query='') {
|
|
global $CFG;
|
|
$default = $this->get_defaultsetting();
|
|
|
|
if ($data) {
|
|
if (file_exists($data) and is_executable($data)) {
|
|
$executable = '<span class="pathok">✔</span>';
|
|
} else {
|
|
$executable = '<span class="patherror">✘</span>';
|
|
}
|
|
} else {
|
|
$executable = '';
|
|
}
|
|
if (!empty($CFG->preventexecpath)) {
|
|
$this->visiblename .= '<div class="form-overridden">'.get_string('execpathnotallowed', 'admin').'</div>';
|
|
}
|
|
|
|
return format_admin_setting($this, $this->visiblename,
|
|
'<div class="form-file defaultsnext"><input type="text" size="'.$this->size.'" id="'.$this->get_id().'" name="'.$this->get_full_name().'" value="'.s($data).'" />'.$executable.'</div>',
|
|
$this->description, true, '', $default, $query);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Path to directory
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_configdirectory extends admin_setting_configfile {
|
|
|
|
/**
|
|
* Returns an XHTML field
|
|
*
|
|
* @param string $data This is the value for the field
|
|
* @param string $query
|
|
* @return string XHTML
|
|
*/
|
|
public function output_html($data, $query='') {
|
|
$default = $this->get_defaultsetting();
|
|
|
|
if ($data) {
|
|
if (file_exists($data) and is_dir($data)) {
|
|
$executable = '<span class="pathok">✔</span>';
|
|
} else {
|
|
$executable = '<span class="patherror">✘</span>';
|
|
}
|
|
} else {
|
|
$executable = '';
|
|
}
|
|
|
|
return format_admin_setting($this, $this->visiblename,
|
|
'<div class="form-file defaultsnext"><input type="text" size="'.$this->size.'" id="'.$this->get_id().'" name="'.$this->get_full_name().'" value="'.s($data).'" />'.$executable.'</div>',
|
|
$this->description, true, '', $default, $query);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Checkbox
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_configcheckbox extends admin_setting {
|
|
/** @var string Value used when checked */
|
|
public $yes;
|
|
/** @var string Value used when not checked */
|
|
public $no;
|
|
|
|
/**
|
|
* 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 string $defaultsetting
|
|
* @param string $yes value used when checked
|
|
* @param string $no value used when not checked
|
|
*/
|
|
public function __construct($name, $visiblename, $description, $defaultsetting, $yes='1', $no='0') {
|
|
parent::__construct($name, $visiblename, $description, $defaultsetting);
|
|
$this->yes = (string)$yes;
|
|
$this->no = (string)$no;
|
|
}
|
|
|
|
/**
|
|
* Retrieves the current setting using the objects name
|
|
*
|
|
* @return string
|
|
*/
|
|
public function get_setting() {
|
|
return $this->config_read($this->name);
|
|
}
|
|
|
|
/**
|
|
* Sets the value for the setting
|
|
*
|
|
* Sets the value for the setting to either the yes or no values
|
|
* of the object by comparing $data to yes
|
|
*
|
|
* @param mixed $data Gets converted to str for comparison against yes value
|
|
* @return string empty string or error
|
|
*/
|
|
public function write_setting($data) {
|
|
if ((string)$data === $this->yes) { // convert to strings before comparison
|
|
$data = $this->yes;
|
|
} else {
|
|
$data = $this->no;
|
|
}
|
|
return ($this->config_write($this->name, $data) ? '' : get_string('errorsetting', 'admin'));
|
|
}
|
|
|
|
/**
|
|
* Returns an XHTML checkbox field
|
|
*
|
|
* @param string $data If $data matches yes then checkbox is checked
|
|
* @param string $query
|
|
* @return string XHTML field
|
|
*/
|
|
public function output_html($data, $query='') {
|
|
$default = $this->get_defaultsetting();
|
|
|
|
if (!is_null($default)) {
|
|
if ((string)$default === $this->yes) {
|
|
$defaultinfo = get_string('checkboxyes', 'admin');
|
|
} else {
|
|
$defaultinfo = get_string('checkboxno', 'admin');
|
|
}
|
|
} else {
|
|
$defaultinfo = NULL;
|
|
}
|
|
|
|
if ((string)$data === $this->yes) { // convert to strings before comparison
|
|
$checked = 'checked="checked"';
|
|
} else {
|
|
$checked = '';
|
|
}
|
|
|
|
return format_admin_setting($this, $this->visiblename,
|
|
'<div class="form-checkbox defaultsnext" ><input type="hidden" name="'.$this->get_full_name().'" value="'.s($this->no).'" /> '
|
|
.'<input type="checkbox" id="'.$this->get_id().'" name="'.$this->get_full_name().'" value="'.s($this->yes).'" '.$checked.' /></div>',
|
|
$this->description, true, '', $defaultinfo, $query);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Multiple checkboxes, each represents different value, stored in csv format
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_configmulticheckbox extends admin_setting {
|
|
/** @var array Array of choices value=>label */
|
|
public $choices;
|
|
|
|
/**
|
|
* Constructor: uses parent::__construct
|
|
*
|
|
* @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
|
|
* @param array $choices array of $value=>$label for each checkbox
|
|
*/
|
|
public function __construct($name, $visiblename, $description, $defaultsetting, $choices) {
|
|
$this->choices = $choices;
|
|
parent::__construct($name, $visiblename, $description, $defaultsetting);
|
|
}
|
|
|
|
/**
|
|
* This public function may be used in ancestors for lazy loading of choices
|
|
*
|
|
* @todo Check if this function is still required content commented out only returns true
|
|
* @return bool true if loaded, false if error
|
|
*/
|
|
public function load_choices() {
|
|
/*
|
|
if (is_array($this->choices)) {
|
|
return true;
|
|
}
|
|
.... load choices here
|
|
*/
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Is setting related to query text - used when searching
|
|
*
|
|
* @param string $query
|
|
* @return bool true on related, false on not or failure
|
|
*/
|
|
public function is_related($query) {
|
|
if (!$this->load_choices() or empty($this->choices)) {
|
|
return false;
|
|
}
|
|
if (parent::is_related($query)) {
|
|
return true;
|
|
}
|
|
|
|
foreach ($this->choices as $desc) {
|
|
if (strpos(textlib::strtolower($desc), $query) !== false) {
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Returns the current setting if it is set
|
|
*
|
|
* @return mixed null if null, else an array
|
|
*/
|
|
public function get_setting() {
|
|
$result = $this->config_read($this->name);
|
|
|
|
if (is_null($result)) {
|
|
return NULL;
|
|
}
|
|
if ($result === '') {
|
|
return array();
|
|
}
|
|
$enabled = explode(',', $result);
|
|
$setting = array();
|
|
foreach ($enabled as $option) {
|
|
$setting[$option] = 1;
|
|
}
|
|
return $setting;
|
|
}
|
|
|
|
/**
|
|
* Saves the setting(s) provided in $data
|
|
*
|
|
* @param array $data An array of data, if not array returns empty str
|
|
* @return mixed empty string on useless data or bool true=success, false=failed
|
|
*/
|
|
public function write_setting($data) {
|
|
if (!is_array($data)) {
|
|
return ''; // ignore it
|
|
}
|
|
if (!$this->load_choices() or empty($this->choices)) {
|
|
return '';
|
|
}
|
|
unset($data['xxxxx']);
|
|
$result = array();
|
|
foreach ($data as $key => $value) {
|
|
if ($value and array_key_exists($key, $this->choices)) {
|
|
$result[] = $key;
|
|
}
|
|
}
|
|
return $this->config_write($this->name, implode(',', $result)) ? '' : get_string('errorsetting', 'admin');
|
|
}
|
|
|
|
/**
|
|
* Returns XHTML field(s) as required by choices
|
|
*
|
|
* Relies on data being an array should data ever be another valid vartype with
|
|
* acceptable value this may cause a warning/error
|
|
* if (!is_array($data)) would fix the problem
|
|
*
|
|
* @todo Add vartype handling to ensure $data is an array
|
|
*
|
|
* @param array $data An array of checked values
|
|
* @param string $query
|
|
* @return string XHTML field
|
|
*/
|
|
public function output_html($data, $query='') {
|
|
if (!$this->load_choices() or empty($this->choices)) {
|
|
return '';
|
|
}
|
|
$default = $this->get_defaultsetting();
|
|
if (is_null($default)) {
|
|
$default = array();
|
|
}
|
|
if (is_null($data)) {
|
|
$data = array();
|
|
}
|
|
$options = array();
|
|
$defaults = array();
|
|
foreach ($this->choices as $key=>$description) {
|
|
if (!empty($data[$key])) {
|
|
$checked = 'checked="checked"';
|
|
} else {
|
|
$checked = '';
|
|
}
|
|
if (!empty($default[$key])) {
|
|
$defaults[] = $description;
|
|
}
|
|
|
|
$options[] = '<input type="checkbox" id="'.$this->get_id().'_'.$key.'" name="'.$this->get_full_name().'['.$key.']" value="1" '.$checked.' />'
|
|
.'<label for="'.$this->get_id().'_'.$key.'">'.highlightfast($query, $description).'</label>';
|
|
}
|
|
|
|
if (is_null($default)) {
|
|
$defaultinfo = NULL;
|
|
} else if (!empty($defaults)) {
|
|
$defaultinfo = implode(', ', $defaults);
|
|
} else {
|
|
$defaultinfo = get_string('none');
|
|
}
|
|
|
|
$return = '<div class="form-multicheckbox">';
|
|
$return .= '<input type="hidden" name="'.$this->get_full_name().'[xxxxx]" value="1" />'; // something must be submitted even if nothing selected
|
|
if ($options) {
|
|
$return .= '<ul>';
|
|
foreach ($options as $option) {
|
|
$return .= '<li>'.$option.'</li>';
|
|
}
|
|
$return .= '</ul>';
|
|
}
|
|
$return .= '</div>';
|
|
|
|
return format_admin_setting($this, $this->visiblename, $return, $this->description, false, '', $defaultinfo, $query);
|
|
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Multiple checkboxes 2, value stored as string 00101011
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_configmulticheckbox2 extends admin_setting_configmulticheckbox {
|
|
|
|
/**
|
|
* Returns the setting if set
|
|
*
|
|
* @return mixed null if not set, else an array of set settings
|
|
*/
|
|
public function get_setting() {
|
|
$result = $this->config_read($this->name);
|
|
if (is_null($result)) {
|
|
return NULL;
|
|
}
|
|
if (!$this->load_choices()) {
|
|
return NULL;
|
|
}
|
|
$result = str_pad($result, count($this->choices), '0');
|
|
$result = preg_split('//', $result, -1, PREG_SPLIT_NO_EMPTY);
|
|
$setting = array();
|
|
foreach ($this->choices as $key=>$unused) {
|
|
$value = array_shift($result);
|
|
if ($value) {
|
|
$setting[$key] = 1;
|
|
}
|
|
}
|
|
return $setting;
|
|
}
|
|
|
|
/**
|
|
* Save setting(s) provided in $data param
|
|
*
|
|
* @param array $data An array of settings to save
|
|
* @return mixed empty string for bad data or bool true=>success, false=>error
|
|
*/
|
|
public function write_setting($data) {
|
|
if (!is_array($data)) {
|
|
return ''; // ignore it
|
|
}
|
|
if (!$this->load_choices() or empty($this->choices)) {
|
|
return '';
|
|
}
|
|
$result = '';
|
|
foreach ($this->choices as $key=>$unused) {
|
|
if (!empty($data[$key])) {
|
|
$result .= '1';
|
|
} else {
|
|
$result .= '0';
|
|
}
|
|
}
|
|
return $this->config_write($this->name, $result) ? '' : get_string('errorsetting', 'admin');
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Select one value from list
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_configselect extends admin_setting {
|
|
/** @var array Array of choices value=>label */
|
|
public $choices;
|
|
|
|
/**
|
|
* 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 string|int $defaultsetting
|
|
* @param array $choices array of $value=>$label for each selection
|
|
*/
|
|
public function __construct($name, $visiblename, $description, $defaultsetting, $choices) {
|
|
$this->choices = $choices;
|
|
parent::__construct($name, $visiblename, $description, $defaultsetting);
|
|
}
|
|
|
|
/**
|
|
* This function may be used in ancestors for lazy loading of choices
|
|
*
|
|
* Override this method if loading of choices is expensive, such
|
|
* as when it requires multiple db requests.
|
|
*
|
|
* @return bool true if loaded, false if error
|
|
*/
|
|
public function load_choices() {
|
|
/*
|
|
if (is_array($this->choices)) {
|
|
return true;
|
|
}
|
|
.... load choices here
|
|
*/
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Check if this is $query is related to a choice
|
|
*
|
|
* @param string $query
|
|
* @return bool true if related, false if not
|
|
*/
|
|
public function is_related($query) {
|
|
if (parent::is_related($query)) {
|
|
return true;
|
|
}
|
|
if (!$this->load_choices()) {
|
|
return false;
|
|
}
|
|
foreach ($this->choices as $key=>$value) {
|
|
if (strpos(textlib::strtolower($key), $query) !== false) {
|
|
return true;
|
|
}
|
|
if (strpos(textlib::strtolower($value), $query) !== false) {
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Return the setting
|
|
*
|
|
* @return mixed returns config if successful else null
|
|
*/
|
|
public function get_setting() {
|
|
return $this->config_read($this->name);
|
|
}
|
|
|
|
/**
|
|
* Save a setting
|
|
*
|
|
* @param string $data
|
|
* @return string empty of error string
|
|
*/
|
|
public function write_setting($data) {
|
|
if (!$this->load_choices() or empty($this->choices)) {
|
|
return '';
|
|
}
|
|
if (!array_key_exists($data, $this->choices)) {
|
|
return ''; // ignore it
|
|
}
|
|
|
|
return ($this->config_write($this->name, $data) ? '' : get_string('errorsetting', 'admin'));
|
|
}
|
|
|
|
/**
|
|
* Returns XHTML select field
|
|
*
|
|
* Ensure the options are loaded, and generate the XHTML for the select
|
|
* element and any warning message. Separating this out from output_html
|
|
* makes it easier to subclass this class.
|
|
*
|
|
* @param string $data the option to show as selected.
|
|
* @param string $current the currently selected option in the database, null if none.
|
|
* @param string $default the default selected option.
|
|
* @return array the HTML for the select element, and a warning message.
|
|
*/
|
|
public function output_select_html($data, $current, $default, $extraname = '') {
|
|
if (!$this->load_choices() or empty($this->choices)) {
|
|
return array('', '');
|
|
}
|
|
|
|
$warning = '';
|
|
if (is_null($current)) {
|
|
// first run
|
|
} else if (empty($current) and (array_key_exists('', $this->choices) or array_key_exists(0, $this->choices))) {
|
|
// no warning
|
|
} else if (!array_key_exists($current, $this->choices)) {
|
|
$warning = get_string('warningcurrentsetting', 'admin', s($current));
|
|
if (!is_null($default) and $data == $current) {
|
|
$data = $default; // use default instead of first value when showing the form
|
|
}
|
|
}
|
|
|
|
$selecthtml = '<select id="'.$this->get_id().'" name="'.$this->get_full_name().$extraname.'">';
|
|
foreach ($this->choices as $key => $value) {
|
|
// the string cast is needed because key may be integer - 0 is equal to most strings!
|
|
$selecthtml .= '<option value="'.$key.'"'.((string)$key==$data ? ' selected="selected"' : '').'>'.$value.'</option>';
|
|
}
|
|
$selecthtml .= '</select>';
|
|
return array($selecthtml, $warning);
|
|
}
|
|
|
|
/**
|
|
* Returns XHTML select field and wrapping div(s)
|
|
*
|
|
* @see output_select_html()
|
|
*
|
|
* @param string $data the option to show as selected
|
|
* @param string $query
|
|
* @return string XHTML field and wrapping div
|
|
*/
|
|
public function output_html($data, $query='') {
|
|
$default = $this->get_defaultsetting();
|
|
$current = $this->get_setting();
|
|
|
|
list($selecthtml, $warning) = $this->output_select_html($data, $current, $default);
|
|
if (!$selecthtml) {
|
|
return '';
|
|
}
|
|
|
|
if (!is_null($default) and array_key_exists($default, $this->choices)) {
|
|
$defaultinfo = $this->choices[$default];
|
|
} else {
|
|
$defaultinfo = NULL;
|
|
}
|
|
|
|
$return = '<div class="form-select defaultsnext">' . $selecthtml . '</div>';
|
|
|
|
return format_admin_setting($this, $this->visiblename, $return, $this->description, true, $warning, $defaultinfo, $query);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Select multiple items from list
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_configmultiselect extends admin_setting_configselect {
|
|
/**
|
|
* 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 array of $value=>$label for each list item
|
|
*/
|
|
public function __construct($name, $visiblename, $description, $defaultsetting, $choices) {
|
|
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 array();
|
|
}
|
|
return explode(',', $result);
|
|
}
|
|
|
|
/**
|
|
* Saves setting(s) provided through $data
|
|
*
|
|
* Potential bug in the works should anyone call with this function
|
|
* using a vartype that is not an array
|
|
*
|
|
* @param array $data
|
|
*/
|
|
public function write_setting($data) {
|
|
if (!is_array($data)) {
|
|
return ''; //ignore it
|
|
}
|
|
if (!$this->load_choices() or empty($this->choices)) {
|
|
return '';
|
|
}
|
|
|
|
unset($data['xxxxx']);
|
|
|
|
$save = array();
|
|
foreach ($data as $value) {
|
|
if (!array_key_exists($value, $this->choices)) {
|
|
continue; // ignore it
|
|
}
|
|
$save[] = $value;
|
|
}
|
|
|
|
return ($this->config_write($this->name, implode(',', $save)) ? '' : get_string('errorsetting', 'admin'));
|
|
}
|
|
|
|
/**
|
|
* Is setting related to query text - used when searching
|
|
*
|
|
* @param string $query
|
|
* @return bool true if related, false if not
|
|
*/
|
|
public function is_related($query) {
|
|
if (!$this->load_choices() or empty($this->choices)) {
|
|
return false;
|
|
}
|
|
if (parent::is_related($query)) {
|
|
return true;
|
|
}
|
|
|
|
foreach ($this->choices as $desc) {
|
|
if (strpos(textlib::strtolower($desc), $query) !== false) {
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Returns XHTML multi-select field
|
|
*
|
|
* @todo Add vartype handling to ensure $data is an array
|
|
* @param array $data Array of values to select by default
|
|
* @param string $query
|
|
* @return string XHTML multi-select field
|
|
*/
|
|
public function output_html($data, $query='') {
|
|
if (!$this->load_choices() or empty($this->choices)) {
|
|
return '';
|
|
}
|
|
$choices = $this->choices;
|
|
$default = $this->get_defaultsetting();
|
|
if (is_null($default)) {
|
|
$default = array();
|
|
}
|
|
if (is_null($data)) {
|
|
$data = array();
|
|
}
|
|
|
|
$defaults = array();
|
|
$size = min(10, count($this->choices));
|
|
$return = '<div class="form-select"><input type="hidden" name="'.$this->get_full_name().'[xxxxx]" value="1" />'; // something must be submitted even if nothing selected
|
|
$return .= '<select id="'.$this->get_id().'" name="'.$this->get_full_name().'[]" size="'.$size.'" multiple="multiple">';
|
|
foreach ($this->choices as $key => $description) {
|
|
if (in_array($key, $data)) {
|
|
$selected = 'selected="selected"';
|
|
} else {
|
|
$selected = '';
|
|
}
|
|
if (in_array($key, $default)) {
|
|
$defaults[] = $description;
|
|
}
|
|
|
|
$return .= '<option value="'.s($key).'" '.$selected.'>'.$description.'</option>';
|
|
}
|
|
|
|
if (is_null($default)) {
|
|
$defaultinfo = NULL;
|
|
} if (!empty($defaults)) {
|
|
$defaultinfo = implode(', ', $defaults);
|
|
} else {
|
|
$defaultinfo = get_string('none');
|
|
}
|
|
|
|
$return .= '</select></div>';
|
|
return format_admin_setting($this, $this->visiblename, $return, $this->description, true, '', $defaultinfo, $query);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Time selector
|
|
*
|
|
* This is a liiitle bit messy. we're using two selects, but we're returning
|
|
* them as an array named after $name (so we only use $name2 internally for the setting)
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_configtime extends admin_setting {
|
|
/** @var string Used for setting second select (minutes) */
|
|
public $name2;
|
|
|
|
/**
|
|
* Constructor
|
|
* @param string $hoursname setting for hours
|
|
* @param string $minutesname setting for hours
|
|
* @param string $visiblename localised
|
|
* @param string $description long localised info
|
|
* @param array $defaultsetting array representing default time 'h'=>hours, 'm'=>minutes
|
|
*/
|
|
public function __construct($hoursname, $minutesname, $visiblename, $description, $defaultsetting) {
|
|
$this->name2 = $minutesname;
|
|
parent::__construct($hoursname, $visiblename, $description, $defaultsetting);
|
|
}
|
|
|
|
/**
|
|
* Get the selected time
|
|
*
|
|
* @return mixed An array containing 'h'=>xx, 'm'=>xx, or null if not set
|
|
*/
|
|
public function get_setting() {
|
|
$result1 = $this->config_read($this->name);
|
|
$result2 = $this->config_read($this->name2);
|
|
if (is_null($result1) or is_null($result2)) {
|
|
return NULL;
|
|
}
|
|
|
|
return array('h' => $result1, 'm' => $result2);
|
|
}
|
|
|
|
/**
|
|
* Store the time (hours and minutes)
|
|
*
|
|
* @param array $data Must be form 'h'=>xx, 'm'=>xx
|
|
* @return bool true if success, false if not
|
|
*/
|
|
public function write_setting($data) {
|
|
if (!is_array($data)) {
|
|
return '';
|
|
}
|
|
|
|
$result = $this->config_write($this->name, (int)$data['h']) && $this->config_write($this->name2, (int)$data['m']);
|
|
return ($result ? '' : get_string('errorsetting', 'admin'));
|
|
}
|
|
|
|
/**
|
|
* Returns XHTML time select fields
|
|
*
|
|
* @param array $data Must be form 'h'=>xx, 'm'=>xx
|
|
* @param string $query
|
|
* @return string XHTML time select fields and wrapping div(s)
|
|
*/
|
|
public function output_html($data, $query='') {
|
|
$default = $this->get_defaultsetting();
|
|
|
|
if (is_array($default)) {
|
|
$defaultinfo = $default['h'].':'.$default['m'];
|
|
} else {
|
|
$defaultinfo = NULL;
|
|
}
|
|
|
|
$return = '<div class="form-time defaultsnext">'.
|
|
'<select id="'.$this->get_id().'h" name="'.$this->get_full_name().'[h]">';
|
|
for ($i = 0; $i < 24; $i++) {
|
|
$return .= '<option value="'.$i.'"'.($i == $data['h'] ? ' selected="selected"' : '').'>'.$i.'</option>';
|
|
}
|
|
$return .= '</select>:<select id="'.$this->get_id().'m" name="'.$this->get_full_name().'[m]">';
|
|
for ($i = 0; $i < 60; $i += 5) {
|
|
$return .= '<option value="'.$i.'"'.($i == $data['m'] ? ' selected="selected"' : '').'>'.$i.'</option>';
|
|
}
|
|
$return .= '</select></div>';
|
|
return format_admin_setting($this, $this->visiblename, $return, $this->description, false, '', $defaultinfo, $query);
|
|
}
|
|
|
|
}
|
|
|
|
|
|
/**
|
|
* Seconds duration setting.
|
|
*
|
|
* @copyright 2012 Petr Skoda (http://skodak.org)
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_configduration extends admin_setting {
|
|
|
|
/** @var int default duration 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 mixed $defaultsetting string or array depending on implementation
|
|
* @param int $defaultunit - day, week, etc. (in seconds)
|
|
*/
|
|
public function __construct($name, $visiblename, $description, $defaultsetting, $defaultunit = 86400) {
|
|
if (is_number($defaultsetting)) {
|
|
$defaultsetting = self::parse_seconds($defaultsetting);
|
|
}
|
|
$units = self::get_units();
|
|
if (isset($units[$defaultunit])) {
|
|
$this->defaultunit = $defaultunit;
|
|
} else {
|
|
$this->defaultunit = 86400;
|
|
}
|
|
parent::__construct($name, $visiblename, $description, $defaultsetting);
|
|
}
|
|
|
|
/**
|
|
* Returns selectable units.
|
|
* @static
|
|
* @return array
|
|
*/
|
|
protected static function get_units() {
|
|
return array(
|
|
604800 => get_string('weeks'),
|
|
86400 => get_string('days'),
|
|
3600 => get_string('hours'),
|
|
60 => get_string('minutes'),
|
|
1 => get_string('seconds'),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Converts seconds to some more user friendly string.
|
|
* @static
|
|
* @param int $seconds
|
|
* @return string
|
|
*/
|
|
protected static function get_duration_text($seconds) {
|
|
if (empty($seconds)) {
|
|
return get_string('none');
|
|
}
|
|
$data = self::parse_seconds($seconds);
|
|
switch ($data['u']) {
|
|
case (60*60*24*7):
|
|
return get_string('numweeks', '', $data['v']);
|
|
case (60*60*24):
|
|
return get_string('numdays', '', $data['v']);
|
|
case (60*60):
|
|
return get_string('numhours', '', $data['v']);
|
|
case (60):
|
|
return get_string('numminutes', '', $data['v']);
|
|
default:
|
|
return get_string('numseconds', '', $data['v']*$data['u']);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Finds suitable units for given duration.
|
|
* @static
|
|
* @param int $seconds
|
|
* @return array
|
|
*/
|
|
protected static function parse_seconds($seconds) {
|
|
foreach (self::get_units() as $unit => $unused) {
|
|
if ($seconds % $unit === 0) {
|
|
return array('v'=>(int)($seconds/$unit), 'u'=>$unit);
|
|
}
|
|
}
|
|
return array('v'=>(int)$seconds, 'u'=>1);
|
|
}
|
|
|
|
/**
|
|
* Get the selected duration as array.
|
|
*
|
|
* @return mixed An array containing 'v'=>xx, 'u'=>xx, or null if not set
|
|
*/
|
|
public function get_setting() {
|
|
$seconds = $this->config_read($this->name);
|
|
if (is_null($seconds)) {
|
|
return null;
|
|
}
|
|
|
|
return self::parse_seconds($seconds);
|
|
}
|
|
|
|
/**
|
|
* Store the duration as seconds.
|
|
*
|
|
* @param array $data Must be form 'h'=>xx, 'm'=>xx
|
|
* @return bool true if success, false if not
|
|
*/
|
|
public function write_setting($data) {
|
|
if (!is_array($data)) {
|
|
return '';
|
|
}
|
|
|
|
$seconds = (int)($data['v']*$data['u']);
|
|
if ($seconds < 0) {
|
|
return get_string('errorsetting', 'admin');
|
|
}
|
|
|
|
$result = $this->config_write($this->name, $seconds);
|
|
return ($result ? '' : get_string('errorsetting', 'admin'));
|
|
}
|
|
|
|
/**
|
|
* Returns duration text+select fields.
|
|
*
|
|
* @param array $data Must be form 'v'=>xx, 'u'=>xx
|
|
* @param string $query
|
|
* @return string duration text+select fields and wrapping div(s)
|
|
*/
|
|
public function output_html($data, $query='') {
|
|
$default = $this->get_defaultsetting();
|
|
|
|
if (is_number($default)) {
|
|
$defaultinfo = self::get_duration_text($default);
|
|
} else if (is_array($default)) {
|
|
$defaultinfo = self::get_duration_text($default['v']*$default['u']);
|
|
} else {
|
|
$defaultinfo = null;
|
|
}
|
|
|
|
$units = self::get_units();
|
|
|
|
$return = '<div class="form-duration defaultsnext">';
|
|
$return .= '<input type="text" size="5" id="'.$this->get_id().'v" name="'.$this->get_full_name().'[v]" value="'.s($data['v']).'" />';
|
|
$return .= '<select id="'.$this->get_id().'u" name="'.$this->get_full_name().'[u]">';
|
|
foreach ($units as $val => $text) {
|
|
$selected = '';
|
|
if ($data['v'] == 0) {
|
|
if ($val == $this->defaultunit) {
|
|
$selected = ' selected="selected"';
|
|
}
|
|
} else if ($val == $data['u']) {
|
|
$selected = ' selected="selected"';
|
|
}
|
|
$return .= '<option value="'.$val.'"'.$selected.'>'.$text.'</option>';
|
|
}
|
|
$return .= '</select></div>';
|
|
return format_admin_setting($this, $this->visiblename, $return, $this->description, false, '', $defaultinfo, $query);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Used to validate a textarea used for ip addresses
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_configiplist extends admin_setting_configtextarea {
|
|
|
|
/**
|
|
* Validate the contents of the textarea as IP addresses
|
|
*
|
|
* Used to validate a new line separated list of IP addresses collected from
|
|
* a textarea control
|
|
*
|
|
* @param string $data A list of IP Addresses separated by new lines
|
|
* @return mixed bool true for success or string:error on failure
|
|
*/
|
|
public function validate($data) {
|
|
if(!empty($data)) {
|
|
$ips = explode("\n", $data);
|
|
} else {
|
|
return true;
|
|
}
|
|
$result = true;
|
|
foreach($ips as $ip) {
|
|
$ip = trim($ip);
|
|
if (preg_match('#^(\d{1,3})(\.\d{1,3}){0,3}$#', $ip, $match) ||
|
|
preg_match('#^(\d{1,3})(\.\d{1,3}){0,3}(\/\d{1,2})$#', $ip, $match) ||
|
|
preg_match('#^(\d{1,3})(\.\d{1,3}){3}(-\d{1,3})$#', $ip, $match)) {
|
|
$result = true;
|
|
} else {
|
|
$result = false;
|
|
break;
|
|
}
|
|
}
|
|
if($result) {
|
|
return true;
|
|
} else {
|
|
return get_string('validateerror', 'admin');
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* An admin setting for selecting one or more users who have a capability
|
|
* in the system context
|
|
*
|
|
* An admin setting for selecting one or more users, who have a particular capability
|
|
* in the system context. Warning, make sure the list will never be too long. There is
|
|
* no paging or searching of this list.
|
|
*
|
|
* To correctly get a list of users from this config setting, you need to call the
|
|
* get_users_from_config($CFG->mysetting, $capability); function in moodlelib.php.
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_users_with_capability extends admin_setting_configmultiselect {
|
|
/** @var string The capabilities name */
|
|
protected $capability;
|
|
/** @var int include admin users too */
|
|
protected $includeadmins;
|
|
|
|
/**
|
|
* 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 array $defaultsetting array of usernames
|
|
* @param string $capability string capability name.
|
|
* @param bool $includeadmins include administrators
|
|
*/
|
|
function __construct($name, $visiblename, $description, $defaultsetting, $capability, $includeadmins = true) {
|
|
$this->capability = $capability;
|
|
$this->includeadmins = $includeadmins;
|
|
parent::__construct($name, $visiblename, $description, $defaultsetting, NULL);
|
|
}
|
|
|
|
/**
|
|
* Load all of the uses who have the capability into choice array
|
|
*
|
|
* @return bool Always returns true
|
|
*/
|
|
function load_choices() {
|
|
if (is_array($this->choices)) {
|
|
return true;
|
|
}
|
|
list($sort, $sortparams) = users_order_by_sql('u');
|
|
if (!empty($sortparams)) {
|
|
throw new coding_exception('users_order_by_sql returned some query parameters. ' .
|
|
'This is unexpected, and a problem because there is no way to pass these ' .
|
|
'parameters to get_users_by_capability. See MDL-34657.');
|
|
}
|
|
$users = get_users_by_capability(context_system::instance(),
|
|
$this->capability, 'u.id,u.username,u.firstname,u.lastname', $sort);
|
|
$this->choices = array(
|
|
'$@NONE@$' => get_string('nobody'),
|
|
'$@ALL@$' => get_string('everyonewhocan', 'admin', get_capability_string($this->capability)),
|
|
);
|
|
if ($this->includeadmins) {
|
|
$admins = get_admins();
|
|
foreach ($admins as $user) {
|
|
$this->choices[$user->id] = fullname($user);
|
|
}
|
|
}
|
|
if (is_array($users)) {
|
|
foreach ($users as $user) {
|
|
$this->choices[$user->id] = fullname($user);
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Returns the default setting for class
|
|
*
|
|
* @return mixed Array, or string. Empty string if no default
|
|
*/
|
|
public function get_defaultsetting() {
|
|
$this->load_choices();
|
|
$defaultsetting = parent::get_defaultsetting();
|
|
if (empty($defaultsetting)) {
|
|
return array('$@NONE@$');
|
|
} else if (array_key_exists($defaultsetting, $this->choices)) {
|
|
return $defaultsetting;
|
|
} else {
|
|
return '';
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns the current setting
|
|
*
|
|
* @return mixed array or string
|
|
*/
|
|
public function get_setting() {
|
|
$result = parent::get_setting();
|
|
if ($result === null) {
|
|
// this is necessary for settings upgrade
|
|
return null;
|
|
}
|
|
if (empty($result)) {
|
|
$result = array('$@NONE@$');
|
|
}
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* Save the chosen setting provided as $data
|
|
*
|
|
* @param array $data
|
|
* @return mixed string or array
|
|
*/
|
|
public function write_setting($data) {
|
|
// If all is selected, remove any explicit options.
|
|
if (in_array('$@ALL@$', $data)) {
|
|
$data = array('$@ALL@$');
|
|
}
|
|
// None never needs to be written to the DB.
|
|
if (in_array('$@NONE@$', $data)) {
|
|
unset($data[array_search('$@NONE@$', $data)]);
|
|
}
|
|
return parent::write_setting($data);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Special checkbox for calendar - resets SESSION vars.
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_special_adminseesall extends admin_setting_configcheckbox {
|
|
/**
|
|
* Calls the parent::__construct with default values
|
|
*
|
|
* name => calendar_adminseesall
|
|
* visiblename => get_string('adminseesall', 'admin')
|
|
* description => get_string('helpadminseesall', 'admin')
|
|
* defaultsetting => 0
|
|
*/
|
|
public function __construct() {
|
|
parent::__construct('calendar_adminseesall', get_string('adminseesall', 'admin'),
|
|
get_string('helpadminseesall', 'admin'), '0');
|
|
}
|
|
|
|
/**
|
|
* Stores the setting passed in $data
|
|
*
|
|
* @param mixed gets converted to string for comparison
|
|
* @return string empty string or error message
|
|
*/
|
|
public function write_setting($data) {
|
|
global $SESSION;
|
|
return parent::write_setting($data);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Special select for settings that are altered in setup.php and can not be altered on the fly
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_special_selectsetup extends admin_setting_configselect {
|
|
/**
|
|
* Reads the setting directly from the database
|
|
*
|
|
* @return mixed
|
|
*/
|
|
public function get_setting() {
|
|
// read directly from db!
|
|
return get_config(NULL, $this->name);
|
|
}
|
|
|
|
/**
|
|
* Save the setting passed in $data
|
|
*
|
|
* @param string $data The setting to save
|
|
* @return string empty or error message
|
|
*/
|
|
public function write_setting($data) {
|
|
global $CFG;
|
|
// do not change active CFG setting!
|
|
$current = $CFG->{$this->name};
|
|
$result = parent::write_setting($data);
|
|
$CFG->{$this->name} = $current;
|
|
return $result;
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Special select for frontpage - stores data in course table
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_sitesetselect extends admin_setting_configselect {
|
|
/**
|
|
* Returns the site name for the selected site
|
|
*
|
|
* @see get_site()
|
|
* @return string The site name of the selected site
|
|
*/
|
|
public function get_setting() {
|
|
$site = course_get_format(get_site())->get_course();
|
|
return $site->{$this->name};
|
|
}
|
|
|
|
/**
|
|
* Updates the database and save the setting
|
|
*
|
|
* @param string data
|
|
* @return string empty or error message
|
|
*/
|
|
public function write_setting($data) {
|
|
global $DB, $SITE, $COURSE;
|
|
if (!in_array($data, array_keys($this->choices))) {
|
|
return get_string('errorsetting', 'admin');
|
|
}
|
|
$record = new stdClass();
|
|
$record->id = SITEID;
|
|
$temp = $this->name;
|
|
$record->$temp = $data;
|
|
$record->timemodified = time();
|
|
|
|
course_get_format($SITE)->update_course_format_options($record);
|
|
$DB->update_record('course', $record);
|
|
|
|
// Reset caches.
|
|
$SITE = $DB->get_record('course', array('id'=>$SITE->id), '*', MUST_EXIST);
|
|
if ($SITE->id == $COURSE->id) {
|
|
$COURSE = $SITE;
|
|
}
|
|
format_base::reset_course_cache($SITE->id);
|
|
|
|
return '';
|
|
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Select for blog's bloglevel setting: if set to 0, will set blog_menu
|
|
* block to hidden.
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_bloglevel extends admin_setting_configselect {
|
|
/**
|
|
* Updates the database and save the setting
|
|
*
|
|
* @param string data
|
|
* @return string empty or error message
|
|
*/
|
|
public function write_setting($data) {
|
|
global $DB, $CFG;
|
|
if ($data == 0) {
|
|
$blogblocks = $DB->get_records_select('block', "name LIKE 'blog_%' AND visible = 1");
|
|
foreach ($blogblocks as $block) {
|
|
$DB->set_field('block', 'visible', 0, array('id' => $block->id));
|
|
}
|
|
} else {
|
|
// reenable all blocks only when switching from disabled blogs
|
|
if (isset($CFG->bloglevel) and $CFG->bloglevel == 0) {
|
|
$blogblocks = $DB->get_records_select('block', "name LIKE 'blog_%' AND visible = 0");
|
|
foreach ($blogblocks as $block) {
|
|
$DB->set_field('block', 'visible', 1, array('id' => $block->id));
|
|
}
|
|
}
|
|
}
|
|
return parent::write_setting($data);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Special select - lists on the frontpage - hacky
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_courselist_frontpage extends admin_setting {
|
|
/** @var array Array of choices value=>label */
|
|
public $choices;
|
|
|
|
/**
|
|
* Construct override, requires one param
|
|
*
|
|
* @param bool $loggedin Is the user logged in
|
|
*/
|
|
public function __construct($loggedin) {
|
|
global $CFG;
|
|
require_once($CFG->dirroot.'/course/lib.php');
|
|
$name = 'frontpage'.($loggedin ? 'loggedin' : '');
|
|
$visiblename = get_string('frontpage'.($loggedin ? 'loggedin' : ''),'admin');
|
|
$description = get_string('configfrontpage'.($loggedin ? 'loggedin' : ''),'admin');
|
|
$defaults = array(FRONTPAGEALLCOURSELIST);
|
|
parent::__construct($name, $visiblename, $description, $defaults);
|
|
}
|
|
|
|
/**
|
|
* Loads the choices available
|
|
*
|
|
* @return bool always returns true
|
|
*/
|
|
public function load_choices() {
|
|
if (is_array($this->choices)) {
|
|
return true;
|
|
}
|
|
$this->choices = array(FRONTPAGENEWS => get_string('frontpagenews'),
|
|
FRONTPAGEALLCOURSELIST => get_string('frontpagecourselist'),
|
|
FRONTPAGEENROLLEDCOURSELIST => get_string('frontpageenrolledcourselist'),
|
|
FRONTPAGECATEGORYNAMES => get_string('frontpagecategorynames'),
|
|
FRONTPAGECATEGORYCOMBO => get_string('frontpagecategorycombo'),
|
|
FRONTPAGECOURSESEARCH => get_string('frontpagecoursesearch'),
|
|
'none' => get_string('none'));
|
|
if ($this->name === 'frontpage') {
|
|
unset($this->choices[FRONTPAGEENROLLEDCOURSELIST]);
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Returns the selected settings
|
|
*
|
|
* @param mixed array or setting or null
|
|
*/
|
|
public function get_setting() {
|
|
$result = $this->config_read($this->name);
|
|
if (is_null($result)) {
|
|
return NULL;
|
|
}
|
|
if ($result === '') {
|
|
return array();
|
|
}
|
|
return explode(',', $result);
|
|
}
|
|
|
|
/**
|
|
* Save the selected options
|
|
*
|
|
* @param array $data
|
|
* @return mixed empty string (data is not an array) or bool true=success false=failure
|
|
*/
|
|
public function write_setting($data) {
|
|
if (!is_array($data)) {
|
|
return '';
|
|
}
|
|
$this->load_choices();
|
|
$save = array();
|
|
foreach($data as $datum) {
|
|
if ($datum == 'none' or !array_key_exists($datum, $this->choices)) {
|
|
continue;
|
|
}
|
|
$save[$datum] = $datum; // no duplicates
|
|
}
|
|
return ($this->config_write($this->name, implode(',', $save)) ? '' : get_string('errorsetting', 'admin'));
|
|
}
|
|
|
|
/**
|
|
* Return XHTML select field and wrapping div
|
|
*
|
|
* @todo Add vartype handling to make sure $data is an array
|
|
* @param array $data Array of elements to select by default
|
|
* @return string XHTML select field and wrapping div
|
|
*/
|
|
public function output_html($data, $query='') {
|
|
$this->load_choices();
|
|
$currentsetting = array();
|
|
foreach ($data as $key) {
|
|
if ($key != 'none' and array_key_exists($key, $this->choices)) {
|
|
$currentsetting[] = $key; // already selected first
|
|
}
|
|
}
|
|
|
|
$return = '<div class="form-group">';
|
|
for ($i = 0; $i < count($this->choices) - 1; $i++) {
|
|
if (!array_key_exists($i, $currentsetting)) {
|
|
$currentsetting[$i] = 'none'; //none
|
|
}
|
|
$return .='<select class="form-select" id="'.$this->get_id().$i.'" name="'.$this->get_full_name().'[]">';
|
|
foreach ($this->choices as $key => $value) {
|
|
$return .= '<option value="'.$key.'"'.("$key" == $currentsetting[$i] ? ' selected="selected"' : '').'>'.$value.'</option>';
|
|
}
|
|
$return .= '</select>';
|
|
if ($i !== count($this->choices) - 2) {
|
|
$return .= '<br />';
|
|
}
|
|
}
|
|
$return .= '</div>';
|
|
|
|
return format_admin_setting($this, $this->visiblename, $return, $this->description, false, '', NULL, $query);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Special checkbox for frontpage - stores data in course table
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_sitesetcheckbox extends admin_setting_configcheckbox {
|
|
/**
|
|
* Returns the current sites name
|
|
*
|
|
* @return string
|
|
*/
|
|
public function get_setting() {
|
|
$site = course_get_format(get_site())->get_course();
|
|
return $site->{$this->name};
|
|
}
|
|
|
|
/**
|
|
* Save the selected setting
|
|
*
|
|
* @param string $data The selected site
|
|
* @return string empty string or error message
|
|
*/
|
|
public function write_setting($data) {
|
|
global $DB, $SITE, $COURSE;
|
|
$record = new stdClass();
|
|
$record->id = $SITE->id;
|
|
$record->{$this->name} = ($data == '1' ? 1 : 0);
|
|
$record->timemodified = time();
|
|
|
|
course_get_format($SITE)->update_course_format_options($record);
|
|
$DB->update_record('course', $record);
|
|
|
|
// Reset caches.
|
|
$SITE = $DB->get_record('course', array('id'=>$SITE->id), '*', MUST_EXIST);
|
|
if ($SITE->id == $COURSE->id) {
|
|
$COURSE = $SITE;
|
|
}
|
|
format_base::reset_course_cache($SITE->id);
|
|
|
|
return '';
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Special text for frontpage - stores data in course table.
|
|
* Empty string means not set here. Manual setting is required.
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_sitesettext extends admin_setting_configtext {
|
|
/**
|
|
* Return the current setting
|
|
*
|
|
* @return mixed string or null
|
|
*/
|
|
public function get_setting() {
|
|
$site = course_get_format(get_site())->get_course();
|
|
return $site->{$this->name} != '' ? $site->{$this->name} : NULL;
|
|
}
|
|
|
|
/**
|
|
* Validate the selected data
|
|
*
|
|
* @param string $data The selected value to validate
|
|
* @return mixed true or message string
|
|
*/
|
|
public function validate($data) {
|
|
$cleaned = clean_param($data, PARAM_TEXT);
|
|
if ($cleaned === '') {
|
|
return get_string('required');
|
|
}
|
|
if ("$data" == "$cleaned") { // implicit conversion to string is needed to do exact comparison
|
|
return true;
|
|
} else {
|
|
return get_string('validateerror', 'admin');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Save the selected setting
|
|
*
|
|
* @param string $data The selected value
|
|
* @return string empty or error message
|
|
*/
|
|
public function write_setting($data) {
|
|
global $DB, $SITE, $COURSE;
|
|
$data = trim($data);
|
|
$validated = $this->validate($data);
|
|
if ($validated !== true) {
|
|
return $validated;
|
|
}
|
|
|
|
$record = new stdClass();
|
|
$record->id = $SITE->id;
|
|
$record->{$this->name} = $data;
|
|
$record->timemodified = time();
|
|
|
|
course_get_format($SITE)->update_course_format_options($record);
|
|
$DB->update_record('course', $record);
|
|
|
|
// Reset caches.
|
|
$SITE = $DB->get_record('course', array('id'=>$SITE->id), '*', MUST_EXIST);
|
|
if ($SITE->id == $COURSE->id) {
|
|
$COURSE = $SITE;
|
|
}
|
|
format_base::reset_course_cache($SITE->id);
|
|
|
|
return '';
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Special text editor for site description.
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_special_frontpagedesc extends admin_setting {
|
|
/**
|
|
* Calls parent::__construct with specific arguments
|
|
*/
|
|
public function __construct() {
|
|
parent::__construct('summary', get_string('frontpagedescription'), get_string('frontpagedescriptionhelp'), NULL);
|
|
editors_head_setup();
|
|
}
|
|
|
|
/**
|
|
* Return the current setting
|
|
* @return string The current setting
|
|
*/
|
|
public function get_setting() {
|
|
$site = course_get_format(get_site())->get_course();
|
|
return $site->{$this->name};
|
|
}
|
|
|
|
/**
|
|
* Save the new setting
|
|
*
|
|
* @param string $data The new value to save
|
|
* @return string empty or error message
|
|
*/
|
|
public function write_setting($data) {
|
|
global $DB, $SITE, $COURSE;
|
|
$record = new stdClass();
|
|
$record->id = $SITE->id;
|
|
$record->{$this->name} = $data;
|
|
$record->timemodified = time();
|
|
|
|
course_get_format($SITE)->update_course_format_options($record);
|
|
$DB->update_record('course', $record);
|
|
|
|
// Reset caches.
|
|
$SITE = $DB->get_record('course', array('id'=>$SITE->id), '*', MUST_EXIST);
|
|
if ($SITE->id == $COURSE->id) {
|
|
$COURSE = $SITE;
|
|
}
|
|
format_base::reset_course_cache($SITE->id);
|
|
|
|
return '';
|
|
}
|
|
|
|
/**
|
|
* Returns XHTML for the field plus wrapping div
|
|
*
|
|
* @param string $data The current value
|
|
* @param string $query
|
|
* @return string The XHTML output
|
|
*/
|
|
public function output_html($data, $query='') {
|
|
global $CFG;
|
|
|
|
$CFG->adminusehtmleditor = can_use_html_editor();
|
|
$return = '<div class="form-htmlarea">'.print_textarea($CFG->adminusehtmleditor, 15, 60, 0, 0, $this->get_full_name(), $data, 0, true, 'summary') .'</div>';
|
|
|
|
return format_admin_setting($this, $this->visiblename, $return, $this->description, false, '', NULL, $query);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Administration interface for emoticon_manager settings.
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_emoticons extends admin_setting {
|
|
|
|
/**
|
|
* Calls parent::__construct with specific args
|
|
*/
|
|
public function __construct() {
|
|
global $CFG;
|
|
|
|
$manager = get_emoticon_manager();
|
|
$defaults = $this->prepare_form_data($manager->default_emoticons());
|
|
parent::__construct('emoticons', get_string('emoticons', 'admin'), get_string('emoticons_desc', 'admin'), $defaults);
|
|
}
|
|
|
|
/**
|
|
* Return the current setting(s)
|
|
*
|
|
* @return array Current settings array
|
|
*/
|
|
public function get_setting() {
|
|
global $CFG;
|
|
|
|
$manager = get_emoticon_manager();
|
|
|
|
$config = $this->config_read($this->name);
|
|
if (is_null($config)) {
|
|
return null;
|
|
}
|
|
|
|
$config = $manager->decode_stored_config($config);
|
|
if (is_null($config)) {
|
|
return null;
|
|
}
|
|
|
|
return $this->prepare_form_data($config);
|
|
}
|
|
|
|
/**
|
|
* Save selected settings
|
|
*
|
|
* @param array $data Array of settings to save
|
|
* @return bool
|
|
*/
|
|
public function write_setting($data) {
|
|
|
|
$manager = get_emoticon_manager();
|
|
$emoticons = $this->process_form_data($data);
|
|
|
|
if ($emoticons === false) {
|
|
return false;
|
|
}
|
|
|
|
if ($this->config_write($this->name, $manager->encode_stored_config($emoticons))) {
|
|
return ''; // success
|
|
} else {
|
|
return get_string('errorsetting', 'admin') . $this->visiblename . html_writer::empty_tag('br');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Return XHTML field(s) for options
|
|
*
|
|
* @param array $data Array of options to set in HTML
|
|
* @return string XHTML string for the fields and wrapping div(s)
|
|
*/
|
|
public function output_html($data, $query='') {
|
|
global $OUTPUT;
|
|
|
|
$out = html_writer::start_tag('table', array('id' => 'emoticonsetting', 'class' => 'admintable generaltable'));
|
|
$out .= html_writer::start_tag('thead');
|
|
$out .= html_writer::start_tag('tr');
|
|
$out .= html_writer::tag('th', get_string('emoticontext', 'admin'));
|
|
$out .= html_writer::tag('th', get_string('emoticonimagename', 'admin'));
|
|
$out .= html_writer::tag('th', get_string('emoticoncomponent', 'admin'));
|
|
$out .= html_writer::tag('th', get_string('emoticonalt', 'admin'), array('colspan' => 2));
|
|
$out .= html_writer::tag('th', '');
|
|
$out .= html_writer::end_tag('tr');
|
|
$out .= html_writer::end_tag('thead');
|
|
$out .= html_writer::start_tag('tbody');
|
|
$i = 0;
|
|
foreach($data as $field => $value) {
|
|
switch ($i) {
|
|
case 0:
|
|
$out .= html_writer::start_tag('tr');
|
|
$current_text = $value;
|
|
$current_filename = '';
|
|
$current_imagecomponent = '';
|
|
$current_altidentifier = '';
|
|
$current_altcomponent = '';
|
|
case 1:
|
|
$current_filename = $value;
|
|
case 2:
|
|
$current_imagecomponent = $value;
|
|
case 3:
|
|
$current_altidentifier = $value;
|
|
case 4:
|
|
$current_altcomponent = $value;
|
|
}
|
|
|
|
$out .= html_writer::tag('td',
|
|
html_writer::empty_tag('input',
|
|
array(
|
|
'type' => 'text',
|
|
'class' => 'form-text',
|
|
'name' => $this->get_full_name().'['.$field.']',
|
|
'value' => $value,
|
|
)
|
|
), array('class' => 'c'.$i)
|
|
);
|
|
|
|
if ($i == 4) {
|
|
if (get_string_manager()->string_exists($current_altidentifier, $current_altcomponent)) {
|
|
$alt = get_string($current_altidentifier, $current_altcomponent);
|
|
} else {
|
|
$alt = $current_text;
|
|
}
|
|
if ($current_filename) {
|
|
$out .= html_writer::tag('td', $OUTPUT->render(new pix_emoticon($current_filename, $alt, $current_imagecomponent)));
|
|
} else {
|
|
$out .= html_writer::tag('td', '');
|
|
}
|
|
$out .= html_writer::end_tag('tr');
|
|
$i = 0;
|
|
} else {
|
|
$i++;
|
|
}
|
|
|
|
}
|
|
$out .= html_writer::end_tag('tbody');
|
|
$out .= html_writer::end_tag('table');
|
|
$out = html_writer::tag('div', $out, array('class' => 'form-group'));
|
|
$out .= html_writer::tag('div', html_writer::link(new moodle_url('/admin/resetemoticons.php'), get_string('emoticonsreset', 'admin')));
|
|
|
|
return format_admin_setting($this, $this->visiblename, $out, $this->description, false, '', NULL, $query);
|
|
}
|
|
|
|
/**
|
|
* Converts the array of emoticon objects provided by {@see emoticon_manager} into admin settings form data
|
|
*
|
|
* @see self::process_form_data()
|
|
* @param array $emoticons array of emoticon objects as returned by {@see emoticon_manager}
|
|
* @return array of form fields and their values
|
|
*/
|
|
protected function prepare_form_data(array $emoticons) {
|
|
|
|
$form = array();
|
|
$i = 0;
|
|
foreach ($emoticons as $emoticon) {
|
|
$form['text'.$i] = $emoticon->text;
|
|
$form['imagename'.$i] = $emoticon->imagename;
|
|
$form['imagecomponent'.$i] = $emoticon->imagecomponent;
|
|
$form['altidentifier'.$i] = $emoticon->altidentifier;
|
|
$form['altcomponent'.$i] = $emoticon->altcomponent;
|
|
$i++;
|
|
}
|
|
// add one more blank field set for new object
|
|
$form['text'.$i] = '';
|
|
$form['imagename'.$i] = '';
|
|
$form['imagecomponent'.$i] = '';
|
|
$form['altidentifier'.$i] = '';
|
|
$form['altcomponent'.$i] = '';
|
|
|
|
return $form;
|
|
}
|
|
|
|
/**
|
|
* Converts the data from admin settings form into an array of emoticon objects
|
|
*
|
|
* @see self::prepare_form_data()
|
|
* @param array $data array of admin form fields and values
|
|
* @return false|array of emoticon objects
|
|
*/
|
|
protected function process_form_data(array $form) {
|
|
|
|
$count = count($form); // number of form field values
|
|
|
|
if ($count % 5) {
|
|
// we must get five fields per emoticon object
|
|
return false;
|
|
}
|
|
|
|
$emoticons = array();
|
|
for ($i = 0; $i < $count / 5; $i++) {
|
|
$emoticon = new stdClass();
|
|
$emoticon->text = clean_param(trim($form['text'.$i]), PARAM_NOTAGS);
|
|
$emoticon->imagename = clean_param(trim($form['imagename'.$i]), PARAM_PATH);
|
|
$emoticon->imagecomponent = clean_param(trim($form['imagecomponent'.$i]), PARAM_COMPONENT);
|
|
$emoticon->altidentifier = clean_param(trim($form['altidentifier'.$i]), PARAM_STRINGID);
|
|
$emoticon->altcomponent = clean_param(trim($form['altcomponent'.$i]), PARAM_COMPONENT);
|
|
|
|
if (strpos($emoticon->text, ':/') !== false or strpos($emoticon->text, '//') !== false) {
|
|
// prevent from breaking http://url.addresses by accident
|
|
$emoticon->text = '';
|
|
}
|
|
|
|
if (strlen($emoticon->text) < 2) {
|
|
// do not allow single character emoticons
|
|
$emoticon->text = '';
|
|
}
|
|
|
|
if (preg_match('/^[a-zA-Z]+[a-zA-Z0-9]*$/', $emoticon->text)) {
|
|
// emoticon text must contain some non-alphanumeric character to prevent
|
|
// breaking HTML tags
|
|
$emoticon->text = '';
|
|
}
|
|
|
|
if ($emoticon->text !== '' and $emoticon->imagename !== '' and $emoticon->imagecomponent !== '') {
|
|
$emoticons[] = $emoticon;
|
|
}
|
|
}
|
|
return $emoticons;
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Special setting for limiting of the list of available languages.
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_langlist extends admin_setting_configtext {
|
|
/**
|
|
* Calls parent::__construct with specific arguments
|
|
*/
|
|
public function __construct() {
|
|
parent::__construct('langlist', get_string('langlist', 'admin'), get_string('configlanglist', 'admin'), '', PARAM_NOTAGS);
|
|
}
|
|
|
|
/**
|
|
* Save the new setting
|
|
*
|
|
* @param string $data The new setting
|
|
* @return bool
|
|
*/
|
|
public function write_setting($data) {
|
|
$return = parent::write_setting($data);
|
|
get_string_manager()->reset_caches();
|
|
return $return;
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Selection of one of the recognised countries using the list
|
|
* returned by {@link get_list_of_countries()}.
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_settings_country_select extends admin_setting_configselect {
|
|
protected $includeall;
|
|
public function __construct($name, $visiblename, $description, $defaultsetting, $includeall=false) {
|
|
$this->includeall = $includeall;
|
|
parent::__construct($name, $visiblename, $description, $defaultsetting, NULL);
|
|
}
|
|
|
|
/**
|
|
* Lazy-load the available choices for the select box
|
|
*/
|
|
public function load_choices() {
|
|
global $CFG;
|
|
if (is_array($this->choices)) {
|
|
return true;
|
|
}
|
|
$this->choices = array_merge(
|
|
array('0' => get_string('choosedots')),
|
|
get_string_manager()->get_list_of_countries($this->includeall));
|
|
return true;
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* admin_setting_configselect for the default number of sections in a course,
|
|
* simply so we can lazy-load the choices.
|
|
*
|
|
* @copyright 2011 The Open University
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_settings_num_course_sections extends admin_setting_configselect {
|
|
public function __construct($name, $visiblename, $description, $defaultsetting) {
|
|
parent::__construct($name, $visiblename, $description, $defaultsetting, array());
|
|
}
|
|
|
|
/** Lazy-load the available choices for the select box */
|
|
public function load_choices() {
|
|
$max = get_config('moodlecourse', 'maxsections');
|
|
if (!isset($max) || !is_numeric($max)) {
|
|
$max = 52;
|
|
}
|
|
for ($i = 0; $i <= $max; $i++) {
|
|
$this->choices[$i] = "$i";
|
|
}
|
|
return true;
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Course category selection
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_settings_coursecat_select extends admin_setting_configselect {
|
|
/**
|
|
* Calls parent::__construct with specific arguments
|
|
*/
|
|
public function __construct($name, $visiblename, $description, $defaultsetting) {
|
|
parent::__construct($name, $visiblename, $description, $defaultsetting, NULL);
|
|
}
|
|
|
|
/**
|
|
* Load the available choices for the select box
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function load_choices() {
|
|
global $CFG;
|
|
require_once($CFG->dirroot.'/course/lib.php');
|
|
if (is_array($this->choices)) {
|
|
return true;
|
|
}
|
|
$this->choices = make_categories_options();
|
|
return true;
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Special control for selecting days to backup
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_special_backupdays extends admin_setting_configmulticheckbox2 {
|
|
/**
|
|
* Calls parent::__construct with specific arguments
|
|
*/
|
|
public function __construct() {
|
|
parent::__construct('backup_auto_weekdays', get_string('automatedbackupschedule','backup'), get_string('automatedbackupschedulehelp','backup'), array(), NULL);
|
|
$this->plugin = 'backup';
|
|
}
|
|
|
|
/**
|
|
* Load the available choices for the select box
|
|
*
|
|
* @return bool Always returns true
|
|
*/
|
|
public function load_choices() {
|
|
if (is_array($this->choices)) {
|
|
return true;
|
|
}
|
|
$this->choices = array();
|
|
$days = array('sunday', 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday');
|
|
foreach ($days as $day) {
|
|
$this->choices[$day] = get_string($day, 'calendar');
|
|
}
|
|
return true;
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Special debug setting
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_special_debug extends admin_setting_configselect {
|
|
/**
|
|
* Calls parent::__construct with specific arguments
|
|
*/
|
|
public function __construct() {
|
|
parent::__construct('debug', get_string('debug', 'admin'), get_string('configdebug', 'admin'), DEBUG_NONE, NULL);
|
|
}
|
|
|
|
/**
|
|
* Load the available choices for the select box
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function load_choices() {
|
|
if (is_array($this->choices)) {
|
|
return true;
|
|
}
|
|
$this->choices = array(DEBUG_NONE => get_string('debugnone', 'admin'),
|
|
DEBUG_MINIMAL => get_string('debugminimal', 'admin'),
|
|
DEBUG_NORMAL => get_string('debugnormal', 'admin'),
|
|
DEBUG_ALL => get_string('debugall', 'admin'),
|
|
DEBUG_DEVELOPER => get_string('debugdeveloper', 'admin'));
|
|
return true;
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Special admin control
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_special_calendar_weekend extends admin_setting {
|
|
/**
|
|
* Calls parent::__construct with specific arguments
|
|
*/
|
|
public function __construct() {
|
|
$name = 'calendar_weekend';
|
|
$visiblename = get_string('calendar_weekend', 'admin');
|
|
$description = get_string('helpweekenddays', 'admin');
|
|
$default = array ('0', '6'); // Saturdays and Sundays
|
|
parent::__construct($name, $visiblename, $description, $default);
|
|
}
|
|
|
|
/**
|
|
* Gets the current settings as an array
|
|
*
|
|
* @return mixed Null if none, else array of settings
|
|
*/
|
|
public function get_setting() {
|
|
$result = $this->config_read($this->name);
|
|
if (is_null($result)) {
|
|
return NULL;
|
|
}
|
|
if ($result === '') {
|
|
return array();
|
|
}
|
|
$settings = array();
|
|
for ($i=0; $i<7; $i++) {
|
|
if ($result & (1 << $i)) {
|
|
$settings[] = $i;
|
|
}
|
|
}
|
|
return $settings;
|
|
}
|
|
|
|
/**
|
|
* Save the new settings
|
|
*
|
|
* @param array $data Array of new settings
|
|
* @return bool
|
|
*/
|
|
public function write_setting($data) {
|
|
if (!is_array($data)) {
|
|
return '';
|
|
}
|
|
unset($data['xxxxx']);
|
|
$result = 0;
|
|
foreach($data as $index) {
|
|
$result |= 1 << $index;
|
|
}
|
|
return ($this->config_write($this->name, $result) ? '' : get_string('errorsetting', 'admin'));
|
|
}
|
|
|
|
/**
|
|
* Return XHTML to display the control
|
|
*
|
|
* @param array $data array of selected days
|
|
* @param string $query
|
|
* @return string XHTML for display (field + wrapping div(s)
|
|
*/
|
|
public function output_html($data, $query='') {
|
|
// The order matters very much because of the implied numeric keys
|
|
$days = array('sunday', 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday');
|
|
$return = '<table><thead><tr>';
|
|
$return .= '<input type="hidden" name="'.$this->get_full_name().'[xxxxx]" value="1" />'; // something must be submitted even if nothing selected
|
|
foreach($days as $index => $day) {
|
|
$return .= '<td><label for="'.$this->get_id().$index.'">'.get_string($day, 'calendar').'</label></td>';
|
|
}
|
|
$return .= '</tr></thead><tbody><tr>';
|
|
foreach($days as $index => $day) {
|
|
$return .= '<td><input type="checkbox" class="form-checkbox" id="'.$this->get_id().$index.'" name="'.$this->get_full_name().'[]" value="'.$index.'" '.(in_array("$index", $data) ? 'checked="checked"' : '').' /></td>';
|
|
}
|
|
$return .= '</tr></tbody></table>';
|
|
|
|
return format_admin_setting($this, $this->visiblename, $return, $this->description, false, '', NULL, $query);
|
|
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Admin setting that allows a user to pick a behaviour.
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_question_behaviour extends admin_setting_configselect {
|
|
/**
|
|
* @param string $name name of config variable
|
|
* @param string $visiblename display name
|
|
* @param string $description description
|
|
* @param string $default default.
|
|
*/
|
|
public function __construct($name, $visiblename, $description, $default) {
|
|
parent::__construct($name, $visiblename, $description, $default, NULL);
|
|
}
|
|
|
|
/**
|
|
* Load list of behaviours as choices
|
|
* @return bool true => success, false => error.
|
|
*/
|
|
public function load_choices() {
|
|
global $CFG;
|
|
require_once($CFG->dirroot . '/question/engine/lib.php');
|
|
$this->choices = question_engine::get_behaviour_options('');
|
|
return true;
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Admin setting that allows a user to pick appropriate roles for something.
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_pickroles extends admin_setting_configmulticheckbox {
|
|
/** @var array Array of capabilities which identify roles */
|
|
private $types;
|
|
|
|
/**
|
|
* @param string $name Name of config variable
|
|
* @param string $visiblename Display name
|
|
* @param string $description Description
|
|
* @param array $types Array of archetypes which identify
|
|
* roles that will be enabled by default.
|
|
*/
|
|
public function __construct($name, $visiblename, $description, $types) {
|
|
parent::__construct($name, $visiblename, $description, NULL, NULL);
|
|
$this->types = $types;
|
|
}
|
|
|
|
/**
|
|
* Load roles as choices
|
|
*
|
|
* @return bool true=>success, false=>error
|
|
*/
|
|
public function load_choices() {
|
|
global $CFG, $DB;
|
|
if (during_initial_install()) {
|
|
return false;
|
|
}
|
|
if (is_array($this->choices)) {
|
|
return true;
|
|
}
|
|
if ($roles = get_all_roles()) {
|
|
$this->choices = role_fix_names($roles, null, ROLENAME_ORIGINAL, true);
|
|
return true;
|
|
} else {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Return the default setting for this control
|
|
*
|
|
* @return array Array of default settings
|
|
*/
|
|
public function get_defaultsetting() {
|
|
global $CFG;
|
|
|
|
if (during_initial_install()) {
|
|
return null;
|
|
}
|
|
$result = array();
|
|
foreach($this->types as $archetype) {
|
|
if ($caproles = get_archetype_roles($archetype)) {
|
|
foreach ($caproles as $caprole) {
|
|
$result[$caprole->id] = 1;
|
|
}
|
|
}
|
|
}
|
|
return $result;
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Text field with an advanced checkbox, that controls a additional $name.'_adv' setting.
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_configtext_with_advanced extends admin_setting_configtext {
|
|
/**
|
|
* 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 ('value'=>string, '__construct'=>bool)
|
|
* @param mixed $paramtype int means PARAM_XXX type, string is a allowed format in regex
|
|
* @param int $size default field size
|
|
*/
|
|
public function __construct($name, $visiblename, $description, $defaultsetting, $paramtype=PARAM_RAW, $size=null) {
|
|
parent::__construct($name, $visiblename, $description, $defaultsetting['value'], $paramtype, $size);
|
|
$this->set_advanced_flag_options(admin_setting_flag::ENABLED, !empty($defaultsetting['adv']));
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Checkbox with an advanced checkbox that controls an additional $name.'_adv' config setting.
|
|
*
|
|
* @copyright 2009 Petr Skoda (http://skodak.org)
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_configcheckbox_with_advanced extends admin_setting_configcheckbox {
|
|
|
|
/**
|
|
* 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 ('value'=>string, 'adv'=>bool)
|
|
* @param string $yes value used when checked
|
|
* @param string $no value used when not checked
|
|
*/
|
|
public function __construct($name, $visiblename, $description, $defaultsetting, $yes='1', $no='0') {
|
|
parent::__construct($name, $visiblename, $description, $defaultsetting['value'], $yes, $no);
|
|
$this->set_advanced_flag_options(admin_setting_flag::ENABLED, !empty($defaultsetting['adv']));
|
|
}
|
|
|
|
}
|
|
|
|
|
|
/**
|
|
* Checkbox with an advanced checkbox that controls an additional $name.'_locked' config setting.
|
|
*
|
|
* This is nearly a copy/paste of admin_setting_configcheckbox_with_adv
|
|
*
|
|
* @copyright 2010 Sam Hemelryk
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_configcheckbox_with_lock extends admin_setting_configcheckbox {
|
|
/**
|
|
* 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 ('value'=>string, 'locked'=>bool)
|
|
* @param string $yes value used when checked
|
|
* @param string $no value used when not checked
|
|
*/
|
|
public function __construct($name, $visiblename, $description, $defaultsetting, $yes='1', $no='0') {
|
|
parent::__construct($name, $visiblename, $description, $defaultsetting['value'], $yes, $no);
|
|
$this->set_locked_flag_options(admin_setting_flag::ENABLED, !empty($defaultsetting['locked']));
|
|
}
|
|
|
|
}
|
|
|
|
|
|
/**
|
|
* Dropdown menu with an advanced checkbox, that controls a additional $name.'_adv' setting.
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_configselect_with_advanced extends admin_setting_configselect {
|
|
/**
|
|
* Calls parent::__construct with specific arguments
|
|
*/
|
|
public function __construct($name, $visiblename, $description, $defaultsetting, $choices) {
|
|
parent::__construct($name, $visiblename, $description, $defaultsetting['value'], $choices);
|
|
$this->set_advanced_flag_options(admin_setting_flag::ENABLED, !empty($defaultsetting['adv']));
|
|
}
|
|
|
|
}
|
|
|
|
|
|
/**
|
|
* Graded roles in gradebook
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_special_gradebookroles extends admin_setting_pickroles {
|
|
/**
|
|
* Calls parent::__construct with specific arguments
|
|
*/
|
|
public function __construct() {
|
|
parent::__construct('gradebookroles', get_string('gradebookroles', 'admin'),
|
|
get_string('configgradebookroles', 'admin'),
|
|
array('student'));
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_regradingcheckbox extends admin_setting_configcheckbox {
|
|
/**
|
|
* Saves the new settings passed in $data
|
|
*
|
|
* @param string $data
|
|
* @return mixed string or Array
|
|
*/
|
|
public function write_setting($data) {
|
|
global $CFG, $DB;
|
|
|
|
$oldvalue = $this->config_read($this->name);
|
|
$return = parent::write_setting($data);
|
|
$newvalue = $this->config_read($this->name);
|
|
|
|
if ($oldvalue !== $newvalue) {
|
|
// force full regrading
|
|
$DB->set_field('grade_items', 'needsupdate', 1, array('needsupdate'=>0));
|
|
}
|
|
|
|
return $return;
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Which roles to show on course description page
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_special_coursecontact extends admin_setting_pickroles {
|
|
/**
|
|
* Calls parent::__construct with specific arguments
|
|
*/
|
|
public function __construct() {
|
|
parent::__construct('coursecontact', get_string('coursecontact', 'admin'),
|
|
get_string('coursecontact_desc', 'admin'),
|
|
array('editingteacher'));
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_special_gradelimiting extends admin_setting_configcheckbox {
|
|
/**
|
|
* Calls parent::__construct with specific arguments
|
|
*/
|
|
function admin_setting_special_gradelimiting() {
|
|
parent::__construct('unlimitedgrades', get_string('unlimitedgrades', 'grades'),
|
|
get_string('unlimitedgrades_help', 'grades'), '0', '1', '0');
|
|
}
|
|
|
|
/**
|
|
* Force site regrading
|
|
*/
|
|
function regrade_all() {
|
|
global $CFG;
|
|
require_once("$CFG->libdir/gradelib.php");
|
|
grade_force_site_regrading();
|
|
}
|
|
|
|
/**
|
|
* Saves the new settings
|
|
*
|
|
* @param mixed $data
|
|
* @return string empty string or error message
|
|
*/
|
|
function write_setting($data) {
|
|
$previous = $this->get_setting();
|
|
|
|
if ($previous === null) {
|
|
if ($data) {
|
|
$this->regrade_all();
|
|
}
|
|
} else {
|
|
if ($data != $previous) {
|
|
$this->regrade_all();
|
|
}
|
|
}
|
|
return ($this->config_write($this->name, $data) ? '' : get_string('errorsetting', 'admin'));
|
|
}
|
|
|
|
}
|
|
|
|
|
|
/**
|
|
* Primary grade export plugin - has state tracking.
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_special_gradeexport extends admin_setting_configmulticheckbox {
|
|
/**
|
|
* Calls parent::__construct with specific arguments
|
|
*/
|
|
public function __construct() {
|
|
parent::__construct('gradeexport', get_string('gradeexport', 'admin'),
|
|
get_string('configgradeexport', 'admin'), array(), NULL);
|
|
}
|
|
|
|
/**
|
|
* Load the available choices for the multicheckbox
|
|
*
|
|
* @return bool always returns true
|
|
*/
|
|
public function load_choices() {
|
|
if (is_array($this->choices)) {
|
|
return true;
|
|
}
|
|
$this->choices = array();
|
|
|
|
if ($plugins = get_plugin_list('gradeexport')) {
|
|
foreach($plugins as $plugin => $unused) {
|
|
$this->choices[$plugin] = get_string('pluginname', 'gradeexport_'.$plugin);
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Grade category settings
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_gradecat_combo extends admin_setting {
|
|
/** @var array Array of choices */
|
|
public $choices;
|
|
|
|
/**
|
|
* Sets choices and calls parent::__construct with passed arguments
|
|
* @param string $name
|
|
* @param string $visiblename
|
|
* @param string $description
|
|
* @param mixed $defaultsetting string or array depending on implementation
|
|
* @param array $choices An array of choices for the control
|
|
*/
|
|
public function __construct($name, $visiblename, $description, $defaultsetting, $choices) {
|
|
$this->choices = $choices;
|
|
parent::__construct($name, $visiblename, $description, $defaultsetting);
|
|
}
|
|
|
|
/**
|
|
* Return the current setting(s) array
|
|
*
|
|
* @return array Array of value=>xx, forced=>xx, adv=>xx
|
|
*/
|
|
public function get_setting() {
|
|
global $CFG;
|
|
|
|
$value = $this->config_read($this->name);
|
|
$flag = $this->config_read($this->name.'_flag');
|
|
|
|
if (is_null($value) or is_null($flag)) {
|
|
return NULL;
|
|
}
|
|
|
|
$flag = (int)$flag;
|
|
$forced = (boolean)(1 & $flag); // first bit
|
|
$adv = (boolean)(2 & $flag); // second bit
|
|
|
|
return array('value' => $value, 'forced' => $forced, 'adv' => $adv);
|
|
}
|
|
|
|
/**
|
|
* Save the new settings passed in $data
|
|
*
|
|
* @todo Add vartype handling to ensure $data is array
|
|
* @param array $data Associative array of value=>xx, forced=>xx, adv=>xx
|
|
* @return string empty or error message
|
|
*/
|
|
public function write_setting($data) {
|
|
global $CFG;
|
|
|
|
$value = $data['value'];
|
|
$forced = empty($data['forced']) ? 0 : 1;
|
|
$adv = empty($data['adv']) ? 0 : 2;
|
|
$flag = ($forced | $adv); //bitwise or
|
|
|
|
if (!in_array($value, array_keys($this->choices))) {
|
|
return 'Error setting ';
|
|
}
|
|
|
|
$oldvalue = $this->config_read($this->name);
|
|
$oldflag = (int)$this->config_read($this->name.'_flag');
|
|
$oldforced = (1 & $oldflag); // first bit
|
|
|
|
$result1 = $this->config_write($this->name, $value);
|
|
$result2 = $this->config_write($this->name.'_flag', $flag);
|
|
|
|
// force regrade if needed
|
|
if ($oldforced != $forced or ($forced and $value != $oldvalue)) {
|
|
require_once($CFG->libdir.'/gradelib.php');
|
|
grade_category::updated_forced_settings();
|
|
}
|
|
|
|
if ($result1 and $result2) {
|
|
return '';
|
|
} else {
|
|
return get_string('errorsetting', 'admin');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Return XHTML to display the field and wrapping div
|
|
*
|
|
* @todo Add vartype handling to ensure $data is array
|
|
* @param array $data Associative array of value=>xx, forced=>xx, adv=>xx
|
|
* @param string $query
|
|
* @return string XHTML to display control
|
|
*/
|
|
public function output_html($data, $query='') {
|
|
$value = $data['value'];
|
|
$forced = !empty($data['forced']);
|
|
$adv = !empty($data['adv']);
|
|
|
|
$default = $this->get_defaultsetting();
|
|
if (!is_null($default)) {
|
|
$defaultinfo = array();
|
|
if (isset($this->choices[$default['value']])) {
|
|
$defaultinfo[] = $this->choices[$default['value']];
|
|
}
|
|
if (!empty($default['forced'])) {
|
|
$defaultinfo[] = get_string('force');
|
|
}
|
|
if (!empty($default['adv'])) {
|
|
$defaultinfo[] = get_string('advanced');
|
|
}
|
|
$defaultinfo = implode(', ', $defaultinfo);
|
|
|
|
} else {
|
|
$defaultinfo = NULL;
|
|
}
|
|
|
|
|
|
$return = '<div class="form-group">';
|
|
$return .= '<select class="form-select" id="'.$this->get_id().'" name="'.$this->get_full_name().'[value]">';
|
|
foreach ($this->choices as $key => $val) {
|
|
// the string cast is needed because key may be integer - 0 is equal to most strings!
|
|
$return .= '<option value="'.$key.'"'.((string)$key==$value ? ' selected="selected"' : '').'>'.$val.'</option>';
|
|
}
|
|
$return .= '</select>';
|
|
$return .= '<input type="checkbox" class="form-checkbox" id="'.$this->get_id().'force" name="'.$this->get_full_name().'[forced]" value="1" '.($forced ? 'checked="checked"' : '').' />'
|
|
.'<label for="'.$this->get_id().'force">'.get_string('force').'</label>';
|
|
$return .= '<input type="checkbox" class="form-checkbox" id="'.$this->get_id().'adv" name="'.$this->get_full_name().'[adv]" value="1" '.($adv ? 'checked="checked"' : '').' />'
|
|
.'<label for="'.$this->get_id().'adv">'.get_string('advanced').'</label>';
|
|
$return .= '</div>';
|
|
|
|
return format_admin_setting($this, $this->visiblename, $return, $this->description, true, '', $defaultinfo, $query);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Selection of grade report in user profiles
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_grade_profilereport extends admin_setting_configselect {
|
|
/**
|
|
* Calls parent::__construct with specific arguments
|
|
*/
|
|
public function __construct() {
|
|
parent::__construct('grade_profilereport', get_string('profilereport', 'grades'), get_string('profilereport_help', 'grades'), 'user', null);
|
|
}
|
|
|
|
/**
|
|
* Loads an array of choices for the configselect control
|
|
*
|
|
* @return bool always return true
|
|
*/
|
|
public function load_choices() {
|
|
if (is_array($this->choices)) {
|
|
return true;
|
|
}
|
|
$this->choices = array();
|
|
|
|
global $CFG;
|
|
require_once($CFG->libdir.'/gradelib.php');
|
|
|
|
foreach (get_plugin_list('gradereport') as $plugin => $plugindir) {
|
|
if (file_exists($plugindir.'/lib.php')) {
|
|
require_once($plugindir.'/lib.php');
|
|
$functionname = 'grade_report_'.$plugin.'_profilereport';
|
|
if (function_exists($functionname)) {
|
|
$this->choices[$plugin] = get_string('pluginname', 'gradereport_'.$plugin);
|
|
}
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Special class for register auth selection
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_special_registerauth extends admin_setting_configselect {
|
|
/**
|
|
* Calls parent::__construct with specific arguments
|
|
*/
|
|
public function __construct() {
|
|
parent::__construct('registerauth', get_string('selfregistration', 'auth'), get_string('selfregistration_help', 'auth'), '', null);
|
|
}
|
|
|
|
/**
|
|
* Returns the default option
|
|
*
|
|
* @return string empty or default option
|
|
*/
|
|
public function get_defaultsetting() {
|
|
$this->load_choices();
|
|
$defaultsetting = parent::get_defaultsetting();
|
|
if (array_key_exists($defaultsetting, $this->choices)) {
|
|
return $defaultsetting;
|
|
} else {
|
|
return '';
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Loads the possible choices for the array
|
|
*
|
|
* @return bool always returns true
|
|
*/
|
|
public function load_choices() {
|
|
global $CFG;
|
|
|
|
if (is_array($this->choices)) {
|
|
return true;
|
|
}
|
|
$this->choices = array();
|
|
$this->choices[''] = get_string('disable');
|
|
|
|
$authsenabled = get_enabled_auth_plugins(true);
|
|
|
|
foreach ($authsenabled as $auth) {
|
|
$authplugin = get_auth_plugin($auth);
|
|
if (!$authplugin->can_signup()) {
|
|
continue;
|
|
}
|
|
// Get the auth title (from core or own auth lang files)
|
|
$authtitle = $authplugin->get_title();
|
|
$this->choices[$auth] = $authtitle;
|
|
}
|
|
return true;
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* General plugins manager
|
|
*/
|
|
class admin_page_pluginsoverview extends admin_externalpage {
|
|
|
|
/**
|
|
* Sets basic information about the external page
|
|
*/
|
|
public function __construct() {
|
|
global $CFG;
|
|
parent::__construct('pluginsoverview', get_string('pluginsoverview', 'core_admin'),
|
|
"$CFG->wwwroot/$CFG->admin/plugins.php");
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Module manage page
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_page_managemods extends admin_externalpage {
|
|
/**
|
|
* Calls parent::__construct with specific arguments
|
|
*/
|
|
public function __construct() {
|
|
global $CFG;
|
|
parent::__construct('managemodules', get_string('modsettings', 'admin'), "$CFG->wwwroot/$CFG->admin/modules.php");
|
|
}
|
|
|
|
/**
|
|
* Try to find the specified module
|
|
*
|
|
* @param string $query The module to search for
|
|
* @return array
|
|
*/
|
|
public function search($query) {
|
|
global $CFG, $DB;
|
|
if ($result = parent::search($query)) {
|
|
return $result;
|
|
}
|
|
|
|
$found = false;
|
|
if ($modules = $DB->get_records('modules')) {
|
|
foreach ($modules as $module) {
|
|
if (!file_exists("$CFG->dirroot/mod/$module->name/lib.php")) {
|
|
continue;
|
|
}
|
|
if (strpos($module->name, $query) !== false) {
|
|
$found = true;
|
|
break;
|
|
}
|
|
$strmodulename = get_string('modulename', $module->name);
|
|
if (strpos(textlib::strtolower($strmodulename), $query) !== false) {
|
|
$found = true;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
if ($found) {
|
|
$result = new stdClass();
|
|
$result->page = $this;
|
|
$result->settings = array();
|
|
return array($this->name => $result);
|
|
} else {
|
|
return array();
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Special class for enrol plugins management.
|
|
*
|
|
* @copyright 2010 Petr Skoda {@link http://skodak.org}
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_manageenrols extends admin_setting {
|
|
/**
|
|
* Calls parent::__construct with specific arguments
|
|
*/
|
|
public function __construct() {
|
|
$this->nosave = true;
|
|
parent::__construct('enrolsui', get_string('manageenrols', 'enrol'), '', '');
|
|
}
|
|
|
|
/**
|
|
* Always returns true, does nothing
|
|
*
|
|
* @return true
|
|
*/
|
|
public function get_setting() {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Always returns true, does nothing
|
|
*
|
|
* @return true
|
|
*/
|
|
public function get_defaultsetting() {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Always returns '', does not write anything
|
|
*
|
|
* @return string Always returns ''
|
|
*/
|
|
public function write_setting($data) {
|
|
// do not write any setting
|
|
return '';
|
|
}
|
|
|
|
/**
|
|
* Checks if $query is one of the available enrol plugins
|
|
*
|
|
* @param string $query The string to search for
|
|
* @return bool Returns true if found, false if not
|
|
*/
|
|
public function is_related($query) {
|
|
if (parent::is_related($query)) {
|
|
return true;
|
|
}
|
|
|
|
$query = textlib::strtolower($query);
|
|
$enrols = enrol_get_plugins(false);
|
|
foreach ($enrols as $name=>$enrol) {
|
|
$localised = get_string('pluginname', 'enrol_'.$name);
|
|
if (strpos(textlib::strtolower($name), $query) !== false) {
|
|
return true;
|
|
}
|
|
if (strpos(textlib::strtolower($localised), $query) !== false) {
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Builds the XHTML to display the control
|
|
*
|
|
* @param string $data Unused
|
|
* @param string $query
|
|
* @return string
|
|
*/
|
|
public function output_html($data, $query='') {
|
|
global $CFG, $OUTPUT, $DB, $PAGE;
|
|
|
|
// Display strings.
|
|
$strup = get_string('up');
|
|
$strdown = get_string('down');
|
|
$strsettings = get_string('settings');
|
|
$strenable = get_string('enable');
|
|
$strdisable = get_string('disable');
|
|
$struninstall = get_string('uninstallplugin', 'core_admin');
|
|
$strusage = get_string('enrolusage', 'enrol');
|
|
$strversion = get_string('version');
|
|
|
|
$pluginmanager = plugin_manager::instance();
|
|
|
|
$enrols_available = enrol_get_plugins(false);
|
|
$active_enrols = enrol_get_plugins(true);
|
|
|
|
$allenrols = array();
|
|
foreach ($active_enrols as $key=>$enrol) {
|
|
$allenrols[$key] = true;
|
|
}
|
|
foreach ($enrols_available as $key=>$enrol) {
|
|
$allenrols[$key] = true;
|
|
}
|
|
// Now find all borked plugins and at least allow then to uninstall.
|
|
$condidates = $DB->get_fieldset_sql("SELECT DISTINCT enrol FROM {enrol}");
|
|
foreach ($condidates as $candidate) {
|
|
if (empty($allenrols[$candidate])) {
|
|
$allenrols[$candidate] = true;
|
|
}
|
|
}
|
|
|
|
$return = $OUTPUT->heading(get_string('actenrolshhdr', 'enrol'), 3, 'main', true);
|
|
$return .= $OUTPUT->box_start('generalbox enrolsui');
|
|
|
|
$table = new html_table();
|
|
$table->head = array(get_string('name'), $strusage, $strversion, $strenable, $strup.'/'.$strdown, $strsettings, $struninstall);
|
|
$table->colclasses = array('leftalign', 'centeralign', 'centeralign', 'centeralign', 'centeralign', 'centeralign', 'centeralign');
|
|
$table->id = 'courseenrolmentplugins';
|
|
$table->attributes['class'] = 'admintable generaltable';
|
|
$table->data = array();
|
|
|
|
// Iterate through enrol plugins and add to the display table.
|
|
$updowncount = 1;
|
|
$enrolcount = count($active_enrols);
|
|
$url = new moodle_url('/admin/enrol.php', array('sesskey'=>sesskey()));
|
|
$printed = array();
|
|
foreach($allenrols as $enrol => $unused) {
|
|
$plugininfo = $pluginmanager->get_plugin_info('enrol_'.$enrol);
|
|
$version = get_config('enrol_'.$enrol, 'version');
|
|
if ($version === false) {
|
|
$version = '';
|
|
}
|
|
|
|
if (get_string_manager()->string_exists('pluginname', 'enrol_'.$enrol)) {
|
|
$name = get_string('pluginname', 'enrol_'.$enrol);
|
|
} else {
|
|
$name = $enrol;
|
|
}
|
|
// Usage.
|
|
$ci = $DB->count_records('enrol', array('enrol'=>$enrol));
|
|
$cp = $DB->count_records_select('user_enrolments', "enrolid IN (SELECT id FROM {enrol} WHERE enrol = ?)", array($enrol));
|
|
$usage = "$ci / $cp";
|
|
|
|
// Hide/show links.
|
|
if (isset($active_enrols[$enrol])) {
|
|
$aurl = new moodle_url($url, array('action'=>'disable', 'enrol'=>$enrol));
|
|
$hideshow = "<a href=\"$aurl\">";
|
|
$hideshow .= "<img src=\"" . $OUTPUT->pix_url('t/hide') . "\" class=\"iconsmall\" alt=\"$strdisable\" /></a>";
|
|
$enabled = true;
|
|
$displayname = "<span>$name</span>";
|
|
} else if (isset($enrols_available[$enrol])) {
|
|
$aurl = new moodle_url($url, array('action'=>'enable', 'enrol'=>$enrol));
|
|
$hideshow = "<a href=\"$aurl\">";
|
|
$hideshow .= "<img src=\"" . $OUTPUT->pix_url('t/show') . "\" class=\"iconsmall\" alt=\"$strenable\" /></a>";
|
|
$enabled = false;
|
|
$displayname = "<span class=\"dimmed_text\">$name</span>";
|
|
} else {
|
|
$hideshow = '';
|
|
$enabled = false;
|
|
$displayname = '<span class="notifyproblem">'.$name.'</span>';
|
|
}
|
|
if ($PAGE->theme->resolve_image_location('icon', 'enrol_' . $name, false)) {
|
|
$icon = $OUTPUT->pix_icon('icon', '', 'enrol_' . $name, array('class' => 'icon pluginicon'));
|
|
} else {
|
|
$icon = $OUTPUT->pix_icon('spacer', '', 'moodle', array('class' => 'icon pluginicon noicon'));
|
|
}
|
|
|
|
// Up/down link (only if enrol is enabled).
|
|
$updown = '';
|
|
if ($enabled) {
|
|
if ($updowncount > 1) {
|
|
$aurl = new moodle_url($url, array('action'=>'up', 'enrol'=>$enrol));
|
|
$updown .= "<a href=\"$aurl\">";
|
|
$updown .= "<img src=\"" . $OUTPUT->pix_url('t/up') . "\" alt=\"$strup\" class=\"iconsmall\" /></a> ";
|
|
} else {
|
|
$updown .= "<img src=\"" . $OUTPUT->pix_url('spacer') . "\" class=\"iconsmall\" alt=\"\" /> ";
|
|
}
|
|
if ($updowncount < $enrolcount) {
|
|
$aurl = new moodle_url($url, array('action'=>'down', 'enrol'=>$enrol));
|
|
$updown .= "<a href=\"$aurl\">";
|
|
$updown .= "<img src=\"" . $OUTPUT->pix_url('t/down') . "\" alt=\"$strdown\" class=\"iconsmall\" /></a>";
|
|
} else {
|
|
$updown .= "<img src=\"" . $OUTPUT->pix_url('spacer') . "\" class=\"iconsmall\" alt=\"\" />";
|
|
}
|
|
++$updowncount;
|
|
}
|
|
|
|
// Add settings link.
|
|
if (!$version) {
|
|
$settings = '';
|
|
} else if ($surl = $plugininfo->get_settings_url()) {
|
|
$settings = html_writer::link($surl, $strsettings);
|
|
} else {
|
|
$settings = '';
|
|
}
|
|
|
|
// Add uninstall info.
|
|
$uninstall = '';
|
|
if ($uninstallurl = plugin_manager::instance()->get_uninstall_url('enrol_'.$enrol)) {
|
|
$uninstall = html_writer::link($uninstallurl, $struninstall);
|
|
}
|
|
|
|
// Add a row to the table.
|
|
$table->data[] = array($icon.$displayname, $usage, $version, $hideshow, $updown, $settings, $uninstall);
|
|
|
|
$printed[$enrol] = true;
|
|
}
|
|
|
|
$return .= html_writer::table($table);
|
|
$return .= get_string('configenrolplugins', 'enrol').'<br />'.get_string('tablenosave', 'admin');
|
|
$return .= $OUTPUT->box_end();
|
|
return highlight($query, $return);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Blocks manage page
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_page_manageblocks extends admin_externalpage {
|
|
/**
|
|
* Calls parent::__construct with specific arguments
|
|
*/
|
|
public function __construct() {
|
|
global $CFG;
|
|
parent::__construct('manageblocks', get_string('blocksettings', 'admin'), "$CFG->wwwroot/$CFG->admin/blocks.php");
|
|
}
|
|
|
|
/**
|
|
* Search for a specific block
|
|
*
|
|
* @param string $query The string to search for
|
|
* @return array
|
|
*/
|
|
public function search($query) {
|
|
global $CFG, $DB;
|
|
if ($result = parent::search($query)) {
|
|
return $result;
|
|
}
|
|
|
|
$found = false;
|
|
if ($blocks = $DB->get_records('block')) {
|
|
foreach ($blocks as $block) {
|
|
if (!file_exists("$CFG->dirroot/blocks/$block->name/")) {
|
|
continue;
|
|
}
|
|
if (strpos($block->name, $query) !== false) {
|
|
$found = true;
|
|
break;
|
|
}
|
|
$strblockname = get_string('pluginname', 'block_'.$block->name);
|
|
if (strpos(textlib::strtolower($strblockname), $query) !== false) {
|
|
$found = true;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
if ($found) {
|
|
$result = new stdClass();
|
|
$result->page = $this;
|
|
$result->settings = array();
|
|
return array($this->name => $result);
|
|
} else {
|
|
return array();
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Message outputs configuration
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_page_managemessageoutputs extends admin_externalpage {
|
|
/**
|
|
* Calls parent::__construct with specific arguments
|
|
*/
|
|
public function __construct() {
|
|
global $CFG;
|
|
parent::__construct('managemessageoutputs', get_string('managemessageoutputs', 'message'), new moodle_url('/admin/message.php'));
|
|
}
|
|
|
|
/**
|
|
* Search for a specific message processor
|
|
*
|
|
* @param string $query The string to search for
|
|
* @return array
|
|
*/
|
|
public function search($query) {
|
|
global $CFG, $DB;
|
|
if ($result = parent::search($query)) {
|
|
return $result;
|
|
}
|
|
|
|
$found = false;
|
|
if ($processors = get_message_processors()) {
|
|
foreach ($processors as $processor) {
|
|
if (!$processor->available) {
|
|
continue;
|
|
}
|
|
if (strpos($processor->name, $query) !== false) {
|
|
$found = true;
|
|
break;
|
|
}
|
|
$strprocessorname = get_string('pluginname', 'message_'.$processor->name);
|
|
if (strpos(textlib::strtolower($strprocessorname), $query) !== false) {
|
|
$found = true;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
if ($found) {
|
|
$result = new stdClass();
|
|
$result->page = $this;
|
|
$result->settings = array();
|
|
return array($this->name => $result);
|
|
} else {
|
|
return array();
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Default message outputs configuration
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_page_defaultmessageoutputs extends admin_page_managemessageoutputs {
|
|
/**
|
|
* Calls parent::__construct with specific arguments
|
|
*/
|
|
public function __construct() {
|
|
global $CFG;
|
|
admin_externalpage::__construct('defaultmessageoutputs', get_string('defaultmessageoutputs', 'message'), new moodle_url('/message/defaultoutputs.php'));
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Manage question behaviours page
|
|
*
|
|
* @copyright 2011 The Open University
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_page_manageqbehaviours extends admin_externalpage {
|
|
/**
|
|
* Constructor
|
|
*/
|
|
public function __construct() {
|
|
global $CFG;
|
|
parent::__construct('manageqbehaviours', get_string('manageqbehaviours', 'admin'),
|
|
new moodle_url('/admin/qbehaviours.php'));
|
|
}
|
|
|
|
/**
|
|
* Search question behaviours for the specified string
|
|
*
|
|
* @param string $query The string to search for in question behaviours
|
|
* @return array
|
|
*/
|
|
public function search($query) {
|
|
global $CFG;
|
|
if ($result = parent::search($query)) {
|
|
return $result;
|
|
}
|
|
|
|
$found = false;
|
|
require_once($CFG->dirroot . '/question/engine/lib.php');
|
|
foreach (get_plugin_list('qbehaviour') as $behaviour => $notused) {
|
|
if (strpos(textlib::strtolower(question_engine::get_behaviour_name($behaviour)),
|
|
$query) !== false) {
|
|
$found = true;
|
|
break;
|
|
}
|
|
}
|
|
if ($found) {
|
|
$result = new stdClass();
|
|
$result->page = $this;
|
|
$result->settings = array();
|
|
return array($this->name => $result);
|
|
} else {
|
|
return array();
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Question type manage page
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_page_manageqtypes extends admin_externalpage {
|
|
/**
|
|
* Calls parent::__construct with specific arguments
|
|
*/
|
|
public function __construct() {
|
|
global $CFG;
|
|
parent::__construct('manageqtypes', get_string('manageqtypes', 'admin'),
|
|
new moodle_url('/admin/qtypes.php'));
|
|
}
|
|
|
|
/**
|
|
* Search question types for the specified string
|
|
*
|
|
* @param string $query The string to search for in question types
|
|
* @return array
|
|
*/
|
|
public function search($query) {
|
|
global $CFG;
|
|
if ($result = parent::search($query)) {
|
|
return $result;
|
|
}
|
|
|
|
$found = false;
|
|
require_once($CFG->dirroot . '/question/engine/bank.php');
|
|
foreach (question_bank::get_all_qtypes() as $qtype) {
|
|
if (strpos(textlib::strtolower($qtype->local_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 admin_page_manageportfolios extends admin_externalpage {
|
|
/**
|
|
* Calls parent::__construct with specific arguments
|
|
*/
|
|
public function __construct() {
|
|
global $CFG;
|
|
parent::__construct('manageportfolios', get_string('manageportfolios', 'portfolio'),
|
|
"$CFG->wwwroot/$CFG->admin/portfolio.php");
|
|
}
|
|
|
|
/**
|
|
* Searches page for the specified string.
|
|
* @param string $query The string to search for
|
|
* @return bool True if it is found on this page
|
|
*/
|
|
public function search($query) {
|
|
global $CFG;
|
|
if ($result = parent::search($query)) {
|
|
return $result;
|
|
}
|
|
|
|
$found = false;
|
|
$portfolios = get_plugin_list('portfolio');
|
|
foreach ($portfolios as $p => $dir) {
|
|
if (strpos($p, $query) !== false) {
|
|
$found = true;
|
|
break;
|
|
}
|
|
}
|
|
if (!$found) {
|
|
foreach (portfolio_instances(false, false) as $instance) {
|
|
$title = $instance->get('name');
|
|
if (strpos(textlib::strtolower($title), $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 admin_page_managerepositories extends admin_externalpage {
|
|
/**
|
|
* Calls parent::__construct with specific arguments
|
|
*/
|
|
public function __construct() {
|
|
global $CFG;
|
|
parent::__construct('managerepositories', get_string('manage',
|
|
'repository'), "$CFG->wwwroot/$CFG->admin/repository.php");
|
|
}
|
|
|
|
/**
|
|
* Searches page for the specified string.
|
|
* @param string $query The string to search for
|
|
* @return bool True if it is found on this page
|
|
*/
|
|
public function search($query) {
|
|
global $CFG;
|
|
if ($result = parent::search($query)) {
|
|
return $result;
|
|
}
|
|
|
|
$found = false;
|
|
$repositories= get_plugin_list('repository');
|
|
foreach ($repositories as $p => $dir) {
|
|
if (strpos($p, $query) !== false) {
|
|
$found = true;
|
|
break;
|
|
}
|
|
}
|
|
if (!$found) {
|
|
foreach (repository::get_types() as $instance) {
|
|
$title = $instance->get_typename();
|
|
if (strpos(textlib::strtolower($title), $query) !== false) {
|
|
$found = true;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
if ($found) {
|
|
$result = new stdClass();
|
|
$result->page = $this;
|
|
$result->settings = array();
|
|
return array($this->name => $result);
|
|
} else {
|
|
return array();
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Special class for authentication administration.
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_manageauths extends admin_setting {
|
|
/**
|
|
* Calls parent::__construct with specific arguments
|
|
*/
|
|
public function __construct() {
|
|
$this->nosave = true;
|
|
parent::__construct('authsui', get_string('authsettings', 'admin'), '', '');
|
|
}
|
|
|
|
/**
|
|
* Always returns true
|
|
*
|
|
* @return true
|
|
*/
|
|
public function get_setting() {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Always returns true
|
|
*
|
|
* @return true
|
|
*/
|
|
public function get_defaultsetting() {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Always returns '' and doesn't write anything
|
|
*
|
|
* @return string Always returns ''
|
|
*/
|
|
public function write_setting($data) {
|
|
// do not write any setting
|
|
return '';
|
|
}
|
|
|
|
/**
|
|
* Search to find if Query is related to auth plugin
|
|
*
|
|
* @param string $query The string to search for
|
|
* @return bool true for related false for not
|
|
*/
|
|
public function is_related($query) {
|
|
if (parent::is_related($query)) {
|
|
return true;
|
|
}
|
|
|
|
$authsavailable = get_plugin_list('auth');
|
|
foreach ($authsavailable as $auth => $dir) {
|
|
if (strpos($auth, $query) !== false) {
|
|
return true;
|
|
}
|
|
$authplugin = get_auth_plugin($auth);
|
|
$authtitle = $authplugin->get_title();
|
|
if (strpos(textlib::strtolower($authtitle), $query) !== false) {
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Return XHTML to display control
|
|
*
|
|
* @param mixed $data Unused
|
|
* @param string $query
|
|
* @return string highlight
|
|
*/
|
|
public function output_html($data, $query='') {
|
|
global $CFG, $OUTPUT;
|
|
|
|
|
|
// display strings
|
|
$txt = get_strings(array('authenticationplugins', 'users', 'administration',
|
|
'settings', 'edit', 'name', 'enable', 'disable',
|
|
'up', 'down', 'none'));
|
|
$txt->updown = "$txt->up/$txt->down";
|
|
|
|
$authsavailable = get_plugin_list('auth');
|
|
get_enabled_auth_plugins(true); // fix the list of enabled auths
|
|
if (empty($CFG->auth)) {
|
|
$authsenabled = array();
|
|
} else {
|
|
$authsenabled = explode(',', $CFG->auth);
|
|
}
|
|
|
|
// construct the display array, with enabled auth plugins at the top, in order
|
|
$displayauths = array();
|
|
$registrationauths = array();
|
|
$registrationauths[''] = $txt->disable;
|
|
foreach ($authsenabled as $auth) {
|
|
$authplugin = get_auth_plugin($auth);
|
|
/// Get the auth title (from core or own auth lang files)
|
|
$authtitle = $authplugin->get_title();
|
|
/// Apply titles
|
|
$displayauths[$auth] = $authtitle;
|
|
if ($authplugin->can_signup()) {
|
|
$registrationauths[$auth] = $authtitle;
|
|
}
|
|
}
|
|
|
|
foreach ($authsavailable as $auth => $dir) {
|
|
if (array_key_exists($auth, $displayauths)) {
|
|
continue; //already in the list
|
|
}
|
|
$authplugin = get_auth_plugin($auth);
|
|
/// Get the auth title (from core or own auth lang files)
|
|
$authtitle = $authplugin->get_title();
|
|
/// Apply titles
|
|
$displayauths[$auth] = $authtitle;
|
|
if ($authplugin->can_signup()) {
|
|
$registrationauths[$auth] = $authtitle;
|
|
}
|
|
}
|
|
|
|
$return = $OUTPUT->heading(get_string('actauthhdr', 'auth'), 3, 'main');
|
|
$return .= $OUTPUT->box_start('generalbox authsui');
|
|
|
|
$table = new html_table();
|
|
$table->head = array($txt->name, $txt->enable, $txt->updown, $txt->settings);
|
|
$table->colclasses = array('leftalign', 'centeralign', 'centeralign', 'centeralign');
|
|
$table->data = array();
|
|
$table->attributes['class'] = 'admintable generaltable';
|
|
$table->id = 'manageauthtable';
|
|
|
|
//add always enabled plugins first
|
|
$displayname = "<span>".$displayauths['manual']."</span>";
|
|
$settings = "<a href=\"auth_config.php?auth=manual\">{$txt->settings}</a>";
|
|
//$settings = "<a href=\"settings.php?section=authsettingmanual\">{$txt->settings}</a>";
|
|
$table->data[] = array($displayname, '', '', $settings);
|
|
$displayname = "<span>".$displayauths['nologin']."</span>";
|
|
$settings = "<a href=\"auth_config.php?auth=nologin\">{$txt->settings}</a>";
|
|
$table->data[] = array($displayname, '', '', $settings);
|
|
|
|
|
|
// iterate through auth plugins and add to the display table
|
|
$updowncount = 1;
|
|
$authcount = count($authsenabled);
|
|
$url = "auth.php?sesskey=" . sesskey();
|
|
foreach ($displayauths as $auth => $name) {
|
|
if ($auth == 'manual' or $auth == 'nologin') {
|
|
continue;
|
|
}
|
|
// hide/show link
|
|
if (in_array($auth, $authsenabled)) {
|
|
$hideshow = "<a href=\"$url&action=disable&auth=$auth\">";
|
|
$hideshow .= "<img src=\"" . $OUTPUT->pix_url('t/hide') . "\" class=\"iconsmall\" alt=\"disable\" /></a>";
|
|
// $hideshow = "<a href=\"$url&action=disable&auth=$auth\"><input type=\"checkbox\" checked /></a>";
|
|
$enabled = true;
|
|
$displayname = "<span>$name</span>";
|
|
}
|
|
else {
|
|
$hideshow = "<a href=\"$url&action=enable&auth=$auth\">";
|
|
$hideshow .= "<img src=\"" . $OUTPUT->pix_url('t/show') . "\" class=\"iconsmall\" alt=\"enable\" /></a>";
|
|
// $hideshow = "<a href=\"$url&action=enable&auth=$auth\"><input type=\"checkbox\" /></a>";
|
|
$enabled = false;
|
|
$displayname = "<span class=\"dimmed_text\">$name</span>";
|
|
}
|
|
|
|
// up/down link (only if auth is enabled)
|
|
$updown = '';
|
|
if ($enabled) {
|
|
if ($updowncount > 1) {
|
|
$updown .= "<a href=\"$url&action=up&auth=$auth\">";
|
|
$updown .= "<img src=\"" . $OUTPUT->pix_url('t/up') . "\" alt=\"up\" class=\"iconsmall\" /></a> ";
|
|
}
|
|
else {
|
|
$updown .= "<img src=\"" . $OUTPUT->pix_url('spacer') . "\" class=\"iconsmall\" alt=\"\" /> ";
|
|
}
|
|
if ($updowncount < $authcount) {
|
|
$updown .= "<a href=\"$url&action=down&auth=$auth\">";
|
|
$updown .= "<img src=\"" . $OUTPUT->pix_url('t/down') . "\" alt=\"down\" class=\"iconsmall\" /></a>";
|
|
}
|
|
else {
|
|
$updown .= "<img src=\"" . $OUTPUT->pix_url('spacer') . "\" class=\"iconsmall\" alt=\"\" />";
|
|
}
|
|
++ $updowncount;
|
|
}
|
|
|
|
// settings link
|
|
if (file_exists($CFG->dirroot.'/auth/'.$auth.'/settings.php')) {
|
|
$settings = "<a href=\"settings.php?section=authsetting$auth\">{$txt->settings}</a>";
|
|
} else {
|
|
$settings = "<a href=\"auth_config.php?auth=$auth\">{$txt->settings}</a>";
|
|
}
|
|
|
|
// add a row to the table
|
|
$table->data[] =array($displayname, $hideshow, $updown, $settings);
|
|
}
|
|
$return .= html_writer::table($table);
|
|
$return .= get_string('configauthenticationplugins', 'admin').'<br />'.get_string('tablenosave', 'filters');
|
|
$return .= $OUTPUT->box_end();
|
|
return highlight($query, $return);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Special class for authentication administration.
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_manageeditors extends admin_setting {
|
|
/**
|
|
* Calls parent::__construct with specific arguments
|
|
*/
|
|
public function __construct() {
|
|
$this->nosave = true;
|
|
parent::__construct('editorsui', get_string('editorsettings', 'editor'), '', '');
|
|
}
|
|
|
|
/**
|
|
* Always returns true, does nothing
|
|
*
|
|
* @return true
|
|
*/
|
|
public function get_setting() {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Always returns true, does nothing
|
|
*
|
|
* @return true
|
|
*/
|
|
public function get_defaultsetting() {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Always returns '', does not write anything
|
|
*
|
|
* @return string Always returns ''
|
|
*/
|
|
public function write_setting($data) {
|
|
// do not write any setting
|
|
return '';
|
|
}
|
|
|
|
/**
|
|
* Checks if $query is one of the available editors
|
|
*
|
|
* @param string $query The string to search for
|
|
* @return bool Returns true if found, false if not
|
|
*/
|
|
public function is_related($query) {
|
|
if (parent::is_related($query)) {
|
|
return true;
|
|
}
|
|
|
|
$editors_available = editors_get_available();
|
|
foreach ($editors_available as $editor=>$editorstr) {
|
|
if (strpos($editor, $query) !== false) {
|
|
return true;
|
|
}
|
|
if (strpos(textlib::strtolower($editorstr), $query) !== false) {
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Builds the XHTML to display the control
|
|
*
|
|
* @param string $data Unused
|
|
* @param string $query
|
|
* @return string
|
|
*/
|
|
public function output_html($data, $query='') {
|
|
global $CFG, $OUTPUT;
|
|
|
|
// display strings
|
|
$txt = get_strings(array('administration', 'settings', 'edit', 'name', 'enable', 'disable',
|
|
'up', 'down', 'none'));
|
|
$struninstall = get_string('uninstallplugin', 'core_admin');
|
|
|
|
$txt->updown = "$txt->up/$txt->down";
|
|
|
|
$editors_available = editors_get_available();
|
|
$active_editors = explode(',', $CFG->texteditors);
|
|
|
|
$active_editors = array_reverse($active_editors);
|
|
foreach ($active_editors as $key=>$editor) {
|
|
if (empty($editors_available[$editor])) {
|
|
unset($active_editors[$key]);
|
|
} else {
|
|
$name = $editors_available[$editor];
|
|
unset($editors_available[$editor]);
|
|
$editors_available[$editor] = $name;
|
|
}
|
|
}
|
|
if (empty($active_editors)) {
|
|
//$active_editors = array('textarea');
|
|
}
|
|
$editors_available = array_reverse($editors_available, true);
|
|
$return = $OUTPUT->heading(get_string('acteditorshhdr', 'editor'), 3, 'main', true);
|
|
$return .= $OUTPUT->box_start('generalbox editorsui');
|
|
|
|
$table = new html_table();
|
|
$table->head = array($txt->name, $txt->enable, $txt->updown, $txt->settings, $struninstall);
|
|
$table->colclasses = array('leftalign', 'centeralign', 'centeralign', 'centeralign');
|
|
$table->id = 'editormanagement';
|
|
$table->attributes['class'] = 'admintable generaltable';
|
|
$table->data = array();
|
|
|
|
// iterate through auth plugins and add to the display table
|
|
$updowncount = 1;
|
|
$editorcount = count($active_editors);
|
|
$url = "editors.php?sesskey=" . sesskey();
|
|
foreach ($editors_available as $editor => $name) {
|
|
// hide/show link
|
|
if (in_array($editor, $active_editors)) {
|
|
$hideshow = "<a href=\"$url&action=disable&editor=$editor\">";
|
|
$hideshow .= "<img src=\"" . $OUTPUT->pix_url('t/hide') . "\" class=\"iconsmall\" alt=\"disable\" /></a>";
|
|
// $hideshow = "<a href=\"$url&action=disable&editor=$editor\"><input type=\"checkbox\" checked /></a>";
|
|
$enabled = true;
|
|
$displayname = "<span>$name</span>";
|
|
}
|
|
else {
|
|
$hideshow = "<a href=\"$url&action=enable&editor=$editor\">";
|
|
$hideshow .= "<img src=\"" . $OUTPUT->pix_url('t/show') . "\" class=\"iconsmall\" alt=\"enable\" /></a>";
|
|
// $hideshow = "<a href=\"$url&action=enable&editor=$editor\"><input type=\"checkbox\" /></a>";
|
|
$enabled = false;
|
|
$displayname = "<span class=\"dimmed_text\">$name</span>";
|
|
}
|
|
|
|
// up/down link (only if auth is enabled)
|
|
$updown = '';
|
|
if ($enabled) {
|
|
if ($updowncount > 1) {
|
|
$updown .= "<a href=\"$url&action=up&editor=$editor\">";
|
|
$updown .= "<img src=\"" . $OUTPUT->pix_url('t/up') . "\" alt=\"up\" class=\"iconsmall\" /></a> ";
|
|
}
|
|
else {
|
|
$updown .= "<img src=\"" . $OUTPUT->pix_url('spacer') . "\" class=\"iconsmall\" alt=\"\" /> ";
|
|
}
|
|
if ($updowncount < $editorcount) {
|
|
$updown .= "<a href=\"$url&action=down&editor=$editor\">";
|
|
$updown .= "<img src=\"" . $OUTPUT->pix_url('t/down') . "\" alt=\"down\" class=\"iconsmall\" /></a>";
|
|
}
|
|
else {
|
|
$updown .= "<img src=\"" . $OUTPUT->pix_url('spacer') . "\" class=\"iconsmall\" alt=\"\" />";
|
|
}
|
|
++ $updowncount;
|
|
}
|
|
|
|
// settings link
|
|
if (file_exists($CFG->dirroot.'/lib/editor/'.$editor.'/settings.php')) {
|
|
$eurl = new moodle_url('/admin/settings.php', array('section'=>'editorsettings'.$editor));
|
|
$settings = "<a href='$eurl'>{$txt->settings}</a>";
|
|
} else {
|
|
$settings = '';
|
|
}
|
|
|
|
$uninstall = '';
|
|
if ($uninstallurl = plugin_manager::instance()->get_uninstall_url('editor_'.$editor)) {
|
|
$uninstall = html_writer::link($uninstallurl, $struninstall);
|
|
}
|
|
|
|
// add a row to the table
|
|
$table->data[] =array($displayname, $hideshow, $updown, $settings, $uninstall);
|
|
}
|
|
$return .= html_writer::table($table);
|
|
$return .= get_string('configeditorplugins', 'editor').'<br />'.get_string('tablenosave', 'admin');
|
|
$return .= $OUTPUT->box_end();
|
|
return highlight($query, $return);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Special class for license administration.
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_managelicenses extends admin_setting {
|
|
/**
|
|
* Calls parent::__construct with specific arguments
|
|
*/
|
|
public function __construct() {
|
|
$this->nosave = true;
|
|
parent::__construct('licensesui', get_string('licensesettings', 'admin'), '', '');
|
|
}
|
|
|
|
/**
|
|
* Always returns true, does nothing
|
|
*
|
|
* @return true
|
|
*/
|
|
public function get_setting() {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Always returns true, does nothing
|
|
*
|
|
* @return true
|
|
*/
|
|
public function get_defaultsetting() {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Always returns '', does not write anything
|
|
*
|
|
* @return string Always returns ''
|
|
*/
|
|
public function write_setting($data) {
|
|
// do not write any setting
|
|
return '';
|
|
}
|
|
|
|
/**
|
|
* Builds the XHTML to display the control
|
|
*
|
|
* @param string $data Unused
|
|
* @param string $query
|
|
* @return string
|
|
*/
|
|
public function output_html($data, $query='') {
|
|
global $CFG, $OUTPUT;
|
|
require_once($CFG->libdir . '/licenselib.php');
|
|
$url = "licenses.php?sesskey=" . sesskey();
|
|
|
|
// display strings
|
|
$txt = get_strings(array('administration', 'settings', 'name', 'enable', 'disable', 'none'));
|
|
$licenses = license_manager::get_licenses();
|
|
|
|
$return = $OUTPUT->heading(get_string('availablelicenses', 'admin'), 3, 'main', true);
|
|
|
|
$return .= $OUTPUT->box_start('generalbox editorsui');
|
|
|
|
$table = new html_table();
|
|
$table->head = array($txt->name, $txt->enable);
|
|
$table->colclasses = array('leftalign', 'centeralign');
|
|
$table->id = 'availablelicenses';
|
|
$table->attributes['class'] = 'admintable generaltable';
|
|
$table->data = array();
|
|
|
|
foreach ($licenses as $value) {
|
|
$displayname = html_writer::link($value->source, get_string($value->shortname, 'license'), array('target'=>'_blank'));
|
|
|
|
if ($value->enabled == 1) {
|
|
$hideshow = html_writer::link($url.'&action=disable&license='.$value->shortname,
|
|
html_writer::tag('img', '', array('src'=>$OUTPUT->pix_url('t/hide'), 'class'=>'iconsmall', 'alt'=>'disable')));
|
|
} else {
|
|
$hideshow = html_writer::link($url.'&action=enable&license='.$value->shortname,
|
|
html_writer::tag('img', '', array('src'=>$OUTPUT->pix_url('t/show'), 'class'=>'iconsmall', 'alt'=>'enable')));
|
|
}
|
|
|
|
if ($value->shortname == $CFG->sitedefaultlicense) {
|
|
$displayname .= ' '.html_writer::tag('img', '', array('src'=>$OUTPUT->pix_url('t/locked'), 'class'=>'iconsmall', 'alt'=>get_string('default'), 'title'=>get_string('default')));
|
|
$hideshow = '';
|
|
}
|
|
|
|
$enabled = true;
|
|
|
|
$table->data[] =array($displayname, $hideshow);
|
|
}
|
|
$return .= html_writer::table($table);
|
|
$return .= $OUTPUT->box_end();
|
|
return highlight($query, $return);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Course formats manager. Allows to enable/disable formats and jump to settings
|
|
*/
|
|
class admin_setting_manageformats extends admin_setting {
|
|
|
|
/**
|
|
* Calls parent::__construct with specific arguments
|
|
*/
|
|
public function __construct() {
|
|
$this->nosave = true;
|
|
parent::__construct('formatsui', new lang_string('manageformats', 'core_admin'), '', '');
|
|
}
|
|
|
|
/**
|
|
* Always returns true
|
|
*
|
|
* @return true
|
|
*/
|
|
public function get_setting() {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Always returns true
|
|
*
|
|
* @return true
|
|
*/
|
|
public function get_defaultsetting() {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Always returns '' and doesn't write anything
|
|
*
|
|
* @param mixed $data string or array, must not be NULL
|
|
* @return string Always returns ''
|
|
*/
|
|
public function write_setting($data) {
|
|
// do not write any setting
|
|
return '';
|
|
}
|
|
|
|
/**
|
|
* Search to find if Query is related to format plugin
|
|
*
|
|
* @param string $query The string to search for
|
|
* @return bool true for related false for not
|
|
*/
|
|
public function is_related($query) {
|
|
if (parent::is_related($query)) {
|
|
return true;
|
|
}
|
|
$formats = plugin_manager::instance()->get_plugins_of_type('format');
|
|
foreach ($formats as $format) {
|
|
if (strpos($format->component, $query) !== false ||
|
|
strpos(textlib::strtolower($format->displayname), $query) !== false) {
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Return XHTML to display control
|
|
*
|
|
* @param mixed $data Unused
|
|
* @param string $query
|
|
* @return string highlight
|
|
*/
|
|
public function output_html($data, $query='') {
|
|
global $CFG, $OUTPUT;
|
|
$return = '';
|
|
$return = $OUTPUT->heading(new lang_string('courseformats'), 3, 'main');
|
|
$return .= $OUTPUT->box_start('generalbox formatsui');
|
|
|
|
$formats = plugin_manager::instance()->get_plugins_of_type('format');
|
|
|
|
// display strings
|
|
$txt = get_strings(array('settings', 'name', 'enable', 'disable', 'up', 'down', 'default'));
|
|
$txt->uninstall = get_string('uninstallplugin', 'core_admin');
|
|
$txt->updown = "$txt->up/$txt->down";
|
|
|
|
$table = new html_table();
|
|
$table->head = array($txt->name, $txt->enable, $txt->updown, $txt->uninstall, $txt->settings);
|
|
$table->align = array('left', 'center', 'center', 'center', 'center');
|
|
$table->width = '90%';
|
|
$table->attributes['class'] = 'manageformattable generaltable';
|
|
$table->data = array();
|
|
|
|
$cnt = 0;
|
|
$defaultformat = get_config('moodlecourse', 'format');
|
|
$spacer = $OUTPUT->pix_icon('spacer', '', 'moodle', array('class' => 'iconsmall'));
|
|
foreach ($formats as $format) {
|
|
$url = new moodle_url('/admin/courseformats.php',
|
|
array('sesskey' => sesskey(), 'format' => $format->name));
|
|
$isdefault = '';
|
|
if ($format->is_enabled()) {
|
|
$strformatname = html_writer::tag('span', $format->displayname);
|
|
if ($defaultformat === $format->name) {
|
|
$hideshow = $txt->default;
|
|
} else {
|
|
$hideshow = html_writer::link($url->out(false, array('action' => 'disable')),
|
|
$OUTPUT->pix_icon('t/hide', $txt->disable, 'moodle', array('class' => 'iconsmall')));
|
|
}
|
|
} else {
|
|
$strformatname = html_writer::tag('span', $format->displayname, array('class' => 'dimmed_text'));
|
|
$hideshow = html_writer::link($url->out(false, array('action' => 'enable')),
|
|
$OUTPUT->pix_icon('t/show', $txt->enable, 'moodle', array('class' => 'iconsmall')));
|
|
}
|
|
$updown = '';
|
|
if ($cnt) {
|
|
$updown .= html_writer::link($url->out(false, array('action' => 'up')),
|
|
$OUTPUT->pix_icon('t/up', $txt->up, 'moodle', array('class' => 'iconsmall'))). '';
|
|
} else {
|
|
$updown .= $spacer;
|
|
}
|
|
if ($cnt < count($formats) - 1) {
|
|
$updown .= ' '.html_writer::link($url->out(false, array('action' => 'down')),
|
|
$OUTPUT->pix_icon('t/down', $txt->down, 'moodle', array('class' => 'iconsmall')));
|
|
} else {
|
|
$updown .= $spacer;
|
|
}
|
|
$cnt++;
|
|
$settings = '';
|
|
if ($format->get_settings_url()) {
|
|
$settings = html_writer::link($format->get_settings_url(), $txt->settings);
|
|
}
|
|
$uninstall = '';
|
|
if ($uninstallurl = plugin_manager::instance()->get_uninstall_url('format_'.$format->name)) {
|
|
$uninstall = html_writer::link($uninstallurl, $txt->uninstall);
|
|
}
|
|
$table->data[] =array($strformatname, $hideshow, $updown, $uninstall, $settings);
|
|
}
|
|
$return .= html_writer::table($table);
|
|
$link = html_writer::link(new moodle_url('/admin/settings.php', array('section' => 'coursesettings')), new lang_string('coursesettings'));
|
|
$return .= html_writer::tag('p', get_string('manageformatsgotosettings', 'admin', $link));
|
|
$return .= $OUTPUT->box_end();
|
|
return highlight($query, $return);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Special class for filter administration.
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_page_managefilters extends admin_externalpage {
|
|
/**
|
|
* Calls parent::__construct with specific arguments
|
|
*/
|
|
public function __construct() {
|
|
global $CFG;
|
|
parent::__construct('managefilters', get_string('filtersettings', 'admin'), "$CFG->wwwroot/$CFG->admin/filters.php");
|
|
}
|
|
|
|
/**
|
|
* Searches all installed filters for specified filter
|
|
*
|
|
* @param string $query The filter(string) to search for
|
|
* @param string $query
|
|
*/
|
|
public function search($query) {
|
|
global $CFG;
|
|
if ($result = parent::search($query)) {
|
|
return $result;
|
|
}
|
|
|
|
$found = false;
|
|
$filternames = filter_get_all_installed();
|
|
foreach ($filternames as $path => $strfiltername) {
|
|
if (strpos(textlib::strtolower($strfiltername), $query) !== false) {
|
|
$found = true;
|
|
break;
|
|
}
|
|
if (strpos($path, $query) !== false) {
|
|
$found = true;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if ($found) {
|
|
$result = new stdClass;
|
|
$result->page = $this;
|
|
$result->settings = array();
|
|
return array($this->name => $result);
|
|
} else {
|
|
return array();
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Initialise admin page - this function does require login and permission
|
|
* checks specified in page definition.
|
|
*
|
|
* This function must be called on each admin page before other code.
|
|
*
|
|
* @global moodle_page $PAGE
|
|
*
|
|
* @param string $section name of page
|
|
* @param string $extrabutton extra HTML that is added after the blocks editing on/off button.
|
|
* @param array $extraurlparams an array paramname => paramvalue, or parameters that need to be
|
|
* added to the turn blocks editing on/off form, so this page reloads correctly.
|
|
* @param string $actualurl if the actual page being viewed is not the normal one for this
|
|
* page (e.g. admin/roles/allow.php, instead of admin/roles/manage.php, you can pass the alternate URL here.
|
|
* @param array $options Additional options that can be specified for page setup.
|
|
* pagelayout - This option can be used to set a specific pagelyaout, admin is default.
|
|
*/
|
|
function admin_externalpage_setup($section, $extrabutton = '', array $extraurlparams = null, $actualurl = '', array $options = array()) {
|
|
global $CFG, $PAGE, $USER, $SITE, $OUTPUT;
|
|
|
|
$PAGE->set_context(null); // hack - set context to something, by default to system context
|
|
|
|
$site = get_site();
|
|
require_login();
|
|
|
|
if (!empty($options['pagelayout'])) {
|
|
// A specific page layout has been requested.
|
|
$PAGE->set_pagelayout($options['pagelayout']);
|
|
} else if ($section === 'upgradesettings') {
|
|
$PAGE->set_pagelayout('maintenance');
|
|
} else {
|
|
$PAGE->set_pagelayout('admin');
|
|
}
|
|
|
|
$adminroot = admin_get_root(false, false); // settings not required for external pages
|
|
$extpage = $adminroot->locate($section, true);
|
|
|
|
if (empty($extpage) or !($extpage instanceof admin_externalpage)) {
|
|
// The requested section isn't in the admin tree
|
|
// It could be because the user has inadequate capapbilities or because the section doesn't exist
|
|
if (!has_capability('moodle/site:config', context_system::instance())) {
|
|
// The requested section could depend on a different capability
|
|
// but most likely the user has inadequate capabilities
|
|
print_error('accessdenied', 'admin');
|
|
} else {
|
|
print_error('sectionerror', 'admin', "$CFG->wwwroot/$CFG->admin/");
|
|
}
|
|
}
|
|
|
|
// this eliminates our need to authenticate on the actual pages
|
|
if (!$extpage->check_access()) {
|
|
print_error('accessdenied', 'admin');
|
|
die;
|
|
}
|
|
|
|
// $PAGE->set_extra_button($extrabutton); TODO
|
|
|
|
if (!$actualurl) {
|
|
$actualurl = $extpage->url;
|
|
}
|
|
|
|
$PAGE->set_url($actualurl, $extraurlparams);
|
|
if (strpos($PAGE->pagetype, 'admin-') !== 0) {
|
|
$PAGE->set_pagetype('admin-' . $PAGE->pagetype);
|
|
}
|
|
|
|
if (empty($SITE->fullname) || empty($SITE->shortname)) {
|
|
// During initial install.
|
|
$strinstallation = get_string('installation', 'install');
|
|
$strsettings = get_string('settings');
|
|
$PAGE->navbar->add($strsettings);
|
|
$PAGE->set_title($strinstallation);
|
|
$PAGE->set_heading($strinstallation);
|
|
$PAGE->set_cacheable(false);
|
|
return;
|
|
}
|
|
|
|
// Locate the current item on the navigation and make it active when found.
|
|
$path = $extpage->path;
|
|
$node = $PAGE->settingsnav;
|
|
while ($node && count($path) > 0) {
|
|
$node = $node->get(array_pop($path));
|
|
}
|
|
if ($node) {
|
|
$node->make_active();
|
|
}
|
|
|
|
// Normal case.
|
|
$adminediting = optional_param('adminedit', -1, PARAM_BOOL);
|
|
if ($PAGE->user_allowed_editing() && $adminediting != -1) {
|
|
$USER->editing = $adminediting;
|
|
}
|
|
|
|
$visiblepathtosection = array_reverse($extpage->visiblepath);
|
|
|
|
if ($PAGE->user_allowed_editing()) {
|
|
if ($PAGE->user_is_editing()) {
|
|
$caption = get_string('blockseditoff');
|
|
$url = new moodle_url($PAGE->url, array('adminedit'=>'0'));
|
|
} else {
|
|
$caption = get_string('blocksediton');
|
|
$url = new moodle_url($PAGE->url, array('adminedit'=>'1'));
|
|
}
|
|
$PAGE->set_button($OUTPUT->single_button($url, $caption, 'get'));
|
|
}
|
|
|
|
$PAGE->set_title("$SITE->shortname: " . implode(": ", $visiblepathtosection));
|
|
$PAGE->set_heading($SITE->fullname);
|
|
|
|
// prevent caching in nav block
|
|
$PAGE->navigation->clear_cache();
|
|
}
|
|
|
|
/**
|
|
* Returns the reference to admin tree root
|
|
*
|
|
* @return object admin_root object
|
|
*/
|
|
function admin_get_root($reload=false, $requirefulltree=true) {
|
|
global $CFG, $DB, $OUTPUT;
|
|
|
|
static $ADMIN = NULL;
|
|
|
|
if (is_null($ADMIN)) {
|
|
// create the admin tree!
|
|
$ADMIN = new admin_root($requirefulltree);
|
|
}
|
|
|
|
if ($reload or ($requirefulltree and !$ADMIN->fulltree)) {
|
|
$ADMIN->purge_children($requirefulltree);
|
|
}
|
|
|
|
if (!$ADMIN->loaded) {
|
|
// we process this file first to create categories first and in correct order
|
|
require($CFG->dirroot.'/'.$CFG->admin.'/settings/top.php');
|
|
|
|
// now we process all other files in admin/settings to build the admin tree
|
|
foreach (glob($CFG->dirroot.'/'.$CFG->admin.'/settings/*.php') as $file) {
|
|
if ($file == $CFG->dirroot.'/'.$CFG->admin.'/settings/top.php') {
|
|
continue;
|
|
}
|
|
if ($file == $CFG->dirroot.'/'.$CFG->admin.'/settings/plugins.php') {
|
|
// plugins are loaded last - they may insert pages anywhere
|
|
continue;
|
|
}
|
|
require($file);
|
|
}
|
|
require($CFG->dirroot.'/'.$CFG->admin.'/settings/plugins.php');
|
|
|
|
$ADMIN->loaded = true;
|
|
}
|
|
|
|
return $ADMIN;
|
|
}
|
|
|
|
/// settings utility functions
|
|
|
|
/**
|
|
* This function applies default settings.
|
|
*
|
|
* @param object $node, NULL means complete tree, null by default
|
|
* @param bool $unconditional if true overrides all values with defaults, null buy default
|
|
*/
|
|
function admin_apply_default_settings($node=NULL, $unconditional=true) {
|
|
global $CFG;
|
|
|
|
if (is_null($node)) {
|
|
$node = admin_get_root(true, true);
|
|
}
|
|
|
|
if ($node instanceof admin_category) {
|
|
$entries = array_keys($node->children);
|
|
foreach ($entries as $entry) {
|
|
admin_apply_default_settings($node->children[$entry], $unconditional);
|
|
}
|
|
|
|
} else if ($node instanceof admin_settingpage) {
|
|
foreach ($node->settings as $setting) {
|
|
if (!$unconditional and !is_null($setting->get_setting())) {
|
|
//do not override existing defaults
|
|
continue;
|
|
}
|
|
$defaultsetting = $setting->get_defaultsetting();
|
|
if (is_null($defaultsetting)) {
|
|
// no value yet - default maybe applied after admin user creation or in upgradesettings
|
|
continue;
|
|
}
|
|
$setting->write_setting($defaultsetting);
|
|
$setting->write_setting_flags(null);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Store changed settings, this function updates the errors variable in $ADMIN
|
|
*
|
|
* @param object $formdata from form
|
|
* @return int number of changed settings
|
|
*/
|
|
function admin_write_settings($formdata) {
|
|
global $CFG, $SITE, $DB;
|
|
|
|
$olddbsessions = !empty($CFG->dbsessions);
|
|
$formdata = (array)$formdata;
|
|
|
|
$data = array();
|
|
foreach ($formdata as $fullname=>$value) {
|
|
if (strpos($fullname, 's_') !== 0) {
|
|
continue; // not a config value
|
|
}
|
|
$data[$fullname] = $value;
|
|
}
|
|
|
|
$adminroot = admin_get_root();
|
|
$settings = admin_find_write_settings($adminroot, $data);
|
|
|
|
$count = 0;
|
|
foreach ($settings as $fullname=>$setting) {
|
|
/** @var $setting admin_setting */
|
|
$original = $setting->get_setting();
|
|
$error = $setting->write_setting($data[$fullname]);
|
|
if ($error !== '') {
|
|
$adminroot->errors[$fullname] = new stdClass();
|
|
$adminroot->errors[$fullname]->data = $data[$fullname];
|
|
$adminroot->errors[$fullname]->id = $setting->get_id();
|
|
$adminroot->errors[$fullname]->error = $error;
|
|
} else {
|
|
$setting->write_setting_flags($data);
|
|
}
|
|
if ($setting->post_write_settings($original)) {
|
|
$count++;
|
|
}
|
|
}
|
|
|
|
if ($olddbsessions != !empty($CFG->dbsessions)) {
|
|
require_logout();
|
|
}
|
|
|
|
// Now update $SITE - just update the fields, in case other people have a
|
|
// a reference to it (e.g. $PAGE, $COURSE).
|
|
$newsite = $DB->get_record('course', array('id'=>$SITE->id));
|
|
foreach (get_object_vars($newsite) as $field => $value) {
|
|
$SITE->$field = $value;
|
|
}
|
|
|
|
// now reload all settings - some of them might depend on the changed
|
|
admin_get_root(true);
|
|
return $count;
|
|
}
|
|
|
|
/**
|
|
* Internal recursive function - finds all settings from submitted form
|
|
*
|
|
* @param object $node Instance of admin_category, or admin_settingpage
|
|
* @param array $data
|
|
* @return array
|
|
*/
|
|
function admin_find_write_settings($node, $data) {
|
|
$return = array();
|
|
|
|
if (empty($data)) {
|
|
return $return;
|
|
}
|
|
|
|
if ($node instanceof admin_category) {
|
|
$entries = array_keys($node->children);
|
|
foreach ($entries as $entry) {
|
|
$return = array_merge($return, admin_find_write_settings($node->children[$entry], $data));
|
|
}
|
|
|
|
} else if ($node instanceof admin_settingpage) {
|
|
foreach ($node->settings as $setting) {
|
|
$fullname = $setting->get_full_name();
|
|
if (array_key_exists($fullname, $data)) {
|
|
$return[$fullname] = $setting;
|
|
}
|
|
}
|
|
|
|
}
|
|
|
|
return $return;
|
|
}
|
|
|
|
/**
|
|
* Internal function - prints the search results
|
|
*
|
|
* @param string $query String to search for
|
|
* @return string empty or XHTML
|
|
*/
|
|
function admin_search_settings_html($query) {
|
|
global $CFG, $OUTPUT;
|
|
|
|
if (textlib::strlen($query) < 2) {
|
|
return '';
|
|
}
|
|
$query = textlib::strtolower($query);
|
|
|
|
$adminroot = admin_get_root();
|
|
$findings = $adminroot->search($query);
|
|
$return = '';
|
|
$savebutton = false;
|
|
|
|
foreach ($findings as $found) {
|
|
$page = $found->page;
|
|
$settings = $found->settings;
|
|
if ($page->is_hidden()) {
|
|
// hidden pages are not displayed in search results
|
|
continue;
|
|
}
|
|
if ($page instanceof admin_externalpage) {
|
|
$return .= $OUTPUT->heading(get_string('searchresults','admin').' - <a href="'.$page->url.'">'.highlight($query, $page->visiblename).'</a>', 2, 'main');
|
|
} else if ($page instanceof admin_settingpage) {
|
|
$return .= $OUTPUT->heading(get_string('searchresults','admin').' - <a href="'.$CFG->wwwroot.'/'.$CFG->admin.'/settings.php?section='.$page->name.'">'.highlight($query, $page->visiblename).'</a>', 2, 'main');
|
|
} else {
|
|
continue;
|
|
}
|
|
if (!empty($settings)) {
|
|
$return .= '<fieldset class="adminsettings">'."\n";
|
|
foreach ($settings as $setting) {
|
|
if (empty($setting->nosave)) {
|
|
$savebutton = true;
|
|
}
|
|
$return .= '<div class="clearer"><!-- --></div>'."\n";
|
|
$fullname = $setting->get_full_name();
|
|
if (array_key_exists($fullname, $adminroot->errors)) {
|
|
$data = $adminroot->errors[$fullname]->data;
|
|
} else {
|
|
$data = $setting->get_setting();
|
|
// do not use defaults if settings not available - upgradesettings handles the defaults!
|
|
}
|
|
$return .= $setting->output_html($data, $query);
|
|
}
|
|
$return .= '</fieldset>';
|
|
}
|
|
}
|
|
|
|
if ($savebutton) {
|
|
$return .= '<div class="form-buttons"><input class="form-submit" type="submit" value="'.get_string('savechanges','admin').'" /></div>';
|
|
}
|
|
|
|
return $return;
|
|
}
|
|
|
|
/**
|
|
* Internal function - returns arrays of html pages with uninitialised settings
|
|
*
|
|
* @param object $node Instance of admin_category or admin_settingpage
|
|
* @return array
|
|
*/
|
|
function admin_output_new_settings_by_page($node) {
|
|
global $OUTPUT;
|
|
$return = array();
|
|
|
|
if ($node instanceof admin_category) {
|
|
$entries = array_keys($node->children);
|
|
foreach ($entries as $entry) {
|
|
$return += admin_output_new_settings_by_page($node->children[$entry]);
|
|
}
|
|
|
|
} else if ($node instanceof admin_settingpage) {
|
|
$newsettings = array();
|
|
foreach ($node->settings as $setting) {
|
|
if (is_null($setting->get_setting())) {
|
|
$newsettings[] = $setting;
|
|
}
|
|
}
|
|
if (count($newsettings) > 0) {
|
|
$adminroot = admin_get_root();
|
|
$page = $OUTPUT->heading(get_string('upgradesettings','admin').' - '.$node->visiblename, 2, 'main');
|
|
$page .= '<fieldset class="adminsettings">'."\n";
|
|
foreach ($newsettings as $setting) {
|
|
$fullname = $setting->get_full_name();
|
|
if (array_key_exists($fullname, $adminroot->errors)) {
|
|
$data = $adminroot->errors[$fullname]->data;
|
|
} else {
|
|
$data = $setting->get_setting();
|
|
if (is_null($data)) {
|
|
$data = $setting->get_defaultsetting();
|
|
}
|
|
}
|
|
$page .= '<div class="clearer"><!-- --></div>'."\n";
|
|
$page .= $setting->output_html($data);
|
|
}
|
|
$page .= '</fieldset>';
|
|
$return[$node->name] = $page;
|
|
}
|
|
}
|
|
|
|
return $return;
|
|
}
|
|
|
|
/**
|
|
* Format admin settings
|
|
*
|
|
* @param object $setting
|
|
* @param string $title label element
|
|
* @param string $form form fragment, html code - not highlighted automatically
|
|
* @param string $description
|
|
* @param bool $label link label to id, true by default
|
|
* @param string $warning warning text
|
|
* @param sting $defaultinfo defaults info, null means nothing, '' is converted to "Empty" string, defaults to null
|
|
* @param string $query search query to be highlighted
|
|
* @return string XHTML
|
|
*/
|
|
function format_admin_setting($setting, $title='', $form='', $description='', $label=true, $warning='', $defaultinfo=NULL, $query='') {
|
|
global $CFG;
|
|
|
|
$name = empty($setting->plugin) ? $setting->name : "$setting->plugin | $setting->name";
|
|
$fullname = $setting->get_full_name();
|
|
|
|
// sometimes the id is not id_s_name, but id_s_name_m or something, and this does not validate
|
|
if ($label) {
|
|
$labelfor = 'for = "'.$setting->get_id().'"';
|
|
} else {
|
|
$labelfor = '';
|
|
}
|
|
$form .= $setting->output_setting_flags();
|
|
|
|
$override = '';
|
|
if (empty($setting->plugin)) {
|
|
if (array_key_exists($setting->name, $CFG->config_php_settings)) {
|
|
$override = '<div class="form-overridden">'.get_string('configoverride', 'admin').'</div>';
|
|
}
|
|
} else {
|
|
if (array_key_exists($setting->plugin, $CFG->forced_plugin_settings) and array_key_exists($setting->name, $CFG->forced_plugin_settings[$setting->plugin])) {
|
|
$override = '<div class="form-overridden">'.get_string('configoverride', 'admin').'</div>';
|
|
}
|
|
}
|
|
|
|
if ($warning !== '') {
|
|
$warning = '<div class="form-warning">'.$warning.'</div>';
|
|
}
|
|
|
|
$defaults = array();
|
|
if (!is_null($defaultinfo)) {
|
|
if ($defaultinfo === '') {
|
|
$defaultinfo = get_string('emptysettingvalue', 'admin');
|
|
}
|
|
$defaults[] = $defaultinfo;
|
|
}
|
|
|
|
$setting->get_setting_flag_defaults($defaults);
|
|
|
|
if (!empty($defaults)) {
|
|
$defaultinfo = implode(', ', $defaults);
|
|
$defaultinfo = highlight($query, nl2br(s($defaultinfo)));
|
|
$defaultinfo = '<div class="form-defaultinfo">'.get_string('defaultsettinginfo', 'admin', $defaultinfo).'</div>';
|
|
}
|
|
|
|
|
|
$str = '
|
|
<div class="form-item clearfix" id="admin-'.$setting->name.'">
|
|
<div class="form-label">
|
|
<label '.$labelfor.'>'.highlightfast($query, $title).$override.$warning.'</label>
|
|
<span class="form-shortname">'.highlightfast($query, $name).'</span>
|
|
</div>
|
|
<div class="form-setting">'.$form.$defaultinfo.'</div>
|
|
<div class="form-description">'.highlight($query, markdown_to_html($description)).'</div>
|
|
</div>';
|
|
|
|
$adminroot = admin_get_root();
|
|
if (array_key_exists($fullname, $adminroot->errors)) {
|
|
$str = '<fieldset class="error"><legend>'.$adminroot->errors[$fullname]->error.'</legend>'.$str.'</fieldset>';
|
|
}
|
|
|
|
return $str;
|
|
}
|
|
|
|
/**
|
|
* Based on find_new_settings{@link ()} in upgradesettings.php
|
|
* Looks to find any admin settings that have not been initialized. Returns 1 if it finds any.
|
|
*
|
|
* @param object $node Instance of admin_category, or admin_settingpage
|
|
* @return boolean true if any settings haven't been initialised, false if they all have
|
|
*/
|
|
function any_new_admin_settings($node) {
|
|
|
|
if ($node instanceof admin_category) {
|
|
$entries = array_keys($node->children);
|
|
foreach ($entries as $entry) {
|
|
if (any_new_admin_settings($node->children[$entry])) {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
} else if ($node instanceof admin_settingpage) {
|
|
foreach ($node->settings as $setting) {
|
|
if ($setting->get_setting() === NULL) {
|
|
return true;
|
|
}
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Moved from admin/replace.php so that we can use this in cron
|
|
*
|
|
* @param string $search string to look for
|
|
* @param string $replace string to replace
|
|
* @return bool success or fail
|
|
*/
|
|
function db_replace($search, $replace) {
|
|
global $DB, $CFG, $OUTPUT;
|
|
|
|
// TODO: this is horrible hack, we should do whitelisting and each plugin should be responsible for proper replacing...
|
|
$skiptables = array('config', 'config_plugins', 'config_log', 'upgrade_log', 'log',
|
|
'filter_config', 'sessions', 'events_queue', 'repository_instance_config',
|
|
'block_instances', '');
|
|
|
|
// Turn off time limits, sometimes upgrades can be slow.
|
|
@set_time_limit(0);
|
|
|
|
if (!$tables = $DB->get_tables() ) { // No tables yet at all.
|
|
return false;
|
|
}
|
|
foreach ($tables as $table) {
|
|
|
|
if (in_array($table, $skiptables)) { // Don't process these
|
|
continue;
|
|
}
|
|
|
|
if ($columns = $DB->get_columns($table)) {
|
|
$DB->set_debug(true);
|
|
foreach ($columns as $column => $data) {
|
|
if (in_array($data->meta_type, array('C', 'X'))) { // Text stuff only
|
|
//TODO: this should be definitively moved to DML driver to do the actual replace, this is not going to work for MSSQL and Oracle...
|
|
$DB->execute("UPDATE {".$table."} SET $column = REPLACE($column, ?, ?)", array($search, $replace));
|
|
}
|
|
}
|
|
$DB->set_debug(false);
|
|
}
|
|
}
|
|
|
|
// delete modinfo caches
|
|
rebuild_course_cache(0, true);
|
|
|
|
// TODO: we should ask all plugins to do the search&replace, for now let's do only blocks...
|
|
$blocks = get_plugin_list('block');
|
|
foreach ($blocks as $blockname=>$fullblock) {
|
|
if ($blockname === 'NEWBLOCK') { // Someone has unzipped the template, ignore it
|
|
continue;
|
|
}
|
|
|
|
if (!is_readable($fullblock.'/lib.php')) {
|
|
continue;
|
|
}
|
|
|
|
$function = 'block_'.$blockname.'_global_db_replace';
|
|
include_once($fullblock.'/lib.php');
|
|
if (!function_exists($function)) {
|
|
continue;
|
|
}
|
|
|
|
echo $OUTPUT->notification("Replacing in $blockname blocks...", 'notifysuccess');
|
|
$function($search, $replace);
|
|
echo $OUTPUT->notification("...finished", 'notifysuccess');
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Manage repository settings
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_managerepository extends admin_setting {
|
|
/** @var string */
|
|
private $baseurl;
|
|
|
|
/**
|
|
* calls parent::__construct with specific arguments
|
|
*/
|
|
public function __construct() {
|
|
global $CFG;
|
|
parent::__construct('managerepository', get_string('manage', 'repository'), '', '');
|
|
$this->baseurl = $CFG->wwwroot . '/' . $CFG->admin . '/repository.php?sesskey=' . sesskey();
|
|
}
|
|
|
|
/**
|
|
* Always returns true, does nothing
|
|
*
|
|
* @return true
|
|
*/
|
|
public function get_setting() {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Always returns true does nothing
|
|
*
|
|
* @return true
|
|
*/
|
|
public function get_defaultsetting() {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Always returns s_managerepository
|
|
*
|
|
* @return string Always return 's_managerepository'
|
|
*/
|
|
public function get_full_name() {
|
|
return 's_managerepository';
|
|
}
|
|
|
|
/**
|
|
* Always returns '' doesn't do anything
|
|
*/
|
|
public function write_setting($data) {
|
|
$url = $this->baseurl . '&new=' . $data;
|
|
return '';
|
|
// TODO
|
|
// Should not use redirect and exit here
|
|
// Find a better way to do this.
|
|
// redirect($url);
|
|
// exit;
|
|
}
|
|
|
|
/**
|
|
* Searches repository plugins for one that matches $query
|
|
*
|
|
* @param string $query The string to search for
|
|
* @return bool true if found, false if not
|
|
*/
|
|
public function is_related($query) {
|
|
if (parent::is_related($query)) {
|
|
return true;
|
|
}
|
|
|
|
$repositories= get_plugin_list('repository');
|
|
foreach ($repositories as $p => $dir) {
|
|
if (strpos($p, $query) !== false) {
|
|
return true;
|
|
}
|
|
}
|
|
foreach (repository::get_types() as $instance) {
|
|
$title = $instance->get_typename();
|
|
if (strpos(textlib::strtolower($title), $query) !== false) {
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Helper function that generates a moodle_url object
|
|
* relevant to the repository
|
|
*/
|
|
|
|
function repository_action_url($repository) {
|
|
return new moodle_url($this->baseurl, array('sesskey'=>sesskey(), 'repos'=>$repository));
|
|
}
|
|
|
|
/**
|
|
* Builds XHTML to display the control
|
|
*
|
|
* @param string $data Unused
|
|
* @param string $query
|
|
* @return string XHTML
|
|
*/
|
|
public function output_html($data, $query='') {
|
|
global $CFG, $USER, $OUTPUT;
|
|
|
|
// Get strings that are used
|
|
$strshow = get_string('on', 'repository');
|
|
$strhide = get_string('off', 'repository');
|
|
$strdelete = get_string('disabled', 'repository');
|
|
|
|
$actionchoicesforexisting = array(
|
|
'show' => $strshow,
|
|
'hide' => $strhide,
|
|
'delete' => $strdelete
|
|
);
|
|
|
|
$actionchoicesfornew = array(
|
|
'newon' => $strshow,
|
|
'newoff' => $strhide,
|
|
'delete' => $strdelete
|
|
);
|
|
|
|
$return = '';
|
|
$return .= $OUTPUT->box_start('generalbox');
|
|
|
|
// Set strings that are used multiple times
|
|
$settingsstr = get_string('settings');
|
|
$disablestr = get_string('disable');
|
|
|
|
// Table to list plug-ins
|
|
$table = new html_table();
|
|
$table->head = array(get_string('name'), get_string('isactive', 'repository'), get_string('order'), $settingsstr);
|
|
$table->align = array('left', 'center', 'center', 'center', 'center');
|
|
$table->data = array();
|
|
|
|
// Get list of used plug-ins
|
|
$repositorytypes = repository::get_types();
|
|
if (!empty($repositorytypes)) {
|
|
// Array to store plugins being used
|
|
$alreadyplugins = array();
|
|
$totalrepositorytypes = count($repositorytypes);
|
|
$updowncount = 1;
|
|
foreach ($repositorytypes as $i) {
|
|
$settings = '';
|
|
$typename = $i->get_typename();
|
|
// Display edit link only if you can config the type or if it has multiple instances (e.g. has instance config)
|
|
$typeoptionnames = repository::static_function($typename, 'get_type_option_names');
|
|
$instanceoptionnames = repository::static_function($typename, 'get_instance_option_names');
|
|
|
|
if (!empty($typeoptionnames) || !empty($instanceoptionnames)) {
|
|
// Calculate number of instances in order to display them for the Moodle administrator
|
|
if (!empty($instanceoptionnames)) {
|
|
$params = array();
|
|
$params['context'] = array(get_system_context());
|
|
$params['onlyvisible'] = false;
|
|
$params['type'] = $typename;
|
|
$admininstancenumber = count(repository::static_function($typename, 'get_instances', $params));
|
|
// site instances
|
|
$admininstancenumbertext = get_string('instancesforsite', 'repository', $admininstancenumber);
|
|
$params['context'] = array();
|
|
$instances = repository::static_function($typename, 'get_instances', $params);
|
|
$courseinstances = array();
|
|
$userinstances = array();
|
|
|
|
foreach ($instances as $instance) {
|
|
$repocontext = context::instance_by_id($instance->instance->contextid);
|
|
if ($repocontext->contextlevel == CONTEXT_COURSE) {
|
|
$courseinstances[] = $instance;
|
|
} else if ($repocontext->contextlevel == CONTEXT_USER) {
|
|
$userinstances[] = $instance;
|
|
}
|
|
}
|
|
// course instances
|
|
$instancenumber = count($courseinstances);
|
|
$courseinstancenumbertext = get_string('instancesforcourses', 'repository', $instancenumber);
|
|
|
|
// user private instances
|
|
$instancenumber = count($userinstances);
|
|
$userinstancenumbertext = get_string('instancesforusers', 'repository', $instancenumber);
|
|
} else {
|
|
$admininstancenumbertext = "";
|
|
$courseinstancenumbertext = "";
|
|
$userinstancenumbertext = "";
|
|
}
|
|
|
|
$settings .= '<a href="' . $this->baseurl . '&action=edit&repos=' . $typename . '">' . $settingsstr .'</a>';
|
|
|
|
$settings .= $OUTPUT->container_start('mdl-left');
|
|
$settings .= '<br/>';
|
|
$settings .= $admininstancenumbertext;
|
|
$settings .= '<br/>';
|
|
$settings .= $courseinstancenumbertext;
|
|
$settings .= '<br/>';
|
|
$settings .= $userinstancenumbertext;
|
|
$settings .= $OUTPUT->container_end();
|
|
}
|
|
// Get the current visibility
|
|
if ($i->get_visible()) {
|
|
$currentaction = 'show';
|
|
} else {
|
|
$currentaction = 'hide';
|
|
}
|
|
|
|
$select = new single_select($this->repository_action_url($typename, 'repos'), 'action', $actionchoicesforexisting, $currentaction, null, 'applyto' . basename($typename));
|
|
|
|
// Display up/down link
|
|
$updown = '';
|
|
// Should be done with CSS instead.
|
|
$spacer = $OUTPUT->spacer(array('height' => 15, 'width' => 15, 'class' => 'smallicon'));
|
|
|
|
if ($updowncount > 1) {
|
|
$updown .= "<a href=\"$this->baseurl&action=moveup&repos=".$typename."\">";
|
|
$updown .= "<img src=\"" . $OUTPUT->pix_url('t/up') . "\" alt=\"up\" class=\"iconsmall\" /></a> ";
|
|
}
|
|
else {
|
|
$updown .= $spacer;
|
|
}
|
|
if ($updowncount < $totalrepositorytypes) {
|
|
$updown .= "<a href=\"$this->baseurl&action=movedown&repos=".$typename."\">";
|
|
$updown .= "<img src=\"" . $OUTPUT->pix_url('t/down') . "\" alt=\"down\" class=\"iconsmall\" /></a>";
|
|
}
|
|
else {
|
|
$updown .= $spacer;
|
|
}
|
|
|
|
$updowncount++;
|
|
|
|
$table->data[] = array($i->get_readablename(), $OUTPUT->render($select), $updown, $settings);
|
|
|
|
if (!in_array($typename, $alreadyplugins)) {
|
|
$alreadyplugins[] = $typename;
|
|
}
|
|
}
|
|
}
|
|
|
|
// Get all the plugins that exist on disk
|
|
$plugins = get_plugin_list('repository');
|
|
if (!empty($plugins)) {
|
|
foreach ($plugins as $plugin => $dir) {
|
|
// Check that it has not already been listed
|
|
if (!in_array($plugin, $alreadyplugins)) {
|
|
$select = new single_select($this->repository_action_url($plugin, 'repos'), 'action', $actionchoicesfornew, 'delete', null, 'applyto' . basename($plugin));
|
|
$table->data[] = array(get_string('pluginname', 'repository_'.$plugin), $OUTPUT->render($select), '', '');
|
|
}
|
|
}
|
|
}
|
|
|
|
$return .= html_writer::table($table);
|
|
$return .= $OUTPUT->box_end();
|
|
return highlight($query, $return);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Special checkbox for enable mobile web service
|
|
* If enable then we store the service id of the mobile service into config table
|
|
* If disable then we unstore the service id from the config table
|
|
*/
|
|
class admin_setting_enablemobileservice extends admin_setting_configcheckbox {
|
|
|
|
/** @var boolean True means that the capability 'webservice/xmlrpc:use' is set for authenticated user role */
|
|
private $xmlrpcuse;
|
|
/** @var boolean True means that the capability 'webservice/rest:use' is set for authenticated user role */
|
|
private $restuse;
|
|
|
|
/**
|
|
* Return true if Authenticated user role has the capability 'webservice/xmlrpc:use' and 'webservice/rest:use', otherwise false.
|
|
*
|
|
* @return boolean
|
|
*/
|
|
private function is_protocol_cap_allowed() {
|
|
global $DB, $CFG;
|
|
|
|
// We keep xmlrpc enabled for backward compatibility.
|
|
// If the $this->xmlrpcuse variable is not set, it needs to be set.
|
|
if (empty($this->xmlrpcuse) and $this->xmlrpcuse!==false) {
|
|
$params = array();
|
|
$params['permission'] = CAP_ALLOW;
|
|
$params['roleid'] = $CFG->defaultuserroleid;
|
|
$params['capability'] = 'webservice/xmlrpc:use';
|
|
$this->xmlrpcuse = $DB->record_exists('role_capabilities', $params);
|
|
}
|
|
|
|
// If the $this->restuse variable is not set, it needs to be set.
|
|
if (empty($this->restuse) and $this->restuse!==false) {
|
|
$params = array();
|
|
$params['permission'] = CAP_ALLOW;
|
|
$params['roleid'] = $CFG->defaultuserroleid;
|
|
$params['capability'] = 'webservice/rest:use';
|
|
$this->restuse = $DB->record_exists('role_capabilities', $params);
|
|
}
|
|
|
|
return ($this->xmlrpcuse && $this->restuse);
|
|
}
|
|
|
|
/**
|
|
* Set the 'webservice/xmlrpc:use'/'webservice/rest:use' to the Authenticated user role (allow or not)
|
|
* @param type $status true to allow, false to not set
|
|
*/
|
|
private function set_protocol_cap($status) {
|
|
global $CFG;
|
|
if ($status and !$this->is_protocol_cap_allowed()) {
|
|
//need to allow the cap
|
|
$permission = CAP_ALLOW;
|
|
$assign = true;
|
|
} else if (!$status and $this->is_protocol_cap_allowed()){
|
|
//need to disallow the cap
|
|
$permission = CAP_INHERIT;
|
|
$assign = true;
|
|
}
|
|
if (!empty($assign)) {
|
|
$systemcontext = get_system_context();
|
|
assign_capability('webservice/xmlrpc:use', $permission, $CFG->defaultuserroleid, $systemcontext->id, true);
|
|
assign_capability('webservice/rest:use', $permission, $CFG->defaultuserroleid, $systemcontext->id, true);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Builds XHTML to display the control.
|
|
* The main purpose of this overloading is to display a warning when https
|
|
* is not supported by the server
|
|
* @param string $data Unused
|
|
* @param string $query
|
|
* @return string XHTML
|
|
*/
|
|
public function output_html($data, $query='') {
|
|
global $CFG, $OUTPUT;
|
|
$html = parent::output_html($data, $query);
|
|
|
|
if ((string)$data === $this->yes) {
|
|
require_once($CFG->dirroot . "/lib/filelib.php");
|
|
$curl = new curl();
|
|
$httpswwwroot = str_replace('http:', 'https:', $CFG->wwwroot); //force https url
|
|
$curl->head($httpswwwroot . "/login/index.php");
|
|
$info = $curl->get_info();
|
|
if (empty($info['http_code']) or ($info['http_code'] >= 400)) {
|
|
$html .= $OUTPUT->notification(get_string('nohttpsformobilewarning', 'admin'));
|
|
}
|
|
}
|
|
|
|
return $html;
|
|
}
|
|
|
|
/**
|
|
* Retrieves the current setting using the objects name
|
|
*
|
|
* @return string
|
|
*/
|
|
public function get_setting() {
|
|
global $CFG;
|
|
|
|
// For install cli script, $CFG->defaultuserroleid is not set so return 0
|
|
// Or if web services aren't enabled this can't be,
|
|
if (empty($CFG->defaultuserroleid) || empty($CFG->enablewebservices)) {
|
|
return 0;
|
|
}
|
|
|
|
require_once($CFG->dirroot . '/webservice/lib.php');
|
|
$webservicemanager = new webservice();
|
|
$mobileservice = $webservicemanager->get_external_service_by_shortname(MOODLE_OFFICIAL_MOBILE_SERVICE);
|
|
if ($mobileservice->enabled and $this->is_protocol_cap_allowed()) {
|
|
return $this->config_read($this->name); //same as returning 1
|
|
} else {
|
|
return 0;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Save the selected setting
|
|
*
|
|
* @param string $data The selected site
|
|
* @return string empty string or error message
|
|
*/
|
|
public function write_setting($data) {
|
|
global $DB, $CFG;
|
|
|
|
//for install cli script, $CFG->defaultuserroleid is not set so do nothing
|
|
if (empty($CFG->defaultuserroleid)) {
|
|
return '';
|
|
}
|
|
|
|
$servicename = MOODLE_OFFICIAL_MOBILE_SERVICE;
|
|
|
|
require_once($CFG->dirroot . '/webservice/lib.php');
|
|
$webservicemanager = new webservice();
|
|
|
|
$updateprotocol = false;
|
|
if ((string)$data === $this->yes) {
|
|
//code run when enable mobile web service
|
|
//enable web service systeme if necessary
|
|
set_config('enablewebservices', true);
|
|
|
|
//enable mobile service
|
|
$mobileservice = $webservicemanager->get_external_service_by_shortname(MOODLE_OFFICIAL_MOBILE_SERVICE);
|
|
$mobileservice->enabled = 1;
|
|
$webservicemanager->update_external_service($mobileservice);
|
|
|
|
//enable xml-rpc server
|
|
$activeprotocols = empty($CFG->webserviceprotocols) ? array() : explode(',', $CFG->webserviceprotocols);
|
|
|
|
if (!in_array('xmlrpc', $activeprotocols)) {
|
|
$activeprotocols[] = 'xmlrpc';
|
|
$updateprotocol = true;
|
|
}
|
|
|
|
if (!in_array('rest', $activeprotocols)) {
|
|
$activeprotocols[] = 'rest';
|
|
$updateprotocol = true;
|
|
}
|
|
|
|
if ($updateprotocol) {
|
|
set_config('webserviceprotocols', implode(',', $activeprotocols));
|
|
}
|
|
|
|
//allow xml-rpc:use capability for authenticated user
|
|
$this->set_protocol_cap(true);
|
|
|
|
} else {
|
|
//disable web service system if no other services are enabled
|
|
$otherenabledservices = $DB->get_records_select('external_services',
|
|
'enabled = :enabled AND (shortname != :shortname OR shortname IS NULL)', array('enabled' => 1,
|
|
'shortname' => MOODLE_OFFICIAL_MOBILE_SERVICE));
|
|
if (empty($otherenabledservices)) {
|
|
set_config('enablewebservices', false);
|
|
|
|
//also disable xml-rpc server
|
|
$activeprotocols = empty($CFG->webserviceprotocols) ? array() : explode(',', $CFG->webserviceprotocols);
|
|
$protocolkey = array_search('xmlrpc', $activeprotocols);
|
|
if ($protocolkey !== false) {
|
|
unset($activeprotocols[$protocolkey]);
|
|
$updateprotocol = true;
|
|
}
|
|
|
|
$protocolkey = array_search('rest', $activeprotocols);
|
|
if ($protocolkey !== false) {
|
|
unset($activeprotocols[$protocolkey]);
|
|
$updateprotocol = true;
|
|
}
|
|
|
|
if ($updateprotocol) {
|
|
set_config('webserviceprotocols', implode(',', $activeprotocols));
|
|
}
|
|
|
|
//disallow xml-rpc:use capability for authenticated user
|
|
$this->set_protocol_cap(false);
|
|
}
|
|
|
|
//disable the mobile service
|
|
$mobileservice = $webservicemanager->get_external_service_by_shortname(MOODLE_OFFICIAL_MOBILE_SERVICE);
|
|
$mobileservice->enabled = 0;
|
|
$webservicemanager->update_external_service($mobileservice);
|
|
}
|
|
|
|
return (parent::write_setting($data));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Special class for management of external services
|
|
*
|
|
* @author Petr Skoda (skodak)
|
|
*/
|
|
class admin_setting_manageexternalservices extends admin_setting {
|
|
/**
|
|
* Calls parent::__construct with specific arguments
|
|
*/
|
|
public function __construct() {
|
|
$this->nosave = true;
|
|
parent::__construct('webservicesui', get_string('externalservices', 'webservice'), '', '');
|
|
}
|
|
|
|
/**
|
|
* Always returns true, does nothing
|
|
*
|
|
* @return true
|
|
*/
|
|
public function get_setting() {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Always returns true, does nothing
|
|
*
|
|
* @return true
|
|
*/
|
|
public function get_defaultsetting() {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Always returns '', does not write anything
|
|
*
|
|
* @return string Always returns ''
|
|
*/
|
|
public function write_setting($data) {
|
|
// do not write any setting
|
|
return '';
|
|
}
|
|
|
|
/**
|
|
* Checks if $query is one of the available external services
|
|
*
|
|
* @param string $query The string to search for
|
|
* @return bool Returns true if found, false if not
|
|
*/
|
|
public function is_related($query) {
|
|
global $DB;
|
|
|
|
if (parent::is_related($query)) {
|
|
return true;
|
|
}
|
|
|
|
$services = $DB->get_records('external_services', array(), 'id, name');
|
|
foreach ($services as $service) {
|
|
if (strpos(textlib::strtolower($service->name), $query) !== false) {
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Builds the XHTML to display the control
|
|
*
|
|
* @param string $data Unused
|
|
* @param string $query
|
|
* @return string
|
|
*/
|
|
public function output_html($data, $query='') {
|
|
global $CFG, $OUTPUT, $DB;
|
|
|
|
// display strings
|
|
$stradministration = get_string('administration');
|
|
$stredit = get_string('edit');
|
|
$strservice = get_string('externalservice', 'webservice');
|
|
$strdelete = get_string('delete');
|
|
$strplugin = get_string('plugin', 'admin');
|
|
$stradd = get_string('add');
|
|
$strfunctions = get_string('functions', 'webservice');
|
|
$strusers = get_string('users');
|
|
$strserviceusers = get_string('serviceusers', 'webservice');
|
|
|
|
$esurl = "$CFG->wwwroot/$CFG->admin/webservice/service.php";
|
|
$efurl = "$CFG->wwwroot/$CFG->admin/webservice/service_functions.php";
|
|
$euurl = "$CFG->wwwroot/$CFG->admin/webservice/service_users.php";
|
|
|
|
// built in services
|
|
$services = $DB->get_records_select('external_services', 'component IS NOT NULL', null, 'name');
|
|
$return = "";
|
|
if (!empty($services)) {
|
|
$return .= $OUTPUT->heading(get_string('servicesbuiltin', 'webservice'), 3, 'main');
|
|
|
|
|
|
|
|
$table = new html_table();
|
|
$table->head = array($strservice, $strplugin, $strfunctions, $strusers, $stredit);
|
|
$table->colclasses = array('leftalign service', 'leftalign plugin', 'centeralign functions', 'centeralign users', 'centeralign ');
|
|
$table->id = 'builtinservices';
|
|
$table->attributes['class'] = 'admintable externalservices generaltable';
|
|
$table->data = array();
|
|
|
|
// iterate through auth plugins and add to the display table
|
|
foreach ($services as $service) {
|
|
$name = $service->name;
|
|
|
|
// hide/show link
|
|
if ($service->enabled) {
|
|
$displayname = "<span>$name</span>";
|
|
} else {
|
|
$displayname = "<span class=\"dimmed_text\">$name</span>";
|
|
}
|
|
|
|
$plugin = $service->component;
|
|
|
|
$functions = "<a href=\"$efurl?id=$service->id\">$strfunctions</a>";
|
|
|
|
if ($service->restrictedusers) {
|
|
$users = "<a href=\"$euurl?id=$service->id\">$strserviceusers</a>";
|
|
} else {
|
|
$users = get_string('allusers', 'webservice');
|
|
}
|
|
|
|
$edit = "<a href=\"$esurl?id=$service->id\">$stredit</a>";
|
|
|
|
// add a row to the table
|
|
$table->data[] = array($displayname, $plugin, $functions, $users, $edit);
|
|
}
|
|
$return .= html_writer::table($table);
|
|
}
|
|
|
|
// Custom services
|
|
$return .= $OUTPUT->heading(get_string('servicescustom', 'webservice'), 3, 'main');
|
|
$services = $DB->get_records_select('external_services', 'component IS NULL', null, 'name');
|
|
|
|
$table = new html_table();
|
|
$table->head = array($strservice, $strdelete, $strfunctions, $strusers, $stredit);
|
|
$table->colclasses = array('leftalign service', 'leftalign plugin', 'centeralign functions', 'centeralign users', 'centeralign ');
|
|
$table->id = 'customservices';
|
|
$table->attributes['class'] = 'admintable externalservices generaltable';
|
|
$table->data = array();
|
|
|
|
// iterate through auth plugins and add to the display table
|
|
foreach ($services as $service) {
|
|
$name = $service->name;
|
|
|
|
// hide/show link
|
|
if ($service->enabled) {
|
|
$displayname = "<span>$name</span>";
|
|
} else {
|
|
$displayname = "<span class=\"dimmed_text\">$name</span>";
|
|
}
|
|
|
|
// delete link
|
|
$delete = "<a href=\"$esurl?action=delete&sesskey=".sesskey()."&id=$service->id\">$strdelete</a>";
|
|
|
|
$functions = "<a href=\"$efurl?id=$service->id\">$strfunctions</a>";
|
|
|
|
if ($service->restrictedusers) {
|
|
$users = "<a href=\"$euurl?id=$service->id\">$strserviceusers</a>";
|
|
} else {
|
|
$users = get_string('allusers', 'webservice');
|
|
}
|
|
|
|
$edit = "<a href=\"$esurl?id=$service->id\">$stredit</a>";
|
|
|
|
// add a row to the table
|
|
$table->data[] = array($displayname, $delete, $functions, $users, $edit);
|
|
}
|
|
// add new custom service option
|
|
$return .= html_writer::table($table);
|
|
|
|
$return .= '<br />';
|
|
// add a token to the table
|
|
$return .= "<a href=\"$esurl?id=0\">$stradd</a>";
|
|
|
|
return highlight($query, $return);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Special class for overview of external services
|
|
*
|
|
* @author Jerome Mouneyrac
|
|
*/
|
|
class admin_setting_webservicesoverview extends admin_setting {
|
|
|
|
/**
|
|
* Calls parent::__construct with specific arguments
|
|
*/
|
|
public function __construct() {
|
|
$this->nosave = true;
|
|
parent::__construct('webservicesoverviewui',
|
|
get_string('webservicesoverview', 'webservice'), '', '');
|
|
}
|
|
|
|
/**
|
|
* Always returns true, does nothing
|
|
*
|
|
* @return true
|
|
*/
|
|
public function get_setting() {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Always returns true, does nothing
|
|
*
|
|
* @return true
|
|
*/
|
|
public function get_defaultsetting() {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Always returns '', does not write anything
|
|
*
|
|
* @return string Always returns ''
|
|
*/
|
|
public function write_setting($data) {
|
|
// do not write any setting
|
|
return '';
|
|
}
|
|
|
|
/**
|
|
* Builds the XHTML to display the control
|
|
*
|
|
* @param string $data Unused
|
|
* @param string $query
|
|
* @return string
|
|
*/
|
|
public function output_html($data, $query='') {
|
|
global $CFG, $OUTPUT;
|
|
|
|
$return = "";
|
|
$brtag = html_writer::empty_tag('br');
|
|
|
|
// Enable mobile web service
|
|
$enablemobile = new admin_setting_enablemobileservice('enablemobilewebservice',
|
|
get_string('enablemobilewebservice', 'admin'),
|
|
get_string('configenablemobilewebservice',
|
|
'admin', ''), 0); //we don't want to display it but to know the ws mobile status
|
|
$manageserviceurl = new moodle_url("/admin/settings.php?section=externalservices");
|
|
$wsmobileparam = new stdClass();
|
|
$wsmobileparam->enablemobileservice = get_string('enablemobilewebservice', 'admin');
|
|
$wsmobileparam->manageservicelink = html_writer::link($manageserviceurl,
|
|
get_string('externalservices', 'webservice'));
|
|
$mobilestatus = $enablemobile->get_setting()?get_string('mobilewsenabled', 'webservice'):get_string('mobilewsdisabled', 'webservice');
|
|
$wsmobileparam->wsmobilestatus = html_writer::tag('strong', $mobilestatus);
|
|
$return .= $OUTPUT->heading(get_string('enablemobilewebservice', 'admin'), 3, 'main');
|
|
$return .= $brtag . get_string('enablemobilewsoverview', 'webservice', $wsmobileparam)
|
|
. $brtag . $brtag;
|
|
|
|
/// One system controlling Moodle with Token
|
|
$return .= $OUTPUT->heading(get_string('onesystemcontrolling', 'webservice'), 3, 'main');
|
|
$table = new html_table();
|
|
$table->head = array(get_string('step', 'webservice'), get_string('status'),
|
|
get_string('description'));
|
|
$table->colclasses = array('leftalign step', 'leftalign status', 'leftalign description');
|
|
$table->id = 'onesystemcontrol';
|
|
$table->attributes['class'] = 'admintable wsoverview generaltable';
|
|
$table->data = array();
|
|
|
|
$return .= $brtag . get_string('onesystemcontrollingdescription', 'webservice')
|
|
. $brtag . $brtag;
|
|
|
|
/// 1. Enable Web Services
|
|
$row = array();
|
|
$url = new moodle_url("/admin/search.php?query=enablewebservices");
|
|
$row[0] = "1. " . html_writer::tag('a', get_string('enablews', 'webservice'),
|
|
array('href' => $url));
|
|
$status = html_writer::tag('span', get_string('no'), array('class' => 'statuscritical'));
|
|
if ($CFG->enablewebservices) {
|
|
$status = get_string('yes');
|
|
}
|
|
$row[1] = $status;
|
|
$row[2] = get_string('enablewsdescription', 'webservice');
|
|
$table->data[] = $row;
|
|
|
|
/// 2. Enable protocols
|
|
$row = array();
|
|
$url = new moodle_url("/admin/settings.php?section=webserviceprotocols");
|
|
$row[0] = "2. " . html_writer::tag('a', get_string('enableprotocols', 'webservice'),
|
|
array('href' => $url));
|
|
$status = html_writer::tag('span', get_string('none'), array('class' => 'statuscritical'));
|
|
//retrieve activated protocol
|
|
$active_protocols = empty($CFG->webserviceprotocols) ?
|
|
array() : explode(',', $CFG->webserviceprotocols);
|
|
if (!empty($active_protocols)) {
|
|
$status = "";
|
|
foreach ($active_protocols as $protocol) {
|
|
$status .= $protocol . $brtag;
|
|
}
|
|
}
|
|
$row[1] = $status;
|
|
$row[2] = get_string('enableprotocolsdescription', 'webservice');
|
|
$table->data[] = $row;
|
|
|
|
/// 3. Create user account
|
|
$row = array();
|
|
$url = new moodle_url("/user/editadvanced.php?id=-1");
|
|
$row[0] = "3. " . html_writer::tag('a', get_string('createuser', 'webservice'),
|
|
array('href' => $url));
|
|
$row[1] = "";
|
|
$row[2] = get_string('createuserdescription', 'webservice');
|
|
$table->data[] = $row;
|
|
|
|
/// 4. Add capability to users
|
|
$row = array();
|
|
$url = new moodle_url("/admin/roles/check.php?contextid=1");
|
|
$row[0] = "4. " . html_writer::tag('a', get_string('checkusercapability', 'webservice'),
|
|
array('href' => $url));
|
|
$row[1] = "";
|
|
$row[2] = get_string('checkusercapabilitydescription', 'webservice');
|
|
$table->data[] = $row;
|
|
|
|
/// 5. Select a web service
|
|
$row = array();
|
|
$url = new moodle_url("/admin/settings.php?section=externalservices");
|
|
$row[0] = "5. " . html_writer::tag('a', get_string('selectservice', 'webservice'),
|
|
array('href' => $url));
|
|
$row[1] = "";
|
|
$row[2] = get_string('createservicedescription', 'webservice');
|
|
$table->data[] = $row;
|
|
|
|
/// 6. Add functions
|
|
$row = array();
|
|
$url = new moodle_url("/admin/settings.php?section=externalservices");
|
|
$row[0] = "6. " . html_writer::tag('a', get_string('addfunctions', 'webservice'),
|
|
array('href' => $url));
|
|
$row[1] = "";
|
|
$row[2] = get_string('addfunctionsdescription', 'webservice');
|
|
$table->data[] = $row;
|
|
|
|
/// 7. Add the specific user
|
|
$row = array();
|
|
$url = new moodle_url("/admin/settings.php?section=externalservices");
|
|
$row[0] = "7. " . html_writer::tag('a', get_string('selectspecificuser', 'webservice'),
|
|
array('href' => $url));
|
|
$row[1] = "";
|
|
$row[2] = get_string('selectspecificuserdescription', 'webservice');
|
|
$table->data[] = $row;
|
|
|
|
/// 8. Create token for the specific user
|
|
$row = array();
|
|
$url = new moodle_url("/admin/webservice/tokens.php?sesskey=" . sesskey() . "&action=create");
|
|
$row[0] = "8. " . html_writer::tag('a', get_string('createtokenforuser', 'webservice'),
|
|
array('href' => $url));
|
|
$row[1] = "";
|
|
$row[2] = get_string('createtokenforuserdescription', 'webservice');
|
|
$table->data[] = $row;
|
|
|
|
/// 9. Enable the documentation
|
|
$row = array();
|
|
$url = new moodle_url("/admin/search.php?query=enablewsdocumentation");
|
|
$row[0] = "9. " . html_writer::tag('a', get_string('enabledocumentation', 'webservice'),
|
|
array('href' => $url));
|
|
$status = '<span class="warning">' . get_string('no') . '</span>';
|
|
if ($CFG->enablewsdocumentation) {
|
|
$status = get_string('yes');
|
|
}
|
|
$row[1] = $status;
|
|
$row[2] = get_string('enabledocumentationdescription', 'webservice');
|
|
$table->data[] = $row;
|
|
|
|
/// 10. Test the service
|
|
$row = array();
|
|
$url = new moodle_url("/admin/webservice/testclient.php");
|
|
$row[0] = "10. " . html_writer::tag('a', get_string('testwithtestclient', 'webservice'),
|
|
array('href' => $url));
|
|
$row[1] = "";
|
|
$row[2] = get_string('testwithtestclientdescription', 'webservice');
|
|
$table->data[] = $row;
|
|
|
|
$return .= html_writer::table($table);
|
|
|
|
/// Users as clients with token
|
|
$return .= $brtag . $brtag . $brtag;
|
|
$return .= $OUTPUT->heading(get_string('userasclients', 'webservice'), 3, 'main');
|
|
$table = new html_table();
|
|
$table->head = array(get_string('step', 'webservice'), get_string('status'),
|
|
get_string('description'));
|
|
$table->colclasses = array('leftalign step', 'leftalign status', 'leftalign description');
|
|
$table->id = 'userasclients';
|
|
$table->attributes['class'] = 'admintable wsoverview generaltable';
|
|
$table->data = array();
|
|
|
|
$return .= $brtag . get_string('userasclientsdescription', 'webservice') .
|
|
$brtag . $brtag;
|
|
|
|
/// 1. Enable Web Services
|
|
$row = array();
|
|
$url = new moodle_url("/admin/search.php?query=enablewebservices");
|
|
$row[0] = "1. " . html_writer::tag('a', get_string('enablews', 'webservice'),
|
|
array('href' => $url));
|
|
$status = html_writer::tag('span', get_string('no'), array('class' => 'statuscritical'));
|
|
if ($CFG->enablewebservices) {
|
|
$status = get_string('yes');
|
|
}
|
|
$row[1] = $status;
|
|
$row[2] = get_string('enablewsdescription', 'webservice');
|
|
$table->data[] = $row;
|
|
|
|
/// 2. Enable protocols
|
|
$row = array();
|
|
$url = new moodle_url("/admin/settings.php?section=webserviceprotocols");
|
|
$row[0] = "2. " . html_writer::tag('a', get_string('enableprotocols', 'webservice'),
|
|
array('href' => $url));
|
|
$status = html_writer::tag('span', get_string('none'), array('class' => 'statuscritical'));
|
|
//retrieve activated protocol
|
|
$active_protocols = empty($CFG->webserviceprotocols) ?
|
|
array() : explode(',', $CFG->webserviceprotocols);
|
|
if (!empty($active_protocols)) {
|
|
$status = "";
|
|
foreach ($active_protocols as $protocol) {
|
|
$status .= $protocol . $brtag;
|
|
}
|
|
}
|
|
$row[1] = $status;
|
|
$row[2] = get_string('enableprotocolsdescription', 'webservice');
|
|
$table->data[] = $row;
|
|
|
|
|
|
/// 3. Select a web service
|
|
$row = array();
|
|
$url = new moodle_url("/admin/settings.php?section=externalservices");
|
|
$row[0] = "3. " . html_writer::tag('a', get_string('selectservice', 'webservice'),
|
|
array('href' => $url));
|
|
$row[1] = "";
|
|
$row[2] = get_string('createserviceforusersdescription', 'webservice');
|
|
$table->data[] = $row;
|
|
|
|
/// 4. Add functions
|
|
$row = array();
|
|
$url = new moodle_url("/admin/settings.php?section=externalservices");
|
|
$row[0] = "4. " . html_writer::tag('a', get_string('addfunctions', 'webservice'),
|
|
array('href' => $url));
|
|
$row[1] = "";
|
|
$row[2] = get_string('addfunctionsdescription', 'webservice');
|
|
$table->data[] = $row;
|
|
|
|
/// 5. Add capability to users
|
|
$row = array();
|
|
$url = new moodle_url("/admin/roles/check.php?contextid=1");
|
|
$row[0] = "5. " . html_writer::tag('a', get_string('addcapabilitytousers', 'webservice'),
|
|
array('href' => $url));
|
|
$row[1] = "";
|
|
$row[2] = get_string('addcapabilitytousersdescription', 'webservice');
|
|
$table->data[] = $row;
|
|
|
|
/// 6. Test the service
|
|
$row = array();
|
|
$url = new moodle_url("/admin/webservice/testclient.php");
|
|
$row[0] = "6. " . html_writer::tag('a', get_string('testwithtestclient', 'webservice'),
|
|
array('href' => $url));
|
|
$row[1] = "";
|
|
$row[2] = get_string('testauserwithtestclientdescription', 'webservice');
|
|
$table->data[] = $row;
|
|
|
|
$return .= html_writer::table($table);
|
|
|
|
return highlight($query, $return);
|
|
}
|
|
|
|
}
|
|
|
|
|
|
/**
|
|
* Special class for web service protocol administration.
|
|
*
|
|
* @author Petr Skoda (skodak)
|
|
*/
|
|
class admin_setting_managewebserviceprotocols extends admin_setting {
|
|
|
|
/**
|
|
* Calls parent::__construct with specific arguments
|
|
*/
|
|
public function __construct() {
|
|
$this->nosave = true;
|
|
parent::__construct('webservicesui', get_string('manageprotocols', 'webservice'), '', '');
|
|
}
|
|
|
|
/**
|
|
* Always returns true, does nothing
|
|
*
|
|
* @return true
|
|
*/
|
|
public function get_setting() {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Always returns true, does nothing
|
|
*
|
|
* @return true
|
|
*/
|
|
public function get_defaultsetting() {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Always returns '', does not write anything
|
|
*
|
|
* @return string Always returns ''
|
|
*/
|
|
public function write_setting($data) {
|
|
// do not write any setting
|
|
return '';
|
|
}
|
|
|
|
/**
|
|
* Checks if $query is one of the available webservices
|
|
*
|
|
* @param string $query The string to search for
|
|
* @return bool Returns true if found, false if not
|
|
*/
|
|
public function is_related($query) {
|
|
if (parent::is_related($query)) {
|
|
return true;
|
|
}
|
|
|
|
$protocols = get_plugin_list('webservice');
|
|
foreach ($protocols as $protocol=>$location) {
|
|
if (strpos($protocol, $query) !== false) {
|
|
return true;
|
|
}
|
|
$protocolstr = get_string('pluginname', 'webservice_'.$protocol);
|
|
if (strpos(textlib::strtolower($protocolstr), $query) !== false) {
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Builds the XHTML to display the control
|
|
*
|
|
* @param string $data Unused
|
|
* @param string $query
|
|
* @return string
|
|
*/
|
|
public function output_html($data, $query='') {
|
|
global $CFG, $OUTPUT;
|
|
|
|
// display strings
|
|
$stradministration = get_string('administration');
|
|
$strsettings = get_string('settings');
|
|
$stredit = get_string('edit');
|
|
$strprotocol = get_string('protocol', 'webservice');
|
|
$strenable = get_string('enable');
|
|
$strdisable = get_string('disable');
|
|
$strversion = get_string('version');
|
|
|
|
$protocols_available = get_plugin_list('webservice');
|
|
$active_protocols = empty($CFG->webserviceprotocols) ? array() : explode(',', $CFG->webserviceprotocols);
|
|
ksort($protocols_available);
|
|
|
|
foreach ($active_protocols as $key=>$protocol) {
|
|
if (empty($protocols_available[$protocol])) {
|
|
unset($active_protocols[$key]);
|
|
}
|
|
}
|
|
|
|
$return = $OUTPUT->heading(get_string('actwebserviceshhdr', 'webservice'), 3, 'main');
|
|
$return .= $OUTPUT->box_start('generalbox webservicesui');
|
|
|
|
$table = new html_table();
|
|
$table->head = array($strprotocol, $strversion, $strenable, $strsettings);
|
|
$table->colclasses = array('leftalign', 'centeralign', 'centeralign', 'centeralign', 'centeralign');
|
|
$table->id = 'webserviceprotocols';
|
|
$table->attributes['class'] = 'admintable generaltable';
|
|
$table->data = array();
|
|
|
|
// iterate through auth plugins and add to the display table
|
|
$url = "$CFG->wwwroot/$CFG->admin/webservice/protocols.php?sesskey=" . sesskey();
|
|
foreach ($protocols_available as $protocol => $location) {
|
|
$name = get_string('pluginname', 'webservice_'.$protocol);
|
|
|
|
$plugin = new stdClass();
|
|
if (file_exists($CFG->dirroot.'/webservice/'.$protocol.'/version.php')) {
|
|
include($CFG->dirroot.'/webservice/'.$protocol.'/version.php');
|
|
}
|
|
$version = isset($plugin->version) ? $plugin->version : '';
|
|
|
|
// hide/show link
|
|
if (in_array($protocol, $active_protocols)) {
|
|
$hideshow = "<a href=\"$url&action=disable&webservice=$protocol\">";
|
|
$hideshow .= "<img src=\"" . $OUTPUT->pix_url('t/hide') . "\" class=\"iconsmall\" alt=\"$strdisable\" /></a>";
|
|
$displayname = "<span>$name</span>";
|
|
} else {
|
|
$hideshow = "<a href=\"$url&action=enable&webservice=$protocol\">";
|
|
$hideshow .= "<img src=\"" . $OUTPUT->pix_url('t/show') . "\" class=\"iconsmall\" alt=\"$strenable\" /></a>";
|
|
$displayname = "<span class=\"dimmed_text\">$name</span>";
|
|
}
|
|
|
|
// settings link
|
|
if (file_exists($CFG->dirroot.'/webservice/'.$protocol.'/settings.php')) {
|
|
$settings = "<a href=\"settings.php?section=webservicesetting$protocol\">$strsettings</a>";
|
|
} else {
|
|
$settings = '';
|
|
}
|
|
|
|
// add a row to the table
|
|
$table->data[] = array($displayname, $version, $hideshow, $settings);
|
|
}
|
|
$return .= html_writer::table($table);
|
|
$return .= get_string('configwebserviceplugins', 'webservice');
|
|
$return .= $OUTPUT->box_end();
|
|
|
|
return highlight($query, $return);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Special class for web service token administration.
|
|
*
|
|
* @author Jerome Mouneyrac
|
|
*/
|
|
class admin_setting_managewebservicetokens extends admin_setting {
|
|
|
|
/**
|
|
* Calls parent::__construct with specific arguments
|
|
*/
|
|
public function __construct() {
|
|
$this->nosave = true;
|
|
parent::__construct('webservicestokenui', get_string('managetokens', 'webservice'), '', '');
|
|
}
|
|
|
|
/**
|
|
* Always returns true, does nothing
|
|
*
|
|
* @return true
|
|
*/
|
|
public function get_setting() {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Always returns true, does nothing
|
|
*
|
|
* @return true
|
|
*/
|
|
public function get_defaultsetting() {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Always returns '', does not write anything
|
|
*
|
|
* @return string Always returns ''
|
|
*/
|
|
public function write_setting($data) {
|
|
// do not write any setting
|
|
return '';
|
|
}
|
|
|
|
/**
|
|
* Builds the XHTML to display the control
|
|
*
|
|
* @param string $data Unused
|
|
* @param string $query
|
|
* @return string
|
|
*/
|
|
public function output_html($data, $query='') {
|
|
global $CFG, $OUTPUT, $DB, $USER;
|
|
|
|
// display strings
|
|
$stroperation = get_string('operation', 'webservice');
|
|
$strtoken = get_string('token', 'webservice');
|
|
$strservice = get_string('service', 'webservice');
|
|
$struser = get_string('user');
|
|
$strcontext = get_string('context', 'webservice');
|
|
$strvaliduntil = get_string('validuntil', 'webservice');
|
|
$striprestriction = get_string('iprestriction', 'webservice');
|
|
|
|
$return = $OUTPUT->box_start('generalbox webservicestokenui');
|
|
|
|
$table = new html_table();
|
|
$table->head = array($strtoken, $struser, $strservice, $striprestriction, $strvaliduntil, $stroperation);
|
|
$table->colclasses = array('leftalign', 'leftalign', 'leftalign', 'centeralign', 'centeralign', 'centeralign');
|
|
$table->id = 'webservicetokens';
|
|
$table->attributes['class'] = 'admintable generaltable';
|
|
$table->data = array();
|
|
|
|
$tokenpageurl = "$CFG->wwwroot/$CFG->admin/webservice/tokens.php?sesskey=" . sesskey();
|
|
|
|
//TODO: in order to let the administrator delete obsolete token, split this request in multiple request or use LEFT JOIN
|
|
|
|
//here retrieve token list (including linked users firstname/lastname and linked services name)
|
|
$sql = "SELECT t.id, t.token, u.id AS userid, u.firstname, u.lastname, s.name, t.iprestriction, t.validuntil, s.id AS serviceid
|
|
FROM {external_tokens} t, {user} u, {external_services} s
|
|
WHERE t.creatorid=? AND t.tokentype = ? AND s.id = t.externalserviceid AND t.userid = u.id";
|
|
$tokens = $DB->get_records_sql($sql, array($USER->id, EXTERNAL_TOKEN_PERMANENT));
|
|
if (!empty($tokens)) {
|
|
foreach ($tokens as $token) {
|
|
//TODO: retrieve context
|
|
|
|
$delete = "<a href=\"".$tokenpageurl."&action=delete&tokenid=".$token->id."\">";
|
|
$delete .= get_string('delete')."</a>";
|
|
|
|
$validuntil = '';
|
|
if (!empty($token->validuntil)) {
|
|
$validuntil = userdate($token->validuntil, get_string('strftimedatetime', 'langconfig'));
|
|
}
|
|
|
|
$iprestriction = '';
|
|
if (!empty($token->iprestriction)) {
|
|
$iprestriction = $token->iprestriction;
|
|
}
|
|
|
|
$userprofilurl = new moodle_url('/user/profile.php?id='.$token->userid);
|
|
$useratag = html_writer::start_tag('a', array('href' => $userprofilurl));
|
|
$useratag .= $token->firstname." ".$token->lastname;
|
|
$useratag .= html_writer::end_tag('a');
|
|
|
|
//check user missing capabilities
|
|
require_once($CFG->dirroot . '/webservice/lib.php');
|
|
$webservicemanager = new webservice();
|
|
$usermissingcaps = $webservicemanager->get_missing_capabilities_by_users(
|
|
array(array('id' => $token->userid)), $token->serviceid);
|
|
|
|
if (!is_siteadmin($token->userid) and
|
|
array_key_exists($token->userid, $usermissingcaps)) {
|
|
$missingcapabilities = implode(', ',
|
|
$usermissingcaps[$token->userid]);
|
|
if (!empty($missingcapabilities)) {
|
|
$useratag .= html_writer::tag('div',
|
|
get_string('usermissingcaps', 'webservice',
|
|
$missingcapabilities)
|
|
. ' ' . $OUTPUT->help_icon('missingcaps', 'webservice'),
|
|
array('class' => 'missingcaps'));
|
|
}
|
|
}
|
|
|
|
$table->data[] = array($token->token, $useratag, $token->name, $iprestriction, $validuntil, $delete);
|
|
}
|
|
|
|
$return .= html_writer::table($table);
|
|
} else {
|
|
$return .= get_string('notoken', 'webservice');
|
|
}
|
|
|
|
$return .= $OUTPUT->box_end();
|
|
// add a token to the table
|
|
$return .= "<a href=\"".$tokenpageurl."&action=create\">";
|
|
$return .= get_string('add')."</a>";
|
|
|
|
return highlight($query, $return);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Colour picker
|
|
*
|
|
* @copyright 2010 Sam Hemelryk
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_configcolourpicker extends admin_setting {
|
|
|
|
/**
|
|
* Information for previewing the colour
|
|
*
|
|
* @var array|null
|
|
*/
|
|
protected $previewconfig = null;
|
|
|
|
/**
|
|
*
|
|
* @param string $name
|
|
* @param string $visiblename
|
|
* @param string $description
|
|
* @param string $defaultsetting
|
|
* @param array $previewconfig Array('selector'=>'.some .css .selector','style'=>'backgroundColor');
|
|
*/
|
|
public function __construct($name, $visiblename, $description, $defaultsetting, array $previewconfig=null) {
|
|
$this->previewconfig = $previewconfig;
|
|
parent::__construct($name, $visiblename, $description, $defaultsetting);
|
|
}
|
|
|
|
/**
|
|
* Return the setting
|
|
*
|
|
* @return mixed returns config if successful else null
|
|
*/
|
|
public function get_setting() {
|
|
return $this->config_read($this->name);
|
|
}
|
|
|
|
/**
|
|
* Saves the setting
|
|
*
|
|
* @param string $data
|
|
* @return bool
|
|
*/
|
|
public function write_setting($data) {
|
|
$data = $this->validate($data);
|
|
if ($data === false) {
|
|
return get_string('validateerror', 'admin');
|
|
}
|
|
return ($this->config_write($this->name, $data) ? '' : get_string('errorsetting', 'admin'));
|
|
}
|
|
|
|
/**
|
|
* Validates the colour that was entered by the user
|
|
*
|
|
* @param string $data
|
|
* @return string|false
|
|
*/
|
|
protected function validate($data) {
|
|
/**
|
|
* List of valid HTML colour names
|
|
*
|
|
* @var array
|
|
*/
|
|
$colornames = array(
|
|
'aliceblue', 'antiquewhite', 'aqua', 'aquamarine', 'azure',
|
|
'beige', 'bisque', 'black', 'blanchedalmond', 'blue',
|
|
'blueviolet', 'brown', 'burlywood', 'cadetblue', 'chartreuse',
|
|
'chocolate', 'coral', 'cornflowerblue', 'cornsilk', 'crimson',
|
|
'cyan', 'darkblue', 'darkcyan', 'darkgoldenrod', 'darkgray',
|
|
'darkgrey', 'darkgreen', 'darkkhaki', 'darkmagenta',
|
|
'darkolivegreen', 'darkorange', 'darkorchid', 'darkred',
|
|
'darksalmon', 'darkseagreen', 'darkslateblue', 'darkslategray',
|
|
'darkslategrey', 'darkturquoise', 'darkviolet', 'deeppink',
|
|
'deepskyblue', 'dimgray', 'dimgrey', 'dodgerblue', 'firebrick',
|
|
'floralwhite', 'forestgreen', 'fuchsia', 'gainsboro',
|
|
'ghostwhite', 'gold', 'goldenrod', 'gray', 'grey', 'green',
|
|
'greenyellow', 'honeydew', 'hotpink', 'indianred', 'indigo',
|
|
'ivory', 'khaki', 'lavender', 'lavenderblush', 'lawngreen',
|
|
'lemonchiffon', 'lightblue', 'lightcoral', 'lightcyan',
|
|
'lightgoldenrodyellow', 'lightgray', 'lightgrey', 'lightgreen',
|
|
'lightpink', 'lightsalmon', 'lightseagreen', 'lightskyblue',
|
|
'lightslategray', 'lightslategrey', 'lightsteelblue', 'lightyellow',
|
|
'lime', 'limegreen', 'linen', 'magenta', 'maroon',
|
|
'mediumaquamarine', 'mediumblue', 'mediumorchid', 'mediumpurple',
|
|
'mediumseagreen', 'mediumslateblue', 'mediumspringgreen',
|
|
'mediumturquoise', 'mediumvioletred', 'midnightblue', 'mintcream',
|
|
'mistyrose', 'moccasin', 'navajowhite', 'navy', 'oldlace', 'olive',
|
|
'olivedrab', 'orange', 'orangered', 'orchid', 'palegoldenrod',
|
|
'palegreen', 'paleturquoise', 'palevioletred', 'papayawhip',
|
|
'peachpuff', 'peru', 'pink', 'plum', 'powderblue', 'purple', 'red',
|
|
'rosybrown', 'royalblue', 'saddlebrown', 'salmon', 'sandybrown',
|
|
'seagreen', 'seashell', 'sienna', 'silver', 'skyblue', 'slateblue',
|
|
'slategray', 'slategrey', 'snow', 'springgreen', 'steelblue', 'tan',
|
|
'teal', 'thistle', 'tomato', 'turquoise', 'violet', 'wheat', 'white',
|
|
'whitesmoke', 'yellow', 'yellowgreen'
|
|
);
|
|
|
|
if (preg_match('/^#?([[:xdigit:]]{3}){1,2}$/', $data)) {
|
|
if (strpos($data, '#')!==0) {
|
|
$data = '#'.$data;
|
|
}
|
|
return $data;
|
|
} else if (in_array(strtolower($data), $colornames)) {
|
|
return $data;
|
|
} else if (preg_match('/rgb\(\d{0,3}%?\, ?\d{0,3}%?, ?\d{0,3}%?\)/i', $data)) {
|
|
return $data;
|
|
} else if (preg_match('/rgba\(\d{0,3}%?\, ?\d{0,3}%?, ?\d{0,3}%?\, ?\d(\.\d)?\)/i', $data)) {
|
|
return $data;
|
|
} else if (preg_match('/hsl\(\d{0,3}\, ?\d{0,3}%, ?\d{0,3}%\)/i', $data)) {
|
|
return $data;
|
|
} else if (preg_match('/hsla\(\d{0,3}\, ?\d{0,3}%,\d{0,3}%\, ?\d(\.\d)?\)/i', $data)) {
|
|
return $data;
|
|
} else if (($data == 'transparent') || ($data == 'currentColor') || ($data == 'inherit')) {
|
|
return $data;
|
|
} else if (empty($data)) {
|
|
return $this->defaultsetting;
|
|
} else {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Generates the HTML for the setting
|
|
*
|
|
* @global moodle_page $PAGE
|
|
* @global core_renderer $OUTPUT
|
|
* @param string $data
|
|
* @param string $query
|
|
*/
|
|
public function output_html($data, $query = '') {
|
|
global $PAGE, $OUTPUT;
|
|
$PAGE->requires->js_init_call('M.util.init_colour_picker', array($this->get_id(), $this->previewconfig));
|
|
$content = html_writer::start_tag('div', array('class'=>'form-colourpicker defaultsnext'));
|
|
$content .= html_writer::tag('div', $OUTPUT->pix_icon('i/loading', get_string('loading', 'admin'), 'moodle', array('class'=>'loadingicon')), array('class'=>'admin_colourpicker clearfix'));
|
|
$content .= html_writer::empty_tag('input', array('type'=>'text','id'=>$this->get_id(), 'name'=>$this->get_full_name(), 'value'=>$data, 'size'=>'12'));
|
|
if (!empty($this->previewconfig)) {
|
|
$content .= html_writer::empty_tag('input', array('type'=>'button','id'=>$this->get_id().'_preview', 'value'=>get_string('preview'), 'class'=>'admin_colourpicker_preview'));
|
|
}
|
|
$content .= html_writer::end_tag('div');
|
|
return format_admin_setting($this, $this->visiblename, $content, $this->description, false, '', $this->get_defaultsetting(), $query);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Class used for uploading of one file into file storage,
|
|
* the file name is stored in config table.
|
|
*
|
|
* Please note you need to implement your own '_pluginfile' callback function,
|
|
* this setting only stores the file, it does not deal with file serving.
|
|
*
|
|
* @copyright 2013 Petr Skoda {@link http://skodak.org}
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_configstoredfile extends admin_setting {
|
|
/** @var array file area options - should be one file only */
|
|
protected $options;
|
|
/** @var string name of the file area */
|
|
protected $filearea;
|
|
/** @var int intemid */
|
|
protected $itemid;
|
|
/** @var string used for detection of changes */
|
|
protected $oldhashes;
|
|
|
|
/**
|
|
* Create new stored file setting.
|
|
*
|
|
* @param string $name low level setting name
|
|
* @param string $visiblename human readable setting name
|
|
* @param string $description description of setting
|
|
* @param mixed $filearea file area for file storage
|
|
* @param int $itemid itemid for file storage
|
|
* @param array $options file area options
|
|
*/
|
|
public function __construct($name, $visiblename, $description, $filearea, $itemid = 0, array $options = null) {
|
|
parent::__construct($name, $visiblename, $description, '');
|
|
$this->filearea = $filearea;
|
|
$this->itemid = $itemid;
|
|
$this->options = (array)$options;
|
|
}
|
|
|
|
/**
|
|
* Applies defaults and returns all options.
|
|
* @return array
|
|
*/
|
|
protected function get_options() {
|
|
global $CFG;
|
|
|
|
require_once("$CFG->libdir/filelib.php");
|
|
require_once("$CFG->dirroot/repository/lib.php");
|
|
$defaults = array(
|
|
'mainfile' => '', 'subdirs' => 0, 'maxbytes' => -1, 'maxfiles' => 1,
|
|
'accepted_types' => '*', 'return_types' => FILE_INTERNAL, 'areamaxbytes' => FILE_AREA_MAX_BYTES_UNLIMITED,
|
|
'context' => context_system::instance());
|
|
foreach($this->options as $k => $v) {
|
|
$defaults[$k] = $v;
|
|
}
|
|
|
|
return $defaults;
|
|
}
|
|
|
|
public function get_setting() {
|
|
return $this->config_read($this->name);
|
|
}
|
|
|
|
public function write_setting($data) {
|
|
global $USER;
|
|
|
|
// Let's not deal with validation here, this is for admins only.
|
|
$current = $this->get_setting();
|
|
if (empty($data)) {
|
|
// Most probably applying default settings.
|
|
if ($current === null) {
|
|
return ($this->config_write($this->name, '') ? '' : get_string('errorsetting', 'admin'));
|
|
}
|
|
return '';
|
|
} else if (!is_number($data)) {
|
|
// Draft item id is expected here!
|
|
return get_string('errorsetting', 'admin');
|
|
}
|
|
|
|
$options = $this->get_options();
|
|
$fs = get_file_storage();
|
|
$component = is_null($this->plugin) ? 'core' : $this->plugin;
|
|
|
|
$this->oldhashes = null;
|
|
if ($current) {
|
|
$hash = sha1('/'.$options['context']->id.'/'.$component.'/'.$this->filearea.'/'.$this->itemid.$current);
|
|
if ($file = $fs->get_file_by_hash($hash)) {
|
|
$this->oldhashes = $file->get_contenthash().$file->get_pathnamehash();
|
|
}
|
|
unset($file);
|
|
}
|
|
|
|
if ($fs->file_exists($options['context']->id, $component, $this->filearea, $this->itemid, '/', '.')) {
|
|
// Make sure the settings form was not open for more than 4 days and draft areas deleted in the meantime.
|
|
$usercontext = context_user::instance($USER->id);
|
|
if (!$fs->file_exists($usercontext->id, 'user', 'draft', $data, '/', '.')) {
|
|
return get_string('errorsetting', 'admin');
|
|
}
|
|
}
|
|
|
|
file_save_draft_area_files($data, $options['context']->id, $component, $this->filearea, $this->itemid, $options);
|
|
$files = $fs->get_area_files($options['context']->id, $component, $this->filearea, $this->itemid, 'sortorder,filepath,filename', false);
|
|
|
|
$filepath = '';
|
|
if ($files) {
|
|
/** @var stored_file $file */
|
|
$file = reset($files);
|
|
$filepath = $file->get_filepath().$file->get_filename();
|
|
}
|
|
|
|
return ($this->config_write($this->name, $filepath) ? '' : get_string('errorsetting', 'admin'));
|
|
}
|
|
|
|
public function post_write_settings($original) {
|
|
$options = $this->get_options();
|
|
$fs = get_file_storage();
|
|
$component = is_null($this->plugin) ? 'core' : $this->plugin;
|
|
|
|
$current = $this->get_setting();
|
|
$newhashes = null;
|
|
if ($current) {
|
|
$hash = sha1('/'.$options['context']->id.'/'.$component.'/'.$this->filearea.'/'.$this->itemid.$current);
|
|
if ($file = $fs->get_file_by_hash($hash)) {
|
|
$newhashes = $file->get_contenthash().$file->get_pathnamehash();
|
|
}
|
|
unset($file);
|
|
}
|
|
|
|
if ($this->oldhashes === $newhashes) {
|
|
$this->oldhashes = null;
|
|
return false;
|
|
}
|
|
$this->oldhashes = null;
|
|
|
|
$callbackfunction = $this->updatedcallback;
|
|
if (!empty($callbackfunction) and function_exists($callbackfunction)) {
|
|
$callbackfunction($this->get_full_name());
|
|
}
|
|
return true;
|
|
}
|
|
|
|
public function output_html($data, $query = '') {
|
|
global $PAGE, $CFG;
|
|
|
|
$options = $this->get_options();
|
|
$id = $this->get_id();
|
|
$elname = $this->get_full_name();
|
|
$draftitemid = file_get_submitted_draft_itemid($elname);
|
|
$component = is_null($this->plugin) ? 'core' : $this->plugin;
|
|
file_prepare_draft_area($draftitemid, $options['context']->id, $component, $this->filearea, $this->itemid, $options);
|
|
|
|
// Filemanager form element implementation is far from optimal, we need to rework this if we ever fix it...
|
|
require_once("$CFG->dirroot/lib/form/filemanager.php");
|
|
|
|
$fmoptions = new stdClass();
|
|
$fmoptions->mainfile = $options['mainfile'];
|
|
$fmoptions->maxbytes = $options['maxbytes'];
|
|
$fmoptions->maxfiles = $options['maxfiles'];
|
|
$fmoptions->client_id = uniqid();
|
|
$fmoptions->itemid = $draftitemid;
|
|
$fmoptions->subdirs = $options['subdirs'];
|
|
$fmoptions->target = $id;
|
|
$fmoptions->accepted_types = $options['accepted_types'];
|
|
$fmoptions->return_types = $options['return_types'];
|
|
$fmoptions->context = $options['context'];
|
|
$fmoptions->areamaxbytes = $options['areamaxbytes'];
|
|
|
|
$fm = new form_filemanager($fmoptions);
|
|
$output = $PAGE->get_renderer('core', 'files');
|
|
$html = $output->render($fm);
|
|
|
|
$html .= '<input value="'.$draftitemid.'" name="'.$elname.'" type="hidden" />';
|
|
$html .= '<input value="" id="'.$id.'" type="hidden" />';
|
|
|
|
return format_admin_setting($this, $this->visiblename,
|
|
'<div class="form-filemanager">'.$html.'</div>', $this->description, true, '', '', $query);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Administration interface for user specified regular expressions for device detection.
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_devicedetectregex extends admin_setting {
|
|
|
|
/**
|
|
* Calls parent::__construct with specific args
|
|
*
|
|
* @param string $name
|
|
* @param string $visiblename
|
|
* @param string $description
|
|
* @param mixed $defaultsetting
|
|
*/
|
|
public function __construct($name, $visiblename, $description, $defaultsetting = '') {
|
|
global $CFG;
|
|
parent::__construct($name, $visiblename, $description, $defaultsetting);
|
|
}
|
|
|
|
/**
|
|
* Return the current setting(s)
|
|
*
|
|
* @return array Current settings array
|
|
*/
|
|
public function get_setting() {
|
|
global $CFG;
|
|
|
|
$config = $this->config_read($this->name);
|
|
if (is_null($config)) {
|
|
return null;
|
|
}
|
|
|
|
return $this->prepare_form_data($config);
|
|
}
|
|
|
|
/**
|
|
* Save selected settings
|
|
*
|
|
* @param array $data Array of settings to save
|
|
* @return bool
|
|
*/
|
|
public function write_setting($data) {
|
|
if (empty($data)) {
|
|
$data = array();
|
|
}
|
|
|
|
if ($this->config_write($this->name, $this->process_form_data($data))) {
|
|
return ''; // success
|
|
} else {
|
|
return get_string('errorsetting', 'admin') . $this->visiblename . html_writer::empty_tag('br');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Return XHTML field(s) for regexes
|
|
*
|
|
* @param array $data Array of options to set in HTML
|
|
* @return string XHTML string for the fields and wrapping div(s)
|
|
*/
|
|
public function output_html($data, $query='') {
|
|
global $OUTPUT;
|
|
|
|
$out = html_writer::start_tag('table', array('border' => 1, 'class' => 'generaltable'));
|
|
$out .= html_writer::start_tag('thead');
|
|
$out .= html_writer::start_tag('tr');
|
|
$out .= html_writer::tag('th', get_string('devicedetectregexexpression', 'admin'));
|
|
$out .= html_writer::tag('th', get_string('devicedetectregexvalue', 'admin'));
|
|
$out .= html_writer::end_tag('tr');
|
|
$out .= html_writer::end_tag('thead');
|
|
$out .= html_writer::start_tag('tbody');
|
|
|
|
if (empty($data)) {
|
|
$looplimit = 1;
|
|
} else {
|
|
$looplimit = (count($data)/2)+1;
|
|
}
|
|
|
|
for ($i=0; $i<$looplimit; $i++) {
|
|
$out .= html_writer::start_tag('tr');
|
|
|
|
$expressionname = 'expression'.$i;
|
|
|
|
if (!empty($data[$expressionname])){
|
|
$expression = $data[$expressionname];
|
|
} else {
|
|
$expression = '';
|
|
}
|
|
|
|
$out .= html_writer::tag('td',
|
|
html_writer::empty_tag('input',
|
|
array(
|
|
'type' => 'text',
|
|
'class' => 'form-text',
|
|
'name' => $this->get_full_name().'[expression'.$i.']',
|
|
'value' => $expression,
|
|
)
|
|
), array('class' => 'c'.$i)
|
|
);
|
|
|
|
$valuename = 'value'.$i;
|
|
|
|
if (!empty($data[$valuename])){
|
|
$value = $data[$valuename];
|
|
} else {
|
|
$value= '';
|
|
}
|
|
|
|
$out .= html_writer::tag('td',
|
|
html_writer::empty_tag('input',
|
|
array(
|
|
'type' => 'text',
|
|
'class' => 'form-text',
|
|
'name' => $this->get_full_name().'[value'.$i.']',
|
|
'value' => $value,
|
|
)
|
|
), array('class' => 'c'.$i)
|
|
);
|
|
|
|
$out .= html_writer::end_tag('tr');
|
|
}
|
|
|
|
$out .= html_writer::end_tag('tbody');
|
|
$out .= html_writer::end_tag('table');
|
|
|
|
return format_admin_setting($this, $this->visiblename, $out, $this->description, false, '', null, $query);
|
|
}
|
|
|
|
/**
|
|
* Converts the string of regexes
|
|
*
|
|
* @see self::process_form_data()
|
|
* @param $regexes string of regexes
|
|
* @return array of form fields and their values
|
|
*/
|
|
protected function prepare_form_data($regexes) {
|
|
|
|
$regexes = json_decode($regexes);
|
|
|
|
$form = array();
|
|
|
|
$i = 0;
|
|
|
|
foreach ($regexes as $value => $regex) {
|
|
$expressionname = 'expression'.$i;
|
|
$valuename = 'value'.$i;
|
|
|
|
$form[$expressionname] = $regex;
|
|
$form[$valuename] = $value;
|
|
$i++;
|
|
}
|
|
|
|
return $form;
|
|
}
|
|
|
|
/**
|
|
* Converts the data from admin settings form into a string of regexes
|
|
*
|
|
* @see self::prepare_form_data()
|
|
* @param array $data array of admin form fields and values
|
|
* @return false|string of regexes
|
|
*/
|
|
protected function process_form_data(array $form) {
|
|
|
|
$count = count($form); // number of form field values
|
|
|
|
if ($count % 2) {
|
|
// we must get five fields per expression
|
|
return false;
|
|
}
|
|
|
|
$regexes = array();
|
|
for ($i = 0; $i < $count / 2; $i++) {
|
|
$expressionname = "expression".$i;
|
|
$valuename = "value".$i;
|
|
|
|
$expression = trim($form['expression'.$i]);
|
|
$value = trim($form['value'.$i]);
|
|
|
|
if (empty($expression)){
|
|
continue;
|
|
}
|
|
|
|
$regexes[$value] = $expression;
|
|
}
|
|
|
|
$regexes = json_encode($regexes);
|
|
|
|
return $regexes;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Multiselect for current modules
|
|
*
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class admin_setting_configmultiselect_modules extends admin_setting_configmultiselect {
|
|
private $excludesystem;
|
|
|
|
/**
|
|
* Calls parent::__construct - note array $choices is not required
|
|
*
|
|
* @param string $name setting name
|
|
* @param string $visiblename localised setting name
|
|
* @param string $description setting description
|
|
* @param array $defaultsetting a plain array of default module ids
|
|
* @param bool $excludesystem If true, excludes modules with 'system' archetype
|
|
*/
|
|
public function __construct($name, $visiblename, $description, $defaultsetting = array(),
|
|
$excludesystem = true) {
|
|
parent::__construct($name, $visiblename, $description, $defaultsetting, null);
|
|
$this->excludesystem = $excludesystem;
|
|
}
|
|
|
|
/**
|
|
* Loads an array of current module choices
|
|
*
|
|
* @return bool always return true
|
|
*/
|
|
public function load_choices() {
|
|
if (is_array($this->choices)) {
|
|
return true;
|
|
}
|
|
$this->choices = array();
|
|
|
|
global $CFG, $DB;
|
|
$records = $DB->get_records('modules', array('visible'=>1), 'name');
|
|
foreach ($records as $record) {
|
|
// Exclude modules if the code doesn't exist
|
|
if (file_exists("$CFG->dirroot/mod/$record->name/lib.php")) {
|
|
// Also exclude system modules (if specified)
|
|
if (!($this->excludesystem &&
|
|
plugin_supports('mod', $record->name, FEATURE_MOD_ARCHETYPE) ===
|
|
MOD_ARCHETYPE_SYSTEM)) {
|
|
$this->choices[$record->id] = $record->name;
|
|
}
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
}
|