Bug 695843 part 5 - Add a FileLocation class to either store a pair (zip, path) or a file, and do some operations on these. r=bsmedberg,mwu

modules/libjar/nsZipArchive.cpp

@@ -206,7 +206,7 @@ nsresult nsZipHandle::Init(nsILocalFile *file, nsZipHandle **ret)
   }
 
   handle->mMap = map;
-  handle->mFile = file;
+  handle->mFile.Init(file);
   handle->mLen = (PRUint32) size;
   handle->mFileData = buf;
   *ret = handle.forget().get();
@@ -228,6 +228,7 @@ nsresult nsZipHandle::Init(nsZipArchive *zip, const char *entry,
     return NS_ERROR_UNEXPECTED;
 
   handle->mMap = nsnull;
+  handle->mFile.Init(zip, entry);
   handle->mLen = handle->mBuf->Length();
   handle->mFileData = handle->mBuf->Buffer();
   *ret = handle.forget().get();
@@ -279,7 +280,8 @@ nsresult nsZipArchive::OpenArchive(nsZipHandle *aZipHandle)
     logFile->Create(nsIFile::DIRECTORY_TYPE, 0700);
 
     nsAutoString name;
-    aZipHandle->mFile->GetLeafName(name);
+    nsCOMPtr<nsILocalFile> file = aZipHandle->mFile.GetBaseFile();
+    file->GetLeafName(name);
     name.Append(NS_LITERAL_STRING(".log"));
     logFile->Append(name);
 

modules/libjar/nsZipArchive.h

@@ -56,6 +56,7 @@
 #include "nsAutoPtr.h"
 #include "nsILocalFile.h"
 #include "mozilla/FileUtils.h"
+#include "mozilla/FileLocation.h"
 
 #if defined(XP_WIN) && defined(_MSC_VER)
 #define MOZ_WIN_MEM_TRY_BEGIN __try {
@@ -402,6 +403,7 @@ public:
 
 class nsZipHandle {
 friend class nsZipArchive;
+friend class mozilla::FileLocation;
 public:
   static nsresult Init(nsILocalFile *file, nsZipHandle **ret NS_OUTPARAM);
   static nsresult Init(nsZipArchive *zip, const char *entry,
@@ -415,7 +417,7 @@ public:
 protected:
   const PRUint8 * mFileData; /* pointer to mmaped file */
   PRUint32        mLen;      /* length of file and memory mapped area */
-  nsCOMPtr<nsILocalFile> mFile; /* source file if any, for logging */
+  mozilla::FileLocation mFile; /* source file if any, for logging */
 
 private:
   nsZipHandle();

xpcom/build/FileLocation.cpp

@@ -0,0 +1,197 @@
+/* ***** 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
+ * http://www.mozilla.org/MPL/
+ *
+ * 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 code
+ *
+ * The Initial Developer of the Original Code is
+ * Mozilla Foundation
+ * Portions created by the Initial Developer are Copyright (C) 2011
+ * the Initial Developer. All Rights Reserved.
+ *
+ * Contributor(s):
+ *   Mike Hommey <mh@glandium.org>
+ *
+ * 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 ***** */
+
+#include "FileLocation.h"
+#include "nsZipArchive.h"
+#include "nsURLHelper.h"
+
+namespace mozilla {
+
+FileLocation::FileLocation(const FileLocation &file, const char *path)
+{
+  if (file.IsZip()) {
+    if (file.mBaseFile) {
+      Init(file.mBaseFile, file.mPath.get());
+    } else {
+      Init(file.mBaseZip, file.mPath.get());
+    }
+    if (path) {
+      PRInt32 i = mPath.RFindChar('/');
+      if (kNotFound == i) {
+        mPath.Truncate(0);
+      } else {
+        mPath.Truncate(i + 1);
+      }
+      mPath += path;
+    }
+  } else {
+    if (path) {
+      nsCOMPtr<nsIFile> cfile;
+      file.mBaseFile->GetParent(getter_AddRefs(cfile));
+      nsCOMPtr<nsILocalFile> clfile = do_QueryInterface(cfile);
+
+#if defined(XP_WIN) || defined(XP_OS2)
+      nsCAutoString pathStr(path);
+      char *p;
+      PRUint32 len = pathStr.GetMutableData(&p);
+      for (; len; ++p, --len) {
+        if ('/' == *p) {
+            *p = '\\';
+        }
+      }
+      clfile->AppendRelativeNativePath(pathStr);
+#else
+      clfile->AppendRelativeNativePath(nsDependentCString(path));
+#endif
+      Init(clfile);
+    } else {
+      Init(file.mBaseFile);
+    }
+  }
+}
+
+void
+FileLocation::GetURIString(nsACString &result) const
+{
+  if (mBaseFile) {
+    net_GetURLSpecFromActualFile(mBaseFile, result);
+  } else if (mBaseZip) {
+    nsRefPtr<nsZipHandle> handler = mBaseZip->GetFD();
+    handler->mFile.GetURIString(result);
+  }
+  if (IsZip()) {
+    result.Insert("jar:", 0);
+    result += "!/";
+    result += mPath;
+  }
+}
+
+already_AddRefed<nsILocalFile>
+FileLocation::GetBaseFile()
+{
+  if (IsZip() && mBaseZip) {
+    nsRefPtr<nsZipHandle> handler = mBaseZip->GetFD();
+    if (handler)
+      return handler->mFile.GetBaseFile();
+    return NULL;
+  }
+
+  nsCOMPtr<nsILocalFile> file = mBaseFile;
+  return file.forget();
+}
+
+bool
+FileLocation::Equals(const FileLocation &file) const
+{
+  if (mPath != file.mPath)
+    return false;
+
+  if (mBaseFile && file.mBaseFile) {
+    bool eq;
+    return NS_SUCCEEDED(mBaseFile->Equals(file.mBaseFile, &eq)) && eq;
+  }
+
+  const FileLocation *a = this, *b = &file;
+  if (a->mBaseZip) {
+    nsRefPtr<nsZipHandle> handler = a->mBaseZip->GetFD();
+    a = &handler->mFile;
+  }
+  if (b->mBaseZip) {
+    nsRefPtr<nsZipHandle> handler = b->mBaseZip->GetFD();
+    b = &handler->mFile;
+  }
+  return a->Equals(*b);
+}
+
+nsresult
+FileLocation::GetData(Data &data)
+{
+  if (!IsZip()) {
+    return mBaseFile->OpenNSPRFileDesc(PR_RDONLY, 0444, &data.mFd);
+  }
+  data.mZip = mBaseZip;
+  if (!data.mZip) {
+    data.mZip = new nsZipArchive();
+    data.mZip->OpenArchive(mBaseFile);
+  }
+  data.mItem = data.mZip->GetItem(mPath.get());
+  if (data.mItem)
+    return NS_OK;
+  return NS_ERROR_FILE_UNRECOGNIZED_PATH;
+}
+
+nsresult
+FileLocation::Data::GetSize(PRUint32 *result)
+{
+  if (mFd) {
+    PRFileInfo64 fileInfo;
+    if (PR_SUCCESS != PR_GetOpenFileInfo64(mFd, &fileInfo))
+      return NS_ErrorAccordingToNSPR();
+
+    if (fileInfo.size > PRInt64(PR_UINT32_MAX))
+      return NS_ERROR_FILE_TOO_BIG;
+
+    *result = fileInfo.size;
+    return NS_OK;
+  } else if (mItem) {
+    *result = mItem->RealSize();
+    return NS_OK;
+  }
+  return NS_ERROR_NOT_INITIALIZED;
+}
+
+nsresult
+FileLocation::Data::Copy(char *buf, PRUint32 len)
+{
+  if (mFd) {
+    for (PRUint32 totalRead = 0; totalRead < len; ) {
+      PRInt32 read = PR_Read(mFd, buf + totalRead, NS_MIN(len - totalRead, PRUint32(PR_INT32_MAX)));
+      if (read < 0)
+        return NS_ErrorAccordingToNSPR();
+      totalRead += read;
+    }
+    return NS_OK;
+  } else if (mItem) {
+    nsZipCursor cursor(mItem, mZip, reinterpret_cast<PRUint8 *>(buf), len, true);
+    PRUint32 readLen;
+    cursor.Copy(&readLen);
+    return (readLen == len) ? NS_OK : NS_ERROR_FILE_CORRUPTED;
+  }
+  return NS_ERROR_NOT_INITIALIZED;
+}
+
+} /* namespace mozilla */

xpcom/build/FileLocation.h

@@ -0,0 +1,198 @@
+/* ***** 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
+ * http://www.mozilla.org/MPL/
+ *
+ * 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 code
+ *
+ * The Initial Developer of the Original Code is
+ * Mozilla Foundation
+ * Portions created by the Initial Developer are Copyright (C) 2011
+ * the Initial Developer. All Rights Reserved.
+ *
+ * Contributor(s):
+ *   Mike Hommey <mh@glandium.org>
+ *
+ * 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 mozilla_FileLocation_h
+#define mozilla_FileLocation_h
+
+#include "nsString.h"
+#include "nsCOMPtr.h"
+#include "nsAutoPtr.h"
+#include "nsILocalFile.h"
+#include "nsIURI.h"
+#include "FileUtils.h"
+
+class nsZipArchive;
+class nsZipItem;
+
+namespace mozilla {
+
+class FileLocation
+{
+public:
+  /**
+   * FileLocation is an helper to handle different kind of file locations
+   * within Gecko:
+   * - on filesystems
+   * - in archives
+   * - in archives within archives
+   * As such, it stores a path within an archive, as well as the archive
+   * path itself, or the complete file path alone when on a filesystem.
+   * When the archive is in an archive, an nsZipArchive is stored instead
+   * of a file path.
+   */
+  FileLocation() { }
+
+  /**
+   * Constructor for plain files
+   */
+  FileLocation(nsILocalFile *file)
+  {
+    Init(file);
+  }
+
+  /**
+   * Constructors for path within an archive. The archive can be given either
+   * as nsILocalFile or nsZipArchive.
+   */
+  FileLocation(nsILocalFile *zip, const char *path)
+  {
+    Init(zip, path);
+  }
+
+  FileLocation(nsZipArchive *zip, const char *path)
+  {
+    Init(zip, path);
+  }
+
+  /**
+   * Creates a new file location relative to another one.
+   */
+  FileLocation(const FileLocation &file, const char *path = NULL);
+
+  /**
+   * Initialization functions corresponding to constructors
+   */
+  void Init(nsILocalFile *file)
+  {
+    mBaseZip = NULL;
+    mBaseFile = file;
+    mPath.Truncate();
+  }
+
+  void Init(nsILocalFile *zip, const char *path)
+  {
+    mBaseZip = NULL;
+    mBaseFile = zip;
+    mPath = path;
+  }
+
+  void Init(nsZipArchive *zip, const char *path)
+  {
+    mBaseZip = zip;
+    mBaseFile = NULL;
+    mPath = path;
+  }
+
+  /**
+   * Returns an URI string corresponding to the file location
+   */
+  void GetURIString(nsACString &result) const;
+
+  /**
+   * Returns the base file of the location, where base file is defined as:
+   * - The file itself when the location is on a filesystem
+   * - The archive file when the location is in an archive
+   * - The outer archive file when the location is in an archive in an archive
+   */
+  already_AddRefed<nsILocalFile> GetBaseFile();
+
+  /**
+   * Returns whether the "base file" (see GetBaseFile) is an archive
+   */
+  bool IsZip() const
+  {
+    return !mPath.IsEmpty();
+  }
+
+  /**
+   * Returns the path within the archive, when within an archive
+   */
+  void GetPath(nsACString &result) const
+  {
+    result = mPath;
+  }
+
+  /**
+   * Boolean value corresponding to whether the file location is initialized
+   * or not.
+   */
+  operator bool() const
+  {
+    return mBaseFile || mBaseZip;
+  }
+
+  /**
+   * Returns whether another FileLocation points to the same resource
+   */
+  bool Equals(const FileLocation &file) const;
+
+  /**
+   * Data associated with a FileLocation.
+   */
+  class Data
+  {
+  public:
+    /**
+     * Returns the data size
+     */
+    nsresult GetSize(PRUint32 *result);
+
+    /**
+     * Copies the data in the given buffer
+     */
+    nsresult Copy(char *buf, PRUint32 len);
+  protected:
+    friend class FileLocation;
+    nsZipItem *mItem;
+    nsRefPtr<nsZipArchive> mZip;
+    mozilla::AutoFDClose mFd;
+  };
+
+  /**
+   * Returns the data associated with the resource pointed at by the file
+   * location.
+   */
+  nsresult GetData(Data &data);
+private:
+  nsCOMPtr<nsILocalFile> mBaseFile;
+  nsRefPtr<nsZipArchive> mBaseZip;
+  nsCString mPath;
+}; /* class FileLocation */
+
+} /* namespace mozilla */
+
+#endif /* mozilla_FileLocation_h */

xpcom/build/Makefile.in

@@ -59,14 +59,15 @@ ifeq ($(OS_ARCH),Linux)
 DEFINES += -DXP_LINUX
 endif
 
-CPPSRCS		= \
-		$(XPCOM_GLUE_SRC_LCPPSRCS) \
-		$(XPCOM_GLUENS_SRC_LCPPSRCS) \
-		nsXPComInit.cpp \
-		nsXPCOMStrings.cpp \
-		Services.cpp \
-		Omnijar.cpp \
-		$(NULL)
+CPPSRCS = \
+  $(XPCOM_GLUE_SRC_LCPPSRCS) \
+  $(XPCOM_GLUENS_SRC_LCPPSRCS) \
+  nsXPComInit.cpp \
+  nsXPCOMStrings.cpp \
+  Services.cpp \
+  Omnijar.cpp \
+  FileLocation.cpp \
+  $(NULL)
 
 SHARED_LIBRARY_LIBS = \
 		$(DEPTH)/chrome/src/$(LIB_PREFIX)chrome_s.$(LIB_SUFFIX) \
@@ -123,6 +124,7 @@ EXPORTS_mozilla = \
   Services.h \
   ServiceList.h \
   Omnijar.h \
+  FileLocation.h \
   $(NULL)