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

apistatusesupdate.php 7.85 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 31 32 33 34 35 36 37 38 39
 * @author    Zach Copley <zach@status.net>
 * @copyright 2009 StatusNet, Inc.
 * @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);
}

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

/**
 * Updates the authenticating user's status (posts a notice).
 *
 * @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 58
 * @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/
 */

59
class ApiStatusesUpdateAction extends ApiAuthAction
Zach Copley's avatar
Zach Copley committed
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78
{
    var $source                = null;
    var $status                = null;
    var $in_reply_to_status_id = null;
    static $reserved_sources = array('web', 'omb', 'mail', 'xmpp', 'api');

    /**
     * Take arguments for running
     *
     * @param array $args $_REQUEST args
     *
     * @return boolean success flag
     *
     */

    function prepare($args)
    {
        parent::prepare($args);

79
        $this->user   = $this->auth_user;
Zach Copley's avatar
Zach Copley committed
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
        $this->status = $this->trimmed('status');
        $this->source = $this->trimmed('source');

        if (empty($this->source) || in_array($source, $this->reserved_sources)) {
            $this->source = 'api';
        }

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

        return true;
    }

    /**
     * Handle the request
     *
96
     * Make a new notice for the update, save it, and show it
Zach Copley's avatar
Zach Copley committed
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
     *
     * @param array $args $_REQUEST data (unused)
     *
     * @return void
     */

    function handle($args)
    {
        parent::handle($args);

        if ($_SERVER['REQUEST_METHOD'] != 'POST') {
            $this->clientError(
                _('This method requires a POST.'),
                400, $this->format
            );
            return;
        }

115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
        if (empty($_POST) && $_SERVER['CONTENT_LENGTH']) {
            $this->clientError(sprintf(_('The server was unable to handle ' .
                                         'that much POST data (%s bytes) due to its current configuration.'),
                                       $_SERVER['CONTENT_LENGTH']));
            return;
        }

        if (empty($this->user)) {
            $this->clientError(_('No such user!'), 404, $this->format);
            return;
        }

        if (empty($this->status)) {
            $this->clientError(
                'Client must provide a \'status\' parameter with a value.',
                400,
                $this->format
            );
            return;
        }

Zach Copley's avatar
Zach Copley committed
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
        $status_shortened = common_shorten_links($this->status);

        if (Notice::contentTooLong($status_shortened)) {

            // Note: Twitter truncates anything over 140, flags the status
            // as "truncated."

            $this->clientError(
                sprintf(
                    _('That\'s too long. Max notice size is %d chars.'),
                    Notice::maxContent()
                ),
                406,
                $this->format
            );

            return;
        }

        // Check for commands

        $inter = new CommandInterpreter();
        $cmd = $inter->handle_command($this->user, $status_shortened);

        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!

            $this->notice = $this->user->getCurrentNotice();

        } 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(
                        _('Not found'),
                        $code = 404,
                        $this->format
                    );
                    return;
                }
            }

194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
            $upload = null;

            common_debug('looking for attachment');

            $upload = MediaFile::fromUpload('media', $this->user);

            common_debug("uploaded file = " . var_export($upload, true));

            if (isset($upload)) {
                common_debug('newNotice: found an upload');

                    $status_shortened .= ' ' . $upload->shortUrl();

                    common_debug('content w/upload = ' . $status_shortened);

                    if (Notice::contentTooLong($status_shortened)) {
                        $upload->delete();
                        $this->clientError(sprintf(_('Max notice size is %d chars, including attachment URL.'),
                                                   Notice::maxContent()));
                    } else {
                        common_debug('content not too long');
                    }
            }

Zach Copley's avatar
Zach Copley committed
218 219
            $this->notice = Notice::saveNew(
                $this->user->id,
220
                html_entity_decode($status_shortened, ENT_NOQUOTES, 'UTF-8'),
Zach Copley's avatar
Zach Copley committed
221 222 223 224 225
                $this->source,
                1,
                $reply_to
            );

226 227 228 229
            if (isset($upload)) {
                $upload->attachToNotice($this->notice);
            }

Zach Copley's avatar
Zach Copley committed
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
            common_broadcast_notice($this->notice);
        }

        $this->showNotice();
    }

    /**
     * Show the resulting notice
     *
     * @return void
     */

    function showNotice()
    {
        if (!empty($this->notice)) {
            if ($this->format == 'xml') {
246
                $this->showSingleXmlStatus($this->notice);
Zach Copley's avatar
Zach Copley committed
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273
            } 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',
            'FavCommand', 'OnCommand', 'OffCommand');

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

        return false;
    }

}