react-native-bg-geolocation 0.2.0

package/ios/engine/AtomicBoolean.swift

@@ -0,0 +1,48 @@
+import Foundation
+
+@objc public final class AtomicBoolean: NSObject {
+
+    private var _value: Bool = false
+    private var _lock = os_unfair_lock_s()
+
+    @objc public override init() {
+        super.init()
+        setValue(false)
+    }
+
+    @objc public init(value: Bool) {
+        super.init()
+        _value = value
+    }
+
+    @objc public func getValue() -> Bool {
+        os_unfair_lock_lock(&_lock)
+        let v = _value
+        os_unfair_lock_unlock(&_lock)
+        return v
+    }
+
+    @objc public func setValue(_ value: Bool) {
+        os_unfair_lock_lock(&_lock)
+        _value = value
+        os_unfair_lock_unlock(&_lock)
+    }
+
+    @objc public func compareTo(_ expected: Bool, andSetValue newValue: Bool) -> Bool {
+        os_unfair_lock_lock(&_lock)
+        defer { os_unfair_lock_unlock(&_lock) }
+        if _value == expected {
+            _value = newValue
+            return true
+        }
+        return false
+    }
+
+    @objc public func getAndSetValue(_ newValue: Bool) -> Bool {
+        os_unfair_lock_lock(&_lock)
+        let old = _value
+        _value = newValue
+        os_unfair_lock_unlock(&_lock)
+        return old
+    }
+}

package/ios/engine/BGActivityChangeEvent.swift

@@ -0,0 +1,20 @@
+import Foundation
+
+@objc public final class BGActivityChangeEvent: NSObject {
+
+    @objc public private(set) var confidence: Int
+    @objc public private(set) var activity: String
+
+    @objc public init(activityName: String?, confidence: Int) {
+        self.confidence = confidence
+        self.activity = activityName ?? "unknown"
+        super.init()
+    }
+
+    @objc public func toDictionary() -> [String: Any] {
+        return [
+            "activity": activity,
+            "confidence": confidence
+        ]
+    }
+}

package/ios/engine/BGActivityConfig.swift

@@ -0,0 +1,71 @@
+import Foundation
+
+@objc public final class BGActivityConfig: BGConfigModuleBase {
+
+    @objc public var disableMotionActivityUpdates: Bool = false
+    @objc public var disableStopDetection: Bool = false
+    @objc public var stopOnStationary: Bool = false
+    @objc public var stopDetectionDelay: Double = 0
+    @objc public var activityRecognitionInterval: Double = 0
+    @objc public var minimumActivityRecognitionConfidence: Int = 0
+    @objc public var triggerActivities: String = ""
+
+    @objc public override func applyDefaults() {
+        stopDetectionDelay = 0
+        activityRecognitionInterval = 10000.0
+        minimumActivityRecognitionConfidence = 70
+        disableMotionActivityUpdates = false
+        disableStopDetection = false
+        stopOnStationary = false
+        triggerActivities = ""
+    }
+
+    @objc public override func propertySpecs() -> [BGPropertySpecImpl] {
+        return [
+            BGPropertySpecImpl(name: "stopDetectionDelay", type: "integer"),
+            BGPropertySpecImpl(name: "activityRecognitionInterval", type: "integer"),
+            BGPropertySpecImpl(name: "minimumActivityRecognitionConfidence", type: "integer"),
+            BGPropertySpecImpl(name: "disableMotionActivityUpdates", type: "bool"),
+            BGPropertySpecImpl(name: "disableStopDetection", type: "bool"),
+            BGPropertySpecImpl(name: "stopOnStationary", type: "bool"),
+            BGPropertySpecImpl(name: "triggerActivities", type: "string")
+        ]
+    }
+
+    @objc public override func contributeDeprecatedProperties(_ dict: NSMutableDictionary, redact: Bool) {
+        dict.setObject(NSNumber(value: stopDetectionDelay), forKey: "stopDetectionDelay" as NSString)
+        dict.setObject(NSNumber(value: activityRecognitionInterval), forKey: "activityRecognitionInterval" as NSString)
+        dict.setObject(NSNumber(value: minimumActivityRecognitionConfidence), forKey: "minimumActivityRecognitionConfidence" as NSString)
+        dict.setObject(NSNumber(value: disableMotionActivityUpdates), forKey: "disableMotionActivityUpdates" as NSString)
+        dict.setObject(NSNumber(value: disableStopDetection), forKey: "disableStopDetection" as NSString)
+        dict.setObject(NSNumber(value: stopOnStationary), forKey: "stopOnStationary" as NSString)
+        dict.setObject(triggerActivities, forKey: "triggerActivities" as NSString)
+    }
+
+    @objc public override func validateConfiguration() -> Bool {
+        if disableStopDetection && stopOnStationary {
+            let logger = BGLog.sharedInstance()
+            if logger.shouldLog(2) {
+                let message = "BGActivityConfig: stopOnStationary is enabled but disableStopDetection is also enabled - stopOnStationary will have no effect"
+                logger.log(2, tag: 9, function: "-[BGActivityConfig validateConfiguration]", message: message)
+            }
+        }
+        if disableMotionActivityUpdates && !disableStopDetection {
+            let logger = BGLog.sharedInstance()
+            if logger.shouldLog(2) {
+                let message = "BGActivityConfig: Motion activity updates are disabled but stop detection is enabled - stop detection may not work properly"
+                logger.log(2, tag: 9, function: "-[BGActivityConfig validateConfiguration]", message: message)
+            }
+        }
+        return true
+    }
+
+    public override var description: String {
+        return String(format: "<%@: %p> {\n  stopDetectionDelay: %.0fs\n  activityRecognitionInterval: %.0f ms\n  minimumActivityRecognitionConfidence: %ld%%\n  disableMotionActivityUpdates: %@\n  disableStopDetection: %@\n  stopOnStationary: %@\n}",
+                      String(describing: type(of: self)), self,
+                      stopDetectionDelay, activityRecognitionInterval, minimumActivityRecognitionConfidence,
+                      disableMotionActivityUpdates ? "YES" : "NO",
+                      disableStopDetection ? "YES" : "NO",
+                      stopOnStationary ? "YES" : "NO")
+    }
+}

package/ios/engine/BGAppConfig.swift

@@ -0,0 +1,92 @@
+import Foundation
+
+@objc public class BGAppConfig: BGConfigModuleBase {
+
+    @objc public var stopOnTerminate: Bool = true
+    @objc public var startOnBoot: Bool = false
+    @objc public var preventSuspend: Bool = false
+    @objc public var heartbeatInterval: Double = 60.0
+    @objc public var schedule: [String] = []
+    @objc public var liveActivityEnabled: Bool = false
+    @objc public var liveActivityTitle: String = "Live location"
+    @objc public var liveActivitySubtitle: String = "Background tracking is active"
+    @objc public var liveActivityUpdateInterval: Double = 15.0
+    @objc public var liveActivityStaleSeconds: Double = 120.0
+    @objc public var liveActivityPushUpdates: Bool = false
+    @objc public var locationPushEnabled: Bool = false
+    @objc public var trackingAudioEnabled: Bool = false
+    @objc public var trackingAudioVolume: Double = 0.04
+    @objc public var trackingAudioMixWithOthers: Bool = true
+
+    @objc public override func applyDefaults() {
+        stopOnTerminate = true
+        startOnBoot = false
+        preventSuspend = false
+        heartbeatInterval = 60.0
+        schedule = []
+        liveActivityEnabled = false
+        liveActivityTitle = "Live location"
+        liveActivitySubtitle = "Background tracking is active"
+        liveActivityUpdateInterval = 15.0
+        liveActivityStaleSeconds = 120.0
+        liveActivityPushUpdates = false
+        locationPushEnabled = false
+        trackingAudioEnabled = false
+        trackingAudioVolume = 0.04
+        trackingAudioMixWithOthers = true
+    }
+
+    @objc public var hasSchedule: Bool {
+        return !schedule.isEmpty
+    }
+
+    @objc public var isBackgroundExecutionEnabled: Bool {
+        return !stopOnTerminate || startOnBoot || preventSuspend
+    }
+
+    @objc public override func propertySpecs() -> [BGPropertySpecImpl] {
+        return [
+            BGPropertySpec(name: "stopOnTerminate", type: "bool"),
+            BGPropertySpec(name: "startOnBoot", type: "bool"),
+            BGPropertySpec(name: "preventSuspend", type: "bool"),
+            BGPropertySpec(name: "heartbeatInterval", type: "double"),
+            BGPropertySpec(name: "schedule", type: "array"),
+            BGPropertySpec(name: "liveActivityEnabled", type: "bool"),
+            BGPropertySpec(name: "liveActivityTitle", type: "string"),
+            BGPropertySpec(name: "liveActivitySubtitle", type: "string"),
+            BGPropertySpec(name: "liveActivityUpdateInterval", type: "double"),
+            BGPropertySpec(name: "liveActivityStaleSeconds", type: "double"),
+            BGPropertySpec(name: "liveActivityPushUpdates", type: "bool"),
+            BGPropertySpec(name: "locationPushEnabled", type: "bool"),
+            BGPropertySpec(name: "trackingAudioEnabled", type: "bool"),
+            BGPropertySpec(name: "trackingAudioVolume", type: "double"),
+            BGPropertySpec(name: "trackingAudioMixWithOthers", type: "bool")
+        ]
+    }
+
+    @objc public override func contributeDeprecatedProperties(_ dict: NSMutableDictionary, redact: Bool) {
+        dict["stopOnTerminate"] = stopOnTerminate
+        dict["startOnBoot"] = startOnBoot
+        dict["preventSuspend"] = preventSuspend
+        dict["heartbeatInterval"] = heartbeatInterval
+        dict["schedule"] = schedule
+        dict["liveActivityEnabled"] = liveActivityEnabled
+        dict["liveActivityTitle"] = liveActivityTitle
+        dict["liveActivitySubtitle"] = liveActivitySubtitle
+        dict["liveActivityUpdateInterval"] = liveActivityUpdateInterval
+        dict["liveActivityStaleSeconds"] = liveActivityStaleSeconds
+        dict["liveActivityPushUpdates"] = liveActivityPushUpdates
+        dict["locationPushEnabled"] = locationPushEnabled
+        dict["trackingAudioEnabled"] = trackingAudioEnabled
+        dict["trackingAudioVolume"] = trackingAudioVolume
+        dict["trackingAudioMixWithOthers"] = trackingAudioMixWithOthers
+    }
+
+    @objc public override func validateConfiguration() -> Bool {
+        return true
+    }
+
+    @objc public override var description: String {
+        return "<BGAppConfig stopOnTerminate=\(stopOnTerminate) startOnBoot=\(startOnBoot) preventSuspend=\(preventSuspend) heartbeatInterval=\(heartbeatInterval)>"
+    }
+}

package/ios/engine/BGAppState.swift

@@ -0,0 +1,147 @@
+import Foundation
+import UIKit
+import CoreLocation
+
+@objc public class BGAppState: NSObject {
+
+    private static var _sharedInstance: BGAppState?
+    private static let onceLock = NSLock()
+
+    @objc public var isInBackground: Bool = false
+    @objc public var clientReady: Bool = false
+    @objc public var didLaunchInBackground: Bool = false
+    @objc public var foregroundObserved: Bool = false
+    @objc public var flippedToUserInitiated: Bool = false
+    @objc public var heuristicResult: String?
+    @objc public var heuristicTimerFired: Bool = false
+    @objc public var launchClassificationFinalized: Bool = false
+    @objc public var resolvingRoot: Bool = false
+    @objc public var readyCallbackDelivered: Bool = false
+    @objc public var launchTimestamp: Date?
+    @objc public var heuristicTimer: Timer?
+    @objc public var rootViewController: UIViewController?
+    @objc public var readyCallback: (([String: Any]) -> Void)?
+    @objc public var pendingRootCallbacks: [[String: Any]] = []
+
+    @objc public class func sharedInstance() -> BGAppState {
+        onceLock.lock()
+        defer { onceLock.unlock() }
+        if _sharedInstance == nil {
+            _sharedInstance = BGAppState()
+        }
+        return _sharedInstance!
+    }
+
+    @objc public override init() {
+        super.init()
+        launchTimestamp = Date()
+        isInBackground = UIApplication.shared.applicationState == .background
+        didLaunchInBackground = isInBackground || UserDefaults.standard.bool(forKey: "BGLocationManager_didLaunchInBackground")
+        setupNotifications()
+    }
+
+    deinit {
+        NotificationCenter.default.removeObserver(self)
+        cancelHeuristicTimer()
+    }
+
+    private func setupNotifications() {
+        NotificationCenter.default.addObserver(self, selector: #selector(onDidBecomeActive),
+                                               name: UIApplication.didBecomeActiveNotification, object: nil)
+        NotificationCenter.default.addObserver(self, selector: #selector(onEnterBackground),
+                                               name: UIApplication.didEnterBackgroundNotification, object: nil)
+        NotificationCenter.default.addObserver(self, selector: #selector(onEnterForeground),
+                                               name: UIApplication.willEnterForegroundNotification, object: nil)
+        NotificationCenter.default.addObserver(self, selector: #selector(onWillTerminate),
+                                               name: UIApplication.willTerminateNotification, object: nil)
+    }
+
+    @objc public func onDidBecomeActive() {
+        isInBackground = false
+        foregroundObserved = true
+        BGTrackingService.sharedInstance().onResume()
+    }
+
+    @objc public func onEnterBackground() {
+        isInBackground = true
+        startHeuristicTimerIfNeeded()
+        BGTrackingService.sharedInstance().onSuspend()
+    }
+
+    @objc public func onEnterForeground() {
+        isInBackground = false
+        cancelHeuristicTimer()
+    }
+
+    @objc public func onWillTerminate() {
+        BGTrackingService.sharedInstance().onAppTerminate()
+    }
+
+    @objc public func startHeuristicTimerIfNeeded() {
+        guard heuristicTimer == nil else { return }
+        heuristicTimer = Timer.scheduledTimer(timeInterval: 0.8,
+                                              target: self,
+                                              selector: #selector(heuristicTimerFiredAction),
+                                              userInfo: nil,
+                                              repeats: false)
+    }
+
+    @objc private func heuristicTimerFiredAction() {
+        heuristicTimerFired = true
+        heuristicTimer = nil
+    }
+
+    @objc public func cancelHeuristicTimer() {
+        heuristicTimer?.invalidate()
+        heuristicTimer = nil
+    }
+
+    @objc public func ready(_ callback: @escaping ([String: Any]) -> Void) {
+        readyCallback = callback
+        if readyCallbackDelivered {
+            callback([:])
+        }
+    }
+
+    @objc public func hasBackgroundLocationMode() -> Bool {
+        guard let modes = Bundle.main.object(forInfoDictionaryKey: "UIBackgroundModes") as? [String] else {
+            return false
+        }
+        return modes.contains("location")
+    }
+
+    @objc public func hasAnyLocationUsageDescription() -> Bool {
+        let keys = ["NSLocationAlwaysUsageDescription",
+                    "NSLocationWhenInUseUsageDescription",
+                    "NSLocationAlwaysAndWhenInUseUsageDescription"]
+        return keys.contains { Bundle.main.object(forInfoDictionaryKey: $0) != nil }
+    }
+
+    @objc public func canShowBackgroundLocationIndicator() -> Bool {
+        if #available(iOS 13.0, *) {
+            return true
+        }
+        return false
+    }
+
+    @objc public func applySafeBackgroundLocationSettings(toManager manager: CLLocationManager,
+                                                          showsIndicator: Bool) {
+        if #available(iOS 11.0, *) {
+            manager.showsBackgroundLocationIndicator = showsIndicator
+        }
+    }
+
+    @objc public func getRootViewController(_ completion: @escaping (UIViewController?) -> Void) {
+        DispatchQueue.main.async {
+            completion(self.topPresenter())
+        }
+    }
+
+    @objc public func topPresenter() -> UIViewController? {
+        var top = UIApplication.shared.windows.first(where: { $0.isKeyWindow })?.rootViewController
+        while let presented = top?.presentedViewController {
+            top = presented
+        }
+        return top
+    }
+}

package/ios/engine/BGAuthorization.swift

@@ -0,0 +1,85 @@
+import Foundation
+
+@objc public class BGAuthorization: NSObject {
+
+    @objc public var strategy: String = "JWT"
+    @objc public var accessToken: String?
+    @objc public var refreshToken: String?
+    @objc public var refreshUrl: String?
+    @objc public var refreshHeaders: [String: String] = [:]
+    @objc public var refreshPayload: [String: Any] = [:]
+    @objc public var expires: Date?
+
+    @objc public var accessRE: String?
+    @objc public var accessTokenRE: String?
+    @objc public var refreshTokenRE: String?
+    @objc public var refreshRenewRE: String?
+    @objc public var expiresRE: String?
+
+    @objc public var config: BGAuthorizationConfig?
+
+    @objc public override init() {
+        super.init()
+    }
+
+    @objc public func applyResponseData(_ data: [String: Any]) {
+        if let token = resolveValue(data, pattern: accessTokenRE) ?? data["access_token"] as? String {
+            accessToken = token
+        }
+        if let refresh = resolveValue(data, pattern: refreshTokenRE) ?? data["refresh_token"] as? String {
+            refreshToken = refresh
+        }
+        if let expiry = resolveValue(data, pattern: expiresRE) ?? data["expires_at"] as? String {
+            let formatter = ISO8601DateFormatter()
+            expires = formatter.date(from: expiry)
+        }
+    }
+
+    private func resolveValue(_ data: [String: Any], pattern: String?) -> String? {
+        guard let pattern = pattern, !pattern.isEmpty else { return nil }
+        return data[pattern] as? String
+    }
+
+    public func refreshAuthorization(_ headers: inout [String: String], statusCode: Int) -> Bool {
+        guard statusCode == 401, let refreshUrl = refreshUrl, !refreshUrl.isEmpty else { return false }
+        return true
+    }
+
+    @objc public func resolve(
+        _ request: URLRequest,
+        success: @escaping (_ request: URLRequest) -> Void,
+        failure: @escaping (_ error: Error) -> Void
+    ) {
+        var req = request
+        if let token = accessToken {
+            req.setValue("Bearer \(token)", forHTTPHeaderField: "Authorization")
+        }
+        success(req)
+    }
+
+    @objc public func toDictionary() -> [String: Any] {
+        return toDictionary(false)
+    }
+
+    @objc public func toDictionary(_ redact: Bool) -> [String: Any] {
+        var dict: [String: Any] = ["strategy": strategy]
+        if redact {
+            dict["accessToken"] = "**redacted**"
+            dict["refreshToken"] = "**redacted**"
+        } else {
+            if let t = accessToken { dict["accessToken"] = t }
+            if let t = refreshToken { dict["refreshToken"] = t }
+        }
+        if let u = refreshUrl { dict["refreshUrl"] = u }
+        if let e = expires { dict["expires"] = e.timeIntervalSince1970 }
+        return dict
+    }
+
+    @objc public func toString() -> String {
+        return "<BGAuthorization strategy=\(strategy)>"
+    }
+
+    @objc public override var description: String {
+        return toString()
+    }
+}

package/ios/engine/BGAuthorizationAlertPresenter.swift

@@ -0,0 +1,39 @@
+import Foundation
+import UIKit
+
+@objc public class BGAuthorizationAlertPresenter: NSObject {
+
+    @objc public var authorization: BGAuthorization?
+    @objc public var alertController: UIAlertController?
+
+    @objc public init(authorization: BGAuthorization) {
+        self.authorization = authorization
+        super.init()
+    }
+
+    @objc public var isAlertVisible: Bool {
+        return alertController != nil && alertController?.view.window != nil
+    }
+
+    @objc public func getAlertController(withCancelHandler handler: (() -> Void)?) -> UIAlertController {
+        let alert = UIAlertController(
+            title: "Location Authorization",
+            message: "This app requires location access. Please enable it in Settings.",
+            preferredStyle: .alert
+        )
+        alert.addAction(UIAlertAction(title: "Settings", style: .default) { _ in
+            if let url = URL(string: UIApplication.openSettingsURLString) {
+                UIApplication.shared.open(url)
+            }
+        })
+        alert.addAction(UIAlertAction(title: "Cancel", style: .cancel) { _ in
+            handler?()
+        })
+        return alert
+    }
+
+    @objc public func dismissAlert() {
+        alertController?.dismiss(animated: true)
+        alertController = nil
+    }
+}

package/ios/engine/BGAuthorizationConfig.swift

@@ -0,0 +1,50 @@
+import Foundation
+
+@objc public class BGAuthorizationConfig: BGConfigModuleBase {
+
+    @objc public var strategy: String = "JWT"
+    @objc public var accessToken: String?
+    @objc public var refreshToken: String?
+    @objc public var refreshUrl: String?
+    @objc public var refreshHeaders: [String: String] = [:]
+    @objc public var refreshPayload: [String: Any] = [:]
+    @objc public var expires: Date?
+
+    @objc public override func applyDefaults() {
+        strategy = "JWT"
+        accessToken = nil
+        refreshToken = nil
+        refreshUrl = nil
+        refreshHeaders = [:]
+        refreshPayload = [:]
+        expires = nil
+    }
+
+    @objc public func moduleKey() -> String {
+        return "authorization"
+    }
+
+    @objc public override func deprecatedPropertyMappings() -> [String: String] {
+        return [:]
+    }
+
+    @objc public override func sensitivePropertyNames() -> [String] {
+        return ["accessToken", "refreshToken"]
+    }
+
+    @objc public override func propertySpecs() -> [BGPropertySpecImpl] {
+        return [
+            BGPropertySpec(name: "strategy", type: "string"),
+            BGPropertySpec(name: "accessToken", type: "string"),
+            BGPropertySpec(name: "refreshToken", type: "string"),
+            BGPropertySpec(name: "refreshUrl", type: "string"),
+            BGPropertySpec(name: "refreshHeaders", type: "object"),
+            BGPropertySpec(name: "refreshPayload", type: "object"),
+            BGPropertySpec(name: "expires", type: "date")
+        ]
+    }
+
+    @objc public func apply(_ dict: [String: Any]) {
+        updateWithDictionary(dict)
+    }
+}

package/ios/engine/BGAuthorizationEvent.swift

@@ -0,0 +1,40 @@
+import Foundation
+
+@objc public final class BGAuthorizationEvent: NSObject {
+
+    @objc public private(set) var status: Int
+    @objc public private(set) var error: Error?
+    @objc public private(set) var response: Any?
+
+    @objc public init(response: Any?, status: Int) {
+        self.status = status
+        self.error = nil
+        self.response = response
+        super.init()
+    }
+
+    @objc public init(error: Error?, status: Int) {
+        self.status = status
+        self.error = error
+        self.response = [AnyHashable: Any]()
+        super.init()
+    }
+
+    @objc public func toDictionary() -> [String: Any] {
+        if let error = error {
+            return [
+                "status": status,
+                "success": false,
+                "error": (error as NSError).localizedDescription,
+                "response": NSNull()
+            ]
+        } else {
+            return [
+                "status": status,
+                "success": true,
+                "error": NSNull(),
+                "response": response ?? NSNull()
+            ]
+        }
+    }
+}