// // Copyright 2021 Signal Messenger, LLC // SPDX-License-Identifier: AGPL-3.0-only // import AVFoundation import Foundation import SignalMessaging import SignalServiceKit import Vision public enum QRCodeScanOutcome: UInt { case stopScanning case continueScanning } // MARK: - public protocol QRCodeScanDelegate: AnyObject { // A QR code scan might yield a String payload, Data payload or both. // // * Traditional QR code payloads are Strings, but that's not true of // payloads like our safety numbers/fingerprints. In that case, // a Data payload will be present but not a String payload. // * iOS tries to parse QR code payloads as Strings but doesn't // expose the underlying Data payload, only the "codewords" (an // encoded form of the Data payload). // We use QRCodePayload to parse the Data payload from the // "codewords". QRCodePayload only supports a narrow set of "modes" // & "configurations". iOS supports presumably the entire QR code // standard. If a QR code contains Kanji, for example, a String // payload will be present (parsed by iOS) but not a Data payload. // // In some scenarios, we require a Data payload. If a Data payload // cannot be parsed, qrCodeScanViewScanned should presumably exit // and return .continueScanning to ignore the scanned QR code. Or // an error alert might be presented. // // In other scenarios, we require a String payload, e.g. when we // expect a URL. Similarly, if a String payload is required and // not present, we probably want to ignore the scanned QR code and // continue scanning. @discardableResult func qrCodeScanViewScanned(_ qrCodeScanViewController: QRCodeScanViewController, qrCodeData: Data?, qrCodeString: String?) -> QRCodeScanOutcome // QRCodeScanViewController DRYs up asking for camera permissions, etc. // If scanning cannot be performed (e.g. a user declined to grant camera // permissions), the delegate will be asked to dismiss. func qrCodeScanViewDismiss(_ qrCodeScanViewController: QRCodeScanViewController) } // MARK: - public class QRCodeScanViewController: OWSViewController { public enum Appearance: UInt { case normal case unadorned fileprivate var backgroundColor: UIColor { switch self { case .normal: return .ows_black case .unadorned: return .clear } } fileprivate var shouldMaskView: Bool { switch self { case .normal: return true case .unadorned: return false } } } private let appearance: Appearance public weak var delegate: QRCodeScanDelegate? private let delegateHasAcceptedScanResults = AtomicBool(false) private var scanner: QRCodeScanner? public required init(appearance: Appearance) { self.appearance = appearance super.init() } public override var prefersStatusBarHidden: Bool { guard !CurrentAppContext().hasActiveCall else { return false } return true } public override var prefersHomeIndicatorAutoHidden: Bool { return true } // MARK: - View Lifecycle public override func viewDidLoad() { AssertIsOnMainThread() super.viewDidLoad() view.backgroundColor = appearance.backgroundColor addObservers() } public override func viewDidAppear(_ animated: Bool) { AssertIsOnMainThread() super.viewDidAppear(animated) tryToStartScanning() } public override func viewDidDisappear(_ animated: Bool) { AssertIsOnMainThread() super.viewDidDisappear(animated) stopScanning() } // MARK: - Notifications private func addObservers() { AssertIsOnMainThread() NotificationCenter.default.addObserver( self, selector: #selector(didEnterBackground), name: .OWSApplicationDidEnterBackground, object: nil ) NotificationCenter.default.addObserver( self, selector: #selector(didBecomeActive), name: .OWSApplicationDidBecomeActive, object: nil ) } @objc private func didEnterBackground() { AssertIsOnMainThread() stopScanning() } @objc private func didBecomeActive() { AssertIsOnMainThread() tryToStartScanning() } // MARK: - Scanning private func stopScanning() { scanner = nil } @objc public func tryToStartScanning() { AssertIsOnMainThread() guard nil == scanner else { return } self.ows_askForCameraPermissions { [weak self] granted in guard let self = self else { return } if granted { self.startScanning() } else { self.delegate?.qrCodeScanViewDismiss(self) } } } private func startScanning() { AssertIsOnMainThread() guard scanner == nil, !delegateHasAcceptedScanResults.get() else { return } let scanner = QRCodeScanner(sampleBufferDelegate: self) self.scanner = scanner view.removeAllSubviews() let previewView = scanner.previewView view.addSubview(previewView) previewView.autoPinEdgesToSuperviewEdges() if appearance.shouldMaskView { let maskingView = BezierPathView { layer, bounds in // Add a circular mask let path = UIBezierPath(rect: bounds) let margin = CGFloat.scaleFromIPhone5To7Plus(8, 16) // Center the circle's bounding rectangle let circleDiameter = bounds.size.smallerAxis - margin * 2 let circleSize = CGSize.square(circleDiameter) let circleRect = CGRect(origin: (bounds.size - circleSize).asPoint * 0.5, size: circleSize) let circlePath = UIBezierPath(roundedRect: circleRect, cornerRadius: circleDiameter / 2) path.append(circlePath) path.usesEvenOddFillRule = true layer.path = path.cgPath layer.fillRule = .evenOdd layer.fillColor = UIColor.gray.cgColor layer.opacity = 0.5 } self.view.addSubview(maskingView) maskingView.autoPinEdgesToSuperviewEdges() } firstly { scanner.startVideoCapture() }.done { Logger.info("Ready.") }.catch { [weak self] error in owsFailDebug("Error: \(error)") guard let self = self else { return } self.showFailureUI(error: error) } } private func showFailureUI(error: Error) { Logger.error("error: \(error)") OWSActionSheets.showActionSheet(title: nil, message: error.userErrorDescription, buttonTitle: CommonStrings.dismissButton, buttonAction: { [weak self] _ in guard let self = self else { return } self.delegate?.qrCodeScanViewDismiss(self) }) } private lazy var detectQRCodeRequest: VNDetectBarcodesRequest = { let request = VNDetectBarcodesRequest { [weak self] request, error in guard let self = self else { return } if let error = error { DispatchQueue.main.async { self.showFailureUI(error: error) } return } self.processClassification(request) } request.symbologies = [ .qr ] return request }() private func processClassification(_ request: VNRequest) { guard !delegateHasAcceptedScanResults.get() else { return } func filterBarcodes() -> [VNBarcodeObservation] { guard let results = request.results else { return [] } return results.compactMap { $0 as? VNBarcodeObservation }.filter { (barcode: VNBarcodeObservation) in guard barcode.symbology == .qr else { owsFailDebug("Invalid symbology.") return false } guard nil != barcode.barcodeDescriptor as? CIQRCodeDescriptor else { owsFailDebug("Invalid barcodeDescriptor.") return false } guard barcode.confidence > 0.9 else { // Require high confidence. return false } return true } } let barcodes: [VNBarcodeObservation] = filterBarcodes().sorted { // If multiple bardcodes found, prefer barcode with higher confidence. // In practice, all QR codes have confidence of 1.0. $0.confidence > $1.confidence } struct QRCode { let qrCodeCodewords: Data let qrCodeVersion: Int // One or both will be non-nil. let qrCodeString: String? let qrCodeData: Data? } let qrCodes: [QRCode] = barcodes.compactMap { barcode in guard let barcodeDescriptor = barcode.barcodeDescriptor as? CIQRCodeDescriptor else { return nil } let qrCodeCodewords = barcodeDescriptor.errorCorrectedPayload let qrCodeVersion = barcodeDescriptor.symbolVersion let qrCodeString: String? = barcode.payloadStringValue let qrCodeData: Data? = QRCodePayload.parse( codewords: qrCodeCodewords, qrCodeVersion: qrCodeVersion )?.data guard qrCodeString != nil || qrCodeData != nil else { return nil } return QRCode( qrCodeCodewords: qrCodeCodewords, qrCodeVersion: qrCodeVersion, qrCodeString: qrCodeString, qrCodeData: qrCodeData ) } guard let qrCode = qrCodes.first else { return } Logger.info("Scanned QR Code.") DispatchQueue.main.async { [weak self] in guard let self = self, let delegate = self.delegate, !self.delegateHasAcceptedScanResults.get() else { return } let outcome = delegate.qrCodeScanViewScanned( self, qrCodeData: qrCode.qrCodeData, qrCodeString: qrCode.qrCodeString ) switch outcome { case .stopScanning: self.delegateHasAcceptedScanResults.set(true) self.stopScanning() ImpactHapticFeedback.impactOccurred(style: .medium) case .continueScanning: break } } } } // MARK: - private enum QRCodeError: Error { case invalidCodewords case unknownMode case unsupportedConfiguration case invalidLength } // MARK: - // iOS tries to parse QR code payloads as Strings but doesn't // expose the underlying Data payload, only the "codewords" (an // encoded form of the Data payload). // // QRCodePayload can parse some Data payloads from the "codewords". // QRCodePayload only supports a narrow set of "modes" // & "configurations", but this is sufficient for the cases where // we need it: safety number fingerprints. // // This isn't an efficient way to parse the codewords, but // correctness matters and perf doesn't, since QR code payloads // are inherently small. Therefore, this approach favors simplicity // over efficiency. public class QRCodePayload { public let version: Int public let mode: Mode public let bytes: [UInt8] public var data: Data { Data(bytes) } public var asString: String? { String(data: data, encoding: .utf8) } init(version: Int, mode: Mode, bytes: [UInt8]) { self.version = version self.mode = mode self.bytes = bytes } // There are even more modes, but it'll improve logging a bit // to identify these modes even though we don't support them. // // TODO: We currently only support .byte mode. public enum Mode: UInt { case numeric = 1 case alphaNumeric = 2 case bytes = 4 case kanji = 8 } public static func parse(codewords: Data, qrCodeVersion version: Int) -> QRCodePayload? { // QR Code Standard // ISO/IEC 18004:2015 // https://www.iso.org/standard/62021.html do { let bitstream = QRCodeBitStream(codewords: codewords) let modeLength: UInt = 4 let modeBits = try bitstream.readUInt8(bitCount: modeLength) guard let mode = Mode(rawValue: UInt(modeBits)) else { let ignoreUnknownMode = CurrentAppContext().isRunningTests if ignoreUnknownMode { Logger.error("Invalid mode: \(modeBits)") return nil } else { owsFailDebug("Invalid mode: \(modeBits)") } throw QRCodeError.unknownMode } // TODO: We currently only support .byte mode. guard mode == .bytes else { Logger.warn("Unsupported mode: \(mode)") throw QRCodeError.unsupportedConfiguration } let characterCountLength = try characterCountIndicatorLengthBits(version: version, mode: mode) let characterCount = try bitstream.readUInt32(bitCount: characterCountLength) guard characterCount > 0 else { Logger.error("Invalid length: \(characterCount)") throw QRCodeError.invalidLength } // TODO: We currently only support .byte mode. var bytes = [UInt8]() for _ in 0.. UInt { if version >= 1, version <= 9 { switch mode { case .numeric: return 10 case .alphaNumeric: return 9 case .bytes: return 8 case .kanji: return 8 } } else if version >= 10, version <= 26 { switch mode { case .numeric: return 12 case .alphaNumeric: return 11 case .bytes: return 16 case .kanji: return 10 } } else if version >= 27, version <= 40 { switch mode { case .numeric: return 14 case .alphaNumeric: return 13 case .bytes: return 16 case .kanji: return 12 } } throw QRCodeError.unsupportedConfiguration } } // MARK: - // This isn't an efficient way to parse the codewords, but // correctness matters and perf doesn't, since QR code payloads // are inherently small. private class QRCodeBitStream { private var bits: [UInt8] required init(codewords: Data) { var bits = [UInt8]() for codeword in codewords { var codeword: UInt8 = codeword var codewordBits = [UInt8]() for _ in 0..<8 { let bit = codeword & 1 codeword = codeword >> 1 codewordBits.append(UInt8(bit)) } owsAssertDebug(codeword == 0) // We reverse; we want to stream bits in "most significant-to-least-significant" // order. bits.append(contentsOf: codewordBits.reversed()) } self.bits = bits } private func readBit() throws -> UInt8 { guard !bits.isEmpty else { throw QRCodeError.invalidCodewords } return bits.removeFirst() } fileprivate func readUInt8(bitCount: UInt) throws -> UInt8 { owsAssertDebug(bitCount > 0) owsAssertDebug(bitCount <= 8) return UInt8(try readUInt32(bitCount: bitCount)) } fileprivate func readUInt32(bitCount: UInt) throws -> UInt32 { owsAssertDebug(bitCount > 0) owsAssertDebug(bitCount <= 32) var result: UInt32 = 0 for _ in 0.. Promise { AssertIsOnMainThread() guard !Platform.isSimulator else { // Trying to actually set up the capture session will fail on a simulator // since we don't have actual capture devices. But it's useful to be able // to mostly run the capture code on the simulator to work with layout. return Promise.value(()) } // If the session is already running, no need to do anything. guard !self.session.isRunning else { return Promise.value(()) } if !hasRequestedDeviceOrientationNotifications { UIDevice.current.beginGeneratingDeviceOrientationNotifications() NotificationCenter.default.addObserver(self, selector: #selector(orientationDidChange), name: UIDevice.orientationDidChangeNotification, object: UIDevice.current) hasRequestedDeviceOrientationNotifications = true } let initialCaptureOrientation = AVCaptureVideoOrientation(deviceOrientation: UIDevice.current.orientation) ?? .portrait return sessionQueue.async(.promise) { [weak self] in guard let self = self else { return } self.session.beginConfiguration() defer { self.session.commitConfiguration() } self.captureOrientation = initialCaptureOrientation self.session.sessionPreset = .high try self.setCurrentInput() let videoDataOutput = self.output.videoDataOutput guard self.session.canAddOutput(videoDataOutput) else { owsFailDebug("!canAddOutput(videoDataOutput).") throw QRCodeScanError.initializationFailed } self.session.addOutput(videoDataOutput) guard let connection = videoDataOutput.connection(with: .video) else { owsFailDebug("Missing videoDataOutput.connection.") throw QRCodeScanError.initializationFailed } if connection.isVideoStabilizationSupported { connection.preferredVideoStabilizationMode = .auto } }.done(on: sessionQueue) { self.session.startRunning() } } public func assertIsOnSessionQueue() { assertOnQueue(sessionQueue) } // This method should be called on the serial queue, // and between calls to session.beginConfiguration/commitConfiguration public func setCurrentInput() throws { assertIsOnSessionQueue() let device = try selectCaptureDevice() Logger.verbose("device: \(device.deviceType), position: \(device.position)") try device.lockForConfiguration() // Setting (focus/exposure)PointOfInterest alone does not initiate a (focus/exposure) operation. // Call set(Focus/Exposure)Mode() to apply the new point of interest. let focusMode: AVCaptureDevice.FocusMode = .continuousAutoFocus if device.isFocusModeSupported(focusMode) { device.focusMode = focusMode } let exposureMode: AVCaptureDevice.ExposureMode = .continuousAutoExposure if device.isExposureModeSupported(exposureMode) { device.exposureMode = exposureMode } device.unlockForConfiguration() let newInput = try AVCaptureDeviceInput(device: device) session.addInput(newInput) } private func selectCaptureDevice() throws -> AVCaptureDevice { assertIsOnSessionQueue() // Camera types in descending order of preference. var deviceTypes = [AVCaptureDevice.DeviceType]() deviceTypes.append(.builtInWideAngleCamera) deviceTypes.append(.builtInUltraWideCamera) deviceTypes.append(.builtInDualWideCamera) deviceTypes.append(.builtInTripleCamera) deviceTypes.append(.builtInDualCamera) deviceTypes.append(.builtInTelephotoCamera) func selectDevice(session: AVCaptureDevice.DiscoverySession) -> AVCaptureDevice? { var deviceMap = [AVCaptureDevice.DeviceType: AVCaptureDevice]() for device in session.devices { deviceMap[device.deviceType] = device } for deviceType in deviceTypes { if let device = deviceMap[deviceType] { return device } } return nil } // Prefer a back-facing camera. let backSession = AVCaptureDevice.DiscoverySession(deviceTypes: deviceTypes, mediaType: .video, position: .back) if let device = selectDevice(session: backSession) { return device } // Failover to a front-facing camera. let frontSession = AVCaptureDevice.DiscoverySession(deviceTypes: deviceTypes, mediaType: .video, position: .front) if let device = selectDevice(session: frontSession) { return device } throw QRCodeScanError.assertionError(description: "Missing videoDevice.") } } // MARK: - private class QRCodeScanPreviewView: UIView { let previewLayer: AVCaptureVideoPreviewLayer override var bounds: CGRect { didSet { previewLayer.frame = bounds } } override var contentMode: UIView.ContentMode { get { switch previewLayer.videoGravity { case .resizeAspectFill: return .scaleAspectFill case .resizeAspect: return .scaleAspectFit case .resize: return .scaleToFill default: owsFailDebug("Unexpected contentMode") return .scaleToFill } } set { switch newValue { case .scaleAspectFill: previewLayer.videoGravity = .resizeAspectFill case .scaleAspectFit: previewLayer.videoGravity = .resizeAspect case .scaleToFill: previewLayer.videoGravity = .resize default: owsFailDebug("Unexpected contentMode") } } } init(session: AVCaptureSession) { previewLayer = AVCaptureVideoPreviewLayer(session: session) if Platform.isSimulator { // helpful for debugging layout on simulator which has no real capture device previewLayer.backgroundColor = UIColor.green.withAlphaComponent(0.4).cgColor } super.init(frame: .zero) self.contentMode = .scaleAspectFill previewLayer.frame = bounds layer.addSublayer(previewLayer) } required init?(coder aDecoder: NSCoder) { fatalError("init(coder:) has not been implemented") } } // MARK: - private class QRCodeScanOutput { let videoDataOutput = AVCaptureVideoDataOutput() // MARK: - Init required init(sampleBufferDelegate: AVCaptureVideoDataOutputSampleBufferDelegate) { videoDataOutput.videoSettings = [kCVPixelBufferPixelFormatTypeKey as String: Int(kCVPixelFormatType_32BGRA)] videoDataOutput.setSampleBufferDelegate( sampleBufferDelegate, queue: DispatchQueue.global(qos: DispatchQoS.QoSClass.default)) } } // MARK: - public extension AVCaptureVideoOrientation { init?(deviceOrientation: UIDeviceOrientation) { switch deviceOrientation { case .unknown: return nil case .portrait: self = .portrait case .portraitUpsideDown: self = .portraitUpsideDown case .landscapeLeft: self = .landscapeRight case .landscapeRight: self = .landscapeLeft case .faceUp: return nil case .faceDown: return nil @unknown default: return nil } } init?(interfaceOrientation: UIInterfaceOrientation) { switch interfaceOrientation { case .unknown: return nil case .portrait: self = .portrait case .portraitUpsideDown: self = .portraitUpsideDown case .landscapeLeft: self = .landscapeLeft case .landscapeRight: self = .landscapeRight @unknown default: return nil } } }