Database support for GDataDirectoryService.

chrome/browser/chromeos/gdata/gdata_files.h

 // Copyright (c) 2012 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 CHROME_BROWSER_CHROMEOS_GDATA_GDATA_FILES_H_
 #define CHROME_BROWSER_CHROMEOS_GDATA_GDATA_FILES_H_
 
 #include <map>
 #include <string>
 
 #include "base/callback.h"
 #include "base/gtest_prod_util.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/memory/singleton.h"
 #include "base/memory/weak_ptr.h"
 #include "base/platform_file.h"
 #include "base/synchronization/lock.h"
 #include "chrome/browser/chromeos/gdata/gdata_params.h"
 #include "chrome/browser/chromeos/gdata/gdata_uploader.h"
 #include "chrome/browser/chromeos/gdata/gdata_wapi_parser.h"
 #include "chrome/browser/profiles/profile_keyed_service.h"
 #include "chrome/browser/profiles/profile_keyed_service_factory.h"
 
+namespace base {
+class SequencedTaskRunner;
+}
+
 namespace gdata {
 
+struct CreateDBParams;
 class GDataFile;
 class GDataDirectory;
 class GDataDirectoryService;
+class GDataDirectoryServiceDB;
 
 class GDataEntryProto;
 class GDataDirectoryProto;
 class GDataRootDirectoryProto;
 class PlatformFileInfoProto;
 
 // The root directory content origin.
 enum ContentOrigin {
   UNINITIALIZED,
   // Content is currently loading from somewhere.  Needs to wait.
@@ skipping 43 matching lines @@
   const GDataFile* AsGDataFileConst() const;
   const GDataDirectory* AsGDataDirectoryConst() const;
 
   // Converts DocumentEntry into GDataEntry.
   static GDataEntry* FromDocumentEntry(
       GDataDirectory* parent,
       DocumentEntry* doc,
       GDataDirectoryService* directory_service);
 
   // Serialize/Parse to/from string via proto classes.
-  // TODO(achuith): Correctly set up parent_ and root_ links in
-  // FromProtoString.
   void SerializeToString(std::string* serialized_proto) const;
+  // TODO(achuith): Get rid of this.

[satorux1, 2012/08/02 17:24:03]

Please add a url to the bug

[achuithb, 2012/08/02 20:26:25]

Done.

   static scoped_ptr<GDataEntry> FromProtoString(
       const std::string& serialized_proto);
 
   // Converts the proto representation to the platform file.
   static void ConvertProtoToPlatformFileInfo(
       const PlatformFileInfoProto& proto,
       base::PlatformFileInfo* file_info);
 
   // Converts the platform file info to the proto representation.
   static void ConvertPlatformFileInfoToProto(
       const base::PlatformFileInfo& file_info,
       PlatformFileInfoProto* proto);
 
   // Converts to/from proto. Only handles the common part (i.e. does not
-  // touch |file_specific_info| and |directory_specific_info|.
+  // touch |file_specific_info|).
   bool FromProto(const GDataEntryProto& proto) WARN_UNUSED_RESULT;
   void ToProto(GDataEntryProto* proto) const;
 
   // Similar to ToProto() but this fills in |file_specific_info| and
   // |directory_specific_info| based on the actual type of the entry.
   // Used to obtain full metadata of a file or a directory as
   // GDataEntryProto.
   void ToProtoFull(GDataEntryProto* proto) const;
 
   // Escapes forward slashes from file names with magic unicode character
@@ skipping 209 matching lines @@
   // entry instance.
   bool RemoveChild(GDataEntry* entry);
 
   // Collection of children GDataEntry items.
   GDataFileCollection child_files_;
   GDataDirectoryCollection child_directories_;
 
   DISALLOW_COPY_AND_ASSIGN(GDataDirectory);
 };
 
+// TODO(achuith,hashimoto,satorux): Move this to a separate file.

[satorux1, 2012/08/02 17:24:03]

could you file a bug and add a url to it? I'll find someone to work on this.

[achuithb, 2012/08/02 20:26:25]

Done.

 // Class to handle GDataEntry* lookups, add/remove GDataEntry*.
 class GDataDirectoryService {
  public:
   // Callback for GetEntryByResourceIdAsync.
   typedef base::Callback<void(GDataEntry* entry)> GetEntryByResourceIdCallback;
 
+  // Map of resource id and serialized GDataEntry.
+  typedef std::map<std::string, std::string> SerializedMap;
+
   GDataDirectoryService();
   ~GDataDirectoryService();
 
   GDataDirectory* root() { return root_.get(); }
 
   // Last time when we dumped serialized file system to disk.
   const base::Time& last_serialized() const { return last_serialized_; }
   void set_last_serialized(const base::Time& time) { last_serialized_ = time; }
   // Size of serialized file system on disk in bytes.
   const size_t serialized_size() const { return serialized_size_; }
@@ skipping 38 matching lines @@
   void RefreshFile(scoped_ptr<GDataFile> fresh_file);
 
   // Replaces file entry |old_entry| with its fresh value |fresh_file|.
   static void RefreshFileInternal(scoped_ptr<GDataFile> fresh_file,
                                   GDataEntry* old_entry);
 
   // Serializes/Parses to/from string via proto classes.
   void SerializeToString(std::string* serialized_proto) const;
   bool ParseFromString(const std::string& serialized_proto);
 
+  // Restore from and save to database.

[satorux1, 2012/08/02 17:24:03]

Restores/saves

[achuithb, 2012/08/02 20:26:25]

Done.

+  void InitFromDB(const FilePath& db_path,
+                  base::SequencedTaskRunner* blocking_task_runner,
+                  LoadRootFeedParams* load_params,
+                  const base::Closure& callback);
+  void SaveToDB();
+
  private:
   // A map table of file's resource string to its GDataFile* entry.
   typedef std::map<std::string, GDataEntry*> ResourceMap;
 
+  // Initialize the resource map using serialized_resources fetched from the db.

[satorux1, 2012/08/02 17:24:03]

please fix other paces too

[achuithb, 2012/08/02 20:26:25]

Done.

+  void InitResourceMap(CreateDBParams* create_params,
+                       LoadRootFeedParams* load_params,
+                       const base::Closure& callback);
+
+  // Clear root_ and the resource map.
+  void ClearRoot();
+
+  // Create GDataEntry from serialized string.
+  scoped_ptr<GDataEntry> FromProtoString(
+      const std::string& serialized_proto);
+
+  // Private data members.
+  scoped_refptr<base::SequencedTaskRunner> blocking_task_runner_;
+  scoped_ptr<GDataDirectoryServiceDB> directory_service_db_;
+
+  ResourceMap resource_map_;
+
   scoped_ptr<GDataDirectory> root_;  // Stored in the serialized proto.
-  ResourceMap resource_map_;
 
   base::Time last_serialized_;
   size_t serialized_size_;
   int largest_changestamp_;  // Stored in the serialized proto.
   ContentOrigin origin_;
 
+  base::WeakPtrFactory<GDataDirectoryService> ui_weak_ptr_factory_;

[satorux1, 2012/08/02 17:24:03]

omit "ui_"?

[achuithb, 2012/08/02 20:26:25]

Done.

+
   DISALLOW_COPY_AND_ASSIGN(GDataDirectoryService);
 };
 
 }  // namespace gdata
 
 #endif  // CHROME_BROWSER_CHROMEOS_GDATA_GDATA_FILES_H_