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