MDL-31627: Arialist theme do not resize content when there are no blocks
[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
22  * @subpackage 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  function rss_add_http_header($context, $componentname, $componentinstance, $title) {
30     global $PAGE, $USER;
32     $componentid = null;
33     if (is_object($componentinstance)) {
34         $componentid = $componentinstance->id;
35     } else {
36         $componentid = $componentinstance;
37     }
39     $rsspath = rss_get_url($context->id, $USER->id, $componentname, $componentid);
40     $PAGE->add_alternate_version($title, $rsspath, 'application/rss+xml');
41  }
43 /**
44  * This function returns the icon (from theme) with the link to rss/file.php
45  *
46  * @global object
47  * @global object
48  */
49 function rss_get_link($contextid, $userid, $componentname, $id, $tooltiptext='') {
50     global $OUTPUT;
52     static $rsspath = '';
54     $rsspath = rss_get_url($contextid, $userid, $componentname, $id);
55     $rsspix = $OUTPUT->pix_url('i/rss');
57     return '<a href="'. $rsspath .'"><img src="'. $rsspix .'" title="'. strip_tags($tooltiptext) .'" alt="'.get_string('rss').'" /></a>';
58 }
60 /**
61  * This function returns the URL for the RSS XML file.
62  *
63  * @global object
64  * @param int contextid the course id
65  * @param int userid the current user id
66  * @param string modulename the name of the current module. For example "forum"
67  * @param string $additionalargs For modules, module instance id
68  */
69 function rss_get_url($contextid, $userid, $componentname, $additionalargs) {
70     global $CFG;
71     require_once($CFG->libdir.'/filelib.php');
72     $usertoken = rss_get_token($userid);
73     return get_file_url($contextid.'/'.$usertoken.'/'.$componentname.'/'.$additionalargs.'/rss.xml', null, 'rssfile');
74 }
76 /**
77  * This function prints the icon (from theme) with the link to rss/file.php
78  */
79 function rss_print_link($contextid, $userid, $componentname, $id, $tooltiptext='') {
80     print rss_get_link($contextid, $userid, $componentname, $id, $tooltiptext);
82 }
84 /**
85  * Given an object, deletes all RSS files associated with it.
86  * Relies on a naming convention. See rss_get_filename()
87  *
88  * @param string $componentname the name of the module ie 'forum'. Used to construct the cache path.
89  * @param object $instance An object with an id member variable ie $forum, $glossary.
90  * @return void
91  */
92 function rss_delete_file($componentname, $instance) {
93     global $CFG;
95     $dirpath = "$CFG->cachedir/rss/$componentname";
96     if (is_dir($dirpath)) {
97         $dh  = opendir($dirpath);
98         while (false !== ($filename = readdir($dh))) {
99             if ($filename!='.' && $filename!='..') {
100                 if (preg_match("/{$instance->id}_/", $filename)) {
101                     unlink("$dirpath/$filename");
102                 }
103             }
104         }
105     }
108 /**
109  * Are RSS feeds enabled for the supplied module instance?
110  * @param object $instance An instance of an activity module ie $forum, $glossary.
111  * @param boolean $hasrsstype Should there be a rsstype member variable?
112  * @param boolean $hasrssarticles Should there be a rssarticles member variable?
113  */
114 function rss_enabled_for_mod($modname, $instance=null, $hasrsstype=true, $hasrssarticles=true) {
115     if ($hasrsstype) {
116         if (empty($instance->rsstype) || $instance->rsstype==0) {
117             return false;
118         }
119     }
121     //have they set the RSS feed to return 0 results?
122     if ($hasrssarticles) {
123         if (empty($instance->rssarticles) || $instance->rssarticles==0) {
124             return false;
125         }
126     }
128     if (!empty($instance) && !instance_is_visible($modname,$instance)) {
129         return false;
130     }
132     return true;
135 /**
136  * This function saves to file the rss feed specified in the parameters
137  *
138  * @global object
139  * @param string $componentname the module name ie forum. Used to create a cache directory.
140  * @param string $filename the name of the file to be created ie "1234"
141  * @param string $contents the data to be written to the file
142  */
143 function rss_save_file($componentname, $filename, $contents, $expandfilename=true) {
144     global $CFG;
146     $status = true;
148     if (! $basedir = make_cache_directory ('rss/'. $componentname)) {
149         //Cannot be created, so error
150         $status = false;
151     }
153     if ($status) {
154         $fullfilename = $filename;
155         if ($expandfilename) {
156             $fullfilename = rss_get_file_full_name($componentname, $filename);
157         }
159         $rss_file = fopen($fullfilename, "w");
160         if ($rss_file) {
161             $status = fwrite ($rss_file, $contents);
162             fclose($rss_file);
163         } else {
164             $status = false;
165         }
166     }
167     return $status;
171 function rss_get_file_full_name($componentname, $filename) {
172     global $CFG;
173     return "$CFG->cachedir/rss/$componentname/$filename.xml";
176 function rss_get_file_name($instance, $sql) {
177     return $instance->id.'_'.md5($sql);
180 /**
181  * This function return all the common headers for every rss feed in the site
182  *
183  * @global object
184  * @global object
185  */
186 function rss_standard_header($title = NULL, $link = NULL, $description = NULL) {
187     global $CFG, $USER, $OUTPUT;
189     $status = true;
190     $result = "";
192     $site = get_site();
194     if ($status) {
196         //Calculate title, link and description
197         if (empty($title)) {
198             $title = format_string($site->fullname);
199         }
200         if (empty($link)) {
201             $link = $CFG->wwwroot;
202         }
203         if (empty($description)) {
204             $description = $site->summary;
205         }
207         //xml headers
208         $result .= "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
209         $result .= "<rss version=\"2.0\">\n";
211         //open the channel
212         $result .= rss_start_tag('channel', 1, true);
214         //write channel info
215         $result .= rss_full_tag('title', 2, false, strip_tags($title));
216         $result .= rss_full_tag('link', 2, false, $link);
217         $result .= rss_full_tag('description', 2, false, $description);
218         $result .= rss_full_tag('generator', 2, false, 'Moodle');
219         if (!empty($USER->lang)) {
220             $result .= rss_full_tag('language', 2, false, substr($USER->lang,0,2));
221         }
222         $today = getdate();
223         $result .= rss_full_tag('copyright', 2, false, '&#169; '. $today['year'] .' '. format_string($site->fullname));
224         /*
225        if (!empty($USER->email)) {
226             $result .= rss_full_tag('managingEditor', 2, false, fullname($USER));
227             $result .= rss_full_tag('webMaster', 2, false, fullname($USER));
228         }
229        */
231         //write image info
232         $rsspix = $OUTPUT->pix_url('i/rsssitelogo');
234         //write the info
235         $result .= rss_start_tag('image', 2, true);
236         $result .= rss_full_tag('url', 3, false, $rsspix);
237         $result .= rss_full_tag('title', 3, false, 'moodle');
238         $result .= rss_full_tag('link', 3, false, $CFG->wwwroot);
239         $result .= rss_full_tag('width', 3, false, '140');
240         $result .= rss_full_tag('height', 3, false, '35');
241         $result .= rss_end_tag('image', 2, true);
242     }
244     if (!$status) {
245         return false;
246     } else {
247         return $result;
248     }
251 //This function returns the rss XML code for every item passed in the array
252 //item->title: The title of the item
253 //item->author: The author of the item. Optional !!
254 //item->pubdate: The pubdate of the item
255 //item->link: The link url of the item
256 //item->description: The content of the item
257 function rss_add_items($items) {
258     global $CFG;
260     $result = '';
262     if (!empty($items)) {
263         foreach ($items as $item) {
264             $result .= rss_start_tag('item',2,true);
265             //Include the category if exists (some rss readers will use it to group items)
266             if (isset($item->category)) {
267                 $result .= rss_full_tag('category',3,false,$item->category);
268             }
269             if (isset($item->tags)) {
270                 $attributes = array();
271                 if (isset($item->tagscheme)) {
272                     $attributes['domain'] = s($item->tagscheme);
273                 }
274                 foreach ($item->tags as $tag) {
275                     $result .= rss_full_tag('category', 3, false, $tag, $attributes);
276                 }
277             }
278             $result .= rss_full_tag('title',3,false,strip_tags($item->title));
279             $result .= rss_full_tag('link',3,false,$item->link);
280             $result .= rss_add_enclosures($item);
281             $result .= rss_full_tag('pubDate',3,false,gmdate('D, d M Y H:i:s',$item->pubdate).' GMT');  # MDL-12563
282             //Include the author if exists
283             if (isset($item->author) && !empty($item->author)) {
284                 //$result .= rss_full_tag('author',3,false,$item->author);
285                 //We put it in the description instead because it's more important
286                 //for moodle than most other feeds, and most rss software seems to ignore
287                 //the author field ...
288                 $item->description = get_string('byname','',$item->author).'. &nbsp;<p>'.$item->description.'</p>';
289             }
290             $result .= rss_full_tag('description',3,false,$item->description);
291             $result .= rss_full_tag('guid',3,false,$item->link,array('isPermaLink' => 'true'));
292             $result .= rss_end_tag('item',2,true);
294         }
295     } else {
296         $result = false;
297     }
298     return $result;
301 /**
302  * This function return all the common footers for every rss feed in the site
303  */
304 function rss_standard_footer($title = NULL, $link = NULL, $description = NULL) {
305     $status = true;
306     $result = '';
308     //Close the chanel
309     $result .= rss_end_tag('channel', 1, true);
310     ////Close the rss tag
311     $result .= '</rss>';
313     return $result;
316 /**
317  * This function return an error xml file (string)
318  * to be sent when a rss is required (file.php)
319  * and something goes wrong
320  */
321 function rss_geterrorxmlfile($errortype = 'rsserror') {
322     global $CFG;
324     $return = '';
326     //XML Header
327     $return = rss_standard_header();
329     //XML item
330     if ($return) {
331         $item = new stdClass();
332         $item->title       = "RSS Error";
333         $item->link        = $CFG->wwwroot;
334         $item->pubdate     = time();
335         $item->description = get_string($errortype);
336         $return .= rss_add_items(array($item));
337     }
339     //XML Footer
340     if ($return) {
341         $return .= rss_standard_footer();
342     }
344     return $return;
347 function rss_get_userid_from_token($token) {
348     global $DB;
349     $record = $DB->get_record('user_private_key', array('script'=>'rss','value' => $token), 'userid', IGNORE_MISSING);
350     if ($record) {
351         return $record->userid;
352     }
353     return null;
356 function rss_get_token($userid) {
357     return get_user_key('rss', $userid);
360 function rss_delete_token($userid) {
361     delete_user_key('rss', $userid);
364 // ===== This function are used to write XML tags =========
365 // [stronk7]: They are similar to the glossary export and backup generation
366 // but I've replicated them here because they have some minor
367 // diferences. Someday all they should go to a common place.
369 /**
370  * Return the xml start tag
371  */
372 function rss_start_tag($tag,$level=0,$endline=false,$attributes=null) {
373     if ($endline) {
374        $endchar = "\n";
375     } else {
376        $endchar = "";
377     }
378     $attrstring = '';
379     if (!empty($attributes) && is_array($attributes)) {
380         foreach ($attributes as $key => $value) {
381             $attrstring .= " ".$key."=\"".$value."\"";
382         }
383     }
384     return str_repeat(" ",$level*2)."<".$tag.$attrstring.">".$endchar;
387 /**
388  * Return the xml end tag
389  */
390 function rss_end_tag($tag,$level=0,$endline=true) {
391     if ($endline) {
392        $endchar = "\n";
393     } else {
394        $endchar = "";
395     }
396     return str_repeat(" ",$level*2)."</".$tag.">".$endchar;
399 /**
400  * Return the start tag, the contents and the end tag
401  */
402 function rss_full_tag($tag,$level=0,$endline=true,$content,$attributes=null) {
403     $st = rss_start_tag($tag,$level,$endline,$attributes);
404     $co="";
405     $co = preg_replace("/\r\n|\r/", "\n", htmlspecialchars($content));
406     $et = rss_end_tag($tag,0,true);
408     return $st.$co.$et;
411 /**
412  * Adds RSS Media Enclosures for "podcasting" by including attachments that
413  * are specified in the item->attachments field.
414  * Note also that iTunes does some things very badly - one thing it does is
415  * refuse to download ANY of your files if you're using "file.php?file=blah"
416  * and can't use the more elegant "file.php/blah" slasharguments setting. It
417  * stops after ".php" and assumes the files are not media files, despite what
418  * is specified in the "type" attribute. Dodgy coding all round!
419  *
420  * Authors
421  *     - Hannes Gassert <hannes@mediagonal.ch>
422  *     - Dan Stowell
423  *
424  * @global object
425  * @param    $item     object representing an RSS item
426  * @return   string    RSS enclosure tags
427  */
428 function rss_add_enclosures($item){
429     global $CFG;
431     $returnstring = '';
433     // list of media file extensions and their respective mime types
434     include_once($CFG->libdir.'/filelib.php');
435     $mediafiletypes = get_mimetypes_array();
437     // take into account attachments (e.g. from forum) - with these, we are able to know the file size
438     if (isset($item->attachments) && is_array($item->attachments)) {
439         foreach ($item->attachments as $attachment){
440             $extension = strtolower(substr($attachment->url, strrpos($attachment->url, '.')+1));
441             if (isset($mediafiletypes[$extension]['type'])) {
442                 $type = $mediafiletypes[$extension]['type'];
443             } else {
444                 $type = 'document/unknown';
445             }
446             $returnstring .= "\n<enclosure url=\"$attachment->url\" length=\"$attachment->length\" type=\"$type\" />\n";
447         }
448     }
450     return $returnstring;