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;
}
/**
- * Processes data from GET requests and sets defaults
+ * Processes data from GET requests and sets paging conditions
*
- * @param array $defaults Associative array of expected request keys and their default typed value. A null
- * value will remove the request key from the resulting value array.
- * @param array $request Custom REQUEST array, superglobal instead
- * @return array request data
+ * @param array $request Custom REQUEST array
+ * @param array $condition Existing conditions to merge
+ * @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) {
if (!empty($request['max_id'])) {
- $condition = DBA::mergeConditions($condition, ["`uri-id` < ?", $request['max_id']]);
+ $condition = DBA::mergeConditions($condition, ["`uri-id` < ?", intval($request['max_id'])]);
}
if (!empty($request['since_id'])) {
- $condition = DBA::mergeConditions($condition, ["`uri-id` > ?", $request['since_id']]);
+ $condition = DBA::mergeConditions($condition, ["`uri-id` > ?", intval($request['since_id'])]);
}
if (!empty($request['min_id'])) {
- $condition = DBA::mergeConditions($condition, ["`uri-id` > ?", $request['min_id']]);
+ $condition = DBA::mergeConditions($condition, ["`uri-id` > ?", intval($request['min_id'])]);
}
} else {
switch ($requested_order) {
- case TimelineOrderByTypes::CREATED_AT:
- $order_field = 'created';
+ case TimelineOrderByTypes::RECEIVED:
+ case TimelineOrderByTypes::CHANGED:
+ case TimelineOrderByTypes::EDITED:
+ case TimelineOrderByTypes::CREATED:
+ case TimelineOrderByTypes::COMMENTED:
+ $order_field = $requested_order;
break;
default:
- $order_field = 'uri-id';
- }
- if (!empty($request['max_time'])) {
- $condition = DBA::mergeConditions($condition, ["`$order_field` < ?", DateTimeFormat::convert($request['max_time'], DateTimeFormat::MYSQL)]);
+ 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['min_time'])) {
- $condition = DBA::mergeConditions($condition, ["`$order_field` > ?", DateTimeFormat::convert($request['min_time'], DateTimeFormat::MYSQL)]);
+ if (!empty($request['since_id'])) {
+ $condition = DBA::mergeConditions($condition, ["`$order_field` > ?", DateTimeFormat::convert($request['since_id'], DateTimeFormat::MYSQL)]);
+ }
- $params['order'] = [$order_field];
+ if (!empty($request['min_id'])) {
+ $condition = DBA::mergeConditions($condition, ["`$order_field` > ?", DateTimeFormat::convert($request['min_id'], DateTimeFormat::MYSQL)]);
}
}
return $condition;
}
+ /**
+ * Processes data from GET requests and sets paging conditions
+ *
+ * @param array $request Custom REQUEST array
+ * @param array $params Existing $params element to build on
+ * @return array ordering data added to the params blocks that was passed in
+ * @throws \Exception
+ */
+ protected function buildOrderAndLimitParams(array $request, array $params = []): array
+ {
+ $requested_order = $request['friendica_order'];
+ switch ($requested_order) {
+ case TimelineOrderByTypes::CHANGED:
+ case TimelineOrderByTypes::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'])) {
+ $params['order'] = [$order_field];
+ } else {
+ $params['order'] = [$order_field => true];
+ }
+
+ $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
*
/**
* 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;
* 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 '';
unset($request['min_id']);
unset($request['max_id']);
unset($request['since_id']);
- unset($request['min_time']);
- unset($request['max_time']);
$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']);
- $prev_request['min_time'] = $max_date->format(DateTimeFormat::JSON);
- $next_request['max_time'] = $min_date->format(DateTimeFormat::JSON);
+ $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 {
$prev_request['min_id'] = self::$boundaries['max'];
$next_request['max_id'] = self::$boundaries['min'];
*/
public static function appSupportsQuotes(): bool
{
- $token = self::getCurrentApplication();
+ $token = OAuth::getCurrentApplicationToken();
return (!empty($token['name']) && in_array($token['name'], ['Fedilab']));
}