blob: 0554a68bba41c5c37dd5bc8dcd6dd17ea11c9170 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
// 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 WEBKIT_FILEAPI_FILE_SYSTEM_UTIL_H_
#define WEBKIT_FILEAPI_FILE_SYSTEM_UTIL_H_
#include <string>
#include <vector>
#include "base/file_path.h"
#include "base/platform_file.h"
#include "third_party/WebKit/Source/WebKit/chromium/public/WebFileError.h"
#include "webkit/fileapi/file_system_types.h"
#include "webkit/fileapi/fileapi_export.h"
#include "webkit/quota/quota_types.h"
class GURL;
namespace fileapi {
extern const char kPersistentDir[];
extern const char kTemporaryDir[];
extern const char kExternalDir[];
extern const char kIsolatedDir[];
extern const char kTestDir[];
class FILEAPI_EXPORT VirtualPath {
public:
// Use this instead of FilePath::BaseName when operating on virtual paths.
// FilePath::BaseName will get confused by ':' on Windows when it looks like a
// drive letter separator; this will treat it as just another character.
static FilePath BaseName(const FilePath& virtual_path);
// Likewise, use this instead of FilePath::GetComponents when operating on
// virtual paths.
// Note that this assumes very clean input, with no leading slash, and it will
// not evaluate '.' or '..' components.
static void GetComponents(const FilePath& path,
std::vector<FilePath::StringType>* components);
};
// Returns the root URI of the filesystem that can be specified by a pair of
// |origin_url| and |type|. The returned URI can be used as a root path
// of the filesystem (e.g. <returned_URI> + "/relative/path" will compose
// a path pointing to the entry "/relative/path" in the filesystem).
//
// For Isolated filesystem this returns the 'common' root part, e.g.
// returns URL without the filesystem ID.
//
// |type| needs to be public type as the returned URI is given to the renderer.
FILEAPI_EXPORT GURL GetFileSystemRootURI(const GURL& origin_url,
FileSystemType type);
// Returns the name for the filesystem that is specified by a pair of
// |origin_url| and |type|.
// (The name itself is neither really significant nor a formal identifier
// but can be read as the .name field of the returned FileSystem object
// as a user-friendly name in the javascript layer).
//
// |type| needs to be public type as the returned name is given to the renderer.
//
// Example:
// The name for a TEMPORARY filesystem of "http://www.example.com:80/"
// should look like: "http_www.example.host_80:temporary"
FILEAPI_EXPORT std::string GetFileSystemName(const GURL& origin_url,
FileSystemType type);
// Converts FileSystemType |type| to/from the StorageType |storage_type| that
// is used for the unified quota system.
// (Basically this naively maps TEMPORARY storage type to TEMPORARY filesystem
// type, PERSISTENT storage type to PERSISTENT filesystem type and vice versa.)
FILEAPI_EXPORT FileSystemType QuotaStorageTypeToFileSystemType(
quota::StorageType storage_type);
FILEAPI_EXPORT quota::StorageType FileSystemTypeToQuotaStorageType(
FileSystemType type);
// Returns the origin identifier string for the given |url| and vice versa.
// The origin identifier string is a serialized form of a security origin
// and can be used as a path name as it contains no "/" or other possibly
// unsafe characters. (See WebKit's SecurityOrigin code for more details.)
//
// Example:
// "http://www.example.com:80/"'s identifier should look like:
// "http_www.example.host_80"
FILEAPI_EXPORT std::string GetOriginIdentifierFromURL(const GURL& url);
FILEAPI_EXPORT GURL GetOriginURLFromIdentifier(
const std::string& origin_identifier);
// Returns the string representation of the given filesystem |type|.
// Returns an empty string if the |type| is invalid.
FILEAPI_EXPORT std::string GetFileSystemTypeString(FileSystemType type);
// Encodes |file_path| to a string.
// Following conditions should be held:
// - StringToFilePath(FilePathToString(path)) == path
// - StringToFilePath(FilePathToString(path) + "/" + "SubDirectory") ==
// path.AppendASCII("SubDirectory");
//
// TODO(tzik): Replace CreateFilePath and FilePathToString in
// third_party/leveldatabase/env_chromium.cc with them.
FILEAPI_EXPORT std::string FilePathToString(const FilePath& file_path);
// Decode a file path from |file_path_string|.
FILEAPI_EXPORT FilePath StringToFilePath(const std::string& file_path_string);
// File error conversion
FILEAPI_EXPORT WebKit::WebFileError PlatformFileErrorToWebFileError(
base::PlatformFileError error_code);
// Generate a file system name for the given arguments. Should only be used by
// platform apps.
FILEAPI_EXPORT std::string GetIsolatedFileSystemName(
const GURL& origin_url,
const std::string& filesystem_id);
// Find the file system id from |filesystem_name|. Should only be used by
// platform apps. This function will return false if the file system name is
// not of the form {origin}:Isolated_{id}, and will also check that there is an
// origin and id present. It will not check that the origin or id are valid.
FILEAPI_EXPORT bool CrackIsolatedFileSystemName(
const std::string& filesystem_name,
std::string* filesystem_id);
} // namespace fileapi
#endif // WEBKIT_FILEAPI_FILE_SYSTEM_UTIL_H_
|
