First version of the IMS CP resource module.
Known limitations:
- IMS Metadata is not loaded (soon it will be).
- IMS submanifests are not supported (is anybody using them?).
- Need to convert loaded data to SITE->charset, have to think a bit about it.
But it loads IMS CP packages like a charm! ;-)
This commit is contained in:
stronk7
@@ -0,0 +1,309 @@
|
||||
<?php // $Id$
|
||||
|
||||
///////////////////////////////////////////////////////////////////////////
|
||||
// //
|
||||
// NOTICE OF COPYRIGHT //
|
||||
// //
|
||||
// Moodle - Modular Object-Oriented Dynamic Learning Environment //
|
||||
// http://moodle.com //
|
||||
// //
|
||||
// Copyright (C) 2001-3001 Martin Dougiamas http://dougiamas.com //
|
||||
// (C) 2001-3001 Eloy Lafuente (stronk7) http://contiento.com //
|
||||
// //
|
||||
// This program is free software; you can redistribute it and/or modify //
|
||||
// it under the terms of the GNU General Public License as published by //
|
||||
// the Free Software Foundation; either version 2 of the License, or //
|
||||
// (at your option) any later version. //
|
||||
// //
|
||||
// This program is distributed in the hope that it will be useful, //
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of //
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the //
|
||||
// GNU General Public License for more details: //
|
||||
// //
|
||||
// http://www.gnu.org/copyleft/gpl.html //
|
||||
// //
|
||||
///////////////////////////////////////////////////////////////////////////
|
||||
|
||||
/***
|
||||
* This page will deploy an IMS Content Package zip file,
|
||||
* building all the structures and auxiliary files to
|
||||
* work inside a Moodle resource.
|
||||
*/
|
||||
|
||||
/// Required stuff
|
||||
require_once('../../../../config.php');
|
||||
require_once('../../lib.php');
|
||||
require_once('resource.class.php');
|
||||
require_once('../../../../backup/lib.php');
|
||||
require_once('../../../../lib/filelib.php');
|
||||
require_once('../../../../lib/xmlize.php');
|
||||
|
||||
/// Load request parameters
|
||||
$courseid = required_param ('courseid', PARAM_INT);
|
||||
$cmid = required_param ('cmid', PARAM_INT);
|
||||
$file = required_param ('file', PARAM_PATH);
|
||||
$inpopup = optional_param ('inpopup', 0, PARAM_BOOL);
|
||||
|
||||
/// Fetch some records from DB
|
||||
$course = get_record ('course', 'id', $courseid);
|
||||
$cm = get_record ('course_modules', 'id', $cmid);
|
||||
$resource = get_record ('resource', 'id', $cm->instance);
|
||||
|
||||
/// Get some needed strings
|
||||
$strdeploy = get_string('deploy','resource');
|
||||
|
||||
/// Instantiate a resource_ims object and modify its navigation
|
||||
$resource_obj = new resource_ims ($cmid);
|
||||
if ($resource_obj->course->category) {
|
||||
$resource_obj->navigation = "<a target=\"{$CFG->framename}\" href=\"$CFG->wwwroot/course/view.php?id={$course->id}\">{$course->shortname}</a> -> ".
|
||||
"<a target=\"{$CFG->framename}\" href=\"$CFG->wwwroot/mod/resource/index.php?id={$course->id}\">$resource_obj->strresources</a> -> ";
|
||||
} else {
|
||||
$resource_obj->navigation = "<a target=\"{$CFG->framename}\" href=\"$CFG->wwwroot/mod/resource/index.php?id={$course->id}\">$resource_obj->strresources</a> -> ";
|
||||
}
|
||||
|
||||
/// Print the header of the page
|
||||
$pagetitle = strip_tags($course->shortname.': '.
|
||||
format_string($resource->name)).': '.
|
||||
$strdeploy;
|
||||
|
||||
if ($inpopup) {
|
||||
print_header($pagetitle, $course->fullname);
|
||||
} else {
|
||||
print_header($pagetitle, $course->fullname,
|
||||
$resource_obj->navigation.format_string($resource->name).' -> '.$strdeploy,
|
||||
'', '', true,
|
||||
update_module_button($cm->id, $course->id, $resource_obj->strresource));
|
||||
}
|
||||
|
||||
/// Security Constraints (sesskey and isteacheredit)
|
||||
if (!confirm_sesskey()) {
|
||||
error(get_string('confirmsesskeybad', 'error'));
|
||||
} else if (!isteacheredit($courseid)) {
|
||||
error("Only editing teachers can deploy packages !");
|
||||
}
|
||||
|
||||
///
|
||||
/// Main process, where everything is deployed
|
||||
///
|
||||
|
||||
/// Set some variables
|
||||
|
||||
/// Create directories
|
||||
if (!$resourcedir = make_upload_directory($courseid.'/'.$CFG->moddata.'/resource/'.$resource->id)) {
|
||||
error (get_string('errorcreatingdirectory', 'error'));
|
||||
}
|
||||
|
||||
/// Ensure it's empty
|
||||
if (!delete_dir_contents($resourcedir)) {
|
||||
error (get_string('errorcleaningdirectory', 'error'));
|
||||
}
|
||||
|
||||
/// Copy files
|
||||
$origin = $CFG->dataroot.'/'.$courseid.'/'.$file;
|
||||
if (!is_file($origin)) {
|
||||
error (get_string('filenotexists' , 'error', $file));
|
||||
}
|
||||
$mimetype = mimeinfo("type", $file);
|
||||
if ($mimetype != "application/zip") {
|
||||
error (get_string('errorincorrectextension', 'error'));
|
||||
}
|
||||
$resourcefile = $resourcedir.'/'.basename($origin);
|
||||
if (!backup_copy_file($origin, $resourcefile)) {
|
||||
error (get_string('errorcopyingfiles', 'error'));
|
||||
}
|
||||
|
||||
/// Unzip files
|
||||
if (!unzip_file($resourcefile, '', false)) {
|
||||
error (get_string('errorunzippingfiles', 'error'));
|
||||
}
|
||||
|
||||
/// Check for imsmanifest
|
||||
if (!file_exists($resourcedir.'/imsmanifest.xml')) {
|
||||
error (get_string('filenotexists', 'error', 'imsmanifest.xml'));
|
||||
}
|
||||
|
||||
/// Load imsmanifest to memory (instead of using a full parser,
|
||||
/// we are going to use xmlize intensively (because files aren't too big)
|
||||
if (!$imsmanifest = ims_file2var ($resourcedir.'/imsmanifest.xml')) {
|
||||
error (get_string ('errorreadingfile', 'error', 'imsmanifest.xml'));
|
||||
}
|
||||
|
||||
/// xmlize the variable
|
||||
$data = xmlize($imsmanifest, 0);
|
||||
|
||||
/// Parse XML-metadata
|
||||
/// Skip this for now (until a proper METADATA container was created in Moodle).
|
||||
|
||||
/// Parse XML-content package data
|
||||
/// First we select an organization an load all the items
|
||||
if (!$items = ims_process_organizations($data['manifest']['#']['organizations']['0'])) {
|
||||
error (get_string('errornonmeaningfulcontent', 'error'));
|
||||
}
|
||||
|
||||
/// Now, we load all the resources available (keys are identifiers)
|
||||
if (!$resources = ims_load_resources($data['manifest']['#']['resources']['0']['#']['resource'])) {
|
||||
error (get_string('errornonmeaningfulcontent', 'error'));
|
||||
}
|
||||
///Now we assign to each item, its resource (by identifier)
|
||||
foreach ($items as $key=>$item) {
|
||||
if (!empty($resources[$item->identifierref])) {
|
||||
$items[$key]->href = $resources[$item->identifierref];
|
||||
} else {
|
||||
$items[$key]->href = '';
|
||||
}
|
||||
}
|
||||
|
||||
/// Create the INDEX (moodle_inx.ser - where the order of the pages are stored serialized) file
|
||||
if (!ims_save_serialized_file($resourcedir.'/moodle_inx.ser', $items)) {
|
||||
error (get_string('errorgeneratingfile', 'error', 'moodle_inx.ser'));
|
||||
}
|
||||
|
||||
/// Create the HASH file (moodle_hash.ser - where the hash of the ims is stored serialized) file
|
||||
$hash = $resource_obj->calculatefilehash($resourcefile);
|
||||
if (!ims_save_serialized_file($resourcedir.'/moodle_hash.ser', $hash)) {
|
||||
error (get_string('errorgeneratingfile', 'error', 'moodle_hash.ser'));
|
||||
}
|
||||
|
||||
/// End button (go to view mode)
|
||||
echo '<center>';
|
||||
print_simple_box(get_string("imspackageloaded"),"center");
|
||||
$link = $CFG->wwwroot.'/mod/resource/view.php';
|
||||
$options['r'] = $resource->id;
|
||||
$label = get_string('viewims', 'resource');
|
||||
$method = 'post';
|
||||
print_single_button($link, $options, $label, $method);
|
||||
echo '</center>';
|
||||
|
||||
///
|
||||
/// End of main process, where everything is deployed
|
||||
///
|
||||
|
||||
/// Print the footer of the page
|
||||
print_footer();
|
||||
|
||||
///
|
||||
/// Common and useful functions used by the body of the script
|
||||
///
|
||||
|
||||
/*** This function will return an ordered and nested array of items
|
||||
* that is a perfect representation of the prefered organization
|
||||
*/
|
||||
function ims_process_organizations($data) {
|
||||
global $CFG;
|
||||
|
||||
/// Get the default organization
|
||||
$default_organization = $data['@']['default'];
|
||||
if ($CFG->debug) print_object('default_organization: '.$default_organization);
|
||||
|
||||
/// Iterate (reverse) over organizations until we find the default one
|
||||
$count_organizations = count($data['#']['organization']);
|
||||
if ($CFG->debug) print_object('count_organizations: '.$count_organizations);
|
||||
|
||||
$current_organization = $count_organizations - 1;
|
||||
while ($current_organization >= 0) {
|
||||
/// Load organization and check it
|
||||
$organization = $data['#']['organization'][$current_organization];
|
||||
if ($organization['@']['identifier'] == $default_organization) {
|
||||
$current_organization = -1; //Match, so exit.
|
||||
}
|
||||
$current_organization--;
|
||||
}
|
||||
|
||||
/// At this point we MUST have the final organization
|
||||
if ($CFG->debug) print_object('final organization: '.$organization['#']['title'][0]['#']);
|
||||
if (empty($organization)) {
|
||||
return false; //Error, no organization found
|
||||
}
|
||||
|
||||
/// Extract items map from organization
|
||||
$items = $organization['#']['item'];
|
||||
if (!$itemmap = ims_process_items($items)) {
|
||||
return false; //Error, no items found
|
||||
}
|
||||
return $itemmap;
|
||||
}
|
||||
|
||||
/*** This function gets the xmlized representation of the items
|
||||
* and returns an array of items, ordered, with level and info
|
||||
*/
|
||||
function ims_process_items($items, $level = 1, &$id = 1, $parent = 0) {
|
||||
global $CFG;
|
||||
|
||||
$itemmap = array();
|
||||
|
||||
/// Iterate over items from start to end
|
||||
$count_items = count($items);
|
||||
if ($CFG->debug) print_object('level '.$level.'-count_items: '.$count_items);
|
||||
|
||||
$current_item = 0;
|
||||
while ($current_item < $count_items) {
|
||||
/// Load item
|
||||
$item = $items[$current_item];
|
||||
$obj_item = new stdClass;
|
||||
$obj_item->title = $item['#']['title'][0]['#'];
|
||||
$obj_item->identifier = $item['@']['identifier'];
|
||||
$obj_item->identifierref = $item['@']['identifierref'];
|
||||
$obj_item->id = $id;
|
||||
$obj_item->level = $level;
|
||||
$obj_item->parent = $parent;
|
||||
/// Only if the item has everything
|
||||
if (!empty($obj_item->title) &&
|
||||
!empty($obj_item->identifier)) {
|
||||
/// Add to itemmap
|
||||
$itemmap[$id] = $obj_item;
|
||||
if ($CFG->debug) print_object('level '.$level.'-id '.$id.'-parent '.$parent.'-'.$obj_item->title);
|
||||
/// Counters go up
|
||||
$id++;
|
||||
/// Check for subitems recursively
|
||||
$subitems = $item['#']['item'];
|
||||
if (count($subitems)) {
|
||||
/// Recursive call
|
||||
$subitemmap = ims_process_items($subitems, $level+1, $id, $obj_item->id);
|
||||
/// Add at the end and counters if necessary
|
||||
if ($count_subitems = count($subitemmap)) {
|
||||
foreach ($subitemmap as $subitem) {
|
||||
/// Add the subitem to the main items array
|
||||
$itemmap[$subitem->id] = $subitem;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
$current_item++;
|
||||
}
|
||||
return $itemmap;
|
||||
}
|
||||
|
||||
/*** This function will load an array of resources to be used later.
|
||||
* Keys are identifiers
|
||||
*/
|
||||
function ims_load_resources($data) {
|
||||
global $CFG;
|
||||
|
||||
$resources = array();
|
||||
|
||||
$count_resources = count($data);
|
||||
if ($CFG->debug) print_object('count_resources: '.$count_resources);
|
||||
|
||||
$current_resource = 0;
|
||||
while ($current_resource < $count_resources) {
|
||||
/// Load resource
|
||||
$resource = $data[$current_resource];
|
||||
$obj_resource = new stdClass;
|
||||
$obj_resource->identifier = $resource['@']['identifier'];
|
||||
$obj_resource->href = $resource['@']['href'];
|
||||
if (empty($obj_resource->href)) {
|
||||
$obj_resource->href = $resource['#']['file'][0]['@']['href'];
|
||||
}
|
||||
/// Only if the resource has everything
|
||||
if (!empty($obj_resource->identifier) &&
|
||||
!empty($obj_resource->href)) {
|
||||
/// Add to resources (identifier as key)
|
||||
$resources[$obj_resource->identifier] = $obj_resource->href;
|
||||
}
|
||||
/// Counters go up
|
||||
$current_resource++;
|
||||
}
|
||||
return $resources;
|
||||
}
|
||||
|
||||
?>
|
||||
@@ -0,0 +1,205 @@
|
||||
<?php // $Id$
|
||||
|
||||
///////////////////////////////////////////////////////////////////////////
|
||||
// //
|
||||
// NOTICE OF COPYRIGHT //
|
||||
// //
|
||||
// Moodle - Modular Object-Oriented Dynamic Learning Environment //
|
||||
// http://moodle.com //
|
||||
// //
|
||||
// Copyright (C) 2001-3001 Martin Dougiamas http://dougiamas.com //
|
||||
// (C) 2001-3001 Eloy Lafuente (stronk7) http://contiento.com //
|
||||
// //
|
||||
// This program is free software; you can redistribute it and/or modify //
|
||||
// it under the terms of the GNU General Public License as published by //
|
||||
// the Free Software Foundation; either version 2 of the License, or //
|
||||
// (at your option) any later version. //
|
||||
// //
|
||||
// This program is distributed in the hope that it will be useful, //
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of //
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the //
|
||||
// GNU General Public License for more details: //
|
||||
// //
|
||||
// http://www.gnu.org/copyleft/gpl.html //
|
||||
// //
|
||||
///////////////////////////////////////////////////////////////////////////
|
||||
?>
|
||||
|
||||
<tr valign="top">
|
||||
<td align="right" nowrap="nowrap">
|
||||
|
||||
|
||||
<script language="javascript" type="text/javascript">
|
||||
function showhide (id, set) {
|
||||
divobj = document.getElementById(id);
|
||||
butobj = document.getElementById(id+'button');
|
||||
prefobj = document.getElementById(id+'pref');
|
||||
if (set == true) {
|
||||
if (prefobj.value == '1') {
|
||||
divobj.style.display = 'block';
|
||||
butobj.value = '<?php print_string("hidesettings") ?>';
|
||||
} else {
|
||||
divobj.style.display = 'none';
|
||||
butobj.value = '<?php print_string("showsettings") ?>...';
|
||||
}
|
||||
} else {
|
||||
if (prefobj.value == '1') {
|
||||
divobj.style.display = 'none';
|
||||
butobj.value = '<?php print_string("showsettings") ?>...';
|
||||
prefobj.value = '0';
|
||||
} else {
|
||||
divobj.style.display = 'block';
|
||||
butobj.value = '<?php print_string("hidesettings") ?>';
|
||||
prefobj.value = '1';
|
||||
}
|
||||
}
|
||||
}
|
||||
</script>
|
||||
|
||||
|
||||
<b><?php echo $strfilename ?>:</b>
|
||||
</td>
|
||||
<td>
|
||||
<?php
|
||||
echo "<input type=\"text\" name=\"reference\" size=\"90\" value=\"$form->reference\" alt=\"reference\" /><br />";
|
||||
button_to_popup_window ("/files/index.php?id=$form->course&choose=form.reference", "coursefiles", $strchooseafile, 500, 750, $strchooseafile);
|
||||
?>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr><td colspan="2"><hr /></td></tr>
|
||||
|
||||
<tr>
|
||||
<td align="right"><b><?php print_string("display", "resource") ?>:</b></td>
|
||||
<td>
|
||||
<input type="button" value="hide settings" id="windowsettingsbutton" onclick="javascript: return showhide('windowsettings');" />
|
||||
<input type="hidden" name="windowsettingspref" id="windowsettingspref"
|
||||
value="<?php echo get_user_preferences('resource_windowsettingspref', $CFG->resource_windowsettings); ?>" />
|
||||
<?php helpbutton("window", get_string("display", "resource"), "resource", true) ?>
|
||||
</td>
|
||||
</tr>
|
||||
<tr><td colspan="2">
|
||||
|
||||
<div id="windowsettings">
|
||||
|
||||
<table align="center">
|
||||
|
||||
|
||||
<tr valign="top">
|
||||
|
||||
<td colspan="2">
|
||||
<script type="text/javascript">
|
||||
var popupitems = [<?php echo $popupoptions; ?>];
|
||||
var allitems = [<?php echo $alloptions; ?>];
|
||||
</script>
|
||||
<input type="radio" name="windowpopup" value="0" alt="<?php print_string('pagewindow', 'resource') ?>" <?php echo ($windowtype != "popup") ? "checked=\"checked\"" : "" ?>
|
||||
onclick="lockoptions('form', 'windowpopup[1]', popupitems);" />
|
||||
<b title="<?php print_string("pagedisplay", "resource") ?>"><?php print_string("pagewindow", "resource") ?></b>
|
||||
<blockquote>
|
||||
<input type="hidden" name="framepage" value="1" />
|
||||
</blockquote>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr valign="top">
|
||||
|
||||
<td colspan="2">
|
||||
<input name="windowpopup" type="radio" value="1" alt="<?php p($strnewwindow)?>" <?php echo ($windowtype == "popup") ? "checked=\"checked\"" : "" ?>
|
||||
onclick="lockoptions('form', 'windowpopup[1]', popupitems);" />
|
||||
<b title="<?php p($strnewwindowopen) ?>"><?php p($strnewwindow) ?></b>
|
||||
<blockquote>
|
||||
<?php
|
||||
foreach ($window as $name => $value) {
|
||||
if ($name == "height" or $name == "width") {
|
||||
continue;
|
||||
}
|
||||
echo "<input name=\"h$name\" type=\"hidden\" value=\"0\" />";
|
||||
echo "<input name=\"$name\" type=\"checkbox\" value=\"1\" ".$window->$name." alt=\"$name\" />";
|
||||
$stringname = "str$name";
|
||||
echo $$stringname."<br />";
|
||||
}
|
||||
?>
|
||||
|
||||
<input name="hwidth" type="hidden" value="0" />
|
||||
<input name="width" type="text" size="4" value="<?php p($window->width) ?>" alt="<?php p($strwidth) ?>" />
|
||||
<?php p($strwidth) ?><br />
|
||||
|
||||
<input name="hheight" type="hidden" value="0" />
|
||||
<input name="height" type="text" size="4" value="<?php p($window->height) ?>" alt="<?php p($strheight) ?>" />
|
||||
<?php p($strheight) ?><br />
|
||||
<?php
|
||||
if ($windowtype == "page") {
|
||||
echo "<script type=\"text/javascript\">";
|
||||
echo "lockoptions('form','windowpopup[1]', popupitems);";
|
||||
echo "</script>";
|
||||
} else {
|
||||
echo "<script type=\"text/javascript\">";
|
||||
echo "lockoptions('form','windowpopup[0]', frameitem);";
|
||||
echo "</script>";
|
||||
}
|
||||
?>
|
||||
</blockquote>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
</td></tr>
|
||||
|
||||
<tr>
|
||||
<td align="right"><b><?php print_string("parameters", "resource") ?>:</b></td>
|
||||
<td>
|
||||
<input type="button" value="hide settings" id="parametersettingsbutton" onclick="javascript: return showhide('parametersettings');" />
|
||||
<input type="hidden" name="parametersettingspref" id="parametersettingspref"
|
||||
value="<?php echo get_user_preferences('resource_parametersettingspref', $CFG->resource_parametersettings); ?>" />
|
||||
<?php helpbutton("imsparameters", get_string("parameters", "resource"), "resource", true) ?>
|
||||
</td>
|
||||
</tr>
|
||||
<tr><td colspan="2">
|
||||
|
||||
<div id="parametersettings">
|
||||
|
||||
<table align="center">
|
||||
|
||||
<?php
|
||||
|
||||
$yesno = array();
|
||||
$yesno[0] = get_string('no');
|
||||
$yesno[1] = get_string('yes');
|
||||
|
||||
echo "<tr>\n";
|
||||
echo "<td valign=\"top\" align=\"right\">\n";
|
||||
echo get_string('tableofcontents','resource').': ';
|
||||
echo "</td>\n";
|
||||
echo "<td valign=\"top\">\n";
|
||||
choose_from_menu($yesno, "param_tableofcontents", $form->param_tableofcontents, "");
|
||||
echo "</td>\n";
|
||||
echo "</tr>\n";
|
||||
|
||||
echo "<tr>\n";
|
||||
echo "<td valign=\"top\" align=\"right\">\n";
|
||||
echo get_string('navigationbuttons','resource').': ';
|
||||
echo "</td>\n";
|
||||
echo "<td valign=\"top\">\n";
|
||||
choose_from_menu($yesno, "param_navigationbuttons", $form->param_navigationbuttons, "");
|
||||
echo "</td>\n";
|
||||
echo "</tr>\n";
|
||||
?>
|
||||
|
||||
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script language="javascript" type="text/javascript">
|
||||
showhide('parametersettings', true);
|
||||
showhide('windowsettings', true);
|
||||
</script>
|
||||
|
||||
|
||||
</td></tr>
|
||||
|
||||
<?php print_visible_setting($form); ?>
|
||||
@@ -0,0 +1,757 @@
|
||||
<?php // $Id$
|
||||
|
||||
///////////////////////////////////////////////////////////////////////////
|
||||
// //
|
||||
// NOTICE OF COPYRIGHT //
|
||||
// //
|
||||
// Moodle - Modular Object-Oriented Dynamic Learning Environment //
|
||||
// http://moodle.com //
|
||||
// //
|
||||
// Copyright (C) 2001-3001 Martin Dougiamas http://dougiamas.com //
|
||||
// (C) 2001-3001 Eloy Lafuente (stronk7) http://contiento.com //
|
||||
// //
|
||||
// This program is free software; you can redistribute it and/or modify //
|
||||
// it under the terms of the GNU General Public License as published by //
|
||||
// the Free Software Foundation; either version 2 of the License, or //
|
||||
// (at your option) any later version. //
|
||||
// //
|
||||
// This program is distributed in the hope that it will be useful, //
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of //
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the //
|
||||
// GNU General Public License for more details: //
|
||||
// //
|
||||
// http://www.gnu.org/copyleft/gpl.html //
|
||||
// //
|
||||
///////////////////////////////////////////////////////////////////////////
|
||||
|
||||
/**
|
||||
* Extend the base resource class for ims resources
|
||||
*/
|
||||
class resource_ims extends resource_base {
|
||||
|
||||
var $parameters; //Attribute of this class where we'll store all the IMS deploy preferences
|
||||
|
||||
function resource_ims($cmid=0) {
|
||||
/// super constructor
|
||||
parent::resource_base($cmid);
|
||||
|
||||
/// prevent notice
|
||||
if (empty($this->resource->alltext)) {
|
||||
$this->resource->alltext='';
|
||||
}
|
||||
/// set own attributes
|
||||
$this->parameters = $this->alltext2parameters($this->resource->alltext);
|
||||
}
|
||||
|
||||
/***
|
||||
* This function converts parameters stored in the alltext field to the proper
|
||||
* this->parameters object storing the special configuration of this resource type
|
||||
*/
|
||||
function alltext2parameters($alltext) {
|
||||
/// set parameter defaults
|
||||
$alltextfield = new stdClass();
|
||||
$alltextfield->tableofcontents=0;
|
||||
$alltextfield->navigationbuttons=0;
|
||||
|
||||
/// load up any stored parameters
|
||||
if (!empty($alltext)) {
|
||||
$parray = explode(',', $alltext);
|
||||
foreach ($parray as $key => $fieldstring) {
|
||||
$field = explode('=', $fieldstring);
|
||||
$alltextfield->$field[0] = $field[1];
|
||||
}
|
||||
}
|
||||
|
||||
return $alltextfield;
|
||||
}
|
||||
|
||||
/***
|
||||
* This function converts the this->parameters attribute (object) to the format
|
||||
* needed to save them in the alltext field to store all the special configuration
|
||||
* of this resource type
|
||||
*/
|
||||
function parameters2alltext($parameters) {
|
||||
$optionlist = array();
|
||||
|
||||
$optionlist[] = 'tableofcontents='.$parameters->tableofcontents;
|
||||
$optionlist[] = 'navigationbuttons='.$parameters->navigationbuttons;
|
||||
|
||||
return implode(',', $optionlist);
|
||||
}
|
||||
|
||||
/***
|
||||
* This function will convert all the parameters configured in the resource form
|
||||
* to a this->parameter attribute (object)
|
||||
*/
|
||||
function form2parameters($resource) {
|
||||
$parameters = new stdClass;
|
||||
$parameters->tableofcontents = $resource->param_tableofcontents;
|
||||
$parameters->navigationbuttons = $resource->param_navigationbuttons;
|
||||
|
||||
return $parameters;
|
||||
}
|
||||
|
||||
/*** This function checks for errors in the status or deployment of the IMS
|
||||
* Content Package returning an error code:
|
||||
* 1 = Not a .zip file.
|
||||
* 2 = Zip file doesn't exist
|
||||
* 3 = Package not deployed.
|
||||
* 4 = Package has changed since deployed.
|
||||
*/
|
||||
function check4errors($file, $course, $resource) {
|
||||
|
||||
global $CFG;
|
||||
|
||||
$mimetype = mimeinfo("type", $file);
|
||||
if ($mimetype != "application/zip") {
|
||||
return 1; //Error
|
||||
}
|
||||
|
||||
/// Check if the uploaded file exists
|
||||
if (!file_exists($CFG->dataroot.'/'.$course->id.'/'.$file)) {
|
||||
return 2; //Error
|
||||
}
|
||||
|
||||
/// Calculate the path were the IMS package must be deployed
|
||||
$deploydir = $CFG->dataroot.'/'.$course->id.'/'.$CFG->moddata.'/resource/'.$resource->id;
|
||||
|
||||
/// Confirm that the IMS package has been deployed. These files must exist if
|
||||
/// the package is deployed: moodle_index.ser and moodle_hash.ser
|
||||
if (!file_exists($deploydir.'/moodle_inx.ser') ||
|
||||
!file_exists($deploydir.'/moodle_hash.ser')) {
|
||||
return 3; //Error
|
||||
}
|
||||
|
||||
/// If teacheredit, make, hash check. It's the md5 of the name of the file
|
||||
/// plus its size and modification date
|
||||
if (isteacheredit($course->id)) {
|
||||
if (!$this->checkpackagehash($file, $course, $resource)) {
|
||||
return 4;
|
||||
}
|
||||
}
|
||||
|
||||
/// We've arrived here. Everything is ok
|
||||
return 0;
|
||||
}
|
||||
|
||||
/*** This function will check that the ims package (zip file) uploaded
|
||||
* isn't changed since it was deployed.
|
||||
*/
|
||||
function checkpackagehash($file, $course, $resource) {
|
||||
global $CFG;
|
||||
|
||||
/// Calculate paths
|
||||
$zipfile = $CFG->dataroot.'/'.$course->id.'/'.$file;
|
||||
$hashfile= $CFG->dataroot.'/'.$course->id.'/'.$CFG->moddata.'/resource/'.$resource->id.'/moodle_hash.ser';
|
||||
/// Get deloyed hash value
|
||||
$f = fopen ($hashfile,'r');
|
||||
$deployedhash = fread($f, filesize($hashfile));
|
||||
fclose ($f);
|
||||
/// Unserialize the deployed hash
|
||||
$deployedhash = unserialize($deployedhash);
|
||||
/// Calculate uploaded file hash value
|
||||
$uploadedhash = $this->calculatefilehash($zipfile);
|
||||
|
||||
/// Compare them
|
||||
return ($deployedhash == $uploadedhash);
|
||||
}
|
||||
|
||||
/*** This function will calculate the hash of any file passes as argument.
|
||||
* It's based in a md5 of the filename, filesize and 20 first bytes (it includes
|
||||
* the zip CRC at byte 15).
|
||||
*/
|
||||
function calculatefilehash($filefullpath) {
|
||||
|
||||
/// Name and size
|
||||
$filename = basename($filefullpath);
|
||||
$filesize = filesize($filefullpath);
|
||||
/// Read first 20cc
|
||||
$f = fopen ($filefullpath,'r');
|
||||
$data = fread($f, 20);
|
||||
fclose ($f);
|
||||
|
||||
return md5($filename.'-'.$filesize.'-'.$data);
|
||||
}
|
||||
|
||||
/**
|
||||
* Add new instance of file resource
|
||||
*
|
||||
* Create alltext field before calling base class function.
|
||||
*
|
||||
* @param resource object
|
||||
*/
|
||||
function add_instance($resource) {
|
||||
|
||||
/// Load parameters to this->parameters
|
||||
$this->parameters = $this->form2parameters($resource);
|
||||
/// Save parameters into the alltext field
|
||||
$resource->alltext = $this->parameters2alltext($this->parameters);
|
||||
|
||||
return parent::add_instance($resource);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Update instance of file resource
|
||||
*
|
||||
* Create alltext field before calling base class function.
|
||||
*
|
||||
* @param resource object
|
||||
*/
|
||||
function update_instance($resource) {
|
||||
|
||||
/// Load parameters to this->parameters
|
||||
$this->parameters = $this->form2parameters($resource);
|
||||
/// Save parameters into the alltext field
|
||||
$resource->alltext = $this->parameters2alltext($this->parameters);
|
||||
|
||||
return parent::update_instance($resource);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Display the file resource
|
||||
*
|
||||
* Displays a file resource embedded, in a frame, or in a popup.
|
||||
* Output depends on type of file resource.
|
||||
*
|
||||
* @param CFG global object
|
||||
*/
|
||||
function display() {
|
||||
global $CFG, $THEME, $USER;
|
||||
|
||||
require_once($CFG->libdir.'/filelib.php');
|
||||
|
||||
/// Set up generic stuff first, including checking for access
|
||||
parent::display();
|
||||
|
||||
/// Set up some shorthand variables
|
||||
$cm = $this->cm;
|
||||
$course = $this->course;
|
||||
$resource = $this->resource;
|
||||
|
||||
/// Fetch parameters
|
||||
$inpopup = optional_param('inpopup', 0, PARAM_BOOL);
|
||||
$page = optional_param('page', 0, PARAM_INT);
|
||||
$frameset= optional_param('frameset', '', PARAM_ALPHA);
|
||||
|
||||
/// Init some variables
|
||||
$errorcode = 0;
|
||||
$buttontext = 0;
|
||||
$querystring = '';
|
||||
$resourcetype = '';
|
||||
$mimetype = mimeinfo("type", $resource->reference);
|
||||
$pagetitle = strip_tags($course->shortname.': '.format_string($resource->name));
|
||||
|
||||
/// Cache this per request
|
||||
static $items;
|
||||
|
||||
/// Check for errors
|
||||
$errorcode = $this->check4errors($resource->reference, $course, $resource);
|
||||
|
||||
/// If there are any error, show it instead of the resource page
|
||||
if ($errorcode) {
|
||||
if (!isteacheredit($course->id)) {
|
||||
/// Resource not available page
|
||||
$errortext = get_string('resourcenotavailable','resource');
|
||||
} else {
|
||||
/// Depending of the error, show different messages and pages
|
||||
if ($errorcode ==1) {
|
||||
$errortext = get_string('invalidfiletype','resource');
|
||||
} else if ($errorcode == 2) {
|
||||
$errortext = get_string('filenotexists','resource');
|
||||
} else if ($errorcode == 3) {
|
||||
$errortext = get_string('packagenotdeplyed','resource');
|
||||
} else if ($errorcode == 4) {
|
||||
$errortext = get_string('packagechanged','resource');
|
||||
}
|
||||
}
|
||||
/// Display the error and exit
|
||||
if ($inpopup) {
|
||||
print_header($pagetitle, $course->fullname.' : '.$resource->name);
|
||||
} else {
|
||||
print_header($pagetitle, $course->fullname, "$this->navigation ".format_string($resource->name), "", "", true, update_module_button($cm->id, $course->id, $this->strresource), navmenu($course, $cm));
|
||||
}
|
||||
print_simple_box_start('center', '60%');
|
||||
echo '<p align="center">'.$errortext.'</p>';
|
||||
/// If errors were 3 or 4 and isteacheredit(), show the deploy button
|
||||
if (isteacheredit($course->id) && ($errorcode = 3 || $errorcode ==4)) {
|
||||
$link = 'type/ims/deploy.php';
|
||||
$options['courseid'] = $course->id;
|
||||
$options['cmid'] = $cm->id;
|
||||
$options['file'] = $resource->reference;
|
||||
$options['sesskey'] = $USER->sesskey;
|
||||
$options['inpopup'] = $inpopup;
|
||||
if ($errorcode == 3) {
|
||||
$label = get_string ('deploy', 'resource');
|
||||
} else if ($errorcode == 4) {
|
||||
$label = get_string ('redeploy', 'resource');
|
||||
}
|
||||
$method='post';
|
||||
/// Let's go with the button
|
||||
echo '<center>';
|
||||
print_single_button($link, $options, $label, $method);
|
||||
echo '</center>';
|
||||
}
|
||||
print_simple_box_end();
|
||||
/// Close button if inpopup
|
||||
if ($inpopup) {
|
||||
close_window_button();
|
||||
}
|
||||
|
||||
print_footer();
|
||||
exit;
|
||||
}
|
||||
|
||||
/// Load serialized IMS CP index to memory only once.
|
||||
if (empty($items)) {
|
||||
$resourcedir = $CFG->dataroot.'/'.$course->id.'/'.$CFG->moddata.'/resource/'.$resource->id;
|
||||
if (!$items = ims_load_serialized_file($resourcedir.'/moodle_inx.ser')) {
|
||||
error (get_string('errorreadingfile', 'error', 'moodle_inx.ser'));
|
||||
}
|
||||
}
|
||||
|
||||
/// Check whether this is supposed to be a popup, but was called directly
|
||||
|
||||
if (empty($frameset) && $resource->popup && !$inpopup) { /// Make a page and a pop-up window
|
||||
|
||||
print_header($pagetitle, $course->fullname, "$this->navigation ".format_string($resource->name), "", "", true, update_module_button($cm->id, $course->id, $this->strresource), navmenu($course, $cm));
|
||||
|
||||
echo "\n<script language=\"javascript\" type=\"text/javascript\">";
|
||||
echo "\n<!--\n";
|
||||
echo "openpopup('/mod/resource/view.php?inpopup=true&id={$cm->id}','resource{$resource->id}','{$resource->popup}');\n";
|
||||
echo "\n-->\n";
|
||||
echo '</script>';
|
||||
|
||||
if (trim(strip_tags($resource->summary))) {
|
||||
$formatoptions->noclean = true;
|
||||
print_simple_box(format_text($resource->summary, FORMAT_MOODLE, $formatoptions), "center");
|
||||
}
|
||||
|
||||
$link = "<a href=\"$CFG->wwwroot/mod/resource/view.php?inpopup=true&id={$cm->id}\" target=\"resource{$resource->id}\" onclick=\"return openpopup('/mod/resource/view.php?inpopup=true&id={$cm->id}', 'resource{$resource->id}','{$resource->popup}');\">".format_string($resource->name,true)."</a>";
|
||||
|
||||
echo "<p> </p>";
|
||||
echo '<p align="center">';
|
||||
print_string('popupresource', 'resource');
|
||||
echo '<br />';
|
||||
print_string('popupresourcelink', 'resource', $link);
|
||||
echo "</p>";
|
||||
|
||||
print_footer($course);
|
||||
exit;
|
||||
}
|
||||
|
||||
|
||||
/// If we aren't in a frame, build it (the main one)
|
||||
|
||||
if (empty($frameset)) {
|
||||
|
||||
/// The frameset output starts
|
||||
|
||||
echo "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Frameset//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd\">\n";
|
||||
echo "<html dir=\"ltr\">\n";
|
||||
echo '<head>';
|
||||
echo '<meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />';
|
||||
echo "<title>{$course->shortname}: ".strip_tags(format_string($resource->name,true))."</title></head>\n";
|
||||
echo "<frameset rows=\"$CFG->resource_framesize,*\">"; //Main frameset
|
||||
echo "<frame src=\"view.php?id={$cm->id}&type={$resource->type}&frameset=top\" />"; //Top frame
|
||||
echo "<frame src=\"view.php?id={$cm->id}&type={$resource->type}&frameset=ims\" />"; //Ims frame
|
||||
echo "</frameset>";
|
||||
echo "</html>";
|
||||
/// We can only get here once per resource, so add an entry to the log
|
||||
add_to_log($course->id, "resource", "view", "view.php?id={$cm->id}", $resource->id, $cm->id);
|
||||
exit;
|
||||
}
|
||||
|
||||
/// If required we print the ims frameset
|
||||
|
||||
if ($frameset == 'ims') {
|
||||
|
||||
/// Calculate the file.php correct url
|
||||
if ($CFG->slasharguments) {
|
||||
$fileurl = "{$CFG->wwwroot}/file.php/{$course->id}/{$CFG->moddata}/resource/{$resource->id}";
|
||||
} else {
|
||||
$fileurl = "{$CFG->wwwroot}/file.php?file=/{$course->id}/{$CFG->moddata}/resource/{$resource->id}";
|
||||
}
|
||||
|
||||
/// Calculate the view.php correct url
|
||||
$viewurl = "view.php?id={$cm->id}&type={$resource->type}&frameset=toc&page=";
|
||||
|
||||
|
||||
/// Decide what to show (full toc, partial toc or package file)
|
||||
$fullurl = '';
|
||||
if (empty($page) && !empty($this->parameters->tableofcontents)) {
|
||||
/// Full toc contents
|
||||
$fullurl = $viewurl.$page;
|
||||
} else {
|
||||
if (empty($page)) {
|
||||
/// If no page and no toc, set page 1
|
||||
$page = 1;
|
||||
}
|
||||
if (empty($items[$page]->href)) {
|
||||
/// The page hasn't href, then partial toc contents
|
||||
$fullurl = $viewurl.$page;
|
||||
} else {
|
||||
/// The page has href, then its own file contents
|
||||
$fullurl = $fileurl.'/'.$items[$page]->href;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/// The frameset output starts
|
||||
|
||||
echo "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Frameset//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd\">\n";
|
||||
echo "<html dir=\"ltr\">\n";
|
||||
echo '<head>';
|
||||
echo '<meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />';
|
||||
echo "<title>{$course->shortname}: ".strip_tags(format_string($resource->name,true))."</title></head>\n";
|
||||
if (!empty($this->parameters->navigationbuttons)) {
|
||||
echo "<frameset rows=\"20,*\" border=\"0\">"; //Ims frameset with navigation buttons
|
||||
} else {
|
||||
echo "<frameset rows=\"*\">"; //Ims frameset without navigation buttons
|
||||
}
|
||||
if (!empty($this->parameters->navigationbuttons)) {
|
||||
echo "<frame src=\"view.php?id={$cm->id}&type={$resource->type}&page={$page}&frameset=nav\" scrolling=\"no\" noresize=\"noresize\" name=\"ims-nav\" />"; //Nav frame
|
||||
}
|
||||
echo "<frame src=\"{$fullurl}\" name=\"ims-content\" />"; //Content frame
|
||||
echo "</frameset>";
|
||||
echo "</html>";
|
||||
exit;
|
||||
}
|
||||
|
||||
/// If we are in the top frameset, just print it
|
||||
|
||||
if ($frameset == 'top') {
|
||||
|
||||
/// The header depends of the resource->popup
|
||||
if ($resource->popup) {
|
||||
print_header($pagetitle, $course->fullname.' : '.$resource->name);
|
||||
} else {
|
||||
print_header($pagetitle, $course->fullname, "$this->navigation ".format_string($resource->name), "", "", true, update_module_button($cm->id, $course->id, $this->strresource), navmenu($course, $cm, "parent"));
|
||||
}
|
||||
echo '</body></html>';
|
||||
exit;
|
||||
}
|
||||
|
||||
/// If we are in the toc frameset, calculate and show the toc autobuilt page
|
||||
|
||||
if ($frameset == 'toc') {
|
||||
print_header();
|
||||
$table = new stdClass;
|
||||
if (empty($page)) {
|
||||
$table->head[] = $resource->name.'</b></p>';
|
||||
} else {
|
||||
$table->head[] = $items[$page]->title.'</b></p>';
|
||||
}
|
||||
$table->data[] = array(ims_generate_toc ($items, $resource, $page));
|
||||
$table->width = '60%';
|
||||
print_table($table);
|
||||
print_footer();
|
||||
exit;
|
||||
}
|
||||
|
||||
/// If we are in the nav frameset, just print it
|
||||
|
||||
if ($frameset == 'nav') {
|
||||
/// Header
|
||||
print_header();
|
||||
echo '<div class="ims-nav-bar">';
|
||||
/// Prev button
|
||||
echo ims_get_prev_nav_button ($items, $this, $page);
|
||||
/// Up button
|
||||
echo ims_get_up_nav_button ($items, $this, $page);
|
||||
/// Next button
|
||||
echo ims_get_next_nav_button ($items, $this, $page);
|
||||
/// Main TOC button
|
||||
echo ims_get_toc_nav_button ($items, $this, $page);
|
||||
/// Footer
|
||||
echo '</div></div></div></body></html>';
|
||||
exit;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Setup a new file resource
|
||||
*
|
||||
* Display a form to create a new or edit an existing file resource
|
||||
*
|
||||
* @param form object
|
||||
* @param CFG global object
|
||||
* @param usehtmleditor global integer
|
||||
* @param RESOURCE_WINDOW_OPTIONS global array
|
||||
*/
|
||||
function setup($form) {
|
||||
global $CFG, $usehtmleditor, $RESOURCE_WINDOW_OPTIONS;
|
||||
|
||||
parent::setup($form);
|
||||
|
||||
$strfilename = get_string("location");
|
||||
$strnote = get_string("note", "resource");
|
||||
$strchooseafile = get_string("chooseafile", "resource");
|
||||
$strnewwindow = get_string("newwindow", "resource");
|
||||
$strnewwindowopen = get_string("newwindowopen", "resource");
|
||||
$strsearch = get_string("searchweb", "resource");
|
||||
|
||||
foreach ($RESOURCE_WINDOW_OPTIONS as $optionname) {
|
||||
$stringname = "str$optionname";
|
||||
$$stringname = get_string("new$optionname", "resource");
|
||||
$window->$optionname = "";
|
||||
$jsoption[] = "\"$optionname\"";
|
||||
}
|
||||
|
||||
$frameoption = "\"framepage\"";
|
||||
$popupoptions = implode(",", $jsoption);
|
||||
$jsoption[] = $frameoption;
|
||||
$alloptions = implode(",", $jsoption);
|
||||
|
||||
if ($form->instance) { // Re-editing
|
||||
if (!$form->popup) {
|
||||
$windowtype = "page"; // No popup text => in page
|
||||
foreach ($RESOURCE_WINDOW_OPTIONS as $optionname) {
|
||||
$defaultvalue = "resource_popup$optionname";
|
||||
$window->$optionname = $CFG->$defaultvalue;
|
||||
}
|
||||
} else {
|
||||
$windowtype = "popup";
|
||||
$rawoptions = explode(',', $form->popup);
|
||||
foreach ($rawoptions as $rawoption) {
|
||||
$option = explode('=', trim($rawoption));
|
||||
$optionname = $option[0];
|
||||
$optionvalue = $option[1];
|
||||
if ($optionname == 'height' or $optionname == 'width') {
|
||||
$window->$optionname = $optionvalue;
|
||||
} else if ($optionvalue) {
|
||||
$window->$optionname = 'checked="checked"';
|
||||
}
|
||||
}
|
||||
}
|
||||
} else {
|
||||
foreach ($RESOURCE_WINDOW_OPTIONS as $optionname) {
|
||||
$defaultvalue = "resource_popup$optionname";
|
||||
|
||||
if ($optionname == 'height' or $optionname == 'width') {
|
||||
$window->$optionname = $CFG->$defaultvalue;
|
||||
} else if ($CFG->$defaultvalue) {
|
||||
$window->$optionname = 'checked="checked"';
|
||||
}
|
||||
}
|
||||
|
||||
$windowtype = ($CFG->resource_popup) ? 'popup' : 'page';
|
||||
if (empty($form->options)) {
|
||||
$form->options = 'frame';
|
||||
$form->reference = $CFG->resource_defaulturl;
|
||||
}
|
||||
}
|
||||
if (empty($form->reference)) {
|
||||
$form->reference = $CFG->resource_defaulturl;
|
||||
}
|
||||
|
||||
//Converts the alltext to form fields
|
||||
$parameters=$this->alltext2parameters($form->alltext);
|
||||
$form->param_tableofcontents = $parameters->tableofcontents;
|
||||
$form->param_navigationbuttons = $parameters->navigationbuttons;
|
||||
|
||||
//Show the setup form
|
||||
include("$CFG->dirroot/mod/resource/type/ims/ims.html");
|
||||
|
||||
parent::setup_end();
|
||||
}
|
||||
|
||||
} //End class
|
||||
|
||||
///
|
||||
/// General purpose functions
|
||||
///
|
||||
/*** This function will serialize the variable passed and send it
|
||||
* to filesystem
|
||||
*/
|
||||
function ims_save_serialized_file($destination, $var) {
|
||||
$status = false;
|
||||
if ($ser = serialize($var)) {
|
||||
$status = ims_var2file($destination, $ser);
|
||||
}
|
||||
return $status;
|
||||
}
|
||||
|
||||
/*** This function will unserialize the variable stored
|
||||
* in filesystem
|
||||
*/
|
||||
function ims_load_serialized_file($file) {
|
||||
$status = false;
|
||||
if ($ser = ims_file2var($file)) {
|
||||
$status = unserialize($ser);
|
||||
}
|
||||
return $status;
|
||||
}
|
||||
|
||||
/*** This function will load all the contents of one file to one variable
|
||||
* Not suitable for BIG files
|
||||
*/
|
||||
function ims_file2var ($file) {
|
||||
$status = true;
|
||||
$var = '';
|
||||
$fp = fopen($file, 'r')
|
||||
or $status = false;
|
||||
if ($status) {
|
||||
while ($data = fread($fp, 4096)) {
|
||||
$var = $var.$data;
|
||||
}
|
||||
fclose($fp);
|
||||
}
|
||||
if (!$status) {
|
||||
$var = false;
|
||||
}
|
||||
return $var;
|
||||
}
|
||||
|
||||
/*** This file will write the contents of one variable to a file
|
||||
* Not suitable for BIG files
|
||||
*/
|
||||
function ims_var2file ($file, $var) {
|
||||
$status = false;
|
||||
if ($out = fopen($file,"w")) {
|
||||
$status = fwrite($out, $var);
|
||||
fclose($out);
|
||||
}
|
||||
return $status;
|
||||
}
|
||||
|
||||
/*** This function will generate the TOC file for the package
|
||||
* from an specified parent to be used in the view of the IMS
|
||||
*/
|
||||
function ims_generate_toc($items, $resource, $page=0) {
|
||||
global $CFG;
|
||||
|
||||
$contents = '';
|
||||
|
||||
/// Configure links behaviour
|
||||
$fullurl = $CFG->wwwroot.'/mod/resource/view.php?r='.$resource->id.'&frameset=ims&page=';
|
||||
|
||||
/// Iterate over items to build the menu
|
||||
$currlevel = 0;
|
||||
$currorder = 0;
|
||||
$endlevel = 0;
|
||||
foreach ($items as $item) {
|
||||
/// Skip pages until we arrive to $page
|
||||
if ($item->id < $page) {
|
||||
continue;
|
||||
}
|
||||
/// Arrive to page, we store its level
|
||||
if ($item->id == $page) {
|
||||
$endlevel = $item->level;
|
||||
continue;
|
||||
}
|
||||
/// We are after page and inside it (level > endlevel)
|
||||
if ($item->id > $page && $item->level > $endlevel) {
|
||||
/// Start Level
|
||||
if ($item->level > $currlevel) {
|
||||
$contents .= '<ol class="listlevel_'.$item->level.'">';
|
||||
}
|
||||
/// End Level
|
||||
if ($item->level < $currlevel) {
|
||||
$contents .= '</ol>';
|
||||
}
|
||||
/// Add item
|
||||
$contents .= '<li>';
|
||||
if (!empty($item->href)) {
|
||||
$contents .= '<a href="'.$fullurl.$item->id.'" target="_parent">'.$item->title.'</a>';
|
||||
} else {
|
||||
$contents .= $item->title;
|
||||
}
|
||||
$contents .= '</li>';
|
||||
$currlevel = $item->level;
|
||||
continue;
|
||||
}
|
||||
/// We have reached endlevel, exit
|
||||
if ($item->id > $page && $item->level <= $endlevel) {
|
||||
break;
|
||||
}
|
||||
}
|
||||
$contents .= '</ol>';
|
||||
|
||||
return $contents;
|
||||
}
|
||||
|
||||
/*** This function will return the correct html code needed
|
||||
* to show the previous button in the nav frame
|
||||
**/
|
||||
function ims_get_prev_nav_button ($items, $resource_obj, $page) {
|
||||
|
||||
$cm = $resource_obj->cm;
|
||||
$resource = $resource_obj->resource;
|
||||
|
||||
$contents = '';
|
||||
|
||||
if ($page > 1 ) { //0 and 1 pages haven't previous
|
||||
$page--;
|
||||
$contents .= "<span class=\"ims-nav-button\"><a href=\"view.php?id={$cm->id}&type={$resource->type}&page={$page}&frameset=ims\" target=\"_parent\"><<</a></span>";
|
||||
} else {
|
||||
$contents .= '<span class="ims-nav-dimmed"><<</span>';
|
||||
}
|
||||
|
||||
return $contents;
|
||||
}
|
||||
|
||||
/*** This function will return the correct html code needed
|
||||
* to show the next button in the nav frame
|
||||
**/
|
||||
function ims_get_next_nav_button ($items, $resource_obj, $page) {
|
||||
|
||||
$cm = $resource_obj->cm;
|
||||
$resource = $resource_obj->resource;
|
||||
|
||||
$contents = '';
|
||||
|
||||
if (!empty($items[$page+1])) { //If the next page exists
|
||||
$page++;
|
||||
$contents .= "<span class=\"ims-nav-button\"><a href=\"view.php?id={$cm->id}&type={$resource->type}&page={$page}&frameset=ims\" target=\"_parent\">>></a></span>";
|
||||
} else {
|
||||
$contents .= '<span class="ims-nav-dimmed">>></span>';
|
||||
}
|
||||
|
||||
|
||||
return $contents;
|
||||
}
|
||||
|
||||
/*** This function will return the correct html code needed
|
||||
* to show the up button in the nav frame
|
||||
**/
|
||||
function ims_get_up_nav_button ($items, $resource_obj, $page) {
|
||||
|
||||
$cm = $resource_obj->cm;
|
||||
$resource = $resource_obj->resource;
|
||||
|
||||
$contents = '';
|
||||
|
||||
if ($page > 1 && $items[$page]->parent > 0 ) { //If the page has parent
|
||||
$page = $items[$page]->parent;
|
||||
$contents .= "<span class=\"ims-nav-button\"><a href=\"view.php?id={$cm->id}&type={$resource->type}&page={$page}&frameset=ims\" target=\"_parent\">∧</a></span>";
|
||||
} else {
|
||||
$contents .= '<span class="ims-nav-dimmed">∧</span>';
|
||||
}
|
||||
|
||||
return $contents;
|
||||
}
|
||||
|
||||
/*** This function will return the correct html code needed
|
||||
* to show the toc button in the nav frame
|
||||
**/
|
||||
function ims_get_toc_nav_button ($items, $resource_obj, $page) {
|
||||
|
||||
$cm = $resource_obj->cm;
|
||||
$resource = $resource_obj->resource;
|
||||
|
||||
$strtoc = get_string('toc', 'resource');
|
||||
|
||||
$contents = '';
|
||||
|
||||
if (!empty($resource_obj->parameters->tableofcontents)) { //The toc is enabled
|
||||
$page = 0;
|
||||
$contents .= "<span class=\"ims-nav-button\"><a href=\"view.php?id={$cm->id}&type={$resource->type}&page={$page}&frameset=ims\" target=\"_parent\">TOC</a></span>";
|
||||
}
|
||||
|
||||
return $contents;
|
||||
}
|
||||
|
||||
?>
|
||||
Reference in New Issue
Block a user