/* Copyright 2015 OpenMarket Ltd Copyright 2017 Vector Creations 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 "EventFormatter.h" #import "RiotDesignValues.h" #import "Riot-Swift.h" #import "WidgetManager.h" #import "MXDecryptionResult.h" #import "DecryptionFailureTracker.h" #pragma mark - Constants definitions NSString *const kEventFormatterOnReRequestKeysLinkAction = @"kEventFormatterOnReRequestKeysLinkAction"; NSString *const kEventFormatterOnReRequestKeysLinkActionSeparator = @"/"; @interface EventFormatter () { /** The calendar used to retrieve the today date. */ NSCalendar *calendar; } @end @implementation EventFormatter - (NSAttributedString *)attributedStringFromEvent:(MXEvent *)event withRoomState:(MXRoomState *)roomState error:(MXKEventFormatterError *)error { // Build strings for widget events if (event.eventType == MXEventTypeCustom && ([event.type isEqualToString:kWidgetMatrixEventTypeString] || [event.type isEqualToString:kWidgetModularEventTypeString])) { NSString *displayText; Widget *widget = [[Widget alloc] initWithWidgetEvent:event inMatrixSession:mxSession]; if (widget) { // Prepare the display name of the sender NSString *senderDisplayName = roomState ? [self senderDisplayNameForEvent:event withRoomState:roomState] : event.sender; if (widget.isActive) { if ([widget.type isEqualToString:kWidgetTypeJitsi]) { // This is an alive jitsi widget displayText = [NSString stringWithFormat:NSLocalizedStringFromTable(@"event_formatter_jitsi_widget_added", @"Vector", nil), senderDisplayName]; } else { displayText = [NSString stringWithFormat:NSLocalizedStringFromTable(@"event_formatter_widget_added", @"Vector", nil), widget.name ? widget.name : widget.type, senderDisplayName]; } } else { // This is a closed widget // Check if it corresponds to a jitsi widget by looking at other state events for // this jitsi widget (widget id = event.stateKey). // Get all widgets state events in the room NSMutableArray *widgetStateEvents = [NSMutableArray arrayWithArray:[roomState stateEventsWithType:kWidgetMatrixEventTypeString]]; [widgetStateEvents addObjectsFromArray:[roomState stateEventsWithType:kWidgetModularEventTypeString]]; for (MXEvent *widgetStateEvent in widgetStateEvents) { if ([widgetStateEvent.stateKey isEqualToString:widget.widgetId]) { Widget *activeWidget = [[Widget alloc] initWithWidgetEvent:widgetStateEvent inMatrixSession:mxSession]; if (activeWidget.isActive) { if ([activeWidget.type isEqualToString:kWidgetTypeJitsi]) { // This was a jitsi widget displayText = [NSString stringWithFormat:NSLocalizedStringFromTable(@"event_formatter_jitsi_widget_removed", @"Vector", nil), senderDisplayName]; } else { displayText = [NSString stringWithFormat:NSLocalizedStringFromTable(@"event_formatter_widget_removed", @"Vector", nil), activeWidget.name ? activeWidget.name : activeWidget.type, senderDisplayName]; } break; } } } } } if (displayText) { if (error) { *error = MXKEventFormatterErrorNone; } // Build the attributed string with the right font and color for the events return [self renderString:displayText forEvent:event]; } } if (event.eventType == MXEventTypeRoomCreate) { MXRoomCreateContent *createContent = [MXRoomCreateContent modelFromJSON:event.content]; NSString *roomPredecessorId = createContent.roomPredecessorInfo.roomId; if (roomPredecessorId) { return [self roomCreatePredecessorAttributedStringWithPredecessorRoomId:roomPredecessorId]; } else { return nil; } } NSAttributedString *attributedString = [super attributedStringFromEvent:event withRoomState:roomState error:error]; if (event.sentState == MXEventSentStateSent && [event.decryptionError.domain isEqualToString:MXDecryptingErrorDomain]) { // Track e2e failures dispatch_async(dispatch_get_main_queue(), ^{ [[DecryptionFailureTracker sharedInstance] reportUnableToDecryptErrorForEvent:event withRoomState:roomState myUser:mxSession.myUser.userId]; }); if (event.decryptionError.code == MXDecryptingErrorUnknownInboundSessionIdCode) { // Append to the displayed error an attibuted string with a tappable link // so that the user can try to fix the UTD NSMutableAttributedString *attributedStringWithRerequestMessage = [attributedString mutableCopy]; [attributedStringWithRerequestMessage appendAttributedString:[[NSAttributedString alloc] initWithString:@"\n"]]; NSString *linkActionString = [NSString stringWithFormat:@"%@%@%@", kEventFormatterOnReRequestKeysLinkAction, kEventFormatterOnReRequestKeysLinkActionSeparator, event.eventId]; [attributedStringWithRerequestMessage appendAttributedString: [[NSAttributedString alloc] initWithString:NSLocalizedStringFromTable(@"event_formatter_rerequest_keys_part1_link", @"Vector", nil) attributes:@{ NSLinkAttributeName: linkActionString, NSForegroundColorAttributeName: self.sendingTextColor, NSFontAttributeName: self.encryptedMessagesTextFont }]]; [attributedStringWithRerequestMessage appendAttributedString: [[NSAttributedString alloc] initWithString:NSLocalizedStringFromTable(@"event_formatter_rerequest_keys_part2", @"Vector", nil) attributes:@{ NSForegroundColorAttributeName: self.sendingTextColor, NSFontAttributeName: self.encryptedMessagesTextFont }]]; attributedString = attributedStringWithRerequestMessage; } } return attributedString; } - (NSAttributedString*)attributedStringFromEvents:(NSArray*)events withRoomState:(MXRoomState*)roomState error:(MXKEventFormatterError*)error { NSString *displayText; if (events.count) { if (events[0].eventType == MXEventTypeRoomMember) { // This is a series for cells tagged with RoomBubbleCellDataTagMembership // TODO: Build a complete summary like Riot-web displayText = [NSString stringWithFormat:NSLocalizedStringFromTable(@"event_formatter_member_updates", @"Vector", nil), events.count]; } } if (displayText) { // Build the attributed string with the right font and color for the events return [self renderString:displayText forEvent:events[0]]; } return [super attributedStringFromEvents:events withRoomState:roomState error:error]; } - (instancetype)initWithMatrixSession:(MXSession *)matrixSession { self = [super initWithMatrixSession:matrixSession]; if (self) { calendar = [[NSCalendar alloc] initWithCalendarIdentifier:NSCalendarIdentifierGregorian]; // Use the secondary bg color to set the background color in the default CSS. NSUInteger bgColor = [MXKTools rgbValueWithColor:RiotDesignValues.theme.headerBackgroundColor]; self.defaultCSS = [NSString stringWithFormat:@" \ pre,code { \ background-color: #%06lX; \ display: inline; \ font-family: monospace; \ white-space: pre; \ -coretext-fontname: Menlo-Regular; \ font-size: small; \ }", (unsigned long)bgColor]; self.defaultTextColor = kRiotPrimaryTextColor; self.subTitleTextColor = kRiotSecondaryTextColor; self.prefixTextColor = kRiotSecondaryTextColor; self.bingTextColor = RiotDesignValues.theme.notificationMentionColor; self.encryptingTextColor = RiotDesignValues.theme.tintColor; self.sendingTextColor = kRiotSecondaryTextColor; self.errorTextColor = kRiotColorRed; self.defaultTextFont = [UIFont systemFontOfSize:15]; self.prefixTextFont = [UIFont boldSystemFontOfSize:15]; if ([UIFont respondsToSelector:@selector(systemFontOfSize:weight:)]) { self.bingTextFont = [UIFont systemFontOfSize:15 weight:UIFontWeightMedium]; } else { self.bingTextFont = [UIFont systemFontOfSize:15]; } self.stateEventTextFont = [UIFont italicSystemFontOfSize:15]; self.callNoticesTextFont = [UIFont italicSystemFontOfSize:15]; self.encryptedMessagesTextFont = [UIFont italicSystemFontOfSize:15]; self.emojiOnlyTextFont = [UIFont systemFontOfSize:48]; } return self; } - (NSDictionary*)stringAttributesForEventTimestamp { return @{ NSForegroundColorAttributeName : [UIColor lightGrayColor], NSFontAttributeName: [UIFont systemFontOfSize:10] }; } #pragma mark event sender info - (NSString*)senderAvatarUrlForEvent:(MXEvent*)event withRoomState:(MXRoomState*)roomState { // Override this method to ignore the identicons defined by default in matrix kit. // Consider first the avatar url defined in provided room state (Note: this room state is supposed to not take the new event into account) NSString *senderAvatarUrl = [roomState.members memberWithUserId:event.sender].avatarUrl; // Check whether this avatar url is updated by the current event (This happens in case of new joined member) NSString* membership = event.content[@"membership"]; if (membership && [membership isEqualToString:@"join"] && [event.content[@"avatar_url"] length]) { // Use the actual avatar senderAvatarUrl = event.content[@"avatar_url"]; } // We ignore non mxc avatar url (The identicons are removed here). if (senderAvatarUrl && [senderAvatarUrl hasPrefix:kMXContentUriScheme] == NO) { senderAvatarUrl = nil; } return senderAvatarUrl; } #pragma mark - Timestamp formatting - (NSString*)dateStringFromDate:(NSDate *)date withTime:(BOOL)time { // Check the provided date if (!date) { return nil; } // Retrieve today date at midnight NSDate *today = [calendar startOfDayForDate:[NSDate date]]; NSTimeInterval interval = -[date timeIntervalSinceDate:today]; if (interval > 60*60*24*364) { [dateFormatter setDateFormat:@"MMM dd yyyy"]; // Ignore time information here return [super dateStringFromDate:date withTime:NO]; } else if (interval > 60*60*24*6) { [dateFormatter setDateFormat:@"MMM dd"]; // Ignore time information here return [super dateStringFromDate:date withTime:NO]; } else if (interval > 60*60*24) { if (time) { [dateFormatter setDateFormat:@"EEE"]; } else { [dateFormatter setDateFormat:@"EEEE"]; } return [super dateStringFromDate:date withTime:time]; } else if (interval > 0) { if (time) { [dateFormatter setDateFormat:nil]; return [NSString stringWithFormat:@"%@ %@", NSLocalizedStringFromTable(@"yesterday", @"Vector", nil), [super dateStringFromDate:date withTime:YES]]; } return NSLocalizedStringFromTable(@"yesterday", @"Vector", nil); } else if (interval > - 60*60*24) { if (time) { [dateFormatter setDateFormat:nil]; return [NSString stringWithFormat:@"%@", [super dateStringFromDate:date withTime:YES]]; } return NSLocalizedStringFromTable(@"today", @"Vector", nil); } else { // Date in future [dateFormatter setDateFormat:@"EEE MMM dd yyyy"]; return [super dateStringFromDate:date withTime:time]; } } #pragma mark - Room create predecessor - (NSAttributedString*)roomCreatePredecessorAttributedStringWithPredecessorRoomId:(NSString*)predecessorRoomId { NSString *predecessorRoomPermalink = [MXTools permalinkToRoom:predecessorRoomId]; NSDictionary *roomPredecessorReasonAttributes = @{ NSFontAttributeName : self.defaultTextFont }; NSDictionary *roomLinkAttributes = @{ NSFontAttributeName : self.defaultTextFont, NSUnderlineStyleAttributeName : @(NSUnderlineStyleSingle), NSLinkAttributeName : predecessorRoomPermalink, }; NSMutableAttributedString *roomPredecessorAttributedString = [NSMutableAttributedString new]; NSString *roomPredecessorReasonString = [NSString stringWithFormat:@"%@\n", NSLocalizedStringFromTable(@"room_predecessor_information", @"Vector", nil)]; NSAttributedString *roomPredecessorReasonAttributedString = [[NSAttributedString alloc] initWithString:roomPredecessorReasonString attributes:roomPredecessorReasonAttributes]; NSString *predecessorRoomLinkString = NSLocalizedStringFromTable(@"room_predecessor_link", @"Vector", nil); NSAttributedString *predecessorRoomLinkAttributedString = [[NSAttributedString alloc] initWithString:predecessorRoomLinkString attributes:roomLinkAttributes]; [roomPredecessorAttributedString appendAttributedString:roomPredecessorReasonAttributedString]; [roomPredecessorAttributedString appendAttributedString:predecessorRoomLinkAttributedString]; NSRange wholeStringRange = NSMakeRange(0, roomPredecessorAttributedString.length); [roomPredecessorAttributedString addAttribute:NSForegroundColorAttributeName value:self.defaultTextColor range:wholeStringRange]; return roomPredecessorAttributedString; } @end