/* Copyright 2015, 2016 OpenMarket Ltd Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ import React from 'react'; import type SyntheticKeyboardEvent from 'react/lib/SyntheticKeyboardEvent'; import {Editor, EditorState, RichUtils, CompositeDecorator, convertFromRaw, convertToRaw, Modifier, EditorChangeType, getDefaultKeyBinding, KeyBindingUtil, ContentState, ContentBlock, SelectionState} from 'draft-js'; import classNames from 'classnames'; import escape from 'lodash/escape'; import Q from 'q'; import MatrixClientPeg from '../../../MatrixClientPeg'; import type {MatrixClient} from 'matrix-js-sdk/lib/matrix'; import SlashCommands from '../../../SlashCommands'; import KeyCode from '../../../KeyCode'; import Modal from '../../../Modal'; import sdk from '../../../index'; import { _t } from '../../../languageHandler'; import dis from '../../../dispatcher'; import UserSettingsStore from '../../../UserSettingsStore'; import * as RichText from '../../../RichText'; import * as HtmlUtils from '../../../HtmlUtils'; import Autocomplete from './Autocomplete'; import {Completion} from "../../../autocomplete/Autocompleter"; import Markdown from '../../../Markdown'; import ComposerHistoryManager from '../../../ComposerHistoryManager'; import {onSendMessageFailed} from './MessageComposerInputOld'; const TYPING_USER_TIMEOUT = 10000, TYPING_SERVER_TIMEOUT = 30000; const ZWS_CODE = 8203; const ZWS = String.fromCharCode(ZWS_CODE); // zero width space function stateToMarkdown(state) { return __stateToMarkdown(state) .replace( ZWS, // draft-js-export-markdown adds these ''); // this is *not* a zero width space, trust me :) } /* * The textInput part of the MessageComposer */ export default class MessageComposerInput extends React.Component { static propTypes = { tabComplete: React.PropTypes.any, // a callback which is called when the height of the composer is // changed due to a change in content. onResize: React.PropTypes.func, // js-sdk Room object room: React.PropTypes.object.isRequired, // called with current plaintext content (as a string) whenever it changes onContentChanged: React.PropTypes.func, onUpArrow: React.PropTypes.func, onDownArrow: React.PropTypes.func, // attempts to confirm currently selected completion, returns whether actually confirmed tryComplete: React.PropTypes.func, onInputStateChanged: React.PropTypes.func, }; static getKeyBinding(e: SyntheticKeyboardEvent): string { // C-m => Toggles between rich text and markdown modes if (e.keyCode === KeyCode.KEY_M && KeyBindingUtil.isCtrlKeyCommand(e)) { return 'toggle-mode'; } // Allow opening of dev tools. getDefaultKeyBinding would be 'italic' for KEY_I if (e.keyCode === KeyCode.KEY_I && e.shiftKey && e.ctrlKey) { // When null is returned, draft-js will NOT preventDefault, allowing dev tools // to be toggled when the editor is focussed return null; } return getDefaultKeyBinding(e); } static getBlockStyle(block: ContentBlock): ?string { if (block.getType() === 'strikethrough') { return 'mx_Markdown_STRIKETHROUGH'; } return null; } client: MatrixClient; autocomplete: Autocomplete; historyManager: ComposerHistoryManager; constructor(props, context) { super(props, context); this.onAction = this.onAction.bind(this); this.handleReturn = this.handleReturn.bind(this); this.handleKeyCommand = this.handleKeyCommand.bind(this); this.onEditorContentChanged = this.onEditorContentChanged.bind(this); this.onUpArrow = this.onUpArrow.bind(this); this.onDownArrow = this.onDownArrow.bind(this); this.onTab = this.onTab.bind(this); this.onEscape = this.onEscape.bind(this); this.setDisplayedCompletion = this.setDisplayedCompletion.bind(this); this.onMarkdownToggleClicked = this.onMarkdownToggleClicked.bind(this); this.onTextPasted = this.onTextPasted.bind(this); const isRichtextEnabled = UserSettingsStore.getSyncedSetting('MessageComposerInput.isRichTextEnabled', false); this.state = { // whether we're in rich text or markdown mode isRichtextEnabled, // the currently displayed editor state (note: this is always what is modified on input) editorState: null, // the original editor state, before we started tabbing through completions originalEditorState: null, // the virtual state "above" the history stack, the message currently being composed that // we want to persist whilst browsing history currentlyComposedEditorState: null, }; // bit of a hack, but we need to do this here since createEditorState needs isRichtextEnabled /* eslint react/no-direct-mutation-state:0 */ this.state.editorState = this.createEditorState(); this.client = MatrixClientPeg.get(); } /* * "Does the right thing" to create an EditorState, based on: * - whether we've got rich text mode enabled * - contentState was passed in */ createEditorState(richText: boolean, contentState: ?ContentState): EditorState { let decorators = richText ? RichText.getScopedRTDecorators(this.props) : RichText.getScopedMDDecorators(this.props), compositeDecorator = new CompositeDecorator(decorators); let editorState = null; if (contentState) { editorState = EditorState.createWithContent(contentState, compositeDecorator); } else { editorState = EditorState.createEmpty(compositeDecorator); } return EditorState.moveFocusToEnd(editorState); } componentDidMount() { this.dispatcherRef = dis.register(this.onAction); this.historyManager = new ComposerHistoryManager(this.props.room.roomId); } componentWillUnmount() { dis.unregister(this.dispatcherRef); } componentWillUpdate(nextProps, nextState) { // this is dirty, but moving all this state to MessageComposer is dirtier if (this.props.onInputStateChanged && nextState !== this.state) { const state = this.getSelectionInfo(nextState.editorState); state.isRichtextEnabled = nextState.isRichtextEnabled; this.props.onInputStateChanged(state); } } onAction = (payload) => { const editor = this.refs.editor; let contentState = this.state.editorState.getCurrentContent(); switch (payload.action) { case 'focus_composer': editor.focus(); break; // TODO change this so we insert a complete user alias case 'insert_displayname': { contentState = Modifier.replaceText( contentState, this.state.editorState.getSelection(), `${payload.displayname}: `, ); let editorState = EditorState.push(this.state.editorState, contentState, 'insert-characters'); editorState = EditorState.forceSelection(editorState, contentState.getSelectionAfter()); this.onEditorContentChanged(editorState); editor.focus(); } break; case 'quote': { let {body, formatted_body} = payload.event.getContent(); formatted_body = formatted_body || escape(body); if (formatted_body) { let content = RichText.htmlToContentState(`
${formatted_body}
`); if (!this.state.isRichtextEnabled) { content = ContentState.createFromText(RichText.stateToMarkdown(content)); } const blockMap = content.getBlockMap(); let startSelection = SelectionState.createEmpty(contentState.getFirstBlock().getKey()); contentState = Modifier.splitBlock(contentState, startSelection); startSelection = SelectionState.createEmpty(contentState.getFirstBlock().getKey()); contentState = Modifier.replaceWithFragment(contentState, startSelection, blockMap); startSelection = SelectionState.createEmpty(contentState.getFirstBlock().getKey()); if (this.state.isRichtextEnabled) { contentState = Modifier.setBlockType(contentState, startSelection, 'blockquote'); } let editorState = EditorState.push(this.state.editorState, contentState, 'insert-characters'); editorState = EditorState.moveSelectionToEnd(editorState); this.onEditorContentChanged(editorState); editor.focus(); } } break; } }; onTypingActivity() { this.isTyping = true; if (!this.userTypingTimer) { this.sendTyping(true); } this.startUserTypingTimer(); this.startServerTypingTimer(); } onFinishedTyping() { this.isTyping = false; this.sendTyping(false); this.stopUserTypingTimer(); this.stopServerTypingTimer(); } startUserTypingTimer() { this.stopUserTypingTimer(); const self = this; this.userTypingTimer = setTimeout(function() { self.isTyping = false; self.sendTyping(self.isTyping); self.userTypingTimer = null; }, TYPING_USER_TIMEOUT); } stopUserTypingTimer() { if (this.userTypingTimer) { clearTimeout(this.userTypingTimer); this.userTypingTimer = null; } } startServerTypingTimer() { if (!this.serverTypingTimer) { const self = this; this.serverTypingTimer = setTimeout(function() { if (self.isTyping) { self.sendTyping(self.isTyping); self.startServerTypingTimer(); } }, TYPING_SERVER_TIMEOUT / 2); } } stopServerTypingTimer() { if (this.serverTypingTimer) { clearTimeout(this.servrTypingTimer); this.serverTypingTimer = null; } } sendTyping(isTyping) { if (UserSettingsStore.getSyncedSetting('dontSendTypingNotifications', false)) return; MatrixClientPeg.get().sendTyping( this.props.room.roomId, this.isTyping, TYPING_SERVER_TIMEOUT, ).done(); } refreshTyping() { if (this.typingTimeout) { clearTimeout(this.typingTimeout); this.typingTimeout = null; } } // Called by Draft to change editor contents onEditorContentChanged = (editorState: EditorState) => { editorState = RichText.attachImmutableEntitiesToEmoji(editorState); /* Since a modification was made, set originalEditorState to null, since newState is now our original */ this.setState({ editorState, originalEditorState: null, }); }; /** * We're overriding setState here because it's the most convenient way to monitor changes to the editorState. * Doing it using a separate function that calls setState is a possibility (and was the old approach), but that * approach requires a callback and an extra setState whenever trying to set multiple state properties. * * @param state * @param callback */ setState(state, callback) { if (state.editorState != null) { state.editorState = RichText.attachImmutableEntitiesToEmoji( state.editorState); if (state.editorState.getCurrentContent().hasText()) { this.onTypingActivity(); } else { this.onFinishedTyping(); } if (!state.hasOwnProperty('originalEditorState')) { state.originalEditorState = null; } } super.setState(state, () => { if (callback != null) { callback(); } if (this.props.onContentChanged) { const textContent = this.state.editorState .getCurrentContent().getPlainText(); const selection = RichText.selectionStateToTextOffsets( this.state.editorState.getSelection(), this.state.editorState.getCurrentContent().getBlocksAsArray()); this.props.onContentChanged(textContent, selection); } }); } enableRichtext(enabled: boolean) { if (enabled === this.state.isRichtextEnabled) return; let contentState = null; if (enabled) { const md = new Markdown(this.state.editorState.getCurrentContent().getPlainText()); contentState = RichText.htmlToContentState(md.toHTML()); } else { let markdown = RichText.stateToMarkdown(this.state.editorState.getCurrentContent()); if (markdown[markdown.length - 1] === '\n') { markdown = markdown.substring(0, markdown.length - 1); // stateToMarkdown tacks on an extra newline (?!?) } contentState = ContentState.createFromText(markdown); } this.setState({ editorState: this.createEditorState(enabled, contentState), isRichtextEnabled: enabled, }); UserSettingsStore.setSyncedSetting('MessageComposerInput.isRichTextEnabled', enabled); } handleKeyCommand = (command: string): boolean => { if (command === 'toggle-mode') { this.enableRichtext(!this.state.isRichtextEnabled); return true; } let newState: ?EditorState = null; // Draft handles rich text mode commands by default but we need to do it ourselves for Markdown. if (this.state.isRichtextEnabled) { // These are block types, not handled by RichUtils by default. const blockCommands = ['code-block', 'blockquote', 'unordered-list-item', 'ordered-list-item']; if (blockCommands.includes(command)) { this.setState({ editorState: RichUtils.toggleBlockType(this.state.editorState, command), }); } else if (command === 'strike') { // this is the only inline style not handled by Draft by default this.setState({ editorState: RichUtils.toggleInlineStyle(this.state.editorState, 'STRIKETHROUGH'), }); } } else { let contentState = this.state.editorState.getCurrentContent(), selection = this.state.editorState.getSelection(); const modifyFn = { 'bold': (text) => `**${text}**`, 'italic': (text) => `*${text}*`, 'underline': (text) => `_${text}_`, // there's actually no valid underline in Markdown, but *shrug* 'strike': (text) => `${text}`, 'code-block': (text) => `\`\`\`\n${text}\n\`\`\``, 'blockquote': (text) => text.split('\n').map((line) => `> ${line}\n`).join(''), 'unordered-list-item': (text) => text.split('\n').map((line) => `\n- ${line}`).join(''), 'ordered-list-item': (text) => text.split('\n').map((line, i) => `\n${i + 1}. ${line}`).join(''), }[command]; if (modifyFn) { newState = EditorState.push( this.state.editorState, RichText.modifyText(contentState, selection, modifyFn), 'insert-characters', ); } } if (newState == null) { newState = RichUtils.handleKeyCommand(this.state.editorState, command); } if (newState != null) { this.setState({editorState: newState}); return true; } return false; } onTextPasted(text: string, html?: string) { const currentSelection = this.state.editorState.getSelection(); const currentContent = this.state.editorState.getCurrentContent(); let contentState = null; if (html) { contentState = Modifier.replaceWithFragment( currentContent, currentSelection, RichText.htmlToContentState(html).getBlockMap(), ); } else { contentState = Modifier.replaceText(currentContent, currentSelection, text); } let newEditorState = EditorState.push(this.state.editorState, contentState, 'insert-characters'); newEditorState = EditorState.forceSelection(newEditorState, contentState.getSelectionAfter()); this.onEditorContentChanged(newEditorState); return true; } handleReturn(ev) { if (ev.shiftKey) { this.onEditorContentChanged(RichUtils.insertSoftNewline(this.state.editorState)); return true; } const currentBlockType = RichUtils.getCurrentBlockType(this.state.editorState); // If we're in any of these three types of blocks, shift enter should insert soft newlines // And just enter should end the block if(['blockquote', 'unordered-list-item', 'ordered-list-item'].includes(currentBlockType)) { return false; } const contentState = this.state.editorState.getCurrentContent(); if (!contentState.hasText()) { return true; } let contentText = contentState.getPlainText(), contentHTML; const cmd = SlashCommands.processInput(this.props.room.roomId, contentText); if (cmd) { if (!cmd.error) { this.setState({ editorState: this.createEditorState(), }); } if (cmd.promise) { cmd.promise.then(function() { console.log("Command success."); }, function(err) { console.error("Command failure: %s", err); const ErrorDialog = sdk.getComponent("dialogs.ErrorDialog"); Modal.createDialog(ErrorDialog, { title: _t("Server error"), description: ((err && err.message) ? err.message : _t("Server unavailable, overloaded, or something else went wrong.")), }); }); } else if (cmd.error) { console.error(cmd.error); const ErrorDialog = sdk.getComponent("dialogs.ErrorDialog"); Modal.createDialog(ErrorDialog, { title: _t("Command error"), description: cmd.error, }); } return true; } if (this.state.isRichtextEnabled) { // We should only send HTML if any block is styled or contains inline style let shouldSendHTML = false; const blocks = contentState.getBlocksAsArray(); if (blocks.some((block) => block.getType() !== 'unstyled')) { shouldSendHTML = true; } else { const characterLists = blocks.map((block) => block.getCharacterList()); // For each block of characters, determine if any inline styles are applied // and if yes, send HTML characterLists.forEach((characters) => { const numberOfStylesForCharacters = characters.map( (character) => character.getStyle().toArray().length, ).toArray(); // If any character has more than 0 inline styles applied, send HTML if (numberOfStylesForCharacters.some((styles) => styles > 0)) { shouldSendHTML = true; } }); } if (shouldSendHTML) { contentHTML = HtmlUtils.processHtmlForSending( RichText.contentStateToHTML(contentState), ); } } else { const md = new Markdown(contentText); if (md.isPlainText()) { contentText = md.toPlaintext(); } else { contentHTML = md.toHTML(); } } let sendHtmlFn = this.client.sendHtmlMessage; let sendTextFn = this.client.sendTextMessage; if (contentText.startsWith('/me')) { contentText = contentText.substring(4); // bit of a hack, but the alternative would be quite complicated if (contentHTML) contentHTML = contentHTML.replace(/\/me ?/, ''); sendHtmlFn = this.client.sendHtmlEmote; sendTextFn = this.client.sendEmoteMessage; } if (this.state.isRichtextEnabled) { this.historyManager.addItem( contentHTML ? contentHTML : contentText, contentHTML ? 'html' : 'markdown', ); } else { // Always store MD input as input history this.historyManager.addItem(contentText, 'markdown'); } let sendMessagePromise; if (contentHTML) { sendMessagePromise = sendHtmlFn.call( this.client, this.props.room.roomId, contentText, contentHTML, ); } else { sendMessagePromise = sendTextFn.call(this.client, this.props.room.roomId, contentText); } sendMessagePromise.done((res) => { dis.dispatch({ action: 'message_sent', }); }, (e) => onSendMessageFailed(e, this.props.room)); this.setState({ editorState: this.createEditorState(), }); this.autocomplete.hide(); return true; } onUpArrow = (e) => { this.onVerticalArrow(e, true); }; onDownArrow = (e) => { this.onVerticalArrow(e, false); }; onVerticalArrow = (e, up) => { // Select history only if we are not currently auto-completing if (this.autocomplete.state.completionList.length === 0) { // Don't go back in history if we're in the middle of a multi-line message const selection = this.state.editorState.getSelection(); const blockKey = selection.getStartKey(); const firstBlock = this.state.editorState.getCurrentContent().getFirstBlock(); const lastBlock = this.state.editorState.getCurrentContent().getLastBlock(); const selectionOffset = selection.getAnchorOffset(); let canMoveUp = false; let canMoveDown = false; if (blockKey === firstBlock.getKey()) { const textBeforeCursor = firstBlock.getText().slice(0, selectionOffset); canMoveUp = textBeforeCursor.indexOf('\n') === -1; } if (blockKey === lastBlock.getKey()) { const textAfterCursor = lastBlock.getText().slice(selectionOffset); canMoveDown = textAfterCursor.indexOf('\n') === -1; } if ((up && !canMoveUp) || (!up && !canMoveDown)) return; const selected = this.selectHistory(up); if (selected) { // We're selecting history, so prevent the key event from doing anything else e.preventDefault(); } } else { this.moveAutocompleteSelection(up); } }; selectHistory = async (up) => { const delta = up ? -1 : 1; // True if we are not currently selecting history, but composing a message if (this.historyManager.currentIndex === this.historyManager.history.length) { // We can't go any further - there isn't any more history, so nop. if (!up) { return; } this.setState({ currentlyComposedEditorState: this.state.editorState, }); } else if (this.historyManager.currentIndex + delta === this.historyManager.history.length) { // True when we return to the message being composed currently this.setState({ editorState: this.state.currentlyComposedEditorState, }); this.historyManager.currentIndex = this.historyManager.history.length; return; } const newContent = this.historyManager.getItem(delta, this.state.isRichtextEnabled ? 'html' : 'markdown'); if (!newContent) return false; let editorState = EditorState.push( this.state.editorState, newContent, 'insert-characters', ); // Move selection to the end of the selected history let newSelection = SelectionState.createEmpty(newContent.getLastBlock().getKey()); newSelection = newSelection.merge({ focusOffset: newContent.getLastBlock().getLength(), anchorOffset: newContent.getLastBlock().getLength(), }); editorState = EditorState.forceSelection(editorState, newSelection); this.setState({editorState}); return true; }; onTab = async (e) => { e.preventDefault(); if (this.autocomplete.state.completionList.length === 0) { // Force completions to show for the text currently entered await this.autocomplete.forceComplete(); // Select the first item by moving "down" await this.moveAutocompleteSelection(false); } else { await this.moveAutocompleteSelection(e.shiftKey); } }; moveAutocompleteSelection = (up) => { const completion = up ? this.autocomplete.onUpArrow() : this.autocomplete.onDownArrow(); return this.setDisplayedCompletion(completion); }; onEscape = async (e) => { e.preventDefault(); if (this.autocomplete) { this.autocomplete.onEscape(e); } await this.setDisplayedCompletion(null); // restore originalEditorState }; /* If passed null, restores the original editor content from state.originalEditorState. * If passed a non-null displayedCompletion, modifies state.originalEditorState to compute new state.editorState. */ setDisplayedCompletion = async (displayedCompletion: ?Completion): boolean => { const activeEditorState = this.state.originalEditorState || this.state.editorState; if (displayedCompletion == null) { if (this.state.originalEditorState) { let editorState = this.state.originalEditorState; // This is a workaround from https://github.com/facebook/draft-js/issues/458 // Due to the way we swap editorStates, Draft does not rerender at times editorState = EditorState.forceSelection(editorState, editorState.getSelection()); this.setState({editorState}); } return false; } const {range = {}, completion = ''} = displayedCompletion; const contentState = Modifier.replaceText( activeEditorState.getCurrentContent(), RichText.textOffsetsToSelectionState(range, activeEditorState.getCurrentContent().getBlocksAsArray()), completion, ); let editorState = EditorState.push(activeEditorState, contentState, 'insert-characters'); editorState = EditorState.forceSelection(editorState, contentState.getSelectionAfter()); this.setState({editorState, originalEditorState: activeEditorState}); // for some reason, doing this right away does not update the editor :( // setTimeout(() => this.refs.editor.focus(), 50); return true; }; onFormatButtonClicked(name: "bold" | "italic" | "strike" | "code" | "underline" | "quote" | "bullet" | "numbullet", e) { e.preventDefault(); // don't steal focus from the editor! const command = { code: 'code-block', quote: 'blockquote', bullet: 'unordered-list-item', numbullet: 'ordered-list-item', }[name] || name; this.handleKeyCommand(command); } /* returns inline style and block type of current SelectionState so MessageComposer can render formatting buttons. */ getSelectionInfo(editorState: EditorState) { const styleName = { BOLD: 'bold', ITALIC: 'italic', STRIKETHROUGH: 'strike', UNDERLINE: 'underline', }; const originalStyle = editorState.getCurrentInlineStyle().toArray(); const style = originalStyle .map((style) => styleName[style] || null) .filter((styleName) => !!styleName); const blockName = { 'code-block': 'code', 'blockquote': 'quote', 'unordered-list-item': 'bullet', 'ordered-list-item': 'numbullet', }; const originalBlockType = editorState.getCurrentContent() .getBlockForKey(editorState.getSelection().getStartKey()) .getType(); const blockType = blockName[originalBlockType] || null; return { style, blockType, }; } onMarkdownToggleClicked = (e) => { e.preventDefault(); // don't steal focus from the editor! this.handleKeyCommand('toggle-mode'); }; render() { const activeEditorState = this.state.originalEditorState || this.state.editorState; // From https://github.com/facebook/draft-js/blob/master/examples/rich/rich.html#L92 // If the user changes block type before entering any text, we can // either style the placeholder or hide it. let hidePlaceholder = false; const contentState = activeEditorState.getCurrentContent(); if (!contentState.hasText()) { if (contentState.getBlockMap().first().getType() !== 'unstyled') { hidePlaceholder = true; } } const className = classNames('mx_MessageComposer_input', { mx_MessageComposer_input_empty: hidePlaceholder, }); const content = activeEditorState.getCurrentContent(); const contentText = content.getPlainText(); const selection = RichText.selectionStateToTextOffsets(activeEditorState.getSelection(), activeEditorState.getCurrentContent().getBlocksAsArray()); return (
this.autocomplete = e} onConfirm={this.setDisplayedCompletion} query={contentText} selection={selection}/>
); } } MessageComposerInput.propTypes = { tabComplete: React.PropTypes.any, // a callback which is called when the height of the composer is // changed due to a change in content. onResize: React.PropTypes.func, // js-sdk Room object room: React.PropTypes.object.isRequired, // called with current plaintext content (as a string) whenever it changes onContentChanged: React.PropTypes.func, onUpArrow: React.PropTypes.func, onDownArrow: React.PropTypes.func, onFilesPasted: React.PropTypes.func, // attempts to confirm currently selected completion, returns whether actually confirmed tryComplete: React.PropTypes.func, onInputStateChanged: React.PropTypes.func, };