8972e358405e26a24dad65feba454f5ca1009630
[moodle.git] / backup / moodle2 / restore_subplugin.class.php
1 <?php
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/>.
18 /**
19  * @package    moodlecore
20  * @subpackage backup-moodle2
21  * @copyright  2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 /**
26  * Class implementing the subplugins support for moodle2 restore
27  *
28  * TODO: Finish phpdocs
29  * TODO: Make this subclass of restore_plugin
30  * TODO: Add support for declaring decode_contents (not decode_rules)
31  */
32 abstract class restore_subplugin {
34     protected $subplugintype;
35     protected $subpluginname;
36     protected $connectionpoint;
37     protected $step;
38     protected $task;
40     public function __construct($subplugintype, $subpluginname, $step) {
41         $this->subplugintype = $subplugintype;
42         $this->subpluginname = $subpluginname;
43         $this->step          = $step;
44         $this->task          = $step->get_task();
45         $this->connectionpoint = '';
46     }
48     public function define_subplugin_structure($connectionpoint) {
49         if (!$connectionpoint instanceof restore_path_element) {
50             throw new restore_step_exception('restore_path_element_required', $connectionpoint);
51         }
53         $paths = array();
54         $this->connectionpoint = $connectionpoint;
55         $methodname = 'define_' . basename($this->connectionpoint->get_path()) . '_subplugin_structure';
57         if (method_exists($this, $methodname)) {
58             if ($subbluginpaths = $this->$methodname()) {
59                 foreach ($subbluginpaths as $path) {
60                     $path->set_processing_object($this);
61                     $paths[] = $path;
62                 }
63             }
64         }
65         return $paths;
66     }
68     /**
69      * after_execute dispatcher for any restore_subplugin class
70      *
71      * This method will dispatch execution to the corresponding
72      * after_execute_xxx() method when available, with xxx
73      * being the connection point of the instance, so subplugin
74      * classes with multiple connection points will support
75      * multiple after_execute methods, one for each connection point
76      */
77     public function launch_after_execute_methods() {
78         // Check if the after_execute method exists and launch it
79         $afterexecute = 'after_execute_' . basename($this->connectionpoint->get_path());
80         if (method_exists($this, $afterexecute)) {
81             $this->$afterexecute();
82         }
83     }
85 // Protected API starts here
87 // restore_step/structure_step/task wrappers
89     protected function get_restoreid() {
90         if (is_null($this->task)) {
91             throw new restore_step_exception('not_specified_restore_task');
92         }
93         return $this->task->get_restoreid();
94     }
96     /**
97      * To send ids pairs to backup_ids_table and to store them into paths
98      *
99      * This method will send the given itemname and old/new ids to the
100      * backup_ids_temp table, and, at the same time, will save the new id
101      * into the corresponding restore_path_element for easier access
102      * by children. Also will inject the known old context id for the task
103      * in case it's going to be used for restoring files later
104      */
105     protected function set_mapping($itemname, $oldid, $newid, $restorefiles = false, $filesctxid = null, $parentid = null) {
106         $this->step->set_mapping($itemname, $oldid, $newid, $restorefiles, $filesctxid, $parentid);
107     }
109     /**
110      * Returns the latest (parent) old id mapped by one pathelement
111      */
112     protected function get_old_parentid($itemname) {
113         return $this->step->get_old_parentid($itemname);
114     }
116     /**
117      * Returns the latest (parent) new id mapped by one pathelement
118      */
119     protected function get_new_parentid($itemname) {
120         return $this->step->get_new_parentid($itemname);
121     }
123     /**
124      * Return the new id of a mapping for the given itemname
125      *
126      * @param string $itemname the type of item
127      * @param int $oldid the item ID from the backup
128      * @param mixed $ifnotfound what to return if $oldid wasnt found. Defaults to false
129      */
130     protected function get_mappingid($itemname, $oldid, $ifnotfound = false) {
131         return $this->step->get_mappingid($itemname, $oldid, $ifnotfound);
132     }
134     /**
135      * Return the complete mapping from the given itemname, itemid
136      */
137     protected function get_mapping($itemname, $oldid) {
138         return $this->step->get_mapping($itemname, $oldid);
139     }
141     /**
142      * Add all the existing file, given their component and filearea and one backup_ids itemname to match with
143      */
144     protected function add_related_files($component, $filearea, $mappingitemname, $filesctxid = null, $olditemid = null) {
145         $this->step->add_related_files($component, $filearea, $mappingitemname, $filesctxid, $olditemid);
146     }
148     /**
149      * Apply course startdate offset based in original course startdate and course_offset_startdate setting
150      * Note we are using one static cache here, but *by restoreid*, so it's ok for concurrence/multiple
151      * executions in the same request
152      */
153     protected function apply_date_offset($value) {
154         return $this->step->apply_date_offset($value);
155     }
157     /**
158      * Returns the value of one (task/plan) setting
159      */
160     protected function get_setting_value($name) {
161         if (is_null($this->task)) {
162             throw new restore_step_exception('not_specified_restore_task');
163         }
164         return $this->task->get_setting_value($name);
165     }
167 // end of restore_step/structure_step/task wrappers
169     /**
170      * Simple helper function that returns the name for the restore_path_element
171      * It's not mandatory to use it but recommended ;-)
172      */
173     protected function get_namefor($name = '') {
174         $name = $name !== '' ? '_' . $name : '';
175         return $this->subplugintype . '_' . $this->subpluginname . $name;
176     }
178     /**
179      * Simple helper function that returns the base (prefix) of the path for the restore_path_element
180      * Useful if we used get_recommended_name() in backup. It's not mandatory to use it but recommended ;-)
181      */
182     protected function get_pathfor($path = '') {
183         $path = trim($path, '/') !== '' ? '/' . trim($path, '/') : '';
184         return $this->connectionpoint->get_path() . '/' .
185                'subplugin_' . $this->subplugintype . '_' .
186                $this->subpluginname . '_' . basename($this->connectionpoint->get_path()) . $path;
187     }