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\Session;
34 use Friendica\Core\System;
35 use Friendica\Core\Worker;
36 use Friendica\Database\DBA;
38 use Friendica\Network\HTTPClient\Client\HttpClientAccept;
39 use Friendica\Network\HTTPClient\Client\HttpClientOptions;
40 use Friendica\Network\HTTPException;
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
102 public static function update(array $fields, int $uid): bool
104 $old_owner = User::getOwnerDataById($uid);
105 if (empty($old_owner)) {
109 if (!DBA::update('profile', $fields, ['uid' => $uid])) {
113 $update = Contact::updateSelfFromUserID($uid);
115 $owner = User::getOwnerDataById($uid);
120 if ($old_owner['name'] != $owner['name']) {
121 User::update(['username' => $owner['name']], $uid);
124 $profile_fields = ['postal-code', 'dob', 'prv_keywords', 'homepage'];
125 foreach ($profile_fields as $field) {
126 if ($old_owner[$field] != $owner[$field]) {
132 self::publishUpdate($uid, ($old_owner['net-publish'] != $owner['net-publish']));
139 * Publish a changed profile
141 * @param int $uid User id
142 * @param bool $force Force publishing to the directory
146 public static function publishUpdate(int $uid, bool $force = false)
148 $owner = User::getOwnerDataById($uid);
153 if ($owner['net-publish'] || $force) {
154 // Update global directory in background
155 if (Search::getGlobalDirectory()) {
156 Worker::add(PRIORITY_LOW, 'Directory', $owner['url']);
160 Worker::add(PRIORITY_LOW, 'ProfileUpdate', $uid);
164 * Returns a formatted location string from the given profile array
166 * @param array $profile Profile array (Generated from the "profile" table)
168 * @return string Location string
170 public static function formatLocation(array $profile): string
174 if (!empty($profile['locality'])) {
175 $location .= $profile['locality'];
178 if (!empty($profile['region']) && (($profile['locality'] ?? '') != $profile['region'])) {
183 $location .= $profile['region'];
186 if (!empty($profile['country-name'])) {
191 $location .= $profile['country-name'];
198 * Loads a profile into the page sidebar.
200 * The function requires a writeable copy of the main App structure, and the nickname
201 * of a registered local account.
203 * If the viewer is an authenticated remote viewer, the profile displayed is the
204 * one that has been configured for his/her viewing in the Contact manager.
205 * Passing a non-zero profile ID can also allow a preview of a selected profile
208 * Profile information is placed in the App structure for later retrieval.
209 * Honours the owner's chosen theme for display.
211 * @attention Should only be run in the _init() functions of a module. That ensures that
212 * the theme is chosen before the _init() function of a theme is run, which will usually
213 * load a lot of theme-specific content
216 * @param string $nickname string
217 * @param bool $show_contacts
219 * @return array Profile
220 * @throws HTTPException\NotFoundException
221 * @throws HTTPException\InternalServerErrorException
222 * @throws \ImagickException
224 public static function load(App $a, string $nickname, bool $show_contacts = true): array
226 $profile = User::getOwnerDataByNick($nickname);
227 if (!isset($profile['account_removed']) || $profile['account_removed']) {
228 Logger::info('profile error: ' . DI::args()->getQueryString());
232 // System user, aborting
233 if ($profile['uid'] === 0) {
234 DI::logger()->warning('System user found in Profile::load', ['nickname' => $nickname, 'callstack' => System::callstack(20)]);
235 throw new HTTPException\NotFoundException(DI::l10n()->t('User not found.'));
238 $a->setProfileOwner($profile['uid']);
240 DI::page()['title'] = $profile['name'] . ' @ ' . DI::config()->get('config', 'sitename');
243 $a->setCurrentTheme($profile['theme']);
244 $a->setCurrentMobileTheme(DI::pConfig()->get($a->getProfileOwner(), 'system', 'mobile_theme') ?? '');
248 * load/reload current theme info
251 Renderer::setActiveTemplateEngine(); // reset the template engine to the default in case the user's theme doesn't specify one
253 $theme_info_file = 'view/theme/' . $a->getCurrentTheme() . '/theme.php';
254 if (file_exists($theme_info_file)) {
255 require_once $theme_info_file;
258 $block = (DI::config()->get('system', 'block_public') && !Session::isAuthenticated());
262 * By now, the contact block isn't shown, when a different profile is given
263 * But: When this profile was on the same server, then we could display the contacts
265 DI::page()['aside'] .= self::getVCardHtml($profile, $block, $show_contacts);
271 * Formats a profile for display in the sidebar.
273 * It is very difficult to templatise the HTML completely
274 * because of all the conditional logic.
276 * @param array $profile Profile array
277 * @param bool $block Block personal details
278 * @param bool $show_contacts Show contact block
280 * @return string HTML sidebar module
282 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
283 * @throws \ImagickException
284 * @note Returns empty string if passed $profile is wrong type or not populated
286 * @hooks 'profile_sidebar_enter'
287 * array $profile - profile data
288 * @hooks 'profile_sidebar'
291 public static function getVCardHtml(array $profile, bool $block, bool $show_contacts): string
296 $profile_contact = [];
298 if (local_user() && ($profile['uid'] ?? 0) != local_user()) {
299 $profile_contact = Contact::getByURL($profile['nurl'], null, [], local_user());
301 if (!empty($profile['cid']) && self::getMyURL()) {
302 $profile_contact = Contact::selectFirst([], ['id' => $profile['cid']]);
305 $profile['picdate'] = urlencode($profile['picdate']);
307 $profile['network_link'] = '';
309 Hook::callAll('profile_sidebar_enter', $profile);
311 $profile_url = $profile['url'];
313 $cid = $profile['id'];
316 $unfollow_link = null;
317 $wallmessage_link = null;
319 // Who is the logged-in user to this profile?
320 $visitor_contact = [];
321 if (!empty($profile['uid']) && self::getMyURL()) {
322 $visitor_contact = Contact::selectFirst(['rel'], ['uid' => $profile['uid'], 'nurl' => Strings::normaliseLink(self::getMyURL())]);
325 $local_user_is_self = self::getMyURL() && ($profile['url'] == self::getMyURL());
326 $visitor_is_authenticated = (bool)self::getMyURL();
327 $visitor_is_following =
328 in_array($visitor_contact['rel'] ?? 0, [Contact::FOLLOWER, Contact::FRIEND])
329 || in_array($profile_contact['rel'] ?? 0, [Contact::SHARING, Contact::FRIEND]);
330 $visitor_is_followed =
331 in_array($visitor_contact['rel'] ?? 0, [Contact::SHARING, Contact::FRIEND])
332 || in_array($profile_contact['rel'] ?? 0, [Contact::FOLLOWER, Contact::FRIEND]);
333 $visitor_base_path = self::getMyURL() ? preg_replace('=/profile/(.*)=ism', '', self::getMyURL()) : '';
335 if (!$local_user_is_self) {
336 if (!$visitor_is_authenticated) {
337 // Remote follow is only available for local profiles
338 if (!empty($profile['nickname']) && strpos($profile_url, DI::baseUrl()->get()) === 0) {
339 $follow_link = 'remote_follow/' . $profile['nickname'];
342 if ($visitor_is_following) {
343 $unfollow_link = $visitor_base_path . '/unfollow?url=' . urlencode($profile_url) . '&auto=1';
345 $follow_link = $visitor_base_path .'/follow?url=' . urlencode($profile_url) . '&auto=1';
349 if (Contact::canReceivePrivateMessages($profile_contact)) {
350 if ($visitor_is_followed || $visitor_is_following) {
351 $wallmessage_link = $visitor_base_path . '/message/new/' . $profile_contact['id'];
352 } elseif ($visitor_is_authenticated && !empty($profile['unkmail'])) {
353 $wallmessage_link = 'wallmessage/' . $profile['nickname'];
358 // show edit profile to yourself, but only if this is not meant to be
359 // rendered as a "contact". i.e., if 'self' (a "contact" table column) isn't
361 if (!isset($profile['self']) && $local_user_is_self) {
362 $profile['edit'] = [DI::baseUrl() . '/settings/profile', DI::l10n()->t('Edit profile'), '', DI::l10n()->t('Edit profile')];
364 'chg_photo' => DI::l10n()->t('Change profile photo'),
370 // Fetch the account type
371 $account_type = Contact::getAccountType($profile['account-type']);
373 if (!empty($profile['address']) || !empty($profile['location'])) {
374 $location = DI::l10n()->t('Location:');
377 $homepage = !empty($profile['homepage']) ? DI::l10n()->t('Homepage:') : false;
378 $about = !empty($profile['about']) ? DI::l10n()->t('About:') : false;
379 $xmpp = !empty($profile['xmpp']) ? DI::l10n()->t('XMPP:') : false;
380 $matrix = !empty($profile['matrix']) ? DI::l10n()->t('Matrix:') : false;
382 if ((!empty($profile['hidewall']) || $block) && !Session::isAuthenticated()) {
383 $location = $homepage = $about = false;
386 $split_name = Diaspora::splitName($profile['name']);
387 $firstname = $split_name['first'];
388 $lastname = $split_name['last'];
390 if (!empty($profile['guid'])) {
392 'guid' => $profile['guid'],
393 'podloc' => DI::baseUrl(),
394 'searchable' => ($profile['net-publish'] ? 'true' : 'false'),
395 'nickname' => $profile['nickname'],
396 'fullname' => $profile['name'],
397 'firstname' => $firstname,
398 'lastname' => $lastname,
399 'photo300' => $profile['photo'] ?? '',
400 'photo100' => $profile['thumb'] ?? '',
401 'photo50' => $profile['micro'] ?? '',
411 if (!empty($profile['last-item'])) {
412 $updated = date('c', strtotime($profile['last-item']));
415 if (!$block && $show_contacts) {
416 $contact_block = ContactBlock::getHTML($profile, local_user());
418 if (is_array($profile) && !$profile['hide-friends']) {
419 $contact_count = DBA::count('contact', [
420 'uid' => $profile['uid'],
427 'network' => Protocol::FEDERATED,
432 // Expected profile/vcard.tpl profile.* template variables
438 foreach ($profile as $k => $v) {
439 $k = str_replace('-', '_', $k);
443 if (isset($p['about'])) {
444 $p['about'] = BBCode::convertForUriId($profile['uri-id'] ?? 0, $p['about']);
447 if (isset($p['address'])) {
448 $p['address'] = BBCode::convertForUriId($profile['uri-id'] ?? 0, $p['address']);
451 $p['photo'] = Contact::getAvatarUrlForId($cid, Proxy::SIZE_SMALL);
453 $p['url'] = Contact::magicLinkById($cid, $profile['url']);
455 $tpl = Renderer::getMarkupTemplate('profile/vcard.tpl');
456 $o .= Renderer::replaceMacros($tpl, [
459 '$matrix' => $matrix,
460 '$follow' => DI::l10n()->t('Follow'),
461 '$follow_link' => $follow_link,
462 '$unfollow' => DI::l10n()->t('Unfollow'),
463 '$unfollow_link' => $unfollow_link,
464 '$subscribe_feed' => DI::l10n()->t('Atom feed'),
465 '$subscribe_feed_link' => $profile['poll'],
466 '$wallmessage' => DI::l10n()->t('Message'),
467 '$wallmessage_link' => $wallmessage_link,
468 '$account_type' => $account_type,
469 '$location' => $location,
470 '$homepage' => $homepage,
472 '$network' => DI::l10n()->t('Network:'),
473 '$contacts' => $contact_count,
474 '$updated' => $updated,
475 '$diaspora' => $diaspora,
476 '$contact_block' => $contact_block,
479 $arr = ['profile' => &$profile, 'entry' => &$o];
481 Hook::callAll('profile_sidebar', $arr);
487 * Returns the upcoming birthdays of contacts of the current user as HTML content
489 * @return string The upcoming birthdays (HTML)
490 * @throws HTTPException\InternalServerErrorException
491 * @throws HTTPException\ServiceUnavailableException
492 * @throws \ImagickException
494 public static function getBirthdays(): string
496 if (!local_user() || DI::mode()->isMobile() || DI::mode()->isMobile()) {
501 * $mobile_detect = new Mobile_Detect();
502 * $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
507 $bd_short = DI::l10n()->t('F d');
509 $cacheKey = 'get_birthdays:' . local_user();
510 $events = DI::cache()->get($cacheKey);
511 if (is_null($events)) {
513 "SELECT `event`.*, `event`.`id` AS `eid`, `contact`.* FROM `event`
515 ON `contact`.`id` = `event`.`cid`
516 AND (`contact`.`rel` = ? OR `contact`.`rel` = ?)
517 AND NOT `contact`.`pending`
518 AND NOT `contact`.`hidden`
519 AND NOT `contact`.`blocked`
520 AND NOT `contact`.`archive`
521 AND NOT `contact`.`deleted`
522 WHERE `event`.`uid` = ? AND `type` = 'birthday' AND `start` < ? AND `finish` > ?
527 DateTimeFormat::utc('now + 6 days'),
528 DateTimeFormat::utcNow()
530 if (DBA::isResult($result)) {
531 $events = DBA::toArray($result);
532 DI::cache()->set($cacheKey, $events, Duration::HOUR);
539 if (DBA::isResult($events)) {
540 $now = strtotime('now');
544 foreach ($events as $event) {
545 if (strlen($event['name'])) {
548 if ((strtotime($event['start'] . ' +00:00') < $now) && (strtotime($event['finish'] . ' +00:00') > $now)) {
552 $classToday = $isToday ? ' birthday-today ' : '';
554 foreach ($events as $event) {
555 if (!strlen($event['name'])) {
560 if (in_array($event['cid'], $cids)) {
563 $cids[] = $event['cid'];
565 $today = (strtotime($event['start'] . ' +00:00') < $now) && (strtotime($event['finish'] . ' +00:00') > $now);
568 'id' => $event['id'],
569 'link' => Contact::magicLinkById($event['cid']),
570 'title' => $event['name'],
571 'date' => DI::l10n()->getDay(DateTimeFormat::local($event['start'], $bd_short)) . (($today) ? ' ' . DI::l10n()->t('[today]') : '')
576 $tpl = Renderer::getMarkupTemplate('birthdays_reminder.tpl');
577 return Renderer::replaceMacros($tpl, [
578 '$classtoday' => $classToday,
580 '$event_reminders' => DI::l10n()->t('Birthday Reminders'),
581 '$event_title' => DI::l10n()->t('Birthdays this week:'),
582 '$events' => $tpl_events,
583 '$lbr' => '{', // raw brackets mess up if/endif macro processing
589 * Renders HTML for event reminder (e.g. contact birthdays
591 * @return string Rendered HTML
593 public static function getEventsReminderHTML(): string
598 if (!local_user() || DI::mode()->isMobile() || DI::mode()->isMobile()) {
603 * $mobile_detect = new Mobile_Detect();
604 * $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
609 $bd_format = DI::l10n()->t('g A l F d'); // 8 AM Friday January 18
612 $condition = ["`uid` = ? AND `type` != 'birthday' AND `start` < ? AND `start` >= ?",
613 local_user(), DateTimeFormat::utc('now + 7 days'), DateTimeFormat::utc('now - 1 days')];
614 $s = DBA::select('event', [], $condition, ['order' => ['start']]);
618 if (DBA::isResult($s)) {
622 while ($rr = DBA::fetch($s)) {
623 $condition = ['parent-uri' => $rr['uri'], 'uid' => $rr['uid'], 'author-id' => public_contact(),
624 'vid' => [Verb::getID(Activity::ATTEND), Verb::getID(Activity::ATTENDMAYBE)],
625 'visible' => true, 'deleted' => false];
626 if (!Post::exists($condition)) {
630 if (strlen($rr['summary'])) {
634 $strt = DateTimeFormat::local($rr['start'], 'Y-m-d');
635 if ($strt === DateTimeFormat::localNow('Y-m-d')) {
639 $title = strip_tags(html_entity_decode(BBCode::convertForUriId($rr['uri-id'], $rr['summary']), ENT_QUOTES, 'UTF-8'));
641 if (strlen($title) > 35) {
642 $title = substr($title, 0, 32) . '... ';
645 $description = substr(strip_tags(BBCode::convertForUriId($rr['uri-id'], $rr['desc'])), 0, 32) . '... ';
647 $description = DI::l10n()->t('[No description]');
650 $strt = DateTimeFormat::local($rr['start']);
652 if (substr($strt, 0, 10) < DateTimeFormat::localNow('Y-m-d')) {
656 $today = substr($strt, 0, 10) === DateTimeFormat::localNow('Y-m-d');
658 $rr['title'] = $title;
659 $rr['description'] = $description;
660 $rr['date'] = DI::l10n()->getDay(DateTimeFormat::local($rr['start'], $bd_format)) . (($today) ? ' ' . DI::l10n()->t('[today]') : '');
661 $rr['startime'] = $strt;
662 $rr['today'] = $today;
667 $classtoday = (($istoday) ? 'event-today' : '');
669 $tpl = Renderer::getMarkupTemplate('events_reminder.tpl');
670 return Renderer::replaceMacros($tpl, [
671 '$classtoday' => $classtoday,
672 '$count' => count($r),
673 '$event_reminders' => DI::l10n()->t('Event Reminders'),
674 '$event_title' => DI::l10n()->t('Upcoming events the next 7 days:'),
680 * Retrieves the my_url session variable
684 public static function getMyURL(): string
686 return Session::get('my_url') ?? '';
690 * Process the 'zrl' parameter and initiate the remote authentication.
692 * This method checks if the visitor has a public contact entry and
693 * redirects the visitor to his/her instance to start the magic auth (Authentication)
696 * Ported from Hubzilla: https://framagit.org/hubzilla/core/blob/master/include/channel.php
698 * The implementation for Friendica sadly differs in some points from the one for Hubzilla:
699 * - Hubzilla uses the "zid" parameter, while for Friendica it had been replaced with "zrl"
700 * - There seem to be some reverse authentication (rmagic) that isn't implemented in Friendica at all
702 * It would be favourable to harmonize the two implementations.
704 * @param App $a Application instance.
707 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
708 * @throws \ImagickException
710 public static function zrlInit(App $a)
712 $my_url = self::getMyURL();
713 $my_url = Network::isUrlValid($my_url);
715 if (empty($my_url) || local_user()) {
719 $addr = $_GET['addr'] ?? $my_url;
721 $arr = ['zrl' => $my_url, 'url' => DI::args()->getCommand()];
722 Hook::callAll('zrl_init', $arr);
724 // Try to find the public contact entry of the visitor.
725 $cid = Contact::getIdForURL($my_url);
727 Logger::info('No contact record found for ' . $my_url);
731 $contact = DBA::selectFirst('contact',['id', 'url'], ['id' => $cid]);
733 if (DBA::isResult($contact) && remote_user() && remote_user() == $contact['id']) {
734 Logger::info('The visitor ' . $my_url . ' is already authenticated');
738 // Avoid endless loops
739 $cachekey = 'zrlInit:' . $my_url;
740 if (DI::cache()->get($cachekey)) {
741 Logger::info('URL ' . $my_url . ' already tried to authenticate.');
744 DI::cache()->set($cachekey, true, Duration::MINUTE);
747 Logger::info('Not authenticated. Invoking reverse magic-auth for ' . $my_url);
749 // Remove the "addr" parameter from the destination. It is later added as separate parameter again.
750 $addr_request = 'addr=' . urlencode($addr);
751 $query = rtrim(str_replace($addr_request, '', DI::args()->getQueryString()), '?&');
753 // The other instance needs to know where to redirect.
754 $dest = urlencode(DI::baseUrl()->get() . '/' . $query);
756 // We need to extract the basebath from the profile url
757 // to redirect the visitors '/magic' module.
758 $basepath = Contact::getBasepath($contact['url']);
760 if ($basepath != DI::baseUrl()->get() && !strstr($dest, '/magic')) {
761 $magic_path = $basepath . '/magic' . '?owa=1&dest=' . $dest . '&' . $addr_request;
763 // We have to check if the remote server does understand /magic without invoking something
764 $serverret = DI::httpClient()->head($basepath . '/magic', [HttpClientOptions::ACCEPT_CONTENT => HttpClientAccept::HTML]);
765 if ($serverret->isSuccess()) {
766 Logger::info('Doing magic auth for visitor ' . $my_url . ' to ' . $magic_path);
767 System::externalRedirect($magic_path);
773 * Set the visitor cookies (see remote_user()) for the given handle
775 * @param string $handle Visitor handle
777 * @return array Visitor contact array
779 public static function addVisitorCookieForHandle(string $handle): array
783 // Try to find the public contact entry of the visitor.
784 $cid = Contact::getIdForURL($handle);
786 Logger::info('Handle not found', ['handle' => $handle]);
790 $visitor = Contact::getById($cid);
792 // Authenticate the visitor.
793 $_SESSION['authenticated'] = 1;
794 $_SESSION['visitor_id'] = $visitor['id'];
795 $_SESSION['visitor_handle'] = $visitor['addr'];
796 $_SESSION['visitor_home'] = $visitor['url'];
797 $_SESSION['my_url'] = $visitor['url'];
798 $_SESSION['remote_comment'] = $visitor['subscribe'];
800 Session::setVisitorsContacts();
802 $a->setContactId($visitor['id']);
804 Logger::info('Authenticated visitor', ['url' => $visitor['url']]);
810 * Set the visitor cookies (see remote_user()) for signed HTTP requests
812 * @return array Visitor contact array
814 public static function addVisitorCookieForHTTPSigner(): array
816 $requester = HTTPSignature::getSigner('', $_SERVER);
817 if (empty($requester)) {
820 return Profile::addVisitorCookieForHandle($requester);
824 * OpenWebAuth authentication.
826 * Ported from Hubzilla: https://framagit.org/hubzilla/core/blob/master/include/zid.php
828 * @param string $token
831 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
832 * @throws \ImagickException
834 public static function openWebAuthInit(string $token)
838 // Clean old OpenWebAuthToken entries.
839 OpenWebAuthToken::purge('owt', '3 MINUTE');
841 // Check if the token we got is the same one
842 // we have stored in the database.
843 $visitor_handle = OpenWebAuthToken::getMeta('owt', 0, $token);
845 if ($visitor_handle === false) {
849 $visitor = self::addVisitorCookieForHandle($visitor_handle);
850 if (empty($visitor)) {
855 'visitor' => $visitor,
856 'url' => DI::args()->getQueryString()
859 * @hooks magic_auth_success
860 * Called when a magic-auth was successful.
861 * * \e array \b visitor
864 Hook::callAll('magic_auth_success', $arr);
866 $a->setContactId($arr['visitor']['id']);
868 info(DI::l10n()->t('OpenWebAuth: %1$s welcomes %2$s', DI::baseUrl()->getHostname(), $visitor['name']));
870 Logger::info('OpenWebAuth: auth success from ' . $visitor['addr']);
874 * Returns URL with URL-encoded zrl parameter
876 * @param string $url URL to enhance
877 * @param bool $force Either to force adding zrl parameter
879 * @return string URL with 'zrl' parameter or original URL in case of no Friendica profile URL
881 public static function zrl(string $url, bool $force = false): string
886 if (!strpos($url, '/profile/') && !$force) {
889 if ($force && substr($url, -1, 1) !== '/') {
893 $achar = strpos($url, '?') ? '&' : '?';
894 $mine = self::getMyURL();
896 if ($mine && !Strings::compareLink($mine, $url)) {
897 return $url . $achar . 'zrl=' . urlencode($mine);
904 * Get the user ID of the page owner.
906 * Used from within PCSS themes to set theme parameters. If there's a
907 * profile_uid variable set in App, that is the "page owner" and normally their theme
908 * settings take precedence; unless a local user is logged in which means they don't
909 * want to see anybody else's theme settings except their own while on this site.
913 * @return int user ID
915 * @note Returns local_user instead of user ID if "always_my_theme" is set to true
917 public static function getThemeUid(App $a): int
919 return local_user() ?: $a->getProfileOwner();
923 * search for Profiles
925 * @param int $start Starting record (see LIMIT start,count)
926 * @param int $count Maximum records (see LIMIT start,count)
927 * @param string $search Optional search word (see LIKE %s?%s)
929 * @return array [ 'total' => 123, 'entries' => [...] ];
933 public static function searchProfiles(int $start = 0, int $count = 100, string $search = null): array
935 if (!empty($search)) {
936 $publish = (DI::config()->get('system', 'publish_all') ? '' : "AND `publish` ");
937 $searchTerm = '%' . $search . '%';
938 $condition = ["NOT `blocked` AND NOT `account_removed`
940 AND ((`name` LIKE ?) OR
941 (`nickname` LIKE ?) OR
943 (`locality` LIKE ?) OR
945 (`country-name` LIKE ?) OR
946 (`pub_keywords` LIKE ?) OR
947 (`prv_keywords` LIKE ?))",
948 $searchTerm, $searchTerm, $searchTerm, $searchTerm,
949 $searchTerm, $searchTerm, $searchTerm, $searchTerm];
951 $condition = ['blocked' => false, 'account_removed' => false];
952 if (!DI::config()->get('system', 'publish_all')) {
953 $condition['publish'] = true;
957 $total = DBA::count('owner-view', $condition);
959 // If nothing found, don't try to select details
961 $profiles = DBA::selectToArray('owner-view', [], $condition, ['order' => ['name'], 'limit' => [$start, $count]]);
966 return ['total' => $total, 'entries' => $profiles];
970 * Migrates a legacy profile to the new slimmer profile with extra custom fields.
971 * Multi profiles are converted to ACl-protected custom fields and deleted.
973 * @param array $profile One profile array
978 public static function migrate(array $profile)
980 // Already processed, aborting
981 if ($profile['is-default'] === null) {
987 if (!$profile['is-default']) {
988 $contacts = Contact::selectToArray(['id'], [
989 'uid' => $profile['uid'],
990 'profile-id' => $profile['id']
992 if (!count($contacts)) {
993 // No contact visibility selected defaults to user-only permission
994 $contacts = Contact::selectToArray(['id'], ['uid' => $profile['uid'], 'self' => true]);
998 $permissionSet = DI::permissionSet()->selectOrCreate(
1001 array_column($contacts, 'id') ?? []
1008 'hometown' => DI::l10n()->t('Hometown:'),
1009 'marital' => DI::l10n()->t('Marital Status:'),
1010 'with' => DI::l10n()->t('With:'),
1011 'howlong' => DI::l10n()->t('Since:'),
1012 'sexual' => DI::l10n()->t('Sexual Preference:'),
1013 'politic' => DI::l10n()->t('Political Views:'),
1014 'religion' => DI::l10n()->t('Religious Views:'),
1015 'likes' => DI::l10n()->t('Likes:'),
1016 'dislikes' => DI::l10n()->t('Dislikes:'),
1017 'pdesc' => DI::l10n()->t('Title/Description:'),
1018 'summary' => DI::l10n()->t('Summary'),
1019 'music' => DI::l10n()->t('Musical interests'),
1020 'book' => DI::l10n()->t('Books, literature'),
1021 'tv' => DI::l10n()->t('Television'),
1022 'film' => DI::l10n()->t('Film/dance/culture/entertainment'),
1023 'interest' => DI::l10n()->t('Hobbies/Interests'),
1024 'romance' => DI::l10n()->t('Love/romance'),
1025 'work' => DI::l10n()->t('Work/employment'),
1026 'education' => DI::l10n()->t('School/education'),
1027 'contact' => DI::l10n()->t('Contact information and Social Networks'),
1030 foreach ($custom_fields as $field => $label) {
1031 if (!empty($profile[$field]) && $profile[$field] > DBA::NULL_DATE && $profile[$field] > DBA::NULL_DATETIME) {
1032 DI::profileField()->save(DI::profileFieldFactory()->createFromValues(
1041 $profile[$field] = null;
1044 if ($profile['is-default']) {
1045 $profile['profile-name'] = null;
1046 $profile['is-default'] = null;
1047 DBA::update('profile', $profile, ['id' => $profile['id']]);
1048 } else if (!empty($profile['id'])) {
1049 DBA::delete('profile', ['id' => $profile['id']]);