chrome/browser/media_galleries/win/mtp_device_delegate_impl_win.h

   1 // Copyright (c) 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.
   4
   5 #ifndef CHROME_BROWSER_MEDIA_GALLERIES_WIN_MTP_DEVICE_DELEGATE_IMPL_WIN_H_
   6 #define CHROME_BROWSER_MEDIA_GALLERIES_WIN_MTP_DEVICE_DELEGATE_IMPL_WIN_H_
   7
   8 #include <queue>
   9
  10 #include "base/callback.h"
  11 #include "base/files/file.h"
  12 #include "base/location.h"
  13 #include "base/memory/scoped_ptr.h"
  14 #include "base/memory/weak_ptr.h"
  15 #include "base/strings/string16.h"
  16 #include "base/win/scoped_comptr.h"
  17 #include "chrome/browser/media_galleries/fileapi/mtp_device_async_delegate.h"
  18 #include "storage/browser/fileapi/async_file_util.h"
  19
  20 namespace base {
  21 class FilePath;
  22 class SequencedTaskRunner;
  23 }
  24
  25 class SnapshotFileDetails;
  26 struct SnapshotRequestInfo;
  27
  28 // MTPDeviceDelegateImplWin is used to communicate with the media transfer
  29 // protocol (MTP) device to complete file system operations. These operations
  30 // are performed asynchronously on a blocking pool thread since the device
  31 // access may be slow and may take a long time to complete. MTP
  32 // device can have multiple data storage partitions. MTPDeviceDelegateImplWin
  33 // is instantiated per MTP device storage partition using
  34 // CreateMTPDeviceAsyncDelegate(). MTPDeviceDelegateImplWin lives on the IO
  35 // thread.
  36 class MTPDeviceDelegateImplWin : public MTPDeviceAsyncDelegate {
  37  public:
  38   // Structure used to represent MTP device storage partition details.
  39   struct StorageDeviceInfo {
  40     StorageDeviceInfo(const base::string16& pnp_device_id,
  41                       const base::string16& registered_device_path,
  42                       const base::string16& storage_object_id);
  43
  44     // The PnP Device Id, used to open the device for communication,
  45     // e.g. "\\?\usb#vid_04a9&pid_3073#12#{6ac27878-a6fa-4155-ba85-f1d4f33}".
  46     const base::string16 pnp_device_id;
  47
  48     // The media file system root path, which is obtained during the
  49     // registration of MTP device storage partition as a file system,
  50     // e.g. "\\MTP:StorageSerial:SID-{10001,E,9823}:237483".
  51     const base::string16 registered_device_path;
  52
  53     // The MTP device storage partition object identifier, used to enumerate the
  54     // storage contents, e.g. "s10001".
  55     const base::string16 storage_object_id;
  56   };
  57
  58  private:
  59   friend void OnGetStorageInfoCreateDelegate(
  60       const base::string16& device_location,
  61       const CreateMTPDeviceAsyncDelegateCallback& callback,
  62       base::string16* pnp_device_id,
  63       base::string16* storage_object_id,
  64       bool succeeded);
  65
  66   enum InitializationState {
  67     UNINITIALIZED = 0,
  68     PENDING_INIT,
  69     INITIALIZED
  70   };
  71
  72   // Used to represent pending task details.
  73   struct PendingTaskInfo {
  74     PendingTaskInfo(const tracked_objects::Location& location,
  75                     const base::Callback<base::File::Error(void)>& task,
  76                     const base::Callback<void(base::File::Error)>& reply);
  77
  78     const tracked_objects::Location location;
  79     const base::Callback<base::File::Error(void)> task;
  80     const base::Callback<void(base::File::Error)> reply;
  81   };
  82
  83   // Defers the device initializations until the first file operation request.
  84   // Do all the initializations in EnsureInitAndRunTask() function.
  85   MTPDeviceDelegateImplWin(const base::string16& registered_device_path,
  86                            const base::string16& pnp_device_id,
  87                            const base::string16& storage_object_id);
  88
  89   // Destructed via CancelPendingTasksAndDeleteDelegate().
  90   virtual ~MTPDeviceDelegateImplWin();
  91
  92   // MTPDeviceAsyncDelegate:
  93   virtual void GetFileInfo(const base::FilePath& file_path,
  94                            const GetFileInfoSuccessCallback& success_callback,
  95                            const ErrorCallback& error_callback) override;
  96   virtual void CreateDirectory(
  97       const base::FilePath& directory_path,
  98       const bool exclusive,
  99       const bool recursive,
 100       const CreateDirectorySuccessCallback& success_callback,
 101       const ErrorCallback& error_callback) override;
 102   virtual void ReadDirectory(
 103       const base::FilePath& root,
 104       const ReadDirectorySuccessCallback& success_callback,
 105       const ErrorCallback& error_callback) override;
 106   virtual void CreateSnapshotFile(
 107       const base::FilePath& device_file_path,
 108       const base::FilePath& local_path,
 109       const CreateSnapshotFileSuccessCallback& success_callback,
 110       const ErrorCallback& error_callback) override;
 111   virtual bool IsStreaming() override;
 112   virtual void ReadBytes(const base::FilePath& device_file_path,
 113                          const scoped_refptr<net::IOBuffer>& buf,
 114                          int64 offset,
 115                          int buf_len,
 116                          const ReadBytesSuccessCallback& success_callback,
 117                          const ErrorCallback& error_callback) override;
 118   bool IsReadOnly() const override;
 119   void CopyFileLocal(
 120       const base::FilePath& source_file_path,
 121       const base::FilePath& device_file_path,
 122       const CreateTemporaryFileCallback& create_temporary_file_callback,
 123       const CopyFileProgressCallback& progress_callback,
 124       const CopyFileLocalSuccessCallback& success_callback,
 125       const ErrorCallback& error_callback) override;
 126   void MoveFileLocal(
 127       const base::FilePath& source_file_path,
 128       const base::FilePath& device_file_path,
 129       const CreateTemporaryFileCallback& create_temporary_file_callback,
 130       const MoveFileLocalSuccessCallback& success_callback,
 131       const ErrorCallback& error_callback) override;
 132   void CopyFileFromLocal(
 133       const base::FilePath& source_file_path,
 134       const base::FilePath& device_file_path,
 135       const CopyFileFromLocalSuccessCallback& success_callback,
 136       const ErrorCallback& error_callback) override;
 137   void DeleteFile(const base::FilePath& file_path,
 138                   const DeleteFileSuccessCallback& success_callback,
 139                   const ErrorCallback& error_callback) override;
 140   void DeleteDirectory(const base::FilePath& file_path,
 141                        const DeleteDirectorySuccessCallback& success_callback,
 142                        const ErrorCallback& error_callback) override;
 143   virtual void CancelPendingTasksAndDeleteDelegate() override;
 144
 145   // Ensures the device is initialized for communication by doing a
 146   // call-and-reply to a blocking pool thread. |task_info.task| runs on a
 147   // blocking pool thread and |task_info.reply| runs on the IO thread.
 148   //
 149   // If the device is already initialized, post the |task_info.task|
 150   // immediately on a blocking pool thread.
 151   //
 152   // If the device is uninitialized, store the |task_info| in a pending task
 153   // list and then runs all the pending tasks once the device is successfully
 154   // initialized.
 155   void EnsureInitAndRunTask(const PendingTaskInfo& task_info);
 156
 157   // Writes data chunk from the device to the snapshot file path based on the
 158   // parameters in |current_snapshot_details_| by doing a call-and-reply to a
 159   // blocking pool thread.
 160   void WriteDataChunkIntoSnapshotFile();
 161
 162   // Processes the next pending request.
 163   void ProcessNextPendingRequest();
 164
 165   // Handles the event that the device is initialized. |succeeded| indicates
 166   // whether device initialization succeeded or not. If the device is
 167   // successfully initialized, runs the next pending task.
 168   void OnInitCompleted(bool succeeded);
 169
 170   // Called when GetFileInfo() completes. |file_info| specifies the requested
 171   // file details. |error| specifies the platform file error code.
 172   //
 173   // If the GetFileInfo() succeeds, |success_callback| is invoked to notify the
 174   // caller about the |file_info| details.
 175   //
 176   // If the GetFileInfo() fails, |file_info| is not set and |error_callback| is
 177   // invoked to notify the caller about the platform file |error|.
 178   void OnGetFileInfo(const GetFileInfoSuccessCallback& success_callback,
 179                      const ErrorCallback& error_callback,
 180                      base::File::Info* file_info,
 181                      base::File::Error error);
 182
 183   // Called when ReadDirectory() completes. |file_list| contains the directory
 184   // file entries information. |error| specifies the platform file error code.
 185   //
 186   // If the ReadDirectory() succeeds, |success_callback| is invoked to notify
 187   // the caller about the directory file entries.
 188   //
 189   // If the ReadDirectory() fails, |file_list| is not set and |error_callback|
 190   // is invoked to notify the caller about the platform file |error|.
 191   void OnDidReadDirectory(const ReadDirectorySuccessCallback& success_callback,
 192                           const ErrorCallback& error_callback,
 193                           storage::AsyncFileUtil::EntryList* file_list,
 194                           base::File::Error error);
 195
 196   // Called when the get file stream request completes.
 197   // |file_details.request_info| contains the CreateSnapshot request param
 198   // details. |error| specifies the platform file error code.
 199   //
 200   // If the file stream of the device file is successfully
 201   // fetched, |file_details| will contain the required details for the creation
 202   // of the snapshot file.
 203   //
 204   // If the get file stream request fails, |error| is set accordingly.
 205   void OnGetFileStream(scoped_ptr<SnapshotFileDetails> file_details,
 206                        base::File::Error error);
 207
 208   // Called when WriteDataChunkIntoSnapshotFile() completes.
 209   // |bytes_written| specifies the number of bytes written into the
 210   // |snapshot_file_path| during the last write operation.
 211   //
 212   // If the write operation succeeds, |bytes_written| is set to a non-zero
 213   // value.
 214   //
 215   // If the write operation fails, |bytes_written| is set to zero.
 216   void OnWroteDataChunkIntoSnapshotFile(
 217       const base::FilePath& snapshot_file_path,
 218       DWORD bytes_written);
 219
 220   // Portable device initialization state.
 221   InitializationState init_state_;
 222
 223   // The task runner where the device operation tasks runs.
 224   scoped_refptr<base::SequencedTaskRunner> media_task_runner_;
 225
 226   // Device storage partition details
 227   // (e.g. device path, PnP device id and storage object id).
 228   StorageDeviceInfo storage_device_info_;
 229
 230   // Used to track the current state of the snapshot file (e.g how many bytes
 231   // written to the snapshot file, optimal data transfer size, source file
 232   // stream, etc).
 233   //
 234   // A snapshot file is created incrementally. CreateSnapshotFile request reads
 235   // and writes the snapshot file data in chunks. In order to retain the order
 236   // of the snapshot file requests, make sure there is only one active snapshot
 237   // file request at any time.
 238   scoped_ptr<SnapshotFileDetails> current_snapshot_details_;
 239
 240   // A list of pending tasks that needs to be run when the device is
 241   // initialized or when the current task in progress is complete.
 242   std::queue<PendingTaskInfo> pending_tasks_;
 243
 244   // Used to make sure only one task is in progress at any time.
 245   bool task_in_progress_;
 246
 247   // For callbacks that may run after destruction.
 248   base::WeakPtrFactory<MTPDeviceDelegateImplWin> weak_ptr_factory_;
 249
 250   DISALLOW_COPY_AND_ASSIGN(MTPDeviceDelegateImplWin);
 251 };
 252
 253 #endif  // CHROME_BROWSER_MEDIA_GALLERIES_WIN_MTP_DEVICE_DELEGATE_IMPL_WIN_H_