-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathlib.php
1610 lines (1482 loc) · 57.9 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/>.
/**
* GO1 plugin function library
*
* @package mod_goone
* @copyright 2019, eCreators PTY LTD
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @author Fouad Saikali <[email protected]>
*/
defined('MOODLE_INTERNAL') || die();
require_once($CFG->libdir . '/filelib.php');
require_once($CFG->libdir.'/completionlib.php');
require_once($CFG->dirroot.'/course/lib.php');
require_once($CFG->dirroot.'/course/modlib.php');
$config = get_config('mod_goone');
/**
* Given an object containing all the necessary data,
* (defined by the form in mod_form.php) this function
* will create a new instance and return the id number
* of the new instance.
*
* @param object $data
* @param mod_page_mod_form $mform
* @return int
*/
function goone_add_instance($data, $mform = null) {
global $CFG, $DB;
$cmid = $data->coursemodule;
$data->timecreated = time();
if (empty($data->token)) {
$data->token = goone_download_scorm($data->loid);
}
$data->id = $DB->insert_record('goone', $data);
$DB->set_field('course_modules', 'instance', $data->id, array('id' => $cmid));
$context = context_module::instance($cmid);
$DB->update_record('goone', $data);
return $data->id;
}
/**
* Downloads SCORM Zip file from GO1 API and extracts
* token parameter.
* @param object $loid
* @return string
*/
function goone_download_scorm($loid) {
global $CFG;
// Create temporary storage directory since we need to open a zip.
$tempdir = make_temp_directory('goone/');
$filename = $loid.'.zip';
$tempfile = fopen($CFG->tempdir . '/goone/' . $filename, "w+");
// Download GO1 SCORM zip file from external API.
$curl = new curl();
$serverurl = "https://api.GO1.com/v2/learning-objects/".$loid."/scorm";
$header = array ("Authorization: Bearer ".get_config('mod_goone', 'token'));
$curl->setHeader($header);
$curlopts = array(
'file' => $tempfile,
'followlocation' => true
);
$curl->download_one($serverurl, null, $curlopts);
fclose($tempfile);
$token = goone_extract_scorm_token($loid, $tempdir, $filename);
fulldelete($tempdir.$filename);
fulldelete($tempdir.$loid);
if (!$token) {
throw new moodle_exception('lodownloaderror', $loid);
}
return $token;
}
/**
* Add a get_coursemodule_info function in case any goone type wants to add 'extra' information
* for the course (see resource).
*
* Given a course_module object, this function returns any "extra" information that may be needed
* when printing this activity in a course listing. See get_array_of_activities() in course/lib.php.
*
* @param stdClass $coursemodule The coursemodule object (record).
* @return cached_cm_info An object on information that the courses
* will know about (most noticeably, an icon).
*/
function goone_get_coursemodule_info($coursemodule) {
global $DB;
$dbparams = ['id' => $coursemodule->instance];
$fields = 'id, name, intro, introformat, completionsubmit';
if (!$goone = $DB->get_record('goone', $dbparams, $fields)) {
return false;
}
$result = new cached_cm_info();
$result->name = $goone->name;
if ($coursemodule->showdescription) {
// Convert intro to html. Do not filter cached version, filters run at display time.
$result->content = format_module_intro('goone', $goone, $coursemodule->id, false);
}
// Populate the custom completion rules as key => value pairs, but only if the completion mode is 'automatic'.
if ($coursemodule->completion == COMPLETION_TRACKING_AUTOMATIC) {
$result->customdata['customcompletionrules']['completionsubmit'] = $goone->completionsubmit;
}
return $result;
}
/**
* Extracts token parameter from GO1 SCORM Zip.
* @param string $loid
* @param string $tempdir
* @param string $filename
* @param string $filepath
* @return object
*/
function goone_extract_scorm_token($loid, $tempdir, $filename, $filepath = null ) {
global $CFG;
// Open zip and extract 'config.js'.
if (empty($filepath)) {
$filepath = $CFG->tempdir . '/goone/' . $filename;
}
$tempdir = make_temp_directory('goone/');
$packer = get_file_packer('application/zip');
if ($packer->extract_to_pathname($filepath, $tempdir . $loid)) {
$token = file_get_contents($tempdir . $loid . '/config.js');
// Read token from config.js file to be stored in {goone} table.
preg_match('/{([^}]*)}/', $token, $token);
$token = json_decode($token[0])->token;
return $token;
} else {
return false;
}
}
/**
* Given an object containing all the necessary data,
* (defined by the form in mod_form.php) this function
* will update an existing instance with new data.
*
* @param object $data
* @param mod_page_mod_form $mform
* @return bool
*/
function goone_update_instance($data, $mform) {
global $CFG, $DB;
$cmid = $data->coursemodule;
$data->timemodified = time();
$data->id = $data->instance;
$DB->update_record('goone', $data);
$DB->set_field('course_modules', 'instance', $data->instance, array('id' => $cmid));
return true;
}
/**
* Given an ID of an instance of this module,
* this function will permanently delete the instance
* and any data that depends on it.
*
* @param int $id
* @return bool
*/
function goone_delete_instance($id) {
global $DB;
if (!$goone = $DB->get_record('goone', array('id' => $id))) {
return false;
}
$cm = get_coursemodule_from_instance('goone', $id);
$DB->delete_records('goone', array('id' => $goone->id));
return true;
}
/**
* Returns an array of options for how GO1 courses can be presented
* This is used by the participation report.
*
* @return array
*/
function goone_get_popup_display_array() {
return array(0 => get_string('currentwindow', 'scorm'),
1 => get_string('popup', 'scorm'));
}
/**
* Potentially unused function
*
* @param object $obj completion record object
*/
function notify_completion($obj) {
global $DB, $USER;
$goone = $DB->get_record('goone', array('id' => $obj->activityId));
$cm = get_coursemodule_from_id('goone', $obj->courseModuleId, 0, false, MUST_EXIST);
$course = $DB->get_record('course', array('id' => $cm->course), '*', MUST_EXIST);
// Update completion state.
$completion = new completion_info($course);
if ($completion->is_enabled($cm) && $goone->completionsubmit) {
$b = $completion->update_state($cm, COMPLETION_COMPLETE, $USER->id);
}
}
/**
* Return the list if Moodle features this module supports
*
* @param string $feature FEATURE_xx constant for requested feature
* @return mixed True if module supports feature, null if doesn't know
*/
function goone_supports($feature) {
switch($feature) {
case FEATURE_COMPLETION_TRACKS_VIEWS:
return true;
case FEATURE_COMPLETION_HAS_RULES:
return true;
case FEATURE_BACKUP_MOODLE2:
return true;
default:
return null;
}
}
/**
* Obtains the automatic completion state for this goone based on any conditions
* in goone settings.
*
* @param object $course Course
* @param object $cm Course-module
* @param int $userid User ID
* @param bool $type Type of comparison (or/and; can be used as return value if no conditions)
* @return bool True if completed, false if not. (If no conditions, then return
* value depends on comparison type)
*/
function goone_get_completion_state($course, $cm, $userid, $type) {
global $CFG, $DB;
// Get goone details.
if (!($goone = $DB->get_record('goone', array('id' => $cm->instance)))) {
throw new Exception("Can't find goone {$cm->instance}");
}
$params = array('userid' => $userid, 'gooneid' => $goone->id);
$sql = "
SELECT completed
FROM {goone_completion}
WHERE userid=:userid AND gooneid=:gooneid";
$locomplete = $DB->get_field_sql($sql, $params);
if ($goone->completionsubmit) {
if ($locomplete == 2) {
$result = true;
} else {
$result = false;
}
} else {
// Completion option is not enabled so just return $type.
return $type;
}
return $result;
}
/**
* Generates go token and writes result to plugin config
*
*/
function goone_generatetoken() {
global $CFG, $DB;
$oauthid = get_config('mod_goone', 'client_id');
$oauthsecret = get_config('mod_goone', 'client_secret');
$params = array (
'client_id' => $oauthid,
'client_secret' => $oauthsecret,
'grant_type' => 'client_credentials'
);
$curl = new curl();
$serverurl = "https://auth.GO1.com/oauth/token";
$curloutput = @json_decode($curl->post($serverurl, $params), true);
$curlinfo = $curl->get_info();
if ($curlinfo['http_code'] == 200 && isset($curloutput['access_token'])) {
set_config('token', $curloutput['access_token'], 'mod_goone');
return true;
} else {
set_config('token', '', 'mod_goone');
return false;
}
}
/**
* Generates go token and writes result to plugin config
*
* @return bool
*/
function goone_tokentest() {
global $CFG, $DB;
$config = get_config('mod_goone');
if (empty($config->client_id) || empty($config->client_secret)) {
set_config('token', '', 'mod_goone');
return false;
}
$curl = new curl();
$serverurl = "https://auth.GO1.com/oauth/validate";
$header = array ("Authorization: Bearer ".get_config('mod_goone', 'token'));
$curl->setHeader($header);
$curl->get($serverurl);
$httpcode = $curl->get_info()['http_code'];
if ($httpcode == 200) {
return true;
} else {
// Update the token, in case the credentials have changed.
return goone_generatetoken();
}
}
/**
* Removes HTML tags for course descriptions retreived from GO1 API
*
* @param object $data
* @return object
*/
function goone_clean_hits($data) {
$data = preg_replace(
'/\\\\u[0-9A-F]{4}/i', '', str_replace("\u003C", "<", str_replace("\u003E", ">", str_replace("\/", "/", $data)))
);
$data = html_entity_decode($data);
$data = preg_replace('(\s*<[a-z A-Z 0-9]*>\\s*)', '', $data);
$data = preg_replace('(\s*<\/[a-z A-Z 0-9]*>\s*)', ' ', $data);
$data = preg_replace('(\s*<[^>]*>\s*)', '', $data);
return $data;
}
/**
* Outputs session state to SCORM API (using PAGE API) based on saved location and completion data
*
* @param int $gooneid
* @param int $cmid
*/
function goone_session_state($gooneid, $cmid) {
global $CFG, $DB, $PAGE, $USER;
$def = new stdClass;
// 0 = not started, 1 = in progress, 2 = complete.
$completionrecord = $DB->get_record(
'goone_completion', array('gooneid' => $gooneid, 'userid' => $USER->id), $fields = '*', $strictness = IGNORE_MISSING
);
$def->{(3)} = goone_scorm_def(1, '');
$def->{(6)} = goone_scorm_def(1, '');
$cmistate = "normal";
if ($completionrecord && $completionrecord->completed == 1) {
$def->{(3)} = goone_scorm_def(1, '');
$def->{(6)} = goone_scorm_def(2, $completionrecord->location);
$cmistate = "normal";
}
if ($completionrecord && $completionrecord->completed == 2) {
$def->{(3)} = goone_scorm_def(3, '');
$def->{(6)} = goone_scorm_def(4, '');
$cmistate = "review";
}
$cmiobj = new stdClass();
$cmiobj->{3} = '';
$cmiobj->{6} = '';
$cmiint = new stdClass();
$cmiint->{3} = '';
$cmiint->{6} = '';
$cmistring256 = '^[\\u0000-\\uFFFF]{0,64000}$';
$cmistring4096 = $cmistring256;
$sstate = new stdClass();
$sstate->def = $def;
$sstate->cmiobj = $cmiobj;
$sstate->cmiint = $cmiint;
$sstate->cmistring256 = $cmistring256;
$sstate->cmistring4096 = $cmistring4096;
$sstate->cmistate = $cmistate;
return($sstate);
}
/**
* Populates SCORM API definition for function goone_session_state
*
* @param int $state
* @param string $location
*/
function goone_scorm_def($state, $location) {
global $USER;
if (!$location) {
$location = "";
}
if ($state == 1) {
$cmicredit = "credit";
$cmientry = "ab-initio";
$cmimode = "normal";
$cmilocation = "";
$cmistatus = "";
$cmimax = "";
$cmimin = "";
$cmiexit = "";
}
if ($state == 2) {
$cmicredit = "credit";
$cmientry = "resume";
$cmimode = "normal";
$cmilocation = $location;
$cmistatus = "incomplete";
$cmimax = "";
$cmimin = "";
$cmiexit = "suspend";
}
if ($state == 3) {
$cmicredit = "no-credit";
$cmientry = "ab-initio";
$cmimode = "review";
$cmilocation = "";
$cmistatus = "";
$cmimax = "";
$cmimin = "";
$cmiexit = "";
}
if ($state == 4) {
$cmicredit = "no-credit";
$cmientry = "";
$cmimode = "review";
$cmilocation = "";
$cmistatus = "passed";
$cmimax = "100";
$cmimin = "0";
$cmiexit = "";
}
$def = array();
$def['cmi.core.student_id'] = $USER->username;
$def['cmi.core.student_name'] = $USER->firstname.' '.$USER->lastname;
$def['cmi.core.credit'] = $cmicredit;
$def['cmi.core.entry'] = $cmientry;
$def['cmi.core.lesson_mode'] = $cmimode;
$def['cmi.launch_data'] = '';
$def['cmi.student_data.mastery_score'] = '';
$def['cmi.student_data.max_time_allowed'] = '';
$def['cmi.student_data.time_limit_action'] = '';
$def['cmi.core.total_time'] = '00:00:00';
$def['cmi.core.lesson_location'] = $cmilocation;
$def['cmi.core.lesson_status'] = $cmistatus;
$def['cmi.core.score.raw'] = $cmimax;
$def['cmi.core.score.max'] = $cmimax;
$def['cmi.core.score.min'] = $cmimin;
$def['cmi.core.exit'] = $cmiexit;
$def['cmi.suspend_data'] = '';
$def['cmi.comments'] = '';
$def['cmi.student_preference.language'] = '';
$def['cmi.student_preference.audio'] = '0';
$def['cmi.student_preference.speed'] = '0';
$def['cmi.student_preference.text'] = '0';
return $def;
}
/**
* Saves GO1 course completion state if enabled.
*
* @param object $cm
* @param int $userid
* @param string $location
* @param string $type
* @return bool
*/
function goone_set_completion($cm, $userid, $location, $type) {
global $CFG, $DB;
$gcomp = new stdClass();
$gcomp->userid = $userid;
$gcomp->gooneid = $cm->instance;
$gcomp->position = $location;
$gcomp->timemodified = time();
$compstate = $DB->get_record(
'goone_completion', array('gooneid' => $cm->instance, 'userid' => $userid), 'id,completed', $strictness = IGNORE_MISSING
);
if ($type == "completed" || (!empty($compstate) && $compstate->completed == 2 )) {
$gcomp->completed = 2;
$course = new stdClass();
$course->id = $cm->course;
$completion = new completion_info($course);
if ($completion->is_enabled($cm)) {
$completion->update_state($cm, COMPLETION_COMPLETE, $userid);
}
}
if ($type == "inprogress") {
$gcomp->position = $location;
$gcomp->completed = 1;
}
if ($compstate) {
$gcomp->id = $compstate->id;
$DB->update_record('goone_completion', $gcomp);
return true;
} else {
$DB->insert_record('goone_completion', $gcomp);
return true;
}
return false;
}
/**
* gets scorm_12.js file form mod_scorm, modifies the datamodelurl variable, stores in cache and Retrieves it.
* checks against current scorm version if cache needs to be rebuilt
*
* @return object
*/
function goone_inject_datamodel() {
global $CFG;
$cache = cache::make('mod_goone', 'scorm12datamodel');
$scormversion = core_plugin_manager::instance()->get_plugin_info('mod_scorm')->versiondisk;
if ($data = $cache->get($scormversion)) {
return $data;
}
$data = file($CFG->dirroot.'/mod/scorm/datamodels/scorm_12.js');
$data = implode("", str_replace("/mod/scorm/datamodel.php", "/mod/goone/datamodel.php", $data));
$cache->set($scormversion, $data);
$data = $cache->get($scormversion);
return $data;
}
/**
* Retrieves GO1 search results from GO1 API for Content Browser
*
* @param array $type
* @param array $tag
* @param array $language
* @param array $provider
* @param string $keyword
* @param string $sort
* @param int $offset
* @return object
*/
function goone_get_hits($type, $tag, $language, $provider, $keyword, $sort, $offset) {
global $PAGE, $OUTPUT;
if (!goone_tokentest()) {
return false;
}
$data = array (
'keyword' => $keyword,
'type' => implode(',', $type),
'offset' => $offset,
'sort' => $sort,
'providers' => implode(',', $provider)
);
$config = get_config('mod_goone');
$data['limit'] = 20;
// Modifying request based on filter configuration.
if ($config->filtersel == 1) {
$data['subscribed'] = "true";
}
if ($config->filtersel == 2) {
$data['collection'] = "default";
$data['subscribed'] = "";
}
if ($config->filtersel == 0) {
$data['subscribed'] = "";
$data['collection'] = "";
}
$params = "";
foreach ($data as $key => $value) {
// Workaround for Moodle < 3.1.
if ($value == 'null') {
$value = '';
}
if (!$value == '') {
$params .= $key.'='.$value.'&';
}
}
$params = trim($params, '&');
// Iterating each language/tag item due to current API limitations.
foreach ($language as $lang) {
// Workaround for Moodle < 3.1.
if ($lang == 'null') {
unset($lang);
}
if (isset($lang) && $lang != '') {
$params .= "&language%5B%5D=".$lang;
}
}
foreach ($tag as $ta) {
// Workaround for Moodle < 3.1.
if ($ta == 'null') {
unset($ta);
}
if (isset($ta) && $ta != '') {
$params .= "&tags%5B%5D=".$ta;
}
}
$curl = new curl();
// Appendeding to URL due to API limitations.
$serverurl = "https://api.GO1.com/v2/learning-objects?facets=instance,tag,language&marketplace=all&".$params;
$header = array ("Authorization: Bearer ".get_config('mod_goone', 'token'));
$curl->setHeader($header);
$response = @json_decode($curl->get($serverurl), true);
if ($curl->get_info()['http_code'] != 200) {
throw new moodle_exception('go1apierror');
}
foreach ($response['hits'] as &$obj) {
$obj['description'] = goone_clean_hits($obj['description']);
$obj['pricing']['price'] = '$'.$obj['pricing']['price'];
// Set the "Included" or "Free" flag on each result.
if (!empty($obj['subscription']) and ($obj['subscription']['licenses'] === -1 or $obj['subscription']['licenses'] > 0)) {
$obj['pricing']['price'] = get_string('included', 'goone');
}
if ($obj['pricing']['price'] === "$0") {
$obj['pricing']['price'] = get_string('free', 'goone');
}
if ($obj['image'] == '') {
$obj['image'] = "/mod/goone/pix/placeholder.png";
}
}
$context = context_system::instance();
$PAGE->set_context($context);
return $OUTPUT->render_from_template('mod_goone/hits', $response);
}
/**
* Retrieves GO1 search facets from GO1 API for Content Browser
*
* @return object
*/
function goone_get_facets() {
global $USER;
if (!goone_tokentest()) {
return;
}
$curl = new curl();
$serverurl = "https://api.GO1.com/v2/learning-objects";
$header = array ("Authorization: Bearer ".get_config('mod_goone', 'token'));
$curl->setHeader($header);
$params = array ('facets' => 'instance,tag,language,topics',
'limit' => 0);
$facets = @json_decode($curl->get($serverurl, $params), true);
foreach ($facets['facets']['language']['buckets'] as &$obj) {
$obj['name'] = goone_get_lang($obj['key']);
// Compare 2 letter language string and set as default selection in fitler.
if ($obj['key'] == substr($USER->lang, 0, 2)) {
$obj['selected'] = "selected";
}
}
return $facets;
}
/**
* Converts ISO language code to full language name for GO1 Content Browser
*
* @param string $lang
* @return string
*/
function goone_get_lang($lang = null) {
$languages = get_string_manager()->get_list_of_languages();
if (array_key_exists($lang, $languages)) {
return $languages[$lang];
}
if (strpos($lang, '-') > 0) {
list($langcode, $countrycode) = explode('-', $lang, 2);
if (array_key_exists($langcode, $languages)) {
$string = $languages[$langcode]; $countrycode = clean_param(strtoupper($countrycode), PARAM_STRINGID);
if (get_string_manager()->string_exists($countrycode, 'core_countries')) {
return $string . " (" . get_string($countrycode, 'core_countries') . ")";
}
}
}
if (empty($lang)) {
return get_string('unknownlanguage', 'mod_goone');
}
return $lang;
}
/**
* Retreives detailed GO1 course information for modal popup in GO1 Content Browser
*
* @param int $loid
* @return object
*/
function goone_modal_overview($loid) {
global $PAGE, $OUTPUT;
if (!goone_tokentest()) {
return;
}
$curl = new curl();
$serverurl = "https://api.go1.com/v2/learning-objects/".$loid;
$header = array ("Authorization: Bearer ".get_config('mod_goone', 'token'));
$curl->setHeader($header);
$lodata = @json_decode($curl->get($serverurl), true);
// Data cleanup and prettification.
$lodata['has_items'] = !empty($lodata['items']);
if (!empty($lodata['delivery'])) {
foreach ($lodata['delivery'] as &$obj) {
$obj = goone_convert_hours_mins($obj);
}
}
if ($lodata['image'] == " ") {
unset($lodata['image']);
}
return json_encode($lodata);
}
/**
* Converts timecode to human readable time for GO1 course durations from GO1 API results
*
* @param int $time
* @param string $format
* @return string
*/
function goone_convert_hours_mins($time, $format = '%02d:%02d') {
if ($time < 1) {
return;
}
$hours = floor(floatval($time) / 60);
$minutes = (floatval($time) % 60);
return sprintf($format, $hours, $minutes);
}
/**
* Capability check for adding or updating a goone activity
*
* @param string $mode
* @param int $id
*/
function goone_check_capabilities($mode, $id) {
global $DB;
switch ($mode) {
case 'add':
// Check if course context capability allowed.
$course = $DB->get_record('course', array('id' => $id), '*', MUST_EXIST);
$context = context_course::instance($course->id);
require_capability('mod/goone:addinstance', $context);
return true;
case 'update':
// Check if module context capability allowed.
$goone = $DB->get_record('goone', array('id' => $id), '*', MUST_EXIST);
$cm = get_coursemodule_from_instance("goone", $goone->id, $goone->course);
$context = context_module::instance($cm->id);
require_capability('mod/goone:addinstance', $context);
return true;
default:
throw new moodle_exception('invalidparam');
}
}
/**
* Construct GO1 signup url
*
*/
function goone_signup_url() {
global $CFG;
$partnerurl = "";
$partnerid = get_config('mod_goone', 'partnerid');
if (!empty($partnerid)) {
$partnerurl = "&partner_portal_id=".$partnerid;
}
$url = 'https://auth.GO1.com/oauth/authorize?client_id=Moodle&response_type=code&redirect=false&redirect_uri='
.$CFG->wwwroot.'&new_client=Moodle'.$partnerurl;
return $url;
}
// Bulk actions browser methods
/**
* Return the max and min used based on selected duration option
*
* @param int $selectedduration selected duration
* @return array with min max minutes
*/
function bulk_mod_goone_duration_get_min_max($selectedduration) {
/*
1 0 - 15 min
2 15 - 30 min
3 30 - 60 min
4 60 min
*/
$la_minmax = array();
switch ($selectedduration) {
case '1':
$la_minmax = array('min'=>0,'max'=>15);
break;
case '2':
$la_minmax = array('min'=>15,'max'=>30);
break;
case '3':
$la_minmax = array('min'=>30,'max'=>60);
break;
case '4':
$la_minmax = array('min'=>60);
break;
}
return $la_minmax;
}
/**
* Retrieves GO1 search results from GO1 API for Content Browser
*
* @param array $type
* @param array $topic
* @param array $language
* @param array $provider
* @param string $keyword
* @param string $sort
* @param int $offset
* @return object
*/
function bulk_mod_goone_get_hits($type, $topic, $language, $provider, $keyword, $sort, $offset, $loadmore, $duration) {
global $PAGE, $OUTPUT;
if (!goone_tokentest()) {
return false;
}
$data = array (
'keyword' => $keyword,
'type' => implode(',', $type),
'offset' => $offset,
'sort' => $sort,
'providers' => implode(',', $provider)
);
$config = get_config('mod_goone');
$data['limit'] = 20;
// Modifying request based on filter configuration.
if ($config->filtersel == 1) {
$data['subscribed'] = "true";
}
if ($config->filtersel == 2) {
$data['collection'] = "default";
$data['subscribed'] = "";
}
if ($config->filtersel == 0) {
$data['subscribed'] = "";
$data['collection'] = "";
}
$params = "";
foreach ($data as $key => $value) {
// Workaround for Moodle < 3.1.
if ($value == 'null') {
$value = '';
}
if (!$value == '') {
$params .= $key.'='.$value.'&';
}
}
$params = trim($params, '&');
// Iterating each language/tag item due to current API limitations.
foreach ($language as $lang) {
// Workaround for Moodle < 3.1.
if ($lang == 'null') {
unset($lang);
}
if (isset($lang) && $lang != '') {
$params .= "&language%5B%5D=".$lang;
}
}
foreach ($topic as $ta) {
// Workaround for Moodle < 3.1.
if ($ta == 'null') {
unset($ta);
}
if (isset($ta) && $ta != '') {
$params .= "&topics%5B%5D=".$ta;
}
}
$durationquery = "";
$countdurations = 0;
if (!empty($duration)) {
foreach ($duration as $option) {
$minmax = bulk_mod_goone_duration_get_min_max($option);
if (isset($minmax['min']) && $minmax['max'] ) {
$durationquery .= "duration%5B".$countdurations."%5D%5Bmin%5D=".$minmax['min']."&duration%5B".$countdurations."%5D%5Bmax%5D=".$minmax["max"]."&";
} else if (isset($minmax['min']) && !isset($minmax['max'])) {
$durationquery .= "duration%5B".$countdurations."%5D%5Bmin%5D=".$minmax['min']."&";
} else if (isset($minmax['max']) && !isset($minmax['min'])) {
$durationquery .= "duration%5B".$countdurations."%5D%max%5D=".$minmax['max']."&";
}
$countdurations++;
}
}
if (!empty($durationquery)) {
$durationquery = rtrim($durationquery, '&');
$params.="&".$durationquery;
}
$response = bulk_mod_goone_api_custom_api_request("learning-objects?facets=instance,tag,language,topics&marketplace=all&".$params);
foreach ($response['hits'] as &$obj) {
$obj['description'] = goone_clean_hits($obj['description']);
$obj['title'] = str_replace('"', '', $obj['title']);
$obj['title'] = str_replace("'", '', $obj['title']);
$obj['title'] = goone_clean_hits($obj['title']);
$obj['provider']['name'] = goone_clean_hits($obj['provider']['name']);
$obj['pricing']['price'] = '$'.$obj['pricing']['price'];
// Set the "Included" or "Free" flag on each result.
if (!empty($obj['subscription']) and ($obj['subscription']['licenses'] === -1 or $obj['subscription']['licenses'] > 0)) {
$obj['pricing']['price'] = get_string('included', 'mod_goone');
}
if ($obj['pricing']['price'] === "$0") {
$obj['pricing']['price'] = get_string('free', 'mod_goone');
}
if ($obj['image'] == '') {
$obj['image'] = "/mod/goone/pix/placeholder.png";
}
$obj['language'] = goone_get_lang($obj['language']);
}
$response['loadmore'] = $loadmore;
$context = context_system::instance();
$PAGE->set_context($context);
return $OUTPUT->render_from_template('mod_goone/hits_bulk', $response);
}
/**
* Retreives detailed GO1 course information for modal popup in GO1 Content Browser
*
* @param int $loid
* @return object
*/
function bulk_mod_goone_modal_overview($loid) {
global $PAGE, $OUTPUT;
if (!goone_tokentest()) {
return;
}
$lodata = bulk_mod_goone_get_learnig_objective_info($loid);
// Data cleanup and prettification.
$lodata['has_items'] = !empty($lodata['items']);
if (!empty($lodata['delivery'])) {
foreach ($lodata['delivery'] as &$obj) {
$obj = goone_convert_hours_mins($obj);
}
}
if ($lodata['image'] == " ") {
unset($lodata['image']);
}
return json_encode($lodata);
}
/**
* Will return object of found courses
*
* @param string $stringtosearch
* @return array $result courses found
*/
function bulk_mod_goone_modal_search_course_result($stringtosearch = '') {
global $DB;
$result = array();
if (!empty($stringtosearch)) {
$sql = "SELECT
id, fullname, shortname, idnumber
FROM
{course}
WHERE
id > 1