]> git.mxchange.org Git - friendica.git/blobdiff - src/Model/Contact.php
Changes:
[friendica.git] / src / Model / Contact.php
index bf1a50cbc4e5fd8c08174f6e5ac7c8ff7c2bf441..f8ff91ec554112f4a4a19559f16b4e94ca8369b1 100644 (file)
@@ -119,7 +119,7 @@ class Contact
         * @return array
         * @throws \Exception
         */
-       public static function selectToArray(array $fields = [], array $condition = [], array $params = [])
+       public static function selectToArray(array $fields = [], array $condition = [], array $params = []): array
        {
                return DBA::selectToArray('contact', $fields, $condition, $params);
        }
@@ -128,7 +128,7 @@ class Contact
         * @param array $fields    Array of selected fields, empty for all
         * @param array $condition Array of fields for condition
         * @param array $params    Array of several parameters
-        * @return array
+        * @return array|bool
         * @throws \Exception
         */
        public static function selectFirst(array $fields = [], array $condition = [], array $params = [])
@@ -148,7 +148,7 @@ class Contact
         * @return int  id of the created contact
         * @throws \Exception
         */
-       public static function insert(array $fields, int $duplicate_mode = Database::INSERT_DEFAULT)
+       public static function insert(array $fields, int $duplicate_mode = Database::INSERT_DEFAULT): int
        {
                if (!empty($fields['baseurl']) && empty($fields['gsid'])) {
                        $fields['gsid'] = GServer::getID($fields['baseurl'], true);
@@ -187,6 +187,7 @@ class Contact
         *
         * @return boolean was the update successfull?
         * @throws \Exception
+        * @todo Let's get rid of boolean type of $old_fields
         */
        public static function update(array $fields, array $condition, $old_fields = [])
        {
@@ -204,7 +205,7 @@ class Contact
         * @return array|boolean Contact record if it exists, false otherwise
         * @throws \Exception
         */
-       public static function getById($id, $fields = [])
+       public static function getById(int $id, array $fields = [])
        {
                return DBA::selectFirst('contact', $fields, ['id' => $id]);
        }
@@ -217,7 +218,7 @@ class Contact
         * @return array|boolean Contact record if it exists, false otherwise
         * @throws \Exception
         */
-       public static function getByUriId($uri_id, $fields = [])
+       public static function getByUriId(int $uri_id, array $fields = [])
        {
                return DBA::selectFirst('contact', $fields, ['uri-id' => $uri_id], ['order' => ['uid']]);
        }
@@ -231,7 +232,7 @@ class Contact
         * @param integer $uid    User ID of the contact
         * @return array contact array
         */
-       public static function getByURL(string $url, $update = null, array $fields = [], int $uid = 0)
+       public static function getByURL(string $url, $update = null, array $fields = [], int $uid = 0): array
        {
                if ($update || is_null($update)) {
                        $cid = self::getIdForURL($url, $uid, $update);
@@ -302,7 +303,7 @@ class Contact
         * @param array   $fields Field list
         * @return array contact array
         */
-       public static function getByURLForUser(string $url, int $uid = 0, $update = false, array $fields = [])
+       public static function getByURLForUser(string $url, int $uid = 0, $update = false, array $fields = []): array
        {
                if ($uid != 0) {
                        $contact = self::getByURL($url, $update, $fields, $uid);
@@ -333,7 +334,7 @@ class Contact
         * @throws HTTPException\InternalServerErrorException
         * @throws \ImagickException
         */
-       public static function isFollower($cid, $uid)
+       public static function isFollower(int $cid, int $uid): bool
        {
                if (Contact\User::isBlocked($cid, $uid)) {
                        return false;
@@ -358,7 +359,7 @@ class Contact
         * @throws HTTPException\InternalServerErrorException
         * @throws \ImagickException
         */
-       public static function isFollowerByURL($url, $uid)
+       public static function isFollowerByURL(string $url, uid $uid): bool
        {
                $cid = self::getIdForURL($url, $uid);
 
@@ -370,16 +371,16 @@ class Contact
        }
 
        /**
-        * Tests if the given user follow the given contact
+        * Tests if the given user shares with the given contact
         *
         * @param int $cid Either public contact id or user's contact id
         * @param int $uid User ID
         *
-        * @return boolean is the contact url being followed?
+        * @return boolean is the contact sharing with given user?
         * @throws HTTPException\InternalServerErrorException
         * @throws \ImagickException
         */
-       public static function isSharing($cid, $uid)
+       public static function isSharing(int $cid, int $uid): bool
        {
                if (Contact\User::isBlocked($cid, $uid)) {
                        return false;
@@ -404,7 +405,7 @@ class Contact
         * @throws HTTPException\InternalServerErrorException
         * @throws \ImagickException
         */
-       public static function isSharingByURL($url, $uid)
+       public static function isSharingByURL(string $url, int $uid): bool
        {
                $cid = self::getIdForURL($url, $uid);
 
@@ -425,7 +426,7 @@ class Contact
         * @throws HTTPException\InternalServerErrorException
         * @throws \ImagickException
         */
-       public static function getBasepath($url, $dont_update = false)
+       public static function getBasepath(string $url, bool $dont_update = false): string
        {
                $contact = DBA::selectFirst('contact', ['id', 'baseurl'], ['uid' => 0, 'nurl' => Strings::normaliseLink($url)]);
                if (!DBA::isResult($contact)) {
@@ -459,7 +460,7 @@ class Contact
         *
         * @return boolean Is it the same server?
         */
-       public static function isLocal($url)
+       public static function isLocal(string $url): bool
        {
                if (!parse_url($url, PHP_URL_SCHEME)) {
                        $addr_parts = explode('@', $url);
@@ -476,7 +477,7 @@ class Contact
         *
         * @return boolean Is it the same server?
         */
-       public static function isLocalById(int $cid)
+       public static function isLocalById(int $cid): bool
        {
                $contact = DBA::selectFirst('contact', ['url', 'baseurl'], ['id' => $cid]);
                if (!DBA::isResult($contact)) {
@@ -500,7 +501,7 @@ class Contact
         * @return integer|boolean Public contact id for given user id
         * @throws \Exception
         */
-       public static function getPublicIdByUserId($uid)
+       public static function getPublicIdByUserId(int $uid)
        {
                $self = DBA::selectFirst('contact', ['url'], ['self' => true, 'uid' => $uid]);
                if (!DBA::isResult($self)) {
@@ -519,7 +520,7 @@ class Contact
         * @throws HTTPException\InternalServerErrorException
         * @throws \ImagickException
         */
-       public static function getPublicAndUserContactID($cid, $uid)
+       public static function getPublicAndUserContactID(int $cid, int $uid): array
        {
                // We have to use the legacy function as long as the post update hasn't finished
                if (DI::config()->get('system', 'post_update_version') < 1427) {
@@ -560,7 +561,7 @@ class Contact
         * @throws HTTPException\InternalServerErrorException
         * @throws \ImagickException
         */
-       private static function legacyGetPublicAndUserContactID($cid, $uid)
+       private static function legacyGetPublicAndUserContactID(int $cid, int $uid): array
        {
                if (empty($uid) || empty($cid)) {
                        return [];
@@ -683,7 +684,7 @@ class Contact
         */
        public static function updateSelfFromUserID($uid, $update_avatar = false)
        {
-               $fields = ['id', 'name', 'nick', 'location', 'about', 'keywords', 'avatar', 'prvkey', 'pubkey', 'manually-approve',
+               $fields = ['id', 'uri-id', 'name', 'nick', 'location', 'about', 'keywords', 'avatar', 'prvkey', 'pubkey', 'manually-approve',
                        'xmpp', 'matrix', 'contact-type', 'forum', 'prv', 'avatar-date', 'url', 'nurl', 'unsearchable',
                        'photo', 'thumb', 'micro', 'header', 'addr', 'request', 'notify', 'poll', 'confirm', 'poco', 'network'];
                $self = DBA::selectFirst('contact', $fields, ['uid' => $uid, 'self' => true]);
@@ -715,6 +716,7 @@ class Contact
                // it seems as if ported accounts can have wrong values, so we make sure that now everything is fine.
                $fields['url'] = DI::baseUrl() . '/profile/' . $user['nickname'];
                $fields['nurl'] = Strings::normaliseLink($fields['url']);
+               $fields['uri-id'] = ItemURI::getIdByURI($fields['url']);
                $fields['addr'] = $user['nickname'] . '@' . substr(DI::baseUrl(), strpos(DI::baseUrl(), '://') + 3);
                $fields['request'] = DI::baseUrl() . '/dfrn_request/' . $user['nickname'];
                $fields['notify'] = DI::baseUrl() . '/dfrn_notify/' . $user['nickname'];
@@ -772,10 +774,10 @@ class Contact
                        $fields['updated'] = DateTimeFormat::utcNow();
                        self::update($fields, ['id' => $self['id']]);
 
-                       // Update the public contact as well
-                       $fields['prvkey'] = null;
-                       $fields['self']   = false;
-                       self::update($fields, ['uid' => 0, 'nurl' => $self['nurl']]);
+                       // Update the other contacts as well
+                       unset($fields['prvkey']);
+                       $fields['self'] = false;
+                       self::update($fields, ['uri-id' => $self['uri-id'], 'self' => false]);
 
                        // Update the profile
                        $fields = [
@@ -1525,7 +1527,7 @@ class Contact
         * @param int $type type of contact or account
         * @return string
         */
-       public static function getAccountType(int $type)
+       public static function getAccountType(int $type): string
        {
                switch ($type) {
                        case self::TYPE_ORGANISATION:
@@ -1551,11 +1553,11 @@ class Contact
        /**
         * Blocks a contact
         *
-        * @param int $cid
-        * @return bool
-        * @throws \Exception
+        * @param int $cid Contact id to block
+        * @param string $reason Block reason
+        * @return bool Whether it was successful
         */
-       public static function block($cid, $reason = null)
+       public static function block(int $cid, string $reason = null): bool
        {
                $return = self::update(['blocked' => true, 'block_reason' => $reason], ['id' => $cid]);
 
@@ -1565,11 +1567,10 @@ class Contact
        /**
         * Unblocks a contact
         *
-        * @param int $cid
-        * @return bool
-        * @throws \Exception
+        * @param int $cid Contact id to unblock
+        * @return bool Whether it was successfull
         */
-       public static function unblock($cid)
+       public static function unblock(int $cid): bool
        {
                $return = self::update(['blocked' => false, 'block_reason' => null], ['id' => $cid]);
 
@@ -1579,7 +1580,7 @@ class Contact
        /**
         * Ensure that cached avatar exist
         *
-        * @param integer $cid
+        * @param integer $cid Contact id
         */
        public static function checkAvatarCache(int $cid)
        {
@@ -1619,7 +1620,7 @@ class Contact
         * @param bool  $no_update Don't perfom an update if no cached avatar was found
         * @return string photo path
         */
-       private static function getAvatarPath(array $contact, string $size, $no_update = false)
+       private static function getAvatarPath(array $contact, string $size, bool $no_update = false): string
        {
                $contact = self::checkAvatarCacheByArray($contact, $no_update);
 
@@ -1653,7 +1654,7 @@ class Contact
         * @param bool   $no_update Don't perfom an update if no cached avatar was found
         * @return string photo path
         */
-       public static function getPhoto(array $contact, bool $no_update = false)
+       public static function getPhoto(array $contact, bool $no_update = false): string
        {
                return self::getAvatarPath($contact, Proxy::SIZE_SMALL, $no_update);
        }
@@ -1665,7 +1666,7 @@ class Contact
         * @param bool   $no_update Don't perfom an update if no cached avatar was found
         * @return string photo path
         */
-       public static function getThumb(array $contact, bool $no_update = false)
+       public static function getThumb(array $contact, bool $no_update = false): string
        {
                return self::getAvatarPath($contact, Proxy::SIZE_THUMB, $no_update);
        }
@@ -1677,7 +1678,7 @@ class Contact
         * @param bool   $no_update Don't perfom an update if no cached avatar was found
         * @return string photo path
         */
-       public static function getMicro(array $contact, bool $no_update = false)
+       public static function getMicro(array $contact, bool $no_update = false): string
        {
                return self::getAvatarPath($contact, Proxy::SIZE_MICRO, $no_update);
        }
@@ -1689,7 +1690,7 @@ class Contact
         * @param bool  $no_update Don't perfom an update if no cached avatar was found
         * @return array contact array with avatar cache fields
         */
-       private static function checkAvatarCacheByArray(array $contact, bool $no_update = false)
+       private static function checkAvatarCacheByArray(array $contact, bool $no_update = false): array
        {
                $update = false;
                $contact_fields = [];
@@ -1795,7 +1796,7 @@ class Contact
         * @param string $size    Size of the avatar picture
         * @return string avatar URL
         */
-       public static function getDefaultAvatar(array $contact, string $size)
+       public static function getDefaultAvatar(array $contact, string $size): string
        {
                switch ($size) {
                        case Proxy::SIZE_MICRO:
@@ -1816,6 +1817,114 @@ class Contact
                }
 
                if (!DI::config()->get('system', 'remote_avatar_lookup')) {
+                       $platform = '';
+                       $type     = Contact::TYPE_PERSON;
+
+                       if (!empty($contact['id'])) {
+                               $account = DBA::selectFirst('account-user-view', ['platform', 'contact-type'], ['id' => $contact['id']]);
+                               $platform = $account['platform'] ?? '';
+                               $type     = $account['contact-type'] ?? Contact::TYPE_PERSON;
+                       }
+
+                       if (empty($platform) && !empty($contact['uri-id'])) {
+                               $account = DBA::selectFirst('account-user-view', ['platform', 'contact-type'], ['uri-id' => $contact['uri-id']]);
+                               $platform = $account['platform'] ?? '';
+                               $type     = $account['contact-type'] ?? Contact::TYPE_PERSON;
+                       }
+
+                       switch ($platform) {
+                               case 'corgidon':
+                                       /**
+                                        * Picture credits
+                                        * @license GNU Affero General Public License v3.0
+                                        * @link    https://github.com/msdos621/corgidon/blob/main/public/avatars/original/missing.png
+                                        */
+                                       $default = '/images/default/corgidon.png';
+                                       break;
+
+                               case 'diaspora':
+                                       /**
+                                        * Picture credits
+                                        * @license GNU Affero General Public License v3.0
+                                        * @link    https://github.com/diaspora/diaspora/
+                                        */
+                                       $default = '/images/default/diaspora.png';
+                                       break;
+
+                               case 'gotosocial':
+                                       /**
+                                        * Picture credits
+                                        * @license GNU Affero General Public License v3.0
+                                        * @link    https://github.com/superseriousbusiness/gotosocial/blob/main/web/assets/default_avatars/GoToSocial_icon1.svg
+                                        */
+                                       $default = '/images/default/gotosocial.svg';
+                                       break;
+
+                               case 'hometown':
+                                       /**
+                                        * Picture credits
+                                        * @license GNU Affero General Public License v3.0
+                                        * @link    https://github.com/hometown-fork/hometown/blob/hometown-dev/public/avatars/original/missing.png
+                                        */
+                                       $default = '/images/default/hometown.png';
+                                       break;
+
+                               case 'koyuspace':
+                                       /**
+                                        * Picture credits
+                                        * @license GNU Affero General Public License v3.0
+                                        * @link    https://github.com/koyuspace/mastodon/blob/main/public/avatars/original/missing.png
+                                        */
+                                       $default = '/images/default/koyuspace.png';
+                                       break;
+
+                               case 'ecko':
+                               case 'qoto':
+                               case 'mastodon':
+                                       /**
+                                        * Picture credits
+                                        * @license GNU Affero General Public License v3.0
+                                        * @link    https://github.com/mastodon/mastodon/tree/main/public/avatars/original/missing.png
+                                        */
+                                       $default = '/images/default/mastodon.png';
+                                       break;
+
+                               case 'peertube':
+                                       if ($type == Contact::TYPE_COMMUNITY) {
+                                               /**
+                                                * Picture credits
+                                                * @license GNU Affero General Public License v3.0
+                                                * @link    https://github.com/Chocobozzz/PeerTube/blob/develop/client/src/assets/images/default-avatar-video-channel.png
+                                                */
+                                               $default = '/images/default/peertube-channel.png';
+                                       } else {
+                                               /**
+                                                * Picture credits
+                                                * @license GNU Affero General Public License v3.0
+                                                * @link    https://github.com/Chocobozzz/PeerTube/blob/develop/client/src/assets/images/default-avatar-account.png
+                                                */
+                                               $default = '/images/default/peertube-account.png';
+                                       }
+                                       break;
+
+                               case 'pleroma':
+                                       /**
+                                        * Picture credits
+                                        * @license GNU Affero General Public License v3.0
+                                        * @link    https://git.pleroma.social/pleroma/pleroma/-/blob/develop/priv/static/images/avi.png
+                                        */
+                                       $default = '/images/default/pleroma.png';
+                                       break;
+
+                               case 'plume':
+                                       /**
+                                        * Picture credits
+                                        * @license GNU Affero General Public License v3.0
+                                        * @link    https://github.com/Plume-org/Plume/blob/main/assets/images/default-avatar.png
+                                        */
+                                       $default = '/images/default/plume.png';
+                                       break;
+                       }
                        return DI::baseUrl() . $default;
                }
 
@@ -2049,7 +2158,7 @@ class Contact
                        }
                } else {
                        Photo::delete(['uid' => $uid, 'contact-id' => $cid, 'photo-type' => Photo::CONTACT_AVATAR]);
-                       $fields = Avatar::fetchAvatarContact($contact, $avatar);
+                       $fields = Avatar::fetchAvatarContact($contact, $avatar, $force);
                        $update = ($avatar . $fields['photo'] . $fields['thumb'] . $fields['micro'] != $contact['avatar'] . $contact['photo'] . $contact['thumb'] . $contact['micro']) || $force;
                }
 
@@ -2448,7 +2557,7 @@ class Contact
         * @throws HTTPException\InternalServerErrorException
         * @throws \ImagickException
         */
-       public static function updateFromProbeByURL($url)
+       public static function updateFromProbeByURL(string $url): int
        {
                $id = self::getIdForURL($url);
 
@@ -2469,7 +2578,7 @@ class Contact
         * @param string $network Network of that contact
         * @return string with protocol
         */
-       public static function getProtocol($url, $network)
+       public static function getProtocol(string $url, string $network): string
        {
                if ($network != Protocol::DFRN) {
                        return $network;
@@ -2505,7 +2614,7 @@ class Contact
         * @throws HTTPException\NotFoundException
         * @throws \ImagickException
         */
-       public static function createFromProbeForUser(int $uid, $url, $network = '')
+       public static function createFromProbeForUser(int $uid, string $url, string $network = ''): array
        {
                $result = ['cid' => -1, 'success' => false, 'message' => ''];
 
@@ -2542,6 +2651,11 @@ class Contact
                } else {
                        $probed = true;
                        $ret = Probe::uri($url, $network, $uid);
+
+                       // Ensure that the public contact exists
+                       if ($ret['network'] != Protocol::PHANTOM) {
+                               self::getIdForURL($url);
+                       }
                }
 
                if (($network != '') && ($ret['network'] != $network)) {
@@ -2689,7 +2803,7 @@ class Contact
         * @throws HTTPException\InternalServerErrorException
         * @throws \ImagickException
         */
-       public static function addRelationship(array $importer, array $contact, array $datarray, $sharing = false, $note = '')
+       public static function addRelationship(array $importer, array $contact, array $datarray, bool $sharing = false, string $note = '')
        {
                // Should always be set
                if (empty($datarray['author-id'])) {
@@ -2831,6 +2945,7 @@ class Contact
         * Update the local relationship when a local user loses a follower
         *
         * @param array $contact User-specific contact (uid != 0) array
+        * @return void
         * @throws HTTPException\InternalServerErrorException
         * @throws \ImagickException
         */
@@ -2916,7 +3031,7 @@ class Contact
         * @return array
         * @throws \Exception
         */
-       public static function pruneUnavailable(array $contact_ids)
+       public static function pruneUnavailable(array $contact_ids): array
        {
                if (empty($contact_ids)) {
                        return [];
@@ -2944,7 +3059,7 @@ class Contact
         * @throws HTTPException\InternalServerErrorException
         * @throws \ImagickException
         */
-       public static function magicLink($contact_url, $url = '')
+       public static function magicLink(string $contact_url, string $url = ''): string
        {
                if (!Session::isAuthenticated()) {
                        return $url ?: $contact_url; // Equivalent to: ($url != '') ? $url : $contact_url;
@@ -2971,7 +3086,7 @@ class Contact
         * @throws HTTPException\InternalServerErrorException
         * @throws \ImagickException
         */
-       public static function magicLinkById($cid, $url = '')
+       public static function magicLinkById(int $cid, string $url = ''): string
        {
                $contact = DBA::selectFirst('contact', ['id', 'network', 'url', 'uid'], ['id' => $cid]);
 
@@ -2988,7 +3103,7 @@ class Contact
         * @throws HTTPException\InternalServerErrorException
         * @throws \ImagickException
         */
-       public static function magicLinkByContact($contact, $url = '')
+       public static function magicLinkByContact(array $contact, string $url = ''): string
        {
                $destination = $url ?: $contact['url']; // Equivalent to ($url != '') ? $url : $contact['url'];
 
@@ -3029,7 +3144,7 @@ class Contact
         *
         * @return boolean "true" if it is a forum
         */
-       public static function isForum($contactid)
+       public static function isForum(int $contactid): bool
        {
                $fields = ['contact-type'];
                $condition = ['id' => $contactid];
@@ -3048,7 +3163,7 @@ class Contact
         * @param array $contact
         * @return bool
         */
-       public static function canReceivePrivateMessages(array $contact)
+       public static function canReceivePrivateMessages(array $contact): bool
        {
                $protocol = $contact['network'] ?? $contact['protocol'] ?? Protocol::PHANTOM;
                $self = $contact['self'] ?? false;
@@ -3066,7 +3181,7 @@ class Contact
         * @return array with search results
         * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
-       public static function searchByName(string $search, string $mode = '', int $uid = 0)
+       public static function searchByName(string $search, string $mode = '', int $uid = 0): array
        {
                if (empty($search)) {
                        return [];
@@ -3109,7 +3224,7 @@ class Contact
         * @param array $urls
         * @return array result "count", "added" and "updated"
         */
-       public static function addByUrls(array $urls)
+       public static function addByUrls(array $urls): array
        {
                $added = 0;
                $updated = 0;
@@ -3142,7 +3257,7 @@ class Contact
         * @return array The profile array
         * @throws Exception
         */
-       public static function getRandomContact()
+       public static function getRandomContact(): array
        {
                $contact = DBA::selectFirst('contact', ['id', 'network', 'url', 'uid'], [
                        "`uid` = ? AND `network` = ? AND NOT `failed` AND `last-item` > ?",