adding adNetwork SDKs for AdWhirl and AdMob

2011-12-15 11:18:37 +00:00
parent dc7d52c48c
commit 9c10f47daa
160 changed files with 23482 additions and 0 deletions
@@ -0,0 +1,562 @@
+/*
+
+ AdWhirlConfig.m
+
+ Copyright 2009 AdMob, Inc.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+*/
+
+#import <CommonCrypto/CommonDigest.h>
+
+#import "AdWhirlConfig.h"
+#import "AdWhirlError.h"
+#import "AdWhirlAdNetworkConfig.h"
+#import "AdWhirlLog.h"
+#import "AdWhirlView.h"
+#import "AdWhirlAdNetworkAdapter.h"
+#import "AdWhirlAdNetworkRegistry.h"
+#import "UIColor+AdWhirlConfig.h"
+#import "AWNetworkReachabilityWrapper.h"
+
+
+BOOL awIntVal(NSInteger *var, id val) {
+  if ([val isKindOfClass:[NSNumber class]] || [val isKindOfClass:[NSString class]]) {
+    *var = [val integerValue];
+    return YES;
+  }
+  return NO;
+}
+
+BOOL awFloatVal(CGFloat *var, id val) {
+  if ([val isKindOfClass:[NSNumber class]] || [val isKindOfClass:[NSString class]]) {
+    *var = [val floatValue];
+    return YES;
+  }
+  return NO;
+}
+
+BOOL awDoubleVal(double *var, id val) {
+  if ([val isKindOfClass:[NSNumber class]] || [val isKindOfClass:[NSString class]]) {
+    *var = [val doubleValue];
+    return YES;
+  }
+  return NO;
+}
+
+
+@implementation AdWhirlConfig
+
+@synthesize appKey;
+@synthesize configURL;
+@synthesize adsAreOff;
+@synthesize adNetworkConfigs;
+@synthesize backgroundColor;
+@synthesize textColor;
+@synthesize refreshInterval;
+@synthesize locationOn;
+@synthesize bannerAnimationType;
+@synthesize fullscreenWaitInterval;
+@synthesize fullscreenMaxAds;
+@synthesize hasConfig;
+
+@synthesize adNetworkRegistry;
+
+#pragma mark -
+
+- (id)initWithAppKey:(NSString *)ak delegate:(id<AdWhirlConfigDelegate>)delegate {
+  self = [super init];
+  if (self != nil) {
+    appKey = [[NSString alloc] initWithString:ak];
+    legacy = NO;
+    adNetworkConfigs = [[NSMutableArray alloc] init];
+    delegates = [[NSMutableArray alloc] init];
+    hasConfig = NO;
+    [self addDelegate:delegate];
+
+    // object dependencies
+    adNetworkRegistry = [AdWhirlAdNetworkRegistry sharedRegistry];
+
+    // default values
+    backgroundColor = [[UIColor alloc] initWithRed:0.3 green:0.3 blue:0.3 alpha:1.0];
+    textColor = [[UIColor whiteColor] retain];
+    refreshInterval = 60;
+    locationOn = YES;
+    bannerAnimationType = AWBannerAnimationTypeRandom;
+    fullscreenWaitInterval = 60;
+    fullscreenMaxAds = 2;
+
+    // config URL
+    NSURL *configBaseURL = nil;
+    if ([delegate respondsToSelector:@selector(adWhirlConfigURL)]) {
+      configBaseURL = [delegate adWhirlConfigURL];
+    }
+    if (configBaseURL == nil) {
+      configBaseURL = [NSURL URLWithString:kAdWhirlDefaultConfigURL];
+    }
+    configURL = [[NSURL alloc] initWithString:[NSString stringWithFormat:@"?appid=%@&appver=%d&client=1",
+                                               appKey,
+                                               kAdWhirlAppVer]
+                                relativeToURL:configBaseURL];
+  }
+  return self;
+}
+
+- (BOOL)addDelegate:(id<AdWhirlConfigDelegate>)delegate {
+  for (NSValue *w in delegates) {
+    id<AdWhirlConfigDelegate> existing = [w nonretainedObjectValue];
+    if (existing == delegate) {
+      return NO; // already in the list of delegates
+    }
+  }
+  NSValue *wrapped = [NSValue valueWithNonretainedObject:delegate];
+  [delegates addObject:wrapped];
+  return YES;
+}
+
+- (BOOL)removeDelegate:(id<AdWhirlConfigDelegate>)delegate {
+  NSUInteger i;
+  for (i = 0; i < [delegates count]; i++) {
+    NSValue *w = [delegates objectAtIndex:i];
+    id<AdWhirlConfigDelegate> existing = [w nonretainedObjectValue];
+    if (existing == delegate) {
+      break;
+    }
+  }
+  if (i < [delegates count]) {
+    [delegates removeObjectAtIndex:i];
+    return YES;
+  }
+  return NO;
+}
+
+- (void)notifyDelegatesOfFailure:(NSError *)error {
+  for (NSValue *wrapped in delegates) {
+    id<AdWhirlConfigDelegate> delegate = [wrapped nonretainedObjectValue];
+    if ([delegate respondsToSelector:@selector(adWhirlConfigDidFail:error:)]) {
+      [delegate adWhirlConfigDidFail:self error:error];
+    }
+  }
+}
+
+- (NSString *)description {
+  NSString *desc = [super description];
+  NSString *configs = [NSString stringWithFormat:
+                       @"location_access:%d fg_color:%@ bg_color:%@ cycle_time:%lf transition:%d",
+                       locationOn, textColor, backgroundColor, refreshInterval, bannerAnimationType];
+  return [NSString stringWithFormat:@"%@:\n%@ networks:%@",desc,configs,adNetworkConfigs];
+}
+
+- (void)dealloc {
+  [appKey release], appKey = nil;
+  [configURL release], configURL = nil;
+  [adNetworkConfigs release], adNetworkConfigs = nil;
+  [backgroundColor release], backgroundColor = nil;
+  [textColor release], textColor = nil;
+  [delegates release], delegates = nil;
+  [super dealloc];
+}
+
+#pragma mark parsing methods
+
+- (BOOL)parseExtraConfig:(NSDictionary *)configDict error:(NSError **)error {
+  id bgColor = [configDict objectForKey:@"background_color_rgb"];
+  if (bgColor != nil && [bgColor isKindOfClass:[NSDictionary class]]) {
+    [backgroundColor release];
+    backgroundColor = [[UIColor alloc] initWithDict:(NSDictionary *)bgColor];
+  }
+  id txtColor = [configDict objectForKey:@"text_color_rgb"];
+  if (txtColor != nil && [txtColor isKindOfClass:[NSDictionary class]]) {
+    [textColor release];
+    textColor = [[UIColor alloc] initWithDict:txtColor];
+  }
+  id tempVal;
+  tempVal = [configDict objectForKey:@"refresh_interval"];
+  if (tempVal == nil)
+    tempVal = [configDict objectForKey:@"cycle_time"];
+  NSInteger tempInt;
+  if (tempVal && awIntVal(&tempInt, tempVal)) {
+    refreshInterval = (NSTimeInterval)tempInt;
+    if (refreshInterval >= 30000.0) {
+      // effectively forever, set to 0
+      refreshInterval = 0.0;
+    }
+  }
+  if (awIntVal(&tempInt, [configDict objectForKey:@"location_on"])) {
+    locationOn = (tempInt == 0)? NO : YES;
+    // check user preference. user preference of NO trumps all
+	  
+    BOOL bLocationServiceEnabled = NO;
+    if ([CLLocationManager respondsToSelector:
+                                          @selector(locationServicesEnabled)]) {
+      bLocationServiceEnabled = [CLLocationManager locationServicesEnabled];
+    }
+    else {
+      CLLocationManager* locMan = [[CLLocationManager alloc] init];
+      bLocationServiceEnabled = locMan.locationServicesEnabled;
+      [locMan release], locMan = nil;
+    }
+
+    if (locationOn == YES && bLocationServiceEnabled == NO) {
+      AWLogDebug(@"User disabled location services, set locationOn to NO");
+      locationOn = NO;
+    }
+  }
+  tempVal = [configDict objectForKey:@"transition"];
+  if (tempVal == nil)
+    tempVal = [configDict objectForKey:@"banner_animation_type"];
+  if (tempVal && awIntVal(&tempInt, tempVal)) {
+    switch (tempInt) {
+      case 0: bannerAnimationType = AWBannerAnimationTypeNone; break;
+      case 1: bannerAnimationType = AWBannerAnimationTypeFlipFromLeft; break;
+      case 2: bannerAnimationType = AWBannerAnimationTypeFlipFromRight; break;
+      case 3: bannerAnimationType = AWBannerAnimationTypeCurlUp; break;
+      case 4: bannerAnimationType = AWBannerAnimationTypeCurlDown; break;
+      case 5: bannerAnimationType = AWBannerAnimationTypeSlideFromLeft; break;
+      case 6: bannerAnimationType = AWBannerAnimationTypeSlideFromRight; break;
+      case 7: bannerAnimationType = AWBannerAnimationTypeFadeIn; break;
+      case 8: bannerAnimationType = AWBannerAnimationTypeRandom; break;
+    }
+  }
+  if (awIntVal(&tempInt, [configDict objectForKey:@"fullscreen_wait_interval"])) {
+    fullscreenWaitInterval = tempInt;
+  }
+  if (awIntVal(&tempInt, [configDict objectForKey:@"fullscreen_max_ads"])) {
+    fullscreenMaxAds = tempInt;
+  }
+  return YES;
+}
+
+- (BOOL)parseLegacyConfig:(NSArray *)configArray error:(NSError **)error {
+  NSMutableDictionary *adNetConfigDicts = [[NSMutableDictionary alloc] init];
+  for (int i = 0; i < [configArray count]; i++) {
+    id configObj = [configArray objectAtIndex:i];
+    if (![configObj isKindOfClass:[NSDictionary class]]) {
+      if (error != NULL)
+        *error = [AdWhirlError errorWithCode:AdWhirlConfigDataError
+                                 description:@"Expected dictionary in config data"];
+      [adNetConfigDicts release];
+      return NO;
+    }
+    NSDictionary *configDict = (NSDictionary *)configObj;
+    switch (i) {
+      case 0:
+        // ration map
+      case 1:
+        // key map
+      case 2:
+        // priority map
+        for (id key in [configDict keyEnumerator]) {
+          // format: "<network name>_<value name>" e.g. "admob_ration"
+          NSString *strKey = (NSString *)key;
+          if ([strKey compare:@"empty_ration"] == NSOrderedSame) {
+            NSInteger empty_ration;
+            if (awIntVal(&empty_ration, [configDict objectForKey:key]) && empty_ration == 100) {
+              adsAreOff = YES;
+              [adNetConfigDicts release];
+              return YES;
+            }
+          }
+          adsAreOff = NO;
+          NSRange underScorePos = [strKey rangeOfString:@"_" options:NSBackwardsSearch];
+          if (underScorePos.location == NSNotFound) {
+            if (error != NULL)
+              *error = [AdWhirlError errorWithCode:AdWhirlConfigDataError
+                                       description:[NSString stringWithFormat:
+                                                    @"Expected underscore delimiter in key '%@'", strKey]];
+            [adNetConfigDicts release];
+            return NO;
+          }
+          NSString *networkName = [strKey substringToIndex:underScorePos.location];
+          NSString *valueName = [strKey substringFromIndex:(underScorePos.location+1)];
+          if ([networkName length] == 0) {
+            if (error != NULL)
+              *error = [AdWhirlError errorWithCode:AdWhirlConfigDataError
+                                       description:[NSString stringWithFormat:
+                                                    @"Empty ad network name in key '%@'", strKey]];
+            [adNetConfigDicts release];
+            return NO;
+          }
+          if ([valueName length] == 0) {
+            if (error != NULL)
+              *error = [AdWhirlError errorWithCode:AdWhirlConfigDataError
+                                       description:[NSString stringWithFormat:
+                                                    @"Empty value name in key '%@'", strKey]];
+            [adNetConfigDicts release];
+            return NO;
+          }
+          if ([networkName compare:@"dontcare"] == NSOrderedSame) {
+            continue;
+          }
+          NSMutableDictionary *adNetConfigDict = [adNetConfigDicts objectForKey:networkName];
+          if (adNetConfigDict == nil) {
+            adNetConfigDict = [[NSMutableDictionary alloc] init];
+            [adNetConfigDicts setObject:adNetConfigDict forKey:networkName];
+            [adNetConfigDict release];
+            adNetConfigDict = [adNetConfigDicts objectForKey:networkName];
+          }
+          NSString *properValueName;
+          if ([valueName compare:@"ration"] == NSOrderedSame) {
+            properValueName = AWAdNetworkConfigKeyWeight;
+          }
+          else if ([valueName compare:@"key"] == NSOrderedSame) {
+            properValueName = AWAdNetworkConfigKeyCred;
+          }
+          else if ([valueName compare:@"priority"] == NSOrderedSame) {
+            properValueName = AWAdNetworkConfigKeyPriority;
+          }
+          else {
+            properValueName = valueName;
+          }
+          [adNetConfigDict setObject:[configDict objectForKey:key]
+                              forKey:properValueName];
+        }
+        break; // ad network config maps
+
+      case 3:
+        // general config map
+        if (![self parseExtraConfig:configDict error:error]) {
+          return NO;
+        }
+        break; // general config map
+      default:
+        AWLogWarn(@"Ignoring element at index %d in legacy config", i);
+        break;
+    } // switch (i)
+  } // loop configArray
+
+  // adwhirl_ special handling
+  NSMutableDictionary *adRolloConfig = [adNetConfigDicts objectForKey:@"adrollo"];
+  if (adRolloConfig != nil) {
+    AWLogDebug(@"Processing AdRollo config %@", adRolloConfig);
+    NSMutableArray *adWhirlNetworkConfigs = [[NSMutableArray alloc] init];;
+    for (NSString *netname in [adNetConfigDicts keyEnumerator]) {
+      if (![netname hasPrefix:@"adwhirl_"]) continue;
+      [adWhirlNetworkConfigs addObject:[adNetConfigDicts objectForKey:netname]];
+    }
+    if ([adWhirlNetworkConfigs count] > 0) {
+      // split the ration evenly, use same credentials
+      NSInteger ration = [[adRolloConfig objectForKey:AWAdNetworkConfigKeyWeight] integerValue];
+      ration = ration/[adWhirlNetworkConfigs count];
+      for (NSMutableDictionary *cd in adWhirlNetworkConfigs) {
+        [cd setObject:[NSNumber numberWithInteger:ration]
+               forKey:AWAdNetworkConfigKeyWeight];
+        [cd setObject:[adRolloConfig objectForKey:AWAdNetworkConfigKeyCred]
+               forKey:AWAdNetworkConfigKeyCred];
+      }
+    }
+    [adWhirlNetworkConfigs release];
+  }
+
+  NSInteger totalWeight = 0;
+  for (id networkName in [adNetConfigDicts keyEnumerator]) {
+    NSString *netname = (NSString *)networkName;
+    if ([netname compare:@"adrollo"] == NSOrderedSame) {
+      // skip adrollo, was used for "adwhirl_" networks
+      continue;
+    }
+    NSMutableDictionary *adNetConfigDict = [adNetConfigDicts objectForKey:netname];
+
+    // set network type for legacy
+    NSInteger networkType = 0;
+    if ([netname compare:@"admob"] == NSOrderedSame) {
+      networkType = AdWhirlAdNetworkTypeAdMob;
+    }
+    else if ([netname compare:@"jumptap"] == NSOrderedSame) {
+      networkType = AdWhirlAdNetworkTypeJumpTap;
+    }
+    else if ([netname compare:@"videoegg"] == NSOrderedSame) {
+      networkType = AdWhirlAdNetworkTypeVideoEgg;
+    }
+    else if ([netname compare:@"medialets"] == NSOrderedSame) {
+      networkType = AdWhirlAdNetworkTypeMedialets;
+    }
+    else if ([netname compare:@"liverail"] == NSOrderedSame) {
+      networkType = AdWhirlAdNetworkTypeLiveRail;
+    }
+    else if ([netname compare:@"millennial"] == NSOrderedSame) {
+      networkType = AdWhirlAdNetworkTypeMillennial;
+    }
+    else if ([netname compare:@"greystripe"] == NSOrderedSame) {
+      networkType = AdWhirlAdNetworkTypeGreyStripe;
+    }
+    else if ([netname compare:@"quattro"] == NSOrderedSame) {
+      networkType = AdWhirlAdNetworkTypeQuattro;
+    }
+    else if ([netname compare:@"custom"] == NSOrderedSame) {
+      networkType = AdWhirlAdNetworkTypeCustom;
+    }
+    else if ([netname compare:@"adwhirl_10"] == NSOrderedSame) {
+      networkType = AdWhirlAdNetworkTypeAdWhirl10;
+    }
+    else if ([netname compare:@"mobclix"] == NSOrderedSame) {
+      networkType = AdWhirlAdNetworkTypeMobClix;
+    }
+    else if ([netname compare:@"adwhirl_12"] == NSOrderedSame) {
+      networkType = AdWhirlAdNetworkTypeMdotM;
+    }
+    else if ([netname compare:@"adwhirl_13"] == NSOrderedSame) {
+      networkType = AdWhirlAdNetworkTypeAdWhirl13;
+    }
+    else if ([netname compare:@"google_adsense"] == NSOrderedSame) {
+      networkType = AdWhirlAdNetworkTypeGoogleAdSense;
+    }
+    else if ([netname compare:@"google_doubleclick"] == NSOrderedSame) {
+      networkType = AdWhirlAdNetworkTypeGoogleDoubleClick;
+    }
+    else if ([netname compare:@"generic"] == NSOrderedSame) {
+      networkType = AdWhirlAdNetworkTypeGeneric;
+    }
+    else if ([netname compare:@"inmobi"] == NSOrderedSame) {
+      networkType = AdWhirlAdNetworkTypeInMobi;
+    }
+
+    else {
+      AWLogWarn(@"Unrecognized ad network '%@' in legacy config, ignored", netname);
+      continue;
+    }
+
+    [adNetConfigDict setObject:netname forKey:AWAdNetworkConfigKeyName];
+    [adNetConfigDict setObject:[NSString stringWithFormat:@"%d", networkType]
+                        forKey:AWAdNetworkConfigKeyNID];
+    [adNetConfigDict setObject:[NSNumber numberWithInteger:networkType]
+                        forKey:AWAdNetworkConfigKeyType];
+
+    AdWhirlError *adNetConfigError = nil;
+    AdWhirlAdNetworkConfig *adNetConfig =
+      [[AdWhirlAdNetworkConfig alloc] initWithDictionary:adNetConfigDict
+                                       adNetworkRegistry:adNetworkRegistry
+                                                   error:&adNetConfigError];
+    if (adNetConfig != nil) {
+      [adNetworkConfigs addObject:adNetConfig];
+      totalWeight += adNetConfig.trafficPercentage;
+      [adNetConfig release];
+    }
+    else {
+      AWLogWarn(@"Cannot create ad network config from %@: %@", adNetConfigDict,
+                adNetConfigError != nil? [adNetConfigError localizedDescription]:@"");
+    }
+  } // for each ad network name
+
+  if (totalWeight == 0) {
+    adsAreOff = YES;
+  }
+
+  [adNetConfigDicts release];
+  return YES;
+}
+
+- (BOOL)parseNewConfig:(NSDictionary *)configDict error:(NSError **)error {
+  id extra = [configDict objectForKey:@"extra"];
+  if (extra != nil && [extra isKindOfClass:[NSDictionary class]]) {
+    NSDictionary *extraDict = extra;
+    if (![self parseExtraConfig:extraDict error:error]) {
+      return NO;
+    }
+  }
+  else {
+    AWLogWarn(@"No extra info dict in ad network config");
+  }
+
+  id rations = [configDict objectForKey:@"rations"];
+  double totalWeight = 0.0;
+  if (rations != nil && [rations isKindOfClass:[NSArray class]]) {
+    if ([(NSArray *)rations count] == 0) {
+      adsAreOff = YES;
+      return YES;
+    }
+    adsAreOff = NO;
+    for (id c in (NSArray *)rations) {
+      if (![c isKindOfClass:[NSDictionary class]]) {
+        AWLogWarn(@"Element in rations array is not a dictionary %@ in ad network config",c);
+        continue;
+      }
+      AdWhirlError *adNetConfigError = nil;
+      AdWhirlAdNetworkConfig *adNetConfig =
+        [[AdWhirlAdNetworkConfig alloc] initWithDictionary:(NSDictionary *)c
+                                         adNetworkRegistry:adNetworkRegistry
+                                                     error:&adNetConfigError];
+      if (adNetConfig != nil) {
+        [adNetworkConfigs addObject:adNetConfig];
+        totalWeight += adNetConfig.trafficPercentage;
+        [adNetConfig release];
+      }
+      else {
+        AWLogWarn(@"Cannot create ad network config from %@: %@", c,
+                  adNetConfigError != nil? [adNetConfigError localizedDescription]:@"");
+      }
+    }
+  }
+  else {
+    AWLogError(@"No rations array in ad network config");
+  }
+
+  if (totalWeight == 0.0) {
+    adsAreOff = YES;
+  }
+
+  return YES;
+}
+
+- (BOOL)parseConfig:(NSData *)data error:(NSError **)error {
+  if (hasConfig) {
+    if (error != NULL)
+      *error = [AdWhirlError errorWithCode:AdWhirlConfigDataError
+                               description:@"Already has config, will not parse"];
+    return NO;
+  }
+  NSError *jsonError = nil;
+  id parsed = [[CJSONDeserializer deserializer] deserialize:data error:&jsonError];
+  if (parsed == nil) {
+    if (error != NULL)
+      *error = [AdWhirlError errorWithCode:AdWhirlConfigParseError
+                               description:@"Error parsing config JSON from server"
+                           underlyingError:jsonError];
+    return NO;
+  }
+  if ([parsed isKindOfClass:[NSArray class]]) {
+    // pre-open-source AdWhirl/AdRollo config
+    legacy = YES;
+    if (![self parseLegacyConfig:(NSArray *)parsed error:error]) {
+      return NO;
+    }
+  }
+  else if ([parsed isKindOfClass:[NSDictionary class]]) {
+    // open-source AdWhirl config
+    if (![self parseNewConfig:(NSDictionary *)parsed error:error]) {
+      return NO;
+    }
+  }
+  else {
+    if (error != NULL)
+      *error = [AdWhirlError errorWithCode:AdWhirlConfigDataError
+                               description:@"Expected top-level dictionary in config data"];
+    return NO;
+  }
+
+  // parse success
+  hasConfig = YES;
+
+  // notify delegates of success
+  for (NSValue *wrapped in delegates) {
+    id<AdWhirlConfigDelegate> delegate = [wrapped nonretainedObjectValue];
+    if ([delegate respondsToSelector:@selector(adWhirlConfigDidReceiveConfig:)]) {
+      [delegate adWhirlConfigDidReceiveConfig:self];
+    }
+  }
+
+  return YES;
+}
+
+@end