]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/apiaccountverifycredentials.php
Stronger typing and fixes in RequireValidatedEmail
[quix0rs-gnu-social.git] / actions / apiaccountverifycredentials.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * Test if supplied user credentials are valid.
6  *
7  * PHP version 5
8  *
9  * LICENCE: This program is free software: you can redistribute it and/or modify
10  * it under the terms of the GNU Affero General Public License as published by
11  * the Free Software Foundation, either version 3 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU Affero General Public License for more details.
18  *
19  * You should have received a copy of the GNU Affero General Public License
20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
21  *
22  * @category  API
23  * @package   StatusNet
24  * @author    Evan Prodromou <evan@status.net>
25  * @author    Robin Millette <robin@millette.info>
26  * @author    Zach Copley <zach@status.net>
27  * @copyright 2009 StatusNet, Inc.
28  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
29  * @link      http://status.net/
30  */
31
32 if (!defined('STATUSNET')) {
33     exit(1);
34 }
35
36 /**
37  * Check a user's credentials. Returns an HTTP 200 OK response code and a
38  * representation of the requesting user if authentication was successful;
39  * returns a 401 status code and an error message if not.
40  *
41  * @category API
42  * @package  StatusNet
43  * @author   Evan Prodromou <evan@status.net>
44  * @author   Robin Millette <robin@millette.info>
45  * @author   Zach Copley <zach@status.net>
46  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
47  * @link     http://status.net/
48  */
49 class ApiAccountVerifyCredentialsAction extends ApiAuthAction
50 {
51     protected function handle()
52     {
53         parent::handle();
54
55         if (!in_array($this->format, array('xml', 'json'))) {
56             // TRANS: Client error displayed when coming across a non-supported API method.
57             $this->clientError(_('API method not found.'), $code = 404);
58         }
59
60         $twitter_user = $this->twitterUserArray($this->auth_user->getProfile(), true);
61
62         if ($this->format == 'xml') {
63             $this->initDocument('xml');
64             $this->showTwitterXmlUser($twitter_user, 'user', true);
65             $this->endDocument('xml');
66         } elseif ($this->format == 'json') {
67             $this->initDocument('json');
68             $this->showJsonObjects($twitter_user);
69             $this->endDocument('json');
70         }
71
72     }
73
74     /**
75      * Is this action read only?
76      *
77      * @param array $args other arguments
78      *
79      * @return boolean true
80      */
81     function isReadOnly($args)
82     {
83         return true;
84     }
85 }