lib/atom10feed.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Class for building an Atom feed in memory
   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  Feed
  23  * @package   StatusNet
  24  * @author    Zach Copley <zach@status.net>
  25  * @copyright 2010 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET'))
  31 {
  32     exit(1);
  33 }
  34
  35 class Atom10FeedException extends Exception
  36 {
  37 }
  38
  39 /**
  40  * Class for building an Atom feed in memory.  Get the finished doc
  41  * as a string with Atom10Feed::getString().
  42  *
  43  * @category Feed
  44  * @package  StatusNet
  45  * @author   Zach Copley <zach@status.net>
  46  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  47  * @link     http://status.net/
  48  */
  49 class Atom10Feed extends XMLStringer
  50 {
  51     public  $xw;
  52
  53     // @fixme most of these should probably be read-only properties
  54     private $namespaces;
  55     private $authors;
  56     private $subject;
  57     private $categories;
  58     private $contributors;
  59     private $generator;
  60     private $icon;
  61     private $links;
  62     private $selfLink;
  63     private $selfLinkType;
  64     public $logo;
  65     private $rights;
  66     public $subtitle;
  67     public $title;
  68     private $published;
  69     private $updated;
  70     private $entries;
  71
  72     /**
  73      * Constructor
  74      *
  75      * @param boolean $indent  flag to turn indenting on or off
  76      *
  77      * @return void
  78      */
  79     function __construct($indent = true) {
  80         parent::__construct($indent);
  81         $this->namespaces = array();
  82         $this->authors    = array();
  83         $this->links      = array();
  84         $this->entries    = array();
  85         $this->addNamespace('', 'http://www.w3.org/2005/Atom');
  86     }
  87
  88     /**
  89      * Add another namespace to the feed
  90      *
  91      * @param string $namespace the namespace
  92      * @param string $uri       namspace uri
  93      *
  94      * @return void
  95      */
  96     function addNamespace($namespace, $uri)
  97     {
  98         $ns = array($namespace => $uri);
  99         $this->namespaces = array_merge($this->namespaces, $ns);
 100     }
 101
 102     function addAuthor($name, $uri = null, $email = null)
 103     {
 104         $xs = new XMLStringer(true);
 105
 106         $xs->elementStart('author');
 107
 108         if (!empty($name)) {
 109             $xs->element('name', null, $name);
 110         } else {
 111             throw new Atom10FeedException(
 112                 _('author element must contain a name element.')
 113             );
 114         }
 115
 116         if (isset($uri)) {
 117             $xs->element('uri', null, $uri);
 118         }
 119
 120         if (isset($email)) {
 121             $xs->element('email', null, $email);
 122         }
 123
 124         $xs->elementEnd('author');
 125
 126         array_push($this->authors, $xs->getString());
 127     }
 128
 129     /**
 130      * Add an Author to the feed via raw XML string
 131      *
 132      * @param string $xmlAuthor An XML string representation author
 133      *
 134      * @return void
 135      */
 136     function addAuthorRaw($xmlAuthor)
 137     {
 138         array_push($this->authors, $xmlAuthor);
 139     }
 140
 141     function renderAuthors()
 142     {
 143         foreach ($this->authors as $author) {
 144             $this->raw($author);
 145         }
 146     }
 147
 148     /**
 149      * Deprecated <activity:subject>; ignored
 150      *
 151      * @param string $xmlSubject An XML string representation of the subject
 152      *
 153      * @return void
 154      */
 155
 156     function setActivitySubject($xmlSubject)
 157     {
 158         throw new ServerException(_('Don\'t use this method!'));
 159     }
 160
 161     function getNamespaces()
 162     {
 163         return $this->namespaces;
 164     }
 165
 166     function initFeed()
 167     {
 168         $this->xw->startDocument('1.0', 'UTF-8');
 169         $commonAttrs = array('xml:lang' => 'en-US');
 170         foreach ($this->namespaces as $prefix => $uri) {
 171             if ($prefix == '') {
 172                 $attr = 'xmlns';
 173             } else {
 174                 $attr = 'xmlns:' . $prefix;
 175             }
 176             $commonAttrs[$attr] = $uri;
 177         }
 178         $this->elementStart('feed', $commonAttrs);
 179
 180         $this->element(
 181             'generator', array(
 182                 'uri'     => 'http://status.net',
 183                 'version' => STATUSNET_VERSION
 184             ),
 185             'StatusNet'
 186         );
 187
 188         $this->element('id', null, $this->id);
 189         $this->element('title', null, $this->title);
 190         $this->element('subtitle', null, $this->subtitle);
 191
 192         if (!empty($this->logo)) {
 193             $this->element('logo', null, $this->logo);
 194         }
 195
 196         $this->element('updated', null, $this->updated);
 197
 198         $this->renderAuthors();
 199
 200         if ($this->selfLink) {
 201             $this->addLink($this->selfLink, array('rel' => 'self',
 202                                                   'type' => $this->selfLinkType));
 203         }
 204         $this->renderLinks();
 205     }
 206
 207     /**
 208      * Check that all required elements have been set, etc.
 209      * Throws an Atom10FeedException if something's missing.
 210      *
 211      * @return void
 212      */
 213     function validate()
 214     {
 215     }
 216
 217     function renderLinks()
 218     {
 219         foreach ($this->links as $attrs)
 220         {
 221             $this->element('link', $attrs, null);
 222         }
 223     }
 224
 225     function addEntryRaw($xmlEntry)
 226     {
 227         array_push($this->entries, $xmlEntry);
 228     }
 229
 230     function addEntry($entry)
 231     {
 232         array_push($this->entries, $entry->getString());
 233     }
 234
 235     function renderEntries()
 236     {
 237         foreach ($this->entries as $entry) {
 238             $this->raw($entry);
 239         }
 240     }
 241
 242     function endFeed()
 243     {
 244         $this->elementEnd('feed');
 245         $this->xw->endDocument();
 246     }
 247
 248     function getString()
 249     {
 250         if (Event::handle('StartApiAtom', array($this))) {
 251
 252             $this->validate();
 253             $this->initFeed();
 254
 255             if (!empty($this->subject)) {
 256                 $this->raw($this->subject);
 257             }
 258
 259             $this->renderEntries();
 260             $this->endFeed();
 261
 262             Event::handle('EndApiAtom', array($this));
 263         }
 264
 265         return $this->xw->outputMemory();
 266     }
 267
 268     function setId($id)
 269     {
 270         $this->id = $id;
 271     }
 272
 273     function setSelfLink($url, $type='application/atom+xml')
 274     {
 275         $this->selfLink = $url;
 276         $this->selfLinkType = $type;
 277     }
 278
 279     function setTitle($title)
 280     {
 281         $this->title = $title;
 282     }
 283
 284     function setSubtitle($subtitle)
 285     {
 286         $this->subtitle = $subtitle;
 287     }
 288
 289     function setLogo($logo)
 290     {
 291         $this->logo = $logo;
 292     }
 293
 294     function setUpdated($dt)
 295     {
 296         $this->updated = common_date_iso8601($dt);
 297     }
 298
 299     function setPublished($dt)
 300     {
 301         $this->published = common_date_iso8601($dt);
 302     }
 303
 304     /**
 305      * Adds a link element into the Atom document
 306      *
 307      * Assumes you want rel="alternate" and type="text/html" unless
 308      * you send in $otherAttrs.
 309      *
 310      * @param string $uri            the uri the href needs to point to
 311      * @param array  $otherAttrs     other attributes to stick in
 312      *
 313      * @return void
 314      */
 315     function addLink($uri, $otherAttrs = null) {
 316         $attrs = array('href' => $uri);
 317
 318         if (is_null($otherAttrs)) {
 319             $attrs['rel']  = 'alternate';
 320             $attrs['type'] = 'text/html';
 321         } else {
 322             $attrs = array_merge($attrs, $otherAttrs);
 323         }
 324
 325         array_push($this->links, $attrs);
 326     }
 327 }