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    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 target user.
  44  * This is the equivalent of 'You and friends' page accessed via Web.
  45  *
  46  * @category API
  47  * @package  StatusNet
  48  * @author   Craig Andrews <candrews@integralblue.com>
  49  * @author   Evan Prodromou <evan@status.net>
  50  * @author   Jeffery To <jeffery.to@gmail.com>
  51  * @author   mac65 <mac65@mac65.com>
  52  * @author   Mike Cochrane <mikec@mikenz.geek.nz>
  53  * @author   Robin Millette <robin@millette.info>
  54  * @author   Zach Copley <zach@status.net>
  55  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  56  * @link     http://status.net/
  57  */
  58
  59 class ApiTimelineFriendsAction extends ApiBareAuthAction
  60 {
  61     var $notices  = null;
  62
  63     /**
  64      * Take arguments for running
  65      *
  66      * @param array $args $_REQUEST args
  67      *
  68      * @return boolean success flag
  69      *
  70      */
  71
  72     function prepare($args)
  73     {
  74         parent::prepare($args);
  75         common_debug("api friends_timeline");
  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->showXmlTimeline($this->notices);
 128             break;
 129         case 'rss':
 130             $this->showRssTimeline($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->showAtomTimeline(
 146                 $this->notices, $title, $id, $link,
 147                 $subtitle, null, $selfuri
 148             );
 149             break;
 150         case 'json':
 151             $this->showJsonTimeline($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 }