]> git.mxchange.org Git - friendica.git/blobdiff - src/Model/Profile.php
Add explicit parameter to IHandleUserSession->setvisitorContacts
[friendica.git] / src / Model / Profile.php
index aa027a860b43fc69eb0d0a102926a24bb7ba4723..e6c8e4822d17d3df1d47f75579b0d98fabd70849 100644 (file)
@@ -1,6 +1,6 @@
 <?php
 /**
- * @copyright Copyright (C) 2010-2022, the Friendica project
+ * @copyright Copyright (C) 2010-2023, the Friendica project
  *
  * @license GNU AGPL version 3 or any later version
  *
@@ -30,7 +30,6 @@ use Friendica\Core\Logger;
 use Friendica\Core\Protocol;
 use Friendica\Core\Renderer;
 use Friendica\Core\Search;
-use Friendica\Core\Session;
 use Friendica\Core\System;
 use Friendica\Core\Worker;
 use Friendica\Database\DBA;
@@ -54,10 +53,10 @@ class Profile
         *
         * @param integer User ID
         *
-        * @return array Profile data
+        * @return array|bool Profile data or false on error
         * @throws \Exception
         */
-       public static function getByUID($uid)
+       public static function getByUID(int $uid)
        {
                return DBA::selectFirst('profile', [], ['uid' => $uid]);
        }
@@ -69,7 +68,7 @@ class Profile
         * @param int $id The contact owner ID
         * @param array $fields The selected fields
         *
-        * @return array Profile data for the ID
+        * @return array|bool Profile data for the ID or false on error
         * @throws \Exception
         */
        public static function getById(int $uid, int $id, array $fields = [])
@@ -81,7 +80,7 @@ class Profile
         * Returns profile data for the contact owner
         *
         * @param int $uid The User ID
-        * @param array $fields The fields to retrieve
+        * @param array|bool $fields The fields to retrieve or false on error
         *
         * @return array Array of profile data
         * @throws \Exception
@@ -94,9 +93,10 @@ class Profile
        /**
         * Update a profile entry and distribute the changes if needed
         *
-        * @param array $fields
-        * @param integer $uid
-        * @return boolean
+        * @param array $fields Profile fields to update
+        * @param integer $uid User id
+        *
+        * @return boolean Whether update was successful
         */
        public static function update(array $fields, int $uid): bool
        {
@@ -136,8 +136,11 @@ class Profile
 
        /**
         * Publish a changed profile
-        * @param int  $uid
+        *
+        * @param int  $uid User id
         * @param bool $force Force publishing to the directory
+        *
+        * @return void
         */
        public static function publishUpdate(int $uid, bool $force = false)
        {
@@ -149,11 +152,11 @@ class Profile
                if ($owner['net-publish'] || $force) {
                        // Update global directory in background
                        if (Search::getGlobalDirectory()) {
-                               Worker::add(PRIORITY_LOW, 'Directory', $owner['url']);
+                               Worker::add(Worker::PRIORITY_LOW, 'Directory', $owner['url']);
                        }
                }
 
-               Worker::add(PRIORITY_LOW, 'ProfileUpdate', $uid);
+               Worker::add(Worker::PRIORITY_LOW, 'ProfileUpdate', $uid);
        }
 
        /**
@@ -163,7 +166,7 @@ class Profile
         *
         * @return string Location string
         */
-       public static function formatLocation(array $profile)
+       public static function formatLocation(array $profile): string
        {
                $location = '';
 
@@ -211,16 +214,16 @@ class Profile
         * @param App    $a
         * @param string $nickname string
         * @param bool   $show_contacts
-        * @return array Profile
         *
+        * @return array Profile
         * @throws HTTPException\NotFoundException
         * @throws HTTPException\InternalServerErrorException
         * @throws \ImagickException
         */
-       public static function load(App $a, string $nickname, bool $show_contacts = true)
+       public static function load(App $a, string $nickname, bool $show_contacts = true): array
        {
                $profile = User::getOwnerDataByNick($nickname);
-               if (empty($profile) || $profile['account_removed']) {
+               if (!isset($profile['account_removed']) || $profile['account_removed']) {
                        Logger::info('profile error: ' . DI::args()->getQueryString());
                        return [];
                }
@@ -235,9 +238,9 @@ class Profile
 
                DI::page()['title'] = $profile['name'] . ' @ ' . DI::config()->get('config', 'sitename');
 
-               if (!local_user()) {
+               if (!DI::userSession()->getLocalUserId()) {
                        $a->setCurrentTheme($profile['theme']);
-                       $a->setCurrentMobileTheme(DI::pConfig()->get($a->getProfileOwner(), 'system', 'mobile_theme'));
+                       $a->setCurrentMobileTheme(DI::pConfig()->get($a->getProfileOwner(), 'system', 'mobile_theme') ?? '');
                }
 
                /*
@@ -251,7 +254,7 @@ class Profile
                        require_once $theme_info_file;
                }
 
-               $block = (DI::config()->get('system', 'block_public') && !Session::isAuthenticated());
+               $block = (DI::config()->get('system', 'block_public') && !DI::userSession()->isAuthenticated());
 
                /**
                 * @todo
@@ -284,15 +287,15 @@ class Profile
         * @hooks 'profile_sidebar'
         *      array $arr
         */
-       public static function getVCardHtml(array $profile, bool $block, bool $show_contacts)
+       public static function getVCardHtml(array $profile, bool $block, bool $show_contacts): string
        {
                $o = '';
                $location = false;
 
                $profile_contact = [];
 
-               if (local_user() && ($profile['uid'] ?? 0) != local_user()) {
-                       $profile_contact = Contact::getByURL($profile['nurl'], null, [], local_user());
+               if (DI::userSession()->getLocalUserId() && ($profile['uid'] ?? 0) != DI::userSession()->getLocalUserId()) {
+                       $profile_contact = Contact::getByURL($profile['nurl'], null, [], DI::userSession()->getLocalUserId());
                }
                if (!empty($profile['cid']) && self::getMyURL()) {
                        $profile_contact = Contact::selectFirst([], ['id' => $profile['cid']]);
@@ -331,14 +334,14 @@ class Profile
                if (!$local_user_is_self) {
                        if (!$visitor_is_authenticated) {
                                // Remote follow is only available for local profiles
-                               if (!empty($profile['nickname']) && strpos($profile_url, DI::baseUrl()->get()) === 0) {
-                                       $follow_link = 'remote_follow/' . $profile['nickname'];
+                               if (!empty($profile['nickname']) && strpos($profile_url, (string)DI::baseUrl()) === 0) {
+                                       $follow_link = 'profile/' . $profile['nickname'] . '/remote_follow';
                                }
                        } else {
                                if ($visitor_is_following) {
-                                       $unfollow_link = $visitor_base_path . '/unfollow?url=' . urlencode($profile_url) . '&auto=1';
+                                       $unfollow_link = $visitor_base_path . '/contact/unfollow?url=' . urlencode($profile_url) . '&auto=1';
                                } else {
-                                       $follow_link =  $visitor_base_path .'/follow?url=' . urlencode($profile_url) . '&auto=1';
+                                       $follow_link = $visitor_base_path . '/contact/follow?url=' . urlencode($profile_url) . '&auto=1';
                                }
                        }
 
@@ -346,7 +349,7 @@ class Profile
                                if ($visitor_is_followed || $visitor_is_following) {
                                        $wallmessage_link = $visitor_base_path . '/message/new/' . $profile_contact['id'];
                                } elseif ($visitor_is_authenticated && !empty($profile['unkmail'])) {
-                                       $wallmessage_link = 'wallmessage/' . $profile['nickname'];
+                                       $wallmessage_link = 'profile/' . $profile['nickname'] . '/unkmail';
                                }
                        }
                }
@@ -375,7 +378,7 @@ class Profile
                $xmpp     = !empty($profile['xmpp'])     ? DI::l10n()->t('XMPP:')     : false;
                $matrix   = !empty($profile['matrix'])   ? DI::l10n()->t('Matrix:')   : false;
 
-               if ((!empty($profile['hidewall']) || $block) && !Session::isAuthenticated()) {
+               if ((!empty($profile['hidewall']) || $block) && !DI::userSession()->isAuthenticated()) {
                        $location = $homepage = $about = false;
                }
 
@@ -385,16 +388,16 @@ class Profile
 
                if (!empty($profile['guid'])) {
                        $diaspora = [
-                               'guid' => $profile['guid'],
-                               'podloc' => DI::baseUrl(),
+                               'guid'       => $profile['guid'],
+                               'podloc'     => DI::baseUrl(),
                                'searchable' => ($profile['net-publish'] ? 'true' : 'false'),
-                               'nickname' => $profile['nickname'],
-                               'fullname' => $profile['name'],
-                               'firstname' => $firstname,
-                               'lastname' => $lastname,
-                               'photo300' => $profile['photo'] ?? '',
-                               'photo100' => $profile['thumb'] ?? '',
-                               'photo50' => $profile['micro'] ?? '',
+                               'nickname'   => $profile['nickname'],
+                               'fullname'   => $profile['name'],
+                               'firstname'  => $firstname,
+                               'lastname'   => $lastname,
+                               'photo300'   => $profile['photo'] ?? '',
+                               'photo100'   => $profile['thumb'] ?? '',
+                               'photo50'    => $profile['micro'] ?? '',
                        ];
                } else {
                        $diaspora = false;
@@ -409,17 +412,17 @@ class Profile
                }
 
                if (!$block && $show_contacts) {
-                       $contact_block = ContactBlock::getHTML($profile, local_user());
+                       $contact_block = ContactBlock::getHTML($profile, DI::userSession()->getLocalUserId());
 
                        if (is_array($profile) && !$profile['hide-friends']) {
                                $contact_count = DBA::count('contact', [
-                                       'uid' => $profile['uid'],
-                                       'self' => false,
+                                       'uid'     => $profile['uid'],
+                                       'self'    => false,
                                        'blocked' => false,
                                        'pending' => false,
-                                       'hidden' => false,
+                                       'hidden'  => false,
                                        'archive' => false,
-                                       'failed' => false,
+                                       'failed'  => false,
                                        'network' => Protocol::FEDERATED,
                                ]);
                        }
@@ -428,7 +431,7 @@ class Profile
                // Expected profile/vcard.tpl profile.* template variables
                $p = [
                        'address' => null,
-                       'edit' => null,
+                       'edit'    => null,
                        'upubkey' => null,
                ];
                foreach ($profile as $k => $v) {
@@ -448,6 +451,10 @@ class Profile
 
                $p['url'] = Contact::magicLinkById($cid, $profile['url']);
 
+               if (!isset($profile['hidewall'])) {
+                       Logger::warning('Missing hidewall key in profile array', ['profile' => $profile, 'callstack' => System::callstack(10)]);
+               }
+
                $tpl = Renderer::getMarkupTemplate('profile/vcard.tpl');
                $o .= Renderer::replaceMacros($tpl, [
                        '$profile' => $p,
@@ -458,12 +465,13 @@ class Profile
                        '$unfollow' => DI::l10n()->t('Unfollow'),
                        '$unfollow_link' => $unfollow_link,
                        '$subscribe_feed' => DI::l10n()->t('Atom feed'),
-                       '$subscribe_feed_link' => $profile['poll'],
+                       '$subscribe_feed_link' => $profile['hidewall'] ?? 0 ? '' : $profile['poll'],
                        '$wallmessage' => DI::l10n()->t('Message'),
                        '$wallmessage_link' => $wallmessage_link,
                        '$account_type' => $account_type,
                        '$location' => $location,
                        '$homepage' => $homepage,
+                       '$homepage_verified' => DI::l10n()->t('This website has been verified to belong to the same person.'),
                        '$about' => $about,
                        '$network' => DI::l10n()->t('Network:'),
                        '$contacts' => $contact_count,
@@ -483,14 +491,13 @@ class Profile
         * Returns the upcoming birthdays of contacts of the current user as HTML content
         *
         * @return string The upcoming birthdays (HTML)
-        *
         * @throws HTTPException\InternalServerErrorException
         * @throws HTTPException\ServiceUnavailableException
         * @throws \ImagickException
         */
        public static function getBirthdays(): string
        {
-               if (!local_user() || DI::mode()->isMobile() || DI::mode()->isMobile()) {
+               if (!DI::userSession()->getLocalUserId() || DI::mode()->isMobile() || DI::mode()->isMobile()) {
                        return '';
                }
 
@@ -503,7 +510,7 @@ class Profile
 
                $bd_short = DI::l10n()->t('F d');
 
-               $cacheKey = 'get_birthdays:' . local_user();
+               $cacheKey = 'get_birthdays:' . DI::userSession()->getLocalUserId();
                $events   = DI::cache()->get($cacheKey);
                if (is_null($events)) {
                        $result = DBA::p(
@@ -520,7 +527,7 @@ class Profile
                                ORDER BY `start`",
                                Contact::SHARING,
                                Contact::FRIEND,
-                               local_user(),
+                               DI::userSession()->getLocalUserId(),
                                DateTimeFormat::utc('now + 6 days'),
                                DateTimeFormat::utcNow()
                        );
@@ -582,12 +589,17 @@ class Profile
                ]);
        }
 
-       public static function getEventsReminderHTML()
+       /**
+        * Renders HTML for event reminder (e.g. contact birthdays
+        *
+        * @return string Rendered HTML
+        */
+       public static function getEventsReminderHTML(): string
        {
                $a = DI::app();
                $o = '';
 
-               if (!local_user() || DI::mode()->isMobile() || DI::mode()->isMobile()) {
+               if (!DI::userSession()->getLocalUserId() || DI::mode()->isMobile() || DI::mode()->isMobile()) {
                        return $o;
                }
 
@@ -602,7 +614,7 @@ class Profile
                $classtoday = '';
 
                $condition = ["`uid` = ? AND `type` != 'birthday' AND `start` < ? AND `start` >= ?",
-                       local_user(), DateTimeFormat::utc('now + 7 days'), DateTimeFormat::utc('now - 1 days')];
+                       DI::userSession()->getLocalUserId(), DateTimeFormat::utc('now + 7 days'), DateTimeFormat::utc('now - 1 days')];
                $s = DBA::select('event', [], $condition, ['order' => ['start']]);
 
                $r = [];
@@ -612,7 +624,7 @@ class Profile
                        $total = 0;
 
                        while ($rr = DBA::fetch($s)) {
-                               $condition = ['parent-uri' => $rr['uri'], 'uid' => $rr['uid'], 'author-id' => public_contact(),
+                               $condition = ['parent-uri' => $rr['uri'], 'uid' => $rr['uid'], 'author-id' => DI::userSession()->getPublicContactId(),
                                        'vid' => [Verb::getID(Activity::ATTEND), Verb::getID(Activity::ATTENDMAYBE)],
                                        'visible' => true, 'deleted' => false];
                                if (!Post::exists($condition)) {
@@ -672,10 +684,11 @@ class Profile
         * Retrieves the my_url session variable
         *
         * @return string
+        * @deprecated since version 2022.12, please use UserSession->getMyUrl instead
         */
-       public static function getMyURL()
+       public static function getMyURL(): string
        {
-               return Session::get('my_url');
+               return DI::userSession()->getMyUrl();
        }
 
        /**
@@ -694,6 +707,8 @@ class Profile
         * It would be favourable to harmonize the two implementations.
         *
         * @param App $a Application instance.
+        *
+        * @return void
         * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         * @throws \ImagickException
         */
@@ -702,7 +717,7 @@ class Profile
                $my_url = self::getMyURL();
                $my_url = Network::isUrlValid($my_url);
 
-               if (empty($my_url) || local_user()) {
+               if (empty($my_url) || DI::userSession()->getLocalUserId()) {
                        return;
                }
 
@@ -720,7 +735,7 @@ class Profile
 
                $contact = DBA::selectFirst('contact',['id', 'url'], ['id' => $cid]);
 
-               if (DBA::isResult($contact) && remote_user() && remote_user() == $contact['id']) {
+               if (DBA::isResult($contact) && DI::userSession()->getRemoteUserId() && DI::userSession()->getRemoteUserId() == $contact['id']) {
                        Logger::info('The visitor ' . $my_url . ' is already authenticated');
                        return;
                }
@@ -741,13 +756,13 @@ class Profile
                $query = rtrim(str_replace($addr_request, '', DI::args()->getQueryString()), '?&');
 
                // The other instance needs to know where to redirect.
-               $dest = urlencode(DI::baseUrl()->get() . '/' . $query);
+               $dest = urlencode(DI::baseUrl() . '/' . $query);
 
                // We need to extract the basebath from the profile url
                // to redirect the visitors '/magic' module.
                $basepath = Contact::getBasepath($contact['url']);
 
-               if ($basepath != DI::baseUrl()->get() && !strstr($dest, '/magic')) {
+               if ($basepath != DI::baseUrl() && !strstr($dest, '/magic')) {
                        $magic_path = $basepath . '/magic' . '?owa=1&dest=' . $dest . '&' . $addr_request;
 
                        // We have to check if the remote server does understand /magic without invoking something
@@ -763,9 +778,10 @@ class Profile
         * Set the visitor cookies (see remote_user()) for the given handle
         *
         * @param string $handle Visitor handle
+        *
         * @return array Visitor contact array
         */
-       public static function addVisitorCookieForHandle($handle)
+       public static function addVisitorCookieForHandle(string $handle): array
        {
                $a = DI::app();
 
@@ -779,14 +795,16 @@ class Profile
                $visitor = Contact::getById($cid);
 
                // Authenticate the visitor.
-               $_SESSION['authenticated'] = 1;
-               $_SESSION['visitor_id'] = $visitor['id'];
-               $_SESSION['visitor_handle'] = $visitor['addr'];
-               $_SESSION['visitor_home'] = $visitor['url'];
-               $_SESSION['my_url'] = $visitor['url'];
-               $_SESSION['remote_comment'] = $visitor['subscribe'];
+               DI::userSession()->setMultiple([
+                       'authenticated'  => 1,
+                       'visitor_id'     => $visitor['id'],
+                       'visitor_handle' => $visitor['addr'],
+                       'visitor_home'   => $visitor['url'],
+                       'my_url'         => $visitor['url'],
+                       'remote_comment' => $visitor['subscribe'],
+               ]);
 
-               Session::setVisitorsContacts();
+               DI::userSession()->setVisitorsContacts($visitor['url']);
 
                $a->setContactId($visitor['id']);
 
@@ -797,9 +815,10 @@ class Profile
 
        /**
         * Set the visitor cookies (see remote_user()) for signed HTTP requests
+        (
         * @return array Visitor contact array
         */
-       public static function addVisitorCookieForHTTPSigner()
+       public static function addVisitorCookieForHTTPSigner(): array
        {
                $requester = HTTPSignature::getSigner('', $_SERVER);
                if (empty($requester)) {
@@ -814,10 +833,12 @@ class Profile
         * Ported from Hubzilla: https://framagit.org/hubzilla/core/blob/master/include/zid.php
         *
         * @param string $token
+        *
+        * @return void
         * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         * @throws \ImagickException
         */
-       public static function openWebAuthInit($token)
+       public static function openWebAuthInit(string $token)
        {
                $a = DI::app();
 
@@ -851,28 +872,39 @@ class Profile
 
                $a->setContactId($arr['visitor']['id']);
 
-               info(DI::l10n()->t('OpenWebAuth: %1$s welcomes %2$s', DI::baseUrl()->getHostname(), $visitor['name']));
+               DI::sysmsg()->addInfo(DI::l10n()->t('OpenWebAuth: %1$s welcomes %2$s', DI::baseUrl()->getHost(), $visitor['name']));
 
                Logger::info('OpenWebAuth: auth success from ' . $visitor['addr']);
        }
 
-       public static function zrl($s, $force = false)
+       /**
+        * Returns URL with URL-encoded zrl parameter
+        *
+        * @param string $url   URL to enhance
+        * @param bool   $force Either to force adding zrl parameter
+        *
+        * @return string URL with 'zrl' parameter or original URL in case of no Friendica profile URL
+        */
+       public static function zrl(string $url, bool $force = false): string
        {
-               if (!strlen($s)) {
-                       return $s;
+               if (!strlen($url)) {
+                       return $url;
                }
-               if (!strpos($s, '/profile/') && !$force) {
-                       return $s;
+               if (!strpos($url, '/profile/') && !$force) {
+                       return $url;
                }
-               if ($force && substr($s, -1, 1) !== '/') {
-                       $s = $s . '/';
+               if ($force && substr($url, -1, 1) !== '/') {
+                       $url = $url . '/';
                }
-               $achar = strpos($s, '?') ? '&' : '?';
+
+               $achar = strpos($url, '?') ? '&' : '?';
                $mine = self::getMyURL();
-               if ($mine && !Strings::compareLink($mine, $s)) {
-                       return $s . $achar . 'zrl=' . urlencode($mine);
+
+               if ($mine && !Strings::compareLink($mine, $url)) {
+                       return $url . $achar . 'zrl=' . urlencode($mine);
                }
-               return $s;
+
+               return $url;
        }
 
        /**
@@ -884,27 +916,28 @@ class Profile
         * want to see anybody else's theme settings except their own while on this site.
         *
         * @param App $a
+        *
         * @return int user ID
         *
         * @note Returns local_user instead of user ID if "always_my_theme" is set to true
         */
        public static function getThemeUid(App $a): int
        {
-               return local_user() ?: $a->getProfileOwner();
+               return DI::userSession()->getLocalUserId() ?: $a->getProfileOwner();
        }
 
        /**
         * search for Profiles
         *
-        * @param int  $start
-        * @param int  $count
-        * @param null $search
+        * @param int  $start Starting record (see LIMIT start,count)
+        * @param int  $count Maximum records (see LIMIT start,count)
+        * @param string $search Optional search word (see LIKE %s?%s)
         *
         * @return array [ 'total' => 123, 'entries' => [...] ];
         *
         * @throws \Exception
         */
-       public static function searchProfiles($start = 0, $count = 100, $search = null)
+       public static function searchProfiles(int $start = 0, int $count = 100, string $search = null): array
        {
                if (!empty($search)) {
                        $publish = (DI::config()->get('system', 'publish_all') ? '' : "AND `publish` ");
@@ -945,6 +978,8 @@ class Profile
         * Multi profiles are converted to ACl-protected custom fields and deleted.
         *
         * @param array $profile One profile array
+        *
+        * @return void
         * @throws \Exception
         */
        public static function migrate(array $profile)