abstract out RSS 1.0 generation to allow multiple streams

darcs-hash:20080522112954-84dde-aa5087977298f5169148383e82e22241e613b1f2.gz
This commit is contained in:
Evan Prodromou 2008-05-22 07:29:54 -04:00
parent 5d0bd93eb3
commit 310ef22fd9
5 changed files with 165 additions and 72 deletions

View File

@ -64,7 +64,7 @@ class ShowstreamAction extends StreamAction {
function show_header($user) { function show_header($user) {
common_element('link', array('rel' => 'alternate', common_element('link', array('rel' => 'alternate',
'href' => common_local_url('rss10', array('nickname' => 'href' => common_local_url('userrss', array('nickname' =>
$user->nickname)), $user->nickname)),
'type' => 'application/rss+xml', 'type' => 'application/rss+xml',
'title' => _t('Notice feed for ') . $user->nickname)); 'title' => _t('Notice feed for ') . $user->nickname));

80
actions/userrss.php Normal file
View File

@ -0,0 +1,80 @@
<?php
/*
* Laconica - a distributed open-source microblogging tool
* Copyright (C) 2008, Controlez-Vous, Inc.
*
* 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.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* 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/>.
*/
if (!defined('LACONICA')) { exit(1); }
require_once(INSTALLDIR.'/lib/rssaction.php');
// Formatting of RSS handled by Rss10Action
class UserrssAction extends Rss10Action {
var $user = NULL;
function init() {
$nickname = $this->trimmed('nickname');
$this->user = User::staticGet('nickname', $nickname);
if (!$this->user) {
common_user_error(_t('No such nickname.'));
return false;
} else {
return true;
}
}
function get_notices($limit=0) {
$user = $this->user;
$notices = array();
$notice = DB_DataObject::factory('notice');
$notice->profile_id = $user->id; # user id === profile id
$notice->orderBy('created DESC');
if ($limit != 0) {
$notice->limit(0, $limit);
}
$notice->find();
while ($notice->fetch()) {
$notices[] = clone($notice);
}
return $notices;
}
function get_channel() {
$user = $this->user;
$profile = $user->getProfile();
$c = array('url' => common_local_url('userrss',
array('nickname' =>
$user->nickname)),
'title' => $user->nickname,
'link' => $profile->profileurl,
'description' => _t('Microblog by ') . $user->nickname);
return $c;
}
function get_image() {
$user = $this->user;
$profile = $user->getProfile();
$avatar = $profile->getAvatar(AVATAR_PROFILE_SIZE);
return ($avatar) ? $avatar->url : NULL;
}
}

View File

@ -52,9 +52,10 @@
- FOAF dump for user - FOAF dump for user
- license on showstream - license on showstream
- license on shownotice - license on shownotice
- license in RSS feeds
- TOS checkbox on register - TOS checkbox on register
- instructions - instructions
- deal with PHP quotes escaping + deal with PHP quotes escaping
- fix spacing on notices - fix spacing on notices
- fix spacing in profile - fix spacing in profile
- limit entry in textarea to 140 chars - limit entry in textarea to 140 chars
@ -64,10 +65,11 @@
- source link in footer menu - source link in footer menu
- public stream link in top menu - public stream link in top menu
- AGPL notification - AGPL notification
- gettext
- pretty URLs
- release 0.2 - release 0.2
- Automatically linkify URLs in notices - Automatically linkify URLs in notices
- RDF dump of entire site - RDF dump of entire site
- pretty URLs
- use only canonical email addresses - use only canonical email addresses
- license per notice - license per notice
- allow mixed-case usernames - allow mixed-case usernames
@ -80,7 +82,6 @@
- theme per profile - theme per profile
- email confirmation for registration - email confirmation for registration
- change cookie handling for anon users to be more cache-friendly - change cookie handling for anon users to be more cache-friendly
- gettext
- subscribe remote - subscribe remote
- add subscriber remote - add subscriber remote
- send remote notice - send remote notice

View File

@ -46,4 +46,16 @@ class Action { // lawsuit
$this->args[$k] = ($strip) ? stripslashes($v) : $v; $this->args[$k] = ($strip) ? stripslashes($v) : $v;
} }
} }
function boolean($key, $def=false) {
$arg = $this->arg($key);
return (is_null($arg)) ? $def :
(strcasecmp($arg, 'true')) ? true :
(strcasecmp($arg, 'yes')) ? true :
(strcasecmp($arg, '1')) ? true :
(strcasecmp($arg, 'false')) ? false :
(strcasecmp($arg, 'no')) ? false :
(strcasecmp($arg, '0')) ? false :
$def;
}
} }

View File

@ -24,80 +24,61 @@ class Rss10Action extends Action {
function handle($args) { function handle($args) {
parent::handle($args); parent::handle($args);
$nickname = $this->trimmed('nickname');
if (!$nickname) {
common_user_error(_t('No nickname provided.'));
}
$user = User::staticGet('nickname', $nickname);
if (!$user) {
common_user_error(_t('No such nickname.'));
}
$limit = (int) $this->trimmed('limit'); $limit = (int) $this->trimmed('limit');
$this->show_rss($user, $limit); $this->show_rss($limit);
} }
function show_rss($user, $limit=0) { function init() {
return true;
}
global $config; function get_notices() {
return array();
}
header('Content-Type: application/rdf+xml'); function get_channel() {
return array('url' => '',
'title' => '',
'link' => '',
'description' => '');
}
common_start_xml(); function get_image() {
common_element_start('rdf:RDF', array('xmlns:rdf' => return NULL;
'http://www.w3.org/1999/02/22-rdf-syntax-ns#', }
'xmlns:dc' =>
'http://purl.org/dc/elements/1.1/',
'xmlns' => 'http://purl.org/rss/1.0/'));
$notices = $this->get_notices($user, $limit); function show_rss($limit=0) {
$this->show_channel($user, $notices);
if (!$this->init()) {
return;
}
$notices = $this->get_notices($limit);
$this->init_rss();
$this->show_channel($notices);
$this->show_image();
foreach ($notices as $n) { foreach ($notices as $n) {
$this->show_item($n); $this->show_item($n);
} }
common_element_end('rdf:RDF'); $this->end_rss();
} }
function get_notices($user, $limit=0) { function show_channel($notices) {
$notices = array();
$notice = DB_DataObject::factory('notice'); $channel = $this->get_channel();
$notice->profile_id = $user->id; # user id === profile id $image = $this->get_image();
$notice->orderBy('created DESC');
if ($limit != 0) {
$notice->limit(0, $limit);
}
$notice->find();
while ($notice->fetch()) { common_element_start('channel', array('rdf:about' => $channel['url']));
$notices[] = clone($notice); common_element('title', NULL, $channel['title']);
} common_element('link', NULL, $channel['link']);
common_element('description', NULL, $channel['description']);
return $notices; if ($image) {
} common_element('image', array('rdf:resource' => $image));
function show_channel($user, $notices) {
# XXX: this is kind of indirect, eh?
$profile = $user->getProfile();
$avatar = $profile->getAvatar(AVATAR_PROFILE_SIZE);
common_element_start('channel', array('rdf:about' =>
common_local_url('rss10',
array('nickname' =>
$user->nickname))));
common_element('title', NULL, $user->nickname);
common_element('link', NULL, $profile->profileurl);
common_element('description', NULL, _t('Microblog by ') . $user->nickname);
if ($avatar) {
common_element('image', array('rdf:resource' => $avatar->url));
} }
common_element_start('items'); common_element_start('items');
@ -111,12 +92,16 @@ class Rss10Action extends Action {
common_element_end('rdf:Seq'); common_element_end('rdf:Seq');
common_element_end('items'); common_element_end('items');
common_element_end('channel'); common_element_end('channel');
}
if ($avatar) { function show_image() {
common_element_start('image', array('rdf:about' => $avatar->url)); $image = $this->get_image();
common_element('title', NULL, $user->nickname); if ($image) {
common_element('link', NULL, $profile->profileurl); $channel = $this->get_channel();
common_element('url', NULL, $avatar->url); 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'); common_element_end('image');
} }
} }
@ -130,4 +115,19 @@ class Rss10Action extends Action {
common_element('dc:date', NULL, common_date_w3dtf($notice->created)); common_element('dc:date', NULL, common_date_w3dtf($notice->created));
common_element_end('item'); common_element_end('item');
} }
function init_rss() {
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' => 'http://purl.org/rss/1.0/'));
}
function end_rss() {
common_element_end('rdf:RDF');
}
} }