forked from compilatio/moodle-plagiarism_compilatio
-
Notifications
You must be signed in to change notification settings - Fork 0
/
lib.php
1199 lines (1112 loc) · 55.7 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/>.
/**
* lib.php - Contains Plagiarism plugin specific functions called by Modules.
*
* @since 2.0
* @package plagiarism_compilatio
* @subpackage plagiarism
* @author Dan Marsden <dan@danmarsden.com>
* @copyright 2012 Dan Marsden http://danmarsden.com
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
if (!defined('MOODLE_INTERNAL')) {
die('Direct access to this script is forbidden.'); // It must be included from a Moodle page.
}
// Get global class.
global $CFG;
require_once($CFG->dirroot.'/plagiarism/lib.php');
require_once($CFG->dirroot . '/plagiarism/compilatio/compilatio.class.php');
define('COMPILATIO_MAX_SUBMISSION_ATTEMPTS', 6); // Max num to try and send a submission to Compilatio.
define('COMPILATIO_MAX_SUBMISSION_DELAY', 60); // Max time to wait between submissions (defined in minutes).
define('COMPILATIO_SUBMISSION_DELAY', 15); // Initial wait time, doubled each time until max_submission_delay is met.
define('COMPILATIO_MAX_STATUS_ATTEMPTS', 10); // Maximum number of times to try and obtain the status of a submission.
define('COMPILATIO_MAX_STATUS_DELAY', 1440); // Maximum time to wait between checks (defined in minutes).
define('COMPILATIO_STATUS_DELAY', 30); // Initial wait time, doubled each time a until the max_status_delay is met.
define('COMPILATIO_STATUSCODE_ACCEPTED', '202');
define('COMPILATIO_STATUSCODE_ANALYSING', '203');
define('COMPILATIO_STATUSCODE_BAD_REQUEST', '400');
define('COMPILATIO_STATUSCODE_NOT_FOUND', '404');
define('COMPILATIO_STATUSCODE_UNSUPPORTED', '415');
define('COMPILATIO_STATUSCODE_UNEXTRACTABLE', '416');
define('COMPILATIO_STATUSCODE_TOO_LARGE', '413');
define('COMPILATIO_STATUSCODE_COMPLETE', 'Analyzed');
define('COMPILATIO_ANALYSISTYPE_AUTO', 0); // File shoud be processed as soon as the file is sent.
define('COMPILATIO_ANALYSISTYPE_MANUAL', 1); // File processed when teacher manually decides to.
define('COMPILATIO_ANALYSISTYPE_PROG', 2); // File processed on set time/date.
define('PLAGIARISM_COMPILATIO_SHOW_NEVER', 0);
define('PLAGIARISM_COMPILATIO_SHOW_ALWAYS', 1);
define('PLAGIARISM_COMPILATIO_SHOW_CLOSED', 2);
define('PLAGIARISM_COMPILATIO_DRAFTSUBMIT_IMMEDIATE', 0);
define('PLAGIARISM_COMPILATIO_DRAFTSUBMIT_FINAL', 1);
// Compilatio Class.
class plagiarism_plugin_compilatio extends plagiarism_plugin {
/**
* This function should be used to initialise settings and check if plagiarism is enabled.
* *
* @return mixed - false if not enabled, or returns an array of relevant settings.
*/
public function get_settings() {
global $DB;
static $plagiarismsettings;
if (!empty($plagiarism_settings) || $plagiarismsettings === false) {
return $plagiarismsettings;
}
$plagiarismsettings = (array)get_config('plagiarism');
// Check if compilatio enabled.
if (isset($plagiarismsettings['compilatio_use']) && $plagiarismsettings['compilatio_use']) {
// Now check to make sure required settings are set!
if (empty($plagiarismsettings['compilatio_api'])) {
error("Compilatio API URL not set!");
}
return $plagiarismsettings;
} else {
return false;
}
}
/**
* function which returns an array of all the module instance settings.
*
* @return array
*
*/
public function config_options() {
return array('use_compilatio', 'compilatio_show_student_score', 'compilatio_show_student_report',
'compilatio_draft_submit', 'compilatio_studentemail', 'compilatio_timeanalyse', 'compilatio_analysistype');
}
/**
* hook to allow plagiarism specific information to be displayed beside a submission.
* @param array $linkarraycontains all relevant information for the plugin to generate a link.
* @return string
*
*/
public function get_links($linkarray) {
global $DB, $USER, $COURSE, $OUTPUT, $CFG, $PAGE;
$cmid = $linkarray['cmid'];
$userid = $linkarray['userid'];
if (!empty($linkarray['content'])) {
$filename = "content-" . $COURSE->id . "-" . $cmid . "-". $userid . ".htm";
$filepath = $CFG->dataroot."/temp/compilatio/" . $filename;
$file = new stdclass();
$file->type = "tempcompilatio";
$file->filename = $filename;
$file->timestamp = time();
$file->identifier = sha1($linkarray['content']);
$file->filepath = $filepath;
} else if (!empty($linkarray['file'])) {
$file = new stdclass();
$file->filename = $linkarray['file']->get_filename();
$file->timestamp = time();
$file->identifier = $linkarray['file']->get_contenthash();
$file->filepath = $linkarray['file']->get_filepath();
}
$results = $this->get_file_results($cmid, $userid, $file);
if (empty($results)) {
// Info about this file is not available to this user.
return '';
}
$modulecontext = context_module::instance($cmid);
$output = '';
$trigger = optional_param('compilatioprocess', 0, PARAM_INT);
if ($results['statuscode'] == COMPILATIO_STATUSCODE_ACCEPTED && $trigger == $results['pid']) {
if (has_capability('plagiarism/compilatio:triggeranalysis', $modulecontext)) {
// Trigger manual analysis call.
$plagiarism_file = compilatio_get_plagiarism_file($cmid, $userid, $file);
$analyse = compilatio_startanalyse($plagiarism_file);
if ($analyse === true) {
// Update plagiarism record.
$plagiarism_file->statuscode = COMPILATIO_STATUSCODE_ANALYSING;
$DB->update_record('plagiarism_compilatio_files', $plagiarism_file);
$output .= '<span class="plagiarismreport">'.
'<img src="'.$OUTPUT->pix_url('inprogress', 'plagiarism_compilatio') .
'" alt="'.get_string('processing', 'plagiarism_compilatio').'" '.
'" title="'.get_string('processing', 'plagiarism_compilatio').'" />'.
'</span>';
} else {
$output .= '<span class="plagiarismreport">'.
'</span>';
}
return $output;
}
}
if ($results['statuscode'] == 'pending') {
// TODO: check to make sure there is a pending event entry for this file - if not add one.
$output .= '<span class="plagiarismreport">'.
'<img src="'.$OUTPUT->pix_url('inprogress', 'plagiarism_compilatio') .
'" alt="'.get_string('pending', 'plagiarism_compilatio').'" '.
'" title="'.get_string('pending', 'plagiarism_compilatio').'" />'.
'</span>';
return $output;
}
if ($results['statuscode'] == 'Analyzed') {
// Normal situation - Compilatio has successfully analyzed the file.
$rank = compilatio_get_css_rank($results['score']);
$output .= '<span class="plagiarismreport">';
if (!empty($results['reporturl'])) {
// User is allowed to view the report
// Score is contained in report, so they can see the score too.
$output .= '<a href="'.$results['reporturl'].'" target="_blank">';
$output .= '<span class="compilatioanalysis_icon"><img src="'.$OUTPUT->pix_url('tick', 'plagiarism_compilatio').
'" alt="'.get_string('startanalysis', 'plagiarism_compilatio').'" '.
'" title="'.get_string('startanalysis', 'plagiarism_compilatio').'" /></span>';
$output .= '<span class="compilatioanalysis_text">'.get_string('similarity', 'plagiarism_compilatio') . ':</span>';
$output .= '<span class="'.$rank.'">'.$results['score'].'%</span>';
$output .= '</a>';
} else if ($results['score'] !== '') {
// User is allowed to view only the score.
$output .= get_string('similarity', 'plagiarism_compilatio') . ':';
$output .= '<span class="' . $rank . '">' . $results['score'] . '%</span>';
}
if (!empty($results['renamed'])) {
$output .= $results['renamed'];
}
$output .= '</span>';
} else if ($results['statuscode'] == COMPILATIO_STATUSCODE_ACCEPTED) {
//check if this is a timed release and add hourglass image.
$plagiarismvalues = $DB->get_records_menu('plagiarism_compilatio_config', array('cm'=>$cmid), '', 'name, value');
// Check settings to see if we need to tell compilatio to process this file now.
$output .= '<span class="plagiarismreport">';
if (has_capability('plagiarism/compilatio:triggeranalysis', $modulecontext)) {
$url = new moodle_url($PAGE->url, array('compilatioprocess' => $results['pid']));
$action = optional_param('action', '', PARAM_TEXT); // Hack to add action to params for mod/assign.
if (!empty($action)) {
$url->param('action', $action);
}
$output .= "<span class='compilatiostartanalysis'><a href='$url'>";
$output .= '<span class="compilatiostartanalysis_icon"><img src="'.$OUTPUT->pix_url('control_play_blue', 'plagiarism_compilatio').
'" alt="'.get_string('startanalysis', 'plagiarism_compilatio').'" '.
'" title="'.get_string('startanalysis', 'plagiarism_compilatio').'" /></span>';
$output .= "<span class='compilatiostartanalysis_text'>".get_string('startanalysis', 'plagiarism_compilatio')."</span>";
$output .= "</a></span>";
} else if ($plagiarismvalues['compilatio_analysistype'] == COMPILATIO_ANALYSISTYPE_PROG) {
$output .= '<img src="'.$OUTPUT->pix_url('hourglass', 'plagiarism_compilatio').
'" alt="'.get_string('waitingforanalysis', 'plagiarism_compilatio', userdate($plagiarismvalues['compilatio_timeanalyse'])).'" '.
'" title="'.get_string('waitingforanalysis', 'plagiarism_compilatio', userdate($plagiarismvalues['compilatio_timeanalyse'])).'" />';
} else {
$output .= '<img src="'.$OUTPUT->pix_url('inprogress', 'plagiarism_compilatio') .
'" alt="'.get_string('processing', 'plagiarism_compilatio').'" '.
'" title="'.get_string('processing', 'plagiarism_compilatio').'" />';
}
$output .= '</span>';
} else if ($results['statuscode'] == COMPILATIO_STATUSCODE_ANALYSING) {
$output .= '<span class="plagiarismreport">'.
'<img src="'.$OUTPUT->pix_url('inprogress', 'plagiarism_compilatio') .
'" alt="'.get_string('processing', 'plagiarism_compilatio').'" '.
'" title="'.get_string('processing', 'plagiarism_compilatio').'" />'.
'</span>';
} else if ($results['statuscode'] == COMPILATIO_STATUSCODE_UNSUPPORTED) {
$output .= '<span class="plagiarismreport">'.
'<img src="'.$OUTPUT->pix_url('exclamation', 'plagiarism_compilatio') .
'" alt="'.get_string('unsupportedfiletype', 'plagiarism_compilatio').'" '.
'" title="'.get_string('unsupportedfiletype', 'plagiarism_compilatio').'" />'.
'</span>';
} else if ($results['statuscode'] == COMPILATIO_STATUSCODE_TOO_LARGE) {
$output .= '<span class="plagiarismreport">'.
'<img src="'.$OUTPUT->pix_url('exclamation', 'plagiarism_compilatio') .
'" alt="'.get_string('toolarge', 'plagiarism_compilatio').'" '.
'" title="'.get_string('toolarge', 'plagiarism_compilatio').'" />'.
'</span>';
} else if ($results['statuscode'] == COMPILATIO_STATUSCODE_UNEXTRACTABLE) {
$output .= '<span class="plagiarismreport">'.
'<img src="'.$OUTPUT->pix_url('exclamation', 'plagiarism_compilatio') .
'" alt="'.get_string('unextractablefile', 'plagiarism_compilatio').'" '.
'" title="'.get_string('unextractablefile', 'plagiarism_compilatio').'" />'.
'</span>';
} else {
$title = get_string('unknownwarning', 'plagiarism_compilatio');
$reset = '';
if (has_capability('plagiarism/compilatio:resetfile', $modulecontext) &&
!empty($results['error'])) { // This is a teacher viewing the responses.
// Strip out some possible known text to tidy it up.
$erroresponse = format_text($results['error'], FORMAT_PLAIN);
$erroresponse = str_replace('{"LocalisedMessage":"', '', $erroresponse);
$erroresponse = str_replace('","Message":null}', '', $erroresponse);
$title .= ': ' . $erroresponse;
$url = new moodle_url('/plagiarism/compilatio/reset.php',
array('cmid'=>$cmid, 'pf'=>$results['pid'], 'sesskey'=>sesskey()));
$reset = "<a href='$url'>".get_string('reset')."</a>";
}
$output .= '<span class="plagiarismreport">'.
'<img src="'.$OUTPUT->pix_url('exclamation', 'plagiarism_compilatio') .
'" alt="'.get_string('unknownwarning', 'plagiarism_compilatio').'" '.
'" title="'.$title.'" />'.$reset.'</span>';
}
return $output;
}
public function get_file_results($cmid, $userid, $file) {
global $DB, $USER, $COURSE, $CFG;
$plagiarismsettings = $this->get_settings();
if (empty($plagiarismsettings)) {
// Compilatio is not enabled.
return false;
}
$plagiarismvalues = compilatio_cm_use($cmid);
if (empty($plagiarismvalues)) {
// Compilatio not enabled for this cm.
return false;
}
// Collect detail about the specified coursemodule.
$filehash = $file->identifier;
$modulesql = 'SELECT m.id, m.name, cm.instance'.
' FROM {course_modules} cm' .
' INNER JOIN {modules} m on cm.module = m.id ' .
'WHERE cm.id = ?';
$moduledetail = $DB->get_record_sql($modulesql, array($cmid));
if (!empty($moduledetail)) {
$sql = "SELECT * FROM " . $CFG->prefix . $moduledetail->name . " WHERE id= ?";
$module = $DB->get_record_sql($sql, array($moduledetail->instance));
}
if (empty($module)) {
// No such cmid.
return false;
}
$modulecontext = context_module::instance($cmid);
// If the user has permission to see result of all items in this course module.
$viewscore = $viewreport = has_capability('plagiarism/compilatio:viewreport', $modulecontext);
// Determine if the activity is closed.
// If report is closed, this can make the report available to more users.
$assignclosed = false;
$time = time();
if (!empty($module->preventlate) && !empty($module->timedue)) {
$assignclosed = ($module->timeavailable <= $time && $time <= $module->timedue);
} else if (!empty($module->timeavailable)) {
$assignclosed = ($module->timeavailable <= $time);
}
// Under certain circumstances, users are allowed to see plagiarism info
// even if they don't have view report capability.
if ($USER->id == $userid) {
$selfreport = true;
if (isset($plagiarismvalues['compilatio_show_student_report']) &&
($plagiarismvalues['compilatio_show_student_report']== PLAGIARISM_COMPILATIO_SHOW_ALWAYS ||
$plagiarismvalues['compilatio_show_student_report']== PLAGIARISM_COMPILATIO_SHOW_CLOSED && $assignclosed)) {
$viewreport = true;
}
if (isset($plagiarismvalues['compilatio_show_student_score']) &&
($plagiarismvalues['compilatio_show_student_score']== PLAGIARISM_COMPILATIO_SHOW_ALWAYS) ||
($plagiarismvalues['compilatio_show_student_score']== PLAGIARISM_COMPILATIO_SHOW_CLOSED && $assignclosed)) {
$viewscore = true;
}
} else {
$selfreport = false;
}
// End of rights checking.
if (!$viewscore && !$viewreport && $selfreport) {
// User is not permitted to see any details.
return false;
}
$plagiarismfile = $DB->get_record_sql(
"SELECT * FROM {plagiarism_compilatio_files}
WHERE cm = ? AND userid = ? AND " .
"identifier = ?",
array($cmid, $userid, $filehash));
if (empty($plagiarismfile)) {
// No record of that submitted file.
return false;
}
// Returns after this point will include a result set describing information about
// interactions with compilatio servers.
$results = array('statuscode' => '', 'error' => '', 'reporturl' => '',
'score' => '', 'pid' => '', 'renamed' => '',
'analyzed' => 0,
);
if ($plagiarismfile->statuscode == 'pending') {
$results['statuscode'] = 'pending';
return $results;
}
// Now check for differing filename and display info related to it.
$previouslysubmitted = '';
if ($file->filename !== $plagiarismfile->filename) {
$previouslysubmitted = '<span class="prevsubmitted">('.get_string('previouslysubmitted', 'plagiarism_compilatio').
': '.$plagiarismfile->filename.')</span>';
}
$results['statuscode'] = $plagiarismfile->statuscode;
$results['pid'] = $plagiarismfile->id;
$results['error'] = $plagiarismfile->errorresponse;
if ($plagiarismfile->statuscode=='Analyzed') {
$results['analyzed'] = 1;
// File has been successfully analyzed - return all appropriate details.
if ($viewscore || $viewreport) {
// If user can see the report, they can see the score on the report
// so make it directly available.
$results['score'] = $plagiarismfile->similarityscore;
}
if ($viewreport) {
$results['reporturl'] = $plagiarismfile->reporturl;
}
$results['renamed'] = $previouslysubmitted;
}
return $results;
}
/* hook to save plagiarism specific settings on a module settings page.
* @param object $data - data from an mform submission.
*/
public function save_form_elements($data) {
global $DB;
if (!$this->get_settings()) {
return;
}
if (isset($data->use_compilatio)) {
// Array of possible plagiarism config options.
$plagiarismelements = $this->config_options();
// First get existing values.
$existingelements = $DB->get_records_menu('plagiarism_compilatio_config',
array('cm'=>$data->coursemodule), '', 'name, id');
foreach ($plagiarismelements as $element) {
$newelement = new object();
$newelement->cm = $data->coursemodule;
$newelement->name = $element;
$newelement->value = (isset($data->$element) ? $data->$element : 0);
if (isset($existingelements[$element])) { // Update.
$newelement->id = $existingelements[$element];
$DB->update_record('plagiarism_compilatio_config', $newelement);
} else { // Insert.
$DB->insert_record('plagiarism_compilatio_config', $newelement);
}
}
//check if we are changing from timed or manual to instant
//if changing to instant, make all existing files to get a report.
if (isset($existingelements['compilatio_analysistype']) && $existingelements['compilatio_analysistype'] !== $data->compilatio_analysistype &&
$data->compilatio_analysistype == COMPILATIO_ANALYSISTYPE_AUTO) {
//get all existing files in this assignment set to manual status
$plagiarismfiles = $DB->get_records('plagiarism_compilatio_files',
array('cm'=>$data->coursemodule, 'statuscode'=>COMPILATIO_STATUSCODE_ACCEPTED));
compilatio_analyse_files($plagiarismfiles);
}
}
}
/**
* hook to add plagiarism specific settings to a module settings page.
* @param object $mform - Moodle form
* @param object $context - current context
*/
public function get_form_elements_module($mform, $context, $modulename = "") {
global $CFG, $DB, $COURSE;
$plagiarismsettings = $this->get_settings();
if (!$plagiarismsettings) {
return;
}
// Hack to prevent this from showing on custom compilatioassignment type.
if ($mform->elementExists('seuil_faible')) {
return;
}
$cmid = optional_param('update', 0, PARAM_INT); // We can't access $this->_cm here.
if (!empty($modulename)) {
$modname = 'compilatio_enable_' . $modulename;
if (empty($plagiarismsettings[$modname])) {
return; // Return if compilatio is not enabled for the module
}
}
if (!empty($cmid)) {
$plagiarismvalues = $DB->get_records_menu('plagiarism_compilatio_config', array('cm'=>$cmid), '', 'name, value');
}
// The cmid(0) is the default list.
$plagiarismdefaults = $DB->get_records_menu('plagiarism_compilatio_config', array('cm'=>0), '', 'name, value');
$plagiarismelements = $this->config_options();
if (has_capability('plagiarism/compilatio:enable', $context)) {
compilatio_get_form_elements($mform);
if ($mform->elementExists('compilatio_draft_submit')) {
if ($mform->elementExists('var4')) {
$mform->disabledIf('compilatio_draft_submit', 'var4', 'eq', 0);
}
else if ($mform->elementExists('submissiondrafts')) {
$mform->disabledIf('compilatio_draft_submit', 'submissiondrafts', 'eq', 0);
}
}
// Disable all plagiarism elements if use_plagiarism eg 0.
foreach ($plagiarismelements as $element) {
if ($element <> 'use_compilatio') { // Ignore this var.
$mform->disabledIf($element, 'use_compilatio', 'eq', 0);
}
}
} else { // Add plagiarism settings as hidden vars.
foreach ($plagiarismelements as $element) {
$mform->addElement('hidden', $element);
}
}
// Now set defaults.
foreach ($plagiarismelements as $element) {
if (isset($plagiarismvalues[$element])) {
$mform->setDefault($element, $plagiarismvalues[$element]);
} else if (isset($plagiarismdefaults[$element])) {
$mform->setDefault($element, $plagiarismdefaults[$element]);
}
}
}
/**
* hook to allow a disclosure to be printed notifying users what will happen with their submission.
* @param int $cmid - course module id
* @return string
*/
public function print_disclosure($cmid) {
global $OUTPUT;
$outputhtml = '';
$compilatiouse = compilatio_cm_use($cmid);
$plagiarismsettings = $this->get_settings();
if (!empty($plagiarismsettings['compilatio_student_disclosure']) &&
!empty($compilatiouse)) {
$outputhtml .= $OUTPUT->box_start('generalbox boxaligncenter', 'intro');
$formatoptions = new stdClass;
$formatoptions->noclean = true;
$outputhtml .= format_text($plagiarismsettings['compilatio_student_disclosure'], FORMAT_MOODLE, $formatoptions);
$outputhtml .= $OUTPUT->box_end();
}
return $outputhtml;
}
/**
* hook to allow status of submitted files to be updated - called on grading/report pages.
*
* @param object $course - full Course object
* @param object $cm - full cm object
* @return string
*/
public function update_status($course, $cm) {
global $PAGE, $OUTPUT, $DB;
if (!compilatio_cm_use($cm->id)) {
return '';
}
$output = '';
$update = optional_param('compilatioupdate', '', PARAM_BOOL);
if ($update) {
$sql = "cm = ? AND (statuscode = ? OR statuscode = ?)";
$params = array($cm->id, COMPILATIO_STATUSCODE_COMPLETE, COMPILATIO_STATUSCODE_ANALYSING);
$plagiarism_files = $DB->get_records_select('plagiarism_compilatio_files', $sql, $params);
foreach ($plagiarism_files as $pf) {
compilatio_check_analysis($pf);
}
$output .= $OUTPUT->notification(get_string('updatedanalysis', 'plagiarism_compilatio'), 'notifysuccess');
}
$url = $PAGE->url;
$url->param('compilatioupdate', true);
$url->param('action', optional_param('action', '', PARAM_TEXT)); //add action to params for mod_assign page.
$sql = "select value from {plagiarism_compilatio_config} where cm=? and name='use_compilatio'";
$active_compilatio = $DB->get_record_sql($sql, array($cm->id));
if($active_compilatio->value == 1) {
$output .= "<span class='compilatioupdate'>".$OUTPUT->single_button($url, get_string('updatecompilatioanalysis', 'plagiarism_compilatio'))."</span>";
}
return $output;
}
/**
* called by admin/cron.php
*
*/
public function cron() {
global $CFG, $DB;
// Do any scheduled task stuff.
compilatio_update_allowed_filetypes();
if ($plagiarismsettings = $this->get_settings()) {
compilatio_get_scores($plagiarismsettings);
}
// Now check for any assignments with a scheduled processing time that is after now.
$sql = "SELECT cf.* FROM {plagiarism_compilatio_files} cf
LEFT JOIN {plagiarism_compilatio_config} cc1 ON cc1.cm = cf.cm
LEFT JOIN {plagiarism_compilatio_config} cc2 ON cc2.cm = cf.cm
LEFT JOIN {plagiarism_compilatio_config} cc3 ON cc3.cm = cf.cm
WHERE cf.statuscode = '".COMPILATIO_STATUSCODE_ACCEPTED."'
AND cc1.name = 'use_compilatio' AND cc1.value='1'
AND cc2.name = 'compilatio_analysistype' AND cc2.value = '".COMPILATIO_ANALYSISTYPE_PROG."'
AND cc3.name = 'compilatio_timeanalyse'
AND " . $DB->sql_cast_char2int('cc3.value'). " < ?";
$plagiarismfiles = $DB->get_records_sql($sql, array(time()));
compilatio_analyse_files($plagiarismfiles);
}
/**
* generic handler function for all events - triggers sending of files.
* @return boolean
*/
public function event_handler($eventdata) {
global $DB, $CFG;
$supported_events = compilatio_supported_events();
if (!in_array($eventdata->eventtype, $supported_events)) {
return true; // Don't need to handle this event.
}
$plagiarismsettings = $this->get_settings();
if (!$plagiarismsettings) {
return true;
}
$cmid = (!empty($eventdata->cm->id)) ? $eventdata->cm->id : $eventdata->cmid;
$plagiarismvalues = $DB->get_records_menu('plagiarism_compilatio_config', array('cm'=>$cmid), '', 'name, value');
if (empty($plagiarismvalues['use_compilatio'])) {
// Compilatio not in use for this cm - return.
return true;
}
// Check if the module associated with this event still exists.
if (!$DB->record_exists('course_modules', array('id' => $eventdata->cmid))) {
return true;
}
if ($eventdata->eventtype == 'files_done' ||
$eventdata->eventtype == 'content_done') {
// Assignment-specific functionality:
// This is a 'finalize' event. No files from this event itself,
// but need to check if files from previous events need to be submitted for processing.
mtrace("finalise");
$result = true;
if (isset($plagiarismvalues['compilatio_draft_submit']) &&
$plagiarismvalues['compilatio_draft_submit'] == PLAGIARISM_COMPILATIO_DRAFTSUBMIT_FINAL) {
// Any files attached to previous events were not submitted.
// These files are now finalized, and should be submitted for processing.
if ($eventdata->modulename == 'assignment') {
require_once("$CFG->dirroot/mod/assignment/lib.php"); // Hack to include filelib so that file_storage class is available
// We need to get a list of files attached to this assignment and put them in an array, so that
// We can submit each of them for processing
$assignmentbase = new assignment_base($cmid);
$submission = $assignmentbase->get_submission($eventdata->userid);
$modulecontext = module_context::instance($eventdata->cmid);
$fs = get_file_storage();
if ($files = $fs->get_area_files($modulecontext->id, 'mod_assignment', 'submission', $submission->id, "timemodified", false)) {
foreach ($files as $file) {
$sendresult = compilatio_send_file($cmid, $eventdata->userid, $file, $plagiarismsettings);
$result = $result && $sendresult;
}
}
}
else if ($eventdata->modulename == 'assign') {
require_once("$CFG->dirroot/mod/assign/locallib.php");
$modulecontext = context_module::instance($eventdata->cmid);
$fs = get_file_storage();
if ($files = $fs->get_area_files($modulecontext->id, 'assignsubmission_file', ASSIGNSUBMISSION_FILE_FILEAREA, $eventdata->itemid, "id", false)) {
foreach ($files as $file) {
$sendresult = compilatio_send_file($cmid, $eventdata->userid, $file, $plagiarismsettings);
$result = $result && $sendresult;
}
}
$submission = $DB->get_record('assignsubmission_onlinetext', array('submission'=>$eventdata->itemid));
if (!empty($submission)) {
$eventdata->content = trim(format_text($submission->onlinetext, $submission->onlineformat, array('context'=>$modulecontext)));
$file = compilatio_create_temp_file($cmid, $eventdata);
$sendresult = compilatio_send_file($cmid, $eventdata->userid, $file, $plagiarismsettings);
$result = $result && $sendresult;
unlink($file->filepath); //Delete temp file.
}
}
}
return $result;
}
if (isset($plagiarismvalues['compilatio_draft_submit']) &&
$plagiarismvalues['compilatio_draft_submit'] == PLAGIARISM_COMPILATIO_DRAFTSUBMIT_FINAL) {
// Assignment-specific functionality:
// Files should only be sent for checking once "finalized".
return true;
}
// Text is attached
$result = true;
if (!empty($eventdata->content)) {
$file = compilatio_create_temp_file($cmid, $eventdata);
$sendresult = compilatio_send_file($cmid, $eventdata->userid, $file, $plagiarismsettings);
$result = $result && $sendresult;
unlink($file->filepath);
}
// Normal situation: 1 or more assessable files attached to event, ready to be checked:
if (!empty($eventdata->pathnamehashes)) {
foreach ($eventdata->pathnamehashes as $hash) {
$fs = get_file_storage();
$efile = $fs->get_file_by_hash($hash);
if (empty($efile)) {
mtrace("nofilefound!");
continue;
} else if ($efile->get_filename() ==='.') {
// This 'file' is actually a directory - nothing to submit.
continue;
}
$sendresult = compilatio_send_file($cmid, $eventdata->userid, $efile, $plagiarismsettings);
$result = $result && $sendresult;
}
}
return $result;
}
public function compilatio_send_student_email($plagiarism_file) {
global $DB, $CFG;
if (empty($plagiarism_file->userid)) { // Sanity check.
return false;
}
$user = $DB->get_record('user', array('id'=>$plagiarism_file->userid));
$site = get_site();
$a = new stdClass();
$cm = get_coursemodule_from_id('', $plagiarism_file->cm);
$a->modulename = format_string($cm->name);
$a->modulelink = $CFG->wwwroot.'/mod/'.$cm->modname.'/view.php?id='.$cm->id;
$a->coursename = format_string($DB->get_field('course', 'fullname', array('id'=>$cm->course)));
$emailsubject = get_string('studentemailsubject', 'plagiarism_compilatio');
$emailcontent = get_string('studentemailcontent', 'plagiarism_compilatio', $a);
email_to_user($user, $site->shortname, $emailsubject, $emailcontent);
}
}
function compilatio_create_temp_file($cmid, $eventdata) {
global $CFG;
if (!check_dir_exists($CFG->dataroot."/temp/compilatio", true, true)) {
mkdir($CFG->dataroot."/temp/compilatio", 0700);
}
$filename = "content-" . $eventdata->courseid . "-" . $cmid . "-" . $eventdata->userid . ".htm";
$filepath = $CFG->dataroot."/temp/compilatio/" . $filename;
$fd = fopen($filepath, 'wb'); // Create if not exist, write binary
fwrite($fd, $eventdata->content);
fclose($fd);
$file = new stdclass();
$file->type = "tempcompilatio";
$file->filename = $filename;
$file->timestamp = time();
$file->identifier = sha1_file($filepath);
$file->filepath = $filepath;
return $file;
}
function compilatio_event_file_uploaded($eventdata) {
$eventdata->eventtype = 'file_uploaded';
$compilatio = new plagiarism_plugin_compilatio();
return $compilatio->event_handler($eventdata);
}
function compilatio_event_files_done($eventdata) {
$eventdata->eventtype = 'files_done';
$compilatio = new plagiarism_plugin_compilatio();
return $compilatio->event_handler($eventdata);
}
function compilatio_event_content_uploaded($eventdata) {
$eventdata->eventtype = 'content_uploaded';
$compilatio = new plagiarism_plugin_compilatio();
return $compilatio->event_handler($eventdata);
}
function compilatio_event_content_done($eventdata) {
$eventdata->eventtype = 'content_done';
$compilatio = new plagiarism_plugin_compilatio();
return $compilatio->event_handler($eventdata);
}
function compilatio_event_mod_created($eventdata) {
$result = true;
// A new module has been created - this is a generic event that is called for all module types
// make sure you check the type of module before handling if needed.
return $result;
}
function compilatio_event_mod_updated($eventdata) {
$result = true;
// A module has been updated - this is a generic event that is called for all module types
// make sure you check the type of module before handling if needed.
return $result;
}
function compilatio_event_mod_deleted($eventdata) {
$result = true;
// A module has been deleted - this is a generic event that is called for all module types
// make sure you check the type of module before handling if needed.
return $result;
}
function compilatio_supported_events() {
$supported_events = array('file_uploaded', 'files_done', 'content_uploaded', 'content_done');
return $supported_events;
}
/**
* adds the list of plagiarism settings to a form.
*
* @param object $mform - Moodle form object
* @oaram boolean $defaults - if this is being loaded from defaults form or from inside a mod.
*/
function compilatio_get_form_elements($mform, $defaults=false) {
$ynoptions = array(0 => get_string('no'),
1 => get_string('yes'));
$tiioptions = array(0 => get_string("never"),
1 => get_string("always"),
2 => get_string("showwhenclosed", "plagiarism_compilatio"));
$compilatiodraftoptions = array(
PLAGIARISM_COMPILATIO_DRAFTSUBMIT_IMMEDIATE => get_string("submitondraft", "plagiarism_compilatio"),
PLAGIARISM_COMPILATIO_DRAFTSUBMIT_FINAL => get_string("submitonfinal", "plagiarism_compilatio")
);
$mform->addElement('header', 'plagiarismdesc', get_string('compilatio', 'plagiarism_compilatio'));
$mform->addElement('select', 'use_compilatio', get_string("usecompilatio", "plagiarism_compilatio"), $ynoptions);
$analysistypes = array(COMPILATIO_ANALYSISTYPE_AUTO => get_string('analysistypeauto', 'plagiarism_compilatio'),
COMPILATIO_ANALYSISTYPE_MANUAL => get_string('analysistypemanual', 'plagiarism_compilatio'),
COMPILATIO_ANALYSISTYPE_PROG => get_string('analysistypeprog', 'plagiarism_compilatio'));
$mform->addElement('select', 'compilatio_analysistype', get_string('analysistype', 'plagiarism_compilatio'), $analysistypes);
$mform->addHelpButton('compilatio_analysistype', 'analysistype', 'plagiarism_compilatio');
$mform->setDefault('compilatio_analysistype', COMPILATIO_ANALYSISTYPE_AUTO);
if (!$defaults) { // Only show this inside a module page - not on default settings pages.
$mform->addElement('date_time_selector', 'compilatio_timeanalyse', get_string('analysisdate', 'plagiarism_compilatio'),
array('optional'=>false));
$mform->setDefault('compilatio_timeanalyse', time()+7*24*3600);
$mform->disabledif('compilatio_timeanalyse', 'compilatio_analysistype', 'noteq', COMPILATIO_ANALYSISTYPE_PROG);
}
$mform->addElement('select', 'compilatio_show_student_score',
get_string("compilatio_show_student_score", "plagiarism_compilatio"), $tiioptions);
$mform->addHelpButton('compilatio_show_student_score', 'compilatio_show_student_score', 'plagiarism_compilatio');
$mform->addElement('select', 'compilatio_show_student_report',
get_string("compilatio_show_student_report", "plagiarism_compilatio"), $tiioptions);
$mform->addHelpButton('compilatio_show_student_report', 'compilatio_show_student_report', 'plagiarism_compilatio');
if ($mform->elementExists('var4') ||
$mform->elementExists('submissiondrafts')) {
$mform->addElement('select', 'compilatio_draft_submit',
get_string("compilatio_draft_submit", "plagiarism_compilatio"), $compilatiodraftoptions);
}
$mform->addElement('select', 'compilatio_studentemail',
get_string("compilatio_studentemail", "plagiarism_compilatio"), $ynoptions);
$mform->addHelpButton('compilatio_studentemail', 'compilatio_studentemail', 'plagiarism_compilatio');
}
/**
* updates a compilatio_files record
*
* @param int $cmid - course module id
* @param int $userid - user id
* @param varied $identifier - identifier for this plagiarism record - hash of file, id of quiz question etc.
* @return int - id of compilatio_files record
*/
function compilatio_get_plagiarism_file($cmid, $userid, $file) {
global $DB;
$filehash = (!empty($file->identifier)) ? $file->identifier : $file->get_contenthash();
// Now update or insert record into compilatio_files.
$plagiarism_file = $DB->get_record_sql(
"SELECT * FROM {plagiarism_compilatio_files}
WHERE cm = ? AND userid = ? AND " .
"identifier = ?",
array($cmid, $userid, $filehash));
if (!empty($plagiarism_file)) {
return $plagiarism_file;
} else {
$plagiarism_file = new object();
$plagiarism_file->cm = $cmid;
$plagiarism_file->userid = $userid;
$plagiarism_file->identifier = $filehash;
$plagiarism_file->filename = (!empty($file->filename)) ? $file->filename : $file->get_filename();
$plagiarism_file->statuscode = 'pending';
$plagiarism_file->attempt = 0;
$plagiarism_file->timesubmitted = time();
if (!$pid = $DB->insert_record('plagiarism_compilatio_files', $plagiarism_file)) {
debugging("insert into compilatio_files failed");
}
$plagiarism_file->id = $pid;
return $plagiarism_file;
}
}
function compilatio_send_file($cmid, $userid, $file, $plagiarismsettings) {
global $DB;
$plagiarism_file = compilatio_get_plagiarism_file($cmid, $userid, $file);
// Check if $plagiarism_file actually needs to be submitted.
if ($plagiarism_file->statuscode <> 'pending') {
return true;
}
$filename = (!empty($file->filename)) ? $file->filename : $file->get_filename();
if ($plagiarism_file->filename !== $filename) {
// This is a file that was previously submitted and not sent to compilatio but the filename has changed so fix it.
$plagiarism_file->filename = $filename;
$DB->update_record('plagiarism_compilatio_files', $plagiarism_file);
}
// Check to see if this is a valid file.
$mimetype = compilatio_check_file_type($filename);
if (empty($mimetype)) {
$plagiarism_file->statuscode = COMPILATIO_STATUSCODE_UNSUPPORTED;
$DB->update_record('plagiarism_compilatio_files', $plagiarism_file);
return true;
}
// Check if we need to delay this submission.
$attemptallowed = compilatio_check_attempt_timeout($plagiarism_file);
if (!$attemptallowed) {
return false;
}
// Increment attempt number.
$plagiarism_file->attempt = $plagiarism_file->attempt+1;
$DB->update_record('plagiarism_compilatio_files', $plagiarism_file);
$compid = compilatio_send_file_to_compilatio($plagiarism_file, $plagiarismsettings, $file);
if ($compid !== false) {
$plagiarismvalues = $DB->get_records_menu('plagiarism_compilatio_config', array('cm'=>$cmid), '', 'name, value');
// Check settings to see if we need to tell compilatio to process this file now.
if ($plagiarismvalues['compilatio_analysistype'] == COMPILATIO_ANALYSISTYPE_AUTO) {
compilatio_startanalyse($plagiarism_file, $plagiarismsettings);
}
}
return false;
}
// Function to check timesubmitted and attempt to see if we need to delay an API check.
// Also checks max attempts to see if it has exceeded.
function compilatio_check_attempt_timeout($plagiarism_file) {
global $DB;
// The first time a file is submitted we don't need to wait at all.
if (empty($plagiarism_file->attempt) && $plagiarism_file->statuscode == 'pending') {
return true;
}
$now = time();
// Set some initial defaults.
$submissiondelay = 15;
$maxsubmissiondelay = 60;
$maxattempts = 4;
if ($plagiarism_file->statuscode == 'pending') {
// Initial wait time - doubled each time a check is made until the max delay is met.
$submissiondelay = COMPILATIO_SUBMISSION_DELAY;
// Maximum time to wait between submissions.
$maxsubmissiondelay = COMPILATIO_MAX_SUBMISSION_DELAY;
// Maximum number of times to try and send a submission.
$maxattempts = COMPILATIO_MAX_SUBMISSION_ATTEMPTS;
} else if ($plagiarism_file->statuscode ==COMPILATIO_STATUSCODE_ANALYSING) {
// Initial wait time - this is doubled each time a check is made until the max delay is met.
$submissiondelay = COMPILATIO_STATUS_DELAY;
// Maximum time to wait between checks.
$maxsubmissiondelay = COMPILATIO_MAX_STATUS_DELAY;
// Maximum number of times to try and send a submission.
$maxattempts = COMPILATIO_MAX_STATUS_ATTEMPTS;
}
$wait = $submissiondelay;
// Check if we have exceeded the max attempts.
if ($plagiarism_file->attempt > $maxattempts) {
$plagiarism_file->statuscode = 'timeout';
$DB->update_record('plagiarism_compilatio_files', $plagiarism_file);
return true; // Return true to cancel the event.
}
// Now calculate wait time.
$i= 0;
while ($i < $plagiarism_file->attempt) {
if ($wait > $maxsubmissiondelay) {
$wait = $maxsubmissiondelay;
}
$wait = $wait * $plagiarism_file->attempt;
$i++;
}
$wait = (int)$wait*60;
$timetocheck = (int)($plagiarism_file->timesubmitted +$wait);
// Calculate when this should be checked next.
if ($timetocheck < $now) {
return true;
} else {
return false;
}
}
function compilatio_send_file_to_compilatio(&$plagiarism_file, $plagiarismsettings, $file) {
global $DB, $CFG;
$filename = (!empty($file->filename)) ? $file->filename : $file->get_filename();
$mimetype = compilatio_check_file_type($filename);
if (empty($mimetype)) { // Sanity check on filetype - this should already have been checked.
debugging("no mime type for this file found.");
return false;
}
mtrace("sendfile".$plagiarism_file->id);
$compilatio = new compilatioservice($plagiarismsettings['compilatio_password'], $plagiarismsettings['compilatio_api'],
$CFG->proxyhost, $CFG->proxyport, $CFG->proxyuser, $CFG->proxypassword);
// Get name from module.
$modulesql = 'SELECT m.id, m.name, cm.instance'.
' FROM {course_modules} cm' .
' INNER JOIN {modules} m on cm.module = m.id ' .
'WHERE cm.id = ?';
$moduledetail = $DB->get_record_sql($modulesql, array($plagiarism_file->cm));
if (!empty($moduledetail)) {
$sql = "SELECT * FROM " . $CFG->prefix . $moduledetail->name . " WHERE id= ?";
$module = $DB->get_record_sql($sql, array($moduledetail->instance));
}
if (empty($module)) {
debugging("could not find this module - it may have been deleted?");
return false;
}
$name = format_string($module->name)."_".$plagiarism_file->cm;
$filecontents = (!empty($file->filepath)) ? file_get_contents($file->filepath) : $file->get_content();
$id_compi = $compilatio->SendDoc($name, // Title.
$name, // Description.
$filename, // File_name.
$mimetype, // Mime data.
$filecontents); // Doc content.
if (compilatio_valid_md5($id_compi)) {
$plagiarism_file->externalid = $id_compi;
$plagiarism_file->attempt = 0; // Reset attempts for status checks.
$plagiarism_file->statuscode = COMPILATIO_STATUSCODE_ACCEPTED;
$DB->update_record('plagiarism_compilatio_files', $plagiarism_file);
return $id_compi;
}
//correctif blocage moodle doc non extractable
$plagiarism_file->attempt = 0; // Reset attempts for status checks.
$plagiarism_file->statuscode = COMPILATIO_STATUSCODE_UNEXTRACTABLE;
$DB->update_record('plagiarism_compilatio_files', $plagiarism_file);
debugging("invalid compilatio response received - will try again later.".$id_compi);
// Invalid response returned - increment attempt value and return false to allow this to be called again.
return false;
}
// Function to check for the allowed file types, returns the mimetype that COMPILATIO expects.
function compilatio_check_file_type($filename) {
$pathinfo = pathinfo($filename);
if (empty($pathinfo['extension'])) {
return '';
}
$ext = strtolower($pathinfo['extension']);