Switch WebIntentPickerController to use WebContentsUserData.

chrome/browser/ui/intents/web_intent_picker_controller.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_UI_INTENTS_WEB_INTENT_PICKER_CONTROLLER_H_
 #define CHROME_BROWSER_UI_INTENTS_WEB_INTENT_PICKER_CONTROLLER_H_
 
 #include <vector>
 
 #include "base/compiler_specific.h"
 #include "base/memory/ref_counted.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/memory/weak_ptr.h"
 #include "base/string16.h"
 #include "chrome/browser/extensions/webstore_installer.h"
 #include "chrome/browser/favicon/favicon_service.h"
 #include "chrome/browser/intents/cws_intents_registry.h"
 #include "chrome/browser/intents/web_intents_registry.h"
 #include "chrome/browser/intents/web_intents_reporting.h"
+#include "chrome/browser/tab_contents/web_contents_user_data.h"
 #include "chrome/browser/ui/intents/web_intent_picker_delegate.h"
 #include "content/public/browser/notification_observer.h"
 #include "content/public/browser/notification_registrar.h"
 #include "webkit/glue/web_intent_data.h"
 #include "webkit/glue/web_intent_reply_data.h"
 #include "webkit/glue/web_intent_service_data.h"
 
 class Browser;
 struct DefaultWebIntentService;
 class GURL;
-class TabContents;
+class Profile;
 class WebIntentPicker;
 class WebIntentPickerModel;
 
 namespace content {
 class WebContents;
 class WebIntentsDispatcher;
 }
 
 namespace webkit_glue {
 struct WebIntentServiceData;
 }
 
 // Controls the creation of the WebIntentPicker UI and forwards the user's
 // intent handler choice back to the WebContents object.
 class WebIntentPickerController
     : public content::NotificationObserver,
       public WebIntentPickerDelegate,
-      public extensions::WebstoreInstaller::Delegate {
+      public extensions::WebstoreInstaller::Delegate,
+      public WebContentsUserData<WebIntentPickerController> {
  public:
 
   // The various states that the UI may be in. Public for testing.
   enum WebIntentPickerState {
     kPickerHidden,  // Picker not displayed at all.
     kPickerSetup,  // Initial setup. Acquires data, keeps picker hidden.
     kPickerWaiting, // Displaying "waiting for CWS".
     kPickerWaitLong,  // "waiting" has displayed for longer than min. time.
     kPickerMain,  // Displaying main picker dialog.
     kPickerInline, // Displaying inline intent handler.
   };
 
   // Events that happen during picker life time. Drive state machine.
   enum WebIntentPickerEvent {
     kPickerEventHiddenSetupTimeout,  // Time for hidden setup exired.
     kPickerEventMaxWaitTimeExceeded,  // Exceeded max wait time for CWS results.
     kPickerEventRegistryDataComplete,  // Data from the registry has arrived.
     kPickerEventAsyncDataComplete,  // Data from registry and CWS has arrived.
   };
 
-  explicit WebIntentPickerController(TabContents* tab_contents);
   virtual ~WebIntentPickerController();
 
   // Sets the intent data and return pathway handler object for which
   // this picker was created. The picker takes ownership of
   // |intents_dispatcher|. |intents_dispatcher| must not be NULL.
   void SetIntentsDispatcher(content::WebIntentsDispatcher* intents_dispatcher);
 
   // Shows the web intent picker given the intent |action| and MIME-type |type|.
   void ShowDialog(const string16& action,
                   const string16& type);
@@ skipping 31 matching lines @@
   virtual void OnUserCancelledPickerDialog() OVERRIDE;
   virtual void OnChooseAnotherService() OVERRIDE;
   virtual void OnClosing() OVERRIDE;
 
   // extensions::WebstoreInstaller::Delegate implementation.
   virtual void OnExtensionInstallSuccess(const std::string& id) OVERRIDE;
   virtual void OnExtensionInstallFailure(const std::string& id,
                                          const std::string& error) OVERRIDE;
 
  private:
+  explicit WebIntentPickerController(content::WebContents* web_contents);
+  static int kUserDataKey;

[James Hawkins, 2012/09/25 17:46:25]

Is this used anywhere?  If so please document it.  I couldn't find any uses.

[Avi (use Gerrit), 2012/09/25 18:14:36]

Yes it is. It's part of the WebContentsUserData machinery. See
https://chromiumcodereview.appspot.com/10868115

+  friend class WebContentsUserData<WebIntentPickerController>;
+
   friend class WebIntentPickerControllerTest;
   friend class WebIntentPickerControllerBrowserTest;
   friend class WebIntentPickerControllerIncognitoBrowserTest;
   friend class WebIntentsButtonDecorationTest;
 
   // Forward declaraton of the internal implementation class.
   class UMAReporter;
 
   // Dispatches intent to a just-installed extension with ID |extension_id|.
   void DispatchToInstalledExtension(const std::string& extension_id);
@@ skipping 108 matching lines @@
   // Re-starts the process of showing the dialog, suppressing any default
   // queries. Called on the user clicking Use-Another-Service.
   void ReshowDialog();
 
   // Delegate for ShowDialog and ReshowDialog. Starts all the data queries for
   // loading the picker model and showing the dialog.
   void ShowDialog(bool suppress_defaults);
 
   WebIntentPickerState dialog_state_;  // Current state of the dialog.
 
-  // A weak pointer to the tab contents that the picker is displayed on.
-  TabContents* tab_contents_;
+  // A weak pointer to the web contents that the picker is displayed on.
+  content::WebContents* web_contents_;
+
+  // A weak pointer to the profile for the web contents.
+  Profile* profile_;
 
   // A notification registrar, listening for notifications when the tab closes
   // to close the picker ui.
   content::NotificationRegistrar registrar_;
 
   // A weak pointer to the picker this controller controls.
   WebIntentPicker* picker_;
 
   // The model for the picker. Owned by this controller. It should not be NULL
   // while this controller exists, even if the picker is not shown.
@@ skipping 60 matching lines @@
   // Bucket identifier for UMA reporting. Saved off in a field
   // to avoid repeated calculation of the bucket across
   // multiple UMA calls. Should be recalculated each time
   // |intents_dispatcher_| is set.
   web_intents::UMABucket uma_bucket_;
 
   DISALLOW_COPY_AND_ASSIGN(WebIntentPickerController);
 };
 
 #endif  // CHROME_BROWSER_UI_INTENTS_WEB_INTENT_PICKER_CONTROLLER_H_