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 "core/fileapi/Blob.h" 30 #include "platform/heap/Handle.h" 31 #include "wtf/PassRefPtr.h" 32 #include "wtf/text/WTFString.h" 33 34 namespace blink { 35 36 class ExceptionState; 37 class ExecutionContext; 38 struct FileMetadata; 39 class KURL; 40 41 class File FINAL : public Blob { 42 DEFINE_WRAPPERTYPEINFO(); 43 public: 44 // AllContentTypes should only be used when the full path/name are trusted; otherwise, it could 45 // allow arbitrary pages to determine what applications an user has installed. 46 enum ContentTypeLookupPolicy { 47 WellKnownContentTypes, 48 AllContentTypes, 49 }; 50 51 // The user should not be able to browse to some files, such as the ones 52 // generated by the Filesystem API. 53 enum UserVisibility { IsUserVisible, IsNotUserVisible }; 54 55 static PassRefPtrWillBeRawPtr<File> create(const String& path, ContentTypeLookupPolicy policy = WellKnownContentTypes) 56 { 57 return adoptRefWillBeNoop(new File(path, policy, File::IsUserVisible)); 58 } 59 create(const String & name,double modificationTime,PassRefPtr<BlobDataHandle> blobDataHandle)60 static PassRefPtrWillBeRawPtr<File> create(const String& name, double modificationTime, PassRefPtr<BlobDataHandle> blobDataHandle) 61 { 62 return adoptRefWillBeNoop(new File(name, modificationTime, blobDataHandle)); 63 } 64 65 // For deserialization. createFromSerialization(const String & path,const String & name,const String & relativePath,UserVisibility userVisibility,bool hasSnaphotData,uint64_t size,double lastModified,PassRefPtr<BlobDataHandle> blobDataHandle)66 static PassRefPtrWillBeRawPtr<File> createFromSerialization(const String& path, const String& name, const String& relativePath, UserVisibility userVisibility, bool hasSnaphotData, uint64_t size, double lastModified, PassRefPtr<BlobDataHandle> blobDataHandle) 67 { 68 return adoptRefWillBeNoop(new File(path, name, relativePath, userVisibility, hasSnaphotData, size, lastModified, blobDataHandle)); 69 } createFromIndexedSerialization(const String & path,const String & name,uint64_t size,double lastModified,PassRefPtr<BlobDataHandle> blobDataHandle)70 static PassRefPtrWillBeRawPtr<File> createFromIndexedSerialization(const String& path, const String& name, uint64_t size, double lastModified, PassRefPtr<BlobDataHandle> blobDataHandle) 71 { 72 return adoptRefWillBeNoop(new File(path, name, String(), IsNotUserVisible, true, size, lastModified, blobDataHandle)); 73 } 74 75 static PassRefPtrWillBeRawPtr<File> createWithRelativePath(const String& path, const String& relativePath); 76 77 // 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. 78 // 79 // Otherwise calling size(), lastModifiedTime() and slice() will synchronously query the file metadata. createForFileSystemFile(const String & name,const FileMetadata & metadata,UserVisibility userVisibility)80 static PassRefPtrWillBeRawPtr<File> createForFileSystemFile(const String& name, const FileMetadata& metadata, UserVisibility userVisibility) 81 { 82 return adoptRefWillBeNoop(new File(name, metadata, userVisibility)); 83 } 84 createForFileSystemFile(const KURL & url,const FileMetadata & metadata)85 static PassRefPtrWillBeRawPtr<File> createForFileSystemFile(const KURL& url, const FileMetadata& metadata) 86 { 87 return adoptRefWillBeNoop(new File(url, metadata)); 88 } 89 fileSystemURL()90 KURL fileSystemURL() const { ASSERT(hasValidFileSystemURL()); return m_fileSystemURL; } 91 92 // 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. createForUserProvidedFile(const String & path,const String & displayName)93 static PassRefPtrWillBeRawPtr<File> createForUserProvidedFile(const String& path, const String& displayName) 94 { 95 if (displayName.isEmpty()) 96 return adoptRefWillBeNoop(new File(path, File::AllContentTypes, File::IsUserVisible)); 97 return adoptRefWillBeNoop(new File(path, displayName, File::AllContentTypes, File::IsUserVisible)); 98 } 99 100 static PassRefPtrWillBeRawPtr<File> createForFileSystemFile(const String& path, const String& name, ContentTypeLookupPolicy policy = WellKnownContentTypes) 101 { 102 if (name.isEmpty()) 103 return adoptRefWillBeNoop(new File(path, policy, File::IsNotUserVisible)); 104 return adoptRefWillBeNoop(new File(path, name, policy, File::IsNotUserVisible)); 105 } 106 107 virtual unsigned long long size() const OVERRIDE; 108 virtual PassRefPtrWillBeRawPtr<Blob> slice(long long start, long long end, const String& contentType, ExceptionState&) const OVERRIDE; 109 virtual void close(ExecutionContext*, ExceptionState&) OVERRIDE; 110 isFile()111 virtual bool isFile() const OVERRIDE { return true; } hasBackingFile()112 virtual bool hasBackingFile() const OVERRIDE { return m_hasBackingFile; } 113 114 virtual void appendTo(BlobData&) const OVERRIDE; 115 path()116 const String& path() const { ASSERT(hasValidFilePath()); return m_path; } name()117 const String name() const { return m_name; } 118 119 // Getter for the lastModified IDL attribute, 120 // http://dev.w3.org/2006/webapi/FileAPI/#file-attrs 121 long long lastModified() const; 122 123 // Getter for the lastModifiedDate IDL attribute, 124 // http://www.w3.org/TR/FileAPI/#dfn-lastModifiedDate 125 double lastModifiedDate() const; 126 userVisibility()127 UserVisibility userVisibility() const { return m_userVisibility; } 128 129 // Returns the relative path of this file in the context of a directory selection. webkitRelativePath()130 const String& webkitRelativePath() const { return m_relativePath; } 131 132 // Note that this involves synchronous file operation. Think twice before calling this function. 133 void captureSnapshot(long long& snapshotSize, double& snapshotModificationTime) const; 134 135 // Returns true if this has a valid snapshot metadata (i.e. m_snapshotSize >= 0). hasValidSnapshotMetadata()136 bool hasValidSnapshotMetadata() const { return m_snapshotSize >= 0; } 137 138 private: 139 File(const String& path, ContentTypeLookupPolicy, UserVisibility); 140 File(const String& path, const String& name, ContentTypeLookupPolicy, UserVisibility); 141 File(const String& path, const String& name, const String& relativePath, UserVisibility, bool hasSnaphotData, uint64_t size, double lastModified, PassRefPtr<BlobDataHandle>); 142 File(const String& name, double modificationTime, PassRefPtr<BlobDataHandle>); 143 File(const String& name, const FileMetadata&, UserVisibility); 144 File(const KURL& fileSystemURL, const FileMetadata&); 145 invalidateSnapshotMetadata()146 void invalidateSnapshotMetadata() { m_snapshotSize = -1; } 147 148 // Returns File's last modified time (in MS since Epoch.) 149 // If the modification time isn't known, the current time is returned. 150 double lastModifiedMS() const; 151 152 #if ENABLE(ASSERT) hasValidFileSystemURL()153 bool hasValidFileSystemURL() const { return hasBackingFile(); } 154 // Instances not backed by a file must have an empty path set. hasValidFilePath()155 bool hasValidFilePath() const { return hasBackingFile() || m_path.isEmpty(); } 156 #endif 157 158 bool m_hasBackingFile; 159 UserVisibility m_userVisibility; 160 String m_path; 161 String m_name; 162 163 KURL m_fileSystemURL; 164 165 // 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 slice(). 166 // Otherwise, the snapshot metadata are used directly in those methods. 167 long long m_snapshotSize; 168 const double m_snapshotModificationTime; 169 170 String m_relativePath; 171 }; 172 173 DEFINE_TYPE_CASTS(File, Blob, blob, blob->isFile(), blob.isFile()); 174 175 } // namespace blink 176 177 #endif // File_h 178