BlobRegistry no longer needs SessionIDs
[WebKit-https.git] / Source / WebCore / fileapi / File.h
1 /*
2  * Copyright (C) 2008-2019 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 #pragma once
27
28 #include "Blob.h"
29 #include <wtf/IsoMalloc.h>
30 #include <wtf/Optional.h>
31 #include <wtf/Ref.h>
32 #include <wtf/TypeCasts.h>
33 #include <wtf/text/WTFString.h>
34
35 namespace WebCore {
36
37 class File final : public Blob {
38     WTF_MAKE_ISO_ALLOCATED_EXPORT(File, WEBCORE_EXPORT);
39 public:
40     struct PropertyBag : BlobPropertyBag {
41         Optional<int64_t> lastModified;
42     };
43
44     // Create a file with an optional name exposed to the author (via File.name and associated DOM properties) that differs from the one provided in the path.
45     WEBCORE_EXPORT static Ref<File> create(const String& path, const String& nameOverride = { });
46
47     // Create a File using the 'new File' constructor.
48     static Ref<File> create(Vector<BlobPartVariant>&& blobPartVariants, const String& filename, const PropertyBag& propertyBag)
49     {
50         return adoptRef(*new File(WTFMove(blobPartVariants), filename, propertyBag));
51     }
52
53     static Ref<File> deserialize(const String& path, const URL& srcURL, const String& type, const String& name, const Optional<int64_t>& lastModified = WTF::nullopt)
54     {
55         return adoptRef(*new File(deserializationContructor, path, srcURL, type, name, lastModified));
56     }
57
58     static Ref<File> create(const Blob& blob, const String& name)
59     {
60         return adoptRef(*new File(blob, name));
61     }
62
63     static Ref<File> create(const File& file, const String& name)
64     {
65         return adoptRef(*new File(file, name));
66     }
67
68     static Ref<File> createWithRelativePath(const String& path, const String& relativePath);
69
70     bool isFile() const override { return true; }
71
72     const String& path() const { return m_path; }
73     const String& relativePath() const { return m_relativePath; }
74     void setRelativePath(const String& relativePath) { m_relativePath = relativePath; }
75     const String& name() const { return m_name; }
76     WEBCORE_EXPORT int64_t lastModified() const; // Number of milliseconds since Epoch.
77     const Optional<int64_t>& lastModifiedOverride() const { return m_lastModifiedDateOverride; } // Number of milliseconds since Epoch.
78
79     static String contentTypeForFile(const String& path);
80
81 #if ENABLE(FILE_REPLACEMENT)
82     static bool shouldReplaceFile(const String& path);
83 #endif
84
85     bool isDirectory() const;
86
87 private:
88     WEBCORE_EXPORT explicit File(const String& path);
89     File(URL&&, String&& type, String&& path, String&& name);
90     File(Vector<BlobPartVariant>&& blobPartVariants, const String& filename, const PropertyBag&);
91     File(const Blob&, const String& name);
92     File(const File&, const String& name);
93
94     File(DeserializationContructor, const String& path, const URL& srcURL, const String& type, const String& name, const Optional<int64_t>& lastModified);
95
96     static void computeNameAndContentType(const String& path, const String& nameOverride, String& effectiveName, String& effectiveContentType);
97 #if ENABLE(FILE_REPLACEMENT)
98     static void computeNameAndContentTypeForReplacedFile(const String& path, const String& nameOverride, String& effectiveName, String& effectiveContentType);
99 #endif
100
101     String m_path;
102     String m_relativePath;
103     String m_name;
104
105     Optional<int64_t> m_lastModifiedDateOverride;
106     mutable Optional<bool> m_isDirectory;
107 };
108
109 } // namespace WebCore
110
111 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::File)
112     static bool isType(const WebCore::Blob& blob) { return blob.isFile(); }
113 SPECIALIZE_TYPE_TRAITS_END()