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
  59 class ApiTimelineMentionsAction extends ApiBareAuthAction
  60 {
  61
  62     var $notices = null;
  63
  64     /**
  65      * Take arguments for running
  66      *
  67      * @param array $args $_REQUEST args
  68      *
  69      * @return boolean success flag
  70      *
  71      */
  72
  73     function prepare($args)
  74     {
  75         parent::prepare($args);
  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         $avatar     = $profile->getAvatar(AVATAR_PROFILE_SIZE);
 115
 116         $sitename   = common_config('site', 'name');
 117         $title      = sprintf(
 118             _('%1$s / Updates mentioning %2$s'),
 119             $sitename, $this->user->nickname
 120         );
 121         $taguribase = TagURI::base();
 122         $id         = "tag:$taguribase:Mentions:" . $this->user->id;
 123         $link       = common_local_url(
 124             'replies',
 125             array('nickname' => $this->user->nickname)
 126         );
 127
 128         $self = $this->getSelfUri();
 129
 130         $subtitle   = sprintf(
 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
 153             header('Content-Type: application/atom+xml; charset=utf-8');
 154
 155             $atom = new AtomNoticeFeed($this->auth_user);
 156
 157             $atom->setId($id);
 158             $atom->setTitle($title);
 159             $atom->setSubtitle($subtitle);
 160             $atom->setLogo($logo);
 161             $atom->setUpdated('now');
 162
 163             $atom->addLink($link);
 164             $atom->setSelfLink($self);
 165
 166             $atom->addEntryFromNotices($this->notices);
 167             $this->raw($atom->getString());
 168
 169             break;
 170         case 'json':
 171             $this->showJsonTimeline($this->notices);
 172             break;
 173         default:
 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
 185     function getNotices()
 186     {
 187         $notices = array();
 188
 189         $notice = $this->user->getReplies(
 190             ($this->page - 1) * $this->count, $this->count,
 191             $this->since_id, $this->max_id
 192         );
 193
 194         while ($notice->fetch()) {
 195             $notices[] = clone($notice);
 196         }
 197
 198         return $notices;
 199     }
 200
 201     /**
 202      * Is this action read only?
 203      *
 204      * @param array $args other arguments
 205      *
 206      * @return boolean true
 207      */
 208
 209     function isReadOnly($args)
 210     {
 211         return true;
 212     }
 213
 214     /**
 215      * When was this feed last modified?
 216      *
 217      * @return string datestamp of the latest notice in the stream
 218      */
 219
 220     function lastModified()
 221     {
 222         if (!empty($this->notices) && (count($this->notices) > 0)) {
 223             return strtotime($this->notices[0]->created);
 224         }
 225
 226         return null;
 227     }
 228
 229     /**
 230      * An entity tag for this stream
 231      *
 232      * Returns an Etag based on the action name, language, user ID, and
 233      * timestamps of the first and last notice in the timeline
 234      *
 235      * @return string etag
 236      */
 237
 238     function etag()
 239     {
 240         if (!empty($this->notices) && (count($this->notices) > 0)) {
 241
 242             $last = count($this->notices) - 1;
 243
 244             return '"' . implode(
 245                 ':',
 246                 array($this->arg('action'),
 247                       common_user_cache_hash($this->auth_user),
 248                       common_language(),
 249                       $this->user->id,
 250                       strtotime($this->notices[0]->created),
 251                       strtotime($this->notices[$last]->created))
 252             )
 253             . '"';
 254         }
 255
 256         return null;
 257     }
 258
 259 }