apitimelinegroup.php 6.32 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
<?php
/**
 * StatusNet, the distributed open-source microblogging tool
 *
 * Show a group's notices
 *
 * 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  API
 * @package   StatusNet
Zach Copley's avatar
Zach Copley committed
24 25 26
 * @author    Craig Andrews <candrews@integralblue.com>
 * @author    Evan Prodromou <evan@status.net>
 * @author    Jeffery To <jeffery.to@gmail.com>
27
 * @author    Zach Copley <zach@status.net>
28
 * @copyright 2009-2010 StatusNet, Inc.
29
 * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
30 31 32 33 34 35 36 37
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link      http://status.net/
 */

if (!defined('STATUSNET')) {
    exit(1);
}

38
require_once INSTALLDIR . '/lib/apiprivateauth.php';
39 40 41 42 43 44

/**
 * Returns the most recent notices (default 20) posted to the group specified by ID
 *
 * @category API
 * @package  StatusNet
Zach Copley's avatar
Zach Copley committed
45 46 47
 * @author   Craig Andrews <candrews@integralblue.com>
 * @author   Evan Prodromou <evan@status.net>
 * @author   Jeffery To <jeffery.to@gmail.com>
48 49 50 51
 * @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/
 */
52
class ApiTimelineGroupAction extends ApiPrivateAuthAction
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
{
    var $group   = null;
    var $notices = null;

    /**
     * Take arguments for running
     *
     * @param array $args $_REQUEST args
     *
     * @return boolean success flag
     *
     */
    function prepare($args)
    {
        parent::prepare($args);

69
        $this->group   = $this->getTargetGroup($this->arg('id'));
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85

        return true;
    }

    /**
     * Handle the request
     *
     * Just show the notices
     *
     * @param array $args $_REQUEST data (unused)
     *
     * @return void
     */
    function handle($args)
    {
        parent::handle($args);
86 87

        if (empty($this->group)) {
Siebrand Mazeland's avatar
Siebrand Mazeland committed
88
            // TRANS: Client error displayed requesting most recent notices to a group for a non-existing group.
89
            $this->clientError(_('Group not found.'), 404, $this->format);
90 91 92 93
            return false;
        }

        $this->notices = $this->getNotices();
94 95 96 97 98 99 100 101 102 103
        $this->showTimeline();
    }

    /**
     * Show the timeline of notices
     *
     * @return void
     */
    function showTimeline()
    {
104
        // We'll pull common formatting out of this for other formats
105
        $atom = new AtomGroupNoticeFeed($this->group, $this->auth_user);
106

107
        $self = $this->getSelfUri();
108

109 110 111 112 113
        $link = common_local_url(
            'ApiTimelineGroup',
            array('nickname' => $this->group->nickname)
        );

114 115
        switch($this->format) {
        case 'xml':
116
            $this->showXmlTimeline($this->notices);
117 118
            break;
        case 'rss':
119
            $this->showRssTimeline(
120
                $this->notices,
121
                $atom->title,
122
                $this->group->homeUrl(),
123
                $atom->subtitle,
124
                null,
125 126
                $atom->logo,
                $self
127 128
            );
            break;
129 130 131
        case 'atom':
            header('Content-Type: application/atom+xml; charset=utf-8');
                $atom->addEntryFromNotices($this->notices);
132
                $this->raw($atom->getString());
133
            break;
134
        case 'json':
135
            $this->showJsonTimeline($this->notices);
136
            break;
137
        case 'as':
138
            header('Content-Type: ' . ActivityStreamJSONDocument::CONTENT_TYPE);
139 140 141 142 143 144
            $doc = new ActivityStreamJSONDocument($this->auth_user);
            $doc->setTitle($atom->title);
            $doc->addLink($link, 'alternate', 'text/html');
            $doc->addItemsFromNotices($this->notices);
            $this->raw($doc->asString());
            break;
145 146
        default:
            $this->clientError(
Siebrand Mazeland's avatar
Siebrand Mazeland committed
147
                // TRANS: Client error displayed when trying to handle an unknown API method.
148
                _('API method not found.'),
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
                404,
                $this->format
            );
            break;
        }
    }

    /**
     * Get notices
     *
     * @return array notices
     */
    function getNotices()
    {
        $notices = array();

        $notice = $this->group->getNotices(
            ($this->page-1) * $this->count,
            $this->count,
            $this->since_id,
169
            $this->max_id
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
        );

        while ($notice->fetch()) {
            $notices[] = clone($notice);
        }

        return $notices;
    }

    /**
     * Is this action read only?
     *
     * @param array $args other arguments
     *
     * @return boolean true
     */
    function isReadOnly($args)
    {
        return true;
    }

    /**
     * When was this feed last modified?
     *
     * @return string datestamp of the latest notice in the stream
     */
    function lastModified()
    {
        if (!empty($this->notices) && (count($this->notices) > 0)) {
            return strtotime($this->notices[0]->created);
        }

        return null;
    }

    /**
     * An entity tag for this stream
     *
     * Returns an Etag based on the action name, language, group ID and
     * timestamps of the first and last notice in the timeline
     *
     * @return string etag
     */
    function etag()
    {
        if (!empty($this->notices) && (count($this->notices) > 0)) {

            $last = count($this->notices) - 1;

            return '"' . implode(
                ':',
                array($this->arg('action'),
222
                      common_user_cache_hash($this->auth_user),
223 224 225 226 227 228 229 230 231 232 233
                      common_language(),
                      $this->group->id,
                      strtotime($this->notices[0]->created),
                      strtotime($this->notices[$last]->created))
            )
            . '"';
        }

        return null;
    }
}