lib/rssaction.php

   1 <?php
   2 /**
   3  * Laconica, the distributed open-source microblogging tool
   4  *
   5  * Base class for RSS 1.0 feed actions
   6  *
   7  * PHP version 5
   8  *
   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.
  13  *
  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.
  18  *
  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/>.
  21  *
  22  * @category  Mail
  23  * @package   Laconica
  24  * @author    Evan Prodromou <evan@controlyourself.ca>
  25  * @author    Earle Martin <earle@downlode.org>
  26  * @copyright 2008-9 Control Yourself, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://laconi.ca/
  29  */
  30
  31 if (!defined('LACONICA')) { exit(1); }
  32
  33 define('DEFAULT_RSS_LIMIT', 48);
  34
  35 class Rss10Action extends Action
  36 {
  37     # This will contain the details of each feed item's author and be used to generate SIOC data.
  38
  39     var $creators = array();
  40     var $limit = DEFAULT_RSS_LIMIT;
  41     var $notices = null;
  42
  43     /**
  44      * Constructor
  45      *
  46      * Just wraps the Action constructor.
  47      *
  48      * @param string  $output URI to output to, default = stdout
  49      * @param boolean $indent Whether to indent output, default true
  50      *
  51      * @see Action::__construct
  52      */
  53
  54     function __construct($output='php://output', $indent=true)
  55     {
  56         parent::__construct($output, $indent);
  57     }
  58
  59     /**
  60      * Do we need to write to the database?
  61      *
  62      * @return boolean true
  63      */
  64
  65     function isReadonly()
  66     {
  67         return true;
  68     }
  69
  70     /**
  71      * Read arguments and initialize members
  72      *
  73      * @param array $args Arguments from $_REQUEST
  74      * @return boolean success
  75      */
  76
  77     function prepare($args)
  78     {
  79         parent::prepare($args);
  80         $this->limit = (int) $this->trimmed('limit');
  81         if ($this->limit == 0) {
  82             $this->limit = DEFAULT_RSS_LIMIT;
  83         }
  84         return true;
  85     }
  86
  87     /**
  88      * Handle a request
  89      *
  90      * @param array $args Arguments from $_REQUEST
  91      *
  92      * @return void
  93      */
  94
  95     function handle($args)
  96     {
  97         // Get the list of notices
  98         $this->notices = $this->getNotices();
  99         // Parent handling, including cache check
 100         parent::handle($args);
 101         $this->showRss($this->limit);
 102     }
 103
 104     /**
 105      * Get the notices to output in this stream
 106      *
 107      * @return array an array of Notice objects sorted in reverse chron
 108      */
 109
 110     function getNotices()
 111     {
 112         return array();
 113     }
 114
 115     /**
 116      * Get a description of the channel
 117      *
 118      * Returns an array with the following
 119      * @return array
 120      */
 121
 122     function getChannel()
 123     {
 124         return array('url' => '',
 125                      'title' => '',
 126                      'link' => '',
 127                      'description' => '');
 128     }
 129
 130     function getImage()
 131     {
 132         return null;
 133     }
 134
 135     function showRss($limit=0)
 136     {
 137         $notices = $this->getNotices($limit);
 138
 139         $this->initRss();
 140         $this->showChannel($notices);
 141         $this->showImage();
 142
 143         foreach ($notices as $n) {
 144             $this->showItem($n);
 145         }
 146
 147         $this->showCreators();
 148         $this->endRss();
 149     }
 150
 151     function showChannel($notices)
 152     {
 153
 154         $channel = $this->getChannel();
 155         $image = $this->getImage();
 156
 157         $this->elementStart('channel', array('rdf:about' => $channel['url']));
 158         $this->element('title', null, $channel['title']);
 159         $this->element('link', null, $channel['link']);
 160         $this->element('description', null, $channel['description']);
 161         $this->element('cc:licence', array('rdf:resource' => common_config('license','url')));
 162
 163         if ($image) {
 164             $this->element('image', array('rdf:resource' => $image));
 165         }
 166
 167         $this->elementStart('items');
 168         $this->elementStart('rdf:Seq');
 169
 170         foreach ($notices as $notice) {
 171             $this->element('sioct:MicroblogPost', array('rdf:resource' => $notice->uri));
 172         }
 173
 174         $this->elementEnd('rdf:Seq');
 175         $this->elementEnd('items');
 176
 177         $this->elementEnd('channel');
 178     }
 179
 180     function showImage()
 181     {
 182         $image = $this->getImage();
 183         if ($image) {
 184             $channel = $this->getChannel();
 185             $this->elementStart('image', array('rdf:about' => $image));
 186             $this->element('title', null, $channel['title']);
 187             $this->element('link', null, $channel['link']);
 188             $this->element('url', null, $image);
 189             $this->elementEnd('image');
 190         }
 191     }
 192
 193     function showItem($notice)
 194     {
 195         $profile = Profile::staticGet($notice->profile_id);
 196         $nurl = common_local_url('shownotice', array('notice' => $notice->id));
 197         $creator_uri = common_profile_uri($profile);
 198         $this->elementStart('item', array('rdf:about' => $notice->uri));
 199         $title = $profile->nickname . ': ' . common_xml_safe_str(trim($notice->content));
 200         $this->element('title', null, $title);
 201         $this->element('link', null, $nurl);
 202         $this->element('description', null, $profile->nickname."'s status on ".common_exact_date($notice->created));
 203         $this->element('dc:date', null, common_date_w3dtf($notice->created));
 204         $this->element('dc:creator', null, ($profile->fullname) ? $profile->fullname : $profile->nickname);
 205         $this->element('sioc:has_creator', array('rdf:resource' => $creator_uri));
 206         $this->element('laconica:postIcon', array('rdf:resource' => $profile->avatarUrl()));
 207         $this->element('cc:licence', array('rdf:resource' => common_config('license', 'url')));
 208         $this->elementEnd('item');
 209         $this->creators[$creator_uri] = $profile;
 210     }
 211
 212     function showCreators()
 213     {
 214         foreach ($this->creators as $uri => $profile) {
 215             $id = $profile->id;
 216             $nickname = $profile->nickname;
 217             $this->elementStart('sioc:User', array('rdf:about' => $uri));
 218             $this->element('foaf:nick', null, $nickname);
 219             if ($profile->fullname) {
 220                 $this->element('foaf:name', null, $profile->fullname);
 221             }
 222             $this->element('sioc:id', null, $id);
 223             $avatar = $profile->avatarUrl();
 224             $this->element('sioc:avatar', array('rdf:resource' => $avatar));
 225             $this->elementEnd('sioc:User');
 226         }
 227     }
 228
 229     function initRss()
 230     {
 231         $channel = $this->getChannel();
 232         header('Content-Type: application/rdf+xml');
 233
 234         $this->startXml();
 235         $this->elementStart('rdf:RDF', array('xmlns:rdf' =>
 236                                               'http://www.w3.org/1999/02/22-rdf-syntax-ns#',
 237                                               'xmlns:dc' =>
 238                                               'http://purl.org/dc/elements/1.1/',
 239                                               'xmlns:cc' =>
 240                                               'http://web.resource.org/cc/',
 241                                               'xmlns:content' =>
 242                                               'http://purl.org/rss/1.0/modules/content/',
 243                                               'xmlns:foaf' =>
 244                                               'http://xmlns.com/foaf/0.1/',
 245                                               'xmlns:sioc' =>
 246                                               'http://rdfs.org/sioc/ns#',
 247                                               'xmlns:sioct' =>
 248                                               'http://rdfs.org/sioc/types#',
 249                                               'xmlns:laconica' =>
 250                                               'http://laconi.ca/ont/',
 251                                               'xmlns' => 'http://purl.org/rss/1.0/'));
 252         $this->elementStart('sioc:Site', array('rdf:about' => common_root_url()));
 253         $this->element('sioc:name', null, common_config('site', 'name'));
 254         $this->elementStart('sioc:container_of');
 255         $this->element('sioc:Container', array('rdf:about' =>
 256                                                $channel['url']));
 257         $this->elementEnd('sioc:container_of');
 258         $this->elementEnd('sioc:Site');
 259     }
 260
 261     function endRss()
 262     {
 263         $this->elementEnd('rdf:RDF');
 264     }
 265
 266     /**
 267      * When was this page last modified?
 268      *
 269      */
 270
 271     function lastModified()
 272     {
 273         if (empty($this->notices)) {
 274             return null;
 275         }
 276
 277         if (count($this->notices) == 0) {
 278             return null;
 279         }
 280
 281         // FIXME: doesn't handle modified profiles, avatars, deleted notices
 282
 283         return strtotime($this->notices[0]->created);
 284     }
 285 }
 286