actions/apiexternalprofileshow.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Show an external 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   GNUsocial
  24  * @author    Hannes Mannerheim <h@nnesmannerhe.im>
  25  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  26  * @link      http://www.gnu.org/software/social/
  27  */
  28
  29 if (!defined('GNUSOCIAL')) { exit(1); }
  30
  31 /**
  32  * Ouputs information for a user, specified by ID or screen name.
  33  * The user's most recent status will be returned inline.
  34  */
  35 class ApiExternalProfileShowAction extends ApiPrivateAuthAction
  36 {
  37     /**
  38      * Take arguments for running
  39      *
  40      * @param array $args $_REQUEST args
  41      *
  42      * @return boolean success flag
  43      *
  44      */
  45     protected function prepare(array $args=array())
  46     {
  47         parent::prepare($args);
  48
  49         if ($this->format !== 'json') {
  50             $this->clientError('This method currently only serves JSON.', 415);
  51         }
  52
  53         $profileurl = urldecode($this->arg('profileurl'));
  54
  55         // TODO: Make this more ... unique!
  56         $this->profile = Profile::getKV('profileurl', $profileurl);
  57
  58         if (!($this->profile instanceof Profile)) {
  59             // TRANS: Client error displayed when requesting profile information for a non-existing profile.
  60             $this->clientError(_('Profile not found.'), 404);
  61         }
  62
  63         return true;
  64     }
  65
  66     /**
  67      * Handle the request
  68      *
  69      * Check the format and show the user info
  70      *
  71      * @param array $args $_REQUEST data (unused)
  72      *
  73      * @return void
  74      */
  75     protected function handle()
  76     {
  77         parent::handle();
  78
  79         $twitter_user = $this->twitterUserArray($this->profile, true);
  80
  81         $this->initDocument('json');
  82         $this->showJsonObjects($twitter_user);
  83         $this->endDocument('json');
  84     }
  85
  86     /**
  87      * Return true if read only.
  88      *
  89      * MAY override
  90      *
  91      * @param array $args other arguments
  92      *
  93      * @return boolean is read only action?
  94      */
  95     function isReadOnly($args)
  96     {
  97         return true;
  98     }
  99 }