408 lines
13 KiB
Objective-C
408 lines
13 KiB
Objective-C
/**
|
|
* Copyright (c) 2015-present, Facebook, Inc.
|
|
* All rights reserved.
|
|
*
|
|
* This source code is licensed under the BSD-style license found in the
|
|
* LICENSE file in the root directory of this source tree. An additional grant
|
|
* of patent rights can be found in the PATENTS file in the same directory.
|
|
*/
|
|
|
|
#import "RCTLocationObserver.h"
|
|
|
|
#import <CoreLocation/CLError.h>
|
|
#import <CoreLocation/CLLocationManager.h>
|
|
#import <CoreLocation/CLLocationManagerDelegate.h>
|
|
|
|
#import <React/RCTAssert.h>
|
|
#import <React/RCTBridge.h>
|
|
#import <React/RCTConvert.h>
|
|
#import <React/RCTEventDispatcher.h>
|
|
#import <React/RCTLog.h>
|
|
|
|
typedef NS_ENUM(NSInteger, RCTPositionErrorCode) {
|
|
RCTPositionErrorDenied = 1,
|
|
RCTPositionErrorUnavailable,
|
|
RCTPositionErrorTimeout,
|
|
};
|
|
|
|
#define RCT_DEFAULT_LOCATION_ACCURACY kCLLocationAccuracyHundredMeters
|
|
|
|
typedef struct {
|
|
BOOL skipPermissionRequests;
|
|
} RCTLocationConfiguration;
|
|
|
|
typedef struct {
|
|
double timeout;
|
|
double maximumAge;
|
|
double accuracy;
|
|
double distanceFilter;
|
|
BOOL useSignificantChanges;
|
|
} RCTLocationOptions;
|
|
|
|
@implementation RCTConvert (RCTLocationOptions)
|
|
|
|
+ (RCTLocationConfiguration)RCTLocationConfiguration:(id)json
|
|
{
|
|
NSDictionary<NSString *, id> *options = [RCTConvert NSDictionary:json];
|
|
|
|
return (RCTLocationConfiguration) {
|
|
.skipPermissionRequests = [RCTConvert BOOL:options[@"skipPermissionRequests"]]
|
|
};
|
|
}
|
|
|
|
+ (RCTLocationOptions)RCTLocationOptions:(id)json
|
|
{
|
|
NSDictionary<NSString *, id> *options = [RCTConvert NSDictionary:json];
|
|
|
|
double distanceFilter = options[@"distanceFilter"] == NULL ? RCT_DEFAULT_LOCATION_ACCURACY
|
|
: [RCTConvert double:options[@"distanceFilter"]] ?: kCLDistanceFilterNone;
|
|
|
|
return (RCTLocationOptions){
|
|
.timeout = [RCTConvert NSTimeInterval:options[@"timeout"]] ?: INFINITY,
|
|
.maximumAge = [RCTConvert NSTimeInterval:options[@"maximumAge"]] ?: INFINITY,
|
|
.accuracy = [RCTConvert BOOL:options[@"enableHighAccuracy"]] ? kCLLocationAccuracyBest : RCT_DEFAULT_LOCATION_ACCURACY,
|
|
.distanceFilter = distanceFilter,
|
|
.useSignificantChanges = [RCTConvert BOOL:options[@"useSignificantChanges"]] ?: NO,
|
|
};
|
|
}
|
|
|
|
@end
|
|
|
|
static NSDictionary<NSString *, id> *RCTPositionError(RCTPositionErrorCode code, NSString *msg /* nil for default */)
|
|
{
|
|
if (!msg) {
|
|
switch (code) {
|
|
case RCTPositionErrorDenied:
|
|
msg = @"User denied access to location services.";
|
|
break;
|
|
case RCTPositionErrorUnavailable:
|
|
msg = @"Unable to retrieve location.";
|
|
break;
|
|
case RCTPositionErrorTimeout:
|
|
msg = @"The location request timed out.";
|
|
break;
|
|
}
|
|
}
|
|
|
|
return @{
|
|
@"code": @(code),
|
|
@"message": msg,
|
|
@"PERMISSION_DENIED": @(RCTPositionErrorDenied),
|
|
@"POSITION_UNAVAILABLE": @(RCTPositionErrorUnavailable),
|
|
@"TIMEOUT": @(RCTPositionErrorTimeout)
|
|
};
|
|
}
|
|
|
|
@interface RCTLocationRequest : NSObject
|
|
|
|
@property (nonatomic, copy) RCTResponseSenderBlock successBlock;
|
|
@property (nonatomic, copy) RCTResponseSenderBlock errorBlock;
|
|
@property (nonatomic, assign) RCTLocationOptions options;
|
|
@property (nonatomic, strong) NSTimer *timeoutTimer;
|
|
|
|
@end
|
|
|
|
@implementation RCTLocationRequest
|
|
|
|
- (void)dealloc
|
|
{
|
|
if (_timeoutTimer.valid) {
|
|
[_timeoutTimer invalidate];
|
|
}
|
|
}
|
|
|
|
@end
|
|
|
|
@interface RCTLocationObserver () <CLLocationManagerDelegate>
|
|
|
|
@end
|
|
|
|
@implementation RCTLocationObserver
|
|
{
|
|
CLLocationManager *_locationManager;
|
|
NSDictionary<NSString *, id> *_lastLocationEvent;
|
|
NSMutableArray<RCTLocationRequest *> *_pendingRequests;
|
|
BOOL _observingLocation;
|
|
BOOL _usingSignificantChanges;
|
|
RCTLocationConfiguration _locationConfiguration;
|
|
RCTLocationOptions _observerOptions;
|
|
}
|
|
|
|
RCT_EXPORT_MODULE()
|
|
|
|
#pragma mark - Lifecycle
|
|
|
|
- (void)dealloc
|
|
{
|
|
_usingSignificantChanges ?
|
|
[_locationManager stopMonitoringSignificantLocationChanges] :
|
|
[_locationManager stopUpdatingLocation];
|
|
|
|
_locationManager.delegate = nil;
|
|
}
|
|
|
|
- (dispatch_queue_t)methodQueue
|
|
{
|
|
return dispatch_get_main_queue();
|
|
}
|
|
|
|
- (NSArray<NSString *> *)supportedEvents
|
|
{
|
|
return @[@"geolocationDidChange", @"geolocationError"];
|
|
}
|
|
|
|
#pragma mark - Private API
|
|
|
|
- (void)beginLocationUpdatesWithDesiredAccuracy:(CLLocationAccuracy)desiredAccuracy distanceFilter:(CLLocationDistance)distanceFilter useSignificantChanges:(BOOL)useSignificantChanges
|
|
{
|
|
if (!_locationConfiguration.skipPermissionRequests) {
|
|
[self requestAuthorization];
|
|
}
|
|
|
|
_locationManager.distanceFilter = distanceFilter;
|
|
_locationManager.desiredAccuracy = desiredAccuracy;
|
|
_usingSignificantChanges = useSignificantChanges;
|
|
|
|
// Start observing location
|
|
_usingSignificantChanges ?
|
|
[_locationManager startMonitoringSignificantLocationChanges] :
|
|
[_locationManager startUpdatingLocation];
|
|
}
|
|
|
|
#pragma mark - Timeout handler
|
|
|
|
- (void)timeout:(NSTimer *)timer
|
|
{
|
|
RCTLocationRequest *request = timer.userInfo;
|
|
NSString *message = [NSString stringWithFormat: @"Unable to fetch location within %.1fs.", request.options.timeout];
|
|
request.errorBlock(@[RCTPositionError(RCTPositionErrorTimeout, message)]);
|
|
[_pendingRequests removeObject:request];
|
|
|
|
// Stop updating if no pending requests
|
|
if (_pendingRequests.count == 0 && !_observingLocation) {
|
|
_usingSignificantChanges ?
|
|
[_locationManager stopMonitoringSignificantLocationChanges] :
|
|
[_locationManager stopUpdatingLocation];
|
|
}
|
|
}
|
|
|
|
#pragma mark - Public API
|
|
|
|
RCT_EXPORT_METHOD(setConfiguration:(RCTLocationConfiguration)config)
|
|
{
|
|
_locationConfiguration = config;
|
|
}
|
|
|
|
RCT_EXPORT_METHOD(requestAuthorization)
|
|
{
|
|
if (!_locationManager) {
|
|
_locationManager = [CLLocationManager new];
|
|
_locationManager.delegate = self;
|
|
}
|
|
|
|
// Request location access permission
|
|
if ([[NSBundle mainBundle] objectForInfoDictionaryKey:@"NSLocationAlwaysUsageDescription"] &&
|
|
[_locationManager respondsToSelector:@selector(requestAlwaysAuthorization)]) {
|
|
[_locationManager requestAlwaysAuthorization];
|
|
|
|
// On iOS 9+ we also need to enable background updates
|
|
NSArray *backgroundModes = [[NSBundle mainBundle] objectForInfoDictionaryKey:@"UIBackgroundModes"];
|
|
if (backgroundModes && [backgroundModes containsObject:@"location"]) {
|
|
if ([_locationManager respondsToSelector:@selector(setAllowsBackgroundLocationUpdates:)]) {
|
|
[_locationManager setAllowsBackgroundLocationUpdates:YES];
|
|
}
|
|
}
|
|
} else if ([[NSBundle mainBundle] objectForInfoDictionaryKey:@"NSLocationWhenInUseUsageDescription"] &&
|
|
[_locationManager respondsToSelector:@selector(requestWhenInUseAuthorization)]) {
|
|
[_locationManager requestWhenInUseAuthorization];
|
|
}
|
|
}
|
|
|
|
RCT_EXPORT_METHOD(startObserving:(RCTLocationOptions)options)
|
|
{
|
|
checkLocationConfig();
|
|
|
|
// Select best options
|
|
_observerOptions = options;
|
|
for (RCTLocationRequest *request in _pendingRequests) {
|
|
_observerOptions.accuracy = MIN(_observerOptions.accuracy, request.options.accuracy);
|
|
}
|
|
|
|
[self beginLocationUpdatesWithDesiredAccuracy:_observerOptions.accuracy
|
|
distanceFilter:_observerOptions.distanceFilter
|
|
useSignificantChanges:_observerOptions.useSignificantChanges];
|
|
_observingLocation = YES;
|
|
}
|
|
|
|
RCT_EXPORT_METHOD(stopObserving)
|
|
{
|
|
// Stop observing
|
|
_observingLocation = NO;
|
|
|
|
// Stop updating if no pending requests
|
|
if (_pendingRequests.count == 0) {
|
|
_usingSignificantChanges ?
|
|
[_locationManager stopMonitoringSignificantLocationChanges] :
|
|
[_locationManager stopUpdatingLocation];
|
|
}
|
|
}
|
|
|
|
RCT_EXPORT_METHOD(getCurrentPosition:(RCTLocationOptions)options
|
|
withSuccessCallback:(RCTResponseSenderBlock)successBlock
|
|
errorCallback:(RCTResponseSenderBlock)errorBlock)
|
|
{
|
|
checkLocationConfig();
|
|
|
|
if (!successBlock) {
|
|
RCTLogError(@"%@.getCurrentPosition called with nil success parameter.", [self class]);
|
|
return;
|
|
}
|
|
|
|
if (![CLLocationManager locationServicesEnabled]) {
|
|
if (errorBlock) {
|
|
errorBlock(@[
|
|
RCTPositionError(RCTPositionErrorUnavailable, @"Location services disabled.")
|
|
]);
|
|
return;
|
|
}
|
|
}
|
|
|
|
if ([CLLocationManager authorizationStatus] == kCLAuthorizationStatusDenied) {
|
|
if (errorBlock) {
|
|
errorBlock(@[
|
|
RCTPositionError(RCTPositionErrorDenied, nil)
|
|
]);
|
|
return;
|
|
}
|
|
}
|
|
|
|
// Check if previous recorded location exists and is good enough
|
|
if (_lastLocationEvent &&
|
|
[NSDate date].timeIntervalSince1970 - [RCTConvert NSTimeInterval:_lastLocationEvent[@"timestamp"]] < options.maximumAge &&
|
|
[_lastLocationEvent[@"coords"][@"accuracy"] doubleValue] <= options.accuracy) {
|
|
|
|
// Call success block with most recent known location
|
|
successBlock(@[_lastLocationEvent]);
|
|
return;
|
|
}
|
|
|
|
// Create request
|
|
RCTLocationRequest *request = [RCTLocationRequest new];
|
|
request.successBlock = successBlock;
|
|
request.errorBlock = errorBlock ?: ^(NSArray *args){};
|
|
request.options = options;
|
|
request.timeoutTimer = [NSTimer scheduledTimerWithTimeInterval:options.timeout
|
|
target:self
|
|
selector:@selector(timeout:)
|
|
userInfo:request
|
|
repeats:NO];
|
|
if (!_pendingRequests) {
|
|
_pendingRequests = [NSMutableArray new];
|
|
}
|
|
[_pendingRequests addObject:request];
|
|
|
|
// Configure location manager and begin updating location
|
|
CLLocationAccuracy accuracy = options.accuracy;
|
|
if (_locationManager) {
|
|
accuracy = MIN(_locationManager.desiredAccuracy, accuracy);
|
|
}
|
|
[self beginLocationUpdatesWithDesiredAccuracy:accuracy
|
|
distanceFilter:options.distanceFilter
|
|
useSignificantChanges:options.useSignificantChanges];
|
|
}
|
|
|
|
#pragma mark - CLLocationManagerDelegate
|
|
|
|
- (void)locationManager:(CLLocationManager *)manager
|
|
didUpdateLocations:(NSArray<CLLocation *> *)locations
|
|
{
|
|
// Create event
|
|
CLLocation *location = locations.lastObject;
|
|
_lastLocationEvent = @{
|
|
@"coords": @{
|
|
@"latitude": @(location.coordinate.latitude),
|
|
@"longitude": @(location.coordinate.longitude),
|
|
@"altitude": @(location.altitude),
|
|
@"accuracy": @(location.horizontalAccuracy),
|
|
@"altitudeAccuracy": @(location.verticalAccuracy),
|
|
@"heading": @(location.course),
|
|
@"speed": @(location.speed),
|
|
},
|
|
@"timestamp": @([location.timestamp timeIntervalSince1970] * 1000) // in ms
|
|
};
|
|
|
|
// Send event
|
|
if (_observingLocation) {
|
|
[self sendEventWithName:@"geolocationDidChange" body:_lastLocationEvent];
|
|
}
|
|
|
|
// Fire all queued callbacks
|
|
for (RCTLocationRequest *request in _pendingRequests) {
|
|
request.successBlock(@[_lastLocationEvent]);
|
|
[request.timeoutTimer invalidate];
|
|
}
|
|
[_pendingRequests removeAllObjects];
|
|
|
|
// Stop updating if not observing
|
|
if (!_observingLocation) {
|
|
_usingSignificantChanges ?
|
|
[_locationManager stopMonitoringSignificantLocationChanges] :
|
|
[_locationManager stopUpdatingLocation];
|
|
}
|
|
|
|
// Reset location accuracy if desiredAccuracy is changed.
|
|
// Otherwise update accuracy will force triggering didUpdateLocations, watchPosition would keeping receiving location updates, even there's no location changes.
|
|
if (ABS(_locationManager.desiredAccuracy - RCT_DEFAULT_LOCATION_ACCURACY) > 0.000001) {
|
|
_locationManager.desiredAccuracy = RCT_DEFAULT_LOCATION_ACCURACY;
|
|
}
|
|
}
|
|
|
|
- (void)locationManager:(CLLocationManager *)manager didFailWithError:(NSError *)error
|
|
{
|
|
// Check error type
|
|
NSDictionary<NSString *, id> *jsError = nil;
|
|
switch (error.code) {
|
|
case kCLErrorDenied:
|
|
jsError = RCTPositionError(RCTPositionErrorDenied, nil);
|
|
break;
|
|
case kCLErrorNetwork:
|
|
jsError = RCTPositionError(RCTPositionErrorUnavailable, @"Unable to retrieve location due to a network failure");
|
|
break;
|
|
case kCLErrorLocationUnknown:
|
|
default:
|
|
jsError = RCTPositionError(RCTPositionErrorUnavailable, nil);
|
|
break;
|
|
}
|
|
|
|
// Send event
|
|
if (_observingLocation) {
|
|
[self sendEventWithName:@"geolocationError" body:jsError];
|
|
}
|
|
|
|
// Fire all queued error callbacks
|
|
for (RCTLocationRequest *request in _pendingRequests) {
|
|
request.errorBlock(@[jsError]);
|
|
[request.timeoutTimer invalidate];
|
|
}
|
|
[_pendingRequests removeAllObjects];
|
|
|
|
// Reset location accuracy if desiredAccuracy is changed.
|
|
// Otherwise update accuracy will force triggering didUpdateLocations, watchPosition would keeping receiving location updates, even there's no location changes.
|
|
if (ABS(_locationManager.desiredAccuracy - RCT_DEFAULT_LOCATION_ACCURACY) > 0.000001) {
|
|
_locationManager.desiredAccuracy = RCT_DEFAULT_LOCATION_ACCURACY;
|
|
}
|
|
}
|
|
|
|
static void checkLocationConfig()
|
|
{
|
|
#if RCT_DEV
|
|
if (!([[NSBundle mainBundle] objectForInfoDictionaryKey:@"NSLocationWhenInUseUsageDescription"] ||
|
|
[[NSBundle mainBundle] objectForInfoDictionaryKey:@"NSLocationAlwaysUsageDescription"] ||
|
|
[[NSBundle mainBundle] objectForInfoDictionaryKey:@"NSLocationAlwaysAndWhenInUseUsageDescription"])) {
|
|
RCTLogError(@"Either NSLocationWhenInUseUsageDescription or NSLocationAlwaysUsageDescription or NSLocationAlwaysAndWhenInUseUsageDescription key must be present in Info.plist to use geolocation.");
|
|
}
|
|
#endif
|
|
}
|
|
|
|
@end
|