webgrader/exercise.php at main · tsugitools/webgrader · GitHub

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
<?php
/**
 * Assignment defaults, built-in catalog resolution, and first-launch preload.
 *
 * Priority when loading a placement:
 *   1. Built-in key via Settings::linkDefaultConfigurationFromLaunch (Settings / LTI custom / ?exercise=)
 *      (then catalog file / existing link JSON for that built-in)
 *   2. Valid assignment already in lti_link.json
 *   3. Full assignment via Autograder::loadCustomConfig (custom_config / ?inherit= / ?exercise= as rlid)
 *   4. Empty stub
 *
 * On first launch, Settings::linkDefaultConfigurationFromLaunch('exercise', catalog keys) seeds the
 * link settings row from LTI custom or ?exercise= when the value is valid.
 */

require_once __DIR__ . '/assignments.php';

use \Tsugi\Core\Settings;
use \Tsugi\Util\U;
use \Tsugi\Util\Autograder;

/**
 * Cache-bust token for main-thread JS/CSS.
 */
function webgrader_asset_bust() {
    static $bust = null;
    if ($bust !== null) {
        return $bust;
    }
    $files = array(
        __DIR__ . '/js/webgrader.js',
        __DIR__ . '/js/runtime.js',
        __DIR__ . '/js/tests.js',
        __DIR__ . '/js/validation.js',
        __DIR__ . '/js/html-validate.js',
        __DIR__ . '/js/css-validate.js',
        __DIR__ . '/js/axe-validate.js',
        __DIR__ . '/js/console-capture.js',
        __DIR__ . '/css/webgrader.css',
    );
    $parts = array();
    foreach ($files as $path) {
        $parts[] = is_readable($path) ? md5_file($path) : '';
    }
    $bust = substr(md5(implode('|', $parts)), 0, 12);
    return $bust;
}

/**
 * Empty assignment when nothing is configured yet.
 */
function webgrader_empty_exercise() {
    return array(
        'type' => 'webgrader',
        'schema_version' => 1,
        'id' => 'empty',
        'assignment_version' => 1,
        'title' => '',
        'prompt' => '<p>No assignment configured yet. Instructors: open Settings and choose an assignment, or use Edit to author one.</p>',
        'files' => array(
            'html' => array(
                'mode' => 'editable',
                'starter' => "<!DOCTYPE html>\n<html>\n<head>\n  <title>Untitled</title>\n</head>\n<body>\n\n</body>\n</html>\n",
            ),
            'css' => array(
                'mode' => 'hidden',
                'starter' => '',
            ),
            'javascript' => array(
                'mode' => 'hidden',
                'starter' => '',
            ),
        ),
        'runtime' => array(
            'preview' => true,
            'storage' => 'reset_on_run',
        ),
        'assets' => array(),
        'tests' => array(),
        'grading' => array(
            'maximum_points' => 0,
            'partial_credit' => true,
        ),
    );
}

/**
 * True if decoded array looks like a WebGrader assignment.
 */
function webgrader_is_valid_exercise($decoded) {
    return is_array($decoded)
        && isset($decoded['type'])
        && $decoded['type'] === 'webgrader'
        && isset($decoded['prompt'], $decoded['files']);
}

/**
 * Decode a JSON string into an assignment array, or null.
 */
function webgrader_decode_exercise_json($raw) {
    if (!$raw || !is_string($raw) || U::isEmpty($raw)) {
        return null;
    }
    $decoded = json_decode($raw, true);
    if (webgrader_is_valid_exercise($decoded)) {
        return $decoded;
    }
    return null;
}

/**
 * Load assignment from link JSON; else custom config; else built-in; else empty.
 *
 * @return array{exercise: array, assignmentKey: ?string}
 */
function webgrader_load_exercise($LINK) {
    $assignmentKey = Settings::linkDefaultConfigurationFromLaunch(
        'exercise',
        array_keys(webgrader_assignment_catalog())
    );

    $raw = null;
    if ($LINK && method_exists($LINK, 'getJson')) {
        $raw = $LINK->getJson();
    }
    $existing = webgrader_decode_exercise_json($raw);

    if ($assignmentKey) {
        $builtin = webgrader_builtin_exercise($assignmentKey);
        if ($builtin) {
            $jsonBuiltin = (is_array($existing) && isset($existing['builtin']))
                ? $existing['builtin']
                : null;
            $jsonRev = (is_array($existing) && isset($existing['builtin_rev']))
                ? $existing['builtin_rev']
                : null;
            $fileRev = isset($builtin['builtin_rev']) ? $builtin['builtin_rev'] : null;
            $isCustom = ($jsonRev === 'custom');
            $stale = !$isCustom && $fileRev && $jsonRev !== $fileRev;
            if (!$existing || $jsonBuiltin !== $assignmentKey || $stale) {
                if ($LINK && method_exists($LINK, 'setJson') && !empty($LINK->id)) {
                    $LINK->setJson(json_encode($builtin));
                }
                return array(
                    'exercise' => $builtin,
                    'assignmentKey' => $assignmentKey,
                );
            }
            return array(
                'exercise' => $existing,
                'assignmentKey' => $assignmentKey,
            );
        }
    }

    if ($existing) {
        return array(
            'exercise' => $existing,
            'assignmentKey' => $assignmentKey,
        );
    }

    $fromCustom = Autograder::loadCustomConfig('webgrader_is_valid_exercise');
    if ($fromCustom) {
        if ($LINK && method_exists($LINK, 'setJson') && !empty($LINK->id)) {
            $LINK->setJson(json_encode($fromCustom));
        }
        return array(
            'exercise' => $fromCustom,
            'assignmentKey' => $assignmentKey,
        );
    }

    return array(
        'exercise' => webgrader_empty_exercise(),
        'assignmentKey' => $assignmentKey,
    );
}

/**
 * Decode a student submission from result JSON, or null.
 */
function webgrader_decode_submission($raw) {
    if (!$raw || !is_string($raw) || U::isEmpty($raw)) {
        return null;
    }
    $decoded = json_decode($raw, true);
    if (!is_array($decoded)) {
        return null;
    }
    // Full submission object
    if (isset($decoded['schema']) && $decoded['schema'] === 'webgrader-submission'
        && isset($decoded['files']) && is_array($decoded['files'])) {
        return $decoded;
    }
    // Nested under a key (future-proof)
    if (isset($decoded['webgrader_submission']) && is_array($decoded['webgrader_submission'])) {
        $sub = $decoded['webgrader_submission'];
        if (isset($sub['files']) && is_array($sub['files'])) {
            return $sub;
        }
    }
    return null;
}

/**
 * Load current learner submission from RESULT JSON.
 */
function webgrader_load_submission($RESULT) {
    if (!$RESULT || !method_exists($RESULT, 'getJson')) {
        return null;
    }
    return webgrader_decode_submission($RESULT->getJson());
}