]> git.mxchange.org Git - quix0rs-gnu-social.git/commitdiff
abstract out RSS 1.0 generation to allow multiple streams
authorEvan Prodromou <evan@prodromou.name>
Thu, 22 May 2008 11:29:54 +0000 (07:29 -0400)
committerEvan Prodromou <evan@prodromou.name>
Thu, 22 May 2008 11:29:54 +0000 (07:29 -0400)
darcs-hash:20080522112954-84dde-aa5087977298f5169148383e82e22241e613b1f2.gz

actions/rss10.php [deleted file]
actions/showstream.php
actions/userrss.php [new file with mode: 0644]
doc/TODO
lib/action.php
lib/rssaction.php [new file with mode: 0644]

diff --git a/actions/rss10.php b/actions/rss10.php
deleted file mode 100644 (file)
index bae4e86..0000000
+++ /dev/null
@@ -1,133 +0,0 @@
-<?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); }
-
-class Rss10Action extends Action {
-
-       function 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');
-               
-               $this->show_rss($user, $limit);
-       }
-       
-       function show_rss($user, $limit=0) {
-               
-               global $config;
-               
-               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/'));
-
-               $notices = $this->get_notices($user, $limit);
-               $this->show_channel($user, $notices);
-               
-               foreach ($notices as $n) {
-                       $this->show_item($n);
-               }
-               
-               common_element_end('rdf:RDF');
-       }
-       
-       function get_notices($user, $limit=0) {
-               $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 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('rdf:Seq');
-               foreach ($notices as $n) {
-                       common_element('rdf:li', array('rdf:resource' =>
-                                                                                  common_local_url('shownotice',
-                                                                                                                       array('notice' => $n->id))));
-               }
-               
-               common_element_end('rdf:Seq');
-               common_element_end('items');
-               common_element_end('channel');
-               
-               if ($avatar) {
-                       common_element_start('image', array('rdf:about' => $avatar->url));
-                       common_element('title', NULL, $user->nickname);
-                       common_element('link', NULL, $profile->profileurl);
-                       common_element('url', NULL, $avatar->url);
-                       common_element_end('image');
-               }
-       }
-       
-       function show_item($notice) {
-               $nurl = common_local_url('shownotice', array('notice' => $notice->id));
-               common_element_start('item', array('rdf:about' => $nurl));
-               common_element('title', NULL, $notice->created);
-               common_element('link', NULL, $nurl);
-               common_element('description', NULL, common_render_content($notice->content));
-               common_element('dc:date', NULL, common_date_w3dtf($notice->created));
-               common_element_end('item');
-       }
-}
\ No newline at end of file
index dd849f093645115d92dfc7d9aac5ce4bbeb478ca..3de9a6e23bd4f4f85e1a7d387719f26ab1b5957b 100644 (file)
@@ -64,7 +64,7 @@ class ShowstreamAction extends StreamAction {
 
        function show_header($user) {
                common_element('link', array('rel' => 'alternate',
-                                                                        'href' => common_local_url('rss10', array('nickname' =>
+                                                                        'href' => common_local_url('userrss', array('nickname' =>
                                                                                                                                                           $user->nickname)),
                                                                         'type' => 'application/rss+xml',
                                                                         'title' => _t('Notice feed for ') . $user->nickname));
diff --git a/actions/userrss.php b/actions/userrss.php
new file mode 100644 (file)
index 0000000..92a6bcc
--- /dev/null
@@ -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;
+       }
+}
\ No newline at end of file
index d6d0309f74f59af7fe768ae03d70b87b20b2f8f6..146a364c48ddbc421b1512b4687451e9ed732e69 100644 (file)
--- a/doc/TODO
+++ b/doc/TODO
 - FOAF dump for user
 - license on showstream
 - license on shownotice
+- license in RSS feeds
 - TOS checkbox on register
 - instructions
-- deal with PHP quotes escaping
++ deal with PHP quotes escaping
 - fix spacing on notices
 - fix spacing in profile
 - limit entry in textarea to 140 chars
 - source link in footer menu
 - public stream link in top menu
 - AGPL notification
+- gettext
+- pretty URLs
 - release 0.2
 - Automatically linkify URLs in notices
 - RDF dump of entire site
-- pretty URLs
 - use only canonical email addresses
 - license per notice
 - allow mixed-case usernames
@@ -80,7 +82,6 @@
 - theme per profile
 - email confirmation for registration
 - change cookie handling for anon users to be more cache-friendly
-- gettext
 - subscribe remote
 - add subscriber remote
 - send remote notice
index c346c751313482206230f1d016a7379bfdc62005..67eaf9ed7a65fbaad400a16794687a600fb37215 100644 (file)
@@ -46,4 +46,16 @@ class Action { // lawsuit
                        $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;
+       }
 }
diff --git a/lib/rssaction.php b/lib/rssaction.php
new file mode 100644 (file)
index 0000000..9d4066e
--- /dev/null
@@ -0,0 +1,133 @@
+<?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); }
+
+class Rss10Action extends Action {
+
+       function handle($args) {
+               parent::handle($args);
+               
+               $limit = (int) $this->trimmed('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->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']);
+
+               if ($image) {
+                       common_element('image', array('rdf:resource' => $image));
+               }
+
+               common_element_start('items');
+               common_element_start('rdf:Seq');
+               foreach ($notices as $n) {
+                       common_element('rdf:li', array('rdf:resource' =>
+                                                                                  common_local_url('shownotice',
+                                                                                                                       array('notice' => $n->id))));
+               }
+               
+               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) {
+               $nurl = common_local_url('shownotice', array('notice' => $notice->id));
+               common_element_start('item', array('rdf:about' => $nurl));
+               common_element('title', NULL, $notice->created);
+               common_element('link', NULL, $nurl);
+               common_element('description', NULL, common_render_content($notice->content));
+               common_element('dc:date', NULL, common_date_w3dtf($notice->created));
+               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');
+       }
+}
\ No newline at end of file