ae38278b12c9619c0f62aa360342ccfbcaa1af08
[WebKit-https.git] / Source / WebCore / Modules / filesystem / DOMFileSystemBase.h
1 /*
2  * Copyright (C) 2010 Google Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef DOMFileSystemBase_h
32 #define DOMFileSystemBase_h
33
34 #if ENABLE(FILE_SYSTEM)
35
36 #include "AsyncFileSystem.h"
37 #include "FileSystemFlags.h"
38 #include "FileSystemType.h"
39 #include "KURL.h"
40 #include "PlatformString.h"
41 #include <wtf/PassRefPtr.h>
42 #include <wtf/RefCounted.h>
43
44 namespace WebCore {
45
46 class DirectoryEntry;
47 class DirectoryReaderBase;
48 class EntriesCallback;
49 class EntryBase;
50 class EntryCallback;
51 class ErrorCallback;
52 class MetadataCallback;
53 class ScriptExecutionContext;
54 class SecurityOrigin;
55 class VoidCallback;
56
57 // A common base class for DOMFileSystem and DOMFileSystemSync.
58 class DOMFileSystemBase : public RefCounted<DOMFileSystemBase> {
59 public:
60     // Path prefixes that are used in the filesystem URLs (that can be obtained by toURL()).
61     // http://www.w3.org/TR/file-system-api/#widl-Entry-toURL
62     static const char persistentPathPrefix[];
63     static const size_t persistentPathPrefixLength;
64     static const char temporaryPathPrefix[];
65     static const size_t temporaryPathPrefixLength;
66     static const char isolatedPathPrefix[];
67     static const size_t isolatedPathPrefixLength;
68
69     static PassRefPtr<DOMFileSystemBase> create(ScriptExecutionContext* context, const String& name, FileSystemType type, const KURL& rootURL, PassOwnPtr<AsyncFileSystem> asyncFileSystem)
70     {
71         return adoptRef(new DOMFileSystemBase(context, name, type, rootURL, asyncFileSystem));
72     }
73     virtual ~DOMFileSystemBase();
74
75     const String& name() const { return m_name; }
76     FileSystemType type() const { return m_type; }
77     KURL rootURL() const { return m_filesystemRootURL; }
78     AsyncFileSystem* asyncFileSystem() const { return m_asyncFileSystem.get(); }
79     SecurityOrigin* securityOrigin() const;
80
81     // The clonable flag is used in the structured clone algorithm to test
82     // whether the FileSystem API object is permitted to be cloned. It defaults
83     // to false, and must be explicitly set by internal code permit cloning.
84     void makeClonable() { m_clonable = true; }
85     bool clonable() const { return m_clonable; }
86
87     static bool isValidType(FileSystemType);
88     static bool crackFileSystemURL(const KURL&, FileSystemType&, String& filePath);
89     bool supportsToURL() const;
90     KURL createFileSystemURL(const EntryBase*) const;
91     KURL createFileSystemURL(const String& fullPath) const;
92
93     // Actual FileSystem API implementations. All the validity checks on virtual paths are done at this level.
94     // They return false for immediate errors that don't involve lower AsyncFileSystem layer (e.g. for name validation errors). Otherwise they return true (but later may call back with an runtime error).
95     bool getMetadata(const EntryBase*, PassRefPtr<MetadataCallback>, PassRefPtr<ErrorCallback>);
96     bool move(const EntryBase* source, EntryBase* parent, const String& name, PassRefPtr<EntryCallback>, PassRefPtr<ErrorCallback>);
97     bool copy(const EntryBase* source, EntryBase* parent, const String& name, PassRefPtr<EntryCallback>, PassRefPtr<ErrorCallback>);
98     bool remove(const EntryBase*, PassRefPtr<VoidCallback>, PassRefPtr<ErrorCallback>);
99     bool removeRecursively(const EntryBase*, PassRefPtr<VoidCallback>, PassRefPtr<ErrorCallback>);
100     bool getParent(const EntryBase*, PassRefPtr<EntryCallback>, PassRefPtr<ErrorCallback>);
101     bool getFile(const EntryBase*, const String& path, const FileSystemFlags&, PassRefPtr<EntryCallback>, PassRefPtr<ErrorCallback>);
102     bool getDirectory(const EntryBase*, const String& path, const FileSystemFlags&, PassRefPtr<EntryCallback>, PassRefPtr<ErrorCallback>);
103     bool readDirectory(PassRefPtr<DirectoryReaderBase>, const String& path, PassRefPtr<EntriesCallback>, PassRefPtr<ErrorCallback>);
104
105 protected:
106     DOMFileSystemBase(ScriptExecutionContext*, const String& name, FileSystemType, const KURL& rootURL, PassOwnPtr<AsyncFileSystem>);
107     friend class DOMFileSystemSync;
108
109     ScriptExecutionContext* m_context;
110     String m_name;
111     FileSystemType m_type;
112     KURL m_filesystemRootURL;
113     bool m_clonable;
114
115     mutable OwnPtr<AsyncFileSystem> m_asyncFileSystem;
116 };
117
118 inline bool operator==(const DOMFileSystemBase& a, const DOMFileSystemBase& b) { return a.name() == b.name() && a.type() == b.type() && a.rootURL() == b.rootURL(); }
119
120 } // namespace WebCore
121
122 #endif // ENABLE(FILE_SYSTEM)
123
124 #endif // DOMFileSystemBase_h