3 * @copyright Copyright (C) 2010-2021, 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\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\Protocol\Activity;
39 use Friendica\Protocol\Diaspora;
40 use Friendica\Util\DateTimeFormat;
41 use Friendica\Util\HTTPSignature;
42 use Friendica\Util\Network;
43 use Friendica\Util\Proxy as ProxyUtils;
44 use Friendica\Util\Strings;
49 * Returns default profile for a given user id
51 * @param integer User ID
53 * @return array Profile data
56 public static function getByUID($uid)
58 return DBA::selectFirst('profile', [], ['uid' => $uid]);
62 * Returns default profile for a given user ID and ID
64 * @param int $uid The contact ID
65 * @param int $id The contact owner ID
66 * @param array $fields The selected fields
68 * @return array Profile data for the ID
71 public static function getById(int $uid, int $id, array $fields = [])
73 return DBA::selectFirst('profile', $fields, ['uid' => $uid, 'id' => $id]);
77 * Returns profile data for the contact owner
79 * @param int $uid The User ID
80 * @param array $fields The fields to retrieve
82 * @return array Array of profile data
85 public static function getListByUser(int $uid, array $fields = [])
87 return DBA::selectToArray('profile', $fields, ['uid' => $uid]);
91 * Update a profile entry and distribute the changes if needed
93 * @param array $fields
97 public static function update(array $fields, int $uid): bool
99 $old_owner = User::getOwnerDataById($uid);
100 if (empty($old_owner)) {
104 if (!DBA::update('profile', $fields, ['uid' => $uid])) {
108 $update = Contact::updateSelfFromUserID($uid);
110 $owner = User::getOwnerDataById($uid);
115 if ($old_owner['name'] != $owner['name']) {
116 User::update(['username' => $owner['name']], $uid);
119 $profile_fields = ['postal-code', 'dob', 'prv_keywords', 'homepage'];
120 foreach ($profile_fields as $field) {
121 if ($old_owner[$field] != $owner[$field]) {
127 self::publishUpdate($uid, ($old_owner['net-publish'] != $owner['net-publish']));
134 * Publish a changed profile
136 * @param bool $force Force publishing to the directory
138 public static function publishUpdate(int $uid, bool $force = false)
140 $owner = User::getOwnerDataById($uid);
145 if ($owner['net-publish'] || $force) {
146 // Update global directory in background
147 if (Search::getGlobalDirectory()) {
148 Worker::add(PRIORITY_LOW, 'Directory', $owner['url']);
152 Worker::add(PRIORITY_LOW, 'ProfileUpdate', $uid);
156 * Returns a formatted location string from the given profile array
158 * @param array $profile Profile array (Generated from the "profile" table)
160 * @return string Location string
162 public static function formatLocation(array $profile)
166 if (!empty($profile['locality'])) {
167 $location .= $profile['locality'];
170 if (!empty($profile['region']) && (($profile['locality'] ?? '') != $profile['region'])) {
175 $location .= $profile['region'];
178 if (!empty($profile['country-name'])) {
183 $location .= $profile['country-name'];
190 * Loads a profile into the page sidebar.
192 * The function requires a writeable copy of the main App structure, and the nickname
193 * of a registered local account.
195 * If the viewer is an authenticated remote viewer, the profile displayed is the
196 * one that has been configured for his/her viewing in the Contact manager.
197 * Passing a non-zero profile ID can also allow a preview of a selected profile
200 * Profile information is placed in the App structure for later retrieval.
201 * Honours the owner's chosen theme for display.
203 * @attention Should only be run in the _init() functions of a module. That ensures that
204 * the theme is chosen before the _init() function of a theme is run, which will usually
205 * load a lot of theme-specific content
208 * @param string $nickname string
209 * @param array $profiledata array
210 * @param boolean $show_connect Show connect link
211 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
212 * @throws \ImagickException
214 public static function load(App $a, $nickname, array $profiledata = [], $show_connect = true)
216 $user = DBA::selectFirst('user', ['uid'], ['nickname' => $nickname, 'account_removed' => false]);
218 if (!DBA::isResult($user) && empty($profiledata)) {
219 Logger::log('profile error: ' . DI::args()->getQueryString(), Logger::DEBUG);
223 if (count($profiledata) > 0) {
224 // Ensure to have a "nickname" field
225 if (empty($profiledata['nickname']) && !empty($profiledata['nick'])) {
226 $profiledata['nickname'] = $profiledata['nick'];
229 // Add profile data to sidebar
230 DI::page()['aside'] .= self::sidebar($a, $profiledata, true, $show_connect);
232 if (!DBA::isResult($user)) {
237 $profile = !empty($user['uid']) ? User::getOwnerDataById($user['uid'], false) : [];
239 if (empty($profile) && empty($profiledata)) {
240 Logger::log('profile error: ' . DI::args()->getQueryString(), Logger::DEBUG);
244 if (empty($profile)) {
245 $profile = ['uid' => 0, 'name' => $nickname];
248 $a->profile = $profile;
249 $a->profile_uid = $profile['uid'];
251 $a->profile['mobile-theme'] = DI::pConfig()->get($a->profile['uid'], 'system', 'mobile_theme');
252 $a->profile['network'] = Protocol::DFRN;
254 DI::page()['title'] = $a->profile['name'] . ' @ ' . DI::config()->get('config', 'sitename');
256 if (!$profiledata && !DI::pConfig()->get(local_user(), 'system', 'always_my_theme')) {
257 $a->setCurrentTheme($a->profile['theme']);
258 $a->setCurrentMobileTheme($a->profile['mobile-theme']);
262 * load/reload current theme info
265 Renderer::setActiveTemplateEngine(); // reset the template engine to the default in case the user's theme doesn't specify one
267 $theme_info_file = 'view/theme/' . $a->getCurrentTheme() . '/theme.php';
268 if (file_exists($theme_info_file)) {
269 require_once $theme_info_file;
272 $block = ((DI::config()->get('system', 'block_public') && !Session::isAuthenticated()) ? true : false);
276 * By now, the contact block isn't shown, when a different profile is given
277 * But: When this profile was on the same server, then we could display the contacts
280 DI::page()['aside'] .= self::sidebar($a, $a->profile, $block, $show_connect);
287 * Get the profile for the given nick name
289 * Includes all available profile data
291 * @param string $nickname nick
295 public static function getByNickname($nickname)
297 $profile = DBA::selectFirst('owner-view', [], ['nickname' => $nickname]);
302 * Formats a profile for display in the sidebar.
304 * It is very difficult to templatise the HTML completely
305 * because of all the conditional logic.
307 * @param array $profile
309 * @param boolean $show_connect Show connect link
311 * @return string HTML sidebar module
313 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
314 * @throws \ImagickException
315 * @note Returns empty string if passed $profile is wrong type or not populated
317 * @hooks 'profile_sidebar_enter'
318 * array $profile - profile data
319 * @hooks 'profile_sidebar'
322 private static function sidebar(App $a, array $profile, $block = 0, $show_connect = true)
327 // This function can also use contact information in $profile, but the 'cid'
328 // value is going to be coming from 'owner-view', which means it's the wrong
329 // contact ID for the user viewing this page. Use 'nurl' to look up the
330 // correct contact table entry for the logged-in user.
331 $profile_contact = [];
333 if (!empty($profile['nurl'])) {
334 if (local_user() && ($profile['uid'] ?? 0) != local_user()) {
335 $profile_contact = Contact::getByURL($profile['nurl'], null, ['rel'], local_user());
337 if (!empty($profile['cid']) && self::getMyURL()) {
338 $profile_contact = Contact::selectFirst(['rel'], ['id' => $profile['cid']]);
342 if (empty($profile['nickname'])) {
343 Logger::warning('Received profile with no nickname', ['profile' => $profile, 'callstack' => System::callstack(10)]);
347 $profile['picdate'] = urlencode($profile['picdate'] ?? '');
349 if (($profile['network'] != '') && ($profile['network'] != Protocol::DFRN)) {
350 $profile['network_link'] = Strings::formatNetworkName($profile['network'], $profile['url']);
352 $profile['network_link'] = '';
355 Hook::callAll('profile_sidebar_enter', $profile);
357 if (isset($profile['url'])) {
358 $profile_url = $profile['url'];
360 $profile_url = DI::baseUrl()->get() . '/profile/' . $profile['nickname'];
363 if (!empty($profile['id'])) {
364 $cid = $profile['id'];
366 $cid = Contact::getIdForURL($profile_url, false);
370 $unfollow_link = null;
371 $subscribe_feed_link = null;
372 $wallmessage_link = null;
374 // Who is the logged-in user to this profile?
375 $visitor_contact = [];
376 if (!empty($profile['uid']) && self::getMyURL()) {
377 $visitor_contact = Contact::selectFirst(['rel'], ['uid' => $profile['uid'], 'nurl' => Strings::normaliseLink(self::getMyURL())]);
380 $profile_is_dfrn = $profile['network'] == Protocol::DFRN;
381 $profile_is_native = in_array($profile['network'], Protocol::NATIVE_SUPPORT);
382 $local_user_is_self = self::getMyURL() && ($profile['url'] == self::getMyURL());
383 $visitor_is_authenticated = (bool)self::getMyURL();
384 $visitor_is_following =
385 in_array($visitor_contact['rel'] ?? 0, [Contact::FOLLOWER, Contact::FRIEND])
386 || in_array($profile_contact['rel'] ?? 0, [Contact::SHARING, Contact::FRIEND]);
387 $visitor_is_followed =
388 in_array($visitor_contact['rel'] ?? 0, [Contact::SHARING, Contact::FRIEND])
389 || in_array($profile_contact['rel'] ?? 0, [Contact::FOLLOWER, Contact::FRIEND]);
390 $visitor_base_path = self::getMyURL() ? preg_replace('=/profile/(.*)=ism', '', self::getMyURL()) : '';
392 if (!$local_user_is_self && $show_connect) {
393 if (!$visitor_is_authenticated) {
394 // Remote follow is only available for local profiles
395 if (!empty($profile['nickname']) && strpos($profile_url, DI::baseUrl()->get()) === 0) {
396 $follow_link = 'remote_follow/' . $profile['nickname'];
398 } elseif ($profile_is_native) {
399 if ($visitor_is_following) {
400 $unfollow_link = $visitor_base_path . '/unfollow?url=' . urlencode($profile_url) . '&auto=1';
402 $follow_link = $visitor_base_path .'/follow?url=' . urlencode($profile_url) . '&auto=1';
406 if ($profile_is_dfrn) {
407 $subscribe_feed_link = 'dfrn_poll/' . $profile['nickname'];
410 if (Contact::canReceivePrivateMessages($profile_contact)) {
411 if ($visitor_is_followed || $visitor_is_following) {
412 $wallmessage_link = $visitor_base_path . '/message/new/' . $profile_contact['id'];
413 } elseif ($visitor_is_authenticated && !empty($profile['unkmail'])) {
414 $wallmessage_link = 'wallmessage/' . $profile['nickname'];
419 // show edit profile to yourself, but only if this is not meant to be
420 // rendered as a "contact". i.e., if 'self' (a "contact" table column) isn't
422 if (!isset($profile['self']) && $local_user_is_self) {
423 $profile['edit'] = [DI::baseUrl() . '/settings/profile', DI::l10n()->t('Edit profile'), '', DI::l10n()->t('Edit profile')];
425 'chg_photo' => DI::l10n()->t('Change profile photo'),
431 // Fetch the account type
432 $account_type = Contact::getAccountType($profile);
434 if (!empty($profile['address']) || !empty($profile['location'])) {
435 $location = DI::l10n()->t('Location:');
438 $homepage = !empty($profile['homepage']) ? DI::l10n()->t('Homepage:') : false;
439 $about = !empty($profile['about']) ? DI::l10n()->t('About:') : false;
440 $xmpp = !empty($profile['xmpp']) ? DI::l10n()->t('XMPP:') : false;
442 if ((!empty($profile['hidewall']) || $block) && !Session::isAuthenticated()) {
443 $location = $homepage = $about = false;
446 $split_name = Diaspora::splitName($profile['name']);
447 $firstname = $split_name['first'];
448 $lastname = $split_name['last'];
450 if (!empty($profile['guid'])) {
452 'guid' => $profile['guid'],
453 'podloc' => DI::baseUrl(),
454 'searchable' => ($profile['net-publish'] ? 'true' : 'false'),
455 'nickname' => $profile['nickname'],
456 'fullname' => $profile['name'],
457 'firstname' => $firstname,
458 'lastname' => $lastname,
459 'photo300' => $profile['photo'] ?? '',
460 'photo100' => $profile['thumb'] ?? '',
461 'photo50' => $profile['micro'] ?? '',
471 if (!empty($profile['last-item'])) {
472 $updated = date('c', strtotime($profile['last-item']));
476 $contact_block = ContactBlock::getHTML($a->profile);
478 if (is_array($a->profile) && !$a->profile['hide-friends']) {
479 $contact_count = DBA::count('contact', [
480 'uid' => $profile['uid'],
487 'network' => Protocol::FEDERATED,
492 // Expected profile/vcard.tpl profile.* template variables
498 foreach ($profile as $k => $v) {
499 $k = str_replace('-', '_', $k);
503 if (isset($p['about'])) {
504 $p['about'] = BBCode::convert($p['about']);
507 if (isset($p['address'])) {
508 $p['address'] = BBCode::convert($p['address']);
511 $p['photo'] = Contact::getAvatarUrlForId($cid, ProxyUtils::SIZE_SMALL);
513 $p['url'] = Contact::magicLinkById($cid);
515 $tpl = Renderer::getMarkupTemplate('profile/vcard.tpl');
516 $o .= Renderer::replaceMacros($tpl, [
519 '$follow' => DI::l10n()->t('Follow'),
520 '$follow_link' => $follow_link,
521 '$unfollow' => DI::l10n()->t('Unfollow'),
522 '$unfollow_link' => $unfollow_link,
523 '$subscribe_feed' => DI::l10n()->t('Atom feed'),
524 '$subscribe_feed_link' => $subscribe_feed_link,
525 '$wallmessage' => DI::l10n()->t('Message'),
526 '$wallmessage_link' => $wallmessage_link,
527 '$account_type' => $account_type,
528 '$location' => $location,
529 '$homepage' => $homepage,
531 '$network' => DI::l10n()->t('Network:'),
532 '$contacts' => $contact_count,
533 '$updated' => $updated,
534 '$diaspora' => $diaspora,
535 '$contact_block' => $contact_block,
538 $arr = ['profile' => &$profile, 'entry' => &$o];
540 Hook::callAll('profile_sidebar', $arr);
545 public static function getBirthdays()
550 if (!local_user() || DI::mode()->isMobile() || DI::mode()->isMobile()) {
555 * $mobile_detect = new Mobile_Detect();
556 * $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
561 $bd_format = DI::l10n()->t('g A l F d'); // 8 AM Friday January 18
562 $bd_short = DI::l10n()->t('F d');
564 $cachekey = 'get_birthdays:' . local_user();
565 $r = DI::cache()->get($cachekey);
568 "SELECT `event`.*, `event`.`id` AS `eid`, `contact`.* FROM `event`
570 ON `contact`.`id` = `event`.`cid`
571 AND (`contact`.`rel` = ? OR `contact`.`rel` = ?)
572 AND NOT `contact`.`pending`
573 AND NOT `contact`.`hidden`
574 AND NOT `contact`.`blocked`
575 AND NOT `contact`.`archive`
576 AND NOT `contact`.`deleted`
577 WHERE `event`.`uid` = ? AND `type` = 'birthday' AND `start` < ? AND `finish` > ?
578 ORDER BY `start` ASC ",
582 DateTimeFormat::utc('now + 6 days'),
583 DateTimeFormat::utcNow()
585 if (DBA::isResult($s)) {
586 $r = DBA::toArray($s);
587 DI::cache()->set($cachekey, $r, Duration::HOUR);
593 if (DBA::isResult($r)) {
594 $now = strtotime('now');
598 foreach ($r as $rr) {
599 if (strlen($rr['name'])) {
602 if ((strtotime($rr['start'] . ' +00:00') < $now) && (strtotime($rr['finish'] . ' +00:00') > $now)) {
606 $classtoday = $istoday ? ' birthday-today ' : '';
608 foreach ($r as &$rr) {
609 if (!strlen($rr['name'])) {
615 if (in_array($rr['cid'], $cids)) {
618 $cids[] = $rr['cid'];
620 $today = (((strtotime($rr['start'] . ' +00:00') < $now) && (strtotime($rr['finish'] . ' +00:00') > $now)) ? true : false);
622 $rr['link'] = Contact::magicLinkById($rr['cid']);
623 $rr['title'] = $rr['name'];
624 $rr['date'] = DI::l10n()->getDay(DateTimeFormat::convert($rr['start'], $a->timezone, 'UTC', $rr['adjust'] ? $bd_format : $bd_short)) . (($today) ? ' ' . DI::l10n()->t('[today]') : '');
625 $rr['startime'] = null;
626 $rr['today'] = $today;
630 $tpl = Renderer::getMarkupTemplate('birthdays_reminder.tpl');
631 return Renderer::replaceMacros($tpl, [
632 '$classtoday' => $classtoday,
634 '$event_reminders' => DI::l10n()->t('Birthday Reminders'),
635 '$event_title' => DI::l10n()->t('Birthdays this week:'),
637 '$lbr' => '{', // raw brackets mess up if/endif macro processing
642 public static function getEventsReminderHTML()
647 if (!local_user() || DI::mode()->isMobile() || DI::mode()->isMobile()) {
652 * $mobile_detect = new Mobile_Detect();
653 * $is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
658 $bd_format = DI::l10n()->t('g A l F d'); // 8 AM Friday January 18
661 $condition = ["`uid` = ? AND `type` != 'birthday' AND `start` < ? AND `start` >= ?",
662 local_user(), DateTimeFormat::utc('now + 7 days'), DateTimeFormat::utc('now - 1 days')];
663 $s = DBA::select('event', [], $condition, ['order' => ['start']]);
667 if (DBA::isResult($s)) {
671 while ($rr = DBA::fetch($s)) {
672 $condition = ['parent-uri' => $rr['uri'], 'uid' => $rr['uid'], 'author-id' => public_contact(),
673 'vid' => [Verb::getID(Activity::ATTEND), Verb::getID(Activity::ATTENDMAYBE)],
674 'visible' => true, 'deleted' => false];
675 if (!Post::exists($condition)) {
679 if (strlen($rr['summary'])) {
683 $strt = DateTimeFormat::convert($rr['start'], $rr['adjust'] ? $a->timezone : 'UTC', 'UTC', 'Y-m-d');
684 if ($strt === DateTimeFormat::timezoneNow($a->timezone, 'Y-m-d')) {
688 $title = strip_tags(html_entity_decode(BBCode::convert($rr['summary']), ENT_QUOTES, 'UTF-8'));
690 if (strlen($title) > 35) {
691 $title = substr($title, 0, 32) . '... ';
694 $description = substr(strip_tags(BBCode::convert($rr['desc'])), 0, 32) . '... ';
696 $description = DI::l10n()->t('[No description]');
699 $strt = DateTimeFormat::convert($rr['start'], $rr['adjust'] ? $a->timezone : 'UTC');
701 if (substr($strt, 0, 10) < DateTimeFormat::timezoneNow($a->timezone, 'Y-m-d')) {
705 $today = ((substr($strt, 0, 10) === DateTimeFormat::timezoneNow($a->timezone, 'Y-m-d')) ? true : false);
707 $rr['title'] = $title;
708 $rr['description'] = $description;
709 $rr['date'] = DI::l10n()->getDay(DateTimeFormat::convert($rr['start'], $rr['adjust'] ? $a->timezone : 'UTC', 'UTC', $bd_format)) . (($today) ? ' ' . DI::l10n()->t('[today]') : '');
710 $rr['startime'] = $strt;
711 $rr['today'] = $today;
716 $classtoday = (($istoday) ? 'event-today' : '');
718 $tpl = Renderer::getMarkupTemplate('events_reminder.tpl');
719 return Renderer::replaceMacros($tpl, [
720 '$classtoday' => $classtoday,
721 '$count' => count($r),
722 '$event_reminders' => DI::l10n()->t('Event Reminders'),
723 '$event_title' => DI::l10n()->t('Upcoming events the next 7 days:'),
729 * Retrieves the my_url session variable
733 public static function getMyURL()
735 return Session::get('my_url');
739 * Process the 'zrl' parameter and initiate the remote authentication.
741 * This method checks if the visitor has a public contact entry and
742 * redirects the visitor to his/her instance to start the magic auth (Authentication)
745 * Ported from Hubzilla: https://framagit.org/hubzilla/core/blob/master/include/channel.php
747 * The implementation for Friendica sadly differs in some points from the one for Hubzilla:
748 * - Hubzilla uses the "zid" parameter, while for Friendica it had been replaced with "zrl"
749 * - There seem to be some reverse authentication (rmagic) that isn't implemented in Friendica at all
751 * It would be favourable to harmonize the two implementations.
753 * @param App $a Application instance.
754 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
755 * @throws \ImagickException
757 public static function zrlInit(App $a)
759 $my_url = self::getMyURL();
760 $my_url = Network::isUrlValid($my_url);
762 if (empty($my_url) || local_user()) {
766 $addr = $_GET['addr'] ?? $my_url;
768 $arr = ['zrl' => $my_url, 'url' => DI::args()->getCommand()];
769 Hook::callAll('zrl_init', $arr);
771 // Try to find the public contact entry of the visitor.
772 $cid = Contact::getIdForURL($my_url);
774 Logger::log('No contact record found for ' . $my_url, Logger::DEBUG);
778 $contact = DBA::selectFirst('contact',['id', 'url'], ['id' => $cid]);
780 if (DBA::isResult($contact) && remote_user() && remote_user() == $contact['id']) {
781 Logger::log('The visitor ' . $my_url . ' is already authenticated', Logger::DEBUG);
785 // Avoid endless loops
786 $cachekey = 'zrlInit:' . $my_url;
787 if (DI::cache()->get($cachekey)) {
788 Logger::log('URL ' . $my_url . ' already tried to authenticate.', Logger::DEBUG);
791 DI::cache()->set($cachekey, true, Duration::MINUTE);
794 Logger::log('Not authenticated. Invoking reverse magic-auth for ' . $my_url, Logger::DEBUG);
796 // Remove the "addr" parameter from the destination. It is later added as separate parameter again.
797 $addr_request = 'addr=' . urlencode($addr);
798 $query = rtrim(str_replace($addr_request, '', DI::args()->getQueryString()), '?&');
800 // The other instance needs to know where to redirect.
801 $dest = urlencode(DI::baseUrl()->get() . '/' . $query);
803 // We need to extract the basebath from the profile url
804 // to redirect the visitors '/magic' module.
805 $basepath = Contact::getBasepath($contact['url']);
807 if ($basepath != DI::baseUrl()->get() && !strstr($dest, '/magic')) {
808 $magic_path = $basepath . '/magic' . '?owa=1&dest=' . $dest . '&' . $addr_request;
810 // We have to check if the remote server does understand /magic without invoking something
811 $serverret = DI::httpRequest()->get($basepath . '/magic');
812 if ($serverret->isSuccess()) {
813 Logger::log('Doing magic auth for visitor ' . $my_url . ' to ' . $magic_path, Logger::DEBUG);
814 System::externalRedirect($magic_path);
820 * Set the visitor cookies (see remote_user()) for the given handle
822 * @param string $handle Visitor handle
823 * @return array Visitor contact array
825 public static function addVisitorCookieForHandle($handle)
829 // Try to find the public contact entry of the visitor.
830 $cid = Contact::getIdForURL($handle);
832 Logger::info('Handle not found', ['handle' => $handle]);
836 $visitor = Contact::getById($cid);
838 // Authenticate the visitor.
839 $_SESSION['authenticated'] = 1;
840 $_SESSION['visitor_id'] = $visitor['id'];
841 $_SESSION['visitor_handle'] = $visitor['addr'];
842 $_SESSION['visitor_home'] = $visitor['url'];
843 $_SESSION['my_url'] = $visitor['url'];
844 $_SESSION['remote_comment'] = $visitor['subscribe'];
846 Session::setVisitorsContacts();
848 $a->contact = $visitor;
850 Logger::info('Authenticated visitor', ['url' => $visitor['url']]);
856 * Set the visitor cookies (see remote_user()) for signed HTTP requests
857 * @return array Visitor contact array
859 public static function addVisitorCookieForHTTPSigner()
861 $requester = HTTPSignature::getSigner('', $_SERVER);
862 if (empty($requester)) {
865 return Profile::addVisitorCookieForHandle($requester);
869 * OpenWebAuth authentication.
871 * Ported from Hubzilla: https://framagit.org/hubzilla/core/blob/master/include/zid.php
873 * @param string $token
874 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
875 * @throws \ImagickException
877 public static function openWebAuthInit($token)
881 // Clean old OpenWebAuthToken entries.
882 OpenWebAuthToken::purge('owt', '3 MINUTE');
884 // Check if the token we got is the same one
885 // we have stored in the database.
886 $visitor_handle = OpenWebAuthToken::getMeta('owt', 0, $token);
888 if ($visitor_handle === false) {
892 $visitor = self::addVisitorCookieForHandle($visitor_handle);
893 if (empty($visitor)) {
898 'visitor' => $visitor,
899 'url' => DI::args()->getQueryString()
902 * @hooks magic_auth_success
903 * Called when a magic-auth was successful.
904 * * \e array \b visitor
907 Hook::callAll('magic_auth_success', $arr);
909 $a->contact = $arr['visitor'];
911 info(DI::l10n()->t('OpenWebAuth: %1$s welcomes %2$s', DI::baseUrl()->getHostname(), $visitor['name']));
913 Logger::log('OpenWebAuth: auth success from ' . $visitor['addr'], Logger::DEBUG);
916 public static function zrl($s, $force = false)
921 if (!strpos($s, '/profile/') && !$force) {
924 if ($force && substr($s, -1, 1) !== '/') {
927 $achar = strpos($s, '?') ? '&' : '?';
928 $mine = self::getMyURL();
929 if ($mine && !Strings::compareLink($mine, $s)) {
930 return $s . $achar . 'zrl=' . urlencode($mine);
936 * Get the user ID of the page owner.
938 * Used from within PCSS themes to set theme parameters. If there's a
939 * profile_uid variable set in App, that is the "page owner" and normally their theme
940 * settings take precedence; unless a local user sets the "always_my_theme"
941 * system pconfig, which means they don't want to see anybody else's theme
942 * settings except their own while on this site.
944 * @return int user ID
946 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
947 * @note Returns local_user instead of user ID if "always_my_theme" is set to true
949 public static function getThemeUid(App $a)
951 $uid = !empty($a->profile_uid) ? intval($a->profile_uid) : 0;
952 if (local_user() && (DI::pConfig()->get(local_user(), 'system', 'always_my_theme') || !$uid)) {
960 * search for Profiles
964 * @param null $search
966 * @return array [ 'total' => 123, 'entries' => [...] ];
970 public static function searchProfiles($start = 0, $count = 100, $search = null)
972 if (!empty($search)) {
973 $publish = (DI::config()->get('system', 'publish_all') ? '' : "AND `publish` ");
974 $searchTerm = '%' . $search . '%';
975 $condition = ["NOT `blocked` AND NOT `account_removed`
977 AND ((`name` LIKE ?) OR
978 (`nickname` LIKE ?) OR
980 (`locality` LIKE ?) OR
982 (`country-name` LIKE ?) OR
983 (`pub_keywords` LIKE ?) OR
984 (`prv_keywords` LIKE ?))",
985 $searchTerm, $searchTerm, $searchTerm, $searchTerm,
986 $searchTerm, $searchTerm, $searchTerm, $searchTerm];
988 $condition = ['blocked' => false, 'account_removed' => false];
989 if (!DI::config()->get('system', 'publish_all')) {
990 $condition['publish'] = true;
994 $total = DBA::count('owner-view', $condition);
996 // If nothing found, don't try to select details
998 $profiles = DBA::selectToArray('owner-view', [], $condition, ['order' => ['name'], 'limit' => [$start, $count]]);
1003 return ['total' => $total, 'entries' => $profiles];