import React, {PureComponent, PropTypes} from 'react'; import autobind from 'autobind-decorator'; import CodeMirror from 'codemirror'; import classnames from 'classnames'; import jq from 'jsonpath'; import vkBeautify from 'vkbeautify'; import {DOMParser} from 'xmldom'; import xpath from 'xpath'; import {showModal} from '../modals/index'; import FilterHelpModal from '../modals/filter-help-modal'; import * as misc from '../../../common/misc'; import {trackEvent} from '../../../analytics/index'; import {prettifyJson} from '../../../common/prettify'; import {DEBOUNCE_MILLIS} from '../../../common/constants'; import './base-imports'; import {getTagDefinitions} from '../../../templating/index'; const TAB_KEY = 9; const TAB_SIZE = 4; const BASE_CODEMIRROR_OPTIONS = { lineNumbers: true, placeholder: 'Start Typing...', foldGutter: true, height: 'auto', autoRefresh: 500, lineWrapping: true, scrollbarStyle: 'native', lint: true, matchBrackets: true, autoCloseBrackets: true, tabSize: TAB_SIZE, indentUnit: TAB_SIZE, hintOptions: null, dragDrop: true, viewportMargin: 30, // default 10 selectionPointer: 'default', styleActiveLine: true, indentWithTabs: true, showCursorWhenSelecting: false, cursorScrollMargin: 12, // NOTE: This is px keyMap: 'default', extraKeys: { 'Ctrl-Q': function (cm) { cm.foldCode(cm.getCursor()); } } }; @autobind class CodeEditor extends PureComponent { constructor (props) { super(props); this.state = { filter: props.filter || '' }; this._originalCode = ''; } componentWillUnmount () { if (this.codeMirror) { this.codeMirror.toTextArea(); } } componentDidUpdate () { this._codemirrorSetOptions(); } shouldComponentUpdate (nextProps) { // Update if any properties changed, except value. We ignore value. for (const key of Object.keys(nextProps)) { if (key === 'defaultValue') { continue; } if (this.props[key] !== nextProps[key]) { return true; } } return false; } selectAll () { if (this.codeMirror) { this.codeMirror.setSelection( {line: 0, ch: 0}, {line: this.codeMirror.lineCount(), ch: 0} ); } } focus () { if (this.codeMirror) { this.codeMirror.focus(); } } setCursor (ch, line = 0) { if (this.codeMirror) { if (!this.hasFocus()) { this.focus(); } this.codeMirror.setCursor({line, ch}); } } setSelection (chStart, chEnd, line = 0) { if (this.codeMirror) { this.codeMirror.setSelection( {line, ch: chStart}, {line, ch: chEnd} ); } } getSelectionStart () { const selections = this.codeMirror.listSelections(); if (selections.length) { return selections[0].anchor.ch; } else { return 0; } } getSelectionEnd () { const selections = this.codeMirror.listSelections(); if (selections.length) { return selections[0].head.ch; } else { return 0; } } focusEnd () { if (this.codeMirror) { if (!this.hasFocus()) { this.focus(); } const doc = this.codeMirror.getDoc(); doc.setCursor(doc.lineCount(), 0); } } hasFocus () { if (this.codeMirror) { return this.codeMirror.hasFocus(); } else { return false; } } setAttribute (name, value) { this.codeMirror.getTextArea().parentNode.setAttribute(name, value); } removeAttribute (name) { this.codeMirror.getTextArea().parentNode.removeAttribute(name); } getAttribute (name) { this.codeMirror.getTextArea().parentNode.getAttribute(name); } clearSelection () { // Never do this if dropdown is open if (this.codeMirror.isHintDropdownActive()) { return; } if (this.codeMirror) { this.codeMirror.setSelection( {line: -1, ch: -1}, {line: -1, ch: -1} ); } } getValue () { if (this.codeMirror) { return this.codeMirror.getValue(); } else { return ''; } } _handleInitTextarea (textarea) { if (!textarea) { // Not mounted return; } if (this.codeMirror) { // Already initialized return; } const {defaultValue, debounceMillis: ms} = this.props; this.codeMirror = CodeMirror.fromTextArea(textarea, BASE_CODEMIRROR_OPTIONS); // Set default listeners const debounceMillis = typeof ms === 'number' ? ms : DEBOUNCE_MILLIS; this.codeMirror.on('changes', misc.debounce(this._codemirrorValueChanged, debounceMillis)); this.codeMirror.on('beforeChange', this._codemirrorValueBeforeChange); this.codeMirror.on('keydown', this._codemirrorKeyDown); this.codeMirror.on('focus', this._codemirrorFocus); this.codeMirror.on('blur', this._codemirrorBlur); this.codeMirror.on('paste', this._codemirrorPaste); this.codeMirror.setCursor({line: -1, ch: -1}); if (!this.codeMirror.getOption('indentWithTabs')) { this.codeMirror.setOption('extraKeys', { Tab: cm => { const spaces = (new Array(this.codeMirror.getOption('indentUnit') + 1)).join(' '); cm.replaceSelection(spaces); } }); } // Set editor options this._codemirrorSetOptions(); const setup = () => { // Actually set the value this._codemirrorSetValue(defaultValue || ''); // Setup nunjucks listeners if (this.props.render) { this.codeMirror.enableNunjucksTags(this.props.render); } // Make URLs clickable if (this.props.onClickLink) { this.codeMirror.makeLinksClickable(this.props.onClickLink); } // HACK: Refresh because sometimes it renders too early and the scroll doesn't // quite fit. setTimeout(() => { this.codeMirror.refresh(); }, 100); }; // Do this a bit later for big values so we don't block the render process if (defaultValue && defaultValue.length > 10000) { setTimeout(setup, 100); } else { setup(); } } _isJSON (mode) { if (!mode) { return false; } return mode.indexOf('json') !== -1; } _isXML (mode) { if (!mode) { return false; } return mode.indexOf('xml') !== -1; } _handleBeautify () { trackEvent('Request', 'Beautify'); this._prettify(this.codeMirror.getValue()); } _prettify (code) { this._codemirrorSetValue(code, true); } _prettifyJSON (code) { try { let jsonString = code; if (this.props.updateFilter && this.state.filter) { let obj = JSON.parse(code); try { jsonString = JSON.stringify(jq.query(obj, this.state.filter)); } catch (err) { jsonString = '[]'; } } return prettifyJson(jsonString, '\t'); } catch (e) { // That's Ok, just leave it return code; } } _prettifyXML (code) { if (this.props.updateFilter && this.state.filter) { try { const dom = new DOMParser().parseFromString(code); const nodes = xpath.select(this.state.filter, dom); const inner = nodes.map(n => n.toString()).join('\n'); code = `${inner}`; } catch (e) { // Failed to parse filter (that's ok) code = ``; } } try { return vkBeautify.xml(code, '\t'); } catch (e) { // Failed to parse so just return original return code; } } /** * Sets options on the CodeMirror editor while also sanitizing them */ _codemirrorSetOptions () { const { mode: rawMode, readOnly, hideLineNumbers, keyMap, lineWrapping, getRenderContext, getAutocompleteConstants, hideGutters, tabIndex, placeholder, noMatchBrackets, noDragDrop, hideScrollbars, noStyleActiveLine, noLint, indentSize } = this.props; let mode; if (this.props.render) { mode = {name: 'nunjucks', baseMode: this._normalizeMode(rawMode)}; } else { // foo bar baz mode = this._normalizeMode(rawMode); } let options = { readOnly: !!readOnly, placeholder: placeholder || '', mode: mode, tabIndex: typeof tabIndex === 'number' ? tabIndex : null, dragDrop: !noDragDrop, scrollbarStyle: hideScrollbars ? 'null' : 'native', styleActiveLine: !noStyleActiveLine, lineNumbers: !hideGutters && !hideLineNumbers, foldGutter: !hideGutters && !hideLineNumbers, lineWrapping: lineWrapping, matchBrackets: !noMatchBrackets, lint: !noLint && !readOnly, gutters: [] }; // Only set keyMap if we're not read-only. This is so things like // ctrl-a work on read-only mode. if (!readOnly && keyMap) { options.keyMap = keyMap; } if (indentSize) { options.tabSize = indentSize; options.indentUnit = indentSize; } if (!hideGutters && options.lineNumbers) { options.gutters.push('CodeMirror-linenumbers'); } if (!hideGutters && options.foldGutter) { options.gutters.push('CodeMirror-foldgutter'); } if (!hideGutters && options.lint) { options.gutters.push('CodeMirror-lint-markers'); } // Setup the hint options if (getRenderContext || getAutocompleteConstants) { let getVariables = null; let getTags = null; if (getRenderContext) { getVariables = async () => { const context = await getRenderContext(); const variables = context ? context.keys : []; return variables || []; }; // Only allow tags if we have variables too getTags = getTagDefinitions; } options.environmentAutocomplete = { getVariables, getTags, getConstants: getAutocompleteConstants }; } // Strip of charset if there is one const cm = this.codeMirror; Object.keys(options).map(key => { // Don't set the option if it hasn't changed if (options[key] === cm.options[key]) { return; } cm.setOption(key, options[key]); }); } _normalizeMode (mode) { const mimeType = mode ? mode.split(';')[0] : 'text/plain'; if (this._isJSON(mimeType)) { return 'application/json'; } else if (this._isXML(mimeType)) { return 'application/xml'; } else { return mimeType; } } async _codemirrorKeyDown (doc, e) { // Use default tab behaviour if we're told if (this.props.defaultTabBehavior && e.keyCode === TAB_KEY) { e.codemirrorIgnore = true; } if (this.props.onKeyDown && !doc.isHintDropdownActive()) { this.props.onKeyDown(e, doc.getValue()); } } _codemirrorFocus (doc, e) { if (this.props.onFocus) { this.props.onFocus(e); } } _codemirrorBlur (doc, e) { if (this.props.onBlur) { this.props.onBlur(e); } } _codemirrorValueBeforeChange (doc, change) { // If we're in single-line mode, merge all changed lines into one if (this.props.singleLine && change.text && change.text.length > 1) { const text = change.text .join('') // join all changed lines into one .replace(/\n/g, ' '); // Convert all whitespace to spaces change.update(change.from, change.to, [text]); } } _codemirrorPaste (cm, e) { if (this.props.onPaste) { this.props.onPaste(e); } } /** * Wrapper function to add extra behaviour to our onChange event */ _codemirrorValueChanged () { // Don't trigger change event if we're ignoring changes if (this._ignoreNextChange || !this.props.onChange) { this._ignoreNextChange = false; return; } const value = this.codeMirror.getDoc().getValue(); this.props.onChange(value); } /** * Sets the CodeMirror value without triggering the onChange event * @param code the code to set in the editor * @param forcePrettify */ _codemirrorSetValue (code, forcePrettify = false) { this._originalCode = code; // Don't ignore changes from prettify if (!forcePrettify) { this._ignoreNextChange = true; } const shouldPrettify = forcePrettify || this.props.autoPrettify; if (shouldPrettify && this._canPrettify()) { if (this._isXML(this.props.mode)) { code = this._prettifyXML(code); } else { code = this._prettifyJSON(code); } } this.codeMirror.setValue(code || ''); } _handleFilterChange (e) { const filter = e.target.value; clearTimeout(this._filterTimeout); this._filterTimeout = setTimeout(() => { this.setState({filter}); this._codemirrorSetValue(this._originalCode); if (this.props.updateFilter) { this.props.updateFilter(filter); } }, 200); // So we don't track on every keystroke, give analytics a longer timeout clearTimeout(this._analyticsTimeout); const json = this._isJSON(this.props.mode); this._analyticsTimeout = setTimeout(() => { trackEvent( 'Response', `Filter ${json ? 'JSONPath' : 'XPath'}`, `${filter ? 'Change' : 'Clear'}` ); }, 2000); } _canPrettify () { const {mode} = this.props; return this._isJSON(mode) || this._isXML(mode); } _showFilterHelp () { const isJson = this._isJSON(this.props.mode); showModal(FilterHelpModal, isJson); trackEvent('Response', `Filter ${isJson ? 'JSONPath' : 'XPath'}`, 'Help'); } render () { const { id, readOnly, fontSize, mode, filter, onMouseLeave, onClick, style } = this.props; const classes = classnames(this.props.className, { 'editor': true, 'editor--readonly': readOnly }); const toolbarChildren = []; if (this.props.updateFilter && (this._isJSON(mode) || this._isXML(mode))) { toolbarChildren.push( ); toolbarChildren.push( ); } if (this.props.manualPrettify && this._canPrettify()) { let contentTypeName = ''; if (this._isJSON(mode)) { contentTypeName = 'JSON'; } else if (this._isXML(mode)) { contentTypeName = 'XML'; } toolbarChildren.push( ); } let toolbar = null; if (toolbarChildren.length) { toolbar =
{toolbarChildren}
; } const styles = {}; if (fontSize) { styles.fontSize = `${fontSize}px`; } return (