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