forked from catalyst/moodle-assignsubmission_maharaws
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathlocallib.php
1160 lines (1025 loc) · 48.4 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/>.
/**
* This file contains the definition for the library class for Mahara submission plugin
*
* This class provides all the functionality for the new assign module.
*
* @package assignsubmission_maharaws
* @copyright 2020 Catalyst IT
* @copyright 2012 Lancaster University
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
require_once($CFG->libdir.'/oauthlib.php');
class mahara_oauth extends oauth_helper {
/**
* Request oauth protected resources
* @param string $method
* @param string $url
* @param string $token
* @param string $secret
*/
public function request($method, $url, $params=array(), $token='', $secret='') {
$token = '';
$this->sign_secret = $secret.'&'.$token; // We never pass the token, only the secret.
if (strtolower($method) === 'post' && !empty($params)) {
$oauthparams = $this->prepare_oauth_parameters($url, array('oauth_token' => $token) + $params, $method);
} else {
$oauthparams = $this->prepare_oauth_parameters($url, array('oauth_token' => $token), $method);
}
$this->setup_oauth_http_header($oauthparams);
$content = call_user_func_array(array($this->http, strtolower($method)), array($url, $params, $this->http_options));
if ($this->http->info['http_code'] != 200) {
throw new moodle_exception('webservice call was not successful');
}
// Reset http header and options to prepare for the next request.
$this->http->resetHeader();
// Return request return value.
return $content;
}
}
/**
* library class for Mahara submission plugin extending submission plugin base class
*
* @package assignsubmission_maharaws
* @copyright 2012 Lancaster University
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class assign_submission_maharaws extends assign_submission_plugin {
// We've selected the page/collection, but we haven't locked it or issued a special access token.
const STATUS_SELECTED = 'selected';
// We've locked the page in Mahara and issued an access token.
const STATUS_SUBMITTED = 'submitted';
// We locked and then unlocked the page in Mahara, which means we probably still have a valid
// access token for it.
const STATUS_RELEASED = 'released';
/**
* Get the name of the Mahara submission plugin
*
* @return string
*/
public function get_name() {
return get_string('mahara', 'assignsubmission_maharaws');
}
/**
* Get Mahara submission information from the database
*
* @global stdClass $DB
* @param int $submissionid
* @return mixed
*/
private function get_mahara_submission($submissionid) {
global $DB;
return $DB->get_record('assignsubmission_maharaws', array('submission' => $submissionid));
}
/**
* Get the settings form for Mahara submission plugin
*
* @global stdClass $CFG
* @global stdClass $DB
* @param MoodleQuickForm $mform The form to add elements to
* @return void
*/
public function get_settings(MoodleQuickForm $mform) {
global $CFG;
require_once($CFG->dirroot . '/mod/assign/submission/maharaws/lib.php');
$mform->addElement('text', 'assignsubmission_maharaws_url', get_string('url', 'assignsubmission_maharaws'), array('maxlength' => 255, 'size' => 50));
$mform->setType('assignsubmission_maharaws_url', PARAM_URL);
if (!empty($this->get_config('url'))) {
$mform->setDefault('assignsubmission_maharaws_url', $this->get_config('url'));
}
$mform->addHelpButton('assignsubmission_maharaws_url', 'url', 'assignsubmission_maharaws');
$mform->hideIf('assignsubmission_maharaws_url', 'assignsubmission_maharaws_enabled', 'notchecked');
if (!$this->can_configure()) {
$mform->freeze(['assignsubmission_maharaws_url']);
}
if ($this->can_configure()) {
$mform->addElement('text', 'assignsubmission_maharaws_key', get_string('key', 'assignsubmission_maharaws'), array('maxlength' => 255, 'size' => 50));
$mform->setType('assignsubmission_maharaws_key', PARAM_ALPHANUM);
if (!empty($this->get_config('key'))) {
$mform->setDefault('assignsubmission_maharaws_key', $this->get_config('key'));
}
$mform->addHelpButton('assignsubmission_maharaws_key', 'key', 'assignsubmission_maharaws');
$mform->hideIf('assignsubmission_maharaws_key', 'assignsubmission_maharaws_enabled', 'notchecked');
$mform->addElement('password', 'assignsubmission_maharaws_secret', get_string('secret', 'assignsubmission_maharaws'), array('maxlength' => 255, 'size' => 50));
$mform->setType('assignsubmission_maharaws_secret', PARAM_ALPHANUM);
if (!empty($this->get_config('secret'))) {
$mform->setDefault('assignsubmission_maharaws_secret', $this->get_config('secret'));
}
$mform->addHelpButton('assignsubmission_maharaws_secret', 'secret', 'assignsubmission_maharaws');
$mform->hideIf('assignsubmission_maharaws_secret', 'assignsubmission_maharaws_enabled', 'notchecked');
}
$locked = $this->get_config('lock');
if ($locked === false) {
// No setting for this instance, so use the sitewide default.
$locked = get_config('assignsubmission_maharaws', 'lock');
}
// Menu to select whether to lock Mahara pages or not.
$locksettings = array(
ASSIGNSUBMISSION_MAHARAWS_SETTING_DONTLOCK => new lang_string('no'),
ASSIGNSUBMISSION_MAHARAWS_SETTING_KEEPLOCKED => new lang_string('yeskeeplocked', 'assignsubmission_maharaws'),
ASSIGNSUBMISSION_MAHARAWS_SETTING_UNLOCK => new lang_string('yesunlock', 'assignsubmission_maharaws')
);
$mform->addElement('select', 'assignsubmission_maharaws_lockpages', get_string('lockpages', 'assignsubmission_maharaws'), $locksettings);
$mform->setDefault('assignsubmission_maharaws_lockpages', $locked);
$mform->addHelpButton('assignsubmission_maharaws_lockpages', 'lockpages', 'assignsubmission_maharaws');
$mform->hideIf('assignsubmission_maharaws_lockpages', 'assignsubmission_maharaws_enabled', 'notchecked');
if (!$this->can_configure()) {
$mform->freeze(['assignsubmission_maharaws_lockpages']);
}
}
/**
* Save the settings for Mahara plugin
*
* @param stdClass $data
* @return bool
*/
public function save_settings(stdClass $data) {
global $CFG;
require_once($CFG->dirroot . '/mod/assign/submission/maharaws/lib.php');
if ($this->can_configure()) {
$this->set_config('url', $data->assignsubmission_maharaws_url);
$this->set_config('key', $data->assignsubmission_maharaws_key);
$this->set_config('secret', $data->assignsubmission_maharaws_secret);
$this->set_config('debug', false);
$this->set_config('remoteuser', false);
$this->set_config('lock', $data->assignsubmission_maharaws_lockpages);
$this->set_config('username_attribute', 'email');
}
// Test Mahara connection.
try {
$data = $this->webservice_call("mahara_user_get_extended_context", array());
$funcs = array();
$required = array(
"mahara_user_get_extended_context",
"mahara_submission_get_views_for_user",
"mahara_submission_submit_view_for_assessment",
"mahara_submission_release_submitted_view",
"module_lti_launch",
);
foreach ($data['functions'] as $v) {
$funcs[] = $v['function'];
}
foreach ($required as $f) {
if (!in_array($f, $funcs)) {
$this->set_error(get_string('errorinvalidurl', 'assignsubmission_maharaws', 'missing functions: '.implode(", ", $required))."\n\n".
get_string('invalidurlhelp', 'assignsubmission_maharaws'));
return false;
}
}
} catch (Exception $e) {
$this->set_error(get_string('errorinvalidurl', 'assignsubmission_maharaws', $e->getMessage())."\n".get_string('invalidurlhelp', 'assignsubmission_maharaws'));
return false;
}
return true;
}
/**
* Check if the current user can configure the plugin in the provided context.
*
* @param \context|null $context Context to check permissions in. If not set, then current page context will be used.
*
* @return bool
*/
public function can_configure(context $context = null) {
global $PAGE;
if (empty($context)) {
$context = $PAGE->context;
}
return has_capability('assignsubmission/maharaws:configure', $context);
}
/**
* Add elements to user submission form
*
* @param mixed $submission stdClass|null
* @param MoodleQuickForm $mform
* @param stdClass $data
* @param int $userid
* @return bool
*/
public function webservice_call($function, $params, $method="POST") {
global $CFG;
$endpoint = $this->get_config('url').(preg_match('/\/$/', $this->get_config('url')) ? '' : '/').'webservice/rest/server.php';
$args = array(
'oauth_consumer_key' => $this->get_config('key'),
'oauth_consumer_secret' => $this->get_config('secret'),
'oauth_callback' => 'about:blank',
'api_root' => $endpoint,
);
$client = new mahara_oauth($args);
if (!empty($CFG->disablesslchecks)) {
$options = array('CURLOPT_SSL_VERIFYPEER' => 0, 'CURLOPT_SSL_VERIFYHOST' => 0);
$client->setup_oauth_http_options($options);
}
// Have to flatten nested parameters into JSON as OAuth can't handle it.
foreach ($params as $k => $v) {
if (is_array($v)) {
$params[$k] = json_encode($v);
}
}
$content = $client->request($method, $endpoint,
array_merge($params, array('wsfunction' => $function, 'alt' => 'json')),
null,
$this->get_config('secret'));
$data = json_decode($content, true);
if (isset($data['error']) && $data['error'] == true ) {
throw new Exception($data['error_rendered']);
}
return $data;
}
/**
* Add elements to user submission form
*
* @param mixed $submission stdClass|null
* @param MoodleQuickForm $mform
* @param stdClass $data
* @param int $userid
* @return bool
*/
public function get_form_elements_for_user($submission, MoodleQuickForm $mform, stdClass $data, $userid) {
global $DB, $PAGE, $CFG;
$PAGE->requires->js('/mod/assign/submission/maharaws/js/popup.js');
$PAGE->requires->js('/mod/assign/submission/maharaws/js/filter.js');
// Getting submission.
if ($submission) {
$maharasubmission = $this->get_mahara_submission($submission->id);
}
if (!empty($maharasubmission)) {
$selectedid = $maharasubmission->viewid;
$selectediscollection = $maharasubmission->iscollection;
} else {
$selectedid = 0;
$selectediscollection = null;
}
// Getting views (pages) user have in linked site.
$views = false;
try {
$views = $this->get_views();
} catch (moodle_exception $e) {
$error = $e->getMessage();
}
if (!$views) {
$views = array(
'data' => array(),
'collections' => array('data' => array()),
'ids' => array(),
);
}
// Filter out collection views, special views, and already-submitted views (except the current one).
foreach ($views['data'] as $i => $view) {
if (
$view['collid']
|| $view['type'] != 'portfolio'
|| (
$view['submittedtime']
&& !($view['id'] == $selectedid && $selectediscollection == false)
)
) {
unset($views['ids'][$i]);
unset($views['data'][$i]);
$views['count']--;
}
}
// Filter out empty or submitted collections.
foreach ($views['collections']['data'] as $i => $coll) {
if (
(
array_key_exists('numviews', $coll)
&& $coll['numviews'] == 0
) || (
$coll['submittedtime']
&& !($coll['id'] == $selectedid && $selectediscollection == true)
)
) {
unset($views['collections']['data'][$i]);
$views['collections']['count']--;
}
}
$viewids = $views['ids'];
// Prepare the header.
try {
$remotehost = (object)$this->webservice_call("mahara_user_get_extended_context", array());
} catch (Exception $e) {
debugging("Remote host webservice call failed: ".$e->getCode().":".$e->getMessage());
throw new moodle_exception('errorwsrequest', 'assignsubmission_maharaws', '', $e->getMessage());
}
$remotehost->jumpurl = $CFG->wwwroot.'/mod/assign/submission/maharaws/launch.php?id='.$PAGE->cm->id.'&url='.urlencode($remotehost->siteurl).'&sesskey='.sesskey();
$remotehost->name = $remotehost->sitename;
// See if any of views are already in use, we will remove them from select.
if (count($viewids) || count($views['collections']['data'])) {
$mform->addElement('static', '', $remotehost->name, get_string('selectmaharaview', 'assignsubmission_maharaws', $remotehost));
// Add "none selected" option.
$mform->addElement('radio', 'viewid', '', get_string('noneselected', 'assignsubmission_maharaws'), 'none');
$mform->setType('viewid', PARAM_ALPHANUM);
$mform->setDefault('viewid', 'none');
$mform->addElement('text', 'search', get_string('search'));
$mform->setType('search', PARAM_RAW);
$mform->addElement('html', '<hr/><br/>');
if (count($views['data'])) {
$users = get_users_by_capability($PAGE->context, 'mod/assign:grade');
$names = array();
foreach ($users as $u) {
$names[] = fullname($u, true).(empty($u->{$this->get_config('username_attribute')}) ? '' : ' ('.$u->{$this->get_config('username_attribute')}.')');
}
$names = implode(', ', $names);
$mform->addElement('static', '',
get_string('viewsby', 'assignsubmission_maharaws', $views['displayname']),
get_string('sharewith', 'assignsubmission_maharaws', array('site' => $remotehost->name, 'names' => $names))
);
foreach ($views['data'] as $view) {
$anchor = $this->get_preview_url($view['title'], $view['url'], strip_tags($view['description']));
$mform->addElement('radio', 'viewid', '', $anchor, 'v' . $view['id']);
}
}
if (count($views['collections']['data'])) {
$mform->addElement('static', 'collection_by',
get_string('collectionsby', 'assignsubmission_maharaws', $views['displayname'])
);
foreach ($views['collections']['data'] as $coll) {
$anchor = $this->get_preview_url($coll['name'], $coll['url'], strip_tags($coll['description']));
$mform->addElement('radio', 'viewid', '', $anchor, 'c' . $coll['id']);
}
}
if (!empty($maharasubmission)) {
if ($maharasubmission->iscollection) {
$prefix = 'c';
} else {
$prefix = 'v';
}
$mform->setDefault('viewid', $prefix . $maharasubmission->viewid);
}
return true;
} else {
$mform->addElement(
'static',
'',
$remotehost->name,
get_string('noviewscreated', 'assignsubmission_maharaws', $remotehost)
);
$mform->addElement('hidden', 'viewid', 'none');
$mform->setType('viewid', PARAM_ALPHANUM);
return true;
}
}
/**
* Retrieve user views from Mahara portfolio.
*
* @global stdClass $USER
* @param string $query Search query
* @return mixed
*/
public function get_views($query = '') {
global $USER, $DB, $CFG, $PAGE;
require_once($CFG->dirroot . '/mod/assign/submission/maharaws/lib.php');
$username = (!empty($CFG->mahara_test_user) ? $CFG->mahara_test_user : $USER->{$this->get_config('username_attribute')});
$field = $this->get_mahara_idfield();
try {
$result = $this->webservice_call("mahara_submission_get_views_for_user",
array('users' => array( array($field => $username,
'query' => $query))));
$result = array_pop($result);
$result['views']['ids'] = array_map('intval', explode(',', $result['views']['ids']));
// Overwrite url with full URL.
foreach ($result['views']['data'] as $key => $value) {
$result['views']['data'][$key]['url'] = $result['views']['data'][$key]['fullurl'];
}
foreach ($result['views']['collections']['data'] as $key => $value) {
$result['views']['collections']['data'][$key]['url'] = $result['views']['collections']['data'][$key]['fullurl'];
}
} catch (Exception $e) {
throw new moodle_exception('errorwsrequest', 'assignsubmission_maharaws', '', $e->getMessage());
}
return $result['views'];
}
/**
* Submit view or collection for assessment in Mahara. This marks the view/collection
* as "submitted", creates an access token, and locks the view/collection from editing
* or further submissions in Mahara.
*
* @global stdClass $USER
* @param stdClass $submission The submission record (used for verification)
* @param int $viewid Id of the view or collection to submit
* @param boolean $iscollection True if it's a collection, False if not
* @param $viewownermoodleid ID of the view ower's Moodle user record
* @return mixed
*/
public function submit_view($submission, $viewid, $iscollection, $viewownermoodleid = null) {
global $USER, $DB, $CFG;
// Verify that it's not already submitted to another Mahara assignment in this Moodle site.
// We can't do this on the Mahara side, because Mahara only knows the remote site's wwwroot.
if (
$DB->record_exists_select(
'assignsubmission_maharaws',
'viewid = ? AND iscollection = ? AND viewstatus = ? AND assignment != ?',
array(
$viewid,
($iscollection ? 1 : 0),
self::STATUS_SUBMITTED,
$submission->assignment,
)
)
) {
throw new moodle_exception('errorvieworcollectionalreadysubmitted', 'assignsubmission_maharaws');
}
if (!$viewownermoodleid) {
$username = $USER->{$this->get_config('username_attribute')};
} else {
$username = $DB->get_field('user', $this->get_config('username_attribute'), array('id' => $viewownermoodleid));
}
require_once($CFG->dirroot . '/mod/assign/submission/maharaws/lib.php');
$username = (!empty($CFG->mahara_test_user) ? $CFG->mahara_test_user : $username);
$field = $this->get_mahara_idfield();
try {
$result = $this->webservice_call(
'mahara_submission_submit_view_for_assessment',
array('views' =>
array(
array($field => $username,
'viewid' => $viewid,
'iscollection' => $iscollection,
'lock' => true,
'apilevel' => 'moodle-assignsubmission-mahara:2',
'wwwroot' => $CFG->wwwroot,
),
)
)
);
$result = array_pop($result);
} catch (Exception $e) {
debugging("Submit view for assessment webservice call failed: ".$e->getCode().":".$e->getMessage());
throw new moodle_exception('errorwsrequest', 'assignsubmission_maharaws', '', $e->getMessage());
}
return $result;
}
/**
* Release submitted view for assessment.
*
* @global stdClass $USER
* @param int $viewid View or Collection ID
* @param array $viewoutcomes Outcomes data
* @param boolean $iscollection Whether the $viewid is a view or a collection
* @return mixed
*/
public function release_submitted_view($viewid, $viewoutcomes, $iscollection = false) {
global $USER, $CFG;
try {
$username = (!empty($CFG->mahara_test_user) ? $CFG->mahara_test_user : $USER->{$this->get_config('username_attribute')});
$field = $this->get_mahara_idfield();
$result = $this->webservice_call(
'mahara_submission_release_submitted_view',
array('views' => array( array($field => $username,
'viewid' => $viewid,
'iscollection' => $iscollection,
'viewoutcomes' => implode(',', $viewoutcomes))))
);
} catch (Exception $e) {
debugging("Submit view for assessment webservice call failed: ".$e->getCode().":".$e->getMessage());
throw new moodle_exception('errorwsrequest', 'assignsubmission_maharaws', '', $e->getMessage());
}
return $result;
}
/**
* Save submission data to the database
*
* @global stdClass $DB
* @param stdClass $submission
* @param stdClass $data
* @return bool
*/
public function save(stdClass $submission, stdClass $data) {
global $USER, $DB;
// Because the drop-down menu contains collections & views, we make the id
// start with "v" or "c" to indicate the type, e.g. v30, c100.
if ($data->viewid == 'none') {
$data->viewid = null;
} else {
$iscollection = ($data->viewid[0] == 'c');
$data->viewid = substr($data->viewid, 1);
}
$maharasubmission = $this->get_mahara_submission($submission->id);
if ($submission->status === ASSIGN_SUBMISSION_STATUS_DRAFT) {
// Draft. All we need to do is just save or update submitted view data.
if ($data->viewid === null) {
// They selected "(nothing selected)", so remove their Mahara selection.
return $DB->delete_records(
'assignsubmission_maharaws',
array('submission' => $submission->id)
);
}
if (!$views = $this->get_views()) {
// Wrap recorded error in language string and return false.
$this->set_error(get_string('errorrequest', 'assignsubmission_maharaws', $this->get_error()));
return false;
}
if ($iscollection) {
$foundcoll = false;
if (!is_array($views['collections']['data'])) {
return false;
}
foreach ($views['collections']['data'] as $coll) {
if ($coll['id'] == $data->viewid) {
$foundcoll = true;
$url = $coll['url'];
$title = clean_text($coll['name']);
break;
}
}
// The submitted collection id isn't one of the allowed options for this user.
if (!$foundcoll) {
return false;
}
} else {
$keys = array_flip($views['ids']);
// The submitted view id isn't one of the allowed options for this user.
if (!array_key_exists($data->viewid, $keys)) {
return false;
}
$viewdata = $views['data'][$keys[$data->viewid]];
$url = $viewdata['url'];
$title = clean_text($viewdata['title']);
}
if ($maharasubmission) {
$maharasubmission->viewid = $data->viewid;
$maharasubmission->viewurl = $url;
$maharasubmission->viewtitle = $title;
$maharasubmission->iscollection = (int) $iscollection;
$maharasubmission->viewstatus = self::STATUS_SELECTED;
return $DB->update_record('assignsubmission_maharaws', $maharasubmission);
} else {
$maharasubmission = new stdClass();
$maharasubmission->viewid = $data->viewid;
$maharasubmission->viewurl = $url;
$maharasubmission->viewtitle = $title;
$maharasubmission->iscollection = (int) $iscollection;
$maharasubmission->viewstatus = self::STATUS_SELECTED;
$maharasubmission->submission = $submission->id;
$maharasubmission->assignment = $this->assignment->get_instance()->id;
return $DB->insert_record('assignsubmission_maharaws', $maharasubmission) > 0;
}
} else {
// This is not the draft, but the actual submission. Process it properly.
// If viewid is null, it means they selected no page.
if ($data->viewid === null) {
if ($maharasubmission) {
// Unlock the previously selected page.
if ($maharasubmission->viewstatus == self::STATUS_SUBMITTED) {
$response = $this->release_submitted_view($maharasubmission->viewid, array(), $maharasubmission->iscollection);
if ($response === false) {
throw new moodle_exception('errorrequest', 'assignsubmission_maharaws', '', $this->get_error());
}
}
// Delete the record of the previously selected page from our submission, and exit.
return $DB->delete_records('assignsubmission_maharaws', array('submission' => $submission->id));
} else {
// No previously selected page to clear.
return true;
}
}
// Lock submission on mahara side.
if (!$response = $this->submit_view($submission, $data->viewid, $iscollection)) {
throw new moodle_exception('errorrequest', 'assignsubmission_maharaws', '', $this->get_error());
}
// If we're not locking user pages, then immediately release the page. This will leave it unlocked,
// but leave the access code in place.
// TODO: Replace this hack with something more robust. It's an oversight and a security hole, that the
// access code remains in place in Mahara when you release the page via XML-RPC.
if (!$this->get_config('lock')) {
$this->release_submitted_view($data->viewid, array(), $iscollection);
$status = self::STATUS_RELEASED;
} else {
$status = self::STATUS_SUBMITTED;
}
$params = array(
'context' => context_module::instance($this->assignment->get_course_module()->id),
'courseid' => $this->assignment->get_course()->id,
'objectid' => $submission->id,
'other' => array(
'pathnamehashes' => array(),
'content' => ''
)
);
if (!empty($submission->userid) && ($submission->userid != $USER->id)) {
$params['relateduserid'] = $submission->userid;
}
$event = \assignsubmission_maharaws\event\assessable_uploaded::create($params);
$event->trigger();
$groupname = null;
$groupid = 0;
// Get the group name as other fields are not transcribed in the logs and this information is important.
if (empty($submission->userid) && !empty($submission->groupid)) {
$groupname = $DB->get_field('groups', 'name', array('id' => $submission->groupid), '*', MUST_EXIST);
$groupid = $submission->groupid;
} else {
$params['relateduserid'] = $submission->userid;
}
// Unset the objectid and other field from params for use in submission events.
unset($params['objectid']);
unset($params['other']);
$params['other'] = array(
'submissionid' => $submission->id,
'submissionattempt' => $submission->attemptnumber,
'submissionstatus' => $submission->status,
'groupid' => $groupid,
'groupname' => $groupname
);
if ($maharasubmission) {
// If we are updating previous submission, release previous submission first (if it's locked).
if ($maharasubmission->viewid != $data->viewid && $maharasubmission->viewstatus == self::STATUS_SUBMITTED) {
if ($this->release_submitted_view($maharasubmission->viewid, array(), $maharasubmission->iscollection) === false) {
throw new moodle_exception('errorrequest', 'assignsubmission_maharaws', '', $this->get_error());
}
}
// Update submission data.
$maharasubmission->viewid = $data->viewid;
$maharasubmission->viewurl = $response['url'];
$maharasubmission->viewtitle = clean_text($response['title']);
$maharasubmission->viewstatus = $status;
$maharasubmission->iscollection = (int) $iscollection;
$params['objectid'] = $maharasubmission->id;
$updatestatus = $DB->update_record('assignsubmission_maharaws', $maharasubmission);
$event = \assignsubmission_maharaws\event\submission_updated::create($params);
$event->set_assign($this->assignment);
$event->trigger();
return $updatestatus;
} else {
if ($data->viewid === null) {
return $DB->delete_records('assignsubmission_maharaws', array('submission' => $submission->id));
} else {
// We are dealing with the new submission.
$maharasubmission = new stdClass();
$maharasubmission->viewid = $data->viewid;
$maharasubmission->viewurl = $response['url'];
$maharasubmission->viewtitle = clean_text($response['title']);
$maharasubmission->viewstatus = $status;
$maharasubmission->iscollection = (int) $iscollection;
$maharasubmission->submission = $submission->id;
$maharasubmission->assignment = $this->assignment->get_instance()->id;
$maharasubmission->id = $DB->insert_record('assignsubmission_maharaws', $maharasubmission);
$params['objectid'] = $maharasubmission->id;
$event = \assignsubmission_maharaws\event\submission_created::create($params);
$event->set_assign($this->assignment);
$event->trigger();
return $maharasubmission->id > 0;
}
}
}
}
/**
* Check if the submission plugin has all the required data to allow the work
* to be submitted for grading
* @param stdClass $submission the assign_submission record being submitted.
* @return bool|string 'true' if OK to proceed with submission, otherwise a
* a message to display to the user
*/
public function precheck_submission($submission) {
$maharasubmission = $this->get_mahara_submission($submission->id);
if (!$maharasubmission) {
return get_string('emptysubmission', 'assignsubmission_maharaws');
}
return true;
}
/**
* Process submission for grading
*
* @global stdClass $DB
* @param stdClass $submission
* @return void
*/
public function submit_for_grading($submission) {
global $DB;
// If the submission has been locked in the gradebook, then it has already been submitted on the Mahara side.
$flags = $this->assignment->get_user_flags($submission->userid, false);
if ($flags && $flags->locked == 1) {
return;
}
$maharasubmission = $this->get_mahara_submission($submission->id);
// Lock view on Mahara side as it has been submitted for assessment.
if (!$response = $this->submit_view($submission, $maharasubmission->viewid, $maharasubmission->iscollection)) {
throw new moodle_exception('errorrequest', 'assignsubmission_maharaws', '', $this->get_error());
}
$maharasubmission->viewurl = $response['url'];
$maharasubmission->viewstatus = self::STATUS_SUBMITTED;
if (!$this->get_config('lock')) {
if ($this->release_submitted_view($maharasubmission->viewid, array(), $maharasubmission->iscollection) === false) {
throw new moodle_exception('errorrequest', 'assignsubmission_maharaws', '', $this->get_error());
}
$maharasubmission->viewstatus = self::STATUS_RELEASED;
}
$DB->update_record('assignsubmission_maharaws', $maharasubmission);
}
/**
* Process locking
*
* @global stdClass $DB
* @param stdClass $submission
* @return void
*/
public function lock($submission, stdClass $flags = null) {
global $DB;
$maharasubmission = $this->get_mahara_submission($submission->id);
// If we're not using page locking, then don't need to do anything special here.
// If no page is selected, then we don't need to do anything special here.
// If it's in submitted status, then it has already been locked and we don't need to do anything.
if (
!$this->get_config('lock')
|| !$maharasubmission
|| !$maharasubmission->viewid
|| $maharasubmission->viewstatus == self::STATUS_SUBMITTED
) {
return;
}
// Lock view on Mahara side.
if (!$response = $this->submit_view($submission, $maharasubmission->viewid, $maharasubmission->iscollection, $submission->userid)) {
throw new moodle_exception('errorrequest', 'assignsubmission_maharaws', '', $this->get_error());
}
$maharasubmission->viewurl = $response['url'];
$maharasubmission->viewstatus = self::STATUS_SUBMITTED;
$DB->update_record('assignsubmission_maharaws', $maharasubmission);
}
/**
* Process unlocking
*
* @global stdClass $DB
* @param stdClass $submission
* @return void
*/
public function unlock($submission, stdClass $flags = null) {
global $DB;
// If it has been submitted, and we're using page locking, it needs to remain locked.
if ($submission->status === ASSIGN_SUBMISSION_STATUS_SUBMITTED && $this->get_config('lock')) {
return;
}
$maharasubmission = $this->get_mahara_submission($submission->id);
// If no page is selected, then we don't need to do anything special here.
// If the page isn't locked, we don't need to do anything special here.
if (!$maharasubmission || !$maharasubmission->viewid || $maharasubmission->viewstatus !== self::STATUS_SUBMITTED) {
return;
}
// Unlock view on Mahara side as it has been unlocked.
if ($this->release_submitted_view($maharasubmission->viewid, array(), $maharasubmission->iscollection) === false) {
throw new moodle_exception('errorrequest', 'assignsubmission_maharaws', '', $this->get_error());
}
$this->set_mahara_submission_status($maharasubmission->submission, self::STATUS_RELEASED);
}
/**
* Process reverting to draft
*
* @global stdClass $DB
* @param stdClass $submission
* @return void
*/
public function revert_to_draft(stdClass $submission) {
global $DB;
// If the submission has been locked in the gradebook, then we don't want to release it on the Mahara side
// ... unless we've disabled page locking, in which case we might as well unlock it.
$flags = $this->assignment->get_user_flags($submission->userid, false);
if ($this->get_config('lock') && $flags && $flags->locked == 1) {
return;
}
$maharasubmission = $this->get_mahara_submission($submission->id);
if ($maharasubmission->viewstatus === self::STATUS_SUBMITTED) {
// Unlock view on Mahara side as it has been reverted to draft.
if ($this->release_submitted_view($maharasubmission->viewid, array(), $maharasubmission->iscollection) === false) {
throw new moodle_exception('errorrequest', 'assignsubmission_maharaws', '', $this->get_error());
}
$this->set_mahara_submission_status($submission->id, self::STATUS_RELEASED);
}
}
/**
* Check if submission has been made
*
* @param stdClass $submission
* @return bool
*/
public function is_empty(stdClass $submission) {
$maharasubmission = $this->get_mahara_submission($submission->id);
return empty($maharasubmission);
}
/**
* Gets the preview (popup) and link out for the portfolio
*
* @param string $name
* @param string|moodle_url $url
* @param string $title (Optional)
* @return string
*/
public function get_preview_url($name, $url, $title = null) {
global $OUTPUT, $PAGE;
$cm = $PAGE->cm;
$icon = $OUTPUT->pix_icon('t/preview', $name);
$params = array(
'title' => $title ?: $name,
'target' => '_blank',
'rel' => 'noopener noreferrer',
);
$url = new moodle_url('/mod/assign/submission/maharaws/launch.php', array('url' => $url, 'id' => $cm->id, 'sesskey' => sesskey()));
$popupicon = html_writer::link($url->out(false), $icon, $params + array(
'class' => 'portfolio',
));
$link = html_writer::link($url, $name, $params);
return "$popupicon $link";
}
/**
* Display the view of submission.
*
* @global stdClass $DB
* @global stdClass $USER
* @param stdClass $submission
* @return string
*/
public function view(stdClass $submission) {
global $PAGE, $OUTPUT, $DB, $USER;
$PAGE->requires->js('/mod/assign/submission/maharaws/js/popup.js');
$result = '';
$maharasubmission = $this->get_mahara_submission($submission->id);
if ($maharasubmission) {
$fields = array( 'assignment' => $submission->assignment );
if (!empty($submission->groupid)) {
$fields['groupid'] = $submission->groupid;
}
if (!empty($submission->userid)) {
$fields['userid'] = $submission->userid;
}
$lastattempt = $DB->get_field('assign_submission', 'max(attemptnumber)', $fields);
if ($submission->attemptnumber < $lastattempt) {
$result .= get_string('previousattemptsnotvisible', 'assignsubmission_maharaws');
} else {
// Either the page is viewed by the author or access code has been issued.
return $this->get_preview_url($maharasubmission->viewtitle, $maharasubmission->viewurl);
}
}
return $result;
}
/**
* @see parent
*
* @param stdClass $submission
* @param bool $showviewlink (Mutable)
* @return string
*/
public function view_summary(stdClass $submission, &$showviewlink) {
return $this->view($submission);
}
/**
* Return true if this plugin can upgrade an old Moodle 2.2 assignment of this type and version.
*
* @param string $type old assignment subtype
* @param int $version old assignment version
* @return bool True if upgrade is possible
*/