actions/apitimelinementions.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Show notices mentioning a user (@nickname)
   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  * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
  33  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  34  * @link      http://status.net/
  35  */
  36
  37 if (!defined('STATUSNET')) {
  38     exit(1);
  39 }
  40
  41 require_once INSTALLDIR . '/lib/apibareauth.php';
  42
  43 /**
  44  * Returns the most recent (default 20) mentions (status containing @nickname)
  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 class ApiTimelineMentionsAction extends ApiBareAuthAction
  59 {
  60     var $notices = null;
  61
  62     /**
  63      * Take arguments for running
  64      *
  65      * @param array $args $_REQUEST args
  66      *
  67      * @return boolean success flag
  68      */
  69     function prepare($args)
  70     {
  71         parent::prepare($args);
  72
  73         $this->user = $this->getTargetUser($this->arg('id'));
  74
  75         if (empty($this->user)) {
  76             // TRANS: Client error displayed when requesting most recent mentions for a non-existing user.
  77             $this->clientError(_('No such user.'), 404, $this->format);
  78             return;
  79         }
  80
  81         $this->notices = $this->getNotices();
  82
  83         return true;
  84     }
  85
  86     /**
  87      * Handle the request
  88      *
  89      * Just show the notices
  90      *
  91      * @param array $args $_REQUEST data (unused)
  92      *
  93      * @return void
  94      */
  95     function handle($args)
  96     {
  97         parent::handle($args);
  98         $this->showTimeline();
  99     }
 100
 101     /**
 102      * Show the timeline of notices
 103      *
 104      * @return void
 105      */
 106     function showTimeline()
 107     {
 108         $profile = $this->user->getProfile();
 109         $avatar     = $profile->getAvatar(AVATAR_PROFILE_SIZE);
 110
 111         $sitename   = common_config('site', 'name');
 112         $title      = sprintf(
 113             // TRANS: Title for timeline of most recent mentions of a user.
 114             // TRANS: %1$s is the StatusNet sitename, %2$s is a user nickname.
 115             _('%1$s / Updates mentioning %2$s'),
 116             $sitename, $this->user->nickname
 117         );
 118         $taguribase = TagURI::base();
 119         $id         = "tag:$taguribase:Mentions:" . $this->user->id;
 120         $link       = common_local_url(
 121             'replies',
 122             array('nickname' => $this->user->nickname)
 123         );
 124
 125         $self = $this->getSelfUri();
 126
 127         $subtitle   = sprintf(
 128             // TRANS: Subtitle for timeline of most recent mentions of a user.
 129             // TRANS: %1$s is the StatusNet sitename, %2$s is a user nickname,
 130             // TRANS: %3$s is a user's full name.
 131             _('%1$s updates that reply to updates from %2$s / %3$s.'),
 132             $sitename, $this->user->nickname, $profile->getBestName()
 133         );
 134         $logo = ($avatar) ? $avatar->displayUrl() : Avatar::defaultImage(AVATAR_PROFILE_SIZE);
 135
 136         switch($this->format) {
 137         case 'xml':
 138             $this->showXmlTimeline($this->notices);
 139             break;
 140         case 'rss':
 141             $this->showRssTimeline(
 142                 $this->notices,
 143                 $title,
 144                 $link,
 145                 $subtitle,
 146                 null,
 147                 $logo,
 148                 $self
 149             );
 150             break;
 151         case 'atom':
 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             // TRANS: Client error displayed when trying to handle an unknown API method.
 174             $this->clientError(_('API method not found.'), $code = 404);
 175             break;
 176         }
 177     }
 178
 179     /**
 180      * Get notices
 181      *
 182      * @return array notices
 183      */
 184     function getNotices()
 185     {
 186         $notices = array();
 187
 188         $notice = $this->user->getReplies(
 189             ($this->page - 1) * $this->count, $this->count,
 190             $this->since_id, $this->max_id
 191         );
 192
 193         while ($notice->fetch()) {
 194             $notices[] = clone($notice);
 195         }
 196
 197         return $notices;
 198     }
 199
 200     /**
 201      * Is this action read only?
 202      *
 203      * @param array $args other arguments
 204      *
 205      * @return boolean true
 206      */
 207     function isReadOnly($args)
 208     {
 209         return true;
 210     }
 211
 212     /**
 213      * When was this feed last modified?
 214      *
 215      * @return string datestamp of the latest notice in the stream
 216      */
 217     function lastModified()
 218     {
 219         if (!empty($this->notices) && (count($this->notices) > 0)) {
 220             return strtotime($this->notices[0]->created);
 221         }
 222
 223         return null;
 224     }
 225
 226     /**
 227      * An entity tag for this stream
 228      *
 229      * Returns an Etag based on the action name, language, user ID, and
 230      * timestamps of the first and last notice in the timeline
 231      *
 232      * @return string etag
 233      */
 234     function etag()
 235     {
 236         if (!empty($this->notices) && (count($this->notices) > 0)) {
 237
 238             $last = count($this->notices) - 1;
 239
 240             return '"' . implode(
 241                 ':',
 242                 array($this->arg('action'),
 243                       common_user_cache_hash($this->auth_user),
 244                       common_language(),
 245                       $this->user->id,
 246                       strtotime($this->notices[0]->created),
 247                       strtotime($this->notices[$last]->created))
 248             )
 249             . '"';
 250         }
 251
 252         return null;
 253     }
 254 }