[Summary view] [Print] [Text view]

   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 <[email protected]>
  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 course formats
  32   */
  33  class format 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('format');
  42          if (!$plugins) {
  43              return array();
  44          }
  45          $installed = array();
  46          foreach ($plugins as $plugin => $version) {
  47              $installed[] = 'format_'.$plugin;
  48          }
  49  
  50          list($installed, $params) = $DB->get_in_or_equal($installed, SQL_PARAMS_NAMED);
  51          $disabled = $DB->get_records_select('config_plugins', "plugin $installed AND name = 'disabled'", $params, 'plugin ASC');
  52          foreach ($disabled as $conf) {
  53              if (empty($conf->value)) {
  54                  continue;
  55              }
  56              list($type, $name) = explode('_', $conf->plugin, 2);
  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      /**
  69       * Gathers and returns the information about all plugins of the given type
  70       *
  71       * @param string $type the name of the plugintype, eg. mod, auth or workshopform
  72       * @param string $typerootdir full path to the location of the plugin dir
  73       * @param string $typeclass the name of the actually called class
  74       * @return array of plugintype classes, indexed by the plugin name
  75       */
  76      public static function get_plugins($type, $typerootdir, $typeclass) {
  77          global $CFG;
  78          $formats = parent::get_plugins($type, $typerootdir, $typeclass);
  79          require_once($CFG->dirroot.'/course/lib.php');
  80          $order = get_sorted_course_formats();
  81          $sortedformats = array();
  82          foreach ($order as $formatname) {
  83              $sortedformats[$formatname] = $formats[$formatname];
  84          }
  85          return $sortedformats;
  86      }
  87  
  88      public function get_settings_section_name() {
  89          return 'formatsetting' . $this->name;
  90      }
  91  
  92      public function load_settings(part_of_admin_tree $adminroot, $parentnodename, $hassiteconfig) {
  93          global $CFG, $USER, $DB, $OUTPUT, $PAGE; // In case settings.php wants to refer to them.
  94          $ADMIN = $adminroot; // May be used in settings.php.
  95          $plugininfo = $this; // Also can be used inside settings.php.
  96  
  97          if (!$this->is_installed_and_upgraded()) {
  98              return;
  99          }
 100  
 101          if (!$hassiteconfig or !file_exists($this->full_path('settings.php'))) {
 102              return;
 103          }
 104  
 105          $section = $this->get_settings_section_name();
 106  
 107          $settings = new admin_settingpage($section, $this->displayname, 'moodle/site:config', $this->is_enabled() === false);
 108          include($this->full_path('settings.php')); // This may also set $settings to null.
 109  
 110          if ($settings) {
 111              $ADMIN->add($parentnodename, $settings);
 112          }
 113      }
 114  
 115      public function is_uninstall_allowed() {
 116          if ($this->name !== get_config('moodlecourse', 'format') && $this->name !== 'site') {
 117              return true;
 118          } else {
 119              return false;
 120          }
 121      }
 122  
 123      /**
 124       * Return URL used for management of plugins of this type.
 125       * @return moodle_url
 126       */
 127      public static function get_manage_url() {
 128          return new moodle_url('/admin/settings.php', array('section'=>'manageformats'));
 129      }
 130  
 131      public function get_uninstall_extra_warning() {
 132          global $DB;
 133  
 134          $coursecount = $DB->count_records('course', array('format' => $this->name));
 135  
 136          if (!$coursecount) {
 137              return '';
 138          }
 139  
 140          $defaultformat = $this->get_plugin_manager()->plugin_name('format_'.get_config('moodlecourse', 'format'));
 141          $message = get_string(
 142              'formatuninstallwithcourses', 'core_admin',
 143              (object)array('count' => $coursecount, 'format' => $this->displayname,
 144                  'defaultformat' => $defaultformat));
 145  
 146          return $message;
 147      }
 148  
 149      /**
 150       * Pre-uninstall hook.
 151       *
 152       * This is intended for disabling of plugin, some DB table purging, etc.
 153       *
 154       * NOTE: to be called from uninstall_plugin() only.
 155       * @private
 156       */
 157      public function uninstall_cleanup() {
 158          global $DB;
 159  
 160          if (($defaultformat = get_config('moodlecourse', 'format')) && $defaultformat !== $this->name) {
 161              $courses = $DB->get_records('course', array('format' => $this->name), 'id');
 162              $data = (object)array('id' => null, 'format' => $defaultformat);
 163              foreach ($courses as $record) {
 164                  $data->id = $record->id;
 165                  update_course($data);
 166              }
 167          }
 168  
 169          $DB->delete_records('course_format_options', array('format' => $this->name));
 170  
 171          parent::uninstall_cleanup();
 172      }
 173  }