actions/apitimelinehome.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Show the home 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 ApiTimelineHomeAction 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 home_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         $avatar     = $profile->getAvatar(AVATAR_PROFILE_SIZE);
 114         $sitename   = common_config('site', 'name');
 115         $title      = sprintf(_("%s and friends"), $this->user->nickname);
 116         $taguribase = common_config('integration', 'taguri');
 117         $id         = "tag:$taguribase:HomeTimeline:" . $this->user->id;
 118         $link       = common_local_url(
 119             'all', array('nickname' => $this->user->nickname)
 120         );
 121         $subtitle   = sprintf(
 122             _('Updates from %1$s and friends on %2$s!'),
 123             $this->user->nickname, $sitename
 124         );
 125         $logo       = ($avatar) ? $avatar->displayUrl() : Avatar::defaultImage(AVATAR_PROFILE_SIZE);
 126
 127         switch($this->format) {
 128         case 'xml':
 129             $this->showXmlTimeline($this->notices);
 130             break;
 131         case 'rss':
 132             $this->showRssTimeline($this->notices, $title, $link, $subtitle, null, $logo);
 133             break;
 134         case 'atom':
 135
 136             $target_id = $this->arg('id');
 137
 138             if (isset($target_id)) {
 139                 $selfuri = common_root_url() .
 140                     'api/statuses/home_timeline/' .
 141                     $target_id . '.atom';
 142             } else {
 143                 $selfuri = common_root_url() .
 144                     'api/statuses/home_timeline.atom';
 145             }
 146
 147             $this->showAtomTimeline(
 148                 $this->notices, $title, $id, $link,
 149                 $subtitle, null, $selfuri, $logo
 150             );
 151             break;
 152         case 'json':
 153             $this->showJsonTimeline($this->notices);
 154             break;
 155         default:
 156             $this->clientError(_('API method not found!'), $code = 404);
 157             break;
 158         }
 159     }
 160
 161     /**
 162      * Get notices
 163      *
 164      * @return array notices
 165      */
 166
 167     function getNotices()
 168     {
 169         $notices = array();
 170
 171         if (!empty($this->auth_user) && $this->auth_user->id == $this->user->id) {
 172             $notice = $this->user->noticeInbox(
 173                 ($this->page-1) * $this->count,
 174                 $this->count, $this->since_id,
 175                 $this->max_id, $this->since
 176             );
 177         } else {
 178             $notice = $this->user->noticesWithFriends(
 179                 ($this->page-1) * $this->count,
 180                 $this->count, $this->since_id,
 181                 $this->max_id, $this->since
 182             );
 183         }
 184
 185         while ($notice->fetch()) {
 186             $notices[] = clone($notice);
 187         }
 188
 189         return $notices;
 190     }
 191
 192     /**
 193      * Is this action read only?
 194      *
 195      * @param array $args other arguments
 196      *
 197      * @return boolean true
 198      */
 199
 200     function isReadOnly($args)
 201     {
 202         return true;
 203     }
 204
 205     /**
 206      * When was this feed last modified?
 207      *
 208      * @return string datestamp of the latest notice in the stream
 209      */
 210
 211     function lastModified()
 212     {
 213         if (!empty($this->notices) && (count($this->notices) > 0)) {
 214             return strtotime($this->notices[0]->created);
 215         }
 216
 217         return null;
 218     }
 219
 220     /**
 221      * An entity tag for this stream
 222      *
 223      * Returns an Etag based on the action name, language, user ID, and
 224      * timestamps of the first and last notice in the timeline
 225      *
 226      * @return string etag
 227      */
 228
 229     function etag()
 230     {
 231         if (!empty($this->notices) && (count($this->notices) > 0)) {
 232
 233             $last = count($this->notices) - 1;
 234
 235             return '"' . implode(
 236                 ':',
 237                 array($this->arg('action'),
 238                       common_language(),
 239                       $this->user->id,
 240                       strtotime($this->notices[0]->created),
 241                       strtotime($this->notices[$last]->created))
 242             )
 243             . '"';
 244         }
 245
 246         return null;
 247     }
 248
 249 }