MDL-21432 backup - improve start date offset
[moodle.git] / backup / util / plan / restore_plan.class.php
CommitLineData
b5d45a04
EL
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 * @package moodlecore
20 * @subpackage backup-plan
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 */
24
25/**
26 * Implementable class defining the needed stuf for one restore plan
27 *
28 * TODO: Finish phpdocs
29 */
30class restore_plan extends base_plan implements loggable {
31
785d6603
SH
32 /**
33 *
34 * @var restore_controller
35 */
b5d45a04
EL
36 protected $controller; // The restore controller building/executing this plan
37 protected $basepath; // Fullpath to dir where backup is available
482aac65 38 protected $preloaded; // When executing the plan, do we have preloaded (from checks) info
b5d45a04
EL
39
40 /**
41 * Constructor - instantiates one object of this class
42 */
43 public function __construct($controller) {
44 global $CFG;
45
46 if (! $controller instanceof restore_controller) {
47 throw new restore_plan_exception('wrong_restore_controller_specified');
48 }
49 $this->controller = $controller;
c9d8234a 50 $this->basepath = $CFG->dataroot . '/temp/backup/' . $controller->get_tempdir();
482aac65 51 $this->preloaded = false;
b5d45a04
EL
52 parent::__construct('restore_plan');
53 }
54
55 public function build() {
56 restore_plan_builder::build_plan($this->controller); // We are moodle2 always, go straight to builder
57 $this->built = true;
58 }
59
60 public function get_restoreid() {
61 return $this->controller->get_restoreid();
62 }
63
64 public function get_courseid() {
65 return $this->controller->get_courseid();
66 }
67
68 public function get_basepath() {
69 return $this->basepath;
70 }
71
72 public function get_logger() {
73 return $this->controller->get_logger();
74 }
75
c9d8234a
EL
76 public function get_info() {
77 return $this->controller->get_info();
78 }
79
a4e13312
EL
80 public function get_target() {
81 return $this->controller->get_target();
82 }
83
482aac65
EL
84 public function get_userid() {
85 return $this->controller->get_userid();
86 }
87
88 public function is_samesite() {
89 return $this->controller->is_samesite();
90 }
91
92 public function set_preloaded_information() {
93 $this->preloaded = true;
94 }
95
96 public function get_preloaded_information() {
97 return $this->preloaded;
98 }
99
b1eaf633
EL
100 public function get_tempdir() {
101 return $this->controller->get_tempdir();
102 }
103
b5d45a04
EL
104 public function log($message, $level, $a = null, $depth = null, $display = false) {
105 backup_helper::log($message, $level, $a, $depth, $display, $this->get_logger());
106 }
107
108 /**
109 * Function responsible for executing the tasks of any plan
110 */
111 public function execute() {
112 if ($this->controller->get_status() != backup::STATUS_AWAITING) {
113 throw new restore_controller_exception('restore_not_executable_awaiting_required', $this->controller->get_status());
114 }
115 $this->controller->set_status(backup::STATUS_EXECUTING);
116 parent::execute();
117 $this->controller->set_status(backup::STATUS_FINISHED_OK);
118 }
119}
120
121/*
122 * Exception class used by all the @restore_plan stuff
123 */
124class restore_plan_exception extends base_plan_exception {
125
126 public function __construct($errorcode, $a=NULL, $debuginfo=null) {
127 parent::__construct($errorcode, $a, $debuginfo);
128 }
129}