diff --git a/doc/API-Mastodon.md b/doc/API-Mastodon.md index e94d3c04ed..a734bd5445 100644 --- a/doc/API-Mastodon.md +++ b/doc/API-Mastodon.md @@ -51,6 +51,9 @@ These endpoints use the [Mastodon API entities](https://docs.joinmastodon.org/en - [`GET /api/v1/apps/verify_credentials`](https://docs.joinmastodon.org/methods/apps/) - [`GET /api/v1/blocks`](https://docs.joinmastodon.org/methods/accounts/blocks/) - [`GET /api/v1/bookmarks`](https://docs.joinmastodon.org/methods/accounts/bookmarks/) +- [`GET /api/v1/conversations`](https://docs.joinmastodon.org/methods/timelines/conversations/) +- [`DELETE /api/v1/conversations/:id`](https://docs.joinmastodon.org/methods/timelines/conversations/) +- [`POST /api/v1/conversations/:id/read`](https://docs.joinmastodon.org/methods/timelines/conversations/) - [`GET /api/v1/custom_emojis`](https://docs.joinmastodon.org/methods/instance/custom_emojis/) - Doesn't return unicode emojis since they aren't using an image URL @@ -105,6 +108,7 @@ These endpoints use the [Mastodon API entities](https://docs.joinmastodon.org/en - [`POST /api/v1/statuses/:id/pin`](https://docs.joinmastodon.org/methods/statuses/) - [`POST /api/v1/statuses/:id/unpin`](https://docs.joinmastodon.org/methods/statuses/) - [`GET /api/v1/suggestions`](https://docs.joinmastodon.org/methods/accounts/suggestions/) +- [`GET /api/v1/timelines/direct`](https://docs.joinmastodon.org/methods/timelines/) - [`GET /api/v1/timelines/home`](https://docs.joinmastodon.org/methods/timelines/) - [`GET /api/v1/timelines/list/:id`](https://docs.joinmastodon.org/methods/timelines/) - [`GET /api/v1/timelines/public`](https://docs.joinmastodon.org/methods/timelines/) @@ -118,11 +122,7 @@ These endpoints use the [Mastodon API entities](https://docs.joinmastodon.org/en These emdpoints are planned to be implemented - [`PATCH /api/v1/accounts/update_credentials`](https://docs.joinmastodon.org/methods/accounts/) -- [`GET /api/v1/conversations`](https://docs.joinmastodon.org/methods/timelines/conversations/) -- [`DELETE /api/v1/conversations/:id`](https://docs.joinmastodon.org/methods/timelines/conversations/) -- [`POST /api/v1/conversations/:id/read`](https://docs.joinmastodon.org/methods/timelines/conversations/) - [`GET /api/v1/instance/activity`](https://docs.joinmastodon.org/methods/instance#weekly-activity) -- [`GET /api/v1/timelines/direct`](https://docs.joinmastodon.org/methods/timelines/) ## Non supportable endpoints diff --git a/src/DI.php b/src/DI.php index 9e77943bda..944fad805d 100644 --- a/src/DI.php +++ b/src/DI.php @@ -263,6 +263,14 @@ abstract class DI return self::$dice->create(Factory\Api\Mastodon\Card::class); } + /** + * @return Factory\Api\Mastodon\Conversation + */ + public static function mstdnConversation() + { + return self::$dice->create(Factory\Api\Mastodon\Conversation::class); + } + /** * @return Factory\Api\Mastodon\Emoji */ diff --git a/src/Factory/Api/Mastodon/Conversation.php b/src/Factory/Api/Mastodon/Conversation.php new file mode 100644 index 0000000000..d867dd0b2a --- /dev/null +++ b/src/Factory/Api/Mastodon/Conversation.php @@ -0,0 +1,61 @@ +. + * + */ + +namespace Friendica\Factory\Api\Mastodon; + +use Friendica\BaseFactory; +use Friendica\Database\DBA; +use Friendica\DI; +use Friendica\Model\Contact; + +class Conversation extends BaseFactory +{ + public function CreateFromConvId(int $id) + { + $accounts = []; + $unread = false; + $last_status = null; + + $ids = []; + + $mails = DBA::select('mail', ['id', 'from-url', 'uid', 'seen'], ['convid' => $id], ['order' => ['id' => true]]); + while ($mail = DBA::fetch($mails)) { + if (!$mail['seen']) { + $unread = true; + } + + $id = Contact::getIdForURL($mail['from-url'], 0, false); + if (in_array($id, $ids)) { + continue; + } + + $ids[] = $id; + + if (empty($last_status)) { + $last_status = DI::mstdnStatus()->createFromMailId($mail['id']); + } + + $accounts[] = DI::mstdnAccount()->createFromContactId($id, 0); + } + + return new \Friendica\Object\Api\Mastodon\Conversation($id, $accounts, $unread, $last_status); + } +} diff --git a/src/Factory/Api/Mastodon/Status.php b/src/Factory/Api/Mastodon/Status.php index cc8b7e6d87..3f16b3c380 100644 --- a/src/Factory/Api/Mastodon/Status.php +++ b/src/Factory/Api/Mastodon/Status.php @@ -31,6 +31,7 @@ use Friendica\Model\Post; use Friendica\Model\Verb; use Friendica\Network\HTTPException; use Friendica\Protocol\Activity; +use Friendica\Protocol\ActivityPub; use Friendica\Repository\ProfileField; use Psr\Log\LoggerInterface; @@ -119,4 +120,34 @@ class Status extends BaseFactory return new \Friendica\Object\Api\Mastodon\Status($item, $account, $counts, $userAttributes, $sensitive, $application, $mentions, $tags, $card, $attachments, $reshare); } + + /** + * @param int $uriId id of the mail + * @return \Friendica\Object\Api\Mastodon\Status + * @throws HTTPException\InternalServerErrorException + * @throws \ImagickException + */ + public function createFromMailId(int $id) + { + $item = ActivityPub\Transmitter::ItemArrayFromMail($id, true); + if (empty($item)) { + DI::mstdnError()->RecordNotFound(); + } + + $account = DI::mstdnAccount()->createFromContactId($item['author-id']); + + $counts = new \Friendica\Object\Api\Mastodon\Status\Counts(0, 0, 0); + + $userAttributes = new \Friendica\Object\Api\Mastodon\Status\UserAttributes(false, false, false, false, false); + + $sensitive = false; + $application = new \Friendica\Object\Api\Mastodon\Application(''); + $mentions = []; + $tags = []; + $card = new \Friendica\Object\Api\Mastodon\Card([]); + $attachments = []; + $reshare = []; + + return new \Friendica\Object\Api\Mastodon\Status($item, $account, $counts, $userAttributes, $sensitive, $application, $mentions, $tags, $card, $attachments, $reshare); + } } diff --git a/src/Module/Api/Mastodon/Conversation.php b/src/Module/Api/Mastodon/Conversation.php new file mode 100644 index 0000000000..e87818ac27 --- /dev/null +++ b/src/Module/Api/Mastodon/Conversation.php @@ -0,0 +1,99 @@ +. + * + */ + +namespace Friendica\Module\Api\Mastodon; + +use Friendica\Core\System; +use Friendica\Database\DBA; +use Friendica\DI; +use Friendica\Module\BaseApi; + +/** + * @see https://docs.joinmastodon.org/methods/timelines/conversations/ + */ +class Conversation extends BaseApi +{ + public static function delete(array $parameters = []) + { + self::login(self::SCOPE_WRITE); + $uid = self::getCurrentUserID(); + + if (!empty($parameters['id'])) { + DI::mstdnError()->UnprocessableEntity(); + } + + DBA::delete('conv', ['id' => $parameters['id'], 'uid' => $uid]); + DBA::delete('mail', ['convid' => $parameters['id'], 'uid' => $uid]); + + System::jsonExit([]); + } + + /** + * @param array $parameters + * @throws \Friendica\Network\HTTPException\InternalServerErrorException + */ + public static function rawContent(array $parameters = []) + { + self::login(self::SCOPE_READ); + $uid = self::getCurrentUserID(); + + $request = self::getRequest([ + 'limit' => 20, // Maximum number of results. Defaults to 20. Max 40. + 'max_id' => 0, // Return results older than this ID. Use HTTP Link header to paginate. + 'since_id' => 0, // Return results newer than this ID. Use HTTP Link header to paginate. + 'min_id' => 0, // Return results immediately newer than this ID. Use HTTP Link header to paginate. + ]); + + $params = ['order' => ['id' => true], 'limit' => $request['limit']]; + + $condition = ['uid' => $uid]; + + if (!empty($request['max_id'])) { + $condition = DBA::mergeConditions($condition, ["`id` < ?", $request['max_id']]); + } + + if (!empty($request['since_id'])) { + $condition = DBA::mergeConditions($condition, ["`id` > ?", $request['since_id']]); + } + + if (!empty($request['min_id'])) { + $condition = DBA::mergeConditions($condition, ["`id` > ?", $request['min_id']]); + + $params['order'] = ['id']; + } + + $convs = DBA::select('conv', ['id'], $condition, $params); + + $conversations = []; + + while ($conv = DBA::fetch($convs)) { + $conversations[] = DI::mstdnConversation()->CreateFromConvId($conv['id']); + } + + DBA::close($convs); + + if (!empty($request['min_id'])) { + array_reverse($conversations); + } + + System::jsonExit($conversations); + } +} diff --git a/src/Module/Api/Mastodon/Conversations/Read.php b/src/Module/Api/Mastodon/Conversations/Read.php new file mode 100644 index 0000000000..d1c349eaac --- /dev/null +++ b/src/Module/Api/Mastodon/Conversations/Read.php @@ -0,0 +1,47 @@ +. + * + */ + +namespace Friendica\Module\Api\Mastodon\Conversation; + +use Friendica\Core\System; +use Friendica\Database\DBA; +use Friendica\DI; +use Friendica\Module\BaseApi; + +/** + * @see https://docs.joinmastodon.org/methods/timelines/conversations/ + */ +class Read extends BaseApi +{ + public static function post(array $parameters = []) + { + self::login(self::SCOPE_WRITE); + $uid = self::getCurrentUserID(); + + if (!empty($parameters['id'])) { + DI::mstdnError()->UnprocessableEntity(); + } + + DBA::update('mail', ['seen' => true], ['convid' => $parameters['id'], 'uid' => $uid]); + + System::jsonExit(DI::mstdnConversation()->CreateFromConvId($parameters['id'])->toArray()); + } +} diff --git a/src/Module/Api/Mastodon/Timelines/Direct.php b/src/Module/Api/Mastodon/Timelines/Direct.php new file mode 100644 index 0000000000..104f88d1c2 --- /dev/null +++ b/src/Module/Api/Mastodon/Timelines/Direct.php @@ -0,0 +1,83 @@ +. + * + */ + +namespace Friendica\Module\Api\Mastodon\Timelines; + +use Friendica\Core\System; +use Friendica\Database\DBA; +use Friendica\DI; +use Friendica\Module\BaseApi; +use Friendica\Network\HTTPException; + +/** + * @see https://docs.joinmastodon.org/methods/timelines/ + */ +class Direct extends BaseApi +{ + /** + * @param array $parameters + * @throws HTTPException\InternalServerErrorException + */ + public static function rawContent(array $parameters = []) + { + self::login(self::SCOPE_READ); + $uid = self::getCurrentUserID(); + + $request = self::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 + 'limit' => 20, // Maximum number of results to return. Defaults to 20. + ]); + + $params = ['order' => ['id' => true], 'limit' => $request['limit']]; + + $condition = ['uid' => $uid]; + + if (!empty($request['max_id'])) { + $condition = DBA::mergeConditions($condition, ["`id` < ?", $request['max_id']]); + } + + if (!empty($request['since_id'])) { + $condition = DBA::mergeConditions($condition, ["`id` > ?", $request['since_id']]); + } + + if (!empty($request['min_id'])) { + $condition = DBA::mergeConditions($condition, ["`id` > ?", $request['min_id']]); + + $params['order'] = ['id']; + } + + $mails = DBA::select('mail', ['id'], $condition, $params); + + $statuses = []; + + while ($mail = DBA::fetch($mails)) { + $statuses[] = DI::mstdnStatus()->createFromMailId($mail['id']); + } + + if (!empty($request['min_id'])) { + array_reverse($statuses); + } + + System::jsonExit($statuses); + } +} diff --git a/src/Object/Api/Mastodon/Conversation.php b/src/Object/Api/Mastodon/Conversation.php new file mode 100644 index 0000000000..0b0136044f --- /dev/null +++ b/src/Object/Api/Mastodon/Conversation.php @@ -0,0 +1,54 @@ +. + * + */ + +namespace Friendica\Object\Api\Mastodon; + +use Friendica\BaseDataTransferObject; + +/** + * Class Conversation + * + * @see https://docs.joinmastodon.org/entities/conversation/ + */ +class Conversation extends BaseDataTransferObject +{ + //Required attributes + /** @var string */ + protected $id; + /** @var array */ + protected $accounts; + /** @var bool */ + protected $unread; + + // Optional attributes + /** + * @var Status + */ + protected $last_status = true; + + public function __construct(string $id, array $accounts, bool $unread, \Friendica\Object\Api\Mastodon\Status $last_status) + { + $this->id = $id; + $this->accounts = $accounts; + $this->unread = $unread; + $this->last_status = $last_status; + } +} diff --git a/src/Protocol/ActivityPub/Transmitter.php b/src/Protocol/ActivityPub/Transmitter.php index 9773a5a48b..20c1e49b88 100644 --- a/src/Protocol/ActivityPub/Transmitter.php +++ b/src/Protocol/ActivityPub/Transmitter.php @@ -861,7 +861,7 @@ class Transmitter * @return array * @throws \Exception */ - public static function ItemArrayFromMail($mail_id) + public static function ItemArrayFromMail($mail_id, $use_title = false) { $mail = DBA::selectFirst('mail', [], ['id' => $mail_id]); if (!DBA::isResult($mail)) { @@ -870,29 +870,37 @@ class Transmitter $mail['uri-id'] = ItemURI::insert(['uri' => $mail['uri'], 'guid' => $mail['guid']]); - $reply = DBA::selectFirst('mail', ['uri'], ['parent-uri' => $mail['parent-uri'], 'reply' => false]); + $reply = DBA::selectFirst('mail', ['uri', 'from-url', 'guid'], ['parent-uri' => $mail['parent-uri'], 'reply' => false]); // Making the post more compatible for Mastodon by: // - Making it a note and not an article (no title) // - Moving the title into the "summary" field that is used as a "content warning" - $mail['body'] = '[abstract]' . $mail['title'] . "[/abstract]\n" . $mail['body']; - $mail['title'] = ''; - $mail['author-link'] = $mail['owner-link'] = $mail['from-url']; - $mail['allow_cid'] = '<'.$mail['contact-id'].'>'; - $mail['allow_gid'] = ''; - $mail['deny_cid'] = ''; - $mail['deny_gid'] = ''; - $mail['private'] = true; - $mail['deleted'] = false; - $mail['edited'] = $mail['created']; - $mail['plink'] = $mail['uri']; - $mail['thr-parent'] = $reply['uri']; - $mail['gravity'] = ($mail['reply'] ? GRAVITY_COMMENT: GRAVITY_PARENT); + if ($use_title) { + $mail['body'] = $mail['body']; + $mail['title'] = $mail['title']; + } else { + $mail['body'] = '[abstract]' . $mail['title'] . "[/abstract]\n" . $mail['body']; + $mail['title'] = ''; + } - $mail['event-type'] = ''; - - $mail['parent'] = 0; + $mail['author-link'] = $mail['owner-link'] = $mail['from-url']; + $mail['author-id'] = Contact::getIdForURL($mail['author-link'], 0, false); + $mail['allow_cid'] = '<'.$mail['contact-id'].'>'; + $mail['allow_gid'] = ''; + $mail['deny_cid'] = ''; + $mail['deny_gid'] = ''; + $mail['private'] = Item::PRIVATE; + $mail['deleted'] = false; + $mail['edited'] = $mail['created']; + $mail['plink'] = $mail['uri']; + $mail['thr-parent'] = $reply['uri']; + $mail['thr-parent-id'] = ItemURI::insert(['uri' => $reply['uri'], 'guid' => $reply['guid']]); + $mail['parent-author-id'] = Contact::getIdForURL($reply['from-url'], 0, false); + $mail['gravity'] = ($mail['reply'] ? GRAVITY_COMMENT: GRAVITY_PARENT); + $mail['event-type'] = ''; + $mail['language'] = ''; + $mail['parent'] = 0; return $mail; } diff --git a/static/routes.config.php b/static/routes.config.php index a753b893d2..80b1aadeb8 100644 --- a/static/routes.config.php +++ b/static/routes.config.php @@ -90,9 +90,9 @@ return [ '/apps/verify_credentials' => [Module\Api\Mastodon\Apps\VerifyCredentials::class, [R::GET ]], '/blocks' => [Module\Api\Mastodon\Blocks::class, [R::GET ]], '/bookmarks' => [Module\Api\Mastodon\Bookmarks::class, [R::GET ]], - '/conversations' => [Module\Api\Mastodon\Unimplemented::class, [R::GET ]], // @todo - '/conversations/{id:\d+}' => [Module\Api\Mastodon\Unimplemented::class, [R::DELETE ]], // @todo - '/conversations/{id:\d+}/read' => [Module\Api\Mastodon\Unimplemented::class, [R::POST ]], // @todo + '/conversations' => [Module\Api\Mastodon\Conversation::class, [R::GET ]], + '/conversations/{id:\d+}' => [Module\Api\Mastodon\Conversation::class, [R::DELETE ]], + '/conversations/{id:\d+}/read' => [Module\Api\Mastodon\Conversation\Read::class, [R::POST ]], '/custom_emojis' => [Module\Api\Mastodon\CustomEmojis::class, [R::GET ]], '/domain_blocks' => [Module\Api\Mastodon\Unimplemented::class, [R::GET, R::POST, R::DELETE]], // not supported '/directory' => [Module\Api\Mastodon\Directory::class, [R::GET ]], @@ -142,7 +142,7 @@ return [ '/statuses/{id:\d+}/unpin' => [Module\Api\Mastodon\Statuses\Unpin::class, [ R::POST]], '/suggestions' => [Module\Api\Mastodon\Suggestions::class, [R::GET ]], '/suggestions/{id:\d+}' => [Module\Api\Mastodon\Unimplemented::class, [R::DELETE ]], // not implemented - '/timelines/direct' => [Module\Api\Mastodon\Unimplemented::class, [R::GET ]], // @todo + '/timelines/direct' => [Module\Api\Mastodon\Timelines\Direct::class, [R::GET ]], '/timelines/home' => [Module\Api\Mastodon\Timelines\Home::class, [R::GET ]], '/timelines/list/{id:\d+}' => [Module\Api\Mastodon\Timelines\ListTimeline::class, [R::GET ]], '/timelines/public' => [Module\Api\Mastodon\Timelines\PublicTimeline::class, [R::GET ]],