src/Module/BaseApi.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2023, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   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.
  11  *
  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.
  16  *
  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/>.
  19  *
  20  */
  21
  22 namespace Friendica\Module;
  23
  24 use DateTime;
  25 use Friendica\App;
  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;
  32 use Friendica\DI;
  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;
  48
  49 class BaseApi extends BaseModule
  50 {
  51         const LOG_PREFIX = 'API {action} - ';
  52
  53         const SCOPE_READ   = 'read';
  54         const SCOPE_WRITE  = 'write';
  55         const SCOPE_FOLLOW = 'follow';
  56         const SCOPE_PUSH   = 'push';
  57
  58         /**
  59          * @var array
  60          */
  61         protected static $boundaries = [];
  62
  63         /**
  64          * @var array
  65          */
  66         protected static $request = [];
  67
  68         /** @var App */
  69         protected $app;
  70
  71         /** @var ApiResponse */
  72         protected $response;
  73
  74         public function __construct(App $app, L10n $l10n, App\BaseURL $baseUrl, App\Arguments $args, LoggerInterface $logger, Profiler $profiler, ApiResponse $response, array $server, array $parameters = [])
  75         {
  76                 parent::__construct($l10n, $baseUrl, $args, $logger, $profiler, $response, $server, $parameters);
  77
  78                 $this->app = $app;
  79         }
  80
  81         /**
  82          * Additionally checks, if the caller is permitted to do this action
  83          *
  84          * {@inheritDoc}
  85          *
  86          * @throws HTTPException\ForbiddenException
  87          */
  88         public function run(ModuleHTTPException $httpException, array $request = [], bool $scopecheck = true): ResponseInterface
  89         {
  90                 if ($scopecheck) {
  91                         switch ($this->args->getMethod()) {
  92                                 case Router::DELETE:
  93                                 case Router::PATCH:
  94                                 case Router::POST:
  95                                 case Router::PUT:
  96                                         self::checkAllowedScope(self::SCOPE_WRITE);
  97
  98                                         if (!self::getCurrentUserID()) {
  99                                                 throw new HTTPException\ForbiddenException($this->t('Permission denied.'));
 100                                         }
 101                                         break;
 102                         }
 103                 }
 104
 105                 return parent::run($httpException, $request);
 106         }
 107
 108         /**
 109          * Processes data from GET requests and sets paging conditions
 110          *
 111          * @param array $request       Custom REQUEST array
 112          * @param array $condition     Existing conditions to merge
 113          * @return array paging data condition parameters data
 114          * @throws \Exception
 115          */
 116         protected function addPagingConditions(array $request, array $condition): array
 117         {
 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'])]);
 122                         }
 123
 124                         if (!empty($request['since_id'])) {
 125                                 $condition = DBA::mergeConditions($condition, ["`uri-id` > ?", intval($request['since_id'])]);
 126                         }
 127
 128                         if (!empty($request['min_id'])) {
 129                                 $condition = DBA::mergeConditions($condition, ["`uri-id` > ?", intval($request['min_id'])]);
 130                         }
 131                 } else {
 132                         switch ($requested_order) {
 133                                 case TimelineOrderByTypes::RECEIVED:
 134                                 case TimelineOrderByTypes::CHANGED:
 135                                 case TimelineOrderByTypes::EDITED:
 136                                 case TimelineOrderByTypes::CREATED:
 137                                 case TimelineOrderByTypes::COMMENTED:
 138                                         $order_field = $requested_order;
 139                                         break;
 140                                 default:
 141                                         throw new \Exception("Unrecognized request order: $requested_order");
 142                         }
 143
 144                         if (!empty($request['max_id'])) {
 145                                 $condition = DBA::mergeConditions($condition, ["`$order_field` < ?", DateTimeFormat::convert($request['max_id'], DateTimeFormat::MYSQL)]);
 146                         }
 147
 148                         if (!empty($request['since_id'])) {
 149                                 $condition = DBA::mergeConditions($condition, ["`$order_field` > ?", DateTimeFormat::convert($request['since_id'], DateTimeFormat::MYSQL)]);
 150                         }
 151
 152                         if (!empty($request['min_id'])) {
 153                                 $condition = DBA::mergeConditions($condition, ["`$order_field` > ?", DateTimeFormat::convert($request['min_id'], DateTimeFormat::MYSQL)]);
 154                         }
 155                 }
 156
 157                 return $condition;
 158         }
 159
 160         /**
 161          * Processes data from GET requests and sets paging conditions
 162          *
 163          * @param array $request  Custom REQUEST array
 164          * @param array $params   Existing $params element to build on
 165          * @return array ordering data added to the params blocks that was passed in
 166          * @throws \Exception
 167          */
 168         protected function buildOrderAndLimitParams(array $request, array $params = []): array
 169         {
 170                 $requested_order = $request['friendica_order'];
 171                 switch ($requested_order) {
 172                         case TimelineOrderByTypes::CHANGED:
 173                                 $order_field = 'changed';
 174                                 break;
 175                         case TimelineOrderByTypes::CREATED:
 176                                 $order_field = 'created';
 177                                 break;
 178                         case TimelineOrderByTypes::COMMENTED:
 179                                 $order_field = 'commented';
 180                                 break;
 181                         case TimelineOrderByTypes::EDITED:
 182                                 $order_field = 'edited';
 183                                 break;
 184                         case TimelineOrderByTypes::RECEIVED:
 185                                 $order_field = 'received';
 186                                 break;
 187                         case TimelineOrderByTypes::ID:
 188                         default:
 189                                 $order_field = 'uri-id';
 190                 }
 191
 192                 if (!empty($request['min_id'])) {
 193                         $params['order'] = [$order_field];
 194                 } else {
 195                         $params['order'] = [$order_field => true];
 196                 }
 197
 198                 $params['limit'] = $request['limit'];
 199
 200                 return $params;
 201         }
 202
 203         /**
 204          * Update the ID/time boundaries for this result set. Used for building Link Headers
 205          *
 206          * @param Status $status
 207          * @param array $post_item
 208          * @param string $order
 209          * @return void
 210          * @throws \Exception
 211          */
 212         protected function updateBoundaries(Status $status, array $post_item, string $order)
 213         {
 214                 try {
 215                         switch ($order) {
 216                                 case TimelineOrderByTypes::CHANGED:
 217                                         if (!empty($status->friendicaExtension()->changedAt())) {
 218                                                 self::setBoundaries(new DateTime(DateTimeFormat::utc($status->friendicaExtension()->changedAt(), DateTimeFormat::JSON)));
 219                                         }
 220                                         break;
 221                                 case TimelineOrderByTypes::CREATED:
 222                                         if (!empty($status->createdAt())) {
 223                                                 self::setBoundaries(new DateTime(DateTimeFormat::utc($status->createdAt(), DateTimeFormat::JSON)));
 224                                         }
 225                                         break;
 226                                 case TimelineOrderByTypes::COMMENTED:
 227                                         if (!empty($status->friendicaExtension()->commentedAt())) {
 228                                                 self::setBoundaries(new DateTime(DateTimeFormat::utc($status->friendicaExtension()->commentedAt(), DateTimeFormat::JSON)));
 229                                         }
 230                                         break;
 231                                 case TimelineOrderByTypes::EDITED:
 232                                         if (!empty($status->friendicaExtension()->editedAt())) {
 233                                                 self::setBoundaries(new DateTime(DateTimeFormat::utc($status->friendicaExtension()->editedAt(), DateTimeFormat::JSON)));
 234                                         }
 235                                         break;
 236                                 case TimelineOrderByTypes::RECEIVED:
 237                                         if (!empty($status->friendicaExtension()->receivedAt())) {
 238                                                 self::setBoundaries(new DateTime(DateTimeFormat::utc($status->friendicaExtension()->receivedAt(), DateTimeFormat::JSON)));
 239                                         }
 240                                         break;
 241                                 case TimelineOrderByTypes::ID:
 242                                 default:
 243                                         self::setBoundaries($post_item['uri-id']);
 244                         }
 245                 } catch (\Exception $e) {
 246                         Logger::debug('Error processing page boundary calculation, skipping', ['error' => $e]);
 247                 }
 248         }
 249
 250         /**
 251          * Processes data from GET requests and sets defaults
 252          *
 253          * @param array      $defaults Associative array of expected request keys and their default typed value. A null
 254          *                             value will remove the request key from the resulting value array.
 255          * @param array $request       Custom REQUEST array, superglobal instead
 256          * @return array request data
 257          * @throws \Exception
 258          */
 259         public function getRequest(array $defaults, array $request): array
 260         {
 261                 self::$request    = $request;
 262                 self::$boundaries = [];
 263
 264                 unset(self::$request['pagename']);
 265
 266                 return $this->checkDefaults($defaults, $request);
 267         }
 268
 269         /**
 270          * Set boundaries for the "link" header
 271          * @param array $boundaries
 272          * @param int|\DateTime $id
 273          */
 274         protected static function setBoundaries($id)
 275         {
 276                 if (!isset(self::$boundaries['min'])) {
 277                         self::$boundaries['min'] = $id;
 278                 }
 279
 280                 if (!isset(self::$boundaries['max'])) {
 281                         self::$boundaries['max'] = $id;
 282                 }
 283
 284                 self::$boundaries['min'] = min(self::$boundaries['min'], $id);
 285                 self::$boundaries['max'] = max(self::$boundaries['max'], $id);
 286         }
 287
 288         /**
 289          * Get the "link" header with "next" and "prev" links
 290          * @return string
 291          */
 292         protected static function getLinkHeader(bool $asDate = false): string
 293         {
 294                 if (empty(self::$boundaries)) {
 295                         return '';
 296                 }
 297
 298                 $request = self::$request;
 299
 300                 unset($request['min_id']);
 301                 unset($request['max_id']);
 302                 unset($request['since_id']);
 303
 304                 $prev_request = $next_request = $request;
 305
 306                 if ($asDate) {
 307                         $max_date = self::$boundaries['max'];
 308                         $min_date = self::$boundaries['min'];
 309                         $prev_request['min_id'] = $max_date->format(DateTimeFormat::JSON);
 310                         $next_request['max_id'] = $min_date->format(DateTimeFormat::JSON);
 311                 } else {
 312                         $prev_request['min_id'] = self::$boundaries['max'];
 313                         $next_request['max_id'] = self::$boundaries['min'];
 314                 }
 315
 316                 $command = DI::baseUrl() . '/' . DI::args()->getCommand();
 317
 318                 $prev = $command . '?' . http_build_query($prev_request);
 319                 $next = $command . '?' . http_build_query($next_request);
 320
 321                 return 'Link: <' . $next . '>; rel="next", <' . $prev . '>; rel="prev"';
 322         }
 323
 324         /**
 325          * Get the "link" header with "next" and "prev" links for an offset/limit type call
 326          * @return string
 327          */
 328         protected static function getOffsetAndLimitLinkHeader(int $offset, int $limit): string
 329         {
 330                 $request = self::$request;
 331
 332                 unset($request['offset']);
 333                 $request['limit'] = $limit;
 334
 335                 $prev_request = $next_request = $request;
 336
 337                 $prev_request['offset'] = $offset - $limit;
 338                 $next_request['offset'] = $offset + $limit;
 339
 340                 $command = DI::baseUrl() . '/' . DI::args()->getCommand();
 341
 342                 $prev = $command . '?' . http_build_query($prev_request);
 343                 $next = $command . '?' . http_build_query($next_request);
 344
 345                 if ($prev_request['offset'] >= 0) {
 346                         return 'Link: <' . $next . '>; rel="next", <' . $prev . '>; rel="prev"';
 347                 } else {
 348                         return 'Link: <' . $next . '>; rel="next"';
 349                 }
 350         }
 351
 352         /**
 353          * Set the "link" header with "next" and "prev" links
 354          * @return void
 355          */
 356         protected static function setLinkHeader(bool $asDate = false)
 357         {
 358                 $header = self::getLinkHeader($asDate);
 359                 if (!empty($header)) {
 360                         header($header);
 361                 }
 362         }
 363
 364         /**
 365          * Set the "link" header with "next" and "prev" links
 366          * @return void
 367          */
 368         protected static function setLinkHeaderByOffsetLimit(int $offset, int $limit)
 369         {
 370                 $header = self::getOffsetAndLimitLinkHeader($offset, $limit);
 371                 if (!empty($header)) {
 372                         header($header);
 373                 }
 374         }
 375
 376         /**
 377          * Check if the app is known to support quoted posts
 378          *
 379          * @return bool
 380          */
 381         public static function appSupportsQuotes(): bool
 382         {
 383                 $token = self::getCurrentApplication();
 384                 return (!empty($token['name']) && in_array($token['name'], ['Fedilab']));
 385         }
 386
 387         /**
 388          * Get current application token
 389          *
 390          * @return array token
 391          */
 392         public static function getCurrentApplication()
 393         {
 394                 $token = OAuth::getCurrentApplicationToken();
 395
 396                 if (empty($token)) {
 397                         $token = BasicAuth::getCurrentApplicationToken();
 398                 }
 399
 400                 return $token;
 401         }
 402
 403         /**
 404          * Get current user id, returns 0 if not logged in
 405          *
 406          * @return int User ID
 407          */
 408         public static function getCurrentUserID()
 409         {
 410                 $uid = OAuth::getCurrentUserID();
 411
 412                 if (empty($uid)) {
 413                         $uid = BasicAuth::getCurrentUserID(false);
 414                 }
 415
 416                 return (int)$uid;
 417         }
 418
 419         /**
 420          * Check if the provided scope does exist.
 421          * halts execution on missing scope or when not logged in.
 422          *
 423          * @param string $scope the requested scope (read, write, follow, push)
 424          */
 425         public static function checkAllowedScope(string $scope)
 426         {
 427                 $token = self::getCurrentApplication();
 428
 429                 if (empty($token)) {
 430                         Logger::notice('Empty application token');
 431                         DI::mstdnError()->Forbidden();
 432                 }
 433
 434                 if (!isset($token[$scope])) {
 435                         Logger::warning('The requested scope does not exist', ['scope' => $scope, 'application' => $token]);
 436                         DI::mstdnError()->Forbidden();
 437                 }
 438
 439                 if (empty($token[$scope])) {
 440                         Logger::warning('The requested scope is not allowed', ['scope' => $scope, 'application' => $token]);
 441                         DI::mstdnError()->Forbidden();
 442                 }
 443         }
 444
 445         public static function checkThrottleLimit()
 446         {
 447                 $uid = self::getCurrentUserID();
 448
 449                 // Check for throttling (maximum posts per day, week and month)
 450                 $throttle_day = DI::config()->get('system', 'throttle_limit_day');
 451                 if ($throttle_day > 0) {
 452                         $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60);
 453
 454                         $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", Item::GRAVITY_PARENT, $uid, $datefrom];
 455                         $posts_day = Post::countThread($condition);
 456
 457                         if ($posts_day > $throttle_day) {
 458                                 Logger::notice('Daily posting limit reached', ['uid' => $uid, 'posts' => $posts_day, 'limit' => $throttle_day]);
 459                                 $error = DI::l10n()->t('Too Many Requests');
 460                                 $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);
 461                                 $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
 462                                 System::jsonError(429, $errorobj->toArray());
 463                         }
 464                 }
 465
 466                 $throttle_week = DI::config()->get('system', 'throttle_limit_week');
 467                 if ($throttle_week > 0) {
 468                         $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*7);
 469
 470                         $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", Item::GRAVITY_PARENT, $uid, $datefrom];
 471                         $posts_week = Post::countThread($condition);
 472
 473                         if ($posts_week > $throttle_week) {
 474                                 Logger::notice('Weekly posting limit reached', ['uid' => $uid, 'posts' => $posts_week, 'limit' => $throttle_week]);
 475                                 $error = DI::l10n()->t('Too Many Requests');
 476                                 $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);
 477                                 $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
 478                                 System::jsonError(429, $errorobj->toArray());
 479                         }
 480                 }
 481
 482                 $throttle_month = DI::config()->get('system', 'throttle_limit_month');
 483                 if ($throttle_month > 0) {
 484                         $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*30);
 485
 486                         $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", Item::GRAVITY_PARENT, $uid, $datefrom];
 487                         $posts_month = Post::countThread($condition);
 488
 489                         if ($posts_month > $throttle_month) {
 490                                 Logger::notice('Monthly posting limit reached', ['uid' => $uid, 'posts' => $posts_month, 'limit' => $throttle_month]);
 491                                 $error = DI::l10n()->t('Too Many Requests');
 492                                 $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);
 493                                 $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
 494                                 System::jsonError(429, $errorobj->toArray());
 495                         }
 496                 }
 497         }
 498
 499         public static function getContactIDForSearchterm(string $screen_name = null, string $profileurl = null, int $cid = null, int $uid)
 500         {
 501                 if (!empty($cid)) {
 502                         return $cid;
 503                 }
 504
 505                 if (!empty($profileurl)) {
 506                         return Contact::getIdForURL($profileurl);
 507                 }
 508
 509                 if (empty($cid) && !empty($screen_name)) {
 510                         if (strpos($screen_name, '@') !== false) {
 511                                 return Contact::getIdForURL($screen_name, 0, false);
 512                         }
 513
 514                         $user = User::getByNickname($screen_name, ['uid']);
 515                         if (!empty($user['uid'])) {
 516                                 return Contact::getPublicIdByUserId($user['uid']);
 517                         }
 518                 }
 519
 520                 if ($uid != 0) {
 521                         return Contact::getPublicIdByUserId($uid);
 522                 }
 523
 524                 return null;
 525         }
 526 }