netwerk/streamconv/converters/nsHTTPCompressConv.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set sw=2 ts=8 et 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 #if !defined(__nsHTTPCompressConv__h__)
   8 #  define __nsHTTPCompressConv__h__ 1
   9
  10 #  include "nsIStreamConverter.h"
  11 #  include "nsICompressConvStats.h"
  12 #  include "nsIThreadRetargetableStreamListener.h"
  13 #  include "nsCOMPtr.h"
  14 #  include "mozilla/Atomics.h"
  15 #  include "mozilla/Mutex.h"
  16
  17 #  include "zlib.h"
  18
  19 class nsIStringInputStream;
  20
  21 #  define NS_HTTPCOMPRESSCONVERTER_CID                 \
  22     {                                                  \
  23       /* 66230b2b-17fa-4bd3-abf4-07986151022d */       \
  24       0x66230b2b, 0x17fa, 0x4bd3, {                    \
  25         0xab, 0xf4, 0x07, 0x98, 0x61, 0x51, 0x02, 0x2d \
  26       }                                                \
  27     }
  28
  29 #  define HTTP_DEFLATE_TYPE "deflate"
  30 #  define HTTP_GZIP_TYPE "gzip"
  31 #  define HTTP_X_GZIP_TYPE "x-gzip"
  32 #  define HTTP_COMPRESS_TYPE "compress"
  33 #  define HTTP_X_COMPRESS_TYPE "x-compress"
  34 #  define HTTP_BROTLI_TYPE "br"
  35 #  define HTTP_IDENTITY_TYPE "identity"
  36 #  define HTTP_UNCOMPRESSED_TYPE "uncompressed"
  37 #  define HTTP_ZSTD_TYPE "zstd"
  38 #  define HTTP_ZST_TYPE "zst"
  39
  40 namespace mozilla {
  41 namespace net {
  42
  43 class BrotliWrapper;
  44 class ZstdWrapper;
  45
  46 class nsHTTPCompressConv : public nsIStreamConverter,
  47                            public nsICompressConvStats {
  48  public:
  49   // nsISupports methods
  50   NS_DECL_THREADSAFE_ISUPPORTS
  51   NS_DECL_NSIREQUESTOBSERVER
  52   NS_DECL_NSISTREAMLISTENER
  53   NS_DECL_NSICOMPRESSCONVSTATS
  54   NS_DECL_NSITHREADRETARGETABLESTREAMLISTENER
  55
  56   // nsIStreamConverter methods
  57   NS_DECL_NSISTREAMCONVERTER
  58
  59   nsHTTPCompressConv();
  60
  61   using CompressMode = enum {
  62     HTTP_COMPRESS_GZIP,
  63     HTTP_COMPRESS_DEFLATE,
  64     HTTP_COMPRESS_COMPRESS,
  65     HTTP_COMPRESS_BROTLI,
  66     HTTP_COMPRESS_IDENTITY,
  67     HTTP_COMPRESS_ZSTD,
  68   };
  69
  70  private:
  71   virtual ~nsHTTPCompressConv();
  72
  73   nsCOMPtr<nsIStreamListener>
  74       mListener;  // this guy gets the converted data via his OnDataAvailable ()
  75   Atomic<CompressMode, Relaxed> mMode{HTTP_COMPRESS_IDENTITY};
  76
  77   unsigned char* mOutBuffer{nullptr};
  78   unsigned char* mInpBuffer{nullptr};
  79
  80   uint32_t mOutBufferLen{0};
  81   uint32_t mInpBufferLen{0};
  82
  83   UniquePtr<BrotliWrapper> mBrotli;
  84   UniquePtr<ZstdWrapper> mZstd;
  85
  86   nsCOMPtr<nsIStringInputStream> mStream;
  87
  88   static nsresult BrotliHandler(nsIInputStream* stream, void* closure,
  89                                 const char* dataIn, uint32_t, uint32_t avail,
  90                                 uint32_t* countRead);
  91
  92   static nsresult ZstdHandler(nsIInputStream* stream, void* closure,
  93                               const char* dataIn, uint32_t, uint32_t avail,
  94                               uint32_t* countRead);
  95
  96   nsresult do_OnDataAvailable(nsIRequest* request, uint64_t aSourceOffset,
  97                               const char* buffer, uint32_t aCount);
  98
  99   bool mCheckHeaderDone{false};
 100   Atomic<bool> mStreamEnded{false};
 101   bool mStreamInitialized{false};
 102   bool mDummyStreamInitialised{false};
 103   bool mFailUncleanStops;
 104   bool mDispatchToMainThread{false};
 105
 106   z_stream d_stream{};
 107   unsigned mLen{0}, hMode{0}, mSkipCount{0}, mFlags{0};
 108
 109   uint32_t check_header(nsIInputStream* iStr, uint32_t streamLen, nsresult* rs);
 110
 111   Atomic<uint32_t, Relaxed> mDecodedDataLength{0};
 112
 113   mutable mozilla::Mutex mMutex MOZ_UNANNOTATED{"nsHTTPCompressConv"};
 114 };
 115
 116 }  // namespace net
 117 }  // namespace mozilla
 118
 119 #endif