gdata: Move GDataWapiFeedParser to a set of new files

chrome/browser/chromeos/gdata/gdata_wapi_feed_processor.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_WAPI_FEED_PROCESSOR_H_
+#define CHROME_BROWSER_CHROMEOS_GDATA_GDATA_WAPI_FEED_PROCESSOR_H_
+
+#include <map>
+#include <set>
+#include <string>
+#include <vector>
+
+#include "base/file_path.h"
+#include "chrome/browser/chromeos/gdata/gdata_errorcode.h"
+#include "chrome/browser/chromeos/gdata/gdata_wapi_parser.h"
+
+namespace gdata {
+
+class GDataDirectory;
+class GDataDirectoryService;
+class GDataEntry;
+
+typedef std::map<std::string /* resource_id */, GDataEntry*>
+FileResourceIdMap;
+
+// Struct used to record UMA stats with FeedToFileResourceMap().
+struct FeedToFileResourceMapUmaStats {
+  FeedToFileResourceMapUmaStats();
+  ~FeedToFileResourceMapUmaStats();
+
+  typedef std::map<DocumentEntry::EntryKind, int> EntryKindToCountMap;
+  int num_regular_files;
+  int num_hosted_documents;
+  EntryKindToCountMap num_files_with_entry_kind;
+};
+
+// GDataWapiFeedProcessor is used to process feeds from WAPI (codename for
+// Documents List API).
+class GDataWapiFeedProcessor {
+ public:
+  explicit GDataWapiFeedProcessor(GDataDirectoryService* directory_service);
+  ~GDataWapiFeedProcessor();
+
+  // Applies the documents feeds to the file system using |directory_service_|.
+  //
+  // |start_changestamp| determines the type of feed to process. The value is
+  // set to zero for the root feeds, every other value is for the delta feeds.
+  //
+  // In the case of processing the root feeds |root_feed_changestamp| is used
+  // as its initial changestamp value. The value comes from
+  // AccountMetadataFeed.
+  GDataFileError ApplyFeeds(const std::vector<DocumentFeed*>& feed_list,
+                            int start_changestamp,
+                            int root_feed_changestamp,
+                            std::set<FilePath>* changed_dirs);
+
+  // Converts list of document feeds from collected feeds into
+  // FileResourceIdMap.
+  GDataFileError FeedToFileResourceMap(
+    const std::vector<DocumentFeed*>& feed_list,
+    FileResourceIdMap* file_map,
+    int* feed_changestamp,
+    FeedToFileResourceMapUmaStats* uma_stats);
+
+ private:
+  // Updates UMA histograms about file counts.
+  void UpdateFileCountUmaHistograms(
+      const FeedToFileResourceMapUmaStats& uma_stats) const;
+
+  // Applies the pre-processed feed from |file_map| map onto the file system.
+  // All entries in |file_map| will be erased (i.e. the map becomes empty),
+  // and values are deleted.
+  void ApplyFeedFromFileUrlMap(bool is_delta_feed,
+                               int feed_changestamp,
+                               FileResourceIdMap* file_map,
+                               std::set<FilePath>* changed_dirs);
+
+  // Helper function for adding new |file| from the feed into |directory|. It
+  // checks the type of file and updates |changed_dirs| if this file adding
+  // operation needs to raise directory notification update. If file is being
+  // added to |orphaned_dir_service| such notifications are not raised since
+  // we ignore such files and don't add them to the file system now.
+  static void AddEntryToDirectoryAndCollectChangedDirectories(
+      GDataEntry* entry,
+      GDataDirectory* directory,
+      GDataDirectoryService* orphaned_dir_service,
+      std::set<FilePath>* changed_dirs);
+
+  // Helper function for removing |entry| from |directory|. If |entry| is a
+  // directory too, it will collect all its children file paths into
+  // |changed_dirs| as well.
+  static void RemoveEntryFromDirectoryAndCollectChangedDirectories(
+      GDataDirectory* directory,
+      GDataEntry* entry,
+      std::set<FilePath>* changed_dirs);
+
+  // Finds directory where new |file| should be added to during feed processing.
+  // |orphaned_entries_dir| collects files/dirs that don't have a parent in
+  // either locally cached file system or in this new feed.
+  GDataDirectory* FindDirectoryForNewEntry(
+      GDataEntry* new_entry,
+      const FileResourceIdMap& file_map,
+      GDataDirectoryService* orphaned_dir_service);
+
+  GDataDirectoryService* directory_service_;  // Not owned by the class.
+  DISALLOW_COPY_AND_ASSIGN(GDataWapiFeedProcessor);
+};
+
+}  // namespace gdata
+
+#endif  // CHROME_BROWSER_CHROMEOS_GDATA_GDATA_WAPI_FEED_PROCESSOR_H_