pgadmin4/web/pgadmin/static/js/components/ReactCodeMirror/index.jsx

/////////////////////////////////////////////////////////////
//
// pgAdmin 4 - PostgreSQL Tools
//
// Copyright (C) 2013 - 2025, The pgAdmin Development Team
// This software is released under the PostgreSQL Licence
//
//////////////////////////////////////////////////////////////

import React, { useCallback, useMemo, useRef, useState, useEffect } from 'react';
import { styled } from '@mui/material/styles';
import FileCopyRoundedIcon from '@mui/icons-material/FileCopyRounded';
import CheckRoundedIcon from '@mui/icons-material/CheckRounded';
import PropTypes from 'prop-types';
import { startCompletion } from '@codemirror/autocomplete';
import { format } from 'sql-formatter';

import gettext from 'sources/gettext';
import { PgIconButton } from '../Buttons';
import { copyToClipboard } from '../../clipboard';
import { useDelayedCaller } from '../../custom_hooks';

import Editor from './components/Editor';
import CustomPropTypes from '../../custom_prop_types';
import FindDialog from './components/FindDialog';
import GotoDialog from './components/GotoDialog';
import usePreferences from '../../../../preferences/static/js/store';
import { parseKeyEventValue, parseShortcutValue } from '../../utils';

const Root = styled('div')(() => ({
  position: 'relative',
  height: '100%',
  '& .CodeMirror-copyButton': {
    position: 'absolute',
    zIndex: 99,
    right: '4px',
    top: '4px',
  }
}));


function CopyButton({ editor }) {

  const [isCopied, setIsCopied] = useState(false);
  const revertCopiedText = useDelayedCaller(() => {
    setIsCopied(false);
  });

  return (
    <PgIconButton size="small" className='CodeMirror-copyButton' icon={isCopied ? <CheckRoundedIcon /> : <FileCopyRoundedIcon />}
      title={isCopied ? gettext('Copied!') : gettext('Copy')}
      onClick={() => {
        copyToClipboard(editor?.getValue());
        setIsCopied(true);
        revertCopiedText(1500);
      }}
    />
  );
}

CopyButton.propTypes = {
  editor: PropTypes.object,
};


export default function CodeMirror({className, currEditor, showCopyBtn=false, customKeyMap=[], onTextSelect, ...props}) {
  const editor = useRef();
  const [[showFind, isReplace, findKey], setShowFind] = useState([false, false, false]);
  const [showGoto, setShowGoto] = useState(false);
  const [showCopy, setShowCopy] = useState(false);
  const preferences = usePreferences().getPreferencesForModule('sqleditor');
  const editorPrefs = usePreferences().getPreferencesForModule('editor');

  const formatSQL = (view)=>{
    let selection = true, sql = view.getSelection();
    /* New library does not support capitalize casing
      so if a user has set capitalize casing we will
      use preserve casing which is default for the library.
    */
    let formatPrefs = {
      language: 'postgresql',
      keywordCase: editorPrefs.keyword_case === 'capitalize' ? 'preserve' : editorPrefs.keyword_case,
      identifierCase: editorPrefs.identifier_case === 'capitalize' ? 'preserve' : editorPrefs.identifier_case,
      dataTypeCase: editorPrefs.data_type_case,
      functionCase: editorPrefs.function_case,
      logicalOperatorNewline: editorPrefs.logical_operator_new_line,
      expressionWidth: editorPrefs.expression_width,
      linesBetweenQueries: editorPrefs.lines_between_queries,
      tabWidth: editorPrefs.tab_size,
      useTabs: !editorPrefs.use_spaces,
      denseOperators: !editorPrefs.spaces_around_operators,
      newlineBeforeSemicolon: editorPrefs.new_line_before_semicolon
    };
    if(sql == '') {
      sql = view.getValue();
      selection = false;
    }
    let formattedSql = format(sql,formatPrefs);
    if(selection) {
      view.replaceSelection(formattedSql);
    } else {
      view.setValue(formattedSql);
    }
  };

  // We're not using CodeMirror keymap and using any instead
  // because on Mac, the alt key combination creates special
  // chars and https://github.com/codemirror/view/commit/3cea8dba19845fe75bea4eae756c6103694f49f3
  const customShortcuts = {
    [parseShortcutValue(editorPrefs.find, true)]: () => {
      setTimeout(()=>{
        setShowFind(prevVal => [true, false, !prevVal[2]]);
      }, 0);
    },
    [parseShortcutValue(editorPrefs.replace, true)]: () => {
      setTimeout(()=>{
        setShowFind(prevVal => [true, true, !prevVal[2]]);
      }, 0);
    },
    [parseShortcutValue(editorPrefs.goto_line_col, true)]: () => {
      setShowGoto(true);
    },
    [parseShortcutValue(editorPrefs.comment, true)]: () => {
      editor.current?.execCommand('toggleComment');
    },
    [parseShortcutValue(editorPrefs.format_sql, true)]: formatSQL,
    [parseShortcutValue(preferences.auto_complete, true)]: startCompletion,
  };

  const finalCustomKeyMap = useMemo(() => [
    {
      any: (view, e) => {
        const eventStr = parseKeyEventValue(e, true);
        const callback = customShortcuts[eventStr];
        if(callback) {
          e.preventDefault();
          e.stopPropagation();
          callback(view);
          return true;
        }
        return false;
      }
    },
    ...customKeyMap
  ], [customKeyMap]);

  const closeFind = () => {
    setShowFind([false, false, false]);
    editor.current?.focus();
  };

  const closeGoto = () => {
    setShowGoto(false);
    editor.current?.focus();
  };

  const currEditorWrap = useCallback((obj)=>{
    editor.current = obj;
    currEditor?.(obj);
  }, []);


  const onMouseEnter = useCallback(()=>{showCopyBtn && setShowCopy(true);}, []);
  const onMouseLeave = useCallback(()=>{showCopyBtn && setShowCopy(false);}, []);

  // Use to handle text selection events.
  useEffect(() => {
    if (!onTextSelect) return;

    const handleSelection = () => {
      const selectedText = editor.current?.getSelection();
      if (selectedText) {
        onTextSelect(selectedText);
      } else {
        onTextSelect(''); // Reset if no text is selected
      }
    };

    const handleKeyUp = () => {
      handleSelection();
    };
    // Add event listeners for mouseup and keyup events to detect text selection.
    document.addEventListener('mouseup', handleSelection);
    document.addEventListener('keyup', handleKeyUp);

    // Cleanup function to remove event listeners when component unmounts or onTextSelect changes.
    return () => {
      document.removeEventListener('mouseup', handleSelection);
      document.removeEventListener('keyup', handleKeyUp);
    };
  }, [onTextSelect]);


  return (
    <Root className={[className].join(' ')} onMouseEnter={onMouseEnter} onMouseLeave={onMouseLeave} >
      <Editor currEditor={currEditorWrap} customKeyMap={finalCustomKeyMap} {...props} />
      {showCopy && <CopyButton editor={editor.current} />}
      <FindDialog key={findKey} editor={editor.current} show={showFind} replace={isReplace} onClose={closeFind} />
      <GotoDialog editor={editor.current} show={showGoto} onClose={closeGoto} />
    </Root>
  );
}

CodeMirror.propTypes = {
  currEditor: PropTypes.func,
  className: CustomPropTypes.className,
  showCopyBtn: PropTypes.bool,
  customKeyMap: PropTypes.array,
  onTextSelect:PropTypes.func,
};