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::checkAllowedScope(self::SCOPE_READ);
  44                 $uid = self::getCurrentUserID();
  45
  46                 if (empty($parameters['hashtag'])) {
  47                         DI::mstdnError()->UnprocessableEntity();
  48                 }
  49
  50                 /**
  51                  * @todo Respect missing parameters
  52                  * @see https://github.com/tootsuite/mastodon/blob/main/app/controllers/api/v1/timelines/tag_controller.rb
  53                  *
  54                  * There seem to be the parameters "any", "all", and "none".
  55                  */
  56
  57                 $request = self::getRequest([
  58                         'local'           => false, // If true, return only local statuses. Defaults to false.
  59                         'remote'          => false, // Show only remote statuses? Defaults to false.
  60                         'only_media'      => false, // If true, return only statuses with media attachments. Defaults to false.
  61                         'max_id'          => 0,     // Return results older than this ID.
  62                         'since_id'        => 0,     // Return results newer than this ID.
  63                         'min_id'          => 0,     // Return results immediately newer than this ID.
  64                         'limit'           => 20,    // Maximum number of results to return. Defaults to 20.
  65                         'with_muted'      => false, // Pleroma extension: return activities by muted (not by blocked!) users.
  66                         'exclude_replies' => false, // Don't show comments
  67                 ]);
  68
  69                 $params = ['order' => ['uri-id' => true], 'limit' => $request['limit']];
  70
  71                 $condition = ["`name` = ? AND (`uid` = ? OR (`uid` = ? AND NOT `global`))
  72                         AND (`network` IN (?, ?, ?, ?) OR (`uid` = ? AND `uid` != ?))",
  73                         $parameters['hashtag'], 0, $uid, Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::DIASPORA, Protocol::OSTATUS, $uid, 0];
  74
  75                 if ($request['local']) {
  76                         $condition = DBA::mergeConditions($condition, ["`uri-id` IN (SELECT `uri-id` FROM `post-user` WHERE `origin`)"]);
  77                 }
  78
  79                 if ($request['remote']) {
  80                         $condition = DBA::mergeConditions($condition, ["NOT `uri-id` IN (SELECT `uri-id` FROM `post-user` WHERE `origin`)"]);
  81                 }
  82
  83                 if ($request['only_media']) {
  84                         $condition = DBA::mergeConditions($condition, ["`uri-id` IN (SELECT `uri-id` FROM `post-media` WHERE `type` IN (?, ?, ?))",
  85                                 Post\Media::AUDIO, Post\Media::IMAGE, Post\Media::VIDEO]);
  86                 }
  87
  88                 if ($request['exclude_replies']) {
  89                         $condition = DBA::mergeConditions($condition, ['gravity' => GRAVITY_PARENT]);
  90                 }
  91
  92                 if (!empty($request['max_id'])) {
  93                         $condition = DBA::mergeConditions($condition, ["`uri-id` < ?", $request['max_id']]);
  94                 }
  95
  96                 if (!empty($request['since_id'])) {
  97                         $condition = DBA::mergeConditions($condition, ["`uri-id` > ?", $request['since_id']]);
  98                 }
  99
 100                 if (!empty($request['min_id'])) {
 101                         $condition = DBA::mergeConditions($condition, ["`uri-id` > ?", $request['min_id']]);
 102
 103                         $params['order'] = ['uri-id'];
 104                 }
 105
 106                 $items = DBA::select('tag-search-view', ['uri-id'], $condition, $params);
 107
 108                 $statuses = [];
 109                 while ($item = Post::fetch($items)) {
 110                         $statuses[] = DI::mstdnStatus()->createFromUriId($item['uri-id'], $uid);
 111                 }
 112                 DBA::close($items);
 113
 114                 if (!empty($request['min_id'])) {
 115                         array_reverse($statuses);
 116                 }
 117
 118                 System::jsonExit($statuses);
 119         }
 120 }