]> git.mxchange.org Git - friendica.git/commitdiff
API: Support for private mails
authorMichael <heluecht@pirati.ca>
Wed, 19 May 2021 21:56:50 +0000 (21:56 +0000)
committerMichael <heluecht@pirati.ca>
Wed, 19 May 2021 21:56:50 +0000 (21:56 +0000)
doc/API-Mastodon.md
src/DI.php
src/Factory/Api/Mastodon/Conversation.php [new file with mode: 0644]
src/Factory/Api/Mastodon/Status.php
src/Module/Api/Mastodon/Conversation.php [new file with mode: 0644]
src/Module/Api/Mastodon/Conversations/Read.php [new file with mode: 0644]
src/Object/Api/Mastodon/Conversation.php [new file with mode: 0644]
static/routes.config.php

index e94d3c04ed1ca1e90ba4ededae9f4a06fced5aab..5cb4535547823de9664323184cf8d0c6ced11880 100644 (file)
@@ -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
 
@@ -118,9 +121,6 @@ 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/)
 
index 9e77943bda8403f707f4bb2216a321a78053af3b..944fad805d18d8413d6e9a9e12837c646dbc456a 100644 (file)
@@ -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 (file)
index 0000000..f30ccf4
--- /dev/null
@@ -0,0 +1,60 @@
+<?php
+/**
+ * @copyright Copyright (C) 2010-2021, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
+
+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'], $mail['uid']);
+                       }
+
+                       $accounts[] = DI::mstdnAccount()->createFromContactId($id, $mail['uid']);
+               }
+
+               return new \Friendica\Object\Api\Mastodon\Conversation($id, $accounts, $unread, $last_status);
+       }
+}
index cc8b7e6d87d6ee8bcbc3f56ca8ef6729244338c0..f64dde29bba2735ec8f61001963ceba3737cff60 100644 (file)
@@ -27,6 +27,7 @@ use Friendica\Content\ContactSelector;
 use Friendica\Content\Text\BBCode;
 use Friendica\Database\DBA;
 use Friendica\DI;
+use Friendica\Model\Item;
 use Friendica\Model\Post;
 use Friendica\Model\Verb;
 use Friendica\Network\HTTPException;
@@ -119,4 +120,53 @@ 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
+        * @param int $uid   mail user
+        * @return \Friendica\Object\Api\Mastodon\Status
+        * @throws HTTPException\InternalServerErrorException
+        * @throws \ImagickException
+        */
+       public function createFromMailId(int $id, $uid = 0)
+       {
+               $mail = DBA::selectFirst('mail', [], ['id' => $id, 'uid' => $uid]);
+               if (!$mail) {
+                       DI::mstdnError()->RecordNotFound();
+               }
+
+               $conv = DBA::selectFirst('conv', ['subject'], ['id' => $mail['convid'], 'uid' => $uid]);
+               if (!$conv) {
+                       DI::mstdnError()->RecordNotFound();
+               }
+
+               $account = DI::mstdnAccount()->createFromContactId($mail['contact-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     = [];
+
+               $item = [
+                       'uri-id' => $mail['id'],
+                       'created' => $mail['created'],
+                       'thr-parent-id' => 0,
+                       'parent-author-id' => 0,
+                       'title' => $conv['subject'],
+                       'private' => Item::PRIVATE,
+                       'language' => '',
+                       'uri' => $mail['uri'],
+                       'plink' => '',
+                       'body' => BBCode::convert($mail['body'], false, BBCode::API)
+               ];
+
+               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 (file)
index 0000000..feeb52e
--- /dev/null
@@ -0,0 +1,76 @@
+<?php
+/**
+ * @copyright Copyright (C) 2010-2021, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
+
+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']];
+
+               $convs = DBA::select('conv', ['id'], ['uid' => $uid], $params);
+               $conversations = [];
+
+               foreach ($convs as $conv) {
+                       $conversations[] = DI::mstdnConversation()->CreateFromConvId($conv['id']);
+               }
+
+               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 (file)
index 0000000..346e78a
--- /dev/null
@@ -0,0 +1,47 @@
+<?php
+/**
+ * @copyright Copyright (C) 2010-2021, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
+
+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/Object/Api/Mastodon/Conversation.php b/src/Object/Api/Mastodon/Conversation.php
new file mode 100644 (file)
index 0000000..911b4ad
--- /dev/null
@@ -0,0 +1,54 @@
+<?php
+/**
+ * @copyright Copyright (C) 2010-2021, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
+
+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;
+       }
+}
index a753b893d2c562a690f7c15059c3d4d606d980a7..6b87d55bce917d0e735b301350de319c389d0775 100644 (file)
@@ -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         ]],