MDL-20596 - fixes to backup_course_silently and import_backup_file_silently

Merged from MOODLE_19_STABLE - even though backup/restore is broken in HEAD, for a reference for Eloy's backup 2.0

diff --git a/backup/lib.php b/backup/lib.php
index e50253941f89363d76344ca99ad07ae816c48947..dfc2b07a617dc704600d4170c2adc6be5daa3bd1 100644 (file)
--- a/backup/lib.php
+++ b/backup/lib.php
@@ -502,7 +502,6 @@
      */
     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..
-        global $restore; // ick
 
         if (!defined('RESTORE_SILENTLY')) {
             define('RESTORE_SILENTLY',true); // don't output all the stuff to us.
@@ -512,7 +511,8 @@
         $cleanupafter = false;
         $errorstr = ''; // passed by reference to restore_precheck to get errors from.
 
-        if (!$course = $DB->get_record('course', array('id'=>$destinationcourse))) {
+        $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;
         }
@@ -567,29 +567,65 @@
             return false;
         }
 
-        $SESSION->restore = new StdClass;
+        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 = get_field('role', 'id', 'shortname', $info->shortname)) {
+                    $restore->rolesmapping[$id] = $newroleid;
+                }
+            }
+        }
 
         // add on some extra stuff we need...
-        $SESSION->restore->metacourse   = $restore->metacourse = (isset($preferences['restore_metacourse']) ? $preferences['restore_metacourse'] : 0);
-        $SESSION->restore->restoreto    = $restore->restoreto = RESTORETO_CURRENT_ADDING;
-        $SESSION->restore->users        = $restore->users = $userdata;
-        $SESSION->restore->groups       = $restore->groups = (isset($preferences['restore_groups']) ? $preferences['restore_groups'] : RESTORE_GROUPS_NONE);
-        $SESSION->restore->logs         = $restore->logs = (isset($preferences['restore_logs']) ? $preferences['restore_logs'] : 0);
-        $SESSION->restore->user_files   = $restore->user_files = $userdata;
-        $SESSION->restore->messages     = $restore->messages = (isset($preferences['restore_messages']) ? $preferences['restore_messages'] : 0);
-        $SESSION->restore->blogs        = $restore->blogs = (isset($preferences['restore_blogs']) ? $preferences['restore_blogs'] : 0);
-        $SESSION->restore->course_id    = $restore->course_id = $destinationcourse;
-        $SESSION->restore->deleting     = $emptyfirst;
-        $SESSION->restore->restore_course_files = $restore->course_files = (isset($preferences['restore_course_files']) ? $preferences['restore_course_files'] : 0);
-        $SESSION->restore->restore_site_files = $restore->site_files = (isset($preferences['restore_site_files']) ? $preferences['restore_site_files'] : 0);
-        $SESSION->restore->backup_version = $SESSION->info->backup_backup_version;
-        $SESSION->restore->course_startdateoffset = $course->startdate - $SESSION->course_header->course_startdate;
-
-        restore_setup_for_check($SESSION->restore,$backup_unique_code);
-
-        // maybe we need users (defaults to 2 in restore_setup_for_check)
+        $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)) {
-            $SESSION->restore->users = 1;
+            $restore->users = 1;
         }
 
         // we also need modules...
@@ -597,22 +633,28 @@
             foreach ($allmods as $mod) {
                 $modname = $mod->name;
                 //Now check that we have that module info in the backup file
-                if (isset($SESSION->info->mods[$modname]) && $SESSION->info->mods[$modname]->backup == "true") {
-                    $SESSION->restore->mods[$modname]->restore = true;
-                    $SESSION->restore->mods[$modname]->userinfo = $userdata;
+                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
-                    $SESSION->restore->mods[$modname]->restore = false;
-                    $SESSION->restore->mods[$modname]->userinfo = false;
+                    $restore->mods[$modname]->restore = false;
+                    $restore->mods[$modname]->userinfo = false;
                 }
             }
         }
-        $restore = clone($SESSION->restore);
-        if (!restore_execute($SESSION->restore,$SESSION->info,$SESSION->course_header,$errorstr)) {
+        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;
     }
 
@@ -632,6 +674,7 @@
             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;
         }
@@ -653,6 +696,7 @@
             backup_course_files
             backup_site_files
             backup_messages
+            userdata
     * and if not provided, they will not be included.
     */
 
@@ -662,6 +706,7 @@
         $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") ) {
@@ -678,7 +723,6 @@
                 if (!function_exists($modbackup) || !function_exists($modcheckbackup)) {
                     continue;
                 }
-                $modcheckbackup($course->id, $preferences->backup_users, $preferences->backup_unique_code);
                 $var = "exists_".$modname;
                 $preferences->$var = true;
                 $count++;
@@ -696,8 +740,8 @@
                     $preferences->$var = true;
                     $preferences->mods[$modname]->instances[$instance->id]->backup = true;
                     $var = 'backup_user_info_'.$modname.'_instance_'.$instance->id;
-                    $preferences->$var = true;
-                    $preferences->mods[$modname]->instances[$instance->id]->userinfo = true;
+                    $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.
                 }
@@ -712,9 +756,31 @@
 
                 //Check include user info
                 $var = "backup_user_info_".$modname;
-                $preferences->$var = true;
-                $preferences->mods[$modname]->userinfo = true;
+                $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);
             }
         }
 

diff --git a/backup/restorelib.php b/backup/restorelib.php
index 111b9ebd20256caa41c13c2c55bbe7de47ab1fa8..b35a949ab305f82c13a2b49ae911dacfb291f690 100644 (file)
--- a/backup/restorelib.php
+++ b/backup/restorelib.php
@@ -817,6 +817,8 @@ define('RESTORE_GROUPS_GROUPINGS', 3);
                 backup_putid ($restore->backup_unique_code,"course",$course_header->course_id,$newid);
                 //Replace old course_id in course_header
                 $course_header->course_id = $newid;
+                $SESSION->restore->course_id = $newid;
+                return $newid;
             } else {
                 $status = false;
             }
@@ -3688,7 +3690,7 @@ define('RESTORE_GROUPS_GROUPINGS', 3);
     function restore_create_events($restore,$xml_file) {
         global $DB;
 
-        global $CFG;
+        global $CFG, $SESSION;
 
         $status = true;
         //Check it exists
@@ -8670,7 +8672,7 @@ define('RESTORE_GROUPS_GROUPINGS', 3);
         }
 
         //Now create log entries as needed
-        if ($status and ($restore->logs)) {
+        if ($status and ($info->backup_logs == 'true' && $restore->logs)) {
             if (!defined('RESTORE_SILENTLY')) {
                 echo "<li>".get_string("creatinglogentries");
             }