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