3 * @copyright Copyright (C) 2010-2023, 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;
26 use Friendica\App\Router;
27 use Friendica\BaseModule;
28 use Friendica\Core\L10n;
29 use Friendica\Core\Logger;
30 use Friendica\Core\System;
31 use Friendica\Database\DBA;
33 use Friendica\Model\Contact;
34 use Friendica\Model\Item;
35 use Friendica\Model\Post;
36 use Friendica\Model\User;
37 use Friendica\Module\Api\ApiResponse;
38 use Friendica\Module\Special\HTTPException as ModuleHTTPException;
39 use Friendica\Network\HTTPException;
40 use Friendica\Object\Api\Mastodon\Status;
41 use Friendica\Object\Api\Mastodon\TimelineOrderByTypes;
42 use Friendica\Security\BasicAuth;
43 use Friendica\Security\OAuth;
44 use Friendica\Util\DateTimeFormat;
45 use Friendica\Util\Profiler;
46 use Psr\Http\Message\ResponseInterface;
47 use Psr\Log\LoggerInterface;
49 class BaseApi extends BaseModule
51 const LOG_PREFIX = 'API {action} - ';
53 const SCOPE_READ = 'read';
54 const SCOPE_WRITE = 'write';
55 const SCOPE_FOLLOW = 'follow';
56 const SCOPE_PUSH = 'push';
61 protected static $boundaries = [];
66 protected static $request = [];
71 /** @var ApiResponse */
74 public function __construct(App $app, L10n $l10n, App\BaseURL $baseUrl, App\Arguments $args, LoggerInterface $logger, Profiler $profiler, ApiResponse $response, array $server, array $parameters = [])
76 parent::__construct($l10n, $baseUrl, $args, $logger, $profiler, $response, $server, $parameters);
82 * Additionally checks, if the caller is permitted to do this action
86 * @throws HTTPException\ForbiddenException
88 public function run(ModuleHTTPException $httpException, array $request = [], bool $scopecheck = true): ResponseInterface
91 switch ($this->args->getMethod()) {
96 self::checkAllowedScope(self::SCOPE_WRITE);
98 if (!self::getCurrentUserID()) {
99 throw new HTTPException\ForbiddenException($this->t('Permission denied.'));
105 return parent::run($httpException, $request);
109 * Processes data from GET requests and sets paging conditions
111 * @param array $request Custom REQUEST array
112 * @param array $condition Existing conditions to merge
113 * @return array paging data condition parameters data
116 protected function addPagingConditions(array $request, array $condition): array
118 $requested_order = $request['friendica_order'];
119 if ($requested_order == TimelineOrderByTypes::ID) {
120 if (!empty($request['max_id'])) {
121 $condition = DBA::mergeConditions($condition, ["`uri-id` < ?", intval($request['max_id'])]);
124 if (!empty($request['since_id'])) {
125 $condition = DBA::mergeConditions($condition, ["`uri-id` > ?", intval($request['since_id'])]);
128 if (!empty($request['min_id'])) {
129 $condition = DBA::mergeConditions($condition, ["`uri-id` > ?", intval($request['min_id'])]);
132 $order_field = $requested_order;
133 if (!empty($request['max_id'])) {
134 $condition = DBA::mergeConditions($condition, ["`$order_field` < ?", DateTimeFormat::convert($request['max_id'], DateTimeFormat::MYSQL)]);
137 if (!empty($request['since_id'])) {
138 $condition = DBA::mergeConditions($condition, ["`$order_field` > ?", DateTimeFormat::convert($request['since_id'], DateTimeFormat::MYSQL)]);
141 if (!empty($request['min_id'])) {
142 $condition = DBA::mergeConditions($condition, ["`$order_field` > ?", DateTimeFormat::convert($request['min_id'], DateTimeFormat::MYSQL)]);
150 * Processes data from GET requests and sets paging conditions
152 * @param array $request Custom REQUEST array
153 * @param array $params Existing $params element to build on
154 * @return array ordering data added to the params blocks that was passed in
157 protected function buildOrderAndLimitParams(array $request, array $params = []): array
159 $requested_order = $request['friendica_order'];
160 switch ($requested_order) {
161 case TimelineOrderByTypes::CHANGED:
162 $order_field = 'changed';
164 case TimelineOrderByTypes::CREATED:
165 $order_field = 'created';
167 case TimelineOrderByTypes::COMMENTED:
168 $order_field = 'commented';
170 case TimelineOrderByTypes::EDITED:
171 $order_field = 'edited';
173 case TimelineOrderByTypes::RECEIVED:
174 $order_field = 'received';
176 case TimelineOrderByTypes::ID:
178 $order_field = 'uri-id';
181 if (!empty($request['min_id'])) {
182 $params['order'] = [$order_field];
184 $params['order'] = [$order_field => true];
187 $params['limit'] = $request['limit'];
193 * Update the ID/time boundaries for this result set. Used for building Link Headers
195 * @param Status $status
196 * @param array $post_item
197 * @param string $order
201 protected function updateBoundaries(Status $status, array $post_item, string $order)
205 case TimelineOrderByTypes::CHANGED:
206 if (!empty($status->friendicaExtension()->changedAt())) {
207 self::setBoundaries(new DateTime(DateTimeFormat::utc($status->friendicaExtension()->changedAt(), DateTimeFormat::JSON)));
210 case TimelineOrderByTypes::CREATED:
211 if (!empty($status->createdAt())) {
212 self::setBoundaries(new DateTime(DateTimeFormat::utc($status->createdAt(), DateTimeFormat::JSON)));
215 case TimelineOrderByTypes::COMMENTED:
216 if (!empty($status->friendicaExtension()->commentedAt())) {
217 self::setBoundaries(new DateTime(DateTimeFormat::utc($status->friendicaExtension()->commentedAt(), DateTimeFormat::JSON)));
220 case TimelineOrderByTypes::EDITED:
221 if (!empty($status->friendicaExtension()->editedAt())) {
222 self::setBoundaries(new DateTime(DateTimeFormat::utc($status->friendicaExtension()->editedAt(), DateTimeFormat::JSON)));
225 case TimelineOrderByTypes::RECEIVED:
226 if (!empty($status->friendicaExtension()->receivedAt())) {
227 self::setBoundaries(new DateTime(DateTimeFormat::utc($status->friendicaExtension()->receivedAt(), DateTimeFormat::JSON)));
230 case TimelineOrderByTypes::ID:
232 self::setBoundaries($post_item['uri-id']);
234 } catch (\Exception $e) {
235 Logger::debug('Error processing page boundary calculation, skipping', ['error' => $e]);
240 * Processes data from GET requests and sets defaults
242 * @param array $defaults Associative array of expected request keys and their default typed value. A null
243 * value will remove the request key from the resulting value array.
244 * @param array $request Custom REQUEST array, superglobal instead
245 * @return array request data
248 public function getRequest(array $defaults, array $request): array
250 self::$request = $request;
251 self::$boundaries = [];
253 unset(self::$request['pagename']);
255 return $this->checkDefaults($defaults, $request);
259 * Set boundaries for the "link" header
260 * @param array $boundaries
261 * @param int|\DateTime $id
263 protected static function setBoundaries($id)
265 if (!isset(self::$boundaries['min'])) {
266 self::$boundaries['min'] = $id;
269 if (!isset(self::$boundaries['max'])) {
270 self::$boundaries['max'] = $id;
273 self::$boundaries['min'] = min(self::$boundaries['min'], $id);
274 self::$boundaries['max'] = max(self::$boundaries['max'], $id);
278 * Get the "link" header with "next" and "prev" links
281 protected static function getLinkHeader(bool $asDate = false): string
283 if (empty(self::$boundaries)) {
287 $request = self::$request;
289 unset($request['min_id']);
290 unset($request['max_id']);
291 unset($request['since_id']);
293 $prev_request = $next_request = $request;
296 $max_date = self::$boundaries['max'];
297 $min_date = self::$boundaries['min'];
298 $prev_request['min_id'] = $max_date->format(DateTimeFormat::JSON);
299 $next_request['max_id'] = $min_date->format(DateTimeFormat::JSON);
301 $prev_request['min_id'] = self::$boundaries['max'];
302 $next_request['max_id'] = self::$boundaries['min'];
305 $command = DI::baseUrl() . '/' . DI::args()->getCommand();
307 $prev = $command . '?' . http_build_query($prev_request);
308 $next = $command . '?' . http_build_query($next_request);
310 return 'Link: <' . $next . '>; rel="next", <' . $prev . '>; rel="prev"';
314 * Get the "link" header with "next" and "prev" links for an offset/limit type call
317 protected static function getOffsetAndLimitLinkHeader(int $offset, int $limit): string
319 $request = self::$request;
321 unset($request['offset']);
322 $request['limit'] = $limit;
324 $prev_request = $next_request = $request;
326 $prev_request['offset'] = $offset - $limit;
327 $next_request['offset'] = $offset + $limit;
329 $command = DI::baseUrl() . '/' . DI::args()->getCommand();
331 $prev = $command . '?' . http_build_query($prev_request);
332 $next = $command . '?' . http_build_query($next_request);
334 if ($prev_request['offset'] >= 0) {
335 return 'Link: <' . $next . '>; rel="next", <' . $prev . '>; rel="prev"';
337 return 'Link: <' . $next . '>; rel="next"';
342 * Set the "link" header with "next" and "prev" links
345 protected static function setLinkHeader(bool $asDate = false)
347 $header = self::getLinkHeader($asDate);
348 if (!empty($header)) {
354 * Set the "link" header with "next" and "prev" links
357 protected static function setLinkHeaderByOffsetLimit(int $offset, int $limit)
359 $header = self::getOffsetAndLimitLinkHeader($offset, $limit);
360 if (!empty($header)) {
366 * Check if the app is known to support quoted posts
370 public static function appSupportsQuotes(): bool
372 $token = self::getCurrentApplication();
373 return (!empty($token['name']) && in_array($token['name'], ['Fedilab']));
377 * Get current application token
379 * @return array token
381 public static function getCurrentApplication()
383 $token = OAuth::getCurrentApplicationToken();
386 $token = BasicAuth::getCurrentApplicationToken();
393 * Get current user id, returns 0 if not logged in
395 * @return int User ID
397 public static function getCurrentUserID()
399 $uid = OAuth::getCurrentUserID();
402 $uid = BasicAuth::getCurrentUserID(false);
409 * Check if the provided scope does exist.
410 * halts execution on missing scope or when not logged in.
412 * @param string $scope the requested scope (read, write, follow, push)
414 public static function checkAllowedScope(string $scope)
416 $token = self::getCurrentApplication();
419 Logger::notice('Empty application token');
420 DI::mstdnError()->Forbidden();
423 if (!isset($token[$scope])) {
424 Logger::warning('The requested scope does not exist', ['scope' => $scope, 'application' => $token]);
425 DI::mstdnError()->Forbidden();
428 if (empty($token[$scope])) {
429 Logger::warning('The requested scope is not allowed', ['scope' => $scope, 'application' => $token]);
430 DI::mstdnError()->Forbidden();
434 public static function checkThrottleLimit()
436 $uid = self::getCurrentUserID();
438 // Check for throttling (maximum posts per day, week and month)
439 $throttle_day = DI::config()->get('system', 'throttle_limit_day');
440 if ($throttle_day > 0) {
441 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60);
443 $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", Item::GRAVITY_PARENT, $uid, $datefrom];
444 $posts_day = Post::countThread($condition);
446 if ($posts_day > $throttle_day) {
447 Logger::notice('Daily posting limit reached', ['uid' => $uid, 'posts' => $posts_day, 'limit' => $throttle_day]);
448 $error = DI::l10n()->t('Too Many Requests');
449 $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);
450 $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
451 System::jsonError(429, $errorobj->toArray());
455 $throttle_week = DI::config()->get('system', 'throttle_limit_week');
456 if ($throttle_week > 0) {
457 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*7);
459 $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", Item::GRAVITY_PARENT, $uid, $datefrom];
460 $posts_week = Post::countThread($condition);
462 if ($posts_week > $throttle_week) {
463 Logger::notice('Weekly posting limit reached', ['uid' => $uid, 'posts' => $posts_week, 'limit' => $throttle_week]);
464 $error = DI::l10n()->t('Too Many Requests');
465 $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);
466 $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
467 System::jsonError(429, $errorobj->toArray());
471 $throttle_month = DI::config()->get('system', 'throttle_limit_month');
472 if ($throttle_month > 0) {
473 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*30);
475 $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", Item::GRAVITY_PARENT, $uid, $datefrom];
476 $posts_month = Post::countThread($condition);
478 if ($posts_month > $throttle_month) {
479 Logger::notice('Monthly posting limit reached', ['uid' => $uid, 'posts' => $posts_month, 'limit' => $throttle_month]);
480 $error = DI::l10n()->t('Too Many Requests');
481 $error_description = DI::l10n()->tt('Monthly posting limit of %d post reached. The post was rejected.', 'Monthly posting limit of %d posts reached. The post was rejected.', $throttle_month);
482 $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
483 System::jsonError(429, $errorobj->toArray());
488 public static function getContactIDForSearchterm(string $screen_name = null, string $profileurl = null, int $cid = null, int $uid)
494 if (!empty($profileurl)) {
495 return Contact::getIdForURL($profileurl);
498 if (empty($cid) && !empty($screen_name)) {
499 if (strpos($screen_name, '@') !== false) {
500 return Contact::getIdForURL($screen_name, 0, false);
503 $user = User::getByNickname($screen_name, ['uid']);
504 if (!empty($user['uid'])) {
505 return Contact::getPublicIdByUserId($user['uid']);
510 return Contact::getPublicIdByUserId($uid);