453 lines
		
	
	
		
			19 KiB
		
	
	
	
		
			JavaScript
		
	
	
			
		
		
	
	
			453 lines
		
	
	
		
			19 KiB
		
	
	
	
		
			JavaScript
		
	
	
| /*
 | |
| 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 MatrixClientPeg from './MatrixClientPeg';
 | |
| import CallHandler from './CallHandler';
 | |
| import { _t } from './languageHandler';
 | |
| import * as Roles from './Roles';
 | |
| 
 | |
| function textForMemberEvent(ev) {
 | |
|     // XXX: SYJS-16 "sender is sometimes null for join messages"
 | |
|     const senderName = ev.sender ? ev.sender.name : ev.getSender();
 | |
|     const targetName = ev.target ? ev.target.name : ev.getStateKey();
 | |
|     const prevContent = ev.getPrevContent();
 | |
|     const content = ev.getContent();
 | |
| 
 | |
|     const ConferenceHandler = CallHandler.getConferenceHandler();
 | |
|     const reason = content.reason ? (_t('Reason') + ': ' + content.reason) : '';
 | |
|     switch (content.membership) {
 | |
|         case 'invite': {
 | |
|             const threePidContent = content.third_party_invite;
 | |
|             if (threePidContent) {
 | |
|                 if (threePidContent.display_name) {
 | |
|                     return _t('%(targetName)s accepted the invitation for %(displayName)s.', {
 | |
|                         targetName,
 | |
|                         displayName: threePidContent.display_name,
 | |
|                     });
 | |
|                 } else {
 | |
|                     return _t('%(targetName)s accepted an invitation.', {targetName});
 | |
|                 }
 | |
|             } else {
 | |
|                 if (ConferenceHandler && ConferenceHandler.isConferenceUser(ev.getStateKey())) {
 | |
|                     return _t('%(senderName)s requested a VoIP conference.', {senderName});
 | |
|                 } else {
 | |
|                     return _t('%(senderName)s invited %(targetName)s.', {senderName, targetName});
 | |
|                 }
 | |
|             }
 | |
|         }
 | |
|         case 'ban':
 | |
|             return _t('%(senderName)s banned %(targetName)s.', {senderName, targetName}) + ' ' + reason;
 | |
|         case 'join':
 | |
|             if (prevContent && prevContent.membership === 'join') {
 | |
|                 if (prevContent.displayname && content.displayname && prevContent.displayname !== content.displayname) {
 | |
|                     return _t('%(oldDisplayName)s changed their display name to %(displayName)s.', {
 | |
|                         oldDisplayName: prevContent.displayname,
 | |
|                         displayName: content.displayname,
 | |
|                     });
 | |
|                 } else if (!prevContent.displayname && content.displayname) {
 | |
|                     return _t('%(senderName)s set their display name to %(displayName)s.', {
 | |
|                         senderName: ev.getSender(),
 | |
|                         displayName: content.displayname,
 | |
|                     });
 | |
|                 } else if (prevContent.displayname && !content.displayname) {
 | |
|                     return _t('%(senderName)s removed their display name (%(oldDisplayName)s).', {
 | |
|                         senderName,
 | |
|                         oldDisplayName: prevContent.displayname,
 | |
|                     });
 | |
|                 } else if (prevContent.avatar_url && !content.avatar_url) {
 | |
|                     return _t('%(senderName)s removed their profile picture.', {senderName});
 | |
|                 } else if (prevContent.avatar_url && content.avatar_url &&
 | |
|                     prevContent.avatar_url !== content.avatar_url) {
 | |
|                     return _t('%(senderName)s changed their profile picture.', {senderName});
 | |
|                 } else if (!prevContent.avatar_url && content.avatar_url) {
 | |
|                     return _t('%(senderName)s set a profile picture.', {senderName});
 | |
|                 } else {
 | |
|                     // suppress null rejoins
 | |
|                     return '';
 | |
|                 }
 | |
|             } else {
 | |
|                 if (!ev.target) console.warn("Join message has no target! -- " + ev.getContent().state_key);
 | |
|                 if (ConferenceHandler && ConferenceHandler.isConferenceUser(ev.getStateKey())) {
 | |
|                     return _t('VoIP conference started.');
 | |
|                 } else {
 | |
|                     return _t('%(targetName)s joined the room.', {targetName});
 | |
|                 }
 | |
|             }
 | |
|         case 'leave':
 | |
|             if (ev.getSender() === ev.getStateKey()) {
 | |
|                 if (ConferenceHandler && ConferenceHandler.isConferenceUser(ev.getStateKey())) {
 | |
|                     return _t('VoIP conference finished.');
 | |
|                 } else if (prevContent.membership === "invite") {
 | |
|                     return _t('%(targetName)s rejected the invitation.', {targetName});
 | |
|                 } else {
 | |
|                     return _t('%(targetName)s left the room.', {targetName});
 | |
|                 }
 | |
|             } else if (prevContent.membership === "ban") {
 | |
|                 return _t('%(senderName)s unbanned %(targetName)s.', {senderName, targetName});
 | |
|             } else if (prevContent.membership === "join") {
 | |
|                 return _t('%(senderName)s kicked %(targetName)s.', {senderName, targetName}) + ' ' + reason;
 | |
|             } else if (prevContent.membership === "invite") {
 | |
|                 return _t('%(senderName)s withdrew %(targetName)s\'s invitation.', {
 | |
|                     senderName,
 | |
|                     targetName,
 | |
|                 }) + ' ' + reason;
 | |
|             } else {
 | |
|                 return _t('%(targetName)s left the room.', {targetName});
 | |
|             }
 | |
|     }
 | |
| }
 | |
| 
 | |
| function textForTopicEvent(ev) {
 | |
|     const senderDisplayName = ev.sender && ev.sender.name ? ev.sender.name : ev.getSender();
 | |
|     return _t('%(senderDisplayName)s changed the topic to "%(topic)s".', {
 | |
|         senderDisplayName,
 | |
|         topic: ev.getContent().topic,
 | |
|     });
 | |
| }
 | |
| 
 | |
| function textForRoomNameEvent(ev) {
 | |
|     const senderDisplayName = ev.sender && ev.sender.name ? ev.sender.name : ev.getSender();
 | |
| 
 | |
|     if (!ev.getContent().name || ev.getContent().name.trim().length === 0) {
 | |
|         return _t('%(senderDisplayName)s removed the room name.', {senderDisplayName});
 | |
|     }
 | |
|     return _t('%(senderDisplayName)s changed the room name to %(roomName)s.', {
 | |
|         senderDisplayName,
 | |
|         roomName: ev.getContent().name,
 | |
|     });
 | |
| }
 | |
| 
 | |
| function textForTombstoneEvent(ev) {
 | |
|     const senderDisplayName = ev.sender && ev.sender.name ? ev.sender.name : ev.getSender();
 | |
|     return _t('%(senderDisplayName)s upgraded this room.', {senderDisplayName});
 | |
| }
 | |
| 
 | |
| function textForServerACLEvent(ev) {
 | |
|     const senderDisplayName = ev.sender && ev.sender.name ? ev.sender.name : ev.getSender();
 | |
|     const prevContent = ev.getPrevContent();
 | |
|     const changes = [];
 | |
|     const current = ev.getContent();
 | |
|     const prev = {
 | |
|         deny: Array.isArray(prevContent.deny) ? prevContent.deny : [],
 | |
|         allow: Array.isArray(prevContent.allow) ? prevContent.allow : [],
 | |
|         allow_ip_literals: !(prevContent.allow_ip_literals === false),
 | |
|     };
 | |
|     let text = "";
 | |
|     if (prev.deny.length === 0 && prev.allow.length === 0) {
 | |
|         text = `${senderDisplayName} set server ACLs for this room: `;
 | |
|     } else {
 | |
|         text = `${senderDisplayName} changed the server ACLs for this room: `;
 | |
|     }
 | |
| 
 | |
|     if (!Array.isArray(current.allow)) {
 | |
|         current.allow = [];
 | |
|     }
 | |
|     /* If we know for sure everyone is banned, don't bother showing the diff view */
 | |
|     if (current.allow.length === 0) {
 | |
|         return text + "🎉 All servers are banned from participating! This room can no longer be used.";
 | |
|     }
 | |
| 
 | |
|     if (!Array.isArray(current.deny)) {
 | |
|         current.deny = [];
 | |
|     }
 | |
| 
 | |
|     const bannedServers = current.deny.filter((srv) => typeof(srv) === 'string' && !prev.deny.includes(srv));
 | |
|     const unbannedServers = prev.deny.filter((srv) => typeof(srv) === 'string' && !current.deny.includes(srv));
 | |
|     const allowedServers = current.allow.filter((srv) => typeof(srv) === 'string' && !prev.allow.includes(srv));
 | |
|     const unallowedServers = prev.allow.filter((srv) => typeof(srv) === 'string' && !current.allow.includes(srv));
 | |
| 
 | |
|     if (bannedServers.length > 0) {
 | |
|         changes.push(`Servers matching ${bannedServers.join(", ")} are now banned.`);
 | |
|     }
 | |
| 
 | |
|     if (unbannedServers.length > 0) {
 | |
|         changes.push(`Servers matching ${unbannedServers.join(", ")} were removed from the ban list.`);
 | |
|     }
 | |
| 
 | |
|     if (allowedServers.length > 0) {
 | |
|         changes.push(`Servers matching ${allowedServers.join(", ")} are now allowed.`);
 | |
|     }
 | |
| 
 | |
|     if (unallowedServers.length > 0) {
 | |
|         changes.push(`Servers matching ${unallowedServers.join(", ")} were removed from the allowed list.`);
 | |
|     }
 | |
| 
 | |
|     if (prev.allow_ip_literals !== current.allow_ip_literals) {
 | |
|         const allowban = current.allow_ip_literals ? "allowed" : "banned";
 | |
|         changes.push(`Participating from a server using an IP literal hostname is now ${allowban}.`);
 | |
|     }
 | |
| 
 | |
|     return text + changes.join(" ");
 | |
| }
 | |
| 
 | |
| function textForMessageEvent(ev) {
 | |
|     const senderDisplayName = ev.sender && ev.sender.name ? ev.sender.name : ev.getSender();
 | |
|     let message = senderDisplayName + ': ' + ev.getContent().body;
 | |
|     if (ev.getContent().msgtype === "m.emote") {
 | |
|         message = "* " + senderDisplayName + " " + message;
 | |
|     } else if (ev.getContent().msgtype === "m.image") {
 | |
|         message = _t('%(senderDisplayName)s sent an image.', {senderDisplayName});
 | |
|     }
 | |
|     return message;
 | |
| }
 | |
| 
 | |
| function textForRoomAliasesEvent(ev) {
 | |
|     // An alternative implementation of this as a first-class event can be found at
 | |
|     // https://github.com/matrix-org/matrix-react-sdk/blob/dc7212ec2bd12e1917233ed7153b3e0ef529a135/src/components/views/messages/RoomAliasesEvent.js
 | |
|     // This feels a bit overkill though, and it's not clear the i18n really needs it
 | |
|     // so instead it's landing as a simple textual event.
 | |
| 
 | |
|     const senderName = ev.sender && ev.sender.name ? ev.sender.name : ev.getSender();
 | |
|     const oldAliases = ev.getPrevContent().aliases || [];
 | |
|     const newAliases = ev.getContent().aliases || [];
 | |
| 
 | |
|     const addedAliases = newAliases.filter((x) => !oldAliases.includes(x));
 | |
|     const removedAliases = oldAliases.filter((x) => !newAliases.includes(x));
 | |
| 
 | |
|     if (!addedAliases.length && !removedAliases.length) {
 | |
|         return '';
 | |
|     }
 | |
| 
 | |
|     if (addedAliases.length && !removedAliases.length) {
 | |
|         return _t('%(senderName)s added %(count)s %(addedAddresses)s as addresses for this room.', {
 | |
|             senderName: senderName,
 | |
|             count: addedAliases.length,
 | |
|             addedAddresses: addedAliases.join(', '),
 | |
|         });
 | |
|     } else if (!addedAliases.length && removedAliases.length) {
 | |
|         return _t('%(senderName)s removed %(count)s %(removedAddresses)s as addresses for this room.', {
 | |
|             senderName: senderName,
 | |
|             count: removedAliases.length,
 | |
|             removedAddresses: removedAliases.join(', '),
 | |
|         });
 | |
|     } else {
 | |
|         return _t(
 | |
|             '%(senderName)s added %(addedAddresses)s and removed %(removedAddresses)s as addresses for this room.', {
 | |
|                 senderName: senderName,
 | |
|                 addedAddresses: addedAliases.join(', '),
 | |
|                 removedAddresses: removedAliases.join(', '),
 | |
|             },
 | |
|         );
 | |
|     }
 | |
| }
 | |
| 
 | |
| function textForCanonicalAliasEvent(ev) {
 | |
|     const senderName = ev.sender && ev.sender.name ? ev.sender.name : ev.getSender();
 | |
|     const oldAlias = ev.getPrevContent().alias;
 | |
|     const newAlias = ev.getContent().alias;
 | |
| 
 | |
|     if (newAlias) {
 | |
|         return _t('%(senderName)s set the main address for this room to %(address)s.', {
 | |
|             senderName: senderName,
 | |
|             address: ev.getContent().alias,
 | |
|         });
 | |
|     } else if (oldAlias) {
 | |
|         return _t('%(senderName)s removed the main address for this room.', {
 | |
|             senderName: senderName,
 | |
|         });
 | |
|     }
 | |
| }
 | |
| 
 | |
| function textForCallAnswerEvent(event) {
 | |
|     const senderName = event.sender ? event.sender.name : _t('Someone');
 | |
|     const supported = MatrixClientPeg.get().supportsVoip() ? '' : _t('(not supported by this browser)');
 | |
|     return _t('%(senderName)s answered the call.', {senderName}) + ' ' + supported;
 | |
| }
 | |
| 
 | |
| function textForCallHangupEvent(event) {
 | |
|     const senderName = event.sender ? event.sender.name : _t('Someone');
 | |
|     const eventContent = event.getContent();
 | |
|     let reason = "";
 | |
|     if (!MatrixClientPeg.get().supportsVoip()) {
 | |
|         reason = _t('(not supported by this browser)');
 | |
|     } else if (eventContent.reason) {
 | |
|         if (eventContent.reason === "ice_failed") {
 | |
|             reason = _t('(could not connect media)');
 | |
|         } else if (eventContent.reason === "invite_timeout") {
 | |
|             reason = _t('(no answer)');
 | |
|         } else if (eventContent.reason === "user hangup") {
 | |
|             // workaround for https://github.com/vector-im/riot-web/issues/5178
 | |
|             // it seems Android randomly sets a reason of "user hangup" which is
 | |
|             // interpreted as an error code :(
 | |
|             // https://github.com/vector-im/riot-android/issues/2623
 | |
|             reason = '';
 | |
|         } else {
 | |
|             reason = _t('(unknown failure: %(reason)s)', {reason: eventContent.reason});
 | |
|         }
 | |
|     }
 | |
|     return _t('%(senderName)s ended the call.', {senderName}) + ' ' + reason;
 | |
| }
 | |
| 
 | |
| function textForCallInviteEvent(event) {
 | |
|     const senderName = event.sender ? event.sender.name : _t('Someone');
 | |
|     // FIXME: Find a better way to determine this from the event?
 | |
|     let callType = "voice";
 | |
|     if (event.getContent().offer && event.getContent().offer.sdp &&
 | |
|             event.getContent().offer.sdp.indexOf('m=video') !== -1) {
 | |
|         callType = "video";
 | |
|     }
 | |
|     const supported = MatrixClientPeg.get().supportsVoip() ? "" : _t('(not supported by this browser)');
 | |
|     return _t('%(senderName)s placed a %(callType)s call.', {senderName, callType}) + ' ' + supported;
 | |
| }
 | |
| 
 | |
| function textForThreePidInviteEvent(event) {
 | |
|     const senderName = event.sender ? event.sender.name : event.getSender();
 | |
|     return _t('%(senderName)s sent an invitation to %(targetDisplayName)s to join the room.', {
 | |
|         senderName,
 | |
|         targetDisplayName: event.getContent().display_name,
 | |
|     });
 | |
| }
 | |
| 
 | |
| function textForHistoryVisibilityEvent(event) {
 | |
|     const senderName = event.sender ? event.sender.name : event.getSender();
 | |
|     switch (event.getContent().history_visibility) {
 | |
|         case 'invited':
 | |
|             return _t('%(senderName)s made future room history visible to all room members, '
 | |
|                 + 'from the point they are invited.', {senderName});
 | |
|         case 'joined':
 | |
|             return _t('%(senderName)s made future room history visible to all room members, '
 | |
|                 + 'from the point they joined.', {senderName});
 | |
|         case 'shared':
 | |
|             return _t('%(senderName)s made future room history visible to all room members.', {senderName});
 | |
|         case 'world_readable':
 | |
|             return _t('%(senderName)s made future room history visible to anyone.', {senderName});
 | |
|         default:
 | |
|             return _t('%(senderName)s made future room history visible to unknown (%(visibility)s).', {
 | |
|                 senderName,
 | |
|                 visibility: event.getContent().history_visibility,
 | |
|             });
 | |
|     }
 | |
| }
 | |
| 
 | |
| function textForEncryptionEvent(event) {
 | |
|     const senderName = event.sender ? event.sender.name : event.getSender();
 | |
|     return _t('%(senderName)s turned on end-to-end encryption (algorithm %(algorithm)s).', {
 | |
|         senderName,
 | |
|         algorithm: event.getContent().algorithm,
 | |
|     });
 | |
| }
 | |
| 
 | |
| // Currently will only display a change if a user's power level is changed
 | |
| function textForPowerEvent(event) {
 | |
|     const senderName = event.sender ? event.sender.name : event.getSender();
 | |
|     if (!event.getPrevContent() || !event.getPrevContent().users) {
 | |
|         return '';
 | |
|     }
 | |
|     const userDefault = event.getContent().users_default || 0;
 | |
|     // Construct set of userIds
 | |
|     const users = [];
 | |
|     Object.keys(event.getContent().users).forEach(
 | |
|         (userId) => {
 | |
|             if (users.indexOf(userId) === -1) users.push(userId);
 | |
|         },
 | |
|     );
 | |
|     Object.keys(event.getPrevContent().users).forEach(
 | |
|         (userId) => {
 | |
|             if (users.indexOf(userId) === -1) users.push(userId);
 | |
|         },
 | |
|     );
 | |
|     const diff = [];
 | |
|     // XXX: This is also surely broken for i18n
 | |
|     users.forEach((userId) => {
 | |
|         // Previous power level
 | |
|         const from = event.getPrevContent().users[userId];
 | |
|         // Current power level
 | |
|         const to = event.getContent().users[userId];
 | |
|         if (to !== from) {
 | |
|             diff.push(
 | |
|                 _t('%(userId)s from %(fromPowerLevel)s to %(toPowerLevel)s', {
 | |
|                     userId,
 | |
|                     fromPowerLevel: Roles.textualPowerLevel(from, userDefault),
 | |
|                     toPowerLevel: Roles.textualPowerLevel(to, userDefault),
 | |
|                 }),
 | |
|             );
 | |
|         }
 | |
|     });
 | |
|     if (!diff.length) {
 | |
|         return '';
 | |
|     }
 | |
|     return _t('%(senderName)s changed the power level of %(powerLevelDiffText)s.', {
 | |
|         senderName,
 | |
|         powerLevelDiffText: diff.join(", "),
 | |
|     });
 | |
| }
 | |
| 
 | |
| function textForPinnedEvent(event) {
 | |
|     const senderName = event.getSender();
 | |
|     return _t("%(senderName)s changed the pinned messages for the room.", {senderName});
 | |
| }
 | |
| 
 | |
| function textForWidgetEvent(event) {
 | |
|     const senderName = event.getSender();
 | |
|     const {name: prevName, type: prevType, url: prevUrl} = event.getPrevContent();
 | |
|     const {name, type, url} = event.getContent() || {};
 | |
| 
 | |
|     let widgetName = name || prevName || type || prevType || '';
 | |
|     // Apply sentence case to widget name
 | |
|     if (widgetName && widgetName.length > 0) {
 | |
|         widgetName = widgetName[0].toUpperCase() + widgetName.slice(1) + ' ';
 | |
|     }
 | |
| 
 | |
|     // If the widget was removed, its content should be {}, but this is sufficiently
 | |
|     // equivalent to that condition.
 | |
|     if (url) {
 | |
|         if (prevUrl) {
 | |
|             return _t('%(widgetName)s widget modified by %(senderName)s', {
 | |
|                 widgetName, senderName,
 | |
|             });
 | |
|         } else {
 | |
|             return _t('%(widgetName)s widget added by %(senderName)s', {
 | |
|                 widgetName, senderName,
 | |
|             });
 | |
|         }
 | |
|     } else {
 | |
|         return _t('%(widgetName)s widget removed by %(senderName)s', {
 | |
|             widgetName, senderName,
 | |
|         });
 | |
|     }
 | |
| }
 | |
| 
 | |
| const handlers = {
 | |
|     'm.room.message': textForMessageEvent,
 | |
|     'm.call.invite': textForCallInviteEvent,
 | |
|     'm.call.answer': textForCallAnswerEvent,
 | |
|     'm.call.hangup': textForCallHangupEvent,
 | |
| };
 | |
| 
 | |
| const stateHandlers = {
 | |
|     'm.room.aliases': textForRoomAliasesEvent,
 | |
|     'm.room.canonical_alias': textForCanonicalAliasEvent,
 | |
|     'm.room.name': textForRoomNameEvent,
 | |
|     'm.room.topic': textForTopicEvent,
 | |
|     'm.room.member': textForMemberEvent,
 | |
|     'm.room.third_party_invite': textForThreePidInviteEvent,
 | |
|     'm.room.history_visibility': textForHistoryVisibilityEvent,
 | |
|     'm.room.encryption': textForEncryptionEvent,
 | |
|     'm.room.power_levels': textForPowerEvent,
 | |
|     'm.room.pinned_events': textForPinnedEvent,
 | |
|     'm.room.server_acl': textForServerACLEvent,
 | |
|     'm.room.tombstone': textForTombstoneEvent,
 | |
| 
 | |
|     'im.vector.modular.widgets': textForWidgetEvent,
 | |
| };
 | |
| 
 | |
| module.exports = {
 | |
|     textForEvent: function(ev) {
 | |
|         const handler = (ev.isState() ? stateHandlers : handlers)[ev.getType()];
 | |
|         if (handler) return handler(ev);
 | |
|         return '';
 | |
|     },
 | |
| };
 |