Adapt Chrome to use KeystoneRegistration 1.0.7.1306

chrome/browser/cocoa/keystone_glue.mm

 // Copyright (c) 2009 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #import "chrome/browser/cocoa/keystone_glue.h"
 
 #include <sys/param.h>
 #include <sys/mount.h>
 
 #include <vector>
@@ skipping 14 matching lines @@
 typedef enum {
   kKSPathExistenceChecker,
 } KSExistenceCheckerType;
 
 typedef enum {
   kKSRegistrationUserTicket,
   kKSRegistrationSystemTicket,
   kKSRegistrationDontKnowWhatKindOfTicket,
 } KSRegistrationTicketType;
 
+NSString* KSRegistrationVersionKey = @"Version";
+NSString* KSRegistrationExistenceCheckerTypeKey = @"ExistenceCheckerType";
+NSString* KSRegistrationExistenceCheckerStringKey = @"ExistenceCheckerString";
+NSString* KSRegistrationServerURLStringKey = @"URLString";
+NSString* KSRegistrationPreserveTrustedTesterTokenKey = @"PreserveTTT";
+NSString* KSRegistrationTagKey = @"Tag";
+NSString* KSRegistrationTagPathKey = @"TagPath";
+NSString* KSRegistrationTagKeyKey = @"TagKey";
+
 NSString *KSRegistrationDidCompleteNotification =
     @"KSRegistrationDidCompleteNotification";
 NSString *KSRegistrationPromotionDidCompleteNotification =
     @"KSRegistrationPromotionDidCompleteNotification";
 
 NSString *KSRegistrationCheckForUpdateNotification =
     @"KSRegistrationCheckForUpdateNotification";
 NSString *KSRegistrationStatusKey = @"Status";
-NSString *KSRegistrationVersionKey = @"Version";
 NSString *KSRegistrationUpdateCheckErrorKey = @"Error";
 
 NSString *KSRegistrationStartUpdateNotification =
     @"KSRegistrationStartUpdateNotification";
 NSString *KSUpdateCheckSuccessfulKey = @"CheckSuccessful";
 NSString *KSUpdateCheckSuccessfullyInstalledKey = @"SuccessfullyInstalled";
 
 NSString *KSRegistrationRemoveExistingTag = @"";
 #define KSRegistrationPreserveExistingTag nil
 
 }  // namespace
 
 @interface KSRegistration : NSObject
 
 + (id)registrationWithProductID:(NSString*)productID;
 
-- (BOOL)registerWithVersion:(NSString*)version
-       existenceCheckerType:(KSExistenceCheckerType)xctype
-     existenceCheckerString:(NSString*)xc
-            serverURLString:(NSString*)serverURLString
-            preserveTTToken:(BOOL)preserveToken
-                        tag:(NSString*)tag;
+- (BOOL)registerWithParameters:(NSDictionary*)args;
 
-- (BOOL)promoteWithVersion:(NSString*)version
-      existenceCheckerType:(KSExistenceCheckerType)xctype
-    existenceCheckerString:(NSString*)xc
-           serverURLString:(NSString*)serverURLString
-           preserveTTToken:(BOOL)preserveToken
-                       tag:(NSString*)tag
-             authorization:(AuthorizationRef)authorization;
+- (BOOL)promoteWithParameters:(NSDictionary*)args
+                authorization:(AuthorizationRef)authorization;
 
 - (void)setActive;
 - (void)checkForUpdate;
 - (void)startUpdate;
 - (KSRegistrationTicketType)ticketType;
 
 @end  // @interface KSRegistration
 
 @interface KeystoneGlue(Private)
 
+// Returns the path to the application's Info.plist file.  This returns the
+// outer application bundle's Info.plist, not the framework's Info.plist.
+- (NSString*)appInfoPlistPath;
+
+// Returns a dictionary containing parameters to be used for a KSRegistration
+// -registerWithParameters: or -promoteWithParameters:authorization: call.
+- (NSDictionary*)keystoneParameters;
+
 // Called when Keystone registration completes.
 - (void)registrationComplete:(NSNotification*)notification;
 
 // Called periodically to announce activity by pinging the Keystone server.
 - (void)markActive:(NSTimer*)timer;
 
 // Called when an update check or update installation is complete.  Posts the
 // kAutoupdateStatusNotification notification to the default notification
 // center.
 - (void)updateStatus:(AutoupdateStatus)status version:(NSString*)version;
@@ skipping 44 matching lines @@
 - (void)changePermissionsForPromotionWithTool:(NSString*)toolPath;
 - (void)changePermissionsForPromotionComplete;
 
 @end  // @interface KeystoneGlue(Private)
 
 const NSString* const kAutoupdateStatusNotification =
     @"AutoupdateStatusNotification";
 const NSString* const kAutoupdateStatusStatus = @"status";
 const NSString* const kAutoupdateStatusVersion = @"version";
 
+namespace {
+
+const NSString* const kChannelKey = @"KSChannelID";
+
+}  // namespace
+
 @implementation KeystoneGlue
 
 + (id)defaultKeystoneGlue {
   static bool sTriedCreatingDefaultKeystoneGlue = false;
   // TODO(jrg): use base::SingletonObjC<KeystoneGlue>
   static KeystoneGlue* sDefaultKeystoneGlue = nil;  // leaked
 
   if (!sTriedCreatingDefaultKeystoneGlue) {
     sTriedCreatingDefaultKeystoneGlue = true;
 
@@ skipping 68 matching lines @@
 
   NSString* appPath = [appBundle bundlePath];
   NSString* url = [infoDictionary objectForKey:@"KSUpdateURL"];
   NSString* version = [infoDictionary objectForKey:@"KSVersion"];
 
   if (!productID || !appPath || !url || !version) {
     // If parameters required for Keystone are missing, don't use it.
     return;
   }
 
-  NSString* channel = [infoDictionary objectForKey:@"KSChannelID"];
+  NSString* channel = [infoDictionary objectForKey:kChannelKey];
   // The stable channel has no tag.  If updating to stable, remove the
   // dev and beta tags since we've been "promoted".
   if (channel == nil)
     channel = KSRegistrationRemoveExistingTag;
 
   productID_ = [productID retain];
   appPath_ = [appPath retain];
   url_ = [url retain];
   version_ = [version retain];
   channel_ = [channel retain];
@@ skipping 14 matching lines @@
   // Harness the KSRegistration class.
   Class ksrClass = [ksrBundle classNamed:@"KSRegistration"];
   KSRegistration* ksr = [ksrClass registrationWithProductID:productID_];
   if (!ksr)
     return NO;
 
   registration_ = [ksr retain];
   return YES;
 }
 
+- (NSString*)appInfoPlistPath {
+  // NSBundle ought to have a way to access this path directly, but it
+  // doesn't.
+  return [[appPath_ stringByAppendingPathComponent:@"Contents"]
+             stringByAppendingPathComponent:@"Info.plist"];
+}
+
+- (NSDictionary*)keystoneParameters {
+  NSNumber* xcType = [NSNumber numberWithInt:kKSPathExistenceChecker];
+  NSNumber* preserveTTToken = [NSNumber numberWithBool:YES];
+  NSString* tagPath = [self appInfoPlistPath];
+
+  return [NSDictionary dictionaryWithObjectsAndKeys:
+             version_, KSRegistrationVersionKey,
+             xcType, KSRegistrationExistenceCheckerTypeKey,
+             appPath_, KSRegistrationExistenceCheckerStringKey,
+             url_, KSRegistrationServerURLStringKey,
+             preserveTTToken, KSRegistrationPreserveTrustedTesterTokenKey,
+             channel_, KSRegistrationTagKey,
+             tagPath, KSRegistrationTagPathKey,
+             kChannelKey, KSRegistrationTagKeyKey,
+             nil];
+}
+
 - (void)registerWithKeystone {
   [self updateStatus:kAutoupdateRegistering version:nil];
 
-  if (![registration_ registerWithVersion:version_
-                     existenceCheckerType:kKSPathExistenceChecker
-                   existenceCheckerString:appPath_
-                          serverURLString:url_
-                          preserveTTToken:YES
-                                      tag:channel_]) {
+  NSDictionary* parameters = [self keystoneParameters];
+  if (![registration_ registerWithParameters:parameters]) {
     [self updateStatus:kAutoupdateRegisterFailed version:nil];
     return;
   }
 
   // Upon completion, KSRegistrationDidCompleteNotification will be posted,
   // and -registrationComplete: will be called.
 
   // Mark an active RIGHT NOW; don't wait an hour for the first one.
   [registration_ setActive];
 
@@ skipping 101 matching lines @@
                                               object:nil] autorelease];
 
   NSOperationQueue* operationQueue = [WorkerPoolObjC sharedOperationQueue];
   [operationQueue addOperation:operation];
 }
 
 // Runs on a thread managed by NSOperationQueue.
 - (void)determineUpdateStatus {
   DCHECK(![NSThread isMainThread]);
 
-  NSString* appInfoPlistPath =
-      [[appPath_ stringByAppendingPathComponent:@"Contents"]
-          stringByAppendingPathComponent:@"Info.plist"];
+  NSString* appInfoPlistPath = [self appInfoPlistPath];
   NSDictionary* infoPlist =
       [NSDictionary dictionaryWithContentsOfFile:appInfoPlistPath];
   NSString* version = [infoPlist objectForKey:@"CFBundleShortVersionString"];
 
   [self performSelectorOnMainThread:@selector(determineUpdateStatusForVersion:)
                          withObject:version
                       waitUntilDone:NO];
 }
 
 // Runs on the main thread.
@@ skipping 188 matching lines @@
 
   // TODO(mark): Remove when able!
   //
   // keystone_promote_preflight is hopefully temporary.  It's here to ensure
   // that the Keystone system ticket store is in a usable state for all users
   // on the system.  Ideally, Keystone's installer or another part of Keystone
   // would handle this.  The underlying problem is http://b/2285921, and it
   // causes http://b/2289908, which this workaround addresses.
   //
   // This is run synchronously, which isn't optimal, but
-  // -[KSRegistration promoteWithVersion:...] is currently synchronous too,
-  // and this operation needs to happen before that one.
+  // -[KSRegistration promoteWithParameters:authorization:] is currently
+  // synchronous too, and this operation needs to happen before that one.
   //
   // TODO(mark): Make asynchronous.  That only makes sense if the promotion
   // operation itself is asynchronous too.  http://b/2290009.  Hopefully,
   // the Keystone promotion code will just be changed to do what preflight
   // now does, and then the preflight script can be removed instead.
   NSString* preflightPath =
       [mac_util::MainAppBundle() pathForResource:@"keystone_promote_preflight"
                                           ofType:@"sh"];
   const char* preflightPathC = [preflightPath fileSystemRepresentation];
   const char* arguments[] = {NULL};
@@ skipping 16 matching lines @@
     [self updateStatus:kAutoupdatePromoteFailed version:nil];
     return;
   }
 
   // Hang on to the AuthorizationRef so that it can be used once promotion is
   // complete.  Do this before asking Keystone to promote the ticket, because
   // -promotionComplete: may be called from inside the Keystone promotion
   // call.
   authorization_.swap(authorization);
 
-  if (![registration_ promoteWithVersion:version_
-                    existenceCheckerType:kKSPathExistenceChecker
-                  existenceCheckerString:appPath_
-                         serverURLString:url_
-                         preserveTTToken:YES
-                                     tag:channel_
-                           authorization:authorization_]) {
+  NSDictionary* parameters = [self keystoneParameters];
+  if (![registration_ promoteWithParameters:parameters
+                              authorization:authorization_]) {
     [self updateStatus:kAutoupdatePromoteFailed version:nil];
     authorization_.reset();
     return;
   }
 
   // Upon completion, KSRegistrationPromotionDidCompleteNotification will be
   // posted, and -promotionComplete: will be called.
 }
 
 - (void)promotionComplete:(NSNotification*)notification {
@@ skipping 52 matching lines @@
                       waitUntilDone:NO];
 }
 
 - (void)changePermissionsForPromotionComplete {
   authorization_.reset();
 
   [self updateStatus:kAutoupdatePromoted version:nil];
 }
 
 @end  // @implementation KeystoneGlue