Friendica/friendica-github
1
0
Fork 0
mirror of https://github.com/friendica/friendica synced 2025-04-19 09:50:11 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge remote-tracking branch 'upstream/develop' into api-edit

Browse source
This commit is contained in:
Michael 2023-03-01 05:17:13 +00:00
commit fc8421b57b
9 changed files with 318 additions and 85 deletions
Download patch file Download diff file Expand all files Collapse all files

39
src/Module/Api/Mastodon/Timelines/Home.php
View file

@ -29,6 +29,7 @@ use Friendica\Model\Item;
use Friendica\Model\Post;
use Friendica\Module\BaseApi;
use Friendica\Network\HTTPException;
use Friendica\Object\Api\Mastodon\TimelineOrderByTypes;
/**
* @see https://docs.joinmastodon.org/methods/timelines/
@ -44,39 +45,27 @@ class Home extends BaseApi
$uid = self::getCurrentUserID();
$request = $this->getRequest([
'max_id' => 0, // Return results older than id
'since_id' => 0, // Return results newer than id
'min_id' => 0, // Return results immediately newer than id
'max_id' => null, // Return results older than id
'since_id' => null, // Return results newer than id
'min_id' => null, // Return results immediately newer than id
'limit' => 20, // Maximum number of results to return. Defaults to 20.
'local' => false, // Return only local statuses?
'with_muted' => false, // Pleroma extension: return activities by muted (not by blocked!) users.
'only_media' => false, // Show only statuses with media attached? Defaults to false.
'remote' => false, // Show only remote statuses? Defaults to false.
'exclude_replies' => false, // Don't show comments
'friendica_order' => TimelineOrderByTypes::ID, // Sort order options (defaults to ID)
], $request);
$params = ['order' => ['uri-id' => true], 'limit' => $request['limit']];
$condition = ['gravity' => [Item::GRAVITY_PARENT, Item::GRAVITY_COMMENT], 'uid' => $uid];
$condition = $this->addPagingConditions($request, $condition);
$params = $this->buildOrderAndLimitParams($request);
if ($request['local']) {
$condition = DBA::mergeConditions($condition, ["`uri-id` IN (SELECT `uri-id` FROM `post-user` WHERE `origin`)"]);
}
if (!empty($request['max_id'])) {
$condition = DBA::mergeConditions($condition, ["`uri-id` < ?", $request['max_id']]);
}
if (!empty($request['since_id'])) {
$condition = DBA::mergeConditions($condition, ["`uri-id` > ?", $request['since_id']]);
}
if (!empty($request['min_id'])) {
$condition = DBA::mergeConditions($condition, ["`uri-id` > ?", $request['min_id']]);
$params['order'] = ['uri-id'];
}
if ($request['only_media']) {
$condition = DBA::mergeConditions($condition, ["`uri-id` IN (SELECT `uri-id` FROM `post-media` WHERE `type` IN (?, ?, ?))",
Post\Media::AUDIO, Post\Media::IMAGE, Post\Media::VIDEO]);
@ -96,11 +85,12 @@ class Home extends BaseApi
$statuses = [];
while ($item = Post::fetch($items)) {
self::setBoundaries($item['uri-id']);
try {
$statuses[] = DI::mstdnStatus()->createFromUriId($item['uri-id'], $uid, $display_quotes);
} catch (\Exception $exception) {
Logger::info('Post not fetchable', ['uri-id' => $item['uri-id'], 'uid' => $uid, 'exception' => $exception]);
$status = DI::mstdnStatus()->createFromUriId($item['uri-id'], $uid, $display_quotes);
$this->updateBoundaries($status, $item, $request['friendica_order']);
$statuses[] = $status;
} catch (\Throwable $th) {
Logger::info('Post not fetchable', ['uri-id' => $item['uri-id'], 'uid' => $uid, 'error' => $th]);
}
}
DBA::close($items);
@ -109,7 +99,8 @@ class Home extends BaseApi
$statuses = array_reverse($statuses);
}
self::setLinkHeader();
self::setLinkHeader($request['friendica_order'] != TimelineOrderByTypes::ID);
System::jsonExit($statuses);
}
}

34
src/Module/Api/Mastodon/Timelines/ListTimeline.php
View file

@ -29,6 +29,7 @@ use Friendica\Model\Item;
use Friendica\Model\Post;
use Friendica\Module\BaseApi;
use Friendica\Network\HTTPException;
use Friendica\Object\Api\Mastodon\TimelineOrderByTypes;
/**
* @see https://docs.joinmastodon.org/methods/timelines/
@ -48,35 +49,23 @@ class ListTimeline extends BaseApi
}
$request = $this->getRequest([
'max_id' => 0, // Return results older than id
'since_id' => 0, // Return results newer than id
'min_id' => 0, // Return results immediately newer than id
'max_id' => null, // Return results older than id
'since_id' => null, // Return results newer than id
'min_id' => null, // Return results immediately newer than id
'limit' => 20, // Maximum number of results to return. Defaults to 20.Return results older than this ID.
'with_muted' => false, // Pleroma extension: return activities by muted (not by blocked!) users.
'only_media' => false, // Show only statuses with media attached? Defaults to false.
'local' => false, // Show only local statuses? Defaults to false.
'remote' => false, // Show only remote statuses? Defaults to false.
'exclude_replies' => false, // Don't show comments
'friendica_order' => TimelineOrderByTypes::ID, // Sort order options (defaults to ID)
], $request);
$params = ['order' => ['uri-id' => true], 'limit' => $request['limit']];
$condition = ["`uid` = ? AND `gravity` IN (?, ?) AND `contact-id` IN (SELECT `contact-id` FROM `group_member` WHERE `gid` = ?)",
$uid, Item::GRAVITY_PARENT, Item::GRAVITY_COMMENT, $this->parameters['id']];
if (!empty($request['max_id'])) {
$condition = DBA::mergeConditions($condition, ["`uri-id` < ?", $request['max_id']]);
}
if (!empty($request['since_id'])) {
$condition = DBA::mergeConditions($condition, ["`uri-id` > ?", $request['since_id']]);
}
if (!empty($request['min_id'])) {
$condition = DBA::mergeConditions($condition, ["`uri-id` > ?", $request['min_id']]);
$params['order'] = ['uri-id'];
}
$condition = $this->addPagingConditions($request, $condition);
$params = $this->buildOrderAndLimitParams($request);
if ($request['only_media']) {
$condition = DBA::mergeConditions($condition, ["`uri-id` IN (SELECT `uri-id` FROM `post-media` WHERE `type` IN (?, ?, ?))",
@ -101,11 +90,12 @@ class ListTimeline extends BaseApi
$statuses = [];
while ($item = Post::fetch($items)) {
self::setBoundaries($item['uri-id']);
try {
$statuses[] = DI::mstdnStatus()->createFromUriId($item['uri-id'], $uid, $display_quotes);
} catch (\Exception $exception) {
Logger::info('Post not fetchable', ['uri-id' => $item['uri-id'], 'uid' => $uid, 'exception' => $exception]);
$status = DI::mstdnStatus()->createFromUriId($item['uri-id'], $uid, $display_quotes);
$this->updateBoundaries($status, $item, $request['friendica_order']);
$statuses[] = $status;
} catch (\Throwable $th) {
Logger::info('Post not fetchable', ['uri-id' => $item['uri-id'], 'uid' => $uid, 'error' => $th]);
}
}
DBA::close($items);

38
src/Module/Api/Mastodon/Timelines/PublicTimeline.php
View file

@ -30,6 +30,7 @@ use Friendica\Model\Item;
use Friendica\Model\Post;
use Friendica\Module\BaseApi;
use Friendica\Network\HTTPException;
use Friendica\Object\Api\Mastodon\TimelineOrderByTypes;
/**
* @see https://docs.joinmastodon.org/methods/timelines/
@ -44,22 +45,24 @@ class PublicTimeline extends BaseApi
$uid = self::getCurrentUserID();
$request = $this->getRequest([
'max_id' => null, // Return results older than id
'since_id' => null, // Return results newer than id
'min_id' => null, // Return results immediately newer than id
'limit' => 20, // Maximum number of results to return. Defaults to 20.
'local' => false, // Show only local statuses? Defaults to false.
'remote' => false, // Show only remote statuses? Defaults to false.
'only_media' => false, // Show only statuses with media attached? Defaults to false.
'max_id' => 0, // Return results older than this id
'since_id' => 0, // Return results newer than this id
'min_id' => 0, // Return results immediately newer than this id
'limit' => 20, // Maximum number of results to return. Defaults to 20.
'with_muted' => false, // Pleroma extension: return activities by muted (not by blocked!) users.
'exclude_replies' => false, // Don't show comments
'friendica_order' => TimelineOrderByTypes::ID, // Sort order options (defaults to ID)
], $request);
$params = ['order' => ['uri-id' => true], 'limit' => $request['limit']];
$condition = ['gravity' => [Item::GRAVITY_PARENT, Item::GRAVITY_COMMENT], 'private' => Item::PUBLIC,
'network' => Protocol::FEDERATED, 'author-blocked' => false, 'author-hidden' => false];
$condition = $this->addPagingConditions($request, $condition);
$params = $this->buildOrderAndLimitParams($request);
if ($request['local']) {
$condition = DBA::mergeConditions($condition, ["`uri-id` IN (SELECT `uri-id` FROM `post-user` WHERE `origin`)"]);
}
@ -73,19 +76,6 @@ class PublicTimeline extends BaseApi
Post\Media::AUDIO, Post\Media::IMAGE, Post\Media::VIDEO]);
}
if (!empty($request['max_id'])) {
$condition = DBA::mergeConditions($condition, ["`uri-id` < ?", $request['max_id']]);
}
if (!empty($request['since_id'])) {
$condition = DBA::mergeConditions($condition, ["`uri-id` > ?", $request['since_id']]);
}
if (!empty($request['min_id'])) {
$condition = DBA::mergeConditions($condition, ["`uri-id` > ?", $request['min_id']]);
$params['order'] = ['uri-id'];
}
if ($request['exclude_replies']) {
$condition = DBA::mergeConditions($condition, ['gravity' => Item::GRAVITY_PARENT]);
}
@ -96,13 +86,15 @@ class PublicTimeline extends BaseApi
$statuses = [];
while ($item = Post::fetch($items)) {
self::setBoundaries($item['uri-id']);
try {
$statuses[] = DI::mstdnStatus()->createFromUriId($item['uri-id'], $uid, $display_quotes);
} catch (\Exception $exception) {
Logger::info('Post not fetchable', ['uri-id' => $item['uri-id'], 'uid' => $uid, 'exception' => $exception]);
$status = DI::mstdnStatus()->createFromUriId($item['uri-id'], $uid, $display_quotes);
$this->updateBoundaries($status, $item, $request['friendica_order']);
$statuses[] = $status;
} catch (\Throwable $th) {
Logger::info('Post not fetchable', ['uri-id' => $item['uri-id'], 'uid' => $uid, 'error' => $th]);
}
}
DBA::close($items);
if (!empty($request['min_id'])) {

2
src/Module/Api/Mastodon/Timelines/Tag.php
View file

@ -107,7 +107,7 @@ class Tag extends BaseApi
if (!empty($uid)) {
$condition = DBA::mergeConditions(
$condition,
["NOT `parent-author-id` IN (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND (`blocked` OR `ignored`) AND `cid` = `parent-author-id`)", $uid]
["NOT `author-id` IN (SELECT `cid` FROM `user-contact` WHERE `uid` = ? AND (`blocked` OR `ignored`) AND `cid` = `author-id`)", $uid]
);
}

159
src/Module/BaseApi.php
View file

@ -21,12 +21,14 @@
namespace Friendica\Module;
use DateTime;
use Friendica\App;
use Friendica\App\Router;
use Friendica\BaseModule;
use Friendica\Core\L10n;
use Friendica\Core\Logger;
use Friendica\Core\System;
use Friendica\Database\DBA;
use Friendica\DI;
use Friendica\Model\Contact;
use Friendica\Model\Item;
@ -35,6 +37,8 @@ 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;
use Friendica\Util\DateTimeFormat;
@ -101,6 +105,140 @@ class BaseApi extends BaseModule
return parent::run($httpException, $request);
}
/**
* Processes data from GET requests and sets paging conditions
*
* @param array $request Custom REQUEST array
* @param array $condition Existing conditions to merge
* @return array paging data condition parameters data
* @throws \Exception
*/
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` < ?", intval($request['max_id'])]);
}
if (!empty($request['since_id'])) {
$condition = DBA::mergeConditions($condition, ["`uri-id` > ?", intval($request['since_id'])]);
}
if (!empty($request['min_id'])) {
$condition = DBA::mergeConditions($condition, ["`uri-id` > ?", intval($request['min_id'])]);
}
} else {
switch ($requested_order) {
case TimelineOrderByTypes::RECEIVED:
case TimelineOrderByTypes::CHANGED:
case TimelineOrderByTypes::EDITED:
case TimelineOrderByTypes::CREATED:
case TimelineOrderByTypes::COMMENTED:
$order_field = $requested_order;
break;
default:
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)]);
}
}
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
*
@ -123,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;
@ -143,7 +281,7 @@ class BaseApi extends BaseModule
* Get the "link" header with "next" and "prev" links
* @return string
*/
protected static function getLinkHeader(): string
protected static function getLinkHeader(bool $asDate = false): string
{
if (empty(self::$boundaries)) {
return '';
@ -157,8 +295,15 @@ class BaseApi extends BaseModule
$prev_request = $next_request = $request;
$prev_request['min_id'] = self::$boundaries['max'];
$next_request['max_id'] = self::$boundaries['min'];
if ($asDate) {
$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'];
}
$command = DI::baseUrl() . '/' . DI::args()->getCommand();
@ -200,9 +345,9 @@ class BaseApi extends BaseModule
* Set the "link" header with "next" and "prev" links
* @return void
*/
protected static function setLinkHeader()
protected static function setLinkHeader(bool $asDate = false)
{
$header = self::getLinkHeader();
$header = self::getLinkHeader($asDate);
if (!empty($header)) {
header($header);
}