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>
  27  * @copyright 2009-2010 StatusNet, Inc.
  28  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  29  * @link      http://status.net/
  30  */
  31
  32 if (!defined('STATUSNET')) {
  33     exit(1);
  34 }
  35
  36 require_once INSTALLDIR.'/lib/apibareauth.php';
  37
  38 /**
  39  * Returns the 20 most recent favorite notices for the authenticating user or user
  40  * specified by the ID parameter in the requested format.
  41  *
  42  * @category API
  43  * @package  StatusNet
  44  * @author   Craig Andrews <candrews@integralblue.com>
  45  * @author   Evan Prodromou <evan@status.net>
  46  * @author   Zach Copley <zach@status.net>
  47  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  48  * @link     http://status.net/
  49  */
  50
  51 class ApiTimelineFavoritesAction extends ApiBareAuthAction
  52 {
  53     var $notices  = null;
  54
  55     /**
  56      * Take arguments for running
  57      *
  58      * @param array $args $_REQUEST args
  59      *
  60      * @return boolean success flag
  61      *
  62      */
  63
  64     function prepare($args)
  65     {
  66         parent::prepare($args);
  67
  68         $this->user = $this->getTargetUser($this->arg('id'));
  69
  70         if (empty($this->user)) {
  71             $this->clientError(_('No such user.'), 404, $this->format);
  72             return;
  73         }
  74
  75         $this->notices = $this->getNotices();
  76
  77         return true;
  78     }
  79
  80     /**
  81      * Handle the request
  82      *
  83      * Just show the notices
  84      *
  85      * @param array $args $_REQUEST data (unused)
  86      *
  87      * @return void
  88      */
  89
  90     function handle($args)
  91     {
  92         parent::handle($args);
  93         $this->showTimeline();
  94     }
  95
  96     /**
  97      * Show the timeline of notices
  98      *
  99      * @return void
 100      */
 101
 102     function showTimeline()
 103     {
 104         $profile  = $this->user->getProfile();
 105         $avatar   = $profile->getAvatar(AVATAR_PROFILE_SIZE);
 106
 107         $sitename = common_config('site', 'name');
 108         $title    = sprintf(
 109             _('%1$s / Favorites from %2$s'),
 110             $sitename,
 111             $this->user->nickname
 112         );
 113
 114         $taguribase = TagURI::base();
 115         $id         = "tag:$taguribase:Favorites:" . $this->user->id;
 116
 117         $subtitle = sprintf(
 118             _('%1$s updates favorited by %2$s / %2$s.'),
 119             $sitename,
 120             $profile->getBestName(),
 121             $this->user->nickname
 122         );
 123         $logo = !empty($avatar)
 124             ? $avatar->displayUrl()
 125             : Avatar::defaultImage(AVATAR_PROFILE_SIZE);
 126
 127         $link = common_local_url(
 128             'showfavorites',
 129             array('nickname' => $this->user->nickname)
 130         );
 131
 132         $self = $this->getSelfUri();
 133
 134         switch($this->format) {
 135         case 'xml':
 136             $this->showXmlTimeline($this->notices);
 137             break;
 138         case 'rss':
 139             $this->showRssTimeline(
 140                 $this->notices,
 141                 $title,
 142                 $link,
 143                 $subtitle,
 144                 null,
 145                 $logo,
 146                 $self
 147             );
 148             break;
 149         case 'atom':
 150
 151             header('Content-Type: application/atom+xml; charset=utf-8');
 152
 153             $atom = new AtomNoticeFeed();
 154
 155             $atom->setId($id);
 156             $atom->setTitle($title);
 157             $atom->setSubtitle($subtitle);
 158             $atom->setLogo($logo);
 159             $atom->setUpdated('now');
 160
 161             $atom->addLink($link);
 162             $atom->setSelfLink($self);
 163
 164             $atom->addEntryFromNotices($this->notices);
 165
 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         common_debug("since id = " . $this->since_id . " max id = " . $this->max_id);
 189
 190         if (!empty($this->auth_user) && $this->auth_user->id == $this->user->id) {
 191             $notice = $this->user->favoriteNotices(
 192                 true,
 193                 ($this->page-1) * $this->count,
 194                 $this->count,
 195                 $this->since_id,
 196                 $this->max_id
 197             );
 198         } else {
 199             $notice = $this->user->favoriteNotices(
 200                 false,
 201                 ($this->page-1) * $this->count,
 202                 $this->count,
 203                 $this->since_id,
 204                 $this->max_id
 205             );
 206         }
 207
 208         while ($notice->fetch()) {
 209             $notices[] = clone($notice);
 210         }
 211
 212         return $notices;
 213     }
 214
 215     /**
 216      * Is this action read only?
 217      *
 218      * @param array $args other arguments
 219      *
 220      * @return boolean true
 221      */
 222
 223     function isReadOnly($args)
 224     {
 225         return true;
 226     }
 227
 228     /**
 229      * When was this feed last modified?
 230      *
 231      * @return string datestamp of the latest notice in the stream
 232      */
 233
 234     function lastModified()
 235     {
 236         if (!empty($this->notices) && (count($this->notices) > 0)) {
 237             return strtotime($this->notices[0]->created);
 238         }
 239
 240         return null;
 241     }
 242
 243     /**
 244      * An entity tag for this stream
 245      *
 246      * Returns an Etag based on the action name, language, user ID, and
 247      * timestamps of the first and last notice in the timeline
 248      *
 249      * @return string etag
 250      */
 251
 252     function etag()
 253     {
 254         if (!empty($this->notices) && (count($this->notices) > 0)) {
 255
 256             $last = count($this->notices) - 1;
 257
 258             return '"' . implode(
 259                 ':',
 260                 array($this->arg('action'),
 261                       common_language(),
 262                       $this->user->id,
 263                       strtotime($this->notices[0]->created),
 264                       strtotime($this->notices[$last]->created))
 265             )
 266             . '"';
 267         }
 268
 269         return null;
 270     }
 271
 272 }