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

apiaccountverifycredentials.php 3.01 KB
Newer Older
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
 *
 * Test if supplied user credentials are valid.
 *
 * 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
 * @author    Evan Prodromou <evan@status.net>
 * @author    Robin Millette <robin@millette.info>
26 27 28 29 30 31 32 33 34 35
 * @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
36
require_once INSTALLDIR . '/lib/apiauth.php';
37 38 39 40 41 42 43 44

/**
 * Check a user's credentials. Returns an HTTP 200 OK response code and a
 * representation of the requesting user if authentication was successful;
 * returns a 401 status code and an error message if not.
 *
 * @category API
 * @package  StatusNet
Zach Copley's avatar
Zach Copley committed
45 46
 * @author   Evan Prodromou <evan@status.net>
 * @author   Robin Millette <robin@millette.info>
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
 * @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/
 */
class ApiAccountVerifyCredentialsAction extends ApiAuthAction
{
    /**
     * Handle the request
     *
     * Check whether the credentials are valid and output the result
     *
     * @param array $args $_REQUEST data (unused)
     *
     * @return void
     */
    function handle($args)
    {
        parent::handle($args);

66
        if (!in_array($this->format, array('xml', 'json'))) {
67
            // TRANS: Client error displayed when coming across a non-supported API method.
68 69 70 71 72 73 74 75
            $this->clientError(_('API method not found.'), $code = 404);
            return;
        }

        $twitter_user = $this->twitterUserArray($this->auth_user->getProfile(), true);

        if ($this->format == 'xml') {
            $this->initDocument('xml');
76
            $this->showTwitterXmlUser($twitter_user, 'user', true);
77 78 79 80 81
            $this->endDocument('xml');
        } elseif ($this->format == 'json') {
            $this->initDocument('json');
            $this->showJsonObjects($twitter_user);
            $this->endDocument('json');
82 83 84 85
        }

    }

86 87 88 89
    /**
     * Is this action read only?
     *
     * @param array $args other arguments
90
     *
91
     * @return boolean true
Siebrand Mazeland's avatar
Siebrand Mazeland committed
92
     */
93 94 95 96
    function isReadOnly($args)
    {
        return true;
    }
97
}