Home | History | Annotate | Download | only in fileapi 
      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 "wtf/PassRefPtr.h"
     31 #include "wtf/text/WTFString.h"
     32 
     33 namespace WebCore {
     34 
     35 struct FileMetadata;
     36 class KURL;
     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 KURL& srcURL, const String& type)
     54     {
     55         return adoptRef(new File(path, srcURL, type));
     56     }
     57 
     58     static PassRefPtr<File> createWithRelativePath(const String& path, const String& relativePath);
     59 
     60     // 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.
     61     //
     62     // Otherwise calling size(), lastModifiedTime() and slice() will synchronously query the file metadata.
     63     static PassRefPtr<File> createForFileSystemFile(const String& name, const FileMetadata& metadata)
     64     {
     65         return adoptRef(new File(name, metadata));
     66     }
     67 
     68     static PassRefPtr<File> createForFileSystemFile(const KURL& url, const FileMetadata& metadata)
     69     {
     70         return adoptRef(new File(url, metadata));
     71     }
     72 
     73     KURL fileSystemURL() const { return m_fileSystemURL; }
     74 
     75     // 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.
     76     static PassRefPtr<File> createWithName(const String& path, const String& name, ContentTypeLookupPolicy policy = WellKnownContentTypes)
     77     {
     78         if (name.isEmpty())
     79             return adoptRef(new File(path, policy));
     80         return adoptRef(new File(path, name, policy));
     81     }
     82 
     83     virtual unsigned long long size() const;
     84     virtual bool isFile() const { return true; }
     85 
     86     const String& path() const { return m_path; }
     87     const String& name() const { return m_name; }
     88 
     89     // 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).
     90     double lastModifiedDate() const;
     91 
     92     // Returns the relative path of this file in the context of a directory selection.
     93     const String& webkitRelativePath() const { return m_relativePath; }
     94 
     95     // Note that this involves synchronous file operation. Think twice before calling this function.
     96     void captureSnapshot(long long& snapshotSize, double& snapshotModificationTime) const;
     97 
     98 private:
     99     File(const String& path, ContentTypeLookupPolicy);
    100 
    101     // For deserialization.
    102     File(const String& path, const KURL& srcURL, const String& type);
    103     File(const String& path, const String& name, ContentTypeLookupPolicy);
    104     File(const String& name, const FileMetadata&);
    105     File(const KURL& fileSystemURL, const FileMetadata&);
    106 
    107     // Returns true if this has a valid snapshot metadata (i.e. m_snapshotSize >= 0).
    108     bool hasValidSnapshotMetadata() const { return m_snapshotSize >= 0; }
    109 
    110     String m_path;
    111     String m_name;
    112 
    113     KURL m_fileSystemURL;
    114 
    115     // 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().
    116     // Otherwise, the snapshot metadata are used directly in those methods.
    117     const long long m_snapshotSize;
    118     const double m_snapshotModificationTime;
    119 
    120     String m_relativePath;
    121 };
    122 
    123 inline File* toFile(Blob* blob)
    124 {
    125     ASSERT_WITH_SECURITY_IMPLICATION(!blob || blob->isFile());
    126     return static_cast<File*>(blob);
    127 }
    128 
    129 inline const File* toFile(const Blob* blob)
    130 {
    131     ASSERT_WITH_SECURITY_IMPLICATION(!blob || blob->isFile());
    132     return static_cast<const File*>(blob);
    133 }
    134 
    135 } // namespace WebCore
    136 
    137 #endif // File_h
    138