-
Notifications
You must be signed in to change notification settings - Fork 10
/
jplag_tool.php
322 lines (292 loc) · 12.7 KB
/
jplag_tool.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
<?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/>.
/**
* Define the entry calls for JPlag
* Transform data into the structure required by JPlag,
* communicate with JPlag server and interpret the result
*
* @package plagiarism
* @subpackage programming
* @author thanhtri
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die('Direct access to this script is forbidden.');
require_once(__DIR__.'/plagiarism_tool.php');
require_once(__DIR__.'/jplag/jplag_stub.php');
require_once(__DIR__.'/jplag/jplag_parser.php');
require_once(__DIR__.'/reportlib.php');
class jplag_tool implements plagiarism_tool {
private $jplag_stub=null;
private static $supported_languages = array(
'java' => 'java15',
'c' => 'c/c++',
'c#' => 'c#-1.2',
'scheme' => 'scheme',
'text' => 'text'
);
/**
* Initialise the soap stub.
*/
private function stub_init($jplag_info=null) {
global $CFG;
// the stub is initiated lazily at most one time (per request) when it is required
if ($this->jplag_stub==null) {
// get the username and password
$settings = get_config('plagiarism_programming');
$proxyhost = isset($CFG->proxyhost)?$CFG->proxyhost:'';
$proxyport = isset($CFG->proxyport)?$CFG->proxyport:'';
$proxyuser = isset($CFG->proxyuser)?$CFG->proxyuser:'';
$proxypass = isset($CFG->proxypassword)?$CFG->proxypassword:'';
if (!empty($settings->jplag_user) && !empty($settings->jplag_pass)) {
$this->jplag_stub = new jplag_stub($settings->jplag_user, $settings->jplag_pass,
$proxyhost, $proxyport, $proxyuser, $proxypass);
} else if ($jplag_info!=null) {
$jplag_info->status = 'error';
$jplag_info->message = get_string('credential_not_provided', 'plagiarism_programming');
return false;
}
}
return $this->jplag_stub;
}
/**
* Submit assignment to the JPlag server. It will compress the codes in zip format before sending it
* @param string $inputdir the directory of all submission of the assignment, in which each student's submission is in a
* subdirectory named by their student id and the code associated with it
* @param stdClass $assignment the record object of assignment config
* @param stdClass $scan_info the record object of the status of jplag
* @return the same updated record object of jplag status
*/
public function submit_assignment($inputdir, $assignment, $scan_info) {
if (!$this->stub_init($scan_info)) {
return $scan_info;
}
// check supported assignment
if (!isset(self::$supported_languages[$assignment->language])) {
$scan_info->status = 'error';
$scan_info->message = 'Language not supported by JPlag';
return $scan_info;
}
$zip_full_path = PLAGIARISM_TEMP_DIR.'zip_jplag_'.$assignment->id.'_'.time().'.zip'; //prevent collision
$submit_zip_file = new ZipArchive();
$submit_zip_file->open($zip_full_path, ZipArchive::CREATE);
$this->jplag_zip_directory(strlen(dirname($inputdir))+1, $inputdir, $submit_zip_file);
$submit_zip_file->close();
return $this->jplag_send_to_server($zip_full_path, $assignment, $scan_info);
}
/**
* Send the zip file to JPlag server by SOAP protocol
* @param $zip_file_path the path of zip file
* @param stdClass $assignment_param the record object of assignment config
* @param stdClass $scan_info the record object of the status of jplag (in plagiarism_programming_jplag table)
* @return the same updated record object of jplag status
*/
private function jplag_send_to_server($zip_file_path, $assignment_param, $scan_info) {
if (!$this->stub_init($scan_info)) {
return $scan_info;
}
$option = new jplag_option();
$option->set_language($assignment_param->language);
$option->title = 'Test'; // this param doesn't matter
// initialise progress handler
$handler = new progress_handler('jplag', $scan_info);
try {
$submission_id = $this->jplag_stub->send_file($zip_file_path, $option, $handler);
unlink($zip_file_path);
// upload finished, pass to the scanning phase
$scan_info->status = 'scanning';
$scan_info->submissionid = $submission_id;
} catch (SoapFault $ex) {
$error = jplag_stub::interpret_soap_fault($ex);
$scan_info->status = 'error';
$scan_info->message= $error['message'];
}
return $scan_info;
}
/**
* Checking the status of the scanning. If the current status is scanning,
* it will contact JPlag server to see if the scanning has been finished
* Otherwise, it just return the status in the database
* @param $assignment_param the assignment record object (plagiarism_programming table)
* @param $jplag_param the jplag record object (plagiarism_programming_jplag table)
* @return the updated $jplag_param object
*/
public function check_status($assignment_param, $jplag_param) {
if (!$this->stub_init($jplag_param)) {
return $jplag_param;
}
// TODO: handle network error
$submissionid = $jplag_param->submissionid;
$status = $this->jplag_stub->check_status($submissionid);
$state = $status->state;
if ($state >= SUBMISSION_STATUS_ERROR) {
$jplag_param->status = 'error';
$jplag_param->message = jplag_stub::translate_scanning_status($status);
$jplag_param->error_detail = $status->report;
$this->cancel_submission($jplag_param);
} else if ($state == SUBMISSION_STATUS_DONE) {
$jplag_param->status = 'done';
$jplag_param->progress = 100;
} else { //not done yet
$jplag_param->status = 'scanning';
$jplag_param->progress = $status->progress;
}
return $jplag_param;
}
/**
* Download the result from jplag server.
* Note that the scanning status must be "done"
*/
public function download_result($assignment_param, $jplag_param) {
if (!$this->stub_init($jplag_param)) {
return $jplag_param;
}
// create a directory
$report_path = self::get_report_path();
if (!is_dir($report_path)) {
mkdir($report_path);
}
$report = plagiarism_programming_create_new_report($assignment_param->cmid, 'jplag');
$assignment_report_path = self::get_report_path($report);
if (is_dir($assignment_report_path)) {
plagiarism_programming_rrmdir($assignment_report_path);
}
mkdir($assignment_report_path);
$result_file = $assignment_report_path.'/download.zip';
$file_handle = fopen($result_file, 'w');
echo "Downloading result...\n";
// initialise the handler
$progress_handler = new progress_handler('jplag', $jplag_param);
try {
$this->jplag_stub->download_result($jplag_param->submissionid, $file_handle, $progress_handler);
fclose($file_handle);
$this->extract_zip($result_file);
unlink($result_file); // delete the file after extracting
echo "Finished downloading. Everything OK\n";
$jplag_param->status='done_downloading';
$jplag_param->directory=$assignment_report_path;
$jplag_param->message = 'success';
} catch (SoapFault $fault) {
debug('Error occurs while downloading: '.$fault->detail->JPlagException->description."\n");
$error = jplag_stub::interpret_soap_fault($fault);
$jplag_param->status='error';
$jplag_param->message=$error['message'];
fclose($file_handle);
}
return $jplag_param;
}
protected function cancel_submission($jplag_param) {
try {
$this->jplag_stub->cancel_submission($jplag_param->submissionid);
} catch (SoapFault $ex) {
$fault = jplag_stub::interpret_soap_fault($ex);
$jplag_param->message .= get_string('jplag_cancel_error', 'plagiarism_programming').' '.$fault['message'];
}
}
/**
* Link to JPlag plagiarism report for the assignment
* @param stdClass $scan_info the record object of the status of jplag (in plagiarism_programming_jplag table)
*/
public function display_link($scan_info) {
global $CFG;
$report_path = $CFG->wwwroot.'/plagiarism/programming/view.php?cmid='.$scan_info->cmid;
return "<a target='_blank' href='$report_path'>JPlag report</a>";
}
public static function get_report_path($report=null) {
global $CFG;
if (!$report) {
return "{$CFG->tempdir}/plagiarism_report/";
} else {
return "{$CFG->tempdir}/plagiarism_report/report{$report->cmid}_v$report->version";
}
}
/**
* The supported languages of jplag
* @return the supported languages of JPlag under an array('language', 'code')
* - code is used by the server to identify the language
*/
public static function get_supported_language() {
return self::$supported_languages;
}
/**
* Compress all the students submission into one zip file
* @param int $baselength the length of the base directory
* @param string $dir the directory to compress
* @param ZipArchive $submit_zip_file the ZipArchive to add files in
* @return void
*/
private function jplag_zip_directory($baselength, $dir, $submit_zip_file) {
if (is_dir($dir)) {
$archive_dir_name = substr($dir, $baselength, -1);
$submit_zip_file->addEmptyDir($archive_dir_name);
$all_files = scandir($dir);
foreach ($all_files as $file) {
if ($file=='.' || $file=='..') {
continue;
}
$path = $dir.$file;
if (is_dir($path)) {
$this->jplag_zip_directory($baselength, $path.'/', $submit_zip_file);
} else {
$archive_file_name = substr($path, $baselength);
$file_content = file_get_contents($path);
$submit_zip_file->addFromString($archive_file_name, $file_content);
}
}
}
}
/**
* Extract the report zip files
* @param string $zip_file the full path of the file to extract
* @return void
*/
private function extract_zip($zip_file) {
assert(is_file($zip_file));
$handle = zip_open($zip_file);
$base_dir = dirname($zip_file);
if ($handle) {
while ($zip_entry = zip_read($handle)) {
$entry_name = zip_entry_name($zip_entry);
if (substr($entry_name, -1)!='/') { // a file
$fp = plagiarism_programming_create_file($base_dir.'/'.$entry_name);
if (zip_entry_open($handle, $zip_entry, 'r')) {
$buf = zip_entry_read($zip_entry, zip_entry_filesize($zip_entry));
fwrite($fp, $buf);
zip_entry_close($zip_entry);
fclose($fp);
}
}
}
}
}
/**
* Parse the report
* @param stdClass $assignment the assignment config record object (of plagiarism_programming table)
* @param stdClass $jplag_info the jplag status record object (of plagiarism_programming_jplag table)
* @return stdClass the same $jplag_info record, with status updated
*/
public function parse_result($assignment, $jplag_info) {
$parser = new jplag_parser($assignment->cmid);
$parser->parse();
$jplag_info->status = 'finished';
return $jplag_info;
}
/**
* Get the toolname
*/
public function get_name() {
return 'jplag';
}
}