-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy pathlocallib.php
982 lines (828 loc) · 43.5 KB
/
locallib.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
<?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/>.
/**
* Private echolink module utility functions
*
* @package mod
* @subpackage echolink
* @copyright (c) 2013, Echo360 Inc. www.echo360.com
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die;
require_once("$CFG->libdir/filelib.php");
require_once("$CFG->libdir/resourcelib.php");
require_once("$CFG->dirroot/mod/echolink/lib.php");
require_once("$CFG->dirroot/mod/echolink/library/ess-rest-lib.php");
require_once("$CFG->dirroot/mod/echolink/library/ess-seamless-lib.php");
$config = get_config('echolink');
define('ESS_API_PATH', "ess/scheduleapi/v1/");
define('ESS_URL', $config->ESS_URL . ESS_API_PATH);
define('ESS_CONSUMER_KEY', $config->ESS_Consumer_Key);
define('ESS_CONSUMER_SECRET', $config->ESS_Consumer_Secret);
//-------------------------------------------------------------
function echolink_ess_get_rest_courses($moodleCourse = null, $defaultFilter = null) {
// Retrieve ESS Course XML
$courseXML = callRestService(ESS_URL, ESS_CONSUMER_KEY, ESS_CONSUMER_SECRET, "courses", "", "GET", array());
if($courseXML != null || $courseXML != '') {
$courseJSON = convertXMLtoJSON($courseXML, true, true);
$courseFilterHTML = "<div id='headerDiv'>" .
"<div id='headerData'><h3 style='text-align:left;'>Echo360 Courses | Sections | Presentations</h3></div>" .
"<div style='float: right;'>Show By: <select name='SHOW_BY_FILTER' id='show_by_filter'><option value='show_all_ess_courses'>All Available Echo360 Courses</option><option value='show_my_ess_courses'>My Echo360 Courses</option></select></div>" .
"</div>";
if($courseJSON['total-results'] == 0) {
return "<div id='echoLinkFormDiv'>" .
$courseFilterHTML .
"<div id='courseDiv'>" .
"<div id='coursesData' style='margin-left: 20px; padding-bottom: 10px;'>" .
"<div class='courseRecord'>No EchoSystem Courses are currently available.</div>" .
"</div>" .
"</div>" .
"</div>";
} else if($courseJSON['total-results'] == 1) {
$id = $courseJSON['course']['id'];
$name = $courseJSON['course']['name'] . " (" . $courseJSON['course']['identifier'] . ")";
return "<div id='echoLinkFormDiv'>" .
$courseFilterHTML .
"<div id='courseDiv'>" .
"<div id='coursesData' style='margin-left: 20px; padding-bottom: 10px;'>" .
"<div class='courseRecord' id='$id'>" .
"<a href='#' class='ess_course_link' id='$id' target='_parent'><label id='$id' style='font-weight: bold;'> + </label>$name</a>" .
"<div class='sectionDiv' id='$id'></div>" .
"</div>" .
"</div>" .
"</div>" .
"</div>";
} else {
$courseData = array();
foreach($courseJSON['course'] as $course) {
$courseData[$course['id']] = $course['name'] . " (" . $course['identifier'] . ")";
}
asort($courseData);
$courseHTML = "<div id='echoLinkFormDiv'>" .
$courseFilterHTML .
"<div id='courseDiv'>" .
"<div id='coursesData' style='margin-left: 20px; padding-bottom: 10px;'>";
foreach($courseData as $id => $name) {
$courseHTML .= "<div class='courseRecord' id='$id'>" .
"<a href='#' class='ess_course_link' id='$id' target='_parent'><label id='$id' style='font-weight: bold;'> + </label> $name</a>" .
"<div class='sectionDiv' id='$id'></div>" .
"</div>";
}
$courseHTML .= "</div>" .
"</div>" .
"</div>";
return $courseHTML;
}
} else {
return "<div style='text-align: center;padding:10px;color:red;font-weight:bold;'>Communication error with the configured EchoSystem Server.<br />Please contact your EchoSystem Administrators for assistance.</div>";
}
}// end of echolink_ess_get_rest_courses function
function echolink_ess_get_rest_person_courses($moodlePerson, $moodleCourse = null, $defaultFilter = null) {
if($moodlePerson != null && $moodlePerson != '') {
// Retrieve ESS Person XML by searching by their Moodle UserID (should be an Institution Staff-ID value and is used for the ESS Username).
$personXML = callRestService(ESS_URL, ESS_CONSUMER_KEY, ESS_CONSUMER_SECRET, "people?filter=$moodlePerson", "", "GET", array());
if($personXML != null && $personXML != '') {
$personJSON = convertXMLtoJSON($personXML, true, true);
if($personJSON['total-results'] == 0) { // If Person record(s) are not found, return warning message no ESS User found for current Moodle User
if($defaultFilter == '0') {
$courseFilterHTML = "<div id='headerDiv'>" .
"<div id='headerData'><h3 style='text-align:left;'>Echo360 Courses | Sections | Presentations</h3></div>" .
"<div style='float: right;'>Show By: <select name='SHOW_BY_FILTER' id='show_by_filter'><option value='show_all_ess_courses'>All Available Echo360 Courses</option><option value='show_my_ess_courses'>My Echo360 Courses</option></select></div>" .
"</div>";
return "<div id='echoLinkFormDiv'>" .
$courseFilterHTML .
"<div id='courseDiv'>" .
"<div id='coursesData' style='margin-left: 20px; padding-bottom: 10px;'><div class='courseRecord'>No EchoSystem Courses are currently available for current Moodle User '$moodlePerson'.</div></div>" .
"</div>" .
"</div>";
} else {
return "<div style='text-align: center;padding:10px;color:red;font-weight:bold;'>Moodle User '$moodlePerson' is not found in the configured EchoSystem Server.<br />Please contact your EchoSystem Administrators for assistance.</div>";
}
} else if($personJSON['total-results'] >= 1) { // Else Person record(s) are found
$personUUID = "";
if($personJSON['total-results'] == 1) {
$personUUID = $personJSON['person']['id'];
} else {
foreach($personJSON['person'] as $person) {
if($person['user-name'] == "$moodlePerson") {
$personUUID = $person['id'];
break;
}
}
}
if($personUUID == "") {
if($defaultFilter == '0') {
$courseFilterHTML = "<div id='headerDiv'>" .
"<div id='headerData'><h3 style='text-align:left;'>Echo360 Courses | Sections | Presentations</h3></div>" .
"<div style='float: right;'>Show By: <select name='SHOW_BY_FILTER' id='show_by_filter'><option value='show_all_ess_courses'>All Available Echo360 Courses</option><option value='show_my_ess_courses'>My Echo360 Courses</option></select></div>" .
"</div>";
return "<div id='echoLinkFormDiv'>" .
$courseFilterHTML .
"<div id='courseDiv'>" .
"<div id='coursesData' style='margin-left: 20px; padding-bottom: 10px;'><div class='courseRecord'>No EchoSystem Courses are currently available for current Moodle User '$moodlePerson'.</div></div>" .
"</div>" .
"</div>";
} else {
return "<div style='text-align: center;padding:10px;color:red;font-weight:bold;'>Moodle User '$moodlePerson' was not found in the configured EchoSystem Server.<br />Please contact your EchoSystem Administrators for assistance. ?</div>";
}
} else {
$sectionRoleXML = callRestService(ESS_URL, ESS_CONSUMER_KEY, ESS_CONSUMER_SECRET, "presenters/$personUUID/sections", "", "GET", array());
$sectionRoleJSON = convertXMLtoJSON($sectionRoleXML, true, true);
$courseFilterHTML = "";
if($defaultFilter == '0') {
$courseFilterHTML = "<div id='headerDiv'>" .
"<div id='headerData'><h3 style='text-align:left;'>Echo360 Courses | Sections | Presentations</h3></div>" .
"<div style='float: right;'>Show By: <select name='SHOW_BY_FILTER' id='show_by_filter'><option value='show_all_ess_courses'>All Available Echo360 Courses</option><option value='show_my_ess_courses' selected>My Echo360 Courses</option></select></div>" .
"</div>";
}
if($sectionRoleJSON['total-results'] == 0) {
return "<div id='echoLinkFormDiv'>" .
$courseFilterHTML .
"<div id='courseDiv'>" .
"<div id='coursesData' style='margin-left: 20px; padding-bottom: 10px;'><div class='courseRecord'>No EchoSystem Courses are currently available for current Moodle User '$moodlePerson'.</div></div>" .
"</div>" .
"</div>";
} else if($sectionRoleJSON['total-results'] == 1) {
if($sectionRoleJSON['section-role']['course-id'] == "") {
return "<div style='text-align: center;padding:10px;color:red;font-weight:bold;'>Unable to retrieve EchoSystem Courses for current Moodle User '$moodlePerson' due to EchoSystem API limitations.<br />Please upgrade to EchoSystem 5.3 or higher.</div>";
} else {
$id = $sectionRoleJSON['section-role']['course-id'];
$name = $sectionRoleJSON['section-role']['course-name'] . " (" . $sectionRoleJSON['section-role']['course-identifier'] . ")";
return "<div id='echoLinkFormDiv'>" .
$courseFilterHTML .
"<div id='courseDiv'>" .
"<div id='coursesData' style='margin-left: 20px; padding-bottom: 10px;'>" .
"<div class='courseRecord' id='$id'>" .
"<a href='#' class='ess_course_link' id='$id' target='_parent'><label id='$id' style='font-weight: bold;'> + </label>$name</a>" .
"<div class='sectionDiv' id='$id'></div>" .
"</div>" .
"</div>" .
"</div>" .
"</div>";
}
} else {
$sectionRoleData = array();
foreach($sectionRoleJSON['section-role'] as $sectionRole) {
$sectionRoleData[$sectionRole['course-id']] = $sectionRole['course-name'] . " (" . $sectionRole['course-identifier'] . ")";
}
asort($sectionRoleData);
$courseHTML = "<div id='echoLinkFormDiv'>" .
$courseFilterHTML .
"<div id='courseDiv'>" .
"<div id='coursesData' style='margin-left: 20px; padding-bottom: 10px;'>";
foreach($sectionRoleData as $id => $name) {
$courseHTML .= "<div class='courseRecord' id='$id'>" .
"<a href='#' class='ess_course_link' id='$id' target='_parent'><label id='$id' style='font-weight: bold;'> + </label>$name</a>" .
"<div class='sectionDiv' id='$id'></div>" .
"</div>";
}
$courseHTML .= "</div>" .
"</div>" .
"</div>";
return $courseHTML;
}
}
}
} else {
return "<div style='text-align: center;padding:10px;color:red;font-weight:bold;'>Communication error with the configured EchoSystem Server.<br />Please contact your EchoSystem Administrators for assistance.</div>";
}
}
}// end of echolink_ess_get_rest_person_courses function
function echolink_ess_get_rest_course_sections($essCourse) {
// Retrieve ESS Section XML
$sectionXML = callRestService(ESS_URL, ESS_CONSUMER_KEY, ESS_CONSUMER_SECRET, "courses/$essCourse/sections", "", "GET", array());
if($sectionXML != null || $sectionXML != '') {
$sectionJSON = convertXMLtoJSON($sectionXML, true, true);
if($sectionJSON['total-results'] == 0) {
return "<div id='sectionData' style='margin-left: 20px; padding-bottom:10px;'><div class='sectionRecord'>No EchoSystem Sections are currently available for this Course.</div></div>";
} else if($sectionJSON['total-results'] == 1) {
$id = $sectionJSON['section']['id'];
$name = $sectionJSON['section']['name'];
return "<div id='sectionData' style='margin-left: 20px; padding-bottom:10px;'>" .
"<div class='sectionRecord' id='$id'>" .
"<a href='#' class='ess_section_link' id='$id' target='_parent'><label id='$id' style='font-weight: bold'> + </label> $name</a>" .
"<div class='presentationDiv' id='$id'></div>" .
"</div>" .
"</div>";
} else {
$sectionData = array();
foreach($sectionJSON['section'] as $section) {
$sectionData[$section['id']] = $section['name'];
}
asort($sectionData);
$courseSectionHTML = "<div id='sectionData' style='margin-left: 20px; padding-bottom:10px;'>";
foreach($sectionData as $id => $name) {
$courseSectionHTML .= "<div class='sectionRecord' id='$id'>" .
"<a href='#' class='ess_section_link' id='$id' target='_parent'><label id='$id' style='font-weight: bold'> + </label> $name</a>" .
"<div class='presentationDiv' id='$id'></div>" .
"</div>";
}
$courseSectionHTML .= "</div>";
return $courseSectionHTML;
}
}
}// end of echolink_ess_get_rest_course_sections function
function echolink_ess_get_rest_section($essSection) {
// Retrieve ESS Section XML
$sectionXML = callRestService(ESS_URL, ESS_CONSUMER_KEY, ESS_CONSUMER_SECRET, "sections/$essSection", "", "GET", array());
if($sectionXML != null || $sectionXML != '') {
$sectionJSON = convertXMLtoJSON($sectionXML, true, true);
$ecpLink = "";
foreach($sectionJSON['link'] as $link) {
if($link['@attributes']['title'] == "course-portal") {
$ecpLink = $link['@attributes']['href'];
break;
}
}
return "<div id='ecpLinkData' style='margin-left: 20px; padding-top: 5px;'>" .
"<div class='sectionRecordECPLink' id=''>• <i><a href='#' class='ess_presentation_link' id='$ecpLink'>EchoCenter Page Link</a></i></div>" .
"</div>";
} else {
return "<div style='text-align: center;padding:10px;color:red;font-weight:bold;'>Communication error with the configured EchoSystem Server.<br />Please contact your EchoSystem Administrators for assistance.</div>";
}
}// end of echolink_ess_get_rest_section function
function echolink_ess_get_rest_section_presentations($essSection) {
// Retrieve ESS Section Presentation XML
$sectionPresentationXML = callRestService(ESS_URL, ESS_CONSUMER_KEY, ESS_CONSUMER_SECRET, "sections/$essSection/presentations", "", "GET", array());
if($sectionPresentationXML != null || $sectionPresentationXML != '') {
$sectionPresentationJSON = convertXMLtoJSON($sectionPresentationXML, true, true);
if($sectionPresentationJSON['total-results'] == 0) {
return "<div id='presentationLinkData' style='margin-left: 40px; padding-bottom: 5px;'><div class='presentationRecord'>• No Echo360 Presentations are currently available.</div></div>";
} else if($sectionPresentationJSON['total-results'] == 1) {
if($sectionPresentationJSON['presentation']['status'] == "presentation-status-available") {
$id = $sectionPresentationJSON['presentation']['id'];
$time = date("Y-m-d H:i", strtotime($sectionPresentationJSON['presentation']['start-time']));
$title = $sectionPresentationJSON['presentation']['title'];
return "<div id='presentationLinkData' style='margin-left: 40px; padding-bottom: 5px;'>" .
"<div class='presentationRecord'>• <span style='color: gray;'>$time</span> - <i><a href='#' class='ess_presentation_link' id='$id'>$title</a></i>";
"</div>";
} else {
return "<div id='presentationLinkData' style='margin-left: 40px; padding-bottom: 5px;'><div class='presentationRecord'>• No Echo360 Presentations are currently available.</div></div>";
}
} else {
$presentationData = array();
foreach($sectionPresentationJSON['presentation'] as $presentation) {
if($presentation['status'] == "presentation-status-available") {
$presentationData[$presentation['id']] = date("Y-m-d H:i", strtotime($presentation['start-time'])) . " ||--|| " . $presentation['title'];
}
}
asort($presentationData);
$presentationHTML = "<div id='presentationLinkData' style='margin-left: 40px; padding-bottom: 5px;'>";
foreach($presentationData as $id => $title) {
$_title = explode(" ||--|| ", $title);
$presentationHTML .= "<div class='presentationRecord'>• <span style='color: gray;'>" . $_title[0] . "</span> - <i><a href='#' class='ess_presentation_link' id='$id'>" . $_title[1] . "</a></i>";
}
$presentationHTML .= "</div>";
return $presentationHTML;
}
} else {
// Do nothing - error message would have already been displayed
}
}// end of echolink_ess_get_rest_section_presentations function
function echolink_ess_get_rest_presentation($essPresentation) {
// Retrieve ESS Section XML
$presentationXML = callRestService(ESS_URL, ESS_CONSUMER_KEY, ESS_CONSUMER_SECRET, "presentations/$essPresentation", "", "GET", array());
return convertXMLtoJSON($presentationXML, true, false);
}// end of echolink_ess_get_rest_presentation function
//-------------------------------------------------------------
//-------------------------------------------------------------
function convertXMLtoJSON($xml, $encode, $decode) {
$xml = str_replace('<?xml version="1.0"?>', '', $xml);
$xml = str_replace(array("\n", "\r", "\t"), '', $xml);
$xml = trim(str_replace('"', "'", $xml));
if($encode == false && $decode == false) {
return simplexml_load_string($xml);
} else if($encode == true && $decode == false) {
return json_encode(simplexml_load_string($xml));
} else if($encode == true && $decode == true) {
return json_decode(json_encode(simplexml_load_string($xml)), true);
}
}// end of convertXMLtoJSON function
//-------------------------------------------------------------
//-------------------------------------------------------------
function echolink_ess_oauth_seamless_login($echolink) {
global $USER;
$config = get_config('echolink');
$essURL = $config->ESS_URL;
$essConsumerKey = $config->ESS_Consumer_Key;
$essConsumerSecret = $config->ESS_Consumer_Secret;
$realm = "";
$isInstructor = true;
$essSSOLogin = new EchoSystemSeamlessLogin($essURL, $essConsumerKey, $essConsumerSecret, $realm);
$ssoResponse = $essSSOLogin->generate_sso_url($echolink, $USER, $isInstructor, true);
if($ssoResponse['success'] == true) {
// we want to test for a 404
$curl = $essSSOLogin->get_curl_with_defaults();
$headers = $essSSOLogin->get_headers($curl, $ssoResponse['url'], 1);
if (!strstr($headers[0]['http'], "302")) {
$error_message = 'unexpected_response';
$e = explode(" ", $headers[0]['http'], 3);
$error_detail = $e[2];
} else if (strstr($headers[1]['http'], "404")) {
$error_message = 'not_found_response';
$e = explode(" ", $headers[1]['http'], 3);
$error_detail = $e[2];
} else if (strstr($headers[1]['http'], "403")) {
$error_message = 'forbidden_response';
$e = explode(" ", $headers[1]['http'], 3);
$error_detail = $e[2];
} else if (!strstr($headers[1]['http'], "200")) {
$error_message = 'unexpected_response';
$e = explode(" ", $headers[1]['http'], 3);
$error_detail = $e[2];
}
curl_close($curl);
if ($error_message == "") {
// All good - but we already used the request - need to sign again (generate a new nonce)
$ssoResponse = $essSSOLogin->generate_sso_url($echolink, $USER, $isInstructor, true);
header("Location:" . $ssoResponse['url']);
} else {
print_error($error_message, 'mod_echolink', '', $error_detail);
}
}
return;
}// end of echolink_ess_oauth_seamless_login function
//-------------------------------------------------------------
//-------------------------------------------------------------
/**
* This methods does weak echolink validation, we are looking for major problems only,
* no strict RFE validation.
*
* @param $echolink
* @return bool true is seems valid, false if definitely not valid URL
*/
function echolink_appears_valid_echolink($echolink) {
if (preg_match('/^(\/|https?:|ftp:)/i', $echolink)) {
// note: this is not exact validation, we look for severely malformed URLs only
return (bool)preg_match('/^[a-z]+:\/\/([^:@\s]+:[^@\s]+@)?[a-z0-9_\.\-]+(:[0-9]+)?(\/[^#]*)?(#.*)?$/i', $echolink);
} else {
return (bool)preg_match('/^[a-z]+:\/\/...*$/i', $echolink);
}
}
/**
* Fix common URL problems that we want teachers to see fixed
* the next time they edit the resource.
*
* This function does not include any XSS protection.
*
* @param string $echolink
* @return string
*/
function echolink_fix_submitted_echolink($echolink) {
// note: empty echolinks are prevented in form validation
$echolink = trim($echolink);
// remove encoded entities - we want the raw URI here
$echolink = html_entity_decode($echolink, ENT_QUOTES, 'UTF-8');
if (!preg_match('|^[a-z]+:|i', $echolink) and !preg_match('|^/|', $echolink)) {
// invalid URI, try to fix it by making it normal URL,
// please note relative echolinks are not allowed, /xx/yy links are ok
$echolink = 'http://'.$echolink;
}
return $echolink;
}
/**
* Return full echolink with all extra parameters
*
* This function does not include any XSS protection.
*
* @param string $echolink
* @param object $cm
* @param object $course
* @param object $config
* @return string echolink with & encoded as &
*/
function echolink_get_full_echolink($echolink, $cm, $course, $config=null) {
$parameters = empty($echolink->parameters) ? array() : unserialize($echolink->parameters);
// make sure there are no encoded entities, it is ok to do this twice
$fullecholink = html_entity_decode($echolink->externalecholink, ENT_QUOTES, 'UTF-8');
if (preg_match('/^(\/|https?:|ftp:)/i', $fullecholink) or preg_match('|^/|', $fullecholink)) {
// encode extra chars in URLs - this does not make it always valid, but it helps with some UTF-8 problems
$allowed = "a-zA-Z0-9".preg_quote(';/?:@=&$_.+!*(),-#%', '/');
$fullecholink = preg_replace_callback("/[^$allowed]/", 'echolink_filter_callback', $fullecholink);
} else {
// encode special chars only
$fullecholink = str_replace('"', '%22', $fullecholink);
$fullecholink = str_replace('\'', '%27', $fullecholink);
$fullecholink = str_replace(' ', '%20', $fullecholink);
$fullecholink = str_replace('<', '%3C', $fullecholink);
$fullecholink = str_replace('>', '%3E', $fullecholink);
}
// add variable echolink parameters
if (!empty($parameters)) {
if (!$config) {
$config = get_config('echolink');
}
$paramvalues = echolink_get_variable_values($echolink, $cm, $course, $config);
foreach ($parameters as $parse=>$parameter) {
if (isset($paramvalues[$parameter])) {
$parameters[$parse] = rawecholinkencode($parse).'='.rawecholinkencode($paramvalues[$parameter]);
} else {
unset($parameters[$parse]);
}
}
if (!empty($parameters)) {
if (stripos($fullecholink, 'teamspeak://') === 0) {
$fullecholink = $fullecholink.'?'.implode('?', $parameters);
} else {
$join = (strpos($fullecholink, '?') === false) ? '?' : '&';
$fullecholink = $fullecholink.$join.implode('&', $parameters);
}
}
}
// encode all & to & entity
$fullecholink = str_replace('&', '&', $fullecholink);
return $fullecholink;
}
/**
* Unicode encoding helper callback
* @internal
* @param array $matches
* @return string
*/
function echolink_filter_callback($matches) {
return rawecholinkencode($matches[0]);
}
/**
* Print echolink header.
* @param object $echolink
* @param object $cm
* @param object $course
* @return void
*/
function echolink_print_header($echolink, $cm, $course) {
global $PAGE, $OUTPUT;
$PAGE->set_title($course->shortname.': '.$echolink->name);
$PAGE->set_heading($course->fullname);
$PAGE->set_activity_record($echolink);
echo $OUTPUT->header();
}
/**
* Print echolink heading.
* @param object $echolink
* @param object $cm
* @param object $course
* @param bool $ignoresettings print even if not specified in modedit
* @return void
*/
function echolink_print_heading($echolink, $cm, $course, $ignoresettings=false) {
global $OUTPUT;
$options = empty($echolink->displayoptions) ? array() : unserialize($echolink->displayoptions);
if ($ignoresettings or !empty($options['printheading'])) {
echo $OUTPUT->heading(format_string($echolink->name), 2, 'main', 'echolinkheading');
}
}
/**
* Print echolink introduction.
* @param object $echolink
* @param object $cm
* @param object $course
* @param bool $ignoresettings print even if not specified in modedit
* @return void
*/
function echolink_print_intro($echolink, $cm, $course, $ignoresettings=false) {
global $OUTPUT;
$options = empty($echolink->displayoptions) ? array() : unserialize($echolink->displayoptions);
if ($ignoresettings or !empty($options['printintro'])) {
if (trim(strip_tags($echolink->intro))) {
echo $OUTPUT->box_start('mod_introbox', 'echolinkintro');
echo format_module_intro('echolink', $echolink, $cm->id);
echo $OUTPUT->box_end();
}
}
}
/**
* Display echolink frames.
* @param object $echolink
* @param object $cm
* @param object $course
* @return does not return
*/
function echolink_display_frame($echolink, $cm, $course) {
global $PAGE, $OUTPUT, $CFG;
$frame = optional_param('frameset', 'main', PARAM_ALPHA);
if ($frame === 'top') {
$PAGE->set_pagelayout('frametop');
echolink_print_header($echolink, $cm, $course);
echolink_print_heading($echolink, $cm, $course);
echolink_print_intro($echolink, $cm, $course);
echo $OUTPUT->footer();
die;
} else {
$config = get_config('echolink');
$context = context_module::instance($cm->id);
$exteecholink = echolink_get_full_echolink($echolink, $cm, $course, $config);
$navecholink = "$CFG->wwwroot/mod/echolink/view.php?id=$cm->id&frameset=top";
$coursecontext = context_course::instance($course->id);
$courseshortname = format_string($course->shortname, true, array('context' => $coursecontext));
$title = strip_tags($courseshortname.': '.format_string($echolink->name));
$framesize = $config->framesize;
$modulename = s(get_string('modulename','echolink'));
$contentframetitle = format_string($echolink->name);
$dir = get_string('thisdirection', 'langconfig');
$extframe = <<<EOF
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
<html dir="$dir">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>$title</title>
</head>
<frameset rows="$framesize,*">
<frame src="$navecholink" title="$modulename"/>
<frame src="$exteecholink" title="$contentframetitle"/>
</frameset>
</html>
EOF;
@header('Content-Type: text/html; charset=utf-8');
echo $extframe;
die;
}
}
/**
* Print echolink info and link.
* @param object $echolink
* @param object $cm
* @param object $course
* @return does not return
*/
function echolink_print_workaround($echolink, $cm, $course) {
global $OUTPUT;
echolink_print_header($echolink, $cm, $course);
echolink_print_heading($echolink, $cm, $course, true);
echolink_print_intro($echolink, $cm, $course, true);
$fullecholink = echolink_get_full_echolink($echolink, $cm, $course);
$display = echolink_get_final_display_type($echolink);
if ($display == RESOURCELIB_DISPLAY_POPUP) {
$jsfullecholink = addslashes_js($fullecholink);
$options = empty($echolink->displayoptions) ? array() : unserialize($echolink->displayoptions);
$width = empty($options['popupwidth']) ? 620 : $options['popupwidth'];
$height = empty($options['popupheight']) ? 450 : $options['popupheight'];
$wh = "width=$width,height=$height,toolbar=no,location=no,menubar=no,copyhistory=no,status=no,directories=no,scrollbars=yes,resizable=yes";
$extra = "onclick=\"window.open('$jsfullecholink', '', '$wh'); return false;\"";
} else if ($display == RESOURCELIB_DISPLAY_NEW) {
$extra = "onclick=\"this.target='_blank';\"";
} else {
$extra = '';
}
echo '<div class="echolinkworkaround">';
print_string('clicktoopen', 'echolink', "<a href=\"$fullecholink\" $extra>$fullecholink</a>");
echo '</div>';
echo $OUTPUT->footer();
die;
}
/**
* Display embedded echolink file.
* @param object $echolink
* @param object $cm
* @param object $course
* @return does not return
*/
function echolink_display_embed($echolink, $cm, $course) {
global $CFG, $PAGE, $OUTPUT;
$mimetype = resourcelib_guess_url_mimetype($echolink->externalecholink);
$fullecholink = echolink_get_full_echolink($echolink, $cm, $course);
$title = $echolink->name;
$link = html_writer::tag('a', $fullecholink, array('href'=>str_replace('&', '&', $fullecholink)));
$clicktoopen = get_string('clicktoopen', 'echolink', $link);
$moodleecholink = new moodle_echolink($fullecholink);
$extension = resourcelib_get_extension($echolink->externalecholink);
$mediarenderer = $PAGE->get_renderer('core', 'media');
$embedoptions = array(
core_media::OPTION_TRUSTED => true,
core_media::OPTION_BLOCK => true
);
if (in_array($mimetype, array('image/gif','image/jpeg','image/png'))) { // It's an image
$code = resourcelib_embed_image($fullecholink, $title);
} else if ($mediarenderer->can_embed_echolink($moodleecholink, $embedoptions)) {
// Media (audio/video) file.
$code = $mediarenderer->embed_echolink($moodleecholink, $title, 0, 0, $embedoptions);
} else {
// anything else - just try object tag enlarged as much as possible
$code = resourcelib_embed_general($fullecholink, $title, $clicktoopen, $mimetype);
}
echolink_print_header($echolink, $cm, $course);
echolink_print_heading($echolink, $cm, $course);
echo $code;
echolink_print_intro($echolink, $cm, $course);
echo $OUTPUT->footer();
die;
}
/**
* Decide the best display format.
* @param object $echolink
* @return int display type constant
*/
function echolink_get_final_display_type($echolink) {
global $CFG;
if ($echolink->display != RESOURCELIB_DISPLAY_AUTO) {
return $echolink->display;
}
// detect links to local moodle pages
if (strpos($echolink->externalecholink, $CFG->wwwroot) === 0) {
if (strpos($echolink->externalecholink, 'file.php') === false and strpos($echolink->externalecholink, '.php') !== false ) {
// most probably our moodle page with navigation
return RESOURCELIB_DISPLAY_OPEN;
}
}
static $download = array('application/zip', 'application/x-tar', 'application/g-zip', // binary formats
'application/pdf', 'text/html'); // these are known to cause trouble for external links, sorry
static $embed = array('image/gif', 'image/jpeg', 'image/png', 'image/svg+xml', // images
'application/x-shockwave-flash', 'video/x-flv', 'video/x-ms-wm', // video formats
'video/quicktime', 'video/mpeg', 'video/mp4',
'audio/mp3', 'audio/x-realaudio-plugin', 'x-realaudio-plugin', // audio formats,
);
$mimetype = resourcelib_guess_url_mimetype($echolink->externalecholink);
if (in_array($mimetype, $download)) {
return RESOURCELIB_DISPLAY_DOWNLOAD;
}
if (in_array($mimetype, $embed)) {
return RESOURCELIB_DISPLAY_EMBED;
}
// let the browser deal with it somehow
return RESOURCELIB_DISPLAY_OPEN;
}
/**
* Get the parameters that may be appended to URL
* @param object $config echolink module config options
* @return array array describing opt groups
*/
function echolink_get_variable_options($config) {
global $CFG;
$options = array();
$options[''] = array('' => get_string('chooseavariable', 'echolink'));
$options[get_string('course')] = array(
'courseid' => 'id',
'coursefullname' => get_string('fullnamecourse'),
'courseshortname' => get_string('shortnamecourse'),
'courseidnumber' => get_string('idnumbercourse'),
'coursesummary' => get_string('summary'),
'courseformat' => get_string('format'),
);
$options[get_string('modulename', 'echolink')] = array(
'echolinkinstance' => 'id',
'echolinkcmid' => 'cmid',
'echolinkname' => get_string('name'),
'echolinkidnumber' => get_string('idnumbermod'),
);
$options[get_string('miscellaneous')] = array(
'sitename' => get_string('fullsitename'),
'serverecholink' => get_string('serverecholink', 'echolink'),
'currenttime' => get_string('time'),
'lang' => get_string('language'),
);
if (!empty($config->secretphrase)) {
$options[get_string('miscellaneous')]['encryptedcode'] = get_string('encryptedcode');
}
$options[get_string('user')] = array(
'userid' => 'id',
'userusername' => get_string('username'),
'useridnumber' => get_string('idnumber'),
'userfirstname' => get_string('firstname'),
'userlastname' => get_string('lastname'),
'userfullname' => get_string('fullnameuser'),
'useremail' => get_string('email'),
'usericq' => get_string('icqnumber'),
'userphone1' => get_string('phone').' 1',
'userphone2' => get_string('phone2').' 2',
'userinstitution' => get_string('institution'),
'userdepartment' => get_string('department'),
'useraddress' => get_string('address'),
'usercity' => get_string('city'),
'usertimezone' => get_string('timezone'),
'userecholink' => get_string('webpage'),
);
if ($config->rolesinparams) {
$roles = role_fix_names(get_all_roles());
$roleoptions = array();
foreach ($roles as $role) {
$roleoptions['course'.$role->shortname] = get_string('yourwordforx', '', $role->localname);
}
$options[get_string('roles')] = $roleoptions;
}
return $options;
}
/**
* Get the parameter values that may be appended to URL
* @param object $echolink module instance
* @param object $cm
* @param object $course
* @param object $config module config options
* @return array of parameter values
*/
function echolink_get_variable_values($echolink, $cm, $course, $config) {
global $USER, $CFG;
$site = get_site();
$coursecontext = context_course::instance($course->id);
$values = array (
'courseid' => $course->id,
'coursefullname' => format_string($course->fullname),
'courseshortname' => format_string($course->shortname, true, array('context' => $coursecontext)),
'courseidnumber' => $course->idnumber,
'coursesummary' => $course->summary,
'courseformat' => $course->format,
'lang' => current_language(),
'sitename' => format_string($site->fullname),
'serverecholink' => $CFG->wwwroot,
'currenttime' => time(),
'echolinkinstance' => $echolink->id,
'echolinkcmid' => $cm->id,
'echolinkname' => format_string($echolink->name),
'echolinkidnumber' => $cm->idnumber,
);
if (isloggedin()) {
$values['userid'] = $USER->id;
$values['userusername'] = $USER->username;
$values['useridnumber'] = $USER->idnumber;
$values['userfirstname'] = $USER->firstname;
$values['userlastname'] = $USER->lastname;
$values['userfullname'] = fullname($USER);
$values['useremail'] = $USER->email;
$values['usericq'] = $USER->icq;
$values['userphone1'] = $USER->phone1;
$values['userphone2'] = $USER->phone2;
$values['userinstitution'] = $USER->institution;
$values['userdepartment'] = $USER->department;
$values['useraddress'] = $USER->address;
$values['usercity'] = $USER->city;
$values['usertimezone'] = get_user_timezone_offset();
$values['userecholink'] = $USER->echolink;
}
// weak imitation of Single-Sign-On, for backwards compatibility only
// NOTE: login hack is not included in 2.0 any more, new contrib auth plugin
// needs to be createed if somebody needs the old functionality!
if (!empty($config->secretphrase)) {
$values['encryptedcode'] = echolink_get_encrypted_parameter($echolink, $config);
}
//hmm, this is pretty fragile and slow, why do we need it here??
if ($config->rolesinparams) {
$coursecontext = context_course::instance($course->id);
$roles = role_fix_names(get_all_roles($coursecontext), $coursecontext, ROLENAME_ALIAS);
foreach ($roles as $role) {
$values['course'.$role->shortname] = $role->localname;
}
}
return $values;
}
/**
* BC internal function
* @param object $echolink
* @param object $config
* @return string
*/
function echolink_get_encrypted_parameter($echolink, $config) {
global $CFG;
if (file_exists("$CFG->dirroot/local/externserverfile.php")) {
require_once("$CFG->dirroot/local/externserverfile.php");
if (function_exists('extern_server_file')) {
return extern_server_file($echolink, $config);
}
}
return md5(getremoteaddr().$config->secretphrase);
}
/**
* Optimised mimetype detection from general URL
* @param $fullecholink
* @param int $size of the icon.
* @return string|null mimetype or null when the filetype is not relevant.
*/
function echolink_guess_icon($fullecholink, $size = null) {
global $CFG;
require_once("$CFG->libdir/filelib.php");
if (substr_count($fullecholink, '/') < 3 or substr($fullecholink, -1) === '/') {
// Most probably default directory - index.php, index.html, etc. Return null because
// we want to use the default module icon instead of the HTML file icon.
return null;
}
$icon = file_extension_icon($fullecholink, $size);
$htmlicon = file_extension_icon('.htm', $size);
$unknownicon = file_extension_icon('', $size);
// We do not want to return those icon types, the module icon is more appropriate.
if ($icon === $unknownicon || $icon === $htmlicon) {
return null;
}
return $icon;
}
//-------------------------------------------------------------
//-------------------------------------------------------------
// Functions to perform XSL transformations from XML to HTML
function echolink_transform_xml_to_html($xsl, $xml) {
$xslDoc = new DOMDocument();
$xslDoc->load($xsl);
// Allocate a new XSLT processor
$xslt = new XSLTProcessor();
$xslt->importStylesheet($xslDoc);
return $xslt->transformToXML(new SimpleXMLElement($xml));
}// end of echolink_transform_xml_to_html function
//-------------------------------------------------------------