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     private $namespaces;
  53     private $authors;
  54     private $subject;
  55     private $categories;
  56     private $contributors;
  57     private $generator;
  58     private $icon;
  59     private $links;
  60     private $logo;
  61     private $rights;
  62     private $subtitle;
  63     private $title;
  64     private $published;
  65     private $updated;
  66     private $entries;
  67
  68     /**
  69      * Constructor
  70      *
  71      * @param boolean $indent  flag to turn indenting on or off
  72      *
  73      * @return void
  74      */
  75     function __construct($indent = true) {
  76         parent::__construct($indent);
  77         $this->namespaces = array();
  78         $this->authors    = array();
  79         $this->links      = array();
  80         $this->entries    = array();
  81         $this->addNamespace('', 'http://www.w3.org/2005/Atom');
  82     }
  83
  84     /**
  85      * Add another namespace to the feed
  86      *
  87      * @param string $namespace the namespace
  88      * @param string $uri       namspace uri
  89      *
  90      * @return void
  91      */
  92     function addNamespace($namespace, $uri)
  93     {
  94         $ns = array($namespace => $uri);
  95         $this->namespaces = array_merge($this->namespaces, $ns);
  96     }
  97
  98     function addAuthor($name, $uri = null, $email = null)
  99     {
 100         $xs = new XMLStringer(true);
 101
 102         $xs->elementStart('author');
 103
 104         if (!empty($name)) {
 105             $xs->element('name', null, $name);
 106         } else {
 107             throw new Atom10FeedException(
 108                 'author element must contain a name element.'
 109             );
 110         }
 111
 112         if (isset($uri)) {
 113             $xs->element('uri', null, $uri);
 114         }
 115
 116         if (isset($email)) {
 117             $xs->element('email', null, $email);
 118         }
 119
 120         $xs->elementEnd('author');
 121
 122         array_push($this->authors, $xs->getString());
 123     }
 124
 125     /**
 126      * Add an Author to the feed via raw XML string
 127      *
 128      * @param string $xmlAuthor An XML string representation author
 129      *
 130      * @return void
 131      */
 132     function addAuthorRaw($xmlAuthor)
 133     {
 134         array_push($this->authors, $xmlAuthor);
 135     }
 136
 137     function renderAuthors()
 138     {
 139         foreach ($this->authors as $author) {
 140             $this->raw($author);
 141         }
 142     }
 143
 144     /**
 145      * Add a activity feed subject via raw XML string
 146      *
 147      * @param string $xmlSubject An XML string representation of the subject
 148      *
 149      * @return void
 150      */
 151     function setActivitySubject($xmlSubject)
 152     {
 153         $this->subject = $xmlSubject;
 154     }
 155
 156     function getNamespaces()
 157     {
 158         return $this->namespaces;
 159     }
 160
 161     function initFeed()
 162     {
 163         $this->xw->startDocument('1.0', 'UTF-8');
 164         $commonAttrs = array('xml:lang' => 'en-US');
 165         foreach ($this->namespaces as $prefix => $uri) {
 166             if ($prefix == '') {
 167                 $attr = 'xmlns';
 168             } else {
 169                 $attr = 'xmlns:' . $prefix;
 170             }
 171             $commonAttrs[$attr] = $uri;
 172         }
 173         $this->elementStart('feed', $commonAttrs);
 174
 175         $this->element('id', null, $this->id);
 176         $this->element('title', null, $this->title);
 177         $this->element('subtitle', null, $this->subtitle);
 178
 179         if (!empty($this->logo)) {
 180             $this->element('logo', null, $this->logo);
 181         }
 182
 183         $this->element('updated', null, $this->updated);
 184
 185         $this->renderAuthors();
 186
 187         $this->renderLinks();
 188     }
 189
 190     /**
 191      * Check that all required elements have been set, etc.
 192      * Throws an Atom10FeedException if something's missing.
 193      *
 194      * @return void
 195      */
 196     function validate()
 197     {
 198     }
 199
 200     function renderLinks()
 201     {
 202         foreach ($this->links as $attrs)
 203         {
 204             $this->element('link', $attrs, null);
 205         }
 206     }
 207
 208     function addEntryRaw($xmlEntry)
 209     {
 210         array_push($this->entries, $xmlEntry);
 211     }
 212
 213     function addEntry($entry)
 214     {
 215         array_push($this->entries, $entry->getString());
 216     }
 217
 218     function renderEntries()
 219     {
 220         foreach ($this->entries as $entry) {
 221             $this->raw($entry);
 222         }
 223     }
 224
 225     function endFeed()
 226     {
 227         $this->elementEnd('feed');
 228         $this->xw->endDocument();
 229     }
 230
 231     function getString()
 232     {
 233         if (Event::handle('StartApiAtom', array($this))) {
 234
 235             $this->validate();
 236             $this->initFeed();
 237
 238             if (!empty($this->subject)) {
 239                 $this->raw($this->subject);
 240             }
 241
 242             $this->renderEntries();
 243             $this->endFeed();
 244
 245             Event::handle('EndApiAtom', array($this));
 246         }
 247
 248         return $this->xw->outputMemory();
 249     }
 250
 251     function setId($id)
 252     {
 253         $this->id = $id;
 254     }
 255
 256     function setTitle($title)
 257     {
 258         $this->title = $title;
 259     }
 260
 261     function setSubtitle($subtitle)
 262     {
 263         $this->subtitle = $subtitle;
 264     }
 265
 266     function setLogo($logo)
 267     {
 268         $this->logo = $logo;
 269     }
 270
 271     function setUpdated($dt)
 272     {
 273         $this->updated = common_date_iso8601($dt);
 274     }
 275
 276     function setPublished($dt)
 277     {
 278         $this->published = common_date_iso8601($dt);
 279     }
 280
 281     /**
 282      * Adds a link element into the Atom document
 283      *
 284      * Assumes you want rel="alternate" and type="text/html" unless
 285      * you send in $otherAttrs.
 286      *
 287      * @param string $uri            the uri the href needs to point to
 288      * @param array  $otherAttrs     other attributes to stick in
 289      *
 290      * @return void
 291      */
 292     function addLink($uri, $otherAttrs = null) {
 293         $attrs = array('href' => $uri);
 294
 295         if (is_null($otherAttrs)) {
 296             $attrs['rel']  = 'alternate';
 297             $attrs['type'] = 'text/html';
 298         } else {
 299             $attrs = array_merge($attrs, $otherAttrs);
 300         }
 301
 302         array_push($this->links, $attrs);
 303     }
 304
 305 }