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\Model;
24 use Friendica\App\BaseURL;
25 use Friendica\Content\Pager;
26 use Friendica\Content\Text\HTML;
27 use Friendica\Core\Hook;
28 use Friendica\Core\Logger;
29 use Friendica\Core\Protocol;
30 use Friendica\Core\Renderer;
31 use Friendica\Core\Session;
32 use Friendica\Core\System;
33 use Friendica\Core\Worker;
34 use Friendica\Database\Database;
35 use Friendica\Database\DBA;
37 use Friendica\Network\HTTPException;
38 use Friendica\Network\Probe;
39 use Friendica\Protocol\Activity;
40 use Friendica\Protocol\ActivityPub;
41 use Friendica\Protocol\DFRN;
42 use Friendica\Protocol\Diaspora;
43 use Friendica\Protocol\OStatus;
44 use Friendica\Protocol\Salmon;
45 use Friendica\Util\DateTimeFormat;
46 use Friendica\Util\Images;
47 use Friendica\Util\Network;
48 use Friendica\Util\Proxy;
49 use Friendica\Util\Strings;
52 * functions for interacting with a contact
56 const DEFAULT_AVATAR_PHOTO = '/images/person-300.jpg';
57 const DEFAULT_AVATAR_THUMB = '/images/person-80.jpg';
58 const DEFAULT_AVATAR_MICRO = '/images/person-48.jpg';
61 * @deprecated since version 2019.03
62 * @see User::PAGE_FLAGS_NORMAL
64 const PAGE_NORMAL = User::PAGE_FLAGS_NORMAL;
66 * @deprecated since version 2019.03
67 * @see User::PAGE_FLAGS_SOAPBOX
69 const PAGE_SOAPBOX = User::PAGE_FLAGS_SOAPBOX;
71 * @deprecated since version 2019.03
72 * @see User::PAGE_FLAGS_COMMUNITY
74 const PAGE_COMMUNITY = User::PAGE_FLAGS_COMMUNITY;
76 * @deprecated since version 2019.03
77 * @see User::PAGE_FLAGS_FREELOVE
79 const PAGE_FREELOVE = User::PAGE_FLAGS_FREELOVE;
81 * @deprecated since version 2019.03
82 * @see User::PAGE_FLAGS_BLOG
84 const PAGE_BLOG = User::PAGE_FLAGS_BLOG;
86 * @deprecated since version 2019.03
87 * @see User::PAGE_FLAGS_PRVGROUP
89 const PAGE_PRVGROUP = User::PAGE_FLAGS_PRVGROUP;
94 const LOCK_INSERT = 'contact-insert';
99 * TYPE_UNKNOWN - unknown type
101 * TYPE_PERSON - the account belongs to a person
102 * Associated page types: PAGE_NORMAL, PAGE_SOAPBOX, PAGE_FREELOVE
104 * TYPE_ORGANISATION - the account belongs to an organisation
105 * Associated page type: PAGE_SOAPBOX
107 * TYPE_NEWS - the account is a news reflector
108 * Associated page type: PAGE_SOAPBOX
110 * TYPE_COMMUNITY - the account is community forum
111 * Associated page types: PAGE_COMMUNITY, PAGE_PRVGROUP
113 * TYPE_RELAY - the account is a relay
114 * This will only be assigned to contacts, not to user accounts
117 const TYPE_UNKNOWN = -1;
118 const TYPE_PERSON = User::ACCOUNT_TYPE_PERSON;
119 const TYPE_ORGANISATION = User::ACCOUNT_TYPE_ORGANISATION;
120 const TYPE_NEWS = User::ACCOUNT_TYPE_NEWS;
121 const TYPE_COMMUNITY = User::ACCOUNT_TYPE_COMMUNITY;
122 const TYPE_RELAY = User::ACCOUNT_TYPE_RELAY;
141 const MIRROR_DEACTIVATED = 0;
142 const MIRROR_FORWARDED = 1;
143 const MIRROR_OWN_POST = 2;
144 const MIRROR_NATIVE_RESHARE = 3;
147 * @param array $fields Array of selected fields, empty for all
148 * @param array $condition Array of fields for condition
149 * @param array $params Array of several parameters
153 public static function selectToArray(array $fields = [], array $condition = [], array $params = [])
155 return DBA::selectToArray('contact', $fields, $condition, $params);
159 * @param array $fields Array of selected fields, empty for all
160 * @param array $condition Array of fields for condition
161 * @param array $params Array of several parameters
165 public static function selectFirst(array $fields = [], array $condition = [], array $params = [])
167 $contact = DBA::selectFirst('contact', $fields, $condition, $params);
173 * Insert a row into the contact table
174 * Important: You can't use DBA::lastInsertId() after this call since it will be set to 0.
176 * @param array $fields field array
177 * @param int $duplicate_mode Do an update on a duplicate entry
179 * @return boolean was the insert successful?
182 public static function insert(array $fields, int $duplicate_mode = Database::INSERT_DEFAULT)
184 if (!empty($fields['baseurl']) && empty($fields['gsid'])) {
185 $fields['gsid'] = GServer::getID($fields['baseurl'], true);
188 if (empty($fields['created'])) {
189 $fields['created'] = DateTimeFormat::utcNow();
192 $ret = DBA::insert('contact', $fields, $duplicate_mode);
193 $contact = DBA::selectFirst('contact', ['nurl', 'uid'], ['id' => DBA::lastInsertId()]);
194 if (!DBA::isResult($contact)) {
199 // Search for duplicated contacts and get rid of them
200 self::removeDuplicates($contact['nurl'], $contact['uid']);
206 * @param integer $id Contact ID
207 * @param array $fields Array of selected fields, empty for all
208 * @return array|boolean Contact record if it exists, false otherwise
211 public static function getById($id, $fields = [])
213 return DBA::selectFirst('contact', $fields, ['id' => $id]);
217 * Fetches a contact by a given url
219 * @param string $url profile url
220 * @param boolean $update true = always update, false = never update, null = update when not found or outdated
221 * @param array $fields Field list
222 * @param integer $uid User ID of the contact
223 * @return array contact array
225 public static function getByURL(string $url, $update = null, array $fields = [], int $uid = 0)
227 if ($update || is_null($update)) {
228 $cid = self::getIdForURL($url, $uid, $update);
233 $contact = self::getById($cid, $fields);
234 if (empty($contact)) {
240 // Add internal fields
242 if (!empty($fields)) {
243 foreach (['id', 'avatar', 'created', 'updated', 'last-update', 'success_update', 'failure_update', 'network'] as $internal) {
244 if (!in_array($internal, $fields)) {
245 $fields[] = $internal;
246 $removal[] = $internal;
251 // We first try the nurl (http://server.tld/nick), most common case
252 $options = ['order' => ['id']];
253 $contact = DBA::selectFirst('contact', $fields, ['nurl' => Strings::normaliseLink($url), 'uid' => $uid, 'deleted' => false], $options);
255 // Then the addr (nick@server.tld)
256 if (!DBA::isResult($contact)) {
257 $contact = DBA::selectFirst('contact', $fields, ['addr' => str_replace('acct:', '', $url), 'uid' => $uid, 'deleted' => false], $options);
260 // Then the alias (which could be anything)
261 if (!DBA::isResult($contact)) {
262 // The link could be provided as http although we stored it as https
263 $ssl_url = str_replace('http://', 'https://', $url);
264 $condition = ['`alias` IN (?, ?, ?) AND `uid` = ? AND NOT `deleted`', $url, Strings::normaliseLink($url), $ssl_url, $uid];
265 $contact = DBA::selectFirst('contact', $fields, $condition, $options);
268 if (!DBA::isResult($contact)) {
272 // Update the contact in the background if needed
273 $updated = max($contact['success_update'], $contact['created'], $contact['updated'], $contact['last-update'], $contact['failure_update']);
274 if (($updated < DateTimeFormat::utc('now -7 days')) && in_array($contact['network'], Protocol::FEDERATED) && !self::isLocalById($contact['id'])) {
275 Worker::add(PRIORITY_LOW, "UpdateContact", $contact['id']);
278 // Remove the internal fields
279 foreach ($removal as $internal) {
280 unset($contact[$internal]);
287 * Fetches a contact for a given user by a given url.
288 * In difference to "getByURL" the function will fetch a public contact when no user contact had been found.
290 * @param string $url profile url
291 * @param integer $uid User ID of the contact
292 * @param boolean $update true = always update, false = never update, null = update when not found or outdated
293 * @param array $fields Field list
294 * @return array contact array
296 public static function getByURLForUser(string $url, int $uid = 0, $update = false, array $fields = [])
299 $contact = self::getByURL($url, $update, $fields, $uid);
300 if (!empty($contact)) {
301 if (!empty($contact['id'])) {
302 $contact['cid'] = $contact['id'];
309 $contact = self::getByURL($url, $update, $fields);
310 if (!empty($contact['id'])) {
312 $contact['zid'] = $contact['id'];
318 * Tests if the given contact is a follower
320 * @param int $cid Either public contact id or user's contact id
321 * @param int $uid User ID
323 * @return boolean is the contact id a follower?
324 * @throws HTTPException\InternalServerErrorException
325 * @throws \ImagickException
327 public static function isFollower($cid, $uid)
329 if (Contact\User::isBlocked($cid, $uid)) {
333 $cdata = self::getPublicAndUserContacID($cid, $uid);
334 if (empty($cdata['user'])) {
338 $condition = ['id' => $cdata['user'], 'rel' => [self::FOLLOWER, self::FRIEND]];
339 return DBA::exists('contact', $condition);
343 * Tests if the given contact url is a follower
345 * @param string $url Contact URL
346 * @param int $uid User ID
348 * @return boolean is the contact id a follower?
349 * @throws HTTPException\InternalServerErrorException
350 * @throws \ImagickException
352 public static function isFollowerByURL($url, $uid)
354 $cid = self::getIdForURL($url, $uid);
360 return self::isFollower($cid, $uid);
364 * Tests if the given user follow the given contact
366 * @param int $cid Either public contact id or user's contact id
367 * @param int $uid User ID
369 * @return boolean is the contact url being followed?
370 * @throws HTTPException\InternalServerErrorException
371 * @throws \ImagickException
373 public static function isSharing($cid, $uid)
375 if (Contact\User::isBlocked($cid, $uid)) {
379 $cdata = self::getPublicAndUserContacID($cid, $uid);
380 if (empty($cdata['user'])) {
384 $condition = ['id' => $cdata['user'], 'rel' => [self::SHARING, self::FRIEND]];
385 return DBA::exists('contact', $condition);
389 * Tests if the given user follow the given contact url
391 * @param string $url Contact URL
392 * @param int $uid User ID
394 * @return boolean is the contact url being followed?
395 * @throws HTTPException\InternalServerErrorException
396 * @throws \ImagickException
398 public static function isSharingByURL($url, $uid)
400 $cid = self::getIdForURL($url, $uid);
406 return self::isSharing($cid, $uid);
410 * Get the basepath for a given contact link
412 * @param string $url The contact link
413 * @param boolean $dont_update Don't update the contact
415 * @return string basepath
416 * @throws HTTPException\InternalServerErrorException
417 * @throws \ImagickException
419 public static function getBasepath($url, $dont_update = false)
421 $contact = DBA::selectFirst('contact', ['id', 'baseurl'], ['uid' => 0, 'nurl' => Strings::normaliseLink($url)]);
422 if (!DBA::isResult($contact)) {
426 if (!empty($contact['baseurl'])) {
427 return $contact['baseurl'];
428 } elseif ($dont_update) {
432 // Update the existing contact
433 self::updateFromProbe($contact['id']);
435 // And fetch the result
436 $contact = DBA::selectFirst('contact', ['baseurl'], ['id' => $contact['id']]);
437 if (empty($contact['baseurl'])) {
438 Logger::info('No baseurl for contact', ['url' => $url]);
442 Logger::info('Found baseurl for contact', ['url' => $url, 'baseurl' => $contact['baseurl']]);
443 return $contact['baseurl'];
447 * Check if the given contact url is on the same server
449 * @param string $url The contact link
451 * @return boolean Is it the same server?
453 public static function isLocal($url)
455 return Strings::compareLink(self::getBasepath($url, true), DI::baseUrl());
459 * Check if the given contact ID is on the same server
461 * @param string $url The contact link
463 * @return boolean Is it the same server?
465 public static function isLocalById(int $cid)
467 $contact = DBA::selectFirst('contact', ['url', 'baseurl'], ['id' => $cid]);
468 if (!DBA::isResult($contact)) {
472 if (empty($contact['baseurl'])) {
473 $baseurl = self::getBasepath($contact['url'], true);
475 $baseurl = $contact['baseurl'];
478 return Strings::compareLink($baseurl, DI::baseUrl());
482 * Returns the public contact id of the given user id
484 * @param integer $uid User ID
486 * @return integer|boolean Public contact id for given user id
489 public static function getPublicIdByUserId($uid)
491 $self = DBA::selectFirst('contact', ['url'], ['self' => true, 'uid' => $uid]);
492 if (!DBA::isResult($self)) {
495 return self::getIdForURL($self['url']);
499 * Returns the contact id for the user and the public contact id for a given contact id
501 * @param int $cid Either public contact id or user's contact id
502 * @param int $uid User ID
504 * @return array with public and user's contact id
505 * @throws HTTPException\InternalServerErrorException
506 * @throws \ImagickException
508 public static function getPublicAndUserContacID($cid, $uid)
510 if (empty($uid) || empty($cid)) {
514 $contact = DBA::selectFirst('contact', ['id', 'uid', 'url'], ['id' => $cid]);
515 if (!DBA::isResult($contact)) {
519 // We quit when the user id don't match the user id of the provided contact
520 if (($contact['uid'] != $uid) && ($contact['uid'] != 0)) {
524 if ($contact['uid'] != 0) {
525 $pcid = self::getIdForURL($contact['url'], 0, false, ['url' => $contact['url']]);
529 $ucid = $contact['id'];
531 $pcid = $contact['id'];
532 $ucid = self::getIdForURL($contact['url'], $uid);
535 return ['public' => $pcid, 'user' => $ucid];
539 * Returns contact details for a given contact id in combination with a user id
541 * @param int $cid A contact ID
542 * @param int $uid The User ID
543 * @param array $fields The selected fields for the contact
545 * @return array The contact details
549 public static function getContactForUser($cid, $uid, array $fields = [])
551 $contact = DBA::selectFirst('contact', $fields, ['id' => $cid, 'uid' => $uid]);
553 if (!DBA::isResult($contact)) {
561 * Creates the self-contact for the provided user id
564 * @return bool Operation success
565 * @throws HTTPException\InternalServerErrorException
567 public static function createSelfFromUserId($uid)
569 $user = DBA::selectFirst('user', ['uid', 'username', 'nickname', 'pubkey', 'prvkey'],
570 ['uid' => $uid, 'account_expired' => false]);
571 if (!DBA::isResult($user)) {
576 'uid' => $user['uid'],
577 'created' => DateTimeFormat::utcNow(),
579 'name' => $user['username'],
580 'nick' => $user['nickname'],
581 'pubkey' => $user['pubkey'],
582 'prvkey' => $user['prvkey'],
583 'photo' => DI::baseUrl() . '/photo/profile/' . $user['uid'] . '.jpg',
584 'thumb' => DI::baseUrl() . '/photo/avatar/' . $user['uid'] . '.jpg',
585 'micro' => DI::baseUrl() . '/photo/micro/' . $user['uid'] . '.jpg',
588 'url' => DI::baseUrl() . '/profile/' . $user['nickname'],
589 'nurl' => Strings::normaliseLink(DI::baseUrl() . '/profile/' . $user['nickname']),
590 'addr' => $user['nickname'] . '@' . substr(DI::baseUrl(), strpos(DI::baseUrl(), '://') + 3),
591 'request' => DI::baseUrl() . '/dfrn_request/' . $user['nickname'],
592 'notify' => DI::baseUrl() . '/dfrn_notify/' . $user['nickname'],
593 'poll' => DI::baseUrl() . '/dfrn_poll/' . $user['nickname'],
594 'confirm' => DI::baseUrl() . '/dfrn_confirm/' . $user['nickname'],
595 'poco' => DI::baseUrl() . '/poco/' . $user['nickname'],
596 'name-date' => DateTimeFormat::utcNow(),
597 'uri-date' => DateTimeFormat::utcNow(),
598 'avatar-date' => DateTimeFormat::utcNow(),
604 // Only create the entry if it doesn't exist yet
605 if (!DBA::exists('contact', ['uid' => $uid, 'self' => true])) {
606 $return = DBA::insert('contact', $contact);
609 // Create the public contact
610 if (!DBA::exists('contact', ['nurl' => $contact['nurl'], 'uid' => 0])) {
611 $contact['self'] = false;
613 $contact['prvkey'] = null;
615 DBA::insert('contact', $contact, Database::INSERT_IGNORE);
622 * Updates the self-contact for the provided user id
625 * @param boolean $update_avatar Force the avatar update
626 * @throws HTTPException\InternalServerErrorException
628 public static function updateSelfFromUserID($uid, $update_avatar = false)
630 $fields = ['id', 'name', 'nick', 'location', 'about', 'keywords', 'avatar', 'prvkey', 'pubkey',
631 'xmpp', 'contact-type', 'forum', 'prv', 'avatar-date', 'url', 'nurl', 'unsearchable',
632 'photo', 'thumb', 'micro', 'addr', 'request', 'notify', 'poll', 'confirm', 'poco'];
633 $self = DBA::selectFirst('contact', $fields, ['uid' => $uid, 'self' => true]);
634 if (!DBA::isResult($self)) {
638 $fields = ['nickname', 'page-flags', 'account-type', 'prvkey', 'pubkey'];
639 $user = DBA::selectFirst('user', $fields, ['uid' => $uid, 'account_expired' => false]);
640 if (!DBA::isResult($user)) {
644 $fields = ['name', 'photo', 'thumb', 'about', 'address', 'locality', 'region',
645 'country-name', 'pub_keywords', 'xmpp', 'net-publish'];
646 $profile = DBA::selectFirst('profile', $fields, ['uid' => $uid]);
647 if (!DBA::isResult($profile)) {
651 $file_suffix = 'jpg';
653 $fields = ['name' => $profile['name'], 'nick' => $user['nickname'],
654 'avatar-date' => $self['avatar-date'], 'location' => Profile::formatLocation($profile),
655 'about' => $profile['about'], 'keywords' => $profile['pub_keywords'],
656 'contact-type' => $user['account-type'], 'prvkey' => $user['prvkey'],
657 'pubkey' => $user['pubkey'], 'xmpp' => $profile['xmpp']];
659 // it seems as if ported accounts can have wrong values, so we make sure that now everything is fine.
660 $fields['url'] = DI::baseUrl() . '/profile/' . $user['nickname'];
661 $fields['nurl'] = Strings::normaliseLink($fields['url']);
662 $fields['addr'] = $user['nickname'] . '@' . substr(DI::baseUrl(), strpos(DI::baseUrl(), '://') + 3);
663 $fields['request'] = DI::baseUrl() . '/dfrn_request/' . $user['nickname'];
664 $fields['notify'] = DI::baseUrl() . '/dfrn_notify/' . $user['nickname'];
665 $fields['poll'] = DI::baseUrl() . '/dfrn_poll/'. $user['nickname'];
666 $fields['confirm'] = DI::baseUrl() . '/dfrn_confirm/' . $user['nickname'];
667 $fields['poco'] = DI::baseUrl() . '/poco/' . $user['nickname'];
669 $avatar = Photo::selectFirst(['resource-id', 'type'], ['uid' => $uid, 'profile' => true]);
670 if (DBA::isResult($avatar)) {
671 if ($update_avatar) {
672 $fields['avatar-date'] = DateTimeFormat::utcNow();
675 // Creating the path to the avatar, beginning with the file suffix
676 $types = Images::supportedTypes();
677 if (isset($types[$avatar['type']])) {
678 $file_suffix = $types[$avatar['type']];
681 // We are adding a timestamp value so that other systems won't use cached content
682 $timestamp = strtotime($fields['avatar-date']);
684 $prefix = DI::baseUrl() . '/photo/' .$avatar['resource-id'] . '-';
685 $suffix = '.' . $file_suffix . '?ts=' . $timestamp;
687 $fields['photo'] = $prefix . '4' . $suffix;
688 $fields['thumb'] = $prefix . '5' . $suffix;
689 $fields['micro'] = $prefix . '6' . $suffix;
691 // We hadn't found a photo entry, so we use the default avatar
692 $fields['photo'] = self::getDefaultAvatar($fields, Proxy::SIZE_SMALL);
693 $fields['thumb'] = self::getDefaultAvatar($fields, Proxy::SIZE_THUMB);
694 $fields['micro'] = self::getDefaultAvatar($fields, Proxy::SIZE_MICRO);
697 $fields['avatar'] = DI::baseUrl() . '/photo/profile/' .$uid . '.' . $file_suffix;
698 $fields['forum'] = $user['page-flags'] == User::PAGE_FLAGS_COMMUNITY;
699 $fields['prv'] = $user['page-flags'] == User::PAGE_FLAGS_PRVGROUP;
700 $fields['unsearchable'] = !$profile['net-publish'];
704 foreach ($fields as $field => $content) {
705 if ($self[$field] != $content) {
711 if ($fields['name'] != $self['name']) {
712 $fields['name-date'] = DateTimeFormat::utcNow();
714 $fields['updated'] = DateTimeFormat::utcNow();
715 DBA::update('contact', $fields, ['id' => $self['id']]);
717 // Update the public contact as well
718 $fields['prvkey'] = null;
719 $fields['self'] = false;
720 DBA::update('contact', $fields, ['uid' => 0, 'nurl' => $self['nurl']]);
722 // Update the profile
723 $fields = ['photo' => DI::baseUrl() . '/photo/profile/' .$uid . '.' . $file_suffix,
724 'thumb' => DI::baseUrl() . '/photo/avatar/' . $uid .'.' . $file_suffix];
725 DBA::update('profile', $fields, ['uid' => $uid]);
730 * Marks a contact for removal
732 * @param int $id contact id
734 * @throws HTTPException\InternalServerErrorException
736 public static function remove($id)
738 // We want just to make sure that we don't delete our "self" contact
739 $contact = DBA::selectFirst('contact', ['uid'], ['id' => $id, 'self' => false]);
740 if (!DBA::isResult($contact)) {
744 // Archive the contact
745 DBA::update('contact', ['archive' => true, 'network' => Protocol::PHANTOM, 'deleted' => true], ['id' => $id]);
747 // Delete it in the background
748 Worker::add(PRIORITY_MEDIUM, 'RemoveContact', $id);
752 * Sends an unfriend message. Does not remove the contact
754 * @param array $user User unfriending
755 * @param array $contact Contact unfriended
756 * @param boolean $dissolve Remove the contact on the remote side
758 * @throws HTTPException\InternalServerErrorException
759 * @throws \ImagickException
761 public static function terminateFriendship(array $user, array $contact, $dissolve = false)
763 if (empty($contact['network'])) {
767 $protocol = $contact['network'];
768 if (($protocol == Protocol::DFRN) && !self::isLegacyDFRNContact($contact)) {
769 $protocol = Protocol::ACTIVITYPUB;
772 if (($protocol == Protocol::DFRN) && $dissolve) {
773 DFRN::deliver($user, $contact, 'placeholder', true);
774 } elseif (in_array($protocol, [Protocol::OSTATUS, Protocol::DFRN])) {
775 // create an unfollow slap
777 $item['verb'] = Activity::O_UNFOLLOW;
778 $item['gravity'] = GRAVITY_ACTIVITY;
779 $item['follow'] = $contact["url"];
784 $slap = OStatus::salmon($item, $user);
786 if (!empty($contact['notify'])) {
787 Salmon::slapper($user, $contact['notify'], $slap);
789 } elseif ($protocol == Protocol::DIASPORA) {
790 Diaspora::sendUnshare($user, $contact);
791 } elseif ($protocol == Protocol::ACTIVITYPUB) {
792 ActivityPub\Transmitter::sendContactUndo($contact['url'], $contact['id'], $user['uid']);
795 ActivityPub\Transmitter::sendContactReject($contact['url'], $contact['hub-verify'], $user['uid']);
801 * Marks a contact for archival after a communication issue delay
803 * Contact has refused to recognise us as a friend. We will start a countdown.
804 * If they still don't recognise us in 32 days, the relationship is over,
805 * and we won't waste any more time trying to communicate with them.
806 * This provides for the possibility that their database is temporarily messed
807 * up or some other transient event and that there's a possibility we could recover from it.
809 * @param array $contact contact to mark for archival
811 * @throws HTTPException\InternalServerErrorException
813 public static function markForArchival(array $contact)
815 if (!isset($contact['url']) && !empty($contact['id'])) {
816 $fields = ['id', 'url', 'archive', 'self', 'term-date'];
817 $contact = DBA::selectFirst('contact', $fields, ['id' => $contact['id']]);
818 if (!DBA::isResult($contact)) {
821 } elseif (!isset($contact['url'])) {
822 Logger::info('Empty contact', ['contact' => $contact, 'callstack' => System::callstack(20)]);
825 Logger::info('Contact is marked for archival', ['id' => $contact['id'], 'term-date' => $contact['term-date']]);
827 // Contact already archived or "self" contact? => nothing to do
828 if ($contact['archive'] || $contact['self']) {
832 if ($contact['term-date'] <= DBA::NULL_DATETIME) {
833 DBA::update('contact', ['term-date' => DateTimeFormat::utcNow()], ['id' => $contact['id']]);
834 DBA::update('contact', ['term-date' => DateTimeFormat::utcNow()], ['`nurl` = ? AND `term-date` <= ? AND NOT `self`', Strings::normaliseLink($contact['url']), DBA::NULL_DATETIME]);
837 * We really should send a notification to the owner after 2-3 weeks
838 * so they won't be surprised when the contact vanishes and can take
839 * remedial action if this was a serious mistake or glitch
842 /// @todo Check for contact vitality via probing
843 $archival_days = DI::config()->get('system', 'archival_days', 32);
845 $expiry = $contact['term-date'] . ' + ' . $archival_days . ' days ';
846 if (DateTimeFormat::utcNow() > DateTimeFormat::utc($expiry)) {
847 /* Relationship is really truly dead. archive them rather than
848 * delete, though if the owner tries to unarchive them we'll start
849 * the whole process over again.
851 DBA::update('contact', ['archive' => true], ['id' => $contact['id']]);
852 DBA::update('contact', ['archive' => true], ['nurl' => Strings::normaliseLink($contact['url']), 'self' => false]);
858 * Cancels the archival countdown
860 * @see Contact::markForArchival()
862 * @param array $contact contact to be unmarked for archival
866 public static function unmarkForArchival(array $contact)
868 // Always unarchive the relay contact entry
869 if (!empty($contact['batch']) && !empty($contact['term-date']) && ($contact['term-date'] > DBA::NULL_DATETIME)) {
870 $fields = ['failed' => false, 'term-date' => DBA::NULL_DATETIME, 'archive' => false];
871 $condition = ['uid' => 0, 'network' => Protocol::FEDERATED, 'batch' => $contact['batch'], 'contact-type' => self::TYPE_RELAY];
872 if (!DBA::exists('contact', array_merge($condition, $fields))) {
873 DBA::update('contact', $fields, $condition);
877 $condition = ['`id` = ? AND (`term-date` > ? OR `archive`)', $contact['id'], DBA::NULL_DATETIME];
878 $exists = DBA::exists('contact', $condition);
880 // We don't need to update, we never marked this contact for archival
885 Logger::info('Contact is marked as vital again', ['id' => $contact['id'], 'term-date' => $contact['term-date']]);
887 if (!isset($contact['url']) && !empty($contact['id'])) {
888 $fields = ['id', 'url', 'batch'];
889 $contact = DBA::selectFirst('contact', $fields, ['id' => $contact['id']]);
890 if (!DBA::isResult($contact)) {
895 // It's a miracle. Our dead contact has inexplicably come back to life.
896 $fields = ['failed' => false, 'term-date' => DBA::NULL_DATETIME, 'archive' => false];
897 DBA::update('contact', $fields, ['id' => $contact['id']]);
898 DBA::update('contact', $fields, ['nurl' => Strings::normaliseLink($contact['url']), 'self' => false]);
902 * Returns the data array for the photo menu of a given contact
904 * @param array $contact contact
905 * @param int $uid optional, default 0
907 * @throws HTTPException\InternalServerErrorException
908 * @throws \ImagickException
910 public static function photoMenu(array $contact, $uid = 0)
915 $contact_drop_link = '';
922 if (empty($contact['uid']) || ($contact['uid'] != $uid)) {
924 $profile_link = self::magicLinkByContact($contact);
925 $menu = ['profile' => [DI::l10n()->t('View Profile'), $profile_link, true]];
930 // Look for our own contact if the uid doesn't match and isn't public
931 $contact_own = DBA::selectFirst('contact', [], ['nurl' => $contact['nurl'], 'network' => $contact['network'], 'uid' => $uid]);
932 if (DBA::isResult($contact_own)) {
933 return self::photoMenu($contact_own, $uid);
938 if (($contact['network'] === Protocol::DFRN) && !$contact['self'] && empty($contact['pending'])) {
940 $profile_link = DI::baseUrl() . '/redir/' . $contact['id'];
942 $profile_link = $contact['url'];
945 if ($profile_link === 'mailbox') {
950 $status_link = $profile_link . '/status';
951 $photos_link = str_replace('/profile/', '/photos/', $profile_link);
952 $profile_link = $profile_link . '/profile';
955 if (self::canReceivePrivateMessages($contact) && empty($contact['pending'])) {
956 $pm_url = DI::baseUrl() . '/message/new/' . $contact['id'];
959 if (($contact['network'] == Protocol::DFRN) && !$contact['self'] && empty($contact['pending'])) {
960 $poke_link = 'contact/' . $contact['id'] . '/poke';
963 $contact_url = DI::baseUrl() . '/contact/' . $contact['id'];
965 $posts_link = DI::baseUrl() . '/contact/' . $contact['id'] . '/conversations';
967 if (!$contact['self']) {
968 $contact_drop_link = DI::baseUrl() . '/contact/' . $contact['id'] . '/drop?confirm=1';
973 if (!$contact['self'] && in_array($contact['network'], Protocol::NATIVE_SUPPORT)) {
974 if ($contact['uid'] && in_array($contact['rel'], [self::SHARING, self::FRIEND])) {
975 $unfollow_link = 'unfollow?url=' . urlencode($contact['url']) . '&auto=1';
976 } elseif(!$contact['pending']) {
977 $follow_link = 'follow?url=' . urlencode($contact['url']) . '&auto=1';
981 if (!empty($follow_link) || !empty($unfollow_link)) {
982 $contact_drop_link = '';
987 * "name" => [ "Label", "link", (bool)Should the link opened in a new tab? ]
989 if (empty($contact['uid'])) {
991 'profile' => [DI::l10n()->t('View Profile') , $profile_link , true],
992 'network' => [DI::l10n()->t('Network Posts') , $posts_link , false],
993 'edit' => [DI::l10n()->t('View Contact') , $contact_url , false],
994 'follow' => [DI::l10n()->t('Connect/Follow'), $follow_link , true],
995 'unfollow'=> [DI::l10n()->t('UnFollow') , $unfollow_link, true],
999 'status' => [DI::l10n()->t('View Status') , $status_link , true],
1000 'profile' => [DI::l10n()->t('View Profile') , $profile_link , true],
1001 'photos' => [DI::l10n()->t('View Photos') , $photos_link , true],
1002 'network' => [DI::l10n()->t('Network Posts') , $posts_link , false],
1003 'edit' => [DI::l10n()->t('View Contact') , $contact_url , false],
1004 'drop' => [DI::l10n()->t('Drop Contact') , $contact_drop_link, false],
1005 'pm' => [DI::l10n()->t('Send PM') , $pm_url , false],
1006 'poke' => [DI::l10n()->t('Poke') , $poke_link , false],
1007 'follow' => [DI::l10n()->t('Connect/Follow'), $follow_link , true],
1008 'unfollow'=> [DI::l10n()->t('UnFollow') , $unfollow_link , true],
1011 if (!empty($contact['pending'])) {
1012 $intro = DBA::selectFirst('intro', ['id'], ['contact-id' => $contact['id']]);
1013 if (DBA::isResult($intro)) {
1014 $menu['follow'] = [DI::l10n()->t('Approve'), 'notifications/intros/' . $intro['id'], true];
1019 $args = ['contact' => $contact, 'menu' => &$menu];
1021 Hook::callAll('contact_photo_menu', $args);
1023 $menucondensed = [];
1025 foreach ($menu as $menuname => $menuitem) {
1026 if ($menuitem[1] != '') {
1027 $menucondensed[$menuname] = $menuitem;
1031 return $menucondensed;
1035 * Fetch the contact id for a given URL and user
1037 * First lookup in the contact table to find a record matching either `url`, `nurl`,
1038 * `addr` or `alias`.
1040 * If there's no record and we aren't looking for a public contact, we quit.
1041 * If there's one, we check that it isn't time to update the picture else we
1042 * directly return the found contact id.
1044 * Second, we probe the provided $url whether it's http://server.tld/profile or
1045 * nick@server.tld. We quit if we can't get any info back.
1047 * Third, we create the contact record if it doesn't exist
1049 * Fourth, we update the existing record with the new data (avatar, alias, nick)
1050 * if there's any updates
1052 * @param string $url Contact URL
1053 * @param integer $uid The user id for the contact (0 = public contact)
1054 * @param boolean $update true = always update, false = never update, null = update when not found
1055 * @param array $default Default value for creating the contact when everything else fails
1057 * @return integer Contact ID
1058 * @throws HTTPException\InternalServerErrorException
1059 * @throws \ImagickException
1061 public static function getIdForURL($url, $uid = 0, $update = null, $default = [])
1066 Logger::notice('Empty url, quitting', ['url' => $url, 'user' => $uid, 'default' => $default]);
1070 $contact = self::getByURL($url, false, ['id', 'network'], $uid);
1072 if (!empty($contact)) {
1073 $contact_id = $contact["id"];
1075 if (empty($update)) {
1076 Logger::debug('Contact found', ['url' => $url, 'uid' => $uid, 'update' => $update, 'cid' => $contact_id]);
1079 } elseif ($uid != 0) {
1080 Logger::debug('Contact does not exist for the user', ['url' => $url, 'uid' => $uid, 'update' => $update]);
1082 } elseif (empty($default) && !is_null($update) && !$update) {
1083 Logger::info('Contact not found, update not desired', ['url' => $url, 'uid' => $uid, 'update' => $update]);
1089 if (empty($default['network']) || $update) {
1090 $data = Probe::uri($url, "", $uid);
1092 // Take the default values when probing failed
1093 if (!empty($default) && !in_array($data["network"], array_merge(Protocol::NATIVE_SUPPORT, [Protocol::PUMPIO]))) {
1094 $data = array_merge($data, $default);
1096 } elseif (!empty($default['network'])) {
1100 if (($uid == 0) && (empty($data['network']) || ($data['network'] == Protocol::PHANTOM))) {
1101 // Fetch data for the public contact via the first found personal contact
1102 /// @todo Check if this case can happen at all (possibly with mail accounts?)
1103 $fields = ['name', 'nick', 'url', 'addr', 'alias', 'avatar', 'contact-type',
1104 'keywords', 'location', 'about', 'unsearchable', 'batch', 'notify', 'poll',
1105 'request', 'confirm', 'poco', 'subscribe', 'network', 'baseurl', 'gsid'];
1107 $personal_contact = DBA::selectFirst('contact', $fields, ["`addr` = ? AND `uid` != 0", $url]);
1108 if (!DBA::isResult($personal_contact)) {
1109 $personal_contact = DBA::selectFirst('contact', $fields, ["`nurl` = ? AND `uid` != 0", Strings::normaliseLink($url)]);
1112 if (DBA::isResult($personal_contact)) {
1113 Logger::info('Take contact data from personal contact', ['url' => $url, 'update' => $update, 'contact' => $personal_contact, 'callstack' => System::callstack(20)]);
1114 $data = $personal_contact;
1115 $data['photo'] = $personal_contact['avatar'];
1116 $data['account-type'] = $personal_contact['contact-type'];
1117 $data['hide'] = $personal_contact['unsearchable'];
1118 unset($data['avatar']);
1119 unset($data['contact-type']);
1120 unset($data['unsearchable']);
1124 if (empty($data['network']) || ($data['network'] == Protocol::PHANTOM)) {
1125 Logger::notice('No valid network found', ['url' => $url, 'uid' => $uid, 'default' => $default, 'update' => $update, 'callstack' => System::callstack(20)]);
1130 $urls = [Strings::normaliseLink($url), Strings::normaliseLink($data['url'])];
1131 if (!empty($data['alias'])) {
1132 $urls[] = Strings::normaliseLink($data['alias']);
1134 $contact = self::selectFirst(['id'], ['nurl' => $urls, 'uid' => $uid]);
1135 if (!empty($contact['id'])) {
1136 $contact_id = $contact['id'];
1137 Logger::info('Fetched id by url', ['cid' => $contact_id, 'uid' => $uid, 'url' => $url, 'data' => $data]);
1142 // We only insert the basic data. The rest will be done in "updateFromProbeArray"
1145 'url' => $data['url'],
1146 'nurl' => Strings::normaliseLink($data['url']),
1147 'network' => $data['network'],
1148 'created' => DateTimeFormat::utcNow(),
1149 'rel' => self::SHARING,
1155 $condition = ['nurl' => Strings::normaliseLink($data["url"]), 'uid' => $uid, 'deleted' => false];
1157 // Before inserting we do check if the entry does exist now.
1158 if (DI::lock()->acquire(self::LOCK_INSERT, 0)) {
1159 $contact = DBA::selectFirst('contact', ['id'], $condition, ['order' => ['id']]);
1160 if (DBA::isResult($contact)) {
1161 $contact_id = $contact['id'];
1162 Logger::notice('Contact had been created (shortly) before', ['id' => $contact_id, 'url' => $url, 'uid' => $uid]);
1164 DBA::insert('contact', $fields);
1165 $contact_id = DBA::lastInsertId();
1167 Logger::info('Contact inserted', ['id' => $contact_id, 'url' => $url, 'uid' => $uid]);
1170 DI::lock()->release(self::LOCK_INSERT);
1172 Logger::warning('Contact lock had not been acquired');
1176 Logger::info('Contact was not inserted', ['url' => $url, 'uid' => $uid]);
1180 Logger::info('Contact will be updated', ['url' => $url, 'uid' => $uid, 'update' => $update, 'cid' => $contact_id]);
1183 self::updateFromProbeArray($contact_id, $data);
1185 // Don't return a number for a deleted account
1186 if (!empty($data['account-type']) && $data['account-type'] == User::ACCOUNT_TYPE_DELETED) {
1187 Logger::info('Contact is a tombstone', ['url' => $url, 'uid' => $uid]);
1195 * Checks if the contact is archived
1197 * @param int $cid contact id
1199 * @return boolean Is the contact archived?
1200 * @throws HTTPException\InternalServerErrorException
1202 public static function isArchived(int $cid)
1208 $contact = DBA::selectFirst('contact', ['archive', 'url', 'batch'], ['id' => $cid]);
1209 if (!DBA::isResult($contact)) {
1213 if ($contact['archive']) {
1217 // Check status of ActivityPub endpoints
1218 $apcontact = APContact::getByURL($contact['url'], false);
1219 if (!empty($apcontact)) {
1220 if (!empty($apcontact['inbox']) && DBA::exists('inbox-status', ['archive' => true, 'url' => $apcontact['inbox']])) {
1224 if (!empty($apcontact['sharedinbox']) && DBA::exists('inbox-status', ['archive' => true, 'url' => $apcontact['sharedinbox']])) {
1229 // Check status of Diaspora endpoints
1230 if (!empty($contact['batch'])) {
1231 $condition = ['archive' => true, 'uid' => 0, 'network' => Protocol::FEDERATED, 'batch' => $contact['batch'], 'contact-type' => self::TYPE_RELAY];
1232 return DBA::exists('contact', $condition);
1239 * Checks if the contact is blocked
1241 * @param int $cid contact id
1243 * @return boolean Is the contact blocked?
1244 * @throws HTTPException\InternalServerErrorException
1246 public static function isBlocked($cid)
1252 $blocked = DBA::selectFirst('contact', ['blocked', 'url'], ['id' => $cid]);
1253 if (!DBA::isResult($blocked)) {
1257 if (Network::isUrlBlocked($blocked['url'])) {
1261 return (bool) $blocked['blocked'];
1265 * Checks if the contact is hidden
1267 * @param int $cid contact id
1269 * @return boolean Is the contact hidden?
1270 * @throws \Exception
1272 public static function isHidden($cid)
1278 $hidden = DBA::selectFirst('contact', ['hidden'], ['id' => $cid]);
1279 if (!DBA::isResult($hidden)) {
1282 return (bool) $hidden['hidden'];
1286 * Returns posts from a given contact url
1288 * @param string $contact_url Contact URL
1289 * @param bool $thread_mode
1290 * @param int $update Update mode
1291 * @param int $parent Item parent ID for the update mode
1292 * @return string posts in HTML
1293 * @throws \Exception
1295 public static function getPostsFromUrl($contact_url, $thread_mode = false, $update = 0, $parent = 0)
1297 return self::getPostsFromId(self::getIdForURL($contact_url), $thread_mode, $update, $parent);
1301 * Returns posts from a given contact id
1303 * @param int $cid Contact ID
1304 * @param bool $thread_mode
1305 * @param int $update Update mode
1306 * @param int $parent Item parent ID for the update mode
1307 * @return string posts in HTML
1308 * @throws \Exception
1310 public static function getPostsFromId($cid, $thread_mode = false, $update = 0, $parent = 0)
1314 $contact = DBA::selectFirst('contact', ['contact-type', 'network'], ['id' => $cid]);
1315 if (!DBA::isResult($contact)) {
1319 if (empty($contact["network"]) || in_array($contact["network"], Protocol::FEDERATED)) {
1320 $sql = "(`uid` = 0 OR (`uid` = ? AND NOT `global`))";
1325 $contact_field = ((($contact["contact-type"] == self::TYPE_COMMUNITY) || ($contact['network'] == Protocol::MAIL)) ? 'owner-id' : 'author-id');
1328 $condition = ["((`$contact_field` = ? AND `gravity` = ?) OR (`author-id` = ? AND `gravity` = ? AND `vid` = ?)) AND " . $sql,
1329 $cid, GRAVITY_PARENT, $cid, GRAVITY_ACTIVITY, Verb::getID(Activity::ANNOUNCE), local_user()];
1331 $condition = ["`$contact_field` = ? AND `gravity` IN (?, ?) AND " . $sql,
1332 $cid, GRAVITY_PARENT, GRAVITY_COMMENT, local_user()];
1335 if (!empty($parent)) {
1336 $condition = DBA::mergeConditions($condition, ['parent' => $parent]);
1338 $last_received = isset($_GET['last_received']) ? DateTimeFormat::utc($_GET['last_received']) : '';
1339 if (!empty($last_received)) {
1340 $condition = DBA::mergeConditions($condition, ["`received` < ?", $last_received]);
1344 if (DI::mode()->isMobile()) {
1345 $itemsPerPage = DI::pConfig()->get(local_user(), 'system', 'itemspage_mobile_network',
1346 DI::config()->get('system', 'itemspage_network_mobile'));
1348 $itemsPerPage = DI::pConfig()->get(local_user(), 'system', 'itemspage_network',
1349 DI::config()->get('system', 'itemspage_network'));
1352 $pager = new Pager(DI::l10n(), DI::args()->getQueryString(), $itemsPerPage);
1354 $params = ['order' => ['received' => true], 'limit' => [$pager->getStart(), $pager->getItemsPerPage()]];
1356 if (DI::pConfig()->get(local_user(), 'system', 'infinite_scroll')) {
1357 $tpl = Renderer::getMarkupTemplate('infinite_scroll_head.tpl');
1358 $o = Renderer::replaceMacros($tpl, ['$reload_uri' => DI::args()->getQueryString()]);
1364 $items = Post::toArray(Post::selectForUser(local_user(), ['uri-id', 'gravity', 'parent-uri-id', 'thr-parent-id', 'author-id'], $condition, $params));
1366 $o .= conversation($a, $items, 'contacts', $update, false, 'commented', local_user());
1368 $items = Post::toArray(Post::selectForUser(local_user(), Item::DISPLAY_FIELDLIST, $condition, $params));
1370 $o .= conversation($a, $items, 'contact-posts', $update);
1374 if (DI::pConfig()->get(local_user(), 'system', 'infinite_scroll')) {
1375 $o .= HTML::scrollLoader();
1377 $o .= $pager->renderMinimal(count($items));
1385 * Returns the account type name
1387 * The function can be called with either the user or the contact array
1389 * @param array $contact contact or user array
1392 public static function getAccountType(array $contact)
1394 // There are several fields that indicate that the contact or user is a forum
1395 // "page-flags" is a field in the user table,
1396 // "forum" and "prv" are used in the contact table. They stand for User::PAGE_FLAGS_COMMUNITY and User::PAGE_FLAGS_PRVGROUP.
1397 if ((isset($contact['page-flags']) && (intval($contact['page-flags']) == User::PAGE_FLAGS_COMMUNITY))
1398 || (isset($contact['page-flags']) && (intval($contact['page-flags']) == User::PAGE_FLAGS_PRVGROUP))
1399 || (isset($contact['forum']) && intval($contact['forum']))
1400 || (isset($contact['prv']) && intval($contact['prv']))
1401 || (isset($contact['community']) && intval($contact['community']))
1403 $type = self::TYPE_COMMUNITY;
1405 $type = self::TYPE_PERSON;
1408 // The "contact-type" (contact table) and "account-type" (user table) are more general then the chaos from above.
1409 if (isset($contact["contact-type"])) {
1410 $type = $contact["contact-type"];
1413 if (isset($contact["account-type"])) {
1414 $type = $contact["account-type"];
1418 case self::TYPE_ORGANISATION:
1419 $account_type = DI::l10n()->t("Organisation");
1422 case self::TYPE_NEWS:
1423 $account_type = DI::l10n()->t('News');
1426 case self::TYPE_COMMUNITY:
1427 $account_type = DI::l10n()->t("Forum");
1435 return $account_type;
1443 * @throws \Exception
1445 public static function block($cid, $reason = null)
1447 $return = DBA::update('contact', ['blocked' => true, 'block_reason' => $reason], ['id' => $cid]);
1453 * Unblocks a contact
1457 * @throws \Exception
1459 public static function unblock($cid)
1461 $return = DBA::update('contact', ['blocked' => false, 'block_reason' => null], ['id' => $cid]);
1467 * Ensure that cached avatar exist
1469 * @param integer $cid
1471 public static function checkAvatarCache(int $cid)
1473 $contact = DBA::selectFirst('contact', ['url', 'avatar', 'photo', 'thumb', 'micro'], ['id' => $cid, 'uid' => 0, 'self' => false]);
1474 if (!DBA::isResult($contact)) {
1478 if (empty($contact['avatar']) || (!empty($contact['photo']) && !empty($contact['thumb']) && !empty($contact['micro']))) {
1482 Logger::info('Adding avatar cache', ['id' => $cid, 'contact' => $contact]);
1484 self::updateAvatar($cid, $contact['avatar'], true);
1488 * Return the photo path for a given contact array in the given size
1490 * @param array $contact contact array
1491 * @param string $field Fieldname of the photo in the contact array
1492 * @param string $size Size of the avatar picture
1493 * @param string $avatar Avatar path that is displayed when no photo had been found
1494 * @param bool $no_update Don't perfom an update if no cached avatar was found
1495 * @return string photo path
1497 private static function getAvatarPath(array $contact, string $field, string $size, string $avatar, $no_update = false)
1499 if (!empty($contact)) {
1500 $contact = self::checkAvatarCacheByArray($contact, $no_update);
1501 if (!empty($contact[$field])) {
1502 $avatar = $contact[$field];
1506 if ($no_update && empty($avatar) && !empty($contact['avatar'])) {
1507 $avatar = $contact['avatar'];
1510 if (empty($avatar)) {
1511 $avatar = self::getDefaultAvatar([], $size);
1514 if (Proxy::isLocalImage($avatar)) {
1517 return Proxy::proxifyUrl($avatar, false, $size);
1522 * Return the photo path for a given contact array
1524 * @param array $contact Contact array
1525 * @param string $avatar Avatar path that is displayed when no photo had been found
1526 * @param bool $no_update Don't perfom an update if no cached avatar was found
1527 * @return string photo path
1529 public static function getPhoto(array $contact, string $avatar = '', bool $no_update = false)
1531 return self::getAvatarPath($contact, 'photo', Proxy::SIZE_SMALL, $avatar, $no_update);
1535 * Return the photo path (thumb size) for a given contact array
1537 * @param array $contact Contact array
1538 * @param string $avatar Avatar path that is displayed when no photo had been found
1539 * @param bool $no_update Don't perfom an update if no cached avatar was found
1540 * @return string photo path
1542 public static function getThumb(array $contact, string $avatar = '', bool $no_update = false)
1544 return self::getAvatarPath($contact, 'thumb', Proxy::SIZE_THUMB, $avatar, $no_update);
1548 * Return the photo path (micro size) for a given contact array
1550 * @param array $contact Contact array
1551 * @param string $avatar Avatar path that is displayed when no photo had been found
1552 * @param bool $no_update Don't perfom an update if no cached avatar was found
1553 * @return string photo path
1555 public static function getMicro(array $contact, string $avatar = '', bool $no_update = false)
1557 return self::getAvatarPath($contact, 'micro', Proxy::SIZE_MICRO, $avatar, $no_update);
1561 * Check the given contact array for avatar cache fields
1563 * @param array $contact
1564 * @param bool $no_update Don't perfom an update if no cached avatar was found
1565 * @return array contact array with avatar cache fields
1567 private static function checkAvatarCacheByArray(array $contact, bool $no_update = false)
1570 $contact_fields = [];
1571 $fields = ['photo', 'thumb', 'micro'];
1572 foreach ($fields as $field) {
1573 if (isset($contact[$field])) {
1574 $contact_fields[] = $field;
1576 if (isset($contact[$field]) && empty($contact[$field])) {
1581 if (!$update || $no_update) {
1585 if (!empty($contact['id']) && !empty($contact['avatar'])) {
1586 self::updateAvatar($contact['id'], $contact['avatar'], true);
1588 $new_contact = self::getById($contact['id'], $contact_fields);
1589 if (DBA::isResult($new_contact)) {
1590 // We only update the cache fields
1591 $contact = array_merge($contact, $new_contact);
1595 /// add the default avatars if the fields aren't filled
1596 if (isset($contact['photo']) && empty($contact['photo'])) {
1597 $contact['photo'] = self::getDefaultAvatar($contact, Proxy::SIZE_SMALL);
1599 if (isset($contact['thumb']) && empty($contact['thumb'])) {
1600 $contact['thumb'] = self::getDefaultAvatar($contact, Proxy::SIZE_THUMB);
1602 if (isset($contact['micro']) && empty($contact['micro'])) {
1603 $contact['micro'] = self::getDefaultAvatar($contact, Proxy::SIZE_MICRO);
1610 * Fetch the default avatar for the given contact and size
1612 * @param array $contact contact array
1613 * @param string $size Size of the avatar picture
1616 public static function getDefaultAvatar(array $contact, string $size)
1619 case Proxy::SIZE_MICRO:
1620 $avatar['size'] = 48;
1621 $default = self::DEFAULT_AVATAR_MICRO;
1624 case Proxy::SIZE_THUMB:
1625 $avatar['size'] = 80;
1626 $default = self::DEFAULT_AVATAR_THUMB;
1629 case Proxy::SIZE_SMALL:
1631 $avatar['size'] = 300;
1632 $default = self::DEFAULT_AVATAR_PHOTO;
1636 if (!DI::config()->get('system', 'remote_avatar_lookup')) {
1637 return DI::baseUrl() . $default;
1640 if (!empty($contact['xmpp'])) {
1641 $avatar['email'] = $contact['xmpp'];
1642 } elseif (!empty($contact['addr'])) {
1643 $avatar['email'] = $contact['addr'];
1644 } elseif (!empty($contact['url'])) {
1645 $avatar['email'] = $contact['url'];
1647 return DI::baseUrl() . $default;
1650 $avatar['url'] = '';
1651 $avatar['success'] = false;
1653 Hook::callAll('avatar_lookup', $avatar);
1655 if ($avatar['success'] && !empty($avatar['url'])) {
1656 return $avatar['url'];
1659 return DI::baseUrl() . $default;
1663 * Updates the avatar links in a contact only if needed
1665 * @param int $cid Contact id
1666 * @param string $avatar Link to avatar picture
1667 * @param bool $force force picture update
1668 * @param bool $create_cache Enforces the creation of cached avatar fields
1671 * @throws HTTPException\InternalServerErrorException
1672 * @throws HTTPException\NotFoundException
1673 * @throws \ImagickException
1675 public static function updateAvatar(int $cid, string $avatar, bool $force = false, bool $create_cache = false)
1677 $contact = DBA::selectFirst('contact', ['uid', 'avatar', 'photo', 'thumb', 'micro', 'xmpp', 'addr', 'nurl', 'url', 'network'],
1678 ['id' => $cid, 'self' => false]);
1679 if (!DBA::isResult($contact)) {
1683 $uid = $contact['uid'];
1685 // Only update the cached photo links of public contacts when they already are cached
1686 if (($uid == 0) && !$force && empty($contact['thumb']) && empty($contact['micro']) && !$create_cache) {
1687 if ($contact['avatar'] != $avatar) {
1688 DBA::update('contact', ['avatar' => $avatar], ['id' => $cid]);
1689 Logger::info('Only update the avatar', ['id' => $cid, 'avatar' => $avatar, 'contact' => $contact]);
1694 // User contacts use are updated through the public contacts
1695 if (($uid != 0) && !in_array($contact['network'], [Protocol::FEED, Protocol::MAIL])) {
1696 $pcid = self::getIdForURL($contact['url'], false);
1697 if (!empty($pcid)) {
1698 Logger::debug('Update the private contact via the public contact', ['id' => $cid, 'uid' => $uid, 'public' => $pcid]);
1699 self::updateAvatar($pcid, $avatar, $force, true);
1704 $default_avatar = empty($avatar) || strpos($avatar, self::DEFAULT_AVATAR_PHOTO);
1706 if ($default_avatar) {
1707 $avatar = self::getDefaultAvatar($contact, Proxy::SIZE_SMALL);
1710 if ($default_avatar && Proxy::isLocalImage($avatar)) {
1711 $fields = ['avatar' => $avatar, 'avatar-date' => DateTimeFormat::utcNow(),
1713 'thumb' => self::getDefaultAvatar($contact, Proxy::SIZE_THUMB),
1714 'micro' => self::getDefaultAvatar($contact, Proxy::SIZE_MICRO)];
1715 Logger::debug('Use default avatar', ['id' => $cid, 'uid' => $uid]);
1718 // Use the data from the self account
1719 if (empty($fields)) {
1720 $local_uid = User::getIdForURL($contact['url']);
1721 if (!empty($local_uid)) {
1722 $fields = self::selectFirst(['avatar', 'avatar-date', 'photo', 'thumb', 'micro'], ['self' => true, 'uid' => $local_uid]);
1723 Logger::debug('Use owner data', ['id' => $cid, 'uid' => $uid, 'owner-uid' => $local_uid]);
1727 if (empty($fields)) {
1728 $update = ($contact['avatar'] != $avatar) || $force;
1732 $contact['photo'] ?? '',
1733 $contact['thumb'] ?? '',
1734 $contact['micro'] ?? '',
1737 foreach ($data as $image_uri) {
1738 $image_rid = Photo::ridFromURI($image_uri);
1739 if ($image_rid && !Photo::exists(['resource-id' => $image_rid, 'uid' => $uid])) {
1740 Logger::debug('Regenerating avatar', ['contact uid' => $uid, 'cid' => $cid, 'missing photo' => $image_rid, 'avatar' => $contact['avatar']]);
1747 $photos = Photo::importProfilePhoto($avatar, $uid, $cid, true);
1749 $fields = ['avatar' => $avatar, 'photo' => $photos[0], 'thumb' => $photos[1], 'micro' => $photos[2], 'avatar-date' => DateTimeFormat::utcNow()];
1750 $update = !empty($fields);
1751 Logger::debug('Created new cached avatars', ['id' => $cid, 'uid' => $uid, 'owner-uid' => $local_uid]);
1757 $update = ($fields['photo'] . $fields['thumb'] . $fields['micro'] != $contact['photo'] . $contact['thumb'] . $contact['micro']) || $force;
1766 if (($uid == 0) && !in_array($contact['network'], [Protocol::FEED, Protocol::MAIL])) {
1767 // Collect all user contacts of the given public contact
1768 $personal_contacts = DBA::select('contact', ['id', 'uid'],
1769 ["`nurl` = ? AND `id` != ? AND NOT `self`", $contact['nurl'], $cid]);
1770 while ($personal_contact = DBA::fetch($personal_contacts)) {
1771 $cids[] = $personal_contact['id'];
1772 $uids[] = $personal_contact['uid'];
1774 DBA::close($personal_contacts);
1776 if (!empty($cids)) {
1777 // Delete possibly existing cached user contact avatars
1778 Photo::delete(['uid' => $uids, 'contact-id' => $cids, 'album' => Photo::CONTACT_PHOTOS]);
1784 Logger::info('Updating cached contact avatars', ['cid' => $cids, 'uid' => $uids, 'fields' => $fields]);
1785 DBA::update('contact', $fields, ['id' => $cids]);
1788 public static function deleteContactByUrl(string $url)
1790 // Update contact data for all users
1791 $condition = ['self' => false, 'nurl' => Strings::normaliseLink($url)];
1792 $contacts = DBA::select('contact', ['id', 'uid'], $condition);
1793 while ($contact = DBA::fetch($contacts)) {
1794 Logger::info('Deleting contact', ['id' => $contact['id'], 'uid' => $contact['uid'], 'url' => $url]);
1795 self::remove($contact['id']);
1800 * Helper function for "updateFromProbe". Updates personal and public contact
1802 * @param integer $id contact id
1803 * @param integer $uid user id
1804 * @param string $old_url The previous profile URL of the contact
1805 * @param string $new_url The profile URL of the contact
1806 * @param array $fields The fields that are updated
1808 * @throws \Exception
1810 private static function updateContact(int $id, int $uid, string $old_url, string $new_url, array $fields)
1812 if (Strings::normaliseLink($new_url) != Strings::normaliseLink($old_url)) {
1813 Logger::notice('New URL differs from old URL', ['old' => $old_url, 'new' => $new_url]);
1814 // @todo It is to decide what to do when the URL is changed
1817 if (!DBA::update('contact', $fields, ['id' => $id])) {
1818 Logger::info('Couldn\'t update contact.', ['id' => $id, 'fields' => $fields]);
1822 // Search for duplicated contacts and get rid of them
1823 if (self::removeDuplicates(Strings::normaliseLink($new_url), $uid)) {
1827 // Archive or unarchive the contact.
1828 $contact = DBA::selectFirst('contact', [], ['id' => $id]);
1829 if (!DBA::isResult($contact)) {
1830 Logger::info('Couldn\'t select contact for archival.', ['id' => $id]);
1834 if (isset($fields['failed'])) {
1835 if ($fields['failed']) {
1836 self::markForArchival($contact);
1838 self::unmarkForArchival($contact);
1842 if ($contact['uid'] != 0) {
1846 // Update contact data for all users
1847 $condition = ['self' => false, 'nurl' => Strings::normaliseLink($old_url)];
1849 $condition['network'] = [Protocol::DFRN, Protocol::DIASPORA, Protocol::ACTIVITYPUB];
1850 DBA::update('contact', $fields, $condition);
1852 // We mustn't set the update fields for OStatus contacts since they are updated in OnePoll
1853 $condition['network'] = Protocol::OSTATUS;
1855 // If the contact failed, propagate the update fields to all contacts
1856 if (empty($fields['failed'])) {
1857 unset($fields['last-update']);
1858 unset($fields['success_update']);
1859 unset($fields['failure_update']);
1862 if (empty($fields)) {
1866 DBA::update('contact', $fields, $condition);
1870 * Remove duplicated contacts
1872 * @param string $nurl Normalised contact url
1873 * @param integer $uid User id
1875 * @throws \Exception
1877 public static function removeDuplicates(string $nurl, int $uid)
1879 $condition = ['nurl' => $nurl, 'uid' => $uid, 'deleted' => false, 'network' => Protocol::FEDERATED];
1880 $count = DBA::count('contact', $condition);
1885 $first_contact = DBA::selectFirst('contact', ['id', 'network'], $condition, ['order' => ['id']]);
1886 if (!DBA::isResult($first_contact)) {
1887 // Shouldn't happen - so we handle it
1891 $first = $first_contact['id'];
1892 Logger::info('Found duplicates', ['count' => $count, 'first' => $first, 'uid' => $uid, 'nurl' => $nurl]);
1893 if (($uid != 0 && ($first_contact['network'] == Protocol::DFRN))) {
1894 // Don't handle non public DFRN duplicates by now (legacy DFRN is very special because of the key handling)
1895 Logger::info('Not handling non public DFRN duplicate', ['uid' => $uid, 'nurl' => $nurl]);
1899 // Find all duplicates
1900 $condition = ["`nurl` = ? AND `uid` = ? AND `id` != ? AND NOT `self` AND NOT `deleted`", $nurl, $uid, $first];
1901 $duplicates = DBA::select('contact', ['id', 'network'], $condition);
1902 while ($duplicate = DBA::fetch($duplicates)) {
1903 if (!in_array($duplicate['network'], Protocol::FEDERATED)) {
1907 Worker::add(PRIORITY_HIGH, 'MergeContact', $first, $duplicate['id'], $uid);
1909 DBA::close($duplicates);
1910 Logger::info('Duplicates handled', ['uid' => $uid, 'nurl' => $nurl, 'callstack' => System::callstack(20)]);
1915 * @param integer $id contact id
1916 * @param string $network Optional network we are probing for
1918 * @throws HTTPException\InternalServerErrorException
1919 * @throws \ImagickException
1921 public static function updateFromProbe(int $id, string $network = '')
1923 $contact = DBA::selectFirst('contact', ['uid', 'url'], ['id' => $id]);
1924 if (!DBA::isResult($contact)) {
1928 $ret = Probe::uri($contact['url'], $network, $contact['uid']);
1929 return self::updateFromProbeArray($id, $ret);
1933 * @param integer $id contact id
1934 * @param array $ret Probed data
1936 * @throws HTTPException\InternalServerErrorException
1937 * @throws \ImagickException
1939 private static function updateFromProbeArray(int $id, array $ret)
1942 Warning: Never ever fetch the public key via Probe::uri and write it into the contacts.
1943 This will reliably kill your communication with old Friendica contacts.
1946 // These fields aren't updated by this routine:
1947 // 'xmpp', 'sensitive'
1949 $fields = ['uid', 'avatar', 'name', 'nick', 'location', 'keywords', 'about', 'subscribe', 'manually-approve',
1950 'unsearchable', 'url', 'addr', 'batch', 'notify', 'poll', 'request', 'confirm', 'poco',
1951 'network', 'alias', 'baseurl', 'gsid', 'forum', 'prv', 'contact-type', 'pubkey', 'last-item'];
1952 $contact = DBA::selectFirst('contact', $fields, ['id' => $id]);
1953 if (!DBA::isResult($contact)) {
1957 if (self::isLocal($ret['url'])) {
1958 Logger::info('Local contacts are not updated here.');
1962 if (!empty($ret['account-type']) && $ret['account-type'] == User::ACCOUNT_TYPE_DELETED) {
1963 Logger::info('Deleted account', ['id' => $id, 'url' => $ret['url'], 'ret' => $ret]);
1966 // Delete all contacts with the same URL
1967 self::deleteContactByUrl($ret['url']);
1971 $uid = $contact['uid'];
1972 unset($contact['uid']);
1974 $pubkey = $contact['pubkey'];
1975 unset($contact['pubkey']);
1977 $contact['photo'] = $contact['avatar'];
1978 unset($contact['avatar']);
1980 $updated = DateTimeFormat::utcNow();
1982 // We must not try to update relay contacts via probe. They are no real contacts.
1983 // We check after the probing to be able to correct falsely detected contact types.
1984 if (($contact['contact-type'] == self::TYPE_RELAY) &&
1985 (!Strings::compareLink($ret['url'], $contact['url']) || in_array($ret['network'], [Protocol::FEED, Protocol::PHANTOM]))) {
1986 self::updateContact($id, $uid, $contact['url'], $contact['url'], ['failed' => false, 'last-update' => $updated, 'success_update' => $updated]);
1987 Logger::info('Not updating relais', ['id' => $id, 'url' => $contact['url']]);
1991 // If Probe::uri fails the network code will be different ("feed" or "unkn")
1992 if (($ret['network'] == Protocol::PHANTOM) || (($ret['network'] == Protocol::FEED) && ($ret['network'] != $contact['network']))) {
1993 self::updateContact($id, $uid, $contact['url'], $ret['url'], ['failed' => true, 'last-update' => $updated, 'failure_update' => $updated]);
1997 if (isset($ret['hide']) && is_bool($ret['hide'])) {
1998 $ret['unsearchable'] = $ret['hide'];
2001 if (isset($ret['account-type']) && is_int($ret['account-type'])) {
2002 $ret['forum'] = false;
2003 $ret['prv'] = false;
2004 $ret['contact-type'] = $ret['account-type'];
2005 if (($ret['contact-type'] == User::ACCOUNT_TYPE_COMMUNITY) && isset($ret['manually-approve'])) {
2006 $ret['forum'] = (bool)!$ret['manually-approve'];
2007 $ret['prv'] = (bool)!$ret['forum'];
2011 $new_pubkey = $ret['pubkey'] ?? '';
2014 $ret['last-item'] = Probe::getLastUpdate($ret);
2015 Logger::info('Fetched last item', ['id' => $id, 'probed_url' => $ret['url'], 'last-item' => $ret['last-item'], 'callstack' => System::callstack(20)]);
2020 // make sure to not overwrite existing values with blank entries except some technical fields
2021 $keep = ['batch', 'notify', 'poll', 'request', 'confirm', 'poco', 'baseurl'];
2022 foreach ($ret as $key => $val) {
2023 if (!array_key_exists($key, $contact)) {
2025 } elseif (($contact[$key] != '') && ($val === '') && !is_bool($ret[$key]) && !in_array($key, $keep)) {
2026 $ret[$key] = $contact[$key];
2027 } elseif ($ret[$key] != $contact[$key]) {
2032 if (!empty($ret['last-item']) && ($contact['last-item'] < $ret['last-item'])) {
2035 unset($ret['last-item']);
2038 if (!empty($ret['photo']) && ($ret['network'] != Protocol::FEED)) {
2039 self::updateAvatar($id, $ret['photo'], $update);
2043 self::updateContact($id, $uid, $contact['url'], $ret['url'], ['failed' => false, 'last-update' => $updated, 'success_update' => $updated]);
2045 if (Contact\Relation::isDiscoverable($ret['url'])) {
2046 Worker::add(PRIORITY_LOW, 'ContactDiscovery', $ret['url']);
2049 // Update the public contact
2051 $contact = self::getByURL($ret['url'], false, ['id']);
2052 if (!empty($contact['id'])) {
2053 self::updateFromProbeArray($contact['id'], $ret);
2060 $ret['nurl'] = Strings::normaliseLink($ret['url']);
2061 $ret['updated'] = $updated;
2062 $ret['failed'] = false;
2064 // Only fill the pubkey if it had been empty before. We have to prevent identity theft.
2065 if (empty($pubkey) && !empty($new_pubkey)) {
2066 $ret['pubkey'] = $new_pubkey;
2069 if ((!empty($ret['addr']) && ($ret['addr'] != $contact['addr'])) || (!empty($ret['alias']) && ($ret['alias'] != $contact['alias']))) {
2070 $ret['uri-date'] = DateTimeFormat::utcNow();
2073 if (($ret['name'] != $contact['name']) || ($ret['nick'] != $contact['nick'])) {
2074 $ret['name-date'] = $updated;
2077 if (($uid == 0) || in_array($ret['network'], [Protocol::DFRN, Protocol::DIASPORA, Protocol::ACTIVITYPUB])) {
2078 $ret['last-update'] = $updated;
2079 $ret['success_update'] = $updated;
2082 unset($ret['photo']);
2084 self::updateContact($id, $uid, $contact['url'], $ret['url'], $ret);
2086 if (Contact\Relation::isDiscoverable($ret['url'])) {
2087 Worker::add(PRIORITY_LOW, 'ContactDiscovery', $ret['url']);
2094 * @param integer $url contact url
2095 * @return integer Contact id
2096 * @throws HTTPException\InternalServerErrorException
2097 * @throws \ImagickException
2099 public static function updateFromProbeByURL($url)
2101 $id = self::getIdForURL($url);
2107 self::updateFromProbe($id);
2113 * Detects if a given contact array belongs to a legacy DFRN connection
2115 * @param array $contact
2118 public static function isLegacyDFRNContact($contact)
2120 // Newer Friendica contacts are connected via AP, then these fields aren't set
2121 return !empty($contact['dfrn-id']) || !empty($contact['issued-id']);
2125 * Detects the communication protocol for a given contact url.
2126 * This is used to detect Friendica contacts that we can communicate via AP.
2128 * @param string $url contact url
2129 * @param string $network Network of that contact
2130 * @return string with protocol
2132 public static function getProtocol($url, $network)
2134 if ($network != Protocol::DFRN) {
2138 $apcontact = APContact::getByURL($url);
2139 if (!empty($apcontact) && !empty($apcontact['generator'])) {
2140 return Protocol::ACTIVITYPUB;
2147 * Takes a $uid and a url/handle and adds a new contact
2149 * Currently if the contact is DFRN, interactive needs to be true, to redirect to the
2150 * dfrn_request page.
2152 * Otherwise this can be used to bulk add StatusNet contacts, Twitter contacts, etc.
2155 * $return['success'] boolean true if successful
2156 * $return['message'] error text if success is false.
2158 * Takes a $uid and a url/handle and adds a new contact
2160 * @param array $user The user the contact should be created for
2161 * @param string $url The profile URL of the contact
2162 * @param bool $interactive
2163 * @param string $network
2165 * @throws HTTPException\InternalServerErrorException
2166 * @throws HTTPException\NotFoundException
2167 * @throws \ImagickException
2169 public static function createFromProbe(array $user, $url, $interactive = false, $network = '')
2171 $result = ['cid' => -1, 'success' => false, 'message' => ''];
2173 // remove ajax junk, e.g. Twitter
2174 $url = str_replace('/#!/', '/', $url);
2176 if (!Network::isUrlAllowed($url)) {
2177 $result['message'] = DI::l10n()->t('Disallowed profile URL.');
2181 if (Network::isUrlBlocked($url)) {
2182 $result['message'] = DI::l10n()->t('Blocked domain');
2187 $result['message'] = DI::l10n()->t('Connect URL missing.');
2191 $arr = ['url' => $url, 'contact' => []];
2193 Hook::callAll('follow', $arr);
2196 $result['message'] = DI::l10n()->t('The contact could not be added. Please check the relevant network credentials in your Settings -> Social Networks page.');
2200 if (!empty($arr['contact']['name'])) {
2201 $ret = $arr['contact'];
2203 $ret = Probe::uri($url, $network, $user['uid']);
2206 if (($network != '') && ($ret['network'] != $network)) {
2207 Logger::log('Expected network ' . $network . ' does not match actual network ' . $ret['network']);
2211 // check if we already have a contact
2212 // the poll url is more reliable than the profile url, as we may have
2213 // indirect links or webfinger links
2215 $condition = ['uid' => $user['uid'], 'poll' => [$ret['poll'], Strings::normaliseLink($ret['poll'])], 'network' => $ret['network'], 'pending' => false];
2216 $contact = DBA::selectFirst('contact', ['id', 'rel'], $condition);
2217 if (!DBA::isResult($contact)) {
2218 $condition = ['uid' => $user['uid'], 'nurl' => Strings::normaliseLink($ret['url']), 'network' => $ret['network'], 'pending' => false];
2219 $contact = DBA::selectFirst('contact', ['id', 'rel'], $condition);
2222 $protocol = self::getProtocol($ret['url'], $ret['network']);
2224 if (($protocol === Protocol::DFRN) && !DBA::isResult($contact)) {
2226 if (strlen(DI::baseUrl()->getUrlPath())) {
2227 $myaddr = bin2hex(DI::baseUrl() . '/profile/' . $user['nickname']);
2229 $myaddr = bin2hex($user['nickname'] . '@' . DI::baseUrl()->getHostname());
2232 DI::baseUrl()->redirect($ret['request'] . "&addr=$myaddr");
2236 } elseif (DI::config()->get('system', 'dfrn_only') && ($ret['network'] != Protocol::DFRN)) {
2237 $result['message'] = DI::l10n()->t('This site is not configured to allow communications with other networks.') . EOL;
2238 $result['message'] .= DI::l10n()->t('No compatible communication protocols or feeds were discovered.') . EOL;
2242 // This extra param just confuses things, remove it
2243 if ($protocol === Protocol::DIASPORA) {
2244 $ret['url'] = str_replace('?absolute=true', '', $ret['url']);
2247 // do we have enough information?
2248 if (empty($protocol) || ($protocol == Protocol::PHANTOM) || (empty($ret['url']) && empty($ret['addr']))) {
2249 $result['message'] .= DI::l10n()->t('The profile address specified does not provide adequate information.') . EOL;
2250 if (empty($ret['poll'])) {
2251 $result['message'] .= DI::l10n()->t('No compatible communication protocols or feeds were discovered.') . EOL;
2253 if (empty($ret['name'])) {
2254 $result['message'] .= DI::l10n()->t('An author or name was not found.') . EOL;
2256 if (empty($ret['url'])) {
2257 $result['message'] .= DI::l10n()->t('No browser URL could be matched to this address.') . EOL;
2259 if (strpos($ret['url'], '@') !== false) {
2260 $result['message'] .= DI::l10n()->t('Unable to match @-style Identity Address with a known protocol or email contact.') . EOL;
2261 $result['message'] .= DI::l10n()->t('Use mailto: in front of address to force email check.') . EOL;
2266 if ($protocol === Protocol::OSTATUS && DI::config()->get('system', 'ostatus_disabled')) {
2267 $result['message'] .= DI::l10n()->t('The profile address specified belongs to a network which has been disabled on this site.') . EOL;
2268 $ret['notify'] = '';
2271 if (!$ret['notify']) {
2272 $result['message'] .= DI::l10n()->t('Limited profile. This person will be unable to receive direct/personal notifications from you.') . EOL;
2275 $writeable = ((($protocol === Protocol::OSTATUS) && ($ret['notify'])) ? 1 : 0);
2277 $subhub = (($protocol === Protocol::OSTATUS) ? true : false);
2279 $hidden = (($protocol === Protocol::MAIL) ? 1 : 0);
2282 if (($protocol == Protocol::ACTIVITYPUB) && isset($ret['manually-approve'])) {
2283 $pending = (bool)$ret['manually-approve'];
2286 if (in_array($protocol, [Protocol::MAIL, Protocol::DIASPORA, Protocol::ACTIVITYPUB])) {
2290 if (DBA::isResult($contact)) {
2292 $new_relation = (($contact['rel'] == self::FOLLOWER) ? self::FRIEND : self::SHARING);
2294 $fields = ['rel' => $new_relation, 'subhub' => $subhub, 'readonly' => false];
2295 DBA::update('contact', $fields, ['id' => $contact['id']]);
2297 $new_relation = (in_array($protocol, [Protocol::MAIL]) ? self::FRIEND : self::SHARING);
2299 // create contact record
2301 'uid' => $user['uid'],
2302 'created' => DateTimeFormat::utcNow(),
2303 'url' => $ret['url'],
2304 'nurl' => Strings::normaliseLink($ret['url']),
2305 'addr' => $ret['addr'],
2306 'alias' => $ret['alias'],
2307 'batch' => $ret['batch'],
2308 'notify' => $ret['notify'],
2309 'poll' => $ret['poll'],
2310 'poco' => $ret['poco'],
2311 'name' => $ret['name'],
2312 'nick' => $ret['nick'],
2313 'network' => $ret['network'],
2314 'baseurl' => $ret['baseurl'],
2315 'gsid' => $ret['gsid'] ?? null,
2316 'protocol' => $protocol,
2317 'pubkey' => $ret['pubkey'],
2318 'rel' => $new_relation,
2319 'priority'=> $ret['priority'],
2320 'writable'=> $writeable,
2321 'hidden' => $hidden,
2324 'pending' => $pending,
2329 $contact = DBA::selectFirst('contact', [], ['url' => $ret['url'], 'network' => $ret['network'], 'uid' => $user['uid']]);
2330 if (!DBA::isResult($contact)) {
2331 $result['message'] .= DI::l10n()->t('Unable to retrieve contact information.') . EOL;
2335 $contact_id = $contact['id'];
2336 $result['cid'] = $contact_id;
2338 Group::addMember(User::getDefaultGroup($user['uid'], $contact["network"]), $contact_id);
2340 // Update the avatar
2341 self::updateAvatar($contact_id, $ret['photo']);
2343 // pull feed and consume it, which should subscribe to the hub.
2344 if ($contact['network'] == Protocol::OSTATUS) {
2345 Worker::add(PRIORITY_HIGH, 'OnePoll', $contact_id, 'force');
2347 Worker::add(PRIORITY_HIGH, 'UpdateContact', $contact_id);
2350 $owner = User::getOwnerDataById($user['uid']);
2352 if (DBA::isResult($owner)) {
2353 if (in_array($protocol, [Protocol::OSTATUS, Protocol::DFRN])) {
2354 // create a follow slap
2356 $item['verb'] = Activity::FOLLOW;
2357 $item['gravity'] = GRAVITY_ACTIVITY;
2358 $item['follow'] = $contact["url"];
2360 $item['title'] = '';
2362 $item['uri-id'] = 0;
2364 $slap = OStatus::salmon($item, $owner);
2366 if (!empty($contact['notify'])) {
2367 Salmon::slapper($owner, $contact['notify'], $slap);
2369 } elseif ($protocol == Protocol::DIASPORA) {
2370 $ret = Diaspora::sendShare($owner, $contact);
2371 Logger::log('share returns: ' . $ret);
2372 } elseif ($protocol == Protocol::ACTIVITYPUB) {
2373 $activity_id = ActivityPub\Transmitter::activityIDFromContact($contact_id);
2374 if (empty($activity_id)) {
2375 // This really should never happen
2379 $ret = ActivityPub\Transmitter::sendActivity('Follow', $contact['url'], $user['uid'], $activity_id);
2380 Logger::log('Follow returns: ' . $ret);
2384 $result['success'] = true;
2389 * Updated contact's SSL policy
2391 * @param array $contact Contact array
2392 * @param string $new_policy New policy, valid: self,full
2394 * @return array Contact array with updated values
2395 * @throws \Exception
2397 public static function updateSslPolicy(array $contact, $new_policy)
2399 $ssl_changed = false;
2400 if ((intval($new_policy) == BaseURL::SSL_POLICY_SELFSIGN || $new_policy === 'self') && strstr($contact['url'], 'https:')) {
2401 $ssl_changed = true;
2402 $contact['url'] = str_replace('https:', 'http:', $contact['url']);
2403 $contact['request'] = str_replace('https:', 'http:', $contact['request']);
2404 $contact['notify'] = str_replace('https:', 'http:', $contact['notify']);
2405 $contact['poll'] = str_replace('https:', 'http:', $contact['poll']);
2406 $contact['confirm'] = str_replace('https:', 'http:', $contact['confirm']);
2407 $contact['poco'] = str_replace('https:', 'http:', $contact['poco']);
2410 if ((intval($new_policy) == BaseURL::SSL_POLICY_FULL || $new_policy === 'full') && strstr($contact['url'], 'http:')) {
2411 $ssl_changed = true;
2412 $contact['url'] = str_replace('http:', 'https:', $contact['url']);
2413 $contact['request'] = str_replace('http:', 'https:', $contact['request']);
2414 $contact['notify'] = str_replace('http:', 'https:', $contact['notify']);
2415 $contact['poll'] = str_replace('http:', 'https:', $contact['poll']);
2416 $contact['confirm'] = str_replace('http:', 'https:', $contact['confirm']);
2417 $contact['poco'] = str_replace('http:', 'https:', $contact['poco']);
2421 $fields = ['url' => $contact['url'], 'request' => $contact['request'],
2422 'notify' => $contact['notify'], 'poll' => $contact['poll'],
2423 'confirm' => $contact['confirm'], 'poco' => $contact['poco']];
2424 DBA::update('contact', $fields, ['id' => $contact['id']]);
2433 * @param int $cid Public contact id
2434 * @param int $uid User ID
2436 * @return bool "true" if following had been successful
2438 public static function follow(int $cid, int $uid)
2440 $user = User::getById($uid);
2445 $contact = self::getById($cid, ['url']);
2447 $result = self::createFromProbe($user, $contact['url'], false);
2449 return $result['cid'];
2453 * Unfollow a contact
2455 * @param int $cid Public contact id
2456 * @param int $uid User ID
2458 * @return bool "true" if unfollowing had been successful
2460 public static function unfollow(int $cid, int $uid)
2462 $cdata = self::getPublicAndUserContacID($cid, $uid);
2463 if (empty($cdata['user'])) {
2467 $contact = self::getById($cdata['user']);
2469 self::removeSharer([], $contact);
2475 * @param array $importer Owner (local user) data
2476 * @param array $contact Existing owner-specific contact data we want to expand the relationship with. Optional.
2477 * @param array $datarray An item-like array with at least the 'author-id' and 'author-url' keys for the contact. Mandatory.
2478 * @param bool $sharing True: Contact is now sharing with Owner; False: Contact is now following Owner (default)
2479 * @param string $note Introduction additional message
2480 * @return bool|null True: follow request is accepted; False: relationship is rejected; Null: relationship is pending
2481 * @throws HTTPException\InternalServerErrorException
2482 * @throws \ImagickException
2484 public static function addRelationship(array $importer, array $contact, array $datarray, $sharing = false, $note = '')
2486 // Should always be set
2487 if (empty($datarray['author-id'])) {
2491 $fields = ['url', 'name', 'nick', 'avatar', 'photo', 'network', 'blocked'];
2492 $pub_contact = DBA::selectFirst('contact', $fields, ['id' => $datarray['author-id']]);
2493 if (!DBA::isResult($pub_contact)) {
2494 // Should never happen
2498 // Contact is blocked at node-level
2499 if (self::isBlocked($datarray['author-id'])) {
2503 $url = ($datarray['author-link'] ?? '') ?: $pub_contact['url'];
2504 $name = $pub_contact['name'];
2505 $photo = ($pub_contact['avatar'] ?? '') ?: $pub_contact["photo"];
2506 $nick = $pub_contact['nick'];
2507 $network = $pub_contact['network'];
2509 // Ensure that we don't create a new contact when there already is one
2510 $cid = self::getIdForURL($url, $importer['uid']);
2512 $contact = DBA::selectFirst('contact', [], ['id' => $cid]);
2515 if (!empty($contact)) {
2516 if (!empty($contact['pending'])) {
2517 Logger::info('Pending contact request already exists.', ['url' => $url, 'uid' => $importer['uid']]);
2521 // Contact is blocked at user-level
2522 if (!empty($contact['id']) && !empty($importer['id']) &&
2523 Contact\User::isBlocked($contact['id'], $importer['id'])) {
2527 // Make sure that the existing contact isn't archived
2528 self::unmarkForArchival($contact);
2530 if (($contact['rel'] == self::SHARING)
2531 || ($sharing && $contact['rel'] == self::FOLLOWER)) {
2532 DBA::update('contact', ['rel' => self::FRIEND, 'writable' => true, 'pending' => false],
2533 ['id' => $contact['id'], 'uid' => $importer['uid']]);
2536 // Ensure to always have the correct network type, independent from the connection request method
2537 self::updateFromProbe($contact['id']);
2539 Post\UserNotification::insertNotication($contact['id'], Verb::getID(Activity::FOLLOW), $importer['uid']);
2543 // send email notification to owner?
2544 if (DBA::exists('contact', ['nurl' => Strings::normaliseLink($url), 'uid' => $importer['uid'], 'pending' => true])) {
2545 Logger::log('ignoring duplicated connection request from pending contact ' . $url);
2549 // create contact record
2550 DBA::insert('contact', [
2551 'uid' => $importer['uid'],
2552 'created' => DateTimeFormat::utcNow(),
2554 'nurl' => Strings::normaliseLink($url),
2557 'network' => $network,
2558 'rel' => self::FOLLOWER,
2565 $contact_id = DBA::lastInsertId();
2567 // Ensure to always have the correct network type, independent from the connection request method
2568 self::updateFromProbe($contact_id);
2570 self::updateAvatar($contact_id, $photo, true);
2572 Post\UserNotification::insertNotication($contact_id, Verb::getID(Activity::FOLLOW), $importer['uid']);
2574 $contact_record = DBA::selectFirst('contact', ['id', 'network', 'name', 'url', 'photo'], ['id' => $contact_id]);
2576 /// @TODO Encapsulate this into a function/method
2577 $fields = ['uid', 'username', 'email', 'page-flags', 'notify-flags', 'language'];
2578 $user = DBA::selectFirst('user', $fields, ['uid' => $importer['uid']]);
2579 if (DBA::isResult($user) && !in_array($user['page-flags'], [User::PAGE_FLAGS_SOAPBOX, User::PAGE_FLAGS_FREELOVE, User::PAGE_FLAGS_COMMUNITY])) {
2580 // create notification
2581 $hash = Strings::getRandomHex();
2583 if (is_array($contact_record)) {
2584 DBA::insert('intro', ['uid' => $importer['uid'], 'contact-id' => $contact_record['id'],
2585 'blocked' => false, 'knowyou' => false, 'note' => $note,
2586 'hash' => $hash, 'datetime' => DateTimeFormat::utcNow()]);
2589 Group::addMember(User::getDefaultGroup($importer['uid'], $contact_record["network"]), $contact_record['id']);
2591 if (($user['notify-flags'] & Notification\Type::INTRO) &&
2592 in_array($user['page-flags'], [User::PAGE_FLAGS_NORMAL])) {
2595 'type' => Notification\Type::INTRO,
2596 'otype' => Notification\ObjectType::INTRO,
2597 'verb' => ($sharing ? Activity::FRIEND : Activity::FOLLOW),
2598 'uid' => $user['uid'],
2599 'cid' => $contact_record['id'],
2600 'link' => DI::baseUrl() . '/notifications/intros',
2603 } elseif (DBA::isResult($user) && in_array($user['page-flags'], [User::PAGE_FLAGS_SOAPBOX, User::PAGE_FLAGS_FREELOVE, User::PAGE_FLAGS_COMMUNITY])) {
2604 if (($user['page-flags'] == User::PAGE_FLAGS_FREELOVE) && ($network != Protocol::DIASPORA)) {
2605 self::createFromProbe($importer, $url, false, $network);
2608 $condition = ['uid' => $importer['uid'], 'url' => $url, 'pending' => true];
2609 $fields = ['pending' => false];
2610 if ($user['page-flags'] == User::PAGE_FLAGS_FREELOVE) {
2611 $fields['rel'] = self::FRIEND;
2614 DBA::update('contact', $fields, $condition);
2623 public static function removeFollower($importer, $contact)
2625 if (($contact['rel'] == self::FRIEND) || ($contact['rel'] == self::SHARING)) {
2626 DBA::update('contact', ['rel' => self::SHARING], ['id' => $contact['id']]);
2628 self::remove($contact['id']);
2632 public static function removeSharer($importer, $contact)
2634 if (($contact['rel'] == self::FRIEND) || ($contact['rel'] == self::FOLLOWER)) {
2635 DBA::update('contact', ['rel' => self::FOLLOWER], ['id' => $contact['id']]);
2637 self::remove($contact['id']);
2642 * Create a birthday event.
2644 * Update the year and the birthday.
2646 public static function updateBirthdays()
2650 AND (`contact`.`rel` = ? OR `contact`.`rel` = ?)
2651 AND NOT `contact`.`pending`
2652 AND NOT `contact`.`hidden`
2653 AND NOT `contact`.`blocked`
2654 AND NOT `contact`.`archive`
2655 AND NOT `contact`.`deleted`',
2661 $contacts = DBA::select('contact', ['id', 'uid', 'name', 'url', 'bd'], $condition);
2663 while ($contact = DBA::fetch($contacts)) {
2664 Logger::log('update_contact_birthday: ' . $contact['bd']);
2666 $nextbd = DateTimeFormat::utcNow('Y') . substr($contact['bd'], 4);
2668 if (Event::createBirthday($contact, $nextbd)) {
2672 ['bdyear' => substr($nextbd, 0, 4), 'bd' => $nextbd],
2673 ['id' => $contact['id']]
2677 DBA::close($contacts);
2681 * Remove the unavailable contact ids from the provided list
2683 * @param array $contact_ids Contact id list
2685 * @throws \Exception
2687 public static function pruneUnavailable(array $contact_ids)
2689 if (empty($contact_ids)) {
2693 $contacts = self::selectToArray(['id'], [
2694 'id' => $contact_ids,
2700 return array_column($contacts, 'id');
2704 * Returns a magic link to authenticate remote visitors
2706 * @todo check if the return is either a fully qualified URL or a relative path to Friendica basedir
2708 * @param string $contact_url The address of the target contact profile
2709 * @param string $url An url that we will be redirected to after the authentication
2711 * @return string with "redir" link
2712 * @throws HTTPException\InternalServerErrorException
2713 * @throws \ImagickException
2715 public static function magicLink($contact_url, $url = '')
2717 if (!Session::isAuthenticated()) {
2718 return $url ?: $contact_url; // Equivalent to: ($url != '') ? $url : $contact_url;
2721 $contact = self::getByURL($contact_url, false);
2722 if (empty($contact)) {
2723 return $url ?: $contact_url; // Equivalent to: ($url != '') ? $url : $contact_url;
2726 // Prevents endless loop in case only a non-public contact exists for the contact URL
2727 unset($contact['uid']);
2729 return self::magicLinkByContact($contact, $url ?: $contact_url);
2733 * Returns a magic link to authenticate remote visitors
2735 * @param integer $cid The contact id of the target contact profile
2736 * @param string $url An url that we will be redirected to after the authentication
2738 * @return string with "redir" link
2739 * @throws HTTPException\InternalServerErrorException
2740 * @throws \ImagickException
2742 public static function magicLinkById($cid, $url = '')
2744 $contact = DBA::selectFirst('contact', ['id', 'network', 'url', 'uid'], ['id' => $cid]);
2746 return self::magicLinkByContact($contact, $url);
2750 * Returns a magic link to authenticate remote visitors
2752 * @param array $contact The contact array with "uid", "network" and "url"
2753 * @param string $url An url that we will be redirected to after the authentication
2755 * @return string with "redir" link
2756 * @throws HTTPException\InternalServerErrorException
2757 * @throws \ImagickException
2759 public static function magicLinkByContact($contact, $url = '')
2761 $destination = $url ?: $contact['url']; // Equivalent to ($url != '') ? $url : $contact['url'];
2763 if (!Session::isAuthenticated()) {
2764 return $destination;
2767 // Only redirections to the same host do make sense
2768 if (($url != '') && (parse_url($url, PHP_URL_HOST) != parse_url($contact['url'], PHP_URL_HOST))) {
2772 if (DI::pConfig()->get(local_user(), 'system', 'stay_local') && ($url == '')) {
2773 return 'contact/' . $contact['id'] . '/conversations';
2776 if (!empty($contact['network']) && $contact['network'] != Protocol::DFRN) {
2777 return $destination;
2780 if (empty($contact['id'])) {
2781 return $destination;
2784 $redirect = 'redir/' . $contact['id'];
2786 if (($url != '') && !Strings::compareLink($contact['url'], $url)) {
2787 $redirect .= '?url=' . $url;
2794 * Is the contact a forum?
2796 * @param integer $contactid ID of the contact
2798 * @return boolean "true" if it is a forum
2800 public static function isForum($contactid)
2802 $fields = ['forum', 'prv'];
2803 $condition = ['id' => $contactid];
2804 $contact = DBA::selectFirst('contact', $fields, $condition);
2805 if (!DBA::isResult($contact)) {
2810 return ($contact['forum'] || $contact['prv']);
2814 * Can the remote contact receive private messages?
2816 * @param array $contact
2819 public static function canReceivePrivateMessages(array $contact)
2821 $protocol = $contact['network'] ?? $contact['protocol'] ?? Protocol::PHANTOM;
2822 $self = $contact['self'] ?? false;
2824 return in_array($protocol, [Protocol::DFRN, Protocol::DIASPORA, Protocol::ACTIVITYPUB]) && !$self;
2828 * Search contact table by nick or name
2830 * @param string $search Name or nick
2831 * @param string $mode Search mode (e.g. "community")
2832 * @param int $uid User ID
2834 * @return array with search results
2835 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
2837 public static function searchByName(string $search, string $mode = '', int $uid = 0)
2839 if (empty($search)) {
2843 // check supported networks
2844 if (DI::config()->get('system', 'diaspora_enabled')) {
2845 $diaspora = Protocol::DIASPORA;
2847 $diaspora = Protocol::DFRN;
2850 if (!DI::config()->get('system', 'ostatus_disabled')) {
2851 $ostatus = Protocol::OSTATUS;
2853 $ostatus = Protocol::DFRN;
2856 // check if we search only communities or every contact
2857 if ($mode === 'community') {
2858 $extra_sql = sprintf(' AND `contact-type` = %d', self::TYPE_COMMUNITY);
2865 $results = DBA::p("SELECT * FROM `contact`
2866 WHERE NOT `unsearchable` AND `network` IN (?, ?, ?, ?) AND
2867 NOT `failed` AND `uid` = ? AND
2868 (`addr` LIKE ? OR `name` LIKE ? OR `nick` LIKE ?) $extra_sql
2869 ORDER BY `nurl` DESC LIMIT 1000",
2870 Protocol::DFRN, Protocol::ACTIVITYPUB, $ostatus, $diaspora, $uid, $search, $search, $search
2873 $contacts = DBA::toArray($results);
2878 * Add public contacts from an array
2880 * @param array $urls
2881 * @return array result "count", "added" and "updated"
2883 public static function addByUrls(array $urls)
2890 foreach ($urls as $url) {
2891 if (empty($url) || !is_string($url)) {
2894 $contact = self::getByURL($url, false, ['id', 'updated']);
2895 if (empty($contact['id'])) {
2896 Worker::add(PRIORITY_LOW, 'AddContact', 0, $url);
2898 } elseif ($contact['updated'] < DateTimeFormat::utc('now -7 days')) {
2899 Worker::add(PRIORITY_LOW, 'UpdateContact', $contact['id']);
2907 return ['count' => $count, 'added' => $added, 'updated' => $updated, 'unchanged' => $unchanged];
2911 * Returns a random, global contact array of the current node
2913 * @return array The profile array
2916 public static function getRandomContact()
2918 $contact = DBA::selectFirst('contact', ['id', 'network', 'url', 'uid'], [
2919 "`uid` = ? AND `network` = ? AND NOT `failed` AND `last-item` > ?",
2920 0, Protocol::DFRN, DateTimeFormat::utc('now - 1 month'),
2921 ], ['order' => ['RAND()']]);
2923 if (DBA::isResult($contact)) {