extensions/browser/api/cast_channel/cast_channel_api.h

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef EXTENSIONS_BROWSER_API_CAST_CHANNEL_CAST_CHANNEL_API_H_
   6 #define EXTENSIONS_BROWSER_API_CAST_CHANNEL_CAST_CHANNEL_API_H_
   7
   8 #include <string>
   9
  10 #include "base/basictypes.h"
  11 #include "base/memory/ref_counted.h"
  12 #include "base/memory/scoped_ptr.h"
  13 #include "base/threading/thread_checker.h"
  14 #include "extensions/browser/api/api_resource_manager.h"
  15 #include "extensions/browser/api/async_api_function.h"
  16 #include "extensions/browser/api/cast_channel/cast_socket.h"
  17 #include "extensions/browser/browser_context_keyed_api_factory.h"
  18 #include "extensions/common/api/cast_channel.h"
  19
  20 class GURL;
  21 class CastChannelAPITest;
  22
  23 namespace content {
  24 class BrowserContext;
  25 }
  26
  27 namespace net {
  28 class IPEndPoint;
  29 }
  30
  31 namespace extensions {
  32
  33 namespace core_api {
  34 namespace cast_channel {
  35 class Logger;
  36 }  // namespace cast_channel
  37 }  // namespace core_api
  38
  39 namespace cast_channel = core_api::cast_channel;
  40
  41 class CastChannelAPI : public BrowserContextKeyedAPI {
  42  public:
  43   explicit CastChannelAPI(content::BrowserContext* context);
  44
  45   static CastChannelAPI* Get(content::BrowserContext* context);
  46
  47   // BrowserContextKeyedAPI implementation.
  48   static BrowserContextKeyedAPIFactory<CastChannelAPI>* GetFactoryInstance();
  49
  50   // Returns a pointer to the Logger member variable.
  51   // TODO(imcheng): Consider whether it is possible for this class to own the
  52   // CastSockets and make this class the sole owner of Logger.
  53   // Alternatively,
  54   // consider making Logger not ref-counted by passing a weak
  55   // reference of Logger to the CastSockets instead.
  56   scoped_refptr<cast_channel::Logger> GetLogger();
  57
  58   // Sets the CastSocket instance to be used for testing.
  59   void SetSocketForTest(scoped_ptr<cast_channel::CastSocket> socket_for_test);
  60
  61   // Returns a test CastSocket instance, if it is defined.
  62   // Otherwise returns a scoped_ptr with a NULL ptr value.
  63   scoped_ptr<cast_channel::CastSocket> GetSocketForTest();
  64
  65   // Returns the API browser context.
  66   content::BrowserContext* GetBrowserContext() const;
  67
  68  private:
  69   friend class BrowserContextKeyedAPIFactory<CastChannelAPI>;
  70   friend class ::CastChannelAPITest;
  71   friend class CastTransportDelegate;
  72
  73   ~CastChannelAPI() override;
  74
  75   // BrowserContextKeyedAPI implementation.
  76   static const char* service_name() { return "CastChannelAPI"; }
  77
  78   content::BrowserContext* const browser_context_;
  79   scoped_refptr<cast_channel::Logger> logger_;
  80   scoped_ptr<cast_channel::CastSocket> socket_for_test_;
  81
  82   DISALLOW_COPY_AND_ASSIGN(CastChannelAPI);
  83 };
  84
  85 class CastChannelAsyncApiFunction : public AsyncApiFunction {
  86  public:
  87   CastChannelAsyncApiFunction();
  88
  89  protected:
  90   ~CastChannelAsyncApiFunction() override;
  91
  92   // AsyncApiFunction:
  93   bool PrePrepare() override;
  94   bool Respond() override;
  95
  96   // Returns the socket corresponding to |channel_id| if one exists.  Otherwise,
  97   // sets the function result with CHANNEL_ERROR_INVALID_CHANNEL_ID, completes
  98   // the function, and returns null.
  99   cast_channel::CastSocket* GetSocketOrCompleteWithError(int channel_id);
 100
 101   // Adds |socket| to |manager_| and returns the new channel_id.  |manager_|
 102   // assumes ownership of |socket|.
 103   int AddSocket(cast_channel::CastSocket* socket);
 104
 105   // Removes the CastSocket corresponding to |channel_id| from the resource
 106   // manager.
 107   void RemoveSocket(int channel_id);
 108
 109   // Sets the function result to a ChannelInfo obtained from the state of
 110   // |socket|.
 111   void SetResultFromSocket(const cast_channel::CastSocket& socket);
 112
 113   // Sets the function result to a ChannelInfo populated with |channel_id| and
 114   // |error|.
 115   void SetResultFromError(int channel_id, cast_channel::ChannelError error);
 116
 117   // Returns the socket corresponding to |channel_id| if one exists, or null
 118   // otherwise.
 119   cast_channel::CastSocket* GetSocket(int channel_id) const;
 120
 121  private:
 122   // Sets the function result from |channel_info|.
 123   void SetResultFromChannelInfo(const cast_channel::ChannelInfo& channel_info);
 124
 125   // The API resource manager for CastSockets.
 126   ApiResourceManager<cast_channel::CastSocket>* manager_;
 127 };
 128
 129 class CastChannelOpenFunction : public CastChannelAsyncApiFunction {
 130  public:
 131   CastChannelOpenFunction();
 132
 133  protected:
 134   ~CastChannelOpenFunction() override;
 135
 136   // AsyncApiFunction:
 137   bool PrePrepare() override;
 138   bool Prepare() override;
 139   void AsyncWorkStart() override;
 140
 141  private:
 142   DECLARE_EXTENSION_FUNCTION("cast.channel.open", CAST_CHANNEL_OPEN)
 143
 144   // Processes incoming cast message events and errors,
 145   // and provides additional API and socket context for those events.
 146   class CastMessageHandler : public cast_channel::CastTransport::Delegate {
 147    public:
 148     CastMessageHandler(CastChannelAPI* api, cast_channel::CastSocket* socket);
 149     ~CastMessageHandler() override;
 150
 151     void OnError(cast_channel::ChannelError error_state,
 152                  const cast_channel::LastErrors& last_errors) override;
 153     void OnMessage(const cast_channel::CastMessage& message) override;
 154
 155    private:
 156     CastChannelAPI* const api;
 157     cast_channel::CastSocket* const socket;
 158
 159     DISALLOW_COPY_AND_ASSIGN(CastMessageHandler);
 160   };
 161
 162   // Parses the cast:// or casts:// |url|, fills |connect_info| with the
 163   // corresponding details, and returns true. Returns false if |url| is not a
 164   // valid Cast URL.
 165   static bool ParseChannelUrl(const GURL& url,
 166                               cast_channel::ConnectInfo* connect_info);
 167
 168   // Validates that |connect_info| represents a valid IP end point and returns a
 169   // new IPEndPoint if so.  Otherwise returns NULL.
 170   static net::IPEndPoint* ParseConnectInfo(
 171       const cast_channel::ConnectInfo& connect_info);
 172
 173   void OnOpen(cast_channel::ChannelError result);
 174
 175   scoped_ptr<cast_channel::Open::Params> params_;
 176   // The id of the newly opened socket.
 177   int new_channel_id_;
 178   CastChannelAPI* api_;
 179   scoped_ptr<cast_channel::ConnectInfo> connect_info_;
 180   scoped_ptr<net::IPEndPoint> ip_endpoint_;
 181   cast_channel::ChannelAuthType channel_auth_;
 182
 183   FRIEND_TEST_ALL_PREFIXES(CastChannelOpenFunctionTest, TestParseChannelUrl);
 184   FRIEND_TEST_ALL_PREFIXES(CastChannelOpenFunctionTest, TestParseConnectInfo);
 185   DISALLOW_COPY_AND_ASSIGN(CastChannelOpenFunction);
 186 };
 187
 188 class CastChannelSendFunction : public CastChannelAsyncApiFunction {
 189  public:
 190   CastChannelSendFunction();
 191
 192  protected:
 193   ~CastChannelSendFunction() override;
 194
 195   // AsyncApiFunction:
 196   bool Prepare() override;
 197   void AsyncWorkStart() override;
 198
 199  private:
 200   DECLARE_EXTENSION_FUNCTION("cast.channel.send", CAST_CHANNEL_SEND)
 201
 202   void OnSend(int result);
 203
 204   scoped_ptr<cast_channel::Send::Params> params_;
 205
 206   DISALLOW_COPY_AND_ASSIGN(CastChannelSendFunction);
 207 };
 208
 209 class CastChannelCloseFunction : public CastChannelAsyncApiFunction {
 210  public:
 211   CastChannelCloseFunction();
 212
 213  protected:
 214   ~CastChannelCloseFunction() override;
 215
 216   // AsyncApiFunction:
 217   bool Prepare() override;
 218   void AsyncWorkStart() override;
 219
 220  private:
 221   DECLARE_EXTENSION_FUNCTION("cast.channel.close", CAST_CHANNEL_CLOSE)
 222
 223   void OnClose(int result);
 224
 225   scoped_ptr<cast_channel::Close::Params> params_;
 226
 227   DISALLOW_COPY_AND_ASSIGN(CastChannelCloseFunction);
 228 };
 229
 230 class CastChannelGetLogsFunction : public CastChannelAsyncApiFunction {
 231  public:
 232   CastChannelGetLogsFunction();
 233
 234  protected:
 235   ~CastChannelGetLogsFunction() override;
 236
 237   // AsyncApiFunction:
 238   bool PrePrepare() override;
 239   bool Prepare() override;
 240   void AsyncWorkStart() override;
 241
 242  private:
 243   DECLARE_EXTENSION_FUNCTION("cast.channel.getLogs", CAST_CHANNEL_GETLOGS)
 244
 245   CastChannelAPI* api_;
 246
 247   DISALLOW_COPY_AND_ASSIGN(CastChannelGetLogsFunction);
 248 };
 249
 250 class CastChannelSetAuthorityKeysFunction : public CastChannelAsyncApiFunction {
 251  public:
 252   CastChannelSetAuthorityKeysFunction();
 253
 254  protected:
 255   virtual ~CastChannelSetAuthorityKeysFunction();
 256
 257   // AsyncApiFunction:
 258   virtual bool Prepare() override;
 259   virtual void AsyncWorkStart() override;
 260
 261  private:
 262   DECLARE_EXTENSION_FUNCTION("cast.channel.setAuthorityKeys",
 263                              CAST_CHANNEL_SETAUTHORITYKEYS)
 264
 265   scoped_ptr<cast_channel::SetAuthorityKeys::Params> params_;
 266
 267   DISALLOW_COPY_AND_ASSIGN(CastChannelSetAuthorityKeysFunction);
 268 };
 269
 270 }  // namespace extensions
 271
 272 #endif  // EXTENSIONS_BROWSER_API_CAST_CHANNEL_CAST_CHANNEL_API_H_