mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-01-19 14:27:22 +01:00
Code Issues Projects Releases Wiki Activity
moodle/backup/restorelib.php

1457 lines
67 KiB
PHP
Raw Normal View History

Now backuplib.php includes all the functions needed in backup, restorelib.php all the functions needed in restore and lib.php the rest of common functions.
2003-05-14 22:09:30 +00:00
<?PHP //$Id$
Copy, expand and do preliminary checks from backup file
2003-05-16 21:52:49 +00:00
//Functions used in restore
Begin parsing xml data. Info tags.
2003-05-16 23:57:35 +00:00
//This function unzips a zip file in the same directory that it is
Copy, expand and do preliminary checks from backup file
2003-05-16 21:52:49 +00:00
//It automatically uses pclzip or command line unzip
function restore_unzip ($file,$moodle_home) {
global $CFG;
$status = true;
if (empty($CFG->unzip)) { // Use built-in php-based unzip function
include_once($moodle_home."/lib/pclzip/pclzip.lib.php");
$archive = new PclZip($file);
if (!$list = $archive->extract(dirname($file))) {
$status = false;
}
} else { // Use external unzip program
$command = "cd ".dirname($file)."; $CFG->unzip -o ".basename($file);
Exec($command);
}
return $status;
}
//This function checks if moodle.xml seems to be a valid xml file
//(exists, has an xml header and a course main tag
function restore_check_moodle_file ($file) {
$status = true;
//Check if it exists
if ($status = is_file($file)) {
//Open it and read the first 200 bytes (chars)
$handle = fopen ($file, "r");
$first_chars = fread($handle,200);
$status = fclose ($handle);
//Chek if it has the requires strings
if ($status) {
$status = strpos($first_chars,"<?xml version=\"1.0\" encoding=\"UTF-8\"?>");
if ($status !== false) {
$status = strpos($first_chars,"<MOODLE_BACKUP>");
}
}
}
return $status;
}
Begin parsing xml data. Info tags.
2003-05-16 23:57:35 +00:00
Now course header is retrieved too !!
2003-05-17 17:34:30 +00:00
//This function read the xml file and store it data from the info zone in an object
Begin parsing xml data. Info tags.
2003-05-16 23:57:35 +00:00
function restore_read_xml_info ($xml_file) {
//We call the main read_xml function, with todo = INFO
$info = restore_read_xml ($xml_file,"INFO",false);
return $info;
}
Now course header is retrieved too !!
2003-05-17 17:34:30 +00:00
//This function read the xml file and store it data from the course header zone in an object
function restore_read_xml_course_header ($xml_file) {
//We call the main read_xml function, with todo = COURSE_HEADER
$info = restore_read_xml ($xml_file,"COURSE_HEADER",false);
return $info;
}
Course Header and Backup info is showed now !! I'll start using sessions to mange all this data.
2003-05-18 15:51:20 +00:00
Finished restoring course, course_sections and course_modules. When ending the restore process, we've to update the instance field of course_modules and the modinfo field of course. Now we haven´t the necessary info to do that.
2003-05-24 00:27:45 +00:00
//This function read the xml file and store its data from the sections in a object
function restore_read_xml_sections ($xml_file) {
//We call the main read_xml function, with todo = SECTIONS
$info = restore_read_xml ($xml_file,"SECTIONS",false);
Restore into new course and existing course implemented. Restore sections and mod implemented. Restore users (all, course and none) implemented
2003-05-25 22:58:13 +00:00
return $info;
}
//This function read the xml file and store its data from the users in
//backup_ids->info db (and user's id in $info)
function restore_read_xml_users ($restore,$xml_file) {
//We call the main read_xml function, with todo = USERS
$info = restore_read_xml ($xml_file,"USERS",$restore);
Finished restoring course, course_sections and course_modules. When ending the restore process, we've to update the instance field of course_modules and the modinfo field of course. Now we haven´t the necessary info to do that.
2003-05-24 00:27:45 +00:00
return $info;
}
Begin restoring mods. Now they are readed and saved to db (backup_ids) in serialized form.
2003-05-30 21:32:04 +00:00
//This function read the xml file and store its data from the modules in
//backup_ids->info
function restore_read_xml_modules ($restore,$xml_file) {
//We call the main read_xml function, with todo = MODULES
$info = restore_read_xml ($xml_file,"MODULES",$restore);
return $info;
}
Course Header and Backup info is showed now !! I'll start using sessions to mange all this data.
2003-05-18 15:51:20 +00:00
//This function prints the contents from the info parammeter passed
function restore_print_info ($info) {
$status = true;
if ($info) {
//This is tha align to every ingo table
$table->align = array ("RIGHT","LEFT");
//This is the nowrap clause
$table->wrap = array ("","NOWRAP");
//The width
$table->width = "70%";
//Put interesting info in table
//The backup original name
$tab[0][0] = "<b>".get_string("backuporiginalname").":</b>";
$tab[0][1] = $info->backup_name;
//The moodle version
$tab[1][0] = "<b>".get_string("moodleversion").":</b>";
$tab[1][1] = $info->backup_moodle_release." (".$info->backup_moodle_version.")";
//The backup version
$tab[2][0] = "<b>".get_string("backupversion").":</b>";
$tab[2][1] = $info->backup_backup_release." (".$info->backup_backup_version.")";
//The backup date
$tab[3][0] = "<b>".get_string("backupdate").":</b>";
$tab[3][1] = userdate($info->backup_date);
//Print title
print_heading(get_string("backup").":");
$table->data = $tab;
//Print backup general info
print_table($table);
//Now backup contents in another table
$tab = array();
//First mods info
$mods = $info->mods;
$elem = 0;
foreach ($mods as $key => $mod) {
$tab[$elem][0] = "<b>".get_string("modulenameplural",$key).":</b>";
if ($mod->backup == "false") {
$tab[$elem][1] = get_string("notincluded");
} else {
if ($mod->userinfo == "true") {
$tab[$elem][1] = get_string("included")." ".get_string("withuserdata");
} else {
$tab[$elem][1] = get_string("included")." ".get_string("withoutuserdata");
}
}
$elem++;
}
//Users info
$tab[$elem][0] = "<b>".get_string("users").":</b>";
$tab[$elem][1] = get_string($info->backup_users);
$elem++;
//Logs info
$tab[$elem][0] = "<b>".get_string("logs").":</b>";
if ($info->backup_logs == "true") {
$tab[$elem][1] = get_string("yes");
} else {
$tab[$elem][1] = get_string("no");
}
$elem++;
//User Files info
$tab[$elem][0] = "<b>".get_string("userfiles").":</b>";
if ($info->backup_user_files == "true") {
$tab[$elem][1] = get_string("yes");
} else {
$tab[$elem][1] = get_string("no");
}
$elem++;
//Course Files info
$tab[$elem][0] = "<b>".get_string("coursefiles").":</b>";
if ($info->backup_course_files == "true") {
$tab[$elem][1] = get_string("yes");
} else {
$tab[$elem][1] = get_string("no");
}
$elem++;
$table->data = $tab;
//Print title
print_heading(get_string("backupdetails").":");
//Print backup general info
print_table($table);
} else {
$status = false;
}
return $status;
}
//This function prints the contents from the course_header parammeter passed
function restore_print_course_header ($course_header) {
$status = true;
if ($course_header) {
//This is tha align to every ingo table
$table->align = array ("RIGHT","LEFT");
//The width
$table->width = "70%";
//Put interesting course header in table
//The course name
$tab[0][0] = "<b>".get_string("name").":</b>";
$tab[0][1] = $course_header->course_fullname." (".$course_header->course_shortname.")";
//The course summary
$tab[1][0] = "<b>".get_string("summary").":</b>";
$tab[1][1] = $course_header->course_summary;
$table->data = $tab;
//Print title
print_heading(get_string("course").":");
//Print backup course header info
print_table($table);
} else {
$status = false;
}
return $status;
}
Finished restoring course, course_sections and course_modules. When ending the restore process, we've to update the instance field of course_modules and the modinfo field of course. Now we haven´t the necessary info to do that.
2003-05-24 00:27:45 +00:00
//This function create a new course record.
//When finished, course_header contains the id of the new course
function restore_create_new_course($restore,&$course_header) {
global $CFG;
$status = true;
$fullname = $course_header->course_fullname;
$shortname = $course_header->course_shortname;
$currentfullname = "";
$currentshortname = "";
$counter = 0;
//Iteratere while the name exists
do {
if ($counter) {
Little bug when renaming existent courses...
2003-06-03 16:32:38 +00:00
$suffixfull = " ".get_string("copy")." ".$counter;
$suffixshort = "-".$counter;
Finished restoring course, course_sections and course_modules. When ending the restore process, we've to update the instance field of course_modules and the modinfo field of course. Now we haven´t the necessary info to do that.
2003-05-24 00:27:45 +00:00
} else {
$suffixfull = "";
$suffixshort = "";
}
Little bug when renaming existent courses...
2003-06-03 16:32:38 +00:00
$currentfullname = $fullname.$suffixfull;
$currentshortname = $shortname.$suffixshort;
Finished restoring course, course_sections and course_modules. When ending the restore process, we've to update the instance field of course_modules and the modinfo field of course. Now we haven´t the necessary info to do that.
2003-05-24 00:27:45 +00:00
$course = get_record("course","fullname",addslashes($currentfullname));
$counter++;
} while ($course);
//New name = currentname
$course_header->course_fullname = $currentfullname;
$course_header->course_shortname = $currentshortname;
//Now calculate the category
$category = get_record("course_categories","id",$course_header->category->id,
"name",addslashes($course_header->category->name));
//If no exists, try by name only
if (!$category) {
$category = get_record("course_categories","name",addslashes($course_header->category->name));
}
//If no exists, get category id 1
if (!$category) {
$category = get_record("course_categories","id","1");
}
//If exists, put new category id
if ($category) {
$course_header->category->id = $category->id;
$course_header->category->name = $category->name;
//Error, cannot locate category
} else {
$course_header->category->id = 0;
$course_header->category->name = getstring("unknowcategory");
$status = false;
}
//Create the course_object
if ($status) {
$course->category = addslashes($course_header->category->id);
$course->password = addslashes($course_header->course_password);
$course->fullname = addslashes($course_header->course_fullname);
$course->shortname = addslashes($course_header->course_shortname);
$course->summary = addslashes($course_header->course_summary);
$course->format = addslashes($course_header->course_format);
$course->newsitems = addslashes($course_header->course_newsitems);
$course->teacher = addslashes($course_header->course_teacher);
$course->teachers = addslashes($course_header->course_teachers);
$course->student = addslashes($course_header->course_student);
$course->students = addslashes($course_header->course_students);
$course->guest = addslashes($course_header->course_guest);
$course->startdate = addslashes($course_header->course_startdate);
$course->numsections = addslashes($course_header->course_numsections);
$course->showrecent = addslashes($course_header->course_showrecent);
$course->marker = addslashes($course_header->course_marker);
$course->timecreated = addslashes($course_header->course_timecreated);
$course->timemodified = addslashes($course_header->course_timemodified);
//Now insert the record
$newid = insert_record("course",$course);
if ($newid) {
//save old and new course id
backup_putid ($restore->backup_unique_code,"course",$course_header->course_id,$newid);
//Replace old course_id in course_header
$course_header->course_id = $newid;
} else {
$status = false;
}
}
return $status;
}
//This function creates all the course_sections and course_modules from xml
Changed bahabior when restoring into a existing course (don't create sections and assign to section 0 if original section doesn't exist). Everything is saved in backup_ids to use it when restoring modules.
2003-05-28 23:41:56 +00:00
//when restoring in a new course or simply checks sections and create records
//in backup_ids when restoring in a existing course
Finished restoring course, course_sections and course_modules. When ending the restore process, we've to update the instance field of course_modules and the modinfo field of course. Now we haven´t the necessary info to do that.
2003-05-24 00:27:45 +00:00
function restore_create_sections($restore,$xml_file) {
Changed bahabior when restoring into a existing course (don't create sections and assign to section 0 if original section doesn't exist). Everything is saved in backup_ids to use it when restoring modules.
2003-05-28 23:41:56 +00:00
global $CFG,$db;
Finished restoring course, course_sections and course_modules. When ending the restore process, we've to update the instance field of course_modules and the modinfo field of course. Now we haven´t the necessary info to do that.
2003-05-24 00:27:45 +00:00
$status = true;
//Check it exists
if (!file_exists($xml_file)) {
$status = false;
}
//Get info from xml
if ($status) {
$info = restore_read_xml_sections($xml_file);
}
//Put the info in the DB, recoding ids and saving the in backup tables
$sequence = "";
if ($info) {
//For each, section, save it to db
foreach ($info->sections as $key => $sect) {
$sequence = "";
$section->course = $restore->course_id;
$section->section = $sect->number;
Need to addslashes before put summary section data to db !!! Now restoring sections is working. User restoring failed !! -> Too much records !!
2003-06-10 17:27:08 +00:00
$section->summary = addslashes($sect->summary);
Finished restoring course, course_sections and course_modules. When ending the restore process, we've to update the instance field of course_modules and the modinfo field of course. Now we haven´t the necessary info to do that.
2003-05-24 00:27:45 +00:00
$section->visible = $sect->visible;
$section->sequence = "";
Changed bahabior when restoring into a existing course (don't create sections and assign to section 0 if original section doesn't exist). Everything is saved in backup_ids to use it when restoring modules.
2003-05-28 23:41:56 +00:00
//Now calculate the section's newid
$newid = 0;
if ($restore->restoreto == 1) {
//Save it to db (only if restoring to new course)
$newid = insert_record("course_sections",$section);
} else {
//Get section id when restoring in existing course
$rec = get_record("course_sections","course",$restore->course_id,
"section",$section->section);
//If that section doesn't exist, get section 0 (every mod will be
//asigned there
if(!$rec) {
$rec = get_record("course_sections","course",$restore->course_id,
"section","0");
}
$newid = $rec->id;
$sequence = $rec->sequence;
}
Finished restoring course, course_sections and course_modules. When ending the restore process, we've to update the instance field of course_modules and the modinfo field of course. Now we haven´t the necessary info to do that.
2003-05-24 00:27:45 +00:00
if ($newid) {
//save old and new section id
backup_putid ($restore->backup_unique_code,"course_sections",$key,$newid);
} else {
$status = false;
}
//If all is OK, go with associated mods
if ($status) {
//If we have mods in the section
if ($sect->mods) {
//For each mod inside section
foreach ($sect->mods as $keym => $mod) {
//Check if we've to restore this module
if ($restore->mods[$mod->type]->restore) {
//Get the module id from modules
$module = get_record("modules","name",$mod->type);
if ($module) {
$course_module->course = $restore->course_id;
$course_module->module = $module->id;
$course_module->section = $newid;
$course_module->added = $mod->added;
$course_module->deleted = $mod->deleted;
$course_module->score = $mod->score;
$course_module->visible = $mod->visible;
Now readjusting course_modules instance and course modinfo os implemented and working
2003-05-31 15:21:39 +00:00
$course_module->instance = null;
//NOTE: The instance (new) is calculated and updated in db in the
Finished restoring course, course_sections and course_modules. When ending the restore process, we've to update the instance field of course_modules and the modinfo field of course. Now we haven´t the necessary info to do that.
2003-05-24 00:27:45 +00:00
// final step of the restore. We don't know it yet.
Now readjusting course_modules instance and course modinfo os implemented and working
2003-05-31 15:21:39 +00:00
//print_object($course_module); //Debug
Finished restoring course, course_sections and course_modules. When ending the restore process, we've to update the instance field of course_modules and the modinfo field of course. Now we haven´t the necessary info to do that.
2003-05-24 00:27:45 +00:00
//Save it to db
$newidmod = insert_record("course_modules",$course_module);
if ($newidmod) {
//save old and new module id
Now readjusting course_modules instance and course modinfo os implemented and working
2003-05-31 15:21:39 +00:00
//In the info field, we save the original instance of the module
//to use it later
backup_putid ($restore->backup_unique_code,"course_modules",
$keym,$newidmod,$mod->instance);
Finished restoring course, course_sections and course_modules. When ending the restore process, we've to update the instance field of course_modules and the modinfo field of course. Now we haven´t the necessary info to do that.
2003-05-24 00:27:45 +00:00
} else {
$status = false;
}
//Now, calculate the sequence field
if ($status) {
if ($sequence) {
$sequence .= ",".$newidmod;
} else {
$sequence = $newidmod;
}
}
} else {
$status = false;
}
}
}
}
}
//If all is OK, update sequence field in course_sections
if ($status) {
$rec->id = $newid;
$rec->sequence = $sequence;
Bug solved restoring in existing course.
2003-06-12 22:30:20 +00:00
//Unset other fields before update (we don't want them)
//Only need id and sequence !! Previously, existing bug
//because update without addslashes in summary
unset($rec->course);
unset($rec->section);
unset($rec->summary);
unset($rec->visible);
Finished restoring course, course_sections and course_modules. When ending the restore process, we've to update the instance field of course_modules and the modinfo field of course. Now we haven´t the necessary info to do that.
2003-05-24 00:27:45 +00:00
$status = update_record("course_sections",$rec);
}
}
} else {
$status = false;
}
return $status;
}
Restore into new course and existing course implemented. Restore sections and mod implemented. Restore users (all, course and none) implemented
2003-05-25 22:58:13 +00:00
//This function creates all the user, user_students, user_teachers
//user_course_creators and user_admins from xml
function restore_create_users($restore,$xml_file) {
Some improvements and tons of flushes !!
2003-06-12 17:38:36 +00:00
global $CFG, $db;
Restore into new course and existing course implemented. Restore sections and mod implemented. Restore users (all, course and none) implemented
2003-05-25 22:58:13 +00:00
$status = true;
//Check it exists
if (!file_exists($xml_file)) {
$status = false;
}
//Get info from xml
if ($status) {
//info will contain the old_id of every user
//in backup_ids->info will be the real info (serialized)
$info = restore_read_xml_users($restore,$xml_file);
}
//Now, get evey user_id from $info and user data from $backup_ids
//and create the necessary records (users, user_students, user_teachers
//user_course_creators and user_admins
if ($info) {
//For each, user, take its info from backup_ids
foreach ($info->users as $userid) {
$rec = backup_getid($restore->backup_unique_code,"user",$userid);
Changes in: - Saving temp data to fs, instead of db (mysql limit bug OUT) - Modified clean directories (moodle standard delete dir function seems to work wrong with large dirs - Send info to browser continuosly to avoid timeouts. - Increase php execution time limit - More checks. - Restore into existing course now works fine - Create course_dir if it doesn't exist in the final step of backup.
2003-06-20 19:42:20 +00:00
$user = $rec->info;
Restore into new course and existing course implemented. Restore sections and mod implemented. Restore users (all, course and none) implemented
2003-05-25 22:58:13 +00:00
//Calculate if it is a course user
//Has role teacher or student or admin or coursecreator
$is_course_user = ($user->roles[teacher] or $user->roles[student] or
$user->roles[admin] or $user->roles[coursecreator]);
//Check if it's admin and coursecreator
$is_admin = ($user->roles[admin]);
$is_coursecreator = ($user->roles[coursecreator]);
//Check if it's teacher and student
$is_teacher = ($user->roles[teacher]);
$is_student = ($user->roles[student]);
Minor bug creating newid when restorinf users
2003-05-25 23:37:07 +00:00
//To store new ids created
$newid=null;
//check if it exists (by username) and get its id
Restore into new course and existing course implemented. Restore sections and mod implemented. Restore users (all, course and none) implemented
2003-05-25 22:58:13 +00:00
$user_exists = true;
Minor bug creating newid when restorinf users
2003-05-25 23:37:07 +00:00
$user_data = get_record("user","username",$user->username);
if (!$user_data) {
Restore into new course and existing course implemented. Restore sections and mod implemented. Restore users (all, course and none) implemented
2003-05-25 22:58:13 +00:00
$user_exists = false;
Minor bug creating newid when restorinf users
2003-05-25 23:37:07 +00:00
} else {
$newid = $user_data->id;
Restore into new course and existing course implemented. Restore sections and mod implemented. Restore users (all, course and none) implemented
2003-05-25 22:58:13 +00:00
}
//Flags to see if we have to create the user and roles
$create_user = true;
$create_roles = true;
//If we are restoring course users and it isn't a course user
if ($restore->users == 1 and !$is_course_user) {
//If only restoring course_users and user isn't a course_user, inform to $backup_ids
$status = backup_putid($restore->backup_unique_code,"user",$userid,null,'notincourse');
$create_user = false;
$create_roles = false;
}
if ($user_exists and $create_user) {
//If user exists mark its newid in backup_ids (the same than old)
Minor bug creating newid when restorinf users
2003-05-25 23:37:07 +00:00
$status = backup_putid($restore->backup_unique_code,"user",$userid,$newid,'exists');
Restore into new course and existing course implemented. Restore sections and mod implemented. Restore users (all, course and none) implemented
2003-05-25 22:58:13 +00:00
$create_user = false;
}
//Here, if create_user, do it
if ($create_user) {
Some improvements and tons of flushes !!
2003-06-12 17:38:36 +00:00
//We addslashes to necessary fields
$user->username = addslashes($user->username);
$user->firstname = addslashes($user->firstname);
$user->lastname = addslashes($user->lastname);
$user->email = addslashes($user->email);
$user->institution = addslashes($user->institution);
$user->department = addslashes($user->department);
$user->address = addslashes($user->address);
$user->city = addslashes($user->city);
$user->url = addslashes($user->url);
$user->description = addslashes($user->description);
Restore into new course and existing course implemented. Restore sections and mod implemented. Restore users (all, course and none) implemented
2003-05-25 22:58:13 +00:00
//We are going to create the user
//The structure is exactly as we need
$newid = insert_record ("user",$user);
//Put the new id
Few changes to gather info to show in restore progress (various user counts (existing, new,...)
2003-05-26 00:07:56 +00:00
$status = backup_putid($restore->backup_unique_code,"user",$userid,$newid,"new");
Restore into new course and existing course implemented. Restore sections and mod implemented. Restore users (all, course and none) implemented
2003-05-25 22:58:13 +00:00
}
//Here, if create_roles, do it as necessary
if ($create_roles) {
Few changes to gather info to show in restore progress (various user counts (existing, new,...)
2003-05-26 00:07:56 +00:00
//Get the newid and currecnt info from backup_ids
Restore into new course and existing course implemented. Restore sections and mod implemented. Restore users (all, course and none) implemented
2003-05-25 22:58:13 +00:00
$data = backup_getid($restore->backup_unique_code,"user",$userid);
$newid = $data->new_id;
Few changes to gather info to show in restore progress (various user counts (existing, new,...)
2003-05-26 00:07:56 +00:00
$currinfo = $data->info.",";
Restore into new course and existing course implemented. Restore sections and mod implemented. Restore users (all, course and none) implemented
2003-05-25 22:58:13 +00:00
//Now, depending of the role, create records in user_studentes and user_teacher
//and/or mark it in backup_ids
if ($is_admin) {
Few changes to gather info to show in restore progress (various user counts (existing, new,...)
2003-05-26 00:07:56 +00:00
//If the record (user_admins) doesn't exists
if (!record_exists("user_admins","userid",$newid)) {
//Only put status in backup_ids
$currinfo = $currinfo."admin,";
$status = backup_putid($restore->backup_unique_code,"user",$userid,$newid,$currinfo);
}
Restore into new course and existing course implemented. Restore sections and mod implemented. Restore users (all, course and none) implemented
2003-05-25 22:58:13 +00:00
}
if ($is_coursecreator) {
Few changes to gather info to show in restore progress (various user counts (existing, new,...)
2003-05-26 00:07:56 +00:00
//If the record (user_coursecreators) doesn't exists
if (!record_exists("user_coursecreators","userid",$newid)) {
//Only put status in backup_ids
$currinfo = $currinfo."coursecreator,";
$status = backup_putid($restore->backup_unique_code,"user",$userid,$newid,$currinfo);
}
Restore into new course and existing course implemented. Restore sections and mod implemented. Restore users (all, course and none) implemented
2003-05-25 22:58:13 +00:00
}
if ($is_teacher) {
//If the record (teacher) doesn't exists
if (!record_exists("user_teachers","userid",$newid,"course", $restore->course_id)) {
Minor bug creating newid when restorinf users
2003-05-25 23:37:07 +00:00
//Put status in backup_ids
Few changes to gather info to show in restore progress (various user counts (existing, new,...)
2003-05-26 00:07:56 +00:00
$currinfo = $currinfo."teacher,";
$status = backup_putid($restore->backup_unique_code,"user",$userid,$newid,$currinfo);
Restore into new course and existing course implemented. Restore sections and mod implemented. Restore users (all, course and none) implemented
2003-05-25 22:58:13 +00:00
//Set course and user
$user->roles[teacher]->course = $restore->course_id;
$user->roles[teacher]->userid = $newid;
//Insert data in user_teachers
//The structure is exactly as we need
$status = insert_record("user_teachers",$user->roles[teacher]);
}
}
if ($is_student) {
//If the record (student) doesn't exists
if (!record_exists("user_students","userid",$newid,"course", $restore->course_id)) {
Minor bug creating newid when restorinf users
2003-05-25 23:37:07 +00:00
//Put status in backup_ids
Few changes to gather info to show in restore progress (various user counts (existing, new,...)
2003-05-26 00:07:56 +00:00
$currinfo = $currinfo."student,";
$status = backup_putid($restore->backup_unique_code,"user",$userid,$newid,$currinfo);
Restore into new course and existing course implemented. Restore sections and mod implemented. Restore users (all, course and none) implemented
2003-05-25 22:58:13 +00:00
//Set course and user
$user->roles[student]->course = $restore->course_id;
$user->roles[student]->userid = $newid;
//Insert data in user_students
//The structure is exactly as we need
$status = insert_record("user_students",$user->roles[student]);
}
}
if (!$is_course_user) {
Few changes to gather info to show in restore progress (various user counts (existing, new,...)
2003-05-26 00:07:56 +00:00
//If the record (user) doesn't exists
if (!record_exists("user","id",$newid)) {
//Put status in backup_ids
$currinfo = $currinfo."user,";
$status = backup_putid($restore->backup_unique_code,"user",$userid,$newid,$currinfo);
}
Restore into new course and existing course implemented. Restore sections and mod implemented. Restore users (all, course and none) implemented
2003-05-25 22:58:13 +00:00
}
}
}
} else {
$status = false;
}
return $status;
}
Implemented copying course_files and user_files.
2003-05-28 19:43:11 +00:00
//This function restores the userfiles from the temp (user_files) directory to the
//dataroot/users directory
function restore_user_files($restore) {
global $CFG;
$status = true;
//First, we check to "users" exists and create is as necessary
//in CFG->dataroot
$dest_dir = $CFG->dataroot."/users";
$status = check_dir_exists($dest_dir,true);
//Now, we iterate over "user_files" records to check if that user dir must be
//copied (and renamed) to the "users" dir.
$rootdir = $CFG->dataroot."/temp/backup/".$restore->backup_unique_code."/user_files";
//Check if directory exists
if (is_dir($rootdir)) {
$list = list_directories ($rootdir);
if ($list) {
//Iterate
$counter = 0;
foreach ($list as $dir) {
//Look for dir like username in backup_ids
$data = get_record ("backup_ids","backup_code",$restore->backup_unique_code,
"table_name","user",
"old_id",$dir);
//If thar user exists in backup_ids
if ($data) {
//Only it user has been created now
if (strpos($data->info,"new") !== false) {
//Copy the old_dir to its new location (and name) !!
//Only if destination doesn't exists
if (!file_exists($dest_dir."/".$data->new_id)) {
$status = backup_copy_file($rootdir."/".$dir,
$dest_dir."/".$data->new_id);
$counter ++;
}
Minor change to avoid timeouts copying user files and course files.
2003-06-21 22:37:57 +00:00
//Do some output
if ($counter % 2 == 0) {
echo ".";
if ($counter % 40 == 0) {
echo "<br>";
}
backup_flush(300);
}
Implemented copying course_files and user_files.
2003-05-28 19:43:11 +00:00
}
}
}
}
}
//If status is ok and whe have dirs created, returns counter to inform
if ($status and $counter) {
return $counter;
} else {
return $status;
}
}
//This function restores the course files from the temp (course_files) directory to the
//dataroot/course_id directory
function restore_course_files($restore) {
global $CFG;
$status = true;
//First, we check to "course_id" exists and create is as necessary
//in CFG->dataroot
$dest_dir = $CFG->dataroot."/".$restore->course_id;
$status = check_dir_exists($dest_dir,true);
//Now, we iterate over "course_files" records to check if that file/dir must be
//copied to the "dest_dir" dir.
$rootdir = $CFG->dataroot."/temp/backup/".$restore->backup_unique_code."/course_files";
//Check if directory exists
if (is_dir($rootdir)) {
$list = list_directories_and_files ($rootdir);
if ($list) {
//Iterate
$counter = 0;
foreach ($list as $dir) {
//Copy the dir to its new location
//Only if destination file/dir doesn exists
if (!file_exists($dest_dir."/".$dir)) {
$status = backup_copy_file($rootdir."/".$dir,
$dest_dir."/".$dir);
$counter ++;
}
Minor change to avoid timeouts copying user files and course files.
2003-06-21 22:37:57 +00:00
//Do some output
if ($counter % 2 == 0) {
echo ".";
if ($counter % 40 == 0) {
echo "<br>";
}
backup_flush(300);
}
Implemented copying course_files and user_files.
2003-05-28 19:43:11 +00:00
}
}
}
//If status is ok and whe have dirs created, returns counter to inform
if ($status and $counter) {
return $counter;
} else {
return $status;
}
}
Now course header is retrieved too !!
2003-05-17 17:34:30 +00:00
Begin restoring mods. Now they are readed and saved to db (backup_ids) in serialized form.
2003-05-30 21:32:04 +00:00
//This function creates all the structures for every module in backup file
//Depending what has been selected.
function restore_create_modules($restore,$xml_file) {
global $CFG;
$status = true;
//Check it exists
if (!file_exists($xml_file)) {
$status = false;
}
//Get info from xml
if ($status) {
Return info to know what modules process...
2003-05-30 22:55:40 +00:00
//info will contain the id and modtype of every module
Begin restoring mods. Now they are readed and saved to db (backup_ids) in serialized form.
2003-05-30 21:32:04 +00:00
//in backup_ids->info will be the real info (serialized)
$info = restore_read_xml_modules($restore,$xml_file);
}
Return info to know what modules process...
2003-05-30 22:55:40 +00:00
//Now, if we have anything in info, we have to restore that mods
//from backup_ids (calling every mod restore function)
if ($info) {
Changes in: - Saving temp data to fs, instead of db (mysql limit bug OUT) - Modified clean directories (moodle standard delete dir function seems to work wrong with large dirs - Send info to browser continuosly to avoid timeouts. - Increase php execution time limit - More checks. - Restore into existing course now works fine - Create course_dir if it doesn't exist in the final step of backup.
2003-06-20 19:42:20 +00:00
if ($info !== true) {
//Iterate over each module
foreach ($info as $mod) {
$modrestore = $mod->modtype."_restore_mods";
if (function_exists($modrestore)) {
//print_object ($mod); //Debug
$status = $modrestore($mod,$restore);
} else {
//Something was wrong. Function should exist.
$status = false;
}
Now readjusting course_modules instance and course modinfo os implemented and working
2003-05-31 15:21:39 +00:00
}
}
} else {
$status = false;
}
return $status;
}
//This function adjusts the instance field into course_modules. It's executed after
//modules restore. There, we KNOW the new instance id !!
function restore_check_instances($restore) {
global $CFG;
$status = true;
Return info to know what modules process...
2003-05-30 22:55:40 +00:00
Now readjusting course_modules instance and course modinfo os implemented and working
2003-05-31 15:21:39 +00:00
//We are going to iterate over each course_module saved in backup_ids
Changes in: - Saving temp data to fs, instead of db (mysql limit bug OUT) - Modified clean directories (moodle standard delete dir function seems to work wrong with large dirs - Send info to browser continuosly to avoid timeouts. - Increase php execution time limit - More checks. - Restore into existing course now works fine - Create course_dir if it doesn't exist in the final step of backup.
2003-06-20 19:42:20 +00:00
$course_modules = get_records_sql("SELECT old_id,new_id
Now readjusting course_modules instance and course modinfo os implemented and working
2003-05-31 15:21:39 +00:00
FROM {$CFG->prefix}backup_ids
WHERE backup_code = '$restore->backup_unique_code' AND
table_name = 'course_modules'");
if ($course_modules) {
foreach($course_modules as $cm) {
Changes in: - Saving temp data to fs, instead of db (mysql limit bug OUT) - Modified clean directories (moodle standard delete dir function seems to work wrong with large dirs - Send info to browser continuosly to avoid timeouts. - Increase php execution time limit - More checks. - Restore into existing course now works fine - Create course_dir if it doesn't exist in the final step of backup.
2003-06-20 19:42:20 +00:00
//Get full record, using backup_getids
$cm_module = backup_getid($restore->backup_unique_code,"course_modules",$cm->old_id);
Now readjusting course_modules instance and course modinfo os implemented and working
2003-05-31 15:21:39 +00:00
//Now we are going to the REAL course_modules to get its type (field module)
Changes in: - Saving temp data to fs, instead of db (mysql limit bug OUT) - Modified clean directories (moodle standard delete dir function seems to work wrong with large dirs - Send info to browser continuosly to avoid timeouts. - Increase php execution time limit - More checks. - Restore into existing course now works fine - Create course_dir if it doesn't exist in the final step of backup.
2003-06-20 19:42:20 +00:00
$module = get_record("course_modules","id",$cm_module->new_id);
Now readjusting course_modules instance and course modinfo os implemented and working
2003-05-31 15:21:39 +00:00
if ($module) {
//We know the module type id. Get the name from modules
$type = get_record("modules","id",$module->module);
if ($type) {
//We know the type name and the old_id. Get its new_id
//from backup_ids. It's the instance !!!
Changes in: - Saving temp data to fs, instead of db (mysql limit bug OUT) - Modified clean directories (moodle standard delete dir function seems to work wrong with large dirs - Send info to browser continuosly to avoid timeouts. - Increase php execution time limit - More checks. - Restore into existing course now works fine - Create course_dir if it doesn't exist in the final step of backup.
2003-06-20 19:42:20 +00:00
$instance = backup_getid($restore->backup_unique_code,$type->name,$cm_module->info);
Now readjusting course_modules instance and course modinfo os implemented and working
2003-05-31 15:21:39 +00:00
if ($instance) {
//We have the new instance, so update the record in course_modules
$module->instance = $instance->new_id;
//print_object ($module); //Debug
$status = update_record("course_modules",$module);
} else {
$status = false;
}
} else {
$status = false;
}
} else {
$status = false;
}
}
Return info to know what modules process...
2003-05-30 22:55:40 +00:00
}
Now readjusting course_modules instance and course modinfo os implemented and working
2003-05-31 15:21:39 +00:00
return $status;
Begin restoring mods. Now they are readed and saved to db (backup_ids) in serialized form.
2003-05-30 21:32:04 +00:00
}
Begin parsing xml data. Info tags.
2003-05-16 23:57:35 +00:00
//=====================================================================================
//== ==
//== XML Functions (SAX) ==
//== ==
//=====================================================================================
//This is the class used to do all the xml parse
class MoodleParser {
var $level = 0; //Level we are
Changes in: - Saving temp data to fs, instead of db (mysql limit bug OUT) - Modified clean directories (moodle standard delete dir function seems to work wrong with large dirs - Send info to browser continuosly to avoid timeouts. - Increase php execution time limit - More checks. - Restore into existing course now works fine - Create course_dir if it doesn't exist in the final step of backup.
2003-06-20 19:42:20 +00:00
var $counter = 0; //Counter
Begin parsing xml data. Info tags.
2003-05-16 23:57:35 +00:00
var $tree = array(); //Array of levels we are
var $content = ""; //Content under current level
var $todo = ""; //What we hav to do when parsing
Return info to know what modules process...
2003-05-30 22:55:40 +00:00
var $info = ""; //Information collected. Temp storage. Used to return data after parsing.
var $temp = ""; //Temp storage.
Begin parsing xml data. Info tags.
2003-05-16 23:57:35 +00:00
var $preferences = ""; //Preferences about what to load !!
var $finished = false; //Flag to say xml_parse to stop
Now course header is retrieved too !!
2003-05-17 17:34:30 +00:00
//This function is used to get the current contents property value
//They are trimed and converted from utf8
function getContents() {
return trim(utf8_decode($this->content));
}
Reading more info...
2003-05-17 11:40:27 +00:00
//This is the startTag handler we use where we are reading the info zone (todo="INFO")
function startElementInfo($parser, $tagName, $attrs) {
//Refresh properties
$this->level++;
$this->tree[$this->level] = $tagName;
Some improvements and tons of flushes !!
2003-06-12 17:38:36 +00:00
//Output something to avoid browser timeouts...
backup_flush();
Reading more info...
2003-05-17 11:40:27 +00:00
//Check if we are into INFO zone
//if ($this->tree[2] == "INFO") //Debug
// echo $this->level.str_repeat("&nbsp;",$this->level*2)."&lt;".$tagName."&gt;<br>\n"; //Debug
}
Begin parsing xml data. Info tags.
2003-05-16 23:57:35 +00:00
Now course header is retrieved too !!
2003-05-17 17:34:30 +00:00
//This is the startTag handler we use where we are reading the course header zone (todo="COURSE_HEADER")
function startElementCourseHeader($parser, $tagName, $attrs) {
//Refresh properties
$this->level++;
$this->tree[$this->level] = $tagName;
Some improvements and tons of flushes !!
2003-06-12 17:38:36 +00:00
//Output something to avoid browser timeouts...
backup_flush();
Now course header is retrieved too !!
2003-05-17 17:34:30 +00:00
//Check if we are into COURSE_HEADER zone
//if ($this->tree[3] == "HEADER") //Debug
// echo $this->level.str_repeat("&nbsp;",$this->level*2)."&lt;".$tagName."&gt;<br>\n"; //Debug
}
Finished restoring course, course_sections and course_modules. When ending the restore process, we've to update the instance field of course_modules and the modinfo field of course. Now we haven´t the necessary info to do that.
2003-05-24 00:27:45 +00:00
//This is the startTag handler we use where we are reading the sections zone (todo="SECTIONS")
function startElementSections($parser, $tagName, $attrs) {
//Refresh properties
$this->level++;
$this->tree[$this->level] = $tagName;
Some improvements and tons of flushes !!
2003-06-12 17:38:36 +00:00
//Output something to avoid browser timeouts...
backup_flush();
Finished restoring course, course_sections and course_modules. When ending the restore process, we've to update the instance field of course_modules and the modinfo field of course. Now we haven´t the necessary info to do that.
2003-05-24 00:27:45 +00:00
//Check if we are into SECTIONS zone
//if ($this->tree[3] == "SECTIONS") //Debug
// echo $this->level.str_repeat("&nbsp;",$this->level*2)."&lt;".$tagName."&gt;<br>\n"; //Debug
}
Restore into new course and existing course implemented. Restore sections and mod implemented. Restore users (all, course and none) implemented
2003-05-25 22:58:13 +00:00
//This is the startTag handler we use where we are reading the user zone (todo="USERS")
function startElementUsers($parser, $tagName, $attrs) {
//Refresh properties
$this->level++;
$this->tree[$this->level] = $tagName;
Some improvements and tons of flushes !!
2003-06-12 17:38:36 +00:00
Restore into new course and existing course implemented. Restore sections and mod implemented. Restore users (all, course and none) implemented
2003-05-25 22:58:13 +00:00
//Check if we are into USERS zone
//if ($this->tree[3] == "USERS") //Debug
// echo $this->level.str_repeat("&nbsp;",$this->level*2)."&lt;".$tagName."&gt;<br>\n"; //Debug
}
Finished restoring course, course_sections and course_modules. When ending the restore process, we've to update the instance field of course_modules and the modinfo field of course. Now we haven´t the necessary info to do that.
2003-05-24 00:27:45 +00:00
Begin restoring mods. Now they are readed and saved to db (backup_ids) in serialized form.
2003-05-30 21:32:04 +00:00
//This is the startTag handler we use where we are reading the modules zone (todo="MODULES")
function startElementModules($parser, $tagName, $attrs) {
//Refresh properties
$this->level++;
$this->tree[$this->level] = $tagName;
Some improvements and tons of flushes !!
2003-06-12 17:38:36 +00:00
Changes in: - Saving temp data to fs, instead of db (mysql limit bug OUT) - Modified clean directories (moodle standard delete dir function seems to work wrong with large dirs - Send info to browser continuosly to avoid timeouts. - Increase php execution time limit - More checks. - Restore into existing course now works fine - Create course_dir if it doesn't exist in the final step of backup.
2003-06-20 19:42:20 +00:00
if ($tagName == "MOD" && $this->tree[3] == "MODULES") {
echo "<P>MOD: ".strftime ("%X",time()),"-";
}
Some improvements and tons of flushes !!
2003-06-12 17:38:36 +00:00
//Output something to avoid browser timeouts...
backup_flush();
Begin restoring mods. Now they are readed and saved to db (backup_ids) in serialized form.
2003-05-30 21:32:04 +00:00
//Check if we are into MODULES zone
//if ($this->tree[3] == "MODULES") //Debug
// echo $this->level.str_repeat("&nbsp;",$this->level*2)."&lt;".$tagName."&gt;<br>\n"; //Debug
Some improvements and tons of flushes !!
2003-06-12 17:38:36 +00:00
Begin restoring mods. Now they are readed and saved to db (backup_ids) in serialized form.
2003-05-30 21:32:04 +00:00
//If we are under a MOD tag under a MODULES zone, accumule it
if (($this->tree[4] == "MOD") and ($this->tree[3] == "MODULES")) {
Return info to know what modules process...
2003-05-30 22:55:40 +00:00
$this->temp .= "<".$tagName.">";
Begin restoring mods. Now they are readed and saved to db (backup_ids) in serialized form.
2003-05-30 21:32:04 +00:00
}
}
Reading more info...
2003-05-17 11:40:27 +00:00
//This is the startTag default handler we use when todo is undefined
Begin parsing xml data. Info tags.
2003-05-16 23:57:35 +00:00
function startElement($parser, $tagName, $attrs) {
$this->level++;
Debug a bit
2003-05-17 08:56:53 +00:00
$this->tree[$this->level] = $tagName;
Some improvements and tons of flushes !!
2003-06-12 17:38:36 +00:00
//Output something to avoid browser timeouts...
backup_flush();
Debug a bit
2003-05-17 08:56:53 +00:00
echo $this->level.str_repeat("&nbsp;",$this->level*2)."&lt;".$tagName."&gt;<br>\n"; //Debug
Begin parsing xml data. Info tags.
2003-05-16 23:57:35 +00:00
}
Reading more info...
2003-05-17 11:40:27 +00:00
//This is the endTag handler we use where we are reading the info zone (todo="INFO")
function endElementInfo($parser, $tagName) {
//Check if we are into INFO zone
if ($this->tree[2] == "INFO") {
//if (trim($this->content)) //Debug
Now course header is retrieved too !!
2003-05-17 17:34:30 +00:00
// echo "C".str_repeat("&nbsp;",($this->level+2)*2).$this->getContents()."<br>\n"; //Debug
Reading more info...
2003-05-17 11:40:27 +00:00
//echo $this->level.str_repeat("&nbsp;",$this->level*2)."&lt;/".$tagName."&gt;<br>\n"; //Debug
//Dependig of different combinations, do different things
if ($this->level == 3) {
switch ($tagName) {
case "NAME":
Now course header is retrieved too !!
2003-05-17 17:34:30 +00:00
$this->info->backup_name = $this->getContents();
Reading more info...
2003-05-17 11:40:27 +00:00
break;
case "MOODLE_VERSION":
Now course header is retrieved too !!
2003-05-17 17:34:30 +00:00
$this->info->backup_moodle_version = $this->getContents();
Reading more info...
2003-05-17 11:40:27 +00:00
break;
case "MOODLE_RELEASE":
Now course header is retrieved too !!
2003-05-17 17:34:30 +00:00
$this->info->backup_moodle_release = $this->getContents();
Reading more info...
2003-05-17 11:40:27 +00:00
break;
case "BACKUP_VERSION":
Now course header is retrieved too !!
2003-05-17 17:34:30 +00:00
$this->info->backup_backup_version = $this->getContents();
Reading more info...
2003-05-17 11:40:27 +00:00
break;
case "BACKUP_RELEASE":
Now course header is retrieved too !!
2003-05-17 17:34:30 +00:00
$this->info->backup_backup_release = $this->getContents();
Reading more info...
2003-05-17 11:40:27 +00:00
break;
case "DATE":
Now course header is retrieved too !!
2003-05-17 17:34:30 +00:00
$this->info->backup_date = $this->getContents();
Reading more info...
2003-05-17 11:40:27 +00:00
break;
}
}
if ($this->tree[3] == "DETAILS") {
if ($this->level == 4) {
switch ($tagName) {
case "USERS":
Now course header is retrieved too !!
2003-05-17 17:34:30 +00:00
$this->info->backup_users = $this->getContents();
Reading more info...
2003-05-17 11:40:27 +00:00
break;
case "LOGS":
Now course header is retrieved too !!
2003-05-17 17:34:30 +00:00
$this->info->backup_logs = $this->getContents();
Reading more info...
2003-05-17 11:40:27 +00:00
break;
case "USERFILES":
Now course header is retrieved too !!
2003-05-17 17:34:30 +00:00
$this->info->backup_user_files = $this->getContents();
Reading more info...
2003-05-17 11:40:27 +00:00
break;
case "COURSEFILES":
Now course header is retrieved too !!
2003-05-17 17:34:30 +00:00
$this->info->backup_course_files = $this->getContents();
Reading more info...
2003-05-17 11:40:27 +00:00
break;
}
}
if ($this->level == 5) {
switch ($tagName) {
case "NAME":
Now course header is retrieved too !!
2003-05-17 17:34:30 +00:00
$this->info->tempName = $this->getContents();
Reading more info...
2003-05-17 11:40:27 +00:00
break;
case "INCLUDED":
Now course header is retrieved too !!
2003-05-17 17:34:30 +00:00
$this->info->mods[$this->info->tempName]->backup = $this->getContents();
break;
case "USERINFO":
$this->info->mods[$this->info->tempName]->userinfo = $this->getContents();
Reading more info...
2003-05-17 11:40:27 +00:00
break;
}
}
}
Now course header is retrieved too !!
2003-05-17 17:34:30 +00:00
}
Reading more info...
2003-05-17 11:40:27 +00:00
Begin parsing xml data. Info tags.
2003-05-16 23:57:35 +00:00
Now course header is retrieved too !!
2003-05-17 17:34:30 +00:00
//Clear things
$this->tree[$this->level] = "";
$this->level--;
$this->content = "";
Reading more info...
2003-05-17 11:40:27 +00:00
//Stop parsing if todo = INFO and tagName = INFO (en of the tag, of course)
//Speed up a lot (avoid parse all)
if ($tagName == "INFO") {
$this->finished = true;
}
}
Now course header is retrieved too !!
2003-05-17 17:34:30 +00:00
//This is the endTag handler we use where we are reading the course_header zone (todo="COURSE_HEADER")
function endElementCourseHeader($parser, $tagName) {
//Check if we are into COURSE_HEADER zone
if ($this->tree[3] == "HEADER") {
//if (trim($this->content)) //Debug
// echo "C".str_repeat("&nbsp;",($this->level+2)*2).$this->getContents()."<br>\n"; //Debug
//echo $this->level.str_repeat("&nbsp;",$this->level*2)."&lt;/".$tagName."&gt;<br>\n"; //Debug
//Dependig of different combinations, do different things
if ($this->level == 4) {
switch ($tagName) {
case "ID":
$this->info->course_id = $this->getContents();
break;
case "PASSWORD":
$this->info->course_password = $this->getContents();
break;
case "FULLNAME":
$this->info->course_fullname = $this->getContents();
break;
case "SHORTNAME":
$this->info->course_shortname = $this->getContents();
break;
case "SUMMARY":
$this->info->course_summary = $this->getContents();
break;
case "FORMAT":
$this->info->course_format = $this->getContents();
break;
case "NEWSITEMS":
$this->info->course_newsitems = $this->getContents();
break;
case "TEACHER":
$this->info->course_teacher = $this->getContents();
break;
case "TEACHERS":
$this->info->course_teachers = $this->getContents();
break;
case "STUDENT":
$this->info->course_student = $this->getContents();
break;
case "STUDENTS":
$this->info->course_students = $this->getContents();
break;
case "GUEST":
$this->info->course_guest = $this->getContents();
break;
case "STARDATE":
$this->info->course_stardate = $this->getContents();
break;
case "NUMSECTIONS":
$this->info->course_numsections = $this->getContents();
break;
case "SHOWRECENT":
$this->info->course_showrecent = $this->getContents();
break;
case "MARKER":
$this->info->course_marker = $this->getContents();
break;
case "TIMECREATED":
$this->info->course_timecreated = $this->getContents();
break;
case "TIMEMODIFIED":
$this->info->course_timemodified = $this->getContents();
break;
}
}
if ($this->tree[4] == "CATEGORY") {
if ($this->level == 5) {
switch ($tagName) {
case "ID":
$this->info->category->id = $this->getContents();
break;
case "NAME":
$this->info->category->name = $this->getContents();
break;
}
}
}
}
//Clear things
$this->tree[$this->level] = "";
$this->level--;
$this->content = "";
//Stop parsing if todo = COURSE_HEADER and tagName = HEADER (en of the tag, of course)
//Speed up a lot (avoid parse all)
if ($tagName == "HEADER") {
$this->finished = true;
}
}
Finished restoring course, course_sections and course_modules. When ending the restore process, we've to update the instance field of course_modules and the modinfo field of course. Now we haven´t the necessary info to do that.
2003-05-24 00:27:45 +00:00
//This is the endTag handler we use where we are reading the sections zone (todo="SECTIONS")
function endElementSections($parser, $tagName) {
//Check if we are into SECTIONS zone
if ($this->tree[3] == "SECTIONS") {
//if (trim($this->content)) //Debug
// echo "C".str_repeat("&nbsp;",($this->level+2)*2).$this->getContents()."<br>\n"; //Debug
//echo $this->level.str_repeat("&nbsp;",$this->level*2)."&lt;/".$tagName."&gt;<br>\n"; //Debug
//Dependig of different combinations, do different things
if ($this->level == 4) {
switch ($tagName) {
case "SECTION":
//We've finalized a section, get it
$this->info->sections[$this->info->tempsection->id]->number = $this->info->tempsection->number;
$this->info->sections[$this->info->tempsection->id]->summary = $this->info->tempsection->summary;
$this->info->sections[$this->info->tempsection->id]->visible = $this->info->tempsection->visible;
Changed bahabior when restoring into a existing course (don't create sections and assign to section 0 if original section doesn't exist). Everything is saved in backup_ids to use it when restoring modules.
2003-05-28 23:41:56 +00:00
$this->info->sections[$this->info->tempsection->id]->mods = $this->info->tempsection->mods;
Finished restoring course, course_sections and course_modules. When ending the restore process, we've to update the instance field of course_modules and the modinfo field of course. Now we haven´t the necessary info to do that.
2003-05-24 00:27:45 +00:00
unset($this->info->tempsection);
}
}
if ($this->level == 5) {
switch ($tagName) {
case "ID":
$this->info->tempsection->id = $this->getContents();
break;
case "NUMBER":
$this->info->tempsection->number = $this->getContents();
break;
case "SUMMARY":
$this->info->tempsection->summary = $this->getContents();
break;
case "VISIBLE":
$this->info->tempsection->visible = $this->getContents();
break;
}
}
if ($this->level == 6) {
switch ($tagName) {
case "MOD":
Restore into new course and existing course implemented. Restore sections and mod implemented. Restore users (all, course and none) implemented
2003-05-25 22:58:13 +00:00
//We've finalized a mod, get it
$this->info->tempsection->mods[$this->info->tempmod->id]->type =
Finished restoring course, course_sections and course_modules. When ending the restore process, we've to update the instance field of course_modules and the modinfo field of course. Now we haven´t the necessary info to do that.
2003-05-24 00:27:45 +00:00
$this->info->tempmod->type;
Restore into new course and existing course implemented. Restore sections and mod implemented. Restore users (all, course and none) implemented
2003-05-25 22:58:13 +00:00
$this->info->tempsection->mods[$this->info->tempmod->id]->instance =
Finished restoring course, course_sections and course_modules. When ending the restore process, we've to update the instance field of course_modules and the modinfo field of course. Now we haven´t the necessary info to do that.
2003-05-24 00:27:45 +00:00
$this->info->tempmod->instance;
Restore into new course and existing course implemented. Restore sections and mod implemented. Restore users (all, course and none) implemented
2003-05-25 22:58:13 +00:00
$this->info->tempsection->mods[$this->info->tempmod->id]->added =
Finished restoring course, course_sections and course_modules. When ending the restore process, we've to update the instance field of course_modules and the modinfo field of course. Now we haven´t the necessary info to do that.
2003-05-24 00:27:45 +00:00
$this->info->tempmod->added;
Restore into new course and existing course implemented. Restore sections and mod implemented. Restore users (all, course and none) implemented
2003-05-25 22:58:13 +00:00
$this->info->tempsection->mods[$this->info->tempmod->id]->deleted =
Finished restoring course, course_sections and course_modules. When ending the restore process, we've to update the instance field of course_modules and the modinfo field of course. Now we haven´t the necessary info to do that.
2003-05-24 00:27:45 +00:00
$this->info->tempmod->deleted;
Restore into new course and existing course implemented. Restore sections and mod implemented. Restore users (all, course and none) implemented
2003-05-25 22:58:13 +00:00
$this->info->tempsection->mods[$this->info->tempmod->id]->score =
Finished restoring course, course_sections and course_modules. When ending the restore process, we've to update the instance field of course_modules and the modinfo field of course. Now we haven´t the necessary info to do that.
2003-05-24 00:27:45 +00:00
$this->info->tempmod->score;
Restore into new course and existing course implemented. Restore sections and mod implemented. Restore users (all, course and none) implemented
2003-05-25 22:58:13 +00:00
$this->info->tempsection->mods[$this->info->tempmod->id]->visible =
Finished restoring course, course_sections and course_modules. When ending the restore process, we've to update the instance field of course_modules and the modinfo field of course. Now we haven´t the necessary info to do that.
2003-05-24 00:27:45 +00:00
$this->info->tempmod->visible;
unset($this->info->tempmod);
}
}
if ($this->level == 7) {
switch ($tagName) {
case "ID":
$this->info->tempmod->id = $this->getContents();
break;
case "TYPE":
$this->info->tempmod->type = $this->getContents();
break;
case "INSTANCE":
$this->info->tempmod->instance = $this->getContents();
break;
case "ADDED":
$this->info->tempmod->added = $this->getContents();
break;
case "DELETED":
$this->info->tempmod->deleted = $this->getContents();
break;
case "SCORE":
$this->info->tempmod->score = $this->getContents();
break;
case "VISIBLE":
$this->info->tempmod->visible = $this->getContents();
break;
}
}
}
//Clear things
$this->tree[$this->level] = "";
$this->level--;
$this->content = "";
//Stop parsing if todo = SECTIONS and tagName = SECTIONS (en of the tag, of course)
//Speed up a lot (avoid parse all)
if ($tagName == "SECTIONS") {
$this->finished = true;
}
}
Restore into new course and existing course implemented. Restore sections and mod implemented. Restore users (all, course and none) implemented
2003-05-25 22:58:13 +00:00
//This is the endTag handler we use where we are reading the users zone (todo="USERS")
function endElementUsers($parser, $tagName) {
//Check if we are into USERS zone
if ($this->tree[3] == "USERS") {
//if (trim($this->content)) //Debug
// echo "C".str_repeat("&nbsp;",($this->level+2)*2).$this->getContents()."<br>\n"; //Debug
//echo $this->level.str_repeat("&nbsp;",$this->level*2)."&lt;/".$tagName."&gt;<br>\n"; //Debug
//Dependig of different combinations, do different things
if ($this->level == 4) {
switch ($tagName) {
case "USER":
Changes in: - Saving temp data to fs, instead of db (mysql limit bug OUT) - Modified clean directories (moodle standard delete dir function seems to work wrong with large dirs - Send info to browser continuosly to avoid timeouts. - Increase php execution time limit - More checks. - Restore into existing course now works fine - Create course_dir if it doesn't exist in the final step of backup.
2003-06-20 19:42:20 +00:00
//Increment counter
$this->counter++;
Begin restoring mods. Now they are readed and saved to db (backup_ids) in serialized form.
2003-05-30 21:32:04 +00:00
//Save to db
Restore into new course and existing course implemented. Restore sections and mod implemented. Restore users (all, course and none) implemented
2003-05-25 22:58:13 +00:00
backup_putid($this->preferences->backup_unique_code,"user",$this->info->tempuser->id,
Changes in: - Saving temp data to fs, instead of db (mysql limit bug OUT) - Modified clean directories (moodle standard delete dir function seems to work wrong with large dirs - Send info to browser continuosly to avoid timeouts. - Increase php execution time limit - More checks. - Restore into existing course now works fine - Create course_dir if it doesn't exist in the final step of backup.
2003-06-20 19:42:20 +00:00
null,$this->info->tempuser);
//Do some output
if ($this->counter % 10 == 0) {
echo ".";
if ($this->counter % 200 == 0) {
echo "<br>";
}
backup_flush(300);
}
Restore into new course and existing course implemented. Restore sections and mod implemented. Restore users (all, course and none) implemented
2003-05-25 22:58:13 +00:00
//Delete temp obejct
unset($this->info->tempuser);
break;
}
}
if ($this->level == 5) {
switch ($tagName) {
case "ID":
$this->info->users[$this->getContents()] = $this->getContents();
$this->info->tempuser->id = $this->getContents();
break;
case "CONFIRMED":
$this->info->tempuser->confirmed = $this->getContents();
break;
case "DELETED":
$this->info->tempuser->deleted = $this->getContents();
break;
case "USERNAME":
$this->info->tempuser->username = $this->getContents();
break;
case "PASSWORD":
$this->info->tempuser->password = $this->getContents();
break;
case "IDNUMBER":
$this->info->tempuser->idnumber = $this->getContents();
break;
case "FIRSTNAME":
$this->info->tempuser->firstname = $this->getContents();
break;
case "LASTNAME":
$this->info->tempuser->lastname = $this->getContents();
break;
case "EMAIL":
$this->info->tempuser->email = $this->getContents();
break;
case "ICQ":
$this->info->tempuser->icq = $this->getContents();
break;
case "PHONE1":
$this->info->tempuser->phone1 = $this->getContents();
break;
case "PHONE2":
$this->info->tempuser->phone2 = $this->getContents();
break;
case "INSTITUTION":
$this->info->tempuser->institution = $this->getContents();
break;
case "DEPARTMENT":
$this->info->tempuser->department = $this->getContents();
break;
case "ADDRESS":
$this->info->tempuser->address = $this->getContents();
break;
case "CITY":
$this->info->tempuser->city = $this->getContents();
break;
case "COUNTRY":
$this->info->tempuser->country = $this->getContents();
break;
case "LANG":
$this->info->tempuser->lang = $this->getContents();
break;
case "TIMEZONE":
$this->info->tempuser->timezone = $this->getContents();
break;
case "FIRSTACCESS":
$this->info->tempuser->firstaccess = $this->getContents();
break;
case "LASTACCESS":
$this->info->tempuser->lastaccess = $this->getContents();
break;
case "LASTLOGIN":
$this->info->tempuser->lastlogin = $this->getContents();
break;
case "CURRENTLOGIN":
$this->info->tempuser->currentlogin = $this->getContents();
break;
case "LASTIP":
$this->info->tempuser->lastip = $this->getContents();
break;
case "SECRET":
$this->info->tempuser->secret = $this->getContents();
break;
case "PICTURE":
$this->info->tempuser->picture = $this->getContents();
break;
case "URL":
$this->info->tempuser->url = $this->getContents();
break;
case "DESCRIPTION":
$this->info->tempuser->description = $this->getContents();
break;
case "MAILFORMAT":
$this->info->tempuser->mailformat = $this->getContents();
break;
case "MAILDISPLAY":
$this->info->tempuser->maildisplay = $this->getContents();
break;
case "HTMLEDITOR":
$this->info->tempuser->htmleditor = $this->getContents();
break;
case "AUTOSUBSCRIBE":
$this->info->tempuser->autosubscribe = $this->getContents();
break;
case "TIMEMODIFIED":
$this->info->tempuser->timemodified = $this->getContents();
break;
}
}
if ($this->level == 6) {
switch ($tagName) {
case "ROLE":
//We've finalized a role, get it
$this->info->tempuser->roles[$this->info->temprole->type]->authority =
$this->info->temprole->authority;
$this->info->tempuser->roles[$this->info->temprole->type]->tea_role =
$this->info->temprole->tea_role;
$this->info->tempuser->roles[$this->info->temprole->type]->timestart =
$this->info->temprole->timestart;
$this->info->tempuser->roles[$this->info->temprole->type]->timeend =
$this->info->temprole->timeend;
$this->info->tempuser->roles[$this->info->temprole->type]->time =
$this->info->temprole->time;
unset($this->info->temprole);
break;
}
}
if ($this->level == 7) {
switch ($tagName) {
case "TYPE":
$this->info->temprole->type = $this->getContents();
break;
case "AUTHORITY":
$this->info->temprole->authority = $this->getContents();
break;
case "TEA_ROLE":
$this->info->temprole->tea_role = $this->getContents();
break;
case "TIMESTART":
$this->info->temprole->timestart = $this->getContents();
break;
case "TIMEEND":
$this->info->temprole->timeend = $this->getContents();
break;
case "TIME":
$this->info->temprole->time = $this->getContents();
break;
}
}
}
//Stop parsing if todo = USERS and tagName = USERS (en of the tag, of course)
//Speed up a lot (avoid parse all)
if ($tagName == "USERS" and $this->level == 3) {
$this->finished = true;
Changes in: - Saving temp data to fs, instead of db (mysql limit bug OUT) - Modified clean directories (moodle standard delete dir function seems to work wrong with large dirs - Send info to browser continuosly to avoid timeouts. - Increase php execution time limit - More checks. - Restore into existing course now works fine - Create course_dir if it doesn't exist in the final step of backup.
2003-06-20 19:42:20 +00:00
$this->counter = 0;
Restore into new course and existing course implemented. Restore sections and mod implemented. Restore users (all, course and none) implemented
2003-05-25 22:58:13 +00:00
}
//Clear things
$this->tree[$this->level] = "";
$this->level--;
$this->content = "";
}
Finished restoring course, course_sections and course_modules. When ending the restore process, we've to update the instance field of course_modules and the modinfo field of course. Now we haven´t the necessary info to do that.
2003-05-24 00:27:45 +00:00
Begin restoring mods. Now they are readed and saved to db (backup_ids) in serialized form.
2003-05-30 21:32:04 +00:00
//This is the endTag handler we use where we are reading the modules zone (todo="MODULES")
function endElementModules($parser, $tagName) {
//Check if we are into MODULES zone
if ($this->tree[3] == "MODULES") {
//if (trim($this->content)) //Debug
// echo "C".str_repeat("&nbsp;",($this->level+2)*2).$this->getContents()."<br>\n"; //Debug
//echo $this->level.str_repeat("&nbsp;",$this->level*2)."&lt;/".$tagName."&gt;<br>\n"; //Debug
//Acumulate data to info (content + close tag)
Now readjusting course_modules instance and course modinfo os implemented and working
2003-05-31 15:21:39 +00:00
//Reconvert: strip htmlchars again and trim to generate xml data
$this->temp .= htmlspecialchars(trim($this->content))."</".$tagName.">";
Begin restoring mods. Now they are readed and saved to db (backup_ids) in serialized form.
2003-05-30 21:32:04 +00:00
//If we've finished a mod, xmlize it an save to db
if (($this->level == 4) and ($tagName == "MOD")) {
//Prepend XML standard header to info gathered
Return info to know what modules process...
2003-05-30 22:55:40 +00:00
$xml_data = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n".$this->temp;
Begin restoring mods. Now they are readed and saved to db (backup_ids) in serialized form.
2003-05-30 21:32:04 +00:00
//Call to xmlize for this portion of xml data (one MOD)
Changes in: - Saving temp data to fs, instead of db (mysql limit bug OUT) - Modified clean directories (moodle standard delete dir function seems to work wrong with large dirs - Send info to browser continuosly to avoid timeouts. - Increase php execution time limit - More checks. - Restore into existing course now works fine - Create course_dir if it doesn't exist in the final step of backup.
2003-06-20 19:42:20 +00:00
echo "-XMLIZE: ".strftime ("%X",time()),"-";
Begin restoring mods. Now they are readed and saved to db (backup_ids) in serialized form.
2003-05-30 21:32:04 +00:00
$data = xmlize($xml_data);
Changes in: - Saving temp data to fs, instead of db (mysql limit bug OUT) - Modified clean directories (moodle standard delete dir function seems to work wrong with large dirs - Send info to browser continuosly to avoid timeouts. - Increase php execution time limit - More checks. - Restore into existing course now works fine - Create course_dir if it doesn't exist in the final step of backup.
2003-06-20 19:42:20 +00:00
echo strftime ("%X",time())."<p>";
Begin restoring mods. Now they are readed and saved to db (backup_ids) in serialized form.
2003-05-30 21:32:04 +00:00
//traverse_xmlize($data); //Debug
//print_object ($GLOBALS['traverse_array']); //Debug
//$GLOBALS['traverse_array']=""; //Debug
//Now, save data to db. We'll use it later
//Get id and modtype from data
$mod_id = $data["MOD"]["#"]["ID"]["0"]["#"];
$mod_type = $data["MOD"]["#"]["MODTYPE"]["0"]["#"];
Only save to backup_ids restoreable modules.
2003-05-30 21:56:08 +00:00
//Only if we've selected to restore it
if ($this->preferences->mods[$mod_type]->restore) {
//Save to db
Some improvements and tons of flushes !!
2003-06-12 17:38:36 +00:00
$status = backup_putid($this->preferences->backup_unique_code,$mod_type,$mod_id,
Changes in: - Saving temp data to fs, instead of db (mysql limit bug OUT) - Modified clean directories (moodle standard delete dir function seems to work wrong with large dirs - Send info to browser continuosly to avoid timeouts. - Increase php execution time limit - More checks. - Restore into existing course now works fine - Create course_dir if it doesn't exist in the final step of backup.
2003-06-20 19:42:20 +00:00
null,$data);
Some improvements and tons of flushes !!
2003-06-12 17:38:36 +00:00
//echo "<p>id: ".$mod_id."-".$mod_type." len.: ".strlen($sla_mod_temp)." to_db: ".$status."<p>"; //Debug
Return info to know what modules process...
2003-05-30 22:55:40 +00:00
//Create returning info
Now readjusting course_modules instance and course modinfo os implemented and working
2003-05-31 15:21:39 +00:00
$ret_info->id = $mod_id;
$ret_info->modtype = $mod_type;
$this->info[] = $ret_info;
Only save to backup_ids restoreable modules.
2003-05-30 21:56:08 +00:00
}
Changes in: - Saving temp data to fs, instead of db (mysql limit bug OUT) - Modified clean directories (moodle standard delete dir function seems to work wrong with large dirs - Send info to browser continuosly to avoid timeouts. - Increase php execution time limit - More checks. - Restore into existing course now works fine - Create course_dir if it doesn't exist in the final step of backup.
2003-06-20 19:42:20 +00:00
//Reset temp
unset($this->temp);
Begin restoring mods. Now they are readed and saved to db (backup_ids) in serialized form.
2003-05-30 21:32:04 +00:00
}
}
//Stop parsing if todo = MODULES and tagName = MODULES (en of the tag, of course)
//Speed up a lot (avoid parse all)
if ($tagName == "MODULES" and $this->level == 3) {
$this->finished = true;
}
//Clear things
$this->tree[$this->level] = "";
$this->level--;
$this->content = "";
}
Reading more info...
2003-05-17 11:40:27 +00:00
//This is the endTag default handler we use when todo is undefined
Begin parsing xml data. Info tags.
2003-05-16 23:57:35 +00:00
function endElement($parser, $tagName) {
Debug a bit
2003-05-17 08:56:53 +00:00
if (trim($this->content)) //Debug
Now course header is retrieved too !!
2003-05-17 17:34:30 +00:00
echo "C".str_repeat("&nbsp;",($this->level+2)*2).$this->getContents()."<br>\n"; //Debug
Debug a bit
2003-05-17 08:56:53 +00:00
echo $this->level.str_repeat("&nbsp;",$this->level*2)."&lt;/".$tagName."&gt;<br>\n"; //Debug
Reading more info...
2003-05-17 11:40:27 +00:00
//Clear things
Begin parsing xml data. Info tags.
2003-05-16 23:57:35 +00:00
$this->tree[$this->level] = "";
Reading more info...
2003-05-17 11:40:27 +00:00
$this->level--;
Begin parsing xml data. Info tags.
2003-05-16 23:57:35 +00:00
$this->content = "";
}
Reading more info...
2003-05-17 11:40:27 +00:00
//This is the handler to read data contents (simple accumule it)
Begin parsing xml data. Info tags.
2003-05-16 23:57:35 +00:00
function characterData($parser, $data) {
$this->content .= $data;
}
}
//This function executes the MoodleParser
function restore_read_xml ($xml_file,$todo,$preferences) {
Reading more info...
2003-05-17 11:40:27 +00:00
Begin parsing xml data. Info tags.
2003-05-16 23:57:35 +00:00
$status = true;
$xml_parser = xml_parser_create();
$moodle_parser = new MoodleParser();
$moodle_parser->todo = $todo;
$moodle_parser->preferences = $preferences;
xml_set_object($xml_parser,&$moodle_parser);
Reading more info...
2003-05-17 11:40:27 +00:00
//Depending of the todo we use some element_handler or another
if ($todo == "INFO") {
//Define handlers to that zone
xml_set_element_handler($xml_parser, "startElementInfo", "endElementInfo");
Now course header is retrieved too !!
2003-05-17 17:34:30 +00:00
} else if ($todo == "COURSE_HEADER") {
//Define handlers to that zone
xml_set_element_handler($xml_parser, "startElementCourseHeader", "endElementCourseHeader");
Finished restoring course, course_sections and course_modules. When ending the restore process, we've to update the instance field of course_modules and the modinfo field of course. Now we haven´t the necessary info to do that.
2003-05-24 00:27:45 +00:00
} else if ($todo == "SECTIONS") {
//Define handlers to that zone
xml_set_element_handler($xml_parser, "startElementSections", "endElementSections");
Restore into new course and existing course implemented. Restore sections and mod implemented. Restore users (all, course and none) implemented
2003-05-25 22:58:13 +00:00
} else if ($todo == "USERS") {
//Define handlers to that zone
xml_set_element_handler($xml_parser, "startElementUsers", "endElementUsers");
Begin restoring mods. Now they are readed and saved to db (backup_ids) in serialized form.
2003-05-30 21:32:04 +00:00
} else if ($todo == "MODULES") {
//Define handlers to that zone
xml_set_element_handler($xml_parser, "startElementModules", "endElementModules");
Reading more info...
2003-05-17 11:40:27 +00:00
} else {
//Define default handlers (must no be invoked when everything become finished)
xml_set_element_handler($xml_parser, "startElementInfo", "endElementInfo");
}
Begin parsing xml data. Info tags.
2003-05-16 23:57:35 +00:00
xml_set_character_data_handler($xml_parser, "characterData");
$fp = fopen($xml_file,"r")
or $status = false;
if ($status) {
while ($data = fread($fp, 4096) and !$moodle_parser->finished)
xml_parse($xml_parser, $data, feof($fp))
or die(sprintf("XML error: %s at line %d",
xml_error_string(xml_get_error_code($xml_parser)),
xml_get_current_line_number($xml_parser)));
fclose($fp);
}
Debug a bit
2003-05-17 08:56:53 +00:00
//Get info from parser
$info = $moodle_parser->info;
//Clear parser mem
Begin parsing xml data. Info tags.
2003-05-16 23:57:35 +00:00
xml_parser_free($xml_parser);
Changes in: - Saving temp data to fs, instead of db (mysql limit bug OUT) - Modified clean directories (moodle standard delete dir function seems to work wrong with large dirs - Send info to browser continuosly to avoid timeouts. - Increase php execution time limit - More checks. - Restore into existing course now works fine - Create course_dir if it doesn't exist in the final step of backup.
2003-06-20 19:42:20 +00:00
if ($status && $info) {
Begin parsing xml data. Info tags.
2003-05-16 23:57:35 +00:00
return $info;
} else {
return $status;
}
}
Now backuplib.php includes all the functions needed in backup, restorelib.php all the functions needed in restore and lib.php the rest of common functions.
2003-05-14 22:09:30 +00:00
?>
Reference in New Issue Copy Permalink