actions/apitimelineuser.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Show a user's timeline
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  API
  23  * @package   StatusNet
  24  * @author    Zach Copley <zach@status.net>
  25  * @copyright 2009 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET')) {
  31     exit(1);
  32 }
  33
  34 require_once INSTALLDIR.'/lib/apibareauth.php';
  35
  36 /**
  37  * Returns the most recent notices (default 20) posted by the authenticating
  38  * user. Another user's timeline can be requested via the id parameter. This
  39  * is the API equivalent of the user profile web page.
  40  *
  41  * @category API
  42  * @package  StatusNet
  43  * @author   Zach Copley <zach@status.net>
  44  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  45  * @link     http://status.net/
  46  */
  47
  48 class ApiTimelineUserAction extends ApiBareAuthAction
  49 {
  50
  51     var $user    = null;
  52     var $notices = null;
  53
  54     /**
  55      * Take arguments for running
  56      *
  57      * @param array $args $_REQUEST args
  58      *
  59      * @return boolean success flag
  60      *
  61      */
  62
  63     function prepare($args)
  64     {
  65         parent::prepare($args);
  66
  67         $this->user = $this->getTargetUser($this->arg('id'));
  68
  69         if (empty($this->user)) {
  70             $this->clientError(_('No such user!'), 404, $this->format);
  71             return;
  72         }
  73
  74         $this->notices = $this->getNotices();
  75
  76         return true;
  77     }
  78
  79     /**
  80      * Handle the request
  81      *
  82      * Just show the notices
  83      *
  84      * @param array $args $_REQUEST data (unused)
  85      *
  86      * @return void
  87      */
  88
  89     function handle($args)
  90     {
  91         parent::handle($args);
  92         $this->showTimeline();
  93     }
  94
  95     /**
  96      * Show the timeline of notices
  97      *
  98      * @return void
  99      */
 100
 101     function showTimeline()
 102     {
 103         $profile = $this->user->getProfile();
 104
 105         $sitename   = common_config('site', 'name');
 106         $title      = sprintf(_("%s timeline"), $this->user->nickname);
 107         $taguribase = common_config('integration', 'taguri');
 108         $id         = "tag:$taguribase:UserTimeline:" . $this->user->id;
 109         $link       = common_local_url(
 110             'showstream',
 111             array('nickname' => $this->user->nickname)
 112         );
 113         $subtitle   = sprintf(
 114             _('Updates from %1$s on %2$s!'),
 115             $this->user->nickname, $sitename
 116         );
 117
 118         // FriendFeed's SUP protocol
 119         // Also added RSS and Atom feeds
 120
 121         $suplink = common_local_url('sup', null, null, $this->user->id);
 122         header('X-SUP-ID: ' . $suplink);
 123
 124         switch($this->format) {
 125         case 'xml':
 126             $this->show_xml_timeline($this->notices);
 127             break;
 128         case 'rss':
 129             $this->show_rss_timeline(
 130                 $this->notices, $title, $link,
 131                 $subtitle, $suplink
 132             );
 133             break;
 134         case 'atom':
 135             if (isset($apidata['api_arg'])) {
 136                 $selfuri = common_root_url() .
 137                     'api/statuses/user_timeline/' .
 138                     $apidata['api_arg'] . '.atom';
 139             } else {
 140                 $selfuri = common_root_url() .
 141                     'api/statuses/user_timeline.atom';
 142             }
 143             $this->show_atom_timeline(
 144                 $this->notices, $title, $id, $link,
 145                 $subtitle, $suplink, $selfuri
 146             );
 147             break;
 148         case 'json':
 149             $this->show_json_timeline($this->notices);
 150             break;
 151         default:
 152             $this->clientError(_('API method not found!'), $code = 404);
 153             break;
 154         }
 155
 156     }
 157
 158     /**
 159      * Get notices
 160      *
 161      * @return array notices
 162      */
 163
 164     function getNotices()
 165     {
 166         $notices = array();
 167
 168         $notice = $this->user->getNotices(
 169             ($this->page-1) * $this->count, $this->count,
 170             $this->since_id, $this->max_id, $this->since
 171         );
 172
 173         while ($notice->fetch()) {
 174             $notices[] = clone($notice);
 175         }
 176
 177         return $notices;
 178     }
 179
 180     /**
 181      * Is this action read only?
 182      *
 183      * @param array $args other arguments
 184      *
 185      * @return boolean true
 186      */
 187
 188     function isReadOnly($args)
 189     {
 190         return true;
 191     }
 192
 193     /**
 194      * When was this feed last modified?
 195      *
 196      * @return string datestamp of the latest notice in the stream
 197      */
 198
 199     function lastModified()
 200     {
 201         if (!empty($this->notices) && (count($this->notices) > 0)) {
 202             return strtotime($this->notices[0]->created);
 203         }
 204
 205         return null;
 206     }
 207
 208     /**
 209      * An entity tag for this stream
 210      *
 211      * Returns an Etag based on the action name, language, user ID, and
 212      * timestamps of the first and last notice in the timeline
 213      *
 214      * @return string etag
 215      */
 216
 217     function etag()
 218     {
 219         if (!empty($this->notices) && (count($this->notices) > 0)) {
 220
 221             $last = count($this->notices) - 1;
 222
 223             return '"' . implode(
 224                 ':',
 225                 array($this->arg('action'),
 226                       common_language(),
 227                       $this->user->id,
 228                       strtotime($this->notices[0]->created),
 229                       strtotime($this->notices[$last]->created))
 230             )
 231             . '"';
 232         }
 233
 234         return null;
 235     }
 236
 237 }