66e5ce8872e6a0c5a28b88fd714135c9b91f8516
[moodle.git] / backup / backup.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
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 common stuff to be used by the backup stuff
27  *
28  * This class defines various constants and methods that will be used
29  * by different classes, all related with the backup process. Just provides
30  * the top hierarchy of the backup controller/worker stuff.
31  *
32  * TODO: Finish phpdocs
33  */
34 abstract class backup implements checksumable {
36     // Backup type
37     const TYPE_1ACTIVITY = 'activity';
38     const TYPE_1SECTION  = 'section';
39     const TYPE_1COURSE   = 'course';
41     // Backup format
42     const FORMAT_MOODLE  = 'moodle2';
43     const FORMAT_MOODLE1 = 'moodle1';
44     const FORMAT_IMSCC1  = 'imscc1';
45     const FORMAT_IMSCC11 = 'imscc11';
46     const FORMAT_UNKNOWN = 'unknown';
48     // Interactive
49     const INTERACTIVE_YES = true;
50     const INTERACTIVE_NO  = false;
52     // Predefined modes (purposes) of the backup
53     const MODE_GENERAL   = 10;
55     /**
56      * This is used for importing courses, and for duplicating activities.
57      *
58      * This mode will ensure that files are not included in the backup generation, and
59      * during a restore they are copied from the existing file record.
60      */
61     const MODE_IMPORT    = 20;
62     const MODE_HUB       = 30;
64     /**
65      * This mode is intended for duplicating courses and cases where the backup target is
66      * within the same site.
67      *
68      * This mode will ensure that files are not included in the backup generation, and
69      * during a restore they are copied from the existing file record.
70      *
71      * For creating a backup for archival purposes or greater longevity, use MODE_GENERAL.
72      */
73     const MODE_SAMESITE  = 40;
74     const MODE_AUTOMATED = 50;
75     const MODE_CONVERTED = 60;
77     // Target (new/existing/current/adding/deleting)
78     const TARGET_CURRENT_DELETING = 0;
79     const TARGET_CURRENT_ADDING   = 1;
80     const TARGET_NEW_COURSE       = 2;
81     const TARGET_EXISTING_DELETING= 3;
82     const TARGET_EXISTING_ADDING  = 4;
84     // Execution mode
85     const EXECUTION_INMEDIATE = 1;
86     const EXECUTION_DELAYED   = 2;
88     // Status of the backup_controller
89     const STATUS_CREATED     = 100;
90     const STATUS_REQUIRE_CONV= 200;
91     const STATUS_PLANNED     = 300;
92     const STATUS_CONFIGURED  = 400;
93     const STATUS_SETTING_UI  = 500;
94     const STATUS_NEED_PRECHECK=600;
95     const STATUS_AWAITING    = 700;
96     const STATUS_EXECUTING   = 800;
97     const STATUS_FINISHED_ERR= 900;
98     const STATUS_FINISHED_OK =1000;
100     // Logging levels
101     const LOG_DEBUG   = 50;
102     const LOG_INFO    = 40;
103     const LOG_WARNING = 30;
104     const LOG_ERROR   = 20;
105     const LOG_NONE    = 10;
107     // Some constants used to identify some helpfull processor variables
108     // (using negative numbers to avoid any collision posibility
109     // To be used when defining backup structures
110     const VAR_COURSEID   = -1;  // To reference id of course in a processor
111     const VAR_SECTIONID  = -11; // To reference id of section in a processor
112     const VAR_ACTIVITYID = -21; // To reference id of activity in a processor
113     const VAR_MODID      = -31; // To reference id of course_module in a processor
114     const VAR_MODNAME    = -41; // To reference name of module in a processor
115     const VAR_BLOCKID    = -51; // To reference id of block in a processor
116     const VAR_BLOCKNAME  = -61; // To reference name of block in a processor
117     const VAR_CONTEXTID  = -71; // To reference context id in a processor
118     const VAR_PARENTID   = -81; // To reference the first parent->id in a backup structure
120     // Used internally by the backup process
121     const VAR_BACKUPID   = -1001; // To reference the backupid being processed
122     const VAR_BASEPATH   = -1011; // To reference the dir where the file is generated
124     // Type of operation
125     const OPERATION_BACKUP  ='backup'; // We are performing one backup
126     const OPERATION_RESTORE ='restore';// We are performing one restore
128     // Options for "Include enrolment methods" restore setting.
129     const ENROL_NEVER     = 0;
130     const ENROL_WITHUSERS = 1;
131     const ENROL_ALWAYS    = 2;
133     // Version and release (to keep CFG->backup_version (and release) updated automatically).
134     /**
135      * Usually same than major release version, this is used to mark important
136      * point is backup when some behavior/approach channged, in order to allow
137      * conditional coding based on it.
138      */
139     const VERSION = 2018051400;
140     /**
141      * Usually same than major release zero version, mainly for informative/historic purposes.
142      */
143     const RELEASE = '3.5';
145     /**
146      * Cipher to be used in backup and restore operations.
147      */
148     const CIPHER = 'aes-256-cbc';
149     /**
150      * Bytes enforced for key, using the cypher above. Restrictive? Yes, but better than unsafe lengths
151      */
152     const CIPHERKEYLEN = 32;
155 /*
156  * Exception class used by all the @backup stuff
157  */
158 abstract class backup_exception extends moodle_exception {
160     public function __construct($errorcode, $a=NULL, $debuginfo=null) {
161         parent::__construct($errorcode, 'error', '', $a, $debuginfo);
162     }