resource_hide_repository)) {
set_config("resource_hide_repository", "1");
}
/**
* resource_base is the base class for resource types
*
* This class provides all the functionality for a resource
*/
class resource_base {
var $cm;
var $course;
var $resource;
var $navlinks;
/**
* Constructor for the base resource class
*
* Constructor for the base resource class.
* If cmid is set create the cm, course, resource objects.
* and do some checks to make sure people can be here, and so on.
*
* @param cmid integer, the current course module id - not set for new resources
*/
function resource_base($cmid=0) {
global $CFG, $COURSE;
$this->navlinks = array();
if ($cmid) {
if (! $this->cm = get_coursemodule_from_id('resource', $cmid)) {
error("Course Module ID was incorrect");
}
if (! $this->course = get_record("course", "id", $this->cm->course)) {
error("Course is misconfigured");
}
if (! $this->resource = get_record("resource", "id", $this->cm->instance)) {
error("Resource ID was incorrect");
}
$this->strresource = get_string("modulename", "resource");
$this->strresources = get_string("modulenameplural", "resource");
if (!$this->cm->visible and !has_capability('moodle/course:viewhiddenactivities', get_context_instance(CONTEXT_MODULE, $this->cm->id))) {
$pagetitle = strip_tags($this->course->shortname.': '.$this->strresource);
$navigation = build_navigation($this->navlinks, $this->cm);
print_header($pagetitle, $this->course->fullname, $navigation, "", "", true, '', navmenu($this->course, $this->cm));
notice(get_string("activityiscurrentlyhidden"), "$CFG->wwwroot/course/view.php?id={$this->course->id}");
}
} else {
$this->course = $COURSE;
}
}
/**
* Display function does nothing in the base class
*/
function display() {
}
/**
* Display the resource with the course blocks.
*/
function display_course_blocks_start() {
global $CFG;
global $USER;
global $THEME;
require_once($CFG->libdir.'/blocklib.php');
require_once($CFG->libdir.'/pagelib.php');
require_once($CFG->dirroot.'/course/lib.php'); //required by some blocks
$PAGE = page_create_object(PAGE_COURSE_VIEW, $this->course->id);
$this->PAGE = $PAGE;
$pageblocks = blocks_setup($PAGE);
$blocks_preferred_width = bounded_number(180, blocks_preferred_width($pageblocks[BLOCK_POS_LEFT]), 210);
/// Print the page header
$edit = optional_param('edit', -1, PARAM_BOOL);
if (($edit != -1) and $PAGE->user_allowed_editing()) {
$USER->editing = $edit;
}
$morenavlinks = array($this->strresources => 'index.php?id='.$this->course->id,
$this->resource->name => '');
$PAGE->print_header($this->course->shortname.': %fullname%', $morenavlinks, "", "",
update_module_button($this->cm->id, $this->course->id, $this->strresource));
echo '
';
$lt = (empty($THEME->layouttable)) ? array('left', 'middle', 'right') : $THEME->layouttable;
foreach ($lt as $column) {
$lt1[] = $column;
if ($column == 'middle') break;
}
foreach ($lt1 as $column) {
switch ($column) {
case 'left':
if((blocks_have_content($pageblocks, BLOCK_POS_LEFT) || $PAGE->user_is_editing())) {
echo '';
print_container_start();
blocks_print_group($PAGE, $pageblocks, BLOCK_POS_LEFT);
print_container_end();
echo ' | ';
}
break;
case 'middle':
echo '';
print_container_start(false, 'middle-column-wrap');
echo ' ';
break;
case 'right':
if((blocks_have_content($pageblocks, BLOCK_POS_RIGHT) || $PAGE->user_is_editing())) {
echo ' | ';
print_container_start();
blocks_print_group($PAGE, $pageblocks, BLOCK_POS_RIGHT);
print_container_end();
echo ' | ';
}
break;
}
}
}
/**
* Finish displaying the resource with the course blocks
*/
function display_course_blocks_end() {
global $CFG;
global $THEME;
$PAGE = $this->PAGE;
$pageblocks = blocks_setup($PAGE);
$blocks_preferred_width = bounded_number(180, blocks_preferred_width($pageblocks[BLOCK_POS_RIGHT]), 210);
$lt = (empty($THEME->layouttable)) ? array('left', 'middle', 'right') : $THEME->layouttable;
foreach ($lt as $column) {
if ($column != 'middle') {
array_shift($lt);
} else if ($column == 'middle') {
break;
}
}
foreach ($lt as $column) {
switch ($column) {
case 'left':
if((blocks_have_content($pageblocks, BLOCK_POS_LEFT) || $PAGE->user_is_editing())) {
echo '';
print_container_start();
blocks_print_group($PAGE, $pageblocks, BLOCK_POS_LEFT);
print_container_end();
echo ' | ';
}
break;
case 'middle':
echo '';
print_container_end();
echo '';
break;
case 'right':
if((blocks_have_content($pageblocks, BLOCK_POS_RIGHT) || $PAGE->user_is_editing())) {
echo '';
print_container_start();
blocks_print_group($PAGE, $pageblocks, BLOCK_POS_RIGHT);
print_container_end();
echo ' | ';
}
break;
}
}
echo '
';
print_footer($this->course);
}
function add_instance($resource) {
// Given an object containing all the necessary data,
// (defined by the form in mod.html) this function
// will create a new instance and return the id number
// of the new instance.
$resource->timemodified = time();
return insert_record("resource", $resource);
}
function update_instance($resource) {
// Given an object containing all the necessary data,
// (defined by the form in mod.html) this function
// will update an existing instance with new data.
$resource->id = $resource->instance;
$resource->timemodified = time();
return update_record("resource", $resource);
}
function delete_instance($resource) {
// Given an object containing the resource data
// this function will permanently delete the instance
// and any data that depends on it.
$result = true;
if (! delete_records("resource", "id", "$resource->id")) {
$result = false;
}
return $result;
}
function setup_elements(&$mform) {
//override to add your own options
}
function setup_preprocessing(&$default_values){
//override to add your own options
}
} /// end of class definition
function resource_add_instance($resource) {
global $CFG;
$resource->type = clean_param($resource->type, PARAM_SAFEDIR); // Just to be safe
require_once("$CFG->dirroot/mod/resource/type/$resource->type/resource.class.php");
$resourceclass = "resource_$resource->type";
$res = new $resourceclass();
return $res->add_instance($resource);
}
function resource_update_instance($resource) {
global $CFG;
$resource->type = clean_param($resource->type, PARAM_SAFEDIR); // Just to be safe
require_once("$CFG->dirroot/mod/resource/type/$resource->type/resource.class.php");
$resourceclass = "resource_$resource->type";
$res = new $resourceclass();
return $res->update_instance($resource);
}
function resource_delete_instance($id) {
global $CFG;
if (! $resource = get_record("resource", "id", "$id")) {
return false;
}
$resource->type = clean_param($resource->type, PARAM_SAFEDIR); // Just to be safe
require_once("$CFG->dirroot/mod/resource/type/$resource->type/resource.class.php");
$resourceclass = "resource_$resource->type";
$res = new $resourceclass();
return $res->delete_instance($resource);
}
function resource_user_outline($course, $user, $mod, $resource) {
if ($logs = get_records_select("log", "userid='$user->id' AND module='resource'
AND action='view' AND info='$resource->id'", "time ASC")) {
$numviews = count($logs);
$lastlog = array_pop($logs);
$result = new object();
$result->info = get_string("numviews", "", $numviews);
$result->time = $lastlog->time;
return $result;
}
return NULL;
}
function resource_user_complete($course, $user, $mod, $resource) {
global $CFG;
if ($logs = get_records_select("log", "userid='$user->id' AND module='resource'
AND action='view' AND info='$resource->id'", "time ASC")) {
$numviews = count($logs);
$lastlog = array_pop($logs);
$strmostrecently = get_string("mostrecently");
$strnumviews = get_string("numviews", "", $numviews);
echo "$strnumviews - $strmostrecently ".userdate($lastlog->time);
} else {
print_string("neverseen", "resource");
}
}
function resource_get_participants($resourceid) {
//Returns the users with data in one resource
//(NONE, byt must exists on EVERY mod !!)
return false;
}
function resource_get_coursemodule_info($coursemodule) {
/// Given a course_module object, this function returns any
/// "extra" information that may be needed when printing
/// this activity in a course listing.
///
/// See get_array_of_activities() in course/lib.php
///
global $CFG;
$info = NULL;
if ($resource = get_record("resource", "id", $coursemodule->instance, '', '', '', '', 'id, popup, reference, type, name')) {
$info = new object();
$info->name = $resource->name;
if (!empty($resource->popup)) {
$info->extra = urlencode("onclick=\"this.target='resource$resource->id'; return ".
"openpopup('/mod/resource/view.php?inpopup=true&id=".
$coursemodule->id.
"','resource$resource->id','$resource->popup');\"");
}
require_once($CFG->libdir.'/filelib.php');
if ($resource->type == 'file') {
$icon = mimeinfo("icon", $resource->reference);
if ($icon != 'unknown.gif') {
$info->icon ="f/$icon";
} else {
$info->icon ="f/web.gif";
}
} else if ($resource->type == 'directory') {
$info->icon ="f/folder.gif";
}
}
return $info;
}
function resource_fetch_remote_file ($cm, $url, $headers = "" ) {
/// Snoopy is an HTTP client in PHP
global $CFG;
require_once("$CFG->libdir/snoopy/Snoopy.class.inc");
$client = new Snoopy();
$ua = 'Moodle/'. $CFG->release . ' (+http://moodle.org';
if ( $CFG->resource_usecache ) {
$ua = $ua . ')';
} else {
$ua = $ua . '; No cache)';
}
$client->agent = $ua;
$client->read_timeout = 5;
$client->use_gzip = true;
if (is_array($headers) ) {
$client->rawheaders = $headers;
}
@$client->fetch($url);
if ( $client->status >= 200 && $client->status < 300 ) {
$tags = array("A" => "href=",
"IMG" => "src=",
"LINK" => "href=",
"AREA" => "href=",
"FRAME" => "src=",
"IFRAME" => "src=",
"FORM" => "action=");
foreach ($tags as $tag => $key) {
$prefix = "fetch.php?id=$cm->id&url=";
if ( $tag == "IMG" or $tag == "LINK" or $tag == "FORM") {
$prefix = "";
}
$client->results = resource_redirect_tags($client->results, $url, $tag, $key,$prefix);
}
} else {
if ( $client->status >= 400 && $client->status < 500) {
$client->results = get_string("fetchclienterror","resource"); // Client error
} elseif ( $client->status >= 500 && $client->status < 600) {
$client->results = get_string("fetchservererror","resource"); // Server error
} else {
$client->results = get_string("fetcherror","resource"); // Redirection? HEAD? Unknown error.
}
}
return $client;
}
function resource_redirect_tags($text, $url, $tagtoparse, $keytoparse,$prefix = "" ) {
$valid = 1;
if ( strpos($url,"?") == FALSE ) {
$valid = 1;
}
if ( $valid ) {
$lastpoint = strrpos($url,".");
$lastslash = strrpos($url,"/");
if ( $lastpoint > $lastslash ) {
$root = substr($url,0,$lastslash+1);
} else {
$root = $url;
}
if ( $root == "http://" or
$root == "https://") {
$root = $url;
}
if ( substr($root,strlen($root)-1) == '/' ) {
$root = substr($root,0,-1);
}
$mainroot = $root;
$lastslash = strrpos($mainroot,"/");
while ( $lastslash > 9) {
$mainroot = substr($mainroot,0,$lastslash);
$lastslash = strrpos($mainroot,"/");
}
$regex = "/<$tagtoparse (.+?)>/is";
$count = preg_match_all($regex, $text, $hrefs);
for ( $i = 0; $i < $count; $i++) {
$tag = $hrefs[1][$i];
$poshref = strpos(strtolower($tag),strtolower($keytoparse));
$start = $poshref + strlen($keytoparse);
$left = substr($tag,0,$start);
if ( $tag[$start] == '"' ) {
$left .= '"';
$start++;
}
$posspace = strpos($tag," ", $start+1);
$right = "";
if ( $posspace != FALSE) {
$right = substr($tag, $posspace);
}
$end = strlen($tag)-1;
if ( $tag[$end] == '"' ) {
$right = '"' . $right;
}
$finalurl = substr($tag,$start,$end-$start+$diff);
// Here, we could have these possible values for $finalurl:
// file.ext Add current root dir
// http://(domain) don't care
// http://(domain)/ don't care
// http://(domain)/folder don't care
// http://(domain)/folder/ don't care
// http://(domain)/folder/file.ext don't care
// folder/ Add current root dir
// folder/file.ext Add current root dir
// /folder/ Add main root dir
// /folder/file.ext Add main root dir
// Special case: If finalurl contains a ?, it won't be parsed
$valid = 1;
if ( strpos($finalurl,"?") == FALSE ) {
$valid = 1;
}
if ( $valid ) {
if ( $finalurl[0] == "/" ) {
$finalurl = $mainroot . $finalurl;
} elseif ( strtolower(substr($finalurl,0,7)) != "http://" and
strtolower(substr($finalurl,0,8)) != "https://") {
if ( $finalurl[0] == "/") {
$finalurl = $mainroot . $finalurl;
} else {
$finalurl = "$root/$finalurl";
}
}
$text = str_replace($tag,"$left$prefix$finalurl$right",$text);
}
}
}
return $text;
}
function resource_is_url($path) {
if (strpos($path, '://')) { // eg http:// https:// ftp:// etc
return true;
}
if (strpos($path, '/') === 0) { // Starts with slash
return true;
}
return false;
}
function resource_get_types() {
global $CFG;
$types = array();
$standardresources = array('text','html','file','directory');
foreach ($standardresources as $resourcetype) {
$type = new object();
$type->modclass = MOD_CLASS_RESOURCE;
$type->name = $resourcetype;
$type->type = "resource&type=$resourcetype";
$type->typestr = resource_get_name($resourcetype);
$types[] = $type;
}
/// Drop-in extra resource types
$resourcetypes = get_list_of_plugins('mod/resource/type');
foreach ($resourcetypes as $resourcetype) {
if (!empty($CFG->{'resource_hide_'.$resourcetype})) { // Not wanted
continue;
}
if (!in_array($resourcetype, $standardresources)) {
$type = new object();
$type->modclass = MOD_CLASS_RESOURCE;
$type->name = $resourcetype;
$type->type = "resource&type=$resourcetype";
$type->typestr = resource_get_name($resourcetype);
$types[] = $type;
}
}
return $types;
}
function resource_get_view_actions() {
return array('view','view all');
}
function resource_get_post_actions() {
return array();
}
function resource_renamefiles($course, $wdir, $oldname, $name) {
global $CFG;
$status = ''.get_string('affectedresources', 'resource').':
';
$updates = false;
$old = trim($wdir.'/'.$oldname, '/');
$new = trim($wdir.'/'.$name, '/');
$sql = "SELECT r.id, r.reference, r.name, cm.id AS cmid
FROM {$CFG->prefix}resource r,
{$CFG->prefix}course_modules cm,
{$CFG->prefix}modules m
WHERE r.course = '{$course->id}'
AND m.name = 'resource'
AND cm.module = m.id
AND cm.instance = r.id
AND (r.type = 'file' OR r.type = 'directory')
AND (r.reference LIKE '{$old}/%' OR r.reference = '{$old}')";
if ($resources = get_records_sql($sql)) {
foreach ($resources as $resource) {
$r = new object();
$r->id = $resource->id;
$r->reference = '';
if ($resource->reference == $old) {
$r->reference = addslashes($new);
} else {
$r->reference = addslashes(preg_replace('|^'.preg_quote($old, '|').'/|', $new.'/', $resource->reference));
}
if ($r->reference !== '') {
$updates = true;
$status .= "- wwwroot/mod/resource/view.php?id=$resource->cmid\" target=\"_blank\">$resource->name: $resource->reference ==> $r->reference
";
if (!empty($CFG->resource_autofilerename)) {
if (!update_record('resource', $r)) {
error("Error updating resource with ID $r->id.");
}
}
}
}
}
$status .= '
';
if ($updates) {
echo $status;
if (empty($CFG->resource_autofilerename)) {
notify(get_string('warningdisabledrename', 'resource'));
}
}
}
function resource_delete_warning($course, $files) {
global $CFG;
$found = array();
foreach($files as $key=>$file) {
$files[$key] = trim($file, '/');
}
$sql = "SELECT r.id, r.reference, r.name, cm.id AS cmid
FROM {$CFG->prefix}resource r,
{$CFG->prefix}course_modules cm,
{$CFG->prefix}modules m
WHERE r.course = '{$course->id}'
AND m.name = 'resource'
AND cm.module = m.id
AND cm.instance = r.id
AND (r.type = 'file' OR r.type = 'directory')";
if ($resources = get_records_sql($sql)) {
foreach ($resources as $resource) {
if ($resource->reference == '') {
continue; // top shared directory does not prevent anything
}
if (in_array($resource->reference, $files)) {
$found[$resource->id] = $resource;
} else {
foreach($files as $file) {
if (preg_match('|^'.preg_quote($file, '|').'/|', $resource->reference)) {
$found[$resource->id] = $resource;
}
}
}
}
}
if (!empty($found)) {
print_simple_box_start("center");
echo ''.get_string('affectedresources', 'resource').':
';
print_simple_box_end();
return true;
} else {
return false;
}
}
/**
* This function is used by the reset_course_userdata function in moodlelib.
* @param $data the data submitted from the reset course.
* @return array status array
*/
function resource_reset_userdata($data) {
return array();
}
/**
* Returns all other caps used in module
*/
function resource_get_extra_capabilities() {
return array('moodle/site:accessallgroups');
}
/**
* Returns the full name of the given resource type. The name can
* either be set at the resource type level or at the resource module
* level.
*
* @param string $type shortname (or directory name) of the resource type
*/
function resource_get_name($type) {
$name = get_string("resourcetype$type", "resource_$type");
if (substr($name, 0, 2) === '[[') {
$name = get_string("resourcetype$type", 'resource');
}
return $name;
}
/**
* Tells if files in moddata are trusted and can be served without XSS protection.
* @return bool true if file can be submitted by teacher only (trusted), false otherwise
*/
function resource_is_moddata_trusted() {
return true;
}
?>