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 $user    = null;
  49     var $group   = null;
  50
  51     /**
  52      * Take arguments for running
  53      *
  54      * @param array $args $_REQUEST args
  55      *
  56      * @return boolean success flag
  57      *
  58      */
  59
  60     function prepare($args)
  61     {
  62         parent::prepare($args);
  63
  64         $this->user  = $this->auth_user;
  65         $this->group = $this->getTargetGroup($this->arg('id'));
  66
  67         return true;
  68     }
  69
  70     /**
  71      * Handle the request
  72      *
  73      * Save the new message
  74      *
  75      * @param array $args $_REQUEST data (unused)
  76      *
  77      * @return void
  78      */
  79
  80     function handle($args)
  81     {
  82         parent::handle($args);
  83
  84         if ($_SERVER['REQUEST_METHOD'] != 'POST') {
  85             $this->clientError(
  86                 _('This method requires a POST.'),
  87                 400,
  88                 $this->format
  89             );
  90             return;
  91         }
  92
  93         if (empty($this->user)) {
  94             $this->clientError(_('No such user!'), 404, $this->format);
  95             return;
  96         }
  97
  98         if (empty($this->group)) {
  99             $this->clientError('Group not found!', 404, $this->format);
 100             return false;
 101         }
 102
 103         if ($this->user->isMember($this->group)) {
 104             $this->clientError(
 105                 _('You are already a member of that group.'),
 106                 403,
 107                 $this->format
 108             );
 109             return;
 110         }
 111
 112         if (Group_block::isBlocked($this->group, $this->user->getProfile())) {
 113             $this->clientError(
 114                 _('You have been blocked from that group by the admin.'),
 115                 403,
 116                 $this->format
 117             );
 118             return;
 119         }
 120
 121         $member = new Group_member();
 122
 123         $member->group_id   = $this->group->id;
 124         $member->profile_id = $this->user->id;
 125         $member->created    = common_sql_now();
 126
 127         $result = $member->insert();
 128
 129         if (!$result) {
 130             common_log_db_error($member, 'INSERT', __FILE__);
 131             $this->serverError(
 132                 sprintf(
 133                     _('Could not join user %s to group %s.'),
 134                     $this->user->nickname,
 135                     $this->group->nickname
 136                 )
 137             );
 138             return;
 139         }
 140
 141         switch($this->format) {
 142         case 'xml':
 143             $this->show_single_xml_group($this->group);
 144             break;
 145         case 'json':
 146             $this->showSingleJsonGroup($this->group);
 147             break;
 148         default:
 149             $this->clientError(
 150                 _('API method not found!'),
 151                 404,
 152                 $this->format
 153             );
 154             break;
 155         }
 156     }
 157
 158 }