dom/file/BaseBlobImpl.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef mozilla_dom_BaseBlobImpl_h
   8 #define mozilla_dom_BaseBlobImpl_h
   9
  10 #include "mozilla/dom/BlobImpl.h"
  11
  12 namespace mozilla {
  13 namespace dom {
  14
  15 class BaseBlobImpl : public BlobImpl
  16 {
  17 public:
  18   BaseBlobImpl(const nsAString& aName, const nsAString& aContentType,
  19                uint64_t aLength, int64_t aLastModifiedDate)
  20     : mIsFile(true)
  21     , mImmutable(false)
  22     , mContentType(aContentType)
  23     , mName(aName)
  24     , mStart(0)
  25     , mLength(aLength)
  26     , mLastModificationDate(aLastModifiedDate)
  27     , mSerialNumber(NextSerialNumber())
  28   {
  29     // Ensure non-null mContentType by default
  30     mContentType.SetIsVoid(false);
  31   }
  32
  33   BaseBlobImpl(const nsAString& aName, const nsAString& aContentType,
  34                uint64_t aLength)
  35     : mIsFile(true)
  36     , mImmutable(false)
  37     , mContentType(aContentType)
  38     , mName(aName)
  39     , mStart(0)
  40     , mLength(aLength)
  41     , mLastModificationDate(INT64_MAX)
  42     , mSerialNumber(NextSerialNumber())
  43   {
  44     // Ensure non-null mContentType by default
  45     mContentType.SetIsVoid(false);
  46   }
  47
  48   BaseBlobImpl(const nsAString& aContentType, uint64_t aLength)
  49     : mIsFile(false)
  50     , mImmutable(false)
  51     , mContentType(aContentType)
  52     , mStart(0)
  53     , mLength(aLength)
  54     , mLastModificationDate(INT64_MAX)
  55     , mSerialNumber(NextSerialNumber())
  56   {
  57     // Ensure non-null mContentType by default
  58     mContentType.SetIsVoid(false);
  59   }
  60
  61   BaseBlobImpl(const nsAString& aContentType, uint64_t aStart,
  62                uint64_t aLength)
  63     : mIsFile(false)
  64     , mImmutable(false)
  65     , mContentType(aContentType)
  66     , mStart(aStart)
  67     , mLength(aLength)
  68     , mLastModificationDate(INT64_MAX)
  69     , mSerialNumber(NextSerialNumber())
  70   {
  71     MOZ_ASSERT(aLength != UINT64_MAX, "Must know length when creating slice");
  72     // Ensure non-null mContentType by default
  73     mContentType.SetIsVoid(false);
  74   }
  75
  76   virtual void GetName(nsAString& aName) const override;
  77
  78   virtual void GetDOMPath(nsAString& aName) const override;
  79
  80   virtual void SetDOMPath(const nsAString& aName) override;
  81
  82   virtual int64_t GetLastModified(ErrorResult& aRv) override;
  83
  84   virtual void SetLastModified(int64_t aLastModified) override;
  85
  86   virtual void GetMozFullPath(nsAString& aName,
  87                               SystemCallerGuarantee /* unused */,
  88                               ErrorResult& aRv) const override;
  89
  90   virtual void GetMozFullPathInternal(nsAString& aFileName,
  91                                       ErrorResult& aRv) const override;
  92
  93   virtual uint64_t GetSize(ErrorResult& aRv) override
  94   {
  95     return mLength;
  96   }
  97
  98   virtual void GetType(nsAString& aType) override;
  99
 100   size_t GetAllocationSize() const override
 101   {
 102     return 0;
 103   }
 104
 105   virtual uint64_t GetSerialNumber() const override { return mSerialNumber; }
 106
 107   virtual already_AddRefed<BlobImpl>
 108   CreateSlice(uint64_t aStart, uint64_t aLength,
 109               const nsAString& aContentType, ErrorResult& aRv) override
 110   {
 111     return nullptr;
 112   }
 113
 114   virtual const nsTArray<RefPtr<BlobImpl>>*
 115   GetSubBlobImpls() const override
 116   {
 117     return nullptr;
 118   }
 119
 120   virtual void CreateInputStream(nsIInputStream** aStream,
 121                                  ErrorResult& aRv) override
 122   {
 123     aRv.Throw(NS_ERROR_NOT_IMPLEMENTED);
 124   }
 125
 126   virtual int64_t GetFileId() override;
 127
 128   virtual nsresult GetSendInfo(nsIInputStream** aBody,
 129                                uint64_t* aContentLength,
 130                                nsACString& aContentType,
 131                                nsACString& aCharset) override;
 132
 133   virtual nsresult GetMutable(bool* aMutable) const override;
 134
 135   virtual nsresult SetMutable(bool aMutable) override;
 136
 137   virtual void
 138   SetLazyData(const nsAString& aName, const nsAString& aContentType,
 139               uint64_t aLength, int64_t aLastModifiedDate) override
 140   {
 141     mName = aName;
 142     mContentType = aContentType;
 143     mLength = aLength;
 144     mLastModificationDate = aLastModifiedDate;
 145     mIsFile = !aName.IsVoid();
 146   }
 147
 148   virtual bool IsMemoryFile() const override
 149   {
 150     return false;
 151   }
 152
 153   virtual bool IsDateUnknown() const override
 154   {
 155     return mIsFile && mLastModificationDate == INT64_MAX;
 156   }
 157
 158   virtual bool IsFile() const override
 159   {
 160     return mIsFile;
 161   }
 162
 163   virtual bool IsSizeUnknown() const override
 164   {
 165     return mLength == UINT64_MAX;
 166   }
 167
 168 protected:
 169   virtual ~BaseBlobImpl() {}
 170
 171   /**
 172    * Returns a new, effectively-unique serial number. This should be used
 173    * by implementations to obtain a serial number for GetSerialNumber().
 174    * The implementation is thread safe.
 175    */
 176   static uint64_t NextSerialNumber();
 177
 178   bool mIsFile;
 179   bool mImmutable;
 180
 181   nsString mContentType;
 182   nsString mName;
 183   nsString mPath; // The path relative to a directory chosen by the user
 184
 185   uint64_t mStart;
 186   uint64_t mLength;
 187
 188   int64_t mLastModificationDate;
 189
 190   const uint64_t mSerialNumber;
 191 };
 192
 193 } // namespace dom
 194 } // namespace mozilla
 195
 196 #endif // mozilla_dom_BaseBlobImpl_h