X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=lib%2Frssaction.php;h=0c8188e88021a8aca153d0eefb09ecf2b5805861;hb=83adf9fa1ab9d288e86fba9907be11454c3e0e28;hp=0152f25bc76acc9ff7a3edd44df484ff22eabc4b;hpb=e0c3bf5a75094937315aa09dd9635833f9eb2925;p=quix0rs-gnu-social.git diff --git a/lib/rssaction.php b/lib/rssaction.php index 0152f25bc7..0c8188e880 100644 --- a/lib/rssaction.php +++ b/lib/rssaction.php @@ -1,9 +1,12 @@ . + * + * @category Mail + * @package Laconica + * @author Evan Prodromou + * @author Earle Martin + * @copyright 2008-9 Control Yourself, Inc. + * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0 + * @link http://laconi.ca/ */ if (!defined('LACONICA')) { exit(1); } define('DEFAULT_RSS_LIMIT', 48); -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(); - - function is_readonly() { - return true; - } - - function handle($args) { - parent::handle($args); - $limit = (int) $this->trimmed('limit'); - if ($limit == 0) { - $limit = DEFAULT_RSS_LIMIT; - } - $this->show_rss($limit); - } - - function init() { - return true; - } - - function get_notices() { - return array(); - } - - function get_channel() { - return array('url' => '', - 'title' => '', - 'link' => '', - 'description' => ''); - } - - function get_image() { - return NULL; - } - - function show_rss($limit=0) { - - if (!$this->init()) { - return; - } - - $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(); - } - - function show_channel($notices) { - - $channel = $this->get_channel(); - $image = $this->get_image(); - - 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'))); - - if ($image) { - common_element('image', array('rdf:resource' => $image)); - } - - common_element_start('items'); - common_element_start('rdf:Seq'); - - foreach ($notices as $notice) { - common_element('sioct:MicroblogPost', array('rdf:resource' => $notice->uri)); - } - - common_element_end('rdf:Seq'); - common_element_end('items'); - - common_element_end('channel'); - } - - function show_image() { - $image = $this->get_image(); - 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'); - } - } - - function show_item($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)); - $title = $profile->nickname . ': ' . common_xml_safe_str($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->creators[$creator_uri] = $profile; - } - - function show_creators() { - 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); - if ($profile->fullname) { - common_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'); - } - } - - function init_rss() { - $channel = $this->get_channel(); - - header('Content-Type: application/rdf+xml'); - - common_start_xml(); - common_element_start('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/', - 'xmlns:foaf' => - 'http://xmlns.com/foaf/0.1/', - 'xmlns:sioc' => - 'http://rdfs.org/sioc/ns#', - 'xmlns:sioct' => - 'http://rdfs.org/sioc/types#', - 'xmlns:laconica' => - 'http://laconi.ca/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' => - $channel['url'])); - common_element_end('sioc:container_of'); - common_element_end('sioc:Site'); - } - - function end_rss() { - common_element_end('rdf:RDF'); - } +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; + + /** + * 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 isReadonly() + { + return true; + } + + /** + * 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; + } + return true; + } + + /** + * Handle a request + * + * @param array $args Arguments from $_REQUEST + * + * @return void + */ + + function handle($args) + { + // Parent handling, including cache check + parent::handle($args); + // Get the list of notices + if (empty($this->tag)) { + $this->notices = $this->getNotices($this->limit); + } else { + $this->notices = $this->getTaggedNotices($this->tag, $this->limit); + } + $this->showRss(); + } + + /** + * Get the notices to output in this stream + * + * @return array an array of Notice objects sorted in reverse chron + */ + + function getNotices() + { + return array(); + } + + /** + * Get a description of the channel + * + * Returns an array with the following + * @return array + */ + + function getChannel() + { + return array('url' => '', + 'title' => '', + 'link' => '', + 'description' => ''); + } + + function getImage() + { + return null; + } + + function showRss() + { + $this->initRss(); + $this->showChannel(); + $this->showImage(); + + foreach ($this->notices as $n) { + $this->showItem($n); + } + + $this->showCreators(); + $this->endRss(); + } + + function showChannel() + { + + $channel = $this->getChannel(); + $image = $this->getImage(); + + $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) { + $this->element('image', array('rdf:resource' => $image)); + } + + $this->elementStart('items'); + $this->elementStart('rdf:Seq'); + + foreach ($this->notices as $notice) { + $this->element('rdf:li', array('rdf:resource' => $notice->uri)); + } + + $this->elementEnd('rdf:Seq'); + $this->elementEnd('items'); + + $this->elementEnd('channel'); + } + + function showImage() + { + $image = $this->getImage(); + if ($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 showItem($notice) + { + $profile = Profile::staticGet($notice->profile_id); + $nurl = common_local_url('shownotice', array('notice' => $notice->id)); + $creator_uri = common_profile_uri($profile); + $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)); + $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')); + $this->element('laconica: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)); + } + $this->elementEnd('item'); + $this->creators[$creator_uri] = $profile; + } + + function showCreators() + { + foreach ($this->creators as $uri => $profile) { + $id = $profile->id; + $nickname = $profile->nickname; + $this->elementStart('foaf:Agent', array('rdf:about' => $uri)); + $this->element('foaf:nick', null, $nickname); + if ($profile->fullname) { + $this->element('foaf:name', null, $profile->fullname); + } + $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 initRss() + { + $channel = $this->getChannel(); + header('Content-Type: application/rdf+xml'); + + $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://creativecommons.org/ns#', + 'xmlns:content' => + 'http://purl.org/rss/1.0/modules/content/', + 'xmlns:foaf' => + 'http://xmlns.com/foaf/0.1/', + 'xmlns:sioc' => + 'http://rdfs.org/sioc/ns#', + 'xmlns:sioct' => + 'http://rdfs.org/sioc/types#', + 'xmlns:laconica' => + 'http://laconi.ca/ont/', + 'xmlns' => 'http://purl.org/rss/1.0/')); + $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'])); + $this->elementEnd('sioc:space_of'); + $this->elementEnd('sioc:Site'); + } + + 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); + } } +