rss MDL-24509 added support for 1.9 rss feed requests
[moodle.git] / rss / file.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * rss/file.php - entry point to serve rss streams
19  * 
20  * This script simply checks the parameters to construct a $USER
21  * then finds and calls a function in the relevant component to 
22  * actually check security and create the RSS stream
23  *
24  * @package   moodlecore
25  * @copyright 1999 onwards Martin Dougiamas  http://moodle.com
26  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27  */
30 // Disable moodle specific debug messages and any errors in output
31 define('NO_DEBUG_DISPLAY', true);//comment this out to see any error messages during RSS generation
33 // Sessions not used here, we recreate $USER every time we are called
34 define('NO_MOODLE_COOKIES', true);
36 require_once('../config.php');
37 require_once($CFG->libdir.'/filelib.php');
38 require_once($CFG->libdir.'/rsslib.php');
40 // RSS feeds must be enabled site-wide
41 if (empty($CFG->enablerssfeeds)) {
42     debugging('DISABLED (admin variables)');
43     rss_error();
44 }
47 // All the arguments are in the path
48 $relativepath = get_file_argument();
49 if (!$relativepath) {
50     rss_error();
51 }
54 // Extract relative path components into variables
55 $args = explode('/', trim($relativepath, '/'));
56 if (count($args) < 5) {
57     rss_error();
58 }
60 $contextid   = (int)$args[0];
61 $token  = clean_param($args[1], PARAM_ALPHANUM);
62 $componentname = clean_param($args[2], PARAM_FILE);
64 //check if they have requested a 1.9 RSS feed
65 //if token is an int its a user id (1.9 request)
66 //if token contains any letters its a token (2.0 request)
67 $inttoken = intval($token);
68 if ($token==="$inttoken") {
69     //they've requested a feed using a 1.9 url. redirect them to the 2.0 url using the guest account
71     $instanceid  = clean_param($args[3], PARAM_INT);
73     //1.9 URL puts course id where the context id is in 2.0 URLs
74     $courseid = $contextid;
75     unset($contextid);
77     //find the context id
78     if ($course = $DB->get_record('course', array('id' => $courseid))) {
79         $modinfo =& get_fast_modinfo($course);
81         if (!isset($modinfo->instances[$componentname])) {
82             $modinfo->instances[$componentname] = array();
83         }
84         
85         foreach ($modinfo->instances[$componentname] as $modinstanceid=>$cm) {
86             if ($modinstanceid==$instanceid) {
87                 $context = get_context_instance(CONTEXT_MODULE, $cm->id);
88                 break;
89             }
90         }
91     }
93     if (empty($context)) {
94         //this shouldnt happen. something bad is going on.
95         rss_error('rsserror');
96     }
98     //calling isguestuser() just to make sure that $CFG->siteguest is set
99     isguestuser($token);
100     $guesttoken = rss_get_token($CFG->siteguest);
102     //change forum to mod_forum (for example)
103     $componentname = 'mod_'.$componentname;
105     $url = $PAGE->url;
106     $url->set_slashargument("/{$context->id}/$guesttoken/$componentname/$instanceid/rss.xml");
108     //redirect to the 2.0 rss URL
109     redirect($url);
110 } else {
111     // Authenticate the user from the token
112     $userid = rss_get_userid_from_token($token);
113     if (!$userid) {
114         rss_error('rsserrorauth');
115     }
118 $user = get_complete_user_data('id', $userid);
119 session_set_user($user); //for login and capability checks
121 // Check the context actually exists
122 list($context, $course, $cm) = get_context_info_array($contextid);
124 if (!$context) {
125     rss_error();
127 $PAGE->set_context($context);
129 try {
130     $autologinguest = true;
131     $setwantsurltome = true;
132     $preventredirect = true;
133     require_login($course, $autologinguest, $cm, $setwantsurltome, $preventredirect);
134 } catch (Exception $e) {
135     if (isguestuser()) {
136         rss_error('rsserrorguest');
137     } else {
138         rss_error('rsserrorauth');
139     }
142 // Work out which component in Moodle we want (from the frankenstyle name)
143 $componentdir = get_component_directory($componentname);
144 list($type, $plugin) = normalize_component($componentname);
147 // Call the component to check/update the feed and tell us the path to the cached file
148 $pathname = null;
150 if (file_exists($componentdir)) {
151     require_once("$componentdir/rsslib.php");
152     $functionname = $plugin.'_rss_get_feed';
154     if (function_exists($functionname)) {
155         // $pathname will be null if there was a problem (eg user doesn't have the necessary capabilities)
156         // NOTE:the component providing the feed must do its own capability checks and security
157         $pathname = $functionname($context, $args);
158     }
162 // Check that file exists
163 if (empty($pathname) || !file_exists($pathname)) {
164     rss_error();
167 // Send the RSS file to the user!
168 send_file($pathname, 'rss.xml', 3600);   // Cached by browsers for 1 hour
171 /*
172  * Sends an error formatted as an rss file and then dies
173  */
174 function rss_error($error='rsserror', $filename='rss.xml', $lifetime=0) {
175     send_file(rss_geterrorxmlfile($error), $filename, $lifetime, false, true);
176     exit;