Merge 230360 "[mac] Support adding the launcher to the Dock when..."

chrome/browser/mac/dock.mm

 // Copyright (c) 2012 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/mac/dock.h"
 
 #include <ApplicationServices/ApplicationServices.h>
 #import <Foundation/Foundation.h>
 #include <CoreFoundation/CoreFoundation.h>
 #include <signal.h>
@@ skipping 80 matching lines @@
     }
 
     NSDictionary* tile_data = [app objectForKey:kDockTileDataKey];
     if (![tile_data isKindOfClass:[NSDictionary class]]) {
       LOG(ERROR) << "tile_data not NSDictionary";
       return nil;
     }
 
     NSDictionary* file_data = [tile_data objectForKey:kDockFileDataKey];
     if (![file_data isKindOfClass:[NSDictionary class]]) {
-      LOG(ERROR) << "file_data not NSDictionary";
-      return nil;
+      // Some apps (e.g. Dashboard) have no file data, but instead have a
+      // special value for the tile-type key. For these, add an empty string to
+      // align indexes with the source array.
+      [app_paths addObject:@""];
+      continue;
     }
 
     NSURL* url = NSURLCreateFromDictionary(file_data);
     if (!url) {
       LOG(ERROR) << "no URL";
       return nil;
     }
 
     if (![url isFileURL]) {
       LOG(ERROR) << "non-file URL";
@@ skipping 20 matching lines @@
   // Sending a SIGHUP to the Dock seems to be a more reliable way to get the
   // replacement Dock process to read the newly written plist than using the
   // equivalent of "launchctl stop" (even if followed by "launchctl start.")
   // Note that this is a potential race in that pid may no longer be valid or
   // may even have been reused.
   kill(pid, SIGHUP);
 }
 
 }  // namespace
 
-void AddIcon(NSString* installed_path, NSString* dmg_app_path) {
+AddIconStatus AddIcon(NSString* installed_path, NSString* dmg_app_path) {
   // ApplicationServices.framework/Frameworks/HIServices.framework contains an
   // undocumented function, CoreDockAddFileToDock, that is able to add items
   // to the Dock "live" without requiring a Dock restart. Under the hood, it
   // communicates with the Dock via Mach IPC. It is available as of Mac OS X
   // 10.6. AddIcon could call CoreDockAddFileToDock if available, but
   // CoreDockAddFileToDock seems to always to add the new Dock icon last,
   // where AddIcon takes care to position the icon appropriately. Based on
   // disassembly, the signature of the undocumented function appears to be
   //    extern "C" OSStatus CoreDockAddFileToDock(CFURLRef url, int);
   // The int argument doesn't appear to have any effect. It's not used as the
   // position to place the icon as hoped.
 
   // There's enough potential allocation in this function to justify a
   // distinct pool.
   base::mac::ScopedNSAutoreleasePool autorelease_pool;
 
   NSString* const kDockDomain = @"com.apple.dock";
   NSUserDefaults* user_defaults = [NSUserDefaults standardUserDefaults];
 
   NSDictionary* dock_plist_const =
       [user_defaults persistentDomainForName:kDockDomain];
   if (![dock_plist_const isKindOfClass:[NSDictionary class]]) {
     LOG(ERROR) << "dock_plist_const not NSDictionary";
-    return;
+    return IconAddFailure;
   }
   NSMutableDictionary* dock_plist =
       [NSMutableDictionary dictionaryWithDictionary:dock_plist_const];
 
   NSString* const kDockPersistentAppsKey = @"persistent-apps";
   NSArray* persistent_apps_const =
       [dock_plist objectForKey:kDockPersistentAppsKey];
   if (![persistent_apps_const isKindOfClass:[NSArray class]]) {
     LOG(ERROR) << "persistent_apps_const not NSArray";
-    return;
+    return IconAddFailure;
   }
   NSMutableArray* persistent_apps =
       [NSMutableArray arrayWithArray:persistent_apps_const];
 
   NSMutableArray* persistent_app_paths = PersistentAppPaths(persistent_apps);
   if (!persistent_app_paths) {
-    return;
+    return IconAddFailure;
   }
 
   NSUInteger already_installed_app_index = NSNotFound;
   NSUInteger app_index = NSNotFound;
   for (NSUInteger index = 0; index < [persistent_apps count]; ++index) {
     NSString* app_path = [persistent_app_paths objectAtIndex:index];
     if ([app_path isEqualToString:installed_path]) {
       // If the Dock already contains a reference to the newly installed
       // application, don't add another one.
       already_installed_app_index = index;
@@ skipping 98 matching lines @@
     if (app_index == NSNotFound) {
       // Put the new application last in the Dock.
       app_index = [persistent_apps count];
     }
 
     // Set up the new Dock tile.
     NSURL* url = [NSURL fileURLWithPath:installed_path isDirectory:YES];
     NSDictionary* url_dict = NSURLCopyDictionary(url);
     if (!url_dict) {
       LOG(ERROR) << "couldn't create url_dict";
-      return;
+      return IconAddFailure;
     }
 
     NSDictionary* new_tile_data =
         [NSDictionary dictionaryWithObject:url_dict
                                     forKey:kDockFileDataKey];
     NSDictionary* new_tile =
         [NSDictionary dictionaryWithObject:new_tile_data
                                     forKey:kDockTileDataKey];
 
     // Add the new tile to the Dock.
     [persistent_apps insertObject:new_tile atIndex:app_index];
     [persistent_app_paths insertObject:installed_path atIndex:app_index];
     made_change = true;
   }
 
   // Verify that the arrays are still parallel.
   DCHECK_EQ([persistent_apps count], [persistent_app_paths count]);
 
   if (!made_change) {
     // If no changes were made, there's no point in rewriting the Dock's
     // plist or restarting the Dock.
-    return;
+    return IconAlreadyPresent;
   }
 
   // Rewrite the plist.
   [dock_plist setObject:persistent_apps forKey:kDockPersistentAppsKey];
   [user_defaults setPersistentDomain:dock_plist forName:kDockDomain];
 
   Restart();
+  return IconAddSuccess;
 }
 
 }  // namespace dock