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;
25 use Friendica\BaseModule;
26 use Friendica\Core\L10n;
27 use Friendica\Core\Logger;
28 use Friendica\Core\System;
30 use Friendica\Model\Contact;
31 use Friendica\Model\Post;
32 use Friendica\Model\User;
33 use Friendica\Module\Api\ApiResponse;
34 use Friendica\Network\HTTPException;
35 use Friendica\Security\BasicAuth;
36 use Friendica\Security\OAuth;
37 use Friendica\Util\DateTimeFormat;
38 use Friendica\Util\HTTPInputData;
39 use Friendica\Util\Profiler;
40 use Psr\Log\LoggerInterface;
42 class BaseApi extends BaseModule
44 const LOG_PREFIX = 'API {action} - ';
46 const SCOPE_READ = 'read';
47 const SCOPE_WRITE = 'write';
48 const SCOPE_FOLLOW = 'follow';
49 const SCOPE_PUSH = 'push';
54 protected static $boundaries = [];
59 protected static $request = [];
64 /** @var ApiResponse */
67 public function __construct(App $app, L10n $l10n, App\BaseURL $baseUrl, App\Arguments $args, LoggerInterface $logger, Profiler $profiler, ApiResponse $response, array $server, array $parameters = [])
69 parent::__construct($l10n, $baseUrl, $args, $logger, $profiler, $response, $server, $parameters);
74 protected function delete()
76 self::checkAllowedScope(self::SCOPE_WRITE);
78 if (!$this->app->isLoggedIn()) {
79 throw new HTTPException\ForbiddenException($this->t('Permission denied.'));
83 protected function patch()
85 self::checkAllowedScope(self::SCOPE_WRITE);
87 if (!$this->app->isLoggedIn()) {
88 throw new HTTPException\ForbiddenException($this->t('Permission denied.'));
92 protected function post(array $request = [], array $post = [])
94 self::checkAllowedScope(self::SCOPE_WRITE);
96 if (!$this->app->isLoggedIn()) {
97 throw new HTTPException\ForbiddenException($this->t('Permission denied.'));
101 public function put()
103 self::checkAllowedScope(self::SCOPE_WRITE);
105 if (!$this->app->isLoggedIn()) {
106 throw new HTTPException\ForbiddenException($this->t('Permission denied.'));
111 * Processes data from GET requests and sets defaults
113 * @param array $defaults Associative array of expected request keys and their default typed value. A null
114 * value will remove the request key from the resulting value array.
115 * @param array|null $request Custom REQUEST array, superglobal instead
116 * @return array request data
119 public static function getRequest(array $defaults, array $request = null): array
121 $httpinput = HTTPInputData::process();
122 $input = array_merge($httpinput['variables'], $httpinput['files'], $request ?? $_REQUEST);
124 self::$request = $input;
125 self::$boundaries = [];
127 unset(self::$request['pagename']);
131 foreach ($defaults as $parameter => $defaultvalue) {
132 if (is_string($defaultvalue)) {
133 $request[$parameter] = $input[$parameter] ?? $defaultvalue;
134 } elseif (is_int($defaultvalue)) {
135 $request[$parameter] = (int)($input[$parameter] ?? $defaultvalue);
136 } elseif (is_float($defaultvalue)) {
137 $request[$parameter] = (float)($input[$parameter] ?? $defaultvalue);
138 } elseif (is_array($defaultvalue)) {
139 $request[$parameter] = $input[$parameter] ?? [];
140 } elseif (is_bool($defaultvalue)) {
141 $request[$parameter] = in_array(strtolower($input[$parameter] ?? ''), ['true', '1']);
143 Logger::notice('Unhandled default value type', ['parameter' => $parameter, 'type' => gettype($defaultvalue)]);
147 foreach ($input ?? [] as $parameter => $value) {
148 if ($parameter == 'pagename') {
151 if (!in_array($parameter, array_keys($defaults))) {
152 Logger::notice('Unhandled request field', ['parameter' => $parameter, 'value' => $value, 'command' => DI::args()->getCommand()]);
156 Logger::debug('Got request parameters', ['request' => $request, 'command' => DI::args()->getCommand()]);
161 * Set boundaries for the "link" header
162 * @param array $boundaries
165 protected static function setBoundaries(int $id)
167 if (!isset(self::$boundaries['min'])) {
168 self::$boundaries['min'] = $id;
171 if (!isset(self::$boundaries['max'])) {
172 self::$boundaries['max'] = $id;
175 self::$boundaries['min'] = min(self::$boundaries['min'], $id);
176 self::$boundaries['max'] = max(self::$boundaries['max'], $id);
180 * Set the "link" header with "next" and "prev" links
183 protected static function setLinkHeader()
185 if (empty(self::$boundaries)) {
189 $request = self::$request;
191 unset($request['min_id']);
192 unset($request['max_id']);
193 unset($request['since_id']);
195 $prev_request = $next_request = $request;
197 $prev_request['min_id'] = self::$boundaries['max'];
198 $next_request['max_id'] = self::$boundaries['min'];
200 $command = DI::baseUrl() . '/' . DI::args()->getCommand();
202 $prev = $command . '?' . http_build_query($prev_request);
203 $next = $command . '?' . http_build_query($next_request);
205 header('Link: <' . $next . '>; rel="next", <' . $prev . '>; rel="prev"');
209 * Get current application token
211 * @return array token
213 public static function getCurrentApplication()
215 $token = OAuth::getCurrentApplicationToken();
218 $token = BasicAuth::getCurrentApplicationToken();
225 * Get current user id, returns 0 if not logged in
227 * @return int User ID
229 public static function getCurrentUserID()
231 $uid = OAuth::getCurrentUserID();
234 $uid = BasicAuth::getCurrentUserID(false);
241 * Check if the provided scope does exist.
242 * halts execution on missing scope or when not logged in.
244 * @param string $scope the requested scope (read, write, follow, push)
246 public static function checkAllowedScope(string $scope)
248 $token = self::getCurrentApplication();
251 Logger::notice('Empty application token');
252 DI::mstdnError()->Forbidden();
255 if (!isset($token[$scope])) {
256 Logger::warning('The requested scope does not exist', ['scope' => $scope, 'application' => $token]);
257 DI::mstdnError()->Forbidden();
260 if (empty($token[$scope])) {
261 Logger::warning('The requested scope is not allowed', ['scope' => $scope, 'application' => $token]);
262 DI::mstdnError()->Forbidden();
266 public static function checkThrottleLimit()
268 $uid = self::getCurrentUserID();
270 // Check for throttling (maximum posts per day, week and month)
271 $throttle_day = DI::config()->get('system', 'throttle_limit_day');
272 if ($throttle_day > 0) {
273 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60);
275 $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", GRAVITY_PARENT, $uid, $datefrom];
276 $posts_day = Post::countThread($condition);
278 if ($posts_day > $throttle_day) {
279 Logger::info('Daily posting limit reached', ['uid' => $uid, 'posts' => $posts_day, 'limit' => $throttle_day]);
280 $error = DI::l10n()->t('Too Many Requests');
281 $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);
282 $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
283 System::jsonError(429, $errorobj->toArray());
287 $throttle_week = DI::config()->get('system', 'throttle_limit_week');
288 if ($throttle_week > 0) {
289 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*7);
291 $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", GRAVITY_PARENT, $uid, $datefrom];
292 $posts_week = Post::countThread($condition);
294 if ($posts_week > $throttle_week) {
295 Logger::info('Weekly posting limit reached', ['uid' => $uid, 'posts' => $posts_week, 'limit' => $throttle_week]);
296 $error = DI::l10n()->t('Too Many Requests');
297 $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);
298 $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
299 System::jsonError(429, $errorobj->toArray());
303 $throttle_month = DI::config()->get('system', 'throttle_limit_month');
304 if ($throttle_month > 0) {
305 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*30);
307 $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", GRAVITY_PARENT, $uid, $datefrom];
308 $posts_month = Post::countThread($condition);
310 if ($posts_month > $throttle_month) {
311 Logger::info('Monthly posting limit reached', ['uid' => $uid, 'posts' => $posts_month, 'limit' => $throttle_month]);
312 $error = DI::l10n()->t('Too Many Requests');
313 $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);
314 $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
315 System::jsonError(429, $errorobj->toArray());
320 public static function getContactIDForSearchterm(string $screen_name = null, string $profileurl = null, int $cid = null, int $uid)
326 if (!empty($profileurl)) {
327 return Contact::getIdForURL($profileurl);
330 if (empty($cid) && !empty($screen_name)) {
331 if (strpos($screen_name, '@') !== false) {
332 return Contact::getIdForURL($screen_name, 0, false);
335 $user = User::getByNickname($screen_name, ['uid']);
336 if (!empty($user['uid'])) {
337 return Contact::getPublicIdByUserId($user['uid']);
342 return Contact::getPublicIdByUserId($uid);