Restore 2.0 for developers - Revision history

Mudrd8mz: Text replacement - "" to ""

2021-07-14T20:19:11Z

Text replacement - "</code>" to "</syntaxhighlight>"

← Older revision		Revision as of 20:19, 14 July 2021
Line 81:		Line 81:
	}		}
	}		}
	</~~code~~>		</syntaxhighlight>

	=== restore_choice_activity_task.class.php ===		=== restore_choice_activity_task.class.php ===
Line 176:		Line 176:

	}		}
	</~~code~~>		</syntaxhighlight>

	'''define_restore_log_rules''': it covers all the "mandatory" log actions, performing {course_module} and {choice} mappings properly. Note that names between curly brackets instruct the log processor to look in the mapping tables for item = name between brackets. Of course, other modules like forum, has a lot of rules, with more complex mappings and so on. Choice is pretty basic.		'''define_restore_log_rules''': it covers all the "mandatory" log actions, performing {course_module} and {choice} mappings properly. Note that names between curly brackets instruct the log processor to look in the mapping tables for item = name between brackets. Of course, other modules like forum, has a lot of rules, with more complex mappings and so on. Choice is pretty basic.
Line 216:		Line 216:
	// Commit.		// Commit.
	$transaction->allow_commit();		$transaction->allow_commit();
	</~~code~~>		</syntaxhighlight>

	Note:		Note:
Line 257:		Line 257:
	$controller->destroy();		$controller->destroy();
	}		}
	</~~code~~>		</syntaxhighlight>

	== Code that runs after restore ==		== Code that runs after restore ==

Mudrd8mz: Text replacement - "`" to ""`


2021-07-14T13:34:25Z
Text replacement - "<code php>" to "<syntaxhighlight lang="php">"

				
				
				
				
				
				← Older revision
				Revision as of 13:34, 14 July 2021
				
Line 13:
Line 13:
=== restore_choice_stepslib.php === === restore_choice_stepslib.php ===



<code php> <syntaxhighlight lang="php">
/** /**
  * Structure step to restore one choice activity   * Structure step to restore one choice activity
Line 84:
Line 84:



=== restore_choice_activity_task.class.php === === restore_choice_activity_task.class.php ===
<code php> <syntaxhighlight lang="php">
/** /**
  * choice restore task that provides all the settings and steps to perform one   * choice restore task that provides all the settings and steps to perform one
Line 190:
Line 190:
# Run the following code: # Run the following code:



<code php> <syntaxhighlight lang="php">
<?php <?php



Line 231:
Line 231:






<code php> <syntaxhighlight lang="php">
     /**      /**
      * Test restore of deadlock causing backup.       * Test restore of deadlock causing backup.



Dasistwas: /* Automatically triggering restore in code */
2020-05-02T21:19:26Z
Automatically triggering restore in code

				
				
				
				
				
				← Older revision
				Revision as of 21:19, 2 May 2020
				
Line 222:
Line 222:
* The transaction is used so that if backup fails, the course isn't created. * The transaction is used so that if backup fails, the course isn't created.
* The MODE_SAMESITE option is used if restoring a backup which comes from the same site, otherwise MODE_GENERAL might be used. * The MODE_SAMESITE option is used if restoring a backup which comes from the same site, otherwise MODE_GENERAL might be used.


There is a another good example in backup/controller/tests/controller_test.php. If done like that, it actually works. Important: Extract the content to the tmp directory. 

Instead of $foldername = 'deadlock". This has to be used:

$foldername = restore_controller::get_tempdir_name($courseid, $USER->id);


<code php>
    /**
     * Test restore of deadlock causing backup.
     */
    public function test_restore_of_deadlock_causing_backup() {
        global $USER, $CFG;
        $this->preventResetByRollback();

        $foldername = 'deadlock';
        $fp = get_file_packer('application/vnd.moodle.backup');
        $tempdir = make_backup_temp_directory($foldername);
        $files = $fp->extract_to_pathname($CFG->dirroot . '/backup/controller/tests/fixtures/deadlock.mbz', $tempdir);

        $this->setAdminUser();
        $controller = new restore_controller(
            'deadlock',
            $this->courseid,
            backup::INTERACTIVE_NO,
            backup::MODE_GENERAL,
            $USER->id,
            backup::TARGET_NEW_COURSE
        );
        $this->assertTrue($controller->execute_precheck());
        $controller->execute_plan();
        $controller->destroy();
    }
</code>



== Code that runs after restore == == Code that runs after restore ==



Ankitfrenz: /* restore_choice_stepslib.php */
2017-10-16T05:52:11Z
restore_choice_stepslib.php

				
				
				
				
				
				← Older revision
				Revision as of 05:52, 16 October 2017
				
Line 43:
Line 43:
         $data->timeopen = $this->apply_date_offset($data->timeopen);          $data->timeopen = $this->apply_date_offset($data->timeopen);
         $data->timeclose = $this->apply_date_offset($data->timeclose);          $data->timeclose = $this->apply_date_offset($data->timeclose);
        $data->timemodified = $this->apply_date_offset($data->timemodified); 



         // insert the choice record          // insert the choice record
Line 58:
Line 57:



         $data->choiceid = $this->get_new_parentid('choice');          $data->choiceid = $this->get_new_parentid('choice');
        $data->timemodified = $this->apply_date_offset($data->timemodified); 



         $newitemid = $DB->insert_record('choice_options', $data);          $newitemid = $DB->insert_record('choice_options', $data);
Line 72:
Line 70:
         $data->optionid = $this->get_mappingid('choice_option', $data->optionid);          $data->optionid = $this->get_mappingid('choice_option', $data->optionid);
         $data->userid = $this->get_mappingid('user', $data->userid);          $data->userid = $this->get_mappingid('user', $data->userid);
        $data->timemodified = $this->apply_date_offset($data->timemodified); 



         $newitemid = $DB->insert_record('choice_answers', $data);          $newitemid = $DB->insert_record('choice_answers', $data);



TimHunt: /* Code that runs after restore */
2015-03-25T20:38:38Z
Code that runs after restore

				
				
				
				
				
				← Older revision
				Revision as of 20:38, 25 March 2015
				
Line 228:
Line 228:
== Code that runs after restore == == Code that runs after restore ==



If you are writing a restore task for an activity module, your code is all executed while the system is restoring that module. For example, the <tt>after_execute</tt>  method in your <tt>restore_mymodule_activity_structure_step</tt> class is called immediately after all the other restore functions in that step are finished. If you are writing a restore task for an activity module, your code is all executed while the system is restoring that module. The <tt>after_execute</tt> method in your <tt>restore_mymodule_activity_structure_step</tt> class is called immediately after all the other restore functions in that step are finished for that instance of the module.



=== The problem === === The problem ===



Mudrd8mz: /* Automatically triggering restore in code */ Fix the variable name
2014-05-15T11:52:28Z
Automatically triggering restore in code:  Fix the variable name

				
				
				
				
				
				← Older revision
				Revision as of 11:52, 15 May 2014
				
Line 207:
Line 207:
$folder             = XX; // as found in: $CFG->dataroot . '/temp/backup/'   $folder             = XX; // as found in: $CFG->dataroot . '/temp/backup/'  
$categoryid         = YY; // e.g. 1 == Miscellaneous $categoryid         = YY; // e.g. 1 == Miscellaneous
$usedoingtherestore = ZZ; // e.g. 2 == admin $userdoingrestore   = ZZ; // e.g. 2 == admin
$courseid           = restore_dbops::create_new_course('', '', $categoryid); $courseid           = restore_dbops::create_new_course('', '', $categoryid);



// Restore backup into course. // Restore backup into course.
$controller = new restore_controller($folder, $courseid,   $controller = new restore_controller($folder, $courseid,  
         backup::INTERACTIVE_NO, backup::MODE_SAMESITE, $userdoingtherestore,          backup::INTERACTIVE_NO, backup::MODE_SAMESITE, $userdoingrestore,
         backup::TARGET_NEW_COURSE);          backup::TARGET_NEW_COURSE);
$controller->execute_precheck(); $controller->execute_precheck();



TimHunt: /* Automatically triggering restore in code */
2014-02-21T11:35:38Z
Automatically triggering restore in code

				
				
				
				
				
				← Older revision
				Revision as of 11:35, 21 February 2014
				
Line 196:
Line 196:
<?php <?php



define( 'CLI_SCRIPT', true ); define('CLI_SCRIPT', true);



require_once( 'config.php' ); require_once('config.php');
require_once( $CFG->dirroot . '/backup/util/includes/restore_includes.php' ); require_once($CFG->dirroot . '/backup/util/includes/restore_includes.php');



// Transaction // Transaction.
$transaction = $DB->start_delegated_transaction( ); $transaction = $DB->start_delegated_transaction();
 
// Create new course 
$folder                 = XX; // as found in: $CFG->dataroot . '/temp/backup/' 
$categoryid             = YY; // e.g. 1 == Miscellaneous 
$user_doing_the_restore = ZZ; // e.g. 2 == admin 
$courseid               = restore_dbops::create_new_course( '', '', $categoryid ); 



// Restore backup into course // Create new course.
$controller = new restore_controller( $folder, $courseid,   $folder             = XX; // as found in: $CFG->dataroot . '/temp/backup/' 
         backup::INTERACTIVE_NO, backup::MODE_SAMESITE, $user_doing_the_restore, $categoryid         = YY; // e.g. 1 == Miscellaneous
         backup::TARGET_NEW_COURSE ); $usedoingtherestore = ZZ; // e.g. 2 == admin
$controller->execute_precheck( ); $courseid           = restore_dbops::create_new_course('', '', $categoryid);
$controller->execute_plan( );  
 // Restore backup into course.
// Commit $controller = new restore_controller($folder, $courseid,  
$transaction->allow_commit( );          backup::INTERACTIVE_NO, backup::MODE_SAMESITE, $userdoingtherestore,
         backup::TARGET_NEW_COURSE);
$controller->execute_precheck();
$controller->execute_plan();
 
// Commit.
$transaction->allow_commit();
</code> </code>






Alfredo delgado: /* Automatically triggering restore in code */
2013-07-19T20:46:23Z
Automatically triggering restore in code

				
				
				
				
				
				← Older revision
				Revision as of 20:46, 19 July 2013
				
Line 194:
Line 194:



<code php> <code php>
        // Transaction <?php
        $transaction = $DB->start_delegated_transaction();  
define( 'CLI_SCRIPT', true );
 
require_once( 'config.php' );
require_once( $CFG->dirroot . '/backup/util/includes/restore_includes.php' );
 
// Transaction
$transaction = $DB->start_delegated_transaction( );
       
        // Create new course // Create new course
        $courseid = restore_dbops::create_new_course($fullname, $shortname, $categoryid); $folder                 = XX; // as found in: $CFG->dataroot . '/temp/backup/' 
$categoryid             = YY; // e.g. 1 == Miscellaneous
$user_doing_the_restore = ZZ; // e.g. 2 == admin
$courseid               = restore_dbops::create_new_course( '', '', $categoryid );
 
// Restore backup into course
$controller = new restore_controller( $folder, $courseid, 
        backup::INTERACTIVE_NO, backup::MODE_SAMESITE, $user_doing_the_restore,
        backup::TARGET_NEW_COURSE );
$controller->execute_precheck( );
$controller->execute_plan( );
       
        // Restore backup into course // Commit
        $controller = new restore_controller($folder, $courseid, $transaction->allow_commit( );
                backup::INTERACTIVE_NO, backup::MODE_SAMESITE, $USER->id, 
                backup::TARGET_NEW_COURSE); 
        $controller->execute_precheck(); 
        $controller->execute_plan(); 
 
        // Commit 
        $transaction->allow_commit(); 
</code> </code>






Stronk7: Apply fix from MDL-34994. Grrr!
2012-08-27T16:26:53Z
Apply fix from MDL-34994. Grrr!

				
				
				
				
				
				← Older revision
				Revision as of 16:26, 27 August 2012
				
Line 68:
Line 68:



         $data = (object)$data;          $data = (object)$data;
        $oldid = $data->id; 



         $data->choiceid = $this->get_new_parentid('choice');          $data->choiceid = $this->get_new_parentid('choice');
         $data->optionid = $this->get_mappingid('choice_option', $oldid);          $data->optionid = $this->get_mappingid('choice_option', $data->optionid);
         $data->userid = $this->get_mappingid('user', $data->userid);          $data->userid = $this->get_mappingid('user', $data->userid);
         $data->timemodified = $this->apply_date_offset($data->timemodified);          $data->timemodified = $this->apply_date_offset($data->timemodified);





GregLyon at 18:28, 29 May 2012
2012-05-29T18:28:58Z


				
				
				
				
				
				← Older revision
				Revision as of 18:28, 29 May 2012
				
Line 94:
Line 94:
  */   */



require_once($CFG->dirroot . '/mod/choice/backup/moodle2/restore_kb_stepslib.php'); // Because it exists (must) require_once($CFG->dirroot . '/mod/choice/backup/moodle2/restore_choice_stepslib.php'); // Because it exists (must)



class restore_choice_activity_task extends restore_activity_task { class restore_choice_activity_task extends restore_activity_task {

← Older revision		Revision as of 13:34, 14 July 2021
Line 13:		Line 13:
	=== restore_choice_stepslib.php ===		=== restore_choice_stepslib.php ===

	<~~code~~ php>		<syntaxhighlight lang="php">
	/**		/**
	* Structure step to restore one choice activity		* Structure step to restore one choice activity
Line 84:		Line 84:

	=== restore_choice_activity_task.class.php ===		=== restore_choice_activity_task.class.php ===
	<~~code~~ php>		<syntaxhighlight lang="php">
	/**		/**
	* choice restore task that provides all the settings and steps to perform one		* choice restore task that provides all the settings and steps to perform one
Line 190:		Line 190:
	# Run the following code:		# Run the following code:

	<~~code~~ php>		<syntaxhighlight lang="php">
	<?php		<?php

Line 231:		Line 231:


	<~~code~~ php>		<syntaxhighlight lang="php">
	/**		/**
	* Test restore of deadlock causing backup.		* Test restore of deadlock causing backup.

← Older revision		Revision as of 05:52, 16 October 2017
Line 43:		Line 43:
	$data->timeopen = $this->apply_date_offset($data->timeopen);		$data->timeopen = $this->apply_date_offset($data->timeopen);
	$data->timeclose = $this->apply_date_offset($data->timeclose);		$data->timeclose = $this->apply_date_offset($data->timeclose);
	~~$data->timemodified = $this->apply_date_offset($data->timemodified);~~

	// insert the choice record		// insert the choice record
Line 58:		Line 57:

	$data->choiceid = $this->get_new_parentid('choice');		$data->choiceid = $this->get_new_parentid('choice');
	~~$data->timemodified = $this->apply_date_offset($data->timemodified);~~

	$newitemid = $DB->insert_record('choice_options', $data);		$newitemid = $DB->insert_record('choice_options', $data);
Line 72:		Line 70:
	$data->optionid = $this->get_mappingid('choice_option', $data->optionid);		$data->optionid = $this->get_mappingid('choice_option', $data->optionid);
	$data->userid = $this->get_mappingid('user', $data->userid);		$data->userid = $this->get_mappingid('user', $data->userid);
	~~$data->timemodified = $this->apply_date_offset($data->timemodified);~~

	$newitemid = $DB->insert_record('choice_answers', $data);		$newitemid = $DB->insert_record('choice_answers', $data);

← Older revision		Revision as of 20:38, 25 March 2015
Line 228:		Line 228:
	== Code that runs after restore ==		== Code that runs after restore ==

	If you are writing a restore task for an activity module, your code is all executed while the system is restoring that module. ~~For example, the~~ <tt>after_execute</tt> method in your <tt>restore_mymodule_activity_structure_step</tt> class is called immediately after all the other restore functions in that step are finished.		If you are writing a restore task for an activity module, your code is all executed while the system is restoring that module. The <tt>after_execute</tt> method in your <tt>restore_mymodule_activity_structure_step</tt> class is called immediately after all the other restore functions in that step are finished for that instance of the module.

	=== The problem ===		=== The problem ===

← Older revision		Revision as of 11:52, 15 May 2014
Line 207:		Line 207:
	$folder = XX; // as found in: $CFG->dataroot . '/temp/backup/'		$folder = XX; // as found in: $CFG->dataroot . '/temp/backup/'
	$categoryid = YY; // e.g. 1 == Miscellaneous		$categoryid = YY; // e.g. 1 == Miscellaneous
	$~~usedoingtherestore~~ = ZZ; // e.g. 2 == admin		$userdoingrestore = ZZ; // e.g. 2 == admin
	$courseid = restore_dbops::create_new_course('', '', $categoryid);		$courseid = restore_dbops::create_new_course('', '', $categoryid);

	// Restore backup into course.		// Restore backup into course.
	$controller = new restore_controller($folder, $courseid,		$controller = new restore_controller($folder, $courseid,
	backup::INTERACTIVE_NO, backup::MODE_SAMESITE, $~~userdoingtherestore~~,		backup::INTERACTIVE_NO, backup::MODE_SAMESITE, $userdoingrestore,
	backup::TARGET_NEW_COURSE);		backup::TARGET_NEW_COURSE);
	$controller->execute_precheck();		$controller->execute_precheck();

← Older revision		Revision as of 11:35, 21 February 2014
Line 196:		Line 196:
	<?php		<?php

	define( 'CLI_SCRIPT', true );		define('CLI_SCRIPT', true);

	require_once( 'config.php' );		require_once('config.php');
	require_once( $CFG->dirroot . '/backup/util/includes/restore_includes.php' );		require_once($CFG->dirroot . '/backup/util/includes/restore_includes.php');

	// Transaction		// Transaction.
	$transaction = $DB->start_delegated_transaction( );		$transaction = $DB->start_delegated_transaction();

	~~// Create new course~~
	~~$folder = XX; // as found in: $CFG->dataroot . '/temp/backup/'~~
	~~$categoryid = YY; // e.g. 1 == Miscellaneous~~
	~~$user_doing_the_restore = ZZ; // e.g. 2 == admin~~
	~~$courseid = restore_dbops::create_new_course( '', '', $categoryid~~ );

	// Restore backup into course		// Create new course.
	$controller = new restore_controller( $folder, $courseid,		$folder = XX; // as found in: $CFG->dataroot . '/temp/backup/'
	backup::INTERACTIVE_NO, backup::MODE_SAMESITE, $~~user_doing_the_restore~~,		$categoryid = YY; // e.g. 1 == Miscellaneous
	backup::TARGET_NEW_COURSE );		$usedoingtherestore = ZZ; // e.g. 2 == admin
	$controller->execute_precheck( );		$courseid = restore_dbops::create_new_course('', '', $categoryid);
	$controller->execute_plan( );
			// Restore backup into course.
	// Commit		$controller = new restore_controller($folder, $courseid,
	$transaction->allow_commit( );		backup::INTERACTIVE_NO, backup::MODE_SAMESITE, $userdoingtherestore,
			backup::TARGET_NEW_COURSE);
			$controller->execute_precheck();
			$controller->execute_plan();

			// Commit.
			$transaction->allow_commit();
	</code>		</code>

← Older revision		Revision as of 20:46, 19 July 2013
Line 194:		Line 194:

	<code php>		<code php>
	// Transaction		<?php
	$transaction = $DB->start_delegated_transaction();
			define( 'CLI_SCRIPT', true );

			require_once( 'config.php' );
			require_once( $CFG->dirroot . '/backup/util/includes/restore_includes.php' );

			// Transaction
			$transaction = $DB->start_delegated_transaction( );

	// Create new course		// Create new course
	$courseid = restore_dbops::create_new_course($~~fullname~~, $~~shortname~~, $~~categoryid~~);		$folder = XX; // as found in: $CFG->dataroot . '/temp/backup/'
			$categoryid = YY; // e.g. 1 == Miscellaneous
			$user_doing_the_restore = ZZ; // e.g. 2 == admin
			$courseid = restore_dbops::create_new_course( '', '', $categoryid );

			// Restore backup into course
			$controller = new restore_controller( $folder, $courseid,
			backup::INTERACTIVE_NO, backup::MODE_SAMESITE, $user_doing_the_restore,
			backup::TARGET_NEW_COURSE );
			$controller->execute_precheck( );
			$controller->execute_plan( );

	~~// Restore backup into course~~		// Commit
	~~$controller = new restore_controller($folder, $courseid,~~		$transaction->allow_commit( );
	~~backup::INTERACTIVE_NO, backup::MODE_SAMESITE, $USER->id,~~
	~~backup::TARGET_NEW_COURSE);~~
	~~$controller->execute_precheck();~~
	~~$controller->execute_plan();~~

	// Commit
	$transaction->allow_commit();
	</code>		</code>

← Older revision		Revision as of 16:26, 27 August 2012
Line 68:		Line 68:

	$data = (object)$data;		$data = (object)$data;
	~~$oldid = $data->id;~~

	$data->choiceid = $this->get_new_parentid('choice');		$data->choiceid = $this->get_new_parentid('choice');
	$data->optionid = $this->get_mappingid('choice_option', $~~oldid~~);		$data->optionid = $this->get_mappingid('choice_option', $data->optionid);
	$data->userid = $this->get_mappingid('user', $data->userid);		$data->userid = $this->get_mappingid('user', $data->userid);
	$data->timemodified = $this->apply_date_offset($data->timemodified);		$data->timemodified = $this->apply_date_offset($data->timemodified);

← Older revision		Revision as of 18:28, 29 May 2012
Line 94:		Line 94:
	*/		*/

	require_once($CFG->dirroot . '/mod/choice/backup/moodle2/~~restore_kb_stepslib~~.php'); // Because it exists (must)		require_once($CFG->dirroot . '/mod/choice/backup/moodle2/restore_choice_stepslib.php'); // Because it exists (must)

	class restore_choice_activity_task extends restore_activity_task {		class restore_choice_activity_task extends restore_activity_task {