Index: aicc.php =================================================================== RCS file: /cvsroot/moodle/moodle/mod/scorm/aicc.php,v retrieving revision 1.42 diff -u -r1.42 aicc.php --- aicc.php 26 Jun 2010 00:48:35 -0000 1.42 +++ aicc.php 2 Jul 2010 09:37:52 -0000 @@ -55,13 +55,14 @@ } else { print_error('cannotcallscript'); } - scorm_write_log("aicc", "scoid: $scoid", $scoid); - scorm_write_log("aicc", "mode: $mode", $scoid); - scorm_write_log("aicc", "status: $status", $scoid); - scorm_write_log("aicc", "attempt: $attempt", $scoid); - scorm_write_log("aicc", "command: $command", $scoid); - scorm_write_log("aicc", "sessionid: $sessionid", $scoid); - scorm_write_log("aicc", "aiccdata:\r\n$aiccdata", $scoid); + $aiccrequest = "MOODLE scoid: $scoid" + . "\r\nMOODLE mode: $mode" + . "\r\nMOODLE status: $status" + . "\r\nMOODLE attempt: $attempt" + . "\r\nAICC sessionid: $sessionid" + . "\r\nAICC command: $command" + . "\r\nAICC aiccdata:\r\n$aiccdata"; + scorm_debug_log_write("aicc", "HACP Request:\r\n$aiccrequest", $scoid); ob_start(); if ($scorm = $DB->get_record('scorm',array('id'=>$sco->scorm))) { @@ -386,5 +387,5 @@ } } $aiccresponse = ob_get_contents(); - scorm_write_log("aicc", "response:\r\n$aiccresponse", $scoid); - ob_end_flush(); \ No newline at end of file + scorm_debug_log_write("aicc", "HACP Response:\r\n$aiccresponse", $scoid); + ob_end_flush(); Index: lib.php =================================================================== RCS file: /cvsroot/moodle/moodle/mod/scorm/lib.php,v retrieving revision 1.141 diff -u -r1.141 lib.php --- lib.php 25 Jun 2010 07:30:56 -0000 1.141 +++ lib.php 2 Jul 2010 09:18:27 -0000 @@ -969,27 +969,127 @@ $navigation->nodetype = navigation_node::NODETYPE_LEAF; } /** - * writes log output to a temp log file + * Get the filename for a temp log file * * @param string $type - type of log(aicc,scorm12,scorm13) used as prefix for filename - * @param string $text - text to be written to file. - * @param integer $scoid - scoid of object this log entry is for. + * @param integer $scoid - scoid of object this log entry is for + * @return string The filename as an absolute path */ -function scorm_write_log($type, $text, $scoid) { +function scorm_debug_log_filename($type, $scoid) { + global $CFG, $USER; + + $logpath = $CFG->dataroot.'/temp/scormlogs'; + $logfile = $logpath.'/'.$type.'debug_'.$USER->id.'_'.$scoid.'.log'; + return $logfile; +} +/** + * Writes log output to a temp log file + * + * @param string $type - type of log(aicc,scorm12,scorm13) used as prefix for filename + * @param string $text - text to be written to file + * @param integer $scoid - scoid of object this log entry is for + * + */ +function scorm_debug_log_write($type, $text, $scoid) { global $CFG, $USER; $debugenablelog = debugging('', DEBUG_DEVELOPER); if (!$debugenablelog || empty($text)) { return ; } - if (make_upload_directory('temp/scormlogs/')) { - $logpath = $CFG->dataroot.'/temp/scormlogs'; - $logfile = $logpath.'/'.$type.'debug_'.$USER->id.'_'.$scoid.'.log'; + if (make_upload_directory('temp/scormlogs/')) { + $logfile = scorm_debug_log_filename($type, $scoid); @file_put_contents($logfile, date('Y/m/d H:i:s O')." DEBUG $text\r\n", FILE_APPEND); } } /** + * Remove debug log file + * + * @param string $type - type of log(aicc,scorm12,scorm13) used as prefix for filename + * @param integer $scoid - scoid of object this log entry is for + * @return boolean True if the file is successfully deleted, false otherwise + */ +function scorm_debug_log_remove($type, $scoid) { + global $CFG, $USER; + + $debugenablelog = debugging('', DEBUG_DEVELOPER); + $logfile = scorm_debug_log_filename($type, $scoid); + if (!$debugenablelog || !file_exists($logfile)) { + return false; + } + + return @unlink($logfile); +} +/** + * Print out log output, full or incremental + * + * @param string $type - type of log(aicc,scorm12,scorm13) used as prefix for filename + * @param integer $scoid - scoid of object this log entry is for + * @param string $action - type of the retrieval(full,incremental). Default: full + * @return mixed True if anything has been echoed, false on failure e.g. if the file doesn't exists or no update has been found, null otherwise + * @todo SplFileObject should be the preferred choice but it's not backward compatible with 1.9 requirements + */ +function scorm_debug_log_print($type, $scoid, $action = 'full') { + global $CFG, $SESSION, $USER; + + $debugenablelog = debugging('', DEBUG_DEVELOPER); + if (!$debugenablelog) { + return null; + } + + $logfile = scorm_debug_log_filename($type, $scoid);; + if (file_exists($logfile) && is_readable($logfile)) { + switch($action) { + case 'incremental': + $last = null; + if (isset($SESSION->scorm_debug_log_last_position)) { + $last = $SESSION->scorm_debug_log_last_position; + $handle = @fopen($logfile, 'r'); + if ($handle) { + $position = filesize($logfile); + $least = ($position > $last ? $last : -1); // -1 => log smaller than previous run + if ($least > 0) { + if (fseek($handle, $least, SEEK_SET) > -1) { + $line = null; + while (!feof($handle)) { + $line = stream_get_line($handle, 4096, "\r\n");; + // Use a fixed EOL, \n, and flush the line to output + echo rtrim($line, "\r\n") . "\n"; + } + // Track the Last Position + $SESSION->scorm_debug_log_last_position = $position; + } + } + fclose($handle); + return true; + } + return false; + } + // Get the full log: no valid last timestamp found in session i.e. no break + default: + // Get the content: slow but memory proof + $handle = @fopen($logfile, 'r'); + if ($handle) { + $position = filesize($logfile); + $line = null; + while (!feof($handle)) { + $line = $buffer = stream_get_line($handle, 4096, "\r\n");; + // Fix the EOL with \n and flush the line to output + echo rtrim($line, "\r\n") . "\n"; + } + fclose($handle); + // Track the Last Position + $SESSION->scorm_debug_log_last_position = $position; + return true; + } + return false; + } + } + + return false; +} +/** * writes overview info for course_overview block - displays upcoming scorm objects that have a due date * * @param object $type - type of log(aicc,scorm12,scorm13) used as prefix for filename --- aicc_debug.php +++ aicc_debug.php @@ -0,0 +1,205 @@ +dirroot.'/mod/scorm/lib.php'); + + $ajax = optional_param('ajax', 0, PARAM_INT); // 1=update, 2=delete, =get + + $PAGE->set_url('/mod/scorm/datamodels/aicc_debug.php', array('ajax' => $ajax)); + + // Simple authorization: $USER will be already able to access just + // to his/her perfomance on his/her own attempts + require_login(); + + // Required parameters from SESSION + if (isset($SESSION->scorm_scoid)) { + $scoid = $SESSION->scorm_scoid; + } else { + print_error('cannotcallscript'); + } + + $logfile = scorm_debug_log_filename($type, $scoid); + switch ($ajax) { + case 1: // update + $result = scorm_debug_log_print('aicc', $scoid, 'incremental'); + exit(); + case 2: // delete + $result = scorm_debug_log_remove('aicc', $scoid); + echo ($result ? 'true' : 'false'); + exit(); + } + + // Clean up any previous incremental read + unset($SESSION->scorm_debug_log_last_position); + +?> + + + AICC HACP debug log viewer: $CFG->dataroot<?php echo str_replace($CFG->dataroot, '', $logfile); ?> + + + + + +
+ Log viewer: + + + +
+
+
+
+
+ + + +