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