extensions/browser/api/web_view/web_view_internal_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_WEB_VIEW_WEB_VIEW_INTERNAL_API_H_
   6 #define EXTENSIONS_BROWSER_API_WEB_VIEW_WEB_VIEW_INTERNAL_API_H_
   7
   8 #include "extensions/browser/api/capture_web_contents_function.h"
   9 #include "extensions/browser/api/execute_code_function.h"
  10 #include "extensions/browser/extension_function.h"
  11 #include "extensions/browser/guest_view/web_view/web_view_guest.h"
  12
  13 // WARNING: WebViewInternal could be loaded in an unblessed context, thus any
  14 // new APIs must extend WebViewInternalExtensionFunction or
  15 // WebViewInternalExecuteCodeFunction which do a process ID check to prevent
  16 // abuse by normal renderer processes.
  17 namespace extensions {
  18
  19 // An abstract base class for async webview APIs. It does a process ID check
  20 // in RunAsync, and then calls RunAsyncSafe which must be overriden by all
  21 // subclasses.
  22 class WebViewInternalExtensionFunction : public AsyncExtensionFunction {
  23  public:
  24   WebViewInternalExtensionFunction() {}
  25
  26  protected:
  27   ~WebViewInternalExtensionFunction() override {}
  28
  29   // ExtensionFunction implementation.
  30   bool RunAsync() final;
  31
  32  private:
  33   virtual bool RunAsyncSafe(WebViewGuest* guest) = 0;
  34 };
  35
  36 class WebViewInternalNavigateFunction
  37     : public WebViewInternalExtensionFunction {
  38  public:
  39   DECLARE_EXTENSION_FUNCTION("webViewInternal.navigate",
  40                              WEBVIEWINTERNAL_NAVIGATE);
  41   WebViewInternalNavigateFunction() {}
  42
  43  protected:
  44   ~WebViewInternalNavigateFunction() override {}
  45
  46  private:
  47   // WebViewInternalExtensionFunction implementation.
  48   bool RunAsyncSafe(WebViewGuest* guest) override;
  49
  50   DISALLOW_COPY_AND_ASSIGN(WebViewInternalNavigateFunction);
  51 };
  52
  53 class WebViewInternalExecuteCodeFunction
  54     : public extensions::ExecuteCodeFunction {
  55  public:
  56   WebViewInternalExecuteCodeFunction();
  57
  58  protected:
  59   ~WebViewInternalExecuteCodeFunction() override;
  60
  61   // Initialize |details_| if it hasn't already been.
  62   bool Init() override;
  63   bool ShouldInsertCSS() const override;
  64   bool CanExecuteScriptOnPage() override;
  65   // Guarded by a process ID check.
  66   extensions::ScriptExecutor* GetScriptExecutor() final;
  67   bool IsWebView() const override;
  68   const GURL& GetWebViewSrc() const override;
  69
  70  private:
  71   // Contains extension resource built from path of file which is
  72   // specified in JSON arguments.
  73   extensions::ExtensionResource resource_;
  74
  75   int guest_instance_id_;
  76
  77   GURL guest_src_;
  78
  79   DISALLOW_COPY_AND_ASSIGN(WebViewInternalExecuteCodeFunction);
  80 };
  81
  82 class WebViewInternalExecuteScriptFunction
  83     : public WebViewInternalExecuteCodeFunction {
  84  public:
  85   WebViewInternalExecuteScriptFunction();
  86
  87  protected:
  88   ~WebViewInternalExecuteScriptFunction() override {}
  89
  90   void OnExecuteCodeFinished(const std::string& error,
  91                              const GURL& on_url,
  92                              const base::ListValue& result) override;
  93
  94   DECLARE_EXTENSION_FUNCTION("webViewInternal.executeScript",
  95                              WEBVIEWINTERNAL_EXECUTESCRIPT)
  96
  97  private:
  98   DISALLOW_COPY_AND_ASSIGN(WebViewInternalExecuteScriptFunction);
  99 };
 100
 101 class WebViewInternalInsertCSSFunction
 102     : public WebViewInternalExecuteCodeFunction {
 103  public:
 104   WebViewInternalInsertCSSFunction();
 105
 106  protected:
 107   ~WebViewInternalInsertCSSFunction() override {}
 108
 109   bool ShouldInsertCSS() const override;
 110
 111   DECLARE_EXTENSION_FUNCTION("webViewInternal.insertCSS",
 112                              WEBVIEWINTERNAL_INSERTCSS)
 113
 114  private:
 115   DISALLOW_COPY_AND_ASSIGN(WebViewInternalInsertCSSFunction);
 116 };
 117
 118 class WebViewInternalCaptureVisibleRegionFunction
 119     : public extensions::CaptureWebContentsFunction {
 120   DECLARE_EXTENSION_FUNCTION("webViewInternal.captureVisibleRegion",
 121                              WEBVIEWINTERNAL_CAPTUREVISIBLEREGION);
 122
 123   WebViewInternalCaptureVisibleRegionFunction();
 124
 125  protected:
 126   ~WebViewInternalCaptureVisibleRegionFunction() override;
 127
 128  private:
 129   // extensions::CaptureWebContentsFunction implementation.
 130   bool IsScreenshotEnabled() override;
 131   content::WebContents* GetWebContentsForID(int id) override;
 132   void OnCaptureFailure(FailureReason reason) override;
 133
 134   DISALLOW_COPY_AND_ASSIGN(WebViewInternalCaptureVisibleRegionFunction);
 135 };
 136
 137 class WebViewInternalSetNameFunction : public WebViewInternalExtensionFunction {
 138  public:
 139   DECLARE_EXTENSION_FUNCTION("webViewInternal.setName",
 140                              WEBVIEWINTERNAL_SETNAME);
 141
 142   WebViewInternalSetNameFunction();
 143
 144  protected:
 145   ~WebViewInternalSetNameFunction() override;
 146
 147  private:
 148   bool RunAsyncSafe(WebViewGuest* guest) override;
 149
 150   DISALLOW_COPY_AND_ASSIGN(WebViewInternalSetNameFunction);
 151 };
 152
 153 class WebViewInternalSetAllowTransparencyFunction :
 154     public WebViewInternalExtensionFunction {
 155  public:
 156   DECLARE_EXTENSION_FUNCTION("webViewInternal.setAllowTransparency",
 157                              WEBVIEWINTERNAL_SETALLOWTRANSPARENCY);
 158
 159   WebViewInternalSetAllowTransparencyFunction();
 160
 161  protected:
 162   ~WebViewInternalSetAllowTransparencyFunction() override;
 163
 164  private:
 165   bool RunAsyncSafe(WebViewGuest* guest) override;
 166
 167   DISALLOW_COPY_AND_ASSIGN(WebViewInternalSetAllowTransparencyFunction);
 168 };
 169
 170 class WebViewInternalSetZoomFunction : public WebViewInternalExtensionFunction {
 171  public:
 172   DECLARE_EXTENSION_FUNCTION("webViewInternal.setZoom",
 173                              WEBVIEWINTERNAL_SETZOOM);
 174
 175   WebViewInternalSetZoomFunction();
 176
 177  protected:
 178   ~WebViewInternalSetZoomFunction() override;
 179
 180  private:
 181   bool RunAsyncSafe(WebViewGuest* guest) override;
 182
 183   DISALLOW_COPY_AND_ASSIGN(WebViewInternalSetZoomFunction);
 184 };
 185
 186 class WebViewInternalGetZoomFunction : public WebViewInternalExtensionFunction {
 187  public:
 188   DECLARE_EXTENSION_FUNCTION("webViewInternal.getZoom",
 189                              WEBVIEWINTERNAL_GETZOOM);
 190
 191   WebViewInternalGetZoomFunction();
 192
 193  protected:
 194   ~WebViewInternalGetZoomFunction() override;
 195
 196  private:
 197   bool RunAsyncSafe(WebViewGuest* guest) override;
 198
 199   DISALLOW_COPY_AND_ASSIGN(WebViewInternalGetZoomFunction);
 200 };
 201
 202 class WebViewInternalFindFunction : public WebViewInternalExtensionFunction {
 203  public:
 204   DECLARE_EXTENSION_FUNCTION("webViewInternal.find", WEBVIEWINTERNAL_FIND);
 205
 206   WebViewInternalFindFunction();
 207
 208   // Exposes SendResponse() for use by WebViewInternalFindHelper.
 209   using WebViewInternalExtensionFunction::SendResponse;
 210
 211  protected:
 212   ~WebViewInternalFindFunction() override;
 213
 214  private:
 215   // WebViewInternalExtensionFunction implementation.
 216   bool RunAsyncSafe(WebViewGuest* guest) override;
 217
 218   DISALLOW_COPY_AND_ASSIGN(WebViewInternalFindFunction);
 219 };
 220
 221 class WebViewInternalStopFindingFunction
 222     : public WebViewInternalExtensionFunction {
 223  public:
 224   DECLARE_EXTENSION_FUNCTION("webViewInternal.stopFinding",
 225                              WEBVIEWINTERNAL_STOPFINDING);
 226
 227   WebViewInternalStopFindingFunction();
 228
 229  protected:
 230   ~WebViewInternalStopFindingFunction() override;
 231
 232  private:
 233   // WebViewInternalExtensionFunction implementation.
 234   bool RunAsyncSafe(WebViewGuest* guest) override;
 235
 236   DISALLOW_COPY_AND_ASSIGN(WebViewInternalStopFindingFunction);
 237 };
 238
 239 class WebViewInternalLoadDataWithBaseUrlFunction
 240     : public WebViewInternalExtensionFunction {
 241  public:
 242   DECLARE_EXTENSION_FUNCTION("webViewInternal.loadDataWithBaseUrl",
 243                              WEBVIEWINTERNAL_LOADDATAWITHBASEURL);
 244
 245   WebViewInternalLoadDataWithBaseUrlFunction();
 246
 247  protected:
 248   ~WebViewInternalLoadDataWithBaseUrlFunction() override;
 249
 250  private:
 251   bool RunAsyncSafe(WebViewGuest* guest) override;
 252
 253   DISALLOW_COPY_AND_ASSIGN(WebViewInternalLoadDataWithBaseUrlFunction);
 254 };
 255
 256 class WebViewInternalGoFunction : public WebViewInternalExtensionFunction {
 257  public:
 258   DECLARE_EXTENSION_FUNCTION("webViewInternal.go", WEBVIEWINTERNAL_GO);
 259
 260   WebViewInternalGoFunction();
 261
 262  protected:
 263   ~WebViewInternalGoFunction() override;
 264
 265  private:
 266   // WebViewInternalExtensionFunction implementation.
 267   bool RunAsyncSafe(WebViewGuest* guest) override;
 268
 269   DISALLOW_COPY_AND_ASSIGN(WebViewInternalGoFunction);
 270 };
 271
 272 class WebViewInternalReloadFunction : public WebViewInternalExtensionFunction {
 273  public:
 274   DECLARE_EXTENSION_FUNCTION("webViewInternal.reload", WEBVIEWINTERNAL_RELOAD);
 275
 276   WebViewInternalReloadFunction();
 277
 278  protected:
 279   ~WebViewInternalReloadFunction() override;
 280
 281  private:
 282   // WebViewInternalExtensionFunction implementation.
 283   bool RunAsyncSafe(WebViewGuest* guest) override;
 284
 285   DISALLOW_COPY_AND_ASSIGN(WebViewInternalReloadFunction);
 286 };
 287
 288 class WebViewInternalSetPermissionFunction
 289     : public WebViewInternalExtensionFunction {
 290  public:
 291   DECLARE_EXTENSION_FUNCTION("webViewInternal.setPermission",
 292                              WEBVIEWINTERNAL_SETPERMISSION);
 293
 294   WebViewInternalSetPermissionFunction();
 295
 296  protected:
 297   ~WebViewInternalSetPermissionFunction() override;
 298
 299  private:
 300   // WebViewInternalExtensionFunction implementation.
 301   bool RunAsyncSafe(WebViewGuest* guest) override;
 302
 303   DISALLOW_COPY_AND_ASSIGN(WebViewInternalSetPermissionFunction);
 304 };
 305
 306 class WebViewInternalOverrideUserAgentFunction
 307     : public WebViewInternalExtensionFunction {
 308  public:
 309   DECLARE_EXTENSION_FUNCTION("webViewInternal.overrideUserAgent",
 310                              WEBVIEWINTERNAL_OVERRIDEUSERAGENT);
 311
 312   WebViewInternalOverrideUserAgentFunction();
 313
 314  protected:
 315   ~WebViewInternalOverrideUserAgentFunction() override;
 316
 317  private:
 318   // WebViewInternalExtensionFunction implementation.
 319   bool RunAsyncSafe(WebViewGuest* guest) override;
 320
 321   DISALLOW_COPY_AND_ASSIGN(WebViewInternalOverrideUserAgentFunction);
 322 };
 323
 324 class WebViewInternalStopFunction : public WebViewInternalExtensionFunction {
 325  public:
 326   DECLARE_EXTENSION_FUNCTION("webViewInternal.stop", WEBVIEWINTERNAL_STOP);
 327
 328   WebViewInternalStopFunction();
 329
 330  protected:
 331   ~WebViewInternalStopFunction() override;
 332
 333  private:
 334   // WebViewInternalExtensionFunction implementation.
 335   bool RunAsyncSafe(WebViewGuest* guest) override;
 336
 337   DISALLOW_COPY_AND_ASSIGN(WebViewInternalStopFunction);
 338 };
 339
 340 class WebViewInternalTerminateFunction
 341     : public WebViewInternalExtensionFunction {
 342  public:
 343   DECLARE_EXTENSION_FUNCTION("webViewInternal.terminate",
 344                              WEBVIEWINTERNAL_TERMINATE);
 345
 346   WebViewInternalTerminateFunction();
 347
 348  protected:
 349   ~WebViewInternalTerminateFunction() override;
 350
 351  private:
 352   // WebViewInternalExtensionFunction implementation.
 353   bool RunAsyncSafe(WebViewGuest* guest) override;
 354
 355   DISALLOW_COPY_AND_ASSIGN(WebViewInternalTerminateFunction);
 356 };
 357
 358 class WebViewInternalClearDataFunction
 359     : public WebViewInternalExtensionFunction {
 360  public:
 361   DECLARE_EXTENSION_FUNCTION("webViewInternal.clearData",
 362                              WEBVIEWINTERNAL_CLEARDATA);
 363
 364   WebViewInternalClearDataFunction();
 365
 366  protected:
 367   ~WebViewInternalClearDataFunction() override;
 368
 369  private:
 370   // WebViewInternalExtensionFunction implementation.
 371   bool RunAsyncSafe(WebViewGuest* guest) override;
 372
 373   uint32 GetRemovalMask();
 374   void ClearDataDone();
 375
 376   // Removal start time.
 377   base::Time remove_since_;
 378   // Removal mask, corresponds to StoragePartition::RemoveDataMask enum.
 379   uint32 remove_mask_;
 380   // Tracks any data related or parse errors.
 381   bool bad_message_;
 382
 383   DISALLOW_COPY_AND_ASSIGN(WebViewInternalClearDataFunction);
 384 };
 385
 386 }  // namespace extensions
 387
 388 #endif  // CHROME_BROWSER_EXTENSIONS_API_WEB_VIEW_WEB_VIEW_INTERNAL_API_H_