session-ios/SignalMessaging/utils/ProximityMonitoringManager.swift

//
//  Copyright (c) 2018 Open Whisper Systems. All rights reserved.
//

@objc
public protocol OWSProximityMonitoringManager: class {
    func add(lifetime: AnyObject)
    func remove(lifetime: AnyObject)
}

@objc
public class OWSProximityMonitoringManagerImpl: NSObject, OWSProximityMonitoringManager {
    var lifetimes: [Weak<AnyObject>] = []

    public override init() {
        super.init()

        // TODO: change to `runNowOrWhenAppWillBecomeReady` when
        // reverse integrating
        AppReadiness.runNowOrWhenAppIsReady {
            self.setup()
        }
    }

    // MARK: 

    var device: UIDevice {
        return UIDevice.current
    }

    // MARK: 

    @objc
    public func add(lifetime: AnyObject) {
        objc_sync_enter(self)

        if !lifetimes.contains { $0.value === lifetime } {
            lifetimes.append(Weak(value: lifetime))
        }
        reconcile()

        objc_sync_exit(self)
    }

    @objc
    public func remove(lifetime: AnyObject) {
        objc_sync_enter(self)

        lifetimes = lifetimes.filter { $0.value !== lifetime }
        reconcile()

        objc_sync_exit(self)
    }

    @objc
    public func setup() {
        NotificationCenter.default.addObserver(self, selector: #selector(proximitySensorStateDidChange(notification:)), name: .UIDeviceProximityStateDidChange, object: nil)
    }

    @objc
    func proximitySensorStateDidChange(notification: Notification) {
        Logger.debug("")
        // This is crazy, but if we disable `device.isProximityMonitoringEnabled` while
        // `device.proximityState` is true (while the device is held to the ear)
        // then `device.proximityState` remains true, even after we bring the phone
        // away from the ear and re-enable monitoring.
        //
        // To resolve this, we wait to disable proximity monitoring until `proximityState`
        // is false.
        if self.device.proximityState {
            self.add(lifetime: self)
        } else {
            self.remove(lifetime: self)
        }
    }

    func reconcile() {
        lifetimes = lifetimes.filter { $0.value != nil }
        if lifetimes.isEmpty {
            DispatchQueue.main.async {
                Logger.debug("disabling proximity monitoring")
                self.device.isProximityMonitoringEnabled = false
            }
        } else {
            let lifetimes = self.lifetimes
            DispatchQueue.main.async {
                Logger.debug("willEnable proximity monitoring for lifetimes: \(lifetimes), proximityState: \(self.device.proximityState)")
                self.device.isProximityMonitoringEnabled = true
                Logger.debug("didEnable proximity monitoring for lifetimes: \(lifetimes), proximityState: \(self.device.proximityState)")
            }
        }
    }
}