Path: blob/main/Signal/Usernames/Links/UsernameLinkPresentQRCodeViewController.swift
1 views
//
// Copyright 2023 Signal Messenger, LLC
// SPDX-License-Identifier: AGPL-3.0-only
//
import SignalServiceKit
import SignalUI
class UsernameLinkPresentQRCodeViewController: OWSTableViewController2 {
private enum UsernameLinkState {
case available(
usernameLink: Usernames.UsernameLink,
qrCode: UIImage,
)
case resetting
case corrupted
var linkParams: (Usernames.UsernameLink, qrCode: UIImage)? {
switch self {
case let .available(usernameLink, qrCode):
return (usernameLink, qrCode: qrCode)
case .resetting, .corrupted:
return nil
}
}
static func forUsernameLink(
usernameLink: Usernames.UsernameLink,
) -> UsernameLinkState {
if
let qrCode = QRCodeGenerator().generateQRCode(url: usernameLink.url)
{
return .available(
usernameLink: usernameLink,
qrCode: qrCode,
)
}
return .corrupted
}
}
private let db: any DB
private let localUsernameManager: LocalUsernameManager
private let username: String
private let originalUsernameLink: Usernames.UsernameLink?
private var shouldResetLinkOnAppear: Bool
private weak var usernameChangeDelegate: UsernameChangeDelegate?
private var qrCodeColor: QRCodeColor!
private var _usernameLinkState: UsernameLinkState!
/// A layer of indirection to avoid needing to handle `nil` in switches,
/// which you apparently need to even for implicitly-unwrapped optionals.
private var usernameLinkState: UsernameLinkState {
get {
guard let _usernameLinkState else { owsFail("Should never be unset!") }
return _usernameLinkState
}
set { _usernameLinkState = newValue }
}
/// Create a new controller.
///
/// - Parameter usernameLink
/// The user's current username link, if available. If `nil` is passed, the
/// link will be reset when this controller loads.
init(
db: any DB,
localUsernameManager: LocalUsernameManager,
username: String,
usernameLink: Usernames.UsernameLink?,
usernameChangeDelegate: UsernameChangeDelegate,
) {
self.db = db
self.localUsernameManager = localUsernameManager
self.username = username
self.originalUsernameLink = usernameLink
self.shouldResetLinkOnAppear = usernameLink == nil
self.usernameChangeDelegate = usernameChangeDelegate
super.init()
}
// MARK: - Views
/// A horizontal stack view that centers its fixed-width content subviews.
private class CenteringStackView: UIStackView {
init(centeredSubviews: [UIView]) {
super.init(frame: .zero)
let leftSpacer = SpacerView()
let rightSpacer = SpacerView()
addArrangedSubviews([leftSpacer] + centeredSubviews + [rightSpacer])
axis = .horizontal
alignment = .center
spacing = 8
leftSpacer.autoPinWidth(toWidthOf: rightSpacer)
}
required init(coder: NSCoder) {
owsFail("Not implemented")
}
}
// MARK: QR Code
private var qrCodeView: UIView?
/// Builds the QR code view, including the QR code, colored background, and
/// display of the current username.
private func buildQRCodeView() -> UIView {
let qrCodeView: QRCodeView = {
let qrCodeView = QRCodeView(
qrCodeTintColor: qrCodeColor,
contentInset: 16,
)
switch usernameLinkState {
case .resetting:
// The QR code view will be in a "loading" state already.
break
case let .available(_, qrCode):
qrCodeView.setQRCode(image: qrCode)
case .corrupted:
qrCodeView.setError()
}
return qrCodeView
}()
let copyUsernameButton: UIButton = {
let button = OWSButton(block: { [weak self] in
guard let self else { return }
UIPasteboard.general.string = self.username
self.showUsernameCopiedToast()
})
button.setTitle(username, for: .normal)
button.setTitleColor(qrCodeColor.username, for: .normal)
button.titleLabel!.font = .dynamicTypeHeadline.semibold()
button.setTemplateImage(
Theme.iconImage(.buttonCopy),
tintColor: qrCodeColor.username,
)
button.imageView!.autoSetDimensions(to: .square(24))
button.ows_titleEdgeInsets = UIEdgeInsets(top: 0, leading: 6, bottom: 0, trailing: 0)
button.configureForMultilineTitle()
button.dimsWhenHighlighted = true
return button
}()
let wrapperView = UIView()
wrapperView.backgroundColor = qrCodeColor.background
wrapperView.layer.cornerRadius = 24
wrapperView.layoutMargins = UIEdgeInsets(hMargin: 40, vMargin: 32)
wrapperView.addSubview(qrCodeView)
wrapperView.addSubview(copyUsernameButton)
qrCodeView.autoPinTopToSuperviewMargin()
qrCodeView.autoSetDimensions(to: .square(214))
qrCodeView.autoHCenterInSuperview()
qrCodeView.autoPinEdge(.bottom, to: .top, of: copyUsernameButton, withOffset: -16)
copyUsernameButton.autoPinLeadingToSuperviewMargin()
copyUsernameButton.autoPinTrailingToSuperviewMargin()
copyUsernameButton.autoPinBottomToSuperviewMargin()
return wrapperView
}
// MARK: Action buttons
private func buildActionButton(
title: String,
icon: ThemeIcon,
block: @escaping (SettingsHeaderButton) -> Void,
) -> SettingsHeaderButton {
let button = SettingsHeaderButton(title: title.capitalized, icon: icon)
button.buttonBackgroundColor = Self.cellBackgroundColor(isUsingPresentedStyle: true)
button.selectedButtonBackgroundColor = Self.cellSelectedBackgroundColor()
button.addActionHandler({ [weak button] in
guard let button else { return }
block(button)
})
button.autoSetDimension(
.width,
toSize: 100,
relation: .greaterThanOrEqual,
)
return button
}
private func buildActionButtonsView() -> UIView {
let usernameLinkButton = buildActionButton(
title: OWSLocalizedString(
"USERNAME_LINK_SHEET_BUTTON",
comment: "Title for a button to open a sheet for copying and sharing your username link.",
),
icon: .buttonLink,
block: { [weak self] _ in
guard let self else { return }
switch self.usernameLinkState {
case let .available(usernameLink, _):
let shareSheet = UsernameLinkShareSheetViewController(
usernameLink: usernameLink,
didCopyUsername: { [weak self] in
guard let self else { return }
self.dismiss(animated: true) {
self.showUsernameLinkCopiedToast()
}
},
)
shareSheet.dismissalDelegate = self
self.present(
shareSheet,
animated: true,
)
case .resetting, .corrupted:
break
}
},
)
let shareQRCodeButton = buildActionButton(
title: OWSLocalizedString(
"USERNAME_LINK_QR_CODE_VIEW_SHARE_BUTTON",
comment: "Title for a button to share your username link QR code. Lowercase styling is intentional.",
),
icon: .buttonShare,
block: { [weak self] actionButton in
self?.shareQRCode(sourceView: actionButton)
},
)
let colorQRCodeButton = buildActionButton(
title: OWSLocalizedString(
"USERNAME_LINK_QR_CODE_VIEW_COLOR_BUTTON",
comment: "Title for a button to pick the color of your username link QR code. Lowercase styling is intentional.",
),
icon: .chatSettingsWallpaper,
block: { [weak self] _ in
guard
let self,
let (_, qrCodeImage) = self.usernameLinkState.linkParams
else { return }
let colorPickerVC = UsernameLinkQRCodeColorPickerViewController(
currentColor: self.qrCodeColor,
username: self.username,
qrCode: qrCodeImage,
delegate: self,
)
self.presentFormSheet(
OWSNavigationController(rootViewController: colorPickerVC),
animated: true,
)
},
)
let stackView = CenteringStackView(centeredSubviews: [
usernameLinkButton,
shareQRCodeButton,
colorQRCodeButton,
])
shareQRCodeButton.autoPinWidth(toWidthOf: colorQRCodeButton)
usernameLinkButton.autoPinWidth(toWidthOf: colorQRCodeButton)
return stackView
}
/// Generate a color-over-white QR code and share.
private func shareQRCode(sourceView: UIView) {
guard
let (usernameLink, _) = self.usernameLinkState.linkParams,
let qrCode = QRCodeGenerator().generateQRCode(url: usernameLink.url)
else {
return
}
let canvas = UIView()
canvas.frame.size = CGSize(width: 424, height: 576)
canvas.backgroundColor = self.qrCodeColor.canvas
canvas.layoutMargins = .init(top: 0, left: 48, bottom: 10, right: 48)
let stackView = UIStackView()
canvas.addSubview(stackView)
stackView.axis = .vertical
stackView.alignment = .fill
stackView.spacing = 56
stackView.autoPinWidthToSuperviewMargins()
stackView.autoVCenterInSuperview()
let card = UIStackView()
stackView.addArrangedSubview(card)
card.axis = .vertical
card.spacing = 16
card.alignment = .center
card.backgroundColor = self.qrCodeColor.background
card.layer.cornerRadius = 32
card.layoutMargins = .init(top: 32, left: 40, bottom: 34, right: 40)
card.isLayoutMarginsRelativeArrangement = true
let qrCodeBackground = UIView()
card.addArrangedSubview(qrCodeBackground)
qrCodeBackground.backgroundColor = .white
qrCodeBackground.layoutMargins = .init(margin: 16)
qrCodeBackground.layer.cornerRadius = 12
qrCodeBackground.layer.borderWidth = 2
qrCodeBackground.layer.borderColor = self.qrCodeColor.paddingBorder.cgColor
let qrCodeView: UIImageView = .withTemplateImage(qrCode, tintColor: self.qrCodeColor.foreground)
qrCodeBackground.addSubview(qrCodeView)
qrCodeView.autoPinEdgesToSuperviewMargins()
qrCodeView.autoPinToSquareAspectRatio()
let usernameLabel = UILabel()
card.addArrangedSubview(usernameLabel)
usernameLabel.font = .semiboldFont(ofSize: 20)
usernameLabel.textColor = self.qrCodeColor.username
usernameLabel.numberOfLines = 0
usernameLabel.textAlignment = .center
usernameLabel.text = self.username
let instructionsLabel = UILabel()
stackView.addArrangedSubview(instructionsLabel)
instructionsLabel.font = .systemFont(ofSize: 14)
instructionsLabel.textColor = Theme.lightThemeSecondaryTextAndIconColor
instructionsLabel.numberOfLines = 0
instructionsLabel.textAlignment = .center
instructionsLabel.text = OWSLocalizedString(
"USERNAME_QR_CODE_EXPORT_INSTRUCTIONS",
comment: "Instructions that appear below the username QR code on a sharable exported image.",
)
canvas.setNeedsLayout()
canvas.layoutIfNeeded()
let output = canvas.renderAsImage()
ShareActivityUtil.present(
activityItems: [output],
from: self,
sourceView: sourceView,
completion: { [weak self] in
self?.setMaxBrightness()
},
)
}
// MARK: Disclaimer text
private func buildDisclaimerLabel() -> UILabel {
let label = UILabel()
label.font = .dynamicTypeCaption1
label.numberOfLines = 0
label.textAlignment = .center
label.textColor = Theme.secondaryTextAndIconColor
label.text = OWSLocalizedString(
"USERNAME_LINK_QR_CODE_VIEW_DISCLAIMER_LABEL",
comment: "Text for a label explaining what the username link and QR code give others access to.",
)
return label
}
// MARK: Reset button
private var resetButtonString: String {
return OWSLocalizedString(
"USERNAME_LINK_QR_CODE_VIEW_RESET_BUTTON_TITLE",
comment: "Title for a button that allows users to reset their username link and QR code.",
)
}
private func buildResetButtonView() -> UIView {
let button = OWSRoundedButton { [weak self] in
self?.tappedResetButton()
}
button.setTitle(resetButtonString, for: .normal)
button.ows_contentEdgeInsets = UIEdgeInsets(hMargin: 16, vMargin: 6)
button.backgroundColor = Theme.isDarkThemeEnabled ? .ows_gray80 : .ows_whiteAlpha70
button.titleLabel!.font = .dynamicTypeSubheadline.bold()
button.setTitleColor(Theme.primaryTextColor, for: .normal)
button.configureForMultilineTitle()
button.dimsWhenHighlighted = true
button.dimsWhenDisabled = true
switch usernameLinkState {
case .resetting:
button.isEnabled = false
case .available, .corrupted:
button.isEnabled = true
}
return CenteringStackView(centeredSubviews: [button])
}
private func tappedResetButton() {
let actionSheet = ActionSheetController(message: OWSLocalizedString(
"USERNAME_LINK_QR_CODE_VIEW_RESET_SHEET_MESSAGE",
comment: "A message explaining what will happen if the user resets their QR code.",
))
actionSheet.addAction(ActionSheetAction(
title: resetButtonString,
style: .destructive,
handler: { [weak self] _ in
self?.resetUsernameLink()
},
))
actionSheet.addAction(ActionSheetAction(
title: CommonStrings.cancelButton,
style: .cancel,
))
actionSheet.dismissalDelegate = self
OWSActionSheets.showActionSheet(actionSheet, fromViewController: self)
}
// MARK: Put it all together
private func buildTableContents() {
let topSection = OWSTableSection(items: [
.itemWrappingView(
viewBlock: { [weak self] in
self?.qrCodeView = self?.buildQRCodeView()
return self?.qrCodeView
},
margins: UIEdgeInsets(top: 32, leading: 48, bottom: 12, trailing: 48),
),
.itemWrappingView(
viewBlock: { [weak self] in
return self?.buildActionButtonsView()
},
margins: UIEdgeInsets(top: 12, leading: 16, bottom: 20, trailing: 16),
),
])
let bottomSection = OWSTableSection(items: [
.itemWrappingView(
viewBlock: { [weak self] in
self?.buildDisclaimerLabel()
},
margins: UIEdgeInsets(top: 12, leading: 32, bottom: 12, trailing: 32),
),
.itemWrappingView(
viewBlock: { [weak self] in
self?.buildResetButtonView()
},
margins: UIEdgeInsets(top: 12, leading: 32, bottom: 24, trailing: 32),
),
])
topSection.hasSeparators = false
topSection.hasBackground = false
bottomSection.hasSeparators = false
bottomSection.hasBackground = false
defaultSpacingBetweenSections = 0
contents = OWSTableContents(sections: [
topSection,
bottomSection,
])
}
// MARK: - Controller lifecycle
override func viewDidLoad() {
super.viewDidLoad()
qrCodeColor = db.read { tx in
return localUsernameManager.usernameLinkQRCodeColor(tx: tx)
}
if let usernameLink = originalUsernameLink {
usernameLinkState = .forUsernameLink(usernameLink: usernameLink)
} else {
usernameLinkState = .resetting
}
buildTableContents()
}
override func viewWillAppear(_ animated: Bool) {
if shouldResetLinkOnAppear {
shouldResetLinkOnAppear = false
// If we have no username link to start, immediately kick off a
// reset.
resetUsernameLink(shouldReloadTableContents: false)
}
}
private var shouldAnimateQRCode = false
override func viewDidAppear(_ animated: Bool) {
super.viewDidAppear(animated)
setMaxBrightness()
// Partially swiping down on the sheet and letting go will call
// `viewDidAppear` without `viewDidDisappear`, so only animate the QR
// code if the view disappeared first.
guard shouldAnimateQRCode, let qrCodeView else { return }
shouldAnimateQRCode = false
qrCodeView.layer.opacity = 0
if !UIAccessibility.isReduceMotionEnabled {
qrCodeView.transform = .scale(0.9)
}
let animator = UIViewPropertyAnimator(duration: 0.35, springDamping: 1, springResponse: 0.35)
animator.addAnimations {
qrCodeView.layer.opacity = 1
qrCodeView.transform = .identity
}
animator.startAnimation()
}
override func viewDidDisappear(_ animated: Bool) {
super.viewDidDisappear(animated)
restoreBrightness()
shouldAnimateQRCode = true
}
override func appWillResignActive() {
super.appWillResignActive()
restoreBrightness()
}
override func appDidBecomeActive() {
super.appDidBecomeActive()
setMaxBrightness()
}
private var oldBrightness: CGFloat?
/// Sets the screen brightness to 100% to make the QR code easier to scan.
/// Saves the old brightness in `oldBrightness` to be restored later.
/// Called automatically in `present(_:animated:)`.
private func setMaxBrightness() {
// Only allow this to be called once at a time so it doesn't save a
// previously-forced max brightness.
guard oldBrightness == nil else { return }
let screen = AppEnvironment.shared.windowManagerRef.rootWindow.screen
oldBrightness = screen.brightness
screen.brightness = 1.0
}
/// Restores the brightness to the value saved in `oldBrightness` by
/// `setMaxBrightness()` if the brightness is at 100%. Call this any time
/// a sheet is dismissed by setting the `SheetDismissalDelegate` of the
/// sheet to this view controller and calling `didDismissPresentedSheet()`
/// in its `viewDidDisappear(_:)`.
private func restoreBrightness() {
guard let oldBrightness else { return }
let screen = AppEnvironment.shared.windowManagerRef.rootWindow.screen
// If the brightness was adjusted manually below 100%, just keep that.
if screen.brightness >= 1.0 {
screen.brightness = oldBrightness
}
self.oldBrightness = nil
}
private func reloadTableContents() {
self.tableView.reloadData()
}
private func resetUsernameLink(shouldReloadTableContents: Bool = true) {
UsernameLogger.shared.info("Resetting username link!")
usernameLinkState = .resetting
if shouldReloadTableContents {
reloadTableContents()
}
Guarantee.wrapAsync {
await self.localUsernameManager.rotateUsernameLink()
}.map(on: DispatchQueue.main) { remoteMutationResult -> Usernames.RemoteMutationResult<Usernames.UsernameLink> in
let latestUsernameState: Usernames.LocalUsernameState = self.db.read { tx in
self.localUsernameManager.usernameState(tx: tx)
}
if let usernameLink = latestUsernameState.usernameLink {
self.usernameLinkState = .forUsernameLink(
usernameLink: usernameLink,
)
} else {
self.usernameLinkState = .corrupted
}
self.reloadTableContents()
self.usernameChangeDelegate?.usernameStateDidChange(
newState: latestUsernameState,
)
return remoteMutationResult
}.done(on: DispatchQueue.main) { remoteMutationResult in
switch remoteMutationResult {
case .success:
OWSActionSheets.showActionSheet(
message: OWSLocalizedString(
"USERNAME_LINK_QR_CODE_VIEW_RESET_SUCCESSFUL",
comment: "Text presenting an action sheet notifying the user their QR code and link were reset.",
),
fromViewController: self,
dismissalDelegate: self,
)
case .failure:
OWSActionSheets.showActionSheet(
message: OWSLocalizedString(
"USERNAME_LINK_QR_CODE_VIEW_LINK_NOT_SET",
comment: "Text presented in an action sheet notifying the user their qr code and link are not set.",
),
fromViewController: self,
dismissalDelegate: self,
)
}
}
}
private func showUsernameCopiedToast() {
self.presentToast(
text: OWSLocalizedString(
"USERNAME_LINK_QR_CODE_VIEW_USERNAME_COPIED",
comment: "Text presented in a toast notifying the user that their username was copied to the system clipboard.",
),
image: .copy,
)
}
private func showUsernameLinkCopiedToast() {
self.presentToast(
text: OWSLocalizedString(
"USERNAME_LINK_QR_CODE_VIEW_USERNAME_LINK_COPIED",
comment: "Text presented in a toast notifying the user that their username link was copied to the system clipboard.",
),
image: .copy,
)
}
override func present(_ viewControllerToPresent: UIViewController, animated flag: Bool, completion: (() -> Void)? = nil) {
super.present(viewControllerToPresent, animated: flag, completion: completion)
restoreBrightness()
}
}
extension UsernameLinkPresentQRCodeViewController: SheetDismissalDelegate {
func didDismissPresentedSheet() {
setMaxBrightness()
}
}
extension UsernameLinkPresentQRCodeViewController: UsernameLinkQRCodeColorPickerDelegate {
func didFinalizeSelectedColor(color: QRCodeColor) {
db.write { tx in
localUsernameManager.setUsernameLinkQRCodeColor(
color: color,
tx: tx,
)
}
SSKEnvironment.shared.storageServiceManagerRef.recordPendingLocalAccountUpdates()
self.qrCodeColor = color
reloadTableContents()
}
}