[moodle.git] / mod / resource / lib.php

<?PHP  // $Id$

define("REFERENCE",   "1");
define("WEBPAGE",     "2");
define("UPLOADEDFILE","3");
define("PLAINTEXT",   "4");
define("WEBLINK",     "5");
define("HTML",        "6");
define("PROGRAM",     "7");
define("WIKITEXT",    "8");

$RESOURCE_TYPE = array (REFERENCE    => get_string("resourcetype1", "resource"),
                        WEBPAGE      => get_string("resourcetype2", "resource"),
                        UPLOADEDFILE => get_string("resourcetype3", "resource"),
                        PLAINTEXT    => get_string("resourcetype4", "resource"),
                        WEBLINK      => get_string("resourcetype5", "resource"),
                        HTML         => get_string("resourcetype6", "resource"),
                        PROGRAM      => get_string("resourcetype7", "resource"),
                        WIKITEXT     => get_string("resourcetype8", "resource") );

if (!isset($CFG->resource_framesize)) {
    set_config("resource_framesize", 130);
} 

if (!isset($CFG->resource_websearch)) {
    set_config("resource_websearch", "http://google.com/");
} 

if (!isset($CFG->resource_defaulturl)) {
    set_config("resource_defaulturl", "http://");
}  

if (!isset($CFG->resource_filterexternalpages)) {
    set_config("resource_filterexternalpages", false);
}  

$RESOURCE_WINDOW_OPTIONS = array("resizable", "scrollbars", "directories", "location", 
                                 "menubar", "toolbar", "status", "height", "width");

if (!isset($CFG->resource_popup)) {
    set_config("resource_popup", "");
}  

foreach ($RESOURCE_WINDOW_OPTIONS as $popupoption) {
    $popupoption = "resource_popup$popupoption";
    if (!isset($CFG->$popupoption)) {
        if ($popupoption == "resource_popupheight") {
            set_config($popupoption, 450);
        } else if ($popupoption == "resource_popupwidth") {
            set_config($popupoption, 620);
        } else {
            set_config($popupoption, "checked");
        }
    }  
}

function resource_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.

    global $RESOURCE_WINDOW_OPTIONS;

    $resource->timemodified = time();

    if (isset($resource->setnewwindow)) {
        $optionlist = array();
        foreach ($RESOURCE_WINDOW_OPTIONS as $option) {
            if (isset($resource->$option)) {
                $optionlist[] = $option."=".$resource->$option;
            }
        }
        $resource->alltext = implode(',', $optionlist);
    }

    return insert_record("resource", $resource);
}


function resource_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.

    global $RESOURCE_WINDOW_OPTIONS;

    $resource->id = $resource->instance;
    $resource->timemodified = time();

    if (isset($resource->setnewwindow)) {
        $optionlist = array();
        foreach ($RESOURCE_WINDOW_OPTIONS as $option) {
            if (isset($resource->$option)) {
                $optionlist[] = $option."=".$resource->$option;
            }
        }
        $resource->alltext = implode(',', $optionlist);
    }

    return update_record("resource", $resource);
}


function resource_delete_instance($id) {
// Given an ID of an instance of this module, 
// this function will permanently delete the instance 
// and any data that depends on it.  

    if (! $resource = get_record("resource", "id", "$id")) {
        return false;
    }

    $result = true;

    if (! delete_records("resource", "id", "$resource->id")) {
        $result = false;
    }

    return $result;
}


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->info = get_string("numviews", "", $numviews);
        $result->time = $lastlog->time;

        return $result;
    }
    return NULL;
}


function resource_user_complete($course, $user, $mod, $resource) {
    global $CFG, $THEME;

    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
///

   if ($resource = get_record("resource", "id", $coursemodule->instance)) {
       if (($resource->type == UPLOADEDFILE or $resource->type == WEBLINK) and !empty($resource->alltext)) {
           return urlencode("target=\"resource$resource->id\" onClick=\"return ".
                            "openpopup('/mod/resource/view.php?inpopup=true&id=".
                            $coursemodule->id.
                            "','resource$resource->id','$resource->alltext');\"");
       }
   }

   return false;
}
 
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;
}

?>
Commit	Line	Data
2a439ba7	1	<?PHP // $Id$
	2
	3	define("REFERENCE", "1");
	4	define("WEBPAGE", "2");
	5	define("UPLOADEDFILE","3");
	6	define("PLAINTEXT", "4");
	7	define("WEBLINK", "5");
	8	define("HTML", "6");
f7a5c8fa	9	define("PROGRAM", "7");
3e9ca9fb	10	define("WIKITEXT", "8");
2a439ba7	11
	12	$RESOURCE_TYPE = array (REFERENCE => get_string("resourcetype1", "resource"),
	13	WEBPAGE => get_string("resourcetype2", "resource"),
	14	UPLOADEDFILE => get_string("resourcetype3", "resource"),
	15	PLAINTEXT => get_string("resourcetype4", "resource"),
	16	WEBLINK => get_string("resourcetype5", "resource"),
f7a5c8fa	17	HTML => get_string("resourcetype6", "resource"),
3e9ca9fb	18	PROGRAM => get_string("resourcetype7", "resource"),
3e9ca9fb	19	WIKITEXT => get_string("resourcetype8", "resource") );
2a439ba7	20
5925d0ef	21	if (!isset($CFG->resource_framesize)) {
	22	set_config("resource_framesize", 130);
	23	}
92a419a2	24
66c25030	25	if (!isset($CFG->resource_websearch)) {
	26	set_config("resource_websearch", "http://google.com/");
	27	}
	28
5e91dd3f	29	if (!isset($CFG->resource_defaulturl)) {
5e91dd3f	30	set_config("resource_defaulturl", "http://");
3bfe3922	31	}
	32
	33	if (!isset($CFG->resource_filterexternalpages)) {
	34	set_config("resource_filterexternalpages", false);
	35	}
5e91dd3f	36
86aa7ccf	37	$RESOURCE_WINDOW_OPTIONS = array("resizable", "scrollbars", "directories", "location",
86aa7ccf	38	"menubar", "toolbar", "status", "height", "width");
92a419a2	39
83891eda	40	if (!isset($CFG->resource_popup)) {
	41	set_config("resource_popup", "");
	42	}
	43
	44	foreach ($RESOURCE_WINDOW_OPTIONS as $popupoption) {
	45	$popupoption = "resource_popup$popupoption";
	46	if (!isset($CFG->$popupoption)) {
	47	if ($popupoption == "resource_popupheight") {
	48	set_config($popupoption, 450);
	49	} else if ($popupoption == "resource_popupwidth") {
	50	set_config($popupoption, 620);
	51	} else {
	52	set_config($popupoption, "checked");
	53	}
	54	}
	55	}
	56
cccb016a	57	function resource_add_instance($resource) {
	58	// Given an object containing all the necessary data,
	59	// (defined by the form in mod.html) this function
	60	// will create a new instance and return the id number
	61	// of the new instance.
2a439ba7	62
86aa7ccf	63	global $RESOURCE_WINDOW_OPTIONS;
86aa7ccf	64
cccb016a	65	$resource->timemodified = time();
2a439ba7	66
86aa7ccf	67	if (isset($resource->setnewwindow)) {
	68	$optionlist = array();
	69	foreach ($RESOURCE_WINDOW_OPTIONS as $option) {
	70	if (isset($resource->$option)) {
	71	$optionlist[] = $option."=".$resource->$option;
	72	}
	73	}
	74	$resource->alltext = implode(',', $optionlist);
	75	}
	76
cccb016a	77	return insert_record("resource", $resource);
cccb016a	78	}
2a439ba7	79
cccb016a	80
	81	function resource_update_instance($resource) {
	82	// Given an object containing all the necessary data,
	83	// (defined by the form in mod.html) this function
	84	// will update an existing instance with new data.
	85
86aa7ccf	86	global $RESOURCE_WINDOW_OPTIONS;
86aa7ccf	87
cccb016a	88	$resource->id = $resource->instance;
	89	$resource->timemodified = time();
	90
86aa7ccf	91	if (isset($resource->setnewwindow)) {
	92	$optionlist = array();
	93	foreach ($RESOURCE_WINDOW_OPTIONS as $option) {
	94	if (isset($resource->$option)) {
	95	$optionlist[] = $option."=".$resource->$option;
	96	}
	97	}
	98	$resource->alltext = implode(',', $optionlist);
	99	}
	100
cccb016a	101	return update_record("resource", $resource);
	102	}
	103
	104
	105	function resource_delete_instance($id) {
	106	// Given an ID of an instance of this module,
	107	// this function will permanently delete the instance
	108	// and any data that depends on it.
	109
	110	if (! $resource = get_record("resource", "id", "$id")) {
	111	return false;
2a439ba7	112	}
2a439ba7	113
cccb016a	114	$result = true;
	115
	116	if (! delete_records("resource", "id", "$resource->id")) {
	117	$result = false;
2a439ba7	118	}
2a439ba7	119
cccb016a	120	return $result;
2a439ba7	121	}
cccb016a	122
2a439ba7	123
2a439ba7	124	function resource_user_outline($course, $user, $mod, $resource) {
ebc3bd2b	125	if ($logs = get_records_select("log", "userid='$user->id' AND module='resource'
ebc3bd2b	126	AND action='view' AND info='$resource->id'", "time ASC")) {
2a439ba7	127
	128	$numviews = count($logs);
	129	$lastlog = array_pop($logs);
	130
	131	$result->info = get_string("numviews", "", $numviews);
	132	$result->time = $lastlog->time;
	133
	134	return $result;
	135	}
	136	return NULL;
	137	}
	138
	139
	140	function resource_user_complete($course, $user, $mod, $resource) {
	141	global $CFG, $THEME;
	142
ebc3bd2b	143	if ($logs = get_records_select("log", "userid='$user->id' AND module='resource'
ebc3bd2b	144	AND action='view' AND info='$resource->id'", "time ASC")) {
2a439ba7	145	$numviews = count($logs);
	146	$lastlog = array_pop($logs);
	147
	148	$strmostrecently = get_string("mostrecently");
	149	$strnumviews = get_string("numviews", "", $numviews);
	150
	151	echo "$strnumviews - $strmostrecently ".userdate($lastlog->time);
	152
	153	} else {
4282d7dd	154	print_string("neverseen", "resource");
2a439ba7	155	}
	156	}
	157
84caf038	158	function resource_get_participants($resourceid) {
	159	//Returns the users with data in one resource
	160	//(NONE, byt must exists on EVERY mod !!)
	161
	162	return false;
	163	}
2a439ba7	164
8dddba42	165	function resource_get_coursemodule_info($coursemodule) {
	166	/// Given a course_module object, this function returns any
	167	/// "extra" information that may be needed when printing
	168	/// this activity in a course listing.
	169	///
	170	/// See get_array_of_activities() in course/lib.php
	171	///
	172
	173	if ($resource = get_record("resource", "id", $coursemodule->instance)) {
	174	if (($resource->type == UPLOADEDFILE or $resource->type == WEBLINK) and !empty($resource->alltext)) {
	175	return urlencode("target=\"resource$resource->id\" onClick=\"return ".
	176	"openpopup('/mod/resource/view.php?inpopup=true&id=".
	177	$coursemodule->id.
	178	"','resource$resource->id','$resource->alltext');\"");
	179	}
	180	}
	181
	182	return false;
	183	}
af65e103	184
8367faba	185	function resource_fetch_remote_file ($cm, $url, $headers = "" ) {
3bfe3922	186	/// Snoopy is an HTTP client in PHP
	187
	188	global $CFG;
	189
	190	require_once("$CFG->libdir/snoopy/Snoopy.class.inc");
	191
b2b8471e	192	$client = new Snoopy();
bf46cd22	193	$ua = 'Moodle/'. $CFG->release . ' (+http://moodle.org';
	194	if ( $CFG->resource_usecache ) {
	195	$ua = $ua . ')';
	196	} else {
	197	$ua = $ua . '; No cache)';
	198	}
	199	$client->agent = $ua;
	200	$client->read_timeout = 5;
	201	$client->use_gzip = true;
b2b8471e	202	if (is_array($headers) ) {
	203	$client->rawheaders = $headers;
	204	}
	205
	206	@$client->fetch($url);
bf46cd22	207	if ( $client->status >= 200 && $client->status < 300 ) {
	208	$tags = array("A" => "href=",
	209	"IMG" => "src=",
	210	"LINK" => "href=",
	211	"AREA" => "href=",
	212	"FRAME" => "src=",
	213	"IFRAME" => "src=",
	214	"FORM" => "action=");
af65e103	215
bf46cd22	216	foreach ($tags as $tag => $key) {
	217	$prefix = "fetch.php?id=$cm->id&url=";
	218	if ( $tag == "IMG" or $tag == "LINK" or $tag == "FORM") {
	219	$prefix = "";
	220	}
	221	$client->results = resource_redirect_tags($client->results, $url, $tag, $key,$prefix);
	222	}
	223	} else {
	224	if ( $client->status >= 400 && $client->status < 500) {
	225	$client->results = get_string("fetchclienterror","resource"); // Client error
	226	} elseif ( $client->status >= 500 && $client->status < 600) {
	227	$client->results = get_string("fetchservererror","resource"); // Server error
	228	} else {
	229	$client->results = get_string("fetcherror","resource"); // Redirection? HEAD? Unknown error.
af65e103	230	}
af65e103	231	}
b2b8471e	232	return $client;
af65e103	233	}
	234
	235	function resource_redirect_tags($text, $url, $tagtoparse, $keytoparse,$prefix = "" ) {
bf46cd22	236	$valid = 1;
af65e103	237	if ( strpos($url,"?") == FALSE ) {
	238	$valid = 1;
	239	}
	240	if ( $valid ) {
	241	$lastpoint = strrpos($url,".");
	242	$lastslash = strrpos($url,"/");
	243	if ( $lastpoint > $lastslash ) {
	244	$root = substr($url,0,$lastslash+1);
	245	} else {
	246	$root = $url;
	247	}
	248	if ( $root == "http://" or
	249	$root == "https://") {
	250	$root = $url;
	251	}
	252	if ( substr($root,strlen($root)-1) == '/' ) {
	253	$root = substr($root,0,-1);
	254	}
	255
	256	$mainroot = $root;
	257	$lastslash = strrpos($mainroot,"/");
	258	while ( $lastslash > 9) {
	259	$mainroot = substr($mainroot,0,$lastslash);
	260
	261	$lastslash = strrpos($mainroot,"/");
	262	}
8dddba42	263
af65e103	264	$regex = "/<$tagtoparse (.+?)>/is";
	265	$count = preg_match_all($regex, $text, $hrefs);
	266	for ( $i = 0; $i < $count; $i++) {
	267	$tag = $hrefs[1][$i];
	268
	269	$poshref = strpos(strtolower($tag),strtolower($keytoparse));
	270	$start = $poshref + strlen($keytoparse);
	271	$left = substr($tag,0,$start);
	272	if ( $tag[$start] == '"' ) {
	273	$left .= '"';
	274	$start++;
	275	}
	276	$posspace = strpos($tag," ", $start+1);
	277	$right = "";
	278	if ( $posspace != FALSE) {
	279	$right = substr($tag, $posspace);
	280	}
	281	$end = strlen($tag)-1;
	282	if ( $tag[$end] == '"' ) {
	283	$right = '"' . $right;
	284	}
	285	$finalurl = substr($tag,$start,$end-$start+$diff);
	286	// Here, we could have these possible values for $finalurl:
	287	// file.ext Add current root dir
	288	// http://(domain) don't care
	289	// http://(domain)/ don't care
	290	// http://(domain)/folder don't care
	291	// http://(domain)/folder/ don't care
	292	// http://(domain)/folder/file.ext don't care
	293	// folder/ Add current root dir
	294	// folder/file.ext Add current root dir
	295	// /folder/ Add main root dir
	296	// /folder/file.ext Add main root dir
	297
	298	// Special case: If finalurl contains a ?, it won't be parsed
bf46cd22	299	$valid = 1;
af65e103	300
	301	if ( strpos($finalurl,"?") == FALSE ) {
	302	$valid = 1;
	303	}
	304	if ( $valid ) {
	305	if ( $finalurl[0] == "/" ) {
	306	$finalurl = $mainroot . $finalurl;
	307	} elseif ( strtolower(substr($finalurl,0,7)) != "http://" and
	308	strtolower(substr($finalurl,0,8)) != "https://") {
	309	if ( $finalurl[0] == "/") {
	310	$finalurl = $mainroot . $finalurl;
	311	} else {
	312	$finalurl = "$root/$finalurl";
	313	}
	314	}
	315
	316	$text = str_replace($tag,"$left$prefix$finalurl$right",$text);
	317	}
	318	}
	319	}
	320	return $text;
	321	}
8dddba42	322
2a439ba7	323	?>