-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathlib.php
1188 lines (1070 loc) · 49.4 KB
/
lib.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
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?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/>.
/**
* This file contains helper functions for the Moodle Rollover Wizard.
*
* Provides functionalities related to the course rollover process, including verification,
* data manipulation, and progress tracking. This file utilizes existing Moodle libraries
* for course management, block handling, and backup/restore operations.
*
* @package local_rollover_wizard
* @copyright 2024 Cosector Development <dev@cosector.co.uk>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
define('ROLLOVER_WIZARD_SUCCESS', 'Successful');
define('ROLLOVER_WIZARD_UNSUCCESS', 'Unsuccessful');
define('ROLLOVER_WIZARD_CANCELLED', 'Cancelled');
define('ROLLOVER_WIZARD_NOTSTARTED', 'Not-started');
define('ROLLOVER_WIZARD_INPROGRESS', 'In-progress');
define('ROLLOVER_WIZARD_PARTLYSUCCESS', 'Partly-Successful');
require_once($CFG->dirroot . '/course/lib.php');
require_once($CFG->dirroot . '/lib/blocklib.php');
require_once($CFG->dirroot . '/mod/quiz/locallib.php');
require_once($CFG->dirroot . '/backup/util/includes/restore_includes.php');
require_once($CFG->dirroot . '/backup/util/includes/backup_includes.php');
/**
* Extends the navigation for a course during the rollover wizard.
*
* This function is likely called by the rollover wizard process to modify
* the course navigation structure.
*
* @param navigation_node $navigation The navigation node object.
* @param stdClass $course The course object.
* @param stdClass $context The context object.
* @return void
*/
function local_rollover_wizard_extend_navigation_course(navigation_node $navigation, $course, $context)
{
global $PAGE, $CFG;
if (has_capability('local/rollover_wizard:edit', $context)) {
$sessiondata = [];
if (isset($_SESSION['local_rollover_wizard'])) {
foreach ($_SESSION['local_rollover_wizard'] as $key => $object) {
if (is_array($object)) {
$targetcourse = $object['target_course'];
if ($targetcourse->id == $course->id) {
unset($_SESSION['local_rollover_wizard'][$key]);
break;
}
}
}
}
$sessiondata['target_course'] = $course;
$sessiondata['source_course'] = null;
$sessiondata['selected_activity'] = null;
$sessiondata['mode'] = null;
$sessiondata['import_course_setting'] = false;
$key = time();
$_SESSION['local_rollover_wizard'][$key] = $sessiondata;
$_SESSION['local_rollover_wizard']['key'] = $key;
$PAGE->requires->js(new moodle_url($CFG->wwwroot . '/local/rollover_wizard/script/app.js'));
$PAGE->requires->css(new moodle_url($CFG->wwwroot . '/local/rollover_wizard/script/app.css'));
$navigation->add(
get_string(
'importcourse',
'local_rollover_wizard'
),
'#',
navigation_node::TYPE_SETTING,
null,
'rolloverwizard',
null
);
}
}
/**
* Verifies a course during the rollover wizard process.
*
* Checks for potential issues or conflicts during the course rollover.
*
* @param int $sourcecourseid The ID of the source course.
* @param int $targetcourseid The ID of the target course.
* @param bool $fullwarning Whether to return full warning messages or just a count.
* @param string $mode The rollover mode (e.g., 'reverse').
* @return string A warning message or an empty string if no issues found.
*/
function local_rollover_wizard_verify_course($sourcecourseid, $targetcourseid, $fullwarning = true, $mode = 'reverse')
{
global $DB, $CFG, $USER;
$setting = get_config('local_rollover_wizard');
$excludedactivitytypes = (empty(trim($setting->activities_notberolled)) ? [] : explode(',', $setting->activities_notberolled));
$excludedactivitytypes = array_map('trim', $excludedactivitytypes);
$warnings = '';
$warningcount = 0;
$sql = "SELECT DISTINCT targetcourseid, timecreated, userid
FROM {local_rollover_wizard_log} WHERE status IN('Successful', 'Partly-Successful')
GROUP BY targetcourseid";
$rolledovertargetcourses = $DB->get_records_sql($sql);
$rolledovertargetcoursekeys = array_keys($rolledovertargetcourses);
if (in_array($targetcourseid, $rolledovertargetcoursekeys)) {
$userid = $rolledovertargetcourses[$targetcourseid]->userid;
$user = $DB->get_record('user', ['id' => $userid]);
$warnings = 'This course had content imported on ' .
userdate($rolledovertargetcourses[$targetcourseid]->timecreated, '%d-%m-%y') .
" by " . fullname($user);
$warningcount++;
}
if ($fullwarning) {
$sourcecourseactivities = course_modinfo::get_array_of_activities($DB->get_record('course', ['id' => $sourcecourseid]));
$targetcourseactivities = course_modinfo::get_array_of_activities($DB->get_record('course', ['id' => $targetcourseid]));
$sourcecourseactivities = array_filter($sourcecourseactivities, static function ($element) {
return $element->mod != 'forum';
}); // Forum added by default in all courses.
$targetcourseactivities = array_filter($targetcourseactivities, static function ($element) {
return $element->mod != 'forum';
}); // Forum added by default in all courses.
$sourcecourseactivitynames = array_column($sourcecourseactivities, 'name');
$targetcourseactivitynames = array_column($targetcourseactivities, 'name');
$duplicatenames = null;
$diffs = null;
$duplicatenames = array_intersect($targetcourseactivitynames, $sourcecourseactivitynames);
$diffs = array_diff($sourcecourseactivitynames, $targetcourseactivitynames);
if (!empty($duplicatenames) || !empty($diffs)) {
$warnings .= (empty($warnings) ? '' : '<br>') . 'Content exists in target course';
$warningcount++;
}
$diffs = null;
$diffs = array_diff(array_column($targetcourseactivities, 'mod'), $excludedactivitytypes);
if (empty($diffs)) {
$warnings .= (empty($warnings) ? '' : '<br>') . 'The source course is blank';
$warningcount++;
}
$sourceformat = course_get_format($sourcecourseid);
$targetformat = course_get_format($targetcourseid);
if ($sourceformat->get_format() != $targetformat->get_format()) {
$warnings .= (empty($warnings) ? '' : '<br>') . 'The course-format is different in source and target courses';
$warningcount++;
}
}
$targetcourse = $DB->get_record('course', ['id' => $targetcourseid]);
$coursetext = "";
if ($warningcount > 0) {
$coursetext = "<b>" . $targetcourse->fullname . "</b> : <br> ";
$warnings = "<div class='rollover-warning-courseid-" . $targetcourseid . "'> $coursetext $warnings </div>";
} else {
$warnings = " ";
}
return $warnings;
}
/**
* Executes the rollover wizard process.
*
* This function initiates the course rollover process based on the specified mode.
*
* @param int $mode The rollover mode (default is 1).
* @return void
*/
function local_rollover_wizard_executerollover($mode = 1, $taskid = 0)
{
global $CFG, $USER, $DB;
require_once($CFG->dirroot . '/course/modlib.php');
require_once($CFG->dirroot . '/backup/util/includes/backup_includes.php');
require_once($CFG->dirroot . '/backup/util/includes/restore_includes.php');
require_once($CFG->libdir . '/filelib.php');
$setting = get_config('local_rollover_wizard');
$excludedactivitytypes = (empty(trim($setting->activities_notberolled)) ? [] : explode(',', $setting->activities_notberolled));
$excludedactivitytypes = array_map('trim', $excludedactivitytypes);
$rolloverqueues = [];
if (!empty($taskid)) {
$rolloverqueue = $DB->get_record(
'local_rollover_wizard_log',
[
'taskid' => $taskid,
'status' => ROLLOVER_WIZARD_NOTSTARTED
]
);
$rolloverqueues[] = $rolloverqueue;
} else {
$rolloverqueues = $DB->get_records(
'local_rollover_wizard_log',
[
'instantexecute' => 0,
'status' => ROLLOVER_WIZARD_NOTSTARTED
]
);
if (empty($rolloverqueues)) {
$rolloverqueues = $DB->get_records(
'local_rollover_wizard_log',
[
'instantexecute' => 1,
'status' => ROLLOVER_WIZARD_NOTSTARTED
]
);
}
}
$countquiz = 0;
$enabled = get_config("local_rollover_wizard", "update_internal_link");
foreach ($rolloverqueues as $rolloverqueue) {
$rolloverqueue = $DB->get_record('local_rollover_wizard_log', ['id' => $rolloverqueue->id]);
$params = [
"id" => $rolloverqueue->sourcecourseid
];
$course = $DB->get_record("course", $params, "*", MUST_EXIST);
mtrace('Content Rollover Wizard Taskid: ' . $rolloverqueue->taskid . ' Started.');
$sourcecourseid = $rolloverqueue->sourcecourseid;
$targetcourseid = $rolloverqueue->targetcourseid;
$useridrollover = $rolloverqueue->userid;
if (!empty($rolloverqueue->cmids)) {
$curexcludedactivitytypes = json_decode($rolloverqueue->excludedactivitytypes);
if ($rolloverqueue->status != ROLLOVER_WIZARD_NOTSTARTED) {
continue;
}
mtrace('TaskID ' . $rolloverqueue->taskid . ' Started.');
$note = '';
$rolledovercmids = '';
$includedsections = [];
$originalsections = [];
$checksections = false;
$rolloverqueue->status = ROLLOVER_WIZARD_INPROGRESS;
$DB->update_record('local_rollover_wizard_log', $rolloverqueue);
$cmids = json_decode($rolloverqueue->cmids);
foreach ($cmids as $cmid) {
$cm = get_coursemodule_from_id('', $cmid);
if ($cm && $cm->modname === 'quiz') {
$countquiz = 1;
}
}
// 1. Proccess activity section to target course.
try {
// Create backup controller.
$bc = new backup_controller(
backup::TYPE_1COURSE,
$sourcecourseid,
backup::FORMAT_MOODLE,
backup::INTERACTIVE_NO,
backup::MODE_IMPORT,
$useridrollover
);
$settings = $bc->get_plan()->get_settings();
foreach ($settings as $setting) {
$settingname = $setting->get_name();
mtrace("Setting Name : ".$settingname);
$shouldinclude = true;
if($countquiz===0){
if (strpos($settingname, 'questionbank') !== false) {
$shouldinclude = false;
}
mtrace("Question Bank Disabled");
}
foreach ($curexcludedactivitytypes as $excludedactivity) {
if (strpos($settingname, $excludedactivity) !== false) {
$shouldinclude = false;
break;
}
}
if (!$shouldinclude) {
$setting->set_value(0);
mtrace("Disabled setting: " . $settingname);
}
}
// Run plan backup.
$bc->execute_plan();
$backupid = $bc->get_backupid();
$bc->destroy();
// Create restore controller.
$rc = new restore_controller(
$backupid,
$targetcourseid,
backup::INTERACTIVE_NO,
backup::MODE_IMPORT,
$useridrollover,
backup::TARGET_CURRENT_ADDING
);
$settings = $rc->get_plan()->get_settings();
foreach ($settings as $setting) {
$settingname = $setting->get_name();
mtrace("Restore : " . $settingname);
}
$rc->execute_precheck();
$rc->execute_plan();
$rc->destroy();
} catch (\Throwable $e) {
mtrace("import failed: " . $e->getMessage());
$note .= "import failed: " . $e->getMessage() . '<br>';
if (trim($e->getMessage()) == 'Table "backup_files_temp" already exists') {
$dbman = $DB->get_manager();
$dbman->drop_table(new \xmldb_table('backup_ids_temp'));
$dbman->drop_table(new \xmldb_table('backup_files_temp'));
}
}
// 2. Proccess Check link to source course
local_rollover_wizard_update_internal_links($rolloverqueue, $enabled);
// 3. Proccess import course setting to target course.
foreach ($cmids as $cmid) {
// Mendapatkan course module berdasarkan cmid
if ($cmid === 'coursesettings') {
try {
$fs = get_file_storage();
$oldtargetcourse = $DB->get_record('course', ['id' => $targetcourseid]);
$oldhasfile = false;
$oldtargetcontext = \context_course::instance($oldtargetcourse->id);
$sql = "SELECT itemid, filename
FROM {files}
WHERE component='course'
AND filearea='overviewfiles'
AND contextid=:contextid LIMIT 1";
$filerecord = $DB->get_record_sql($sql, ['contextid' => $oldtargetcontext->id]);
$file = null;
if (!empty($filerecord)) {
$file = $fs->get_file($oldtargetcontext->id, 'course', 'overviewfiles', 0, '/', $filerecord->filename);
$oldhasfile = true;
}
$backuptempdir = make_backup_temp_directory('');
$packer = get_file_packer('application/vnd.moodle.backup');
$admin = get_admin();
if (!$admin) {
mtrace("Error: No admin account was found");
$a = new stdclass();
$a->userid = $rolloverqueue->userid;
$a->courseid = $courseid;
$a->capability = 'none';
throw new backup_controller_exception('admin_user_missing', $a);
}
$bc = new \backup_controller(
\backup::TYPE_1COURSE,
$sourcecourseid,
\backup::FORMAT_MOODLE,
\backup::INTERACTIVE_NO,
\backup::MODE_GENERAL,
$admin->id
);
foreach ($bc->get_plan()->get_settings() as $setting) {
if ($setting->get_status() != \base_setting::NOT_LOCKED) {
continue;
}
$name = $setting->get_name();
if ($name == 'filename') {
continue;
}
$value = false;
$bc->get_plan()->get_setting($name)->set_value($value);
}
$bc->execute_plan();
$results = $bc->get_results();
$results['backup_destination']->extract_to_pathname($packer, "$backuptempdir/test_content_rollover");
$bc->destroy();
unset($bc);
$rc = new \restore_controller(
'test_content_rollover',
$targetcourseid,
\backup::INTERACTIVE_NO,
\backup::MODE_GENERAL,
$admin->id,
\backup::TARGET_CURRENT_ADDING
);
foreach ($rc->get_plan()->get_settings() as $setting) {
if ($setting->get_status() != \base_setting::NOT_LOCKED) {
continue;
}
$name = $setting->get_name();
$value = false;
if ($name == 'overwrite_conf') {
$value = true;
}
$rc->get_plan()->get_setting($name)->set_value($value);
}
if (!$rc->execute_precheck()) {
$a = new stdclass();
$a->userid = $rolloverqueue->userid;
$a->courseid = $courseid;
$a->capability = 'none';
throw new backup_controller_exception('course_settings_precheck_failed', $a);
}
$rc->execute_plan();
$rc->destroy();
// Course setting update.
$targetcourse = $DB->get_record('course', ['id' => $targetcourseid]);
$targetcourse->summary = $oldtargetcourse->summary;
$targetcourse->summaryformat = $oldtargetcourse->summaryformat;
$targetcourse->visible = $oldtargetcourse->visible;
$targetcourse->visibleold = $oldtargetcourse->visibleold;
$targetcourse->startdate = $oldtargetcourse->startdate;
$targetcourse->enddate = $oldtargetcourse->enddate;
$targetcourse->idnumber = $oldtargetcourse->idnumber;
$DB->update_record('course', $targetcourse);
$targetcontext = \context_course::instance($targetcourse->id);
$sql = "SELECT itemid, filename
FROM {files}
WHERE component='course'
AND filearea='overviewfiles'
AND contextid=:contextid LIMIT 1";
$filerecord = $DB->get_record_sql($sql, ['contextid' => $targetcontext->id]);
$file = null;
if (!$oldhasfile) {
if (!empty($filerecord)) {
$file = $fs->get_file($targetcontext->id, 'course', 'overviewfiles', 0, '/', $filerecord->filename);
}
if ($file) {
$file->delete();
}
}
} catch (\Throwable $e) {
mtrace("Course Settings failed: " . $e->getMessage());
$note .= "Course Settings failed: " . $e->getMessage() . '<br>';
}
}
}
// $coursetarget = $DB->get_record("course", ["id" => $targetcourseid], "*", MUST_EXIST);
// $coursecontext = context_course::instance($coursetarget->id);
// local_rollover_wizard_check_question_bank($coursetarget,$coursecontext);
rebuild_course_cache($rolloverqueue->targetcourseid, true);
if (empty($note)) {
$rolloverqueue->status = ROLLOVER_WIZARD_SUCCESS;
} else {
$rolloverqueue->status = ROLLOVER_WIZARD_PARTLYSUCCESS;
$rolloverqueue->note = $note;
}
$rolloverqueue->rolledovercmids = $rolledovercmids;
$DB->update_record('local_rollover_wizard_log', $rolloverqueue);
}
// End of Rollover Blocks.
// Purge Caches.
rebuild_course_cache($rolloverqueue->targetcourseid, true);
mtrace('TaskID ' . $rolloverqueue->taskid . ' finished.');
$setting = get_config('local_rollover_wizard');
if (!empty($setting->enable_email_notification) && $setting->enable_email_notification == 1) {
if($rolloverqueue->status===ROLLOVER_WIZARD_SUCCESS){
try {
mtrace('Rollover process - Start sending email out.');
local_rollover_wizard_send_email($rolloverqueue);
mtrace('Rollover process - Sending email finished.');
} catch (\Exception $e) {
mtrace("Error at sending email out: " . $e->getMessage());
}
}
}
mtrace('Rollover process finished.');
}
}
function local_rollover_wizard_check_question_bank($coursetarget,$coursecontext){
global $DB;
// Get mod quiz from target course
$quizzes = $DB->get_records('quiz', array('course' => $coursetarget->id));
foreach ($quizzes as $q) {
$cm = get_coursemodule_from_instance('quiz', $q->id, $q->course, false, MUST_EXIST);
$quizobjs = new quiz($q, $cm, $coursetarget);
$slots[] = $quizobjs->get_structure()->get_slots();
foreach ($quizobjs->get_structure()->get_slots() as $key => $value) {
$category_quiz[] = $value->category;
}
}
if ($category_quiz) {
$new_category = array_unique($category_quiz);
}
$fields = 'id, parent, name, contextid';
if ($categories = $DB->get_records('question_categories', ['contextid' => $coursecontext->id], 'parent', $fields)) {
$categories = sort_categories_by_tree($categories);
$categoryids = array_column($categories, "id");
$contextidcategory = array_column($categories, "contextid");
$contextidcategory = array_column($categories, "contextid");
$contextidcategory = array_unique($contextidcategory);
if (!empty($contextidcategory)) {
$sql = "
SELECT qbe.id AS question_id,
qbe.questioncategoryid,
COALESCE(COUNT(qr.questionbankentryid), 0) AS usage_count
FROM {question_bank_entries} qbe
LEFT JOIN {question_references} qr ON qr.questionbankentryid = qbe.id
WHERE qbe.questioncategoryid IN (
SELECT qc.id FROM mdl_question_categories qc
WHERE qc.contextid =:contextid
)
GROUP BY qbe.id, qbe.questioncategoryid
ORDER BY qbe.id DESC";
$result = $DB->get_records_sql($sql, ["contextid" => $contextidcategory[0]]);
$all_zero_usage = true;
$categoryidremove = [];
foreach ($result as $entry) {
if ($entry->usage_count > 0) {
$all_zero_usage = false;
break;
}
$categoryidremove[] = $entry->questioncategoryid;
}
mtrace(json_encode($quizzes));
mtrace(json_encode($new_category));
mtrace(json_encode($categoryidremove));
if ($all_zero_usage) {
if (!empty($categoryidremove)) {
foreach ($categoryidremove as $categoryid) {
if (empty($quizzes)) {
$DB->delete_records("question_bank_entries", ["questioncategoryid" => $categoryid]);
$DB->delete_records("question_categories", ["id" => $categoryid]);
}
if (!empty($new_category)) {
if (!in_array($categoryid, $new_category)) {
$DB->delete_records("question_bank_entries", ["questioncategoryid" => $categoryid]);
$DB->delete_records("question_categories", ["id" => $categoryid]);
}
}
}
}
}
}
}
}
/**
* Creates missing course section(s) and rebuilds course cache
*
* @param int|stdClass $courseorid course id or course object
* @param int|array $sections list of relative section numbers to create
* @return bool if there were any sections created
*/
function local_rollover_wizard_course_create_sections_if_missing(
$targetcourseid,
$sourcecourseid,
$checksections = false,
$included = []
) {
$sections = array_keys(get_fast_modinfo($sourcecourseid)->get_section_info_all());
if (!is_array($sections)) {
$sections = [$sections];
}
$originalsections = get_fast_modinfo($sourcecourseid)->get_section_info_all();
$existing = array_keys(get_fast_modinfo($targetcourseid)->get_section_info_all());
if ($newsections = array_diff($sections, $existing)) {
foreach ($newsections as $sectionnum) {
$originalsection = $originalsections[$sectionnum];
local_rollover_wizard_course_create_section($targetcourseid, $sectionnum, true, $originalsection->visible);
}
return true;
}
return false;
}
/**
* Rewrites the summary for a course during the rollover wizard.
*
* This function modifies the summary based on the provided source and target sections.
*
* @param stdClass $sourcesection The source section object.
* @param stdClass $targetsection The target section object.
* @return string The rewritten summary string.
*/
function local_rollover_wizard_rewrite_summary($sourcesection, $targetsection)
{
global $DB;
$summary = $sourcesection->summary;
$sourcecontext = \context_course::instance($sourcesection->course);
$targetcontext = \context_course::instance($targetsection->course);
$doc = new DOMDocument;
$doc->preserveWhiteSpace = false;
@$doc->loadHTML('<?xml encoding="utf-8" ?><div>' . $summary . '</div>');
$xpath = new DOMXpath($doc);
$rawsrcs = ['//img/@src', '//a/@href'];
foreach ($rawsrcs as $rawsrc) {
$srcs = $xpath->query($rawsrc);
foreach ($srcs as $src) {
$nameonly = str_replace('@@PLUGINFILE@@/', '', $src->nodeValue);
$nameonly = explode('?', $nameonly)[0];
$nameonly = urldecode($nameonly);
$sql = "SELECT itemid
FROM {files}
WHERE component='course'
AND filearea='section'
AND " . $DB->sql_compare_text('filename') . "=" . $DB->sql_compare_text(':filename') . "
AND contextid=:contextid LIMIT 1";
$fileitemid = $DB->get_field_sql($sql, ['contextid' => $targetcontext->id, 'filename' => $nameonly]);
if (empty($fileitemid)) {
$fs = get_file_storage();
// Get Source file.
$file = $fs->get_file($sourcecontext->id, 'course', 'section', $sourcesection->id, '/', $nameonly);
if (!$file) {
continue;
}
$newfilerecord = [
'contextid' => $targetcontext->id,
'component' => $file->get_component(),
'filearea' => $file->get_filearea(),
'itemid' => $targetsection->id,
'filepath' => $file->get_filepath(),
'filename' => $file->get_filename(),
'timecreated' => time(),
'timemodified' => time(),
];
$fs->create_file_from_storedfile($newfilerecord, $file);
$fileitemid = $DB->get_field_sql($sql, ['contextid' => $targetcontext->id, 'filename' => $nameonly]);
}
if (!empty($fileitemid)) {
$imgpath = file_rewrite_pluginfile_urls(
$src->nodeValue,
'pluginfile.php',
$targetcontext->id,
'course',
'section',
$fileitemid
);
$summary = str_replace($src->nodeValue, $imgpath, $summary);
}
}
}
return $summary;
}
function local_rollover_wizard_rewrite_format_intro($source_module, $target_module)
{
global $DB;
$summary = $source_module->intro;
$sourcecontext = context_module::instance($source_module->coursemodule);
$targetcontext = context_module::instance($target_module->coursemodule);
$doc = new DOMDocument;
$doc->preserveWhiteSpace = false;
@$doc->loadHTML('<?xml encoding="utf-8" ?><div>' . $summary . '</div>');
$xpath = new DOMXpath($doc);
$rawsrcs = ['//img/@src', '//a/@href'];
foreach ($rawsrcs as $rawsrc) {
$srcs = $xpath->query($rawsrc);
foreach ($srcs as $src) {
$nameonly = str_replace('@@PLUGINFILE@@/', '', $src->nodeValue);
$nameonly = explode('?', $nameonly)[0];
$nameonly = urldecode($nameonly);
$sql = "SELECT itemid
FROM {files}
WHERE component='mod_{$target_module->modname}'
AND filearea='intro'
AND " . $DB->sql_compare_text('filename') . "=" . $DB->sql_compare_text(':filename') . "
AND contextid=:contextid LIMIT 1";
$fileitemid = $DB->get_field_sql($sql, ['contextid' => $targetcontext->id, 'filename' => $nameonly]);
if (empty($fileitemid)) {
$fs = get_file_storage();
$file = $fs->get_file($sourcecontext->id, 'mod_' . $source_module->modname, 'intro', $source_module->id, '/', $nameonly);
if (!$file) {
continue;
}
$newfilerecord = [
'contextid' => $targetcontext->id,
'component' => $file->get_component(),
'filearea' => $file->get_filearea(),
'itemid' => $target_module->id,
'filepath' => $file->get_filepath(),
'filename' => $file->get_filename(),
'timecreated' => time(),
'timemodified' => time(),
];
$fs->create_file_from_storedfile($newfilerecord, $file);
$fileitemid = $DB->get_field_sql($sql, ['contextid' => $targetcontext->id, 'filename' => $nameonly]);
}
if (!empty($fileitemid)) {
$path = file_rewrite_pluginfile_urls(
$src->nodeValue,
'pluginfile.php',
$targetcontext->id,
'mod_' . $target_module->modname,
'intro',
$fileitemid
);
$summary = str_replace($src->nodeValue, $path, $summary);
}
}
}
return $summary;
}
/**
* Fixes image references within HTML blocks during a rollover wizard.
*
* This function adjusts image paths or URLs within the HTML content.
*
* @param int $sourceblockid The ID of the source HTML block.
* @param int $targetblockid The ID of the target HTML block.
* @param string $content The HTML content to be processed.
* @return void The modified HTML content with fixed image references.
*/
function local_rollover_wizard_htmlblokcs_imagefix($sourceblockid, $targetblockid, $content)
{
global $DB;
$sourcecontext = \context_block::instance($sourceblockid);
$targetcontext = \context_block::instance($targetblockid);
$doc = new DOMDocument;
$doc->preserveWhiteSpace = false;
@$doc->loadHTML('<?xml encoding="utf-8" ?><div>' . $content . '</div>');
$xpath = new DOMXpath($doc);
$rawsrcs = ['//img/@src', '//a/@href'];
foreach ($rawsrcs as $rawsrc) {
$srcs = $xpath->query($rawsrc);
foreach ($srcs as $src) {
$nameonly = str_replace('@@PLUGINFILE@@/', '', $src->nodeValue);
$nameonly = explode('?', $nameonly)[0];
$nameonly = urldecode($nameonly);
$sql = "SELECT itemid
FROM {files}
WHERE component='course'
AND filearea='section'
AND " . $DB->sql_compare_text('filename') . "=" . $DB->sql_compare_text(':filename') . "
AND contextid=:contextid LIMIT 1";
$fileitemid = $DB->get_field_sql($sql, ['contextid' => $targetcontext->id, 'filename' => $nameonly]);
if (empty($fileitemid)) {
$fs = get_file_storage();
// Get Source file.
$file = $fs->get_file($sourcecontext->id, 'block_html', 'content', 0, '/', $nameonly);
if (!$file) {
continue;
}
$newfilerecord = [
'contextid' => $targetcontext->id,
'component' => $file->get_component(),
'filearea' => $file->get_filearea(),
'itemid' => 0,
'filepath' => $file->get_filepath(),
'filename' => $file->get_filename(),
'timecreated' => time(),
'timemodified' => time(),
];
$fs->create_file_from_storedfile($newfilerecord, $file);
$fileitemid = $DB->get_field_sql($sql, ['contextid' => $targetcontext->id, 'filename' => $nameonly]);
}
}
}
}
/**
* Sends an email related to the rollover wizard process.
*
* This function dispatches an email based on the provided rollover queue data.
*
* @param stdClass $rolloverqueue The rollover queue data.
* @return void
*/
function local_rollover_wizard_send_email($rolloverqueue)
{
global $CFG, $DB;
require_once($CFG->dirroot . '/course/lib.php');
$subject = 'Course content rollover has completed.';
$htmlemmailtemplate = get_string('emailtemplate', 'local_rollover_wizard');
$reportlink = $CFG->wwwroot . '/course/view.php?id=' . $rolloverqueue->targetcourseid;
$reportlink = "<a href='$reportlink'>$reportlink</a>";
$emailuser = $DB->get_record('user', ['id' => $rolloverqueue->userid]);
$htmlemmailtemplate = str_replace('{FULLNAME}', "$emailuser->firstname $emailuser->lastname", $htmlemmailtemplate);
$htmlemmailtemplate = str_replace('{REPORT-LINK}', $reportlink, $htmlemmailtemplate);
$fromuser = core_user::get_noreply_user();
// New approach.
$eventdata = new \core\message\message();
$eventdata->component = 'local_rollover_wizard';
$eventdata->name = 'content_rolledover_wizard';
$eventdata->userfrom = \core_user::get_noreply_user();
$eventdata->userto = $emailuser;
$eventdata->subject = $subject;
$eventdata->fullmessage = $htmlemmailtemplate;
$eventdata->fullmessageformat = FORMAT_PLAIN;
$eventdata->fullmessagehtml = $htmlemmailtemplate;
$eventdata->smallmessage = $htmlemmailtemplate;
$eventdata->notification = 1;
$eventdata->contexturl = (new moodle_url('/course/view.php', ['id' => $rolloverqueue->targetcourseid]))->out();
$eventdata->contexturlname = 'Rollover Wizard';
$eventdata->courseid = 0;
message_send($eventdata);
}
/**
* Creates a course section and adds it to the specified position
*
* @param int|stdClass $courseorid course id or course object
* @param int $position position to add to, 0 means to the end. If position is greater than
* number of existing secitons, the section is added to the end. This will become sectionnum of the
* new section. All existing sections at this or bigger position will be shifted down.
* @param bool $skipcheck the check has already been made and we know that the section with this position does not exist
* @return stdClass created section object
*/
function local_rollover_wizard_course_create_section($courseorid, $position = 0, $skipcheck = false, $visible = 1)
{
global $DB;
$courseid = is_object($courseorid) ? $courseorid->id : $courseorid;
// Find the last sectionnum among existing sections.
if ($skipcheck) {
$lastsection = $position - 1;
} else {
$lastsection = (int) $DB->get_field_sql('SELECT max(section) from {course_sections} WHERE course = ?', [$courseid]);
}
// First add section to the end.
$cw = new stdClass();
$cw->course = $courseid;
$cw->section = $lastsection + 1;
$cw->summary = '';
$cw->summaryformat = FORMAT_HTML;
$cw->sequence = '';
$cw->name = null;
$cw->visible = $visible;
$cw->availability = null;
$cw->timemodified = time();
$cw->id = $DB->insert_record("course_sections", $cw);
// Now move it to the specified position.
if ($position > 0 && $position <= $lastsection) {
$course = is_object($courseorid) ? $courseorid : get_course($courseorid);
move_section_to($course, $cw->section, $position, true);
$cw->section = $position;
}
core\event\course_section_created::create_from_section($cw)->trigger();
rebuild_course_cache($courseid, true);
return $cw;
}
/**
* Checks if a course should be processed by a cron task during the rollover wizard.
*
* Determines if the course size exceeds the configured threshold for cron processing.
*
* @param int $courseid The ID of the course to check.
* @return bool True if the course should be processed by cron, false otherwise.
*/
function local_rollover_wizard_is_crontask($courseid)
{
global $DB;
$setting = get_config('local_rollover_wizard');
$iscron = false;
if (!empty($setting->enable_cron_schedulling) && $setting->enable_cron_schedulling == 1) {
$iscron = false;
$coursesize = $DB->get_record('rollover_wizard_coursesize', ['courseid' => $courseid]);
if ($coursesize) {
$maxfilesize = $setting->cron_size_threshold * 1024 ** 3;
$iscron = ((int) $coursesize->size) >= $maxfilesize;
}
}
return $iscron;
}
/**
* Checks if a course should be processed by a cron task during the rollover wizard.
*
* Determines if the course size exceeds the configured threshold for cron processing.
*
* @param int $courseid The ID of the course to check.
* @return bool True if the course should be processed by cron, false otherwise.
*/
function local_rollover_wizard_is_limit_question($courseid)
{
global $DB;
$setting = get_config('local_rollover_wizard');
$course=$DB->get_record("course",["id"=>$courseid]);
$limitquestionbank = (int)($setting->cron_limit_question);
list($totalquestionbank,$questionbank)=local_rollover_wizard_check_total_question_bank_course($course);
$iscron = false;
if($totalquestionbank>=$limitquestionbank) $iscron = true;
return $iscron;
}
/**
* Calculates the total file size for a course.
*
* This function retrieves the size of files associated with blocks, course modules,
* and the course itself, returning the total size.
*
* @param int $courseid The ID of the course to calculate file size for.
* @return stdClass An object containing the course ID (`id`) and total file size (`filesize`).
*/
function local_rollover_wizard_course_filesize($courseid)
{
global $DB;
// New Code.
$filesize = 0;
$blockquery = "SELECT c.id, SUM(f.filesize) AS filesize
FROM {block_instances} bi
JOIN {context} cx1 ON cx1.contextlevel = " . CONTEXT_BLOCK . " AND cx1.instanceid = bi.id
JOIN {context} cx2 ON cx2.contextlevel = " . CONTEXT_COURSE . " AND cx2.id = bi.parentcontextid
JOIN {course} c ON c.id = cx2.instanceid
JOIN {files} f ON f.contextid = cx1.id
WHERE c.id = $courseid
GROUP BY c.id";
if ($record = $DB->get_record_sql($blockquery)) {
$filesize += $record->filesize;
}
$cmquery = "SELECT c.id, SUM(f.filesize) AS filesize
FROM {course_modules} cm
JOIN {context} cx ON cx.contextlevel = " . CONTEXT_MODULE . " AND cx.instanceid = cm.id
JOIN {course} c ON c.id = cm.course
JOIN {files} f ON f.contextid = cx.id
WHERE c.id = $courseid
GROUP BY c.id";
if ($record = $DB->get_record_sql($cmquery)) {
$filesize += $record->filesize;
}
$coursequery = "SELECT c.id, SUM(f.filesize) AS filesize
FROM {course} c
JOIN {context} cx ON cx.contextlevel = " . CONTEXT_COURSE . " AND cx.instanceid = c.id
JOIN {files} f ON f.contextid = cx.id
WHERE c.id = $courseid
GROUP BY c.id";
if ($record = $DB->get_record_sql($coursequery)) {
$filesize += $record->filesize;
}
$course = new \stdClass();
$course->filesize = $filesize;
$course->id = $courseid;