diff options
Diffstat (limited to 'src/XHtml/HTMLNavbarController.php')
| -rw-r--r-- | src/XHtml/HTMLNavbarController.php | 582 |
1 files changed, 582 insertions, 0 deletions
diff --git a/src/XHtml/HTMLNavbarController.php b/src/XHtml/HTMLNavbarController.php new file mode 100644 index 00000000..ef01578b --- /dev/null +++ b/src/XHtml/HTMLNavbarController.php @@ -0,0 +1,582 @@ +<?php + +/** + * PHPPgAdmin6 + */ + +namespace PHPPgAdmin\XHtml; + +/** + * Class to render tables. Formerly part of Misc.php. + */ +class HTMLNavbarController extends HTMLController +{ + public $controller_name = 'HTMLNavbarController'; + + /** + * Display a bread crumb trail. + * + * @param array|string $trail an array of breadcrumb items, or a string to identify one of them + * @param bool $do_print true to echo, false to return html + * @param null|string $from + * + * @return string ( description_of_the_return_value ) + */ + public function printTrail($trail = [], $do_print = true, $from = null) + { + $from = $from ?: __METHOD__; + + $trail_html = $this->printTopbar($from); + + if (\is_string($trail)) { + $subject = $trail; + $trail = $this->_getTrail($subject); + // Trail hook's place + $plugin_functions_parameters = [ + 'trail' => &$trail, + 'section' => $subject, + ]; + } + + $crumbs = $this->_getCrumbs($trail); + + $viewVars = [ + 'crumbs' => $crumbs, + 'controller_name' => $this->controller_name, + ]; + $containerInstance = $this->getContainer(); + $requestVars = $containerInstance->getAllRequestVars(); + + $viewVars = $this->_getSearchPathsCrumbs($crumbs, $viewVars, $requestVars); + + $trail_html .= $containerInstance->view->fetch('components/trail.twig', $viewVars); + + return $trail_html; + } + + /** + * Get the URL for the last active tab of a particular tab bar. + * + * @param string $section + * + * @return null|mixed + */ + public function getLastTabURL($section) + { + //$data = $this->getDatabaseAccessor(); + + $tabs = $this->misc->getNavTabs($section); + + if (isset($_SESSION['webdbLastTab'][$section], $tabs[$_SESSION['webdbLastTab'][$section]])) { + $tab = $tabs[$_SESSION['webdbLastTab'][$section]]; + } else { + $tab = \reset($tabs); + } + // $this->prtrace(['section' => $section, 'tabs' => $tabs, 'tab' => $tab]); + + return isset($tab['url']) ? $tab : null; + } + + /** + * Display navigation tabs. + * + * @param string $alltabs The name of current section (Ex: intro, server, ...), + * or an array with tabs (Ex: sqledit::doFind function) + * @param string $activetab the name of the tab to be highlighted + * @param bool $do_print true to print html, false to return html + * @param null|string $from whichi method is calling this one + */ + public function printTabs($alltabs, $activetab, $do_print = true, $from = null) + { + $from = $from ?: __METHOD__; + + $this->misc = $this->misc; + $_SESSION['webdbLastTab'] = $_SESSION['webdbLastTab'] ?? []; + + if (!\is_array($_SESSION['webdbLastTab'])) { + $_SESSION['webdbLastTab'] = [$alltabs => $activetab]; + } + + if (\is_string($alltabs)) { + $_SESSION['webdbLastTab'][$alltabs] = $activetab; + $alltabs = $this->misc->getNavTabs($alltabs); + } + $tabs_html = ''; + + //Getting only visible tabs + $tabs = []; + + if (0 < \count($alltabs)) { + foreach ($alltabs as $tab_id => $tab) { + if (!isset($tab['hide']) || true !== $tab['hide']) { + $tabs[$tab_id] = $tab; + $tabs[$tab_id]['active'] = ($tab_id === $activetab) ? ' active' : ''; + $tabs[$tab_id]['tablink'] = \str_replace(['&', '.php'], ['&', ''], \htmlentities($this->getActionUrl($tab, $_REQUEST, $from))); + + if (isset($tab['icon']) && $icon = $this->view->icon($tab['icon'])) { + $tabs[$tab_id]['iconurl'] = $icon; + } + + if (isset($tab['help'])) { + $tabs[$tab_id]['helpurl'] = \str_replace('&', '&', $this->view->getHelpLink($tab['help'])); + } + } + } + } + + if (0 < \count($tabs)) { + $width = (int) (100 / \count($tabs)) . '%'; + + $viewVars = [ + 'width' => $width, + 'tabs' => $tabs, + 'controller_name' => $this->controller_name, + ]; + + $tabs_html = $this->getContainer()->view->fetch('components/tabs.twig', $viewVars); + } + + return $tabs_html; + } + + /** + * @psalm-return array<array-key, array{url: string, iconalt?: mixed|string, title?: mixed, icon?: string, text?: mixed, helpurl?: string}> + * + * @param mixed $trail + * + * @return (mixed|string)[][] + */ + private function _getCrumbs($trail) + { + $crumbs = []; + + foreach ($trail as $crumb_id => $crumb) { + if (isset($crumb['url'])) { + $crumbs[$crumb_id]['url'] = \str_replace('&', '&', $crumb['url']); + } + + if (isset($crumb['title'])) { + $crumbs[$crumb_id]['title'] = $crumb['title']; + $crumbs[$crumb_id]['iconalt'] = $crumb['title']; + } else { + $crumbs[$crumb_id]['iconalt'] = 'Database Root'; + } + + if (isset($crumb['icon']) && $icon = $this->view->icon($crumb['icon'])) { + $crumbs[$crumb_id]['icon'] = $icon; + } + + $crumbs[$crumb_id]['text'] = $crumb['text']; + + if (isset($crumb['help'])) { + $crumbs[$crumb_id]['helpurl'] = \str_replace('&', '&', $this->view->getHelpLink($crumb['help'])); + } + } + + return $crumbs; + } + + /** + * @param mixed $crumbs + * + * @return array + */ + private function _getSearchPathsCrumbs($crumbs, array $viewVars, array $requestVars = []) + { + $data = $this->misc->getDatabaseAccessor(); + $lang = $this->lang; + + if (isset($crumbs['database'])) { + $search_path_crumbs = []; + $dburl = $crumbs['database']['url']; + $search_paths = $data->getSearchPath(); + + foreach ($search_paths as $schema) { + $destination = $this->container->getDestinationWithLastTab('database', $requestVars); + $search_path_crumbs[$schema] = [ + 'title' => $lang['strschema'], + 'text' => $schema, + 'icon' => $this->view->icon('Schema'), + 'iconalt' => $lang['strschema'], + 'url' => $destination, + ]; + } + $viewVars['search_paths'] = $search_path_crumbs; + } + + return $viewVars; + } + + /** + * [printTopbar description]. + * + * @param null|mixed $from which method is calling this one + * + * @return string + */ + private function printTopbar($from = null): ?string + { + $from = $from ?: __METHOD__; + + $lang = $this->lang; + + $this->misc = $this->misc; + $appName = $this->misc->appName; + $appVersion = $this->misc->appVersion; + + $server_info = $this->misc->getServerInfo(); + $server_id = $this->misc->getServerId(); + $reqvars = $this->misc->getRequestVars('table'); + + $topbar_html = '<div class="topbar" data-controller="' . $this->controller_name . '"><div class="platform">'; + + if ($server_info && isset($server_info['platform'], $server_info['username'])) { + // top left informations when connected + $topbar_html .= \sprintf( + $lang['strtopbar'], + '<span class="platform">' . \htmlspecialchars($server_info['platform']) . '</span>', + '<span class="host">' . \htmlspecialchars((empty($server_info['host'])) ? 'localhost' : $server_info['host']) . '</span>', + '<span class="port">' . \htmlspecialchars($server_info['port']) . '</span>', + '<span class="username">' . \htmlspecialchars($server_info['username']) . '</span>' + ); + + $topbar_html .= '</div>'; + + // top right informations when connected + + $toplinks = [ + 'sql' => [ + 'attr' => [ + 'class' => 'toplink_popup', + 'href' => [ + 'url' => \containerInstance()->subFolder . '/src/views/sqledit', + 'urlvars' => \array_merge($reqvars, [ + 'action' => 'sql', + ]), + ], + 'target' => 'sqledit', + 'id' => 'toplink_sql', + ], + 'content' => $lang['strsql'], + ], + 'history' => [ + 'attr' => [ + 'class' => 'toplink_popup', + 'href' => [ + 'url' => \containerInstance()->subFolder . '/src/views/history', + 'urlvars' => \array_merge($reqvars, [ + 'action' => 'pophistory', + ]), + ], + 'id' => 'toplink_history', + ], + 'content' => $lang['strhistory'], + ], + 'find' => [ + 'attr' => [ + 'class' => 'toplink_popup', + 'href' => [ + 'url' => \containerInstance()->subFolder . '/src/views/sqledit', + 'urlvars' => \array_merge($reqvars, [ + 'action' => 'find', + ]), + ], + 'target' => 'sqledit', + 'id' => 'toplink_find', + ], + 'content' => $lang['strfind'], + ], + 'logout' => [ + 'attr' => [ + 'id' => 'toplink_logout', + 'href' => [ + 'url' => \containerInstance()->subFolder . '/src/views/servers', + 'urlvars' => [ + 'action' => 'logout', + 'logoutServer' => \sha1("{$server_info['host']}:{$server_info['port']}:{$server_info['sslmode']}"), + ], + ], + ], + 'content' => $lang['strlogout'], + ], + ]; + + // Toplink hook's place + $plugin_functions_parameters = [ + 'toplinks' => &$toplinks, + ]; + + $topbar_html .= '<div class="toplinks">'; + $toplinks_html = ''; + + foreach ($toplinks as $link) { + $toplinks_html .= \str_replace('.php', '', $this->printLink($link, false, $from)) . \PHP_EOL; + } + + if (\mb_strpos($toplinks_html, 'toplink_popup') !== false) { + $topbar_html .= \str_replace( + [ + '<a', + '/a>', + 'id="toplink_logout" href', + 'class="toplink_popup" href', + 'src/views/', + 'target="sqledit"', + ], + [ + '<button', + '/button>', + 'id="toplink_logout" rel', + 'class="toplink_popup" rel', + '', + 'target="_blank" ', + ], + $toplinks_html + ); + } + } else { + $topbar_html .= "<span class=\"appname\">{$appName}</span> <span class=\"version\">{$appVersion}</span>"; + } + + $topbar_html .= '</div></div>' . \PHP_EOL; + + return $topbar_html; + } + + /** + * @return string + */ + private function getHREFSubject(string $subject) + { + $vars = $this->misc->getSubjectParams($subject); + \ksort($vars['params']); + + return "{$vars['url']}&" . \http_build_query($vars['params'], '', '&'); + } + + /** + * Create a bread crumb trail of the object hierarchy. + * + * @param null|string $subject sunkect of the trail + * + * @return (mixed|null|string)[][] the trail array + * + * @psalm-return array<array-key, array<array-key, mixed|null|string>> + */ + private function _getTrail($subject = null) + { + $lang = $this->lang; + + $appName = $this->misc->appName; + + $trail = []; + + $trail['root'] = [ + 'text' => $appName, + 'url' => \containerInstance()->subFolder . '/src/views/servers', + 'icon' => 'Introduction', + ]; + + if ('root' === $subject) { + return $trail; + } + + $server_info = $this->misc->getServerInfo(); + $trail['server'] = [ + 'title' => $lang['strserver'], + 'text' => $server_info['desc'], + 'url' => $this->getHREFSubject('server'), + 'help' => 'pg.server', + 'icon' => 'Server', + ]; + + if ('server' === $subject) { + return $trail; + } + + $database_rolename = [ + 'database' => [ + 'title' => $lang['strdatabase'], + 'subject' => 'database', + 'help' => 'pg.database', + 'icon' => 'Database', + ], + 'rolename' => [ + 'title' => $lang['strrole'], + 'subject' => 'role', + 'help' => 'pg.role', + 'icon' => 'Roles', + ], + ]; + + $trail = $this->_getTrailsFromArray($trail, $database_rolename); + + if (\in_array($subject, ['database', 'role'], true)) { + return $trail; + } + + $schema = [ + 'schema' => [ + 'title' => $lang['strschema'], + 'subject' => 'schema', + 'help' => 'pg.schema', + 'icon' => 'Schema', + ], + ]; + + $trail = $this->_getTrailsFromArray($trail, $schema); + + if ('schema' === $subject) { + return $trail; + } + + $table_view_matview_fts = [ + 'table' => [ + 'title' => $lang['strtable'], + 'subject' => 'table', + 'help' => 'pg.table', + 'icon' => 'Table', + ], + 'view' => [ + 'title' => $lang['strview'], + 'subject' => 'view', + 'help' => 'pg.view', + 'icon' => 'View', + ], + 'matview' => [ + 'title' => 'M' . $lang['strview'], + 'subject' => 'matview', + 'help' => 'pg.matview', + 'icon' => 'MViews', + ], + 'ftscfg' => [ + 'title' => $lang['strftsconfig'], + 'subject' => 'ftscfg', + 'help' => 'pg.ftscfg.example', + 'icon' => 'Fts', + ], + ]; + + $trail = $this->_getTrailsFromArray($trail, $table_view_matview_fts); + + if (\in_array($subject, ['table', 'view', 'matview', 'ftscfg'], true)) { + return $trail; + } + + if (null !== $subject) { + $trail = $this->_getLastTrailPart($subject, $trail); + } + + return $trail; + } + + /** + * @param (mixed|string)[][] $trail + * @param (mixed|string)[][] $the_array + * + * @return (mixed|string)[][] + * + * @psalm-return array<array-key, array<array-key, mixed|string>> + */ + private function _getTrailsFromArray(array $trail, array $the_array) + { + foreach ($the_array as $key => $value) { + if (isset($_REQUEST[$key])) { + $trail[$key] = [ + 'title' => $value['title'], + 'text' => $_REQUEST[$key], + 'url' => $this->getHREFSubject($value['subject']), + 'help' => $value['help'], + 'icon' => $value['icon'], + ]; + + break; + } + } + + return $trail; + } + + /** + * @param (mixed|string)[][] $trail + * + * @return (mixed|null|string)[][] + * + * @psalm-return array<array-key, array<array-key, mixed|null|string>> + */ + private function _getLastTrailPart(string $subject, $trail) + { + $lang = $this->lang; + + switch ($subject) { + case 'function': + $trail[$subject] = [ + 'title' => $lang['str' . $subject], + 'text' => $_REQUEST[$subject], + 'url' => $this->getHREFSubject('function'), + 'help' => 'pg.function', + 'icon' => 'Function', + ]; + + break; + case 'aggregate': + $trail[$subject] = [ + 'title' => $lang['straggregate'], + 'text' => $_REQUEST['aggrname'], + 'url' => $this->getHREFSubject('aggregate'), + 'help' => 'pg.aggregate', + 'icon' => 'Aggregate', + ]; + + break; + case 'column': + $trail['column'] = [ + 'title' => $lang['strcolumn'], + 'text' => $_REQUEST['column'], + 'icon' => 'Column', + 'url' => $this->getHREFSubject('column'), + ]; + + break; + + default: + if (isset($_REQUEST[$subject])) { + switch ($subject) { + case 'domain': + $icon = 'Domain'; + + break; + case 'sequence': + $icon = 'Sequence'; + + break; + case 'type': + $icon = 'Type'; + + break; + case 'operator': + $icon = 'Operator'; + + break; + case 'index': + $icon = 'Index'; + + break; + + default: + $icon = null; + + break; + } + $trail[$subject] = [ + 'title' => \array_key_exists('str' . $subject, $lang) ? $lang['str' . $subject] : $subject, + 'text' => $_REQUEST[$subject], + 'help' => 'pg.' . $subject, + 'icon' => $icon, + ]; + } + } + + return $trail; + } +} |