]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/apiblockcreate.php
jQuery cookie plugin updated
[quix0rs-gnu-social.git] / actions / apiblockcreate.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * Block a user 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    Evan Prodromou <evan@status.net>
25  * @author    Zach Copley <zach@status.net>
26  * @copyright 2009-2010 StatusNet, Inc.
27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
28  * @link      http://status.net/
29  */
30
31 if (!defined('STATUSNET')) {
32     exit(1);
33 }
34
35 /**
36  * Blocks the user specified in the ID parameter as the authenticating user.
37  * Destroys a friendship to the blocked user if it exists. Returns the
38  * blocked user in the requested format when successful.
39  *
40  * @category API
41  * @package  StatusNet
42  * @author   Evan Prodromou <evan@status.net>
43  * @author   Zach Copley <zach@status.net>
44  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
45  * @link     http://status.net/
46  */
47 class ApiBlockCreateAction extends ApiAuthAction
48 {
49     protected $needPost = true;
50
51     var $other   = null;
52
53     /**
54      * Take arguments for running
55      *
56      * @param array $args $_REQUEST args
57      *
58      * @return boolean success flag
59      *
60      */
61     protected function prepare(array $args=array())
62     {
63         parent::prepare($args);
64
65         $this->other  = $this->getTargetProfile($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     protected function handle()
80     {
81         parent::handle();
82
83         if (empty($this->user) || empty($this->other)) {
84             // TRANS: Client error displayed when trying to block a non-existing user or a user from another site.
85             $this->clientError(_('No such user.'), 404);
86         }
87
88         // Don't allow blocking yourself!
89
90         if ($this->user->id == $this->other->id) {
91             // TRANS: Client error displayed when users try to block themselves.
92             $this->clientError(_("You cannot block yourself!"), 403);
93         }
94
95         if (!$this->user->hasBlocked($this->other)) {
96             if (Event::handle('StartBlockProfile', array($this->user, $this->other))) {
97                 $result = $this->user->block($this->other);
98                 if ($result) {
99                     Event::handle('EndBlockProfile', array($this->user, $this->other));
100                 }
101             }
102         }
103
104         if ($this->user->hasBlocked($this->other)) {
105             $this->initDocument($this->format);
106             $this->showProfile($this->other, $this->format);
107             $this->endDocument($this->format);
108         } else {
109             // TRANS: Server error displayed when blocking a user has failed.
110             $this->serverError(_('Block user failed.'), 500);
111         }
112     }
113 }