Cleanup InterfaceRegistry + adds Serialize()

services/service_manager/public/cpp/interface_registry.h

 // Copyright 2016 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 SERVICES_SERVICE_MANAGER_PUBLIC_CPP_INTERFACE_REGISTRY_H_
 #define SERVICES_SERVICE_MANAGER_PUBLIC_CPP_INTERFACE_REGISTRY_H_
 
 #include <memory>
 #include <queue>
 #include <set>
@@ skipping 59 matching lines @@
                            mojo::ScopedMessagePipeHandle handle) {
       registry_->GetInterface(name, std::move(handle));
     }
 
    private:
     InterfaceRegistry* registry_;
     DISALLOW_COPY_AND_ASSIGN(TestApi);
   };
 
   // Construct an unbound InterfaceRegistry. This object will not bind requests
-  // for interfaces until Bind() is called.
+  // for interfaces until Bind() is called. |name| is used for error reporting
+  // and should reflect the name of the InterfaceProviderSpec pair that controls
+  // which interfaces can be bound via this InterfaceRegistry.
   explicit InterfaceRegistry(const std::string& name);
   ~InterfaceRegistry() override;
 
   // Sets a default handler for incoming interface requests which are allowed by
   // capability filters but have no registered handler in this registry.
   void set_default_binder(const Binder& binder) { default_binder_ = binder; }
 
   // Binds a request for an InterfaceProvider from a remote source.
   // |remote_info| contains the the identity of the remote, and the remote's
   // InterfaceProviderSpec, which will be intersected with the local's exports
   // to determine what interfaces may be bound.
   void Bind(mojom::InterfaceProviderRequest request,
             const Identity& local_identity,
             const InterfaceProviderSpec& local_interface_provider_spec,
             const Identity& remote_identity,
             const InterfaceProviderSpec& remote_interface_provider_spec);
 
+  // Serializes the contents of the registry (including the local and remote
+  // specs) to a stringstream.
+  void Serialize(std::stringstream* stream);
+
   base::WeakPtr<InterfaceRegistry> GetWeakPtr();
 
   // Allows |Interface| to be exposed via this registry. Requests to bind will
   // be handled by |factory|. Returns true if the interface was exposed, false
   // if Connection policy prevented exposure.
   template <typename Interface>
   bool AddInterface(InterfaceFactory<Interface>* factory) {
     return SetInterfaceBinderForName(
         base::MakeUnique<internal::InterfaceFactoryBinder<Interface>>(factory),
         Interface::Name_);
@@ skipping 32 matching lines @@
   // Resumes incoming interface request binding.
   void ResumeBinding();
 
   // Populates a set with the interface names this registry can bind.
   void GetInterfaceNames(std::set<std::string>* interface_names);
 
   // Sets a closure to be run when the InterfaceProvider pipe is closed.
   void SetConnectionLostClosure(const base::Closure& connection_lost_closure);
 
  private:
-  using NameToInterfaceBinderMap =
+  using InterfaceNameToBinderMap =
       std::map<std::string, std::unique_ptr<InterfaceBinder>>;
 
   // mojom::InterfaceProvider:
   void GetInterface(const std::string& interface_name,
                     mojo::ScopedMessagePipeHandle handle) override;
 
   // Returns true if the binder was set, false if it was not set (e.g. by
   // some filtering policy preventing this interface from being exposed).
   bool SetInterfaceBinderForName(std::unique_ptr<InterfaceBinder> binder,
                                  const std::string& name);
 
   // Returns true if |remote_identity_| is allowed to bind |interface_name|,
   // according to capability policy.
   bool CanBindRequestForInterface(const std::string& interface_name) const;
 
+  // Called whenever |remote_interface_provider_spec_| changes to rebuild the
+  // contents of |exposed_interfaces_| and |expose_all_interfaces_|.
+  void RebuildExposedInterfaces();
+
   mojom::InterfaceProviderRequest pending_request_;
 
   mojo::Binding<mojom::InterfaceProvider> binding_;
-  Identity identity_;
-  InterfaceProviderSpec interface_provider_spec_;
+
   std::string name_;
 
-  // Metadata computed when Bind() is called:
+  // Initialized from static metadata in the host service's manifest.
+  Identity local_identity_;
+  InterfaceProviderSpec local_interface_provider_spec_;
+
+  // Initialized from static metadata in the remote service's manifest.
   Identity remote_identity_;
-  InterfaceSet allowed_interfaces_;
-  bool allow_all_interfaces_ = false;
+  // Initialized from static metadata in the remote service's manifest. May be
+  // mutated after the fact when a capability is dynamically granted via a call
+  // to GrantCapability().
+  InterfaceProviderSpec remote_interface_provider_spec_;
 
-  NameToInterfaceBinderMap name_to_binder_;
+  // Metadata computed whenever |remote_interface_provider_spec_| changes.
+  InterfaceSet exposed_interfaces_;
+  bool expose_all_interfaces_ = false;
+
+  // Contains every interface binder that has been registered with this
+  // InterfaceRegistry. Not all binders may be reachable depending on the
+  // capabilities requested by the remote. Only interfaces in
+  // exposed_interfaces_ may be bound. When |expose_all_interfaces_| is true,
+  // any interface may be bound.
+  InterfaceNameToBinderMap name_to_binder_;
   Binder default_binder_;
 
   bool is_paused_ = false;
 
   // Pending interface requests which can accumulate if GetInterface() is called
   // while binding is paused.
   std::queue<std::pair<std::string, mojo::ScopedMessagePipeHandle>>
       pending_interface_requests_;
 
   base::WeakPtrFactory<InterfaceRegistry> weak_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(InterfaceRegistry);
 };
 
 }  // namespace service_manager
 
 #endif  // SERVICES_SERVICE_MANAGER_PUBLIC_CPP_INTERFACE_REGISTRY_H_