Initial work to remove the notion of all extension message payloads as strings.

chrome/browser/extensions/extension_event_router.cc

 // 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.
 
 #include "chrome/browser/extensions/extension_event_router.h"
 
 #include "base/bind.h"
 #include "base/command_line.h"
 #include "base/message_loop.h"
 #include "base/values.h"
@@ skipping 11 matching lines @@
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/common/chrome_notification_types.h"
 #include "chrome/common/chrome_switches.h"
 #include "chrome/common/extensions/extension.h"
 #include "chrome/common/extensions/extension_messages.h"
 #include "chrome/common/extensions/api/extension_api.h"
 #include "chrome/common/view_type.h"
 #include "content/public/browser/notification_service.h"
 #include "content/public/browser/render_process_host.h"
 
+using base::Value;
 using content::BrowserThread;
 using extensions::Extension;
 using extensions::ExtensionAPI;
 
 namespace {
 
 const char kDispatchEvent[] = "Event.dispatchJSON";
 
 void NotifyEventListenerRemovedOnIOThread(
     void* profile,
@@ skipping 17 matching lines @@
     if (process < that.process)
       return true;
     if (process == that.process && extension_id < that.extension_id)
       return true;
     return false;
   }
 };
 
 struct ExtensionEventRouter::ExtensionEvent {
   std::string event_name;
-  std::string event_args;
+  scoped_ptr<Value> event_args;
   GURL event_url;
   Profile* restrict_to_profile;
-  std::string cross_incognito_args;
+  scoped_ptr<Value> cross_incognito_args;
   UserGestureState user_gesture;
 
   ExtensionEvent(const std::string& event_name,
+                 const Value& event_args,
+                 const GURL& event_url,
+                 Profile* restrict_to_profile,
+                 const Value& cross_incognito_args,
+                 UserGestureState user_gesture)
+    : event_name(event_name),
+      event_args(event_args.DeepCopy()),
+      event_url(event_url),
+      restrict_to_profile(restrict_to_profile),
+      cross_incognito_args(cross_incognito_args.DeepCopy()),
+      user_gesture(user_gesture) {}
+
+  ExtensionEvent(const std::string& event_name,
+                 const Value& event_args,
+                 const GURL& event_url,
+                 Profile* restrict_to_profile,
+                 UserGestureState user_gesture)
+    : event_name(event_name),
+      event_args(event_args.DeepCopy()),
+      event_url(event_url),
+      restrict_to_profile(restrict_to_profile),
+      cross_incognito_args(NULL),
+      user_gesture(user_gesture) {}
+
+  // TODO(gdk): This variant should be retired once the callers are switched to
+  // providing Values instead of just strings.
+  ExtensionEvent(const std::string& event_name,
                  const std::string& event_args,
                  const GURL& event_url,
                  Profile* restrict_to_profile,
                  const std::string& cross_incognito_args,
                  UserGestureState user_gesture)
     : event_name(event_name),
-      event_args(event_args),
+      event_args(Value::CreateStringValue(event_args)),
       event_url(event_url),
       restrict_to_profile(restrict_to_profile),
-      cross_incognito_args(cross_incognito_args),
+      cross_incognito_args(Value::CreateStringValue(cross_incognito_args)),
       user_gesture(user_gesture) {}
 };
 
 // static
 void ExtensionEventRouter::DispatchEvent(IPC::Sender* ipc_sender,
                                          const std::string& extension_id,
                                          const std::string& event_name,
+                                         const Value& event_args,
+                                         const GURL& event_url,
+                                         UserGestureState user_gesture) {
+  ListValue args;
+  args.Set(0, Value::CreateStringValue(event_name));
+  args.Set(1, event_args.DeepCopy());

[asargent_no_longer_on_chrome, 2012/06/18 16:25:30]

It's a bummer to have to copy the arguments just to hand off to be sent over the
IPC channel. Can you avoid the DeepCopy here by doing:

ListValue args;
args.Set(0, Value::CreateStringValue(event_name));
args.Set(1, static_cast<Value*>(&event_args));

...

// Take back ownership of event_args so it doesn't get deleted.
Value* tmp;
args.Remove(1, &tmp);

?

This can be a follow-up TODO though if you want. (I suppose for pedantry we
might consider changing event_args from const Value& to Value* to avoid needing
to cast away the constness).

[Garret Kelly, 2012/06/18 18:15:01]

I've added a TODO, I'll refactor that as part of the remaining changeover to
Value for event_args.

+  ipc_sender->Send(new ExtensionMsg_MessageInvoke(MSG_ROUTING_CONTROL,
+      extension_id, kDispatchEvent, args, event_url,
+      user_gesture == USER_GESTURE_ENABLED));
+}
+
+// static
+void ExtensionEventRouter::DispatchEvent(IPC::Sender* ipc_sender,
+                                         const std::string& extension_id,
+                                         const std::string& event_name,
                                          const std::string& event_args,
                                          const GURL& event_url,
                                          UserGestureState user_gesture) {
-  ListValue args;
-  args.Set(0, Value::CreateStringValue(event_name));
-  args.Set(1, Value::CreateStringValue(event_args));
-  ipc_sender->Send(new ExtensionMsg_MessageInvoke(MSG_ROUTING_CONTROL,
-      extension_id, kDispatchEvent, args, event_url,
-      user_gesture == USER_GESTURE_ENABLED));
+  scoped_ptr<Value> event_args_value(Value::CreateStringValue(event_args));
+  DispatchEvent(ipc_sender, extension_id, event_name, *event_args_value.get(),
+                event_url, user_gesture);
 }
 
 ExtensionEventRouter::ExtensionEventRouter(Profile* profile)
     : profile_(profile),
       extension_devtools_manager_(
           ExtensionSystem::Get(profile)->devtools_manager()) {
   registrar_.Add(this, content::NOTIFICATION_RENDERER_PROCESS_TERMINATED,
                  content::NotificationService::AllSources());
   registrar_.Add(this, content::NOTIFICATION_RENDERER_PROCESS_CLOSED,
                  content::NotificationService::AllSources());
@@ skipping 124 matching lines @@
     const GURL& event_url) {
   linked_ptr<ExtensionEvent> event(
       new ExtensionEvent(event_name, event_args, event_url,
                          restrict_to_profile, "", USER_GESTURE_UNKNOWN));
   DispatchEventImpl("", event);
 }
 
 void ExtensionEventRouter::DispatchEventToExtension(
     const std::string& extension_id,
     const std::string& event_name,
-    const std::string& event_args,
+    const Value& event_args,
     Profile* restrict_to_profile,
     const GURL& event_url) {
   DCHECK(!extension_id.empty());
   linked_ptr<ExtensionEvent> event(
       new ExtensionEvent(event_name, event_args, event_url,
-                         restrict_to_profile, "", USER_GESTURE_UNKNOWN));
+                         restrict_to_profile, USER_GESTURE_UNKNOWN));
   DispatchEventImpl(extension_id, event);
 }
 
 void ExtensionEventRouter::DispatchEventToExtension(
     const std::string& extension_id,
     const std::string& event_name,
     const std::string& event_args,
     Profile* restrict_to_profile,
+    const GURL& event_url) {
+  scoped_ptr<Value> event_args_value(Value::CreateStringValue(event_args));
+  DispatchEventToExtension(extension_id, event_name, *event_args_value.get(),
+                           restrict_to_profile, event_url);
+}
+
+void ExtensionEventRouter::DispatchEventToExtension(
+    const std::string& extension_id,
+    const std::string& event_name,
+    const std::string& event_args,
+    Profile* restrict_to_profile,
     const GURL& event_url,
     UserGestureState user_gesture) {
   DCHECK(!extension_id.empty());
   linked_ptr<ExtensionEvent> event(
       new ExtensionEvent(event_name, event_args, event_url,
                          restrict_to_profile, "", user_gesture));
   DispatchEventImpl(extension_id, event);
 }
 
 void ExtensionEventRouter::DispatchEventsToRenderersAcrossIncognito(
@@ skipping 48 matching lines @@
       listener.process->GetBrowserContext());
   extensions::ProcessMap* process_map =
       listener_profile->GetExtensionService()->process_map();
   // If the event is privileged, only send to extension processes. Otherwise,
   // it's OK to send to normal renderers (e.g., for content scripts).
   if (ExtensionAPI::GetSharedInstance()->IsPrivileged(event->event_name) &&
       !process_map->Contains(extension->id(), listener.process->GetID())) {
     return;
   }
 
-  const std::string* event_args;
+  const Value* event_args = NULL;
   if (!CanDispatchEventToProfile(listener_profile, extension,
                                  event, &event_args))
     return;
 
   DispatchEvent(listener.process, listener.extension_id,
                 event->event_name, *event_args,
                 event->event_url, event->user_gesture);
   IncrementInFlightEvents(listener_profile, extension);
 }
 
 bool ExtensionEventRouter::CanDispatchEventToProfile(
     Profile* profile,
     const Extension* extension,
     const linked_ptr<ExtensionEvent>& event,
-    const std::string** event_args) {
-  *event_args = &event->event_args;
+    const Value** event_args) {
+  *event_args = event->event_args.get();
 
   // Is this event from a different profile than the renderer (ie, an
   // incognito tab event sent to a normal process, or vice versa).
   bool cross_incognito = event->restrict_to_profile &&
       profile != event->restrict_to_profile;
   if (cross_incognito &&
       !profile->GetExtensionService()->CanCrossIncognito(extension)) {
-    if (event->cross_incognito_args.empty())
+    if (!event->cross_incognito_args.get())
       return false;
     // Send the event with different arguments to extensions that can't
     // cross incognito.
-    *event_args = &event->cross_incognito_args;
+    *event_args = event->cross_incognito_args.get();
   }
 
   return true;
 }
 
 void ExtensionEventRouter::LoadLazyBackgroundPagesForEvent(
     const std::string& extension_id,
     const linked_ptr<ExtensionEvent>& event) {
   ExtensionService* service = profile_->GetExtensionService();
 
@@ skipping 20 matching lines @@
             profile_->GetOffTheRecordProfile(), extension, event);
       }
     }
   }
 }
 
 void ExtensionEventRouter::MaybeLoadLazyBackgroundPage(
     Profile* profile,
     const Extension* extension,
     const linked_ptr<ExtensionEvent>& event) {
-  const std::string* event_args;
+  const Value* event_args = NULL;
   if (!CanDispatchEventToProfile(profile, extension, event, &event_args))
     return;
 
   extensions::LazyBackgroundTaskQueue* queue =
       ExtensionSystem::Get(profile)->lazy_background_task_queue();
   if (queue->ShouldEnqueueTask(profile, extension)) {
     queue->AddPendingTask(
         profile, extension->id(),
         base::Bind(&ExtensionEventRouter::DispatchPendingEvent,
                    base::Unretained(this), event));
@@ skipping 96 matching lines @@
       MessageLoop::current()->PostTask(FROM_HERE,
           base::Bind(&extensions::RuntimeEventRouter::DispatchOnInstalledEvent,
                      profile_, extension->id()));
       break;
     }
     default:
       NOTREACHED();
       return;
   }
 }