3 * @copyright Copyright (C) 2020, Friendica
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Model;
24 use Friendica\App\BaseURL;
25 use Friendica\Content\Pager;
26 use Friendica\Core\Hook;
27 use Friendica\Core\Logger;
28 use Friendica\Core\Protocol;
29 use Friendica\Core\Session;
30 use Friendica\Core\System;
31 use Friendica\Core\Worker;
32 use Friendica\Database\DBA;
34 use Friendica\Model\Notify\Type;
35 use Friendica\Network\HTTPException;
36 use Friendica\Network\Probe;
37 use Friendica\Protocol\Activity;
38 use Friendica\Protocol\ActivityPub;
39 use Friendica\Protocol\DFRN;
40 use Friendica\Protocol\Diaspora;
41 use Friendica\Protocol\OStatus;
42 use Friendica\Protocol\Salmon;
43 use Friendica\Util\DateTimeFormat;
44 use Friendica\Util\Images;
45 use Friendica\Util\Network;
46 use Friendica\Util\Strings;
49 * functions for interacting with a contact
54 * @deprecated since version 2019.03
55 * @see User::PAGE_FLAGS_NORMAL
57 const PAGE_NORMAL = User::PAGE_FLAGS_NORMAL;
59 * @deprecated since version 2019.03
60 * @see User::PAGE_FLAGS_SOAPBOX
62 const PAGE_SOAPBOX = User::PAGE_FLAGS_SOAPBOX;
64 * @deprecated since version 2019.03
65 * @see User::PAGE_FLAGS_COMMUNITY
67 const PAGE_COMMUNITY = User::PAGE_FLAGS_COMMUNITY;
69 * @deprecated since version 2019.03
70 * @see User::PAGE_FLAGS_FREELOVE
72 const PAGE_FREELOVE = User::PAGE_FLAGS_FREELOVE;
74 * @deprecated since version 2019.03
75 * @see User::PAGE_FLAGS_BLOG
77 const PAGE_BLOG = User::PAGE_FLAGS_BLOG;
79 * @deprecated since version 2019.03
80 * @see User::PAGE_FLAGS_PRVGROUP
82 const PAGE_PRVGROUP = User::PAGE_FLAGS_PRVGROUP;
90 * TYPE_UNKNOWN - the account has been imported from gcontact where this is the default type value
92 * TYPE_PERSON - the account belongs to a person
93 * Associated page types: PAGE_NORMAL, PAGE_SOAPBOX, PAGE_FREELOVE
95 * TYPE_ORGANISATION - the account belongs to an organisation
96 * Associated page type: PAGE_SOAPBOX
98 * TYPE_NEWS - the account is a news reflector
99 * Associated page type: PAGE_SOAPBOX
101 * TYPE_COMMUNITY - the account is community forum
102 * Associated page types: PAGE_COMMUNITY, PAGE_PRVGROUP
104 * TYPE_RELAY - the account is a relay
105 * This will only be assigned to contacts, not to user accounts
108 const TYPE_UNKNOWN = -1;
109 const TYPE_PERSON = User::ACCOUNT_TYPE_PERSON;
110 const TYPE_ORGANISATION = User::ACCOUNT_TYPE_ORGANISATION;
111 const TYPE_NEWS = User::ACCOUNT_TYPE_NEWS;
112 const TYPE_COMMUNITY = User::ACCOUNT_TYPE_COMMUNITY;
113 const TYPE_RELAY = User::ACCOUNT_TYPE_RELAY;
132 * @param array $fields Array of selected fields, empty for all
133 * @param array $condition Array of fields for condition
134 * @param array $params Array of several parameters
138 public static function selectToArray(array $fields = [], array $condition = [], array $params = [])
140 return DBA::selectToArray('contact', $fields, $condition, $params);
144 * @param array $fields Array of selected fields, empty for all
145 * @param array $condition Array of fields for condition
146 * @param array $params Array of several parameters
150 public static function selectFirst(array $fields = [], array $condition = [], array $params = [])
152 $contact = DBA::selectFirst('contact', $fields, $condition, $params);
158 * Insert a row into the contact table
159 * Important: You can't use DBA::lastInsertId() after this call since it will be set to 0.
161 * @param array $fields field array
162 * @param bool $on_duplicate_update Do an update on a duplicate entry
164 * @return boolean was the insert successful?
167 public static function insert(array $fields, bool $on_duplicate_update = false)
169 $ret = DBA::insert('contact', $fields, $on_duplicate_update);
170 $contact = DBA::selectFirst('contact', ['nurl', 'uid'], ['id' => DBA::lastInsertId()]);
171 if (!DBA::isResult($contact)) {
176 // Search for duplicated contacts and get rid of them
177 self::removeDuplicates($contact['nurl'], $contact['uid']);
183 * @param integer $id Contact ID
184 * @param array $fields Array of selected fields, empty for all
185 * @return array|boolean Contact record if it exists, false otherwise
188 public static function getById($id, $fields = [])
190 return DBA::selectFirst('contact', $fields, ['id' => $id]);
194 * Tests if the given contact is a follower
196 * @param int $cid Either public contact id or user's contact id
197 * @param int $uid User ID
199 * @return boolean is the contact id a follower?
200 * @throws HTTPException\InternalServerErrorException
201 * @throws \ImagickException
203 public static function isFollower($cid, $uid)
205 if (self::isBlockedByUser($cid, $uid)) {
209 $cdata = self::getPublicAndUserContacID($cid, $uid);
210 if (empty($cdata['user'])) {
214 $condition = ['id' => $cdata['user'], 'rel' => [self::FOLLOWER, self::FRIEND]];
215 return DBA::exists('contact', $condition);
219 * Tests if the given contact url is a follower
221 * @param string $url Contact URL
222 * @param int $uid User ID
224 * @return boolean is the contact id a follower?
225 * @throws HTTPException\InternalServerErrorException
226 * @throws \ImagickException
228 public static function isFollowerByURL($url, $uid)
230 $cid = self::getIdForURL($url, $uid, true);
236 return self::isFollower($cid, $uid);
240 * Tests if the given user follow the given contact
242 * @param int $cid Either public contact id or user's contact id
243 * @param int $uid User ID
245 * @return boolean is the contact url being followed?
246 * @throws HTTPException\InternalServerErrorException
247 * @throws \ImagickException
249 public static function isSharing($cid, $uid)
251 if (self::isBlockedByUser($cid, $uid)) {
255 $cdata = self::getPublicAndUserContacID($cid, $uid);
256 if (empty($cdata['user'])) {
260 $condition = ['id' => $cdata['user'], 'rel' => [self::SHARING, self::FRIEND]];
261 return DBA::exists('contact', $condition);
265 * Tests if the given user follow the given contact url
267 * @param string $url Contact URL
268 * @param int $uid User ID
270 * @return boolean is the contact url being followed?
271 * @throws HTTPException\InternalServerErrorException
272 * @throws \ImagickException
274 public static function isSharingByURL($url, $uid)
276 $cid = self::getIdForURL($url, $uid, true);
282 return self::isSharing($cid, $uid);
286 * Get the basepath for a given contact link
288 * @param string $url The contact link
289 * @param boolean $dont_update Don't update the contact
291 * @return string basepath
292 * @throws HTTPException\InternalServerErrorException
293 * @throws \ImagickException
295 public static function getBasepath($url, $dont_update = false)
297 $contact = DBA::selectFirst('contact', ['id', 'baseurl'], ['uid' => 0, 'nurl' => Strings::normaliseLink($url)]);
298 if (!DBA::isResult($contact)) {
302 if (!empty($contact['baseurl'])) {
303 return $contact['baseurl'];
304 } elseif ($dont_update) {
308 // Update the existing contact
309 self::updateFromProbe($contact['id'], '', true);
311 // And fetch the result
312 $contact = DBA::selectFirst('contact', ['baseurl'], ['id' => $contact['id']]);
313 if (empty($contact['baseurl'])) {
314 Logger::info('No baseurl for contact', ['url' => $url]);
318 Logger::info('Found baseurl for contact', ['url' => $url, 'baseurl' => $contact['baseurl']]);
319 return $contact['baseurl'];
323 * Check if the given contact url is on the same server
325 * @param string $url The contact link
327 * @return boolean Is it the same server?
329 public static function isLocal($url)
331 return Strings::compareLink(self::getBasepath($url, true), DI::baseUrl());
335 * Check if the given contact ID is on the same server
337 * @param string $url The contact link
339 * @return boolean Is it the same server?
341 public static function isLocalById(int $cid)
343 $contact = DBA::selectFirst('contact', ['url', 'baseurl'], ['id' => $cid]);
344 if (!DBA::isResult($contact)) {
348 if (empty($contact['baseurl'])) {
349 $baseurl = self::getBasepath($contact['url'], true);
351 $baseurl = $contact['baseurl'];
354 return Strings::compareLink($baseurl, DI::baseUrl());
358 * Returns the public contact id of the given user id
360 * @param integer $uid User ID
362 * @return integer|boolean Public contact id for given user id
365 public static function getPublicIdByUserId($uid)
367 $self = DBA::selectFirst('contact', ['url'], ['self' => true, 'uid' => $uid]);
368 if (!DBA::isResult($self)) {
371 return self::getIdForURL($self['url'], 0, true);
375 * Returns the contact id for the user and the public contact id for a given contact id
377 * @param int $cid Either public contact id or user's contact id
378 * @param int $uid User ID
380 * @return array with public and user's contact id
381 * @throws HTTPException\InternalServerErrorException
382 * @throws \ImagickException
384 public static function getPublicAndUserContacID($cid, $uid)
386 if (empty($uid) || empty($cid)) {
390 $contact = DBA::selectFirst('contact', ['id', 'uid', 'url'], ['id' => $cid]);
391 if (!DBA::isResult($contact)) {
395 // We quit when the user id don't match the user id of the provided contact
396 if (($contact['uid'] != $uid) && ($contact['uid'] != 0)) {
400 if ($contact['uid'] != 0) {
401 $pcid = Contact::getIdForURL($contact['url'], 0, true, ['url' => $contact['url']]);
405 $ucid = $contact['id'];
407 $pcid = $contact['id'];
408 $ucid = Contact::getIdForURL($contact['url'], $uid, true);
411 return ['public' => $pcid, 'user' => $ucid];
415 * Returns contact details for a given contact id in combination with a user id
417 * @param int $cid A contact ID
418 * @param int $uid The User ID
419 * @param array $fields The selected fields for the contact
421 * @return array The contact details
425 public static function getContactForUser($cid, $uid, array $fields = [])
427 $contact = DBA::selectFirst('contact', $fields, ['id' => $cid, 'uid' => $uid]);
429 if (!DBA::isResult($contact)) {
437 * Block contact id for user id
439 * @param int $cid Either public contact id or user's contact id
440 * @param int $uid User ID
441 * @param boolean $blocked Is the contact blocked or unblocked?
444 public static function setBlockedForUser($cid, $uid, $blocked)
446 $cdata = self::getPublicAndUserContacID($cid, $uid);
451 if ($cdata['user'] != 0) {
452 DBA::update('contact', ['blocked' => $blocked], ['id' => $cdata['user'], 'pending' => false]);
455 DBA::update('user-contact', ['blocked' => $blocked], ['cid' => $cdata['public'], 'uid' => $uid], true);
459 * Returns "block" state for contact id and user id
461 * @param int $cid Either public contact id or user's contact id
462 * @param int $uid User ID
464 * @return boolean is the contact id blocked for the given user?
467 public static function isBlockedByUser($cid, $uid)
469 $cdata = self::getPublicAndUserContacID($cid, $uid);
474 $public_blocked = false;
476 if (!empty($cdata['public'])) {
477 $public_contact = DBA::selectFirst('user-contact', ['blocked'], ['cid' => $cdata['public'], 'uid' => $uid]);
478 if (DBA::isResult($public_contact)) {
479 $public_blocked = $public_contact['blocked'];
483 $user_blocked = $public_blocked;
485 if (!empty($cdata['user'])) {
486 $user_contact = DBA::selectFirst('contact', ['blocked'], ['id' => $cdata['user'], 'pending' => false]);
487 if (DBA::isResult($user_contact)) {
488 $user_blocked = $user_contact['blocked'];
492 if ($user_blocked != $public_blocked) {
493 DBA::update('user-contact', ['blocked' => $user_blocked], ['cid' => $cdata['public'], 'uid' => $uid], true);
496 return $user_blocked;
500 * Ignore contact id for user id
502 * @param int $cid Either public contact id or user's contact id
503 * @param int $uid User ID
504 * @param boolean $ignored Is the contact ignored or unignored?
507 public static function setIgnoredForUser($cid, $uid, $ignored)
509 $cdata = self::getPublicAndUserContacID($cid, $uid);
514 if ($cdata['user'] != 0) {
515 DBA::update('contact', ['readonly' => $ignored], ['id' => $cdata['user'], 'pending' => false]);
518 DBA::update('user-contact', ['ignored' => $ignored], ['cid' => $cdata['public'], 'uid' => $uid], true);
522 * Returns "ignore" state for contact id and user id
524 * @param int $cid Either public contact id or user's contact id
525 * @param int $uid User ID
527 * @return boolean is the contact id ignored for the given user?
530 public static function isIgnoredByUser($cid, $uid)
532 $cdata = self::getPublicAndUserContacID($cid, $uid);
537 $public_ignored = false;
539 if (!empty($cdata['public'])) {
540 $public_contact = DBA::selectFirst('user-contact', ['ignored'], ['cid' => $cdata['public'], 'uid' => $uid]);
541 if (DBA::isResult($public_contact)) {
542 $public_ignored = $public_contact['ignored'];
546 $user_ignored = $public_ignored;
548 if (!empty($cdata['user'])) {
549 $user_contact = DBA::selectFirst('contact', ['readonly'], ['id' => $cdata['user'], 'pending' => false]);
550 if (DBA::isResult($user_contact)) {
551 $user_ignored = $user_contact['readonly'];
555 if ($user_ignored != $public_ignored) {
556 DBA::update('user-contact', ['ignored' => $user_ignored], ['cid' => $cdata['public'], 'uid' => $uid], true);
559 return $user_ignored;
563 * Set "collapsed" for contact id and user id
565 * @param int $cid Either public contact id or user's contact id
566 * @param int $uid User ID
567 * @param boolean $collapsed are the contact's posts collapsed or uncollapsed?
570 public static function setCollapsedForUser($cid, $uid, $collapsed)
572 $cdata = self::getPublicAndUserContacID($cid, $uid);
577 DBA::update('user-contact', ['collapsed' => $collapsed], ['cid' => $cdata['public'], 'uid' => $uid], true);
581 * Returns "collapsed" state for contact id and user id
583 * @param int $cid Either public contact id or user's contact id
584 * @param int $uid User ID
586 * @return boolean is the contact id blocked for the given user?
587 * @throws HTTPException\InternalServerErrorException
588 * @throws \ImagickException
590 public static function isCollapsedByUser($cid, $uid)
592 $cdata = self::getPublicAndUserContacID($cid, $uid);
599 if (!empty($cdata['public'])) {
600 $public_contact = DBA::selectFirst('user-contact', ['collapsed'], ['cid' => $cdata['public'], 'uid' => $uid]);
601 if (DBA::isResult($public_contact)) {
602 $collapsed = $public_contact['collapsed'];
610 * Returns a list of contacts belonging in a group
616 public static function getByGroupId($gid)
621 $stmt = DBA::p('SELECT `group_member`.`contact-id`, `contact`.*
623 INNER JOIN `group_member`
624 ON `contact`.`id` = `group_member`.`contact-id`
626 AND `contact`.`uid` = ?
627 AND NOT `contact`.`self`
628 AND NOT `contact`.`deleted`
629 AND NOT `contact`.`blocked`
630 AND NOT `contact`.`pending`
631 ORDER BY `contact`.`name` ASC',
636 if (DBA::isResult($stmt)) {
637 $return = DBA::toArray($stmt);
645 * Creates the self-contact for the provided user id
648 * @return bool Operation success
649 * @throws HTTPException\InternalServerErrorException
651 public static function createSelfFromUserId($uid)
653 // Only create the entry if it doesn't exist yet
654 if (DBA::exists('contact', ['uid' => $uid, 'self' => true])) {
658 $user = DBA::selectFirst('user', ['uid', 'username', 'nickname'], ['uid' => $uid]);
659 if (!DBA::isResult($user)) {
663 $return = DBA::insert('contact', [
664 'uid' => $user['uid'],
665 'created' => DateTimeFormat::utcNow(),
667 'name' => $user['username'],
668 'nick' => $user['nickname'],
669 'photo' => DI::baseUrl() . '/photo/profile/' . $user['uid'] . '.jpg',
670 'thumb' => DI::baseUrl() . '/photo/avatar/' . $user['uid'] . '.jpg',
671 'micro' => DI::baseUrl() . '/photo/micro/' . $user['uid'] . '.jpg',
674 'url' => DI::baseUrl() . '/profile/' . $user['nickname'],
675 'nurl' => Strings::normaliseLink(DI::baseUrl() . '/profile/' . $user['nickname']),
676 'addr' => $user['nickname'] . '@' . substr(DI::baseUrl(), strpos(DI::baseUrl(), '://') + 3),
677 'request' => DI::baseUrl() . '/dfrn_request/' . $user['nickname'],
678 'notify' => DI::baseUrl() . '/dfrn_notify/' . $user['nickname'],
679 'poll' => DI::baseUrl() . '/dfrn_poll/' . $user['nickname'],
680 'confirm' => DI::baseUrl() . '/dfrn_confirm/' . $user['nickname'],
681 'poco' => DI::baseUrl() . '/poco/' . $user['nickname'],
682 'name-date' => DateTimeFormat::utcNow(),
683 'uri-date' => DateTimeFormat::utcNow(),
684 'avatar-date' => DateTimeFormat::utcNow(),
692 * Updates the self-contact for the provided user id
695 * @param boolean $update_avatar Force the avatar update
696 * @throws HTTPException\InternalServerErrorException
698 public static function updateSelfFromUserID($uid, $update_avatar = false)
700 $fields = ['id', 'name', 'nick', 'location', 'about', 'keywords', 'avatar',
701 'xmpp', 'contact-type', 'forum', 'prv', 'avatar-date', 'url', 'nurl', 'unsearchable',
702 'photo', 'thumb', 'micro', 'addr', 'request', 'notify', 'poll', 'confirm', 'poco'];
703 $self = DBA::selectFirst('contact', $fields, ['uid' => $uid, 'self' => true]);
704 if (!DBA::isResult($self)) {
708 $fields = ['nickname', 'page-flags', 'account-type'];
709 $user = DBA::selectFirst('user', $fields, ['uid' => $uid]);
710 if (!DBA::isResult($user)) {
714 $fields = ['name', 'photo', 'thumb', 'about', 'address', 'locality', 'region',
715 'country-name', 'pub_keywords', 'xmpp', 'net-publish'];
716 $profile = DBA::selectFirst('profile', $fields, ['uid' => $uid]);
717 if (!DBA::isResult($profile)) {
721 $file_suffix = 'jpg';
723 $fields = ['name' => $profile['name'], 'nick' => $user['nickname'],
724 'avatar-date' => $self['avatar-date'], 'location' => Profile::formatLocation($profile),
725 'about' => $profile['about'], 'keywords' => $profile['pub_keywords'],
726 'contact-type' => $user['account-type'],
727 'xmpp' => $profile['xmpp']];
729 $avatar = Photo::selectFirst(['resource-id', 'type'], ['uid' => $uid, 'profile' => true]);
730 if (DBA::isResult($avatar)) {
731 if ($update_avatar) {
732 $fields['avatar-date'] = DateTimeFormat::utcNow();
735 // Creating the path to the avatar, beginning with the file suffix
736 $types = Images::supportedTypes();
737 if (isset($types[$avatar['type']])) {
738 $file_suffix = $types[$avatar['type']];
741 // We are adding a timestamp value so that other systems won't use cached content
742 $timestamp = strtotime($fields['avatar-date']);
744 $prefix = DI::baseUrl() . '/photo/' .$avatar['resource-id'] . '-';
745 $suffix = '.' . $file_suffix . '?ts=' . $timestamp;
747 $fields['photo'] = $prefix . '4' . $suffix;
748 $fields['thumb'] = $prefix . '5' . $suffix;
749 $fields['micro'] = $prefix . '6' . $suffix;
751 // We hadn't found a photo entry, so we use the default avatar
752 $fields['photo'] = DI::baseUrl() . '/images/person-300.jpg';
753 $fields['thumb'] = DI::baseUrl() . '/images/person-80.jpg';
754 $fields['micro'] = DI::baseUrl() . '/images/person-48.jpg';
757 $fields['avatar'] = DI::baseUrl() . '/photo/profile/' .$uid . '.' . $file_suffix;
758 $fields['forum'] = $user['page-flags'] == User::PAGE_FLAGS_COMMUNITY;
759 $fields['prv'] = $user['page-flags'] == User::PAGE_FLAGS_PRVGROUP;
760 $fields['unsearchable'] = !$profile['net-publish'];
762 // it seems as if ported accounts can have wrong values, so we make sure that now everything is fine.
763 $fields['url'] = DI::baseUrl() . '/profile/' . $user['nickname'];
764 $fields['nurl'] = Strings::normaliseLink($fields['url']);
765 $fields['addr'] = $user['nickname'] . '@' . substr(DI::baseUrl(), strpos(DI::baseUrl(), '://') + 3);
766 $fields['request'] = DI::baseUrl() . '/dfrn_request/' . $user['nickname'];
767 $fields['notify'] = DI::baseUrl() . '/dfrn_notify/' . $user['nickname'];
768 $fields['poll'] = DI::baseUrl() . '/dfrn_poll/'. $user['nickname'];
769 $fields['confirm'] = DI::baseUrl() . '/dfrn_confirm/' . $user['nickname'];
770 $fields['poco'] = DI::baseUrl() . '/poco/' . $user['nickname'];
774 foreach ($fields as $field => $content) {
775 if ($self[$field] != $content) {
781 if ($fields['name'] != $self['name']) {
782 $fields['name-date'] = DateTimeFormat::utcNow();
784 $fields['updated'] = DateTimeFormat::utcNow();
785 DBA::update('contact', $fields, ['id' => $self['id']]);
787 // Update the public contact as well
788 DBA::update('contact', $fields, ['uid' => 0, 'nurl' => $self['nurl']]);
790 // Update the profile
791 $fields = ['photo' => DI::baseUrl() . '/photo/profile/' .$uid . '.' . $file_suffix,
792 'thumb' => DI::baseUrl() . '/photo/avatar/' . $uid .'.' . $file_suffix];
793 DBA::update('profile', $fields, ['uid' => $uid]);
798 * Marks a contact for removal
800 * @param int $id contact id
802 * @throws HTTPException\InternalServerErrorException
804 public static function remove($id)
806 // We want just to make sure that we don't delete our "self" contact
807 $contact = DBA::selectFirst('contact', ['uid'], ['id' => $id, 'self' => false]);
808 if (!DBA::isResult($contact) || !intval($contact['uid'])) {
812 // Archive the contact
813 DBA::update('contact', ['archive' => true, 'network' => Protocol::PHANTOM, 'deleted' => true], ['id' => $id]);
815 // Delete it in the background
816 Worker::add(PRIORITY_MEDIUM, 'RemoveContact', $id);
820 * Sends an unfriend message. Does not remove the contact
822 * @param array $user User unfriending
823 * @param array $contact Contact unfriended
824 * @param boolean $dissolve Remove the contact on the remote side
826 * @throws HTTPException\InternalServerErrorException
827 * @throws \ImagickException
829 public static function terminateFriendship(array $user, array $contact, $dissolve = false)
831 if (empty($contact['network'])) {
835 $protocol = $contact['network'];
836 if (($protocol == Protocol::DFRN) && !self::isLegacyDFRNContact($contact)) {
837 $protocol = Protocol::ACTIVITYPUB;
840 if (($protocol == Protocol::DFRN) && $dissolve) {
841 DFRN::deliver($user, $contact, 'placeholder', true);
842 } elseif (in_array($protocol, [Protocol::OSTATUS, Protocol::DFRN])) {
843 // create an unfollow slap
845 $item['verb'] = Activity::O_UNFOLLOW;
846 $item['follow'] = $contact["url"];
851 $item['attach'] = '';
852 $slap = OStatus::salmon($item, $user);
854 if (!empty($contact['notify'])) {
855 Salmon::slapper($user, $contact['notify'], $slap);
857 } elseif ($protocol == Protocol::DIASPORA) {
858 Diaspora::sendUnshare($user, $contact);
859 } elseif ($protocol == Protocol::ACTIVITYPUB) {
860 ActivityPub\Transmitter::sendContactUndo($contact['url'], $contact['id'], $user['uid']);
863 ActivityPub\Transmitter::sendContactReject($contact['url'], $contact['hub-verify'], $user['uid']);
869 * Marks a contact for archival after a communication issue delay
871 * Contact has refused to recognise us as a friend. We will start a countdown.
872 * If they still don't recognise us in 32 days, the relationship is over,
873 * and we won't waste any more time trying to communicate with them.
874 * This provides for the possibility that their database is temporarily messed
875 * up or some other transient event and that there's a possibility we could recover from it.
877 * @param array $contact contact to mark for archival
879 * @throws HTTPException\InternalServerErrorException
881 public static function markForArchival(array $contact)
883 if (!isset($contact['url']) && !empty($contact['id'])) {
884 $fields = ['id', 'url', 'archive', 'self', 'term-date'];
885 $contact = DBA::selectFirst('contact', $fields, ['id' => $contact['id']]);
886 if (!DBA::isResult($contact)) {
889 } elseif (!isset($contact['url'])) {
890 Logger::log('Empty contact: ' . json_encode($contact) . ' - ' . System::callstack(20), Logger::DEBUG);
893 Logger::log('Contact '.$contact['id'].' is marked for archival', Logger::DEBUG);
895 // Contact already archived or "self" contact? => nothing to do
896 if ($contact['archive'] || $contact['self']) {
900 if ($contact['term-date'] <= DBA::NULL_DATETIME) {
901 DBA::update('contact', ['term-date' => DateTimeFormat::utcNow()], ['id' => $contact['id']]);
902 DBA::update('contact', ['term-date' => DateTimeFormat::utcNow()], ['`nurl` = ? AND `term-date` <= ? AND NOT `self`', Strings::normaliseLink($contact['url']), DBA::NULL_DATETIME]);
905 * We really should send a notification to the owner after 2-3 weeks
906 * so they won't be surprised when the contact vanishes and can take
907 * remedial action if this was a serious mistake or glitch
910 /// @todo Check for contact vitality via probing
911 $archival_days = DI::config()->get('system', 'archival_days', 32);
913 $expiry = $contact['term-date'] . ' + ' . $archival_days . ' days ';
914 if (DateTimeFormat::utcNow() > DateTimeFormat::utc($expiry)) {
915 /* Relationship is really truly dead. archive them rather than
916 * delete, though if the owner tries to unarchive them we'll start
917 * the whole process over again.
919 DBA::update('contact', ['archive' => true], ['id' => $contact['id']]);
920 DBA::update('contact', ['archive' => true], ['nurl' => Strings::normaliseLink($contact['url']), 'self' => false]);
921 GContact::updateFromPublicContactURL($contact['url']);
927 * Cancels the archival countdown
929 * @see Contact::markForArchival()
931 * @param array $contact contact to be unmarked for archival
935 public static function unmarkForArchival(array $contact)
937 // Always unarchive the relay contact entry
938 if (!empty($contact['batch']) && !empty($contact['term-date']) && ($contact['term-date'] > DBA::NULL_DATETIME)) {
939 $fields = ['term-date' => DBA::NULL_DATETIME, 'archive' => false];
940 $condition = ['uid' => 0, 'network' => Protocol::FEDERATED, 'batch' => $contact['batch'], 'contact-type' => self::TYPE_RELAY];
941 DBA::update('contact', $fields, $condition);
944 $condition = ['`id` = ? AND (`term-date` > ? OR `archive`)', $contact['id'], DBA::NULL_DATETIME];
945 $exists = DBA::exists('contact', $condition);
947 // We don't need to update, we never marked this contact for archival
952 Logger::log('Contact '.$contact['id'].' is marked as vital again', Logger::DEBUG);
954 if (!isset($contact['url']) && !empty($contact['id'])) {
955 $fields = ['id', 'url', 'batch'];
956 $contact = DBA::selectFirst('contact', $fields, ['id' => $contact['id']]);
957 if (!DBA::isResult($contact)) {
962 // It's a miracle. Our dead contact has inexplicably come back to life.
963 $fields = ['term-date' => DBA::NULL_DATETIME, 'archive' => false];
964 DBA::update('contact', $fields, ['id' => $contact['id']]);
965 DBA::update('contact', $fields, ['nurl' => Strings::normaliseLink($contact['url']), 'self' => false]);
966 GContact::updateFromPublicContactURL($contact['url']);
970 * Get contact data for a given profile link
972 * The function looks at several places (contact table and gcontact table) for the contact
973 * It caches its result for the same script execution to prevent duplicate calls
975 * @param string $url The profile link
976 * @param int $uid User id
977 * @param array $default If not data was found take this data as default value
979 * @return array Contact data
980 * @throws HTTPException\InternalServerErrorException
982 public static function getDetailsByURL($url, $uid = -1, array $default = [])
994 if (isset($cache[$url][$uid])) {
995 return $cache[$url][$uid];
998 $ssl_url = str_replace('http://', 'https://', $url);
1000 $nurl = Strings::normaliseLink($url);
1002 // Fetch contact data from the contact table for the given user
1003 $s = DBA::p("SELECT `id`, `id` AS `cid`, 0 AS `gid`, 0 AS `zid`, `uid`, `url`, `nurl`, `alias`, `network`, `name`, `nick`, `addr`, `location`, `about`, `xmpp`,
1004 `keywords`, `photo`, `thumb`, `micro`, `forum`, `prv`, (`forum` | `prv`) AS `community`, `contact-type`, `bd` AS `birthday`, `self`, `rel`, `pending`
1005 FROM `contact` WHERE `nurl` = ? AND `uid` = ?", $nurl, $uid);
1006 $r = DBA::toArray($s);
1008 // Fetch contact data from the contact table for the given user, checking with the alias
1009 if (!DBA::isResult($r)) {
1010 $s = DBA::p("SELECT `id`, `id` AS `cid`, 0 AS `gid`, 0 AS `zid`, `uid`, `url`, `nurl`, `alias`, `network`, `name`, `nick`, `addr`, `location`, `about`, `xmpp`,
1011 `keywords`, `photo`, `thumb`, `micro`, `forum`, `prv`, (`forum` | `prv`) AS `community`, `contact-type`, `bd` AS `birthday`, `self`, `rel`, `pending`
1012 FROM `contact` WHERE `alias` IN (?, ?, ?) AND `uid` = ?", $nurl, $url, $ssl_url, $uid);
1013 $r = DBA::toArray($s);
1016 // Fetch the data from the contact table with "uid=0" (which is filled automatically)
1017 if (!DBA::isResult($r)) {
1018 $s = DBA::p("SELECT `id`, 0 AS `cid`, `id` AS `zid`, 0 AS `gid`, `uid`, `url`, `nurl`, `alias`, `network`, `name`, `nick`, `addr`, `location`, `about`, `xmpp`,
1019 `keywords`, `photo`, `thumb`, `micro`, `forum`, `prv`, (`forum` | `prv`) AS `community`, `contact-type`, `bd` AS `birthday`, 0 AS `self`, `rel`, `pending`
1020 FROM `contact` WHERE `nurl` = ? AND `uid` = 0", $nurl);
1021 $r = DBA::toArray($s);
1024 // Fetch the data from the contact table with "uid=0" (which is filled automatically) - checked with the alias
1025 if (!DBA::isResult($r)) {
1026 $s = DBA::p("SELECT `id`, 0 AS `cid`, `id` AS `zid`, 0 AS `gid`, `uid`, `url`, `nurl`, `alias`, `network`, `name`, `nick`, `addr`, `location`, `about`, `xmpp`,
1027 `keywords`, `photo`, `thumb`, `micro`, `forum`, `prv`, (`forum` | `prv`) AS `community`, `contact-type`, `bd` AS `birthday`, 0 AS `self`, `rel`, `pending`
1028 FROM `contact` WHERE `alias` IN (?, ?, ?) AND `uid` = 0", $nurl, $url, $ssl_url);
1029 $r = DBA::toArray($s);
1032 // Fetch the data from the gcontact table
1033 if (!DBA::isResult($r)) {
1034 $s = DBA::p("SELECT 0 AS `id`, 0 AS `cid`, `id` AS `gid`, 0 AS `zid`, 0 AS `uid`, `url`, `nurl`, `alias`, `network`, `name`, `nick`, `addr`, `location`, `about`, '' AS `xmpp`,
1035 `keywords`, `photo`, `photo` AS `thumb`, `photo` AS `micro`, 0 AS `forum`, 0 AS `prv`, `community`, `contact-type`, `birthday`, 0 AS `self`, 2 AS `rel`, 0 AS `pending`
1036 FROM `gcontact` WHERE `nurl` = ?", $nurl);
1037 $r = DBA::toArray($s);
1040 if (DBA::isResult($r)) {
1041 $authoritativeResult = true;
1042 // If there is more than one entry we filter out the connector networks
1043 if (count($r) > 1) {
1044 foreach ($r as $id => $result) {
1045 if (!in_array($result["network"], Protocol::NATIVE_SUPPORT)) {
1051 $profile = array_shift($r);
1053 // "bd" always contains the upcoming birthday of a contact.
1054 // "birthday" might contain the birthday including the year of birth.
1055 if ($profile["birthday"] > DBA::NULL_DATE) {
1056 $bd_timestamp = strtotime($profile["birthday"]);
1057 $month = date("m", $bd_timestamp);
1058 $day = date("d", $bd_timestamp);
1060 $current_timestamp = time();
1061 $current_year = date("Y", $current_timestamp);
1062 $current_month = date("m", $current_timestamp);
1063 $current_day = date("d", $current_timestamp);
1065 $profile["bd"] = $current_year . "-" . $month . "-" . $day;
1066 $current = $current_year . "-" . $current_month . "-" . $current_day;
1068 if ($profile["bd"] < $current) {
1069 $profile["bd"] = ( ++$current_year) . "-" . $month . "-" . $day;
1072 $profile["bd"] = DBA::NULL_DATE;
1075 $authoritativeResult = false;
1076 $profile = $default;
1079 if (empty($profile["photo"]) && isset($default["photo"])) {
1080 $profile["photo"] = $default["photo"];
1083 if (empty($profile["name"]) && isset($default["name"])) {
1084 $profile["name"] = $default["name"];
1087 if (empty($profile["network"]) && isset($default["network"])) {
1088 $profile["network"] = $default["network"];
1091 if (empty($profile["thumb"]) && isset($profile["photo"])) {
1092 $profile["thumb"] = $profile["photo"];
1095 if (empty($profile["micro"]) && isset($profile["thumb"])) {
1096 $profile["micro"] = $profile["thumb"];
1099 if ((empty($profile["addr"]) || empty($profile["name"])) && !empty($profile["gid"])
1100 && in_array($profile["network"], Protocol::FEDERATED)
1102 Worker::add(PRIORITY_LOW, "UpdateGContact", $url);
1105 // Show contact details of Diaspora contacts only if connected
1106 if (empty($profile["cid"]) && ($profile["network"] ?? "") == Protocol::DIASPORA) {
1107 $profile["location"] = "";
1108 $profile["about"] = "";
1109 $profile["birthday"] = DBA::NULL_DATE;
1112 // Only cache the result if it came from the DB since this method is used in widely different contexts
1113 // @see display_fetch_author for an example of $default parameter diverging from the DB result
1114 if ($authoritativeResult) {
1115 $cache[$url][$uid] = $profile;
1122 * Get contact data for a given address
1124 * The function looks at several places (contact table and gcontact table) for the contact
1126 * @param string $addr The profile link
1127 * @param int $uid User id
1129 * @return array Contact data
1130 * @throws HTTPException\InternalServerErrorException
1131 * @throws \ImagickException
1133 public static function getDetailsByAddr($addr, $uid = -1)
1140 $uid = local_user();
1143 // Fetch contact data from the contact table for the given user
1144 $r = q("SELECT `id`, `id` AS `cid`, 0 AS `gid`, 0 AS `zid`, `uid`, `url`, `nurl`, `alias`, `network`, `name`, `nick`, `addr`, `location`, `about`, `xmpp`,
1145 `keywords`, `photo`, `thumb`, `micro`, `forum`, `prv`, (`forum` | `prv`) AS `community`, `contact-type`, `bd` AS `birthday`, `self`, `rel`, `pending`,`baseurl`
1146 FROM `contact` WHERE `addr` = '%s' AND `uid` = %d AND NOT `deleted`",
1150 // Fetch the data from the contact table with "uid=0" (which is filled automatically)
1151 if (!DBA::isResult($r)) {
1152 $r = q("SELECT `id`, 0 AS `cid`, `id` AS `zid`, 0 AS `gid`, `uid`, `url`, `nurl`, `alias`, `network`, `name`, `nick`, `addr`, `location`, `about`, `xmpp`,
1153 `keywords`, `photo`, `thumb`, `micro`, `forum`, `prv`, (`forum` | `prv`) AS `community`, `contact-type`, `bd` AS `birthday`, 0 AS `self`, `rel`, `pending`, `baseurl`
1154 FROM `contact` WHERE `addr` = '%s' AND `uid` = 0 AND NOT `deleted`",
1159 // Fetch the data from the gcontact table
1160 if (!DBA::isResult($r)) {
1161 $r = q("SELECT 0 AS `id`, 0 AS `cid`, `id` AS `gid`, 0 AS `zid`, 0 AS `uid`, `url`, `nurl`, `alias`, `network`, `name`, `nick`, `addr`, `location`, `about`, '' AS `xmpp`,
1162 `keywords`, `photo`, `photo` AS `thumb`, `photo` AS `micro`, `community` AS `forum`, 0 AS `prv`, `community`, `contact-type`, `birthday`, 0 AS `self`, 2 AS `rel`, 0 AS `pending`, `server_url` AS `baseurl`
1163 FROM `gcontact` WHERE `addr` = '%s'",
1168 if (!DBA::isResult($r)) {
1169 $data = Probe::uri($addr);
1171 $profile = self::getDetailsByURL($data['url'], $uid);
1180 * Returns the data array for the photo menu of a given contact
1182 * @param array $contact contact
1183 * @param int $uid optional, default 0
1185 * @throws HTTPException\InternalServerErrorException
1186 * @throws \ImagickException
1188 public static function photoMenu(array $contact, $uid = 0)
1193 $contact_drop_link = '';
1197 $uid = local_user();
1200 if (empty($contact['uid']) || ($contact['uid'] != $uid)) {
1202 $profile_link = self::magicLink($contact['url']);
1203 $menu = ['profile' => [DI::l10n()->t('View Profile'), $profile_link, true]];
1208 // Look for our own contact if the uid doesn't match and isn't public
1209 $contact_own = DBA::selectFirst('contact', [], ['nurl' => $contact['nurl'], 'network' => $contact['network'], 'uid' => $uid]);
1210 if (DBA::isResult($contact_own)) {
1211 return self::photoMenu($contact_own, $uid);
1216 if (($contact['network'] === Protocol::DFRN) && !$contact['self'] && empty($contact['pending'])) {
1218 $profile_link = DI::baseUrl() . '/redir/' . $contact['id'];
1220 $profile_link = $contact['url'];
1223 if ($profile_link === 'mailbox') {
1228 $status_link = $profile_link . '/status';
1229 $photos_link = str_replace('/profile/', '/photos/', $profile_link);
1230 $profile_link = $profile_link . '/profile';
1233 if (self::canReceivePrivateMessages($contact) && empty($contact['pending'])) {
1234 $pm_url = DI::baseUrl() . '/message/new/' . $contact['id'];
1237 if (($contact['network'] == Protocol::DFRN) && !$contact['self'] && empty($contact['pending'])) {
1238 $poke_link = 'contact/' . $contact['id'] . '/poke';
1241 $contact_url = DI::baseUrl() . '/contact/' . $contact['id'];
1243 $posts_link = DI::baseUrl() . '/contact/' . $contact['id'] . '/conversations';
1245 if (!$contact['self']) {
1246 $contact_drop_link = DI::baseUrl() . '/contact/' . $contact['id'] . '/drop?confirm=1';
1250 $unfollow_link = '';
1251 if (!$contact['self'] && in_array($contact['network'], Protocol::NATIVE_SUPPORT)) {
1252 if ($contact['uid'] && in_array($contact['rel'], [self::SHARING, self::FRIEND])) {
1253 $unfollow_link = 'unfollow?url=' . urlencode($contact['url']);
1254 } elseif(!$contact['pending']) {
1255 $follow_link = 'follow?url=' . urlencode($contact['url']);
1259 if (!empty($follow_link) || !empty($unfollow_link)) {
1260 $contact_drop_link = '';
1265 * "name" => [ "Label", "link", (bool)Should the link opened in a new tab? ]
1267 if (empty($contact['uid'])) {
1269 'profile' => [DI::l10n()->t('View Profile') , $profile_link , true],
1270 'network' => [DI::l10n()->t('Network Posts') , $posts_link , false],
1271 'edit' => [DI::l10n()->t('View Contact') , $contact_url , false],
1272 'follow' => [DI::l10n()->t('Connect/Follow'), $follow_link , true],
1273 'unfollow'=> [DI::l10n()->t('UnFollow') , $unfollow_link, true],
1277 'status' => [DI::l10n()->t('View Status') , $status_link , true],
1278 'profile' => [DI::l10n()->t('View Profile') , $profile_link , true],
1279 'photos' => [DI::l10n()->t('View Photos') , $photos_link , true],
1280 'network' => [DI::l10n()->t('Network Posts') , $posts_link , false],
1281 'edit' => [DI::l10n()->t('View Contact') , $contact_url , false],
1282 'drop' => [DI::l10n()->t('Drop Contact') , $contact_drop_link, false],
1283 'pm' => [DI::l10n()->t('Send PM') , $pm_url , false],
1284 'poke' => [DI::l10n()->t('Poke') , $poke_link , false],
1285 'follow' => [DI::l10n()->t('Connect/Follow'), $follow_link , true],
1286 'unfollow'=> [DI::l10n()->t('UnFollow') , $unfollow_link , true],
1289 if (!empty($contact['pending'])) {
1290 $intro = DBA::selectFirst('intro', ['id'], ['contact-id' => $contact['id']]);
1291 if (DBA::isResult($intro)) {
1292 $menu['follow'] = [DI::l10n()->t('Approve'), 'notifications/intros/' . $intro['id'], true];
1297 $args = ['contact' => $contact, 'menu' => &$menu];
1299 Hook::callAll('contact_photo_menu', $args);
1301 $menucondensed = [];
1303 foreach ($menu as $menuname => $menuitem) {
1304 if ($menuitem[1] != '') {
1305 $menucondensed[$menuname] = $menuitem;
1309 return $menucondensed;
1313 * Returns ungrouped contact count or list for user
1315 * Returns either the total number of ungrouped contacts for the given user
1316 * id or a paginated list of ungrouped contacts.
1318 * @param int $uid uid
1320 * @throws \Exception
1322 public static function getUngroupedList($uid)
1332 SELECT DISTINCT(`contact-id`)
1334 INNER JOIN `group` ON `group`.`id` = `group_member`.`gid`
1335 WHERE `group`.`uid` = %d
1336 )", intval($uid), intval($uid));
1340 * Have a look at all contact tables for a given profile url.
1341 * This function works as a replacement for probing the contact.
1343 * @param string $url Contact URL
1344 * @param integer $cid Contact ID
1346 * @return array Contact array in the "probe" structure
1348 private static function getProbeDataFromDatabase($url, $cid = null)
1350 // The link could be provided as http although we stored it as https
1351 $ssl_url = str_replace('http://', 'https://', $url);
1353 $fields = ['id', 'uid', 'url', 'addr', 'alias', 'notify', 'poll', 'name', 'nick',
1354 'photo', 'keywords', 'location', 'about', 'network',
1355 'priority', 'batch', 'request', 'confirm', 'poco'];
1358 $data = DBA::selectFirst('contact', $fields, ['id' => $cid]);
1359 if (DBA::isResult($data)) {
1364 $data = DBA::selectFirst('contact', $fields, ['nurl' => Strings::normaliseLink($url)]);
1366 if (!DBA::isResult($data)) {
1367 $condition = ['alias' => [$url, Strings::normaliseLink($url), $ssl_url]];
1368 $data = DBA::selectFirst('contact', $fields, $condition);
1371 if (DBA::isResult($data)) {
1372 // For security reasons we don't fetch key data from our users
1373 $data["pubkey"] = '';
1377 $fields = ['url', 'addr', 'alias', 'notify', 'name', 'nick',
1378 'photo', 'keywords', 'location', 'about', 'network'];
1379 $data = DBA::selectFirst('gcontact', $fields, ['nurl' => Strings::normaliseLink($url)]);
1381 if (!DBA::isResult($data)) {
1382 $condition = ['alias' => [$url, Strings::normaliseLink($url), $ssl_url]];
1383 $data = DBA::selectFirst('contact', $fields, $condition);
1386 if (DBA::isResult($data)) {
1387 $data["pubkey"] = '';
1389 $data["priority"] = 0;
1390 $data["batch"] = '';
1391 $data["request"] = '';
1392 $data["confirm"] = '';
1397 $data = ActivityPub::probeProfile($url, false);
1398 if (!empty($data)) {
1402 $fields = ['url', 'addr', 'alias', 'notify', 'poll', 'name', 'nick',
1403 'photo', 'network', 'priority', 'batch', 'request', 'confirm'];
1404 $data = DBA::selectFirst('fcontact', $fields, ['url' => $url]);
1406 if (!DBA::isResult($data)) {
1407 $condition = ['alias' => [$url, Strings::normaliseLink($url), $ssl_url]];
1408 $data = DBA::selectFirst('contact', $fields, $condition);
1411 if (DBA::isResult($data)) {
1412 $data["pubkey"] = '';
1413 $data["keywords"] = '';
1414 $data["location"] = '';
1415 $data["about"] = '';
1424 * Fetch the contact id for a given URL and user
1426 * First lookup in the contact table to find a record matching either `url`, `nurl`,
1427 * `addr` or `alias`.
1429 * If there's no record and we aren't looking for a public contact, we quit.
1430 * If there's one, we check that it isn't time to update the picture else we
1431 * directly return the found contact id.
1433 * Second, we probe the provided $url whether it's http://server.tld/profile or
1434 * nick@server.tld. We quit if we can't get any info back.
1436 * Third, we create the contact record if it doesn't exist
1438 * Fourth, we update the existing record with the new data (avatar, alias, nick)
1439 * if there's any updates
1441 * @param string $url Contact URL
1442 * @param integer $uid The user id for the contact (0 = public contact)
1443 * @param boolean $no_update Don't update the contact
1444 * @param array $default Default value for creating the contact when every else fails
1445 * @param boolean $in_loop Internally used variable to prevent an endless loop
1447 * @return integer Contact ID
1448 * @throws HTTPException\InternalServerErrorException
1449 * @throws \ImagickException
1451 public static function getIdForURL($url, $uid = 0, $no_update = false, $default = [], $in_loop = false)
1453 Logger::log("Get contact data for url " . $url . " and user " . $uid . " - " . System::callstack(), Logger::DEBUG);
1461 /// @todo Verify if we can't use Contact::getDetailsByUrl instead of the following
1462 // We first try the nurl (http://server.tld/nick), most common case
1463 $fields = ['id', 'avatar', 'updated', 'network'];
1464 $options = ['order' => ['id']];
1465 $contact = DBA::selectFirst('contact', $fields, ['nurl' => Strings::normaliseLink($url), 'uid' => $uid, 'deleted' => false], $options);
1467 // Then the addr (nick@server.tld)
1468 if (!DBA::isResult($contact)) {
1469 $contact = DBA::selectFirst('contact', $fields, ['addr' => str_replace('acct:', '', $url), 'uid' => $uid, 'deleted' => false], $options);
1472 // Then the alias (which could be anything)
1473 if (!DBA::isResult($contact)) {
1474 // The link could be provided as http although we stored it as https
1475 $ssl_url = str_replace('http://', 'https://', $url);
1476 $condition = ['`alias` IN (?, ?, ?) AND `uid` = ? AND NOT `deleted`', $url, Strings::normaliseLink($url), $ssl_url, $uid];
1477 $contact = DBA::selectFirst('contact', $fields, $condition, $options);
1480 if (DBA::isResult($contact)) {
1481 $contact_id = $contact["id"];
1482 $update_contact = false;
1484 // Update the contact every 7 days (Don't update mail or feed contacts)
1485 if (in_array($contact['network'], Protocol::FEDERATED)) {
1486 $update_contact = ($contact['updated'] < DateTimeFormat::utc('now -7 days'));
1488 // We force the update if the avatar is empty
1489 if (empty($contact['avatar'])) {
1490 $update_contact = true;
1492 } elseif (empty($default) && in_array($contact['network'], [Protocol::MAIL, Protocol::PHANTOM]) && ($uid == 0)) {
1493 // Update public mail accounts via their user's accounts
1494 $fields = ['network', 'addr', 'name', 'nick', 'avatar', 'photo', 'thumb', 'micro'];
1495 $mailcontact = DBA::selectFirst('contact', $fields, ["`addr` = ? AND `network` = ? AND `uid` != 0", $url, Protocol::MAIL]);
1496 if (!DBA::isResult($mailcontact)) {
1497 $mailcontact = DBA::selectFirst('contact', $fields, ["`nurl` = ? AND `network` = ? AND `uid` != 0", $url, Protocol::MAIL]);
1500 if (DBA::isResult($mailcontact)) {
1501 DBA::update('contact', $mailcontact, ['id' => $contact_id]);
1505 // Update the contact in the background if needed but it is called by the frontend
1506 if ($update_contact && $no_update && in_array($contact['network'], Protocol::NATIVE_SUPPORT)) {
1507 Worker::add(PRIORITY_LOW, "UpdateContact", $contact_id, ($uid == 0 ? 'force' : ''));
1510 if (!$update_contact || $no_update) {
1513 } elseif ($uid != 0) {
1514 // Non-existing user-specific contact, exiting
1518 if ($no_update && empty($default)) {
1519 // When we don't want to update, we look if we know this contact in any way
1520 $data = self::getProbeDataFromDatabase($url, $contact_id);
1521 $background_update = true;
1522 } elseif ($no_update && !empty($default['network'])) {
1523 // If there are default values, take these
1525 $background_update = false;
1528 $background_update = false;
1532 $data = Probe::uri($url, "", $uid);
1535 // Take the default values when probing failed
1536 if (!empty($default) && !in_array($data["network"], array_merge(Protocol::NATIVE_SUPPORT, [Protocol::PUMPIO]))) {
1537 $data = array_merge($data, $default);
1540 if (empty($data) || ($data['network'] == Protocol::PHANTOM)) {
1541 Logger::info('No valid network found', ['url' => $url, 'data' => $data, 'callstack' => System::callstack(20)]);
1545 if (!$contact_id && !empty($data['alias']) && ($data['alias'] != $url) && !$in_loop) {
1546 $contact_id = self::getIdForURL($data["alias"], $uid, true, $default, true);
1552 'created' => DateTimeFormat::utcNow(),
1553 'url' => $data['url'],
1554 'nurl' => Strings::normaliseLink($data['url']),
1555 'addr' => $data['addr'] ?? '',
1556 'alias' => $data['alias'] ?? '',
1557 'notify' => $data['notify'] ?? '',
1558 'poll' => $data['poll'] ?? '',
1559 'name' => $data['name'] ?? '',
1560 'nick' => $data['nick'] ?? '',
1561 'photo' => $data['photo'] ?? '',
1562 'keywords' => $data['keywords'] ?? '',
1563 'location' => $data['location'] ?? '',
1564 'about' => $data['about'] ?? '',
1565 'network' => $data['network'],
1566 'pubkey' => $data['pubkey'] ?? '',
1567 'rel' => self::SHARING,
1568 'priority' => $data['priority'] ?? 0,
1569 'batch' => $data['batch'] ?? '',
1570 'request' => $data['request'] ?? '',
1571 'confirm' => $data['confirm'] ?? '',
1572 'poco' => $data['poco'] ?? '',
1573 'baseurl' => $data['baseurl'] ?? '',
1574 'gsid' => $data['gsid'] ?? null,
1575 'name-date' => DateTimeFormat::utcNow(),
1576 'uri-date' => DateTimeFormat::utcNow(),
1577 'avatar-date' => DateTimeFormat::utcNow(),
1583 $condition = ['nurl' => Strings::normaliseLink($data["url"]), 'uid' => $uid, 'deleted' => false];
1585 // Before inserting we do check if the entry does exist now.
1586 $contact = DBA::selectFirst('contact', ['id'], $condition, ['order' => ['id']]);
1587 if (!DBA::isResult($contact)) {
1588 Logger::info('Create new contact', $fields);
1590 self::insert($fields);
1592 // We intentionally aren't using lastInsertId here. There is a chance for duplicates.
1593 $contact = DBA::selectFirst('contact', ['id'], $condition, ['order' => ['id']]);
1594 if (!DBA::isResult($contact)) {
1595 Logger::info('Contact creation failed', $fields);
1600 Logger::info('Contact had been created before', ['id' => $contact["id"], 'url' => $url, 'contact' => $fields]);
1603 $contact_id = $contact["id"];
1606 if (!empty($data['photo']) && ($data['network'] != Protocol::FEED)) {
1607 self::updateAvatar($data['photo'], $uid, $contact_id);
1610 if (in_array($data["network"], array_merge(Protocol::NATIVE_SUPPORT, [Protocol::PUMPIO]))) {
1611 if ($background_update) {
1612 // Update in the background when we fetched the data solely from the database
1613 Worker::add(PRIORITY_MEDIUM, "UpdateContact", $contact_id, ($uid == 0 ? 'force' : ''));
1615 // Else do a direct update
1616 self::updateFromProbe($contact_id, '', false);
1618 // Update the gcontact entry
1620 GContact::updateFromPublicContactID($contact_id);
1621 if (($data['network'] == Protocol::ACTIVITYPUB) && in_array(DI::config()->get('system', 'gcontact_discovery'), [GContact::DISCOVERY_DIRECT, GContact::DISCOVERY_RECURSIVE])) {
1622 GContact::discoverFollowers($data['url']);
1627 $fields = ['url', 'nurl', 'addr', 'alias', 'name', 'nick', 'keywords', 'location', 'about', 'avatar-date', 'baseurl'];
1628 $contact = DBA::selectFirst('contact', $fields, ['id' => $contact_id]);
1630 // This condition should always be true
1631 if (!DBA::isResult($contact)) {
1636 'url' => $data['url'],
1637 'nurl' => Strings::normaliseLink($data['url']),
1638 'updated' => DateTimeFormat::utcNow()
1641 $fields = ['addr', 'alias', 'name', 'nick', 'keywords', 'location', 'about', 'baseurl'];
1643 foreach ($fields as $field) {
1644 $updated[$field] = ($data[$field] ?? '') ?: $contact[$field];
1647 if (($updated['addr'] != $contact['addr']) || (!empty($data['alias']) && ($data['alias'] != $contact['alias']))) {
1648 $updated['uri-date'] = DateTimeFormat::utcNow();
1651 if (($data['name'] != $contact['name']) || ($data['nick'] != $contact['nick'])) {
1652 $updated['name-date'] = DateTimeFormat::utcNow();
1655 DBA::update('contact', $updated, ['id' => $contact_id], $contact);
1662 * Checks if the contact is archived
1664 * @param int $cid contact id
1666 * @return boolean Is the contact archived?
1667 * @throws HTTPException\InternalServerErrorException
1669 public static function isArchived(int $cid)
1675 $contact = DBA::selectFirst('contact', ['archive', 'url', 'batch'], ['id' => $cid]);
1676 if (!DBA::isResult($contact)) {
1680 if ($contact['archive']) {
1684 // Check status of ActivityPub endpoints
1685 $apcontact = APContact::getByURL($contact['url'], false);
1686 if (!empty($apcontact)) {
1687 if (!empty($apcontact['inbox']) && DBA::exists('inbox-status', ['archive' => true, 'url' => $apcontact['inbox']])) {
1691 if (!empty($apcontact['sharedinbox']) && DBA::exists('inbox-status', ['archive' => true, 'url' => $apcontact['sharedinbox']])) {
1696 // Check status of Diaspora endpoints
1697 if (!empty($contact['batch'])) {
1698 $condition = ['archive' => true, 'uid' => 0, 'network' => Protocol::FEDERATED, 'batch' => $contact['batch'], 'contact-type' => self::TYPE_RELAY];
1699 return DBA::exists('contact', $condition);
1706 * Checks if the contact is blocked
1708 * @param int $cid contact id
1710 * @return boolean Is the contact blocked?
1711 * @throws HTTPException\InternalServerErrorException
1713 public static function isBlocked($cid)
1719 $blocked = DBA::selectFirst('contact', ['blocked', 'url'], ['id' => $cid]);
1720 if (!DBA::isResult($blocked)) {
1724 if (Network::isUrlBlocked($blocked['url'])) {
1728 return (bool) $blocked['blocked'];
1732 * Checks if the contact is hidden
1734 * @param int $cid contact id
1736 * @return boolean Is the contact hidden?
1737 * @throws \Exception
1739 public static function isHidden($cid)
1745 $hidden = DBA::selectFirst('contact', ['hidden'], ['id' => $cid]);
1746 if (!DBA::isResult($hidden)) {
1749 return (bool) $hidden['hidden'];
1753 * Returns posts from a given contact url
1755 * @param string $contact_url Contact URL
1757 * @param bool $thread_mode
1758 * @param int $update
1759 * @return string posts in HTML
1760 * @throws \Exception
1762 public static function getPostsFromUrl($contact_url, $thread_mode = false, $update = 0)
1766 $cid = self::getIdForURL($contact_url);
1768 $contact = DBA::selectFirst('contact', ['contact-type', 'network'], ['id' => $cid]);
1769 if (!DBA::isResult($contact)) {
1773 if (empty($contact["network"]) || in_array($contact["network"], Protocol::FEDERATED)) {
1774 $sql = "(`item`.`uid` = 0 OR (`item`.`uid` = ? AND NOT `item`.`global`))";
1776 $sql = "`item`.`uid` = ?";
1779 $contact_field = ((($contact["contact-type"] == self::TYPE_COMMUNITY) || ($contact['network'] == Protocol::MAIL)) ? 'owner-id' : 'author-id');
1782 $condition = ["`$contact_field` = ? AND `gravity` = ? AND " . $sql,
1783 $cid, GRAVITY_PARENT, local_user()];
1785 $condition = ["`$contact_field` = ? AND `gravity` IN (?, ?) AND " . $sql,
1786 $cid, GRAVITY_PARENT, GRAVITY_COMMENT, local_user()];
1789 if (DI::mode()->isMobile()) {
1790 $itemsPerPage = DI::pConfig()->get(local_user(), 'system', 'itemspage_mobile_network',
1791 DI::config()->get('system', 'itemspage_network_mobile'));
1793 $itemsPerPage = DI::pConfig()->get(local_user(), 'system', 'itemspage_network',
1794 DI::config()->get('system', 'itemspage_network'));
1797 $pager = new Pager(DI::l10n(), DI::args()->getQueryString(), $itemsPerPage);
1799 $params = ['order' => ['received' => true],
1800 'limit' => [$pager->getStart(), $pager->getItemsPerPage()]];
1803 $r = Item::selectThreadForUser(local_user(), ['uri'], $condition, $params);
1805 $items = Item::inArray($r);
1807 $o = conversation($a, $items, 'contacts', $update, false, 'commented', local_user());
1809 $r = Item::selectForUser(local_user(), [], $condition, $params);
1811 $items = Item::inArray($r);
1813 $o = conversation($a, $items, 'contact-posts', false);
1817 $o .= $pager->renderMinimal(count($items));
1824 * Returns the account type name
1826 * The function can be called with either the user or the contact array
1828 * @param array $contact contact or user array
1831 public static function getAccountType(array $contact)
1833 // There are several fields that indicate that the contact or user is a forum
1834 // "page-flags" is a field in the user table,
1835 // "forum" and "prv" are used in the contact table. They stand for User::PAGE_FLAGS_COMMUNITY and User::PAGE_FLAGS_PRVGROUP.
1836 // "community" is used in the gcontact table and is true if the contact is User::PAGE_FLAGS_COMMUNITY or User::PAGE_FLAGS_PRVGROUP.
1837 if ((isset($contact['page-flags']) && (intval($contact['page-flags']) == User::PAGE_FLAGS_COMMUNITY))
1838 || (isset($contact['page-flags']) && (intval($contact['page-flags']) == User::PAGE_FLAGS_PRVGROUP))
1839 || (isset($contact['forum']) && intval($contact['forum']))
1840 || (isset($contact['prv']) && intval($contact['prv']))
1841 || (isset($contact['community']) && intval($contact['community']))
1843 $type = self::TYPE_COMMUNITY;
1845 $type = self::TYPE_PERSON;
1848 // The "contact-type" (contact table) and "account-type" (user table) are more general then the chaos from above.
1849 if (isset($contact["contact-type"])) {
1850 $type = $contact["contact-type"];
1853 if (isset($contact["account-type"])) {
1854 $type = $contact["account-type"];
1858 case self::TYPE_ORGANISATION:
1859 $account_type = DI::l10n()->t("Organisation");
1862 case self::TYPE_NEWS:
1863 $account_type = DI::l10n()->t('News');
1866 case self::TYPE_COMMUNITY:
1867 $account_type = DI::l10n()->t("Forum");
1875 return $account_type;
1883 * @throws \Exception
1885 public static function block($cid, $reason = null)
1887 $return = DBA::update('contact', ['blocked' => true, 'block_reason' => $reason], ['id' => $cid]);
1893 * Unblocks a contact
1897 * @throws \Exception
1899 public static function unblock($cid)
1901 $return = DBA::update('contact', ['blocked' => false, 'block_reason' => null], ['id' => $cid]);
1907 * Updates the avatar links in a contact only if needed
1909 * @param string $avatar Link to avatar picture
1910 * @param int $uid User id of contact owner
1911 * @param int $cid Contact id
1912 * @param bool $force force picture update
1915 * @throws HTTPException\InternalServerErrorException
1916 * @throws HTTPException\NotFoundException
1917 * @throws \ImagickException
1919 public static function updateAvatar($avatar, $uid, $cid, $force = false)
1921 $contact = DBA::selectFirst('contact', ['avatar', 'photo', 'thumb', 'micro', 'nurl'], ['id' => $cid, 'self' => false]);
1922 if (!DBA::isResult($contact)) {
1927 $contact['photo'] ?? '',
1928 $contact['thumb'] ?? '',
1929 $contact['micro'] ?? '',
1932 foreach ($data as $image_uri) {
1933 $image_rid = Photo::ridFromURI($image_uri);
1934 if ($image_rid && !Photo::exists(['resource-id' => $image_rid, 'uid' => $uid])) {
1935 Logger::info('Regenerating avatar', ['contact uid' => $uid, 'cid' => $cid, 'missing photo' => $image_rid, 'avatar' => $contact['avatar']]);
1940 if (($contact["avatar"] != $avatar) || $force) {
1941 $photos = Photo::importProfilePhoto($avatar, $uid, $cid, true);
1944 $fields = ['avatar' => $avatar, 'photo' => $photos[0], 'thumb' => $photos[1], 'micro' => $photos[2], 'avatar-date' => DateTimeFormat::utcNow()];
1945 DBA::update('contact', $fields, ['id' => $cid]);
1947 // Update the public contact (contact id = 0)
1949 $pcontact = DBA::selectFirst('contact', ['id'], ['nurl' => $contact['nurl'], 'uid' => 0]);
1950 if (DBA::isResult($pcontact)) {
1951 DBA::update('contact', $fields, ['id' => $pcontact['id']]);
1959 * Helper function for "updateFromProbe". Updates personal and public contact
1961 * @param integer $id contact id
1962 * @param integer $uid user id
1963 * @param string $url The profile URL of the contact
1964 * @param array $fields The fields that are updated
1966 * @throws \Exception
1968 private static function updateContact($id, $uid, $url, array $fields)
1970 if (!DBA::update('contact', $fields, ['id' => $id])) {
1971 Logger::info('Couldn\'t update contact.', ['id' => $id, 'fields' => $fields]);
1975 // Search for duplicated contacts and get rid of them
1976 if (self::removeDuplicates(Strings::normaliseLink($url), $uid) || ($uid != 0)) {
1980 // Update the corresponding gcontact entry
1981 GContact::updateFromPublicContactID($id);
1983 // Archive or unarchive the contact. We only need to do this for the public contact.
1984 // The archive/unarchive function will update the personal contacts by themselves.
1985 $contact = DBA::selectFirst('contact', [], ['id' => $id]);
1986 if (!DBA::isResult($contact)) {
1987 Logger::info('Couldn\'t select contact for archival.', ['id' => $id]);
1991 if (!empty($fields['success_update'])) {
1992 self::unmarkForArchival($contact);
1993 } elseif (!empty($fields['failure_update'])) {
1994 self::markForArchival($contact);
1997 $condition = ['self' => false, 'nurl' => Strings::normaliseLink($url), 'network' => Protocol::FEDERATED];
1999 // These contacts are sharing with us, we don't poll them.
2000 // This means that we don't set the update fields in "OnePoll.php".
2001 $condition['rel'] = self::SHARING;
2002 DBA::update('contact', $fields, $condition);
2004 unset($fields['last-update']);
2005 unset($fields['success_update']);
2006 unset($fields['failure_update']);
2008 if (empty($fields)) {
2012 // We are polling these contacts, so we mustn't set the update fields here.
2013 $condition['rel'] = [self::FOLLOWER, self::FRIEND];
2014 DBA::update('contact', $fields, $condition);
2018 * Remove duplicated contacts
2020 * @param string $nurl Normalised contact url
2021 * @param integer $uid User id
2023 * @throws \Exception
2025 public static function removeDuplicates(string $nurl, int $uid)
2027 $condition = ['nurl' => $nurl, 'uid' => $uid, 'deleted' => false, 'network' => Protocol::FEDERATED];
2028 $count = DBA::count('contact', $condition);
2033 $first_contact = DBA::selectFirst('contact', ['id', 'network'], $condition, ['order' => ['id']]);
2034 if (!DBA::isResult($first_contact)) {
2035 // Shouldn't happen - so we handle it
2039 $first = $first_contact['id'];
2040 Logger::info('Found duplicates', ['count' => $count, 'first' => $first, 'uid' => $uid, 'nurl' => $nurl]);
2041 if (($uid != 0 && ($first_contact['network'] == Protocol::DFRN))) {
2042 // Don't handle non public DFRN duplicates by now (legacy DFRN is very special because of the key handling)
2043 Logger::info('Not handling non public DFRN duplicate', ['uid' => $uid, 'nurl' => $nurl]);
2047 // Find all duplicates
2048 $condition = ["`nurl` = ? AND `uid` = ? AND `id` != ? AND NOT `self` AND NOT `deleted`", $nurl, $uid, $first];
2049 $duplicates = DBA::select('contact', ['id', 'network'], $condition);
2050 while ($duplicate = DBA::fetch($duplicates)) {
2051 if (!in_array($duplicate['network'], Protocol::FEDERATED)) {
2055 Worker::add(PRIORITY_HIGH, 'MergeContact', $first, $duplicate['id'], $uid);
2057 DBA::close($duplicates);
2058 Logger::info('Duplicates handled', ['uid' => $uid, 'nurl' => $nurl]);
2063 * @param integer $id contact id
2064 * @param string $network Optional network we are probing for
2065 * @param boolean $force Optional forcing of network probing (otherwise we use the cached data)
2067 * @throws HTTPException\InternalServerErrorException
2068 * @throws \ImagickException
2070 public static function updateFromProbe($id, $network = '', $force = false)
2073 Warning: Never ever fetch the public key via Probe::uri and write it into the contacts.
2074 This will reliably kill your communication with old Friendica contacts.
2077 // These fields aren't updated by this routine:
2078 // 'xmpp', 'sensitive'
2080 $fields = ['uid', 'avatar', 'name', 'nick', 'location', 'keywords', 'about',
2081 'unsearchable', 'url', 'addr', 'batch', 'notify', 'poll', 'request', 'confirm', 'poco',
2082 'network', 'alias', 'baseurl', 'gsid', 'forum', 'prv', 'contact-type', 'pubkey'];
2083 $contact = DBA::selectFirst('contact', $fields, ['id' => $id]);
2084 if (!DBA::isResult($contact)) {
2088 $uid = $contact['uid'];
2089 unset($contact['uid']);
2091 $pubkey = $contact['pubkey'];
2092 unset($contact['pubkey']);
2094 $contact['photo'] = $contact['avatar'];
2095 unset($contact['avatar']);
2097 $ret = Probe::uri($contact['url'], $network, $uid, !$force);
2099 $updated = DateTimeFormat::utcNow();
2101 // We must not try to update relay contacts via probe. They are no real contacts.
2102 // We check after the probing to be able to correct falsely detected contact types.
2103 if (($contact['contact-type'] == self::TYPE_RELAY) &&
2104 (!Strings::compareLink($ret['url'], $contact['url']) || in_array($ret['network'], [Protocol::FEED, Protocol::PHANTOM]))) {
2105 self::updateContact($id, $uid, $contact['url'], ['last-update' => $updated, 'success_update' => $updated]);
2106 Logger::info('Not updating relais', ['id' => $id, 'url' => $contact['url']]);
2110 // If Probe::uri fails the network code will be different ("feed" or "unkn")
2111 if (in_array($ret['network'], [Protocol::FEED, Protocol::PHANTOM]) && ($ret['network'] != $contact['network'])) {
2112 if ($force && ($uid == 0)) {
2113 self::updateContact($id, $uid, $ret['url'], ['last-update' => $updated, 'failure_update' => $updated]);
2118 if (isset($ret['hide']) && is_bool($ret['hide'])) {
2119 $ret['unsearchable'] = $ret['hide'];
2122 if (isset($ret['account-type']) && is_int($ret['account-type'])) {
2123 $ret['forum'] = false;
2124 $ret['prv'] = false;
2125 $ret['contact-type'] = $ret['account-type'];
2126 if ($ret['contact-type'] == User::ACCOUNT_TYPE_COMMUNITY) {
2127 $apcontact = APContact::getByURL($ret['url'], false);
2128 if (isset($apcontact['manually-approve'])) {
2129 $ret['forum'] = (bool)!$apcontact['manually-approve'];
2130 $ret['prv'] = (bool)!$ret['forum'];
2135 $new_pubkey = $ret['pubkey'];
2139 // make sure to not overwrite existing values with blank entries except some technical fields
2140 $keep = ['batch', 'notify', 'poll', 'request', 'confirm', 'poco', 'baseurl'];
2141 foreach ($ret as $key => $val) {
2142 if (!array_key_exists($key, $contact)) {
2144 } elseif (($contact[$key] != '') && ($val === '') && !is_bool($ret[$key]) && !in_array($key, $keep)) {
2145 $ret[$key] = $contact[$key];
2146 } elseif ($ret[$key] != $contact[$key]) {
2151 if (!empty($ret['photo']) && ($ret['network'] != Protocol::FEED)) {
2152 self::updateAvatar($ret['photo'], $uid, $id, $update || $force);
2157 self::updateContact($id, $uid, $ret['url'], ['last-update' => $updated, 'success_update' => $updated]);
2160 // Update the public contact
2162 self::updateFromProbeByURL($ret['url']);
2168 $ret['nurl'] = Strings::normaliseLink($ret['url']);
2169 $ret['updated'] = $updated;
2171 // Only fill the pubkey if it had been empty before. We have to prevent identity theft.
2172 if (empty($pubkey) && !empty($new_pubkey)) {
2173 $ret['pubkey'] = $new_pubkey;
2176 if (($ret['addr'] != $contact['addr']) || (!empty($ret['alias']) && ($ret['alias'] != $contact['alias']))) {
2177 $ret['uri-date'] = DateTimeFormat::utcNow();
2180 if (($ret['name'] != $contact['name']) || ($ret['nick'] != $contact['nick'])) {
2181 $ret['name-date'] = $updated;
2184 if ($force && ($uid == 0)) {
2185 $ret['last-update'] = $updated;
2186 $ret['success_update'] = $updated;
2189 unset($ret['photo']);
2191 self::updateContact($id, $uid, $ret['url'], $ret);
2196 public static function updateFromProbeByURL($url, $force = false)
2198 $id = self::getIdForURL($url);
2204 self::updateFromProbe($id, '', $force);
2210 * Detects if a given contact array belongs to a legacy DFRN connection
2212 * @param array $contact
2215 public static function isLegacyDFRNContact($contact)
2217 // Newer Friendica contacts are connected via AP, then these fields aren't set
2218 return !empty($contact['dfrn-id']) || !empty($contact['issued-id']);
2222 * Detects the communication protocol for a given contact url.
2223 * This is used to detect Friendica contacts that we can communicate via AP.
2225 * @param string $url contact url
2226 * @param string $network Network of that contact
2227 * @return string with protocol
2229 public static function getProtocol($url, $network)
2231 if ($network != Protocol::DFRN) {
2235 $apcontact = APContact::getByURL($url);
2236 if (!empty($apcontact) && !empty($apcontact['generator'])) {
2237 return Protocol::ACTIVITYPUB;
2244 * Takes a $uid and a url/handle and adds a new contact
2246 * Currently if the contact is DFRN, interactive needs to be true, to redirect to the
2247 * dfrn_request page.
2249 * Otherwise this can be used to bulk add StatusNet contacts, Twitter contacts, etc.
2252 * $return['success'] boolean true if successful
2253 * $return['message'] error text if success is false.
2255 * Takes a $uid and a url/handle and adds a new contact
2257 * @param string $url
2258 * @param bool $interactive
2259 * @param string $network
2261 * @throws HTTPException\InternalServerErrorException
2262 * @throws \ImagickException
2264 public static function createFromProbe($uid, $url, $interactive = false, $network = '')
2266 $result = ['cid' => -1, 'success' => false, 'message' => ''];
2270 // remove ajax junk, e.g. Twitter
2271 $url = str_replace('/#!/', '/', $url);
2273 if (!Network::isUrlAllowed($url)) {
2274 $result['message'] = DI::l10n()->t('Disallowed profile URL.');
2278 if (Network::isUrlBlocked($url)) {
2279 $result['message'] = DI::l10n()->t('Blocked domain');
2284 $result['message'] = DI::l10n()->t('Connect URL missing.');
2288 $arr = ['url' => $url, 'contact' => []];
2290 Hook::callAll('follow', $arr);
2293 $result['message'] = DI::l10n()->t('The contact could not be added. Please check the relevant network credentials in your Settings -> Social Networks page.');
2297 if (!empty($arr['contact']['name'])) {
2298 $ret = $arr['contact'];
2300 $ret = Probe::uri($url, $network, $uid, false);
2303 if (($network != '') && ($ret['network'] != $network)) {
2304 Logger::log('Expected network ' . $network . ' does not match actual network ' . $ret['network']);
2308 // check if we already have a contact
2309 // the poll url is more reliable than the profile url, as we may have
2310 // indirect links or webfinger links
2312 $condition = ['uid' => $uid, 'poll' => [$ret['poll'], Strings::normaliseLink($ret['poll'])], 'network' => $ret['network'], 'pending' => false];
2313 $contact = DBA::selectFirst('contact', ['id', 'rel'], $condition);
2314 if (!DBA::isResult($contact)) {
2315 $condition = ['uid' => $uid, 'nurl' => Strings::normaliseLink($url), 'network' => $ret['network'], 'pending' => false];
2316 $contact = DBA::selectFirst('contact', ['id', 'rel'], $condition);
2319 $protocol = self::getProtocol($url, $ret['network']);
2321 if (($protocol === Protocol::DFRN) && !DBA::isResult($contact)) {
2323 if (strlen(DI::baseUrl()->getUrlPath())) {
2324 $myaddr = bin2hex(DI::baseUrl() . '/profile/' . $a->user['nickname']);
2326 $myaddr = bin2hex($a->user['nickname'] . '@' . DI::baseUrl()->getHostname());
2329 DI::baseUrl()->redirect($ret['request'] . "&addr=$myaddr");
2333 } elseif (DI::config()->get('system', 'dfrn_only') && ($ret['network'] != Protocol::DFRN)) {
2334 $result['message'] = DI::l10n()->t('This site is not configured to allow communications with other networks.') . EOL;
2335 $result['message'] .= DI::l10n()->t('No compatible communication protocols or feeds were discovered.') . EOL;
2339 // This extra param just confuses things, remove it
2340 if ($protocol === Protocol::DIASPORA) {
2341 $ret['url'] = str_replace('?absolute=true', '', $ret['url']);
2344 // do we have enough information?
2345 if (empty($ret['name']) || empty($ret['poll']) || (empty($ret['url']) && empty($ret['addr']))) {
2346 $result['message'] .= DI::l10n()->t('The profile address specified does not provide adequate information.') . EOL;
2347 if (empty($ret['poll'])) {
2348 $result['message'] .= DI::l10n()->t('No compatible communication protocols or feeds were discovered.') . EOL;
2350 if (empty($ret['name'])) {
2351 $result['message'] .= DI::l10n()->t('An author or name was not found.') . EOL;
2353 if (empty($ret['url'])) {
2354 $result['message'] .= DI::l10n()->t('No browser URL could be matched to this address.') . EOL;
2356 if (strpos($url, '@') !== false) {
2357 $result['message'] .= DI::l10n()->t('Unable to match @-style Identity Address with a known protocol or email contact.') . EOL;
2358 $result['message'] .= DI::l10n()->t('Use mailto: in front of address to force email check.') . EOL;
2363 if ($protocol === Protocol::OSTATUS && DI::config()->get('system', 'ostatus_disabled')) {
2364 $result['message'] .= DI::l10n()->t('The profile address specified belongs to a network which has been disabled on this site.') . EOL;
2365 $ret['notify'] = '';
2368 if (!$ret['notify']) {
2369 $result['message'] .= DI::l10n()->t('Limited profile. This person will be unable to receive direct/personal notifications from you.') . EOL;
2372 $writeable = ((($protocol === Protocol::OSTATUS) && ($ret['notify'])) ? 1 : 0);
2374 $subhub = (($protocol === Protocol::OSTATUS) ? true : false);
2376 $hidden = (($protocol === Protocol::MAIL) ? 1 : 0);
2379 if ($protocol == Protocol::ACTIVITYPUB) {
2380 $apcontact = APContact::getByURL($url, false);
2381 if (isset($apcontact['manually-approve'])) {
2382 $pending = (bool)$apcontact['manually-approve'];
2386 if (in_array($protocol, [Protocol::MAIL, Protocol::DIASPORA, Protocol::ACTIVITYPUB])) {
2390 if (DBA::isResult($contact)) {
2392 $new_relation = (($contact['rel'] == self::FOLLOWER) ? self::FRIEND : self::SHARING);
2394 $fields = ['rel' => $new_relation, 'subhub' => $subhub, 'readonly' => false];
2395 DBA::update('contact', $fields, ['id' => $contact['id']]);
2397 $new_relation = (in_array($protocol, [Protocol::MAIL]) ? self::FRIEND : self::SHARING);
2399 // create contact record
2402 'created' => DateTimeFormat::utcNow(),
2403 'url' => $ret['url'],
2404 'nurl' => Strings::normaliseLink($ret['url']),
2405 'addr' => $ret['addr'],
2406 'alias' => $ret['alias'],
2407 'batch' => $ret['batch'],
2408 'notify' => $ret['notify'],
2409 'poll' => $ret['poll'],
2410 'poco' => $ret['poco'],
2411 'name' => $ret['name'],
2412 'nick' => $ret['nick'],
2413 'network' => $ret['network'],
2414 'baseurl' => $ret['baseurl'],
2415 'gsid' => $ret['gsid'] ?? null,
2416 'protocol' => $protocol,
2417 'pubkey' => $ret['pubkey'],
2418 'rel' => $new_relation,
2419 'priority'=> $ret['priority'],
2420 'writable'=> $writeable,
2421 'hidden' => $hidden,
2424 'pending' => $pending,
2429 $contact = DBA::selectFirst('contact', [], ['url' => $ret['url'], 'network' => $ret['network'], 'uid' => $uid]);
2430 if (!DBA::isResult($contact)) {
2431 $result['message'] .= DI::l10n()->t('Unable to retrieve contact information.') . EOL;
2435 $contact_id = $contact['id'];
2436 $result['cid'] = $contact_id;
2438 Group::addMember(User::getDefaultGroup($uid, $contact["network"]), $contact_id);
2440 // Update the avatar
2441 self::updateAvatar($ret['photo'], $uid, $contact_id);
2443 // pull feed and consume it, which should subscribe to the hub.
2445 Worker::add(PRIORITY_HIGH, "OnePoll", $contact_id, "force");
2447 $owner = User::getOwnerDataById($uid);
2449 if (DBA::isResult($owner)) {
2450 if (in_array($protocol, [Protocol::OSTATUS, Protocol::DFRN])) {
2451 // create a follow slap
2453 $item['verb'] = Activity::FOLLOW;
2454 $item['follow'] = $contact["url"];
2456 $item['title'] = '';
2458 $item['uri-id'] = 0;
2459 $item['attach'] = '';
2461 $slap = OStatus::salmon($item, $owner);
2463 if (!empty($contact['notify'])) {
2464 Salmon::slapper($owner, $contact['notify'], $slap);
2466 } elseif ($protocol == Protocol::DIASPORA) {
2467 $ret = Diaspora::sendShare($a->user, $contact);
2468 Logger::log('share returns: ' . $ret);
2469 } elseif ($protocol == Protocol::ACTIVITYPUB) {
2470 $activity_id = ActivityPub\Transmitter::activityIDFromContact($contact_id);
2471 if (empty($activity_id)) {
2472 // This really should never happen
2476 $ret = ActivityPub\Transmitter::sendActivity('Follow', $contact['url'], $uid, $activity_id);
2477 Logger::log('Follow returns: ' . $ret);
2481 $result['success'] = true;
2486 * Updated contact's SSL policy
2488 * @param array $contact Contact array
2489 * @param string $new_policy New policy, valid: self,full
2491 * @return array Contact array with updated values
2492 * @throws \Exception
2494 public static function updateSslPolicy(array $contact, $new_policy)
2496 $ssl_changed = false;
2497 if ((intval($new_policy) == BaseURL::SSL_POLICY_SELFSIGN || $new_policy === 'self') && strstr($contact['url'], 'https:')) {
2498 $ssl_changed = true;
2499 $contact['url'] = str_replace('https:', 'http:', $contact['url']);
2500 $contact['request'] = str_replace('https:', 'http:', $contact['request']);
2501 $contact['notify'] = str_replace('https:', 'http:', $contact['notify']);
2502 $contact['poll'] = str_replace('https:', 'http:', $contact['poll']);
2503 $contact['confirm'] = str_replace('https:', 'http:', $contact['confirm']);
2504 $contact['poco'] = str_replace('https:', 'http:', $contact['poco']);
2507 if ((intval($new_policy) == BaseURL::SSL_POLICY_FULL || $new_policy === 'full') && strstr($contact['url'], 'http:')) {
2508 $ssl_changed = true;
2509 $contact['url'] = str_replace('http:', 'https:', $contact['url']);
2510 $contact['request'] = str_replace('http:', 'https:', $contact['request']);
2511 $contact['notify'] = str_replace('http:', 'https:', $contact['notify']);
2512 $contact['poll'] = str_replace('http:', 'https:', $contact['poll']);
2513 $contact['confirm'] = str_replace('http:', 'https:', $contact['confirm']);
2514 $contact['poco'] = str_replace('http:', 'https:', $contact['poco']);
2518 $fields = ['url' => $contact['url'], 'request' => $contact['request'],
2519 'notify' => $contact['notify'], 'poll' => $contact['poll'],
2520 'confirm' => $contact['confirm'], 'poco' => $contact['poco']];
2521 DBA::update('contact', $fields, ['id' => $contact['id']]);
2528 * @param array $importer Owner (local user) data
2529 * @param array $contact Existing owner-specific contact data we want to expand the relationship with. Optional.
2530 * @param array $datarray An item-like array with at least the 'author-id' and 'author-url' keys for the contact. Mandatory.
2531 * @param bool $sharing True: Contact is now sharing with Owner; False: Contact is now following Owner (default)
2532 * @param string $note Introduction additional message
2533 * @return bool|null True: follow request is accepted; False: relationship is rejected; Null: relationship is pending
2534 * @throws HTTPException\InternalServerErrorException
2535 * @throws \ImagickException
2537 public static function addRelationship(array $importer, array $contact, array $datarray, $sharing = false, $note = '')
2539 // Should always be set
2540 if (empty($datarray['author-id'])) {
2544 $fields = ['url', 'name', 'nick', 'avatar', 'photo', 'network', 'blocked'];
2545 $pub_contact = DBA::selectFirst('contact', $fields, ['id' => $datarray['author-id']]);
2546 if (!DBA::isResult($pub_contact)) {
2547 // Should never happen
2551 // Contact is blocked at node-level
2552 if (self::isBlocked($datarray['author-id'])) {
2556 $url = ($datarray['author-link'] ?? '') ?: $pub_contact['url'];
2557 $name = $pub_contact['name'];
2558 $photo = ($pub_contact['avatar'] ?? '') ?: $pub_contact["photo"];
2559 $nick = $pub_contact['nick'];
2560 $network = $pub_contact['network'];
2562 // Ensure that we don't create a new contact when there already is one
2563 $cid = self::getIdForURL($url, $importer['uid']);
2565 $contact = DBA::selectFirst('contact', [], ['id' => $cid]);
2568 if (!empty($contact)) {
2569 if (!empty($contact['pending'])) {
2570 Logger::info('Pending contact request already exists.', ['url' => $url, 'uid' => $importer['uid']]);
2574 // Contact is blocked at user-level
2575 if (!empty($contact['id']) && !empty($importer['id']) &&
2576 self::isBlockedByUser($contact['id'], $importer['id'])) {
2580 // Make sure that the existing contact isn't archived
2581 self::unmarkForArchival($contact);
2583 if (($contact['rel'] == self::SHARING)
2584 || ($sharing && $contact['rel'] == self::FOLLOWER)) {
2585 DBA::update('contact', ['rel' => self::FRIEND, 'writable' => true, 'pending' => false],
2586 ['id' => $contact['id'], 'uid' => $importer['uid']]);
2589 // Ensure to always have the correct network type, independent from the connection request method
2590 self::updateFromProbe($contact['id'], '', true);
2594 // send email notification to owner?
2595 if (DBA::exists('contact', ['nurl' => Strings::normaliseLink($url), 'uid' => $importer['uid'], 'pending' => true])) {
2596 Logger::log('ignoring duplicated connection request from pending contact ' . $url);
2600 // create contact record
2601 DBA::insert('contact', [
2602 'uid' => $importer['uid'],
2603 'created' => DateTimeFormat::utcNow(),
2605 'nurl' => Strings::normaliseLink($url),
2609 'network' => $network,
2610 'rel' => self::FOLLOWER,
2617 $contact_id = DBA::lastInsertId();
2619 // Ensure to always have the correct network type, independent from the connection request method
2620 self::updateFromProbe($contact_id, '', true);
2622 Contact::updateAvatar($photo, $importer["uid"], $contact_id, true);
2624 $contact_record = DBA::selectFirst('contact', ['id', 'network', 'name', 'url', 'photo'], ['id' => $contact_id]);
2626 /// @TODO Encapsulate this into a function/method
2627 $fields = ['uid', 'username', 'email', 'page-flags', 'notify-flags', 'language'];
2628 $user = DBA::selectFirst('user', $fields, ['uid' => $importer['uid']]);
2629 if (DBA::isResult($user) && !in_array($user['page-flags'], [User::PAGE_FLAGS_SOAPBOX, User::PAGE_FLAGS_FREELOVE, User::PAGE_FLAGS_COMMUNITY])) {
2630 // create notification
2631 $hash = Strings::getRandomHex();
2633 if (is_array($contact_record)) {
2634 DBA::insert('intro', ['uid' => $importer['uid'], 'contact-id' => $contact_record['id'],
2635 'blocked' => false, 'knowyou' => false, 'note' => $note,
2636 'hash' => $hash, 'datetime' => DateTimeFormat::utcNow()]);
2639 Group::addMember(User::getDefaultGroup($importer['uid'], $contact_record["network"]), $contact_record['id']);
2641 if (($user['notify-flags'] & Type::INTRO) &&
2642 in_array($user['page-flags'], [User::PAGE_FLAGS_NORMAL])) {
2645 'type' => Type::INTRO,
2646 'notify_flags' => $user['notify-flags'],
2647 'language' => $user['language'],
2648 'to_name' => $user['username'],
2649 'to_email' => $user['email'],
2650 'uid' => $user['uid'],
2651 'link' => DI::baseUrl() . '/notifications/intros',
2652 'source_name' => ((strlen(stripslashes($contact_record['name']))) ? stripslashes($contact_record['name']) : DI::l10n()->t('[Name Withheld]')),
2653 'source_link' => $contact_record['url'],
2654 'source_photo' => $contact_record['photo'],
2655 'verb' => ($sharing ? Activity::FRIEND : Activity::FOLLOW),
2659 } elseif (DBA::isResult($user) && in_array($user['page-flags'], [User::PAGE_FLAGS_SOAPBOX, User::PAGE_FLAGS_FREELOVE, User::PAGE_FLAGS_COMMUNITY])) {
2660 if (($user['page-flags'] == User::PAGE_FLAGS_FREELOVE) && ($network != Protocol::DIASPORA)) {
2661 self::createFromProbe($importer['uid'], $url, false, $network);
2664 $condition = ['uid' => $importer['uid'], 'url' => $url, 'pending' => true];
2665 $fields = ['pending' => false];
2666 if ($user['page-flags'] == User::PAGE_FLAGS_FREELOVE) {
2667 $fields['rel'] = Contact::FRIEND;
2670 DBA::update('contact', $fields, $condition);
2679 public static function removeFollower($importer, $contact, array $datarray = [], $item = "")
2681 if (($contact['rel'] == self::FRIEND) || ($contact['rel'] == self::SHARING)) {
2682 DBA::update('contact', ['rel' => self::SHARING], ['id' => $contact['id']]);
2684 Contact::remove($contact['id']);
2688 public static function removeSharer($importer, $contact, array $datarray = [], $item = "")
2690 if (($contact['rel'] == self::FRIEND) || ($contact['rel'] == self::FOLLOWER)) {
2691 DBA::update('contact', ['rel' => self::FOLLOWER], ['id' => $contact['id']]);
2693 Contact::remove($contact['id']);
2698 * Create a birthday event.
2700 * Update the year and the birthday.
2702 public static function updateBirthdays()
2706 AND `bd` > "0001-01-01"
2707 AND SUBSTRING(`bd`, 1, 4) != `bdyear`
2708 AND (`contact`.`rel` = ? OR `contact`.`rel` = ?)
2709 AND NOT `contact`.`pending`
2710 AND NOT `contact`.`hidden`
2711 AND NOT `contact`.`blocked`
2712 AND NOT `contact`.`archive`
2713 AND NOT `contact`.`deleted`',
2718 $contacts = DBA::select('contact', ['id', 'uid', 'name', 'url', 'bd'], $condition);
2720 while ($contact = DBA::fetch($contacts)) {
2721 Logger::log('update_contact_birthday: ' . $contact['bd']);
2723 $nextbd = DateTimeFormat::utcNow('Y') . substr($contact['bd'], 4);
2725 if (Event::createBirthday($contact, $nextbd)) {
2729 ['bdyear' => substr($nextbd, 0, 4), 'bd' => $nextbd],
2730 ['id' => $contact['id']]
2734 DBA::close($contacts);
2738 * Remove the unavailable contact ids from the provided list
2740 * @param array $contact_ids Contact id list
2742 * @throws \Exception
2744 public static function pruneUnavailable(array $contact_ids)
2746 if (empty($contact_ids)) {
2750 $contacts = Contact::selectToArray(['id'], [
2751 'id' => $contact_ids,
2757 return array_column($contacts, 'id');
2761 * Returns a magic link to authenticate remote visitors
2763 * @todo check if the return is either a fully qualified URL or a relative path to Friendica basedir
2765 * @param string $contact_url The address of the target contact profile
2766 * @param string $url An url that we will be redirected to after the authentication
2768 * @return string with "redir" link
2769 * @throws HTTPException\InternalServerErrorException
2770 * @throws \ImagickException
2772 public static function magicLink($contact_url, $url = '')
2774 if (!Session::isAuthenticated()) {
2775 return $url ?: $contact_url; // Equivalent to: ($url != '') ? $url : $contact_url;
2778 $data = self::getProbeDataFromDatabase($contact_url);
2780 return $url ?: $contact_url; // Equivalent to: ($url != '') ? $url : $contact_url;
2783 // Prevents endless loop in case only a non-public contact exists for the contact URL
2784 unset($data['uid']);
2786 return self::magicLinkByContact($data, $url ?: $contact_url);
2790 * Returns a magic link to authenticate remote visitors
2792 * @param integer $cid The contact id of the target contact profile
2793 * @param string $url An url that we will be redirected to after the authentication
2795 * @return string with "redir" link
2796 * @throws HTTPException\InternalServerErrorException
2797 * @throws \ImagickException
2799 public static function magicLinkbyId($cid, $url = '')
2801 $contact = DBA::selectFirst('contact', ['id', 'network', 'url', 'uid'], ['id' => $cid]);
2803 return self::magicLinkByContact($contact, $url);
2807 * Returns a magic link to authenticate remote visitors
2809 * @param array $contact The contact array with "uid", "network" and "url"
2810 * @param string $url An url that we will be redirected to after the authentication
2812 * @return string with "redir" link
2813 * @throws HTTPException\InternalServerErrorException
2814 * @throws \ImagickException
2816 public static function magicLinkByContact($contact, $url = '')
2818 $destination = $url ?: $contact['url']; // Equivalent to ($url != '') ? $url : $contact['url'];
2820 if (!Session::isAuthenticated() || ($contact['network'] != Protocol::DFRN)) {
2821 return $destination;
2824 // Only redirections to the same host do make sense
2825 if (($url != '') && (parse_url($url, PHP_URL_HOST) != parse_url($contact['url'], PHP_URL_HOST))) {
2829 if (!empty($contact['uid'])) {
2830 return self::magicLink($contact['url'], $url);
2833 if (empty($contact['id'])) {
2834 return $destination;
2837 $redirect = 'redir/' . $contact['id'];
2839 if (($url != '') && !Strings::compareLink($contact['url'], $url)) {
2840 $redirect .= '?url=' . $url;
2847 * Remove a contact from all groups
2849 * @param integer $contact_id
2851 * @return boolean Success
2853 public static function removeFromGroups($contact_id)
2855 return DBA::delete('group_member', ['contact-id' => $contact_id]);
2859 * Is the contact a forum?
2861 * @param integer $contactid ID of the contact
2863 * @return boolean "true" if it is a forum
2865 public static function isForum($contactid)
2867 $fields = ['forum', 'prv'];
2868 $condition = ['id' => $contactid];
2869 $contact = DBA::selectFirst('contact', $fields, $condition);
2870 if (!DBA::isResult($contact)) {
2875 return ($contact['forum'] || $contact['prv']);
2879 * Can the remote contact receive private messages?
2881 * @param array $contact
2884 public static function canReceivePrivateMessages(array $contact)
2886 $protocol = $contact['network'] ?? $contact['protocol'] ?? Protocol::PHANTOM;
2887 $self = $contact['self'] ?? false;
2889 return in_array($protocol, [Protocol::DFRN, Protocol::DIASPORA, Protocol::ACTIVITYPUB]) && !$self;