3 * StatusNet, the distributed open-source microblogging tool
5 * Base class for RSS 1.0 feed actions
9 * LICENCE: This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Affero General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Affero General Public License for more details.
19 * You should have received a copy of the GNU Affero General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 * @author Evan Prodromou <evan@status.net>
25 * @author Earle Martin <earle@downlode.org>
26 * @copyright 2008-9 StatusNet, Inc.
27 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
28 * @link http://status.net/
31 if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
33 define('DEFAULT_RSS_LIMIT', 48);
35 class Rss10Action extends Action
37 // This will contain the details of each feed item's author and be used to generate SIOC data.
39 var $creators = array();
40 var $limit = DEFAULT_RSS_LIMIT;
42 var $tags_already_output = array();
47 * Just wraps the Action constructor.
49 * @param string $output URI to output to, default = stdout
50 * @param boolean $indent Whether to indent output, default true
52 * @see Action::__construct
55 function __construct($output='php://output', $indent=null)
57 parent::__construct($output, $indent);
61 * Do we need to write to the database?
63 * @return boolean true
72 * Read arguments and initialize members
74 * @param array $args Arguments from $_REQUEST
75 * @return boolean success
78 function prepare($args)
80 parent::prepare($args);
82 $this->limit = (int) $this->trimmed('limit');
84 if ($this->limit == 0) {
85 $this->limit = DEFAULT_RSS_LIMIT;
88 if (common_config('site', 'private')) {
89 if (!isset($_SERVER['PHP_AUTH_USER'])) {
91 // This header makes basic auth go
92 header('WWW-Authenticate: Basic realm="GNU social RSS"');
94 // If the user hits cancel -- bam!
95 $this->show_basic_auth_error();
98 $nickname = $_SERVER['PHP_AUTH_USER'];
99 $password = $_SERVER['PHP_AUTH_PW'];
101 if (!common_check_user($nickname, $password)) {
102 // basic authentication failed
103 list($proxy, $ip) = common_client_ip();
105 common_log(LOG_WARNING, "Failed RSS auth attempt, nickname = $nickname, proxy = $proxy, ip = $ip.");
106 $this->show_basic_auth_error();
118 * @param array $args Arguments from $_REQUEST
123 function handle($args)
125 // Parent handling, including cache check
126 parent::handle($args);
130 function show_basic_auth_error()
132 header('HTTP/1.1 401 Unauthorized');
133 header('Content-Type: application/xml; charset=utf-8');
135 $this->elementStart('hash');
136 $this->element('error', null, 'Could not authenticate you.');
137 $this->element('request', null, $_SERVER['REQUEST_URI']);
138 $this->elementEnd('hash');
143 * Get the notices to output in this stream.
145 * @return array an array of Notice objects sorted in reverse chron
148 function getNotices()
154 * Get a description of the channel
156 * Returns an array with the following
160 function getChannel()
162 return array('url' => '',
165 'description' => '');
176 $this->showChannel();
179 if (count($this->notices)) {
180 foreach ($this->notices as $n) {
183 } catch (Exception $e) {
184 // log exceptions and continue
185 common_log(LOG_ERR, $e->getMessage());
191 $this->showCreators();
195 function showChannel()
198 $channel = $this->getChannel();
199 $image = $this->getImage();
201 $this->elementStart('channel', array('rdf:about' => $channel['url']));
202 $this->element('title', null, $channel['title']);
203 $this->element('link', null, $channel['link']);
204 $this->element('description', null, $channel['description']);
205 $this->element('cc:licence', array('rdf:resource' => common_config('license','url')));
208 $this->element('image', array('rdf:resource' => $image));
211 $this->elementStart('items');
212 $this->elementStart('rdf:Seq');
214 if (count($this->notices)) {
215 foreach ($this->notices as $notice) {
216 $this->element('rdf:li', array('rdf:resource' => $notice->uri));
220 $this->elementEnd('rdf:Seq');
221 $this->elementEnd('items');
223 $this->elementEnd('channel');
228 $image = $this->getImage();
230 $channel = $this->getChannel();
231 $this->elementStart('image', array('rdf:about' => $image));
232 $this->element('title', null, $channel['title']);
233 $this->element('link', null, $channel['link']);
234 $this->element('url', null, $image);
235 $this->elementEnd('image');
239 function showItem($notice)
241 $profile = $notice->getProfile();
242 $nurl = common_local_url('shownotice', array('notice' => $notice->id));
243 $creator_uri = common_profile_uri($profile);
244 $this->elementStart('item', array('rdf:about' => $notice->uri,
245 'rdf:type' => 'http://rdfs.org/sioc/types#MicroblogPost'));
246 $title = $profile->nickname . ': ' . common_xml_safe_str(trim($notice->content));
247 $this->element('title', null, $title);
248 $this->element('link', null, $nurl);
249 $this->element('description', null, $profile->nickname."'s status on ".common_exact_date($notice->created));
250 if ($notice->rendered) {
251 $this->element('content:encoded', null, common_xml_safe_str($notice->rendered));
253 $this->element('dc:date', null, common_date_w3dtf($notice->created));
254 $this->element('dc:creator', null, ($profile->fullname) ? $profile->fullname : $profile->nickname);
255 $this->element('foaf:maker', array('rdf:resource' => $creator_uri));
256 $this->element('sioc:has_creator', array('rdf:resource' => $creator_uri.'#acct'));
257 $location = $notice->getLocation();
258 if ($location && isset($location->lat) && isset($location->lon)) {
259 $location_uri = $location->getRdfURL();
260 $attrs = array('geo:lat' => $location->lat,
261 'geo:long' => $location->lon);
262 if (strlen($location_uri)) {
263 $attrs['rdf:resource'] = $location_uri;
265 $this->element('statusnet:origin', $attrs);
267 $this->element('statusnet:postIcon', array('rdf:resource' => $profile->avatarUrl()));
268 $this->element('cc:licence', array('rdf:resource' => common_config('license', 'url')));
269 if ($notice->reply_to) {
270 $replyurl = common_local_url('shownotice', array('notice' => $notice->reply_to));
271 $this->element('sioc:reply_of', array('rdf:resource' => $replyurl));
273 if (!empty($notice->conversation)) {
274 $conversationurl = common_local_url('conversation',
275 array('id' => $notice->conversation));
276 $this->element('sioc:has_discussion', array('rdf:resource' => $conversationurl));
278 $attachments = $notice->attachments();
280 foreach($attachments as $attachment){
282 $enclosure = $attachment->getEnclosure();
283 $attribs = array('rdf:resource' => $enclosure->url);
284 if ($enclosure->title) {
285 $attribs['dc:title'] = $enclosure->title;
287 if ($enclosure->modified) {
288 $attribs['dc:date'] = common_date_w3dtf($enclosure->modified);
290 if ($enclosure->size) {
291 $attribs['enc:length'] = $enclosure->size;
293 if ($enclosure->mimetype) {
294 $attribs['enc:type'] = $enclosure->mimetype;
296 $this->element('enc:enclosure', $attribs);
297 } catch (ServerException $e) {
298 // There was not enough metadata available
300 $this->element('sioc:links_to', array('rdf:resource'=>$attachment->url));
304 $tag = new Notice_tag();
305 $tag->notice_id = $notice->id;
307 $entry['tags']=array();
308 while ($tag->fetch()) {
309 $tagpage = common_local_url('tag', array('tag' => $tag->tag));
311 if ( in_array($tag, $this->tags_already_output) ) {
312 $this->element('ctag:tagged', array('rdf:resource'=>$tagpage.'#concept'));
316 $tagrss = common_local_url('tagrss', array('tag' => $tag->tag));
317 $this->elementStart('ctag:tagged');
318 $this->elementStart('ctag:Tag', array('rdf:about'=>$tagpage.'#concept', 'ctag:label'=>$tag->tag));
319 $this->element('foaf:page', array('rdf:resource'=>$tagpage));
320 $this->element('rdfs:seeAlso', array('rdf:resource'=>$tagrss));
321 $this->elementEnd('ctag:Tag');
322 $this->elementEnd('ctag:tagged');
324 $this->tags_already_output[] = $tag->tag;
327 $this->elementEnd('item');
328 $this->creators[$creator_uri] = $profile;
331 function showCreators()
333 foreach ($this->creators as $uri => $profile) {
335 $nickname = $profile->nickname;
336 $this->elementStart('foaf:Agent', array('rdf:about' => $uri));
337 $this->element('foaf:nick', null, $nickname);
338 if ($profile->fullname) {
339 $this->element('foaf:name', null, $profile->fullname);
341 $this->element('foaf:holdsAccount', array('rdf:resource' => $uri.'#acct'));
342 $avatar = $profile->avatarUrl();
343 $this->element('foaf:depiction', array('rdf:resource' => $avatar));
344 $this->elementEnd('foaf:Agent');
350 $channel = $this->getChannel();
351 header('Content-Type: application/rdf+xml');
354 $this->elementStart('rdf:RDF', array('xmlns:rdf' =>
355 'http://www.w3.org/1999/02/22-rdf-syntax-ns#',
357 'http://purl.org/dc/elements/1.1/',
359 'http://creativecommons.org/ns#',
361 'http://purl.org/rss/1.0/modules/content/',
363 'http://commontag.org/ns#',
365 'http://xmlns.com/foaf/0.1/',
367 'http://purl.oclc.org/net/rss_2.0/enc#',
369 'http://rdfs.org/sioc/ns#',
371 'http://rdfs.org/sioc/types#',
373 'http://www.w3.org/2000/01/rdf-schema#',
375 'http://www.w3.org/2003/01/geo/wgs84_pos#',
377 'http://status.net/ont/',
378 'xmlns' => 'http://purl.org/rss/1.0/'));
379 $this->elementStart('sioc:Site', array('rdf:about' => common_root_url()));
380 $this->element('sioc:name', null, common_config('site', 'name'));
381 $this->elementStart('sioc:space_of');
382 $this->element('sioc:Container', array('rdf:about' =>
384 $this->elementEnd('sioc:space_of');
385 $this->elementEnd('sioc:Site');
390 $this->elementEnd('rdf:RDF');
394 * When was this page last modified?
398 function lastModified()
400 if (empty($this->notices)) {
404 if (count($this->notices) == 0) {
408 // FIXME: doesn't handle modified profiles, avatars, deleted notices
410 return strtotime($this->notices[0]->created);