2 // This file is part of Moodle - http://moodle.org/
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.
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.
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/>.
17 if (!defined('MOODLE_INTERNAL')) {
18 die('Direct access to this script is forbidden.'); /// It must be included from a Moodle page
21 require_once($CFG->dirroot.'/course/moodleform_mod.php');
22 require_once($CFG->dirroot.'/mod/scorm/locallib.php');
24 class mod_scorm_mod_form extends moodleform_mod {
26 function definition() {
27 global $CFG, $COURSE, $OUTPUT;
28 $cfg_scorm = get_config('scorm');
30 $mform = $this->_form;
32 if (!$CFG->slasharguments) {
33 $mform->addElement('static', '', '', $OUTPUT->notification(get_string('slashargs', 'scorm'), 'notifyproblem'));
35 //-------------------------------------------------------------------------------
36 $mform->addElement('header', 'general', get_string('general', 'form'));
39 $mform->addElement('text', 'name', get_string('name'));
40 if (!empty($CFG->formatstringstriptags)) {
41 $mform->setType('name', PARAM_TEXT);
43 $mform->setType('name', PARAM_CLEANHTML);
45 $mform->addRule('name', null, 'required', null, 'client');
48 $this->add_intro_editor(true);
51 $scormtypes = array(SCORM_TYPE_LOCAL => get_string('typelocal', 'scorm'));
53 if ($cfg_scorm->allowtypeexternal) {
54 $scormtypes[SCORM_TYPE_EXTERNAL] = get_string('typeexternal', 'scorm');
57 if ($cfg_scorm->allowtypelocalsync) {
58 $scormtypes[SCORM_TYPE_LOCALSYNC] = get_string('typelocalsync', 'scorm');
61 if (!empty($CFG->repositoryactivate) and $cfg_scorm->allowtypeimsrepository) {
62 $scormtypes[SCORM_TYPE_IMSREPOSITORY] = get_string('typeimsrepository', 'scorm');
65 if ($cfg_scorm->allowtypeexternalaicc) {
66 $scormtypes[SCORM_TYPE_AICCURL] = get_string('typeaiccurl', 'scorm');
70 if (count($scormtypes) > 1) {
71 $mform->addElement('select', 'scormtype', get_string('scormtype', 'scorm'), $scormtypes);
72 $mform->addHelpButton('scormtype', 'scormtype', 'scorm');
73 $mform->addElement('text', 'packageurl', get_string('packageurl', 'scorm'), array('size'=>60));
74 $mform->setType('packageurl', PARAM_RAW);
75 $mform->addHelpButton('packageurl', 'packageurl', 'scorm');
76 $mform->disabledIf('packageurl', 'scormtype', 'eq', SCORM_TYPE_LOCAL);
78 $mform->addElement('hidden', 'scormtype', SCORM_TYPE_LOCAL);
81 // New local package upload
82 $maxbytes = get_max_upload_file_size($CFG->maxbytes, $COURSE->maxbytes);
83 $mform->setMaxFileSize($maxbytes);
84 $mform->addElement('filepicker', 'packagefile', get_string('package', 'scorm'));
85 $mform->addHelpButton('packagefile', 'package', 'scorm');
86 $mform->disabledIf('packagefile', 'scormtype', 'noteq', SCORM_TYPE_LOCAL);
88 //-------------------------------------------------------------------------------
90 $mform->addElement('header', 'timerestricthdr', get_string('timerestrict', 'scorm'));
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 //-------------------------------------------------------------------------------
96 $mform->addElement('header', 'displaysettings', get_string('displaysettings', 'scorm'));
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);
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);
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);
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);
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);
127 $skipviewoptions = scorm_get_skip_view_array();
128 if ($COURSE->format == 'scorm') { // Remove option that would cause a constant redirect.
129 unset($skipviewoptions[SCORM_SKIPVIEW_ALWAYS]);
130 if ($cfg_scorm->skipview == SCORM_SKIPVIEW_ALWAYS) {
131 $cfg_scorm->skipview = SCORM_SKIPVIEW_FIRST;
134 $mform->addElement('select', 'skipview', get_string('skipview', 'scorm'), $skipviewoptions);
135 $mform->addHelpButton('skipview', 'skipview', 'scorm');
136 $mform->setDefault('skipview', $cfg_scorm->skipview);
137 $mform->setAdvanced('skipview', $cfg_scorm->skipview_adv);
140 $mform->addElement('selectyesno', 'hidebrowse', get_string('hidebrowse', 'scorm'));
141 $mform->addHelpButton('hidebrowse', 'hidebrowse', 'scorm');
142 $mform->setDefault('hidebrowse', $cfg_scorm->hidebrowse);
143 $mform->setAdvanced('hidebrowse', $cfg_scorm->hidebrowse_adv);
145 // Display course structure
146 $mform->addElement('selectyesno', 'displaycoursestructure', get_string('displaycoursestructure', 'scorm'));
147 $mform->addHelpButton('displaycoursestructure', 'displaycoursestructure', 'scorm');
148 $mform->setDefault('displaycoursestructure', $cfg_scorm->displaycoursestructure);
149 $mform->setAdvanced('displaycoursestructure', $cfg_scorm->displaycoursestructure_adv);
152 $mform->addElement('select', 'hidetoc', get_string('hidetoc', 'scorm'), scorm_get_hidetoc_array());
153 $mform->addHelpButton('hidetoc', 'hidetoc', 'scorm');
154 $mform->setDefault('hidetoc', $cfg_scorm->hidetoc);
155 $mform->setAdvanced('hidetoc', $cfg_scorm->hidetoc_adv);
157 // Hide Navigation panel
158 $mform->addElement('selectyesno', 'hidenav', get_string('hidenav', 'scorm'));
159 $mform->setDefault('hidenav', $cfg_scorm->hidenav);
160 $mform->setAdvanced('hidenav', $cfg_scorm->hidenav_adv);
161 $mform->disabledIf('hidenav', 'hidetoc', 'noteq', 0);
163 //-------------------------------------------------------------------------------
165 $mform->addElement('header', 'gradesettings', get_string('gradesettings', 'scorm'));
168 $mform->addElement('select', 'grademethod', get_string('grademethod', 'scorm'), scorm_get_grade_method_array());
169 $mform->addHelpButton('grademethod', 'grademethod', 'scorm');
170 $mform->setDefault('grademethod', $cfg_scorm->grademethod);
171 $mform->setAdvanced('grademethod', $cfg_scorm->grademethod_adv);
174 for ($i=0; $i<=100; $i++) {
177 $mform->addElement('select', 'maxgrade', get_string('maximumgrade'), $grades);
178 $mform->setDefault('maxgrade', $cfg_scorm->maxgrade);
179 $mform->disabledIf('maxgrade', 'grademethod', 'eq', GRADESCOES);
180 $mform->setAdvanced('maxgrade', $cfg_scorm->maxgrade_adv);
182 $mform->addElement('header', 'othersettings', get_string('othersettings', 'scorm'));
185 $mform->addElement('select', 'maxattempt', get_string('maximumattempts', 'scorm'), scorm_get_attempts_array());
186 $mform->addHelpButton('maxattempt', 'maximumattempts', 'scorm');
187 $mform->setDefault('maxattempt', $cfg_scorm->maxattempt);
188 $mform->setAdvanced('maxattempt', $cfg_scorm->maxattempt_adv);
191 $mform->addElement('select', 'whatgrade', get_string('whatgrade', 'scorm'), scorm_get_what_grade_array());
192 $mform->disabledIf('whatgrade', 'maxattempt', 'eq', 1);
193 $mform->addHelpButton('whatgrade', 'whatgrade', 'scorm');
194 $mform->setDefault('whatgrade', $cfg_scorm->whatgrade);
195 $mform->setAdvanced('whatgrade', $cfg_scorm->whatgrade_adv);
197 // Display attempt status
198 $mform->addElement('select', 'displayattemptstatus', get_string('displayattemptstatus', 'scorm'), scorm_get_attemptstatus_array());
199 $mform->addHelpButton('displayattemptstatus', 'displayattemptstatus', 'scorm');
200 $mform->setDefault('displayattemptstatus', $cfg_scorm->displayattemptstatus);
201 $mform->setAdvanced('displayattemptstatus', $cfg_scorm->displayattemptstatus_adv);
204 $mform->addElement('selectyesno', 'forcecompleted', get_string('forcecompleted', 'scorm'));
205 $mform->addHelpButton('forcecompleted', 'forcecompleted', 'scorm');
206 $mform->setDefault('forcecompleted', $cfg_scorm->forcecompleted);
207 $mform->setAdvanced('forcecompleted', $cfg_scorm->forcecompleted_adv);
210 $mform->addElement('selectyesno', 'forcenewattempt', get_string('forcenewattempt', 'scorm'));
211 $mform->addHelpButton('forcenewattempt', 'forcenewattempt', 'scorm');
212 $mform->setDefault('forcenewattempt', $cfg_scorm->forcenewattempt);
213 $mform->setAdvanced('forcenewattempt', $cfg_scorm->forcenewattempt_adv);
215 // Last attempt lock - lock the enter button after the last available attempt has been made
216 $mform->addElement('selectyesno', 'lastattemptlock', get_string('lastattemptlock', 'scorm'));
217 $mform->addHelpButton('lastattemptlock', 'lastattemptlock', 'scorm');
218 $mform->setDefault('lastattemptlock', $cfg_scorm->lastattemptlock);
219 $mform->setAdvanced('lastattemptlock', $cfg_scorm->lastattemptlock_adv);
222 /* $mform->addElement('static', '', '' ,'<hr />');
223 $mform->addElement('static', 'activation', get_string('activation','scorm'));
224 $datestartgrp = array();
225 $datestartgrp[] = &$mform->createElement('date_time_selector', 'startdate');
226 $datestartgrp[] = &$mform->createElement('checkbox', 'startdisabled', null, get_string('disable'));
227 $mform->addGroup($datestartgrp, 'startdategrp', get_string('from'), ' ', false);
228 $mform->setDefault('startdate', 0);
229 $mform->setDefault('startdisabled', 1);
230 $mform->disabledIf('startdategrp', 'startdisabled', 'checked');
232 $dateendgrp = array();
233 $dateendgrp[] = &$mform->createElement('date_time_selector', 'enddate');
234 $dateendgrp[] = &$mform->createElement('checkbox', 'enddisabled', null, get_string('disable'));
235 $mform->addGroup($dateendgrp, 'dateendgrp', get_string('to'), ' ', false);
236 $mform->setDefault('enddate', 0);
237 $mform->setDefault('enddisabled', 1);
238 $mform->disabledIf('dateendgrp', 'enddisabled', 'checked');
242 $mform->addElement('selectyesno', 'auto', get_string('autocontinue', 'scorm'));
243 $mform->addHelpButton('auto', 'autocontinue', 'scorm');
244 $mform->setDefault('auto', $cfg_scorm->auto);
245 $mform->setAdvanced('auto', $cfg_scorm->auto_adv);
247 if (count($scormtypes) > 1) {
248 // Update packages timing
249 $mform->addElement('select', 'updatefreq', get_string('updatefreq', 'scorm'), scorm_get_updatefreq_array());
250 $mform->setDefault('updatefreq', $cfg_scorm->updatefreq);
251 $mform->setAdvanced('updatefreq', $cfg_scorm->updatefreq_adv);
252 $mform->addHelpButton('updatefreq', 'updatefreq', 'scorm');
253 $mform->disabledIf('updatefreq', 'scormtype', 'eq', SCORM_TYPE_LOCAL);
255 $mform->addElement('hidden', 'updatefreq', 0);
257 //-------------------------------------------------------------------------------
259 $mform->addElement('hidden', 'datadir', null);
260 $mform->setType('datadir', PARAM_RAW);
261 $mform->addElement('hidden', 'pkgtype', null);
262 $mform->setType('pkgtype', PARAM_RAW);
263 $mform->addElement('hidden', 'launch', null);
264 $mform->setType('launch', PARAM_RAW);
265 $mform->addElement('hidden', 'redirect', null);
266 $mform->setType('redirect', PARAM_RAW);
267 $mform->addElement('hidden', 'redirecturl', null);
268 $mform->setType('redirecturl', PARAM_RAW);
270 //-------------------------------------------------------------------------------
271 $this->standard_coursemodule_elements();
272 //-------------------------------------------------------------------------------
274 $this->add_action_buttons();
277 function data_preprocessing(&$default_values) {
280 if (isset($default_values['popup']) && ($default_values['popup'] == 1) && isset($default_values['options'])) {
281 if (!empty($default_values['options'])) {
282 $options = explode(',', $default_values['options']);
283 foreach ($options as $option) {
284 list($element, $value) = explode('=', $option);
285 $element = trim($element);
286 $default_values[$element] = trim($value);
290 if (isset($default_values['grademethod'])) {
291 $default_values['grademethod'] = intval($default_values['grademethod']);
293 if (isset($default_values['width']) && (strpos($default_values['width'], '%') === false) && ($default_values['width'] <= 100)) {
294 $default_values['width'] .= '%';
296 if (isset($default_values['width']) && (strpos($default_values['height'], '%') === false) && ($default_values['height'] <= 100)) {
297 $default_values['height'] .= '%';
299 $scorms = get_all_instances_in_course('scorm', $COURSE);
300 $coursescorm = current($scorms);
302 $draftitemid = file_get_submitted_draft_itemid('packagefile');
303 file_prepare_draft_area($draftitemid, $this->context->id, 'mod_scorm', 'package', 0);
304 $default_values['packagefile'] = $draftitemid;
306 if (($COURSE->format == 'scorm') && ((count($scorms) == 0) || ($default_values['instance'] == $coursescorm->id))) {
307 $default_values['redirect'] = 'yes';
308 $default_values['redirecturl'] = '../course/view.php?id='.$default_values['course'];
310 $default_values['redirect'] = 'no';
311 $default_values['redirecturl'] = '../mod/scorm/view.php?id='.$default_values['coursemodule'];
313 if (isset($default_values['version'])) {
314 $default_values['pkgtype'] = (substr($default_values['version'], 0, 5) == 'SCORM') ? 'scorm':'aicc';
316 if (isset($default_values['instance'])) {
317 $default_values['datadir'] = $default_values['instance'];
319 if (empty($default_values['timeopen'])) {
320 $default_values['timeopen'] = 0;
322 if (empty($default_values['timeclose'])) {
323 $default_values['timeclose'] = 0;
326 // Set some completion default data
327 if (!empty($default_values['completionstatusrequired']) && !is_array($default_values['completionstatusrequired'])) {
330 foreach (scorm_status_options() as $key => $value) {
331 if (($default_values['completionstatusrequired'] & $key) == $key) {
336 $default_values['completionstatusrequired'] = $cvalues;
339 if (!isset($default_values['completionscorerequired']) || !strlen($default_values['completionscorerequired'])) {
340 $default_values['completionscoredisabled'] = 1;
345 function validation($data, $files) {
347 $errors = parent::validation($data, $files);
349 $type = $data['scormtype'];
351 if ($type === SCORM_TYPE_LOCAL) {
352 if (!empty($data['update'])) {
355 } else if (empty($data['packagefile'])) {
356 $errors['packagefile'] = get_string('required');
359 $files = $this->get_draft_files('packagefile');
360 if (count($files)<1) {
361 $errors['packagefile'] = get_string('required');
364 $file = reset($files);
365 $filename = $CFG->tempdir.'/scormimport/scrom_'.time();
366 make_temp_directory('scormimport');
367 $file->copy_content_to($filename);
369 $packer = get_file_packer('application/zip');
371 $filelist = $packer->list_files($filename);
372 if (!is_array($filelist)) {
373 $errors['packagefile'] = 'Incorrect file package - not an archive'; //TODO: localise
375 $manifestpresent = false;
377 foreach ($filelist as $info) {
378 if ($info->pathname == 'imsmanifest.xml') {
379 $manifestpresent = true;
382 if (preg_match('/\.cst$/', $info->pathname)) {
387 if (!$manifestpresent and !$aiccfound) {
388 $errors['packagefile'] = 'Incorrect file package - missing imsmanifest.xml or AICC structure'; //TODO: localise
394 } else if ($type === SCORM_TYPE_EXTERNAL) {
395 $reference = $data['packageurl'];
396 if (!preg_match('/(http:\/\/|https:\/\/|www).*\/imsmanifest.xml$/i', $reference)) {
397 $errors['packageurl'] = get_string('invalidurl', 'scorm');
400 } else if ($type === 'packageurl') {
401 $reference = $data['reference'];
402 if (!preg_match('/(http:\/\/|https:\/\/|www).*(\.zip|\.pif)$/i', $reference)) {
403 $errors['packageurl'] = get_string('invalidurl', 'scorm');
406 } else if ($type === SCORM_TYPE_IMSREPOSITORY) {
407 $reference = $data['packageurl'];
408 if (stripos($reference, '#') !== 0) {
409 $errors['packageurl'] = get_string('invalidurl', 'scorm');
411 } else if ($type === SCORM_TYPE_AICCURL) {
412 $reference = $data['packageurl'];
413 if (!preg_match('/(http:\/\/|https:\/\/|www).*/', $reference)) {
414 $errors['packageurl'] = get_string('invalidurl', 'scorm');
421 //need to translate the "options" and "reference" field.
422 function set_data($default_values) {
423 $default_values = (array)$default_values;
425 if (isset($default_values['scormtype']) and isset($default_values['reference'])) {
426 switch ($default_values['scormtype']) {
427 case SCORM_TYPE_LOCALSYNC :
428 case SCORM_TYPE_EXTERNAL:
429 case SCORM_TYPE_IMSREPOSITORY:
430 case SCORM_TYPE_AICCURL:
431 $default_values['packageurl'] = $default_values['reference'];
434 unset($default_values['reference']);
436 if (!empty($default_values['options'])) {
437 $options = explode(',', $default_values['options']);
438 foreach ($options as $option) {
439 $opt = explode('=', $option);
440 if (isset($opt[1])) {
441 $default_values[$opt[0]] = $opt[1];
446 $this->data_preprocessing($default_values);
447 parent::set_data($default_values);
450 function add_completion_rules() {
451 $mform =& $this->_form;
456 $group[] =& $mform->createElement('text', 'completionscorerequired', '', array('size' => 5));
457 $group[] =& $mform->createElement('checkbox', 'completionscoredisabled', null, get_string('disable'));
458 $mform->setType('completionscorerequired', PARAM_INT);
459 $mform->addGroup($group, 'completionscoregroup', get_string('completionscorerequired', 'scorm'), '', false);
460 $mform->addHelpButton('completionscoregroup', 'completionscorerequired', 'scorm');
461 $mform->disabledIf('completionscorerequired', 'completionscoredisabled', 'checked');
462 $mform->setDefault('completionscorerequired', 0);
464 $items[] = 'completionscoregroup';
470 foreach (scorm_status_options(true) as $key => $value) {
472 $key = 'completionstatusrequired['.$key.']';
474 $name = get_string('completionstatusrequired', 'scorm');
478 $mform->addElement('checkbox', $key, $name, $value);
479 $mform->setType($key, PARAM_BOOL);
482 $mform->addHelpButton($firstkey, 'completionstatusrequired', 'scorm');
487 function completion_rule_enabled($data) {
488 $status = !empty($data['completionstatusrequired']);
489 $score = empty($data['completionscoredisabled']) && strlen($data['completionscorerequired']);
491 return $status || $score;
494 function get_data($slashed = true) {
495 $data = parent::get_data($slashed);
501 // Turn off completion settings if the checkboxes aren't ticked
502 $autocompletion = !empty($data->completion) && $data->completion == COMPLETION_TRACKING_AUTOMATIC;
504 if (isset($data->completionstatusrequired) && is_array($data->completionstatusrequired)) {
506 foreach (array_keys($data->completionstatusrequired) as $state) {
510 $data->completionstatusrequired = $total;
513 if (!$autocompletion) {
514 $data->completionstatusrequired = null;
517 if (!empty($data->completionscoredisabled) || !$autocompletion) {
518 $data->completionscorerequired = null;