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)) {
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 // Only create the entry if it doesn't exist yet
570 if (DBA::exists('contact', ['uid' => $uid, 'self' => true])) {
574 $user = DBA::selectFirst('user', ['uid', 'username', 'nickname', 'pubkey', 'prvkey'],
575 ['uid' => $uid, 'account_expired' => false]);
576 if (!DBA::isResult($user)) {
580 $return = DBA::insert('contact', [
581 'uid' => $user['uid'],
582 'created' => DateTimeFormat::utcNow(),
584 'name' => $user['username'],
585 'nick' => $user['nickname'],
586 'pubkey' => $user['pubkey'],
587 'prvkey' => $user['prvkey'],
588 'photo' => DI::baseUrl() . '/photo/profile/' . $user['uid'] . '.jpg',
589 'thumb' => DI::baseUrl() . '/photo/avatar/' . $user['uid'] . '.jpg',
590 'micro' => DI::baseUrl() . '/photo/micro/' . $user['uid'] . '.jpg',
593 'url' => DI::baseUrl() . '/profile/' . $user['nickname'],
594 'nurl' => Strings::normaliseLink(DI::baseUrl() . '/profile/' . $user['nickname']),
595 'addr' => $user['nickname'] . '@' . substr(DI::baseUrl(), strpos(DI::baseUrl(), '://') + 3),
596 'request' => DI::baseUrl() . '/dfrn_request/' . $user['nickname'],
597 'notify' => DI::baseUrl() . '/dfrn_notify/' . $user['nickname'],
598 'poll' => DI::baseUrl() . '/dfrn_poll/' . $user['nickname'],
599 'confirm' => DI::baseUrl() . '/dfrn_confirm/' . $user['nickname'],
600 'poco' => DI::baseUrl() . '/poco/' . $user['nickname'],
601 'name-date' => DateTimeFormat::utcNow(),
602 'uri-date' => DateTimeFormat::utcNow(),
603 'avatar-date' => DateTimeFormat::utcNow(),
611 * Updates the self-contact for the provided user id
614 * @param boolean $update_avatar Force the avatar update
615 * @throws HTTPException\InternalServerErrorException
617 public static function updateSelfFromUserID($uid, $update_avatar = false)
619 $fields = ['id', 'name', 'nick', 'location', 'about', 'keywords', 'avatar', 'prvkey', 'pubkey',
620 'xmpp', 'contact-type', 'forum', 'prv', 'avatar-date', 'url', 'nurl', 'unsearchable',
621 'photo', 'thumb', 'micro', 'addr', 'request', 'notify', 'poll', 'confirm', 'poco'];
622 $self = DBA::selectFirst('contact', $fields, ['uid' => $uid, 'self' => true]);
623 if (!DBA::isResult($self)) {
627 $fields = ['nickname', 'page-flags', 'account-type', 'prvkey', 'pubkey'];
628 $user = DBA::selectFirst('user', $fields, ['uid' => $uid, 'account_expired' => false]);
629 if (!DBA::isResult($user)) {
633 $fields = ['name', 'photo', 'thumb', 'about', 'address', 'locality', 'region',
634 'country-name', 'pub_keywords', 'xmpp', 'net-publish'];
635 $profile = DBA::selectFirst('profile', $fields, ['uid' => $uid]);
636 if (!DBA::isResult($profile)) {
640 $file_suffix = 'jpg';
642 $fields = ['name' => $profile['name'], 'nick' => $user['nickname'],
643 'avatar-date' => $self['avatar-date'], 'location' => Profile::formatLocation($profile),
644 'about' => $profile['about'], 'keywords' => $profile['pub_keywords'],
645 'contact-type' => $user['account-type'], 'prvkey' => $user['prvkey'],
646 'pubkey' => $user['pubkey'], 'xmpp' => $profile['xmpp']];
648 // it seems as if ported accounts can have wrong values, so we make sure that now everything is fine.
649 $fields['url'] = DI::baseUrl() . '/profile/' . $user['nickname'];
650 $fields['nurl'] = Strings::normaliseLink($fields['url']);
651 $fields['addr'] = $user['nickname'] . '@' . substr(DI::baseUrl(), strpos(DI::baseUrl(), '://') + 3);
652 $fields['request'] = DI::baseUrl() . '/dfrn_request/' . $user['nickname'];
653 $fields['notify'] = DI::baseUrl() . '/dfrn_notify/' . $user['nickname'];
654 $fields['poll'] = DI::baseUrl() . '/dfrn_poll/'. $user['nickname'];
655 $fields['confirm'] = DI::baseUrl() . '/dfrn_confirm/' . $user['nickname'];
656 $fields['poco'] = DI::baseUrl() . '/poco/' . $user['nickname'];
658 $avatar = Photo::selectFirst(['resource-id', 'type'], ['uid' => $uid, 'profile' => true]);
659 if (DBA::isResult($avatar)) {
660 if ($update_avatar) {
661 $fields['avatar-date'] = DateTimeFormat::utcNow();
664 // Creating the path to the avatar, beginning with the file suffix
665 $types = Images::supportedTypes();
666 if (isset($types[$avatar['type']])) {
667 $file_suffix = $types[$avatar['type']];
670 // We are adding a timestamp value so that other systems won't use cached content
671 $timestamp = strtotime($fields['avatar-date']);
673 $prefix = DI::baseUrl() . '/photo/' .$avatar['resource-id'] . '-';
674 $suffix = '.' . $file_suffix . '?ts=' . $timestamp;
676 $fields['photo'] = $prefix . '4' . $suffix;
677 $fields['thumb'] = $prefix . '5' . $suffix;
678 $fields['micro'] = $prefix . '6' . $suffix;
680 // We hadn't found a photo entry, so we use the default avatar
681 $fields['photo'] = self::getDefaultAvatar($fields, Proxy::SIZE_SMALL);
682 $fields['thumb'] = self::getDefaultAvatar($fields, Proxy::SIZE_THUMB);
683 $fields['micro'] = self::getDefaultAvatar($fields, Proxy::SIZE_MICRO);
686 $fields['avatar'] = DI::baseUrl() . '/photo/profile/' .$uid . '.' . $file_suffix;
687 $fields['forum'] = $user['page-flags'] == User::PAGE_FLAGS_COMMUNITY;
688 $fields['prv'] = $user['page-flags'] == User::PAGE_FLAGS_PRVGROUP;
689 $fields['unsearchable'] = !$profile['net-publish'];
693 foreach ($fields as $field => $content) {
694 if ($self[$field] != $content) {
700 if ($fields['name'] != $self['name']) {
701 $fields['name-date'] = DateTimeFormat::utcNow();
703 $fields['updated'] = DateTimeFormat::utcNow();
704 DBA::update('contact', $fields, ['id' => $self['id']]);
706 // Update the public contact as well
707 DBA::update('contact', $fields, ['uid' => 0, 'nurl' => $self['nurl']]);
709 // Update the profile
710 $fields = ['photo' => DI::baseUrl() . '/photo/profile/' .$uid . '.' . $file_suffix,
711 'thumb' => DI::baseUrl() . '/photo/avatar/' . $uid .'.' . $file_suffix];
712 DBA::update('profile', $fields, ['uid' => $uid]);
717 * Marks a contact for removal
719 * @param int $id contact id
721 * @throws HTTPException\InternalServerErrorException
723 public static function remove($id)
725 // We want just to make sure that we don't delete our "self" contact
726 $contact = DBA::selectFirst('contact', ['uid'], ['id' => $id, 'self' => false]);
727 if (!DBA::isResult($contact)) {
731 // Archive the contact
732 DBA::update('contact', ['archive' => true, 'network' => Protocol::PHANTOM, 'deleted' => true], ['id' => $id]);
734 // Delete it in the background
735 Worker::add(PRIORITY_MEDIUM, 'RemoveContact', $id);
739 * Sends an unfriend message. Does not remove the contact
741 * @param array $user User unfriending
742 * @param array $contact Contact unfriended
743 * @param boolean $dissolve Remove the contact on the remote side
745 * @throws HTTPException\InternalServerErrorException
746 * @throws \ImagickException
748 public static function terminateFriendship(array $user, array $contact, $dissolve = false)
750 if (empty($contact['network'])) {
754 $protocol = $contact['network'];
755 if (($protocol == Protocol::DFRN) && !self::isLegacyDFRNContact($contact)) {
756 $protocol = Protocol::ACTIVITYPUB;
759 if (($protocol == Protocol::DFRN) && $dissolve) {
760 DFRN::deliver($user, $contact, 'placeholder', true);
761 } elseif (in_array($protocol, [Protocol::OSTATUS, Protocol::DFRN])) {
762 // create an unfollow slap
764 $item['verb'] = Activity::O_UNFOLLOW;
765 $item['gravity'] = GRAVITY_ACTIVITY;
766 $item['follow'] = $contact["url"];
771 $slap = OStatus::salmon($item, $user);
773 if (!empty($contact['notify'])) {
774 Salmon::slapper($user, $contact['notify'], $slap);
776 } elseif ($protocol == Protocol::DIASPORA) {
777 Diaspora::sendUnshare($user, $contact);
778 } elseif ($protocol == Protocol::ACTIVITYPUB) {
779 ActivityPub\Transmitter::sendContactUndo($contact['url'], $contact['id'], $user['uid']);
782 ActivityPub\Transmitter::sendContactReject($contact['url'], $contact['hub-verify'], $user['uid']);
788 * Marks a contact for archival after a communication issue delay
790 * Contact has refused to recognise us as a friend. We will start a countdown.
791 * If they still don't recognise us in 32 days, the relationship is over,
792 * and we won't waste any more time trying to communicate with them.
793 * This provides for the possibility that their database is temporarily messed
794 * up or some other transient event and that there's a possibility we could recover from it.
796 * @param array $contact contact to mark for archival
798 * @throws HTTPException\InternalServerErrorException
800 public static function markForArchival(array $contact)
802 if (!isset($contact['url']) && !empty($contact['id'])) {
803 $fields = ['id', 'url', 'archive', 'self', 'term-date'];
804 $contact = DBA::selectFirst('contact', $fields, ['id' => $contact['id']]);
805 if (!DBA::isResult($contact)) {
808 } elseif (!isset($contact['url'])) {
809 Logger::info('Empty contact', ['contact' => $contact, 'callstack' => System::callstack(20)]);
812 Logger::info('Contact is marked for archival', ['id' => $contact['id'], 'term-date' => $contact['term-date']]);
814 // Contact already archived or "self" contact? => nothing to do
815 if ($contact['archive'] || $contact['self']) {
819 if ($contact['term-date'] <= DBA::NULL_DATETIME) {
820 DBA::update('contact', ['term-date' => DateTimeFormat::utcNow()], ['id' => $contact['id']]);
821 DBA::update('contact', ['term-date' => DateTimeFormat::utcNow()], ['`nurl` = ? AND `term-date` <= ? AND NOT `self`', Strings::normaliseLink($contact['url']), DBA::NULL_DATETIME]);
824 * We really should send a notification to the owner after 2-3 weeks
825 * so they won't be surprised when the contact vanishes and can take
826 * remedial action if this was a serious mistake or glitch
829 /// @todo Check for contact vitality via probing
830 $archival_days = DI::config()->get('system', 'archival_days', 32);
832 $expiry = $contact['term-date'] . ' + ' . $archival_days . ' days ';
833 if (DateTimeFormat::utcNow() > DateTimeFormat::utc($expiry)) {
834 /* Relationship is really truly dead. archive them rather than
835 * delete, though if the owner tries to unarchive them we'll start
836 * the whole process over again.
838 DBA::update('contact', ['archive' => true], ['id' => $contact['id']]);
839 DBA::update('contact', ['archive' => true], ['nurl' => Strings::normaliseLink($contact['url']), 'self' => false]);
845 * Cancels the archival countdown
847 * @see Contact::markForArchival()
849 * @param array $contact contact to be unmarked for archival
853 public static function unmarkForArchival(array $contact)
855 // Always unarchive the relay contact entry
856 if (!empty($contact['batch']) && !empty($contact['term-date']) && ($contact['term-date'] > DBA::NULL_DATETIME)) {
857 $fields = ['failed' => false, 'term-date' => DBA::NULL_DATETIME, 'archive' => false];
858 $condition = ['uid' => 0, 'network' => Protocol::FEDERATED, 'batch' => $contact['batch'], 'contact-type' => self::TYPE_RELAY];
859 if (!DBA::exists('contact', array_merge($condition, $fields))) {
860 DBA::update('contact', $fields, $condition);
864 $condition = ['`id` = ? AND (`term-date` > ? OR `archive`)', $contact['id'], DBA::NULL_DATETIME];
865 $exists = DBA::exists('contact', $condition);
867 // We don't need to update, we never marked this contact for archival
872 Logger::info('Contact is marked as vital again', ['id' => $contact['id'], 'term-date' => $contact['term-date']]);
874 if (!isset($contact['url']) && !empty($contact['id'])) {
875 $fields = ['id', 'url', 'batch'];
876 $contact = DBA::selectFirst('contact', $fields, ['id' => $contact['id']]);
877 if (!DBA::isResult($contact)) {
882 // It's a miracle. Our dead contact has inexplicably come back to life.
883 $fields = ['failed' => false, 'term-date' => DBA::NULL_DATETIME, 'archive' => false];
884 DBA::update('contact', $fields, ['id' => $contact['id']]);
885 DBA::update('contact', $fields, ['nurl' => Strings::normaliseLink($contact['url']), 'self' => false]);
889 * Returns the data array for the photo menu of a given contact
891 * @param array $contact contact
892 * @param int $uid optional, default 0
894 * @throws HTTPException\InternalServerErrorException
895 * @throws \ImagickException
897 public static function photoMenu(array $contact, $uid = 0)
902 $contact_drop_link = '';
909 if (empty($contact['uid']) || ($contact['uid'] != $uid)) {
911 $profile_link = self::magicLinkByContact($contact);
912 $menu = ['profile' => [DI::l10n()->t('View Profile'), $profile_link, true]];
917 // Look for our own contact if the uid doesn't match and isn't public
918 $contact_own = DBA::selectFirst('contact', [], ['nurl' => $contact['nurl'], 'network' => $contact['network'], 'uid' => $uid]);
919 if (DBA::isResult($contact_own)) {
920 return self::photoMenu($contact_own, $uid);
925 if (($contact['network'] === Protocol::DFRN) && !$contact['self'] && empty($contact['pending'])) {
927 $profile_link = DI::baseUrl() . '/redir/' . $contact['id'];
929 $profile_link = $contact['url'];
932 if ($profile_link === 'mailbox') {
937 $status_link = $profile_link . '/status';
938 $photos_link = str_replace('/profile/', '/photos/', $profile_link);
939 $profile_link = $profile_link . '/profile';
942 if (self::canReceivePrivateMessages($contact) && empty($contact['pending'])) {
943 $pm_url = DI::baseUrl() . '/message/new/' . $contact['id'];
946 if (($contact['network'] == Protocol::DFRN) && !$contact['self'] && empty($contact['pending'])) {
947 $poke_link = 'contact/' . $contact['id'] . '/poke';
950 $contact_url = DI::baseUrl() . '/contact/' . $contact['id'];
952 $posts_link = DI::baseUrl() . '/contact/' . $contact['id'] . '/conversations';
954 if (!$contact['self']) {
955 $contact_drop_link = DI::baseUrl() . '/contact/' . $contact['id'] . '/drop?confirm=1';
960 if (!$contact['self'] && in_array($contact['network'], Protocol::NATIVE_SUPPORT)) {
961 if ($contact['uid'] && in_array($contact['rel'], [self::SHARING, self::FRIEND])) {
962 $unfollow_link = 'unfollow?url=' . urlencode($contact['url']) . '&auto=1';
963 } elseif(!$contact['pending']) {
964 $follow_link = 'follow?url=' . urlencode($contact['url']) . '&auto=1';
968 if (!empty($follow_link) || !empty($unfollow_link)) {
969 $contact_drop_link = '';
974 * "name" => [ "Label", "link", (bool)Should the link opened in a new tab? ]
976 if (empty($contact['uid'])) {
978 'profile' => [DI::l10n()->t('View Profile') , $profile_link , true],
979 'network' => [DI::l10n()->t('Network Posts') , $posts_link , false],
980 'edit' => [DI::l10n()->t('View Contact') , $contact_url , false],
981 'follow' => [DI::l10n()->t('Connect/Follow'), $follow_link , true],
982 'unfollow'=> [DI::l10n()->t('UnFollow') , $unfollow_link, true],
986 'status' => [DI::l10n()->t('View Status') , $status_link , true],
987 'profile' => [DI::l10n()->t('View Profile') , $profile_link , true],
988 'photos' => [DI::l10n()->t('View Photos') , $photos_link , true],
989 'network' => [DI::l10n()->t('Network Posts') , $posts_link , false],
990 'edit' => [DI::l10n()->t('View Contact') , $contact_url , false],
991 'drop' => [DI::l10n()->t('Drop Contact') , $contact_drop_link, false],
992 'pm' => [DI::l10n()->t('Send PM') , $pm_url , false],
993 'poke' => [DI::l10n()->t('Poke') , $poke_link , false],
994 'follow' => [DI::l10n()->t('Connect/Follow'), $follow_link , true],
995 'unfollow'=> [DI::l10n()->t('UnFollow') , $unfollow_link , true],
998 if (!empty($contact['pending'])) {
999 $intro = DBA::selectFirst('intro', ['id'], ['contact-id' => $contact['id']]);
1000 if (DBA::isResult($intro)) {
1001 $menu['follow'] = [DI::l10n()->t('Approve'), 'notifications/intros/' . $intro['id'], true];
1006 $args = ['contact' => $contact, 'menu' => &$menu];
1008 Hook::callAll('contact_photo_menu', $args);
1010 $menucondensed = [];
1012 foreach ($menu as $menuname => $menuitem) {
1013 if ($menuitem[1] != '') {
1014 $menucondensed[$menuname] = $menuitem;
1018 return $menucondensed;
1022 * Fetch the contact id for a given URL and user
1024 * First lookup in the contact table to find a record matching either `url`, `nurl`,
1025 * `addr` or `alias`.
1027 * If there's no record and we aren't looking for a public contact, we quit.
1028 * If there's one, we check that it isn't time to update the picture else we
1029 * directly return the found contact id.
1031 * Second, we probe the provided $url whether it's http://server.tld/profile or
1032 * nick@server.tld. We quit if we can't get any info back.
1034 * Third, we create the contact record if it doesn't exist
1036 * Fourth, we update the existing record with the new data (avatar, alias, nick)
1037 * if there's any updates
1039 * @param string $url Contact URL
1040 * @param integer $uid The user id for the contact (0 = public contact)
1041 * @param boolean $update true = always update, false = never update, null = update when not found
1042 * @param array $default Default value for creating the contact when everything else fails
1044 * @return integer Contact ID
1045 * @throws HTTPException\InternalServerErrorException
1046 * @throws \ImagickException
1048 public static function getIdForURL($url, $uid = 0, $update = null, $default = [])
1053 Logger::notice('Empty url, quitting', ['url' => $url, 'user' => $uid, 'default' => $default]);
1057 $contact = self::getByURL($url, false, ['id', 'network'], $uid);
1059 if (!empty($contact)) {
1060 $contact_id = $contact["id"];
1062 if (empty($update)) {
1063 Logger::debug('Contact found', ['url' => $url, 'uid' => $uid, 'update' => $update, 'cid' => $contact_id]);
1066 } elseif ($uid != 0) {
1067 Logger::debug('Contact does not exist for the user', ['url' => $url, 'uid' => $uid, 'update' => $update]);
1069 } elseif (empty($default) && !is_null($update) && !$update) {
1070 Logger::info('Contact not found, update not desired', ['url' => $url, 'uid' => $uid, 'update' => $update]);
1076 if (empty($default['network']) || $update) {
1077 $data = Probe::uri($url, "", $uid);
1079 // Take the default values when probing failed
1080 if (!empty($default) && !in_array($data["network"], array_merge(Protocol::NATIVE_SUPPORT, [Protocol::PUMPIO]))) {
1081 $data = array_merge($data, $default);
1083 } elseif (!empty($default['network'])) {
1087 if (($uid == 0) && (empty($data['network']) || ($data['network'] == Protocol::PHANTOM))) {
1088 // Fetch data for the public contact via the first found personal contact
1089 /// @todo Check if this case can happen at all (possibly with mail accounts?)
1090 $fields = ['name', 'nick', 'url', 'addr', 'alias', 'avatar', 'contact-type',
1091 'keywords', 'location', 'about', 'unsearchable', 'batch', 'notify', 'poll',
1092 'request', 'confirm', 'poco', 'subscribe', 'network', 'baseurl', 'gsid'];
1094 $personal_contact = DBA::selectFirst('contact', $fields, ["`addr` = ? AND `uid` != 0", $url]);
1095 if (!DBA::isResult($personal_contact)) {
1096 $personal_contact = DBA::selectFirst('contact', $fields, ["`nurl` = ? AND `uid` != 0", Strings::normaliseLink($url)]);
1099 if (DBA::isResult($personal_contact)) {
1100 Logger::info('Take contact data from personal contact', ['url' => $url, 'update' => $update, 'contact' => $personal_contact, 'callstack' => System::callstack(20)]);
1101 $data = $personal_contact;
1102 $data['photo'] = $personal_contact['avatar'];
1103 $data['account-type'] = $personal_contact['contact-type'];
1104 $data['hide'] = $personal_contact['unsearchable'];
1105 unset($data['avatar']);
1106 unset($data['contact-type']);
1107 unset($data['unsearchable']);
1111 if (empty($data['network']) || ($data['network'] == Protocol::PHANTOM)) {
1112 Logger::notice('No valid network found', ['url' => $url, 'uid' => $uid, 'default' => $default, 'update' => $update, 'callstack' => System::callstack(20)]);
1117 $urls = [Strings::normaliseLink($url), Strings::normaliseLink($data['url'])];
1118 if (!empty($data['alias'])) {
1119 $urls[] = Strings::normaliseLink($data['alias']);
1121 $contact = self::selectFirst(['id'], ['nurl' => $urls, 'uid' => $uid]);
1122 if (!empty($contact['id'])) {
1123 $contact_id = $contact['id'];
1124 Logger::info('Fetched id by url', ['cid' => $contact_id, 'uid' => $uid, 'url' => $url, 'data' => $data]);
1129 // We only insert the basic data. The rest will be done in "updateFromProbeArray"
1132 'url' => $data['url'],
1133 'nurl' => Strings::normaliseLink($data['url']),
1134 'network' => $data['network'],
1135 'created' => DateTimeFormat::utcNow(),
1136 'rel' => self::SHARING,
1142 $condition = ['nurl' => Strings::normaliseLink($data["url"]), 'uid' => $uid, 'deleted' => false];
1144 // Before inserting we do check if the entry does exist now.
1145 if (DI::lock()->acquire(self::LOCK_INSERT, 0)) {
1146 $contact = DBA::selectFirst('contact', ['id'], $condition, ['order' => ['id']]);
1147 if (DBA::isResult($contact)) {
1148 $contact_id = $contact['id'];
1149 Logger::notice('Contact had been created (shortly) before', ['id' => $contact_id, 'url' => $url, 'uid' => $uid]);
1151 DBA::insert('contact', $fields);
1152 $contact_id = DBA::lastInsertId();
1154 Logger::info('Contact inserted', ['id' => $contact_id, 'url' => $url, 'uid' => $uid]);
1157 DI::lock()->release(self::LOCK_INSERT);
1159 Logger::warning('Contact lock had not been acquired');
1163 Logger::info('Contact was not inserted', ['url' => $url, 'uid' => $uid]);
1167 Logger::info('Contact will be updated', ['url' => $url, 'uid' => $uid, 'update' => $update, 'cid' => $contact_id]);
1170 self::updateFromProbeArray($contact_id, $data);
1172 // Don't return a number for a deleted account
1173 if (!empty($data['account-type']) && $data['account-type'] == User::ACCOUNT_TYPE_DELETED) {
1174 Logger::info('Contact is a tombstone', ['url' => $url, 'uid' => $uid]);
1182 * Checks if the contact is archived
1184 * @param int $cid contact id
1186 * @return boolean Is the contact archived?
1187 * @throws HTTPException\InternalServerErrorException
1189 public static function isArchived(int $cid)
1195 $contact = DBA::selectFirst('contact', ['archive', 'url', 'batch'], ['id' => $cid]);
1196 if (!DBA::isResult($contact)) {
1200 if ($contact['archive']) {
1204 // Check status of ActivityPub endpoints
1205 $apcontact = APContact::getByURL($contact['url'], false);
1206 if (!empty($apcontact)) {
1207 if (!empty($apcontact['inbox']) && DBA::exists('inbox-status', ['archive' => true, 'url' => $apcontact['inbox']])) {
1211 if (!empty($apcontact['sharedinbox']) && DBA::exists('inbox-status', ['archive' => true, 'url' => $apcontact['sharedinbox']])) {
1216 // Check status of Diaspora endpoints
1217 if (!empty($contact['batch'])) {
1218 $condition = ['archive' => true, 'uid' => 0, 'network' => Protocol::FEDERATED, 'batch' => $contact['batch'], 'contact-type' => self::TYPE_RELAY];
1219 return DBA::exists('contact', $condition);
1226 * Checks if the contact is blocked
1228 * @param int $cid contact id
1230 * @return boolean Is the contact blocked?
1231 * @throws HTTPException\InternalServerErrorException
1233 public static function isBlocked($cid)
1239 $blocked = DBA::selectFirst('contact', ['blocked', 'url'], ['id' => $cid]);
1240 if (!DBA::isResult($blocked)) {
1244 if (Network::isUrlBlocked($blocked['url'])) {
1248 return (bool) $blocked['blocked'];
1252 * Checks if the contact is hidden
1254 * @param int $cid contact id
1256 * @return boolean Is the contact hidden?
1257 * @throws \Exception
1259 public static function isHidden($cid)
1265 $hidden = DBA::selectFirst('contact', ['hidden'], ['id' => $cid]);
1266 if (!DBA::isResult($hidden)) {
1269 return (bool) $hidden['hidden'];
1273 * Returns posts from a given contact url
1275 * @param string $contact_url Contact URL
1276 * @param bool $thread_mode
1277 * @param int $update Update mode
1278 * @param int $parent Item parent ID for the update mode
1279 * @return string posts in HTML
1280 * @throws \Exception
1282 public static function getPostsFromUrl($contact_url, $thread_mode = false, $update = 0, $parent = 0)
1284 return self::getPostsFromId(self::getIdForURL($contact_url), $thread_mode, $update, $parent);
1288 * Returns posts from a given contact id
1290 * @param int $cid Contact ID
1291 * @param bool $thread_mode
1292 * @param int $update Update mode
1293 * @param int $parent Item parent ID for the update mode
1294 * @return string posts in HTML
1295 * @throws \Exception
1297 public static function getPostsFromId($cid, $thread_mode = false, $update = 0, $parent = 0)
1301 $contact = DBA::selectFirst('contact', ['contact-type', 'network'], ['id' => $cid]);
1302 if (!DBA::isResult($contact)) {
1306 if (empty($contact["network"]) || in_array($contact["network"], Protocol::FEDERATED)) {
1307 $sql = "(`uid` = 0 OR (`uid` = ? AND NOT `global`))";
1312 $contact_field = ((($contact["contact-type"] == self::TYPE_COMMUNITY) || ($contact['network'] == Protocol::MAIL)) ? 'owner-id' : 'author-id');
1315 $condition = ["((`$contact_field` = ? AND `gravity` = ?) OR (`author-id` = ? AND `gravity` = ? AND `vid` = ?)) AND " . $sql,
1316 $cid, GRAVITY_PARENT, $cid, GRAVITY_ACTIVITY, Verb::getID(Activity::ANNOUNCE), local_user()];
1318 $condition = ["`$contact_field` = ? AND `gravity` IN (?, ?) AND " . $sql,
1319 $cid, GRAVITY_PARENT, GRAVITY_COMMENT, local_user()];
1322 if (!empty($parent)) {
1323 $condition = DBA::mergeConditions($condition, ['parent' => $parent]);
1325 $last_received = isset($_GET['last_received']) ? DateTimeFormat::utc($_GET['last_received']) : '';
1326 if (!empty($last_received)) {
1327 $condition = DBA::mergeConditions($condition, ["`received` < ?", $last_received]);
1331 if (DI::mode()->isMobile()) {
1332 $itemsPerPage = DI::pConfig()->get(local_user(), 'system', 'itemspage_mobile_network',
1333 DI::config()->get('system', 'itemspage_network_mobile'));
1335 $itemsPerPage = DI::pConfig()->get(local_user(), 'system', 'itemspage_network',
1336 DI::config()->get('system', 'itemspage_network'));
1339 $pager = new Pager(DI::l10n(), DI::args()->getQueryString(), $itemsPerPage);
1341 $params = ['order' => ['received' => true], 'limit' => [$pager->getStart(), $pager->getItemsPerPage()]];
1343 if (DI::pConfig()->get(local_user(), 'system', 'infinite_scroll')) {
1344 $tpl = Renderer::getMarkupTemplate('infinite_scroll_head.tpl');
1345 $o = Renderer::replaceMacros($tpl, ['$reload_uri' => DI::args()->getQueryString()]);
1351 $items = Post::toArray(Post::selectForUser(local_user(), ['uri-id', 'gravity', 'parent-uri-id', 'thr-parent-id', 'author-id'], $condition, $params));
1353 $o .= conversation($a, $items, 'contacts', $update, false, 'commented', local_user());
1355 $items = Post::toArray(Post::selectForUser(local_user(), Item::DISPLAY_FIELDLIST, $condition, $params));
1357 $o .= conversation($a, $items, 'contact-posts', $update);
1361 if (DI::pConfig()->get(local_user(), 'system', 'infinite_scroll')) {
1362 $o .= HTML::scrollLoader();
1364 $o .= $pager->renderMinimal(count($items));
1372 * Returns the account type name
1374 * The function can be called with either the user or the contact array
1376 * @param array $contact contact or user array
1379 public static function getAccountType(array $contact)
1381 // There are several fields that indicate that the contact or user is a forum
1382 // "page-flags" is a field in the user table,
1383 // "forum" and "prv" are used in the contact table. They stand for User::PAGE_FLAGS_COMMUNITY and User::PAGE_FLAGS_PRVGROUP.
1384 if ((isset($contact['page-flags']) && (intval($contact['page-flags']) == User::PAGE_FLAGS_COMMUNITY))
1385 || (isset($contact['page-flags']) && (intval($contact['page-flags']) == User::PAGE_FLAGS_PRVGROUP))
1386 || (isset($contact['forum']) && intval($contact['forum']))
1387 || (isset($contact['prv']) && intval($contact['prv']))
1388 || (isset($contact['community']) && intval($contact['community']))
1390 $type = self::TYPE_COMMUNITY;
1392 $type = self::TYPE_PERSON;
1395 // The "contact-type" (contact table) and "account-type" (user table) are more general then the chaos from above.
1396 if (isset($contact["contact-type"])) {
1397 $type = $contact["contact-type"];
1400 if (isset($contact["account-type"])) {
1401 $type = $contact["account-type"];
1405 case self::TYPE_ORGANISATION:
1406 $account_type = DI::l10n()->t("Organisation");
1409 case self::TYPE_NEWS:
1410 $account_type = DI::l10n()->t('News');
1413 case self::TYPE_COMMUNITY:
1414 $account_type = DI::l10n()->t("Forum");
1422 return $account_type;
1430 * @throws \Exception
1432 public static function block($cid, $reason = null)
1434 $return = DBA::update('contact', ['blocked' => true, 'block_reason' => $reason], ['id' => $cid]);
1440 * Unblocks a contact
1444 * @throws \Exception
1446 public static function unblock($cid)
1448 $return = DBA::update('contact', ['blocked' => false, 'block_reason' => null], ['id' => $cid]);
1454 * Ensure that cached avatar exist
1456 * @param integer $cid
1458 public static function checkAvatarCache(int $cid)
1460 $contact = DBA::selectFirst('contact', ['url', 'avatar', 'photo', 'thumb', 'micro'], ['id' => $cid, 'uid' => 0, 'self' => false]);
1461 if (!DBA::isResult($contact)) {
1465 if (empty($contact['avatar']) || (!empty($contact['photo']) && !empty($contact['thumb']) && !empty($contact['micro']))) {
1469 Logger::info('Adding avatar cache', ['id' => $cid, 'contact' => $contact]);
1471 self::updateAvatar($cid, $contact['avatar'], true);
1475 * Return the photo path for a given contact array in the given size
1477 * @param array $contact contact array
1478 * @param string $field Fieldname of the photo in the contact array
1479 * @param string $size Size of the avatar picture
1480 * @param string $avatar Avatar path that is displayed when no photo had been found
1481 * @param bool $no_update Don't perfom an update if no cached avatar was found
1482 * @return string photo path
1484 private static function getAvatarPath(array $contact, string $field, string $size, string $avatar, $no_update = false)
1486 if (!empty($contact)) {
1487 $contact = self::checkAvatarCacheByArray($contact, $no_update);
1488 if (!empty($contact[$field])) {
1489 $avatar = $contact[$field];
1493 if ($no_update && empty($avatar) && !empty($contact['avatar'])) {
1494 $avatar = $contact['avatar'];
1497 if (empty($avatar)) {
1498 $avatar = self::getDefaultAvatar([], $size);
1501 if (Proxy::isLocalImage($avatar)) {
1504 return Proxy::proxifyUrl($avatar, false, $size);
1509 * Return the photo path for a given contact array
1511 * @param array $contact Contact array
1512 * @param string $avatar Avatar path that is displayed when no photo had been found
1513 * @param bool $no_update Don't perfom an update if no cached avatar was found
1514 * @return string photo path
1516 public static function getPhoto(array $contact, string $avatar = '', bool $no_update = false)
1518 return self::getAvatarPath($contact, 'photo', Proxy::SIZE_SMALL, $avatar, $no_update);
1522 * Return the photo path (thumb size) 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 getThumb(array $contact, string $avatar = '', bool $no_update = false)
1531 return self::getAvatarPath($contact, 'thumb', Proxy::SIZE_THUMB, $avatar, $no_update);
1535 * Return the photo path (micro 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 getMicro(array $contact, string $avatar = '', bool $no_update = false)
1544 return self::getAvatarPath($contact, 'micro', Proxy::SIZE_MICRO, $avatar, $no_update);
1548 * Check the given contact array for avatar cache fields
1550 * @param array $contact
1551 * @param bool $no_update Don't perfom an update if no cached avatar was found
1552 * @return array contact array with avatar cache fields
1554 private static function checkAvatarCacheByArray(array $contact, bool $no_update = false)
1557 $contact_fields = [];
1558 $fields = ['photo', 'thumb', 'micro'];
1559 foreach ($fields as $field) {
1560 if (isset($contact[$field])) {
1561 $contact_fields[] = $field;
1563 if (isset($contact[$field]) && empty($contact[$field])) {
1568 if (!$update || $no_update) {
1572 if (!empty($contact['id']) && !empty($contact['avatar'])) {
1573 self::updateAvatar($contact['id'], $contact['avatar'], true);
1575 $new_contact = self::getById($contact['id'], $contact_fields);
1576 if (DBA::isResult($new_contact)) {
1577 // We only update the cache fields
1578 $contact = array_merge($contact, $new_contact);
1582 /// add the default avatars if the fields aren't filled
1583 if (isset($contact['photo']) && empty($contact['photo'])) {
1584 $contact['photo'] = self::getDefaultAvatar($contact, Proxy::SIZE_SMALL);
1586 if (isset($contact['thumb']) && empty($contact['thumb'])) {
1587 $contact['thumb'] = self::getDefaultAvatar($contact, Proxy::SIZE_THUMB);
1589 if (isset($contact['micro']) && empty($contact['micro'])) {
1590 $contact['micro'] = self::getDefaultAvatar($contact, Proxy::SIZE_MICRO);
1597 * Fetch the default avatar for the given contact and size
1599 * @param array $contact contact array
1600 * @param string $size Size of the avatar picture
1603 public static function getDefaultAvatar(array $contact, string $size)
1606 case Proxy::SIZE_MICRO:
1607 $avatar['size'] = 48;
1608 $default = self::DEFAULT_AVATAR_MICRO;
1611 case Proxy::SIZE_THUMB:
1612 $avatar['size'] = 80;
1613 $default = self::DEFAULT_AVATAR_THUMB;
1616 case Proxy::SIZE_SMALL:
1618 $avatar['size'] = 300;
1619 $default = self::DEFAULT_AVATAR_PHOTO;
1623 if (!DI::config()->get('system', 'remote_avatar_lookup')) {
1624 return DI::baseUrl() . $default;
1627 if (!empty($contact['xmpp'])) {
1628 $avatar['email'] = $contact['xmpp'];
1629 } elseif (!empty($contact['addr'])) {
1630 $avatar['email'] = $contact['addr'];
1631 } elseif (!empty($contact['url'])) {
1632 $avatar['email'] = $contact['url'];
1634 return DI::baseUrl() . $default;
1637 $avatar['url'] = '';
1638 $avatar['success'] = false;
1640 Hook::callAll('avatar_lookup', $avatar);
1642 if ($avatar['success'] && !empty($avatar['url'])) {
1643 return $avatar['url'];
1646 return DI::baseUrl() . $default;
1650 * Updates the avatar links in a contact only if needed
1652 * @param int $cid Contact id
1653 * @param string $avatar Link to avatar picture
1654 * @param bool $force force picture update
1655 * @param bool $create_cache Enforces the creation of cached avatar fields
1658 * @throws HTTPException\InternalServerErrorException
1659 * @throws HTTPException\NotFoundException
1660 * @throws \ImagickException
1662 public static function updateAvatar(int $cid, string $avatar, bool $force = false, bool $create_cache = false)
1664 $contact = DBA::selectFirst('contact', ['uid', 'avatar', 'photo', 'thumb', 'micro', 'xmpp', 'addr', 'nurl', 'url', 'network'],
1665 ['id' => $cid, 'self' => false]);
1666 if (!DBA::isResult($contact)) {
1670 $uid = $contact['uid'];
1672 // Only update the cached photo links of public contacts when they already are cached
1673 if (($uid == 0) && !$force && empty($contact['thumb']) && empty($contact['micro']) && !$create_cache) {
1674 if ($contact['avatar'] != $avatar) {
1675 DBA::update('contact', ['avatar' => $avatar], ['id' => $cid]);
1676 Logger::info('Only update the avatar', ['id' => $cid, 'avatar' => $avatar, 'contact' => $contact]);
1681 // User contacts use are updated through the public contacts
1682 if (($uid != 0) && !in_array($contact['network'], [Protocol::FEED, Protocol::MAIL])) {
1683 $pcid = self::getIdForURL($contact['url'], false);
1684 if (!empty($pcid)) {
1685 Logger::debug('Update the private contact via the public contact', ['id' => $cid, 'uid' => $uid, 'public' => $pcid]);
1686 self::updateAvatar($pcid, $avatar, $force, true);
1691 $default_avatar = empty($avatar) || strpos($avatar, self::DEFAULT_AVATAR_PHOTO);
1693 if ($default_avatar) {
1694 $avatar = self::getDefaultAvatar($contact, Proxy::SIZE_SMALL);
1697 if ($default_avatar && Proxy::isLocalImage($avatar)) {
1698 $fields = ['avatar' => $avatar, 'avatar-date' => DateTimeFormat::utcNow(),
1700 'thumb' => self::getDefaultAvatar($contact, Proxy::SIZE_THUMB),
1701 'micro' => self::getDefaultAvatar($contact, Proxy::SIZE_MICRO)];
1702 Logger::debug('Use default avatar', ['id' => $cid, 'uid' => $uid]);
1705 // Use the data from the self account
1706 if (empty($fields)) {
1707 $local_uid = User::getIdForURL($contact['url']);
1708 if (!empty($local_uid)) {
1709 $fields = self::selectFirst(['avatar', 'avatar-date', 'photo', 'thumb', 'micro'], ['self' => true, 'uid' => $local_uid]);
1710 Logger::debug('Use owner data', ['id' => $cid, 'uid' => $uid, 'owner-uid' => $local_uid]);
1714 if (empty($fields)) {
1715 $update = ($contact['avatar'] != $avatar) || $force;
1719 $contact['photo'] ?? '',
1720 $contact['thumb'] ?? '',
1721 $contact['micro'] ?? '',
1724 foreach ($data as $image_uri) {
1725 $image_rid = Photo::ridFromURI($image_uri);
1726 if ($image_rid && !Photo::exists(['resource-id' => $image_rid, 'uid' => $uid])) {
1727 Logger::debug('Regenerating avatar', ['contact uid' => $uid, 'cid' => $cid, 'missing photo' => $image_rid, 'avatar' => $contact['avatar']]);
1734 $photos = Photo::importProfilePhoto($avatar, $uid, $cid, true);
1736 $fields = ['avatar' => $avatar, 'photo' => $photos[0], 'thumb' => $photos[1], 'micro' => $photos[2], 'avatar-date' => DateTimeFormat::utcNow()];
1737 $update = !empty($fields);
1738 Logger::debug('Created new cached avatars', ['id' => $cid, 'uid' => $uid, 'owner-uid' => $local_uid]);
1744 $update = ($fields['photo'] . $fields['thumb'] . $fields['micro'] != $contact['photo'] . $contact['thumb'] . $contact['micro']) || $force;
1753 if (($uid == 0) && !in_array($contact['network'], [Protocol::FEED, Protocol::MAIL])) {
1754 // Collect all user contacts of the given public contact
1755 $personal_contacts = DBA::select('contact', ['id', 'uid'],
1756 ["`nurl` = ? AND `id` != ? AND NOT `self`", $contact['nurl'], $cid]);
1757 while ($personal_contact = DBA::fetch($personal_contacts)) {
1758 $cids[] = $personal_contact['id'];
1759 $uids[] = $personal_contact['uid'];
1761 DBA::close($personal_contacts);
1763 if (!empty($cids)) {
1764 // Delete possibly existing cached user contact avatars
1765 Photo::delete(['uid' => $uids, 'contact-id' => $cids, 'album' => Photo::CONTACT_PHOTOS]);
1771 Logger::info('Updating cached contact avatars', ['cid' => $cids, 'uid' => $uids, 'fields' => $fields]);
1772 DBA::update('contact', $fields, ['id' => $cids]);
1775 public static function deleteContactByUrl(string $url)
1777 // Update contact data for all users
1778 $condition = ['self' => false, 'nurl' => Strings::normaliseLink($url)];
1779 $contacts = DBA::select('contact', ['id', 'uid'], $condition);
1780 while ($contact = DBA::fetch($contacts)) {
1781 Logger::info('Deleting contact', ['id' => $contact['id'], 'uid' => $contact['uid'], 'url' => $url]);
1782 self::remove($contact['id']);
1787 * Helper function for "updateFromProbe". Updates personal and public contact
1789 * @param integer $id contact id
1790 * @param integer $uid user id
1791 * @param string $old_url The previous profile URL of the contact
1792 * @param string $new_url The profile URL of the contact
1793 * @param array $fields The fields that are updated
1795 * @throws \Exception
1797 private static function updateContact(int $id, int $uid, string $old_url, string $new_url, array $fields)
1799 if (Strings::normaliseLink($new_url) != Strings::normaliseLink($old_url)) {
1800 Logger::notice('New URL differs from old URL', ['old' => $old_url, 'new' => $new_url]);
1801 // @todo It is to decide what to do when the URL is changed
1804 if (!DBA::update('contact', $fields, ['id' => $id])) {
1805 Logger::info('Couldn\'t update contact.', ['id' => $id, 'fields' => $fields]);
1809 // Search for duplicated contacts and get rid of them
1810 if (self::removeDuplicates(Strings::normaliseLink($new_url), $uid)) {
1814 // Archive or unarchive the contact.
1815 $contact = DBA::selectFirst('contact', [], ['id' => $id]);
1816 if (!DBA::isResult($contact)) {
1817 Logger::info('Couldn\'t select contact for archival.', ['id' => $id]);
1821 if (isset($fields['failed'])) {
1822 if ($fields['failed']) {
1823 self::markForArchival($contact);
1825 self::unmarkForArchival($contact);
1829 if ($contact['uid'] != 0) {
1833 // Update contact data for all users
1834 $condition = ['self' => false, 'nurl' => Strings::normaliseLink($old_url)];
1836 $condition['network'] = [Protocol::DFRN, Protocol::DIASPORA, Protocol::ACTIVITYPUB];
1837 DBA::update('contact', $fields, $condition);
1839 // We mustn't set the update fields for OStatus contacts since they are updated in OnePoll
1840 $condition['network'] = Protocol::OSTATUS;
1842 // If the contact failed, propagate the update fields to all contacts
1843 if (empty($fields['failed'])) {
1844 unset($fields['last-update']);
1845 unset($fields['success_update']);
1846 unset($fields['failure_update']);
1849 if (empty($fields)) {
1853 DBA::update('contact', $fields, $condition);
1857 * Remove duplicated contacts
1859 * @param string $nurl Normalised contact url
1860 * @param integer $uid User id
1862 * @throws \Exception
1864 public static function removeDuplicates(string $nurl, int $uid)
1866 $condition = ['nurl' => $nurl, 'uid' => $uid, 'deleted' => false, 'network' => Protocol::FEDERATED];
1867 $count = DBA::count('contact', $condition);
1872 $first_contact = DBA::selectFirst('contact', ['id', 'network'], $condition, ['order' => ['id']]);
1873 if (!DBA::isResult($first_contact)) {
1874 // Shouldn't happen - so we handle it
1878 $first = $first_contact['id'];
1879 Logger::info('Found duplicates', ['count' => $count, 'first' => $first, 'uid' => $uid, 'nurl' => $nurl]);
1880 if (($uid != 0 && ($first_contact['network'] == Protocol::DFRN))) {
1881 // Don't handle non public DFRN duplicates by now (legacy DFRN is very special because of the key handling)
1882 Logger::info('Not handling non public DFRN duplicate', ['uid' => $uid, 'nurl' => $nurl]);
1886 // Find all duplicates
1887 $condition = ["`nurl` = ? AND `uid` = ? AND `id` != ? AND NOT `self` AND NOT `deleted`", $nurl, $uid, $first];
1888 $duplicates = DBA::select('contact', ['id', 'network'], $condition);
1889 while ($duplicate = DBA::fetch($duplicates)) {
1890 if (!in_array($duplicate['network'], Protocol::FEDERATED)) {
1894 Worker::add(PRIORITY_HIGH, 'MergeContact', $first, $duplicate['id'], $uid);
1896 DBA::close($duplicates);
1897 Logger::info('Duplicates handled', ['uid' => $uid, 'nurl' => $nurl, 'callstack' => System::callstack(20)]);
1902 * @param integer $id contact id
1903 * @param string $network Optional network we are probing for
1905 * @throws HTTPException\InternalServerErrorException
1906 * @throws \ImagickException
1908 public static function updateFromProbe(int $id, string $network = '')
1910 $contact = DBA::selectFirst('contact', ['uid', 'url'], ['id' => $id]);
1911 if (!DBA::isResult($contact)) {
1915 $ret = Probe::uri($contact['url'], $network, $contact['uid']);
1916 return self::updateFromProbeArray($id, $ret);
1920 * @param integer $id contact id
1921 * @param array $ret Probed data
1923 * @throws HTTPException\InternalServerErrorException
1924 * @throws \ImagickException
1926 private static function updateFromProbeArray(int $id, array $ret)
1929 Warning: Never ever fetch the public key via Probe::uri and write it into the contacts.
1930 This will reliably kill your communication with old Friendica contacts.
1933 // These fields aren't updated by this routine:
1934 // 'xmpp', 'sensitive'
1936 $fields = ['uid', 'avatar', 'name', 'nick', 'location', 'keywords', 'about', 'subscribe', 'manually-approve',
1937 'unsearchable', 'url', 'addr', 'batch', 'notify', 'poll', 'request', 'confirm', 'poco',
1938 'network', 'alias', 'baseurl', 'gsid', 'forum', 'prv', 'contact-type', 'pubkey', 'last-item'];
1939 $contact = DBA::selectFirst('contact', $fields, ['id' => $id]);
1940 if (!DBA::isResult($contact)) {
1944 if (!empty($ret['account-type']) && $ret['account-type'] == User::ACCOUNT_TYPE_DELETED) {
1945 Logger::info('Deleted account', ['id' => $id, 'url' => $ret['url'], 'ret' => $ret]);
1948 // Delete all contacts with the same URL
1949 self::deleteContactByUrl($ret['url']);
1953 $uid = $contact['uid'];
1954 unset($contact['uid']);
1956 $pubkey = $contact['pubkey'];
1957 unset($contact['pubkey']);
1959 $contact['photo'] = $contact['avatar'];
1960 unset($contact['avatar']);
1962 $updated = DateTimeFormat::utcNow();
1964 // We must not try to update relay contacts via probe. They are no real contacts.
1965 // We check after the probing to be able to correct falsely detected contact types.
1966 if (($contact['contact-type'] == self::TYPE_RELAY) &&
1967 (!Strings::compareLink($ret['url'], $contact['url']) || in_array($ret['network'], [Protocol::FEED, Protocol::PHANTOM]))) {
1968 self::updateContact($id, $uid, $contact['url'], $contact['url'], ['failed' => false, 'last-update' => $updated, 'success_update' => $updated]);
1969 Logger::info('Not updating relais', ['id' => $id, 'url' => $contact['url']]);
1973 // If Probe::uri fails the network code will be different ("feed" or "unkn")
1974 if (($ret['network'] == Protocol::PHANTOM) || (($ret['network'] == Protocol::FEED) && ($ret['network'] != $contact['network']))) {
1975 self::updateContact($id, $uid, $contact['url'], $ret['url'], ['failed' => true, 'last-update' => $updated, 'failure_update' => $updated]);
1979 if (isset($ret['hide']) && is_bool($ret['hide'])) {
1980 $ret['unsearchable'] = $ret['hide'];
1983 if (isset($ret['account-type']) && is_int($ret['account-type'])) {
1984 $ret['forum'] = false;
1985 $ret['prv'] = false;
1986 $ret['contact-type'] = $ret['account-type'];
1987 if (($ret['contact-type'] == User::ACCOUNT_TYPE_COMMUNITY) && isset($ret['manually-approve'])) {
1988 $ret['forum'] = (bool)!$ret['manually-approve'];
1989 $ret['prv'] = (bool)!$ret['forum'];
1993 $new_pubkey = $ret['pubkey'] ?? '';
1996 $ret['last-item'] = Probe::getLastUpdate($ret);
1997 Logger::info('Fetched last item', ['id' => $id, 'probed_url' => $ret['url'], 'last-item' => $ret['last-item'], 'callstack' => System::callstack(20)]);
2002 // make sure to not overwrite existing values with blank entries except some technical fields
2003 $keep = ['batch', 'notify', 'poll', 'request', 'confirm', 'poco', 'baseurl'];
2004 foreach ($ret as $key => $val) {
2005 if (!array_key_exists($key, $contact)) {
2007 } elseif (($contact[$key] != '') && ($val === '') && !is_bool($ret[$key]) && !in_array($key, $keep)) {
2008 $ret[$key] = $contact[$key];
2009 } elseif ($ret[$key] != $contact[$key]) {
2014 if (!empty($ret['last-item']) && ($contact['last-item'] < $ret['last-item'])) {
2017 unset($ret['last-item']);
2020 if (!empty($ret['photo']) && ($ret['network'] != Protocol::FEED)) {
2021 self::updateAvatar($id, $ret['photo'], $update);
2025 self::updateContact($id, $uid, $contact['url'], $ret['url'], ['failed' => false, 'last-update' => $updated, 'success_update' => $updated]);
2027 if (Contact\Relation::isDiscoverable($ret['url'])) {
2028 Worker::add(PRIORITY_LOW, 'ContactDiscovery', $ret['url']);
2031 // Update the public contact
2033 $contact = self::getByURL($ret['url'], false, ['id']);
2034 if (!empty($contact['id'])) {
2035 self::updateFromProbeArray($contact['id'], $ret);
2042 $ret['nurl'] = Strings::normaliseLink($ret['url']);
2043 $ret['updated'] = $updated;
2044 $ret['failed'] = false;
2046 // Only fill the pubkey if it had been empty before. We have to prevent identity theft.
2047 if (empty($pubkey) && !empty($new_pubkey)) {
2048 $ret['pubkey'] = $new_pubkey;
2051 if ((!empty($ret['addr']) && ($ret['addr'] != $contact['addr'])) || (!empty($ret['alias']) && ($ret['alias'] != $contact['alias']))) {
2052 $ret['uri-date'] = DateTimeFormat::utcNow();
2055 if (($ret['name'] != $contact['name']) || ($ret['nick'] != $contact['nick'])) {
2056 $ret['name-date'] = $updated;
2059 if (($uid == 0) || in_array($ret['network'], [Protocol::DFRN, Protocol::DIASPORA, Protocol::ACTIVITYPUB])) {
2060 $ret['last-update'] = $updated;
2061 $ret['success_update'] = $updated;
2064 unset($ret['photo']);
2066 self::updateContact($id, $uid, $contact['url'], $ret['url'], $ret);
2068 if (Contact\Relation::isDiscoverable($ret['url'])) {
2069 Worker::add(PRIORITY_LOW, 'ContactDiscovery', $ret['url']);
2076 * @param integer $url contact url
2077 * @return integer Contact id
2078 * @throws HTTPException\InternalServerErrorException
2079 * @throws \ImagickException
2081 public static function updateFromProbeByURL($url)
2083 $id = self::getIdForURL($url);
2089 self::updateFromProbe($id);
2095 * Detects if a given contact array belongs to a legacy DFRN connection
2097 * @param array $contact
2100 public static function isLegacyDFRNContact($contact)
2102 // Newer Friendica contacts are connected via AP, then these fields aren't set
2103 return !empty($contact['dfrn-id']) || !empty($contact['issued-id']);
2107 * Detects the communication protocol for a given contact url.
2108 * This is used to detect Friendica contacts that we can communicate via AP.
2110 * @param string $url contact url
2111 * @param string $network Network of that contact
2112 * @return string with protocol
2114 public static function getProtocol($url, $network)
2116 if ($network != Protocol::DFRN) {
2120 $apcontact = APContact::getByURL($url);
2121 if (!empty($apcontact) && !empty($apcontact['generator'])) {
2122 return Protocol::ACTIVITYPUB;
2129 * Takes a $uid and a url/handle and adds a new contact
2131 * Currently if the contact is DFRN, interactive needs to be true, to redirect to the
2132 * dfrn_request page.
2134 * Otherwise this can be used to bulk add StatusNet contacts, Twitter contacts, etc.
2137 * $return['success'] boolean true if successful
2138 * $return['message'] error text if success is false.
2140 * Takes a $uid and a url/handle and adds a new contact
2142 * @param array $user The user the contact should be created for
2143 * @param string $url The profile URL of the contact
2144 * @param bool $interactive
2145 * @param string $network
2147 * @throws HTTPException\InternalServerErrorException
2148 * @throws HTTPException\NotFoundException
2149 * @throws \ImagickException
2151 public static function createFromProbe(array $user, $url, $interactive = false, $network = '')
2153 $result = ['cid' => -1, 'success' => false, 'message' => ''];
2155 // remove ajax junk, e.g. Twitter
2156 $url = str_replace('/#!/', '/', $url);
2158 if (!Network::isUrlAllowed($url)) {
2159 $result['message'] = DI::l10n()->t('Disallowed profile URL.');
2163 if (Network::isUrlBlocked($url)) {
2164 $result['message'] = DI::l10n()->t('Blocked domain');
2169 $result['message'] = DI::l10n()->t('Connect URL missing.');
2173 $arr = ['url' => $url, 'contact' => []];
2175 Hook::callAll('follow', $arr);
2178 $result['message'] = DI::l10n()->t('The contact could not be added. Please check the relevant network credentials in your Settings -> Social Networks page.');
2182 if (!empty($arr['contact']['name'])) {
2183 $ret = $arr['contact'];
2185 $ret = Probe::uri($url, $network, $user['uid']);
2188 if (($network != '') && ($ret['network'] != $network)) {
2189 Logger::log('Expected network ' . $network . ' does not match actual network ' . $ret['network']);
2193 // check if we already have a contact
2194 // the poll url is more reliable than the profile url, as we may have
2195 // indirect links or webfinger links
2197 $condition = ['uid' => $user['uid'], 'poll' => [$ret['poll'], Strings::normaliseLink($ret['poll'])], 'network' => $ret['network'], 'pending' => false];
2198 $contact = DBA::selectFirst('contact', ['id', 'rel'], $condition);
2199 if (!DBA::isResult($contact)) {
2200 $condition = ['uid' => $user['uid'], 'nurl' => Strings::normaliseLink($ret['url']), 'network' => $ret['network'], 'pending' => false];
2201 $contact = DBA::selectFirst('contact', ['id', 'rel'], $condition);
2204 $protocol = self::getProtocol($ret['url'], $ret['network']);
2206 if (($protocol === Protocol::DFRN) && !DBA::isResult($contact)) {
2208 if (strlen(DI::baseUrl()->getUrlPath())) {
2209 $myaddr = bin2hex(DI::baseUrl() . '/profile/' . $user['nickname']);
2211 $myaddr = bin2hex($user['nickname'] . '@' . DI::baseUrl()->getHostname());
2214 DI::baseUrl()->redirect($ret['request'] . "&addr=$myaddr");
2218 } elseif (DI::config()->get('system', 'dfrn_only') && ($ret['network'] != Protocol::DFRN)) {
2219 $result['message'] = DI::l10n()->t('This site is not configured to allow communications with other networks.') . EOL;
2220 $result['message'] .= DI::l10n()->t('No compatible communication protocols or feeds were discovered.') . EOL;
2224 // This extra param just confuses things, remove it
2225 if ($protocol === Protocol::DIASPORA) {
2226 $ret['url'] = str_replace('?absolute=true', '', $ret['url']);
2229 // do we have enough information?
2230 if (empty($protocol) || ($protocol == Protocol::PHANTOM) || (empty($ret['url']) && empty($ret['addr']))) {
2231 $result['message'] .= DI::l10n()->t('The profile address specified does not provide adequate information.') . EOL;
2232 if (empty($ret['poll'])) {
2233 $result['message'] .= DI::l10n()->t('No compatible communication protocols or feeds were discovered.') . EOL;
2235 if (empty($ret['name'])) {
2236 $result['message'] .= DI::l10n()->t('An author or name was not found.') . EOL;
2238 if (empty($ret['url'])) {
2239 $result['message'] .= DI::l10n()->t('No browser URL could be matched to this address.') . EOL;
2241 if (strpos($ret['url'], '@') !== false) {
2242 $result['message'] .= DI::l10n()->t('Unable to match @-style Identity Address with a known protocol or email contact.') . EOL;
2243 $result['message'] .= DI::l10n()->t('Use mailto: in front of address to force email check.') . EOL;
2248 if ($protocol === Protocol::OSTATUS && DI::config()->get('system', 'ostatus_disabled')) {
2249 $result['message'] .= DI::l10n()->t('The profile address specified belongs to a network which has been disabled on this site.') . EOL;
2250 $ret['notify'] = '';
2253 if (!$ret['notify']) {
2254 $result['message'] .= DI::l10n()->t('Limited profile. This person will be unable to receive direct/personal notifications from you.') . EOL;
2257 $writeable = ((($protocol === Protocol::OSTATUS) && ($ret['notify'])) ? 1 : 0);
2259 $subhub = (($protocol === Protocol::OSTATUS) ? true : false);
2261 $hidden = (($protocol === Protocol::MAIL) ? 1 : 0);
2264 if (($protocol == Protocol::ACTIVITYPUB) && isset($ret['manually-approve'])) {
2265 $pending = (bool)$ret['manually-approve'];
2268 if (in_array($protocol, [Protocol::MAIL, Protocol::DIASPORA, Protocol::ACTIVITYPUB])) {
2272 if (DBA::isResult($contact)) {
2274 $new_relation = (($contact['rel'] == self::FOLLOWER) ? self::FRIEND : self::SHARING);
2276 $fields = ['rel' => $new_relation, 'subhub' => $subhub, 'readonly' => false];
2277 DBA::update('contact', $fields, ['id' => $contact['id']]);
2279 $new_relation = (in_array($protocol, [Protocol::MAIL]) ? self::FRIEND : self::SHARING);
2281 // create contact record
2283 'uid' => $user['uid'],
2284 'created' => DateTimeFormat::utcNow(),
2285 'url' => $ret['url'],
2286 'nurl' => Strings::normaliseLink($ret['url']),
2287 'addr' => $ret['addr'],
2288 'alias' => $ret['alias'],
2289 'batch' => $ret['batch'],
2290 'notify' => $ret['notify'],
2291 'poll' => $ret['poll'],
2292 'poco' => $ret['poco'],
2293 'name' => $ret['name'],
2294 'nick' => $ret['nick'],
2295 'network' => $ret['network'],
2296 'baseurl' => $ret['baseurl'],
2297 'gsid' => $ret['gsid'] ?? null,
2298 'protocol' => $protocol,
2299 'pubkey' => $ret['pubkey'],
2300 'rel' => $new_relation,
2301 'priority'=> $ret['priority'],
2302 'writable'=> $writeable,
2303 'hidden' => $hidden,
2306 'pending' => $pending,
2311 $contact = DBA::selectFirst('contact', [], ['url' => $ret['url'], 'network' => $ret['network'], 'uid' => $user['uid']]);
2312 if (!DBA::isResult($contact)) {
2313 $result['message'] .= DI::l10n()->t('Unable to retrieve contact information.') . EOL;
2317 $contact_id = $contact['id'];
2318 $result['cid'] = $contact_id;
2320 Group::addMember(User::getDefaultGroup($user['uid'], $contact["network"]), $contact_id);
2322 // Update the avatar
2323 self::updateAvatar($contact_id, $ret['photo']);
2325 // pull feed and consume it, which should subscribe to the hub.
2326 if ($contact['network'] == Protocol::OSTATUS) {
2327 Worker::add(PRIORITY_HIGH, 'OnePoll', $contact_id, 'force');
2329 Worker::add(PRIORITY_HIGH, 'UpdateContact', $contact_id);
2332 $owner = User::getOwnerDataById($user['uid']);
2334 if (DBA::isResult($owner)) {
2335 if (in_array($protocol, [Protocol::OSTATUS, Protocol::DFRN])) {
2336 // create a follow slap
2338 $item['verb'] = Activity::FOLLOW;
2339 $item['gravity'] = GRAVITY_ACTIVITY;
2340 $item['follow'] = $contact["url"];
2342 $item['title'] = '';
2344 $item['uri-id'] = 0;
2346 $slap = OStatus::salmon($item, $owner);
2348 if (!empty($contact['notify'])) {
2349 Salmon::slapper($owner, $contact['notify'], $slap);
2351 } elseif ($protocol == Protocol::DIASPORA) {
2352 $ret = Diaspora::sendShare($owner, $contact);
2353 Logger::log('share returns: ' . $ret);
2354 } elseif ($protocol == Protocol::ACTIVITYPUB) {
2355 $activity_id = ActivityPub\Transmitter::activityIDFromContact($contact_id);
2356 if (empty($activity_id)) {
2357 // This really should never happen
2361 $ret = ActivityPub\Transmitter::sendActivity('Follow', $contact['url'], $user['uid'], $activity_id);
2362 Logger::log('Follow returns: ' . $ret);
2366 $result['success'] = true;
2371 * Updated contact's SSL policy
2373 * @param array $contact Contact array
2374 * @param string $new_policy New policy, valid: self,full
2376 * @return array Contact array with updated values
2377 * @throws \Exception
2379 public static function updateSslPolicy(array $contact, $new_policy)
2381 $ssl_changed = false;
2382 if ((intval($new_policy) == BaseURL::SSL_POLICY_SELFSIGN || $new_policy === 'self') && strstr($contact['url'], 'https:')) {
2383 $ssl_changed = true;
2384 $contact['url'] = str_replace('https:', 'http:', $contact['url']);
2385 $contact['request'] = str_replace('https:', 'http:', $contact['request']);
2386 $contact['notify'] = str_replace('https:', 'http:', $contact['notify']);
2387 $contact['poll'] = str_replace('https:', 'http:', $contact['poll']);
2388 $contact['confirm'] = str_replace('https:', 'http:', $contact['confirm']);
2389 $contact['poco'] = str_replace('https:', 'http:', $contact['poco']);
2392 if ((intval($new_policy) == BaseURL::SSL_POLICY_FULL || $new_policy === 'full') && strstr($contact['url'], 'http:')) {
2393 $ssl_changed = true;
2394 $contact['url'] = str_replace('http:', 'https:', $contact['url']);
2395 $contact['request'] = str_replace('http:', 'https:', $contact['request']);
2396 $contact['notify'] = str_replace('http:', 'https:', $contact['notify']);
2397 $contact['poll'] = str_replace('http:', 'https:', $contact['poll']);
2398 $contact['confirm'] = str_replace('http:', 'https:', $contact['confirm']);
2399 $contact['poco'] = str_replace('http:', 'https:', $contact['poco']);
2403 $fields = ['url' => $contact['url'], 'request' => $contact['request'],
2404 'notify' => $contact['notify'], 'poll' => $contact['poll'],
2405 'confirm' => $contact['confirm'], 'poco' => $contact['poco']];
2406 DBA::update('contact', $fields, ['id' => $contact['id']]);
2413 * @param array $importer Owner (local user) data
2414 * @param array $contact Existing owner-specific contact data we want to expand the relationship with. Optional.
2415 * @param array $datarray An item-like array with at least the 'author-id' and 'author-url' keys for the contact. Mandatory.
2416 * @param bool $sharing True: Contact is now sharing with Owner; False: Contact is now following Owner (default)
2417 * @param string $note Introduction additional message
2418 * @return bool|null True: follow request is accepted; False: relationship is rejected; Null: relationship is pending
2419 * @throws HTTPException\InternalServerErrorException
2420 * @throws \ImagickException
2422 public static function addRelationship(array $importer, array $contact, array $datarray, $sharing = false, $note = '')
2424 // Should always be set
2425 if (empty($datarray['author-id'])) {
2429 $fields = ['url', 'name', 'nick', 'avatar', 'photo', 'network', 'blocked'];
2430 $pub_contact = DBA::selectFirst('contact', $fields, ['id' => $datarray['author-id']]);
2431 if (!DBA::isResult($pub_contact)) {
2432 // Should never happen
2436 // Contact is blocked at node-level
2437 if (self::isBlocked($datarray['author-id'])) {
2441 $url = ($datarray['author-link'] ?? '') ?: $pub_contact['url'];
2442 $name = $pub_contact['name'];
2443 $photo = ($pub_contact['avatar'] ?? '') ?: $pub_contact["photo"];
2444 $nick = $pub_contact['nick'];
2445 $network = $pub_contact['network'];
2447 // Ensure that we don't create a new contact when there already is one
2448 $cid = self::getIdForURL($url, $importer['uid']);
2450 $contact = DBA::selectFirst('contact', [], ['id' => $cid]);
2453 if (!empty($contact)) {
2454 if (!empty($contact['pending'])) {
2455 Logger::info('Pending contact request already exists.', ['url' => $url, 'uid' => $importer['uid']]);
2459 // Contact is blocked at user-level
2460 if (!empty($contact['id']) && !empty($importer['id']) &&
2461 Contact\User::isBlocked($contact['id'], $importer['id'])) {
2465 // Make sure that the existing contact isn't archived
2466 self::unmarkForArchival($contact);
2468 if (($contact['rel'] == self::SHARING)
2469 || ($sharing && $contact['rel'] == self::FOLLOWER)) {
2470 DBA::update('contact', ['rel' => self::FRIEND, 'writable' => true, 'pending' => false],
2471 ['id' => $contact['id'], 'uid' => $importer['uid']]);
2474 // Ensure to always have the correct network type, independent from the connection request method
2475 self::updateFromProbe($contact['id']);
2479 // send email notification to owner?
2480 if (DBA::exists('contact', ['nurl' => Strings::normaliseLink($url), 'uid' => $importer['uid'], 'pending' => true])) {
2481 Logger::log('ignoring duplicated connection request from pending contact ' . $url);
2485 // create contact record
2486 DBA::insert('contact', [
2487 'uid' => $importer['uid'],
2488 'created' => DateTimeFormat::utcNow(),
2490 'nurl' => Strings::normaliseLink($url),
2493 'network' => $network,
2494 'rel' => self::FOLLOWER,
2501 $contact_id = DBA::lastInsertId();
2503 // Ensure to always have the correct network type, independent from the connection request method
2504 self::updateFromProbe($contact_id);
2506 self::updateAvatar($contact_id, $photo, true);
2508 $contact_record = DBA::selectFirst('contact', ['id', 'network', 'name', 'url', 'photo'], ['id' => $contact_id]);
2510 /// @TODO Encapsulate this into a function/method
2511 $fields = ['uid', 'username', 'email', 'page-flags', 'notify-flags', 'language'];
2512 $user = DBA::selectFirst('user', $fields, ['uid' => $importer['uid']]);
2513 if (DBA::isResult($user) && !in_array($user['page-flags'], [User::PAGE_FLAGS_SOAPBOX, User::PAGE_FLAGS_FREELOVE, User::PAGE_FLAGS_COMMUNITY])) {
2514 // create notification
2515 $hash = Strings::getRandomHex();
2517 if (is_array($contact_record)) {
2518 DBA::insert('intro', ['uid' => $importer['uid'], 'contact-id' => $contact_record['id'],
2519 'blocked' => false, 'knowyou' => false, 'note' => $note,
2520 'hash' => $hash, 'datetime' => DateTimeFormat::utcNow()]);
2523 Group::addMember(User::getDefaultGroup($importer['uid'], $contact_record["network"]), $contact_record['id']);
2525 if (($user['notify-flags'] & Notification\Type::INTRO) &&
2526 in_array($user['page-flags'], [User::PAGE_FLAGS_NORMAL])) {
2529 'type' => Notification\Type::INTRO,
2530 'otype' => Notification\ObjectType::INTRO,
2531 'verb' => ($sharing ? Activity::FRIEND : Activity::FOLLOW),
2532 'uid' => $user['uid'],
2533 'cid' => $contact_record['id'],
2534 'link' => DI::baseUrl() . '/notifications/intros',
2537 } elseif (DBA::isResult($user) && in_array($user['page-flags'], [User::PAGE_FLAGS_SOAPBOX, User::PAGE_FLAGS_FREELOVE, User::PAGE_FLAGS_COMMUNITY])) {
2538 if (($user['page-flags'] == User::PAGE_FLAGS_FREELOVE) && ($network != Protocol::DIASPORA)) {
2539 self::createFromProbe($importer, $url, false, $network);
2542 $condition = ['uid' => $importer['uid'], 'url' => $url, 'pending' => true];
2543 $fields = ['pending' => false];
2544 if ($user['page-flags'] == User::PAGE_FLAGS_FREELOVE) {
2545 $fields['rel'] = self::FRIEND;
2548 DBA::update('contact', $fields, $condition);
2557 public static function removeFollower($importer, $contact, array $datarray = [], $item = "")
2559 if (($contact['rel'] == self::FRIEND) || ($contact['rel'] == self::SHARING)) {
2560 DBA::update('contact', ['rel' => self::SHARING], ['id' => $contact['id']]);
2562 self::remove($contact['id']);
2566 public static function removeSharer($importer, $contact, array $datarray = [], $item = "")
2568 if (($contact['rel'] == self::FRIEND) || ($contact['rel'] == self::FOLLOWER)) {
2569 DBA::update('contact', ['rel' => self::FOLLOWER], ['id' => $contact['id']]);
2571 self::remove($contact['id']);
2576 * Create a birthday event.
2578 * Update the year and the birthday.
2580 public static function updateBirthdays()
2584 AND (`contact`.`rel` = ? OR `contact`.`rel` = ?)
2585 AND NOT `contact`.`pending`
2586 AND NOT `contact`.`hidden`
2587 AND NOT `contact`.`blocked`
2588 AND NOT `contact`.`archive`
2589 AND NOT `contact`.`deleted`',
2595 $contacts = DBA::select('contact', ['id', 'uid', 'name', 'url', 'bd'], $condition);
2597 while ($contact = DBA::fetch($contacts)) {
2598 Logger::log('update_contact_birthday: ' . $contact['bd']);
2600 $nextbd = DateTimeFormat::utcNow('Y') . substr($contact['bd'], 4);
2602 if (Event::createBirthday($contact, $nextbd)) {
2606 ['bdyear' => substr($nextbd, 0, 4), 'bd' => $nextbd],
2607 ['id' => $contact['id']]
2611 DBA::close($contacts);
2615 * Remove the unavailable contact ids from the provided list
2617 * @param array $contact_ids Contact id list
2619 * @throws \Exception
2621 public static function pruneUnavailable(array $contact_ids)
2623 if (empty($contact_ids)) {
2627 $contacts = self::selectToArray(['id'], [
2628 'id' => $contact_ids,
2634 return array_column($contacts, 'id');
2638 * Returns a magic link to authenticate remote visitors
2640 * @todo check if the return is either a fully qualified URL or a relative path to Friendica basedir
2642 * @param string $contact_url The address of the target contact profile
2643 * @param string $url An url that we will be redirected to after the authentication
2645 * @return string with "redir" link
2646 * @throws HTTPException\InternalServerErrorException
2647 * @throws \ImagickException
2649 public static function magicLink($contact_url, $url = '')
2651 if (!Session::isAuthenticated()) {
2652 return $url ?: $contact_url; // Equivalent to: ($url != '') ? $url : $contact_url;
2655 $contact = self::getByURL($contact_url, false);
2656 if (empty($contact)) {
2657 return $url ?: $contact_url; // Equivalent to: ($url != '') ? $url : $contact_url;
2660 // Prevents endless loop in case only a non-public contact exists for the contact URL
2661 unset($contact['uid']);
2663 return self::magicLinkByContact($contact, $url ?: $contact_url);
2667 * Returns a magic link to authenticate remote visitors
2669 * @param integer $cid The contact id of the target contact profile
2670 * @param string $url An url that we will be redirected to after the authentication
2672 * @return string with "redir" link
2673 * @throws HTTPException\InternalServerErrorException
2674 * @throws \ImagickException
2676 public static function magicLinkById($cid, $url = '')
2678 $contact = DBA::selectFirst('contact', ['id', 'network', 'url', 'uid'], ['id' => $cid]);
2680 return self::magicLinkByContact($contact, $url);
2684 * Returns a magic link to authenticate remote visitors
2686 * @param array $contact The contact array with "uid", "network" and "url"
2687 * @param string $url An url that we will be redirected to after the authentication
2689 * @return string with "redir" link
2690 * @throws HTTPException\InternalServerErrorException
2691 * @throws \ImagickException
2693 public static function magicLinkByContact($contact, $url = '')
2695 $destination = $url ?: $contact['url']; // Equivalent to ($url != '') ? $url : $contact['url'];
2697 if (!Session::isAuthenticated()) {
2698 return $destination;
2701 // Only redirections to the same host do make sense
2702 if (($url != '') && (parse_url($url, PHP_URL_HOST) != parse_url($contact['url'], PHP_URL_HOST))) {
2706 if (DI::pConfig()->get(local_user(), 'system', 'stay_local') && ($url == '')) {
2707 return 'contact/' . $contact['id'] . '/conversations';
2710 if (!empty($contact['network']) && $contact['network'] != Protocol::DFRN) {
2711 return $destination;
2714 if (empty($contact['id'])) {
2715 return $destination;
2718 $redirect = 'redir/' . $contact['id'];
2720 if (($url != '') && !Strings::compareLink($contact['url'], $url)) {
2721 $redirect .= '?url=' . $url;
2728 * Is the contact a forum?
2730 * @param integer $contactid ID of the contact
2732 * @return boolean "true" if it is a forum
2734 public static function isForum($contactid)
2736 $fields = ['forum', 'prv'];
2737 $condition = ['id' => $contactid];
2738 $contact = DBA::selectFirst('contact', $fields, $condition);
2739 if (!DBA::isResult($contact)) {
2744 return ($contact['forum'] || $contact['prv']);
2748 * Can the remote contact receive private messages?
2750 * @param array $contact
2753 public static function canReceivePrivateMessages(array $contact)
2755 $protocol = $contact['network'] ?? $contact['protocol'] ?? Protocol::PHANTOM;
2756 $self = $contact['self'] ?? false;
2758 return in_array($protocol, [Protocol::DFRN, Protocol::DIASPORA, Protocol::ACTIVITYPUB]) && !$self;
2762 * Search contact table by nick or name
2764 * @param string $search Name or nick
2765 * @param string $mode Search mode (e.g. "community")
2767 * @return array with search results
2768 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
2770 public static function searchByName($search, $mode = '')
2772 if (empty($search)) {
2776 // check supported networks
2777 if (DI::config()->get('system', 'diaspora_enabled')) {
2778 $diaspora = Protocol::DIASPORA;
2780 $diaspora = Protocol::DFRN;
2783 if (!DI::config()->get('system', 'ostatus_disabled')) {
2784 $ostatus = Protocol::OSTATUS;
2786 $ostatus = Protocol::DFRN;
2789 // check if we search only communities or every contact
2790 if ($mode === 'community') {
2791 $extra_sql = sprintf(' AND `contact-type` = %d', self::TYPE_COMMUNITY);
2798 $results = DBA::p("SELECT * FROM `contact`
2799 WHERE NOT `unsearchable` AND `network` IN (?, ?, ?, ?) AND
2800 NOT `failed` AND `uid` = ? AND
2801 (`addr` LIKE ? OR `name` LIKE ? OR `nick` LIKE ?) $extra_sql
2802 ORDER BY `nurl` DESC LIMIT 1000",
2803 Protocol::DFRN, Protocol::ACTIVITYPUB, $ostatus, $diaspora, 0, $search, $search, $search
2806 $contacts = DBA::toArray($results);
2811 * Add public contacts from an array
2813 * @param array $urls
2814 * @return array result "count", "added" and "updated"
2816 public static function addByUrls(array $urls)
2823 foreach ($urls as $url) {
2824 if (empty($url) || !is_string($url)) {
2827 $contact = self::getByURL($url, false, ['id', 'updated']);
2828 if (empty($contact['id'])) {
2829 Worker::add(PRIORITY_LOW, 'AddContact', 0, $url);
2831 } elseif ($contact['updated'] < DateTimeFormat::utc('now -7 days')) {
2832 Worker::add(PRIORITY_LOW, 'UpdateContact', $contact['id']);
2840 return ['count' => $count, 'added' => $added, 'updated' => $updated, 'unchanged' => $unchanged];
2844 * Returns a random, global contact array of the current node
2846 * @return array The profile array
2849 public static function getRandomContact()
2851 $contact = DBA::selectFirst('contact', ['id', 'network', 'url', 'uid'], [
2852 "`uid` = ? AND `network` = ? AND NOT `failed` AND `last-item` > ?",
2853 0, Protocol::DFRN, DateTimeFormat::utc('now - 1 month'),
2854 ], ['order' => ['RAND()']]);
2856 if (DBA::isResult($contact)) {