-
Notifications
You must be signed in to change notification settings - Fork 0
/
locallib.php
1138 lines (992 loc) · 41.3 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
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/>.
/*
TopoMojo Plugin for Moodle
Copyright 2024 Carnegie Mellon University.
NO WARRANTY. THIS CARNEGIE MELLON UNIVERSITY AND SOFTWARE ENGINEERING INSTITUTE MATERIAL IS FURNISHED ON AN "AS-IS" BASIS.
CARNEGIE MELLON UNIVERSITY MAKES NO WARRANTIES OF ANY KIND, EITHER EXPRESSED OR IMPLIED, AS TO ANY MATTER INCLUDING, BUT NOT LIMITED TO,
WARRANTY OF FITNESS FOR PURPOSE OR MERCHANTABILITY, EXCLUSIVITY, OR RESULTS OBTAINED FROM USE OF THE MATERIAL.
CARNEGIE MELLON UNIVERSITY DOES NOT MAKE ANY WARRANTY OF ANY KIND WITH RESPECT TO FREEDOM FROM PATENT, TRADEMARK, OR COPYRIGHT INFRINGEMENT.
Licensed under a GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007-style license, please see license.txt or contact [email protected] for full
terms.
[DISTRIBUTION STATEMENT A] This material has been approved for public release and unlimited distribution.
Please see Copyright notice for non-US Government use and distribution.
This Software includes and/or makes use of Third-Party Software each subject to its own license.
DM24-1175
*/
/**
* Private topomojo module utility functions
*
* @package mod_topomojo
* @copyright 2024 Carnegie Mellon University
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die;
require_once("$CFG->dirroot/mod/topomojo/lib.php");
require_once($CFG->libdir . '/questionlib.php');
/**
* Sets up and returns a cURL client with the required headers.
*
* This function initializes a cURL client and configures it with the necessary headers,
* including the API key for the TopoMojo service. The API key is retrieved from the configuration.
*
* @return curl The configured cURL client instance.
*/
function setup() {
$client = new curl;
$xapikey = get_config('topomojo', 'apikey');
$topoheaders = array('x-api-key: ' . $xapikey, 'content-type: application/json');
$client->setHeader($topoheaders);
//debugging("api key $xapikey", DEBUG_DEVELOPER);
return $client;
}
/**
* Retrieves and filters events from the gamespaces endpoint.
*
* This function makes a web request to the TopoMojo API to list gamespaces that match the given name.
* It filters the results based on the active status of the events and the provided name. The function
* also handles HTTP errors and JSON decoding issues.
*
* @param curl $client The cURL client instance used to make the API request.
* @param string $name The name of the event to filter by.
*
* @return array An array of events that match the provided name and are active. If no events match, an empty array is returned.
*
* @throws moodle_exception If the cURL client is null.
*/
function list_events($client, $name) {
//debugging("listing events", DEBUG_DEVELOPER);
if ($client == null) {
throw new moodle_exception('error with userauth');
return;
}
// Web request
//echo $name . "<br>";
//$url = get_config('topomojo', 'topomojoapiurl') . "/gamespaces?WantsAll=false&Term=" . rawurlencode("Wireless") . "&Filter=all";
$url = get_config('topomojo', 'topomojoapiurl') . "/gamespaces?WantsAll=false&Term=" . rawurlencode($name) . "&WantsActive=true";
//echo "GET $url<br>";
$response = $client->get($url);
if ($client->info['http_code'] !== 200) {
debugging('response code ' . $client->info['http_code'] . " $url", DEBUG_DEVELOPER);
return;
}
if (!$response) {
debugging("no response received by list_events $url", DEBUG_DEVELOPER);
return;
}
$r = json_decode($response, true);
if (!$r) {
debugging("could not decode json $url", DEBUG_DEVELOPER);
return;
}
$matches = [];
foreach ($r as $event) {
// Filter by name
$name = preg_replace('/ - \d+$/', '', $name); ///CHECK THIS - 0 IS BEING ADDED TO THE NAME DON'T KNOW WHY
if (($event['name'] === $name) && ($event['isActive'])) {
array_push($matches, $event);
}
}
debugging("list_events found " . count($matches) . " active events", DEBUG_DEVELOPER);
usort($matches, 'whencreated');
return $matches;
}
/**
* Filters events to include only those managed by a specific user.
*
* This function processes a list of events and filters them based on the manager's name.
* Only events managed by "Adam Welle" are included in the resulting array.
*
* @param array $events An array of events to filter. Each event should be an associative array with a 'managerName' key.
*
* @return array An array of events where the 'managerName' is "Adam Welle".
* If no events match or if the input is not an array, an empty array is returned.
*/
function moodle_events($events) {
$eventsmoodle = [];
if (!is_array($events)) {
debugging("no events to parse in eventsmoodle", DEBUG_DEVELOPER);
return;
}
foreach ($events as $event) {
if ($event['managerName'] == "Adam Welle") {
//echo "<br>got moodle user<br>";
array_push($eventsmoodle, $event);
}
}
//debugging("found " . count($eventsmoodle) . " events started by moodle", DEBUG_DEVELOPER);
return $eventsmoodle;
}
/**
* Filters events to include only those associated with the current user.
*
* This function iterates over a list of events and retrieves additional information
* about each event from the TopoMojo API. It then checks if the current user is
* listed as a player in each event and includes only those events where the user is found.
*
* @param curl $client An instance of the curl class used for making HTTP requests.
* @param array $events An array of events, where each event is expected to have an 'id' key.
*
* @return array An array of events where the current user is listed as a player.
* If no events match or if there is an error, an empty array or error will be returned.
*
* @throws moodle_exception If there is an error with user authentication, an error communicating with TopoMojo,
* or an issue decoding the JSON response.
*/
function user_events($client, $events) {
global $USER;
//debugging("filtering events for user", DEBUG_DEVELOPER);
if ($client == null) {
throw new moodle_exception('error with userauth');
return;
}
$userevents = [];
if (!is_array($events)) {
debugging("cannot parse for userevents if events is not an array", DEBUG_DEVELOPER);
return;
}
foreach ($events as $event) {
// Web request
$url = get_config('topomojo', 'topomojoapiurl') . "/gamespace/" . $event['id'];
//echo "<br>GET $url<br>";
$count = 1;
$response = null;
do {
$response = $client->get($url);
//print_r($response);
if (!$response) {
debugging("no response received by $url in attempt $count", DEBUG_DEVELOPER);
$count++;
}
} while (!$response && ($count < 4));
if (!$response) {
throw new moodle_exception("Error communicating with TopoMojo after $count attempts: " . $response);
return;
}
$r = json_decode($response, true);
if (!$r) {
debugging("could not decode json $url", DEBUG_DEVELOPER);
throw new moodle_exception("Error communicating with TopoMojo after $count attempts: " . $response);
return;
}
//debugging("returned array with " . count($r) . " elements", DEBUG_DEVELOPER);
$players = $r['players'];
//print_r($players);
$subjectid = explode( "@", $USER->email )[0];
//echo "<br>subjectid $subjectid<br>";
if (!is_array($players)) {
debugging("no players for this event " + $event->id, DEBUG_DEVELOPER);
return;
}
foreach ($players as $player) {
//print_r($player);
if ($player['subjectId'] == $subjectid) {
//echo "found user";
array_push($userevents, $r);
}
}
}
//debugging("found " . count($userevents) . " events for this user", DEBUG_DEVELOPER);
return $userevents;
}
/**
* Retrieves workspace information from the TopoMojo API.
*
* This function sends a request to the TopoMojo API to get details about a specific workspace
* based on the provided workspace ID. It handles HTTP response codes and errors during the
* request. The function assumes that the API returns a JSON response containing workspace details.
*
* @param curl $client An instance of the curl class used for making HTTP requests.
* @param string $id The ID of the workspace to retrieve.
*
* @return mixed The workspace details decoded from the JSON response. Returns null if the workspace
* could not be found or if there was an error processing the response.
*
* @throws moodle_exception If the HTTP request fails or if the response code is not 200.
*/
function get_workspace($client, $id) {
global $USER;
if ($client == null) {
throw new moodle_exception('could not setup session');
}
// Web request
$url = get_config('topomojo', 'topomojoapiurl') . "/workspace/" . $id;
//echo "GET $url<br>";
$response = $client->get($url);
// TODO handle network error
if ($client->info['http_code'] !== 200) {
//debugging('response code ' . $client->info['http_code'] . " for $url", DEBUG_DEVELOPER);
//print_r($client->response);
// TODO we dont have an httpp_code if the connection failed
throw new moodle_exception($client->info['http_code'] . " for $url");
}
if (!$response) {
debugging('no response received by get_workspace', DEBUG_DEVELOPER);
}
//echo "response:<br><pre>$response</pre>";
$r = json_decode($response);
if (!$r) {
debugging("could not find item by id", DEBUG_DEVELOPER);
return;
}
return $r;
}
/**
* Retrieves a list of workspaces from the TopoMojo API.
*
* This function sends a request to the TopoMojo API to get details about all workspaces. It handles
* HTTP response codes and errors during the request. The function assumes that the API returns a
* JSON response containing a list of workspaces.
*
* @param curl $client An instance of the curl class used for making HTTP requests.
*
* @return mixed The list of workspaces decoded from the JSON response. Returns null if there
* was an error retrieving or processing the response.
*
* @throws moodle_exception If the HTTP request fails or if the response code is not 200.
*/
function get_workspaces($client) {
if ($client == null) {
debugging('error with client in get_workspaces', DEBUG_DEVELOPER);
return;
}
// Web request
$url = get_config('topomojo', 'topomojoapiurl') . "/workspaces";
//echo "GET $url<br>";
$response = $client->get($url);
if (!$response) {
debugging("no response received by get_workspaces for $url", DEBUG_DEVELOPER);
}
//echo "response:<br><pre>$response</pre>";
if ($client->info['http_code'] !== 200) {
debugging('response code ' . $client->info['http_code'] . " for $url", DEBUG_DEVELOPER);
return;
}
$r = json_decode($response);
if (!$r) {
debugging("could not find item by id", DEBUG_DEVELOPER);
return;
}
return $r;
}
/**
* Retrieves the challenge associated with a specific gamespace from the TopoMojo API.
*
* This function sends a request to the TopoMojo API to get the challenge details for a gamespace
* identified by its ID. It handles HTTP response codes and potential errors during the request.
* The function assumes that the API returns a JSON response containing the challenge details.
*
* @param curl $client An instance of the curl class used for making HTTP requests.
* @param string $id The ID of the gamespace for which the challenge details are to be retrieved.
*
* @return mixed The challenge details decoded from the JSON response. Returns null if there
* was an error retrieving or processing the response.
*
* @throws moodle_exception If the HTTP request fails or if the response code is not 200.
*/
function get_gamespace_challenge($client, $id) {
global $USER;
if ($client == null) {
throw new moodle_exception('could not setup session');
}
// Web request
$url = get_config('topomojo', 'topomojoapiurl') . "/gamespace/" . $id . "/challenge";
//echo "GET $url<br>";
$response = $client->get($url);
// TODO handle network error
if ($client->info['http_code'] !== 200) {
//debugging('response code ' . $client->info['http_code'] . " for $url", DEBUG_DEVELOPER);
//print_r($client->response);
// TODO we dont have an httpp_code if the connection failed
throw new moodle_exception($client->info['http_code'] . " for $url");
}
if (!$response) {
debugging('no response received by get_workspace', DEBUG_DEVELOPER);
}
//echo "response:<br><pre>$response</pre>";
$r = json_decode($response);
if (!$r) {
debugging("could not find item by id", DEBUG_DEVELOPER);
return;
}
return $r;
}
/**
* Retrieves a document in Markdown format from the TopoMojo API.
*
* This function sends a request to the TopoMojo API to get the content of a document identified
* by its ID. It handles HTTP response codes and potential errors during the request. The function
* assumes that the API returns the document content directly as a response.
*
* @param curl $client An instance of the curl class used for making HTTP requests.
* @param string $id The ID of the document to be retrieved.
*
* @return string The document content in Markdown format. Returns null if there was an error
* retrieving or processing the response.
*
* @throws moodle_exception If the HTTP request fails or if the response code is not 200.
*/
function get_markdown($client, $id) {
global $USER;
if ($client == null) {
throw new moodle_exception('could not setup session');
}
// Web request
$url = get_config('topomojo', 'topomojoapiurl') . "/document/" . $id;
//echo "GET $url<br>";
$response = $client->get($url);
// TODO handle network error
if ($client->info['http_code'] !== 200) {
//debugging('response code ' . $client->info['http_code'] . " for $url", DEBUG_DEVELOPER);
//print_r($client->response);
// TODO we dont have an httpp_code if the connection failed
throw new moodle_exception($client->info['http_code'] . " for $url");
}
if (!$response) {
debugging('no response received by get_document', DEBUG_DEVELOPER);
}
return $response;
}
/**
* Starts a new gamespace from a specified workspace.
*
* This function sends a request to the TopoMojo API to initiate a new gamespace using the provided
* workspace ID and TopoMojo settings. It configures various parameters such as maximum attempts,
* duration, points, and player information before making the request. The function returns the
* response from the API if successful, or handles errors if the request fails.
*
* @param curl $client An instance of the curl class used for making HTTP requests.
* @param string $id The ID of the workspace from which to start the gamespace.
* @param object $topomojo An object containing configuration settings for the gamespace, including
* duration, grade, and variant.
*
* @return object|null The response from the API if the request is successful, or null if the request
* fails or if the response cannot be decoded.
*
* @throws moodle_exception If there is an issue with the HTTP request or if the response code is not 200.
*/
function start_event($client, $id, $topomojo) {
global $USER;
debugging("starting gamespace from workspace $id", DEBUG_DEVELOPER);
if ($client == null) {
debugging('error with client in start_event', DEBUG_DEVELOPER);;
return;
}
// Web request
$url = get_config('topomojo', 'topomojoapiurl') . "/gamespace";
//echo "POST $url<br>";
// Generate post data
$payload = new stdClass();
$payload->resourceId = $id;
$payload->startGamespace = true;
$payload->allowPreview = false;
$payload->allowReset = false;
$payload->maxAttempts = 1; // TODO get this from settings
$payload->maxMinutes = $topomojo->duration / 60;
$payload->points = $topomojo->grade;
$payload->variant = $topomojo->variant;
$payload->players = [];
$payload->players[0] = new stdClass();
$payload->players[0]->subjectId = explode( "@", $USER->email )[0];
$payload->players[0]->subjectName = $USER->username;
$json = json_encode($payload);
//print_r($json);
$client->setopt(['CURLOPT_POSTFIELDS' => $json]);
$response = $client->post($url, $json);
if (!$response) {
debugging('no response received by start_event response code ' , $client->info['http_code'] . " for $url", DEBUG_DEVELOPER);
return;
}
//echo "response:<br><pre>$response</pre>";
$r = json_decode($response);
if (!$r) {
//echo "could not decode json<br>";
return;
}
// Success
if ($client->info['http_code'] === 200) {
return $r;
}
//echo "response code ". $client->info['http_code'] . "<br>";
debugging('response code ' . $client->info['http_code'], DEBUG_DEVELOPER);
//print_r($r);
return;
}
/**
* Stops and completes a gamespace identified by the given ID.
*
* This function sends a POST request to the TopoMojo API to mark a gamespace as completed. It handles
* the request using the provided HTTP client and processes the response. If the request fails or returns
* an error code, the function logs debugging information. If no response is received, an exception is thrown.
*
* @param curl $client An instance of the curl class used for making HTTP requests.
* @param string $id The ID of the gamespace to be marked as completed.
*
* @return void
*
* @throws \Exception If no response is received from the API.
*/
function stop_event($client, $id) {
if ($client == null) {
debugging('error with client in stop_event', DEBUG_DEVELOPER);;
return;
}
// Web request
$url = get_config('topomojo', 'topomojoapiurl') . "/gamespace/" . $id . "/complete";
//echo "POST $url<br>";
$response = $client->post($url);
if ($client->info['http_code'] !== 200) {
debugging('response code ' . $client->info['http_code'] . " for $url", DEBUG_DEVELOPER);
}
if (!$response) {
throw new \Exception($response);
return;
}
//echo "response:<br><pre>$response</pre>";
return;
}
/**
* Retrieves a ticket from the TopoMojo API for the current user.
*
* This function sends a GET request to the TopoMojo API to obtain a ticket associated with the current user.
* It handles the request using the provided HTTP client and processes the response. If the response code is
* 200, it returns the ticket. If the response code is 500, it logs debugging information. If the response
* cannot be decoded or if there is an error, the function returns `null`.
*
* @param curl $client An instance of the curl class used for making HTTP requests.
*
* @return string|null The ticket if the request is successful and the response code is 200, or `null` if
* the request fails or the response cannot be decoded.
*/
function get_ticket($client) {
if ($client == null) {
debugging('error with client in get_ticket', DEBUG_DEVELOPER);;
return;
}
// Web request
$url = get_config('topomojo', 'topomojoapiurl') . "/user/ticket";
//echo "POST $url<br>";
$response = $client->get($url);
//echo "response:<br><pre>$response</pre>";
$r = json_decode($response);
if (!$r) {
//echo "could not decode json<br>";
return;
}
// Success
if ($client->info['http_code'] === 200) {
return $r->ticket;
}
if ($client->info['http_code'] === 500) {
//echo "response code ". $client->info['http_code'] . "<br>";
debugging('response code ' . $client->info['http_code'], DEBUG_DEVELOPER);
}
return;
}
/**
* Retrieves an invitation for a specific gamespace from the TopoMojo API.
*
* This function sends a POST request to the TopoMojo API to obtain an invitation for a gamespace identified
* by the provided ID. It handles the request using the provided HTTP client and processes the response. If
* the response code is 200, it returns the invitation details. If the response code is 500, it logs debugging
* information. If the response cannot be decoded or if there is an error, the function returns `null`.
*
* @param curl $client An instance of the curl class used for making HTTP requests.
* @param string $id The ID of the gamespace for which to retrieve the invitation.
*
* @return mixed The invitation details if the request is successful and the response code is 200, or `null`
* if the request fails or the response cannot be decoded.
*/
function get_invite($client, $id) {
if ($client == null) {
debugging('error with client in get_invite', DEBUG_DEVELOPER);;
return;
}
// Web request
$url = get_config('topomojo', 'topomojoapiurl') . "/gamespace/" . $id . "/invite";
//echo "POST $url<br>";
$response = $client->post($url);
//echo "response:<br><pre>$response</pre>";
$r = json_decode($response);
if (!$r) {
//echo "could not decode json<br>";
return;
}
// Success
if ($client->info['http_code'] === 200) {
return $r;
}
if ($client->info['http_code'] === 500) {
//echo "response code ". $client->info['http_code'] . "<br>";
debugging('response code ' . $client->info['http_code'], DEBUG_DEVELOPER);
}
return;
}
/**
* Extends or updates a gamespace with the provided data using the TopoMojo API.
*
* This function sends a PUT request to the TopoMojo API to update a gamespace with the data provided. It sets
* the appropriate header for JSON Patch format and processes the response. If the response code is 200, it
* indicates a successful update and the function returns `true`. If the response code is not 200, it logs the
* response code and returns `false`.
*
* @param curl $client An instance of the curl class used for making HTTP requests.
* @param array $data The data to be sent in the request body to update the gamespace.
*
* @return bool Returns `true` if the request is successful and the response code is 200, or `false` otherwise.
*/
function extend_event($client, $data) {
if ($client == null) {
return;
}
// Web request
$url = get_config('topomojo', 'topomojoapiurl') . "/gamespace";
$client->setHeader('Content-Type: application/json-patch+json');
$response = $client->put($url, json_encode($data));
if ($client->info['http_code'] !== 200) {
debugging('response code ' . $client->info['http_code'] . " for $url", DEBUG_DEVELOPER);
return false;
}
return true;
}
/**
* Retrieves a gamespace event from the TopoMojo API.
*
* This function sends a GET request to the TopoMojo API to retrieve details of a gamespace event identified
* by the provided ID. It processes the response and returns the decoded event data if the request is successful.
* If the request fails or the response cannot be decoded, it logs debugging information and throws an exception.
*
* @param curl $client An instance of the curl class used for making HTTP requests.
* @param string $id The ID of the gamespace event to retrieve.
*
* @return object|null Returns the decoded event data as an object if the request is successful and the response
* code is 200. Returns `null` if the response is not successful or if an error occurs.
*
* @throws moodle_exception Throws an exception if the response cannot be decoded or if the response code is not 200.
*/
function get_event($client, $id) {
if ($client == null) {
debugging('error with client in get_event', DEBUG_DEVELOPER);;
return;
}
if ($id == null) {
debugging('error with id in get_event', DEBUG_DEVELOPER);;
return;
}
// Web request
$url = get_config('topomojo', 'topomojoapiurl') . "/gamespace/" . $id;
//echo "GET $url<br>";
$response = $client->get($url);
if (!$response) {
debugging("no response received by get_event for $url", DEBUG_DEVELOPER);
return;
}
//echo "response:<br><pre>$response</pre>";
$r = json_decode($response);
if (!$r) {
//debugging("could not decode json for $url", DEBUG_DEVELOPER);
throw new moodle_exception($response);
return;
}
if ($client->info['http_code'] === 200) {
return $r;
} else {
debugging('response code ' . $client->info['http_code'] . " for $url", DEBUG_DEVELOPER);
throw new moodle_exception($r->detail);
}
return;
}
/**
* Compares two associative arrays based on their 'whenCreated' timestamps.
*
* This function compares the 'whenCreated' values of two associative arrays using a natural order comparison.
* It returns an integer less than, equal to, or greater than zero if the first 'whenCreated' is considered
* to be less than, equal to, or greater than the second 'whenCreated' respectively.
*
* @param array $a The first associative array containing a 'whenCreated' key.
* @param array $b The second associative array containing a 'whenCreated' key.
*
* @return int Returns an integer less than, equal to, or greater than zero depending on whether the 'whenCreated'
* value of $a is less than, equal to, or greater than the 'whenCreated' value of $b.
*/
function whencreated($a, $b) {
return strnatcmp($a['whencreated'], $b['whencreated']);
}
/**
* Retrieves the first active event from a history array.
*
* This function iterates through an array of event history and returns the first event marked as active.
* If no active event is found, it returns null. If the input history is null, it also returns null.
*
* @param array|null $history An array of events, where each event is an associative array containing at least an 'isActive' key.
* If null, the function will return null immediately.
*
* @return object|null Returns the first active event as an object, or null if no active event is found or if the input is null.
*/
function get_active_event($history) {
if ($history == null) {
return null;
}
foreach ($history as $odx) {
if (($odx['isActive'] == true)) {
debugging("we found an active event in the history pulled from topomojo", DEBUG_DEVELOPER);
return (object)$odx;
}
}
debugging("there are no active events in the history pulled from topomojo", DEBUG_DEVELOPER);
return null;
}
/**
* Retrieves the grading options for calculating the TopoMojo grade.
*
* This function returns an associative array where the keys are grading option constants
* and the values are corresponding language strings
* that describe each grading option. The grading options determine how the TopoMojo grade
* is calculated from individual attempt grades.
*
* @return array An associative array where the keys are grading option constants and the values are language strings.
*/
function topomojo_get_grading_options() {
return [
TOPOMOJO_GRADEHIGHEST => get_string('gradehighest', 'topomojo'),
TOPOMOJO_GRADEAVERAGE => get_string('gradeaverage', 'topomojo'),
TOPOMOJO_ATTEMPTFIRST => get_string('attemptfirst', 'topomojo'),
TOPOMOJO_ATTEMPTLAST => get_string('attemptlast', 'topomojo'),
];
}
/**
* Retrieves the language string for a given grading option.
*
* This function returns the language string corresponding to the specified grading option constant.
*
* @param int $option One of the grading option constants (e.g., TOPOMOJO_GRADEHIGHEST, TOPOMOJO_GRADEAVERAGE,
* TOPOMOJO_ATTEMPTFIRST, TOPOMOJO_ATTEMPTLAST).
* @return string The language string for the specified grading option.
*/
function topomojo_get_grading_option_name($option) {
$strings = topomojo_get_grading_options();
return $strings[$option];
}
/**
* Creates and triggers an event when a TopoMojo attempt ends.
*
* This function logs the end of a TopoMojo attempt by creating and triggering a Moodle event.
*
* @param stdClass $cm The course module object containing the module ID.
* @param context $context The context in which the event is triggered.
* @param stdClass $topomojo The TopoMojo instance object.
* @return void
*/
function topomojo_end($cm, $context, $topomojo) {
global $USER;
$params = [
'objectid' => $cm->id,
'context' => $context,
'relateduserid' => $USER->id,
];
$event = \mod_topomojo\event\attempt_ended::create($params);
$event->add_record_snapshot('topomojo', $topomojo);
$event->trigger();
}
/**
* Creates and triggers an event when a TopoMojo attempt starts.
*
* This function logs the start of a TopoMojo attempt by creating and triggering a Moodle event.
*
* @param stdClass $cm The course module object containing the module ID.
* @param context $context The context in which the event is triggered.
* @param stdClass $topomojo The TopoMojo instance object.
* @return void
*/
function topomojo_start($cm, $context, $topomojo) {
global $USER;
$params = [
'objectid' => $cm->id,
'context' => $context,
'relateduserid' => $USER->id,
];
$event = \mod_topomojo\event\attempt_started::create($params);
$event->add_record_snapshot('topomojo', $topomojo);
$event->trigger();
}
/**
* Retrieves a challenge from the TopoMojo API based on the provided ID.
*
* This function sends a request to the TopoMojo API to fetch details of a specific challenge by its ID.
* It handles the response and errors, and returns the challenge data as a decoded JSON object.
*
* @param object $client The HTTP client used to make the API request.
* @param int $id The ID of the challenge to retrieve.
* @return object|null The decoded challenge data object if successful, or null if an error occurs or the data cannot be decoded.
* @throws moodle_exception If there is an issue with the client or the response code is not 200.
*/
function get_challenge($client, $id) {
global $USER;
if ($client == null) {
throw new moodle_exception('could not setup session');
}
// Web request
$url = get_config('topomojo', 'topomojoapiurl') . "/challenge/" . $id;
//echo "GET $url<br>";
$response = $client->get($url);
// TODO handle network error
if ($client->info['http_code'] !== 200) {
//debugging('response code ' . $client->info['http_code'] . " for $url", DEBUG_DEVELOPER);
//print_r($client->response);
// TODO we dont have an httpp_code if the connection failed
throw new moodle_exception($client->info['http_code'] . " for $url");
}
if (!$response) {
debugging('no response received by get_challenge', DEBUG_DEVELOPER);
}
//echo "response:<br><pre>$response</pre>";
$r = json_decode($response);
if (!$r) {
debugging("could not find item by id", DEBUG_DEVELOPER);
return;
}
return $r;
}
/**
* Retrieves all attempts for a given course from the TopoMojo module.
*
* This function queries the database to fetch all attempts related to the specified course.
* It then creates an array of `topomojo_attempt` objects from the retrieved records.
*
* @param int $course The ID of the course for which attempts are to be retrieved.
* @return array An array of `\mod_topomojo\topomojo_attempt` objects representing the attempts for the specified course.
*/
function getall_course_attempts($course) {
global $DB, $USER;
$sqlparams = [];
$where = [];
$where[] = '{topomojo}.course= ?';
$sqlparams[] = $course;
$wherestring = implode(' AND ', $where);
$sql = "SELECT {topomojo_attempts}.* FROM {topomojo_attempts} JOIN {topomojo}
ON {topomojo_attempts}.topomojoid = {topomojo}.id WHERE $wherestring";
$dbattempts = $DB->get_records_sql($sql, $sqlparams);
$attempts = [];
// Create array of class attempts from the db entry
foreach ($dbattempts as $dbattempt) {
$attempts[] = new \mod_topomojo\topomojo_attempt($dbattempt);
}
return $attempts;
}
/**
* Retrieves all TopoMojo attempts from the database.
*
* This function queries the database to fetch all records from the `topomojo_attempts` table
* and then creates an array of `topomojo_attempt` objects from the retrieved records.
*
* @return array An array of `\mod_topomojo\topomojo_attempt` objects representing all TopoMojo attempts.
*/
function getall_topomojo_attempts($course) {
global $DB, $USER;
$sql = "SELECT * FROM {topomojo_attempts}";
$dbattempts = $DB->get_records_sql($sql);
$attempts = [];
// Create array of class attempts from the db entry
foreach ($dbattempts as $dbattempt) {
$attempts[] = new \mod_topomojo\topomojo_attempt($dbattempt);
}
return $attempts;
}
/**
* Generates a string representation of a question with optional details.
*
* This function creates an HTML string representing a question object, including
* its name, ID number, tags, and text. The output can be customized based on the
* flags provided.
*
* @param object $question The question object containing details such as name, idnumber, and text.
* @param bool $showicon Whether to display an icon for the question. Default is false.
* @param bool $showquestiontext Whether to display the question text. Default is true.
* @param bool $showidnumber Whether to display the question ID number. Default is false.
* @param mixed $showtags If true, retrieves and displays tags associated with the question.
* If an array, uses it directly. Default is false.
*
* @return string An HTML string representing the formatted question details.
*/
function topomojo_question_tostring($question, $showicon = false, $showquestiontext = true,
$showidnumber = false, $showtags = false) {
global $OUTPUT;
$result = '';
// Question name.
$name = shorten_text(format_string($question->name), 200);
if ($showicon) {
$name .= print_question_icon($question) . ' ' . $name;
}
$result .= html_writer::span($name, 'questionname');
// Question idnumber.
if ($showidnumber && $question->idnumber !== null && $question->idnumber !== '') {
$result .= ' ' . html_writer::span(
html_writer::span(get_string('idnumber', 'question'), 'accesshide') .
' ' . s($question->idnumber), 'badge badge-primary');
}
// Question tags.
if (is_array($showtags)) {
$tags = $showtags;
} else if ($showtags) {
$tags = core_tag_tag::get_item_tags('core_question', 'question', $question->id);
} else {
$tags = [];
}
if ($tags) {
$result .= $OUTPUT->tag_list($tags, null, 'd-inline', 0, null, true);
}
// Question text.
if ($showquestiontext) {
$questiontext = question_utils::to_plain_text($question->questiontext,
$question->questiontextformat, ['noclean' => true, 'para' => false]);
$questiontext = shorten_text($questiontext, 50);
if ($questiontext) {
$result .= ' ' . html_writer::span(s($questiontext), 'questiontext');
}
}
return $result;
}
/**
* Generates a URL to preview a specific question from a topomojo quiz.
*
* @param object $topomojo The topomojo settings containing quiz configurations.
* @param object $question The question object to be previewed.
* @param int|null $variant (optional) The specific question variant to preview. Defaults to null.
* @return moodle_url The URL to preview the question with the given options.