MDL-17069 - no longer using $_POST
[moodle.git] / backup / util / checks / backup_check.class.php
CommitLineData
69dd0c8c
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-factories
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 * Non instantiable helper class providing different backup checks
27 *
28 * This class contains various static methods available in order to easily
29 * perform a bunch of backup architecture tests
30 *
31 * TODO: Finish phpdocs
32 */
33abstract class backup_check {
34
35 public static function check_format_and_type($format, $type) {
36 global $CFG;
37
38 $file = $CFG->dirroot . '/backup/' . $format . '/backup_plan_builder.class.php';
39 if (! file_exists($file)) {
40 throw new backup_controller_exception('backup_check_unsupported_format', $format);
41 }
42 require_once($file);
43 if (!in_array($type, backup_plan_builder::supported_backup_types())) {
44 throw new backup_controller_exception('backup_check_unsupported_type', $type);
45 }
46
47 require_once($CFG->dirroot . '/backup/moodle2/backup_plan_builder.class.php');
48 }
49
50 public static function check_id($type, $id) {
51 global $DB;
52 switch ($type) {
53 case backup::TYPE_1ACTIVITY:
54 // id must exist in course_modules table
55 if (! $DB->record_exists('course_modules', array('id' => $id))) {
56 throw new backup_controller_exception('backup_check_module_not_exists', $id);
57 }
58 break;
59 case backup::TYPE_1SECTION:
60 // id must exist in course_sections table
61 if (! $DB->record_exists('course_sections', array('id' => $id))) {
62 throw new backup_controller_exception('backup_check_section_not_exists', $id);
63 }
64 break;
65 case backup::TYPE_1COURSE:
66 // id must exist in course table
67 if (! $DB->record_exists('course', array('id' => $id))) {
68 throw new backup_controller_exception('backup_check_course_not_exists', $id);
69 }
70 break;
71 default:
72 throw new backup_controller_exception('backup_check_incorrect_type', $type);
73 }
74 return true;
75 }
76
77 public static function check_user($userid) {
78 global $DB;
79 // userid must exist in user table
80 if (! $DB->record_exists('user', array('id' => $userid))) {
81 throw new backup_controller_exception('backup_check_user_not_exists', $userid);
82 }
83 return true;
84 }
85
86 public static function check_security($backup_controller, $apply) {
87 if (! $backup_controller instanceof backup_controller) {
88 throw new backup_controller_exception('backup_check_security_requires_backup_controller');
89 }
90 $backup_controller->log('checking plan security', backup::LOG_INFO);
91 return true;
92 }
93}