Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
//
// HCPPlugin.m
//
// Created by Nikolay Demyankov on 07.08.15.
//
#import <Cordova/CDVConfigParser.h>
#import "HCPPlugin.h"
#import "HCPFileDownloader.h"
#import "HCPFilesStructure.h"
#import "HCPUpdateLoader.h"
#import "HCPEvents.h"
#import "HCPPluginInternalPreferences+UserDefaults.h"
#import "HCPUpdateInstaller.h"
#import "NSJSONSerialization+HCPExtension.h"
#import "CDVPluginResult+HCPEvents.h"
#import "HCPXmlConfig.h"
#import "NSBundle+HCPExtension.h"
#import "HCPApplicationConfigStorage.h"
#import "HCPAppUpdateRequestAlertDialog.h"
#import "HCPAssetsFolderHelper.h"
#import "NSError+HCPExtension.h"
#import "HCPCleanupHelper.h"
#import "HCPUpdateRequest.h"
@interface HCPPlugin() {
HCPFilesStructure *_filesStructure;
NSString *_defaultCallbackID;
BOOL _isPluginReadyForWork;
HCPPluginInternalPreferences *_pluginInternalPrefs;
NSString *_installationCallback;
NSString *_downloadCallback;
HCPXmlConfig *_pluginXmlConfig;
HCPApplicationConfig *_appConfig;
HCPAppUpdateRequestAlertDialog *_appUpdateRequestDialog;
NSString *_indexPage;
NSMutableArray<CDVPluginResult *> *_defaultCallbackStoredResults;
}
@end
#pragma mark Local constants declaration
static NSString *const DEFAULT_STARTING_PAGE = @"index.html";
@implementation HCPPlugin
#pragma mark Lifecycle
-(void)pluginInitialize {
[self doLocalInit];
[self subscribeToEvents];
// install www folder if it is needed
if ([self isWWwFolderNeedsToBeInstalled]) {
[self installWwwFolder];
return;
}
// cleanup file system: remove older releases, except current and the previous one
[self cleanupFileSystemFromOldReleases];
_isPluginReadyForWork = YES;
[self resetIndexPageToExternalStorage];
[self loadApplicationConfig];
// install update if any exists
if (_pluginXmlConfig.isUpdatesAutoInstallationAllowed &&
_pluginInternalPrefs.readyForInstallationReleaseVersionName.length > 0) {
[self _installUpdate:nil];
}
}
- (void)onAppTerminate {
[self unsubscribeFromEvents];
}
- (void)onResume:(NSNotification *)notification {
if (!_pluginXmlConfig.isUpdatesAutoInstallationAllowed ||
_pluginInternalPrefs.readyForInstallationReleaseVersionName.length == 0) {
return;
}
// load app config from update folder and check, if we are allowed to install it
HCPFilesStructure *fs = [[HCPFilesStructure alloc] initWithReleaseVersion:_pluginInternalPrefs.readyForInstallationReleaseVersionName];
id<HCPConfigFileStorage> configStorage = [[HCPApplicationConfigStorage alloc] initWithFileStructure:fs];
HCPApplicationConfig *configFromNewRelease = [configStorage loadFromFolder:fs.downloadFolder];
if (configFromNewRelease.contentConfig.updateTime == HCPUpdateOnResume ||
configFromNewRelease.contentConfig.updateTime == HCPUpdateNow) {
[self _installUpdate:nil];
}
}
#pragma mark Private API
- (void)installWwwFolder {
_isPluginReadyForWork = NO;
// reset www folder installed flag
if (_pluginInternalPrefs.isWwwFolderInstalled) {
_pluginInternalPrefs.wwwFolderInstalled = NO;
_pluginInternalPrefs.readyForInstallationReleaseVersionName = @"";
_pluginInternalPrefs.previousReleaseVersionName = @"";
HCPApplicationConfig *config = [HCPApplicationConfig configFromBundle:[HCPFilesStructure defaultConfigFileName]];
_pluginInternalPrefs.currentReleaseVersionName = config.contentConfig.releaseVersion;
[_pluginInternalPrefs saveToUserDefaults];
}
[HCPAssetsFolderHelper installWwwFolderToExternalStorageFolder:_filesStructure.wwwFolder];
}
/**
* Load application config from file system
*/
- (void)loadApplicationConfig {
id<HCPConfigFileStorage> configStorage = [[HCPApplicationConfigStorage alloc] initWithFileStructure:_filesStructure];
_appConfig = [configStorage loadFromFolder:_filesStructure.wwwFolder];
}
/**
* Check if www folder already exists on the external storage.
*
* @return <code>YES</code> - www folder doesn't exist, we need to install it; <code>NO</code> - folder already installed
*/
- (BOOL)isWWwFolderNeedsToBeInstalled {
NSFileManager *fileManager = [NSFileManager defaultManager];
BOOL isApplicationUpdated = ![[NSBundle applicationBuildVersion] isEqualToString:_pluginInternalPrefs.appBuildVersion];
BOOL isWWwFolderExists = [fileManager fileExistsAtPath:_filesStructure.wwwFolder.path];
BOOL isWWwFolderInstalled = _pluginInternalPrefs.isWwwFolderInstalled;
return isApplicationUpdated || !isWWwFolderExists || !isWWwFolderInstalled;
}
/**
* Perform initialization of the plugin variables.
*/
- (void)doLocalInit {
_defaultCallbackStoredResults = [[NSMutableArray alloc] init];
// init plugin config from xml
_pluginXmlConfig = [HCPXmlConfig loadFromCordovaConfigXml];
// load plugin internal preferences
_pluginInternalPrefs = [HCPPluginInternalPreferences loadFromUserDefaults];
if (_pluginInternalPrefs == nil || _pluginInternalPrefs.currentReleaseVersionName.length == 0) {
_pluginInternalPrefs = [HCPPluginInternalPreferences defaultConfig];
[_pluginInternalPrefs saveToUserDefaults];
}
NSLog(@"Currently running release version %@", _pluginInternalPrefs.currentReleaseVersionName);
// init file structure for www files
_filesStructure = [[HCPFilesStructure alloc] initWithReleaseVersion:_pluginInternalPrefs.currentReleaseVersionName];
}
/**
* Load update from the server.
*
* @param callbackId id of the caller on JavaScript side; it will be used to send back the result of the download process
*
* @return <code>YES</code> if download process started; <code>NO</code> otherwise
*/
- (BOOL)_fetchUpdate:(NSString *)callbackId withOptions:(HCPFetchUpdateOptions *)options {
if (!_isPluginReadyForWork) {
return NO;
}
if (!options && self.defaultFetchUpdateOptions) {
options = self.defaultFetchUpdateOptions;
}
HCPUpdateRequest *request = [[HCPUpdateRequest alloc] init];
request.configURL = options.configFileURL ? options.configFileURL : _pluginXmlConfig.configUrl;
request.requestHeaders = options.requestHeaders;
request.currentWebVersion = _pluginInternalPrefs.currentReleaseVersionName;
request.currentNativeVersion = _pluginXmlConfig.nativeInterfaceVersion;
NSError *error = nil;
[[HCPUpdateLoader sharedInstance] executeDownloadRequest:request error:&error];
if (error) {
if (callbackId) {
CDVPluginResult *errorResult = [CDVPluginResult pluginResultWithActionName:kHCPUpdateDownloadErrorEvent
applicationConfig:nil
error:error];
[self.commandDelegate sendPluginResult:errorResult callbackId:callbackId];
}
return NO;
}
if (callbackId) {
_downloadCallback = callbackId;
}
return YES;
}
/**
* Install update.
*
* @param callbackID callbackId id of the caller on JavaScript side; it will be used to send back the result of the installation process
*
* @return <code>YES</code> if installation has started; <code>NO</code> otherwise
*/
- (BOOL)_installUpdate:(NSString *)callbackID {
if (!_isPluginReadyForWork) {
return NO;
}
NSString *newVersion = _pluginInternalPrefs.readyForInstallationReleaseVersionName;
NSString *currentVersion = _pluginInternalPrefs.currentReleaseVersionName;
NSError *error = nil;
[[HCPUpdateInstaller sharedInstance] installVersion:newVersion currentVersion:currentVersion error:&error];
if (error) {
if (error.code == kHCPNothingToInstallErrorCode) {
NSNotification *notification = [HCPEvents notificationWithName:kHCPNothingToInstallEvent
applicationConfig:nil
taskId:nil
error:error];
[self onNothingToInstallEvent:notification];
} else {
if (callbackID) {
CDVPluginResult *errorResult = [CDVPluginResult pluginResultWithActionName:kHCPUpdateInstallationErrorEvent
applicationConfig:nil
error:error];
[self.commandDelegate sendPluginResult:errorResult callbackId:callbackID];
}
}
return NO;
}
if (callbackID) {
_installationCallback = callbackID;
}
return YES;
}
/**
* Load given url into the WebView
*
* @param url url to load
*/
- (void)loadURL:(NSString *)url {
[[NSOperationQueue mainQueue] addOperationWithBlock:^{
NSURL *loadURL = [NSURL URLWithString:[NSString stringWithFormat:@"%@/%@", _filesStructure.wwwFolder.absoluteString, url]];
NSURLRequest *request = [NSURLRequest requestWithURL:loadURL
cachePolicy:NSURLRequestReloadIgnoringCacheData
timeoutInterval:10000];
#ifdef __CORDOVA_4_0_0
[self.webViewEngine loadRequest:request];
#else
[self.webView loadRequest:request];
#endif
}];
}
/**
* Redirect user to the index page that is located on the external storage.
*/
- (void)resetIndexPageToExternalStorage {
NSString *indexPageStripped = [self indexPageFromConfigXml];
NSRange r = [indexPageStripped rangeOfCharacterFromSet:[NSCharacterSet characterSetWithCharactersInString:@"?#"] options:0];
if (r.location != NSNotFound) {
indexPageStripped = [indexPageStripped substringWithRange:NSMakeRange(0, r.location)];
}
NSURL *indexPageExternalURL = [self appendWwwFolderPathToPath:indexPageStripped];
if (![[NSFileManager defaultManager] fileExistsAtPath:indexPageExternalURL.path]) {
return;
}
// rewrite starting page www folder path: should load from external storage
if ([self.viewController isKindOfClass:[CDVViewController class]]) {
((CDVViewController *)self.viewController).wwwFolderName = _filesStructure.wwwFolder.absoluteString;
} else {
NSLog(@"HotCodePushError: Can't make starting page to be from external storage. Main controller should be of type CDVViewController.");
}
}
/**
* If needed - add path to www folder on the external storage to the provided path.
*
* @param pagePath path to which we want add www folder
*
* @return resulting path
*/
- (NSURL *)appendWwwFolderPathToPath:(NSString *)pagePath {
if ([pagePath hasPrefix:_filesStructure.wwwFolder.absoluteString]) {
return [NSURL URLWithString:pagePath];
}
return [_filesStructure.wwwFolder URLByAppendingPathComponent:pagePath];
}
/**
* Get index page from config.xml
*
* @return index page of the application
*/
- (NSString *)indexPageFromConfigXml {
if (_indexPage) {
return _indexPage;
}
CDVConfigParser* delegate = [[CDVConfigParser alloc] init];
// read from config.xml in the app bundle
NSURL* url = [NSURL fileURLWithPath:[NSBundle pathToCordovaConfigXml]];
NSXMLParser *configParser = [[NSXMLParser alloc] initWithContentsOfURL:url];
[configParser setDelegate:((id <NSXMLParserDelegate>)delegate)];
[configParser parse];
if (delegate.startPage) {
_indexPage = delegate.startPage;
} else {
_indexPage = DEFAULT_STARTING_PAGE;
}
return _indexPage;
}
/**
* Notify JavaScript module about occured event.
* For that we will use callback, received on plugin initialization stage.
*
* @param result message to send to web side
* @return YES - result was sent to the web page; NO - otherwise
*/
- (BOOL)invokeDefaultCallbackWithMessage:(CDVPluginResult *)result {
if (!_defaultCallbackID) {
[_defaultCallbackStoredResults addObject:result];
return NO;
}
[result setKeepCallbackAsBool:YES];
[self.commandDelegate sendPluginResult:result callbackId:_defaultCallbackID];
return YES;
}
- (void)dispatchDefaultCallbackStoredResults {
if (!_defaultCallbackID || _defaultCallbackStoredResults.count == 0) {
return;
}
for (CDVPluginResult *callResult in _defaultCallbackStoredResults) {
[callResult setKeepCallbackAsBool:YES];
[self.commandDelegate sendPluginResult:callResult callbackId:_defaultCallbackID];
}
[_defaultCallbackStoredResults removeAllObjects];
}
#pragma mark Events
/**
* Subscribe to different events: lifecycle, plugin specific.
*/
- (void)subscribeToEvents {
[self subscribeToLifecycleEvents];
[self subscribeToPluginInternalEvents];
}
/**
* Subscribe to lifecycle events.
*/
- (void)subscribeToLifecycleEvents {
[[NSNotificationCenter defaultCenter] addObserver:self
selector:@selector(onResume:)
name:UIApplicationWillEnterForegroundNotification
object:nil];
}
/**
* Subscrive to plugin workflow events.
*/
- (void)subscribeToPluginInternalEvents {
NSNotificationCenter *notificationCenter = [NSNotificationCenter defaultCenter];
// bundle installation events
[notificationCenter addObserver:self
selector:@selector(onBeforeAssetsInstalledOnExternalStorageEvent:)
name:kHCPBeforeBundleAssetsInstalledOnExternalStorageEvent
object:nil];
[notificationCenter addObserver:self
selector:@selector(onAssetsInstalledOnExternalStorageEvent:)
name:kHCPBundleAssetsInstalledOnExternalStorageEvent
object:nil];
[notificationCenter addObserver:self
selector:@selector(onAssetsInstallationErrorEvent:)
name:kHCPBundleAssetsInstallationErrorEvent
object:nil];
// update download events
[notificationCenter addObserver:self
selector:@selector(onUpdateDownloadErrorEvent:)
name:kHCPUpdateDownloadErrorEvent
object:nil];
[notificationCenter addObserver:self
selector:@selector(onNothingToUpdateEvent:)
name:kHCPNothingToUpdateEvent
object:nil];
[notificationCenter addObserver:self
selector:@selector(onUpdateIsReadyForInstallation:)
name:kHCPUpdateIsReadyForInstallationEvent
object:nil];
// update installation events
[notificationCenter addObserver:self
selector:@selector(onUpdateInstallationErrorEvent:)
name:kHCPUpdateInstallationErrorEvent
object:nil];
[notificationCenter addObserver:self
selector:@selector(onBeforeInstallEvent:)
name:kHCPBeforeInstallEvent
object:nil];
[notificationCenter addObserver:self
selector:@selector(onUpdateInstalledEvent:)
name:kHCPUpdateIsInstalledEvent
object:nil];
[notificationCenter addObserver:self
selector:@selector(onNothingToInstallEvent:)
name:kHCPNothingToInstallEvent
object:nil];
}
/**
* Remove subscription.
* Should be called only when the application is terminated.
*/
- (void)unsubscribeFromEvents {
[[NSNotificationCenter defaultCenter] removeObserver:self];
}
#pragma mark Bundle installation events
/**
* Method is called when we about to start installing www folder from bundle onto the external storage.
*
* @param notification captured notification with event details
*/
- (void)onBeforeAssetsInstalledOnExternalStorageEvent:(NSNotification *)notification {
CDVPluginResult *result = [CDVPluginResult pluginResultForNotification:notification];
[self invokeDefaultCallbackWithMessage:result];
}
/**
* Method is called when we successfully installed www folder from bundle onto the external storage.
*
* @param notification captured notification with event details
*/
- (void)onAssetsInstalledOnExternalStorageEvent:(NSNotification *)notification {
// update stored config with new application build version
_pluginInternalPrefs.appBuildVersion = [NSBundle applicationBuildVersion];
_pluginInternalPrefs.wwwFolderInstalled = YES;
[_pluginInternalPrefs saveToUserDefaults];
// allow work
_isPluginReadyForWork = YES;
// send notification to web
[self invokeDefaultCallbackWithMessage:[CDVPluginResult pluginResultForNotification:notification]];
// fetch update
[self loadApplicationConfig];
if (_pluginXmlConfig.isUpdatesAutoDownloadAllowed &&
![HCPUpdateLoader sharedInstance].isDownloadInProgress &&
![HCPUpdateInstaller sharedInstance].isInstallationInProgress) {
[self _fetchUpdate:nil withOptions:nil];
}
}
/**
* Method is called when error occured during the installation for the www folder from bundle on the external storage
*
* @param notification captured notification with event details
*/
- (void)onAssetsInstallationErrorEvent:(NSNotification *)notification {
_isPluginReadyForWork = NO;
// send notification to web
[self invokeDefaultCallbackWithMessage:[CDVPluginResult pluginResultForNotification:notification]];
}
#pragma mark Update download events
/**
* Method is called when error occured during the update download process.
*
* @param notification captured notification with event details
*/
- (void)onUpdateDownloadErrorEvent:(NSNotification *)notification {
NSError *error = notification.userInfo[kHCPEventUserInfoErrorKey];
NSLog(@"Error during update: %@", [error underlyingErrorLocalizedDesription]);
// send notification to the associated callback
CDVPluginResult *pluginResult = [CDVPluginResult pluginResultForNotification:notification];
if (_downloadCallback) {
[self.commandDelegate sendPluginResult:pluginResult callbackId:_downloadCallback];
_downloadCallback = nil;
}
// send notification to the default callback
[self invokeDefaultCallbackWithMessage:pluginResult];
// probably never happens, but just for safety
[self rollbackIfCorrupted:error];
}
/**
* Method is called when there is nothing new to download from the server.
*
* @param notification captured notification with event details.
*/
- (void)onNothingToUpdateEvent:(NSNotification *)notification {
NSLog(@"Nothing to update");
// send notification to the associated callback
CDVPluginResult *pluginResult = [CDVPluginResult pluginResultForNotification:notification];
if (_downloadCallback) {
[self.commandDelegate sendPluginResult:pluginResult callbackId:_downloadCallback];
_downloadCallback = nil;
}
// send notification to the default callback
[self invokeDefaultCallbackWithMessage:pluginResult];
}
/**
* Method is called when update is loaded and ready for installation.
*
* @param notification captured notification with event details
*/
- (void)onUpdateIsReadyForInstallation:(NSNotification *)notification {
// new application config from server
HCPApplicationConfig *newConfig = notification.userInfo[kHCPEventUserInfoApplicationConfigKey];
NSLog(@"Update is ready for installation: %@", newConfig.contentConfig.releaseVersion);
// store, that we are ready for installation
_pluginInternalPrefs.readyForInstallationReleaseVersionName = newConfig.contentConfig.releaseVersion;
[_pluginInternalPrefs saveToUserDefaults];
// send notification to the associated callback
CDVPluginResult *pluginResult = [CDVPluginResult pluginResultForNotification:notification];
if (_downloadCallback) {
[self.commandDelegate sendPluginResult:pluginResult callbackId:_downloadCallback];
_downloadCallback = nil;
}
// send notification to the default callback
[self invokeDefaultCallbackWithMessage:pluginResult];
// if it is allowed - launch the installation
if (_pluginXmlConfig.isUpdatesAutoInstallationAllowed &&
newConfig.contentConfig.updateTime == HCPUpdateNow &&
![HCPUpdateLoader sharedInstance].isDownloadInProgress &&
![HCPUpdateInstaller sharedInstance].isInstallationInProgress) {
[self _installUpdate:nil];
}
}
#pragma mark Update installation events
/**
* Method is called when user requested to install the update, but there is nothing to install.
*
* @param notification captured notification with the event details
*/
- (void)onNothingToInstallEvent:(NSNotification *)notification {
CDVPluginResult *pluginResult = [CDVPluginResult pluginResultForNotification:notification];
// send notification to the caller from the JavaScript side if there was any
if (_installationCallback) {
[self.commandDelegate sendPluginResult:pluginResult callbackId:_installationCallback];
_installationCallback = nil;
}
// send notification to the default callback
[self invokeDefaultCallbackWithMessage:pluginResult];
}
/**
* Method is called when installation is about to begin
*
* @param notification captured notification with the event details
*/
- (void)onBeforeInstallEvent:(NSNotification *)notification {
CDVPluginResult *pluginResult = [CDVPluginResult pluginResultForNotification:notification];
// send notification to the default callback
[self invokeDefaultCallbackWithMessage:pluginResult];
}
/**
* Method is called when error occured during the installation process.
*
* @param notification captured notification with the event details
*/
- (void)onUpdateInstallationErrorEvent:(NSNotification *)notification {
_pluginInternalPrefs.readyForInstallationReleaseVersionName = @"";
[_pluginInternalPrefs saveToUserDefaults];
CDVPluginResult *pluginResult = [CDVPluginResult pluginResultForNotification:notification];
// send notification to the caller from the JavaScript side if there was any
if (_installationCallback) {
[self.commandDelegate sendPluginResult:pluginResult callbackId:_installationCallback];
_installationCallback = nil;
}
// send notification to the default callback
[self invokeDefaultCallbackWithMessage:pluginResult];
// probably never happens, but just for safety
NSError *error = notification.userInfo[kHCPEventUserInfoErrorKey];
[self rollbackIfCorrupted:error];
}
/**
* Method is called when update has been installed.
*
* @param notification captured notification with the event details
*/
- (void)onUpdateInstalledEvent:(NSNotification *)notification {
_appConfig = notification.userInfo[kHCPEventUserInfoApplicationConfigKey];
_pluginInternalPrefs.readyForInstallationReleaseVersionName = @"";
_pluginInternalPrefs.previousReleaseVersionName = _pluginInternalPrefs.currentReleaseVersionName;
_pluginInternalPrefs.currentReleaseVersionName = _appConfig.contentConfig.releaseVersion;
[_pluginInternalPrefs saveToUserDefaults];
_filesStructure = [[HCPFilesStructure alloc] initWithReleaseVersion:_pluginInternalPrefs.currentReleaseVersionName];
CDVPluginResult *pluginResult = [CDVPluginResult pluginResultForNotification:notification];
// send notification to the caller from the JavaScript side of there was any
if (_installationCallback) {
[self.commandDelegate sendPluginResult:pluginResult callbackId:_installationCallback];
_installationCallback = nil;
}
// send notification to the default callback
[self invokeDefaultCallbackWithMessage:pluginResult];
// reload application to the index page
[self loadURL:[self indexPageFromConfigXml]];
[self cleanupFileSystemFromOldReleases];
}
#pragma mark Rollback process
/**
* Rollback to the previously installed version of the app.
*/
- (void)rollbackToPreviousRelease {
_pluginInternalPrefs.readyForInstallationReleaseVersionName = @"";
_pluginInternalPrefs.currentReleaseVersionName = _pluginInternalPrefs.previousReleaseVersionName;
_pluginInternalPrefs.previousReleaseVersionName = @"";
[_pluginInternalPrefs saveToUserDefaults];
_filesStructure = [[HCPFilesStructure alloc] initWithReleaseVersion:_pluginInternalPrefs.currentReleaseVersionName];
if (_appConfig) {
[self loadApplicationConfig];
}
[self loadURL:[self indexPageFromConfigXml]];
}
/**
* Rollback to the previous/bundled version of the app, if error indicates that current release is corrupted.
*
* @param error captured error
*/
- (void)rollbackIfCorrupted:(NSError *)error {
if (error.code != kHCPLocalVersionOfApplicationConfigNotFoundErrorCode && error.code != kHCPLocalVersionOfManifestNotFoundErrorCode) {
return;
}
if (_pluginInternalPrefs.previousReleaseVersionName.length > 0) {
NSLog(@"WWW folder is corrupted, rolling back to previous version.");
[self rollbackToPreviousRelease];
} else {
NSLog(@"WWW folder is corrupted, reinstalling it from bundle.");
[self installWwwFolder];
}
}
#pragma mark Cleanup process
- (void)cleanupFileSystemFromOldReleases {
if (!_pluginInternalPrefs.currentReleaseVersionName.length) {
return;
}
[HCPCleanupHelper removeUnusedReleasesExcept:@[_pluginInternalPrefs.currentReleaseVersionName,
_pluginInternalPrefs.previousReleaseVersionName,
_pluginInternalPrefs.readyForInstallationReleaseVersionName]];
}
#pragma mark Methods, invoked from Javascript
- (void)jsInitPlugin:(CDVInvokedUrlCommand *)command {
_defaultCallbackID = command.callbackId;
[self dispatchDefaultCallbackStoredResults];
if (_pluginXmlConfig.isUpdatesAutoDownloadAllowed &&
![HCPUpdateLoader sharedInstance].isDownloadInProgress &&
![HCPUpdateInstaller sharedInstance].isInstallationInProgress) {
[self _fetchUpdate:nil withOptions:nil];
}
}
- (void)jsConfigure:(CDVInvokedUrlCommand *)command {
if (!_isPluginReadyForWork) {
[self sendPluginNotReadyToWorkMessageForEvent:nil callbackID:command.callbackId];
return;
}
NSDictionary *options = command.arguments[0];
[_pluginXmlConfig mergeOptionsFromJS:options];
// TODO: store them somewhere?
CDVPluginResult *pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK];
[self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId];
}
- (void)jsFetchUpdate:(CDVInvokedUrlCommand *)command {
if (!_isPluginReadyForWork) {
[self sendPluginNotReadyToWorkMessageForEvent:kHCPUpdateDownloadErrorEvent callbackID:command.callbackId];
}
NSDictionary *optionsFromJS = command.arguments.count ? command.arguments[0] : nil;
HCPFetchUpdateOptions *fetchOptions = [[HCPFetchUpdateOptions alloc] initWithDictionary:optionsFromJS];
[self _fetchUpdate:command.callbackId withOptions:fetchOptions];
}
- (void)jsInstallUpdate:(CDVInvokedUrlCommand *)command {
if (!_isPluginReadyForWork) {
[self sendPluginNotReadyToWorkMessageForEvent:kHCPUpdateInstallationErrorEvent callbackID:command.callbackId];
return;
}
[self _installUpdate:command.callbackId];
}
- (void)jsRequestAppUpdate:(CDVInvokedUrlCommand *)command {
if (!_isPluginReadyForWork || command.arguments.count == 0) {
[self sendPluginNotReadyToWorkMessageForEvent:nil callbackID:command.callbackId];
return;
}
NSString* message = command.arguments[0];
if (message.length == 0) {
return;
}
_appUpdateRequestDialog = [[HCPAppUpdateRequestAlertDialog alloc] initWithMessage:message storeUrl:_appConfig.storeUrl onSuccessBlock:^{
[self.commandDelegate sendPluginResult:[CDVPluginResult resultWithStatus:CDVCommandStatus_OK] callbackId:command.callbackId];
_appUpdateRequestDialog = nil;
} onFailureBlock:^{
[self.commandDelegate sendPluginResult:[CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR] callbackId:command.callbackId];
_appUpdateRequestDialog = nil;
}];
[_appUpdateRequestDialog show];
}
- (void)jsIsUpdateAvailableForInstallation:(CDVInvokedUrlCommand *)command {
NSDictionary *data = nil;
NSError *error = nil;
if (_pluginInternalPrefs.readyForInstallationReleaseVersionName.length) {
data = @{@"currentVersion": _pluginInternalPrefs.currentReleaseVersionName,
@"readyToInstallVersion": _pluginInternalPrefs.readyForInstallationReleaseVersionName};
} else {
error = [NSError errorWithCode:kHCPNothingToInstallErrorCode description:@"Nothing to install"];
}
CDVPluginResult *result = [CDVPluginResult pluginResultWithActionName:nil data:data error:error];
[self.commandDelegate sendPluginResult:result callbackId:command.callbackId];
}
- (void)jsGetVersionInfo:(CDVInvokedUrlCommand *)command {
NSDictionary *data = @{@"currentWebVersion": _pluginInternalPrefs.currentReleaseVersionName,
@"readyToInstallWebVersion": _pluginInternalPrefs.readyForInstallationReleaseVersionName,
@"previousWebVersion": _pluginInternalPrefs.previousReleaseVersionName,
@"appVersion": [NSBundle applicationVersionName],
@"buildVersion": [NSBundle applicationBuildVersion]};
CDVPluginResult *result = [CDVPluginResult pluginResultWithActionName:nil data:data error:nil];
[self.commandDelegate sendPluginResult:result callbackId:command.callbackId];
}
- (void)sendPluginNotReadyToWorkMessageForEvent:(NSString *)eventName callbackID:(NSString *)callbackID {
NSError *error = [NSError errorWithCode:kHCPAssetsNotYetInstalledErrorCode
description:@"WWW folder from the bundle is not yet installed on the external device. Please, wait for this operation to finish."];
CDVPluginResult *errorResult = [CDVPluginResult pluginResultWithActionName:eventName
data:nil
error:error];
[self.commandDelegate sendPluginResult:errorResult callbackId:callbackID];
}
@end