]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/groupblock.php
Use array_merge instead of array_replace (same effect, and array_merge works with...
[quix0rs-gnu-social.git] / actions / groupblock.php
1 <?php
2 /**
3  * Block a user from a group action class.
4  *
5  * PHP version 5
6  *
7  * @category Action
8  * @package  StatusNet
9  * @author   Evan Prodromou <evan@status.net>
10  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
11  * @link     http://status.net/
12  *
13  * StatusNet - the distributed open-source microblogging tool
14  * Copyright (C) 2008, 2009, StatusNet, Inc.
15  *
16  * This program is free software: you can redistribute it and/or modify
17  * it under the terms of the GNU Affero General Public License as published by
18  * the Free Software Foundation, either version 3 of the License, or
19  * (at your option) any later version.
20  *
21  * This program is distributed in the hope that it will be useful,
22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
24  * GNU Affero General Public License for more details.
25  *
26  * You should have received a copy of the GNU Affero General Public License
27  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
28  */
29
30 if (!defined('STATUSNET') && !defined('LACONICA')) {
31     exit(1);
32 }
33
34 /**
35  * Block a user from a group
36  *
37  * @category Action
38  * @package  StatusNet
39  * @author   Evan Prodromou <evan@status.net>
40  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
41  * @link     http://status.net/
42  */
43 class GroupblockAction extends RedirectingAction
44 {
45     var $profile = null;
46     var $group = null;
47
48     /**
49      * Take arguments for running
50      *
51      * @param array $args $_REQUEST args
52      *
53      * @return boolean success flag
54      */
55     function prepare($args)
56     {
57         parent::prepare($args);
58         if (!common_logged_in()) {
59             // TRANS: Error message displayed when trying to perform an action that requires a logged in user.
60             $this->clientError(_('Not logged in.'));
61             return false;
62         }
63         $token = $this->trimmed('token');
64         if (empty($token) || $token != common_session_token()) {
65             // TRANS: Client error displayed when the session token does not match or is not given.
66             $this->clientError(_('There was a problem with your session token. Try again, please.'));
67             return;
68         }
69         $id = $this->trimmed('blockto');
70         if (empty($id)) {
71             // TRANS: Client error displayed trying to block a user from a group while not specifying a to be blocked user profile.
72             $this->clientError(_('No profile specified.'));
73             return false;
74         }
75         $this->profile = Profile::staticGet('id', $id);
76         if (empty($this->profile)) {
77             // TRANS: Client error displayed trying to block a user from a group while specifying a non-existing profile.
78             $this->clientError(_('No profile with that ID.'));
79             return false;
80         }
81         $group_id = $this->trimmed('blockgroup');
82         if (empty($group_id)) {
83             // TRANS: Client error displayed trying to block a user from a group while not specifying a group to block a profile from.
84             $this->clientError(_('No group specified.'));
85             return false;
86         }
87         $this->group = User_group::staticGet('id', $group_id);
88         if (empty($this->group)) {
89             // TRANS: Client error displayed trying to block a user from a group while specifying a non-existing group.
90             $this->clientError(_('No such group.'));
91             return false;
92         }
93         $user = common_current_user();
94         if (!$user->isAdmin($this->group)) {
95             // TRANS: Client error displayed trying to block a user from a group while not being an admin user.
96             $this->clientError(_('Only an admin can block group members.'), 401);
97             return false;
98         }
99         if (Group_block::isBlocked($this->group, $this->profile)) {
100             // TRANS: Client error displayed trying to block a user from a group while user is already blocked from the given group.
101             $this->clientError(_('User is already blocked from group.'));
102             return false;
103         }
104         // XXX: could have proactive blocks, but we don't have UI for it.
105         if (!$this->profile->isMember($this->group)) {
106             // TRANS: Client error displayed trying to block a user from a group while user is not a member of given group.
107             $this->clientError(_('User is not a member of group.'));
108             return false;
109         }
110         return true;
111     }
112
113     /**
114      * Handle request
115      *
116      * Shows a page with list of favorite notices
117      *
118      * @param array $args $_REQUEST args; handled in prepare()
119      *
120      * @return void
121      */
122     function handle($args)
123     {
124         parent::handle($args);
125         if ($_SERVER['REQUEST_METHOD'] == 'POST') {
126             if ($this->arg('no')) {
127                 $this->returnToPrevious();
128             } elseif ($this->arg('yes')) {
129                 $this->blockProfile();
130             } elseif ($this->arg('blockto')) {
131                 $this->showPage();
132             }
133         }
134     }
135
136     function showContent() {
137         $this->areYouSureForm();
138     }
139
140     function title() {
141         // TRANS: Title for block user from group page.
142         return _('Block user from group');
143     }
144
145     function showNoticeForm() {
146         // nop
147     }
148
149     /**
150      * Confirm with user.
151      *
152      * Shows a confirmation form.
153      *
154      * @return void
155      */
156     function areYouSureForm()
157     {
158         $id = $this->profile->id;
159         $this->elementStart('form', array('id' => 'block-' . $id,
160                                            'method' => 'post',
161                                            'class' => 'form_settings form_entity_block',
162                                            'action' => common_local_url('groupblock')));
163         $this->elementStart('fieldset');
164         $this->hidden('token', common_session_token());
165         // TRANS: Fieldset legend for block user from group form.
166         $this->element('legend', _('Block user'));
167         $this->element('p', null,
168                        // TRANS: Explanatory text for block user from group form before setting the block.
169                        // TRANS: %1$s is that to be blocked user, %2$s is the group the user will be blocked from.
170                        sprintf(_('Are you sure you want to block user "%1$s" from the group "%2$s"? '.
171                                  'They will be removed from the group, unable to post, and '.
172                                  'unable to subscribe to the group in the future.'),
173                                $this->profile->getBestName(),
174                                $this->group->getBestName()));
175         $this->hidden('blockto-' . $this->profile->id,
176                       $this->profile->id,
177                       'blockto');
178         $this->hidden('blockgroup-' . $this->group->id,
179                       $this->group->id,
180                       'blockgroup');
181         foreach ($this->args as $k => $v) {
182             if (substr($k, 0, 9) == 'returnto-') {
183                 $this->hidden($k, $v);
184             }
185         }
186         $this->submit('form_action-no',
187                       // TRANS: Button label on the form to block a user from a group.
188                       _m('BUTTON','No'),
189                       'submit form_action-primary',
190                       'no',
191                       // TRANS: Submit button title for 'No' when blocking a user from a group.
192                       _('Do not block this user from this group.'));
193         $this->submit('form_action-yes',
194                       // TRANS: Button label on the form to block a user from a group.
195                       _m('BUTTON','Yes'),
196                       'submit form_action-secondary',
197                       'yes',
198                       // TRANS: Submit button title for 'Yes' when blocking a user from a group.
199                       _('Block this user from this group.'));
200         $this->elementEnd('fieldset');
201         $this->elementEnd('form');
202     }
203
204     /**
205      * Actually block a user.
206      *
207      * @return void
208      */
209     function blockProfile()
210     {
211         $block = Group_block::blockProfile($this->group, $this->profile,
212                                            common_current_user());
213
214         if (empty($block)) {
215             // TRANS: Server error displayed when trying to block a user from a group fails because of an application error.
216             $this->serverError(_("Database error blocking user from group."));
217             return false;
218         }
219
220         $this->returnToPrevious();
221     }
222
223     /**
224      * If we reached this form without returnto arguments, default to
225      * the top of the group's member list.
226      *
227      * @return string URL
228      */
229     function defaultReturnTo()
230     {
231         return common_local_url('groupmembers',
232                                 array('nickname' => $this->group->nickname));
233     }
234
235     function showScripts()
236     {
237         parent::showScripts();
238         $this->autofocus('form_action-yes');
239     }
240 }