Merge branch 'wip-MDL-31627-master' of git://github.com/marinaglancy/moodle
[moodle.git] / lib / rsslib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * This file contains all the common stuff to be used in RSS System
20  *
21  * @package    core_rss
22  * @category   rss
23  * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 defined('MOODLE_INTERNAL') || die();
29 /**
30  * Build the URL for the RSS feed and add it as a header
31  *
32  * @param stdClass    $context           The context under which the URL should be created
33  * @param string      $componentname     The name of the component for which the RSS feed exists
34  * @param stdClass    $componentinstance The instance of the component
35  * @param string      $title             Name for the link to be added to the page header
36  */
37 function rss_add_http_header($context, $componentname, $componentinstance, $title) {
38     global $PAGE, $USER;
40     $componentid = null;
41     if (is_object($componentinstance)) {
42         $componentid = $componentinstance->id;
43     } else {
44         $componentid = $componentinstance;
45     }
47     $rsspath = rss_get_url($context->id, $USER->id, $componentname, $componentid);
48     $PAGE->add_alternate_version($title, $rsspath, 'application/rss+xml');
49  }
51 /**
52  * Print the link for the RSS feed with the correct RSS icon
53  *
54  * @param stdClass    $contextid     The id of the context under which the URL should be created
55  * @param int         $userid        The source of the RSS feed (site/course/group/user)
56  * @param string      $componentname The name of the component for which the feed exists
57  * @param string      $id            The name by which to call the RSS File
58  * @param string      $tooltiptext   The tooltip to be displayed with the link
59  * @return string HTML output for the RSS link
60  */
61 function rss_get_link($contextid, $userid, $componentname, $id, $tooltiptext='') {
62     global $OUTPUT;
64     static $rsspath = '';
66     $rsspath = rss_get_url($contextid, $userid, $componentname, $id);
67     $rsspix = $OUTPUT->pix_url('i/rss');
69     return '<a href="'. $rsspath .'"><img src="'. $rsspix .'" title="'. strip_tags($tooltiptext) .'" alt="'.get_string('rss').'" /></a>';
70 }
72 /**
73  * This function returns the URL for the RSS XML file.
74  *
75  * @param int    $contextid      the course id
76  * @param int    $userid         the current user id
77  * @param string $componentname  the name of the current component. For example "forum"
78  * @param string $additionalargs For modules, module instance id
79  * @return string the url of the RSS feed
80  */
81 function rss_get_url($contextid, $userid, $componentname, $additionalargs) {
82     global $CFG;
83     require_once($CFG->libdir.'/filelib.php');
84     $usertoken = rss_get_token($userid);
85     return get_file_url($contextid.'/'.$usertoken.'/'.$componentname.'/'.$additionalargs.'/rss.xml', null, 'rssfile');
86 }
88 /**
89  * Print the link for the RSS feed with the correct RSS icon (Theme based)
90  *
91  * @param stdClass    $contextid     The id of the context under which the URL should be created
92  * @param int         $userid        The source of the RSS feed (site/course/group/user)
93  * @param string      $componentname The name of the component for which the feed exists
94  * @param string      $id            The name by which to call the RSS File
95  * @param string      $tooltiptext   The tooltip to be displayed with the link
96  */
97 function rss_print_link($contextid, $userid, $componentname, $id, $tooltiptext='') {
98     print rss_get_link($contextid, $userid, $componentname, $id, $tooltiptext);
102 /**
103  * Given an object, deletes all RSS files associated with it.
104  *
105  * @param string   $componentname the name of the module ie 'forum'. Used to construct the cache path.
106  * @param stdClass $instance      An object with an id member variable ie $forum, $glossary.
107  */
108 function rss_delete_file($componentname, $instance) {
109     global $CFG;
111     $dirpath = "$CFG->cachedir/rss/$componentname";
112     if (is_dir($dirpath)) {
113         $dh  = opendir($dirpath);
114         while (false !== ($filename = readdir($dh))) {
115             if ($filename!='.' && $filename!='..') {
116                 if (preg_match("/{$instance->id}_/", $filename)) {
117                     unlink("$dirpath/$filename");
118                 }
119             }
120         }
121     }
124 /**
125  * Are RSS feeds enabled for the supplied module instance?
126  *
127  * @param string   $modname        The name of the module to be checked
128  * @param stdClass $instance       An instance of an activity module ie $forum, $glossary.
129  * @param bool     $hasrsstype     Should there be a rsstype member variable?
130  * @param bool     $hasrssarticles Should there be a rssarticles member variable?
131  * @return bool whether or not RSS is enabled for the module
132  */
133 function rss_enabled_for_mod($modname, $instance=null, $hasrsstype=true, $hasrssarticles=true) {
134     if ($hasrsstype) {
135         if (empty($instance->rsstype) || $instance->rsstype==0) {
136             return false;
137         }
138     }
140     //have they set the RSS feed to return 0 results?
141     if ($hasrssarticles) {
142         if (empty($instance->rssarticles) || $instance->rssarticles==0) {
143             return false;
144         }
145     }
147     if (!empty($instance) && !instance_is_visible($modname,$instance)) {
148         return false;
149     }
151     return true;
154 /**
155  * This function saves to file the rss feed specified in the parameters
156  *
157  * @param string $componentname  the module name ie forum. Used to create a cache directory.
158  * @param string $filename       the name of the file to be created ie "rss.xml"
159  * @param string $contents       the data to be written to the file
160  * @param bool   $expandfilename whether or not the fullname of the RSS file should be used
161  * @return bool whether the save was successful or not
162  */
163 function rss_save_file($componentname, $filename, $contents, $expandfilename=true) {
164     global $CFG;
166     $status = true;
168     if (! $basedir = make_cache_directory ('rss/'. $componentname)) {
169         //Cannot be created, so error
170         $status = false;
171     }
173     if ($status) {
174         $fullfilename = $filename;
175         if ($expandfilename) {
176             $fullfilename = rss_get_file_full_name($componentname, $filename);
177         }
179         $rss_file = fopen($fullfilename, "w");
180         if ($rss_file) {
181             $status = fwrite ($rss_file, $contents);
182             fclose($rss_file);
183         } else {
184             $status = false;
185         }
186     }
187     return $status;
190 /**
191  * Retrieve the location and file name of a cached RSS feed
192  *
193  * @param string $componentname the name of the component the RSS feed is being created for
194  * @param string $filename the name of the RSS FEED
195  * @return string The full name and path of the RSS file
196  */
197 function rss_get_file_full_name($componentname, $filename) {
198     global $CFG;
199     return "$CFG->cachedir/rss/$componentname/$filename.xml";
202 /**
203  * Construct the file name of the RSS File
204  *
205  * @param stdClass $instance the instance of the source of the RSS feed
206  * @param string $sql the SQL used to produce the RSS feed
207  * @return string the name of the RSS file
208  */
209 function rss_get_file_name($instance, $sql) {
210     return $instance->id.'_'.md5($sql);
213 /**
214  * This function return all the common headers for every rss feed in the site
215  *
216  * @param string $title       the title for the RSS Feed
217  * @param string $link        the link for the origin of the RSS feed
218  * @param string $description the description of the contents of the RSS feed
219  * @return bool|string the standard header for the RSS feed
220  */
221 function rss_standard_header($title = NULL, $link = NULL, $description = NULL) {
222     global $CFG, $USER, $OUTPUT;
224     $status = true;
225     $result = "";
227     $site = get_site();
229     if ($status) {
231         //Calculate title, link and description
232         if (empty($title)) {
233             $title = format_string($site->fullname);
234         }
235         if (empty($link)) {
236             $link = $CFG->wwwroot;
237         }
238         if (empty($description)) {
239             $description = $site->summary;
240         }
242         //xml headers
243         $result .= "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
244         $result .= "<rss version=\"2.0\">\n";
246         //open the channel
247         $result .= rss_start_tag('channel', 1, true);
249         //write channel info
250         $result .= rss_full_tag('title', 2, false, strip_tags($title));
251         $result .= rss_full_tag('link', 2, false, $link);
252         $result .= rss_full_tag('description', 2, false, $description);
253         $result .= rss_full_tag('generator', 2, false, 'Moodle');
254         if (!empty($USER->lang)) {
255             $result .= rss_full_tag('language', 2, false, substr($USER->lang,0,2));
256         }
257         $today = getdate();
258         $result .= rss_full_tag('copyright', 2, false, '&#169; '. $today['year'] .' '. format_string($site->fullname));
259         /*
260        if (!empty($USER->email)) {
261             $result .= rss_full_tag('managingEditor', 2, false, fullname($USER));
262             $result .= rss_full_tag('webMaster', 2, false, fullname($USER));
263         }
264        */
266         //write image info
267         $rsspix = $OUTPUT->pix_url('i/rsssitelogo');
269         //write the info
270         $result .= rss_start_tag('image', 2, true);
271         $result .= rss_full_tag('url', 3, false, $rsspix);
272         $result .= rss_full_tag('title', 3, false, 'moodle');
273         $result .= rss_full_tag('link', 3, false, $CFG->wwwroot);
274         $result .= rss_full_tag('width', 3, false, '140');
275         $result .= rss_full_tag('height', 3, false, '35');
276         $result .= rss_end_tag('image', 2, true);
277     }
279     if (!$status) {
280         return false;
281     } else {
282         return $result;
283     }
287 /**
288  * Generates the rss XML code for every item passed in the array
289  *
290  * item->title: The title of the item
291  * item->author: The author of the item. Optional !!
292  * item->pubdate: The pubdate of the item
293  * item->link: The link url of the item
294  * item->description: The content of the item
295  *
296  * @param array $items an array of item objects
297  * @return bool|string the rss XML code for every item passed in the array
298  */
299 function rss_add_items($items) {
300     global $CFG;
302     $result = '';
304     if (!empty($items)) {
305         foreach ($items as $item) {
306             $result .= rss_start_tag('item',2,true);
307             //Include the category if exists (some rss readers will use it to group items)
308             if (isset($item->category)) {
309                 $result .= rss_full_tag('category',3,false,$item->category);
310             }
311             if (isset($item->tags)) {
312                 $attributes = array();
313                 if (isset($item->tagscheme)) {
314                     $attributes['domain'] = s($item->tagscheme);
315                 }
316                 foreach ($item->tags as $tag) {
317                     $result .= rss_full_tag('category', 3, false, $tag, $attributes);
318                 }
319             }
320             $result .= rss_full_tag('title',3,false,strip_tags($item->title));
321             $result .= rss_full_tag('link',3,false,$item->link);
322             $result .= rss_add_enclosures($item);
323             $result .= rss_full_tag('pubDate',3,false,gmdate('D, d M Y H:i:s',$item->pubdate).' GMT');  # MDL-12563
324             //Include the author if exists
325             if (isset($item->author) && !empty($item->author)) {
326                 //$result .= rss_full_tag('author',3,false,$item->author);
327                 //We put it in the description instead because it's more important
328                 //for moodle than most other feeds, and most rss software seems to ignore
329                 //the author field ...
330                 $item->description = get_string('byname','',$item->author).'. &nbsp;<p>'.$item->description.'</p>';
331             }
332             $result .= rss_full_tag('description',3,false,$item->description);
333             $result .= rss_full_tag('guid',3,false,$item->link,array('isPermaLink' => 'true'));
334             $result .= rss_end_tag('item',2,true);
336         }
337     } else {
338         $result = false;
339     }
340     return $result;
343 /**
344  * This function return all the common footers for every rss feed in the site
345  *
346  * @param string $title       Not used at all
347  * @param string $link        Not used at all
348  * @param string $description Not used at all
349  * @todo  MDL-31050 Fix/Remove this function
350  * @return string
351  */
352 function rss_standard_footer($title = NULL, $link = NULL, $description = NULL) {
353     $status = true;
354     $result = '';
356     //Close the chanel
357     $result .= rss_end_tag('channel', 1, true);
358     ////Close the rss tag
359     $result .= '</rss>';
361     return $result;
365 /**
366  * This function return an error xml file (string) to be sent when a rss is required (file.php) and something goes wrong
367  *
368  * @param string $errortype Type of error to send, default is rsserror
369  * @return stdClass returns a XML Feed with an error message in it
370  */
371 function rss_geterrorxmlfile($errortype = 'rsserror') {
372     global $CFG;
374     $return = '';
376     //XML Header
377     $return = rss_standard_header();
379     //XML item
380     if ($return) {
381         $item = new stdClass();
382         $item->title       = "RSS Error";
383         $item->link        = $CFG->wwwroot;
384         $item->pubdate     = time();
385         $item->description = get_string($errortype);
386         $return .= rss_add_items(array($item));
387     }
389     //XML Footer
390     if ($return) {
391         $return .= rss_standard_footer();
392     }
394     return $return;
397 /**
398  * Get the ID of the user from a given RSS Token
399  *
400  * @param string $token the RSS token you would like to use to find the user id
401  * @return int The user id
402  */
403 function rss_get_userid_from_token($token) {
404     global $DB;
405     $record = $DB->get_record('user_private_key', array('script'=>'rss','value' => $token), 'userid', IGNORE_MISSING);
406     if ($record) {
407         return $record->userid;
408     }
409     return null;
412 /**
413  * Get the RSS Token from a given user id
414  *
415  * @param int $userid The user id
416  * @return string the RSS token for the user
417  */
418 function rss_get_token($userid) {
419     return get_user_key('rss', $userid);
422 /**
423  * Removes the token for the given user from the DB
424  * @param int $userid The user id for the token you wish to delete
425  */
426 function rss_delete_token($userid) {
427     delete_user_key('rss', $userid);
430 /**
431  * Return the xml start tag
432  *
433  * @param string $tag        the xml tag name
434  * @param int    $level      the indentation level
435  * @param bool   $endline    whether or not to start new tags on a new line
436  * @param array  $attributes the attributes of the xml tag
437  * @return string the xml start tag
438  */
439 function rss_start_tag($tag,$level=0,$endline=false,$attributes=null) {
440     if ($endline) {
441        $endchar = "\n";
442     } else {
443        $endchar = "";
444     }
445     $attrstring = '';
446     if (!empty($attributes) && is_array($attributes)) {
447         foreach ($attributes as $key => $value) {
448             $attrstring .= " ".$key."=\"".$value."\"";
449         }
450     }
451     return str_repeat(" ",$level*2)."<".$tag.$attrstring.">".$endchar;
454 /**
455  * Return the xml end tag
456  * @param string $tag        the xml tag name
457  * @param int    $level      the indentation level
458  * @param bool   $endline    whether or not to start new tags on a new line
459  * @return string the xml end tag
460  */
461 function rss_end_tag($tag,$level=0,$endline=true) {
462     if ($endline) {
463        $endchar = "\n";
464     } else {
465        $endchar = "";
466     }
467     return str_repeat(" ",$level*2)."</".$tag.">".$endchar;
470 /**
471  * Return the while xml element, including content
472  *
473  * @param string $tag        the xml tag name
474  * @param int    $level      the indentation level
475  * @param bool   $endline    whether or not to start new tags on a new line
476  * @param string $content    the text to go inside the tag
477  * @param array  $attributes the attributes of the xml tag
478  * @return string the whole xml element
479  */
480 function rss_full_tag($tag,$level=0,$endline=true,$content,$attributes=null) {
481     $st = rss_start_tag($tag,$level,$endline,$attributes);
482     $co="";
483     $co = preg_replace("/\r\n|\r/", "\n", htmlspecialchars($content));
484     $et = rss_end_tag($tag,0,true);
486     return $st.$co.$et;
489 /**
490  * Adds RSS Media Enclosures for "podcasting" by including attachments that
491  * are specified in the item->attachments field.
492  *
493  * @param stdClass $item representing an RSS item
494  * @return string RSS enclosure tags
495  */
496 function rss_add_enclosures($item){
497     global $CFG;
499     $returnstring = '';
501     // list of media file extensions and their respective mime types
502     include_once($CFG->libdir.'/filelib.php');
503     $mediafiletypes = get_mimetypes_array();
505     // take into account attachments (e.g. from forum) - with these, we are able to know the file size
506     if (isset($item->attachments) && is_array($item->attachments)) {
507         foreach ($item->attachments as $attachment){
508             $extension = strtolower(substr($attachment->url, strrpos($attachment->url, '.')+1));
509             if (isset($mediafiletypes[$extension]['type'])) {
510                 $type = $mediafiletypes[$extension]['type'];
511             } else {
512                 $type = 'document/unknown';
513             }
514             $returnstring .= "\n<enclosure url=\"$attachment->url\" length=\"$attachment->length\" type=\"$type\" />\n";
515         }
516     }
518     return $returnstring;