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    Zach Copley <zach@status.net>
  25  * @copyright 2009 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET')) {
  31     exit(1);
  32 }
  33
  34 require_once INSTALLDIR.'/lib/apiauth.php';
  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   Zach Copley <zach@status.net>
  44  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  45  * @link     http://status.net/
  46  */
  47
  48 class ApiAccountVerifyCredentialsAction extends ApiAuthAction
  49 {
  50     /**
  51      * Take arguments for running
  52      *
  53      * @param array $args $_REQUEST args
  54      *
  55      * @return boolean success flag
  56      *
  57      */
  58
  59     function prepare($args)
  60     {
  61         parent::prepare($args);
  62
  63         if ($this->requiresAuth()) {
  64             if ($this->checkBasicAuthUser() == false) {
  65                 return false;
  66             }
  67         }
  68
  69         return true;
  70     }
  71
  72     /**
  73      * Handle the request
  74      *
  75      * Check whether the credentials are valid and output the result
  76      *
  77      * @param array $args $_REQUEST data (unused)
  78      *
  79      * @return void
  80      */
  81
  82     function handle($args)
  83     {
  84         parent::handle($args);
  85
  86         switch ($this->format) {
  87         case 'xml':
  88         case 'json':
  89             $args['id'] = $this->auth_user->id;
  90             $action_obj = new ApiUserShowAction();
  91             $action_obj->prepare($args);
  92             $action_obj->handle($args);
  93             break;
  94         default:
  95             header('Content-Type: text/html; charset=utf-8');
  96             print 'Authorized';
  97         }
  98
  99     }
 100
 101 }