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'];
192 protected function updateBoundaries(Status $status, array $post_item, string $order) {
196 case TimelineOrderByTypes::CHANGED:
197 if (!empty($status->friendicaExtension()->changedAt())){
198 self::setBoundaries(new DateTime(DateTimeFormat::utc($status->friendicaExtension()->changedAt(), DateTimeFormat::JSON)));
201 case TimelineOrderByTypes::CREATED:
202 if (!empty($status->createdAt())){
203 self::setBoundaries(new DateTime(DateTimeFormat::utc($status->createdAt(), DateTimeFormat::JSON)));
206 case TimelineOrderByTypes::COMMENTED:
207 if (!empty($status->friendicaExtension()->commentedAt())){
208 self::setBoundaries(new DateTime(DateTimeFormat::utc($status->friendicaExtension()->commentedAt(), DateTimeFormat::JSON)));
211 case TimelineOrderByTypes::EDITED:
212 if (!empty($status->friendicaExtension()->editedAt())){
213 self::setBoundaries(new DateTime(DateTimeFormat::utc($status->friendicaExtension()->editedAt(), DateTimeFormat::JSON)));
216 case TimelineOrderByTypes::RECEIVED:
217 if (!empty($status->friendicaExtension()->receivedAt())){
218 self::setBoundaries(new DateTime(DateTimeFormat::utc($status->friendicaExtension()->receivedAt(), DateTimeFormat::JSON)));
221 case TimelineOrderByTypes::ID:
223 self::setBoundaries($post_item['uri-id']);
225 } catch (\Exception $e) {
226 Logger::debug('Error processing page boundary calculation, skipping', ['error' => $e]);
231 * Processes data from GET requests and sets defaults
233 * @param array $defaults Associative array of expected request keys and their default typed value. A null
234 * value will remove the request key from the resulting value array.
235 * @param array $request Custom REQUEST array, superglobal instead
236 * @return array request data
239 public function getRequest(array $defaults, array $request): array
241 self::$request = $request;
242 self::$boundaries = [];
244 unset(self::$request['pagename']);
246 return $this->checkDefaults($defaults, $request);
250 * Set boundaries for the "link" header
251 * @param array $boundaries
252 * @param int|\DateTime $id
254 protected static function setBoundaries($id)
256 if (!isset(self::$boundaries['min'])) {
257 self::$boundaries['min'] = $id;
260 if (!isset(self::$boundaries['max'])) {
261 self::$boundaries['max'] = $id;
264 self::$boundaries['min'] = min(self::$boundaries['min'], $id);
265 self::$boundaries['max'] = max(self::$boundaries['max'], $id);
269 * Get the "link" header with "next" and "prev" links
272 protected static function getLinkHeader(bool $asDate): string
274 if (empty(self::$boundaries)) {
278 $request = self::$request;
280 unset($request['min_id']);
281 unset($request['max_id']);
282 unset($request['since_id']);
284 $prev_request = $next_request = $request;
287 $max_date = self::$boundaries['max'];
288 $min_date = self::$boundaries['min'];
289 $prev_request['min_id'] = $max_date->format(DateTimeFormat::JSON);
290 $next_request['max_id'] = $min_date->format(DateTimeFormat::JSON);
292 $prev_request['min_id'] = self::$boundaries['max'];
293 $next_request['max_id'] = self::$boundaries['min'];
296 $command = DI::baseUrl() . '/' . DI::args()->getCommand();
298 $prev = $command . '?' . http_build_query($prev_request);
299 $next = $command . '?' . http_build_query($next_request);
301 return 'Link: <' . $next . '>; rel="next", <' . $prev . '>; rel="prev"';
305 * Get the "link" header with "next" and "prev" links for an offset/limit type call
308 protected static function getOffsetAndLimitLinkHeader(int $offset, int $limit): string
310 $request = self::$request;
312 unset($request['offset']);
313 $request['limit'] = $limit;
315 $prev_request = $next_request = $request;
317 $prev_request['offset'] = $offset - $limit;
318 $next_request['offset'] = $offset + $limit;
320 $command = DI::baseUrl() . '/' . DI::args()->getCommand();
322 $prev = $command . '?' . http_build_query($prev_request);
323 $next = $command . '?' . http_build_query($next_request);
325 if ($prev_request['offset'] >= 0) {
326 return 'Link: <' . $next . '>; rel="next", <' . $prev . '>; rel="prev"';
328 return 'Link: <' . $next . '>; rel="next"';
333 * Set the "link" header with "next" and "prev" links
336 protected static function setLinkHeader(bool $asDate = false)
338 $header = self::getLinkHeader($asDate);
339 if (!empty($header)) {
345 * Set the "link" header with "next" and "prev" links
348 protected static function setLinkHeaderByOffsetLimit(int $offset, int $limit)
350 $header = self::getOffsetAndLimitLinkHeader($offset, $limit);
351 if (!empty($header)) {
357 * Check if the app is known to support quoted posts
361 public static function appSupportsQuotes(): bool
363 $token = self::getCurrentApplication();
364 return (!empty($token['name']) && in_array($token['name'], ['Fedilab']));
368 * Get current application token
370 * @return array token
372 public static function getCurrentApplication()
374 $token = OAuth::getCurrentApplicationToken();
377 $token = BasicAuth::getCurrentApplicationToken();
384 * Get current user id, returns 0 if not logged in
386 * @return int User ID
388 public static function getCurrentUserID()
390 $uid = OAuth::getCurrentUserID();
393 $uid = BasicAuth::getCurrentUserID(false);
400 * Check if the provided scope does exist.
401 * halts execution on missing scope or when not logged in.
403 * @param string $scope the requested scope (read, write, follow, push)
405 public static function checkAllowedScope(string $scope)
407 $token = self::getCurrentApplication();
410 Logger::notice('Empty application token');
411 DI::mstdnError()->Forbidden();
414 if (!isset($token[$scope])) {
415 Logger::warning('The requested scope does not exist', ['scope' => $scope, 'application' => $token]);
416 DI::mstdnError()->Forbidden();
419 if (empty($token[$scope])) {
420 Logger::warning('The requested scope is not allowed', ['scope' => $scope, 'application' => $token]);
421 DI::mstdnError()->Forbidden();
425 public static function checkThrottleLimit()
427 $uid = self::getCurrentUserID();
429 // Check for throttling (maximum posts per day, week and month)
430 $throttle_day = DI::config()->get('system', 'throttle_limit_day');
431 if ($throttle_day > 0) {
432 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60);
434 $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", Item::GRAVITY_PARENT, $uid, $datefrom];
435 $posts_day = Post::countThread($condition);
437 if ($posts_day > $throttle_day) {
438 Logger::notice('Daily posting limit reached', ['uid' => $uid, 'posts' => $posts_day, 'limit' => $throttle_day]);
439 $error = DI::l10n()->t('Too Many Requests');
440 $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);
441 $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
442 System::jsonError(429, $errorobj->toArray());
446 $throttle_week = DI::config()->get('system', 'throttle_limit_week');
447 if ($throttle_week > 0) {
448 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*7);
450 $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", Item::GRAVITY_PARENT, $uid, $datefrom];
451 $posts_week = Post::countThread($condition);
453 if ($posts_week > $throttle_week) {
454 Logger::notice('Weekly posting limit reached', ['uid' => $uid, 'posts' => $posts_week, 'limit' => $throttle_week]);
455 $error = DI::l10n()->t('Too Many Requests');
456 $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);
457 $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
458 System::jsonError(429, $errorobj->toArray());
462 $throttle_month = DI::config()->get('system', 'throttle_limit_month');
463 if ($throttle_month > 0) {
464 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*30);
466 $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", Item::GRAVITY_PARENT, $uid, $datefrom];
467 $posts_month = Post::countThread($condition);
469 if ($posts_month > $throttle_month) {
470 Logger::notice('Monthly posting limit reached', ['uid' => $uid, 'posts' => $posts_month, 'limit' => $throttle_month]);
471 $error = DI::l10n()->t('Too Many Requests');
472 $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);
473 $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
474 System::jsonError(429, $errorobj->toArray());
479 public static function getContactIDForSearchterm(string $screen_name = null, string $profileurl = null, int $cid = null, int $uid)
485 if (!empty($profileurl)) {
486 return Contact::getIdForURL($profileurl);
489 if (empty($cid) && !empty($screen_name)) {
490 if (strpos($screen_name, '@') !== false) {
491 return Contact::getIdForURL($screen_name, 0, false);
494 $user = User::getByNickname($screen_name, ['uid']);
495 if (!empty($user['uid'])) {
496 return Contact::getPublicIdByUserId($user['uid']);
501 return Contact::getPublicIdByUserId($uid);