apitimelinetag.php 6.77 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 the latest notices for a given tag
 *
 * 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 20 most recent notices tagged by a given tag
 *
 * @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 ApiTimelineTagAction extends ApiPrivateAuthAction
53 54 55 56 57 58 59 60 61 62 63 64 65 66
{
    var $notices = null;

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

67 68
        common_debug("apitimelinetag prepare()");

69
        $this->tag     = $this->arg('tag');
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
        $this->notices = $this->getNotices();

        return true;
    }

    /**
     * Handle the request
     *
     * Just show the notices
     *
     * @param array $args $_REQUEST data (unused)
     *
     * @return void
     */
    function handle($args)
    {
        parent::handle($args);
        $this->showTimeline();
    }

    /**
     * Show the timeline of notices
     *
     * @return void
     */
    function showTimeline()
    {
        $sitename   = common_config('site', 'name');
98
        $sitelogo   = (common_config('site', 'logo')) ? common_config('site', 'logo') : Theme::path('logo.png');
Siebrand Mazeland's avatar
Siebrand Mazeland committed
99 100
        // TRANS: Title for timeline with lastest notices with a given tag.
        // TRANS: %s is the tag.
101
        $title      = sprintf(_("Notices tagged with %s"), $this->tag);
Zach Copley's avatar
Zach Copley committed
102
        $subtitle   = sprintf(
Siebrand Mazeland's avatar
Siebrand Mazeland committed
103 104
            // TRANS: Subtitle for timeline with lastest notices with a given tag.
            // TRANS: %1$s is the tag, $2$s is the StatusNet sitename.
Zach Copley's avatar
Zach Copley committed
105 106 107 108
            _('Updates tagged with %1$s on %2$s!'),
            $this->tag,
            $sitename
        );
109
        $taguribase = TagURI::base();
110
        $id         = "tag:$taguribase:TagTimeline:".$this->tag;
111

112 113 114 115 116 117 118
        $link = common_local_url(
            'tag',
            array('tag' => $this->tag)
        );

        $self = $this->getSelfUri();

119 120
        switch($this->format) {
        case 'xml':
121
            $this->showXmlTimeline($this->notices);
122 123
            break;
        case 'rss':
124
            $this->showRssTimeline(
Zach Copley's avatar
Zach Copley committed
125 126 127 128 129
                $this->notices,
                $title,
                $link,
                $subtitle,
                null,
130 131
                $sitelogo,
                $self
132
            );
133 134 135 136
            break;
        case 'atom':
            header('Content-Type: application/atom+xml; charset=utf-8');

137
            $atom = new AtomNoticeFeed($this->auth_user);
138 139 140 141 142 143 144

            $atom->setId($id);
            $atom->setTitle($title);
            $atom->setSubtitle($subtitle);
            $atom->setLogo($logo);
            $atom->setUpdated('now');

145 146
            $atom->addLink($link);
            $atom->setSelfLink($self);
147 148 149 150

            $atom->addEntryFromNotices($this->notices);
            $this->raw($atom->getString());

151 152
            break;
        case 'json':
153
            $this->showJsonTimeline($this->notices);
154
            break;
155
        case 'as':
156
            header('Content-Type: ' . ActivityStreamJSONDocument::CONTENT_TYPE);
157 158 159 160 161 162
            $doc = new ActivityStreamJSONDocument($this->auth_user);
            $doc->setTitle($title);
            $doc->addLink($link, 'alternate', 'text/html');
            $doc->addItemsFromNotices($this->notices);
            $this->raw($doc->asString());
            break;
163
        default:
164
            // TRANS: Client error displayed when coming across a non-supported API method.
165
            $this->clientError(_('API method not found.'), $code = 404);
166 167 168 169 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 222 223 224 225 226 227 228 229 230 231 232 233 234
            break;
        }
    }

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

        $notice = Notice_tag::getStream(
            $this->tag,
            ($this->page - 1) * $this->count,
            $this->count + 1
        );

        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, 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'),
235
                      common_user_cache_hash($this->auth_user),
236 237 238 239 240 241 242 243 244 245 246
                      common_language(),
                      $this->tag,
                      strtotime($this->notices[0]->created),
                      strtotime($this->notices[$last]->created))
            )
            . '"';
        }

        return null;
    }
}