123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266 |
- //
- // iRate.m
- //
- // Version 1.12.1
- //
- // Created by Nick Lockwood on 26/01/2011.
- // Copyright 2011 Charcoal Design
- //
- // Distributed under the permissive zlib license
- // Get the latest version from here:
- //
- // https://github.com/nicklockwood/iRate
- //
- // This software is provided 'as-is', without any express or implied
- // warranty. In no event will the authors be held liable for any damages
- // arising from the use of this software.
- //
- // Permission is granted to anyone to use this software for any purpose,
- // including commercial applications, and to alter it and redistribute it
- // freely, subject to the following restrictions:
- //
- // 1. The origin of this software must not be misrepresented; you must not
- // claim that you wrote the original software. If you use this software
- // in a product, an acknowledgment in the product documentation would be
- // appreciated but is not required.
- //
- // 2. Altered source versions must be plainly marked as such, and must not be
- // misrepresented as being the original software.
- //
- // 3. This notice may not be removed or altered from any source distribution.
- //
- #import "iRate.h"
- #import <Availability.h>
- #if !__has_feature(objc_arc)
- #error This class requires automatic reference counting
- #endif
- #pragma clang diagnostic ignored "-Warc-repeated-use-of-weak"
- #pragma clang diagnostic ignored "-Wobjc-missing-property-synthesis"
- #pragma clang diagnostic ignored "-Wdirect-ivar-access"
- #pragma clang diagnostic ignored "-Wpartial-availability"
- #pragma clang diagnostic ignored "-Wunused-macros"
- #pragma clang diagnostic ignored "-Wconversion"
- #pragma clang diagnostic ignored "-Wformat-nonliteral"
- #pragma clang diagnostic ignored "-Wdouble-promotion"
- #pragma clang diagnostic ignored "-Wselector"
- #pragma clang diagnostic ignored "-Wgnu"
- NSUInteger const iRateAppStoreGameGenreID = 6014;
- NSString *const iRateErrorDomain = @"iRateErrorDomain";
- NSString *const iRateMessageTitleKey = @"iRateMessageTitle";
- NSString *const iRateAppMessageKey = @"iRateAppMessage";
- NSString *const iRateGameMessageKey = @"iRateGameMessage";
- NSString *const iRateUpdateMessageKey = @"iRateUpdateMessage";
- NSString *const iRateCancelButtonKey = @"iRateCancelButton";
- NSString *const iRateRemindButtonKey = @"iRateRemindButton";
- NSString *const iRateRateButtonKey = @"iRateRateButton";
- NSString *const iRateCouldNotConnectToAppStore = @"iRateCouldNotConnectToAppStore";
- NSString *const iRateDidDetectAppUpdate = @"iRateDidDetectAppUpdate";
- NSString *const iRateDidPromptForRating = @"iRateDidPromptForRating";
- NSString *const iRateUserDidAttemptToRateApp = @"iRateUserDidAttemptToRateApp";
- NSString *const iRateUserDidDeclineToRateApp = @"iRateUserDidDeclineToRateApp";
- NSString *const iRateUserDidRequestReminderToRateApp = @"iRateUserDidRequestReminderToRateApp";
- NSString *const iRateDidOpenAppStore = @"iRateDidOpenAppStore";
- static NSString *const iRateAppStoreIDKey = @"iRateAppStoreID";
- static NSString *const iRateRatedVersionKey = @"iRateRatedVersionChecked";
- static NSString *const iRateDeclinedVersionKey = @"iRateDeclinedVersion";
- static NSString *const iRateLastRemindedKey = @"iRateLastReminded";
- static NSString *const iRateLastVersionUsedKey = @"iRateLastVersionUsed";
- static NSString *const iRateFirstUsedKey = @"iRateFirstUsed";
- static NSString *const iRateUseCountKey = @"iRateUseCount";
- static NSString *const iRateEventCountKey = @"iRateEventCount";
- static NSString *const iRateMacAppStoreBundleID = @"com.apple.appstore";
- static NSString *const iRateAppLookupURLFormat = @"https://itunes.apple.com/%@/lookup";
- static NSString *const iRateiOSAppStoreURLScheme = @"itms-apps";
- static NSString *const iRateiOSAppStoreURLFormat = @"itms-apps://itunes.apple.com/app/id%@?action=write-review";
- static NSString *const iRateMacAppStoreURLFormat = @"macappstore://itunes.apple.com/app/id%@?action=write-review";
- #define SECONDS_IN_A_DAY 86400.0
- #define SECONDS_IN_A_WEEK 604800.0
- #define MAC_APP_STORE_REFRESH_DELAY 5.0
- #define REQUEST_TIMEOUT 60.0
- @interface iRate()
- @property (nonatomic, strong) id visibleAlert;
- @property (nonatomic, assign) BOOL checkingForPrompt;
- @property (nonatomic, assign) BOOL checkingForAppStoreID;
- @end
- @implementation iRate
- + (void)load
- {
- dispatch_async(dispatch_get_main_queue(), ^{
- [self sharedInstance];
- });
- }
- + (instancetype)sharedInstance
- {
- static dispatch_once_t once;
- static iRate *sharedInstance = nil;
- dispatch_once(&once, ^{
- sharedInstance = [(iRate *)[self alloc] init];
- });
- return sharedInstance;
- }
- - (NSString *)localizedStringForKey:(NSString *)key withDefault:(NSString *)defaultString
- {
- static NSBundle *bundle = nil;
- if (bundle == nil)
- {
- NSString *bundlePath = [[NSBundle bundleForClass:[iRate class]] pathForResource:@"iRate" ofType:@"bundle"];
- if (self.useAllAvailableLanguages)
- {
- bundle = [NSBundle bundleWithPath:bundlePath];
- NSString *language = [[NSLocale preferredLanguages] count]? [NSLocale preferredLanguages][0]: @"en";
- if (![[bundle localizations] containsObject:language])
- {
- language = [language componentsSeparatedByString:@"-"][0];
- }
- if ([[bundle localizations] containsObject:language])
- {
- bundlePath = [bundle pathForResource:language ofType:@"lproj"];
- }
- }
- bundle = [NSBundle bundleWithPath:bundlePath] ?: [NSBundle mainBundle];
- }
- defaultString = [bundle localizedStringForKey:key value:defaultString table:nil];
- return [[NSBundle mainBundle] localizedStringForKey:key value:defaultString table:nil];
- }
- - (iRate *)init
- {
- if ((self = [super init]))
- {
- #if TARGET_OS_IPHONE
- //register for iphone application events
- if (&UIApplicationWillEnterForegroundNotification)
- {
- [[NSNotificationCenter defaultCenter] addObserver:self
- selector:@selector(applicationWillEnterForeground)
- name:UIApplicationWillEnterForegroundNotification
- object:nil];
- }
- #endif
- //get country
- self.appStoreCountry = [(NSLocale *)[NSLocale currentLocale] objectForKey:NSLocaleCountryCode];
- if ([self.appStoreCountry isEqualToString:@"150"])
- {
- self.appStoreCountry = @"eu";
- }
- else if (!self.appStoreCountry || [[self.appStoreCountry stringByReplacingOccurrencesOfString:@"[A-Za-z]{2}" withString:@"" options:NSRegularExpressionSearch range:NSMakeRange(0, 2)] length])
- {
- self.appStoreCountry = @"us";
- }
- else if ([self.appStoreCountry isEqualToString:@"GI"])
- {
- self.appStoreCountry = @"GB";
- }
- //application version (use short version preferentially)
- self.applicationVersion = [[NSBundle mainBundle] objectForInfoDictionaryKey:@"CFBundleShortVersionString"];
- if ([self.applicationVersion length] == 0)
- {
- self.applicationVersion = [[NSBundle mainBundle] objectForInfoDictionaryKey:(__bridge NSString *)kCFBundleVersionKey];
- }
- //localised application name
- self.applicationName = [[NSBundle mainBundle] objectForInfoDictionaryKey:@"CFBundleDisplayName"];
- if ([self.applicationName length] == 0)
- {
- self.applicationName = [[NSBundle mainBundle] objectForInfoDictionaryKey:(__bridge NSString *)kCFBundleNameKey];
- }
- //bundle id
- self.applicationBundleID = [[NSBundle mainBundle] bundleIdentifier];
- //default settings
- self.useAllAvailableLanguages = YES;
- self.promptForNewVersionIfUserRated = NO;
- self.onlyPromptIfLatestVersion = YES;
- self.onlyPromptIfMainWindowIsAvailable = YES;
- self.promptAtLaunch = YES;
- self.usesUntilPrompt = 10;
- self.eventsUntilPrompt = 10;
- self.daysUntilPrompt = 10.0;
- self.usesPerWeekForPrompt = 0.0;
- self.remindPeriod = 1.0;
- self.verboseLogging = NO;
- self.previewMode = NO;
- self.useSKStoreReviewControllerIfAvailable = YES;
- #if DEBUG
- //enable verbose logging in debug mode
- self.verboseLogging = YES;
- NSLog(@"iRate verbose logging enabled.");
- #endif
- //app launched
- dispatch_async(dispatch_get_main_queue(), ^{
- [self applicationLaunched];
- });
- }
- return self;
- }
- - (id<iRateDelegate>)delegate
- {
- if (_delegate == nil)
- {
- #if TARGET_OS_IPHONE
- #define APP_CLASS UIApplication
- #else
- #define APP_CLASS NSApplication
- #endif
- _delegate = (id<iRateDelegate>)[(APP_CLASS *)[APP_CLASS sharedApplication] delegate];
- }
- return _delegate;
- }
- - (NSString *)messageTitle
- {
- return [_messageTitle ?: [self localizedStringForKey:iRateMessageTitleKey withDefault:@"Rate %@"] stringByReplacingOccurrencesOfString:@"%@" withString:self.applicationName];
- }
- - (NSString *)message
- {
- NSString *message = _message;
- if (!message)
- {
- message = (self.appStoreGenreID == iRateAppStoreGameGenreID)? [self localizedStringForKey:iRateGameMessageKey withDefault:@"If you enjoy playing %@, would you mind taking a moment to rate it? It won’t take more than a minute. Thanks for your support!"]: [self localizedStringForKey:iRateAppMessageKey withDefault:@"If you enjoy using %@, would you mind taking a moment to rate it? It won’t take more than a minute. Thanks for your support!"];
- }
- return [message stringByReplacingOccurrencesOfString:@"%@" withString:self.applicationName];
- }
- - (NSString *)updateMessage
- {
- NSString *updateMessage = _updateMessage;
- if (!updateMessage)
- {
- updateMessage = [self localizedStringForKey:iRateUpdateMessageKey withDefault:self.message];
- }
- return [updateMessage stringByReplacingOccurrencesOfString:@"%@" withString:self.applicationName];
- }
- - (NSString *)cancelButtonLabel
- {
- return _cancelButtonLabel ?: [self localizedStringForKey:iRateCancelButtonKey withDefault:@"No, Thanks"];
- }
- - (NSString *)rateButtonLabel
- {
- return _rateButtonLabel ?: [self localizedStringForKey:iRateRateButtonKey withDefault:@"Rate It Now"];
- }
- - (NSString *)remindButtonLabel
- {
- return _remindButtonLabel ?: [self localizedStringForKey:iRateRemindButtonKey withDefault:@"Remind Me Later"];
- }
- - (NSURL *)ratingsURL
- {
- if (_ratingsURL)
- {
- return _ratingsURL;
- }
- if (!self.appStoreID && self.verboseLogging)
- {
- NSLog(@"iRate could not find the App Store ID for this application. If the application is not intended for App Store release then you must specify a custom ratingsURL.");
- }
- NSString *URLString;
- #if TARGET_OS_IPHONE
- URLString = iRateiOSAppStoreURLFormat;
- #else
- URLString = iRateMacAppStoreURLFormat;
- #endif
- return [NSURL URLWithString:[NSString stringWithFormat:URLString, @(self.appStoreID)]];
- }
- - (NSUInteger)appStoreID
- {
- return _appStoreID ?: [[[NSUserDefaults standardUserDefaults] objectForKey:iRateAppStoreIDKey] unsignedIntegerValue];
- }
- - (NSDate *)firstUsed
- {
- return [[NSUserDefaults standardUserDefaults] objectForKey:iRateFirstUsedKey];
- }
- - (void)setFirstUsed:(NSDate *)date
- {
- [[NSUserDefaults standardUserDefaults] setObject:date forKey:iRateFirstUsedKey];
- [[NSUserDefaults standardUserDefaults] synchronize];
- }
- - (NSDate *)lastReminded
- {
- return [[NSUserDefaults standardUserDefaults] objectForKey:iRateLastRemindedKey];
- }
- - (void)setLastReminded:(NSDate *)date
- {
- [[NSUserDefaults standardUserDefaults] setObject:date forKey:iRateLastRemindedKey];
- [[NSUserDefaults standardUserDefaults] synchronize];
- }
- - (NSUInteger)usesCount
- {
- return [[NSUserDefaults standardUserDefaults] integerForKey:iRateUseCountKey];
- }
- - (void)setUsesCount:(NSUInteger)count
- {
- [[NSUserDefaults standardUserDefaults] setInteger:(NSInteger)count forKey:iRateUseCountKey];
- [[NSUserDefaults standardUserDefaults] synchronize];
- }
- - (NSUInteger)eventCount
- {
- return [[NSUserDefaults standardUserDefaults] integerForKey:iRateEventCountKey];
- }
- - (void)setEventCount:(NSUInteger)count
- {
- [[NSUserDefaults standardUserDefaults] setInteger:(NSInteger)count forKey:iRateEventCountKey];
- [[NSUserDefaults standardUserDefaults] synchronize];
- }
- - (float)usesPerWeek
- {
- return (float)self.usesCount / ([[NSDate date] timeIntervalSinceDate:self.firstUsed] / SECONDS_IN_A_WEEK);
- }
- - (BOOL)declinedThisVersion
- {
- return [[[NSUserDefaults standardUserDefaults] objectForKey:iRateDeclinedVersionKey] isEqualToString:self.applicationVersion];
- }
- - (void)setDeclinedThisVersion:(BOOL)declined
- {
- [[NSUserDefaults standardUserDefaults] setObject:(declined? self.applicationVersion: nil) forKey:iRateDeclinedVersionKey];
- [[NSUserDefaults standardUserDefaults] synchronize];
- }
- - (BOOL)declinedAnyVersion
- {
- return [(NSString *)[[NSUserDefaults standardUserDefaults] objectForKey:iRateDeclinedVersionKey] length] != 0;
- }
- - (BOOL)ratedVersion:(NSString *)version
- {
- return [[[NSUserDefaults standardUserDefaults] objectForKey:iRateRatedVersionKey] isEqualToString:version];
- }
- - (BOOL)ratedThisVersion
- {
- return [self ratedVersion:self.applicationVersion];
- }
- - (void)setRatedThisVersion:(BOOL)rated
- {
- [[NSUserDefaults standardUserDefaults] setObject:(rated? self.applicationVersion: nil) forKey:iRateRatedVersionKey];
- [[NSUserDefaults standardUserDefaults] synchronize];
- }
- - (BOOL)ratedAnyVersion
- {
- return [(NSString *)[[NSUserDefaults standardUserDefaults] objectForKey:iRateRatedVersionKey] length] != 0;
- }
- - (void)dealloc
- {
- [[NSNotificationCenter defaultCenter] removeObserver:self];
- }
- - (void)incrementUseCount
- {
- self.usesCount ++;
- }
- - (void)incrementEventCount
- {
- self.eventCount ++;
- }
- - (BOOL)shouldPromptForRating
- {
- //preview mode?
- if (self.previewMode)
- {
- NSLog(@"iRate preview mode is enabled - make sure you disable this for release");
- return YES;
- }
- //check if we've rated this version
- else if (self.ratedThisVersion)
- {
- if (self.verboseLogging)
- {
- NSLog(@"iRate did not prompt for rating because the user has already rated this version");
- }
- return NO;
- }
- //check if we've rated any version
- else if (self.ratedAnyVersion && !self.promptForNewVersionIfUserRated)
- {
- if (self.verboseLogging)
- {
- NSLog(@"iRate did not prompt for rating because the user has already rated this app, and promptForNewVersionIfUserRated is disabled");
- }
- return NO;
- }
- //check if we've declined to rate the app
- else if (self.declinedAnyVersion)
- {
- if (self.verboseLogging)
- {
- NSLog(@"iRate did not prompt for rating because the user has declined to rate the app");
- }
- return NO;
- }
- //check how long we've been using this version
- else if ([[NSDate date] timeIntervalSinceDate:self.firstUsed] < self.daysUntilPrompt * SECONDS_IN_A_DAY)
- {
- if (self.verboseLogging)
- {
- NSLog(@"iRate did not prompt for rating because the app was first used less than %g days ago", self.daysUntilPrompt);
- }
- return NO;
- }
- //check how many times we've used it and the number of significant events
- else if (self.usesCount < self.usesUntilPrompt && self.eventCount < self.eventsUntilPrompt)
- {
- if (self.verboseLogging)
- {
- NSLog(@"iRate did not prompt for rating because the app has only been used %@ times and only %@ events have been logged", @(self.usesCount), @(self.eventCount));
- }
- return NO;
- }
- //check if usage frequency is high enough
- else if (self.usesPerWeek < self.usesPerWeekForPrompt)
- {
- if (self.verboseLogging)
- {
- NSLog(@"iRate did not prompt for rating because the app has only been used %g times per week on average since it was installed", self.usesPerWeek);
- }
- return NO;
- }
- //check if within the reminder period
- else if (self.lastReminded != nil && [[NSDate date] timeIntervalSinceDate:self.lastReminded] < self.remindPeriod * SECONDS_IN_A_DAY)
- {
- if (self.verboseLogging)
- {
- NSLog(@"iRate did not prompt for rating because the user last asked to be reminded less than %g days ago", self.remindPeriod);
- }
- return NO;
- }
- //lets prompt!
- return YES;
- }
- - (NSString *)valueForKey:(NSString *)key inJSON:(id)json
- {
- if ([json isKindOfClass:[NSString class]])
- {
- //use legacy parser
- NSRange keyRange = [json rangeOfString:[NSString stringWithFormat:@"\"%@\"", key]];
- if (keyRange.location != NSNotFound)
- {
- NSInteger start = keyRange.location + keyRange.length;
- NSRange valueStart = [json rangeOfString:@":" options:(NSStringCompareOptions)0 range:NSMakeRange(start, [(NSString *)json length] - start)];
- if (valueStart.location != NSNotFound)
- {
- start = valueStart.location + 1;
- NSRange valueEnd = [json rangeOfString:@"," options:(NSStringCompareOptions)0 range:NSMakeRange(start, [(NSString *)json length] - start)];
- if (valueEnd.location != NSNotFound)
- {
- NSString *value = [json substringWithRange:NSMakeRange(start, valueEnd.location - start)];
- value = [value stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]];
- while ([value hasPrefix:@"\""] && ![value hasSuffix:@"\""])
- {
- if (valueEnd.location == NSNotFound)
- {
- break;
- }
- NSInteger newStart = valueEnd.location + 1;
- valueEnd = [json rangeOfString:@"," options:(NSStringCompareOptions)0 range:NSMakeRange(newStart, [(NSString *)json length] - newStart)];
- value = [json substringWithRange:NSMakeRange(start, valueEnd.location - start)];
- value = [value stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]];
- }
- value = [value stringByTrimmingCharactersInSet:[NSCharacterSet characterSetWithCharactersInString:@"\""]];
- value = [value stringByReplacingOccurrencesOfString:@"\\\\" withString:@"\\"];
- value = [value stringByReplacingOccurrencesOfString:@"\\/" withString:@"/"];
- value = [value stringByReplacingOccurrencesOfString:@"\\\"" withString:@"\""];
- value = [value stringByReplacingOccurrencesOfString:@"\\n" withString:@"\n"];
- value = [value stringByReplacingOccurrencesOfString:@"\\r" withString:@"\r"];
- value = [value stringByReplacingOccurrencesOfString:@"\\t" withString:@"\t"];
- value = [value stringByReplacingOccurrencesOfString:@"\\f" withString:@"\f"];
- value = [value stringByReplacingOccurrencesOfString:@"\\b" withString:@"\f"];
- while (YES)
- {
- NSRange unicode = [value rangeOfString:@"\\u"];
- if (unicode.location == NSNotFound || unicode.location + unicode.length == 0)
- {
- break;
- }
- uint32_t c = 0;
- NSString *hex = [value substringWithRange:NSMakeRange(unicode.location + 2, 4)];
- NSScanner *scanner = [NSScanner scannerWithString:hex];
- [scanner scanHexInt:&c];
- if (c <= 0xffff)
- {
- value = [value stringByReplacingCharactersInRange:NSMakeRange(unicode.location, 6) withString:[NSString stringWithFormat:@"%C", (unichar)c]];
- }
- else
- {
- //convert character to surrogate pair
- uint16_t x = (uint16_t)c;
- uint16_t u = (c >> 16) & ((1 << 5) - 1);
- uint16_t w = (uint16_t)u - 1;
- unichar high = 0xd800 | (w << 6) | x >> 10;
- unichar low = (uint16_t)(0xdc00 | (x & ((1 << 10) - 1)));
- value = [value stringByReplacingCharactersInRange:NSMakeRange(unicode.location, 6) withString:[NSString stringWithFormat:@"%C%C", high, low]];
- }
- }
- return value;
- }
- }
- }
- }
- else
- {
- return json[key];
- }
- return nil;
- }
- - (void)setAppStoreIDOnMainThread:(NSString *)appStoreIDString
- {
- _appStoreID = [appStoreIDString integerValue];
- [[NSUserDefaults standardUserDefaults] setInteger:_appStoreID forKey:iRateAppStoreIDKey];
- [[NSUserDefaults standardUserDefaults] synchronize];
- }
- - (void)connectionSucceeded
- {
- if (self.checkingForAppStoreID)
- {
- //no longer checking
- self.checkingForPrompt = NO;
- self.checkingForAppStoreID = NO;
- //open app store
- [self openRatingsPageInAppStore];
- }
- else if (self.checkingForPrompt)
- {
- //no longer checking
- self.checkingForPrompt = NO;
- //confirm with delegate
- if ([self.delegate respondsToSelector:@selector(iRateShouldPromptForRating)] && ![self.delegate iRateShouldPromptForRating])
- {
- if (self.verboseLogging)
- {
- NSLog(@"iRate did not display the rating prompt because the iRateShouldPromptForRating delegate method returned NO");
- }
- return;
- }
- //prompt user
- [self promptForRating: NO];
- }
- }
- - (void)connectionError:(NSError *)error
- {
- if (self.checkingForPrompt || self.checkingForAppStoreID)
- {
- //no longer checking
- self.checkingForPrompt = NO;
- self.checkingForAppStoreID = NO;
- //log the error
- if (error)
- {
- NSLog(@"iRate rating process failed because: %@", [error localizedDescription]);
- }
- else
- {
- NSLog(@"iRate rating process failed because an unknown error occurred");
- }
- //could not connect
- if ([self.delegate respondsToSelector:@selector(iRateCouldNotConnectToAppStore:)])
- {
- [self.delegate iRateCouldNotConnectToAppStore:error];
- }
- [[NSNotificationCenter defaultCenter] postNotificationName:iRateCouldNotConnectToAppStore
- object:error];
- }
- }
- - (void)checkForConnectivityInBackground
- {
- #if (defined(__IPHONE_OS_VERSION_MIN_REQUIRED) && __IPHONE_OS_VERSION_MIN_REQUIRED >= __IPHONE_8_0) \
- || (defined(__MAC_OS_X_VERSION_MIN_REQUIRED) && __MAC_OS_X_VERSION_MIN_REQUIRED >= __MAC_10_10)
- #define IRATE_BACKGROUND_QUEUE QOS_CLASS_BACKGROUND
- #else
- #define IRATE_BACKGROUND_QUEUE DISPATCH_QUEUE_PRIORITY_BACKGROUND
- #endif
- dispatch_async(dispatch_get_global_queue(IRATE_BACKGROUND_QUEUE, 0), ^{
- [self checkForConnectivity];
- });
- }
- - (void)checkForConnectivity
- {
- @autoreleasepool
- {
- //first check iTunes
- NSString *iTunesServiceURL = [NSString stringWithFormat:iRateAppLookupURLFormat, self.appStoreCountry];
- if (_appStoreID) //important that we check ivar and not getter in case it has changed
- {
- iTunesServiceURL = [iTunesServiceURL stringByAppendingFormat:@"?id=%@", @(_appStoreID)];
- }
- else
- {
- iTunesServiceURL = [iTunesServiceURL stringByAppendingFormat:@"?bundleId=%@", self.applicationBundleID];
- }
- if (self.verboseLogging)
- {
- NSLog(@"iRate is checking %@ to retrieve the App Store details...", iTunesServiceURL);
- }
- NSError *error = nil;
- NSURLResponse *response = nil;
- NSURL *url = [NSURL URLWithString:iTunesServiceURL];
- NSURLRequest *request = [NSURLRequest requestWithURL:url cachePolicy:NSURLRequestReloadIgnoringLocalCacheData timeoutInterval:REQUEST_TIMEOUT];
- #pragma clang diagnostic push
- #pragma clang diagnostic ignored "-Wdeprecated-declarations"
- NSData *data = [NSURLConnection sendSynchronousRequest:request returningResponse:&response error:&error];
- #pragma clang diagnostic pop
- NSInteger statusCode = ((NSHTTPURLResponse *)response).statusCode;
- if (data && statusCode == 200)
- {
- //in case error is garbage...
- error = nil;
- id json = nil;
- if ([NSJSONSerialization class])
- {
- json = [[NSJSONSerialization JSONObjectWithData:data options:(NSJSONReadingOptions)0 error:&error][@"results"] lastObject];
- }
- else
- {
- //convert to string
- json = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
- }
- if (!error)
- {
- //check bundle ID matches
- NSString *bundleID = [self valueForKey:@"bundleId" inJSON:json];
- if (bundleID)
- {
- if ([bundleID.lowercaseString isEqualToString:self.applicationBundleID.lowercaseString])
- {
- //get genre
- if (self.appStoreGenreID == 0)
- {
- self.appStoreGenreID = [[self valueForKey:@"primaryGenreId" inJSON:json] integerValue];
- }
- //get app id
- if (!_appStoreID)
- {
- NSString *appStoreIDString = [self valueForKey:@"trackId" inJSON:json];
- dispatch_sync(dispatch_get_main_queue(), ^{
- [self setAppStoreIDOnMainThread:appStoreIDString];
- });
- if (self.verboseLogging)
- {
- NSLog(@"iRate found the app on iTunes. The App Store ID is %@", appStoreIDString);
- }
- }
- //check version
- if (self.onlyPromptIfLatestVersion && !self.previewMode)
- {
- NSString *latestVersion = [self valueForKey:@"version" inJSON:json];
- if ([latestVersion compare:self.applicationVersion options:NSNumericSearch] == NSOrderedDescending)
- {
- if (self.verboseLogging)
- {
- NSLog(@"iRate found that the installed application version (%@) is not the latest version on the App Store, which is %@", self.applicationVersion, latestVersion);
- }
- error = [NSError errorWithDomain:iRateErrorDomain code:iRateErrorApplicationIsNotLatestVersion userInfo:@{NSLocalizedDescriptionKey: @"Installed app is not the latest version available"}];
- }
- }
- }
- else
- {
- if (self.verboseLogging)
- {
- NSLog(@"iRate found that the application bundle ID (%@) does not match the bundle ID of the app found on iTunes (%@) with the specified App Store ID (%@)", self.applicationBundleID, bundleID, @(self.appStoreID));
- }
- error = [NSError errorWithDomain:iRateErrorDomain code:iRateErrorBundleIdDoesNotMatchAppStore userInfo:@{NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Application bundle ID does not match expected value of %@", bundleID]}];
- }
- }
- else if (_appStoreID || !self.ratingsURL)
- {
- if (self.verboseLogging)
- {
- NSLog(@"iRate could not find this application on iTunes. If your app is not intended for App Store release then you must specify a custom ratingsURL. If this is the first release of your application then it's not a problem that it cannot be found on the store yet");
- }
- if (!self.previewMode)
- {
- error = [NSError errorWithDomain:iRateErrorDomain
- code:iRateErrorApplicationNotFoundOnAppStore
- userInfo:@{NSLocalizedDescriptionKey: @"The application could not be found on the App Store."}];
- }
- }
- else if (!_appStoreID && self.verboseLogging)
- {
- NSLog(@"iRate could not find your app on iTunes. If your app is not yet on the store or is not intended for App Store release then don't worry about this");
- }
- }
- }
- else if (statusCode >= 400)
- {
- //http error
- NSString *message = [NSString stringWithFormat:@"The server returned a %@ error", @(statusCode)];
- error = [NSError errorWithDomain:@"HTTPResponseErrorDomain" code:statusCode userInfo:@{NSLocalizedDescriptionKey: message}];
- }
- dispatch_async(dispatch_get_main_queue(), ^{
- //handle errors (ignoring sandbox issues)
- if (error && !(error.code == EPERM && [error.domain isEqualToString:NSPOSIXErrorDomain] && self.appStoreID))
- {
- [self connectionError:error];
- }
- else if (self.appStoreID || self.previewMode)
- {
- //show prompt
- [self connectionSucceeded];
- }
- });
- }
- }
- - (void)promptIfNetworkAvailable
- {
- if (!self.checkingForPrompt && !self.checkingForAppStoreID)
- {
- self.checkingForPrompt = YES;
- [self checkForConnectivityInBackground];
- }
- }
- - (void)promptIfAllCriteriaMet
- {
- if ([self shouldPromptForRating])
- {
- [self promptIfNetworkAvailable];
- }
- }
- - (BOOL)showRemindButton
- {
- return [self.remindButtonLabel length];
- }
- - (BOOL)showCancelButton
- {
- return [self.cancelButtonLabel length];
- }
- - (void)promptForRating
- {
- [self promptForRating: YES];
- }
- - (void)promptForRating:(BOOL)manual
- {
- if (!self.visibleAlert)
- {
- NSString *message = self.ratedAnyVersion? self.updateMessage: self.message;
- #if TARGET_OS_IPHONE
- #if __IPHONE_OS_VERSION_MAX_ALLOWED > __IPHONE_10_2
- if (!manual && [SKStoreReviewController class])
- {
- [self remindLater];
- [SKStoreReviewController requestReview];
- }
- else
- #endif
- {
- UIViewController *topController = [UIApplication sharedApplication].delegate.window.rootViewController;
- while (topController.presentedViewController)
- {
- topController = topController.presentedViewController;
- }
- if ([UIAlertController class] && topController && self.useUIAlertControllerIfAvailable)
- {
- UIAlertController *alert = [UIAlertController alertControllerWithTitle:self.messageTitle message:message preferredStyle:UIAlertControllerStyleAlert];
- //rate action
- [alert addAction:[UIAlertAction actionWithTitle:self.rateButtonLabel style:UIAlertActionStyleDefault handler:^(__unused UIAlertAction *action) {
- [self didDismissAlert:alert withButtonAtIndex:0];
- }]];
- //cancel action
- if ([self showCancelButton])
- {
- [alert addAction:[UIAlertAction actionWithTitle:self.cancelButtonLabel style:UIAlertActionStyleCancel handler:^(__unused UIAlertAction *action) {
- [self didDismissAlert:alert withButtonAtIndex:1];
- }]];
- }
- //remind action
- if ([self showRemindButton])
- {
- [alert addAction:[UIAlertAction actionWithTitle:self.remindButtonLabel style:UIAlertActionStyleDefault handler:^(__unused UIAlertAction *action) {
- [self didDismissAlert:alert withButtonAtIndex:[self showCancelButton]? 2: 1];
- }]];
- }
- self.visibleAlert = alert;
- //get current view controller and present alert
- [topController presentViewController:alert animated:YES completion:NULL];
- }
- else
- {
- #pragma clang diagnostic push
- #pragma clang diagnostic ignored "-Wdeprecated-declarations"
- UIAlertView *alert = [[UIAlertView alloc] initWithTitle:self.messageTitle
- message:message
- delegate:(id<UIAlertViewDelegate>)self
- cancelButtonTitle:nil
- otherButtonTitles:self.rateButtonLabel, nil];
- #pragma clang diagnostic pop
- if ([self showCancelButton])
- {
- [alert addButtonWithTitle:self.cancelButtonLabel];
- alert.cancelButtonIndex = 1;
- }
- if ([self showRemindButton])
- {
- [alert addButtonWithTitle:self.remindButtonLabel];
- }
- self.visibleAlert = alert;
- [self.visibleAlert show];
- }
- }
- #else
- //only show when main window is available
- if (self.onlyPromptIfMainWindowIsAvailable && ![[NSApplication sharedApplication] mainWindow])
- {
- dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(0.5 * NSEC_PER_SEC)), dispatch_get_main_queue(), ^{
- [self promptForRating: NO];
- });
- return;
- }
- NSAlert *alert = [[NSAlert alloc] init];
- alert.messageText = self.messageTitle;
- alert.informativeText = message;
- [alert addButtonWithTitle:self.rateButtonLabel];
- if ([self showCancelButton])
- {
- [alert addButtonWithTitle:self.cancelButtonLabel];
- }
- if ([self showRemindButton])
- {
- [alert addButtonWithTitle:self.remindButtonLabel];
- }
- self.visibleAlert = alert;
- #if __MAC_OS_X_VERSION_MIN_REQUIRED < __MAC_10_9
- if (![alert respondsToSelector:@selector(beginSheetModalForWindow:completionHandler:)])
- {
- [alert beginSheetModalForWindow:(__nonnull id)[NSApplication sharedApplication].mainWindow
- modalDelegate:self
- didEndSelector:@selector(alertDidEnd:returnCode:contextInfo:)
- contextInfo:nil];
- }
- else
- #endif
- {
- [alert beginSheetModalForWindow:(__nonnull id)[NSApplication sharedApplication].mainWindow completionHandler:^(NSModalResponse returnCode) {
- [self didDismissAlert:alert withButtonAtIndex:returnCode - NSAlertFirstButtonReturn];
- }];
- }
- #endif
- //inform about prompt
- if ([self.delegate respondsToSelector:@selector(iRateDidPromptForRating)])
- {
- [self.delegate iRateDidPromptForRating];
- }
- [[NSNotificationCenter defaultCenter] postNotificationName:iRateDidPromptForRating
- object:nil];
- }
- }
- - (void)applicationLaunched
- {
- //check if this is a new version
- NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
- NSString *lastUsedVersion = [defaults objectForKey:iRateLastVersionUsedKey];
- if (!self.firstUsed || ![lastUsedVersion isEqualToString:self.applicationVersion])
- {
- [defaults setObject:self.applicationVersion forKey:iRateLastVersionUsedKey];
- if (!self.firstUsed || [self ratedAnyVersion])
- {
- //reset defaults
- [defaults setObject:[NSDate date] forKey:iRateFirstUsedKey];
- [defaults setInteger:0 forKey:iRateUseCountKey];
- [defaults setInteger:0 forKey:iRateEventCountKey];
- [defaults setObject:nil forKey:iRateLastRemindedKey];
- [defaults synchronize];
- }
- else if ([[NSDate date] timeIntervalSinceDate:self.firstUsed] > (self.daysUntilPrompt - 1) * SECONDS_IN_A_DAY)
- {
- //if was previously installed, but we haven't yet prompted for a rating
- //don't reset, but make sure it won't rate for a day at least
- self.firstUsed = [[NSDate date] dateByAddingTimeInterval:(self.daysUntilPrompt - 1) * -SECONDS_IN_A_DAY];
- }
- //inform about app update
- if ([self.delegate respondsToSelector:@selector(iRateDidDetectAppUpdate)])
- {
- [self.delegate iRateDidDetectAppUpdate];
- }
- [[NSNotificationCenter defaultCenter] postNotificationName:iRateDidDetectAppUpdate
- object:nil];
- }
- [self incrementUseCount];
- [self checkForConnectivityInBackground];
- if (self.promptAtLaunch)
- {
- [self promptIfAllCriteriaMet];
- }
- }
- - (void)didDismissAlert:(__unused id)alertView withButtonAtIndex:(NSInteger)buttonIndex
- {
- dispatch_async(dispatch_get_main_queue(), ^{
- //get button indices
- NSInteger rateButtonIndex = 0;
- NSInteger cancelButtonIndex = [self showCancelButton]? 1: 0;
- NSInteger remindButtonIndex = [self showRemindButton]? cancelButtonIndex + 1: 0;
- if (buttonIndex == rateButtonIndex)
- {
- [self rate];
- }
- else if (buttonIndex == cancelButtonIndex)
- {
- [self declineThisVersion];
- }
- else if (buttonIndex == remindButtonIndex)
- {
- [self remindLater];
- }
-
- //release alert
- self.visibleAlert = nil;
- });
- }
- #if TARGET_OS_IPHONE
- - (void)applicationWillEnterForeground
- {
- if ([UIApplication sharedApplication].applicationState == UIApplicationStateBackground)
- {
- [self incrementUseCount];
- [self checkForConnectivityInBackground];
- if (self.promptAtLaunch)
- {
- [self promptIfAllCriteriaMet];
- }
- }
- }
- - (void)openRatingsPageInAppStore
- {
- if (!_ratingsURL && !self.appStoreID)
- {
- self.checkingForAppStoreID = YES;
- if (!self.checkingForPrompt)
- {
- [self checkForConnectivityInBackground];
- }
- return;
- }
- NSString *cantOpenMessage = nil;
- #if TARGET_IPHONE_SIMULATOR
- if ([[self.ratingsURL scheme] isEqualToString:iRateiOSAppStoreURLScheme])
- {
- cantOpenMessage = @"iRate could not open the ratings page because the App Store is not available on the iOS simulator";
- }
- #endif
- void (^handler)(NSString *errorMessage) = ^(NSString *errorMessage)
- {
- if (errorMessage)
- {
- NSLog(@"%@", errorMessage);
- NSError *error = [NSError errorWithDomain:iRateErrorDomain code:iRateErrorCouldNotOpenRatingPageURL userInfo:@{NSLocalizedDescriptionKey: errorMessage}];
- if ([self.delegate respondsToSelector:@selector(iRateCouldNotConnectToAppStore:)])
- {
- [self.delegate iRateCouldNotConnectToAppStore:error];
- }
- [[NSNotificationCenter defaultCenter] postNotificationName:iRateCouldNotConnectToAppStore
- object:error];
- }
- else
- {
- if ([self.delegate respondsToSelector:@selector(iRateDidOpenAppStore)])
- {
- [self.delegate iRateDidOpenAppStore];
- }
- [[NSNotificationCenter defaultCenter] postNotificationName:iRateDidOpenAppStore
- object:nil];
- }
- };
- if (cantOpenMessage)
- {
- handler(cantOpenMessage);
- }
- else
- {
- if (self.verboseLogging)
- {
- NSLog(@"iRate will open the App Store ratings page using the following URL: %@", self.ratingsURL);
- }
- #if __IPHONE_OS_VERSION_MIN_REQUIRED >= __IPHONE_10_0
- [[UIApplication sharedApplication] openURL:self.ratingsURL options:@{} completionHandler:^(BOOL success){
- if (success)
- {
- handler(nil);
- }
- else
- {
- handler([NSString stringWithFormat:@"iRate was unable to open the specified ratings URL: %@", self.ratingsURL]);
- }
- }];
- #else
- if ([[UIApplication sharedApplication] openURL:self.ratingsURL])
- {
- handler(nil);
- }
- else
- {
- handler([NSString stringWithFormat:@"iRate was unable to open the specified ratings URL: %@", self.ratingsURL]);
- }
- #endif
- }
- }
- #pragma clang diagnostic push
- #pragma clang diagnostic ignored "-Wdeprecated-declarations"
- - (void)alertView:(UIAlertView *)alertView didDismissWithButtonIndex:(NSInteger)buttonIndex
- {
- [self didDismissAlert:alertView withButtonAtIndex:buttonIndex];
- }
- #pragma clang diagnostic pop
- #else
- - (void)openAppPageWhenAppStoreLaunched
- {
- //check if app store is running
- for (NSRunningApplication *app in [[NSWorkspace sharedWorkspace] runningApplications])
- {
- if ([app.bundleIdentifier isEqualToString:iRateMacAppStoreBundleID])
- {
- //open app page
- [[NSWorkspace sharedWorkspace] performSelector:@selector(openURL:) withObject:self.ratingsURL afterDelay:MAC_APP_STORE_REFRESH_DELAY];
- return;
- }
- }
- //try again
- [self performSelector:@selector(openAppPageWhenAppStoreLaunched) withObject:nil afterDelay:0.0];
- }
- - (void)openRatingsPageInAppStore
- {
- if (!_ratingsURL && !self.appStoreID)
- {
- self.checkingForAppStoreID = YES;
- if (!self.checkingForPrompt)
- {
- [self checkForConnectivityInBackground];
- }
- return;
- }
- if (self.verboseLogging)
- {
- NSLog(@"iRate will open the App Store ratings page using the following URL: %@", self.ratingsURL);
- }
- [[NSWorkspace sharedWorkspace] openURL:self.ratingsURL];
- [self openAppPageWhenAppStoreLaunched];
- if ([self.delegate respondsToSelector:@selector(iRateDidOpenAppStore)])
- {
- [self.delegate iRateDidOpenAppStore];
- }
- }
- - (void)alertDidEnd:(NSAlert *)alert returnCode:(NSInteger)returnCode contextInfo:(__unused void *)contextInfo
- {
- [self didDismissAlert:alert withButtonAtIndex:returnCode - NSAlertFirstButtonReturn];
- }
- #endif
- - (void)logEvent:(BOOL)deferPrompt
- {
- [self incrementEventCount];
- if (!deferPrompt)
- {
- [self promptIfAllCriteriaMet];
- }
- }
- #pragma mark - User's actions
- - (void)declineThisVersion
- {
- //ignore this version
- self.declinedThisVersion = YES;
- //log event
- if ([self.delegate respondsToSelector:@selector(iRateUserDidDeclineToRateApp)])
- {
- [self.delegate iRateUserDidDeclineToRateApp];
- }
- [[NSNotificationCenter defaultCenter] postNotificationName:iRateUserDidDeclineToRateApp
- object:nil];
- }
- - (void)remindLater
- {
- //remind later
- self.lastReminded = [NSDate date];
- //log event
- if ([self.delegate respondsToSelector:@selector(iRateUserDidRequestReminderToRateApp)])
- {
- [self.delegate iRateUserDidRequestReminderToRateApp];
- }
- [[NSNotificationCenter defaultCenter] postNotificationName:iRateUserDidRequestReminderToRateApp
- object:nil];
- }
- - (void)rate
- {
- //mark as rated
- self.ratedThisVersion = YES;
- //log event
- if ([self.delegate respondsToSelector:@selector(iRateUserDidAttemptToRateApp)])
- {
- [self.delegate iRateUserDidAttemptToRateApp];
- }
- [[NSNotificationCenter defaultCenter] postNotificationName:iRateUserDidAttemptToRateApp
- object:nil];
- // if the delegate has not implemented the method, or if it returns YES
- if (![self.delegate respondsToSelector:@selector(iRateShouldOpenAppStore)] || [self.delegate iRateShouldOpenAppStore])
- {
- //launch mac app store
- [self openRatingsPageInAppStore];
- }
- }
- @end
|