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 /**
  39  * Removes the authenticated user from the group specified by ID
  40  *
  41  * @category API
  42  * @package  StatusNet
  43  * @author   Craig Andrews <candrews@integralblue.com>
  44  * @author   Evan Prodromou <evan@status.net>
  45  * @author   Jeffery To <jeffery.to@gmail.com>
  46  * @author   Zach Copley <zach@status.net>
  47  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  48  * @link     http://status.net/
  49  */
  50 class ApiGroupLeaveAction extends ApiAuthAction
  51 {
  52     var $group   = null;
  53
  54     /**
  55      * Take arguments for running
  56      *
  57      * @param array $args $_REQUEST args
  58      *
  59      * @return boolean success flag
  60      */
  61     function prepare($args)
  62     {
  63         parent::prepare($args);
  64
  65         $this->user  = $this->auth_user;
  66         $this->group = $this->getTargetGroup($this->arg('id'));
  67
  68         return true;
  69     }
  70
  71     /**
  72      * Handle the request
  73      *
  74      * Save the new message
  75      *
  76      * @param array $args $_REQUEST data (unused)
  77      *
  78      * @return void
  79      */
  80     function handle($args)
  81     {
  82         parent::handle($args);
  83
  84         if ($_SERVER['REQUEST_METHOD'] != 'POST') {
  85             $this->clientError(
  86                 // TRANS: Client error. POST is a HTTP command. It should not be translated.
  87                 _('This method requires a POST.'),
  88                 400,
  89                 $this->format
  90             );
  91             return;
  92         }
  93
  94         if (empty($this->user)) {
  95             // TRANS: Client error displayed when trying to have a non-existing user leave a group.
  96             $this->clientError(_('No such user.'), 404, $this->format);
  97             return;
  98         }
  99
 100         if (empty($this->group)) {
 101             // TRANS: Client error displayed when trying to leave a group that does not exist.
 102             $this->clientError(_('Group not found.'), 404, $this->format);
 103             return false;
 104         }
 105
 106         $member = new Group_member();
 107
 108         $member->group_id   = $this->group->id;
 109         $member->profile_id = $this->auth_user->id;
 110
 111         if (!$member->find(true)) {
 112             // TRANS: Server error displayed when trying to leave a group the user is not a member of.
 113             $this->serverError(_('You are not a member of this group.'));
 114             return;
 115         }
 116
 117         try {
 118             $this->user->leaveGroup($this->group);
 119         } catch (Exception $e) {
 120             // TRANS: Server error displayed when leaving a group failed in the database.
 121             // TRANS: %1$s is the leaving user's nickname, $2$s is the group nickname for which the leave failed.
 122             $this->serverError(sprintf(_('Could not remove user %1$s from group %2$s.'),
 123                                        $cur->nickname, $this->group->nickname));
 124             return;
 125         }
 126         switch($this->format) {
 127         case 'xml':
 128             $this->showSingleXmlGroup($this->group);
 129             break;
 130         case 'json':
 131             $this->showSingleJsonGroup($this->group);
 132             break;
 133         default:
 134             $this->clientError(
 135                 // TRANS: Client error displayed when coming across a non-supported API method.
 136                 _('API method not found.'),
 137                 404,
 138                 $this->format
 139             );
 140             break;
 141         }
 142     }
 143 }