/backup/moodle2/restore_plugin.class.php
PHP | 284 lines | 119 code | 28 blank | 137 comment | 15 complexity | 44c36c4d19cb663fb6805c1be4baa30b MD5 | raw file
Possible License(s): MIT, AGPL-3.0, MPL-2.0-no-copyleft-exception, LGPL-3.0, GPL-3.0, Apache-2.0, LGPL-2.1, BSD-3-Clause
- <?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/>.
- /**
- * Defines restore_plugin class
- *
- * @package core_backup
- * @subpackage moodle2
- * @category backup
- * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
- defined('MOODLE_INTERNAL') || die();
- /**
- * Class implementing the plugins support for moodle2 restore
- *
- * TODO: Finish phpdocs
- */
- abstract class restore_plugin {
- /** @var string */
- protected $plugintype;
- /** @var string */
- protected $pluginname;
- /** @var string */
- protected $connectionpoint;
- /** @var restore_structure_step */
- protected $step;
- /** @var restore_course_task|restore_activity_task */
- protected $task;
- /**
- * restore_plugin constructor.
- *
- * @param string $plugintype
- * @param string $pluginname
- * @param restore_structure_step $step
- */
- public function __construct($plugintype, $pluginname, $step) {
- $this->plugintype = $plugintype;
- $this->pluginname = $pluginname;
- $this->step = $step;
- $this->task = $step->get_task();
- $this->connectionpoint = '';
- }
- public function define_plugin_structure($connectionpoint) {
- if (!$connectionpoint instanceof restore_path_element) {
- throw new restore_step_exception('restore_path_element_required', $connectionpoint);
- }
- $paths = array();
- $this->connectionpoint = $connectionpoint;
- $methodname = 'define_' . basename($this->connectionpoint->get_path()) . '_plugin_structure';
- if (method_exists($this, $methodname)) {
- if ($pluginpaths = $this->$methodname()) {
- foreach ($pluginpaths as $path) {
- if ($path->get_processing_object() === null && !$this->step->grouped_parent_exists($path, $paths)) {
- $path->set_processing_object($this);
- }
- $paths[] = $path;
- }
- }
- }
- return $paths;
- }
- /**
- * after_execute dispatcher for any restore_plugin class
- *
- * This method will dispatch execution to the corresponding
- * after_execute_xxx() method when available, with xxx
- * being the connection point of the instance, so plugin
- * classes with multiple connection points will support
- * multiple after_execute methods, one for each connection point
- */
- public function launch_after_execute_methods() {
- // Check if the after_execute method exists and launch it
- $afterexecute = 'after_execute_' . basename($this->connectionpoint->get_path());
- if (method_exists($this, $afterexecute)) {
- $this->$afterexecute();
- }
- }
- /**
- * after_restore dispatcher for any restore_plugin class
- *
- * This method will dispatch execution to the corresponding
- * after_restore_xxx() method when available, with xxx
- * being the connection point of the instance, so plugin
- * classes with multiple connection points will support
- * multiple after_restore methods, one for each connection point
- */
- public function launch_after_restore_methods() {
- // Check if the after_restore method exists and launch it
- $afterrestore = 'after_restore_' . basename($this->connectionpoint->get_path());
- if (method_exists($this, $afterrestore)) {
- $this->$afterrestore();
- }
- }
- /**
- * Returns one array with all the decode contents
- * to be processed by the links decoder
- *
- * This method, given one plugin type, returns one
- * array of {@link restore_decode_content} objects
- * that will be added to the restore decoder in order
- * to perform modifications under the plugin contents.
- *
- * The objects are retrieved by calling to the {@link define_decode_contents}
- * method (when available), first in the main restore_xxxx_plugin class
- * and later on each of the available subclasses
- */
- static public function get_restore_decode_contents($plugintype) {
- $decodecontents = array();
- // Check the requested plugintype is a valid one
- if (!array_key_exists($plugintype, core_component::get_plugin_types($plugintype))) {
- throw new backup_step_exception('incorrect_plugin_type', $plugintype);
- }
- // Check the base plugin class exists
- $classname = 'restore_' . $plugintype . '_plugin';
- if (!class_exists($classname)) {
- throw new backup_step_exception('plugin_class_not_found', $classname);
- }
- // First, call to the define_plugin_decode_contents in the base plugin class
- // (must exist by design in all the plugin base classes)
- if (method_exists($classname, 'define_plugin_decode_contents')) {
- $decodecontents = array_merge($decodecontents, call_user_func(array($classname, 'define_plugin_decode_contents')));
- }
- // Now, iterate over all the possible plugins available
- // (only the needed ones have been loaded, so they will
- // be the ones being asked here). Fetch their restore contents
- // by calling (if exists) to their define_decode_contents() method
- $plugins = core_component::get_plugin_list($plugintype);
- foreach ($plugins as $plugin => $plugindir) {
- $classname = 'restore_' . $plugintype . '_' . $plugin . '_plugin';
- if (class_exists($classname)) {
- if (method_exists($classname, 'define_decode_contents')) {
- $decodecontents = array_merge($decodecontents, call_user_func(array($classname, 'define_decode_contents')));
- }
- }
- }
- return $decodecontents;
- }
- /**
- * Define the contents in the plugin that must be
- * processed by the link decoder
- */
- static public function define_plugin_decode_contents() {
- throw new coding_exception('define_plugin_decode_contents() method needs to be overridden in each subclass of restore_plugin');
- }
- // Protected API starts here
- // restore_step/structure_step/task wrappers
- protected function get_restoreid() {
- if (is_null($this->task)) {
- throw new restore_step_exception('not_specified_restore_task');
- }
- return $this->task->get_restoreid();
- }
- /**
- * To send ids pairs to backup_ids_table and to store them into paths
- *
- * This method will send the given itemname and old/new ids to the
- * backup_ids_temp table, and, at the same time, will save the new id
- * into the corresponding restore_path_element for easier access
- * by children. Also will inject the known old context id for the task
- * in case it's going to be used for restoring files later
- */
- protected function set_mapping($itemname, $oldid, $newid, $restorefiles = false, $filesctxid = null, $parentid = null) {
- $this->step->set_mapping($itemname, $oldid, $newid, $restorefiles, $filesctxid, $parentid);
- }
- /**
- * Returns the latest (parent) old id mapped by one pathelement
- */
- protected function get_old_parentid($itemname) {
- return $this->step->get_old_parentid($itemname);
- }
- /**
- * Returns the latest (parent) new id mapped by one pathelement
- */
- protected function get_new_parentid($itemname) {
- return $this->step->get_new_parentid($itemname);
- }
- /**
- * Return the new id of a mapping for the given itemname
- *
- * @param string $itemname the type of item
- * @param int $oldid the item ID from the backup
- * @param mixed $ifnotfound what to return if $oldid wasnt found. Defaults to false
- */
- protected function get_mappingid($itemname, $oldid, $ifnotfound = false) {
- return $this->step->get_mappingid($itemname, $oldid, $ifnotfound);
- }
- /**
- * Return the complete mapping from the given itemname, itemid
- */
- protected function get_mapping($itemname, $oldid) {
- return $this->step->get_mapping($itemname, $oldid);
- }
- /**
- * Add all the existing file, given their component and filearea and one backup_ids itemname to match with
- */
- protected function add_related_files($component, $filearea, $mappingitemname, $filesctxid = null, $olditemid = null) {
- $this->step->add_related_files($component, $filearea, $mappingitemname, $filesctxid, $olditemid);
- }
- /**
- * Apply course startdate offset based in original course startdate and course_offset_startdate setting
- * Note we are using one static cache here, but *by restoreid*, so it's ok for concurrence/multiple
- * executions in the same request
- */
- protected function apply_date_offset($value) {
- return $this->step->apply_date_offset($value);
- }
- /**
- * Returns the value of one (task/plan) setting
- */
- protected function get_setting_value($name) {
- if (is_null($this->task)) {
- throw new restore_step_exception('not_specified_restore_task');
- }
- return $this->task->get_setting_value($name);
- }
- // end of restore_step/structure_step/task wrappers
- /**
- * Simple helper function that returns the name for the restore_path_element
- * It's not mandatory to use it but recommended ;-)
- */
- protected function get_namefor($name = '') {
- $name = $name !== '' ? '_' . $name : '';
- return $this->plugintype . '_' . $this->pluginname . $name;
- }
- /**
- * Simple helper function that returns the base (prefix) of the path for the restore_path_element
- * Useful if we used get_recommended_name() in backup. It's not mandatory to use it but recommended ;-)
- */
- protected function get_pathfor($path = '') {
- $path = trim($path, '/') !== '' ? '/' . trim($path, '/') : '';
- return $this->connectionpoint->get_path() . '/' .
- 'plugin_' . $this->plugintype . '_' .
- $this->pluginname . '_' . basename($this->connectionpoint->get_path()) . $path;
- }
- /**
- * Get the task we are part of.
- *
- * @return restore_activity_task|restore_course_task the task.
- */
- protected function get_task() {
- return $this->task;
- }
- }