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

apistatusesupdate.php 13.2 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 132 133 134 135 136
if (!defined('STATUSNET')) {
    exit(1);
}

/**
 * Updates the authenticating user's status (posts a notice).
 *
 * @category API
 * @package  StatusNet
Zach Copley's avatar
Zach Copley committed
137 138 139 140 141 142
 * @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
143 144 145 146
 * @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/
 */
147
class ApiStatusesUpdateAction extends ApiAuthAction
Zach Copley's avatar
Zach Copley committed
148
{
149 150
    protected $needPost = true;

Zach Copley's avatar
Zach Copley committed
151 152
    var $status                = null;
    var $in_reply_to_status_id = null;
153 154
    var $lat                   = null;
    var $lon                   = null;
155
    var $media_ids             = array();   // file_id in the keys
156

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

        $this->status = $this->trimmed('status');
169 170
        $this->lat    = $this->trimmed('lat');
        $this->lon    = $this->trimmed('long');
171 172 173 174 175 176 177 178 179 180 181 182
        $matches = array();
        common_debug(get_called_class().': media_ids=='._ve($this->trimmed('media_ids')));
        if (preg_match_all('/\d+/', $this->trimmed('media_ids'), $matches) !== false) {
            foreach (array_unique($matches[0]) as $match) {
                try {
                    $this->media_ids[$match] = true;    // = File::getByID($match);
                } catch (Exception $e) {
                    // Either $match was 0 (EmptyIdException) or File was not found (NoResultException)
                    // Do we abort and report to the client?
                }
            }
        }
Zach Copley's avatar
Zach Copley committed
183 184 185 186 187 188 189 190 191 192

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

        return true;
    }

    /**
     * Handle the request
     *
193
     * Make a new notice for the update, save it, and show it
Zach Copley's avatar
Zach Copley committed
194 195 196
     *
     * @return void
     */
197
    protected function handle()
Zach Copley's avatar
Zach Copley committed
198
    {
199
        parent::handle();
Zach Copley's avatar
Zach Copley committed
200

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

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

217
        if (empty($this->status)) {
218 219
            // TRANS: Client error displayed when the parameter "status" is missing.
            $this->clientError(_('Client must provide a \'status\' parameter with a value.'));
220 221
        }

222
        if (is_null($this->scoped)) {
Siebrand Mazeland's avatar
Siebrand Mazeland committed
223
            // TRANS: Client error displayed when updating a status for a non-existing user.
224
            $this->clientError(_('No such user.'), 404);
225 226
        }

mattl's avatar
mattl committed
227
        /* Do not call shortenLinks until the whole notice has been build */
Zach Copley's avatar
Zach Copley committed
228 229 230 231

        // Check for commands

        $inter = new CommandInterpreter();
232
        $cmd = $inter->handle_command($this->auth_user, $this->status);
Zach Copley's avatar
Zach Copley committed
233 234 235 236 237 238 239 240 241 242

        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!

243
            $this->notice = $this->auth_user->getCurrentNotice();
Zach Copley's avatar
Zach Copley committed
244 245 246 247 248 249
        } else {
            $reply_to = null;

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

250
                $reply = Notice::getKV($this->in_reply_to_status_id);
Zach Copley's avatar
Zach Copley committed
251 252 253 254

                if ($reply) {
                    $reply_to = $this->in_reply_to_status_id;
                } else {
255 256
                    // TRANS: Client error displayed when replying to a non-existing notice.
                    $this->clientError(_('Parent notice not found.'), 404);
Zach Copley's avatar
Zach Copley committed
257 258 259
                }
            }

260 261 262 263 264 265 266
            common_debug(get_called_class().': parsed media_ids=='._ve($this->media_ids));
            foreach(array_keys($this->media_ids) as $media_id) {
                // FIXME: Validation on this... Worst case is that if someone sends bad media_ids then
                // we'll fill the notice with non-working links, so no real harm, done, but let's fix.
                $this->status .= ' ' . common_local_url('attachment', array('attachment' => $media_id));
            }

267
            $upload = null;
268
            try {
269
                $upload = MediaFile::fromUpload('media', $this->scoped);
270
                $this->status .= ' ' . $upload->shortUrl();
mattl's avatar
mattl committed
271
                /* Do not call shortenLinks until the whole notice has been build */
mattl's avatar
mattl committed
272 273
            } catch (NoUploadedMediaException $e) {
                // There was no uploaded media for us today.
274 275 276
            }

            /* Do call shortenlinks here & check notice length since notice is about to be saved & sent */
mattl's avatar
mattl committed
277
            $status_shortened = $this->auth_user->shortenLinks($this->status);
278 279

            if (Notice::contentTooLong($status_shortened)) {
mattl's avatar
mattl committed
280
                if ($upload instanceof MediaFile) {
281 282
                    $upload->delete();
                }
283 284 285 286 287 288 289 290
                // TRANS: Client error displayed exceeding the maximum notice length.
                // TRANS: %d is the maximum lenth for a notice.
                $msg = _m('Maximum notice size is %d character, including attachment URL.',
                          'Maximum notice size is %d characters, including attachment URL.',
                          Notice::maxContent());
                /* Use HTTP 413 error code (Request Entity Too Large)
                 * instead of basic 400 for better understanding
                 */
291
                $this->clientError(sprintf($msg, Notice::maxContent()), 413);
292 293
            }

294

Evan Prodromou's avatar
Evan Prodromou committed
295
            $content = html_entity_decode($status_shortened, ENT_NOQUOTES, 'UTF-8');
296 297 298

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

299
            if ($this->scoped->shareLocation()) {
300 301 302 303 304

                $locOptions = Notice::locationOptions($this->lat,
                                                      $this->lon,
                                                      null,
                                                      null,
305
                                                      $this->scoped);
306 307

                $options = array_merge($options, $locOptions);
308 309
            }

310 311
            try {
                $this->notice = Notice::saveNew(
312
                    $this->scoped->id,
313 314 315 316 317
                    $content,
                    $this->source,
                    $options
                );
            } catch (Exception $e) {
318
                $this->clientError($e->getMessage(), $e->getCode());
319
            }
Zach Copley's avatar
Zach Copley committed
320

321 322 323
            if (isset($upload)) {
                $upload->attachToNotice($this->notice);
            }
Zach Copley's avatar
Zach Copley committed
324 325 326 327 328 329 330 331 332 333 334 335 336 337
        }

        $this->showNotice();
    }

    /**
     * Show the resulting notice
     *
     * @return void
     */
    function showNotice()
    {
        if (!empty($this->notice)) {
            if ($this->format == 'xml') {
338
                $this->showSingleXmlStatus($this->notice);
Zach Copley's avatar
Zach Copley committed
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353
            } 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)
    {
354
        static $cmdlist = array('SubCommand', 'UnsubCommand',
355
            'OnCommand', 'OffCommand', 'JoinCommand', 'LeaveCommand');
Zach Copley's avatar
Zach Copley committed
356

357 358 359 360
        $supported = null;

        if (Event::handle('CommandSupportedAPI', array($cmd, &$supported))) {
            $supported = $supported || in_array(get_class($cmd), $cmdlist);
Zach Copley's avatar
Zach Copley committed
361 362
        }

363
        return $supported;
Zach Copley's avatar
Zach Copley committed
364 365
    }
}