]> git.mxchange.org Git - friendica.git/blob - src/Module/Api/Mastodon/Timelines/Tag.php
Harmonized API parameters for all timeline endpoints
[friendica.git] / src / Module / Api / Mastodon / Timelines / Tag.php
1 <?php
2 /**
3  * @copyright Copyright (C) 2010-2021, 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\Protocol;
25 use Friendica\Core\System;
26 use Friendica\Database\DBA;
27 use Friendica\DI;
28 use Friendica\Model\Post;
29 use Friendica\Module\BaseApi;
30 use Friendica\Network\HTTPException;
31
32 /**
33  * @see https://docs.joinmastodon.org/methods/timelines/
34  */
35 class Tag extends BaseApi
36 {
37         /**
38          * @param array $parameters
39          * @throws HTTPException\InternalServerErrorException
40          */
41         public static function rawContent(array $parameters = [])
42         {
43                 self::login(self::SCOPE_READ);
44                 $uid = self::getCurrentUserID();
45
46                 if (empty($parameters['hashtag'])) {
47                         DI::mstdnError()->UnprocessableEntity();
48                 }
49
50                 $request = self::getRequest([
51                         'local'           => false, // If true, return only local statuses. Defaults to false.
52                         'remote'          => false, // Show only remote statuses? Defaults to false.
53                         'only_media'      => false, // If true, return only statuses with media attachments. Defaults to false.
54                         'max_id'          => 0,     // Return results older than this ID.
55                         'since_id'        => 0,     // Return results newer than this ID.
56                         'min_id'          => 0,     // Return results immediately newer than this ID.
57                         'limit'           => 20,    // Maximum number of results to return. Defaults to 20.
58                         'with_muted'      => false, // Pleroma extension: return activities by muted (not by blocked!) users.
59                         'exclude_replies' => false, // Don't show comments
60                 ]);
61
62                 $params = ['order' => ['uri-id' => true], 'limit' => $request['limit']];
63
64                 $condition = ["`name` = ? AND (`uid` = ? OR (`uid` = ? AND NOT `global`))
65                         AND (`network` IN (?, ?, ?, ?) OR (`uid` = ? AND `uid` != ?))",
66                         $parameters['hashtag'], 0, $uid, Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::DIASPORA, Protocol::OSTATUS, $uid, 0];
67
68                 if ($request['local']) {
69                         $condition = DBA::mergeConditions($condition, ["`uri-id` IN (SELECT `uri-id` FROM `post-user` WHERE `origin`)"]);
70                 }
71
72                 if ($request['remote']) {
73                         $condition = DBA::mergeConditions($condition, ["NOT `uri-id` IN (SELECT `uri-id` FROM `post-user` WHERE `origin`)"]);
74                 }
75
76                 if ($request['only_media']) {
77                         $condition = DBA::mergeConditions($condition, ["`uri-id` IN (SELECT `uri-id` FROM `post-media` WHERE `type` IN (?, ?, ?))",
78                                 Post\Media::AUDIO, Post\Media::IMAGE, Post\Media::VIDEO]);
79                 }
80
81                 if ($request['exclude_replies']) {
82                         $condition = DBA::mergeConditions($condition, ['gravity' => GRAVITY_PARENT]);
83                 }
84
85                 if (!empty($request['max_id'])) {
86                         $condition = DBA::mergeConditions($condition, ["`uri-id` < ?", $request['max_id']]);
87                 }
88
89                 if (!empty($request['since_id'])) {
90                         $condition = DBA::mergeConditions($condition, ["`uri-id` > ?", $request['since_id']]);
91                 }
92
93                 if (!empty($request['min_id'])) {
94                         $condition = DBA::mergeConditions($condition, ["`uri-id` > ?", $request['min_id']]);
95
96                         $params['order'] = ['uri-id'];
97                 }
98
99                 $items = DBA::select('tag-search-view', ['uri-id'], $condition, $params);
100
101                 $statuses = [];
102                 while ($item = Post::fetch($items)) {
103                         $statuses[] = DI::mstdnStatus()->createFromUriId($item['uri-id'], $uid);
104                 }
105                 DBA::close($items);
106
107                 if (!empty($request['min_id'])) {
108                         array_reverse($statuses);
109                 }
110
111                 System::jsonExit($statuses);
112         }
113 }