+ added deprecation to stripMobilePayload

parfeon · parfeon · commit f7bba8db9144 · 2017-02-03T20:22:15.000+02:00
+ added 'stripMobilePayload' deprecation information output to Xcode console [#139015913]
[ci skip]
diff --git a/Example/PubNub Example.xcodeproj/project.pbxproj b/Example/PubNub Example.xcodeproj/project.pbxproj
@@ -619,7 +619,7 @@
 				GCC_WARN_SIGN_COMPARE = YES;
 				GCC_WARN_STRICT_SELECTOR_MATCH = YES;
 				INFOPLIST_FILE = "PubNub/PubNub Example-Info.plist";
-				IPHONEOS_DEPLOYMENT_TARGET = 8.0;
+				IPHONEOS_DEPLOYMENT_TARGET = 8.4;
 				MODULE_NAME = ExampleApp;
 				PRODUCT_BUNDLE_IDENTIFIER = "org.cocoapods.demo.${PRODUCT_NAME:rfc1034identifier}";
 				PRODUCT_NAME = "$(TARGET_NAME)";
@@ -651,7 +651,7 @@
 				GCC_WARN_SIGN_COMPARE = YES;
 				GCC_WARN_STRICT_SELECTOR_MATCH = YES;
 				INFOPLIST_FILE = "PubNub/PubNub Example-Info.plist";
-				IPHONEOS_DEPLOYMENT_TARGET = 8.0;
+				IPHONEOS_DEPLOYMENT_TARGET = 8.4;
 				MODULE_NAME = ExampleApp;
 				PRODUCT_BUNDLE_IDENTIFIER = "org.cocoapods.demo.${PRODUCT_NAME:rfc1034identifier}";
 				PRODUCT_NAME = "$(TARGET_NAME)";
diff --git a/PubNub/Core/PubNub+Core.m b/PubNub/Core/PubNub+Core.m
@@ -165,6 +165,13 @@ - (void)setupClientLogger;
  */
 - (void)printLogVerbosityInformation;
 
+/**
+ @brief  Check client configuration and notify about outdated API and options.
+ 
+ @since 4.5.13
+ */
+- (void)notifyDeprecatedAPI;
+
 #pragma mark -
 
 
@@ -235,6 +242,7 @@ - (instancetype)initWithConfiguration:(PNConfiguration *)configuration
             _instanceID = [@"58EB05C9-9DE4-4118-B5D7-EE059FBF19A9" copy];
         }
         [self prepareNetworkManagers];
+        [self notifyDeprecatedAPI];
         
         _subscriberManager = [PNSubscriber subscriberForClient:self];
         _sequenceManager = [PNPublishSequence sequenceForClient:self];
@@ -601,6 +609,57 @@ - (void)printLogVerbosityInformation {
                     [enabledFlags componentsJoinedByString:@", "]);
 }
 
+- (void)notifyDeprecatedAPI {
+    
+    NSMutableString *deprecation = [NSMutableString new];
+    [deprecation appendString:@"\n\n\n--------------------------------------------\n- PubNub deprecated API "
+                               "usage notification -\n--------------------------------------------\n\n"];
+    if (self.configuration.shouldStripMobilePayload) {
+        
+        [deprecation appendString:@"- Deprecated: PNConfiguration.shouldStripMobilePayload property.-\n"
+         "When set to YES SDK automatically stripped out original message\nfrompayload which combined message"
+         " and push notification payloads.\n\nThis deprecation may affect application in case if it "
+         "used\npublish API to send messages along with push notification payloads.\nProperty completely will"
+         " be deprecated with next 'major' SDK update.\n\n"];
+        
+        [deprecation appendString:@"If application's code rely on automatic messages clean up (send\nmobile "
+         "push notifications along with messages or store message\ninside payload) it is suggested to update "
+         "this code before property\nwill be completely removed from SDK.\nAt first "
+         "`shouldStripMobilePayload` should be set to NO (YES by\ndefault). Next will be update callback "
+         "which handle new messages:\n\n"
+         "\t- (void)client:(PubNub *)client didReceiveMessage:(PNMessageResult *)message {\n\n"
+         "\t\tid messageData = message.data.message;\n"
+         "\t\tif ([messageData isKindOfClass:[NSDictionary class]]) {\n\n"
+         "\t\t\t// It will be better to access cipher key directly, because 'currentConfiguration'\n"
+         "\t\t\t// make copy of PNConfiguration each time.\n"
+         "\t\t\tNSString *cipherKey = [client currentConfiguration].cipherKey;\n"
+         "\t\t\tNSMutableDictionary *messagePayload = [messageData mutableCopy];\n"
+         "\t\t\tif (cipherKey.length && messagePayload[@\"pn_other\"]) {\n\n"
+         "\t\t\t\tNSError *parseError = nil;\n"
+         "\t\t\t\tid decryptedMessageData = [PNAES decrypt:messagePayload[@\"pn_other\"] withKey:cipherKey \n"
+         "\t\t\t\t                                andError:&parseError];\n"
+         "\t\t\t\tif (decryptedMessageData) {\n\n"
+         "\t\t\t\t\tmessageData = [NSJSONSerialization JSONObjectWithData:decryptedMessageData\n"
+         "\t\t\t\t\t                                              options:NSJSONReadingAllowFragments\n"
+         "\t\t\t\t\t                                                error:&parseError];\n"
+         "\t\t\t\t}\n"
+         "\t\t\t\tif (!parseError) {\n\n"
+         "\t\t\t\t\tif (![messageData isKindOfClass:[NSDictionary class]]) {\n\n"
+         "\t\t\t\t\t\tmessagePayload[@\"pn_other\"] = messageData;\n"
+         "\t\t\t\t\t} else { [messagePayload addEntriesFromDictionary:messageData]; }\n"
+         "\t\t\t\t}\n"
+         "\t\t\t\telse { /* Handle message decryption and JSON decode. */ }\n"
+         "\t\t\t}\n"
+         "\t\t\t// Remove keys for any used push notification provider.\n"
+         "\t\t\t[messagePayload removeObjectsForKeys:@[@\"pn_apns\", @\"pn_gcm\", @\"pn_mpns\"]];\n"
+         "\t\t\tmessageData = (messagePayload[@\"pn_other\"]?: messagePayload);\n"
+         "\t\t}\n"
+         "\t\tNSLog(@\"Received message: %@\", messageData);\n"
+         "\t}\n\n\n"];
+        NSLog(@"%@", deprecation);
+    }
+}
+
 - (void)dealloc {
     
 #if TARGET_OS_IOS
diff --git a/PubNub/Data/PNConfiguration.h b/PubNub/Data/PNConfiguration.h
@@ -275,7 +275,8 @@ NS_ASSUME_NONNULL_BEGIN
  
  @since 4.5.0
  */
-@property (nonatomic, assign, getter = shouldStripMobilePayload) BOOL stripMobilePayload NS_SWIFT_NAME(stripMobilePayload);
+@property (nonatomic, assign, getter = shouldStripMobilePayload) BOOL stripMobilePayload NS_SWIFT_NAME(stripMobilePayload)
+          DEPRECATED_MSG_ATTRIBUTE("This option deprecated and will be removed in next general SDK update.");
 
 /**
  @brief  Construct configuration instance using minimal required data.
