-
Notifications
You must be signed in to change notification settings - Fork 41
/
lib.php
1079 lines (1074 loc) · 38.2 KB
/
lib.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Library of interface functions and constants for module emarking
* All the core Moodle functions, neeeded to allow the module to work
* integrated in Moodle should be placed here.
* All the emarking specific functions, needed to implement all the module
* logic, should go to locallib.php. This will help to save some memory when
* Moodle is performing actions across all modules.
*
* @package mod_emarking
* @copyright 2013-2015 Jorge Villalón
* @copyright 2014 Nicolas Perez <niperez@alumnos.uai.cl>
* @copyright 2014 Carlos Villarroel <cavillarroel@alumnos.uai.cl>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined ( 'MOODLE_INTERNAL' ) || die ();
// EMarking type.
define ( 'EMARKING_TYPE_PRINT_ONLY', 0 );
define ( 'EMARKING_TYPE_ON_SCREEN_MARKING', 1 );
define ( 'EMARKING_TYPE_MARKER_TRAINING', 2 );
define ( 'EMARKING_TYPE_STUDENT_TRAINING', 3 );
define ( 'EMARKING_TYPE_PEER_REVIEW', 4 );
define ( 'EMARKING_TYPE_PRINT_SCAN', 5 );
// Emarking upload type
define ( 'EMARKING_UPLOAD_QR', 10 );
define ( 'EMARKING_UPLOAD_FILE', 20 );
define ( 'EMARKING_UPLOAD_TEXT', 30 );
define ( 'EMARKING_UPLOAD_HTML', 40 );
// Print orders status.
define ( 'EMARKING_EXAM_UPLOADED', 10 );
define ( 'EMARKING_EXAM_ERROR_PROCESSING', 12 );
define ( 'EMARKING_EXAM_BEING_PROCESSED', 13 );
define ( 'EMARKING_EXAM_PROCESSED', 18 );
define ( 'EMARKING_EXAM_SENT_TO_PRINT', 20 );
define ( 'EMARKING_EXAM_ERROR_PRINTING', 22 );
define ( 'EMARKING_EXAM_PRINTED', 30 );
// Anonymous definitions.
define ( 'EMARKING_ANON_STUDENT', 0 );
define ( 'EMARKING_ANON_BOTH', 1 );
define ( 'EMARKING_ANON_NONE', 2 );
define ( 'EMARKING_ANON_MARKER', 3 );
// Justice perception status.
define ( 'EMARKING_JUSTICE_DISABLED', 0 );
define ( 'EMARKING_JUSTICE_PER_SUBMISSION', 2 );
define ( 'EMARKING_JUSTICE_PER_CRITERION', 3 );
// Grading status.
define ( 'EMARKING_STATUS_MISSING', 0 ); // Not submitted.
define ( 'EMARKING_STATUS_ABSENT', 5 ); // Absent.
define ( 'EMARKING_STATUS_SUBMITTED', 10 ); // Submitted.
define ( 'EMARKING_STATUS_GRADING', 15 ); // Feedback generated.
define ( 'EMARKING_STATUS_PUBLISHED', 20 ); // Feedback generated.
define ( 'EMARKING_STATUS_REGRADING', 30 ); // Student did not accept. asked for regrade.
define ( 'EMARKING_STATUS_REGRADING_RESPONDED', 35 ); // Regrades were processed.
define ( 'EMARKING_STATUS_ACCEPTED', 40 ); // Student accepted the submission.
// Regrade motives.
define ( 'EMARKING_REGRADE_MISASSIGNED_SCORE', 1 );
define ( 'EMARKING_REGRADE_UNCLEAR_FEEDBACK', 2 );
define ( 'EMARKING_REGRADE_STATEMENT_PROBLEM', 3 );
define ( 'EMARKING_REGRADE_ERROR_CARRIED_FORWARD', 4 );
define ( 'EMARKING_REGRADE_CORRECT_ALTERNATIVE_ANSWER', 5 );
define ( 'EMARKING_REGRADE_OTHER', 10 );
// Answer key status.
define ( 'EMARKING_ANSWERKEY_NONE', 0 );
define ( 'EMARKING_ANSWERKEY_REQUESTED', 10 );
define ( 'EMARKING_ANSWERKEY_REJECTED', 20 );
define ( 'EMARKING_ANSWERKEY_ACCEPTED', 30 );
// Digitized answers status.
define ( 'EMARKING_DIGITIZED_ANSWER_MISSING', 0 );
define ( 'EMARKING_DIGITIZED_ANSWER_UPLOADED', 10 );
define ( 'EMARKING_DIGITIZED_ANSWER_BEING_PROCESSED', 20 );
define ( 'EMARKING_DIGITIZED_ANSWER_ERROR_PROCESSING', 30 );
define ( 'EMARKING_DIGITIZED_ANSWER_PROCESSED', 40 );
// Download exams security levels.
define ( 'EMARKING_SECURITY_NO_VALIDATION', 0 );
define ( 'EMARKING_SECURITY_TOKEN_EMAIL', 10 );
define ( 'EMARKING_SECURITY_TOKEN_SMS', 20 );
// Types of page´s layout
define ( 'EMARKING_PAGES_LAYOUT_STANDARD', 0 );
define ( 'EMARKING_PAGES_LAYOUT_EMBEDDED', 10 );
// Marking buttons in Emarking interface.
define ( 'EMARKING_BUTTON_COMMENT', 1 );
define ( 'EMARKING_BUTTON_RUBRIC', 2 );
define ( 'EMARKING_BUTTON_TICK', 3 );
define ( 'EMARKING_BUTTON_CROSS', 4 );
define ( 'EMARKING_BUTTON_PEN', 5 );
define ( 'EMARKING_BUTTON_QUESTION', 6 );
define ( 'EMARKING_BUTTON_HIGHLIGHT', 7 );
// Reports.
define ( 'EMARKING_REPORT_FEEDBACK', 1 );
define ( 'EMARKING_REPORT_GRADES', 2 );
define ( 'EMARKING_REPORT_MARKING', 3 );
define ( 'EMARKING_REPORT_RANKING', 4 );
define ( 'EMARKING_REPORT_OUTCOMES', 5 );
define ( 'EMARKING_REPORT_JUSTICE', 6 );
// Moodle core API.
/**
* Returns the information on whether the module supports a feature
*
* @see plugin_supports() in lib/moodlelib.php
* @param string $feature
* FEATURE_xx constant for requested feature
* @return mixed true if the feature is supported, null if unknown
*/
function emarking_supports($feature) {
switch ($feature) {
case FEATURE_GRADE_HAS_GRADE :
return true;
case FEATURE_ADVANCED_GRADING :
return true;
case FEATURE_GRADE_OUTCOMES :
return true;
case FEATURE_RATE :
return false;
default :
return null;
}
}
/**
* Returns the available EMarking types in this server
*
* @param string $enabled
* filter by only those that are enabled
* @return string[]
*/
function emarking_types_array($filterenabled = false) {
global $CFG;
$types = array ();
if (isset ( $CFG->emarking_enabledtypes )) {
$allowed = explode ( ',', $CFG->emarking_enabledtypes );
} else {
$allowed = array ();
}
// All available types
$types [EMARKING_TYPE_PRINT_ONLY] = get_string ( 'type_print_only', 'mod_emarking' );
$types [EMARKING_TYPE_PRINT_SCAN] = get_string ( 'type_print_scan', 'mod_emarking' );
$types [EMARKING_TYPE_ON_SCREEN_MARKING] = get_string ( 'type_normal', 'mod_emarking' );
$types [EMARKING_TYPE_MARKER_TRAINING] = get_string ( 'type_markers_training', 'mod_emarking' );
$types [EMARKING_TYPE_PEER_REVIEW] = get_string ( 'type_peer_review', 'mod_emarking' );
$types [EMARKING_TYPE_STUDENT_TRAINING] = get_string ( 'type_student_training', 'mod_emarking' );
if ($filterenabled) {
foreach ( $types as $typekey => $typename ) {
if (array_search ( $typekey, $allowed ) === FALSE) {
unset ( $types [$typekey] );
}
}
}
return $types;
}
/**
* Returns the available EMarking ipload types in this server
*
* @param string $enabled
* filter by only those that are enabled
* @return string[]
*/
function emarking_uploadtypes_array($filterenabled = false) {
global $CFG;
$types = array ();
if (isset ( $CFG->emarking_enableduploadtypes )) {
$allowed = explode ( ',', $CFG->emarking_enableduploadtypes );
} else {
$allowed = array ();
}
// All available types
$types [EMARKING_UPLOAD_QR] = get_string ( 'uploadtype_qr', 'mod_emarking' );
$types [EMARKING_UPLOAD_HTML] = get_string ( 'uploadtype_html', 'mod_emarking' );
$types [EMARKING_UPLOAD_TEXT] = get_string ( 'uploadtype_text', 'mod_emarking' );
$types [EMARKING_UPLOAD_FILE] = get_string ( 'uploadtype_file', 'mod_emarking' );
if ($filterenabled) {
foreach ( $types as $typekey => $typename ) {
if (array_search ( $typekey, $allowed ) === FALSE) {
unset ( $types [$typekey] );
}
}
}
return $types;
}
/**
* Saves a new instance of the emarking into the database
* Given an object containing all the necessary data,
* (defined by the form in mod_form.php) this function
* will create a new instance and return the id number
* of the new instance.
*
* @param object $emarking
* An object from the form in mod_form.php
* @param mod_emarking_mod_form $mform
* @return int The id of the newly inserted emarking record
*/
function emarking_add_instance(stdClass $data, mod_emarking_mod_form $mform = null) {
global $DB, $CFG, $COURSE, $USER;
$data->timecreated = time ();
$id = $DB->insert_record ( 'emarking', $data );
$data->id = $id;
emarking_grade_item_update ( $data );
if ($data->type == EMARKING_TYPE_MARKER_TRAINING || ! $mform) {
return $id;
}
if ($data->type == EMARKING_TYPE_PEER_REVIEW && isset ( $data->importemarking ) && $data->importemarking > 0) {
$data->parent = $data->importemarking;
$data->copiedfromparent = 0;
$DB->update_record ( 'emarking', $data );
return $id;
}
foreach ( $data as $k => $v ) {
$parts = explode ( '-', $k );
if (count ( $parts ) > 1 && $parts [0] === 'marker') {
$markerid = intval ( $parts [1] );
$marker = new stdClass ();
$marker->emarking = $id;
$marker->marker = $markerid;
$marker->qualitycontrol = 1;
$DB->insert_record ( 'emarking_markers', $marker );
}
}
if ($data->uploadtype != EMARKING_UPLOAD_QR) {
return $id;
}
$context = context_course::instance ( $COURSE->id );
$examid = 0;
// If there's no previous exam to associate, and we are creating a new
// EMarking, we need the PDF file.
if ($data->exam == 0) {
$examfiles = emarking_validate_exam_files_from_draft ();
if (count ( $examfiles ) == 0) {
throw new Exception ( 'Invalid PDF exam files' );
}
$numpages = $examfiles [0] ['numpages'];
} else {
$examid = $data->exam;
}
$studentsnumber = emarking_get_students_count_for_printing ( $COURSE->id );
// A new exam object is created and its attributes filled from form data.
if ($examid == 0) {
$exam = new stdClass ();
$exam->course = $COURSE->id;
$exam->courseshortname = $COURSE->shortname;
$exam->name = $mform->get_data ()->name;
$exam->examdate = $mform->get_data ()->examdate;
$exam->emarking = $id;
$exam->headerqr = isset ( $mform->get_data ()->headerqr ) ? 1 : 0;
$exam->printrandom = isset ( $mform->get_data ()->printrandom ) ? 1 : 0;
$exam->printlist = isset ( $mform->get_data ()->printlist ) ? 1 : 0;
$exam->extrasheets = $mform->get_data ()->extrasheets;
$exam->extraexams = $mform->get_data ()->extraexams;
$exam->usebackside = isset ( $mform->get_data ()->printdoublesided ) ? 1 : 0;
if ($examid == 0) {
$exam->timecreated = time ();
}
$exam->timemodified = time ();
$exam->requestedby = $USER->id;
$exam->totalstudents = $studentsnumber;
$exam->comment = $mform->get_data ()->comment;
// Get the enrolments as a comma separated values.
$enrollist = array ();
if (! empty ( $mform->get_data ()->enrolments )) {
$enrolments = $mform->get_data ()->enrolments;
foreach ( $enrolments as $key => $enrolment ) {
if (! empty ( $enrolment )) {
$enrollist [] = $key;
}
}
}
$exam->enrolments = implode ( ",", $enrollist );
$exam->printdate = 0;
$exam->status = EMARKING_EXAM_UPLOADED;
// Calculate total pages for exam.
$exam->totalpages = $numpages;
$exam->printingcost = emarking_get_category_cost ( $COURSE->id );
$exam->id = $DB->insert_record ( 'emarking_exams', $exam );
$fs = get_file_storage ();
foreach ( $examfiles as $exampdf ) {
// Save the submitted file to check if it's a PDF.
$filerecord = array (
'component' => 'mod_emarking',
'filearea' => 'exams',
'contextid' => $context->id,
'itemid' => $exam->id,
'filepath' => '/',
'filename' => $exampdf ['filename']
);
$file = $fs->create_file_from_pathname ( $filerecord, $exampdf ['pathname'] );
}
// Update exam object to store the PDF's file id.
$exam->file = $file->get_id ();
if (! $DB->update_record ( 'emarking_exams', $exam )) {
$fs->delete_area_files ( $contextid, 'emarking', 'exams', $exam->id );
print_error ( get_string ( 'errorsavingpdf', 'mod_emarking' ) );
}
// If it is a multi-course submission, insert several exams.
if (! empty ( $mform->get_data ()->multicourse )) {
$multicourse = $mform->get_data ()->multicourse;
foreach ( $multicourse as $key => $mcourse ) {
if (! empty ( $key )) {
if ($thiscourse = $DB->get_record ( 'course', array (
'shortname' => $key
) )) {
$studentsnumber = emarking_get_students_count_for_printing ( $thiscourse->id );
list ( $newemarkingid, $newcmid, $sectionid ) = emarking_copy_to_cm ( $data, $thiscourse->id );
$newexam = $exam;
$newexam->id = null;
$newexam->totalstudents = $studentsnumber;
$newexam->course = $thiscourse->id;
$newexam->courseshortname = $thiscourse->shortname;
$newexam->emarking = $newemarkingid;
$newexam->id = $DB->insert_record ( 'emarking_exams', $newexam );
$thiscontext = context_course::instance ( $thiscourse->id );
// Create file records for all new exams.
foreach ( $examfiles as $exampdf ) {
// Save the submitted file to check if it's a PDF.
$filerecord = array (
'component' => 'mod_emarking',
'filearea' => 'exams',
'contextid' => $thiscontext->id,
'itemid' => $newexam->id,
'filepath' => '/',
'filename' => $exampdf ['filename']
);
$file = $fs->create_file_from_pathname ( $filerecord, $exampdf ['pathname'] );
}
}
}
}
}
} else {
$exam = $DB->get_record ( "emarking_exams", array (
"id" => $examid
) );
$exam->emarking = $id;
$exam->timemodified = time ();
$DB->update_record ( 'emarking_exams', $exam );
}
$headerqr = isset ( $mform->get_data ()->headerqr ) ? 1 : 0;
setcookie ( "emarking_headerqr", $headerqr, time () + 3600 * 24 * 365 * 10, '/' );
$defaultexam = new stdClass ();
$defaultexam->headerqr = $exam->headerqr;
$defaultexam->printrandom = $exam->printrandom;
$defaultexam->printlist = $exam->printlist;
$defaultexam->extrasheets = $exam->extrasheets;
$defaultexam->extraexams = $exam->extraexams;
$defaultexam->usebackside = $exam->usebackside;
$defaultexam->enrolments = $exam->enrolments;
setcookie ( "emarking_exam_defaults", json_encode ( $defaultexam ), time () + 3600 * 24 * 365 * 10, '/' );
return $id;
}
/**
* Creates a copy of the emarking in the database.
*
* @param unknown $originalemarking
* @return boolean|multitype:unknown NULL Ambigous <boolean, number>
*/
function emarking_copy_to_cm($originalemarking, $destinationcourse) {
global $CFG, $DB;
require_once ($CFG->dirroot . "/course/lib.php");
require_once ($CFG->dirroot . "/mod/emarking/mod_form.php");
$emarkingmod = $DB->get_record ( 'modules', array (
'name' => 'emarking'
) );
$emarking = new stdClass ();
$emarking = $originalemarking;
$emarking->id = null;
$emarking->course = $destinationcourse;
$emarking->id = emarking_add_instance ( $emarking );
// Add coursemodule.
$mod = new stdClass ();
$mod->course = $destinationcourse;
$mod->module = $emarkingmod->id;
$mod->instance = $emarking->id;
$mod->section = 0;
$mod->visible = 0; // Hide the forum.
$mod->visibleold = 0; // Hide the forum.
$mod->groupmode = 0;
$mod->grade = 100;
if (! $cmid = add_course_module ( $mod )) {
return false;
}
$sectionid = course_add_cm_to_section ( $mod->course, $cmid, 0 );
return array (
$emarking->id,
$cmid,
$sectionid
);
}
/**
* Updates an instance of the emarking in the database
* Given an object containing all the necessary data,
* (defined by the form in mod_form.php) this function
* will update an existing instance with new data.
*
* @param object|\stdClass $emarking
* An object from the form in mod_form.php
* @param mod_emarking_mod_form $mform
* @return boolean Success/Fail
*/
function emarking_update_instance(stdClass $emarking, mod_emarking_mod_form $mform = null) {
global $DB, $CFG, $COURSE;
if ($emarking->type != EMARKING_TYPE_MARKER_TRAINING && $emarking->uploadtype == EMARKING_UPLOAD_QR) {
// If there is NO exam for the emarking activity and the user selected she
// wouldn't use a previous exam there is something wrong.
if ((! $exam = $DB->get_record ( "emarking_exams", array (
"emarking" => $emarking->instance
) )) && $mform->get_data ()->exam == 0) {
return false;
}
// If there is NO exam with the id selected by the user there is something wrong
// (When the emarking already has an exam, the data comes in a hidden field.
if (! $exam = $DB->get_record ( "emarking_exams", array (
"id" => $mform->get_data ()->exam
) )) {
return false;
}
// We update the exam row.
$exam->name = $emarking->name;
$exam->comment = $mform->get_data ()->comment;
$exam->emarking = $emarking->instance;
$DB->update_record ( "emarking_exams", $exam );
}
if (! isset ( $mform->get_data ()->linkrubric )) {
$emarking->linkrubric = 0;
}
if (! isset ( $mform->get_data ()->collaborativefeatures )) {
$emarking->collaborativefeatures = 0;
}
if (! isset ( $mform->get_data ()->enableduedate )) {
$emarking->markingduedate = null;
}
if (! isset ( $mform->get_data ()->enablescan )) {
$emarking->enablescan = 0;
}
if (! isset ( $mform->get_data ()->enableosm )) {
$emarking->enableosm = 0;
}
$emarking->introformat = FORMAT_HTML;
$emarking->timemodified = time ();
$emarking->id = $emarking->instance;
$ret = $DB->update_record ( 'emarking', $emarking );
emarking_grade_item_update ( $emarking );
return $ret;
}
/**
* Removes an instance of the emarking from the database
* Given an ID of an instance of this module,
* this function will permanently delete the instance
* and any data that depends on it.
*
* @param int $id
* Id of the module instance
* @return boolean Success/Failure
*/
function emarking_delete_instance($id) {
global $DB;
if (! $emarking = $DB->get_record ( 'emarking', array (
'id' => $id
) )) {
return false;
}
$exam = $DB->get_record ( "emarking_exams", array (
"emarking" => $id
) );
// If we have an associated exam that was already sent to print
// we can't delete the e-marking activity.
if ($exam && $exam->status >= EMARKING_EXAM_SENT_TO_PRINT) {
throw new moodle_exception ( "emarking/cannotdeleteprintedemarking", "An already printed emarking activity can not be deleted." );
}
// Delete dependent records.
$tran = $DB->start_delegated_transaction ();
if (! $DB->delete_records ( 'emarking_marker_criterion', array (
'emarking' => $emarking->id
) )) {
$tran->rollback ( new Exception ( 'Could not delete marker_criterion objects' ) );
return false;
}
if (! $DB->delete_records ( 'emarking_markers', array (
'emarking' => $emarking->id
) )) {
$tran->rollback ( new Exception ( 'Could not delete markers objects' ) );
return false;
}
if (! $DB->delete_records ( 'emarking_predefined_comment', array (
'emarkingid' => $emarking->id
) )) {
$tran->rollback ( new Exception ( 'Could not delete predefined comment objects' ) );
return false;
}
$submissions = $DB->get_records ( 'emarking_submission', array (
'emarking' => $emarking->id
) );
foreach ( $submissions as $submission ) {
if (! $DB->delete_records ( 'emarking_perception', array (
'submission' => $submission->id
) )) {
$tran->rollback ( new Exception ( 'Could not delete perception objects' ) );
return false;
}
$drafts = $DB->get_records ( 'emarking_draft', array (
'submissionid' => $submission->id
) );
foreach ( $drafts as $draft ) {
if (! $DB->delete_records ( 'emarking_regrade', array (
'draft' => $draft->id
) )) {
$tran->rollback ( new Exception ( 'Could not delete regrade objects' ) );
return false;
}
$pages = $DB->get_records ( 'emarking_page', array (
'submission' => $submission->id
) );
foreach ( $pages as $page ) {
if (! $DB->delete_records ( 'emarking_page_criterion', array (
'page' => $page->id,
'emarking' => $emarking->id
) )) {
$tran->rollback ( new Exception ( 'Could not delete page_criterion objects' ) );
return false;
}
if (! $DB->delete_records ( 'emarking_comment', array (
'page' => $page->id,
'draft' => $draft->id
) )) {
$tran->rollback ( new Exception ( 'Could not delete comment objects' ) );
return false;
}
if (! $DB->delete_records ( 'emarking_page', array (
'id' => $page->id
) )) {
$tran->rollback ( new Exception ( 'Could not delete page object' ) );
return false;
}
}
if (! $DB->delete_records ( 'emarking_draft', array (
'id' => $draft->id
) )) {
$tran->rollback ( new Exception ( 'Could not delete draft object' ) );
return false;
}
}
if (! $DB->delete_records ( 'emarking_submission', array (
'id' => $submission->id
) )) {
$tran->rollback ( new Exception ( 'Could not delete submission object' ) );
return false;
}
}
if (! $DB->delete_records ( 'emarking_exams', array (
'emarking' => $emarking->id
) )) {
$tran->rollback ( new Exception ( 'Could not delete emarking_exam object' ) );
return false;
}
if (! $DB->delete_records ( 'emarking', array (
'id' => $emarking->id
) )) {
$tran->rollback ( new Exception ( 'Could not delete emarking object' ) );
return false;
}
$tran->allow_commit ();
// We do not delete exams for DB purposes.
return true;
}
/**
* Returns a small object with summary information about what a
* user has done with a given particular instance of this module
* Used for user activity reports.
* $return->time = the time they did it
* $return->info = a short text description
*
* @param
* $course
* @param
* $user
* @param
* $mod
* @param
* $emarking
* @return stdClass|null
*/
function emarking_user_outline($course, $user, $mod, $emarking) {
$return = new stdClass ();
$return->time = 0;
$return->info = '';
return $return;
}
/**
* Prints a detailed representation of what a user has done with
* a given particular instance of this module, for user activity reports.
*
* @param stdClass $course
* the current course record
* @param stdClass $user
* the record of the user we are generating report for
* @param cm_info $mod
* course module info
* @param stdClass $emarking
* the module instance record
* @return void, is supposed to echp directly
*/
function emarking_user_complete($course, $user, $mod, $emarking) {
}
/**
* Given a course and a time, this module should find recent activity
* that has occurred in emarking activities and print it out.
* Return true if there was output, or false is there was none.
*
* @return boolean
*/
function emarking_print_recent_activity($course, $viewfullnames, $timestart) {
return false; // True if anything was printed, otherwise false.
}
/**
* Prepares the recent activity data
* This callback function is supposed to populate the passed array with
* custom activity records.
* These records are then rendered into HTML via
* {@link emarking_print_recent_mod_activity()}.
*
* @param array $activities
* sequentially indexed array of objects with the 'cmid' property
* @param int $index
* the index in the $activities to use for the next record
* @param int $timestart
* append activity since this time
* @param int $courseid
* the id of the course we produce the report for
* @param int $cmid
* course module id
* @param int $userid
* check for a particular user's activity only, defaults to 0 (all users)
* @param int $groupid
* check for a particular group's activity only, defaults to 0 (all groups)
* @return void adds items into $activities and increases $index
*/
function emarking_get_recent_mod_activity(&$activities, &$index, $timestart, $courseid, $cmid, $userid = 0, $groupid = 0) {
}
/**
* Prints single activity item prepared by {@see emarking_get_recent_mod_activity()}
*
* @return void
*/
function emarking_print_recent_mod_activity($activity, $courseid, $detail, $modnames, $viewfullnames) {
}
/**
* Function to be run periodically according to the moodle cron
* This function searches for things that need to be done, such
* as sending out mail, toggling flags etc .
* ..
*
* @return boolean
* @todo Finish documenting this function
*/
function emarking_cron() {
return true;
}
/**
* Returns all other caps used in the module
*
* @example return array('moodle/site:accessallgroups');
* @return array
*/
function emarking_get_extra_capabilities() {
return array ();
}
// Gradebook API.
/**
* Is a given scale used by the instance of emarking?
* This function returns if a scale is being used by one emarking
* if it has support for grading and scales.
* Commented code should be
* modified if necessary. See forum, glossary or journal modules
* as reference.
*
* @param int $emarkingid
* ID of an instance of this module
* @return bool true if the scale is used by the given emarking instance
*/
function emarking_scale_used($emarkingid, $scaleid) {
global $DB;
return false;
}
/**
* Checks if scale is being used by any instance of emarking.
* This is used to find out if scale used anywhere.
*
* @param $scaleid int
* @return boolean true if the scale is used by any emarking instance
*/
function emarking_scale_used_anywhere($scaleid) {
return false;
}
/**
* Validates if the draft files uploaded by a user are valid PDF exams
*
* @return array list of valid PDF exam files
*/
function emarking_validate_exam_files_from_draft() {
global $USER, $COURSE;
// We get the draftid from the form.
$draftid = file_get_submitted_draft_itemid ( 'exam_files' );
$usercontext = context_user::instance ( $USER->id );
$fs = get_file_storage ();
$files = $fs->get_area_files ( $usercontext->id, 'user', 'draft', $draftid );
$tempdir = emarking_get_temp_dir_path ( $COURSE->id );
emarking_initialize_directory ( $tempdir, true );
$numpagesprevious = - 1;
$exampdfs = array ();
foreach ( $files as $uploadedfile ) {
if ($uploadedfile->is_directory () || $uploadedfile->get_mimetype () !== 'application/pdf') {
continue;
}
$filename = $uploadedfile->get_filename ();
$filename = emarking_clean_filename ( $filename );
$newfilename = $tempdir . '/' . $filename;
$pdffile = emarking_get_path_from_hash ( $tempdir, $uploadedfile->get_pathnamehash () );
// Executes pdftk burst to get all pages separated.
$numpages = emarking_pdf_count_pages ( $newfilename, $tempdir, false );
$exampdfs [] = array (
'pathname' => $pdffile,
'filename' => $filename,
'numpages' => $numpages
);
}
return $exampdfs;
}
/**
* Creates or updates grade item for the give emarking instance
* Needed by grade_update_mod_grades() in lib/gradelib.php
*
* @param stdClass $emarking
* instance object with extra cmidnumber and modname property
* @param null $grades
* @return int 0 if ok, error code otherwise
*/
function emarking_grade_item_update(stdClass $emarking, $grades = null) {
global $CFG;
require_once ($CFG->libdir . '/gradelib.php');
require_once ($CFG->dirroot . '/mod/emarking/marking/locallib.php');
if ($grades == null) {
emarking_calculate_grades_users ( $emarking );
}
$params = array ();
$params ['itemname'] = clean_param ( $emarking->name, PARAM_NOTAGS );
$params ['gradetype'] = GRADE_TYPE_VALUE;
$params ['grademax'] = $emarking->grade;
$params ['grademin'] = $emarking->grademin;
if ($grades === 'reset') {
$params ['reset'] = true;
$grades = null;
}
$ret = grade_update ( 'mod/emarking', $emarking->course, 'mod', 'emarking', $emarking->id, 0, $grades, $params );
emarking_publish_all_grades ( $emarking );
return $ret;
}
/**
* Update emarking grades in the gradebook
* Needed by grade_update_mod_grades() in lib/gradelib.php
*
* @param stdClass $emarking
* instance object with extra cmidnumber and modname property
* @param int $userid
* update grade of specific user only, 0 means all participants
* @param bool $nullifnone
* not used in emarking.
* @return void
*/
function emarking_update_grades(stdClass $emarking, $userid = 0, $nullifnone = true) {
global $CFG;
require_once ($CFG->libdir . '/gradelib.php');
if ($emarking->grade == 0) {
emarking_grade_item_update ( $emarking );
} else if ($grades = emarking_get_user_grades ( $emarking, $userid )) {
foreach ( $grades as $k => $v ) {
$grades [$k]->rawgrade = null;
}
emarking_grade_item_update ( $emarking, $grades );
} else {
emarking_grade_item_update ( $emarking );
}
}
/**
* Get emarking grades in a format compatible with the gradebook
*
* @param
* $emarking
* @param int $userid
* @return array
*/
function emarking_get_user_grades($emarking, $userid = 0) {
global $DB, $CFG;
require_once ($CFG->dirroot . '/grade/grading/lib.php');
emarking_calculate_grades_users ( $emarking, $userid );
$gradebookgrades = array ();
$params = array (
'emarking' => $emarking->id
);
if ($userid > 0) {
$params ['student'] = $userid;
}
$submissions = $DB->get_records ( 'emarking_submission', $params );
foreach ( $submissions as $submission ) {
$gradebookgrade = new stdClass ();
$gradebookgrade->userid = $submission->student;
$gradebookgrade->datesubmitted = $submission->timecreated;
$gradebookgrade->rawgrade = $submission->grade;
$gradebookgrade->usermodified = $submission->teacher;
$gradebookgrade->dategraded = $submission->timemodified;
$gradebookgrades [$submission->student] = $gradebookgrade;
}
return $gradebookgrades;
}
/**
* Removes all grades from gradebook
*
* @param int $courseid
* The ID of the course to reset
* @param string $type
* Optional type of assignment to limit the reset to a particular assignment type
*/
function emarking_reset_gradebook($courseid, $type = '') {
global $CFG, $DB;
$params = array (
'moduletype' => 'emarking',
'courseid' => $courseid
);
$sql = 'SELECT a.*, cm.idnumber as cmidnumber, a.course as courseid
FROM {assign} a, {course_modules} cm, {modules} m
WHERE m.name=:moduletype AND m.id=cm.module AND cm.instance=a.id AND a.course=:courseid';
if ($emarkings = $DB->get_records_sql ( $sql, $params )) {
foreach ( $emarkings as $emarking ) {
emarking_grade_item_update ( $emarking, 'reset' );
}
}
}
/**
* Lists all gradable areas for the advanced grading methods framework
*
* @return array('string'=>'string') An array with area names as keys and descriptions as values
*/
function emarking_grading_areas_list() {
return array (
'attempt' => get_string ( 'attempt', 'mod_emarking' )
);
}
// File API.
/**
* Returns the lists of all browsable file areas within the given module context
* The file area 'intro' for the activity introduction field is added automatically
* by {@link file_browser::get_file_info_context_module()}
*
* @param stdClass $course
* @param stdClass $cm
* @param stdClass $context
* @return array of [(string)filearea] => (string)description
*/
function emarking_get_file_areas($course, $cm, $context) {
return array ();
}
/**
* File browsing support for emarking file areas
*
* @package mod_emarking
* @category files
* @param file_browser $browser
* @param array $areas
* @param stdClass $course
* @param stdClass $cm
* @param stdClass $context
* @param string $filearea
* @param int $itemid
* @param string $filepath
* @param string $filename
* @return file_info instance or null if not found
*/
function emarking_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) {
return null;
}
/**
* Serves the files from the emarking file areas
*
* @package mod_emarking
* @category files
* @param stdClass $course
* the course object
* @param stdClass $cm
* the course module object
* @param stdClass $context
* the emarking's context
* @param string $filearea
* the name of the file area
* @param array $args
* extra arguments (itemid, path)
* @param bool $forcedownload
* whether or not force download
* @param array $options
* additional options affecting the file serving
*/
function emarking_pluginfile($course, $cm, $context, $filearea, array $args, $forcedownload, array $options = array()) {
global $DB, $CFG, $USER;
require_once ($CFG->dirroot . '/mod/emarking/locallib.php');
require_once ($CFG->dirroot . '/mod/emarking/print/locallib.php');
// send_file defaults.
$lifetime = null;
$filter = 0;
$pathisstring = false;
$forcedownload = false;
$mimetype = '';
$dontdie = false;
$directdownload = isset ( $CFG->emarking_downloadsecurity ) && $CFG->emarking_downloadsecurity == EMARKING_SECURITY_NO_VALIDATION;
// end of send_file defaults.
$filename = array_pop ( $args );
$itemid = array_pop ( $args );
if ($filearea !== 'instructions') {
require_login ();
$contextcourse = context_course::instance ( $course->id );
$contextcategory = context_coursecat::instance ( $course->category );
}
if ($filearea === 'instructions') {
$lifetime = 60 * 60 * 24 * 36500;
}
// Downloading digitized answers requires uploadexam permission on activity.
if ($filearea === 'upload') {
if (! has_capability ( 'mod/emarking:uploadexam', $context )) {
send_file_not_found ();
}
}
// Security! We always protect the exams filearea.
if ($filearea === 'exams') {
send_file_not_found ();
}
if ($filearea === 'pages') {
$parts = explode ( '-', $filename );
if (count ( $parts ) != 3) {
send_file_not_found ();
}
if (! ($parts [0] === intval ( $parts [0] ) . "") || ! ($parts [1] === intval ( $parts [1] ) . "")) {
send_file_not_found ();
}
$subparts = explode ( '.', $parts [2] );
$isanonymous = substr ( $subparts [0], - strlen ( '_a' ) ) === '_a';
$imageuser = intval ( $parts [0] );
$usercangrade = has_capability ( 'mod/emarking:grade', $context );
$bothenrolled = is_enrolled ( $contextcourse ) && is_enrolled ( $contextcourse, $imageuser );
if ($USER->id != $imageuser && // If user does not owns the image.
! $usercangrade && // And can not grade.
! $isanonymous && // And we are not in anonymous mode.
! is_siteadmin ( $USER ) && // And the user is not admin.
! $bothenrolled) {
send_file_not_found ();
}
}
if ($filearea === 'response') {
$parts = explode ( '_', $filename );
if (count ( $parts ) != 3) {
send_file_not_found ();
}
if (! ($parts [0] === "response") || ! ($parts [1] === intval ( $parts [1] ) . "")) {
send_file_not_found ();
}
$subparts = explode ( '.', $parts [2] );
$draftid = intval ( $subparts [0] );
if (! $draft = $DB->get_record ( 'emarking_draft', array (
'id' => $draftid
) )) {
send_file_not_found ();
}
if (! $submission = $DB->get_record ( 'emarking_submission', array (
'id' => $draft->submissionid
) )) {
send_file_not_found ();
}
$emarkingid = intval ( $parts [1] );
if (! $emarking = $DB->get_record ( 'emarking', array (
'id' => $emarkingid
) )) {
send_file_not_found ();
}
if ($submission->student != $USER->id && ! is_siteadmin ( $USER ) && ! has_capability ( 'mod/emarking:supervisegrading', $context )) {
send_file_not_found ();
}
$forcedownload = true;
$mimetype = 'application/pdf';
}
if ($filearea === 'examstoprint') {