An error occurred while loading the file. Please try again.
-
Kurzenberger authored5d3f9422
<?php
namespace assignsubmission_dta;
// 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/>.
/**
* utility class for DTA submission plugin result display
*
* @package assignsubmission_dta
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
use assignsubmission_dta\db_utils;
use assignsubmission_dta\dta_backend_utils;
use assignsubmission_dta\models\dta_result;
use assignsubmission_dta\models\dta_result_summary;
use assignsubmission_dta\models\dta_recommendation;
class view_submission_utils {
/**
* Broadly used in logic, parametrized for easier change.
*/
const COMPONENT_NAME = "assignsubmission_dta";
/**
* generates a short summary html
*
* @param int $assignmentid assignment
* @param int $submissionid submission to create a report for
* @return string html
*/
public static function generate_summary_html(
int $assignmentid,
int $submissionid
): string {
// Fetch data.
$summary = db_utils::get_Result_Summary_From_Database($assignmentid, $submissionid);
$html = "";
// Calculate success rate, if no unknown result states or compilation errors.
$successrate = "?";
if ($summary->unknown_count() == 0 && $summary->compilation_error_count() == 0) {
$successrate = round(($summary->successful_count() / $summary->result_count()) * 100, 2 );
}
// Generate html.
$html .= $summary->successful_count() . "/";
$html .= ($summary->compilation_error_count() == 0 && $summary->unknown_count() == 0)
? $summary->result_Count() . " (" . $successrate . "%)"
: "?";
$html .= get_string("tests_successful", self::COMPONENT_NAME) . "<br />";
if ($summary->compilation_error_count() > 0) {
$html .= $summary->compilation_error_count() . get_string("compilation_errors", self::COMPONENT_NAME) . "<br />";
}
if ($summary->unknown_count() > 0) {
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
$html .= $summary->unknown_count() . get_string("unknown_state", self::COMPONENT_NAME) . "<br />";
}
$showncompetencies = explode(";", $summary->successfultestcompetencies);
$overallcompetencies = explode(";", $summary->overalltestcompetencies);
$tmp = "";
for ($index = 0, $size = count($showncompetencies); $index < $size; $index++) {
$shown = $showncompetencies[$index];
$comp = $overallcompetencies[$index];
// If the competency was actually assessed by the assignment and tests, add a summary entry.
if ($shown != "0") {
$tmp .= get_string("comp" . $index, self::COMPONENT_NAME) .
" " . 100 * floatval($shown) / floatval($comp) . "% " . "<br />";
}
}
$html .= get_string("success_competencies", self::COMPONENT_NAME) . "<br />" . $tmp . "<br />";
return \html_writer::div($html, "dtaSubmissionSummary");
}
/**
* generates detailed view html
*
* @param int $assignmentid assignment
* @param int $submissionid submission to create a report for
*/
public static function generate_detail_html(
int $assignmentid,
int $submissionid
): string {
// Fetch data.
$summary = db_utils::get_result_summary_from_database($assignmentid, $submissionid);
$recommendations = db_utils::get_recommendations_from_database($assignmentid, $submissionid);
$html = "";
// Define a few css classes and prepare html attribute arrays to beautify the output.
$tableheaderrowattributes = ["class" => "dtaTableHeaderRow"];
$tablerowattributes = ["class" => "dtaTableRow"];
$resultrowattributes = $tablerowattributes;
$unknownattributes = 'dtaResultUnknown';
$successattributes = 'dtaResultSuccess';
$failureattributes = 'dtaResultFailure';
$compilationerrorattributes = 'dtaResultCompilationError';
$attributes = ["class" => "dtaTableData"];
// ***************
// SUMMARY TABLE
// ***************
$tmp = "";
$tmp .= \html_writer::tag("th", get_string("summary", self::COMPONENT_NAME), ["class" => "dtaTableHeader"]);
$tmp .= \html_writer::empty_tag("th", ["class" => "dtaTableHeader"]);
$header = \html_writer::tag("tr", $tmp, $tableheaderrowattributes);
$header = \html_writer::tag("thead", $header);
$body = "";
// Total items.
$tmp = "";
$tmp .= \html_writer::tag("td", get_string("total_items", self::COMPONENT_NAME), $attributes);
$tmp .= \html_writer::tag("td", $summary->result_count(), $attributes);
$resultrowattributes = $tablerowattributes;
$resultrowattributes['class'] .= " " . $unknownattributes;
$body .= \html_writer::tag("tr", $tmp, $resultrowattributes);
// Tests successful.
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
$tmp = "";
$tmp .= \html_writer::tag("td", get_string("tests_successful", self::COMPONENT_NAME), $attributes);
$tmp .= \html_writer::tag("td", $summary->successful_count(), $attributes);
$resultrowattributes = $tablerowattributes;
$successrate = "?";
if ($summary->unknown_count() > 0 || $summary->compilation_error_count() > 0) {
$resultrowattributes['class'] .= " " . $unknownattributes;
} else {
$successrate = round(($summary->successful_count() / $summary->result_count()) * 100, 2);
if ($successrate < 50) {
$resultrowattributes['class'] .= " " . $compilationerrorattributes;
} else if ($successrate < 75) {
$resultrowattributes['class'] .= " " . $failureattributes;
} else {
$resultrowattributes['class'] .= " " . $successattributes;
}
}
$body .= \html_writer::tag("tr", $tmp, $resultrowattributes);
// Failures.
$tmp = "";
$tmp .= \html_writer::tag("td", get_string("failures", self::COMPONENT_NAME), $attributes);
$tmp .= \html_writer::tag("td", $summary->failed_count(), $attributes);
$resultrowattributes = $tablerowattributes;
if ($summary->failed_count() > 0) {
$resultrowattributes['class'] .= " " . $failureattributes;
} else {
$resultrowattributes['class'] .= " " . $successattributes;
}
$body .= \html_writer::tag("tr", $tmp, $resultrowattributes);
// Compilation errors.
$tmp = "";
$tmp .= \html_writer::tag("td", get_string("compilation_errors", self::COMPONENT_NAME), $attributes);
$tmp .= \html_writer::tag("td", $summary->compilation_error_count(), $attributes);
$resultrowattributes = $tablerowattributes;
if ($summary->compilation_error_count() > 0) {
$resultrowattributes['class'] .= " " . $compilationerrorattributes;
} else {
$resultrowattributes['class'] .= " " . $successattributes;
}
$body .= \html_writer::tag("tr", $tmp, $resultrowattributes);
// Unknown state.
$tmp = "";
$tmp .= \html_writer::tag("td", get_string("unknown_state", self::COMPONENT_NAME), $attributes);
$tmp .= \html_writer::tag("td", $summary->unknown_count(), $attributes);
$resultrowattributes = $tablerowattributes;
if ($summary->unknown_count() > 0) {
$resultrowattributes['class'] .= " " . $unknownattributes;
} else {
$resultrowattributes['class'] .= " " . $successattributes;
}
$body .= \html_writer::tag("tr", $tmp, $resultrowattributes);
// Success rate.
$tmp = "";
$tmp .= \html_writer::tag("td", \html_writer::tag("b", get_string("success_rate", self::COMPONENT_NAME)), $attributes);
$tmp .= \html_writer::tag(
"td",
\html_writer::tag("b", $summary->successful_count() . "/" .
(($summary->compilation_error_count() == 0 && $summary->unknown_count() == 0)
? $summary->result_count() . " (" . $successrate . "%)"
: "?")),
$attributes
);
$resultrowattributes = $tablerowattributes;
if ($summary->unknown_count() > 0 || $summary->compilation_error_count() > 0) {
$resultrowattributes['class'] .= " " . $unknownattributes;
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
} else {
if ($successrate < 50) {
$resultrowattributes['class'] .= " " . $compilationerrorattributes;
} else if ($successrate < 75) {
$resultrowattributes['class'] .= " " . $failureattributes;
} else {
$resultrowattributes['class'] .= " " . $successattributes;
}
}
$body .= \html_writer::tag("tr", $tmp, $resultrowattributes);
$body = \html_writer::tag("tbody", $body);
$table = \html_writer::tag("table", $header . $body, ["class" => "dtaTable"]);
$html .= $table;
// Add empty div for spacing after summary.
$html .= \html_writer::empty_tag("div", ["class" => "dtaSpacer"]);
// ***************
// RECOMMENDATIONS TABLE
// ***************
if (!empty($recommendations)) {
// Sorting logic.
$allowed_sort_fields = ['topic', 'exercise_name', 'difficulty', 'score'];
$allowed_sort_dirs = ['asc', 'desc'];
$sortby = isset($_POST['sortby']) ? $_POST['sortby'] : 'score';
$sortdir = isset($_POST['sortdir']) ? $_POST['sortdir'] : 'asc';
if (!in_array($sortby, $allowed_sort_fields)) {
$sortby = 'score';
}
if (!in_array($sortdir, $allowed_sort_dirs)) {
$sortdir = 'asc';
}
usort($recommendations, function($a, $b) use ($sortby, $sortdir) {
$valueA = $a->{$sortby};
$valueB = $b->{$sortby};
if (is_numeric($valueA) && is_numeric($valueB)) {
$comparison = $valueA - $valueB;
} else {
$comparison = strnatcasecmp($valueA, $valueB);
}
if ($comparison == 0) {
return 0;
}
if ($sortdir == 'asc') {
return ($comparison < 0) ? -1 : 1;
} else {
return ($comparison < 0) ? 1 : -1;
}
});
$html .= \html_writer::tag('h3', get_string('recommendations', self::COMPONENT_NAME));
$generate_sortable_header = function($column_name, $display_name) use ($sortby, $sortdir) {
$new_sortdir = ($sortby == $column_name && $sortdir == 'asc') ? 'desc' : 'asc';
$class = 'dtaTableHeader';
if ($sortby == $column_name) {
$class .= ' sorted ' . $sortdir;
}
// Sort button.
$button = \html_writer::empty_tag('input', [
'type' => 'submit',
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
'name' => 'sortbutton',
'value' => ($new_sortdir == 'asc' ? '↑' : '↓'),
'class' => 'sort-button'
]);
// Hidden inputs.
$hidden_inputs = \html_writer::empty_tag('input', [
'type' => 'hidden',
'name' => 'sortby',
'value' => $column_name
]);
$hidden_inputs .= \html_writer::empty_tag('input', [
'type' => 'hidden',
'name' => 'sortdir',
'value' => $new_sortdir
]);
$form = \html_writer::start_tag('form', ['method' => 'post', 'style' => 'display:inline']);
$form .= $hidden_inputs;
$form .= $display_name . ' ' . $button;
$form .= \html_writer::end_tag('form');
return \html_writer::tag("th", $form, ["class" => $class]);
};
// Table header for recommendations.
$tableheader = "";
$tableheader .= $generate_sortable_header('topic', get_string("topic", self::COMPONENT_NAME));
$tableheader .= $generate_sortable_header('exercise_name', get_string("exercise_name", self::COMPONENT_NAME));
$tableheader .= \html_writer::tag("th", get_string("url", self::COMPONENT_NAME), ["class" => "dtaTableHeader"]);
$tableheader .= $generate_sortable_header('difficulty', get_string("difficulty", self::COMPONENT_NAME));
$tableheader .= $generate_sortable_header('score', get_string("score", self::COMPONENT_NAME));
$tableheader = \html_writer::tag("tr", $tableheader, ["class" => "dtaTableHeaderRow"]);
$tableheader = \html_writer::tag("thead", $tableheader);
// Table body for recommendations.
$tablebody = "";
foreach ($recommendations as $recommendation) {
$tablerow = "";
$tablerow .= \html_writer::tag("td", $recommendation->topic, $attributes);
$tablerow .= \html_writer::tag("td", $recommendation->exercise_name, $attributes);
$tablerow .= \html_writer::tag("td", \html_writer::link($recommendation->url, $recommendation->url), $attributes);
$tablerow .= \html_writer::tag("td", $recommendation->difficulty, $attributes);
$tablerow .= \html_writer::tag("td", $recommendation->score, $attributes);
$tablebody .= \html_writer::tag("tr", $tablerow, $tablerowattributes);
}
$tablebody = \html_writer::tag("tbody", $tablebody);
$html .= \html_writer::tag("table", $tableheader . $tablebody, ["class" => "dtaTable"]);
// Add empty div for spacing after recommendations.
$html .= \html_writer::empty_tag("div", ["class" => "dtaSpacer"]);
}
// ***************
// COMPETENCY ASSESSMENT TABLE
// ***************
$body = "";
$tmp = "";
$tmp .= \html_writer::tag("th", get_string("competencies", self::COMPONENT_NAME), ["class" => "dtaTableHeader"]);
$tmp .= \html_writer::empty_tag("th", ["class" => "dtaTableHeader"]);
$header = \html_writer::tag("tr", $tmp, $tableheaderrowattributes);
$header = \html_writer::tag("thead", $header);
$showncompetencies = explode(";", $summary->successfultestcompetencies);
$overallcompetencies = explode(";", $summary->overalltestcompetencies);
for ($index = 0, $size = count($overallcompetencies); $index < $size; $index++) {
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
$comp = $overallcompetencies[$index];
$shown = $showncompetencies[$index];
// If the competency was actually assessed by the assignment and tests, add a row in the table.
if ($comp != "0") {
$resultrowattributes = $tablerowattributes;
$tmp = "";
$tmp .= \html_writer::tag("td", get_string("comp" . $index, self::COMPONENT_NAME), $resultrowattributes);
$tmp .= \html_writer::tag("td", (100 * floatval($shown) / floatval($comp)) . "% (" . $shown . " / " . $comp . ")", $resultrowattributes);
$tmp .= \html_writer::tag("td", get_string("comp_expl" . $index, self::COMPONENT_NAME), $resultrowattributes);
$body .= \html_writer::tag("tr", $tmp, $resultrowattributes);
}
}
$body = \html_writer::tag("tbody", $body);
$html .= \html_writer::tag("table", $header . $body, ["class" => "dtaTable"]);
// Add empty div for spacing between competency and details table.
$html .= \html_writer::empty_tag("div", ["class" => "dtaSpacer"]);
// ***************
// DETAILS TABLE
// ***************
$tmp = "";
$tmp .= \html_writer::tag("th", get_string("details", self::COMPONENT_NAME), ["class" => "dtaTableHeader"]);
$tmp .= \html_writer::empty_tag("th", ["class" => "dtaTableHeader"]);
$header = \html_writer::tag("tr", $tmp, $tableheaderrowattributes);
$header = \html_writer::tag("thead", $header);
$body = "";
$spacerrow = null;
foreach ($summary->results as $r) {
// Add spacer first if not null.
if (!is_null($spacerrow)) {
$body .= $spacerrow;
}
$resultrowattributes = $tablerowattributes;
// Set CSS class for colored left-border according to results state.
if ($r->state == 0) {
$resultrowattributes['class'] .= ' dtaResultUnknown';
} else if ($r->state == 1) {
$resultrowattributes['class'] .= ' dtaResultSuccess';
} else if ($r->state == 2) {
$resultrowattributes['class'] .= ' dtaResultFailure';
} else if ($r->state == 3) {
$resultrowattributes['class'] .= ' dtaResultCompilationError';
}
$tmp = "";
$tmp .= \html_writer::tag("td", get_string("package_name", self::COMPONENT_NAME), $attributes);
$tmp .= \html_writer::tag("td", $r->packagename, $attributes);
$tmp .= \html_writer::tag("td", get_string("unit_name", self::COMPONENT_NAME), $attributes);
$tmp .= \html_writer::tag("td", $r->classname, $attributes);
$tmp .= \html_writer::tag("td", get_string("test_name", self::COMPONENT_NAME), $attributes);
$tmp .= \html_writer::tag("td", $r->name, $attributes);
$body .= \html_writer::tag("tr", $tmp, $resultrowattributes);
$tmp = "";
$tmp .= \html_writer::tag("td", get_string("status", self::COMPONENT_NAME), $attributes);
$tmp .= \html_writer::tag("td", dta_result::get_statename($r->state), $attributes);
$body .= \html_writer::tag("tr", $tmp, $resultrowattributes);
// If state is different than successful, show additional info.
if ($r->state != 1) {
$tmp = "";
$tmp .= \html_writer::tag("td", get_string("failure_type", self::COMPONENT_NAME), $attributes);
$tmp .= \html_writer::tag("td", $r->failureType, $attributes);
$body .= \html_writer::tag("tr", $tmp, $resultrowattributes);
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
$tmp = "";
$tmp .= \html_writer::tag("td", get_string("failure_reason", self::COMPONENT_NAME), $attributes);
$tmp .= \html_writer::tag("td", $r->failureReason, $attributes);
$body .= \html_writer::tag("tr", $tmp, $resultrowattributes);
if (!is_null($r->lineNumber) && $r->lineNumber > 0) {
$tmp = "";
$tmp .= \html_writer::tag("td", get_string("line_no", self::COMPONENT_NAME), $attributes);
$tmp .= \html_writer::tag("td", $r->lineNumber, $attributes);
$body .= \html_writer::tag("tr", $tmp, $resultrowattributes);
}
if (!is_null($r->columnNumber) && $r->columnNumber > 0) {
$tmp = "";
$tmp .= \html_writer::tag("td", get_string("col_no", self::COMPONENT_NAME), $attributes);
$tmp .= \html_writer::tag("td", $r->columnNumber, $attributes);
$body .= \html_writer::tag("tr", $tmp, $resultrowattributes);
}
if (!is_null($r->position) && $r->position > 0) {
$tmp = "";
$tmp .= \html_writer::tag("td", get_string("pos", self::COMPONENT_NAME), $attributes);
$tmp .= \html_writer::tag("td", $r->position, $attributes);
$body .= \html_writer::tag("tr", $tmp, $resultrowattributes);
}
$tmp = "";
$tmp .= \html_writer::tag("td", get_string("stacktrace", self::COMPONENT_NAME), $attributes);
$tmp .= \html_writer::tag("td", \html_writer::tag("details", $r->stacktrace, ["class" => "dtaStacktraceDetails"]), $attributes);
$body .= \html_writer::tag("tr", $tmp, $resultrowattributes);
}
if (is_null($spacerrow)) {
$spacerrow = \html_writer::empty_tag("tr", ["class" => "dtaTableSpacer"]);
}
}
$html .= \html_writer::tag("table", $header . $body, ["class" => "dtaTable"]);
// Wrap generated html into final div.
$html = \html_writer::div($html, "dtaSubmissionDetails");
return $html;
}
}