netwerk/protocol/about/nsAboutCacheEntry.h
author Mozilla Releng Treescript <release+treescript@mozilla.org>
Fri, 27 May 2022 06:58:24 +0000
changeset 619020 ab65238291222763a2dd2f0ffc3c539d37a940f6
parent 595875 20db87ff5cb936f7c9ec5a48ea6e94c0aefba4e3
permissions -rw-r--r--
no bug - Bumping Firefox l10n changesets r=release a=l10n-bump DONTBUILD be -> 040b93d8fc0266fdc8696c86290152480570a8a8 eo -> 2aeb97991166e6e5d3514662ea7012744f724732 es-AR -> 3f2e985b37848b8d19ac9d01aa9ecd76895547bb it -> 12f68a74e363beee234126dcf25407f882d085ff

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef nsAboutCacheEntry_h__
#define nsAboutCacheEntry_h__

#include "nsIAboutModule.h"
#include "nsICacheEntryOpenCallback.h"
#include "nsICacheEntry.h"
#include "nsIStreamListener.h"
#include "nsString.h"
#include "nsCOMPtr.h"
#include "nsIChannel.h"

class nsIAsyncOutputStream;
class nsIInputStream;
class nsILoadContextInfo;
class nsIURI;

class nsAboutCacheEntry final : public nsIAboutModule {
 public:
  NS_DECL_ISUPPORTS
  NS_DECL_NSIABOUTMODULE

 private:
  virtual ~nsAboutCacheEntry() = default;

  class Channel final : public nsICacheEntryOpenCallback,
                        public nsICacheEntryMetaDataVisitor,
                        public nsIStreamListener,
                        public nsIChannel {
   public:
    NS_DECL_ISUPPORTS
    NS_DECL_NSICACHEENTRYOPENCALLBACK
    NS_DECL_NSICACHEENTRYMETADATAVISITOR
    NS_DECL_NSIREQUESTOBSERVER
    NS_DECL_NSISTREAMLISTENER
    NS_FORWARD_SAFE_NSICHANNEL(mChannel)
    NS_FORWARD_SAFE_NSIREQUEST(mChannel)

    Channel() = default;

   private:
    virtual ~Channel() = default;

   public:
    [[nodiscard]] nsresult Init(nsIURI* uri, nsILoadInfo* aLoadInfo);

    [[nodiscard]] nsresult GetContentStream(nsIURI*, nsIInputStream**);
    [[nodiscard]] nsresult OpenCacheEntry(nsIURI*);
    [[nodiscard]] nsresult OpenCacheEntry();
    [[nodiscard]] nsresult WriteCacheEntryDescription(nsICacheEntry*);
    [[nodiscard]] nsresult WriteCacheEntryUnavailable();
    [[nodiscard]] nsresult ParseURI(nsIURI* uri, nsACString& storageName,
                                    nsILoadContextInfo** loadInfo,
                                    nsCString& enahnceID, nsIURI** cacheUri);
    void CloseContent();

    [[nodiscard]] static nsresult PrintCacheData(
        nsIInputStream* aInStream, void* aClosure, const char* aFromSegment,
        uint32_t aToOffset, uint32_t aCount, uint32_t* aWriteCount);

   private:
    nsCString mStorageName, mEnhanceId;
    nsCOMPtr<nsILoadContextInfo> mLoadInfo;
    nsCOMPtr<nsIURI> mCacheURI;

    nsCString* mBuffer{nullptr};
    nsCOMPtr<nsIAsyncOutputStream> mOutputStream;
    bool mWaitingForData{false};
    uint32_t mHexDumpState{0};

    nsCOMPtr<nsIChannel> mChannel;
  };
};

#define NS_ABOUT_CACHE_ENTRY_MODULE_CID              \
  { /* 7fa5237d-b0eb-438f-9e50-ca0166e63788 */       \
    0x7fa5237d, 0xb0eb, 0x438f, {                    \
      0x9e, 0x50, 0xca, 0x01, 0x66, 0xe6, 0x37, 0x88 \
    }                                                \
  }

#endif  // nsAboutCacheEntry_h__