src/third_party/WebKit/Source/bindings/v8/DOMWrapperWorld.h

   1 /*
   2  * Copyright (C) 2009 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef DOMWrapperWorld_h
  32 #define DOMWrapperWorld_h
  33
  34 #include "bindings/v8/V8DOMActivityLogger.h"
  35 #include "bindings/v8/V8PerContextData.h"
  36 #include "platform/weborigin/SecurityOrigin.h"
  37 #include <v8.h>
  38 #include "wtf/PassRefPtr.h"
  39 #include "wtf/RefCounted.h"
  40 #include "wtf/RefPtr.h"
  41 #include "wtf/text/WTFString.h"
  42
  43 namespace WebCore {
  44
  45 class DOMDataStore;
  46 class ScriptController;
  47 class ExecutionContext;
  48
  49 enum WorldIdConstants {
  50     MainWorldId = 0,
  51     // Embedder isolated worlds can use IDs in [1, 1<<29).
  52     EmbedderWorldIdLimit = (1 << 29),
  53     ScriptPreprocessorIsolatedWorldId,
  54     WorkerWorldId,
  55 };
  56
  57 // This class represent a collection of DOM wrappers for a specific world.
  58 class DOMWrapperWorld : public RefCounted<DOMWrapperWorld> {
  59 public:
  60     static PassRefPtr<DOMWrapperWorld> create(int worldId, int extensionGroup);
  61
  62     static const int mainWorldExtensionGroup = 0;
  63     static PassRefPtr<DOMWrapperWorld> ensureIsolatedWorld(int worldId, int extensionGroup);
  64     ~DOMWrapperWorld();
  65
  66     static bool isolatedWorldsExist() { return isolatedWorldCount; }
  67     static void getAllWorldsInMainThread(Vector<RefPtr<DOMWrapperWorld> >& worlds);
  68
  69     static DOMWrapperWorld* world(v8::Handle<v8::Context> context)
  70     {
  71         ASSERT(contextHasCorrectPrototype(context));
  72         return V8PerContextDataHolder::from(context)->world();
  73     }
  74
  75     // Will return null if there is no DOMWrapperWorld for the current v8::Context
  76     static DOMWrapperWorld* current(v8::Isolate*);
  77     static DOMWrapperWorld* mainWorld();
  78
  79     // Associates an isolated world (see above for description) with a security
  80     // origin. XMLHttpRequest instances used in that world will be considered
  81     // to come from that origin, not the frame's.
  82     static void setIsolatedWorldSecurityOrigin(int worldID, PassRefPtr<SecurityOrigin>);
  83     static void clearIsolatedWorldSecurityOrigin(int worldID);
  84     SecurityOrigin* isolatedWorldSecurityOrigin();
  85
  86     // Associated an isolated world with a Content Security Policy. Resources
  87     // embedded into the main world's DOM from script executed in an isolated
  88     // world should be restricted based on the isolated world's DOM, not the
  89     // main world's.
  90     //
  91     // FIXME: Right now, resource injection simply bypasses the main world's
  92     // DOM. More work is necessary to allow the isolated world's policy to be
  93     // applied correctly.
  94     static void setIsolatedWorldContentSecurityPolicy(int worldID, const String& policy);
  95     static void clearIsolatedWorldContentSecurityPolicy(int worldID);
  96     bool isolatedWorldHasContentSecurityPolicy();
  97
  98     // Associate a logger with the world identified by worldId (worlId may be 0
  99     // identifying the main world).
 100     static void setActivityLogger(int worldId, PassOwnPtr<V8DOMActivityLogger>);
 101     static V8DOMActivityLogger* activityLogger(int worldId);
 102
 103     bool isMainWorld() const { return m_worldId == MainWorldId; }
 104     bool isWorkerWorld() const { return m_worldId == WorkerWorldId; }
 105     bool isIsolatedWorld() const { return !isMainWorld() && !isWorkerWorld(); }
 106
 107     int worldId() const { return m_worldId; }
 108     int extensionGroup() const { return m_extensionGroup; }
 109     DOMDataStore& domDataStore() { return *m_domDataStore; }
 110
 111 private:
 112     static unsigned isolatedWorldCount;
 113
 114     DOMWrapperWorld(int worldId, int extensionGroup);
 115     static bool contextHasCorrectPrototype(v8::Handle<v8::Context>);
 116
 117     const int m_worldId;
 118     const int m_extensionGroup;
 119     OwnPtr<DOMDataStore> m_domDataStore;
 120 };
 121
 122 } // namespace WebCore
 123
 124 #endif // DOMWrapperWorld_h