3 * @copyright Copyright (C) 2010-2022, the Friendica project
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Content;
25 use Friendica\Core\Hook;
26 use Friendica\Core\Renderer;
27 use Friendica\Database\DBA;
29 use Friendica\Model\Contact;
30 use Friendica\Model\Profile;
31 use Friendica\Model\User;
32 use Friendica\Module\Conversation\Community;
36 private static $selected = [
42 'introductions' => null,
43 'notifications' => null,
54 * An array of HTML links provided by addons providing a module via the app_menu hook
58 private static $app_menu = null;
61 * Set a menu item in navbar as selected
65 public static function setSelected(string $item)
67 self::$selected[$item] = 'selected';
71 * Build page header and site navigation bars
75 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
77 public static function build(App $a): string
79 // Placeholder div for popup panel
80 $nav = '<div id="panel" style="display: none;"></div>';
82 $nav_info = self::getInfo($a);
84 $tpl = Renderer::getMarkupTemplate('nav.tpl');
86 $nav .= Renderer::replaceMacros($tpl, [
87 '$sitelocation' => $nav_info['sitelocation'],
88 '$nav' => $nav_info['nav'],
89 '$banner' => $nav_info['banner'],
90 '$emptynotifications' => DI::l10n()->t('Nothing new here'),
91 '$userinfo' => $nav_info['userinfo'],
92 '$sel' => self::$selected,
93 '$apps' => self::getAppMenu(),
94 '$home' => DI::l10n()->t('Go back'),
95 '$clear_notifs' => DI::l10n()->t('Clear notifications'),
96 '$search_hint' => DI::l10n()->t('@name, !forum, #tags, content')
99 Hook::callAll('page_header', $nav);
105 * Returns the addon app menu
109 public static function getAppMenu(): array
111 if (is_null(self::$app_menu)) {
112 self::populateAppMenu();
115 return self::$app_menu;
119 * Fills the apps static variable with apps that require a menu
123 private static function populateAppMenu()
125 self::$app_menu = [];
127 //Don't populate apps_menu if apps are private
128 $privateapps = DI::config()->get('config', 'private_addons', false);
129 if (DI::userSession()->getLocalUserId() || !$privateapps) {
130 $arr = ['app_menu' => self::$app_menu];
132 Hook::callAll('app_menu', $arr);
134 self::$app_menu = $arr['app_menu'];
139 * Prepares a list of navigation links
142 * @return array Navigation links
143 * string 'sitelocation' => The webbie (username@site.com)
144 * array 'nav' => Array of links used in the nav menu
145 * string 'banner' => Formatted html link with banner image
146 * array 'userinfo' => Array of user information (name, icon)
147 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
149 private static function getInfo(App $a): array
151 $ssl_state = (bool) DI::userSession()->getLocalUserId();
154 * Our network is distributed, and as you visit friends some of the
155 * sites look exactly the same - it isn't always easy to know where you are.
156 * Display the current site location as a navigation aid.
159 $myident = !empty($a->getLoggedInUserNickname()) ? $a->getLoggedInUserNickname() . '@' : '';
161 $sitelocation = $myident . substr(DI::baseUrl()->get($ssl_state), strpos(DI::baseUrl()->get($ssl_state), '//') + 2);
165 'moderation' => null,
172 'langselector' => null,
175 'notifications' => null,
181 // Display login or logout
184 // nav links: array of array('href', 'text', 'extra css classes', 'title')
185 if (DI::userSession()->isAuthenticated()) {
186 $nav['logout'] = ['logout', DI::l10n()->t('Logout'), '', DI::l10n()->t('End this session')];
188 $nav['login'] = ['login', DI::l10n()->t('Login'), (DI::args()->getModuleName() == 'login' ? 'selected' : ''), DI::l10n()->t('Sign in')];
191 if ($a->isLoggedIn()) {
193 $nav['usermenu'][] = ['profile/' . $a->getLoggedInUserNickname(), DI::l10n()->t('Status'), '', DI::l10n()->t('Your posts and conversations')];
194 $nav['usermenu'][] = ['profile/' . $a->getLoggedInUserNickname() . '/profile', DI::l10n()->t('Profile'), '', DI::l10n()->t('Your profile page')];
195 $nav['usermenu'][] = ['photos/' . $a->getLoggedInUserNickname(), DI::l10n()->t('Photos'), '', DI::l10n()->t('Your photos')];
196 $nav['usermenu'][] = ['profile/' . $a->getLoggedInUserNickname() . '/media', DI::l10n()->t('Media'), '', DI::l10n()->t('Your postings with media')];
197 $nav['usermenu'][] = ['calendar/', DI::l10n()->t('Calendar'), '', DI::l10n()->t('Your calendar')];
198 $nav['usermenu'][] = ['notes/', DI::l10n()->t('Personal notes'), '', DI::l10n()->t('Your personal notes')];
201 $contact = DBA::selectFirst('contact', ['id', 'url', 'avatar', 'micro', 'name', 'nick', 'baseurl', 'updated'], ['uid' => $a->getLoggedInUserId(), 'self' => true]);
203 'icon' => Contact::getMicro($contact),
204 'name' => $contact['name'],
208 // "Home" should also take you home from an authenticated remote profile connection
209 $homelink = Profile::getMyURL();
211 $homelink = DI::session()->get('visitor_home', '');
214 if (DI::args()->getModuleName() != 'home' && ! DI::userSession()->getLocalUserId()) {
215 $nav['home'] = [$homelink, DI::l10n()->t('Home'), '', DI::l10n()->t('Home Page')];
218 if (intval(DI::config()->get('config', 'register_policy')) === \Friendica\Module\Register::OPEN && !DI::userSession()->isAuthenticated()) {
219 $nav['register'] = ['register', DI::l10n()->t('Register'), '', DI::l10n()->t('Create an account')];
224 if (!DI::config()->get('system', 'hide_help')) {
225 $nav['help'] = [$help_url, DI::l10n()->t('Help'), '', DI::l10n()->t('Help and documentation')];
228 if (count(self::getAppMenu()) > 0) {
229 $nav['apps'] = ['apps', DI::l10n()->t('Apps'), '', DI::l10n()->t('Addon applications, utilities, games')];
232 if (DI::userSession()->getLocalUserId() || !DI::config()->get('system', 'local_search')) {
233 $nav['search'] = ['search', DI::l10n()->t('Search'), '', DI::l10n()->t('Search site content')];
235 $nav['searchoption'] = [
236 DI::l10n()->t('Full Text'),
237 DI::l10n()->t('Tags'),
238 DI::l10n()->t('Contacts')
241 if (DI::config()->get('system', 'poco_local_search')) {
242 $nav['searchoption'][] = DI::l10n()->t('Forums');
246 $gdirpath = 'directory';
248 if (strlen(DI::config()->get('system', 'singleuser'))) {
249 $gdir = DI::config()->get('system', 'directory');
251 $gdirpath = Profile::zrl($gdir, true);
255 if ((DI::userSession()->getLocalUserId() || DI::config()->get('system', 'community_page_style') != Community::DISABLED_VISITOR) &&
256 !(DI::config()->get('system', 'community_page_style') == Community::DISABLED)) {
257 $nav['community'] = ['community', DI::l10n()->t('Community'), '', DI::l10n()->t('Conversations on this and other servers')];
260 if (DI::userSession()->getLocalUserId()) {
261 $nav['calendar'] = ['calendar', DI::l10n()->t('Calendar'), '', DI::l10n()->t('Calendar')];
264 $nav['directory'] = [$gdirpath, DI::l10n()->t('Directory'), '', DI::l10n()->t('People directory')];
266 $nav['about'] = ['friendica', DI::l10n()->t('Information'), '', DI::l10n()->t('Information about this friendica instance')];
268 if (DI::config()->get('system', 'tosdisplay')) {
269 $nav['tos'] = ['tos', DI::l10n()->t('Terms of Service'), '', DI::l10n()->t('Terms of Service of this Friendica instance')];
272 // The following nav links are only show to logged in users
273 if (DI::userSession()->getLocalUserId() && !empty($a->getLoggedInUserNickname())) {
274 $nav['network'] = ['network', DI::l10n()->t('Network'), '', DI::l10n()->t('Conversations from your friends')];
276 $nav['home'] = ['profile/' . $a->getLoggedInUserNickname(), DI::l10n()->t('Home'), '', DI::l10n()->t('Your posts and conversations')];
278 // Don't show notifications for public communities
279 if (DI::session()->get('page_flags', '') != User::PAGE_FLAGS_COMMUNITY) {
280 $nav['introductions'] = ['notifications/intros', DI::l10n()->t('Introductions'), '', DI::l10n()->t('Friend Requests')];
281 $nav['notifications'] = ['notifications', DI::l10n()->t('Notifications'), '', DI::l10n()->t('Notifications')];
282 $nav['notifications']['all'] = ['notifications/system', DI::l10n()->t('See all notifications'), '', ''];
283 $nav['notifications']['mark'] = ['', DI::l10n()->t('Mark as seen'), '', DI::l10n()->t('Mark all system notifications as seen')];
286 $nav['messages'] = ['message', DI::l10n()->t('Messages'), '', DI::l10n()->t('Private mail')];
287 $nav['messages']['inbox'] = ['message', DI::l10n()->t('Inbox'), '', DI::l10n()->t('Inbox')];
288 $nav['messages']['outbox'] = ['message/sent', DI::l10n()->t('Outbox'), '', DI::l10n()->t('Outbox')];
289 $nav['messages']['new'] = ['message/new', DI::l10n()->t('New Message'), '', DI::l10n()->t('New Message')];
291 if (User::hasIdentities(DI::userSession()->getSubManagedUserId() ?: DI::userSession()->getLocalUserId())) {
292 $nav['delegation'] = ['delegation', DI::l10n()->t('Accounts'), '', DI::l10n()->t('Manage other pages')];
295 $nav['settings'] = ['settings', DI::l10n()->t('Settings'), '', DI::l10n()->t('Account settings')];
297 $nav['contacts'] = ['contact', DI::l10n()->t('Contacts'), '', DI::l10n()->t('Manage/edit friends and contacts')];
300 // Show the link to the admin configuration page if user is admin
301 if ($a->isSiteAdmin()) {
302 $nav['admin'] = ['admin/', DI::l10n()->t('Admin'), '', DI::l10n()->t('Site setup and configuration')];
303 $nav['moderation'] = ['moderation/', DI::l10n()->t('Moderation'), '', DI::l10n()->t('Content and user moderation')];
306 $nav['navigation'] = ['navigation/', DI::l10n()->t('Navigation'), '', DI::l10n()->t('Site map')];
308 // Provide a banner/logo/whatever
309 $banner = DI::config()->get('system', 'banner');
310 if (is_null($banner)) {
311 $banner = '<a href="https://friendi.ca"><img id="logo-img" width="32" height="32" src="images/friendica.svg" alt="logo" /></a><span id="logo-text"><a href="https://friendi.ca">Friendica</a></span>';
317 'sitelocation' => $sitelocation,
318 'userinfo' => $userinfo,
321 Hook::callAll('nav_info', $nav_info);