actions/apistatusesshow.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Show a notice (as a Twitter-style status)
   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    Tom Blankenship <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 /**
  42  * Returns the notice specified by id as a Twitter-style status and inline user
  43  *
  44  * @category API
  45  * @package  StatusNet
  46  * @author   Craig Andrews <candrews@integralblue.com>
  47  * @author   Evan Prodromou <evan@status.net>
  48  * @author   Jeffery To <jeffery.to@gmail.com>
  49  * @author   Tom Blankenship <mac65@mac65.com>
  50  * @author   Mike Cochrane <mikec@mikenz.geek.nz>
  51  * @author   Robin Millette <robin@millette.info>
  52  * @author   Zach Copley <zach@status.net>
  53  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  54  * @link     http://status.net/
  55  */
  56 class ApiStatusesShowAction extends ApiPrivateAuthAction
  57 {
  58     var $notice_id = null;
  59     var $notice    = null;
  60
  61     /**
  62      * Take arguments for running
  63      *
  64      * @param array $args $_REQUEST args
  65      *
  66      * @return boolean success flag
  67      */
  68     function prepare(array $args=array())
  69     {
  70         parent::prepare($args);
  71
  72         // 'id' is an undocumented parameter in Twitter's API. Several
  73         // clients make use of it, so we support it too.
  74
  75         // show.json?id=12345 takes precedence over /show/12345.json
  76
  77         $this->notice_id = (int)$this->trimmed('id');
  78
  79         if (empty($notice_id)) {
  80             $this->notice_id = (int)$this->arg('id');
  81         }
  82
  83         $this->notice = Notice::getKV((int)$this->notice_id);
  84
  85         return true;
  86     }
  87
  88     /**
  89      * Handle the request
  90      *
  91      * Check the format and show the notice
  92      *
  93      * @param array $args $_REQUEST data (unused)
  94      *
  95      * @return void
  96      */
  97     function handle(array $args=array())
  98     {
  99         parent::handle($args);
 100
 101         if (!in_array($this->format, array('xml', 'json', 'atom'))) {
 102             // TRANS: Client error displayed when coming across a non-supported API method.
 103             $this->clientError(_('API method not found.'), 404);
 104         }
 105
 106         switch ($_SERVER['REQUEST_METHOD']) {
 107         case 'GET':
 108             $this->showNotice();
 109             break;
 110         case 'DELETE':
 111             $this->deleteNotice();
 112             break;
 113         default:
 114             // TRANS: Client error displayed calling an unsupported HTTP error in API status show.
 115             $this->clientError(_('HTTP method not supported.'), 405);
 116         }
 117     }
 118
 119     /**
 120      * Show the notice
 121      *
 122      * @return void
 123      */
 124     function showNotice()
 125     {
 126         if (!empty($this->notice)) {
 127             switch ($this->format) {
 128             case 'xml':
 129                 $this->showSingleXmlStatus($this->notice);
 130                 break;
 131             case 'json':
 132                 $this->show_single_json_status($this->notice);
 133                 break;
 134             case 'atom':
 135                 $this->showSingleAtomStatus($this->notice);
 136                 break;
 137             default:
 138                 // TRANS: Exception thrown requesting an unsupported notice output format.
 139                 // TRANS: %s is the requested output format.
 140                 throw new Exception(sprintf(_("Unsupported format: %s."), $this->format));
 141             }
 142         } else {
 143             // XXX: Twitter just sets a 404 header and doens't bother
 144             // to return an err msg
 145
 146             $deleted = Deleted_notice::getKV($this->notice_id);
 147
 148             if (!empty($deleted)) {
 149                 $this->clientError(
 150                     // TRANS: Client error displayed requesting a deleted status.
 151                     _('Status deleted.'),
 152                     410,
 153                     $this->format
 154                 );
 155             } else {
 156                 $this->clientError(
 157                     // TRANS: Client error displayed requesting a status with an invalid ID.
 158                     _('No status with that ID found.'),
 159                     404,
 160                     $this->format
 161                 );
 162             }
 163         }
 164     }
 165
 166     /**
 167      * We expose AtomPub here, so non-GET/HEAD reqs must be read/write.
 168      *
 169      * @param array $args other arguments
 170      *
 171      * @return boolean true
 172      */
 173
 174     function isReadOnly(array $args=array())
 175     {
 176         return ($_SERVER['REQUEST_METHOD'] == 'GET' || $_SERVER['REQUEST_METHOD'] == 'HEAD');
 177     }
 178
 179     /**
 180      * When was this notice last modified?
 181      *
 182      * @return string datestamp of the latest notice in the stream
 183      */
 184     function lastModified()
 185     {
 186         if (!empty($this->notice)) {
 187             return strtotime($this->notice->created);
 188         }
 189
 190         return null;
 191     }
 192
 193     /**
 194      * An entity tag for this notice
 195      *
 196      * Returns an Etag based on the action name, language, and
 197      * timestamps of the notice
 198      *
 199      * @return string etag
 200      */
 201     function etag()
 202     {
 203         if (!empty($this->notice)) {
 204
 205             return '"' . implode(
 206                 ':',
 207                 array($this->arg('action'),
 208                       common_user_cache_hash($this->auth_user),
 209                       common_language(),
 210                       $this->notice->id,
 211                       strtotime($this->notice->created))
 212             )
 213             . '"';
 214         }
 215
 216         return null;
 217     }
 218
 219     function deleteNotice()
 220     {
 221         if ($this->format != 'atom') {
 222             // TRANS: Client error displayed when trying to delete a notice not using the Atom format.
 223             $this->clientError(_('Can only delete using the Atom format.'));
 224         }
 225
 226         if (empty($this->auth_user) ||
 227             ($this->notice->profile_id != $this->auth_user->id &&
 228              !$this->auth_user->hasRight(Right::DELETEOTHERSNOTICE))) {
 229             // TRANS: Client error displayed when a user has no rights to delete notices of other users.
 230             $this->clientError(_('Cannot delete this notice.'), 403);
 231         }
 232
 233         if (Event::handle('StartDeleteOwnNotice', array($this->auth_user, $this->notice))) {
 234             $this->notice->delete();
 235             Event::handle('EndDeleteOwnNotice', array($this->auth_user, $this->notice));
 236         }
 237
 238         // @fixme is there better output we could do here?
 239
 240         header('HTTP/1.1 200 OK');
 241         header('Content-Type: text/plain');
 242         // TRANS: Confirmation of notice deletion in API. %d is the ID (number) of the deleted notice.
 243         print(sprintf(_('Deleted notice %d'), $this->notice->id));
 244         print("\n");
 245     }
 246 }