edf485582faf66834930aaa5119fb06801b45627
[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 <wtf/PassRefPtr.h>
31 #include <wtf/text/WTFString.h>
32
33 namespace WebCore {
34
35 struct FileMetadata;
36 class URL;
37
38 class File : public Blob {
39 public:
40     // AllContentTypes should only be used when the full path/name are trusted; otherwise, it could
41     // allow arbitrary pages to determine what applications an user has installed.
42     enum ContentTypeLookupPolicy {
43         WellKnownContentTypes,
44         AllContentTypes,
45     };
46
47     static PassRefPtr<File> create(const String& path, ContentTypeLookupPolicy policy = WellKnownContentTypes)
48     {
49         return adoptRef(new File(path, policy));
50     }
51
52     // For deserialization.
53     static PassRefPtr<File> create(const String& path, const URL& srcURL, const String& type)
54     {
55         return adoptRef(new File(path, srcURL, type));
56     }
57
58 #if ENABLE(DIRECTORY_UPLOAD)
59     static PassRefPtr<File> createWithRelativePath(const String& path, const String& relativePath);
60 #endif
61
62     // 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.
63     static PassRefPtr<File> createWithName(const String& path, const String& name, ContentTypeLookupPolicy policy = WellKnownContentTypes)
64     {
65         if (name.isEmpty())
66             return adoptRef(new File(path, policy));
67         return adoptRef(new File(path, name, policy));
68     }
69
70     virtual unsigned long long size() const override;
71     virtual bool isFile() const override { return true; }
72
73     const String& path() const { return m_path; }
74     const String& name() const { return m_name; }
75
76     // This returns the current date and time if the file's last modifiecation date is not known (per spec: http://www.w3.org/TR/FileAPI/#dfn-lastModifiedDate).
77     double lastModifiedDate() const;
78
79 #if ENABLE(DIRECTORY_UPLOAD)
80     // Returns the relative path of this file in the context of a directory selection.
81     const String& webkitRelativePath() const { return m_relativePath; }
82 #endif
83
84     // Note that this involves synchronous file operation. Think twice before calling this function.
85     void captureSnapshot(long long& snapshotSize, double& snapshotModificationTime) const;
86
87 private:
88     File(const String& path, ContentTypeLookupPolicy);
89
90     // For deserialization.
91     File(const String& path, const URL& srcURL, const String& type);
92     File(const String& path, const String& name, ContentTypeLookupPolicy);
93
94     String m_path;
95     String m_name;
96
97 #if ENABLE(DIRECTORY_UPLOAD)
98     String m_relativePath;
99 #endif
100 };
101
102 inline File* toFile(Blob* blob)
103 {
104     ASSERT_WITH_SECURITY_IMPLICATION(!blob || blob->isFile());
105     return static_cast<File*>(blob);
106 }
107
108 inline const File* toFile(const Blob* blob)
109 {
110     ASSERT_WITH_SECURITY_IMPLICATION(!blob || blob->isFile());
111     return static_cast<const File*>(blob);
112 }
113
114 } // namespace WebCore
115
116 #endif // File_h