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 = TagURI::base();
 116         $id         = "tag:$taguribase:FriendsTimeline:" . $this->user->id;
 117
 118         $subtitle = sprintf(
 119             // TRANS: Message is used as a subtitle. %1$s is a user nickname, %2$s is a site name.
 120             _('Updates from %1$s and friends on %2$s!'),
 121             $this->user->nickname,
 122             $sitename
 123         );
 124
 125         $link = common_local_url(
 126             'all',
 127              array('nickname' => $this->user->nickname)
 128         );
 129
 130         $self = $this->getSelfUri();
 131
 132         $logo = (!empty($avatar))
 133             ? $avatar->displayUrl()
 134             : Avatar::defaultImage(AVATAR_PROFILE_SIZE);
 135
 136         switch($this->format) {
 137         case 'xml':
 138             $this->showXmlTimeline($this->notices);
 139             break;
 140         case 'rss':
 141
 142             $this->showRssTimeline(
 143                 $this->notices,
 144                 $title,
 145                 $link,
 146                 $subtitle,
 147                 null,
 148                 $logo,
 149                 $self
 150             );
 151             break;
 152         case 'atom':
 153
 154             header('Content-Type: application/atom+xml; charset=utf-8');
 155
 156             $atom = new AtomNoticeFeed();
 157
 158             $atom->setId($id);
 159             $atom->setTitle($title);
 160             $atom->setSubtitle($subtitle);
 161             $atom->setLogo($logo);
 162             $atom->setUpdated('now');
 163             $atom->addLink($link);
 164             $atom->setSelfLink($self);
 165
 166             $atom->addEntryFromNotices($this->notices);
 167
 168             $this->raw($atom->getString());
 169
 170             break;
 171         case 'json':
 172             $this->showJsonTimeline($this->notices);
 173             break;
 174         default:
 175             $this->clientError(_('API method not found.'), $code = 404);
 176             break;
 177         }
 178     }
 179
 180     /**
 181      * Get notices
 182      *
 183      * @return array notices
 184      */
 185
 186     function getNotices()
 187     {
 188         $notices = array();
 189
 190         if (!empty($this->auth_user) && $this->auth_user->id == $this->user->id) {
 191             $notice = $this->user->ownFriendsTimeline(($this->page-1) * $this->count,
 192                                                       $this->count, $this->since_id,
 193                                                       $this->max_id);
 194         } else {
 195             $notice = $this->user->friendsTimeline(($this->page-1) * $this->count,
 196                                                    $this->count, $this->since_id,
 197                                                    $this->max_id);
 198         }
 199
 200         while ($notice->fetch()) {
 201             $notices[] = clone($notice);
 202         }
 203
 204         return $notices;
 205     }
 206
 207     /**
 208      * Is this action read only?
 209      *
 210      * @param array $args other arguments
 211      *
 212      * @return boolean true
 213      */
 214
 215     function isReadOnly($args)
 216     {
 217         return true;
 218     }
 219
 220     /**
 221      * When was this feed last modified?
 222      *
 223      * @return string datestamp of the latest notice in the stream
 224      */
 225
 226     function lastModified()
 227     {
 228         if (!empty($this->notices) && (count($this->notices) > 0)) {
 229             return strtotime($this->notices[0]->created);
 230         }
 231
 232         return null;
 233     }
 234
 235     /**
 236      * An entity tag for this stream
 237      *
 238      * Returns an Etag based on the action name, language, user ID, and
 239      * timestamps of the first and last notice in the timeline
 240      *
 241      * @return string etag
 242      */
 243
 244     function etag()
 245     {
 246         if (!empty($this->notices) && (count($this->notices) > 0)) {
 247
 248             $last = count($this->notices) - 1;
 249
 250             return '"' . implode(
 251                                  ':',
 252                                  array($this->arg('action'),
 253                                        common_language(),
 254                                        $this->user->id,
 255                                        strtotime($this->notices[0]->created),
 256                                        strtotime($this->notices[$last]->created))
 257                                  )
 258               . '"';
 259         }
 260
 261         return null;
 262     }
 263
 264 }