src/Module/Api/Twitter/Followers/Lists.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\Twitter\Followers;
  23
  24 use Friendica\Core\System;
  25 use Friendica\Database\DBA;
  26 use Friendica\Module\Api\Twitter\ContactEndpoint;
  27 use Friendica\Module\BaseApi;
  28
  29 /**
  30  * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-followers-list
  31  */
  32 class Lists extends ContactEndpoint
  33 {
  34         protected function rawContent(array $request = [])
  35         {
  36                 self::checkAllowedScope(self::SCOPE_READ);
  37                 $uid = BaseApi::getCurrentUserID();
  38
  39                 // Expected value for user_id parameter: public/user contact id
  40                 $contact_id            = filter_input(INPUT_GET, 'user_id'              , FILTER_VALIDATE_INT);
  41                 $screen_name           = filter_input(INPUT_GET, 'screen_name');
  42                 $profile_url           = filter_input(INPUT_GET, 'profile_url');
  43                 $cursor                = filter_input(INPUT_GET, 'cursor'               , FILTER_VALIDATE_INT, ['options' => ['default' => -1]]);
  44                 $skip_status           = filter_input(INPUT_GET, 'skip_status'          , FILTER_VALIDATE_BOOLEAN, ['options' => ['default' => false]]);
  45                 $include_user_entities = filter_input(INPUT_GET, 'include_user_entities', FILTER_VALIDATE_BOOLEAN, ['options' => ['default' => false]]);
  46                 $count                 = filter_input(INPUT_GET, 'count'                , FILTER_VALIDATE_INT, ['options' => [
  47                         'default' => self::DEFAULT_COUNT,
  48                         'min_range' => 1,
  49                         'max_range' => self::MAX_COUNT,
  50                 ]]);
  51                 // Friendica-specific
  52                 $since_id              = filter_input(INPUT_GET, 'since_id', FILTER_VALIDATE_INT);
  53                 $max_id                = filter_input(INPUT_GET, 'max_id'  , FILTER_VALIDATE_INT);
  54                 $min_id                = filter_input(INPUT_GET, 'min_id'  , FILTER_VALIDATE_INT);
  55
  56                 $cid = BaseApi::getContactIDForSearchterm($screen_name, $profile_url, $contact_id, $uid);
  57
  58                 $params = ['order' => ['relation-cid' => true], 'limit' => $count];
  59
  60                 $condition = ['cid' => $cid, 'follows' => true];
  61
  62                 $total_count = (int)DBA::count('contact-relation', $condition);
  63
  64                 if (!empty($max_id)) {
  65                         $condition = DBA::mergeConditions($condition, ["`relation-cid` < ?", $max_id]);
  66                 }
  67
  68                 if (!empty($since_id)) {
  69                         $condition = DBA::mergeConditions($condition, ["`relation-cid` > ?", $since_id]);
  70                 }
  71
  72                 if (!empty($min_id)) {
  73                         $condition = DBA::mergeConditions($condition, ["`relation-cid` > ?", $min_id]);
  74
  75                         $params['order'] = ['relation-cid'];
  76                 }
  77
  78                 $ids = [];
  79
  80                 $followers = DBA::select('contact-relation', ['relation-cid'], $condition, $params);
  81                 while ($follower = DBA::fetch($followers)) {
  82                         self::setBoundaries($follower['relation-cid']);
  83                         $ids[] = $follower['relation-cid'];
  84                 }
  85                 DBA::close($followers);
  86
  87                 if (!empty($min_id)) {
  88                         $ids = array_reverse($ids);
  89                 }
  90
  91                 $return = self::list($ids, $total_count, $uid, $cursor, $count, $skip_status, $include_user_entities);
  92
  93                 self::setLinkHeader();
  94
  95                 $this->response->exit('lists', ['lists' => $return]);
  96         }
  97 }