actions/apitimelinefavorites.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Show a user's favorite notices
   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    Zach Copley <zach@status.net> * @copyright 2009 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET')) {
  32     exit(1);
  33 }
  34
  35 require_once INSTALLDIR.'/lib/apibareauth.php';
  36
  37 /**
  38  * Returns the 20 most recent favorite notices for the authenticating user or user
  39  * specified by the ID parameter in the requested format.
  40  *
  41  * @category API
  42  * @package  StatusNet
  43  * @author   Craig Andrews <candrews@integralblue.com>
  44  * @author   Evan Prodromou <evan@status.net>
  45  * @author   Zach Copley <zach@status.net>
  46  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  47  * @link     http://status.net/
  48  */
  49
  50 class ApiTimelineFavoritesAction extends ApiBareAuthAction
  51 {
  52     var $notices  = null;
  53
  54     /**
  55      * Take arguments for running
  56      *
  57      * @param array $args $_REQUEST args
  58      *
  59      * @return boolean success flag
  60      *
  61      */
  62
  63     function prepare($args)
  64     {
  65         parent::prepare($args);
  66
  67         $this->user = $this->getTargetUser($this->arg('id'));
  68
  69         if (empty($this->user)) {
  70             $this->clientError(_('No such user!'), 404, $this->format);
  71             return;
  72         }
  73
  74         $this->notices = $this->getNotices();
  75
  76         return true;
  77     }
  78
  79     /**
  80      * Handle the request
  81      *
  82      * Just show the notices
  83      *
  84      * @param array $args $_REQUEST data (unused)
  85      *
  86      * @return void
  87      */
  88
  89     function handle($args)
  90     {
  91         parent::handle($args);
  92         $this->showTimeline();
  93     }
  94
  95     /**
  96      * Show the timeline of notices
  97      *
  98      * @return void
  99      */
 100
 101     function showTimeline()
 102     {
 103         $profile = $this->user->getProfile();
 104
 105         $sitename   = common_config('site', 'name');
 106         $title      = sprintf(
 107             _('%s / Favorites from %s'),
 108             $sitename,
 109             $this->user->nickname
 110         );
 111
 112         $taguribase = common_config('integration', 'taguri');
 113         $id         = "tag:$taguribase:Favorites:" . $this->user->id;
 114         $link       = common_local_url(
 115             'favorites',
 116             array('nickname' => $this->user->nickname)
 117         );
 118         $subtitle   = sprintf(
 119             _('%s updates favorited by %s / %s.'),
 120             $sitename,
 121             $profile->getBestName(),
 122             $this->user->nickname
 123         );
 124
 125         switch($this->format) {
 126         case 'xml':
 127             $this->showXmlTimeline($this->notices);
 128             break;
 129         case 'rss':
 130             $this->showRssTimeline($this->notices, $title, $link, $subtitle);
 131             break;
 132         case 'atom':
 133             $selfuri = common_root_url() .
 134                 ltrim($_SERVER['QUERY_STRING'], 'p=');
 135             $this->showAtomTimeline(
 136                 $this->notices, $title, $id, $link, $subtitle,
 137                 null, $selfuri
 138             );
 139             break;
 140         case 'json':
 141             $this->showJsonTimeline($this->notices);
 142             break;
 143         default:
 144             $this->clientError(_('API method not found!'), $code = 404);
 145             break;
 146         }
 147     }
 148
 149     /**
 150      * Get notices
 151      *
 152      * @return array notices
 153      */
 154
 155     function getNotices()
 156     {
 157         $notices = array();
 158
 159         if (!empty($this->auth_user) && $this->auth_user->id == $this->user->id) {
 160             $notice = $this->user->favoriteNotices(
 161                 ($this->page-1) * $this->count,
 162                 $this->count,
 163                 true
 164             );
 165         } else {
 166             $notice = $this->user->favoriteNotices(
 167                 ($this->page-1) * $this->count,
 168                 $this->count,
 169                 false
 170             );
 171         }
 172
 173         while ($notice->fetch()) {
 174             $notices[] = clone($notice);
 175         }
 176
 177         return $notices;
 178     }
 179
 180     /**
 181      * Is this action read only?
 182      *
 183      * @param array $args other arguments
 184      *
 185      * @return boolean true
 186      */
 187
 188     function isReadOnly($args)
 189     {
 190         return true;
 191     }
 192
 193     /**
 194      * When was this feed last modified?
 195      *
 196      * @return string datestamp of the latest notice in the stream
 197      */
 198
 199     function lastModified()
 200     {
 201         if (!empty($this->notices) && (count($this->notices) > 0)) {
 202             return strtotime($this->notices[0]->created);
 203         }
 204
 205         return null;
 206     }
 207
 208     /**
 209      * An entity tag for this stream
 210      *
 211      * Returns an Etag based on the action name, language, user ID, and
 212      * timestamps of the first and last notice in the timeline
 213      *
 214      * @return string etag
 215      */
 216
 217     function etag()
 218     {
 219         if (!empty($this->notices) && (count($this->notices) > 0)) {
 220
 221             $last = count($this->notices) - 1;
 222
 223             return '"' . implode(
 224                 ':',
 225                 array($this->arg('action'),
 226                       common_language(),
 227                       $this->user->id,
 228                       strtotime($this->notices[0]->created),
 229                       strtotime($this->notices[$last]->created))
 230             )
 231             . '"';
 232         }
 233
 234         return null;
 235     }
 236
 237 }