mirror of
https://github.com/pgadmin-org/pgadmin4.git
synced 2025-02-25 18:55:31 -06:00
9f12747d9b
Fixed following issues: 1. If the database name contains escape characters then PSQL unable to connect. 2. If the user terminates the connection by typing the 'exit' command, PSQL will show the connection termination msg. Fixes #2341
544 lines
17 KiB
Python
544 lines
17 KiB
Python
##########################################################################
|
|
#
|
|
# pgAdmin 4 - PostgreSQL Tools
|
|
#
|
|
# Copyright (C) 2013 - 2021, The pgAdmin Development Team
|
|
# This software is released under the PostgreSQL Licence
|
|
#
|
|
##########################################################################
|
|
import sys
|
|
from flask_babelex import gettext
|
|
from pgadmin.utils.constants import PREF_LABEL_DISPLAY,\
|
|
PREF_LABEL_KEYBOARD_SHORTCUTS, PREF_LABEL_TABS_SETTINGS, \
|
|
PREF_LABEL_OPTIONS, QT_DEFAULT_PLACEHOLDER
|
|
from flask_security import current_user
|
|
import config
|
|
|
|
LOCK_LAYOUT_LEVEL = {
|
|
'PREVENT_DOCKING': 'docking',
|
|
'FULL': 'full',
|
|
'NONE': 'none'
|
|
}
|
|
|
|
|
|
def register_browser_preferences(self):
|
|
self.show_system_objects = self.preference.register(
|
|
'display', 'show_system_objects',
|
|
gettext("Show system objects?"), 'boolean', False,
|
|
category_label=PREF_LABEL_DISPLAY
|
|
)
|
|
if config.SERVER_MODE:
|
|
self.hide_shared_server = self.preference.register(
|
|
'display', 'hide_shared_server',
|
|
gettext("Hide shared servers?"), 'boolean', False,
|
|
category_label=gettext('Display'),
|
|
help_str=gettext(
|
|
'If set to True, then all shared servers will be '
|
|
'hidden from browser tree'
|
|
)
|
|
)
|
|
|
|
self.preference.register(
|
|
'display', 'enable_acitree_animation',
|
|
gettext("Enable browser tree animation?"), 'boolean', True,
|
|
category_label=PREF_LABEL_DISPLAY
|
|
)
|
|
|
|
self.preference.register(
|
|
'display', 'enable_alertify_animation',
|
|
gettext("Enable dialogue/notification animation?"), 'boolean',
|
|
True, category_label=PREF_LABEL_DISPLAY
|
|
)
|
|
|
|
self.preference.register(
|
|
'display', 'browser_tree_state_save_interval',
|
|
gettext("Browser tree state saving interval"), 'integer',
|
|
30, category_label=PREF_LABEL_DISPLAY,
|
|
help_str=gettext(
|
|
'Browser tree state saving interval in seconds. '
|
|
'Use -1 to disable the tree saving mechanism.'
|
|
)
|
|
)
|
|
|
|
self.preference.register(
|
|
'display', 'confirm_on_refresh_close',
|
|
gettext("Confirm on close or refresh?"), 'boolean',
|
|
True, category_label=PREF_LABEL_DISPLAY,
|
|
help_str=gettext(
|
|
'Confirm closure or refresh of the browser or browser tab is '
|
|
'intended before proceeding.'
|
|
)
|
|
)
|
|
|
|
self.preference.register(
|
|
'display', 'confirm_on_properties_close',
|
|
gettext("Confirm before Close/Reset in object properties dialog?"),
|
|
'boolean',
|
|
True, category_label=PREF_LABEL_DISPLAY,
|
|
help_str=gettext(
|
|
'Confirm before closing or resetting the changes in the '
|
|
'properties dialog for an object if the changes are not saved.'
|
|
)
|
|
)
|
|
|
|
self.preference.register(
|
|
'display', 'auto_expand_sole_children',
|
|
gettext("Auto-expand sole children"), 'boolean', True,
|
|
category_label=PREF_LABEL_DISPLAY,
|
|
help_str=gettext(
|
|
'If a treeview node is expanded and has only a single '
|
|
'child, automatically expand the child node as well.'
|
|
)
|
|
)
|
|
|
|
self.lock_layout = self.preference.register(
|
|
'display', 'lock_layout',
|
|
gettext('Lock Layout'), 'radioModern', LOCK_LAYOUT_LEVEL['NONE'],
|
|
category_label=PREF_LABEL_DISPLAY, options=[
|
|
{'label': gettext('None'), 'value': LOCK_LAYOUT_LEVEL['NONE']},
|
|
{'label': gettext('Prevent Docking'),
|
|
'value': LOCK_LAYOUT_LEVEL['PREVENT_DOCKING']},
|
|
{'label': gettext('Full Lock'),
|
|
'value': LOCK_LAYOUT_LEVEL['FULL']},
|
|
],
|
|
help_str=gettext(
|
|
'Lock the UI layout at different levels'
|
|
)
|
|
)
|
|
|
|
self.table_row_count_threshold = self.preference.register(
|
|
'properties', 'table_row_count_threshold',
|
|
gettext("Count rows if estimated less than"), 'integer', 2000,
|
|
category_label=gettext('Properties')
|
|
)
|
|
|
|
self.pg_agent_row_threshold = self.preference.register(
|
|
'properties', 'pgagent_row_threshold',
|
|
gettext("Maximum job history rows"), 'integer', 250,
|
|
category_label=gettext('Properties'),
|
|
min_val=1, max_val=9999,
|
|
help_str=gettext(
|
|
'The maximum number of history rows to show on '
|
|
'the Statistics tab for pgAgent jobs'
|
|
)
|
|
)
|
|
|
|
fields = [
|
|
{'name': 'key', 'type': 'keyCode', 'label': gettext('Key')},
|
|
{'name': 'shift', 'type': 'checkbox', 'label': gettext('Shift')},
|
|
{'name': 'control', 'type': 'checkbox', 'label': gettext('Ctrl')},
|
|
{'name': 'alt', 'type': 'checkbox', 'label': gettext('Alt/Option')}
|
|
]
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts',
|
|
'browser_tree',
|
|
gettext('Browser tree'),
|
|
'keyboardshortcut',
|
|
{
|
|
'alt': True,
|
|
'shift': True,
|
|
'control': False,
|
|
'key': {'key_code': 66, 'char': 'b'}
|
|
},
|
|
category_label=PREF_LABEL_KEYBOARD_SHORTCUTS,
|
|
fields=fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts',
|
|
'tabbed_panel_backward',
|
|
gettext('Tabbed panel backward'),
|
|
'keyboardshortcut',
|
|
{
|
|
'alt': True,
|
|
'shift': True,
|
|
'control': False,
|
|
'key': {'key_code': 91, 'char': '['}
|
|
},
|
|
category_label=PREF_LABEL_KEYBOARD_SHORTCUTS,
|
|
fields=fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts',
|
|
'tabbed_panel_forward',
|
|
gettext('Tabbed panel forward'),
|
|
'keyboardshortcut',
|
|
{
|
|
'alt': True,
|
|
'shift': True,
|
|
'control': False,
|
|
'key': {'key_code': 93, 'char': ']'}
|
|
},
|
|
category_label=PREF_LABEL_KEYBOARD_SHORTCUTS,
|
|
fields=fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts',
|
|
'main_menu_file',
|
|
gettext('File main menu'),
|
|
'keyboardshortcut',
|
|
{
|
|
'alt': True,
|
|
'shift': True,
|
|
'control': False,
|
|
'key': {'key_code': 70, 'char': 'f'}
|
|
},
|
|
category_label=PREF_LABEL_KEYBOARD_SHORTCUTS,
|
|
fields=fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts',
|
|
'main_menu_object',
|
|
gettext('Object main menu'),
|
|
'keyboardshortcut',
|
|
{
|
|
'alt': True,
|
|
'shift': True,
|
|
'control': False,
|
|
'key': {'key_code': 79, 'char': 'o'}
|
|
},
|
|
category_label=PREF_LABEL_KEYBOARD_SHORTCUTS,
|
|
fields=fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts',
|
|
'main_menu_tools',
|
|
gettext('Tools main menu'),
|
|
'keyboardshortcut',
|
|
{
|
|
'alt': True,
|
|
'shift': True,
|
|
'control': False,
|
|
'key': {'key_code': 76, 'char': 'l'}
|
|
},
|
|
category_label=PREF_LABEL_KEYBOARD_SHORTCUTS,
|
|
fields=fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts',
|
|
'main_menu_help',
|
|
gettext('Help main menu'),
|
|
'keyboardshortcut',
|
|
{
|
|
'alt': True,
|
|
'shift': True,
|
|
'control': False,
|
|
'key': {'key_code': 72, 'char': 'h'}
|
|
},
|
|
category_label=PREF_LABEL_KEYBOARD_SHORTCUTS,
|
|
fields=fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts',
|
|
'sub_menu_query_tool',
|
|
gettext('Open query tool'),
|
|
'keyboardshortcut',
|
|
{
|
|
'alt': True,
|
|
'shift': True,
|
|
'control': False,
|
|
'key': {'key_code': 81, 'char': 'q'}
|
|
},
|
|
category_label=PREF_LABEL_KEYBOARD_SHORTCUTS,
|
|
fields=fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts',
|
|
'sub_menu_view_data',
|
|
gettext('View data'),
|
|
'keyboardshortcut',
|
|
{
|
|
'alt': True,
|
|
'shift': True,
|
|
'control': False,
|
|
'key': {'key_code': 86, 'char': 'v'}
|
|
},
|
|
category_label=PREF_LABEL_KEYBOARD_SHORTCUTS,
|
|
fields=fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts',
|
|
'sub_menu_search_objects',
|
|
gettext('Search objects'),
|
|
'keyboardshortcut',
|
|
{
|
|
'alt': True,
|
|
'shift': True,
|
|
'control': False,
|
|
'key': {'key_code': 83, 'char': 's'}
|
|
},
|
|
category_label=PREF_LABEL_KEYBOARD_SHORTCUTS,
|
|
fields=fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts',
|
|
'sub_menu_create',
|
|
gettext('Create object'),
|
|
'keyboardshortcut',
|
|
{
|
|
'alt': True,
|
|
'shift': True,
|
|
'control': False,
|
|
'key': {'key_code': 78, 'char': 'n'}
|
|
},
|
|
category_label=PREF_LABEL_KEYBOARD_SHORTCUTS,
|
|
fields=fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts',
|
|
'sub_menu_properties',
|
|
gettext('Edit object properties'),
|
|
'keyboardshortcut',
|
|
{
|
|
'alt': True,
|
|
'shift': True,
|
|
'control': False,
|
|
'key': {'key_code': 69, 'char': 'e'}
|
|
},
|
|
category_label=PREF_LABEL_KEYBOARD_SHORTCUTS,
|
|
fields=fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts',
|
|
'sub_menu_delete',
|
|
gettext('Delete object'),
|
|
'keyboardshortcut',
|
|
{
|
|
'alt': True,
|
|
'shift': True,
|
|
'control': False,
|
|
'key': {'key_code': 68, 'char': 'd'}
|
|
},
|
|
category_label=PREF_LABEL_KEYBOARD_SHORTCUTS,
|
|
fields=fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts',
|
|
'grid_menu_drop_multiple',
|
|
gettext('Delete/Drop multiple objects'),
|
|
'keyboardshortcut',
|
|
{
|
|
'alt': True,
|
|
'shift': True,
|
|
'control': False,
|
|
'key': {'key_code': 77, 'char': 'm'}
|
|
},
|
|
category_label=PREF_LABEL_KEYBOARD_SHORTCUTS,
|
|
fields=fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts',
|
|
'grid_menu_drop_cascade_multiple',
|
|
gettext('Drop Cascade multiple objects'),
|
|
'keyboardshortcut',
|
|
{
|
|
'alt': True,
|
|
'shift': True,
|
|
'control': False,
|
|
'key': {'key_code': 85, 'char': 'u'}
|
|
},
|
|
category_label=PREF_LABEL_KEYBOARD_SHORTCUTS,
|
|
fields=fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts',
|
|
'context_menu',
|
|
gettext('Open context menu'),
|
|
'keyboardshortcut',
|
|
{
|
|
'alt': True,
|
|
'shift': True,
|
|
'control': False,
|
|
'key': {'key_code': 67, 'char': 'c'}
|
|
},
|
|
category_label=PREF_LABEL_KEYBOARD_SHORTCUTS,
|
|
fields=fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts',
|
|
'direct_debugging',
|
|
gettext('Direct debugging'),
|
|
'keyboardshortcut',
|
|
{
|
|
'alt': True,
|
|
'shift': True,
|
|
'control': False,
|
|
'key': {'key_code': 71, 'char': 'g'}
|
|
},
|
|
category_label=PREF_LABEL_KEYBOARD_SHORTCUTS,
|
|
fields=fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts',
|
|
'dialog_tab_forward',
|
|
gettext('Dialog tab forward'),
|
|
'keyboardshortcut',
|
|
{
|
|
'alt': False,
|
|
'shift': True,
|
|
'control': True,
|
|
'key': {'key_code': 93, 'char': ']'}
|
|
},
|
|
category_label=PREF_LABEL_KEYBOARD_SHORTCUTS,
|
|
fields=fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts',
|
|
'dialog_tab_backward',
|
|
gettext('Dialog tab backward'),
|
|
'keyboardshortcut',
|
|
{
|
|
'alt': False,
|
|
'shift': True,
|
|
'control': True,
|
|
'key': {'key_code': 91, 'char': '['}
|
|
},
|
|
category_label=PREF_LABEL_KEYBOARD_SHORTCUTS,
|
|
fields=fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts',
|
|
'sub_menu_refresh',
|
|
gettext('Refresh browser tree'),
|
|
'keyboardshortcut',
|
|
{
|
|
'alt': False,
|
|
'shift': False,
|
|
'control': False,
|
|
'key': {'key_code': 116, 'char': 'F5'}
|
|
},
|
|
category_label=PREF_LABEL_KEYBOARD_SHORTCUTS,
|
|
fields=fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts',
|
|
'add_grid_row',
|
|
gettext('Add grid row'),
|
|
'keyboardshortcut',
|
|
{
|
|
'alt': False,
|
|
'shift': True,
|
|
'control': True,
|
|
'key': {'key_code': 65, 'char': 'a'}
|
|
},
|
|
category_label=PREF_LABEL_KEYBOARD_SHORTCUTS,
|
|
fields=fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts', 'open_quick_search',
|
|
gettext('Quick Search'), 'keyboardshortcut',
|
|
{
|
|
'alt': False,
|
|
'shift': True,
|
|
'control': True,
|
|
'key': {'key_code': 70, 'char': 'f'}
|
|
},
|
|
category_label=PREF_LABEL_KEYBOARD_SHORTCUTS,
|
|
fields=fields
|
|
)
|
|
|
|
self.dynamic_tab_title = self.preference.register(
|
|
'tab_settings', 'dynamic_tabs',
|
|
gettext("Dynamic tab size"), 'boolean', False,
|
|
category_label=PREF_LABEL_TABS_SETTINGS,
|
|
help_str=gettext(
|
|
'If set to True, the tabs will take full size as per the title, '
|
|
'it will also applicable for already opened tabs')
|
|
)
|
|
|
|
self.qt_tab_title = self.preference.register(
|
|
'tab_settings', 'qt_tab_title_placeholder',
|
|
gettext("Query tool tab title"),
|
|
'text', QT_DEFAULT_PLACEHOLDER,
|
|
category_label=PREF_LABEL_DISPLAY,
|
|
help_str=gettext(
|
|
'Supported placeholders are %DATABASE%, %USERNAME%, and %SERVER%. '
|
|
'Users can provide any string with or without placeholders of'
|
|
' their choice. The blank title will be revert back to the'
|
|
' default title with placeholders.'
|
|
)
|
|
)
|
|
|
|
self.ve_edt_tab_title = self.preference.register(
|
|
'tab_settings', 'vw_edt_tab_title_placeholder',
|
|
gettext("View/Edit data tab title"),
|
|
'text', '%SCHEMA%.%TABLE%/%DATABASE%/%USERNAME%@%SERVER%',
|
|
category_label=PREF_LABEL_DISPLAY,
|
|
help_str=gettext(
|
|
'Supported placeholders are %SCHEMA%, %TABLE%, %DATABASE%, '
|
|
'%USERNAME%, and %SERVER%. Users can provide any string with or '
|
|
'without placeholders of their choice. The blank title will be '
|
|
'revert back to the default title with placeholders.'
|
|
)
|
|
)
|
|
|
|
self.debugger_tab_title = self.preference.register(
|
|
'tab_settings', 'debugger_tab_title_placeholder',
|
|
gettext("Debugger tab title"),
|
|
'text', '%FUNCTION%(%ARGS%)',
|
|
category_label=PREF_LABEL_DISPLAY,
|
|
help_str=gettext(
|
|
'Supported placeholders are %FUNCTION%, %ARGS%, %SCHEMA% and'
|
|
' %DATABASE%. Users can provide any string with or '
|
|
'without placeholders of their choice. The blank title will be'
|
|
' revert back to the default title with placeholders.'
|
|
)
|
|
)
|
|
|
|
self.open_in_new_tab = self.preference.register(
|
|
'tab_settings', 'new_browser_tab_open',
|
|
gettext("Open in new browser tab"), 'select2', None,
|
|
category_label=PREF_LABEL_OPTIONS,
|
|
options=[{'label': gettext('Query Tool'), 'value': 'qt'},
|
|
{'label': gettext('Debugger'), 'value': 'debugger'},
|
|
{'label': gettext('Schema Diff'), 'value': 'schema_diff'},
|
|
{'label': gettext('ERD Tool'), 'value': 'erd_tool'},
|
|
{'label': gettext('PSQL Tool'), 'value': 'psql_tool'}],
|
|
help_str=gettext(
|
|
'Select Query Tool, Debugger, Schema Diff, ERD Tool '
|
|
'or PSQL Tool from the drop-down to set '
|
|
'open in new browser tab for that particular module.'
|
|
),
|
|
select2={
|
|
'multiple': True, 'allowClear': False,
|
|
'tags': True, 'first_empty': False,
|
|
'selectOnClose': False, 'emptyOptions': True,
|
|
'tokenSeparators': [','],
|
|
'placeholder': gettext('Select open new tab...')
|
|
}
|
|
)
|
|
|
|
self.psql_tab_title = self.preference.register(
|
|
'tab_settings', 'psql_tab_title_placeholder',
|
|
gettext("PSQL tool tab title"),
|
|
'text', '%DATABASE%/%USERNAME%@%SERVER%',
|
|
category_label=PREF_LABEL_DISPLAY,
|
|
help_str=gettext(
|
|
'Supported placeholders are %DATABASE%, %USERNAME%, '
|
|
'and %SERVER%. Users can provide any string with or without'
|
|
' placeholders of their choice. The blank title will be revert'
|
|
' back to the default title with placeholders.'
|
|
)
|
|
)
|