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