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

atompubfavoritefeed.php 11.3 KB
Newer Older
Evan Prodromou's avatar
Evan Prodromou committed
1 2 3 4 5 6
<?php
/**
 * StatusNet - the distributed open-source microblogging tool
 * Copyright (C) 2010, StatusNet, Inc.
 *
 * Feed of ActivityStreams 'favorite' actions
Siebrand Mazeland's avatar
Siebrand Mazeland committed
7
 *
Evan Prodromou's avatar
Evan Prodromou committed
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
 * PHP version 5
 *
 * 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  AtomPub
 * @package   StatusNet
 * @author    Evan Prodromou <evan@status.net>
 * @copyright 2010 StatusNet, Inc.
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
 * @link      http://status.net/
 */

if (!defined('STATUSNET')) {
    // This check helps protect against security problems;
    // your code file can't be executed directly from the web.
    exit(1);
}

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

/**
 * Feed of ActivityStreams 'favorite' actions
 *
 * @category  AtomPub
 * @package   StatusNet
 * @author    Evan Prodromou <evan@status.net>
 * @copyright 2010 StatusNet, Inc.
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
 * @link      http://status.net/
 */
class AtompubfavoritefeedAction extends ApiAuthAction
{
    private $_profile = null;
    private $_faves   = null;

    /**
     * For initializing members of the class.
     *
     * @param array $argarray misc. arguments
     *
     * @return boolean true
     */
    function prepare($argarray)
    {
        parent::prepare($argarray);

        $this->_profile = Profile::staticGet('id', $this->trimmed('profile'));

        if (empty($this->_profile)) {
Siebrand Mazeland's avatar
Siebrand Mazeland committed
68 69
            // TRANS: Client exception thrown when requesting a favorite feed for a non-existing profile.
            throw new ClientException(_('No such profile.'), 404);
Evan Prodromou's avatar
Evan Prodromou committed
70 71 72 73 74 75 76 77
        }

        $offset = ($this->page-1) * $this->count;
        $limit  = $this->count + 1;

        $this->_faves = Fave::byProfile($this->_profile->id,
                                        $offset,
                                        $limit);
Siebrand Mazeland's avatar
Siebrand Mazeland committed
78

Evan Prodromou's avatar
Evan Prodromou committed
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
        return true;
    }

    /**
     * Handler method
     *
     * @param array $argarray is ignored since it's now passed in in prepare()
     *
     * @return void
     */
    function handle($argarray=null)
    {
        parent::handle($argarray);

        switch ($_SERVER['REQUEST_METHOD']) {
        case 'HEAD':
        case 'GET':
            $this->showFeed();
            break;
        case 'POST':
            $this->addFavorite();
            break;
        default:
Siebrand Mazeland's avatar
Siebrand Mazeland committed
102
            // TRANS: Client exception thrown when using an unsupported HTTP method.
Evan Prodromou's avatar
Evan Prodromou committed
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
            throw new ClientException(_('HTTP method not supported.'), 405);
            return;
        }

        return;
    }

    /**
     * Show a feed of favorite activity streams objects
     *
     * @return void
     */
    function showFeed()
    {
        header('Content-Type: application/atom+xml; charset=utf-8');

        $url = common_local_url('AtomPubFavoriteFeed',
                                array('profile' => $this->_profile->id));

        $feed = new Atom10Feed(true);

        $feed->addNamespace('activity',
                            'http://activitystrea.ms/spec/1.0/');

        $feed->addNamespace('poco',
                            'http://portablecontacts.net/spec/1.0');

        $feed->addNamespace('media',
                            'http://purl.org/syndication/atommedia');

        $feed->id = $url;

        $feed->setUpdated('now');

        $feed->addAuthor($this->_profile->getBestName(),
                         $this->_profile->getURI());

Siebrand Mazeland's avatar
Siebrand Mazeland committed
140 141
        // TRANS: Title for Atom favorites feed.
        // TRANS: %s is a user nickname.
Evan Prodromou's avatar
Evan Prodromou committed
142 143 144
        $feed->setTitle(sprintf(_("%s favorites"),
                                $this->_profile->getBestName()));

Siebrand Mazeland's avatar
Siebrand Mazeland committed
145 146 147
        // TRANS: Subtitle for Atom favorites feed.
        // TRANS: %1$s is a user nickname, %2$s is the StatusNet sitename.
        $feed->setSubtitle(sprintf(_("Notices %1$s has favorited on %2$s"),
Evan Prodromou's avatar
Evan Prodromou committed
148 149 150 151
                                   $this->_profile->getBestName(),
                                   common_config('site', 'name')));

        $feed->addLink(common_local_url('showfavorites',
Siebrand Mazeland's avatar
Siebrand Mazeland committed
152
                                        array('nickname' =>
Evan Prodromou's avatar
Evan Prodromou committed
153 154 155 156 157
                                              $this->_profile->nickname)));

        $feed->addLink($url,
                       array('rel' => 'self',
                             'type' => 'application/atom+xml'));
Siebrand Mazeland's avatar
Siebrand Mazeland committed
158

Evan Prodromou's avatar
Evan Prodromou committed
159 160 161 162 163 164 165 166
        // If there's more...

        if ($this->page > 1) {
            $feed->addLink($url,
                           array('rel' => 'first',
                                 'type' => 'application/atom+xml'));

            $feed->addLink(common_local_url('AtomPubFavoriteFeed',
Siebrand Mazeland's avatar
Siebrand Mazeland committed
167
                                            array('profile' =>
168
                                                  $this->_profile->id),
Siebrand Mazeland's avatar
Siebrand Mazeland committed
169
                                            array('page' =>
Evan Prodromou's avatar
Evan Prodromou committed
170 171 172 173 174 175 176 177 178
                                                  $this->page - 1)),
                           array('rel' => 'prev',
                                 'type' => 'application/atom+xml'));
        }

        if ($this->_faves->N > $this->count) {

            $feed->addLink(common_local_url('AtomPubFavoriteFeed',
                                            array('profile' =>
179 180
                                                  $this->_profile->id),
                                            array('page' =>
Evan Prodromou's avatar
Evan Prodromou committed
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
                                                  $this->page + 1)),
                           array('rel' => 'next',
                                 'type' => 'application/atom+xml'));
        }

        $i = 0;

        while ($this->_faves->fetch()) {

            // We get one more than needed; skip that one

            $i++;

            if ($i > $this->count) {
                break;
            }

            $act = $this->_faves->asActivity();
            $feed->addEntryRaw($act->asString(false, false, false));
        }

        $this->raw($feed->getString());
    }

    /**
     * add a new favorite
     *
     * @return void
     */
    function addFavorite()
    {
        // XXX: Refactor this; all the same for atompub

        if (empty($this->auth_user) ||
            $this->auth_user->id != $this->_profile->id) {
Siebrand Mazeland's avatar
Siebrand Mazeland committed
216 217 218
            // TRANS: Client exception thrown when trying to set a favorite for another user.
            throw new ClientException(_("Cannot add someone else's".
                                        " subscription."), 403);
Evan Prodromou's avatar
Evan Prodromou committed
219
        }
Siebrand Mazeland's avatar
Siebrand Mazeland committed
220

Evan Prodromou's avatar
Evan Prodromou committed
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
        $xml = file_get_contents('php://input');

        $dom = DOMDocument::loadXML($xml);

        if ($dom->documentElement->namespaceURI != Activity::ATOM ||
            $dom->documentElement->localName != 'entry') {
            // TRANS: Client error displayed when not using an Atom entry.
            throw new ClientException(_('Atom post must be an Atom entry.'));
            return;
        }

        $activity = new Activity($dom->documentElement);

        $fave = null;

        if (Event::handle('StartAtomPubNewActivity', array(&$activity))) {

            if ($activity->verb != ActivityVerb::FAVORITE) {
Siebrand Mazeland's avatar
Siebrand Mazeland committed
239 240
                // TRANS: Client exception thrown when trying use an incorrect activity verb for the Atom pub method.
                throw new ClientException(_('Can only handle favorite activities.'));
Evan Prodromou's avatar
Evan Prodromou committed
241 242 243 244 245 246 247 248
                return;
            }

            $note = $activity->objects[0];

            if (!in_array($note->type, array(ActivityObject::NOTE,
                                             ActivityObject::BLOGENTRY,
                                             ActivityObject::STATUS))) {
Siebrand Mazeland's avatar
Siebrand Mazeland committed
249
                // TRANS: Client exception thrown when trying favorite an object that is not a notice.
Evan Prodromou's avatar
Evan Prodromou committed
250 251 252 253 254 255 256 257
                throw new ClientException(_('Can only fave notices.'));
                return;
            }

            $notice = Notice::staticGet('uri', $note->id);

            if (empty($notice)) {
                // XXX: import from listed URL or something
Siebrand Mazeland's avatar
Siebrand Mazeland committed
258
                // TRANS: Client exception thrown when trying favorite a notice without content.
Evan Prodromou's avatar
Evan Prodromou committed
259 260 261 262 263 264 265
                throw new ClientException(_('Unknown note.'));
            }

            $old = Fave::pkeyGet(array('user_id' => $this->auth_user->id,
                                       'notice_id' => $notice->id));

            if (!empty($old)) {
Siebrand Mazeland's avatar
Siebrand Mazeland committed
266
                // TRANS: Client exception thrown when trying favorite an already favorited notice.
Evan Prodromou's avatar
Evan Prodromou 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 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
                throw new ClientException(_('Already a favorite.'));
            }

            $profile = $this->auth_user->getProfile();

            $fave = Fave::addNew($profile, $notice);

            if (!empty($fave)) {
                $this->_profile->blowFavesCache();
                $this->notify($fave, $notice, $this->auth_user);
            }

            Event::handle('EndAtomPubNewActivity', array($activity, $fave));
        }

        if (!empty($fave)) {
            $act = $fave->asActivity();

            header('Content-Type: application/atom+xml; charset=utf-8');
            header('Content-Location: ' . $act->selfLink);

            $this->startXML();
            $this->raw($act->asString(true, true, true));
            $this->endXML();
        }
    }

    /**
     * Return true if read only.
     *
     * MAY override
     *
     * @param array $args other arguments
     *
     * @return boolean is read only action?
     */
    function isReadOnly($args)
    {
        if ($_SERVER['REQUEST_METHOD'] == 'GET' ||
            $_SERVER['REQUEST_METHOD'] == 'HEAD') {
            return true;
        } else {
            return false;
        }
    }

    /**
     * Return last modified, if applicable.
     *
     * MAY override
     *
     * @return string last modified http header
     */
    function lastModified()
    {
        // For comparison with If-Last-Modified
        // If not applicable, return null
        return null;
    }

    /**
     * Return etag, if applicable.
     *
     * MAY override
     *
     * @return string etag http header
     */
    function etag()
    {
        return null;
    }

    /**
     * Does this require authentication?
     *
     * @return boolean true if delete, else false
     */
    function requiresAuth()
    {
        if ($_SERVER['REQUEST_METHOD'] == 'GET' ||
            $_SERVER['REQUEST_METHOD'] == 'HEAD') {
            return false;
        } else {
            return true;
        }
    }

    /**
     * Notify the author of the favorite that the user likes their notice
     *
     * @param Favorite $fave   the favorite in question
     * @param Notice   $notice the notice that's been faved
     * @param User     $user   the user doing the favoriting
     *
     * @return void
     */
    function notify($fave, $notice, $user)
    {
        $other = User::staticGet('id', $notice->profile_id);
        if ($other && $other->id != $user->id) {
            if ($other->email && $other->emailnotifyfav) {
                mail_notify_fave($other, $user, $notice);
            }
            // XXX: notify by IM
            // XXX: notify by SMS
        }
    }
}