removed the report of db filesize in GetStorageInUse.

git-svn-id: svn://10.0.0.236/branches/CacheIntegration_BRANCH@55763 18797224-902f-48f8-a5cc-f745e15eee43

mozilla/netwerk/cache/Makefile.in

@@ -0,0 +1,38 @@
+#
+# The contents of this file are subject to the Netscape 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/NPL/
+#
+# 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.org code.
+#
+# The Initial Developer of the Original Code is Netscape
+# Communications Corporation.  Portions created by Netscape are
+# Copyright (C) 1998 Netscape Communications Corporation. All
+# Rights Reserved.
+#
+# Contributor(s): 
+#
+
+DEPTH		= ../..
+topsrcdir	= @top_srcdir@
+srcdir		= @srcdir@
+VPATH		= @srcdir@
+
+include $(DEPTH)/config/autoconf.mk
+
+DIRS		= \
+        public \
+        memcache \
+        filecache \
+        mgr \
+        build \
+		$(NULL)
+
+include $(topsrcdir)/config/rules.mk
+

mozilla/netwerk/cache/Makefile.win

@@ -0,0 +1,33 @@
+#!gmake
+#
+# The contents of this file are subject to the Netscape 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/NPL/
+#
+# 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.org code.
+#
+# The Initial Developer of the Original Code is Netscape
+# Communications Corporation.  Portions created by Netscape are
+# Copyright (C) 1998 Netscape Communications Corporation. All
+# Rights Reserved.
+#
+# Contributor(s): 
+
+
+DEPTH=..\..
+DIRS= 	\
+	public                  \
+	mgr			\
+	memcache		\
+	filecache		\
+	build                   \
+	$(NULL)
+
+include <$(DEPTH)\config\rules.mak>
+

mozilla/netwerk/cache/build/Makefile.in

@@ -0,0 +1,54 @@
+#
+# The contents of this file are subject to the Netscape Public License
+# Version 1.0 (the "NPL"); you may not use this file except in
+# compliance with the NPL.  You may obtain a copy of the NPL at
+# http://www.mozilla.org/NPL/
+#
+# Software distributed under the NPL is distributed on an "AS IS" basis,
+# WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+# for the specific language governing rights and limitations under the
+# NPL.
+#
+# The Initial Developer of this code under the NPL is Netscape
+# Communications Corporation.  Portions created by Netscape are
+# Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+# Reserved.
+#
+
+DEPTH		= ../../..
+topsrcdir	= @top_srcdir@
+srcdir		= @srcdir@
+VPATH		= @srcdir@
+
+include $(DEPTH)/config/autoconf.mk
+
+MODULE		= nkcacke
+LIBRARY_NAME	= necko_cache
+IS_COMPONENT	= 1
+
+CPPSRCS		= nsNetDataCacheModule.cpp
+
+SHARED_LIBRARY_LIBS = \
+		$(DIST)/lib/libnkcachemgr_s.a \
+		$(DIST)/lib/libnkfilecache_s.a \
+		$(DIST)/lib/libnkmemcache_s.a \
+        $(DIST)/lib/libmozdbm_s.a     \
+        $(DIST)/lib/libxpcomio_s.a \
+		$(NULL)
+
+LOCAL_INCLUDES	= \
+		-I$(DEPTH)/netwerk/cache/memcache \
+		-I$(DEPTH)/netwerk/cache/filecache \
+		-I$(DEPTH)/netwerk/cache/mgr \
+		$(NULL)
+
+EXTRA_DSO_LDOPTS = \
+		$(MKSHLIB_FORCE_ALL) \
+		$(SHARED_LIBRARY_LIBS) \
+		$(MKSHLIB_UNFORCE_ALL) \
+		$(NULL)
+
+include $(topsrcdir)/config/rules.mk
+
+$(LIBRARY) $(SHARED_LIBRARY): $(SHARED_LIBRARY_LIBS) Makefile
+

mozilla/netwerk/cache/build/makefile.win

@@ -0,0 +1,51 @@
+#!gmake
+#
+# The contents of this file are subject to the Netscape 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/NPL/
+#
+# 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.org code.
+#
+# The Initial Developer of the Original Code is Netscape
+# Communications Corporation.  Portions created by Netscape are
+# Copyright (C) 1998 Netscape Communications Corporation. All
+# Rights Reserved.
+#
+
+DEPTH=..\..\..
+MODULE=nkcache
+
+MAKE_OBJ_TYPE=DLL
+DLLNAME=nkcache
+DLL=.\$(OBJDIR)\$(DLLNAME).dll
+
+CPP_OBJS=                                    \
+        .\$(OBJDIR)\nsNetDataCacheModule.obj \
+	$(NULL)
+
+LLIBS=                                \
+        $(DIST)\lib\nkcachemgr_s.lib  \
+        $(DIST)\lib\nkfilecache_s.lib \
+        $(DIST)\lib\nkmemcache_s.lib  \
+        $(DIST)\lib\dbm32.lib         \
+        $(DIST)\lib\xpcom.lib         \
+        $(LIBNSPR)  
+
+INCS = $(INCS)                             \
+        -I$(DEPTH)\netwerk\cache\memcache  \
+        -I$(DEPTH)\netwerk\cache\filecache \
+        -I$(DEPTH)\netwerk\cache\mgr       \
+        $(NULL)
+
+include <$(DEPTH)\config\rules.mak>
+
+install:: $(DLL)
+	$(MAKE_INSTALL) .\$(OBJDIR)\$(DLLNAME).dll $(DIST)\bin\components
+	$(MAKE_INSTALL) .\$(OBJDIR)\$(DLLNAME).lib $(DIST)\lib
+

mozilla/netwerk/cache/build/nsNetDataCacheModule.cpp

@@ -0,0 +1,49 @@
+ /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ * The contents of this file are subject to the Netscape 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/NPL/
+ *  
+ * 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 Netscape are
+ * Copyright (C) 1998-1999 Netscape Communications Corporation. All
+ * Rights Reserved.
+ *
+ */
+
+#include "nsCOMPtr.h"
+#include "nsIModule.h"
+#include "nscore.h"
+#include "nsIComponentManager.h"
+#include "nsIServiceManager.h"
+#include "nsIGenericFactory.h"
+
+#include "nsINetDataCache.h"
+#include "nsINetDataCacheManager.h"
+#include "nsMemCacheCID.h"
+#include "nsMemCache.h"
+#include "nsNetDiskCache.h"
+#include "nsNetDiskCacheCID.h"
+#include "nsCacheManager.h"
+
+// Factory method to create a new nsMemCache instance.  Used
+// by nsNetDataCacheModule
+NS_GENERIC_FACTORY_CONSTRUCTOR_INIT(nsMemCache, Init)
+NS_GENERIC_FACTORY_CONSTRUCTOR_INIT(nsNetDiskCache, Init)
+NS_GENERIC_FACTORY_CONSTRUCTOR_INIT(nsCacheManager, Init)
+
+static nsModuleComponentInfo components[] = {
+    { "Memory Cache", NS_MEM_CACHE_FACTORY_CID, NS_NETWORK_MEMORY_CACHE_PROGID, nsMemCacheConstructor },
+    { "File Cache",   NS_NETDISKCACHE_CID,      NS_NETWORK_FILE_CACHE_PROGID,   nsNetDiskCacheConstructor },
+    { "Cache Manager",NS_CACHE_MANAGER_CID,     NS_NETWORK_CACHE_MANAGER_PROGID,nsCacheManagerConstructor }
+};
+
+NS_IMPL_NSGETMODULE("Network Data Cache", components)

mozilla/netwerk/cache/filecache/Makefile.in

@@ -0,0 +1,60 @@
+# 
+# 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 Communicator.
+# 
+# The Initial Developer of the Original Code is Intel Corp.
+# Portions created by Intel Corp. are
+# Copyright (C) 1999, 1999 Intel Corp.  All
+# Rights Reserved.
+# 
+# Contributor(s): Yixiong Zou <yixiong.zou@intel.com>
+#                 Carl Wong <carl.wong@intel.com>
+# 
+
+DEPTH		= ../../..
+topsrcdir	= @top_srcdir@
+VPATH       = @srcdir@
+srcdir		= @srcdir@
+
+include $(DEPTH)/config/autoconf.mk
+
+MODULE = nkcache
+
+LIBRARY_NAME = nkfilecache_s
+
+REQUIRES	= nspr dbm 
+
+EXTRA_DSO_LDOPTS  +=  -L$(DIST)/lib  -lmozdbm_s
+
+EXPORTS=nsNetDiskCacheCID.h \
+	nsNetDiskCache.h \
+	nsIDBAccessor.h \
+	nsDBAccessor.h \
+	$(NULL)
+
+CPPSRCS		= \
+        nsDBAccessor.cpp\
+        nsDBEnumerator.cpp \
+        nsNetDiskCache.cpp \
+        nsDiskCacheRecord.cpp \
+        nsDiskCacheRecordChannel.cpp \
+		$(NULL)
+
+EXTRA_LIBS	= $(NSPR_LIBS) 
+
+# we don't want the shared lib, but we want to force the creation of a
+# static lib.
+override NO_SHARED_LIB=1
+override NO_STATIC_LIB=
+
+include $(topsrcdir)/config/rules.mk
+

mozilla/netwerk/cache/filecache/makefile.win

@@ -0,0 +1,44 @@
+#!gmake
+#
+# The contents of this file are subject to the Netscape Public License
+# Version 1.0 (the "NPL"); you may not use this file except in
+# compliance with the NPL.  You may obtain a copy of the NPL at
+# http://www.mozilla.org/NPL/
+#
+# Software distributed under the NPL is distributed on an "AS IS" basis,
+# WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+# for the specific language governing rights and limitations under the
+# NPL.
+#
+# The Initial Developer of this code under the NPL is Netscape
+# Communications Corporation.  Portions created by Netscape are
+# Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+# Reserved.
+
+DEPTH=..\..\..
+
+include <$(DEPTH)/config/config.mak>
+
+MODULE = nkcache
+
+LIBRARY_NAME = nkfilecache_s
+
+CPP_OBJS=                                    \
+        .\$(OBJDIR)\nsDBAccessor.obj         \
+        .\$(OBJDIR)\nsDBEnumerator.obj       \
+        .\$(OBJDIR)\nsNetDiskCache.obj       \
+        .\$(OBJDIR)\nsDiskCacheRecord.obj    \
+        .\$(OBJDIR)\nsDiskCacheRecordChannel.obj    \
+	$(NULL)
+
+EXPORTS=nsNetDiskCacheCID.h
+
+include <$(DEPTH)\config\rules.mak> 
+
+install:: $(LIBRARY)
+	$(MAKE_INSTALL) $(LIBRARY) $(DIST)\lib
+
+clobber::
+        rm -rf $(OBJDIR)
+        rm -f $(DIST)\lib\$(LIBRARY_NAME).lib
+

mozilla/netwerk/cache/filecache/nsDBAccessor.cpp

@@ -0,0 +1,416 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
+ *
+ * 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 Communicator.
+ * 
+ * The Initial Developer of the Original Code is Intel Corp.
+ * Portions created by Intel Corp. are
+ * Copyright (C) 1999, 1999 Intel Corp.  All
+ * Rights Reserved.
+ * 
+ * Contributor(s): Yixiong Zou <yixiong.zou@intel.com>
+ *                 Carl Wong <carl.wong@intel.com>
+ */
+
+/*
+ * This file is part of filecache implementation.
+ * 
+ * nsIDBAccessor is a interface that shields all the direct database access 
+ * method from nsNetDiskCache. 
+ * 
+ * nsDBAccessor is a implementation of the nsIDBAccessor interface. It
+ * uses dbm(Berkely) as the database. 
+ * 
+ * a nsDiskCacheRecord is mapped into two entries in the database, 
+ *    key->recordID
+ *    recordID->metadata
+ */
+
+#include "nsDBAccessor.h"
+#include "nscore.h"
+
+#include "prtypes.h"
+#include "plhash.h"
+#include "nsCRT.h"
+
+nsDBAccessor::nsDBAccessor() :
+  mDB(0) ,
+  mDBFile(0) ,
+  mSessionID(0) ,
+  mSessionCntr(0) ,
+  mDBFilesize(0) 
+{
+  mLastSyncTime = PR_IntervalNow() ;
+
+  NS_INIT_REFCNT();
+}
+
+nsDBAccessor::~nsDBAccessor()
+{
+  Shutdown() ;
+}
+
+//
+// Implement nsISupports methods
+//
+NS_IMPL_ISUPPORTS(nsDBAccessor, NS_GET_IID(nsIDBAccessor))
+
+
+///////////////////////////////////////////////////////////
+// nsIDBAccessor methods 
+
+NS_IMETHODIMP
+nsDBAccessor::Init(nsIFileSpec* dbfile)
+{
+  char* dbname ;
+
+  // this should cover all platforms. 
+  dbfile->GetNativePath(&dbname) ;
+  
+  mDBFile = dbfile ;
+
+  // FUR - how is page size chosen ?  It's worth putting a comment
+  // in here about the possible usefulness of tuning these parameters
+  HASHINFO hash_info = {
+    16*1024 , /* bucket size */
+    0 ,       /* fill factor */
+    0 ,       /* number of elements */
+    0 ,       /* bytes to cache */
+    0 ,       /* hash function */
+    0} ;      /* byte order */
+
+  mDB = dbopen(dbname,
+               O_RDWR | O_CREAT ,
+               0600 ,
+               DB_HASH ,
+               & hash_info) ;
+
+  nsCRT::free(dbname) ;
+
+  if(!mDB)
+    return NS_ERROR_FAILURE ;
+
+  // set mSessionID
+  DBT db_key, db_data ;
+
+  db_key.data = NS_CONST_CAST(char*, SessionKey) ;
+  db_key.size = PL_strlen(SessionKey) ;
+
+  int status = (*mDB->get)(mDB, &db_key, &db_data, 0) ;
+  if(status == -1) {
+    NS_ERROR("ERROR: failed get session id in database.") ;
+    return NS_ERROR_FAILURE ;
+  }
+
+  if(status == 0) {
+    // get the last session id
+    PRInt16 *old_ID = NS_STATIC_CAST(PRInt16*, db_data.data) ;
+    if(*old_ID < ini_sessionID) {
+      NS_ERROR("ERROR: Bad Session ID in database, corrupted db.") ;
+      return NS_ERROR_FAILURE ;
+    }
+
+    mSessionID = *old_ID + 1 ;
+  } 
+  else if(status == 1) {
+    // must be a new db
+    mSessionID = ini_sessionID ;
+  }
+  db_data.data = NS_REINTERPRET_CAST(void*, &mSessionID) ;
+  db_data.size = sizeof(PRInt16) ;
+
+  // store the new session id
+  status = (*mDB->put)(mDB, &db_key, &db_data, 0) ;
+
+  if(status == 0) {
+    (*mDB->sync)(mDB, 0) ;
+
+    // initialize database filesize
+    return mDBFile->GetFileSize(&mDBFilesize) ;
+  } 
+  else {
+    NS_ERROR("reset session ID failure.") ;
+    return NS_ERROR_FAILURE ;
+  }
+  
+}
+
+NS_IMETHODIMP
+nsDBAccessor::Shutdown(void)
+{
+  if(mDB) {
+    (*mDB->sync)(mDB, 0) ;
+    (*mDB->close)(mDB) ;
+    mDB = nsnull ;
+  }
+
+  return NS_OK ;
+}
+  
+NS_IMETHODIMP
+nsDBAccessor::Get(PRInt32 aID, void** anEntry, PRUint32 *aLength) 
+{
+  if(!anEntry)
+    return NS_ERROR_NULL_POINTER ;
+
+  *anEntry = nsnull ;
+  *aLength = 0 ;
+
+  NS_ASSERTION(mDB, "no database") ;
+
+  DBT db_key, db_data ;
+
+  db_key.data = NS_REINTERPRET_CAST(void*, &aID) ;
+  db_key.size = sizeof(PRInt32) ;
+  
+  int status = 0 ;
+  status = (*mDB->get)(mDB, &db_key, &db_data, 0) ;
+
+  if(status == 0) {
+    *anEntry = db_data.data ;
+    *aLength = db_data.size ;
+    return NS_OK ;
+  } 
+  else if(status == 1)
+    return NS_OK ;
+  else
+    return NS_ERROR_FAILURE ;
+
+}
+
+NS_IMETHODIMP
+nsDBAccessor::Put(PRInt32 aID, void* anEntry, PRUint32 aLength)
+{
+  NS_ASSERTION(mDB, "no database") ;
+
+  DBT db_key, db_data ;
+
+  db_key.data = NS_REINTERPRET_CAST(void*, &aID) ;
+  db_key.size = sizeof(PRInt32) ;
+
+  db_data.data = anEntry ;
+  db_data.size = aLength ;
+
+  if(0 == (*mDB->put)(mDB, &db_key, &db_data, 0)) {
+    return Sync() ;
+  }
+  else {
+    return NS_ERROR_FAILURE ;
+  }
+}
+
+/*
+ * It's more important to remove the id->metadata entry first since
+ * key->id mapping is just a reference
+ */
+NS_IMETHODIMP
+nsDBAccessor::Del(PRInt32 aID, void* anEntry, PRUint32 aLength)
+{
+  NS_ASSERTION(mDB, "no database") ;
+
+  DBT db_key ;
+
+  // delete recordID->metadata
+  db_key.data = NS_REINTERPRET_CAST(void*, &aID) ;
+  db_key.size = sizeof(PRInt32) ;
+
+  PRInt32 status = -1 ;
+  status = (*mDB->del)(mDB, &db_key, 0) ;
+
+  if(-1 == status) {
+    return NS_ERROR_FAILURE ;
+  } 
+
+  // delete key->recordID
+  db_key.data = anEntry ;
+  db_key.size = aLength ;
+  status = (*mDB->del)(mDB, &db_key, 0) ;
+  if(-1 == status) {
+    return NS_ERROR_FAILURE ;
+  } 
+
+  return Sync() ;
+}
+
+NS_IMETHODIMP
+nsDBAccessor::GetID(const char* key, PRUint32 length, PRInt32* aID) 
+{
+  NS_ASSERTION(mDB, "no database") ;
+
+  DBT db_key, db_data ;
+
+  db_key.data = NS_CONST_CAST(char*, key) ;
+  db_key.size = length ;
+
+  int status = (*mDB->get)(mDB, &db_key, &db_data, 0) ;
+  if(status == 0) {
+    // found recordID
+    *aID = *(NS_REINTERPRET_CAST(PRInt32*, db_data.data)) ;
+    return NS_OK ;
+  }
+  else if(status == 1) {
+    // create a new one
+    PRInt32 id = 0 ;
+    id = mSessionID << 16 | mSessionCntr++ ;
+
+    // add new id into mDB
+    db_data.data = NS_REINTERPRET_CAST(void*, &id) ;
+    db_data.size = sizeof(PRInt32) ;
+
+    status = (*mDB->put)(mDB, &db_key, &db_data, 0) ;
+    if(status != 0) {
+      NS_ERROR("updating db failure.") ;
+      return NS_ERROR_FAILURE ;
+    }
+    *aID = id ;
+    return Sync() ;
+  } 
+  else {
+    NS_ERROR("ERROR: keydb failure.") ;
+    return NS_ERROR_FAILURE ;
+  }
+}
+
+NS_IMETHODIMP
+nsDBAccessor::EnumEntry(void** anEntry, PRUint32* aLength, PRBool bReset) 
+{
+  if(!anEntry)
+    return NS_ERROR_NULL_POINTER ;
+
+  *anEntry = nsnull ;
+  *aLength = 0 ;
+
+  NS_ASSERTION(mDB, "no database") ;
+
+  PRUint32 flag ;
+
+  if(bReset) 
+    flag = R_FIRST ;
+  else
+    flag = R_NEXT ;
+
+  DBT db_key, db_data ;
+
+  PRUint32 len = PL_strlen(SessionKey) ;
+
+  int status ;
+
+  do {
+    status = (*mDB->seq)(mDB, &db_key, &db_data, flag) ;
+    flag = R_NEXT ;
+    if(status == -1)
+      return NS_ERROR_FAILURE ;
+    // get next if it's a key->recordID 
+    if(db_key.size > sizeof(PRInt32) && db_data.size == sizeof(PRInt32))
+      continue ;
+    // get next if it's a sessionID entry
+    if(db_key.size == len && db_data.size == sizeof(PRInt16))
+      continue ;
+    // recordID is always 32 bits long
+    if(db_key.size == sizeof(PRInt32))
+      break ;
+  } while(!status) ;
+
+  if (0 == status) {
+    *anEntry = db_data.data ;
+    *aLength = db_data.size ;
+  }
+  return NS_OK ;
+}
+
+/*
+ * returns the cached database file size.
+ * mDBFilesize will be updated during Sync().
+ */
+NS_IMETHODIMP
+nsDBAccessor::GetDBFilesize(PRUint32* aSize)
+{
+  *aSize = mDBFilesize ;
+  return NS_OK ; 
+}
+
+NS_IMETHODIMP
+nsDBAccessor::GetSpecialEntry(void** anEntry, PRUint32* aLength)
+{
+  if(!anEntry)
+    return NS_ERROR_NULL_POINTER ;
+
+  *anEntry = nsnull ;
+  *aLength = 0 ;
+
+  DBT db_key, db_data ;
+
+  db_key.data = NS_CONST_CAST(char*, SpecialEntry) ;
+  db_key.size = PL_strlen(SpecialEntry) ;
+
+  int status = (*mDB->get)(mDB, &db_key, &db_data, 0) ;
+
+  if(status == -1) {
+    NS_ERROR("ERROR: failed get special entry in database.") ;
+    return NS_ERROR_FAILURE ;
+  }
+
+  if(status == 0) {
+    *anEntry = db_data.data ;
+    *aLength = db_data.size ;
+  } 
+  
+  return NS_OK ;
+}
+
+NS_IMETHODIMP
+nsDBAccessor::SetSpecialEntry(void* anEntry, PRUint32 aLength)
+{
+  DBT db_key, db_data ;
+
+  db_key.data = NS_CONST_CAST(char*, SpecialEntry) ;
+  db_key.size = PL_strlen(SpecialEntry) ;
+
+  db_data.data = anEntry ;
+  db_data.size = aLength ;
+
+  if(0 == (*mDB->put)(mDB, &db_key, &db_data, 0)) {
+    (*mDB->sync)(mDB, 0) ;
+    return NS_OK ;
+  }
+  else {
+    return NS_ERROR_FAILURE ;
+  }
+}
+
+/*
+ * sync routine is only called when the SyncInterval is reached. Otherwise
+ * it just returns. If db synced, the filesize will be updated at the
+ * same time.
+ */
+nsresult
+nsDBAccessor::Sync(void)
+{
+  PRIntervalTime time = PR_IntervalNow() ;
+  PRIntervalTime duration = time - mLastSyncTime ;
+  
+  if (PR_IntervalToMilliseconds(duration) > SyncInterval) {
+    int status = (*mDB->sync)(mDB, 0) ;
+    if(status == 0) {
+//      printf("\tsynced\n") ;
+      mLastSyncTime = time ;
+      
+      // update db filesize here
+      return mDBFile->GetFileSize(&mDBFilesize) ;
+      
+    } else
+      return NS_ERROR_FAILURE ;
+  } else {
+//    printf("\tnot synced\n") ;
+    return NS_OK ;
+  }
+}

mozilla/netwerk/cache/filecache/nsDBAccessor.h

@@ -0,0 +1,93 @@
+/*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
+ *
+ * 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 Communicator.
+ * 
+ * The Initial Developer of the Original Code is Intel Corp.
+ * Portions created by Intel Corp. are
+ * Copyright (C) 1999, 1999 Intel Corp.  All
+ * Rights Reserved.
+ * 
+ * Contributor(s): Yixiong Zou <yixiong.zou@intel.com>
+ *                 Carl Wong <carl.wong@intel.com>
+ */
+
+/*
+ * This file is part of filecache implementation.
+ * 
+ * nsIDBAccessor is a interface that shields all the direct database access 
+ * method from nsNetDiskCache. 
+ * 
+ * nsDBAccessor is a implementation of the nsIDBAccessor interface. It
+ * uses dbm(Berkely) as the database. 
+ *
+ */
+
+#ifndef _NSIDBACCESSOR_H_
+#define _NSIDBACCESSOR_H_
+
+#include "nsIDBAccessor.h"
+#include "mcom_db.h"
+#include "prinrval.h"
+#include "nsCOMPtr.h"
+
+// bogus string for the key of session id 
+static const char * const SessionKey = "SK" ;
+
+// bogus string for the size 
+static const char * const SpecialEntry = "SE" ;
+
+// initial session id number 
+static const PRInt16 ini_sessionID = 0xff ;
+
+static const PRUint16 SyncInterval = 1000 ;
+
+class nsDBAccessor : public nsIDBAccessor
+{
+  public:
+  NS_DECL_ISUPPORTS
+
+  nsDBAccessor() ;
+  virtual ~nsDBAccessor() ;
+  
+  NS_IMETHOD Init(nsIFileSpec* dbfile) ;
+  NS_IMETHOD Shutdown(void) ; 
+
+  NS_IMETHOD Put(PRInt32 aID, void* anEntry, PRUint32 aLength) ;
+
+  NS_IMETHOD Get(PRInt32 aID, void** anEntry, PRUint32 *aLength) ;
+
+  NS_IMETHOD Del(PRInt32 aID, void* anEntry, PRUint32 aLength) ;
+
+  NS_IMETHOD GetID(const char* key, PRUint32 length, PRInt32* aID) ;
+
+  NS_IMETHOD EnumEntry(void* *anEntry, PRUint32* aLength, PRBool bReset) ;
+  
+  NS_IMETHOD GetDBFilesize(PRUint32* aSize) ;
+  
+  NS_IMETHOD GetSpecialEntry(void** anEntry, PRUint32 *aLength) ;
+  NS_IMETHOD SetSpecialEntry(void* anEntry, PRUint32 aLength) ;
+
+  protected:
+  nsresult Sync(void) ;
+
+  private:
+  DB *                          mDB ;
+  nsCOMPtr<nsIFileSpec>         mDBFile ;
+  PRInt16                       mSessionID ;
+  PRInt16                       mSessionCntr ;
+  PRIntervalTime                mLastSyncTime ;
+  PRUint32                      mDBFilesize ; // cached DB filesize, 
+                                              // updated on every sync for now
+} ;
+
+#endif // _NSIDBACCESSOR_H_

mozilla/netwerk/cache/filecache/nsDBEnumerator.cpp

@@ -0,0 +1,108 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
+ *
+ * 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 Communicator.
+ * 
+ * The Initial Developer of the Original Code is Intel Corp.
+ * Portions created by Intel Corp. are
+ * Copyright (C) 1999, 1999 Intel Corp.  All
+ * Rights Reserved.
+ * 
+ * Contributor(s): Yixiong Zou <yixiong.zou@intel.com>
+ *                 Carl Wong <carl.wong@intel.com>
+ */
+
+/*
+ * This file is part of filecache implementation.
+ *
+ * It implements a simple iterator for the database, see nsDBAccessor. 
+ */
+
+#include "nsDBEnumerator.h"
+#include "nsDiskCacheRecord.h"
+
+nsDBEnumerator::nsDBEnumerator(nsIDBAccessor* aDB, nsNetDiskCache* aCache) :
+  m_DB(aDB) ,
+  m_DiskCache(aCache) ,
+  m_tempEntry(0) ,
+  m_tempEntry_length(0) ,
+  m_CacheEntry(0) ,
+  m_bReset(PR_TRUE) 
+{
+  NS_INIT_REFCNT();
+
+}
+
+nsDBEnumerator::~nsDBEnumerator()
+{
+  NS_IF_RELEASE(m_CacheEntry) ;
+}
+
+//
+// Implement nsISupports methods
+//
+NS_IMPL_ISUPPORTS(nsDBEnumerator, NS_GET_IID(nsIEnumerator))
+
+/////////////////////////////////////////////////////////////////
+// nsISimpleEnumerator methods
+
+NS_IMETHODIMP
+nsDBEnumerator::HasMoreElements(PRBool *_retval)
+{
+  *_retval = PR_FALSE ;
+
+  nsresult rv = m_DB->EnumEntry(&m_tempEntry, &m_tempEntry_length, m_bReset) ;
+
+  if(NS_FAILED(rv)) {
+    // do some error recovery
+    m_DiskCache->DBRecovery() ;
+    return rv ;
+  }
+
+  m_bReset = PR_FALSE ;
+
+  if(m_tempEntry && m_tempEntry_length != 0)
+    *_retval = PR_TRUE ;
+
+  return NS_OK ;
+}
+
+// this routine does not create a new item by itself  
+// Rather it reuses the item inside the object. So if you need to use the 
+// item later, you have to
+// create a new item specifically, using copy constructor or some other dup 
+// function. And don't forget to release it after you're done
+//
+NS_IMETHODIMP
+nsDBEnumerator::GetNext(nsISupports **_retval)
+{
+  if(!m_CacheEntry) {
+    m_CacheEntry = new nsDiskCacheRecord(m_DB, m_DiskCache) ;
+    if(m_CacheEntry)
+      NS_ADDREF(m_CacheEntry) ;
+    else
+      return NS_ERROR_OUT_OF_MEMORY ;
+  }
+
+  if(!_retval)
+    return NS_ERROR_NULL_POINTER ;
+  *_retval = nsnull ;
+
+  nsresult rv = m_CacheEntry->RetrieveInfo(m_tempEntry, m_tempEntry_length) ;
+  if(NS_FAILED(rv))
+    return rv ;
+
+  *_retval = NS_STATIC_CAST(nsISupports*, m_CacheEntry) ;
+  NS_ADDREF(*_retval) ; // all good getter addref 
+
+  return NS_OK ;
+}

mozilla/netwerk/cache/filecache/nsDBEnumerator.h

@@ -0,0 +1,60 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
+ *
+ * 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 Communicator.
+ * 
+ * The Initial Developer of the Original Code is Intel Corp.
+ * Portions created by Intel Corp. are
+ * Copyright (C) 1999, 1999 Intel Corp.  All
+ * Rights Reserved.
+ * 
+ * Contributor(s): Yixiong Zou <yixiong.zou@intel.com>
+ *                 Carl Wong <carl.wong@intel.com>
+ */
+
+/*
+ * This file is part of filecache implementation.
+ *
+ * It implements a simple iterator for the database, see nsDBAccessor. 
+ */
+
+#ifndef _NS_DBENUMERATOR_H_
+#define _NS_DBENUMERATOR_H_
+
+#include "nsISimpleEnumerator.h"
+#include "nsINetDataCacheRecord.h"
+#include "nsIDBAccessor.h"
+#include "nsCOMPtr.h"
+#include "nsNetDiskCache.h"
+#include "nsDiskCacheRecord.h"
+
+class nsCachedDiskData ; /* forward decl */
+
+class nsDBEnumerator : public nsISimpleEnumerator {
+public:
+    NS_DECL_ISUPPORTS
+
+    NS_DECL_NSISIMPLEENUMERATOR 
+
+    nsDBEnumerator(nsIDBAccessor* aDB, nsNetDiskCache* aCache) ;
+    virtual ~nsDBEnumerator() ;
+
+private:
+    nsCOMPtr<nsIDBAccessor>                m_DB ;
+    nsCOMPtr<nsNetDiskCache>               m_DiskCache ;
+    void *                                 m_tempEntry ;
+    PRUint32                               m_tempEntry_length ;
+    nsDiskCacheRecord*                     m_CacheEntry ;
+    PRBool                                 m_bReset ;
+};
+
+#endif // _NS_DBENUMERATOR_H_

mozilla/netwerk/cache/filecache/nsDiskCacheRecord.cpp

@@ -0,0 +1,456 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
+ *
+ * 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 Communicator.
+ * 
+ * The Initial Developer of the Original Code is Intel Corp.
+ * Portions created by Intel Corp. are
+ * Copyright (C) 1999, 1999 Intel Corp.  All
+ * Rights Reserved.
+ * 
+ * Contributor(s): Yixiong Zou <yixiong.zou@intel.com>
+ *                 Carl Wong <carl.wong@intel.com>
+ */
+
+#include "nsDiskCacheRecord.h"
+#include "nsINetDataDiskCache.h"
+#include "nsNetDiskCacheCID.h"
+#include "nsDiskCacheRecordChannel.h"
+#include "nsFileStream.h"
+
+#include "nsIComponentManager.h"
+#include "nsIServiceManager.h"
+#include "nsIProtocolHandler.h"
+#include "nsIIOService.h"
+#include "nsIAllocator.h"
+
+#include "plstr.h"
+#include "prprf.h"
+#include "prmem.h"
+#include "prlog.h"
+#include "prtypes.h"
+#include "netCore.h"
+
+#include "nsDBAccessor.h"
+
+#if !defined(IS_LITTLE_ENDIAN) && !defined(IS_BIG_ENDIAN)
+ERROR! Must have a byte order
+#endif
+
+#ifdef IS_LITTLE_ENDIAN
+#define COPY_INT32(_a,_b)  memcpy(_a, _b, sizeof(int32))
+#else
+#define COPY_INT32(_a,_b)  /* swap */                   \
+    do {                                                \
+    ((char *)(_a))[0] = ((char *)(_b))[3];              \
+    ((char *)(_a))[1] = ((char *)(_b))[2];              \
+    ((char *)(_a))[2] = ((char *)(_b))[1];              \
+    ((char *)(_a))[3] = ((char *)(_b))[0];              \
+    } while(0)
+#endif
+
+nsDiskCacheRecord::nsDiskCacheRecord(nsIDBAccessor* db, nsNetDiskCache* aCache) :
+  mKey(0) ,
+  mKeyLength(0) ,
+  mRecordID(0) ,
+  mMetaData(0) ,
+  mMetaDataLength(0) ,
+  mDB(db) ,
+  mInfo(0) ,
+  mInfoSize(0) ,
+  mNumChannels(0) ,
+  mDiskCache(aCache) 
+{
+  NS_INIT_REFCNT();
+  NS_ASSERTION(mDiskCache, "Must have an nsNetDiskCache");
+  NS_ADDREF(mDiskCache);
+}
+
+// mem alloced. so caller should do free() on key. 
+NS_IMETHODIMP
+nsDiskCacheRecord::Init(const char* key, PRUint32 length, PRInt32 ID) 
+{
+  NS_NewFileSpec(getter_AddRefs(mFile));
+  if(!mFile)
+    return NS_ERROR_OUT_OF_MEMORY ;
+
+  // copy key
+  mKeyLength = length ;
+  mKey = NS_STATIC_CAST(char*, nsAllocator::Alloc(mKeyLength*sizeof(char))) ;
+  if(!mKey) 
+    return NS_ERROR_OUT_OF_MEMORY ;
+
+  memcpy(mKey, key, length) ;
+
+  // get RecordID
+  mRecordID = ID ;
+
+  // setup the file name
+  nsCOMPtr<nsIFileSpec> dbFolder ;
+  mDiskCache->GetDiskCacheFolder(getter_AddRefs(dbFolder)) ;
+
+  nsresult rv = mFile->FromFileSpec(dbFolder) ;
+  if(NS_FAILED(rv))
+    return NS_ERROR_FAILURE ;
+
+  // dir is a hash result of mRecordID%32, hope it's enough 
+  char filename[9], dirName[3] ;
+  
+  PR_snprintf(dirName, 3, "%02x", (((PRUint32)mRecordID) % 32)) ;
+  mFile->AppendRelativeUnixPath(dirName) ;
+
+  PR_snprintf(filename, 9, "%08x", mRecordID) ;
+  mFile->AppendRelativeUnixPath(filename) ;
+
+  return NS_OK ;
+}
+
+nsDiskCacheRecord::~nsDiskCacheRecord()
+{
+  if(mKey)
+    nsAllocator::Free(mKey) ;
+  if(mMetaData)
+    nsAllocator::Free(mMetaData) ;
+  if(mInfo) 
+    nsAllocator::Free(mInfo) ;
+
+  NS_IF_RELEASE(mDiskCache);
+}
+
+//
+// Implement nsISupports methods
+//
+NS_IMPL_ISUPPORTS(nsDiskCacheRecord, NS_GET_IID(nsINetDataCacheRecord))
+
+///////////////////////////////////////////////////////////////////////
+// nsINetDataCacheRecord methods
+
+// yes, mem alloced on *_retval.
+NS_IMETHODIMP
+nsDiskCacheRecord::GetKey(PRUint32 *length, char** _retval) 
+{
+  if(!_retval)
+    return NS_ERROR_NULL_POINTER ;
+
+  *length = mKeyLength ;
+  *_retval = NS_STATIC_CAST(char*, nsAllocator::Alloc(mKeyLength*sizeof(char))) ;
+  if(!*_retval)
+    return NS_ERROR_OUT_OF_MEMORY ;
+
+  memcpy(*_retval, mKey, mKeyLength) ;
+
+  return NS_OK ;
+}
+
+NS_IMETHODIMP
+nsDiskCacheRecord::GetRecordID(PRInt32* aRecordID)
+{
+  *aRecordID = mRecordID ;
+  return NS_OK ;
+}
+
+// yes, mem alloced on *_retval. 
+NS_IMETHODIMP
+nsDiskCacheRecord::GetMetaData(PRUint32 *length, char **_retval) 
+{
+  if(!_retval)
+    return NS_ERROR_NULL_POINTER ;
+
+  // always null the return value first. 
+  *_retval = nsnull ;
+
+  *length = mMetaDataLength ;
+
+  if(mMetaDataLength) {
+    *_retval = NS_STATIC_CAST(char*, nsAllocator::Alloc(mMetaDataLength*sizeof(char))) ;
+    if(!*_retval)
+      return NS_ERROR_OUT_OF_MEMORY ;
+
+    memcpy(*_retval, mMetaData, mMetaDataLength) ;
+  }
+
+  return NS_OK ;
+}
+
+NS_IMETHODIMP
+nsDiskCacheRecord::SetMetaData(PRUint32 length, const char* data)
+{
+  // set the mMetaData
+  mMetaDataLength = length ;
+  if(mMetaData)
+    nsAllocator::Free(mMetaData) ;
+  mMetaData = NS_STATIC_CAST(char*, nsAllocator::Alloc(mMetaDataLength*sizeof(char))) ;
+  if(!mMetaData) {
+    return NS_ERROR_OUT_OF_MEMORY ;
+  }
+  memcpy(mMetaData, data, length) ;
+
+  // Generate mInfo
+  nsresult rv = GenInfo() ;
+  if(NS_FAILED(rv))
+    return rv ;
+
+  // write through into mDB
+  rv = mDB->Put(mRecordID, mInfo, mInfoSize) ;
+
+  return rv ;
+}
+
+NS_IMETHODIMP
+nsDiskCacheRecord::GetStoredContentLength(PRUint32 *aStoredContentLength)
+{
+  return mFile->GetFileSize(aStoredContentLength) ;
+}
+
+// untill nsIFileSpec::Truncate() is in, we have to do all this ugly stuff
+NS_IMETHODIMP
+nsDiskCacheRecord::SetStoredContentLength(PRUint32 aStoredContentLength)
+{
+  PRUint32 len = 0 ;
+  nsresult rv = mFile->GetFileSize(&len) ;
+  if(NS_FAILED(rv))
+    return rv ;
+
+  if(len < aStoredContentLength)
+  {
+    NS_ERROR("Error: can not set filesize to something bigger than itself.\n") ;
+    return NS_ERROR_FAILURE ;
+  }
+  else {
+    rv = mFile->Truncate(aStoredContentLength) ;
+    if(NS_FAILED(rv))
+      return rv ;
+    
+    mDiskCache->m_StorageInUse -= (len - aStoredContentLength) ;
+    return NS_OK ;
+  }
+}
+
+NS_IMETHODIMP
+nsDiskCacheRecord::Delete(void)
+{
+  if(mNumChannels)
+    return NS_ERROR_NOT_AVAILABLE ;
+
+  PRUint32 len ;
+  mFile->GetFileSize(&len) ;
+
+  nsFileSpec cache_file ;
+  nsresult rv = mFile->GetFileSpec(&cache_file) ;
+
+  if(NS_FAILED(rv)) 
+    return NS_ERROR_FAILURE ;
+
+  cache_file.Delete(PR_TRUE) ;
+
+  // updata the storage size
+  mDiskCache->m_StorageInUse -= len ;
+
+  rv = mDB->Del(mRecordID, mKey, mKeyLength) ;
+  if(NS_FAILED(rv)) 
+    return NS_ERROR_FAILURE ;
+  else
+    return NS_OK ;
+}
+
+NS_IMETHODIMP
+nsDiskCacheRecord::GetFilename(nsIFileSpec * *aFilename) 
+{
+  if(!aFilename)
+    return NS_ERROR_NULL_POINTER ;
+
+  *aFilename = mFile ;
+  NS_ADDREF(*aFilename) ;
+
+  return NS_OK ;
+}
+
+NS_IMETHODIMP
+nsDiskCacheRecord::NewChannel(nsILoadGroup *loadGroup, nsIChannel **_retval) 
+{
+  nsDiskCacheRecordChannel* channel = new nsDiskCacheRecordChannel(this, loadGroup) ;
+  if(!channel) 
+    return NS_ERROR_OUT_OF_MEMORY ;
+
+  nsresult rv = channel->Init() ;
+  if(NS_FAILED(rv))
+    return rv ;
+
+  NS_ADDREF(channel) ;
+  *_retval = NS_STATIC_CAST(nsIChannel*, channel) ;
+  return NS_OK ;
+}
+
+//////////////////////////////////////////////////////////////////////////
+// nsDiskCacheRecord methods
+
+// file name is represented by a url string. I hope this would be more
+// generic
+nsresult
+nsDiskCacheRecord::GenInfo() 
+{
+  if(mInfo)
+    nsAllocator::Free(mInfo) ;
+
+  char* file_url=nsnull ;
+  PRUint32 name_len ;
+  mFile->GetURLString(&file_url) ;
+  name_len = PL_strlen(file_url)+1 ;
+
+  mInfoSize  = sizeof(PRUint32) ;    // checksum for mInfoSize
+  mInfoSize += sizeof(PRInt32) ;     // RecordID
+  mInfoSize += sizeof(PRUint32) ;    // key length
+  mInfoSize += mKeyLength ;          // key 
+  mInfoSize += sizeof(PRUint32) ;    // metadata length
+  mInfoSize += mMetaDataLength ;     // metadata 
+  mInfoSize += sizeof(PRUint32) ;    // filename length
+  mInfoSize += name_len ;            // filename 
+
+  void* newInfo = nsAllocator::Alloc(mInfoSize*sizeof(char)) ;
+  if(!newInfo) {
+    return NS_ERROR_OUT_OF_MEMORY ;
+  }
+
+  // copy the checksum mInfoSize
+  char* cur_ptr = NS_STATIC_CAST(char*, newInfo) ;
+  COPY_INT32(cur_ptr, &mInfoSize) ;
+  cur_ptr += sizeof(PRUint32) ;
+
+  // copy RecordID
+  COPY_INT32(cur_ptr, &mRecordID) ;
+  cur_ptr += sizeof(PRInt32) ;
+
+  // copy key length
+  COPY_INT32(cur_ptr, &mKeyLength) ;
+  cur_ptr += sizeof(PRUint32) ;
+
+  // copy key
+  memcpy(cur_ptr, mKey, mKeyLength) ;
+  cur_ptr += mKeyLength ;
+
+  // copy metadata length
+  COPY_INT32(cur_ptr, &mMetaDataLength) ;
+  cur_ptr += sizeof(PRUint32) ;
+
+  // copy metadata
+  memcpy(cur_ptr, mMetaData, mMetaDataLength) ;
+  cur_ptr += mMetaDataLength ;
+
+  // copy file name length 
+  COPY_INT32(cur_ptr, &name_len) ;
+  cur_ptr += sizeof(PRUint32) ;
+
+  // copy file name
+  memcpy(cur_ptr, file_url, name_len) ;
+  cur_ptr += name_len ;
+
+  PR_ASSERT(cur_ptr == NS_STATIC_CAST(char*, newInfo) + mInfoSize);
+  mInfo = newInfo ;
+
+  return NS_OK ;
+}
+
+/*
+ * This Method suppose to get all the info from the db record
+ * and set them to accroding members. the original values
+ * will all be overwritten. only minimal error checking is performed.
+ */
+NS_IMETHODIMP
+nsDiskCacheRecord::RetrieveInfo(void* aInfo, PRUint32 aInfoLength) 
+{
+  // reset everything
+  if(mInfo) {
+    nsAllocator::Free(mInfo) ;
+    mInfo = nsnull ;
+  }
+
+  if(mKey) {
+    nsAllocator::Free(mKey) ;
+    mKey = nsnull ;
+  }
+  if(mMetaData) {
+    nsAllocator::Free(mMetaData) ;
+    mMetaData = nsnull ;
+  }
+
+  char * cur_ptr = NS_STATIC_CAST(char*, aInfo) ;
+
+  char* file_url ;
+  PRUint32 name_len ;
+
+  // set mInfoSize 
+  COPY_INT32(&mInfoSize, cur_ptr) ;
+  cur_ptr += sizeof(PRUint32) ;
+
+  // check this at least
+  if(mInfoSize != aInfoLength) 
+    return NS_ERROR_FAILURE ;
+
+  // set mRecordID 
+  COPY_INT32(&mRecordID, cur_ptr) ;
+  cur_ptr += sizeof(PRInt32) ;
+
+  // set mKeyLength
+  COPY_INT32(&mKeyLength, cur_ptr) ;
+  cur_ptr += sizeof(PRUint32) ;
+
+  // set mKey
+  mKey = NS_STATIC_CAST(char*, nsAllocator::Alloc(mKeyLength*sizeof(char))) ;
+  if(!mKey) 
+    return NS_ERROR_OUT_OF_MEMORY ;
+  
+  memcpy(mKey, cur_ptr, mKeyLength) ;
+  cur_ptr += mKeyLength ;
+
+  PRInt32 id ;
+  mDB->GetID(mKey, mKeyLength, &id) ;
+  NS_ASSERTION(id==mRecordID, "\t ++++++ bad record, somethings wrong\n") ;
+
+  // set mMetaDataLength
+  COPY_INT32(&mMetaDataLength, cur_ptr) ;
+  cur_ptr += sizeof(PRUint32) ;
+
+  // set mMetaData
+  mMetaData = NS_STATIC_CAST(char*, nsAllocator::Alloc(mMetaDataLength*sizeof(char))) ;
+  if(!mMetaData) 
+    return NS_ERROR_OUT_OF_MEMORY ;
+  
+  memcpy(mMetaData, cur_ptr, mMetaDataLength) ;
+  cur_ptr += mMetaDataLength ;
+
+  // get mFile name length
+  COPY_INT32(&name_len, cur_ptr) ;
+  cur_ptr += sizeof(PRUint32) ;
+
+  // get mFile native name
+  file_url = NS_STATIC_CAST(char*, nsAllocator::Alloc(name_len*sizeof(char))) ;
+  if(!file_url) 
+    return NS_ERROR_OUT_OF_MEMORY ;
+  
+  memcpy(file_url, cur_ptr, name_len) ;
+  cur_ptr += name_len ;
+
+  PR_ASSERT(cur_ptr == NS_STATIC_CAST(char*, aInfo) + mInfoSize);
+
+  // create mFile if Init() isn't called 
+  if(!mFile) {
+    NS_NewFileSpec(getter_AddRefs(mFile));
+    if(!mFile)
+      return NS_ERROR_OUT_OF_MEMORY ;
+  }
+
+  // setup mFile
+  mFile->SetURLString(file_url) ;
+
+  return NS_OK ;
+}
+

mozilla/netwerk/cache/filecache/nsDiskCacheRecord.h

@@ -0,0 +1,71 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
+ *
+ * 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 Communicator.
+ * 
+ * The Initial Developer of the Original Code is Intel Corp.
+ * Portions created by Intel Corp. are
+ * Copyright (C) 1999, 1999 Intel Corp.  All
+ * Rights Reserved.
+ * 
+ * Contributor(s): Yixiong Zou <yixiong.zou@intel.com>
+ *                 Carl Wong <carl.wong@intel.com>
+ */
+
+#ifndef _NET_CACHEDDISKDATA_H_
+#define _NET_CACHEDDISKDATA_H_
+
+#include "nsINetDataCacheRecord.h"
+#include "nsCOMPtr.h"
+#include "nsIDBAccessor.h"
+#include "prtypes.h"
+#include "nsILoadGroup.h"
+#include "nsIFileChannel.h" 
+#include "nsNetDiskCache.h"
+
+class nsDiskCacheRecord : public nsINetDataCacheRecord
+{
+  public:
+
+  NS_DECL_ISUPPORTS
+  NS_DECL_NSINETDATACACHERECORD
+
+  protected: 
+
+  nsDiskCacheRecord(nsIDBAccessor* db, nsNetDiskCache* aCache) ;
+  virtual ~nsDiskCacheRecord() ;
+
+  NS_IMETHOD RetrieveInfo(void* aInfo, PRUint32 aInfoLength) ;
+  NS_IMETHOD Init(const char* key, PRUint32 length, PRInt32 ID) ;
+
+  nsresult GenInfo(void) ;
+
+  private:
+
+  char*                     mKey ;
+  PRUint32                  mKeyLength ;
+  PRInt32                   mRecordID ;
+  char*                     mMetaData ;
+  PRUint32                  mMetaDataLength ;
+  nsCOMPtr<nsIFileSpec>     mFile ;
+  nsCOMPtr<nsIDBAccessor>            mDB ; 
+  void*                     mInfo ;
+  PRUint32                  mInfoSize ;
+  PRUint32                  mNumChannels ;
+  nsNetDiskCache*           mDiskCache ;
+
+  friend class nsDiskCacheRecordChannel ;
+  friend class nsDBEnumerator ;
+  friend class nsNetDiskCache ;
+} ;
+
+#endif // _NET_CACHEDDISKDATA_H_

mozilla/netwerk/cache/filecache/nsDiskCacheRecordChannel.cpp

@@ -0,0 +1,552 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
+ *
+ * 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 Communicator.
+ * 
+ * The Initial Developer of the Original Code is Intel Corp.
+ * Portions created by Intel Corp. are
+ * Copyright (C) 1999, 1999 Intel Corp.  All
+ * Rights Reserved.
+ * 
+ * Contributor(s): Yixiong Zou <yixiong.zou@intel.com>
+ *                 Carl Wong <carl.wong@intel.com>
+ */
+
+/*
+ * Most of the code are taken from nsFileChannel.  
+ */
+
+#include "nsDiskCacheRecordChannel.h"
+#include "nsIFileTransportService.h"
+//#include "nsIIOService.h"
+#include "nsIServiceManager.h"
+#include "nsIURL.h"
+#include "nsIOutputStream.h"
+#include "netCore.h"
+#include "nsIMIMEService.h"
+#include "nsISupportsUtils.h"
+
+//static NS_DEFINE_CID(kIOServiceCID, NS_IOSERVICE_CID);
+static NS_DEFINE_CID(kFileTransportServiceCID, NS_FILETRANSPORTSERVICE_CID);
+static NS_DEFINE_CID(kStandardURLCID, NS_STANDARDURL_CID);
+static NS_DEFINE_CID(kMIMEServiceCID, NS_MIMESERVICE_CID);
+
+// This is copied from nsMemCacheChannel, We should consolidate these two.
+class WriteStreamWrapper : public nsIOutputStream 
+{
+  public:
+  WriteStreamWrapper(nsDiskCacheRecordChannel* aChannel,
+                     nsIOutputStream *aBaseStream) ;
+
+  virtual ~WriteStreamWrapper() ;
+
+  static nsresult
+  Create(nsDiskCacheRecordChannel* aChannel, nsIOutputStream *aBaseStream, nsIOutputStream* *aWrapper) ;
+
+  NS_DECL_ISUPPORTS
+  NS_DECL_NSIBASESTREAM
+  NS_DECL_NSIOUTPUTSTREAM
+
+  private:
+  nsDiskCacheRecordChannel*         mChannel;
+  nsCOMPtr<nsIOutputStream>         mBaseStream;
+} ;
+
+// implement nsISupports
+NS_IMPL_ISUPPORTS(WriteStreamWrapper, NS_GET_IID(nsIOutputStream))
+
+WriteStreamWrapper::WriteStreamWrapper(nsDiskCacheRecordChannel* aChannel, 
+                                       nsIOutputStream *aBaseStream) 
+  : mChannel(aChannel), mBaseStream(aBaseStream)
+{ 
+  NS_INIT_REFCNT(); 
+  NS_ADDREF(mChannel);
+}
+
+WriteStreamWrapper::~WriteStreamWrapper()
+{
+  NS_RELEASE(mChannel);
+}
+
+nsresult 
+WriteStreamWrapper::Create(nsDiskCacheRecordChannel*aChannel, nsIOutputStream *aBaseStream, nsIOutputStream* * aWrapper) 
+{
+  WriteStreamWrapper *wrapper = new WriteStreamWrapper(aChannel, aBaseStream);
+  if (!wrapper) return NS_ERROR_OUT_OF_MEMORY;
+    NS_ADDREF(wrapper);
+  *aWrapper = wrapper;
+  return NS_OK;
+}
+
+NS_IMETHODIMP
+WriteStreamWrapper::Write(const char *aBuffer, PRUint32 aCount, PRUint32 *aNumWritten) 
+{
+  *aNumWritten = 0;
+  nsresult rv = mBaseStream->Write(aBuffer, aCount, aNumWritten);
+  mChannel->NotifyStorageInUse(*aNumWritten);
+  return rv;
+}
+
+NS_IMETHODIMP
+WriteStreamWrapper::Flush() 
+{ 
+  return mBaseStream->Flush(); 
+}
+
+NS_IMETHODIMP
+WriteStreamWrapper::Close() 
+{ 
+  return mBaseStream->Close(); 
+}
+
+nsDiskCacheRecordChannel::nsDiskCacheRecordChannel(nsDiskCacheRecord *aRecord, 
+                                                   nsILoadGroup *aLoadGroup)
+  : mRecord(aRecord) ,
+    mLoadGroup(aLoadGroup) 
+{
+  NS_INIT_REFCNT() ;
+  NS_ADDREF(mRecord);
+  mRecord->mNumChannels++ ;
+}
+
+nsDiskCacheRecordChannel::~nsDiskCacheRecordChannel()
+{
+  mRecord->mNumChannels-- ;
+  NS_RELEASE(mRecord);
+}
+
+//  I know that I gave conflicting advice on the issue of file
+//  transport versus file protocol handler, but I thought that the
+//  last word was that we would use the raw transport, when I wrote:
+//
+//   > I just thought of an argument for the other side of the coin, i.e. the
+//   > benefit of *not* reusing the file protocol handler: On the Mac, it's
+//   > expensive to convert from a string URL to an nsFileSpec, because the Mac
+//   > is brain-dead and scans every directory on the path to the file.  It's
+//   > cheaper to create a nsFileSpec for a cache file by combining a single,
+//   > static nsFileSpec that corresponds to the cache directory with the
+//   > relative path to the cache file (using nsFileSpec's operator +).  This
+//   > operation is optimized on the Mac to avoid the scanning operation.
+//
+//  The Mac guys will eat us alive if we do path string to nsFileSpec
+//  conversions for every cache file we open.
+
+nsresult 
+nsDiskCacheRecordChannel::Init(void) 
+{
+  nsresult rv = mRecord->mFile->GetFileSpec(&mSpec) ;
+  
+#ifdef XP_MAC
+
+  // Don't assume we actually created a good file spec
+  FSSpec theSpec = mSpec.GetFSSpec();
+  if (!theSpec.name[0]) {
+    NS_ERROR("failed to create a file spec");
+
+    // Since we didn't actually create the file spec
+    // we return an error
+    return NS_ERROR_MALFORMED_URI;
+  }
+#endif
+  
+  return rv ;
+
+}
+
+nsresult 
+nsDiskCacheRecordChannel::NotifyStorageInUse(PRInt32 aBytesUsed)
+{
+  return mRecord->mDiskCache->m_StorageInUse += aBytesUsed ;
+}
+
+// implement nsISupports
+NS_IMPL_ISUPPORTS4(nsDiskCacheRecordChannel, 
+                   nsIChannel, 
+                   nsIRequest,
+                   nsIStreamListener,
+                   nsIStreamObserver)
+
+// implement nsIRequest
+NS_IMETHODIMP
+nsDiskCacheRecordChannel::IsPending(PRBool *aIsPending) 
+{
+  *aIsPending = PR_FALSE ;
+  if(!mFileTransport)
+    return NS_OK ;
+
+  return mFileTransport->IsPending(aIsPending) ;
+}
+
+NS_IMETHODIMP
+nsDiskCacheRecordChannel::Cancel(void)
+{
+  if(!mFileTransport)
+    return NS_ERROR_FAILURE ;
+
+  return mFileTransport->Cancel() ;
+}
+
+NS_IMETHODIMP
+nsDiskCacheRecordChannel::Suspend(void)
+{
+  if(!mFileTransport)
+    return NS_ERROR_FAILURE ;
+
+  return mFileTransport->Suspend() ;
+}
+
+NS_IMETHODIMP
+nsDiskCacheRecordChannel::Resume(void)
+{
+  if(!mFileTransport)
+    return NS_ERROR_FAILURE ;
+
+  return mFileTransport->Resume() ;
+}
+
+// implement nsIChannel
+
+NS_IMETHODIMP
+nsDiskCacheRecordChannel::GetOriginalURI(nsIURI* *aURI)
+{
+  // FUR - might need to implement this - not sure
+  return NS_ERROR_NOT_IMPLEMENTED ;
+}
+  
+NS_IMETHODIMP
+nsDiskCacheRecordChannel::GetURI(nsIURI * *aURI)
+{
+  if(!mFileTransport)
+    return NS_ERROR_FAILURE ;
+
+  return mFileTransport->GetURI(aURI) ;
+}
+
+NS_IMETHODIMP
+nsDiskCacheRecordChannel::OpenInputStream(PRUint32 aStartPosition, 
+                                          PRInt32 aReadCount,
+                                          nsIInputStream* *aResult)
+{
+  nsresult rv ;
+
+  if(mFileTransport)
+    return NS_ERROR_IN_PROGRESS ;
+
+  NS_WITH_SERVICE(nsIFileTransportService, fts, kFileTransportServiceCID, &rv) ;
+  if(NS_FAILED(rv)) return rv ;
+  
+  rv = fts->CreateTransport(mSpec, "load", 0, 0, getter_AddRefs(mFileTransport)) ;
+  if(NS_FAILED(rv))
+    return rv ;
+  
+  // we don't need to worry about notification callbacks
+  
+  rv = mFileTransport->OpenInputStream(aStartPosition, aReadCount, aResult) ;
+  if(NS_FAILED(rv)) 
+    mFileTransport = nsnull ;
+
+  return rv ;
+}
+
+NS_IMETHODIMP
+nsDiskCacheRecordChannel::OpenOutputStream(PRUint32 startPosition, 
+                                           nsIOutputStream* *aResult)
+{
+  nsresult rv ;
+  NS_ENSURE_ARG(aResult) ;
+  
+  if(mFileTransport)
+    return NS_ERROR_IN_PROGRESS ;
+
+  nsCOMPtr<nsIOutputStream> outputStream ;
+
+  NS_WITH_SERVICE(nsIFileTransportService, fts, kFileTransportServiceCID, &rv) ;
+  if(NS_FAILED(rv)) return rv ;
+  
+  rv = fts->CreateTransport(mSpec, "load", 0, 0, getter_AddRefs(mFileTransport)) ;
+  if(NS_FAILED(rv))
+    return rv ;
+ 
+  // we don't need to worry about notification callbacks
+  
+  rv = mFileTransport->OpenOutputStream(startPosition, getter_AddRefs(outputStream)) ;
+  if(NS_FAILED(rv)) {
+    mFileTransport = nsnull ;
+    return rv ;
+  }
+ 
+  return WriteStreamWrapper::Create(this, outputStream, aResult) ;
+
+}
+
+NS_IMETHODIMP
+nsDiskCacheRecordChannel::AsyncOpen(nsIStreamObserver *observer, 
+                                    nsISupports *ctxt)
+{
+  return NS_ERROR_NOT_IMPLEMENTED ;
+}
+
+NS_IMETHODIMP
+nsDiskCacheRecordChannel::AsyncRead(PRUint32 aStartPosition, 
+                                    PRInt32 aReadCount,
+                                    nsISupports *aContext, 
+                                    nsIStreamListener *aListener)
+{
+  nsresult rv ;
+
+  if(mFileTransport)
+    return NS_ERROR_IN_PROGRESS ;
+  
+  mRealListener = aListener;
+  nsCOMPtr<nsIStreamListener> tempListener = this;
+
+  if (mLoadGroup) {
+    nsCOMPtr<nsILoadGroupListenerFactory> factory;
+    //
+    // Create a load group "proxy" listener...
+    //
+    rv = mLoadGroup->GetGroupListenerFactory(getter_AddRefs(factory));
+    if (factory) {
+      nsIStreamListener *newListener;
+      rv = factory->CreateLoadGroupListener(mRealListener, &newListener);
+      if (NS_SUCCEEDED(rv)) {
+        mRealListener = newListener;
+        NS_RELEASE(newListener);
+        }
+      }
+
+      rv = mLoadGroup->AddChannel(this, nsnull);
+      if (NS_FAILED(rv)) return rv;
+  }
+
+
+  NS_WITH_SERVICE(nsIFileTransportService, fts, kFileTransportServiceCID, &rv);
+  if (NS_FAILED(rv)) return rv;
+
+  rv = fts->CreateTransport(mSpec, "load", 0, 0, getter_AddRefs(mFileTransport));
+  if (NS_FAILED(rv)) return rv;
+
+  // no callbacks
+
+  rv = mFileTransport->AsyncRead(aStartPosition, 
+                                 aReadCount, 
+                                 aContext, 
+                                 tempListener);
+
+  if (NS_FAILED(rv)) {
+    // release the transport so that we don't think we're in progress
+    mFileTransport = nsnull;
+  }
+  return rv;
+}
+
+NS_IMETHODIMP
+nsDiskCacheRecordChannel::AsyncWrite(nsIInputStream *fromStream, 
+                                     PRUint32 startPosition,
+                                     PRInt32 writeCount, 
+                                     nsISupports *ctxt,
+                                     nsIStreamObserver *observer)
+
+{
+  /*
+  if(!mFileTransport)
+    return NS_ERROR_FAILURE ;
+
+  return mFileTransport->AsyncWrite(fromStream, 
+                                    startPosition,
+                                    writeCount,
+                                    ctxt,
+                                    observer) ;
+  */
+
+  // I can't do this since the write is not monitored, and I won't be
+  // able to updata the storage. 
+  return NS_ERROR_NOT_IMPLEMENTED;
+}
+
+NS_IMETHODIMP
+nsDiskCacheRecordChannel::GetLoadAttributes(nsLoadFlags *aLoadAttributes)
+{
+  // Not required to be implemented, since it is implemented by cache manager
+  NS_ASSERTION(0, "nsDiskCacheRecordChannel method unexpectedly called");
+  return NS_ERROR_NOT_IMPLEMENTED;
+}
+
+NS_IMETHODIMP
+nsDiskCacheRecordChannel::SetLoadAttributes(nsLoadFlags aLoadAttributes)
+{
+  // Not required to be implemented, since it is implemented by cache manager
+  NS_ASSERTION(0, "nsDiskCacheRecordChannel method unexpectedly called");
+  return NS_ERROR_NOT_IMPLEMENTED;
+}
+
+#define DUMMY_TYPE "text/html"
+
+NS_IMETHODIMP
+nsDiskCacheRecordChannel::GetContentType(char * *aContentType)
+{
+  nsresult rv ;
+
+  if (mSpec.IsDirectory()) {
+    *aContentType = nsCRT::strdup("application/http-index-format");
+    return *aContentType ? NS_OK : NS_ERROR_OUT_OF_MEMORY;
+  }
+  else {
+    // I wish I can make this simplier
+
+    char* urlStr ;
+    mRecord->mFile->GetURLString(&urlStr) ;
+
+    // file: URLs (currently) have no additional structure beyond that provided by standard
+    // URLs, so there is no "outer" given to CreateInstance 
+
+    nsCOMPtr<nsIURI> url;
+    rv = nsComponentManager::CreateInstance(kStandardURLCID, nsnull,
+                                            NS_GET_IID(nsIURI),
+                                            //(void**)&url);
+                                            getter_AddRefs(url)) ;
+    if (NS_FAILED(rv)) return rv;
+
+    rv = url->SetSpec((char*)urlStr);
+    if (NS_FAILED(rv)) 
+        return rv;
+
+    NS_WITH_SERVICE(nsIMIMEService, MIMEService, kMIMEServiceCID, &rv);
+    if (NS_FAILED(rv)) return rv;
+
+    rv = MIMEService->GetTypeFromURI(url, aContentType);
+    if (NS_SUCCEEDED(rv)) return rv;
+  }
+
+  // if all else fails treat it as text/html?
+  *aContentType = nsCRT::strdup(DUMMY_TYPE);
+  if (!*aContentType) {
+    return NS_ERROR_OUT_OF_MEMORY;
+  } else {
+    return NS_OK;
+  }
+}
+
+NS_IMETHODIMP
+nsDiskCacheRecordChannel::GetContentLength(PRInt32 *aContentLength)
+{
+  nsresult rv;
+  PRUint32 length;
+
+  rv = mRecord->mFile->GetFileSize(&length);
+  if (NS_SUCCEEDED(rv)) {
+    *aContentLength = (PRInt32)length;
+  } else {
+    *aContentLength = -1;
+  }
+  return rv;
+}
+
+NS_IMETHODIMP
+nsDiskCacheRecordChannel::GetOwner(nsISupports* *aOwner)
+{
+  *aOwner = mOwner.get() ;
+  NS_IF_ADDREF(*aOwner) ;
+  return NS_OK ;
+}
+
+NS_IMETHODIMP
+nsDiskCacheRecordChannel::SetOwner(nsISupports* aOwner) 
+{
+  mOwner = aOwner ;
+  return NS_OK ;
+}
+
+NS_IMETHODIMP
+nsDiskCacheRecordChannel::GetLoadGroup(nsILoadGroup* *aLoadGroup)
+{
+    // Not required to be implemented, since it is implemented by cache manager
+    NS_ASSERTION(0, "nsDiskCacheRecordChannel method unexpectedly called");
+      return NS_OK ;
+}
+
+NS_IMETHODIMP
+nsDiskCacheRecordChannel::SetLoadGroup(nsILoadGroup* aLoadGroup)
+{
+    // Not required to be implemented, since it is implemented by cache manager
+    NS_ASSERTION(0, "nsDiskCacheRecordChannel method unexpectedly called");
+      return NS_OK;
+}
+
+NS_IMETHODIMP
+nsDiskCacheRecordChannel::GetNotificationCallbacks(nsIInterfaceRequestor* *aNotificationCallbacks)
+{
+    // Not required to be implemented, since it is implemented by cache manager
+    NS_ASSERTION(0, "nsDiskCacheRecordChannel method unexpectedly called");
+      return NS_ERROR_NOT_IMPLEMENTED;
+}
+
+NS_IMETHODIMP
+nsDiskCacheRecordChannel::SetNotificationCallbacks(nsIInterfaceRequestor* aNotificationCallbacks)
+{
+    // Not required to be implemented, since it is implemented by cache manager
+    NS_ASSERTION(0, "nsDiskCacheRecordChannel method unexpectedly called");
+      return NS_ERROR_NOT_IMPLEMENTED;
+}
+
+////////////////////////////////////////////////////////////////////////////////
+// nsIStreamListener methods:
+////////////////////////////////////////////////////////////////////////////////
+
+NS_IMETHODIMP
+nsDiskCacheRecordChannel::OnStartRequest(nsIChannel* transportChannel, nsISupports* context)
+{
+  NS_ASSERTION(mRealListener, "No listener...");
+  return mRealListener->OnStartRequest(this, context);
+}
+
+NS_IMETHODIMP
+nsDiskCacheRecordChannel::OnStopRequest(nsIChannel* transportChannel, nsISupports* context,
+                             nsresult aStatus, const PRUnichar* aMsg)
+{
+  nsresult rv;
+
+  rv = mRealListener->OnStopRequest(this, context, aStatus, aMsg);
+
+  if (mLoadGroup) {
+    if (NS_SUCCEEDED(rv)) {
+      mLoadGroup->RemoveChannel(this, context, aStatus, aMsg);
+    }
+  }
+
+  // Release the reference to the consumer stream listener...
+  mRealListener = null_nsCOMPtr();
+  mFileTransport = null_nsCOMPtr();
+  return rv;
+}
+
+NS_IMETHODIMP
+nsDiskCacheRecordChannel::OnDataAvailable(nsIChannel* transportChannel, nsISupports* context,
+                               nsIInputStream *aIStream, PRUint32 aSourceOffset,
+                               PRUint32 aLength)
+{
+  nsresult rv;
+
+  rv = mRealListener->OnDataAvailable(this, context, aIStream,
+                                      aSourceOffset, aLength);
+
+  //
+  // If the connection is being aborted cancel the transport.  This will
+  // insure that the transport will go away even if it is blocked waiting
+  // for the consumer to empty the pipe...
+  //
+  if (NS_FAILED(rv)) {
+    mFileTransport->Cancel();
+  }
+  return rv;
+}
+

mozilla/netwerk/cache/filecache/nsDiskCacheRecordChannel.h

@@ -0,0 +1,76 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
+ *
+ * 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 Communicator.
+ * 
+ * The Initial Developer of the Original Code is Intel Corp.
+ * Portions created by Intel Corp. are
+ * Copyright (C) 1999, 1999 Intel Corp.  All
+ * Rights Reserved.
+ * 
+ * Contributor(s): Yixiong Zou <yixiong.zou@intel.com>
+ *                 Carl Wong <carl.wong@intel.com>
+ */
+
+#ifndef _ns_DiskCacheRecordChannel_h_
+#define _ns_DiskCacheRecordChannel_h_
+
+#include "nsIChannel.h"
+#include "nsCOMPtr.h"
+#include "nsDiskCacheRecord.h"
+#include "nsIStreamListener.h"
+
+/*
+ * This class is plagiarized from nsMemCacheChannel
+ */
+
+class nsDiskCacheRecordChannel : public nsIChannel,
+                                 public nsIStreamListener 
+{
+  public:
+
+  nsDiskCacheRecordChannel(nsDiskCacheRecord *aRecord, nsILoadGroup *aLoadGroup);
+  virtual ~nsDiskCacheRecordChannel() ;
+
+  // Declare nsISupports methods
+  NS_DECL_ISUPPORTS
+
+  // Declare nsIRequest methods
+  NS_DECL_NSIREQUEST
+
+  // Declare nsIChannel methods
+  NS_DECL_NSICHANNEL
+
+  // Declare nsIStreamObserver methods
+  NS_DECL_NSISTREAMOBSERVER
+
+  // Declare nsIStreamListener methods
+  NS_DECL_NSISTREAMLISTENER
+
+  nsresult Init(void) ;
+
+  private:
+
+  nsresult NotifyStorageInUse(PRInt32 aBytesUsed) ;
+
+  nsDiskCacheRecord*                    mRecord ;
+  nsCOMPtr<nsILoadGroup>                mLoadGroup ;
+  nsCOMPtr<nsISupports>                 mOwner ;
+  nsCOMPtr<nsIChannel>                  mFileTransport ;
+  nsFileSpec                            mSpec ;
+  nsCOMPtr<nsIStreamListener>           mRealListener;
+
+  friend class WriteStreamWrapper ;
+} ;
+
+#endif // _ns_DiskCacheRecordChannel_h_
+

mozilla/netwerk/cache/filecache/nsIDBAccessor.h

@@ -0,0 +1,66 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
+ *
+ * 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 Communicator.
+ * 
+ * The Initial Developer of the Original Code is Intel Corp.
+ * Portions created by Intel Corp. are
+ * Copyright (C) 1999, 1999 Intel Corp.  All
+ * Rights Reserved.
+ * 
+ * Contributor(s): Yixiong Zou <yixiong.zou@intel.com>
+ *                 Carl Wong <carl.wong@intel.com>
+ */
+
+#ifndef _NS_IDBACCESSOR_H_
+#define _NS_IDBACCESSOR_H_
+
+#include "nsISupports.h"
+#include "nsIFileSpec.h"
+
+// nsIDBAccessorIID {6AADD4D0-7785-11d3-87FE-000629D01344}
+#define NS_IDBACCESSOR_IID \
+{ 0x6aadd4d0, 0x7785, 0x11d3, \
+ {0x87, 0xfe, 0x0, 0x6, 0x29, 0xd0, 0x13, 0x44}}
+
+// nsDBAccessorCID {6AADD4D1-7785-11d3-87FE-000629D01344}
+#define NS_DBACCESSOR_CID \
+{ 0x6aadd4d1, 0x7785, 0x11d3, \
+  { 0x87, 0xfe, 0x0, 0x6, 0x29, 0xd0, 0x13, 0x44 }} 
+
+class nsIDBAccessor : public nsISupports
+{
+  public:
+  NS_DEFINE_STATIC_IID_ACCESSOR(NS_IDBACCESSOR_IID)
+
+  NS_IMETHOD Init(nsIFileSpec* DBFile) = 0 ;
+  NS_IMETHOD Shutdown(void) = 0 ;
+
+  NS_IMETHOD Put(PRInt32 aID, void* anEntry, PRUint32 aLength) = 0 ;
+
+  NS_IMETHOD Get(PRInt32 aID, void** anEntry, PRUint32 *aLength) = 0 ;
+
+  NS_IMETHOD Del(PRInt32 aID, void* anEntry, PRUint32 aLength) = 0 ;
+
+  NS_IMETHOD GetID(const char* key, PRUint32 length, PRInt32* aID) = 0 ;
+
+  NS_IMETHOD EnumEntry(void* *anEntry, PRUint32* aLength, PRBool bReset) = 0 ;
+  
+  NS_IMETHOD GetDBFilesize(PRUint32* aSize) = 0 ;
+    
+  NS_IMETHOD GetSpecialEntry(void** anEntry, PRUint32 *aLength) = 0 ;
+  NS_IMETHOD SetSpecialEntry(void* anEntry, PRUint32 aLength) = 0 ;
+
+} ;
+
+#endif // _NS_IDBACCESSOR_H_
+

mozilla/netwerk/cache/filecache/nsNetDiskCache.cpp

@@ -0,0 +1,704 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
+ *
+ * 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 Communicator.
+ * 
+ * The Initial Developer of the Original Code is Intel Corp.
+ * Portions created by Intel Corp. are
+ * Copyright (C) 1999, 1999 Intel Corp.  All
+ * Rights Reserved.
+ * 
+ * Contributor(s): Yixiong Zou <yixiong.zou@intel.com>
+ *                 Carl Wong <carl.wong@intel.com>
+ */
+
+#include "nsNetDiskCache.h"
+#include "nscore.h"
+
+#include "plstr.h"
+#include "prprf.h"
+#include "prtypes.h"
+#include "prio.h"
+#include "prsystem.h" // Directory Seperator
+#include "plhash.h"
+#include "prclist.h"
+#include "prmem.h"
+#include "prlog.h"
+
+#include "nsIComponentManager.h"
+#include "nsIServiceManager.h"
+
+#include "nsIPref.h"
+#include "mcom_db.h"
+#include "nsDBEnumerator.h"
+
+#include "nsDiskCacheRecord.h"
+#include "netCore.h"
+
+#if !defined(IS_LITTLE_ENDIAN) && !defined(IS_BIG_ENDIAN)
+ERROR! Must have a byte order
+#endif
+
+#ifdef IS_LITTLE_ENDIAN
+#define COPY_INT32(_a,_b)  memcpy(_a, _b, sizeof(int32))
+#else
+#define COPY_INT32(_a,_b)  /* swap */                   \
+    do {                                                \
+    ((char *)(_a))[0] = ((char *)(_b))[3];              \
+    ((char *)(_a))[1] = ((char *)(_b))[2];              \
+    ((char *)(_a))[2] = ((char *)(_b))[1];              \
+    ((char *)(_a))[3] = ((char *)(_b))[0];              \
+    } while(0)
+#endif
+
+static NS_DEFINE_CID(kPrefCID, NS_PREF_CID) ;
+static NS_DEFINE_CID(kDBAccessorCID, NS_DBACCESSOR_CID) ;
+
+static const PRUint32 DISK_CACHE_SIZE_DEFAULT = 5*1024*1024 ; // 5MB
+static const char * const DISK_CACHE_PREF  = "browser.cache.disk_cache_size";
+static const char * const CACHE_DIR_PREF   = "browser.cache.directory";
+
+class nsDiskCacheRecord ;
+
+nsNetDiskCache::nsNetDiskCache() :
+  m_Enabled(PR_TRUE) ,
+  m_NumEntries(0) ,
+  m_pNextCache(0) ,
+  m_pDiskCacheFolder(0) ,
+  m_StorageInUse(0) ,
+  m_DB(0) ,
+  m_DBCorrupted(PR_FALSE) 
+{
+  // set it to INF for now 
+  m_MaxEntries = (PRUint32)-1 ;
+
+  NS_INIT_REFCNT();
+
+}
+
+nsNetDiskCache::~nsNetDiskCache()
+{
+  SetSpecialEntry() ;
+
+  NS_IF_RELEASE(m_DB) ;
+  
+
+  // FUR
+  // I think that, eventually, we also want a distinguished key in the DB which
+  // means "clean cache shutdown".  You clear this flag when the db is first
+  // opened and set it just before the db is closed.  If the db wasn't shutdown
+  // cleanly in a prior session, i.e. because the app crashed, on startup you
+  // scan all the individual files in directories and look for "orphans",
+  // i.e. cache files which don't have corresponding entries in the db.  That's
+  // also when storage-in-use and number of entries would be recomputed.
+  //
+  // We don't necessarily need all this functionality immediately, though.
+
+
+  if(m_DBCorrupted) {
+    
+    nsFileSpec cacheFolder ;
+    m_pDiskCacheFolder->GetFileSpec(&cacheFolder) ;
+    
+    char nameInt[6] ;
+
+    for(nsDirectoryIterator di(cacheFolder, PR_FALSE); di.Exists(); di++) {
+      char* filename = di.Spec().GetLeafName() ;
+      char* pname = nameInt ;
+      pname = PL_strncpyz(pname, filename, 6) ;
+
+      if(PL_strcmp(pname, "trash") == 0)
+        RemoveFolder(di.Spec()) ;
+      
+      nsCRT::free(filename) ;  
+    }
+  }
+}
+
+NS_IMETHODIMP
+nsNetDiskCache::Init(void) 
+{
+  nsresult rv ;
+  
+  // don't initialize if no cache folder is set. 
+  if(!m_pDiskCacheFolder) return NS_OK ;
+
+  if(!m_DB) {
+    m_DB = new nsDBAccessor() ;
+    if(!m_DB)
+      return NS_ERROR_OUT_OF_MEMORY ;
+    else
+      NS_ADDREF(m_DB) ;
+  }
+
+  // create cache sub directories
+  nsCOMPtr<nsIFileSpec> cacheSubDir;
+  rv = NS_NewFileSpec(getter_AddRefs(cacheSubDir));
+
+  for (int i=0; i < 32; i++) {
+    rv = cacheSubDir->FromFileSpec(m_pDiskCacheFolder) ;
+    if(NS_FAILED(rv))
+      return rv ;
+
+    char dirName[3];
+    PR_snprintf (dirName, 3, "%0.2x", i);
+    cacheSubDir->AppendRelativeUnixPath (dirName) ;
+    CreateDir(cacheSubDir);
+  }
+
+  return InitDB() ;
+}
+
+NS_IMETHODIMP
+nsNetDiskCache::InitDB(void)
+{
+  nsresult rv ; 
+
+  if(!m_DBFile) {
+    NS_NewFileSpec(getter_AddRefs(m_DBFile)) ;
+    if(!m_DBFile)
+      return NS_ERROR_OUT_OF_MEMORY ;
+  }
+
+  rv = m_DBFile->FromFileSpec(m_pDiskCacheFolder) ;
+  if(NS_FAILED(rv))
+    return rv ;
+
+  m_DBFile->AppendRelativeUnixPath("cache.db") ;
+
+  rv = m_DB->Init(m_DBFile) ;
+
+  if(rv == NS_ERROR_FAILURE) {
+    // try recovery if error 
+    DBRecovery() ;
+  }
+
+  rv = GetSpecialEntry() ;
+  if(rv == NS_ERROR_FAILURE) {
+    // try recovery if error 
+    DBRecovery() ;
+  }
+
+  return rv ;
+}
+
+//////////////////////////////////////////////////////////////////////////
+// nsISupports methods
+
+NS_IMPL_ISUPPORTS3(nsNetDiskCache,
+                   nsINetDataDiskCache,
+                   nsINetDataCache,
+                   nsISupports) 
+
+///////////////////////////////////////////////////////////////////////////
+// nsINetDataCache Method 
+
+NS_IMETHODIMP
+nsNetDiskCache::GetDescription(PRUnichar* *aDescription) 
+{
+  nsAutoString description("Disk Cache") ;
+  *aDescription = description.ToNewUnicode() ;
+  if(!*aDescription)
+    return NS_ERROR_OUT_OF_MEMORY ;
+
+  return NS_OK ;
+}
+
+/* don't alloc mem for nsICachedNetData. 
+ * RecordID is generated using the same scheme in nsCacheDiskData,
+ * see GetCachedNetData() for detail.
+ */
+NS_IMETHODIMP
+nsNetDiskCache::Contains(const char* key, PRUint32 length, PRBool *_retval) 
+{
+  *_retval = PR_FALSE ;
+
+  NS_ASSERTION(m_DB, "no db.") ;
+
+  PRInt32 id = 0 ;
+  nsresult rv = m_DB->GetID(key, length, &id) ;
+
+  if(NS_FAILED(rv)) {
+    // try recovery if error 
+    DBRecovery() ;
+    return rv ;
+  }
+
+  void* info = 0 ;
+  PRUint32 info_size = 0 ;
+
+  rv = m_DB->Get(id, &info, &info_size) ;
+  if(NS_SUCCEEDED(rv) && info) 
+    *_retval = PR_TRUE ;
+        
+  if(NS_FAILED(rv)) {
+    // try recovery if error 
+    DBRecovery() ;
+  }
+
+  return rv ;
+}
+
+/* regardless if it's cached or not, a copy of nsNetDiskCache would 
+ * always be returned. so release it appropriately. 
+ * if mem alloced, updata m_NumEntries also.
+ * for now, the new nsCachedNetData is not written into db yet since
+ * we have nothing to write.
+ */
+NS_IMETHODIMP
+nsNetDiskCache::GetCachedNetData(const char* key, PRUint32 length, nsINetDataCacheRecord **_retval) 
+{
+  NS_ASSERTION(m_DB, "no db.") ;
+
+  nsresult rv = 0 ;
+  if (!_retval)
+    return NS_ERROR_NULL_POINTER ;
+
+  *_retval = nsnull ;
+
+  PRInt32 id = 0 ;
+  rv = m_DB->GetID(key, length, &id) ;
+  if(NS_FAILED(rv)) {
+    // try recovery if error 
+    DBRecovery() ;
+    return rv ;
+  }
+
+  // construct an empty record
+  nsDiskCacheRecord* newRecord = new nsDiskCacheRecord(m_DB, this) ;
+  if(!newRecord) 
+    return NS_ERROR_OUT_OF_MEMORY ;
+
+  rv = newRecord->Init(key, length, id) ;
+  if(NS_FAILED(rv)) {
+    delete newRecord ;
+    return rv ;
+  }
+
+  NS_ADDREF(newRecord) ; // addref for _retval 
+  *_retval = (nsINetDataCacheRecord*) newRecord ;
+  
+  void* info = 0 ;
+  PRUint32 info_size = 0 ;
+
+  rv = m_DB->Get(id, &info, &info_size) ;
+  if(NS_SUCCEEDED(rv) && info) {
+
+    // this is a previously cached record 
+    nsresult r1 ;
+    r1 = newRecord->RetrieveInfo(info, info_size) ;
+
+    if(NS_SUCCEEDED(rv)) 
+      return NS_OK ;
+    else { 
+      // probably a bad one
+      NS_RELEASE(newRecord) ;
+      *_retval = nsnull ;
+      return r1;
+    }
+    
+  } else if (NS_SUCCEEDED(rv) && !info) {
+    // this is a new record. 
+    m_NumEntries ++ ;
+    return NS_OK ;
+  } else {
+    // database error.
+    DBRecovery() ;
+    return rv ;
+  }
+}
+
+/* get an nsICachedNetData, mem needs to be de-alloced if not found. */
+NS_IMETHODIMP
+nsNetDiskCache::GetCachedNetDataByID(PRInt32 RecordID, nsINetDataCacheRecord **_retval) 
+{
+  NS_ASSERTION(m_DB, "no db.") ;
+
+  if (!_retval)
+    return NS_ERROR_NULL_POINTER ;
+
+  *_retval = nsnull ;
+  
+  nsresult rv ;
+
+  void* info = 0 ;
+  PRUint32 info_size = 0 ;
+
+  rv = m_DB->Get(RecordID, &info, &info_size) ;
+  if(NS_SUCCEEDED(rv) && info) {
+
+    // construct an empty record if only found in db
+    nsDiskCacheRecord* newRecord = new nsDiskCacheRecord(m_DB, this) ;
+    if(!newRecord) 
+      return NS_ERROR_OUT_OF_MEMORY ;
+
+    NS_ADDREF(newRecord) ; // addref for _retval
+    rv = newRecord->RetrieveInfo(info, info_size) ;
+
+    if(NS_SUCCEEDED(rv)) {
+      *_retval = (nsINetDataCacheRecord*) newRecord ;
+      return NS_OK ;
+    } 
+    else {
+      // bad record, I guess
+      NS_RELEASE(newRecord) ; // release if bad things happen
+      return rv ;
+    }
+  } else {
+    NS_ERROR("Error: RecordID not in DB\n") ;
+    DBRecovery() ;
+    return rv ;
+  }
+}
+
+NS_IMETHODIMP
+nsNetDiskCache::GetEnabled(PRBool *aEnabled) 
+{
+  *aEnabled = m_Enabled ;
+  return NS_OK ;
+}
+
+NS_IMETHODIMP
+nsNetDiskCache::SetEnabled(PRBool aEnabled) 
+{
+  m_Enabled = aEnabled ;
+  return NS_OK ;
+}
+
+NS_IMETHODIMP
+nsNetDiskCache::GetFlags(PRUint32 *aFlags) 
+{
+  *aFlags = FILE_PER_URL_CACHE;
+  return NS_OK ;
+}
+
+NS_IMETHODIMP
+nsNetDiskCache::GetNumEntries(PRUint32 *aNumEntries) 
+{
+  *aNumEntries = m_NumEntries ;
+  return NS_OK ;
+}
+
+NS_IMETHODIMP
+nsNetDiskCache::GetMaxEntries(PRUint32 *aMaxEntries)
+{
+  *aMaxEntries = m_MaxEntries ;
+  return NS_OK ;
+}
+
+NS_IMETHODIMP
+nsNetDiskCache::NewCacheEntryIterator(nsISimpleEnumerator **_retval) 
+{
+  NS_ASSERTION(m_DB, "no db.") ;
+
+  if(!_retval)
+    return NS_ERROR_NULL_POINTER ;
+
+  *_retval = nsnull ;
+
+  nsISimpleEnumerator* enumerator = new nsDBEnumerator(m_DB, this) ;
+  if(enumerator) {
+    NS_ADDREF(enumerator) ;
+    *_retval = enumerator ;
+    return NS_OK ;
+  }
+  else 
+    return NS_ERROR_OUT_OF_MEMORY ;
+}
+
+NS_IMETHODIMP
+nsNetDiskCache::GetNextCache(nsINetDataCache * *aNextCache)
+{
+  if(!aNextCache)
+    return NS_ERROR_NULL_POINTER ;
+
+  *aNextCache = m_pNextCache ;
+  return NS_OK ;
+}
+
+NS_IMETHODIMP
+nsNetDiskCache::SetNextCache(nsINetDataCache *aNextCache)
+{
+  m_pNextCache = aNextCache ;
+  return NS_OK ;
+}
+
+// db size can always be measured at the last minute. Since it's hard
+// to know before hand. 
+NS_IMETHODIMP
+nsNetDiskCache::GetStorageInUse(PRUint32 *aStorageInUse)
+{
+  NS_ASSERTION(m_DB, "no db.") ;
+
+  PRUint32 total_size = m_StorageInUse ;
+
+  /*
+  PRUint32 len = 0 ;
+  // add the size of the db.
+  m_DB->GetDBFilesize(&len) ;
+  total_size += len ;
+  */
+
+  // we need size in kB
+  total_size = total_size >> 10 ;
+
+  *aStorageInUse = total_size ;
+  return NS_OK ;
+}
+
+/*
+ * The whole cache dirs can be whiped clean since all the cache 
+ * files are resides in seperate hashed dirs. It's safe to do so.
+ */
+ 
+NS_IMETHODIMP
+nsNetDiskCache::RemoveAll(void)
+{
+  NS_ASSERTION(m_DB, "no db.") ;
+  NS_ASSERTION(m_pDiskCacheFolder, "no cache folder.") ;
+
+  // remove all the sub folders
+  nsFileSpec cacheSubDir;
+
+  for (int i=0; i < 32; i++) {
+    m_pDiskCacheFolder->GetFileSpec(&cacheSubDir) ;
+
+    char dirName[3];
+    PR_snprintf (dirName, 3, "%0.2x", i);
+    cacheSubDir += dirName ;
+    RemoveFolder(cacheSubDir) ;
+  }
+
+  // don't forget the db file itself
+  m_DB->Shutdown() ;
+  nsFileSpec dbfile ;
+  m_DBFile->GetFileSpec(&dbfile) ;
+  dbfile.Delete(PR_TRUE) ;
+
+  // reinitilize
+  return Init() ;
+}
+
+//////////////////////////////////////////////////////////////////
+// nsINetDataDiskCache methods
+
+NS_IMETHODIMP
+nsNetDiskCache::GetDiskCacheFolder(nsIFileSpec * *aDiskCacheFolder)
+{
+  *aDiskCacheFolder = nsnull ;
+  NS_ASSERTION(m_pDiskCacheFolder, "no cache folder.") ;
+
+  *aDiskCacheFolder = m_pDiskCacheFolder ;
+  NS_ADDREF(*aDiskCacheFolder) ;
+  return NS_OK ;
+}
+
+NS_IMETHODIMP
+nsNetDiskCache::SetDiskCacheFolder(nsIFileSpec * aDiskCacheFolder)
+{
+  if(!m_pDiskCacheFolder) {
+    NS_NewFileSpec(getter_AddRefs(m_pDiskCacheFolder));
+    if(!m_pDiskCacheFolder) 
+      return NS_ERROR_OUT_OF_MEMORY ;
+    
+    m_pDiskCacheFolder = aDiskCacheFolder ;
+    return Init() ;
+  } 
+  else {
+    char *newfolder, *oldfolder ;
+    m_pDiskCacheFolder->GetNativePath(&oldfolder) ;
+    aDiskCacheFolder->GetNativePath(&newfolder) ;
+
+    if(PL_strcmp(newfolder, oldfolder) != 0) {
+      m_pDiskCacheFolder = aDiskCacheFolder ;
+
+      // do we need to blow away old cache before building a new one?
+      // return RemoveAll() ;
+
+      m_DB->Shutdown() ;
+      return Init() ;
+
+    } else 
+      return NS_OK ;
+  }
+}
+
+//////////////////////////////////////////////////////////////////
+// nsNetDiskCache methods
+
+// create a directory (recursively)
+NS_IMETHODIMP
+nsNetDiskCache::CreateDir(nsIFileSpec* dir_spec) 
+{
+  PRBool does_exist ;
+  nsCOMPtr<nsIFileSpec> p_spec ;
+
+  dir_spec->Exists(&does_exist) ;
+  if(does_exist) 
+    return NS_OK ;
+
+  nsresult rv = dir_spec->GetParent(getter_AddRefs(p_spec)) ;
+  if(NS_FAILED(rv))
+    return rv ;
+
+  p_spec->Exists(&does_exist) ;
+  if(!does_exist) {
+    CreateDir(p_spec) ;
+    rv = dir_spec->CreateDir() ;
+    if(NS_FAILED(rv))
+      return rv ;
+  }
+  else {
+    rv = dir_spec->CreateDir() ;
+    if(NS_FAILED(rv))
+      return rv ;
+  }
+  
+  return NS_OK ;
+}
+
+// We can't afford to make a *separate* pass over the whole db on every
+// startup, just to figure out m_NumEntries and m_StorageInUse.  (This is a
+// several second operation on a large db).  We'll likely need to store
+// distinguished keys in the db that contain these values and update them
+// incrementally, except when failure to shut down the db cleanly is detected.
+
+NS_IMETHODIMP
+nsNetDiskCache::GetSpecialEntry(void)
+{
+  void* pInfo ;
+  PRUint32 InfoSize ;
+
+  nsresult rv = m_DB->GetSpecialEntry(&pInfo, &InfoSize) ;
+  if(NS_FAILED(rv))
+    return rv ;
+
+  if(!pInfo && InfoSize == 0) {
+    // must be a new DB
+    m_NumEntries = 0 ;
+    m_StorageInUse = 0 ;
+  } 
+  else {
+    char * cur_ptr = NS_STATIC_CAST(char*, pInfo) ;
+    
+    // get m_NumEntries
+    COPY_INT32(&m_NumEntries, cur_ptr) ;
+    cur_ptr += sizeof(PRUint32) ;
+    
+    // get m_StorageInUse
+    COPY_INT32(&m_StorageInUse, cur_ptr) ;
+    cur_ptr += sizeof(PRUint32) ;
+    
+    PR_ASSERT(cur_ptr == NS_STATIC_CAST(char*, pInfo) + InfoSize);
+  }
+
+  return NS_OK ;
+}
+
+NS_IMETHODIMP
+nsNetDiskCache::SetSpecialEntry(void)
+{
+  PRUint32 InfoSize ;
+  
+  InfoSize = sizeof m_NumEntries ;
+  InfoSize += sizeof m_StorageInUse ;
+  
+  void* pInfo = nsAllocator::Alloc(InfoSize*sizeof(char)) ;
+  if(!pInfo) 
+    return NS_ERROR_OUT_OF_MEMORY ;
+  
+  char* cur_ptr = NS_STATIC_CAST(char*, pInfo) ;
+
+  COPY_INT32(cur_ptr, &m_NumEntries) ;
+  cur_ptr += sizeof(PRUint32) ;
+
+  COPY_INT32(cur_ptr, &m_StorageInUse) ;
+  cur_ptr += sizeof(PRUint32) ;
+  
+  PR_ASSERT(cur_ptr == NS_STATIC_CAST(char*, pInfo) + InfoSize);
+  
+  return m_DB->SetSpecialEntry(pInfo, InfoSize) ;
+}
+
+// this routine will be called everytime we have a db corruption. 
+// m_DB will be re-initialized, m_StorageInUse and m_NumEntries will
+// be reset.
+NS_IMETHODIMP
+nsNetDiskCache::DBRecovery(void)
+{
+  // rename all the sub cache dirs and remove them later during dtor. 
+  nsresult rv = RenameCacheSubDirs() ;
+  if(NS_FAILED(rv))
+    return rv ;
+
+  // remove corrupted db file, don't care if db->shutdown fails or not.
+  m_DB->Shutdown() ;
+  
+  nsFileSpec dbfile ;
+  m_DBFile->GetFileSpec(&dbfile) ;
+  dbfile.Delete(PR_TRUE) ;
+
+  // make sure it's not there any more
+  PRBool exists = dbfile.Exists() ;
+  if(exists) {
+    NS_ERROR("can't remove old db.") ;
+    return NS_ERROR_FAILURE ;
+  }
+
+  // reinitilize DB 
+  return InitDB() ;
+}
+
+// this routine will add string "trash" to current CacheSubDir names. 
+// e.g. 00->trash00, 1f->trash1f. and update the m_DBCorrupted. 
+
+NS_IMETHODIMP
+nsNetDiskCache::RenameCacheSubDirs(void) 
+{
+  nsCOMPtr<nsIFileSpec> cacheSubDir;
+  nsresult rv = NS_NewFileSpec(getter_AddRefs(cacheSubDir)) ;
+
+  for (int i=0; i < 32; i++) {
+    rv = cacheSubDir->FromFileSpec(m_pDiskCacheFolder) ;
+    if(NS_FAILED(rv))
+      return rv ;
+
+    char oldName[3], newName[8];
+    PR_snprintf(oldName, 3, "%0.2x", i) ;
+    cacheSubDir->AppendRelativeUnixPath(oldName) ;
+
+    // re-name the directory
+    PR_snprintf(newName, 8, "trash%0.2x", i) ;
+    rv = cacheSubDir->Rename(newName) ;
+    if(NS_FAILED(rv))
+      // TODO, error checking
+      return NS_ERROR_FAILURE ;
+  }
+
+  // update m_DBCorrupted 
+  m_DBCorrupted = PR_TRUE ;
+
+  return NS_OK ;
+}
+
+// this routine is used by dtor and RemoveAll() to clean up dirs.
+NS_IMETHODIMP
+nsNetDiskCache::RemoveFolder(nsFileSpec aFolder)
+{
+  for(nsDirectoryIterator di(aFolder, PR_FALSE); di.Exists(); di++) {
+    di.Spec().Delete(PR_TRUE) ;
+  }
+  
+  aFolder.Delete(PR_FALSE) ; // recursive delete
+  
+  return NS_OK ;
+}

mozilla/netwerk/cache/filecache/nsNetDiskCache.h

@@ -0,0 +1,91 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
+ *
+ * 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 Communicator.
+ * 
+ * The Initial Developer of the Original Code is Intel Corp.
+ * Portions created by Intel Corp. are
+ * Copyright (C) 1999, 1999 Intel Corp.  All
+ * Rights Reserved.
+ * 
+ * Contributor(s): Yixiong Zou <yixiong.zou@intel.com>
+ *                 Carl Wong <carl.wong@intel.com>
+ */
+
+/*
+ * This file is part of filecache implementation.
+ *
+ * nsNetDiskCache is the main disk cache module that will create 
+ * the cache database, and then store and retrieve nsDiskCacheRecord 
+ * objects from it. It also contains some basic error recovery procedure.
+ */
+
+#ifndef __gen_nsNetDiskCache_h__
+#define __gen_nsNetDiskCache_h__
+
+#include "nsINetDataDiskCache.h"
+#include "nsNetDiskCacheCID.h"
+#include "nsCOMPtr.h"
+#include "nsIPref.h"
+#include "nsDBAccessor.h"
+
+class nsIURI; /* forward decl */
+class nsICachedNetData; /* forward decl */
+class nsISimpleEnumerator; /* forward decl */
+class nsIFileSpec; /* forward decl */
+
+/* starting interface:    nsNetDiskCache */
+
+class nsNetDiskCache : public nsINetDataDiskCache {
+  public: 
+
+  NS_DECL_ISUPPORTS
+  NS_DECL_NSINETDATACACHE
+  NS_DECL_NSINETDATADISKCACHE
+
+  NS_IMETHOD Init(void) ;
+
+  nsNetDiskCache() ;
+  virtual ~nsNetDiskCache() ;
+
+  protected:
+
+  NS_IMETHOD InitDB(void) ;
+  NS_IMETHOD CreateDir(nsIFileSpec* dir_spec) ;
+  NS_IMETHOD GetSpecialEntry(void) ;
+  NS_IMETHOD SetSpecialEntry(void) ;
+
+  NS_IMETHOD RenameCacheSubDirs(void) ;
+  NS_IMETHOD DBRecovery(void) ;
+  NS_IMETHOD RemoveFolder(nsFileSpec aFolder) ;
+
+  private:
+
+  PRBool 			                m_Enabled ;
+  PRUint32 			                m_NumEntries ;
+  nsCOMPtr<nsINetDataCache> 	    m_pNextCache ;
+  nsCOMPtr<nsIFileSpec>   	        m_pDiskCacheFolder ;
+  nsCOMPtr<nsIFileSpec>             m_DBFile ;
+
+  PRUint32                          m_MaxEntries ;
+  PRUint32                          m_StorageInUse ;
+  nsIDBAccessor*                    m_DB ;
+
+  // this is used to indicate a db corruption 
+  PRBool                            m_DBCorrupted ;
+
+  friend class nsDiskCacheRecord ;
+  friend class nsDiskCacheRecordChannel ;
+  friend class nsDBEnumerator ;
+} ;
+
+#endif /* __gen_nsNetDiskCache_h__ */

mozilla/netwerk/cache/filecache/nsNetDiskCacheCID.h

@@ -0,0 +1,32 @@
+/*
+ * 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 Communicator.
+ * 
+ * The Initial Developer of the Original Code is Intel Corp.
+ * Portions created by Intel Corp. are
+ * Copyright (C) 1999, 1999 Intel Corp.  All
+ * Rights Reserved.
+ * 
+ * Contributor(s): Yixiong Zou <yixiong.zou@intel.com>
+ *                 Carl Wong <carl.wong@intel.com>
+ */
+
+#ifndef _nsNetDiskCacheCID_h_
+#define _nsNetDiskCacheCID_h_
+
+#define NS_NETDISKCACHE_CID_STR "ECFEEA00-7201-11d3-87FE-000629D01344"
+
+#define NS_NETDISKCACHE_CID \
+{ 0xecfeea00, 0x7201, 0x11d3, \
+ { 0x87, 0xfe, 0x0, 0x6, 0x29, 0xd0, 0x13, 0x44 }}
+
+#endif /* _nsNetDiskCacheCID_h_ */

mozilla/netwerk/cache/filecache/test/Makefile.in

@@ -0,0 +1,50 @@
+#
+# The contents of this file are subject to the Netscape Public License
+# Version 1.0 (the "NPL"); you may not use this file except in
+# compliance with the NPL.  You may obtain a copy of the NPL at
+# http://www.mozilla.org/NPL/
+#
+# Software distributed under the NPL is distributed on an "AS IS" basis,
+# WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+# for the specific language governing rights and limitations under the
+# NPL.
+#
+# The Initial Developer of this code under the NPL is Netscape
+# Communications Corporation.  Portions created by Netscape are
+# Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+# Reserved.
+#
+
+DEPTH		= ../../../..
+topsrcdir	= @top_srcdir@
+srcdir		= @srcdir@
+VPATH		= @srcdir@
+
+include $(DEPTH)/config/autoconf.mk
+
+REQUIRES	= libreg xpcom
+
+CPPSRCS		= \
+         diskcache.cpp \
+		$(NULL)
+
+SIMPLE_PROGRAMS	= $(CPPSRCS:.cpp=)
+
+ifdef NO_LD_ARCHIVE_FLAGS
+LOST_SYM_LIBS	= -lxpcomds_s -lxptinfo -lmozreg_s
+endif
+
+LIBS		= \
+		-lmozjs \
+		-lxpcom \
+        -lmozdbm_s \
+		$(MOZ_NECKO_UTIL_LIBS) \
+		$(LOST_SYM_LIBS) \
+		$(NSPR_LIBS) \
+		$(NULL)
+
+include $(topsrcdir)/config/rules.mk
+
+LOCAL_INCLUDES = -I$(srcdir)/..
+
+DEFINES		+= -DUSE_NSREG -DCACHE

mozilla/netwerk/cache/filecache/test/diskcache.cpp

@@ -0,0 +1,836 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ *
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+
+#include "nsIStreamListener.h"
+#include "nsIStreamObserver.h"
+#include "nsIServiceManager.h"
+#include "nsIInputStream.h"
+#include "nsIOutputStream.h"
+#include "nsIEventQueue.h"
+#include "nsIEventQueueService.h"
+#include "nsIChannel.h"
+#include "nsCOMPtr.h"
+#include "nsString.h"
+#include <stdio.h>
+#include <unistd.h>
+
+#include "nsINetDataCache.h"
+#include "nsINetDataCacheRecord.h"
+//#include "nsMemCacheCID.h"
+#include "nsNetDiskCache.h"
+#include "nsIPref.h"
+#include "prenv.h"
+#include "nsIFileStream.h"
+
+// Number of test entries to be placed in the cache
+#define NUM_CACHE_ENTRIES  250
+
+// Cache content stream length will have random length between zero and
+// MAX_CONTENT_LENGTH bytes
+#define MAX_CONTENT_LENGTH 20000
+
+// Length of random-data cache entry key
+#define CACHE_KEY_LENGTH 15
+
+// Length of random-data cache entry meta-data
+#define CACHE_METADATA_LENGTH 100
+
+//static NS_DEFINE_CID(kMemCacheCID, NS_MEM_CACHE_FACTORY_CID);
+static NS_DEFINE_CID(kEventQueueServiceCID, NS_EVENTQUEUESERVICE_CID);
+static NS_DEFINE_CID(kDiskCacheCID, NS_NETDISKCACHE_CID) ;
+static NS_DEFINE_CID(kPrefCID, NS_PREF_CID);
+static NS_DEFINE_IID(kIPrefIID, NS_IPREF_IID);
+
+// Mapping from test case number to RecordID
+static PRInt32 recordID[NUM_CACHE_ENTRIES];
+
+static PRInt32
+mapRecordIdToTestNum(PRInt32 aRecordID)
+{
+    int i;
+    for (i = 0; i < NUM_CACHE_ENTRIES; i++) {
+        if (recordID[i] == aRecordID)
+            return i;
+    }
+    return -1;
+}
+
+// A supply of stream data to either store or compare with
+class nsITestDataStream {
+public:
+    virtual ~nsITestDataStream() {};
+    virtual PRUint32 Next() = 0;
+    virtual void Read(char* aBuf, PRUint32 aCount) = 0;
+
+    virtual PRBool Match(char* aBuf, PRUint32 aCount) = 0;
+    virtual void Skip(PRUint32 aCount) = 0;
+};
+
+// A reproducible stream of random data.
+class RandomStream : public nsITestDataStream {
+public:
+    RandomStream(PRUint32 aSeed) {
+        mStartSeed = mState = aSeed;
+    }
+    
+    PRUint32 GetStartSeed() {
+        return mStartSeed;
+    }
+    
+    PRUint32 Next() {
+        mState = 1103515245 * mState + 12345;
+        return mState;
+    }
+
+    void Read(char* aBuf, PRUint32 aCount) {
+        PRUint32 i;
+        for (i = 0; i < aCount; i++) {
+            *aBuf++ = Next();
+        }
+    }
+
+    PRBool
+    Match(char* aBuf, PRUint32 aCount) {
+        PRUint32 i;
+        for (i = 0; i < aCount; i++) {
+            if (*aBuf++ != (char)(Next() & 0xff))
+                return PR_FALSE;
+        }
+        return PR_TRUE;
+    }
+
+    void
+    Skip(PRUint32 aCount) {
+        while (aCount--)
+            Next();
+    }
+
+protected:
+    
+    PRUint32 mState;
+    PRUint32 mStartSeed;
+};
+
+// A stream of data that increments on each byte that is read, modulo 256
+class CounterStream : public nsITestDataStream {
+public:
+    CounterStream(PRUint32 aSeed) {
+        mStartSeed = mState = aSeed;
+    }
+    
+    PRUint32 GetStartSeed() {
+        return mStartSeed;
+    }
+    
+    PRUint32 Next() {
+        mState += 1;
+        mState &= 0xff;
+        return mState;
+    }
+
+    void Read(char* aBuf, PRUint32 aCount) {
+        PRUint32 i;
+        for (i = 0; i < aCount; i++) {
+            *aBuf++ = Next();
+        }
+    }
+
+    PRBool
+    Match(char* aBuf, PRUint32 aCount) {
+        PRUint32 i;
+        for (i = 0; i < aCount; i++) {
+            if (*aBuf++ != (char)Next())
+                return PR_FALSE;
+        }
+        return PR_TRUE;
+    }
+
+    void
+    Skip(PRUint32 aCount) {
+        mState += aCount;
+        mState &= 0xff;
+    }
+
+protected:
+    
+    PRUint32 mState;
+    PRUint32 mStartSeed;
+};
+
+static int gNumReaders = 0;
+static PRUint32 gTotalBytesRead = 0;
+static PRUint32 gTotalDuration = 0;
+
+class nsReader : public nsIStreamListener {
+public:
+    NS_DECL_ISUPPORTS
+
+    nsReader()
+        : mStartTime(0), mBytesRead(0)
+    {
+        NS_INIT_REFCNT();
+        gNumReaders++;
+    }
+
+    virtual ~nsReader() {
+        delete mTestDataStream;
+        gNumReaders--;
+    }
+
+    nsresult 
+    Init(nsIChannel *aChannel, nsITestDataStream* aRandomStream, PRUint32 aExpectedStreamLength) {
+        mChannel = aChannel;
+        mTestDataStream = aRandomStream;
+        mExpectedStreamLength = aExpectedStreamLength;
+        mRefCnt = 1;
+        return NS_OK;
+    }
+
+    NS_IMETHOD OnStartRequest(nsIChannel* channel,
+                              nsISupports* context) {
+        mStartTime = PR_IntervalNow();
+        return NS_OK;
+    }
+
+    NS_IMETHOD OnDataAvailable(nsIChannel* channel, 
+                               nsISupports* context,
+                               nsIInputStream *aIStream, 
+                               PRUint32 aSourceOffset,
+                               PRUint32 aLength) {
+        char buf[1025];
+        while (aLength > 0) {
+            PRUint32 amt;
+            PRBool match;
+            aIStream->Read(buf, sizeof buf, &amt);
+            if (amt == 0) break;
+            aLength -= amt;
+            mBytesRead += amt;
+            match = mTestDataStream->Match(buf, amt);
+            NS_ASSERTION(match, "Stored data was corrupted on read");
+        }
+        return NS_OK;
+    }
+
+    NS_IMETHOD OnStopRequest(nsIChannel* channel, 
+                             nsISupports* context,
+                             nsresult aStatus,
+                             const PRUnichar* aMsg) {
+        PRIntervalTime endTime;
+        PRIntervalTime duration;
+        
+        endTime = PR_IntervalNow();
+        duration = (endTime - mStartTime);
+
+        if (NS_FAILED(aStatus)) printf("channel failed.\n");
+        //        printf("read %d bytes\n", mBytesRead);
+
+        NS_ASSERTION(mBytesRead == mExpectedStreamLength,
+                     "Stream in cache is wrong length");
+
+        gTotalBytesRead += mBytesRead;
+        gTotalDuration += duration;
+
+        // Release channel
+        mChannel = 0;
+        return NS_OK;
+    }
+
+protected:
+    PRIntervalTime       mStartTime;
+    PRUint32             mBytesRead;
+    nsITestDataStream*   mTestDataStream;
+    PRUint32             mExpectedStreamLength;
+    nsCOMPtr<nsIChannel> mChannel;
+};
+
+NS_IMPL_ISUPPORTS2(nsReader, nsIStreamListener, nsIStreamObserver)
+
+static nsIEventQueue* eventQueue;
+
+nsresult
+InitQueue() {
+    nsresult rv;
+
+    NS_WITH_SERVICE(nsIEventQueueService, eventQService, kEventQueueServiceCID, &rv);
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get event queue service");
+
+    rv = eventQService->CreateThreadEventQueue();
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't create event queue");
+  
+    rv = eventQService->GetThreadEventQueue(PR_CurrentThread(), &eventQueue);
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get event queue for main thread");
+
+    return NS_OK;
+}
+
+// Process events until all streams are OnStopRequest'ed
+nsresult
+WaitForEvents() {
+    while (gNumReaders) {
+        eventQueue->ProcessPendingEvents();
+    }
+    return NS_OK;
+}
+
+// Read data for a single cache record and compare against testDataStream
+nsresult
+TestReadStream(nsINetDataCacheRecord *record, nsITestDataStream *testDataStream,
+               PRUint32 expectedStreamLength)
+{
+    nsCOMPtr<nsIChannel> channel;
+    nsresult rv;
+    PRUint32 actualContentLength;
+
+    rv = record->NewChannel(0, getter_AddRefs(channel));
+    NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+
+    rv = record->GetStoredContentLength(&actualContentLength);
+    NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+    NS_ASSERTION(actualContentLength == expectedStreamLength,
+                 "nsINetDataCacheRecord::GetContentLength() busted ?");
+    
+    nsReader *reader = new nsReader;
+    reader->AddRef();
+    rv = reader->Init(channel, testDataStream, expectedStreamLength);
+    NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+    
+    rv = channel->AsyncRead(0, -1, 0, reader);
+    NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+    reader->Release();
+
+    return NS_OK;
+}
+
+// Check that records can be retrieved using their record-ID, in addition
+// to using the opaque key.
+nsresult
+TestRecordID(nsINetDataCache *cache)
+{
+    nsresult rv;
+    nsCOMPtr<nsINetDataCacheRecord> record;
+    RandomStream *randomStream;
+    PRUint32 metaDataLength;
+    char cacheKey[CACHE_KEY_LENGTH];
+    char *metaData;
+    PRUint32 testNum;
+    PRBool match;
+
+    for (testNum = 0; testNum < NUM_CACHE_ENTRIES; testNum++) {
+        randomStream = new RandomStream(testNum);
+        randomStream->Read(cacheKey, sizeof cacheKey);
+
+        rv = cache->GetCachedNetDataByID(recordID[testNum], getter_AddRefs(record));
+        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't obtain record using record ID");
+
+        // Match against previously stored meta-data
+        rv = record->GetMetaData(&metaDataLength, &metaData);
+        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get record meta-data");
+        match = randomStream->Match(metaData, metaDataLength);
+        NS_ASSERTION(match, "Meta-data corrupted or incorrect");
+
+        nsAllocator::Free(metaData);
+        delete randomStream;
+    }
+    return NS_OK;
+}
+
+// Check that all cache entries in the database are enumerated and that
+// no duplicates appear.
+nsresult
+TestEnumeration(nsINetDataCache *cache)
+{
+    nsresult rv;
+    nsCOMPtr<nsINetDataCacheRecord> record;
+    nsCOMPtr<nsISupports> tempISupports;
+    nsCOMPtr<nsISimpleEnumerator> iterator;
+    RandomStream *randomStream;
+    PRUint32 metaDataLength;
+    char cacheKey[CACHE_KEY_LENGTH];
+    char *metaData;
+    PRUint32 testNum;
+    PRBool match;
+    PRInt32 recID;
+
+    int numRecords = 0;
+
+    // Iterate over all records in the cache
+    rv = cache->NewCacheEntryIterator(getter_AddRefs(iterator));
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't create new cache entry iterator");
+
+    PRBool notDone;
+    while (1) {
+
+        // Done iterating ?
+        rv = iterator->HasMoreElements(&notDone);
+        if (NS_FAILED(rv)) return rv;
+        if (!notDone)
+            break;
+
+        // Get next record in iteration
+        rv = iterator->GetNext(getter_AddRefs(tempISupports));
+        NS_ASSERTION(NS_SUCCEEDED(rv), "iterator bustage");
+        record = do_QueryInterface(tempISupports);
+
+        numRecords++;
+
+        // Get record ID
+        rv = record->GetRecordID(&recID);
+        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get Record ID");
+        testNum = mapRecordIdToTestNum(recID);
+        NS_ASSERTION(testNum != -1, "Corrupted Record ID ?");
+
+        // Erase mapping from table, so that duplicate enumerations are detected
+        recordID[testNum] = -1;
+
+        // Make sure stream matches test data
+        randomStream = new RandomStream(testNum);
+        randomStream->Read(cacheKey, sizeof cacheKey);
+
+        // Match against previously stored meta-data
+        rv = record->GetMetaData(&metaDataLength, &metaData);
+        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get record meta-data");
+        match = randomStream->Match(metaData, metaDataLength);
+        NS_ASSERTION(match, "Meta-data corrupted or incorrect");
+        nsAllocator::Free(metaData);
+
+        delete randomStream;
+    }
+
+    NS_ASSERTION(numRecords == NUM_CACHE_ENTRIES, "Iteration bug");
+
+    return NS_OK;
+}
+
+// Read the test data that was written in FillCache(), checking for
+// corruption, truncation.
+nsresult
+TestRead(nsINetDataCache *cache)
+{
+    nsresult rv;
+    PRBool inCache;
+    nsCOMPtr<nsINetDataCacheRecord> record;
+    RandomStream *randomStream;
+    PRUint32 metaDataLength;
+    char cacheKey[CACHE_KEY_LENGTH];
+    char *metaData, *storedCacheKey;
+    PRUint32 testNum, storedCacheKeyLength;
+    PRBool match;
+
+    for (testNum = 0; testNum < NUM_CACHE_ENTRIES; testNum++) {
+        randomStream = new RandomStream(testNum);
+        randomStream->Read(cacheKey, sizeof cacheKey);
+
+        // Ensure that entry is in the cache
+        rv = cache->Contains(cacheKey, sizeof cacheKey, &inCache);
+        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+        NS_ASSERTION(inCache, "nsINetDataCache::Contains error");
+        
+        rv = cache->GetCachedNetData(cacheKey, sizeof cacheKey, getter_AddRefs(record));
+        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+
+        // Match against previously stored meta-data
+        match = record->GetMetaData(&metaDataLength, &metaData);
+        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+        match = randomStream->Match(metaData, metaDataLength);
+        NS_ASSERTION(match, "Meta-data corrupted or incorrect");
+        nsAllocator::Free(metaData);
+
+        // Test GetKey() method
+        rv = record->GetKey(&storedCacheKeyLength, &storedCacheKey);
+        NS_ASSERTION(NS_SUCCEEDED(rv) &&
+                     (storedCacheKeyLength == sizeof cacheKey) &&
+                     !memcmp(storedCacheKey, &cacheKey[0], sizeof cacheKey),
+                     "nsINetDataCacheRecord::GetKey failed");
+        nsAllocator::Free(storedCacheKey);
+
+        PRUint32 expectedStreamLength = randomStream->Next() & 0xffff;
+
+        TestReadStream(record, randomStream, expectedStreamLength);
+    }
+
+    WaitForEvents();
+
+    // Compute rate in MB/s
+    double rate = gTotalBytesRead / PR_IntervalToMilliseconds(gTotalDuration);
+    rate *= NUM_CACHE_ENTRIES;
+    rate *= 1000;
+    rate /= (1024 * 1024);
+    printf("Read %d bytes at a rate of %5.1f MB per second \n",
+           gTotalBytesRead, rate);
+
+    return NS_OK;
+}
+
+// Repeatedly call SetStoredContentLength() on a cache entry and make
+// read the stream's data to ensure that it's not corrupted by the effect
+nsresult
+TestTruncation(nsINetDataCache *cache)
+{
+    nsresult rv;
+    nsCOMPtr<nsINetDataCacheRecord> record;
+    RandomStream *randomStream;
+    char cacheKey[CACHE_KEY_LENGTH];
+
+    randomStream = new RandomStream(0);
+    randomStream->Read(cacheKey, sizeof cacheKey);
+
+    rv = cache->GetCachedNetData(cacheKey, sizeof cacheKey, getter_AddRefs(record));
+    NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+
+    randomStream->Skip(CACHE_METADATA_LENGTH);
+    PRUint32 initialStreamLength = randomStream->Next() & 0xffff;
+    delete randomStream;
+
+    PRUint32 i;
+    PRUint32 delta = initialStreamLength / 64;
+    for (i = initialStreamLength; i >= delta; i -= delta) {
+        PRUint32 expectedStreamLength = i;
+
+        // Do the truncation
+        record->SetStoredContentLength(expectedStreamLength);
+        randomStream = new RandomStream(0);
+        randomStream->Skip(CACHE_KEY_LENGTH + CACHE_METADATA_LENGTH + 1);
+
+        TestReadStream(record, randomStream, expectedStreamLength);
+        WaitForEvents();
+    }
+
+    return NS_OK;
+}
+
+// Write known data to random offsets in a single cache entry and test
+// resulting stream for correctness.
+nsresult
+TestOffsetWrites(nsINetDataCache *cache)
+{
+    nsresult rv;
+    nsCOMPtr<nsINetDataCacheRecord> record;
+    nsCOMPtr<nsIChannel> channel;
+    nsCOMPtr<nsIOutputStream> outStream;
+    char buf[512];
+    char cacheKey[CACHE_KEY_LENGTH];
+    RandomStream *randomStream;
+
+    randomStream = new RandomStream(0);
+    randomStream->Read(cacheKey, sizeof cacheKey);
+
+    rv = cache->GetCachedNetData(cacheKey, sizeof cacheKey, getter_AddRefs(record));
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't access record via opaque cache key");
+
+
+    nsCOMPtr<nsIFileSpec> file ;
+    record->GetFilename(getter_AddRefs(file)) ;
+    char* name ;
+    file->GetUnixStyleFilePath(&name) ;
+    printf(" file name is %s \n", name) ;
+
+    // Write buffer-fulls of data at random offsets into the cache entry.
+    // Data written is (offset % 0xff)
+    PRUint32 startingOffset;
+    PRUint32 streamLength = 0;
+    PRUint32 len = 0 ;
+    CounterStream *counterStream;
+
+    int i = 0;
+    for (i = 0; i < 257; i++) {
+        rv = record->NewChannel(0, getter_AddRefs(channel));
+        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+
+        startingOffset = streamLength ? streamLength - (randomStream->Next() % sizeof buf): 0;
+        rv = channel->OpenOutputStream(startingOffset, getter_AddRefs(outStream));
+        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+        
+        truncate(name, startingOffset) ;
+
+        counterStream = new CounterStream(startingOffset);
+        counterStream->Read(buf, sizeof buf);
+
+      nsresult status ;
+      nsCOMPtr<nsIRandomAccessStore> ras = do_QueryInterface(outStream, &status);
+      if (NS_FAILED(status)) {
+      //        mState = END_WRITE;
+        return NS_ERROR_FAILURE;
+      }
+      PRIntn offset ;
+      ras->Tell(&offset) ;
+//      printf(" offset is %d \n", offset) ;
+
+        PRUint32 numWritten;
+        rv = outStream->Write(buf, sizeof buf, &numWritten);
+        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+        NS_ASSERTION(numWritten == sizeof buf, "Write() bug?");
+        streamLength = startingOffset + sizeof buf;
+
+        rv = outStream->Close();
+        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't close channel");
+        delete counterStream;
+
+        record->GetStoredContentLength(&len) ;
+        if(len != streamLength) 
+          printf(" offset = %d is wrong, filesize = %d\n", startingOffset, len) ;
+
+    }
+
+        /*
+        rv = record->NewChannel(0, getter_AddRefs(channel));
+        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+
+        startingOffset = 208;
+        rv = channel->OpenOutputStream(startingOffset, getter_AddRefs(outStream));
+        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+        
+        counterStream = new CounterStream(startingOffset);
+        counterStream->Read(buf, sizeof buf);
+
+      nsresult status ;
+      nsCOMPtr<nsIRandomAccessStore> ras = do_QueryInterface(outStream, &status);
+      if (NS_FAILED(status)) {
+      //        mState = END_WRITE;
+        return NS_ERROR_FAILURE;
+      }
+      PRIntn offset = 0 ;
+      ras->Tell(&offset) ;
+      printf(" offset is %d \n", offset) ;
+
+        PRUint32 numWritten;
+        rv = outStream->Write(buf, sizeof buf, &numWritten);
+        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+        NS_ASSERTION(numWritten == sizeof buf, "Write() bug?");
+        streamLength = startingOffset + sizeof buf;
+
+        rv = outStream->Close();
+        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't close channel");
+        delete counterStream;
+
+        record->GetStoredContentLength(&len) ;
+        if(len != streamLength) 
+          printf(" offset = %d is wrong, filesize = %d\n", startingOffset, len) ;
+          */
+    
+    delete randomStream;
+
+    counterStream = new CounterStream(0);
+    TestReadStream(record, counterStream, streamLength);
+    WaitForEvents();
+
+    return NS_OK;
+}
+
+// Create entries in the network data cache, using random data for the
+// key, the meta-data and the stored content data.
+nsresult
+FillCache(nsINetDataCache *cache)
+{
+    nsresult rv;
+    PRBool inCache;
+    nsCOMPtr<nsINetDataCacheRecord> record;
+    nsCOMPtr<nsIChannel> channel;
+    nsCOMPtr<nsIOutputStream> outStream;
+    char buf[1000];
+    PRUint32 metaDataLength;
+    char cacheKey[CACHE_KEY_LENGTH];
+    char metaData[CACHE_METADATA_LENGTH];
+    PRUint32 testNum;
+    char *data;
+    RandomStream *randomStream;
+
+    PRIntervalTime startTime = PR_IntervalNow();
+    
+    for (testNum = 0; testNum < NUM_CACHE_ENTRIES; testNum++) {
+        randomStream = new RandomStream(testNum);
+        randomStream->Read(cacheKey, sizeof cacheKey);
+
+        // No entry should be in cache until we add it
+        rv = cache->Contains(cacheKey, sizeof cacheKey, &inCache);
+        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+        NS_ASSERTION(!inCache, "nsINetDataCache::Contains error");
+        
+        rv = cache->GetCachedNetData(cacheKey, sizeof cacheKey, getter_AddRefs(record));
+        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't access record via opaque cache key");
+
+        // Test nsINetDataCacheRecord::GetRecordID()
+        rv = record->GetRecordID(&recordID[testNum]);
+        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get Record ID");
+
+        // Test nsINetDataCache::GetNumEntries()
+        PRUint32 numEntries = (PRUint32)-1;
+        rv = cache->GetNumEntries(&numEntries);
+        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get number of cache entries");
+        NS_ASSERTION(numEntries == testNum + 1, "GetNumEntries failure");
+
+        // Record meta-data should be initially empty
+        rv = record->GetMetaData(&metaDataLength, &data);
+        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+        if ((metaDataLength != 0) || (data != 0))
+            return NS_ERROR_FAILURE;
+
+        // Store random data as meta-data
+        randomStream->Read(metaData, sizeof metaData);
+        record->SetMetaData(sizeof metaData, metaData);
+
+        rv = record->NewChannel(0, getter_AddRefs(channel));
+        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+
+        rv = channel->OpenOutputStream(0, getter_AddRefs(outStream));
+        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+        
+        PRUint32 beforeOccupancy;
+        rv = cache->GetStorageInUse(&beforeOccupancy);
+        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get cache occupancy");
+
+        int streamLength = randomStream->Next() & 0xffff;
+        int remaining = streamLength;
+        while (remaining) {
+            PRUint32 numWritten;
+            int amount = PR_MIN(sizeof buf, remaining);
+            randomStream->Read(buf, amount);
+
+            rv = outStream->Write(buf, amount, &numWritten);
+            NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+            NS_ASSERTION(numWritten == (PRUint32)amount, "Write() bug?");
+            
+            remaining -= amount;
+        }
+        outStream->Close();
+
+        PRUint32 afterOccupancy;
+        rv = cache->GetStorageInUse(&afterOccupancy);
+        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get cache occupancy");
+        PRUint32 streamLengthInKB = streamLength >> 10;
+        NS_ASSERTION((afterOccupancy - beforeOccupancy) >= streamLengthInKB,
+                     "nsINetDataCache::GetStorageInUse() is busted");
+        
+
+        // *Now* there should be an entry in the cache
+        rv = cache->Contains(cacheKey, sizeof cacheKey, &inCache);
+        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+        NS_ASSERTION(inCache, "nsINetDataCache::Contains error");
+
+        delete randomStream;
+    }
+
+    PRIntervalTime endTime = PR_IntervalNow();
+
+    return NS_OK;
+}
+
+nsresult NS_AutoregisterComponents()
+{
+  nsresult rv = nsComponentManager::AutoRegister(nsIComponentManager::NS_Startup,
+                                                 NULL /* default */);
+  return rv;
+}
+
+PRBool initPref ()
+{
+  nsresult rv;
+  NS_WITH_SERVICE(nsIPref, prefPtr, kPrefCID, &rv);
+  if (NS_FAILED(rv))
+    return false;
+
+  nsCOMPtr<nsIFileSpec> fileSpec;
+  rv = NS_NewFileSpec (getter_AddRefs(fileSpec));
+  if (NS_FAILED(rv))
+    return false;
+
+  nsCString defaultPrefFile = PR_GetEnv ("MOZILLA_FIVE_HOME");
+  if (defaultPrefFile.Length())
+    defaultPrefFile += "/";
+  else
+    defaultPrefFile = "./";
+  defaultPrefFile += "default_prefs.js";
+
+  fileSpec->SetUnixStyleFilePath (defaultPrefFile.GetBuffer());
+
+  PRBool exists = false;
+  fileSpec->Exists(&exists);
+  if (exists)
+    prefPtr->ReadUserPrefsFrom(fileSpec);
+  else
+    return false;
+  return true;
+}
+
+int
+main(int argc, char* argv[])
+{
+    initPref() ;
+    nsresult rv;
+    nsCOMPtr<nsINetDataCache> cache;
+
+    rv = NS_AutoregisterComponents();
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't register XPCOM components");
+
+    rv = nsComponentManager::CreateInstance(kDiskCacheCID, nsnull,
+                                            NS_GET_IID(nsINetDataCache),
+                                            getter_AddRefs(cache));
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't create memory cache factory");
+
+    InitQueue();
+
+    PRUnichar* description;
+    rv = cache->GetDescription(&description);
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get cache description");
+    nsCAutoString descStr(description);
+    printf("Testing: %s\n", descStr.GetBuffer());
+
+    rv = cache->RemoveAll();
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't clear cache");
+
+    PRUint32 startOccupancy;
+    rv = cache->GetStorageInUse(&startOccupancy);
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get cache occupancy");
+
+    PRUint32 numEntries = (PRUint32)-1;
+    rv = cache->GetNumEntries(&numEntries);
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get number of cache entries");
+    NS_ASSERTION(numEntries == 0, "Couldn't clear cache");
+
+    rv = FillCache(cache);
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't fill cache with random test data");
+
+    rv = TestRead(cache);
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't read random test data from cache");
+
+    rv = TestRecordID(cache);
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't index records using record ID");
+
+    rv = TestEnumeration(cache);
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't successfully enumerate records");
+
+    rv = TestTruncation(cache);
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't successfully truncate records");
+
+    rv = TestOffsetWrites(cache);
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't successfully write to records using non-zero offsets");
+
+    rv = cache->RemoveAll();
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't clear cache");
+    rv = cache->GetNumEntries(&numEntries);
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get number of cache entries");
+    NS_ASSERTION(numEntries == 0, "Couldn't clear cache");
+
+    PRUint32 endOccupancy;
+    rv = cache->GetStorageInUse(&endOccupancy);
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get cache occupancy");
+
+    NS_ASSERTION(startOccupancy == endOccupancy, "Cache occupancy not correctly computed ?");
+
+    return 0;
+}
+

mozilla/netwerk/cache/memcache/Makefile.in

@@ -0,0 +1,48 @@
+# Generated automatically from Makefile.in by configure.
+#
+# The contents of this file are subject to the Netscape Public License
+# Version 1.0 (the "NPL"); you may not use this file except in
+# compliance with the NPL.  You may obtain a copy of the NPL at
+# http://www.mozilla.org/NPL/
+#
+# Software distributed under the NPL is distributed on an "AS IS" basis,
+# WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+# for the specific language governing rights and limitations under the
+# NPL.
+#
+# The Initial Developer of this code under the NPL is Netscape
+# Communications Corporation.  Portions created by Netscape are
+# Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+# Reserved.
+#
+
+DEPTH		= ../../..
+topsrcdir	= @top_srcdir@
+VPATH       = @srcdir@
+srcdir		= @srcdir@
+
+include $(DEPTH)/config/autoconf.mk
+
+MODULE = nkcache
+
+LIBRARY_NAME = nkmemcache_s
+
+REQUIRES	= nspr dbm 
+
+EXPORTS=nsMemCacheCID.h \
+	nsMemCache.h \
+	$(NULL)
+
+CPPSRCS		= \
+        nsMemCache.cpp \
+        nsMemCacheRecord.cpp \
+        nsMemCacheChannel.cpp \
+		$(NULL)
+
+# we don't want the shared lib, but we want to force the creation of a
+# static lib.
+override NO_SHARED_LIB=1
+override NO_STATIC_LIB=
+
+include $(topsrcdir)/config/rules.mk
+

mozilla/netwerk/cache/memcache/makefile.win

@@ -0,0 +1,42 @@
+#!nmake
+#
+# The contents of this file are subject to the Netscape Public License
+# Version 1.0 (the "NPL"); you may not use this file except in
+# compliance with the NPL.  You may obtain a copy of the NPL at
+# http://www.mozilla.org/NPL/
+#
+# Software distributed under the NPL is distributed on an "AS IS" basis,
+# WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+# for the specific language governing rights and limitations under the
+# NPL.
+#
+# The Initial Developer of this code under the NPL is Netscape
+# Communications Corporation.  Portions created by Netscape are
+# Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+# Reserved.
+
+DEPTH=..\..\..
+
+include <$(DEPTH)/config/config.mak>
+
+MODULE = nkcache
+
+LIBRARY_NAME = nkmemcache_s
+
+CPP_OBJS =                                \
+ 	.\$(OBJDIR)\nsMemCache.obj        \
+	.\$(OBJDIR)\nsMemCacheRecord.obj  \
+	.\$(OBJDIR)\nsMemCacheChannel.obj \
+	$(NULL)
+
+EXPORTS=nsMemCacheCID.h
+
+include <$(DEPTH)\config\rules.mak>
+
+install:: $(LIBRARY)
+	$(MAKE_INSTALL) $(LIBRARY) $(DIST)\lib
+
+clobber::
+        rm -rf $(OBJDIR)
+        rm -f $(DIST)\lib\$(LIBRARY_NAME).lib
+

mozilla/netwerk/cache/memcache/nsMemCache.cpp

@@ -0,0 +1,334 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ * The contents of this file are subject to the Netscape 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/NPL/
+ *  
+ * 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 Netscape are
+ * Copyright (C) 1998-1999 Netscape Communications Corporation. All
+ * Rights Reserved.
+ *
+ */
+
+/**
+ * nsMemCache is the implementation of an in-memory network-data
+ * cache, used to cache the responses to network retrieval commands.
+ * Each cache entry may contain both content, e.g. GIF image data, and
+ * associated metadata, e.g. HTTP headers.  Each entry is indexed by
+ * two different keys: a record id number and an opaque key, which is
+ * created by the cache manager by combining the URI with a "secondary
+ * key", e.g. HTTP post data.
+ */
+
+#include "nsMemCache.h"
+#include "nsMemCacheRecord.h"
+#include "nsIGenericFactory.h"
+#include "nsString.h"
+#include "nsHashtable.h"
+#include "nsHashtableEnumerator.h"
+#include "nsEnumeratorUtils.h"
+
+PRInt32 nsMemCache::gRecordSerialNumber = 0;
+
+nsMemCache::nsMemCache()
+    : mNumEntries(0), mOccupancy(0), mEnabled(PR_TRUE),
+      mHashTable(0)
+{
+    NS_INIT_REFCNT();
+}
+
+nsMemCache::~nsMemCache()
+{
+    nsresult rv;
+
+    rv = RemoveAll();
+    NS_ASSERTION(NS_SUCCEEDED(rv) && (mNumEntries == 0),
+                 "Failure to shut down memory cache. "
+                 "Somewhere, someone is holding references to at least one cache record");
+    delete mHashTable;
+}
+
+nsresult
+nsMemCache::Init()
+{
+    mHashTable = new nsHashtable(256);
+    if (!mHashTable)
+        return NS_ERROR_OUT_OF_MEMORY;
+    return NS_OK;
+}
+
+NS_IMPL_ISUPPORTS(nsMemCache, NS_GET_IID(nsINetDataCache))
+
+NS_IMETHODIMP
+nsMemCache::GetDescription(PRUnichar * *aDescription)
+{
+    nsAutoString description("Memory Cache");
+    *aDescription = description.ToNewUnicode();
+    if (!*aDescription)
+        return NS_ERROR_OUT_OF_MEMORY;
+    return NS_OK;
+}
+
+NS_IMETHODIMP
+nsMemCache::Contains(const char *aKey, PRUint32 aKeyLength, PRBool *aFound)
+{
+    nsOpaqueKey *opaqueKey = new nsOpaqueKey(aKey, aKeyLength);
+    if (!opaqueKey)
+        return NS_ERROR_OUT_OF_MEMORY;
+    *aFound = mHashTable->Exists(opaqueKey);
+    delete opaqueKey;
+    return NS_OK;
+}
+
+NS_IMETHODIMP
+nsMemCache::GetCachedNetData(const char *aKey, PRUint32 aKeyLength,
+                             nsINetDataCacheRecord* *aRecord)
+{
+    nsresult rv;
+    nsMemCacheRecord* record = 0;
+    nsOpaqueKey *opaqueKey2 = 0;
+    nsOpaqueKey *opaqueKey3 = 0;
+    nsOpaqueKey *opaqueKey;
+
+    opaqueKey = new nsOpaqueKey(aKey, aKeyLength);
+    if (!opaqueKey)
+        goto out_of_memory;
+    record = (nsMemCacheRecord*)mHashTable->Get(opaqueKey);
+    delete opaqueKey;
+
+    // No existing cache database entry was found.  Create a new one.
+    // This requires two mappings in the hash table:
+    //    Record ID  ==> record
+    //    Opaque key ==> record
+    if (!record) {
+        record = new nsMemCacheRecord;
+        if (!record)
+            goto out_of_memory;
+        rv = record->Init(aKey, aKeyLength, ++gRecordSerialNumber, this);
+        if (NS_FAILED(rv)) goto out_of_memory;
+
+        // Index the record by opaque key
+        opaqueKey2 = new nsOpaqueKey(record->mKey, record->mKeyLength);
+        if (!opaqueKey2) goto out_of_memory;
+        mHashTable->Put(opaqueKey2, record);
+        
+        // Index the record by it's record ID
+        char *recordIDbytes = NS_REINTERPRET_CAST(char *, &record->mRecordID);
+        opaqueKey3 = new nsOpaqueKey(recordIDbytes,
+                                     sizeof record->mRecordID);
+        if (!opaqueKey3) {
+            // Clean up the first record from the hash table
+            mHashTable->Remove(opaqueKey);
+            goto out_of_memory;
+        }
+        mHashTable->Put(opaqueKey3, record);
+        
+        // The hash table holds on to the record
+        record->AddRef();
+        
+        delete opaqueKey2;
+        delete opaqueKey3;
+        mNumEntries++;
+    }
+
+    record->AddRef();
+    *aRecord = record;
+    return NS_OK;
+
+ out_of_memory:
+    delete opaqueKey2;
+    delete opaqueKey3;
+    delete record;
+    return NS_ERROR_OUT_OF_MEMORY;
+}
+
+NS_IMETHODIMP
+nsMemCache::GetCachedNetDataByID(PRInt32 RecordID,
+                                 nsINetDataCacheRecord* *aRecord)
+{
+    nsOpaqueKey opaqueKey(NS_REINTERPRET_CAST(const char *, &RecordID),
+                          sizeof RecordID);
+    *aRecord = (nsINetDataCacheRecord*)mHashTable->Get(&opaqueKey);
+    if (*aRecord) {
+        NS_ADDREF(*aRecord);
+        return NS_OK;
+    }
+    return NS_ERROR_FAILURE;
+}
+
+NS_METHOD
+nsMemCache::Delete(nsMemCacheRecord* aRecord)
+{
+    nsMemCacheRecord *removedRecord;
+
+    char *recordIDbytes = NS_REINTERPRET_CAST(char *, &aRecord->mRecordID);
+    nsOpaqueKey opaqueRecordIDKey(recordIDbytes,
+                                  sizeof aRecord->mRecordID);
+    removedRecord = (nsMemCacheRecord*)mHashTable->Remove(&opaqueRecordIDKey);
+    NS_ASSERTION(removedRecord == aRecord, "memory cache database inconsistent");
+
+    nsOpaqueKey opaqueKey(aRecord->mKey, aRecord->mKeyLength);
+    removedRecord = (nsMemCacheRecord*)mHashTable->Remove(&opaqueKey);
+    NS_ASSERTION(removedRecord == aRecord, "memory cache database inconsistent");
+
+    aRecord->Release();
+
+    mNumEntries--;
+    
+    return NS_OK;
+}
+    
+
+NS_IMETHODIMP
+nsMemCache::GetEnabled(PRBool *aEnabled)
+{
+    NS_ENSURE_ARG(aEnabled);
+    *aEnabled = mEnabled;
+    return NS_OK;
+}
+
+NS_IMETHODIMP
+nsMemCache::SetEnabled(PRBool aEnabled)
+{
+    mEnabled = aEnabled;
+    return NS_OK;
+}
+
+NS_IMETHODIMP
+nsMemCache::GetFlags(PRUint32 *aFlags)
+{
+    NS_ENSURE_ARG(aFlags);
+    *aFlags = MEMORY_CACHE;
+    return NS_OK;
+}
+
+NS_IMETHODIMP
+nsMemCache::GetNumEntries(PRUint32 *aNumEntries)
+{
+    NS_ENSURE_ARG(aNumEntries);
+    *aNumEntries = mNumEntries;
+    return NS_OK;
+}
+
+NS_IMETHODIMP
+nsMemCache::GetMaxEntries(PRUint32 *aMaxEntries)
+{
+    NS_ENSURE_ARG(aMaxEntries);
+    *aMaxEntries = MEM_CACHE_MAX_ENTRIES;
+    return NS_OK;
+}
+
+static NS_METHOD
+HashEntryConverter(nsHashKey *aKey, void *aValue,
+                   void *unused, nsISupports **retval)
+{
+    nsMemCacheRecord *record;
+    nsOpaqueKey *opaqueKey;
+
+    record = (nsMemCacheRecord*)aValue;
+    opaqueKey = (nsOpaqueKey*)aKey;
+
+    // Hash table keys that index cache entries by their record ID
+    // shouldn't be enumerated.
+    if ((opaqueKey->GetKeyLength() == sizeof(PRInt32))) {
+
+#ifdef DEBUG
+        PRInt32 recordID;
+        record->GetRecordID(&recordID);
+        NS_ASSERTION(*((PRInt32*)opaqueKey->GetKey()) == recordID,
+                     "Key has incorrect key length");
+#endif
+        return NS_ERROR_FAILURE;
+    }
+
+    NS_IF_ADDREF(record);
+    *retval = NS_STATIC_CAST(nsISupports*, record);
+    return NS_OK;
+}
+
+NS_IMETHODIMP
+nsMemCache::NewCacheEntryIterator(nsISimpleEnumerator* *aIterator)
+{
+    nsCOMPtr<nsIEnumerator> iterator;
+
+    NS_ENSURE_ARG(aIterator);
+    NS_NewHashtableEnumerator(mHashTable, HashEntryConverter,
+                              mHashTable, getter_AddRefs(iterator));
+    return NS_NewAdapterEnumerator(aIterator, iterator);
+}
+
+NS_IMETHODIMP
+nsMemCache::GetNextCache(nsINetDataCache* *aNextCache)
+{
+    NS_ENSURE_ARG(aNextCache);
+    *aNextCache = mNextCache;
+    NS_ADDREF(*aNextCache);
+    return NS_OK;
+}
+
+NS_IMETHODIMP
+nsMemCache::SetNextCache(nsINetDataCache* aNextCache)
+{
+    mNextCache = aNextCache;
+    return NS_OK;
+}
+
+NS_IMETHODIMP
+nsMemCache::GetStorageInUse(PRUint32 *aStorageInUse)
+{
+    NS_ENSURE_ARG(aStorageInUse);
+
+    // Convert from bytes to KB
+    *aStorageInUse = (mOccupancy >> 10);
+    return NS_OK;
+}
+
+NS_IMETHODIMP
+nsMemCache::RemoveAll(void)
+{
+    PRBool failed;
+
+    nsCOMPtr<nsISimpleEnumerator> iterator;
+    nsCOMPtr<nsISupports> recordSupports;
+    nsCOMPtr<nsINetDataCacheRecord> record;
+    nsresult rv;
+
+    failed = PR_FALSE;
+    rv = NewCacheEntryIterator(getter_AddRefs(iterator));
+    if (NS_FAILED(rv))
+        return rv;
+
+    PRBool notDone;
+    while (1) {
+        rv = iterator->HasMoreElements(&notDone);
+        if (NS_FAILED(rv)) return rv;
+        if (!notDone)
+            break;
+        
+        iterator->GetNext(getter_AddRefs(recordSupports));
+        record = do_QueryInterface(recordSupports);
+        recordSupports = 0;
+
+        PRUint32 bytesUsed;
+        record->GetStoredContentLength(&bytesUsed);
+        rv = record->Delete();
+        if (NS_FAILED(rv)) {
+            failed = PR_TRUE;
+            continue;
+        }
+        mOccupancy -= bytesUsed;
+    }
+
+    if (failed)
+        return NS_ERROR_FAILURE;
+    return NS_OK;
+}

mozilla/netwerk/cache/memcache/nsMemCache.h

@@ -0,0 +1,83 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ * The contents of this file are subject to the Netscape 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/NPL/
+ *  
+ * 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 Netscape are
+ * Copyright (C) 1998-1999 Netscape Communications Corporation. All
+ * Rights Reserved.
+ *
+ */
+
+/**
+ * nsMemCache is the implementation of an in-memory network-data
+ * cache, used to cache the responses to network retrieval commands.
+ * Each cache entry may contain both content, e.g. GIF image data, and
+ * associated metadata, e.g. HTTP headers.  Each entry is indexed by
+ * two different keys: a record id number and an opaque key, which is
+ * created by the cache manager by combining the URI with a "secondary
+ * key", e.g. HTTP post data.
+ */
+
+#ifndef _nsMemCache_h_
+#define _nsMemCache_h_
+
+#include "nsINetDataCache.h"
+
+// Maximum number of URIs that may be resident in the cache
+#define MEM_CACHE_MAX_ENTRIES 1000
+
+#define MEM_CACHE_SEGMENT_SIZE       (1 << 12)
+#define MEM_CACHE_MAX_ENTRY_SIZE     (1 << 20)
+
+class nsHashtable;
+class nsMemCacheRecord;
+
+class nsMemCache : public nsINetDataCache
+{
+public:
+    nsMemCache();
+    virtual ~nsMemCache();
+    nsresult Init();
+
+    // nsISupports methods
+    NS_DECL_ISUPPORTS
+
+    // nsINetDataCache methods
+    NS_DECL_NSINETDATACACHE
+
+    // Factory
+    static NS_METHOD nsMemCacheConstructor(nsISupports *aOuter, REFNSIID aIID,
+                                           void **aResult);
+
+protected:
+
+    PRUint32         mNumEntries;
+    PRUint32         mOccupancy;   // Memory used, in bytes
+    PRBool           mEnabled;     // If false, bypass mem cache
+
+    nsINetDataCache* mNextCache;
+
+    // Mapping from either opaque key or record ID to nsMemCacheRecord
+    nsHashtable*     mHashTable;
+
+    // Used to assign record ID's
+    static PRInt32   gRecordSerialNumber;
+
+    NS_METHOD Delete(nsMemCacheRecord* aRecord);
+
+    friend class nsMemCacheRecord;
+    friend class nsMemCacheChannel;
+};
+
+#endif // _nsMemCache_h_

mozilla/netwerk/cache/memcache/nsMemCacheCID.h

@@ -0,0 +1,36 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ * The contents of this file are subject to the Netscape 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/NPL/
+ *  
+ * 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 Netscape are
+ * Copyright (C) 1998-1999 Netscape Communications Corporation. All
+ * Rights Reserved.
+ *
+ */
+
+//  XPCOM Class ID for the network data in-memory cache
+
+#ifndef nsMEMCACHECID_h__
+#define nsMEMCACHECID_h__
+
+// {e4710560-7de2-11d3-90cb-0040056a906e}
+#define NS_MEM_CACHE_FACTORY_CID                          \
+    {                                                     \
+        0xe4710560,                                       \
+	    0x7de2,                                           \
+        0x11d3,                                           \
+	    {0x90, 0xcb, 0x00, 0x40, 0x05, 0x6a, 0x90, 0x6e}  \
+    }
+
+#endif // nsMEMCACHECID_h__

mozilla/netwerk/cache/memcache/nsMemCacheChannel.cpp

@@ -0,0 +1,462 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ * The contents of this file are subject to the Netscape 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/NPL/
+ *  
+ * 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 Netscape are
+ * Copyright (C) 1998-1999 Netscape Communications Corporation. All
+ * Rights Reserved.
+ *
+ */
+
+#include "nsMemCache.h"
+#include "nsMemCacheChannel.h"
+#include "nsIStreamListener.h"
+#include "nsIChannel.h"
+#include "nsIStorageStream.h"
+#include "nsIOutputStream.h"
+#include "nsIServiceManager.h"
+#include "nsIEventQueueService.h"
+#include "nsNetUtil.h"
+#include "nsILoadGroup.h"
+
+static NS_DEFINE_CID(kIOServiceCID, NS_IOSERVICE_CID);
+static NS_DEFINE_CID(kEventQueueService, NS_EVENTQUEUESERVICE_CID);
+
+NS_IMPL_ISUPPORTS(nsMemCacheChannel, NS_GET_IID(nsIChannel))
+
+void
+nsMemCacheChannel::NotifyStorageInUse(PRInt32 aBytesUsed)
+{
+    mRecord->mCache->mOccupancy += aBytesUsed;
+}
+
+/**
+ * This class acts as an adaptor around a synchronous input stream to add async
+ * read capabilities.  It adds methods for initiating, suspending, resuming and
+ * cancelling async reads. 
+ */
+class AsyncReadStreamAdaptor : public nsIInputStream {
+public:
+    AsyncReadStreamAdaptor(nsMemCacheChannel* aChannel, nsIInputStream *aSyncStream):
+        mSyncStream(aSyncStream), mDataAvailCursor(0),
+        mRemaining(0), mAvailable(0), mChannel(aChannel), mAborted(PR_FALSE), mSuspended(PR_FALSE)
+        {
+            NS_INIT_REFCNT();
+            NS_ADDREF(mChannel);
+        }
+
+    virtual ~AsyncReadStreamAdaptor() { 
+        mChannel->mAsyncReadStream = 0;
+        NS_RELEASE(mChannel);
+    }
+    
+    NS_DECL_ISUPPORTS
+
+    nsresult
+    IsPending(PRBool* aIsPending) {
+        *aIsPending = (mRemaining != 0) && !mAborted;
+        return NS_OK;
+    }
+
+    nsresult
+    Cancel(void) {
+        mAborted = PR_TRUE;
+        return mStreamListener->OnStopRequest(mChannel, mContext, NS_BINDING_ABORTED, nsnull);
+    }
+
+    nsresult
+    Suspend(void) { mSuspended = PR_TRUE; return NS_OK; }
+
+    nsresult
+    Resume(void) {
+        if (!mSuspended)
+            return NS_ERROR_FAILURE;
+        mSuspended = PR_FALSE;
+        return NextListenerEvent();
+    }
+
+    NS_IMETHOD
+    Available(PRUint32 *aNumBytes) { return mAvailable; }
+
+    NS_IMETHOD
+    Read(char* aBuf, PRUint32 aCount, PRUint32 *aBytesRead) {
+        if (mAborted)
+            return NS_ERROR_ABORT;
+
+        *aBytesRead = 0;
+        aCount = PR_MIN(aCount, mAvailable);
+        nsresult rv = mSyncStream->Read(aBuf, aCount, aBytesRead);
+        mAvailable -= *aBytesRead;
+
+        if (NS_FAILED(rv) && (rv != NS_BASE_STREAM_WOULD_BLOCK)) {
+            Fail();
+            return rv;
+        }
+
+        if (!mSuspended && !mAvailable) {
+            rv = NextListenerEvent();
+            if (NS_FAILED(rv)) {
+                Fail();
+                return rv;
+            }
+        }
+
+        return NS_OK;
+    }
+
+    NS_IMETHOD
+    Close() {
+        nsresult rv = mSyncStream->Close();
+        mSyncStream = 0;
+        mContext = 0;
+        mStreamListener = 0;
+        return rv;
+    }
+
+    nsresult
+    AsyncRead(PRUint32 aStartPosition, PRInt32 aReadCount,
+              nsISupports* aContext, nsIStreamListener* aListener) {
+
+        nsresult rv;
+        nsIEventQueue *eventQ;
+
+        mContext = aContext;
+        mStreamListener = aListener;
+        mRemaining = aReadCount;
+
+        NS_WITH_SERVICE(nsIIOService, serv, kIOServiceCID, &rv);
+        if (NS_FAILED(rv)) return rv;
+
+        NS_WITH_SERVICE(nsIEventQueueService, eventQService, kEventQueueService, &rv);
+        if (NS_FAILED(rv)) return rv;
+
+        rv = eventQService->GetThreadEventQueue(PR_CurrentThread(), &eventQ);
+        if (NS_FAILED(rv)) return rv;
+
+        rv = NS_NewAsyncStreamListener(aListener, eventQ, 
+                                       getter_AddRefs(mStreamListener));
+        NS_RELEASE(eventQ);
+        if (NS_FAILED(rv)) return rv;
+
+        rv = mStreamListener->OnStartRequest(mChannel, aContext);
+        if (NS_FAILED(rv)) return rv;
+
+        return NextListenerEvent();
+    }
+
+protected:
+
+    nsresult
+    Fail(void) {
+        mAborted = PR_TRUE;
+        return mStreamListener->OnStopRequest(mChannel, mContext, NS_BINDING_FAILED, nsnull);
+    }
+
+    nsresult
+    NextListenerEvent() {
+        PRUint32 available;
+        nsresult rv = mSyncStream->Available(&available);
+        if (NS_FAILED(rv)) return rv;
+        available -= mAvailable;
+        available = PR_MIN(available, mRemaining);
+
+        if (available) {
+            PRUint32 size = PR_MIN(available, MEM_CACHE_SEGMENT_SIZE);
+            rv = mStreamListener->OnDataAvailable(mChannel, mContext, this,
+                                                  mDataAvailCursor, size);
+            mDataAvailCursor += size;
+            mRemaining -= size;
+            mAvailable += size;
+            return rv;
+        } else {
+            rv = mStreamListener->OnStopRequest(mChannel, mContext, NS_OK, nsnull);
+            AsyncReadStreamAdaptor* thisAlias = this;
+            NS_RELEASE(thisAlias);
+            return rv;
+        }
+    }
+    
+private:
+    nsCOMPtr<nsISupports>       mContext;        // Opaque context passed to AsyncRead()
+    nsCOMPtr<nsIStreamListener> mStreamListener; // Stream listener that has been proxied
+    nsCOMPtr<nsIInputStream>    mSyncStream;     // Underlying synchronous stream that is
+                                                 //   being converted to an async stream
+    PRUint32                    mDataAvailCursor;
+    PRUint32                    mRemaining;      // Size of AsyncRead request less bytes for
+                                                 //   consumer OnDataAvailable's that were fired
+    PRUint32                    mAvailable;      // Number of bytes for which OnDataAvailable fired
+    nsMemCacheChannel*          mChannel;        // Associated memory cache channel, strong link
+                                                 //   but can not use nsCOMPtr
+    PRBool                      mAborted;        // Abort() has been called
+    PRBool                      mSuspended;      // Suspend() has been called
+};
+
+NS_IMPL_ISUPPORTS(AsyncReadStreamAdaptor,  NS_GET_IID(nsIInputStream))
+
+// The only purpose of this output stream wrapper is to adjust the cache's
+// overall occupancy as new data flows into the cache entry.
+class MemCacheWriteStreamWrapper : public nsIOutputStream {
+public:
+    MemCacheWriteStreamWrapper(nsMemCacheChannel* aChannel, nsIOutputStream *aBaseStream):
+        mBaseStream(aBaseStream), mChannel(aChannel)
+        {
+            NS_INIT_REFCNT();
+            NS_ADDREF(mChannel);
+        }
+
+    virtual ~MemCacheWriteStreamWrapper() { NS_RELEASE(mChannel); };
+    
+    static nsresult
+    Create(nsMemCacheChannel* aChannel, nsIOutputStream *aBaseStream, nsIOutputStream* *aWrapper) {
+        MemCacheWriteStreamWrapper *wrapper =
+            new MemCacheWriteStreamWrapper(aChannel, aBaseStream);
+        if (!wrapper) return NS_ERROR_OUT_OF_MEMORY;
+        NS_ADDREF(wrapper);
+        *aWrapper = wrapper;
+        return NS_OK;
+    }
+    
+    NS_DECL_ISUPPORTS
+
+    NS_IMETHOD
+    Write(const char *aBuffer, PRUint32 aCount, PRUint32 *aNumWritten) {
+        *aNumWritten = 0;
+        nsresult rv = mBaseStream->Write(aBuffer, aCount, aNumWritten);
+        mChannel->NotifyStorageInUse(*aNumWritten);
+        return rv;
+    }
+
+    NS_IMETHOD
+    Flush() { return mBaseStream->Flush(); }
+
+    NS_IMETHOD
+    Close() { return mBaseStream->Close(); }
+
+private:
+    nsCOMPtr<nsIOutputStream>   mBaseStream;
+    nsMemCacheChannel*          mChannel;
+};
+
+NS_IMPL_ISUPPORTS(MemCacheWriteStreamWrapper,  NS_GET_IID(nsIOutputStream))
+
+nsMemCacheChannel::nsMemCacheChannel(nsMemCacheRecord *aRecord, nsILoadGroup *aLoadGroup)
+    : mRecord(aRecord)
+{
+    NS_INIT_REFCNT();
+    mRecord->mNumChannels++;
+}
+
+nsMemCacheChannel::~nsMemCacheChannel()
+{
+    mRecord->mNumChannels--;
+}
+
+NS_IMETHODIMP
+nsMemCacheChannel::IsPending(PRBool* aIsPending)
+{
+    *aIsPending = PR_FALSE;
+    if (!mAsyncReadStream)
+        return NS_OK;
+    return mAsyncReadStream->IsPending(aIsPending);
+}
+
+NS_IMETHODIMP
+nsMemCacheChannel::Cancel(void)
+{
+    if (!mAsyncReadStream)
+        return NS_ERROR_FAILURE;
+    return mAsyncReadStream->Cancel();
+}
+
+NS_IMETHODIMP
+nsMemCacheChannel::Suspend(void)
+{
+    if (!mAsyncReadStream)
+        return NS_ERROR_FAILURE;
+    return mAsyncReadStream->Suspend();
+}
+
+NS_IMETHODIMP
+nsMemCacheChannel::Resume(void)
+{
+    if (!mAsyncReadStream)
+        return NS_ERROR_FAILURE;
+    return mAsyncReadStream->Resume();
+}
+
+NS_IMETHODIMP
+nsMemCacheChannel::GetOriginalURI(nsIURI * *aURI)
+{
+    // Not required
+    return NS_ERROR_NOT_IMPLEMENTED;
+}
+
+NS_IMETHODIMP
+nsMemCacheChannel::GetURI(nsIURI * *aURI)
+{
+    // Not required to be implemented, since it is implemented by cache manager
+    NS_ASSERTION(0, "nsMemCacheChannel method unexpectedly called");
+    return NS_ERROR_NOT_IMPLEMENTED;
+}
+
+NS_IMETHODIMP
+nsMemCacheChannel::OpenInputStream(PRUint32 aStartPosition, PRInt32 aReadCount,
+                                   nsIInputStream* *aResult)
+{
+    nsresult rv;
+    NS_ENSURE_ARG(aResult);
+    if (mInputStream)
+        return NS_ERROR_NOT_AVAILABLE;
+
+    rv = mRecord->mStorageStream->NewInputStream(aStartPosition, getter_AddRefs(mInputStream));
+    *aResult = mInputStream;
+    NS_ADDREF(*aResult);
+    return rv;
+}
+
+NS_IMETHODIMP
+nsMemCacheChannel::OpenOutputStream(PRUint32 startPosition, nsIOutputStream* *aResult)
+{
+    nsresult rv;
+    NS_ENSURE_ARG(aResult);
+
+    nsCOMPtr<nsIOutputStream> outputStream;
+
+    PRUint32 oldLength;
+    mRecord->mStorageStream->GetLength(&oldLength);
+    rv = mRecord->mStorageStream->GetOutputStream(startPosition, getter_AddRefs(outputStream));
+    if (NS_FAILED(rv)) return rv;
+    if (startPosition < oldLength)
+        NotifyStorageInUse(startPosition - oldLength);
+
+    return MemCacheWriteStreamWrapper::Create(this, outputStream, aResult);
+}
+
+NS_IMETHODIMP
+nsMemCacheChannel::AsyncOpen(nsIStreamObserver *observer, nsISupports *ctxt)
+{
+    // Not required
+    return NS_ERROR_NOT_IMPLEMENTED;
+}
+
+NS_IMETHODIMP
+nsMemCacheChannel::AsyncRead(PRUint32 aStartPosition, PRInt32 aReadCount,
+                             nsISupports *aContext, nsIStreamListener *aListener)
+{
+    nsCOMPtr<nsIInputStream> inputStream;
+    nsresult rv = OpenInputStream(aStartPosition, aReadCount, getter_AddRefs(inputStream));
+    if (NS_FAILED(rv)) return rv;
+    
+    AsyncReadStreamAdaptor *asyncReadStreamAdaptor;
+    asyncReadStreamAdaptor = new AsyncReadStreamAdaptor(this, inputStream);
+    if (!asyncReadStreamAdaptor)
+        return NS_ERROR_OUT_OF_MEMORY;
+    NS_ADDREF(asyncReadStreamAdaptor);
+    mAsyncReadStream = asyncReadStreamAdaptor;
+
+    rv = asyncReadStreamAdaptor->AsyncRead(aStartPosition, aReadCount, aContext, aListener);
+    if (NS_FAILED(rv))
+        delete asyncReadStreamAdaptor;
+    return rv;
+}
+
+NS_IMETHODIMP
+nsMemCacheChannel::AsyncWrite(nsIInputStream *fromStream, PRUint32 startPosition,
+                              PRInt32 writeCount, nsISupports *ctxt,
+                              nsIStreamObserver *observer)
+{
+    // Not required to be implemented
+    NS_ASSERTION(0, "nsMemCacheChannel method unexpectedly called");
+    return NS_ERROR_NOT_IMPLEMENTED;
+}
+
+NS_IMETHODIMP
+nsMemCacheChannel::GetLoadAttributes(nsLoadFlags *aLoadAttributes)
+{
+    // Not required to be implemented, since it is implemented by cache manager
+    NS_ASSERTION(0, "nsMemCacheChannel method unexpectedly called");
+    return NS_ERROR_NOT_IMPLEMENTED;
+}
+
+NS_IMETHODIMP
+nsMemCacheChannel::SetLoadAttributes(nsLoadFlags aLoadAttributes)
+{
+    // Not required to be implemented, since it is implemented by cache manager
+    NS_ASSERTION(0, "nsMemCacheChannel method unexpectedly called");
+    return NS_ERROR_NOT_IMPLEMENTED;
+}
+
+NS_IMETHODIMP
+nsMemCacheChannel::GetContentType(char* *aContentType)
+{
+    // Not required to be implemented, since it is implemented by cache manager
+    NS_ASSERTION(0, "nsMemCacheChannel method unexpectedly called");
+    return NS_ERROR_NOT_IMPLEMENTED;
+}
+
+NS_IMETHODIMP
+nsMemCacheChannel::GetContentLength(PRInt32 *aContentLength)
+{
+    // Not required to be implemented, since it is implemented by cache manager
+    NS_ASSERTION(0, "nsMemCacheChannel method unexpectedly called");
+    return NS_ERROR_NOT_IMPLEMENTED;
+}
+
+NS_IMETHODIMP
+nsMemCacheChannel::GetOwner(nsISupports* *aOwner)
+{
+    *aOwner = mOwner.get();
+    NS_IF_ADDREF(*aOwner);
+    return NS_OK;
+}
+
+NS_IMETHODIMP
+nsMemCacheChannel::SetOwner(nsISupports* aOwner)
+{
+    // Not required to be implemented, since it is implemented by cache manager
+    mOwner = aOwner;
+    return NS_OK;
+}
+
+NS_IMETHODIMP
+nsMemCacheChannel::GetLoadGroup(nsILoadGroup* *aLoadGroup)
+{
+    // Not required to be implemented, since it is implemented by cache manager
+    NS_ASSERTION(0, "nsMemCacheChannel method unexpectedly called");
+    return NS_ERROR_NOT_IMPLEMENTED;
+}
+
+NS_IMETHODIMP
+nsMemCacheChannel::SetLoadGroup(nsILoadGroup* aLoadGroup)
+{
+    // Not required to be implemented, since it is implemented by cache manager
+    NS_ASSERTION(0, "nsMemCacheChannel method unexpectedly called");
+    return NS_ERROR_NOT_IMPLEMENTED;
+}
+
+NS_IMETHODIMP
+nsMemCacheChannel::GetNotificationCallbacks(nsIInterfaceRequestor* *aNotificationCallbacks)
+{
+    // Not required to be implemented, since it is implemented by cache manager
+    NS_ASSERTION(0, "nsMemCacheChannel method unexpectedly called");
+    return NS_ERROR_NOT_IMPLEMENTED;
+}
+
+NS_IMETHODIMP
+nsMemCacheChannel::SetNotificationCallbacks(nsIInterfaceRequestor* aNotificationCallbacks)
+{
+    // Not required to be implemented, since it is implemented by cache manager
+    NS_ASSERTION(0, "nsMemCacheChannel method unexpectedly called");
+    return NS_ERROR_NOT_IMPLEMENTED;
+}

mozilla/netwerk/cache/memcache/nsMemCacheChannel.h

@@ -0,0 +1,61 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ * The contents of this file are subject to the Netscape 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/NPL/
+ *  
+ * 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 Netscape are
+ * Copyright (C) 1998-1999 Netscape Communications Corporation. All
+ * Rights Reserved.
+ *
+ */
+
+#ifndef _nsMemCacheChannel_h_
+#define _nsMemCacheChannel_h_
+
+#include "nsMemCacheRecord.h"
+#include "nsIChannel.h"
+#include "nsIInputStream.h"
+#include "nsCOMPtr.h"
+
+
+class AsyncReadStreamAdaptor;
+
+class nsMemCacheChannel : public nsIChannel
+{
+public:
+    // Constructors and Destructor
+    nsMemCacheChannel(nsMemCacheRecord *aRecord, nsILoadGroup *aLoadGroup);
+    virtual ~nsMemCacheChannel();
+
+    // Declare nsISupports methods
+    NS_DECL_ISUPPORTS
+
+    // Declare nsIRequest methods
+    NS_DECL_NSIREQUEST
+
+    // Declare nsIChannel methods
+    NS_DECL_NSICHANNEL
+
+protected:
+    void NotifyStorageInUse(PRInt32 aBytesUsed);
+
+    nsCOMPtr<nsMemCacheRecord>   mRecord;
+    nsCOMPtr<nsIInputStream>     mInputStream;
+    nsCOMPtr<nsISupports>        mOwner;
+    AsyncReadStreamAdaptor*      mAsyncReadStream; // non-owning pointer
+
+    friend class MemCacheWriteStreamWrapper;
+    friend class AsyncReadStreamAdaptor;
+};
+
+#endif // _nsMemCacheChannel_h_

mozilla/netwerk/cache/memcache/nsMemCacheRecord.cpp

@@ -0,0 +1,164 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ * The contents of this file are subject to the Netscape 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/NPL/
+ *  
+ * 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 Netscape are
+ * Copyright (C) 1998-1999 Netscape Communications Corporation. All
+ * Rights Reserved.
+ *
+ */
+
+#include "nsMemCache.h"
+#include "nsMemCacheRecord.h"
+#include "nsMemCacheChannel.h"
+#include "nsIAllocator.h"
+#include "nsStorageStream.h"
+
+static NS_DEFINE_IID(kINetDataCacheRecord, NS_INETDATACACHERECORD_IID);
+
+nsMemCacheRecord::nsMemCacheRecord()
+    : mKey(0), mKeyLength(0), mMetaData(0), mMetaDataLength(0), mNumChannels(0)
+{
+    NS_INIT_REFCNT();
+}
+
+nsMemCacheRecord::~nsMemCacheRecord()
+{
+    if (mMetaData)
+        delete[] mMetaData;
+    if (mKey)
+        delete[] mKey;
+}	
+     
+NS_IMPL_ISUPPORTS(nsMemCacheRecord, NS_GET_IID(nsINetDataCacheRecord))
+
+NS_IMETHODIMP
+nsMemCacheRecord::GetKey(PRUint32 *aLength, char **aResult)
+{
+    NS_ENSURE_ARG(aResult);
+    *aResult = (char *)nsAllocator::Alloc(mKeyLength);
+    if (!*aResult)
+        return NS_ERROR_OUT_OF_MEMORY;
+    memcpy(*aResult, mKey, mKeyLength);
+    *aLength = mKeyLength;
+    return NS_OK;
+}
+
+nsresult
+nsMemCacheRecord::Init(const char *aKey, PRUint32 aKeyLength,
+                       PRUint32 aRecordID, nsMemCache *aCache)
+{
+    nsresult rv;
+
+    NS_ASSERTION(!mKey, "Memory cache record key set multiple times");
+
+    rv = NS_NewStorageStream(MEM_CACHE_SEGMENT_SIZE, MEM_CACHE_MAX_ENTRY_SIZE,
+                             getter_AddRefs(mStorageStream));
+    if (NS_FAILED(rv)) return rv;
+
+    mKey = new char[aKeyLength];
+    if (!mKey)
+        return NS_ERROR_OUT_OF_MEMORY;
+    memcpy(mKey, aKey, aKeyLength);
+    mKeyLength = aKeyLength;
+    mRecordID = aRecordID;
+    mCache = aCache;
+    return NS_OK;
+}
+
+NS_IMETHODIMP
+nsMemCacheRecord::GetRecordID(PRInt32 *aRecordID)
+{
+    NS_ENSURE_ARG(aRecordID);
+    *aRecordID = mRecordID;
+    return NS_OK;
+}
+
+NS_IMETHODIMP
+nsMemCacheRecord::GetMetaData(PRUint32 *aLength, char **aResult)
+{
+    NS_ENSURE_ARG(aResult);
+
+    *aResult = 0;
+    if (mMetaDataLength) {
+        *aResult = (char*)nsAllocator::Alloc(mMetaDataLength);
+        if (!*aResult)
+            return NS_ERROR_OUT_OF_MEMORY;
+        memcpy(*aResult, mMetaData, mMetaDataLength);
+    }
+    *aLength = mMetaDataLength;
+    return NS_OK;
+}
+
+NS_IMETHODIMP
+nsMemCacheRecord::SetMetaData(PRUint32 aLength, const char *aData)
+{
+    if (mMetaData)
+        delete[] mMetaData;
+    mMetaData = new char[aLength];
+    if (!mMetaData)
+        return NS_ERROR_OUT_OF_MEMORY;
+    memcpy(mMetaData, aData, aLength);
+    mMetaDataLength = aLength;
+    return NS_OK;
+}
+
+NS_IMETHODIMP
+nsMemCacheRecord::GetStoredContentLength(PRUint32 *aStoredContentLength)
+{
+    NS_ENSURE_ARG(aStoredContentLength);
+    return mStorageStream->GetLength(aStoredContentLength);
+}
+
+NS_IMETHODIMP
+nsMemCacheRecord::SetStoredContentLength(PRUint32 aStoredContentLength)
+{
+    PRUint32 before, after;
+    mStorageStream->GetLength(&before);
+    nsresult rv = mStorageStream->SetLength(aStoredContentLength);
+    if (NS_FAILED(rv)) return rv;
+    mStorageStream->GetLength(&after);
+    mCache->mOccupancy -= (before - after);
+    return NS_OK;
+}
+
+NS_IMETHODIMP
+nsMemCacheRecord::Delete(void)
+{
+    if (mNumChannels)
+        return NS_ERROR_NOT_AVAILABLE;
+  
+    return mCache->Delete(this);
+}
+
+NS_IMETHODIMP
+nsMemCacheRecord::GetFilename(nsIFileSpec* *aFilename)
+{
+    return NS_ERROR_NOT_IMPLEMENTED;
+}
+
+NS_IMETHODIMP
+nsMemCacheRecord::NewChannel(nsILoadGroup *aLoadGroup, nsIChannel* *aResult)
+{
+    NS_ENSURE_ARG(aResult);
+
+    nsMemCacheChannel* channel = new nsMemCacheChannel(this, aLoadGroup);
+    if (!channel)
+        return NS_ERROR_OUT_OF_MEMORY;
+
+    NS_ADDREF(channel);
+    *aResult = NS_STATIC_CAST(nsIChannel*, channel);
+    return NS_OK;
+
+}

mozilla/netwerk/cache/memcache/nsMemCacheRecord.h

@@ -0,0 +1,65 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ * The contents of this file are subject to the Netscape 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/NPL/
+ *  
+ * 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 Netscape are
+ * Copyright (C) 1998-1999 Netscape Communications Corporation. All
+ * Rights Reserved.
+ *
+ */
+
+#ifndef _nsMemCacheRecord_h_
+#define _nsMemCacheRecord_h_
+
+#include "nsINetDataCacheRecord.h"
+#include "nsIStorageStream.h"
+#include "nsCOMPtr.h"
+
+class nsMemCache;
+
+class nsMemCacheRecord : public nsINetDataCacheRecord
+{
+
+public:
+    // Declare interface methods
+    NS_DECL_ISUPPORTS
+    NS_DECL_NSINETDATACACHERECORD
+
+protected:
+    // Constructors and Destructor
+    nsMemCacheRecord();
+    virtual ~nsMemCacheRecord();
+
+    nsresult Init(const char *aKey, PRUint32 aKeyLength,
+                  PRUint32 aRecordID, nsMemCache *aCache);
+
+    char*       mKey;              // opaque database key for this record
+    PRUint32    mKeyLength;        // length, in bytes, of mKey
+
+    PRInt32     mRecordID;         // An alternate key for this record
+
+    char*       mMetaData;         // opaque URI metadata
+    PRUint32    mMetaDataLength;   // length, in bytes, of mMetaData
+
+    nsMemCache* mCache;            // weak pointer to the cache database
+                                   //  that this record inhabits
+
+    nsCOMPtr<nsIStorageStream> mStorageStream;
+    PRUint32    mNumChannels;      // Count un-Release'ed nsIChannels
+
+    friend class nsMemCache;
+    friend class nsMemCacheChannel;
+};
+
+#endif // _nsMemCacheRecord_h_

mozilla/netwerk/cache/mgr/Makefile.in

@@ -0,0 +1,55 @@
+#
+# The contents of this file are subject to the Netscape 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/NPL/
+#
+# 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.org code.
+#
+# The Initial Developer of the Original Code is Netscape
+# Communications Corporation.  Portions created by Netscape are
+# Copyright (C) 1998 Netscape Communications Corporation. All
+# Rights Reserved.
+#
+# Contributor(s): 
+#
+
+DEPTH		= ../../..
+topsrcdir	= @top_srcdir@
+srcdir		= @srcdir@
+VPATH		= @srcdir@
+
+include $(DEPTH)/config/autoconf.mk
+
+MODULE		= nkcache 
+LIBRARY_NAME	= nkcachemgr_s
+
+REQUIRES	= nspr
+
+EXPORTS		= \
+		nsCacheManager.h \
+		$(NULL)
+
+CPPSRCS		= \
+        nsCacheManager.cpp \
+        nsCachedNetData.cpp \
+        nsReplacementPolicy.cpp \
+        nsCacheEntryChannel.cpp \
+		$(NULL)
+
+LOCAL_INCLUDES	= -I$(srcdir)/../public -I$(srcdir)/../include
+
+EXTRA_LIBS	= $(NSPR_LIBS)
+
+# we don't want the shared lib, but we want to force the creation of a
+# static lib.
+override NO_SHARED_LIB=1
+override NO_STATIC_LIB=
+
+include $(topsrcdir)/config/rules.mk
+

mozilla/netwerk/cache/mgr/Makefile.win

@@ -0,0 +1,45 @@
+#!gmake
+#
+# The contents of this file are subject to the Netscape 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/NPL/
+#
+# 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.org code.
+#
+# The Initial Developer of the Original Code is Netscape
+# Communications Corporation.  Portions created by Netscape are
+# Copyright (C) 1998 Netscape Communications Corporation. All
+# Rights Reserved.
+#
+# Contributor(s): 
+
+DEPTH=..\..\..
+
+include <$(DEPTH)/config/config.mak>
+
+MODULE = nkcache
+
+LIBRARY_NAME = nkcachemgr_s
+
+CPP_OBJS =                                   \
+	.\$(OBJDIR)\nsCacheManager.obj       \
+	.\$(OBJDIR)\nsCachedNetData.obj      \
+	.\$(OBJDIR)\nsReplacementPolicy.obj  \
+	.\$(OBJDIR)\nsCacheEntryChannel.obj  \
+	$(NULL)
+
+include <$(DEPTH)\config\rules.mak> 
+
+install:: $(LIBRARY)
+	$(MAKE_INSTALL) $(LIBRARY) $(DIST)\lib
+
+clobber::
+        rm -rf $(OBJDIR)
+        rm -f $(DIST)\lib\$(LIBRARY_NAME).lib
+

mozilla/netwerk/cache/mgr/nsCacheEntryChannel.cpp

@@ -0,0 +1,261 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ *
+ * The contents of this file are subject to the Netscape 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/NPL/
+ *  
+ * 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 Netscape are
+ * Copyright (C) 1999 Netscape Communications Corporation. All
+ * Rights Reserved.
+ * 
+ * Contributor(s): 
+ *   Scott Furman, fur@netscape.com
+ */
+
+#include "nsCacheManager.h"
+#include "nsCacheEntryChannel.h"
+#include "nsIOutputStream.h"
+#include "nsIIOService.h"
+#include "nsIServiceManager.h"
+#include "nsIStreamListener.h"
+
+nsCacheEntryChannel::nsCacheEntryChannel(nsCachedNetData* aCacheEntry, nsIChannel* aChannel,
+                                         nsILoadGroup* aLoadGroup):
+    nsChannelProxy(aChannel), mCacheEntry(aCacheEntry), mLoadGroup(aLoadGroup), mLoadAttributes(0)
+{
+    NS_ASSERTION(aCacheEntry->mChannelCount < 0xFF, "Overflowed channel counter");
+    mCacheEntry->mChannelCount++;
+    NS_INIT_REFCNT();
+}
+
+nsCacheEntryChannel::~nsCacheEntryChannel()
+{
+    mCacheEntry->mChannelCount--;
+}
+
+NS_IMPL_ISUPPORTS3(nsCacheEntryChannel, nsISupports, nsIChannel, nsIRequest)
+
+// A proxy for nsIOutputStream
+class CacheOutputStream : public nsIOutputStream {
+
+public:
+    CacheOutputStream(nsIOutputStream *aOutputStream, nsCachedNetData *aCacheEntry):
+        mOutputStream(aOutputStream), mCacheEntry(aCacheEntry), mStartTime(PR_Now())
+        { NS_INIT_REFCNT(); }
+
+    virtual ~CacheOutputStream() {
+        mCacheEntry->NoteDownloadTime(mStartTime, PR_Now());
+        mCacheEntry->ClearFlag(nsCachedNetData::UPDATE_IN_PROGRESS);
+    }
+    
+    NS_DECL_ISUPPORTS
+
+    NS_IMETHOD Close() {
+        return mOutputStream->Close();
+    }
+
+    NS_IMETHOD Flush() { return mOutputStream->Flush(); }
+
+    NS_IMETHOD
+    Write(const char *aBuf, PRUint32 aCount, PRUint32 *aActualBytes) {
+        nsresult rv;
+    
+        *aActualBytes = 0;
+        rv = mOutputStream->Write(aBuf, aCount, aActualBytes);
+        mCacheEntry->mLogicalLength += *aActualBytes;
+        if (NS_FAILED(rv)) return rv;
+        nsCacheManager::LimitCacheSize();
+        return rv;
+    }
+    
+protected:
+    nsCOMPtr<nsIOutputStream> mOutputStream;
+    nsCOMPtr<nsCachedNetData> mCacheEntry;
+
+    // Time at which stream was opened
+    PRTime mStartTime;
+};
+
+NS_IMPL_ISUPPORTS(CacheOutputStream, NS_GET_IID(nsIOutputStream))
+
+NS_IMETHODIMP
+nsCacheEntryChannel::OpenOutputStream(PRUint32 aStartPosition, nsIOutputStream* *aOutputStream)
+{
+    nsresult rv;
+    nsCOMPtr<nsIOutputStream> baseOutputStream;
+    
+    rv = mChannel->OpenOutputStream(aStartPosition, getter_AddRefs(baseOutputStream));
+    if (NS_FAILED(rv)) return rv;
+
+    mCacheEntry->NoteUpdate();
+    mCacheEntry->NoteAccess();
+    mCacheEntry->mLogicalLength = aStartPosition;
+
+    *aOutputStream = new CacheOutputStream(baseOutputStream, mCacheEntry);
+    if (!*aOutputStream)
+        return NS_ERROR_OUT_OF_MEMORY;
+    NS_ADDREF(*aOutputStream);
+    return NS_OK;
+}
+
+NS_IMETHODIMP
+nsCacheEntryChannel::OpenInputStream(PRUint32 aStartPosition, PRInt32 aReadCount,
+				     nsIInputStream* *aInputStream)
+{
+    mCacheEntry->NoteAccess();
+    return mChannel->OpenInputStream(aStartPosition, aReadCount, aInputStream);
+}
+
+class CacheManagerStreamListener: public nsIStreamListener  {
+
+    public:
+    
+    CacheManagerStreamListener(nsIStreamListener *aListener,
+                               nsILoadGroup *aLoadGroup, nsIChannel *aChannel):
+        mListener(aListener), mLoadGroup(aLoadGroup), mChannel(aChannel)
+        { NS_INIT_REFCNT(); }
+
+    virtual ~CacheManagerStreamListener() {}
+
+    private:
+
+    NS_DECL_ISUPPORTS
+
+    NS_IMETHOD
+    OnDataAvailable(nsIChannel *channel, nsISupports *aContext,
+                    nsIInputStream *inStr, PRUint32 sourceOffset, PRUint32 count) {
+        return mListener->OnDataAvailable(mChannel, aContext, inStr, sourceOffset, count);
+    }
+
+    NS_IMETHOD
+    OnStartRequest(nsIChannel *channel, nsISupports *aContext) {
+        if (mLoadGroup)
+            mLoadGroup->AddChannel(mChannel, aContext);
+        return mListener->OnStartRequest(mChannel, aContext);
+    }
+
+    NS_IMETHOD
+    OnStopRequest(nsIChannel *channel, nsISupports *aContext,
+                  nsresult status, const PRUnichar *errorMsg) {
+        nsresult rv;
+        rv = mListener->OnStopRequest(mChannel, aContext, status, errorMsg);
+        if (mLoadGroup)
+            mLoadGroup->RemoveChannel(mChannel, aContext, status, errorMsg);
+        return rv;
+    }
+
+    private:
+    
+    nsCOMPtr<nsIStreamListener>  mListener;
+    nsCOMPtr<nsILoadGroup>       mLoadGroup;
+    nsCOMPtr<nsIChannel>         mChannel;
+};
+
+NS_IMPL_ISUPPORTS2(CacheManagerStreamListener, nsIStreamListener, nsIStreamObserver)
+
+NS_IMETHODIMP
+nsCacheEntryChannel::AsyncRead(PRUint32 aStartPosition, PRInt32 aReadCount,
+                               nsISupports *aContext, nsIStreamListener *aListener)
+{
+    nsresult rv;
+
+    mCacheEntry->NoteAccess();
+
+    nsCOMPtr<nsIStreamListener> headListener;
+    if (mLoadGroup) {
+        mLoadGroup->GetDefaultLoadAttributes(&mLoadAttributes);
+
+        // Create a load group "proxy" listener...
+        nsCOMPtr<nsILoadGroupListenerFactory> factory;
+        rv = mLoadGroup->GetGroupListenerFactory(getter_AddRefs(factory));
+        if (NS_SUCCEEDED(rv) && factory) {
+            rv = factory->CreateLoadGroupListener(aListener, 
+                                                  getter_AddRefs(headListener));
+            if (NS_FAILED(rv)) return rv;
+        }
+
+    } else {
+        headListener = aListener;
+    }
+
+    CacheManagerStreamListener* cacheManagerStreamListener;
+    nsIChannel *channelForListener;
+
+    channelForListener = mProxyChannel ? mProxyChannel.get() : NS_STATIC_CAST(nsIChannel*, this);
+    cacheManagerStreamListener =
+        new CacheManagerStreamListener(headListener, mLoadGroup, channelForListener);
+    if (!cacheManagerStreamListener) return NS_ERROR_OUT_OF_MEMORY;
+    
+    NS_ADDREF(cacheManagerStreamListener);
+    rv = mChannel->AsyncRead(aStartPosition, aReadCount, aContext,
+                             cacheManagerStreamListener);
+    NS_RELEASE(cacheManagerStreamListener);
+
+    return rv;
+}
+
+// No async writes allowed to the cache yet
+NS_IMETHODIMP
+nsCacheEntryChannel::AsyncWrite(nsIInputStream *aFromStream, PRUint32 aStartPosition,
+				PRInt32 aWriteCount, nsISupports *aContext,
+				nsIStreamObserver *aObserver)
+{
+    return NS_ERROR_NOT_IMPLEMENTED;
+}
+
+NS_IMETHODIMP
+nsCacheEntryChannel::GetLoadGroup(nsILoadGroup* *aLoadGroup)
+{
+    *aLoadGroup = mLoadGroup;
+    return NS_OK;
+}
+
+NS_IMETHODIMP
+nsCacheEntryChannel::GetLoadAttributes(nsLoadFlags *aLoadAttributes)
+{
+    *aLoadAttributes = mLoadAttributes;
+    return NS_OK;
+}
+
+NS_IMETHODIMP
+nsCacheEntryChannel::SetLoadAttributes(nsLoadFlags aLoadAttributes)
+{
+    mLoadAttributes = aLoadAttributes;
+    return NS_OK;
+}
+
+static NS_DEFINE_CID(kIOServiceCID, NS_IOSERVICE_CID);
+
+NS_IMETHODIMP
+nsCacheEntryChannel::GetURI(nsIURI * *aURI)
+{
+    char* spec;
+    nsresult rv;
+
+    rv = mCacheEntry->GetUriSpec(&spec);
+    if (NS_FAILED(rv)) return rv;
+
+    NS_WITH_SERVICE(nsIIOService, serv, kIOServiceCID, &rv);
+    if (NS_FAILED(rv)) return rv;
+    
+    rv = serv->NewURI(spec, 0, aURI);
+    nsAllocator::Free(spec);
+    return rv;
+}
+
+NS_IMETHODIMP
+nsCacheEntryChannel::GetOriginalURI(nsIURI * *aURI)
+{
+    // FIXME - should return original URI passed into NewChannel() ?
+    return NS_ERROR_NOT_IMPLEMENTED;
+}

mozilla/netwerk/cache/mgr/nsCacheEntryChannel.h

@@ -0,0 +1,82 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ *
+ * The contents of this file are subject to the Netscape 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/NPL/
+ *  
+ * 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 Netscape are
+ * Copyright (C) 1998-1999 Netscape Communications Corporation. All
+ * Rights Reserved.
+ * 
+ * Contributor(s): 
+ *   Scott Furman, fur@netscape.com
+ */
+
+#ifndef _nsCacheEntryChannel_h_
+#define _nsCacheEntryChannel_h_
+
+#include "nsCOMPtr.h"
+#include "nsIChannel.h"
+#include "nsCachedNetData.h"
+#include "nsILoadGroup.h"
+
+class nsIStreamListener;
+
+// A proxy for an nsIChannel, useful when only a few nsIChannel
+// methods must be overridden
+class nsChannelProxy : public nsIChannel {
+
+public:
+    NS_FORWARD_NSICHANNEL(mChannel->)
+    NS_FORWARD_NSIREQUEST(mChannel->)
+
+protected:
+    nsChannelProxy(nsIChannel* aChannel):mChannel(aChannel) {};
+    virtual ~nsChannelProxy() {};
+    nsCOMPtr<nsIChannel>      mChannel;
+};
+
+// Override several nsIChannel methods so that they interact with the cache manager
+class nsCacheEntryChannel : public nsChannelProxy {
+
+public:
+    NS_DECL_ISUPPORTS
+
+    NS_IMETHOD OpenOutputStream(PRUint32 aStartPosition, nsIOutputStream* *aOutputStream);
+    NS_IMETHOD OpenInputStream(PRUint32 aStartPosition, PRInt32 aReadCount,
+			       nsIInputStream* *aInputStream);
+    NS_IMETHOD AsyncRead(PRUint32 aStartPosition, PRInt32 aReadCount,
+			 nsISupports *aContext, nsIStreamListener *aListener);
+    NS_IMETHOD AsyncWrite(nsIInputStream *aFromStream, PRUint32 aStartPosition,
+			  PRInt32 aWriteCount, nsISupports *aContext,
+			  nsIStreamObserver *aObserver);
+    NS_IMETHOD GetLoadAttributes(nsLoadFlags *aLoadAttributes);
+    NS_IMETHOD SetLoadAttributes(nsLoadFlags aLoadAttributes);
+    NS_IMETHOD GetLoadGroup(nsILoadGroup* *aLoadGroup);
+    NS_IMETHOD GetURI(nsIURI * *aURI);
+    NS_IMETHOD GetOriginalURI(nsIURI * *aURI);
+
+protected:
+    nsCacheEntryChannel(nsCachedNetData* aCacheEntry, nsIChannel* aChannel, nsILoadGroup* aLoadGroup);
+    virtual ~nsCacheEntryChannel();
+
+    friend class nsCachedNetData;
+
+private:
+    nsCOMPtr<nsCachedNetData>    mCacheEntry;
+    nsCOMPtr<nsILoadGroup>       mLoadGroup;
+    nsCOMPtr<nsIChannel>         mProxyChannel;
+    nsLoadFlags                  mLoadAttributes;
+};
+
+#endif // _nsCacheEntryChannel_h_

mozilla/netwerk/cache/mgr/nsCacheManager.cpp

@@ -0,0 +1,497 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ * 
+ * The contents of this file are subject to the Netscape 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/NPL/
+ *  
+ * 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 Netscape are
+ * Copyright (C) 1998-1999 Netscape Communications Corporation. All
+ * Rights Reserved.
+ * 
+ * Contributor(s): 
+ *   Scott Furman, fur@netscape.com
+ */
+
+#include "nsINetDataCache.h"
+#include "nsCacheManager.h"
+#include "nsCachedNetData.h"
+#include "nsReplacementPolicy.h"
+#include "nsString.h"
+#include "nsIURI.h"
+#include "nsHashtable.h"
+#include "nsIComponentManager.h"
+#include "nsINetDataDiskCache.h"
+
+// Limit the number of entries in the cache to conserve memory space
+// in the nsReplacementPolicy code
+#define MAX_MEM_CACHE_ENTRIES    800
+#define MAX_DISK_CACHE_ENTRIES  3200
+
+// Cache capacities in MB, overridable via APIs
+#define DEFAULT_MEMORY_CACHE_CAPACITY  1024
+#define DEFAULT_DISK_CACHE_CAPACITY   10000
+
+#define CACHE_HIGH_WATER_MARK(capacity) ((PRUint32)(0.98 * (capacity)))
+#define CACHE_LOW_WATER_MARK(capacity)  ((PRUint32)(0.97 * (capacity)))
+
+nsCacheManager* gCacheManager = 0;
+
+NS_IMPL_ISUPPORTS(nsCacheManager, NS_GET_IID(nsINetDataCacheManager))
+
+nsCacheManager::nsCacheManager()
+    : mActiveCacheRecords(0),
+    mDiskCacheCapacity(DEFAULT_DISK_CACHE_CAPACITY),
+    mMemCacheCapacity(DEFAULT_MEMORY_CACHE_CAPACITY)
+{
+    NS_ASSERTION(!gCacheManager, "Multiple cache managers created");
+    gCacheManager = this;
+    NS_INIT_REFCNT();
+}
+
+nsCacheManager::~nsCacheManager()
+{
+    gCacheManager = 0;
+    delete mActiveCacheRecords;
+    delete mMemSpaceManager;
+    delete mDiskSpaceManager;
+}
+
+nsresult
+nsCacheManager::Init()
+{
+    nsresult rv;
+
+    mActiveCacheRecords = new nsHashtable(64);
+    if (!mActiveCacheRecords)
+        return NS_ERROR_OUT_OF_MEMORY;
+
+    // Instantiate the memory cache component
+    rv = nsComponentManager::CreateInstance(NS_NETWORK_MEMORY_CACHE_PROGID,
+                                            nsnull,
+                                            NS_GET_IID(nsINetDataCache),
+                                            getter_AddRefs(mMemCache));
+    if (NS_FAILED(rv))
+        return rv;
+
+    rv = nsComponentManager::CreateInstance(NS_NETWORK_FLAT_CACHE_PROGID,
+                                            nsnull,
+                                            NS_GET_IID(nsINetDataCache),
+
+                                            getter_AddRefs(mFlatCache));
+
+    if (NS_FAILED(rv)) {
+        // For now, we don't require a flat cache module to be present
+        if (rv != NS_ERROR_FACTORY_NOT_REGISTERED)
+            return rv;
+    }
+
+#ifdef FILE_CACHE_IS_READY
+    // Instantiate the file cache component
+    rv = nsComponentManager::CreateInstance(NS_NETWORK_FILE_CACHE_PROGID,
+                                            nsnull,
+                                            NS_GET_IID(nsINetDataCache),
+                                            getter_AddRefs(mFileCache));
+    if (NS_FAILED(rv)) {
+        NS_WARNING("No disk cache present");
+    }
+#endif
+
+    // Set up linked list of caches in search order
+    mCacheSearchChain = mMemCache;
+    if (mFlatCache) {
+        mMemCache->SetNextCache(mFlatCache);
+        mFlatCache->SetNextCache(mFileCache);
+    } else {
+        mMemCache->SetNextCache(mFileCache);
+    }
+
+    // TODO - Load any extension caches here
+
+    // Initialize replacement policy for memory cache module
+    mMemSpaceManager = new nsReplacementPolicy;
+    if (!mMemSpaceManager)
+        return NS_ERROR_OUT_OF_MEMORY;
+    rv = mMemSpaceManager->Init(MAX_MEM_CACHE_ENTRIES);
+    if (NS_FAILED(rv)) return rv;
+    rv = mMemSpaceManager->AddCache(mMemCache);
+
+    // Initialize replacement policy for disk cache modules (file
+    // cache and flat cache)
+    mDiskSpaceManager = new nsReplacementPolicy;
+    if (!mDiskSpaceManager)
+        return NS_ERROR_OUT_OF_MEMORY;
+    rv = mDiskSpaceManager->Init(MAX_DISK_CACHE_ENTRIES);
+    if (NS_FAILED(rv)) return rv;
+    if (mFileCache) {
+        rv = mDiskSpaceManager->AddCache(mFileCache);
+        if (NS_FAILED(rv)) return rv;
+    }
+    if (mFlatCache) {
+        rv = mDiskSpaceManager->AddCache(mFlatCache);
+        if (NS_FAILED(rv)) return rv;
+    }
+
+    return NS_OK;
+}
+
+NS_IMETHODIMP
+nsCacheManager::GetCachedNetData(const char *aUriSpec, const char *aSecondaryKey,
+                                 PRUint32 aSecondaryKeyLength,
+                                 PRUint32 aFlags, nsICachedNetData* *aResult)
+{
+    nsCachedNetData *cachedData;
+    nsresult rv;
+    nsINetDataCache *cache;
+    nsReplacementPolicy *spaceManager;
+
+    if (aFlags & CACHE_AS_FILE) {
+        cache = mFileCache;
+        spaceManager = mDiskSpaceManager;
+
+        // Ensure that cache is initialized
+        if (mDiskCacheCapacity == (PRUint32)-1)
+            return NS_ERROR_NOT_AVAILABLE;
+
+    } else if ((aFlags & BYPASS_PERSISTENT_CACHE) ||
+               (!mFileCache && !mFlatCache) || !mDiskCacheCapacity) {
+        cache = mMemCache;
+        spaceManager = mMemSpaceManager;
+    } else {
+        cache = mFlatCache ? mFlatCache : mFileCache;
+        spaceManager = mDiskSpaceManager;
+    }
+
+    // Construct the cache key by appending the secondary key to the URI spec
+    nsCAutoString cacheKey(aUriSpec);
+
+    // Insert NUL at end of URI spec
+    cacheKey += '\0';
+    if (aSecondaryKey)
+        cacheKey.Append(aSecondaryKey, aSecondaryKeyLength);
+
+    nsStringKey key(cacheKey);
+    cachedData = (nsCachedNetData*)mActiveCacheRecords->Get(&key);
+
+    // There is no existing instance of nsCachedNetData for this URL.
+    // Make one from the corresponding record in the cache module.
+    if (cachedData) {
+        NS_ASSERTION(cache == cachedData->mCache,
+                     "Cannot yet handle simultaneously active requests for the "
+                     "same URL using different caches");
+        NS_ADDREF(cachedData);
+    } else {
+        rv = spaceManager->GetCachedNetData(cacheKey.GetBuffer(), cacheKey.Length(),
+                                            cache, &cachedData);
+        if (NS_FAILED(rv)) return rv;
+
+        mActiveCacheRecords->Put(&key, cachedData);
+    }
+    
+    *aResult = cachedData;
+    return NS_OK;
+}
+
+// Remove this cache entry from the list of active ones
+nsresult
+nsCacheManager::NoteDormant(nsCachedNetData* aEntry)
+{
+    nsresult rv;
+    PRUint32 keyLength;
+    char* key;
+    nsCOMPtr<nsINetDataCacheRecord> record;
+    nsCachedNetData* deletedEntry;
+
+    rv = aEntry->GetRecord(getter_AddRefs(record));
+    if (NS_FAILED(rv)) return rv;
+    
+    rv = record->GetKey(&keyLength, &key);
+    if (NS_FAILED(rv)) return rv;
+    
+    nsStringKey hashTableKey(nsCString(key, keyLength));
+    deletedEntry = (nsCachedNetData*)gCacheManager->mActiveCacheRecords->Remove(&hashTableKey);
+//  NS_ASSERTION(deletedEntry == aEntry, "Hash table inconsistency");
+    return NS_OK;
+}
+
+NS_IMETHODIMP
+nsCacheManager::Contains(const char *aUriSpec, const char *aSecondaryKey,
+                         PRUint32 aSecondaryKeyLength,
+                         PRUint32 aFlags, PRBool *aResult)
+{
+    nsINetDataCache *cache;
+    nsReplacementPolicy *spaceManager;
+    nsCachedNetData *cachedData;
+
+    if (aFlags & CACHE_AS_FILE) {
+        cache = mFileCache;
+        spaceManager = mDiskSpaceManager;
+    } else if ((aFlags & BYPASS_PERSISTENT_CACHE) ||
+               (!mFileCache && !mFlatCache) || !mDiskCacheCapacity) {
+        cache = mMemCache;
+        spaceManager = mMemSpaceManager;
+    } else {
+        cache = mFlatCache ? mFlatCache : mFileCache;
+        spaceManager = mDiskSpaceManager;
+    }
+
+    // Construct the cache key by appending the secondary key to the URI spec
+    nsCAutoString cacheKey(aUriSpec);
+
+    // Insert NUL between URI spec and secondary key
+    cacheKey += '\0';
+    cacheKey.Append(aSecondaryKey, aSecondaryKeyLength);
+
+    // Locate the record using (URI + secondary key)
+    nsStringKey key(cacheKey);
+    cachedData = (nsCachedNetData*)mActiveCacheRecords->Get(&key);
+
+    if (cachedData && (cache == cachedData->mCache)) {
+        *aResult = PR_TRUE;
+        return NS_OK;
+    } else {
+        // No active cache entry, see if there is a dormant one
+        return cache->Contains(cacheKey.GetBuffer(), cacheKey.Length(), aResult);
+    }
+}
+
+NS_IMETHODIMP
+nsCacheManager::GetNumEntries(PRUint32 *aNumEntries)
+{
+    nsresult rv;
+    nsCOMPtr<nsISimpleEnumerator> iterator;
+    nsCOMPtr<nsISupports> cacheSupports;
+    nsCOMPtr<nsINetDataCache> cache;
+
+    PRUint32 totalEntries = 0;
+    
+    rv = NewCacheModuleIterator(getter_AddRefs(iterator));
+    if (NS_FAILED(rv)) return rv;
+    while (1) {
+        PRBool notDone;
+        rv = iterator->HasMoreElements(&notDone);
+        if (NS_FAILED(rv)) return rv;
+        if (!notDone)
+            break;
+        
+        iterator->GetNext(getter_AddRefs(cacheSupports));
+        cache = do_QueryInterface(cacheSupports);
+        
+        PRUint32 numEntries;
+        rv = cache->GetNumEntries(&numEntries);
+        if (NS_FAILED(rv)) return rv;
+        totalEntries += numEntries;
+    }
+    
+    *aNumEntries = totalEntries;
+    return NS_OK;
+}
+
+NS_IMETHODIMP
+nsCacheManager::NewCacheEntryIterator(nsISimpleEnumerator* *aResult)
+{
+    return NS_ERROR_NOT_IMPLEMENTED;
+}
+
+class CacheEnumerator : public nsISimpleEnumerator
+{
+public:
+    CacheEnumerator(nsINetDataCache* aFirstCache):mCache(aFirstCache)
+        { NS_INIT_REFCNT(); }
+
+    virtual ~CacheEnumerator() {};
+    
+    NS_DECL_ISUPPORTS
+
+    NS_IMETHODIMP
+    HasMoreElements(PRBool* aMoreElements) {
+        *aMoreElements = (mCache != 0);
+        return NS_OK;
+    }
+
+    NS_IMETHODIMP
+    GetNext(nsISupports* *aSupports) {
+        *aSupports = mCache;
+        if (!mCache)
+            return NS_ERROR_FAILURE;
+        NS_ADDREF(*aSupports);
+
+        nsCOMPtr<nsINetDataCache> nextCache;
+        nsresult rv = mCache->GetNextCache(getter_AddRefs(nextCache));
+        mCache = nextCache;
+        return rv;
+    }
+
+private:
+    nsCOMPtr<nsINetDataCache> mCache;
+};
+
+NS_IMPL_ISUPPORTS(CacheEnumerator, NS_GET_IID(nsISimpleEnumerator))
+
+NS_IMETHODIMP
+nsCacheManager::NewCacheModuleIterator(nsISimpleEnumerator* *aResult)
+{
+    *aResult = new CacheEnumerator(mCacheSearchChain);
+    if (!*aResult)
+        return NS_ERROR_OUT_OF_MEMORY;
+    NS_ADDREF(*aResult);
+    return NS_OK;
+}
+
+NS_IMETHODIMP
+nsCacheManager::RemoveAll(void)
+{
+    nsresult rv, result;
+    nsCOMPtr<nsISimpleEnumerator> iterator;
+    nsCOMPtr<nsINetDataCache> cache;
+    nsCOMPtr<nsISupports> iSupports;
+
+    result = NS_OK;
+    rv = NewCacheModuleIterator(getter_AddRefs(iterator));
+    if (NS_FAILED(rv)) return rv;
+    while (1) {
+        PRBool notDone;
+        rv = iterator->HasMoreElements(&notDone);
+        if (NS_FAILED(rv)) return rv;
+        if (!notDone)
+            break;
+        
+        iterator->GetNext(getter_AddRefs(iSupports));
+        cache = do_QueryInterface(iSupports);
+
+        PRUint32 cacheFlags;
+        rv = cache->GetFlags(&cacheFlags);
+        if (NS_FAILED(rv)) return rv;
+        
+        if ((cacheFlags & nsINetDataCache::READ_ONLY) == 0) {
+            rv = cache->RemoveAll();
+            if (NS_FAILED(rv))
+                result = rv;
+        }
+    }
+
+    return result;
+}
+
+nsresult
+nsCacheManager::LimitMemCacheSize()
+{
+    nsresult rv;
+    nsReplacementPolicy* spaceManager;
+
+    NS_ASSERTION(gCacheManager, "No cache manager");
+
+    spaceManager = gCacheManager->mMemSpaceManager;
+
+    PRUint32 occupancy;
+    rv = spaceManager->GetStorageInUse(&occupancy);
+    if (NS_FAILED(rv)) return rv;
+
+    PRUint32 memCacheCapacity = gCacheManager->mMemCacheCapacity;
+    if (occupancy > CACHE_HIGH_WATER_MARK(memCacheCapacity))
+        return spaceManager->Evict(CACHE_LOW_WATER_MARK(memCacheCapacity));
+
+    return NS_OK;
+}
+
+nsresult
+nsCacheManager::LimitDiskCacheSize()
+{
+    nsresult rv;
+    nsReplacementPolicy* spaceManager;
+
+    NS_ASSERTION(gCacheManager, "No cache manager");
+
+    spaceManager = gCacheManager->mDiskSpaceManager;
+
+    PRUint32 occupancy;
+    rv = spaceManager->GetStorageInUse(&occupancy);
+    if (NS_FAILED(rv)) return rv;
+
+    PRUint32 diskCacheCapacity = gCacheManager->mDiskCacheCapacity;
+    if (occupancy > CACHE_HIGH_WATER_MARK(diskCacheCapacity))
+        return spaceManager->Evict(CACHE_LOW_WATER_MARK(diskCacheCapacity));
+
+    return NS_OK;
+}
+
+nsresult
+nsCacheManager::LimitCacheSize()
+{
+    nsresult rv;
+
+    rv = LimitDiskCacheSize();
+    if (NS_FAILED(rv)) return rv;
+
+    rv = LimitMemCacheSize();
+    if (NS_FAILED(rv)) return rv;
+
+    return NS_OK;
+}
+
+NS_IMETHODIMP
+nsCacheManager::SetMemCacheCapacity(PRUint32 aCapacity)
+{
+    mMemCacheCapacity = aCapacity;
+    LimitCacheSize();
+    return NS_OK;
+}
+
+NS_IMETHODIMP
+nsCacheManager::GetMemCacheCapacity(PRUint32* aCapacity)
+{
+    NS_ENSURE_ARG_POINTER(aCapacity);
+    *aCapacity = mMemCacheCapacity;
+    return NS_OK;
+}
+
+NS_IMETHODIMP
+nsCacheManager::SetDiskCacheCapacity(PRUint32 aCapacity)
+{
+    mDiskCacheCapacity = aCapacity;
+    LimitCacheSize();
+    return NS_OK;
+}
+
+NS_IMETHODIMP
+nsCacheManager::GetDiskCacheCapacity(PRUint32* aCapacity)
+{
+    NS_ENSURE_ARG_POINTER(aCapacity);
+    *aCapacity = mDiskCacheCapacity;
+    return NS_OK;
+}
+
+NS_IMETHODIMP
+nsCacheManager::SetDiskCacheFolder(nsIFileSpec* aFolder)
+{
+    NS_ENSURE_ARG(aFolder);
+
+    if (!mFileCache)
+        return NS_ERROR_NOT_AVAILABLE;
+
+    nsCOMPtr<nsINetDataDiskCache> fileCache;
+    fileCache = do_QueryInterface(mFileCache);
+    return fileCache->SetDiskCacheFolder(aFolder);
+}
+
+NS_IMETHODIMP
+nsCacheManager::GetDiskCacheFolder(nsIFileSpec* *aFolder)
+{
+    NS_ENSURE_ARG(aFolder);
+
+    if (!mFileCache)
+        return NS_ERROR_NOT_AVAILABLE;
+
+    nsCOMPtr<nsINetDataDiskCache> fileCache;
+    fileCache = do_QueryInterface(mFileCache);
+    return fileCache->GetDiskCacheFolder(aFolder);
+}

mozilla/netwerk/cache/mgr/nsCacheManager.h

@@ -0,0 +1,100 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ *
+ * The contents of this file are subject to the Netscape 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/NPL/
+ *  
+ * 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 Netscape are
+ * Copyright (C) 1998-1999 Netscape Communications Corporation. All
+ * Rights Reserved.
+ * 
+ * Contributor(s): 
+ *   Scott Furman, fur@netscape.com
+ */
+
+#ifndef _nsCacheManager_h_
+#define _nsCacheManager_h_
+
+// 2030f0b0-9567-11d3-90d3-0040056a906e
+#define NS_CACHE_MANAGER_CID                              \
+    {                                                     \
+        0x2030f0b0,                                       \
+        0x9567,                                           \
+        0x11d3,                                           \
+        {0x90, 0xd3, 0x00, 0x40, 0x05, 0x6a, 0x90, 0x6e}  \
+    }
+
+#include "nsINetDataCacheManager.h"
+#include "nsINetDataCache.h"
+#include "nsCOMPtr.h"
+
+class nsHashtable;
+class nsReplacementPolicy;
+class nsCachedNetData;
+
+class nsCacheManager : public nsINetDataCacheManager {
+
+public:
+    nsCacheManager();
+    virtual ~nsCacheManager();
+
+    NS_METHOD Init();
+
+    // nsISupports methods
+    NS_DECL_ISUPPORTS
+
+    // nsINetDataCacheManager methods
+    NS_DECL_NSINETDATACACHEMANAGER
+
+private:
+	
+    // Mapping from cache key to nsCachedNetData, but only for those cache
+    // entries with external references, i.e. those referred to outside the
+    // cache manager
+    nsHashtable*              mActiveCacheRecords;
+
+    // Memory cache
+    nsCOMPtr<nsINetDataCache> mMemCache;
+
+    // Flat-file database cache; All content aggregated into single disk file
+    nsCOMPtr<nsINetDataCache> mFlatCache;
+
+    // stream-as-file cache
+    nsCOMPtr<nsINetDataCache> mFileCache;
+
+    // Unified replacement policy for flat-cache and file-cache
+    nsReplacementPolicy*      mDiskSpaceManager;
+    
+    // Replacement policy for memory cache
+    nsReplacementPolicy*      mMemSpaceManager;
+
+    // List of caches in search order
+    nsINetDataCache*          mCacheSearchChain;
+
+    // Combined file/flat cache capacity, in KB
+    PRUint32                  mDiskCacheCapacity;
+
+    // Memory cache capacity, in KB
+    PRUint32                  mMemCacheCapacity;
+
+protected:
+    static nsresult NoteDormant(nsCachedNetData* aEntry);
+    static nsresult LimitCacheSize();
+    static nsresult LimitMemCacheSize();
+    static nsresult LimitDiskCacheSize();
+
+    friend class nsCachedNetData;
+    friend class CacheOutputStream;
+};
+
+#endif // _nsCacheManager_h_

mozilla/netwerk/cache/mgr/nsCachedNetData.h

@@ -0,0 +1,242 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ *
+ * The contents of this file are subject to the Netscape 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/NPL/
+ *  
+ * 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 Netscape are
+ * Copyright (C) 1998-1999 Netscape Communications Corporation. All
+ * Rights Reserved.
+ * 
+ * Contributor(s): 
+ *   Scott Furman, fur@netscape.com
+ */
+
+#ifndef _nsCachedNetData_h_
+#define _nsCachedNetData_h_
+
+#include "nsICachedNetData.h"
+#include "nsCOMPtr.h"
+#include "nsINetDataCacheRecord.h"
+
+class nsINetDataCache;
+class nsIStreamAsFileObserver;
+class nsIStreamAsFile;
+class nsIArena;
+class StreamAsFileObserverClosure;
+class CacheMetaData;
+
+// Number of recent access times recorded
+#define MAX_K  3
+
+/**
+ * FIXME - add comment.  There are a lot of these data structures resident in
+ * memory, so be careful about adding members unnecessarily.
+ */
+class nsCachedNetData : public nsICachedNetData {
+
+public:
+    NS_DECL_ISUPPORTS
+
+    // nsICachedNetData methods
+    NS_DECL_NSICACHEDNETDATA
+
+    NS_METHOD Init(nsINetDataCacheRecord *aRecord, nsINetDataCache *aCache);
+
+protected:
+
+    // Bits for mFlags, below
+    typedef enum {
+        DIRTY               = 1 << 0, // Cache entry data needs to be flushed to database
+
+    // ==== Flags that can be set by the protocol handler ====
+        ALLOW_PARTIAL       = 1 << 1, // Protocol handler supports partial fetching
+        UPDATE_IN_PROGRESS  = 1 << 2, // Protocol handler now modifying cache data
+
+    // ==== Cache-entry state flags.  At most one of these flags can be set ====
+        TRUNCATED_CONTENT   = 1 << 4, // Entry contains valid content, but it has
+                                      //   been truncated by cache manager
+
+        // A previously-used cache entry, which has been purged of all cached
+        // content and protocol-private data.  This cache entry can be refilled
+        // with new content or it may be retained in this vestigial state
+        // because the usage statistics it contains will be used by the
+        // replacement policy if the same URI is ever cached again.
+        VESTIGIAL           = 1 << 5,
+
+    // ==== Memory usage status bits.  At most one of these flags can be set ====
+        RECYCLED            = 1 << 8, // Previously associated database record has
+                                      //   been deleted; This cache entry is available
+                                      //   for recycling.
+
+        DORMANT             = 1 << 9, // No references to this cache entry, except by
+                                      //   the cache manager itself
+        
+    // ==== Setter bits ====
+        LAST_MODIFIED_KNOWN = 1 <<12, // Protocol handler called SetLastModifiedTime()
+        EXPIRATION_KNOWN    = 1 <<13, // Protocol handler called SetExpirationTime()
+        STALE_TIME_KNOWN    = 1 <<14, // Protocol handler called SetStaleTime()
+
+    // ==== Useful flag combinations ====
+        // Cache entry not eligible for eviction
+        UNEVICTABLE         = VESTIGIAL | RECYCLED | UPDATE_IN_PROGRESS,
+        
+        // State flags that are in-memory only, i.e. not persistent 
+        TRANSIENT_FLAGS     = DIRTY | RECYCLED | DORMANT
+    } Flag;
+
+    PRBool GetFlag(Flag aFlag) { return (mFlags & aFlag) != 0; }
+    nsresult GetFlag(PRBool *aResult, Flag aFlag) { *aResult = GetFlag(aFlag); return NS_OK; }
+
+    // Set a boolean flag for the cache entry
+    nsresult SetFlag(PRBool aValue, Flag aFlag);
+    nsresult SetFlag(Flag aFlag)   { return SetFlag(PR_TRUE,  aFlag); }
+    nsresult ClearFlag(Flag aFlag) { return SetFlag(PR_FALSE, aFlag); }
+
+    void ComputeProfit(PRUint32 aCurrentTime);
+    static int Compare(const void *a, const void *b, void *unused);
+
+    void NoteAccess();
+    void NoteUpdate();
+
+    // Get underlying raw cache database record.
+    nsresult GetRecord(nsINetDataCacheRecord* *aRecord);
+
+    nsresult GetRecordID(PRInt32 *aRecordID);
+
+    nsresult Evict(PRUint32 aTruncatedContentLength);
+    
+    nsresult GetFileSpec(nsIFileSpec* *aFileSpec);
+
+    void NoteDownloadTime(PRTime start, PRTime end);
+
+    // placement new for arena-allocation
+    void *operator new (size_t aSize, nsIArena *aArena);
+
+    friend class nsReplacementPolicy;
+    friend class nsCacheManager;
+    friend class StreamAsFile;
+    friend class nsCacheEntryChannel;
+    friend class CacheOutputStream;
+    friend class InterceptStreamListener;
+
+private:
+
+    nsCachedNetData() {};
+    virtual ~nsCachedNetData() {};
+
+    // Initialize internal fields of this nsCachedNetData instance from the
+    // underlying raw cache database record.
+    nsresult Deserialize(PRBool aDeserializeFlags);
+
+    // Notify stream-as-file observers about change in cache entry status
+    nsresult Notify(PRUint32 aMessage, nsresult aError);
+
+    // Add/Remove stream-as-file observers
+    nsresult AddObserver(nsIStreamAsFile *aStreamAsFile, nsIStreamAsFileObserver* aObserver);
+    nsresult RemoveObserver(nsIStreamAsFileObserver* aObserver);
+
+    // Mark cache entry to indicate a write out to the cache database is required
+    void SetDirty() { mFlags |= DIRTY; }
+
+    nsresult Resurrect(nsINetDataCacheRecord *aRecord);
+
+    nsresult CommitFlags();
+
+    CacheMetaData* FindTaggedMetaData(const char* aTag, PRBool aCreate);
+
+private:
+    
+    // List of nsIStreamAsFileObserver's that will receive notification events
+    // when the cache manager or a client desires to delete/truncate a cache
+    // entry file.
+    StreamAsFileObserverClosure* mObservers;
+
+    // Protocol-specific meta-data, opaque to the cache manager
+    CacheMetaData *mMetaData;
+
+    // Next in chain for a single bucket in the replacement policy hash table
+    // that maps from record ID to nsCachedNetData
+    nsCachedNetData* mNext;
+    
+    // See flag bits, above
+    // NOTE: 16 bit member is combined with members below for
+    //       struct packing efficiency.  Do not change order of members!
+    PRUint16    mFlags;
+
+protected:
+
+    // Number of nsCacheEntryChannels referring to this record
+    PRUint8     mChannelCount;
+
+    // Below members are statistics kept per cache-entry, used to decide how
+    // profitable it will be to evict a record from the cache relative to other
+    // existing records.  Note: times are measured in *seconds* since the
+    // 1/1/70 epoch, same as a unix time_t.
+
+    // Number of accesses for this cache record
+    // NOTE: 8 bit member is combined with members above for
+    //       struct packing efficiency.  Do not change order of members!
+    PRUint8     mNumAccesses;
+
+    // A reference to the underlying, raw cache database record, either as a
+    // pointer to an in-memory object or as a database record identifier
+    union {
+        nsINetDataCacheRecord* mRecord;
+
+        // Database record ID of associated cache record.  See
+        // nsINetDataCache::GetRecordByID().
+        PRInt32  mRecordID;
+    };
+
+    // Weak link to parent cache
+    nsINetDataCache* mCache;
+
+    // Length of stored content, which may be less than storage consumed if
+    // compression is used
+    PRUint32 mLogicalLength;
+
+    // Most recent cache entry access times, used to compute access frequency
+    PRUint32 mAccessTime[MAX_K];
+    
+    // We use modification time of the original document for replacement policy
+    // computations, i.e. to compute a document's age, but if we don't know it,
+    // we use the time that the document was last written to the cache.
+    union {
+        // Document modification time, if known.
+        PRUint32 mLastModifiedTime;
+
+        // Time of last cache update for this doc
+        PRUint32 mLastUpdateTime;
+    };
+
+    union {
+      // Time until which document is fresh, i.e. does not have to be validated
+      // with server and, therefore, data in cache is guaranteed usable
+      PRUint32 mExpirationTime;
+
+      // Heuristic time at which cached document is likely to be out-of-date
+      // with respect to canonical copy on server.  Used for cache replacement
+      // policy, not for validation.
+      PRUint32 mStaleTime;
+    };
+
+    // Download time per byte, measure roughly in units of KB/s
+    float mDownloadRate;
+    
+    // Heuristic estimate of cache entry future benefits, based on above values
+    float mProfit;
+};
+
+#endif // _nsCachedNetData_h_
+

mozilla/netwerk/cache/mgr/nsReplacementPolicy.cpp

@@ -0,0 +1,666 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ * The contents of this file are subject to the Netscape 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/NPL/
+ *  
+ * 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 Netscape are
+ * Copyright (C) 1998-1999 Netscape Communications Corporation. All
+ * Rights Reserved.
+ * 
+ * Contributor(s): 
+ *   Scott Furman, fur@netscape.com
+ */
+
+#include "nsReplacementPolicy.h"
+#include "nsCachedNetData.h"
+
+#include "nsQuickSort.h"
+#include "nsIAllocator.h"
+#include "nsIEnumerator.h"
+#include "prtime.h"
+#include "prbit.h"
+#include "nsCOMPtr.h"
+#include <math.h>
+
+// Constant used to estimate frequency of access to a document based on size
+#define CACHE_CONST_B   1.35
+
+// A cache whose space is managed by this replacement policy
+class nsReplacementPolicy::CacheInfo {
+public:
+    CacheInfo(nsINetDataCache* aCache):mCache(aCache),mNext(0) {}
+
+    nsINetDataCache* mCache;
+    CacheInfo*       mNext;
+};
+
+nsReplacementPolicy::nsReplacementPolicy()
+    : mRankedEntries(0), mCaches(0), mRecordsRemovedSinceLastRanking(0),
+      mNumEntries(0), mCapacityRankedEntriesArray(0), mLastRankTime(0) {}
+
+nsReplacementPolicy::~nsReplacementPolicy()
+{
+    if (mRankedEntries)
+        nsAllocator::Free(mRankedEntries);
+    if (mMapRecordIdToEntry)
+        nsAllocator::Free(mMapRecordIdToEntry);
+}
+
+nsresult
+nsReplacementPolicy::Init(PRUint32 aMaxCacheEntries)
+{
+    nsresult rv;
+
+    rv = NS_NewHeapArena(getter_AddRefs(mArena), sizeof(nsCachedNetData) * 32);
+    if (NS_FAILED(rv)) return rv;
+
+    mMaxEntries = aMaxCacheEntries;
+
+    mHashArrayLength = PR_CeilingLog2(aMaxCacheEntries) >> 3;
+    size_t numBytes = mHashArrayLength * sizeof(*mMapRecordIdToEntry);
+    mMapRecordIdToEntry = (nsCachedNetData**)nsAllocator::Alloc(numBytes);
+    if (!mMapRecordIdToEntry)
+        return NS_ERROR_OUT_OF_MEMORY;
+
+    nsCRT::zero(mMapRecordIdToEntry, numBytes);
+
+    return NS_OK;
+}
+
+nsresult
+nsReplacementPolicy::AddCache(nsINetDataCache *aCache)
+{
+    CacheInfo *cacheInfo = new CacheInfo(aCache);
+    if (!cacheInfo)
+        return NS_ERROR_OUT_OF_MEMORY;
+    cacheInfo->mNext = mCaches;
+    mCaches = cacheInfo;
+    return NS_OK;
+}
+
+PRUint32
+nsReplacementPolicy::HashRecordID(PRInt32 aRecordID)
+{
+    return ((aRecordID >> 16) ^ aRecordID) & (mHashArrayLength - 1);
+}
+
+nsCachedNetData*
+nsReplacementPolicy::FindCacheEntryByRecordID(PRInt32 aRecordID, nsINetDataCache *aCache)
+{
+    nsresult rv;
+    nsCachedNetData* cacheEntry;
+    PRUint32 bucket = HashRecordID(aRecordID);
+
+    cacheEntry = mMapRecordIdToEntry[bucket];
+    for (;cacheEntry; cacheEntry = cacheEntry->mNext) {
+
+        PRInt32 recordID;
+        rv = cacheEntry->GetRecordID(&recordID);
+        if (NS_FAILED(rv))
+            continue;
+
+        if ((recordID == aRecordID) && (cacheEntry->mCache == aCache))
+            return cacheEntry;
+    }
+
+    return 0;
+}
+
+// Add a cache entry to the hash table that maps record ID to entries
+void
+nsReplacementPolicy::AddCacheEntry(nsCachedNetData* aCacheEntry, PRInt32 aRecordID)
+{
+    nsCachedNetData** cacheEntryp;
+    PRUint32 bucket = HashRecordID(aRecordID);
+
+    cacheEntryp = &mMapRecordIdToEntry[bucket];
+    while (*cacheEntryp)
+        cacheEntryp = &(*cacheEntryp)->mNext;
+    *cacheEntryp = aCacheEntry;
+    aCacheEntry->mNext = 0;
+}
+
+// Delete a cache entry from the hash table that maps record ID to entries
+nsresult
+nsReplacementPolicy::DeleteCacheEntry(nsCachedNetData* aCacheEntry)
+{
+    nsresult rv;
+    PRInt32 recordID;
+    rv = aCacheEntry->GetRecordID(&recordID);
+    if (NS_FAILED(rv)) return rv;
+
+    PRUint32 bucket = HashRecordID(recordID);
+
+    nsCachedNetData** cacheEntryp;
+    cacheEntryp = &mMapRecordIdToEntry[bucket];
+    while (*cacheEntryp) {
+        if (*cacheEntryp == aCacheEntry) {
+            *cacheEntryp = aCacheEntry->mNext;
+            return NS_OK;
+        }
+        cacheEntryp = &(*cacheEntryp)->mNext;
+    }
+    
+    NS_ASSERTION(0, "hash table inconsistency");
+    return NS_ERROR_FAILURE;
+}
+
+nsresult
+nsReplacementPolicy::AddAllRecordsInCache(nsINetDataCache *aCache)
+{
+    nsresult rv;
+    nsCOMPtr<nsISimpleEnumerator> iterator;
+    nsCOMPtr<nsISupports> iSupports;
+    nsCOMPtr<nsINetDataCacheRecord> record;
+    rv = aCache->NewCacheEntryIterator(getter_AddRefs(iterator));
+    if (!NS_SUCCEEDED(rv)) return rv;
+
+    while (1) {
+        PRBool notDone;
+
+        rv = iterator->HasMoreElements(&notDone);
+        if (NS_FAILED(rv)) return rv;
+        if (!notDone)
+            break;
+
+        rv = iterator->GetNext(getter_AddRefs(iSupports));
+        if (!NS_SUCCEEDED(rv)) return rv;
+        record = do_QueryInterface(iSupports);
+        
+        rv = AssociateCacheEntryWithRecord(record, aCache, 0);
+        if (!NS_SUCCEEDED(rv)) return rv;
+    }
+
+    return NS_OK;
+}
+
+// Get current time and convert to seconds since the epoch
+static PRUint32
+now32()
+{
+    double nowFP;
+    PRInt64 now64 = PR_Now();
+    LL_L2D(nowFP, now64);
+    PRUint32 now = (PRUint32)(nowFP * 1e-6);
+    return now;
+}
+
+void
+nsCachedNetData::NoteDownloadTime(PRTime start, PRTime end)
+{
+    double startFP, endFP, rate, duration;
+
+    LL_L2D(startFP, start);
+    LL_L2D(endFP, end);
+
+    duration = endFP - startFP;
+
+    // If the data arrives so fast that it can not be timed due to the clock
+    // granularity, assume a data arrival duration of 10 ms
+    if (!duration)
+        duration = 10000;
+
+    // Compute download rate in kB/s
+    rate = mLogicalLength / (duration * (1e-6 * 1024.0));
+    
+    if (mDownloadRate) {
+        // Exponentially smooth download rate
+        const double alpha = 0.5;
+        mDownloadRate = (float)(mDownloadRate * alpha + rate * (1.0 - alpha));
+    } else {
+        mDownloadRate = (float)rate;
+    }
+}
+
+// 1 hour
+#define MIN_HALFLIFE (60 * 60)
+
+// 1 week
+#define TYPICAL_HALFLIFE (7 * 24 * 60 * 60)
+
+/**
+ * Estimate the profit that would be lost if the given cache entry was evicted
+ * from the cache.  Profit is defined as the future expected download delay per
+ * byte of cached content.  The profit computation is made based on projected
+ * frequency of access, prior download performance and a heuristic staleness
+ * criteria.  The technique used is a variation of that described in the
+ * following paper:
+ *
+ *    "A Case for Delay-Conscious Caching of Web Documents"
+ *    http://www.bell-labs.com/user/rvingral/www97.html
+ *
+ * Briefly, expected profit is:
+ *
+ *   (projected frequency of access) * (download time per byte) * (probability freshness)
+ */
+void
+nsCachedNetData::ComputeProfit(PRUint32 aNow)
+{
+    PRUint32 K, now;
+
+    if (aNow)
+        now = aNow;
+    else
+        now = now32();
+    
+    K = PR_MIN(MAX_K, mNumAccesses);
+    if (!K) {
+        mProfit = 0;
+        return;
+    }
+
+    // Compute time, in seconds, since k'th most recent access
+    double timeSinceKthAccess = now - mAccessTime[K - 1];
+    if (timeSinceKthAccess <= 0.0)    // Sanity check
+        timeSinceKthAccess = 1.0;
+
+    // Estimate frequency of future document access based on past
+    //  access frequency
+    double frequencyAccess = K / timeSinceKthAccess;
+
+    // If we don't have much historical data on access frequency
+    //   use a heuristic based on document size as an estimate
+    if (mLogicalLength) {
+        if (K == 1) {
+            frequencyAccess /= pow(mLogicalLength, CACHE_CONST_B);
+        } else if (K == 2) {
+            frequencyAccess /= pow(mLogicalLength, CACHE_CONST_B / 2);
+        }
+    }
+
+    // Estimate likelihood that data in cache is fresh, i.e.
+    //  that it corresponds to the document on the server
+    double probabilityFreshness;
+    PRInt32 halfLife, age, docTime;
+    PRBool potentiallyStale;
+
+    docTime = GetFlag(LAST_MODIFIED_KNOWN) ? mLastModifiedTime : mLastUpdateTime;
+    age = now - docTime;
+
+    probabilityFreshness = 1.0; // Optimistic
+
+    if (GetFlag(EXPIRATION_KNOWN)) {
+        potentiallyStale = now > mExpirationTime;
+        halfLife = mExpirationTime - mLastModifiedTime;
+    } else if (GetFlag(STALE_TIME_KNOWN)) {
+        potentiallyStale = PR_TRUE;
+        halfLife = mStaleTime - docTime;
+    } else {
+        potentiallyStale = PR_TRUE;
+        halfLife = TYPICAL_HALFLIFE;
+    }
+    
+    if (potentiallyStale) {
+        if (halfLife < MIN_HALFLIFE)
+            halfLife = MIN_HALFLIFE;
+
+        probabilityFreshness = pow(0.5, (double)age / (double)halfLife);
+    }
+
+    mProfit = (float)(frequencyAccess * probabilityFreshness);
+    if (mDownloadRate)
+        mProfit /= mDownloadRate;
+}
+
+// Number of entries to grow mRankedEntries array when it's full
+#define STATS_GROWTH_INCREMENT  256
+
+
+// Sorting predicate for NS_Quicksort
+int
+nsCachedNetData::Compare(const void *a, const void *b, void *unused)
+{
+    nsCachedNetData* entryA = *(nsCachedNetData**)a;
+    nsCachedNetData* entryB = *(nsCachedNetData**)b;
+
+    // Percolate deleted or empty entries to the end of the mRankedEntries
+    // array, so that they can be recycled.
+    if (!entryA || entryA->GetFlag(RECYCLED)) {
+        if (!entryB || entryB->GetFlag(RECYCLED))
+            return 0;
+        else 
+            return +1;
+    } 
+    if (!entryB || entryB->GetFlag(RECYCLED))
+        return -1;
+
+    // Evicted entries (those with no content data) and active entries (those
+    // currently being updated) are collected towards the end of the sorted
+    // array just prior to the deleted cache entries, since evicted entries
+    // can't be re-evicted.
+    if (entryA->GetFlag(UPDATE_IN_PROGRESS)) {
+        if (entryB->GetFlag(UPDATE_IN_PROGRESS))
+            return 0;
+        else 
+            return +1;
+    } 
+    if (entryB->GetFlag(UPDATE_IN_PROGRESS))
+        return -1;
+
+    PRUint16 Ka = PR_MIN(MAX_K, entryA->mNumAccesses);
+    PRUint16 Kb = PR_MIN(MAX_K, entryB->mNumAccesses);
+
+    // Order cache entries by the number of times they've been accessed
+    if (Ka < Kb)
+        return -1;
+    if (Ka > Kb)
+        return +1;
+
+    /*
+     * Among records that have been accessed an equal number of times, order
+     * them by profit.
+     */
+    if (entryA->mProfit > entryB->mProfit)
+        return +1;
+    if (entryA->mProfit < entryB->mProfit)
+        return -1;
+    return 0;
+}
+
+/**
+ * Rank cache entries in terms of their elegibility for eviction.
+ */
+nsresult
+nsReplacementPolicy::RankRecords()
+{
+    PRUint32 i, now;
+
+    // Add all cache records if this is the first ranking
+    if (!mLastRankTime) {
+        nsresult rv;
+        CacheInfo *cacheInfo;
+
+        cacheInfo = mCaches;
+        while (cacheInfo) {
+            rv = AddAllRecordsInCache(cacheInfo->mCache);
+            if (NS_FAILED(rv)) return rv;
+
+            cacheInfo = cacheInfo->mNext;
+        }
+    }
+
+    // Get current time and convert to seconds since the epoch
+    now = now32();
+
+    // Recompute profit for every known cache record, except deleted ones
+    for (i = 0; i < mNumEntries; i++) {
+        nsCachedNetData* entry = mRankedEntries[i];
+        if (entry && !entry->GetFlag(nsCachedNetData::RECYCLED))
+            entry->ComputeProfit(now);
+    }
+    NS_QuickSort(mRankedEntries, mNumEntries, sizeof *mRankedEntries, 
+                 nsCachedNetData::Compare, 0);
+
+    mNumEntries -= mRecordsRemovedSinceLastRanking;
+    mRecordsRemovedSinceLastRanking = 0;
+    mLastRankTime = now;
+    return NS_OK;
+}
+
+// A heuristic policy to avoid the cost of re-ranking cache records by
+// profitability every single time space must be made available in the cache.
+void
+nsReplacementPolicy::MaybeRerankRecords()
+{
+    // Rank at most once per minute
+    PRUint32 now = now32();
+    if ((now - mLastRankTime) >= 60)
+        RankRecords();
+}
+
+void
+nsReplacementPolicy::CompactRankedEntriesArray()
+{
+    if (mRecordsRemovedSinceLastRanking || !mLastRankTime)
+        RankRecords();
+}
+
+nsresult
+nsReplacementPolicy::CheckForTooManyCacheEntries()
+{
+    if (mCapacityRankedEntriesArray == mMaxEntries) {
+        return DeleteOneEntry(0);
+    } else {
+        nsresult rv;
+        CacheInfo *cacheInfo;
+
+        cacheInfo = mCaches;
+        while (cacheInfo) {
+            PRUint32 numEntries, maxEntries;
+
+            rv = cacheInfo->mCache->GetNumEntries(&numEntries);
+            if (NS_FAILED(rv)) return rv;
+
+            rv = cacheInfo->mCache->GetMaxEntries(&maxEntries);
+            if (NS_FAILED(rv)) return rv;
+
+            if (numEntries == maxEntries)
+                return DeleteOneEntry(cacheInfo->mCache);
+
+            cacheInfo = cacheInfo->mNext;
+        }
+    }
+    return NS_OK;
+}
+
+
+/** 
+ * Create a new association between a low-level cache database record and a
+ * cache entry.  Add the entry to the set of entries eligible for eviction from
+ * the cache.  This would typically be done when the cache entry is created.
+ */
+nsresult
+nsReplacementPolicy::AssociateCacheEntryWithRecord(nsINetDataCacheRecord *aRecord,
+                                                   nsINetDataCache* aCache,
+                                                   nsCachedNetData** aResult)
+{
+    nsCachedNetData* cacheEntry;
+    nsresult rv;
+
+    // First, see if the record is already known to the replacement policy
+    PRInt32 recordID;
+    rv = aRecord->GetRecordID(&recordID);
+    if (NS_FAILED(rv)) return rv;
+    cacheEntry = FindCacheEntryByRecordID(recordID, aCache);
+    if (cacheEntry) {
+        if (aResult) {
+            if (cacheEntry->GetFlag(nsCachedNetData::DORMANT))
+                cacheEntry->Resurrect(aRecord);
+            NS_ADDREF(cacheEntry);
+            *aResult = cacheEntry;
+        }
+        return NS_OK;
+    }
+
+    // Compact the array of cache entry statistics, so that free entries appear
+    // at the end, for possible reuse.
+    if (mNumEntries && (mNumEntries == mCapacityRankedEntriesArray))
+        CompactRankedEntriesArray();
+
+    // If compaction doesn't yield available entries in the
+    // mRankedEntries array, then extend the array.
+    if (mNumEntries == mCapacityRankedEntriesArray) {
+        PRUint32 newCapacity;
+
+        rv = CheckForTooManyCacheEntries();
+        if (NS_FAILED(rv)) return rv;
+
+        newCapacity = mCapacityRankedEntriesArray + STATS_GROWTH_INCREMENT;
+        if (newCapacity > mMaxEntries)
+            newCapacity = mMaxEntries;
+
+        nsCachedNetData** newRankedEntriesArray; 
+        PRUint32 numBytes = sizeof(nsCachedNetData*) * newCapacity;
+        newRankedEntriesArray = 
+            (nsCachedNetData**)nsAllocator::Realloc(mRankedEntries, numBytes);
+        if (!newRankedEntriesArray)
+            return NS_ERROR_OUT_OF_MEMORY;
+        
+        mRankedEntries = newRankedEntriesArray;
+        mCapacityRankedEntriesArray = newCapacity;
+
+        PRUint32 i;
+        for (i = mNumEntries; i < newCapacity; i++)
+            mRankedEntries[i] = 0;
+    }
+
+    // Recycle the record after the last in-use record in the array
+    nsCachedNetData *entry = mRankedEntries[mNumEntries];
+    NS_ASSERTION(!entry || !entry->GetFlag(nsCachedNetData::RECYCLED),
+                 "Only deleted cache entries should appear at end of array");
+
+    if (!entry) {
+        entry = new(mArena) nsCachedNetData;
+        if (!entry)
+            return NS_ERROR_OUT_OF_MEMORY;
+        mRankedEntries[mNumEntries] = entry;
+    } else {
+        // Clear out recycled data structure
+        nsCRT::zero(entry, sizeof(*entry));
+    }
+
+    entry->Init(aRecord, aCache);
+    AddCacheEntry(entry, recordID);
+    
+    // Add one reference to the cache entry from the cache manager
+    NS_ADDREF(entry);
+
+    if (aResult) {
+        // And one reference from our caller
+        NS_ADDREF(entry);
+        *aResult = entry;
+    }
+
+    mNumEntries++;
+    return NS_OK;
+}
+
+nsresult
+nsReplacementPolicy::GetCachedNetData(const char* cacheKey, PRUint32 cacheKeyLength,
+                                      nsINetDataCache* aCache,
+                                      nsCachedNetData** aResult)
+{
+    nsresult rv;
+    nsCOMPtr<nsINetDataCacheRecord> record;
+
+    rv = aCache->GetCachedNetData(cacheKey, cacheKeyLength,
+                                  getter_AddRefs(record));
+    if (NS_FAILED(rv)) return rv;
+    return AssociateCacheEntryWithRecord(record, aCache, aResult);
+}
+
+/**
+ * Delete the least desirable record from the cache database.  This is used
+ * when the addition of another record would exceed either the cache manager or
+ * the cache's maximum permitted number of records.
+ */
+nsresult
+nsReplacementPolicy::DeleteOneEntry(nsINetDataCache *aCache)
+{
+    PRUint32 i;
+    nsresult rv;
+    nsCachedNetData *entry;
+
+    i = 0;
+    while (1) {
+        MaybeRerankRecords();
+        for (; i < mNumEntries; i++) {
+            entry = mRankedEntries[i];
+            if (!entry || entry->GetFlag(nsCachedNetData::RECYCLED))
+                continue;
+            if (!aCache || (entry->mCache == aCache))
+                break;
+        }
+
+        // Report error if no record found to delete
+        if (i == mNumEntries)
+            return NS_ERROR_FAILURE;
+        rv = entry->Delete();
+        if (NS_SUCCEEDED(rv)) {
+            rv = DeleteCacheEntry(entry);
+            return rv;
+        }
+    }
+}
+
+nsresult
+nsReplacementPolicy::GetStorageInUse(PRUint32* aStorageInUse)
+{
+    nsresult rv;
+    CacheInfo *cacheInfo;
+
+    *aStorageInUse = 0;
+    cacheInfo = mCaches;
+    while (cacheInfo) {
+        PRUint32 cacheStorage;
+        rv = cacheInfo->mCache->GetStorageInUse(&cacheStorage);
+        if (NS_FAILED(rv)) return rv;
+
+        *aStorageInUse += cacheStorage;
+        cacheInfo = cacheInfo->mNext;
+    }
+    return NS_OK;
+}
+
+/**
+ * Delete the least desirable records from the cache until the occupancy of the
+ * cache has been reduced by the given number of KB.  This is used when the
+ * addition of more cache data would exceed the cache's capacity. 
+ */
+nsresult
+nsReplacementPolicy::Evict(PRUint32 aTargetOccupancy)
+{
+    PRUint32 i;
+    nsCachedNetData *entry;
+    nsresult rv;
+    PRUint32 occupancy;
+    PRInt32 truncatedLength;
+    nsCOMPtr<nsINetDataCacheRecord> record;
+
+    MaybeRerankRecords();
+    for (i = 0; i < mNumEntries; i++) {
+        rv = GetStorageInUse(&occupancy);
+        if (!NS_SUCCEEDED(rv)) return rv;
+        
+        if (occupancy <= aTargetOccupancy)
+            return NS_OK;
+
+        entry = mRankedEntries[i];
+
+        // Skip deleted/empty cache entries and ones that have already been evicted
+        if (!entry || entry->GetFlag(nsCachedNetData::UNEVICTABLE))
+            continue;
+
+        if (entry->GetFlag(nsCachedNetData::ALLOW_PARTIAL)) {
+            rv = entry->GetRecord(getter_AddRefs(record));
+            if (NS_FAILED(rv))
+                continue;
+
+            PRUint32 contentLength;
+            rv = record->GetStoredContentLength(&contentLength);
+            if (NS_FAILED(rv))
+                continue;
+            
+            // Additional cache storage required, in KB
+            PRUint32 storageToReclaim = (occupancy - aTargetOccupancy) << 10;
+            
+            truncatedLength = (PRInt32)(contentLength - storageToReclaim);
+            if (truncatedLength < 0)
+                truncatedLength = 0;
+        } else {
+            truncatedLength = 0;
+        }
+        rv = entry->Evict(truncatedLength);
+    }
+    return NS_ERROR_FAILURE;
+}

mozilla/netwerk/cache/mgr/nsReplacementPolicy.h

@@ -0,0 +1,136 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ *
+ * The contents of this file are subject to the Netscape 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/NPL/
+ *  
+ * 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 Netscape are
+ * Copyright (C) 1998-1999 Netscape Communications Corporation. All
+ * Rights Reserved.
+ * 
+ * Contributor(s): 
+ *   Scott Furman, fur@netscape.com
+ */
+
+/**
+ * This class manages one or more caches that share a storage resource, e.g. a
+ * file cache and a flat-database cache might each occupy space on the disk and
+ * they would share a single instance of nsReplacementPolicy.  The replacement
+ * policy heuristically chooses which cache entries to evict when storage is
+ * required to accommodate incoming cache data.
+ */
+
+#ifndef _nsReplacementPolicy_h_
+#define _nsReplacementPolicy_h_
+
+#include "nscore.h"
+#include "nsISupportsUtils.h"
+#include "nsINetDataCache.h"
+#include "nsICachedNetData.h"
+#include "nsIArena.h"
+#include "nsCOMPtr.h"
+#include "nsHashtable.h"
+
+class nsCachedNetData;
+struct PL_HashTable;
+
+/**
+ * This private class is responsible for implementing the network data cache's
+ * replacement policy, i.e. it decides which cache data should be evicted to
+ * make room for new incoming data.
+ */
+class nsReplacementPolicy {
+
+public:
+
+    nsReplacementPolicy();
+    ~nsReplacementPolicy();
+
+protected:
+
+    nsresult Init(PRUint32 aMaxCacheEntries);
+    nsresult AddCache(nsINetDataCache *aCache);
+    nsresult GetCachedNetData(const char* cacheKey, PRUint32 cacheKeyLength,
+                              nsINetDataCache* aCache,
+                              nsCachedNetData** aResult);
+    nsresult GetStorageInUse(PRUint32* aNumKBytes);
+
+    friend class nsCacheManager;
+
+private:
+    nsresult RankRecords();
+    void MaybeRerankRecords();
+    void CompactRankedEntriesArray();
+    nsresult DeleteOneEntry(nsINetDataCache* aCache);
+    nsresult Evict(PRUint32 aTargetOccupancy);
+
+    nsCachedNetData* FindCacheEntryByRecordID(PRInt32 aRecordID, nsINetDataCache *aCache);
+    void AddCacheEntry(nsCachedNetData* aCacheEntry, PRInt32 aRecordID);
+    nsresult DeleteCacheEntry(nsCachedNetData* aCacheEntry);
+    PRUint32 HashRecordID(PRInt32 aRecordID);
+    nsresult AssociateCacheEntryWithRecord(nsINetDataCacheRecord *aRecord,
+                                           nsINetDataCache* aCache,
+                                           nsCachedNetData** aResult);
+
+    nsresult AddAllRecordsInCache(nsINetDataCache *aCache);
+    nsresult CheckForTooManyCacheEntries();
+
+    class CacheInfo;
+
+private:
+
+    // Growable array of pointers to individual cache entries; It is sorted by
+    // profitability, such that low-numbered array indices refer to cache
+    // entries that are the least profitable to retain.  New cache entries are
+    // added to the end of the array.  Deleted cache entries are specially
+    // marked and percolate to the end of the array for recycling whenever
+    // mRankedEntries is sorted.  Evicted cache entries (those with no
+    // associated content data) are retained for the purpose of improving the
+    // replacement policy efficacy, and are percolated towards the end of the
+    // array, just prior to the deleted cache entries.
+    //
+    // The array is not in sorted order 100% of the time; For efficiency
+    // reasons, sorting is only done when heuristically deemed necessary.
+    nsCachedNetData**   mRankedEntries;
+
+    // Hash table buckets to map Record ID to cache entry.  We use this instead
+    // of a PL_HashTable to reduce storage requirements
+    nsCachedNetData**   mMapRecordIdToEntry;
+
+    // Length of mMapRecordIdToEntry array
+    PRUint32            mHashArrayLength;
+
+    // Linked list of caches that share this replacement policy
+    CacheInfo*          mCaches;
+
+    // Allocation area for cache entry (nsCachedNetData) instances
+    nsCOMPtr<nsIArena>  mArena;
+
+    // Bookkeeping
+    PRUint32            mRecordsRemovedSinceLastRanking;
+
+    // Maximum permitted length of mRankedEntries array
+    PRUint32            mMaxEntries;
+
+    // Number of occupied slots in mRankedEntries array
+    PRUint32            mNumEntries;
+
+    // Capacity of mRankedEntries array
+    PRUint32            mCapacityRankedEntriesArray;
+
+    // Time at which cache entries were last ranked by profitability
+    PRUint32            mLastRankTime;
+};
+
+
+#endif // _nsReplacementPolicy_h_

mozilla/netwerk/cache/public/Makefile.in

@@ -0,0 +1,43 @@
+#
+# The contents of this file are subject to the Netscape 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/NPL/
+#
+# 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.org code.
+#
+# The Initial Developer of the Original Code is Netscape
+# Communications Corporation.  Portions created by Netscape are
+# Copyright (C) 1998 Netscape Communications Corporation. All
+# Rights Reserved.
+#
+# Contributor(s): 
+#
+
+DEPTH		= ../../..
+topsrcdir	= @top_srcdir@
+srcdir		= @srcdir@
+VPATH		= @srcdir@
+
+MODULE		= nkcache
+
+include $(DEPTH)/config/autoconf.mk
+
+XPIDLSRCS	= \
+		nsICachedNetData.idl          \
+	        nsINetDataCacheManager.idl    \
+		nsINetDataCache.idl           \
+		nsINetDataCacheRecord.idl     \
+	        nsINetDataDiskCache.idl       \
+		nsIStreamAsFile.idl           \
+	        $(NULL)
+
+EXPORTS		:= $(addprefix $(srcdir)/, $(EXPORTS))
+
+include $(topsrcdir)/config/rules.mk
+

mozilla/netwerk/cache/public/Makefile.win

@@ -0,0 +1,41 @@
+#!gmake
+#
+# The contents of this file are subject to the Netscape 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/NPL/
+#
+# 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.org code.
+#
+# The Initial Developer of the Original Code is Netscape
+# Communications Corporation.  Portions created by Netscape are
+# Copyright (C) 1998 Netscape Communications Corporation. All
+# Rights Reserved.
+#
+# Contributor(s): 
+
+MODULE = nkcache
+
+DEPTH = ..\..\..
+include <$(DEPTH)/config/config.mak>
+
+
+EXPORTS =                   \
+        $(NULL)
+
+XPIDLSRCS =                             \
+        .\nsICachedNetData.idl          \
+        .\nsINetDataCacheManager.idl    \
+        .\nsINetDataCache.idl           \
+        .\nsINetDataCacheRecord.idl     \
+        .\nsINetDataDiskCache.idl       \
+        .\nsIStreamAsFile.idl           \
+        $(NULL)
+
+include <$(DEPTH)/config/rules.mak>
+

mozilla/netwerk/cache/public/nsICachedNetData.idl

@@ -0,0 +1,229 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ *
+ * The contents of this file are subject to the Netscape 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/NPL/
+ *
+ * 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.org code.
+ *
+ * The Initial Developer of the Original Code is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation. All
+ * Rights Reserved.
+ *
+ * Contributor(s): 
+ */
+
+#include "nsrootidl.idl"
+#include "nsISupports.idl"
+
+interface nsIFileSpec;
+interface nsIURI;
+interface nsIObserver;
+interface nsIChannel;
+interface nsINetDataCache;
+interface nsINetDataCacheRecord;
+interface nsILoadGroup;
+interface nsIStreamListener;
+
+/**
+ * The nsICachedNetData interface represents a single entry in a database that
+ * caches data retrieved from the network. This interface is implemented by the
+ * cache manager on top of the low-level nsINetDataCacheRecord and
+ * nsINetDataCache interfaces that are implemented by the database.
+ *
+ * Each cache record may contain both content and metadata.  The content may
+ * be, for example, GIF image data or HTML, and it is accessed through
+ * nsIChannel's streaming API.  The opaque metadata, which may contain HTTP
+ * headers among other things, is stored as a byte array.  Each entry in the
+ * cache is indexed by two different keys: a record id number and a key created
+ * by combining the URI with a "secondary key", e.g. HTTP post data.
+ *
+ * @See nsINetDataCacheRecord
+ * @See nsINetDataCache
+ * @See nsINetDataDiskCache
+ * @See nsINetDataCacheManager
+ */
+[scriptable, uuid(6aeb2a40-6d43-11d3-90c8-000064657374)]
+interface nsICachedNetData : nsISupports
+{
+    /**
+     * String form of the URI provided as an argument to the call to
+     * nsINetDataCacheManager::GetCachedNetData() that created this record.
+     */
+    readonly attribute string uriSpec;
+    
+    /**
+     * Getter for the opaque secondary database key provided as an argument to
+     * the call to nsINetDataCacheManager::GetCachedNetData() that created this
+     * record.
+     */
+    void getSecondaryKey(out unsigned long length,
+                         [retval, size_is(length)] out string secondaryKey);
+
+    /**
+     * This flag may be set by a protocol handler to indicate that it supports
+     * partial fetching of data.  In that case, the cache manager is permitted
+     * to truncate the entry's content to accommodate incoming data for other
+     * cache entries rather than deleting it wholesale.
+     */
+    attribute boolean allowPartial;
+    
+    /**
+     * This flag indicates that the write stream supplying content data for the
+     * cache did not complete normally and, therefore, the content may be
+     * truncated.
+     */
+    readonly attribute boolean partialFlag;
+
+    /**
+     * This flag can be set and cleared by a protocol handler as a form of
+     * self-notification, so as to avoid race conditions in which a protocol
+     * handler issues two identical network requests to fill the same cache
+     * entry.  The cache manager itself largely ignores this flag.
+     */
+    attribute boolean updateInProgress;
+
+    /**
+     * inUse is set if any existing channels are associated with this cache
+     * entry or if the updateInProgess flag is set.  This can be used to
+     * prevent writing to a cache entry by a protocol handler if it's being
+     * read or written elsewhere.
+     */
+    readonly attribute boolean inUse;
+
+    /**
+     * Date/time that the document was last stored on the origin server, as
+     * supplied by the protocol handler.  This value is used as input to the
+     * cache replacement policy, i.e. it is not used for validation.  If the
+     * protocol can't supply a last-modified time, this attribute should remain
+     * unset.  When unset, the value of this attribute is zero.
+     *
+     * FIXME: Should use nsIDateTime interface, once it's created
+     * instead of PRTime, for improved scriptability ? 
+     */
+    attribute PRTime lastModifiedTime;
+
+    /**
+     * Supplied by the protocol handler, the expirationTime attribute specifies
+     * the time until which the document is guaranteed fresh, i.e. the document
+     * does not have to be validated with the server and, therefore, any data
+     * in cache is definitely usable.  The value of this attribute serves as a
+     * hint to the cache replacement policy.  Only one of either staleTime or
+     * expirationTime may be set for a single cache record.  When unset, the
+     * value of this attribute is zero. 
+     */
+    attribute PRTime expirationTime;
+
+    /**
+     * Date/time supplied by the protocol handler, at which point the content
+     * is *likely* to be stale, i.e. the data in the cache may be out-of-date
+     * with respect to the data on the server.  This heuristic date does not
+     * necessarily correspond to the HTTP Expires header, as it does not
+     * determine when cached network data must be validated with the origin
+     * server, but only serves as a hint to the cache replacement policy.  Only
+     * one of either staleTime or expirationTime may be set for a single cache
+     * record.  When unset, the value of this attribute is zero.
+     */
+    attribute PRTime staleTime;
+
+    /**
+     * Date/time of last access of the data in this cache record, as determined
+     * by the cache manager.
+     */
+    readonly attribute PRTime lastAccessTime;
+
+    /**
+     * Number of times this record has been accessed since it was first stored.
+     */
+    readonly attribute PRUint16 numberAccesses;
+
+    /**
+     * Accessor methods for opaque meta-data which can be read and updated
+     * independently of the content data.
+     *
+     * The aTag argument can be used to accommodate multiple clients of the
+     * cache API, each of which wants to store its own private meta-data into
+     * the cache.  For example, there could be a "headers" tag that the HTTP
+     * protocol handler uses to store http response headers and a "image size"
+     * tag used to store the image dimensions of a GIF file.  The aData
+     * argument refers to an opaque blob of arbitrary bytes.
+     *
+     * IMPORTANT: If aData does not contain byte-oriented data, i.e. it's not a
+     *            string, the contents of aData must be byte-swapped by the,
+     *            caller, so as to make the cache files endian-independent.
+     */
+    void getAnnotation(in string aTag, 
+                       out PRUint32 aLength, [size_is(aLength), retval] out string aData);
+    void setAnnotation(in string aTag,
+                       in  PRUint32 aLength, [size_is(aLength)] in string aData);
+
+    /**
+     * As a getter, return the number of content bytes stored in the cache,
+     * i.e. via the nsIChannel streaming APIs.  This may be less than the
+     * complete content length if a partial cache fill occurred.  The cached
+     * content can be truncated by setting the value of this attribute.  The
+     * value of the attribute represents a logical, not a physical, length.  If
+     * compression has been used, the content may consume less storage than
+     * indicated by this attribute.
+     *
+     * When this attribute is set to zero the associated cache disk file, if
+     * any, should be deleted.
+     */
+    attribute PRUint32 storedContentLength;
+
+    /** 
+     * Notify any observers associated with this cache entry of the deletion
+     * request.  If all observers drop their reference to the cache entry,
+     * proceed to delete the underlying cache database record and associated
+     * content storage.
+     */
+    void delete();
+
+    /**
+     * Flush any changes in this entry's data to the cache database.  This
+     * method will automatically be called when the last reference to the cache
+     * is dropped, but it can also be called explicitly for a synchronous
+     * effect.
+     */
+    void commit();
+
+    /**
+     * Parent container cache for this entry.
+     */
+    readonly attribute nsINetDataCache cache;
+
+    /**
+     * Create a channel for reading or writing a stream of content into the
+     * entry.  It is expected that many of the nsIChannel methods return
+     * NS_NOT_IMPLEMENTED, including:
+     *
+     *    + GetURI()
+     *    + GetContentType()
+     *    + GetContentLength()
+     *
+     * Though nsIChannel provides for both async and synchronous I/O APIs, both
+     * may not be implemented.  Only AsyncRead() and OpenOutputStream() is
+     * required.  The aProxyChannel argument allows another channel to be
+     * specified as the proffered argument to nsIStreamListener methods rather
+     * than the cache's own channel.
+     */
+    nsIChannel newChannel(in nsILoadGroup aLoadGroup,
+                          in nsIChannel aProxyChannel);
+
+    /**
+     * This method can be used by a caching protocol handler to store data in
+     * the cache by forking an asynchronous read stream so that it is
+     * simultaneously sent to a requester and written into the cache.  This
+     * method implicitly sets the updateInProgress flag, if it has not already
+     * been set.
+     */
+    nsIStreamListener interceptAsyncRead(in nsIStreamListener aOriginalListener,
+                                         in PRUint32 aStartOffset);
+};

mozilla/netwerk/cache/public/nsINetDataCache.idl

@@ -0,0 +1,143 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ *
+ * The contents of this file are subject to the Netscape 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/NPL/
+ *
+ * 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.org code.
+ *
+ * The Initial Developer of the Original Code is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation. All
+ * Rights Reserved.
+ *
+ * Contributor(s): 
+ */
+
+#include "nsISupports.idl"
+
+interface nsIURI;
+interface nsINetDataCacheRecord;
+interface nsISimpleEnumerator;
+interface nsIFileSpec;
+
+/**
+ * The nsINetDataCache defines the low-level API for a network-data
+ * cache, used to cache the responses to network retrieval commands.
+ * This interface, along with nsINetDataCacheRecord, is implemented by
+ * the memory cache, the file cache and, optionally, by some extension
+ * caches.  This interface is essentially a pseudo-private API for the
+ * cache manager.  Other clients should never use this interface.
+ *
+ * Each cache entry may contain both content, e.g. GIF image data, and
+ * associated metadata, e.g. HTTP headers.  Each entry is indexed by two
+ * different keys: a record id number and a key created by combining the URI
+ * with a "secondary key", e.g. HTTP post data.
+ *
+ * The nsINetDataCache interface is agnostic as to where the data is
+ * stored and whether the storage is volatile or persistent.  The
+ * memory cache, any disk caches and any extension caches must all
+ * implement this interface.
+ *
+ */
+[scriptable, uuid(ccfc58c0-6dde-11d3-90c8-000064657374)]
+interface nsINetDataCache : nsISupports
+{
+	/**
+	 * Human-readable description of the cache module, e.g. "Disk Cache"
+	 */
+	readonly attribute wstring description;
+  
+    /**
+     * Returns true if cached data is available for the given opaque key,
+     * even if only partial data is stored.
+     */
+    boolean contains([size_is(length)] in string key, in PRUint32 length);
+
+    /**
+     * Fetch the cache entry record for the given opaque key.  If one does not
+     * exist, create a new, empty record.
+     */
+    nsINetDataCacheRecord getCachedNetData([size_is(length)] in string key,
+                                           in PRUint32 length);
+
+    /**
+     * Fetch the cache entry record for the given URI using the record ID as a key.
+     */
+    nsINetDataCacheRecord getCachedNetDataByID(in PRInt32 RecordID);
+
+	/**
+	 * False indicates that this cache is entirely bypassed.
+	 */
+    attribute boolean enabled;
+
+    /**
+     * Constants for flags attribute, below
+     */
+
+    // Used for extension caches, e.g. a CD-ROM cache
+    const long READ_ONLY          = 1 << 0;
+
+    // One of these bits must be set
+    const long MEMORY_CACHE       = 1 << 1;
+    const long FLAT_FILE_CACHE    = 1 << 2;
+    const long FILE_PER_URL_CACHE = 1 << 3;
+
+	/**
+	 * See constants defined above.
+	 */
+	readonly attribute PRUint32 flags;
+
+    /**
+     * Total number of URI entries stored in the cache.
+     */
+    readonly attribute PRUint32 numEntries;
+
+    /**
+     * Maximum number of URI entries that may be stored in the cache.
+     */
+    readonly attribute PRUint32 maxEntries;
+
+    /**
+     * Enumerate the URI entries stored in the cache.
+     */
+    nsISimpleEnumerator newCacheEntryIterator();
+
+	/**
+	 * Contains a reference to the next cache in search order.  For the memory
+	 * cache, this attribute always references the disk cache.  For the disk
+	 * cache, it contains a reference to the first extension cache.
+	 */
+    attribute nsINetDataCache nextCache;
+
+    /**
+     * An estimate of the amount of storage occupied by the cache, in kB.
+     * Actual use may be slightly higher than reported due to cache overhead
+     * and heap fragmentation (in the memory cache) or block quantization (in
+     * the disk cache).
+	 */
+    readonly attribute PRUint32 storageInUse;
+
+    /**
+     * Remove all entries from a writable cache.  This could be used, for
+     * example, after a guest ends a browser session.  This is equivalent to
+     * setting the cache's Capacity to zero, except that all cache entries,
+     * even those in active use, will be deleted.  Also, any global cache
+     * database files will be deleted.
+	 */
+    void removeAll();
+};
+
+%{ C++
+// ProgID prefix for Components that implement this interface
+#define NS_NETWORK_CACHE_PROGID "component://netscape/network/cache"
+#define NS_NETWORK_MEMORY_CACHE_PROGID NS_NETWORK_CACHE_PROGID "?name=memory-cache"
+#define NS_NETWORK_FLAT_CACHE_PROGID   NS_NETWORK_CACHE_PROGID "?name=flat-cache"
+#define NS_NETWORK_FILE_CACHE_PROGID   NS_NETWORK_CACHE_PROGID "?name=file-cache"
+%}

mozilla/netwerk/cache/public/nsINetDataCacheManager.idl

@@ -0,0 +1,163 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ *
+ * The contents of this file are subject to the Netscape 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/NPL/
+ *
+ * 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.org code.
+ *
+ * The Initial Developer of the Original Code is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation. All
+ * Rights Reserved.
+ *
+ * Contributor(s): 
+ */
+
+#include "nsISupports.idl"
+
+interface nsISimpleEnumerator;
+interface nsICachedNetData;
+interface nsINetDataCache;
+interface nsINetDataDiskCache;
+interface nsIURI;
+interface nsIFileSpec;
+
+/**
+ * The network-response cache manager is partly responsible for the caching of
+ * content and associated metadata that has been retrieved via the network.
+ * (The remaining responsibility for caching lies with individual network
+ * protocol handlers.)
+ *
+ * The cache manager supervises the actions of individual cache components,
+ * such as the memory cache, the disk cache and any extension caches, e.g. a
+ * read-only CD-ROM cache.
+ *
+ * @See nsINetDataCache
+ * @See nsICachedNetData
+ */
+[scriptable, uuid(71c8ab00-6d5c-11d3-90c8-000064657374)]
+interface nsINetDataCacheManager : nsISupports
+{
+    /**
+     * Flag for the GetCachedNetData() method: If set, the memory cache is
+     * neither searched nor will any data be stored into it.  This might be
+     * appropriate, for example, with images, because they have their own
+     * cache for storing *decoded* images.
+     */
+    const unsigned long BYPASS_MEMORY_CACHE       = 1 << 0;
+
+    /**
+     * Flag for the GetCachedNetData() method: If set, the disk cache
+     * is neither searched nor will any be data stored into it.
+     * However, read-only extension caches may be searched.  This
+     * might be used to avoid leaving persistent records of secure
+     * data.
+     */
+    const unsigned long BYPASS_PERSISTENT_CACHE   = 1 << 1;
+
+    /**
+     * Flag for the GetCachedNetData() method: If set, any stream
+     * content is stored in the cache as a single disk file.  Content
+     * will not be cached in the memory cache nor is it cached in a
+     * flat-file cache database.  This is used to implement the jar
+     * protocol handler and to provide the stream-as-file semantics
+     * required by the classic bowser plugin API.
+     */
+    const unsigned long CACHE_AS_FILE             = 1 << 2;
+
+    /**
+     * Fetch the cache entry record for the given URI.  If one does not exist,
+     * create a new, empty record.  The normal search order for caches is:
+     *   + Memory cache
+     *   + Disk cache
+     *   + File cache (stream-as-file cache)
+     *   + All extension caches
+     *
+     * When writing, data is typically stored in both the memory cache and the
+     * disk cache.  Both the search order and this write policy can be modified by
+     * setting one or more of the flag argument bits, as defined above.
+     *
+     * The optionally-NULL secondaryKey argument can be used, e.g. for form
+     * post data or for HTTP headers in the case of HTTP.
+     */
+    nsICachedNetData getCachedNetData(in string uri,
+                                      [size_is(secondaryKeyLength)] in string secondaryKey,
+                                      in PRUint32 secondaryKeyLength,
+                                      in PRUint32 flags);
+
+    /**
+     * Returns true if cached content is available for the given URI, even if
+     * only partial data is stored.  The flags argument behaves the same as for
+     * the GetCachedNetData() method, above.
+     */
+    boolean contains(in string uri,
+                     [size_is(secondaryKeyLength)] in string secondaryKey,
+                     in PRUint32 secondaryKeyLength,
+                     in PRUint32 flags);
+
+    /**
+     * Total number of unexpired URI entries stored in all caches.  This number
+     * does not take into account duplicate URIs, e.g. because the memory cache
+     * and the disk cache might each contain an entry for the same URI.
+     */
+    readonly attribute PRUint32 numEntries;
+
+    /**
+     * Enumerate the unexpired URI entries stored in all caches.  Some URIs may
+     * be enumerated more than once, e.g.  because the the memory cache and the
+     * disk cache might each contain an entry for the same URI.
+     */
+    nsISimpleEnumerator newCacheEntryIterator();
+
+    /*
+     * Enumerate all the loaded nsINetDataCache-implementing cache modules.
+     * The first module enumerated will be the memory cache, the second will be
+     * the disk cache, then the file cache, followed by all the extension
+     * caches, in search order. 
+     */
+    nsISimpleEnumerator newCacheModuleIterator();
+
+    /**
+     * Remove all entries from all writable caches.  This could be used, for
+     * example, after a guest ends a browser session.  This is equivalent to
+     * setting the DiskCacheCapacity to zero, except that all cache entries,
+     * even those in active use, will be deleted.  Also, any global cache
+     * database files will be deleted.
+     */
+    void RemoveAll();
+
+    /**
+     * The disk cache is made up of the file cache (for stream-as-file
+     * requests) and a (possibly independent) persistent cache that handles all
+     * other cache requests.  This attribute sets/gets the combined capacity of
+     * these caches, measured in KBytes.  Setting the capacity lower than the
+     * current amount of space currently in use may cause cache entries to be
+     * evicted from the cache to accomodate the requested capacity.
+     */
+    attribute PRUint32 diskCacheCapacity;
+
+    /**
+     * This attribute sets/gets the capacity of the memory cache, measured in
+     * KBytes.  Setting the capacity lower than the current amount of space
+     * currently in use may cause cache entries to be evicted from the cache to
+     * accomodate the requested capacity.
+     */
+    attribute PRUint32 memCacheCapacity;
+
+	/**
+	 * This attribute must be set before attempting to store into the disk cache.
+	 */
+    attribute nsIFileSpec diskCacheFolder;
+};
+
+%{ C++
+// ProgID prefix for Components that implement this interface
+#define NS_NETWORK_CACHE_MANAGER_PROGID NS_NETWORK_CACHE_PROGID "?name=manager"
+%}

mozilla/netwerk/cache/public/nsINetDataCacheRecord.idl

@@ -0,0 +1,125 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ *
+ * The contents of this file are subject to the Netscape 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/NPL/
+ *
+ * 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.org code.
+ *
+ * The Initial Developer of the Original Code is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation. All
+ * Rights Reserved.
+ *
+ * Contributor(s): 
+ */
+
+#include "nsISupports.idl"
+#include "nsrootidl.idl"
+
+interface nsIFileSpec;
+interface nsIChannel;
+interface nsINetDataCache;
+
+/**
+ * The nsINetDataCacheRecord represents a single entry in a database that
+ * caches data retrieved from the network. On top of this low-level interface
+ * to the raw record data, the cache manager implements a higher-level record
+ * interface, nsICachedNetData.  Each instance of nsINetDataCacheRecord is
+ * (internally) associated with a parent database, an instance of the
+ * nsINetDataCache interface.  This interface is essentially a pseudo-private
+ * API for the cache manager.  Other clients should never use this interface.
+ *
+ * Each cache record may contain both content and metadata.  The content may
+ * be, for example, GIF image data or HTML, and it is accessed through
+ * nsIChannel's streaming API.  The opaque metadata, which may contain HTTP
+ * headers among other things, is accessed as a contiguous byte array.  Each
+ * entry in the cache is indexed by two different keys: a unique record id
+ * number, generated by the cache, and an opaque string.  The latter contains
+ * the URI and other secondary key information, e.g. HTTP form post key/value
+ * pairs.
+ *
+ * The nsINetDataCacheRecord interface is agnostic as to where the data is
+ * stored and whether the storage is volatile or persistent.  The memory cache,
+ * the disk cache, a flat-file cache and any read-only extension caches must
+ * all implement this interface.
+ *
+ * @See nsICachedNetData
+ * @See nsINetDataCache
+ * @See nsINetDataDiskCache
+ * @See nsINetDataCacheManager
+ */
+
+interface nsILoadGroup;
+
+[scriptable, uuid(fdcdd6a0-7461-11d3-90ca-0040056a906e)]
+interface nsINetDataCacheRecord : nsISupports
+{
+    /**
+     * As far as the nsINetDataCacheRecord implementation is concerned, the
+     * cache entry database key is an opaque blob, but it's intended to contain
+     * both the URI and any secondary keys, such as HTTP post data.
+     */
+    void getKey(out unsigned long length, [size_is(length), retval] out string key);
+
+    /**
+     * A persistent record number assigned by the cache which must be unique
+     * among all entries stored within the same cache.  The record ID serves as
+     * an alternate key to the cache record.  Providing that they satisfy the
+     * afforementioned uniqueness requirement, record IDs can be assigned any
+     * value by the database except that they may never be zero.
+     */
+    readonly attribute PRInt32 recordID;
+
+    /**
+     * Opaque data which can be updated for each cache entry independently of
+     * the content data.  This data is a combination of protocol-independent
+     * data provided by the cache manager and protocol-specific meta-data,
+     * e.g. HTTP headers.
+     */
+    void getMetaData(out PRUint32 length, [size_is(length), retval] out string metaData);
+    void setMetaData(in  PRUint32 length, [size_is(length)] in string data);
+
+    /**
+     * Number of content bytes stored in the cache, i.e. via the nsIChannel
+     * streaming APIs.  This may be less than the complete content length if a
+     * partial cache fill occurred.  Additionally, the cached content can be
+     * truncated by reducing the value of this attribute.  When this attribute
+     * is set to zero the associated cache disk file, if any, should be
+     * deleted.
+     */
+    attribute PRUint32 storedContentLength;
+
+    /** 
+     * Delete this cache entry and its associated content.
+     */
+    void delete();
+
+    /**
+     * Create a channel for reading or writing a stream of content into the
+     * entry.  However, many of the nsIChannel methods may return
+     * NS_NOT_IMPLEMENTED, including:
+     *
+     *    + GetURI()
+     *    + GetContentType()
+     *    + GetContentLength()
+     */
+    nsIChannel newChannel(in nsILoadGroup loadGroup);
+
+    /**
+     * If a cache is implemented such that it stores each URI's content in an
+     * individual disk file, this method will identify the file corresponding
+     * to this record.  This may be used to implement the "stream-as-file"
+     * semantics required by some plugins and by the 'jar:' protocol handler.
+     * However, not all cache implementations are *required* to store the data
+     * from each URI in an individual file, so it is acceptable for an
+     * implementation of this method to signal NS_NOT_IMPLEMENTED.
+     */
+    readonly attribute nsIFileSpec filename;
+};

mozilla/netwerk/cache/public/nsINetDataDiskCache.idl

@@ -0,0 +1,42 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ *
+ * The contents of this file are subject to the Netscape 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/NPL/
+ *
+ * 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.org code.
+ *
+ * The Initial Developer of the Original Code is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation. All
+ * Rights Reserved.
+ *
+ * Contributor(s): 
+ */
+
+#include "nsINetDataCache.idl"
+
+interface nsIFileSpec;
+
+/**
+/**
+ * A network-data disk cache is used to persistently cache the responses to
+ * network retrieval commands.  Each cache entry may contain both content,
+ * e.g. GIF image data, and associated metadata, e.g. HTTP headers.
+ */
+[scriptable, uuid(6408e390-6f13-11d3-90c8-000064657374)]
+interface nsINetDataDiskCache : nsINetDataCache
+{
+	/**
+	 * This attribute must be set before calling any other methods of this
+	 * interface.
+	 */
+    attribute nsIFileSpec diskCacheFolder;
+};
+

mozilla/netwerk/cache/public/nsIStreamAsFile.idl

@@ -0,0 +1,106 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ *
+ * The contents of this file are subject to the Netscape 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/NPL/
+ *  
+ * 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 Netscape are
+ * Copyright (C) 1999 Netscape Communications Corporation. All
+ * Rights Reserved.
+ * 
+ * Contributor(s): 
+ *   Scott Furman, fur@netscape.com
+ */
+#include "nsrootidl.idl"
+#include "nsISupports.idl"
+
+interface nsIFileSpec;
+interface nsIStreamAsFileObserver;
+
+/**
+ * In addition to enhancing effective network response time via caching, the
+ * cache manager serves a second purpose by providing the stream-as-file
+ * service required by traditional browser plugins and the jar: protocol
+ * handler.  The interface below provides a means for a client to determine the
+ * filename associated with a stream and to detect modification/deletion of
+ * that file.
+ */
+[scriptable, uuid(0eedbbf0-92d9-11d3-90d3-0040056a906e)]
+interface nsIStreamAsFile : nsISupports
+{
+    /**
+     * Filename containing stream-as-file
+     */
+    readonly attribute nsIFileSpec fileSpec;
+
+    /**
+     * Add an observer for this cache record.  When the cache wants to delete
+     * or truncate a record, so as to make space for another cache entry's
+     * content data, it will call <code>aObserver</code>'s Observe() method,
+     * passing the nsIStreamAsFile instance as the <code>aSubject</code>
+     * argument and an appropriate message.  If the observer does not wish to
+     * inhibit deletion/truncation, it should Release() any references it has to the
+     * cache record.
+     *
+     * @See nsIStreamAsFileObserver
+     */
+    void addObserver(in nsIStreamAsFileObserver aObserver);
+
+    /**
+     * Delete an observer that was added by the AddObserver() method.
+     */
+    void removeObserver(in nsIStreamAsFileObserver aObserver);
+};
+
+/**
+ * This interface can be implemented by a client to receive notifications of
+ * either modification or deletion of a file created by the cache manager using
+ * the stream-as-file semantics.
+ */
+[scriptable, uuid(a26e27c0-92da-11d3-90d3-0040056a906e)]
+interface nsIStreamAsFileObserver : nsISupports
+{
+    /**
+     * Flag bits for argument to Observe() method.
+     */
+    const long NOTIFY_AVAILABLE    = 1 << 0; // Stream-as-file now available for reading
+    const long NOTIFY_ERROR        = 1 << 1; // Error while loading stream / creating file
+    const long REQUEST_DELETION    = 1 << 2; // Cache manager wishes to delete/truncate file
+    const long INVALIDATE          = 1 << 3; // File is out-of-date
+
+    // Convenience value
+    const long MAKE_UNAVAILABLE    = REQUEST_DELETION | INVALIDATE;
+    
+    /**
+     * Receive either a notification or a request concerning a file that has
+     * been opened using stream-as-file.  The aMessage and aError arguments
+     * have varying values depending on the nature of the notification.
+     * aMessage is set to NOTIFY_AVAILABLE when a complete stream has been read
+     * and stored on disk in a file.  At that point, and no sooner, may the
+     * filename attribute of the associated nsIStreamAsFile be accessed via the
+     * associated nsIStreamAsFile interface.  If the aMessage argument is
+     * NOTIFY_ERROR, the aError argument contains the relevant error code.  If
+     * the aMessage argument is either REQUEST_DELETION or REQUEST_TRUNCATION,
+     * the callee should immediately Release() all references to the
+     * nsIStreamAsFile (and any references to its associated nsICachedNetData
+     * instances), unless it wishes to inhibit the requested file modification.
+     * If the aMessage argument is INVALIDATE, the cache manager is replacing
+     * the file with a more recent version.  If a client wants to continue
+     * using the (now out-of-date) file, it must delete it when it has finished,
+     * as the cache manager will effectively relinquished ownership of the
+     * file.
+     */
+    void ObserveStreamAsFile(in nsIStreamAsFile aStreamAsFile,
+			     in PRUint32 aMessage,
+			     in nsresult aError);
+};

mozilla/netwerk/makefile.win

@@ -0,0 +1,39 @@
+#!gmake
+#
+# The contents of this file are subject to the Netscape 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/NPL/
+#
+# 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.org code.
+#
+# The Initial Developer of the Original Code is Netscape
+# Communications Corporation.  Portions created by Netscape are
+# Copyright (C) 1998 Netscape Communications Corporation. All
+# Rights Reserved.
+#
+# Contributor(s): 
+
+DEPTH = ..
+
+MODULE = necko
+
+DIRS=            \
+	base     \
+	dns      \
+	build    \
+	protocol \
+	socket   \
+	util     \
+	mime     \
+	streamconv \
+	cache    \
+	test     \
+	$(NULL)
+
+include <$(DEPTH)\config\rules.mak>

mozilla/netwerk/protocol/http/public/nsIHTTPHeader.idl

@@ -0,0 +1,32 @@
+/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ *
+ * The contents of this file are subject to the Netscape 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/NPL/
+ *
+ * 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.org code.
+ *
+ * The Initial Developer of the Original Code is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation. All
+ * Rights Reserved.
+ *
+ * Contributor(s): 
+ */
+
+#include "nsISupports.idl"
+
+interface nsIAtom;
+                  
+[scriptable, uuid(a3ec67f0-465a-11d3-9a89-0080c7cb1080)]
+interface nsIHTTPHeader : nsISupports
+{
+    nsIAtom GetField();
+    string GetValue();
+};

mozilla/netwerk/test/TestCacheMgr.cpp

@@ -0,0 +1,603 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ *
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+
+#include "nsIStreamListener.h"
+#include "nsIStreamObserver.h"
+#include "nsIServiceManager.h"
+#include "nsIInputStream.h"
+#include "nsIOutputStream.h"
+#include "nsIEventQueue.h"
+#include "nsIEventQueueService.h"
+#include "nsIChannel.h"
+#include "nsCOMPtr.h"
+
+#include "nsINetDataCache.h"
+#include "nsINetDataCacheManager.h"
+#include "nsICachedNetData.h"
+
+
+// Number of test entries to be placed in the cache
+// FIXME - temporary
+#define NUM_CACHE_ENTRIES  25
+
+// Cache content stream length will have random length between zero and
+// MAX_CONTENT_LENGTH bytes
+#define MAX_CONTENT_LENGTH 20000
+
+// Limits, converted to KB
+#define DISK_CACHE_CAPACITY  ((MAX_CONTENT_LENGTH * 4) >> 10)
+#define MEM_CACHE_CAPACITY   ((MAX_CONTENT_LENGTH * 3) >> 10)
+
+// Length of random-data cache entry URI key
+#define CACHE_KEY_LENGTH 13
+
+// Length of random-data cache entry secondary key
+#define CACHE_SECONDARY_KEY_LENGTH 10
+
+// Length of random-data cache entry meta-data
+#define CACHE_PROTOCOL_PRIVATE_LENGTH 10
+
+// Mapping from test case number to RecordID
+static PRInt32 recordID[NUM_CACHE_ENTRIES];
+
+static PRInt32
+mapRecordIdToTestNum(PRInt32 aRecordID)
+{
+    int i;
+    for (i = 0; i < NUM_CACHE_ENTRIES; i++) {
+        if (recordID[i] == aRecordID)
+            return i;
+    }
+    return -1;
+}
+
+// A supply of stream data to either store or compare with
+class nsITestDataStream {
+public:
+    virtual ~nsITestDataStream() {};
+    virtual PRUint32 Next() = 0;
+    virtual void Read(char* aBuf, PRUint32 aCount) = 0;
+    virtual void ReadString(char* aBuf, PRUint32 aCount) = 0;
+
+    virtual PRBool Match(char* aBuf, PRUint32 aCount) = 0;
+    virtual PRBool MatchString(char* aBuf, PRUint32 aCount) = 0;
+    virtual void Skip(PRUint32 aCount) = 0;
+    virtual void SkipString(PRUint32 aCount) = 0;
+};
+
+// A reproducible stream of random data.
+class RandomStream : public nsITestDataStream {
+public:
+    RandomStream(PRUint32 aSeed) {
+        mStartSeed = mState = aSeed;
+    }
+    
+    PRUint32 GetStartSeed() {
+        return mStartSeed;
+    }
+    
+    PRUint32 Next() {
+        mState = 1103515245 * mState + 12345 ^ (mState >> 16);
+        return mState;
+    }
+
+    PRUint8 NextChar() {
+        PRUint8 c;
+        do {
+            c = Next();
+        } while (!isalnum(c));
+        return c;
+    }
+
+    void Read(char* aBuf, PRUint32 aCount) {
+        PRUint32 i;
+        for (i = 0; i < aCount; i++) {
+            *aBuf++ = Next();
+        }
+    }
+
+    // Same as Read(), but using only printable chars and
+    //   with a terminating NUL
+    void ReadString(char* aBuf, PRUint32 aCount) {
+        PRUint32 i;
+        for (i = 0; i < aCount; i++) {
+            *aBuf++ = NextChar();
+        }
+        *aBuf = 0;
+    }
+
+    PRBool
+    Match(char* aBuf, PRUint32 aCount) {
+        PRUint32 i;
+        for (i = 0; i < aCount; i++) {
+            if (*aBuf++ != (char)(Next() & 0xff))
+                return PR_FALSE;
+        }
+        return PR_TRUE;
+    }
+
+    PRBool
+    MatchString(char* aBuf, PRUint32 aCount) {
+        PRUint32 i;
+        for (i = 0; i < aCount; i++) {
+            if (*aBuf++ != (char)(NextChar() & 0xff))
+                return PR_FALSE;
+        }
+        
+        // Check for terminating NUL character
+        if (*aBuf)
+            return PR_FALSE;
+        return PR_TRUE;
+    }
+
+    void
+    Skip(PRUint32 aCount) {
+        while (aCount--)
+            Next();
+    }
+
+    void
+    SkipString(PRUint32 aCount) {
+        while (aCount--)
+            NextChar();
+    }
+
+protected:
+    
+    PRUint32 mState;
+    PRUint32 mStartSeed;
+};
+
+static int gNumReaders = 0;
+static PRUint32 gTotalBytesRead = 0;
+static PRUint32 gTotalBytesWritten = 0;
+static PRUint32 gTotalDuration = 0;
+
+class nsReader : public nsIStreamListener {
+public:
+    NS_DECL_ISUPPORTS
+
+    nsReader()
+        : mStartTime(0), mBytesRead(0)
+    {
+        NS_INIT_REFCNT();
+        gNumReaders++;
+    }
+
+    virtual ~nsReader() {
+        delete mTestDataStream;
+        gNumReaders--;
+    }
+
+    nsresult 
+    Init(nsITestDataStream* aRandomStream, PRUint32 aExpectedStreamLength) {
+        mTestDataStream = aRandomStream;
+        mExpectedStreamLength = aExpectedStreamLength;
+        mRefCnt = 1;
+        return NS_OK;
+    }
+
+    NS_IMETHOD OnStartRequest(nsIChannel* channel,
+                              nsISupports* context) {
+        mStartTime = PR_IntervalNow();
+        return NS_OK;
+    }
+
+    NS_IMETHOD OnDataAvailable(nsIChannel* channel, 
+                               nsISupports* context,
+                               nsIInputStream *aIStream, 
+                               PRUint32 aSourceOffset,
+                               PRUint32 aLength) {
+        char buf[1025];
+        while (aLength > 0) {
+            PRUint32 amt;
+            PRBool match;
+            aIStream->Read(buf, sizeof buf, &amt);
+            if (amt == 0) break;
+            aLength -= amt;
+            mBytesRead += amt;
+            match = mTestDataStream->Match(buf, amt);
+            NS_ASSERTION(match, "Stored data was corrupted on read");
+        }
+        return NS_OK;
+    }
+
+    NS_IMETHOD OnStopRequest(nsIChannel* channel, 
+                             nsISupports* context,
+                             nsresult aStatus,
+                             const PRUnichar* aMsg) {
+        PRIntervalTime endTime;
+        PRIntervalTime duration;
+        
+        endTime = PR_IntervalNow();
+        duration = (endTime - mStartTime);
+
+        if (NS_FAILED(aStatus)) printf("channel failed.\n");
+        //        printf("read %d bytes\n", mBytesRead);
+
+        //FIXME        NS_ASSERTION(mBytesRead == mExpectedStreamLength,
+        // "Stream in cache is wrong length");
+
+        gTotalBytesRead += mBytesRead;
+        gTotalDuration += duration;
+
+        return NS_OK;
+    }
+
+protected:
+    PRIntervalTime       mStartTime;
+    PRUint32             mBytesRead;
+    nsITestDataStream*   mTestDataStream;
+    PRUint32             mExpectedStreamLength;
+};
+
+NS_IMPL_ISUPPORTS2(nsReader, nsIStreamListener, nsIStreamObserver)
+
+static nsIEventQueue* eventQueue;
+
+static NS_DEFINE_CID(kEventQueueServiceCID, NS_EVENTQUEUESERVICE_CID);
+
+nsresult
+InitQueue() {
+    nsresult rv;
+
+    NS_WITH_SERVICE(nsIEventQueueService, eventQService, kEventQueueServiceCID, &rv);
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get event queue service");
+
+    rv = eventQService->CreateThreadEventQueue();
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't create event queue");
+  
+    rv = eventQService->GetThreadEventQueue(PR_CurrentThread(), &eventQueue);
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get event queue for main thread");
+
+    return NS_OK;
+}
+
+// Process events until all streams are OnStopRequest'ed
+nsresult
+WaitForEvents() {
+    while (gNumReaders) {
+        eventQueue->ProcessPendingEvents();
+    }
+    return NS_OK;
+}
+
+// Read data for a single cache record and compare against testDataStream
+nsresult
+TestReadStream(nsICachedNetData *cacheEntry, nsITestDataStream *testDataStream,
+               PRUint32 expectedStreamLength)
+{
+    nsCOMPtr<nsIChannel> channel;
+    nsresult rv;
+    PRUint32 actualContentLength;
+
+    rv = cacheEntry->NewChannel(0, 0, getter_AddRefs(channel));
+    NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+
+    rv = cacheEntry->GetStoredContentLength(&actualContentLength);
+    NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+    // FIXME    NS_ASSERTION(actualContentLength == expectedStreamLength,
+    //                 "nsICachedNetData::GetContentLength() busted ?");
+    
+    nsReader *reader = new nsReader;
+    reader->AddRef();
+    rv = reader->Init(testDataStream, expectedStreamLength);
+    NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+    
+    rv = channel->AsyncRead(0, -1, 0, reader);
+    NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+    reader->Release();
+
+    return NS_OK;
+}
+
+// Convert PRTime to unix-style time_t, i.e. seconds since the epoch
+static PRUint32
+convertPRTimeToSeconds(PRTime aTime64)
+{
+    double fpTime;
+    LL_L2D(fpTime, aTime64);
+    return (PRUint32)(fpTime * 1e-6 + 0.5);
+}
+
+// Convert unix-style time_t, i.e. seconds since the epoch, to PRTime
+static PRTime
+convertSecondsToPRTime(PRUint32 aSeconds)
+{
+    PRInt64 t64;
+    LL_L2I(t64, aSeconds);
+    LL_MUL(t64, t64, 1000000);
+    return t64;
+}
+
+// Read the test data that was written in FillCache(), checking for
+// corruption, truncation.
+nsresult
+TestRead(nsINetDataCacheManager *aCache, PRUint32 aFlags)
+{
+    nsresult rv;
+    PRBool inCache;
+    nsCOMPtr<nsICachedNetData> cacheEntry;
+    RandomStream *randomStream;
+    char uriCacheKey[CACHE_KEY_LENGTH];
+    char secondaryCacheKey[CACHE_SECONDARY_KEY_LENGTH];
+    char *storedUriKey;
+    PRUint32 testNum;
+
+    gTotalBytesRead = 0;
+    gTotalDuration = 0;
+    for (testNum = 0; testNum < NUM_CACHE_ENTRIES; testNum++) {
+        randomStream = new RandomStream(testNum);
+        randomStream->ReadString(uriCacheKey, sizeof uriCacheKey - 1);
+        randomStream->Read(secondaryCacheKey, sizeof secondaryCacheKey);
+
+        // Ensure that entry is in the cache
+        rv = aCache->Contains(uriCacheKey,
+                              secondaryCacheKey, sizeof secondaryCacheKey,
+                              aFlags, &inCache);
+        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+        NS_ASSERTION(inCache, "nsINetDataCacheManager::Contains error");
+        
+        rv = aCache->GetCachedNetData(uriCacheKey,
+                                      secondaryCacheKey, sizeof secondaryCacheKey,
+                                      aFlags,
+                                      getter_AddRefs(cacheEntry));
+        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+
+        // Test GetUriSpec() method
+        rv = cacheEntry->GetUriSpec(&storedUriKey);
+        NS_ASSERTION(NS_SUCCEEDED(rv) &&
+                     !memcmp(storedUriKey, &uriCacheKey[0], sizeof uriCacheKey),
+                     "nsICachedNetData::GetKey failed");
+        nsAllocator::Free(storedUriKey);
+
+        // Test GetSecondaryKey() method
+        PRUint32 storedSecondaryKeyLength;
+        char* storedSecondaryKey;
+        rv = cacheEntry->GetSecondaryKey(&storedSecondaryKeyLength, &storedSecondaryKey);
+        NS_ASSERTION(NS_SUCCEEDED(rv) &&
+                     !memcmp(storedSecondaryKey, &secondaryCacheKey[0],
+                             sizeof secondaryCacheKey),
+                     "nsICachedNetData::GetSecondaryKey failed");
+
+        // Compare against stored protocol data
+        char *storedProtocolData;
+        PRUint32 storedProtocolDataLength;
+        rv = cacheEntry->GetAnnotation("test data", &storedProtocolDataLength, &storedProtocolData);
+        NS_ASSERTION(NS_SUCCEEDED(rv) &&
+                     storedProtocolDataLength == CACHE_PROTOCOL_PRIVATE_LENGTH,
+                     "nsICachedNetData::GetAnnotation() failed");
+        randomStream->Match(storedProtocolData, storedProtocolDataLength);
+
+        // Test GetAllowPartial()
+        PRBool allowPartial;
+        rv = cacheEntry->GetAllowPartial(&allowPartial);
+        NS_ASSERTION(NS_SUCCEEDED(rv) &&
+                     (allowPartial == (PRBool)(randomStream->Next() & 1)),
+                     "nsICachedNetData::GetAllowPartial() failed");
+
+        // Test GetExpirationTime()
+        PRTime expirationTime;
+        PRTime expectedExpirationTime = convertSecondsToPRTime(randomStream->Next() & 0xffffff);
+        rv = cacheEntry->GetExpirationTime(&expirationTime);
+
+        NS_ASSERTION(NS_SUCCEEDED(rv) && LL_EQ(expirationTime, expectedExpirationTime),
+                     "nsICachedNetData::GetExpirationTime() failed");
+
+        PRUint32 expectedStreamLength = randomStream->Next() % MAX_CONTENT_LENGTH;
+
+        TestReadStream(cacheEntry, randomStream, expectedStreamLength);
+    }
+
+    WaitForEvents();
+
+    // Compute rate in MB/s
+    double rate = gTotalBytesRead / PR_IntervalToMilliseconds(gTotalDuration);
+    rate *= NUM_CACHE_ENTRIES;
+    rate *= 1000;
+    rate /= (1024 * 1024);
+    printf("Read  %7d bytes at a rate of %5.1f MB per second \n",
+           gTotalBytesRead, rate);
+
+    return NS_OK;
+}
+
+// Create entries in the network data cache, using random data for the
+// key, the meta-data and the stored content data.
+nsresult
+FillCache(nsINetDataCacheManager *aCache, PRUint32 aFlags, PRUint32 aCacheCapacity)
+{
+    nsresult rv;
+    PRBool inCache;
+    nsCOMPtr<nsICachedNetData> cacheEntry;
+    nsCOMPtr<nsIChannel> channel;
+    nsCOMPtr<nsIOutputStream> outStream;
+    nsCOMPtr<nsINetDataCache> containingCache;
+    char buf[1000];
+    PRUint32 protocolDataLength;
+    char cacheKey[CACHE_KEY_LENGTH];
+    char secondaryCacheKey[CACHE_SECONDARY_KEY_LENGTH];
+    char protocolData[CACHE_PROTOCOL_PRIVATE_LENGTH];
+    PRUint32 testNum;
+    RandomStream *randomStream;
+
+    gTotalBytesWritten = 0;
+    PRIntervalTime startTime = PR_IntervalNow();
+    
+    for (testNum = 0; testNum < NUM_CACHE_ENTRIES; testNum++) {
+        randomStream = new RandomStream(testNum);
+        randomStream->ReadString(cacheKey, sizeof cacheKey - 1);
+        randomStream->Read(secondaryCacheKey, sizeof secondaryCacheKey);
+
+        // No entry should be in cache until we add it
+        rv = aCache->Contains(cacheKey,
+                              secondaryCacheKey, sizeof secondaryCacheKey,
+                              aFlags, &inCache);
+        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+        NS_ASSERTION(!inCache, "nsINetDataCacheManager::Contains error");
+        
+        rv = aCache->GetCachedNetData(cacheKey,
+                                      secondaryCacheKey, sizeof secondaryCacheKey,
+                                      aFlags,
+                                      getter_AddRefs(cacheEntry));
+        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't access cacheEntry via cache key");
+
+        // Test nsINetDataCacheManager::GetNumEntries()
+        PRUint32 numEntries = (PRUint32)-1;
+        rv = aCache->GetNumEntries(&numEntries);
+        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get number of cache entries");
+        NS_ASSERTION(numEntries == testNum + 1, "GetNumEntries failure");
+
+        // Record meta-data should be initially empty
+        char *protocolDatap;
+        rv = cacheEntry->GetAnnotation("test data", &protocolDataLength, &protocolDatap);
+        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+        if ((protocolDataLength != 0) || (protocolDatap != 0))
+            return NS_ERROR_FAILURE;
+
+        // Store random data as meta-data
+        randomStream->Read(protocolData, sizeof protocolData);
+        cacheEntry->SetAnnotation("test data", sizeof protocolData, protocolData);
+
+        // Store random data as allow-partial flag
+        PRBool allowPartial = randomStream->Next() & 1;
+        rv = cacheEntry->SetAllowPartial(allowPartial);
+        NS_ASSERTION(NS_SUCCEEDED(rv),
+                     "nsICachedNetData::SetAllowPartial() failed");
+
+        // Store random data as expiration time
+        PRTime expirationTime = convertSecondsToPRTime(randomStream->Next() & 0xffffff);
+        rv = cacheEntry->SetExpirationTime(expirationTime);
+        NS_ASSERTION(NS_SUCCEEDED(rv),
+                     "nsICachedNetData::SetExpirationTime() failed");
+
+        // Cache manager complains if expiration set without setting last-modified time
+        rv = cacheEntry->SetLastModifiedTime(expirationTime);
+
+        rv = cacheEntry->NewChannel(0, 0, getter_AddRefs(channel));
+        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+
+        rv = cacheEntry->GetCache(getter_AddRefs(containingCache));
+        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+
+        rv = channel->OpenOutputStream(0, getter_AddRefs(outStream));
+        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+        
+        int streamLength = randomStream->Next() % MAX_CONTENT_LENGTH;
+        int remaining = streamLength;
+        while (remaining) {
+            PRUint32 numWritten;
+            int amount = PR_MIN(sizeof buf, remaining);
+            randomStream->Read(buf, amount);
+
+            rv = outStream->Write(buf, amount, &numWritten);
+            NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+            NS_ASSERTION(numWritten == (PRUint32)amount, "Write() bug?");
+            
+            remaining -= amount;
+
+            PRUint32 storageInUse;
+            rv = containingCache->GetStorageInUse(&storageInUse);
+            NS_ASSERTION(NS_SUCCEEDED(rv) && (storageInUse <= aCacheCapacity),
+                         "Cache manager failed to limit cache growth");
+        }
+        outStream->Close();
+        gTotalBytesWritten += streamLength;
+
+        // *Now* there should be an entry in the cache
+        rv = aCache->Contains(cacheKey,
+                              secondaryCacheKey, sizeof secondaryCacheKey,
+                              aFlags, &inCache);
+        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+        NS_ASSERTION(inCache, "nsINetDataCacheManager::Contains error");
+
+        delete randomStream;
+    }
+
+    PRIntervalTime endTime = PR_IntervalNow();
+
+    // Compute rate in MB/s
+    double rate = gTotalBytesWritten / PR_IntervalToMilliseconds(endTime - startTime);
+    rate *= 1000;
+    rate /= (1024 * 1024);
+    printf("Wrote %7d bytes at a rate of %5.1f MB per second \n",
+           gTotalBytesWritten, rate);
+
+    return NS_OK;
+}
+
+nsresult NS_AutoregisterComponents()
+{
+  nsresult rv = nsComponentManager::AutoRegister(nsIComponentManager::NS_Startup,
+                                                 NULL /* default */);
+  return rv;
+}
+
+nsresult
+Test(nsINetDataCacheManager *aCache, PRUint32 aFlags, PRUint32 aCacheCapacity)
+{
+    nsresult rv;
+
+    rv = aCache->RemoveAll();
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't clear cache");
+
+    PRUint32 numEntries = (PRUint32)-1;
+    rv = aCache->GetNumEntries(&numEntries);
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get number of cache entries");
+    NS_ASSERTION(numEntries == 0, "Couldn't clear cache");
+
+    rv = FillCache(aCache, aFlags, aCacheCapacity);
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't fill cache with random test data");
+
+    rv = TestRead(aCache, aFlags);
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't read random test data from cache");
+
+    rv = aCache->RemoveAll();
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't clear cache");
+
+    rv = aCache->GetNumEntries(&numEntries);
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get number of cache entries");
+    NS_ASSERTION(numEntries == 0, "Couldn't clear cache");
+
+    return 0;
+}
+int
+main(int argc, char* argv[])
+{
+    nsresult rv;
+    nsCOMPtr<nsINetDataCacheManager> cache;
+
+    rv = NS_AutoregisterComponents();
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't register XPCOM components");
+
+    rv = nsComponentManager::CreateInstance(NS_NETWORK_CACHE_MANAGER_PROGID,
+                                            nsnull,
+                                            NS_GET_IID(nsINetDataCacheManager),
+                                            getter_AddRefs(cache));
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't create cache manager factory") ;
+
+    cache->SetDiskCacheCapacity(DISK_CACHE_CAPACITY);
+    cache->SetMemCacheCapacity(MEM_CACHE_CAPACITY);
+
+    InitQueue();
+    
+    Test(cache, nsINetDataCacheManager::BYPASS_PERSISTENT_CACHE, MEM_CACHE_CAPACITY);
+    Test(cache, nsINetDataCacheManager::BYPASS_MEMORY_CACHE, DISK_CACHE_CAPACITY);
+    return 0;
+}
+

mozilla/netwerk/test/TestRawCache.cpp

@@ -0,0 +1,820 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ *
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+
+#include "nsIStreamListener.h"
+#include "nsIStreamObserver.h"
+#include "nsIServiceManager.h"
+#include "nsIInputStream.h"
+#include "nsIOutputStream.h"
+#include "nsIEventQueue.h"
+#include "nsIEventQueueService.h"
+#include "nsIChannel.h"
+#include "nsCOMPtr.h"
+#include "nsString.h"
+#include <stdio.h>
+
+#include "nsINetDataCache.h"
+#include "nsINetDataDiskCache.h"
+#include "nsINetDataCacheRecord.h"
+#include "nsMemCacheCID.h"
+// file cache include
+#include "nsNetDiskCacheCID.h"
+#include "nsIPref.h"
+#include "prenv.h"
+#include "nsIFileStream.h"
+
+
+// Number of test entries to be placed in the cache
+#define NUM_CACHE_ENTRIES  250
+
+// Cache content stream length will have random length between zero and
+// MAX_CONTENT_LENGTH bytes
+#define MAX_CONTENT_LENGTH 20000
+
+// Length of random-data cache entry key
+#define CACHE_KEY_LENGTH 15
+
+// Length of random-data cache entry meta-data
+#define CACHE_METADATA_LENGTH 100
+
+static NS_DEFINE_CID(kMemCacheCID, NS_MEM_CACHE_FACTORY_CID);
+static NS_DEFINE_CID(kEventQueueServiceCID, NS_EVENTQUEUESERVICE_CID);
+
+// file cache cid
+static NS_DEFINE_CID(kDiskCacheCID, NS_NETDISKCACHE_CID) ;
+static NS_DEFINE_CID(kPrefCID, NS_PREF_CID);
+static NS_DEFINE_IID(kIPrefIID, NS_IPREF_IID);
+
+// Mapping from test case number to RecordID
+static PRInt32 recordID[NUM_CACHE_ENTRIES];
+
+static PRInt32
+mapRecordIdToTestNum(PRInt32 aRecordID)
+{
+    int i;
+    for (i = 0; i < NUM_CACHE_ENTRIES; i++) {
+        if (recordID[i] == aRecordID)
+            return i;
+    }
+    return -1;
+}
+
+// A supply of stream data to either store or compare with
+class nsITestDataStream {
+public:
+    virtual ~nsITestDataStream() {};
+    virtual PRUint32 Next() = 0;
+    virtual void Read(char* aBuf, PRUint32 aCount) = 0;
+
+    virtual PRBool Match(char* aBuf, PRUint32 aCount) = 0;
+    virtual void Skip(PRUint32 aCount) = 0;
+};
+
+// A reproducible stream of random data.
+class RandomStream : public nsITestDataStream {
+public:
+    RandomStream(PRUint32 aSeed) {
+        mStartSeed = mState = aSeed;
+    }
+    
+    PRUint32 GetStartSeed() {
+        return mStartSeed;
+    }
+    
+    PRUint32 Next() {
+        mState = 1103515245 * mState + 12345;
+        return mState;
+    }
+
+    void Read(char* aBuf, PRUint32 aCount) {
+        PRUint32 i;
+        for (i = 0; i < aCount; i++) {
+            *aBuf++ = Next();
+        }
+    }
+
+    PRBool
+    Match(char* aBuf, PRUint32 aCount) {
+        PRUint32 i;
+        for (i = 0; i < aCount; i++) {
+            if (*aBuf++ != (char)(Next() & 0xff))
+                return PR_FALSE;
+        }
+        return PR_TRUE;
+    }
+
+    void
+    Skip(PRUint32 aCount) {
+        while (aCount--)
+            Next();
+    }
+
+protected:
+    
+    PRUint32 mState;
+    PRUint32 mStartSeed;
+};
+
+// A stream of data that increments on each byte that is read, modulo 256
+class CounterStream : public nsITestDataStream {
+public:
+    CounterStream(PRUint32 aSeed) {
+        mStartSeed = mState = aSeed;
+    }
+    
+    PRUint32 GetStartSeed() {
+        return mStartSeed;
+    }
+    
+    PRUint32 Next() {
+        mState += 1;
+        mState &= 0xff;
+        return mState;
+    }
+
+    void Read(char* aBuf, PRUint32 aCount) {
+        PRUint32 i;
+        for (i = 0; i < aCount; i++) {
+            *aBuf++ = Next();
+        }
+    }
+
+    PRBool
+    Match(char* aBuf, PRUint32 aCount) {
+        PRUint32 i;
+        for (i = 0; i < aCount; i++) {
+            if (*aBuf++ != (char)Next())
+                return PR_FALSE;
+        }
+        return PR_TRUE;
+    }
+
+    void
+    Skip(PRUint32 aCount) {
+        mState += aCount;
+        mState &= 0xff;
+    }
+
+protected:
+    
+    PRUint32 mState;
+    PRUint32 mStartSeed;
+};
+
+static int gNumReaders = 0;
+static PRUint32 gTotalBytesRead = 0;
+static PRUint32 gTotalDuration = 0;
+
+class nsReader : public nsIStreamListener {
+public:
+    NS_DECL_ISUPPORTS
+
+    nsReader()
+        : mStartTime(0), mBytesRead(0)
+    {
+        NS_INIT_REFCNT();
+        gNumReaders++;
+    }
+
+    virtual ~nsReader() {
+        delete mTestDataStream;
+        gNumReaders--;
+    }
+
+    nsresult 
+    Init(nsITestDataStream* aRandomStream, PRUint32 aExpectedStreamLength) {
+        mTestDataStream = aRandomStream;
+        mExpectedStreamLength = aExpectedStreamLength;
+        mRefCnt = 1;
+        return NS_OK;
+    }
+
+    NS_IMETHOD OnStartRequest(nsIChannel* channel,
+                              nsISupports* context) {
+        mStartTime = PR_IntervalNow();
+        return NS_OK;
+    }
+
+    NS_IMETHOD OnDataAvailable(nsIChannel* channel, 
+                               nsISupports* context,
+                               nsIInputStream *aIStream, 
+                               PRUint32 aSourceOffset,
+                               PRUint32 aLength) {
+        char buf[1025];
+        while (aLength > 0) {
+            PRUint32 amt;
+            PRBool match;
+            aIStream->Read(buf, sizeof buf, &amt);
+            if (amt == 0) break;
+            aLength -= amt;
+            mBytesRead += amt;
+            match = mTestDataStream->Match(buf, amt);
+            NS_ASSERTION(match, "Stored data was corrupted on read");
+        }
+        return NS_OK;
+    }
+
+    NS_IMETHOD OnStopRequest(nsIChannel* channel, 
+                             nsISupports* context,
+                             nsresult aStatus,
+                             const PRUnichar* aMsg) {
+        PRIntervalTime endTime;
+        PRIntervalTime duration;
+        
+        endTime = PR_IntervalNow();
+        duration = (endTime - mStartTime);
+
+        if (NS_FAILED(aStatus)) printf("channel failed.\n");
+        //        printf("read %d bytes\n", mBytesRead);
+
+        NS_ASSERTION(mBytesRead == mExpectedStreamLength,
+                     "Stream in cache is wrong length");
+
+        gTotalBytesRead += mBytesRead;
+        gTotalDuration += duration;
+
+        return NS_OK;
+    }
+
+protected:
+    PRIntervalTime       mStartTime;
+    PRUint32             mBytesRead;
+    nsITestDataStream*   mTestDataStream;
+    PRUint32             mExpectedStreamLength;
+};
+
+NS_IMPL_ISUPPORTS2(nsReader, nsIStreamListener, nsIStreamObserver)
+
+static nsIEventQueue* eventQueue;
+
+nsresult
+InitQueue() {
+    nsresult rv;
+
+    NS_WITH_SERVICE(nsIEventQueueService, eventQService, kEventQueueServiceCID, &rv);
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get event queue service");
+
+    rv = eventQService->CreateThreadEventQueue();
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't create event queue");
+  
+    rv = eventQService->GetThreadEventQueue(PR_CurrentThread(), &eventQueue);
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get event queue for main thread");
+
+    return NS_OK;
+}
+
+// Process events until all streams are OnStopRequest'ed
+nsresult
+WaitForEvents() {
+    while (gNumReaders) {
+        eventQueue->ProcessPendingEvents();
+    }
+    return NS_OK;
+}
+
+// Read data for a single cache record and compare against testDataStream
+nsresult
+TestReadStream(nsINetDataCacheRecord *record, nsITestDataStream *testDataStream,
+               PRUint32 expectedStreamLength)
+{
+    nsCOMPtr<nsIChannel> channel;
+    nsresult rv;
+    PRUint32 actualContentLength;
+
+    rv = record->NewChannel(0, getter_AddRefs(channel));
+    NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+
+    rv = record->GetStoredContentLength(&actualContentLength);
+    NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+    NS_ASSERTION(actualContentLength == expectedStreamLength,
+                 "nsINetDataCacheRecord::GetContentLength() busted ?");
+    
+    nsReader *reader = new nsReader;
+    rv = reader->Init(testDataStream, expectedStreamLength);
+    NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+    
+    rv = channel->AsyncRead(0, -1, 0, reader);
+    NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+    reader->Release();
+
+    return NS_OK;
+}
+
+// Check that records can be retrieved using their record-ID, in addition
+// to using the opaque key.
+nsresult
+TestRecordID(nsINetDataCache *cache)
+{
+    nsresult rv;
+    nsCOMPtr<nsINetDataCacheRecord> record;
+    RandomStream *randomStream;
+    PRUint32 metaDataLength;
+    char cacheKey[CACHE_KEY_LENGTH];
+    char *metaData;
+    PRUint32 testNum;
+    PRBool match;
+
+    for (testNum = 0; testNum < NUM_CACHE_ENTRIES; testNum++) {
+        randomStream = new RandomStream(testNum);
+        randomStream->Read(cacheKey, sizeof cacheKey);
+
+        rv = cache->GetCachedNetDataByID(recordID[testNum], getter_AddRefs(record));
+        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't obtain record using record ID");
+
+        // Match against previously stored meta-data
+        rv = record->GetMetaData(&metaDataLength, &metaData);
+        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get record meta-data");
+        match = randomStream->Match(metaData, metaDataLength);
+        NS_ASSERTION(match, "Meta-data corrupted or incorrect");
+
+        nsAllocator::Free(metaData);
+        delete randomStream;
+    }
+    return NS_OK;
+}
+
+// Check that all cache entries in the database are enumerated and that
+// no duplicates appear.
+nsresult
+TestEnumeration(nsINetDataCache *cache)
+{
+    nsresult rv;
+    nsCOMPtr<nsINetDataCacheRecord> record;
+    nsCOMPtr<nsISupports> tempISupports;
+    nsCOMPtr<nsISimpleEnumerator> iterator;
+    RandomStream *randomStream;
+    PRUint32 metaDataLength;
+    char cacheKey[CACHE_KEY_LENGTH];
+    char *metaData;
+    PRUint32 testNum;
+    PRBool match;
+    PRInt32 recID;
+
+    int numRecords = 0;
+
+    // Iterate over all records in the cache
+    rv = cache->NewCacheEntryIterator(getter_AddRefs(iterator));
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't create new cache entry iterator");
+
+    PRBool notDone;
+    while (1) {
+
+        // Done iterating ?
+        rv = iterator->HasMoreElements(&notDone);
+        if (NS_FAILED(rv)) return rv;
+        if (!notDone)
+            break;
+
+        // Get next record in iteration
+        rv = iterator->GetNext(getter_AddRefs(tempISupports));
+        NS_ASSERTION(NS_SUCCEEDED(rv), "iterator bustage");
+        record = do_QueryInterface(tempISupports);
+
+        numRecords++;
+
+        // Get record ID
+        rv = record->GetRecordID(&recID);
+        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get Record ID");
+        testNum = mapRecordIdToTestNum(recID);
+        NS_ASSERTION(testNum != -1, "Corrupted Record ID ?");
+
+        // Erase mapping from table, so that duplicate enumerations are detected
+        recordID[testNum] = -1;
+
+        // Make sure stream matches test data
+        randomStream = new RandomStream(testNum);
+        randomStream->Read(cacheKey, sizeof cacheKey);
+
+        // Match against previously stored meta-data
+        rv = record->GetMetaData(&metaDataLength, &metaData);
+        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get record meta-data");
+        match = randomStream->Match(metaData, metaDataLength);
+        NS_ASSERTION(match, "Meta-data corrupted or incorrect");
+        nsAllocator::Free(metaData);
+
+        delete randomStream;
+    }
+
+    NS_ASSERTION(numRecords == NUM_CACHE_ENTRIES, "Iteration bug");
+
+    return NS_OK;
+}
+
+// Read the test data that was written in FillCache(), checking for
+// corruption, truncation.
+nsresult
+TestRead(nsINetDataCache *cache)
+{
+    nsresult rv;
+    PRBool inCache;
+    nsCOMPtr<nsINetDataCacheRecord> record;
+    RandomStream *randomStream;
+    PRUint32 metaDataLength;
+    char cacheKey[CACHE_KEY_LENGTH];
+    char *metaData, *storedCacheKey;
+    PRUint32 testNum, storedCacheKeyLength;
+    PRBool match;
+
+    for (testNum = 0; testNum < NUM_CACHE_ENTRIES; testNum++) {
+        randomStream = new RandomStream(testNum);
+        randomStream->Read(cacheKey, sizeof cacheKey);
+
+        // Ensure that entry is in the cache
+        rv = cache->Contains(cacheKey, sizeof cacheKey, &inCache);
+        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+        NS_ASSERTION(inCache, "nsINetDataCache::Contains error");
+        
+        rv = cache->GetCachedNetData(cacheKey, sizeof cacheKey, getter_AddRefs(record));
+        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+
+        // Match against previously stored meta-data
+        match = record->GetMetaData(&metaDataLength, &metaData);
+        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+        match = randomStream->Match(metaData, metaDataLength);
+        NS_ASSERTION(match, "Meta-data corrupted or incorrect");
+        nsAllocator::Free(metaData);
+
+        // Test GetKey() method
+        rv = record->GetKey(&storedCacheKeyLength, &storedCacheKey);
+        NS_ASSERTION(NS_SUCCEEDED(rv) &&
+                     (storedCacheKeyLength == sizeof cacheKey) &&
+                     !memcmp(storedCacheKey, &cacheKey[0], sizeof cacheKey),
+                     "nsINetDataCacheRecord::GetKey failed");
+        nsAllocator::Free(storedCacheKey);
+
+        PRUint32 expectedStreamLength = randomStream->Next() % MAX_CONTENT_LENGTH;
+
+        TestReadStream(record, randomStream, expectedStreamLength);
+    }
+
+    WaitForEvents();
+
+    // Compute rate in MB/s
+    double rate = gTotalBytesRead / PR_IntervalToMilliseconds(gTotalDuration);
+    rate *= NUM_CACHE_ENTRIES;
+    rate *= 1000;
+    rate /= (1024 * 1024);
+    printf("Read %d bytes at a rate of %5.1f MB per second \n",
+           gTotalBytesRead, rate);
+
+    return NS_OK;
+}
+
+// Repeatedly call SetStoredContentLength() on a cache entry and make
+// read the stream's data to ensure that it's not corrupted by the effect
+nsresult
+TestTruncation(nsINetDataCache *cache)
+{
+    nsresult rv;
+    nsCOMPtr<nsINetDataCacheRecord> record;
+    RandomStream *randomStream;
+    char cacheKey[CACHE_KEY_LENGTH];
+
+    randomStream = new RandomStream(0);
+    randomStream->Read(cacheKey, sizeof cacheKey);
+
+    rv = cache->GetCachedNetData(cacheKey, sizeof cacheKey, getter_AddRefs(record));
+    NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+
+    randomStream->Skip(CACHE_METADATA_LENGTH);
+    PRUint32 initialStreamLength = randomStream->Next() % MAX_CONTENT_LENGTH;
+    delete randomStream;
+
+    PRUint32 i;
+    PRUint32 delta = initialStreamLength / 64;
+    for (i = initialStreamLength; i >= delta; i -= delta) {
+        PRUint32 expectedStreamLength = i;
+
+        // Do the truncation
+        record->SetStoredContentLength(expectedStreamLength);
+        randomStream = new RandomStream(0);
+        randomStream->Skip(CACHE_KEY_LENGTH + CACHE_METADATA_LENGTH + 1);
+
+        PRUint32 afterContentLength;
+        rv = record->GetStoredContentLength(&afterContentLength);
+        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+
+        NS_ASSERTION(afterContentLength == expectedStreamLength,
+                     "nsINetDataCacheRecord::SetContentLength() failed to truncate record");
+
+        TestReadStream(record, randomStream, expectedStreamLength);
+        WaitForEvents();
+    }
+
+    return NS_OK;
+}
+
+// Write known data to random offsets in a single cache entry and test
+// resulting stream for correctness.
+nsresult
+TestOffsetWrites(nsINetDataCache *cache)
+{
+    nsresult rv;
+    nsCOMPtr<nsINetDataCacheRecord> record;
+    nsCOMPtr<nsIChannel> channel;
+    nsCOMPtr<nsIOutputStream> outStream;
+    char buf[512];
+    char cacheKey[CACHE_KEY_LENGTH];
+    RandomStream *randomStream;
+
+    randomStream = new RandomStream(0);
+    randomStream->Read(cacheKey, sizeof cacheKey);
+
+    rv = cache->GetCachedNetData(cacheKey, sizeof cacheKey, getter_AddRefs(record));
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't access record via opaque cache key");
+
+
+    // Write buffer-fulls of data at random offsets into the cache entry.
+    // Data written is (offset % 0xff)
+    PRUint32 startingOffset;
+    PRUint32 streamLength = 0;
+    CounterStream *counterStream;
+    int i;
+    for (i = 0; i < 100; i++) {
+        rv = record->NewChannel(0, getter_AddRefs(channel));
+        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+
+        startingOffset = streamLength ? streamLength - (randomStream->Next() % sizeof buf): 0;
+        rv = channel->OpenOutputStream(startingOffset, getter_AddRefs(outStream));
+        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+        
+        counterStream = new CounterStream(startingOffset);
+        counterStream->Read(buf, sizeof buf);
+
+        PRUint32 numWritten;
+        rv = outStream->Write(buf, sizeof buf, &numWritten);
+        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+        NS_ASSERTION(numWritten == sizeof buf, "Write() bug?");
+        streamLength = startingOffset + sizeof buf;
+
+        rv = outStream->Close();
+        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't close channel");
+        delete counterStream;
+    }
+    
+    delete randomStream;
+
+    counterStream = new CounterStream(0);
+    TestReadStream(record, counterStream, streamLength);
+    WaitForEvents();
+
+    return NS_OK;
+}
+
+// Create entries in the network data cache, using random data for the
+// key, the meta-data and the stored content data.
+nsresult
+FillCache(nsINetDataCache *cache)
+{
+    nsresult rv;
+    PRBool inCache;
+    nsCOMPtr<nsINetDataCacheRecord> record;
+    nsCOMPtr<nsIChannel> channel;
+    nsCOMPtr<nsIOutputStream> outStream;
+    char buf[1000];
+    PRUint32 metaDataLength;
+    char cacheKey[CACHE_KEY_LENGTH];
+    char metaData[CACHE_METADATA_LENGTH];
+    PRUint32 testNum;
+    char *data;
+    RandomStream *randomStream;
+    PRUint32 totalBytesWritten = 0;
+
+    PRIntervalTime startTime = PR_IntervalNow();
+    
+    for (testNum = 0; testNum < NUM_CACHE_ENTRIES; testNum++) {
+        randomStream = new RandomStream(testNum);
+        randomStream->Read(cacheKey, sizeof cacheKey);
+
+        // No entry should be in cache until we add it
+        rv = cache->Contains(cacheKey, sizeof cacheKey, &inCache);
+        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+        NS_ASSERTION(!inCache, "nsINetDataCache::Contains error");
+        
+        rv = cache->GetCachedNetData(cacheKey, sizeof cacheKey, getter_AddRefs(record));
+        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't access record via opaque cache key");
+
+        // Test nsINetDataCacheRecord::GetRecordID()
+        rv = record->GetRecordID(&recordID[testNum]);
+        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get Record ID");
+
+        // Test nsINetDataCache::GetNumEntries()
+        PRUint32 numEntries = (PRUint32)-1;
+        rv = cache->GetNumEntries(&numEntries);
+        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get number of cache entries");
+        NS_ASSERTION(numEntries == testNum + 1, "GetNumEntries failure");
+
+        // Record meta-data should be initially empty
+        rv = record->GetMetaData(&metaDataLength, &data);
+        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+        if ((metaDataLength != 0) || (data != 0))
+            return NS_ERROR_FAILURE;
+
+        // Store random data as meta-data
+        randomStream->Read(metaData, sizeof metaData);
+        record->SetMetaData(sizeof metaData, metaData);
+
+        rv = record->NewChannel(0, getter_AddRefs(channel));
+        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+
+        rv = channel->OpenOutputStream(0, getter_AddRefs(outStream));
+        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+        
+        PRUint32 beforeOccupancy;
+        rv = cache->GetStorageInUse(&beforeOccupancy);
+        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get cache occupancy");
+
+        int streamLength = randomStream->Next() % MAX_CONTENT_LENGTH;
+        int remaining = streamLength;
+        while (remaining) {
+            PRUint32 numWritten;
+            int amount = PR_MIN(sizeof buf, remaining);
+            randomStream->Read(buf, amount);
+
+            rv = outStream->Write(buf, amount, &numWritten);
+            NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+            NS_ASSERTION(numWritten == (PRUint32)amount, "Write() bug?");
+            
+            remaining -= amount;
+        }
+        outStream->Close();
+        totalBytesWritten += streamLength;
+
+        PRUint32 afterOccupancy;
+        rv = cache->GetStorageInUse(&afterOccupancy);
+        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get cache occupancy");
+        PRUint32 streamLengthInKB = streamLength >> 10;
+        NS_ASSERTION((afterOccupancy - beforeOccupancy) >= streamLengthInKB,
+                     "nsINetDataCache::GetStorageInUse() is busted");
+        
+
+        // *Now* there should be an entry in the cache
+        rv = cache->Contains(cacheKey, sizeof cacheKey, &inCache);
+        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
+        NS_ASSERTION(inCache, "nsINetDataCache::Contains error");
+
+        delete randomStream;
+    }
+
+    PRIntervalTime endTime = PR_IntervalNow();
+
+    // Compute rate in MB/s
+    double rate = totalBytesWritten / PR_IntervalToMilliseconds(endTime - startTime);
+    rate *= 1000;
+    rate /= (1024 * 1024);
+    printf("Wrote %7d bytes at a rate of %5.1f MB per second \n",
+           totalBytesWritten, rate);
+
+    return NS_OK;
+}
+
+nsresult NS_AutoregisterComponents()
+{
+  nsresult rv = nsComponentManager::AutoRegister(nsIComponentManager::NS_Startup,
+                                                 NULL /* default */);
+  return rv;
+}
+
+PRBool initPref ()
+{
+    nsresult rv;
+    NS_WITH_SERVICE(nsIPref, prefPtr, kPrefCID, &rv);
+    if (NS_FAILED(rv))
+        return false;
+               
+    nsCOMPtr<nsIFileSpec> fileSpec;
+    rv = NS_NewFileSpec (getter_AddRefs(fileSpec));
+    if (NS_FAILED(rv))
+        return false;
+                            
+    nsCString defaultPrefFile = PR_GetEnv ("MOZILLA_FIVE_HOME");
+    if (defaultPrefFile.Length())
+        defaultPrefFile += "/";
+    else
+        defaultPrefFile = "./";
+    defaultPrefFile += "default_prefs.js";
+                                                 
+    fileSpec->SetUnixStyleFilePath (defaultPrefFile.GetBuffer());
+                                                    
+    PRBool exists = false;
+    fileSpec->Exists(&exists);
+    if (exists)
+        prefPtr->ReadUserPrefsFrom(fileSpec);
+    else
+        return false;
+    return true;
+}
+
+int
+main(int argc, char* argv[])
+{
+    nsresult rv;
+
+    if(argc <2) {
+      printf(" %s -f to test filecache\n", argv[0]) ;
+      printf(" %s -m to test memcache\n", argv[0]) ;
+      return -1 ;
+    }
+
+
+    rv = NS_AutoregisterComponents();
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't register XPCOM components");
+
+    nsCOMPtr<nsINetDataCache> cache;
+
+    if (PL_strcasecmp(argv[1], "-m") == 0) {
+        rv = nsComponentManager::CreateInstance(kMemCacheCID, nsnull,
+                                            NS_GET_IID(nsINetDataCache),
+                                            getter_AddRefs(cache));
+        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't create memory cache factory");
+    } else if (PL_strcasecmp(argv[1], "-f") == 0) {
+
+        nsCOMPtr<nsINetDataDiskCache> diskcache ;
+
+        rv = nsComponentManager::CreateInstance(kDiskCacheCID, nsnull,
+                                            NS_GET_IID(nsINetDataDiskCache),
+                                             getter_AddRefs(diskcache));
+        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't create disk cache factory") ;
+        
+        nsCOMPtr<nsIFileSpec> folder ;
+        NS_NewFileSpec(getter_AddRefs(folder)) ;
+        folder->SetUnixStyleFilePath("/tmp") ;
+        diskcache->SetDiskCacheFolder(folder) ;
+
+        cache = diskcache ;
+
+    } else {
+      printf("  %s -f to test filecache\n", argv[0]) ;
+      printf(" %s -m to test memcache\n", argv[0]) ;
+      return -1 ;
+    }
+
+    InitQueue();
+
+    PRUnichar* description;
+    rv = cache->GetDescription(&description);
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get cache description");
+    nsCAutoString descStr(description);
+    printf("Testing: %s\n", descStr.GetBuffer());
+
+    rv = cache->RemoveAll();
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't clear cache");
+
+    PRUint32 startOccupancy;
+    rv = cache->GetStorageInUse(&startOccupancy);
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get cache occupancy");
+
+    PRUint32 numEntries = (PRUint32)-1;
+    rv = cache->GetNumEntries(&numEntries);
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get number of cache entries");
+    NS_ASSERTION(numEntries == 0, "Couldn't clear cache");
+
+    rv = FillCache(cache);
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't fill cache with random test data");
+
+    rv = TestRead(cache);
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't read random test data from cache");
+
+    rv = TestRecordID(cache);
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't index records using record ID");
+
+    rv = TestEnumeration(cache);
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't successfully enumerate records");
+
+    rv = TestTruncation(cache);
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't successfully truncate records");
+
+    rv = TestOffsetWrites(cache);
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't successfully write to records using non-zero offsets");
+
+    rv = cache->RemoveAll();
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't clear cache");
+    rv = cache->GetNumEntries(&numEntries);
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get number of cache entries");
+    NS_ASSERTION(numEntries == 0, "Couldn't clear cache");
+
+    PRUint32 endOccupancy;
+    rv = cache->GetStorageInUse(&endOccupancy);
+
+    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get cache occupancy");
+
+    NS_ASSERTION(startOccupancy == endOccupancy, "Cache occupancy not correctly computed ?");
+
+    return 0;
+}
+

mozilla/netwerk/test/makefile.win

@@ -0,0 +1,82 @@
+#!nmake
+#
+# The contents of this file are subject to the Netscape 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/NPL/
+#
+# 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.org code.
+#
+# The Initial Developer of the Original Code is Netscape
+# Communications Corporation.  Portions created by Netscape are
+# Copyright (C) 1998 Netscape Communications Corporation. All
+# Rights Reserved.
+#
+# Contributor(s): 
+
+DEPTH=..\..
+
+MAKE_OBJ_TYPE	= EXE
+PROG1 = .\$(OBJDIR)\TestFileInput.exe
+PROG2 = .\$(OBJDIR)\TestSocketInput.exe
+PROG3 = .\$(OBJDIR)\TestSocketIO.exe
+PROG4 = .\$(OBJDIR)\TestProtocols.exe
+PROG5 = .\$(OBJDIR)\TestSocketTransport.exe
+PROG6 = .\$(OBJDIR)\urltest.exe
+PROG7 = .\$(OBJDIR)\TestFileInput2.exe
+PROG8 = .\$(OBJDIR)\TestFileTransport.exe
+PROG9 = .\$(OBJDIR)\TestRes.exe
+PROGA = .\$(OBJDIR)\TestRawCache.exe
+PROGB = .\$(OBJDIR)\TestCacheMgr.exe
+PROGRAMS = \
+#$(PROG1) $(PROG2) $(PROG3) $(PROG4) $(PROG5) $(PROG6) $(PROG7) $(PROG8) $(PROG9)\
+          $(PROGA) $(PROGB)
+
+LCFLAGS=-DUSE_NSREG -GX
+
+REQUIRES=libreg
+
+INCS = $(INCS)                  \
+        -I$(DEPTH)\dist\include \
+        $(NULL)
+
+LLIBS=                 \
+ $(DIST)\lib\xpcom.lib \
+ $(LIBNSPR)            \
+ $(NULL)
+
+include <$(DEPTH)\config\rules.mak>
+
+install:: $(PROGRAMS)
+	-for %p in ($(PROGRAMS)) do $(MAKE_INSTALL) %p $(DIST)\bin
+
+clobber::
+	-for %p in ($(PROGRAMS)) do $(RM) %p $(DIST)\bin\%p
+
+$(PROG1): $(OBJDIR) TestFileInput.cpp
+
+$(PROG2): $(OBJDIR) TestSocketInput.cpp
+
+$(PROG3): $(OBJDIR) TestSocketIO.cpp
+
+$(PROG4): $(OBJDIR) TestProtocols.cpp
+
+$(PROG5): $(OBJDIR) TestSocketTransport.cpp
+
+$(PROG6): $(OBJDIR) urltest.cpp
+
+$(PROG7): $(OBJDIR) TestFileInput2.cpp
+
+$(PROG8): $(OBJDIR) TestFileTransport.cpp
+
+$(PROG9): $(OBJDIR) TestRes.cpp
+
+$(PROGA): $(OBJDIR) TestRawCache.cpp
+
+$(PROGB): $(OBJDIR) TestCacheMgr.cpp
+

mozilla/webtools/litmus/.htaccess

@@ -1,3 +0,0 @@
-<FilesMatch ^(.*localconfig.*)$>
-  deny from all
-</FilesMatch>

mozilla/webtools/litmus/INSTALL

@@ -1,44 +0,0 @@
-===Litmus Installation Instructions===
-
-First of all, let me convince you that you in fact probbaly do not want
-to install Litmus. Litmus is not 1.0 software. Litmus is not even 0.5
-software. In fact, Litmus doesn't really do any of the things you would
-expect it to do yet.
-
-In summary, if you're not looking to install Litmus because you are or
-want to be a Litmus developer, you'd best turn around and go back from
-whence you came.
-
-If at any point you find that you don't understand these installation
-instructions, it's a good sign you want to turn back as well.
-
-Required Perl Modules: 
-Class::DBI 
-Class::DBI::mysql 
-Template 
-Time::Piece 
-Time::Piece::mysql 
-Time::Seconds
-Date::Manip
-HTML::StripScripts
-HTML::StripScripts::Parser
-Text::Markdown
-XML::XPath
-
-Once you've got everything installed, run: mysql < createdb.sql to
-create the Litmus database.
-
-Then edit Litmus/Config.pm to give it the information it needs to
-connect to the database.
-
-Run ./populatedb.pl to create products, testgroups, subgroups, etc...
-There is no UI at present for doing this.
-
-Edit the newly created 'localconfig' file and provide your database 
-configuration. 
-
-Then just pop the whole thing into a directory where your web server can
-get at it. Have fun!
-
-Note: After upgrading Litmus, it's a good idea to run populatedb.pl
-again to pick up any schema changes that may have occured. 

mozilla/webtools/litmus/Litmus.pm

@@ -1,109 +0,0 @@
-# -*- mode: cperl; c-basic-offset: 8; indent-tabs-mode: nil; -*-
-
-=head1 COPYRIGHT
-
- # ***** BEGIN LICENSE BLOCK *****
- # Version: MPL 1.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 Litmus.
- #
- # The Initial Developer of the Original Code is
- # the Mozilla Corporation.
- # Portions created by the Initial Developer are Copyright (C) 2006
- # the Initial Developer. All Rights Reserved.
- #
- # Contributor(s):
- #   Chris Cooper <ccooper@deadsquid.com>
- #   Zach Lipton <zach@zachlipton.com>
- #   Max Kanat-Alexander <mkanat@bugzilla.org>
- #
- # ***** END LICENSE BLOCK *****
-
-=cut
-
-# Global object store and function library for Litmus
-
-package Litmus;
-
-use strict;
-
-use Litmus::Template;
-use Litmus::Config;
-use Litmus::Error;
-use Litmus::Auth;
-use Litmus::CGI;
-
-our $_request_cache = {};
-
-# each cgi _MUST_ call Litmus->init() prior to doing anything else.
-# init() ensures that the installation has not been disabled, deals with pending 
-# login requests, and other essential tasks.
-sub init() {
-	if ($Litmus::Config::disabled) {
-  	  	my $c = new CGI();
-    	print $c->header();
-    	print "Litmus has been shutdown by the administrator. Please try again later.";
-    	exit;
-	}
-	# check for pending logins:
-	my $c = cgi();
-	if ($c->param("login_type")) {
-		Litmus::Auth::processLoginForm();
-	}
-}
-
-# Global Template object
-sub template() {
-    my $class = shift;
-    request_cache()->{template} ||= Litmus::Template->create();
-    return request_cache()->{template};
-}
-
-# Global CGI object
-sub cgi() {
-    my $class = shift;
-    request_cache()->{cgi} ||= new Litmus::CGI();
-    return request_cache()->{cgi};
-}
-
-sub getCurrentUser {
-	return Litmus::Auth::getCurrentUser();
-}
-
-# cache of global variables for a single request only
-# use me like: Litmus->request_cache->{'var'} = 'foo';
-# entries here are guarenteed to get flushed when the request ends, 
-# even when running under mod_perl
-# from Bugzilla.pm:
-sub request_cache {
-    if ($ENV{MOD_PERL}) {
-        my $request = Apache->request();
-        my $cache = $request->pnotes();
-        # Sometimes mod_perl doesn't properly call DESTROY on all
-        # the objects in pnotes(), so we register a cleanup handler
-        # to make sure that this happens.
-        if (!$cache->{cleanup_registered}) {
-             $request->push_handlers(PerlCleanupHandler => sub {
-                 my $r = shift;
-                 foreach my $key (keys %{$r->pnotes}) {
-                     delete $r->pnotes->{$key};
-                 }
-             });
-             $cache->{cleanup_registered} = 1;
-        }
-        return $cache;
-    }
-    return $_request_cache;
-}
-
-1;

mozilla/webtools/litmus/Litmus/Auth.pm

@@ -1,555 +0,0 @@
-# -*- mode: cperl; c-basic-offset: 8; indent-tabs-mode: nil; -*-
-
-=head1 COPYRIGHT
-
- # ***** BEGIN LICENSE BLOCK *****
- # Version: MPL 1.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 Litmus.
- #
- # The Initial Developer of the Original Code is
- # the Mozilla Corporation.
- # Portions created by the Initial Developer are Copyright (C) 2006
- # the Initial Developer. All Rights Reserved.
- #
- # Contributor(s):
- #   Chris Cooper <ccooper@deadsquid.com>
- #   Zach Lipton <zach@zachlipton.com>
- #
- # ***** END LICENSE BLOCK *****
-
-=cut
-
-package Litmus::Auth;
-
-use strict;
-
-# IMPORTANT! 
-## You _must_ call Litmus::Auth methods before sending a Content-type
-## header so that any required cookies can be sent.
-
-require Exporter;
-use Litmus::Error;
-use Time::Piece;
-use Time::Seconds;
-use Litmus::DB::User;
-
-use CGI;
-
-our @ISA = qw(Exporter);
-our @EXPORT = qw();
-
-my $logincookiename = $Litmus::Config::user_cookiename;
-my $cookie_expire_days = 7;
-
-# Given a username and password, validate the login. Returns the 
-# Litmus::DB::User object associated with the username if the login 
-# is sucuessful. Returns false otherwise.
-sub validate_login($$) {
-  my $username = shift;
-  my $password = shift;
-
-  return 0 if (!$username or $username eq '' or 
-               !$password or $password eq '');
-
-  my ($userobj) = Litmus::DB::User->search(email => $username);
-
-  if (!$userobj) { 
-    return 0; 
-  } 
-
-  if (!$userobj->enabled() || $userobj->enabled() == 0) { 
-    die "Account ".$userobj->username()." has been disabled by the administrator"; 
-  }
-	
-  # for security reasons, we use the real (correct) crypt'd passwd
-  # as the salt:
-  my $realPasswordCrypted = $userobj->getRealPasswd();
-  return 0 if (!$realPasswordCrypted or $realPasswordCrypted eq '');
-  my $enteredPasswordCrypted = crypt($password, $realPasswordCrypted);
-  if ($enteredPasswordCrypted eq $realPasswordCrypted) {
-    return $userobj;
-  } else {
-    return 0;
-  }
-}
-
-# Used by a CGI when a login is required to proceed beyond a certain point.
-# requireLogin() will return a Litmus::User object to indicate that the user 
-# is logged in, or it will redirect to a login page to allow the login to be 
-# completed. Once the login is complete, the user will be redirected back to 
-# $return_to and any parameters in the current CGI.pm object will be passed 
-# to the new script. 
-#
-sub requireLogin {
-  my $return_to = shift;
-  my $admin_login_required = shift;
-  my $cgi = Litmus->cgi();
-
-  # see if we are already logged in:
-  my $user = getCurrentUser();
-  return $user if $user; # well, that was easy...
-
-  my $vars = {
-              title => "Login",
-              return_to => $return_to,
-              adminrequired => $admin_login_required,
-              params => $cgi,
-             };
-
-  print $cgi->header();
-  Litmus->template()->process("auth/login.html.tmpl", $vars) ||
-    internalError(Litmus->template()->error());
-  
-  exit;	
-}
-
-# Used by a CGI in much the same way as requireLogin() when the user must
-# be an admin to proceed.
-sub requireAdmin {
-  my $return_to = shift;
-  my $cgi = Litmus->cgi();
-  
-  my $user = requireLogin($return_to, 1);
-  if (!$user || !$user->is_admin()) { 
-  	print $cgi->header();
-    basicError("You must be a Litmus administrator to perform this function.");
-  }
-  return $user;
-}
-
-# Returns the current Litmus::DB::Session object corresponding to the current 
-# logged-in user, or 0 if no valid session exists
-sub getCurrentSession() {
-	my $c = Litmus->cgi();
-	
-	# we're actually processing the login form right now, so the cookie hasn't
-	# been sent yet...
-	if (Litmus->request_cache->{'curSession'}) { 
-		return Litmus->request_cache->{'curSession'}; 
-	} 
-	
-	my $sessionCookie = $c->cookie($logincookiename);
-  	if (! $sessionCookie) {
-    	return 0
-    }
-  
-	my @sessions = Litmus::DB::Session->search(sessioncookie => $sessionCookie);
-	my $session = $sessions[0];
-	if (! $session) { return 0 }
-  
-	# see if it's still valid and that the user hasn't been disabled
-	if (! $session->isValid()) { return 0 }
-  
-	return $session;
-}
-
-# Returns the Litmus::User object corresponding to the current logged-in
-# user, or 0 if no valid login cookie exists
-sub getCurrentUser() {
-	my $session = getCurrentSession();
-	
-	if ($session) {
-		return $session->user_id();
-	} else {
-		return 0;
-	}
-}
-
-
-#
-# ONLY NON-PUBLIC API BEYOND THIS POINT
-#
-
-# Processes data from a login form (auth/login.html.tmpl) using data 
-# from the current Litmus::CGI object in use. When complete, returns the 
-# flow of control to the script the user wanted to reach before the login,
-# setting a login cookie for the user.
-sub processLoginForm {
-  my $c = Litmus->cgi();
-  
-  my $type = $c->param("login_type");
-  
-  if ($c->param("accountCreated")  && 
-      $c->param("accountCreated") eq "true") {
-    # make sure they really are logged in and didn't just set
-    # the accountCreated flag:
-    requireLogin("index.cgi");
-    return; # we're done here
-  }
-  
-  if ($type eq "litmus") {
-    my $username = $c->param("email");
-    my $password = $c->param("password");
-    
-    my $user = validate_login($username, $password);
-    
-    if (!$user) {
-      loginError($c, "Username/Password incorrect. Please try again.");
-    }
-    
-    my $session = makeSession($user);
-    $c->storeCookie(makeCookie($session));
-    
-  } elsif ($type eq "newaccount") {
-    my $email = $c->param("email");
-    my $name = $c->param("realname");
-    my $password = $c->param("password"); 
-    my $nickname = $c->param("irc_nickname");
-    
-    # some basic form-field validation:
-    my $emailregexp = q:^[\\w\\.\\+\\-=]+@[\\w\\.\\-]+\\.[\\w\\-]+$:;
-    if (! $email || ! $email =~ /$emailregexp/) {
-      loginError($c, "You must enter a valid email address");
-    }
-    if (! $password eq $c->param("password_confirm")) {
-      loginError($c, "Passwords do not match. Please try again.");
-    }
-
-    my @users = Litmus::DB::User->search(email => $email);
-    if ($users[0]) {
-      loginError($c, "User ".$users[0]->email() ." already exists.");
-    }
-    if ($nickname and $nickname ne '') {
-      @users = Litmus::DB::User->search(irc_nickname => $nickname);
-      if ($users[0]) {
-        loginError($c, "An account with that IRC nickname already exists.");
-      }
-    } else {
-      $nickname = undef;
-    }
-    
-    my $userobj = 
-      Litmus::DB::User->create({email => $email, 
-                                password => bz_crypt($password),
-                                bugzilla_uid => 0,
-                                realname => $name,
-                                enabled => 1, 
-                                is_admin => 0,
-                                irc_nickname => $nickname
-                               });
-    
-    my $session = makeSession($userobj);
-    $c->storeCookie(makeCookie($session));
-    
-    my $vars = {
-                title => "Account Created",
-                email => $email,
-                realname => $name,
-                return_to => $c->param("login_loc"),
-                params => $c
-               };
-    
-    print $c->header();
-    Litmus->template()->process("auth/accountcreated.html.tmpl", $vars) ||
-      internalError(Litmus->template()->error());
-    
-    exit;	
-    
-  } elsif ($type eq "bugzilla") {
-    my $username = $c->param("username");
-    my $password = $c->param("password");
-    
-    
-  } elsif ($type eq "convert") {
-    # convert an old-school Litmus account (pre authentication system) 
-    # to a new one with a password:
-    my $username = $c->param("email");
-    
-    my @userobjs = Litmus::DB::User->search(email => $username);
-    my $userobj = $userobjs[0];
-    if (! $userobj || $userobj->email() ne $username) {
-      loginError($c, "User $username does not exist.");
-    }
-    
-    if ($userobj->password() ne "") {
-      # already a new-style account
-      loginError($c, "User $username has already been updated.");
-    }
-    
-    # display a "convert login" form to get the rest of the information
-    print $c->header();
-    my $return_to = $c->param("login_loc") || "";
-    unsetFields();
-    my $vars = {
-                title => "Update Login",
-                email => $username,
-                return_to => $return_to,
-                params => $c,
-               };
-    
-    Litmus->template()->process("auth/convertaccount.html.tmpl", $vars) ||
-      internalError(Litmus->template()->error());
-    exit;
-  } elsif ($type eq "reallyconvert") {
-    my $username = $c->param("email");
-    my $realname = $c->param("realname");
-    my $password = $c->param("password");
-    my $password_confirm = $c->param("password_confirm");
-    my $nickname = $c->param("irc_nickname");
-    
-    if (! $password eq $password_confirm) {
-      loginError($c, "Passwords do not match. Please try again.");
-    }
-    
-    my @userobjs = Litmus::DB::User->search(email => $username);
-    my $userobj = $userobjs[0];
-    
-    # just to be safe:
-    if (! $userobj || $userobj->email() ne $username) {
-      loginError($c, "User $username does not exist.");
-    }
-    
-    if ($userobj->password() ne "" && ($userobj->bugzilla_uid() == 0 || 
-                                       !$userobj->bugzilla_uid())) {
-      # already a new-style account
-      loginError($c, "User $username has already been updated.");
-    }
-    my ($nickname_exists) = 
-      Litmus::DB::User->search(irc_nickname => $nickname);
-    if ($nickname_exists) {
-      loginError($c,
-                 "An account with that IRC nickname already exists.",
-                 "auth/convertaccount.html.tmpl",
-                 "Update Login");
-    }
-    
-    # do the upgrade:
-    $userobj->password(bz_crypt($password));
-    $userobj->bugzilla_uid("0");
-    $userobj->realname($realname);
-    $userobj->enabled(1);
-#    $userobj->is_admin(0);
-    $userobj->irc_nickname($nickname);
-    $userobj->update();
-    
-    my $session = makeSession($userobj);
-    $c->storeCookie(makeCookie($session));
-
-    my $vars = {
-                title => "Account Created",
-                email => $username,
-                realname => $realname,
-                return_to => $c->param("login_loc"),
-                params => $c
-               };
-    
-    print $c->header();
-    Litmus->template()->process("auth/accountcreated.html.tmpl", $vars) ||
-      internalError(Litmus->template()->error());
-    
-    exit;
-    
-  } else {
-    internalError("Unknown login scheme attempted");
-  }
-}
-
-sub changePassword {
-	my $userobj = shift;
-	my $password = shift;
-	$userobj->password(bz_crypt($password));
-	$userobj->update();
-	
-	my @sessions = $userobj->sessions();
-	foreach my $session (@sessions) {
-		$session->makeExpire();
-	}
-}
-
-# Given a userobj, process the login and return a session object
-sub makeSession {
-  my $userobj = shift;
-  my $c = Litmus->cgi();
-  
-  my $expires = localtime() + ONE_DAY * $cookie_expire_days;
-  
-  my $sessioncookie = randomToken(64);
-  
-  my $session = Litmus::DB::Session->create({
-                                             user_id => $userobj, 
-                                             sessioncookie => $sessioncookie,
-                                             expires => $expires});
-  
-  Litmus->request_cache->{'curSession'} = $session;
-  return $session;
-}
-
-# Given a session, create a login cookie to go with it
-sub makeCookie {
-  my $session = shift;
-  
-  my $cookie = Litmus->cgi()->cookie( 
-                                     -name    => $logincookiename,
-                                     -value   => $session->sessioncookie(),
-                                     -domain  => $main::ENV{"HTTP_HOST"},
-                                     -expires => $session->expires(),
-                                    );
-  return $cookie;
-}
-
-sub loginError {
-  my $c = shift;
-  my $message = shift;
-  my $template = shift;
-  my $title = shift;
-
-  if (!$template) {
-    $template = "auth/login.html.tmpl";
-  }
-  if (!$title) {
-    $title = "Login";
-  }
-
-  print $c->header();
-  
-  my $return_to = $c->param("login_loc") || "";
-  my $email = $c->param("email") || "";
-	
-  unsetFields();
-  
-  my $vars = {
-              title => $title,
-              return_to => $return_to,
-              email => $email,
-              params => $c,
-              onload => "toggleMessage('failure','$message')", 
-            };
-
-  Litmus->template()->process($template, $vars) ||
-    internalError(Litmus->template()->error());
-  
-  exit;
-}
-
-sub unsetFields() {
-  my $c = Litmus->cgi();
-  
-  # We need to unset some params in $c since otherwise we end up with 
-  # a hidden form field set for "email" and friends and madness results:
-  $c->param('email', '');
-  $c->param('username', '');
-  $c->param('login_type', '');
-  $c->param('login_loc', '');
-  $c->param('realname', '');
-  $c->param('password', '');
-  $c->param('password_confirm', '');
-  
-}
-
-# Like crypt(), but with a random salt. Thanks to Bugzilla for this.
-sub bz_crypt {
-  my ($password) = @_;
-  
-  # The list of characters that can appear in a salt.  Salts and hashes
-  # are both encoded as a sequence of characters from a set containing
-  # 64 characters, each one of which represents 6 bits of the salt/hash.
-  # The encoding is similar to BASE64, the difference being that the
-  # BASE64 plus sign (+) is replaced with a forward slash (/).
-  my @saltchars = (0..9, 'A'..'Z', 'a'..'z', '.', '/');
-  
-  # Generate the salt.  We use an 8 character (48 bit) salt for maximum
-  # security on systems whose crypt uses MD5.  Systems with older
-  # versions of crypt will just use the first two characters of the salt.
-  my $salt = '';
-  for ( my $i=0 ; $i < 8 ; ++$i ) {
-    $salt .= $saltchars[rand(64)];
-  }
-  
-  # Crypt the password.
-  my $cryptedpassword = crypt($password, $salt);
-  
-  # Return the crypted password.
-  return $cryptedpassword;
-}
-
-sub randomToken {
-  my $size = shift || 10; # default to 10 chars if nothing specified
-  return join("", map{ ('0'..'9','a'..'z','A'..'Z')[rand 62] } (1..$size));
-}
-
-# Deprecated:
-# DO NOT USE
-sub setCookie {
-  my $user = shift;
-  my $expires = shift;
-
-  my $user_id = 0;
-  if ($user) {
-    $user_id = $user->user_id();
-  }
-  
-  if (!$expires or $expires eq '') {
-    $expires = '+3d';
-  }
-    
-  my $c = Litmus->cgi();
-  
-  my $cookie = $c->cookie( 
-                          -name    => $logincookiename,
-                          -value   => $user_id,
-                          -domain  => $main::ENV{"HTTP_HOST"},
-                          -expires => $expires,
-                         );
-  
-  return $cookie;
-}
-
-# Deprecated:
-sub getCookie() {
-  return getCurrentUser();
-}
-
-sub istrusted($) {
-  my $userobj = shift;
-
-  return 0 if (!$userobj);
-  
-  if ($userobj->istrusted()) {
-    return 1;
-  } else {
-    return 0;
-  }
-}
-
-sub canEdit($) {
-  my $userobj = shift;
-  
-  return $userobj->istrusted();
-}
-
-#########################################################################
-# logout()
-#
-# Unset the user's cookie
-#########################################################################
-sub logout() {
-  my $c = Litmus->cgi();
-
-  my $cookie = $c->cookie(
-                          -name => $logincookiename,
-                          -value => '',
-                          -domain  => $main::ENV{"HTTP_HOST"},
-                          -expires => '-1d'
-                         );
-  $c->storeCookie($cookie);
-  
-  # invalidate the session behind the cookie as well:
-  my $session = getCurrentSession();
-  if ($session) { $session->makeExpire() } 
-}
-
-
-1;
-
-

mozilla/webtools/litmus/Litmus/BugzillaDBI.pm

@@ -1,59 +0,0 @@
-# -*- mode: cperl; c-basic-offset: 8; indent-tabs-mode: nil; -*-
-
-=head1 COPYRIGHT
-
- # ***** BEGIN LICENSE BLOCK *****
- # Version: MPL 1.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 Litmus.
- #
- # The Initial Developer of the Original Code is
- # the Mozilla Corporation.
- # Portions created by the Initial Developer are Copyright (C) 2006
- # the Initial Developer. All Rights Reserved.
- #
- # Contributor(s):
- #   Chris Cooper <ccooper@deadsquid.com>
- #   Zach Lipton <zach@zachlipton.com>
- #
- # ***** END LICENSE BLOCK *****
-
-=cut
-
-package Litmus::BugzillaDBI;
-
-use strict;
-use warnings;
-use Litmus::Config;
-use Litmus::Error;
-use Memoize;
-
-use base 'Litmus::DBI';
-
-BEGIN {
-unless ($Litmus::Config::bugzilla_auth_enabled) {
-	return 1;
-}
-}
-
-my $dsn = "dbi:mysql:$Litmus::Config::bugzilla_db:$Litmus::Config::bugzilla_host";
-
-Litmus::BugzillaDBI->set_db('Main',
-                         $dsn,
-                         $Litmus::Config::bugzilla_user,
-                         $Litmus::Config::bugzilla_pass);
-                         
-
-                                         
-1;
-

mozilla/webtools/litmus/Litmus/CGI.pm

@@ -1,72 +0,0 @@
-# -*- mode: cperl; c-basic-offset: 8; indent-tabs-mode: nil; -*-
-
-=head1 COPYRIGHT
-
- # ***** BEGIN LICENSE BLOCK *****
- # Version: MPL 1.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 Litmus.
- #
- # The Initial Developer of the Original Code is
- # the Mozilla Corporation.
- # Portions created by the Initial Developer are Copyright (C) 2006
- # the Initial Developer. All Rights Reserved.
- #
- # Contributor(s):
- #   Zach Lipton <zach@zachlipton.com>
- #
- # ***** END LICENSE BLOCK *****
-
-=cut
-
-package Litmus::CGI; 
-
-use strict;
-use base 'CGI';
-
-# Subclass of CGI.pm that can store cookies in advance and output them 
-# later when the header() method is called. This feature should probably 
-# be submitted as a patch to CGI.pm itself.
-
-sub new {
-	my $class = shift;
-	my @args = @_;
-	
-	my $self = $class->SUPER::new(@args);
-	$self->{'litmusCookieStore'} = [];
-	return $self;
-}
-
-# Stores a cookie to be set later by the header() method
-sub storeCookie {
-	my $self = shift;
-	my $cookie = shift;
-	
-	# "we're like kids in a candy shop"
-	my @cookieStore = @{$self->{'litmusCookieStore'}};
-	push(@cookieStore, $cookie);
-	$self->{'litmusCookieStore'} = \@cookieStore;
-}
-
-sub header {
-	my $self = shift;
-	my @args = @_;
-	
-	foreach my $cur ($self->{'litmusCookieStore'}) {
-		push(@args, {-cookie => $cur});
-	}
-	
-	$self->SUPER::header(@args);
-}
-
-1;

mozilla/webtools/litmus/Litmus/Cache.pm

@@ -1,125 +0,0 @@
-# -*- mode: cperl; c-basic-offset: 8; indent-tabs-mode: nil; -*-
-
-=head1 COPYRIGHT
-
- # ***** BEGIN LICENSE BLOCK *****
- # Version: MPL 1.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 Litmus.
- #
- # The Initial Developer of the Original Code is
- # the Mozilla Corporation.
- # Portions created by the Initial Developer are Copyright (C) 2006
- # the Initial Developer. All Rights Reserved.
- #
- # Contributor(s):
- #   Chris Cooper <ccooper@deadsquid.com>
- #   Zach Lipton <zach@zachlipton.com>
- #
- # ***** END LICENSE BLOCK *****
-
-=cut
-
-package Litmus::Cache;
-
-use strict;
-
-use Litmus;
-use Data::JavaScript;
-use Litmus::DB::Product;
-
-our @ISA = qw(Exporter);
-@Litmus::Cache::EXPORT = qw(
-    rebuildCache
-);
-
-# generate a new litmusconfig.js file because something has updated:
-sub rebuildCache {
-    unless (-e "data") { system("mkdir", "data") }
-    open(CACHE, ">data/litmusconfig.js.new");
-    
-    print CACHE "// Litmus configuration information\n";
-    print CACHE "// Do not edit this file directly. It is autogenerated from the database\n";
-    print CACHE "\n";
-    
-    # we build up @litmusconfig, a big perl data structure, and spit the 
-    # whole thing out as javascript with Data::JavaScript
-    # shield your eyes, we're in for a long trip
-    my @litmusconfig;
-    my @products = Litmus::DB::Product->search(enabled => 1);
-    my $prodcount = 0;
-    foreach my $curproduct (@products) {
-        my $prodrow =  \%{$litmusconfig[$prodcount]};
-           $prodrow->{"name"} = $curproduct->name();
-           $prodrow->{"id"} = $curproduct->product_id();
-           
-           my $brancharray = \@{$prodrow->{"branches"}};
-           my $branchcount = 0;
-           foreach my $curbranch ($curproduct->branches(enabled => 1)) {
-               my $branchrow = \%{$brancharray->[$branchcount]};
-               $branchrow->{"name"} = $curbranch->name();
-               $branchrow->{"id"} = $curbranch->branch_id();
-               $branchcount++;
-           }
-           
-           my $platformarray = \@{$prodrow->{"platforms"}};
-           my $platformcount = 0;
-           foreach my $curplat (Litmus::DB::Platform->search_ByProduct($curproduct->product_id())) {
-               my $platrow = \%{$platformarray->[$platformcount]};
-               $platrow->{"name"} = $curplat->name();
-               $platrow->{"id"} = $curplat->platform_id();
-               
-               my $opsysarray = \@{$platrow->{"opsyses"}};
-               my $opsyscount = 0;
-               foreach my $curopsys ($curplat->opsyses()) {
-                   my $opsysrow = \%{$opsysarray->[$opsyscount]};
-                   $opsysrow->{"name"} = $curopsys->name();
-                   $opsysrow->{"id"} = $curopsys->opsys_id();
-                   $opsyscount++;
-               }
-               $platformcount++;
-           }
-           
-           my $grouparray = \@{$prodrow->{"testgroups"}};
-           my $groupcount = 0;
-           foreach my $curgroup ($curproduct->testgroups()) {
-               next if (!$curgroup->enabled);
-               my $grouprow = \%{$grouparray->[$groupcount]};
-               $grouprow->{"name"} = $curgroup->name();
-               $grouprow->{"id"} = $curgroup->testgroup_id();
-               $groupcount++;
-               
-               my $subgrouparray = \@{$grouprow->{"subgroups"}};
-               my $subgroupcount = 0;
-               foreach my $cursubgroup (Litmus::DB::Subgroup->search_EnabledByTestgroup($curgroup->testgroup_id())) {
-                 next if (!$cursubgroup->enabled);
-                   my $subgrouprow = \%{$subgrouparray->[$subgroupcount]};
-                   $subgrouprow->{"name"} = $cursubgroup->name();
-                   $subgrouprow->{"id"} = $cursubgroup->subgroup_id();
-                   $subgroupcount++;
-               }
-           }
-           
-        $prodcount++;
-    }
-        
-    
-    my $data = jsdump('litmusconfig', \@litmusconfig);
-    $data =~ s/new Object;/new Array\(\);/g;
-    print CACHE $data;
-    close(CACHE);
-    system("mv", "data/litmusconfig.js.new", "data/litmusconfig.js");
-    #system("chmod", "-R", "755", "data/");
-}
-
-1;

mozilla/webtools/litmus/Litmus/Config.pm

@@ -1,49 +0,0 @@
-# -*- mode: cperl; c-basic-offset: 8; indent-tabs-mode: nil; -*-
-
-=head1 COPYRIGHT
-
- # ***** BEGIN LICENSE BLOCK *****
- # Version: MPL 1.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 Litmus.
- #
- # The Initial Developer of the Original Code is
- # the Mozilla Corporation.
- # Portions created by the Initial Developer are Copyright (C) 2006
- # the Initial Developer. All Rights Reserved.
- #
- # Contributor(s):
- #   Chris Cooper <ccooper@deadsquid.com>
- #   Zach Lipton <zach@zachlipton.com>
- #
- # ***** END LICENSE BLOCK *****
-
-=cut
-
-package Litmus::Config; 
-
-use strict;
-
-do 'localconfig';
-
-our $version = "0.6";
-
-# if true, then Litmus will not accept any requests
-our $disabled = 0;
-
-our $datadir = "data/";
-
-# Set/unset this to display inline debugging value/code.
-our $DEBUG = 0;
-
-1;

mozilla/webtools/litmus/Litmus/DB/Branch.pm

@@ -1,48 +0,0 @@
-# -*- mode: cperl; c-basic-offset: 8; indent-tabs-mode: nil; -*-
-
-=head1 COPYRIGHT
-
- # ***** BEGIN LICENSE BLOCK *****
- # Version: MPL 1.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 Litmus.
- #
- # The Initial Developer of the Original Code is
- # the Mozilla Corporation.
- # Portions created by the Initial Developer are Copyright (C) 2006
- # the Initial Developer. All Rights Reserved.
- #
- # Contributor(s):
- #   Chris Cooper <ccooper@deadsquid.com>
- #   Zach Lipton <zach@zachlipton.com>
- #
- # ***** END LICENSE BLOCK *****
-
-=cut
-
-package Litmus::DB::Branch;
-
-use strict;
-use base 'Litmus::DBI';
-
-Litmus::DB::Branch->table('branches');
-
-Litmus::DB::Branch->columns(All => qw/branch_id product_id name detect_regexp enabled/);
-Litmus::DB::Branch->columns(Essential => qw/branch_id product_id name detect_regexp enabled/);
-
-Litmus::DB::Branch->column_alias("product_id", "product");
-
-Litmus::DB::Branch->has_many(test_results => "Litmus::DB::Testresult");
-Litmus::DB::Branch->has_a(product => "Litmus::DB::Product");
-
-1;

mozilla/webtools/litmus/Litmus/DB/BugzillaUser.pm

@@ -1,44 +0,0 @@
-# -*- mode: cperl; c-basic-offset: 8; indent-tabs-mode: nil; -*-
-
-=head1 COPYRIGHT
-
- # ***** BEGIN LICENSE BLOCK *****
- # Version: MPL 1.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 Litmus.
- #
- # The Initial Developer of the Original Code is
- # the Mozilla Corporation.
- # Portions created by the Initial Developer are Copyright (C) 2006
- # the Initial Developer. All Rights Reserved.
- #
- # Contributor(s):
- #   Chris Cooper <ccooper@deadsquid.com>
- #   Zach Lipton <zach@zachlipton.com>
- #
- # ***** END LICENSE BLOCK *****
-
-=cut
-
-package Litmus::DB::BugzillaUser;
-
-use strict;
-use base 'Litmus::BugzillaDBI';
-
-Litmus::DB::BugzillaUser->table('profiles');
-
-Litmus::DB::BugzillaUser->columns(All => qw/userid login_name cryptpassword realname 
-	disabledtext mybugslink refreshed_when extern_id/);
-
-
-1;

mozilla/webtools/litmus/Litmus/DB/BuildType.pm

@@ -1,44 +0,0 @@
-# -*- mode: cperl; c-basic-offset: 8; indent-tabs-mode: nil; -*-
-
-=head1 COPYRIGHT
-
- # ***** BEGIN LICENSE BLOCK *****
- # Version: MPL 1.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 Litmus.
- #
- # The Initial Developer of the Original Code is
- # the Mozilla Corporation.
- # Portions created by the Initial Developer are Copyright (C) 2006
- # the Initial Developer. All Rights Reserved.
- #
- # Contributor(s):
- #   Chris Cooper <ccooper@deadsquid.com>
- #   Zach Lipton <zach@zachlipton.com>
- #
- # ***** END LICENSE BLOCK *****
-
-=cut
-
-package Litmus::DB::BuildType;
-
-use strict;
-use base 'Litmus::DBI';
-
-Litmus::DB::BuildType->table('build_type_lookup');
-
-Litmus::DB::BuildType->columns(All => qw/build_type_id name/);
-
-Litmus::DB::BuildType->has_many(test_results => "Litmus::DB::Testresult");
-
-1;

mozilla/webtools/litmus/Litmus/DB/Comment.pm

@@ -1,53 +0,0 @@
-# -*- mode: cperl; c-basic-offset: 8; indent-tabs-mode: nil; -*-
-
-=head1 COPYRIGHT
-
- # ***** BEGIN LICENSE BLOCK *****
- # Version: MPL 1.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 Litmus.
- #
- # The Initial Developer of the Original Code is
- # the Mozilla Corporation.
- # Portions created by the Initial Developer are Copyright (C) 2006
- # the Initial Developer. All Rights Reserved.
- #
- # Contributor(s):
- #   Chris Cooper <ccooper@deadsquid.com>
- #   Zach Lipton <zach@zachlipton.com>
- #
- # ***** END LICENSE BLOCK *****
-
-=cut
-
-package Litmus::DB::Comment;
-
-use strict;
-use base 'Litmus::DBI';
-
-use Time::Piece;
-
-Litmus::DB::Comment->table('test_result_comments');
-
-Litmus::DB::Comment->columns(All => qw/comment_id test_result_id last_updated submission_time user_id comment/);
-
-Litmus::DB::Comment->column_alias("test_result_id", "test_result");
-Litmus::DB::Comment->column_alias("user_id", "user");
-
-Litmus::DB::Comment->has_a(test_result => "Litmus::DB::Testresult");
-Litmus::DB::Comment->has_a(user => "Litmus::DB::User");
-
-Litmus::DB::Comment->autoinflate(dates => 'Time::Piece');
-
-1;
-

mozilla/webtools/litmus/Litmus/DB/ExitStatus.pm

@@ -1,44 +0,0 @@
-# -*- mode: cperl; c-basic-offset: 8; indent-tabs-mode: nil; -*-
-
-=head1 COPYRIGHT
-
- # ***** BEGIN LICENSE BLOCK *****
- # Version: MPL 1.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 Litmus.
- #
- # The Initial Developer of the Original Code is
- # the Mozilla Corporation.
- # Portions created by the Initial Developer are Copyright (C) 2006
- # the Initial Developer. All Rights Reserved.
- #
- # Contributor(s):
- #   Chris Cooper <ccooper@deadsquid.com>
- #   Zach Lipton <zach@zachlipton.com>
- #
- # ***** END LICENSE BLOCK *****
-
-=cut
-
-package Litmus::DB::ExitStatus;
-
-use strict;
-use base 'Litmus::DBI';
-
-Litmus::DB::ExitStatus->table('exit_status_lookup');
-
-Litmus::DB::ExitStatus->columns(All => qw/exit_status_id name/);
-
-Litmus::DB::ExitStatus->has_many(test_results => "Litmus::DB::Testresult");
-
-1;

mozilla/webtools/litmus/Litmus/DB/Format.pm

@@ -1,46 +0,0 @@
-# -*- mode: cperl; c-basic-offset: 8; indent-tabs-mode: nil; -*-
-
-=head1 COPYRIGHT
-
- # ***** BEGIN LICENSE BLOCK *****
- # Version: MPL 1.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 Litmus.
- #
- # The Initial Developer of the Original Code is
- # the Mozilla Corporation.
- # Portions created by the Initial Developer are Copyright (C) 2006
- # the Initial Developer. All Rights Reserved.
- #
- # Contributor(s):
- #   Chris Cooper <ccooper@deadsquid.com>
- #   Zach Lipton <zach@zachlipton.com>
- #
- # ***** END LICENSE BLOCK *****
-
-=cut
-
-package Litmus::DB::Format;
-
-use strict;
-use base 'Litmus::DBI';
-
-Litmus::DB::Format->table('test_format_lookup');
-
-Litmus::DB::Format->columns(All => qw/format_id name/);
-
-Litmus::DB::Format->column_alias("format_id", "formatid");
-
-Litmus::DB::Format->has_many(testcases => "Litmus::DB::Testcase");
-
-1;

mozilla/webtools/litmus/Litmus/DB/Locale.pm

@@ -1,52 +0,0 @@
-# -*- mode: cperl; c-basic-offset: 8; indent-tabs-mode: nil; -*-
-
-=head1 COPYRIGHT
-
- # ***** BEGIN LICENSE BLOCK *****
- # Version: MPL 1.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 Litmus.
- #
- # The Initial Developer of the Original Code is
- # the Mozilla Corporation.
- # Portions created by the Initial Developer are Copyright (C) 2006
- # the Initial Developer. All Rights Reserved.
- #
- # Contributor(s):
- #   Chris Cooper <ccooper@deadsquid.com>
- #   Zach Lipton <zach@zachlipton.com>
- #
- # ***** END LICENSE BLOCK *****
-
-=cut
-
-package Litmus::DB::Locale;
-
-use strict;
-use base 'Litmus::DBI';
-
-Litmus::DB::Locale->table('locale_lookup');
-
-Litmus::DB::Locale->columns(All => qw/abbrev name/);
-
-Litmus::DB::Locale->column_alias("abbrev", "locale");
-
-Litmus::DB::Locale->has_many(test_results => "Litmus::DB::Testresult");
-
-__PACKAGE__->set_sql(RetrieveAll => qq{
-                                       SELECT __ESSENTIAL__
-                                       FROM   __TABLE__
-                                       ORDER BY abbrev ASC
-});
-
-1;

mozilla/webtools/litmus/Litmus/DB/Log.pm

@@ -1,50 +0,0 @@
-# -*- mode: cperl; c-basic-offset: 8; indent-tabs-mode: nil; -*-
-
-=head1 COPYRIGHT
-
- # ***** BEGIN LICENSE BLOCK *****
- # Version: MPL 1.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 Litmus.
- #
- # The Initial Developer of the Original Code is
- # the Mozilla Corporation.
- # Portions created by the Initial Developer are Copyright (C) 2006
- # the Initial Developer. All Rights Reserved.
- #
- # Contributor(s):
- #   Chris Cooper <ccooper@deadsquid.com>
- #   Zach Lipton <zach@zachlipton.com>
- #
- # ***** END LICENSE BLOCK *****
-
-=cut
-
-package Litmus::DB::Log;
-
-use strict;
-use base 'Litmus::DBI';
-
-Litmus::DB::Log->table('test_result_logs');
-
-Litmus::DB::Log->columns(All => qw/log_id last_updated submission_time log_type_id log_text/);
-
-Litmus::DB::Log->column_alias("test_results", "testresults");
-Litmus::DB::Log->column_alias("log_type_id", "log_type");
-
-Litmus::DB::Log->has_a(log_type => "Litmus::DB::LogType");
-Litmus::DB::Log->has_many(test_results => ["Litmus::DB::LogTestresult" => 'test_result']);
-
-Litmus::DB::Testresult->autoinflate(dates => 'Time::Piece');
-
-1;

mozilla/webtools/litmus/Litmus/DB/LogTestresult.pm

@@ -1,47 +0,0 @@
-# -*- mode: cperl; c-basic-offset: 8; indent-tabs-mode: nil; -*-
-
-=head1 COPYRIGHT
-
- # ***** BEGIN LICENSE BLOCK *****
- # Version: MPL 1.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 Litmus.
- #
- # The Initial Developer of the Original Code is
- # the Mozilla Corporation.
- # Portions created by the Initial Developer are Copyright (C) 2006
- # the Initial Developer. All Rights Reserved.
- #
- # Contributor(s):
- #   Chris Cooper <ccooper@deadsquid.com>
- #   Zach Lipton <zach@zachlipton.com>
- #
- # ***** END LICENSE BLOCK *****
-
-=cut
-
-package Litmus::DB::LogTestresult;
-
-use strict;
-use base 'Litmus::DBI';
-
-Litmus::DB::LogTestresult->table('testresult_logs_join');
-
-Litmus::DB::LogTestresult->columns(Primary => qw/test_result_id log_id/);
-
-Litmus::DB::LogTestresult->column_alias("test_result_id", "test_result");
-
-Litmus::DB::LogTestresult->has_a(test_result => "Litmus::DB::Testresult");
-Litmus::DB::LogTestresult->has_a(log_id => "Litmus::DB::Log");
-
-1;

mozilla/webtools/litmus/Litmus/DB/LogType.pm

@@ -1,44 +0,0 @@
-# -*- mode: cperl; c-basic-offset: 8; indent-tabs-mode: nil; -*-
-
-=head1 COPYRIGHT
-
- # ***** BEGIN LICENSE BLOCK *****
- # Version: MPL 1.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 Litmus.
- #
- # The Initial Developer of the Original Code is
- # the Mozilla Corporation.
- # Portions created by the Initial Developer are Copyright (C) 2006
- # the Initial Developer. All Rights Reserved.
- #
- # Contributor(s):
- #   Chris Cooper <ccooper@deadsquid.com>
- #   Zach Lipton <zach@zachlipton.com>
- #
- # ***** END LICENSE BLOCK *****
-
-=cut
-
-package Litmus::DB::LogType;
-
-use strict;
-use base 'Litmus::DBI';
-
-Litmus::DB::LogType->table('log_type_lookup');
-
-Litmus::DB::LogType->columns(All => qw/log_type_id name/);
-
-Litmus::DB::LogType->has_many(test_result_logs => "Litmus::DB::Log");
-
-1;

mozilla/webtools/litmus/Litmus/DB/Opsys.pm

@@ -1,48 +0,0 @@
-# -*- mode: cperl; c-basic-offset: 8; indent-tabs-mode: nil; -*-
-
-=head1 COPYRIGHT
-
- # ***** BEGIN LICENSE BLOCK *****
- # Version: MPL 1.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 Litmus.
- #
- # The Initial Developer of the Original Code is
- # the Mozilla Corporation.
- # Portions created by the Initial Developer are Copyright (C) 2006
- # the Initial Developer. All Rights Reserved.
- #
- # Contributor(s):
- #   Chris Cooper <ccooper@deadsquid.com>
- #   Zach Lipton <zach@zachlipton.com>
- #
- # ***** END LICENSE BLOCK *****
-
-=cut
-
-package Litmus::DB::Opsys;
-
-use strict;
-use base 'Litmus::DBI';
-
-Litmus::DB::Opsys->table('opsyses');
-
-Litmus::DB::Opsys->columns(All => qw/opsys_id platform_id name detect_regexp/);
-Litmus::DB::Opsys->columns(Essential => qw/opsys_id platform_id name detect_regexp/);
-
-Litmus::DB::Opsys->column_alias("platform_id", "platform");
-
-Litmus::DB::Opsys->has_many(test_results => "Litmus::DB::Testresult");
-Litmus::DB::Opsys->has_a(platform => "Litmus::DB::Platform");
-
-1;

mozilla/webtools/litmus/Litmus/DB/Platform.pm

@@ -1,105 +0,0 @@
-# -*- mode: cperl; c-basic-offset: 8; indent-tabs-mode: nil; -*-
-
-=head1 COPYRIGHT
-
- # ***** BEGIN LICENSE BLOCK *****
- # Version: MPL 1.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 Litmus.
- #
- # The Initial Developer of the Original Code is
- # the Mozilla Corporation.
- # Portions created by the Initial Developer are Copyright (C) 2006
- # the Initial Developer. All Rights Reserved.
- #
- # Contributor(s):
- #   Chris Cooper <ccooper@deadsquid.com>
- #   Zach Lipton <zach@zachlipton.com>
- #
- # ***** END LICENSE BLOCK *****
-
-=cut
-
-package Litmus::DB::Platform;
-
-use strict;
-use base 'Litmus::DBI';
-use CGI;
-
-Litmus::DB::Platform->table('platforms');
-
-Litmus::DB::Platform->columns(All => qw/platform_id name detect_regexp iconpath/);
-Litmus::DB::Platform->columns(Essential => qw/platform_id name detect_regexp iconpath/);
-
-Litmus::DB::Platform->column_alias("platform_id", "platformid");
-
-Litmus::DB::Platform->has_many(opsyses => "Litmus::DB::Opsys");
-
-Litmus::DB::Platform->set_sql(ByProduct => qq{
-                                              SELECT pl.* 
-                                              FROM platforms pl, platform_products plpr
-                                              WHERE plpr.product_id=? AND plpr.platform_id=pl.platform_id
-});
-
-Litmus::DB::Platform->set_sql(ByProductAndName => qq{
-                                                     SELECT pl.* 
-                                                     FROM platforms pl, platform_products plpr
-                                                     WHERE plpr.product_id=? AND plpr.platform_id=pl.platform_id
-                                                     AND pl.name=?
-});
-
-#########################################################################
-sub delete_from_products() {
-  my $self = shift;
-  
-  my $dbh = __PACKAGE__->db_Main();
-  my $sql = "DELETE from platform_products WHERE platform_id=?";
-  my $rows = $dbh->do($sql,
-                      undef,
-                      $self->platform_id
-                     );
-}
-
-#########################################################################
-sub delete_with_refs() {
-  my $self = shift;
-
-  $self->delete_from_products();
-
-  # XXX: How to handle opsyses?
-
-  return $self->delete;
-}
-
-#########################################################################
-sub update_products() {
-  my $self = shift;
-  my $new_product_ids = shift;
-  
-  if (scalar @$new_product_ids) {
-    # Failing to delete products is _not_ fatal when adding a new subgroup.
-    my $rv = $self->delete_from_products();
-    my $dbh = __PACKAGE__->db_Main();  
-    my $sql = "INSERT INTO platform_products (platform_id,product_id) VALUES (?,?)";
-    foreach my $new_product_id (@$new_product_ids) {
-      my $rows = $dbh->do($sql, 
-			  undef,
-			  $self->platform_id,
-			  $new_product_id
-			 );
-    }
-  }
-}
-
-
-1;

mozilla/webtools/litmus/Litmus/DB/Product.pm

@@ -1,108 +0,0 @@
-# -*- mode: cperl; c-basic-offset: 8; indent-tabs-mode: nil; -*-
-
-=head1 COPYRIGHT
-
- # ***** BEGIN LICENSE BLOCK *****
- # Version: MPL 1.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 Litmus.
- #
- # The Initial Developer of the Original Code is
- # the Mozilla Corporation.
- # Portions created by the Initial Developer are Copyright (C) 2006
- # the Initial Developer. All Rights Reserved.
- #
- # Contributor(s):
- #   Chris Cooper <ccooper@deadsquid.com>
- #   Zach Lipton <zach@zachlipton.com>
- #
- # ***** END LICENSE BLOCK *****
-
-=cut
-
-package Litmus::DB::Product;
-
-use strict;
-use base 'Litmus::DBI';
-
-Litmus::DB::Product->table('products');
-
-Litmus::DB::Product->columns(All => qw/product_id name iconpath enabled/);
-Litmus::DB::Product->columns(Essential => qw/product_id name iconpath enabled/);
-
-Litmus::DB::Product->column_alias("product_id", "productid");
-
-Litmus::DB::Product->has_many(testcases => "Litmus::DB::Testcase", 
-                              { order_by => 'testcase_id' });
-Litmus::DB::Product->has_many(subgroups => "Litmus::DB::Subgroup",
-                              { order_by => 'name' });
-Litmus::DB::Product->has_many(testgroups => "Litmus::DB::Testgroup",
-                              { order_by => 'name' });
-Litmus::DB::Product->has_many(branches => "Litmus::DB::Branch",
-                              { order_by => 'name' });
-
-__PACKAGE__->set_sql(ByPlatform => qq{
-                                      SELECT pr.* 
-                                      FROM products pr, platform_products plpr 
-                                      WHERE plpr.platform_id=? AND plpr.product_id=pr.product_id
-                                      ORDER BY pr.name ASC
-});
-
-#########################################################################
-sub delete_from_platforms() {
-  my $self = shift;
-  
-  my $dbh = __PACKAGE__->db_Main();
-  my $sql = "DELETE from platform_products WHERE product_id=?";
-  my $rows = $dbh->do($sql,
-                      undef,
-                      $self->product_id
-                     );
-}
-
-#########################################################################
-sub delete_with_refs() {
-  my $self = shift;
-  $self->delete_from_platforms();
-
-  my $dbh = __PACKAGE__->db_Main();
-  my $sql = "UPDATE testgroups SET product_id=0,enabled=0 WHERE product_id=?";
-  my $rows = $dbh->do($sql,
-                      undef,
-                      $self->product_id
-                     );
-
-  # Remove references to product in other entities. 
-  # Disable those entities for good measure.
-  $sql = "UPDATE subgroups SET product_id=0,enabled=0 WHERE product_id=?";
-  $rows = $dbh->do($sql,
-                   undef,
-                   $self->product_id
-                  );
-
-  $sql = "UPDATE testcases SET product_id=0,enabled=0,community_enabled=0 WHERE product_id=?";
-  $rows = $dbh->do($sql,
-                   undef,
-                   $self->product_id
-                  );
-
-  $sql = "UPDATE branches SET product_id=0,enabled=0 WHERE product_id=?";
-  $rows = $dbh->do($sql,
-                   undef,
-                   $self->product_id
-                  );
-
-  return $self->delete;
-}
-
-1;

mozilla/webtools/litmus/Litmus/DB/ResultStatus.pm

@@ -1,44 +0,0 @@
-# -*- mode: cperl; c-basic-offset: 8; indent-tabs-mode: nil; -*-
-
-=head1 COPYRIGHT
-
- # ***** BEGIN LICENSE BLOCK *****
- # Version: MPL 1.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 Litmus.
- #
- # The Initial Developer of the Original Code is
- # the Mozilla Corporation.
- # Portions created by the Initial Developer are Copyright (C) 2006
- # the Initial Developer. All Rights Reserved.
- #
- # Contributor(s):
- #   Chris Cooper <ccooper@deadsquid.com>
- #   Zach Lipton <zach@zachlipton.com>
- #
- # ***** END LICENSE BLOCK *****
-
-=cut
-
-package Litmus::DB::ResultStatus;
-
-use strict;
-use base 'Litmus::DBI';
-
-Litmus::DB::ResultStatus->table('test_result_status_lookup');
-
-Litmus::DB::ResultStatus->columns(All => qw/result_status_id name class_name/);
-
-Litmus::DB::ResultStatus->has_many(test_results => "Litmus::DB::Testresult");
-
-1;

mozilla/webtools/litmus/Litmus/DB/Resultbug.pm

@@ -1,54 +0,0 @@
-# -*- mode: cperl; c-basic-offset: 8; indent-tabs-mode: nil; -*-
-
-=head1 COPYRIGHT
-
- # ***** BEGIN LICENSE BLOCK *****
- # Version: MPL 1.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 Litmus.
- #
- # The Initial Developer of the Original Code is
- # the Mozilla Corporation.
- # Portions created by the Initial Developer are Copyright (C) 2006
- # the Initial Developer. All Rights Reserved.
- #
- # Contributor(s):
- #   Chris Cooper <ccooper@deadsquid.com>
- #   Zach Lipton <zach@zachlipton.com>
- #
- # ***** END LICENSE BLOCK *****
-
-=cut
-
-package Litmus::DB::Resultbug;
-
-use strict;
-use base 'Litmus::DBI';
-
-use Time::Piece;
-
-Litmus::DB::Resultbug->table('test_result_bugs');
-
-Litmus::DB::Resultbug->columns(Primary => qw/test_result_id bug_id/);
-Litmus::DB::Resultbug->columns(All => qw/last_updated submission_time user_id/);
-
-Litmus::DB::Resultbug->column_alias("test_result_id", "test_result");
-Litmus::DB::Resultbug->column_alias("test_result_id", "testresult");
-Litmus::DB::Resultbug->column_alias("user_id", "user");
-
-Litmus::DB::Resultbug->has_a(test_result => "Litmus::DB::Testresult");
-Litmus::DB::Resultbug->has_a(user => "Litmus::DB::User");
-
-Litmus::DB::Resultbug->autoinflate(dates => 'Time::Piece');
-
-1;

mozilla/webtools/litmus/Litmus/DB/Session.pm

@@ -1,69 +0,0 @@
-# -*- mode: cperl; c-basic-offset: 8; indent-tabs-mode: nil; -*-
-
-=head1 COPYRIGHT
-
- # ***** BEGIN LICENSE BLOCK *****
- # Version: MPL 1.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 Litmus.
- #
- # The Initial Developer of the Original Code is
- # the Mozilla Corporation.
- # Portions created by the Initial Developer are Copyright (C) 2006
- # the Initial Developer. All Rights Reserved.
- #
- # Contributor(s):
- #   Chris Cooper <ccooper@deadsquid.com>
- #   Zach Lipton <zach@zachlipton.com>
- #
- # ***** END LICENSE BLOCK *****
-
-=cut
-
-package Litmus::DB::Session;
-
-use strict;
-use base 'Litmus::DBI';
-
-use Time::Piece;
-
-Litmus::DB::Session->table('sessions');
-
-Litmus::DB::Session->columns(All => qw/session_id user_id sessioncookie expires/);
-
-Litmus::DB::Session->has_a(user_id => "Litmus::DB::User");
-
-Litmus::DB::Session->autoinflate(dates => 'Time::Piece');
-
-# expire the current Session object 
-sub makeExpire {
-	my $self = shift;
-	$self->delete();
-}
-
-sub isValid {
-	my $self = shift;
-	
-	if ($self->expires() <= localtime()) {
-    	$self->makeExpire();
-    	return 0;
-    }
-    
-    if (!$self->user_id()->enabled() || $self->user_id()->enabled() == 0) {
-    	$self->makeExpire();
-    	return 0;
-    }
-    return 1;
-}
-
-1;

mozilla/webtools/litmus/Litmus/DB/Subgroup.pm

@@ -1,306 +0,0 @@
-# -*- mode: cperl; c-basic-offset: 8; indent-tabs-mode: nil; -*-
-
-=head1 COPYRIGHT
-
- # ***** BEGIN LICENSE BLOCK *****
- # Version: MPL 1.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 Litmus.
- #
- # The Initial Developer of the Original Code is
- # the Mozilla Corporation.
- # Portions created by the Initial Developer are Copyright (C) 2006
- # the Initial Developer. All Rights Reserved.
- #
- # Contributor(s):
- #   Chris Cooper <ccooper@deadsquid.com>
- #   Zach Lipton <zach@zachlipton.com>
- #
- # ***** END LICENSE BLOCK *****
-
-=cut
-
-package Litmus::DB::Subgroup;
-
-use strict;
-use base 'Litmus::DBI';
-
-use Time::Piece::MySQL;
-#use Litmus::DB::Testresult;
-
-Litmus::DB::Subgroup->table('subgroups');
-
-Litmus::DB::Subgroup->columns(All => qw/subgroup_id name testrunner_group_id enabled product_id/);
-Litmus::DB::Subgroup->columns(Essential => qw/subgroup_id name testrunner_group_id enabled product_id/);
-
-Litmus::DB::Subgroup->column_alias("subgroup_id", "subgroupid");
-
-Litmus::DB::Subgroup->has_a(product => "Litmus::DB::Product");
-
-__PACKAGE__->set_sql(EnabledByTestgroup => qq{
-                                              SELECT sg.* 
-                                              FROM subgroups sg, subgroup_testgroups sgtg 
-                                              WHERE sgtg.testgroup_id=? AND sgtg.subgroup_id=sg.subgroup_id AND sg.enabled=1 
-                                              ORDER BY sgtg.sort_order ASC
-});
-
-__PACKAGE__->set_sql(ByTestgroup => qq{
-                                       SELECT sg.* 
-                                       FROM subgroups sg, subgroup_testgroups sgtg 
-                                       WHERE sgtg.testgroup_id=? AND sgtg.subgroup_id=sg.subgroup_id
-                                       ORDER BY sgtg.sort_order ASC
-});
-
-__PACKAGE__->set_sql(NumEnabledTestcases => qq{
-                                               SELECT count(tc.testcase_id) as num_testcases
-                                               FROM testcases tc, testcase_subgroups tcsg
-                                               WHERE tcsg.subgroup_id=? AND tcsg.testcase_id=tc.testcase_id AND tc.enabled=1 AND tc.community_enabled=1 
-});
-
-__PACKAGE__->set_sql(EnabledByTestcase => qq{
-                                             SELECT sg.* 
-                                             FROM subgroups sg, testcase_subgroups tcsg
-                                             WHERE tcsg.testcase_id=? AND tcsg.subgroup_id=sg.subgroup_id AND sg.enabled=1 
-                                             ORDER by sg.name ASC
-});
-
-__PACKAGE__->set_sql(ByTestcase => qq{
-                                      SELECT sg.* 
-                                      FROM subgroups sg, testcase_subgroups tcsg
-                                      WHERE tcsg.testcase_id=? AND tcsg.subgroup_id=sg.subgroup_id 
-                                      ORDER by sg.name ASC
-});
-
-#########################################################################
-sub coverage() {
-  my $self = shift;
-  my $platform = shift;
-  my $build_id = shift;
-  my $locale = shift;
-  my $community_only = shift;
-  my $user = shift;
-
-  my $sql = "SELECT COUNT(t.testcase_id) FROM testcase_subgroups tsg, testcases t WHERE tsg.subgroup_id=? AND tsg.testcase_id=t.testcase_id AND t.enabled=1";
-  if ($community_only) {
-    $sql .= " AND t.community_enabled=1";
-  }
-  my $dbh = $self->db_Main();
-  my $sth = $dbh->prepare_cached($sql);
-  $sth->execute(
-                $self->{'subgroup_id'},
-               );
-  my ($num_testcases) = $sth->fetchrow_array;
-
-  $sth->finish;
-
-  if (!$num_testcases or 
-      $num_testcases == 0) { return "N/A" }
-
-
-  $sql = "SELECT t.testcase_id, count(tr.testresult_id) AS num_results
-             FROM testcase_subgroups tsg JOIN testcases t ON (tsg.testcase_id=t.testcase_id) LEFT JOIN test_results tr ON (tr.testcase_id=t.testcase_id) JOIN opsyses o ON (tr.opsys_id=o.opsys_id)
-             WHERE tsg.subgroup_id=? AND tr.build_id=? AND tr.locale_abbrev=? AND o.platform_id=?";
-  if ($community_only) {
-    $sql .= " AND t.community_enabled=1";
-  }
-  if ($user) {
-    $sql .= " AND tr.user_id=" . $user->{'user_id'};
-  }
-  
-  $sql .= " GROUP BY tr.testcase_id";
-
-  $sth = $dbh->prepare_cached($sql);
-  $sth->execute(
-                $self->{'subgroup_id'},
-                $build_id,
-                $locale,
-                $platform->{'platform_id'}
-               );
-  my @test_results = $self->sth_to_objects($sth);
-
-  $sth->finish;
-
-  if (@test_results == 0) { return "0" }
-
-  my $num_completed = 0;
-  foreach my $curtest (@test_results) {
-    if ($curtest->{'num_results'} > 0) {
-      $num_completed++;
-    }
-  }
-  
-  my $result = $num_completed/($num_testcases) * 100;
-  unless ($result) {                   
-    return "0";
-  }
-
-  return sprintf("%d",$result);  
-}
-
-#########################################################################
-sub clone() {
-  my $self = shift;
-
-  my $new_subgroup = $self->copy;
-  if (!$new_subgroup) { 
-    return undef;
-  }
-
-  # Propagate testgroup membership;
-  my $dbh = __PACKAGE__->db_Main();  
-  my $sql = "INSERT INTO subgroup_testgroups (subgroup_id,testgroup_id,sort_order) SELECT ?,testgroup_id,sort_order FROM subgroup_testgroups WHERE subgroup_id=?";
-  
-  my $rows = $dbh->do($sql,
-		      undef,
-		      $new_subgroup->subgroup_id,
-		      $self->subgroup_id
-		     );
-  if (! $rows) {
-    # XXX: Do we need to throw a warning here?
-    # What happens when we clone a subgroup that doesn't belong to  
-    # any testgroups?
-  }  
-
-  $sql = "INSERT INTO testcase_subgroups (testcase_id,subgroup_id,sort_order) SELECT testcase_id,?,sort_order FROM testcase_subgroups WHERE subgroup_id=?";
-  
-  $rows = $dbh->do($sql,
-                   undef,
-                   $new_subgroup->subgroup_id,
-                   $self->subgroup_id
-                  );
-  if (! $rows) {
-    # XXX: Do we need to throw a warning here?
-  }  
-
-  return $new_subgroup;
-}
-
-#########################################################################
-sub delete_from_testgroups() {
-  my $self = shift;
-  
-  my $dbh = __PACKAGE__->db_Main();  
-  my $sql = "DELETE from subgroup_testgroups WHERE subgroup_id=?";
-  return $dbh->do($sql,
-                  undef,
-                  $self->subgroup_id
-                 );
-}
-
-#########################################################################
-sub delete_from_testgroup() {
-  my $self = shift;
-  my $testgroup_id = shift;
-  
-  my $dbh = __PACKAGE__->db_Main();  
-  my $sql = "DELETE from subgroup_testgroups WHERE subgroup_id=? AND testgroup_id=?";
-  return $dbh->do($sql,
-                  undef,
-                  $self->subgroup_id,
-                  $testgroup_id
-                 );
-}
-
-#########################################################################
-sub delete_from_testcases() {
-  my $self = shift;
-  
-  my $dbh = __PACKAGE__->db_Main();  
-  my $sql = "DELETE from testcase_subgroups WHERE subgroup_id=?";
-  return $dbh->do($sql,
-                  undef,
-                  $self->subgroup_id
-                 );
-}
-
-#########################################################################
-sub delete_with_refs() {
-  my $self = shift;
-  $self->delete_from_testgroups();
-  $self->delete_from_testcases();
-  return $self->delete;
-}
-
-#########################################################################
-sub update_testgroups() {
-  my $self = shift;
-  my $new_testgroup_ids = shift;
-  
-  if (scalar @$new_testgroup_ids) {
-    # Failing to delete testgroups is _not_ fatal when adding a new subgroup.
-    my $rv = $self->delete_from_testgroups();
-    my $dbh = __PACKAGE__->db_Main();  
-    my $sql = "INSERT INTO subgroup_testgroups (subgroup_id,testgroup_id,sort_order) VALUES (?,?,1)";
-    foreach my $new_testgroup_id (@$new_testgroup_ids) {
-      my $rows = $dbh->do($sql, 
-			  undef,
-			  $self->subgroup_id,
-			  $new_testgroup_id
-			 );
-    }
-  }
-}
-
-#########################################################################
-sub update_testgroup() {
-  my $self = shift;
-  my $testgroup_id = shift;
-  my $sort_order = shift;
-  
-  # Sort order defaults to 1.
-  if (!$sort_order) {
-    $sort_order = 1;
-  }
-
-  my $rv = $self->delete_from_testgroup($testgroup_id);
-  my $dbh = __PACKAGE__->db_Main();  
-  my $sql = "INSERT INTO subgroup_testgroups (subgroup_id,testgroup_id,sort_order) VALUES (?,?,?)";
-  return $dbh->do($sql, 
-                  undef,
-                  $self->subgroup_id,
-                  $testgroup_id,
-                  $sort_order
-                 );
-}
-
-#########################################################################
-sub update_testcases() {
-  my $self = shift;
-  my $new_testcase_ids = shift;
-  
-  if (scalar @$new_testcase_ids) {
-    # Failing to delete testcases is _not_ fatal when adding a new subgroup.
-    my $rv = $self->delete_from_testcases();
-    my $dbh = __PACKAGE__->db_Main();  
-    my $sql = "INSERT INTO testcase_subgroups (testcase_id,subgroup_id,sort_order) VALUES (?,?,?)";
-    my $sort_order = 1;
-    foreach my $new_testcase_id (@$new_testcase_ids) {
-      next if (!$new_testcase_id);
-      # Log any failures/duplicate keys to STDERR.
-      eval {
-        my $rows = $dbh->do($sql, 
-                            undef,
-                            $new_testcase_id,
-                            $self->subgroup_id,
-                            $sort_order
-                           );
-      };
-      if ($@) {
-        print STDERR $@;
-      }
-      $sort_order++;
-    }
-  }
-}
-
-1;

mozilla/webtools/litmus/Litmus/DB/TestRun.pm

@@ -1,61 +0,0 @@
-# -*- mode: cperl; c-basic-offset: 8; indent-tabs-mode: nil; -*-
-
-=head1 COPYRIGHT
-
- # ***** BEGIN LICENSE BLOCK *****
- # Version: MPL 1.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 Litmus.
- #
- # The Initial Developer of the Original Code is
- # the Mozilla Corporation.
- # Portions created by the Initial Developer are Copyright (C) 2006
- # the Initial Developer. All Rights Reserved.
- #
- # Contributor(s):
- #   Chris Cooper <ccooper@deadsquid.com>
- #   Zach Lipton <zach@zachlipton.com>
- #
- # ***** END LICENSE BLOCK *****
-
-=cut
-
-package Litmus::DB::TestRun;
-
-use strict;
-use base 'Litmus::DBI';
-
-use Time::Piece;
-use Time::Seconds;
-
-Litmus::DB::TestRun->table('test_runs');
-
-Litmus::DB::TestRun->columns(All => qw/test_run_id testgroup_id name description start_timestamp finish_timestamp enabled/);
-
-Litmus::DB::TestRun->column_alias("testgroup_id", "testgroup");
-
-Litmus::DB::TestRun->has_a(testgroup => "Litmus::DB::Testgroup");
-Litmus::DB::TestRun->has_many(subgroups => 
-                                [ "Litmus::DB::SubgroupTestgroup" => "testgroup" ]);
-
-Litmus::DB::TestRun->autoinflate(dates => 'Time::Piece');
-
-1;
-
-
-
-
-
-
-
-

mozilla/webtools/litmus/Litmus/DB/Testcase.pm

@@ -1,377 +0,0 @@
-# -*- mode: cperl; c-basic-offset: 8; indent-tabs-mode: nil; -*-
-
-=head1 COPYRIGHT
-
- # ***** BEGIN LICENSE BLOCK *****
- # Version: MPL 1.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 Litmus.
- #
- # The Initial Developer of the Original Code is
- # the Mozilla Corporation.
- # Portions created by the Initial Developer are Copyright (C) 2006
- # the Initial Developer. All Rights Reserved.
- #
- # Contributor(s):
- #   Chris Cooper <ccooper@deadsquid.com>
- #   Zach Lipton <zach@zachlipton.com>
- #
- # ***** END LICENSE BLOCK *****
-
-=cut
-
-package Litmus::DB::Testcase;
-
-use strict;
-use base 'Litmus::DBI';
-
-use Date::Manip;
-#use Litmus::DB::Testresult;
-use Memoize;
-#use Litmus::Error;
-
-our $default_relevance_threshold = 1.0;
-our $default_match_limit = 25;
-our $default_num_days = 7;
-
-Litmus::DB::Testcase->table('testcases');
-
-Litmus::DB::Testcase->columns(Primary => qw/testcase_id/);
-Litmus::DB::Testcase->columns(Essential => qw/summary details enabled community_enabled format_id regression_bug_id product_id steps expected_results author_id creation_date last_updated version testrunner_case_id testrunner_case_version/);
-
-Litmus::DB::Testcase->column_alias("testcase_id", "testid");
-Litmus::DB::Testcase->column_alias("testcase_id", "test_id");
-Litmus::DB::Testcase->column_alias("testcase_id", "id");
-Litmus::DB::Testcase->column_alias("community_enabled", "communityenabled");
-Litmus::DB::Testcase->column_alias("format_id", "format");
-Litmus::DB::Testcase->column_alias("author_id", "author");
-Litmus::DB::Testcase->column_alias("product_id", "product");
-
-Litmus::DB::Testcase->has_a("format" => "Litmus::DB::Format");
-Litmus::DB::Testcase->has_a("author" => "Litmus::DB::User");
-Litmus::DB::Testcase->has_a("product" => "Litmus::DB::Product");
-
-__PACKAGE__->set_sql(EnabledBySubgroup => qq{
-				             SELECT t.* 
-					     FROM testcases t, testcase_subgroups tsg
-					     WHERE tsg.subgroup_id=? AND tsg.testcase_id=t.testcase_id AND t.enabled=1 
-					     ORDER BY tsg.sort_order ASC
-});
-
-__PACKAGE__->set_sql(BySubgroup => qq{
-SELECT t.* 
-FROM testcases t, testcase_subgroups tsg
-WHERE 
-  tsg.subgroup_id=? AND
-  tsg.testcase_id=t.testcase_id
-  ORDER BY tsg.sort_order ASC
-});
-
-__PACKAGE__->set_sql(ByTestgroup => qq{
-SELECT t.* 
-FROM testcases t, testcase_subgroups tsg, subgroup_testgroups sgtg
-WHERE 
-  tsg.testcase_id=t.testcase_id AND
-  tsg.subgroup_id=sgtg.subgroup_id AND
-  sgtg.testgroup_id = ?
-  ORDER BY tsg.sort_order ASC
-});
-
-__PACKAGE__->set_sql(CommunityEnabledBySubgroup => qq{
-                                                      SELECT t.* 
-                                                      FROM testcases t, testcase_subgroups tsg
-						      WHERE tsg.subgroup_id=? AND tsg.testcase_id=t.testcase_id AND t.enabled=1 AND t.community_enabled=1
-						      ORDER BY tsg.sort_order ASC, t.testcase_id ASC
-});
-
-Litmus::DB::Testcase->has_many(test_results => "Litmus::DB::Testresult", {order_by => 'submission_time DESC'});
-
-Litmus::DB::Testcase->has_many(subgroups => 
-	["Litmus::DB::TestcaseSubgroup" => 'subgroup']);
-
-#########################################################################
-# is_completed($$$$$)
-#
-# Check whether we have test results for the current test that correspond
-# to the provided platform, build_id, and user(optional).
-#########################################################################
-memoize('is_completed');
-sub is_completed {
-  my $self = shift;
-  my $platform = shift;
-  my $build_id = shift;
-  my $locale = shift;
-  my $user = shift;        # optional
-
-  my @results;
-  if ($user) {
-    @results = Litmus::DB::Testresult->search_CompletedByUser(
-                                                              $self->{'testcase_id'},
-                                                              $build_id,
-                                                              $locale->{'abbrev'},
-                                                              $platform->{'platform_id'},
-                                                              $user->{'user_id'},
-                                                             );
-  } else {
-    @results = Litmus::DB::Testresult->search_Completed(
-                                                        $self->{'testcase_id'},
-                                                        $build_id,
-                                                        $locale->{'abbrev'},
-                                                        $platform->{'platform_id'},
-                                                       );
-  }
-
-  return @results;
-}
-
-#########################################################################
-sub getFullTextMatches() {
-  my $self = shift;
-  my $text_snippet = shift;
-  my $match_limit = shift;
-  my $relevance_threshold = shift;
-  
-  if (!$match_limit) {
-    $match_limit = $default_match_limit;
-  }
-  if (!$relevance_threshold) {
-    $relevance_threshold = $default_relevance_threshold
-  }
-  
-  __PACKAGE__->set_sql(FullTextMatches => qq{
-                                             SELECT testcase_id, summary, creation_date, last_updated, MATCH (summary,steps,expected_results) AGAINST (?) AS relevance
-					     FROM testcases
-					     WHERE MATCH (summary,steps,expected_results) AGAINST (?) HAVING relevance > ?
-					     ORDER BY relevance DESC, summary ASC
-                                             LIMIT $match_limit
-});
-  
-  
-  return $self->search_FullTextMatches(
-                                       $text_snippet,
-                                       $text_snippet,
-                                       $relevance_threshold
-                                      );
-}
-
-#########################################################################
-sub getNewTestcases() {
-  my $self = shift;
-  my $num_days = shift;
-  my $match_limit = shift;
-  
-  if (!$num_days) {
-    $num_days = $default_num_days;
-  }
-  
-  if (!$match_limit) {
-    $match_limit = $default_match_limit;
-  }
-  
-  __PACKAGE__->set_sql(NewTestcases => qq{
-				          SELECT testcase_id, summary, creation_date, last_updated
-                                          FROM testcases
-                                          WHERE creation_date>=?
-                                          ORDER BY creation_date DESC
-                                          LIMIT $match_limit
-});
-  
-  my $err;
-  my $new_datestamp=&UnixDate(DateCalc("now","- $num_days days"),"%q");
-  return $self->search_NewTestcases($new_datestamp);
-}
-
-#########################################################################
-sub getRecentlyUpdated() {
-  my $self = shift;
-  my $num_days = shift;
-  my $match_limit = shift;
-  
-  if (!$num_days) {
-    $num_days = $default_num_days;
-  }
-  
-  if (!$match_limit) {
-    $match_limit = $default_match_limit;
-  }
-  
-  __PACKAGE__->set_sql(RecentlyUpdated => qq{
-                                             SELECT testcase_id, summary, creation_date, last_updated
-                                             FROM testcases
-                                             WHERE last_updated>=? AND last_updated>creation_date
-                                             ORDER BY last_updated DESC
-                                             LIMIT $match_limit
-});
-  
-  my $err;
-  my $new_datestamp=&UnixDate(DateCalc("now","- $num_days days"),"%q");
-  return $self->search_RecentlyUpdated($new_datestamp);
-}
-
-#########################################################################
-sub getDefaultMatchLimit() {
-  return $default_match_limit;
-}
-
-#########################################################################
-sub getDefaultRelevanceThreshold() {
-  return $default_relevance_threshold;
-}
-
-#########################################################################
-sub getDefaultNumDays() {
-  return $default_num_days;
-}
-
-#########################################################################
-sub clone() {
-  my $self = shift;
-  
-  my $new_testcase = $self->copy;
-  if (!$new_testcase) {
-    return undef;
-  }
-  
-  # Update dates to now.
-  my $now = &UnixDate("today","%q");
-  $new_testcase->creation_date($now);
-  $new_testcase->last_updated($now);
-  $new_testcase->update();
-  
-  # Propagate subgroup membership;
-  my $dbh = __PACKAGE__->db_Main();
-  my $sql = "INSERT INTO testcase_subgroups (testcase_id,subgroup_id,sort_order) SELECT ?,subgroup_id,sort_order FROM testcase_subgroups WHERE testcase_id=?";
-  
-  my $rows = $dbh->do($sql,
-		      undef,
-		      $new_testcase->testcase_id,
-		      $self->testcase_id
-		     );
-  if (! $rows) {
-    # XXX: Do we need to throw a warning here?
-    # What happens when we clone a testcase that doesn't belong to
-    # any subgroups?
-  }
-  
-  $sql = "INSERT INTO related_testcases (testcase_id, related_testcase_id) VALUES (?,?)";
-  $rows = $dbh->do($sql, 
-                   undef,
-                   $self->testcase_id,
-                   $new_testcase->testcase_id
-                  );
-  if (! $rows) {
-    # XXX: Do we need to throw a warning here?
-  }
-  
-  return $new_testcase;
-}
-
-#########################################################################
-sub delete_from_subgroups() {
-  my $self = shift;
-  
-  my $dbh = __PACKAGE__->db_Main();
-  my $sql = "DELETE from testcase_subgroups WHERE testcase_id=?";
-  return $dbh->do($sql,
-                  undef,
-                  $self->testcase_id
-                 );
-}
-
-#########################################################################
-sub delete_from_subgroup() {
-  my $self = shift;
-  my $subgroup_id = shift;  
-
-  my $dbh = __PACKAGE__->db_Main();
-  my $sql = "DELETE from testcase_subgroups WHERE testcase_id=? AND subgroup_id=?";
-  return $dbh->do($sql,
-                  undef,
-                  $self->testcase_id,
-                  $subgroup_id
-                 );
-}
-
-#########################################################################
-sub delete_from_related() {
-  my $self = shift;
-  
-  my $dbh = __PACKAGE__->db_Main();
-  my $sql = "DELETE from related_testcases WHERE testcase_id=? OR related_testcase_id=?";
-  return $dbh->do($sql,
-                  undef,
-                  $self->testcase_id,
-                  $self->testcase_id
-                 );
-}
-
-#########################################################################
-sub delete_with_refs() {
-  my $self = shift;
-  $self->delete_from_subgroups();
-  $self->delete_from_related();
-  return $self->delete;
-}
-
-#########################################################################
-sub update_subgroups() {
-  my $self = shift;
-  my $new_subgroup_ids = shift;
-  
-  if (scalar @$new_subgroup_ids) {
-    # Failing to delete subgroups is _not_ fatal when adding a new testcase.
-    my $rv = $self->delete_from_subgroups();
-    my $dbh = __PACKAGE__->db_Main();
-    my $sql = "INSERT INTO testcase_subgroups (testcase_id,subgroup_id,sort_order) VALUES (?,?,1)";
-    foreach my $new_subgroup_id (@$new_subgroup_ids) {
-      my $rows = $dbh->do($sql, 
-			  undef,
-			  $self->testcase_id,
-			  $new_subgroup_id
-			 );
-    }
-  }
-}
-
-#########################################################################
-sub update_subgroup() {
-  my $self = shift;
-  my $subgroup_id = shift;
-  my $sort_order = shift;
-
-  # Sort order defaults to 1.
-  if (!$sort_order) {
-    $sort_order = 1;
-  }
-  
-  my $rv = $self->delete_from_subgroup($subgroup_id);
-  my $dbh = __PACKAGE__->db_Main();
-  my $sql = "INSERT INTO testcase_subgroups (testcase_id,subgroup_id,sort_order) VALUES (?,?,?)";
-  return $dbh->do($sql, 
-                  undef,
-                  $self->testcase_id,
-                  $subgroup_id,
-                  $sort_order
-                 );
-}
-
-1;
-
-
-
-
-
-
-
-
-

mozilla/webtools/litmus/Litmus/DB/TestcaseSubgroup.pm

@@ -1,49 +0,0 @@
-# -*- mode: cperl; c-basic-offset: 8; indent-tabs-mode: nil; -*-
-
-=head1 COPYRIGHT
-
- # ***** BEGIN LICENSE BLOCK *****
- # Version: MPL 1.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 Litmus.
- #
- # The Initial Developer of the Original Code is
- # the Mozilla Corporation.
- # Portions created by the Initial Developer are Copyright (C) 2006
- # the Initial Developer. All Rights Reserved.
- #
- # Contributor(s):
- #   Chris Cooper <ccooper@deadsquid.com>
- #   Zach Lipton <zach@zachlipton.com>
- #
- # ***** END LICENSE BLOCK *****
-
-=cut
-
-package Litmus::DB::TestcaseSubgroup;
-
-use strict;
-use base 'Litmus::DBI';
-
-Litmus::DB::TestcaseSubgroup->table('testcase_subgroups');
-
-Litmus::DB::TestcaseSubgroup->columns(All => qw/testcase_id subgroup_id/);
-
-Litmus::DB::TestcaseSubgroup->has_a(testcase_id => "Litmus::DB::Testcase");
-Litmus::DB::TestcaseSubgroup->has_a(subgroup_id => "Litmus::DB::Subgroup");
-
-Litmus::DB::TestcaseSubgroup->column_alias("testcase_id", "testcase");
-Litmus::DB::TestcaseSubgroup->column_alias("testcase_id", "test");
-Litmus::DB::TestcaseSubgroup->column_alias("subgroup_id", "subgroup");
-
-1;

mozilla/webtools/litmus/Litmus/DB/Testgroup.pm

@@ -1,260 +0,0 @@
-# -*- mode: cperl; c-basic-offset: 8; indent-tabs-mode: nil; -*-
-
-=head1 COPYRIGHT
-
- # ***** BEGIN LICENSE BLOCK *****
- # Version: MPL 1.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 Litmus.
- #
- # The Initial Developer of the Original Code is
- # the Mozilla Corporation.
- # Portions created by the Initial Developer are Copyright (C) 2006
- # the Initial Developer. All Rights Reserved.
- #
- # Contributor(s):
- #   Chris Cooper <ccooper@deadsquid.com>
- #   Zach Lipton <zach@zachlipton.com>
- #
- # ***** END LICENSE BLOCK *****
-
-=cut
-
-package Litmus::DB::Testgroup;
-
-use strict;
-use base 'Litmus::DBI';
-
-Litmus::DB::Testgroup->table('testgroups');
-
-Litmus::DB::Testgroup->columns(All => qw/testgroup_id product_id name enabled testrunner_plan_id/);
-Litmus::DB::Testgroup->columns(Essential => qw/testgroup_id product_id name enabled testrunner_plan_id/);
-
-Litmus::DB::Testgroup->column_alias("product_id", "product");
-
-Litmus::DB::Testgroup->has_a(product => "Litmus::DB::Product");
-
-__PACKAGE__->set_sql(EnabledByBranch => qq{
-                                           SELECT tg.* 
-                                           FROM testgroups tg, testgroup_branches tgb
-                                           WHERE tgb.branch_id=? AND tgb.testgroup_id=tg.testgroup_id AND tg.enabled=1 ORDER by tg.name ASC
-});
-
-__PACKAGE__->set_sql(ByBranch => qq{
-                                    SELECT tg.* 
-                                    FROM testgroups tg, testgroup_branches tgb
-                                    WHERE tgb.branch_id=? AND tgb.testgroup_id=tg.testgroup_id ORDER by tg.name ASC
-});
-
-__PACKAGE__->set_sql(EnabledBySubgroup => qq{
-                                             SELECT tg.* 
-                                             FROM testgroups tg, subgroup_testgroups sgtg
-                                             WHERE sgtg.subgroup_id=? AND sgtg.testgroup_id=tg.testgroup_id AND tg.enabled=1 ORDER by tg.name ASC
-});
-
-__PACKAGE__->set_sql(BySubgroup => qq{
-                                      SELECT tg.* 
-                                      FROM testgroups tg, subgroup_testgroups sgtg
-                                      WHERE sgtg.subgroup_id=? AND sgtg.testgroup_id=tg.testgroup_id ORDER by tg.name ASC
-});
-
-__PACKAGE__->set_sql(EnabledByTestcase => qq{
-                                             SELECT tg.* 
-                                             FROM testgroups tg, subgroup_testgroups sgtg, testcase_subgroups tcsg
-                                             WHERE tcsg.testcase_id=? AND tcsg.subgroup_id=sgtg.subgroup_id AND sgtg.testgroup_id=tg.testgroup_id AND tg.enabled=1 ORDER by tg.name ASC
-});
-
-__PACKAGE__->set_sql(ByTestcase => qq{
-                                      SELECT tg.* 
-                                      FROM testgroups tg, subgroup_testgroups sgtg, testcase_subgroups tcsg
-                                      WHERE tcsg.testcase_id=? AND tcsg.subgroup_id=sgtg.subgroup_id AND sgtg.testgroup_id=tg.testgroup_id ORDER by tg.name ASC
-});
-
-#########################################################################
-sub coverage {
-  my $self = shift;
-  my $platform = shift;
-  my $build_id = shift;
-  my $locale = shift;
-  my $community_only = shift;
-  my $user = shift;
-
-  my $percent_completed = 0;
-
-  my @subgroups = Litmus::DB::Subgroup->search_EnabledByTestgroup($self->testgroup_id);
-  my $num_empty_subgroups = 0;
-  foreach my $subgroup (@subgroups) {
-    my $subgroup_percent = $subgroup->coverage(
-                                               $platform, 
-                                               $build_id, 
-                                               $locale,
-                                               $community_only,
-                                               $user,
-                                              );
-    if ($subgroup_percent eq "N/A") {
-      $num_empty_subgroups++;
-    } else {
-      $percent_completed += $subgroup_percent;
-    }
-  }
-  
-  if (scalar(@subgroups) - $num_empty_subgroups == 0) { 
-    return "N/A"
-  }
-  my $total_percentage = $percent_completed / 
-    (scalar @subgroups - $num_empty_subgroups);
-  
-  return sprintf("%d",$total_percentage);
-}
-
-#########################################################################
-sub clone() {
-  my $self = shift;
-
-  my $new_testgroup = $self->copy;
-  if (!$new_testgroup) {
-    return undef;
-  }
-
-  # Propagate testgroup membership;
-  my $dbh = __PACKAGE__->db_Main();
-  my $sql = "INSERT INTO subgroup_testgroups (subgroup_id,testgroup_id,sort_order) SELECT subgroup_id,?,sort_order FROM subgroup_testgroups WHERE testgroup_id=?";
-
-  my $rows = $dbh->do($sql,
-		      undef,
-		      $new_testgroup->testgroup_id,
-		      $self->testgroup_id
-		     );
-  if (! $rows) {
-    # XXX: Do we need to throw a warning here?
-  }  
-
-  return $new_testgroup;
-}
-
-#########################################################################
-sub delete_from_subgroups() {
-  my $self = shift;
-
-  my $dbh = __PACKAGE__->db_Main();  
-  my $sql = "DELETE from subgroup_testgroups WHERE testgroup_id=?";
-  my $rows = $dbh->do($sql,
-                      undef,
-                      $self->testgroup_id
-                     );
-}
-
-#########################################################################
-sub delete_from_test_runs() {
-  my $self = shift;
-
-  # XXX: Placeholder for test runs.
-  return;
-}
-
-#########################################################################
-sub delete_with_refs() {
-  my $self = shift;
-  $self->delete_from_subgroups();
-  $self->delete_from_test_runs();
-  return $self->delete;
-}
-
-#########################################################################
-sub update_subgroups() {
-  my $self = shift;
-  my $new_subgroup_ids = shift;
-  
-  if (scalar @$new_subgroup_ids) {
-    # Failing to delete subgroups is _not_ fatal when adding a new testgroup.
-    my $rv = $self->delete_from_subgroups();
-    my $dbh = __PACKAGE__->db_Main();  
-    my $sql = "INSERT INTO subgroup_testgroups (subgroup_id,testgroup_id,sort_order) VALUES (?,?,?)";
-    my $sort_order = 1;
-    foreach my $new_subgroup_id (@$new_subgroup_ids) {
-      next if (!$new_subgroup_id);
-      # Log any failures/duplicate keys to STDERR.
-      eval {
-        my $rows = $dbh->do($sql, 
-                            undef,
-                            $new_subgroup_id,
-                            $self->testgroup_id,
-                            $sort_order
-                           );
-      };
-      if ($@) {
-        print STDERR $@;
-      }
-      $sort_order++;
-    }
-  }
-}
-
-#########################################################################
-sub update_branches() {
-  my $self = shift;
-  my $new_branch_ids = shift;
-  
-  if (scalar @$new_branch_ids) {
-    # Failing to delete branches is _not_ fatal when adding a new testgroup.
-    my $rv = $self->delete_from_branches();
-    my $dbh = __PACKAGE__->db_Main();  
-    my $sql = "INSERT INTO testgroup_branches (testgroup_id,branch_id) VALUES (?,?)";
-    foreach my $new_branch_id (@$new_branch_ids) {
-      next if (!$new_branch_id);
-      # Log any failures/duplicate keys to STDERR.
-      eval {
-        my $rows = $dbh->do($sql, 
-                            undef,
-                            $self->testgroup_id,
-                            $new_branch_id,
-                           );
-      };
-      if ($@) {
-        print STDERR $@;
-      }
-    }
-  }
-}
-
-#########################################################################
-sub add_branch() {
-  my $self = shift;
-  my $new_branch_id = shift;
-  
-  # Failure to insert isn't fatal in the case of a collision, but we do want
-  # to log it.
-  my $dbh = __PACKAGE__->db_Main();  
-  my $sql = "INSERT INTO testgroup_branches (testgroup_id,branch_id) VALUES (?,?)";
-  # Log any failures/duplicate keys to STDERR.
-  eval {
-    my $rows = $dbh->do($sql, 
-                        undef,
-                        $self->testgroup_id,
-                        $new_branch_id,
-                       );
-  };
-  if ($@) {
-    print STDERR $@;
-  }
-}
-
-1;
-
-
-
-
-
-
-
-

mozilla/webtools/litmus/Litmus/DB/Testresult.pm

@@ -1,390 +0,0 @@
-# -*- mode: cperl; c-basic-offset: 8; indent-tabs-mode: nil; -*-
-
-=head1 COPYRIGHT
-
- # ***** BEGIN LICENSE BLOCK *****
- # Version: MPL 1.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 Litmus.
- #
- # The Initial Developer of the Original Code is
- # the Mozilla Corporation.
- # Portions created by the Initial Developer are Copyright (C) 2006
- # the Initial Developer. All Rights Reserved.
- #
- # Contributor(s):
- #   Chris Cooper <ccooper@deadsquid.com>
- #   Zach Lipton <zach@zachlipton.com>
- #
- # ***** END LICENSE BLOCK *****
-
-=cut
-
-package Litmus::DB::Testresult;
-
-use strict;
-use base 'Litmus::DBI';
-
-use Date::Manip;
-use Time::Piece;
-use Time::Seconds;
-use Memoize;
-
-our $_num_results_default = 15;
-
-Litmus::DB::Testresult->table('test_results');
-
-Litmus::DB::Testresult->columns(All => qw/testresult_id testcase_id last_updated submission_time user_id opsys_id branch_id build_id user_agent result_status_id build_type_id machine_name exit_status_id duration_ms talkback_id valid vetted validated_by_user_id vetted_by_user_id validated_timestamp vetted_timestamp locale_abbrev is_automated_result/);
-
-Litmus::DB::Testresult->column_alias("testcase_id", "testcase");
-Litmus::DB::Testresult->column_alias("submission_time", "timestamp");
-Litmus::DB::Testresult->column_alias("user_id", "user");
-Litmus::DB::Testresult->column_alias("opsys_id", "opsys");
-Litmus::DB::Testresult->column_alias("branch_id", "branch");
-Litmus::DB::Testresult->column_alias("user_agent", "useragent");
-Litmus::DB::Testresult->column_alias("result_status_id", "result_status");
-Litmus::DB::Testresult->column_alias("build_type_id", "build_type");
-Litmus::DB::Testresult->column_alias("exit_status_id", "exit_status");
-Litmus::DB::Testresult->column_alias("validity_id", "validity");
-Litmus::DB::Testresult->column_alias("vetting_status_id", "vetting_status");
-Litmus::DB::Testresult->column_alias("locale_abbrev", "locale");
-Litmus::DB::Testresult->column_alias("is_automated_result", "isAutomated");
-
-Litmus::DB::Testresult->has_a(opsys => "Litmus::DB::Opsys");
-Litmus::DB::Testresult->has_a(branch => "Litmus::DB::Branch");
-Litmus::DB::Testresult->has_a(testcase => "Litmus::DB::Testcase");
-Litmus::DB::Testresult->has_a(result_status => "Litmus::DB::ResultStatus");
-Litmus::DB::Testresult->has_a(user => "Litmus::DB::User");
-Litmus::DB::Testresult->has_a(useragent => "Litmus::UserAgentDetect");
-Litmus::DB::Testresult->has_a(build_type => "Litmus::DB::BuildType");
-Litmus::DB::Testresult->has_a(exit_status => "Litmus::DB::ExitStatus");
-Litmus::DB::Testresult->has_a(locale => "Litmus::DB::Locale");
-Litmus::DB::Testresult->has_a(platform => 
-                              [ "Litmus::DB::Opsys" => "platform" ]);
-
-Litmus::DB::Testresult->has_many(logs => 
-						  ["Litmus::DB::LogTestresult" => 'log_id']);
-Litmus::DB::Testresult->has_many(comments => "Litmus::DB::Comment", {order_by => 'comment_id ASC, submission_time ASC'});
-Litmus::DB::Testresult->has_many(bugs => "Litmus::DB::Resultbug", {order_by => 'bug_id ASC, submission_time DESC'});
-
-Litmus::DB::Testresult->autoinflate(dates => 'Time::Piece');
-
-Litmus::DB::Testresult->set_sql(DefaultTestResults => qq{
-    SELECT tr.testresult_id,tr.testcase_id,t.summary,tr.submission_time AS created,p.name AS platform_name,pr.name as product_name,trsl.name AS result_status,trsl.class_name result_status_class,b.name AS branch_name,tg.name AS test_group_name, tr.locale_abbrev, u.email
-    FROM test_results tr, testcases t, platforms p, opsyses o, branches b, products pr, test_result_status_lookup trsl, testgroups tg, subgroups sg, users u, testcase_subgroups tcsg, subgroup_testgroups sgtg
-    WHERE tr.testcase_id=t.testcase_id AND tr.opsys_id=o.opsys_id AND o.platform_id=p.platform_id AND tr.branch_id=b.branch_id AND b.product_id=pr.product_id AND tr.result_status_id=trsl.result_status_id AND tcsg.testcase_id=tr.testcase_id AND tcsg.subgroup_id=sg.subgroup_id AND sg.subgroup_id=sgtg.subgroup_id AND sgtg.testgroup_id=tg.testgroup_id AND tr.user_id=u.user_id AND tr.valid=1
-    ORDER BY tr.submission_time DESC, t.testcase_id DESC
-    LIMIT $_num_results_default 
-});
-
-Litmus::DB::Testresult->set_sql(CommonResults => qq{ 
-    SELECT COUNT(tr.testcase_id) AS num_results, tr.testcase_id, t.summary, MAX(tr.submission_time) AS most_recent, MAX(tr.testresult_id) AS max_id 
-    FROM test_results tr, testcases t, test_result_status_lookup trsl 
-    WHERE tr.testcase_id=t.testcase_id AND tr.result_status_id=trsl.result_status_id AND trsl.class_name=? 
-    GROUP BY tr.testcase_id 
-    ORDER BY num_results DESC, tr.testresult_id DESC 
-    LIMIT 15
-    });
-
-Litmus::DB::Testresult->set_sql(Completed => qq{
-    SELECT tr.* 
-    FROM test_results tr, opsyses o
-    WHERE tr.testcase_id=? AND 
-        tr.build_id=? AND 
-        tr.locale_abbrev=? AND
-        tr.opsys_id=o.opsys_id AND
-        o.platform_id=?
-    ORDER BY tr.submission_time DESC
-});
-
-Litmus::DB::Testresult->set_sql(CompletedByUser => qq{
-    SELECT tr.* 
-    FROM test_results tr, opsyses o
-    WHERE tr.testcase_id=? AND 
-        tr.build_id=? AND 
-        tr.locale_abbrev=? AND
-        tr.opsys_id=o.opsys_id AND
-        o.platform_id=? AND
-        tr.user_id=?
-    ORDER BY tr.submission_time DESC
-});
-
-#########################################################################
-# for historical reasons, note() is a shorthand way of saying "the text of 
-# the first comment on this result if that comment was submitted by the 
-# result submitter"
-#########################################################################
-sub note {
-    my $self = shift;
-    
-    my @comments = $self->comments();
-    
-    if (@comments && $comments[0] &&
-        $comments[0]->user() == $self->user()) {
-        return $comments[0]->comment();
-    } else {
-        return undef;
-    }
-}
-
-#########################################################################
-# is this test result from a trusted user?
-#########################################################################
-sub istrusted {
-  my $self = shift; 
-  
-   if ($self->user()->istrusted()) {
-    return 1;
-  } else {
-    return 0;
-  }
-}
-
-#########################################################################
-# &getDefaultTestResults($)
-#
-#########################################################################
-sub getDefaultTestResults($) {
-    my $self = shift;
-    my @rows = $self->search_DefaultTestResults();
-    my $criteria = "Default<br/>Ordered by Created<br/>Limit to $_num_results_default results";
-    return $criteria, \@rows;
-}
-
-#########################################################################
-# &getTestResults($\@\@$)
-# 
-######################################################################### 
-sub getTestResults($\@\@$) {
-    my ($self,$where_criteria,$order_by_criteria,$limit_value) = @_;
-    
-    my $select = 'SELECT tr.testresult_id,tr.testcase_id,t.summary,tr.submission_time AS created,p.name AS platform_name,pr.name as product_name,trsl.name AS result_status,trsl.class_name AS result_status_class,b.name AS branch_name,tg.name AS test_group_name, tr.locale_abbrev, u.email';
-    
-    my $from = 'FROM test_results tr, testcases t, platforms p, opsyses o, branches b, products pr, test_result_status_lookup trsl, testgroups tg, subgroups sg, users u, testcase_subgroups tcsg, subgroup_testgroups sgtg';
-    
-    my $where = 'WHERE tr.testcase_id=t.testcase_id AND tr.opsys_id=o.opsys_id AND o.platform_id=p.platform_id AND tr.branch_id=b.branch_id AND b.product_id=pr.product_id AND tr.result_status_id=trsl.result_status_id AND tcsg.testcase_id=tr.testcase_id AND tcsg.subgroup_id=sg.subgroup_id AND sg.subgroup_id=sgtg.subgroup_id AND sgtg.testgroup_id=tg.testgroup_id AND tr.user_id=u.user_id AND tr.valid=1';
-    
-    my $limit = 'LIMIT ';
-
-    foreach my $criterion (@$where_criteria) {
-         $criterion->{'value'} =~ s/'/\'/g;
-        if ($criterion->{'field'} eq 'branch') {
-            $where .= " AND b.name='" . $criterion->{'value'} . "'";
-        } elsif ($criterion->{'field'} eq 'locale') {
-            $where .= " AND tr.locale_abbrev='" . $criterion->{'value'} . "'";
-        } elsif ($criterion->{'field'} eq 'product') {
-            $where .= " AND pr.name='" . $criterion->{'value'} . "'";
-        } elsif ($criterion->{'field'} eq 'platform') {
-            $where .= " AND p.name='" . $criterion->{'value'} . "'";
-        } elsif ($criterion->{'field'} eq 'test_group') {
-            $where .= " AND tg.name='" . $criterion->{'value'} . "'";
-        } elsif ($criterion->{'field'} eq 'testcase_id') {
-            $where .= " AND tr.testcase_id='" . $criterion->{'value'} . "'";
-        } elsif ($criterion->{'field'} eq 'summary') {
-            $where .= ' AND t.summary LIKE \'%%' . $criterion->{'value'} . '%%\'';
-        } elsif ($criterion->{'field'} eq 'email') {
-            $where .= ' AND u.email LIKE \'%%' . $criterion->{'value'} . '%%\'';
-        } elsif ($criterion->{'field'} eq 'result_status') {
-            $where .= " AND trsl.class_name='" . $criterion->{'value'} . "'";
-        } elsif ($criterion->{'field'} eq 'trusted_only') {            
-            if ($from !~ /users u/) {
-                $from .= ", users u";
-            }
-            $where .= " AND u.user_id=tr.user_id AND u.is_admin=1";
-        } elsif ($criterion->{'field'} eq 'start_date') {
-            my $start_timestamp = &Date::Manip::UnixDate(&Date::Manip::ParseDateString($criterion->{'value'}),"%q");
-            if ($start_timestamp !~ /^\d\d\d\d\d\d\d\d\d\d\d\d\d\d$/) {
-                print STDERR "Unable to parse a valid start date from '$criterion->{'value'},' ignoring.\n";
-            } else {
-                $where .= " AND tr.submission_time>=$start_timestamp";
-            }
-        } elsif ($criterion->{'field'} eq 'end_date') {
-            my $end_timestamp = &Date::Manip::UnixDate(&Date::Manip::ParseDateString($criterion->{'value'}),"%q");
-            if ($end_timestamp !~ /^\d\d\d\d\d\d\d\d\d\d\d\d\d\d$/) {
-                print STDERR "Unable to parse a valid end date from '$criterion->{'value'},' ignoring.\n";
-            } else {
-                $where .= " AND tr.submission_time<=$end_timestamp";
-            }
-        } elsif ($criterion->{'field'} eq 'timespan') {
-            next if ($criterion->{'value'} eq 'all');
-            my $day_delta = $criterion->{'value'};
-            my $err;
-            my $timestamp = 
-                &Date::Manip::UnixDate(&Date::Manip::DateCalc("now",
-                                                              "$day_delta days",
-                                                              \$err),
-                                       "%q");
-            $where .= " AND tr.submission_time>=$timestamp";
-
-        } elsif ($criterion->{'field'} eq 'search_field') {
-            ($from,$where) = &_processSearchField($criterion,$from,$where);
-        } else {
-            # Skip unknown field
-        }
-    }
-
-    my $order_by = 'ORDER BY ';
-    foreach my $criterion (@$order_by_criteria) {
-        # Skip empty fields.
-        next if (!$criterion or !$criterion->{'field'});
-
-        if ($criterion->{'field'} eq 'created') {
-            $order_by .= "tr.submission_time $criterion->{'direction'},";
-        } elsif ($criterion->{'field'} eq 'product') {
-            $order_by .= "pr.name $criterion->{'direction'},";
-        } elsif ($criterion->{'field'} eq 'platform') {
-            $order_by .= "p.name $criterion->{'direction'},";
-        } elsif ($criterion->{'field'} eq 'test_group') {
-            $order_by .= "tg.name $criterion->{'direction'},";
-        } elsif ($criterion->{'field'} eq 'testcase_id') {
-            $order_by .= "tr.testcase_id $criterion->{'direction'},";
-        } elsif ($criterion->{'field'} eq 'summary') {
-            $order_by .= "t.summary $criterion->{'direction'},";
-        } elsif ($criterion->{'field'} eq 'result_status') {
-            $order_by .= "trsl.class_name $criterion->{'direction'},";
-        } elsif ($criterion->{'field'} eq 'branch') {
-            $order_by .= "b.name $criterion->{'direction'},";
-        } elsif ($criterion->{'field'} eq 'locale') {
-            $order_by .= "tr.locale_abbrev $criterion->{'direction'},";
-        } elsif ($criterion->{'field'} eq 'email') {
-            $order_by .= "u.email $criterion->{'direction'},";
-        } else {
-            # Skip unknown field
-        }
-    }
-    if ($order_by eq 'ORDER BY ') {
-        $order_by .= 'tr.submission_time DESC';
-    } else {
-        chop($order_by);
-    }
-
-    if ($limit_value and $limit_value ne '') {
-        $limit .= "$limit_value";
-    } else {
-        $limit .= "$_num_results_default";
-    }
-    
-    my $sql = "$select $from $where $order_by $limit";
-#print $sql,"<br/>\n";
-    Litmus::DB::Testresult->set_sql(TestResults => qq{
-        $sql
-        });
-
-    my @rows = $self->search_TestResults();
-    
-    return \@rows;
-}
-
-#########################################################################
-# &_processSearchField(\%\$\$)
-# 
-######################################################################### 
-sub _processSearchField(\%) {
-    my ($search_field,$from,$where) = @_;
- 
-    my $table_field = "";
-    if ($search_field->{'search_field'} eq 'build_id') {
-        $table_field='tr.build_id';
-    } elsif ($search_field->{'search_field'} eq 'comments') {
-        $table_field='c.comment';        
-    } elsif ($search_field->{'search_field'} eq 'locale') {
-        $table_field='tr.locale_abbrev';        
-    } elsif ($search_field->{'search_field'} eq 'opsys') {
-        $table_field='o.name';
-    } elsif ($search_field->{'search_field'} eq 'platform') {
-        $table_field='p.name';
-    } elsif ($search_field->{'search_field'} eq 'product') {
-        $table_field='pr.name';
-    } elsif ($search_field->{'search_field'} eq 'result_status') {
-        $table_field='trsl.name';        
-    } elsif ($search_field->{'search_field'} eq 'subgroup') {
-        $table_field='sg.name';        
-    } elsif ($search_field->{'search_field'} eq 'email') {
-        if ($from !~ /users u/) {
-            $from .= ", users u";
-            $where .= " AND tr.user_id=u.user_id";
-        }
-        $table_field='u.email';        
-    } elsif ($search_field->{'search_field'} eq 'summary') {
-        $table_field='t.summary';
-    } elsif ($search_field->{'search_field'} eq 'test_group') {
-        $table_field='tg.name';        
-    } elsif ($search_field->{'search_field'} eq 'user_agent') {
-        $table_field='tr.user_agent';        
-    } else {
-        return ($from,$where);
-    }
-
-    if ($search_field->{'match_criteria'} eq 'contains_all' or
-        $search_field->{'match_criteria'} eq 'contains_any' or
-        $search_field->{'match_criteria'} eq 'not_contain_any') {
-        
-        my $join = "";
-        if ($search_field->{'match_criteria'} eq 'contains_all') {
-            $join = 'AND';
-        } else {
-            $join = 'OR';
-        }
-
-        my @words = split(/ /,$search_field->{'value'});
-        if ($search_field->{'match_criteria'} eq 'not_contain_any') {
-            $where .= " AND NOT (";
-        } else {
-            $where .= " AND (";
-        }
-        my $first_pass = 1;
-        foreach my $word (@words) {
-            if ( $first_pass ) {
-                $where .= "UPPER($table_field) LIKE UPPER('%%" . $word . "%%')";
-                $first_pass = 0;
-            } else {
-                $where .= " $join UPPER($table_field) LIKE UPPER('%%" . $word . "%%')";
-            }
-        }
-        $where .= ")";        
-    } elsif ($search_field->{'match_criteria'} eq 'contains') {
-        $where .= " AND UPPER($table_field) LIKE UPPER('%%" . $search_field->{'value'} . "%%')";
-    } elsif ($search_field->{'match_criteria'} eq 'contains_case') {
-        $where .= " AND $table_field LIKE '%%" . $search_field->{'value'} . "%%'";
-    } elsif ($search_field->{'match_criteria'} eq 'not_contain') {
-        $where .= " AND UPPER($table_field) NOT LIKE UPPER('%%" . $search_field->{'value'} . "%%')";
-    } elsif ($search_field->{'match_criteria'} eq 'regexp') {
-        $where .= " AND $table_field REGEXP '" . $search_field->{'value'} . "'";        
-    } elsif ($search_field->{'match_criteria'} eq 'not_regexp') {        
-        $where .= " AND $table_field NOT REGEXP '" . $search_field->{'value'} . "'";        
-    } else {
-      # Ignore unknown match criteria.
-      return ($from,$where);
-    }
-
-    return ($from,$where);
-}
-
-#########################################################################
-#########################################################################
-sub getCommonResults($$) {
-    my ($self,$status,$limit_value) = @_;
-    
-    if (!$status) {
-      return undef;
-    }
-    
-    if (!$limit_value) {
-        $limit_value = $_num_results_default;
-    }
-
-    my @rows = $self->search_CommonResults($status);
-    return \@rows;    
-}
-
-1;

mozilla/webtools/litmus/Litmus/DB/User.pm

@@ -1,119 +0,0 @@
-# -*- mode: cperl; c-basic-offset: 8; indent-tabs-mode: nil; -*-
-
-=head1 COPYRIGHT
-
- # ***** BEGIN LICENSE BLOCK *****
- # Version: MPL 1.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 Litmus.
- #
- # The Initial Developer of the Original Code is
- # the Mozilla Corporation.
- # Portions created by the Initial Developer are Copyright (C) 2006
- # the Initial Developer. All Rights Reserved.
- #
- # Contributor(s):
- #   Chris Cooper <ccooper@deadsquid.com>
- #   Zach Lipton <zach@zachlipton.com>
- #
- # ***** END LICENSE BLOCK *****
-
-=cut
-
-package Litmus::DB::User;
-
-use strict;
-use Litmus::Config;
-use base 'Litmus::DBI';
-
-Litmus::DB::User->table('users');
-
-Litmus::DB::User->columns(All => qw/user_id bugzilla_uid email password realname irc_nickname enabled is_admin authtoken/);
-
-Litmus::DB::User->column_alias("is_trusted", "istrusted");
-Litmus::DB::User->column_alias("is_admin", "is_trusted");
-
-Litmus::DB::User->has_many(test_results => "Litmus::DB::Testresult");
-Litmus::DB::User->has_many(sessions => "Litmus::DB::Session");
-
-# ZLL: only load BugzillaUser if Bugzilla Auth is actually enabled
-if ($Litmus::Config::bugzilla_auth_enabled) {
-	Litmus::DB::User->has_a(bugzilla_uid => "Litmus::DB::BugzillaUser");
-}
-
-__PACKAGE__->set_sql(RetrieveAll => qq{
-                                       SELECT __ESSENTIAL__
-                                       FROM   __TABLE__
-                                       ORDER BY email ASC
-});
-
-__PACKAGE__->set_sql(TopTesters => qq{
-                                      SELECT users.user_id, users.email, count(*) AS num_results
-                                      FROM users, test_results
-                                      WHERE users.user_id=test_results.user_id
-                                      GROUP BY user_id
-                                      ORDER BY num_results DESC
-                                      LIMIT 15
-});
-
-# the COLLATE latin1_general_ci sillyness forces a case-insensitive match
-# removed a LIMIT 300 to work around a mysql bug in the ancient version
-# on rodan
-__PACKAGE__->set_sql(FullTextMatches => q{
-	SELECT *
-	FROM __TABLE__ 
-	WHERE 
-	  email COLLATE latin1_general_ci like concat('%%',?,'%%') OR 
-	  irc_nickname COLLATE latin1_general_ci  like concat('%%',?,'%%') OR 
-	  realname COLLATE latin1_general_ci like concat('%%',?,'%%') 
-	ORDER BY email ASC
-});
-
-
-
-#########################################################################
-# returns the crypt'd password from a linked Bugzilla account if it 
-# exists or the Litmus user account
-sub getRealPasswd {
-  my $self = shift;
-  if ($self->bugzilla_uid()) {
-    return $self->bugzilla_uid()->cryptpassword();
-  } else {
-    return $self->password();
-  }
-}
-
-#########################################################################
-sub getDisplayName() {
-  my $self = shift;
-  
-  return $self->irc_nickname if ($self->irc_nickname and
-                                 $self->irc_nickname ne '');
-  return $self->realname if ($self->realname and
-                             $self->realname ne '');
-  
-  if ($self->email and
-      $self->email ne '') {
-    my $display_name = $self->email;
-    $display_name =~ s/\@.*$//g;
-    return $display_name
-  }
-
-  return undef;
-}
-
-
-1;
-
-
-

mozilla/webtools/litmus/Litmus/DBI.pm

@@ -1,130 +0,0 @@
-# -*- mode: cperl; c-basic-offset: 8; indent-tabs-mode: nil; -*-
-
-=head1 COPYRIGHT
-
- # ***** BEGIN LICENSE BLOCK *****
- # Version: MPL 1.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 Litmus.
- #
- # The Initial Developer of the Original Code is
- # the Mozilla Corporation.
- # Portions created by the Initial Developer are Copyright (C) 2006
- # the Initial Developer. All Rights Reserved.
- #
- # Contributor(s):
- #   Chris Cooper <ccooper@deadsquid.com>
- #   Zach Lipton <zach@zachlipton.com>
- #
- # ***** END LICENSE BLOCK *****
-
-=cut
-
-package Litmus::DBI;
-
-require Apache::DBI;
-use strict;
-use warnings;
-use Litmus::Config;
-use Memoize;
-
-use base 'Class::DBI::mysql';
-
-our $dsn = "dbi:mysql:database=$Litmus::Config::db_name;host=$Litmus::Config::db_host;port=3306";
-
-
-
-our %column_aliases;
-
-Litmus::DBI->connection( $dsn,
-                         $Litmus::Config::db_user,
-                         $Litmus::Config::db_pass,
-                         	{AutoCommit=>1}
-                         );
-Litmus::DBI->autoupdate(1);
-                         
-# In some cases, we have column names that make sense from a database perspective
-# (i.e. subgroup_id), but that don't make sense from a class/object perspective 
-# (where subgroup would be more appropriate). To handle this, we allow for 
-# Litmus::DBI's subclasses to set column aliases with the column_alias() sub. 
-# Takes the database column name and the alias name. 
-sub column_alias {
-    my ($self, $db_name, $alias_name) = @_;
-    
-    $column_aliases{$alias_name} = $db_name;
-}
-
-# here's where the actual work happens. We consult our alias list 
-# (as created by calls to column_alias()) and substitute the 
-# database column if we find a match
-memoize('find_column');
-sub find_column {
-    my $self = shift;
-    my $wanted = shift;
-    
-    if (ref $self) {
-        $wanted =~ s/^.*::(\w+)$/$1/;
-    }
-    if ($column_aliases{$wanted}) {
-        return $column_aliases{$wanted};
-    } else {
-        # not an alias, so we use the normal 
-        # find_column() from Class::DBI
-        $self->SUPER::find_column($wanted);
-    }
-}
-
-sub AUTOLOAD {
-    my $self = shift;
-    my @args = @_;
-    my $name = our $AUTOLOAD;
-    
-    my $col = $self->find_column($name);
-    if (!$col) {
-        internalError("tried to call Litmus::DBI method $name which does not exist");
-    }
-    
-    return $self->$col(@args);
-}
-        
-sub _croak {
-	my ($self, $message, %info) = @_;
-	internalError($message);
-	return;
-}
-
-# Get Class::DBI's default dbh options
-my $db_options = { __PACKAGE__->_default_attributes };
-
-__PACKAGE__->_remember_handle('Main'); # so dbi_commit works
-
-# override default to avoid using Ima::DBI closure
-sub db_Main {
-   my $dbh;
-   if ( $ENV{'MOD_PERL'} and !$Apache::ServerStarting ) {
-	   $dbh = Apache->request()->pnotes('dbh');
-   }
-   if ( !$dbh ) {
-	   $dbh = DBI->connect(
-		   $dsn,  $Litmus::Config::db_user,
-		   $Litmus::Config::db_pass, $db_options
-	   );
-	   if ( $ENV{'MOD_PERL'} and !$Apache::ServerStarting ) {
-		   Apache->request()->pnotes( 'dbh', $dbh );
-	   }
-   }
-   return $dbh;
-}
-
-1;
-

mozilla/webtools/litmus/Litmus/DBTools.pm

@@ -1,275 +0,0 @@
- # 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 Litmus.
- #
- # The Initial Developer of the Original Code is
- # the Mozilla Corporation.
- # Portions created by the Initial Developer are Copyright (C) 2006
- # the Initial Developer. All Rights Reserved.
- #
- # Contributor(s):
- #   Chris Cooper <ccooper@deadsquid.com>
- #   Zach Lipton <zach@zachlipton.com>
-
-# Utility functions (based on those from Bugzilla's checksetup.pl to 
-# create new fields and indicies to the schema when upgrading an installation.
-
-package Litmus::DBTools;
-
-use strict;
-
-#########################################################################
-sub new {
-	my ($class, $dbh) = @_;
-	my $self = {};
-	$self->{'dbh'} = $dbh;
-	bless($self);
-	return $self;
-}
-
-#########################################################################
-sub ChangeFieldType {
-    my ($self, $table, $field, $newtype) = @_;
-
-    my $ref = $self->GetFieldDef($table, $field);
-    #print "0: $$ref[0]   1: $$ref[1]   2: $$ref[2]   3: $$ref[3]  4: $$ref[4]\n";
-
-    my $oldtype = $ref->[1];
-    if (! $ref->[2]) {
-        $oldtype .= qq{ not null};
-    }
-    if ($ref->[4]) {
-        $oldtype .= qq{ default "$ref->[4]"};
-    }
-
-    if ($oldtype ne $newtype) {
-        print "Updating field type $field in table $table ...\n";
-        print "old: $oldtype\n";
-        print "new: $newtype\n";
-#        'not null' should be passed as part of the call to ChangeFieldType()
-#        $newtype .= " NOT NULL" if $$ref[3];
-        $self->{'dbh'}->do("ALTER TABLE $table
-                  CHANGE $field
-                  $field $newtype");
-    }
-}
-
-#########################################################################
-sub RenameTable {
-    my ($self, $table, $newname) = @_;
-
-    my $ref = $self->TableExists($table);
-    return unless $ref; # already renamed?
-
-    $self->{'dbh'}->do("ALTER TABLE $table
-                  RENAME TO $newname");
-}
-
-#########################################################################
-sub RenameField {
-    my ($self, $table, $field, $newname) = @_;
-
-    my $ref = $self->GetFieldDef($table, $field);
-    return unless $ref; # already fixed?
-    #print "0: $$ref[0]   1: $$ref[1]   2: $$ref[2]   3: $$ref[3]  4: $$ref[4]\n";
-
-    if ($$ref[1] ne $newname) {
-        print "Updating field $field in table $table ...\n";
-        my $type = $$ref[1];
-        $type .= " NOT NULL" if !$$ref[2];
-        $type .= " auto_increment" if $$ref[5] =~ /auto_increment/;
-        $self->{'dbh'}->do("ALTER TABLE $table
-                  CHANGE $field
-                  $newname $type");
-    }
-}
-
-#########################################################################
-sub AddField {
-    my ($self, $table, $field, $definition) = @_;
-
-    my $ref = $self->GetFieldDef($table, $field);
-    return if $ref; # already added?
-
-    print "Adding new field $field to table $table ...\n";
-    $self->{'dbh'}->do("ALTER TABLE $table
-              ADD COLUMN $field $definition");
-}
-
-#########################################################################
-sub AddKey {
-    my ($self, $table, $field, $definition) = @_;
-
-    my $ref = $self->GetIndexDef($table, $field);
-    return if $ref; # already added?
-
-    print "Adding new key $field to table $table ...\n";
-    $self->{'dbh'}->do("ALTER TABLE $table
-              ADD KEY $field $definition");
-}
-
-#########################################################################
-sub AddUniqueKey {
-    my ($self, $table, $field, $definition) = @_;
-
-    my $ref = $self->GetIndexDef($table, $field);
-    return if $ref; # already added?
-
-    print "Adding new key $field to table $table ...\n";
-    $self->{'dbh'}->do("ALTER TABLE $table
-              ADD UNIQUE KEY $field $definition");
-}
-
-#########################################################################
-sub AddFullText {
-    my ($self, $table, $index, $definition) = @_;
-
-    my $ref = $self->GetIndexDef($table, $index);
-    return if $ref; # already added?
-
-    print "Adding new fulltext $index to table $table ...\n";
-    $self->{'dbh'}->do("ALTER TABLE $table
-              ADD FULLTEXT $index $definition");
-}
-
-
-#########################################################################
-sub DropField {
-    my ($self, $table, $field) = @_;
-
-    my $ref = $self->GetFieldDef($table, $field);
-    return unless $ref; # already dropped?
-
-    print "Deleting unused field $field from table $table ...\n";
-    $self->{'dbh'}->do("ALTER TABLE $table
-              DROP COLUMN $field");
-}
-
-#########################################################################
-sub DropTable {
-    my ($self, $table, $field) = @_;
-
-    my $ref = $self->TableExists($table);
-    return unless $ref; # already dropped?
-
-    print "Deleting unused table $table ...\n";
-    $self->{'dbh'}->do("DROP TABLE $table");
-}
-
-#########################################################################
-# this uses a mysql specific command. 
-sub TableExists {
-   my ($self, $table) = @_;
-   my @tables;
-   my $dbtable;
-   my $exists = 0;
-   my $sth = $self->{'dbh'}->prepare("SHOW TABLES");
-   $sth->execute;
-   while ( ($dbtable) = $sth->fetchrow_array ) {
-      if ($dbtable eq $table) {
-         $exists = 1;
-      } 
-   } 
-   $sth->finish;
-   return $exists;
-} 
-
-#########################################################################
-sub GetFieldDef {
-    my ($self, $table, $field) = @_;
-    my $sth = $self->{'dbh'}->prepare("SHOW COLUMNS FROM $table");
-    $sth->execute;
-
-    while (my $ref = $sth->fetchrow_arrayref) {
-        next if $$ref[0] ne $field;
-        $sth->finish;
-        return $ref;
-   }
-}
-
-#########################################################################
-sub GetIndexDef {
-    my ($self, $table, $field) = @_;
-    my $sth = $self->{'dbh'}->prepare("SHOW INDEX FROM $table");
-    $sth->execute;
-
-    while (my $ref = $sth->fetchrow_arrayref) {
-        next if $$ref[2] ne $field;
-        $sth->finish;
-        return $ref;
-   }
-}
-
-#########################################################################
-sub CountIndexes {
-    my ($self, $table) = @_;
-    
-    my $sth = $self->{'dbh'}->prepare("SHOW INDEX FROM $table");
-    $sth->execute;
-
-    if ( $sth->rows == -1 ) {
-      $sth->finish;
-      die ("Unexpected response while counting indexes in $table:" .
-           " \$sth->rows == -1");
-    }
-    
-    my $rows = $sth->rows;
-    $sth->finish;
-    return ($rows);
-}
-
-#########################################################################
-sub DropIndex {
-    my ($self, $table, $index) = @_;
-
-    my $ref = $self->GetIndexDef($table, $index);
-    return unless $ref; # no matching index?
-
-	print "Removing index $index from table $table ...\n";
-    $self->{'dbh'}->do("ALTER TABLE $table
-                  DROP INDEX $index");
-}
-
-#########################################################################
-sub DropIndexes {
-    my ($self, $table) = @_;
-    my %SEEN;
-
-    # get the list of indexes
-    #
-    my $sth = $self->{'dbh'}->prepare("SHOW INDEX FROM $table");
-    $sth->execute;
-
-    # drop each index
-    #
-    while ( my $ref = $sth->fetchrow_arrayref) {
-      
-      # note that some indexes are described by multiple rows in the
-      # index table, so we may have already dropped the index described
-      # in the current row.
-      # 
-      next if exists $SEEN{$$ref[2]};
-
-      if ($$ref[2] eq 'PRIMARY') {
-          # The syntax for dropping a PRIMARY KEY is different
-          # from the normal DROP INDEX syntax.
-          $self->{'dbh'}->do("ALTER TABLE $table DROP PRIMARY KEY"); 
-      }
-      else {
-          $self->{'dbh'}->do("ALTER TABLE $table DROP INDEX $$ref[2]");
-      }
-      $SEEN{$$ref[2]} = 1;
-
-    }
-    $sth->finish;
-}
-
-1;

mozilla/webtools/litmus/Litmus/Error.pm

@@ -1,84 +0,0 @@
-# -*- mode: cperl; c-basic-offset: 8; indent-tabs-mode: nil; -*-
-
-=head1 COPYRIGHT
-
- # ***** BEGIN LICENSE BLOCK *****
- # Version: MPL 1.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 Litmus.
- #
- # The Initial Developer of the Original Code is
- # the Mozilla Corporation.
- # Portions created by the Initial Developer are Copyright (C) 2006
- # the Initial Developer. All Rights Reserved.
- #
- # Contributor(s):
- #   Chris Cooper <ccooper@deadsquid.com>
- #   Zach Lipton <zach@zachlipton.com>
- #
- # ***** END LICENSE BLOCK *****
-
-=cut
-
-# General error reporting
-
-package Litmus::Error;
-
-use strict;
-
-our @ISA = qw(Exporter);
-@Litmus::Error::EXPORT = qw(
-	basicError
-    invalidInputError
-    internalError
-    lastDitchError
-);
-
-# just a general run of the mill error
-sub basicError {
-	my $message = shift;
-	_doError($message);
-	exit;
-}
-
-# used to alert the user when an unexpected input value is found
-sub invalidInputError($) {
-    my $message = shift;
-    _doError("Invalid Input - $message");
-    exit;
-}
-
-sub internalError($) {
-    my $message = shift;
-    _doError("Litmus has suffered an internal error - $message");
-    exit;
-}
-
-# an error type that does not use a template error message. Used if we 
-# can't even process the error template. 
-sub lastDitchError($) {
-    my $message = shift;
-    print "Error - Litmus has suffered a serious fatal internal error - $message";
-    exit;
-}
-
-sub _doError($) {
-    my $message = shift;
-    my $vars = {
-        message => $message,
-    };
-    Litmus->template()->process("error/error.html.tmpl", $vars) || 
-         lastDitchError(Litmus->template()->error());
-}
-
-1;

mozilla/webtools/litmus/Litmus/FormWidget.pm

@@ -1,342 +0,0 @@
-# -*- mode: cperl; c-basic-offset: 8; indent-tabs-mode: nil; -*-
-
-=head1 COPYRIGHT
-
- # ***** BEGIN LICENSE BLOCK *****
- # Version: MPL 1.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 Litmus.
- #
- # The Initial Developer of the Original Code is
- # the Mozilla Corporation.
- # Portions created by the Initial Developer are Copyright (C) 2006
- # the Initial Developer. All Rights Reserved.
- #
- # Contributor(s):
- #   Chris Cooper <ccooper@deadsquid.com>
- #   Zach Lipton <zach@zachlipton.com>
- #
- # ***** END LICENSE BLOCK *****
-
-=cut
-
-package Litmus::FormWidget;
-use strict;
-
-BEGIN {
-    use Exporter ();
-    use vars qw ($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
-    $VERSION     = 0.01;
-    @ISA         = qw (Exporter);
-    #Give a hoot don't pollute, do not export more than needed by default
-    @EXPORT      = qw ( getProducts );
-    @EXPORT_OK   = qw ();
-    %EXPORT_TAGS = ();
-}
-
-use DBI;
-use Litmus::DBI;
-
-our $_dbh = Litmus::DBI->db_Main();
-
-#########################################################################
-=head1 NAME
-
-Litmus::FormWidget - Create value lists to be used in HTML forms
-
-=head1 SYNOPSIS
-
-  use Litmus::FormWidget
-
-=head1 DESCRIPTION
-
-Litmus::FormWidget creates value lists to be used in HTML forms.
-
-=head1 USAGE
-
-
-=head1 BUGS
-
-
-
-=head1 SUPPORT
-
-
-
-=head1 AUTHOR
-
-    Chris Cooper
-    CPAN ID: CCOOPER
-    Mozilla Corporation
-    ccooper@deadsquid.com
-    http://litmus.mozilla.org/
-
-=head1 SEE ALSO
-
-perl(1).
-
-=cut
-
-#########################################################################
-
-#sub new
-#{
-#    my ($class, %parameters) = @_;
-#    my $self = bless ({}, ref ($class) || $class);
-#    return ($self);
-#}
-
-#########################################################################
-
-=head2 getProducts
-
- Usage     : How to use this function/method
- Purpose   : What it does
- Returns   : What it returns
- Argument  : What it wants to know
- Throws    : Exceptions and other anomolies
- Comments  : This is a sample subroutine header.
-           : It is polite to include more pod and fewer comments.
-
-See Also   : 
-
-=cut
-
-#########################################################################
-sub getProducts()
-{
-    my $sql = "SELECT name, product_id FROM products ORDER BY name";
-    return _getValues($sql);
-}
-
-#########################################################################
-sub getUniquePlatforms()
-{
-    my $sql = "SELECT DISTINCT(name), platform_id FROM platforms ORDER BY name";
-    return _getValues($sql);
-}
-
-#########################################################################
-sub getPlatforms()
-{
-    my $sql = "SELECT platform_id, name from platforms ORDER BY name ASC";
-    return _getValues($sql);
-}
-
-#########################################################################
-sub getBranches()
-{
-    my $sql = "SELECT name, branch_id FROM branches ORDER BY name ASC";
-    return _getValues($sql);
-}
-
-#########################################################################
-sub getUniqueBranches()
-{
-    my $sql = "SELECT DISTINCT(name) FROM branches ORDER BY name ASC";
-    return _getValues($sql);
-}
-
-#########################################################################
-sub getOpsyses()
-{
-    my $sql = "SELECT name, opsys_id FROM opsyses ORDER BY name ASC";
-    return _getValues($sql);
-}
-
-#########################################################################
-sub getUniqueOpsyses()
-{
-    my $sql = "SELECT DISTINCT(name) FROM opsyses ORDER BY name ASC";
-    return _getValues($sql);
-}
-
-#########################################################################
-sub getLogTypes()
-{
-    my $sql = "SELECT DISTINCT(name) FROM log_type_lookup ORDER BY name";
-    return _getValues($sql);
-}
-
-#########################################################################
-sub getTestStatuses()
-{
-    my @TestStatuses = ({name => 'Enabled'},
-                        {name => 'Disabled'});
-    return \@TestStatuses;
-}
-
-#########################################################################
-sub getResultStatuses()
-{
-    my $sql = "SELECT result_status_id,class_name FROM test_result_status_lookup ORDER BY result_status_id";
-    return _getValues($sql);
-}
-
-#########################################################################
-sub getTestcaseIDs()
-{
-    my $sql = "SELECT testcase_id FROM testcases ORDER BY testcase_id";
-    return _getValues($sql);
-}
-
-#########################################################################
-sub getTestcases()
-{
-    my $sql = "SELECT testcase_id, summary, product_id FROM testcases ORDER BY testcase_id";
-    return _getValues($sql);
-}
-
-#########################################################################
-sub getSubgroups()
-{
-    my $sql = "SELECT subgroup_id, name, product_id FROM subgroups ORDER BY name, subgroup_id";
-    return _getValues($sql);
-}
-
-#########################################################################
-sub getTestgroups()
-{
-    my $sql = "SELECT testgroup_id, name, product_id FROM testgroups ORDER BY name, testgroup_id";
-    return _getValues($sql);
-}
-
-
-#########################################################################
-sub getLocales()
-{
-  my @locales = Litmus::DB::Locale->retrieve_all();
-  return \@locales;
-}
-
-#########################################################################
-sub getUsers()
-{
-  my @users = Litmus::DB::User->retrieve_all();
-  return \@users;
-}
-
-#########################################################################
-sub getAuthors()
-{
-  my $sql = "SELECT user_id, email FROM users WHERE is_admin=1 ORDER BY email";
-  return _getValues($sql);
-}
-
-
-
-#########################################################################
-sub getFields()
-{
-    my @fields = (
-                  { name => 'build_id',
-                    display_string => "Build ID", },
-                  { name => 'comment',
-                    display_string => "Comments", }, 
-                  { name => 'locale',
-                    display_string => "Locale", }, 
-                  { name => 'opsys',
-                    display_string => "Operating System", }, 
-                  { name => 'platform',
-                    display_string => "Platform", }, 
-                  { name => 'product',
-                    display_string => "Product", },
-                  { name => 'result_status',
-                    display_string => "Result Status", },
-                  { name => 'subgroup',
-                    display_string => "Subgroup", },
-                  { name => 'email',
-                    display_string => "Submitted By", },
-                  { name => 'summary',
-                    display_string => "Summary", }, 
-                  { name => 'testgroup',
-                    display_string => "Testgroup", },
-                  { name => 'user_agent',
-                    display_string => "User Agent", },
-                  );
-    return \@fields;
-}
-
-#########################################################################
-sub getMatchCriteria()
-{
-    my @match_criteria = (
-                          { name => "contains_all",
-                            display_string => "contains all of the words/strings" },
-                          { name => "contains_any",
-                            display_string => "contains any of the words/strings" },
-                          { name => "contains",
-                            display_string => "contains the word/string" },
-                          { name => "contains_case",
-                            display_string => "contains the word/string (exact case)" },
-                          { name => "not_contain",
-                            display_string => "does not contains the word/string" },
-                          { name => "not_contain_any",
-                            display_string => "does not contains any of the words/string" },
-                          { name => "regexp",
-                            display_string => "matches the regexp" },
-                          { name => "not_regexp",
-                            display_string => "does not match the regexp" },
-                          );
-    return \@match_criteria;
-}
-
-#########################################################################
-sub getSortFields()
-{
-    my @sort_fields = (
-                       { name => "branch", 
-                         display_string => "Branch"},
-                       { name => "created", 
-                         display_string => "Date"},
-                       { name => "locale", 
-                         display_string => "Locale"},
-                       { name => "platform", 
-                         display_string => "Platform"},
-                       { name => "product", 
-                         display_string => "Product"},
-                       { name => "email", 
-                         display_string => "Submitted By"},
-                       { name => "summary", 
-                         display_string => "Summary"},
-                       { name => "result_status", 
-                         display_string => "Status"},
-                       { name => "testcase_id", 
-                         display_string => "Testcase ID#"},
-                       { name => "testgroup", 
-                         display_string => "Testgroup"},
-                       );
-    return \@sort_fields;
-}
-
-#########################################################################
-sub _getValues($)
-{
-    my ($sql) = @_;
-    my $sth = $_dbh->prepare_cached($sql);
-    $sth->execute();
-    my @rows;
-    while (my $data = $sth->fetchrow_hashref) {
-    push @rows, $data;
-    }
-    return \@rows;
-    $sth->finish();
-}
-
-1; 
-
-
-
-
-
-

mozilla/webtools/litmus/Litmus/StripScripts.pm

@@ -1,43 +0,0 @@
-# -*- mode: cperl; c-basic-offset: 8; indent-tabs-mode: nil; -*-
-
-=head1 COPYRIGHT
-
- # ***** BEGIN LICENSE BLOCK *****
- # Version: MPL 1.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 Litmus.
- #
- # The Initial Developer of the Original Code is
- # the Mozilla Corporation.
- # Portions created by the Initial Developer are Copyright (C) 2006
- # the Initial Developer. All Rights Reserved.
- #
- # Contributor(s):
- #   Chris Cooper <ccooper@deadsquid.com>
- #   Zach Lipton <zach@zachlipton.com>
- #
- # ***** END LICENSE BLOCK *****
-
-=cut
-
-package Litmus::StripScripts;
-use base qw(HTML::StripScripts::Parser);
-    
-# Override broken href validation code.
-sub validate_href_attribute {
-  my ($self, $text) = @_;
-  
-  $self->SUPER::validate_href_attribute or $text =~ m<^((https?|ftp|mailto)://[\w\-\.]{1,100}(?:\:\d{1,5})?(?:/(?:[\w\-.!~*|;:/?=+\$\,%#]|&amp;){0,100})?)$>x ? $1 : undef;
-} 
-
-1;

mozilla/webtools/litmus/Litmus/SysConfig.pm

@@ -1,263 +0,0 @@
-# -*- mode: cperl; c-basic-offset: 8; indent-tabs-mode: nil; -*-
-
-=head1 COPYRIGHT
-
- # ***** BEGIN LICENSE BLOCK *****
- # Version: MPL 1.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 Litmus.
- #
- # The Initial Developer of the Original Code is
- # the Mozilla Corporation.
- # Portions created by the Initial Developer are Copyright (C) 2006
- # the Initial Developer. All Rights Reserved.
- #
- # Contributor(s):
- #   Chris Cooper <ccooper@deadsquid.com>
- #   Zach Lipton <zach@zachlipton.com>
- #
- # ***** END LICENSE BLOCK *****
-
-=cut
-
-package Litmus::SysConfig;
-
-use strict;
-
-require Exporter;
-use Litmus;
-use Litmus::DB::Locale;
-use Litmus::DB::Product;
-use Litmus::Error;
-use Litmus::Utils;
-use CGI;
-
-our @ISA = qw(Exporter);
-our @EXPORT = qw();
-
-my $configcookiename = $Litmus::Config::sysconfig_cookiename;
-
-sub new {
-    my ($class, $product, $platform, $opsys, $branch, $build_id, $locale) = @_;
-
-    my $self = {};
-    bless($self);
-    
-    $self->{"product"}  = $product;
-    $self->{"platform"} = $platform;
-    $self->{"opsys"}    = $opsys;
-    $self->{"branch"}   = $branch;
-    $self->{"build_id"}  = $build_id;
-    $self->{"locale"}   = $locale;
-    
-    return $self;
-}
-
-sub setCookie {
-    my $self = shift;
-    
-    my %cookiedata;
-    
-    my $c = Litmus->cgi();
-    my $cookie = $c->cookie( 
-        -name   => $configcookiename.'_'.$self->{"product"}->product_id(),
-        -value  => join('|', $self->{"product"}->product_id(), $self->{"platform"}->platform_id(),
-             $self->{"opsys"}->opsys_id(), $self->{"branch"}->branch_id(), $self->{"build_id"}, $self->{"locale"}->abbrev()),
-        -domain => $main::ENV{"HTTP_HOST"},
-    );
-    
-    return $cookie;
-}
-
-sub getCookie {
-    my $self = shift;
-    my $c = Litmus->cgi();
-    my $product = shift;
-    
-    return Litmus::SysConfig->
-    	realGetCookie($configcookiename.'_'.$product->product_id());
-    
-}
-
-# returns sysconfig objects corresponding to all sysconfig cookies the user 
-# has set
-sub getAllCookies {
-	my $self = shift;
-	my $c = Litmus->cgi();
-	
-	my @cookies = ();
-	my @names = $c->cookie();
-	foreach my $cur (@names) {
-		if ($cur =~ /^\Q$configcookiename\E_/) {
-			push(@cookies, Litmus::SysConfig->realGetCookie($cur));
-		}
-	}
-	if (@cookies == 0) { push(@cookies, undef) }
-	return @cookies;
-}
-
-sub realGetCookie {
-	my $self = shift;
-	my $cookiename = shift;
-	
-	my $c = Litmus->cgi();
-	my $cookie = $c->cookie($cookiename);
-	if (! $cookie) {
-        return;
-    }
-    
-    my @sysconfig = split(/\|/, $cookie);
-    
-    return new(undef,
-               Litmus::DB::Product->retrieve($sysconfig[0]), 
-               Litmus::DB::Platform->retrieve($sysconfig[1]), 
-               Litmus::DB::Opsys->retrieve($sysconfig[2]), 
-               Litmus::DB::Branch->retrieve($sysconfig[3]), 
-               $sysconfig[4],
-               Litmus::DB::Locale->retrieve($sysconfig[5])
-               );    
-}
-
-sub product() {
-    my $self = shift;
-    
-    return $self->{"product"};
-}
-
-sub platform() {
-    my $self = shift;
-    
-    return $self->{"platform"};
-}
-
-sub opsys() {
-    my $self = shift;
-    
-    return $self->{"opsys"};
-}
-
-sub branch() {
-    my $self = shift;
-    
-    return $self->{"branch"};
-}
-
-sub build_id() {
-    my $self = shift;
-    
-    return $self->{"build_id"};
-}
-
-sub locale() {
-    my $self = shift;
-    
-    return $self->{"locale"};
-}
-
-
-# display the system configuration form
-# optionally takes the product to configure for 
-# and requires a url to load when done. this 
-# url should call processForm() to 
-# set the sysconfig cookie and do 
-# error handling.
-# optionaly, pass a CGI object and its
-# data will be stored in the form so 
-# the receiving script can access it.
-sub displayForm {
-    my $self = shift;
-    my $product = shift;
-    my $goto = shift;
-    my $c = shift; 
-    
-    my @products; 
-    # if we already know the product, then just send it on:
-    if ($product) {
-        $products[0] = $product;
-    } else {
-        # we need to ask the user for the product then
-        @products = Litmus::DB::Product->retrieve_all();
-    }
-
-    my @locales = Litmus::DB::Locale->retrieve_all(
-                                                   { order_by => 'abbrev' }
-                                                  );
-    my $vars = {
-        locales    => \@locales,        
-        products   => \@products,
-        ua         => Litmus::UserAgentDetect->new(),
-        "goto" => $goto,
-        cgidata   => $c,
-        };
-        
-    # if the user already has a cookie set for this product, then 
-    # load those values as defaults:
-    if ($product && Litmus::SysConfig->getCookie($product)) {
-        my $sysconfig = Litmus::SysConfig->getCookie($product);
-        $vars->{"defaultplatform"} = $sysconfig->platform();
-        $vars->{"defaultopsys"} = $sysconfig->opsys();
-        $vars->{"defaultbranch"} = $sysconfig->branch();
-        $vars->{"defaultlocale"} = $sysconfig->locale();
-    }
-    
-    # send a default build id if we have one:
-    my @cookies = Litmus::SysConfig->getAllCookies();
-    if ($cookies[0]) { $vars->{"defaultbuildid"} = $cookies[0]->build_id() }
-    
-    my $cookie =  Litmus::Auth::getCurrentUser();
-    $vars->{"defaultemail"} = $cookie;
-    $vars->{"show_admin"} = Litmus::Auth::istrusted($cookie);
-
-    $vars->{"title"} = "Run Tests";
-    
-    Litmus->template()->process("runtests/sysconfig.html.tmpl", $vars) || 
-        internalError(Litmus->template()->error());    
-}
-
-# process a form containing sysconfig information. 
-# takes a CGI object containing param data
-sub processForm {
-    my $self = shift;
-    my $c = shift;
-    
-    my $product = Litmus::DB::Product->retrieve($c->param("product"));
-    my $platform = Litmus::DB::Platform->retrieve($c->param("platform"));
-    my $opsys = Litmus::DB::Opsys->retrieve($c->param("opsys"));
-    my $branch = Litmus::DB::Branch->retrieve($c->param("branch"));
-    my $build_id = $c->param("build_id");
-    my $locale = Litmus::DB::Locale->retrieve($c->param("locale"));
-    
-    requireField("product", $product);
-    requireField("platform", $platform);
-    requireField("opsys", $opsys);
-    requireField("branch", $branch);
-    requireField("build_id", $build_id);
-    requireField("locale", $locale);
-    
-    # set a cookie with the user's testing details:
-    my $prod =  Litmus::DB::Product->retrieve($c->param("product"));
-    my $sysconfig = Litmus::SysConfig->new(
-                            $product,
-                            $platform, 
-                            $opsys,
-                            $branch,
-                            $build_id,
-                            $locale
-                            );
-                                    
-    return $sysconfig;
-}
-1;
-
-
-

mozilla/webtools/litmus/Litmus/Template.pm

@@ -1,205 +0,0 @@
-# -*- mode: cperl; c-basic-offset: 8; indent-tabs-mode: nil; -*-
-
-=head1 COPYRIGHT
-
- # ***** BEGIN LICENSE BLOCK *****
- # Version: MPL 1.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 the Bugzilla Bug Tracking System.
- #
- # The Initial Developer of the Original Code is Netscape Communications
- # Corporation. Portions created by Netscape are
- # Copyright (C) 1998 Netscape Communications Corporation. All
- # Rights Reserved.
- #
- # Contributor(s): Terry Weissman <terry@mozilla.org>
- #                 Dan Mosedale <dmose@mozilla.org>
- #                 Jacob Steenhagen <jake@bugzilla.org>
- #                 Bradley Baetz <bbaetz@student.usyd.edu.au>
- #                 Christopher Aillon <christopher@aillon.com>
- #                 Tobias Burnus <burnus@net-b.de>
- #                 Myk Melez <myk@mozilla.org>
- #                 Max Kanat-Alexander <mkanat@bugzilla.org>
- #                 Zach Lipton <zach@zachlipton.com>
- #                 Chris Cooper <ccooper@deadsquid.com>
- #
- # ***** END LICENSE BLOCK *****
-
-=cut
-
-# This is mostly a placeholder. At some point in the future, we might 
-# want to be more like Bugzilla and support multiple languages and 
-# other fine features, so we keep this around now so that adding new 
-# things later won't require changing every source file. 
-
-package Litmus::Template;
-
-use strict;
-
-use Litmus::Config;
-use Litmus::StripScripts;
-use Text::Markdown;
-
-use base qw(Template);
-
-my $template_include_path;
-
-$Template::Directive::WHILE_MAX = 30000;
-
-# Returns the path to the templates based on the Accept-Language
-# settings of the user and of the available languages
-# If no Accept-Language is present it uses the defined default
-sub getTemplateIncludePath () {
-    return "templates/en/default";
-}
-
-# Constants:
-my %constants = {};
-$constants{litmus_version} = $Litmus::Config::version;
-
-# html tag stripper:
-my $strip = Litmus::StripScripts->new(
-                                      {
-                                       AllowHref => 1,
-                                       AllowSrc => 1,
-                                       Context => 'Document'
-                                      },
-                                      strict_names => 1,
-                                     );
-
-###############################################################################
-# Templatization Code
-
-# Use the Toolkit Template's Stash module to add utility pseudo-methods
-# to template variables.
-use Template::Stash;
-
-# Add "contains***" methods to list variables that search for one or more 
-# items in a list and return boolean values representing whether or not 
-# one/all/any item(s) were found.
-$Template::Stash::LIST_OPS->{ contains } =
-  sub {
-      my ($list, $item) = @_;
-      return grep($_ eq $item, @$list);
-  };
-
-$Template::Stash::LIST_OPS->{ containsany } =
-  sub {
-      my ($list, $items) = @_;
-      foreach my $item (@$items) { 
-          return 1 if grep($_ eq $item, @$list);
-      }
-      return 0;
-  };
-
-# Allow us to still get the scalar if we use the list operation ".0" on it
-$Template::Stash::SCALAR_OPS->{ 0 } = 
-  sub {
-      return $_[0];
-  };
-
-# Add a "substr" method to the Template Toolkit's "scalar" object
-# that returns a substring of a string.
-$Template::Stash::SCALAR_OPS->{ substr } = 
-  sub {
-      my ($scalar, $offset, $length) = @_;
-      return substr($scalar, $offset, $length);
-  };
-
-# Add a "truncate" method to the Template Toolkit's "scalar" object
-# that truncates a string to a certain length.
-$Template::Stash::SCALAR_OPS->{ truncate } = 
-  sub {
-      my ($string, $length, $ellipsis) = @_;
-      $ellipsis ||= "";
-      
-      return $string if !$length || length($string) <= $length;
-      
-      my $strlen = $length - length($ellipsis);
-      my $newstr = substr($string, 0, $strlen) . $ellipsis;
-      return $newstr;
-  };
-
-# Create the template object that processes templates and specify
-# configuration parameters that apply to all templates.
-sub create {
-    my $class = shift;
-    return $class->new({
-        INCLUDE_PATH => &getTemplateIncludePath,
-        CONSTANTS => \%constants,
-        PRE_PROCESS => "variables.none.tmpl",
-        POST_CHOMP => 1,
-        EVAL_PERL => 1,
-        
-        COMPILE_DIR => $Litmus::Config::datadir,
-        
-        FILTERS => {
-            # disallow all html in testcase data except for non-evil tags
-            testdata => sub {
-                my ($data) = @_;
-                
-                $strip->parse($data);
-                $strip->eof();
-                
-                return $strip->filtered_document;
-            }, 
-            
-            # process the text with the markdown text processor
-            markdown => sub {
-            	my ($data) = @_;
-            	$data = Text::Markdown::markdown($data);
-            	return $data;
-            },
-            
-            # Returns the text with backslashes, single/double quotes,
-            # and newlines/carriage returns escaped for use in JS strings.
-            # thanks to bugzilla!
-            js => sub {
-                my ($var) = @_;
-                $var =~ s/([\\\'\"\/])/\\$1/g;
-                $var =~ s/\n/\\n/g;
-                $var =~ s/\r/\\r/g;
-                $var =~ s/\@/\\x40/g; # anti-spam for email addresses
-                return $var;
-            },
-            
-            # anti-spam filtering of email addresses
-            email => sub {
-                my ($var) = @_;
-                $var =~ s/\@/\&#64;/g;
-                return $var;    
-            }, 
-            
-            # dummy filter when we don't actually need to filter anything
-            none => sub {
-            	my ($var) = @_;
-                return $var;
-            },
-        },
-    });
-}
-
-# override the process() method to sneak defaultemail into all template 
-# variable spaces
-sub process {
-	my ($self, $template, $vars, $outstream, @opts) = @_;
-	my %vars = %$vars;
-	
-	$vars{defaultemail} = $vars{defaultemail} ? $vars{defaultemail} : 
-		Litmus->getCurrentUser();
-	
-	$vars{show_admin} = Litmus->getCurrentUser() ? 
-	  Litmus->getCurrentUser()->is_admin() : 0;
-	
-	$self->SUPER::process($template, \%vars, $outstream, @opts);
-}

mozilla/webtools/litmus/Litmus/Testlist.pm

@@ -1,66 +0,0 @@
-# -*- mode: cperl; c-basic-offset: 8; indent-tabs-mode: nil; -*-
-
-=head1 COPYRIGHT
-
- # ***** BEGIN LICENSE BLOCK *****
- # Version: MPL 1.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 Litmus.
- #
- # The Initial Developer of the Original Code is
- # the Mozilla Corporation.
- # Portions created by the Initial Developer are Copyright (C) 2006
- # the Initial Developer. All Rights Reserved.
- #
- # Contributor(s):
- #   Chris Cooper <ccooper@deadsquid.com>
- #   Zach Lipton <zach@zachlipton.com>
- #
- # ***** END LICENSE BLOCK *****
-
-=cut
-
-package Litmus::Testlist;
-
-use strict;
-
-use base qw(Exporter);
-@Litmus::Testlist::EXPORT = qw(
-                               makeHotlist
-                              );
-
-sub makeHotlist {
-    my $numtests = shift;
-    my $state = shift;
-    my @tests = @_;
-    
-    my @potentialtests;
-    foreach my $curtest (@tests) {
-        if ($curtest->isrecent()) {
-            foreach my $curplat ($curtest->subgroup()->testgroup()->product()->platforms()) {
-                my $found;
-                my $curstate = $curtest->state($curplat);
-                if ($curstate && $curstate->resultid() == $state->resultid()) {
-                    push(@potentialtests, $curtest);
-                    $found++;
-                } 
-                if ($found) {next}
-            }
-        }
-    }
-    
-    @potentialtests = sort{$b->num_recent_results() <=> $a->num_recent_results()} 
-                           @potentialtests;
-                           
-    return @potentialtests;
-}

mozilla/webtools/litmus/Litmus/UserAgentDetect.pm

@@ -1,147 +0,0 @@
-# -*- mode: cperl; c-basic-offset: 8; indent-tabs-mode: nil; -*-
-
-=head1 COPYRIGHT
-
- # ***** BEGIN LICENSE BLOCK *****
- # Version: MPL 1.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 Litmus.
- #
- # The Initial Developer of the Original Code is
- # the Mozilla Corporation.
- # Portions created by the Initial Developer are Copyright (C) 2006
- # the Initial Developer. All Rights Reserved.
- #
- # Contributor(s):
- #   Chris Cooper <ccooper@deadsquid.com>
- #   Zach Lipton <zach@zachlipton.com>
- #
- # ***** END LICENSE BLOCK *****
-
-=cut
-
-# Handle detection of system information from the UA string
-
-package Litmus::UserAgentDetect;
-
-use strict;
-
-require Exporter;
-use Litmus;
-use Litmus::DB::Platform;
-use Litmus::DB::Opsys;
-use Litmus::DB::Branch;
-
-our @ISA = qw(Exporter);
-our @EXPORT = qw(detectBuildID);
-
-# define some SQL queries we will use:
-Litmus::DB::Platform->set_sql(detectplatform => qq{
-                                                  SELECT p.platform_id
-                                                  FROM platforms p, platform_products pp
-                                                  WHERE 
-                                                      ? REGEXP detect_regexp AND 
-                                                      p.platform_id=pp.platform_id  AND
-                                                      pp.product_id LIKE ?
-                                                });
-Litmus::DB::Branch->set_sql(detectbranch => qq{
-                                                SELECT __ESSENTIAL__
-                                                FROM __TABLE__
-                                                WHERE 
-                                                    ? REGEXP detect_regexp AND 
-                                                    product_id LIKE ?
-                                            });                                                
-
-# constructor. Optionally you can pass a UA string 
-# and it will be used. Otherwise the default is the 
-# current useragent.
-sub new {
-    my $self = {};
-    my $class = shift;
-    my $ua = shift;
-    
-    bless($self);
-    $self->{ua} = $main::ENV{"HTTP_USER_AGENT"};
-    if ($ua) { $self->{ua} = $ua }
-    return $self;
-}
-
-# default stringification is to return the ua:
-use overload 
-    '""' => \&ua;
-    
-
-sub ua {
-    my $self = shift;
-    
-    # we pad the UA with a space since some of our regexp matches expect 
-    # to match things at the end of the string. This is quite possibly 
-    # a bug. 
-    return $self->{ua}." ";
-}
-
-sub build_id {
-    my $self = shift;
-    my $ua = $self->{ua};
-    
-    # mozilla products only
-    unless ($ua =~ /Mozilla\/5\.0/) {
-        return undef;
-    }
-    $ua =~ /(200\d*)/;
-    return $1; 
-}
-
-sub locale {
-    my $self = shift;
-    my $ua = $self->{ua};
-    
-    # mozilla products only
-    unless ($ua =~ /Mozilla\/5\.0/) {
-        return undef;
-    }
-
-    # Format (e.g.): 
-    # Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.8) Gecko/20051111 Firefox/1.5
-    $ua =~ /Mozilla\/5\.0 \([^;]*; [^;]*; [^;]*; ([^;]*); [^;]*\)/;
-    return $1; 
-}
-
-sub platform {
-    my $self = shift;
-    my $product = shift; # optionally, just lookup for one product
-    
-    if (! $product) { $product = '%' }
-    
-    my @platforms = Litmus::DB::Platform->search_detectplatform($self->ua, $product);
-    return @platforms;
-}
-
-sub branch {
-    my $self = shift;
-    my $product = shift; # optionally, just lookup for one branch
-    
-    if (! $product) { $product = '%' }
-    
-    my @branches = Litmus::DB::Branch->search_detectbranch($self->ua, $product);
-    return @branches;
-}
-
-# from the legacy API before we had an OO interface:
-sub detectBuildId() {
-    my $self = Litmus::UserAgentDetect->new($main::ENV{"HTTP_USER_AGENT"});
-    
-    return $self->build_id();
-}
-
-1;

mozilla/webtools/litmus/Litmus/Utils.pm

@@ -1,61 +0,0 @@
-# -*- mode: cperl; c-basic-offset: 8; indent-tabs-mode: nil; -*-
-
-=head1 COPYRIGHT
-
- # ***** BEGIN LICENSE BLOCK *****
- # Version: MPL 1.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 Litmus.
- #
- # The Initial Developer of the Original Code is
- # the Mozilla Corporation.
- # Portions created by the Initial Developer are Copyright (C) 2006
- # the Initial Developer. All Rights Reserved.
- #
- # Contributor(s):
- #   Chris Cooper <ccooper@deadsquid.com>
- #   Zach Lipton <zach@zachlipton.com>
- #
- # ***** END LICENSE BLOCK *****
-
-=cut
-
-# General utility functions
-
-package Litmus::Utils;
-
-use strict;
-
-use Litmus;
-use Litmus::Error;
-use CGI;
-
-our @ISA = qw(Exporter);
-@Litmus::Utils::EXPORT = qw(
-    requireField
-);
-
-
-# requireField - checks that $field contains data (other than ---) and throws
-# an invalidInputError if it does not.
-sub requireField {
-    my ($fieldname, $field) = @_;
-    
-    unless($field && $field ne "---") {
-        my $c = Litmus->cgi();
-        print $c->header();
-        invalidInputError("You must make a valid selection for field ".$fieldname.".");
-    }
-}
-
-1;

mozilla/webtools/litmus/Litmus/XML.pm

@@ -1,419 +0,0 @@
-# -*- mode: cperl; c-basic-offset: 8; indent-tabs-mode: nil; -*-
-
-=head1 COPYRIGHT
-
- # ***** BEGIN LICENSE BLOCK *****
- # Version: MPL 1.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 Litmus.
- #
- # The Initial Developer of the Original Code is
- # the Mozilla Corporation.
- # Portions created by the Initial Developer are Copyright (C) 2006
- # the Initial Developer. All Rights Reserved.
- #
- # Contributor(s):
- #   Zach Lipton <zach@zachlipton.com>
- #
- # ***** END LICENSE BLOCK *****
-
-=cut
-
-package Litmus::XML; 
-
-# Litmus XML Interface
-# For further details, see the web services specification at 
-# http://wiki.mozilla.org/Litmus:Web_Services
-
-use strict;
-
-use XML::XPath;
-use XML::XPath::XMLParser;
-
-use Litmus::DB::User;
-use Litmus::UserAgentDetect;
-use Date::Manip;
-
-use CGI::Carp qw(set_message fatalsToBrowser);
-
-# if we die for some reason, make sure we give a fatal error per spec
-BEGIN { 
-	set_message(sub { 
-		print "Fatal error: internal server error\n";
-	});
-}
-
-no warnings;
-no diagnostics;
-
-sub new {
-	my $self = {};
-	bless($self);
-	return $self;
-}
-
-# process XML test result data as described by 
-# the spec at http://wiki.mozilla.org/Litmus:Web_Services
-sub processResults {
-	my $self = shift;
-	my $data = shift;
-	
-	$self->parseResultFile($data) ? 1 : return 0;
-	
-	unless ($self->authenticate()) { return 0} # login failure
-	
-	$self->validateResults() ? 1 : return 0;
-	
-	# at this point, everything is valid, so if we're just validating the 
-	# results, we can return an ok:
-	if ($self->{'action'} eq 'validate') {
-		unless  ($self->{'response'}) { $self->respOk() }
-		return 1;
-	}
-	
-	# add so-called 'global logs' that apply to all the results
-	# we save them in @globallogs so we can map them to the results later
-	my @globallogs;
-	foreach my $log (@{$self->{'logs'}}) {
-		# the submission time is the timestamp of the first testresult:
-		my $newlog = Litmus::DB::Log->create({
-			submission_time => $self->{'results'}->[0]->{'timestamp'},
-			log_type => $log->{'type'},
-			log_text => $log->{'data'},
-		});
-		push(@globallogs, $newlog);
-	}
-	
-	# now actually add the new results to the db:
-	foreach my $result (@{$self->{'results'}}) {
-		my $newres = Litmus::DB::Testresult->create({
-			testcase      => $result->{'testid'},
-			user_agent    => new Litmus::UserAgentDetect($self->{'useragent'}),
-			user 	      => $self->{'user'}, 
-			opsys 	      => $self->{'sysconfig'}->{'opsys'},
-			branch 	      => $self->{'sysconfig'}->{'branch'},
-			locale	      => $self->{'sysconfig'}->{'locale'},
-			build_id      => $self->{'sysconfig'}->{'buildid'},
-			machine_name  => $self->{'machinename'},
-			result_status => $result->{'resultstatus'},
-			timestamp     => $result->{'timestamp'},
-			exit_status   => $result->{'exitstatus'},
-			duration_ms   => $result->{'duration'},
-			valid		  => 1,
-			isAutomated   => $result->{'isAutomated'},
-		});
-		
-		if (!$newres) { $self->respErrResult($result->{'testid'}); next; }
-		
-		# add any bug ids:
-		foreach my $bug (@{$result->{'bugs'}}) {
-			my $newbug = Litmus::DB::Resultbug->create({
-				test_result_id  => $newres,
-				bug_id 		    => $bug, 
-				submission_time => $result->{'timestamp'},
-				user		    => $self->{'user'},
-			});
-		}
-		
-		# add any comments:
-		foreach my $comment (@{$result->{'comments'}}) {
-			my $newcomment = Litmus::DB::Comment->create({
-				test_result     => $newres,
-				submission_time => $result->{'timestamp'},
-				user            => $self->{'user'},
-				comment         => $comment,
-			});
-		}
-	
-		# add logs:
-		my @resultlogs;
-		push(@resultlogs, @globallogs); # all results get the global logs
-		foreach my $log (@{$result->{'logs'}}) {
-			my $newlog = Litmus::DB::Log->create({
-				submission_time => $result->{'timestamp'},
-				log_type => $log->{'type'},
-				log_text => $log->{'data'},
-			});
-			push(@resultlogs, $newlog);
-		}
-		
-		# now we map the logs to the current result:
-		foreach my $log (@resultlogs) {
-			Litmus::DB::LogTestresult->create({
-				test_result => $newres,
-				log_id => $log,
-			});
-		}
-	}
-	
-	unless  ($self->{'response'}) { $self->respOk() }
-	
-	#$self->{'response'} = $self->{'results'}->[0]->{'resultstatus'};
-	
-}
-
-sub parseResultFile {
-	my $self = shift;
-	my $data = shift;
-	my $x = XML::XPath->new(xml => $data, standalone => 1);
-	$self->{'useragent'} = $x->findvalue('/litmusresults/@useragent');
-	$self->{'machinename'} = $x->findvalue('litmusresults/@machinename');
-	$self->{'action'} = $x->findvalue('/litmusresults/@action');
-	$self->{'user'}->{'username'} = $x->findvalue(
-									'/litmusresults/testresults/@username');
-	$self->{'user'}->{'token'} = $x->findvalue(
-								   '/litmusresults/testresults/@authtoken');
-	
-	$self->{'sysconfig'}->{'product'} = $x->findvalue('/litmusresults/testresults/@product');
-	$self->{'sysconfig'}->{'platform'} = $x->findvalue('/litmusresults/testresults/@platform');
-	$self->{'sysconfig'}->{'opsys'} = $x->findvalue('/litmusresults/testresults/@opsys');
-	$self->{'sysconfig'}->{'branch'} = $x->findvalue('/litmusresults/testresults/@branch');
-	$self->{'sysconfig'}->{'buildid'} = $x->findvalue('/litmusresults/testresults/@buildid');
-	$self->{'sysconfig'}->{'locale'} = $x->findvalue('/litmusresults/testresults/@locale');
-	
-	my @glogs = $x->find('/litmusresults/testresults/log')->get_nodelist();
-	my $l_ct = 0;
-	foreach my $log (@glogs) {
-		my $type = $x->findvalue('@logtype', $log);
-			my $logdata = stripWhitespace($log->string_value());
-			$self->{'logs'}->[$l_ct]->{'type'} = $type;
-			$self->{'logs'}->[$l_ct]->{'data'} = $logdata;
-			$l_ct++;
-	}
-	
-	my @results = $x->find('/litmusresults/testresults/result')->get_nodelist();
-	my $c = 0;
-	foreach my $result (@results) {
-		$self->{'results'}->[$c]->{'testid'} = $x->findvalue('@testid', $result);
-		$self->{'results'}->[$c]->{'isAutomated'} = $x->findvalue('@is_automated_result', $result);
-		$self->{'results'}->[$c]->{'resultstatus'} = $x->findvalue('@resultstatus', $result);
-		$self->{'results'}->[$c]->{'exitstatus'} = $x->findvalue('@exitstatus', $result);
-		$self->{'results'}->[$c]->{'duration'} = $x->findvalue('@duration', $result);
-		$self->{'results'}->[$c]->{'timestamp'} = 
-			&Date::Manip::UnixDate($x->findvalue('@timestamp', $result), "%q");
-		
-		
-		my @comments = $x->find('comment', $result)->get_nodelist();
-		my $com_ct = 0;
-		foreach my $comment (@comments) {
-			$comment = stripWhitespace($comment->string_value());
-			$self->{'results'}->[$c]->{'comments'}->[$com_ct] = $comment;
-			$com_ct++;
-		}
-		
-		my @bugs = $x->find('bugnumber', $result)->get_nodelist();
-		my $bug_ct = 0;
-		foreach my $bug (@bugs) {
-			$bug = stripWhitespace($bug->string_value());
-			$self->{'results'}->[$c]->{'bugs'}->[$bug_ct];
-			$bug_ct++;
-		}
-		
-		my @logs = $x->find('log', $result)->get_nodelist();
-		my $log_ct = 0;
-		foreach my $log (@logs) {
-			my $type = $x->findvalue('@logtype', $log);
-			my $logdata = stripWhitespace($log->string_value());
-			$self->{'results'}->[$c]->{'logs'}->[$log_ct]->{'type'} = $type;
-			$self->{'results'}->[$c]->{'logs'}->[$log_ct]->{'data'} = $logdata;
-			$log_ct++;
-		}	
-		$c++;
-	}
-	
-	$self->{'x'} = $x;
-}
-
-# validate the result data, and resolve references to various tables
-# the correct objects, looking up id numbers as needed
-sub validateResults {
-	my $self = shift;
-
-	my $action = $self->{'action'};
-	if ($action ne 'submit' && $action ne 'validate') {
-		$self->respErrFatal("Action must be either 'submit' or 'validate'");
-		return 0;
-	}
-	
-	my @users = Litmus::DB::User->search(email => $self->{'user'}->{'username'});
-	$self->{'user'} = $users[0];
-	
-	
-	unless ($self->{'useragent'}) { 
-		$self->respErrFatal("You must specify a useragent");
-		return 0;
-	}
-	
-	my @prods = Litmus::DB::Product->search(name => $self->{'sysconfig'}->{'product'});
-	unless ($prods[0]) { 
-		$self->respErrFatal("Invalid product: ".$self->{'sysconfig'}->{'product'});
-		return 0;
-	}
-	$self->{'sysconfig'}->{'product'} = $prods[0];
-	
-	my @platforms = Litmus::DB::Platform->search_ByProductAndName(
-											$self->{'sysconfig'}->{'product'},
-											$self->{'sysconfig'}->{'platform'});
-	unless ($platforms[0]) { 
-		$self->respErrFatal("Invalid platform: ".$self->{'sysconfig'}->{'platform'});
-		return 0;
-	}
-	$self->{'sysconfig'}->{'platform'} = $platforms[0];
-	
-	my @opsyses = Litmus::DB::Opsys->search(
-								name => $self->{'sysconfig'}->{'opsys'}, 
-							    platform => $self->{'sysconfig'}->{'platform'});
-	unless ($opsyses[0]) { 
-		$self->respErrFatal("Invalid opsys: ".$self->{'sysconfig'}->{'opsys'});
-		return 0;
-	}
-	$self->{'sysconfig'}->{'opsys'} = $opsyses[0];
-	
-	my @branches = Litmus::DB::Branch->search(
-										name => $self->{'sysconfig'}->{'branch'},
-										product => $self->{'sysconfig'}->{'product'});
-	unless ($branches[0]) { 
-		$self->respErrFatal("Invalid branch: ".$self->{'sysconfig'}->{'branch'});
-		return 0;
-	}
-	$self->{'sysconfig'}->{'branch'} = $branches[0];
-	
-	unless ($self->{'sysconfig'}->{'buildid'}) {
-		$self->respErrFatal("Invalid build id: ".$self->{'sysconfig'}->{'buildid'});
-		return 0;
-	}
-	
-	my @locales = Litmus::DB::Locale->search(
-									locale => $self->{'sysconfig'}->{'locale'});
-	unless ($locales[0]) { 
-		$self->respErrFatal("Invalid locale: ".$self->{'sysconfig'}->{'locale'});
-		return 0;
-	}
-	$self->{'sysconfig'}->{'locale'} = $locales[0];
-	
-	foreach my $log (@{$self->{'logs'}}) {
-		my @types = Litmus::DB::LogType->search(name => $log->{'type'});
-		unless ($types[0]) {
-			$self->respErrFatal("Invalid log type: ".$log->{'type'});
-			return 0;
-		}
-		$log->{'type'} = $types[0];
-	}
-	
-	foreach my $result (@{$self->{'results'}}) {
-		my @tests = Litmus::DB::Testcase->search(
-									test_id => $result->{'testid'});
-		unless ($tests[0]) { 
-			$self->respErrResult('unknown', "Invalid test id");
-			next;
-		}
-		$result->{'testid'} = $tests[0];
-		
-		# assume it's an automated test result if not specified
-		($result->{'isAutomated'} eq '0' || $result->{'isAutomated'} ne undef) ? 
-			$result->{'isAutomated'} = 0 : $result->{'isAutomated'} = 1;
-		
-		my @results = Litmus::DB::ResultStatus->search(
-									name => $result->{'resultstatus'});
-		unless ($results[0]) { 
-			$self->respErrResult($result->{'testid'}, "Invalid resultstatus");
-			next;
-		}
-		$result->{'resultstatus'} = $results[0];
-		
-		my @es = Litmus::DB::ExitStatus->search(
-									name => $result->{'exitstatus'});
-		unless ($es[0]) { 
-			$self->respErrResult($result->{'testid'}, "Invalid exitstatus");
-			next;
-		}
-		$result->{'exitstatus'} = $es[0];
-		
-		# if there's no duration, then it's just 0:
-		unless ($result->{'duration'}) {
-			$result->{'duration'} = 0;
-		}
-		
-		# if there's no timestamp, then it's now:
-		unless ($result->{'timestamp'}) {
-			$result->{'timestamp'} = &Date::Manip::UnixDate("now","%q");
-		}
-		
-		foreach my $log (@{$result->{'logs'}}) {
-			my @types = Litmus::DB::LogType->search(name => $log->{'type'});
-			unless ($types[0]) {
-				$self->respErrResult($result->{'testid'}, 
-									 "Invalid log type: ".$log->{'type'});
-				next;
-			}
-			$log->{'type'} = $types[0];
-		}		
-	}
-	return 1;
-}
-
-sub response {
-	my $self = shift;
-	return $self->{'response'};
-}
-
-
-# ONLY NON-PUBLIC API BELOW THIS POINT
-
-sub authenticate {
-	my $self = shift;
-	
-	my @users = Litmus::DB::User->search(email => $self->{'user'}->{'username'});
-	my $user = $users[0];
-	
-	unless ($user) { $self->respErrFatal("User does not exist"); return 0 }
-	
-	unless ($user->enabled()) { $self->respErrFatal("User disabled"); return 0 }
-	
-	if ($user->authtoken() ne $self->{'user'}->{'token'}) {
-		respErrFatal("Invalid authentication token for user ".
-			$self->{'user'}->{'username'});
-		return 0;
-	}
-	return 1;
-}
-
-sub respOk {
-	my $self = shift;
-	$self->{'response'} = 'ok';
-}
-
-sub respErrFatal {
-	my $self = shift;
-	my $error = shift;
-	$self->{'response'} = "Fatal error: $error\n";
-}
-
-sub respErrResult {
-	my $self = shift;
-	my $testid = shift;
-	my $error = shift;
-	$self->{'response'} .= "Error processing result for test $testid: $error\n";
-}
-
-# remove leading and trailing whitespace from logs and comments
-sub stripWhitespace {
-	my $txt = shift;
-	$txt =~ s/^\s+//;
-	$txt =~ s/\s+$//;
-	return $txt;
-}
-
-
-
-1;

mozilla/webtools/litmus/Makefile

@@ -1,56 +0,0 @@
-# Litmus Makefile
-
-PERL=perl
-
-install: templates
-	$(PERL) populatedb.pl
-
-# precompile all templates with the Template Toolkit
-# to speed things up a good bit. 
-# This ought to be done in a more "makelike" way, but 
-# various difficulties prevent that unless we use a configure 
-# script to generate the Makefile, at which point we could have 
-# been done already...
-
-%.tmpl: 
-	$(PERL) -e " \
-		eval('use CGI qw(-no_debug)'); \
-		use Litmus::Template;use diagnostics; \
-		\$$template = Litmus::Template->create(); \
-		\$$template->context()->template('$@'); \
-	"
-
-templates: index.html.tmpl
-	$(PERL) -e " \
-		use File::Find; \
-		find({ wanted => sub { \
-			\$$name = \$$File::Find::name; \
-			return if (-d \$$name); \
-			return if (\$$name =~ /\/CVS\//); \
-			return if (\$$name !~ /\.tmpl\$$/); \
-			\$$name =~ s/templates\/en\/default\///; \
-			if (-M 'templates/en/default/'.\$$name < -M 'data/templates/en/default/'.\$$name \
-				|| ! -e 'data/templates/en/default/'.\$$name \
-				|| -M 'Litmus/Template.pm' < -M 'data/templates/en/default/'.\$$name) { \
-				system("make", "\$$name"); \
-			} \
-		}, no_chdir => 1 }, 'templates/en/default'); \
-	"
-	
-# tags: generate ctags style hints for ease of editing
-# requires Exuberant Ctags to be installed (http://ctags.sf.net/)
-ctags: 
-	`which ctags` --excmd=number --tag-relative=no --fields=+a+m+n+S -R `pwd`
-
-tags: ctags
-	
-test: 
-	$(PERL) runtests.pl
-
-cache: 
-	$(PERL) -MLitmus -MLitmus::Cache -e "Litmus::Cache::rebuildCache();"
-	@echo "Done";
-
-clean: 
-	rm -rf data
-	make install

mozilla/webtools/litmus/README

@@ -1,47 +0,0 @@
-===Litmus===
-
-If you're reading this, you've downloaded, received, or simply conjured
-out of thin air, a copy of the Litmus testcase management system.
-Presumably, you're reading this file because you have some sort of
-question about Litmus. Hopefully, if we've done our job right, this file
-ought to answer your questions. 
-
-Q: What is Litmus?
-A: Litmus is a testcase management system. Its goal is to allow users to
-enter software tests, run them, and view and manage the results. Along
-the way, users can expect to be able to do queries and reports and have
-access all the usual features they expect from a first-class web
-application. The reality may be somewhat different than this goal.
-Litmus is developed by mozilla.org.  
-
-Q: How do I install this dang thing?
-A: You probably want the file called INSTALL.
-
-Q: Where is the real documentation?
-A: Hahahaha. What is this "documentation" you speak of? You might want
-to check out the Litmus Wiki, which may or may not contain useful
-information. See http://wiki.mozilla.org/Litmus.
-
-Q: What needs to be done?
-A: See http://wiki.mozilla.org/Litmus:Todo
-
-Q: How much does it cost?
-A: Nothing. Litmus is Free Software, licensed under the Mozilla Public
-License.
-
-Q: Wait. Isn't "testcase" two words? 
-A: Not here it isn't. 
-
-Q: Waaaaaaah. Why is Litmus written in Perl and not
-PHP/Python/Java/Objective Pascal/Latin?
-A: Because I know Perl. Duh. Also because Litmus uses some code from
-Bugzilla, and it wouldn't be able to do this if it was written in some
-other language. Camels are also some of the least buggy animals around,
-as they swat flies away with their tails. 
-
-Q: I'm still confused. You didn't answer my question. I don't know what
-to do. Help!
-A: First of all, that's not a question. In any case, your best bet is
-probably to email Zach Lipton <zach@zachlipton.com>, and if you ask
-nicely and don't make too much of a pest of yourself, he'd be glad to
-get you on the right track. 

mozilla/webtools/litmus/advanced_search.cgi

@@ -1,246 +0,0 @@
-#!/usr/bin/perl -w
-# -*- mode: cperl; c-basic-offset: 8; indent-tabs-mode: nil; -*-
-
-# ***** BEGIN LICENSE BLOCK *****
-# Version: MPL 1.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 Litmus.
-#
-# The Initial Developer of the Original Code is
-# the Mozilla Corporation.
-# Portions created by the Initial Developer are Copyright (C) 2006
-# the Initial Developer. All Rights Reserved.
-#
-# Contributor(s):
-#   Chris Cooper <ccooper@deadsquid.com>
-#   Zach Lipton <zach@zachlipton.com>
-#
-# ***** END LICENSE BLOCK *****
-
-use strict;
-
-use Litmus;
-use Litmus::Auth;
-use Litmus::Error;
-use Litmus::DB::Testresult;
-use Litmus::FormWidget;
-
-use CGI;
-use Time::Piece::MySQL;
-
-Litmus->init();
-my $c = Litmus->cgi();
-print $c->header();
-
-
-
-# Hash refs for maintaining state in the search form.
-my $defaults = undef;
-my $order_bys = undef;
-
-my $MAX_SORT_FIELDS = 10;
-my $MAX_SEARCH_FIELDS = 10;
-
-my $criteria = "Custom<br/>";
-my $results;
-my @where;
-my @order_by;
-my $limit;
-my $where_criteria = "";
-my $order_by_criteria = "";
-my $limit_criteria = "";
-
-if ($c->param) {    
-
-    foreach my $param ($c->param) {
-        next if ($c->param($param) eq '');
-        
-        if ($param =~ /sort_field(\d+)/) {
-            # We slot sort fields into the @order_by array based on their
-            # field_num. Empty array slots will be ignored when the SQL 
-            # is built. We set an upper limit on the number of sort fields 
-            # we can handle to prevent abuse.
-            my $field_num = $1;
-            next if ($field_num > $MAX_SORT_FIELDS);
-            my $sort_field = $c->param($param);
-            my $sort_order = 'ASC';
-            if ($c->param("sort_order$field_num")) {
-                $sort_order = $c->param("sort_order$field_num");
-            }
-            $order_by[$field_num] = { field => $sort_field,
-                                      direction => $sort_order};
-
-        } elsif ($param =~ /search_field(\d+)/) {
-            # We set an upper limit on the number of search fields 
-            # we can handle to prevent abuse.
-            my $field_num = $1;
-            next if ($field_num > $MAX_SEARCH_FIELDS);
-            my $search_field = $c->param($param);
-            my $match_criteria = $c->param("match_criteria$field_num");
-            my $value = $c->param("search_value$field_num");
-            push @where, { 'field' => 'search_field',
-                           'search_field' => $search_field,
-                           'match_criteria' => $match_criteria,
-                           'value' => $value};
-            $where_criteria .= "$search_field $match_criteria '$value'<br/>";
-
-        } elsif ($param eq 'start_date') {
-            my $start_date = $c->param($param);
-            $start_date =~ s/[^0-9A-Za-z ]/ /g;
-            my $end_date;
-            # Use 'now' as the default end date.
-            if ($c->param('end_date') and $c->param('end_date') ne '') {
-                $end_date = $c->param('end_date');
-                $end_date =~ s/[^0-9A-Za-z ]/ /g;
-            } else {
-                $end_date = 'Now';
-            }
-            push @where, { field => 'start_date',
-                           value => $start_date};
-            push @where, { field => 'end_date',
-                           value => $end_date};
-            $where_criteria .= "Date between '$start_date' and '$end_date'<br/>";
-        } elsif ($param eq 'trusted_only') {
-            push @where, {field => 'trusted_only',
-                          value => 1};            
-            $limit_criteria .= "Display trusted results only<br/>";
-        } elsif ($param eq "limit") {
-            $limit = $c->param($param);
-            next if ($limit == $Litmus::DB::Testresult::_num_results_default);
-            $limit_criteria .= "Limit to $limit results<br/>";
-        } elsif ($param eq 'branch') {
-            my $value = $c->param($param);
-            push @where, {field => $param,
-                          value => $value};
-            $where_criteria .= "Branch is \'".$c->param($param)."\'<br/>";
-            $defaults->{branch} =  $c->param($param);
-        } elsif ($param eq 'locale') {
-            my $value = $c->param($param);
-            push @where, {field => 'locale',
-                          value => $value};
-            $where_criteria .= "Locale is \'".$c->param($param)."\'<br/>";
-            $defaults->{locale} =  $c->param($param);
-        } elsif ($param eq 'email') {
-            my $value = $c->param($param);
-            push @where, {field => 'email',
-                          value => $value};
-            $where_criteria .= "Submitted By is \'".$c->param($param)."\'<br/>";
-            $defaults->{locale} =  $c->param($param);
-        } elsif ($param eq 'product') {
-            my $value = $c->param($param);
-            push @where, {field => $param,
-                          value => $value};
-            $where_criteria .= "Product is \'".$c->param($param)."\'<br/>";
-            $defaults->{product} = $c->param($param);
-        } elsif ($param eq 'platform') {
-            my $value = $c->param($param);
-            push @where, {field => $param,
-                          value => $value};
-            $where_criteria .= "Platform is \'".$c->param($param)."\'<br/>";
-            $defaults->{platform} = $c->param($param);
-        } elsif ($param eq 'test_group') {
-            my $value = $c->param($param);
-            push @where, {field => $param,
-                          value => $value};
-            $where_criteria .= "Test group is \'".$c->param($param)."\'<br/>";
-            $defaults->{test_group} = $c->param($param);
-        } elsif ($param eq 'test_id') {
-            my $value = $c->param($param);
-            push @where, {field => $param,
-                          value => $value};
-            $where_criteria .= "Testcase ID# is \'".$c->param($param)."\'<br/>";
-            $defaults->{test_id} = $c->param($param);                
-        } elsif ($param eq 'summary') {
-            my $value = $c->param($param);
-            push @where, {field => $param,
-                          value => $value};
-            $where_criteria .= "Summary like \'".$c->param($param)."\'<br/>";
-            $defaults->{summary} = $c->param($param);
-        } elsif ($param eq 'result_status') {
-            my $value = $c->param($param);
-            push @where, {field => $param,
-                          value => $value};
-            $where_criteria .= "Status is \'".$c->param($param)."\'<br/>";
-            $defaults->{result_status} = $c->param($param);
-        } else {
-            # Skip unknown field
-        }
-    }
-    if ($where_criteria eq '' and 
-        scalar(@order_by) == 0 and
-        $limit_criteria eq '') {
-        ($criteria,$results) = 
-          Litmus::DB::Testresult->getDefaultTestResults;    
-    } else {
-        foreach my $order_by_field (@order_by) {
-            next if (!$order_by_field);
-            $order_by_criteria .= "Order by $order_by_field->{field} $order_by_field->{direction}<br/>";
-        }
-
-        $criteria .= $where_criteria . $order_by_criteria . $limit_criteria;
-        $criteria =~ s/_/ /g;
-        $results = Litmus::DB::Testresult->getTestResults(\@where,
-                                                          \@order_by,
-                                                          $limit);
-    }
-} else {
-    ($criteria,$results) = 
-      Litmus::DB::Testresult->getDefaultTestResults;    
-}
-
-# Populate each of our form widgets for select/input.
-# Set a default value as appropriate.
-my $products = Litmus::FormWidget->getProducts;
-my $platforms = Litmus::FormWidget->getUniquePlatforms;
-my $test_groups = Litmus::FormWidget->getTestgroups;
-my $testcases = Litmus::FormWidget->getTestcaseIDs;
-my $result_statuses = Litmus::FormWidget->getResultStatuses;
-my $branches = Litmus::FormWidget->getBranches;
-my $locales = Litmus::FormWidget->getLocales;
-my $users = Litmus::FormWidget->getUsers;
-
-my $fields = Litmus::FormWidget->getFields;
-my $match_criteria = Litmus::FormWidget->getMatchCriteria;
-my $sort_fields = Litmus::FormWidget->getSortFields;
-
-my $title = 'Advanced Search';
-
-my $vars = {
-    title => $title,
-    criteria => $criteria,
-    products => $products,
-    platforms => $platforms,
-    test_groups => $test_groups,
-    testcases => $testcases,
-    result_statuses => $result_statuses,
-    branches => $branches,
-    locales => $locales,
-    users => $users,
-    fields => $fields,
-    match_criteria => $match_criteria,
-    sort_fields => $sort_fields,
-};
-
-# Only include results if we have them.
-if ($results and scalar @$results > 0) {
-    $vars->{results} = $results;
-}
-
-my $cookie =  Litmus::Auth::getCookie();
-$vars->{"defaultemail"} = $cookie;
-$vars->{"show_admin"} = Litmus::Auth::istrusted($cookie);
-
-Litmus->template()->process("reporting/advanced_search.tmpl", $vars) || 
-    internalError(Litmus->template()->error());
-
-exit 0;