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         // Parent handling, including cache check
  98         parent::handle($args);
  99
 100         if (common_config('site', 'private')) {
 101             if (!isset($_SERVER['PHP_AUTH_USER'])) {
 102
 103                 # This header makes basic auth go
 104                 header('WWW-Authenticate: Basic realm="Laconica RSS"');
 105
 106                 # If the user hits cancel -- bam!
 107                 $this->show_basic_auth_error();
 108                 return;
 109             } else {
 110                 $nickname = $_SERVER['PHP_AUTH_USER'];
 111                 $password = $_SERVER['PHP_AUTH_PW'];
 112
 113                 if (!common_check_user($nickname, $password)) {
 114                     # basic authentication failed
 115                     $this->show_basic_auth_error();
 116                     return;
 117                 }
 118             }
 119         }
 120
 121         // Get the list of notices
 122         if (empty($this->tag)) {
 123             $this->notices = $this->getNotices($this->limit);
 124         } else {
 125             $this->notices = $this->getTaggedNotices($this->tag, $this->limit);
 126         }
 127         $this->showRss();
 128     }
 129
 130     function show_basic_auth_error()
 131     {
 132         header('HTTP/1.1 401 Unauthorized');
 133         header('Content-Type: application/xml; charset=utf-8');
 134         $this->startXML();
 135         $this->elementStart('hash');
 136         $this->element('error', null, 'Could not authenticate you.');
 137         $this->element('request', null, $_SERVER['REQUEST_URI']);
 138         $this->elementEnd('hash');
 139         $this->endXML();
 140     }
 141
 142     /**
 143      * Get the notices to output in this stream
 144      *
 145      * @return array an array of Notice objects sorted in reverse chron
 146      */
 147
 148     function getNotices()
 149     {
 150         return array();
 151     }
 152
 153     /**
 154      * Get a description of the channel
 155      *
 156      * Returns an array with the following
 157      * @return array
 158      */
 159
 160     function getChannel()
 161     {
 162         return array('url' => '',
 163                      'title' => '',
 164                      'link' => '',
 165                      'description' => '');
 166     }
 167
 168     function getImage()
 169     {
 170         return null;
 171     }
 172
 173     function showRss()
 174     {
 175         $this->initRss();
 176         $this->showChannel();
 177         $this->showImage();
 178
 179         foreach ($this->notices as $n) {
 180             $this->showItem($n);
 181         }
 182
 183         $this->showCreators();
 184         $this->endRss();
 185     }
 186
 187     function showChannel()
 188     {
 189
 190         $channel = $this->getChannel();
 191         $image = $this->getImage();
 192
 193         $this->elementStart('channel', array('rdf:about' => $channel['url']));
 194         $this->element('title', null, $channel['title']);
 195         $this->element('link', null, $channel['link']);
 196         $this->element('description', null, $channel['description']);
 197         $this->element('cc:licence', array('rdf:resource' => common_config('license','url')));
 198
 199         if ($image) {
 200             $this->element('image', array('rdf:resource' => $image));
 201         }
 202
 203         $this->elementStart('items');
 204         $this->elementStart('rdf:Seq');
 205
 206         foreach ($this->notices as $notice) {
 207             $this->element('rdf:li', array('rdf:resource' => $notice->uri));
 208         }
 209
 210         $this->elementEnd('rdf:Seq');
 211         $this->elementEnd('items');
 212
 213         $this->elementEnd('channel');
 214     }
 215
 216     function showImage()
 217     {
 218         $image = $this->getImage();
 219         if ($image) {
 220             $channel = $this->getChannel();
 221             $this->elementStart('image', array('rdf:about' => $image));
 222             $this->element('title', null, $channel['title']);
 223             $this->element('link', null, $channel['link']);
 224             $this->element('url', null, $image);
 225             $this->elementEnd('image');
 226         }
 227     }
 228
 229     function showItem($notice)
 230     {
 231         $profile = Profile::staticGet($notice->profile_id);
 232         $nurl = common_local_url('shownotice', array('notice' => $notice->id));
 233         $creator_uri = common_profile_uri($profile);
 234         $this->elementStart('item', array('rdf:about' => $notice->uri,
 235                             'rdf:type' => 'http://rdfs.org/sioc/types#MicroblogPost'));
 236         $title = $profile->nickname . ': ' . common_xml_safe_str(trim($notice->content));
 237         $this->element('title', null, $title);
 238         $this->element('link', null, $nurl);
 239         $this->element('description', null, $profile->nickname."'s status on ".common_exact_date($notice->created));
 240         if ($notice->rendered) {
 241             $this->element('content:encoded', null, common_xml_safe_str($notice->rendered));
 242         }
 243         $this->element('dc:date', null, common_date_w3dtf($notice->created));
 244         $this->element('dc:creator', null, ($profile->fullname) ? $profile->fullname : $profile->nickname);
 245         $this->element('foaf:maker', array('rdf:resource' => $creator_uri));
 246         $this->element('sioc:has_creator', array('rdf:resource' => $creator_uri.'#acct'));
 247         $this->element('laconica:postIcon', array('rdf:resource' => $profile->avatarUrl()));
 248         $this->element('cc:licence', array('rdf:resource' => common_config('license', 'url')));
 249         if ($notice->reply_to) {
 250             $replyurl = common_local_url('shownotice', array('notice' => $notice->reply_to));
 251             $this->element('sioc:reply_of', array('rdf:resource' => $replyurl));
 252         }
 253         $attachments = $notice->attachments();
 254         if($attachments){
 255             foreach($attachments as $attachment){
 256                 $this->element('enc:enclosure', array('rdf:resource'=>$attachment->url,'enc:type'=>$attachment->mimetype,'enc:length'=>$attachment->size), null);
 257             }
 258         }
 259
 260         $this->elementEnd('item');
 261         $this->creators[$creator_uri] = $profile;
 262     }
 263
 264     function showCreators()
 265     {
 266         foreach ($this->creators as $uri => $profile) {
 267             $id = $profile->id;
 268             $nickname = $profile->nickname;
 269             $this->elementStart('foaf:Agent', array('rdf:about' => $uri));
 270             $this->element('foaf:nick', null, $nickname);
 271             if ($profile->fullname) {
 272                 $this->element('foaf:name', null, $profile->fullname);
 273             }
 274             $this->element('foaf:holdsAccount', array('rdf:resource' => $uri.'#acct'));
 275             $avatar = $profile->avatarUrl();
 276             $this->element('foaf:depiction', array('rdf:resource' => $avatar));
 277             $this->elementEnd('foaf:Agent');
 278         }
 279     }
 280
 281     function initRss()
 282     {
 283         $channel = $this->getChannel();
 284         header('Content-Type: application/rdf+xml');
 285
 286         $this->startXml();
 287         $this->elementStart('rdf:RDF', array('xmlns:rdf' =>
 288                                               'http://www.w3.org/1999/02/22-rdf-syntax-ns#',
 289                                               'xmlns:dc' =>
 290                                               'http://purl.org/dc/elements/1.1/',
 291                                               'xmlns:cc' =>
 292                                               'http://creativecommons.org/ns#',
 293                                               'xmlns:content' =>
 294                                               'http://purl.org/rss/1.0/modules/content/',
 295                                               'xmlns:enc' =>
 296                                               'http://purl.oclc.org/net/rss_2.0/enc#',
 297                                               'xmlns:foaf' =>
 298                                               'http://xmlns.com/foaf/0.1/',
 299                                               'xmlns:sioc' =>
 300                                               'http://rdfs.org/sioc/ns#',
 301                                               'xmlns:sioct' =>
 302                                               'http://rdfs.org/sioc/types#',
 303                                               'xmlns:laconica' =>
 304                                               'http://laconi.ca/ont/',
 305                                               'xmlns' => 'http://purl.org/rss/1.0/'));
 306         $this->elementStart('sioc:Site', array('rdf:about' => common_root_url()));
 307         $this->element('sioc:name', null, common_config('site', 'name'));
 308         $this->elementStart('sioc:space_of');
 309         $this->element('sioc:Container', array('rdf:about' =>
 310                                                $channel['url']));
 311         $this->elementEnd('sioc:space_of');
 312         $this->elementEnd('sioc:Site');
 313     }
 314
 315     function endRss()
 316     {
 317         $this->elementEnd('rdf:RDF');
 318     }
 319
 320     /**
 321      * When was this page last modified?
 322      *
 323      */
 324
 325     function lastModified()
 326     {
 327         if (empty($this->notices)) {
 328             return null;
 329         }
 330
 331         if (count($this->notices) == 0) {
 332             return null;
 333         }
 334
 335         // FIXME: doesn't handle modified profiles, avatars, deleted notices
 336
 337         return strtotime($this->notices[0]->created);
 338     }
 339 }
 340