The Tor Browser: modules/libjar/nsJAR.h@b8a032363ba2 (annotated)

modules/libjar/nsJAR.h@b8a032363ba2 (annotated)

modules/libjar/nsJAR.h

Thu, 22 Jan 2015 13:21:57 +0100

author: Michael Schloh von Bennewitz <michael@schloh.com>
date: Thu, 22 Jan 2015 13:21:57 +0100
branch: TOR_BUG_9701
changeset 15: b8a032363ba2
permissions: -rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

 /* -*- 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 nsJAR_h_
 #define nsJAR_h_
 #include "nscore.h"
 #include "prio.h"
 #include "plstr.h"
 #include "prlog.h"
 #include "prinrval.h"
 #include "mozilla/Mutex.h"
 #include "nsIComponentManager.h"
 #include "nsCOMPtr.h"
 #include "nsClassHashtable.h"
 #include "nsString.h"
 #include "nsIFile.h"
 #include "nsStringEnumerator.h"
 #include "nsHashKeys.h"
 #include "nsRefPtrHashtable.h"
 #include "nsTHashtable.h"
 #include "nsIZipReader.h"
 #include "nsZipArchive.h"
 #include "nsICertificatePrincipal.h"
 #include "nsISignatureVerifier.h"
 #include "nsIObserverService.h"
 #include "nsWeakReference.h"
 #include "nsIObserver.h"
 #include "mozilla/Attributes.h"
 class nsIInputStream;
 class nsJARManifestItem;
 class nsZipReaderCache;
 /* For mManifestStatus */
 typedef enum
 {
   JAR_MANIFEST_NOT_PARSED = 0,
   JAR_VALID_MANIFEST      = 1,
   JAR_INVALID_SIG         = 2,
   JAR_INVALID_UNKNOWN_CA  = 3,
   JAR_INVALID_MANIFEST    = 4,
   JAR_INVALID_ENTRY       = 5,
   JAR_NO_MANIFEST         = 6,
   JAR_NOT_SIGNED          = 7
 } JARManifestStatusType;
 /*-------------------------------------------------------------------------
  * Class nsJAR declaration.
  * nsJAR serves as an XPCOM wrapper for nsZipArchive with the addition of
  * JAR manifest file parsing.
  *------------------------------------------------------------------------*/
 class nsJAR : public nsIZipReader
 {
   // Allows nsJARInputStream to call the verification functions
   friend class nsJARInputStream;
   // Allows nsZipReaderCache to access mOuterZipEntry
   friend class nsZipReaderCache;
   public:
     nsJAR();
     virtual ~nsJAR();
     NS_DEFINE_STATIC_CID_ACCESSOR( NS_ZIPREADER_CID )
     NS_DECL_THREADSAFE_ISUPPORTS
     NS_DECL_NSIZIPREADER
     nsresult GetJarPath(nsACString& aResult);
     PRIntervalTime GetReleaseTime() {
         return mReleaseTime;
     }
     bool IsReleased() {
         return mReleaseTime != PR_INTERVAL_NO_TIMEOUT;
     }
     void SetReleaseTime() {
       mReleaseTime = PR_IntervalNow();
     }
     void ClearReleaseTime() {
       mReleaseTime = PR_INTERVAL_NO_TIMEOUT;
     }
     void SetZipReaderCache(nsZipReaderCache* cache) {
       mCache = cache;
     }
   protected:
     typedef nsClassHashtable<nsCStringHashKey, nsJARManifestItem> ManifestDataHashtable;
     //-- Private data members
     nsCOMPtr<nsIFile>        mZipFile;        // The zip/jar file on disk
     nsCString                mOuterZipEntry;  // The entry in the zip this zip is reading from
     nsRefPtr<nsZipArchive>   mZip;            // The underlying zip archive
     ManifestDataHashtable    mManifestData;   // Stores metadata for each entry
     bool                     mParsedManifest; // True if manifest has been parsed
     nsCOMPtr<nsICertificatePrincipal> mPrincipal; // The entity which signed this file
     int16_t                  mGlobalStatus;   // Global signature verification status
     PRIntervalTime           mReleaseTime;    // used by nsZipReaderCache for flushing entries
     nsZipReaderCache*        mCache;          // if cached, this points to the cache it's contained in
     mozilla::Mutex           mLock;
     int64_t                  mMtime;
     int32_t                  mTotalItemsInManifest;
     bool                     mOpened;
     nsresult ParseManifest();
     void     ReportError(const nsACString &aFilename, int16_t errorCode);
     nsresult LoadEntry(const nsACString &aFilename, char** aBuf,
                        uint32_t* aBufLen = nullptr);
     int32_t  ReadLine(const char** src);
     nsresult ParseOneFile(const char* filebuf, int16_t aFileType);
     nsresult VerifyEntry(nsJARManifestItem* aEntry, const char* aEntryData,
                          uint32_t aLen);
     nsresult CalculateDigest(const char* aInBuf, uint32_t aInBufLen,
                              nsCString& digest);
 };
 /**
  * nsJARItem
  *
  * An individual JAR entry. A set of nsJARItems matching a
  * supplied pattern are returned in a nsJAREnumerator.
  */
 class nsJARItem : public nsIZipEntry
 {
 public:
     NS_DECL_THREADSAFE_ISUPPORTS
     NS_DECL_NSIZIPENTRY
     nsJARItem(nsZipItem* aZipItem);
     virtual ~nsJARItem() {}
 private:
     uint32_t     mSize;             /* size in original file */
     uint32_t     mRealsize;         /* inflated size */
     uint32_t     mCrc32;
     PRTime       mLastModTime;
     uint16_t     mCompression;
     uint32_t     mPermissions;
     bool mIsDirectory;
     bool mIsSynthetic;
 };
 /**
  * nsJAREnumerator
  *
  * Enumerates a list of files in a zip archive
  * (based on a pattern match in its member nsZipFind).
  */
 class nsJAREnumerator MOZ_FINAL : public nsIUTF8StringEnumerator
 {
 public:
     NS_DECL_THREADSAFE_ISUPPORTS
     NS_DECL_NSIUTF8STRINGENUMERATOR
     nsJAREnumerator(nsZipFind *aFind) : mFind(aFind), mName(nullptr) {
       NS_ASSERTION(mFind, "nsJAREnumerator: Missing zipFind.");
     }
 private:
     nsZipFind    *mFind;
     const char*   mName;    // pointer to an name owned by mArchive -- DON'T delete
     uint16_t      mNameLen;
     ~nsJAREnumerator() { delete mFind; }
 };
 ////////////////////////////////////////////////////////////////////////////////
 #if defined(DEBUG_warren) || defined(DEBUG_jband)
 #define ZIP_CACHE_HIT_RATE
 #endif
 class nsZipReaderCache : public nsIZipReaderCache, public nsIObserver,
                          public nsSupportsWeakReference
 {
 public:
   NS_DECL_THREADSAFE_ISUPPORTS
   NS_DECL_NSIZIPREADERCACHE
   NS_DECL_NSIOBSERVER
   nsZipReaderCache();
   virtual ~nsZipReaderCache();
   nsresult ReleaseZip(nsJAR* reader);
   typedef nsRefPtrHashtable<nsCStringHashKey, nsJAR> ZipsHashtable;
 protected:
   mozilla::Mutex        mLock;
   uint32_t              mCacheSize;
   ZipsHashtable         mZips;
 #ifdef ZIP_CACHE_HIT_RATE
   uint32_t              mZipCacheLookups;
   uint32_t              mZipCacheHits;
   uint32_t              mZipCacheFlushes;
   uint32_t              mZipSyncMisses;
 #endif
 };
 ////////////////////////////////////////////////////////////////////////////////
 #endif /* nsJAR_h_ */

The Tor Browser / annotate

modules/libjar/nsJAR.h@b8a032363ba2 (annotated)

modules/libjar/nsJAR.h