actions/apigroupleave.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Leave a group via the API
   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/apiauth.php';
  39
  40 /**
  41  * Removes the authenticated user from the group specified by ID
  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
  53 class ApiGroupLeaveAction extends ApiAuthAction
  54 {
  55     var $group   = null;
  56
  57     /**
  58      * Take arguments for running
  59      *
  60      * @param array $args $_REQUEST args
  61      *
  62      * @return boolean success flag
  63      *
  64      */
  65
  66     function prepare($args)
  67     {
  68         parent::prepare($args);
  69
  70         $this->user  = $this->auth_user;
  71         $this->group = $this->getTargetGroup($this->arg('id'));
  72
  73         return true;
  74     }
  75
  76     /**
  77      * Handle the request
  78      *
  79      * Save the new message
  80      *
  81      * @param array $args $_REQUEST data (unused)
  82      *
  83      * @return void
  84      */
  85
  86     function handle($args)
  87     {
  88         parent::handle($args);
  89
  90         if ($_SERVER['REQUEST_METHOD'] != 'POST') {
  91             $this->clientError(
  92                 // TRANS: Client error. POST is a HTTP command. It should not be translated.
  93                 _('This method requires a POST.'),
  94                 400,
  95                 $this->format
  96             );
  97             return;
  98         }
  99
 100         if (empty($this->user)) {
 101             $this->clientError(_('No such user.'), 404, $this->format);
 102             return;
 103         }
 104
 105         if (empty($this->group)) {
 106             $this->clientError(_('Group not found.'), 404, $this->format);
 107             return false;
 108         }
 109
 110         $member = new Group_member();
 111
 112         $member->group_id   = $this->group->id;
 113         $member->profile_id = $this->auth_user->id;
 114
 115         if (!$member->find(true)) {
 116             $this->serverError(_('You are not a member of this group.'));
 117             return;
 118         }
 119
 120         $result = $member->delete();
 121
 122         if (!$result) {
 123             common_log_db_error($member, 'DELETE', __FILE__);
 124             $this->serverError(
 125                 sprintf(
 126                     _('Could not remove user %1$s from group %2$s.'),
 127                     $this->user->nickname,
 128                     $this->group->nickname
 129                 )
 130             );
 131             return;
 132         }
 133
 134         switch($this->format) {
 135         case 'xml':
 136             $this->showSingleXmlGroup($this->group);
 137             break;
 138         case 'json':
 139             $this->showSingleJsonGroup($this->group);
 140             break;
 141         default:
 142             $this->clientError(
 143                 _('API method not found.'),
 144                 404,
 145                 $this->format
 146             );
 147             break;
 148         }
 149     }
 150
 151 }