make errormessages modular and better

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

diff --git a/src/Module/BaseApi.php b/src/Module/BaseApi.php
index 5f1156d7710e49d2bb9948b16396882aab0a4509..b5fc8c8499254b97e74f2ab670cc8a6b984be71a 100644 (file)
--- a/src/Module/BaseApi.php
+++ b/src/Module/BaseApi.php
@@ -37,6 +37,7 @@ use Friendica\Model\User;
 use Friendica\Module\Api\ApiResponse;
 use Friendica\Module\Special\HTTPException as ModuleHTTPException;
 use Friendica\Network\HTTPException;
+use Friendica\Object\Api\Mastodon\Status;
 use Friendica\Object\Api\Mastodon\TimelineOrderByTypes;
 use Friendica\Security\BasicAuth;
 use Friendica\Security\OAuth;
@@ -112,7 +113,7 @@ class BaseApi extends BaseModule
         * @return array paging data condition parameters data
         * @throws \Exception
         */
-       public function addPagingConditions(array $request, array $condition): array
+       protected function addPagingConditions(array $request, array $condition): array
        {
                $requested_order = $request['friendica_order'];
                if ($requested_order == TimelineOrderByTypes::ID) {
@@ -129,21 +130,27 @@ class BaseApi extends BaseModule
                        }
                } else {
                        switch ($requested_order) {
+                               case TimelineOrderByTypes::RECEIVED:
+                               case TimelineOrderByTypes::CHANGED:
+                               case TimelineOrderByTypes::EDITED:
                                case TimelineOrderByTypes::CREATED:
-                                       $order_field = 'created';
+                               case TimelineOrderByTypes::COMMENTED:
+                                       $order_field = $requested_order;
                                        break;
                                default:
-                                       $order_field = 'uri-id';
+                                       throw new \Exception("Unrecognized request order: $requested_order");
                        }
+
                        if (!empty($request['max_id'])) {
                                $condition = DBA::mergeConditions($condition, ["`$order_field` < ?", DateTimeFormat::convert($request['max_id'], DateTimeFormat::MYSQL)]);
                        }
 
+                       if (!empty($request['since_id'])) {
+                               $condition = DBA::mergeConditions($condition, ["`$order_field` > ?", DateTimeFormat::convert($request['since_id'], DateTimeFormat::MYSQL)]);
+                       }
 
                        if (!empty($request['min_id'])) {
                                $condition = DBA::mergeConditions($condition, ["`$order_field` > ?", DateTimeFormat::convert($request['min_id'], DateTimeFormat::MYSQL)]);
-
-                               $params['order'] = [$order_field];
                        }
                }
 
@@ -158,29 +165,80 @@ class BaseApi extends BaseModule
         * @return array ordering data added to the params blocks that was passed in
         * @throws \Exception
         */
-       public function buildOrderAndLimitParams(array $request, array $params = []): array
+       protected function buildOrderAndLimitParams(array $request, array $params = []): array
        {
                $requested_order = $request['friendica_order'];
                switch ($requested_order) {
+                       case TimelineOrderByTypes::CHANGED:
                        case TimelineOrderByTypes::CREATED:
-                               $order_field = 'created';
+                       case TimelineOrderByTypes::COMMENTED:
+                       case TimelineOrderByTypes::EDITED:
+                       case TimelineOrderByTypes::RECEIVED:
+                               $order_field = $requested_order;
                                break;
                        case TimelineOrderByTypes::ID:
                        default:
                                $order_field = 'uri-id';
                }
 
-               if(!empty($request['min_id'])) {
+               if (!empty($request['min_id'])) {
                        $params['order'] = [$order_field];
                } else {
                        $params['order'] = [$order_field => true];
                }
 
-               $params['limit']= $request['limit'];
+               $params['limit'] = $request['limit'];
 
                return $params;
        }
 
+       /**
+        * Update the ID/time boundaries for this result set. Used for building Link Headers
+        *
+        * @param Status $status
+        * @param array $post_item
+        * @param string $order
+        * @return void
+        * @throws \Exception
+        */
+       protected function updateBoundaries(Status $status, array $post_item, string $order)
+       {
+               try {
+                       switch ($order) {
+                               case TimelineOrderByTypes::CHANGED:
+                                       if (!empty($status->friendicaExtension()->changedAt())) {
+                                               self::setBoundaries(new DateTime(DateTimeFormat::utc($status->friendicaExtension()->changedAt(), DateTimeFormat::JSON)));
+                                       }
+                                       break;
+                               case TimelineOrderByTypes::CREATED:
+                                       if (!empty($status->createdAt())) {
+                                               self::setBoundaries(new DateTime(DateTimeFormat::utc($status->createdAt(), DateTimeFormat::JSON)));
+                                       }
+                                       break;
+                               case TimelineOrderByTypes::COMMENTED:
+                                       if (!empty($status->friendicaExtension()->commentedAt())) {
+                                               self::setBoundaries(new DateTime(DateTimeFormat::utc($status->friendicaExtension()->commentedAt(), DateTimeFormat::JSON)));
+                                       }
+                                       break;
+                               case TimelineOrderByTypes::EDITED:
+                                       if (!empty($status->editedAt())) {
+                                               self::setBoundaries(new DateTime(DateTimeFormat::utc($status->editedAt(), DateTimeFormat::JSON)));
+                                       }
+                                       break;
+                               case TimelineOrderByTypes::RECEIVED:
+                                       if (!empty($status->friendicaExtension()->receivedAt())) {
+                                               self::setBoundaries(new DateTime(DateTimeFormat::utc($status->friendicaExtension()->receivedAt(), DateTimeFormat::JSON)));
+                                       }
+                                       break;
+                               case TimelineOrderByTypes::ID:
+                               default:
+                                       self::setBoundaries($post_item['uri-id']);
+                       }
+               } catch (\Exception $e) {
+                       Logger::debug('Error processing page boundary calculation, skipping', ['error' => $e]);
+               }
+       }
+
        /**
         * Processes data from GET requests and sets defaults
         *
@@ -203,9 +261,9 @@ class BaseApi extends BaseModule
        /**
         * Set boundaries for the "link" header
         * @param array $boundaries
-        * @param int $id
+        * @param int|\DateTime $id
         */
-       protected static function setBoundaries(int $id)
+       protected static function setBoundaries($id)
        {
                if (!isset(self::$boundaries['min'])) {
                        self::$boundaries['min'] = $id;
@@ -223,7 +281,7 @@ class BaseApi extends BaseModule
         * Get the "link" header with "next" and "prev" links
         * @return string
         */
-       protected static function getLinkHeader(bool $asDate): string
+       protected static function getLinkHeader(bool $asDate = false): string
        {
                if (empty(self::$boundaries)) {
                        return '';
@@ -238,10 +296,8 @@ class BaseApi extends BaseModule
                $prev_request = $next_request = $request;
 
                if ($asDate) {
-                       $max_date = new DateTime();
-                       $max_date->setTimestamp(self::$boundaries['max']);
-                       $min_date = new DateTime();
-                       $min_date->setTimestamp(self::$boundaries['min']);
+                       $max_date = self::$boundaries['max'];
+                       $min_date = self::$boundaries['min'];
                        $prev_request['min_id'] = $max_date->format(DateTimeFormat::JSON);
                        $next_request['max_id'] = $min_date->format(DateTimeFormat::JSON);
                } else {