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.
5 #include "content/renderer/history_serialization.h"
7 #include "content/common/page_state_serialization.h"
8 #include "content/public/common/page_state.h"
9 #include "content/renderer/history_entry.h"
10 #include "third_party/WebKit/public/platform/WebFloatPoint.h"
11 #include "third_party/WebKit/public/platform/WebHTTPBody.h"
12 #include "third_party/WebKit/public/platform/WebPoint.h"
13 #include "third_party/WebKit/public/platform/WebString.h"
14 #include "third_party/WebKit/public/platform/WebVector.h"
15 #include "third_party/WebKit/public/web/WebHistoryItem.h"
16 #include "third_party/WebKit/public/web/WebSerializedScriptValue.h"
18 using blink::WebHTTPBody;
19 using blink::WebHistoryItem;
20 using blink::WebSerializedScriptValue;
21 using blink::WebString;
22 using blink::WebVector;
27 void ToNullableString16Vector(const WebVector<WebString>& input,
28 std::vector<base::NullableString16>* output) {
29 output->reserve(input.size());
30 for (size_t i = 0; i < input.size(); ++i)
31 output->push_back(input[i]);
34 void ToExplodedHttpBodyElement(const WebHTTPBody::Element& input,
35 ExplodedHttpBodyElement* output) {
37 case WebHTTPBody::Element::TypeData:
38 output->data.assign(input.data.data(), input.data.size());
40 case WebHTTPBody::Element::TypeFile:
41 output->file_path = input.filePath;
42 output->file_start = input.fileStart;
43 output->file_length = input.fileLength;
44 output->file_modification_time = input.modificationTime;
46 case WebHTTPBody::Element::TypeFileSystemURL:
47 output->filesystem_url = input.fileSystemURL;
48 output->file_start = input.fileStart;
49 output->file_length = input.fileLength;
50 output->file_modification_time = input.modificationTime;
52 case WebHTTPBody::Element::TypeBlob:
53 output->blob_uuid = input.blobUUID.utf8();
58 void AppendHTTPBodyElement(const ExplodedHttpBodyElement& element,
59 WebHTTPBody* http_body) {
60 switch (element.type) {
61 case WebHTTPBody::Element::TypeData:
62 http_body->appendData(element.data);
64 case WebHTTPBody::Element::TypeFile:
65 http_body->appendFileRange(
69 element.file_modification_time);
71 case WebHTTPBody::Element::TypeFileSystemURL:
72 http_body->appendFileSystemURLRange(
73 element.filesystem_url,
76 element.file_modification_time);
78 case WebHTTPBody::Element::TypeBlob:
79 http_body->appendBlob(WebString::fromUTF8(element.blob_uuid));
84 void GenerateFrameStateFromItem(const WebHistoryItem& item,
85 ExplodedFrameState* state) {
86 state->url_string = item.urlString();
87 state->referrer = item.referrer();
88 state->referrer_policy = item.referrerPolicy();
89 state->target = item.target();
90 if (!item.stateObject().isNull())
91 state->state_object = item.stateObject().toString();
92 state->pinch_viewport_scroll_offset = item.pinchViewportScrollOffset();
93 state->scroll_offset = item.scrollOffset();
94 state->item_sequence_number = item.itemSequenceNumber();
95 state->document_sequence_number =
96 item.documentSequenceNumber();
97 state->page_scale_factor = item.pageScaleFactor();
98 ToNullableString16Vector(item.documentState(), &state->document_state);
100 state->http_body.http_content_type = item.httpContentType();
101 const WebHTTPBody& http_body = item.httpBody();
102 if (!(state->http_body.is_null = http_body.isNull())) {
103 state->http_body.identifier = http_body.identifier();
104 state->http_body.elements.resize(http_body.elementCount());
105 for (size_t i = 0; i < http_body.elementCount(); ++i) {
106 WebHTTPBody::Element element;
107 http_body.elementAt(i, element);
108 ToExplodedHttpBodyElement(element, &state->http_body.elements[i]);
110 state->http_body.contains_passwords = http_body.containsPasswordData();
114 void RecursivelyGenerateFrameState(HistoryEntry::HistoryNode* node,
115 ExplodedFrameState* state) {
116 GenerateFrameStateFromItem(node->item(), state);
118 std::vector<HistoryEntry::HistoryNode*>& children = node->children();
119 state->children.resize(children.size());
120 for (size_t i = 0; i < children.size(); ++i)
121 RecursivelyGenerateFrameState(children[i], &state->children[i]);
124 void RecursivelyGenerateHistoryItem(const ExplodedFrameState& state,
125 HistoryEntry::HistoryNode* node) {
128 item.setURLString(state.url_string);
129 item.setReferrer(state.referrer, state.referrer_policy);
130 item.setTarget(state.target);
131 if (!state.state_object.is_null()) {
133 WebSerializedScriptValue::fromString(state.state_object));
135 item.setDocumentState(state.document_state);
136 item.setPinchViewportScrollOffset(state.pinch_viewport_scroll_offset);
137 item.setScrollOffset(state.scroll_offset);
138 item.setPageScaleFactor(state.page_scale_factor);
140 // These values are generated at WebHistoryItem construction time, and we
141 // only want to override those new values with old values if the old values
142 // are defined. A value of 0 means undefined in this context.
143 if (state.item_sequence_number)
144 item.setItemSequenceNumber(state.item_sequence_number);
145 if (state.document_sequence_number)
146 item.setDocumentSequenceNumber(state.document_sequence_number);
148 item.setHTTPContentType(state.http_body.http_content_type);
149 if (!state.http_body.is_null) {
150 WebHTTPBody http_body;
151 http_body.initialize();
152 http_body.setIdentifier(state.http_body.identifier);
153 for (size_t i = 0; i < state.http_body.elements.size(); ++i)
154 AppendHTTPBodyElement(state.http_body.elements[i], &http_body);
155 item.setHTTPBody(http_body);
157 node->set_item(item);
159 for (size_t i = 0; i < state.children.size(); ++i)
160 RecursivelyGenerateHistoryItem(state.children[i], node->AddChild());
165 PageState HistoryEntryToPageState(HistoryEntry* entry) {
166 ExplodedPageState state;
167 ToNullableString16Vector(entry->root().getReferencedFilePaths(),
168 &state.referenced_files);
170 RecursivelyGenerateFrameState(entry->root_history_node(), &state.top);
172 std::string encoded_data;
173 if (!EncodePageState(state, &encoded_data))
176 return PageState::CreateFromEncodedData(encoded_data);
179 PageState SingleHistoryItemToPageState(const WebHistoryItem& item) {
180 ExplodedPageState state;
181 ToNullableString16Vector(item.getReferencedFilePaths(),
182 &state.referenced_files);
183 GenerateFrameStateFromItem(item, &state.top);
185 std::string encoded_data;
186 if (!EncodePageState(state, &encoded_data))
189 return PageState::CreateFromEncodedData(encoded_data);
192 scoped_ptr<HistoryEntry> PageStateToHistoryEntry(const PageState& page_state) {
193 ExplodedPageState state;
194 if (!DecodePageState(page_state.ToEncodedData(), &state))
195 return scoped_ptr<HistoryEntry>();
197 scoped_ptr<HistoryEntry> entry(new HistoryEntry());
198 RecursivelyGenerateHistoryItem(state.top, entry->root_history_node());
203 } // namespace content