Browser Plugin: Implement BrowserPluginObserver.

content/renderer/browser_plugin/browser_plugin_impl.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  CONTENT_RENDERER_BROWSER_PLUGIN_BROWSER_PLUGIN_H_
-#define  CONTENT_RENDERER_BROWSER_PLUGIN_BROWSER_PLUGIN_H_
-
-#include "third_party/WebKit/Source/WebKit/chromium/public/WebPlugin.h"
+#ifndef  CONTENT_RENDERER_BROWSER_PLUGIN_BROWSER_PLUGIN_IMPL_H_
+#define  CONTENT_RENDERER_BROWSER_PLUGIN_BROWSER_PLUGIN_IMPL_H_
 
 #include "base/memory/scoped_ptr.h"
 #include "base/memory/weak_ptr.h"
+#include "base/observer_list.h"
 #include "base/process_util.h"
 #include "base/sequenced_task_runner_helpers.h"
 #if defined(OS_WIN)
 #include "base/shared_memory.h"
 #endif
 #include "content/common/browser_plugin_message_enums.h"
+#include "content/public/renderer/browser_plugin/browser_plugin.h"
 #include "content/renderer/browser_plugin/browser_plugin_backing_store.h"
 #include "content/renderer/browser_plugin/browser_plugin_bindings.h"
 #include "content/renderer/render_view_impl.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebDragStatus.h"
+#include "third_party/WebKit/Source/WebKit/chromium/public/WebPlugin.h"
 
 struct BrowserPluginHostMsg_AutoSize_Params;
 struct BrowserPluginHostMsg_ResizeGuest_Params;
 struct BrowserPluginMsg_LoadCommit_Params;
 struct BrowserPluginMsg_UpdateRect_Params;
 
 namespace content {
 
 class BrowserPluginCompositingHelper;
 class BrowserPluginManager;
+class BrowserPluginObserver;
 class MockBrowserPlugin;
 
-class CONTENT_EXPORT BrowserPlugin :
-    NON_EXPORTED_BASE(public WebKit::WebPlugin) {
+class CONTENT_EXPORT BrowserPluginImpl :
+    NON_EXPORTED_BASE(public WebKit::WebPlugin),
+    public BrowserPlugin {
  public:
   RenderViewImpl* render_view() const { return render_view_.get(); }
   int render_view_routing_id() const { return render_view_routing_id_; }
 
   bool OnMessageReceived(const IPC::Message& msg);
 
-  // Update Browser Plugin's DOM Node attribute |attribute_name| with the value
-  // |attribute_value|.
-  void UpdateDOMAttribute(const std::string& attribute_name,
-                          const std::string& attribute_value);
-  // Remove the DOM Node attribute with the name |attribute_name|.
-  void RemoveDOMAttribute(const std::string& attribute_name);
-  // Get Browser Plugin's DOM Node attribute |attribute_name|'s value.
-  std::string GetDOMAttributeValue(const std::string& attribute_name) const;
-  // Checks if the attribute |attribute_name| exists in the DOM.
-  bool HasDOMAttribute(const std::string& attribute_name) const;
-
   // Get the name attribute value.
   std::string GetNameAttribute() const;
   // Parse the name attribute value.
   void ParseNameAttribute();
   // Get the src attribute value of the BrowserPlugin instance.
   std::string GetSrcAttribute() const;
   // Parse the src attribute value of the BrowserPlugin instance.
   bool ParseSrcAttribute(std::string* error_message);
   // Get the autosize attribute value.
   bool GetAutoSizeAttribute() const;
@@ skipping 69 matching lines @@
   // Not OK to use this function for making security-sensitive decision since it
   // can return false positives when the plugin has rotation transformation
   // applied.
   bool InBounds(const gfx::Point& point) const;
 
   gfx::Point ToLocalCoordinates(const gfx::Point& point) const;
   // Called by browser plugin binding.
   void OnEmbedderDecidedPermission(int request_id, bool allow);
 
 
+  // BrowserPlugin implementation.
+  virtual RenderView* GetRenderView() const OVERRIDE;
+  virtual WebKit::WebPluginContainer* GetContainer() const OVERRIDE;
+  virtual void AddMethodBinding(
+      BrowserPluginMethodBinding* method_binding) OVERRIDE;
+  virtual void AddPropertyBinding(
+      BrowserPluginPropertyBinding* method_binding) OVERRIDE;
+  virtual void TriggerEvent(
+      const std::string& event_name,
+      std::map<std::string, base::Value*>* props) OVERRIDE;
+  virtual void UpdateDOMAttribute(const std::string& attribute_name,
+                                  const std::string& attribute_value) OVERRIDE;
+  virtual void RemoveDOMAttribute(const std::string& attribute_name) OVERRIDE;
+  virtual std::string GetDOMAttributeValue(
+      const std::string& attribute_name) const OVERRIDE;
+  virtual bool HasDOMAttribute(
+      const std::string& attribute_name) const OVERRIDE;
+  virtual bool HasNavigated() const OVERRIDE;
+
+  // IPC::Sender implementation.
+  virtual bool Send(IPC::Message* message) OVERRIDE;
+
   // WebKit::WebPlugin implementation.
   virtual WebKit::WebPluginContainer* container() const OVERRIDE;
   virtual bool initialize(WebKit::WebPluginContainer* container) OVERRIDE;
   virtual void destroy() OVERRIDE;
   virtual NPObject* scriptableObject() OVERRIDE;
   virtual bool supportsKeyboardFocus() const OVERRIDE;
   virtual bool canProcessDrag() const OVERRIDE;
   virtual void paint(
       WebKit::WebCanvas* canvas,
       const WebKit::WebRect& rect) OVERRIDE;
@@ skipping 19 matching lines @@
   virtual void didFinishLoading() OVERRIDE;
   virtual void didFailLoading(const WebKit::WebURLError& error) OVERRIDE;
   virtual void didFinishLoadingFrameRequest(
       const WebKit::WebURL& url,
       void* notify_data) OVERRIDE;
   virtual void didFailLoadingFrameRequest(
       const WebKit::WebURL& url,
       void* notify_data,
       const WebKit::WebURLError& error) OVERRIDE;
  private:
-  friend class base::DeleteHelper<BrowserPlugin>;
+  friend class base::DeleteHelper<BrowserPluginImpl>;
   // Only the manager is allowed to create a BrowserPlugin.
   friend class BrowserPluginManagerImpl;
+  friend class BrowserPluginObserver;
   friend class MockBrowserPluginManager;
 
   // For unit/integration tests.
   friend class MockBrowserPlugin;
 
-  // A BrowserPlugin object is a controller that represents an instance of a
+  // A BrowserPluginImpl object is a controller that represents an instance of a
   // browser plugin within the embedder renderer process. Each BrowserPlugin
-  // within a process has a unique instance_id that is used to route messages
+  // within a process has a unique |instance_id| that is used to route messages
   // to it. It takes in a RenderViewImpl that it's associated with along
   // with the frame within which it lives and the initial attributes assigned
   // to it on creation.
-  BrowserPlugin(
+  BrowserPluginImpl(
       RenderViewImpl* render_view,
       WebKit::WebFrame* frame,
       const WebKit::WebPluginParams& params);
 
-  virtual ~BrowserPlugin();
+  virtual ~BrowserPluginImpl();
+
+  // Add and remove observers for filtering IPC messages. Clients must be sure
+  // to remove the observer before they go away.
+  void AddObserver(BrowserPluginObserver* observer);
+  void RemoveObserver(BrowserPluginObserver* observer);
 
   int width() const { return plugin_rect_.width(); }
   int height() const { return plugin_rect_.height(); }
   int instance_id() const { return instance_id_; }
   // Gets the Max Height value used for auto size.
   int GetAdjustedMaxHeight() const;
   // Gets the Max Width value used for auto size.
   int GetAdjustedMaxWidth() const;
   // Gets the Min Height value used for auto size.
   int GetAdjustedMinHeight() const;
   // Gets the Min Width value used for auto size.
   int GetAdjustedMinWidth() const;
   BrowserPluginManager* browser_plugin_manager() const {
     return browser_plugin_manager_;
   }
 
   // Virtual to allow for mocking in tests.
   virtual float GetDeviceScaleFactor() const;
 
   // Parses the attributes of the browser plugin from the element's attributes
   // and sets them appropriately.
   void ParseAttributes();
 
-  // Triggers the event-listeners for |event_name|. Note that the function
-  // frees all the values in |props|.
-  void TriggerEvent(const std::string& event_name,
-                    std::map<std::string, base::Value*>* props);
-
   // Creates and maps a shared damage buffer.
   virtual base::SharedMemory* CreateDamageBuffer(
       const size_t size,
       base::SharedMemoryHandle* shared_memory_handle);
   // Swaps out the |current_damage_buffer_| with the |pending_damage_buffer_|.
   void SwapDamageBuffers();
 
   // Populates BrowserPluginHostMsg_ResizeGuest_Params with resize state and
   // allocates a new |pending_damage_buffer_| if in software rendering mode.
   void PopulateResizeGuestParameters(
@@ skipping 53 matching lines @@
                                            void* param);
 
   // IPC message handlers.
   // Please keep in alphabetical order.
   void OnAdvanceFocus(int instance_id, bool reverse);
   void OnBuffersSwapped(int instance_id,
                         const gfx::Size& size,
                         std::string mailbox_name,
                         int gpu_route_id,
                         int gpu_host_id);
+  void OnForwardMessage(int instance_id, const IPC::Message& msg);
   void OnGuestContentWindowReady(int instance_id,
                                  int content_window_routing_id);
   void OnGuestGone(int instance_id, int process_id, int status);
   void OnGuestResponsive(int instance_id, int process_id);
   void OnGuestUnresponsive(int instance_id, int process_id);
   void OnLoadAbort(int instance_id,
                    const GURL& url,
                    bool is_top_level,
                    const std::string& type);
   void OnLoadCommit(int instance_id,
@@ skipping 52 matching lines @@
   gfx::Size last_view_size_;
   bool size_changed_in_flight_;
   bool allocate_instance_id_sent_;
 
   // Each permission request item in the map is a pair of request id and
   // permission type.
   typedef std::map<int, std::pair<int, BrowserPluginPermissionType> >
       PendingPermissionRequests;
   PendingPermissionRequests pending_permission_requests_;
 
-  typedef std::pair<int, base::WeakPtr<BrowserPlugin> >
+  typedef std::pair<int, base::WeakPtr<BrowserPluginImpl> >
       AliveV8PermissionRequestItem;
   std::map<int, AliveV8PermissionRequestItem*>
       alive_v8_permission_request_objects_;
 
   // BrowserPlugin outlives RenderViewImpl in Chrome Apps and so we need to
   // store the BrowserPlugin's BrowserPluginManager in a member variable to
   // avoid accessing the RenderViewImpl.
   scoped_refptr<BrowserPluginManager> browser_plugin_manager_;
 
+  // A list of observers that filter messages. Weak references.
+  ObserverList<BrowserPluginObserver> observers_;
+
   // Important: Do not add more history state here.
   // We strongly discourage storing additional history state (such as page IDs)
   // in the embedder process, at the risk of having incorrect information that
   // can lead to broken back/forward logic in apps.
   // It's also important that this state does not get modified by any logic in
   // the embedder process. It should only be updated in response to navigation
   // events in the guest.  No assumptions should be made about how the index
   // will change after a navigation (e.g., for back, forward, or go), because
   // the changes are not always obvious.  For example, there is a maximum
   // number of entries and earlier ones will automatically be pruned.
   int current_nav_entry_index_;
   int nav_entry_count_;
 
   // Used for HW compositing.
   bool compositing_enabled_;
   scoped_refptr<BrowserPluginCompositingHelper> compositing_helper_;
 
   // Weak factory used in v8 |MakeWeak| callback, since the v8 callback might
   // get called after BrowserPlugin has been destroyed.
-  base::WeakPtrFactory<BrowserPlugin> weak_ptr_factory_;
+  base::WeakPtrFactory<BrowserPluginImpl> weak_ptr_factory_;
 
-  DISALLOW_COPY_AND_ASSIGN(BrowserPlugin);
+  DISALLOW_COPY_AND_ASSIGN(BrowserPluginImpl);
 };
 
 }  // namespace content
 
-#endif  // CONTENT_RENDERER_BROWSER_PLUGIN_BROWSER_PLUGIN_H_
+#endif  // CONTENT_RENDERER_BROWSER_PLUGIN_BROWSER_PLUGIN_IMPL_H_