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

apitimelineuser.php 16.6 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 timeline
 *
 * 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 27 28 29
 * @author    Craig Andrews <candrews@integralblue.com>
 * @author    Evan Prodromou <evan@status.net>
 * @author    Jeffery To <jeffery.to@gmail.com>
 * @author    mac65 <mac65@mac65.com>
 * @author    Mike Cochrane <mikec@mikenz.geek.nz>
 * @author    Robin Millette <robin@millette.info>
30 31
 * @author    Zach Copley <zach@status.net>
 * @copyright 2009 StatusNet, Inc.
32
 * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
33 34 35 36 37 38 39 40
 * @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);
}

Zach Copley's avatar
Zach Copley committed
41
require_once INSTALLDIR . '/lib/apibareauth.php';
42 43 44 45 46 47 48 49

/**
 * Returns the most recent notices (default 20) posted by the authenticating
 * user. Another user's timeline can be requested via the id parameter. This
 * is the API equivalent of the user profile web page.
 *
 * @category API
 * @package  StatusNet
Zach Copley's avatar
Zach Copley committed
50 51 52 53 54 55
 * @author   Craig Andrews <candrews@integralblue.com>
 * @author   Evan Prodromou <evan@status.net>
 * @author   Jeffery To <jeffery.to@gmail.com>
 * @author   mac65 <mac65@mac65.com>
 * @author   Mike Cochrane <mikec@mikenz.geek.nz>
 * @author   Robin Millette <robin@millette.info>
56 57 58 59
 * @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/
 */
60
class ApiTimelineUserAction extends ApiBareAuthAction
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
{
    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
78
            // TRANS: Client error displayed requesting most recent notices for a non-existing user.
79
            $this->clientError(_('No such user.'), 404, $this->format);
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
            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);
100 101 102 103 104 105

        if ($this->isPost()) {
            $this->handlePost();
        } else {
            $this->showTimeline();
        }
106 107 108 109 110 111 112 113 114 115 116
    }

    /**
     * Show the timeline of notices
     *
     * @return void
     */
    function showTimeline()
    {
        $profile = $this->user->getProfile();

117 118
        // We'll use the shared params from the Atom stub
        // for other feed types.
119
        $atom = new AtomUserNoticeFeed($this->user, $this->auth_user);
120 121

        $link = common_local_url(
122 123 124
                                 'showstream',
                                 array('nickname' => $this->user->nickname)
                                 );
125

126
        $self = $this->getSelfUri();
127 128 129 130 131 132 133

        // FriendFeed's SUP protocol
        // Also added RSS and Atom feeds

        $suplink = common_local_url('sup', null, null, $this->user->id);
        header('X-SUP-ID: ' . $suplink);

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

152 153
            $atom->setId($self);
            $atom->setSelfLink($self);
154 155 156 157 158 159 160 161 162 163 164 165 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

            // Add navigation links: next, prev, first
            // Note: we use IDs rather than pages for navigation; page boundaries
            // change too quickly!

            if (!empty($this->next_id)) {
                $nextUrl = common_local_url('ApiTimelineUser',
                                            array('format' => 'atom',
                                                  'id' => $this->user->id),
                                            array('max_id' => $this->next_id));

                $atom->addLink($nextUrl,
                               array('rel' => 'next',
                                     'type' => 'application/atom+xml'));
            }

            if (($this->page > 1 || !empty($this->max_id)) && !empty($this->notices)) {

                $lastNotice = $this->notices[0];
                $lastId     = $lastNotice->id;

                $prevUrl = common_local_url('ApiTimelineUser',
                                            array('format' => 'atom',
                                                  'id' => $this->user->id),
                                            array('since_id' => $lastId));

                $atom->addLink($prevUrl,
                               array('rel' => 'prev',
                                     'type' => 'application/atom+xml'));
            }

            if ($this->page > 1 || !empty($this->since_id) || !empty($this->max_id)) {

                $firstUrl = common_local_url('ApiTimelineUser',
                                            array('format' => 'atom',
                                                  'id' => $this->user->id));

                $atom->addLink($firstUrl,
                               array('rel' => 'first',
                                     'type' => 'application/atom+xml'));

            }

Zach Copley's avatar
Zach Copley committed
197
            $atom->addEntryFromNotices($this->notices);
198
            $this->raw($atom->getString());
Zach Copley's avatar
Zach Copley committed
199

200 201
            break;
        case 'json':
202
            $this->showJsonTimeline($this->notices);
203 204
            break;
        default:
Siebrand Mazeland's avatar
Siebrand Mazeland committed
205
            // TRANS: Client error displayed when trying to handle an unknown API method.
206
            $this->clientError(_('API method not found.'), $code = 404);
207 208 209 210 211 212 213 214 215 216 217 218 219
            break;
        }
    }

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

220 221 222 223
        $notice = $this->user->getNotices(($this->page-1) * $this->count,
                                          $this->count + 1,
                                          $this->since_id,
                                          $this->max_id);
224 225

        while ($notice->fetch()) {
226 227 228 229 230 231
            if (count($notices) < $this->count) {
                $notices[] = clone($notice);
            } else {
                $this->next_id = $notice->id;
                break;
            }
232 233 234 235 236 237
        }

        return $notices;
    }

    /**
238
     * We expose AtomPub here, so non-GET/HEAD reqs must be read/write.
239 240 241 242 243
     *
     * @param array $args other arguments
     *
     * @return boolean true
     */
244

245 246
    function isReadOnly($args)
    {
247
        return ($_SERVER['REQUEST_METHOD'] == 'GET' || $_SERVER['REQUEST_METHOD'] == 'HEAD');
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
    }

    /**
     * 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;

277
            return '"' . implode(
278 279 280 281 282 283 284 285 286
                                 ':',
                                 array($this->arg('action'),
                                       common_user_cache_hash($this->auth_user),
                                       common_language(),
                                       $this->user->id,
                                       strtotime($this->notices[0]->created),
                                       strtotime($this->notices[$last]->created))
                                 )
              . '"';
287 288 289 290 291
        }

        return null;
    }

292 293 294 295
    function handlePost()
    {
        if (empty($this->auth_user) ||
            $this->auth_user->id != $this->user->id) {
296 297
            // TRANS: Client error displayed trying to add a notice to another user's timeline.
            $this->clientError(_('Only the user can add to their own timeline.'));
298 299 300
            return;
        }

301
        // Only handle posts for Atom
302
        if ($this->format != 'atom') {
303 304
            // TRANS: Client error displayed when using another format than AtomPub.
            $this->clientError(_('Only accept AtomPub for Atom feeds.'));
305 306 307
            return;
        }

308 309
        $xml = trim(file_get_contents('php://input'));
        if (empty($xml)) {
310
            // TRANS: Client error displayed attempting to post an empty API notice.
311 312
            $this->clientError(_('Atom post must not be empty.'));
        }
313 314

        $dom = DOMDocument::loadXML($xml);
315
        if (!$dom) {
316
            // TRANS: Client error displayed attempting to post an API that is not well-formed XML.
317 318
            $this->clientError(_('Atom post must be well-formed XML.'));
        }
319 320 321

        if ($dom->documentElement->namespaceURI != Activity::ATOM ||
            $dom->documentElement->localName != 'entry') {
322
            // TRANS: Client error displayed when not using an Atom entry.
323 324 325 326 327 328
            $this->clientError(_('Atom post must be an Atom entry.'));
            return;
        }

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

329 330 331
        $saved = null;

        if (Event::handle('StartAtomPubNewActivity', array(&$activity, $this->user, &$saved))) {
332

Evan Prodromou's avatar
Evan Prodromou committed
333
            if ($activity->verb != ActivityVerb::POST) {
334 335 336
                // TRANS: Client error displayed when not using the POST verb.
                // TRANS: Do not translate POST.
                $this->clientError(_('Can only handle POST activities.'));
Evan Prodromou's avatar
Evan Prodromou committed
337 338
                return;
            }
339

Evan Prodromou's avatar
Evan Prodromou committed
340 341 342 343 344
            $note = $activity->objects[0];

            if (!in_array($note->type, array(ActivityObject::NOTE,
                                             ActivityObject::BLOGENTRY,
                                             ActivityObject::STATUS))) {
345 346 347 348
                // TRANS: Client error displayed when using an unsupported activity object type.
                // TRANS: %s is the unsupported activity object type.
                $this->clientError(sprintf(_('Cannot handle activity object type "%s".'),
                                             $note->type));
Evan Prodromou's avatar
Evan Prodromou committed
349 350 351 352 353
                return;
            }

            $saved = $this->postNote($activity);

354
            Event::handle('EndAtomPubNewActivity', array($activity, $this->user, $saved));
Evan Prodromou's avatar
Evan Prodromou committed
355 356 357
        }

        if (!empty($saved)) {
358
            header('HTTP/1.1 201 Created');
359
            header("Location: " . common_local_url('ApiStatusesShow', array('id' => $saved->id,
Evan Prodromou's avatar
Evan Prodromou committed
360 361
                                                                            'format' => 'atom')));
            $this->showSingleAtomStatus($saved);
362
        }
Evan Prodromou's avatar
Evan Prodromou committed
363 364 365 366 367
    }

    function postNote($activity)
    {
        $note = $activity->objects[0];
368 369 370 371 372 373 374 375 376 377 378

        // Use summary as fallback for content

        if (!empty($note->content)) {
            $sourceContent = $note->content;
        } else if (!empty($note->summary)) {
            $sourceContent = $note->summary;
        } else if (!empty($note->title)) {
            $sourceContent = $note->title;
        } else {
            // @fixme fetch from $sourceUrl?
379
            // TRANS: Client error displayed when posting a notice without content through the API.
380
            // TRANS: %d is the notice ID (number).
381 382
            $this->clientError(sprintf(_('No content for notice %d.'),
                                       $note->id));
383 384 385 386 387 388 389 390
            return;
        }

        // Get (safe!) HTML and text versions of the content

        $rendered = $this->purify($sourceContent);
        $content = html_entity_decode(strip_tags($rendered), ENT_QUOTES, 'UTF-8');

391
        $shortened = $this->auth_user->shortenLinks($content);
392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407

        $options = array('is_local' => Notice::LOCAL_PUBLIC,
                         'rendered' => $rendered,
                         'replies' => array(),
                         'groups' => array(),
                         'tags' => array(),
                         'urls' => array());

        // accept remote URI (not necessarily a good idea)

        common_debug("Note ID is {$note->id}");

        if (!empty($note->id)) {
            $notice = Notice::staticGet('uri', trim($note->id));

            if (!empty($notice)) {
408
                // TRANS: Client error displayed when using another format than AtomPub.
409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
                $this->clientError(sprintf(_('Notice with URI "%s" already exists.'),
                                           $note->id));
                return;
            }
            common_log(LOG_NOTICE, "Saving client-supplied notice URI '$note->id'");
            $options['uri'] = $note->id;
        }

        // accept remote create time (also maybe not such a good idea)

        if (!empty($activity->time)) {
            common_log(LOG_NOTICE, "Saving client-supplied create time {$activity->time}");
            $options['created'] = common_sql_date($activity->time);
        }

        // Check for optional attributes...

        if (!empty($activity->context)) {

            foreach ($activity->context->attention as $uri) {

                $profile = Profile::fromURI($uri);

                if (!empty($profile)) {
433
                    $options['replies'][] = $uri;
434 435 436
                } else {
                    $group = User_group::staticGet('uri', $uri);
                    if (!empty($group)) {
437
                        $options['groups'][] = $uri;
438 439
                    } else {
                        // @fixme: hook for discovery here
440
                        common_log(LOG_WARNING, sprintf('AtomPub post with unknown attention URI %s', $uri));
441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489
                    }
                }
            }

            // Maintain direct reply associations
            // @fixme what about conversation ID?

            if (!empty($activity->context->replyToID)) {
                $orig = Notice::staticGet('uri',
                                          $activity->context->replyToID);
                if (!empty($orig)) {
                    $options['reply_to'] = $orig->id;
                }
            }

            $location = $activity->context->location;

            if ($location) {
                $options['lat'] = $location->lat;
                $options['lon'] = $location->lon;
                if ($location->location_id) {
                    $options['location_ns'] = $location->location_ns;
                    $options['location_id'] = $location->location_id;
                }
            }
        }

        // Atom categories <-> hashtags

        foreach ($activity->categories as $cat) {
            if ($cat->term) {
                $term = common_canonical_tag($cat->term);
                if ($term) {
                    $options['tags'][] = $term;
                }
            }
        }

        // Atom enclosures -> attachment URLs
        foreach ($activity->enclosures as $href) {
            // @fixme save these locally or....?
            $options['urls'][] = $href;
        }

        $saved = Notice::saveNew($this->user->id,
                                 $content,
                                 'atompub', // TODO: deal with this
                                 $options);

Evan Prodromou's avatar
Evan Prodromou committed
490
        return $saved;
491 492 493 494 495 496 497 498 499 500
    }

    function purify($content)
    {
        require_once INSTALLDIR.'/extlib/htmLawed/htmLawed.php';

        $config = array('safe' => 1,
                        'deny_attribute' => 'id,style,on*');
        return htmLawed($content, $config);
    }
501
}