b6ade2d4a9
the report flow is now based on the matrix version and the new one will only be used if the SDK checks if the server supports it.
362 lines
17 KiB
Swift
362 lines
17 KiB
Swift
//
|
|
// Copyright 2022-2024 New Vector Ltd.
|
|
//
|
|
// SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
|
|
// Please see LICENSE files in the repository root for full details.
|
|
//
|
|
|
|
#if canImport(EmbeddedElementCall)
|
|
import EmbeddedElementCall
|
|
#endif
|
|
|
|
import Foundation
|
|
import SwiftUI
|
|
|
|
// Common settings between app and NSE
|
|
protocol CommonSettingsProtocol {
|
|
var logLevel: LogLevel { get }
|
|
var traceLogPacks: Set<TraceLogPack> { get }
|
|
var enableOnlySignedDeviceIsolationMode: Bool { get }
|
|
var hideInviteAvatars: Bool { get }
|
|
var timelineMediaVisibility: TimelineMediaVisibility { get }
|
|
}
|
|
|
|
/// Store Element specific app settings.
|
|
final class AppSettings {
|
|
private enum UserDefaultsKeys: String {
|
|
case lastVersionLaunched
|
|
case seenInvites
|
|
case appLockNumberOfPINAttempts
|
|
case appLockNumberOfBiometricAttempts
|
|
case timelineStyle
|
|
|
|
case analyticsConsentState
|
|
case hasRunNotificationPermissionsOnboarding
|
|
case hasRunIdentityConfirmationOnboarding
|
|
|
|
case frequentlyUsedSystemEmojis
|
|
|
|
case enableNotifications
|
|
case enableInAppNotifications
|
|
case pusherProfileTag
|
|
case logLevel
|
|
case traceLogPacks
|
|
case viewSourceEnabled
|
|
case optimizeMediaUploads
|
|
case appAppearance
|
|
case sharePresence
|
|
case hideUnreadMessagesBadge
|
|
case hideInviteAvatars
|
|
case timelineMediaVisibility
|
|
case isNewBloomEnabled
|
|
|
|
case elementCallBaseURLOverride
|
|
|
|
// Feature flags
|
|
case publicSearchEnabled
|
|
case fuzzyRoomListSearchEnabled
|
|
case enableOnlySignedDeviceIsolationMode
|
|
case knockingEnabled
|
|
case threadsEnabled
|
|
}
|
|
|
|
private static var suiteName: String = InfoPlistReader.main.appGroupIdentifier
|
|
private static var remoteSuiteName = "\(InfoPlistReader.main.appGroupIdentifier).remote"
|
|
|
|
/// UserDefaults to be used on reads and writes.
|
|
private static var store: UserDefaults! = UserDefaults(suiteName: suiteName)
|
|
|
|
#if IS_MAIN_APP
|
|
|
|
static func resetAllSettings() {
|
|
MXLog.warning("Resetting the AppSettings.")
|
|
store.removePersistentDomain(forName: suiteName)
|
|
}
|
|
|
|
static func resetSessionSpecificSettings() {
|
|
MXLog.warning("Resetting the user session specific AppSettings.")
|
|
store.removeObject(forKey: UserDefaultsKeys.hasRunIdentityConfirmationOnboarding.rawValue)
|
|
}
|
|
|
|
static func configureWithSuiteName(_ name: String) {
|
|
suiteName = name
|
|
|
|
guard let userDefaults = UserDefaults(suiteName: name) else {
|
|
fatalError("Fail to load shared UserDefaults")
|
|
}
|
|
|
|
store = userDefaults
|
|
}
|
|
|
|
// MARK: - Hooks
|
|
|
|
// swiftlint:disable:next function_parameter_count
|
|
func override(defaultHomeserverAddress: String,
|
|
pushGatewayBaseURL: URL,
|
|
oidcRedirectURL: URL,
|
|
websiteURL: URL,
|
|
logoURL: URL,
|
|
copyrightURL: URL,
|
|
acceptableUseURL: URL,
|
|
privacyURL: URL,
|
|
encryptionURL: URL,
|
|
chatBackupDetailsURL: URL,
|
|
identityPinningViolationDetailsURL: URL,
|
|
elementWebHosts: [String],
|
|
bugReportApplicationID: String,
|
|
analyticsTermsURL: URL?,
|
|
mapTilerConfiguration: MapTilerConfiguration) {
|
|
self.defaultHomeserverAddress = defaultHomeserverAddress
|
|
self.pushGatewayBaseURL = pushGatewayBaseURL
|
|
self.oidcRedirectURL = oidcRedirectURL
|
|
self.websiteURL = websiteURL
|
|
self.logoURL = logoURL
|
|
self.copyrightURL = copyrightURL
|
|
self.acceptableUseURL = acceptableUseURL
|
|
self.privacyURL = privacyURL
|
|
self.encryptionURL = encryptionURL
|
|
self.chatBackupDetailsURL = chatBackupDetailsURL
|
|
self.identityPinningViolationDetailsURL = identityPinningViolationDetailsURL
|
|
self.elementWebHosts = elementWebHosts
|
|
self.bugReportApplicationID = bugReportApplicationID
|
|
self.analyticsTermsURL = analyticsTermsURL
|
|
self.mapTilerConfiguration = mapTilerConfiguration
|
|
}
|
|
|
|
// MARK: - Application
|
|
|
|
/// Whether or not the app is a development build that isn't in production.
|
|
static var isDevelopmentBuild: Bool = {
|
|
#if DEBUG
|
|
true
|
|
#else
|
|
let apps = ["io.element.elementx.nightly", "io.element.elementx.pr"]
|
|
return apps.contains(InfoPlistReader.main.baseBundleIdentifier)
|
|
#endif
|
|
}()
|
|
|
|
/// The last known version of the app that was launched on this device, which is
|
|
/// used to detect when migrations should be run. When `nil` the app may have been
|
|
/// deleted between runs so should clear data in the shared container and keychain.
|
|
@UserPreference(key: UserDefaultsKeys.lastVersionLaunched, storageType: .userDefaults(store))
|
|
var lastVersionLaunched: String?
|
|
|
|
/// The Set of room identifiers of invites that the user already saw in the invites list.
|
|
/// This Set is being used to implement badges for unread invites.
|
|
@UserPreference(key: UserDefaultsKeys.seenInvites, defaultValue: [], storageType: .userDefaults(store))
|
|
var seenInvites: Set<String>
|
|
|
|
/// The default homeserver address used. This is intentionally a string without a scheme
|
|
/// so that it can be passed to Rust as a ServerName for well-known discovery.
|
|
private(set) var defaultHomeserverAddress = "matrix.org"
|
|
|
|
/// The task identifier used for background app refresh. Also used in main target's the Info.plist
|
|
let backgroundAppRefreshTaskIdentifier = "io.element.elementx.background.refresh"
|
|
|
|
/// A URL where users can go read more about the app.
|
|
private(set) var websiteURL: URL = "https://element.io"
|
|
/// A URL that contains the app's logo that may be used when showing content in a web view.
|
|
private(set) var logoURL: URL = "https://element.io/mobile-icon.png"
|
|
/// A URL that contains that app's copyright notice.
|
|
private(set) var copyrightURL: URL = "https://element.io/copyright"
|
|
/// A URL that contains the app's Terms of use.
|
|
private(set) var acceptableUseURL: URL = "https://element.io/acceptable-use-policy-terms"
|
|
/// A URL that contains the app's Privacy Policy.
|
|
private(set) var privacyURL: URL = "https://element.io/privacy"
|
|
/// A URL where users can go read more about encryption in general.
|
|
private(set) var encryptionURL: URL = "https://element.io/help#encryption"
|
|
/// A URL where users can go read more about the chat backup.
|
|
private(set) var chatBackupDetailsURL: URL = "https://element.io/help#encryption5"
|
|
/// A URL where users can go read more about identity pinning violations
|
|
private(set) var identityPinningViolationDetailsURL: URL = "https://element.io/help#encryption18"
|
|
/// Any domains that Element web may be hosted on - used for handling links.
|
|
private(set) var elementWebHosts = ["app.element.io", "staging.element.io", "develop.element.io"]
|
|
|
|
@UserPreference(key: UserDefaultsKeys.appAppearance, defaultValue: .system, storageType: .userDefaults(store))
|
|
var appAppearance: AppAppearance
|
|
|
|
// MARK: - Security
|
|
|
|
/// The app must be locked with a PIN code as part of the authentication flow.
|
|
let appLockIsMandatory = false
|
|
/// The amount of time the app can remain in the background for without requesting the PIN/TouchID/FaceID.
|
|
let appLockGracePeriod: TimeInterval = 0
|
|
/// Any codes that the user isn't allowed to use for their PIN.
|
|
let appLockPINCodeBlockList = ["0000", "1234"]
|
|
/// The number of attempts the user has made to unlock the app with a PIN code (resets when unlocked).
|
|
@UserPreference(key: UserDefaultsKeys.appLockNumberOfPINAttempts, defaultValue: 0, storageType: .userDefaults(store))
|
|
var appLockNumberOfPINAttempts: Int
|
|
|
|
// MARK: - Authentication
|
|
|
|
/// Any pre-defined static client registrations for OIDC issuers.
|
|
let oidcStaticRegistrations: [URL: String] = ["https://id.thirdroom.io/realms/thirdroom": "elementx"]
|
|
/// The redirect URL used for OIDC. This no longer uses universal links so we don't need the bundle ID to avoid conflicts between Element X, Nightly and PR builds.
|
|
private(set) var oidcRedirectURL: URL = "https://element.io/oidc/login"
|
|
|
|
private(set) lazy var oidcConfiguration = OIDCConfigurationProxy(clientName: InfoPlistReader.main.bundleDisplayName,
|
|
redirectURI: oidcRedirectURL,
|
|
clientURI: websiteURL,
|
|
logoURI: logoURL,
|
|
tosURI: acceptableUseURL,
|
|
policyURI: privacyURL,
|
|
staticRegistrations: oidcStaticRegistrations.mapKeys { $0.absoluteString })
|
|
|
|
/// Whether or not the Create Account button is shown on the start screen.
|
|
///
|
|
/// **Note:** Setting this to false doesn't prevent someone from creating an account when the selected homeserver's MAS allows registration.
|
|
let showCreateAccountButton = true
|
|
|
|
// MARK: - Notifications
|
|
|
|
var pusherAppID: String {
|
|
#if DEBUG
|
|
InfoPlistReader.main.baseBundleIdentifier + ".ios.dev"
|
|
#else
|
|
InfoPlistReader.main.baseBundleIdentifier + ".ios.prod"
|
|
#endif
|
|
}
|
|
|
|
private(set) var pushGatewayBaseURL: URL = "https://matrix.org"
|
|
var pushGatewayNotifyEndpoint: URL { pushGatewayBaseURL.appending(path: "_matrix/push/v1/notify") }
|
|
|
|
@UserPreference(key: UserDefaultsKeys.enableNotifications, defaultValue: true, storageType: .userDefaults(store))
|
|
var enableNotifications
|
|
|
|
@UserPreference(key: UserDefaultsKeys.enableInAppNotifications, defaultValue: true, storageType: .userDefaults(store))
|
|
var enableInAppNotifications
|
|
|
|
/// Tag describing which set of device specific rules a pusher executes.
|
|
@UserPreference(key: UserDefaultsKeys.pusherProfileTag, storageType: .userDefaults(store))
|
|
var pusherProfileTag: String?
|
|
|
|
// MARK: - Bug report
|
|
|
|
let bugReportServiceBaseURL: URL? = Secrets.rageshakeServerURL.map { URL(string: $0)! } // swiftlint:disable:this force_unwrapping
|
|
let bugReportSentryURL: URL? = Secrets.sentryDSN.map { URL(string: $0)! } // swiftlint:disable:this force_unwrapping
|
|
/// The name allocated by the bug report server
|
|
private(set) var bugReportApplicationID = "element-x-ios"
|
|
/// The maximum size of the upload request. Default value is just below CloudFlare's max request size.
|
|
let bugReportMaxUploadSize = 50 * 1024 * 1024
|
|
|
|
// MARK: - Analytics
|
|
|
|
/// The configuration to use for analytics. Set to `nil` to disable analytics.
|
|
let analyticsConfiguration: AnalyticsConfiguration? = AppSettings.makeAnalyticsConfiguration()
|
|
/// The URL to open with more information about analytics terms. When this is `nil` the "Learn more" link will be hidden.
|
|
private(set) var analyticsTermsURL: URL? = "https://element.io/cookie-policy"
|
|
/// Whether or not there the app is able ask for user consent to enable analytics or sentry reporting.
|
|
var canPromptForAnalytics: Bool { analyticsConfiguration != nil || bugReportSentryURL != nil }
|
|
|
|
private static func makeAnalyticsConfiguration() -> AnalyticsConfiguration? {
|
|
guard let host = Secrets.postHogHost, let apiKey = Secrets.postHogAPIKey else { return nil }
|
|
return AnalyticsConfiguration(host: host, apiKey: apiKey)
|
|
}
|
|
|
|
/// Whether the user has opted in to send analytics.
|
|
@UserPreference(key: UserDefaultsKeys.analyticsConsentState, defaultValue: AnalyticsConsentState.unknown, storageType: .userDefaults(store))
|
|
var analyticsConsentState
|
|
|
|
@UserPreference(key: UserDefaultsKeys.hasRunNotificationPermissionsOnboarding, defaultValue: false, storageType: .userDefaults(store))
|
|
var hasRunNotificationPermissionsOnboarding
|
|
|
|
@UserPreference(key: UserDefaultsKeys.hasRunIdentityConfirmationOnboarding, defaultValue: false, storageType: .userDefaults(store))
|
|
var hasRunIdentityConfirmationOnboarding
|
|
|
|
@UserPreference(key: UserDefaultsKeys.frequentlyUsedSystemEmojis, defaultValue: [FrequentlyUsedEmoji](), storageType: .userDefaults(store))
|
|
var frequentlyUsedSystemEmojis
|
|
|
|
// MARK: - Home Screen
|
|
|
|
@UserPreference(key: UserDefaultsKeys.hideUnreadMessagesBadge, defaultValue: false, storageType: .userDefaults(store))
|
|
var hideUnreadMessagesBadge
|
|
|
|
// MARK: - Room Screen
|
|
|
|
@UserPreference(key: UserDefaultsKeys.viewSourceEnabled, defaultValue: isDevelopmentBuild, storageType: .userDefaults(store))
|
|
var viewSourceEnabled
|
|
|
|
@UserPreference(key: UserDefaultsKeys.optimizeMediaUploads, defaultValue: true, storageType: .userDefaults(store))
|
|
var optimizeMediaUploads
|
|
|
|
/// Whether or not to show a warning on the media caption composer so the user knows
|
|
/// that captions might not be visible to users who are using other Matrix clients.
|
|
let shouldShowMediaCaptionWarning = true
|
|
|
|
// MARK: - Element Call
|
|
|
|
// swiftlint:disable:next force_unwrapping
|
|
let elementCallBaseURL: URL = EmbeddedElementCall.appURL!
|
|
|
|
// These are publicly availble on https://call.element.io so we don't neeed to treat them as secrets
|
|
let elementCallPosthogAPIHost = "https://posthog-element-call.element.io"
|
|
let elementCallPosthogAPIKey = "phc_rXGHx9vDmyEvyRxPziYtdVIv0ahEv8A9uLWFcCi1WcU"
|
|
let elementCallPosthogSentryDSN = "https://3bd2f95ba5554d4497da7153b552ffb5@sentry.tools.element.io/41"
|
|
|
|
@UserPreference(key: UserDefaultsKeys.elementCallBaseURLOverride, defaultValue: nil, storageType: .userDefaults(store))
|
|
var elementCallBaseURLOverride: URL?
|
|
|
|
// MARK: - Users
|
|
|
|
/// Whether to hide the display name and avatar of ignored users as these may contain objectionable content.
|
|
let hideIgnoredUserProfiles = true
|
|
|
|
// MARK: - Maps
|
|
|
|
// maptiler base url
|
|
private(set) var mapTilerConfiguration = MapTilerConfiguration(baseURL: "https://api.maptiler.com/maps",
|
|
apiKey: Secrets.mapLibreAPIKey,
|
|
lightStyleID: "9bc819c8-e627-474a-a348-ec144fe3d810",
|
|
darkStyleID: "dea61faf-292b-4774-9660-58fcef89a7f3")
|
|
|
|
// MARK: - Presence
|
|
|
|
@UserPreference(key: UserDefaultsKeys.sharePresence, defaultValue: true, storageType: .userDefaults(store))
|
|
var sharePresence
|
|
|
|
// MARK: - Feature Flags
|
|
|
|
@UserPreference(key: UserDefaultsKeys.publicSearchEnabled, defaultValue: false, storageType: .userDefaults(store))
|
|
var publicSearchEnabled
|
|
|
|
@UserPreference(key: UserDefaultsKeys.fuzzyRoomListSearchEnabled, defaultValue: false, storageType: .userDefaults(store))
|
|
var fuzzyRoomListSearchEnabled
|
|
|
|
@UserPreference(key: UserDefaultsKeys.knockingEnabled, defaultValue: false, storageType: .userDefaults(store))
|
|
var knockingEnabled
|
|
|
|
@UserPreference(key: UserDefaultsKeys.threadsEnabled, defaultValue: false, storageType: .userDefaults(store))
|
|
var threadsEnabled
|
|
|
|
#endif
|
|
|
|
// MARK: - Shared
|
|
|
|
@UserPreference(key: UserDefaultsKeys.logLevel, defaultValue: LogLevel.info, storageType: .userDefaults(store))
|
|
var logLevel
|
|
|
|
@UserPreference(key: UserDefaultsKeys.traceLogPacks, defaultValue: [], storageType: .userDefaults(store))
|
|
var traceLogPacks: Set<TraceLogPack>
|
|
|
|
/// Configuration to enable only signed device isolation mode for crypto. In this mode only devices signed by their owner will be considered in e2ee rooms.
|
|
@UserPreference(key: UserDefaultsKeys.enableOnlySignedDeviceIsolationMode, defaultValue: false, storageType: .userDefaults(store))
|
|
var enableOnlySignedDeviceIsolationMode
|
|
|
|
@UserPreference(key: UserDefaultsKeys.hideInviteAvatars, defaultValue: false, storageType: .userDefaults(store))
|
|
var hideInviteAvatars
|
|
|
|
@UserPreference(key: UserDefaultsKeys.timelineMediaVisibility, defaultValue: TimelineMediaVisibility.always, storageType: .userDefaults(store))
|
|
var timelineMediaVisibility
|
|
|
|
@UserPreference(key: UserDefaultsKeys.isNewBloomEnabled, defaultValue: false, storageType: .userDefaults(store))
|
|
var isNewBloomEnabled
|
|
}
|
|
|
|
extension AppSettings: CommonSettingsProtocol { }
|
|
|
|
enum TimelineMediaVisibility: Codable {
|
|
case always
|
|
case privateOnly
|
|
case never
|
|
}
|