]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/block.php
events for blocking a user
[quix0rs-gnu-social.git] / actions / block.php
1 <?php
2 /**
3  * Block a user action class.
4  *
5  * PHP version 5
6  *
7  * @category Action
8  * @package  StatusNet
9  * @author   Evan Prodromou <evan@status.net>
10  * @author   Robin Millette <millette@status.net>
11  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
12  * @link     http://status.net/
13  *
14  * StatusNet - the distributed open-source microblogging tool
15  * Copyright (C) 2008, 2009, StatusNet, Inc.
16  *
17  * This program is free software: you can redistribute it and/or modify
18  * it under the terms of the GNU Affero General Public License as published by
19  * the Free Software Foundation, either version 3 of the License, or
20  * (at your option) any later version.
21  *
22  * This program is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25  * GNU Affero General Public License for more details.
26  *
27  * You should have received a copy of the GNU Affero General Public License
28  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
29  */
30
31 if (!defined('STATUSNET') && !defined('LACONICA')) {
32     exit(1);
33 }
34
35 /**
36  * Block a user action class.
37  *
38  * @category Action
39  * @package  StatusNet
40  * @author   Evan Prodromou <evan@status.net>
41  * @author   Robin Millette <millette@status.net>
42  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
43  * @link     http://status.net/
44  */
45
46 class BlockAction extends ProfileFormAction
47 {
48     var $profile = null;
49
50     /**
51      * Take arguments for running
52      *
53      * @param array $args $_REQUEST args
54      *
55      * @return boolean success flag
56      */
57
58     function prepare($args)
59     {
60         if (!parent::prepare($args)) {
61             return false;
62         }
63
64         $cur = common_current_user();
65
66         assert(!empty($cur)); // checked by parent
67
68         if ($cur->hasBlocked($this->profile)) {
69             $this->clientError(_("You already blocked that user."));
70             return false;
71         }
72
73         return true;
74     }
75
76     /**
77      * Handle request
78      *
79      * Shows a page with list of favorite notices
80      *
81      * @param array $args $_REQUEST args; handled in prepare()
82      *
83      * @return void
84      */
85
86     function handle($args)
87     {
88         if ($_SERVER['REQUEST_METHOD'] == 'POST') {
89             if ($this->arg('no')) {
90                 $this->returnToArgs();
91             } elseif ($this->arg('yes')) {
92                 $this->handlePost();
93                 $this->returnToArgs();
94             } else {
95                 $this->showPage();
96             }
97         }
98     }
99
100     function showContent() {
101         $this->areYouSureForm();
102     }
103
104     function title() {
105         return _('Block user');
106     }
107
108     function showNoticeForm() {
109         // nop
110     }
111
112     /**
113      * Confirm with user.
114      *
115      * Shows a confirmation form.
116      *
117      * @return void
118      */
119     function areYouSureForm()
120     {
121         $id = $this->profile->id;
122         $this->elementStart('form', array('id' => 'block-' . $id,
123                                            'method' => 'post',
124                                            'class' => 'form_settings form_entity_block',
125                                            'action' => common_local_url('block')));
126         $this->elementStart('fieldset');
127         $this->hidden('token', common_session_token());
128         $this->element('legend', _('Block user'));
129         $this->element('p', null,
130                        _('Are you sure you want to block this user? '.
131                          'Afterwards, they will be unsubscribed from you, '.
132                          'unable to subscribe to you in the future, and '.
133                          'you will not be notified of any @-replies from them.'));
134         $this->element('input', array('id' => 'blockto-' . $id,
135                                       'name' => 'profileid',
136                                       'type' => 'hidden',
137                                       'value' => $id));
138         foreach ($this->args as $k => $v) {
139             if (substr($k, 0, 9) == 'returnto-') {
140                 $this->hidden($k, $v);
141             }
142         }
143         $this->submit('form_action-no', _('No'), 'submit form_action-primary', 'no', _("Do not block this user"));
144         $this->submit('form_action-yes', _('Yes'), 'submit form_action-secondary', 'yes', _('Block this user'));
145         $this->elementEnd('fieldset');
146         $this->elementEnd('form');
147     }
148
149     /**
150      * Actually block a user.
151      *
152      * @return void
153      */
154
155     function handlePost()
156     {
157         $cur = common_current_user();
158
159         if (Event::handle('StartBlockProfile', array($cur, $this->profile))) {
160             $result = $cur->block($this->profile);
161             if ($result) {
162                 Event::handle('EndBlockProfile', array($cur, $this->profile));
163             }
164         }
165
166         if (!$result) {
167             $this->serverError(_('Failed to save block information.'));
168             return;
169         }
170     }
171 }