actions/apigroupjoin.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Join 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  * Joins the authenticated user to the group speicified 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 ApiGroupJoinAction extends ApiAuthAction
  51 {
  52     protected $needPost = true;
  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     protected function prepare(array $args=array())
  64     {
  65         parent::prepare($args);
  66
  67         $this->group = $this->getTargetGroup($this->arg('id'));
  68
  69         return true;
  70     }
  71
  72     /**
  73      * Handle the request
  74      *
  75      * Join the authenticated user to the group
  76      *
  77      * @return void
  78      */
  79     protected function handle()
  80     {
  81         parent::handle();
  82
  83         if (empty($this->scoped)) {
  84             // TRANS: Client error displayed when trying to have a non-existing user join a group.
  85             $this->clientError(_('No such user.'), 404);
  86         }
  87
  88         if (empty($this->group)) {
  89             // TRANS: Client error displayed when trying to join a group that does not exist.
  90             $this->clientError(_('Group not found.'), 404);
  91         }
  92
  93         if ($this->scoped->isMember($this->group)) {
  94             // TRANS: Server error displayed when trying to join a group the user is already a member of.
  95             $this->clientError(_('You are already a member of that group.'), 403);
  96         }
  97
  98         if (Group_block::isBlocked($this->group, $this->scoped)) {
  99             // TRANS: Server error displayed when trying to join a group the user is blocked from joining.
 100             $this->clientError(_('You have been blocked from that group by the admin.'), 403);
 101         }
 102
 103         try {
 104             $this->scoped->joinGroup($this->group);
 105         } catch (Exception $e) {
 106             // TRANS: Server error displayed when joining a group failed in the database.
 107             // TRANS: %1$s is the joining user's nickname, $2$s is the group nickname for which the join failed.
 108             $this->serverError(sprintf(_('Could not join user %1$s to group %2$s.'),
 109                                        $this->scoped->nickname, $this->group->nickname));
 110         }
 111
 112         switch($this->format) {
 113         case 'xml':
 114             $this->showSingleXmlGroup($this->group);
 115             break;
 116         case 'json':
 117             $this->showSingleJsonGroup($this->group);
 118             break;
 119         default:
 120             // TRANS: Client error displayed when coming across a non-supported API method.
 121             $this->clientError(_('API method not found.'), 404);
 122         }
 123     }
 124 }