michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
michael@0:  */
michael@0: 
michael@0: #include "StreamFunctions.h"
michael@0: #include "nsZipHeader.h"
michael@0: #include "nsMemory.h"
michael@0: #include "prtime.h"
michael@0: 
michael@0: #define ZIP_FILE_HEADER_SIGNATURE 0x04034b50
michael@0: #define ZIP_FILE_HEADER_SIZE 30
michael@0: #define ZIP_CDS_HEADER_SIGNATURE 0x02014b50
michael@0: #define ZIP_CDS_HEADER_SIZE 46
michael@0: 
michael@0: #define FLAGS_IS_UTF8 0x800
michael@0: 
michael@0: #define ZIP_EXTENDED_TIMESTAMP_FIELD 0x5455
michael@0: #define ZIP_EXTENDED_TIMESTAMP_MODTIME 0x01
michael@0: 
michael@0: /**
michael@0:  * nsZipHeader represents an entry from a zip file.
michael@0:  */
michael@0: NS_IMPL_ISUPPORTS(nsZipHeader, nsIZipEntry)
michael@0: 
michael@0: /* readonly attribute unsigned short compression; */
michael@0: NS_IMETHODIMP nsZipHeader::GetCompression(uint16_t *aCompression)
michael@0: {
michael@0:     NS_ASSERTION(mInited, "Not initalised");
michael@0: 
michael@0:     *aCompression = mMethod;
michael@0:     return NS_OK;
michael@0: }
michael@0: 
michael@0: /* readonly attribute unsigned long size; */
michael@0: NS_IMETHODIMP nsZipHeader::GetSize(uint32_t *aSize)
michael@0: {
michael@0:     NS_ASSERTION(mInited, "Not initalised");
michael@0: 
michael@0:     *aSize = mCSize;
michael@0:     return NS_OK;
michael@0: }
michael@0: 
michael@0: /* readonly attribute unsigned long realSize; */
michael@0: NS_IMETHODIMP nsZipHeader::GetRealSize(uint32_t *aRealSize)
michael@0: {
michael@0:     NS_ASSERTION(mInited, "Not initalised");
michael@0: 
michael@0:     *aRealSize = mUSize;
michael@0:     return NS_OK;
michael@0: }
michael@0: 
michael@0: /* readonly attribute unsigned long CRC32; */
michael@0: NS_IMETHODIMP nsZipHeader::GetCRC32(uint32_t *aCRC32)
michael@0: {
michael@0:     NS_ASSERTION(mInited, "Not initalised");
michael@0: 
michael@0:     *aCRC32 = mCRC;
michael@0:     return NS_OK;
michael@0: }
michael@0: 
michael@0: /* readonly attribute boolean isDirectory; */
michael@0: NS_IMETHODIMP nsZipHeader::GetIsDirectory(bool *aIsDirectory)
michael@0: {
michael@0:     NS_ASSERTION(mInited, "Not initalised");
michael@0: 
michael@0:     if (mName.Last() == '/')
michael@0:         *aIsDirectory = true;
michael@0:     else
michael@0:         *aIsDirectory = false;
michael@0:     return NS_OK;
michael@0: }
michael@0: 
michael@0: /* readonly attribute PRTime lastModifiedTime; */
michael@0: NS_IMETHODIMP nsZipHeader::GetLastModifiedTime(PRTime *aLastModifiedTime)
michael@0: {
michael@0:     NS_ASSERTION(mInited, "Not initalised");
michael@0: 
michael@0:     // Try to read timestamp from extra field
michael@0:     uint16_t blocksize;
michael@0:     const uint8_t *tsField = GetExtraField(ZIP_EXTENDED_TIMESTAMP_FIELD, false, &blocksize);
michael@0:     if (tsField && blocksize >= 5) {
michael@0:         uint32_t pos = 4;
michael@0:         uint8_t flags;
michael@0:         flags = READ8(tsField, &pos);
michael@0:         if (flags & ZIP_EXTENDED_TIMESTAMP_MODTIME) {
michael@0:             *aLastModifiedTime = (PRTime)(READ32(tsField, &pos))
michael@0:                                  * PR_USEC_PER_SEC;
michael@0:             return NS_OK;
michael@0:         }
michael@0:     }
michael@0: 
michael@0:     // Use DOS date/time fields
michael@0:     // Note that on DST shift we can't handle correctly the hour that is valid
michael@0:     // in both DST zones
michael@0:     PRExplodedTime time;
michael@0: 
michael@0:     time.tm_usec = 0;
michael@0: 
michael@0:     time.tm_hour = (mTime >> 11) & 0x1F;
michael@0:     time.tm_min = (mTime >> 5) & 0x3F;
michael@0:     time.tm_sec = (mTime & 0x1F) * 2;
michael@0: 
michael@0:     time.tm_year = (mDate >> 9) + 1980;
michael@0:     time.tm_month = ((mDate >> 5) & 0x0F) - 1;
michael@0:     time.tm_mday = mDate & 0x1F;
michael@0: 
michael@0:     time.tm_params.tp_gmt_offset = 0;
michael@0:     time.tm_params.tp_dst_offset = 0;
michael@0: 
michael@0:     PR_NormalizeTime(&time, PR_GMTParameters);
michael@0:     time.tm_params.tp_gmt_offset = PR_LocalTimeParameters(&time).tp_gmt_offset;
michael@0:     PR_NormalizeTime(&time, PR_GMTParameters);
michael@0:     time.tm_params.tp_dst_offset = PR_LocalTimeParameters(&time).tp_dst_offset;
michael@0: 
michael@0:     *aLastModifiedTime = PR_ImplodeTime(&time);
michael@0: 
michael@0:     return NS_OK;
michael@0: }
michael@0: 
michael@0: /* readonly attribute boolean isSynthetic; */
michael@0: NS_IMETHODIMP nsZipHeader::GetIsSynthetic(bool *aIsSynthetic)
michael@0: {
michael@0:     NS_ASSERTION(mInited, "Not initalised");
michael@0: 
michael@0:     *aIsSynthetic = false;
michael@0:     return NS_OK;
michael@0: }
michael@0: 
michael@0: /* readonly attribute unsigned long permissions; */
michael@0: NS_IMETHODIMP nsZipHeader::GetPermissions(uint32_t *aPermissions)
michael@0: {
michael@0:     NS_ASSERTION(mInited, "Not initalised");
michael@0: 
michael@0:     // Always give user read access at least, this matches nsIZipReader's behaviour
michael@0:     *aPermissions = ((mEAttr >> 16) & 0xfff) | 0x100;
michael@0:     return NS_OK;
michael@0: }
michael@0: 
michael@0: void nsZipHeader::Init(const nsACString & aPath, PRTime aDate, uint32_t aAttr,
michael@0:                        uint32_t aOffset)
michael@0: {
michael@0:     NS_ASSERTION(!mInited, "Already initalised");
michael@0: 
michael@0:     PRExplodedTime time;
michael@0:     PR_ExplodeTime(aDate, PR_LocalTimeParameters, &time);
michael@0: 
michael@0:     mTime = time.tm_sec / 2 + (time.tm_min << 5) + (time.tm_hour << 11);
michael@0:     mDate = time.tm_mday + ((time.tm_month + 1) << 5) +
michael@0:             ((time.tm_year - 1980) << 9);
michael@0: 
michael@0:     // Store modification timestamp as extra field
michael@0:     // First fill CDS extra field
michael@0:     mFieldLength = 9;
michael@0:     mExtraField = new uint8_t[mFieldLength];
michael@0:     if (!mExtraField) {
michael@0:         mFieldLength = 0;
michael@0:     } else {
michael@0:         uint32_t pos = 0;
michael@0:         WRITE16(mExtraField.get(), &pos, ZIP_EXTENDED_TIMESTAMP_FIELD);
michael@0:         WRITE16(mExtraField.get(), &pos, 5);
michael@0:         WRITE8(mExtraField.get(), &pos, ZIP_EXTENDED_TIMESTAMP_MODTIME);
michael@0:         WRITE32(mExtraField.get(), &pos, aDate / PR_USEC_PER_SEC);
michael@0: 
michael@0:         // Fill local extra field
michael@0:         mLocalExtraField = new uint8_t[mFieldLength];
michael@0:         if (mLocalExtraField) {
michael@0:             mLocalFieldLength = mFieldLength;
michael@0:             memcpy(mLocalExtraField.get(), mExtraField.get(), mLocalFieldLength);
michael@0:         }
michael@0:     }
michael@0: 
michael@0:     mEAttr = aAttr;
michael@0:     mOffset = aOffset;
michael@0:     mName = aPath;
michael@0:     mComment = NS_LITERAL_CSTRING("");
michael@0:     // Claim a UTF-8 path in case it needs it.
michael@0:     mFlags |= FLAGS_IS_UTF8;
michael@0:     mInited = true;
michael@0: }
michael@0: 
michael@0: uint32_t nsZipHeader::GetFileHeaderLength()
michael@0: {
michael@0:     return ZIP_FILE_HEADER_SIZE + mName.Length() + mLocalFieldLength;
michael@0: }
michael@0: 
michael@0: nsresult nsZipHeader::WriteFileHeader(nsIOutputStream *aStream)
michael@0: {
michael@0:     NS_ASSERTION(mInited, "Not initalised");
michael@0: 
michael@0:     uint8_t buf[ZIP_FILE_HEADER_SIZE];
michael@0:     uint32_t pos = 0;
michael@0:     WRITE32(buf, &pos, ZIP_FILE_HEADER_SIGNATURE);
michael@0:     WRITE16(buf, &pos, mVersionNeeded);
michael@0:     WRITE16(buf, &pos, mFlags);
michael@0:     WRITE16(buf, &pos, mMethod);
michael@0:     WRITE16(buf, &pos, mTime);
michael@0:     WRITE16(buf, &pos, mDate);
michael@0:     WRITE32(buf, &pos, mCRC);
michael@0:     WRITE32(buf, &pos, mCSize);
michael@0:     WRITE32(buf, &pos, mUSize);
michael@0:     WRITE16(buf, &pos, mName.Length());
michael@0:     WRITE16(buf, &pos, mLocalFieldLength);
michael@0: 
michael@0:     nsresult rv = ZW_WriteData(aStream, (const char *)buf, pos);
michael@0:     NS_ENSURE_SUCCESS(rv, rv);
michael@0: 
michael@0:     rv = ZW_WriteData(aStream, mName.get(), mName.Length());
michael@0:     NS_ENSURE_SUCCESS(rv, rv);
michael@0: 
michael@0:     if (mLocalFieldLength)
michael@0:     {
michael@0:       rv = ZW_WriteData(aStream, (const char *)mLocalExtraField.get(), mLocalFieldLength);
michael@0:       NS_ENSURE_SUCCESS(rv, rv);
michael@0:     }
michael@0: 
michael@0:     return NS_OK;
michael@0: }
michael@0: 
michael@0: uint32_t nsZipHeader::GetCDSHeaderLength()
michael@0: {
michael@0:     return ZIP_CDS_HEADER_SIZE + mName.Length() + mComment.Length() +
michael@0:            mFieldLength;
michael@0: }
michael@0: 
michael@0: nsresult nsZipHeader::WriteCDSHeader(nsIOutputStream *aStream)
michael@0: {
michael@0:     NS_ASSERTION(mInited, "Not initalised");
michael@0: 
michael@0:     uint8_t buf[ZIP_CDS_HEADER_SIZE];
michael@0:     uint32_t pos = 0;
michael@0:     WRITE32(buf, &pos, ZIP_CDS_HEADER_SIGNATURE);
michael@0:     WRITE16(buf, &pos, mVersionMade);
michael@0:     WRITE16(buf, &pos, mVersionNeeded);
michael@0:     WRITE16(buf, &pos, mFlags);
michael@0:     WRITE16(buf, &pos, mMethod);
michael@0:     WRITE16(buf, &pos, mTime);
michael@0:     WRITE16(buf, &pos, mDate);
michael@0:     WRITE32(buf, &pos, mCRC);
michael@0:     WRITE32(buf, &pos, mCSize);
michael@0:     WRITE32(buf, &pos, mUSize);
michael@0:     WRITE16(buf, &pos, mName.Length());
michael@0:     WRITE16(buf, &pos, mFieldLength);
michael@0:     WRITE16(buf, &pos, mComment.Length());
michael@0:     WRITE16(buf, &pos, mDisk);
michael@0:     WRITE16(buf, &pos, mIAttr);
michael@0:     WRITE32(buf, &pos, mEAttr);
michael@0:     WRITE32(buf, &pos, mOffset);
michael@0: 
michael@0:     nsresult rv = ZW_WriteData(aStream, (const char *)buf, pos);
michael@0:     NS_ENSURE_SUCCESS(rv, rv);
michael@0: 
michael@0:     rv = ZW_WriteData(aStream, mName.get(), mName.Length());
michael@0:     NS_ENSURE_SUCCESS(rv, rv);
michael@0:     if (mExtraField) {
michael@0:         rv = ZW_WriteData(aStream, (const char *)mExtraField.get(), mFieldLength);
michael@0:         NS_ENSURE_SUCCESS(rv, rv);
michael@0:     }
michael@0:     return ZW_WriteData(aStream, mComment.get(), mComment.Length());
michael@0: }
michael@0: 
michael@0: nsresult nsZipHeader::ReadCDSHeader(nsIInputStream *stream)
michael@0: {
michael@0:     NS_ASSERTION(!mInited, "Already initalised");
michael@0: 
michael@0:     uint8_t buf[ZIP_CDS_HEADER_SIZE];
michael@0: 
michael@0:     nsresult rv = ZW_ReadData(stream, (char *)buf, ZIP_CDS_HEADER_SIZE);
michael@0:     NS_ENSURE_SUCCESS(rv, rv);
michael@0: 
michael@0:     uint32_t pos = 0;
michael@0:     uint32_t signature = READ32(buf, &pos);
michael@0:     if (signature != ZIP_CDS_HEADER_SIGNATURE)
michael@0:         return NS_ERROR_FILE_CORRUPTED;
michael@0: 
michael@0:     mVersionMade = READ16(buf, &pos);
michael@0:     mVersionNeeded = READ16(buf, &pos);
michael@0:     mFlags = READ16(buf, &pos);
michael@0:     mMethod = READ16(buf, &pos);
michael@0:     mTime = READ16(buf, &pos);
michael@0:     mDate = READ16(buf, &pos);
michael@0:     mCRC = READ32(buf, &pos);
michael@0:     mCSize = READ32(buf, &pos);
michael@0:     mUSize = READ32(buf, &pos);
michael@0:     uint16_t namelength = READ16(buf, &pos);
michael@0:     mFieldLength = READ16(buf, &pos);
michael@0:     uint16_t commentlength = READ16(buf, &pos);
michael@0:     mDisk = READ16(buf, &pos);
michael@0:     mIAttr = READ16(buf, &pos);
michael@0:     mEAttr = READ32(buf, &pos);
michael@0:     mOffset = READ32(buf, &pos);
michael@0: 
michael@0:     if (namelength > 0) {
michael@0:         nsAutoArrayPtr<char> field(new char[namelength]);
michael@0:         NS_ENSURE_TRUE(field, NS_ERROR_OUT_OF_MEMORY);
michael@0:         rv = ZW_ReadData(stream, field.get(), namelength);
michael@0:         NS_ENSURE_SUCCESS(rv, rv);
michael@0:         mName.Assign(field, namelength);
michael@0:     }
michael@0:     else
michael@0:         mName = NS_LITERAL_CSTRING("");
michael@0: 
michael@0:     if (mFieldLength > 0) {
michael@0:         mExtraField = new uint8_t[mFieldLength];
michael@0:         NS_ENSURE_TRUE(mExtraField, NS_ERROR_OUT_OF_MEMORY);
michael@0:         rv = ZW_ReadData(stream, (char *)mExtraField.get(), mFieldLength);
michael@0:         NS_ENSURE_SUCCESS(rv, rv);
michael@0:     }
michael@0: 
michael@0:     if (commentlength > 0) {
michael@0:         nsAutoArrayPtr<char> field(new char[commentlength]);
michael@0:         NS_ENSURE_TRUE(field, NS_ERROR_OUT_OF_MEMORY);
michael@0:         rv = ZW_ReadData(stream, field.get(), commentlength);
michael@0:         NS_ENSURE_SUCCESS(rv, rv);
michael@0:         mComment.Assign(field, commentlength);
michael@0:     }
michael@0:     else
michael@0:         mComment = NS_LITERAL_CSTRING("");
michael@0: 
michael@0:     mInited = true;
michael@0:     return NS_OK;
michael@0: }
michael@0: 
michael@0: const uint8_t * nsZipHeader::GetExtraField(uint16_t aTag, bool aLocal, uint16_t *aBlockSize)
michael@0: {
michael@0:     const uint8_t *buf = aLocal ? mLocalExtraField : mExtraField;
michael@0:     uint32_t buflen = aLocal ? mLocalFieldLength : mFieldLength;
michael@0:     uint32_t pos = 0;
michael@0:     uint16_t tag, blocksize;
michael@0: 
michael@0:     while (buf && (pos + 4) <= buflen) {
michael@0:       tag = READ16(buf, &pos);
michael@0:       blocksize = READ16(buf, &pos);
michael@0: 
michael@0:       if (aTag == tag && (pos + blocksize) <= buflen) {
michael@0:         *aBlockSize = blocksize;
michael@0:         return buf + pos - 4;
michael@0:       }
michael@0: 
michael@0:       pos += blocksize;
michael@0:     }
michael@0: 
michael@0:     return nullptr;
michael@0: }
michael@0: 
michael@0: /*
michael@0:  * Pad extra field to align data starting position to specified size.
michael@0:  */
michael@0: nsresult nsZipHeader::PadExtraField(uint32_t aOffset, uint16_t aAlignSize)
michael@0: {
michael@0:     uint32_t pad_size;
michael@0:     uint32_t pa_offset;
michael@0:     uint32_t pa_end;
michael@0: 
michael@0:     // Check for range and power of 2.
michael@0:     if (aAlignSize < 2 || aAlignSize > 32768 ||
michael@0:         (aAlignSize & (aAlignSize - 1)) != 0) {
michael@0:       return NS_ERROR_INVALID_ARG;
michael@0:     }
michael@0: 
michael@0:     // Point to current starting data position.
michael@0:     aOffset += ZIP_FILE_HEADER_SIZE + mName.Length() + mLocalFieldLength;
michael@0: 
michael@0:     // Calculate aligned offset.
michael@0:     pa_offset = aOffset & ~(aAlignSize - 1);
michael@0:     pa_end = pa_offset + aAlignSize;
michael@0:     pad_size = pa_end - aOffset;
michael@0:     if (pad_size == 0) {
michael@0:       return NS_OK;
michael@0:     }
michael@0: 
michael@0:     // Leave enough room(at least 4 bytes) for valid values in extra field.
michael@0:     while (pad_size < 4) {
michael@0:       pad_size += aAlignSize;
michael@0:     }
michael@0:     // Extra field length is 2 bytes.
michael@0:     if (mLocalFieldLength + pad_size > 65535) {
michael@0:       return NS_ERROR_FAILURE;
michael@0:     }
michael@0: 
michael@0:     nsAutoArrayPtr<uint8_t> field = mLocalExtraField;
michael@0:     uint32_t pos = mLocalFieldLength;
michael@0: 
michael@0:     mLocalExtraField = new uint8_t[mLocalFieldLength + pad_size];
michael@0:     memcpy(mLocalExtraField.get(), field, mLocalFieldLength);
michael@0:     // Use 0xFFFF as tag ID to avoid conflict with other IDs.
michael@0:     // For more information, please read "Extensible data fields" section in:
michael@0:     // http://www.pkware.com/documents/casestudies/APPNOTE.TXT
michael@0:     WRITE16(mLocalExtraField.get(), &pos, 0xFFFF);
michael@0:     WRITE16(mLocalExtraField.get(), &pos, pad_size - 4);
michael@0:     memset(mLocalExtraField.get() + pos, 0, pad_size - 4);
michael@0:     mLocalFieldLength += pad_size;
michael@0: 
michael@0:     return NS_OK;
michael@0: }