-
-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
Navigation.php
279 lines (248 loc) · 10.5 KB
/
Navigation.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
<?php
/**
* This class is responsible for instantiating
* the various components of the navigation panel
*/
declare(strict_types=1);
namespace PhpMyAdmin\Navigation;
use PhpMyAdmin\Config;
use PhpMyAdmin\Config\PageSettings;
use PhpMyAdmin\ConfigStorage\Relation;
use PhpMyAdmin\Container\ContainerBuilder;
use PhpMyAdmin\Current;
use PhpMyAdmin\DatabaseInterface;
use PhpMyAdmin\Dbal\ConnectionType;
use PhpMyAdmin\ResponseRenderer;
use PhpMyAdmin\Sanitize;
use PhpMyAdmin\Server\Select;
use PhpMyAdmin\Template;
use PhpMyAdmin\Theme\ThemeManager;
use PhpMyAdmin\Url;
use PhpMyAdmin\UserPreferences;
use PhpMyAdmin\UserPrivilegesFactory;
use PhpMyAdmin\Util;
use function __;
use function count;
use function defined;
use function file_exists;
use function parse_url;
use function str_contains;
use function trim;
use const PHP_URL_HOST;
/**
* The navigation panel - displays server, db and table selection tree
*/
class Navigation
{
private NavigationTree $tree;
private readonly UserPrivilegesFactory $userPrivilegesFactory;
public function __construct(
private Template $template,
private Relation $relation,
private DatabaseInterface $dbi,
private readonly Config $config,
) {
$this->tree = new NavigationTree($this->template, $this->dbi, $this->relation, $this->config);
$this->userPrivilegesFactory = new UserPrivilegesFactory($this->dbi);
}
/**
* Renders the navigation tree, or part of it
*
* @return string The navigation tree
*/
public function getDisplay(): string
{
$userPrivileges = $this->userPrivilegesFactory->getPrivileges();
$logo = [
'is_displayed' => $this->config->settings['NavigationDisplayLogo'],
'has_link' => false,
'link' => '#',
'attributes' => ' target="_blank" rel="noopener noreferrer"',
'source' => '',
];
$response = ResponseRenderer::getInstance();
if (! $response->isAjax()) {
$logo['source'] = $this->getLogoSource();
$logo['has_link'] = $this->config->settings['NavigationLogoLink'] !== '';
$logo['link'] = trim($this->config->settings['NavigationLogoLink']);
if (! Sanitize::checkLink($logo['link'], true)) {
$logo['link'] = 'index.php';
}
if ($this->config->settings['NavigationLogoLinkWindow'] === 'main') {
if (empty(parse_url($logo['link'], PHP_URL_HOST))) {
$logo['link'] .= Url::getCommon(
[],
! str_contains($logo['link'], '?') ? '?' : Url::getArgSeparator(),
);
// Internal link detected
$logo['attributes'] = '';
} else {
// External links having a domain name should not be considered
// to be links that can use our internal ajax loading
$logo['attributes'] = ' class="disableAjax"';
}
}
if ($this->config->settings['NavigationDisplayServers'] && count($this->config->settings['Servers']) > 1) {
$serverSelect = Select::render(true);
}
if (! defined('PMA_DISABLE_NAVI_SETTINGS')) {
$pageSettings = new PageSettings(
new UserPreferences($this->dbi, new Relation($this->dbi), $this->template),
);
$pageSettings->init('Navi', 'pma_navigation_settings');
$response->addHTML($pageSettings->getErrorHTML());
$navigationSettings = $pageSettings->getHTML();
}
}
if (! $response->isAjax() || ! empty($_POST['full']) || ! empty($_POST['reload'])) {
if ($this->config->settings['ShowDatabasesNavigationAsTree']) {
// provide database tree in navigation
$navRender = $this->tree->renderState($userPrivileges);
} else {
// provide legacy pre-4.0 navigation
$navRender = $this->tree->renderDbSelect($userPrivileges);
}
} else {
$navRender = $this->tree->renderPath($userPrivileges);
}
return $this->template->render('navigation/main', [
'is_ajax' => $response->isAjax(),
'logo' => $logo,
'config_navigation_width' => $this->config->settings['NavigationWidth'],
'is_synced' => $this->config->settings['NavigationLinkWithMainPanel'],
'is_highlighted' => $this->config->settings['NavigationTreePointerEnable'],
'is_autoexpanded' => $this->config->settings['NavigationTreeAutoexpandSingleDb'],
'server' => Current::$server,
'auth_type' => $this->config->selectedServer['auth_type'],
'is_servers_displayed' => $this->config->settings['NavigationDisplayServers'],
'servers' => $this->config->settings['Servers'],
'server_select' => $serverSelect ?? '',
'navigation_tree' => $navRender,
'is_navigation_settings_enabled' => ! defined('PMA_DISABLE_NAVI_SETTINGS'),
'navigation_settings' => $navigationSettings ?? '',
'is_drag_drop_import_enabled' => $this->config->settings['enable_drag_drop_import'] === true,
'is_mariadb' => $this->dbi->isMariaDB(),
]);
}
/**
* Add an item of navigation tree to the hidden items list in PMA database.
*
* @param string $itemName name of the navigation tree item
* @param string $itemType type of the navigation tree item
* @param string $dbName database name
*/
public function hideNavigationItem(
string $itemName,
string $itemType,
string $dbName,
): void {
$navigationItemsHidingFeature = $this->relation->getRelationParameters()->navigationItemsHidingFeature;
if ($navigationItemsHidingFeature === null) {
return;
}
$navTable = Util::backquote($navigationItemsHidingFeature->database)
. '.' . Util::backquote($navigationItemsHidingFeature->navigationHiding);
$sqlQuery = 'INSERT INTO ' . $navTable
. '(`username`, `item_name`, `item_type`, `db_name`, `table_name`)'
. ' VALUES ('
. $this->dbi->quoteString($this->config->selectedServer['user'], ConnectionType::ControlUser) . ','
. $this->dbi->quoteString($itemName, ConnectionType::ControlUser) . ','
. $this->dbi->quoteString($itemType, ConnectionType::ControlUser) . ','
. $this->dbi->quoteString($dbName, ConnectionType::ControlUser) . ','
. "'')";
$this->dbi->tryQueryAsControlUser($sqlQuery);
}
/**
* Remove a hidden item of navigation tree from the
* list of hidden items in PMA database.
*
* @param string $itemName name of the navigation tree item
* @param string $itemType type of the navigation tree item
* @param string $dbName database name
*/
public function unhideNavigationItem(
string $itemName,
string $itemType,
string $dbName,
): void {
$navigationItemsHidingFeature = $this->relation->getRelationParameters()->navigationItemsHidingFeature;
if ($navigationItemsHidingFeature === null) {
return;
}
$navTable = Util::backquote($navigationItemsHidingFeature->database)
. '.' . Util::backquote($navigationItemsHidingFeature->navigationHiding);
$sqlQuery = 'DELETE FROM ' . $navTable
. ' WHERE'
. ' `username`='
. $this->dbi->quoteString($this->config->selectedServer['user'], ConnectionType::ControlUser)
. ' AND `item_name`=' . $this->dbi->quoteString($itemName, ConnectionType::ControlUser)
. ' AND `item_type`=' . $this->dbi->quoteString($itemType, ConnectionType::ControlUser)
. ' AND `db_name`=' . $this->dbi->quoteString($dbName, ConnectionType::ControlUser);
$this->dbi->tryQueryAsControlUser($sqlQuery);
}
/**
* Returns HTML for the dialog to show hidden navigation items.
*
* @param string $database database name
*
* @return string HTML for the dialog to show hidden navigation items
*/
public function getItemUnhideDialog(string $database): string
{
$hidden = $this->getHiddenItems($database);
$typeMap = [
'group' => __('Groups:'),
'event' => __('Events:'),
'function' => __('Functions:'),
'procedure' => __('Procedures:'),
'table' => __('Tables:'),
'view' => __('Views:'),
];
return $this->template->render('navigation/item_unhide_dialog', [
'database' => $database,
'hidden' => $hidden,
'types' => $typeMap,
]);
}
/** @return mixed[] */
private function getHiddenItems(string $database): array
{
$navigationItemsHidingFeature = $this->relation->getRelationParameters()->navigationItemsHidingFeature;
if ($navigationItemsHidingFeature === null) {
return [];
}
$navTable = Util::backquote($navigationItemsHidingFeature->database)
. '.' . Util::backquote($navigationItemsHidingFeature->navigationHiding);
$sqlQuery = 'SELECT `item_name`, `item_type` FROM ' . $navTable
. ' WHERE `username`='
. $this->dbi->quoteString($this->config->selectedServer['user'], ConnectionType::ControlUser)
. ' AND `db_name`=' . $this->dbi->quoteString($database, ConnectionType::ControlUser)
. " AND `table_name`=''";
$result = $this->dbi->tryQueryAsControlUser($sqlQuery);
$hidden = [];
if ($result) {
foreach ($result as $row) {
$type = $row['item_type'];
if (! isset($hidden[$type])) {
$hidden[$type] = [];
}
$hidden[$type][] = $row['item_name'];
}
}
return $hidden;
}
/** @return string Logo source */
private function getLogoSource(): string
{
/** @var ThemeManager $themeManager */
$themeManager = ContainerBuilder::getContainer()->get(ThemeManager::class);
$theme = $themeManager->theme;
if (@file_exists($theme->getFsPath() . 'img/logo_left.png')) {
return $theme->getPath() . '/img/logo_left.png';
}
if (@file_exists($theme->getFsPath() . 'img/pma_logo2.png')) {
return $theme->getPath() . '/img/pma_logo2.png';
}
return '';
}
}