admin/plugins.php

   1 <?php
   2
   3 // This file is part of Moodle - http://moodle.org/
   4 //
   5 // Moodle is free software: you can redistribute it and/or modify
   6 // it under the terms of the GNU General Public License as published by
   7 // the Free Software Foundation, either version 3 of the License, or
   8 // (at your option) any later version.
   9 //
  10 // Moodle is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU General Public License
  16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 /**
  19  * UI for general plugins management
  20  *
  21  * @package    core
  22  * @subpackage admin
  23  * @copyright  2011 David Mudrak <david@moodle.com>
  24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  25  */
  26
  27 require_once(dirname(dirname(__FILE__)) . '/config.php');
  28 require_once($CFG->libdir . '/adminlib.php');
  29 require_once($CFG->libdir . '/filelib.php');
  30
  31 $fetchupdates = optional_param('fetchupdates', false, PARAM_BOOL); // Check for available plugins updates.
  32 $updatesonly = optional_param('updatesonly', false, PARAM_BOOL); // Show updateable plugins only.
  33 $contribonly = optional_param('contribonly', false, PARAM_BOOL); // Show additional plugins only.
  34 $uninstall = optional_param('uninstall', '', PARAM_COMPONENT); // Uninstall the plugin.
  35 $delete = optional_param('delete', '', PARAM_COMPONENT); // Delete the plugin folder after it is uninstalled.
  36 $confirmed = optional_param('confirm', false, PARAM_BOOL); // Confirm the uninstall/delete action.
  37 $return = optional_param('return', 'overview', PARAM_ALPHA); // Where to return after uninstall.
  38 $installupdate = optional_param('installupdate', null, PARAM_COMPONENT); // Install given available update.
  39 $installupdateversion = optional_param('installupdateversion', null, PARAM_INT); // Version of the available update to install.
  40 $installupdatex = optional_param('installupdatex', false, PARAM_BOOL); // Install all available plugin updates.
  41 $confirminstallupdate = optional_param('confirminstallupdate', false, PARAM_BOOL); // Available update(s) install confirmed?
  42
  43 // NOTE: do not use admin_externalpage_setup() here because it loads
  44 //       full admin tree which is not possible during uninstallation.
  45
  46 require_login();
  47 $syscontext = context_system::instance();
  48 require_capability('moodle/site:config', $syscontext);
  49
  50 // URL params we want to maintain on redirects.
  51 $pageparams = array('updatesonly' => $updatesonly, 'contribonly' => $contribonly);
  52 $pageurl = new moodle_url('/admin/plugins.php', $pageparams);
  53
  54 $pluginman = core_plugin_manager::instance();
  55
  56 if ($uninstall) {
  57     require_sesskey();
  58
  59     if (!$confirmed) {
  60         admin_externalpage_setup('pluginsoverview', '', $pageparams);
  61     } else {
  62         $PAGE->set_url($pageurl);
  63         $PAGE->set_context($syscontext);
  64         $PAGE->set_pagelayout('maintenance');
  65         $PAGE->set_popup_notification_allowed(false);
  66     }
  67
  68     /** @var core_admin_renderer $output */
  69     $output = $PAGE->get_renderer('core', 'admin');
  70
  71     $pluginfo = $pluginman->get_plugin_info($uninstall);
  72
  73     // Make sure we know the plugin.
  74     if (is_null($pluginfo)) {
  75         throw new moodle_exception('err_uninstalling_unknown_plugin', 'core_plugin', '', array('plugin' => $uninstall),
  76             'core_plugin_manager::get_plugin_info() returned null for the plugin to be uninstalled');
  77     }
  78
  79     $pluginname = $pluginman->plugin_name($pluginfo->component);
  80     $PAGE->set_title($pluginname);
  81     $PAGE->navbar->add(get_string('uninstalling', 'core_plugin', array('name' => $pluginname)));
  82
  83     if (!$pluginman->can_uninstall_plugin($pluginfo->component)) {
  84         throw new moodle_exception('err_cannot_uninstall_plugin', 'core_plugin', '',
  85             array('plugin' => $pluginfo->component),
  86             'core_plugin_manager::can_uninstall_plugin() returned false');
  87     }
  88
  89     if (!$confirmed) {
  90         $continueurl = new moodle_url($PAGE->url, array('uninstall' => $pluginfo->component, 'sesskey' => sesskey(), 'confirm' => 1, 'return'=>$return));
  91         $cancelurl = $pluginfo->get_return_url_after_uninstall($return);
  92         echo $output->plugin_uninstall_confirm_page($pluginman, $pluginfo, $continueurl, $cancelurl);
  93         exit();
  94
  95     } else {
  96         $SESSION->pluginuninstallreturn = $pluginfo->get_return_url_after_uninstall($return);
  97         $progress = new progress_trace_buffer(new text_progress_trace(), false);
  98         $pluginman->uninstall_plugin($pluginfo->component, $progress);
  99         $progress->finished();
 100
 101         if ($pluginman->is_plugin_folder_removable($pluginfo->component)) {
 102             $continueurl = new moodle_url($PAGE->url, array('delete' => $pluginfo->component, 'sesskey' => sesskey(), 'confirm' => 1));
 103             echo $output->plugin_uninstall_results_removable_page($pluginman, $pluginfo, $progress, $continueurl);
 104             // Reset op code caches.
 105             if (function_exists('opcache_reset')) {
 106                 opcache_reset();
 107             }
 108             exit();
 109
 110         } else {
 111             echo $output->plugin_uninstall_results_page($pluginman, $pluginfo, $progress);
 112             // Reset op code caches.
 113             if (function_exists('opcache_reset')) {
 114                 opcache_reset();
 115             }
 116             exit();
 117         }
 118     }
 119 }
 120
 121 if ($delete and $confirmed) {
 122     require_sesskey();
 123
 124     $PAGE->set_url($pageurl);
 125     $PAGE->set_context($syscontext);
 126     $PAGE->set_pagelayout('maintenance');
 127     $PAGE->set_popup_notification_allowed(false);
 128
 129     /** @var core_admin_renderer $output */
 130     $output = $PAGE->get_renderer('core', 'admin');
 131
 132     $pluginfo = $pluginman->get_plugin_info($delete);
 133
 134     // Make sure we know the plugin.
 135     if (is_null($pluginfo)) {
 136         throw new moodle_exception('err_removing_unknown_plugin', 'core_plugin', '', array('plugin' => $delete),
 137             'core_plugin_manager::get_plugin_info() returned null for the plugin to be deleted');
 138     }
 139
 140     $pluginname = $pluginman->plugin_name($pluginfo->component);
 141     $PAGE->set_title($pluginname);
 142     $PAGE->navbar->add(get_string('uninstalling', 'core_plugin', array('name' => $pluginname)));
 143
 144     // Make sure it is not installed.
 145     if (!is_null($pluginfo->versiondb)) {
 146         throw new moodle_exception('err_removing_installed_plugin', 'core_plugin', '',
 147             array('plugin' => $pluginfo->component, 'versiondb' => $pluginfo->versiondb),
 148             'core_plugin_manager::get_plugin_info() returned not-null versiondb for the plugin to be deleted');
 149     }
 150
 151     // Make sure the folder is within Moodle installation tree.
 152     if (strpos($pluginfo->rootdir, $CFG->dirroot) !== 0) {
 153         throw new moodle_exception('err_unexpected_plugin_rootdir', 'core_plugin', '',
 154             array('plugin' => $pluginfo->component, 'rootdir' => $pluginfo->rootdir, 'dirroot' => $CFG->dirroot),
 155             'plugin root folder not in the moodle dirroot');
 156     }
 157
 158     // So long, and thanks for all the bugs.
 159     $pluginman->remove_plugin_folder($pluginfo);
 160
 161     // We need to execute upgrade to make sure everything including caches is up to date.
 162     redirect(new moodle_url('/admin/index.php'));
 163 }
 164
 165 // Install all avilable updates.
 166 if ($installupdatex) {
 167     require_once($CFG->libdir.'/upgradelib.php');
 168     require_sesskey();
 169
 170     $PAGE->set_url($pageurl);
 171     $PAGE->set_context($syscontext);
 172     $PAGE->set_pagelayout('maintenance');
 173     $PAGE->set_popup_notification_allowed(false);
 174
 175     $installable = $pluginman->filter_installable($pluginman->available_updates());
 176     upgrade_install_plugins($installable, $confirminstallupdate,
 177         get_string('updateavailableinstallallhead', 'core_admin'),
 178         new moodle_url($PAGE->url, array('installupdatex' => 1, 'confirminstallupdate' => 1))
 179     );
 180 }
 181
 182 // Install single available update.
 183 if ($installupdate and $installupdateversion) {
 184     require_once($CFG->libdir.'/upgradelib.php');
 185     require_sesskey();
 186
 187     $PAGE->set_url($pageurl);
 188     $PAGE->set_context($syscontext);
 189     $PAGE->set_pagelayout('maintenance');
 190     $PAGE->set_popup_notification_allowed(false);
 191
 192     if ($pluginman->is_remote_plugin_installable($installupdate, $installupdateversion)) {
 193         $installable = array($pluginman->get_remote_plugin_info($installupdate, $installupdateversion, true));
 194         upgrade_install_plugins($installable, $confirminstallupdate,
 195             get_string('updateavailableinstallallhead', 'core_admin'),
 196             new moodle_url($PAGE->url, array('installupdate' => $installupdate,
 197                 'installupdateversion' => $installupdateversion, 'confirminstallupdate' => 1)
 198             )
 199         );
 200     }
 201 }
 202
 203 admin_externalpage_setup('pluginsoverview', '', $pageparams);
 204
 205 /** @var core_admin_renderer $output */
 206 $output = $PAGE->get_renderer('core', 'admin');
 207
 208 $checker = \core\update\checker::instance();
 209
 210 if ($fetchupdates) {
 211     require_sesskey();
 212     $checker->fetch();
 213     redirect($PAGE->url);
 214 }
 215
 216 echo $output->plugin_management_page($pluginman, $checker, $pageparams);