We are no longer offering accounts on this server. Consider https://gitlab.freedesktop.org/ as a place to host projects.

apitimelinefavorites.php 7.86 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 user's favorite 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
 * @author    Craig Andrews <candrews@integralblue.com>
 * @author    Evan Prodromou <evan@status.net>
26 27
 * @author    Zach Copley <zach@status.net>
 * @copyright 2009-2010 StatusNet, Inc.
28
 * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
 * @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);
}

require_once INSTALLDIR.'/lib/apibareauth.php';

/**
 * Returns the 20 most recent favorite notices for the authenticating user or user
 * specified by the ID parameter in the requested format.
 *
 * @category API
 * @package  StatusNet
Zach Copley's avatar
Zach Copley committed
45 46
 * @author   Craig Andrews <candrews@integralblue.com>
 * @author   Evan Prodromou <evan@status.net>
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
 * @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/
 */
class ApiTimelineFavoritesAction extends ApiBareAuthAction
{
    var $notices  = null;

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

        $this->user = $this->getTargetUser($this->arg('id'));

        if (empty($this->user)) {
Siebrand Mazeland's avatar
Siebrand Mazeland committed
69
            // TRANS: Client error displayed when requesting most recent favourite notices by a user for a non-existing user.
70
            $this->clientError(_('No such user.'), 404, $this->format);
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 98 99 100
            return;
        }

        $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()
    {
101 102
        $profile  = $this->user->getProfile();
        $avatar   = $profile->getAvatar(AVATAR_PROFILE_SIZE);
103

104 105
        $sitename = common_config('site', 'name');
        $title    = sprintf(
Siebrand Mazeland's avatar
Siebrand Mazeland committed
106 107
            // TRANS: Title for timeline of most recent favourite notices by a user.
            // TRANS: %1$s is the StatusNet sitename, %2$s is a user nickname.
108
            _('%1$s / Favorites from %2$s'),
109 110 111 112
            $sitename,
            $this->user->nickname
        );

113
        $taguribase = TagURI::base();
114
        $id         = "tag:$taguribase:Favorites:" . $this->user->id;
115 116

        $subtitle = sprintf(
Siebrand Mazeland's avatar
Siebrand Mazeland committed
117 118 119 120
            // TRANS: Subtitle for timeline of most recent favourite notices by a user.
            // TRANS: %1$s is the StatusNet sitename, %2$s is a user's full name,
            // TRANS: %3$s is a user nickname.
            _('%1$s updates favorited by %2$s / %3$s.'),
121 122 123 124
            $sitename,
            $profile->getBestName(),
            $this->user->nickname
        );
125 126 127
        $logo = !empty($avatar)
            ? $avatar->displayUrl()
            : Avatar::defaultImage(AVATAR_PROFILE_SIZE);
128

129 130 131 132 133 134 135
        $link = common_local_url(
            'showfavorites',
            array('nickname' => $this->user->nickname)
        );

        $self = $this->getSelfUri();

136 137
        switch($this->format) {
        case 'xml':
138
            $this->showXmlTimeline($this->notices);
139 140
            break;
        case 'rss':
141 142 143 144 145 146
            $this->showRssTimeline(
                $this->notices,
                $title,
                $link,
                $subtitle,
                null,
147 148
                $logo,
                $self
149
            );
150 151
            break;
        case 'atom':
152 153
            header('Content-Type: application/atom+xml; charset=utf-8');

154
            $atom = new AtomNoticeFeed($this->auth_user);
155 156 157 158 159 160 161

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

162 163
            $atom->addLink($link);
            $atom->setSelfLink($self);
164 165 166 167

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

            $this->raw($atom->getString());
168 169
            break;
        case 'json':
170
            $this->showJsonTimeline($this->notices);
171
            break;
172
        case 'as':
173
            header('Content-Type: ' . ActivityStreamJSONDocument::CONTENT_TYPE);
174 175 176 177 178 179
            $doc = new ActivityStreamJSONDocument($this->auth_user);
            $doc->setTitle($title);
            $doc->addLink($link,'alternate', 'text/html');
            $doc->addItemsFromNotices($this->notices);
            $this->raw($doc->asString());
            break;
180
        default:
181
            // TRANS: Client error displayed when coming across a non-supported API method.
182
            $this->clientError(_('API method not found.'), $code = 404);
183 184 185 186 187 188 189 190 191 192 193 194 195
            break;
        }
    }

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

196 197
        common_debug("since id = " . $this->since_id . " max id = " . $this->max_id);

198 199
        if (!empty($this->auth_user) && $this->auth_user->id == $this->user->id) {
            $notice = $this->user->favoriteNotices(
200
                true,
201 202
                ($this->page-1) * $this->count,
                $this->count,
203 204
                $this->since_id,
                $this->max_id
205 206 207
            );
        } else {
            $notice = $this->user->favoriteNotices(
208
                false,
209 210
                ($this->page-1) * $this->count,
                $this->count,
211 212
                $this->since_id,
                $this->max_id
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
            );
        }

        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, user 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'),
266
                      common_user_cache_hash($this->auth_user),
267 268 269 270 271 272 273 274 275 276 277
                      common_language(),
                      $this->user->id,
                      strtotime($this->notices[0]->created),
                      strtotime($this->notices[$last]->created))
            )
            . '"';
        }

        return null;
    }
}