[Summary view]

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 401 and 402] [Versions 401 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;
  27  
  28  defined('MOODLE_INTERNAL') || die();
  29  
  30  /**
  31   * Class for messaging processors
  32   */
  33  class message 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          return $DB->get_records_menu('message_processors', array('enabled'=>1), 'name ASC', 'name, name AS val');
  41      }
  42  
  43      public static function enable_plugin(string $pluginname, int $enabled): bool {
  44          global $DB;
  45  
  46          if (!$plugin = $DB->get_record('message_processors', ['name' => $pluginname])) {
  47              throw new \moodle_exception('invalidplugin', 'message', '', $pluginname);
  48          }
  49  
  50          $haschanged = false;
  51  
  52          // Only set visibility if it's different from the current value.
  53          if ($plugin->enabled != $enabled) {
  54              $haschanged = true;
  55              $processor = \core_message\api::get_processed_processor_object($plugin);
  56  
  57              // Include this information into config changes table.
  58              add_to_config_log($processor->name, $processor->enabled, $enabled, 'core');
  59  
  60              // Save processor enabled/disabled status.
  61              \core_message\api::update_processor_status($processor, $enabled);
  62          }
  63  
  64          return $haschanged;
  65      }
  66  
  67      public function get_settings_section_name() {
  68          return 'messagesetting' . $this->name;
  69      }
  70  
  71      public function load_settings(part_of_admin_tree $adminroot, $parentnodename, $hassiteconfig) {
  72          global $CFG, $USER, $DB, $OUTPUT, $PAGE; // In case settings.php wants to refer to them.
  73          $ADMIN = $adminroot; // May be used in settings.php.
  74          $plugininfo = $this; // Also can be used inside settings.php.
  75  
  76          if (!$this->is_installed_and_upgraded()) {
  77              return;
  78          }
  79  
  80          if (!$hassiteconfig) {
  81              return;
  82          }
  83          $section = $this->get_settings_section_name();
  84  
  85          $settings = null;
  86          $processors = get_message_processors();
  87          if (isset($processors[$this->name])) {
  88              $processor = $processors[$this->name];
  89              if ($processor->available && $processor->hassettings) {
  90                  $settings = new admin_settingpage($section, $this->displayname,
  91                      'moodle/site:config', $this->is_enabled() === false);
  92                  include($this->full_path('settings.php')); // This may also set $settings to null.
  93              }
  94          }
  95          if ($settings) {
  96              $ADMIN->add($parentnodename, $settings);
  97          }
  98      }
  99  
 100      /**
 101       * Return URL used for management of plugins of this type.
 102       * @return moodle_url
 103       */
 104      public static function get_manage_url() {
 105          return new moodle_url('/admin/message.php');
 106      }
 107  
 108      public function is_uninstall_allowed() {
 109          return true;
 110      }
 111  
 112      /**
 113       * Pre-uninstall hook.
 114       *
 115       * This is intended for disabling of plugin, some DB table purging, etc.
 116       *
 117       * NOTE: to be called from uninstall_plugin() only.
 118       * @private
 119       */
 120      public function uninstall_cleanup() {
 121          global $CFG;
 122  
 123          require_once($CFG->libdir.'/messagelib.php');
 124          message_processor_uninstall($this->name);
 125  
 126          parent::uninstall_cleanup();
 127      }
 128  }