RLMSyncConfiguration.mm 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292
  1. ////////////////////////////////////////////////////////////////////////////
  2. //
  3. // Copyright 2016 Realm Inc.
  4. //
  5. // Licensed under the Apache License, Version 2.0 (the "License");
  6. // you may not use this file except in compliance with the License.
  7. // You may obtain a copy of the License at
  8. //
  9. // http://www.apache.org/licenses/LICENSE-2.0
  10. //
  11. // Unless required by applicable law or agreed to in writing, software
  12. // distributed under the License is distributed on an "AS IS" BASIS,
  13. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14. // See the License for the specific language governing permissions and
  15. // limitations under the License.
  16. //
  17. ////////////////////////////////////////////////////////////////////////////
  18. #import "RLMSyncConfiguration_Private.hpp"
  19. #import "RLMRealmConfiguration+Sync.h"
  20. #import "RLMSyncManager_Private.h"
  21. #import "RLMSyncSession_Private.hpp"
  22. #import "RLMSyncSessionRefreshHandle.hpp"
  23. #import "RLMSyncUser_Private.hpp"
  24. #import "RLMSyncUtil_Private.hpp"
  25. #import "RLMUtil.hpp"
  26. #import "sync/sync_manager.hpp"
  27. #import "sync/sync_config.hpp"
  28. #import <realm/sync/protocol.hpp>
  29. using namespace realm;
  30. namespace {
  31. using ProtocolError = realm::sync::ProtocolError;
  32. RLMSyncSystemErrorKind errorKindForSyncError(SyncError error) {
  33. if (error.is_client_reset_requested()) {
  34. return RLMSyncSystemErrorKindClientReset;
  35. } else if (error.error_code == ProtocolError::permission_denied) {
  36. return RLMSyncSystemErrorKindPermissionDenied;
  37. } else if (error.error_code == ProtocolError::bad_authentication) {
  38. return RLMSyncSystemErrorKindUser;
  39. } else if (error.is_session_level_protocol_error()) {
  40. return RLMSyncSystemErrorKindSession;
  41. } else if (error.is_connection_level_protocol_error()) {
  42. return RLMSyncSystemErrorKindConnection;
  43. } else if (error.is_client_error()) {
  44. return RLMSyncSystemErrorKindClient;
  45. } else {
  46. return RLMSyncSystemErrorKindUnknown;
  47. }
  48. }
  49. BOOL isValidRealmURL(NSURL *url) {
  50. NSString *scheme = [url scheme];
  51. return [scheme isEqualToString:@"realm"] || [scheme isEqualToString:@"realms"];
  52. }
  53. }
  54. @interface RLMSyncConfiguration () {
  55. std::unique_ptr<realm::SyncConfig> _config;
  56. }
  57. - (instancetype)initWithUser:(RLMSyncUser *)user
  58. realmURL:(NSURL *)url
  59. customFileURL:(nullable NSURL *)customFileURL
  60. isPartial:(BOOL)isPartial
  61. stopPolicy:(RLMSyncStopPolicy)stopPolicy
  62. errorHandler:(std::function<realm::SyncSessionErrorHandler>)errorHandler;
  63. @end
  64. @implementation RLMSyncConfiguration
  65. @dynamic stopPolicy;
  66. - (instancetype)initWithRawConfig:(realm::SyncConfig)config {
  67. if (self = [super init]) {
  68. _config = std::make_unique<realm::SyncConfig>(std::move(config));
  69. }
  70. return self;
  71. }
  72. - (BOOL)isEqual:(id)object {
  73. if (![object isKindOfClass:[RLMSyncConfiguration class]]) {
  74. return NO;
  75. }
  76. RLMSyncConfiguration *that = (RLMSyncConfiguration *)object;
  77. return [self.realmURL isEqual:that.realmURL]
  78. && [self.user isEqual:that.user]
  79. && self.stopPolicy == that.stopPolicy
  80. && self.fullSynchronization == that.fullSynchronization;
  81. }
  82. - (void)setEnableSSLValidation:(BOOL)enableSSLValidation {
  83. _config->client_validate_ssl = (bool)enableSSLValidation;
  84. }
  85. - (BOOL)enableSSLValidation {
  86. return (BOOL)_config->client_validate_ssl;
  87. }
  88. - (void)setIsPartial:(BOOL)isPartial {
  89. _config->is_partial = (bool)isPartial;
  90. }
  91. - (NSURL *)pinnedCertificateURL {
  92. if (auto& path = _config->ssl_trust_certificate_path) {
  93. return [NSURL fileURLWithPath:RLMStringDataToNSString(*path)];
  94. }
  95. return nil;
  96. }
  97. - (void)setPinnedCertificateURL:(NSURL *)pinnedCertificateURL {
  98. if (pinnedCertificateURL) {
  99. if ([pinnedCertificateURL respondsToSelector:@selector(UTF8String)]) {
  100. _config->ssl_trust_certificate_path = std::string([(id)pinnedCertificateURL UTF8String]);
  101. }
  102. else {
  103. _config->ssl_trust_certificate_path = std::string(pinnedCertificateURL.path.UTF8String);
  104. }
  105. }
  106. else {
  107. _config->ssl_trust_certificate_path = util::none;
  108. }
  109. }
  110. - (BOOL)isPartial {
  111. return (BOOL)_config->is_partial;
  112. }
  113. - (void)setFullSynchronization:(BOOL)fullSynchronization {
  114. _config->is_partial = !(bool)fullSynchronization;
  115. }
  116. - (BOOL)fullSynchronization {
  117. return !(BOOL)_config->is_partial;
  118. }
  119. - (realm::SyncConfig)rawConfiguration {
  120. return *_config;
  121. }
  122. - (RLMSyncUser *)user {
  123. return [[RLMSyncUser alloc] initWithSyncUser:_config->user];
  124. }
  125. - (RLMSyncStopPolicy)stopPolicy {
  126. return translateStopPolicy(_config->stop_policy);
  127. }
  128. - (void)setStopPolicy:(RLMSyncStopPolicy)stopPolicy {
  129. _config->stop_policy = translateStopPolicy(stopPolicy);
  130. }
  131. - (NSString *)urlPrefix {
  132. if (_config->url_prefix) {
  133. return @(_config->url_prefix->c_str());
  134. }
  135. return nil;
  136. }
  137. - (void)setUrlPrefix:(NSString *)urlPrefix {
  138. if (urlPrefix) {
  139. _config->url_prefix.emplace(urlPrefix.UTF8String);
  140. } else {
  141. _config->url_prefix = none;
  142. }
  143. }
  144. - (NSURL *)realmURL {
  145. NSString *rawStringURL = @(_config->reference_realm_url.c_str());
  146. return [NSURL URLWithString:rawStringURL];
  147. }
  148. - (instancetype)initWithUser:(RLMSyncUser *)user realmURL:(NSURL *)url {
  149. return [self initWithUser:user
  150. realmURL:url
  151. customFileURL:nil
  152. isPartial:NO
  153. stopPolicy:RLMSyncStopPolicyAfterChangesUploaded
  154. errorHandler:nullptr];
  155. }
  156. - (instancetype)initWithUser:(RLMSyncUser *)user
  157. realmURL:(NSURL *)url
  158. isPartial:(BOOL)isPartial
  159. urlPrefix:(NSString *)urlPrefix
  160. stopPolicy:(RLMSyncStopPolicy)stopPolicy
  161. enableSSLValidation:(BOOL)enableSSLValidation
  162. certificatePath:(nullable NSURL *)certificatePath {
  163. auto config = [self initWithUser:user
  164. realmURL:url
  165. customFileURL:nil
  166. isPartial:isPartial
  167. stopPolicy:stopPolicy
  168. errorHandler:nullptr];
  169. config.urlPrefix = urlPrefix;
  170. config.enableSSLValidation = enableSSLValidation;
  171. config.pinnedCertificateURL = certificatePath;
  172. return config;
  173. }
  174. - (instancetype)initWithUser:(RLMSyncUser *)user
  175. realmURL:(NSURL *)url
  176. customFileURL:(nullable NSURL *)customFileURL
  177. isPartial:(BOOL)isPartial
  178. stopPolicy:(RLMSyncStopPolicy)stopPolicy
  179. errorHandler:(std::function<realm::SyncSessionErrorHandler>)errorHandler {
  180. if (self = [super init]) {
  181. if (!isValidRealmURL(url)) {
  182. @throw RLMException(@"The provided URL (%@) was not a valid Realm URL.", [url absoluteString]);
  183. }
  184. auto bindHandler = [=](auto&,
  185. const SyncConfig& config,
  186. const std::shared_ptr<SyncSession>& session) {
  187. const std::shared_ptr<SyncUser>& user = config.user;
  188. NSURL *realmURL = [NSURL URLWithString:@(config.realm_url().c_str())];
  189. NSString *path = [realmURL path];
  190. REALM_ASSERT(realmURL && path);
  191. RLMSyncSessionRefreshHandle *handle = [[RLMSyncSessionRefreshHandle alloc] initWithRealmURL:realmURL
  192. user:user
  193. session:std::move(session)
  194. completionBlock:[RLMSyncManager sharedManager].sessionCompletionNotifier];
  195. context_for(user).register_refresh_handle([path UTF8String], handle);
  196. };
  197. if (!errorHandler) {
  198. errorHandler = [=](std::shared_ptr<SyncSession> errored_session,
  199. SyncError error) {
  200. RLMSyncSession *session = [[RLMSyncSession alloc] initWithSyncSession:errored_session];
  201. NSMutableDictionary *userInfo = [NSMutableDictionary dictionaryWithCapacity:error.user_info.size()];
  202. for (auto& pair : error.user_info) {
  203. userInfo[@(pair.first.c_str())] = @(pair.second.c_str());
  204. }
  205. // FIXME: how should the binding respond if the `is_fatal` bool is true?
  206. [[RLMSyncManager sharedManager] _fireErrorWithCode:error.error_code.value()
  207. message:@(error.message.c_str())
  208. isFatal:error.is_fatal
  209. session:session
  210. userInfo:userInfo
  211. errorClass:errorKindForSyncError(error)];
  212. };
  213. }
  214. _config = std::make_unique<SyncConfig>(SyncConfig{
  215. [user _syncUser],
  216. [[url absoluteString] UTF8String]
  217. });
  218. _config->stop_policy = translateStopPolicy(stopPolicy);
  219. _config->bind_session_handler = std::move(bindHandler);
  220. _config->error_handler = std::move(errorHandler);
  221. _config->is_partial = isPartial;
  222. _config->client_resync_mode = realm::ClientResyncMode::Manual;
  223. if (NSString *authorizationHeaderName = [RLMSyncManager sharedManager].authorizationHeaderName) {
  224. _config->authorization_header_name.emplace(authorizationHeaderName.UTF8String);
  225. }
  226. if (NSDictionary<NSString *, NSString *> *customRequestHeaders = [RLMSyncManager sharedManager].customRequestHeaders) {
  227. for (NSString *key in customRequestHeaders) {
  228. _config->custom_http_headers.emplace(key.UTF8String, customRequestHeaders[key].UTF8String);
  229. }
  230. }
  231. self.customFileURL = customFileURL;
  232. return self;
  233. }
  234. return nil;
  235. }
  236. + (RLMRealmConfiguration *)automaticConfiguration {
  237. if (RLMSyncUser.allUsers.count != 1)
  238. @throw RLMException(@"The automatic configuration requires there be exactly one logged-in sync user.");
  239. return [RLMSyncConfiguration automaticConfigurationForUser:RLMSyncUser.currentUser];
  240. }
  241. + (RLMRealmConfiguration *)automaticConfigurationForUser:(RLMSyncUser *)user {
  242. RLMSyncConfiguration *syncConfig = [[RLMSyncConfiguration alloc] initWithUser:user
  243. realmURL:user.defaultRealmURL
  244. customFileURL:nil
  245. isPartial:YES
  246. stopPolicy:RLMSyncStopPolicyAfterChangesUploaded
  247. errorHandler:nullptr];
  248. RLMRealmConfiguration *config = [[RLMRealmConfiguration alloc] init];
  249. config.syncConfiguration = syncConfig;
  250. return config;
  251. }
  252. @end