1/*
2 * Copyright (C) 2009, 2010 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 SerializedScriptValue_h
32#define SerializedScriptValue_h
33
34#include "bindings/core/v8/ScriptValue.h"
35#include "wtf/HashMap.h"
36#include "wtf/ThreadSafeRefCounted.h"
37#include <v8.h>
38
39namespace WTF {
40
41class ArrayBuffer;
42class ArrayBufferContents;
43
44}
45
46namespace blink {
47
48class BlobDataHandle;
49class ExceptionState;
50class MessagePort;
51class WebBlobInfo;
52
53typedef WillBeHeapVector<RefPtrWillBeMember<MessagePort>, 1> MessagePortArray;
54typedef Vector<RefPtr<WTF::ArrayBuffer>, 1> ArrayBufferArray;
55typedef HashMap<String, RefPtr<BlobDataHandle> > BlobDataHandleMap;
56typedef Vector<blink::WebBlobInfo> WebBlobInfoArray;
57
58class SerializedScriptValue FINAL : public ThreadSafeRefCounted<SerializedScriptValue> {
59public:
60    // Increment this for each incompatible change to the wire format.
61    // Version 2: Added StringUCharTag for UChar v8 strings.
62    // Version 3: Switched to using uuids as blob data identifiers.
63    // Version 4: Extended File serialization to be complete.
64    // Version 5: Added CryptoKeyTag for Key objects.
65    // Version 6: Added indexed serialization for File, Blob, and FileList.
66    // Version 7: Extended File serialization with user visibility.
67    static const uint32_t wireFormatVersion = 7;
68
69    ~SerializedScriptValue();
70
71    // If a serialization error occurs (e.g., cyclic input value) this
72    // function returns an empty representation, schedules a V8 exception to
73    // be thrown using v8::ThrowException(), and sets |didThrow|. In this case
74    // the caller must not invoke any V8 operations until control returns to
75    // V8. When serialization is successful, |didThrow| is false.
76    static PassRefPtr<SerializedScriptValue> create(v8::Handle<v8::Value>, MessagePortArray*, ArrayBufferArray*, ExceptionState&, v8::Isolate*);
77    static PassRefPtr<SerializedScriptValue> createFromWire(const String&);
78    static PassRefPtr<SerializedScriptValue> createFromWireBytes(const Vector<uint8_t>&);
79    static PassRefPtr<SerializedScriptValue> create(const String&);
80    static PassRefPtr<SerializedScriptValue> create(const String&, v8::Isolate*);
81    static PassRefPtr<SerializedScriptValue> create();
82    static PassRefPtr<SerializedScriptValue> create(const ScriptValue&, WebBlobInfoArray*, ExceptionState&, v8::Isolate*);
83
84    // Never throws exceptions.
85    static PassRefPtr<SerializedScriptValue> createAndSwallowExceptions(v8::Handle<v8::Value>, v8::Isolate*);
86
87    static PassRefPtr<SerializedScriptValue> nullValue();
88
89    String toWireString() const { return m_data; }
90    void toWireBytes(Vector<char>&) const;
91
92    // Deserializes the value (in the current context). Returns a null value in
93    // case of failure.
94    v8::Handle<v8::Value> deserialize(MessagePortArray* = 0);
95    v8::Handle<v8::Value> deserialize(v8::Isolate*, MessagePortArray* = 0, const WebBlobInfoArray* = 0);
96
97    // Helper function which pulls the values out of a JS sequence and into a MessagePortArray.
98    // Also validates the elements per sections 4.1.13 and 4.1.15 of the WebIDL spec and section 8.3.3
99    // of the HTML5 spec and generates exceptions as appropriate.
100    // Returns true if the array was filled, or false if the passed value was not of an appropriate type.
101    static bool extractTransferables(v8::Local<v8::Value>, int, MessagePortArray&, ArrayBufferArray&, ExceptionState&, v8::Isolate*);
102
103    // Informs the V8 about external memory allocated and owned by this object. Large values should contribute
104    // to GC counters to eventually trigger a GC, otherwise flood of postMessage() can cause OOM.
105    // Ok to invoke multiple times (only adds memory once).
106    // The memory registration is revoked automatically in destructor.
107    void registerMemoryAllocatedWithCurrentScriptContext();
108
109private:
110    enum StringDataMode {
111        StringValue,
112        WireData
113    };
114    typedef Vector<WTF::ArrayBufferContents, 1> ArrayBufferContentsArray;
115
116    SerializedScriptValue();
117    SerializedScriptValue(v8::Handle<v8::Value>, MessagePortArray*, ArrayBufferArray*, WebBlobInfoArray*, ExceptionState&, v8::Isolate*);
118    explicit SerializedScriptValue(const String& wireData);
119
120    static PassOwnPtr<ArrayBufferContentsArray> transferArrayBuffers(ArrayBufferArray&, ExceptionState&, v8::Isolate*);
121
122    String m_data;
123    OwnPtr<ArrayBufferContentsArray> m_arrayBufferContentsArray;
124    BlobDataHandleMap m_blobDataHandles;
125    intptr_t m_externallyAllocatedMemory;
126};
127
128} // namespace blink
129
130#endif // SerializedScriptValue_h
131