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    Craig Andrews <candrews@integralblue.com>
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @author    Jeffery To <jeffery.to@gmail.com>
  27  * @author    mac65 <mac65@mac65.com>
  28  * @author    Mike Cochrane <mikec@mikenz.geek.nz>
  29  * @author    Robin Millette <robin@millette.info>
  30  * @author    Zach Copley <zach@status.net>
  31  * @copyright 2009 StatusNet, Inc.
  32  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  33  * @link      http://status.net/
  34  */
  35
  36 if (!defined('STATUSNET')) {
  37     exit(1);
  38 }
  39
  40 require_once INSTALLDIR . '/lib/apibareauth.php';
  41
  42 /**
  43  * Returns the most recent notices (default 20) posted by the authenticating
  44  * user. Another user's timeline can be requested via the id parameter. This
  45  * is the API equivalent of the user profile web page.
  46  *
  47  * @category API
  48  * @package  StatusNet
  49  * @author   Craig Andrews <candrews@integralblue.com>
  50  * @author   Evan Prodromou <evan@status.net>
  51  * @author   Jeffery To <jeffery.to@gmail.com>
  52  * @author   mac65 <mac65@mac65.com>
  53  * @author   Mike Cochrane <mikec@mikenz.geek.nz>
  54  * @author   Robin Millette <robin@millette.info>
  55  * @author   Zach Copley <zach@status.net>
  56  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  57  * @link     http://status.net/
  58  */
  59
  60 class ApiTimelineUserAction extends ApiBareAuthAction
  61 {
  62
  63     var $notices = null;
  64
  65     /**
  66      * Take arguments for running
  67      *
  68      * @param array $args $_REQUEST args
  69      *
  70      * @return boolean success flag
  71      *
  72      */
  73
  74     function prepare($args)
  75     {
  76         parent::prepare($args);
  77
  78         $this->user = $this->getTargetUser($this->arg('id'));
  79
  80         if (empty($this->user)) {
  81             $this->clientError(_('No such user!'), 404, $this->format);
  82             return;
  83         }
  84
  85         $this->notices = $this->getNotices();
  86
  87         return true;
  88     }
  89
  90     /**
  91      * Handle the request
  92      *
  93      * Just show the notices
  94      *
  95      * @param array $args $_REQUEST data (unused)
  96      *
  97      * @return void
  98      */
  99
 100     function handle($args)
 101     {
 102         parent::handle($args);
 103         $this->showTimeline();
 104     }
 105
 106     /**
 107      * Show the timeline of notices
 108      *
 109      * @return void
 110      */
 111
 112     function showTimeline()
 113     {
 114         $profile = $this->user->getProfile();
 115
 116         $sitename   = common_config('site', 'name');
 117         $title      = sprintf(_("%s timeline"), $this->user->nickname);
 118         $taguribase = common_config('integration', 'taguri');
 119         $id         = "tag:$taguribase:UserTimeline:" . $this->user->id;
 120         $link       = common_local_url(
 121             'showstream',
 122             array('nickname' => $this->user->nickname)
 123         );
 124         $subtitle   = sprintf(
 125             _('Updates from %1$s on %2$s!'),
 126             $this->user->nickname, $sitename
 127         );
 128
 129         // FriendFeed's SUP protocol
 130         // Also added RSS and Atom feeds
 131
 132         $suplink = common_local_url('sup', null, null, $this->user->id);
 133         header('X-SUP-ID: ' . $suplink);
 134
 135         switch($this->format) {
 136         case 'xml':
 137             $this->showXmlTimeline($this->notices);
 138             break;
 139         case 'rss':
 140             $this->showRssTimeline(
 141                 $this->notices, $title, $link,
 142                 $subtitle, $suplink
 143             );
 144             break;
 145         case 'atom':
 146             if (isset($apidata['api_arg'])) {
 147                 $selfuri = common_root_url() .
 148                     'api/statuses/user_timeline/' .
 149                     $apidata['api_arg'] . '.atom';
 150             } else {
 151                 $selfuri = common_root_url() .
 152                     'api/statuses/user_timeline.atom';
 153             }
 154             $this->showAtomTimeline(
 155                 $this->notices, $title, $id, $link,
 156                 $subtitle, $suplink, $selfuri
 157             );
 158             break;
 159         case 'json':
 160             $this->showJsonTimeline($this->notices);
 161             break;
 162         default:
 163             $this->clientError(_('API method not found!'), $code = 404);
 164             break;
 165         }
 166
 167     }
 168
 169     /**
 170      * Get notices
 171      *
 172      * @return array notices
 173      */
 174
 175     function getNotices()
 176     {
 177         $notices = array();
 178
 179         $notice = $this->user->getNotices(
 180             ($this->page-1) * $this->count, $this->count,
 181             $this->since_id, $this->max_id, $this->since
 182         );
 183
 184         while ($notice->fetch()) {
 185             $notices[] = clone($notice);
 186         }
 187
 188         return $notices;
 189     }
 190
 191     /**
 192      * Is this action read only?
 193      *
 194      * @param array $args other arguments
 195      *
 196      * @return boolean true
 197      */
 198
 199     function isReadOnly($args)
 200     {
 201         return true;
 202     }
 203
 204     /**
 205      * When was this feed last modified?
 206      *
 207      * @return string datestamp of the latest notice in the stream
 208      */
 209
 210     function lastModified()
 211     {
 212         if (!empty($this->notices) && (count($this->notices) > 0)) {
 213             return strtotime($this->notices[0]->created);
 214         }
 215
 216         return null;
 217     }
 218
 219     /**
 220      * An entity tag for this stream
 221      *
 222      * Returns an Etag based on the action name, language, user ID, and
 223      * timestamps of the first and last notice in the timeline
 224      *
 225      * @return string etag
 226      */
 227
 228     function etag()
 229     {
 230         if (!empty($this->notices) && (count($this->notices) > 0)) {
 231
 232             $last = count($this->notices) - 1;
 233
 234             return '"' . implode(
 235                 ':',
 236                 array($this->arg('action'),
 237                       common_language(),
 238                       $this->user->id,
 239                       strtotime($this->notices[0]->created),
 240                       strtotime($this->notices[$last]->created))
 241             )
 242             . '"';
 243         }
 244
 245         return null;
 246     }
 247
 248 }