3 * @copyright Copyright (C) 2010-2022, 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\Model\Contact;
25 use Friendica\Core\Logger;
26 use Friendica\Core\Protocol;
27 use Friendica\Database\Database;
28 use Friendica\Database\DBA;
30 use Friendica\Model\APContact;
31 use Friendica\Model\Contact;
32 use Friendica\Model\Profile;
33 use Friendica\Model\User;
34 use Friendica\Protocol\ActivityPub;
35 use Friendica\Util\DateTimeFormat;
36 use Friendica\Util\Strings;
39 * This class provides relationship information based on the `contact-relation` table.
40 * This table is directional (cid = source, relation-cid = target), references public contacts (with uid=0) and records both
41 * follows and the last interaction (likes/comments) on public posts.
46 * No discovery of followers/followings
48 const DISCOVERY_NONE = 0;
50 * Discover followers/followings of local contacts
52 const DISCOVERY_LOCAL = 1;
54 * Discover followers/followings of local contacts and contacts that visibly interacted on the system
56 const DISCOVERY_INTERACTOR = 2;
58 * Discover followers/followings of all contacts
60 const DISCOVERY_ALL = 3;
62 public static function store(int $target, int $actor, string $interaction_date)
64 if ($actor == $target) {
68 DBA::insert('contact-relation', ['last-interaction' => $interaction_date, 'cid' => $target, 'relation-cid' => $actor], Database::INSERT_UPDATE);
72 * Fetches the followers of a given profile and adds them
74 * @param string $url URL of a profile
77 public static function discoverByUrl(string $url)
79 $contact = Contact::getByURL($url);
80 if (empty($contact)) {
81 Logger::info('Contact not found', ['url' => $url]);
85 if (!self::isDiscoverable($url, $contact)) {
86 Logger::info('Contact is not discoverable', ['url' => $url]);
90 $uid = User::getIdForURL($url);
92 Logger::info('Fetch the followers/followings locally', ['url' => $url]);
93 $followers = self::getContacts($uid, [Contact::FOLLOWER, Contact::FRIEND]);
94 $followings = self::getContacts($uid, [Contact::SHARING, Contact::FRIEND]);
95 } elseif (!Contact::isLocal($url)) {
96 Logger::info('Fetch the followers/followings by polling the endpoints', ['url' => $url]);
97 $apcontact = APContact::getByURL($url, false);
99 if (!empty($apcontact['followers']) && is_string($apcontact['followers'])) {
100 $followers = ActivityPub::fetchItems($apcontact['followers']);
105 if (!empty($apcontact['following']) && is_string($apcontact['following'])) {
106 $followings = ActivityPub::fetchItems($apcontact['following']);
111 Logger::notice('Contact seems to be local but could not be found here', ['url' => $url]);
116 if (empty($followers) && empty($followings)) {
117 Contact::update(['last-discovery' => DateTimeFormat::utcNow()], ['id' => $contact['id']]);
118 Logger::info('The contact does not offer discoverable data', ['id' => $contact['id'], 'url' => $url, 'network' => $contact['network']]);
122 $target = $contact['id'];
124 if (!empty($followers)) {
125 // Clear the follower list, since it will be recreated in the next step
126 DBA::update('contact-relation', ['follows' => false], ['cid' => $target]);
130 foreach (array_merge($followers, $followings) as $contact) {
131 if (is_string($contact)) {
132 $contacts[] = $contact;
133 } elseif (!empty($contact['url']) && is_string($contact['url'])) {
134 $contacts[] = $contact['url'];
137 $contacts = array_unique($contacts);
139 $follower_counter = 0;
140 $following_counter = 0;
142 Logger::info('Discover contacts', ['id' => $target, 'url' => $url, 'contacts' => count($contacts)]);
143 foreach ($contacts as $contact) {
144 $actor = Contact::getIdForURL($contact);
145 if (!empty($actor)) {
146 if (in_array($contact, $followers)) {
147 $fields = ['cid' => $target, 'relation-cid' => $actor, 'follows' => true, 'follow-updated' => DateTimeFormat::utcNow()];
148 DBA::insert('contact-relation', $fields, Database::INSERT_UPDATE);
152 if (in_array($contact, $followings)) {
153 $fields = ['cid' => $actor, 'relation-cid' => $target, 'follows' => true, 'follow-updated' => DateTimeFormat::utcNow()];
154 DBA::insert('contact-relation', $fields, Database::INSERT_UPDATE);
155 $following_counter++;
160 if (!empty($followers)) {
161 // Delete all followers that aren't followers anymore (and aren't interacting)
162 DBA::delete('contact-relation', ['cid' => $target, 'follows' => false, 'last-interaction' => DBA::NULL_DATETIME]);
165 Contact::update(['last-discovery' => DateTimeFormat::utcNow()], ['id' => $target]);
166 Logger::info('Contacts discovery finished', ['id' => $target, 'url' => $url, 'follower' => $follower_counter, 'following' => $following_counter]);
171 * Fetch contact url list from the given local user
173 * @param integer $uid
175 * @return array contact list
177 private static function getContacts(int $uid, array $rel): array
180 $profile = Profile::getByUID($uid);
181 if (!empty($profile['hide-friends'])) {
194 $condition = DBA::mergeConditions($condition, ["`url` IN (SELECT `url` FROM `apcontact`)"]);
195 $contacts = DBA::select('contact', ['url'], $condition);
196 while ($contact = DBA::fetch($contacts)) {
197 $list[] = $contact['url'];
199 DBA::close($contacts);
205 * Tests if a given contact url is discoverable
207 * @param string $url Contact url
208 * @param array $contact Contact array
209 * @return boolean True if contact is discoverable
211 public static function isDiscoverable(string $url, array $contact = []): bool
213 $contact_discovery = DI::config()->get('system', 'contact_discovery');
215 if ($contact_discovery == self::DISCOVERY_NONE) {
219 if (empty($contact)) {
220 $contact = Contact::getByURL($url, false);
223 if (empty($contact)) {
227 if ($contact['last-discovery'] > DateTimeFormat::utc('now - 1 month')) {
228 Logger::info('No discovery - Last was less than a month ago.', ['id' => $contact['id'], 'url' => $url, 'discovery' => $contact['last-discovery']]);
232 if ($contact_discovery != self::DISCOVERY_ALL) {
233 $local = DBA::exists('contact', ["`nurl` = ? AND `uid` != ?", Strings::normaliseLink($url), 0]);
234 if (($contact_discovery == self::DISCOVERY_LOCAL) && !$local) {
235 Logger::info('No discovery - This contact is not followed/following locally.', ['id' => $contact['id'], 'url' => $url]);
239 if ($contact_discovery == self::DISCOVERY_INTERACTOR) {
240 $interactor = DBA::exists('contact-relation', ["`relation-cid` = ? AND `last-interaction` > ?", $contact['id'], DBA::NULL_DATETIME]);
241 if (!$local && !$interactor) {
242 Logger::info('No discovery - This contact is not interacting locally.', ['id' => $contact['id'], 'url' => $url]);
246 } elseif ($contact['created'] > DateTimeFormat::utc('now - 1 day')) {
247 // Newly created contacts are not discovered to avoid DDoS attacks
248 Logger::info('No discovery - Contact record is less than a day old.', ['id' => $contact['id'], 'url' => $url, 'discovery' => $contact['created']]);
252 if (!in_array($contact['network'], [Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::OSTATUS])) {
253 $apcontact = APContact::getByURL($url, false);
254 if (empty($apcontact)) {
255 Logger::info('No discovery - The contact does not seem to speak ActivityPub.', ['id' => $contact['id'], 'url' => $url, 'network' => $contact['network']]);
264 * Returns an array of sugguested contacts for given user id
266 * @param int $uid User id
267 * @param int $start optional, default 0
268 * @param int $limit optional, default 80
271 static public function getSuggestions(int $uid, int $start = 0, int $limit = 80): array
273 $cid = Contact::getPublicIdByUserId($uid);
274 $totallimit = $start + $limit;
277 Logger::info('Collecting suggestions', ['uid' => $uid, 'cid' => $cid, 'start' => $start, 'limit' => $limit]);
279 $diaspora = DI::config()->get('system', 'diaspora_enabled') ? Protocol::DIASPORA : Protocol::ACTIVITYPUB;
280 $ostatus = !DI::config()->get('system', 'ostatus_disabled') ? Protocol::OSTATUS : Protocol::ACTIVITYPUB;
282 // The query returns contacts where contacts interacted with whom the given user follows.
283 // Contacts who already are in the user's contact table are ignored.
284 $results = DBA::select('contact', [], ["`id` IN (SELECT `cid` FROM `contact-relation` WHERE `relation-cid` IN
285 (SELECT `cid` FROM `contact-relation` WHERE `relation-cid` = ?)
286 AND NOT `cid` IN (SELECT `id` FROM `contact` WHERE `uid` = ? AND `nurl` IN
287 (SELECT `nurl` FROM `contact` WHERE `uid` = ? AND `rel` IN (?, ?))))
288 AND NOT `hidden` AND `network` IN (?, ?, ?, ?)",
294 Protocol::ACTIVITYPUB,
299 'order' => ['last-item' => true],
300 'limit' => $totallimit,
304 while ($contact = DBA::fetch($results)) {
305 $contacts[$contact['id']] = $contact;
308 DBA::close($results);
310 Logger::info('Contacts of contacts who are followed by the given user', ['uid' => $uid, 'cid' => $cid, 'count' => count($contacts)]);
312 if (count($contacts) >= $totallimit) {
313 return array_slice($contacts, $start, $limit);
316 // The query returns contacts where contacts interacted with whom also interacted with the given user.
317 // Contacts who already are in the user's contact table are ignored.
318 $results = DBA::select('contact', [],
319 ["`id` IN (SELECT `cid` FROM `contact-relation` WHERE `relation-cid` IN
320 (SELECT `relation-cid` FROM `contact-relation` WHERE `cid` = ?)
321 AND NOT `cid` IN (SELECT `id` FROM `contact` WHERE `uid` = ? AND `nurl` IN
322 (SELECT `nurl` FROM `contact` WHERE `uid` = ? AND `rel` IN (?, ?))))
323 AND NOT `hidden` AND `network` IN (?, ?, ?, ?)",
324 $cid, 0, $uid, Contact::FRIEND, Contact::SHARING,
325 Protocol::ACTIVITYPUB, Protocol::DFRN, $diaspora, $ostatus],
326 ['order' => ['last-item' => true], 'limit' => $totallimit]
329 while ($contact = DBA::fetch($results)) {
330 $contacts[$contact['id']] = $contact;
332 DBA::close($results);
334 Logger::info('Contacts of contacts who are following the given user', ['uid' => $uid, 'cid' => $cid, 'count' => count($contacts)]);
336 if (count($contacts) >= $totallimit) {
337 return array_slice($contacts, $start, $limit);
340 // The query returns contacts that follow the given user but aren't followed by that user.
341 $results = DBA::select('contact', [],
342 ["`nurl` IN (SELECT `nurl` FROM `contact` WHERE `uid` = ? AND `rel` = ?)
343 AND NOT `hidden` AND `uid` = ? AND `network` IN (?, ?, ?, ?)",
344 $uid, Contact::FOLLOWER, 0,
345 Protocol::ACTIVITYPUB, Protocol::DFRN, $diaspora, $ostatus],
346 ['order' => ['last-item' => true], 'limit' => $totallimit]
349 while ($contact = DBA::fetch($results)) {
350 $contacts[$contact['id']] = $contact;
352 DBA::close($results);
354 Logger::info('Followers that are not followed by the given user', ['uid' => $uid, 'cid' => $cid, 'count' => count($contacts)]);
356 if (count($contacts) >= $totallimit) {
357 return array_slice($contacts, $start, $limit);
360 // The query returns any contact that isn't followed by that user.
361 $results = DBA::select('contact', [],
362 ["NOT `nurl` IN (SELECT `nurl` FROM `contact` WHERE `uid` = ? AND `rel` IN (?, ?))
363 AND NOT `hidden` AND `uid` = ? AND `network` IN (?, ?, ?, ?)",
364 $uid, Contact::FRIEND, Contact::SHARING, 0,
365 Protocol::ACTIVITYPUB, Protocol::DFRN, $diaspora, $ostatus],
366 ['order' => ['last-item' => true], 'limit' => $totallimit]
369 while ($contact = DBA::fetch($results)) {
370 $contacts[$contact['id']] = $contact;
372 DBA::close($results);
374 Logger::info('Any contact', ['uid' => $uid, 'cid' => $cid, 'count' => count($contacts)]);
376 return array_slice($contacts, $start, $limit);
380 * Counts all the known follows of the provided public contact
382 * @param int $cid Public contact id
383 * @param array $condition Additional condition on the contact table
387 public static function countFollows(int $cid, array $condition = []): int
389 $condition = DBA::mergeConditions($condition, [
390 '`id` IN (SELECT `relation-cid` FROM `contact-relation` WHERE `cid` = ? AND `follows`)',
394 return DI::dba()->count('contact', $condition);
398 * Returns a paginated list of contacts that are followed the provided public contact.
400 * @param int $cid Public contact id
401 * @param array $condition Additional condition on the contact table
404 * @param bool $shuffle
408 public static function listFollows(int $cid, array $condition = [], int $count = 30, int $offset = 0, bool $shuffle = false)
410 $condition = DBA::mergeConditions($condition,
411 ['`id` IN (SELECT `relation-cid` FROM `contact-relation` WHERE `cid` = ? AND `follows`)',
415 return DI::dba()->selectToArray('contact', [], $condition,
416 ['limit' => [$offset, $count], 'order' => [$shuffle ? 'RAND()' : 'name']]
421 * Counts all the known followers of the provided public contact
423 * @param int $cid Public contact id
424 * @param array $condition Additional condition on the contact table
428 public static function countFollowers(int $cid, array $condition = [])
430 $condition = DBA::mergeConditions($condition,
431 ['`id` IN (SELECT `cid` FROM `contact-relation` WHERE `relation-cid` = ? AND `follows`)',
435 return DI::dba()->count('contact', $condition);
439 * Returns a paginated list of contacts that follow the provided public contact.
441 * @param int $cid Public contact id
442 * @param array $condition Additional condition on the contact table
445 * @param bool $shuffle
449 public static function listFollowers(int $cid, array $condition = [], int $count = 30, int $offset = 0, bool $shuffle = false)
451 $condition = DBA::mergeConditions($condition,
452 ['`id` IN (SELECT `cid` FROM `contact-relation` WHERE `relation-cid` = ? AND `follows`)', $cid]
455 return DI::dba()->selectToArray('contact', [], $condition,
456 ['limit' => [$offset, $count], 'order' => [$shuffle ? 'RAND()' : 'name']]
461 * Counts the number of contacts that are known mutuals with the provided public contact.
463 * @param int $cid Public contact id
464 * @param array $condition Additional condition array on the contact table
468 public static function countMutuals(int $cid, array $condition = [])
470 $condition = DBA::mergeConditions($condition,
471 ['`id` IN (SELECT `relation-cid` FROM `contact-relation` WHERE `cid` = ? AND `follows`)
472 AND `id` IN (SELECT `cid` FROM `contact-relation` WHERE `relation-cid` = ? AND `follows`)',
476 return DI::dba()->count('contact', $condition);
480 * Returns a paginated list of contacts that are known mutuals with the provided public contact.
482 * @param int $cid Public contact id
483 * @param array $condition Additional condition on the contact table
486 * @param bool $shuffle
490 public static function listMutuals(int $cid, array $condition = [], int $count = 30, int $offset = 0, bool $shuffle = false)
492 $condition = DBA::mergeConditions($condition,
493 ['`id` IN (SELECT `relation-cid` FROM `contact-relation` WHERE `cid` = ? AND `follows`)
494 AND `id` IN (SELECT `cid` FROM `contact-relation` WHERE `relation-cid` = ? AND `follows`)',
498 return DI::dba()->selectToArray('contact', [], $condition,
499 ['limit' => [$offset, $count], 'order' => [$shuffle ? 'RAND()' : 'name']]
505 * Counts the number of contacts with any relationship with the provided public contact.
507 * @param int $cid Public contact id
508 * @param array $condition Additional condition array on the contact table
512 public static function countAll(int $cid, array $condition = [])
514 $condition = DBA::mergeConditions($condition,
515 ['(`id` IN (SELECT `relation-cid` FROM `contact-relation` WHERE `cid` = ? AND `follows`)
516 OR `id` IN (SELECT `cid` FROM `contact-relation` WHERE `relation-cid` = ? AND `follows`))',
520 return DI::dba()->count('contact', $condition);
524 * Returns a paginated list of contacts with any relationship with the provided public contact.
526 * @param int $cid Public contact id
527 * @param array $condition Additional condition on the contact table
530 * @param bool $shuffle
534 public static function listAll(int $cid, array $condition = [], int $count = 30, int $offset = 0, bool $shuffle = false)
536 $condition = DBA::mergeConditions($condition,
537 ['(`id` IN (SELECT `relation-cid` FROM `contact-relation` WHERE `cid` = ? AND `follows`)
538 OR `id` IN (SELECT `cid` FROM `contact-relation` WHERE `relation-cid` = ? AND `follows`))',
542 return DI::dba()->selectToArray('contact', [], $condition,
543 ['limit' => [$offset, $count], 'order' => [$shuffle ? 'RAND()' : 'name']]
548 * Counts the number of contacts that both provided public contacts have interacted with at least once.
549 * Interactions include follows and likes and comments on public posts.
551 * @param int $sourceId Public contact id
552 * @param int $targetId Public contact id
553 * @param array $condition Additional condition array on the contact table
557 public static function countCommon(int $sourceId, int $targetId, array $condition = [])
559 $condition = DBA::mergeConditions($condition,
560 ['`id` IN (SELECT `relation-cid` FROM `contact-relation` WHERE `cid` = ?)
561 AND `id` IN (SELECT `relation-cid` FROM `contact-relation` WHERE `cid` = ?)',
562 $sourceId, $targetId]
565 return DI::dba()->count('contact', $condition);
569 * Returns a paginated list of contacts that both provided public contacts have interacted with at least once.
570 * Interactions include follows and likes and comments on public posts.
572 * @param int $sourceId Public contact id
573 * @param int $targetId Public contact id
574 * @param array $condition Additional condition on the contact table
577 * @param bool $shuffle
578 * @return array|bool Array on success, false on failure
581 public static function listCommon(int $sourceId, int $targetId, array $condition = [], int $count = 30, int $offset = 0, bool $shuffle = false)
583 $condition = DBA::mergeConditions($condition,
584 ["`id` IN (SELECT `relation-cid` FROM `contact-relation` WHERE `cid` = ?)
585 AND `id` IN (SELECT `relation-cid` FROM `contact-relation` WHERE `cid` = ?)",
586 $sourceId, $targetId]
589 return DI::dba()->selectToArray('contact', [], $condition,
590 ['limit' => [$offset, $count], 'order' => [$shuffle ? 'RAND()' : 'name']]
595 * Counts the number of contacts that are followed by both provided public contacts.
597 * @param int $sourceId Public contact id
598 * @param int $targetId Public contact id
599 * @param array $condition Additional condition array on the contact table
603 public static function countCommonFollows(int $sourceId, int $targetId, array $condition = []): int
605 $condition = DBA::mergeConditions($condition,
606 ['`id` IN (SELECT `relation-cid` FROM `contact-relation` WHERE `cid` = ? AND `follows`)
607 AND `id` IN (SELECT `relation-cid` FROM `contact-relation` WHERE `cid` = ? AND `follows`)',
608 $sourceId, $targetId]
611 return DI::dba()->count('contact', $condition);
615 * Returns a paginated list of contacts that are followed by both provided public contacts.
617 * @param int $sourceId Public contact id
618 * @param int $targetId Public contact id
619 * @param array $condition Additional condition array on the contact table
622 * @param bool $shuffle
623 * @return array|bool Array on success, false on failure
626 public static function listCommonFollows(int $sourceId, int $targetId, array $condition = [], int $count = 30, int $offset = 0, bool $shuffle = false)
628 $condition = DBA::mergeConditions($condition,
629 ["`id` IN (SELECT `relation-cid` FROM `contact-relation` WHERE `cid` = ? AND `follows`)
630 AND `id` IN (SELECT `relation-cid` FROM `contact-relation` WHERE `cid` = ? AND `follows`)",
631 $sourceId, $targetId]
634 return DI::dba()->selectToArray('contact', [], $condition,
635 ['limit' => [$offset, $count], 'order' => [$shuffle ? 'RAND()' : 'name']]
640 * Counts the number of contacts that follow both provided public contacts.
642 * @param int $sourceId Public contact id
643 * @param int $targetId Public contact id
644 * @param array $condition Additional condition on the contact table
648 public static function countCommonFollowers(int $sourceId, int $targetId, array $condition = []): int
650 $condition = DBA::mergeConditions($condition,
651 ["`id` IN (SELECT `cid` FROM `contact-relation` WHERE `relation-cid` = ? AND `follows`)
652 AND `id` IN (SELECT `cid` FROM `contact-relation` WHERE `relation-cid` = ? AND `follows`)",
653 $sourceId, $targetId]
656 return DI::dba()->count('contact', $condition);
660 * Returns a paginated list of contacts that follow both provided public contacts.
662 * @param int $sourceId Public contact id
663 * @param int $targetId Public contact id
664 * @param array $condition Additional condition on the contact table
667 * @param bool $shuffle
668 * @return array|bool Array on success, false on failure
671 public static function listCommonFollowers(int $sourceId, int $targetId, array $condition = [], int $count = 30, int $offset = 0, bool $shuffle = false)
673 $condition = DBA::mergeConditions($condition,
674 ["`id` IN (SELECT `cid` FROM `contact-relation` WHERE `relation-cid` = ? AND `follows`)
675 AND `id` IN (SELECT `cid` FROM `contact-relation` WHERE `relation-cid` = ? AND `follows`)",
676 $sourceId, $targetId]
679 return DI::dba()->selectToArray('contact', [], $condition,
680 ['limit' => [$offset, $count], 'order' => [$shuffle ? 'RAND()' : 'name']]