src/webkit/browser/fileapi/file_system_backend.h

   1 // Copyright (c) 2012 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 WEBKIT_BROWSER_FILEAPI_FILE_SYSTEM_BACKEND_H_
   6 #define WEBKIT_BROWSER_FILEAPI_FILE_SYSTEM_BACKEND_H_
   7
   8 #include <string>
   9 #include <vector>
  10
  11 #include "base/callback_forward.h"
  12 #include "base/files/file_path.h"
  13 #include "base/memory/scoped_ptr.h"
  14 #include "base/platform_file.h"
  15 #include "webkit/browser/fileapi/file_permission_policy.h"
  16 #include "webkit/browser/fileapi/open_file_system_mode.h"
  17 #include "webkit/browser/webkit_storage_browser_export.h"
  18 #include "webkit/common/fileapi/file_system_types.h"
  19
  20 class GURL;
  21
  22 namespace webkit_blob {
  23 class FileStreamReader;
  24 }
  25
  26 namespace fileapi {
  27
  28 class AsyncFileUtil;
  29 class CopyOrMoveFileValidatorFactory;
  30 class FileSystemURL;
  31 class FileStreamWriter;
  32 class FileSystemContext;
  33 class FileSystemFileUtil;
  34 class FileSystemOperation;
  35 class FileSystemQuotaUtil;
  36
  37 // An interface for defining a file system backend.
  38 //
  39 // NOTE: when you implement a new FileSystemBackend for your own
  40 // FileSystem module, please contact to kinuko@chromium.org.
  41 //
  42 class WEBKIT_STORAGE_BROWSER_EXPORT FileSystemBackend {
  43  public:
  44   // Callback for InitializeFileSystem.
  45   typedef base::Callback<void(const GURL& root_url,
  46                               const std::string& name,
  47                               base::PlatformFileError error)>
  48       OpenFileSystemCallback;
  49   virtual ~FileSystemBackend() {}
  50
  51   // Returns true if this filesystem backend can handle |type|.
  52   // One filesystem backend may be able to handle multiple filesystem types.
  53   virtual bool CanHandleType(FileSystemType type) const = 0;
  54
  55   // This method is called right after the backend is registered in the
  56   // FileSystemContext and before any other methods are called. Each backend can
  57   // do additional initialization which depends on FileSystemContext here.
  58   virtual void Initialize(FileSystemContext* context) = 0;
  59
  60   // Opens the filesystem for the given |origin_url| and |type|.
  61   // This verifies if it is allowed to request (or create) the filesystem
  62   // and if it can access (or create) the root directory.
  63   // If |mode| is CREATE_IF_NONEXISTENT calling this may also create
  64   // the root directory (and/or related database entries etc) for
  65   // the filesystem if it doesn't exist.
  66   virtual void OpenFileSystem(
  67       const GURL& origin_url,
  68       FileSystemType type,
  69       OpenFileSystemMode mode,
  70       const OpenFileSystemCallback& callback) = 0;
  71
  72   // Returns the specialized AsyncFileUtil for this backend.
  73   virtual AsyncFileUtil* GetAsyncFileUtil(FileSystemType type) = 0;
  74
  75   // Returns the specialized CopyOrMoveFileValidatorFactory for this backend
  76   // and |type|.  If |error_code| is PLATFORM_FILE_OK and the result is NULL,
  77   // then no validator is required.
  78   virtual CopyOrMoveFileValidatorFactory* GetCopyOrMoveFileValidatorFactory(
  79       FileSystemType type, base::PlatformFileError* error_code) = 0;
  80
  81   // Returns a new instance of the specialized FileSystemOperation for this
  82   // backend based on the given triplet of |origin_url|, |file_system_type|
  83   // and |virtual_path|. On failure to create a file system operation, set
  84   // |error_code| correspondingly.
  85   // This method is usually dispatched by
  86   // FileSystemContext::CreateFileSystemOperation.
  87   virtual FileSystemOperation* CreateFileSystemOperation(
  88       const FileSystemURL& url,
  89       FileSystemContext* context,
  90       base::PlatformFileError* error_code) const = 0;
  91
  92   // Creates a new file stream reader for a given filesystem URL |url| with an
  93   // offset |offset|. |expected_modification_time| specifies the expected last
  94   // modification if the value is non-null, the reader will check the underlying
  95   // file's actual modification time to see if the file has been modified, and
  96   // if it does any succeeding read operations should fail with
  97   // ERR_UPLOAD_FILE_CHANGED error.
  98   // This method itself does *not* check if the given path exists and is a
  99   // regular file.
 100   virtual scoped_ptr<webkit_blob::FileStreamReader> CreateFileStreamReader(
 101       const FileSystemURL& url,
 102       int64 offset,
 103       const base::Time& expected_modification_time,
 104       FileSystemContext* context) const = 0;
 105
 106   // Creates a new file stream writer for a given filesystem URL |url| with an
 107   // offset |offset|.
 108   // This method itself does *not* check if the given path exists and is a
 109   // regular file.
 110   virtual scoped_ptr<FileStreamWriter> CreateFileStreamWriter(
 111       const FileSystemURL& url,
 112       int64 offset,
 113       FileSystemContext* context) const = 0;
 114
 115   // Returns the specialized FileSystemQuotaUtil for this backend.
 116   // This could return NULL if this backend does not support quota.
 117   virtual FileSystemQuotaUtil* GetQuotaUtil() = 0;
 118 };
 119
 120 // An interface to control external file system access permissions.
 121 // TODO(satorux): Move this out of 'webkit/browser/fileapi'. crbug.com/257279
 122 class ExternalFileSystemBackend : public FileSystemBackend {
 123  public:
 124   // Returns true if |url| is allowed to be accessed.
 125   // This is supposed to perform ExternalFileSystem-specific security
 126   // checks.
 127   virtual bool IsAccessAllowed(const fileapi::FileSystemURL& url) const = 0;
 128   // Returns the list of top level directories that are exposed by this
 129   // provider. This list is used to set appropriate child process file access
 130   // permissions.
 131   virtual std::vector<base::FilePath> GetRootDirectories() const = 0;
 132   // Grants access to all external file system from extension identified with
 133   // |extension_id|.
 134   virtual void GrantFullAccessToExtension(const std::string& extension_id) = 0;
 135   // Grants access to |virtual_path| from |origin_url|.
 136   virtual void GrantFileAccessToExtension(
 137       const std::string& extension_id,
 138       const base::FilePath& virtual_path) = 0;
 139   // Revokes file access from extension identified with |extension_id|.
 140   virtual void RevokeAccessForExtension(
 141         const std::string& extension_id) = 0;
 142   // Gets virtual path by known filesystem path. Returns false when filesystem
 143   // path is not exposed by this provider.
 144   virtual bool GetVirtualPath(const base::FilePath& file_system_path,
 145                               base::FilePath* virtual_path) = 0;
 146 };
 147
 148 }  // namespace fileapi
 149
 150 #endif  // WEBKIT_BROWSER_FILEAPI_FILE_SYSTEM_BACKEND_H_