Provide option to open file in new tab in the the query tool.#1235

yogeshmahajan-1903 · yogeshmahajan-1903 · commit a90f8646529d · 2025-02-21T12:04:25.000+05:30
diff --git a/docs/en_US/images/preferences_sql_options.png b/docs/en_US/images/preferences_sql_options.png
diff --git a/docs/en_US/images/query_toolbar.png b/docs/en_US/images/query_toolbar.png
diff --git a/docs/en_US/preferences.rst b/docs/en_US/preferences.rst
@@ -474,6 +474,9 @@ Use the fields on the *Options* panel to manage editor preferences.
   editor will prompt the user to saved unsaved data when exiting the data
   editor.
 
+* When the *Open the file in a new tab?* switch is set to *True*, the
+  editor will open the new file in new tab of the Query Tool.
+
 * When the *Prompt to save unsaved query changes?* switch is set to *True*, the
   editor will prompt the user to saved unsaved query modifications when exiting
   the Query Tool.
diff --git a/docs/en_US/query_tool_toolbar.rst b/docs/en_US/query_tool_toolbar.rst
@@ -29,7 +29,8 @@ File Options
    +----------------------+---------------------------------------------------------------------------------------------------+----------------+
    | Icon                 | Behavior                                                                                          | Shortcut       |
    +======================+===================================================================================================+================+
-   | *Open File*          | Click the *Open File* icon to display a previously saved query in the SQL Editor.                 | Cmd/Ctrl + O   |
+   | *Open File*          | Click the *Open File* icon to display a previously saved query in the same tab of the SQL Editor. |                |
+   |                      | To open the file in a new tab, select *Open in a new tab?* option form the dropdown.              | Cmd/Ctrl + O   |
    +----------------------+---------------------------------------------------------------------------------------------------+----------------+
    | *Save File*          | Click the *Save* icon to perform a quick-save of a previously saved query, or to access the       | Cmd/Ctrl + S   |
    |                      | *Save* menu:                                                                                      |                |
diff --git a/web/pgadmin/misc/file_manager/__init__.py b/web/pgadmin/misc/file_manager/__init__.py
@@ -380,6 +380,12 @@ def create_new_transaction(params):
                 True,
                 gettext("Select Folder")
             ),
+            'open_file': (
+                ['open_file'],
+                True,
+                False,
+                gettext("Select File")
+            ),
             'create_file': (
                 ['select_file', 'rename', 'create'],
                 True,
diff --git a/web/pgadmin/misc/file_manager/static/js/FileManagerModule.jsx b/web/pgadmin/misc/file_manager/static/js/FileManagerModule.jsx
@@ -61,7 +61,9 @@ export default class FileManagerModule {
     if(!title) {
       if(params.dialog_type == 'create_file') {
         title = gettext('Save File');
-      } else if(params.dialog_type == 'select_file') {
+      } else if(params.dialog_type == 'open_file'){
+        title = gettext('Open File');
+      }else if(params.dialog_type == 'select_file') {
         title = gettext('Select File');
       } else {
         title = gettext('Storage Manager');
diff --git a/web/pgadmin/misc/file_manager/static/js/components/FileManager.jsx b/web/pgadmin/misc/file_manager/static/js/components/FileManager.jsx
@@ -645,7 +645,8 @@ export default function FileManager({params, closeModal, onOK, onCancel, sharedS
     } else if(selectedRowIdx.current >= 0 && row) {
       let selectedfileType = row?.file_type;
       if(((selectedfileType == 'dir' || selectedfileType == 'drive') && fmUtilsObj.hasCapability('select_folder'))
-      || (selectedfileType != 'dir' && selectedfileType != 'drive' && fmUtilsObj.hasCapability('select_file'))) {
+      || (selectedfileType != 'dir' && selectedfileType != 'drive' && fmUtilsObj.hasCapability('select_file'))
+      || (selectedfileType != 'dir' && selectedfileType != 'drive' && fmUtilsObj.hasCapability('open_file'))) {
         disabled = false;
       }
     }
@@ -695,9 +696,12 @@ export default function FileManager({params, closeModal, onOK, onCancel, sharedS
     okBtnText = gettext('Select');
     if(params.dialog_type == 'create_file' || params.dialog_type == 'create_folder') {
       okBtnText = gettext('Create');
+    }else if(params.dialog_type == 'open_file'){
+      okBtnText = gettext('Open');
     }
   }
 
+
   return (
     <ErrorBoundary>
       <StyledBox display="flex" flexDirection="column" height="100%">
@@ -862,4 +866,4 @@ FileManager.propTypes = {
   onCancel: PropTypes.func,
   sharedStorages: PropTypes.array,
   restrictedSharedStorage: PropTypes.array,
-};
+};
diff --git a/web/pgadmin/static/js/components/ExternalIcon.jsx b/web/pgadmin/static/js/components/ExternalIcon.jsx
@@ -117,4 +117,4 @@ export const MSAzureIcon = ({style})=><ExternalIcon Icon={MsAzure} style={{heigh
 MSAzureIcon.propTypes = {style: PropTypes.object};
 
 export const SchemaDiffIcon = ({style})=><ExternalIcon Icon={SchemaDiffSvg} style={{height: '2rem', ...style}} data-label="SchemaDiffIcon" />;
-SchemaDiffIcon.propTypes = {style: PropTypes.object};
+SchemaDiffIcon.propTypes = {style: PropTypes.object};
diff --git a/web/pgadmin/tools/sqleditor/static/js/components/QueryToolComponent.jsx b/web/pgadmin/tools/sqleditor/static/js/components/QueryToolComponent.jsx
@@ -261,6 +261,7 @@ export default function QueryToolComponent({params, pgWindow, pgAdmin, selectedN
     }
   }, pollTime);
 
+
   let defaultLayout = {
     dockbox: {
       mode: 'vertical',
@@ -378,6 +379,10 @@ export default function QueryToolComponent({params, pgWindow, pgAdmin, selectedN
           let msg = `${selectedConn['server_name']}/${selectedConn['database_name']} - Database connected`;
           pgAdmin.Browser.notifier.success(_.escape(msg));
         }
+        // Open the file if filename passed on the parameters.
+        if(qtState.params.fileName){
+          eventBus.current.fireEvent(QUERY_TOOL_EVENTS.LOAD_FILE, params.fileName, params.storage);
+        }
       }).catch((error)=>{
         if(error.response?.request?.responseText?.search('Ticket expired') !== -1) {
           Kerberos.fetch_ticket()
@@ -577,14 +582,20 @@ export default function QueryToolComponent({params, pgWindow, pgAdmin, selectedN
       eventBus.current.fireEvent(QUERY_TOOL_EVENTS.EDITOR_LAST_FOCUS);
     };
     const events = [
-      [QUERY_TOOL_EVENTS.TRIGGER_LOAD_FILE, ()=>{
+      [QUERY_TOOL_EVENTS.TRIGGER_LOAD_FILE, (openInNewTab=false)=>{
         let fileParams = {
           'supported_types': ['sql', '*'], // file types allowed
-          'dialog_type': 'select_file', // open select file dialog
+          'dialog_type': 'open_file', // open select file dialog
         };
-        pgAdmin.Tools.FileManager.show(fileParams, (fileName, storage)=>{
-          eventBus.current.fireEvent(QUERY_TOOL_EVENTS.LOAD_FILE, fileName, storage);
-        }, null, modal);
+        if(openInNewTab){
+          pgAdmin.Tools.FileManager.show(fileParams, (fileName, storage)=>{
+            onNewQueryToolClick(null, fileName, storage);
+          }, null, modal, openInNewTab);
+        }else{
+          pgAdmin.Tools.FileManager.show(fileParams,(fileName, storage)=>{
+            eventBus.current.fireEvent(QUERY_TOOL_EVENTS.LOAD_FILE, fileName, storage);
+          }, null, modal);
+        }
       }],
       [QUERY_TOOL_EVENTS.TRIGGER_SAVE_FILE, (isSaveAs=false)=>{
         if(!isSaveAs && qtState.current_file) {
@@ -783,8 +794,7 @@ export default function QueryToolComponent({params, pgWindow, pgAdmin, selectedN
     });
   }, [qtState.preferences.browser, qtState.connection_list, qtState.params]);
 
-
-  const onNewQueryToolClick = ()=>{
+  const onNewQueryToolClick = (event, fileName, storage)=>{
     const transId = commonUtils.getRandomInt(1, 9999999);
     let selectedConn = _.find(qtState.connection_list, (c)=>c.is_selected);
     let parentData = {
@@ -807,6 +817,8 @@ export default function QueryToolComponent({params, pgWindow, pgAdmin, selectedN
     showQueryTool.launchQueryTool(pgWindow.pgAdmin.Tools.SQLEditor, transId, gridUrl, title, {
       user: selectedConn.user,
       role: selectedConn.role,
+      fileName: fileName,
+      storage: storage
     });
   };
 
@@ -982,6 +994,8 @@ QueryToolComponent.propTypes = {
     server_name: PropTypes.string,
     database_name: PropTypes.string,
     layout: PropTypes.string,
+    fileName: PropTypes.string,
+    storage: PropTypes.string,
   }),
   pgWindow: PropTypes.object.isRequired,
   pgAdmin: PropTypes.object.isRequired,
diff --git a/web/pgadmin/tools/sqleditor/static/js/components/sections/MainToolBar.jsx b/web/pgadmin/tools/sqleditor/static/js/components/sections/MainToolBar.jsx
@@ -74,6 +74,7 @@ export function MainToolBar({containerRef, onFilterClick, onManageMacros, onAddT
   const [checkedMenuItems, setCheckedMenuItems] = React.useState({});
   /* Menu button refs */
   const saveAsMenuRef = React.useRef(null);
+  const openInNewTabMenuRef = React.useRef(null);
   const editMenuRef = React.useRef(null);
   const autoCommitMenuRef = React.useRef(null);
   const explainMenuRef = React.useRef(null);
@@ -138,9 +139,9 @@ export function MainToolBar({containerRef, onFilterClick, onManageMacros, onAddT
 
   const openFile = useCallback(()=>{
     confirmDiscard(()=>{
-      eventBus.fireEvent(QUERY_TOOL_EVENTS.TRIGGER_LOAD_FILE);
+      eventBus.fireEvent(QUERY_TOOL_EVENTS.TRIGGER_LOAD_FILE, Boolean(checkedMenuItems['open_in_new_tab']));
     }, true);
-  }, [buttonsDisabled['save']]);
+  }, [buttonsDisabled['save'], checkedMenuItems]);
 
   const saveFile = useCallback((saveAs=false)=>{
     eventBus.fireEvent(QUERY_TOOL_EVENTS.TRIGGER_SAVE_FILE, saveAs);
@@ -337,6 +338,7 @@ export function MainToolBar({containerRef, onFilterClick, onManageMacros, onAddT
           explain_summary: queryToolPref.explain_summary,
           explain_settings: queryToolPref.explain_settings,
           explain_wal: queryToolPref.explain_wal,
+          open_in_new_tab: queryToolPref.open_in_new_tab,
         });
       }
     }
@@ -501,6 +503,11 @@ export function MainToolBar({containerRef, onFilterClick, onManageMacros, onAddT
         <PgButtonGroup size="small">
           <PgIconButton title={gettext('Open File')} icon={<FolderRoundedIcon />} disabled={!queryToolCtx.params.is_query_tool}
             shortcut={queryToolPref.btn_open_file} onClick={openFile} />
+          <PgIconButton title={gettext('Open in a new tab')} icon={<KeyboardArrowDownIcon />} splitButton disabled={!queryToolCtx.params.is_query_tool}
+            name="menu-openfileintab" ref={openInNewTabMenuRef} onClick={toggleMenu}
+          />
+        </PgButtonGroup>
+        <PgButtonGroup size="small">
           <PgIconButton title={gettext('Save File')} icon={<SaveRoundedIcon />}
             shortcut={queryToolPref.btn_save_file} disabled={buttonsDisabled['save'] || !queryToolCtx.params.is_query_tool}
             onClick={()=>{saveFile(false);}} />
@@ -562,13 +569,22 @@ export function MainToolBar({containerRef, onFilterClick, onManageMacros, onAddT
           <PgIconButton title={gettext('Help')} icon={<HelpIcon />} onClick={onHelpClick} />
         </PgButtonGroup>
       </StyledBox>
+      <PgMenu
+        anchorRef={openInNewTabMenuRef}
+        open={openMenuName=='menu-openfileintab'}
+        onClose={onMenuClose}
+        label={gettext('Open file Menu')}
+      >
+        <PgMenuItem hasCheck value="open_in_new_tab" checked={checkedMenuItems['open_in_new_tab']}
+          onClick={checkMenuClick}>{gettext('Open in a new tab?')}</PgMenuItem>
+      </PgMenu>
       <PgMenu
         anchorRef={saveAsMenuRef}
         open={openMenuName=='menu-saveas'}
         onClose={onMenuClose}
-        label={gettext('File Menu')}
+        label={gettext('Save As')}
       >
-        <PgMenuItem onClick={()=>{saveFile(true);}}>{gettext('Save as')}</PgMenuItem>
+        <PgMenuItem onClick={()=>{saveFile(true);}}>{gettext('Save As')}</PgMenuItem>
       </PgMenu>
       <PgMenu
         anchorRef={editMenuRef}
diff --git a/web/pgadmin/tools/sqleditor/utils/query_tool_preferences.py b/web/pgadmin/tools/sqleditor/utils/query_tool_preferences.py
@@ -133,6 +133,16 @@ def register_query_tool_preferences(self):
         )
     )
 
+    self.open_file_in_new_tab = self.preference.register(
+        'Options', 'open_in_new_tab',
+        gettext("Open the file in a new tab?"), 'boolean',
+        True,
+        category_label=PREF_LABEL_OPTIONS,
+        help_str=gettext(
+            'Specifies whether or not to open file in a new tab.'
+        )
+    )
+
     self.view_edit_promotion_warning = self.preference.register(
         'Options', 'view_edit_promotion_warning',
         gettext("Show View/Edit Data Promotion Warning?"),
