author Chris Double <>
Wed, 06 Aug 2008 12:47:37 +1200
changeset 16410 d9167d3c4207f461b551ea7aa509b19bc54be418
parent 731 bf26dee46a0a67175575b2ff6897dae6123ebf8d
child 20028 c61681813a11306289f4a0297a47e36b2dd85d63
permissions -rw-r--r--
Bug 448834. Move Ogg libraries from modules/ to media/. r+sr=roc

/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 * The Original Code is Mozilla Communicator client code, released
 * March 31, 1998.
 * The Initial Developer of the Original Code is
 * Netscape Communications Corporation.
 * Portions created by the Initial Developer are Copyright (C) 1998-2000
 * the Initial Developer. All Rights Reserved.
 * Contributor(s):
 *   Don Bragg <>
 *   Samir Gehani <>
 *   Mitch Stoltz <>
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 * ***** END LICENSE BLOCK ***** */

#ifndef nsJAR_h__
#define nsJAR_h__

#include "nscore.h"
#include "pratom.h"
#include "prmem.h"
#include "prio.h"
#include "plstr.h"
#include "prlog.h"
#include "prtypes.h"
#include "prinrval.h"

#include "nsIComponentManager.h"
#include "nsCOMPtr.h"
#include "nsString.h"
#include "nsIFile.h"
#include "nsStringEnumerator.h"
#include "nsHashtable.h"
#include "nsAutoLock.h"
#include "nsIZipReader.h"
#include "nsIJAR.h"
#include "nsZipArchive.h"
#include "zipfile.h"
#include "nsIPrincipal.h"
#include "nsISignatureVerifier.h"
#include "nsIObserverService.h"
#include "nsWeakReference.h"
#include "nsIObserver.h"

class nsIInputStream;
class nsJARManifestItem;
class nsZipReaderCache;

/* For mManifestStatus */
typedef enum
  JAR_INVALID_SIG         = 2,
  JAR_INVALID_ENTRY       = 5,
  JAR_NO_MANIFEST         = 6,
  JAR_NOT_SIGNED          = 7
} JARManifestStatusType;

PRTime GetModTime(PRUint16 aDate, PRUint16 aTime);

 * Class nsJAR declaration. 
 * nsJAR serves as an XPCOM wrapper for nsZipArchive with the addition of 
 * JAR manifest file parsing. 
class nsJAR : public nsIZipReader, public nsIJAR
  // Allows nsJARInputStream to call the verification functions
  friend class nsJARInputStream;


    virtual ~nsJAR();



    nsresult GetJarPath(nsACString& aResult);

    PRIntervalTime GetReleaseTime() {
        return mReleaseTime;
    PRBool 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;

    //-- Private data members
    nsCOMPtr<nsIFile>        mZipFile;        // The zip/jar file on disk
    nsZipArchive             mZip;            // The underlying zip archive
    nsObjectHashtable        mManifestData;   // Stores metadata for each entry
    PRBool                   mParsedManifest; // True if manifest has been parsed
    nsCOMPtr<nsIPrincipal>   mPrincipal;      // The entity which signed this file
    PRInt16                  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
    PRLock*                  mLock;	
    PRInt32                  mTotalItemsInManifest;
    //-- Private functions
    PRFileDesc* OpenFile();

    nsresult ParseManifest(nsISignatureVerifier* verifier);
    void     ReportError(const char* aFilename, PRInt16 errorCode);
    nsresult LoadEntry(const char* aFilename, char** aBuf, 
                       PRUint32* aBufLen = nsnull);
    PRInt32  ReadLine(const char** src); 
    nsresult ParseOneFile(const char* filebuf, PRInt16 aFileType);
    nsresult VerifyEntry(nsJARManifestItem* aEntry, const char* aEntryData, 
                         PRUint32 aLen);

    nsresult CalculateDigest(const char* aInBuf, PRUint32 aInBufLen,
                             char** digest);

    //-- Debugging
    void DumpMetadata(const char* aMessage);

 * nsJARItem
 * An individual JAR entry. A set of nsJARItems macthing a
 * supplied pattern are returned in a nsJAREnumerator.
class nsJARItem : public nsIZipEntry
    nsJARItem(nsZipItem* aZipItem);
    virtual ~nsJARItem() {}

    PRUint32     mSize;             /* size in original file */
    PRUint32     mRealsize;         /* inflated size */
    PRUint32     mCrc32;
    PRUint16     mDate;
    PRUint16     mTime;
    PRUint8      mCompression;
    PRPackedBool mIsDirectory; 
    PRPackedBool mIsSynthetic;

 * nsJAREnumerator
 * Enumerates a list of files in a zip archive 
 * (based on a pattern match in its member nsZipFind).
class nsJAREnumerator : public nsIUTF8StringEnumerator

    nsJAREnumerator(nsZipFind *aFind) : mFind(aFind), mCurr(nsnull) { 
      NS_ASSERTION(mFind, "nsJAREnumerator: Missing zipFind.");

    nsZipFind    *mFind;
    const char*   mCurr;    // pointer to an name owned by mArchive -- DON'T delete

    ~nsJAREnumerator() { delete mFind; }


#if defined(DEBUG_warren) || defined(DEBUG_jband)

class nsZipReaderCache : public nsIZipReaderCache, public nsIObserver,
                         public nsSupportsWeakReference

  virtual ~nsZipReaderCache();

  nsresult ReleaseZip(nsJAR* reader);

  PRLock*               mLock;
  PRInt32               mCacheSize;
  nsSupportsHashtable   mZips;

  PRUint32              mZipCacheLookups;
  PRUint32              mZipCacheHits;
  PRUint32              mZipCacheFlushes;
  PRUint32              mZipSyncMisses;



#endif /* nsJAR_h__ */