ehealthsolutions/element-x-ios
3
0
Fork 0
mirror of https://github.com/Novaloop-AG/element-x-ios.git synced 2026-11-02 21:33:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Redaction reason (#6098)

Browse Source
This commit is contained in:
Mauro
2026-09-07 18:57:05 +02:00
committed by GitHub
parent 350d47c94a
commit 346a1e8ebb
35 changed files with 381 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files
ElementX/Sources/Generated/Strings.swift
+8
View File
@@ -2992,6 +2992,14 @@ internal nonisolated enum L10n {
internal static var screenRoomChangeRoleUnsavedChangesDescription: String { return L10n.tr("Localizable", "screen_room_change_role_unsaved_changes_description") }
/// Save changes?
internal static var screenRoomChangeRoleUnsavedChangesTitle: String { return L10n.tr("Localizable", "screen_room_change_role_unsaved_changes_title") }
/// Are you sure you wish to remove this message?
internal static var screenRoomConfirmRemovalMessage: String { return L10n.tr("Localizable", "screen_room_confirm_removal_message") }
/// Reason (optional)
internal static var screenRoomConfirmRemovalReasonLabel: String { return L10n.tr("Localizable", "screen_room_confirm_removal_reason_label") }
/// Enter…
internal static var screenRoomConfirmRemovalReasonPlaceholder: String { return L10n.tr("Localizable", "screen_room_confirm_removal_reason_placeholder") }
/// Confirm removal
internal static var screenRoomConfirmRemovalTitle: String { return L10n.tr("Localizable", "screen_room_confirm_removal_title") }
/// Add topic
internal static var screenRoomDetailsAddTopicTitle: String { return L10n.tr("Localizable", "screen_room_details_add_topic_title") }
/// Encrypted
ElementX/Sources/Mocks/Generated/GeneratedMocks.swift
+23 -23
View File
@@ -11988,34 +11988,34 @@ nonisolated class TimelineControllerMock: TimelineControllerProtocol, @unchecked
}
//MARK: - redact
private let redactCallsCountLock = NSLock()
private nonisolated(unsafe) var redactUnderlyingCallsCount = 0
var redactCallsCount: Int {
get { redactCallsCountLock.withLock { redactUnderlyingCallsCount } }
set { redactCallsCountLock.withLock { redactUnderlyingCallsCount = newValue } }
private let redactReasonCallsCountLock = NSLock()
private nonisolated(unsafe) var redactReasonUnderlyingCallsCount = 0
var redactReasonCallsCount: Int {
get { redactReasonCallsCountLock.withLock { redactReasonUnderlyingCallsCount } }
set { redactReasonCallsCountLock.withLock { redactReasonUnderlyingCallsCount = newValue } }
}
var redactCalled: Bool {
return redactCallsCount > 0
var redactReasonCalled: Bool {
return redactReasonCallsCount > 0
}
private let redactReceivedEventOrTransactionIDLock = NSLock()
private nonisolated(unsafe) var redactUnderlyingReceivedEventOrTransactionID: TimelineItemIdentifier.EventOrTransactionID?
var redactReceivedEventOrTransactionID: TimelineItemIdentifier.EventOrTransactionID? {
get { redactReceivedEventOrTransactionIDLock.withLock { redactUnderlyingReceivedEventOrTransactionID } }
set { redactReceivedEventOrTransactionIDLock.withLock { redactUnderlyingReceivedEventOrTransactionID = newValue } }
private let redactReasonReceivedArgumentsLock = NSLock()
private nonisolated(unsafe) var redactReasonUnderlyingReceivedArguments: (eventOrTransactionID: TimelineItemIdentifier.EventOrTransactionID, reason: String?)?
var redactReasonReceivedArguments: (eventOrTransactionID: TimelineItemIdentifier.EventOrTransactionID, reason: String?)? {
get { redactReasonReceivedArgumentsLock.withLock { redactReasonUnderlyingReceivedArguments } }
set { redactReasonReceivedArgumentsLock.withLock { redactReasonUnderlyingReceivedArguments = newValue } }
}
private let redactReceivedInvocationsLock = NSLock()
private nonisolated(unsafe) var redactUnderlyingReceivedInvocations: [TimelineItemIdentifier.EventOrTransactionID] = []
var redactReceivedInvocations: [TimelineItemIdentifier.EventOrTransactionID] {
get { redactReceivedInvocationsLock.withLock { redactUnderlyingReceivedInvocations } }
set { redactReceivedInvocationsLock.withLock { redactUnderlyingReceivedInvocations = newValue } }
private let redactReasonReceivedInvocationsLock = NSLock()
private nonisolated(unsafe) var redactReasonUnderlyingReceivedInvocations: [(eventOrTransactionID: TimelineItemIdentifier.EventOrTransactionID, reason: String?)] = []
var redactReasonReceivedInvocations: [(eventOrTransactionID: TimelineItemIdentifier.EventOrTransactionID, reason: String?)] {
get { redactReasonReceivedInvocationsLock.withLock { redactReasonUnderlyingReceivedInvocations } }
set { redactReasonReceivedInvocationsLock.withLock { redactReasonUnderlyingReceivedInvocations = newValue } }
}
nonisolated(unsafe) var redactClosure: ((TimelineItemIdentifier.EventOrTransactionID) async -> Void)?
nonisolated(unsafe) var redactReasonClosure: ((TimelineItemIdentifier.EventOrTransactionID, String?) async -> Void)?
@concurrent func redact(_ eventOrTransactionID: TimelineItemIdentifier.EventOrTransactionID) async {
redactCallsCountLock.withLock { redactUnderlyingCallsCount += 1 }
redactReceivedEventOrTransactionID = eventOrTransactionID
redactReceivedInvocationsLock.withLock { redactUnderlyingReceivedInvocations.append(eventOrTransactionID) }
await redactClosure?(eventOrTransactionID)
@concurrent func redact(_ eventOrTransactionID: TimelineItemIdentifier.EventOrTransactionID, reason: String?) async {
redactReasonCallsCountLock.withLock { redactReasonUnderlyingCallsCount += 1 }
redactReasonReceivedArguments = (eventOrTransactionID: eventOrTransactionID, reason: reason)
redactReasonReceivedInvocationsLock.withLock { redactReasonUnderlyingReceivedInvocations.append((eventOrTransactionID: eventOrTransactionID, reason: reason)) }
await redactReasonClosure?(eventOrTransactionID, reason)
}
//MARK: - pin
ElementX/Sources/Mocks/TimelineControllerMock.swift
+2 -2
View File
@@ -74,9 +74,9 @@ struct TimelineControllerMockConfiguration {
_ = await timelineProxy.toggleReaction(reaction, to: eventOrTransactionID)
}
redactClosure = { [timelineProxy] eventOrTransactionID in
redactReasonClosure = { [timelineProxy] eventOrTransactionID, reason in
guard let timelineProxy else { return }
_ = await timelineProxy.redact(eventOrTransactionID, reason: nil)
_ = await timelineProxy.redact(eventOrTransactionID, reason: reason)
}
editMessageHtmlIntentionalMentionsClosure = { [weak self] _, message, _, _ in
ElementX/Sources/Other/TestablePreview/TestablePreviewsDictionary.swift
+1
View File
@@ -126,6 +126,7 @@ enum TestablePreviewsDictionary {
"ReadMarkerRoomTimelineView_Previews" : ReadMarkerRoomTimelineView_Previews.self,
"ReadReceiptCell_Previews" : ReadReceiptCell_Previews.self,
"ReadReceiptsSummaryView_Previews" : ReadReceiptsSummaryView_Previews.self,
"RedactConfirmationView_Previews" : RedactConfirmationView_Previews.self,
"RedactedRoomTimelineView_Previews" : RedactedRoomTimelineView_Previews.self,
"ReportContentScreen_Previews" : ReportContentScreen_Previews.self,
"ReportRoomScreen_Previews" : ReportRoomScreen_Previews.self,
ElementX/Sources/Screens/CreatePollScreen/PollFormScreenViewModel.swift
+11 -3
View File
@@ -52,11 +52,19 @@ class PollFormScreenViewModel: PollFormScreenViewModelType, PollFormScreenViewMo
}
}
case .delete:
// A blank reason is no reason at all, so don't send one.
var reason: String?
let binding: Binding<String> = .init(get: { reason ?? "" },
set: { reason = $0.isBlank ? nil : $0 })
state.bindings.alertInfo = .init(id: .init(),
title: L10n.screenEditPollDeleteConfirmationTitle,
message: L10n.screenEditPollDeleteConfirmation,
primaryButton: .init(title: L10n.actionCancel, role: .cancel, action: nil),
secondaryButton: .init(title: L10n.actionOk) { Task { await self.deletePoll() } })
secondaryButton: .init(title: L10n.actionOk) { Task { await self.deletePoll(reason: reason) } },
textFields: [.init(placeholder: L10n.screenRoomConfirmRemovalReasonLabel,
text: binding,
autoCapitalization: .sentences,
autoCorrectionDisabled: false)])
case .cancel:
if state.formContentHasChanged {
state.bindings.alertInfo = .init(id: .init(),
@@ -116,7 +124,7 @@ class PollFormScreenViewModel: PollFormScreenViewModelType, PollFormScreenViewMo
}
}
private func deletePoll() async {
private func deletePoll(reason: String?) async {
// There aren't any local echoes for redactions, so dismiss the screen early
// until we have them: https://github.com/matrix-org/matrix-rust-sdk/issues/4162
actionsSubject.send(.close)
@@ -126,6 +134,6 @@ class PollFormScreenViewModel: PollFormScreenViewModelType, PollFormScreenViewMo
return
}
await timelineController.redact(.eventID(pollStartID))
await timelineController.redact(.eventID(pollStartID), reason: reason)
}
}
ElementX/Sources/Screens/FilePreviewScreen/TimelineMediaPreviewModels.swift
+1 -1
View File
@@ -91,6 +91,6 @@ enum TimelineMediaPreviewViewAction {
case updateCurrentItem(TimelineMediaPreviewItem)
case showItemDetails(TimelineMediaPreviewItem.Media)
case menuAction(TimelineItemMenuAction, item: TimelineMediaPreviewItem.Media)
case redactConfirmation(item: TimelineMediaPreviewItem.Media)
case redactConfirmation(item: TimelineMediaPreviewItem.Media, reason: String)
case timelineEndReached
}
ElementX/Sources/Screens/FilePreviewScreen/TimelineMediaPreviewViewModel.swift
+4 -4
View File
@@ -128,8 +128,8 @@ class TimelineMediaPreviewViewModel: TimelineMediaPreviewViewModelType {
default:
MXLog.error("Received unexpected action: \(action)")
}
case .redactConfirmation(let item):
redactItem(item)
case .redactConfirmation(let item, let reason):
redactItem(item, reason: reason)
case .timelineEndReached:
showTimelineEndIndicator()
}
@@ -267,8 +267,8 @@ class TimelineMediaPreviewViewModel: TimelineMediaPreviewViewModelType {
}
}
private func redactItem(_ item: TimelineMediaPreviewItem.Media) {
timelineViewModel.context.send(viewAction: .handleTimelineItemMenuAction(itemID: item.timelineItem.id, action: .redact(isMedia: true)))
private func redactItem(_ item: TimelineMediaPreviewItem.Media, reason: String) {
timelineViewModel.context.send(viewAction: .redactConfirmed(itemID: item.timelineItem.id, reason: reason))
state.bindings.redactConfirmationItem = nil
state.previewControllerDriver.send(.dismissDetailsSheet)
actionsSubject.send(.dismiss)
ElementX/Sources/Screens/FilePreviewScreen/View/TimelineMediaPreviewRedactConfirmationView.swift
+7 -2
View File
@@ -16,6 +16,7 @@ struct TimelineMediaPreviewRedactConfirmationView: View {
@ObservedObject var context: TimelineMediaPreviewViewModel.Context
var preferredColorScheme: ColorScheme? = .dark
@State private var reason = ""
@State private var sheetHeight: CGFloat = .zero
private let topPadding: CGFloat = 19
@@ -24,6 +25,10 @@ struct TimelineMediaPreviewRedactConfirmationView: View {
VStack(spacing: 0) {
header
preview
TextField(L10n.screenRoomConfirmRemovalReasonPlaceholder, text: $reason)
.textFieldStyle(.compound(labelText: L10n.screenRoomConfirmRemovalReasonLabel))
.padding(.horizontal, 24)
.padding(.bottom, 40)
buttons
}
.readHeight($sheetHeight)
@@ -95,13 +100,13 @@ struct TimelineMediaPreviewRedactConfirmationView: View {
}
.frame(maxWidth: .infinity, alignment: .leading)
.padding(.horizontal, 24)
.padding(.bottom, 40)
.padding(.bottom, 24)
}
private var buttons: some View {
VStack(spacing: 16) {
Button(L10n.actionRemove, role: .destructive) {
context.send(viewAction: .redactConfirmation(item: item))
context.send(viewAction: .redactConfirmation(item: item, reason: reason))
}
.buttonStyle(.compound(.primary))
ElementX/Sources/Screens/Timeline/TimelineInteractionHandler.swift
+16 -4
View File
@@ -19,6 +19,7 @@ enum TimelineInteractionHandlerAction {
case displayEditPollForm(eventID: String, poll: Poll)
case showActionMenu(TimelineItemActionMenuInfo)
case showRedactConfirmation(itemID: TimelineItemIdentifier)
case showDebugInfo(TimelineItemDebugInfo)
case displayAudioRecorderPermissionError
@@ -114,13 +115,24 @@ class TimelineInteractionHandler {
}
}
// swiftlint:disable:next cyclomatic_complexity
func handleTimelineItemMenuAction(_ action: TimelineItemMenuAction, itemID: TimelineItemIdentifier) {
func redact(_ itemID: TimelineItemIdentifier, reason: String?) {
// Redacting needs the event alone, so it works even when the item isn't part of this timeline,
// such as one held by a media preview that was built from a different one.
guard case let .event(_, eventOrTransactionID) = itemID else { fatalError() }
Task { await timelineController.redact(eventOrTransactionID, reason: reason) }
}
// swiftlint:disable:next cyclomatic_complexity
func handleTimelineItemMenuAction(_ action: TimelineItemMenuAction, itemID: TimelineItemIdentifier) {
if case .redact = action {
guard case let .event(_, eventOrTransactionID) = itemID else { fatalError() }
Task { await timelineController.redact(eventOrTransactionID) }
// An unsent message is only dropped from the send queue. No redaction event reaches
// the server, so there is nothing to attach a reason to, and asking for one would
// only delay the abort while the message might still go out.
if case .event(_, .eventID) = itemID {
actionsSubject.send(.showRedactConfirmation(itemID: itemID))
} else {
redact(itemID, reason: nil)
}
return
}
ElementX/Sources/Screens/Timeline/TimelineModels.swift
+9
View File
@@ -66,6 +66,8 @@ enum TimelineViewAction {
case displayTimelineItemMenu(itemID: TimelineItemIdentifier)
case handleTimelineItemMenuAction(itemID: TimelineItemIdentifier, action: TimelineItemMenuAction)
/// The user has confirmed the removal of an item, optionally giving a reason.
case redactConfirmed(itemID: TimelineItemIdentifier, reason: String?)
case tappedOnSenderDetails(sender: TimelineItemSender)
case displayReactionSummary(itemID: TimelineItemIdentifier, key: String)
@@ -189,6 +191,8 @@ struct TimelineViewStateBindings {
var manageMemberViewModel: ManageRoomMemberSheetViewModel?
var redactConfirmationInfo: TimelineRedactConfirmationInfo?
var showTranslation = false
var textToBeTranslated: String?
}
@@ -219,6 +223,11 @@ struct ReadReceiptSummaryInfo: Identifiable {
let id: TimelineItemIdentifier
}
/// The item that the user has asked to remove and must confirm, optionally giving a reason.
struct TimelineRedactConfirmationInfo: Identifiable {
let id: TimelineItemIdentifier
}
enum TimelineAlertInfoType: Hashable {
case audioRecodingPermissionError
case pollEndConfirmation(String)
ElementX/Sources/Screens/Timeline/TimelineViewModel.swift
+7 -1
View File
@@ -198,6 +198,10 @@ class TimelineViewModel: TimelineViewModelType, TimelineViewModelProtocol {
timelineInteractionHandler.displayTimelineItemActionMenu(for: itemID)
case .handleTimelineItemMenuAction(let itemID, let action):
timelineInteractionHandler.handleTimelineItemMenuAction(action, itemID: itemID)
case .redactConfirmed(let itemID, let reason):
state.bindings.redactConfirmationInfo = nil
// A blank reason is no reason at all, so don't send one.
timelineInteractionHandler.redact(itemID, reason: reason?.isBlank == false ? reason : nil)
case .tappedOnSenderDetails(let sender):
handleTappedOnSenderDetails(sender: sender)
case .displayEmojiPicker(let itemID):
@@ -533,6 +537,8 @@ class TimelineViewModel: TimelineViewModelType, TimelineViewModelProtocol {
} else {
self.state.bindings.actionMenuInfo = actionMenuInfo
}
case .showRedactConfirmation(let itemID):
state.bindings.redactConfirmationInfo = .init(id: itemID)
case .showDebugInfo(let debugInfo):
state.bindings.debugInfo = debugInfo
case .viewInRoomTimeline(let eventID):
@@ -1121,7 +1127,7 @@ class TimelineViewModel: TimelineViewModelType, TimelineViewModelProtocol {
verticalButtons: sendHandle.map { sendHandle in
[.init(title: L10n.actionRetry) { [weak self] in self?.retrySending(sendHandle) },
.init(title: L10n.actionRemoveMessage, role: .destructive) { [weak self] in
self?.timelineInteractionHandler.handleTimelineItemMenuAction(.redact(isMedia: false), itemID: sendHandle.itemID)
self?.timelineInteractionHandler.redact(sendHandle.itemID, reason: nil)
}]
})
case .encryptionAuthenticity(let message):
ElementX/Sources/Screens/Timeline/View/RedactConfirmationView.swift
+102
View File
@@ -0,0 +1,102 @@
//
// Copyright 2026 Element Creations Ltd.
//
// SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial.
// Please see LICENSE files in the repository root for full details.
//
import Compound
import SwiftUI
/// Asks the user to confirm removing a message, letting them give an optional reason.
struct RedactConfirmationView: View {
@Environment(\.dismiss) private var dismiss
@State var reason = ""
let confirm: (String) -> Void
@State private var sheetHeight: CGFloat = .zero
private let topPadding: CGFloat = 44 // For the navigation bar
var body: some View {
ElementNavigationStack {
ScrollView {
VStack(spacing: 0) {
header
TextField(L10n.screenRoomConfirmRemovalReasonPlaceholder, text: $reason)
.textFieldStyle(.compound(labelText: L10n.screenRoomConfirmRemovalReasonLabel))
buttons
}
.padding(.horizontal, 24)
.padding(.bottom, 16)
.readHeight($sheetHeight)
}
.scrollBounceBehavior(.basedOnSize)
.toolbar {
ToolbarItem(placement: .primaryAction) {
ToolbarButton(role: .close) { dismiss() }
}
}
}
.presentationDetents([.height(sheetHeight + topPadding)])
.presentationDragIndicator(.hidden)
.presentationBackground(.compound.bgCanvasDefault)
.interactiveDismissDisabled()
}
private var header: some View {
VStack(spacing: 8) {
Text(L10n.screenRoomConfirmRemovalTitle)
.font(.compound.headingMDBold)
.foregroundStyle(.compound.textPrimary)
Text(L10n.screenRoomConfirmRemovalMessage)
.font(.compound.bodyLG)
.foregroundStyle(.compound.textSecondary)
}
.multilineTextAlignment(.center)
.padding(.top, 8)
.padding(.bottom, 24)
}
private var buttons: some View {
ViewThatFits {
HStack(spacing: 12) {
cancelButton
removeButton
}
VStack(spacing: 16) {
removeButton
cancelButton
}
}
.padding(.top, 24)
}
private var cancelButton: some View {
Button(L10n.actionCancel) {
dismiss()
}
.buttonStyle(.compound(.secondary))
}
private var removeButton: some View {
Button(L10n.actionRemove, role: .destructive) {
confirm(reason)
}
.buttonStyle(.compound(.primary))
}
}
// MARK: - Previews
struct RedactConfirmationView_Previews: PreviewProvider, TestablePreview {
static var previews: some View {
RedactConfirmationView { _ in }
.previewDisplayName("Empty")
RedactConfirmationView(reason: "Posted in the wrong room.") { _ in }
.previewDisplayName("Reason")
}
}
ElementX/Sources/Screens/Timeline/View/TimelineView.swift
+5
View File
@@ -27,6 +27,11 @@ struct TimelineView: View {
ManageRoomMemberSheetView(context: $0.context)
}
.sheet(item: $timelineContext.debugInfo) { TimelineItemDebugView(info: $0) }
.sheet(item: $timelineContext.redactConfirmationInfo) { info in
RedactConfirmationView { reason in
timelineContext.send(viewAction: .redactConfirmed(itemID: info.id, reason: reason))
}
}
.sheet(item: $timelineContext.actionMenuInfo) { info in
let actions = TimelineItemMenuActionProvider(timelineItem: info.item,
canCurrentUserSendMessage: timelineContext.viewState.canCurrentUserSendMessage,
ElementX/Sources/Services/Timeline/TimelineController/TimelineController.swift
+2 -2
View File
@@ -211,10 +211,10 @@ class TimelineController: TimelineControllerProtocol {
}
}
func redact(_ eventOrTransactionID: TimelineItemIdentifier.EventOrTransactionID) async {
func redact(_ eventOrTransactionID: TimelineItemIdentifier.EventOrTransactionID, reason: String?) async {
MXLog.info("Send redaction in \(roomID)")
switch await activeTimeline.redact(eventOrTransactionID, reason: nil) {
switch await activeTimeline.redact(eventOrTransactionID, reason: reason) {
case .success:
MXLog.info("Finished redacting message")
case .failure(let error):
ElementX/Sources/Services/Timeline/TimelineController/TimelineControllerProtocol.swift
+1 -1
View File
@@ -84,7 +84,7 @@ protocol TimelineControllerProtocol: Sendable {
func toggleReaction(_ reaction: String, to eventOrTransactionID: TimelineItemIdentifier.EventOrTransactionID) async
func redact(_ eventOrTransactionID: TimelineItemIdentifier.EventOrTransactionID) async
func redact(_ eventOrTransactionID: TimelineItemIdentifier.EventOrTransactionID, reason: String?) async
func pin(eventID: String) async