summaryrefslogtreecommitdiffstats
path: root/webkit/glue/glue_serialize.cc
blob: 0850e1bb615143975c8ba98dd592addd87ec225b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
// Copyright (c) 2006-2008 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "config.h"
#include <string>

#include "base/compiler_specific.h"

MSVC_PUSH_WARNING_LEVEL(0);
#include "HistoryItem.h"
#include "PlatformString.h"
#include "ResourceRequest.h"
MSVC_POP_WARNING();
#undef LOG

#include "webkit/glue/glue_serialize.h"

#include "base/pickle.h"
#include "base/string_util.h"
#include "webkit/glue/glue_util.h"
#include "webkit/glue/webkit_glue.h"

using namespace WebCore;

namespace webkit_glue {

struct SerializeObject {
  SerializeObject() : iter(NULL) {}
  SerializeObject(const char* data, int len) : pickle(data, len), iter(NULL) {}

  std::string GetAsString() {
    return std::string(static_cast<const char*>(pickle.data()), pickle.size());
  }

  Pickle pickle;
  mutable void* iter;
  mutable int version;
};

// TODO(mpcomplete): obsolete versions 1 and 2 after 1/1/2008.
// Version ID used in reading/writing history items.
// 1: Initial revision.
// 2: Added case for NULL string versus "". Version 2 code can read Version 1
//    data, but not vice versa.
// 3: Version 2 was broken, it stored number of UChars, not number of bytes.
//    This version checks and reads v1 and v2 correctly.
// 4: Adds support for storing FormData::identifier().
// 5: Adds support for empty FormData
// Should be const, but unit tests may modify it.
int kVersion = 5;

// A bunch of convenience functions to read/write to SerializeObjects.
// The serializers assume the input data is in the correct format and so does
// no error checking.
inline void WriteData(const void* data, int length, SerializeObject* obj) {
  obj->pickle.WriteData(static_cast<const char*>(data), length);
}

inline void ReadData(const SerializeObject* obj, const void** data,
                     int* length) {
  const char* tmp;
  obj->pickle.ReadData(&obj->iter, &tmp, length);
  *data = tmp;
}

inline bool ReadBytes(const SerializeObject* obj, const void** data,
                     int length) {
  const char *tmp;
  if (!obj->pickle.ReadBytes(&obj->iter, &tmp, length))
    return false;
  *data = tmp;
  return true;
}

inline void WriteInteger(int data, SerializeObject* obj) {
  obj->pickle.WriteInt(data);
}

inline int ReadInteger(const SerializeObject* obj) {
  int tmp = 0;
  obj->pickle.ReadInt(&obj->iter, &tmp);
  return tmp;
}

inline void WriteInteger64(int64 data, SerializeObject* obj) {
  obj->pickle.WriteInt64(data);
}

inline int64 ReadInteger64(const SerializeObject* obj) {
  int64 tmp = 0;
  obj->pickle.ReadInt64(&obj->iter, &tmp);
  return tmp;
}

inline void WriteReal(double data, SerializeObject* obj) {
  WriteData(&data, sizeof(double), obj);
}

inline double ReadReal(const SerializeObject* obj) {
  const void* tmp;
  int length;
  ReadData(obj, &tmp, &length);
  return *static_cast<const double*>(tmp);
}

inline void WriteBoolean(bool data, SerializeObject* obj) {
  obj->pickle.WriteInt(data ? 1 : 0);
}

inline bool ReadBoolean(const SerializeObject* obj) {
  bool tmp;
  obj->pickle.ReadBool(&obj->iter, &tmp);
  return tmp;
}

// Read/WriteString pickle the String as <int length><UChar* data>.
// If length == -1, then the String itself is NULL (String()).
// Otherwise the length is the number of UChars (not bytes) in the String.
inline void WriteString(const String& data, SerializeObject* obj) {
  switch (kVersion) {
    case 1:
      // Version 1 writes <length in bytes><string data>.
      // It saves String() and "" as "".
      obj->pickle.WriteInt(data.length() * sizeof(UChar));
      obj->pickle.WriteBytes(data.characters(), data.length() * sizeof(UChar));
      break;
    case 2:
      // Version 2 writes <length in UChars><string data>.
      // It uses -1 in the length field to mean String().
      if (data.isNull()) {
        obj->pickle.WriteInt(-1);
      } else {
        obj->pickle.WriteInt(data.length());
        obj->pickle.WriteBytes(data.characters(),
                               data.length() * sizeof(UChar));
      }
      break;
    default:
      // Version 3+ writes <length in bytes><string data>.
      // It uses -1 in the length field to mean String().
      if (data.isNull()) {
        obj->pickle.WriteInt(-1);
      } else {
        obj->pickle.WriteInt(data.length() * sizeof(UChar));
        obj->pickle.WriteBytes(data.characters(),
                               data.length() * sizeof(UChar));
      }
      break;
  }
}

// This reads a serialized String from obj. If a string can't be read,
// String() is returned.
inline String ReadString(const SerializeObject* obj) {
  int length;

  // Versions 1, 2, and 3 all start with an integer.
  if (!obj->pickle.ReadInt(&obj->iter, &length))
    return String();

  // Starting with version 2, -1 means String().
  if (length == -1)
    return String();

  // In version 2, the length field was the length in UChars.
  // In version 1 and 3 it is the length in bytes.
  int bytes = ((obj->version == 2) ? length * sizeof(UChar) : length);

  const void* data;
  if (!ReadBytes(obj, &data, bytes))
    return String();
  return String(static_cast<const UChar*>(data), bytes / sizeof(UChar));
}

// Writes a Vector of Strings into a SerializeObject for serialization.
static void WriteStringVector(const Vector<String>& data, SerializeObject* obj) {
  WriteInteger(static_cast<int>(data.size()), obj);
  for (size_t i = 0, c = data.size(); i < c; ++i) {
    unsigned ui = static_cast<unsigned>(i);  // sigh
    WriteString(data[ui], obj);
  }
}

static void ReadStringVector(const SerializeObject* obj, Vector<String>* data) {
  int num_elements = ReadInteger(obj);
  data->reserveCapacity(num_elements);
  for (int i = 0; i < num_elements; ++i) {
    data->append(ReadString(obj));
  }
}

// Writes a FormData object into a SerializeObject for serialization.
static void WriteFormData(const FormData* form_data, SerializeObject* obj) {
  WriteBoolean(form_data != NULL, obj);

  if (!form_data)
    return;

  WriteInteger(static_cast<int>(form_data->elements().size()), obj);
  for (size_t i = 0, c = form_data->elements().size(); i < c; ++i) {
    const FormDataElement& e = form_data->elements().at(i);
    WriteInteger(e.m_type, obj);

    if (e.m_type == FormDataElement::data) {
      WriteData(e.m_data.data(), static_cast<int>(e.m_data.size()), obj);
    } else {
      WriteString(e.m_filename, obj);
    }
  }
  WriteInteger64(form_data->identifier(), obj);
}

static PassRefPtr<FormData> ReadFormData(const SerializeObject* obj) {
  // In newer versions, an initial boolean indicates if we have form data.
  if (obj->version >= 5 && !ReadBoolean(obj))
    return NULL;

  // In older versions, 0 elements implied no form data.
  int num_elements = ReadInteger(obj);
  if (num_elements == 0 && obj->version < 5)
    return NULL;

  RefPtr<FormData> form_data = FormData::create();

  for (int i = 0; i < num_elements; ++i) {
    int type = ReadInteger(obj);
    if (type == FormDataElement::data) {
      const void* data;
      int length;
      ReadData(obj, &data, &length);
      form_data->appendData(static_cast<const char*>(data), length);
    } else {
      form_data->appendFile(ReadString(obj));
    }
  }
  if (obj->version >= 4)
    form_data->setIdentifier(ReadInteger64(obj));

  return form_data.release();
}

// Writes the HistoryItem data into the SerializeObject object for
// serialization.
static void WriteHistoryItem(const HistoryItem* item, SerializeObject* obj) {
  // WARNING: This data may be persisted for later use. As such, care must be
  // taken when changing the serialized format. If a new field needs to be
  // written, only adding at the end will make it easier to deal with loading
  // older versions. Similarly, this should NOT save fields with sensitive
  // data, such as password fields.
  WriteInteger(kVersion, obj);
  WriteString(item->urlString(), obj);
  WriteString(item->originalURLString(), obj);
  WriteString(item->target(), obj);
  WriteString(item->parent(), obj);
  WriteString(item->title(), obj);
  WriteString(item->alternateTitle(), obj);
  WriteReal(item->lastVisitedTime(), obj);
  WriteInteger(item->scrollPoint().x(), obj);
  WriteInteger(item->scrollPoint().y(), obj);
  WriteBoolean(item->isTargetItem(), obj);
  WriteInteger(item->visitCount(), obj);
  WriteString(item->referrer(), obj);

  WriteStringVector(item->documentState(), obj);

  // No access to formData through a const HistoryItem = lame.
  WriteFormData(const_cast<HistoryItem*>(item)->formData(), obj);
  WriteString(item->formContentType(), obj);
  WriteString(item->referrer(), obj);

  // Subitems
  WriteInteger(static_cast<int>(item->children().size()), obj);
  for (size_t i = 0, c = item->children().size(); i < c; ++i)
    WriteHistoryItem(item->children().at(i).get(), obj);
}

// Creates a new HistoryItem tree based on the serialized string.
// Assumes the data is in the format returned by WriteHistoryItem.
static PassRefPtr<HistoryItem> ReadHistoryItem(const SerializeObject* obj,
                                               bool include_form_data) {
  // See note in WriteHistoryItem. on this.
  obj->version = ReadInteger(obj);

  if (obj->version > kVersion || obj->version < 1)
    return NULL;

  RefPtr<HistoryItem> item = HistoryItem::create();

  item->setURLString(ReadString(obj));
  item->setOriginalURLString(ReadString(obj));
  item->setTarget(ReadString(obj));
  item->setParent(ReadString(obj));
  item->setTitle(ReadString(obj));
  item->setAlternateTitle(ReadString(obj));
  item->setLastVisitedTime(ReadReal(obj));
  int x = ReadInteger(obj);
  int y = ReadInteger(obj);
  item->setScrollPoint(IntPoint(x, y));
  item->setIsTargetItem(ReadBoolean(obj));
  item->setVisitCount(ReadInteger(obj));
  item->setReferrer(ReadString(obj));

  Vector<String> document_state;
  ReadStringVector(obj, &document_state);
  item->setDocumentState(document_state);

  // Form data.  If there is any form data, we assume POST, otherwise GET.
  // FormData is ref counted.
  ResourceRequest dummy_request;  // only way to initialize HistoryItem
  dummy_request.setHTTPBody(ReadFormData(obj));
  dummy_request.setHTTPContentType(ReadString(obj));
  dummy_request.setHTTPReferrer(ReadString(obj));
  if (dummy_request.httpBody())
    dummy_request.setHTTPMethod("POST");
  if (include_form_data)
    item->setFormInfoFromRequest(dummy_request);

  // Subitems
  int num_children = ReadInteger(obj);
  for (int i = 0; i < num_children; ++i)
    item->addChildItem(ReadHistoryItem(obj, include_form_data));

  return item.release();
}

// Serialize a HistoryItem to a string, using our JSON Value serializer.
void HistoryItemToString(PassRefPtr<HistoryItem> item,
                         std::string* serialized_item) {
  if (!item) {
    serialized_item->clear();
    return;
  }

  SerializeObject obj;
  WriteHistoryItem(item.get(), &obj);
  *serialized_item = obj.GetAsString();
}

// Reconstruct a HistoryItem from a string, using our JSON Value deserializer.
// This assumes that the given serialized string has all the required key,value
// pairs, and does minimal error checking. If |include_form_data| is true,
// the form data from a post is restored, otherwise the form data is empty.
static PassRefPtr<HistoryItem> HistoryItemFromString(
    const std::string& serialized_item,
    bool include_form_data) {
  if (serialized_item.empty())
    return NULL;

  SerializeObject obj(serialized_item.data(),
                      static_cast<int>(serialized_item.length()));
  return ReadHistoryItem(&obj, include_form_data);
}

PassRefPtr<HistoryItem> HistoryItemFromString(
    const std::string& serialized_item) {
  return HistoryItemFromString(serialized_item, true);
}

// For testing purposes only.
void HistoryItemToVersionedString(PassRefPtr<HistoryItem> item, int version,
                                  std::string* serialized_item) {
  if (!item) {
    serialized_item->clear();
    return;
  }

  // Temporarily change the version.
  int real_version = kVersion;
  kVersion = version;

  SerializeObject obj;
  WriteHistoryItem(item.get(), &obj);
  *serialized_item = obj.GetAsString();

  kVersion = real_version;
}

std::string CreateHistoryStateForURL(const GURL& url) {
  // TODO(eseide): We probably should be passing a list visit time other than 0
  RefPtr<HistoryItem> item(HistoryItem::create(GURLToKURL(url), String(), 0));
  std::string data;
  HistoryItemToString(item, &data);
  return data;
}

std::string RemoveFormDataFromHistoryState(const std::string& content_state) {
  RefPtr<HistoryItem> history_item(HistoryItemFromString(content_state, false));
  if (!history_item.get()) {
    // Couldn't parse the string, return an empty string.
    return std::string();
  }
  std::string new_state;
  HistoryItemToString(history_item, &new_state);
  return new_state;
}

}  // namespace webkit_glue