An error occurred while loading the file. Please try again.
-
mamunozgil authoredf484bd97
<?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/>.use assignsubmission_dta\dta_db_utils;use assignsubmission_dta\dta_backend_utils;use assignsubmission_dta\dta_view_submission_utils;use assignsubmission_dta\models\dta_result;use assignsubmission_dta\models\dta_result_summary;use assignsubmission_dta\models\dta_recommendation;/** * Library class for DTA submission plugin extending assign submission plugin base class. * * @package assignsubmission_dta * @copyright 2023 Your Name or Organization * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */class assign_submission_dta extends assign_submission_plugin { /** * Broadly used in logic, parametrized for easier change. */ public const ASSIGNSUBMISSION_DTA_COMPONENT_NAME = 'assignsubmission_dta'; /** * Draft file area for DTA tests to be uploaded by the teacher. */ public const ASSIGNSUBMISSION_DTA_DRAFT_FILEAREA_TEST = 'tests_draft_dta'; /** * File area for DTA tests to be uploaded by the teacher. */ public const ASSIGNSUBMISSION_DTA_FILEAREA_TEST = 'tests_dta'; /** * File area for DTA submission assignment. */ public const ASSIGNSUBMISSION_DTA_FILEAREA_SUBMISSION = 'submissions_dta'; /** * Get plugin name. * * @return string */ public function get_name(): string { return get_string('pluginname', self::ASSIGNSUBMISSION_DTA_COMPONENT_NAME); } /** * Get default settings for assignment submission settings. * * @param MoodleQuickForm $mform Form to add elements to. * @return void */ public function get_settings(MoodleQuickForm $mform): void { // Add draft filemanager to form. $mform->addElement(
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
'filemanager',
self::ASSIGNSUBMISSION_DTA_DRAFT_FILEAREA_TEST,
get_string(
'submission_settings_label',
self::ASSIGNSUBMISSION_DTA_COMPONENT_NAME
),
null,
$this->get_file_options(true)
);
// Add help button to added filemanager.
$mform->addHelpButton(
// Form-unique element id to which to add button.
self::ASSIGNSUBMISSION_DTA_DRAFT_FILEAREA_TEST,
// Key.
'submission_settings_label',
// Language file to use.
self::ASSIGNSUBMISSION_DTA_COMPONENT_NAME
);
// Only show filemanager if plugin is enabled.
$mform->hideIf(
// Form-unique element id to hide.
self::ASSIGNSUBMISSION_DTA_DRAFT_FILEAREA_TEST,
// Condition to check.
self::ASSIGNSUBMISSION_DTA_COMPONENT_NAME . '_enabled',
// State to match for hiding.
'notchecked'
);
}
/**
* Allows the plugin to update the default values passed into
* the settings form (needed to set up draft areas for editor
* and filemanager elements).
*
* @param array $defaultvalues Default values to update.
*/
public function data_preprocessing(&$defaultvalues): void {
// Get id of draft area for file manager creation.
$draftitemid = file_get_submitted_draft_itemid(
self::ASSIGNSUBMISSION_DTA_DRAFT_FILEAREA_TEST
);
// Prepare draft area with created draft filearea.
file_prepare_draft_area(
$draftitemid,
$this->assignment->get_context()->id,
self::ASSIGNSUBMISSION_DTA_COMPONENT_NAME,
self::ASSIGNSUBMISSION_DTA_FILEAREA_TEST,
0,
['subdirs' => 0]
);
$defaultvalues[self::ASSIGNSUBMISSION_DTA_DRAFT_FILEAREA_TEST] = $draftitemid;
}
/**
* Save settings of assignment submission settings.
*
* @param stdClass $data Form data.
* @return bool
*/
public function save_settings(stdClass $data): bool {
// If the assignment has no filemanager for our plugin, just leave.
$draftfilemanagerid = self::ASSIGNSUBMISSION_DTA_DRAFT_FILEAREA_TEST;
if (!isset($data->$draftfilemanagerid)) {
return true;
}
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
// Store files from draft filearea to final one.
file_save_draft_area_files(
// Form-unique element id of draft filemanager from the edit.
$data->$draftfilemanagerid,
// Id of the assignment in edit.
$this->assignment->get_context()->id,
self::ASSIGNSUBMISSION_DTA_COMPONENT_NAME,
self::ASSIGNSUBMISSION_DTA_FILEAREA_TEST,
0
);
// Get files from proper filearea.
$fs = get_file_storage();
$files = $fs->get_area_files(
// Id of the current assignment.
$this->assignment->get_context()->id,
self::ASSIGNSUBMISSION_DTA_COMPONENT_NAME,
self::ASSIGNSUBMISSION_DTA_FILEAREA_TEST,
0,
'id',
false
);
// Check if a file was uploaded.
if (empty($files)) {
\core\notification::error(
get_string('no_testfile_warning', self::ASSIGNSUBMISSION_DTA_COMPONENT_NAME)
);
return true;
}
// Get the file.
$file = reset($files);
// Send file to backend.
return dta_backend_utils::assignsubmission_dta_send_testconfig_to_backend(
$this->assignment,
$file
);
}
/**
* Add elements to submission form.
*
* @param stdClass|null $submissionorgrade Submission or grade to show in the form.
* @param MoodleQuickForm $mform Form for adding elements.
* @param stdClass $data Data for filling the elements.
* @param int $userid Current user.
* @return bool True if form elements added.
*/
public function get_form_elements_for_user(
$submissionorgrade,
MoodleQuickForm $mform,
stdClass $data,
$userid
): bool {
// Prepare submission filearea.
$data = file_prepare_standard_filemanager(
$data,
'tasks',
$this->get_file_options(false),
$this->assignment->get_context(),
self::ASSIGNSUBMISSION_DTA_COMPONENT_NAME,
self::ASSIGNSUBMISSION_DTA_FILEAREA_SUBMISSION,
$submissionorgrade ? $submissionorgrade->id : 0
);
// Add filemanager to form.
$mform->addElement(
'filemanager',
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
// Form-unique identifier.
'tasks_filemanager',
// Label to show next to the filemanager.
get_string('submission_label', self::ASSIGNSUBMISSION_DTA_COMPONENT_NAME),
null,
$this->get_file_options(false)
);
// Add help button.
$mform->addHelpButton(
'tasks_filemanager',
'submission_label',
self::ASSIGNSUBMISSION_DTA_COMPONENT_NAME
);
return true;
}
/**
* Determines if a submission file area contains any files.
*
* @param stdClass $submission Submission to check.
* @return bool True if file count is zero.
*/
public function is_empty(stdClass $submission): bool {
return ($this->count_files(
$submission->id,
self::ASSIGNSUBMISSION_DTA_FILEAREA_SUBMISSION
) === 0);
}
/**
* Counts the number of files in a filearea.
*
* @param int $submissionid Submission id to check.
* @param string $areaid Filearea id to count.
* @return int Number of files submitted in the filearea.
*/
private function count_files(int $submissionid, $areaid): int {
$fs = get_file_storage();
$files = $fs->get_area_files(
$this->assignment->get_context()->id,
self::ASSIGNSUBMISSION_DTA_COMPONENT_NAME,
$areaid,
$submissionid,
'id',
false
);
return count($files);
}
/**
* Save data to the database.
*
* @param stdClass $submission Submission object.
* @param stdClass $data Data from the form.
* @return bool True if saved successfully.
*/
public function save(stdClass $submission, stdClass $data): bool {
$data = file_postupdate_standard_filemanager(
$data,
'tasks',
$this->get_file_options(false),
$this->assignment->get_context(),
self::ASSIGNSUBMISSION_DTA_COMPONENT_NAME,
self::ASSIGNSUBMISSION_DTA_FILEAREA_SUBMISSION,
$submission->id
);
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
// If submission is empty, leave directly.
if ($this->is_empty($submission)) {
return true;
}
// Get submitted files.
$fs = get_file_storage();
$files = $fs->get_area_files(
$this->assignment->get_context()->id,
self::ASSIGNSUBMISSION_DTA_COMPONENT_NAME,
self::ASSIGNSUBMISSION_DTA_FILEAREA_SUBMISSION,
$submission->id,
'id',
false
);
// Check if a file is uploaded.
if (empty($files)) {
\core\notification::error(
get_string('no_submissionfile_warning', self::ASSIGNSUBMISSION_DTA_COMPONENT_NAME)
);
return true;
}
// Get the file.
$file = reset($files);
// Send file to backend (split across lines to avoid exceeding length).
$response = \assignsubmission_dta\dta_backend_utils::assignsubmission_dta_send_submission_to_backend(
$this->assignment,
$submission->id,
$file
);
// With a null response, return an error.
if (is_null($response)) {
return false;
}
// Convert received JSON to valid class instances.
$resultsummary = dta_result_summary::assignsubmission_dta_decode_json($response);
// Decode recommendations from response.
$recommendations = dta_recommendation::assignsubmission_dta_decode_json_recommendations($response);
// Use Moodle debugging instead of error_log/print_r.
debugging('Recommendations: ' . json_encode($recommendations), DEBUG_DEVELOPER);
// Persist new results to database (split long lines).
dta_db_utils::assignsubmission_dta_store_result_summary_to_database(
$this->assignment->get_instance()->id,
$submission->id,
$resultsummary
);
// Store the array of recommendations in the database.
dta_db_utils::assignsubmission_dta_store_recommendations_to_database(
$this->assignment->get_instance()->id,
$submission->id,
$recommendations
);
return true;
}
/**
* Display a short summary of the test results of the submission.
*
* @param stdClass $submission Submission to show.
* @param bool $showviewlink Whether to show expand option.
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
* @return string Summary results HTML.
*/
public function view_summary(stdClass $submission, &$showviewlink): string {
$showviewlink = true;
return dta_view_submission_utils::assignsubmission_dta_generate_summary_html(
$this->assignment->get_instance()->id,
$submission->id
);
}
/**
* Display detailed results.
*
* @param stdClass $submission The submission for which to show results.
* @return string Detailed results HTML.
*/
public function view(stdClass $submission): string {
return dta_view_submission_utils::assignsubmission_dta_generate_detail_html(
$this->assignment->get_instance()->id,
$submission->id
);
}
/**
* Generate array of allowed file types to upload.
*
* @param bool $settings Whether this is for assignment settings or active submission.
* @return array
*/
private function get_file_options(bool $settings): array {
$fileoptions = [
'subdirs' => 0,
'maxfiles' => 1,
'accepted_types' => (
$settings
? ['.txt']
: [
'.txt',
'.zip',
]
),
'return_types' => FILE_INTERNAL,
];
return $fileoptions;
}
/**
* Get file areas returns a list of areas this plugin stores files.
*
* @return array An array of fileareas (keys) and descriptions (values).
*/
public function get_file_areas(): array {
return [
self::ASSIGNSUBMISSION_DTA_FILEAREA_SUBMISSION =>
get_string('dta_submissions_fa', self::ASSIGNSUBMISSION_DTA_COMPONENT_NAME),
self::ASSIGNSUBMISSION_DTA_FILEAREA_TEST =>
get_string('dta_tests_fa', self::ASSIGNSUBMISSION_DTA_COMPONENT_NAME),
];
}
/**
* Produce a list of files suitable for export that represent this feedback or submission.
*
* @param stdClass $submission The submission object.
* @param stdClass $user The user record (unused).
* @return array An array of files indexed by filename.
*/
public function get_files(stdClass $submission, stdClass $user): array {
$result = [];
$fs = get_file_storage();
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
$files = $fs->get_area_files(
$this->assignment->get_context()->id,
self::ASSIGNSUBMISSION_DTA_COMPONENT_NAME,
self::ASSIGNSUBMISSION_DTA_FILEAREA_SUBMISSION,
$submission->id,
'timemodified',
false
);
foreach ($files as $fileobj) {
// Do we return the full folder path or just the file name?
if (isset($submission->exportfullpath) && $submission->exportfullpath === false) {
$result[$fileobj->get_filename()] = $fileobj;
} else {
$result[$fileobj->get_filepath() . $fileobj->get_filename()] = $fileobj;
}
}
return $result;
}
/**
* The plugin is being uninstalled - cleanup.
*
* @return bool
*/
public function delete_instance(): bool {
dta_db_utils::assignsubmission_dta_uninstall_plugin_cleaup();
return true;
}
}