mirrored from git://git.moodle.org/moodle.git
/
externallib.php
4603 lines (4113 loc) · 206 KB
/
externallib.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/>.
/**
* External course API
*
* @package core_course
* @category external
* @copyright 2009 Petr Skodak
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die;
use core_course\external\course_summary_exporter;
use core_external\external_api;
use core_external\external_description;
use core_external\external_files;
use core_external\external_format_value;
use core_external\external_function_parameters;
use core_external\external_multiple_structure;
use core_external\external_single_structure;
use core_external\external_value;
use core_external\external_warnings;
use core_external\util;
require_once(__DIR__ . "/lib.php");
/**
* Course external functions
*
* @package core_course
* @category external
* @copyright 2011 Jerome Mouneyrac
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.2
*/
class core_course_external extends external_api {
/**
* Returns description of method parameters
*
* @return external_function_parameters
* @since Moodle 2.9 Options available
* @since Moodle 2.2
*/
public static function get_course_contents_parameters() {
return new external_function_parameters(
array('courseid' => new external_value(PARAM_INT, 'course id'),
'options' => new external_multiple_structure (
new external_single_structure(
array(
'name' => new external_value(PARAM_ALPHANUM,
'The expected keys (value format) are:
excludemodules (bool) Do not return modules, return only the sections structure
excludecontents (bool) Do not return module contents (i.e: files inside a resource)
includestealthmodules (bool) Return stealth modules for students in a special
section (with id -1)
sectionid (int) Return only this section
sectionnumber (int) Return only this section with number (order)
cmid (int) Return only this module information (among the whole sections structure)
modname (string) Return only modules with this name "label, forum, etc..."
modid (int) Return only the module with this id (to be used with modname'),
'value' => new external_value(PARAM_RAW, 'the value of the option,
this param is personaly validated in the external function.')
)
), 'Options, used since Moodle 2.9', VALUE_DEFAULT, array())
)
);
}
/**
* Get course contents
*
* @param int $courseid course id
* @param array $options Options for filtering the results, used since Moodle 2.9
* @return array
* @since Moodle 2.9 Options available
* @since Moodle 2.2
*/
public static function get_course_contents($courseid, $options = array()) {
global $CFG, $DB, $USER, $PAGE;
require_once($CFG->dirroot . "/course/lib.php");
require_once($CFG->libdir . '/completionlib.php');
//validate parameter
$params = self::validate_parameters(self::get_course_contents_parameters(),
array('courseid' => $courseid, 'options' => $options));
$filters = array();
if (!empty($params['options'])) {
foreach ($params['options'] as $option) {
$name = trim($option['name']);
// Avoid duplicated options.
if (!isset($filters[$name])) {
switch ($name) {
case 'excludemodules':
case 'excludecontents':
case 'includestealthmodules':
$value = clean_param($option['value'], PARAM_BOOL);
$filters[$name] = $value;
break;
case 'sectionid':
case 'sectionnumber':
case 'cmid':
case 'modid':
$value = clean_param($option['value'], PARAM_INT);
if (is_numeric($value)) {
$filters[$name] = $value;
} else {
throw new moodle_exception('errorinvalidparam', 'webservice', '', $name);
}
break;
case 'modname':
$value = clean_param($option['value'], PARAM_PLUGIN);
if ($value) {
$filters[$name] = $value;
} else {
throw new moodle_exception('errorinvalidparam', 'webservice', '', $name);
}
break;
default:
throw new moodle_exception('errorinvalidparam', 'webservice', '', $name);
}
}
}
}
//retrieve the course
$course = $DB->get_record('course', array('id' => $params['courseid']), '*', MUST_EXIST);
// now security checks
$context = context_course::instance($course->id, IGNORE_MISSING);
try {
self::validate_context($context);
} catch (Exception $e) {
$exceptionparam = new stdClass();
$exceptionparam->message = $e->getMessage();
$exceptionparam->courseid = $course->id;
throw new moodle_exception('errorcoursecontextnotvalid', 'webservice', '', $exceptionparam);
}
$canupdatecourse = has_capability('moodle/course:update', $context);
//create return value
$coursecontents = array();
if ($canupdatecourse or $course->visible
or has_capability('moodle/course:viewhiddencourses', $context)) {
//retrieve sections
$modinfo = get_fast_modinfo($course);
$sections = $modinfo->get_section_info_all();
$courseformat = course_get_format($course);
$coursenumsections = $courseformat->get_last_section_number();
$stealthmodules = array(); // Array to keep all the modules available but not visible in a course section/topic.
$completioninfo = new completion_info($course);
//for each sections (first displayed to last displayed)
$modinfosections = $modinfo->get_sections();
foreach ($sections as $key => $section) {
// This becomes true when we are filtering and we found the value to filter with.
$sectionfound = false;
// Filter by section id.
if (!empty($filters['sectionid'])) {
if ($section->id != $filters['sectionid']) {
continue;
} else {
$sectionfound = true;
}
}
// Filter by section number. Note that 0 is a valid section number.
if (isset($filters['sectionnumber'])) {
if ($key != $filters['sectionnumber']) {
continue;
} else {
$sectionfound = true;
}
}
// reset $sectioncontents
$sectionvalues = array();
$sectionvalues['id'] = $section->id;
$sectionvalues['name'] = get_section_name($course, $section);
$sectionvalues['visible'] = $section->visible;
$options = (object) array('noclean' => true);
list($sectionvalues['summary'], $sectionvalues['summaryformat']) =
\core_external\util::format_text($section->summary, $section->summaryformat,
$context, 'course', 'section', $section->id, $options);
$sectionvalues['section'] = $section->section;
$sectionvalues['hiddenbynumsections'] = $section->section > $coursenumsections ? 1 : 0;
$sectionvalues['uservisible'] = $section->uservisible;
if (!empty($section->availableinfo)) {
$sectionvalues['availabilityinfo'] = \core_availability\info::format_info($section->availableinfo, $course);
}
$sectioncontents = array();
// For each module of the section.
if (empty($filters['excludemodules']) and !empty($modinfosections[$section->section])) {
foreach ($modinfosections[$section->section] as $cmid) {
$cm = $modinfo->cms[$cmid];
$cminfo = cm_info::create($cm);
$activitydates = \core\activity_dates::get_dates_for_module($cminfo, $USER->id);
// Stop here if the module is not visible to the user on the course main page:
// The user can't access the module and the user can't view the module on the course page.
if (!$cm->uservisible && !$cm->is_visible_on_course_page()) {
continue;
}
// This becomes true when we are filtering and we found the value to filter with.
$modfound = false;
// Filter by cmid.
if (!empty($filters['cmid'])) {
if ($cmid != $filters['cmid']) {
continue;
} else {
$modfound = true;
}
}
// Filter by module name and id.
if (!empty($filters['modname'])) {
if ($cm->modname != $filters['modname']) {
continue;
} else if (!empty($filters['modid'])) {
if ($cm->instance != $filters['modid']) {
continue;
} else {
// Note that if we are only filtering by modname we don't break the loop.
$modfound = true;
}
}
}
$module = array();
$modcontext = context_module::instance($cm->id);
//common info (for people being able to see the module or availability dates)
$module['id'] = $cm->id;
$module['name'] = \core_external\util::format_string($cm->name, $modcontext);
$module['instance'] = $cm->instance;
$module['contextid'] = $modcontext->id;
$module['modname'] = (string) $cm->modname;
$module['modplural'] = (string) $cm->modplural;
$module['modicon'] = $cm->get_icon_url()->out(false);
$module['indent'] = $cm->indent;
$module['onclick'] = $cm->onclick;
$module['afterlink'] = $cm->afterlink;
$activitybadgedata = $cm->get_activitybadge();
if (!empty($activitybadgedata)) {
$module['activitybadge'] = $activitybadgedata;
}
$module['customdata'] = json_encode($cm->customdata);
$module['completion'] = $cm->completion;
$module['downloadcontent'] = $cm->downloadcontent;
$module['noviewlink'] = plugin_supports('mod', $cm->modname, FEATURE_NO_VIEW_LINK, false);
$module['dates'] = $activitydates;
$module['groupmode'] = $cm->groupmode;
// Check module completion.
$completion = $completioninfo->is_enabled($cm);
if ($completion != COMPLETION_DISABLED) {
$exporter = new \core_completion\external\completion_info_exporter($course, $cm, $USER->id);
$renderer = $PAGE->get_renderer('core');
$modulecompletiondata = (array)$exporter->export($renderer);
$module['completiondata'] = $modulecompletiondata;
}
if (!empty($cm->showdescription) or $module['noviewlink']) {
// We want to use the external format. However from reading get_formatted_content(), $cm->content format is always FORMAT_HTML.
$options = array('noclean' => true);
list($module['description'], $descriptionformat) = \core_external\util::format_text($cm->content,
FORMAT_HTML, $modcontext, $cm->modname, 'intro', $cm->id, $options);
}
//url of the module
$url = $cm->url;
if ($url) { //labels don't have url
$module['url'] = $url->out(false);
}
$canviewhidden = has_capability('moodle/course:viewhiddenactivities',
context_module::instance($cm->id));
//user that can view hidden module should know about the visibility
$module['visible'] = $cm->visible;
$module['visibleoncoursepage'] = $cm->visibleoncoursepage;
$module['uservisible'] = $cm->uservisible;
if (!empty($cm->availableinfo)) {
$module['availabilityinfo'] = \core_availability\info::format_info($cm->availableinfo, $course);
}
// Availability date (also send to user who can see hidden module).
if ($CFG->enableavailability && ($canviewhidden || $canupdatecourse)) {
$module['availability'] = $cm->availability;
}
// Return contents only if the user can access to the module.
if ($cm->uservisible) {
$baseurl = 'webservice/pluginfile.php';
// Call $modulename_export_contents (each module callback take care about checking the capabilities).
require_once($CFG->dirroot . '/mod/' . $cm->modname . '/lib.php');
$getcontentfunction = $cm->modname.'_export_contents';
if (function_exists($getcontentfunction)) {
$contents = $getcontentfunction($cm, $baseurl);
$module['contentsinfo'] = array(
'filescount' => count($contents),
'filessize' => 0,
'lastmodified' => 0,
'mimetypes' => array(),
);
foreach ($contents as $content) {
// Check repository file (only main file).
if (!isset($module['contentsinfo']['repositorytype'])) {
$module['contentsinfo']['repositorytype'] =
isset($content['repositorytype']) ? $content['repositorytype'] : '';
}
if (isset($content['filesize'])) {
$module['contentsinfo']['filessize'] += $content['filesize'];
}
if (isset($content['timemodified']) &&
($content['timemodified'] > $module['contentsinfo']['lastmodified'])) {
$module['contentsinfo']['lastmodified'] = $content['timemodified'];
}
if (isset($content['mimetype'])) {
$module['contentsinfo']['mimetypes'][$content['mimetype']] = $content['mimetype'];
}
}
if (empty($filters['excludecontents']) and !empty($contents)) {
$module['contents'] = $contents;
} else {
$module['contents'] = array();
}
}
}
// Assign result to $sectioncontents, there is an exception,
// stealth activities in non-visible sections for students go to a special section.
if (!empty($filters['includestealthmodules']) && !$section->uservisible && $cm->is_stealth()) {
$stealthmodules[] = $module;
} else {
$sectioncontents[] = $module;
}
// If we just did a filtering, break the loop.
if ($modfound) {
break;
}
}
}
$sectionvalues['modules'] = $sectioncontents;
// assign result to $coursecontents
$coursecontents[$key] = $sectionvalues;
// Break the loop if we are filtering.
if ($sectionfound) {
break;
}
}
// Now that we have iterated over all the sections and activities, check the visibility.
// We didn't this before to be able to retrieve stealth activities.
foreach ($coursecontents as $sectionnumber => $sectioncontents) {
$section = $sections[$sectionnumber];
if (!$courseformat->is_section_visible($section)) {
unset($coursecontents[$sectionnumber]);
continue;
}
// Remove section and modules information if the section is not visible for the user.
if (!$section->uservisible) {
$coursecontents[$sectionnumber]['modules'] = array();
// Remove summary information if the section is completely hidden only,
// even if the section is not user visible, the summary is always displayed among the availability information.
if (!$section->visible) {
$coursecontents[$sectionnumber]['summary'] = '';
}
}
}
// Include stealth modules in special section (without any info).
if (!empty($stealthmodules)) {
$coursecontents[] = array(
'id' => -1,
'name' => '',
'summary' => '',
'summaryformat' => FORMAT_MOODLE,
'modules' => $stealthmodules
);
}
}
return $coursecontents;
}
/**
* Returns description of method result value
*
* @return \core_external\external_description
* @since Moodle 2.2
*/
public static function get_course_contents_returns() {
$completiondefinition = \core_completion\external\completion_info_exporter::get_read_structure(VALUE_DEFAULT, []);
return new external_multiple_structure(
new external_single_structure(
array(
'id' => new external_value(PARAM_INT, 'Section ID'),
'name' => new external_value(PARAM_RAW, 'Section name'),
'visible' => new external_value(PARAM_INT, 'is the section visible', VALUE_OPTIONAL),
'summary' => new external_value(PARAM_RAW, 'Section description'),
'summaryformat' => new external_format_value('summary'),
'section' => new external_value(PARAM_INT, 'Section number inside the course', VALUE_OPTIONAL),
'hiddenbynumsections' => new external_value(PARAM_INT, 'Whether is a section hidden in the course format',
VALUE_OPTIONAL),
'uservisible' => new external_value(PARAM_BOOL, 'Is the section visible for the user?', VALUE_OPTIONAL),
'availabilityinfo' => new external_value(PARAM_RAW, 'Availability information.', VALUE_OPTIONAL),
'modules' => new external_multiple_structure(
new external_single_structure(
array(
'id' => new external_value(PARAM_INT, 'activity id'),
'url' => new external_value(PARAM_URL, 'activity url', VALUE_OPTIONAL),
'name' => new external_value(PARAM_RAW, 'activity module name'),
'instance' => new external_value(PARAM_INT, 'instance id', VALUE_OPTIONAL),
'contextid' => new external_value(PARAM_INT, 'Activity context id.', VALUE_OPTIONAL),
'description' => new external_value(PARAM_RAW, 'activity description', VALUE_OPTIONAL),
'visible' => new external_value(PARAM_INT, 'is the module visible', VALUE_OPTIONAL),
'uservisible' => new external_value(PARAM_BOOL, 'Is the module visible for the user?',
VALUE_OPTIONAL),
'availabilityinfo' => new external_value(PARAM_RAW, 'Availability information.',
VALUE_OPTIONAL),
'visibleoncoursepage' => new external_value(PARAM_INT, 'is the module visible on course page',
VALUE_OPTIONAL),
'modicon' => new external_value(PARAM_URL, 'activity icon url'),
'modname' => new external_value(PARAM_PLUGIN, 'activity module type'),
'modplural' => new external_value(PARAM_TEXT, 'activity module plural name'),
'availability' => new external_value(PARAM_RAW, 'module availability settings', VALUE_OPTIONAL),
'indent' => new external_value(PARAM_INT, 'number of identation in the site'),
'onclick' => new external_value(PARAM_RAW, 'Onclick action.', VALUE_OPTIONAL),
'afterlink' => new external_value(PARAM_RAW, 'After link info to be displayed.',
VALUE_OPTIONAL),
'activitybadge' => self::get_activitybadge_structure(),
'customdata' => new external_value(PARAM_RAW, 'Custom data (JSON encoded).', VALUE_OPTIONAL),
'noviewlink' => new external_value(PARAM_BOOL, 'Whether the module has no view page',
VALUE_OPTIONAL),
'completion' => new external_value(PARAM_INT, 'Type of completion tracking:
0 means none, 1 manual, 2 automatic.', VALUE_OPTIONAL),
'completiondata' => $completiondefinition,
'downloadcontent' => new external_value(PARAM_INT, 'The download content value', VALUE_OPTIONAL),
'dates' => new external_multiple_structure(
new external_single_structure(
array(
'label' => new external_value(PARAM_TEXT, 'date label'),
'timestamp' => new external_value(PARAM_INT, 'date timestamp'),
'relativeto' => new external_value(PARAM_INT, 'relative date timestamp',
VALUE_OPTIONAL),
'dataid' => new external_value(PARAM_NOTAGS, 'cm data id', VALUE_OPTIONAL),
)
),
'Course dates',
VALUE_DEFAULT,
[]
),
'groupmode' => new external_value(PARAM_INT, 'Group mode value', VALUE_OPTIONAL),
'contents' => new external_multiple_structure(
new external_single_structure(
array(
// content info
'type'=> new external_value(PARAM_TEXT, 'a file or a folder or external link'),
'filename'=> new external_value(PARAM_FILE, 'filename'),
'filepath'=> new external_value(PARAM_PATH, 'filepath'),
'filesize'=> new external_value(PARAM_INT, 'filesize'),
'fileurl' => new external_value(PARAM_URL, 'downloadable file url', VALUE_OPTIONAL),
'content' => new external_value(PARAM_RAW, 'Raw content, will be used when type is content', VALUE_OPTIONAL),
'timecreated' => new external_value(PARAM_INT, 'Time created'),
'timemodified' => new external_value(PARAM_INT, 'Time modified'),
'sortorder' => new external_value(PARAM_INT, 'Content sort order'),
'mimetype' => new external_value(PARAM_RAW, 'File mime type.', VALUE_OPTIONAL),
'isexternalfile' => new external_value(PARAM_BOOL, 'Whether is an external file.',
VALUE_OPTIONAL),
'repositorytype' => new external_value(PARAM_PLUGIN, 'The repository type for external files.',
VALUE_OPTIONAL),
// copyright related info
'userid' => new external_value(PARAM_INT, 'User who added this content to moodle'),
'author' => new external_value(PARAM_TEXT, 'Content owner'),
'license' => new external_value(PARAM_TEXT, 'Content license'),
'tags' => new external_multiple_structure(
\core_tag\external\tag_item_exporter::get_read_structure(), 'Tags',
VALUE_OPTIONAL
),
)
), 'Course contents', VALUE_DEFAULT, array()
),
'contentsinfo' => new external_single_structure(
array(
'filescount' => new external_value(PARAM_INT, 'Total number of files.'),
'filessize' => new external_value(PARAM_INT, 'Total files size.'),
'lastmodified' => new external_value(PARAM_INT, 'Last time files were modified.'),
'mimetypes' => new external_multiple_structure(
new external_value(PARAM_RAW, 'File mime type.'),
'Files mime types.'
),
'repositorytype' => new external_value(PARAM_PLUGIN, 'The repository type for
the main file.', VALUE_OPTIONAL),
), 'Contents summary information.', VALUE_OPTIONAL
),
)
), 'list of module'
)
)
)
);
}
/**
* Returns description of activitybadge data.
*
* @return external_description
*/
protected static function get_activitybadge_structure(): external_description {
return new external_single_structure(
[
'badgecontent' => new external_value(
PARAM_TEXT,
'The content to be displayed in the activity badge',
VALUE_OPTIONAL
),
'badgestyle' => new external_value(
PARAM_TEXT,
'The style for the activity badge',
VALUE_OPTIONAL
),
'badgeurl' => new external_value(
PARAM_URL,
'An optional URL to redirect the user when the activity badge is clicked',
VALUE_OPTIONAL
),
'badgeelementid' => new external_value(
PARAM_ALPHANUMEXT,
'An optional id in case the module wants to add some code for the activity badge',
VALUE_OPTIONAL
),
'badgeextraattributes' => new external_multiple_structure(
new external_single_structure(
[
'name' => new external_value(
PARAM_TEXT,
'The attribute name',
VALUE_OPTIONAL
),
'value' => new external_value(
PARAM_TEXT,
'The attribute value',
VALUE_OPTIONAL
),
],
'Each of the attribute names and values',
VALUE_OPTIONAL
),
'An optional array of extra HTML attributes to add to the badge element',
VALUE_OPTIONAL
),
],
'Activity badge to display near the name',
VALUE_OPTIONAL
);
}
/**
* Returns description of method parameters
*
* @return external_function_parameters
* @since Moodle 2.3
*/
public static function get_courses_parameters() {
return new external_function_parameters(
array('options' => new external_single_structure(
array('ids' => new external_multiple_structure(
new external_value(PARAM_INT, 'Course id')
, 'List of course id. If empty return all courses
except front page course.',
VALUE_OPTIONAL)
), 'options - operator OR is used', VALUE_DEFAULT, array())
)
);
}
/**
* Get courses
*
* @param array $options It contains an array (list of ids)
* @return array
* @since Moodle 2.2
*/
public static function get_courses($options = array()) {
global $CFG, $DB;
require_once($CFG->dirroot . "/course/lib.php");
//validate parameter
$params = self::validate_parameters(self::get_courses_parameters(),
array('options' => $options));
//retrieve courses
if (!array_key_exists('ids', $params['options'])
or empty($params['options']['ids'])) {
$courses = $DB->get_records('course');
} else {
$courses = $DB->get_records_list('course', 'id', $params['options']['ids']);
}
//create return value
$coursesinfo = array();
foreach ($courses as $course) {
// now security checks
$context = context_course::instance($course->id, IGNORE_MISSING);
$courseformatoptions = course_get_format($course)->get_format_options();
try {
self::validate_context($context);
} catch (Exception $e) {
$exceptionparam = new stdClass();
$exceptionparam->message = $e->getMessage();
$exceptionparam->courseid = $course->id;
throw new moodle_exception('errorcoursecontextnotvalid', 'webservice', '', $exceptionparam);
}
if ($course->id != SITEID) {
require_capability('moodle/course:view', $context);
}
$courseinfo = array();
$courseinfo['id'] = $course->id;
$courseinfo['fullname'] = \core_external\util::format_string($course->fullname, $context);
$courseinfo['shortname'] = \core_external\util::format_string($course->shortname, $context);
$courseinfo['displayname'] = \core_external\util::format_string(get_course_display_name_for_list($course), $context);
$courseinfo['categoryid'] = $course->category;
list($courseinfo['summary'], $courseinfo['summaryformat']) =
\core_external\util::format_text($course->summary, $course->summaryformat, $context, 'course', 'summary', 0);
$courseinfo['format'] = $course->format;
$courseinfo['startdate'] = $course->startdate;
$courseinfo['enddate'] = $course->enddate;
$courseinfo['showactivitydates'] = $course->showactivitydates;
$courseinfo['showcompletionconditions'] = $course->showcompletionconditions;
if (array_key_exists('numsections', $courseformatoptions)) {
// For backward-compartibility
$courseinfo['numsections'] = $courseformatoptions['numsections'];
}
$courseinfo['pdfexportfont'] = $course->pdfexportfont;
$handler = core_course\customfield\course_handler::create();
if ($customfields = $handler->export_instance_data($course->id)) {
$courseinfo['customfields'] = [];
foreach ($customfields as $data) {
$courseinfo['customfields'][] = [
'type' => $data->get_type(),
'value' => $data->get_value(),
'valueraw' => $data->get_data_controller()->get_value(),
'name' => $data->get_name(),
'shortname' => $data->get_shortname()
];
}
}
//some field should be returned only if the user has update permission
$courseadmin = has_capability('moodle/course:update', $context);
if ($courseadmin) {
$courseinfo['categorysortorder'] = $course->sortorder;
$courseinfo['idnumber'] = $course->idnumber;
$courseinfo['showgrades'] = $course->showgrades;
$courseinfo['showreports'] = $course->showreports;
$courseinfo['newsitems'] = $course->newsitems;
$courseinfo['visible'] = $course->visible;
$courseinfo['maxbytes'] = $course->maxbytes;
if (array_key_exists('hiddensections', $courseformatoptions)) {
// For backward-compartibility
$courseinfo['hiddensections'] = $courseformatoptions['hiddensections'];
}
// Return numsections for backward-compatibility with clients who expect it.
$courseinfo['numsections'] = course_get_format($course)->get_last_section_number();
$courseinfo['groupmode'] = $course->groupmode;
$courseinfo['groupmodeforce'] = $course->groupmodeforce;
$courseinfo['defaultgroupingid'] = $course->defaultgroupingid;
$courseinfo['lang'] = clean_param($course->lang, PARAM_LANG);
$courseinfo['timecreated'] = $course->timecreated;
$courseinfo['timemodified'] = $course->timemodified;
$courseinfo['forcetheme'] = clean_param($course->theme, PARAM_THEME);
$courseinfo['enablecompletion'] = $course->enablecompletion;
$courseinfo['completionnotify'] = $course->completionnotify;
$courseinfo['courseformatoptions'] = array();
foreach ($courseformatoptions as $key => $value) {
$courseinfo['courseformatoptions'][] = array(
'name' => $key,
'value' => $value
);
}
}
if ($courseadmin or $course->visible
or has_capability('moodle/course:viewhiddencourses', $context)) {
$coursesinfo[] = $courseinfo;
}
}
return $coursesinfo;
}
/**
* Returns description of method result value
*
* @return \core_external\external_description
* @since Moodle 2.2
*/
public static function get_courses_returns() {
return new external_multiple_structure(
new external_single_structure(
array(
'id' => new external_value(PARAM_INT, 'course id'),
'shortname' => new external_value(PARAM_RAW, 'course short name'),
'categoryid' => new external_value(PARAM_INT, 'category id'),
'categorysortorder' => new external_value(PARAM_INT,
'sort order into the category', VALUE_OPTIONAL),
'fullname' => new external_value(PARAM_RAW, 'full name'),
'displayname' => new external_value(PARAM_RAW, 'course display name'),
'idnumber' => new external_value(PARAM_RAW, 'id number', VALUE_OPTIONAL),
'summary' => new external_value(PARAM_RAW, 'summary'),
'summaryformat' => new external_format_value('summary'),
'format' => new external_value(PARAM_PLUGIN,
'course format: weeks, topics, social, site,..'),
'showgrades' => new external_value(PARAM_INT,
'1 if grades are shown, otherwise 0', VALUE_OPTIONAL),
'newsitems' => new external_value(PARAM_INT,
'number of recent items appearing on the course page', VALUE_OPTIONAL),
'startdate' => new external_value(PARAM_INT,
'timestamp when the course start'),
'enddate' => new external_value(PARAM_INT,
'timestamp when the course end'),
'numsections' => new external_value(PARAM_INT,
'(deprecated, use courseformatoptions) number of weeks/topics',
VALUE_OPTIONAL),
'maxbytes' => new external_value(PARAM_INT,
'largest size of file that can be uploaded into the course',
VALUE_OPTIONAL),
'showreports' => new external_value(PARAM_INT,
'are activity report shown (yes = 1, no =0)', VALUE_OPTIONAL),
'visible' => new external_value(PARAM_INT,
'1: available to student, 0:not available', VALUE_OPTIONAL),
'hiddensections' => new external_value(PARAM_INT,
'(deprecated, use courseformatoptions) How the hidden sections in the course are displayed to students',
VALUE_OPTIONAL),
'groupmode' => new external_value(PARAM_INT, 'no group, separate, visible',
VALUE_OPTIONAL),
'groupmodeforce' => new external_value(PARAM_INT, '1: yes, 0: no',
VALUE_OPTIONAL),
'defaultgroupingid' => new external_value(PARAM_INT, 'default grouping id',
VALUE_OPTIONAL),
'timecreated' => new external_value(PARAM_INT,
'timestamp when the course have been created', VALUE_OPTIONAL),
'timemodified' => new external_value(PARAM_INT,
'timestamp when the course have been modified', VALUE_OPTIONAL),
'enablecompletion' => new external_value(PARAM_INT,
'Enabled, control via completion and activity settings. Disbaled,
not shown in activity settings.',
VALUE_OPTIONAL),
'completionnotify' => new external_value(PARAM_INT,
'1: yes 0: no', VALUE_OPTIONAL),
'lang' => new external_value(PARAM_SAFEDIR,
'forced course language', VALUE_OPTIONAL),
'forcetheme' => new external_value(PARAM_PLUGIN,
'name of the force theme', VALUE_OPTIONAL),
'courseformatoptions' => new external_multiple_structure(
new external_single_structure(
array('name' => new external_value(PARAM_ALPHANUMEXT, 'course format option name'),
'value' => new external_value(PARAM_RAW, 'course format option value')
)), 'additional options for particular course format', VALUE_OPTIONAL
),
'showactivitydates' => new external_value(PARAM_BOOL, 'Whether the activity dates are shown or not'),
'showcompletionconditions' => new external_value(PARAM_BOOL,
'Whether the activity completion conditions are shown or not'),
'customfields' => new external_multiple_structure(
new external_single_structure(
['name' => new external_value(PARAM_RAW, 'The name of the custom field'),
'shortname' => new external_value(PARAM_ALPHANUMEXT, 'The shortname of the custom field'),
'type' => new external_value(PARAM_COMPONENT,
'The type of the custom field - text, checkbox...'),
'valueraw' => new external_value(PARAM_RAW, 'The raw value of the custom field'),
'value' => new external_value(PARAM_RAW, 'The value of the custom field')]
), 'Custom fields and associated values', VALUE_OPTIONAL),
), 'course'
)
);
}
/**
* Return array of all editable course custom fields indexed by their shortname
*
* @param \context $context
* @param int $courseid
* @return \core_customfield\field_controller[]
*/
public static function get_editable_customfields(\context $context, int $courseid = 0): array {
$result = [];
$handler = \core_course\customfield\course_handler::create();
$handler->set_parent_context($context);
foreach ($handler->get_editable_fields($courseid) as $field) {
$result[$field->get('shortname')] = $field;
}
return $result;
}
/**
* Returns description of method parameters
*
* @return external_function_parameters
* @since Moodle 2.2
*/
public static function create_courses_parameters() {
$courseconfig = get_config('moodlecourse'); //needed for many default values
return new external_function_parameters(
array(
'courses' => new external_multiple_structure(
new external_single_structure(
array(
'fullname' => new external_value(PARAM_TEXT, 'full name'),
'shortname' => new external_value(PARAM_TEXT, 'course short name'),
'categoryid' => new external_value(PARAM_INT, 'category id'),
'idnumber' => new external_value(PARAM_RAW, 'id number', VALUE_OPTIONAL),
'summary' => new external_value(PARAM_RAW, 'summary', VALUE_OPTIONAL),
'summaryformat' => new external_format_value('summary', VALUE_DEFAULT),
'format' => new external_value(PARAM_PLUGIN,
'course format: weeks, topics, social, site,..',
VALUE_DEFAULT, $courseconfig->format),
'showgrades' => new external_value(PARAM_INT,
'1 if grades are shown, otherwise 0', VALUE_DEFAULT,
$courseconfig->showgrades),
'newsitems' => new external_value(PARAM_INT,
'number of recent items appearing on the course page',
VALUE_DEFAULT, $courseconfig->newsitems),
'startdate' => new external_value(PARAM_INT,
'timestamp when the course start', VALUE_OPTIONAL),
'enddate' => new external_value(PARAM_INT,
'timestamp when the course end', VALUE_OPTIONAL),
'numsections' => new external_value(PARAM_INT,
'(deprecated, use courseformatoptions) number of weeks/topics',
VALUE_OPTIONAL),
'maxbytes' => new external_value(PARAM_INT,
'largest size of file that can be uploaded into the course',
VALUE_DEFAULT, $courseconfig->maxbytes),
'showreports' => new external_value(PARAM_INT,
'are activity report shown (yes = 1, no =0)', VALUE_DEFAULT,
$courseconfig->showreports),
'visible' => new external_value(PARAM_INT,
'1: available to student, 0:not available', VALUE_OPTIONAL),
'hiddensections' => new external_value(PARAM_INT,
'(deprecated, use courseformatoptions) How the hidden sections in the course are displayed to students',
VALUE_OPTIONAL),
'groupmode' => new external_value(PARAM_INT, 'no group, separate, visible',
VALUE_DEFAULT, $courseconfig->groupmode),
'groupmodeforce' => new external_value(PARAM_INT, '1: yes, 0: no',
VALUE_DEFAULT, $courseconfig->groupmodeforce),
'defaultgroupingid' => new external_value(PARAM_INT, 'default grouping id',
VALUE_DEFAULT, 0),
'enablecompletion' => new external_value(PARAM_INT,
'Enabled, control via completion and activity settings. Disabled,
not shown in activity settings.',
VALUE_OPTIONAL),
'completionnotify' => new external_value(PARAM_INT,
'1: yes 0: no', VALUE_OPTIONAL),
'lang' => new external_value(PARAM_SAFEDIR,
'forced course language', VALUE_OPTIONAL),
'forcetheme' => new external_value(PARAM_PLUGIN,
'name of the force theme', VALUE_OPTIONAL),
'courseformatoptions' => new external_multiple_structure(
new external_single_structure(
array('name' => new external_value(PARAM_ALPHANUMEXT, 'course format option name'),
'value' => new external_value(PARAM_RAW, 'course format option value')
)),
'additional options for particular course format', VALUE_OPTIONAL),
'customfields' => new external_multiple_structure(
new external_single_structure(
array(
'shortname' => new external_value(PARAM_ALPHANUMEXT, 'The shortname of the custom field'),
'value' => new external_value(PARAM_RAW, 'The value of the custom field'),
)), 'custom fields for the course', VALUE_OPTIONAL
)
)), 'courses to create'
)
)
);
}
/**
* Create courses
*
* @param array $courses
* @return array courses (id and shortname only)
* @since Moodle 2.2
*/
public static function create_courses($courses) {
global $CFG, $DB;
require_once($CFG->dirroot . "/course/lib.php");
require_once($CFG->libdir . '/completionlib.php');
$params = self::validate_parameters(self::create_courses_parameters(),
array('courses' => $courses));
$availablethemes = core_component::get_plugin_list('theme');
$availablelangs = get_string_manager()->get_list_of_translations();
$transaction = $DB->start_delegated_transaction();
foreach ($params['courses'] as $course) {
// Ensure the current user is allowed to run this function
$context = context_coursecat::instance($course['categoryid'], IGNORE_MISSING);
try {
self::validate_context($context);
} catch (Exception $e) {
$exceptionparam = new stdClass();
$exceptionparam->message = $e->getMessage();
$exceptionparam->catid = $course['categoryid'];
throw new moodle_exception('errorcatcontextnotvalid', 'webservice', '', $exceptionparam);
}
require_capability('moodle/course:create', $context);
// Fullname and short name are required to be non-empty.
if (trim($course['fullname']) === '') {
throw new moodle_exception('errorinvalidparam', 'webservice', '', 'fullname');
} else if (trim($course['shortname']) === '') {
throw new moodle_exception('errorinvalidparam', 'webservice', '', 'shortname');
}
// Make sure lang is valid
if (array_key_exists('lang', $course)) {
if (empty($availablelangs[$course['lang']])) {
throw new moodle_exception('errorinvalidparam', 'webservice', '', 'lang');
}
if (!has_capability('moodle/course:setforcedlanguage', $context)) {
unset($course['lang']);
}
}
// Make sure theme is valid
if (array_key_exists('forcetheme', $course)) {
if (!empty($CFG->allowcoursethemes)) {
if (empty($availablethemes[$course['forcetheme']])) {
throw new moodle_exception('errorinvalidparam', 'webservice', '', 'forcetheme');
} else {
$course['theme'] = $course['forcetheme'];
}
}
}
//force visibility if ws user doesn't have the permission to set it
$category = $DB->get_record('course_categories', array('id' => $course['categoryid']));
if (!has_capability('moodle/course:visibility', $context)) {
$course['visible'] = $category->visible;
}
//set default value for completion
$courseconfig = get_config('moodlecourse');
if (completion_info::is_enabled_for_site()) {
if (!array_key_exists('enablecompletion', $course)) {
$course['enablecompletion'] = $courseconfig->enablecompletion;
}
} else {
$course['enablecompletion'] = 0;
}
$course['category'] = $course['categoryid'];