atomnoticefeed.php 4.24 KB
Newer Older
1
<?php
2 3 4
/**
 * StatusNet, the distributed open-source microblogging tool
 *
5
 * Class for building an Atom feed from a collection of notices
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
 *
 * 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/
 */
29

30
if (!defined('STATUSNET'))
31 32 33 34 35 36 37 38 39 40 41 42 43 44
{
    exit(1);
}

/**
 * Class for creating a feed that represents a collection of notices. Builds the
 * feed in memory. Get the feed as a string with AtomNoticeFeed::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/
 */
45 46
class AtomNoticeFeed extends Atom10Feed
{
47
    var $cur;
48
    protected $scoped=null;
49 50 51 52 53 54 55 56 57 58 59

    /**
     * Constructor - adds a bunch of XML namespaces we need in our
     * notice-specific Atom feeds, and allows setting the current
     * authenticated user (useful for API methods).
     *
     * @param User    $cur     the current authenticated user (optional)
     * @param boolean $indent  Whether to indent XML output
     *
     */
    function __construct($cur = null, $indent = true) {
60 61
        parent::__construct($indent);

62 63
        $this->cur = $cur ?: common_current_user();
        $this->scoped = !is_null($this->cur) ? $this->cur->getProfile() : null;
64

65
        // Feeds containing notice info use these namespaces
66 67

        $this->addNamespace(
68
            'thr',
69 70
            'http://purl.org/syndication/thread/1.0'
        );
71 72

        $this->addNamespace(
73
            'georss',
74 75 76 77
            'http://www.georss.org/georss'
        );

        $this->addNamespace(
78
            'activity',
79 80 81
            'http://activitystrea.ms/spec/1.0/'
        );

82 83 84 85 86
        $this->addNamespace(
            'media',
            'http://purl.org/syndication/atommedia'
        );

87 88 89 90 91
        $this->addNamespace(
            'poco',
            'http://portablecontacts.net/spec/1.0'
        );

92 93
        // XXX: What should the uri be?
        $this->addNamespace(
94
            'ostatus',
95 96
            'http://ostatus.org/schema/1.0'
        );
97 98 99

        $this->addNamespace(
            'statusnet',
100
            'http://status.net/schema/api/1/'
101
        );
102 103
    }

104 105 106 107 108 109
    /**
     * Add more than one Notice to the feed
     *
     * @param mixed $notices an array of Notice objects or handle
     *
     */
110 111 112 113 114 115
    function addEntryFromNotices($notices)
    {
        if (is_array($notices)) {
            foreach ($notices as $notice) {
                $this->addEntryFromNotice($notice);
            }
116
        } elseif ($notices instanceof Notice) {
117
            while ($notices->fetch()) {
118
                $this->addEntryFromNotice($notices);
119
            }
120 121
        } else {
            throw new ServerException('addEntryFromNotices got neither an array nor a Notice object');
122 123 124
        }
    }

125 126 127 128 129
    /**
     * Add a single Notice to the feed
     *
     * @param Notice $notice a Notice to add
     */
130
    function addEntryFromNotice(Notice $notice)
131
    {
132 133 134
        try {
            $source = $this->showSource();
            $author = $this->showAuthor();
135

136
            $this->addEntryRaw($notice->asAtomEntry(false, $source, $author, $this->scoped));
137 138 139 140
        } catch (Exception $e) {
            common_log(LOG_ERR, $e->getMessage());
            // we continue on exceptions
        }
141
    }
142

143 144 145 146
    function showSource()
    {
        return true;
    }
147

148 149 150 151 152
    function showAuthor()
    {
        return true;
    }
}