mirrored from git://git.moodle.org/moodle.git
-
Notifications
You must be signed in to change notification settings - Fork 6.6k
/
restore_ui_stage.class.php
770 lines (721 loc) · 28 KB
/
restore_ui_stage.class.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* restore user interface stages
*
* This file contains the classes required to manage the stages that make up the
* restore user interface.
* These will be primarily operated a {@see restore_ui} instance.
*
* @package moodlecore
* @copyright 2010 Sam Hemelryk
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
/**
* Abstract stage class
*
* This class should be extended by all restore stages (a requirement of many restore ui functions).
* Each stage must then define two abstract methods
* - process : To process the stage
* - initialise_stage_form : To get a restore_moodleform instance for the stage
*
* @copyright 2010 Sam Hemelryk
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
abstract class restore_ui_stage extends base_ui_stage {
/**
* Constructor
* @param restore_ui $ui
*/
public function __construct(restore_ui $ui, array $params=null) {
$this->ui = $ui;
$this->params = $params;
}
/**
* The restore id from the restore controller
* @return string
*/
final public function get_restoreid() {
return $this->get_uniqueid();
}
/**
* This is an independent stage
* @return int
*/
final public function is_independent() {
return false;
}
/**
* No sub stages for this stage
* @return false
*/
public function has_sub_stages() {
return false;
}
/**
* The name of this stage
* @return string
*/
final public function get_name() {
return get_string('restorestage'.$this->stage,'backup');
}
/**
* Returns true if this is the settings stage
* @return bool
*/
final public function is_first_stage() {
return $this->stage == restore_ui::STAGE_SETTINGS;
}
}
/**
* Abstract class used to represent a restore stage that is indenependent.
*
* An independent stage is a judged to be so because it doesn't require, and has
* no use for the restore controller.
*/
abstract class restore_ui_independent_stage {
abstract public function __construct($contextid);
abstract public function process();
abstract public function display($renderer);
abstract public function get_stage();
/**
* Gets an array of progress bar items that can be displayed through the restore renderer.
* @return array Array of items for the progress bar
*/
public function get_progress_bar() {
global $PAGE;
$stage = restore_ui::STAGE_COMPLETE;
$currentstage = $this->get_stage();
$items = array();
while ($stage > 0) {
$classes = array('backup_stage');
if (floor($stage/2) == $currentstage) {
$classes[] = 'backup_stage_next';
} else if ($stage == $currentstage) {
$classes[] = 'backup_stage_current';
} else if ($stage < $currentstage) {
$classes[] = 'backup_stage_complete';
}
$item = array('text' => strlen(decbin($stage)).'. '.get_string('restorestage'.$stage, 'backup'),'class' => join(' ', $classes));
if ($stage < $currentstage && $currentstage < restore_ui::STAGE_COMPLETE) {
//$item['link'] = new moodle_url($PAGE->url, array('restore'=>$this->get_restoreid(), 'stage'=>$stage));
}
array_unshift($items, $item);
$stage = floor($stage/2);
}
return $items;
}
abstract public function get_stage_name();
/**
* Obviously true
* @return true
*/
final public function is_independent() {
return true;
}
public function destroy() {
// Nothing to destroy here!
}
}
/**
* The confirmation stage.
*
* This is the first stage, it is independent.
*/
class restore_ui_stage_confirm extends restore_ui_independent_stage {
protected $contextid;
protected $filename = null;
protected $filepath = null;
protected $details;
public function __construct($contextid) {
$this->contextid = $contextid;
$this->filename = required_param('filename', PARAM_FILE);
}
public function process() {
global $CFG;
if (!file_exists("$CFG->tempdir/backup/".$this->filename)) {
throw new restore_ui_exception('invalidrestorefile');
}
$outcome = $this->extract_file_to_dir();
if ($outcome) {
fulldelete($this->filename);
}
return $outcome;
}
protected function extract_file_to_dir() {
global $CFG, $USER;
$this->filepath = restore_controller::get_tempdir_name($this->contextid, $USER->id);
$fb = get_file_packer();
return ($fb->extract_to_pathname("$CFG->tempdir/backup/".$this->filename, "$CFG->tempdir/backup/$this->filepath/"));
}
/**
* Renders the confirmation stage screen
*
* @param core_backup_renderer $renderer renderer instance to use
* @return string HTML code
*/
public function display($renderer) {
$prevstageurl = new moodle_url('/backup/restorefile.php', array('contextid' => $this->contextid));
$nextstageurl = new moodle_url('/backup/restore.php', array(
'contextid' => $this->contextid,
'filepath' => $this->filepath,
'stage' => restore_ui::STAGE_DESTINATION));
$format = backup_general_helper::detect_backup_format($this->filepath);
if ($format === backup::FORMAT_UNKNOWN) {
// unknown format - we can't do anything here
return $renderer->backup_details_unknown($prevstageurl);
} else if ($format !== backup::FORMAT_MOODLE) {
// non-standard format to be converted
$details = array('format' => $format, 'type' => backup::TYPE_1COURSE); // todo type to be returned by a converter
return $renderer->backup_details_nonstandard($nextstageurl, $details);
} else {
// standard MBZ backup, let us get information from it and display
$this->details = backup_general_helper::get_backup_information($this->filepath);
return $renderer->backup_details($this->details, $nextstageurl);
}
}
public function get_stage_name() {
return get_string('restorestage'.restore_ui::STAGE_CONFIRM, 'backup');
}
public function get_stage() {
return restore_ui::STAGE_CONFIRM;
}
}
/**
* This is the destination stage.
*
* This stage is the second stage and is also independent
*/
class restore_ui_stage_destination extends restore_ui_independent_stage {
protected $contextid;
protected $filepath = null;
protected $courseid = null;
protected $target = backup::TARGET_NEW_COURSE;
protected $coursesearch = null;
protected $categorysearch = null;
public function __construct($contextid) {
global $PAGE;
$this->contextid = $contextid;
$this->filepath = required_param('filepath', PARAM_ALPHANUM);
$url = new moodle_url($PAGE->url, array(
'filepath'=>$this->filepath,
'contextid'=>$this->contextid,
'stage'=>restore_ui::STAGE_DESTINATION));
$this->coursesearch = new restore_course_search(array('url'=>$url), get_context_instance_by_id($contextid)->instanceid);
$this->categorysearch = new restore_category_search(array('url'=>$url));
}
public function process() {
global $CFG, $DB;
if (!file_exists("$CFG->tempdir/backup/".$this->filepath) || !is_dir("$CFG->tempdir/backup/".$this->filepath)) {
throw new restore_ui_exception('invalidrestorepath');
}
if (optional_param('searchcourses', false, PARAM_BOOL)) {
return false;
}
$this->target = optional_param('target', backup::TARGET_NEW_COURSE, PARAM_INT);
$targetid = optional_param('targetid', null, PARAM_INT);
if (!is_null($this->target) && !is_null($targetid) && confirm_sesskey()) {
if ($this->target == backup::TARGET_NEW_COURSE) {
list($fullname, $shortname) = restore_dbops::calculate_course_names(0, get_string('restoringcourse', 'backup'), get_string('restoringcourseshortname', 'backup'));
$this->courseid = restore_dbops::create_new_course($fullname, $shortname, $targetid);
} else {
$this->courseid = $targetid;
}
return ($DB->record_exists('course', array('id'=>$this->courseid)));
}
return false;
}
/**
* Renders the destination stage screen
*
* @param core_backup_renderer $renderer renderer instance to use
* @return string HTML code
*/
public function display($renderer) {
$format = backup_general_helper::detect_backup_format($this->filepath);
if ($format === backup::FORMAT_MOODLE) {
// standard Moodle 2 format, let use get the type of the backup
$details = backup_general_helper::get_backup_information($this->filepath);
if ($details->type === backup::TYPE_1COURSE) {
$wholecourse = true;
} else {
$wholecourse = false;
}
} else {
// non-standard format to be converted. We assume it contains the
// whole course for now. However, in the future there might be a callback
// to the installed converters
$wholecourse = true;
}
$nextstageurl = new moodle_url('/backup/restore.php', array(
'contextid' => $this->contextid,
'filepath' => $this->filepath,
'stage' => restore_ui::STAGE_SETTINGS));
$context = get_context_instance_by_id($this->contextid);
if ($context->contextlevel == CONTEXT_COURSE and has_capability('moodle/restore:restorecourse', $context)) {
$currentcourse = $context->instanceid;
} else {
$currentcourse = false;
}
return $renderer->course_selector($nextstageurl, $wholecourse, $this->categorysearch, $this->coursesearch, $currentcourse);
}
public function get_stage_name() {
return get_string('restorestage'.restore_ui::STAGE_DESTINATION, 'backup');
}
public function get_filepath() {
return $this->filepath;
}
public function get_course_id() {
return $this->courseid;
}
public function get_stage() {
return restore_ui::STAGE_DESTINATION;
}
public function get_target() {
return $this->target;
}
}
/**
* This stage is the settings stage.
*
* This stage is the third stage, it is dependent on a restore controller and
* is the first stage as such.
*/
class restore_ui_stage_settings extends restore_ui_stage {
/**
* Initial restore stage constructor
* @param restore_ui $ui
*/
public function __construct(restore_ui $ui, array $params=null) {
$this->stage = restore_ui::STAGE_SETTINGS;
parent::__construct($ui, $params);
}
public function process(base_moodleform $form=null) {
$form = $this->initialise_stage_form();
if ($form->is_cancelled()) {
$this->ui->cancel_process();
}
$data = $form->get_data();
if ($data && confirm_sesskey()) {
$tasks = $this->ui->get_tasks();
$changes = 0;
foreach ($tasks as &$task) {
// We are only interesting in the backup root task for this stage
if ($task instanceof restore_root_task || $task instanceof restore_course_task) {
// Get all settings into a var so we can iterate by reference
$settings = $task->get_settings();
foreach ($settings as &$setting) {
$name = $setting->get_ui_name();
if (isset($data->$name) && $data->$name != $setting->get_value()) {
$setting->set_value($data->$name);
$changes++;
} else if (!isset($data->$name) && $setting->get_ui_type() == backup_setting::UI_HTML_CHECKBOX && $setting->get_value()) {
$setting->set_value(0);
$changes++;
}
}
}
}
// Return the number of changes the user made
return $changes;
} else {
return false;
}
}
protected function initialise_stage_form() {
global $PAGE;
if ($this->stageform === null) {
$form = new restore_settings_form($this, $PAGE->url);
// Store as a variable so we can iterate by reference
$tasks = $this->ui->get_tasks();
$headingprinted = false;
// Iterate all tasks by reference
foreach ($tasks as &$task) {
// For the initial stage we are only interested in the root settings
if ($task instanceof restore_root_task) {
if (!$headingprinted) {
$form->add_heading('rootsettings', get_string('restorerootsettings', 'backup'));
$headingprinted = true;
}
$settings = $task->get_settings();
// First add all settings except the filename setting
foreach ($settings as &$setting) {
if ($setting->get_name() == 'filename') {
continue;
}
$form->add_setting($setting, $task);
}
// Then add all dependencies
foreach ($settings as &$setting) {
if ($setting->get_name() == 'filename') {
continue;
}
$form->add_dependencies($setting);
}
}
}
$this->stageform = $form;
}
// Return the form
return $this->stageform;
}
}
/**
* Schema stage of backup process
*
* During the schema stage the user is required to set the settings that relate
* to the area that they are backing up as well as its children.
*
* @copyright 2010 Sam Hemelryk
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class restore_ui_stage_schema extends restore_ui_stage {
/**
* Schema stage constructor
* @param backup_moodleform $ui
*/
public function __construct(restore_ui $ui, array $params=null) {
$this->stage = restore_ui::STAGE_SCHEMA;
parent::__construct($ui, $params);
}
/**
* Processes the schema stage
*
* @param backup_moodleform|null $form
* @return int The number of changes the user made
*/
public function process(base_moodleform $form = null) {
$form = $this->initialise_stage_form();
// Check it wasn't cancelled
if ($form->is_cancelled()) {
$this->ui->cancel_process();
}
// Check it has been submit
$data = $form->get_data();
if ($data && confirm_sesskey()) {
// Get the tasks into a var so we can iterate by reference
$tasks = $this->ui->get_tasks();
$changes = 0;
// Iterate all tasks by reference
foreach ($tasks as &$task) {
// We are only interested in schema settings
if (!($task instanceof restore_root_task)) {
// Store as a variable so we can iterate by reference
$settings = $task->get_settings();
// Iterate by reference
foreach ($settings as &$setting) {
$name = $setting->get_ui_name();
if (isset($data->$name) && $data->$name != $setting->get_value()) {
$setting->set_value($data->$name);
$changes++;
} else if (!isset($data->$name) && $setting->get_ui_type() == backup_setting::UI_HTML_CHECKBOX && $setting->get_value()) {
$setting->set_value(0);
$changes++;
}
}
}
}
// Return the number of changes the user made
return $changes;
} else {
return false;
}
}
/**
* Creates the backup_schema_form instance for this stage
*
* @return backup_schema_form
*/
protected function initialise_stage_form() {
global $PAGE;
if ($this->stageform === null) {
$form = new restore_schema_form($this, $PAGE->url);
$tasks = $this->ui->get_tasks();
$content = '';
$courseheading = false;
foreach ($tasks as $task) {
if (!($task instanceof restore_root_task)) {
if (!$courseheading) {
// If we havn't already display a course heading to group nicely
$form->add_heading('coursesettings', get_string('coursesettings', 'backup'));
$courseheading = true;
}
// First add each setting
foreach ($task->get_settings() as $setting) {
$form->add_setting($setting, $task);
}
// The add all the dependencies
foreach ($task->get_settings() as $setting) {
$form->add_dependencies($setting);
}
} else if ($this->ui->enforce_changed_dependencies()) {
// Only show these settings if dependencies changed them.
// Add a root settings heading to group nicely
$form->add_heading('rootsettings', get_string('rootsettings', 'backup'));
// Iterate all settings and add them to the form as a fixed
// setting. We only want schema settings to be editable
foreach ($task->get_settings() as $setting) {
if ($setting->get_name() != 'filename') {
$form->add_fixed_setting($setting, $task);
}
}
}
}
$this->stageform = $form;
}
return $this->stageform;
}
}
/**
* Confirmation stage
*
* On this stage the user reviews the setting for the backup and can change the filename
* of the file that will be generated.
*
* @copyright 2010 Sam Hemelryk
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class restore_ui_stage_review extends restore_ui_stage {
/**
* Constructs the stage
* @param backup_ui $ui
*/
public function __construct($ui, array $params=null) {
$this->stage = restore_ui::STAGE_REVIEW;
parent::__construct($ui, $params);
}
/**
* Processes the confirmation stage
*
* @param backup_moodleform $form
* @return int The number of changes the user made
*/
public function process(base_moodleform $form = null) {
$form = $this->initialise_stage_form();
// Check it hasn't been cancelled
if ($form->is_cancelled()) {
$this->ui->cancel_process();
}
$data = $form->get_data();
if ($data && confirm_sesskey()) {
return 0;
} else {
return false;
}
}
/**
* Creates the backup_confirmation_form instance this stage requires
*
* @return backup_confirmation_form
*/
protected function initialise_stage_form() {
global $PAGE;
if ($this->stageform === null) {
// Get the form
$form = new restore_review_form($this, $PAGE->url);
$content = '';
$courseheading = false;
foreach ($this->ui->get_tasks() as $task) {
if ($task instanceof restore_root_task) {
// If its a backup root add a root settings heading to group nicely
$form->add_heading('rootsettings', get_string('rootsettings', 'backup'));
} else if (!$courseheading) {
// we havn't already add a course heading
$form->add_heading('coursesettings', get_string('coursesettings', 'backup'));
$courseheading = true;
}
// Iterate all settings, doesnt need to happen by reference
foreach ($task->get_settings() as $setting) {
$form->add_fixed_setting($setting, $task);
}
}
$this->stageform = $form;
}
return $this->stageform;
}
}
/**
* Final stage of backup
*
* This stage is special in that it is does not make use of a form. The reason for
* this is the order of procession of backup at this stage.
* The processesion is:
* 1. The final stage will be intialise.
* 2. The confirmation stage will be processed.
* 3. The backup will be executed
* 4. The complete stage will be loaded by execution
* 5. The complete stage will be displayed
*
* This highlights that we neither need a form nor a display method for this stage
* we simply need to process.
*
* @copyright 2010 Sam Hemelryk
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class restore_ui_stage_process extends restore_ui_stage {
const SUBSTAGE_NONE = 0;
const SUBSTAGE_PRECHECKS = 2;
protected $substage = 0;
/**
* Constructs the final stage
* @param backup_ui $ui
*/
public function __construct(base_ui $ui, array $params=null) {
$this->stage = restore_ui::STAGE_PROCESS;
parent::__construct($ui, $params);
}
/**
* Processes the final stage.
*
* In this case it checks to see if there is a sub stage that we need to display
* before execution, if there is we gear up to display the subpage, otherwise
* we return true which will lead to execution of the restore and the loading
* of the completed stage.
*/
public function process(base_moodleform $form=null) {
if (optional_param('cancel', false, PARAM_BOOL)) {
redirect(new moodle_url('/course/view.php', array('id'=>$this->get_ui()->get_controller()->get_courseid())));
}
// First decide whether a substage is needed
$rc = $this->ui->get_controller();
if ($rc->get_status() == backup::STATUS_SETTING_UI) {
$rc->finish_ui();
}
if ($rc->get_status() == backup::STATUS_NEED_PRECHECK) {
if (!$rc->precheck_executed()) {
$rc->execute_precheck(true);
}
$results = $rc->get_precheck_results();
if (!empty($results)) {
$this->substage = self::SUBSTAGE_PRECHECKS;
}
}
$substage = optional_param('substage', null, PARAM_INT);
if (empty($this->substage) && !empty($substage)) {
$this->substage = $substage;
// Now check whether that substage has already been submit
if ($this->substage == self::SUBSTAGE_PRECHECKS && optional_param('sesskey', null, PARAM_RAW) == sesskey()) {
$info = $rc->get_info();
if (!empty($info->role_mappings->mappings)) {
foreach ($info->role_mappings->mappings as $key=>&$mapping) {
$mapping->targetroleid = optional_param('mapping'.$key, $mapping->targetroleid, PARAM_INT);
}
$info->role_mappings->modified = true;
}
// We've processed the substage now setting it back to none so we
// can move to the next stage.
$this->substage = self::SUBSTAGE_NONE;
}
}
return empty($this->substage);
}
/**
* should NEVER be called... throws an exception
*/
protected function initialise_stage_form() {
throw new backup_ui_exception('backup_ui_must_execute_first');
}
/**
* Renders the process stage screen
*
* @param core_backup_renderer $renderer renderer instance to use
* @return string HTML code
*/
public function display($renderer) {
global $PAGE;
$html = '';
$haserrors = false;
$url = new moodle_url($PAGE->url, array(
'restore' => $this->get_uniqueid(),
'stage' => restore_ui::STAGE_PROCESS,
'substage' => $this->substage,
'sesskey' => sesskey()));
$html .= html_writer::start_tag('form', array(
'action' => $url->out_omit_querystring(),
'class' => 'backup-restore',
'method' => 'post'));
foreach ($url->params() as $name => $value) {
$html .= html_writer::empty_tag('input', array(
'type' => 'hidden',
'name' => $name,
'value' => $value));
}
switch ($this->substage) {
case self::SUBSTAGE_PRECHECKS :
$results = $this->ui->get_controller()->get_precheck_results();
$info = $this->ui->get_controller()->get_info();
$haserrors = (!empty($results['errors']));
$html .= $renderer->precheck_notices($results);
if (!empty($info->role_mappings->mappings)) {
$context = get_context_instance(CONTEXT_COURSE, $this->ui->get_controller()->get_courseid());
$assignableroles = get_assignable_roles($context, ROLENAME_ALIAS, false);
$html .= $renderer->role_mappings($info->role_mappings->mappings, $assignableroles);
}
break;
default:
throw new restore_ui_exception('backup_ui_must_execute_first');
}
$html .= $renderer->substage_buttons($haserrors);
$html .= html_writer::end_tag('form');
return $html;
}
public function has_sub_stages() {
return true;
}
}
/**
* This is the completed stage.
*
* Once this is displayed there is nothing more to do.
*/
class restore_ui_stage_complete extends restore_ui_stage_process {
/**
* The results of the backup execution
* @var array
*/
protected $results;
/**
* Constructs the complete backup stage
* @param backup_ui $ui
* @param array|null $params
* @param array $results
*/
public function __construct(restore_ui $ui, array $params=null, array $results=null) {
$this->results = $results;
parent::__construct($ui, $params);
$this->stage = restore_ui::STAGE_COMPLETE;
}
/**
* Displays the completed backup stage.
*
* Currently this just envolves redirecting to the file browser with an
* appropriate message.
*
* @param core_backup_renderer $renderer
*/
public function display(core_backup_renderer $renderer) {
$html = '';
$html .= $renderer->box_start();
if (array_key_exists('file_missing_in_backup', $this->results)) {
$html .= $renderer->notification(get_string('restorefileweremissing', 'backup'), 'notifyproblem');
}
$html .= $renderer->notification(get_string('restoreexecutionsuccess', 'backup'), 'notifysuccess');
$html .= $renderer->continue_button(new moodle_url('/course/view.php', array(
'id' => $this->get_ui()->get_controller()->get_courseid())), 'get');
$html .= $renderer->box_end();
return $html;
}
}