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 static function init(array $parameters = [])
  39         {
  40                 parent::init($parameters);
  41
  42                 if (!self::login()) {
  43                         throw new HTTPException\UnauthorizedException();
  44                 }
  45         }
  46
  47         /**
  48          * Computes the uid from the contact_id + screen_name parameters
  49          *
  50          * @param int|null $contact_id
  51          * @param string   $screen_name
  52          * @return int
  53          * @throws HTTPException\NotFoundException
  54          */
  55         protected static function getUid(int $contact_id = null, string $screen_name = null)
  56         {
  57                 $uid = self::$current_user_id;
  58
  59                 if ($contact_id || $screen_name) {
  60                         // screen_name trumps user_id when both are provided
  61                         if (!$screen_name) {
  62                                 $contact = Contact::getById($contact_id, ['nick', 'url']);
  63                                 // We don't have the followers of remote accounts so we check for locality
  64                                 if (empty($contact) || !Strings::startsWith($contact['url'], DI::baseUrl()->get())) {
  65                                         throw new HTTPException\NotFoundException(DI::l10n()->t('Contact not found'));
  66                                 }
  67
  68                                 $screen_name = $contact['nick'];
  69                         }
  70
  71                         $user = User::getByNickname($screen_name, ['uid']);
  72                         if (empty($user)) {
  73                                 throw new HTTPException\NotFoundException(DI::l10n()->t('User not found'));
  74                         }
  75
  76                         $uid = (int)$user['uid'];
  77                 }
  78
  79                 return $uid;
  80         }
  81
  82         /**
  83          * This methods expands the contact ids into full user objects in an existing result set.
  84          *
  85          * @param mixed $rel A relationship constant or a list of them
  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($rel, int $uid, int $cursor = -1, int $count = self::DEFAULT_COUNT, bool $skip_status = false, bool $include_user_entities = true)
  97         {
  98                 $return = self::ids($rel, $uid, $cursor, $count);
  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' => (int)$return['total_count'],
 115                 ];
 116
 117                 return $return;
 118         }
 119
 120         /**
 121          * @param mixed $rel A relationship constant or a list of them
 122          * @param int   $uid The local user id we query the contacts from
 123          * @param int   $cursor
 124          * @param int   $count
 125          * @param bool  $stringify_ids
 126          * @return array
 127          * @throws HTTPException\NotFoundException
 128          */
 129         protected static function ids($rel, int $uid, int $cursor = -1, int $count = self::DEFAULT_COUNT, bool $stringify_ids = false)
 130         {
 131                 $hide_friends = false;
 132                 if ($uid != self::$current_user_id) {
 133                         $profile = Profile::getByUID($uid);
 134                         if (empty($profile)) {
 135                                 throw new HTTPException\NotFoundException(DI::l10n()->t('Profile not found'));
 136                         }
 137
 138                         $hide_friends = (bool)$profile['hide-friends'];
 139                 }
 140
 141                 $ids = [];
 142                 $next_cursor = 0;
 143                 $previous_cursor = 0;
 144                 $total_count = 0;
 145                 if (!$hide_friends) {
 146                         $condition = [
 147                                 'rel' => $rel,
 148                                 'uid' => $uid,
 149                                 'self' => false,
 150                                 'deleted' => false,
 151                                 'hidden' => false,
 152                                 'archive' => false,
 153                                 'pending' => false
 154                         ];
 155
 156                         $total_count = (int)DBA::count('contact', $condition);
 157
 158                         $params = ['limit' => $count, 'order' => ['id' => 'ASC']];
 159
 160                         if ($cursor !== -1) {
 161                                 if ($cursor > 0) {
 162                                         $condition = DBA::mergeConditions($condition, ['`id` > ?', $cursor]);
 163                                 } else {
 164                                         $condition = DBA::mergeConditions($condition, ['`id` < ?', -$cursor]);
 165                                         // Previous page case: we want the items closest to cursor but for that we need to reverse the query order
 166                                         $params['order']['id'] = 'DESC';
 167                                 }
 168                         }
 169
 170                         $contacts = Contact::selectToArray(['id'], $condition, $params);
 171
 172                         // Previous page case: once we get the relevant items closest to cursor, we need to restore the expected display order
 173                         if ($cursor !== -1 && $cursor <= 0) {
 174                                 $contacts = array_reverse($contacts);
 175                         }
 176
 177                         // Contains user-specific contact ids
 178                         $ids = array_column($contacts, 'id');
 179
 180                         // Cursor is on the user-specific contact id since it's the sort field
 181                         if (count($ids)) {
 182                                 $previous_cursor = -$ids[0];
 183                                 $next_cursor = (int)$ids[count($ids) -1];
 184                         }
 185
 186                         // No next page
 187                         if ($total_count <= count($contacts) || count($contacts) < $count) {
 188                                 $next_cursor = 0;
 189                         }
 190                         // End of results
 191                         if ($cursor < 0 && count($contacts) === 0) {
 192                                 $next_cursor = -1;
 193                         }
 194
 195                         // No previous page
 196                         if ($cursor === -1) {
 197                                 $previous_cursor = 0;
 198                         }
 199
 200                         if ($cursor > 0 && count($contacts) === 0) {
 201                                 $previous_cursor = -$cursor;
 202                         }
 203
 204                         if ($cursor < 0 && count($contacts) === 0) {
 205                                 $next_cursor = -1;
 206                         }
 207
 208                         // Conversion to public contact ids
 209                         array_walk($ids, function (&$contactId) use ($uid, $stringify_ids) {
 210                                 $cdata = Contact::getPublicAndUserContacID($contactId, $uid);
 211                                 if ($stringify_ids) {
 212                                         $contactId = (string)$cdata['public'];
 213                                 } else {
 214                                         $contactId = (int)$cdata['public'];
 215                                 }
 216                         });
 217                 }
 218
 219                 $return = [
 220                         'ids' => $ids,
 221                         'next_cursor' => $next_cursor,
 222                         'next_cursor_str' => (string)$next_cursor,
 223                         'previous_cursor' => $previous_cursor,
 224                         'previous_cursor_str' => (string)$previous_cursor,
 225                         'total_count' => $total_count,
 226                 ];
 227
 228                 return $return;
 229         }
 230 }