<?php
-/*
- * Laconica - a distributed open-source microblogging tool
- * Copyright (C) 2008, Controlez-Vous, Inc.
+/**
+ * StatusNet, the distributed open-source microblogging tool
*
- * This program is free software: you can redistribute it and/or modify
+ * Base class for RSS 1.0 feed actions
+ *
+ * PHP version 5
+ *
+ * LICENCE: This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @category Mail
+ * @package StatusNet
+ * @author Evan Prodromou <evan@status.net>
+ * @author Earle Martin <earle@downlode.org>
+ * @copyright 2008-9 StatusNet, Inc.
+ * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link http://status.net/
*/
-if (!defined('LACONICA')) { exit(1); }
+if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
define('DEFAULT_RSS_LIMIT', 48);
-class Rss10Action extends Action {
-
+class Rss10Action extends Action
+{
# This will contain the details of each feed item's author and be used to generate SIOC data.
+
var $creators = array();
+ var $limit = DEFAULT_RSS_LIMIT;
+ var $notices = null;
+ var $tags_already_output = array();
+
+ /**
+ * Constructor
+ *
+ * Just wraps the Action constructor.
+ *
+ * @param string $output URI to output to, default = stdout
+ * @param boolean $indent Whether to indent output, default true
+ *
+ * @see Action::__construct
+ */
+
+ function __construct($output='php://output', $indent=true)
+ {
+ parent::__construct($output, $indent);
+ }
+
+ /**
+ * Do we need to write to the database?
+ *
+ * @return boolean true
+ */
- function is_readonly() {
+ function isReadonly()
+ {
return true;
}
- function handle($args) {
- parent::handle($args);
- $limit = (int) $this->trimmed('limit');
- if ($limit == 0) {
- $limit = DEFAULT_RSS_LIMIT;
+ /**
+ * Read arguments and initialize members
+ *
+ * @param array $args Arguments from $_REQUEST
+ * @return boolean success
+ */
+
+ function prepare($args)
+ {
+ parent::prepare($args);
+
+ $this->limit = (int) $this->trimmed('limit');
+
+ if ($this->limit == 0) {
+ $this->limit = DEFAULT_RSS_LIMIT;
+ }
+
+ if (common_config('site', 'private')) {
+ if (!isset($_SERVER['PHP_AUTH_USER'])) {
+
+ # This header makes basic auth go
+ header('WWW-Authenticate: Basic realm="StatusNet RSS"');
+
+ # If the user hits cancel -- bam!
+ $this->show_basic_auth_error();
+ return;
+ } else {
+ $nickname = $_SERVER['PHP_AUTH_USER'];
+ $password = $_SERVER['PHP_AUTH_PW'];
+
+ if (!common_check_user($nickname, $password)) {
+ # basic authentication failed
+ list($proxy, $ip) = common_client_ip();
+
+ common_log(LOG_WARNING, "Failed RSS auth attempt, nickname = $nickname, proxy = $proxy, ip = $ip.");
+ $this->show_basic_auth_error();
+ return;
+ }
+ }
}
- $this->show_rss($limit);
- }
- function init() {
return true;
}
- function get_notices() {
+ /**
+ * Handle a request
+ *
+ * @param array $args Arguments from $_REQUEST
+ *
+ * @return void
+ */
+
+ function handle($args)
+ {
+ // Parent handling, including cache check
+ parent::handle($args);
+ $this->showRss();
+ }
+
+ function show_basic_auth_error()
+ {
+ header('HTTP/1.1 401 Unauthorized');
+ header('Content-Type: application/xml; charset=utf-8');
+ $this->startXML();
+ $this->elementStart('hash');
+ $this->element('error', null, 'Could not authenticate you.');
+ $this->element('request', null, $_SERVER['REQUEST_URI']);
+ $this->elementEnd('hash');
+ $this->endXML();
+ }
+
+ /**
+ * Get the notices to output in this stream.
+ *
+ * @return array an array of Notice objects sorted in reverse chron
+ */
+
+ function getNotices()
+ {
return array();
}
- function get_channel() {
+ /**
+ * Get a description of the channel
+ *
+ * Returns an array with the following
+ * @return array
+ */
+
+ function getChannel()
+ {
return array('url' => '',
'title' => '',
'link' => '',
'description' => '');
}
- function get_image() {
+ function getImage()
+ {
return null;
}
- function show_rss($limit=0) {
+ function showRss()
+ {
+ $this->initRss();
+ $this->showChannel();
+ $this->showImage();
- if (!$this->init()) {
- return;
+ foreach ($this->notices as $n) {
+ $this->showItem($n);
}
- $notices = $this->get_notices($limit);
-
- $this->init_rss();
- $this->show_channel($notices);
- $this->show_image();
-
- foreach ($notices as $n) {
- $this->show_item($n);
- }
-
- $this->show_creators();
- $this->end_rss();
+ $this->showCreators();
+ $this->endRss();
}
- function show_channel($notices) {
+ function showChannel()
+ {
- $channel = $this->get_channel();
- $image = $this->get_image();
+ $channel = $this->getChannel();
+ $image = $this->getImage();
- common_element_start('channel', array('rdf:about' => $channel['url']));
- common_element('title', null, $channel['title']);
- common_element('link', null, $channel['link']);
- common_element('description', null, $channel['description']);
- common_element('cc:licence', array('rdf:resource' => common_config('license','url')));
+ $this->elementStart('channel', array('rdf:about' => $channel['url']));
+ $this->element('title', null, $channel['title']);
+ $this->element('link', null, $channel['link']);
+ $this->element('description', null, $channel['description']);
+ $this->element('cc:licence', array('rdf:resource' => common_config('license','url')));
if ($image) {
- common_element('image', array('rdf:resource' => $image));
+ $this->element('image', array('rdf:resource' => $image));
}
- common_element_start('items');
- common_element_start('rdf:Seq');
+ $this->elementStart('items');
+ $this->elementStart('rdf:Seq');
- foreach ($notices as $notice) {
- common_element('sioct:MicroblogPost', array('rdf:resource' => $notice->uri));
+ foreach ($this->notices as $notice) {
+ $this->element('rdf:li', array('rdf:resource' => $notice->uri));
}
- common_element_end('rdf:Seq');
- common_element_end('items');
+ $this->elementEnd('rdf:Seq');
+ $this->elementEnd('items');
- common_element_end('channel');
+ $this->elementEnd('channel');
}
- function show_image() {
- $image = $this->get_image();
+ function showImage()
+ {
+ $image = $this->getImage();
if ($image) {
- $channel = $this->get_channel();
- common_element_start('image', array('rdf:about' => $image));
- common_element('title', null, $channel['title']);
- common_element('link', null, $channel['link']);
- common_element('url', null, $image);
- common_element_end('image');
+ $channel = $this->getChannel();
+ $this->elementStart('image', array('rdf:about' => $image));
+ $this->element('title', null, $channel['title']);
+ $this->element('link', null, $channel['link']);
+ $this->element('url', null, $image);
+ $this->elementEnd('image');
}
}
- function show_item($notice) {
+ function showItem($notice)
+ {
$profile = Profile::staticGet($notice->profile_id);
$nurl = common_local_url('shownotice', array('notice' => $notice->id));
$creator_uri = common_profile_uri($profile);
- common_element_start('item', array('rdf:about' => $notice->uri));
+ $this->elementStart('item', array('rdf:about' => $notice->uri,
+ 'rdf:type' => 'http://rdfs.org/sioc/types#MicroblogPost'));
$title = $profile->nickname . ': ' . common_xml_safe_str(trim($notice->content));
- common_element('title', null, $title);
- common_element('link', null, $nurl);
- common_element('description', null, $profile->nickname."'s status on ".common_exact_date($notice->created));
- common_element('dc:date', null, common_date_w3dtf($notice->created));
- common_element('dc:creator', null, ($profile->fullname) ? $profile->fullname : $profile->nickname);
- common_element('sioc:has_creator', array('rdf:resource' => $creator_uri));
- common_element('laconica:postIcon', array('rdf:resource' => common_profile_avatar_url($profile)));
- common_element('cc:licence', array('rdf:resource' => common_config('license', 'url')));
- common_element_end('item');
+ $this->element('title', null, $title);
+ $this->element('link', null, $nurl);
+ $this->element('description', null, $profile->nickname."'s status on ".common_exact_date($notice->created));
+ if ($notice->rendered) {
+ $this->element('content:encoded', null, common_xml_safe_str($notice->rendered));
+ }
+ $this->element('dc:date', null, common_date_w3dtf($notice->created));
+ $this->element('dc:creator', null, ($profile->fullname) ? $profile->fullname : $profile->nickname);
+ $this->element('foaf:maker', array('rdf:resource' => $creator_uri));
+ $this->element('sioc:has_creator', array('rdf:resource' => $creator_uri.'#acct'));
+ $location = $notice->getLocation();
+ if ($location && isset($location->lat) && isset($location->lon)) {
+ $location_uri = $location->getRdfURL();
+ $attrs = array('geo:lat' => $location->lat,
+ 'geo:long' => $location->lon);
+ if (strlen($location_uri)) {
+ $attrs['rdf:resource'] = $location_uri;
+ }
+ $this->element('statusnet:origin', $attrs);
+ }
+ $this->element('statusnet:postIcon', array('rdf:resource' => $profile->avatarUrl()));
+ $this->element('cc:licence', array('rdf:resource' => common_config('license', 'url')));
+ if ($notice->reply_to) {
+ $replyurl = common_local_url('shownotice', array('notice' => $notice->reply_to));
+ $this->element('sioc:reply_of', array('rdf:resource' => $replyurl));
+ }
+ if (!empty($notice->conversation)) {
+ $conversationurl = common_local_url('conversation',
+ array('id' => $notice->conversation));
+ $this->element('sioc:has_discussion', array('rdf:resource' => $conversationurl));
+ }
+ $attachments = $notice->attachments();
+ if($attachments){
+ foreach($attachments as $attachment){
+ $enclosure=$attachment->getEnclosure();
+ if ($enclosure) {
+ $attribs = array('rdf:resource' => $enclosure->url);
+ if ($enclosure->title) {
+ $attribs['dc:title'] = $enclosure->title;
+ }
+ if ($enclosure->modified) {
+ $attribs['dc:date'] = common_date_w3dtf($enclosure->modified);
+ }
+ if ($enclosure->size) {
+ $attribs['enc:length'] = $enclosure->size;
+ }
+ if ($enclosure->mimetype) {
+ $attribs['enc:type'] = $enclosure->mimetype;
+ }
+ $this->element('enc:enclosure', $attribs);
+ }
+ $this->element('sioc:links_to', array('rdf:resource'=>$attachment->url));
+ }
+ }
+
+ $tag = new Notice_tag();
+ $tag->notice_id = $notice->id;
+ if ($tag->find()) {
+ $entry['tags']=array();
+ while ($tag->fetch()) {
+ $tagpage = common_local_url('tag', array('tag' => $tag->tag));
+
+ if ( in_array($tag, $this->tags_already_output) ) {
+ $this->element('ctag:tagged', array('rdf:resource'=>$tagpage.'#concept'));
+ continue;
+ }
+
+ $tagrss = common_local_url('tagrss', array('tag' => $tag->tag));
+ $this->elementStart('ctag:tagged');
+ $this->elementStart('ctag:Tag', array('rdf:about'=>$tagpage.'#concept', 'ctag:label'=>$tag->tag));
+ $this->element('foaf:page', array('rdf:resource'=>$tagpage));
+ $this->element('rdfs:seeAlso', array('rdf:resource'=>$tagrss));
+ $this->elementEnd('ctag:Tag');
+ $this->elementEnd('ctag:tagged');
+
+ $this->tags_already_output[] = $tag->tag;
+ }
+ }
+ $this->elementEnd('item');
$this->creators[$creator_uri] = $profile;
}
- function show_creators() {
+ function showCreators()
+ {
foreach ($this->creators as $uri => $profile) {
$id = $profile->id;
$nickname = $profile->nickname;
- common_element_start('sioc:User', array('rdf:about' => $uri));
- common_element('foaf:nick', null, $nickname);
+ $this->elementStart('foaf:Agent', array('rdf:about' => $uri));
+ $this->element('foaf:nick', null, $nickname);
if ($profile->fullname) {
- common_element('foaf:name', null, $profile->fullname);
+ $this->element('foaf:name', null, $profile->fullname);
}
- common_element('sioc:id', null, $id);
- $avatar = common_profile_avatar_url($profile);
- common_element('sioc:avatar', array('rdf:resource' => $avatar));
- common_element_end('sioc:User');
+ $this->element('foaf:holdsAccount', array('rdf:resource' => $uri.'#acct'));
+ $avatar = $profile->avatarUrl();
+ $this->element('foaf:depiction', array('rdf:resource' => $avatar));
+ $this->elementEnd('foaf:Agent');
}
}
- function init_rss() {
- $channel = $this->get_channel();
+ function initRss()
+ {
+ $channel = $this->getChannel();
header('Content-Type: application/rdf+xml');
- common_start_xml();
- common_element_start('rdf:RDF', array('xmlns:rdf' =>
+ $this->startXml();
+ $this->elementStart('rdf:RDF', array('xmlns:rdf' =>
'http://www.w3.org/1999/02/22-rdf-syntax-ns#',
'xmlns:dc' =>
'http://purl.org/dc/elements/1.1/',
'xmlns:cc' =>
- 'http://web.resource.org/cc/',
+ 'http://creativecommons.org/ns#',
'xmlns:content' =>
'http://purl.org/rss/1.0/modules/content/',
+ 'xmlns:ctag' =>
+ 'http://commontag.org/ns#',
'xmlns:foaf' =>
'http://xmlns.com/foaf/0.1/',
+ 'xmlns:enc' =>
+ 'http://purl.oclc.org/net/rss_2.0/enc#',
'xmlns:sioc' =>
'http://rdfs.org/sioc/ns#',
'xmlns:sioct' =>
'http://rdfs.org/sioc/types#',
- 'xmlns:laconica' =>
- 'http://laconi.ca/ont/',
+ 'xmlns:rdfs' =>
+ 'http://www.w3.org/2000/01/rdf-schema#',
+ 'xmlns:geo' =>
+ 'http://www.w3.org/2003/01/geo/wgs84_pos#',
+ 'xmlns:statusnet' =>
+ 'http://status.net/ont/',
'xmlns' => 'http://purl.org/rss/1.0/'));
- common_element_start('sioc:Site', array('rdf:about' => common_root_url()));
- common_element('sioc:name', null, common_config('site', 'name'));
- common_element_start('sioc:container_of');
- common_element('sioc:Container', array('rdf:about' =>
+ $this->elementStart('sioc:Site', array('rdf:about' => common_root_url()));
+ $this->element('sioc:name', null, common_config('site', 'name'));
+ $this->elementStart('sioc:space_of');
+ $this->element('sioc:Container', array('rdf:about' =>
$channel['url']));
- common_element_end('sioc:container_of');
- common_element_end('sioc:Site');
+ $this->elementEnd('sioc:space_of');
+ $this->elementEnd('sioc:Site');
}
- function end_rss() {
- common_element_end('rdf:RDF');
+ function endRss()
+ {
+ $this->elementEnd('rdf:RDF');
+ }
+
+ /**
+ * When was this page last modified?
+ *
+ */
+
+ function lastModified()
+ {
+ if (empty($this->notices)) {
+ return null;
+ }
+
+ if (count($this->notices) == 0) {
+ return null;
+ }
+
+ // FIXME: doesn't handle modified profiles, avatars, deleted notices
+
+ return strtotime($this->notices[0]->created);
}
}
+