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-2010 StatusNet, Inc.
  32  * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
  33  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  34  * @link      http://status.net/
  35  */
  36
  37 /* External API usage documentation. Please update when you change how this method works. */
  38
  39 /*! @page friendstimeline statuses/friends_timeline
  40
  41     @section Description
  42     Returns the 20 most recent statuses posted by the authenticating
  43     user and that user's friends. This is the equivalent of "You and
  44     friends" page in the web interface.
  45
  46     @par URL patterns
  47     @li /api/statuses/friends_timeline.:format
  48     @li /api/statuses/friends_timeline/:id.:format
  49
  50     @par Formats (:format)
  51     xml, json, rss, atom
  52
  53     @par ID (:id)
  54     username, user id
  55
  56     @par HTTP Method(s)
  57     GET
  58
  59     @par Requires Authentication
  60     Sometimes (see: @ref authentication)
  61
  62     @param user_id (Optional) Specifies a user by ID
  63     @param screen_name (Optional) Specifies a user by screename (nickname)
  64     @param since_id (Optional) Returns only statuses with an ID greater
  65     than (that is, more recent than) the specified ID.
  66     @param max_id (Optional) Returns only statuses with an ID less than
  67     (that is, older than) or equal to the specified ID.
  68     @param count (Optional) Specifies the number of statuses to retrieve.
  69     @param page (Optional) Specifies the page of results to retrieve.
  70
  71     @sa @ref authentication
  72     @sa @ref apiroot
  73
  74     @subsection usagenotes Usage notes
  75     @li The URL pattern is relative to the @ref apiroot.
  76     @li The XML response uses <a href="http://georss.org/Main_Page">GeoRSS</a>
  77     to encode the latitude and longitude (see example response below <georss:point>).
  78
  79     @subsection exampleusage Example usage
  80
  81     @verbatim
  82     curl http://identi.ca/api/statuses/friends_timeline/evan.xml?count=1&page=2
  83     @endverbatim
  84
  85     @subsection exampleresponse Example response
  86
  87     @verbatim
  88     <?xml version="1.0"?>
  89     <statuses type="array">
  90       <status>
  91         <text>back from the !yul !drupal meet with Evolving Web folk, @anarcat, @webchick and others, and an interesting refresher on SQL indexing</text>
  92         <truncated>false</truncated>
  93         <created_at>Wed Mar 31 01:33:02 +0000 2010</created_at>
  94         <in_reply_to_status_id/>
  95         <source>&lt;a href="http://code.google.com/p/microblog-purple/"&gt;mbpidgin&lt;/a&gt;</source>
  96         <id>26674201</id>
  97         <in_reply_to_user_id/>
  98         <in_reply_to_screen_name/>
  99         <geo/>
 100         <favorited>false</favorited>
 101         <user>
 102           <id>246</id>
 103           <name>Mark</name>
 104           <screen_name>lambic</screen_name>
 105           <location>Montreal, Canada</location>
 106           <description>Geek</description>
 107           <profile_image_url>http://avatar.identi.ca/246-48-20080702141545.png</profile_image_url>
 108           <url>http://lambic.co.uk</url>
 109           <protected>false</protected>
 110           <followers_count>73</followers_count>
 111           <profile_background_color>#F0F2F5</profile_background_color>
 112           <profile_text_color/>
 113           <profile_link_color>#002E6E</profile_link_color>
 114           <profile_sidebar_fill_color>#CEE1E9</profile_sidebar_fill_color>
 115           <profile_sidebar_border_color/>
 116           <friends_count>58</friends_count>
 117           <created_at>Wed Jul 02 14:12:15 +0000 2008</created_at>
 118           <favourites_count>2</favourites_count>
 119           <utc_offset>-14400</utc_offset>
 120           <time_zone>US/Eastern</time_zone>
 121           <profile_background_image_url/>
 122           <profile_background_tile>false</profile_background_tile>
 123           <statuses_count>933</statuses_count>
 124           <following>false</following>
 125           <notifications>false</notifications>
 126         </user>
 127       </status>
 128     </statuses>
 129     @endverbatim
 130 */
 131
 132 if (!defined('STATUSNET')) {
 133     exit(1);
 134 }
 135
 136 require_once INSTALLDIR . '/lib/apibareauth.php';
 137
 138 /**
 139  * Returns the most recent notices (default 20) posted by the target user.
 140  * This is the equivalent of 'You and friends' page accessed via Web.
 141  *
 142  * @category API
 143  * @package  StatusNet
 144  * @author   Craig Andrews <candrews@integralblue.com>
 145  * @author   Evan Prodromou <evan@status.net>
 146  * @author   Jeffery To <jeffery.to@gmail.com>
 147  * @author   mac65 <mac65@mac65.com>
 148  * @author   Mike Cochrane <mikec@mikenz.geek.nz>
 149  * @author   Robin Millette <robin@millette.info>
 150  * @author   Zach Copley <zach@status.net>
 151  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 152  * @link     http://status.net/
 153  */
 154
 155 class ApiTimelineFriendsAction extends ApiBareAuthAction
 156 {
 157     var $notices  = null;
 158
 159     /**
 160      * Take arguments for running
 161      *
 162      * @param array $args $_REQUEST args
 163      *
 164      * @return boolean success flag
 165      *
 166      */
 167
 168     function prepare($args)
 169     {
 170         parent::prepare($args);
 171         $this->user = $this->getTargetUser($this->arg('id'));
 172
 173         if (empty($this->user)) {
 174             $this->clientError(_('No such user.'), 404, $this->format);
 175             return;
 176         }
 177
 178         $this->notices = $this->getNotices();
 179
 180         return true;
 181     }
 182
 183     /**
 184      * Handle the request
 185      *
 186      * Just show the notices
 187      *
 188      * @param array $args $_REQUEST data (unused)
 189      *
 190      * @return void
 191      */
 192
 193     function handle($args)
 194     {
 195         parent::handle($args);
 196         $this->showTimeline();
 197     }
 198
 199     /**
 200      * Show the timeline of notices
 201      *
 202      * @return void
 203      */
 204
 205     function showTimeline()
 206     {
 207         $profile    = $this->user->getProfile();
 208         $avatar     = $profile->getAvatar(AVATAR_PROFILE_SIZE);
 209         $sitename   = common_config('site', 'name');
 210         $title      = sprintf(_("%s and friends"), $this->user->nickname);
 211         $taguribase = TagURI::base();
 212         $id         = "tag:$taguribase:FriendsTimeline:" . $this->user->id;
 213
 214         $subtitle = sprintf(
 215             // TRANS: Message is used as a subtitle. %1$s is a user nickname, %2$s is a site name.
 216             _('Updates from %1$s and friends on %2$s!'),
 217             $this->user->nickname,
 218             $sitename
 219         );
 220
 221         $link = common_local_url(
 222             'all',
 223              array('nickname' => $this->user->nickname)
 224         );
 225
 226         $self = $this->getSelfUri();
 227
 228         $logo = (!empty($avatar))
 229             ? $avatar->displayUrl()
 230             : Avatar::defaultImage(AVATAR_PROFILE_SIZE);
 231
 232         switch($this->format) {
 233         case 'xml':
 234             $this->showXmlTimeline($this->notices);
 235             break;
 236         case 'rss':
 237
 238             $this->showRssTimeline(
 239                 $this->notices,
 240                 $title,
 241                 $link,
 242                 $subtitle,
 243                 null,
 244                 $logo,
 245                 $self
 246             );
 247             break;
 248         case 'atom':
 249
 250             header('Content-Type: application/atom+xml; charset=utf-8');
 251
 252             $atom = new AtomNoticeFeed($this->auth_user);
 253
 254             $atom->setId($id);
 255             $atom->setTitle($title);
 256             $atom->setSubtitle($subtitle);
 257             $atom->setLogo($logo);
 258             $atom->setUpdated('now');
 259             $atom->addLink($link);
 260             $atom->setSelfLink($self);
 261
 262             $atom->addEntryFromNotices($this->notices);
 263
 264             $this->raw($atom->getString());
 265
 266             break;
 267         case 'json':
 268             $this->showJsonTimeline($this->notices);
 269             break;
 270         default:
 271             $this->clientError(_('API method not found.'), $code = 404);
 272             break;
 273         }
 274     }
 275
 276     /**
 277      * Get notices
 278      *
 279      * @return array notices
 280      */
 281
 282     function getNotices()
 283     {
 284         $notices = array();
 285
 286         if (!empty($this->auth_user) && $this->auth_user->id == $this->user->id) {
 287             $notice = $this->user->ownFriendsTimeline(($this->page-1) * $this->count,
 288                                                       $this->count, $this->since_id,
 289                                                       $this->max_id);
 290         } else {
 291             $notice = $this->user->friendsTimeline(($this->page-1) * $this->count,
 292                                                    $this->count, $this->since_id,
 293                                                    $this->max_id);
 294         }
 295
 296         while ($notice->fetch()) {
 297             $notices[] = clone($notice);
 298         }
 299
 300         return $notices;
 301     }
 302
 303     /**
 304      * Is this action read only?
 305      *
 306      * @param array $args other arguments
 307      *
 308      * @return boolean true
 309      */
 310
 311     function isReadOnly($args)
 312     {
 313         return true;
 314     }
 315
 316     /**
 317      * When was this feed last modified?
 318      *
 319      * @return string datestamp of the latest notice in the stream
 320      */
 321
 322     function lastModified()
 323     {
 324         if (!empty($this->notices) && (count($this->notices) > 0)) {
 325             return strtotime($this->notices[0]->created);
 326         }
 327
 328         return null;
 329     }
 330
 331     /**
 332      * An entity tag for this stream
 333      *
 334      * Returns an Etag based on the action name, language, user ID, and
 335      * timestamps of the first and last notice in the timeline
 336      *
 337      * @return string etag
 338      */
 339
 340     function etag()
 341     {
 342         if (!empty($this->notices) && (count($this->notices) > 0)) {
 343
 344             $last = count($this->notices) - 1;
 345
 346             return '"' . implode(
 347                                  ':',
 348                                  array($this->arg('action'),
 349                                        common_user_cache_hash($this->auth_user),
 350                                        common_language(),
 351                                        $this->user->id,
 352                                        strtotime($this->notices[0]->created),
 353                                        strtotime($this->notices[$last]->created))
 354                                  )
 355               . '"';
 356         }
 357
 358         return null;
 359     }
 360
 361 }