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 public function definition() {
27 global $CFG, $COURSE, $OUTPUT;
28 $cfgscorm = get_config('scorm');
30 $mform = $this->_form
;
32 if (!$CFG->slasharguments
) {
33 $mform->addElement('static', '', '', $OUTPUT->notification(get_string('slashargs', 'scorm'), 'notifyproblem'));
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');
46 $mform->addRule('name', get_string('maximumchars', '', 255), 'maxlength', 255, 'client');
49 $this->standard_intro_elements();
52 $mform->addElement('header', 'packagehdr', get_string('packagehdr', 'scorm'));
53 $mform->setExpanded('packagehdr', true);
56 $scormtypes = array(SCORM_TYPE_LOCAL
=> get_string('typelocal', 'scorm'));
58 if ($cfgscorm->allowtypeexternal
) {
59 $scormtypes[SCORM_TYPE_EXTERNAL
] = get_string('typeexternal', 'scorm');
62 if ($cfgscorm->allowtypelocalsync
) {
63 $scormtypes[SCORM_TYPE_LOCALSYNC
] = get_string('typelocalsync', 'scorm');
66 if ($cfgscorm->allowtypeexternalaicc
) {
67 $scormtypes[SCORM_TYPE_AICCURL
] = get_string('typeaiccurl', 'scorm');
71 if (count($scormtypes) > 1) {
72 $mform->addElement('select', 'scormtype', get_string('scormtype', 'scorm'), $scormtypes);
73 $mform->setType('scormtype', PARAM_ALPHA
);
74 $mform->addHelpButton('scormtype', 'scormtype', 'scorm');
75 $mform->addElement('text', 'packageurl', get_string('packageurl', 'scorm'), array('size' => 60));
76 $mform->setType('packageurl', PARAM_RAW
);
77 $mform->addHelpButton('packageurl', 'packageurl', 'scorm');
78 $mform->disabledIf('packageurl', 'scormtype', 'eq', SCORM_TYPE_LOCAL
);
80 $mform->addElement('hidden', 'scormtype', SCORM_TYPE_LOCAL
);
81 $mform->setType('scormtype', PARAM_ALPHA
);
84 // New local package upload.
85 $filemanageroptions = array();
86 $filemanageroptions['accepted_types'] = array('.zip', '.xml');
87 $filemanageroptions['maxbytes'] = 0;
88 $filemanageroptions['maxfiles'] = 1;
89 $filemanageroptions['subdirs'] = 0;
91 $mform->addElement('filemanager', 'packagefile', get_string('package', 'scorm'), null, $filemanageroptions);
92 $mform->addHelpButton('packagefile', 'package', 'scorm');
93 $mform->disabledIf('packagefile', 'scormtype', 'noteq', SCORM_TYPE_LOCAL
);
95 // Update packages timing.
96 $mform->addElement('select', 'updatefreq', get_string('updatefreq', 'scorm'), scorm_get_updatefreq_array());
97 $mform->setType('updatefreq', PARAM_INT
);
98 $mform->setDefault('updatefreq', $cfgscorm->updatefreq
);
99 $mform->addHelpButton('updatefreq', 'updatefreq', 'scorm');
102 $mform->addElement('header', 'displaysettings', get_string('appearance'));
104 // Framed / Popup Window.
105 $mform->addElement('select', 'popup', get_string('display', 'scorm'), scorm_get_popup_display_array());
106 $mform->setDefault('popup', $cfgscorm->popup
);
107 $mform->setAdvanced('popup', $cfgscorm->popup_adv
);
110 $mform->addElement('text', 'width', get_string('width', 'scorm'), 'maxlength="5" size="5"');
111 $mform->setDefault('width', $cfgscorm->framewidth
);
112 $mform->setType('width', PARAM_INT
);
113 $mform->setAdvanced('width', $cfgscorm->framewidth_adv
);
114 $mform->disabledIf('width', 'popup', 'eq', 0);
117 $mform->addElement('text', 'height', get_string('height', 'scorm'), 'maxlength="5" size="5"');
118 $mform->setDefault('height', $cfgscorm->frameheight
);
119 $mform->setType('height', PARAM_INT
);
120 $mform->setAdvanced('height', $cfgscorm->frameheight_adv
);
121 $mform->disabledIf('height', 'popup', 'eq', 0);
124 $winoptgrp = array();
125 foreach (scorm_get_popup_options_array() as $key => $value) {
126 $winoptgrp[] = &$mform->createElement('checkbox', $key, '', get_string($key, 'scorm'));
127 $mform->setDefault($key, $value);
129 $mform->addGroup($winoptgrp, 'winoptgrp', get_string('options', 'scorm'), '<br />', false);
130 $mform->disabledIf('winoptgrp', 'popup', 'eq', 0);
131 $mform->setAdvanced('winoptgrp', $cfgscorm->winoptgrp_adv
);
133 // Display activity name.
134 $mform->addElement('advcheckbox', 'displayactivityname', get_string('displayactivityname', 'scorm'));
135 $mform->addHelpButton('displayactivityname', 'displayactivityname', 'scorm');
136 $mform->setDefault('displayactivityname', $cfgscorm->displayactivityname
);
139 $skipviewoptions = scorm_get_skip_view_array();
140 if ($COURSE->format
== 'singleactivity') { // Remove option that would cause a constant redirect.
141 unset($skipviewoptions[SCORM_SKIPVIEW_ALWAYS
]);
142 if ($cfgscorm->skipview
== SCORM_SKIPVIEW_ALWAYS
) {
143 $cfgscorm->skipview
= SCORM_SKIPVIEW_FIRST
;
146 $mform->addElement('select', 'skipview', get_string('skipview', 'scorm'), $skipviewoptions);
147 $mform->addHelpButton('skipview', 'skipview', 'scorm');
148 $mform->setDefault('skipview', $cfgscorm->skipview
);
149 $mform->setAdvanced('skipview', $cfgscorm->skipview_adv
);
152 $mform->addElement('selectyesno', 'hidebrowse', get_string('hidebrowse', 'scorm'));
153 $mform->addHelpButton('hidebrowse', 'hidebrowse', 'scorm');
154 $mform->setDefault('hidebrowse', $cfgscorm->hidebrowse
);
155 $mform->setAdvanced('hidebrowse', $cfgscorm->hidebrowse_adv
);
157 // Display course structure.
158 $mform->addElement('selectyesno', 'displaycoursestructure', get_string('displaycoursestructure', 'scorm'));
159 $mform->addHelpButton('displaycoursestructure', 'displaycoursestructure', 'scorm');
160 $mform->setDefault('displaycoursestructure', $cfgscorm->displaycoursestructure
);
161 $mform->setAdvanced('displaycoursestructure', $cfgscorm->displaycoursestructure_adv
);
164 $mform->addElement('select', 'hidetoc', get_string('hidetoc', 'scorm'), scorm_get_hidetoc_array());
165 $mform->addHelpButton('hidetoc', 'hidetoc', 'scorm');
166 $mform->setDefault('hidetoc', $cfgscorm->hidetoc
);
167 $mform->setAdvanced('hidetoc', $cfgscorm->hidetoc_adv
);
168 $mform->disabledIf('hidetoc', 'scormtype', 'eq', SCORM_TYPE_AICCURL
);
170 // Navigation panel display.
171 $mform->addElement('select', 'nav', get_string('nav', 'scorm'), scorm_get_navigation_display_array());
172 $mform->addHelpButton('nav', 'nav', 'scorm');
173 $mform->setDefault('nav', $cfgscorm->nav
);
174 $mform->setAdvanced('nav', $cfgscorm->nav_adv
);
175 $mform->disabledIf('nav', 'hidetoc', 'noteq', SCORM_TOC_SIDE
);
177 // Navigation panel position from left.
178 $mform->addElement('text', 'navpositionleft', get_string('fromleft', 'scorm'), 'maxlength="5" size="5"');
179 $mform->setDefault('navpositionleft', $cfgscorm->navpositionleft
);
180 $mform->setType('navpositionleft', PARAM_INT
);
181 $mform->setAdvanced('navpositionleft', $cfgscorm->navpositionleft_adv
);
182 $mform->disabledIf('navpositionleft', 'hidetoc', 'noteq', SCORM_TOC_SIDE
);
183 $mform->disabledIf('navpositionleft', 'nav', 'noteq', SCORM_NAV_FLOATING
);
185 // Navigation panel position from top.
186 $mform->addElement('text', 'navpositiontop', get_string('fromtop', 'scorm'), 'maxlength="5" size="5"');
187 $mform->setDefault('navpositiontop', $cfgscorm->navpositiontop
);
188 $mform->setType('navpositiontop', PARAM_INT
);
189 $mform->setAdvanced('navpositiontop', $cfgscorm->navpositiontop_adv
);
190 $mform->disabledIf('navpositiontop', 'hidetoc', 'noteq', SCORM_TOC_SIDE
);
191 $mform->disabledIf('navpositiontop', 'nav', 'noteq', SCORM_NAV_FLOATING
);
193 // Display attempt status.
194 $mform->addElement('select', 'displayattemptstatus', get_string('displayattemptstatus', 'scorm'),
195 scorm_get_attemptstatus_array());
196 $mform->addHelpButton('displayattemptstatus', 'displayattemptstatus', 'scorm');
197 $mform->setDefault('displayattemptstatus', $cfgscorm->displayattemptstatus
);
198 $mform->setAdvanced('displayattemptstatus', $cfgscorm->displayattemptstatus_adv
);
201 $mform->addElement('header', 'availability', get_string('availability'));
203 $mform->addElement('date_time_selector', 'timeopen', get_string("scormopen", "scorm"), array('optional' => true));
204 $mform->addElement('date_time_selector', 'timeclose', get_string("scormclose", "scorm"), array('optional' => true));
207 $mform->addElement('header', 'gradesettings', get_string('grade'));
210 $mform->addElement('select', 'grademethod', get_string('grademethod', 'scorm'), scorm_get_grade_method_array());
211 $mform->addHelpButton('grademethod', 'grademethod', 'scorm');
212 $mform->setDefault('grademethod', $cfgscorm->grademethod
);
215 for ($i = 0; $i <= 100; $i++
) {
218 $mform->addElement('select', 'maxgrade', get_string('maximumgrade'), $grades);
219 $mform->setDefault('maxgrade', $cfgscorm->maxgrade
);
220 $mform->disabledIf('maxgrade', 'grademethod', 'eq', GRADESCOES
);
222 // Attempts management.
223 $mform->addElement('header', 'attemptsmanagementhdr', get_string('attemptsmanagement', 'scorm'));
226 $mform->addElement('select', 'maxattempt', get_string('maximumattempts', 'scorm'), scorm_get_attempts_array());
227 $mform->addHelpButton('maxattempt', 'maximumattempts', 'scorm');
228 $mform->setDefault('maxattempt', $cfgscorm->maxattempt
);
231 $mform->addElement('select', 'whatgrade', get_string('whatgrade', 'scorm'), scorm_get_what_grade_array());
232 $mform->disabledIf('whatgrade', 'maxattempt', 'eq', 1);
233 $mform->addHelpButton('whatgrade', 'whatgrade', 'scorm');
234 $mform->setDefault('whatgrade', $cfgscorm->whatgrade
);
236 // Force new attempt.
237 $mform->addElement('selectyesno', 'forcenewattempt', get_string('forcenewattempt', 'scorm'));
238 $mform->addHelpButton('forcenewattempt', 'forcenewattempt', 'scorm');
239 $mform->setDefault('forcenewattempt', $cfgscorm->forcenewattempt
);
241 // Last attempt lock - lock the enter button after the last available attempt has been made.
242 $mform->addElement('selectyesno', 'lastattemptlock', get_string('lastattemptlock', 'scorm'));
243 $mform->addHelpButton('lastattemptlock', 'lastattemptlock', 'scorm');
244 $mform->setDefault('lastattemptlock', $cfgscorm->lastattemptlock
);
246 // Compatibility settings.
247 $mform->addElement('header', 'compatibilitysettingshdr', get_string('compatibilitysettings', 'scorm'));
250 $mform->addElement('selectyesno', 'forcecompleted', get_string('forcecompleted', 'scorm'));
251 $mform->addHelpButton('forcecompleted', 'forcecompleted', 'scorm');
252 $mform->setDefault('forcecompleted', $cfgscorm->forcecompleted
);
255 $mform->addElement('selectyesno', 'auto', get_string('autocontinue', 'scorm'));
256 $mform->addHelpButton('auto', 'autocontinue', 'scorm');
257 $mform->setDefault('auto', $cfgscorm->auto
);
260 $mform->addElement('selectyesno', 'autocommit', get_string('autocommit', 'scorm'));
261 $mform->addHelpButton('autocommit', 'autocommit', 'scorm');
262 $mform->setDefault('autocommit', $cfgscorm->autocommit
);
265 $mform->addElement('hidden', 'datadir', null);
266 $mform->setType('datadir', PARAM_RAW
);
267 $mform->addElement('hidden', 'pkgtype', null);
268 $mform->setType('pkgtype', PARAM_RAW
);
269 $mform->addElement('hidden', 'launch', null);
270 $mform->setType('launch', PARAM_RAW
);
271 $mform->addElement('hidden', 'redirect', null);
272 $mform->setType('redirect', PARAM_RAW
);
273 $mform->addElement('hidden', 'redirecturl', null);
274 $mform->setType('redirecturl', PARAM_RAW
);
276 $this->standard_coursemodule_elements();
279 $this->add_action_buttons();
282 public function data_preprocessing(&$defaultvalues) {
285 if (isset($defaultvalues['popup']) && ($defaultvalues['popup'] == 1) && isset($defaultvalues['options'])) {
286 if (!empty($defaultvalues['options'])) {
287 $options = explode(',', $defaultvalues['options']);
288 foreach ($options as $option) {
289 list($element, $value) = explode('=', $option);
290 $element = trim($element);
291 $defaultvalues[$element] = trim($value);
295 if (isset($defaultvalues['grademethod'])) {
296 $defaultvalues['grademethod'] = intval($defaultvalues['grademethod']);
298 if (isset($defaultvalues['width']) && (strpos($defaultvalues['width'], '%') === false)
299 && ($defaultvalues['width'] <= 100)) {
300 $defaultvalues['width'] .= '%';
302 if (isset($defaultvalues['width']) && (strpos($defaultvalues['height'], '%') === false)
303 && ($defaultvalues['height'] <= 100)) {
304 $defaultvalues['height'] .= '%';
306 $scorms = get_all_instances_in_course('scorm', $COURSE);
307 $coursescorm = current($scorms);
309 $draftitemid = file_get_submitted_draft_itemid('packagefile');
310 file_prepare_draft_area($draftitemid, $this->context
->id
, 'mod_scorm', 'package', 0,
311 array('subdirs' => 0, 'maxfiles' => 1));
312 $defaultvalues['packagefile'] = $draftitemid;
314 if (($COURSE->format
== 'singleactivity') && ((count($scorms) == 0) ||
($defaultvalues['instance'] == $coursescorm->id
))) {
315 $defaultvalues['redirect'] = 'yes';
316 $defaultvalues['redirecturl'] = '../course/view.php?id='.$defaultvalues['course'];
318 $defaultvalues['redirect'] = 'no';
319 $defaultvalues['redirecturl'] = '../mod/scorm/view.php?id='.$defaultvalues['coursemodule'];
321 if (isset($defaultvalues['version'])) {
322 $defaultvalues['pkgtype'] = (substr($defaultvalues['version'], 0, 5) == 'SCORM') ?
'scorm' : 'aicc';
324 if (isset($defaultvalues['instance'])) {
325 $defaultvalues['datadir'] = $defaultvalues['instance'];
327 if (empty($defaultvalues['timeopen'])) {
328 $defaultvalues['timeopen'] = 0;
330 if (empty($defaultvalues['timeclose'])) {
331 $defaultvalues['timeclose'] = 0;
334 // Set some completion default data.
335 if (!empty($defaultvalues['completionstatusrequired']) && !is_array($defaultvalues['completionstatusrequired'])) {
338 foreach (scorm_status_options() as $key => $value) {
339 if (($defaultvalues['completionstatusrequired'] & $key) == $key) {
344 $defaultvalues['completionstatusrequired'] = $cvalues;
347 if (!isset($defaultvalues['completionscorerequired']) ||
!strlen($defaultvalues['completionscorerequired'])) {
348 $defaultvalues['completionscoredisabled'] = 1;
352 public function validation($data, $files) {
354 $errors = parent
::validation($data, $files);
356 $type = $data['scormtype'];
358 if ($type === SCORM_TYPE_LOCAL
) {
359 if (empty($data['packagefile'])) {
360 $errors['packagefile'] = get_string('required');
363 $draftitemid = file_get_submitted_draft_itemid('packagefile');
365 file_prepare_draft_area($draftitemid, $this->context
->id
, 'mod_scorm', 'packagefilecheck', null,
366 array('subdirs' => 0, 'maxfiles' => 1));
368 // Get file from users draft area.
369 $usercontext = context_user
::instance($USER->id
);
370 $fs = get_file_storage();
371 $files = $fs->get_area_files($usercontext->id
, 'user', 'draft', $draftitemid, 'id', false);
373 if (count($files) < 1) {
374 $errors['packagefile'] = get_string('required');
377 $file = reset($files);
378 if (!$file->is_external_file() && !empty($data['updatefreq'])) {
379 // Make sure updatefreq is not set if using normal local file.
380 $errors['updatefreq'] = get_string('updatefreq_error', 'mod_scorm');
382 if (strtolower($file->get_filename()) == 'imsmanifest.xml') {
383 if (!$file->is_external_file()) {
384 $errors['packagefile'] = get_string('aliasonly', 'mod_scorm');
386 $repository = repository
::get_repository_by_id($file->get_repository_id(), context_system
::instance());
387 if (!$repository->supports_relative_file()) {
388 $errors['packagefile'] = get_string('repositorynotsupported', 'mod_scorm');
391 } else if (strtolower(substr($file->get_filename(), -3)) == 'xml') {
392 $errors['packagefile'] = get_string('invalidmanifestname', 'mod_scorm');
394 // Validate this SCORM package.
395 $errors = array_merge($errors, scorm_validate_package($file));
399 } else if ($type === SCORM_TYPE_EXTERNAL
) {
400 $reference = $data['packageurl'];
402 if (!preg_match('/(http:\/\/|https:\/\/|www).*\/imsmanifest.xml$/i', $reference)) {
403 $errors['packageurl'] = get_string('invalidurl', 'scorm');
405 // Availability check.
406 $result = scorm_check_url($reference);
407 if (is_string($result)) {
408 $errors['packageurl'] = $result;
412 } else if ($type === 'packageurl') {
413 $reference = $data['reference'];
415 if (!preg_match('/(http:\/\/|https:\/\/|www).*(\.zip|\.pif)$/i', $reference)) {
416 $errors['packageurl'] = get_string('invalidurl', 'scorm');
418 // Availability check.
419 $result = scorm_check_url($reference);
420 if (is_string($result)) {
421 $errors['packageurl'] = $result;
425 } else if ($type === SCORM_TYPE_AICCURL
) {
426 $reference = $data['packageurl'];
428 if (!preg_match('/(http:\/\/|https:\/\/|www).*/', $reference)) {
429 $errors['packageurl'] = get_string('invalidurl', 'scorm');
431 // Availability check.
432 $result = scorm_check_url($reference);
433 if (is_string($result)) {
434 $errors['packageurl'] = $result;
443 // Need to translate the "options" and "reference" field.
444 public function set_data($defaultvalues) {
445 $defaultvalues = (array)$defaultvalues;
447 if (isset($defaultvalues['scormtype']) and isset($defaultvalues['reference'])) {
448 switch ($defaultvalues['scormtype']) {
449 case SCORM_TYPE_LOCALSYNC
:
450 case SCORM_TYPE_EXTERNAL
:
451 case SCORM_TYPE_AICCURL
:
452 $defaultvalues['packageurl'] = $defaultvalues['reference'];
455 unset($defaultvalues['reference']);
457 if (!empty($defaultvalues['options'])) {
458 $options = explode(',', $defaultvalues['options']);
459 foreach ($options as $option) {
460 $opt = explode('=', $option);
461 if (isset($opt[1])) {
462 $defaultvalues[$opt[0]] = $opt[1];
467 $this->data_preprocessing($defaultvalues);
468 parent
::set_data($defaultvalues);
471 public function add_completion_rules() {
472 $mform =& $this->_form
;
477 $group[] =& $mform->createElement('text', 'completionscorerequired', '', array('size' => 5));
478 $group[] =& $mform->createElement('checkbox', 'completionscoredisabled', null, get_string('disable'));
479 $mform->setType('completionscorerequired', PARAM_INT
);
480 $mform->addGroup($group, 'completionscoregroup', get_string('completionscorerequired', 'scorm'), '', false);
481 $mform->addHelpButton('completionscoregroup', 'completionscorerequired', 'scorm');
482 $mform->disabledIf('completionscorerequired', 'completionscoredisabled', 'checked');
483 $mform->setDefault('completionscorerequired', 0);
485 $items[] = 'completionscoregroup';
490 foreach (scorm_status_options(true) as $key => $value) {
492 $key = 'completionstatusrequired['.$key.']';
494 $name = get_string('completionstatusrequired', 'scorm');
498 $mform->addElement('checkbox', $key, $name, $value);
499 $mform->setType($key, PARAM_BOOL
);
502 $mform->addHelpButton($firstkey, 'completionstatusrequired', 'scorm');
507 public function completion_rule_enabled($data) {
508 $status = !empty($data['completionstatusrequired']);
509 $score = empty($data['completionscoredisabled']) && strlen($data['completionscorerequired']);
511 return $status ||
$score;
514 public function get_data($slashed = true) {
515 $data = parent
::get_data($slashed);
521 // Convert completionstatusrequired to a proper integer, if any.
523 if (isset($data->completionstatusrequired
) && is_array($data->completionstatusrequired
)) {
524 foreach (array_keys($data->completionstatusrequired
) as $state) {
527 $data->completionstatusrequired
= $total;
530 if (!empty($data->completionunlocked
)) {
531 // Turn off completion settings if the checkboxes aren't ticked.
532 $autocompletion = isset($data->completion
) && $data->completion
== COMPLETION_TRACKING_AUTOMATIC
;
534 if (!(isset($data->completionstatusrequired
) && $autocompletion)) {
535 $data->completionstatusrequired
= null;
537 // Else do nothing: completionstatusrequired has been already converted
538 // into a correct integer representation.
540 if (!empty($data->completionscoredisabled
) ||
!$autocompletion) {
541 $data->completionscorerequired
= null;