3 * @file src/Model/Profile.php
5 namespace Friendica\Model;
8 use Friendica\Content\Text\BBCode;
9 use Friendica\Content\Widget\ContactBlock;
10 use Friendica\Core\Cache\Duration;
11 use Friendica\Core\Hook;
12 use Friendica\Core\Logger;
13 use Friendica\Core\Protocol;
14 use Friendica\Core\Renderer;
15 use Friendica\Core\Session;
16 use Friendica\Core\System;
17 use Friendica\Database\DBA;
19 use Friendica\Protocol\Activity;
20 use Friendica\Protocol\Diaspora;
21 use Friendica\Util\DateTimeFormat;
22 use Friendica\Util\Network;
23 use Friendica\Util\Proxy as ProxyUtils;
24 use Friendica\Util\Strings;
29 * Returns default profile for a given user id
31 * @param integer User ID
33 * @return array Profile data
36 public static function getByUID($uid)
38 return DBA::selectFirst('profile', [], ['uid' => $uid]);
42 * Returns default profile for a given user ID and ID
44 * @param int $uid The contact ID
45 * @param int $id The contact owner ID
46 * @param array $fields The selected fields
48 * @return array Profile data for the ID
51 public static function getById(int $uid, int $id, array $fields = [])
53 return DBA::selectFirst('profile', $fields, ['uid' => $uid, 'id' => $id]);
57 * Returns profile data for the contact owner
59 * @param int $uid The User ID
60 * @param array $fields The fields to retrieve
62 * @return array Array of profile data
65 public static function getListByUser(int $uid, array $fields = [])
67 return DBA::selectToArray('profile', $fields, ['uid' => $uid]);
71 * Returns a formatted location string from the given profile array
73 * @param array $profile Profile array (Generated from the "profile" table)
75 * @return string Location string
77 public static function formatLocation(array $profile)
81 if (!empty($profile['locality'])) {
82 $location .= $profile['locality'];
85 if (!empty($profile['region']) && (($profile['locality'] ?? '') != $profile['region'])) {
90 $location .= $profile['region'];
93 if (!empty($profile['country-name'])) {
98 $location .= $profile['country-name'];
105 * Loads a profile into the page sidebar.
107 * The function requires a writeable copy of the main App structure, and the nickname
108 * of a registered local account.
110 * If the viewer is an authenticated remote viewer, the profile displayed is the
111 * one that has been configured for his/her viewing in the Contact manager.
112 * Passing a non-zero profile ID can also allow a preview of a selected profile
115 * Profile information is placed in the App structure for later retrieval.
116 * Honours the owner's chosen theme for display.
118 * @attention Should only be run in the _init() functions of a module. That ensures that
119 * the theme is chosen before the _init() function of a theme is run, which will usually
120 * load a lot of theme-specific content
123 * @param string $nickname string
124 * @param int $profile_id int
125 * @param array $profiledata array
126 * @param boolean $show_connect Show connect link
127 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
128 * @throws \ImagickException
130 public static function load(App $a, $nickname, $profile_id = 0, array $profiledata = [], $show_connect = true)
132 $user = DBA::selectFirst('user', ['uid'], ['nickname' => $nickname, 'account_removed' => false]);
134 if (!DBA::isResult($user) && empty($profiledata)) {
135 Logger::log('profile error: ' . DI::args()->getQueryString(), Logger::DEBUG);
139 if (count($profiledata) > 0) {
140 // Ensure to have a "nickname" field
141 if (empty($profiledata['nickname']) && !empty($profiledata['nick'])) {
142 $profiledata['nickname'] = $profiledata['nick'];
145 // Add profile data to sidebar
146 DI::page()['aside'] .= self::sidebar($a, $profiledata, true, $show_connect);
148 if (!DBA::isResult($user)) {
153 $profile = self::getByNickname($nickname, $user['uid']);
155 if (empty($profile) && empty($profiledata)) {
156 Logger::log('profile error: ' . DI::args()->getQueryString(), Logger::DEBUG);
160 if (empty($profile)) {
161 $profile = ['uid' => 0, 'name' => $nickname];
164 $a->profile = $profile;
165 $a->profile_uid = $profile['uid'];
167 $a->profile['mobile-theme'] = DI::pConfig()->get($a->profile['uid'], 'system', 'mobile_theme');
168 $a->profile['network'] = Protocol::DFRN;
170 DI::page()['title'] = $a->profile['name'] . ' @ ' . DI::config()->get('config', 'sitename');
172 if (!$profiledata && !DI::pConfig()->get(local_user(), 'system', 'always_my_theme')) {
173 $a->setCurrentTheme($a->profile['theme']);
174 $a->setCurrentMobileTheme($a->profile['mobile-theme']);
178 * load/reload current theme info
181 Renderer::setActiveTemplateEngine(); // reset the template engine to the default in case the user's theme doesn't specify one
183 $theme_info_file = 'view/theme/' . $a->getCurrentTheme() . '/theme.php';
184 if (file_exists($theme_info_file)) {
185 require_once $theme_info_file;
188 if (local_user() && local_user() == $a->profile['uid'] && $profiledata) {
189 DI::page()['aside'] .= Renderer::replaceMacros(
190 Renderer::getMarkupTemplate('settings/profile/link.tpl'),
192 '$editprofile' => DI::l10n()->t('Edit profile'),
193 '$profid' => $a->profile['id']
198 $block = ((DI::config()->get('system', 'block_public') && !Session::isAuthenticated()) ? true : false);
202 * By now, the contact block isn't shown, when a different profile is given
203 * But: When this profile was on the same server, then we could display the contacts
206 DI::page()['aside'] .= self::sidebar($a, $a->profile, $block, $show_connect);
213 * Get all profile data of a local user
215 * If the viewer is an authenticated remote viewer, the profile displayed is the
216 * one that has been configured for his/her viewing in the Contact manager.
217 * Passing a non-zero profile ID can also allow a preview of a selected profile
220 * Includes all available profile data
222 * @param string $nickname nick
223 * @param int $uid uid
224 * @param int $profile_id ID of the profile
228 public static function getByNickname($nickname, $uid = 0)
230 $profile = DBA::fetchFirst(
231 "SELECT `contact`.`id` AS `contact_id`, `contact`.`photo` AS `contact_photo`,
232 `contact`.`thumb` AS `contact_thumb`, `contact`.`micro` AS `contact_micro`,
234 `contact`.`avatar-date` AS picdate, `contact`.`addr`, `contact`.`url`, `user`.*
236 INNER JOIN `contact` on `contact`.`uid` = `profile`.`uid` AND `contact`.`self`
237 INNER JOIN `user` ON `profile`.`uid` = `user`.`uid`
238 WHERE `user`.`nickname` = ? AND `profile`.`uid` = ? LIMIT 1",
247 * Formats a profile for display in the sidebar.
249 * It is very difficult to templatise the HTML completely
250 * because of all the conditional logic.
252 * @param array $profile
254 * @param boolean $show_connect Show connect link
256 * @return string HTML sidebar module
258 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
259 * @throws \ImagickException
260 * @note Returns empty string if passed $profile is wrong type or not populated
262 * @hooks 'profile_sidebar_enter'
263 * array $profile - profile data
264 * @hooks 'profile_sidebar'
267 private static function sidebar(App $a, $profile, $block = 0, $show_connect = true)
272 // This function can also use contact information in $profile
273 $is_contact = !empty($profile['cid']);
275 if (!is_array($profile) && !count($profile)) {
279 $profile['picdate'] = urlencode($profile['picdate'] ?? '');
281 if (($profile['network'] != '') && ($profile['network'] != Protocol::DFRN)) {
282 $profile['network_link'] = Strings::formatNetworkName($profile['network'], $profile['url']);
284 $profile['network_link'] = '';
287 Hook::callAll('profile_sidebar_enter', $profile);
289 if (isset($profile['url'])) {
290 $profile_url = $profile['url'];
292 $profile_url = DI::baseUrl()->get() . '/profile/' . $profile['nickname'];
296 $unfollow_link = null;
297 $subscribe_feed_link = null;
298 $wallmessage_link = null;
302 $visitor_contact = [];
303 if (!empty($profile['uid']) && self::getMyURL()) {
304 $visitor_contact = Contact::selectFirst(['rel'], ['uid' => $profile['uid'], 'nurl' => Strings::normaliseLink(self::getMyURL())]);
307 $profile_contact = [];
308 if (!empty($profile['cid']) && self::getMyURL()) {
309 $profile_contact = Contact::selectFirst(['rel'], ['id' => $profile['cid']]);
312 $profile_is_dfrn = $profile['network'] == Protocol::DFRN;
313 $profile_is_native = in_array($profile['network'], Protocol::NATIVE_SUPPORT);
314 $local_user_is_self = local_user() && local_user() == ($profile['uid'] ?? 0);
315 $visitor_is_authenticated = (bool)self::getMyURL();
316 $visitor_is_following =
317 in_array($visitor_contact['rel'] ?? 0, [Contact::FOLLOWER, Contact::FRIEND])
318 || in_array($profile_contact['rel'] ?? 0, [Contact::SHARING, Contact::FRIEND]);
319 $visitor_is_followed =
320 in_array($visitor_contact['rel'] ?? 0, [Contact::SHARING, Contact::FRIEND])
321 || in_array($profile_contact['rel'] ?? 0, [Contact::FOLLOWER, Contact::FRIEND]);
322 $visitor_base_path = self::getMyURL() ? preg_replace('=/profile/(.*)=ism', '', self::getMyURL()) : '';
324 if (!$local_user_is_self && $show_connect) {
325 if (!$visitor_is_authenticated) {
326 if (!empty($profile['nickname'])) {
327 $follow_link = 'dfrn_request/' . $profile['nickname'];
329 } elseif ($profile_is_native) {
330 if ($visitor_is_following) {
331 $unfollow_link = $visitor_base_path . '/unfollow?url=' . urlencode($profile_url);
333 $follow_link = $visitor_base_path .'/follow?url=' . urlencode($profile_url);
337 if ($profile_is_dfrn) {
338 $subscribe_feed_link = 'dfrn_poll/' . $profile['nickname'];
341 if (Contact::canReceivePrivateMessages($profile)) {
342 if ($visitor_is_followed || $visitor_is_following) {
343 $wallmessage_link = $visitor_base_path . '/message/new/' . base64_encode($profile['addr'] ?? '');
344 } elseif ($visitor_is_authenticated && !empty($profile['unkmail'])) {
345 $wallmessage_link = 'wallmessage/' . $profile['nickname'];
350 // show edit profile to yourself
351 if (!$is_contact && $local_user_is_self) {
352 $profile['edit'] = [DI::baseUrl() . '/settings/profile', DI::l10n()->t('Edit profile'), '', DI::l10n()->t('Edit profile')];
354 'chg_photo' => DI::l10n()->t('Change profile photo'),
360 // Fetch the account type
361 $account_type = Contact::getAccountType($profile);
363 if (!empty($profile['address'])
364 || !empty($profile['location'])
365 || !empty($profile['locality'])
366 || !empty($profile['region'])
367 || !empty($profile['postal-code'])
368 || !empty($profile['country-name'])
370 $location = DI::l10n()->t('Location:');
373 $gender = !empty($profile['gender']) ? DI::l10n()->t('Gender:') : false;
374 $marital = !empty($profile['marital']) ? DI::l10n()->t('Status:') : false;
375 $homepage = !empty($profile['homepage']) ? DI::l10n()->t('Homepage:') : false;
376 $about = !empty($profile['about']) ? DI::l10n()->t('About:') : false;
377 $xmpp = !empty($profile['xmpp']) ? DI::l10n()->t('XMPP:') : false;
379 if ((!empty($profile['hidewall']) || $block) && !Session::isAuthenticated()) {
380 $location = $gender = $marital = $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['publish'] && $profile['net-publish']) ? 'true' : 'false'),
392 'nickname' => $profile['nickname'],
393 'fullname' => $profile['name'],
394 'firstname' => $firstname,
395 'lastname' => $lastname,
396 'photo300' => $profile['contact_photo'] ?? '',
397 'photo100' => $profile['contact_thumb'] ?? '',
398 'photo50' => $profile['contact_micro'] ?? '',
408 $contact_block = ContactBlock::getHTML($a->profile);
410 if (is_array($a->profile) && !$a->profile['hide-friends']) {
412 "SELECT `gcontact`.`updated` FROM `contact` INNER JOIN `gcontact` WHERE `gcontact`.`nurl` = `contact`.`nurl` AND `self` AND `uid` = %d LIMIT 1",
413 intval($a->profile['uid'])
415 if (DBA::isResult($r)) {
416 $updated = date('c', strtotime($r[0]['updated']));
419 $contact_count = DBA::count('contact', [
420 'uid' => $profile['uid'],
426 'network' => Protocol::FEDERATED,
432 foreach ($profile as $k => $v) {
433 $k = str_replace('-', '_', $k);
437 if (isset($p['about'])) {
438 $p['about'] = BBCode::convert($p['about']);
441 if (empty($p['address']) && !empty($p['location'])) {
442 $p['address'] = $p['location'];
445 if (isset($p['address'])) {
446 $p['address'] = BBCode::convert($p['address']);
449 if (isset($p['gender'])) {
450 $p['gender'] = DI::l10n()->t($p['gender']);
453 if (isset($p['marital'])) {
454 $p['marital'] = DI::l10n()->t($p['marital']);
457 if (isset($p['photo'])) {
458 $p['photo'] = ProxyUtils::proxifyUrl($p['photo'], false, ProxyUtils::SIZE_SMALL);
461 $p['url'] = Contact::magicLink(($p['url'] ?? '') ?: $profile_url);
463 $tpl = Renderer::getMarkupTemplate('profile/vcard.tpl');
464 $o .= Renderer::replaceMacros($tpl, [
467 '$follow' => DI::l10n()->t('Follow'),
468 '$follow_link' => $follow_link,
469 '$unfollow' => DI::l10n()->t('Unfollow'),
470 '$unfollow_link' => $unfollow_link,
471 '$subscribe_feed' => DI::l10n()->t('Atom feed'),
472 '$subscribe_feed_link' => $subscribe_feed_link,
473 '$wallmessage' => DI::l10n()->t('Message'),
474 '$wallmessage_link' => $wallmessage_link,
475 '$account_type' => $account_type,
476 '$location' => $location,
477 '$gender' => $gender,
478 '$marital' => $marital,
479 '$homepage' => $homepage,
481 '$network' => DI::l10n()->t('Network:'),
482 '$contacts' => $contact_count,
483 '$updated' => $updated,
484 '$diaspora' => $diaspora,
485 '$contact_block' => $contact_block,
488 $arr = ['profile' => &$profile, 'entry' => &$o];
490 Hook::callAll('profile_sidebar', $arr);
495 public static function getBirthdays()
500 if (!local_user() || DI::mode()->isMobile() || DI::mode()->isMobile()) {
505 * $mobile_detect = new Mobile_Detect();
506 * $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
511 $bd_format = DI::l10n()->t('g A l F d'); // 8 AM Friday January 18
512 $bd_short = DI::l10n()->t('F d');
514 $cachekey = 'get_birthdays:' . local_user();
515 $r = DI::cache()->get($cachekey);
518 "SELECT `event`.*, `event`.`id` AS `eid`, `contact`.* FROM `event`
520 ON `contact`.`id` = `event`.`cid`
521 AND (`contact`.`rel` = ? OR `contact`.`rel` = ?)
522 AND NOT `contact`.`pending`
523 AND NOT `contact`.`hidden`
524 AND NOT `contact`.`blocked`
525 AND NOT `contact`.`archive`
526 AND NOT `contact`.`deleted`
527 WHERE `event`.`uid` = ? AND `type` = 'birthday' AND `start` < ? AND `finish` > ?
528 ORDER BY `start` ASC ",
532 DateTimeFormat::utc('now + 6 days'),
533 DateTimeFormat::utcNow()
535 if (DBA::isResult($s)) {
536 $r = DBA::toArray($s);
537 DI::cache()->set($cachekey, $r, Duration::HOUR);
543 if (DBA::isResult($r)) {
544 $now = strtotime('now');
548 foreach ($r as $rr) {
549 if (strlen($rr['name'])) {
552 if ((strtotime($rr['start'] . ' +00:00') < $now) && (strtotime($rr['finish'] . ' +00:00') > $now)) {
556 $classtoday = $istoday ? ' birthday-today ' : '';
558 foreach ($r as &$rr) {
559 if (!strlen($rr['name'])) {
565 if (in_array($rr['cid'], $cids)) {
568 $cids[] = $rr['cid'];
570 $today = (((strtotime($rr['start'] . ' +00:00') < $now) && (strtotime($rr['finish'] . ' +00:00') > $now)) ? true : false);
572 $rr['link'] = Contact::magicLink($rr['url']);
573 $rr['title'] = $rr['name'];
574 $rr['date'] = DI::l10n()->getDay(DateTimeFormat::convert($rr['start'], $a->timezone, 'UTC', $rr['adjust'] ? $bd_format : $bd_short)) . (($today) ? ' ' . DI::l10n()->t('[today]') : '');
575 $rr['startime'] = null;
576 $rr['today'] = $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:'),
587 '$lbr' => '{', // raw brackets mess up if/endif macro processing
592 public static function getEventsReminderHTML()
597 if (!local_user() || DI::mode()->isMobile() || DI::mode()->isMobile()) {
602 * $mobile_detect = new Mobile_Detect();
603 * $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
608 $bd_format = DI::l10n()->t('g A l F d'); // 8 AM Friday January 18
611 $condition = ["`uid` = ? AND `type` != 'birthday' AND `start` < ? AND `start` >= ?",
612 local_user(), DateTimeFormat::utc('now + 7 days'), DateTimeFormat::utc('now - 1 days')];
613 $s = DBA::select('event', [], $condition, ['order' => ['start']]);
617 if (DBA::isResult($s)) {
621 while ($rr = DBA::fetch($s)) {
622 $condition = ['parent-uri' => $rr['uri'], 'uid' => $rr['uid'], 'author-id' => public_contact(),
623 'activity' => [Item::activityToIndex( Activity::ATTEND), Item::activityToIndex(Activity::ATTENDMAYBE)],
624 'visible' => true, 'deleted' => false];
625 if (!Item::exists($condition)) {
629 if (strlen($rr['summary'])) {
633 $strt = DateTimeFormat::convert($rr['start'], $rr['adjust'] ? $a->timezone : 'UTC', 'UTC', 'Y-m-d');
634 if ($strt === DateTimeFormat::timezoneNow($a->timezone, 'Y-m-d')) {
638 $title = strip_tags(html_entity_decode(BBCode::convert($rr['summary']), ENT_QUOTES, 'UTF-8'));
640 if (strlen($title) > 35) {
641 $title = substr($title, 0, 32) . '... ';
644 $description = substr(strip_tags(BBCode::convert($rr['desc'])), 0, 32) . '... ';
646 $description = DI::l10n()->t('[No description]');
649 $strt = DateTimeFormat::convert($rr['start'], $rr['adjust'] ? $a->timezone : 'UTC');
651 if (substr($strt, 0, 10) < DateTimeFormat::timezoneNow($a->timezone, 'Y-m-d')) {
655 $today = ((substr($strt, 0, 10) === DateTimeFormat::timezoneNow($a->timezone, 'Y-m-d')) ? true : false);
657 $rr['title'] = $title;
658 $rr['description'] = $description;
659 $rr['date'] = DI::l10n()->getDay(DateTimeFormat::convert($rr['start'], $rr['adjust'] ? $a->timezone : 'UTC', 'UTC', $bd_format)) . (($today) ? ' ' . DI::l10n()->t('[today]') : '');
660 $rr['startime'] = $strt;
661 $rr['today'] = $today;
666 $classtoday = (($istoday) ? 'event-today' : '');
668 $tpl = Renderer::getMarkupTemplate('events_reminder.tpl');
669 return Renderer::replaceMacros($tpl, [
670 '$classtoday' => $classtoday,
671 '$count' => count($r),
672 '$event_reminders' => DI::l10n()->t('Event Reminders'),
673 '$event_title' => DI::l10n()->t('Upcoming events the next 7 days:'),
680 * @param string $current
681 * @param bool $is_owner
682 * @param string $nickname
684 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
686 public static function getTabs(App $a, string $current, bool $is_owner, string $nickname = null)
688 if (is_null($nickname)) {
689 $nickname = $a->user['nickname'];
692 $baseProfileUrl = DI::baseUrl() . '/profile/' . $nickname;
696 'label' => DI::l10n()->t('Profile'),
697 'url' => $baseProfileUrl,
698 'sel' => $current == 'profile' ? 'active' : '',
699 'title' => DI::l10n()->t('Profile Details'),
700 'id' => 'profile-tab',
704 'label' => DI::l10n()->t('Status'),
705 'url' => $baseProfileUrl . '/status',
706 'sel' => $current == 'status' ? 'active' : '',
707 'title' => DI::l10n()->t('Status Messages and Posts'),
708 'id' => 'status-tab',
712 'label' => DI::l10n()->t('Photos'),
713 'url' => DI::baseUrl() . '/photos/' . $nickname,
714 'sel' => $current == 'photos' ? 'active' : '',
715 'title' => DI::l10n()->t('Photo Albums'),
720 'label' => DI::l10n()->t('Videos'),
721 'url' => DI::baseUrl() . '/videos/' . $nickname,
722 'sel' => $current == 'videos' ? 'active' : '',
723 'title' => DI::l10n()->t('Videos'),
729 // the calendar link for the full featured events calendar
730 if ($is_owner && $a->theme_events_in_profile) {
732 'label' => DI::l10n()->t('Events'),
733 'url' => DI::baseUrl() . '/events',
734 'sel' => $current == 'events' ? 'active' : '',
735 'title' => DI::l10n()->t('Events and Calendar'),
736 'id' => 'events-tab',
739 // if the user is not the owner of the calendar we only show a calendar
740 // with the public events of the calendar owner
741 } elseif (!$is_owner) {
743 'label' => DI::l10n()->t('Events'),
744 'url' => DI::baseUrl() . '/cal/' . $nickname,
745 'sel' => $current == 'cal' ? 'active' : '',
746 'title' => DI::l10n()->t('Events and Calendar'),
747 'id' => 'events-tab',
754 'label' => DI::l10n()->t('Personal Notes'),
755 'url' => DI::baseUrl() . '/notes',
756 'sel' => $current == 'notes' ? 'active' : '',
757 'title' => DI::l10n()->t('Only You Can See This'),
763 if (empty($a->profile['hide-friends'])) {
765 'label' => DI::l10n()->t('Contacts'),
766 'url' => $baseProfileUrl . '/contacts',
767 'sel' => $current == 'contacts' ? 'active' : '',
768 'title' => DI::l10n()->t('Contacts'),
769 'id' => 'viewcontacts-tab',
774 if (!empty($_SESSION['new_member']) && $is_owner) {
776 'label' => DI::l10n()->t('Tips for New Members'),
777 'url' => DI::baseUrl() . '/newmember',
779 'title' => DI::l10n()->t('Tips for New Members'),
780 'id' => 'newmember-tab',
784 $arr = ['is_owner' => $is_owner, 'nickname' => $nickname, 'tab' => $current, 'tabs' => $tabs];
786 Hook::callAll('profile_tabs', $arr);
788 $tpl = Renderer::getMarkupTemplate('common_tabs.tpl');
790 return Renderer::replaceMacros($tpl, ['$tabs' => $arr['tabs']]);
794 * Retrieves the my_url session variable
798 public static function getMyURL()
800 return Session::get('my_url');
804 * Process the 'zrl' parameter and initiate the remote authentication.
806 * This method checks if the visitor has a public contact entry and
807 * redirects the visitor to his/her instance to start the magic auth (Authentication)
810 * Ported from Hubzilla: https://framagit.org/hubzilla/core/blob/master/include/channel.php
812 * The implementation for Friendica sadly differs in some points from the one for Hubzilla:
813 * - Hubzilla uses the "zid" parameter, while for Friendica it had been replaced with "zrl"
814 * - There seem to be some reverse authentication (rmagic) that isn't implemented in Friendica at all
816 * It would be favourable to harmonize the two implementations.
818 * @param App $a Application instance.
819 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
820 * @throws \ImagickException
822 public static function zrlInit(App $a)
824 $my_url = self::getMyURL();
825 $my_url = Network::isUrlValid($my_url);
827 if (empty($my_url) || local_user()) {
831 $addr = $_GET['addr'] ?? $my_url;
833 $arr = ['zrl' => $my_url, 'url' => DI::args()->getCommand()];
834 Hook::callAll('zrl_init', $arr);
836 // Try to find the public contact entry of the visitor.
837 $cid = Contact::getIdForURL($my_url);
839 Logger::log('No contact record found for ' . $my_url, Logger::DEBUG);
843 $contact = DBA::selectFirst('contact',['id', 'url'], ['id' => $cid]);
845 if (DBA::isResult($contact) && remote_user() && remote_user() == $contact['id']) {
846 Logger::log('The visitor ' . $my_url . ' is already authenticated', Logger::DEBUG);
850 // Avoid endless loops
851 $cachekey = 'zrlInit:' . $my_url;
852 if (DI::cache()->get($cachekey)) {
853 Logger::log('URL ' . $my_url . ' already tried to authenticate.', Logger::DEBUG);
856 DI::cache()->set($cachekey, true, Duration::MINUTE);
859 Logger::log('Not authenticated. Invoking reverse magic-auth for ' . $my_url, Logger::DEBUG);
861 // Remove the "addr" parameter from the destination. It is later added as separate parameter again.
862 $addr_request = 'addr=' . urlencode($addr);
863 $query = rtrim(str_replace($addr_request, '', DI::args()->getQueryString()), '?&');
865 // The other instance needs to know where to redirect.
866 $dest = urlencode(DI::baseUrl()->get() . '/' . $query);
868 // We need to extract the basebath from the profile url
869 // to redirect the visitors '/magic' module.
870 $basepath = Contact::getBasepath($contact['url']);
872 if ($basepath != DI::baseUrl()->get() && !strstr($dest, '/magic')) {
873 $magic_path = $basepath . '/magic' . '?owa=1&dest=' . $dest . '&' . $addr_request;
875 // We have to check if the remote server does understand /magic without invoking something
876 $serverret = Network::curl($basepath . '/magic');
877 if ($serverret->isSuccess()) {
878 Logger::log('Doing magic auth for visitor ' . $my_url . ' to ' . $magic_path, Logger::DEBUG);
879 System::externalRedirect($magic_path);
885 * Set the visitor cookies (see remote_user()) for the given handle
887 * @param string $handle Visitor handle
888 * @return array Visitor contact array
890 public static function addVisitorCookieForHandle($handle)
894 // Try to find the public contact entry of the visitor.
895 $cid = Contact::getIdForURL($handle);
897 Logger::log('unable to finger ' . $handle, Logger::DEBUG);
901 $visitor = DBA::selectFirst('contact', [], ['id' => $cid]);
903 // Authenticate the visitor.
904 $_SESSION['authenticated'] = 1;
905 $_SESSION['visitor_id'] = $visitor['id'];
906 $_SESSION['visitor_handle'] = $visitor['addr'];
907 $_SESSION['visitor_home'] = $visitor['url'];
908 $_SESSION['my_url'] = $visitor['url'];
910 Session::setVisitorsContacts();
912 $a->contact = $visitor;
914 Logger::info('Authenticated visitor', ['url' => $visitor['url']]);
920 * OpenWebAuth authentication.
922 * Ported from Hubzilla: https://framagit.org/hubzilla/core/blob/master/include/zid.php
924 * @param string $token
925 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
926 * @throws \ImagickException
928 public static function openWebAuthInit($token)
932 // Clean old OpenWebAuthToken entries.
933 OpenWebAuthToken::purge('owt', '3 MINUTE');
935 // Check if the token we got is the same one
936 // we have stored in the database.
937 $visitor_handle = OpenWebAuthToken::getMeta('owt', 0, $token);
939 if ($visitor_handle === false) {
943 $visitor = self::addVisitorCookieForHandle($visitor_handle);
944 if (empty($visitor)) {
949 'visitor' => $visitor,
950 'url' => DI::args()->getQueryString()
953 * @hooks magic_auth_success
954 * Called when a magic-auth was successful.
955 * * \e array \b visitor
958 Hook::callAll('magic_auth_success', $arr);
960 $a->contact = $arr['visitor'];
962 info(DI::l10n()->t('OpenWebAuth: %1$s welcomes %2$s', DI::baseUrl()->getHostname(), $visitor['name']));
964 Logger::log('OpenWebAuth: auth success from ' . $visitor['addr'], Logger::DEBUG);
967 public static function zrl($s, $force = false)
972 if (!strpos($s, '/profile/') && !$force) {
975 if ($force && substr($s, -1, 1) !== '/') {
978 $achar = strpos($s, '?') ? '&' : '?';
979 $mine = self::getMyURL();
980 if ($mine && !Strings::compareLink($mine, $s)) {
981 return $s . $achar . 'zrl=' . urlencode($mine);
987 * Get the user ID of the page owner.
989 * Used from within PCSS themes to set theme parameters. If there's a
990 * profile_uid variable set in App, that is the "page owner" and normally their theme
991 * settings take precedence; unless a local user sets the "always_my_theme"
992 * system pconfig, which means they don't want to see anybody else's theme
993 * settings except their own while on this site.
995 * @return int user ID
997 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
998 * @note Returns local_user instead of user ID if "always_my_theme" is set to true
1000 public static function getThemeUid(App $a)
1002 $uid = !empty($a->profile_uid) ? intval($a->profile_uid) : 0;
1003 if (local_user() && (DI::pConfig()->get(local_user(), 'system', 'always_my_theme') || !$uid)) {
1004 return local_user();
1011 * search for Profiles
1015 * @param null $search
1017 * @return array [ 'total' => 123, 'entries' => [...] ];
1019 * @throws \Exception
1021 public static function searchProfiles($start = 0, $count = 100, $search = null)
1023 $publish = (DI::config()->get('system', 'publish_all') ? '' : "`publish` = 1");
1026 if (!empty($search)) {
1027 $searchTerm = '%' . $search . '%';
1028 $cnt = DBA::fetchFirst("SELECT COUNT(*) AS `total`
1030 LEFT JOIN `user` ON `user`.`uid` = `profile`.`uid`
1031 WHERE $publish AND NOT `user`.`blocked` AND NOT `user`.`account_removed`
1032 AND ((`profile`.`name` LIKE ?) OR
1033 (`user`.`nickname` LIKE ?) OR
1034 (`profile`.`pdesc` LIKE ?) OR
1035 (`profile`.`locality` LIKE ?) OR
1036 (`profile`.`region` LIKE ?) OR
1037 (`profile`.`country-name` LIKE ?) OR
1038 (`profile`.`gender` LIKE ?) OR
1039 (`profile`.`marital` LIKE ?) OR
1040 (`profile`.`sexual` LIKE ?) OR
1041 (`profile`.`about` LIKE ?) OR
1042 (`profile`.`romance` LIKE ?) OR
1043 (`profile`.`work` LIKE ?) OR
1044 (`profile`.`education` LIKE ?) OR
1045 (`profile`.`pub_keywords` LIKE ?) OR
1046 (`profile`.`prv_keywords` LIKE ?))",
1047 $searchTerm, $searchTerm, $searchTerm, $searchTerm, $searchTerm, $searchTerm, $searchTerm, $searchTerm,
1048 $searchTerm, $searchTerm, $searchTerm, $searchTerm, $searchTerm, $searchTerm, $searchTerm);
1050 $cnt = DBA::fetchFirst("SELECT COUNT(*) AS `total`
1052 LEFT JOIN `user` ON `user`.`uid` = `profile`.`uid`
1053 WHERE $publish AND NOT `user`.`blocked` AND NOT `user`.`account_removed`");
1056 if (DBA::isResult($cnt)) {
1057 $total = $cnt['total'];
1060 $order = " ORDER BY `name` ASC ";
1063 // If nothing found, don't try to select details
1065 if (!empty($search)) {
1066 $searchTerm = '%' . $search . '%';
1068 $profiles = DBA::p("SELECT `profile`.*, `profile`.`uid` AS `profile_uid`, `user`.`nickname`, `user`.`timezone` , `user`.`page-flags`,
1069 `contact`.`addr`, `contact`.`url` AS `profile_url`
1071 LEFT JOIN `user` ON `user`.`uid` = `profile`.`uid`
1072 LEFT JOIN `contact` ON `contact`.`uid` = `user`.`uid`
1073 WHERE $publish AND NOT `user`.`blocked` AND NOT `user`.`account_removed` AND `contact`.`self`
1074 AND ((`profile`.`name` LIKE ?) OR
1075 (`user`.`nickname` LIKE ?) OR
1076 (`profile`.`pdesc` LIKE ?) OR
1077 (`profile`.`locality` LIKE ?) OR
1078 (`profile`.`region` LIKE ?) OR
1079 (`profile`.`country-name` LIKE ?) OR
1080 (`profile`.`gender` LIKE ?) OR
1081 (`profile`.`marital` LIKE ?) OR
1082 (`profile`.`sexual` LIKE ?) OR
1083 (`profile`.`about` LIKE ?) OR
1084 (`profile`.`romance` LIKE ?) OR
1085 (`profile`.`work` LIKE ?) OR
1086 (`profile`.`education` LIKE ?) OR
1087 (`profile`.`pub_keywords` LIKE ?) OR
1088 (`profile`.`prv_keywords` LIKE ?))
1090 $searchTerm, $searchTerm, $searchTerm, $searchTerm, $searchTerm, $searchTerm, $searchTerm, $searchTerm,
1091 $searchTerm, $searchTerm, $searchTerm, $searchTerm, $searchTerm, $searchTerm, $searchTerm,
1095 $profiles = DBA::p("SELECT `profile`.*, `profile`.`uid` AS `profile_uid`, `user`.`nickname`, `user`.`timezone` , `user`.`page-flags`,
1096 `contact`.`addr`, `contact`.`url` AS `profile_url`
1098 LEFT JOIN `user` ON `user`.`uid` = `profile`.`uid`
1099 LEFT JOIN `contact` ON `contact`.`uid` = `user`.`uid`
1100 WHERE $publish AND NOT `user`.`blocked` AND NOT `user`.`account_removed` AND `contact`.`self`
1107 if (DBA::isResult($profiles) && $total > 0) {
1110 'entries' => DBA::toArray($profiles),