mirror of
https://github.com/moodle/moodle.git
synced 2025-08-05 08:56:36 +02:00
MDL-22164 backup - more cleanup of old 1.9 backup/restore code
This commit is contained in:
Eloy Lafuente
parent
152f2c0777
commit
b5e58c1831
3 changed files with 0 additions and 4111 deletions
327
backup/lib.php
327
backup/lib.php
|
|
@ -488,333 +488,6 @@
|
|||
return ($status && $status2);
|
||||
}
|
||||
|
||||
/** this function will restore an entire backup.zip into the specified course
|
||||
* using standard moodle backup/restore functions, but silently.
|
||||
* @param string $pathtofile the absolute path to the backup file.
|
||||
* @param int $destinationcourse the course id to restore to.
|
||||
* @param boolean $emptyfirst whether to delete all coursedata first.
|
||||
* @param boolean $userdata whether to include any userdata that may be in the backup file.
|
||||
* @param array $preferences optional, 0 will be used. Can contain:
|
||||
* metacourse
|
||||
* logs
|
||||
* course_files
|
||||
* messages
|
||||
*/
|
||||
function import_backup_file_silently($pathtofile,$destinationcourse,$emptyfirst=false,$userdata=false, $preferences=array()) {
|
||||
global $CFG,$SESSION,$USER, $DB; // is there such a thing on cron? I guess so..
|
||||
|
||||
if (!defined('RESTORE_SILENTLY')) {
|
||||
define('RESTORE_SILENTLY',true); // don't output all the stuff to us.
|
||||
}
|
||||
|
||||
$debuginfo = 'import_backup_file_silently: ';
|
||||
$cleanupafter = false;
|
||||
$errorstr = ''; // passed by reference to restore_precheck to get errors from.
|
||||
|
||||
$course = null;
|
||||
if ($destinationcourse && !$course = $DB->get_record('course', array('id'=>$destinationcourse))) {
|
||||
mtrace($debuginfo.'Course with id $destinationcourse was not a valid course!');
|
||||
return false;
|
||||
}
|
||||
|
||||
// first check we have a valid file.
|
||||
if (!file_exists($pathtofile) || !is_readable($pathtofile)) {
|
||||
mtrace($debuginfo.'File '.$pathtofile.' either didn\'t exist or wasn\'t readable');
|
||||
return false;
|
||||
}
|
||||
|
||||
// now make sure it's a zip file
|
||||
require_once($CFG->dirroot.'/lib/filelib.php');
|
||||
$filename = substr($pathtofile,strrpos($pathtofile,'/')+1);
|
||||
$mimetype = mimeinfo("type", $filename);
|
||||
if ($mimetype != 'application/zip') {
|
||||
mtrace($debuginfo.'File '.$pathtofile.' was of wrong mimetype ('.$mimetype.')' );
|
||||
return false;
|
||||
}
|
||||
|
||||
// restore_precheck wants this within dataroot, so lets put it there if it's not already..
|
||||
if (strstr($pathtofile,$CFG->dataroot) === false) {
|
||||
// first try and actually move it..
|
||||
if (!check_dir_exists($CFG->dataroot.'/temp/backup/',true)) {
|
||||
mtrace($debuginfo.'File '.$pathtofile.' outside of dataroot and couldn\'t move it! ');
|
||||
return false;
|
||||
}
|
||||
if (!copy($pathtofile,$CFG->dataroot.'/temp/backup/'.$filename)) {
|
||||
mtrace($debuginfo.'File '.$pathtofile.' outside of dataroot and couldn\'t move it! ');
|
||||
return false;
|
||||
} else {
|
||||
$pathtofile = 'temp/backup/'.$filename;
|
||||
$cleanupafter = true;
|
||||
}
|
||||
} else {
|
||||
// it is within dataroot, so take it off the path for restore_precheck.
|
||||
$pathtofile = substr($pathtofile,strlen($CFG->dataroot.'/'));
|
||||
}
|
||||
|
||||
if (!backup_required_functions()) {
|
||||
mtrace($debuginfo.'Required function check failed (see backup_required_functions)');
|
||||
return false;
|
||||
}
|
||||
@ini_set("max_execution_time","3000");
|
||||
raise_memory_limit(MEMORY_EXTRA);
|
||||
|
||||
if (!$backup_unique_code = restore_precheck($destinationcourse,$pathtofile,$errorstr,true)) {
|
||||
mtrace($debuginfo.'Failed restore_precheck (error was '.$errorstr.')');
|
||||
return false;
|
||||
}
|
||||
|
||||
global $restore; // ick
|
||||
$restore = new StdClass;
|
||||
// copy back over the stuff that gets set in restore_precheck
|
||||
$restore->course_header = $SESSION->course_header;
|
||||
$restore->info = $SESSION->info;
|
||||
|
||||
$xmlfile = "$CFG->dataroot/temp/backup/$backup_unique_code/moodle.xml";
|
||||
$info = restore_read_xml_roles($xmlfile);
|
||||
$restore->rolesmapping = array();
|
||||
if (isset($info->roles) && is_array($info->roles)) {
|
||||
foreach ($info->roles as $id => $info) {
|
||||
if ($newroleid = $DB->get_field('role', 'id', array('shortname' => $info->shortname))) {
|
||||
$restore->rolesmapping[$id] = $newroleid;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// add on some extra stuff we need...
|
||||
$restore->metacourse = (isset($preferences['restore_metacourse']) ? $preferences['restore_metacourse'] : 0);
|
||||
$restore->course_id = $destinationcourse;
|
||||
if ($destinationcourse) {
|
||||
$restore->restoreto = RESTORETO_CURRENT_ADDING;
|
||||
$restore->course_startdateoffset = $course->startdate - $restore->course_header->course_startdate;
|
||||
} else {
|
||||
$restore->restoreto = RESTORETO_NEW_COURSE;
|
||||
$restore->restore_restorecatto = 0; // let this be handled by the headers
|
||||
$restore->course_startdateoffset = 0;
|
||||
|
||||
}
|
||||
|
||||
$restore->users = $userdata;
|
||||
$restore->user_files = $userdata;
|
||||
$restore->deleting = $emptyfirst;
|
||||
|
||||
$restore->groups = (isset($preferences['restore_groups']) ? $preferences['restore_groups'] : RESTORE_GROUPS_NONE);
|
||||
$restore->logs = (isset($preferences['restore_logs']) ? $preferences['restore_logs'] : 0);
|
||||
$restore->messages = (isset($preferences['restore_messages']) ? $preferences['restore_messages'] : 0);
|
||||
$restore->blogs = (isset($preferences['restore_blogs']) ? $preferences['restore_blogs'] : 0);
|
||||
$restore->course_files = (isset($preferences['restore_course_files']) ? $preferences['restore_course_files'] : 0);
|
||||
$restore->site_files = (isset($preferences['restore_site_files']) ? $preferences['restore_site_files'] : 0);
|
||||
|
||||
$restore->backup_version = $restore->info->backup_backup_version;
|
||||
$restore->original_wwwroot = $restore->info->original_wwwroot;
|
||||
|
||||
// now copy what we have over to the session
|
||||
// this needs to happen before restore_setup_for_check
|
||||
// which for some reason reads the session
|
||||
$SESSION->restore =& $restore;
|
||||
// rename the things that are called differently
|
||||
$SESSION->restore->restore_course_files = $restore->course_files;
|
||||
$SESSION->restore->restore_site_files = $restore->site_files;
|
||||
$SESSION->restore->backup_version = $restore->info->backup_backup_version;
|
||||
|
||||
restore_setup_for_check($restore, $backup_unique_code);
|
||||
|
||||
// maybe we need users (defaults to 2 (none) in restore_setup_for_check)
|
||||
// so set this again here
|
||||
if (!empty($userdata)) {
|
||||
$restore->users = 1;
|
||||
}
|
||||
|
||||
// we also need modules...
|
||||
if ($allmods = $DB->get_records("modules")) {
|
||||
foreach ($allmods as $mod) {
|
||||
$modname = $mod->name;
|
||||
//Now check that we have that module info in the backup file
|
||||
if (isset($restore->info->mods[$modname]) && $restore->info->mods[$modname]->backup == "true") {
|
||||
$restore->mods[$modname]->restore = true;
|
||||
$restore->mods[$modname]->userinfo = $userdata;
|
||||
}
|
||||
else {
|
||||
// avoid warnings
|
||||
$restore->mods[$modname]->restore = false;
|
||||
$restore->mods[$modname]->userinfo = false;
|
||||
}
|
||||
}
|
||||
}
|
||||
if (!$status = restore_execute($restore,$restore->info,$restore->course_header,$errorstr)) {
|
||||
mtrace($debuginfo.'Failed restore_execute (error was '.$errorstr.')');
|
||||
return false;
|
||||
}
|
||||
// now get out the new courseid and return that
|
||||
if ($restore->restoreto = RESTORETO_NEW_COURSE) {
|
||||
if (!empty($SESSION->restore->course_id)) {
|
||||
return $SESSION->restore->course_id;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Function to backup an entire course silently and create a zipfile.
|
||||
*
|
||||
* @param int $courseid the id of the course
|
||||
* @param array $prefs see {@link backup_generate_preferences_artificially}
|
||||
*/
|
||||
function backup_course_silently($courseid, $prefs, &$errorstring) {
|
||||
global $CFG, $preferences, $DB; // global preferences here because something else wants it :(
|
||||
if (!defined('BACKUP_SILENTLY')) {
|
||||
define('BACKUP_SILENTLY', 1);
|
||||
}
|
||||
if (!$course = $DB->get_record('course', array('id'=>$courseid))) {
|
||||
debugging("Couldn't find course with id $courseid in backup_course_silently");
|
||||
return false;
|
||||
}
|
||||
$preferences = backup_generate_preferences_artificially($course, $prefs);
|
||||
$preferences->destination = array_key_exists('destination', $prefs) ? $prefs['destination'] : 0;
|
||||
if (backup_execute($preferences, $errorstring)) {
|
||||
return $CFG->dataroot . '/' . $course->id . '/backupdata/' . $preferences->backup_name;
|
||||
}
|
||||
else {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Function to generate the $preferences variable that
|
||||
* backup uses. This will back up all modules and instances in a course.
|
||||
*
|
||||
* @param object $course course object
|
||||
* @param array $prefs can contain:
|
||||
backup_metacourse
|
||||
backup_users
|
||||
backup_logs
|
||||
backup_user_files
|
||||
backup_course_files
|
||||
backup_site_files
|
||||
backup_messages
|
||||
userdata
|
||||
* and if not provided, they will not be included.
|
||||
*/
|
||||
|
||||
function backup_generate_preferences_artificially($course, $prefs) {
|
||||
global $CFG, $DB;
|
||||
$preferences = new StdClass;
|
||||
$preferences->backup_unique_code = time();
|
||||
$preferences->backup_users = (isset($prefs['backup_users']) ? $prefs['backup_users'] : 0);
|
||||
$preferences->backup_name = backup_get_zipfile_name($course, $preferences->backup_unique_code);
|
||||
$preferences->mods = array();
|
||||
$count = 0;
|
||||
|
||||
if ($allmods = $DB->get_records("modules") ) {
|
||||
foreach ($allmods as $mod) {
|
||||
$modname = $mod->name;
|
||||
$modfile = "$CFG->dirroot/mod/$modname/backuplib.php";
|
||||
$modbackup = $modname."_backup_mods";
|
||||
$modbackupone = $modname."_backup_one_mod";
|
||||
$modcheckbackup = $modname."_check_backup_mods";
|
||||
if (!file_exists($modfile)) {
|
||||
continue;
|
||||
}
|
||||
include_once($modfile);
|
||||
if (!function_exists($modbackup) || !function_exists($modcheckbackup)) {
|
||||
continue;
|
||||
}
|
||||
$var = "exists_".$modname;
|
||||
$preferences->$var = true;
|
||||
$count++;
|
||||
// check that there are instances and we can back them up individually
|
||||
if (!$DB->count_records('course_modules', array('course'=>$course->id), array('module'=>$mod->id)) || !function_exists($modbackupone)) {
|
||||
continue;
|
||||
}
|
||||
$var = 'exists_one_'.$modname;
|
||||
$preferences->$var = true;
|
||||
$varname = $modname.'_instances';
|
||||
$preferences->$varname = get_all_instances_in_course($modname, $course, NULL, true);
|
||||
foreach ($preferences->$varname as $instance) {
|
||||
$preferences->mods[$modname]->instances[$instance->id]->name = $instance->name;
|
||||
$var = 'backup_'.$modname.'_instance_'.$instance->id;
|
||||
$preferences->$var = true;
|
||||
$preferences->mods[$modname]->instances[$instance->id]->backup = true;
|
||||
$var = 'backup_user_info_'.$modname.'_instance_'.$instance->id;
|
||||
$preferences->$var = (!array_key_exists('userdata', $prefs) || $prefs['userdata']);
|
||||
$preferences->mods[$modname]->instances[$instance->id]->userinfo = $preferences->$var;
|
||||
$var = 'backup_'.$modname.'_instances';
|
||||
$preferences->$var = 1; // we need this later to determine what to display in modcheckbackup.
|
||||
}
|
||||
|
||||
//Check data
|
||||
//Check module info
|
||||
$preferences->mods[$modname]->name = $modname;
|
||||
|
||||
$var = "backup_".$modname;
|
||||
$preferences->$var = true;
|
||||
$preferences->mods[$modname]->backup = true;
|
||||
|
||||
//Check include user info
|
||||
$var = "backup_user_info_".$modname;
|
||||
$preferences->$var = (!array_key_exists('userdata', $prefs) || $prefs['userdata']);
|
||||
$preferences->mods[$modname]->userinfo = $preferences->$var;
|
||||
|
||||
//Call the check function to show more info
|
||||
$modcheckbackup = $modname."_check_backup_mods";
|
||||
$var = $modname.'_instances';
|
||||
$instancestopass = array();
|
||||
if (!empty($preferences->$var) && is_array($preferences->$var) && count($preferences->$var)) {
|
||||
$table->data = array();
|
||||
$countinstances = 0;
|
||||
foreach ($preferences->$var as $instance) {
|
||||
$var1 = 'backup_'.$modname.'_instance_'.$instance->id;
|
||||
$var2 = 'backup_user_info_'.$modname.'_instance_'.$instance->id;
|
||||
if (!empty($preferences->$var1)) {
|
||||
$obj = new StdClass;
|
||||
$obj->name = $instance->name;
|
||||
$obj->userdata = $preferences->$var2;
|
||||
$obj->id = $instance->id;
|
||||
$instancestopass[$instance->id]= $obj;
|
||||
$countinstances++;
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
$modcheckbackup($course->id,$preferences->$var,$preferences->backup_unique_code,$instancestopass);
|
||||
}
|
||||
}
|
||||
|
||||
//Check other parameters
|
||||
$preferences->backup_metacourse = (isset($prefs['backup_metacourse']) ? $prefs['backup_metacourse'] : 0);
|
||||
$preferences->backup_logs = (isset($prefs['backup_logs']) ? $prefs['backup_logs'] : 0);
|
||||
$preferences->backup_user_files = (isset($prefs['backup_user_files']) ? $prefs['backup_user_files'] : 0);
|
||||
$preferences->backup_course_files = (isset($prefs['backup_course_files']) ? $prefs['backup_course_files'] : 0);
|
||||
$preferences->backup_site_files = (isset($prefs['backup_site_files']) ? $prefs['backup_site_files'] : 0);
|
||||
$preferences->backup_messages = (isset($prefs['backup_messages']) ? $prefs['backup_messages'] : 0);
|
||||
$preferences->backup_gradebook_history = (isset($prefs['backup_gradebook_history']) ? $prefs['backup_gradebook_history'] : 0);
|
||||
$preferences->backup_blogs = (isset($prefs['backup_blogs']) ? $prefs['backup_blogs'] : 0);
|
||||
$preferences->backup_course = $course->id;
|
||||
|
||||
//Check users
|
||||
user_check_backup($course->id,$preferences->backup_unique_code,$preferences->backup_users,$preferences->backup_messages, $preferences->backup_blogs);
|
||||
|
||||
//Check logs
|
||||
log_check_backup($course->id);
|
||||
|
||||
//Check user files
|
||||
user_files_check_backup($course->id,$preferences->backup_unique_code);
|
||||
|
||||
//Check course files
|
||||
course_files_check_backup($course->id,$preferences->backup_unique_code);
|
||||
|
||||
//Check site files
|
||||
site_files_check_backup($course->id,$preferences->backup_unique_code);
|
||||
|
||||
//Role assignments
|
||||
$roles = $DB->get_records('role', null, 'sortorder');
|
||||
foreach ($roles as $role) {
|
||||
$preferences->backuproleassignments[$role->id] = $role;
|
||||
}
|
||||
|
||||
backup_add_static_preferences($preferences);
|
||||
return $preferences;
|
||||
}
|
||||
function add_to_backup_log($starttime,$courseid,$message, $backuptype) {
|
||||
global $DB;
|
||||
$log = new stdClass();
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue