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    Zach Copley <zach@status.net>
  25  * @copyright 2009 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET')) {
  31     exit(1);
  32 }
  33
  34 require_once INSTALLDIR . '/lib/apibareauth.php';
  35
  36 /**
  37  * Returns whether a user is a member of a specified group.
  38  *
  39  * @category API
  40  * @package  StatusNet
  41  * @author   Zach Copley <zach@status.net>
  42  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  43  * @link     http://status.net/
  44  */
  45
  46 class ApiGroupIsMemberAction extends ApiBareAuthAction
  47 {
  48     var $format  = null;
  49     var $user    = null;
  50     var $group   = null;
  51
  52     /**
  53      * Take arguments for running
  54      *
  55      * @param array $args $_REQUEST args
  56      *
  57      * @return boolean success flag
  58      *
  59      */
  60
  61     function prepare($args)
  62     {
  63         parent::prepare($args);
  64
  65         if ($this->requiresAuth()) {
  66             if ($this->checkBasicAuthUser() == false) {
  67                 return;
  68             }
  69         }
  70
  71         $this->user   = $this->getTargetUser(null);
  72         $this->group  = $this->getTargetGroup(null);
  73         $this->format = $this->arg('format');
  74
  75         return true;
  76     }
  77
  78     /**
  79      * Handle the request
  80      *
  81      * Save the new message
  82      *
  83      * @param array $args $_REQUEST data (unused)
  84      *
  85      * @return void
  86      */
  87
  88     function handle($args)
  89     {
  90         parent::handle($args);
  91
  92         if (empty($this->user)) {
  93             $this->clientError(_('No such user!'), 404, $this->format);
  94             return;
  95         }
  96
  97         if (empty($this->group)) {
  98             $this->clientError('Group not found!', 404, $this->format);
  99             return false;
 100         }
 101
 102         $is_member = $this->user->isMember($this->group);
 103
 104         switch($this->format) {
 105         case 'xml':
 106             $this->init_document('xml');
 107             $this->element('is_member', null, $is_member);
 108             $this->end_document('xml');
 109             break;
 110         case 'json':
 111             $this->init_document('json');
 112             $this->show_json_objects(array('is_member' => $is_member));
 113             $this->end_document('json');
 114             break;
 115         default:
 116             $this->clientError(
 117                 _('API method not found!'),
 118                 400,
 119                 $this->format
 120             );
 121             break;
 122         }
 123     }
 124
 125 }