1 // Copyright 2013 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 #ifndef CHROME_BROWSER_SYNC_FILE_SYSTEM_DRIVE_BACKEND_SYNC_ENGINE_INITIALIZER_H_
6 #define CHROME_BROWSER_SYNC_FILE_SYSTEM_DRIVE_BACKEND_SYNC_ENGINE_INITIALIZER_H_
10 #include "base/memory/ref_counted.h"
11 #include "base/memory/scoped_ptr.h"
12 #include "base/memory/scoped_vector.h"
13 #include "base/memory/weak_ptr.h"
14 #include "base/sequenced_task_runner.h"
15 #include "chrome/browser/sync_file_system/drive_backend/sync_task.h"
16 #include "chrome/browser/sync_file_system/sync_callbacks.h"
17 #include "google_apis/drive/drive_common_callbacks.h"
18 #include "google_apis/drive/gdata_errorcode.h"
21 class DriveServiceInterface;
24 namespace google_apis {
34 namespace sync_file_system {
35 namespace drive_backend {
37 class MetadataDatabase;
38 class SyncEngineContext;
40 // This class performs initializion sequence of SyncEngine.
42 // After initialize sequence completed, the Database must have
43 // - Largest change ID,
44 // - Sync-root folder and its tracker,
45 // - All children of sync-root folder that have inactive and non-dirty
48 // The initialization sequence is:
49 // - Open database and load its contents,
50 // - If the database is already populated, complete the sequence.
51 // - Get AboutResource to get the largest change ID and the Drive root folder
53 // - Find the remote sync-root folder, whose title is
54 // "Chrome Syncable FileSystem" and has no parent.
55 // Note that if the initialization is interrupted by the browser restart or
56 // an error, the sequence leaves the folder in the Drive root folder. So, if
57 // we find the folder in the Drive root folder, handle it as the sync-root
59 // - Create the remote sync-root folder if we don't have.
60 // - Detach the remote sync-root folder from its parent if it has.
61 // - Fetch the folder contents of the remote sync-root folder.
62 // The contents are likely registered as app-root folders, but handle them
63 // as regular inactive folders until they are registered explicitly.
64 // - Populate database with the largest change ID, the sync-root folder and
67 class SyncEngineInitializer : public SyncTask {
69 SyncEngineInitializer(SyncEngineContext* sync_context,
70 base::SequencedTaskRunner* task_runner,
71 const base::FilePath& database_path,
72 leveldb::Env* env_override);
73 virtual ~SyncEngineInitializer();
74 virtual void RunPreflight(scoped_ptr<SyncTaskToken> token) OVERRIDE;
76 scoped_ptr<MetadataDatabase> PassMetadataDatabase();
79 typedef base::Callback<void(const SyncStatusCallback& callback)> Task;
81 void DidCreateMetadataDatabase(scoped_ptr<SyncTaskToken> token,
82 SyncStatusCode status,
83 scoped_ptr<MetadataDatabase> instance);
85 void GetAboutResource(scoped_ptr<SyncTaskToken> token);
86 void DidGetAboutResource(
87 scoped_ptr<SyncTaskToken> token,
88 google_apis::GDataErrorCode error,
89 scoped_ptr<google_apis::AboutResource> about_resource);
90 void FindSyncRoot(scoped_ptr<SyncTaskToken> token);
91 void DidFindSyncRoot(scoped_ptr<SyncTaskToken> token,
92 google_apis::GDataErrorCode error,
93 scoped_ptr<google_apis::ResourceList> resource_list);
94 void CreateSyncRoot(scoped_ptr<SyncTaskToken> token);
95 void DidCreateSyncRoot(scoped_ptr<SyncTaskToken> token,
96 google_apis::GDataErrorCode error,
97 scoped_ptr<google_apis::ResourceEntry> entry);
98 void DetachSyncRoot(scoped_ptr<SyncTaskToken> token);
99 void DidDetachSyncRoot(scoped_ptr<SyncTaskToken> token,
100 google_apis::GDataErrorCode error);
101 void ListAppRootFolders(scoped_ptr<SyncTaskToken> token);
102 void DidListAppRootFolders(
103 scoped_ptr<SyncTaskToken> token,
104 google_apis::GDataErrorCode error,
105 scoped_ptr<google_apis::ResourceList> resource_list);
106 void PopulateDatabase(scoped_ptr<SyncTaskToken> token);
107 void DidPopulateDatabase(scoped_ptr<SyncTaskToken> token,
108 SyncStatusCode status);
110 SyncEngineContext* sync_context_; // Not owned.
111 leveldb::Env* env_override_;
113 scoped_refptr<base::SequencedTaskRunner> task_runner_;
114 google_apis::CancelCallback cancel_callback_;
115 base::FilePath database_path_;
117 int find_sync_root_retry_count_;
119 scoped_ptr<MetadataDatabase> metadata_database_;
120 ScopedVector<google_apis::ResourceEntry> app_root_folders_;
122 int64 largest_change_id_;
123 std::string root_folder_id_;
125 scoped_ptr<google_apis::ResourceEntry> sync_root_folder_;
127 base::WeakPtrFactory<SyncEngineInitializer> weak_ptr_factory_;
129 DISALLOW_COPY_AND_ASSIGN(SyncEngineInitializer);
132 } // namespace drive_backend
133 } // namespace sync_file_system
135 #endif // CHROME_BROWSER_SYNC_FILE_SYSTEM_DRIVE_BACKEND_SYNC_ENGINE_INITIALIZER_H_