1 files changed, 157 insertions, 0 deletions
diff --git a/content/browser/in_process_webkit/dom_storage_context.h b/content/browser/in_process_webkit/dom_storage_context.h
new file mode 100644
index 0000000..6810453
--- /dev/null
+++ b/content/browser/in_process_webkit/dom_storage_context.h
@@ -0,0 +1,157 @@
+// Copyright (c) 2010 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.
+
+#ifndef CONTENT_BROWSER_IN_PROCESS_WEBKIT_DOM_STORAGE_CONTEXT_H_
+#define CONTENT_BROWSER_IN_PROCESS_WEBKIT_DOM_STORAGE_CONTEXT_H_
+#pragma once
+
+#include <map>
+#include <set>
+
+#include "base/file_path.h"
+#include "base/string16.h"
+#include "base/time.h"
+
+class DOMStorageArea;
+class DOMStorageMessageFilter;
+class DOMStorageNamespace;
+class WebKitContext;
+
+// This is owned by WebKitContext and is all the dom storage information that's
+// shared by all the DOMStorageMessageFilters that share the same profile.  The
+// specifics of responsibilities are fairly well documented here and in
+// StorageNamespace and StorageArea.  Everything is only to be accessed on the
+// WebKit thread unless noted otherwise.
+//
+// NOTE: Virtual methods facilitate mocking functions for testing.
+class DOMStorageContext {
+ public:
+  explicit DOMStorageContext(WebKitContext* webkit_context);
+  virtual ~DOMStorageContext();
+
+  // Invalid storage id.  No storage session will ever report this value.
+  // Used in DOMStorageMessageFilter::OnStorageAreaId when coping with
+  // interactions with non-existent storage sessions.
+  static const int64 kInvalidStorageId = -1;
+
+  // Allocate a new storage area id.  Only call on the WebKit thread.
+  int64 AllocateStorageAreaId();
+
+  // Allocate a new session storage id.  Only call on the UI or IO thread.
+  int64 AllocateSessionStorageNamespaceId();
+
+  // Clones a session storage namespace and returns the cloned namespaces' id.
+  // Only call on the IO thread.
+  int64 CloneSessionStorage(int64 original_id);
+
+  // Various storage area methods.  The storage area is owned by one of the
+  // namespaces that's owned by this class.
+  void RegisterStorageArea(DOMStorageArea* storage_area);
+  void UnregisterStorageArea(DOMStorageArea* storage_area);
+  DOMStorageArea* GetStorageArea(int64 id);
+
+  // Called on WebKit thread when a session storage namespace can be deleted.
+  void DeleteSessionStorageNamespace(int64 namespace_id);
+
+  // Get a namespace from an id.  What's returned is owned by this class.  If
+  // allocation_allowed is true, then this function will create the storage
+  // namespace if it hasn't been already.
+  DOMStorageNamespace* GetStorageNamespace(int64 id, bool allocation_allowed);
+
+  // Sometimes an event from one DOM storage message filter requires
+  // communication to all of them.
+  typedef std::set<DOMStorageMessageFilter*> MessageFilterSet;
+  void RegisterMessageFilter(DOMStorageMessageFilter* message_filter);
+  void UnregisterMessageFilter(DOMStorageMessageFilter* MessageFilter);
+  const MessageFilterSet* GetMessageFilterSet() const;
+
+  // Tells storage namespaces to purge any memory they do not need.
+  virtual void PurgeMemory();
+
+  // Delete any local storage files that have been touched since the cutoff
+  // date that's supplied.
+  void DeleteDataModifiedSince(const base::Time& cutoff,
+                               const char* url_scheme_to_be_skipped,
+                               const std::vector<string16>& protected_origins);
+
+  // Deletes a single local storage file.
+  void DeleteLocalStorageFile(const FilePath& file_path);
+
+  // Deletes the local storage file for the given origin.
+  void DeleteLocalStorageForOrigin(const string16& origin_id);
+
+  // Deletes all local storage files.
+  void DeleteAllLocalStorageFiles();
+
+  // The local storage directory.
+  static const FilePath::CharType kLocalStorageDirectory[];
+
+  // The local storage file extension.
+  static const FilePath::CharType kLocalStorageExtension[];
+
+  // Get the file name of the local storage file for the given origin.
+  FilePath GetLocalStorageFilePath(const string16& origin_id) const;
+
+  void set_clear_local_state_on_exit_(bool clear_local_state) {
+    clear_local_state_on_exit_ = clear_local_state;
+  }
+
+#ifdef UNIT_TEST
+  // For unit tests allow to override the |data_path_|.
+  void set_data_path(const FilePath& data_path) { data_path_ = data_path; }
+#endif
+
+ private:
+  // Get the local storage instance.  The object is owned by this class.
+  DOMStorageNamespace* CreateLocalStorage();
+
+  // Get a new session storage namespace.  The object is owned by this class.
+  DOMStorageNamespace* CreateSessionStorage(int64 namespace_id);
+
+  // Used internally to register storage namespaces we create.
+  void RegisterStorageNamespace(DOMStorageNamespace* storage_namespace);
+
+  // The WebKit thread half of CloneSessionStorage above.  Static because
+  // DOMStorageContext isn't ref counted thus we can't use a runnable method.
+  // That said, we know this is safe because this class is destroyed on the
+  // WebKit thread, so there's no way it could be destroyed before this is run.
+  static void CompleteCloningSessionStorage(DOMStorageContext* context,
+                                            int64 existing_id, int64 clone_id);
+
+  // The last used storage_area_id and storage_namespace_id's.  For the storage
+  // namespaces, IDs allocated on the UI thread are positive and count up while
+  // IDs allocated on the IO thread are negative and count down.  This allows us
+  // to allocate unique IDs on both without any locking.  All storage area ids
+  // are allocated on the WebKit thread.
+  int64 last_storage_area_id_;
+  int64 last_session_storage_namespace_id_on_ui_thread_;
+  int64 last_session_storage_namespace_id_on_io_thread_;
+
+  // True if the destructor should delete its files.
+  bool clear_local_state_on_exit_;
+
+  // Path where the profile data is stored.
+  // TODO(pastarmovj): Keep in mind that unlike indexed db data_path_ variable
+  // this one still has to point to the upper level dir because of the
+  // MigrateLocalStorageDirectory function. Once this function disappears we can
+  // make it point directly to the dom storage path.
+  FilePath data_path_;
+
+  // All the DOMStorageMessageFilters that are attached to us. ONLY USE ON THE
+  // IO THREAD!
+  MessageFilterSet message_filter_set_;
+
+  // Maps ids to StorageAreas.  We do NOT own these objects.  StorageNamespace
+  // (which does own them) will notify us when we should remove the entries.
+  typedef std::map<int64, DOMStorageArea*> StorageAreaMap;
+  StorageAreaMap storage_area_map_;
+
+  // Maps ids to StorageNamespaces.  We own these objects.
+  typedef std::map<int64, DOMStorageNamespace*> StorageNamespaceMap;
+  StorageNamespaceMap storage_namespace_map_;
+
+  DISALLOW_IMPLICIT_CONSTRUCTORS(DOMStorageContext);
+};
+
+#endif  // CONTENT_BROWSER_IN_PROCESS_WEBKIT_DOM_STORAGE_CONTEXT_H_