dom/file/MultipartBlobImpl.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_MultipartBlobImpl_h
   8 #define mozilla_dom_MultipartBlobImpl_h
   9
  10 #include <utility>
  11
  12 #include "Blob.h"
  13 #include "nsContentUtils.h"
  14 #include "mozilla/Attributes.h"
  15 #include "mozilla/Maybe.h"
  16 #include "mozilla/dom/BaseBlobImpl.h"
  17
  18 namespace mozilla {
  19 class ErrorResult;
  20
  21 namespace dom {
  22
  23 // This is just a sentinel value to be sure that we don't call
  24 // SetLengthAndModifiedDate more than once.
  25 constexpr int64_t MULTIPARTBLOBIMPL_UNKNOWN_LAST_MODIFIED = INT64_MAX;
  26 constexpr uint64_t MULTIPARTBLOBIMPL_UNKNOWN_LENGTH = UINT64_MAX;
  27
  28 class MultipartBlobImpl final : public BaseBlobImpl {
  29  public:
  30   NS_INLINE_DECL_REFCOUNTING_INHERITED(MultipartBlobImpl, BaseBlobImpl)
  31
  32   // Create as a file
  33   static already_AddRefed<MultipartBlobImpl> Create(
  34       nsTArray<RefPtr<BlobImpl>>&& aBlobImpls, const nsAString& aName,
  35       const nsAString& aContentType, RTPCallerType aRTPCallerType,
  36       ErrorResult& aRv);
  37
  38   // Create as a blob
  39   static already_AddRefed<MultipartBlobImpl> Create(
  40       nsTArray<RefPtr<BlobImpl>>&& aBlobImpls, const nsAString& aContentType,
  41       ErrorResult& aRv);
  42
  43   // Create as a file to be later initialized
  44   explicit MultipartBlobImpl(const nsAString& aName)
  45       : BaseBlobImpl(aName, u""_ns, MULTIPARTBLOBIMPL_UNKNOWN_LENGTH,
  46                      MULTIPARTBLOBIMPL_UNKNOWN_LAST_MODIFIED) {}
  47
  48   // Create as a blob to be later initialized
  49   MultipartBlobImpl()
  50       : BaseBlobImpl(u""_ns, MULTIPARTBLOBIMPL_UNKNOWN_LENGTH) {}
  51
  52   void InitializeBlob(RTPCallerType aRTPCallerType, ErrorResult& aRv);
  53
  54   void InitializeBlob(const Sequence<Blob::BlobPart>& aData,
  55                       const nsAString& aContentType, bool aNativeEOL,
  56                       RTPCallerType aRTPCallerType, ErrorResult& aRv);
  57
  58   already_AddRefed<BlobImpl> CreateSlice(uint64_t aStart, uint64_t aLength,
  59                                          const nsAString& aContentType,
  60                                          ErrorResult& aRv) const override;
  61
  62   uint64_t GetSize(ErrorResult& aRv) override { return mLength; }
  63
  64   void CreateInputStream(nsIInputStream** aStream,
  65                          ErrorResult& aRv) const override;
  66
  67   const nsTArray<RefPtr<BlobImpl>>* GetSubBlobImpls() const override {
  68     return mBlobImpls.Length() ? &mBlobImpls : nullptr;
  69   }
  70
  71   void SetName(const nsAString& aName) { mName = aName; }
  72
  73   size_t GetAllocationSize() const override;
  74   size_t GetAllocationSize(
  75       FallibleTArray<BlobImpl*>& aVisitedBlobs) const override;
  76
  77   void GetBlobImplType(nsAString& aBlobImplType) const override;
  78
  79   void SetLastModified(int64_t aLastModified);
  80
  81  protected:
  82   // File constructor.
  83   MultipartBlobImpl(nsTArray<RefPtr<BlobImpl>>&& aBlobImpls,
  84                     const nsAString& aName, const nsAString& aContentType)
  85       : BaseBlobImpl(aName, aContentType, MULTIPARTBLOBIMPL_UNKNOWN_LENGTH,
  86                      MULTIPARTBLOBIMPL_UNKNOWN_LAST_MODIFIED),
  87         mBlobImpls(std::move(aBlobImpls)) {}
  88
  89   // Blob constructor.
  90   MultipartBlobImpl(nsTArray<RefPtr<BlobImpl>>&& aBlobImpls,
  91                     const nsAString& aContentType)
  92       : BaseBlobImpl(aContentType, MULTIPARTBLOBIMPL_UNKNOWN_LENGTH),
  93         mBlobImpls(std::move(aBlobImpls)) {}
  94
  95   ~MultipartBlobImpl() override = default;
  96
  97   void SetLengthAndModifiedDate(const Maybe<RTPCallerType>& aRTPCallerType,
  98                                 ErrorResult& aRv);
  99
 100   nsTArray<RefPtr<BlobImpl>> mBlobImpls;
 101 };
 102
 103 }  // namespace dom
 104 }  // namespace mozilla
 105
 106 #endif  // mozilla_dom_MultipartBlobImpl_h