]> git.mxchange.org Git - friendica.git/blobdiff - src/Content/Nav.php
"inform" functionality moved / unified functionality
[friendica.git] / src / Content / Nav.php
index 4f6f4ae0b905adc3832da6e8abf56db386922ff3..213b4599f06beb51bece5efccb4ff2a1db43a03c 100644 (file)
 <?php
 /**
- * @file src/Content/Nav.php
+ * @copyright Copyright (C) 2010-2022, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
  */
+
 namespace Friendica\Content;
 
 use Friendica\App;
-use Friendica\Content\Feature;
-use Friendica\Core\Addon;
-use Friendica\Core\Config;
-use Friendica\Core\L10n;
-use Friendica\Core\System;
+use Friendica\Core\Hook;
+use Friendica\Core\Renderer;
+use Friendica\Core\Session;
 use Friendica\Database\DBA;
+use Friendica\DI;
 use Friendica\Model\Contact;
 use Friendica\Model\Profile;
-
-require_once 'boot.php';
-require_once 'dba.php';
-require_once 'include/text.php';
+use Friendica\Model\User;
 
 class Nav
 {
+       private static $selected = [
+               'global'    => null,
+               'community' => null,
+               'network'   => null,
+               'home'      => null,
+               'profiles'  => null,
+               'introductions' => null,
+               'notifications' => null,
+               'messages'  => null,
+               'directory' => null,
+               'settings'  => null,
+               'contacts'  => null,
+               'delegation'=> null,
+               'events'    => null,
+               'register'  => null
+       ];
+
+       /**
+        * An array of HTML links provided by addons providing a module via the app_menu hook
+        *
+        * @var array
+        */
+       private static $app_menu = null;
+
+       /**
+        * Set a menu item in navbar as selected
+        *
+        * @param string $item
+        */
+       public static function setSelected($item)
+       {
+               self::$selected[$item] = 'selected';
+       }
+
        /**
         * Build page header and site navigation bars
+        *
+        * @param  App    $a
+        * @return string
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        public static function build(App $a)
        {
-               if (!(x($a->page, 'nav'))) {
-                       $a->page['nav'] = '';
-               }
+               // Placeholder div for popup panel
+               $nav = '<div id="panel" style="display: none;"></div>';
 
-               $a->page['htmlhead'] .= replace_macros(get_markup_template('nav_head.tpl'), []);
+               $nav_info = self::getInfo($a);
 
-               /*
-                * Placeholder div for popup panel
-                */
+               $tpl = Renderer::getMarkupTemplate('nav.tpl');
 
-               $a->page['nav'] .= '<div id="panel" style="display: none;"></div>' ;
+               $nav .= Renderer::replaceMacros($tpl, [
+                       '$sitelocation' => $nav_info['sitelocation'],
+                       '$nav'          => $nav_info['nav'],
+                       '$banner'       => $nav_info['banner'],
+                       '$emptynotifications' => DI::l10n()->t('Nothing new here'),
+                       '$userinfo'     => $nav_info['userinfo'],
+                       '$sel'          => self::$selected,
+                       '$apps'         => self::getAppMenu(),
+                       '$home'         => DI::l10n()->t('Go back'),
+                       '$clear_notifs' => DI::l10n()->t('Clear notifications'),
+                       '$search_hint'  => DI::l10n()->t('@name, !forum, #tags, content')
+               ]);
 
-               $nav_info = self::getInfo($a);
+               Hook::callAll('page_header', $nav);
 
-               /*
-                * Build the page
-                */
+               return $nav;
+       }
 
-               $tpl = get_markup_template('nav.tpl');
+       /**
+        * Returns the addon app menu
+        *
+        * @return array
+        */
+       public static function getAppMenu()
+       {
+               if (is_null(self::$app_menu)) {
+                       self::populateAppMenu();
+               }
 
-               $a->page['nav'] .= replace_macros($tpl, [
-                       '$baseurl' => System::baseUrl(),
-                       '$sitelocation' => $nav_info['sitelocation'],
-                       '$nav' => $nav_info['nav'],
-                       '$banner' => $nav_info['banner'],
-                       '$emptynotifications' => L10n::t('Nothing new here'),
-                       '$userinfo' => $nav_info['userinfo'],
-                       '$sel' =>  $a->nav_sel,
-                       '$apps' => $a->apps,
-                       '$clear_notifs' => L10n::t('Clear notifications'),
-                       '$search_hint' => L10n::t('@name, !forum, #tags, content')
-               ]);
+               return self::$app_menu;
+       }
+
+       /**
+        * Fills the apps static variable with apps that require a menu
+        */
+       private static function populateAppMenu()
+       {
+               self::$app_menu = [];
+
+               //Don't populate apps_menu if apps are private
+               $privateapps = DI::config()->get('config', 'private_addons', false);
+               if (local_user() || !$privateapps) {
+                       $arr = ['app_menu' => self::$app_menu];
+
+                       Hook::callAll('app_menu', $arr);
 
-               Addon::callHooks('page_header', $a->page['nav']);
+                       self::$app_menu = $arr['app_menu'];
+               }
        }
 
        /**
         * Prepares a list of navigation links
         *
-        * @brief Prepares a list of navigation links
-        * @param App $a
+        * @param  App   $a
         * @return array Navigation links
-        *      string 'sitelocation' => The webbie (username@site.com)
-        *      array 'nav' => Array of links used in the nav menu
-        *      string 'banner' => Formatted html link with banner image
-        *      array 'userinfo' => Array of user information (name, icon)
+        *    string 'sitelocation' => The webbie (username@site.com)
+        *    array 'nav' => Array of links used in the nav menu
+        *    string 'banner' => Formatted html link with banner image
+        *    array 'userinfo' => Array of user information (name, icon)
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
-       private static function getInfo(App $a)
+       private static function getInfo(App $a): array
        {
-               $ssl_state = ((local_user()) ? true : false);
+               $ssl_state = (bool) local_user();
 
                /*
                 * Our network is distributed, and as you visit friends some of the
@@ -82,182 +154,168 @@ class Nav
                 * Display the current site location as a navigation aid.
                 */
 
-               $myident = ((is_array($a->user) && isset($a->user['nickname'])) ? $a->user['nickname'] . '@' : '');
-
-               $sitelocation = $myident . substr(System::baseUrl($ssl_state), strpos(System::baseUrl($ssl_state), '//') + 2);
-
-               // nav links: array of array('href', 'text', 'extra css classes', 'title')
-               $nav = [];
+               $myident = !empty($a->getLoggedInUserNickname()) ? $a->getLoggedInUserNickname() . '@' : '';
+
+               $sitelocation = $myident . substr(DI::baseUrl()->get($ssl_state), strpos(DI::baseUrl()->get($ssl_state), '//') + 2);
+
+               $nav = [
+                       'admin'         => null,
+                       'apps'          => null,
+                       'community'     => null,
+                       'home'          => null,
+                       'events'        => null,
+                       'login'         => null,
+                       'logout'        => null,
+                       'langselector'  => null,
+                       'messages'      => null,
+                       'network'       => null,
+                       'notifications' => null,
+                       'remote'        => null,
+                       'search'        => null,
+                       'usermenu'      => [],
+               ];
 
                // Display login or logout
-               $nav['usermenu'] = [];
                $userinfo = null;
 
-               if (local_user()) {
-                       $nav['logout'] = ['logout', L10n::t('Logout'), '', L10n::t('End this session')];
+               // nav links: array of array('href', 'text', 'extra css classes', 'title')
+               if (Session::isAuthenticated()) {
+                       $nav['logout'] = ['logout', DI::l10n()->t('Logout'), '', DI::l10n()->t('End this session')];
+               } else {
+                       $nav['login'] = ['login', DI::l10n()->t('Login'), (DI::args()->getModuleName() == 'login' ? 'selected' : ''), DI::l10n()->t('Sign in')];
+               }
 
+               if ($a->isLoggedIn()) {
                        // user menu
-                       $nav['usermenu'][] = ['profile/' . $a->user['nickname'], L10n::t('Status'), '', L10n::t('Your posts and conversations')];
-                       $nav['usermenu'][] = ['profile/' . $a->user['nickname'] . '?tab=profile', L10n::t('Profile'), '', L10n::t('Your profile page')];
-                       $nav['usermenu'][] = ['photos/' . $a->user['nickname'], L10n::t('Photos'), '', L10n::t('Your photos')];
-                       $nav['usermenu'][] = ['videos/' . $a->user['nickname'], L10n::t('Videos'), '', L10n::t('Your videos')];
-                       $nav['usermenu'][] = ['events/', L10n::t('Events'), '', L10n::t('Your events')];
-                       $nav['usermenu'][] = ['notes/', L10n::t('Personal notes'), '', L10n::t('Your personal notes')];
+                       $nav['usermenu'][] = ['profile/' . $a->getLoggedInUserNickname(), DI::l10n()->t('Status'), '', DI::l10n()->t('Your posts and conversations')];
+                       $nav['usermenu'][] = ['profile/' . $a->getLoggedInUserNickname() . '/profile', DI::l10n()->t('Profile'), '', DI::l10n()->t('Your profile page')];
+                       $nav['usermenu'][] = ['photos/' . $a->getLoggedInUserNickname(), DI::l10n()->t('Photos'), '', DI::l10n()->t('Your photos')];
+                       $nav['usermenu'][] = ['profile/' . $a->getLoggedInUserNickname() . '/media', DI::l10n()->t('Media'), '', DI::l10n()->t('Your postings with media')];
+                       $nav['usermenu'][] = ['events/', DI::l10n()->t('Events'), '', DI::l10n()->t('Your events')];
+                       $nav['usermenu'][] = ['notes/', DI::l10n()->t('Personal notes'), '', DI::l10n()->t('Your personal notes')];
 
                        // user info
-                       $contact = DBA::selectFirst('contact', ['micro'], ['uid' => $a->user['uid'], 'self' => true]);
+                       $contact = DBA::selectFirst('contact', ['id', 'url', 'avatar', 'micro', 'name', 'nick', 'baseurl', 'updated'], ['uid' => $a->getLoggedInUserId(), 'self' => true]);
                        $userinfo = [
-                               'icon' => (DBA::isResult($contact) ? $a->removeBaseURL($contact['micro']) : 'images/person-48.jpg'),
-                               'name' => $a->user['username'],
+                               'icon' => Contact::getMicro($contact),
+                               'name' => $contact['name'],
                        ];
-               } else {
-                       $nav['login'] = ['login', L10n::t('Login'), ($a->module == 'login' ? 'selected' : ''), L10n::t('Sign in')];
                }
 
                // "Home" should also take you home from an authenticated remote profile connection
                $homelink = Profile::getMyURL();
                if (! $homelink) {
-                       $homelink = ((x($_SESSION, 'visitor_home')) ? $_SESSION['visitor_home'] : '');
+                       $homelink = Session::get('visitor_home', '');
                }
 
-               if (($a->module != 'home') && (! (local_user()))) {
-                       $nav['home'] = [$homelink, L10n::t('Home'), '', L10n::t('Home Page')];
+               if ((DI::args()->getModuleName() != 'home') && (! (local_user()))) {
+                       $nav['home'] = [$homelink, DI::l10n()->t('Home'), '', DI::l10n()->t('Home Page')];
                }
 
-               if (intval(Config::get('config', 'register_policy')) === REGISTER_OPEN && !local_user() && !remote_user()) {
-                       $nav['register'] = ['register', L10n::t('Register'), '', L10n::t('Create an account')];
+               if (intval(DI::config()->get('config', 'register_policy')) === \Friendica\Module\Register::OPEN && !Session::isAuthenticated()) {
+                       $nav['register'] = ['register', DI::l10n()->t('Register'), '', DI::l10n()->t('Create an account')];
                }
 
                $help_url = 'help';
 
-               if (!Config::get('system', 'hide_help')) {
-                       $nav['help'] = [$help_url, L10n::t('Help'), '', L10n::t('Help and documentation')];
+               if (!DI::config()->get('system', 'hide_help')) {
+                       $nav['help'] = [$help_url, DI::l10n()->t('Help'), '', DI::l10n()->t('Help and documentation')];
                }
 
-               if (count($a->apps) > 0) {
-                       $nav['apps'] = ['apps', L10n::t('Apps'), '', L10n::t('Addon applications, utilities, games')];
+               if (count(self::getAppMenu()) > 0) {
+                       $nav['apps'] = ['apps', DI::l10n()->t('Apps'), '', DI::l10n()->t('Addon applications, utilities, games')];
                }
 
-               if (local_user() || !Config::get('system', 'local_search')) {
-                       $nav['search'] = ['search', L10n::t('Search'), '', L10n::t('Search site content')];
+               if (local_user() || !DI::config()->get('system', 'local_search')) {
+                       $nav['search'] = ['search', DI::l10n()->t('Search'), '', DI::l10n()->t('Search site content')];
 
                        $nav['searchoption'] = [
-                               L10n::t('Full Text'),
-                               L10n::t('Tags'),
-                               L10n::t('Contacts')
+                               DI::l10n()->t('Full Text'),
+                               DI::l10n()->t('Tags'),
+                               DI::l10n()->t('Contacts')
                        ];
 
-                       if (Config::get('system', 'poco_local_search')) {
-                               $nav['searchoption'][] = L10n::t('Forums');
+                       if (DI::config()->get('system', 'poco_local_search')) {
+                               $nav['searchoption'][] = DI::l10n()->t('Forums');
                        }
                }
 
                $gdirpath = 'directory';
 
-               if (strlen(Config::get('system', 'singleuser'))) {
-                       $gdir = Config::get('system', 'directory');
+               if (strlen(DI::config()->get('system', 'singleuser'))) {
+                       $gdir = DI::config()->get('system', 'directory');
                        if (strlen($gdir)) {
                                $gdirpath = Profile::zrl($gdir, true);
                        }
                }
 
-               if ((local_user() || Config::get('system', 'community_page_style') != CP_NO_COMMUNITY_PAGE) &&
-                       !(Config::get('system', 'community_page_style') == CP_NO_INTERNAL_COMMUNITY)) {
-                       $nav['community'] = ['community', L10n::t('Community'), '', L10n::t('Conversations on this and other servers')];
+               if ((local_user() || DI::config()->get('system', 'community_page_style') != CP_NO_COMMUNITY_PAGE) &&
+                       !(DI::config()->get('system', 'community_page_style') == CP_NO_INTERNAL_COMMUNITY)) {
+                       $nav['community'] = ['community', DI::l10n()->t('Community'), '', DI::l10n()->t('Conversations on this and other servers')];
                }
 
                if (local_user()) {
-                       $nav['events'] = ['events', L10n::t('Events'), '', L10n::t('Events and Calendar')];
+                       $nav['events'] = ['events', DI::l10n()->t('Events'), '', DI::l10n()->t('Events and Calendar')];
                }
 
-               $nav['directory'] = [$gdirpath, L10n::t('Directory'), '', L10n::t('People directory')];
+               $nav['directory'] = [$gdirpath, DI::l10n()->t('Directory'), '', DI::l10n()->t('People directory')];
 
-               $nav['about'] = ['friendica', L10n::t('Information'), '', L10n::t('Information about this friendica instance')];
+               $nav['about'] = ['friendica', DI::l10n()->t('Information'), '', DI::l10n()->t('Information about this friendica instance')];
 
-               if (Config::get('system', 'tosdisplay')) {
-                       $nav['tos'] = ['tos', L10n::t('Terms of Service'), '', L10n::t('Terms of Service of this Friendica instance')];
+               if (DI::config()->get('system', 'tosdisplay')) {
+                       $nav['tos'] = ['tos', DI::l10n()->t('Terms of Service'), '', DI::l10n()->t('Terms of Service of this Friendica instance')];
                }
 
                // The following nav links are only show to logged in users
-               if (local_user()) {
-                       $nav['network'] = ['network', L10n::t('Network'), '', L10n::t('Conversations from your friends')];
-                       $nav['net_reset'] = ['network/0?f=&order=comment&nets=all', L10n::t('Network Reset'), '', L10n::t('Load Network page with no filters')];
+               if (local_user() && !empty($a->getLoggedInUserNickname())) {
+                       $nav['network'] = ['network', DI::l10n()->t('Network'), '', DI::l10n()->t('Conversations from your friends')];
 
-                       $nav['home'] = ['profile/' . $a->user['nickname'], L10n::t('Home'), '', L10n::t('Your posts and conversations')];
+                       $nav['home'] = ['profile/' . $a->getLoggedInUserNickname(), DI::l10n()->t('Home'), '', DI::l10n()->t('Your posts and conversations')];
 
                        // Don't show notifications for public communities
-                       if (defaults($_SESSION, 'page_flags', '') != Contact::PAGE_COMMUNITY) {
-                               $nav['introductions'] = ['notifications/intros', L10n::t('Introductions'), '', L10n::t('Friend Requests')];
-                               $nav['notifications'] = ['notifications',       L10n::t('Notifications'), '', L10n::t('Notifications')];
-                               $nav['notifications']['all'] = ['notifications/system', L10n::t('See all notifications'), '', ''];
-                               $nav['notifications']['mark'] = ['', L10n::t('Mark as seen'), '', L10n::t('Mark all system notifications seen')];
+                       if (Session::get('page_flags', '') != User::PAGE_FLAGS_COMMUNITY) {
+                               $nav['introductions'] = ['notifications/intros', DI::l10n()->t('Introductions'), '', DI::l10n()->t('Friend Requests')];
+                               $nav['notifications'] = ['notifications',       DI::l10n()->t('Notifications'), '', DI::l10n()->t('Notifications')];
+                               $nav['notifications']['all'] = ['notifications/system', DI::l10n()->t('See all notifications'), '', ''];
+                               $nav['notifications']['mark'] = ['', DI::l10n()->t('Mark as seen'), '', DI::l10n()->t('Mark all system notifications as seen')];
                        }
 
-                       $nav['messages'] = ['message', L10n::t('Messages'), '', L10n::t('Private mail')];
-                       $nav['messages']['inbox'] = ['message', L10n::t('Inbox'), '', L10n::t('Inbox')];
-                       $nav['messages']['outbox'] = ['message/sent', L10n::t('Outbox'), '', L10n::t('Outbox')];
-                       $nav['messages']['new'] = ['message/new', L10n::t('New Message'), '', L10n::t('New Message')];
+                       $nav['messages'] = ['message', DI::l10n()->t('Messages'), '', DI::l10n()->t('Private mail')];
+                       $nav['messages']['inbox'] = ['message', DI::l10n()->t('Inbox'), '', DI::l10n()->t('Inbox')];
+                       $nav['messages']['outbox'] = ['message/sent', DI::l10n()->t('Outbox'), '', DI::l10n()->t('Outbox')];
+                       $nav['messages']['new'] = ['message/new', DI::l10n()->t('New Message'), '', DI::l10n()->t('New Message')];
 
-                       if (is_array($a->identities) && count($a->identities) > 1) {
-                               $nav['manage'] = ['manage', L10n::t('Manage'), '', L10n::t('Manage other pages')];
+                       if (User::hasIdentities(DI::session()->get('submanage') ?: local_user())) {
+                               $nav['delegation'] = ['delegation', DI::l10n()->t('Accounts'), '', DI::l10n()->t('Manage other pages')];
                        }
 
-                       $nav['delegations'] = ['delegate', L10n::t('Delegations'), '', L10n::t('Delegate Page Management')];
-
-                       $nav['settings'] = ['settings', L10n::t('Settings'), '', L10n::t('Account settings')];
+                       $nav['settings'] = ['settings', DI::l10n()->t('Settings'), '', DI::l10n()->t('Account settings')];
 
-                       if (Feature::isEnabled(local_user(), 'multi_profiles')) {
-                               $nav['profiles'] = ['profiles', L10n::t('Profiles'), '', L10n::t('Manage/Edit Profiles')];
-                       }
-
-                       $nav['contacts'] = ['contact', L10n::t('Contacts'), '', L10n::t('Manage/edit friends and contacts')];
+                       $nav['contacts'] = ['contact', DI::l10n()->t('Contacts'), '', DI::l10n()->t('Manage/edit friends and contacts')];
                }
 
                // Show the link to the admin configuration page if user is admin
-               if (is_site_admin()) {
-                       $nav['admin'] = ['admin/', L10n::t('Admin'), '', L10n::t('Site setup and configuration')];
+               if ($a->isSiteAdmin()) {
+                       $nav['admin'] = ['admin/', DI::l10n()->t('Admin'), '', DI::l10n()->t('Site setup and configuration')];
                }
 
-               $nav['navigation'] = ['navigation/', L10n::t('Navigation'), '', L10n::t('Site map')];
+               $nav['navigation'] = ['navigation/', DI::l10n()->t('Navigation'), '', DI::l10n()->t('Site map')];
 
                // Provide a banner/logo/whatever
-               $banner = Config::get('system', 'banner');
+               $banner = DI::config()->get('system', 'banner');
                if (is_null($banner)) {
                        $banner = '<a href="https://friendi.ca"><img id="logo-img" src="images/friendica-32.png" alt="logo" /></a><span id="logo-text"><a href="https://friendi.ca">Friendica</a></span>';
                }
 
-               Addon::callHooks('nav_info', $nav);
-
-               return [
+               $nav_info = [
+                       'banner'       => $banner,
+                       'nav'          => $nav,
                        'sitelocation' => $sitelocation,
-                       'nav' => $nav,
-                       'banner' => $banner,
-                       'userinfo' => $userinfo,
+                       'userinfo'     => $userinfo,
                ];
-       }
 
-       /**
-        * Set a menu item in navbar as selected
-        */
-       public static function setSelected($item)
-       {
-               $a = get_app();
-               $a->nav_sel = [
-                       'global'        => null,
-                       'community'     => null,
-                       'network'       => null,
-                       'home'          => null,
-                       'profiles'      => null,
-                       'introductions' => null,
-                       'notifications' => null,
-                       'messages'      => null,
-                       'directory'     => null,
-                       'settings'      => null,
-                       'contacts'      => null,
-                       'manage'        => null,
-                       'events'        => null,
-                       'register'      => null
-               ];
-               $a->nav_sel[$item] = 'selected';
+               Hook::callAll('nav_info', $nav_info);
+
+               return $nav_info;
        }
 }