Merge pull request #12850 from nupplaphil/feat/phpstorm_editorconfig

[friendica.git] / src / Module / BaseApi.php

diff --git a/src/Module/BaseApi.php b/src/Module/BaseApi.php
index 47557928a97c368eb564a397d0bf4417e8d97766..f8524b524ee48c694f2532515aab0cdfe06e3e71 100644 (file)
--- a/src/Module/BaseApi.php
+++ b/src/Module/BaseApi.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * @copyright Copyright (C) 2010-2022, the Friendica project
+ * @copyright Copyright (C) 2010-2023, the Friendica project
  *
  * @license GNU AGPL version 3 or any later version
  *
@@ -33,6 +33,7 @@ use Friendica\Model\Item;
 use Friendica\Model\Post;
 use Friendica\Model\User;
 use Friendica\Module\Api\ApiResponse;
+use Friendica\Module\Special\HTTPException as ModuleHTTPException;
 use Friendica\Network\HTTPException;
 use Friendica\Security\BasicAuth;
 use Friendica\Security\OAuth;
@@ -80,7 +81,7 @@ class BaseApi extends BaseModule
         *
         * @throws HTTPException\ForbiddenException
         */
-       public function run(array $request = [], bool $scopecheck = true): ResponseInterface
+       public function run(ModuleHTTPException $httpException, array $request = [], bool $scopecheck = true): ResponseInterface
        {
                if ($scopecheck) {
                        switch ($this->args->getMethod()) {
@@ -89,15 +90,15 @@ class BaseApi extends BaseModule
                                case Router::POST:
                                case Router::PUT:
                                        self::checkAllowedScope(self::SCOPE_WRITE);
-       
+
                                        if (!self::getCurrentUserID()) {
                                                throw new HTTPException\ForbiddenException($this->t('Permission denied.'));
                                        }
                                        break;
-                       }       
+                       }
                }
 
-               return parent::run($request);
+               return parent::run($httpException, $request);
        }
 
        /**
@@ -139,13 +140,13 @@ class BaseApi extends BaseModule
        }
 
        /**
-        * Set the "link" header with "next" and "prev" links
-        * @return void
+        * Get the "link" header with "next" and "prev" links
+        * @return string
         */
-       protected static function setLinkHeader()
+       protected static function getLinkHeader(): string
        {
                if (empty(self::$boundaries)) {
-                       return;
+                       return '';
                }
 
                $request = self::$request;
@@ -164,7 +165,70 @@ class BaseApi extends BaseModule
                $prev = $command . '?' . http_build_query($prev_request);
                $next = $command . '?' . http_build_query($next_request);
 
-               header('Link: <' . $next . '>; rel="next", <' . $prev . '>; rel="prev"');
+               return 'Link: <' . $next . '>; rel="next", <' . $prev . '>; rel="prev"';
+       }
+
+       /**
+        * Get the "link" header with "next" and "prev" links for an offset/limit type call
+        * @return string
+        */
+       protected static function getOffsetAndLimitLinkHeader(int $offset, int $limit): string
+       {
+               $request = self::$request;
+
+               unset($request['offset']);
+               $request['limit'] = $limit;
+
+               $prev_request = $next_request = $request;
+
+               $prev_request['offset'] = $offset - $limit;
+               $next_request['offset'] = $offset + $limit;
+
+               $command = DI::baseUrl() . '/' . DI::args()->getCommand();
+
+               $prev = $command . '?' . http_build_query($prev_request);
+               $next = $command . '?' . http_build_query($next_request);
+
+               if ($prev_request['offset'] >= 0) {
+                       return 'Link: <' . $next . '>; rel="next", <' . $prev . '>; rel="prev"';
+               } else {
+                       return 'Link: <' . $next . '>; rel="next"';
+               }
+       }
+
+       /**
+        * Set the "link" header with "next" and "prev" links
+        * @return void
+        */
+       protected static function setLinkHeader()
+       {
+               $header = self::getLinkHeader();
+               if (!empty($header)) {
+                       header($header);
+               }
+       }
+
+       /**
+        * Set the "link" header with "next" and "prev" links
+        * @return void
+        */
+       protected static function setLinkHeaderByOffsetLimit(int $offset, int $limit)
+       {
+               $header = self::getOffsetAndLimitLinkHeader($offset, $limit);
+               if (!empty($header)) {
+                       header($header);
+               }
+       }
+
+       /**
+        * Check if the app is known to support quoted posts
+        *
+        * @return bool
+        */
+       public static function appSupportsQuotes(): bool
+       {
+               $token = self::getCurrentApplication();
+               return (!empty($token['name']) && in_array($token['name'], ['Fedilab']));
        }
 
        /**