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  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  30  * @link      http://status.net/
  31  */
  32
  33 if (!defined('STATUSNET')) {
  34     exit(1);
  35 }
  36
  37 require_once INSTALLDIR . '/lib/apiauth.php';
  38
  39 /**
  40  * Joins the authenticated user to the group speicified by ID
  41  *
  42  * @category API
  43  * @package  StatusNet
  44  * @author   Craig Andrews <candrews@integralblue.com>
  45  * @author   Evan Prodromou <evan@status.net>
  46  * @author   Jeffery To <jeffery.to@gmail.com>
  47  * @author   Zach Copley <zach@status.net>
  48  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  49  * @link     http://status.net/
  50  */
  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      */
  64
  65     function prepare($args)
  66     {
  67         parent::prepare($args);
  68
  69         $this->user  = $this->auth_user;
  70         $this->group = $this->getTargetGroup($this->arg('id'));
  71
  72         return true;
  73     }
  74
  75     /**
  76      * Handle the request
  77      *
  78      * Save the new message
  79      *
  80      * @param array $args $_REQUEST data (unused)
  81      *
  82      * @return void
  83      */
  84
  85     function handle($args)
  86     {
  87         parent::handle($args);
  88
  89         if ($_SERVER['REQUEST_METHOD'] != 'POST') {
  90             $this->clientError(
  91                 _('This method requires a POST.'),
  92                 400,
  93                 $this->format
  94             );
  95             return;
  96         }
  97
  98         if (empty($this->user)) {
  99             $this->clientError(_('No such user.'), 404, $this->format);
 100             return;
 101         }
 102
 103         if (empty($this->group)) {
 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                 _('You are already a member of that group.'),
 111                 403,
 112                 $this->format
 113             );
 114             return;
 115         }
 116
 117         if (Group_block::isBlocked($this->group, $this->user->getProfile())) {
 118             $this->clientError(
 119                 _('You have been blocked from that group by the admin.'),
 120                 403,
 121                 $this->format
 122             );
 123             return;
 124         }
 125
 126         $member = new Group_member();
 127
 128         $member->group_id   = $this->group->id;
 129         $member->profile_id = $this->user->id;
 130         $member->created    = common_sql_now();
 131
 132         $result = $member->insert();
 133
 134         if (!$result) {
 135             common_log_db_error($member, 'INSERT', __FILE__);
 136             $this->serverError(
 137                 sprintf(
 138                     _('Could not join user %s to group %s.'),
 139                     $this->user->nickname,
 140                     $this->group->nickname
 141                 )
 142             );
 143             return;
 144         }
 145
 146         switch($this->format) {
 147         case 'xml':
 148             $this->show_single_xml_group($this->group);
 149             break;
 150         case 'json':
 151             $this->showSingleJsonGroup($this->group);
 152             break;
 153         default:
 154             $this->clientError(
 155                 _('API method not found!'),
 156                 404,
 157                 $this->format
 158             );
 159             break;
 160         }
 161     }
 162
 163 }