3 * @copyright Copyright (C) 2010-2021, the Friendica project
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Module;
24 use Friendica\BaseModule;
25 use Friendica\Core\Logger;
26 use Friendica\Core\System;
28 use Friendica\Model\Post;
29 use Friendica\Network\HTTPException;
30 use Friendica\Security\BasicAuth;
31 use Friendica\Security\OAuth;
32 use Friendica\Util\DateTimeFormat;
33 use Friendica\Util\HTTPInputData;
35 class BaseApi extends BaseModule
37 const SCOPE_READ = 'read';
38 const SCOPE_WRITE = 'write';
39 const SCOPE_FOLLOW = 'follow';
40 const SCOPE_PUSH = 'push';
45 protected static $boundaries = [];
50 protected static $request = [];
52 public static function delete(array $parameters = [])
54 self::checkAllowedScope(self::SCOPE_WRITE);
56 if (!DI::app()->isLoggedIn()) {
57 throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
61 public static function patch(array $parameters = [])
63 self::checkAllowedScope(self::SCOPE_WRITE);
65 if (!DI::app()->isLoggedIn()) {
66 throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
70 public static function post(array $parameters = [])
72 self::checkAllowedScope(self::SCOPE_WRITE);
74 if (!DI::app()->isLoggedIn()) {
75 throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
79 public static function put(array $parameters = [])
81 self::checkAllowedScope(self::SCOPE_WRITE);
83 if (!DI::app()->isLoggedIn()) {
84 throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
89 * Processes data from GET requests and sets defaults
91 * @return array request data
93 public static function getRequest(array $defaults)
95 $httpinput = HTTPInputData::process();
96 $input = array_merge($httpinput['variables'], $httpinput['files'], $_REQUEST);
98 self::$request = $input;
99 self::$boundaries = [];
101 unset(self::$request['pagename']);
105 foreach ($defaults as $parameter => $defaultvalue) {
106 if (is_string($defaultvalue)) {
107 $request[$parameter] = $input[$parameter] ?? $defaultvalue;
108 } elseif (is_int($defaultvalue)) {
109 $request[$parameter] = (int)($input[$parameter] ?? $defaultvalue);
110 } elseif (is_float($defaultvalue)) {
111 $request[$parameter] = (float)($input[$parameter] ?? $defaultvalue);
112 } elseif (is_array($defaultvalue)) {
113 $request[$parameter] = $input[$parameter] ?? [];
114 } elseif (is_bool($defaultvalue)) {
115 $request[$parameter] = in_array(strtolower($input[$parameter] ?? ''), ['true', '1']);
117 Logger::notice('Unhandled default value type', ['parameter' => $parameter, 'type' => gettype($defaultvalue)]);
121 foreach ($input ?? [] as $parameter => $value) {
122 if ($parameter == 'pagename') {
125 if (!in_array($parameter, array_keys($defaults))) {
126 Logger::notice('Unhandled request field', ['parameter' => $parameter, 'value' => $value, 'command' => DI::args()->getCommand()]);
130 Logger::debug('Got request parameters', ['request' => $request, 'command' => DI::args()->getCommand()]);
135 * Set boundaries for the "link" header
136 * @param array $boundaries
140 protected static function setBoundaries(int $id)
142 if (!isset(self::$boundaries['min'])) {
143 self::$boundaries['min'] = $id;
146 if (!isset(self::$boundaries['max'])) {
147 self::$boundaries['max'] = $id;
150 self::$boundaries['min'] = min(self::$boundaries['min'], $id);
151 self::$boundaries['max'] = max(self::$boundaries['max'], $id);
155 * Set the "link" header with "next" and "prev" links
158 protected static function setLinkHeader()
160 if (empty(self::$boundaries)) {
164 $request = self::$request;
166 unset($request['min_id']);
167 unset($request['max_id']);
168 unset($request['since_id']);
170 $prev_request = $next_request = $request;
172 $prev_request['min_id'] = self::$boundaries['max'];
173 $next_request['max_id'] = self::$boundaries['min'];
175 $command = DI::baseUrl() . '/' . DI::args()->getCommand();
177 $prev = $command . '?' . http_build_query($prev_request);
178 $next = $command . '?' . http_build_query($next_request);
180 header('Link: <' . $next . '>; rel="next", <' . $prev . '>; rel="prev"');
184 * Get current application token
186 * @return array token
188 protected static function getCurrentApplication()
190 $token = OAuth::getCurrentApplicationToken();
193 $token = BasicAuth::getCurrentApplicationToken();
200 * Get current user id, returns 0 if not logged in
202 * @return int User ID
204 public static function getCurrentUserID()
206 $uid = OAuth::getCurrentUserID();
209 $uid = BasicAuth::getCurrentUserID(false);
216 * Check if the provided scope does exist.
217 * halts execution on missing scope or when not logged in.
219 * @param string $scope the requested scope (read, write, follow, push)
221 public static function checkAllowedScope(string $scope)
223 $token = self::getCurrentApplication();
226 Logger::notice('Empty application token');
227 DI::mstdnError()->Forbidden();
230 if (!isset($token[$scope])) {
231 Logger::warning('The requested scope does not exist', ['scope' => $scope, 'application' => $token]);
232 DI::mstdnError()->Forbidden();
235 if (empty($token[$scope])) {
236 Logger::warning('The requested scope is not allowed', ['scope' => $scope, 'application' => $token]);
237 DI::mstdnError()->Forbidden();
241 public static function checkThrottleLimit()
243 $uid = self::getCurrentUserID();
245 // Check for throttling (maximum posts per day, week and month)
246 $throttle_day = DI::config()->get('system', 'throttle_limit_day');
247 if ($throttle_day > 0) {
248 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60);
250 $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", GRAVITY_PARENT, $uid, $datefrom];
251 $posts_day = Post::countThread($condition);
253 if ($posts_day > $throttle_day) {
254 Logger::info('Daily posting limit reached', ['uid' => $uid, 'posts' => $posts_day, 'limit' => $throttle_day]);
255 $error = DI::l10n()->t('Too Many Requests');
256 $error_description = DI::l10n()->tt("Daily posting limit of %d post reached. The post was rejected.", "Daily posting limit of %d posts reached. The post was rejected.", $throttle_day);
257 $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
258 System::jsonError(429, $errorobj->toArray());
262 $throttle_week = DI::config()->get('system', 'throttle_limit_week');
263 if ($throttle_week > 0) {
264 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*7);
266 $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", GRAVITY_PARENT, $uid, $datefrom];
267 $posts_week = Post::countThread($condition);
269 if ($posts_week > $throttle_week) {
270 Logger::info('Weekly posting limit reached', ['uid' => $uid, 'posts' => $posts_week, 'limit' => $throttle_week]);
271 $error = DI::l10n()->t('Too Many Requests');
272 $error_description = DI::l10n()->tt("Weekly posting limit of %d post reached. The post was rejected.", "Weekly posting limit of %d posts reached. The post was rejected.", $throttle_week);
273 $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
274 System::jsonError(429, $errorobj->toArray());
278 $throttle_month = DI::config()->get('system', 'throttle_limit_month');
279 if ($throttle_month > 0) {
280 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*30);
282 $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", GRAVITY_PARENT, $uid, $datefrom];
283 $posts_month = Post::countThread($condition);
285 if ($posts_month > $throttle_month) {
286 Logger::info('Monthly posting limit reached', ['uid' => $uid, 'posts' => $posts_month, 'limit' => $throttle_month]);
287 $error = DI::l10n()->t('Too Many Requests');
288 $error_description = DI::l10n()->t("Monthly posting limit of %d post reached. The post was rejected.", "Monthly posting limit of %d posts reached. The post was rejected.", $throttle_month);
289 $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
290 System::jsonError(429, $errorobj->toArray());