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