3 * @file src/Model/Contact.php
5 namespace Friendica\Model;
7 use Friendica\BaseObject;
8 use Friendica\Content\Pager;
9 use Friendica\Core\Addon;
10 use Friendica\Core\Config;
11 use Friendica\Core\Hook;
12 use Friendica\Core\L10n;
13 use Friendica\Core\Logger;
14 use Friendica\Core\Protocol;
15 use Friendica\Core\System;
16 use Friendica\Core\Worker;
17 use Friendica\Database\DBA;
18 use Friendica\Network\Probe;
19 use Friendica\Object\Image;
20 use Friendica\Protocol\ActivityPub;
21 use Friendica\Protocol\DFRN;
22 use Friendica\Protocol\Diaspora;
23 use Friendica\Protocol\OStatus;
24 use Friendica\Protocol\PortableContact;
25 use Friendica\Protocol\Salmon;
26 use Friendica\Util\DateTimeFormat;
27 use Friendica\Util\Network;
28 use Friendica\Util\Strings;
31 * @brief functions for interacting with a contact
33 class Contact extends BaseObject
36 * @name page/profile types
38 * PAGE_NORMAL is a typical personal profile account
39 * PAGE_SOAPBOX automatically approves all friend requests as Contact::SHARING, (readonly)
40 * PAGE_COMMUNITY automatically approves all friend requests as Contact::SHARING, but with
41 * write access to wall and comments (no email and not included in page owner's ACL lists)
42 * PAGE_FREELOVE automatically approves all friend requests as full friends (Contact::FRIEND).
46 const PAGE_NORMAL = 0;
47 const PAGE_SOAPBOX = 1;
48 const PAGE_COMMUNITY = 2;
49 const PAGE_FREELOVE = 3;
51 const PAGE_PRVGROUP = 5;
59 * ACCOUNT_TYPE_PERSON - the account belongs to a person
60 * Associated page types: PAGE_NORMAL, PAGE_SOAPBOX, PAGE_FREELOVE
62 * ACCOUNT_TYPE_ORGANISATION - the account belongs to an organisation
63 * Associated page type: PAGE_SOAPBOX
65 * ACCOUNT_TYPE_NEWS - the account is a news reflector
66 * Associated page type: PAGE_SOAPBOX
68 * ACCOUNT_TYPE_COMMUNITY - the account is community forum
69 * Associated page types: PAGE_COMMUNITY, PAGE_PRVGROUP
71 * ACCOUNT_TYPE_RELAY - the account is a relay
72 * This will only be assigned to contacts, not to user accounts
75 const ACCOUNT_TYPE_PERSON = 0;
76 const ACCOUNT_TYPE_ORGANISATION = 1;
77 const ACCOUNT_TYPE_NEWS = 2;
78 const ACCOUNT_TYPE_COMMUNITY = 3;
79 const ACCOUNT_TYPE_RELAY = 4;
98 * @brief Tests if the given contact is a follower
100 * @param int $cid Either public contact id or user's contact id
101 * @param int $uid User ID
103 * @return boolean is the contact id a follower?
105 public static function isFollower($cid, $uid)
107 if (self::isBlockedByUser($cid, $uid)) {
111 $cdata = self::getPublicAndUserContacID($cid, $uid);
112 if (empty($cdata['user'])) {
116 $condition = ['id' => $cdata['user'], 'rel' => [self::FOLLOWER, self::FRIEND]];
117 return DBA::exists('contact', $condition);
121 * @brief Get the basepath for a given contact link
122 * @todo Add functionality to store this value in the contact table
124 * @param string $url The contact link
126 * @return string basepath
128 public static function getBasepath($url)
130 $data = Probe::uri($url);
131 if (!empty($data['baseurl'])) {
132 return $data['baseurl'];
135 // When we can't probe the server, we use some ugly function that does some pattern matching
136 return PortableContact::detectServer($url);
140 * @brief Returns the contact id for the user and the public contact id for a given contact id
142 * @param int $cid Either public contact id or user's contact id
143 * @param int $uid User ID
145 * @return array with public and user's contact id
147 public static function getPublicAndUserContacID($cid, $uid)
149 if (empty($uid) || empty($cid)) {
153 $contact = DBA::selectFirst('contact', ['id', 'uid', 'url'], ['id' => $cid]);
154 if (!DBA::isResult($contact)) {
158 // We quit when the user id don't match the user id of the provided contact
159 if (($contact['uid'] != $uid) && ($contact['uid'] != 0)) {
163 if ($contact['uid'] != 0) {
164 $pcid = Contact::getIdForURL($contact['url'], 0, true, ['url' => $contact['url']]);
168 $ucid = $contact['id'];
170 $pcid = $contact['id'];
171 $ucid = Contact::getIdForURL($contact['url'], $uid, true);
174 return ['public' => $pcid, 'user' => $ucid];
178 * @brief Block contact id for user id
180 * @param int $cid Either public contact id or user's contact id
181 * @param int $uid User ID
182 * @param boolean $blocked Is the contact blocked or unblocked?
184 public static function setBlockedForUser($cid, $uid, $blocked)
186 $cdata = self::getPublicAndUserContacID($cid, $uid);
191 if ($cdata['user'] != 0) {
192 DBA::update('contact', ['blocked' => $blocked], ['id' => $cdata['user'], 'pending' => false]);
195 DBA::update('user-contact', ['blocked' => $blocked], ['cid' => $cdata['public'], 'uid' => $uid], true);
199 * @brief Returns "block" state for contact id and user id
201 * @param int $cid Either public contact id or user's contact id
202 * @param int $uid User ID
204 * @return boolean is the contact id blocked for the given user?
206 public static function isBlockedByUser($cid, $uid)
208 $cdata = self::getPublicAndUserContacID($cid, $uid);
213 $public_blocked = false;
215 if (!empty($cdata['public'])) {
216 $public_contact = DBA::selectFirst('user-contact', ['blocked'], ['cid' => $cdata['public'], 'uid' => $uid]);
217 if (DBA::isResult($public_contact)) {
218 $public_blocked = $public_contact['blocked'];
222 $user_blocked = $public_blocked;
224 if (!empty($cdata['user'])) {
225 $user_contact = DBA::selectFirst('contact', ['blocked'], ['id' => $cdata['user'], 'pending' => false]);
226 if (DBA::isResult($user_contact)) {
227 $user_blocked = $user_contact['blocked'];
231 if ($user_blocked != $public_blocked) {
232 DBA::update('user-contact', ['blocked' => $user_blocked], ['cid' => $cdata['public'], 'uid' => $uid], true);
235 return $user_blocked;
239 * @brief Ignore contact id for user id
241 * @param int $cid Either public contact id or user's contact id
242 * @param int $uid User ID
243 * @param boolean $ignored Is the contact ignored or unignored?
245 public static function setIgnoredForUser($cid, $uid, $ignored)
247 $cdata = self::getPublicAndUserContacID($cid, $uid);
252 if ($cdata['user'] != 0) {
253 DBA::update('contact', ['readonly' => $ignored], ['id' => $cdata['user'], 'pending' => false]);
256 DBA::update('user-contact', ['ignored' => $ignored], ['cid' => $cdata['public'], 'uid' => $uid], true);
260 * @brief Returns "ignore" state for contact id and user id
262 * @param int $cid Either public contact id or user's contact id
263 * @param int $uid User ID
265 * @return boolean is the contact id ignored for the given user?
267 public static function isIgnoredByUser($cid, $uid)
269 $cdata = self::getPublicAndUserContacID($cid, $uid);
274 $public_ignored = false;
276 if (!empty($cdata['public'])) {
277 $public_contact = DBA::selectFirst('user-contact', ['ignored'], ['cid' => $cdata['public'], 'uid' => $uid]);
278 if (DBA::isResult($public_contact)) {
279 $public_ignored = $public_contact['ignored'];
283 $user_ignored = $public_ignored;
285 if (!empty($cdata['user'])) {
286 $user_contact = DBA::selectFirst('contact', ['readonly'], ['id' => $cdata['user'], 'pending' => false]);
287 if (DBA::isResult($user_contact)) {
288 $user_ignored = $user_contact['readonly'];
292 if ($user_ignored != $public_ignored) {
293 DBA::update('user-contact', ['ignored' => $user_ignored], ['cid' => $cdata['public'], 'uid' => $uid], true);
296 return $user_ignored;
300 * @brief Set "collapsed" for contact id and user id
302 * @param int $cid Either public contact id or user's contact id
303 * @param int $uid User ID
304 * @param boolean $collapsed are the contact's posts collapsed or uncollapsed?
306 public static function setCollapsedForUser($cid, $uid, $collapsed)
308 $cdata = self::getPublicAndUserContacID($cid, $uid);
313 DBA::update('user-contact', ['collapsed' => $collapsed], ['cid' => $cdata['public'], 'uid' => $uid], true);
317 * @brief Returns "collapsed" state for contact id and user id
319 * @param int $cid Either public contact id or user's contact id
320 * @param int $uid User ID
322 * @return boolean is the contact id blocked for the given user?
324 public static function isCollapsedByUser($cid, $uid)
326 $cdata = self::getPublicAndUserContacID($cid, $uid);
333 if (!empty($cdata['public'])) {
334 $public_contact = DBA::selectFirst('user-contact', ['collapsed'], ['cid' => $cdata['public'], 'uid' => $uid]);
335 if (DBA::isResult($public_contact)) {
336 $collapsed = $public_contact['collapsed'];
344 * @brief Returns a list of contacts belonging in a group
349 public static function getByGroupId($gid)
354 $stmt = DBA::p('SELECT `group_member`.`contact-id`, `contact`.*
356 INNER JOIN `group_member`
357 ON `contact`.`id` = `group_member`.`contact-id`
359 AND `contact`.`uid` = ?
360 AND NOT `contact`.`self`
361 AND NOT `contact`.`deleted`
362 AND NOT `contact`.`blocked`
363 AND NOT `contact`.`pending`
364 ORDER BY `contact`.`name` ASC',
369 if (DBA::isResult($stmt)) {
370 $return = DBA::toArray($stmt);
378 * @brief Returns the count of OStatus contacts in a group
383 public static function getOStatusCountByGroupId($gid)
387 $contacts = DBA::fetchFirst('SELECT COUNT(*) AS `count`
389 INNER JOIN `group_member`
390 ON `contact`.`id` = `group_member`.`contact-id`
392 AND `contact`.`uid` = ?
393 AND `contact`.`network` = ?
394 AND `contact`.`notify` != ""',
399 $return = $contacts['count'];
406 * Creates the self-contact for the provided user id
409 * @return bool Operation success
411 public static function createSelfFromUserId($uid)
413 // Only create the entry if it doesn't exist yet
414 if (DBA::exists('contact', ['uid' => $uid, 'self' => true])) {
418 $user = DBA::selectFirst('user', ['uid', 'username', 'nickname'], ['uid' => $uid]);
419 if (!DBA::isResult($user)) {
423 $return = DBA::insert('contact', [
424 'uid' => $user['uid'],
425 'created' => DateTimeFormat::utcNow(),
427 'name' => $user['username'],
428 'nick' => $user['nickname'],
429 'photo' => System::baseUrl() . '/photo/profile/' . $user['uid'] . '.jpg',
430 'thumb' => System::baseUrl() . '/photo/avatar/' . $user['uid'] . '.jpg',
431 'micro' => System::baseUrl() . '/photo/micro/' . $user['uid'] . '.jpg',
434 'url' => System::baseUrl() . '/profile/' . $user['nickname'],
435 'nurl' => Strings::normaliseLink(System::baseUrl() . '/profile/' . $user['nickname']),
436 'addr' => $user['nickname'] . '@' . substr(System::baseUrl(), strpos(System::baseUrl(), '://') + 3),
437 'request' => System::baseUrl() . '/dfrn_request/' . $user['nickname'],
438 'notify' => System::baseUrl() . '/dfrn_notify/' . $user['nickname'],
439 'poll' => System::baseUrl() . '/dfrn_poll/' . $user['nickname'],
440 'confirm' => System::baseUrl() . '/dfrn_confirm/' . $user['nickname'],
441 'poco' => System::baseUrl() . '/poco/' . $user['nickname'],
442 'name-date' => DateTimeFormat::utcNow(),
443 'uri-date' => DateTimeFormat::utcNow(),
444 'avatar-date' => DateTimeFormat::utcNow(),
452 * Updates the self-contact for the provided user id
455 * @param boolean $update_avatar Force the avatar update
457 public static function updateSelfFromUserID($uid, $update_avatar = false)
459 $fields = ['id', 'name', 'nick', 'location', 'about', 'keywords', 'gender', 'avatar',
460 'xmpp', 'contact-type', 'forum', 'prv', 'avatar-date', 'url', 'nurl',
461 'photo', 'thumb', 'micro', 'addr', 'request', 'notify', 'poll', 'confirm', 'poco'];
462 $self = DBA::selectFirst('contact', $fields, ['uid' => $uid, 'self' => true]);
463 if (!DBA::isResult($self)) {
467 $fields = ['nickname', 'page-flags', 'account-type'];
468 $user = DBA::selectFirst('user', $fields, ['uid' => $uid]);
469 if (!DBA::isResult($user)) {
473 $fields = ['name', 'photo', 'thumb', 'about', 'address', 'locality', 'region',
474 'country-name', 'gender', 'pub_keywords', 'xmpp'];
475 $profile = DBA::selectFirst('profile', $fields, ['uid' => $uid, 'is-default' => true]);
476 if (!DBA::isResult($profile)) {
480 $fields = ['name' => $profile['name'], 'nick' => $user['nickname'],
481 'avatar-date' => $self['avatar-date'], 'location' => Profile::formatLocation($profile),
482 'about' => $profile['about'], 'keywords' => $profile['pub_keywords'],
483 'gender' => $profile['gender'], 'avatar' => $profile['photo'],
484 'contact-type' => $user['account-type'], 'xmpp' => $profile['xmpp']];
486 $avatar = DBA::selectFirst('photo', ['resource-id', 'type'], ['uid' => $uid, 'profile' => true]);
487 if (DBA::isResult($avatar)) {
488 if ($update_avatar) {
489 $fields['avatar-date'] = DateTimeFormat::utcNow();
492 // Creating the path to the avatar, beginning with the file suffix
493 $types = Image::supportedTypes();
494 if (isset($types[$avatar['type']])) {
495 $file_suffix = $types[$avatar['type']];
497 $file_suffix = 'jpg';
500 // We are adding a timestamp value so that other systems won't use cached content
501 $timestamp = strtotime($fields['avatar-date']);
503 $prefix = System::baseUrl() . '/photo/' .$avatar['resource-id'] . '-';
504 $suffix = '.' . $file_suffix . '?ts=' . $timestamp;
506 $fields['photo'] = $prefix . '4' . $suffix;
507 $fields['thumb'] = $prefix . '5' . $suffix;
508 $fields['micro'] = $prefix . '6' . $suffix;
510 // We hadn't found a photo entry, so we use the default avatar
511 $fields['photo'] = System::baseUrl() . '/images/person-300.jpg';
512 $fields['thumb'] = System::baseUrl() . '/images/person-80.jpg';
513 $fields['micro'] = System::baseUrl() . '/images/person-48.jpg';
516 $fields['forum'] = $user['page-flags'] == self::PAGE_COMMUNITY;
517 $fields['prv'] = $user['page-flags'] == self::PAGE_PRVGROUP;
519 // it seems as if ported accounts can have wrong values, so we make sure that now everything is fine.
520 $fields['url'] = System::baseUrl() . '/profile/' . $user['nickname'];
521 $fields['nurl'] = Strings::normaliseLink($fields['url']);
522 $fields['addr'] = $user['nickname'] . '@' . substr(System::baseUrl(), strpos(System::baseUrl(), '://') + 3);
523 $fields['request'] = System::baseUrl() . '/dfrn_request/' . $user['nickname'];
524 $fields['notify'] = System::baseUrl() . '/dfrn_notify/' . $user['nickname'];
525 $fields['poll'] = System::baseUrl() . '/dfrn_poll/'. $user['nickname'];
526 $fields['confirm'] = System::baseUrl() . '/dfrn_confirm/' . $user['nickname'];
527 $fields['poco'] = System::baseUrl() . '/poco/' . $user['nickname'];
531 foreach ($fields as $field => $content) {
532 if ($self[$field] != $content) {
538 $fields['name-date'] = DateTimeFormat::utcNow();
539 DBA::update('contact', $fields, ['id' => $self['id']]);
541 // Update the public contact as well
542 DBA::update('contact', $fields, ['uid' => 0, 'nurl' => $self['nurl']]);
544 // Update the profile
545 $fields = ['photo' => System::baseUrl() . '/photo/profile/' .$uid . '.jpg',
546 'thumb' => System::baseUrl() . '/photo/avatar/' . $uid .'.jpg'];
547 DBA::update('profile', $fields, ['uid' => $uid, 'is-default' => true]);
552 * @brief Marks a contact for removal
554 * @param int $id contact id
557 public static function remove($id)
559 // We want just to make sure that we don't delete our "self" contact
560 $contact = DBA::selectFirst('contact', ['uid'], ['id' => $id, 'self' => false]);
561 if (!DBA::isResult($contact) || !intval($contact['uid'])) {
565 // Archive the contact
566 DBA::update('contact', ['archive' => true, 'network' => Protocol::PHANTOM, 'deleted' => true], ['id' => $id]);
568 // Delete it in the background
569 Worker::add(PRIORITY_LOW, 'RemoveContact', $id);
573 * @brief Sends an unfriend message. Does not remove the contact
575 * @param array $user User unfriending
576 * @param array $contact Contact unfriended
577 * @param boolean $dissolve Remove the contact on the remote side
580 public static function terminateFriendship(array $user, array $contact, $dissolve = false)
582 if (($contact['network'] == Protocol::DFRN) && $dissolve) {
583 DFRN::deliver($user, $contact, 'placeholder', true);
584 } elseif (in_array($contact['network'], [Protocol::OSTATUS, Protocol::DFRN])) {
585 // create an unfollow slap
587 $item['verb'] = NAMESPACE_OSTATUS . "/unfollow";
588 $item['follow'] = $contact["url"];
593 $item['attach'] = '';
594 $slap = OStatus::salmon($item, $user);
596 if (!empty($contact['notify'])) {
597 Salmon::slapper($user, $contact['notify'], $slap);
599 } elseif ($contact['network'] == Protocol::DIASPORA) {
600 Diaspora::sendUnshare($user, $contact);
601 } elseif ($contact['network'] == Protocol::ACTIVITYPUB) {
602 ActivityPub\Transmitter::sendContactUndo($contact['url'], $contact['id'], $user['uid']);
605 ActivityPub\Transmitter::sendContactReject($contact['url'], $contact['hub-verify'], $user['uid']);
611 * @brief Marks a contact for archival after a communication issue delay
613 * Contact has refused to recognise us as a friend. We will start a countdown.
614 * If they still don't recognise us in 32 days, the relationship is over,
615 * and we won't waste any more time trying to communicate with them.
616 * This provides for the possibility that their database is temporarily messed
617 * up or some other transient event and that there's a possibility we could recover from it.
619 * @param array $contact contact to mark for archival
622 public static function markForArchival(array $contact)
624 if (!isset($contact['url']) && !empty($contact['id'])) {
625 $fields = ['id', 'url', 'archive', 'self', 'term-date'];
626 $contact = DBA::selectFirst('contact', [], ['id' => $contact['id']]);
627 if (!DBA::isResult($contact)) {
630 } elseif (!isset($contact['url'])) {
631 Logger::log('Empty contact: ' . json_encode($contact) . ' - ' . System::callstack(20), Logger::DEBUG);
634 // Contact already archived or "self" contact? => nothing to do
635 if ($contact['archive'] || $contact['self']) {
639 if ($contact['term-date'] <= DBA::NULL_DATETIME) {
640 DBA::update('contact', ['term-date' => DateTimeFormat::utcNow()], ['id' => $contact['id']]);
641 DBA::update('contact', ['term-date' => DateTimeFormat::utcNow()], ['`nurl` = ? AND `term-date` <= ? AND NOT `self`', Strings::normaliseLink($contact['url']), DBA::NULL_DATETIME]);
644 * We really should send a notification to the owner after 2-3 weeks
645 * so they won't be surprised when the contact vanishes and can take
646 * remedial action if this was a serious mistake or glitch
649 /// @todo Check for contact vitality via probing
650 $archival_days = Config::get('system', 'archival_days', 32);
652 $expiry = $contact['term-date'] . ' + ' . $archival_days . ' days ';
653 if (DateTimeFormat::utcNow() > DateTimeFormat::utc($expiry)) {
654 /* Relationship is really truly dead. archive them rather than
655 * delete, though if the owner tries to unarchive them we'll start
656 * the whole process over again.
658 DBA::update('contact', ['archive' => 1], ['id' => $contact['id']]);
659 DBA::update('contact', ['archive' => 1], ['nurl' => Strings::normaliseLink($contact['url']), 'self' => false]);
665 * @brief Cancels the archival countdown
667 * @see Contact::markForArchival()
669 * @param array $contact contact to be unmarked for archival
672 public static function unmarkForArchival(array $contact)
674 $condition = ['`id` = ? AND (`term-date` > ? OR `archive`)', $contact['id'], DBA::NULL_DATETIME];
675 $exists = DBA::exists('contact', $condition);
677 // We don't need to update, we never marked this contact for archival
682 if (!isset($contact['url']) && !empty($contact['id'])) {
683 $fields = ['id', 'url', 'batch'];
684 $contact = DBA::selectFirst('contact', [], ['id' => $contact['id']]);
685 if (!DBA::isResult($contact)) {
690 // It's a miracle. Our dead contact has inexplicably come back to life.
691 $fields = ['term-date' => DBA::NULL_DATETIME, 'archive' => false];
692 DBA::update('contact', $fields, ['id' => $contact['id']]);
693 DBA::update('contact', $fields, ['nurl' => Strings::normaliseLink($contact['url'])]);
695 if (!empty($contact['batch'])) {
696 $condition = ['batch' => $contact['batch'], 'contact-type' => self::ACCOUNT_TYPE_RELAY];
697 DBA::update('contact', $fields, $condition);
702 * @brief Get contact data for a given profile link
704 * The function looks at several places (contact table and gcontact table) for the contact
705 * It caches its result for the same script execution to prevent duplicate calls
707 * @param string $url The profile link
708 * @param int $uid User id
709 * @param array $default If not data was found take this data as default value
711 * @return array Contact data
713 public static function getDetailsByURL($url, $uid = -1, array $default = [])
725 if (isset($cache[$url][$uid])) {
726 return $cache[$url][$uid];
729 $ssl_url = str_replace('http://', 'https://', $url);
731 // Fetch contact data from the contact table for the given user
732 $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`,
733 `keywords`, `gender`, `photo`, `thumb`, `micro`, `forum`, `prv`, (`forum` | `prv`) AS `community`, `contact-type`, `bd` AS `birthday`, `self`
734 FROM `contact` WHERE `nurl` = ? AND `uid` = ?", Strings::normaliseLink($url), $uid);
735 $r = DBA::toArray($s);
737 // Fetch contact data from the contact table for the given user, checking with the alias
738 if (!DBA::isResult($r)) {
739 $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`,
740 `keywords`, `gender`, `photo`, `thumb`, `micro`, `forum`, `prv`, (`forum` | `prv`) AS `community`, `contact-type`, `bd` AS `birthday`, `self`
741 FROM `contact` WHERE `alias` IN (?, ?, ?) AND `uid` = ?", Strings::normaliseLink($url), $url, $ssl_url, $uid);
742 $r = DBA::toArray($s);
745 // Fetch the data from the contact table with "uid=0" (which is filled automatically)
746 if (!DBA::isResult($r)) {
747 $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`,
748 `keywords`, `gender`, `photo`, `thumb`, `micro`, `forum`, `prv`, (`forum` | `prv`) AS `community`, `contact-type`, `bd` AS `birthday`, 0 AS `self`
749 FROM `contact` WHERE `nurl` = ? AND `uid` = 0", Strings::normaliseLink($url));
750 $r = DBA::toArray($s);
753 // Fetch the data from the contact table with "uid=0" (which is filled automatically) - checked with the alias
754 if (!DBA::isResult($r)) {
755 $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`,
756 `keywords`, `gender`, `photo`, `thumb`, `micro`, `forum`, `prv`, (`forum` | `prv`) AS `community`, `contact-type`, `bd` AS `birthday`, 0 AS `self`
757 FROM `contact` WHERE `alias` IN (?, ?, ?) AND `uid` = 0", Strings::normaliseLink($url), $url, $ssl_url);
758 $r = DBA::toArray($s);
761 // Fetch the data from the gcontact table
762 if (!DBA::isResult($r)) {
763 $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`,
764 `keywords`, `gender`, `photo`, `photo` AS `thumb`, `photo` AS `micro`, 0 AS `forum`, 0 AS `prv`, `community`, `contact-type`, `birthday`, 0 AS `self`
765 FROM `gcontact` WHERE `nurl` = ?", Strings::normaliseLink($url));
766 $r = DBA::toArray($s);
769 if (DBA::isResult($r)) {
770 // If there is more than one entry we filter out the connector networks
772 foreach ($r as $id => $result) {
773 if ($result["network"] == Protocol::STATUSNET) {
779 $profile = array_shift($r);
781 // "bd" always contains the upcoming birthday of a contact.
782 // "birthday" might contain the birthday including the year of birth.
783 if ($profile["birthday"] > DBA::NULL_DATE) {
784 $bd_timestamp = strtotime($profile["birthday"]);
785 $month = date("m", $bd_timestamp);
786 $day = date("d", $bd_timestamp);
788 $current_timestamp = time();
789 $current_year = date("Y", $current_timestamp);
790 $current_month = date("m", $current_timestamp);
791 $current_day = date("d", $current_timestamp);
793 $profile["bd"] = $current_year . "-" . $month . "-" . $day;
794 $current = $current_year . "-" . $current_month . "-" . $current_day;
796 if ($profile["bd"] < $current) {
797 $profile["bd"] = ( ++$current_year) . "-" . $month . "-" . $day;
800 $profile["bd"] = DBA::NULL_DATE;
806 if (empty($profile["photo"]) && isset($default["photo"])) {
807 $profile["photo"] = $default["photo"];
810 if (empty($profile["name"]) && isset($default["name"])) {
811 $profile["name"] = $default["name"];
814 if (empty($profile["network"]) && isset($default["network"])) {
815 $profile["network"] = $default["network"];
818 if (empty($profile["thumb"]) && isset($profile["photo"])) {
819 $profile["thumb"] = $profile["photo"];
822 if (empty($profile["micro"]) && isset($profile["thumb"])) {
823 $profile["micro"] = $profile["thumb"];
826 if ((empty($profile["addr"]) || empty($profile["name"])) && (defaults($profile, "gid", 0) != 0)
827 && in_array($profile["network"], [Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::DIASPORA, Protocol::OSTATUS])
829 Worker::add(PRIORITY_LOW, "UpdateGContact", $profile["gid"]);
832 // Show contact details of Diaspora contacts only if connected
833 if ((defaults($profile, "cid", 0) == 0) && (defaults($profile, "network", "") == Protocol::DIASPORA)) {
834 $profile["location"] = "";
835 $profile["about"] = "";
836 $profile["gender"] = "";
837 $profile["birthday"] = DBA::NULL_DATE;
840 $cache[$url][$uid] = $profile;
846 * @brief Get contact data for a given address
848 * The function looks at several places (contact table and gcontact table) for the contact
850 * @param string $addr The profile link
851 * @param int $uid User id
853 * @return array Contact data
855 public static function getDetailsByAddr($addr, $uid = -1)
867 // Fetch contact data from the contact table for the given user
868 $r = q("SELECT `id`, `id` AS `cid`, 0 AS `gid`, 0 AS `zid`, `uid`, `url`, `nurl`, `alias`, `network`, `name`, `nick`, `addr`, `location`, `about`, `xmpp`,
869 `keywords`, `gender`, `photo`, `thumb`, `micro`, `forum`, `prv`, (`forum` | `prv`) AS `community`, `contact-type`, `bd` AS `birthday`, `self`
870 FROM `contact` WHERE `addr` = '%s' AND `uid` = %d AND NOT `deleted`",
874 // Fetch the data from the contact table with "uid=0" (which is filled automatically)
875 if (!DBA::isResult($r)) {
876 $r = q("SELECT `id`, 0 AS `cid`, `id` AS `zid`, 0 AS `gid`, `uid`, `url`, `nurl`, `alias`, `network`, `name`, `nick`, `addr`, `location`, `about`, `xmpp`,
877 `keywords`, `gender`, `photo`, `thumb`, `micro`, `forum`, `prv`, (`forum` | `prv`) AS `community`, `contact-type`, `bd` AS `birthday`, 0 AS `self`
878 FROM `contact` WHERE `addr` = '%s' AND `uid` = 0 AND NOT `deleted`",
883 // Fetch the data from the gcontact table
884 if (!DBA::isResult($r)) {
885 $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`,
886 `keywords`, `gender`, `photo`, `photo` AS `thumb`, `photo` AS `micro`, `community` AS `forum`, 0 AS `prv`, `community`, `contact-type`, `birthday`, 0 AS `self`
887 FROM `gcontact` WHERE `addr` = '%s'",
892 if (!DBA::isResult($r)) {
893 $data = Probe::uri($addr);
895 $profile = self::getDetailsByURL($data['url'], $uid);
904 * @brief Returns the data array for the photo menu of a given contact
906 * @param array $contact contact
907 * @param int $uid optional, default 0
910 public static function photoMenu(array $contact, $uid = 0)
912 // @todo Unused, to be removed
920 $contact_drop_link = '';
927 if (empty($contact['uid']) || ($contact['uid'] != $uid)) {
929 $profile_link = self::magicLink($contact['url']);
930 $menu = ['profile' => [L10n::t('View Profile'), $profile_link, true]];
935 // Look for our own contact if the uid doesn't match and isn't public
936 $contact_own = DBA::selectFirst('contact', [], ['nurl' => $contact['nurl'], 'network' => $contact['network'], 'uid' => $uid]);
937 if (DBA::isResult($contact_own)) {
938 return self::photoMenu($contact_own, $uid);
943 if (($contact['network'] === Protocol::DFRN) && !$contact['self']) {
945 $profile_link = System::baseUrl() . '/redir/' . $contact['id'];
947 $profile_link = $contact['url'];
950 if ($profile_link === 'mailbox') {
955 $status_link = $profile_link . '?url=status';
956 $photos_link = $profile_link . '?url=photos';
957 $profile_link = $profile_link . '?url=profile';
960 if (in_array($contact['network'], [Protocol::DFRN, Protocol::DIASPORA]) && !$contact['self']) {
961 $pm_url = System::baseUrl() . '/message/new/' . $contact['id'];
964 if (($contact['network'] == Protocol::DFRN) && !$contact['self']) {
965 $poke_link = System::baseUrl() . '/poke/?f=&c=' . $contact['id'];
968 $contact_url = System::baseUrl() . '/contact/' . $contact['id'];
970 $posts_link = System::baseUrl() . '/contact/' . $contact['id'] . '/conversations';
972 if (!$contact['self']) {
973 $contact_drop_link = System::baseUrl() . '/contact/' . $contact['id'] . '/drop?confirm=1';
978 * "name" => [ "Label", "link", (bool)Should the link opened in a new tab? ]
980 if (empty($contact['uid'])) {
981 $connlnk = 'follow/?url=' . $contact['url'];
983 'profile' => [L10n::t('View Profile'), $profile_link, true],
984 'network' => [L10n::t('Network Posts'), $posts_link, false],
985 'edit' => [L10n::t('View Contact'), $contact_url, false],
986 'follow' => [L10n::t('Connect/Follow'), $connlnk, true],
990 'status' => [L10n::t('View Status'), $status_link, true],
991 'profile' => [L10n::t('View Profile'), $profile_link, true],
992 'photos' => [L10n::t('View Photos'), $photos_link, true],
993 'network' => [L10n::t('Network Posts'), $posts_link, false],
994 'edit' => [L10n::t('View Contact'), $contact_url, false],
995 'drop' => [L10n::t('Drop Contact'), $contact_drop_link, false],
996 'pm' => [L10n::t('Send PM'), $pm_url, false],
997 'poke' => [L10n::t('Poke'), $poke_link, false],
1001 $args = ['contact' => $contact, 'menu' => &$menu];
1003 Addon::callHooks('contact_photo_menu', $args);
1005 $menucondensed = [];
1007 foreach ($menu as $menuname => $menuitem) {
1008 if ($menuitem[1] != '') {
1009 $menucondensed[$menuname] = $menuitem;
1013 return $menucondensed;
1017 * @brief Returns ungrouped contact count or list for user
1019 * Returns either the total number of ungrouped contacts for the given user
1020 * id or a paginated list of ungrouped contacts.
1022 * @param int $uid uid
1023 * @param int $start optional, default 0
1024 * @param int $count optional, default 0
1028 public static function getUngroupedList($uid)
1038 SELECT DISTINCT(`contact-id`)
1040 INNER JOIN `group` ON `group`.`id` = `group_member`.`gid`
1041 WHERE `group`.`uid` = %d
1042 )", intval($uid), intval($uid));
1046 * @brief Fetch the contact id for a given URL and user
1048 * First lookup in the contact table to find a record matching either `url`, `nurl`,
1049 * `addr` or `alias`.
1051 * If there's no record and we aren't looking for a public contact, we quit.
1052 * If there's one, we check that it isn't time to update the picture else we
1053 * directly return the found contact id.
1055 * Second, we probe the provided $url whether it's http://server.tld/profile or
1056 * nick@server.tld. We quit if we can't get any info back.
1058 * Third, we create the contact record if it doesn't exist
1060 * Fourth, we update the existing record with the new data (avatar, alias, nick)
1061 * if there's any updates
1063 * @param string $url Contact URL
1064 * @param integer $uid The user id for the contact (0 = public contact)
1065 * @param boolean $no_update Don't update the contact
1066 * @param array $default Default value for creating the contact when every else fails
1067 * @param boolean $in_loop Internally used variable to prevent an endless loop
1069 * @return integer Contact ID
1071 public static function getIdForURL($url, $uid = 0, $no_update = false, $default = [], $in_loop = false)
1073 Logger::log("Get contact data for url " . $url . " and user " . $uid . " - " . System::callstack(), Logger::DEBUG);
1081 /// @todo Verify if we can't use Contact::getDetailsByUrl instead of the following
1082 // We first try the nurl (http://server.tld/nick), most common case
1083 $contact = DBA::selectFirst('contact', ['id', 'avatar', 'avatar-date'], ['nurl' => Strings::normaliseLink($url), 'uid' => $uid, 'deleted' => false]);
1085 // Then the addr (nick@server.tld)
1086 if (!DBA::isResult($contact)) {
1087 $contact = DBA::selectFirst('contact', ['id', 'avatar', 'avatar-date'], ['addr' => $url, 'uid' => $uid, 'deleted' => false]);
1090 // Then the alias (which could be anything)
1091 if (!DBA::isResult($contact)) {
1092 // The link could be provided as http although we stored it as https
1093 $ssl_url = str_replace('http://', 'https://', $url);
1094 $condition = ['`alias` IN (?, ?, ?) AND `uid` = ? AND NOT `deleted`', $url, Strings::normaliseLink($url), $ssl_url, $uid];
1095 $contact = DBA::selectFirst('contact', ['id', 'avatar', 'avatar-date'], $condition);
1098 if (DBA::isResult($contact)) {
1099 $contact_id = $contact["id"];
1101 // Update the contact every 7 days
1102 $update_contact = ($contact['avatar-date'] < DateTimeFormat::utc('now -7 days'));
1104 // We force the update if the avatar is empty
1105 if (empty($contact['avatar'])) {
1106 $update_contact = true;
1108 if (!$update_contact || $no_update) {
1111 } elseif ($uid != 0) {
1112 // Non-existing user-specific contact, exiting
1116 // When we don't want to update, we look if some of our users already know this contact
1118 $fields = ['url', 'addr', 'alias', 'notify', 'poll', 'name', 'nick',
1119 'photo', 'keywords', 'location', 'about', 'network',
1120 'priority', 'batch', 'request', 'confirm', 'poco'];
1121 $data = DBA::selectFirst('contact', $fields, ['nurl' => Strings::normaliseLink($url)]);
1123 if (DBA::isResult($data)) {
1124 // For security reasons we don't fetch key data from our users
1125 $data["pubkey"] = '';
1132 $data = Probe::uri($url, "", $uid);
1134 // Ensure that there is a gserver entry
1135 if (!empty($data['baseurl']) && ($data['network'] != Protocol::PHANTOM)) {
1136 PortableContact::checkServer($data['baseurl']);
1140 // Last try in gcontact for unsupported networks
1141 if (!in_array($data["network"], [Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::OSTATUS, Protocol::DIASPORA, Protocol::PUMPIO, Protocol::MAIL, Protocol::FEED])) {
1146 // Get data from the gcontact table
1147 $fields = ['name', 'nick', 'url', 'photo', 'addr', 'alias', 'network'];
1148 $contact = DBA::selectFirst('gcontact', $fields, ['nurl' => Strings::normaliseLink($url)]);
1149 if (!DBA::isResult($contact)) {
1150 $contact = DBA::selectFirst('contact', $fields, ['nurl' => Strings::normaliseLink($url)]);
1153 if (!DBA::isResult($contact)) {
1154 $fields = ['url', 'addr', 'alias', 'notify', 'poll', 'name', 'nick',
1155 'photo', 'keywords', 'location', 'about', 'network',
1156 'priority', 'batch', 'request', 'confirm', 'poco'];
1157 $contact = DBA::selectFirst('contact', $fields, ['addr' => $url]);
1160 if (!DBA::isResult($contact)) {
1161 // The link could be provided as http although we stored it as https
1162 $ssl_url = str_replace('http://', 'https://', $url);
1163 $condition = ['alias' => [$url, Strings::normaliseLink($url), $ssl_url]];
1164 $contact = DBA::selectFirst('contact', $fields, $condition);
1167 if (!DBA::isResult($contact)) {
1168 $fields = ['url', 'addr', 'alias', 'notify', 'poll', 'name', 'nick',
1169 'photo', 'network', 'priority', 'batch', 'request', 'confirm'];
1170 $condition = ['url' => [$url, Strings::normaliseLink($url), $ssl_url]];
1171 $contact = DBA::selectFirst('fcontact', $fields, $condition);
1174 if (!empty($default)) {
1175 $contact = $default;
1178 if (!DBA::isResult($contact)) {
1181 $data = array_merge($data, $contact);
1185 if (!$contact_id && ($data["alias"] != '') && ($data["alias"] != $url) && !$in_loop) {
1186 $contact_id = self::getIdForURL($data["alias"], $uid, true, $default, true);
1189 $url = $data["url"];
1193 'created' => DateTimeFormat::utcNow(),
1194 'url' => $data["url"],
1195 'nurl' => Strings::normaliseLink($data["url"]),
1196 'addr' => $data["addr"],
1197 'alias' => $data["alias"],
1198 'notify' => $data["notify"],
1199 'poll' => $data["poll"],
1200 'name' => $data["name"],
1201 'nick' => $data["nick"],
1202 'photo' => $data["photo"],
1203 'keywords' => $data["keywords"],
1204 'location' => $data["location"],
1205 'about' => $data["about"],
1206 'network' => $data["network"],
1207 'pubkey' => $data["pubkey"],
1208 'rel' => self::SHARING,
1209 'priority' => $data["priority"],
1210 'batch' => $data["batch"],
1211 'request' => $data["request"],
1212 'confirm' => $data["confirm"],
1213 'poco' => $data["poco"],
1214 'name-date' => DateTimeFormat::utcNow(),
1215 'uri-date' => DateTimeFormat::utcNow(),
1216 'avatar-date' => DateTimeFormat::utcNow(),
1222 $condition = ['nurl' => Strings::normaliseLink($data["url"]), 'uid' => $uid, 'deleted' => false];
1224 DBA::update('contact', $fields, $condition, true);
1226 $s = DBA::select('contact', ['id'], $condition, ['order' => ['id'], 'limit' => 2]);
1227 $contacts = DBA::toArray($s);
1228 if (!DBA::isResult($contacts)) {
1232 $contact_id = $contacts[0]["id"];
1234 // Update the newly created contact from data in the gcontact table
1235 $gcontact = DBA::selectFirst('gcontact', ['location', 'about', 'keywords', 'gender'], ['nurl' => Strings::normaliseLink($data["url"])]);
1236 if (DBA::isResult($gcontact)) {
1237 // Only use the information when the probing hadn't fetched these values
1238 if ($data['keywords'] != '') {
1239 unset($gcontact['keywords']);
1241 if ($data['location'] != '') {
1242 unset($gcontact['location']);
1244 if ($data['about'] != '') {
1245 unset($gcontact['about']);
1247 DBA::update('contact', $gcontact, ['id' => $contact_id]);
1250 if (count($contacts) > 1 && $uid == 0 && $contact_id != 0 && $data["url"] != "") {
1251 $condition = ["`nurl` = ? AND `uid` = ? AND `id` != ? AND NOT `self`",
1252 Strings::normaliseLink($data["url"]), 0, $contact_id];
1253 Logger::log('Deleting duplicate contact ' . json_encode($condition), Logger::DEBUG);
1254 DBA::delete('contact', $condition);
1258 self::updateAvatar($data["photo"], $uid, $contact_id);
1260 $fields = ['url', 'nurl', 'addr', 'alias', 'name', 'nick', 'keywords', 'location', 'about', 'avatar-date', 'pubkey'];
1261 $contact = DBA::selectFirst('contact', $fields, ['id' => $contact_id]);
1263 // This condition should always be true
1264 if (!DBA::isResult($contact)) {
1268 $updated = ['addr' => $data['addr'],
1269 'alias' => $data['alias'],
1270 'url' => $data['url'],
1271 'nurl' => Strings::normaliseLink($data['url']),
1272 'name' => $data['name'],
1273 'nick' => $data['nick']];
1275 if ($data['keywords'] != '') {
1276 $updated['keywords'] = $data['keywords'];
1278 if ($data['location'] != '') {
1279 $updated['location'] = $data['location'];
1282 // Update the technical stuff as well - if filled
1283 if ($data['notify'] != '') {
1284 $updated['notify'] = $data['notify'];
1286 if ($data['poll'] != '') {
1287 $updated['poll'] = $data['poll'];
1289 if ($data['batch'] != '') {
1290 $updated['batch'] = $data['batch'];
1292 if ($data['request'] != '') {
1293 $updated['request'] = $data['request'];
1295 if ($data['confirm'] != '') {
1296 $updated['confirm'] = $data['confirm'];
1298 if ($data['poco'] != '') {
1299 $updated['poco'] = $data['poco'];
1302 // Only fill the pubkey if it had been empty before. We have to prevent identity theft.
1303 if (empty($contact['pubkey'])) {
1304 $updated['pubkey'] = $data['pubkey'];
1307 if (($data["addr"] != $contact["addr"]) || ($data["alias"] != $contact["alias"])) {
1308 $updated['uri-date'] = DateTimeFormat::utcNow();
1310 if (($data["name"] != $contact["name"]) || ($data["nick"] != $contact["nick"])) {
1311 $updated['name-date'] = DateTimeFormat::utcNow();
1314 $updated['avatar-date'] = DateTimeFormat::utcNow();
1316 DBA::update('contact', $updated, ['id' => $contact_id], $contact);
1322 * @brief Checks if the contact is blocked
1324 * @param int $cid contact id
1326 * @return boolean Is the contact blocked?
1328 public static function isBlocked($cid)
1334 $blocked = DBA::selectFirst('contact', ['blocked', 'url'], ['id' => $cid]);
1335 if (!DBA::isResult($blocked)) {
1339 if (Network::isUrlBlocked($blocked['url'])) {
1343 return (bool) $blocked['blocked'];
1347 * @brief Checks if the contact is hidden
1349 * @param int $cid contact id
1351 * @return boolean Is the contact hidden?
1353 public static function isHidden($cid)
1359 $hidden = DBA::selectFirst('contact', ['hidden'], ['id' => $cid]);
1360 if (!DBA::isResult($hidden)) {
1363 return (bool) $hidden['hidden'];
1367 * @brief Returns posts from a given contact url
1369 * @param string $contact_url Contact URL
1371 * @return string posts in HTML
1373 public static function getPostsFromUrl($contact_url, $thread_mode = false, $update = 0)
1375 $a = self::getApp();
1377 $cid = Self::getIdForURL($contact_url);
1379 $contact = DBA::selectFirst('contact', ['contact-type', 'network'], ['id' => $cid]);
1380 if (!DBA::isResult($contact)) {
1384 if (in_array($contact["network"], [Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::DIASPORA, Protocol::OSTATUS, ""])) {
1385 $sql = "(`item`.`uid` = 0 OR (`item`.`uid` = ? AND NOT `item`.`global`))";
1387 $sql = "`item`.`uid` = ?";
1390 $contact_field = ($contact["contact-type"] == self::ACCOUNT_TYPE_COMMUNITY ? 'owner-id' : 'author-id');
1393 $condition = ["`$contact_field` = ? AND `gravity` = ? AND " . $sql,
1394 $cid, GRAVITY_PARENT, local_user()];
1396 $condition = ["`$contact_field` = ? AND `gravity` IN (?, ?) AND " . $sql,
1397 $cid, GRAVITY_PARENT, GRAVITY_COMMENT, local_user()];
1400 $pager = new Pager($a->query_string);
1402 $params = ['order' => ['created' => true],
1403 'limit' => [$pager->getStart(), $pager->getItemsPerPage()]];
1406 $r = Item::selectThreadForUser(local_user(), ['uri'], $condition, $params);
1408 $items = Item::inArray($r);
1410 $o = conversation($a, $items, $pager, 'contacts', $update);
1412 $r = Item::selectForUser(local_user(), [], $condition, $params);
1414 $items = Item::inArray($r);
1416 $o = conversation($a, $items, $pager, 'contact-posts', false);
1420 $o .= $pager->renderMinimal(count($items));
1427 * @brief Returns the account type name
1429 * The function can be called with either the user or the contact array
1431 * @param array $contact contact or user array
1434 public static function getAccountType(array $contact)
1436 // There are several fields that indicate that the contact or user is a forum
1437 // "page-flags" is a field in the user table,
1438 // "forum" and "prv" are used in the contact table. They stand for self::PAGE_COMMUNITY and self::PAGE_PRVGROUP.
1439 // "community" is used in the gcontact table and is true if the contact is self::PAGE_COMMUNITY or self::PAGE_PRVGROUP.
1440 if ((isset($contact['page-flags']) && (intval($contact['page-flags']) == self::PAGE_COMMUNITY))
1441 || (isset($contact['page-flags']) && (intval($contact['page-flags']) == self::PAGE_PRVGROUP))
1442 || (isset($contact['forum']) && intval($contact['forum']))
1443 || (isset($contact['prv']) && intval($contact['prv']))
1444 || (isset($contact['community']) && intval($contact['community']))
1446 $type = self::ACCOUNT_TYPE_COMMUNITY;
1448 $type = self::ACCOUNT_TYPE_PERSON;
1451 // The "contact-type" (contact table) and "account-type" (user table) are more general then the chaos from above.
1452 if (isset($contact["contact-type"])) {
1453 $type = $contact["contact-type"];
1456 if (isset($contact["account-type"])) {
1457 $type = $contact["account-type"];
1461 case self::ACCOUNT_TYPE_ORGANISATION:
1462 $account_type = L10n::t("Organisation");
1465 case self::ACCOUNT_TYPE_NEWS:
1466 $account_type = L10n::t('News');
1469 case self::ACCOUNT_TYPE_COMMUNITY:
1470 $account_type = L10n::t("Forum");
1478 return $account_type;
1482 * @brief Blocks a contact
1487 public static function block($uid)
1489 $return = DBA::update('contact', ['blocked' => true], ['id' => $uid]);
1495 * @brief Unblocks a contact
1500 public static function unblock($uid)
1502 $return = DBA::update('contact', ['blocked' => false], ['id' => $uid]);
1508 * @brief Updates the avatar links in a contact only if needed
1510 * @param string $avatar Link to avatar picture
1511 * @param int $uid User id of contact owner
1512 * @param int $cid Contact id
1513 * @param bool $force force picture update
1515 * @return array Returns array of the different avatar sizes
1517 public static function updateAvatar($avatar, $uid, $cid, $force = false)
1519 $contact = DBA::selectFirst('contact', ['avatar', 'photo', 'thumb', 'micro', 'nurl'], ['id' => $cid]);
1520 if (!DBA::isResult($contact)) {
1523 $data = [$contact["photo"], $contact["thumb"], $contact["micro"]];
1526 if (($contact["avatar"] != $avatar) || $force) {
1527 $photos = Photo::importProfilePhoto($avatar, $uid, $cid, true);
1532 ['avatar' => $avatar, 'photo' => $photos[0], 'thumb' => $photos[1], 'micro' => $photos[2], 'avatar-date' => DateTimeFormat::utcNow()],
1536 // Update the public contact (contact id = 0)
1538 $pcontact = DBA::selectFirst('contact', ['id'], ['nurl' => $contact['nurl'], 'uid' => 0]);
1539 if (DBA::isResult($pcontact)) {
1540 self::updateAvatar($avatar, 0, $pcontact['id'], $force);
1552 * @param integer $id contact id
1553 * @param string $network Optional network we are probing for
1556 public static function updateFromProbe($id, $network = '')
1559 Warning: Never ever fetch the public key via Probe::uri and write it into the contacts.
1560 This will reliably kill your communication with Friendica contacts.
1563 $fields = ['url', 'nurl', 'addr', 'alias', 'batch', 'notify', 'poll', 'poco', 'network'];
1564 $contact = DBA::selectFirst('contact', $fields, ['id' => $id]);
1565 if (!DBA::isResult($contact)) {
1569 $ret = Probe::uri($contact["url"], $network);
1571 // If Probe::uri fails the network code will be different
1572 if (($ret["network"] != $contact["network"]) && !in_array($ret["network"], [Protocol::ACTIVITYPUB, $network])) {
1578 // make sure to not overwrite existing values with blank entries
1579 foreach ($ret as $key => $val) {
1580 if (isset($contact[$key]) && ($contact[$key] != "") && ($val == "")) {
1581 $ret[$key] = $contact[$key];
1584 if (isset($contact[$key]) && ($ret[$key] != $contact[$key])) {
1595 'url' => $ret['url'],
1596 'nurl' => Strings::normaliseLink($ret['url']),
1597 'network' => $ret['network'],
1598 'addr' => $ret['addr'],
1599 'alias' => $ret['alias'],
1600 'batch' => $ret['batch'],
1601 'notify' => $ret['notify'],
1602 'poll' => $ret['poll'],
1603 'poco' => $ret['poco']
1608 // Update the corresponding gcontact entry
1609 PortableContact::lastUpdated($ret["url"]);
1615 * Takes a $uid and a url/handle and adds a new contact
1616 * Currently if the contact is DFRN, interactive needs to be true, to redirect to the
1617 * dfrn_request page.
1619 * Otherwise this can be used to bulk add StatusNet contacts, Twitter contacts, etc.
1622 * $return['success'] boolean true if successful
1623 * $return['message'] error text if success is false.
1625 * @brief Takes a $uid and a url/handle and adds a new contact
1627 * @param string $url
1628 * @param bool $interactive
1629 * @param string $network
1630 * @return boolean|string
1632 public static function createFromProbe($uid, $url, $interactive = false, $network = '')
1634 $result = ['cid' => -1, 'success' => false, 'message' => ''];
1638 // remove ajax junk, e.g. Twitter
1639 $url = str_replace('/#!/', '/', $url);
1641 if (!Network::isUrlAllowed($url)) {
1642 $result['message'] = L10n::t('Disallowed profile URL.');
1646 if (Network::isUrlBlocked($url)) {
1647 $result['message'] = L10n::t('Blocked domain');
1652 $result['message'] = L10n::t('Connect URL missing.');
1656 $arr = ['url' => $url, 'contact' => []];
1658 Hook::callAll('follow', $arr);
1661 $result['message'] = L10n::t('The contact could not be added. Please check the relevant network credentials in your Settings -> Social Networks page.');
1665 if (!empty($arr['contact']['name'])) {
1666 $ret = $arr['contact'];
1668 $ret = Probe::uri($url, $network, $uid, false);
1671 if (($network != '') && ($ret['network'] != $network)) {
1672 Logger::log('Expected network ' . $network . ' does not match actual network ' . $ret['network']);
1676 // check if we already have a contact
1677 // the poll url is more reliable than the profile url, as we may have
1678 // indirect links or webfinger links
1680 $condition = ['uid' => $uid, 'poll' => [$ret['poll'], Strings::normaliseLink($ret['poll'])], 'network' => $ret['network'], 'pending' => false];
1681 $contact = DBA::selectFirst('contact', ['id', 'rel'], $condition);
1682 if (!DBA::isResult($contact)) {
1683 $condition = ['uid' => $uid, 'nurl' => Strings::normaliseLink($url), 'network' => $ret['network'], 'pending' => false];
1684 $contact = DBA::selectFirst('contact', ['id', 'rel'], $condition);
1687 if (($ret['network'] === Protocol::DFRN) && !DBA::isResult($contact)) {
1689 if (strlen($a->getURLPath())) {
1690 $myaddr = bin2hex(System::baseUrl() . '/profile/' . $a->user['nickname']);
1692 $myaddr = bin2hex($a->user['nickname'] . '@' . $a->getHostName());
1695 $a->internalRedirect($ret['request'] . "&addr=$myaddr");
1699 } elseif (Config::get('system', 'dfrn_only') && ($ret['network'] != Protocol::DFRN)) {
1700 $result['message'] = L10n::t('This site is not configured to allow communications with other networks.') . EOL;
1701 $result['message'] != L10n::t('No compatible communication protocols or feeds were discovered.') . EOL;
1705 // This extra param just confuses things, remove it
1706 if ($ret['network'] === Protocol::DIASPORA) {
1707 $ret['url'] = str_replace('?absolute=true', '', $ret['url']);
1710 // do we have enough information?
1711 if (empty($ret['name']) || empty($ret['poll']) || (empty($ret['url']) && empty($ret['addr']))) {
1712 $result['message'] .= L10n::t('The profile address specified does not provide adequate information.') . EOL;
1713 if (empty($ret['poll'])) {
1714 $result['message'] .= L10n::t('No compatible communication protocols or feeds were discovered.') . EOL;
1716 if (empty($ret['name'])) {
1717 $result['message'] .= L10n::t('An author or name was not found.') . EOL;
1719 if (empty($ret['url'])) {
1720 $result['message'] .= L10n::t('No browser URL could be matched to this address.') . EOL;
1722 if (strpos($url, '@') !== false) {
1723 $result['message'] .= L10n::t('Unable to match @-style Identity Address with a known protocol or email contact.') . EOL;
1724 $result['message'] .= L10n::t('Use mailto: in front of address to force email check.') . EOL;
1729 if ($ret['network'] === Protocol::OSTATUS && Config::get('system', 'ostatus_disabled')) {
1730 $result['message'] .= L10n::t('The profile address specified belongs to a network which has been disabled on this site.') . EOL;
1731 $ret['notify'] = '';
1734 if (!$ret['notify']) {
1735 $result['message'] .= L10n::t('Limited profile. This person will be unable to receive direct/personal notifications from you.') . EOL;
1738 $writeable = ((($ret['network'] === Protocol::OSTATUS) && ($ret['notify'])) ? 1 : 0);
1740 $subhub = (($ret['network'] === Protocol::OSTATUS) ? true : false);
1742 $hidden = (($ret['network'] === Protocol::MAIL) ? 1 : 0);
1744 $pending = in_array($ret['network'], [Protocol::ACTIVITYPUB]);
1746 if (in_array($ret['network'], [Protocol::MAIL, Protocol::DIASPORA, Protocol::ACTIVITYPUB])) {
1750 if (DBA::isResult($contact)) {
1752 $new_relation = (($contact['rel'] == self::FOLLOWER) ? self::FRIEND : self::SHARING);
1754 $fields = ['rel' => $new_relation, 'subhub' => $subhub, 'readonly' => false];
1755 DBA::update('contact', $fields, ['id' => $contact['id']]);
1757 $new_relation = (in_array($ret['network'], [Protocol::MAIL]) ? self::FRIEND : self::SHARING);
1759 // create contact record
1760 DBA::insert('contact', [
1762 'created' => DateTimeFormat::utcNow(),
1763 'url' => $ret['url'],
1764 'nurl' => Strings::normaliseLink($ret['url']),
1765 'addr' => $ret['addr'],
1766 'alias' => $ret['alias'],
1767 'batch' => $ret['batch'],
1768 'notify' => $ret['notify'],
1769 'poll' => $ret['poll'],
1770 'poco' => $ret['poco'],
1771 'name' => $ret['name'],
1772 'nick' => $ret['nick'],
1773 'network' => $ret['network'],
1774 'pubkey' => $ret['pubkey'],
1775 'rel' => $new_relation,
1776 'priority'=> $ret['priority'],
1777 'writable'=> $writeable,
1778 'hidden' => $hidden,
1781 'pending' => $pending,
1786 $contact = DBA::selectFirst('contact', [], ['url' => $ret['url'], 'network' => $ret['network'], 'uid' => $uid]);
1787 if (!DBA::isResult($contact)) {
1788 $result['message'] .= L10n::t('Unable to retrieve contact information.') . EOL;
1792 $contact_id = $contact['id'];
1793 $result['cid'] = $contact_id;
1795 Group::addMember(User::getDefaultGroup($uid, $contact["network"]), $contact_id);
1797 // Update the avatar
1798 self::updateAvatar($ret['photo'], $uid, $contact_id);
1800 // pull feed and consume it, which should subscribe to the hub.
1802 Worker::add(PRIORITY_HIGH, "OnePoll", $contact_id, "force");
1804 $owner = User::getOwnerDataById($uid);
1806 if (DBA::isResult($owner)) {
1807 if (in_array($contact['network'], [Protocol::OSTATUS, Protocol::DFRN])) {
1808 // create a follow slap
1810 $item['verb'] = ACTIVITY_FOLLOW;
1811 $item['follow'] = $contact["url"];
1813 $item['title'] = '';
1816 $item['attach'] = '';
1818 $slap = OStatus::salmon($item, $owner);
1820 if (!empty($contact['notify'])) {
1821 Salmon::slapper($owner, $contact['notify'], $slap);
1823 } elseif ($contact['network'] == Protocol::DIASPORA) {
1824 $ret = Diaspora::sendShare($a->user, $contact);
1825 Logger::log('share returns: ' . $ret);
1826 } elseif ($contact['network'] == Protocol::ACTIVITYPUB) {
1827 $activity_id = ActivityPub\Transmitter::activityIDFromContact($contact_id);
1828 if (empty($activity_id)) {
1829 // This really should never happen
1833 $ret = ActivityPub\Transmitter::sendActivity('Follow', $contact['url'], $uid, $activity_id);
1834 Logger::log('Follow returns: ' . $ret);
1838 $result['success'] = true;
1843 * @brief Updated contact's SSL policy
1845 * @param array $contact Contact array
1846 * @param string $new_policy New policy, valid: self,full
1848 * @return array Contact array with updated values
1850 public static function updateSslPolicy(array $contact, $new_policy)
1852 $ssl_changed = false;
1853 if ((intval($new_policy) == SSL_POLICY_SELFSIGN || $new_policy === 'self') && strstr($contact['url'], 'https:')) {
1854 $ssl_changed = true;
1855 $contact['url'] = str_replace('https:', 'http:', $contact['url']);
1856 $contact['request'] = str_replace('https:', 'http:', $contact['request']);
1857 $contact['notify'] = str_replace('https:', 'http:', $contact['notify']);
1858 $contact['poll'] = str_replace('https:', 'http:', $contact['poll']);
1859 $contact['confirm'] = str_replace('https:', 'http:', $contact['confirm']);
1860 $contact['poco'] = str_replace('https:', 'http:', $contact['poco']);
1863 if ((intval($new_policy) == SSL_POLICY_FULL || $new_policy === 'full') && strstr($contact['url'], 'http:')) {
1864 $ssl_changed = true;
1865 $contact['url'] = str_replace('http:', 'https:', $contact['url']);
1866 $contact['request'] = str_replace('http:', 'https:', $contact['request']);
1867 $contact['notify'] = str_replace('http:', 'https:', $contact['notify']);
1868 $contact['poll'] = str_replace('http:', 'https:', $contact['poll']);
1869 $contact['confirm'] = str_replace('http:', 'https:', $contact['confirm']);
1870 $contact['poco'] = str_replace('http:', 'https:', $contact['poco']);
1874 $fields = ['url' => $contact['url'], 'request' => $contact['request'],
1875 'notify' => $contact['notify'], 'poll' => $contact['poll'],
1876 'confirm' => $contact['confirm'], 'poco' => $contact['poco']];
1877 DBA::update('contact', $fields, ['id' => $contact['id']]);
1883 public static function addRelationship($importer, $contact, $datarray, $item = '', $sharing = false) {
1884 // Should always be set
1885 if (empty($datarray['author-id'])) {
1889 $fields = ['url', 'name', 'nick', 'photo', 'network'];
1890 $pub_contact = DBA::selectFirst('contact', $fields, ['id' => $datarray['author-id']]);
1891 if (!DBA::isResult($pub_contact)) {
1892 // Should never happen
1896 $url = defaults($datarray, 'author-link', $pub_contact['url']);
1897 $name = $pub_contact['name'];
1898 $photo = $pub_contact['photo'];
1899 $nick = $pub_contact['nick'];
1900 $network = $pub_contact['network'];
1902 if (is_array($contact)) {
1903 if (($contact['rel'] == self::SHARING)
1904 || ($sharing && $contact['rel'] == self::FOLLOWER)) {
1905 DBA::update('contact', ['rel' => self::FRIEND, 'writable' => true],
1906 ['id' => $contact['id'], 'uid' => $importer['uid']]);
1909 if ($contact['network'] == Protocol::ACTIVITYPUB) {
1910 ActivityPub\Transmitter::sendContactAccept($contact['url'], $contact['hub-verify'], $importer['uid']);
1913 // send email notification to owner?
1915 if (DBA::exists('contact', ['nurl' => Strings::normaliseLink($url), 'uid' => $importer['uid'], 'pending' => true])) {
1916 Logger::log('ignoring duplicated connection request from pending contact ' . $url);
1919 // create contact record
1920 q("INSERT INTO `contact` (`uid`, `created`, `url`, `nurl`, `name`, `nick`, `photo`, `network`, `rel`,
1921 `blocked`, `readonly`, `pending`, `writable`)
1922 VALUES (%d, '%s', '%s', '%s', '%s', '%s', '%s', '%s', %d, 0, 0, 1, 1)",
1923 intval($importer['uid']),
1924 DBA::escape(DateTimeFormat::utcNow()),
1926 DBA::escape(Strings::normaliseLink($url)),
1929 DBA::escape($photo),
1930 DBA::escape($network),
1931 intval(self::FOLLOWER)
1935 'id' => DBA::lastInsertId(),
1936 'network' => $network,
1942 Contact::updateAvatar($photo, $importer["uid"], $contact_record["id"], true);
1944 /// @TODO Encapsulate this into a function/method
1945 $fields = ['uid', 'username', 'email', 'page-flags', 'notify-flags', 'language'];
1946 $user = DBA::selectFirst('user', $fields, ['uid' => $importer['uid']]);
1947 if (DBA::isResult($user) && !in_array($user['page-flags'], [self::PAGE_SOAPBOX, self::PAGE_FREELOVE, self::PAGE_COMMUNITY])) {
1948 // create notification
1949 $hash = Strings::getRandomHex();
1951 if (is_array($contact_record)) {
1952 DBA::insert('intro', ['uid' => $importer['uid'], 'contact-id' => $contact_record['id'],
1953 'blocked' => false, 'knowyou' => false,
1954 'hash' => $hash, 'datetime' => DateTimeFormat::utcNow()]);
1957 Group::addMember(User::getDefaultGroup($importer['uid'], $contact_record["network"]), $contact_record['id']);
1959 if (($user['notify-flags'] & NOTIFY_INTRO) &&
1960 in_array($user['page-flags'], [self::PAGE_NORMAL])) {
1963 'type' => NOTIFY_INTRO,
1964 'notify_flags' => $user['notify-flags'],
1965 'language' => $user['language'],
1966 'to_name' => $user['username'],
1967 'to_email' => $user['email'],
1968 'uid' => $user['uid'],
1969 'link' => System::baseUrl() . '/notifications/intro',
1970 'source_name' => ((strlen(stripslashes($contact_record['name']))) ? stripslashes($contact_record['name']) : L10n::t('[Name Withheld]')),
1971 'source_link' => $contact_record['url'],
1972 'source_photo' => $contact_record['photo'],
1973 'verb' => ($sharing ? ACTIVITY_FRIEND : ACTIVITY_FOLLOW),
1978 } elseif (DBA::isResult($user) && in_array($user['page-flags'], [self::PAGE_SOAPBOX, self::PAGE_FREELOVE, self::PAGE_COMMUNITY])) {
1979 $condition = ['uid' => $importer['uid'], 'url' => $url, 'pending' => true];
1980 DBA::update('contact', ['pending' => false], $condition);
1982 $contact = DBA::selectFirst('contact', ['url', 'network', 'hub-verify'], ['id' => $contact_record['id']]);
1984 if ($contact['network'] == Protocol::ACTIVITYPUB) {
1985 ActivityPub\Transmitter::sendContactAccept($contact['url'], $contact['hub-verify'], $importer['uid']);
1991 public static function removeFollower($importer, $contact, array $datarray = [], $item = "")
1993 if (($contact['rel'] == self::FRIEND) || ($contact['rel'] == self::SHARING)) {
1994 DBA::update('contact', ['rel' => self::SHARING], ['id' => $contact['id']]);
1996 Contact::remove($contact['id']);
2000 public static function removeSharer($importer, $contact, array $datarray = [], $item = "")
2002 if (($contact['rel'] == self::FRIEND) || ($contact['rel'] == self::FOLLOWER)) {
2003 DBA::update('contact', ['rel' => self::FOLLOWER], ['id' => $contact['id']]);
2005 Contact::remove($contact['id']);
2010 * @brief Create a birthday event.
2012 * Update the year and the birthday.
2014 public static function updateBirthdays()
2018 AND `bd` > "0001-01-01"
2019 AND SUBSTRING(`bd`, 1, 4) != `bdyear`
2020 AND (`contact`.`rel` = ? OR `contact`.`rel` = ?)
2021 AND NOT `contact`.`pending`
2022 AND NOT `contact`.`hidden`
2023 AND NOT `contact`.`blocked`
2024 AND NOT `contact`.`archive`
2025 AND NOT `contact`.`deleted`',
2030 $contacts = DBA::select('contact', ['id', 'uid', 'name', 'url', 'bd'], $condition);
2032 while ($contact = DBA::fetch($contacts)) {
2033 Logger::log('update_contact_birthday: ' . $contact['bd']);
2035 $nextbd = DateTimeFormat::utcNow('Y') . substr($contact['bd'], 4);
2037 if (Event::createBirthday($contact, $nextbd)) {
2041 ['bdyear' => substr($nextbd, 0, 4), 'bd' => $nextbd],
2042 ['id' => $contact['id']]
2049 * Remove the unavailable contact ids from the provided list
2051 * @param array $contact_ids Contact id list
2053 public static function pruneUnavailable(array &$contact_ids)
2055 if (empty($contact_ids)) {
2059 $str = DBA::escape(implode(',', $contact_ids));
2061 $stmt = DBA::p("SELECT `id` FROM `contact` WHERE `id` IN ( " . $str . ") AND `blocked` = 0 AND `pending` = 0 AND `archive` = 0");
2064 while($contact = DBA::fetch($stmt)) {
2065 $return[] = $contact['id'];
2070 $contact_ids = $return;
2074 * @brief Returns a magic link to authenticate remote visitors
2076 * @todo check if the return is either a fully qualified URL or a relative path to Friendica basedir
2078 * @param string $contact_url The address of the target contact profile
2079 * @param string $url An url that we will be redirected to after the authentication
2081 * @return string with "redir" link
2083 public static function magicLink($contact_url, $url = '')
2085 if (!local_user() && remote_user()) {
2086 return $url ?: $contact_url; // Equivalent to: ($url != '') ? $url : $contact_url;
2089 $cid = self::getIdForURL($contact_url, 0, true);
2091 return $url ?: $contact_url; // Equivalent to: ($url != '') ? $url : $contact_url;
2094 return self::magicLinkbyId($cid, $url);
2098 * @brief Returns a magic link to authenticate remote visitors
2100 * @param integer $cid The contact id of the target contact profile
2101 * @param integer $url An url that we will be redirected to after the authentication
2103 * @return string with "redir" link
2105 public static function magicLinkbyId($cid, $url = '')
2107 $contact = DBA::selectFirst('contact', ['id', 'network', 'url', 'uid'], ['id' => $cid]);
2109 return self::magicLinkbyContact($contact, $url);
2113 * @brief Returns a magic link to authenticate remote visitors
2115 * @param array $contact The contact array with "uid", "network" and "url"
2116 * @param string $url An url that we will be redirected to after the authentication
2118 * @return string with "redir" link
2120 public static function magicLinkbyContact($contact, $url = '')
2122 if ((!local_user() && !remote_user()) || ($contact['network'] != Protocol::DFRN)) {
2123 return $url ?: $contact['url']; // Equivalent to ($url != '') ? $url : $contact['url'];
2126 // Only redirections to the same host do make sense
2127 if (($url != '') && (parse_url($url, PHP_URL_HOST) != parse_url($contact['url'], PHP_URL_HOST))) {
2131 if ($contact['uid'] != 0) {
2132 return self::magicLink($contact['url'], $url);
2135 $redirect = 'redir/' . $contact['id'];
2138 $redirect .= '?url=' . $url;