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\Model\Contact;
25 use Friendica\Core\Logger;
26 use Friendica\Core\Protocol;
27 use Friendica\Database\DBA;
29 use Friendica\Model\APContact;
30 use Friendica\Model\Contact;
31 use Friendica\Protocol\ActivityPub;
32 use Friendica\Util\DateTimeFormat;
33 use Friendica\Util\Strings;
36 * This class provides relationship information based on the `contact-relation` table.
37 * This table is directional (cid = source, relation-cid = target), references public contacts (with uid=0) and records both
38 * follows and the last interaction (likes/comments) on public posts.
43 * No discovery of followers/followings
45 const DISCOVERY_NONE = 0;
47 * Discover followers/followings of local contacts
49 const DISCOVERY_LOCAL = 1;
51 * Discover followers/followings of local contacts and contacts that visibly interacted on the system
53 const DISCOVERY_INTERACTOR = 2;
55 * Discover followers/followings of all contacts
57 const DISCOVERY_ALL = 3;
59 public static function store(int $target, int $actor, string $interaction_date)
61 if ($actor == $target) {
65 DBA::update('contact-relation', ['last-interaction' => $interaction_date], ['cid' => $target, 'relation-cid' => $actor], true);
69 * Fetches the followers of a given profile and adds them
71 * @param string $url URL of a profile
74 public static function discoverByUrl(string $url)
76 $contact = Contact::getByURL($url);
77 if (empty($contact)) {
81 if (!self::isDiscoverable($url, $contact)) {
85 $apcontact = APContact::getByURL($url, false);
87 if (!empty($apcontact['followers']) && is_string($apcontact['followers'])) {
88 $followers = ActivityPub::fetchItems($apcontact['followers']);
93 if (!empty($apcontact['following']) && is_string($apcontact['following'])) {
94 $followings = ActivityPub::fetchItems($apcontact['following']);
99 if (empty($followers) && empty($followings)) {
100 DBA::update('contact', ['last-discovery' => DateTimeFormat::utcNow()], ['id' => $contact['id']]);
101 Logger::info('The contact does not offer discoverable data', ['id' => $contact['id'], 'url' => $url, 'network' => $contact['network']]);
105 $target = $contact['id'];
107 if (!empty($followers)) {
108 // Clear the follower list, since it will be recreated in the next step
109 DBA::update('contact-relation', ['follows' => false], ['cid' => $target]);
113 foreach (array_merge($followers, $followings) as $contact) {
114 if (is_string($contact)) {
115 $contacts[] = $contact;
116 } elseif (!empty($contact['url']) && is_string($contact['url'])) {
117 $contacts[] = $contact['url'];
120 $contacts = array_unique($contacts);
122 $follower_counter = 0;
123 $following_counter = 0;
125 Logger::info('Discover contacts', ['id' => $target, 'url' => $url, 'contacts' => count($contacts)]);
126 foreach ($contacts as $contact) {
127 $actor = Contact::getIdForURL($contact);
128 if (!empty($actor)) {
129 if (in_array($contact, $followers)) {
130 $fields = ['cid' => $target, 'relation-cid' => $actor];
131 DBA::update('contact-relation', ['follows' => true, 'follow-updated' => DateTimeFormat::utcNow()], $fields, true);
135 if (in_array($contact, $followings)) {
136 $fields = ['cid' => $actor, 'relation-cid' => $target];
137 DBA::update('contact-relation', ['follows' => true, 'follow-updated' => DateTimeFormat::utcNow()], $fields, true);
138 $following_counter++;
143 if (!empty($followers)) {
144 // Delete all followers that aren't followers anymore (and aren't interacting)
145 DBA::delete('contact-relation', ['cid' => $target, 'follows' => false, 'last-interaction' => DBA::NULL_DATETIME]);
148 DBA::update('contact', ['last-discovery' => DateTimeFormat::utcNow()], ['id' => $target]);
149 Logger::info('Contacts discovery finished', ['id' => $target, 'url' => $url, 'follower' => $follower_counter, 'following' => $following_counter]);
154 * Tests if a given contact url is discoverable
156 * @param string $url Contact url
157 * @param array $contact Contact array
158 * @return boolean True if contact is discoverable
160 public static function isDiscoverable(string $url, array $contact = [])
162 $contact_discovery = DI::config()->get('system', 'contact_discovery');
164 if ($contact_discovery == self::DISCOVERY_NONE) {
168 if (empty($contact)) {
169 $contact = Contact::getByURL($url, false);
172 if (empty($contact)) {
176 if ($contact['last-discovery'] > DateTimeFormat::utc('now - 1 month')) {
177 Logger::info('No discovery - Last was less than a month ago.', ['id' => $contact['id'], 'url' => $url, 'discovery' => $contact['last-discovery']]);
181 if ($contact_discovery != self::DISCOVERY_ALL) {
182 $local = DBA::exists('contact', ["`nurl` = ? AND `uid` != ?", Strings::normaliseLink($url), 0]);
183 if (($contact_discovery == self::DISCOVERY_LOCAL) && !$local) {
184 Logger::info('No discovery - This contact is not followed/following locally.', ['id' => $contact['id'], 'url' => $url]);
188 if ($contact_discovery == self::DISCOVERY_INTERACTOR) {
189 $interactor = DBA::exists('contact-relation', ["`relation-cid` = ? AND `last-interaction` > ?", $contact['id'], DBA::NULL_DATETIME]);
190 if (!$local && !$interactor) {
191 Logger::info('No discovery - This contact is not interacting locally.', ['id' => $contact['id'], 'url' => $url]);
195 } elseif ($contact['created'] > DateTimeFormat::utc('now - 1 day')) {
196 // Newly created contacts are not discovered to avoid DDoS attacks
197 Logger::info('No discovery - Contact record is less than a day old.', ['id' => $contact['id'], 'url' => $url, 'discovery' => $contact['created']]);
201 if (!in_array($contact['network'], [Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::OSTATUS])) {
202 $apcontact = APContact::getByURL($url, false);
203 if (empty($apcontact)) {
204 Logger::info('No discovery - The contact does not seem to speak ActivityPub.', ['id' => $contact['id'], 'url' => $url, 'network' => $contact['network']]);
213 * @param int $uid user
214 * @param int $start optional, default 0
215 * @param int $limit optional, default 80
218 static public function getSuggestions(int $uid, int $start = 0, int $limit = 80)
220 $cid = Contact::getPublicIdByUserId($uid);
221 $totallimit = $start + $limit;
224 Logger::info('Collecting suggestions', ['uid' => $uid, 'cid' => $cid, 'start' => $start, 'limit' => $limit]);
226 $diaspora = DI::config()->get('system', 'diaspora_enabled') ? Protocol::DIASPORA : Protocol::ACTIVITYPUB;
227 $ostatus = !DI::config()->get('system', 'ostatus_disabled') ? Protocol::OSTATUS : Protocol::ACTIVITYPUB;
229 // The query returns contacts where contacts interacted with whom the given user follows.
230 // Contacts who already are in the user's contact table are ignored.
231 $results = DBA::select('contact', [],
232 ["`id` IN (SELECT `cid` FROM `contact-relation` WHERE `relation-cid` IN
233 (SELECT `cid` FROM `contact-relation` WHERE `relation-cid` = ?)
234 AND NOT `cid` IN (SELECT `id` FROM `contact` WHERE `uid` = ? AND `nurl` IN
235 (SELECT `nurl` FROM `contact` WHERE `uid` = ? AND `rel` IN (?, ?))))
236 AND NOT `hidden` AND `network` IN (?, ?, ?, ?)",
237 $cid, 0, $uid, Contact::FRIEND, Contact::SHARING,
238 Protocol::ACTIVITYPUB, Protocol::DFRN, $diaspora, $ostatus],
239 ['order' => ['last-item' => true], 'limit' => $totallimit]
242 while ($contact = DBA::fetch($results)) {
243 $contacts[$contact['id']] = $contact;
245 DBA::close($results);
247 Logger::info('Contacts of contacts who are followed by the given user', ['uid' => $uid, 'cid' => $cid, 'count' => count($contacts)]);
249 if (count($contacts) >= $totallimit) {
250 return array_slice($contacts, $start, $limit);
253 // The query returns contacts where contacts interacted with whom also interacted with the given user.
254 // Contacts who already are in the user's contact table are ignored.
255 $results = DBA::select('contact', [],
256 ["`id` IN (SELECT `cid` FROM `contact-relation` WHERE `relation-cid` IN
257 (SELECT `relation-cid` FROM `contact-relation` WHERE `cid` = ?)
258 AND NOT `cid` IN (SELECT `id` FROM `contact` WHERE `uid` = ? AND `nurl` IN
259 (SELECT `nurl` FROM `contact` WHERE `uid` = ? AND `rel` IN (?, ?))))
260 AND NOT `hidden` AND `network` IN (?, ?, ?, ?)",
261 $cid, 0, $uid, Contact::FRIEND, Contact::SHARING,
262 Protocol::ACTIVITYPUB, Protocol::DFRN, $diaspora, $ostatus],
263 ['order' => ['last-item' => true], 'limit' => $totallimit]
266 while ($contact = DBA::fetch($results)) {
267 $contacts[$contact['id']] = $contact;
269 DBA::close($results);
271 Logger::info('Contacts of contacts who are following the given user', ['uid' => $uid, 'cid' => $cid, 'count' => count($contacts)]);
273 if (count($contacts) >= $totallimit) {
274 return array_slice($contacts, $start, $limit);
277 // The query returns contacts that follow the given user but aren't followed by that user.
278 $results = DBA::select('contact', [],
279 ["`nurl` IN (SELECT `nurl` FROM `contact` WHERE `uid` = ? AND `rel` = ?)
280 AND NOT `hidden` AND `uid` = ? AND `network` IN (?, ?, ?, ?)",
281 $uid, Contact::FOLLOWER, 0,
282 Protocol::ACTIVITYPUB, Protocol::DFRN, $diaspora, $ostatus],
283 ['order' => ['last-item' => true], 'limit' => $totallimit]
286 while ($contact = DBA::fetch($results)) {
287 $contacts[$contact['id']] = $contact;
289 DBA::close($results);
291 Logger::info('Followers that are not followed by the given user', ['uid' => $uid, 'cid' => $cid, 'count' => count($contacts)]);
293 if (count($contacts) >= $totallimit) {
294 return array_slice($contacts, $start, $limit);
297 // The query returns any contact that isn't followed by that user.
298 $results = DBA::select('contact', [],
299 ["NOT `nurl` IN (SELECT `nurl` FROM `contact` WHERE `uid` = ? AND `rel` IN (?, ?))
300 AND NOT `hidden` AND `uid` = ? AND `network` IN (?, ?, ?, ?)",
301 $uid, Contact::FRIEND, Contact::SHARING, 0,
302 Protocol::ACTIVITYPUB, Protocol::DFRN, $diaspora, $ostatus],
303 ['order' => ['last-item' => true], 'limit' => $totallimit]
306 while ($contact = DBA::fetch($results)) {
307 $contacts[$contact['id']] = $contact;
309 DBA::close($results);
311 Logger::info('Any contact', ['uid' => $uid, 'cid' => $cid, 'count' => count($contacts)]);
313 return array_slice($contacts, $start, $limit);
317 * Counts all the known follows of the provided public contact
319 * @param int $cid Public contact id
320 * @param array $condition Additional condition on the contact table
324 public static function countFollows(int $cid, array $condition = [])
326 $condition = DBA::mergeConditions($condition,
327 ['`id` IN (SELECT `relation-cid` FROM `contact-relation` WHERE `cid` = ? AND `follows`)',
331 return DI::dba()->count('contact', $condition);
335 * Returns a paginated list of contacts that are followed the provided public contact.
337 * @param int $cid Public contact id
338 * @param array $condition Additional condition on the contact table
341 * @param bool $shuffle
345 public static function listFollows(int $cid, array $condition = [], int $count = 30, int $offset = 0, bool $shuffle = false)
347 $condition = DBA::mergeConditions($condition,
348 ['`id` IN (SELECT `relation-cid` FROM `contact-relation` WHERE `cid` = ? AND `follows`)',
352 return DI::dba()->selectToArray('contact', [], $condition,
353 ['limit' => [$offset, $count], 'order' => [$shuffle ? 'RAND()' : 'name']]
358 * Counts all the known followers of the provided public contact
360 * @param int $cid Public contact id
361 * @param array $condition Additional condition on the contact table
365 public static function countFollowers(int $cid, array $condition = [])
367 $condition = DBA::mergeConditions($condition,
368 ['`id` IN (SELECT `cid` FROM `contact-relation` WHERE `relation-cid` = ? AND `follows`)',
372 return DI::dba()->count('contact', $condition);
376 * Returns a paginated list of contacts that follow the provided public contact.
378 * @param int $cid Public contact id
379 * @param array $condition Additional condition on the contact table
382 * @param bool $shuffle
386 public static function listFollowers(int $cid, array $condition = [], int $count = 30, int $offset = 0, bool $shuffle = false)
388 $condition = DBA::mergeConditions($condition,
389 ['`id` IN (SELECT `cid` FROM `contact-relation` WHERE `relation-cid` = ? AND `follows`)', $cid]
392 return DI::dba()->selectToArray('contact', [], $condition,
393 ['limit' => [$offset, $count], 'order' => [$shuffle ? 'RAND()' : 'name']]
398 * Counts the number of contacts that are known mutuals with the provided public contact.
400 * @param int $cid Public contact id
401 * @param array $condition Additional condition array on the contact table
405 public static function countMutuals(int $cid, array $condition = [])
407 $condition = DBA::mergeConditions($condition,
408 ['`id` IN (SELECT `relation-cid` FROM `contact-relation` WHERE `cid` = ? AND `follows`)
409 AND `id` IN (SELECT `cid` FROM `contact-relation` WHERE `relation-cid` = ? AND `follows`)',
413 return DI::dba()->count('contact', $condition);
417 * Returns a paginated list of contacts that are known mutuals with the provided public contact.
419 * @param int $cid Public contact id
420 * @param array $condition Additional condition on the contact table
423 * @param bool $shuffle
427 public static function listMutuals(int $cid, array $condition = [], int $count = 30, int $offset = 0, bool $shuffle = false)
429 $condition = DBA::mergeConditions($condition,
430 ['`id` IN (SELECT `relation-cid` FROM `contact-relation` WHERE `cid` = ? AND `follows`)
431 AND `id` IN (SELECT `cid` FROM `contact-relation` WHERE `relation-cid` = ? AND `follows`)',
435 return DI::dba()->selectToArray('contact', [], $condition,
436 ['limit' => [$offset, $count], 'order' => [$shuffle ? 'name' : 'RAND()']]
442 * Counts the number of contacts with any relationship with the provided public contact.
444 * @param int $cid Public contact id
445 * @param array $condition Additional condition array on the contact table
449 public static function countAll(int $cid, array $condition = [])
451 $condition = DBA::mergeConditions($condition,
452 ['`id` IN (SELECT `relation-cid` FROM `contact-relation` WHERE `cid` = ? AND `follows`)
453 OR `id` IN (SELECT `cid` FROM `contact-relation` WHERE `relation-cid` = ? AND `follows`)',
457 return DI::dba()->count('contact', $condition);
461 * Returns a paginated list of contacts with any relationship with the provided public contact.
463 * @param int $cid Public contact id
464 * @param array $condition Additional condition on the contact table
467 * @param bool $shuffle
471 public static function listAll(int $cid, array $condition = [], int $count = 30, int $offset = 0, bool $shuffle = false)
473 $condition = DBA::mergeConditions($condition,
474 ['`id` IN (SELECT `relation-cid` FROM `contact-relation` WHERE `cid` = ? AND `follows`)
475 OR `id` IN (SELECT `cid` FROM `contact-relation` WHERE `relation-cid` = ? AND `follows`)',
479 return DI::dba()->selectToArray('contact', [], $condition,
480 ['limit' => [$offset, $count], 'order' => [$shuffle ? 'name' : 'RAND()']]
485 * Counts the number of contacts that both provided public contacts have interacted with at least once.
486 * Interactions include follows and likes and comments on public posts.
488 * @param int $sourceId Public contact id
489 * @param int $targetId Public contact id
490 * @param array $condition Additional condition array on the contact table
494 public static function countCommon(int $sourceId, int $targetId, array $condition = [])
496 $condition = DBA::mergeConditions($condition,
497 ['`id` IN (SELECT `relation-cid` FROM `contact-relation` WHERE `cid` = ?)
498 AND `id` IN (SELECT `relation-cid` FROM `contact-relation` WHERE `cid` = ?)',
499 $sourceId, $targetId]
502 return DI::dba()->count('contact', $condition);
506 * Returns a paginated list of contacts that both provided public contacts have interacted with at least once.
507 * Interactions include follows and likes and comments on public posts.
509 * @param int $sourceId Public contact id
510 * @param int $targetId Public contact id
511 * @param array $condition Additional condition on the contact table
514 * @param bool $shuffle
518 public static function listCommon(int $sourceId, int $targetId, array $condition = [], int $count = 30, int $offset = 0, bool $shuffle = false)
520 $condition = DBA::mergeConditions($condition,
521 ["`id` IN (SELECT `relation-cid` FROM `contact-relation` WHERE `cid` = ?)
522 AND `id` IN (SELECT `relation-cid` FROM `contact-relation` WHERE `cid` = ?)",
523 $sourceId, $targetId]
526 return DI::dba()->selectToArray('contact', [], $condition,
527 ['limit' => [$offset, $count], 'order' => [$shuffle ? 'name' : 'RAND()']]
532 * Counts the number of contacts that are followed by both provided public contacts.
534 * @param int $sourceId Public contact id
535 * @param int $targetId Public contact id
536 * @param array $condition Additional condition array on the contact table
540 public static function countCommonFollows(int $sourceId, int $targetId, array $condition = [])
542 $condition = DBA::mergeConditions($condition,
543 ['`id` IN (SELECT `relation-cid` FROM `contact-relation` WHERE `cid` = ? AND `follows`)
544 AND `id` IN (SELECT `relation-cid` FROM `contact-relation` WHERE `cid` = ? AND `follows`)',
545 $sourceId, $targetId]
548 return DI::dba()->count('contact', $condition);
552 * Returns a paginated list of contacts that are followed by both provided public contacts.
554 * @param int $sourceId Public contact id
555 * @param int $targetId Public contact id
556 * @param array $condition Additional condition array on the contact table
559 * @param bool $shuffle
563 public static function listCommonFollows(int $sourceId, int $targetId, array $condition = [], int $count = 30, int $offset = 0, bool $shuffle = false)
565 $condition = DBA::mergeConditions($condition,
566 ["`id` IN (SELECT `relation-cid` FROM `contact-relation` WHERE `cid` = ? AND `follows`)
567 AND `id` IN (SELECT `relation-cid` FROM `contact-relation` WHERE `cid` = ? AND `follows`)",
568 $sourceId, $targetId]
571 return DI::dba()->selectToArray('contact', [], $condition,
572 ['limit' => [$offset, $count], 'order' => [$shuffle ? 'name' : 'RAND()']]
577 * Counts the number of contacts that follow both provided public contacts.
579 * @param int $sourceId Public contact id
580 * @param int $targetId Public contact id
581 * @param array $condition Additional condition on the contact table
585 public static function countCommonFollowers(int $sourceId, int $targetId, array $condition = [])
587 $condition = DBA::mergeConditions($condition,
588 ["`id` IN (SELECT `cid` FROM `contact-relation` WHERE `relation-cid` = ? AND `follows`)
589 AND `id` IN (SELECT `cid` FROM `contact-relation` WHERE `relation-cid` = ? AND `follows`)",
590 $sourceId, $targetId]
593 return DI::dba()->count('contact', $condition);
597 * Returns a paginated list of contacts that follow both provided public contacts.
599 * @param int $sourceId Public contact id
600 * @param int $targetId Public contact id
601 * @param array $condition Additional condition on the contact table
604 * @param bool $shuffle
608 public static function listCommonFollowers(int $sourceId, int $targetId, array $condition = [], int $count = 30, int $offset = 0, bool $shuffle = false)
610 $condition = DBA::mergeConditions($condition,
611 ["`id` IN (SELECT `cid` FROM `contact-relation` WHERE `relation-cid` = ? AND `follows`)
612 AND `id` IN (SELECT `cid` FROM `contact-relation` WHERE `relation-cid` = ? AND `follows`)",
613 $sourceId, $targetId]
616 return DI::dba()->selectToArray('contact', [], $condition,
617 ['limit' => [$offset, $count], 'order' => [$shuffle ? 'name' : 'RAND()']]