actions/apigroupismember.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Check to see whether a user a member of a group
   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    Craig Andrews <candrews@integralblue.com>
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @author    Jeffery To <jeffery.to@gmail.com>
  27  * @author    Zach Copley <zach@status.net>
  28  * @copyright 2009 StatusNet, Inc.
  29  * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
  30  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  31  * @link      http://status.net/
  32  */
  33
  34 if (!defined('STATUSNET')) {
  35     exit(1);
  36 }
  37
  38 require_once INSTALLDIR . '/lib/apibareauth.php';
  39
  40 /**
  41  * Returns whether a user is a member of a specified group.
  42  *
  43  * @category API
  44  * @package  StatusNet
  45  * @author   Craig Andrews <candrews@integralblue.com>
  46  * @author   Evan Prodromou <evan@status.net>
  47  * @author   Jeffery To <jeffery.to@gmail.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 ApiGroupIsMemberAction extends ApiBareAuthAction
  53 {
  54     var $group   = null;
  55
  56     /**
  57      * Take arguments for running
  58      *
  59      * @param array $args $_REQUEST args
  60      *
  61      * @return boolean success flag
  62      */
  63
  64     function prepare($args)
  65     {
  66         parent::prepare($args);
  67
  68         $this->user   = $this->getTargetUser(null);
  69         $this->group  = $this->getTargetGroup(null);
  70
  71         return true;
  72     }
  73
  74     /**
  75      * Handle the request
  76      *
  77      * Save the new message
  78      *
  79      * @param array $args $_REQUEST data (unused)
  80      *
  81      * @return void
  82      */
  83     function handle($args)
  84     {
  85         parent::handle($args);
  86
  87         if (empty($this->user)) {
  88             // TRANS: Client error displayed when checking group membership for a non-existing user.
  89             $this->clientError(_('No such user.'), 404, $this->format);
  90             return;
  91         }
  92
  93         if (empty($this->group)) {
  94             // TRANS: Client error displayed when checking group membership for a non-existing group.
  95             $this->clientError(_('Group not found.'), 404, $this->format);
  96             return false;
  97         }
  98
  99         $is_member = $this->user->isMember($this->group);
 100
 101         switch($this->format) {
 102         case 'xml':
 103             $this->initDocument('xml');
 104             $this->element('is_member', null, $is_member);
 105             $this->endDocument('xml');
 106             break;
 107         case 'json':
 108             $this->initDocument('json');
 109             $this->showJsonObjects(array('is_member' => $is_member));
 110             $this->endDocument('json');
 111             break;
 112         default:
 113             $this->clientError(
 114                 // TRANS: Client error displayed trying to execute an unknown API method showing group membership.
 115                 _('API method not found.'),
 116                 400,
 117                 $this->format
 118             );
 119             break;
 120         }
 121     }
 122
 123     /**
 124      * Return true if read only.
 125      *
 126      * MAY override
 127      *
 128      * @param array $args other arguments
 129      *
 130      * @return boolean is read only action?
 131      */
 132     function isReadOnly($args)
 133     {
 134         return true;
 135     }
 136 }