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