Move URL from WebCore to WTF
[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 #pragma once
27
28 #include "Blob.h"
29 #include <wtf/Optional.h>
30 #include <wtf/Ref.h>
31 #include <wtf/TypeCasts.h>
32 #include <wtf/text/WTFString.h>
33
34 namespace WebCore {
35
36 class File final : public Blob {
37 public:
38     struct PropertyBag : BlobPropertyBag {
39         std::optional<int64_t> lastModified;
40     };
41
42     static Ref<File> create(const String& path)
43     {
44         return adoptRef(*new File(path));
45     }
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 std::optional<int64_t>& lastModified = std::nullopt)
54     {
55         return adoptRef(*new File(deserializationContructor, path, srcURL, type, name, lastModified));
56     }
57
58     // 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.
59     static Ref<File> createWithName(const String& path, const String& nameOverride)
60     {
61         if (nameOverride.isEmpty())
62             return adoptRef(*new File(path));
63         return adoptRef(*new File(path, nameOverride));
64     }
65
66     static Ref<File> create(const Blob& blob, const String& name)
67     {
68         return adoptRef(*new File(blob, name));
69     }
70
71     static Ref<File> create(const File& file, const String& name)
72     {
73         return adoptRef(*new File(file, name));
74     }
75
76     static Ref<File> createWithRelativePath(const String& path, const String& relativePath);
77
78     bool isFile() const override { return true; }
79
80     const String& path() const { return m_path; }
81     const String& relativePath() const { return m_relativePath; }
82     void setRelativePath(const String& relativePath) { m_relativePath = relativePath; }
83     const String& name() const { return m_name; }
84     WEBCORE_EXPORT int64_t lastModified() const; // Number of milliseconds since Epoch.
85     const std::optional<int64_t>& lastModifiedOverride() const { return m_lastModifiedDateOverride; } // Number of milliseconds since Epoch.
86
87     static String contentTypeForFile(const String& path);
88
89 #if ENABLE(FILE_REPLACEMENT)
90     static bool shouldReplaceFile(const String& path);
91 #endif
92
93     bool isDirectory() const;
94
95 private:
96     WEBCORE_EXPORT explicit File(const String& path);
97     File(const String& path, const String& nameOverride);
98     File(Vector<BlobPartVariant>&& blobPartVariants, const String& filename, const PropertyBag&);
99     File(const Blob&, const String& name);
100     File(const File&, const String& name);
101
102     File(DeserializationContructor, const String& path, const URL& srcURL, const String& type, const String& name, const std::optional<int64_t>& lastModified);
103
104     static void computeNameAndContentType(const String& path, const String& nameOverride, String& effectiveName, String& effectiveContentType);
105 #if ENABLE(FILE_REPLACEMENT)
106     static void computeNameAndContentTypeForReplacedFile(const String& path, const String& nameOverride, String& effectiveName, String& effectiveContentType);
107 #endif
108
109     String m_path;
110     String m_relativePath;
111     String m_name;
112
113     std::optional<int64_t> m_lastModifiedDateOverride;
114     mutable std::optional<bool> m_isDirectory;
115 };
116
117 } // namespace WebCore
118
119 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::File)
120     static bool isType(const WebCore::Blob& blob) { return blob.isFile(); }
121 SPECIALIZE_TYPE_TRAITS_END()