3 * @copyright Copyright (C) 2010-2021, the Friendica project
5 * @license GNU AGPL version 3 or any later version
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.
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.
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/>.
22 namespace Friendica\Module\Api\Twitter;
24 use Friendica\Database\DBA;
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;
33 abstract class ContactEndpoint extends BaseApi
35 const DEFAULT_COUNT = 20;
36 const MAX_COUNT = 200;
38 public static function init(array $parameters = [])
40 parent::init($parameters);
42 self::checkAllowedScope(self::SCOPE_READ);
46 * Computes the uid from the contact_id + screen_name parameters
48 * @param int|null $contact_id
49 * @param string $screen_name
51 * @throws HTTPException\NotFoundException
53 protected static function getUid(int $contact_id = null, string $screen_name = null)
55 $uid = self::getCurrentUserID();
57 if ($contact_id || $screen_name) {
58 // screen_name trumps user_id when both are provided
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'));
66 $screen_name = $contact['nick'];
69 $user = User::getByNickname($screen_name, ['uid']);
71 throw new HTTPException\NotFoundException(DI::l10n()->t('User not found'));
74 $uid = (int)$user['uid'];
81 * This methods expands the contact ids into full user objects in an existing result set.
83 * @param mixed $rel A relationship constant or a list of them
84 * @param int $uid The local user id we query the contacts from
87 * @param bool $skip_status
88 * @param bool $include_user_entities
90 * @throws HTTPException\InternalServerErrorException
91 * @throws HTTPException\NotFoundException
92 * @throws \ImagickException
94 protected static function list($rel, int $uid, int $cursor = -1, int $count = self::DEFAULT_COUNT, bool $skip_status = false, bool $include_user_entities = true)
96 $return = self::ids($rel, $uid, $cursor, $count);
99 foreach ($return['ids'] as $contactId) {
100 $users[] = DI::twitterUser()->createFromContactId($contactId, $uid, $skip_status, $include_user_entities);
103 unset($return['ids']);
104 $return['users'] = $users;
108 'next_cursor' => $return['next_cursor'],
109 'next_cursor_str' => $return['next_cursor_str'],
110 'previous_cursor' => $return['previous_cursor'],
111 'previous_cursor_str' => $return['previous_cursor_str'],
112 'total_count' => (int)$return['total_count'],
119 * @param mixed $rel A relationship constant or a list of them
120 * @param int $uid The local user id we query the contacts from
123 * @param bool $stringify_ids
125 * @throws HTTPException\NotFoundException
127 protected static function ids($rel, int $uid, int $cursor = -1, int $count = self::DEFAULT_COUNT, bool $stringify_ids = false)
129 $hide_friends = false;
130 if ($uid != self::getCurrentUserID()) {
131 $profile = Profile::getByUID($uid);
132 if (empty($profile)) {
133 throw new HTTPException\NotFoundException(DI::l10n()->t('Profile not found'));
136 $hide_friends = (bool)$profile['hide-friends'];
141 $previous_cursor = 0;
143 if (!$hide_friends) {
154 $total_count = (int)DBA::count('contact', $condition);
156 $params = ['limit' => $count, 'order' => ['id' => 'ASC']];
158 if ($cursor !== -1) {
160 $condition = DBA::mergeConditions($condition, ['`id` > ?', $cursor]);
162 $condition = DBA::mergeConditions($condition, ['`id` < ?', -$cursor]);
163 // Previous page case: we want the items closest to cursor but for that we need to reverse the query order
164 $params['order']['id'] = 'DESC';
168 $contacts = Contact::selectToArray(['id'], $condition, $params);
170 // Previous page case: once we get the relevant items closest to cursor, we need to restore the expected display order
171 if ($cursor !== -1 && $cursor <= 0) {
172 $contacts = array_reverse($contacts);
175 // Contains user-specific contact ids
176 $ids = array_column($contacts, 'id');
178 // Cursor is on the user-specific contact id since it's the sort field
180 $previous_cursor = -$ids[0];
181 $next_cursor = (int)$ids[count($ids) -1];
185 if ($total_count <= count($contacts) || count($contacts) < $count) {
189 if ($cursor < 0 && count($contacts) === 0) {
194 if ($cursor === -1) {
195 $previous_cursor = 0;
198 if ($cursor > 0 && count($contacts) === 0) {
199 $previous_cursor = -$cursor;
202 if ($cursor < 0 && count($contacts) === 0) {
206 // Conversion to public contact ids
207 array_walk($ids, function (&$contactId) use ($uid, $stringify_ids) {
208 $cdata = Contact::getPublicAndUserContacID($contactId, $uid);
209 if ($stringify_ids) {
210 $contactId = (string)$cdata['public'];
212 $contactId = (int)$cdata['public'];
219 'next_cursor' => $next_cursor,
220 'next_cursor_str' => (string)$next_cursor,
221 'previous_cursor' => $previous_cursor,
222 'previous_cursor_str' => (string)$previous_cursor,
223 'total_count' => $total_count,