]> git.mxchange.org Git - friendica.git/blobdiff - src/Model/Profile.php
Use the cached activity function
[friendica.git] / src / Model / Profile.php
index cb7fa65479513f7ea99967fcbd6c491d227ee9f2..094df729e79d3cc79266cfca91cdad5ef06579bc 100644 (file)
@@ -35,6 +35,8 @@ use Friendica\Core\System;
 use Friendica\Core\Worker;
 use Friendica\Database\DBA;
 use Friendica\DI;
+use Friendica\Network\HTTPClient\Client\HttpClientAccept;
+use Friendica\Network\HTTPClient\Client\HttpClientOptions;
 use Friendica\Network\HTTPException;
 use Friendica\Protocol\Activity;
 use Friendica\Protocol\Diaspora;
@@ -52,10 +54,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]);
        }
@@ -67,7 +69,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 = [])
@@ -79,7 +81,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
@@ -92,9 +94,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
        {
@@ -134,8 +137,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)
        {
@@ -161,7 +167,7 @@ class Profile
         *
         * @return string Location string
         */
-       public static function formatLocation(array $profile)
+       public static function formatLocation(array $profile): string
        {
                $location = '';
 
@@ -209,16 +215,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)) {
+               if (!isset($profile['account_removed']) || $profile['account_removed']) {
                        Logger::info('profile error: ' . DI::args()->getQueryString());
                        return [];
                }
@@ -233,9 +239,9 @@ class Profile
 
                DI::page()['title'] = $profile['name'] . ' @ ' . DI::config()->get('config', 'sitename');
 
-               if (!DI::pConfig()->get(local_user(), 'system', 'always_my_theme')) {
+               if (!local_user()) {
                        $a->setCurrentTheme($profile['theme']);
-                       $a->setCurrentMobileTheme(DI::pConfig()->get($a->getProfileOwner(), 'system', 'mobile_theme'));
+                       $a->setCurrentMobileTheme(DI::pConfig()->get($a->getProfileOwner(), 'system', 'mobile_theme') ?? '');
                }
 
                /*
@@ -282,7 +288,7 @@ 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;
@@ -362,7 +368,7 @@ class Profile
                }
 
                // Fetch the account type
-               $account_type = Contact::getAccountType($profile);
+               $account_type = Contact::getAccountType($profile['account-type']);
 
                if (!empty($profile['address']) || !empty($profile['location'])) {
                        $location = DI::l10n()->t('Location:');
@@ -383,16 +389,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;
@@ -411,13 +417,13 @@ class Profile
 
                        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,
                                ]);
                        }
@@ -426,7 +432,7 @@ class Profile
                // Expected profile/vcard.tpl profile.* template variables
                $p = [
                        'address' => null,
-                       'edit' => null,
+                       'edit'    => null,
                        'upubkey' => null,
                ];
                foreach ($profile as $k => $v) {
@@ -481,7 +487,6 @@ 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
@@ -580,7 +585,12 @@ 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 = '';
@@ -671,9 +681,9 @@ class Profile
         *
         * @return string
         */
-       public static function getMyURL()
+       public static function getMyURL(): string
        {
-               return Session::get('my_url');
+               return Session::get('my_url') ?? '';
        }
 
        /**
@@ -692,6 +702,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
         */
@@ -749,7 +761,7 @@ class Profile
                        $magic_path = $basepath . '/magic' . '?owa=1&dest=' . $dest . '&' . $addr_request;
 
                        // We have to check if the remote server does understand /magic without invoking something
-                       $serverret = DI::httpClient()->get($basepath . '/magic');
+                       $serverret = DI::httpClient()->head($basepath . '/magic', [HttpClientOptions::ACCEPT_CONTENT => HttpClientAccept::HTML]);
                        if ($serverret->isSuccess()) {
                                Logger::info('Doing magic auth for visitor ' . $my_url . ' to ' . $magic_path);
                                System::externalRedirect($magic_path);
@@ -761,9 +773,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();
 
@@ -795,9 +808,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)) {
@@ -812,10 +826,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();
 
@@ -854,23 +870,34 @@ class Profile
                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;
        }
 
        /**
@@ -878,37 +905,32 @@ class Profile
         *
         * Used from within PCSS themes to set theme parameters. If there's a
         * profile_uid variable set in App, that is the "page owner" and normally their theme
-        * settings take precedence; unless a local user sets the "always_my_theme"
-        * system pconfig, which means they don't want to see anybody else's theme
-        * settings except their own while on this site.
+        * settings take precedence; unless a local user is logged in which means they don't
+        * want to see anybody else's theme settings except their own while on this site.
+        *
+        * @param App $a
         *
         * @return int user ID
         *
-        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         * @note Returns local_user instead of user ID if "always_my_theme" is set to true
         */
-       public static function getThemeUid(App $a)
+       public static function getThemeUid(App $a): int
        {
-               $uid = !empty($a->getProfileOwner()) ? intval($a->getProfileOwner()) : 0;
-               if (local_user() && (DI::pConfig()->get(local_user(), 'system', 'always_my_theme') || !$uid)) {
-                       return local_user();
-               }
-
-               return $uid;
+               return local_user() ?: $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` ");
@@ -949,6 +971,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)