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 class ApiListSubscriberAction extends ApiBareAuthAction
  33 {
  34     var $list   = null;
  35
  36     function prepare($args)
  37     {
  38         parent::prepare($args);
  39
  40         $this->target = $this->getTargetProfile($this->arg('id'));
  41         $this->list = $this->getTargetList($this->arg('user'), $this->arg('list_id'));
  42
  43         if (empty($this->list)) {
  44             // TRANS: Client error displayed trying to perform an action related to a non-existing list.
  45             $this->clientError(_('List not found.'), 404);
  46         }
  47
  48         if (!($this->target instanceof Profile)) {
  49             // TRANS: Client error displayed trying to perform an action related to a non-existing user.
  50             $this->clientError(_('No such user.'), 404);
  51         }
  52         return true;
  53     }
  54
  55     function handle($args)
  56     {
  57         parent::handle($args);
  58
  59         $arr = array('profile_tag_id' => $this->list->id,
  60                       'profile_id' => $this->target->id);
  61         $sub = Profile_tag_subscription::pkeyGet($arr);
  62
  63         if(empty($sub)) {
  64             // TRANS: Client error displayed when a membership check for a user is nagative.
  65             $this->clientError(_('The specified user is not a subscriber of this list.'));
  66         }
  67
  68         $user = $this->twitterUserArray($this->target, true);
  69
  70         switch($this->format) {
  71         case 'xml':
  72             $this->showTwitterXmlUser($user, 'user', true);
  73             break;
  74         case 'json':
  75             $this->showSingleJsonUser($user);
  76             break;
  77         default:
  78             $this->clientError(
  79                 // TRANS: Client error displayed when coming across a non-supported API method.
  80                 _('API method not found.'),
  81                 404,
  82                 $this->format
  83             );
  84             break;
  85         }
  86     }
  87 }