actions/apiusershow.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Show a user's profile information
   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    Dan Moore <dan@moore.cx>
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @author    mac65 <mac65@mac65.com>
  27  * @author    Zach Copley <zach@status.net>
  28  * @copyright 2009 StatusNet, Inc.
  29  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  30  * @link      http://status.net/
  31  */
  32
  33 if (!defined('STATUSNET')) {
  34     exit(1);
  35 }
  36
  37 /**
  38  * Ouputs information for a user, specified by ID or screen name.
  39  * The user's most recent status will be returned inline.
  40  *
  41  * @category API
  42  * @package  StatusNet
  43  * @author   Dan Moore <dan@moore.cx>
  44  * @author   Evan Prodromou <evan@status.net>
  45  * @author   mac65 <mac65@mac65.com>
  46  * @author   Zach Copley <zach@status.net>
  47  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  48  * @link     http://status.net/
  49  */
  50 class ApiUserShowAction extends ApiPrivateAuthAction
  51 {
  52     /**
  53      * Take arguments for running
  54      *
  55      * @param array $args $_REQUEST args
  56      *
  57      * @return boolean success flag
  58      *
  59      */
  60     protected function prepare(array $args=array())
  61     {
  62         parent::prepare($args);
  63
  64         $email = $this->arg('email');
  65
  66         // XXX: email field deprecated in Twitter's API
  67
  68         if (!empty($email)) {
  69             $user = User::getKV('email', $email);
  70         } else {
  71             $user = $this->getTargetUser($this->arg('id'));
  72         }
  73
  74         if (!($user instanceof User)) {
  75             // TRANS: Client error displayed when requesting user information for a non-existing user.
  76             $this->clientError(_('User not found.'), 404);
  77         }
  78         $this->target = $user->getProfile();
  79
  80         return true;
  81     }
  82
  83     /**
  84      * Handle the request
  85      *
  86      * Check the format and show the user info
  87      *
  88      * @return void
  89      */
  90     protected function handle()
  91     {
  92         parent::handle();
  93
  94         if (!in_array($this->format, array('xml', 'json'))) {
  95             // TRANS: Client error displayed when coming across a non-supported API method.
  96             $this->clientError(_('API method not found.'), 404);
  97         }
  98
  99         $twitter_user = $this->twitterUserArray($this->target, true);
 100
 101         if ($this->format == 'xml') {
 102             $this->initDocument('xml');
 103             $this->showTwitterXmlUser($twitter_user, 'user', true);
 104             $this->endDocument('xml');
 105         } elseif ($this->format == 'json') {
 106             $this->initDocument('json');
 107             $this->showJsonObjects($twitter_user);
 108             $this->endDocument('json');
 109         }
 110     }
 111
 112     /**
 113      * Return true if read only.
 114      *
 115      * MAY override
 116      *
 117      * @param array $args other arguments
 118      *
 119      * @return boolean is read only action?
 120      */
 121     function isReadOnly($args)
 122     {
 123         return true;
 124     }
 125 }