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