L-electron-Rare/moodle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

MDL-42039 Restore: Add progress tracking in restore controller load

Browse Source 
In the case of a very large backup with many activities, simply loading
the restore controller (specifically, building the plan) can take a long
time and cause timeouts. This change adds progress reporting while the
restore controller is being loaded.

(This also reduces the time between first going to the page, and the
progress bar appearing, making a slightly better user experience.)

Conflicts:

	backup/restore.php
This commit is contained in:
sam marshall
2013-10-10 10:57:24 +08:00
committed by Damyon Wiese
parent a658b73cd0
commit bf2a039e9a
3 changed files with 51 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
backup/controller/restore_controller.class.php
+19 -4
View File
@@ -58,6 +58,11 @@ class restore_controller extends base_controller {
protected $checksum; // Cache @checksumable results for lighter @is_checksum_correct() uses
/**
* Constructor.
*
* If you specify a progress monitor, this will be used to report progress
* while loading the plan, as well as for future use. (You can change it
* for a different one later using set_progress.)
*
* @param string $tempdir Directory under tempdir/backup awaiting restore
* @param int $courseid Course id where restore is going to happen
@@ -65,8 +70,10 @@ class restore_controller extends base_controller {
* @param int $mode backup::MODE_[ GENERAL | HUB | IMPORT | SAMESITE ]
* @param int $userid
* @param int $target backup::TARGET_[ NEW_COURSE | CURRENT_ADDING | CURRENT_DELETING | EXISTING_ADDING | EXISTING_DELETING ]
* @param core_backup_progress $progress Optional progress monitor
*/
public function __construct($tempdir, $courseid, $interactive, $mode, $userid, $target){
public function __construct($tempdir, $courseid, $interactive, $mode, $userid, $target,
core_backup_progress $progress = null) {
$this->tempdir = $tempdir;
$this->courseid = $courseid;
$this->interactive = $interactive;
@@ -99,9 +106,14 @@ class restore_controller extends base_controller {
// Default logger chain (based on interactive/execution)
$this->logger = backup_factory::get_logger_chain($this->interactive, $this->execution, $this->restoreid);
// By default there is no progress reporter. Interfaces that wish to
// display progress must set it.
$this->progress = new core_backup_null_progress();
// By default there is no progress reporter unless you specify one so it
// can be used during loading of the plan.
if ($progress) {
$this->progress = $progress;
} else {
$this->progress = new core_backup_null_progress();
}
$this->progress->start_progress('Constructing restore_controller');
// Instantiate the output_controller singleton and active it if interactive and inmediate
$oc = output_controller::get_instance();
@@ -135,6 +147,9 @@ class restore_controller extends base_controller {
$this->set_status(backup::STATUS_NEED_PRECHECK);
}
}
// Tell progress monitor that we finished loading.
$this->progress->end_progress();
}
/**