3 * @copyright Copyright (C) 2010-2022, 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\Protocol\Activity;
41 use Friendica\Protocol\Diaspora;
42 use Friendica\Security\PermissionSet\Entity\PermissionSet;
43 use Friendica\Util\DateTimeFormat;
44 use Friendica\Util\HTTPSignature;
45 use Friendica\Util\Network;
46 use Friendica\Util\Proxy;
47 use Friendica\Util\Strings;
52 * Returns default profile for a given user id
54 * @param integer User ID
56 * @return array|bool Profile data or false on error
59 public static function getByUID(int $uid)
61 return DBA::selectFirst('profile', [], ['uid' => $uid]);
65 * Returns default profile for a given user ID and ID
67 * @param int $uid The contact ID
68 * @param int $id The contact owner ID
69 * @param array $fields The selected fields
71 * @return array|bool Profile data for the ID or false on error
74 public static function getById(int $uid, int $id, array $fields = [])
76 return DBA::selectFirst('profile', $fields, ['uid' => $uid, 'id' => $id]);
80 * Returns profile data for the contact owner
82 * @param int $uid The User ID
83 * @param array|bool $fields The fields to retrieve or false on error
85 * @return array Array of profile data
88 public static function getListByUser(int $uid, array $fields = [])
90 return DBA::selectToArray('profile', $fields, ['uid' => $uid]);
94 * Update a profile entry and distribute the changes if needed
96 * @param array $fields Profile fields to update
97 * @param integer $uid User id
99 * @return boolean Whether update was successful
101 public static function update(array $fields, int $uid): bool
103 $old_owner = User::getOwnerDataById($uid);
104 if (empty($old_owner)) {
108 if (!DBA::update('profile', $fields, ['uid' => $uid])) {
112 $update = Contact::updateSelfFromUserID($uid);
114 $owner = User::getOwnerDataById($uid);
119 if ($old_owner['name'] != $owner['name']) {
120 User::update(['username' => $owner['name']], $uid);
123 $profile_fields = ['postal-code', 'dob', 'prv_keywords', 'homepage'];
124 foreach ($profile_fields as $field) {
125 if ($old_owner[$field] != $owner[$field]) {
131 self::publishUpdate($uid, ($old_owner['net-publish'] != $owner['net-publish']));
138 * Publish a changed profile
140 * @param int $uid User id
141 * @param bool $force Force publishing to the directory
145 public static function publishUpdate(int $uid, bool $force = false)
147 $owner = User::getOwnerDataById($uid);
152 if ($owner['net-publish'] || $force) {
153 // Update global directory in background
154 if (Search::getGlobalDirectory()) {
155 Worker::add(Worker::PRIORITY_LOW, 'Directory', $owner['url']);
159 Worker::add(Worker::PRIORITY_LOW, 'ProfileUpdate', $uid);
163 * Returns a formatted location string from the given profile array
165 * @param array $profile Profile array (Generated from the "profile" table)
167 * @return string Location string
169 public static function formatLocation(array $profile): string
173 if (!empty($profile['locality'])) {
174 $location .= $profile['locality'];
177 if (!empty($profile['region']) && (($profile['locality'] ?? '') != $profile['region'])) {
182 $location .= $profile['region'];
185 if (!empty($profile['country-name'])) {
190 $location .= $profile['country-name'];
197 * Loads a profile into the page sidebar.
199 * The function requires a writeable copy of the main App structure, and the nickname
200 * of a registered local account.
202 * If the viewer is an authenticated remote viewer, the profile displayed is the
203 * one that has been configured for his/her viewing in the Contact manager.
204 * Passing a non-zero profile ID can also allow a preview of a selected profile
207 * Profile information is placed in the App structure for later retrieval.
208 * Honours the owner's chosen theme for display.
210 * @attention Should only be run in the _init() functions of a module. That ensures that
211 * the theme is chosen before the _init() function of a theme is run, which will usually
212 * load a lot of theme-specific content
215 * @param string $nickname string
216 * @param bool $show_contacts
218 * @return array Profile
219 * @throws HTTPException\NotFoundException
220 * @throws HTTPException\InternalServerErrorException
221 * @throws \ImagickException
223 public static function load(App $a, string $nickname, bool $show_contacts = true): array
225 $profile = User::getOwnerDataByNick($nickname);
226 if (!isset($profile['account_removed']) || $profile['account_removed']) {
227 Logger::info('profile error: ' . DI::args()->getQueryString());
231 // System user, aborting
232 if ($profile['uid'] === 0) {
233 DI::logger()->warning('System user found in Profile::load', ['nickname' => $nickname, 'callstack' => System::callstack(20)]);
234 throw new HTTPException\NotFoundException(DI::l10n()->t('User not found.'));
237 $a->setProfileOwner($profile['uid']);
239 DI::page()['title'] = $profile['name'] . ' @ ' . DI::config()->get('config', 'sitename');
241 if (!DI::userSession()->getLocalUserId()) {
242 $a->setCurrentTheme($profile['theme']);
243 $a->setCurrentMobileTheme(DI::pConfig()->get($a->getProfileOwner(), 'system', 'mobile_theme') ?? '');
247 * load/reload current theme info
250 Renderer::setActiveTemplateEngine(); // reset the template engine to the default in case the user's theme doesn't specify one
252 $theme_info_file = 'view/theme/' . $a->getCurrentTheme() . '/theme.php';
253 if (file_exists($theme_info_file)) {
254 require_once $theme_info_file;
257 $block = (DI::config()->get('system', 'block_public') && !DI::userSession()->isAuthenticated());
261 * By now, the contact block isn't shown, when a different profile is given
262 * But: When this profile was on the same server, then we could display the contacts
264 DI::page()['aside'] .= self::getVCardHtml($profile, $block, $show_contacts);
270 * Formats a profile for display in the sidebar.
272 * It is very difficult to templatise the HTML completely
273 * because of all the conditional logic.
275 * @param array $profile Profile array
276 * @param bool $block Block personal details
277 * @param bool $show_contacts Show contact block
279 * @return string HTML sidebar module
281 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
282 * @throws \ImagickException
283 * @note Returns empty string if passed $profile is wrong type or not populated
285 * @hooks 'profile_sidebar_enter'
286 * array $profile - profile data
287 * @hooks 'profile_sidebar'
290 public static function getVCardHtml(array $profile, bool $block, bool $show_contacts): string
295 $profile_contact = [];
297 if (DI::userSession()->getLocalUserId() && ($profile['uid'] ?? 0) != DI::userSession()->getLocalUserId()) {
298 $profile_contact = Contact::getByURL($profile['nurl'], null, [], DI::userSession()->getLocalUserId());
300 if (!empty($profile['cid']) && self::getMyURL()) {
301 $profile_contact = Contact::selectFirst([], ['id' => $profile['cid']]);
304 $profile['picdate'] = urlencode($profile['picdate']);
306 $profile['network_link'] = '';
308 Hook::callAll('profile_sidebar_enter', $profile);
310 $profile_url = $profile['url'];
312 $cid = $profile['id'];
315 $unfollow_link = null;
316 $wallmessage_link = null;
318 // Who is the logged-in user to this profile?
319 $visitor_contact = [];
320 if (!empty($profile['uid']) && self::getMyURL()) {
321 $visitor_contact = Contact::selectFirst(['rel'], ['uid' => $profile['uid'], 'nurl' => Strings::normaliseLink(self::getMyURL())]);
324 $local_user_is_self = self::getMyURL() && ($profile['url'] == self::getMyURL());
325 $visitor_is_authenticated = (bool)self::getMyURL();
326 $visitor_is_following =
327 in_array($visitor_contact['rel'] ?? 0, [Contact::FOLLOWER, Contact::FRIEND])
328 || in_array($profile_contact['rel'] ?? 0, [Contact::SHARING, Contact::FRIEND]);
329 $visitor_is_followed =
330 in_array($visitor_contact['rel'] ?? 0, [Contact::SHARING, Contact::FRIEND])
331 || in_array($profile_contact['rel'] ?? 0, [Contact::FOLLOWER, Contact::FRIEND]);
332 $visitor_base_path = self::getMyURL() ? preg_replace('=/profile/(.*)=ism', '', self::getMyURL()) : '';
334 if (!$local_user_is_self) {
335 if (!$visitor_is_authenticated) {
336 // Remote follow is only available for local profiles
337 if (!empty($profile['nickname']) && strpos($profile_url, DI::baseUrl()->get()) === 0) {
338 $follow_link = 'profile/' . $profile['nickname'] . '/remote_follow';
341 if ($visitor_is_following) {
342 $unfollow_link = $visitor_base_path . '/contact/unfollow?url=' . urlencode($profile_url) . '&auto=1';
344 $follow_link = $visitor_base_path . '/contact/follow?url=' . urlencode($profile_url) . '&auto=1';
348 if (Contact::canReceivePrivateMessages($profile_contact)) {
349 if ($visitor_is_followed || $visitor_is_following) {
350 $wallmessage_link = $visitor_base_path . '/message/new/' . $profile_contact['id'];
351 } elseif ($visitor_is_authenticated && !empty($profile['unkmail'])) {
352 $wallmessage_link = 'profile/' . $profile['nickname'] . '/unkmail';
357 // show edit profile to yourself, but only if this is not meant to be
358 // rendered as a "contact". i.e., if 'self' (a "contact" table column) isn't
360 if (!isset($profile['self']) && $local_user_is_self) {
361 $profile['edit'] = [DI::baseUrl() . '/settings/profile', DI::l10n()->t('Edit profile'), '', DI::l10n()->t('Edit profile')];
363 'chg_photo' => DI::l10n()->t('Change profile photo'),
369 // Fetch the account type
370 $account_type = Contact::getAccountType($profile['account-type']);
372 if (!empty($profile['address']) || !empty($profile['location'])) {
373 $location = DI::l10n()->t('Location:');
376 $homepage = !empty($profile['homepage']) ? DI::l10n()->t('Homepage:') : false;
377 $about = !empty($profile['about']) ? DI::l10n()->t('About:') : false;
378 $xmpp = !empty($profile['xmpp']) ? DI::l10n()->t('XMPP:') : false;
379 $matrix = !empty($profile['matrix']) ? DI::l10n()->t('Matrix:') : false;
381 if ((!empty($profile['hidewall']) || $block) && !DI::userSession()->isAuthenticated()) {
382 $location = $homepage = $about = false;
385 $split_name = Diaspora::splitName($profile['name']);
386 $firstname = $split_name['first'];
387 $lastname = $split_name['last'];
389 if (!empty($profile['guid'])) {
391 'guid' => $profile['guid'],
392 'podloc' => DI::baseUrl(),
393 'searchable' => ($profile['net-publish'] ? 'true' : 'false'),
394 'nickname' => $profile['nickname'],
395 'fullname' => $profile['name'],
396 'firstname' => $firstname,
397 'lastname' => $lastname,
398 'photo300' => $profile['photo'] ?? '',
399 'photo100' => $profile['thumb'] ?? '',
400 'photo50' => $profile['micro'] ?? '',
410 if (!empty($profile['last-item'])) {
411 $updated = date('c', strtotime($profile['last-item']));
414 if (!$block && $show_contacts) {
415 $contact_block = ContactBlock::getHTML($profile, DI::userSession()->getLocalUserId());
417 if (is_array($profile) && !$profile['hide-friends']) {
418 $contact_count = DBA::count('contact', [
419 'uid' => $profile['uid'],
426 'network' => Protocol::FEDERATED,
431 // Expected profile/vcard.tpl profile.* template variables
437 foreach ($profile as $k => $v) {
438 $k = str_replace('-', '_', $k);
442 if (isset($p['about'])) {
443 $p['about'] = BBCode::convertForUriId($profile['uri-id'] ?? 0, $p['about']);
446 if (isset($p['address'])) {
447 $p['address'] = BBCode::convertForUriId($profile['uri-id'] ?? 0, $p['address']);
450 $p['photo'] = Contact::getAvatarUrlForId($cid, Proxy::SIZE_SMALL);
452 $p['url'] = Contact::magicLinkById($cid, $profile['url']);
454 if (!isset($profile['hidewall'])) {
455 Logger::warning('Missing hidewall key in profile array', ['profile' => $profile, 'callstack' => System::callstack(10)]);
458 $tpl = Renderer::getMarkupTemplate('profile/vcard.tpl');
459 $o .= Renderer::replaceMacros($tpl, [
462 '$matrix' => $matrix,
463 '$follow' => DI::l10n()->t('Follow'),
464 '$follow_link' => $follow_link,
465 '$unfollow' => DI::l10n()->t('Unfollow'),
466 '$unfollow_link' => $unfollow_link,
467 '$subscribe_feed' => DI::l10n()->t('Atom feed'),
468 '$subscribe_feed_link' => $profile['hidewall'] ?? 0 ? '' : $profile['poll'],
469 '$wallmessage' => DI::l10n()->t('Message'),
470 '$wallmessage_link' => $wallmessage_link,
471 '$account_type' => $account_type,
472 '$location' => $location,
473 '$homepage' => $homepage,
474 '$homepage_verified' => DI::l10n()->t('This website has been verified to belong to the same person.'),
476 '$network' => DI::l10n()->t('Network:'),
477 '$contacts' => $contact_count,
478 '$updated' => $updated,
479 '$diaspora' => $diaspora,
480 '$contact_block' => $contact_block,
483 $arr = ['profile' => &$profile, 'entry' => &$o];
485 Hook::callAll('profile_sidebar', $arr);
491 * Returns the upcoming birthdays of contacts of the current user as HTML content
493 * @return string The upcoming birthdays (HTML)
494 * @throws HTTPException\InternalServerErrorException
495 * @throws HTTPException\ServiceUnavailableException
496 * @throws \ImagickException
498 public static function getBirthdays(): string
500 if (!DI::userSession()->getLocalUserId() || DI::mode()->isMobile() || DI::mode()->isMobile()) {
505 * $mobile_detect = new Mobile_Detect();
506 * $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
511 $bd_short = DI::l10n()->t('F d');
513 $cacheKey = 'get_birthdays:' . DI::userSession()->getLocalUserId();
514 $events = DI::cache()->get($cacheKey);
515 if (is_null($events)) {
517 "SELECT `event`.*, `event`.`id` AS `eid`, `contact`.* FROM `event`
519 ON `contact`.`id` = `event`.`cid`
520 AND (`contact`.`rel` = ? OR `contact`.`rel` = ?)
521 AND NOT `contact`.`pending`
522 AND NOT `contact`.`hidden`
523 AND NOT `contact`.`blocked`
524 AND NOT `contact`.`archive`
525 AND NOT `contact`.`deleted`
526 WHERE `event`.`uid` = ? AND `type` = 'birthday' AND `start` < ? AND `finish` > ?
530 DI::userSession()->getLocalUserId(),
531 DateTimeFormat::utc('now + 6 days'),
532 DateTimeFormat::utcNow()
534 if (DBA::isResult($result)) {
535 $events = DBA::toArray($result);
536 DI::cache()->set($cacheKey, $events, Duration::HOUR);
543 if (DBA::isResult($events)) {
544 $now = strtotime('now');
548 foreach ($events as $event) {
549 if (strlen($event['name'])) {
552 if ((strtotime($event['start'] . ' +00:00') < $now) && (strtotime($event['finish'] . ' +00:00') > $now)) {
556 $classToday = $isToday ? ' birthday-today ' : '';
558 foreach ($events as $event) {
559 if (!strlen($event['name'])) {
564 if (in_array($event['cid'], $cids)) {
567 $cids[] = $event['cid'];
569 $today = (strtotime($event['start'] . ' +00:00') < $now) && (strtotime($event['finish'] . ' +00:00') > $now);
572 'id' => $event['id'],
573 'link' => Contact::magicLinkById($event['cid']),
574 'title' => $event['name'],
575 'date' => DI::l10n()->getDay(DateTimeFormat::local($event['start'], $bd_short)) . (($today) ? ' ' . DI::l10n()->t('[today]') : '')
580 $tpl = Renderer::getMarkupTemplate('birthdays_reminder.tpl');
581 return Renderer::replaceMacros($tpl, [
582 '$classtoday' => $classToday,
584 '$event_reminders' => DI::l10n()->t('Birthday Reminders'),
585 '$event_title' => DI::l10n()->t('Birthdays this week:'),
586 '$events' => $tpl_events,
587 '$lbr' => '{', // raw brackets mess up if/endif macro processing
593 * Renders HTML for event reminder (e.g. contact birthdays
595 * @return string Rendered HTML
597 public static function getEventsReminderHTML(): string
602 if (!DI::userSession()->getLocalUserId() || DI::mode()->isMobile() || DI::mode()->isMobile()) {
607 * $mobile_detect = new Mobile_Detect();
608 * $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
613 $bd_format = DI::l10n()->t('g A l F d'); // 8 AM Friday January 18
616 $condition = ["`uid` = ? AND `type` != 'birthday' AND `start` < ? AND `start` >= ?",
617 DI::userSession()->getLocalUserId(), DateTimeFormat::utc('now + 7 days'), DateTimeFormat::utc('now - 1 days')];
618 $s = DBA::select('event', [], $condition, ['order' => ['start']]);
622 if (DBA::isResult($s)) {
626 while ($rr = DBA::fetch($s)) {
627 $condition = ['parent-uri' => $rr['uri'], 'uid' => $rr['uid'], 'author-id' => DI::userSession()->getPublicContactId(),
628 'vid' => [Verb::getID(Activity::ATTEND), Verb::getID(Activity::ATTENDMAYBE)],
629 'visible' => true, 'deleted' => false];
630 if (!Post::exists($condition)) {
634 if (strlen($rr['summary'])) {
638 $strt = DateTimeFormat::local($rr['start'], 'Y-m-d');
639 if ($strt === DateTimeFormat::localNow('Y-m-d')) {
643 $title = strip_tags(html_entity_decode(BBCode::convertForUriId($rr['uri-id'], $rr['summary']), ENT_QUOTES, 'UTF-8'));
645 if (strlen($title) > 35) {
646 $title = substr($title, 0, 32) . '... ';
649 $description = substr(strip_tags(BBCode::convertForUriId($rr['uri-id'], $rr['desc'])), 0, 32) . '... ';
651 $description = DI::l10n()->t('[No description]');
654 $strt = DateTimeFormat::local($rr['start']);
656 if (substr($strt, 0, 10) < DateTimeFormat::localNow('Y-m-d')) {
660 $today = substr($strt, 0, 10) === DateTimeFormat::localNow('Y-m-d');
662 $rr['title'] = $title;
663 $rr['description'] = $description;
664 $rr['date'] = DI::l10n()->getDay(DateTimeFormat::local($rr['start'], $bd_format)) . (($today) ? ' ' . DI::l10n()->t('[today]') : '');
665 $rr['startime'] = $strt;
666 $rr['today'] = $today;
671 $classtoday = (($istoday) ? 'event-today' : '');
673 $tpl = Renderer::getMarkupTemplate('events_reminder.tpl');
674 return Renderer::replaceMacros($tpl, [
675 '$classtoday' => $classtoday,
676 '$count' => count($r),
677 '$event_reminders' => DI::l10n()->t('Event Reminders'),
678 '$event_title' => DI::l10n()->t('Upcoming events the next 7 days:'),
684 * Retrieves the my_url session variable
687 * @deprecated since version 2022.12, please use UserSession->getMyUrl instead
689 public static function getMyURL(): string
691 return DI::userSession()->getMyUrl();
695 * Process the 'zrl' parameter and initiate the remote authentication.
697 * This method checks if the visitor has a public contact entry and
698 * redirects the visitor to his/her instance to start the magic auth (Authentication)
701 * Ported from Hubzilla: https://framagit.org/hubzilla/core/blob/master/include/channel.php
703 * The implementation for Friendica sadly differs in some points from the one for Hubzilla:
704 * - Hubzilla uses the "zid" parameter, while for Friendica it had been replaced with "zrl"
705 * - There seem to be some reverse authentication (rmagic) that isn't implemented in Friendica at all
707 * It would be favourable to harmonize the two implementations.
709 * @param App $a Application instance.
712 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
713 * @throws \ImagickException
715 public static function zrlInit(App $a)
717 $my_url = self::getMyURL();
718 $my_url = Network::isUrlValid($my_url);
720 if (empty($my_url) || DI::userSession()->getLocalUserId()) {
724 $addr = $_GET['addr'] ?? $my_url;
726 $arr = ['zrl' => $my_url, 'url' => DI::args()->getCommand()];
727 Hook::callAll('zrl_init', $arr);
729 // Try to find the public contact entry of the visitor.
730 $cid = Contact::getIdForURL($my_url);
732 Logger::info('No contact record found for ' . $my_url);
736 $contact = DBA::selectFirst('contact',['id', 'url'], ['id' => $cid]);
738 if (DBA::isResult($contact) && DI::userSession()->getRemoteUserId() && DI::userSession()->getRemoteUserId() == $contact['id']) {
739 Logger::info('The visitor ' . $my_url . ' is already authenticated');
743 // Avoid endless loops
744 $cachekey = 'zrlInit:' . $my_url;
745 if (DI::cache()->get($cachekey)) {
746 Logger::info('URL ' . $my_url . ' already tried to authenticate.');
749 DI::cache()->set($cachekey, true, Duration::MINUTE);
752 Logger::info('Not authenticated. Invoking reverse magic-auth for ' . $my_url);
754 // Remove the "addr" parameter from the destination. It is later added as separate parameter again.
755 $addr_request = 'addr=' . urlencode($addr);
756 $query = rtrim(str_replace($addr_request, '', DI::args()->getQueryString()), '?&');
758 // The other instance needs to know where to redirect.
759 $dest = urlencode(DI::baseUrl()->get() . '/' . $query);
761 // We need to extract the basebath from the profile url
762 // to redirect the visitors '/magic' module.
763 $basepath = Contact::getBasepath($contact['url']);
765 if ($basepath != DI::baseUrl()->get() && !strstr($dest, '/magic')) {
766 $magic_path = $basepath . '/magic' . '?owa=1&dest=' . $dest . '&' . $addr_request;
768 // We have to check if the remote server does understand /magic without invoking something
769 $serverret = DI::httpClient()->head($basepath . '/magic', [HttpClientOptions::ACCEPT_CONTENT => HttpClientAccept::HTML]);
770 if ($serverret->isSuccess()) {
771 Logger::info('Doing magic auth for visitor ' . $my_url . ' to ' . $magic_path);
772 System::externalRedirect($magic_path);
778 * Set the visitor cookies (see remote_user()) for the given handle
780 * @param string $handle Visitor handle
782 * @return array Visitor contact array
784 public static function addVisitorCookieForHandle(string $handle): array
788 // Try to find the public contact entry of the visitor.
789 $cid = Contact::getIdForURL($handle);
791 Logger::info('Handle not found', ['handle' => $handle]);
795 $visitor = Contact::getById($cid);
797 // Authenticate the visitor.
798 $_SESSION['authenticated'] = 1;
799 $_SESSION['visitor_id'] = $visitor['id'];
800 $_SESSION['visitor_handle'] = $visitor['addr'];
801 $_SESSION['visitor_home'] = $visitor['url'];
802 $_SESSION['my_url'] = $visitor['url'];
803 $_SESSION['remote_comment'] = $visitor['subscribe'];
805 DI::userSession()->setVisitorsContacts();
807 $a->setContactId($visitor['id']);
809 Logger::info('Authenticated visitor', ['url' => $visitor['url']]);
815 * Set the visitor cookies (see remote_user()) for signed HTTP requests
817 * @return array Visitor contact array
819 public static function addVisitorCookieForHTTPSigner(): array
821 $requester = HTTPSignature::getSigner('', $_SERVER);
822 if (empty($requester)) {
825 return Profile::addVisitorCookieForHandle($requester);
829 * OpenWebAuth authentication.
831 * Ported from Hubzilla: https://framagit.org/hubzilla/core/blob/master/include/zid.php
833 * @param string $token
836 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
837 * @throws \ImagickException
839 public static function openWebAuthInit(string $token)
843 // Clean old OpenWebAuthToken entries.
844 OpenWebAuthToken::purge('owt', '3 MINUTE');
846 // Check if the token we got is the same one
847 // we have stored in the database.
848 $visitor_handle = OpenWebAuthToken::getMeta('owt', 0, $token);
850 if ($visitor_handle === false) {
854 $visitor = self::addVisitorCookieForHandle($visitor_handle);
855 if (empty($visitor)) {
860 'visitor' => $visitor,
861 'url' => DI::args()->getQueryString()
864 * @hooks magic_auth_success
865 * Called when a magic-auth was successful.
866 * * \e array \b visitor
869 Hook::callAll('magic_auth_success', $arr);
871 $a->setContactId($arr['visitor']['id']);
873 DI::sysmsg()->addInfo(DI::l10n()->t('OpenWebAuth: %1$s welcomes %2$s', DI::baseUrl()->getHostname(), $visitor['name']));
875 Logger::info('OpenWebAuth: auth success from ' . $visitor['addr']);
879 * Returns URL with URL-encoded zrl parameter
881 * @param string $url URL to enhance
882 * @param bool $force Either to force adding zrl parameter
884 * @return string URL with 'zrl' parameter or original URL in case of no Friendica profile URL
886 public static function zrl(string $url, bool $force = false): string
891 if (!strpos($url, '/profile/') && !$force) {
894 if ($force && substr($url, -1, 1) !== '/') {
898 $achar = strpos($url, '?') ? '&' : '?';
899 $mine = self::getMyURL();
901 if ($mine && !Strings::compareLink($mine, $url)) {
902 return $url . $achar . 'zrl=' . urlencode($mine);
909 * Get the user ID of the page owner.
911 * Used from within PCSS themes to set theme parameters. If there's a
912 * profile_uid variable set in App, that is the "page owner" and normally their theme
913 * settings take precedence; unless a local user is logged in which means they don't
914 * want to see anybody else's theme settings except their own while on this site.
918 * @return int user ID
920 * @note Returns local_user instead of user ID if "always_my_theme" is set to true
922 public static function getThemeUid(App $a): int
924 return DI::userSession()->getLocalUserId() ?: $a->getProfileOwner();
928 * search for Profiles
930 * @param int $start Starting record (see LIMIT start,count)
931 * @param int $count Maximum records (see LIMIT start,count)
932 * @param string $search Optional search word (see LIKE %s?%s)
934 * @return array [ 'total' => 123, 'entries' => [...] ];
938 public static function searchProfiles(int $start = 0, int $count = 100, string $search = null): array
940 if (!empty($search)) {
941 $publish = (DI::config()->get('system', 'publish_all') ? '' : "AND `publish` ");
942 $searchTerm = '%' . $search . '%';
943 $condition = ["NOT `blocked` AND NOT `account_removed`
945 AND ((`name` LIKE ?) OR
946 (`nickname` LIKE ?) OR
948 (`locality` LIKE ?) OR
950 (`country-name` LIKE ?) OR
951 (`pub_keywords` LIKE ?) OR
952 (`prv_keywords` LIKE ?))",
953 $searchTerm, $searchTerm, $searchTerm, $searchTerm,
954 $searchTerm, $searchTerm, $searchTerm, $searchTerm];
956 $condition = ['blocked' => false, 'account_removed' => false];
957 if (!DI::config()->get('system', 'publish_all')) {
958 $condition['publish'] = true;
962 $total = DBA::count('owner-view', $condition);
964 // If nothing found, don't try to select details
966 $profiles = DBA::selectToArray('owner-view', [], $condition, ['order' => ['name'], 'limit' => [$start, $count]]);
971 return ['total' => $total, 'entries' => $profiles];
975 * Migrates a legacy profile to the new slimmer profile with extra custom fields.
976 * Multi profiles are converted to ACl-protected custom fields and deleted.
978 * @param array $profile One profile array
983 public static function migrate(array $profile)
985 // Already processed, aborting
986 if ($profile['is-default'] === null) {
992 if (!$profile['is-default']) {
993 $contacts = Contact::selectToArray(['id'], [
994 'uid' => $profile['uid'],
995 'profile-id' => $profile['id']
997 if (!count($contacts)) {
998 // No contact visibility selected defaults to user-only permission
999 $contacts = Contact::selectToArray(['id'], ['uid' => $profile['uid'], 'self' => true]);
1003 $permissionSet = DI::permissionSet()->selectOrCreate(
1006 array_column($contacts, 'id') ?? []
1013 'hometown' => DI::l10n()->t('Hometown:'),
1014 'marital' => DI::l10n()->t('Marital Status:'),
1015 'with' => DI::l10n()->t('With:'),
1016 'howlong' => DI::l10n()->t('Since:'),
1017 'sexual' => DI::l10n()->t('Sexual Preference:'),
1018 'politic' => DI::l10n()->t('Political Views:'),
1019 'religion' => DI::l10n()->t('Religious Views:'),
1020 'likes' => DI::l10n()->t('Likes:'),
1021 'dislikes' => DI::l10n()->t('Dislikes:'),
1022 'pdesc' => DI::l10n()->t('Title/Description:'),
1023 'summary' => DI::l10n()->t('Summary'),
1024 'music' => DI::l10n()->t('Musical interests'),
1025 'book' => DI::l10n()->t('Books, literature'),
1026 'tv' => DI::l10n()->t('Television'),
1027 'film' => DI::l10n()->t('Film/dance/culture/entertainment'),
1028 'interest' => DI::l10n()->t('Hobbies/Interests'),
1029 'romance' => DI::l10n()->t('Love/romance'),
1030 'work' => DI::l10n()->t('Work/employment'),
1031 'education' => DI::l10n()->t('School/education'),
1032 'contact' => DI::l10n()->t('Contact information and Social Networks'),
1035 foreach ($custom_fields as $field => $label) {
1036 if (!empty($profile[$field]) && $profile[$field] > DBA::NULL_DATE && $profile[$field] > DBA::NULL_DATETIME) {
1037 DI::profileField()->save(DI::profileFieldFactory()->createFromValues(
1046 $profile[$field] = null;
1049 if ($profile['is-default']) {
1050 $profile['profile-name'] = null;
1051 $profile['is-default'] = null;
1052 DBA::update('profile', $profile, ['id' => $profile['id']]);
1053 } else if (!empty($profile['id'])) {
1054 DBA::delete('profile', ['id' => $profile['id']]);