src/Content/Nav.php

   1 <?php
   2 /**
   3  * @file src/Content/Nav.php
   4  */
   5 namespace Friendica\Content;
   6
   7 use Friendica\App;
   8 use Friendica\Core\Config;
   9 use Friendica\Core\Hook;
  10 use Friendica\Core\L10n;
  11 use Friendica\Core\Renderer;
  12 use Friendica\Core\System;
  13 use Friendica\Database\DBA;
  14 use Friendica\Model\Profile;
  15 use Friendica\Model\User;
  16
  17 class Nav
  18 {
  19         private static $selected = [
  20                 'global'    => null,
  21                 'community' => null,
  22                 'network'   => null,
  23                 'home'      => null,
  24                 'profiles'  => null,
  25                 'introductions' => null,
  26                 'notifications' => null,
  27                 'messages'  => null,
  28                 'directory' => null,
  29                 'settings'  => null,
  30                 'contacts'  => null,
  31                 'manage'    => null,
  32                 'events'    => null,
  33                 'register'  => null
  34         ];
  35
  36         /**
  37          * An array of HTML links provided by addons providing a module via the app_menu hook
  38          *
  39          * @var array
  40          */
  41         private static $app_menu = null;
  42
  43         /**
  44          * Set a menu item in navbar as selected
  45          *
  46          * @param string $item
  47          */
  48         public static function setSelected($item)
  49         {
  50                 self::$selected[$item] = 'selected';
  51         }
  52
  53         /**
  54          * Build page header and site navigation bars
  55          *
  56          * @param  App    $a
  57          * @return string
  58          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
  59          */
  60         public static function build(App $a)
  61         {
  62                 // Placeholder div for popup panel
  63                 $nav = '<div id="panel" style="display: none;"></div>';
  64
  65                 $nav_info = self::getInfo($a);
  66
  67                 $tpl = Renderer::getMarkupTemplate('nav.tpl');
  68
  69                 $nav .= Renderer::replaceMacros($tpl, [
  70                         '$sitelocation' => $nav_info['sitelocation'],
  71                         '$nav'          => $nav_info['nav'],
  72                         '$banner'       => $nav_info['banner'],
  73                         '$emptynotifications' => L10n::t('Nothing new here'),
  74                         '$userinfo'     => $nav_info['userinfo'],
  75                         '$sel'          => self::$selected,
  76                         '$apps'         => self::getAppMenu(),
  77                         '$clear_notifs' => L10n::t('Clear notifications'),
  78                         '$search_hint'  => L10n::t('@name, !forum, #tags, content')
  79                 ]);
  80
  81                 Hook::callAll('page_header', $nav);
  82
  83                 return $nav;
  84         }
  85
  86         /**
  87          * Returns the addon app menu
  88          *
  89          * @return array
  90          */
  91         public static function getAppMenu()
  92         {
  93                 if (is_null(self::$app_menu)) {
  94                         self::populateAppMenu();
  95                 }
  96
  97                 return self::$app_menu;
  98         }
  99
 100         /**
 101          * Fills the apps static variable with apps that require a menu
 102          */
 103         private static function populateAppMenu()
 104         {
 105                 self::$app_menu = [];
 106
 107                 //Don't populate apps_menu if apps are private
 108                 $privateapps = Config::get('config', 'private_addons', false);
 109                 if (local_user() || !$privateapps) {
 110                         $arr = ['app_menu' => self::$app_menu];
 111
 112                         Hook::callAll('app_menu', $arr);
 113
 114                         self::$app_menu = $arr['app_menu'];
 115                 }
 116         }
 117
 118         /**
 119          * Prepares a list of navigation links
 120          *
 121          * @brief Prepares a list of navigation links
 122          * @param  App   $a
 123          * @return array Navigation links
 124          *    string 'sitelocation' => The webbie (username@site.com)
 125          *    array 'nav' => Array of links used in the nav menu
 126          *    string 'banner' => Formatted html link with banner image
 127          *    array 'userinfo' => Array of user information (name, icon)
 128          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 129          */
 130         private static function getInfo(App $a)
 131         {
 132                 $ssl_state = ((local_user()) ? true : false);
 133
 134                 /*
 135                  * Our network is distributed, and as you visit friends some of the
 136                  * sites look exactly the same - it isn't always easy to know where you are.
 137                  * Display the current site location as a navigation aid.
 138                  */
 139
 140                 $myident = ((is_array($a->user) && isset($a->user['nickname'])) ? $a->user['nickname'] . '@' : '');
 141
 142                 $sitelocation = $myident . substr(System::baseUrl($ssl_state), strpos(System::baseUrl($ssl_state), '//') + 2);
 143
 144                 // nav links: array of array('href', 'text', 'extra css classes', 'title')
 145                 $nav = [];
 146
 147                 // Display login or logout
 148                 $nav['usermenu'] = [];
 149                 $userinfo = null;
 150
 151                 if (local_user() || remote_user()) {
 152                         $nav['logout'] = ['logout', L10n::t('Logout'), '', L10n::t('End this session')];
 153                 } else {
 154                         $nav['login'] = ['login', L10n::t('Login'), ($a->module == 'login' ? 'selected' : ''), L10n::t('Sign in')];
 155                 }
 156
 157                 if (local_user()) {
 158                         // user menu
 159                         $nav['usermenu'][] = ['profile/' . $a->user['nickname'], L10n::t('Status'), '', L10n::t('Your posts and conversations')];
 160                         $nav['usermenu'][] = ['profile/' . $a->user['nickname'] . '?tab=profile', L10n::t('Profile'), '', L10n::t('Your profile page')];
 161                         $nav['usermenu'][] = ['photos/' . $a->user['nickname'], L10n::t('Photos'), '', L10n::t('Your photos')];
 162                         $nav['usermenu'][] = ['videos/' . $a->user['nickname'], L10n::t('Videos'), '', L10n::t('Your videos')];
 163                         $nav['usermenu'][] = ['events/', L10n::t('Events'), '', L10n::t('Your events')];
 164                         $nav['usermenu'][] = ['notes/', L10n::t('Personal notes'), '', L10n::t('Your personal notes')];
 165
 166                         // user info
 167                         $contact = DBA::selectFirst('contact', ['micro'], ['uid' => $a->user['uid'], 'self' => true]);
 168                         $userinfo = [
 169                                 'icon' => (DBA::isResult($contact) ? $a->removeBaseURL($contact['micro']) : 'images/person-48.jpg'),
 170                                 'name' => $a->user['username'],
 171                         ];
 172                 }
 173
 174                 // "Home" should also take you home from an authenticated remote profile connection
 175                 $homelink = Profile::getMyURL();
 176                 if (! $homelink) {
 177                         $homelink = defaults($_SESSION, 'visitor_home', '');
 178                 }
 179
 180                 if (($a->module != 'home') && (! (local_user()))) {
 181                         $nav['home'] = [$homelink, L10n::t('Home'), '', L10n::t('Home Page')];
 182                 }
 183
 184                 if (intval(Config::get('config', 'register_policy')) === \Friendica\Module\Register::OPEN && !local_user() && !remote_user()) {
 185                         $nav['register'] = ['register', L10n::t('Register'), '', L10n::t('Create an account')];
 186                 }
 187
 188                 $help_url = 'help';
 189
 190                 if (!Config::get('system', 'hide_help')) {
 191                         $nav['help'] = [$help_url, L10n::t('Help'), '', L10n::t('Help and documentation')];
 192                 }
 193
 194                 if (count(self::getAppMenu()) > 0) {
 195                         $nav['apps'] = ['apps', L10n::t('Apps'), '', L10n::t('Addon applications, utilities, games')];
 196                 }
 197
 198                 if (local_user() || !Config::get('system', 'local_search')) {
 199                         $nav['search'] = ['search', L10n::t('Search'), '', L10n::t('Search site content')];
 200
 201                         $nav['searchoption'] = [
 202                                 L10n::t('Full Text'),
 203                                 L10n::t('Tags'),
 204                                 L10n::t('Contacts')
 205                         ];
 206
 207                         if (Config::get('system', 'poco_local_search')) {
 208                                 $nav['searchoption'][] = L10n::t('Forums');
 209                         }
 210                 }
 211
 212                 $gdirpath = 'directory';
 213
 214                 if (strlen(Config::get('system', 'singleuser'))) {
 215                         $gdir = Config::get('system', 'directory');
 216                         if (strlen($gdir)) {
 217                                 $gdirpath = Profile::zrl($gdir, true);
 218                         }
 219                 }
 220
 221                 if ((local_user() || Config::get('system', 'community_page_style') != CP_NO_COMMUNITY_PAGE) &&
 222                         !(Config::get('system', 'community_page_style') == CP_NO_INTERNAL_COMMUNITY)) {
 223                         $nav['community'] = ['community', L10n::t('Community'), '', L10n::t('Conversations on this and other servers')];
 224                 }
 225
 226                 if (local_user()) {
 227                         $nav['events'] = ['events', L10n::t('Events'), '', L10n::t('Events and Calendar')];
 228                 }
 229
 230                 $nav['directory'] = [$gdirpath, L10n::t('Directory'), '', L10n::t('People directory')];
 231
 232                 $nav['about'] = ['friendica', L10n::t('Information'), '', L10n::t('Information about this friendica instance')];
 233
 234                 if (Config::get('system', 'tosdisplay')) {
 235                         $nav['tos'] = ['tos', L10n::t('Terms of Service'), '', L10n::t('Terms of Service of this Friendica instance')];
 236                 }
 237
 238                 // The following nav links are only show to logged in users
 239                 if (local_user()) {
 240                         $nav['network'] = ['network', L10n::t('Network'), '', L10n::t('Conversations from your friends')];
 241                         $nav['net_reset'] = ['network/?f=', L10n::t('Network Reset'), '', L10n::t('Load Network page with no filters')];
 242
 243                         $nav['home'] = ['profile/' . $a->user['nickname'], L10n::t('Home'), '', L10n::t('Your posts and conversations')];
 244
 245                         // Don't show notifications for public communities
 246                         if (defaults($_SESSION, 'page_flags', '') != User::PAGE_FLAGS_COMMUNITY) {
 247                                 $nav['introductions'] = ['notifications/intros', L10n::t('Introductions'), '', L10n::t('Friend Requests')];
 248                                 $nav['notifications'] = ['notifications',       L10n::t('Notifications'), '', L10n::t('Notifications')];
 249                                 $nav['notifications']['all'] = ['notifications/system', L10n::t('See all notifications'), '', ''];
 250                                 $nav['notifications']['mark'] = ['', L10n::t('Mark as seen'), '', L10n::t('Mark all system notifications seen')];
 251                         }
 252
 253                         $nav['messages'] = ['message', L10n::t('Messages'), '', L10n::t('Private mail')];
 254                         $nav['messages']['inbox'] = ['message', L10n::t('Inbox'), '', L10n::t('Inbox')];
 255                         $nav['messages']['outbox'] = ['message/sent', L10n::t('Outbox'), '', L10n::t('Outbox')];
 256                         $nav['messages']['new'] = ['message/new', L10n::t('New Message'), '', L10n::t('New Message')];
 257
 258                         if (is_array($a->identities) && count($a->identities) > 1) {
 259                                 $nav['manage'] = ['manage', L10n::t('Manage'), '', L10n::t('Manage other pages')];
 260                         }
 261
 262                         $nav['delegations'] = ['delegate', L10n::t('Delegations'), '', L10n::t('Delegate Page Management')];
 263
 264                         $nav['settings'] = ['settings', L10n::t('Settings'), '', L10n::t('Account settings')];
 265
 266                         if (Feature::isEnabled(local_user(), 'multi_profiles')) {
 267                                 $nav['profiles'] = ['profiles', L10n::t('Profiles'), '', L10n::t('Manage/Edit Profiles')];
 268                         }
 269
 270                         $nav['contacts'] = ['contact', L10n::t('Contacts'), '', L10n::t('Manage/edit friends and contacts')];
 271                 }
 272
 273                 // Show the link to the admin configuration page if user is admin
 274                 if (is_site_admin()) {
 275                         $nav['admin'] = ['admin/', L10n::t('Admin'), '', L10n::t('Site setup and configuration')];
 276                 }
 277
 278                 $nav['navigation'] = ['navigation/', L10n::t('Navigation'), '', L10n::t('Site map')];
 279
 280                 // Provide a banner/logo/whatever
 281                 $banner = Config::get('system', 'banner');
 282                 if (is_null($banner)) {
 283                         $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>';
 284                 }
 285
 286                 Hook::callAll('nav_info', $nav);
 287
 288                 return [
 289                         'sitelocation' => $sitelocation,
 290                         'nav' => $nav,
 291                         'banner' => $banner,
 292                         'userinfo' => $userinfo,
 293                 ];
 294         }
 295 }