]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/apifriendshipscreate.php
fix notices in dumpschema
[quix0rs-gnu-social.git] / actions / apifriendshipscreate.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * Subscribe to 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    Dan Moore <dan@moore.cx>
25  * @author    Evan Prodromou <evan@status.net>
26  * @author    Zach Copley <zach@status.net>
27  * @copyright 2009-2010 StatusNet, Inc.
28  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
29  * @link      http://status.net/
30  */
31
32 if (!defined('STATUSNET')) {
33     exit(1);
34 }
35
36 require_once INSTALLDIR . '/lib/apiauth.php';
37
38 /**
39  * Allows the authenticating users to follow (subscribe) the user specified in
40  * the ID parameter.  Returns the befriended user in the requested format when
41  * successful.  Returns a string describing the failure condition when unsuccessful.
42  *
43  * @category API
44  * @package  StatusNet
45  * @author   Dan Moore <dan@moore.cx>
46  * @author   Evan Prodromou <evan@status.net>
47  * @author   Zach Copley <zach@status.net>
48  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
49  * @link     http://status.net/
50  */
51 class ApiFriendshipsCreateAction extends ApiAuthAction
52 {
53     var $other  = null;
54
55     /**
56      * Take arguments for running
57      *
58      * @param array $args $_REQUEST args
59      *
60      * @return boolean success flag
61      *
62      */
63     function prepare($args)
64     {
65         parent::prepare($args);
66
67         $this->user   = $this->auth_user;
68         $this->other  = $this->getTargetProfile($this->arg('id'));
69
70         return true;
71     }
72
73     /**
74      * Handle the request
75      *
76      * Check the format and show the user info
77      *
78      * @param array $args $_REQUEST data (unused)
79      *
80      * @return void
81      */
82     function handle($args)
83     {
84         parent::handle($args);
85
86         if ($_SERVER['REQUEST_METHOD'] != 'POST') {
87             $this->clientError(
88                 // TRANS: Client error. POST is a HTTP command. It should not be translated.
89                 _('This method requires a POST.'),
90                 400,
91                 $this->format
92             );
93             return;
94         }
95
96         if (!in_array($this->format, array('xml', 'json'))) {
97             $this->clientError(
98                 // TRANS: Client error displayed when trying to handle an unknown API method.
99                 _('API method not found.'),
100                 404,
101                 $this->format
102             );
103             return;
104         }
105
106         if (empty($this->other)) {
107             $this->clientError(
108                 // TRANS: Client error displayed when trying follow who's profile could not be found.
109                 _('Could not follow user: profile not found.'),
110                 403,
111                 $this->format
112             );
113             return;
114         }
115
116         if ($this->user->isSubscribed($this->other)) {
117             $errmsg = sprintf(
118                 // TRANS: Client error displayed when trying to follow a user that's already being followed.
119                 // TRANS: %s is the nickname of the user that is already being followed.
120                 _('Could not follow user: %s is already on your list.'),
121                 $this->other->nickname
122             );
123             $this->clientError($errmsg, 403, $this->format);
124             return;
125         }
126
127         $result = subs_subscribe_to($this->user, $this->other);
128
129         if (is_string($result)) {
130             $this->clientError($result, 403, $this->format);
131             return;
132         }
133
134         $this->initDocument($this->format);
135         $this->showProfile($this->other, $this->format);
136         $this->endDocument($this->format);
137     }
138 }