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\TimelineOrderByTypes;
  41 use Friendica\Security\BasicAuth;
  42 use Friendica\Security\OAuth;
  43 use Friendica\Util\DateTimeFormat;
  44 use Friendica\Util\Profiler;
  45 use Psr\Http\Message\ResponseInterface;
  46 use Psr\Log\LoggerInterface;
  47
  48 class BaseApi extends BaseModule
  49 {
  50         const LOG_PREFIX = 'API {action} - ';
  51
  52         const SCOPE_READ   = 'read';
  53         const SCOPE_WRITE  = 'write';
  54         const SCOPE_FOLLOW = 'follow';
  55         const SCOPE_PUSH   = 'push';
  56
  57         /**
  58          * @var array
  59          */
  60         protected static $boundaries = [];
  61
  62         /**
  63          * @var array
  64          */
  65         protected static $request = [];
  66
  67         /** @var App */
  68         protected $app;
  69
  70         /** @var ApiResponse */
  71         protected $response;
  72
  73         public function __construct(App $app, L10n $l10n, App\BaseURL $baseUrl, App\Arguments $args, LoggerInterface $logger, Profiler $profiler, ApiResponse $response, array $server, array $parameters = [])
  74         {
  75                 parent::__construct($l10n, $baseUrl, $args, $logger, $profiler, $response, $server, $parameters);
  76
  77                 $this->app = $app;
  78         }
  79
  80         /**
  81          * Additionally checks, if the caller is permitted to do this action
  82          *
  83          * {@inheritDoc}
  84          *
  85          * @throws HTTPException\ForbiddenException
  86          */
  87         public function run(ModuleHTTPException $httpException, array $request = [], bool $scopecheck = true): ResponseInterface
  88         {
  89                 if ($scopecheck) {
  90                         switch ($this->args->getMethod()) {
  91                                 case Router::DELETE:
  92                                 case Router::PATCH:
  93                                 case Router::POST:
  94                                 case Router::PUT:
  95                                         self::checkAllowedScope(self::SCOPE_WRITE);
  96
  97                                         if (!self::getCurrentUserID()) {
  98                                                 throw new HTTPException\ForbiddenException($this->t('Permission denied.'));
  99                                         }
 100                                         break;
 101                         }
 102                 }
 103
 104                 return parent::run($httpException, $request);
 105         }
 106
 107         /**
 108          * Processes data from GET requests and sets defaults
 109          *
 110          * @param array      $defaults Associative array of expected request keys and their default typed value. A null
 111          *                             value will remove the request key from the resulting value array.
 112          * @param array $request       Custom REQUEST array, superglobal instead
 113          * @return array request data
 114          * @throws \Exception
 115          */
 116         public 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::CREATED:
 134                                         $order_field = 'created';
 135                                         break;
 136                                 default:
 137                                         $order_field = 'uri-id';
 138                         }
 139                         if (!empty($request['max_id'])) {
 140                                 $condition = DBA::mergeConditions($condition, ["`$order_field` < ?", DateTimeFormat::convert($request['max_id'], DateTimeFormat::MYSQL)]);
 141                         }
 142
 143
 144                         if (!empty($request['min_id'])) {
 145                                 $condition = DBA::mergeConditions($condition, ["`$order_field` > ?", DateTimeFormat::convert($request['min_id'], DateTimeFormat::MYSQL)]);
 146
 147                                 $params['order'] = [$order_field];
 148                         }
 149                 }
 150
 151                 return $condition;
 152         }
 153
 154         /**
 155          * Processes data from GET requests and sets defaults
 156          *
 157          * @param array      $defaults Associative array of expected request keys and their default typed value. A null
 158          *                             value will remove the request key from the resulting value array.
 159          * @param array $request       Custom REQUEST array, superglobal instead
 160          * @return array request data
 161          * @throws \Exception
 162          */
 163         public function getRequest(array $defaults, array $request): array
 164         {
 165                 self::$request    = $request;
 166                 self::$boundaries = [];
 167
 168                 unset(self::$request['pagename']);
 169
 170                 return $this->checkDefaults($defaults, $request);
 171         }
 172
 173         /**
 174          * Set boundaries for the "link" header
 175          * @param array $boundaries
 176          * @param int $id
 177          */
 178         protected static function setBoundaries(int $id)
 179         {
 180                 if (!isset(self::$boundaries['min'])) {
 181                         self::$boundaries['min'] = $id;
 182                 }
 183
 184                 if (!isset(self::$boundaries['max'])) {
 185                         self::$boundaries['max'] = $id;
 186                 }
 187
 188                 self::$boundaries['min'] = min(self::$boundaries['min'], $id);
 189                 self::$boundaries['max'] = max(self::$boundaries['max'], $id);
 190         }
 191
 192         /**
 193          * Get the "link" header with "next" and "prev" links
 194          * @return string
 195          */
 196         protected static function getLinkHeader(bool $asDate): string
 197         {
 198                 if (empty(self::$boundaries)) {
 199                         return '';
 200                 }
 201
 202                 $request = self::$request;
 203
 204                 unset($request['min_id']);
 205                 unset($request['max_id']);
 206                 unset($request['since_id']);
 207
 208                 $prev_request = $next_request = $request;
 209
 210                 if ($asDate) {
 211                         $max_date = new DateTime();
 212                         $max_date->setTimestamp(self::$boundaries['max']);
 213                         $min_date = new DateTime();
 214                         $min_date->setTimestamp(self::$boundaries['min']);
 215                         $prev_request['min_id'] = $max_date->format(DateTimeFormat::JSON);
 216                         $next_request['max_id'] = $min_date->format(DateTimeFormat::JSON);
 217                 } else {
 218                         $prev_request['min_id'] = self::$boundaries['max'];
 219                         $next_request['max_id'] = self::$boundaries['min'];
 220                 }
 221
 222                 $command = DI::baseUrl() . '/' . DI::args()->getCommand();
 223
 224                 $prev = $command . '?' . http_build_query($prev_request);
 225                 $next = $command . '?' . http_build_query($next_request);
 226
 227                 return 'Link: <' . $next . '>; rel="next", <' . $prev . '>; rel="prev"';
 228         }
 229
 230         /**
 231          * Get the "link" header with "next" and "prev" links for an offset/limit type call
 232          * @return string
 233          */
 234         protected static function getOffsetAndLimitLinkHeader(int $offset, int $limit): string
 235         {
 236                 $request = self::$request;
 237
 238                 unset($request['offset']);
 239                 $request['limit'] = $limit;
 240
 241                 $prev_request = $next_request = $request;
 242
 243                 $prev_request['offset'] = $offset - $limit;
 244                 $next_request['offset'] = $offset + $limit;
 245
 246                 $command = DI::baseUrl() . '/' . DI::args()->getCommand();
 247
 248                 $prev = $command . '?' . http_build_query($prev_request);
 249                 $next = $command . '?' . http_build_query($next_request);
 250
 251                 if ($prev_request['offset'] >= 0) {
 252                         return 'Link: <' . $next . '>; rel="next", <' . $prev . '>; rel="prev"';
 253                 } else {
 254                         return 'Link: <' . $next . '>; rel="next"';
 255                 }
 256         }
 257
 258         /**
 259          * Set the "link" header with "next" and "prev" links
 260          * @return void
 261          */
 262         protected static function setLinkHeader(bool $asDate = false)
 263         {
 264                 $header = self::getLinkHeader($asDate);
 265                 if (!empty($header)) {
 266                         header($header);
 267                 }
 268         }
 269
 270         /**
 271          * Set the "link" header with "next" and "prev" links
 272          * @return void
 273          */
 274         protected static function setLinkHeaderByOffsetLimit(int $offset, int $limit)
 275         {
 276                 $header = self::getOffsetAndLimitLinkHeader($offset, $limit);
 277                 if (!empty($header)) {
 278                         header($header);
 279                 }
 280         }
 281
 282         /**
 283          * Check if the app is known to support quoted posts
 284          *
 285          * @return bool
 286          */
 287         public static function appSupportsQuotes(): bool
 288         {
 289                 $token = self::getCurrentApplication();
 290                 return (!empty($token['name']) && in_array($token['name'], ['Fedilab']));
 291         }
 292
 293         /**
 294          * Get current application token
 295          *
 296          * @return array token
 297          */
 298         public static function getCurrentApplication()
 299         {
 300                 $token = OAuth::getCurrentApplicationToken();
 301
 302                 if (empty($token)) {
 303                         $token = BasicAuth::getCurrentApplicationToken();
 304                 }
 305
 306                 return $token;
 307         }
 308
 309         /**
 310          * Get current user id, returns 0 if not logged in
 311          *
 312          * @return int User ID
 313          */
 314         public static function getCurrentUserID()
 315         {
 316                 $uid = OAuth::getCurrentUserID();
 317
 318                 if (empty($uid)) {
 319                         $uid = BasicAuth::getCurrentUserID(false);
 320                 }
 321
 322                 return (int)$uid;
 323         }
 324
 325         /**
 326          * Check if the provided scope does exist.
 327          * halts execution on missing scope or when not logged in.
 328          *
 329          * @param string $scope the requested scope (read, write, follow, push)
 330          */
 331         public static function checkAllowedScope(string $scope)
 332         {
 333                 $token = self::getCurrentApplication();
 334
 335                 if (empty($token)) {
 336                         Logger::notice('Empty application token');
 337                         DI::mstdnError()->Forbidden();
 338                 }
 339
 340                 if (!isset($token[$scope])) {
 341                         Logger::warning('The requested scope does not exist', ['scope' => $scope, 'application' => $token]);
 342                         DI::mstdnError()->Forbidden();
 343                 }
 344
 345                 if (empty($token[$scope])) {
 346                         Logger::warning('The requested scope is not allowed', ['scope' => $scope, 'application' => $token]);
 347                         DI::mstdnError()->Forbidden();
 348                 }
 349         }
 350
 351         public static function checkThrottleLimit()
 352         {
 353                 $uid = self::getCurrentUserID();
 354
 355                 // Check for throttling (maximum posts per day, week and month)
 356                 $throttle_day = DI::config()->get('system', 'throttle_limit_day');
 357                 if ($throttle_day > 0) {
 358                         $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60);
 359
 360                         $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", Item::GRAVITY_PARENT, $uid, $datefrom];
 361                         $posts_day = Post::countThread($condition);
 362
 363                         if ($posts_day > $throttle_day) {
 364                                 Logger::notice('Daily posting limit reached', ['uid' => $uid, 'posts' => $posts_day, 'limit' => $throttle_day]);
 365                                 $error = DI::l10n()->t('Too Many Requests');
 366                                 $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);
 367                                 $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
 368                                 System::jsonError(429, $errorobj->toArray());
 369                         }
 370                 }
 371
 372                 $throttle_week = DI::config()->get('system', 'throttle_limit_week');
 373                 if ($throttle_week > 0) {
 374                         $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*7);
 375
 376                         $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", Item::GRAVITY_PARENT, $uid, $datefrom];
 377                         $posts_week = Post::countThread($condition);
 378
 379                         if ($posts_week > $throttle_week) {
 380                                 Logger::notice('Weekly posting limit reached', ['uid' => $uid, 'posts' => $posts_week, 'limit' => $throttle_week]);
 381                                 $error = DI::l10n()->t('Too Many Requests');
 382                                 $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);
 383                                 $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
 384                                 System::jsonError(429, $errorobj->toArray());
 385                         }
 386                 }
 387
 388                 $throttle_month = DI::config()->get('system', 'throttle_limit_month');
 389                 if ($throttle_month > 0) {
 390                         $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*30);
 391
 392                         $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", Item::GRAVITY_PARENT, $uid, $datefrom];
 393                         $posts_month = Post::countThread($condition);
 394
 395                         if ($posts_month > $throttle_month) {
 396                                 Logger::notice('Monthly posting limit reached', ['uid' => $uid, 'posts' => $posts_month, 'limit' => $throttle_month]);
 397                                 $error = DI::l10n()->t('Too Many Requests');
 398                                 $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);
 399                                 $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
 400                                 System::jsonError(429, $errorobj->toArray());
 401                         }
 402                 }
 403         }
 404
 405         public static function getContactIDForSearchterm(string $screen_name = null, string $profileurl = null, int $cid = null, int $uid)
 406         {
 407                 if (!empty($cid)) {
 408                         return $cid;
 409                 }
 410
 411                 if (!empty($profileurl)) {
 412                         return Contact::getIdForURL($profileurl);
 413                 }
 414
 415                 if (empty($cid) && !empty($screen_name)) {
 416                         if (strpos($screen_name, '@') !== false) {
 417                                 return Contact::getIdForURL($screen_name, 0, false);
 418                         }
 419
 420                         $user = User::getByNickname($screen_name, ['uid']);
 421                         if (!empty($user['uid'])) {
 422                                 return Contact::getPublicIdByUserId($user['uid']);
 423                         }
 424                 }
 425
 426                 if ($uid != 0) {
 427                         return Contact::getPublicIdByUserId($uid);
 428                 }
 429
 430                 return null;
 431         }
 432 }