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                 // TRANS: Atom feed exception thrown when an author element does not contain a name element.
 113                 _('Author element must contain a name element.')
 114             );
 115         }
 116
 117         if (isset($uri)) {
 118             $xs->element('uri', null, $uri);
 119         }
 120
 121         if (isset($email)) {
 122             $xs->element('email', null, $email);
 123         }
 124
 125         $xs->elementEnd('author');
 126
 127         array_push($this->authors, $xs->getString());
 128     }
 129
 130     /**
 131      * Add an Author to the feed via raw XML string
 132      *
 133      * @param string $xmlAuthor An XML string representation author
 134      *
 135      * @return void
 136      */
 137     function addAuthorRaw($xmlAuthor)
 138     {
 139         array_push($this->authors, $xmlAuthor);
 140     }
 141
 142     function renderAuthors()
 143     {
 144         foreach ($this->authors as $author) {
 145             $this->raw($author);
 146         }
 147     }
 148
 149     function getNamespaces()
 150     {
 151         return $this->namespaces;
 152     }
 153
 154     function initFeed()
 155     {
 156         $this->startXML();
 157         $commonAttrs = array('xml:lang' => 'en-US');
 158         foreach ($this->namespaces as $prefix => $uri) {
 159             if ($prefix == '') {
 160                 $attr = 'xmlns';
 161             } else {
 162                 $attr = 'xmlns:' . $prefix;
 163             }
 164             $commonAttrs[$attr] = $uri;
 165         }
 166         $this->elementStart('feed', $commonAttrs);
 167
 168         $this->element(
 169             'generator', array(
 170                 'uri'     => 'https://gnu.io/social',
 171                 'version' => GNUSOCIAL_VERSION
 172             ),
 173             'GNU social'
 174         );
 175
 176         $this->element('id', null, $this->id);
 177         $this->element('title', null, $this->title);
 178         $this->element('subtitle', null, $this->subtitle);
 179
 180         if (!empty($this->logo)) {
 181             $this->element('logo', null, $this->logo);
 182         }
 183
 184         $this->element('updated', null, $this->updated);
 185
 186         $this->renderAuthors();
 187
 188         if ($this->selfLink) {
 189             $this->addLink($this->selfLink, array('rel' => 'self',
 190                                                   'type' => $this->selfLinkType));
 191         }
 192         $this->renderLinks();
 193     }
 194
 195     /**
 196      * Check that all required elements have been set, etc.
 197      * Throws an Atom10FeedException if something's missing.
 198      *
 199      * @return void
 200      */
 201     function validate()
 202     {
 203     }
 204
 205     function renderLinks()
 206     {
 207         foreach ($this->links as $attrs)
 208         {
 209             $this->element('link', $attrs, null);
 210         }
 211     }
 212
 213     function addEntryRaw($xmlEntry)
 214     {
 215         array_push($this->entries, $xmlEntry);
 216     }
 217
 218     function addEntry($entry)
 219     {
 220         array_push($this->entries, $entry->getString());
 221     }
 222
 223     function renderEntries()
 224     {
 225         foreach ($this->entries as $entry) {
 226             $this->raw($entry);
 227         }
 228     }
 229
 230     function endFeed()
 231     {
 232         $this->elementEnd('feed');
 233         $this->xw->endDocument();
 234     }
 235
 236     function getString()
 237     {
 238         if (Event::handle('StartApiAtom', array($this))) {
 239
 240             $this->validate();
 241             $this->initFeed();
 242
 243             if (!empty($this->subject)) {
 244                 $this->raw($this->subject);
 245             }
 246
 247             $this->renderEntries();
 248             $this->endFeed();
 249
 250             Event::handle('EndApiAtom', array($this));
 251         }
 252
 253         return $this->xw->outputMemory();
 254     }
 255
 256     function setId($id)
 257     {
 258         $this->id = $id;
 259     }
 260
 261     function setSelfLink($url, $type='application/atom+xml')
 262     {
 263         $this->selfLink = $url;
 264         $this->selfLinkType = $type;
 265     }
 266
 267     function setTitle($title)
 268     {
 269         $this->title = $title;
 270     }
 271
 272     function setSubtitle($subtitle)
 273     {
 274         $this->subtitle = $subtitle;
 275     }
 276
 277     function setLogo($logo)
 278     {
 279         $this->logo = $logo;
 280     }
 281
 282     function setUpdated($dt)
 283     {
 284         $this->updated = common_date_iso8601($dt);
 285     }
 286
 287     function setPublished($dt)
 288     {
 289         $this->published = common_date_iso8601($dt);
 290     }
 291
 292     /**
 293      * Adds a link element into the Atom document
 294      *
 295      * Assumes you want rel="alternate" and type="text/html" unless
 296      * you send in $otherAttrs.
 297      *
 298      * @param string $uri            the uri the href needs to point to
 299      * @param array  $otherAttrs     other attributes to stick in
 300      *
 301      * @return void
 302      */
 303     function addLink($uri, $otherAttrs = null) {
 304         $attrs = array('href' => $uri);
 305
 306         if (is_null($otherAttrs)) {
 307             $attrs['rel']  = 'alternate';
 308             $attrs['type'] = 'text/html';
 309         } else {
 310             $attrs = array_merge($attrs, $otherAttrs);
 311         }
 312
 313         array_push($this->links, $attrs);
 314     }
 315 }