Allow MessageFilters to restrict listening to specific message classes

ipc/ipc_channel_proxy.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 "base/bind.h"
 #include "base/compiler_specific.h"
 #include "base/debug/trace_event.h"
 #include "base/location.h"
 #include "base/memory/ref_counted.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/single_thread_task_runner.h"
 #include "base/thread_task_runner_handle.h"
 #include "ipc/ipc_channel_proxy.h"
 #include "ipc/ipc_listener.h"
 #include "ipc/ipc_logging.h"
 #include "ipc/ipc_message_macros.h"
+#include "ipc/ipc_message_start.h"
 #include "ipc/ipc_message_utils.h"
 
 namespace IPC {
 
 //------------------------------------------------------------------------------
 
+class ChannelProxy::Context::MessageFilterRouter {
+ public:
+  typedef std::vector<MessageFilter*> MessageFilters;
+
+  MessageFilterRouter() {}
+  ~MessageFilterRouter() {}
+
+  void AddFilter(MessageFilter* filter) {
+    // Determine if the filter should be applied to all messages, or only
+    // messages of a certain class.
+    std::vector<uint32> supported_message_classes;
+    if (filter->GetSupportedMessageClasses(&supported_message_classes)) {
+      DCHECK(!supported_message_classes.empty());
+      for (size_t i = 0; i < supported_message_classes.size(); ++i) {
+        const int message_class = supported_message_classes[i];
+        DCHECK(ValidMessageClass(message_class));
+        // Safely ignore repeated subscriptions to a given message class for the
+        // current filter being added.
+        if (!message_class_filters_[message_class].empty() &&
+            message_class_filters_[message_class].back() == filter) {
+          continue;
+        }
+        message_class_filters_[message_class].push_back(filter);
+      }
+    } else {
+      global_filters_.push_back(filter);
+    }
+  }
+
+  void RemoveFilter(MessageFilter* filter) {
+    if (RemoveFilter(global_filters_, filter))
+      return;
+
+    for (size_t i = 0; i < arraysize(message_class_filters_); ++i)
+      RemoveFilter(message_class_filters_[i], filter);
+  }
+
+  bool TryFilters(const Message& message) {
+    if (TryFilters(global_filters_, message))
+      return true;
+
+    const int message_class = IPC_MESSAGE_CLASS(message);
+    if (!ValidMessageClass(message_class))
+      return false;
+
+    return TryFilters(message_class_filters_[message_class], message);
+  }
+
+  void Clear() {
+    global_filters_.clear();
+    for (size_t i = 0; i < arraysize(message_class_filters_); ++i)
+      message_class_filters_[i].clear();
+  }
+
+ private:
+  static bool TryFilters(MessageFilters& filters, const IPC::Message& message) {
+    for (size_t i = 0; i < filters.size(); ++i) {
+      if (filters[i]->OnMessageReceived(message)) {
+        return true;
+      }
+    }
+    return false;
+  }
+
+  static bool RemoveFilter(MessageFilters& filters, MessageFilter* filter) {
+    MessageFilters::iterator it =
+        std::remove(filters.begin(), filters.end(), filter);
+    if (it == filters.end())
+      return false;
+
+    filters.erase(it, filters.end());
+    return true;
+  }
+
+  static bool ValidMessageClass(int message_class) {
+    return message_class >= 0 && message_class < LastIPCMsgStart;
+  }
+
+  // List of global and selective filters; a given filter will exist in either
+  // |message_global_filters_| OR |message_class_filters_|, but not both.
+  // Note that |message_global_filters_| will be given first offering of any
+  // given message.  It's the filter implementer and installer's
+  // responsibility to ensure that a filter is either global or selective to
+  // ensure proper message filtering order.
+  MessageFilters global_filters_;
+  MessageFilters message_class_filters_[LastIPCMsgStart];
+};
+
+//------------------------------------------------------------------------------
+
 ChannelProxy::MessageFilter::MessageFilter() {}
 
 void ChannelProxy::MessageFilter::OnFilterAdded(Channel* channel) {}
 
 void ChannelProxy::MessageFilter::OnFilterRemoved() {}
 
 void ChannelProxy::MessageFilter::OnChannelConnected(int32 peer_pid) {}
 
 void ChannelProxy::MessageFilter::OnChannelError() {}
 
 void ChannelProxy::MessageFilter::OnChannelClosing() {}
 
 bool ChannelProxy::MessageFilter::OnMessageReceived(const Message& message) {
   return false;
 }
 
+bool ChannelProxy::MessageFilter::GetSupportedMessageClasses(
+    std::vector<uint32>* /*supported_message_classes*/) const {
+  return false;
+}
+
 ChannelProxy::MessageFilter::~MessageFilter() {}
 
 //------------------------------------------------------------------------------
 
 ChannelProxy::Context::Context(Listener* listener,
                                base::SingleThreadTaskRunner* ipc_task_runner)
     : listener_task_runner_(base::ThreadTaskRunnerHandle::Get()),
       listener_(listener),
       ipc_task_runner_(ipc_task_runner),
       channel_connected_called_(false),
+      message_filter_router_(new MessageFilterRouter()),
       peer_pid_(base::kNullProcessId) {
   DCHECK(ipc_task_runner_.get());
 }
 
 ChannelProxy::Context::~Context() {
 }
 
 void ChannelProxy::Context::ClearIPCTaskRunner() {
   ipc_task_runner_ = NULL;
 }
 
 void ChannelProxy::Context::CreateChannel(const IPC::ChannelHandle& handle,
                                           const Channel::Mode& mode) {
   DCHECK(channel_.get() == NULL);
   channel_id_ = handle.name;
   channel_.reset(new Channel(handle, mode, this));
 }
 
 bool ChannelProxy::Context::TryFilters(const Message& message) {
+  DCHECK(message_filter_router_);
 #ifdef IPC_MESSAGE_LOG_ENABLED
   Logging* logger = Logging::GetInstance();
   if (logger->Enabled())
     logger->OnPreDispatchMessage(message);
 #endif
 
-  for (size_t i = 0; i < filters_.size(); ++i) {
-    if (filters_[i]->OnMessageReceived(message)) {
+  if (message_filter_router_->TryFilters(message)) {
 #ifdef IPC_MESSAGE_LOG_ENABLED
-      if (logger->Enabled())
-        logger->OnPostDispatchMessage(message, channel_id_);
+    if (logger->Enabled())
+      logger->OnPostDispatchMessage(message, channel_id_);
 #endif
-      return true;
-    }
+    return true;
   }
   return false;
 }
 
 // Called on the IPC::Channel thread
 bool ChannelProxy::Context::OnMessageReceived(const Message& message) {
   // First give a chance to the filters to process this message.
   if (!TryFilters(message))
     OnMessageReceivedNoFilter(message);
   return true;
@@ skipping 57 matching lines @@
   // would result in this branch being taken.
   if (!channel_.get())
     return;
 
   for (size_t i = 0; i < filters_.size(); ++i) {
     filters_[i]->OnChannelClosing();
     filters_[i]->OnFilterRemoved();
   }
 
   // We don't need the filters anymore.
+  message_filter_router_->Clear();
   filters_.clear();
 
   channel_.reset();
 
   // Balance with the reference taken during startup.  This may result in
   // self-destruction.
   Release();
 }
 
 void ChannelProxy::Context::Clear() {
@@ skipping 14 matching lines @@
 void ChannelProxy::Context::OnAddFilter() {
   std::vector<scoped_refptr<MessageFilter> > new_filters;
   {
     base::AutoLock auto_lock(pending_filters_lock_);
     new_filters.swap(pending_filters_);
   }
 
   for (size_t i = 0; i < new_filters.size(); ++i) {
     filters_.push_back(new_filters[i]);
 
+    message_filter_router_->AddFilter(new_filters[i].get());
+
     // If the channel has already been created, then we need to send this
     // message so that the filter gets access to the Channel.
     if (channel_.get())
       new_filters[i]->OnFilterAdded(channel_.get());
     // Ditto for if the channel has been connected.
     if (peer_pid_)
       new_filters[i]->OnChannelConnected(peer_pid_);
   }
 }
 
 // Called on the IPC::Channel thread
 void ChannelProxy::Context::OnRemoveFilter(MessageFilter* filter) {
   if (!channel_.get())
     return;  // The filters have already been deleted.
 
+  message_filter_router_->RemoveFilter(filter);
+
   for (size_t i = 0; i < filters_.size(); ++i) {
     if (filters_[i].get() == filter) {
       filter->OnFilterRemoved();
       filters_.erase(filters_.begin() + i);
       return;
     }
   }
 
   NOTREACHED() << "filter to be removed not found";
 }
@@ skipping 193 matching lines @@
   Channel* channel = context_.get()->channel_.get();
   // Channel must have been created first.
   DCHECK(channel) << context_.get()->channel_id_;
   return channel->GetPeerEuid(peer_euid);
 }
 #endif
 
 //-----------------------------------------------------------------------------
 
 }  // namespace IPC