We are no longer offering accounts on this server. Consider https://gitlab.freedesktop.org/ as a place to host projects.

apistatusesshow.php 7.7 KB
Newer Older
Zach Copley's avatar
Zach Copley committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
<?php
/**
 * StatusNet, the distributed open-source microblogging tool
 *
 * Show a notice (as a Twitter-style status)
 *
 * PHP version 5
 *
 * LICENCE: This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @category  API
 * @package   StatusNet
Zach Copley's avatar
Zach Copley committed
24 25 26 27 28 29
 * @author    Craig Andrews <candrews@integralblue.com>
 * @author    Evan Prodromou <evan@status.net>
 * @author    Jeffery To <jeffery.to@gmail.com>
 * @author    Tom Blankenship <mac65@mac65.com>
 * @author    Mike Cochrane <mikec@mikenz.geek.nz>
 * @author    Robin Millette <robin@millette.info>
Zach Copley's avatar
Zach Copley committed
30 31
 * @author    Zach Copley <zach@status.net>
 * @copyright 2009 StatusNet, Inc.
32
 * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
Zach Copley's avatar
Zach Copley committed
33 34 35 36 37 38 39 40
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link      http://status.net/
 */

if (!defined('STATUSNET')) {
    exit(1);
}

41
require_once INSTALLDIR . '/lib/apiprivateauth.php';
Zach Copley's avatar
Zach Copley committed
42 43 44 45 46 47

/**
 * Returns the notice specified by id as a Twitter-style status and inline user
 *
 * @category API
 * @package  StatusNet
Zach Copley's avatar
Zach Copley committed
48 49 50 51 52 53
 * @author   Craig Andrews <candrews@integralblue.com>
 * @author   Evan Prodromou <evan@status.net>
 * @author   Jeffery To <jeffery.to@gmail.com>
 * @author   Tom Blankenship <mac65@mac65.com>
 * @author   Mike Cochrane <mikec@mikenz.geek.nz>
 * @author   Robin Millette <robin@millette.info>
Zach Copley's avatar
Zach Copley committed
54 55 56 57
 * @author   Zach Copley <zach@status.net>
 * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link     http://status.net/
 */
58
class ApiStatusesShowAction extends ApiPrivateAuthAction
Zach Copley's avatar
Zach Copley committed
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
{
    var $notice_id = null;
    var $notice    = null;

    /**
     * Take arguments for running
     *
     * @param array $args $_REQUEST args
     *
     * @return boolean success flag
     */
    function prepare($args)
    {
        parent::prepare($args);

        // 'id' is an undocumented parameter in Twitter's API. Several
        // clients make use of it, so we support it too.

        // show.json?id=12345 takes precedence over /show/12345.json

        $this->notice_id = (int)$this->trimmed('id');

        if (empty($notice_id)) {
            $this->notice_id = (int)$this->arg('id');
        }

        $this->notice = Notice::staticGet((int)$this->notice_id);

        return true;
    }

    /**
     * Handle the request
     *
Zach Copley's avatar
Zach Copley committed
93
     * Check the format and show the notice
Zach Copley's avatar
Zach Copley committed
94 95 96 97 98 99 100 101 102
     *
     * @param array $args $_REQUEST data (unused)
     *
     * @return void
     */
    function handle($args)
    {
        parent::handle($args);

103
        if (!in_array($this->format, array('xml', 'json', 'atom'))) {
Siebrand Mazeland's avatar
Siebrand Mazeland committed
104
            // TRANS: Client error displayed when trying to handle an unknown API method.
105
            $this->clientError(_('API method not found.'), 404);
Zach Copley's avatar
Zach Copley committed
106 107 108
            return;
        }

Evan Prodromou's avatar
Evan Prodromou committed
109 110 111 112 113 114 115 116
        switch ($_SERVER['REQUEST_METHOD']) {
        case 'GET':
            $this->showNotice();
            break;
        case 'DELETE':
            $this->deleteNotice();
            break;
        default:
117
            // TRANS: Client error displayed calling an unsupported HTTP error in API status show.
Evan Prodromou's avatar
Evan Prodromou committed
118 119 120
            $this->clientError(_('HTTP method not supported.'), 405);
            return;
        }
Zach Copley's avatar
Zach Copley committed
121 122 123
    }

    /**
Zach Copley's avatar
Zach Copley committed
124
     * Show the notice
Zach Copley's avatar
Zach Copley committed
125 126 127 128 129 130
     *
     * @return void
     */
    function showNotice()
    {
        if (!empty($this->notice)) {
131 132
            switch ($this->format) {
            case 'xml':
133
                $this->showSingleXmlStatus($this->notice);
134 135
                break;
            case 'json':
Zach Copley's avatar
Zach Copley committed
136
                $this->show_single_json_status($this->notice);
137 138 139 140 141
                break;
            case 'atom':
                $this->showSingleAtomStatus($this->notice);
                break;
            default:
142 143
                // TRANS: Exception thrown requesting an unsupported notice output format.
                // TRANS: %s is the requested output format.
144
                throw new Exception(sprintf(_("Unsupported format: %s"), $this->format));
Zach Copley's avatar
Zach Copley committed
145 146 147 148 149 150 151 152 153
            }
        } else {
            // XXX: Twitter just sets a 404 header and doens't bother
            // to return an err msg

            $deleted = Deleted_notice::staticGet($this->notice_id);

            if (!empty($deleted)) {
                $this->clientError(
Siebrand Mazeland's avatar
Siebrand Mazeland committed
154
                    // TRANS: Client error displayed requesting a deleted status.
Zach Copley's avatar
Zach Copley committed
155 156
                    _('Status deleted.'),
                    410,
Zach Copley's avatar
Zach Copley committed
157 158 159 160
                    $this->format
                );
            } else {
                $this->clientError(
Siebrand Mazeland's avatar
Siebrand Mazeland committed
161
                    // TRANS: Client error displayed requesting a status with an invalid ID.
Zach Copley's avatar
Zach Copley committed
162
                    _('No status with that ID found.'),
Zach Copley's avatar
Zach Copley committed
163
                    404,
Zach Copley's avatar
Zach Copley committed
164 165 166 167 168 169 170
                    $this->format
                );
            }
        }
    }

    /**
171
     * We expose AtomPub here, so non-GET/HEAD reqs must be read/write.
Zach Copley's avatar
Zach Copley committed
172 173 174 175 176
     *
     * @param array $args other arguments
     *
     * @return boolean true
     */
177

Zach Copley's avatar
Zach Copley committed
178 179
    function isReadOnly($args)
    {
180
        return ($_SERVER['REQUEST_METHOD'] == 'GET' || $_SERVER['REQUEST_METHOD'] == 'HEAD');
Zach Copley's avatar
Zach Copley committed
181 182 183 184 185 186 187 188 189 190
    }

    /**
     * When was this notice last modified?
     *
     * @return string datestamp of the latest notice in the stream
     */
    function lastModified()
    {
        if (!empty($this->notice)) {
191
            return strtotime($this->notice->created);
Zach Copley's avatar
Zach Copley committed
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
        }

        return null;
    }

    /**
     * An entity tag for this notice
     *
     * Returns an Etag based on the action name, language, and
     * timestamps of the notice
     *
     * @return string etag
     */
    function etag()
    {
        if (!empty($this->notice)) {

            return '"' . implode(
                ':',
                array($this->arg('action'),
212
                      common_user_cache_hash($this->auth_user),
Zach Copley's avatar
Zach Copley committed
213 214 215 216 217 218 219 220 221 222
                      common_language(),
                      $this->notice->id,
                      strtotime($this->notice->created))
            )
            . '"';
        }

        return null;
    }

Evan Prodromou's avatar
Evan Prodromou committed
223 224 225
    function deleteNotice()
    {
        if ($this->format != 'atom') {
226
            // TRANS: Client error displayed when trying to delete a notice not using the Atom format.
Evan Prodromou's avatar
Evan Prodromou committed
227 228 229 230 231 232 233
            $this->clientError(_("Can only delete using the Atom format."));
            return;
        }

        if (empty($this->auth_user) ||
            ($this->notice->profile_id != $this->auth_user->id &&
             !$this->auth_user->hasRight(Right::DELETEOTHERSNOTICE))) {
234 235
            // TRANS: Client error displayed when a user has no rights to delete notices of other users.
            $this->clientError(_('Cannot delete this notice.'), 403);
Evan Prodromou's avatar
Evan Prodromou committed
236 237 238 239 240 241 242 243 244 245 246 247
            return;
        }

        if (Event::handle('StartDeleteOwnNotice', array($this->auth_user, $this->notice))) {
            $this->notice->delete();
            Event::handle('EndDeleteOwnNotice', array($this->auth_user, $this->notice));
        }

        // @fixme is there better output we could do here?

        header('HTTP/1.1 200 OK');
        header('Content-Type: text/plain');
248
        // TRANS: Confirmation of notice deletion in API. %d is the ID (number) of the deleted notice.
Evan Prodromou's avatar
Evan Prodromou committed
249 250 251
        print(sprintf(_('Deleted notice %d'), $this->notice->id));
        print("\n");
    }
Zach Copley's avatar
Zach Copley committed
252
}