3 * @copyright Copyright (C) 2010-2023, the Friendica project
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Model;
25 use Friendica\Content\Text\BBCode;
26 use Friendica\Content\Widget\ContactBlock;
27 use Friendica\Core\Cache\Enum\Duration;
28 use Friendica\Core\Hook;
29 use Friendica\Core\Logger;
30 use Friendica\Core\Protocol;
31 use Friendica\Core\Renderer;
32 use Friendica\Core\Search;
33 use Friendica\Core\System;
34 use Friendica\Core\Worker;
35 use Friendica\Database\DBA;
37 use Friendica\Network\HTTPClient\Client\HttpClientAccept;
38 use Friendica\Network\HTTPClient\Client\HttpClientOptions;
39 use Friendica\Network\HTTPException;
40 use Friendica\Network\HTTPException\InternalServerErrorException;
41 use Friendica\Protocol\Activity;
42 use Friendica\Protocol\Diaspora;
43 use Friendica\Security\PermissionSet\Entity\PermissionSet;
44 use Friendica\Util\DateTimeFormat;
45 use Friendica\Util\HTTPSignature;
46 use Friendica\Util\Network;
47 use Friendica\Util\Proxy;
48 use Friendica\Util\Strings;
53 * Returns default profile for a given user id
55 * @param integer User ID
57 * @return array|bool Profile data or false on error
60 public static function getByUID(int $uid)
62 return DBA::selectFirst('profile', [], ['uid' => $uid]);
66 * Returns default profile for a given user ID and ID
68 * @param int $uid The contact ID
69 * @param int $id The contact owner ID
70 * @param array $fields The selected fields
72 * @return array|bool Profile data for the ID or false on error
75 public static function getById(int $uid, int $id, array $fields = [])
77 return DBA::selectFirst('profile', $fields, ['uid' => $uid, 'id' => $id]);
81 * Returns profile data for the contact owner
83 * @param int $uid The User ID
84 * @param array|bool $fields The fields to retrieve or false on error
86 * @return array Array of profile data
89 public static function getListByUser(int $uid, array $fields = [])
91 return DBA::selectToArray('profile', $fields, ['uid' => $uid]);
95 * Update a profile entry and distribute the changes if needed
97 * @param array $fields Profile fields to update
98 * @param integer $uid User id
100 * @return boolean Whether update was successful
103 public static function update(array $fields, int $uid): bool
105 $old_owner = User::getOwnerDataById($uid);
106 if (empty($old_owner)) {
110 if (!DBA::update('profile', $fields, ['uid' => $uid])) {
114 $update = Contact::updateSelfFromUserID($uid);
116 $owner = User::getOwnerDataById($uid);
121 $profile_fields = ['postal-code', 'dob', 'prv_keywords', 'homepage'];
122 foreach ($profile_fields as $field) {
123 if ($old_owner[$field] != $owner[$field]) {
129 self::publishUpdate($uid, ($old_owner['net-publish'] != $owner['net-publish']));
136 * Publish a changed profile
138 * @param int $uid User id
139 * @param bool $force Force publishing to the directory
143 public static function publishUpdate(int $uid, bool $force = false)
145 $owner = User::getOwnerDataById($uid);
150 if ($owner['net-publish'] || $force) {
151 // Update global directory in background
152 if (Search::getGlobalDirectory()) {
153 Worker::add(Worker::PRIORITY_LOW, 'Directory', $owner['url']);
157 Worker::add(Worker::PRIORITY_LOW, 'ProfileUpdate', $uid);
161 * Returns a formatted location string from the given profile array
163 * @param array $profile Profile array (Generated from the "profile" table)
165 * @return string Location string
167 public static function formatLocation(array $profile): string
171 if (!empty($profile['locality'])) {
172 $location .= $profile['locality'];
175 if (!empty($profile['region']) && (($profile['locality'] ?? '') != $profile['region'])) {
180 $location .= $profile['region'];
183 if (!empty($profile['country-name'])) {
188 $location .= $profile['country-name'];
195 * Loads a profile into the page sidebar.
197 * The function requires a writeable copy of the main App structure, and the nickname
198 * of a registered local account.
200 * If the viewer is an authenticated remote viewer, the profile displayed is the
201 * one that has been configured for his/her viewing in the Contact manager.
202 * Passing a non-zero profile ID can also allow a preview of a selected profile
205 * Profile information is placed in the App structure for later retrieval.
206 * Honours the owner's chosen theme for display.
208 * @attention Should only be run in the _init() functions of a module. That ensures that
209 * the theme is chosen before the _init() function of a theme is run, which will usually
210 * load a lot of theme-specific content
213 * @param string $nickname string
214 * @param bool $show_contacts
216 * @return array Profile
217 * @throws HTTPException\NotFoundException
218 * @throws HTTPException\InternalServerErrorException
219 * @throws \ImagickException
221 public static function load(App $a, string $nickname, bool $show_contacts = true): array
223 $profile = User::getOwnerDataByNick($nickname);
224 if (!isset($profile['account_removed']) || $profile['account_removed']) {
225 Logger::info('profile error: ' . DI::args()->getQueryString());
229 // System user, aborting
230 if ($profile['uid'] === 0) {
231 DI::logger()->warning('System user found in Profile::load', ['nickname' => $nickname, 'callstack' => System::callstack(20)]);
232 throw new HTTPException\NotFoundException(DI::l10n()->t('User not found.'));
235 $a->setProfileOwner($profile['uid']);
237 DI::page()['title'] = $profile['name'] . ' @ ' . DI::config()->get('config', 'sitename');
239 if (!DI::userSession()->getLocalUserId()) {
240 $a->setCurrentTheme($profile['theme']);
241 $a->setCurrentMobileTheme(DI::pConfig()->get($a->getProfileOwner(), 'system', 'mobile_theme') ?? '');
245 * load/reload current theme info
248 Renderer::setActiveTemplateEngine(); // reset the template engine to the default in case the user's theme doesn't specify one
250 $theme_info_file = 'view/theme/' . $a->getCurrentTheme() . '/theme.php';
251 if (file_exists($theme_info_file)) {
252 require_once $theme_info_file;
255 $block = (DI::config()->get('system', 'block_public') && !DI::userSession()->isAuthenticated());
259 * By now, the contact block isn't shown, when a different profile is given
260 * But: When this profile was on the same server, then we could display the contacts
262 DI::page()['aside'] .= self::getVCardHtml($profile, $block, $show_contacts);
268 * Formats a profile for display in the sidebar.
270 * It is very difficult to templatise the HTML completely
271 * because of all the conditional logic.
273 * @param array $profile Profile array
274 * @param bool $block Block personal details
275 * @param bool $show_contacts Show contact block
277 * @return string HTML sidebar module
279 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
280 * @throws \ImagickException
281 * @note Returns empty string if passed $profile is wrong type or not populated
283 * @hooks 'profile_sidebar_enter'
284 * array $profile - profile data
285 * @hooks 'profile_sidebar'
288 public static function getVCardHtml(array $profile, bool $block, bool $show_contacts): string
293 $profile_contact = [];
295 if (DI::userSession()->getLocalUserId() && ($profile['uid'] ?? 0) != DI::userSession()->getLocalUserId()) {
296 $profile_contact = Contact::getByURL($profile['nurl'], null, [], DI::userSession()->getLocalUserId());
298 if (!empty($profile['cid']) && self::getMyURL()) {
299 $profile_contact = Contact::selectFirst([], ['id' => $profile['cid']]);
302 $profile['picdate'] = urlencode($profile['picdate']);
304 $profile['network_link'] = '';
306 Hook::callAll('profile_sidebar_enter', $profile);
308 $profile_url = $profile['url'];
310 $cid = $profile['id'];
313 $unfollow_link = null;
314 $wallmessage_link = null;
316 // Who is the logged-in user to this profile?
317 $visitor_contact = [];
318 if (!empty($profile['uid']) && self::getMyURL()) {
319 $visitor_contact = Contact::selectFirst(['rel'], ['uid' => $profile['uid'], 'nurl' => Strings::normaliseLink(self::getMyURL())]);
322 $local_user_is_self = self::getMyURL() && ($profile['url'] == self::getMyURL());
323 $visitor_is_authenticated = (bool)self::getMyURL();
324 $visitor_is_following =
325 in_array($visitor_contact['rel'] ?? 0, [Contact::FOLLOWER, Contact::FRIEND])
326 || in_array($profile_contact['rel'] ?? 0, [Contact::SHARING, Contact::FRIEND]);
327 $visitor_is_followed =
328 in_array($visitor_contact['rel'] ?? 0, [Contact::SHARING, Contact::FRIEND])
329 || in_array($profile_contact['rel'] ?? 0, [Contact::FOLLOWER, Contact::FRIEND]);
330 $visitor_base_path = self::getMyURL() ? preg_replace('=/profile/(.*)=ism', '', self::getMyURL()) : '';
332 if (!$local_user_is_self) {
333 if (!$visitor_is_authenticated) {
334 // Remote follow is only available for local profiles
335 if (!empty($profile['nickname']) && strpos($profile_url, (string)DI::baseUrl()) === 0) {
336 $follow_link = 'profile/' . $profile['nickname'] . '/remote_follow';
339 if ($visitor_is_following) {
340 $unfollow_link = $visitor_base_path . '/contact/unfollow?url=' . urlencode($profile_url) . '&auto=1';
342 $follow_link = $visitor_base_path . '/contact/follow?url=' . urlencode($profile_url) . '&auto=1';
346 if (Contact::canReceivePrivateMessages($profile_contact)) {
347 if ($visitor_is_followed || $visitor_is_following) {
348 $wallmessage_link = $visitor_base_path . '/message/new/' . $profile_contact['id'];
349 } elseif ($visitor_is_authenticated && !empty($profile['unkmail'])) {
350 $wallmessage_link = 'profile/' . $profile['nickname'] . '/unkmail';
355 // show edit profile to yourself, but only if this is not meant to be
356 // rendered as a "contact". i.e., if 'self' (a "contact" table column) isn't
358 if (!isset($profile['self']) && $local_user_is_self) {
359 $profile['edit'] = [DI::baseUrl() . '/settings/profile', DI::l10n()->t('Edit profile'), '', DI::l10n()->t('Edit profile')];
361 'chg_photo' => DI::l10n()->t('Change profile photo'),
367 // Fetch the account type
368 $account_type = Contact::getAccountType($profile['account-type']);
370 if (!empty($profile['address']) || !empty($profile['location'])) {
371 $location = DI::l10n()->t('Location:');
374 $homepage = !empty($profile['homepage']) ? DI::l10n()->t('Homepage:') : false;
375 $about = !empty($profile['about']) ? DI::l10n()->t('About:') : false;
376 $xmpp = !empty($profile['xmpp']) ? DI::l10n()->t('XMPP:') : false;
377 $matrix = !empty($profile['matrix']) ? DI::l10n()->t('Matrix:') : false;
379 if ((!empty($profile['hidewall']) || $block) && !DI::userSession()->isAuthenticated()) {
380 $location = $homepage = $about = false;
383 $split_name = Diaspora::splitName($profile['name']);
384 $firstname = $split_name['first'];
385 $lastname = $split_name['last'];
387 if (!empty($profile['guid'])) {
389 'guid' => $profile['guid'],
390 'podloc' => DI::baseUrl(),
391 'searchable' => ($profile['net-publish'] ? 'true' : 'false'),
392 'nickname' => $profile['nickname'],
393 'fullname' => $profile['name'],
394 'firstname' => $firstname,
395 'lastname' => $lastname,
396 'photo300' => $profile['photo'] ?? '',
397 'photo100' => $profile['thumb'] ?? '',
398 'photo50' => $profile['micro'] ?? '',
408 if (!empty($profile['last-item'])) {
409 $updated = date('c', strtotime($profile['last-item']));
412 if (!$block && $show_contacts) {
413 $contact_block = ContactBlock::getHTML($profile, DI::userSession()->getLocalUserId());
415 if (is_array($profile) && !$profile['hide-friends']) {
416 $contact_count = DBA::count('contact', [
417 'uid' => $profile['uid'],
424 'network' => Protocol::FEDERATED,
429 // Expected profile/vcard.tpl profile.* template variables
435 foreach ($profile as $k => $v) {
436 $k = str_replace('-', '_', $k);
440 if (isset($p['about'])) {
441 $p['about'] = BBCode::convertForUriId($profile['uri-id'] ?? 0, $p['about']);
444 if (isset($p['address'])) {
445 $p['address'] = BBCode::convertForUriId($profile['uri-id'] ?? 0, $p['address']);
448 $p['photo'] = Contact::getAvatarUrlForId($cid, Proxy::SIZE_SMALL);
450 $p['url'] = Contact::magicLinkById($cid, $profile['url']);
452 if (!isset($profile['hidewall'])) {
453 Logger::warning('Missing hidewall key in profile array', ['profile' => $profile, 'callstack' => System::callstack(10)]);
456 if ($profile['account-type'] == Contact::TYPE_COMMUNITY) {
457 $mention_label = DI::l10n()->t('Post to group');
458 $mention_url = 'compose/0?body=!' . $profile['addr'];
459 $network_label = DI::l10n()->t('View group');
460 $network_url = 'network/group/' . $profile['id'];
462 $mention_label = DI::l10n()->t('Mention');
463 $mention_url = 'compose/0?body=@' . $profile['addr'];
464 $network_label = DI::l10n()->t('Network Posts');
465 $network_url = 'contact/' . $profile['id'] . '/conversations';
468 $tpl = Renderer::getMarkupTemplate('profile/vcard.tpl');
469 $o .= Renderer::replaceMacros($tpl, [
472 '$matrix' => $matrix,
473 '$follow' => DI::l10n()->t('Follow'),
474 '$follow_link' => $follow_link,
475 '$unfollow' => DI::l10n()->t('Unfollow'),
476 '$unfollow_link' => $unfollow_link,
477 '$subscribe_feed' => DI::l10n()->t('Atom feed'),
478 '$subscribe_feed_link' => $profile['hidewall'] ?? 0 ? '' : $profile['poll'],
479 '$wallmessage' => DI::l10n()->t('Message'),
480 '$wallmessage_link' => $wallmessage_link,
481 '$account_type' => $account_type,
482 '$location' => $location,
483 '$homepage' => $homepage,
484 '$homepage_verified' => DI::l10n()->t('This website has been verified to belong to the same person.'),
486 '$network' => DI::l10n()->t('Network:'),
487 '$contacts' => $contact_count,
488 '$updated' => $updated,
489 '$diaspora' => $diaspora,
490 '$contact_block' => $contact_block,
491 '$mention_label' => $mention_label,
492 '$mention_url' => $mention_url,
493 '$network_label' => $network_label,
494 '$network_url' => $network_url,
497 $arr = ['profile' => &$profile, 'entry' => &$o];
499 Hook::callAll('profile_sidebar', $arr);
505 * Returns the upcoming birthdays of contacts of the current user as HTML content
507 * @return string The upcoming birthdays (HTML)
508 * @throws HTTPException\InternalServerErrorException
509 * @throws HTTPException\ServiceUnavailableException
510 * @throws \ImagickException
512 public static function getBirthdays(): string
514 if (!DI::userSession()->getLocalUserId() || DI::mode()->isMobile() || DI::mode()->isMobile()) {
519 * $mobile_detect = new Mobile_Detect();
520 * $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
525 $bd_short = DI::l10n()->t('F d');
527 $cacheKey = 'get_birthdays:' . DI::userSession()->getLocalUserId();
528 $events = DI::cache()->get($cacheKey);
529 if (is_null($events)) {
531 "SELECT `event`.*, `event`.`id` AS `eid`, `contact`.* FROM `event`
533 ON `contact`.`id` = `event`.`cid`
534 AND (`contact`.`rel` = ? OR `contact`.`rel` = ?)
535 AND NOT `contact`.`pending`
536 AND NOT `contact`.`hidden`
537 AND NOT `contact`.`blocked`
538 AND NOT `contact`.`archive`
539 AND NOT `contact`.`deleted`
540 WHERE `event`.`uid` = ? AND `type` = 'birthday' AND `start` < ? AND `finish` > ?
544 DI::userSession()->getLocalUserId(),
545 DateTimeFormat::utc('now + 6 days'),
546 DateTimeFormat::utcNow()
548 if (DBA::isResult($result)) {
549 $events = DBA::toArray($result);
550 DI::cache()->set($cacheKey, $events, Duration::HOUR);
557 if (DBA::isResult($events)) {
558 $now = strtotime('now');
562 foreach ($events as $event) {
563 if (strlen($event['name'])) {
566 if ((strtotime($event['start'] . ' +00:00') < $now) && (strtotime($event['finish'] . ' +00:00') > $now)) {
570 $classToday = $isToday ? ' birthday-today ' : '';
572 foreach ($events as $event) {
573 if (!strlen($event['name'])) {
578 if (in_array($event['cid'], $cids)) {
581 $cids[] = $event['cid'];
583 $today = (strtotime($event['start'] . ' +00:00') < $now) && (strtotime($event['finish'] . ' +00:00') > $now);
586 'id' => $event['id'],
587 'link' => Contact::magicLinkById($event['cid']),
588 'title' => $event['name'],
589 'date' => DI::l10n()->getDay(DateTimeFormat::local($event['start'], $bd_short)) . (($today) ? ' ' . DI::l10n()->t('[today]') : '')
594 $tpl = Renderer::getMarkupTemplate('birthdays_reminder.tpl');
595 return Renderer::replaceMacros($tpl, [
596 '$classtoday' => $classToday,
598 '$event_reminders' => DI::l10n()->t('Birthday Reminders'),
599 '$event_title' => DI::l10n()->t('Birthdays this week:'),
600 '$events' => $tpl_events,
601 '$lbr' => '{', // raw brackets mess up if/endif macro processing
607 * Renders HTML for event reminder (e.g. contact birthdays
609 * @return string Rendered HTML
611 public static function getEventsReminderHTML(): string
616 if (!DI::userSession()->getLocalUserId() || DI::mode()->isMobile() || DI::mode()->isMobile()) {
621 * $mobile_detect = new Mobile_Detect();
622 * $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
627 $bd_format = DI::l10n()->t('g A l F d'); // 8 AM Friday January 18
630 $condition = ["`uid` = ? AND `type` != 'birthday' AND `start` < ? AND `start` >= ?",
631 DI::userSession()->getLocalUserId(), DateTimeFormat::utc('now + 7 days'), DateTimeFormat::utc('now - 1 days')];
632 $s = DBA::select('event', [], $condition, ['order' => ['start']]);
636 if (DBA::isResult($s)) {
640 while ($rr = DBA::fetch($s)) {
641 $condition = ['parent-uri' => $rr['uri'], 'uid' => $rr['uid'], 'author-id' => DI::userSession()->getPublicContactId(),
642 'vid' => [Verb::getID(Activity::ATTEND), Verb::getID(Activity::ATTENDMAYBE)],
643 'visible' => true, 'deleted' => false];
644 if (!Post::exists($condition)) {
648 if (strlen($rr['summary'])) {
652 $strt = DateTimeFormat::local($rr['start'], 'Y-m-d');
653 if ($strt === DateTimeFormat::localNow('Y-m-d')) {
657 $title = BBCode::toPlaintext($rr['summary'], false);
659 if (strlen($title) > 35) {
660 $title = substr($title, 0, 32) . '... ';
663 $description = BBCode::toPlaintext($rr['desc'], false) . '... ';
665 $description = DI::l10n()->t('[No description]');
668 $strt = DateTimeFormat::local($rr['start']);
670 if (substr($strt, 0, 10) < DateTimeFormat::localNow('Y-m-d')) {
674 $today = substr($strt, 0, 10) === DateTimeFormat::localNow('Y-m-d');
676 $rr['title'] = $title;
677 $rr['description'] = $description;
678 $rr['date'] = DI::l10n()->getDay(DateTimeFormat::local($rr['start'], $bd_format)) . (($today) ? ' ' . DI::l10n()->t('[today]') : '');
679 $rr['startime'] = $strt;
680 $rr['today'] = $today;
685 $classtoday = (($istoday) ? 'event-today' : '');
687 $tpl = Renderer::getMarkupTemplate('events_reminder.tpl');
688 return Renderer::replaceMacros($tpl, [
689 '$classtoday' => $classtoday,
690 '$count' => count($r),
691 '$event_reminders' => DI::l10n()->t('Event Reminders'),
692 '$event_title' => DI::l10n()->t('Upcoming events the next 7 days:'),
698 * Retrieves the my_url session variable
701 * @deprecated since version 2022.12, please use UserSession->getMyUrl instead
703 public static function getMyURL(): string
705 return DI::userSession()->getMyUrl();
709 * Process the 'zrl' parameter and initiate the remote authentication.
711 * This method checks if the visitor has a public contact entry and
712 * redirects the visitor to his/her instance to start the magic auth (Authentication)
715 * Ported from Hubzilla: https://framagit.org/hubzilla/core/blob/master/include/channel.php
717 * The implementation for Friendica sadly differs in some points from the one for Hubzilla:
718 * - Hubzilla uses the "zid" parameter, while for Friendica it had been replaced with "zrl"
719 * - There seem to be some reverse authentication (rmagic) that isn't implemented in Friendica at all
721 * It would be favourable to harmonize the two implementations.
723 * @param App $a Application instance.
726 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
727 * @throws \ImagickException
729 public static function zrlInit(App $a)
731 $my_url = self::getMyURL();
732 $my_url = Network::isUrlValid($my_url);
734 if (empty($my_url) || DI::userSession()->getLocalUserId()) {
738 $addr = $_GET['addr'] ?? $my_url;
740 $arr = ['zrl' => $my_url, 'url' => DI::args()->getCommand()];
741 Hook::callAll('zrl_init', $arr);
743 // Try to find the public contact entry of the visitor.
744 $cid = Contact::getIdForURL($my_url);
746 Logger::info('No contact record found for ' . $my_url);
750 $contact = DBA::selectFirst('contact',['id', 'url'], ['id' => $cid]);
752 if (DBA::isResult($contact) && DI::userSession()->getRemoteUserId() && DI::userSession()->getRemoteUserId() == $contact['id']) {
753 Logger::info('The visitor ' . $my_url . ' is already authenticated');
757 // Avoid endless loops
758 $cachekey = 'zrlInit:' . $my_url;
759 if (DI::cache()->get($cachekey)) {
760 Logger::info('URL ' . $my_url . ' already tried to authenticate.');
763 DI::cache()->set($cachekey, true, Duration::MINUTE);
766 Logger::info('Not authenticated. Invoking reverse magic-auth for ' . $my_url);
768 // Remove the "addr" parameter from the destination. It is later added as separate parameter again.
769 $addr_request = 'addr=' . urlencode($addr);
770 $query = rtrim(str_replace($addr_request, '', DI::args()->getQueryString()), '?&');
772 // The other instance needs to know where to redirect.
773 $dest = urlencode(DI::baseUrl() . '/' . $query);
775 // We need to extract the basebath from the profile url
776 // to redirect the visitors '/magic' module.
777 $basepath = Contact::getBasepath($contact['url']);
779 if ($basepath != DI::baseUrl() && !strstr($dest, '/magic')) {
780 $magic_path = $basepath . '/magic' . '?owa=1&dest=' . $dest . '&' . $addr_request;
782 // We have to check if the remote server does understand /magic without invoking something
783 $serverret = DI::httpClient()->head($basepath . '/magic', [HttpClientOptions::ACCEPT_CONTENT => HttpClientAccept::HTML]);
784 if ($serverret->isSuccess()) {
785 Logger::info('Doing magic auth for visitor ' . $my_url . ' to ' . $magic_path);
786 System::externalRedirect($magic_path);
792 * Set the visitor cookies (see remote_user()) for the given handle
794 * @param string $handle Visitor handle
796 * @return array Visitor contact array
798 public static function addVisitorCookieForHandle(string $handle): array
802 // Try to find the public contact entry of the visitor.
803 $cid = Contact::getIdForURL($handle);
805 Logger::info('Handle not found', ['handle' => $handle]);
809 $visitor = Contact::getById($cid);
811 // Authenticate the visitor.
812 DI::userSession()->setMultiple([
813 'authenticated' => 1,
814 'visitor_id' => $visitor['id'],
815 'visitor_handle' => $visitor['addr'],
816 'visitor_home' => $visitor['url'],
817 'my_url' => $visitor['url'],
818 'remote_comment' => $visitor['subscribe'],
821 DI::userSession()->setVisitorsContacts($visitor['url']);
823 $a->setContactId($visitor['id']);
825 Logger::info('Authenticated visitor', ['url' => $visitor['url']]);
831 * Set the visitor cookies (see remote_user()) for signed HTTP requests
833 * @param array $server The content of the $_SERVER superglobal
834 * @return array Visitor contact array
835 * @throws InternalServerErrorException
837 public static function addVisitorCookieForHTTPSigner(array $server): array
839 $requester = HTTPSignature::getSigner('', $server);
840 if (empty($requester)) {
843 return Profile::addVisitorCookieForHandle($requester);
847 * OpenWebAuth authentication.
849 * Ported from Hubzilla: https://framagit.org/hubzilla/core/blob/master/include/zid.php
851 * @param string $token
854 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
855 * @throws \ImagickException
857 public static function openWebAuthInit(string $token)
861 // Clean old OpenWebAuthToken entries.
862 OpenWebAuthToken::purge('owt', '3 MINUTE');
864 // Check if the token we got is the same one
865 // we have stored in the database.
866 $visitor_handle = OpenWebAuthToken::getMeta('owt', 0, $token);
868 if ($visitor_handle === false) {
872 $visitor = self::addVisitorCookieForHandle($visitor_handle);
873 if (empty($visitor)) {
878 'visitor' => $visitor,
879 'url' => DI::args()->getQueryString()
882 * @hooks magic_auth_success
883 * Called when a magic-auth was successful.
884 * * \e array \b visitor
887 Hook::callAll('magic_auth_success', $arr);
889 $a->setContactId($arr['visitor']['id']);
891 DI::sysmsg()->addInfo(DI::l10n()->t('OpenWebAuth: %1$s welcomes %2$s', DI::baseUrl()->getHost(), $visitor['name']));
893 Logger::info('OpenWebAuth: auth success from ' . $visitor['addr']);
897 * Returns URL with URL-encoded zrl parameter
899 * @param string $url URL to enhance
900 * @param bool $force Either to force adding zrl parameter
902 * @return string URL with 'zrl' parameter or original URL in case of no Friendica profile URL
904 public static function zrl(string $url, bool $force = false): string
909 if (!strpos($url, '/profile/') && !$force) {
912 if ($force && substr($url, -1, 1) !== '/') {
916 $achar = strpos($url, '?') ? '&' : '?';
917 $mine = self::getMyURL();
919 if ($mine && !Strings::compareLink($mine, $url)) {
920 return $url . $achar . 'zrl=' . urlencode($mine);
927 * Get the user ID of the page owner.
929 * Used from within PCSS themes to set theme parameters. If there's a
930 * profile_uid variable set in App, that is the "page owner" and normally their theme
931 * settings take precedence; unless a local user is logged in which means they don't
932 * want to see anybody else's theme settings except their own while on this site.
936 * @return int user ID
938 * @note Returns local_user instead of user ID if "always_my_theme" is set to true
940 public static function getThemeUid(App $a): int
942 return DI::userSession()->getLocalUserId() ?: $a->getProfileOwner();
946 * search for Profiles
948 * @param int $start Starting record (see LIMIT start,count)
949 * @param int $count Maximum records (see LIMIT start,count)
950 * @param string $search Optional search word (see LIKE %s?%s)
952 * @return array [ 'total' => 123, 'entries' => [...] ];
956 public static function searchProfiles(int $start = 0, int $count = 100, string $search = null): array
958 if (!empty($search)) {
959 $publish = (DI::config()->get('system', 'publish_all') ? '' : "AND `publish` ");
960 $searchTerm = '%' . $search . '%';
961 $condition = ["`verified` AND NOT `blocked` AND NOT `account_removed` AND NOT `account_expired`
963 AND ((`name` LIKE ?) OR
964 (`nickname` LIKE ?) OR
966 (`locality` LIKE ?) OR
968 (`country-name` LIKE ?) OR
969 (`pub_keywords` LIKE ?) OR
970 (`prv_keywords` LIKE ?))",
971 $searchTerm, $searchTerm, $searchTerm, $searchTerm,
972 $searchTerm, $searchTerm, $searchTerm, $searchTerm];
974 $condition = ['verified' => true, 'blocked' => false, 'account_removed' => false, 'account_expired' => false];
975 if (!DI::config()->get('system', 'publish_all')) {
976 $condition['publish'] = true;
980 $total = DBA::count('owner-view', $condition);
982 // If nothing found, don't try to select details
984 $profiles = DBA::selectToArray('owner-view', [], $condition, ['order' => ['name'], 'limit' => [$start, $count]]);
989 return ['total' => $total, 'entries' => $profiles];
993 * Migrates a legacy profile to the new slimmer profile with extra custom fields.
994 * Multi profiles are converted to ACl-protected custom fields and deleted.
996 * @param array $profile One profile array
1001 public static function migrate(array $profile)
1003 // Already processed, aborting
1004 if ($profile['is-default'] === null) {
1010 if (!$profile['is-default']) {
1011 $contacts = Contact::selectToArray(['id'], [
1012 'uid' => $profile['uid'],
1013 'profile-id' => $profile['id']
1015 if (!count($contacts)) {
1016 // No contact visibility selected defaults to user-only permission
1017 $contacts = Contact::selectToArray(['id'], ['uid' => $profile['uid'], 'self' => true]);
1021 $permissionSet = DI::permissionSet()->selectOrCreate(
1024 array_column($contacts, 'id') ?? []
1031 'hometown' => DI::l10n()->t('Hometown:'),
1032 'marital' => DI::l10n()->t('Marital Status:'),
1033 'with' => DI::l10n()->t('With:'),
1034 'howlong' => DI::l10n()->t('Since:'),
1035 'sexual' => DI::l10n()->t('Sexual Preference:'),
1036 'politic' => DI::l10n()->t('Political Views:'),
1037 'religion' => DI::l10n()->t('Religious Views:'),
1038 'likes' => DI::l10n()->t('Likes:'),
1039 'dislikes' => DI::l10n()->t('Dislikes:'),
1040 'pdesc' => DI::l10n()->t('Title/Description:'),
1041 'summary' => DI::l10n()->t('Summary'),
1042 'music' => DI::l10n()->t('Musical interests'),
1043 'book' => DI::l10n()->t('Books, literature'),
1044 'tv' => DI::l10n()->t('Television'),
1045 'film' => DI::l10n()->t('Film/dance/culture/entertainment'),
1046 'interest' => DI::l10n()->t('Hobbies/Interests'),
1047 'romance' => DI::l10n()->t('Love/romance'),
1048 'work' => DI::l10n()->t('Work/employment'),
1049 'education' => DI::l10n()->t('School/education'),
1050 'contact' => DI::l10n()->t('Contact information and Social Networks'),
1053 foreach ($custom_fields as $field => $label) {
1054 if (!empty($profile[$field]) && $profile[$field] > DBA::NULL_DATE && $profile[$field] > DBA::NULL_DATETIME) {
1055 DI::profileField()->save(DI::profileFieldFactory()->createFromValues(
1064 $profile[$field] = null;
1067 if ($profile['is-default']) {
1068 $profile['profile-name'] = null;
1069 $profile['is-default'] = null;
1070 DBA::update('profile', $profile, ['id' => $profile['id']]);
1071 } else if (!empty($profile['id'])) {
1072 DBA::delete('profile', ['id' => $profile['id']]);