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