actions/apitimelinefriends.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Show the friends 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 target user.
  38  * This is the equivalent of 'You and friends' page accessed via Web.
  39  *
  40  * @category API
  41  * @package  StatusNet
  42  * @author   Zach Copley <zach@status.net>
  43  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  44  * @link     http://status.net/
  45  */
  46
  47 class ApiTimelineFriendsAction extends ApiBareAuthAction
  48 {
  49
  50     var $user     = null;
  51     var $notices  = null;
  52     var $count    = null;
  53     var $max_id   = null;
  54     var $since_id = null;
  55     var $since    = null;
  56
  57     /**
  58      * Take arguments for running
  59      *
  60      * @param array $args $_REQUEST args
  61      *
  62      * @return boolean success flag
  63      *
  64      */
  65
  66     function prepare($args)
  67     {
  68         parent::prepare($args);
  69
  70         $this->page     = (int)$this->arg('page', 1);
  71         $this->count    = (int)$this->arg('count', 20);
  72         $this->max_id   = (int)$this->arg('max_id', 0);
  73         $this->since_id = (int)$this->arg('since_id', 0);
  74         $this->since    = $this->arg('since');
  75
  76         $this->user = $this->getTargetUser($this->arg('id'));
  77
  78         if (empty($this->user)) {
  79             $this->clientError(_('No such user!'), 404, $this->format);
  80             return;
  81         }
  82
  83         $this->notices = $this->getNotices();
  84
  85         return true;
  86     }
  87
  88     /**
  89      * Handle the request
  90      *
  91      * Just show the notices
  92      *
  93      * @param array $args $_REQUEST data (unused)
  94      *
  95      * @return void
  96      */
  97
  98     function handle($args)
  99     {
 100         parent::handle($args);
 101         $this->showTimeline();
 102     }
 103
 104     /**
 105      * Show the timeline of notices
 106      *
 107      * @return void
 108      */
 109
 110     function showTimeline()
 111     {
 112         $profile    = $this->user->getProfile();
 113         $sitename   = common_config('site', 'name');
 114         $title      = sprintf(_("%s and friends"), $this->user->nickname);
 115         $taguribase = common_config('integration', 'taguri');
 116         $id         = "tag:$taguribase:FriendsTimeline:" . $this->user->id;
 117         $link       = common_local_url(
 118             'all', array('nickname' => $this->user->nickname)
 119         );
 120         $subtitle   = sprintf(
 121             _('Updates from %1$s and friends on %2$s!'),
 122             $this->user->nickname, $sitename
 123         );
 124
 125         switch($this->format) {
 126         case 'xml':
 127             $this->show_xml_timeline($this->notices);
 128             break;
 129         case 'rss':
 130             $this->show_rss_timeline($this->notices, $title, $link, $subtitle);
 131             break;
 132         case 'atom':
 133
 134             $target_id = $this->arg('id');
 135
 136             if (isset($target_id)) {
 137                 $selfuri = common_root_url() .
 138                     'api/statuses/friends_timeline/' .
 139                     $target_id . '.atom';
 140             } else {
 141                 $selfuri = common_root_url() .
 142                     'api/statuses/friends_timeline.atom';
 143             }
 144
 145             $this->show_atom_timeline(
 146                 $this->notices, $title, $id, $link,
 147                 $subtitle, null, $selfuri
 148             );
 149             break;
 150         case 'json':
 151             $this->show_json_timeline($this->notices);
 152             break;
 153         default:
 154             $this->clientError(_('API method not found!'), $code = 404);
 155             break;
 156         }
 157     }
 158
 159     /**
 160      * Get notices
 161      *
 162      * @return array notices
 163      */
 164
 165     function getNotices()
 166     {
 167         $notices = array();
 168
 169         if (!empty($this->auth_user) && $this->auth_user->id == $this->user->id) {
 170             $notice = $this->user->noticeInbox(
 171                 ($this->page-1) * $this->count,
 172                 $this->count, $this->since_id,
 173                 $this->max_id, $this->since
 174             );
 175         } else {
 176             $notice = $this->user->noticesWithFriends(
 177                 ($this->page-1) * $this->count,
 178                 $this->count, $this->since_id,
 179                 $this->max_id, $this->since
 180             );
 181         }
 182
 183         while ($notice->fetch()) {
 184             $notices[] = clone($notice);
 185         }
 186
 187         return $notices;
 188     }
 189
 190     /**
 191      * Is this action read only?
 192      *
 193      * @param array $args other arguments
 194      *
 195      * @return boolean true
 196      */
 197
 198     function isReadOnly($args)
 199     {
 200         return true;
 201     }
 202
 203     /**
 204      * When was this feed last modified?
 205      *
 206      * @return string datestamp of the latest notice in the stream
 207      */
 208
 209     function lastModified()
 210     {
 211         if (!empty($this->notices) && (count($this->notices) > 0)) {
 212             return strtotime($this->notices[0]->created);
 213         }
 214
 215         return null;
 216     }
 217
 218     /**
 219      * An entity tag for this stream
 220      *
 221      * Returns an Etag based on the action name, language, user ID, and
 222      * timestamps of the first and last notice in the timeline
 223      *
 224      * @return string etag
 225      */
 226
 227     function etag()
 228     {
 229         if (!empty($this->notices) && (count($this->notices) > 0)) {
 230
 231             $last = count($this->notices) - 1;
 232
 233             return '"' . implode(
 234                 ':',
 235                 array($this->arg('action'),
 236                       common_language(),
 237                       $this->user->id,
 238                       strtotime($this->notices[0]->created),
 239                       strtotime($this->notices[$last]->created))
 240             )
 241             . '"';
 242         }
 243
 244         return null;
 245     }
 246
 247 }