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\Database\DBA;
32 use Friendica\Model\Contact;
33 use Friendica\Model\Item;
34 use Friendica\Model\Post;
35 use Friendica\Model\User;
36 use Friendica\Module\Api\ApiResponse;
37 use Friendica\Module\Special\HTTPException as ModuleHTTPException;
38 use Friendica\Network\HTTPException;
39 use Friendica\Object\Api\Mastodon\Error;
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 /** @var \Friendica\Factory\Api\Mastodon\Error */
75 protected $errorFactory;
77 public function __construct(\Friendica\Factory\Api\Mastodon\Error $errorFactory, App $app, L10n $l10n, App\BaseURL $baseUrl, App\Arguments $args, LoggerInterface $logger, Profiler $profiler, ApiResponse $response, array $server, array $parameters = [])
79 parent::__construct($l10n, $baseUrl, $args, $logger, $profiler, $response, $server, $parameters);
82 $this->errorFactory = $errorFactory;
86 * Additionally checks, if the caller is permitted to do this action
90 * @throws HTTPException\ForbiddenException
92 public function run(ModuleHTTPException $httpException, array $request = [], bool $scopecheck = true): ResponseInterface
95 switch ($this->args->getMethod()) {
100 $this->checkAllowedScope(self::SCOPE_WRITE);
102 if (!self::getCurrentUserID()) {
103 throw new HTTPException\ForbiddenException($this->t('Permission denied.'));
109 return parent::run($httpException, $request);
113 * Processes data from GET requests and sets paging conditions
115 * @param array $request Custom REQUEST array
116 * @param array $condition Existing conditions to merge
117 * @return array paging data condition parameters data
120 protected function addPagingConditions(array $request, array $condition): array
122 $requested_order = $request['friendica_order'];
123 if ($requested_order == TimelineOrderByTypes::ID) {
124 if (!empty($request['max_id'])) {
125 $condition = DBA::mergeConditions($condition, ["`uri-id` < ?", intval($request['max_id'])]);
128 if (!empty($request['since_id'])) {
129 $condition = DBA::mergeConditions($condition, ["`uri-id` > ?", intval($request['since_id'])]);
132 if (!empty($request['min_id'])) {
133 $condition = DBA::mergeConditions($condition, ["`uri-id` > ?", intval($request['min_id'])]);
136 switch ($requested_order) {
137 case TimelineOrderByTypes::RECEIVED:
138 case TimelineOrderByTypes::CHANGED:
139 case TimelineOrderByTypes::EDITED:
140 case TimelineOrderByTypes::CREATED:
141 case TimelineOrderByTypes::COMMENTED:
142 $order_field = $requested_order;
145 throw new \Exception("Unrecognized request order: $requested_order");
148 if (!empty($request['max_id'])) {
149 $condition = DBA::mergeConditions($condition, ["`$order_field` < ?", DateTimeFormat::convert($request['max_id'], DateTimeFormat::MYSQL)]);
152 if (!empty($request['since_id'])) {
153 $condition = DBA::mergeConditions($condition, ["`$order_field` > ?", DateTimeFormat::convert($request['since_id'], DateTimeFormat::MYSQL)]);
156 if (!empty($request['min_id'])) {
157 $condition = DBA::mergeConditions($condition, ["`$order_field` > ?", DateTimeFormat::convert($request['min_id'], DateTimeFormat::MYSQL)]);
165 * Processes data from GET requests and sets paging conditions
167 * @param array $request Custom REQUEST array
168 * @param array $params Existing $params element to build on
169 * @return array ordering data added to the params blocks that was passed in
172 protected function buildOrderAndLimitParams(array $request, array $params = []): array
174 $requested_order = $request['friendica_order'];
175 switch ($requested_order) {
176 case TimelineOrderByTypes::CHANGED:
177 case TimelineOrderByTypes::CREATED:
178 case TimelineOrderByTypes::COMMENTED:
179 case TimelineOrderByTypes::EDITED:
180 case TimelineOrderByTypes::RECEIVED:
181 $order_field = $requested_order;
183 case TimelineOrderByTypes::ID:
185 $order_field = 'uri-id';
188 if (!empty($request['min_id'])) {
189 $params['order'] = [$order_field];
191 $params['order'] = [$order_field => true];
194 $params['limit'] = $request['limit'];
200 * Update the ID/time boundaries for this result set. Used for building Link Headers
202 * @param Status $status
203 * @param array $post_item
204 * @param string $order
208 protected function updateBoundaries(Status $status, array $post_item, string $order)
212 case TimelineOrderByTypes::CHANGED:
213 if (!empty($status->friendicaExtension()->changedAt())) {
214 self::setBoundaries(new DateTime(DateTimeFormat::utc($status->friendicaExtension()->changedAt(), DateTimeFormat::JSON)));
217 case TimelineOrderByTypes::CREATED:
218 if (!empty($status->createdAt())) {
219 self::setBoundaries(new DateTime(DateTimeFormat::utc($status->createdAt(), DateTimeFormat::JSON)));
222 case TimelineOrderByTypes::COMMENTED:
223 if (!empty($status->friendicaExtension()->commentedAt())) {
224 self::setBoundaries(new DateTime(DateTimeFormat::utc($status->friendicaExtension()->commentedAt(), DateTimeFormat::JSON)));
227 case TimelineOrderByTypes::EDITED:
228 if (!empty($status->editedAt())) {
229 self::setBoundaries(new DateTime(DateTimeFormat::utc($status->editedAt(), DateTimeFormat::JSON)));
232 case TimelineOrderByTypes::RECEIVED:
233 if (!empty($status->friendicaExtension()->receivedAt())) {
234 self::setBoundaries(new DateTime(DateTimeFormat::utc($status->friendicaExtension()->receivedAt(), DateTimeFormat::JSON)));
237 case TimelineOrderByTypes::ID:
239 self::setBoundaries($post_item['uri-id']);
241 } catch (\Exception $e) {
242 Logger::debug('Error processing page boundary calculation, skipping', ['error' => $e]);
247 * Processes data from GET requests and sets defaults
249 * @param array $defaults Associative array of expected request keys and their default typed value. A null
250 * value will remove the request key from the resulting value array.
251 * @param array $request Custom REQUEST array, superglobal instead
252 * @return array request data
255 public function getRequest(array $defaults, array $request): array
257 self::$request = $request;
258 self::$boundaries = [];
260 unset(self::$request['pagename']);
262 return $this->checkDefaults($defaults, $request);
266 * Set boundaries for the "link" header
267 * @param array $boundaries
268 * @param int|\DateTime $id
270 protected static function setBoundaries($id)
272 if (!isset(self::$boundaries['min'])) {
273 self::$boundaries['min'] = $id;
276 if (!isset(self::$boundaries['max'])) {
277 self::$boundaries['max'] = $id;
280 self::$boundaries['min'] = min(self::$boundaries['min'], $id);
281 self::$boundaries['max'] = max(self::$boundaries['max'], $id);
285 * Get the "link" header with "next" and "prev" links
288 protected static function getLinkHeader(bool $asDate = false): string
290 if (empty(self::$boundaries)) {
294 $request = self::$request;
296 unset($request['min_id']);
297 unset($request['max_id']);
298 unset($request['since_id']);
300 $prev_request = $next_request = $request;
303 $max_date = self::$boundaries['max'];
304 $min_date = self::$boundaries['min'];
305 $prev_request['min_id'] = $max_date->format(DateTimeFormat::JSON);
306 $next_request['max_id'] = $min_date->format(DateTimeFormat::JSON);
308 $prev_request['min_id'] = self::$boundaries['max'];
309 $next_request['max_id'] = self::$boundaries['min'];
312 $command = DI::baseUrl() . '/' . DI::args()->getCommand();
314 $prev = $command . '?' . http_build_query($prev_request);
315 $next = $command . '?' . http_build_query($next_request);
317 return 'Link: <' . $next . '>; rel="next", <' . $prev . '>; rel="prev"';
321 * Get the "link" header with "next" and "prev" links for an offset/limit type call
324 protected static function getOffsetAndLimitLinkHeader(int $offset, int $limit): string
326 $request = self::$request;
328 unset($request['offset']);
329 $request['limit'] = $limit;
331 $prev_request = $next_request = $request;
333 $prev_request['offset'] = $offset - $limit;
334 $next_request['offset'] = $offset + $limit;
336 $command = DI::baseUrl() . '/' . DI::args()->getCommand();
338 $prev = $command . '?' . http_build_query($prev_request);
339 $next = $command . '?' . http_build_query($next_request);
341 if ($prev_request['offset'] >= 0) {
342 return 'Link: <' . $next . '>; rel="next", <' . $prev . '>; rel="prev"';
344 return 'Link: <' . $next . '>; rel="next"';
349 * Set the "link" header with "next" and "prev" links
352 protected static function setLinkHeader(bool $asDate = false)
354 $header = self::getLinkHeader($asDate);
355 if (!empty($header)) {
361 * Set the "link" header with "next" and "prev" links
364 protected static function setLinkHeaderByOffsetLimit(int $offset, int $limit)
366 $header = self::getOffsetAndLimitLinkHeader($offset, $limit);
367 if (!empty($header)) {
373 * Check if the app is known to support quoted posts
377 public static function appSupportsQuotes(): bool
379 $token = OAuth::getCurrentApplicationToken();
380 return (!empty($token['name']) && in_array($token['name'], ['Fedilab']));
384 * Get current application token
386 * @return array token
388 public static function getCurrentApplication()
390 $token = OAuth::getCurrentApplicationToken();
393 $token = BasicAuth::getCurrentApplicationToken();
400 * Get current user id, returns 0 if not logged in
402 * @return int User ID
404 public static function getCurrentUserID()
406 $uid = OAuth::getCurrentUserID();
409 $uid = BasicAuth::getCurrentUserID(false);
416 * Check if the provided scope does exist.
417 * halts execution on missing scope or when not logged in.
419 * @param string $scope the requested scope (read, write, follow, push)
421 public function checkAllowedScope(string $scope)
423 $token = self::getCurrentApplication();
426 $this->logger->notice('Empty application token');
427 $this->logErrorAndJsonExit(403, $this->errorFactory->Forbidden());
430 if (!isset($token[$scope])) {
431 $this->logger->warning('The requested scope does not exist', ['scope' => $scope, 'application' => $token]);
432 $this->logErrorAndJsonExit(403, $this->errorFactory->Forbidden());
435 if (empty($token[$scope])) {
436 $this->logger->warning('The requested scope is not allowed', ['scope' => $scope, 'application' => $token]);
437 $this->logErrorAndJsonExit(403, $this->errorFactory->Forbidden());
441 public function checkThrottleLimit()
443 $uid = self::getCurrentUserID();
445 // Check for throttling (maximum posts per day, week and month)
446 $throttle_day = DI::config()->get('system', 'throttle_limit_day');
447 if ($throttle_day > 0) {
448 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60);
450 $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", Item::GRAVITY_PARENT, $uid, $datefrom];
451 $posts_day = Post::countThread($condition);
453 if ($posts_day > $throttle_day) {
454 $this->logger->notice('Daily posting limit reached', ['uid' => $uid, 'posts' => $posts_day, 'limit' => $throttle_day]);
455 $error = $this->t('Too Many Requests');
456 $error_description = $this->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);
457 $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
458 $this->jsonError(429, $errorobj->toArray());
462 $throttle_week = DI::config()->get('system', 'throttle_limit_week');
463 if ($throttle_week > 0) {
464 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*7);
466 $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", Item::GRAVITY_PARENT, $uid, $datefrom];
467 $posts_week = Post::countThread($condition);
469 if ($posts_week > $throttle_week) {
470 Logger::notice('Weekly posting limit reached', ['uid' => $uid, 'posts' => $posts_week, 'limit' => $throttle_week]);
471 $error = $this->t('Too Many Requests');
472 $error_description = $this->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);
473 $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
474 $this->jsonError(429, $errorobj->toArray());
478 $throttle_month = DI::config()->get('system', 'throttle_limit_month');
479 if ($throttle_month > 0) {
480 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*30);
482 $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", Item::GRAVITY_PARENT, $uid, $datefrom];
483 $posts_month = Post::countThread($condition);
485 if ($posts_month > $throttle_month) {
486 Logger::notice('Monthly posting limit reached', ['uid' => $uid, 'posts' => $posts_month, 'limit' => $throttle_month]);
487 $error = $this->t('Too Many Requests');
488 $error_description = $this->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);
489 $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
490 $this->jsonError(429, $errorobj->toArray());
495 public static function getContactIDForSearchterm(string $screen_name = null, string $profileurl = null, int $cid = null, int $uid)
501 if (!empty($profileurl)) {
502 return Contact::getIdForURL($profileurl);
505 if (empty($cid) && !empty($screen_name)) {
506 if (strpos($screen_name, '@') !== false) {
507 return Contact::getIdForURL($screen_name, 0, false);
510 $user = User::getByNickname($screen_name, ['uid']);
511 if (!empty($user['uid'])) {
512 return Contact::getPublicIdByUserId($user['uid']);
517 return Contact::getPublicIdByUserId($uid);
524 * @param int $errorno
525 * @param Error $error
527 * @throws HTTPException\InternalServerErrorException
529 protected function logErrorAndJsonExit(int $errorno, Error $error)
531 $this->logger->info('API Error', ['no' => $errorno, 'error' => $error->toArray(), 'method' => $this->args->getMethod(), 'command' => $this->args->getQueryString(), 'user-agent' => $this->server['HTTP_USER_AGENT'] ?? '']);
532 $this->jsonError(403, $error->toArray());