Skip to content

Commit

Permalink
Merge branch 'MDL-50428-master' of git://github.com/jleyva/moodle
Browse files Browse the repository at this point in the history 
Conflicts:
	mod/scorm/version.php
	version.php
  • Loading branch information
David Monllao committed Dec 29, 2015
2 parents 9787b9e + 98fff78 commit 97f4eb1
Show file tree
Hide file tree
Showing 8 changed files with 267 additions and 92 deletions.
1 change: 1 addition & 0 deletions lib/db/services.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1246,6 +1246,7 @@
'mod_scorm_get_scorm_sco_tracks',
'mod_scorm_get_scorm_attempt_count',
'mod_scorm_get_scorms_by_courses',
'mod_scorm_launch_sco',
'mod_survey_get_surveys_by_courses',
'mod_survey_view_survey',
'mod_survey_get_questions',
Expand Down
73 changes: 73 additions & 0 deletions mod/scorm/classes/external.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -829,4 +829,77 @@ public static function get_scorms_by_courses_returns() {
)
);
}

/**
* Returns description of method parameters
*
* @return external_function_parameters
* @since Moodle 3.1
*/
public static function launch_sco_parameters() {
return new external_function_parameters(
array(
'scormid' => new external_value(PARAM_INT, 'SCORM instance id'),
'scoid' => new external_value(PARAM_INT, 'SCO id (empty for launching the first SCO)', VALUE_DEFAULT, 0)
)
);
}

/**
* Trigger the course module viewed event.
*
* @param int $scormid the SCORM instance id
* @param int $scoid the SCO id
* @return array of warnings and status result
* @since Moodle 3.1
* @throws moodle_exception
*/
public static function launch_sco($scormid, $scoid = 0) {
global $DB;

$params = self::validate_parameters(self::launch_sco_parameters(),
array(
'scormid' => $scormid,
'scoid' => $scoid
));
$warnings = array();

// Request and permission validation.
$scorm = $DB->get_record('scorm', array('id' => $params['scormid']), '*', MUST_EXIST);
list($course, $cm) = get_course_and_cm_from_instance($scorm, 'scorm');

$context = context_module::instance($cm->id);
self::validate_context($context);

// If the SCORM is not open this function will throw exceptions.
scorm_require_available($scorm);

if (!empty($params['scoid']) and !($sco = scorm_get_sco($params['scoid'], SCO_ONLY))) {
throw new moodle_exception('cannotfindsco', 'scorm');
}

list($sco, $scolaunchurl) = scorm_get_sco_and_launch_url($scorm, $params['scoid'], $context);
// Trigger the SCO launched event.
scorm_launch_sco($scorm, $sco, $cm, $context, $scolaunchurl);

$result = array();
$result['status'] = true;
$result['warnings'] = $warnings;
return $result;
}

/**
* Returns description of method result value
*
* @return external_description
* @since Moodle 3.1
*/
public static function launch_sco_returns() {
return new external_single_structure(
array(
'status' => new external_value(PARAM_BOOL, 'status: true if success'),
'warnings' => new external_warnings()
)
);
}
}
10 changes: 9 additions & 1 deletion mod/scorm/db/services.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,5 +84,13 @@
no courses are provided then all the scorm instances the user has access to will be returned.',
'type' => 'read',
'capabilities' => ''
)
),

'mod_scorm_launch_sco' => array(
'classname' => 'mod_scorm_external',
'methodname' => 'launch_sco',
'description' => 'Trigger the SCO launched event.',
'type' => 'write',
'capabilities' => ''
),
);
98 changes: 9 additions & 89 deletions mod/scorm/loadSCO.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,104 +65,24 @@

$context = context_module::instance($cm->id);

if (!empty($scoid)) {
// Direct SCO request.
if ($sco = scorm_get_sco($scoid)) {
if ($sco->launch == '') {
// Search for the next launchable sco.
if ($scoes = $DB->get_records_select(
'scorm_scoes',
'scorm = ? AND '.$DB->sql_isnotempty('scorm_scoes', 'launch', false, true).' AND id > ?',
array($scorm->id, $sco->id),
'sortorder, id')) {
$sco = current($scoes);
}
}
}
}

// If no sco was found get the first of SCORM package.
if (!isset($sco)) {
$scoes = $DB->get_records_select(
'scorm_scoes',
'scorm = ? AND '.$DB->sql_isnotempty('scorm_scoes', 'launch', false, true),
array($scorm->id),
'sortorder, id'
);
$sco = current($scoes);
}
// Forge SCO URL.
list($sco, $scolaunchurl) = scorm_get_sco_and_launch_url($scorm, $scoid, $context);

if ($sco->scormtype == 'asset') {
$attempt = scorm_get_last_attempt($scorm->id, $USER->id);
$element = (scorm_version_check($scorm->version, SCORM_13)) ? 'cmi.completion_status' : 'cmi.core.lesson_status';
$value = 'completed';
$result = scorm_insert_track($USER->id, $scorm->id, $sco->id, $attempt, $element, $value);
}

// Forge SCO URL.
$connector = '';
$version = substr($scorm->version, 0, 4);
if ((isset($sco->parameters) && (!empty($sco->parameters))) || ($version == 'AICC')) {
if (stripos($sco->launch, '?') !== false) {
$connector = '&';
} else {
$connector = '?';
}
if ((isset($sco->parameters) && (!empty($sco->parameters))) && ($sco->parameters[0] == '?')) {
$sco->parameters = substr($sco->parameters, 1);
}
}

if ($version == 'AICC') {
require_once("$CFG->dirroot/mod/scorm/datamodels/aicclib.php");
$aiccsid = scorm_aicc_get_hacp_session($scorm->id);
if (empty($aiccsid)) {
$aiccsid = sesskey();
}
$scoparams = '';
if (isset($sco->parameters) && (!empty($sco->parameters))) {
$scoparams = '&'. $sco->parameters;
}
$launcher = $sco->launch.$connector.'aicc_sid='.$aiccsid.'&aicc_url='.$CFG->wwwroot.'/mod/scorm/aicc.php'.$scoparams;
} else {
if (isset($sco->parameters) && (!empty($sco->parameters))) {
$launcher = $sco->launch.$connector.$sco->parameters;
} else {
$launcher = $sco->launch;
}
}

if (scorm_external_link($sco->launch)) {
// TODO: does this happen?
$result = $launcher;
} else if ($scorm->scormtype === SCORM_TYPE_EXTERNAL) {
// Remote learning activity.
$result = dirname($scorm->reference).'/'.$launcher;
} else if ($scorm->scormtype === SCORM_TYPE_LOCAL && strtolower($scorm->reference) == 'imsmanifest.xml') {
// This SCORM content sits in a repository that allows relative links.
$result = "$CFG->wwwroot/pluginfile.php/$context->id/mod_scorm/imsmanifest/$scorm->revision/$launcher";
} else if ($scorm->scormtype === SCORM_TYPE_LOCAL or $scorm->scormtype === SCORM_TYPE_LOCALSYNC) {
// Note: do not convert this to use get_file_url() or moodle_url()
// SCORM does not work without slasharguments and moodle_url() encodes querystring vars.
$result = "$CFG->wwwroot/pluginfile.php/$context->id/mod_scorm/content/$scorm->revision/$launcher";
scorm_insert_track($USER->id, $scorm->id, $sco->id, $attempt, $element, $value);
}

// Trigger a Sco launched event.
$event = \mod_scorm\event\sco_launched::create(array(
'objectid' => $sco->id,
'context' => $context,
'other' => array('instanceid' => $scorm->id, 'loadedcontent' => $result)
));
$event->add_record_snapshot('course_modules', $cm);
$event->add_record_snapshot('scorm', $scorm);
$event->add_record_snapshot('scorm_scoes', $sco);
$event->trigger();
// Trigger the SCO launched event.
scorm_launch_sco($scorm, $sco, $cm, $context, $scolaunchurl);

header('Content-Type: text/html; charset=UTF-8');

if ($sco->scormtype == 'asset') {
// HTTP 302 Found => Moved Temporarily.
header('Location: ' . $result);
header('Location: ' . $scolaunchurl);
// Provide a short feedback in case of slow network connection.
echo html_writer::start_tag('html');
echo html_writer::tag('body', html_writer::tag('p', get_string('activitypleasewait', 'scorm')));
Expand Down Expand Up @@ -216,7 +136,7 @@ function myGetAPI() {

function doredirect() {
if (myGetAPIHandle() != null) {
location = "<?php echo $result ?>";
location = "<?php echo $scolaunchurl ?>";
}
else {
document.body.innerHTML = "<p><?php echo get_string('activityloading', 'scorm');?>" +
Expand All @@ -231,15 +151,15 @@ function doredirect() {
} else {
clearInterval(timer);
document.body.innerHTML = "<p><?php echo get_string('activitypleasewait', 'scorm');?></p>";
location = "<?php echo $result ?>";
location = "<?php echo $scolaunchurl ?>";
}
}, 1000);
}
}
//]]>
</script>
<noscript>
<meta http-equiv="refresh" content="0;url=<?php echo $result ?>" />
<meta http-equiv="refresh" content="0;url=<?php echo $scolaunchurl ?>" />
</noscript>
<?php
echo html_writer::end_tag('head');
Expand Down
111 changes: 111 additions & 0 deletions mod/scorm/locallib.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2087,3 +2087,114 @@ function scorm_require_available($scorm, $checkviewreportcap = false, $context =
}

}

/**
* Return a SCO object and the SCO launch URL
*
* @param stdClass $scorm SCORM object
* @param int $scoid The SCO id in database
* @param stdClass $context context object
* @return array the SCO object and URL
* @since Moodle 3.1
*/
function scorm_get_sco_and_launch_url($scorm, $scoid, $context) {
global $CFG, $DB;

if (!empty($scoid)) {
// Direct SCO request.
if ($sco = scorm_get_sco($scoid)) {
if ($sco->launch == '') {
// Search for the next launchable sco.
if ($scoes = $DB->get_records_select(
'scorm_scoes',
'scorm = ? AND '.$DB->sql_isnotempty('scorm_scoes', 'launch', false, true).' AND id > ?',
array($scorm->id, $sco->id),
'sortorder, id')) {
$sco = current($scoes);
}
}
}
}

// If no sco was found get the first of SCORM package.
if (!isset($sco)) {
$scoes = $DB->get_records_select(
'scorm_scoes',
'scorm = ? AND '.$DB->sql_isnotempty('scorm_scoes', 'launch', false, true),
array($scorm->id),
'sortorder, id'
);
$sco = current($scoes);
}

$connector = '';
$version = substr($scorm->version, 0, 4);
if ((isset($sco->parameters) && (!empty($sco->parameters))) || ($version == 'AICC')) {
if (stripos($sco->launch, '?') !== false) {
$connector = '&';
} else {
$connector = '?';
}
if ((isset($sco->parameters) && (!empty($sco->parameters))) && ($sco->parameters[0] == '?')) {
$sco->parameters = substr($sco->parameters, 1);
}
}

if ($version == 'AICC') {
require_once("$CFG->dirroot/mod/scorm/datamodels/aicclib.php");
$aiccsid = scorm_aicc_get_hacp_session($scorm->id);
if (empty($aiccsid)) {
$aiccsid = sesskey();
}
$scoparams = '';
if (isset($sco->parameters) && (!empty($sco->parameters))) {
$scoparams = '&'. $sco->parameters;
}
$launcher = $sco->launch.$connector.'aicc_sid='.$aiccsid.'&aicc_url='.$CFG->wwwroot.'/mod/scorm/aicc.php'.$scoparams;
} else {
if (isset($sco->parameters) && (!empty($sco->parameters))) {
$launcher = $sco->launch.$connector.$sco->parameters;
} else {
$launcher = $sco->launch;
}
}

if (scorm_external_link($sco->launch)) {
// TODO: does this happen?
$scolaunchurl = $launcher;
} else if ($scorm->scormtype === SCORM_TYPE_EXTERNAL) {
// Remote learning activity.
$scolaunchurl = dirname($scorm->reference).'/'.$launcher;
} else if ($scorm->scormtype === SCORM_TYPE_LOCAL && strtolower($scorm->reference) == 'imsmanifest.xml') {
// This SCORM content sits in a repository that allows relative links.
$scolaunchurl = "$CFG->wwwroot/pluginfile.php/$context->id/mod_scorm/imsmanifest/$scorm->revision/$launcher";
} else if ($scorm->scormtype === SCORM_TYPE_LOCAL or $scorm->scormtype === SCORM_TYPE_LOCALSYNC) {
// Note: do not convert this to use get_file_url() or moodle_url()
// SCORM does not work without slasharguments and moodle_url() encodes querystring vars.
$scolaunchurl = "$CFG->wwwroot/pluginfile.php/$context->id/mod_scorm/content/$scorm->revision/$launcher";
}
return array($sco, $scolaunchurl);
}

/**
* Trigger the scorm_launched event.
*
* @param stdClass $scorm scorm object
* @param stdClass $sco sco object
* @param stdClass $cm course module object
* @param stdClass $context context object
* @param string $scourl SCO URL
* @since Moodle 3.1
*/
function scorm_launch_sco($scorm, $sco, $cm, $context, $scourl) {

$event = \mod_scorm\event\sco_launched::create(array(
'objectid' => $sco->id,
'context' => $context,
'other' => array('instanceid' => $scorm->id, 'loadedcontent' => $scourl)
));
$event->add_record_snapshot('course_modules', $cm);
$event->add_record_snapshot('scorm', $scorm);
$event->add_record_snapshot('scorm_scoes', $sco);
$event->trigger();
}
Loading

0 comments on commit 97f4eb1

Please sign in to comment.