src/Module/Api/Twitter/ContactEndpoint.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;
  23
  24 use Friendica\App;
  25 use Friendica\Core\L10n;
  26 use Friendica\Database\DBA;
  27 use Friendica\DI;
  28 use Friendica\Model\Profile;
  29 use Friendica\Model\User;
  30 use Friendica\Module\BaseApi;
  31 use Friendica\Model\Contact;
  32 use Friendica\Network\HTTPException;
  33 use Friendica\Util\Profiler;
  34 use Friendica\Util\Strings;
  35 use Psr\Log\LoggerInterface;
  36
  37 abstract class ContactEndpoint extends BaseApi
  38 {
  39         const DEFAULT_COUNT = 20;
  40         const MAX_COUNT = 200;
  41
  42         public function __construct(L10n $l10n, App\BaseURL $baseUrl, App\Arguments $args, LoggerInterface $logger, Profiler $profiler, array $server, array $parameters = [])
  43         {
  44                 parent::__construct($l10n, $baseUrl, $args, $logger, $profiler, $server, $parameters);
  45
  46                 self::checkAllowedScope(self::SCOPE_READ);
  47         }
  48
  49         /**
  50          * Computes the uid from the contact_id + screen_name parameters
  51          *
  52          * @param int|null $contact_id
  53          * @param string   $screen_name
  54          * @return int
  55          * @throws HTTPException\NotFoundException
  56          */
  57         protected static function getUid(int $contact_id = null, string $screen_name = null)
  58         {
  59                 $uid = self::getCurrentUserID();
  60
  61                 if ($contact_id || $screen_name) {
  62                         // screen_name trumps user_id when both are provided
  63                         if (!$screen_name) {
  64                                 $contact = Contact::getById($contact_id, ['nick', 'url']);
  65                                 // We don't have the followers of remote accounts so we check for locality
  66                                 if (empty($contact) || !Strings::startsWith($contact['url'], DI::baseUrl()->get())) {
  67                                         throw new HTTPException\NotFoundException(DI::l10n()->t('Contact not found'));
  68                                 }
  69
  70                                 $screen_name = $contact['nick'];
  71                         }
  72
  73                         $user = User::getByNickname($screen_name, ['uid']);
  74                         if (empty($user)) {
  75                                 throw new HTTPException\NotFoundException(DI::l10n()->t('User not found'));
  76                         }
  77
  78                         $uid = (int)$user['uid'];
  79                 }
  80
  81                 return $uid;
  82         }
  83
  84         /**
  85          * This methods expands the contact ids into full user objects in an existing result set.
  86          *
  87          * @param array $ids           List of contact ids
  88          * @param int   $total_count   Total list of contacts
  89          * @param int   $uid           The local user id we query the contacts from
  90          * @param int   $cursor
  91          * @param int   $count
  92          * @param bool  $skip_status
  93          * @param bool  $include_user_entities
  94          * @return array
  95          * @throws HTTPException\InternalServerErrorException
  96          * @throws HTTPException\NotFoundException
  97          * @throws \ImagickException
  98          */
  99         protected static function list(array $ids, int $total_count, int $uid, int $cursor = -1, int $count = self::DEFAULT_COUNT, bool $skip_status = false, bool $include_user_entities = true)
 100         {
 101                 $return = self::ids($ids, $total_count, $cursor, $count, false);
 102
 103                 $users = [];
 104                 foreach ($return['ids'] as $contactId) {
 105                         $users[] = DI::twitterUser()->createFromContactId($contactId, $uid, $skip_status, $include_user_entities);
 106                 }
 107
 108                 unset($return['ids']);
 109                 $return['users'] = $users;
 110
 111                 $return = [
 112                         'users' => $users,
 113                         'next_cursor' => $return['next_cursor'],
 114                         'next_cursor_str' => $return['next_cursor_str'],
 115                         'previous_cursor' => $return['previous_cursor'],
 116                         'previous_cursor_str' => $return['previous_cursor_str'],
 117                         'total_count' => $return['total_count'],
 118                 ];
 119
 120                 return $return;
 121         }
 122
 123         /**
 124          * @param array $ids           List of contact ids
 125          * @param int   $total_count   Total list of contacts
 126          * @param int   $cursor
 127          * @param int   $count         Number of elements to return
 128          * @param bool  $stringify_ids if "true" then the id is converted to a string
 129          * @return array
 130          * @throws HTTPException\NotFoundException
 131          */
 132         protected static function ids(array $ids, int $total_count, int $cursor = -1, int $count = self::DEFAULT_COUNT, bool $stringify_ids = false)
 133         {
 134                 $next_cursor = 0;
 135                 $previous_cursor = 0;
 136
 137                 // Cursor is on the user-specific contact id since it's the sort field
 138                 if (count($ids)) {
 139                         $previous_cursor = -$ids[0];
 140                         $next_cursor = (int)$ids[count($ids) -1];
 141                 }
 142
 143                 // No next page
 144                 if ($total_count <= count($ids) || count($ids) < $count) {
 145                         $next_cursor = 0;
 146                 }
 147                 // End of results
 148                 if ($cursor < 0 && count($ids) === 0) {
 149                         $next_cursor = -1;
 150                 }
 151
 152                 // No previous page
 153                 if ($cursor === -1) {
 154                         $previous_cursor = 0;
 155                 }
 156
 157                 if ($cursor > 0 && count($ids) === 0) {
 158                         $previous_cursor = -$cursor;
 159                 }
 160
 161                 if ($cursor < 0 && count($ids) === 0) {
 162                         $next_cursor = -1;
 163                 }
 164
 165                 if ($stringify_ids) {
 166                         array_walk($ids, function (&$contactId) {
 167                                 $contactId = (string)$contactId;
 168                         });
 169                 }
 170
 171                 $return = [
 172                         'ids' => $ids,
 173                         'next_cursor' => $next_cursor,
 174                         'next_cursor_str' => (string)$next_cursor,
 175                         'previous_cursor' => $previous_cursor,
 176                         'previous_cursor_str' => (string)$previous_cursor,
 177                         'total_count' => $total_count,
 178                 ];
 179
 180                 return $return;
 181         }
 182 }