atom10feed.php 7.6 KB
Newer Older
Zach Copley's avatar
Zach Copley committed
1
<?php
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
/**
 * StatusNet, the distributed open-source microblogging tool
 *
 * Class for building an Atom feed in memory
 *
 * PHP version 5
 *
 * LICENCE: This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @category  Feed
 * @package   StatusNet
 * @author    Zach Copley <zach@status.net>
 * @copyright 2010 StatusNet, Inc.
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link      http://status.net/
 */

30
if (!defined('STATUSNET'))
31 32 33
{
    exit(1);
}
Zach Copley's avatar
Zach Copley committed
34 35 36 37 38

class Atom10FeedException extends Exception
{
}

39 40 41 42 43 44 45 46 47 48
/**
 * Class for building an Atom feed in memory.  Get the finished doc
 * as a string with Atom10Feed::getString().
 *
 * @category Feed
 * @package  StatusNet
 * @author   Zach Copley <zach@status.net>
 * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link     http://status.net/
 */
Zach Copley's avatar
Zach Copley committed
49 50 51
class Atom10Feed extends XMLStringer
{
    public  $xw;
52 53

    // @fixme most of these should probably be read-only properties
Zach Copley's avatar
Zach Copley committed
54 55
    private $namespaces;
    private $authors;
56
    private $subject;
Zach Copley's avatar
Zach Copley committed
57 58 59 60 61
    private $categories;
    private $contributors;
    private $generator;
    private $icon;
    private $links;
62 63 64
    private $selfLink;
    private $selfLinkType;
    public $logo;
Zach Copley's avatar
Zach Copley committed
65
    private $rights;
66 67
    public $subtitle;
    public $title;
Zach Copley's avatar
Zach Copley committed
68 69 70 71 72
    private $published;
    private $updated;
    private $entries;

    /**
73
     * Constructor
Zach Copley's avatar
Zach Copley committed
74
     *
75
     * @param boolean $indent  flag to turn indenting on or off
Zach Copley's avatar
Zach Copley committed
76 77 78 79 80 81
     *
     * @return void
     */
    function __construct($indent = true) {
        parent::__construct($indent);
        $this->namespaces = array();
82
        $this->authors    = array();
Zach Copley's avatar
Zach Copley committed
83 84
        $this->links      = array();
        $this->entries    = array();
Brion Vibber's avatar
Brion Vibber committed
85
        $this->addNamespace('', 'http://www.w3.org/2005/Atom');
Zach Copley's avatar
Zach Copley committed
86 87
    }

88 89 90 91 92 93 94 95
    /**
     * Add another namespace to the feed
     *
     * @param string $namespace the namespace
     * @param string $uri       namspace uri
     *
     * @return void
     */
Zach Copley's avatar
Zach Copley committed
96 97 98 99 100 101
    function addNamespace($namespace, $uri)
    {
        $ns = array($namespace => $uri);
        $this->namespaces = array_merge($this->namespaces, $ns);
    }

102 103 104 105 106 107 108 109 110 111
    function addAuthor($name, $uri = null, $email = null)
    {
        $xs = new XMLStringer(true);

        $xs->elementStart('author');

        if (!empty($name)) {
            $xs->element('name', null, $name);
        } else {
            throw new Atom10FeedException(
Siebrand Mazeland's avatar
Siebrand Mazeland committed
112
                // TRANS: Atom feed exception thrown when an author element does not contain a name element.
Siebrand Mazeland's avatar
Siebrand Mazeland committed
113
                _('Author element must contain a name element.')
114 115 116
            );
        }

117
        if (isset($uri)) {
118 119 120
            $xs->element('uri', null, $uri);
        }

121
        if (isset($email)) {
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
            $xs->element('email', null, $email);
        }

        $xs->elementEnd('author');

        array_push($this->authors, $xs->getString());
    }

    /**
     * Add an Author to the feed via raw XML string
     *
     * @param string $xmlAuthor An XML string representation author
     *
     * @return void
     */
    function addAuthorRaw($xmlAuthor)
    {
        array_push($this->authors, $xmlAuthor);
    }

    function renderAuthors()
    {
        foreach ($this->authors as $author) {
            $this->raw($author);
        }
    }

Zach Copley's avatar
Zach Copley committed
149 150 151 152 153 154 155
    function getNamespaces()
    {
        return $this->namespaces;
    }

    function initFeed()
    {
156
        $this->startXML();
Zach Copley's avatar
Zach Copley committed
157
        $commonAttrs = array('xml:lang' => 'en-US');
Brion Vibber's avatar
Brion Vibber committed
158 159 160 161 162 163 164 165
        foreach ($this->namespaces as $prefix => $uri) {
            if ($prefix == '') {
                $attr = 'xmlns';
            } else {
                $attr = 'xmlns:' . $prefix;
            }
            $commonAttrs[$attr] = $uri;
        }
Zach Copley's avatar
Zach Copley committed
166 167
        $this->elementStart('feed', $commonAttrs);

168 169
        $this->element(
            'generator', array(
170
                'uri'     => 'https://gnu.io/social',
171
                'version' => GNUSOCIAL_VERSION
172
            ),
173
            'GNU social'
174 175
        );

Zach Copley's avatar
Zach Copley committed
176 177 178
        $this->element('id', null, $this->id);
        $this->element('title', null, $this->title);
        $this->element('subtitle', null, $this->subtitle);
179 180 181 182 183

        if (!empty($this->logo)) {
            $this->element('logo', null, $this->logo);
        }

Zach Copley's avatar
Zach Copley committed
184 185
        $this->element('updated', null, $this->updated);

186 187
        $this->renderAuthors();

188 189 190 191
        if ($this->selfLink) {
            $this->addLink($this->selfLink, array('rel' => 'self',
                                                  'type' => $this->selfLinkType));
        }
Zach Copley's avatar
Zach Copley committed
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
        $this->renderLinks();
    }

    /**
     * Check that all required elements have been set, etc.
     * Throws an Atom10FeedException if something's missing.
     *
     * @return void
     */
    function validate()
    {
    }

    function renderLinks()
    {
        foreach ($this->links as $attrs)
        {
            $this->element('link', $attrs, null);
        }
    }

213
    function addEntryRaw($xmlEntry)
Zach Copley's avatar
Zach Copley committed
214
    {
215
        array_push($this->entries, $xmlEntry);
Zach Copley's avatar
Zach Copley committed
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
    }

    function addEntry($entry)
    {
        array_push($this->entries, $entry->getString());
    }

    function renderEntries()
    {
        foreach ($this->entries as $entry) {
            $this->raw($entry);
        }
    }

    function endFeed()
    {
        $this->elementEnd('feed');
        $this->xw->endDocument();
    }

    function getString()
    {
238
        if (Event::handle('StartApiAtom', array($this))) {
Zach Copley's avatar
Zach Copley committed
239

240 241
            $this->validate();
            $this->initFeed();
242

243 244 245 246 247 248
            if (!empty($this->subject)) {
                $this->raw($this->subject);
            }

            $this->renderEntries();
            $this->endFeed();
249

250 251
            Event::handle('EndApiAtom', array($this));
        }
Zach Copley's avatar
Zach Copley committed
252 253 254 255 256 257 258 259 260

        return $this->xw->outputMemory();
    }

    function setId($id)
    {
        $this->id = $id;
    }

261 262 263 264 265 266
    function setSelfLink($url, $type='application/atom+xml')
    {
        $this->selfLink = $url;
        $this->selfLinkType = $type;
    }

Zach Copley's avatar
Zach Copley committed
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
    function setTitle($title)
    {
        $this->title = $title;
    }

    function setSubtitle($subtitle)
    {
        $this->subtitle = $subtitle;
    }

    function setLogo($logo)
    {
        $this->logo = $logo;
    }

    function setUpdated($dt)
    {
        $this->updated = common_date_iso8601($dt);
    }

    function setPublished($dt)
    {
        $this->published = common_date_iso8601($dt);
    }

    /**
     * Adds a link element into the Atom document
     *
     * Assumes you want rel="alternate" and type="text/html" unless
     * you send in $otherAttrs.
     *
298
     * @param string $uri            the uri the href needs to point to
Zach Copley's avatar
Zach Copley committed
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315
     * @param array  $otherAttrs     other attributes to stick in
     *
     * @return void
     */
    function addLink($uri, $otherAttrs = null) {
        $attrs = array('href' => $uri);

        if (is_null($otherAttrs)) {
            $attrs['rel']  = 'alternate';
            $attrs['type'] = 'text/html';
        } else {
            $attrs = array_merge($attrs, $otherAttrs);
        }

        array_push($this->links, $attrs);
    }
}