actions/apilistsubscriber.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Check if a user is subscribed to a list
   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  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  25  * @link      http://status.net/
  26  */
  27
  28 if (!defined('STATUSNET')) {
  29     exit(1);
  30 }
  31
  32 require_once INSTALLDIR . '/lib/apiauth.php';
  33
  34 class ApiListSubscriberAction extends ApiBareAuthAction
  35 {
  36     var $list   = null;
  37
  38     function prepare($args)
  39     {
  40         parent::prepare($args);
  41
  42         $this->user = $this->getTargetUser($this->arg('id'));
  43         $this->list = $this->getTargetList($this->arg('user'), $this->arg('list_id'));
  44
  45         if (empty($this->list)) {
  46             // TRANS: Client error displayed trying to perform an action related to a non-existing list.
  47             $this->clientError(_('List not found.'), 404, $this->format);
  48             return false;
  49         }
  50
  51         if (empty($this->user)) {
  52             // TRANS: Client error displayed trying to perform an action related to a non-existing user.
  53             $this->clientError(_('No such user.'), 404, $this->format);
  54             return false;
  55         }
  56         return true;
  57     }
  58
  59     function handle($args)
  60     {
  61         parent::handle($args);
  62
  63         $arr = array('profile_tag_id' => $this->list->id,
  64                       'profile_id' => $this->user->id);
  65         $sub = Profile_tag_subscription::pkeyGet($arr);
  66
  67         if(empty($sub)) {
  68             $this->clientError(
  69                 // TRANS: Client error displayed when a membership check for a user is nagative.
  70                 _('The specified user is not a subscriber of this list.'),
  71                 400,
  72                 $this->format
  73             );
  74         }
  75
  76         $user = $this->twitterUserArray($this->user->getProfile(), true);
  77
  78         switch($this->format) {
  79         case 'xml':
  80             $this->showTwitterXmlUser($user, 'user', true);
  81             break;
  82         case 'json':
  83             $this->showSingleJsonUser($user);
  84             break;
  85         default:
  86             $this->clientError(
  87                 // TRANS: Client error displayed when coming across a non-supported API method.
  88                 _('API method not found.'),
  89                 404,
  90                 $this->format
  91             );
  92             break;
  93         }
  94     }
  95 }