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