]> git.mxchange.org Git - friendica.git/blob - src/Module/Api/Mastodon/Timelines/Home.php
Add comment to friendica_order query parameter in Mastodon Timeline Home
[friendica.git] / src / Module / Api / Mastodon / Timelines / Home.php
1 <?php
2 /**
3  * @copyright Copyright (C) 2010-2023, the Friendica project
4  *
5  * @license GNU AGPL version 3 or any later version
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU Affero General Public License as
9  * published by the Free Software Foundation, either version 3 of the
10  * License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU Affero General Public License for more details.
16  *
17  * You should have received a copy of the GNU Affero General Public License
18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
19  *
20  */
21
22 namespace Friendica\Module\Api\Mastodon\Timelines;
23
24 use Friendica\Core\Logger;
25 use Friendica\Core\System;
26 use Friendica\Database\DBA;
27 use Friendica\DI;
28 use Friendica\Model\Item;
29 use Friendica\Model\Post;
30 use Friendica\Module\BaseApi;
31 use Friendica\Network\HTTPException;
32 use Friendica\Object\Api\Mastodon\TimelineOrderByTypes;
33
34 /**
35  * @see https://docs.joinmastodon.org/methods/timelines/
36  */
37 class Home extends BaseApi
38 {
39         /**
40          * @throws HTTPException\InternalServerErrorException
41          */
42         protected function rawContent(array $request = [])
43         {
44                 self::checkAllowedScope(self::SCOPE_READ);
45                 $uid = self::getCurrentUserID();
46
47                 $request = $this->getRequest([
48                         'max_id'          => null,  // Return results older than id
49                         'since_id'        => null,  // Return results newer than id
50                         'min_id'          => null,  // Return results immediately newer than id
51                         'limit'           => 20,    // Maximum number of results to return. Defaults to 20.
52                         'local'           => false, // Return only local statuses?
53                         'with_muted'      => false, // Pleroma extension: return activities by muted (not by blocked!) users.
54                         'only_media'      => false, // Show only statuses with media attached? Defaults to false.
55                         'remote'          => false, // Show only remote statuses? Defaults to false.
56                         'exclude_replies' => false, // Don't show comments
57                         'friendica_order' => TimelineOrderByTypes::ID, // Sort order options (defaults to ID)
58                 ], $request);
59
60                 $condition = ['gravity' => [Item::GRAVITY_PARENT, Item::GRAVITY_COMMENT], 'uid' => $uid];
61
62                 $condition = $this->addPagingConditions($request, $condition);
63                 $params = $this->buildOrderAndLimitParams($request);
64
65                 if ($request['local']) {
66                         $condition = DBA::mergeConditions($condition, ["`uri-id` IN (SELECT `uri-id` FROM `post-user` WHERE `origin`)"]);
67                 }
68
69                 if ($request['only_media']) {
70                         $condition = DBA::mergeConditions($condition, ["`uri-id` IN (SELECT `uri-id` FROM `post-media` WHERE `type` IN (?, ?, ?))",
71                                 Post\Media::AUDIO, Post\Media::IMAGE, Post\Media::VIDEO]);
72                 }
73
74                 if ($request['remote']) {
75                         $condition = DBA::mergeConditions($condition, ["NOT `uri-id` IN (SELECT `uri-id` FROM `post-user` WHERE `origin` AND `post-user`.`uri-id` = `post-user-view`.`uri-id`)"]);
76                 }
77
78                 if ($request['exclude_replies']) {
79                         $condition = DBA::mergeConditions($condition, ['gravity' => Item::GRAVITY_PARENT]);
80                 }
81
82                 $items = Post::selectForUser($uid, ['uri-id'], $condition, $params);
83
84                 $display_quotes = self::appSupportsQuotes();
85
86                 $statuses = [];
87                 while ($item = Post::fetch($items)) {
88                         try {
89                                 $status =  DI::mstdnStatus()->createFromUriId($item['uri-id'], $uid, $display_quotes);
90                                 $this->updateBoundaries($status, $item, $request['friendica_order']);
91                                 $statuses[] = $status;
92                         } catch (\Throwable $th) {
93                                 Logger::info('Post not fetchable', ['uri-id' => $item['uri-id'], 'uid' => $uid, 'error' => $th]);
94                         }
95                 }
96                 DBA::close($items);
97
98                 if (!empty($request['min_id'])) {
99                         $statuses = array_reverse($statuses);
100                 }
101
102
103                 self::setLinkHeader($request['friendica_order'] != TimelineOrderByTypes::ID);
104                 System::jsonExit($statuses);
105         }
106 }