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