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 require_once INSTALLDIR . '/lib/apiauth.php';
  39
  40 /**
  41  * Joins the authenticated user to the group speicified 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 class ApiGroupJoinAction extends ApiAuthAction
  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     function prepare($args)
  64     {
  65         parent::prepare($args);
  66
  67         $this->user  = $this->auth_user;
  68         $this->group = $this->getTargetGroup($this->arg('id'));
  69
  70         return true;
  71     }
  72
  73     /**
  74      * Handle the request
  75      *
  76      * Save the new message
  77      *
  78      * @param array $args $_REQUEST data (unused)
  79      *
  80      * @return void
  81      */
  82     function handle($args)
  83     {
  84         parent::handle($args);
  85
  86         if ($_SERVER['REQUEST_METHOD'] != 'POST') {
  87             $this->clientError(
  88                 // TRANS: Client error. POST is a HTTP command. It should not be translated.
  89                 _('This method requires a POST.'),
  90                 400,
  91                 $this->format
  92             );
  93             return;
  94         }
  95
  96         if (empty($this->user)) {
  97             // TRANS: Client error displayed when trying to have a non-existing user join a group.
  98             $this->clientError(_('No such user.'), 404, $this->format);
  99             return;
 100         }
 101
 102         if (empty($this->group)) {
 103             // TRANS: Client error displayed when trying to join a group that does not exist.
 104             $this->clientError(_('Group not found.'), 404, $this->format);
 105             return false;
 106         }
 107
 108         if ($this->user->isMember($this->group)) {
 109             $this->clientError(
 110                 // TRANS: Server error displayed when trying to join a group the user is already a member of.
 111                 _('You are already a member of that group.'),
 112                 403,
 113                 $this->format
 114             );
 115             return;
 116         }
 117
 118         if (Group_block::isBlocked($this->group, $this->user->getProfile())) {
 119             $this->clientError(
 120                 // TRANS: Server error displayed when trying to join a group the user is blocked from joining.
 121                 _('You have been blocked from that group by the admin.'),
 122                 403,
 123                 $this->format
 124             );
 125             return;
 126         }
 127
 128         $member = new Group_member();
 129
 130         $member->group_id   = $this->group->id;
 131         $member->profile_id = $this->user->id;
 132         $member->created    = common_sql_now();
 133
 134         $result = $member->insert();
 135
 136         if (!$result) {
 137             common_log_db_error($member, 'INSERT', __FILE__);
 138             $this->serverError(
 139                 sprintf(
 140                     // TRANS: Server error displayed when joining a group fails.
 141                     // TRANS: %1$s is a user nickname, $2$s is a group nickname.
 142                     _('Could not join user %1$s to group %2$s.'),
 143                     $this->user->nickname,
 144                     $this->group->nickname
 145                 )
 146             );
 147             return;
 148         }
 149
 150         switch($this->format) {
 151         case 'xml':
 152             $this->showSingleXmlGroup($this->group);
 153             break;
 154         case 'json':
 155             $this->showSingleJsonGroup($this->group);
 156             break;
 157         default:
 158             $this->clientError(
 159                 // TRANS: Client error displayed trying to execute an unknown API method joining a group.
 160                 _('API method not found.'),
 161                 404,
 162                 $this->format
 163             );
 164             break;
 165         }
 166     }
 167 }