]> git.mxchange.org Git - friendica.git/blobdiff - src/Content/Nav.php
Merge pull request #12946 from friendica/api-permission
[friendica.git] / src / Content / Nav.php
index a63244e856a7ffd0d2b0843750f72552ae7a682a..470882b0757db3a83dce55f9f90bc46075b6ccbc 100644 (file)
@@ -1,18 +1,41 @@
 <?php
 /**
- * @file src/Content/Nav.php
+ * @copyright Copyright (C) 2010-2023, 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\Core\Config;
+use Friendica\App\BaseURL;
+use Friendica\App\Router;
+use Friendica\Core\Config\Capability\IManageConfigValues;
 use Friendica\Core\Hook;
 use Friendica\Core\L10n;
 use Friendica\Core\Renderer;
-use Friendica\Core\System;
-use Friendica\Database\DBA;
+use Friendica\Core\Session\Capability\IHandleUserSessions;
+use Friendica\Database\Database;
+use Friendica\Model\Contact;
 use Friendica\Model\Profile;
 use Friendica\Model\User;
+use Friendica\Module\Conversation\Community;
+use Friendica\Module\Home;
+use Friendica\Module\Security\Login;
+use Friendica\Network\HTTPException;
 
 class Nav
 {
@@ -28,24 +51,47 @@ class Nav
                'directory' => null,
                'settings'  => null,
                'contacts'  => null,
-               'manage'    => null,
-               'events'    => null,
+               'delegation'=> null,
+               'calendar'  => null,
                'register'  => null
        ];
 
        /**
         * An array of HTML links provided by addons providing a module via the app_menu hook
         *
-        * @var array
+        * @var array|null
         */
-       private static $app_menu = null;
+       private $appMenu = null;
+
+       /** @var BaseURL */
+       private $baseUrl;
+       /** @var L10n */
+       private $l10n;
+       /** @var IHandleUserSessions */
+       private $session;
+       /** @var Database */
+       private $database;
+       /** @var IManageConfigValues */
+       private $config;
+       /** @var Router */
+       private $router;
+
+       public function __construct(BaseURL $baseUrl, L10n $l10n, IHandleUserSessions $session, Database $database, IManageConfigValues $config, Router $router)
+       {
+               $this->baseUrl  = $baseUrl;
+               $this->l10n     = $l10n;
+               $this->session  = $session;
+               $this->database = $database;
+               $this->config   = $config;
+               $this->router   = $router;
+       }
 
        /**
         * Set a menu item in navbar as selected
         *
         * @param string $item
         */
-       public static function setSelected($item)
+       public static function setSelected(string $item)
        {
                self::$selected[$item] = 'selected';
        }
@@ -53,16 +99,17 @@ class Nav
        /**
         * Build page header and site navigation bars
         *
-        * @param  App    $a
         * @return string
-        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        * @throws HTTPException\InternalServerErrorException
+        * @throws HTTPException\MethodNotAllowedException
+        * @throws HTTPException\ServiceUnavailableException
         */
-       public static function build(App $a)
+       public function getHtml(): string
        {
                // Placeholder div for popup panel
                $nav = '<div id="panel" style="display: none;"></div>';
 
-               $nav_info = self::getInfo($a);
+               $nav_info = $this->getInfo();
 
                $tpl = Renderer::getMarkupTemplate('nav.tpl');
 
@@ -70,12 +117,13 @@ class Nav
                        '$sitelocation' => $nav_info['sitelocation'],
                        '$nav'          => $nav_info['nav'],
                        '$banner'       => $nav_info['banner'],
-                       '$emptynotifications' => L10n::t('Nothing new here'),
+                       '$emptynotifications' => $this->l10n->t('Nothing new here'),
                        '$userinfo'     => $nav_info['userinfo'],
                        '$sel'          => self::$selected,
-                       '$apps'         => self::getAppMenu(),
-                       '$clear_notifs' => L10n::t('Clear notifications'),
-                       '$search_hint'  => L10n::t('@name, !forum, #tags, content')
+                       '$apps'         => $this->getAppMenu(),
+                       '$home'         => $this->l10n->t('Go back'),
+                       '$clear_notifs' => $this->l10n->t('Clear notifications'),
+                       '$search_hint'  => $this->l10n->t('@name, !forum, #tags, content')
                ]);
 
                Hook::callAll('page_header', $nav);
@@ -87,207 +135,221 @@ class Nav
         * Returns the addon app menu
         *
         * @return array
+        * @throws HTTPException\InternalServerErrorException
         */
-       public static function getAppMenu()
+       public function getAppMenu(): array
        {
-               if (is_null(self::$app_menu)) {
-                       self::populateAppMenu();
+               if (is_null($this->appMenu)) {
+                       $this->appMenu = $this->populateAppMenu();
                }
 
-               return self::$app_menu;
+               return $this->appMenu;
        }
 
        /**
-        * Fills the apps static variable with apps that require a menu
+        * Returns menus for apps that require one
+        *
+        * @return array
+        * @throws HTTPException\InternalServerErrorException
         */
-       private static function populateAppMenu()
+       private function populateAppMenu(): array
        {
-               self::$app_menu = [];
+               $appMenu = [];
 
                //Don't populate apps_menu if apps are private
-               $privateapps = Config::get('config', 'private_addons', false);
-               if (local_user() || !$privateapps) {
-                       $arr = ['app_menu' => self::$app_menu];
+               if (
+                       $this->session->getLocalUserId()
+                       || !$this->config->get('config', 'private_addons', false)
+               ) {
+                       $arr = ['app_menu' => $appMenu];
 
                        Hook::callAll('app_menu', $arr);
 
-                       self::$app_menu = $arr['app_menu'];
+                       $appMenu = $arr['app_menu'];
                }
+
+               return $appMenu;
        }
 
        /**
         * Prepares a list of navigation links
         *
-        * @brief Prepares a list of navigation links
-        * @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)
-        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        * @throws HTTPException\InternalServerErrorException
+        * @throws HTTPException\MethodNotAllowedException
         */
-       private static function getInfo(App $a)
+       private function getInfo(): array
        {
-               $ssl_state = ((local_user()) ? true : false);
-
                /*
-                * Our network is distributed, and as you visit friends some of the
+                * Our network is distributed, and as you visit friends some
                 * sites look exactly the same - it isn't always easy to know where you are.
                 * 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($this->session->getLocalUserNickname()) ? $this->session->getLocalUserNickname() . '@' : '';
+
+               $sitelocation = $myident . substr($this->baseUrl, strpos($this->baseUrl, '//') + 2);
+
+               $nav = [
+                       'admin'         => null,
+                       'moderation'    => null,
+                       'apps'          => null,
+                       'community'     => null,
+                       'home'          => null,
+                       'calendar'      => 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 ($this->session->isAuthenticated()) {
+                       $nav['logout'] = ['logout', $this->l10n->t('Logout'), '', $this->l10n->t('End this session')];
+               } else {
+                       $nav['login'] = ['login', $this->l10n->t('Login'), ($this->router->getModuleClass() == Login::class ? 'selected' : ''), $this->l10n->t('Sign in')];
+               }
 
+               if ($this->session->isAuthenticated()) {
                        // 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/' . $this->session->getLocalUserNickname(), $this->l10n->t('Conversations'), '', $this->l10n->t('Conversations you started')];
+                       $nav['usermenu'][] = ['profile/' . $this->session->getLocalUserNickname() . '/profile', $this->l10n->t('Profile'), '', $this->l10n->t('Your profile page')];
+                       $nav['usermenu'][] = ['profile/' . $this->session->getLocalUserNickname() . '/photos', $this->l10n->t('Photos'), '', $this->l10n->t('Your photos')];
+                       $nav['usermenu'][] = ['profile/' . $this->session->getLocalUserNickname() . '/media', $this->l10n->t('Media'), '', $this->l10n->t('Your postings with media')];
+                       $nav['usermenu'][] = ['calendar/', $this->l10n->t('Calendar'), '', $this->l10n->t('Your calendar')];
+                       $nav['usermenu'][] = ['notes/', $this->l10n->t('Personal notes'), '', $this->l10n->t('Your personal notes')];
 
                        // user info
-                       $contact = DBA::selectFirst('contact', ['micro'], ['uid' => $a->user['uid'], 'self' => true]);
+                       $contact = $this->database->selectFirst('contact', ['id', 'url', 'avatar', 'micro', 'name', 'nick', 'baseurl', 'updated'], ['uid' => $this->session->getLocalUserId(), '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 = defaults($_SESSION, 'visitor_home', '');
+               $homelink = $this->session->getMyUrl();
+               if (!$homelink) {
+                       $homelink = $this->session->get('visitor_home', '');
                }
 
-               if (($a->module != 'home') && (! (local_user()))) {
-                       $nav['home'] = [$homelink, L10n::t('Home'), '', L10n::t('Home Page')];
+               if ($this->router->getModuleClass() != Home::class && !$this->session->getLocalUserId()) {
+                       $nav['home'] = [$homelink, $this->l10n->t('Home'), '', $this->l10n->t('Home Page')];
                }
 
-               if (intval(Config::get('config', 'register_policy')) === \Friendica\Module\Register::OPEN && !local_user() && !remote_user()) {
-                       $nav['register'] = ['register', L10n::t('Register'), '', L10n::t('Create an account')];
+               if (intval($this->config->get('config', 'register_policy')) === \Friendica\Module\Register::OPEN && !$this->session->isAuthenticated()) {
+                       $nav['register'] = ['register', $this->l10n->t('Register'), '', $this->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 (!$this->config->get('system', 'hide_help')) {
+                       $nav['help'] = [$help_url, $this->l10n->t('Help'), '', $this->l10n->t('Help and documentation')];
                }
 
-               if (count(self::getAppMenu()) > 0) {
-                       $nav['apps'] = ['apps', L10n::t('Apps'), '', L10n::t('Addon applications, utilities, games')];
+               if (count($this->getAppMenu()) > 0) {
+                       $nav['apps'] = ['apps', $this->l10n->t('Apps'), '', $this->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 ($this->session->getLocalUserId() || !$this->config->get('system', 'local_search')) {
+                       $nav['search'] = ['search', $this->l10n->t('Search'), '', $this->l10n->t('Search site content')];
 
                        $nav['searchoption'] = [
-                               L10n::t('Full Text'),
-                               L10n::t('Tags'),
-                               L10n::t('Contacts')
+                               $this->l10n->t('Full Text'),
+                               $this->l10n->t('Tags'),
+                               $this->l10n->t('Contacts')
                        ];
 
-                       if (Config::get('system', 'poco_local_search')) {
-                               $nav['searchoption'][] = L10n::t('Forums');
+                       if ($this->config->get('system', 'poco_local_search')) {
+                               $nav['searchoption'][] = $this->l10n->t('Forums');
                        }
                }
 
                $gdirpath = 'directory';
-
-               if (strlen(Config::get('system', 'singleuser'))) {
-                       $gdir = Config::get('system', 'directory');
-                       if (strlen($gdir)) {
-                               $gdirpath = Profile::zrl($gdir, true);
-                       }
+               if ($this->config->get('system', 'singleuser') && $this->config->get('system', 'directory')) {
+                       $gdirpath = Profile::zrl($this->config->get('system', 'directory'), 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 (($this->session->getLocalUserId() || $this->config->get('system', 'community_page_style') != Community::DISABLED_VISITOR) &&
+                       !($this->config->get('system', 'community_page_style') == Community::DISABLED)) {
+                       $nav['community'] = ['community', $this->l10n->t('Community'), '', $this->l10n->t('Conversations on this and other servers')];
                }
 
-               if (local_user()) {
-                       $nav['events'] = ['events', L10n::t('Events'), '', L10n::t('Events and Calendar')];
+               if ($this->session->getLocalUserId()) {
+                       $nav['calendar'] = ['calendar', $this->l10n->t('Calendar'), '', $this->l10n->t('Calendar')];
                }
 
-               $nav['directory'] = [$gdirpath, L10n::t('Directory'), '', L10n::t('People directory')];
+               $nav['directory'] = [$gdirpath, $this->l10n->t('Directory'), '', $this->l10n->t('People directory')];
 
-               $nav['about'] = ['friendica', L10n::t('Information'), '', L10n::t('Information about this friendica instance')];
+               $nav['about'] = ['friendica', $this->l10n->t('Information'), '', $this->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 ($this->config->get('system', 'tosdisplay')) {
+                       $nav['tos'] = ['tos', $this->l10n->t('Terms of Service'), '', $this->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/?f=', L10n::t('Network Reset'), '', L10n::t('Load Network page with no filters')];
+               // The following nav links are only show to logged-in users
+               if ($this->session->getLocalUserNickname()) {
+                       $nav['network'] = ['network', $this->l10n->t('Network'), '', $this->l10n->t('Conversations from your friends')];
 
-                       $nav['home'] = ['profile/' . $a->user['nickname'], L10n::t('Home'), '', L10n::t('Your posts and conversations')];
+                       $nav['home'] = ['profile/' . $this->session->getLocalUserNickname(), $this->l10n->t('Home'), '', $this->l10n->t('Your posts and conversations')];
 
                        // Don't show notifications for public communities
-                       if (defaults($_SESSION, 'page_flags', '') != User::PAGE_FLAGS_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 ($this->session->get('page_flags', '') != User::PAGE_FLAGS_COMMUNITY) {
+                               $nav['introductions'] = ['notifications/intros', $this->l10n->t('Introductions'), '', $this->l10n->t('Friend Requests')];
+                               $nav['notifications'] = ['notifications',       $this->l10n->t('Notifications'), '', $this->l10n->t('Notifications')];
+                               $nav['notifications']['all'] = ['notifications/system', $this->l10n->t('See all notifications'), '', ''];
+                               $nav['notifications']['mark'] = ['', $this->l10n->t('Mark as seen'), '', $this->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', $this->l10n->t('Messages'), '', $this->l10n->t('Private mail')];
+                       $nav['messages']['inbox'] = ['message', $this->l10n->t('Inbox'), '', $this->l10n->t('Inbox')];
+                       $nav['messages']['outbox'] = ['message/sent', $this->l10n->t('Outbox'), '', $this->l10n->t('Outbox')];
+                       $nav['messages']['new'] = ['message/new', $this->l10n->t('New Message'), '', $this->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($this->session->getSubManagedUserId() ?: $this->session->getLocalUserId())) {
+                               $nav['delegation'] = ['delegation', $this->l10n->t('Accounts'), '', $this->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', $this->l10n->t('Settings'), '', $this->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', $this->l10n->t('Contacts'), '', $this->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 ($this->session->isSiteAdmin()) {
+                       $nav['admin']      = ['admin/', $this->l10n->t('Admin'), '', $this->l10n->t('Site setup and configuration')];
+                       $nav['moderation'] = ['moderation/', $this->l10n->t('Moderation'), '', $this->l10n->t('Content and user moderation')];
                }
 
-               $nav['navigation'] = ['navigation/', L10n::t('Navigation'), '', L10n::t('Site map')];
+               $nav['navigation'] = ['navigation/', $this->l10n->t('Navigation'), '', $this->l10n->t('Site map')];
 
                // Provide a banner/logo/whatever
-               $banner = Config::get('system', 'banner');
+               $banner = $this->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>';
+                       $banner = '<a href="https://friendi.ca"><img id="logo-img" width="32" height="32" src="images/friendica.svg" alt="logo" /></a><span id="logo-text"><a href="https://friendi.ca">Friendica</a></span>';
                }
 
-               Hook::callAll('nav_info', $nav);
-
-               return [
+               $nav_info = [
+                       'banner'       => $banner,
+                       'nav'          => $nav,
                        'sitelocation' => $sitelocation,
-                       'nav' => $nav,
-                       'banner' => $banner,
-                       'userinfo' => $userinfo,
+                       'userinfo'     => $userinfo,
                ];
+
+               Hook::callAll('nav_info', $nav_info);
+
+               return $nav_info;
        }
 }