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 require_once INSTALLDIR . '/lib/apiauth.php';
  37
  38 /**
  39  * Check a user's credentials. Returns an HTTP 200 OK response code and a
  40  * representation of the requesting user if authentication was successful;
  41  * returns a 401 status code and an error message if not.
  42  *
  43  * @category API
  44  * @package  StatusNet
  45  * @author   Evan Prodromou <evan@status.net>
  46  * @author   Robin Millette <robin@millette.info>
  47  * @author   Zach Copley <zach@status.net>
  48  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  49  * @link     http://status.net/
  50  */
  51 class ApiAccountVerifyCredentialsAction extends ApiAuthAction
  52 {
  53     /**
  54      * Handle the request
  55      *
  56      * Check whether the credentials are valid and output the result
  57      *
  58      * @param array $args $_REQUEST data (unused)
  59      *
  60      * @return void
  61      */
  62     function handle($args)
  63     {
  64         parent::handle($args);
  65
  66         if (!in_array($this->format, array('xml', 'json'))) {
  67             // TRANS: Client error displayed trying to execute an unknown API method verifying user credentials.
  68             $this->clientError(_('API method not found.'), $code = 404);
  69             return;
  70         }
  71
  72         $twitter_user = $this->twitterUserArray($this->auth_user->getProfile(), true);
  73
  74         if ($this->format == 'xml') {
  75             $this->initDocument('xml');
  76             $this->showTwitterXmlUser($twitter_user, 'user', true);
  77             $this->endDocument('xml');
  78         } elseif ($this->format == 'json') {
  79             $this->initDocument('json');
  80             $this->showJsonObjects($twitter_user);
  81             $this->endDocument('json');
  82         }
  83
  84     }
  85
  86     /**
  87      * Is this action read only?
  88      *
  89      * @param array $args other arguments
  90      *
  91      * @return boolean true
  92      */
  93     function isReadOnly($args)
  94     {
  95         return true;
  96     }
  97 }