You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
217 lines
7.9 KiB
217 lines
7.9 KiB
<?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_subplugin 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 subplugins support for moodle2 restore
|
|
*
|
|
* TODO: Finish phpdocs
|
|
* TODO: Make this subclass of restore_plugin
|
|
* TODO: Add support for declaring decode_contents (not decode_rules)
|
|
*/
|
|
abstract class restore_subplugin {
|
|
|
|
protected $subplugintype;
|
|
protected $subpluginname;
|
|
protected $connectionpoint;
|
|
protected $step;
|
|
protected $task;
|
|
|
|
public function __construct($subplugintype, $subpluginname, $step) {
|
|
$this->subplugintype = $subplugintype;
|
|
$this->subpluginname = $subpluginname;
|
|
$this->step = $step;
|
|
$this->task = $step->get_task();
|
|
$this->connectionpoint = '';
|
|
}
|
|
|
|
public function define_subplugin_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()) . '_subplugin_structure';
|
|
|
|
if (method_exists($this, $methodname)) {
|
|
if ($subbluginpaths = $this->$methodname()) {
|
|
foreach ($subbluginpaths as $path) {
|
|
$path->set_processing_object($this);
|
|
$paths[] = $path;
|
|
}
|
|
}
|
|
}
|
|
return $paths;
|
|
}
|
|
|
|
/**
|
|
* after_execute dispatcher for any restore_subplugin 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 subplugin
|
|
* 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();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* The after_restore dispatcher for any restore_subplugin 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 subplugin
|
|
* 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.
|
|
$afterestore = 'after_restore_' . basename($this->connectionpoint->get_path());
|
|
if (method_exists($this, $afterestore)) {
|
|
$this->$afterestore();
|
|
}
|
|
}
|
|
|
|
// 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);
|
|
}
|
|
|
|
/**
|
|
* Call the log function from the step.
|
|
*/
|
|
public function log($message, $level, $a = null, $depth = null, $display = false) {
|
|
return $this->step->log($message, $level, $a, $depth, $display);
|
|
}
|
|
|
|
/**
|
|
* 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->subplugintype . '_' . $this->subpluginname . $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() . '/' .
|
|
'subplugin_' . $this->subplugintype . '_' .
|
|
$this->subpluginname . '_' . basename($this->connectionpoint->get_path()) . $path;
|
|
}
|
|
}
|
|
|