weekly release 2.3dev
[moodle.git] / mod / scorm / mod_form.php
CommitLineData
a4813c36 1<?php
f7b5c6aa
DM
2// This file is part of Moodle - http://moodle.org/
3//
4// Moodle is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
8//
9// Moodle is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12// GNU General Public License for more details.
13//
14// You should have received a copy of the GNU General Public License
15// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
16
bfebaf64
MD
17if (!defined('MOODLE_INTERNAL')) {
18 die('Direct access to this script is forbidden.'); /// It must be included from a Moodle page
19}
20
ca4eda13 21require_once($CFG->dirroot.'/course/moodleform_mod.php');
a4813c36 22require_once($CFG->dirroot.'/mod/scorm/locallib.php');
23
24class mod_scorm_mod_form extends moodleform_mod {
25
26 function definition() {
6aff538a 27 global $CFG, $COURSE, $OUTPUT;
30fc6e2d 28 $cfg_scorm = get_config('scorm');
a4813c36 29
9528568b 30 $mform = $this->_form;
31
9528568b 32 if (!$CFG->slasharguments) {
ca4eda13 33 $mform->addElement('static', '', '', $OUTPUT->notification(get_string('slashargs', 'scorm'), 'notifyproblem'));
01e6c030 34 }
ca4eda13 35 //-------------------------------------------------------------------------------
a4813c36 36 $mform->addElement('header', 'general', get_string('general', 'form'));
37
ca4eda13 38 // Name
a4813c36 39 $mform->addElement('text', 'name', get_string('name'));
8eb1d25f 40 if (!empty($CFG->formatstringstriptags)) {
41 $mform->setType('name', PARAM_TEXT);
42 } else {
b8ea3041 43 $mform->setType('name', PARAM_CLEANHTML);
8eb1d25f 44 }
a4813c36 45 $mform->addRule('name', null, 'required', null, 'client');
46
ca4eda13 47 // Summary
ac3668bf 48 $this->add_intro_editor(true);
a4813c36 49
ca4eda13 50 // Scorm types
8aba9cda 51 $scormtypes = array(SCORM_TYPE_LOCAL => get_string('typelocal', 'scorm'));
9528568b 52
30fc6e2d 53 if ($cfg_scorm->allowtypeexternal) {
8aba9cda 54 $scormtypes[SCORM_TYPE_EXTERNAL] = get_string('typeexternal', 'scorm');
9528568b 55 }
56
30fc6e2d 57 if ($cfg_scorm->allowtypelocalsync) {
8aba9cda 58 $scormtypes[SCORM_TYPE_LOCALSYNC] = get_string('typelocalsync', 'scorm');
9528568b 59 }
60
30fc6e2d 61 if (!empty($CFG->repositoryactivate) and $cfg_scorm->allowtypeimsrepository) {
8aba9cda 62 $scormtypes[SCORM_TYPE_IMSREPOSITORY] = get_string('typeimsrepository', 'scorm');
9528568b 63 }
64
4388bd45 65 if ($cfg_scorm->allowtypeexternalaicc) {
8aba9cda 66 $scormtypes[SCORM_TYPE_AICCURL] = get_string('typeaiccurl', 'scorm');
4388bd45
DM
67 }
68
ca4eda13 69 // Reference
8aba9cda
DM
70 if (count($scormtypes) > 1) {
71 $mform->addElement('select', 'scormtype', get_string('scormtype', 'scorm'), $scormtypes);
427bcd4d
DM
72 $mform->addHelpButton('scormtype', 'scormtype', 'scorm');
73 $mform->addElement('text', 'packageurl', get_string('packageurl', 'scorm'), array('size'=>60));
9528568b 74 $mform->setType('packageurl', PARAM_RAW);
427bcd4d 75 $mform->addHelpButton('packageurl', 'packageurl', 'scorm');
9528568b 76 $mform->disabledIf('packageurl', 'scormtype', 'eq', SCORM_TYPE_LOCAL);
e73d5557
DM
77 } else {
78 $mform->addElement('hidden', 'scormtype', SCORM_TYPE_LOCAL);
9528568b 79 }
80
ca4eda13 81 // New local package upload
560417ff 82 $maxbytes = get_max_upload_file_size($CFG->maxbytes, $COURSE->maxbytes);
83 $mform->setMaxFileSize($maxbytes);
ca4eda13 84 $mform->addElement('filepicker', 'packagefile', get_string('package', 'scorm'));
427bcd4d 85 $mform->addHelpButton('packagefile', 'package', 'scorm');
9528568b 86 $mform->disabledIf('packagefile', 'scormtype', 'noteq', SCORM_TYPE_LOCAL);
a4813c36 87
ca4eda13
DM
88 //-------------------------------------------------------------------------------
89 // Time restrictions
d54e2145 90 $mform->addElement('header', 'timerestricthdr', get_string('timerestrict', 'scorm'));
d54e2145 91
ca4eda13
DM
92 $mform->addElement('date_time_selector', 'timeopen', get_string("scormopen", "scorm"), array('optional' => true));
93 $mform->addElement('date_time_selector', 'timeclose', get_string("scormclose", "scorm"), array('optional' => true));
94 //-------------------------------------------------------------------------------
0ffaa76b 95 // display Settings
3c0b04c4 96 $mform->addElement('header', 'displaysettings', get_string('displaysettings', 'scorm'));
0ffaa76b
DM
97 // Framed / Popup Window
98 $mform->addElement('select', 'popup', get_string('display', 'scorm'), scorm_get_popup_display_array());
99 $mform->setDefault('popup', $cfg_scorm->popup);
100 $mform->setAdvanced('popup', $cfg_scorm->popup_adv);
101
102 // Width
103 $mform->addElement('text', 'width', get_string('width', 'scorm'), 'maxlength="5" size="5"');
104 $mform->setDefault('width', $cfg_scorm->framewidth);
105 $mform->setType('width', PARAM_INT);
106 $mform->setAdvanced('width', $cfg_scorm->framewidth_adv);
107 $mform->disabledIf('width', 'popup', 'eq', 0);
108
109 // Height
110 $mform->addElement('text', 'height', get_string('height', 'scorm'), 'maxlength="5" size="5"');
111 $mform->setDefault('height', $cfg_scorm->frameheight);
112 $mform->setType('height', PARAM_INT);
113 $mform->setAdvanced('height', $cfg_scorm->frameheight_adv);
114 $mform->disabledIf('height', 'popup', 'eq', 0);
115
116 // Window Options
117 $winoptgrp = array();
118 foreach (scorm_get_popup_options_array() as $key => $value) {
119 $winoptgrp[] = &$mform->createElement('checkbox', $key, '', get_string($key, 'scorm'));
120 $mform->setDefault($key, $value);
121 }
122 $mform->addGroup($winoptgrp, 'winoptgrp', get_string('options', 'scorm'), '<br />', false);
123 $mform->disabledIf('winoptgrp', 'popup', 'eq', 0);
124 $mform->setAdvanced('winoptgrp', $cfg_scorm->winoptgrp_adv);
125
126 // Skip view page
127 $mform->addElement('select', 'skipview', get_string('skipview', 'scorm'), scorm_get_skip_view_array());
128 $mform->addHelpButton('skipview', 'skipview', 'scorm');
129 $mform->setDefault('skipview', $cfg_scorm->skipview);
130 $mform->setAdvanced('skipview', $cfg_scorm->skipview_adv);
131
132 // Hide Browse
133 $mform->addElement('selectyesno', 'hidebrowse', get_string('hidebrowse', 'scorm'));
134 $mform->addHelpButton('hidebrowse', 'hidebrowse', 'scorm');
135 $mform->setDefault('hidebrowse', $cfg_scorm->hidebrowse);
136 $mform->setAdvanced('hidebrowse', $cfg_scorm->hidebrowse_adv);
137
138 // Display course structure
139 $mform->addElement('selectyesno', 'displaycoursestructure', get_string('displaycoursestructure', 'scorm'));
140 $mform->addHelpButton('displaycoursestructure', 'displaycoursestructure', 'scorm');
141 $mform->setDefault('displaycoursestructure', $cfg_scorm->displaycoursestructure);
142 $mform->setAdvanced('displaycoursestructure', $cfg_scorm->displaycoursestructure_adv);
143
144 // Toc display
145 $mform->addElement('select', 'hidetoc', get_string('hidetoc', 'scorm'), scorm_get_hidetoc_array());
146 $mform->addHelpButton('hidetoc', 'hidetoc', 'scorm');
147 $mform->setDefault('hidetoc', $cfg_scorm->hidetoc);
148 $mform->setAdvanced('hidetoc', $cfg_scorm->hidetoc_adv);
149
150 // Hide Navigation panel
151 $mform->addElement('selectyesno', 'hidenav', get_string('hidenav', 'scorm'));
152 $mform->setDefault('hidenav', $cfg_scorm->hidenav);
153 $mform->setAdvanced('hidenav', $cfg_scorm->hidenav_adv);
93e46331 154 $mform->disabledIf('hidenav', 'hidetoc', 'noteq', 0);
0ffaa76b
DM
155
156 //-------------------------------------------------------------------------------
157 // grade Settings
3c0b04c4 158 $mform->addElement('header', 'gradesettings', get_string('gradesettings', 'scorm'));
a4813c36 159
ca4eda13 160 // Grade Method
30fc6e2d 161 $mform->addElement('select', 'grademethod', get_string('grademethod', 'scorm'), scorm_get_grade_method_array());
c329e370 162 $mform->addHelpButton('grademethod', 'grademethod', 'scorm');
30fc6e2d 163 $mform->setDefault('grademethod', $cfg_scorm->grademethod);
0ffaa76b 164 $mform->setAdvanced('grademethod', $cfg_scorm->grademethod_adv);
3268cf99 165
ca4eda13 166 // Maximum Grade
a4813c36 167 for ($i=0; $i<=100; $i++) {
ca4eda13 168 $grades[$i] = "$i";
a4813c36 169 }
170 $mform->addElement('select', 'maxgrade', get_string('maximumgrade'), $grades);
30fc6e2d 171 $mform->setDefault('maxgrade', $cfg_scorm->maxgrade);
ca4eda13 172 $mform->disabledIf('maxgrade', 'grademethod', 'eq', GRADESCOES);
0ffaa76b 173 $mform->setAdvanced('maxgrade', $cfg_scorm->maxgrade_adv);
a4813c36 174
3c0b04c4 175 $mform->addElement('header', 'othersettings', get_string('othersettings', 'scorm'));
a4813c36 176
ca4eda13 177 // Max Attempts
30fc6e2d 178 $mform->addElement('select', 'maxattempt', get_string('maximumattempts', 'scorm'), scorm_get_attempts_array());
c329e370 179 $mform->addHelpButton('maxattempt', 'maximumattempts', 'scorm');
30fc6e2d 180 $mform->setDefault('maxattempt', $cfg_scorm->maxattempts);
0ffaa76b 181 $mform->setAdvanced('maxattempt', $cfg_scorm->maxattempts_adv);
3268cf99 182
ca4eda13 183 // What Grade
87db13b5 184 $mform->addElement('select', 'whatgrade', get_string('whatgrade', 'scorm'), scorm_get_what_grade_array());
ca4eda13 185 $mform->disabledIf('whatgrade', 'maxattempt', 'eq', 1);
c329e370 186 $mform->addHelpButton('whatgrade', 'whatgrade', 'scorm');
87db13b5 187 $mform->setDefault('whatgrade', $cfg_scorm->whatgrade);
0ffaa76b 188 $mform->setAdvanced('whatgrade', $cfg_scorm->whatgrade_adv);
87db13b5 189
ca4eda13 190 // Display attempt status
6381fa56 191 $mform->addElement('selectyesno', 'displayattemptstatus', get_string('displayattemptstatus', 'scorm'));
c329e370 192 $mform->addHelpButton('displayattemptstatus', 'displayattemptstatus', 'scorm');
30fc6e2d 193 $mform->setDefault('displayattemptstatus', $cfg_scorm->displayattemptstatus);
0ffaa76b 194 $mform->setAdvanced('displayattemptstatus', $cfg_scorm->displayattemptstatus_adv);
3268cf99 195
ca4eda13 196 // Force completed
6381fa56 197 $mform->addElement('selectyesno', 'forcecompleted', get_string('forcecompleted', 'scorm'));
c329e370 198 $mform->addHelpButton('forcecompleted', 'forcecompleted', 'scorm');
30fc6e2d 199 $mform->setDefault('forcecompleted', $cfg_scorm->forcecompleted);
0ffaa76b 200 $mform->setAdvanced('forcecompleted', $cfg_scorm->forcecompleted_adv);
6381fa56 201
ca4eda13 202 // Force new attempt
6381fa56 203 $mform->addElement('selectyesno', 'forcenewattempt', get_string('forcenewattempt', 'scorm'));
c329e370 204 $mform->addHelpButton('forcenewattempt', 'forcenewattempt', 'scorm');
30fc6e2d 205 $mform->setDefault('forcenewattempt', $cfg_scorm->forcenewattempt);
0ffaa76b 206 $mform->setAdvanced('forcenewattempt', $cfg_scorm->forcenewattempt_adv);
3268cf99 207
ca4eda13 208 // Last attempt lock - lock the enter button after the last available attempt has been made
6381fa56 209 $mform->addElement('selectyesno', 'lastattemptlock', get_string('lastattemptlock', 'scorm'));
c329e370 210 $mform->addHelpButton('lastattemptlock', 'lastattemptlock', 'scorm');
30fc6e2d 211 $mform->setDefault('lastattemptlock', $cfg_scorm->lastattemptlock);
0ffaa76b 212 $mform->setAdvanced('lastattemptlock', $cfg_scorm->lastattemptlock_adv);
3268cf99 213
ca4eda13 214 // Activation period
2b90f941 215/* $mform->addElement('static', '', '' ,'<hr />');
a4813c36 216 $mform->addElement('static', 'activation', get_string('activation','scorm'));
217 $datestartgrp = array();
218 $datestartgrp[] = &$mform->createElement('date_time_selector', 'startdate');
219 $datestartgrp[] = &$mform->createElement('checkbox', 'startdisabled', null, get_string('disable'));
220 $mform->addGroup($datestartgrp, 'startdategrp', get_string('from'), ' ', false);
221 $mform->setDefault('startdate', 0);
222 $mform->setDefault('startdisabled', 1);
223 $mform->disabledIf('startdategrp', 'startdisabled', 'checked');
224
225 $dateendgrp = array();
226 $dateendgrp[] = &$mform->createElement('date_time_selector', 'enddate');
227 $dateendgrp[] = &$mform->createElement('checkbox', 'enddisabled', null, get_string('disable'));
228 $mform->addGroup($dateendgrp, 'dateendgrp', get_string('to'), ' ', false);
229 $mform->setDefault('enddate', 0);
230 $mform->setDefault('enddisabled', 1);
231 $mform->disabledIf('dateendgrp', 'enddisabled', 'checked');
2b90f941 232*/
3268cf99 233
ca4eda13 234 // Autocontinue
a4813c36 235 $mform->addElement('selectyesno', 'auto', get_string('autocontinue', 'scorm'));
c329e370 236 $mform->addHelpButton('auto', 'autocontinue', 'scorm');
30fc6e2d 237 $mform->setDefault('auto', $cfg_scorm->auto);
0ffaa76b 238 $mform->setAdvanced('auto', $cfg_scorm->auto_adv);
a4813c36 239
8aba9cda
DM
240 if (count($scormtypes) > 1) {
241 // Update packages timing
242 $mform->addElement('select', 'updatefreq', get_string('updatefreq', 'scorm'), scorm_get_updatefreq_array());
243 $mform->setDefault('updatefreq', $cfg_scorm->updatefreq);
244 $mform->setAdvanced('updatefreq', $cfg_scorm->updatefreq_adv);
245 $mform->addHelpButton('updatefreq', 'updatefreq', 'scorm');
246 $mform->disabledIf('updatefreq', 'scormtype', 'eq', SCORM_TYPE_LOCAL);
247 } else {
248 $mform->addElement('hidden', 'updatefreq', 0);
249 }
ca4eda13
DM
250 //-------------------------------------------------------------------------------
251 // Hidden Settings
a4813c36 252 $mform->addElement('hidden', 'datadir', null);
d18e0fe6 253 $mform->setType('datadir', PARAM_RAW);
a4813c36 254 $mform->addElement('hidden', 'pkgtype', null);
d18e0fe6 255 $mform->setType('pkgtype', PARAM_RAW);
a4813c36 256 $mform->addElement('hidden', 'launch', null);
d18e0fe6 257 $mform->setType('launch', PARAM_RAW);
a4813c36 258 $mform->addElement('hidden', 'redirect', null);
d18e0fe6 259 $mform->setType('redirect', PARAM_RAW);
a4813c36 260 $mform->addElement('hidden', 'redirecturl', null);
d18e0fe6 261 $mform->setType('redirecturl', PARAM_RAW);
a4813c36 262
ca4eda13 263 //-------------------------------------------------------------------------------
42f103be 264 $this->standard_coursemodule_elements();
ca4eda13 265 //-------------------------------------------------------------------------------
a4813c36 266 // buttons
267 $this->add_action_buttons();
a4813c36 268 }
269
728d0599 270 function data_preprocessing(&$default_values) {
a4813c36 271 global $COURSE;
272
273 if (isset($default_values['popup']) && ($default_values['popup'] == 1) && isset($default_values['options'])) {
1adc77e6 274 if (!empty($default_values['options'])) {
ca4eda13 275 $options = explode(',', $default_values['options']);
1adc77e6 276 foreach ($options as $option) {
ca4eda13 277 list($element, $value) = explode('=', $option);
1adc77e6 278 $element = trim($element);
279 $default_values[$element] = trim($value);
280 }
a4813c36 281 }
282 }
283 if (isset($default_values['grademethod'])) {
adefe70e 284 $default_values['grademethod'] = intval($default_values['grademethod']);
a4813c36 285 }
ca4eda13 286 if (isset($default_values['width']) && (strpos($default_values['width'], '%') === false) && ($default_values['width'] <= 100)) {
efe95a6f 287 $default_values['width'] .= '%';
a4813c36 288 }
ca4eda13 289 if (isset($default_values['width']) && (strpos($default_values['height'], '%') === false) && ($default_values['height'] <= 100)) {
efe95a6f 290 $default_values['height'] .= '%';
a4813c36 291 }
292 $scorms = get_all_instances_in_course('scorm', $COURSE);
293 $coursescorm = current($scorms);
b76f2e60
DC
294
295 $draftitemid = file_get_submitted_draft_itemid('packagefile');
783f1486 296 file_prepare_draft_area($draftitemid, $this->context->id, 'mod_scorm', 'package', 0);
b76f2e60
DC
297 $default_values['packagefile'] = $draftitemid;
298
a4813c36 299 if (($COURSE->format == 'scorm') && ((count($scorms) == 0) || ($default_values['instance'] == $coursescorm->id))) {
300 $default_values['redirect'] = 'yes';
9528568b 301 $default_values['redirecturl'] = '../course/view.php?id='.$default_values['course'];
a4813c36 302 } else {
303 $default_values['redirect'] = 'no';
304 $default_values['redirecturl'] = '../mod/scorm/view.php?id='.$default_values['coursemodule'];
305 }
306 if (isset($default_values['version'])) {
ca4eda13 307 $default_values['pkgtype'] = (substr($default_values['version'], 0, 5) == 'SCORM') ? 'scorm':'aicc';
a4813c36 308 }
309 if (isset($default_values['instance'])) {
310 $default_values['datadir'] = $default_values['instance'];
311 }
d54e2145 312 if (empty($default_values['timeopen'])) {
413900b4
DM
313 $default_values['timeopen'] = 0;
314 }
315 if (empty($default_values['timeclose'])) {
316 $default_values['timeclose'] = 0;
d54e2145 317 }
a4813c36 318 }
319
a78890d5 320 function validation($data, $files) {
d3d98a3a 321 global $CFG;
a78890d5 322 $errors = parent::validation($data, $files);
60243313 323
9528568b 324 $type = $data['scormtype'];
325
326 if ($type === SCORM_TYPE_LOCAL) {
327 if (!empty($data['update'])) {
328 //ok, not required
a679d64d 329
d3d98a3a 330 } else if (empty($data['packagefile'])) {
9528568b 331 $errors['packagefile'] = get_string('required');
332
333 } else {
d3d98a3a
DC
334 $files = $this->get_draft_files('packagefile');
335 if (count($files)<1) {
336 $errors['packagefile'] = get_string('required');
9eb8dccc 337 return $errors;
d3d98a3a
DC
338 }
339 $file = reset($files);
7aa06e6d 340 $filename = $CFG->tempdir.'/scormimport/scrom_'.time();
af9b1444 341 make_temp_directory('scormimport');
d3d98a3a
DC
342 $file->copy_content_to($filename);
343
9528568b 344 $packer = get_file_packer('application/zip');
345
d3d98a3a 346 $filelist = $packer->list_files($filename);
9528568b 347 if (!is_array($filelist)) {
348 $errors['packagefile'] = 'Incorrect file package - not an archive'; //TODO: localise
349 } else {
350 $manifestpresent = false;
351 $aiccfound = false;
352 foreach ($filelist as $info) {
353 if ($info->pathname == 'imsmanifest.xml') {
354 $manifestpresent = true;
355 break;
356 }
357 if (preg_match('/\.cst$/', $info->pathname)) {
358 $aiccfound = true;
359 break;
360 }
361 }
362 if (!$manifestpresent and !$aiccfound) {
363 $errors['packagefile'] = 'Incorrect file package - missing imsmanifest.xml or AICC structure'; //TODO: localise
364 }
365 }
d3d98a3a 366 unlink($filename);
9528568b 367 }
368
369 } else if ($type === SCORM_TYPE_EXTERNAL) {
370 $reference = $data['packageurl'];
371 if (!preg_match('/(http:\/\/|https:\/\/|www).*\/imsmanifest.xml$/i', $reference)) {
4388bd45 372 $errors['packageurl'] = get_string('invalidurl', 'scorm');
9528568b 373 }
374
375 } else if ($type === 'packageurl') {
376 $reference = $data['reference'];
377 if (!preg_match('/(http:\/\/|https:\/\/|www).*(\.zip|\.pif)$/i', $reference)) {
4388bd45 378 $errors['packageurl'] = get_string('invalidurl', 'scorm');
9528568b 379 }
380
381 } else if ($type === SCORM_TYPE_IMSREPOSITORY) {
382 $reference = $data['packageurl'];
383 if (stripos($reference, '#') !== 0) {
4388bd45
DM
384 $errors['packageurl'] = get_string('invalidurl', 'scorm');
385 }
386 } else if ($type === SCORM_TYPE_AICCURL) {
387 $reference = $data['packageurl'];
388 if (!preg_match('/(http:\/\/|https:\/\/|www).*/', $reference)) {
389 $errors['packageurl'] = get_string('invalidurl', 'scorm');
9528568b 390 }
60243313 391 }
392
a78890d5 393 return $errors;
a679d64d 394 }
9528568b 395
396 //need to translate the "options" and "reference" field.
ea38a6b9 397 function set_data($default_values) {
9528568b 398 $default_values = (array)$default_values;
399
400 if (isset($default_values['scormtype']) and isset($default_values['reference'])) {
401 switch ($default_values['scormtype']) {
402 case SCORM_TYPE_LOCALSYNC :
403 case SCORM_TYPE_EXTERNAL:
404 case SCORM_TYPE_IMSREPOSITORY:
047b4e83 405 case SCORM_TYPE_AICCURL:
9528568b 406 $default_values['packageurl'] = $default_values['reference'];
407 }
408 }
409 unset($default_values['reference']);
410
411 if (!empty($default_values['options'])) {
412 $options = explode(',', $default_values['options']);
413 foreach ($options as $option) {
414 $opt = explode('=', $option);
415 if (isset($opt[1])) {
9b426d03 416 $default_values[$opt[0]] = $opt[1];
ea38a6b9 417 }
418 }
ea38a6b9 419 }
9528568b 420
ea38a6b9 421 $this->data_preprocessing($default_values);
9528568b 422 parent::set_data($default_values);
ea38a6b9 423 }
a4813c36 424}