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