element-web-Github/src/components/views/rooms/MessageComposerInput.js

1631 lines
66 KiB
JavaScript
Raw Normal View History

/*
Copyright 2015, 2016 OpenMarket Ltd
2018-07-10 00:50:07 +08:00
Copyright 2017, 2018 New Vector 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.
*/
2016-06-11 18:22:08 +08:00
import React from 'react';
import PropTypes from 'prop-types';
import { Editor } from 'slate-react';
2018-05-20 05:05:31 +08:00
import { getEventTransfer } from 'slate-react';
import { Value, Block, Inline, Range } from 'slate';
import type { Change } from 'slate';
import Html from 'slate-html-serializer';
2018-05-17 09:13:17 +08:00
import Md from 'slate-md-serializer';
import Plain from 'slate-plain-serializer';
2018-05-13 03:04:58 +08:00
import PlainWithPillsSerializer from "../../../autocomplete/PlainWithPillsSerializer";
2016-06-11 18:22:08 +08:00
import classNames from 'classnames';
2016-05-27 12:45:55 +08:00
import MatrixClientPeg from '../../../MatrixClientPeg';
import type {MatrixClient} from 'matrix-js-sdk/lib/matrix';
import {processCommandInput} from '../../../SlashCommands';
import { KeyCode, isOnlyCtrlOrCmdKeyEvent } from '../../../Keyboard';
import Modal from '../../../Modal';
import sdk from '../../../index';
import { _t } from '../../../languageHandler';
import Analytics from '../../../Analytics';
import dis from '../../../dispatcher';
import * as RichText from '../../../RichText';
import * as HtmlUtils from '../../../HtmlUtils';
import Autocomplete from './Autocomplete';
import {Completion} from "../../../autocomplete/Autocompleter";
import Markdown from '../../../Markdown';
2017-03-10 23:04:31 +08:00
import ComposerHistoryManager from '../../../ComposerHistoryManager';
import MessageComposerStore from '../../../stores/MessageComposerStore';
import ContentMessages from '../../../ContentMessages';
import {MATRIXTO_URL_PATTERN} from '../../../linkify-matrix';
import {
asciiRegexp, unicodeRegexp, shortnameToUnicode,
asciiList, mapUnicodeToShort, toShort,
} from 'emojione';
import SettingsStore, {SettingLevel} from "../../../settings/SettingsStore";
import {makeUserPermalink} from "../../../matrix-to";
import ReplyPreview from "./ReplyPreview";
import RoomViewStore from '../../../stores/RoomViewStore';
import ReplyThread from "../elements/ReplyThread";
import {ContentHelpers} from 'matrix-js-sdk';
import AccessibleButton from '../elements/AccessibleButton';
const EMOJI_UNICODE_TO_SHORTNAME = mapUnicodeToShort();
const REGEX_EMOJI_WHITESPACE = new RegExp('(?:^|\\s)(' + asciiRegexp + ')\\s$');
const EMOJI_REGEX = new RegExp(unicodeRegexp, 'g');
const TYPING_USER_TIMEOUT = 10000; const TYPING_SERVER_TIMEOUT = 30000;
2016-06-11 18:22:08 +08:00
// the Slate node type to default to for unstyled text
2018-05-20 03:38:07 +08:00
const DEFAULT_NODE = 'paragraph';
2018-05-20 06:33:07 +08:00
// map HTML elements through to our Slate schema node types
// used for the HTML deserializer.
// (The names here are chosen to match the MD serializer's schema for convenience)
2018-05-20 06:33:07 +08:00
const BLOCK_TAGS = {
p: 'paragraph',
blockquote: 'block-quote',
ul: 'bulleted-list',
h1: 'heading1',
h2: 'heading2',
h3: 'heading3',
h4: 'heading4',
h5: 'heading5',
h6: 'heading6',
2018-05-20 06:33:07 +08:00
li: 'list-item',
ol: 'numbered-list',
pre: 'code',
2018-05-20 06:33:07 +08:00
};
const MARK_TAGS = {
strong: 'bold',
b: 'bold', // deprecated
em: 'italic',
i: 'italic', // deprecated
code: 'code',
u: 'underlined',
del: 'deleted',
strike: 'deleted', // deprecated
s: 'deleted', // deprecated
2018-05-20 06:33:07 +08:00
};
2016-06-14 21:44:09 +08:00
const SLATE_SCHEMA = {
inlines: {
pill: {
isVoid: true,
},
emoji: {
isVoid: true,
},
},
};
function onSendMessageFailed(err, room) {
// XXX: temporary logging to try to diagnose
// https://github.com/vector-im/riot-web/issues/3148
console.log('MessageComposer got send failure: ' + err.name + '('+err+')');
dis.dispatch({
action: 'message_send_failed',
});
}
function rangeEquals(a: Range, b: Range): boolean {
return (a.anchor.key === b.anchor.key
&& a.anchor.offset === b.anchorOffset
&& a.focus.key === b.focusKey
&& a.focus.offset === b.focusOffset
&& a.isFocused === b.isFocused
&& a.isBackward === b.isBackward);
}
/*
* The textInput part of the MessageComposer
*/
export default class MessageComposerInput extends React.Component {
static propTypes = {
// js-sdk Room object
room: PropTypes.object.isRequired,
onInputStateChanged: PropTypes.func,
};
client: MatrixClient;
autocomplete: Autocomplete;
2017-03-10 23:04:31 +08:00
historyManager: ComposerHistoryManager;
2016-05-27 12:45:55 +08:00
constructor(props, context) {
super(props, context);
const isRichTextEnabled = SettingsStore.getValue('MessageComposerInput.isRichTextEnabled');
Analytics.setRichtextMode(isRichTextEnabled);
2016-06-12 02:41:27 +08:00
this.client = MatrixClientPeg.get();
2018-05-13 03:04:58 +08:00
// track whether we should be trying to show autocomplete suggestions on the current editor
// contents. currently it's only suppressed when navigating history to avoid ugly flashes
// of unexpected corrections as you navigate.
// XXX: should this be in state?
this.suppressAutoComplete = false;
// track whether we've just pressed an arrowkey left or right in order to skip void nodes.
// see https://github.com/ianstormtaylor/slate/issues/762#issuecomment-304855095
this.direction = '';
this.plainWithMdPills = new PlainWithPillsSerializer({ pillFormat: 'md' });
this.plainWithIdPills = new PlainWithPillsSerializer({ pillFormat: 'id' });
2018-05-13 03:04:58 +08:00
this.plainWithPlainPills = new PlainWithPillsSerializer({ pillFormat: 'plain' });
2018-05-20 10:17:51 +08:00
this.md = new Md({
rules: [
{
// if serialize returns undefined it falls through to the default hardcoded
// serialization rules
2018-05-20 10:17:51 +08:00
serialize: (obj, children) => {
if (obj.object !== 'inline') return;
switch (obj.type) {
case 'pill':
return `[${ obj.data.get('completion') }](${ obj.data.get('href') })`;
case 'emoji':
return obj.data.get('emojiUnicode');
2018-05-20 10:17:51 +08:00
}
},
}, {
serialize: (obj, children) => {
if (obj.object !== 'mark') return;
// XXX: slate-md-serializer consumes marks other than bold, italic, code, inserted, deleted
switch (obj.type) {
case 'underlined':
return `<u>${ children }</u>`;
case 'deleted':
return `<del>${ children }</del>`;
case 'code':
// XXX: we only ever get given `code` regardless of whether it was inline or block
// XXX: workaround for https://github.com/tommoor/slate-md-serializer/issues/14
// strip single backslashes from children, as they would have been escaped here
return `\`${ children.split('\\').map((v) => v ? v : '\\').join('') }\``;
}
},
},
],
2018-05-20 10:17:51 +08:00
});
this.html = new Html({
2018-05-20 03:28:38 +08:00
rules: [
{
2018-05-20 06:33:07 +08:00
deserialize: (el, next) => {
const tag = el.tagName.toLowerCase();
let type = BLOCK_TAGS[tag];
if (type) {
return {
object: 'block',
type: type,
nodes: next(el.childNodes),
};
2018-05-20 06:33:07 +08:00
}
type = MARK_TAGS[tag];
if (type) {
return {
object: 'mark',
type: type,
nodes: next(el.childNodes),
};
2018-05-20 06:33:07 +08:00
}
2018-05-20 07:49:29 +08:00
// special case links
if (tag === 'a') {
const href = el.getAttribute('href');
let m;
if (href) {
m = href.match(MATRIXTO_URL_PATTERN);
}
2018-05-20 07:49:29 +08:00
if (m) {
return {
object: 'inline',
type: 'pill',
data: {
2018-05-20 07:49:29 +08:00
href,
completion: el.innerText,
completionId: m[1],
},
};
} else {
2018-05-20 07:49:29 +08:00
return {
object: 'inline',
type: 'link',
data: { href },
nodes: next(el.childNodes),
};
2018-05-20 07:49:29 +08:00
}
}
2018-05-20 06:33:07 +08:00
},
2018-05-20 03:28:38 +08:00
serialize: (obj, children) => {
if (obj.object === 'block') {
2018-05-20 03:28:38 +08:00
return this.renderNode({
node: obj,
2018-05-20 03:38:07 +08:00
children: children,
2018-05-20 03:28:38 +08:00
});
} else if (obj.object === 'mark') {
2018-05-20 03:28:38 +08:00
return this.renderMark({
mark: obj,
2018-05-20 03:38:07 +08:00
children: children,
2018-05-20 03:28:38 +08:00
});
} else if (obj.object === 'inline') {
// special case links, pills and emoji otherwise we
// end up with React components getting rendered out(!)
switch (obj.type) {
case 'pill':
return <a href={ obj.data.get('href') }>{ obj.data.get('completion') }</a>;
case 'link':
return <a href={ obj.data.get('href') }>{ children }</a>;
case 'emoji':
// XXX: apparently you can't return plain strings from serializer rules
// until https://github.com/ianstormtaylor/slate/pull/1854 is merged.
// So instead we temporarily wrap emoji from RTE in an arbitrary tag
// (<b/>). <span/> would be nicer, but in practice it causes CSS issues.
return <b>{ obj.data.get('emojiUnicode') }</b>;
}
return this.renderNode({
node: obj,
children: children,
});
}
},
},
],
2018-05-20 03:28:38 +08:00
});
const savedState = MessageComposerStore.getEditorState(this.props.room.roomId);
2016-05-27 12:45:55 +08:00
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: this.createEditorState(
isRichTextEnabled,
savedState ? savedState.editor_state : undefined,
savedState ? savedState.rich_text : undefined,
),
// 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,
// whether there were any completions
someCompletions: null,
2016-05-27 12:45:55 +08:00
};
}
/*
* "Does the right thing" to create an Editor value, based on:
2016-06-11 18:22:08 +08:00
* - whether we've got rich text mode enabled
* - contentState was passed in
* - whether the contentState that was passed in was rich text
2016-06-11 18:22:08 +08:00
*/
createEditorState(wantRichText: boolean, editorState: ?Value, wasRichText: ?boolean): Value {
2018-05-17 09:13:17 +08:00
if (editorState instanceof Value) {
if (wantRichText && !wasRichText) {
return this.mdToRichEditorState(editorState);
}
if (wasRichText && !wantRichText) {
return this.richToMdEditorState(editorState);
}
2018-05-17 09:13:17 +08:00
return editorState;
} else {
// ...or create a new one. and explicitly focus it otherwise tab in-out issues
const base = Plain.deserialize('', { defaultBlock: DEFAULT_NODE });
return base.change().focus().value;
}
2016-05-27 12:45:55 +08:00
}
componentWillMount() {
this.dispatcherRef = dis.register(this.onAction);
this.historyManager = new ComposerHistoryManager(this.props.room.roomId, 'mx_slate_composer_history_');
2016-05-27 12:45:55 +08:00
}
2016-05-27 12:45:55 +08:00
componentWillUnmount() {
dis.unregister(this.dispatcherRef);
2016-05-27 12:45:55 +08:00
}
_collectEditor = (e) => {
this._editor = e;
}
onAction = (payload) => {
const editorState = this.state.editorState;
2016-06-11 18:22:08 +08:00
switch (payload.action) {
case 'reply_to_event':
case 'focus_composer':
this.focusComposer();
break;
2018-05-14 05:41:39 +08:00
case 'insert_mention':
{
// Pretend that we've autocompleted this user because keeping two code
// paths for inserting a user pill is not fun
const selection = this.getSelectionRange(this.state.editorState);
const member = this.props.room.getMember(payload.user_id);
const completion = member ?
member.rawDisplayName : payload.user_id;
2018-05-14 05:41:39 +08:00
this.setDisplayedCompletion({
completion,
completionId: payload.user_id,
selection,
href: makeUserPermalink(payload.user_id),
suffix: (selection.beginning && selection.start === 0) ? ': ' : ' ',
});
}
break;
2018-05-21 10:48:59 +08:00
case 'quote': {
const html = HtmlUtils.bodyToHtml(payload.event.getContent(), null, {
forComposerQuote: true,
2018-05-21 10:48:59 +08:00
returnString: true,
emojiOne: false,
});
const fragment = this.html.deserialize(html);
// FIXME: do we want to put in a permalink to the original quote here?
// If so, what should be the format, and how do we differentiate it from replies?
const quote = Block.create('block-quote');
if (this.state.isRichTextEnabled) {
2018-05-21 10:48:59 +08:00
let change = editorState.change();
const anchorText = editorState.anchorText;
if ((!anchorText || anchorText.text === '') && editorState.anchorBlock.nodes.size === 1) {
2018-05-21 10:48:59 +08:00
// replace the current block rather than split the block
// XXX: this destroys our focus by deleting the thing we are anchored/focused on
2018-05-21 10:48:59 +08:00
change = change.replaceNodeByKey(editorState.anchorBlock.key, quote);
} else {
2018-05-21 10:48:59 +08:00
// insert it into the middle of the block (splitting it)
change = change.insertBlock(quote);
}
// XXX: heuristic to strip out wrapping <p> which breaks quoting in RT mode
if (fragment.document.nodes.size && fragment.document.nodes.get(0).type === DEFAULT_NODE) {
change = change.insertFragmentByKey(quote.key, 0, fragment.document.nodes.get(0));
} else {
change = change.insertFragmentByKey(quote.key, 0, fragment.document);
}
// XXX: this is to bring back the focus in a sane place and add a paragraph after it
change = change.select(Range.create({
anchor: {
key: quote.key,
},
focus: {
key: quote.key,
},
2018-10-11 17:47:36 +08:00
})).moveToEndOfBlock().insertBlock(Block.create(DEFAULT_NODE)).focus();
2018-05-21 10:48:59 +08:00
this.onChange(change);
} else {
const fragmentChange = fragment.change();
fragmentChange.moveToRangeOfNode(fragment.document)
2018-05-21 10:48:59 +08:00
.wrapBlock(quote);
// FIXME: handle pills and use commonmark rather than md-serialize
const md = this.md.serialize(fragmentChange.value);
const change = editorState.change()
2018-05-21 10:48:59 +08:00
.insertText(md + '\n\n')
.focus();
this.onChange(change);
}
}
break;
}
};
2016-05-27 12:45:55 +08:00
onTypingActivity() {
this.isTyping = true;
if (!this.userTypingTimer) {
this.sendTyping(true);
}
this.startUserTypingTimer();
this.startServerTypingTimer();
2016-05-27 12:45:55 +08:00
}
2016-05-27 12:45:55 +08:00
onFinishedTyping() {
this.isTyping = false;
this.sendTyping(false);
this.stopUserTypingTimer();
this.stopServerTypingTimer();
2016-05-27 12:45:55 +08:00
}
2016-05-27 12:45:55 +08:00
startUserTypingTimer() {
this.stopUserTypingTimer();
const self = this;
this.userTypingTimer = setTimeout(function() {
self.isTyping = false;
self.sendTyping(self.isTyping);
self.userTypingTimer = null;
}, TYPING_USER_TIMEOUT);
2016-05-27 12:45:55 +08:00
}
2016-05-27 12:45:55 +08:00
stopUserTypingTimer() {
if (this.userTypingTimer) {
clearTimeout(this.userTypingTimer);
this.userTypingTimer = null;
}
2016-05-27 12:45:55 +08:00
}
2016-05-27 12:45:55 +08:00
startServerTypingTimer() {
if (!this.serverTypingTimer) {
const self = this;
this.serverTypingTimer = setTimeout(function() {
if (self.isTyping) {
self.sendTyping(self.isTyping);
self.startServerTypingTimer();
}
}, TYPING_SERVER_TIMEOUT / 2);
}
2016-05-27 12:45:55 +08:00
}
2016-05-27 12:45:55 +08:00
stopServerTypingTimer() {
if (this.serverTypingTimer) {
clearTimeout(this.serverTypingTimer);
this.serverTypingTimer = null;
}
2016-05-27 12:45:55 +08:00
}
2016-05-27 12:45:55 +08:00
sendTyping(isTyping) {
Be more positive with setting labels Fixes https://github.com/vector-im/riot-web/issues/6435 This is done through an on-the-fly inverter for the settings. All the settings changed are boolean values, so this should be more than safe to just let happen throughout the SettingsStore. Typically a change like this would be done in the individual handlers (similar to how setting names are remapped to different properties or even different storage locations on the fly), however doing that for this many settings would be a huge nightmare and involve changing *all* the layers. By putting a global "invert this" flag on the setting, we can get away with doing the inversion as the last possible step during a read (or write). To speed up calculations of the default values, we cache all the inverted values into a lookup table similar to how we represent the defaults already. Without this, the DefaultHandler would need to iterate the setting list and invert the values, slowing things down over time. We invert the value up front so we can keep the generic inversion logic without checking the level ahead of time. It is fully intended that a default value represents the new setting name, not the legacy name. This commit also includes a debugger for settings because it was hard to visualize what the SettingsStore was doing during development. Some added information is included as it may be helpful for when someone has a problem with their settings and we need to debug it. Typically the debugger would be run in conjunction with `mxSendRageshake`: `mxSettingsStore.debugSetting('showJoinLeaves') && mxSendRageshake('Debugging showJoinLeaves setting')`.
2019-01-25 11:57:40 +08:00
if (!SettingsStore.getValue('sendTypingNotifications')) return;
MatrixClientPeg.get().sendTyping(
this.props.room.roomId,
this.isTyping, TYPING_SERVER_TIMEOUT,
).done();
2016-05-27 12:45:55 +08:00
}
2016-05-27 12:45:55 +08:00
refreshTyping() {
if (this.typingTimeout) {
clearTimeout(this.typingTimeout);
this.typingTimeout = null;
}
2016-05-27 12:45:55 +08:00
}
onChange = (change: Change, originalEditorState?: Value) => {
2018-05-13 07:40:54 +08:00
let editorState = change.value;
if (this.direction !== '') {
const focusedNode = editorState.focusInline || editorState.focusText;
if (editorState.schema.isVoid(focusedNode)) {
// XXX: does this work in RTL?
const edge = this.direction === 'Previous' ? 'End' : 'Start';
if (editorState.selection.isCollapsed) {
change = change[`moveTo${ edge }Of${ this.direction }Text`]();
} else {
const block = this.direction === 'Previous' ? editorState.previousText : editorState.nextText;
if (block) {
change = change[`moveFocusTo${ edge }OfNode`](block);
}
}
2018-05-13 07:40:54 +08:00
editorState = change.value;
}
}
// when in autocomplete mode and selection changes hide the autocomplete.
// Selection changes when we enter text so use a heuristic to compare documents without doing it recursively
if (this.autocomplete.state.completionList.length > 0 && !this.autocomplete.state.hide &&
!rangeEquals(this.state.editorState.selection, editorState.selection) &&
// XXX: the heuristic failed when inlines like pills weren't taken into account. This is inideal
this.state.editorState.document.toJSON() === editorState.document.toJSON()) {
this.autocomplete.hide();
}
if (Plain.serialize(editorState) !== '') {
this.onTypingActivity();
} else {
this.onFinishedTyping();
}
2018-05-23 07:52:00 +08:00
if (editorState.startText !== null) {
const text = editorState.startText.text;
const currentStartOffset = editorState.selection.start.offset;
2018-05-23 07:52:00 +08:00
// Automatic replacement of plaintext emoji to Unicode emoji
if (SettingsStore.getValue('MessageComposerInput.autoReplaceEmoji')) {
// The first matched group includes just the matched plaintext emoji
const emojiMatch = REGEX_EMOJI_WHITESPACE.exec(text.slice(0, currentStartOffset));
if (emojiMatch) {
// plaintext -> hex unicode
const emojiUc = asciiList[emojiMatch[1]];
// hex unicode -> shortname -> actual unicode
const unicodeEmoji = shortnameToUnicode(EMOJI_UNICODE_TO_SHORTNAME[emojiUc]);
const range = Range.create({
anchor: {
key: editorState.startText.key,
offset: currentStartOffset - emojiMatch[1].length - 1,
},
focus: {
key: editorState.startText.key,
offset: currentStartOffset - 1,
},
2018-05-23 07:52:00 +08:00
});
change = change.insertTextAtRange(range, unicodeEmoji);
editorState = change.value;
}
}
2018-05-23 07:52:00 +08:00
}
// emojioneify any emoji
2018-10-25 22:07:19 +08:00
let foundEmoji;
2018-10-25 21:54:32 +08:00
do {
2018-10-25 22:07:19 +08:00
foundEmoji = false;
for (const node of editorState.document.getTexts()) {
if (node.text !== '' && HtmlUtils.containsEmoji(node.text)) {
let match;
EMOJI_REGEX.lastIndex = 0;
while ((match = EMOJI_REGEX.exec(node.text)) !== null) {
const range = Range.create({
anchor: {
key: node.key,
offset: match.index,
},
focus: {
key: node.key,
offset: match.index + match[0].length,
},
});
const inline = Inline.create({
type: 'emoji',
data: { emojiUnicode: match[0] },
});
change = change.insertInlineAtRange(range, inline);
editorState = change.value;
// if we replaced an emoji, start again looking for more
// emoji in the new editor state since doing the replacement
// will change the node structure & offsets so we can't compute
// insertion ranges from node.key / match.index anymore.
foundEmoji = true;
break;
}
}
}
2018-10-25 21:54:32 +08:00
} while (foundEmoji);
// work around weird bug where inserting emoji via the macOS
// emoji picker can leave the selection stuck in the emoji's
// child text. This seems to happen due to selection getting
// moved in the normalisation phase after calculating these changes
if (editorState.selection.anchor.key &&
editorState.document.getParent(editorState.selection.anchor.key).type === 'emoji') {
change = change.moveToStartOfNextText();
editorState = change.value;
}
2018-05-21 10:48:59 +08:00
if (this.props.onInputStateChanged && editorState.blocks.size > 0) {
let blockType = editorState.blocks.first().type;
2018-05-21 06:34:06 +08:00
// console.log("onInputStateChanged; current block type is " + blockType + " and marks are " + editorState.activeMarks);
if (blockType === 'list-item') {
const parent = editorState.document.getParent(editorState.blocks.first().key);
if (parent.type === 'numbered-list') {
blockType = 'numbered-list';
} else if (parent.type === 'bulleted-list') {
blockType = 'bulleted-list';
}
}
const inputState = {
marks: editorState.activeMarks,
blockType,
};
this.props.onInputStateChanged(inputState);
}
// Record the editor state for this room so that it can be retrieved after switching to another room and back
MessageComposerStore.setEditorState(this.props.room.roomId, editorState, this.state.isRichTextEnabled);
this.setState({
2018-05-13 07:40:54 +08:00
editorState,
originalEditorState: originalEditorState || null,
});
};
mdToRichEditorState(editorState: Value): Value {
// for consistency when roundtripping, we could use slate-md-serializer rather than
// commonmark, but then we would lose pills as the MD deserialiser doesn't know about
// them and doesn't have any extensibility hooks.
//
// The code looks like this:
//
// const markdown = this.plainWithMdPills.serialize(editorState);
//
// // weirdly, the Md serializer can't deserialize '' to a valid Value...
// if (markdown !== '') {
// editorState = this.md.deserialize(markdown);
// }
// else {
// editorState = Plain.deserialize('', { defaultBlock: DEFAULT_NODE });
// }
// so, instead, we use commonmark proper (which is arguably more logical to the user
// anyway, as they'll expect the RTE view to match what they'll see in the timeline,
// but the HTML->MD conversion is anyone's guess).
const textWithMdPills = this.plainWithMdPills.serialize(editorState);
const markdown = new Markdown(textWithMdPills);
// HTML deserialize has custom rules to turn matrix.to links into pill objects.
return this.html.deserialize(markdown.toHTML());
}
2017-03-10 23:04:31 +08:00
richToMdEditorState(editorState: Value): Value {
// FIXME: this conversion loses pills (turning them into pure MD links).
// We need to add a pill-aware deserialize method
// to PlainWithPillsSerializer which recognises pills in raw MD and turns them into pills.
return Plain.deserialize(
// FIXME: we compile the MD out of the RTE state using slate-md-serializer
// which doesn't roundtrip symmetrically with commonmark, which we use for
// compiling MD out of the MD editor state above.
this.md.serialize(editorState),
{ defaultBlock: DEFAULT_NODE },
);
}
2016-05-27 12:45:55 +08:00
enableRichtext(enabled: boolean) {
if (enabled === this.state.isRichTextEnabled) return;
2017-03-10 23:04:31 +08:00
Analytics.setRichtextMode(enabled);
this.setState({
editorState: this.createEditorState(
enabled,
this.state.editorState,
this.state.isRichTextEnabled,
),
isRichTextEnabled: enabled,
}, () => {
this._editor.focus();
if (this.props.onInputStateChanged) {
this.props.onInputStateChanged({
isRichTextEnabled: enabled,
});
}
2016-09-13 19:16:20 +08:00
});
SettingsStore.setValue("MessageComposerInput.isRichTextEnabled", null, SettingLevel.ACCOUNT, enabled);
}
2018-05-17 09:13:17 +08:00
/**
* Check if the current selection has a mark with `type` in it.
*
* @param {String} type
* @return {Boolean}
*/
hasMark = type => {
const { editorState } = this.state;
return editorState.activeMarks.some(mark => mark.type === type);
2018-05-17 09:13:17 +08:00
};
/**
* Check if the any of the currently selected blocks are of `type`.
*
* @param {String} type
* @return {Boolean}
*/
hasBlock = type => {
const { editorState } = this.state;
return editorState.blocks.some(node => node.type === type);
2018-05-17 09:13:17 +08:00
};
2016-06-11 18:22:08 +08:00
onKeyDown = (ev: KeyboardEvent, change: Change, editor: Editor) => {
this.suppressAutoComplete = false;
2018-05-13 07:40:54 +08:00
// skip void nodes - see
// https://github.com/ianstormtaylor/slate/issues/762#issuecomment-304855095
if (ev.keyCode === KeyCode.LEFT) {
this.direction = 'Previous';
} else if (ev.keyCode === KeyCode.RIGHT) {
2018-05-13 07:40:54 +08:00
this.direction = 'Next';
} else {
this.direction = '';
}
2018-05-08 08:54:06 +08:00
switch (ev.keyCode) {
case KeyCode.ENTER:
return this.handleReturn(ev, change);
2018-05-20 03:38:07 +08:00
case KeyCode.BACKSPACE:
return this.onBackspace(ev, change);
2018-05-08 08:54:06 +08:00
case KeyCode.UP:
return this.onVerticalArrow(ev, true);
case KeyCode.DOWN:
return this.onVerticalArrow(ev, false);
2018-05-12 08:10:38 +08:00
case KeyCode.TAB:
return this.onTab(ev);
case KeyCode.ESCAPE:
return this.onEscape(ev);
case KeyCode.SPACE:
return this.onSpace(ev, change);
}
if (isOnlyCtrlOrCmdKeyEvent(ev)) {
const ctrlCmdCommand = {
// C-m => Toggles between rich text and markdown modes
[KeyCode.KEY_M]: 'toggle-mode',
[KeyCode.KEY_B]: 'bold',
[KeyCode.KEY_I]: 'italic',
[KeyCode.KEY_U]: 'underlined',
[KeyCode.KEY_J]: 'inline-code',
}[ev.keyCode];
if (ctrlCmdCommand) {
ev.preventDefault(); // to prevent clashing with Mac's minimize window
return this.handleKeyCommand(ctrlCmdCommand);
}
}
2018-05-17 09:13:17 +08:00
};
onSpace = (ev: KeyboardEvent, change: Change): Change => {
if (ev.metaKey || ev.altKey || ev.shiftKey || ev.ctrlKey) {
return;
}
// drop a point in history so the user can undo a word
// XXX: this seems nasty but adding to history manually seems a no-go
ev.preventDefault();
return change.withoutMerging(() => {
change.insertText(ev.key);
});
};
onBackspace = (ev: KeyboardEvent, change: Change): Change => {
if (ev.metaKey || ev.altKey || ev.shiftKey) {
return;
}
const { editorState } = this.state;
// Allow Ctrl/Cmd-Backspace when focus starts at the start of the composer (e.g select-all)
// for some reason if slate sees you Ctrl-backspace and your anchor.offset=0 it just resets your focus
// XXX: Doing this now seems to put slate into a broken state, and it didn't appear to be doing
// what it claims to do on the old version of slate anyway...
/*if (!editorState.isCollapsed && editorState.selection.anchor.offset === 0) {
return change.delete();
}*/
if (this.state.isRichTextEnabled) {
2018-05-20 03:38:07 +08:00
// let backspace exit lists
const isList = this.hasBlock('list-item');
if (isList && editorState.selection.anchor.offset == 0) {
2018-05-20 03:38:07 +08:00
change
.setBlocks(DEFAULT_NODE)
.unwrapBlock('bulleted-list')
.unwrapBlock('numbered-list');
return change;
} else if (editorState.selection.anchor.offset == 0 && editorState.isCollapsed) {
2018-05-21 10:48:59 +08:00
// turn blocks back into paragraphs
if ((this.hasBlock('block-quote') ||
this.hasBlock('heading1') ||
this.hasBlock('heading2') ||
this.hasBlock('heading3') ||
this.hasBlock('heading4') ||
this.hasBlock('heading5') ||
this.hasBlock('heading6') ||
this.hasBlock('code'))) {
2018-05-21 10:48:59 +08:00
return change.setBlocks(DEFAULT_NODE);
}
// remove paragraphs entirely if they're nested
const parent = editorState.document.getParent(editorState.anchorBlock.key);
if (editorState.selection.anchor.offset == 0 &&
2018-05-21 10:48:59 +08:00
this.hasBlock('paragraph') &&
parent.nodes.size == 1 &&
parent.object !== 'document') {
2018-05-21 10:48:59 +08:00
return change.replaceNodeByKey(editorState.anchorBlock.key, editorState.anchorText)
2018-10-11 17:47:36 +08:00
.moveToEndOfNode(parent)
2018-05-21 10:48:59 +08:00
.focus();
}
2018-05-20 03:38:07 +08:00
}
}
return;
};
2016-06-11 18:22:08 +08:00
handleKeyCommand = (command: string): boolean => {
if (command === 'toggle-mode') {
this.enableRichtext(!this.state.isRichTextEnabled);
2016-06-11 18:22:08 +08:00
return true;
}
//const newState: ?Value = null;
// Draft handles rich text mode commands by default but we need to do it ourselves for Markdown.
if (this.state.isRichTextEnabled) {
2018-05-17 09:13:17 +08:00
const type = command;
const { editorState } = this.state;
const change = editorState.change();
const { document } = editorState;
switch (type) {
// list-blocks:
case 'bulleted-list':
case 'numbered-list': {
// Handle the extra wrapping required for list buttons.
const isList = this.hasBlock('list-item');
const isType = editorState.blocks.some(block => {
return !!document.getClosest(block.key, parent => parent.type === type);
2018-05-17 09:13:17 +08:00
});
if (isList && isType) {
change
.setBlocks(DEFAULT_NODE)
.unwrapBlock('bulleted-list')
.unwrapBlock('numbered-list');
} else if (isList) {
change
.unwrapBlock(
type === 'bulleted-list' ? 'numbered-list' : 'bulleted-list',
2018-05-17 09:13:17 +08:00
)
.wrapBlock(type);
} else {
change.setBlocks('list-item').wrapBlock(type);
}
}
2018-05-17 09:13:17 +08:00
break;
// simple blocks
case 'paragraph':
case 'block-quote':
case 'heading1':
case 'heading2':
case 'heading3':
case 'heading4':
case 'heading5':
case 'heading6':
2018-05-17 09:13:17 +08:00
case 'list-item':
case 'code': {
2018-05-17 09:13:17 +08:00
const isActive = this.hasBlock(type);
const isList = this.hasBlock('list-item');
if (isList) {
change
.setBlocks(isActive ? DEFAULT_NODE : type)
.unwrapBlock('bulleted-list')
.unwrapBlock('numbered-list');
} else {
change.setBlocks(isActive ? DEFAULT_NODE : type);
}
}
break;
// marks:
case 'bold':
case 'italic':
case 'inline-code':
case 'underlined':
case 'deleted': {
change.toggleMark(type === 'inline-code' ? 'code' : type);
2018-05-17 09:13:17 +08:00
}
break;
default:
console.warn(`ignoring unrecognised RTE command ${type}`);
return false;
2016-09-08 01:22:14 +08:00
}
2018-05-17 09:13:17 +08:00
this.onChange(change);
return true;
2016-09-08 01:22:14 +08:00
} else {
2018-05-17 09:13:17 +08:00
/*
const contentState = this.state.editorState.getCurrentContent();
const multipleLinesSelected = RichText.hasMultiLineSelection(this.state.editorState);
const selectionState = this.state.editorState.getSelection();
const start = selectionState.getStartOffset();
const end = selectionState.getEndOffset();
// If multiple lines are selected or nothing is selected, insert a code block
// instead of applying inline code formatting. This is an attempt to mimic what
// happens in non-MD mode.
const treatInlineCodeAsBlock = multipleLinesSelected || start === end;
const textMdCodeBlock = (text) => `\`\`\`\n${text}\n\`\`\`\n`;
const modifyFn = {
'bold': (text) => `**${text}**`,
'italic': (text) => `*${text}*`,
'underline': (text) => `<u>${text}</u>`,
'strike': (text) => `<del>${text}</del>`,
// ("code" is triggered by ctrl+j by draft-js by default)
'code': (text) => treatInlineCodeAsBlock ? textMdCodeBlock(text) : `\`${text}\``,
'code': textMdCodeBlock,
'blockquote': (text) => text.split('\n').map((line) => `> ${line}\n`).join('') + '\n',
'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];
const selectionAfterOffset = {
'bold': -2,
'italic': -1,
'underline': -4,
'strike': -6,
'code': treatInlineCodeAsBlock ? -5 : -1,
'code': -5,
'blockquote': -2,
}[command];
// Returns a function that collapses a selection to its end and moves it by offset
const collapseAndOffsetSelection = (selection, offset) => {
const key = selection.endKey();
return new Range({
anchorKey: key, anchor.offset: offset,
focus.key: key, focus.offset: offset,
});
};
if (modifyFn) {
const previousSelection = this.state.editorState.getSelection();
const newContentState = RichText.modifyText(contentState, previousSelection, modifyFn);
newState = EditorState.push(
this.state.editorState,
newContentState,
'insert-characters',
);
let newSelection = newContentState.getSelectionAfter();
// If the selection range is 0, move the cursor inside the formatted body
if (previousSelection.getStartOffset() === previousSelection.getEndOffset() &&
previousSelection.getStartKey() === previousSelection.getEndKey() &&
selectionAfterOffset !== undefined
) {
const selectedBlock = newContentState.getBlockForKey(previousSelection.getAnchorKey());
const blockLength = selectedBlock.getText().length;
const newOffset = blockLength + selectionAfterOffset;
newSelection = collapseAndOffsetSelection(newSelection, newOffset);
}
newState = EditorState.forceSelection(newState, newSelection);
}
}
if (newState != null) {
this.setState({editorState: newState});
2016-05-27 12:45:55 +08:00
return true;
}
2018-05-17 09:13:17 +08:00
*/
}
2016-05-27 12:45:55 +08:00
return false;
};
2016-05-27 12:45:55 +08:00
2018-05-20 05:05:31 +08:00
onPaste = (event: Event, change: Change, editor: Editor): Change => {
const transfer = getEventTransfer(event);
switch (transfer.type) {
case 'files':
// This actually not so much for 'files' as such (at time of writing
// neither chrome nor firefox let you paste a plain file copied
// from Finder) but more images copied from a different website
// / word processor etc.
return ContentMessages.sharedInstance().sendContentListToRoom(
transfer.files, this.props.room.roomId, this.client,
);
case 'html': {
if (this.state.isRichTextEnabled) {
// FIXME: https://github.com/ianstormtaylor/slate/issues/1497 means
// that we will silently discard nested blocks (e.g. nested lists) :(
const fragment = this.html.deserialize(transfer.html);
return change
// XXX: this somehow makes Slate barf on undo and get too empty and break entirely
// .setOperationFlag("skip", false)
// .setOperationFlag("merge", false)
.insertFragment(fragment.document);
} else {
// in MD mode we don't want the rich content pasted as the magic was annoying people so paste plain
return change.withoutMerging(() => {
change.insertText(transfer.text);
});
}
2018-05-20 06:33:07 +08:00
}
case 'text':
// don't skip/merge so that multiple consecutive pastes can be undone individually
return change.withoutMerging(() => {
change.insertText(transfer.text);
});
}
2018-05-20 05:05:31 +08:00
};
handleReturn = (ev, change) => {
const isMac = navigator.platform.toUpperCase().indexOf('MAC') >= 0;
if (ev.shiftKey || (isMac && ev.altKey)) {
return change.insertText('\n');
2017-03-10 23:04:31 +08:00
}
const editorState = this.state.editorState;
const lastBlock = editorState.blocks.last();
if (['code', 'block-quote', 'list-item'].includes(lastBlock.type)) {
const text = lastBlock.text;
if (text === '') {
// allow the user to cancel empty block by hitting return, useful in conjunction with below `inBlock`
return change
.setBlocks(DEFAULT_NODE)
.unwrapBlock('bulleted-list')
.unwrapBlock('numbered-list');
}
// TODO strip trailing lines from blockquotes/list entries
// the below code seemingly works but doesn't account for edge cases like return with caret not at end
/* const trailingNewlines = text.match(/\n*$/);
if (trailingNewlines && trailingNewlines[0]) {
remove trailing newlines at the end of this block before making a new one
return change.deleteBackward(trailingNewlines[0].length);
}*/
2018-05-17 09:13:17 +08:00
return;
}
2016-06-11 18:22:08 +08:00
2018-05-13 03:04:58 +08:00
let contentText;
let contentHTML;
2016-06-11 18:22:08 +08:00
2018-05-13 03:04:58 +08:00
// only look for commands if the first block contains simple unformatted text
// i.e. no pills or rich-text formatting and begins with a /.
let cmd; let commandText;
2018-05-13 03:04:58 +08:00
const firstChild = editorState.document.nodes.get(0);
const firstGrandChild = firstChild && firstChild.nodes.get(0);
if (firstChild && firstGrandChild &&
firstChild.object === 'block' && firstGrandChild.object === 'text' &&
firstGrandChild.text[0] === '/') {
2018-05-13 03:04:58 +08:00
commandText = this.plainWithIdPills.serialize(editorState);
cmd = processCommandInput(this.props.room.roomId, commandText);
2018-05-13 03:04:58 +08:00
}
2016-06-12 02:41:27 +08:00
if (cmd) {
if (!cmd.error) {
this.historyManager.save(editorState, this.state.isRichTextEnabled ? 'rich' : 'markdown');
2016-06-12 02:41:27 +08:00
this.setState({
editorState: this.createEditorState(),
}, ()=>{
this._editor.focus();
2016-06-12 02:41:27 +08:00
});
}
if (cmd.promise) {
2018-05-13 10:26:22 +08:00
cmd.promise.then(()=>{
2016-06-12 02:41:27 +08:00
console.log("Command success.");
2018-05-13 10:26:22 +08:00
}, (err)=>{
2016-06-12 02:41:27 +08:00
console.error("Command failure: %s", err);
const ErrorDialog = sdk.getComponent("dialogs.ErrorDialog");
Modal.createTrackedDialog('Server error', '', ErrorDialog, {
title: _t("Server error"),
description: ((err && err.message) ? err.message : _t(
"Server unavailable, overloaded, or something else went wrong.",
)),
2016-06-12 02:41:27 +08:00
});
});
} else if (cmd.error) {
2016-06-12 02:41:27 +08:00
console.error(cmd.error);
const ErrorDialog = sdk.getComponent("dialogs.ErrorDialog");
// TODO possibly track which command they ran (not its Arguments) here
Modal.createTrackedDialog('Command error', '', ErrorDialog, {
title: _t("Command error"),
description: cmd.error,
2016-06-12 02:41:27 +08:00
});
}
return true;
}
const replyingToEv = RoomViewStore.getQuotingEvent();
const mustSendHTML = Boolean(replyingToEv);
if (this.state.isRichTextEnabled) {
// We should only send HTML if any block is styled or contains inline style
let shouldSendHTML = false;
if (mustSendHTML) shouldSendHTML = true;
if (!shouldSendHTML) {
2018-05-20 03:28:38 +08:00
shouldSendHTML = !!editorState.document.findDescendant(node => {
// N.B. node.getMarks() might be private?
2018-05-21 10:48:59 +08:00
return ((node.object === 'block' && node.type !== 'paragraph') ||
2018-05-20 03:28:38 +08:00
(node.object === 'inline') ||
(node.object === 'text' && node.getMarks().size > 0));
});
}
2018-05-20 03:28:38 +08:00
2018-05-13 03:04:58 +08:00
contentText = this.plainWithPlainPills.serialize(editorState);
if (contentText === '') return true;
if (shouldSendHTML) {
contentHTML = HtmlUtils.processHtmlForSending(this.html.serialize(editorState));
}
2016-06-11 18:22:08 +08:00
} else {
2018-05-13 03:04:58 +08:00
const sourceWithPills = this.plainWithMdPills.serialize(editorState);
if (sourceWithPills === '') return true;
2018-05-13 03:04:58 +08:00
const mdWithPills = new Markdown(sourceWithPills);
// if contains no HTML and we're not quoting (needing HTML)
2018-05-13 03:04:58 +08:00
if (mdWithPills.isPlainText() && !mustSendHTML) {
// N.B. toPlainText is only usable here because we know that the MD
// didn't contain any formatting in the first place...
contentText = mdWithPills.toPlaintext();
} else {
// to avoid ugliness on clients which ignore the HTML body we don't
// send pills in the plaintext body.
2018-05-13 03:04:58 +08:00
contentText = this.plainWithPlainPills.serialize(editorState);
contentHTML = mdWithPills.toHTML();
}
2016-06-11 18:22:08 +08:00
}
2016-05-27 12:45:55 +08:00
let sendHtmlFn = ContentHelpers.makeHtmlMessage;
let sendTextFn = ContentHelpers.makeTextMessage;
2016-06-12 02:41:27 +08:00
this.historyManager.save(
2018-05-13 03:04:58 +08:00
editorState,
this.state.isRichTextEnabled ? 'rich' : 'markdown',
);
2017-03-10 23:04:31 +08:00
2018-05-13 03:04:58 +08:00
if (commandText && commandText.startsWith('/me')) {
if (replyingToEv) {
const ErrorDialog = sdk.getComponent("dialogs.ErrorDialog");
Modal.createTrackedDialog('Emote Reply Fail', '', ErrorDialog, {
title: _t("Unable to reply"),
description: _t("At this time it is not possible to reply with an emote."),
});
return false;
}
contentText = contentText.substring(4);
// bit of a hack, but the alternative would be quite complicated
if (contentHTML) contentHTML = contentHTML.replace(/\/me ?/, '');
sendHtmlFn = ContentHelpers.makeHtmlEmote;
sendTextFn = ContentHelpers.makeEmoteMessage;
}
2018-05-13 03:04:58 +08:00
let content = contentHTML ?
sendHtmlFn(contentText, contentHTML) :
sendTextFn(contentText);
if (replyingToEv) {
const replyContent = ReplyThread.makeReplyMixIn(replyingToEv);
content = Object.assign(replyContent, content);
2018-05-13 03:04:58 +08:00
// Part of Replies fallback support - prepend the text we're sending
// with the text we're replying to
const nestedReply = ReplyThread.getNestedReplyText(replyingToEv, this.props.permalinkCreator);
if (nestedReply) {
if (content.formatted_body) {
content.formatted_body = nestedReply.html + content.formatted_body;
}
content.body = nestedReply.body + content.body;
}
// Clear reply_to_event as we put the message into the queue
// if the send fails, retry will handle resending.
dis.dispatch({
action: 'reply_to_event',
event: null,
});
}
2016-06-11 18:22:08 +08:00
this.client.sendMessage(this.props.room.roomId, content).then((res) => {
dis.dispatch({
action: 'message_sent',
});
}).catch((e) => {
onSendMessageFailed(e, this.props.room);
});
2016-05-27 12:45:55 +08:00
this.setState({
editorState: this.createEditorState(),
}, ()=>{ this._editor.focus(); });
2016-05-27 12:45:55 +08:00
return true;
};
2016-06-21 21:03:39 +08:00
onVerticalArrow = (e, up) => {
if (e.ctrlKey || e.shiftKey || e.altKey || e.metaKey) {
return;
}
// Select history only if we are not currently auto-completing
if (this.autocomplete.state.completionList.length === 0) {
const selection = this.state.editorState.selection;
// selection must be collapsed
if (!selection.isCollapsed) return;
const document = this.state.editorState.document;
// and we must be at the edge of the document (up=start, down=end)
2018-05-08 08:54:06 +08:00
if (up) {
if (!selection.anchor.isAtStartOfNode(document)) return;
} else {
if (!selection.anchor.isAtEndOfNode(document)) 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);
e.preventDefault();
}
};
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;
}
let editorState;
const historyItem = this.historyManager.getItem(delta);
if (!historyItem) return;
if (historyItem.format === 'rich' && !this.state.isRichTextEnabled) {
editorState = this.richToMdEditorState(historyItem.value);
} else if (historyItem.format === 'markdown' && this.state.isRichTextEnabled) {
editorState = this.mdToRichEditorState(historyItem.value);
} else {
editorState = historyItem.value;
}
// Move selection to the end of the selected history
2018-10-11 17:47:36 +08:00
const change = editorState.change().moveToEndOfNode(editorState.document);
// We don't call this.onChange(change) now, as fixups on stuff like emoji
// should already have been done and persisted in the history.
2018-05-08 08:54:06 +08:00
editorState = change.value;
this.suppressAutoComplete = true;
2018-05-08 08:54:06 +08:00
this.setState({ editorState }, ()=>{
this._editor.focus();
2018-05-08 08:54:06 +08:00
});
return true;
};
2019-01-10 03:36:34 +08:00
onTab = async (e) => {
this.setState({
someCompletions: null,
});
e.preventDefault();
if (this.autocomplete.state.completionList.length === 0) {
// Force completions to show for the text currently entered
const completionCount = await this.autocomplete.forceComplete();
this.setState({
someCompletions: completionCount > 0,
});
// Select the first item by moving "down"
await this.moveAutocompleteSelection(false);
} else {
await this.moveAutocompleteSelection(e.shiftKey);
2016-06-21 21:03:39 +08:00
}
};
2016-06-21 21:03:39 +08:00
moveAutocompleteSelection = (up) => {
up ? this.autocomplete.onUpArrow() : this.autocomplete.onDownArrow();
};
2019-01-10 03:36:34 +08:00
onEscape = async (e) => {
e.preventDefault();
if (this.autocomplete) {
this.autocomplete.onEscape(e);
2016-06-21 21:03:39 +08:00
}
await this.setDisplayedCompletion(null); // restore originalEditorState
};
2016-06-21 21:03:39 +08:00
onAutocompleteConfirm = (displayedCompletion: ?Completion) => {
this.focusComposer();
// XXX: this fails if the composer isn't focused so focus it and delay the completion until next tick
setImmediate(() => {
this.setDisplayedCompletion(displayedCompletion);
});
};
/* 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.
*/
2019-01-10 03:36:34 +08:00
setDisplayedCompletion = async (displayedCompletion: ?Completion): boolean => {
const activeEditorState = this.state.originalEditorState || this.state.editorState;
if (displayedCompletion == null) {
if (this.state.originalEditorState) {
const editorState = this.state.originalEditorState;
this.setState({editorState});
}
return false;
}
2018-05-13 03:04:58 +08:00
const {
range = null,
completion = '',
completionId = '',
href = null,
suffix = '',
2018-05-13 03:04:58 +08:00
} = displayedCompletion;
2018-05-12 08:10:38 +08:00
let inline;
if (href) {
2018-05-12 08:10:38 +08:00
inline = Inline.create({
type: 'pill',
2018-05-20 07:49:29 +08:00
data: { completion, completionId, href },
});
2017-11-06 23:11:42 +08:00
} else if (completion === '@room') {
2018-05-12 08:10:38 +08:00
inline = Inline.create({
type: 'pill',
2018-05-13 07:40:54 +08:00
data: { completion, completionId },
2017-11-06 23:11:42 +08:00
});
}
2018-05-12 08:10:38 +08:00
let editorState = activeEditorState;
if (range) {
const change = editorState.change()
.moveToAnchor()
.moveAnchorTo(range.start)
.moveFocusTo(range.end)
.focus();
2018-05-12 08:10:38 +08:00
editorState = change.value;
}
let change;
if (inline) {
change = editorState.change()
.insertInlineAtRange(editorState.selection, inline)
.insertText(suffix)
.focus();
} else {
change = editorState.change()
.insertTextAtRange(editorState.selection, completion)
.insertText(suffix)
.focus();
}
// for good hygiene, keep editorState updated to track the result of the change
// even though we don't do anything subsequently with it
2018-05-12 08:10:38 +08:00
editorState = change.value;
2018-05-15 08:16:06 +08:00
this.onChange(change, activeEditorState);
return true;
};
2018-05-12 08:10:38 +08:00
renderNode = props => {
const { attributes, children, node, isSelected } = props;
switch (node.type) {
2018-05-17 09:13:17 +08:00
case 'paragraph':
return <p {...attributes}>{children}</p>;
case 'block-quote':
return <blockquote {...attributes}>{children}</blockquote>;
case 'bulleted-list':
return <ul {...attributes}>{children}</ul>;
case 'heading1':
2018-05-17 09:13:17 +08:00
return <h1 {...attributes}>{children}</h1>;
case 'heading2':
2018-05-17 09:13:17 +08:00
return <h2 {...attributes}>{children}</h2>;
case 'heading3':
2018-05-17 09:13:17 +08:00
return <h3 {...attributes}>{children}</h3>;
case 'heading4':
2018-05-20 06:34:30 +08:00
return <h4 {...attributes}>{children}</h4>;
case 'heading5':
2018-05-20 06:34:30 +08:00
return <h5 {...attributes}>{children}</h5>;
case 'heading6':
2018-05-20 06:34:30 +08:00
return <h6 {...attributes}>{children}</h6>;
2018-05-17 09:13:17 +08:00
case 'list-item':
return <li {...attributes}>{children}</li>;
case 'numbered-list':
return <ol {...attributes}>{children}</ol>;
case 'code':
return <pre {...attributes}>{children}</pre>;
case 'link':
2018-05-20 07:49:29 +08:00
return <a {...attributes} href={ node.data.get('href') }>{children}</a>;
2018-05-12 08:10:38 +08:00
case 'pill': {
const { data } = node;
2018-05-20 07:49:29 +08:00
const url = data.get('href');
2018-05-13 07:40:54 +08:00
const completion = data.get('completion');
2018-05-12 08:10:38 +08:00
Be more positive with setting labels Fixes https://github.com/vector-im/riot-web/issues/6435 This is done through an on-the-fly inverter for the settings. All the settings changed are boolean values, so this should be more than safe to just let happen throughout the SettingsStore. Typically a change like this would be done in the individual handlers (similar to how setting names are remapped to different properties or even different storage locations on the fly), however doing that for this many settings would be a huge nightmare and involve changing *all* the layers. By putting a global "invert this" flag on the setting, we can get away with doing the inversion as the last possible step during a read (or write). To speed up calculations of the default values, we cache all the inverted values into a lookup table similar to how we represent the defaults already. Without this, the DefaultHandler would need to iterate the setting list and invert the values, slowing things down over time. We invert the value up front so we can keep the generic inversion logic without checking the level ahead of time. It is fully intended that a default value represents the new setting name, not the legacy name. This commit also includes a debugger for settings because it was hard to visualize what the SettingsStore was doing during development. Some added information is included as it may be helpful for when someone has a problem with their settings and we need to debug it. Typically the debugger would be run in conjunction with `mxSendRageshake`: `mxSettingsStore.debugSetting('showJoinLeaves') && mxSendRageshake('Debugging showJoinLeaves setting')`.
2019-01-25 11:57:40 +08:00
const shouldShowPillAvatar = SettingsStore.getValue("Pill.shouldShowPillAvatar");
2018-05-12 08:10:38 +08:00
const Pill = sdk.getComponent('elements.Pill');
2018-05-13 07:40:54 +08:00
if (completion === '@room') {
2018-05-12 08:10:38 +08:00
return <Pill
type={Pill.TYPE_AT_ROOM_MENTION}
room={this.props.room}
shouldShowPillAvatar={shouldShowPillAvatar}
isSelected={isSelected}
{...attributes}
2018-05-12 08:10:38 +08:00
/>;
} else if (Pill.isPillUrl(url)) {
2018-05-12 08:10:38 +08:00
return <Pill
url={url}
room={this.props.room}
shouldShowPillAvatar={shouldShowPillAvatar}
isSelected={isSelected}
{...attributes}
2018-05-12 08:10:38 +08:00
/>;
} else {
const { text } = node;
2018-05-12 08:10:38 +08:00
return <a href={url} {...props.attributes}>
{ text }
</a>;
}
}
case 'emoji': {
const { data } = node;
const emojiUnicode = data.get('emojiUnicode');
const uri = RichText.unicodeToEmojiUri(emojiUnicode);
const shortname = toShort(emojiUnicode);
const className = classNames('mx_emojione', {
mx_emojione_selected: isSelected,
});
const style = {};
if (props.selected) style.border = '1px solid blue';
return <img className={ className } src={ uri }
title={ shortname } alt={ emojiUnicode } style={style}
/>;
}
2018-05-12 08:10:38 +08:00
}
};
2018-05-17 09:13:17 +08:00
renderMark = props => {
const { children, mark, attributes } = props;
switch (mark.type) {
case 'bold':
2018-05-20 03:28:38 +08:00
return <strong {...attributes}>{children}</strong>;
2018-05-17 09:13:17 +08:00
case 'italic':
2018-05-20 03:28:38 +08:00
return <em {...attributes}>{children}</em>;
case 'code':
2018-05-20 03:28:38 +08:00
return <code {...attributes}>{children}</code>;
case 'underlined':
2018-05-20 03:28:38 +08:00
return <u {...attributes}>{children}</u>;
case 'deleted':
2018-05-20 03:28:38 +08:00
return <del {...attributes}>{children}</del>;
2018-05-17 09:13:17 +08:00
}
};
onFormatButtonClicked = (name, e) => {
e.preventDefault();
// XXX: horrible evil hack to ensure the editor is focused so the act
// of focusing it doesn't then cancel the format button being pressed
// FIXME: can we just tell handleKeyCommand's change to invoke .focus()?
if (document.activeElement && document.activeElement.className !== 'mx_MessageComposer_editor') {
this._editor.focus();
setTimeout(()=>{
this.handleKeyCommand(name);
}, 500); // can't find any callback to hook this to. onFocus and onChange and willComponentUpdate fire too early.
return;
}
this.handleKeyCommand(name);
};
2018-05-12 08:10:38 +08:00
getAutocompleteQuery(editorState: Value) {
// We can just return the current block where the selection begins, which
// should be enough to capture any autocompletion input, given autocompletion
// providers only search for the first match which intersects with the current selection.
// This avoids us having to serialize the whole thing to plaintext and convert
// selection offsets in & out of the plaintext domain.
if (editorState.selection.anchor.key) {
return editorState.document.getDescendant(editorState.selection.anchor.key).text;
} else {
2018-05-20 03:28:38 +08:00
return '';
}
}
2018-05-12 08:10:38 +08:00
getSelectionRange(editorState: Value) {
let beginning = false;
const firstChild = editorState.document.nodes.get(0);
const firstGrandChild = firstChild && firstChild.nodes.get(0);
beginning = (firstChild && firstGrandChild &&
firstChild.object === 'block' && firstGrandChild.object === 'text' &&
editorState.selection.anchor.key === firstGrandChild.key);
2018-05-12 08:10:38 +08:00
// return a character range suitable for handing to an autocomplete provider.
// the range is relative to the anchor of the current editor selection.
// if the selection spans multiple blocks, then we collapse it for the calculation.
const range = {
beginning, // whether the selection is in the first block of the editor or not
start: editorState.selection.anchor.offset,
end: (editorState.selection.anchor.key == editorState.selection.focus.key) ?
editorState.selection.focus.offset : editorState.selection.anchor.offset,
};
2018-05-12 08:10:38 +08:00
if (range.start > range.end) {
const tmp = range.start;
range.start = range.end;
range.end = tmp;
}
return range;
}
onMarkdownToggleClicked = (e) => {
e.preventDefault(); // don't steal focus from the editor!
this.handleKeyCommand('toggle-mode');
};
2016-09-08 01:22:14 +08:00
2018-07-10 00:50:07 +08:00
focusComposer = () => {
this._editor.focus();
2018-07-10 00:50:07 +08:00
};
2016-05-27 12:45:55 +08:00
render() {
const activeEditorState = this.state.originalEditorState || this.state.editorState;
2016-06-11 18:22:08 +08:00
const className = classNames('mx_MessageComposer_input', {
mx_MessageComposer_input_error: this.state.someCompletions === false,
});
const isEmpty = Plain.serialize(this.state.editorState) === '';
let {placeholder} = this.props;
// XXX: workaround for placeholder being shown when there is a formatting block e.g blockquote but no text
if (isEmpty && this.state.editorState.startBlock && this.state.editorState.startBlock.type !== DEFAULT_NODE) {
placeholder = undefined;
}
const markdownClasses = classNames({
mx_MessageComposer_input_markdownIndicator: true,
mx_MessageComposer_markdownDisabled: this.state.isRichTextEnabled,
});
return (
<div className="mx_MessageComposer_input_wrapper" onClick={this.focusComposer}>
<div className="mx_MessageComposer_autocomplete_wrapper">
<ReplyPreview permalinkCreator={this.props.permalinkCreator} />
<Autocomplete
ref={(e) => this.autocomplete = e}
room={this.props.room}
onConfirm={this.onAutocompleteConfirm}
onSelectionChange={this.setDisplayedCompletion}
query={ this.suppressAutoComplete ? '' : this.getAutocompleteQuery(activeEditorState) }
2018-05-12 08:10:38 +08:00
selection={this.getSelectionRange(activeEditorState)}
/>
</div>
<div className={className}>
<AccessibleButton className={markdownClasses}
onClick={this.onMarkdownToggleClicked}
title={this.state.isRichTextEnabled ? _t("Markdown is disabled") : _t("Markdown is enabled")}
/>
<Editor ref={this._collectEditor}
2017-06-03 23:52:45 +08:00
dir="auto"
2018-05-06 08:18:26 +08:00
className="mx_MessageComposer_editor"
placeholder={placeholder}
2018-05-06 07:18:11 +08:00
value={this.state.editorState}
2018-05-08 08:54:06 +08:00
onChange={this.onChange}
onKeyDown={this.onKeyDown}
2018-05-20 05:05:31 +08:00
onPaste={this.onPaste}
2018-05-12 08:10:38 +08:00
renderNode={this.renderNode}
2018-05-17 09:13:17 +08:00
renderMark={this.renderMark}
// disable spell check for the placeholder because browsers don't like "unencrypted"
spellCheck={!isEmpty}
schema={SLATE_SCHEMA}
2018-05-06 06:25:04 +08:00
/>
</div>
</div>
);
}
}