MDL-45339 Libraries: Add a note to docblock of get_config, set_config, and unset_conf...
[moodle.git] / blog / 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  * Blog RSS Management
20  *
21  * @package    core_blog
22  * @category   rss
23  * @copyright  2010 Andrew Davis
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
26 require_once($CFG->dirroot.'/lib/rsslib.php');
27 require_once($CFG->dirroot .'/blog/lib.php');
29 /**
30  * Build the URL for the RSS feed
31  *
32  * @param int    $contextid    The context under which the URL should be created
33  * @param int    $userid       The id of the user requesting the RSS Feed
34  * @param string $filtertype   The source of the RSS feed (site/course/group/user)
35  * @param int    $filterselect The id of the item defined by $filtertype
36  * @param int    $tagid        The id of the row in the tag table that identifies the RSS Feed
37  * @return string
38  */
39 function blog_rss_get_url($contextid, $userid, $filtertype, $filterselect=0, $tagid=0) {
40     $componentname = 'blog';
42     $additionalargs = null;
43     switch ($filtertype) {
44         case 'site':
45             $additionalargs = 'site/'.SITEID;
46         break;
47         case 'course':
48             $additionalargs = 'course/'.$filterselect;
49         break;
50         case 'group':
51             $additionalargs = 'group/'.$filterselect;
52         break;
53         case 'user':
54             $additionalargs = 'user/'.$filterselect;
55         break;
56     }
58     if ($tagid) {
59         $additionalargs .= '/'.$tagid;
60     }
62     return rss_get_url($contextid, $userid, $componentname, $additionalargs);
63 }
65 /**
66  * Print the link for the RSS feed with the correct RSS icon (Theme based)
67  *
68  * @param stdClass    $context      The context under which the URL should be created
69  * @param string      $filtertype   The source of the RSS feed (site/course/group/user)
70  * @param int         $filterselect The id of the item defined by $filtertype
71  * @param int         $tagid        The id of the row in the tag table that identifies the RSS Feed
72  * @param string      $tooltiptext  The tooltip to be displayed with the link
73  */
74 function blog_rss_print_link($context, $filtertype, $filterselect=0, $tagid=0, $tooltiptext='') {
75     global $CFG, $USER, $OUTPUT;
77     if (!isloggedin()) {
78         $userid = $CFG->siteguest;
79     } else {
80         $userid = $USER->id;
81     }
83     $url = blog_rss_get_url($context->id, $userid, $filtertype, $filterselect, $tagid);
84     $rsspix = $OUTPUT->pix_url('i/rss');
85     print '<div class="mdl-right"><a href="'. $url .'"><img src="'. $rsspix .'" title="'. strip_tags($tooltiptext) .'" alt="'.get_string('rss').'" /></a></div>';
86 }
88 /**
89  * Build the URL for the RSS feed amd add it as a header
90  *
91  * @param stdClass    $context      The context under which the URL should be created
92  * @param string      $title        Name for the link to be added to the page header
93  * @param string      $filtertype   The source of the RSS feed (site/course/group/user)
94  * @param int         $filterselect The id of the item defined by $filtertype
95  * @param int         $tagid        The id of the row in the tag table that identifies the RSS Feed
96  */
97 function blog_rss_add_http_header($context, $title, $filtertype, $filterselect=0, $tagid=0) {
98     global $PAGE, $USER, $CFG;
100     //$componentname = 'blog';
101     //rss_add_http_header($context, $componentname, $filterselect, $title);
103     if (!isloggedin()) {
104         $userid = $CFG->siteguest;
105     } else {
106         $userid = $USER->id;
107     }
109     $rsspath = blog_rss_get_url($context->id, $userid, $filtertype, $filterselect, $tagid);
110     $PAGE->add_alternate_version($title, $rsspath, 'application/rss+xml');
113 /**
114  * Utility function to extract parameters needed to generate RSS URLs from the blog filters
115  *
116  * @param  array $filters filters for the blog
117  * @return array array containing the id of the user/course/group, the relevant context and the filter type: site/user/course/group
118  */
119 function blog_rss_get_params($filters) {
120     $thingid = $rsscontext = $filtertype = null;
122     $sitecontext = context_system::instance();
124     if (!$filters) {
125         $thingid = SITEID;
126         $filtertype = 'site';
127     } else if (array_key_exists('course', $filters)) {
128         $thingid = $filters['course'];
129         $filtertype = 'course';
130     } else if (array_key_exists('user', $filters)) {
131         $thingid = $filters['user'];
132         $filtertype = 'user';
133     } else if (array_key_exists('group', $filters)) {
134         $thingid = $filters['group'];
135         $filtertype = 'group';
136     }
138     return array($thingid, $rsscontext, $filtertype);
141 /**
142  * Generate any blog RSS feed via one function
143  *
144  * @param stdClass $context The context of the blog for which the feed it being generated
145  * @param array    $args    An array of arguements needed to build the feed (contextid, token, componentname, type, id, tagid)
146  */
147 function blog_rss_get_feed($context, $args) {
148     global $CFG, $SITE, $DB;
150     if (empty($CFG->enableblogs)) {
151         debugging('Blogging disabled on this site, RSS feeds are not available');
152         return null;
153     }
155     if (empty($CFG->enablerssfeeds)) {
156         debugging('Sorry, RSS feeds are disabled on this site');
157         return '';
158     }
160     if ($CFG->bloglevel == BLOG_SITE_LEVEL) {
161         if (isguestuser()) {
162             debugging(get_string('nopermissiontoshow','error'));
163             return '';
164         }
165     }
167     $sitecontext = context_system::instance();
168     if (!has_capability('moodle/blog:view', $sitecontext)) {
169         return null;
170     }
172     $type  = clean_param($args[3], PARAM_ALPHA);
173     $id = clean_param($args[4], PARAM_INT);  // could be groupid / courseid  / userid  depending on $type
175     $tagid=0;
176     if ($args[5] != 'rss.xml') {
177         $tagid = clean_param($args[5], PARAM_INT);
178     } else {
179         $tagid = 0;
180     }
182     $filename = blog_rss_file_name($type, $id, $tagid);
184     if (file_exists($filename)) {
185         if (filemtime($filename) + 3600 > time()) {
186             return $filename;   // It's already done so we return cached version
187         }
188     }
190     $courseid = $groupid = $userid = null;
191     switch ($type) {
192         case 'site':
193             //$siteid = $id;
194             break;
195         case 'course':
196             $courseid = $id;
197             break;
198         case 'group':
199             $groupid = $id;
200             break;
201         case 'user':
202             $userid = $id;
203             break;
204     }
206     // Get all the entries from the database
207     require_once($CFG->dirroot .'/blog/locallib.php');
208     $blogheaders = blog_get_headers($courseid, $groupid, $userid, $tagid);
210     $bloglisting = new blog_listing($blogheaders['filters']);
211     $blogentries = $bloglisting->get_entries();
213     // Now generate an array of RSS items
214     if ($blogentries) {
215         $items = array();
216         foreach ($blogentries as $blog_entry) {
217             $item = NULL;
218             $item->author = fullname($DB->get_record('user', array('id'=>$blog_entry->userid))); // TODO: this is slow
219             $item->title = $blog_entry->subject;
220             $item->pubdate = $blog_entry->lastmodified;
221             $item->link = $CFG->wwwroot.'/blog/index.php?entryid='.$blog_entry->id;
222             $summary = file_rewrite_pluginfile_urls($blog_entry->summary, 'pluginfile.php',
223                 $sitecontext->id, 'blog', 'post', $blog_entry->id);
224             $item->description = format_text($summary, $blog_entry->format);
225             if ( !empty($CFG->usetags) && ($blogtags = tag_get_tags_array('post', $blog_entry->id)) ) {
226                 if ($blogtags) {
227                     $item->tags = $blogtags;
228                 }
229                 $item->tagscheme = $CFG->wwwroot . '/tag';
230             }
231             $items[] = $item;
232         }
233         $articles = rss_add_items($items);   /// Change structure to XML
234     } else {
235         $articles = '';
236     }
238 /// Get header and footer information
240     switch ($type) {
241         case 'user':
242             $info = fullname($DB->get_record('user', array('id'=>$id), 'firstname,lastname'));
243             break;
244         case 'course':
245             $info = $DB->get_field('course', 'fullname', array('id'=>$id));
246             $info = format_string($info, true, array('context' => context_course::instance($id)));
247             break;
248         case 'site':
249             $info = format_string($SITE->fullname, true, array('context' => context_course::instance(SITEID)));
250             break;
251         case 'group':
252             $group = groups_get_group($id);
253             $info = $group->name; //TODO: $DB->get_field('groups', 'name', array('id'=>$id))
254             break;
255         default:
256             $info = '';
257             break;
258     }
260     if ($tagid) {
261         $info .= ': '.$DB->get_field('tags', 'text', array('id'=>$tagid));
262     }
264     $header = rss_standard_header(get_string($type.'blog','blog', $info),
265                                   $CFG->wwwroot.'/blog/index.php',
266                                   get_string('intro','blog'));
268     $footer = rss_standard_footer();
270     // Save the XML contents to file.
271     $rssdata = $header.$articles.$footer;
272     if (blog_rss_save_file($type,$id,$tagid,$rssdata)) {
273         return $filename;
274     } else {
275         return false;   // Couldn't find it or make it
276     }
279 /**
280  * Retrieve the location and file name of a cached RSS feed
281  *
282  * @param string $type  The source of the RSS feed (site/course/group/user)
283  * @param int    $id    The id of the item defined by $type
284  * @param int    $tagid The id of the row in the tag table that identifies the RSS Feed
285  * @return string
286  */
287 function blog_rss_file_name($type, $id, $tagid=0) {
288     global $CFG;
290     if ($tagid) {
291         return "$CFG->cachedir/rss/blog/$type/$id/$tagid.xml";
292     } else {
293         return "$CFG->cachedir/rss/blog/$type/$id.xml";
294     }
297 /**
298  * This function saves to file the rss feed specified in the parameters
299  *
300  * @param string $type     The source of the RSS feed (site/course/group/user)
301  * @param int    $id       The id of the item defined by $type
302  * @param int    $tagid    The id of the row in the tag table that identifies the RSS Feed
303  * @param string $contents The contents of the RSS Feed file
304  * @return bool whether the save was successful or not
305  */
306 function blog_rss_save_file($type, $id, $tagid=0, $contents='') {
307     global $CFG;
309     $status = true;
311     //blog creates some additional dirs within the rss cache so make sure they all exist
312     make_cache_directory('rss/blog');
313     make_cache_directory('rss/blog/'.$type);
315     $filename = blog_rss_file_name($type, $id, $tagid);
316     $expandfilename = false; //we're supplying a full file path
317     $status = rss_save_file('blog', $filename, $contents, $expandfilename);
319     return $status;
322 /**
323  * Delete the supplied user's cached blog post RSS feed.
324  * Only user blogs are available by RSS.
325  * This doesn't call rss_delete_file() as blog RSS caching uses it's own file structure.
326  *
327  * @param int $userid
328  */
329 function blog_rss_delete_file($userid) {
330     $filename = blog_rss_file_name('user', $userid);
331     if (file_exists($filename)) {
332         unlink($filename);
333     }