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