3 * @copyright Copyright (C) 2020, Friendica
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);
43 throw new HTTPException\UnauthorizedException();
48 * Computes the uid from the contact_id + screen_name parameters
50 * @param int|null $contact_id
51 * @param string $screen_name
53 * @throws HTTPException\NotFoundException
55 protected static function getUid(int $contact_id = null, string $screen_name = null)
57 $uid = self::$current_user_id;
59 if ($contact_id || $screen_name) {
60 // screen_name trumps user_id when both are provided
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'));
68 $screen_name = $contact['nick'];
71 $user = User::getByNickname($screen_name, ['uid']);
73 throw new HTTPException\NotFoundException(DI::l10n()->t('User not found'));
83 * This methods expands the contact ids into full user objects in an existing result set.
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
89 * @param bool $skip_status
90 * @param bool $include_user_entities
92 * @throws HTTPException\InternalServerErrorException
93 * @throws HTTPException\NotFoundException
94 * @throws \ImagickException
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)
98 $return = self::ids($rel, $uid, $cursor, $count);
101 foreach ($return['ids'] as $contactId) {
102 $users[] = DI::twitterUser()->createFromContactId($contactId, $uid, $skip_status, $include_user_entities);
105 unset($return['ids']);
106 $return['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'],
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
125 * @param bool $stringify_ids
127 * @throws HTTPException\NotFoundException
129 protected static function ids($rel, int $uid, int $cursor = -1, int $count = self::DEFAULT_COUNT, bool $stringify_ids = false)
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'));
138 $hide_friends = (bool)$profile['hide-friends'];
143 $previous_cursor = 0;
145 if (!$hide_friends) {
146 $condition = DBA::collapseCondition([
156 $total_count = DBA::count('contact', $condition);
158 if ($cursor !== -1) {
160 $condition[0] .= " AND `id` > ?";
161 $condition[] = $cursor;
163 $condition[0] .= " AND `id` < ?";
164 $condition[] = -$cursor;
168 $contacts = Contact::selectToArray(['id'], $condition, ['limit' => $count, 'order' => ['id']]);
170 // Contains user-specific contact ids
171 $ids = array_column($contacts, 'id');
173 // Cursor is on the user-specific contact id since it's the sort field
175 $previous_cursor = -$ids[0];
176 $next_cursor = $ids[count($ids) -1];
180 if ($total_count <= count($contacts) || count($contacts) < $count) {
184 if ($cursor < 0 && count($contacts) === 0) {
189 if ($cursor === -1) {
190 $previous_cursor = 0;
193 if ($cursor > 0 && count($contacts) === 0) {
194 $previous_cursor = -$cursor;
197 if ($cursor < 0 && count($contacts) === 0) {
201 // Conversion to public contact ids
202 array_walk($ids, function (&$contactId) use ($uid, $stringify_ids) {
203 $cdata = Contact::getPublicAndUserContacID($contactId, $uid);
204 if ($stringify_ids) {
205 $contactId = (string)$cdata['public'];
207 $contactId = (int)$cdata['public'];
214 'next_cursor' => $next_cursor,
215 'next_cursor_str' => (string)$next_cursor,
216 'previous_cursor' => $previous_cursor,
217 'previous_cursor_str' => (string)$previous_cursor,
218 'total_count' => $total_count,