[Summary view]

Differences Between: [Versions 310 and 400] [Versions 311 and 400] [Versions 39 and 400] [Versions 400 and 402] [Versions 400 and 403]

   1  <?php
   2  // This file is part of Moodle - http://moodle.org/
   3  //
   4  // Moodle is free software: you can redistribute it and/or modify
   5  // it under the terms of the GNU General Public License as published by
   6  // the Free Software Foundation, either version 3 of the License, or
   7  // (at your option) any later version.
   8  //
   9  // Moodle is distributed in the hope that it will be useful,
  10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  // GNU General Public License for more details.
  13  //
  14  // You should have received a copy of the GNU General Public License
  15  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16  
  17  /**
  18   * Defines classes used for plugin info.
  19   *
  20   * @package    core
  21   * @copyright  2011 David Mudrak <david@moodle.com>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  namespace core\plugininfo;
  25  
  26  use moodle_url, part_of_admin_tree, admin_settingpage, core_plugin_manager;
  27  
  28  defined('MOODLE_INTERNAL') || die();
  29  
  30  /**
  31   * Class for question types
  32   */
  33  class qtype extends base {
  34      /**
  35       * Finds all enabled plugins, the result may include missing plugins.
  36       * @return array|null of enabled plugins $pluginname=>$pluginname, null means unknown
  37       */
  38      public static function get_enabled_plugins() {
  39          global $DB;
  40  
  41          $plugins = core_plugin_manager::instance()->get_installed_plugins('qtype');
  42          if (!$plugins) {
  43              return array();
  44          }
  45          $installed = array();
  46          foreach ($plugins as $plugin => $version) {
  47              $installed[] = $plugin.'_disabled';
  48          }
  49  
  50          list($installed, $params) = $DB->get_in_or_equal($installed, SQL_PARAMS_NAMED);
  51          $disabled = $DB->get_records_select('config_plugins', "name $installed AND plugin = 'question'", $params, 'plugin ASC');
  52          foreach ($disabled as $conf) {
  53              if (empty($conf->value)) {
  54                  continue;
  55              }
  56              $name = substr($conf->name, 0, -9);
  57              unset($plugins[$name]);
  58          }
  59  
  60          $enabled = array();
  61          foreach ($plugins as $plugin => $version) {
  62              $enabled[$plugin] = $plugin;
  63          }
  64  
  65          return $enabled;
  66      }
  67  
  68      public static function enable_plugin(string $pluginname, int $enabled): bool {
  69          $haschanged = false;
  70  
  71          $settingname = $pluginname . '_disabled';
  72          $oldvalue = get_config('question', $settingname);
  73          $disabled = !$enabled;
  74          // Only set value if there is no config setting or if the value is different from the previous one.
  75          if ($oldvalue == false && $disabled) {
  76              set_config($settingname, $disabled, 'question');
  77              $haschanged = true;
  78          } else if ($oldvalue != false && !$disabled) {
  79              unset_config($settingname, 'question');
  80              $haschanged = true;
  81          }
  82  
  83          if ($haschanged) {
  84              add_to_config_log($settingname, $oldvalue, $disabled, 'question');
  85              \core_plugin_manager::reset_caches();
  86          }
  87  
  88          return $haschanged;
  89      }
  90  
  91      public function is_uninstall_allowed() {
  92          global $DB;
  93  
  94          if ($this->name === 'missingtype') {
  95              // qtype_missingtype is used by the system. It cannot be uninstalled.
  96              return false;
  97          }
  98  
  99          return !$DB->record_exists('question', array('qtype' => $this->name));
 100      }
 101  
 102      /**
 103       * Return URL used for management of plugins of this type.
 104       * @return moodle_url
 105       */
 106      public static function get_manage_url() {
 107          return new moodle_url('/admin/qtypes.php');
 108      }
 109  
 110      /**
 111       * Pre-uninstall hook.
 112       *
 113       * This is intended for disabling of plugin, some DB table purging, etc.
 114       *
 115       * NOTE: to be called from uninstall_plugin() only.
 116       * @private
 117       */
 118      public function uninstall_cleanup() {
 119          // Delete any question configuration records mentioning this plugin.
 120          unset_config($this->name . '_disabled', 'question');
 121          unset_config($this->name . '_sortorder', 'question');
 122  
 123          parent::uninstall_cleanup();
 124      }
 125  
 126      public function get_settings_section_name() {
 127          return 'qtypesetting' . $this->name;
 128      }
 129  
 130      public function load_settings(part_of_admin_tree $adminroot, $parentnodename, $hassiteconfig) {
 131          global $CFG, $USER, $DB, $OUTPUT, $PAGE; // In case settings.php wants to refer to them.
 132          $ADMIN = $adminroot; // May be used in settings.php.
 133          $plugininfo = $this; // Also can be used inside settings.php.
 134          $qtype = $this;      // Also can be used inside settings.php.
 135  
 136          if (!$this->is_installed_and_upgraded()) {
 137              return;
 138          }
 139  
 140          $section = $this->get_settings_section_name();
 141  
 142          $settings = null;
 143          $systemcontext = \context_system::instance();
 144          if (($hassiteconfig || has_capability('moodle/question:config', $systemcontext)) &&
 145              file_exists($this->full_path('settings.php'))) {
 146              $settings = new admin_settingpage($section, $this->displayname,
 147                  'moodle/question:config', $this->is_enabled() === false);
 148              include($this->full_path('settings.php')); // This may also set $settings to null.
 149          }
 150          if ($settings) {
 151              $ADMIN->add($parentnodename, $settings);
 152          }
 153      }
 154  }