update
[moodle.git] / backup / backup.class.php
CommitLineData
c6cc9726
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
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 * 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 */
34abstract class backup implements checksumable {
35
36 // Backup type
3930e8b8
EL
37 const TYPE_1ACTIVITY = 'activity';
38 const TYPE_1SECTION = 'section';
39 const TYPE_1COURSE = 'course';
c6cc9726
EL
40
41 // Backup format
42 const FORMAT_MOODLE = 'moodle2';
f60f4666 43 const FORMAT_MOODLE1 = 'moodle1';
c6cc9726 44 const FORMAT_IMSCC = 'imscc';
f60f4666 45 const FORMAT_UNKNOWN = 'unknown';
c6cc9726
EL
46
47 // Interactive
48 const INTERACTIVE_YES = true;
49 const INTERACTIVE_NO = false;
50
51 // Predefined modes (purposes) of the backup
52 const MODE_GENERAL = 10;
53 const MODE_IMPORT = 20;
54 const MODE_HUB = 30;
55 const MODE_SAMESITE = 40;
56
57 // Execution mode
58 const EXECUTION_INMEDIATE = 1;
59 const EXECUTION_DELAYED = 2;
60
61 // Status of the backup_controller
62 const STATUS_CREATED = 100;
f60f4666
EL
63 const STATUS_REQUIRE_CONV= 200;
64 const STATUS_PLANNED = 300;
65 const STATUS_CONFIGURED = 400;
66 const STATUS_SETTING_UI = 500;
dc5a2f8a
EL
67 const STATUS_NEED_PRECHECK=600;
68 const STATUS_AWAITING = 700;
69 const STATUS_EXECUTING = 800;
70 const STATUS_FINISHED_ERR= 900;
71 const STATUS_FINISHED_OK =1000;
c6cc9726
EL
72
73 // Logging levels
74 const LOG_DEBUG = 50;
75 const LOG_INFO = 40;
76 const LOG_WARNING = 30;
77 const LOG_ERROR = 20;
78 const LOG_NONE = 10;
79
80 // Some constants used to identify some helpfull processor variables
81 // (using negative numbers to avoid any collision posibility
82 // To be used when defining backup structures
83 const VAR_COURSEID = -1; // To reference id of course in a processor
84 const VAR_SECTIONID = -11; // To reference id of section in a processor
85 const VAR_ACTIVITYID = -21; // To reference id of activity in a processor
86 const VAR_MODID = -31; // To reference id of course_module in a processor
87 const VAR_MODNAME = -41; // To reference name of module in a processor
88 const VAR_BLOCKID = -51; // To reference id of block in a processor
89 const VAR_BLOCKNAME = -61; // To reference name of block in a processor
90 const VAR_CONTEXTID = -71; // To reference context id in a processor
91 const VAR_PARENTID = -81; // To reference the first parent->id in a backup structure
92
93 // Used internally by the backup process
94 const VAR_BACKUPID = -1001; // To reference the backupid being processed
95 const VAR_BASEPATH = -1011; // To reference the dir where the file is generated
96
f60f4666
EL
97 // Type of operation
98 const OPERATION_BACKUP ='backup'; // We are performing one backup
99 const OPERATION_RESTORE ='restore';// We are performing one restore
100
c6cc9726 101 // Version (to keep CFG->backup_version (and release) updated automatically)
f60f4666
EL
102 const VERSION = 2010070500;
103 const RELEASE = '2.0 Preview 5';
c6cc9726
EL
104}
105
106/*
107 * Exception class used by all the @backup stuff
108 */
ce937f99 109abstract class backup_exception extends moodle_exception {
c6cc9726
EL
110
111 public function __construct($errorcode, $a=NULL, $debuginfo=null) {
112 parent::__construct($errorcode, 'error', '', $a, null, $debuginfo);
113 }
114}