-
Notifications
You must be signed in to change notification settings - Fork 65
/
lib.php
executable file
·1792 lines (1531 loc) · 76.6 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/>.
/**
* Required and general functions used by the plugin
*
* @package turnitintooltwo
* @copyright 2013 iParadigms LLC
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
global $CFG;
require_once(__DIR__.'/turnitintooltwo_assignment.class.php');
require_once(__DIR__.'/turnitintooltwo_class.class.php');
require_once($CFG->libdir . "/gradelib.php");
// Constants.
define('TURNITINTOOLTWO_MAX_FILE_UPLOAD_SIZE', 104857600);
define('TURNITINTOOLTWO_DEFAULT_PSEUDO_DOMAIN', '@tiimoodle.com');
define('TURNITINTOOLTWO_DEFAULT_PSEUDO_FIRSTNAME', get_string('defaultcoursestudent'));
define('TURNITINTOOLTWO_SUBMISSION_GET_LIMIT', 100);
define('TURNITINTOOLTWO_MAX_FILENAME_LENGTH', 180);
define('TURNITIN_COURSE_TITLE_LIMIT', 300);
define('TURNITIN_ASSIGNMENT_TITLE_LIMIT', 300);
define('MIGRATION_SUBMISSIONS_CUTOFF', 1000);
define('REPORT_GEN_SPEED_NUM_RESUBMISSIONS', 3);
define('REPORT_GEN_SPEED_NUM_HOURS', 24);
// Admin Repository constants.
define('ADMIN_REPOSITORY_OPTION_STANDARD', 0);
define('ADMIN_REPOSITORY_OPTION_EXPANDED', 1);
define('ADMIN_REPOSITORY_OPTION_FORCE_STANDARD', 2);
define('ADMIN_REPOSITORY_OPTION_FORCE_NO', 3);
define('ADMIN_REPOSITORY_OPTION_FORCE_INSTITUTIONAL', 4);
// Submit Papers to Repository constants.
define('SUBMIT_TO_NO_REPOSITORY', 0);
define('SUBMIT_TO_STANDARD_REPOSITORY', 1);
define('SUBMIT_TO_INSTITUTIONAL_REPOSITORY', 2);
// For use in course migration.
/**
* Returns the integration ids and labels.
* @return array Integration ids and labels.
*/
function turnitintooltwo_get_integration_ids() {
static $tiiintegrationids = [];
if (empty($tiiintegrationids)) {
$tiiintegrationids[0] = get_string('nointegration', 'turnitintooltwo');
$tiiintegrationids[1] = 'Blackboard Basic';
$tiiintegrationids[2] = 'WebCT';
$tiiintegrationids[5] = 'Angel';
$tiiintegrationids[6] = 'Moodle Basic';
$tiiintegrationids[7] = 'eCollege';
$tiiintegrationids[8] = 'Desire2Learn';
$tiiintegrationids[9] = 'Sakai';
$tiiintegrationids[12] = 'Moodle Direct';
$tiiintegrationids[13] = 'Blackboard Direct';
$tiiintegrationids[26] = 'LTI';
}
return $tiiintegrationids;
}
/**
* Function for either adding to log or triggering an event
* depending on Moodle version
* @param int $courseid Moodle course ID
* @param string $eventname The event we are logging
* @param string $link A link to the Turnitin activity
* @param string $desc Description of the logged event
* @param int $cmid Course module id
*/
function turnitintooltwo_add_to_log($courseid, $eventname, $link, $desc, $cmid, $userid = 0) {
global $USER;
$eventname = str_replace(' ', '_', $eventname);
$eventpath = '\mod_turnitintooltwo\event\\'.$eventname;
$data = array(
'objectid' => $cmid,
'context' => ( $cmid == 0 ) ? context_course::instance($courseid) : context_module::instance($cmid),
'other' => array('desc' => $desc)
);
if (!empty($userid) && ($userid != $USER->id)) {
$data['relateduserid'] = $userid;
}
$event = $eventpath::create($data);
$event->trigger();
}
/**
* @param string $feature FEATURE_xx constant for requested feature
* @return mixed True if module supports feature, null if doesn't know
*/
function turnitintooltwo_supports($feature) {
defined("FEATURE_SHOW_DESCRIPTION") or define("FEATURE_SHOW_DESCRIPTION", null);
switch($feature) {
case FEATURE_GROUPS:
case FEATURE_GROUPMEMBERSONLY:
case FEATURE_MOD_INTRO:
case FEATURE_COMPLETION_TRACKS_VIEWS:
case FEATURE_GRADE_HAS_GRADE:
case FEATURE_GRADE_OUTCOMES:
case FEATURE_BACKUP_MOODLE2:
case FEATURE_SHOW_DESCRIPTION:
case FEATURE_CONTROLS_GRADE_VISIBILITY:
return true;
default:
return null;
}
}
/**
* @return int the plugin version for use within the plugin.
*/
function turnitintooltwo_get_version() {
global $DB;
$version = $DB->get_record('config_plugins', array('plugin' => 'mod_turnitintooltwo', 'name' => 'version'));
return $version->value;
}
/**
* @return mixed the admin config settings for the plugin
*/
function turnitintooltwo_admin_config() {
return get_config('turnitintooltwo');
}
/**
* Log activity / errors
*
* @param string $string The string describing the activity
* @param string $activity The activity prompting the log
* e.g. PRINT_ERROR (default), API_ERROR, INCLUDE, REQUIRE_ONCE, REQUEST, REDIRECT
*/
function turnitintooltwo_activitylog($string, $activity) {
global $CFG;
static $config;
if (empty($config)) {
$config = turnitintooltwo_admin_config();
}
if ($config->enablediagnostic) {
// We only keep 10 log files, delete any additional files.
$prefix = "activitylog_";
$dirpath = $CFG->tempdir."/turnitintooltwo/logs";
if (!file_exists($dirpath)) {
mkdir($dirpath, 0777, true);
}
$dir = opendir($dirpath);
$files = array();
while ($entry = readdir($dir)) {
if (substr(basename($entry), 0, 1) != "." AND substr_count(basename($entry), $prefix) > 0) {
$files[] = basename($entry);
}
}
sort($files);
for ($i = 0; $i < count($files) - 10; $i++) {
unlink($dirpath."/".$files[$i]);
}
// Replace <br> tags with new line character.
$string = str_replace("<br/>", "\r\n", $string);
// Write to log file.
$filepath = $dirpath."/".$prefix.gmdate('Y-m-d', time()).".txt";
$file = fopen($filepath, 'a');
$output = date('Y-m-d H:i:s O')." (".$activity.")"." - ".$string."\r\n";
fwrite($file, $output);
fclose($file);
}
}
/**
* Needed for instance name update via quick update on the course home page
*
* @param stdClass $turnitintooltwo
* @param integer $userid
* @param boolean $nullifnone
*/
function turnitintooltwo_update_grades($turnitintooltwo, $userid = 0, $nullifnone = true) {
global $DB;
if ($userid != 0) {
return;
}
$turnitintooltwoassignment = new turnitintooltwo_assignment($turnitintooltwo->id);
try {
$turnitintooltwoassignment->edit_moodle_assignment(false);
} catch (Exception $e) {
turnitintooltwo_comms::handle_exceptions($e, 'turnitintooltwoupdateerror', false);
}
// Update events in the calendar.
$parts = $DB->get_records_select("turnitintooltwo_parts", " turnitintooltwoid = ? ",
array($turnitintooltwo->id), 'id ASC');
foreach ($parts as $part) {
turnitintooltwo_update_event($turnitintooltwo, $part, true);
}
}
/**
* Create/update grade item for given assignment
*
* @param object $turnitintooltwo object with extra cmidnumber (if available)
* @param mixed optional array/object of grade(s); 'reset' means reset grades in gradebook
* @return int 0 if ok, error code otherwise
*/
function turnitintooltwo_grade_item_update($turnitintooltwo, $grades = null) {
global $CFG, $DB;
@include_once($CFG->dirroot."/lib/gradelib.php");
$params = array();
$cm = get_coursemodule_from_instance("turnitintooltwo", $turnitintooltwo->id, $turnitintooltwo->course);
$params['itemname'] = $turnitintooltwo->name;
$params['idnumber'] = isset($cm->idnumber) ? $cm->idnumber : null;
$grade = (empty($turnitintooltwo->grade)) ? 0 : $turnitintooltwo->grade;
if ($grade < 0) { // If we're using a grade scale.
$params['gradetype'] = GRADE_TYPE_SCALE;
$params['scaleid'] = -$grade;
} else if ($grade > 0) { // If we are using a grade value.
$params['gradetype'] = GRADE_TYPE_VALUE;
$params['grademax'] = $grade;
$params['grademin'] = 0;
} else { // If we aren't using a grade at all.
$params['gradetype'] = GRADE_TYPE_NONE;
}
// Get the latest part, for the post date and set the default hidden value on grade item.
$lastpart = $DB->get_record('turnitintooltwo_parts', array('turnitintooltwoid' => $turnitintooltwo->id), 'max(dtpost)');
$lastpart = current((array)$lastpart);
$params['hidden'] = $lastpart;
// There should always be a $cm unless this is called on module creation.
if (!empty($cm)) {
// The value of hidden should be 1 if The Turnitin activity is visible so the post date should be used.
$params['hidden'] = ($cm->visible) ? $lastpart : 1;
}
$params['grademin'] = 0;
return grade_update('mod/turnitintooltwo', $turnitintooltwo->course, 'mod', 'turnitintooltwo',
$turnitintooltwo->id, 0, $grades, $params);
}
/**
* Given an object containing all the necessary data, (defined by the form in
* mod_form.php) these functions will create/edit a new instance and return the id
* number of the instance.
*
* @global object
* @param object $turnitintooltwo turnitintooltwo data
* @return int instance id
*/
function turnitintooltwo_add_instance($turnitintooltwo) {
turnitintooltwo_activitylog("Create tool instance - ".$turnitintooltwo->name, "REQUEST");
return turnitintooltwo_edit_instance(0, $turnitintooltwo);
}
function turnitintooltwo_update_instance($turnitintooltwo) {
turnitintooltwo_activitylog("Update tool instance - ".$turnitintooltwo->name." (".$turnitintooltwo->instance.")",
"REQUEST");
return turnitintooltwo_edit_instance($turnitintooltwo->instance, $turnitintooltwo);
}
function turnitintooltwo_edit_instance($id, $turnitintooltwo) {
global $USER;
$turnitintooltwo->name = htmlentities($turnitintooltwo->name);
$turnitintooltwoassignment = new turnitintooltwo_assignment($id, $turnitintooltwo);
if ($id == 0) {
$id = $turnitintooltwoassignment->create_moodle_assignment();
} else {
$turnitintooltwoassignment->edit_moodle_assignment();
}
if (!empty($turnitintooltwo->set_instructor_defaults)) {
$instructor = new turnitintooltwo_user($USER->id, 'Instructor');
$instructor->save_instructor_defaults($turnitintooltwo);
}
return $id;
}
/**
* 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 turnitintooltwo instance id
* @return bool success
*/
function turnitintooltwo_delete_instance($id) {
$turnitintooltwoassignment = new turnitintooltwo_assignment($id);
return $turnitintooltwoassignment->delete_moodle_assignment($id);
}
/**
* Function called by course/reset.php when resetting moodle course, this is used to duplicate or reset a courses Turnitin
* activities. If action specified is 'NEWCLASS' we are creating a new class on Turnitin. For both actions we create new
* assignments on Turnitin and replace the turnitin ids for those parts in the database.
*
* @global object
* @param var $courseid The course ID for the course to reset
* @param string $action The action to use OLDCLASS or NEWCLASS
* @param int $renewdates The action to use new assignment dates or not.
* @return array The status array to pass to turnitintooltwo_reset_userdata
*/
function turnitintooltwo_duplicate_recycle($courseid, $action, $renewdates = null) {
set_time_limit(0);
global $DB, $USER;
$config = turnitintooltwo_admin_config();
$partsarray = array();
$error = false;
$turnitintooltwouser = new turnitintooltwo_user($USER->id, "Instructor");
$turnitintooltwouser->set_user_values_from_tii();
$instructorrubrics = $turnitintooltwouser->get_instructor_rubrics();
if (!$turnitintooltwos = $DB->get_records('turnitintooltwo', array('course' => $courseid))) {
turnitintooltwo_print_error('assigngeterror', 'turnitintooltwo', null, null, __FILE__, __LINE__);
exit();
}
if (!$DB->get_record('course', array('id' => $courseid))) {
turnitintooltwo_print_error('coursegeterror', 'turnitintooltwo', null, null, __FILE__, __LINE__);
exit();
}
foreach ($turnitintooltwos as $turnitintooltwo) {
if (!$parts = $DB->get_records('turnitintooltwo_parts', array('turnitintooltwoid' => $turnitintooltwo->id))) {
turnitintooltwo_print_error('partgeterror', 'turnitintooltwo', null, null, __FILE__, __LINE__);
exit();
}
foreach ($parts as $part) {
$partsarray[$courseid][$turnitintooltwo->id][$part->id]['tiiassignid'] = $part->tiiassignid;
if ($action == "UNTOUCHED") {
$turnitintooltwoassignment = new turnitintooltwo_assignment($turnitintooltwo->id);
turnitintooltwo_update_event($turnitintooltwoassignment->turnitintooltwo, $part);
}
}
/* Set legacy to 0 for all TII2s so that we can have all recreated assignments on the same TII class.
Legacy is set to 1 only for migrated assignments that were migrated on
a course where there were pre-existing V2 assignments.*/
if ($action == "NEWCLASS") {
$update = new stdClass();
$update->id = $turnitintooltwo->id;
$update->legacy = 0;
if (!$DB->update_record('turnitintooltwo', $update)) {
turnitintooltwo_print_error('tii2updateerror', 'turnitintooltwo', null, null, __FILE__, __LINE__);
exit();
} else {
turnitintooltwo_activitylog("Assignment updated (".$turnitintooltwo->id.")", "REQUEST");
}
}
}
// We don't want to go any further if Turnitin Assignments aren't going to be touched.
if ($action == "UNTOUCHED") {
return array();
}
$currentcourse = turnitintooltwo_assignment::get_course_data($courseid);
if ($action == "NEWCLASS") {
// Delete Turnitin class link.
if (!$delete = $DB->delete_records('turnitintooltwo_courses', array('courseid' => $courseid))) {
turnitintooltwo_print_error('coursedeleteerror', 'turnitintooltwo', null, null, __FILE__, __LINE__);
exit();
}
$currentcourse->tii_rel_id = '';
// Create a new class to use with new parts.
$tmpassignment = new turnitintooltwo_assignment(0, '', '');
$newcourse = $tmpassignment->create_tii_course($currentcourse, $USER->id);
// Join Instructor to class.
$turnitintooltwouser->join_user_to_class($newcourse->turnitin_cid);
$currentcourse->turnitin_cid = $newcourse->turnitin_cid;
$currentcourse->turnitin_ctl = $newcourse->turnitin_ctl;
}
// Create array of all the Turnitin assignment ids.
$assignmentids = array();
foreach ($partsarray[$courseid] as $tiitoolid => $tiitool) {
foreach ($tiitool as $partid => $data) {
$assignmentids[] = $data['tiiassignid'];
}
}
// Update all the assignments and parts from Turnitin.
$turnitintooltwoassignment = new turnitintooltwo_assignment(0, '', '');
$turnitintooltwoassignment->update_assignment_from_tii($assignmentids);
// Loop through Turnitintool instances and re-create assignment on Turnitin then swap over the stored Turnitin ids.
foreach ($partsarray[$courseid] as $tiitoolid => $tiitool) {
$turnitintooltwoassignment = new turnitintooltwo_assignment($tiitoolid);
// Create new Assignment parts on Turnitin.
$i = 0;
foreach ($tiitool as $partid => $data) {
$i++;
$assignment = new TiiAssignment();
$assignment->setClassId($currentcourse->turnitin_cid);
$assignment->setAuthorOriginalityAccess($turnitintooltwoassignment->turnitintooltwo->studentreports);
// Get rubrics that are shared on the account.
$turnitinclass = new turnitintooltwo_class($courseid);
$turnitinclass->read_class_from_tii();
$rubrics = $turnitinclass->sharedrubrics;
$rubrics = $rubrics + $instructorrubrics;
$rubricid = '';
if (!empty($turnitintooltwoassignment->turnitintooltwo->rubric)) {
$rubricid = $turnitintooltwoassignment->turnitintooltwo->rubric;
}
$rubricid = (!empty($rubricid) && array_key_exists($rubricid, $rubrics)) ? $rubricid : '';
$assignment->setRubricId($rubricid);
$assignment->setSubmitPapersTo($turnitintooltwoassignment->turnitintooltwo->submitpapersto);
$assignment->setResubmissionRule($turnitintooltwoassignment->turnitintooltwo->reportgenspeed);
$assignment->setBibliographyExcluded($turnitintooltwoassignment->turnitintooltwo->excludebiblio);
$assignment->setQuotedExcluded($turnitintooltwoassignment->turnitintooltwo->excludequoted);
$assignment->setSmallMatchExclusionType($turnitintooltwoassignment->turnitintooltwo->excludetype);
$assignment->setSmallMatchExclusionThreshold((int)$turnitintooltwoassignment->turnitintooltwo->excludevalue);
if ($config->useanon) {
$assignment->setAnonymousMarking($turnitintooltwoassignment->turnitintooltwo->anon);
}
$assignment->setLateSubmissionsAllowed($turnitintooltwoassignment->turnitintooltwo->allowlate);
if ($config->repositoryoption == 1) {
$institutioncheck = 0;
if (isset($turnitintooltwoassignment->turnitintooltwo->institution_check)) {
$institutioncheck = $turnitintooltwoassignment->turnitintooltwo->institution_check;
}
$assignment->setInstitutionCheck($institutioncheck);
}
$attribute = "maxmarks".$i;
$assignment->setMaxGrade($turnitintooltwoassignment->turnitintooltwo->$attribute);
$assignment->setSubmittedDocumentsCheck($turnitintooltwoassignment->turnitintooltwo->spapercheck);
$assignment->setInternetCheck($turnitintooltwoassignment->turnitintooltwo->internetcheck);
$assignment->setPublicationsCheck($turnitintooltwoassignment->turnitintooltwo->journalcheck);
$assignment->setTranslatedMatching($turnitintooltwoassignment->turnitintooltwo->transmatch);
$assignment->setAllowNonOrSubmissions($turnitintooltwoassignment->turnitintooltwo->allownonor);
// Erater settings.
$erater = 0;
if (isset($turnitintooltwoassignment->turnitintooltwo->erater)) {
$erater = $turnitintooltwoassignment->turnitintooltwo->erater;
}
$assignment->setErater($erater);
$assignment->setEraterSpelling($turnitintooltwoassignment->turnitintooltwo->erater_spelling);
$assignment->setEraterGrammar($turnitintooltwoassignment->turnitintooltwo->erater_grammar);
$assignment->setEraterUsage($turnitintooltwoassignment->turnitintooltwo->erater_usage);
$assignment->setEraterMechanics($turnitintooltwoassignment->turnitintooltwo->erater_mechanics);
$assignment->setEraterStyle($turnitintooltwoassignment->turnitintooltwo->erater_style);
$eraterdictionary = 'en_US';
if (isset($turnitintooltwoassignment->turnitintooltwo->erater_dictionary)) {
$eraterdictionary = $turnitintooltwoassignment->turnitintooltwo->erater_dictionary;
}
$assignment->setEraterSpellingDictionary($eraterdictionary);
$eraterhandbook = 0;
if (isset($turnitintooltwoassignment->turnitintooltwo->erater_handbook)) {
$eraterhandbook = $turnitintooltwoassignment->turnitintooltwo->erater_handbook;
}
$assignment->setEraterHandbook($eraterhandbook);
// Generate the assignment dates depending on whether we are renewing them or not.
$datestart = turnitintooltwo_generate_part_dates($renewdates, "start", $turnitintooltwoassignment->turnitintooltwo, $i);
$datedue = turnitintooltwo_generate_part_dates($renewdates, "due", $turnitintooltwoassignment->turnitintooltwo, $i);
$datepost = turnitintooltwo_generate_part_dates($renewdates, "post", $turnitintooltwoassignment->turnitintooltwo, $i);
$assignment->setStartDate($datestart);
$assignment->setDueDate($datedue);
$assignment->setFeedbackReleaseDate($datepost);
$attribute = "partname".$i;
$tiititle = $turnitintooltwoassignment->turnitintooltwo->name." ".$turnitintooltwoassignment->turnitintooltwo->$attribute;
$tiititle = $turnitintooltwoassignment->truncate_title( $tiititle, TURNITIN_ASSIGNMENT_TITLE_LIMIT, 'TT' );
$assignment->setTitle( $tiititle );
$partassignid = $turnitintooltwoassignment->create_tii_assignment($assignment,
$turnitintooltwoassignment->turnitintooltwo->id, $i);
if (empty($partassignid)) {
turnitintooltwo_activitylog("Moodle Assignment could not be created (".$tiitoolid.") - ".
$turnitintooltwoassignment->turnitintooltwo->name , "REQUEST");
$error = true;
}
$part = new stdClass();
$part->id = $partid;
$part->tiiassignid = $partassignid;
$part->turnitintooltwoid = $turnitintooltwoassignment->turnitintooltwo->id;
$part->partname = $turnitintooltwoassignment->turnitintooltwo->$attribute;
$part->deleted = 0;
$part->maxmarks = $assignment->getMaxGrade();
$part->dtstart = strtotime($assignment->getStartDate());
$part->dtdue = strtotime($assignment->getDueDate());
$part->dtpost = strtotime($assignment->getFeedbackReleaseDate());
$part->unanon = 0;
$part->submitted = 0;
turnitintooltwo_reset_part_update($part, $i);
turnitintooltwo_update_event($turnitintooltwoassignment->turnitintooltwo, $part);
if (!$DB->delete_records('turnitintooltwo_submissions', array('submission_part' => $partid))) {
turnitintooltwo_print_error('submissiondeleteerror', 'turnitintooltwo', null, null, __FILE__, __LINE__);
exit();
}
}
}
$datastr = ($action == "NEWCLASS") ? 'copyassigndata' : 'replaceassigndata';
$item = get_string($datastr, 'turnitintooltwo');
$status[] = array('component' => get_string('modulenameplural', 'turnitintooltwo'), 'item' => $item, 'error' => $error);
return $status;
}
/**
* Function called by turnitintooltwo_duplicate_recycle to generate part dates during the course reset process.
*
* @param int $renewdates Determines whether to use new dates or existing dates.
* @param string $datetype "start", "due" or "post" - Determines the kind of date we need to return.
* @param object $part The assignment in which we need dates for.
* @param int The counter used during the part creation.
* @return int A timestamp for the date we requested.
*/
function turnitintooltwo_generate_part_dates($renewdates, $datetype, $part, $i) {
if ($renewdates) {
switch ($datetype) {
case 'start':
return gmdate("Y-m-d\TH:i:s\Z", time());
case 'due':
case 'post':
return gmdate("Y-m-d\TH:i:s\Z", strtotime("+1 week"));
default:
return NULL;
}
} else {
$attribute = "dt".$datetype.$i;
return gmdate("Y-m-d\TH:i:s\Z", $part->$attribute);
}
}
/**
* Function called by turnitintooltwo_duplicate_recycle to update a part during the course reset process.
*
* @param object $part The part data that we are updating.
* @param int $i The counter used during the part creation.
*/
function turnitintooltwo_reset_part_update($part, $i) {
global $DB;
if (!$DB->update_record('turnitintooltwo_parts', $part)) {
turnitintooltwo_print_error('partupdateerror', 'turnitintooltwo', null, $i, __FILE__, __LINE__);
exit();
} else {
turnitintooltwo_activitylog("Moodle Assignment part updated (".$part->id.")", "REQUEST");
}
}
/**
* Function called by course/reset.php when resetting moodle course to actually reset / recycle the data
*
* @param object $data The data object passed by course reset
* @return array The Result of the turnitintooltwo_duplicate_recycle call
*/
function turnitintooltwo_reset_userdata($data) {
$renewdates = isset($data->renew_assignment_dates) ? 1 : null;
$action = 'UNTOUCHED';
switch ($data->reset_turnitintooltwo) {
case 0:
$action = 'NEWCLASS';
break;
case 1:
$action = 'OLDCLASS';
break;
}
$status = turnitintooltwo_duplicate_recycle($data->courseid, $action, $renewdates);
return $status;
}
/**
* Function called by course/reset.php when resetting moodle course to reset / recycle the course data using default values
*
* @param object $course The course object passed by moodle
* @return array The result array
*/
function turnitintooltwo_reset_course_form_defaults($course) {
return array('reset_turnitintooltwo' => 0);
}
/**
* Function called by course/reset.php when resetting moodle course to build the element for the reset form
*
* @param object $mform The mod form object passed by reference by course reset
*/
function turnitintooltwo_reset_course_form_definition(&$mform) {
$mform->addElement('header', 'turnitintooltwoheader', get_string('modulenamewithv2plural', 'turnitintooltwo'));
$options = array(
'0' => get_string('turnitintooltworesetdata0', 'turnitintooltwo'),
'1' => get_string('turnitintooltworesetdata1', 'turnitintooltwo'),
'2' => get_string('turnitintooltworesetdata2', 'turnitintooltwo')
);
$mform->addElement('select', 'reset_turnitintooltwo', get_string('selectoption', 'turnitintooltwo'), $options);
// Renew dates.
$mform->addElement('checkbox', 'renew_assignment_dates', get_string('renew_assignment_dates', 'turnitintooltwo'));
$mform->addHelpButton('renew_assignment_dates', 'renew_assignment_dates', 'turnitintooltwo');
$mform->setDefault('renew_assignment_dates', false);
}
/**
* A Standard Moodle function that moodle executes at the time the cron runs
*/
function turnitintooltwo_cron() {
global $DB, $CFG, $tiitaskcall;
// 2.7 onwards we would like to be called from task calls.
if ( $CFG->version > 2014051200 && !$tiitaskcall ) {
mtrace(get_string('crontaskmodeactive', 'turnitintooltwo'));
return;
}
// Reset task call flag.
if ($tiitaskcall) {
$tiitaskcall = false;
}
// Update gradebook when a part has been deleted.
// Get assignment that needs updating and check whether it exists.
if ($assignment = $DB->get_record('turnitintooltwo', array("needs_updating" => 1), '*', IGNORE_MULTIPLE)) {
// Update the gradebook.
$task = "needsupdating";
turnitintooltwo_cron_update_gradbook($assignment, $task);
}
// Send grades to the gradebook for anonymous marking assignments when the post date has passed.
// Get a list of assignments that need updating.
if ($assignmentlist = $DB->get_records_sql("SELECT DISTINCT(t.id) FROM {turnitintooltwo} t
LEFT JOIN {turnitintooltwo_parts} p ON (p.turnitintooltwoid = t.id)
WHERE (p.turnitintooltwoid + p.dtpost IN
(SELECT p2.turnitintooltwoid + MAX(p2.dtpost)
FROM {turnitintooltwo_parts} p2
GROUP BY p2.turnitintooltwoid))
AND t.anon = 1 AND t.anongradebook = 0 AND p.dtpost < ".time())) {
// Update each assignment.
$task = "anongradebook";
foreach ($assignmentlist as $assignment) {
turnitintooltwo_cron_update_gradbook($assignment, $task);
}
}
// Refresh the submissions for migrated assignment parts if there are none stored locally
// as the 1st time this is done can be quite a long job if there are a lot of submissions.
$migratedemptyparts = $DB->get_records_select('turnitintooltwo_parts', " migrated = 1 AND ".
" (SELECT COUNT(id) FROM {turnitintooltwo_submissions} ".
" WHERE submission_part = {turnitintooltwo_parts}.id) = 0 ");
if (count($migratedemptyparts) > 0) {
$updatedassignments = array();
foreach ($migratedemptyparts as $part) {
if (!array_search($part->id, $updatedassignments)) {
$cm = get_coursemodule_from_instance("turnitintooltwo", $part->turnitintooltwoid);
$turnitintooltwoassignment = new turnitintooltwo_assignment($part->turnitintooltwoid);
$turnitintooltwoassignment->get_submission_ids_from_tii($part);
$turnitintooltwoassignment->refresh_submissions($cm, $part);
$updatedassignments[] = $part->id;
turnitintooltwo_activitylog('Turnitintool submissions downloaded for assignment '.$part->id, 'REQUEST');
}
}
echo 'Turnitintool submissions downloaded for assignments: '.implode(',', $updatedassignments).' ';
}
// Perform gradebook migrations for submissions that were not actioned during the migration tool.
turnitintooltwo_cron_migrate_gradebook();
}
/**
* Migrate the gradebook for submissions which were not migrated during the migration tool.
*/
function turnitintooltwo_cron_migrate_gradebook() {
global $DB;
// Get a list of assignments with outstanding gradebook migrations.
require_once(__DIR__.'/classes/v1migration/v1migration.php');
$sql = "migrate_gradebook = 1 GROUP BY turnitintooltwoid";
$assignments = $DB->get_records_select("turnitintooltwo_submissions", $sql, NULL, 'turnitintooltwoid', "turnitintooltwoid, count(turnitintooltwoid) AS numsubmissions");
$numsubmissions = 0;
foreach ($assignments as $assignment) {
// We will break out unless the number of submissions migrated + to be migrated is MIGRATION_SUBMISSIONS_CUTOFF or less.
if (($numsubmissions + $assignment->numsubmissions) <= MIGRATION_SUBMISSIONS_CUTOFF ||
(($numsubmissions == 0) && ($assignment->numsubmissions > MIGRATION_SUBMISSIONS_CUTOFF))) {
$numsubmissions += $assignment->numsubmissions;
// Get the course ID.
$courseid = $DB->get_field('turnitintooltwo', 'course', array('id' => $assignment->turnitintooltwoid));
// Get a TII assignment ID on this assignment so we can link back to V1.
$sql = "turnitintooltwoid = " . $assignment->turnitintooltwoid . " LIMIT 1";
$tiiid = $DB->get_field_select('turnitintooltwo_parts', 'tiiassignid', $sql);
// Get a V1 part belonging to this assignment.
$sql = "tiiassignid = " . $tiiid . " LIMIT 1";
$turnitintoolid = $DB->get_field_select('turnitintool_parts', 'turnitintoolid', $sql);
$gradeupdates = v1migration::migrate_gradebook($assignment->turnitintooltwoid, $turnitintoolid, $courseid, "cron");
// If we have migrated, update the titles.
if ($gradeupdates == "migrated") {
// Get the V1 assignment.
$v1assignment = $DB->get_record('turnitintool', array("id" => $turnitintoolid));
// Perform post-migration tasks.
$v1migration = new v1migration($courseid, $v1assignment);
$v1migration->post_migration($assignment->turnitintooltwoid);
}
} else {
break;
}
}
}
/**
* Update the gradebook for cron calls.
*
* @param type $assignment The assignment that we are going to update the grades for.
* @param string $task The cron task we are performing the update from.
*/
function turnitintooltwo_cron_update_gradbook($assignment, $task) {
global $DB, $CFG;
@include_once($CFG->dirroot."/lib/gradelib.php");
$turnitintooltwoassignment = new turnitintooltwo_assignment($assignment->id);
$cm = get_coursemodule_from_instance("turnitintooltwo", $turnitintooltwoassignment->turnitintooltwo->id,
$turnitintooltwoassignment->turnitintooltwo->course);
if ($cm) {
$users = get_enrolled_users(context_module::instance($cm->id),
'mod/turnitintooltwo:submit', groups_get_activity_group($cm), 'u.id');
foreach ($users as $user) {
$fieldlist = array('turnitintooltwoid' => $turnitintooltwoassignment->turnitintooltwo->id,
'userid' => $user->id);
// Set submission_unanon when needsupdating is used.
if ($task == "needsupdating") {
$fieldlist['submission_unanon'] = 1;
}
$grades = new stdClass();
if ($submissions = $DB->get_records('turnitintooltwo_submissions', $fieldlist)) {
$overallgrade = $turnitintooltwoassignment->get_overall_grade($submissions, $cm);
if ($turnitintooltwoassignment->turnitintooltwo->grade < 0) {
// Using a scale.
$grades->rawgrade = ($overallgrade == '--') ? null : $overallgrade;
} else {
$grades->rawgrade = ($overallgrade == '--') ? null : number_format($overallgrade, 2);
}
}
$grades->userid = $user->id;
$params['idnumber'] = $cm->idnumber;
grade_update('mod/turnitintooltwo', $turnitintooltwoassignment->turnitintooltwo->course, 'mod',
'turnitintooltwo', $turnitintooltwoassignment->turnitintooltwo->id, 0, $grades, $params);
}
// Remove the "anongradebook" flag.
$updateassignment = new stdClass();
$updateassignment->id = $assignment->id;
// Depending on the task we need to update a different column.
switch($task) {
case "needsupdating":
$updateassignment->needs_updating = 0;
break;
case "anongradebook":
$updateassignment->anongradebook = 1;
break;
}
$DB->update_record("turnitintooltwo", $updateassignment);
}
}
/**
* Abstracted version of throw new moodle_exception() - formerly print_error()
*
* @param string $input The error string if module = null otherwise the language string called by get_string()
* @param string $module The module string
* @param string $param The parameter to send to use as the $a optional object in get_string()
* @param string $file The file where the error occured
* @param string $line The line number where the error occured
*/
function turnitintooltwo_print_error($input, $module = 'turnitintooltwo',
$link = null, $param = null, $file = __FILE__, $line = __LINE__) {
global $CFG;
turnitintooltwo_activitylog($input, "PRINT_ERROR");
$message = (is_null($module)) ? $input : get_string($input, $module, $param);
$linkid = optional_param('id', 0, PARAM_INT);
if (is_null($link) AND substr_count($_SERVER["PHP_SELF"], "turnitintooltwo/view.php") > 0) {
$link = (!empty($linkid)) ? $CFG->wwwroot.'/mod/turnitintooltwo/view.php?id='.$linkid : $CFG->wwwroot;
}
if (basename($file) != "lib.php") {
$message .= ' ('.basename($file).' | '.$line.')';
}
throw new moodle_exception($input, 'turnitintooltwo', $link, $message);
exit();
}
/**
* Outputs the file type array for acceptable file type uploads
*
* @param boolean $setup True if the call is from the assignment activity setup screen
* @param array The array of filetypes ready for the modform parameter
*/
function turnitintooltwo_filetype_array($setup = true) {
$output = array(
1 => get_string('fileupload', 'turnitintooltwo'),
2 => get_string('textsubmission', 'turnitintooltwo')
);
if ($setup) {
$output[0] = get_string('anytype', 'turnitintooltwo');
}
ksort($output);
return $output;
}
/**
* Creates a temp file for submission to Turnitin, uses a random number suffixed with the stored filename
*
* @param array $filename Used to build a more readable filename
* @param string $suffix The file extension for the upload
* @return string $file The filepath of the temp file
*/
function turnitintooltwo_tempfile(array $filename, $suffix) {
$filename = implode('_', $filename);
$filename = str_replace(' ', '_', $filename);
$filename = clean_param(strip_tags($filename), PARAM_FILE);
$tempdir = make_temp_directory('turnitintooltwo');
// Get the file extension (if there is one).
$pathparts = explode('.', $suffix);
$ext = '';
if (count($pathparts) > 1) {
$ext = '.' . array_pop($pathparts);
}
$permittedstrlength = TURNITINTOOLTWO_MAX_FILENAME_LENGTH - mb_strlen($tempdir.DIRECTORY_SEPARATOR, 'UTF-8');
$extlength = mb_strlen('_' . mt_getrandmax() . $ext, 'UTF-8');
if ($extlength > $permittedstrlength) {
// Someone has likely used a filename with an absurdly long extension, or the
// tempdir path is huge, so preserve the extension as much as possible.
$extlength = $permittedstrlength;
}
// Deal with characters which cause problems on some environments.
$filename = iconv('UTF-8', 'us-ascii//TRANSLIT//IGNORE', $filename);
// Shorten the filename as needed, taking the extension into consideration.
$permittedstrlength -= $extlength;
$filename = mb_substr($filename, 0, $permittedstrlength, 'UTF-8');
// Ensure the filename doesn't have any characters that are invalid for the fs.
$filename = clean_param($filename . mb_substr('_' . mt_rand() . $ext, 0, $extlength, 'UTF-8'), PARAM_FILE);
$tries = 0;
do {
if ($tries == 10) {
throw new invalid_dataroot_permissions("turnitintooltwo temporary file cannot be created.");
}
$tries++;
$file = $tempdir . DIRECTORY_SEPARATOR . $filename;
} while ( !touch($file) );
return $file;
}
/**
* Gets the assignments from a specified course from Turnitin
*
* @param int $courseid the id of the course/class in Turnitin
* @param str $returnformat the format we are returning data in
* @return array of data in a datatables readable format
*/
function turnitintooltwo_get_assignments_from_tii($courseid, $returnformat = "json") {
global $DB;
$return = array();
if ($returnformat == "json") {
$return["aaData"] = array();
}
$turnitincomms = new turnitintooltwo_comms();
$turnitincall = $turnitincomms->initialise_api();
$assignment = new TiiAssignment();
$assignment->setClassId($courseid);
$assignmentids = array();
try {
$response = $turnitincall->findAssignments( $assignment );
$findassignment = $response->getAssignment();
$assignmentids = $findassignment->getAssignmentIds();
} catch (Exception $e) {
$turnitincomms->handle_exceptions($e, 'getassignmenterror', false);
}
$assignment = new TiiAssignment();
$assignment->setAssignmentIds($assignmentids);
$currentassignments = array();
if (count($assignmentids) > 0) {
list($insql, $inparams) = $DB->get_in_or_equal($assignmentids);
$currentassignments['TT'] = $DB->get_records_select("turnitintooltwo_parts",
" tiiassignid ".$insql, $inparams, '', 'tiiassignid');
$dbman = $DB->get_manager();
if ($dbman->table_exists('plagiarism_turnitin_config')) {
$currentassignments['PP'] = $DB->get_records_select("plagiarism_turnitin_config", " name = 'turnitin_assignid' ".
" AND value ".$insql, $inparams, '', 'value');
} else {
$currentassignments['PP'] = array();
}
}
try {
$response = $turnitincall->readAssignments( $assignment );
$readassignments = $response->getAssignments();
foreach ($readassignments as $readassignment) {
if (empty($currentassignments['TT'][$readassignment->getAssignmentId()]) &&
empty($currentassignments['PP'][$readassignment->getAssignmentId()])) {
$checkbox = html_writer::checkbox('assignmentids[]', $readassignment->getAssignmentId(), false, '',
array("id" => "assignmentid_".$readassignment->getAssignmentId(),
"disabled" => "disabled", "class" => "assignmentids_check"));
if ($returnformat == "json") {
$return["aaData"][] = array($checkbox, $readassignment->getTitle(), $readassignment->getMaxGrade(),
$readassignment->getAssignmentId());
} else {
$return[$readassignment->getAssignmentId()] = array("tii_id" => $readassignment->getAssignmentId(),
"tii_title" => $readassignment->getTitle());
}
} else {
// Double check that migration has completed for this assignment.
// If not then there has been an error so we delete the previously migrated assignment attempt.
if ($part = $DB->get_record('turnitintooltwo_parts',
array('tiiassignid' => $readassignment->getAssignmentId(), 'migrated' => -1))) {
$DB->delete_records('turnitintooltwo_parts',
array('tiiassignid' => $readassignment->getAssignmentId(), 'migrated' => -1));
turnitintooltwo_activitylog("Deleted failed migration assignment part - id (".
$readassignment->getAssignmentId().")", "REQUEST");
// Remove the Turnitintool if it contains no other parts.
if ($DB->count_records('turnitintooltwo_parts', array('turnitintooltwoid' => $part->turnitintooltwoid)) == 0) {