mirror of
https://github.com/element-hq/element-web
synced 2024-10-27 21:18:13 +03:00
bfa3123f9b
- Instead of using one attribute, use one that might just contain one token - Use the first token when tracking a child - Mandate that no commas can be in individual tokens
632 lines
22 KiB
JavaScript
632 lines
22 KiB
JavaScript
/*
|
|
Copyright 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.
|
|
*/
|
|
|
|
var React = require('react');
|
|
var ReactDOM = require("react-dom");
|
|
var dis = require("../../dispatcher");
|
|
var sdk = require('../../index');
|
|
|
|
var MatrixClientPeg = require('../../MatrixClientPeg');
|
|
|
|
const MILLIS_IN_DAY = 86400000;
|
|
|
|
/* (almost) stateless UI component which builds the event tiles in the room timeline.
|
|
*/
|
|
module.exports = React.createClass({
|
|
displayName: 'MessagePanel',
|
|
|
|
propTypes: {
|
|
// true to give the component a 'display: none' style.
|
|
hidden: React.PropTypes.bool,
|
|
|
|
// true to show a spinner at the top of the timeline to indicate
|
|
// back-pagination in progress
|
|
backPaginating: React.PropTypes.bool,
|
|
|
|
// true to show a spinner at the end of the timeline to indicate
|
|
// forward-pagination in progress
|
|
forwardPaginating: React.PropTypes.bool,
|
|
|
|
// the list of MatrixEvents to display
|
|
events: React.PropTypes.array.isRequired,
|
|
|
|
// ID of an event to highlight. If undefined, no event will be highlighted.
|
|
highlightedEventId: React.PropTypes.string,
|
|
|
|
// Should we show URL Previews
|
|
showUrlPreview: React.PropTypes.bool,
|
|
|
|
// event after which we should show a read marker
|
|
readMarkerEventId: React.PropTypes.string,
|
|
|
|
// whether the read marker should be visible
|
|
readMarkerVisible: React.PropTypes.bool,
|
|
|
|
// the userid of our user. This is used to suppress the read marker
|
|
// for pending messages.
|
|
ourUserId: React.PropTypes.string,
|
|
|
|
// true to suppress the date at the start of the timeline
|
|
suppressFirstDateSeparator: React.PropTypes.bool,
|
|
|
|
// whether to show read receipts
|
|
manageReadReceipts: React.PropTypes.bool,
|
|
|
|
// true if updates to the event list should cause the scroll panel to
|
|
// scroll down when we are at the bottom of the window. See ScrollPanel
|
|
// for more details.
|
|
stickyBottom: React.PropTypes.bool,
|
|
|
|
// callback which is called when the panel is scrolled.
|
|
onScroll: React.PropTypes.func,
|
|
|
|
// callback which is called when more content is needed.
|
|
onFillRequest: React.PropTypes.func,
|
|
|
|
// opacity for dynamic UI fading effects
|
|
opacity: React.PropTypes.number,
|
|
|
|
// className for the panel
|
|
className: React.PropTypes.string.isRequired,
|
|
|
|
// shape parameter to be passed to EventTiles
|
|
tileShape: React.PropTypes.string,
|
|
},
|
|
|
|
componentWillMount: function() {
|
|
// the event after which we put a visible unread marker on the last
|
|
// render cycle; null if readMarkerVisible was false or the RM was
|
|
// suppressed (eg because it was at the end of the timeline)
|
|
this.currentReadMarkerEventId = null;
|
|
|
|
// the event after which we are showing a disappearing read marker
|
|
// animation
|
|
this.currentGhostEventId = null;
|
|
|
|
// opaque readreceipt info for each userId; used by ReadReceiptMarker
|
|
// to manage its animations
|
|
this._readReceiptMap = {};
|
|
|
|
// Remember the read marker ghost node so we can do the cleanup that
|
|
// Velocity requires
|
|
this._readMarkerGhostNode = null;
|
|
|
|
this._isMounted = true;
|
|
},
|
|
|
|
componentWillUnmount: function() {
|
|
this._isMounted = false;
|
|
},
|
|
|
|
/* get the DOM node representing the given event */
|
|
getNodeForEventId: function(eventId) {
|
|
if (!this.eventNodes) {
|
|
return undefined;
|
|
}
|
|
|
|
return this.eventNodes[eventId];
|
|
},
|
|
|
|
/* return true if the content is fully scrolled down right now; else false.
|
|
*/
|
|
isAtBottom: function() {
|
|
return this.refs.scrollPanel
|
|
&& this.refs.scrollPanel.isAtBottom();
|
|
},
|
|
|
|
/* get the current scroll state. See ScrollPanel.getScrollState for
|
|
* details.
|
|
*
|
|
* returns null if we are not mounted.
|
|
*/
|
|
getScrollState: function() {
|
|
if (!this.refs.scrollPanel) { return null; }
|
|
return this.refs.scrollPanel.getScrollState();
|
|
},
|
|
|
|
// returns one of:
|
|
//
|
|
// null: there is no read marker
|
|
// -1: read marker is above the window
|
|
// 0: read marker is within the window
|
|
// +1: read marker is below the window
|
|
getReadMarkerPosition: function() {
|
|
var readMarker = this.refs.readMarkerNode;
|
|
var messageWrapper = this.refs.scrollPanel;
|
|
|
|
if (!readMarker || !messageWrapper) {
|
|
return null;
|
|
}
|
|
|
|
var wrapperRect = ReactDOM.findDOMNode(messageWrapper).getBoundingClientRect();
|
|
var readMarkerRect = readMarker.getBoundingClientRect();
|
|
|
|
// the read-marker pretends to have zero height when it is actually
|
|
// two pixels high; +2 here to account for that.
|
|
if (readMarkerRect.bottom + 2 < wrapperRect.top) {
|
|
return -1;
|
|
} else if (readMarkerRect.top < wrapperRect.bottom) {
|
|
return 0;
|
|
} else {
|
|
return 1;
|
|
}
|
|
},
|
|
|
|
/* jump to the top of the content.
|
|
*/
|
|
scrollToTop: function() {
|
|
if (this.refs.scrollPanel) {
|
|
this.refs.scrollPanel.scrollToTop();
|
|
}
|
|
},
|
|
|
|
/* jump to the bottom of the content.
|
|
*/
|
|
scrollToBottom: function() {
|
|
if (this.refs.scrollPanel) {
|
|
this.refs.scrollPanel.scrollToBottom();
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Page up/down.
|
|
*
|
|
* mult: -1 to page up, +1 to page down
|
|
*/
|
|
scrollRelative: function(mult) {
|
|
if (this.refs.scrollPanel) {
|
|
this.refs.scrollPanel.scrollRelative(mult);
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Scroll up/down in response to a scroll key
|
|
*/
|
|
handleScrollKey: function(ev) {
|
|
if (this.refs.scrollPanel) {
|
|
this.refs.scrollPanel.handleScrollKey(ev);
|
|
}
|
|
},
|
|
|
|
/* jump to the given event id.
|
|
*
|
|
* offsetBase gives the reference point for the pixelOffset. 0 means the
|
|
* top of the container, 1 means the bottom, and fractional values mean
|
|
* somewhere in the middle. If omitted, it defaults to 0.
|
|
*
|
|
* pixelOffset gives the number of pixels *above* the offsetBase that the
|
|
* node (specifically, the bottom of it) will be positioned. If omitted, it
|
|
* defaults to 0.
|
|
*/
|
|
scrollToEvent: function(eventId, pixelOffset, offsetBase) {
|
|
if (this.refs.scrollPanel) {
|
|
this.refs.scrollPanel.scrollToToken(eventId, pixelOffset, offsetBase);
|
|
}
|
|
},
|
|
|
|
/* check the scroll state and send out pagination requests if necessary.
|
|
*/
|
|
checkFillState: function() {
|
|
if (this.refs.scrollPanel) {
|
|
this.refs.scrollPanel.checkFillState();
|
|
}
|
|
},
|
|
|
|
_isUnmounting: function() {
|
|
return !this._isMounted;
|
|
},
|
|
|
|
_getEventTiles: function() {
|
|
var EventTile = sdk.getComponent('rooms.EventTile');
|
|
var DateSeparator = sdk.getComponent('messages.DateSeparator');
|
|
const MemberEventListSummary = sdk.getComponent('views.elements.MemberEventListSummary');
|
|
|
|
this.eventNodes = {};
|
|
|
|
var i;
|
|
|
|
// first figure out which is the last event in the list which we're
|
|
// actually going to show; this allows us to behave slightly
|
|
// differently for the last event in the list.
|
|
//
|
|
// we also need to figure out which is the last event we show which isn't
|
|
// a local echo, to manage the read-marker.
|
|
var lastShownEventIndex = -1;
|
|
var lastShownNonLocalEchoIndex = -1;
|
|
for (i = this.props.events.length-1; i >= 0; i--) {
|
|
var mxEv = this.props.events[i];
|
|
if (!EventTile.haveTileForEvent(mxEv)) {
|
|
continue;
|
|
}
|
|
|
|
if (lastShownEventIndex < 0) {
|
|
lastShownEventIndex = i;
|
|
}
|
|
|
|
if (mxEv.status) {
|
|
// this is a local echo
|
|
continue;
|
|
}
|
|
|
|
lastShownNonLocalEchoIndex = i;
|
|
break;
|
|
}
|
|
|
|
var ret = [];
|
|
|
|
var prevEvent = null; // the last event we showed
|
|
|
|
// assume there is no read marker until proven otherwise
|
|
var readMarkerVisible = false;
|
|
|
|
// if the readmarker has moved, cancel any active ghost.
|
|
if (this.currentReadMarkerEventId && this.props.readMarkerEventId &&
|
|
this.props.readMarkerVisible &&
|
|
this.currentReadMarkerEventId != this.props.readMarkerEventId) {
|
|
this.currentGhostEventId = null;
|
|
}
|
|
|
|
var isMembershipChange = (e) => e.getType() === 'm.room.member';
|
|
|
|
for (i = 0; i < this.props.events.length; i++) {
|
|
let mxEv = this.props.events[i];
|
|
let wantTile = true;
|
|
let eventId = mxEv.getId();
|
|
let readMarkerInMels = false;
|
|
|
|
if (!EventTile.haveTileForEvent(mxEv)) {
|
|
wantTile = false;
|
|
}
|
|
|
|
let last = (i == lastShownEventIndex);
|
|
|
|
// Wrap consecutive member events in a ListSummary, ignore if redacted
|
|
if (isMembershipChange(mxEv) &&
|
|
EventTile.haveTileForEvent(mxEv) &&
|
|
!mxEv.isRedacted()
|
|
) {
|
|
let ts1 = mxEv.getTs();
|
|
// Ensure that the key of the MemberEventListSummary does not change with new
|
|
// member events. This will prevent it from being re-created unnecessarily, and
|
|
// instead will allow new props to be provided. In turn, the shouldComponentUpdate
|
|
// method on MELS can be used to prevent unnecessary renderings.
|
|
//
|
|
// Whilst back-paginating with a MELS at the top of the panel, prevEvent will be null,
|
|
// so use the key "membereventlistsummary-initial". Otherwise, use the ID of the first
|
|
// membership event, which will not change during forward pagination.
|
|
const key = "membereventlistsummary-" + (prevEvent ? mxEv.getId() : "initial");
|
|
|
|
if (this._wantsDateSeparator(prevEvent, mxEv.getDate())) {
|
|
let dateSeparator = <li key={ts1+'~'}><DateSeparator key={ts1+'~'} ts={ts1}/></li>;
|
|
ret.push(dateSeparator);
|
|
}
|
|
|
|
let summarisedEvents = [mxEv];
|
|
for (;i + 1 < this.props.events.length; i++) {
|
|
let collapsedMxEv = this.props.events[i + 1];
|
|
|
|
// Ignore redacted member events
|
|
if (!EventTile.haveTileForEvent(collapsedMxEv)) {
|
|
continue;
|
|
}
|
|
|
|
if (!isMembershipChange(collapsedMxEv) ||
|
|
this._wantsDateSeparator(this.props.events[i], collapsedMxEv.getDate())) {
|
|
break;
|
|
}
|
|
summarisedEvents.push(collapsedMxEv);
|
|
}
|
|
// At this point, i = the index of the last event in the summary sequence
|
|
|
|
let eventTiles = summarisedEvents.map(
|
|
(e) => {
|
|
if (e.getId() === this.props.readMarkerEventId) {
|
|
readMarkerInMels = true;
|
|
}
|
|
// In order to prevent DateSeparators from appearing in the expanded form
|
|
// of MemberEventListSummary, render each member event as if the previous
|
|
// one was itself. This way, the timestamp of the previous event === the
|
|
// timestamp of the current event, and no DateSeperator is inserted.
|
|
let ret = this._getTilesForEvent(e, e);
|
|
prevEvent = e;
|
|
return ret;
|
|
}
|
|
).reduce((a, b) => a.concat(b));
|
|
|
|
if (eventTiles.length === 0) {
|
|
eventTiles = null;
|
|
}
|
|
|
|
ret.push(
|
|
<MemberEventListSummary
|
|
key={key}
|
|
events={summarisedEvents}
|
|
onToggle={this._onWidgetLoad} // Update scroll state
|
|
>
|
|
{eventTiles}
|
|
</MemberEventListSummary>
|
|
);
|
|
|
|
if (readMarkerInMels) {
|
|
ret.push(this._getReadMarkerTile(visible));
|
|
}
|
|
|
|
continue;
|
|
}
|
|
|
|
if (wantTile) {
|
|
// make sure we unpack the array returned by _getTilesForEvent,
|
|
// otherwise react will auto-generate keys and we will end up
|
|
// replacing all of the DOM elements every time we paginate.
|
|
ret.push(...this._getTilesForEvent(prevEvent, mxEv, last));
|
|
prevEvent = mxEv;
|
|
}
|
|
|
|
var isVisibleReadMarker = false;
|
|
|
|
if (eventId == this.props.readMarkerEventId) {
|
|
var visible = this.props.readMarkerVisible;
|
|
|
|
// if the read marker comes at the end of the timeline (except
|
|
// for local echoes, which are excluded from RMs, because they
|
|
// don't have useful event ids), we don't want to show it, but
|
|
// we still want to create the <li/> for it so that the
|
|
// algorithms which depend on its position on the screen aren't
|
|
// confused.
|
|
if (i >= lastShownNonLocalEchoIndex) {
|
|
visible = false;
|
|
}
|
|
ret.push(this._getReadMarkerTile(visible));
|
|
readMarkerVisible = visible;
|
|
isVisibleReadMarker = visible;
|
|
}
|
|
|
|
// XXX: there should be no need for a ghost tile - we should just use a
|
|
// a dispatch (user_activity_end) to start the RM animation.
|
|
if (eventId == this.currentGhostEventId) {
|
|
// if we're showing an animation, continue to show it.
|
|
ret.push(this._getReadMarkerGhostTile());
|
|
} else if (!isVisibleReadMarker &&
|
|
eventId == this.currentReadMarkerEventId) {
|
|
// there is currently a read-up-to marker at this point, but no
|
|
// more. Show an animation of it disappearing.
|
|
ret.push(this._getReadMarkerGhostTile());
|
|
this.currentGhostEventId = eventId;
|
|
}
|
|
}
|
|
|
|
this.currentReadMarkerEventId = readMarkerVisible ? this.props.readMarkerEventId : null;
|
|
return ret;
|
|
},
|
|
|
|
_getTilesForEvent: function(prevEvent, mxEv, last) {
|
|
var EventTile = sdk.getComponent('rooms.EventTile');
|
|
var DateSeparator = sdk.getComponent('messages.DateSeparator');
|
|
var ret = [];
|
|
|
|
// is this a continuation of the previous message?
|
|
var continuation = false;
|
|
|
|
if (prevEvent !== null
|
|
&& prevEvent.sender && mxEv.sender
|
|
&& mxEv.sender.userId === prevEvent.sender.userId
|
|
&& mxEv.getType() == prevEvent.getType()) {
|
|
continuation = true;
|
|
}
|
|
|
|
/*
|
|
// Work out if this is still a continuation, as we are now showing commands
|
|
// and /me messages with their own little avatar. The case of a change of
|
|
// event type (commands) is handled above, but we need to handle the /me
|
|
// messages seperately as they have a msgtype of 'm.emote' but are classed
|
|
// as normal messages
|
|
if (prevEvent !== null && prevEvent.sender && mxEv.sender
|
|
&& mxEv.sender.userId === prevEvent.sender.userId
|
|
&& mxEv.getType() == prevEvent.getType()
|
|
&& prevEvent.getContent().msgtype === 'm.emote') {
|
|
continuation = false;
|
|
}
|
|
*/
|
|
|
|
// local echoes have a fake date, which could even be yesterday. Treat them
|
|
// as 'today' for the date separators.
|
|
var ts1 = mxEv.getTs();
|
|
var eventDate = mxEv.getDate();
|
|
if (mxEv.status) {
|
|
eventDate = new Date();
|
|
ts1 = eventDate.getTime();
|
|
}
|
|
|
|
// do we need a date separator since the last event?
|
|
if (this._wantsDateSeparator(prevEvent, eventDate)) {
|
|
var dateSeparator = <li key={ts1}><DateSeparator key={ts1} ts={ts1}/></li>;
|
|
ret.push(dateSeparator);
|
|
continuation = false;
|
|
}
|
|
|
|
var eventId = mxEv.getId();
|
|
var highlight = (eventId == this.props.highlightedEventId);
|
|
|
|
// we can't use local echoes as scroll tokens, because their event IDs change.
|
|
// Local echos have a send "status".
|
|
var scrollToken = mxEv.status ? undefined : eventId;
|
|
|
|
var readReceipts;
|
|
if (this.props.manageReadReceipts) {
|
|
readReceipts = this._getReadReceiptsForEvent(mxEv);
|
|
}
|
|
|
|
ret.push(
|
|
<li key={eventId}
|
|
ref={this._collectEventNode.bind(this, eventId)}
|
|
data-scroll-tokens={scrollToken}>
|
|
<EventTile mxEvent={mxEv} continuation={continuation}
|
|
isRedacted={mxEv.isRedacted()}
|
|
onWidgetLoad={this._onWidgetLoad}
|
|
readReceipts={readReceipts}
|
|
readReceiptMap={this._readReceiptMap}
|
|
showUrlPreview={this.props.showUrlPreview}
|
|
checkUnmounting={this._isUnmounting}
|
|
eventSendStatus={mxEv.status}
|
|
tileShape={this.props.tileShape}
|
|
last={last} isSelectedEvent={highlight}/>
|
|
</li>
|
|
);
|
|
|
|
return ret;
|
|
},
|
|
|
|
_wantsDateSeparator: function(prevEvent, nextEventDate) {
|
|
if (prevEvent == null) {
|
|
// first event in the panel: depends if we could back-paginate from
|
|
// here.
|
|
return !this.props.suppressFirstDateSeparator;
|
|
}
|
|
const prevEventDate = prevEvent.getDate();
|
|
if (!nextEventDate || !prevEventDate) {
|
|
return false;
|
|
}
|
|
// Return early for events that are > 24h apart
|
|
if (Math.abs(prevEvent.getTs() - nextEventDate.getTime()) > MILLIS_IN_DAY) {
|
|
return true;
|
|
}
|
|
|
|
// Compare weekdays
|
|
return prevEventDate.getDay() !== nextEventDate.getDay();
|
|
},
|
|
|
|
// get a list of read receipts that should be shown next to this event
|
|
// Receipts are objects which have a 'roomMember' and 'ts'.
|
|
_getReadReceiptsForEvent: function(event) {
|
|
const myUserId = MatrixClientPeg.get().credentials.userId;
|
|
|
|
// get list of read receipts, sorted most recent first
|
|
const room = MatrixClientPeg.get().getRoom(event.getRoomId());
|
|
if (!room) {
|
|
return null;
|
|
}
|
|
let receipts = [];
|
|
room.getReceiptsForEvent(event).forEach((r) => {
|
|
if (!r.userId || r.type !== "m.read" || r.userId === myUserId) {
|
|
return; // ignore non-read receipts and receipts from self.
|
|
}
|
|
let member = room.getMember(r.userId);
|
|
if (!member) {
|
|
return; // ignore unknown user IDs
|
|
}
|
|
receipts.push({
|
|
roomMember: member,
|
|
ts: r.data ? r.data.ts : 0,
|
|
});
|
|
});
|
|
|
|
return receipts.sort((r1, r2) => {
|
|
return r2.ts - r1.ts;
|
|
});
|
|
},
|
|
|
|
_getReadMarkerTile: function(visible) {
|
|
var hr;
|
|
if (visible) {
|
|
hr = <hr className="mx_RoomView_myReadMarker"
|
|
style={{opacity: 1, width: '99%'}}
|
|
/>;
|
|
}
|
|
|
|
return (
|
|
<li key="_readupto" ref="readMarkerNode"
|
|
className="mx_RoomView_myReadMarker_container">
|
|
{hr}
|
|
</li>
|
|
);
|
|
},
|
|
|
|
_startAnimation: function(ghostNode) {
|
|
if (this._readMarkerGhostNode) {
|
|
Velocity.Utilities.removeData(this._readMarkerGhostNode);
|
|
}
|
|
this._readMarkerGhostNode = ghostNode;
|
|
|
|
if (ghostNode) {
|
|
Velocity(ghostNode, {opacity: '0', width: '10%'},
|
|
{duration: 400, easing: 'easeInSine',
|
|
delay: 1000});
|
|
}
|
|
},
|
|
|
|
_getReadMarkerGhostTile: function() {
|
|
var hr = <hr className="mx_RoomView_myReadMarker"
|
|
style={{opacity: 1, width: '99%'}}
|
|
ref={this._startAnimation}
|
|
/>;
|
|
|
|
// give it a key which depends on the event id. That will ensure that
|
|
// we get a new DOM node (restarting the animation) when the ghost
|
|
// moves to a different event.
|
|
return (
|
|
<li key={"_readuptoghost_"+this.currentGhostEventId}
|
|
className="mx_RoomView_myReadMarker_container">
|
|
{hr}
|
|
</li>
|
|
);
|
|
},
|
|
|
|
_collectEventNode: function(eventId, node) {
|
|
this.eventNodes[eventId] = node;
|
|
},
|
|
|
|
// once dynamic content in the events load, make the scrollPanel check the
|
|
// scroll offsets.
|
|
_onWidgetLoad: function() {
|
|
var scrollPanel = this.refs.scrollPanel;
|
|
if (scrollPanel) {
|
|
scrollPanel.forceUpdate();
|
|
}
|
|
},
|
|
|
|
onResize: function() {
|
|
dis.dispatch({ action: 'timeline_resize' }, true);
|
|
},
|
|
|
|
render: function() {
|
|
var ScrollPanel = sdk.getComponent("structures.ScrollPanel");
|
|
var Spinner = sdk.getComponent("elements.Spinner");
|
|
var topSpinner, bottomSpinner;
|
|
if (this.props.backPaginating) {
|
|
topSpinner = <li key="_topSpinner"><Spinner /></li>;
|
|
}
|
|
if (this.props.forwardPaginating) {
|
|
bottomSpinner = <li key="_bottomSpinner"><Spinner /></li>;
|
|
}
|
|
|
|
var style = this.props.hidden ? { display: 'none' } : {};
|
|
style.opacity = this.props.opacity;
|
|
|
|
return (
|
|
<ScrollPanel ref="scrollPanel" className={ this.props.className + " mx_fadable" }
|
|
onScroll={ this.props.onScroll }
|
|
onResize={ this.onResize }
|
|
onFillRequest={ this.props.onFillRequest }
|
|
onUnfillRequest={ this.props.onUnfillRequest }
|
|
style={ style }
|
|
stickyBottom={ this.props.stickyBottom }>
|
|
{topSpinner}
|
|
{this._getEventTiles()}
|
|
{bottomSpinner}
|
|
</ScrollPanel>
|
|
);
|
|
},
|
|
});
|