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