lib/rssaction.php

   1 <?php
   2 /*
   3  * Laconica - a distributed open-source microblogging tool
   4  * Copyright (C) 2008, Controlez-Vous, Inc.
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU Affero General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU Affero General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Affero General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 if (!defined('LACONICA')) { exit(1); }
  21
  22 define('DEFAULT_RSS_LIMIT', 48);
  23
  24 class Rss10Action extends Action {
  25
  26         # This will contain the details of each feed item's author and be used to generate SIOC data.
  27         var $creators = array();
  28
  29         function is_readonly() {
  30                 return true;
  31         }
  32
  33         function handle($args) {
  34                 parent::handle($args);
  35                 $limit = (int) $this->trimmed('limit');
  36                 if ($limit == 0) {
  37                         $limit = DEFAULT_RSS_LIMIT;
  38                 }
  39                 $this->show_rss($limit);
  40         }
  41
  42         function init() {
  43                 return true;
  44         }
  45
  46         function get_notices() {
  47                 return array();
  48         }
  49
  50         function get_channel() {
  51                 return array('url' => '',
  52                                          'title' => '',
  53                                          'link' => '',
  54                                          'description' => '');
  55         }
  56
  57         function get_image() {
  58                 return NULL;
  59         }
  60
  61         function show_rss($limit=0) {
  62
  63                 if (!$this->init()) {
  64                         return;
  65                 }
  66
  67                 $notices = $this->get_notices($limit);
  68
  69                 $this->init_rss();
  70                 $this->show_channel($notices);
  71                 $this->show_image();
  72
  73                 foreach ($notices as $n) {
  74                         $this->show_item($n);
  75                 }
  76
  77                 $this->show_creators();
  78                 $this->end_rss();
  79         }
  80
  81         function show_channel($notices) {
  82
  83                 $channel = $this->get_channel();
  84                 $image = $this->get_image();
  85
  86                 common_element_start('channel', array('rdf:about' => $channel['url']));
  87                 common_element('title', NULL, $channel['title']);
  88                 common_element('link', NULL, $channel['link']);
  89                 common_element('description', NULL, $channel['description']);
  90                 common_element('cc:licence', array('rdf:resource' => common_config('license','url')));
  91
  92                 if ($image) {
  93                         common_element('image', array('rdf:resource' => $image));
  94                 }
  95
  96                 common_element_start('items');
  97                 common_element_start('rdf:Seq');
  98
  99                 foreach ($notices as $notice) {
 100                         common_element('sioct:MicroblogPost', array('rdf:resource' => $notice->uri));
 101                 }
 102
 103                 common_element_end('rdf:Seq');
 104                 common_element_end('items');
 105
 106                 common_element_end('channel');
 107         }
 108
 109         function show_image() {
 110                 $image = $this->get_image();
 111                 if ($image) {
 112                         $channel = $this->get_channel();
 113                         common_element_start('image', array('rdf:about' => $image));
 114                         common_element('title', NULL, $channel['title']);
 115                         common_element('link', NULL, $channel['link']);
 116                         common_element('url', NULL, $image);
 117                         common_element_end('image');
 118                 }
 119         }
 120
 121         function show_item($notice) {
 122                 $profile = Profile::staticGet($notice->profile_id);
 123                 $nurl = common_local_url('shownotice', array('notice' => $notice->id));
 124                 $creator_uri = common_profile_uri($profile);
 125                 common_element_start('item', array('rdf:about' => $notice->uri));
 126                 $title = $profile->nickname . ': ' . common_xml_safe_str($notice->content);
 127                 common_element('title', NULL, $title);
 128                 common_element('link', NULL, $nurl);
 129                 common_element('description', NULL, $profile->nickname."'s status on ".common_exact_date($notice->created));
 130                 common_element('dc:date', NULL, common_date_w3dtf($notice->created));
 131                 common_element('dc:creator', NULL, ($profile->fullname) ? $profile->fullname : $profile->nickname);
 132                 common_element('sioc:has_creator', array('rdf:resource' => $creator_uri));
 133                 common_element('laconica:postIcon', array('rdf:resource' => common_profile_avatar_url($profile)));
 134                 common_element('cc:licence', array('rdf:resource' => common_config('license', 'url')));
 135                 common_element_end('item');
 136                 $this->creators[$creator_uri] = $profile;
 137         }
 138
 139         function show_creators() {
 140                 foreach ($this->creators as $uri => $profile) {
 141                         $id = $profile->id;
 142                         $nickname = $profile->nickname;
 143
 144                         common_element_start('sioc:User', array('rdf:about' => $uri));
 145                         common_element('foaf:nick', NULL, $nickname);
 146                         if ($profile->fullname) {
 147                                 common_element('foaf:name', NULL, $profile->fullname);
 148                         }
 149                         common_element('sioc:id', NULL, $id);
 150                         $avatar = common_profile_avatar_url($profile);
 151                         common_element('sioc:avatar', array('rdf:resource' => $avatar));
 152                         common_element_end('sioc:User');
 153                 }
 154         }
 155
 156         function init_rss() {
 157                 $channel = $this->get_channel();
 158
 159                 header('Content-Type: application/rdf+xml');
 160
 161                 common_start_xml();
 162                 common_element_start('rdf:RDF', array('xmlns:rdf' =>
 163                                                                                           'http://www.w3.org/1999/02/22-rdf-syntax-ns#',
 164                                                                                           'xmlns:dc' =>
 165                                                                                           'http://purl.org/dc/elements/1.1/',
 166                                                                                           'xmlns:cc' =>
 167                                                                                           'http://web.resource.org/cc/',
 168                                                                                           'xmlns:foaf' =>
 169                                                                                           'http://xmlns.com/foaf/0.1/',
 170                                                                                           'xmlns:sioc' =>
 171                                                                                           'http://rdfs.org/sioc/ns#',
 172                                                       'xmlns:sioct' =>
 173                                                       'http://rdfs.org/sioc/types#',
 174                                                       'xmlns:laconica' =>
 175                                                       'http://laconi.ca/ont/',
 176                                                                                           'xmlns' => 'http://purl.org/rss/1.0/'));
 177
 178                 common_element_start('sioc:Site', array('rdf:about' => common_root_url()));
 179                 common_element('sioc:name', NULL, common_config('site', 'name'));
 180                 common_element_start('sioc:container_of');
 181                 common_element('sioc:Container', array('rdf:about' =>
 182                                                        $channel['url']));
 183                 common_element_end('sioc:container_of');
 184                 common_element_end('sioc:Site');
 185         }
 186
 187         function end_rss() {
 188                 common_element_end('rdf:RDF');
 189         }
 190 }