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         $this->user = $this->getTargetUser($this->arg('id'));
  76
  77         if (empty($this->user)) {
  78             $this->clientError(_('No such user.'), 404, $this->format);
  79             return;
  80         }
  81
  82         $this->notices = $this->getNotices();
  83
  84         return true;
  85     }
  86
  87     /**
  88      * Handle the request
  89      *
  90      * Just show the notices
  91      *
  92      * @param array $args $_REQUEST data (unused)
  93      *
  94      * @return void
  95      */
  96
  97     function handle($args)
  98     {
  99         parent::handle($args);
 100         $this->showTimeline();
 101     }
 102
 103     /**
 104      * Show the timeline of notices
 105      *
 106      * @return void
 107      */
 108
 109     function showTimeline()
 110     {
 111         $profile    = $this->user->getProfile();
 112         $avatar     = $profile->getAvatar(AVATAR_PROFILE_SIZE);
 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         $logo       = ($avatar) ? $avatar->displayUrl() : Avatar::defaultImage(AVATAR_PROFILE_SIZE);
 125
 126         switch($this->format) {
 127         case 'xml':
 128             $this->showXmlTimeline($this->notices);
 129             break;
 130         case 'rss':
 131             $this->showRssTimeline($this->notices, $title, $link, $subtitle, null, $logo);
 132             break;
 133         case 'atom':
 134
 135             $target_id = $this->arg('id');
 136
 137             if (isset($target_id)) {
 138                 $selfuri = common_root_url() .
 139                   'api/statuses/friends_timeline/' .
 140                   $target_id . '.atom';
 141             } else {
 142                 $selfuri = common_root_url() .
 143                   'api/statuses/friends_timeline.atom';
 144             }
 145
 146             $this->showAtomTimeline(
 147                                     $this->notices, $title, $id, $link,
 148                                     $subtitle, null, $selfuri, $logo
 149                                     );
 150             break;
 151         case 'json':
 152             $this->showJsonTimeline($this->notices);
 153             break;
 154         default:
 155             $this->clientError(_('API method not found.'), $code = 404);
 156             break;
 157         }
 158     }
 159
 160     /**
 161      * Get notices
 162      *
 163      * @return array notices
 164      */
 165
 166     function getNotices()
 167     {
 168         $notices = array();
 169
 170         if (!empty($this->auth_user) && $this->auth_user->id == $this->user->id) {
 171             $notice = $this->user->ownFriendsTimeline(($this->page-1) * $this->count,
 172                                                       $this->count, $this->since_id,
 173                                                       $this->max_id, $this->since);
 174         } else {
 175             $notice = $this->user->friendsTimeline(($this->page-1) * $this->count,
 176                                                    $this->count, $this->since_id,
 177                                                    $this->max_id, $this->since);
 178         }
 179
 180         while ($notice->fetch()) {
 181             $notices[] = clone($notice);
 182         }
 183
 184         return $notices;
 185     }
 186
 187     /**
 188      * Is this action read only?
 189      *
 190      * @param array $args other arguments
 191      *
 192      * @return boolean true
 193      */
 194
 195     function isReadOnly($args)
 196     {
 197         return true;
 198     }
 199
 200     /**
 201      * When was this feed last modified?
 202      *
 203      * @return string datestamp of the latest notice in the stream
 204      */
 205
 206     function lastModified()
 207     {
 208         if (!empty($this->notices) && (count($this->notices) > 0)) {
 209             return strtotime($this->notices[0]->created);
 210         }
 211
 212         return null;
 213     }
 214
 215     /**
 216      * An entity tag for this stream
 217      *
 218      * Returns an Etag based on the action name, language, user ID, and
 219      * timestamps of the first and last notice in the timeline
 220      *
 221      * @return string etag
 222      */
 223
 224     function etag()
 225     {
 226         if (!empty($this->notices) && (count($this->notices) > 0)) {
 227
 228             $last = count($this->notices) - 1;
 229
 230             return '"' . implode(
 231                                  ':',
 232                                  array($this->arg('action'),
 233                                        common_language(),
 234                                        $this->user->id,
 235                                        strtotime($this->notices[0]->created),
 236                                        strtotime($this->notices[$last]->created))
 237                                  )
 238               . '"';
 239         }
 240
 241         return null;
 242     }
 243
 244 }