Have getFileMetadata() return a std::optional<FileMetadata>
[WebKit-https.git] / Source / WebCore / platform / network / BlobDataFileReference.cpp
1 /*
2  * Copyright (C) 2014 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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #include "BlobDataFileReference.h"
28
29 #include "File.h"
30 #include "FileMetadata.h"
31 #include "FileSystem.h"
32
33 namespace WebCore {
34
35 BlobDataFileReference::BlobDataFileReference(const String& path)
36     : m_path(path)
37 #if ENABLE(FILE_REPLACEMENT)
38     , m_replacementShouldBeGenerated(false)
39 #endif
40     , m_size(0)
41     , m_expectedModificationTime(invalidFileTime())
42 {
43 }
44
45 BlobDataFileReference::~BlobDataFileReference()
46 {
47 #if ENABLE(FILE_REPLACEMENT)
48     if (!m_replacementPath.isNull())
49         deleteFile(m_replacementPath);
50 #endif
51 }
52
53 const String& BlobDataFileReference::path()
54 {
55 #if ENABLE(FILE_REPLACEMENT)
56     if (m_replacementShouldBeGenerated)
57         generateReplacementFile();
58
59     if (!m_replacementPath.isNull())
60         return m_replacementPath;
61 #endif
62
63     return m_path;
64 }
65
66 unsigned long long BlobDataFileReference::size()
67 {
68 #if ENABLE(FILE_REPLACEMENT)
69     if (m_replacementShouldBeGenerated)
70         generateReplacementFile();
71 #endif
72
73     return m_size;
74 }
75
76 double BlobDataFileReference::expectedModificationTime()
77 {
78 #if ENABLE(FILE_REPLACEMENT)
79     // We do not currently track modifications for generated files, because we have a snapshot.
80     // Unfortunately, this is inconsistent with regular file handling - File objects should be invalidated when underlying files change.
81     if (m_replacementShouldBeGenerated || !m_replacementPath.isNull())
82         return invalidFileTime();
83 #endif
84
85     return m_expectedModificationTime;
86 }
87
88 void BlobDataFileReference::startTrackingModifications()
89 {
90     // This is not done automatically by the constructor, because BlobDataFileReference is
91     // also used to pass paths around before registration. Only registered blobs need to pay
92     // the cost of tracking file modifications.
93
94 #if ENABLE(FILE_REPLACEMENT)
95     m_replacementShouldBeGenerated = File::shouldReplaceFile(m_path);
96 #endif
97
98     // FIXME: Some platforms provide better ways to listen for file system object changes, consider using these.
99     auto metadata = fileMetadataFollowingSymlinks(m_path);
100     if (!metadata)
101         return;
102
103     m_expectedModificationTime = metadata.value().modificationTime;
104
105 #if ENABLE(FILE_REPLACEMENT)
106     if (m_replacementShouldBeGenerated)
107         return;
108 #endif
109
110     m_size = metadata.value().length;
111 }
112
113 void BlobDataFileReference::prepareForFileAccess()
114 {
115 }
116
117 void BlobDataFileReference::revokeFileAccess()
118 {
119 }
120
121 }