Files from drag and file <input> should use getMIMETypeForExtension to determine...
[WebKit-https.git] / Source / WebCore / fileapi / File.h
1 /*
2  * Copyright (C) 2008 Apple 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
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef File_h
27 #define File_h
28
29 #include "Blob.h"
30 #include "PlatformString.h"
31 #include <wtf/PassRefPtr.h>
32 #include <wtf/RefCounted.h>
33
34 namespace WebCore {
35
36 struct FileMetadata;
37 class KURL;
38
39 class File : public Blob {
40 public:
41     // AllContentTypes should only be used when the full path/name are trusted; otherwise, it could
42     // allow arbitrary pages to determine what applications an user has installed.
43     enum ContentTypeLookupPolicy {
44         WellKnownContentTypes,
45         AllContentTypes,
46     };
47
48     static PassRefPtr<File> create(const String& path, ContentTypeLookupPolicy policy = WellKnownContentTypes)
49     {
50         return adoptRef(new File(path, policy));
51     }
52
53     // For deserialization.
54     static PassRefPtr<File> create(const String& path, const KURL& srcURL, const String& type)
55     {
56         return adoptRef(new File(path, srcURL, type));
57     }
58
59 #if ENABLE(DIRECTORY_UPLOAD)
60     static PassRefPtr<File> createWithRelativePath(const String& path, const String& relativePath);
61 #endif
62
63 #if ENABLE(FILE_SYSTEM)
64     // If filesystem files live in the remote filesystem, the port might pass the valid metadata (whose length field is non-negative) and cache in the File object.
65     //
66     // Otherwise calling size(), lastModifiedTime() and slice() will synchronously query the file metadata.
67     static PassRefPtr<File> createForFileSystemFile(const String& name, const FileMetadata& metadata)
68     {
69         return adoptRef(new File(name, metadata));
70     }
71 #endif
72
73     // Create a file with a name exposed to the author (via File.name and associated DOM properties) that differs from the one provided in the path.
74     static PassRefPtr<File> createWithName(const String& path, const String& name, ContentTypeLookupPolicy policy = WellKnownContentTypes)
75     {
76         if (name.isEmpty())
77             return adoptRef(new File(path, policy));
78         return adoptRef(new File(path, name, policy));
79     }
80
81     virtual unsigned long long size() const;
82     virtual bool isFile() const { return true; }
83
84     const String& path() const { return m_path; }
85     const String& name() const { return m_name; }
86
87     // This may return NaN (which is converted to null Date in javascript layer) if getFileModificationTime() platform call has failed or the information is not available.
88     double lastModifiedDate() const;
89
90 #if ENABLE(DIRECTORY_UPLOAD)
91     // Returns the relative path of this file in the context of a directory selection.
92     const String& webkitRelativePath() const { return m_relativePath; }
93 #endif
94
95     // Note that this involves synchronous file operation. Think twice before calling this function.
96     void captureSnapshot(long long& snapshotSize, double& snapshotModificationTime) const;
97
98 private:
99     File(const String& path, ContentTypeLookupPolicy);
100
101     // For deserialization.
102     File(const String& path, const KURL& srcURL, const String& type);
103     File(const String& path, const String& name, ContentTypeLookupPolicy);
104
105 # if ENABLE(FILE_SYSTEM)
106     File(const String& name, const FileMetadata&);
107
108     // Returns true if this has a valid snapshot metadata (i.e. m_snapshotSize >= 0).
109     bool hasValidSnapshotMetadata() const { return m_snapshotSize >= 0; }
110 #endif
111
112     String m_path;
113     String m_name;
114
115 #if ENABLE(FILE_SYSTEM)
116     // If m_snapshotSize is negative (initialized to -1 by default), the snapshot metadata is invalid and we retrieve the latest metadata synchronously in size(), lastModifiedTime() and webkitSlice().
117     // Otherwise, the snapshot metadata are used directly in those methods.
118     const long long m_snapshotSize;
119     const double m_snapshotModificationTime;
120 #endif
121
122 #if ENABLE(DIRECTORY_UPLOAD)
123     String m_relativePath;
124 #endif
125 };
126
127 inline File* toFile(Blob* blob)
128 {
129     ASSERT(!blob || blob->isFile());
130     return static_cast<File*>(blob);
131 }
132
133 inline const File* toFile(const Blob* blob)
134 {
135     ASSERT(!blob || blob->isFile());
136     return static_cast<const File*>(blob);
137 }
138
139 } // namespace WebCore
140
141 #endif // File_h