18e77ef2f6fcb057999e6c2d9f63cfe14f4ef229
[moodle.git] / backup / util / plan / restore_step.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-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  */
25 /**
26  * Abstract class defining the needed stuf for one restore step
27  *
28  * TODO: Finish phpdocs
29  */
30 abstract class restore_step extends base_step {
32     /**
33      * Constructor - instantiates one object of this class
34      */
35     public function __construct($name, $task = null) {
36         if (!is_null($task) && !($task instanceof restore_task)) {
37             throw new restore_step_exception('wrong_restore_task_specified');
38         }
39         parent::__construct($name, $task);
40     }
42     protected function get_restoreid() {
43         if (is_null($this->task)) {
44             throw new restore_step_exception('not_specified_restore_task');
45         }
46         return $this->task->get_restoreid();
47     }
49     /**
50      * Apply course startdate offset based in original course startdate and course_offset_startdate setting
51      * Note we are using one static cache here, but *by restoreid*, so it's ok for concurrence/multiple
52      * executions in the same request
53      *
54      * Note: The policy is to roll date only for configurations and not for user data. see MDL-9367.
55      *
56      * @param int $value Time value (seconds since epoch), or empty for nothing
57      * @return int Time value after applying the date offset, or empty for nothing
58      */
59     public function apply_date_offset($value) {
61         // Empties don't offset - zeros (int and string), false and nulls return original value.
62         if (empty($value)) {
63             return $value;
64         }
66         static $cache = array();
67         // Lookup cache.
68         if (isset($cache[$this->get_restoreid()])) {
69             return $value + $cache[$this->get_restoreid()];
70         }
71         // No cache, let's calculate the offset.
72         $original = $this->task->get_info()->original_course_startdate;
73         $setting = 0;
74         if ($this->setting_exists('course_startdate')) { // Seting may not exist (MDL-25019).
75             $settingobject = $this->task->get_setting('course_startdate');
76             if (method_exists($settingobject, 'get_normalized_value')) {
77                 $setting = $settingobject->get_normalized_value();
78             } else {
79                 $setting = $settingobject->get_value();
80             }
81         }
83         if (empty($original) || empty($setting)) {
84             // Original course has not startdate or setting doesn't exist, offset = 0.
85             $cache[$this->get_restoreid()] = 0;
87         } else if (abs($setting - $original) < 24 * 60 * 60) {
88             // Less than 24h of difference, offset = 0 (this avoids some problems with timezones).
89             $cache[$this->get_restoreid()] = 0;
91         } else {
92             // Arrived here, let's calculate the real offset.
93             $cache[$this->get_restoreid()] = $setting - $original;
94         }
96         // Return the passed value with cached offset applied.
97         return $value + $cache[$this->get_restoreid()];
98     }
100     /**
101      * Returns symmetric-key AES-256 decryption of base64 encoded contents.
102      *
103      * This method is used in restore operations to decrypt contents encrypted with
104      * {@link encrypted_final_element} automatically decoding (base64) and decrypting
105      * contents using the key stored in backup_encryptkey config.
106      *
107      * Requires openssl, cipher availability, and key existence (backup
108      * automatically sets it if missing). Integrity is provided via HMAC.
109      *
110      * @param string $value {@link encrypted_final_element} value to decode and decrypt.
111      * @return string|null decoded and decrypted value or null if the operation can not be performed.
112      */
113     public function decrypt($value) {
115         // No openssl available, skip this field completely.
116         if (!function_exists('openssl_encrypt')) {
117             return null;
118         }
120         // No hash available, skip this field completely.
121         if (!function_exists('hash_hmac')) {
122             return null;
123         }
125         // Cypher not available, skip this field completely.
126         if (!in_array(backup::CIPHER, openssl_get_cipher_methods())) {
127             return null;
128         }
130         // Get the decrypt key. Skip if missing.
131         $key = get_config('backup', 'backup_encryptkey');
132         if ($key === false) {
133             return null;
134         }
136         // And decode it.
137         $key = base64_decode($key);
139         // Arrived here, let's proceed with authentication (provides integrity).
140         $hmaclen = 32; // SHA256 is 32 bytes.
141         $ivlen = openssl_cipher_iv_length(backup::CIPHER);
142         list($hmac, $iv, $text) = array_values(unpack("a{$hmaclen}hmac/a{$ivlen}iv/a*text", base64_decode($value)));
144         // Verify HMAC matches expectations, skip if not (integrity failed).
145         if (!hash_equals($hmac, hash_hmac('sha256', $iv . $text, $key, true))) {
146             return null;
147         }
149         // Arrived here, integrity is ok, let's decrypt.
150         $result = openssl_decrypt($text, backup::CIPHER, $key, OPENSSL_RAW_DATA, $iv);
152         // For some reason decrypt failed (strange, HMAC check should have deteted it), skip this field completely.
153         if ($result === false) {
154             return null;
155         }
157         return $result;
158     }
161 /*
162  * Exception class used by all the @restore_step stuff
163  */
164 class restore_step_exception extends base_step_exception {
166     public function __construct($errorcode, $a=NULL, $debuginfo=null) {
167         parent::__construct($errorcode, $a, $debuginfo);
168     }