Make web_app::ShortcutInfo RefCountedThreadSafe (1)

chrome/browser/web_applications/web_app.h

 // 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.
 
 #ifndef CHROME_BROWSER_WEB_APPLICATIONS_WEB_APP_H_
 #define CHROME_BROWSER_WEB_APPLICATIONS_WEB_APP_H_
 
 #include <memory>
 #include <string>
 #include <vector>
 
 #include "base/callback.h"
 #include "base/files/file_path.h"
 #include "base/macros.h"
+#include "base/memory/ref_counted.h"
+#include "base/sequenced_task_runner_helpers.h"
 #include "base/strings/string16.h"
 #include "build/build_config.h"
 #include "chrome/browser/shell_integration.h"
 #include "chrome/common/web_application_info.h"
+#include "content/public/browser/browser_thread.h"
 
 class Profile;
 
 namespace content {
 class WebContents;
 }
 
 namespace extensions {
 class Extension;
 }
 
 namespace gfx {
 class ImageFamily;
 }
 
 // This namespace contains everything related to integrating Chrome apps into
 // the OS. E.g. creating and updating shorcuts for apps, setting up file
 // associations, etc.
 namespace web_app {
 
 // Represents the info required to create a shortcut for an app.
-struct ShortcutInfo {
+// ShortcutInfo is passed around via scoped_refptrs, and is destroyed on UI
+// thread. Since gfx::ImageFamily can have gfx::Image and it has ImageStorage
+// which has a non-thread-safe ref count bound to UI thread, all ref count
+// manipulation must happen on UI thread.
+struct ShortcutInfo : public base::RefCountedThreadSafe<
+                          ShortcutInfo,
+                          content::BrowserThread::DeleteOnUIThread> {
   ShortcutInfo();
-  ~ShortcutInfo();
 
   GURL url;
   // If |extension_id| is non-empty, this is short cut is to an extension-app
   // and the launch url will be detected at start-up. In this case, |url|
   // is still used to generate the app id (windows app id, not chrome app id).
   std::string extension_id;
   bool is_platform_app = false;
   bool from_bookmark = false;
   base::string16 title;
   base::string16 description;
   base::FilePath extension_path;
   gfx::ImageFamily favicon;
   base::FilePath profile_path;
   std::string profile_name;
   std::string version_for_display;
 
  private:
-  // ShortcutInfo must not be copied; generally it is passed around via
-  // scoped_ptrs. This is to allow passing ShortcutInfos between threads,
-  // despite ImageFamily having a non-thread-safe reference count.
+  friend struct content::BrowserThread::DeleteOnThread<
+      content::BrowserThread::UI>;
+  friend class base::DeleteHelper<ShortcutInfo>;
+  ~ShortcutInfo();
+
   DISALLOW_COPY_AND_ASSIGN(ShortcutInfo);
 };
 
 // This specifies a folder in the system applications menu (e.g the Start Menu
 // on Windows).
 //
 // These represent the applications menu root, the "Google Chrome" folder and
 // the "Chrome Apps" folder respectively.
 //
 // APP_MENU_LOCATION_HIDDEN specifies a shortcut that is used to register the
@@ skipping 26 matching lines @@
 };
 
 // This encodes the cause of shortcut creation as the correct behavior in each
 // case is implementation specific.
 enum ShortcutCreationReason {
   SHORTCUT_CREATION_BY_USER,
   SHORTCUT_CREATION_AUTOMATED,
 };
 
 // Called by GetShortcutInfoForApp after fetching the ShortcutInfo.
-typedef base::Callback<void(std::unique_ptr<ShortcutInfo>)>
-    ShortcutInfoCallback;
+typedef base::Callback<void(scoped_refptr<ShortcutInfo>)> ShortcutInfoCallback;
 
 #if defined(TOOLKIT_VIEWS)
 // Extracts shortcut info of the given WebContents.
-std::unique_ptr<ShortcutInfo> GetShortcutInfoForTab(
+scoped_refptr<ShortcutInfo> GetShortcutInfoForTab(
     content::WebContents* web_contents);
 #endif
 
 // Updates web app shortcut of the WebContents. This function checks and
 // updates web app icon and shortcuts if needed. For icon, the check is based
 // on MD5 hash of icon image. For shortcuts, it checks the desktop, start menu
 // and quick launch (as well as pinned shortcut) for shortcut and only
 // updates (recreates) them if they exits.
 void UpdateShortcutForTabContents(content::WebContents* web_contents);
 
-std::unique_ptr<ShortcutInfo> ShortcutInfoForExtensionAndProfile(
+scoped_refptr<ShortcutInfo> ShortcutInfoForExtensionAndProfile(
     const extensions::Extension* app,
     Profile* profile);
 
 // Populates a ShortcutInfo for the given |extension| in |profile| and passes
 // it to |callback| after asynchronously loading all icon representations.
 void GetShortcutInfoForApp(const extensions::Extension* extension,
                            Profile* profile,
                            const ShortcutInfoCallback& callback);
 
 // Whether to create a shortcut for this type of extension.
@@ skipping 25 matching lines @@
 std::string GenerateApplicationNameFromExtensionId(const std::string& id);
 
 // Extracts the extension id from the app name.
 std::string GetExtensionIdFromApplicationName(const std::string& app_name);
 
 // Create shortcuts for web application based on given shortcut data.
 // |shortcut_info| contains information about the shortcuts to create, and
 // |locations| contains information about where to create them.
 void CreateShortcutsWithInfo(ShortcutCreationReason reason,
                              const ShortcutLocations& locations,
-                             std::unique_ptr<ShortcutInfo> shortcut_info);
+                             scoped_refptr<ShortcutInfo> shortcut_info);
 
 // Creates shortcuts for an app. This loads the app's icon from disk, and calls
 // CreateShortcutsWithInfo(). If you already have a ShortcutInfo with the app's
 // icon loaded, you should use CreateShortcutsWithInfo() directly.
 void CreateShortcuts(ShortcutCreationReason reason,
                      const ShortcutLocations& locations,
                      Profile* profile,
                      const extensions::Extension* app);
 
 // Delete all shortcuts that have been created for the given profile and
@@ skipping 40 matching lines @@
 std::vector<base::FilePath> GetShortcutPaths(
     const ShortcutLocations& creation_locations);
 #endif
 
 // Implemented for each platform, does the platform specific parts of creating
 // shortcuts. Used internally by CreateShortcuts methods.
 // |shortcut_data_path| is where to store any resources created for the
 // shortcut, and is also used as the UserDataDir for platform app shortcuts.
 // |shortcut_info| contains info about the shortcut to create, and
 // |creation_locations| contains information about where to create them.
-bool CreatePlatformShortcuts(
-    const base::FilePath& shortcut_data_path,
-    std::unique_ptr<ShortcutInfo> shortcut_info,
-    const ShortcutLocations& creation_locations,
-    ShortcutCreationReason creation_reason);
+bool CreatePlatformShortcuts(const base::FilePath& shortcut_data_path,
+                             scoped_refptr<ShortcutInfo> shortcut_info,
+                             const ShortcutLocations& creation_locations,
+                             ShortcutCreationReason creation_reason);
 
 // Delete all the shortcuts we have added for this extension. This is the
 // platform specific implementation of the DeleteAllShortcuts function, and
 // is executed on the FILE thread.
 void DeletePlatformShortcuts(const base::FilePath& shortcut_data_path,
-                             std::unique_ptr<ShortcutInfo> shortcut_info);
+                             scoped_refptr<ShortcutInfo> shortcut_info);
 
 // Updates all the shortcuts we have added for this extension. This is the
 // platform specific implementation of the UpdateAllShortcuts function, and
 // is executed on the FILE thread.
 void UpdatePlatformShortcuts(const base::FilePath& shortcut_data_path,
                              const base::string16& old_app_title,
-                             std::unique_ptr<ShortcutInfo> shortcut_info);
+                             scoped_refptr<ShortcutInfo> shortcut_info);
 
 // Delete all the shortcuts for an entire profile.
 // This is executed on the FILE thread.
 void DeleteAllShortcutsForProfile(const base::FilePath& profile_path);
 
 // Sanitizes |name| and returns a version of it that is safe to use as an
 // on-disk file name .
 base::FilePath GetSanitizedFileName(const base::string16& name);
 
 }  // namespace internals
 
 }  // namespace web_app
 
 #endif  // CHROME_BROWSER_WEB_APPLICATIONS_WEB_APP_H_