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

apistatusesupdate.php 13.3 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
 *
 * Post a notice (update your status) through the API
 *
 * 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
 * @author    Zach Copley <zach@status.net>
31
 * @copyright 2009-2010 StatusNet, Inc.
32
 * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
Zach Copley's avatar
Zach Copley committed
33 34 35 36
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link      http://status.net/
 */

37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
/* External API usage documentation. Please update when you change how this method works. */

/*! @page statusesupdate statuses/update

    @section Description
    Updates the authenticating user's status. Requires the status parameter specified below.
    Request must be a POST.

    @par URL pattern
    /api/statuses/update.:format

    @par Formats (:format)
    xml, json

    @par HTTP Method(s)
    POST

    @par Requires Authentication
    Yes

    @param status (Required) The URL-encoded text of the status update.
58
    @param source (Optional) The source application name, if using HTTP authentication or an anonymous OAuth consumer.
59 60 61 62 63 64 65 66 67 68 69
    @param in_reply_to_status_id (Optional) The ID of an existing status that the update is in reply to.
    @param lat (Optional) The latitude the status refers to.
    @param long (Optional) The longitude the status refers to.
    @param media (Optional) a media upload, such as an image or movie file.

    @sa @ref authentication
    @sa @ref apiroot

    @subsection usagenotes Usage notes

    @li The URL pattern is relative to the @ref apiroot.
70
    @li If the @e source parameter is not supplied the source of the status will default to 'api'. When authenticated via a registered OAuth application, the application's registered name and URL will always override the source parameter.
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
    @li The XML response uses <a href="http://georss.org/Main_Page">GeoRSS</a>
    to encode the latitude and longitude (see example response below <georss:point>).
    @li Data uploaded via the @e media parameter should be multipart/form-data encoded.

    @subsection exampleusage Example usage

    @verbatim
    curl -u username:password http://example.com/api/statuses/update.xml -d status='Howdy!' -d lat='30.468' -d long='-94.743'
    @endverbatim

    @subsection exampleresponse Example response

    @verbatim
    <?xml version="1.0" encoding="UTF-8"?>
    <status>
      <text>Howdy!</text>
      <truncated>false</truncated>
      <created_at>Tue Mar 30 23:28:05 +0000 2010</created_at>
      <in_reply_to_status_id/>
      <source>api</source>
      <id>26668724</id>
      <in_reply_to_user_id/>
      <in_reply_to_screen_name/>
      <geo xmlns:georss="http://www.georss.org/georss">
        <georss:point>30.468 -94.743</georss:point>
      </geo>
      <favorited>false</favorited>
      <user>
        <id>25803</id>
        <name>Jed Sanders</name>
        <screen_name>jedsanders</screen_name>
        <location>Hoop and Holler, Texas</location>
        <description>I like to think of myself as America's Favorite.</description>
        <profile_image_url>http://avatar.example.com/25803-48-20080924200604.png</profile_image_url>
        <url>http://jedsanders.net</url>
        <protected>false</protected>
        <followers_count>5</followers_count>
        <profile_background_color/>
        <profile_text_color/>
        <profile_link_color/>
        <profile_sidebar_fill_color/>
        <profile_sidebar_border_color/>
        <friends_count>2</friends_count>
        <created_at>Wed Sep 24 20:04:00 +0000 2008</created_at>
        <favourites_count>0</favourites_count>
        <utc_offset>0</utc_offset>
        <time_zone>UTC</time_zone>
        <profile_background_image_url/>
        <profile_background_tile>false</profile_background_tile>
        <statuses_count>70</statuses_count>
        <following>true</following>
        <notifications>true</notifications>
      </user>
    </status>
    @endverbatim
*/

Zach Copley's avatar
Zach Copley committed
128 129 130 131
if (!defined('STATUSNET')) {
    exit(1);
}

Zach Copley's avatar
Zach Copley committed
132
require_once INSTALLDIR . '/lib/apiauth.php';
133
require_once INSTALLDIR . '/lib/mediafile.php';
Zach Copley's avatar
Zach Copley committed
134 135 136 137 138 139

/**
 * Updates the authenticating user's status (posts a notice).
 *
 * @category API
 * @package  StatusNet
Zach Copley's avatar
Zach Copley committed
140 141 142 143 144 145
 * @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
146 147 148 149
 * @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/
 */
150
class ApiStatusesUpdateAction extends ApiAuthAction
Zach Copley's avatar
Zach Copley committed
151 152 153
{
    var $status                = null;
    var $in_reply_to_status_id = null;
154 155 156
    var $lat                   = null;
    var $lon                   = null;

Zach Copley's avatar
Zach Copley committed
157 158 159 160 161 162 163 164 165 166 167 168
    /**
     * Take arguments for running
     *
     * @param array $args $_REQUEST args
     *
     * @return boolean success flag
     */
    function prepare($args)
    {
        parent::prepare($args);

        $this->status = $this->trimmed('status');
169 170
        $this->lat    = $this->trimmed('lat');
        $this->lon    = $this->trimmed('long');
Zach Copley's avatar
Zach Copley committed
171 172 173 174 175 176 177 178 179 180

        $this->in_reply_to_status_id
            = intval($this->trimmed('in_reply_to_status_id'));

        return true;
    }

    /**
     * Handle the request
     *
181
     * Make a new notice for the update, save it, and show it
Zach Copley's avatar
Zach Copley committed
182 183 184 185 186 187 188 189 190 191 192
     *
     * @param array $args $_REQUEST data (unused)
     *
     * @return void
     */
    function handle($args)
    {
        parent::handle($args);

        if ($_SERVER['REQUEST_METHOD'] != 'POST') {
            $this->clientError(
Siebrand Mazeland's avatar
Siebrand Mazeland committed
193
                // TRANS: Client error. POST is a HTTP command. It should not be translated.
Zach Copley's avatar
Zach Copley committed
194
                _('This method requires a POST.'),
195 196
                400,
                $this->format
Zach Copley's avatar
Zach Copley committed
197 198 199 200
            );
            return;
        }

201 202 203 204 205 206 207
        // Workaround for PHP returning empty $_POST and $_FILES when POST
        // length > post_max_size in php.ini

        if (empty($_FILES)
            && empty($_POST)
            && ($_SERVER['CONTENT_LENGTH'] > 0)
        ) {
Siebrand Mazeland's avatar
Siebrand Mazeland committed
208 209 210 211 212
             // TRANS: Client error displayed when the number of bytes in a POST request exceeds a limit.
             // TRANS: %s is the number of bytes of the CONTENT_LENGTH.
             $msg = _m('The server was unable to handle that much POST data (%s byte) due to its current configuration.',
                      'The server was unable to handle that much POST data (%s bytes) due to its current configuration.',
                      intval($_SERVER['CONTENT_LENGTH']));
213 214 215 216 217

            $this->clientError(sprintf($msg, $_SERVER['CONTENT_LENGTH']));
            return;
        }

218 219
        if (empty($this->status)) {
            $this->clientError(
Siebrand Mazeland's avatar
Siebrand Mazeland committed
220
                // TRANS: Client error displayed when the parameter "status" is missing.
221
                _('Client must provide a \'status\' parameter with a value.'),
222 223 224
                400,
                $this->format
            );
225 226 227
            return;
        }

228
        if (empty($this->auth_user)) {
Siebrand Mazeland's avatar
Siebrand Mazeland committed
229
            // TRANS: Client error displayed when updating a status for a non-existing user.
230
            $this->clientError(_('No such user.'), 404, $this->format);
231 232 233
            return;
        }

234
        $status_shortened = $this->auth_user->shortenlinks($this->status);
Zach Copley's avatar
Zach Copley committed
235 236 237 238 239 240 241

        if (Notice::contentTooLong($status_shortened)) {
            // Note: Twitter truncates anything over 140, flags the status
            // as "truncated."

            $this->clientError(
                sprintf(
242 243
                    // TRANS: Client error displayed exceeding the maximum notice length.
                    // TRANS: %d is the maximum length for a notice.
Siebrand Mazeland's avatar
Siebrand Mazeland committed
244 245 246
                    _m('That\'s too long. Maximum notice size is %d character.',
                      'That\'s too long. Maximum notice size is %d characters.',
                      Notice::maxContent()),
Zach Copley's avatar
Zach Copley committed
247 248 249 250 251 252 253 254 255 256 257 258
                    Notice::maxContent()
                ),
                406,
                $this->format
            );

            return;
        }

        // Check for commands

        $inter = new CommandInterpreter();
259
        $cmd = $inter->handle_command($this->auth_user, $status_shortened);
Zach Copley's avatar
Zach Copley committed
260 261 262 263 264 265 266 267 268 269

        if ($cmd) {
            if ($this->supported($cmd)) {
                $cmd->execute(new Channel());
            }

            // Cmd not supported?  Twitter just returns your latest status.
            // And, it returns your last status whether the cmd was successful
            // or not!

270
            $this->notice = $this->auth_user->getCurrentNotice();
Zach Copley's avatar
Zach Copley committed
271 272 273 274 275 276 277 278 279 280 281 282
        } else {
            $reply_to = null;

            if (!empty($this->in_reply_to_status_id)) {
                // Check whether notice actually exists

                $reply = Notice::staticGet($this->in_reply_to_status_id);

                if ($reply) {
                    $reply_to = $this->in_reply_to_status_id;
                } else {
                    $this->clientError(
Siebrand Mazeland's avatar
Siebrand Mazeland committed
283 284
                        // TRANS: Client error displayed when replying to a non-existing notice.
                        _('Parent notice not found.'),
Zach Copley's avatar
Zach Copley committed
285 286 287 288 289 290 291
                        $code = 404,
                        $this->format
                    );
                    return;
                }
            }

292
            $upload = null;
293 294

            try {
295
                $upload = MediaFile::fromUpload('media', $this->auth_user);
296 297
            } catch (Exception $e) {
                $this->clientError($e->getMessage(), $e->getCode(), $this->format);
298 299
                return;
            }
300 301

            if (isset($upload)) {
302
                $status_shortened .= ' ' . $upload->shortUrl();
303
                $status_shortened = $this->auth_user->shortenlinks($status_shortened);
304

305 306
                if (Notice::contentTooLong($status_shortened)) {
                    $upload->delete();
Siebrand Mazeland's avatar
Siebrand Mazeland committed
307 308
                    // TRANS: Client error displayed exceeding the maximum notice length.
                    // TRANS: %d is the maximum lenth for a notice.
Siebrand Mazeland's avatar
Siebrand Mazeland committed
309 310 311
                    $msg = _m('Maximum notice size is %d character, including attachment URL.',
                             'Maximum notice size is %d characters, including attachment URL.',
                             Notice::maxContent());
312 313 314 315 316
                    $this->clientError(
                        sprintf($msg, Notice::maxContent()),
                        400,
                        $this->format
                    );
317
                }
318 319
            }

Evan Prodromou's avatar
Evan Prodromou committed
320
            $content = html_entity_decode($status_shortened, ENT_NOQUOTES, 'UTF-8');
321 322 323

            $options = array('reply_to' => $reply_to);

324
            if ($this->auth_user->shareLocation()) {
325 326 327 328 329

                $locOptions = Notice::locationOptions($this->lat,
                                                      $this->lon,
                                                      null,
                                                      null,
330
                                                      $this->auth_user->getProfile());
331 332

                $options = array_merge($options, $locOptions);
333 334
            }

335 336 337 338 339 340 341 342
            try {
                $this->notice = Notice::saveNew(
                    $this->auth_user->id,
                    $content,
                    $this->source,
                    $options
                );
            } catch (Exception $e) {
343
                $this->clientError($e->getMessage(), $e->getCode(), $this->format);
344 345
                return;
            }
Zach Copley's avatar
Zach Copley committed
346

347 348 349
            if (isset($upload)) {
                $upload->attachToNotice($this->notice);
            }
Zach Copley's avatar
Zach Copley committed
350 351 352 353 354 355 356 357 358 359 360 361 362 363
        }

        $this->showNotice();
    }

    /**
     * Show the resulting notice
     *
     * @return void
     */
    function showNotice()
    {
        if (!empty($this->notice)) {
            if ($this->format == 'xml') {
364
                $this->showSingleXmlStatus($this->notice);
Zach Copley's avatar
Zach Copley committed
365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
            } elseif ($this->format == 'json') {
                $this->show_single_json_status($this->notice);
            }
        }
    }

    /**
     * Is this command supported when doing an update from the API?
     *
     * @param string $cmd the command to check for
     *
     * @return boolean true or false
     */
    function supported($cmd)
    {
        static $cmdlist = array('MessageCommand', 'SubCommand', 'UnsubCommand',
381
            'FavCommand', 'OnCommand', 'OffCommand', 'JoinCommand', 'LeaveCommand');
Zach Copley's avatar
Zach Copley committed
382 383 384 385 386 387 388 389

        if (in_array(get_class($cmd), $cmdlist)) {
            return true;
        }

        return false;
    }
}