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/bugzilla/Attachment.pm

@@ -1,97 +0,0 @@
-# -*- Mode: perl; indent-tabs-mode: nil -*-
-#
-# 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>
-#                 Myk Melez <myk@mozilla.org>
-
-############################################################################
-# Module Initialization
-############################################################################
-
-use diagnostics;
-use strict;
-
-package Attachment;
-
-# This module requires that its caller have said "require CGI.pl" to import
-# relevant functions from that script and its companion globals.pl.
-
-############################################################################
-# Functions
-############################################################################
-
-sub query
-{
-  # Retrieves and returns an array of attachment records for a given bug. 
-  # This data should be given to attachment/list.atml in an
-  # "attachments" variable.
-  my ($bugid) = @_;
-
-  my $in_editbugs = &::UserInGroup($::userid, "editbugs");
-
-  # Retrieve a list of attachments for this bug and write them into an array
-  # of hashes in which each hash represents a single attachment.
-  &::SendSQL("
-              SELECT attach_id, creation_ts, mimetype, description, ispatch, 
-               isobsolete, submitter_id 
-              FROM attachments WHERE bug_id = $bugid ORDER BY attach_id
-            ");
-  my @attachments = ();
-  while (&::MoreSQLData()) {
-    my %a;
-    my $submitter_id;
-    ($a{'attachid'}, $a{'date'}, $a{'contenttype'}, $a{'description'},
-     $a{'ispatch'}, $a{'isobsolete'}, $submitter_id) = &::FetchSQLData();
-
-    # Format the attachment's creation/modification date into a standard
-    # format (YYYY-MM-DD HH:MM)
-    if ($a{'date'} =~ /^(\d\d\d\d)(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)$/) {
-        $a{'date'} = "$1-$2-$3 $4:$5";
-    }
-
-    # Retrieve a list of status flags that have been set on the attachment.
-    &::PushGlobalSQLState();
-    &::SendSQL(" 
-                SELECT   name 
-                FROM     attachstatuses, attachstatusdefs 
-                WHERE    attach_id = $a{'attachid'} 
-                AND      attachstatuses.statusid = attachstatusdefs.id
-                ORDER BY sortkey
-              ");
-    my @statuses = ();
-    while (&::MoreSQLData()) { 
-      my ($status) = &::FetchSQLData(); 
-      push @statuses , $status;
-    }
-    $a{'statuses'} = \@statuses;
-    &::PopGlobalSQLState();
-
-    # We will display the edit link if the user can edit the attachment;
-    # ie the are the submitter, or they have canedit.
-    # Also show the link if the user is not logged in - in that cae,
-    # They'll be prompted later
-    $a{'canedit'} = ($::userid == 0 || $submitter_id == $::userid ||
-                     $in_editbugs);
-    push @attachments, \%a;
-  }
-  
-  return \@attachments;  
-}
-
-1;

mozilla/webtools/bugzilla/Bug.pm

@@ -1,504 +0,0 @@
-# -*- Mode: perl; indent-tabs-mode: nil -*-
-#
-# 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): Dawn Endico    <endico@mozilla.org>
-#                 Terry Weissman <terry@mozilla.org>
-#                 Chris Yeh      <cyeh@bluemartini.com>
-
-use diagnostics;
-use strict;
-
-use DBI;
-use RelationSet;
-use vars qw($unconfirmedstate $legal_keywords);
-require "globals.pl";
-require "CGI.pl";
-package Bug;
-use CGI::Carp qw(fatalsToBrowser);
-my %ok_field;
-
-for my $key (qw (bug_id product version rep_platform op_sys bug_status 
-                resolution priority bug_severity component assigned_to
-                reporter bug_file_loc short_desc target_milestone 
-                qa_contact status_whiteboard creation_ts 
-                delta_ts votes whoid comment query error) ){
-    $ok_field{$key}++;
-    }
-
-# create a new empty bug
-#
-sub new {
-  my $type = shift();
-  my %bug;
-
-  # create a ref to an empty hash and bless it
-  #
-  my $self = {%bug};
-  bless $self, $type;
-
-  # construct from a hash containing a bug's info
-  #
-  if ($#_ == 1) {
-    $self->initBug(@_);
-  } else {
-    confess("invalid number of arguments \($#_\)($_)");
-  }
-
-  # bless as a Bug
-  #
-  return $self;
-}
-
-
-
-# dump info about bug into hash unless user doesn't have permission
-# user_id 0 is used when person is not logged in.
-#
-sub initBug  {
-  my $self = shift();
-  my ($bug_id, $user_id) = (@_);
-
-  my $old_bug_id = $bug_id;
-  if ((! defined $bug_id) || (!$bug_id) || (!&::detaint_natural($bug_id))) {
-      # no bug number given
-      $self->{'bug_id'} = $old_bug_id;
-      $self->{'error'} = "InvalidBugId";
-      return $self;
-  }
-
-# default userid 0, or get DBID if you used an email address
-  unless (defined $user_id) {
-    $user_id = 0;
-  }
-  else {
-     if ($user_id =~ /^\@/) {
-        $user_id = &::DBname_to_id($user_id); 
-     }
-  }
-     
-
-  &::ConnectToDatabase();
-  &::GetVersionTable();
-
-  # this verification should already have been done by caller
-  # my $loginok = quietly_check_login();
-
-
-  $self->{'whoid'} = $user_id;
-
-  # First check that we can see it
-  if (!&::CanSeeBug($bug_id, $user_id)) {
-      # is it not there, or are we just forbidden to see it?
-      &::SendSQL("SELECT bug_id FROM bugs WHERE bug_id = $bug_id");
-      if (&::FetchSQLData()) {
-          $self->{'error'} = "NotPermitted";
-      } else {
-          $self->{'error'} = "NotFound";
-      }
-      $self->{'bug_id'} = $bug_id;
-      return $self;
-  }
-
-  my $query = "
-    select
-      bugs.bug_id, product, version, rep_platform, op_sys, bug_status,
-      resolution, priority, bug_severity, component, assigned_to, reporter,
-      bug_file_loc, short_desc, target_milestone, qa_contact,
-      status_whiteboard, date_format(creation_ts,'%Y-%m-%d %H:%i'),
-      delta_ts, sum(votes.count)
-    from bugs left join votes using(bug_id)
-    where bugs.bug_id = $bug_id
-    group by bugs.bug_id";
-
-  &::SendSQL($query);
-  my @row;
-
-  @row = &::FetchSQLData();
-  my $count = 0;
-  my %fields;
-  foreach my $field ("bug_id", "product", "version", "rep_platform",
-                     "op_sys", "bug_status", "resolution", "priority",
-                     "bug_severity", "component", "assigned_to", "reporter",
-                     "bug_file_loc", "short_desc", "target_milestone",
-                     "qa_contact", "status_whiteboard", "creation_ts",
-                     "delta_ts", "votes") {
-      $fields{$field} = shift @row;
-      if ($fields{$field}) {
-          $self->{$field} = $fields{$field};
-      }
-      $count++;
-  }
-
-  $self->{'assigned_to'} = &::DBID_to_name($self->{'assigned_to'});
-  $self->{'reporter'} = &::DBID_to_name($self->{'reporter'});
-
-  my $ccSet = new RelationSet;
-  $ccSet->mergeFromDB("select who from cc where bug_id=$bug_id");
-  my @cc = $ccSet->toArrayOfStrings();
-  if (@cc) {
-    $self->{'cc'} = \@cc;
-  }
-
-  if (&::Param("useqacontact") && (defined $self->{'qa_contact'}) ) {
-    my $name = $self->{'qa_contact'} > 0 ? &::DBID_to_name($self->{'qa_contact'}) :"";
-    if ($name) {
-      $self->{'qa_contact'} = $name;
-    }
-  }
-
-  if (@::legal_keywords) {
-    &::SendSQL("SELECT keyworddefs.name 
-              FROM keyworddefs, keywords
-             WHERE keywords.bug_id = $bug_id 
-               AND keyworddefs.id = keywords.keywordid
-          ORDER BY keyworddefs.name");
-    my @list;
-    while (&::MoreSQLData()) {
-        push(@list, &::FetchOneColumn());
-    }
-    if (@list) {
-      $self->{'keywords'} = join(', ', @list);
-    }
-  }
-
-  &::SendSQL("select attach_id, creation_ts, description 
-           from attachments 
-           where bug_id = $bug_id");
-  my @attachments;
-  while (&::MoreSQLData()) {
-    my ($attachid, $date, $desc) = (&::FetchSQLData());
-    if ($date =~ /^(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)$/) {
-        $date = "$3/$4/$2 $5:$6";
-      my %attach;
-      $attach{'attachid'} = $attachid;
-      $attach{'date'} = $date;
-      $attach{'desc'} = $desc;
-      push @attachments, \%attach;
-    }
-  }
-  if (@attachments) {
-    $self->{'attachments'} = \@attachments;
-  }
-
-  &::SendSQL("select bug_id, who, bug_when, thetext 
-           from longdescs 
-           where bug_id = $bug_id");
-  my @longdescs;
-  while (&::MoreSQLData()) {
-    my ($bug_id, $who, $bug_when, $thetext) = (&::FetchSQLData());
-    my %longdesc;
-    $longdesc{'who'} = $who;
-    $longdesc{'bug_when'} = $bug_when;
-    $longdesc{'thetext'} = $thetext;
-    push @longdescs, \%longdesc;
-  }
-  if (@longdescs) {
-    $self->{'longdescs'} = \@longdescs;
-  }
-
-  if (&::Param("usedependencies")) {
-    my @depends = EmitDependList("blocked", "dependson", $bug_id);
-    if ( @depends ) {
-      $self->{'dependson'} = \@depends;
-    }
-    my @blocks = EmitDependList("dependson", "blocked", $bug_id);
-    if ( @blocks ) {
-      $self->{'blocks'} = \@blocks;
-    }
-  }
-
-  return $self;
-}
-
-
-
-# given a bug hash, emit xml for it. with file header provided by caller
-#
-sub emitXML {
-  ( $#_ == 0 ) || confess("invalid number of arguments");
-  my $self = shift();
-  my $xml;
-
-
-  if (exists $self->{'error'}) {
-    $xml .= "<bug error=\"$self->{'error'}\">\n";
-    $xml .= "  <bug_id>$self->{'bug_id'}</bug_id>\n";
-    $xml .= "</bug>\n";
-    return $xml;
-  }
-
-  $xml .= "<bug>\n";
-
-  foreach my $field ("bug_id", "bug_status", "product",
-      "priority", "version", "rep_platform", "assigned_to", "delta_ts", 
-      "component", "reporter", "target_milestone", "bug_severity", 
-      "creation_ts", "qa_contact", "op_sys", "resolution", "bug_file_loc",
-      "short_desc", "keywords", "status_whiteboard") {
-    if ($self->{$field}) {
-      $xml .= "  <$field>" . QuoteXMLChars($self->{$field}) . "</$field>\n";
-    }
-  }
-
-  foreach my $field ("dependson", "blocks", "cc") {
-    if (defined $self->{$field}) {
-      for (my $i=0 ; $i < @{$self->{$field}} ; $i++) {
-        $xml .= "  <$field>" . $self->{$field}[$i] . "</$field>\n";
-      }
-    }
-  }
-
-  if (defined $self->{'longdescs'}) {
-    for (my $i=0 ; $i < @{$self->{'longdescs'}} ; $i++) {
-      $xml .= "  <long_desc>\n"; 
-      $xml .= "   <who>" . &::DBID_to_name($self->{'longdescs'}[$i]->{'who'}) 
-                         . "</who>\n"; 
-      $xml .= "   <bug_when>" . $self->{'longdescs'}[$i]->{'bug_when'} 
-                              . "</bug_when>\n"; 
-      $xml .= "   <thetext>" . QuoteXMLChars($self->{'longdescs'}[$i]->{'thetext'})
-                             . "</thetext>\n"; 
-      $xml .= "  </long_desc>\n"; 
-    }
-  }
-
-  if (defined $self->{'attachments'}) {
-    for (my $i=0 ; $i < @{$self->{'attachments'}} ; $i++) {
-      $xml .= "  <attachment>\n"; 
-      $xml .= "    <attachid>" . $self->{'attachments'}[$i]->{'attachid'}
-                              . "</attachid>\n"; 
-      $xml .= "    <date>" . $self->{'attachments'}[$i]->{'date'} . "</date>\n"; 
-      $xml .= "    <desc>" . QuoteXMLChars($self->{'attachments'}[$i]->{'desc'}) . "</desc>\n"; 
-    # $xml .= "    <type>" . $self->{'attachments'}[$i]->{'type'} . "</type>\n"; 
-    # $xml .= "    <data>" . $self->{'attachments'}[$i]->{'data'} . "</data>\n"; 
-      $xml .= "  </attachment>\n"; 
-    }
-  }
-
-  $xml .= "</bug>\n";
-  return $xml;
-}
-
-sub EmitDependList {
-  my ($myfield, $targetfield, $bug_id) = (@_);
-  my @list;
-  &::SendSQL("select dependencies.$targetfield, bugs.bug_status
-           from dependencies, bugs
-           where dependencies.$myfield = $bug_id
-             and bugs.bug_id = dependencies.$targetfield
-           order by dependencies.$targetfield");
-  while (&::MoreSQLData()) {
-    my ($i, $stat) = (&::FetchSQLData());
-    push @list, $i;
-  }
-  return @list;
-}
-
-sub QuoteXMLChars {
-  $_[0] =~ s/&/&amp;/g;
-  $_[0] =~ s/</&lt;/g;
-  $_[0] =~ s/>/&gt;/g;
-  $_[0] =~ s/'/&apos;/g;
-  $_[0] =~ s/"/&quot;/g;
-# $_[0] =~ s/([\x80-\xFF])/&XmlUtf8Encode(ord($1))/ge;
-  return($_[0]);
-}
-
-sub XML_Header {
-  my ($urlbase, $version, $maintainer, $exporter) = (@_);
-
-  my $xml;
-  $xml = "<?xml version=\"1.0\" standalone=\"yes\"?>\n";
-  $xml .= "<!DOCTYPE bugzilla SYSTEM \"$urlbase";
-  if (! ($urlbase =~ /.+\/$/)) {
-    $xml .= "/";
-  }
-  $xml .= "bugzilla.dtd\">\n";
-  $xml .= "<bugzilla";
-  if (defined $exporter) {
-    $xml .= " exporter=\"$exporter\"";
-  }
-  $xml .= " version=\"$version\"";
-  $xml .= " urlbase=\"$urlbase\"";
-  $xml .= " maintainer=\"$maintainer\">\n";
-  return ($xml);
-}
-
-
-sub XML_Footer {
-  return ("</bugzilla>\n");
-}
-
-sub UserInGroup {
-    my $self = shift();
-    my ($groupname) = (@_);
-    return &::UserInGroup($self->{'whoid'}, $groupname);
-}
-
-sub CanChangeField {
-   my $self = shift();
-   my ($f, $oldvalue, $newvalue) = (@_);
-   my $UserInEditGroup = -1;
-   my $UserInCanConfirmGroup = -1;
-   my $ownerid;
-   my $reporterid;
-   my $qacontactid;
-
-    if ($f eq "assigned_to" || $f eq "reporter" || $f eq "qa_contact") {
-        if ($oldvalue =~ /^\d+$/) {
-            if ($oldvalue == 0) {
-                $oldvalue = "";
-            } else {
-                $oldvalue = &::DBID_to_name($oldvalue);
-            }
-        }
-    }
-    if ($oldvalue eq $newvalue) {
-        return 1;
-    }
-    if (&::trim($oldvalue) eq &::trim($newvalue)) {
-        return 1;
-    }
-    if ($f =~ /^longdesc/) {
-        return 1;
-    }
-    if ($UserInEditGroup < 0) {
-        $UserInEditGroup = UserInGroup($self, "editbugs");
-    }
-    if ($UserInEditGroup) {
-        return 1;
-    }
-    &::SendSQL("SELECT reporter, assigned_to, qa_contact FROM bugs " .
-                "WHERE bug_id = $self->{'bug_id'}");
-    ($reporterid, $ownerid, $qacontactid) = (&::FetchSQLData());
-
-    # Let reporter change bug status, even if they can't edit bugs.
-    # If reporter can't re-open their bug they will just file a duplicate.
-    # While we're at it, let them close their own bugs as well.
-    if ( ($f eq "bug_status") && ($self->{'whoid'} eq $reporterid) ) {
-        return 1;
-    }
-    if ($f eq "bug_status" && $newvalue ne $::unconfirmedstate &&
-        &::IsOpenedState($newvalue)) {
-
-        # Hmm.  They are trying to set this bug to some opened state
-        # that isn't the UNCONFIRMED state.  Are they in the right
-        # group?  Or, has it ever been confirmed?  If not, then this
-        # isn't legal.
-
-        if ($UserInCanConfirmGroup < 0) {
-            $UserInCanConfirmGroup = &::UserInGroup($self->{'whoid'},"canconfirm");
-        }
-        if ($UserInCanConfirmGroup) {
-            return 1;
-        }
-        &::SendSQL("SELECT everconfirmed FROM bugs WHERE bug_id = $self->{'bug_id'}");
-        my $everconfirmed = FetchOneColumn();
-        if ($everconfirmed) {
-            return 1;
-        }
-    } elsif ($reporterid eq $self->{'whoid'} || $ownerid eq $self->{'whoid'} ||
-             $qacontactid eq $self->{'whoid'}) {
-        return 1;
-    }
-    $self->{'error'} = "
-Only the owner or submitter of the bug, or a sufficiently
-empowered user, may make that change to the $f field."
-}
-
-sub Collision {
-    my $self = shift();
-    my $write = "WRITE";        # Might want to make a param to control
-                                # whether we do LOW_PRIORITY ...
-    &::SendSQL("LOCK TABLES bugs $write, bugs_activity $write, cc $write, " .
-               "cc AS selectVisible_cc $write, " .
-            "profiles $write, dependencies $write, votes $write, " .
-            "keywords $write, longdescs $write, fielddefs $write, " .
-            "keyworddefs READ, groups READ, attachments READ, products READ");
-    &::SendSQL("SELECT delta_ts FROM bugs where bug_id=$self->{'bug_id'}");
-    my $delta_ts = &::FetchOneColumn();
-    &::SendSQL("unlock tables");
-    if ($self->{'delta_ts'} ne $delta_ts) {
-       return 1;
-    }
-    else {
-       return 0;
-    }
-}
-
-sub AppendComment  {
-    my $self = shift();
-    my ($comment) = (@_);
-    $comment =~ s/\r\n/\n/g;     # Get rid of windows-style line endings.
-    $comment =~ s/\r/\n/g;       # Get rid of mac-style line endings.
-    if ($comment =~ /^\s*$/) {  # Nothin' but whitespace.
-        return;
-    }
-
-    &::SendSQL("INSERT INTO longdescs (bug_id, who, bug_when, thetext) " .
-            "VALUES($self->{'bug_id'}, $self->{'whoid'}, now(), " . &::SqlQuote($comment) . ")");
-
-    &::SendSQL("UPDATE bugs SET delta_ts = now() WHERE bug_id = $self->{'bug_id'}");
-}
-
-
-#from o'reilley's Programming Perl
-sub display {
-    my $self = shift;
-    my @keys;
-    if (@_ == 0) {                  # no further arguments
-        @keys = sort keys(%$self);
-    }  else {
-        @keys = @_;                 # use the ones given
-    }
-    foreach my $key (@keys) {
-        print "\t$key => $self->{$key}\n";
-    }
-}
-
-sub CommitChanges {
-
-#snapshot bug
-#snapshot dependencies
-#check can change fields
-#check collision
-#lock and change fields
-#notify through mail
-
-}
-
-sub AUTOLOAD {
-  use vars qw($AUTOLOAD);
-  my $self = shift;
-  my $type = ref($self) || $self;
-  my $attr = $AUTOLOAD;
-
-  $attr =~ s/.*:://;
-  return unless $attr=~ /[^A-Z]/;
-  if (@_) {
-    $self->{$attr} = shift;
-    return;
-  }
-  confess ("invalid bug attribute $attr") unless $ok_field{$attr};
-  if (defined $self->{$attr}) {
-    return $self->{$attr};
-  } else {
-    return '';
-  }
-}
-
-1;

mozilla/webtools/bugzilla/README

@@ -1,16 +0,0 @@
-* This README is no longer used to house installation instructions.  Instead,
-it contains pointers to where you may find the information you need.
-
-* Installation instructions are now found in docs/, with a variety of document
-types available.  Please refer to these documents when installing, configuring,
-and maintaining your Bugzilla installation.  A helpful starting point is
-docs/txt/Bugzilla-Guide.txt, or with a web browser at docs/html/index.html.
-
-* Release notes for people upgrading to a new version of Bugzilla are
-available at docs/rel_notes.txt.
-
-* If you wish to contribute to the documentation, please read docs/README.docs.
-
-* The Bugzilla web site is at "http://www.mozilla.org/projects/bugzilla/".
-This site will contain the latest Bugzilla information, including how to
-report bugs and how to get help with Bugzilla.

mozilla/webtools/bugzilla/RelationSet.pm

@@ -1,268 +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 the Bugzilla Bug Tracking System.
-# 
-# The Initial Developer of the Original Code is Netscape Communications
-# Corporation. Portions created by Netscape are
-# Copyright (C) 2000 Netscape Communications Corporation.  All
-# Rights Reserved.
-# 
-# Contributor(s): Dan Mosedale <dmose@mozilla.org>
-#                 Terry Weissman <terry@mozilla.org>
-#                 Dave Miller <justdave@syndicomm.com>
-
-# This object models a set of relations between one item and a group
-# of other items.  An example is the set of relations between one bug
-# and the users CCed on that bug.  Currently, the relation objects are
-# expected to be bugzilla userids.  However, this could and perhaps
-# should be generalized to work with non userid objects, such as
-# keywords associated with a bug.  That shouldn't be hard to do; it
-# might involve turning this into a virtual base class, and having
-# UserSet and KeywordSet types that inherit from it.
-
-use diagnostics;
-use strict;
-
-# Everything that uses RelationSet should already have globals.pl loaded
-# so we don't want to load it here.  Doing so causes a loop in Perl because
-# globals.pl turns around and does a 'use RelationSet'
-# See http://bugzilla.mozilla.org/show_bug.cgi?id=72862
-#require "globals.pl";
-
-package RelationSet;
-use CGI::Carp qw(fatalsToBrowser);
-
-# create a new empty RelationSet
-#
-sub new {
-  my $type = shift();
-
-  # create a ref to an empty hash and bless it
-  #
-  my $self = {};
-  bless $self, $type;
-
-  # construct from a comma-delimited string
-  # 
-  if ($#_ == 0) {
-    $self->mergeFromString($_[0]);
-  }
-  # unless this was a constructor for an empty list, somebody screwed up.
-  #
-  elsif ( $#_ != -1 ) {
-    confess("invalid number of arguments");
-  }
-
-  # bless as a RelationSet
-  #
-  return $self;
-}
-
-# Assumes that the set of relations "FROM $table WHERE $constantSql and 
-# $column = $value" is currently represented by $self, and this set should
-# be updated to look like $other.  
-#
-# Returns an array of two strings, one INSERT and one DELETE, which will
-# make this change.  Either or both strings may be the empty string,
-# meaning that no INSERT or DELETE or both (respectively) need to be done.
-#
-# THE CALLER IS RESPONSIBLE FOR ANY DESIRED LOCKING AND/OR CONSISTENCY 
-# CHECKS (not to mention doing the SendSQL() calls).
-#
-sub generateSqlDeltas {
-  ($#_ == 5) || confess("invalid number of arguments");
-  my ( $self, # instance ptr to set representing the existing state
-       $endState, # instance ptr to set representing the desired state
-       $table, # table where these relations are kept
-       $invariantName, # column held const for a RelationSet (often "bug_id")
-       $invariantValue, # what to hold the above column constant at
-       $columnName # the column which varies (often a userid)
-     ) = @_;
-
-  # construct the insert list by finding relations which exist in the
-  # end state but not the current state.
-  #
-  my @endStateRelations = keys(%$endState);
-  my @insertList = ();
-  foreach ( @endStateRelations ) {
-    push ( @insertList, $_ ) if ( ! exists $$self{"$_"} );
-  }
-
-  # we've built the list.  If it's non-null, add required sql chrome.
-  #
-  my $sqlInsert="";
-  if ( $#insertList > -1 ) {
-    $sqlInsert = "INSERT INTO $table ($invariantName, $columnName) VALUES " .
-      join (",", 
-            map ( "($invariantValue, $_)" , @insertList ) 
-           );
-  }
-     
-  # construct the delete list by seeing which relations exist in the
-  # current state but not the end state
-  #
-  my @selfRelations = keys(%$self);
-  my @deleteList = ();
-  foreach ( @selfRelations ) {
-    push (@deleteList, $_) if ( ! exists $$endState{"$_"} );
-  }
-
-  # we've built the list.  if it's non-empty, add required sql chrome.
-  #
-  my $sqlDelete = "";
-  if ( $#deleteList > -1 ) {
-    $sqlDelete = "DELETE FROM $table WHERE $invariantName = $invariantValue " .
-      "AND $columnName IN ( " . join (",", @deleteList) . " )";
-  } 
-
-  return ($sqlInsert, $sqlDelete);
-}
-
-# compare the current object with another.  
-#
-sub isEqual {
-  ($#_ == 1) || confess("invalid number of arguments");
-  my $self = shift();
-  my $other = shift();
-
-  # get arrays of the keys for faster processing
-  #
-  my @selfRelations = keys(%$self);
-  my @otherRelations = keys(%$other);
- 
-  # make sure the arrays are the same size
-  #
-  return 0 if ( $#selfRelations != $#otherRelations );
-
-  # bail out if any of the elements are different
-  #
-  foreach my $relation ( @selfRelations ) {
-    return 0 if ( !exists $$other{$relation})
-  }
-
-  # we made it!
-  #
-  return 1;
-
-}
-
-# merge the results of a SQL command into this set
-#
-sub mergeFromDB {
-  ( $#_ == 1 ) || confess("invalid number of arguments");
-  my $self = shift();
-
-  &::SendSQL(shift());
-  while (my @row = &::FetchSQLData()) {
-    $$self{$row[0]} = 1;
-  }
-
-  return;
-}
-
-# merge a set in string form into this set
-#
-sub mergeFromString {
-  ($#_ == 1) || confess("invalid number of arguments");
-  my $self = shift();
-
-  # do the merge
-  #
-  foreach my $person (split(/[ ,]/, shift())) {
-    if ($person ne "") {
-      $$self{&::DBNameToIdAndCheck($person)} = 1;
-    }
-  }
-}
-
-# remove a set in string form from this set
-#
-sub removeItemsInString {
-  ($#_ == 1) || confess("invalid number of arguments");
-  my $self = shift();
-
-  # do the merge
-  #
-  foreach my $person (split(/[ ,]/, shift())) {
-    if ($person ne "") {
-      my $dbid = &::DBNameToIdAndCheck($person);
-      if (exists $$self{$dbid}) {
-        delete $$self{$dbid};
-      }
-    }
-  }
-}
-
-# remove a set in array form from this set
-#
-sub removeItemsInArray {
-  ($#_ > 0) || confess("invalid number of arguments");
-  my $self = shift();
-
-  # do the merge
-  #
-  while (my $person = shift()) {
-    if ($person ne "") {
-      my $dbid = &::DBNameToIdAndCheck($person);
-      if (exists $$self{$dbid}) {
-        delete $$self{$dbid};
-      }
-    }
-  }
-}
-
-# return the number of elements in this set
-#
-sub size {
-  my $self = shift();
-
-  my @k = keys(%$self);
-  return $#k++;
-}
-
-# return this set in array form
-#
-sub toArray {
-  my $self= shift();
-
-  return keys(%$self);
-}
-
-# return this set as an array of strings
-#
-sub toArrayOfStrings {
-  ($#_ == 0) || confess("invalid number of arguments");
-  my $self = shift();
-
-  my @result = ();
-  foreach my $i ( keys %$self ) {
-    push @result, &::DBID_to_name($i);
-  }
-
-  return sort { lc($a) cmp lc($b) } @result;
-}  
-
-# return this set in string form (comma-separated and sorted)
-#
-sub toString {
-  ($#_ == 0) || confess("invalid number of arguments");
-  my $self = shift();
-
-  my @result = ();
-  foreach my $i ( keys %$self ) {
-    push @result, &::DBID_to_name($i);
-  }
-
-  return join(',', sort(@result));
-}  
-
-1;

mozilla/webtools/bugzilla/Token.pm

@@ -1,270 +0,0 @@
-# -*- Mode: perl; indent-tabs-mode: nil -*-
-#
-# 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):    Myk Melez <myk@mozilla.org>
-
-################################################################################
-# Module Initialization
-################################################################################
-
-# Make it harder for us to do dangerous things in Perl.
-use diagnostics;
-use strict;
-
-# Bundle the functions in this file together into the "Token" package.
-package Token;
-
-use Date::Format;
-
-# This module requires that its caller have said "require CGI.pl" to import
-# relevant functions from that script and its companion globals.pl.
-
-################################################################################
-# Constants
-################################################################################
-
-# The maximum number of days a token will remain valid.
-my $maxtokenage = 3;
-
-################################################################################
-# Functions
-################################################################################
-
-sub IssueEmailChangeToken {
-    my ($userid, $old_email, $new_email) = @_;
-
-    my $token_ts = time();
-    my $issuedate = time2str("%Y-%m-%d %H:%M", $token_ts);
-
-    # Generate a unique token and insert it into the tokens table.
-    # We have to lock the tokens table before generating the token, 
-    # since the database must be queried for token uniqueness.
-    &::SendSQL("LOCK TABLES tokens WRITE");
-    my $token = GenerateUniqueToken();
-    my $quotedtoken = &::SqlQuote($token);
-    my $quoted_emails = &::SqlQuote($old_email . ":" . $new_email);
-    &::SendSQL("INSERT INTO tokens ( userid , issuedate , token , 
-                                     tokentype , eventdata )
-                VALUES             ( $userid , '$issuedate' , $quotedtoken , 
-                                     'emailold' , $quoted_emails )");
-    my $newtoken = GenerateUniqueToken();
-    $quotedtoken = &::SqlQuote($newtoken);
-    &::SendSQL("INSERT INTO tokens ( userid , issuedate , token , 
-                                     tokentype , eventdata )
-                VALUES             ( $userid , '$issuedate' , $quotedtoken , 
-                                     'emailnew' , $quoted_emails )");
-    &::SendSQL("UNLOCK TABLES");
-
-    # Mail the user the token along with instructions for using it.
-
-    my $template = $::template;
-    my $vars = $::vars;
-
-    $vars->{'oldemailaddress'} = $old_email . &::Param('emailsuffix');
-    $vars->{'newemailaddress'} = $new_email . &::Param('emailsuffix');
-    
-    $vars->{'max_token_age'} = $maxtokenage;
-    $vars->{'token_ts'} = $token_ts;
-
-    $vars->{'token'} = $token;
-    $vars->{'emailaddress'} = $old_email . &::Param('emailsuffix');
-
-    my $message;
-    $template->process("account/email/change-old.txt.tmpl", $vars, \$message)
-      || &::ThrowTemplateError($template->error());
-
-    open SENDMAIL, "|/usr/lib/sendmail -t -i";
-    print SENDMAIL $message;
-    close SENDMAIL;
-
-    $vars->{'token'} = $newtoken;
-    $vars->{'emailaddress'} = $new_email . &::Param('emailsuffix');
-
-    $message = "";
-    $template->process("account/email/change-new.txt.tmpl", $vars, \$message)
-      || &::ThrowTemplateError($template->error());
-
-    open SENDMAIL, "|/usr/lib/sendmail -t -i";
-    print SENDMAIL $message;
-    close SENDMAIL;
-
-}
-
-sub IssuePasswordToken {
-    # Generates a random token, adds it to the tokens table, and sends it
-    # to the user with instructions for using it to change their password.
-
-    my ($loginname) = @_;
-
-    # Retrieve the user's ID from the database.
-    my $quotedloginname = &::SqlQuote($loginname);
-    &::SendSQL("SELECT userid FROM profiles WHERE login_name = $quotedloginname");
-    my ($userid) = &::FetchSQLData();
-
-    my $token_ts = time();
-    my $issuedate = time2str("%Y-%m-%d %H:%M", $token_ts);
-
-    # Generate a unique token and insert it into the tokens table.
-    # We have to lock the tokens table before generating the token, 
-    # since the database must be queried for token uniqueness.
-    &::SendSQL("LOCK TABLES tokens WRITE");
-    my $token = GenerateUniqueToken();
-    my $quotedtoken = &::SqlQuote($token);
-    my $quotedipaddr = &::SqlQuote($::ENV{'REMOTE_ADDR'});
-    &::SendSQL("INSERT INTO tokens ( userid , issuedate , token , tokentype , eventdata )
-                VALUES      ( $userid , '$issuedate' , $quotedtoken , 'password' , $quotedipaddr )");
-    &::SendSQL("UNLOCK TABLES");
-
-    # Mail the user the token along with instructions for using it.
-    
-    my $template = $::template;
-    my $vars = $::vars;
-
-    $vars->{'token'} = $token;
-    $vars->{'emailaddress'} = $loginname . &::Param('emailsuffix');
-
-    $vars->{'max_token_age'} = $maxtokenage;
-    $vars->{'token_ts'} = $token_ts;
-
-    my $message = "";
-    $template->process("account/password/forgotten-password.txt.tmpl", 
-                                                               $vars, \$message)
-      || &::ThrowTemplateError($template->error());
-
-    open SENDMAIL, "|/usr/lib/sendmail -t -i";
-    print SENDMAIL $message;
-    close SENDMAIL;
-
-}
-
-
-sub CleanTokenTable {
-    &::SendSQL("LOCK TABLES tokens WRITE");
-    &::SendSQL("DELETE FROM tokens 
-                WHERE TO_DAYS(NOW()) - TO_DAYS(issuedate) >= " . $maxtokenage);
-    &::SendSQL("UNLOCK TABLES");
-}
-
-
-sub GenerateUniqueToken {
-    # Generates a unique random token.  Uses &GenerateRandomPassword 
-    # for the tokens themselves and checks uniqueness by searching for
-    # the token in the "tokens" table.  Gives up if it can't come up
-    # with a token after about one hundred tries.
-
-    my $token;
-    my $duplicate = 1;
-    my $tries = 0;
-    while ($duplicate) {
-
-        ++$tries;
-        if ($tries > 100) {
-            &::DisplayError("Something is seriously wrong with the token generation system.");
-            exit;
-        }
-
-        $token = &::GenerateRandomPassword();
-        &::SendSQL("SELECT userid FROM tokens WHERE token = " . &::SqlQuote($token));
-        $duplicate = &::FetchSQLData();
-    }
-
-    return $token;
-
-}
-
-
-sub Cancel {
-    # Cancels a previously issued token and notifies the system administrator.
-    # This should only happen when the user accidentally makes a token request
-    # or when a malicious hacker makes a token request on behalf of a user.
-    
-    my ($token, $cancelaction) = @_;
-
-    # Quote the token for inclusion in SQL statements.
-    my $quotedtoken = &::SqlQuote($token);
-    
-    # Get information about the token being cancelled.
-    &::SendSQL("SELECT  issuedate , tokentype , eventdata , login_name , realname
-                FROM    tokens, profiles 
-                WHERE   tokens.userid = profiles.userid
-                AND     token = $quotedtoken");
-    my ($issuedate, $tokentype, $eventdata, $loginname, $realname) = &::FetchSQLData();
-
-    # Get the email address of the Bugzilla maintainer.
-    my $maintainer = &::Param('maintainer');
-
-    # Format the user's real name and email address into a single string.
-    my $username = $realname ? $realname . " <" . $loginname . ">" : $loginname;
-
-    my $template = $::template;
-    my $vars = $::vars;
-
-    $vars->{'emailaddress'} = $username;
-    $vars->{'maintainer'} = $maintainer;
-    $vars->{'remoteaddress'} = $::ENV{'REMOTE_ADDR'};
-    $vars->{'token'} = $token;
-    $vars->{'tokentype'} = $tokentype;
-    $vars->{'issuedate'} = $issuedate;
-    $vars->{'eventdata'} = $eventdata;
-    $vars->{'cancelaction'} = $cancelaction;
-
-    # Notify the user via email about the cancellation.
-
-    my $message;
-    $template->process("account/cancel-token.txt.tmpl", $vars, \$message)
-      || &::ThrowTemplateError($template->error());
-
-    open SENDMAIL, "|/usr/lib/sendmail -t -i";
-    print SENDMAIL $message;
-    close SENDMAIL;
-
-    # Delete the token from the database.
-    &::SendSQL("LOCK TABLES tokens WRITE");
-    &::SendSQL("DELETE FROM tokens WHERE token = $quotedtoken");
-    &::SendSQL("UNLOCK TABLES");
-}
-
-sub HasPasswordToken {
-    # Returns a password token if the user has one.
-    
-    my ($userid) = @_;
-    
-    &::SendSQL("SELECT token FROM tokens 
-                WHERE userid = $userid AND tokentype = 'password' LIMIT 1");
-    my ($token) = &::FetchSQLData();
-    
-    return $token;
-}
-
-sub HasEmailChangeToken {
-    # Returns an email change token if the user has one. 
-    
-    my ($userid) = @_;
-    
-    &::SendSQL("SELECT token FROM tokens 
-                 WHERE userid = $userid 
-                   AND tokentype = 'emailnew' 
-                    OR tokentype = 'emailold' LIMIT 1");
-    my ($token) = &::FetchSQLData();
-    
-    return $token;
-}
-
-
-1;

mozilla/webtools/bugzilla/UPGRADING

@@ -1,3 +0,0 @@
-Please consult The Bugzilla Guide for instructions on how to upgrade
-Bugzilla from an older version.  The Guide can be found with this
-distribution, in docs/html, docs/txt, and docs/sgml.

mozilla/webtools/bugzilla/UPGRADING-pre-2.8

@@ -1,407 +0,0 @@
-This file contains only important changes made to Bugzilla before release
-2.8.  If you are upgrading from version older than 2.8, please read this file.
-If you are upgrading from 2.8 or newer, please read the Installation and
-Upgrade instructions in The Bugzilla Guide, found with this distribution in
-docs/html, docs/txt, and docs/sgml.
-
-For a complete list of what changes, use Bonsai
-(http://cvs-mirror.mozilla.org/webtools/bonsai/cvsqueryform.cgi) to
-query the CVS tree.  For example,
-
-    http://cvs-mirror.mozilla.org/webtools/bonsai/cvsquery.cgi?module=all&branch=HEAD&branchtype=match&dir=mozilla%2Fwebtools%2Fbugzilla&file=&filetype=match&who=&whotype=match&sortby=Date&hours=2&date=week&mindate=&maxdate=&cvsroot=%2Fcvsroot 
-
-will tell you what has been changed in the last week.
-
-
-10/12/99 The CHANGES file is now obsolete!  There is a new file called
-checksetup.pl.  You should get in the habit of running that file every time
-you update your installation of Bugzilla.  That file will be constantly 
-updated to automatically update your installation to match any code changes.
-If you're curious as to what is going on, changes are commented in that file, 
-at the end.
-
-Many thanks to Holger Schurig <holgerschurig@nikocity.de> for writing this
-script!
-
-
-
-10/11/99 Restructured voting database to add a cached value in each
-bug recording how many total votes that bug has.  While I'm at it, I
-removed the unused "area" field from the bugs database.  It is
-distressing to realize that the bugs table has reached the maximum
-number of indices allowed by MySQL (16), which may make future
-enhancements awkward.
-
-You must feed the following to MySQL:
-
-	alter table bugs drop column area;
-	alter table bugs add column votes mediumint not null, add index (votes);
-
-You then *must* delete the data/versioncache file when you make this
-change, as it contains references to the "area" field.  Deleting it is safe,
-bugzilla will correctly regenerate it.
-
-If you have been using the voting feature at all, then you will then
-need to update the voting cache.  You can do this by visiting the
-sanitycheck.cgi page, and taking it up on its offer to rebuild the
-votes stuff.
-
-
-10/7/99 Added voting ability.  You must run the new script
-"makevotestable.sh".  You must also feed the following to mysql:
-
-	alter table products add column votesperuser smallint not null;
-
-
-
-9/15/99 Apparently, newer alphas of MySQL won't allow you to have
-"when" as a column name.  So, I have had to rename a column in the
-bugs_activity table.  You must feed the below to mysql or you won't
-work at all.
-
-	alter table bugs_activity change column when bug_when datetime not null;
-
-
-8/16/99 Added "OpenVMS" to the list of OS's. Feed this to mysql:
-
-	alter table bugs change column op_sys op_sys enum("All", "Windows 3.1", "Windows 95", "Windows 98", "Windows NT", "Mac System 7", "Mac System 7.5", "Mac System 7.6.1", "Mac System 8.0", "Mac System 8.5", "Mac System 8.6", "AIX", "BSDI", "HP-UX", "IRIX", "Linux", "FreeBSD", "OSF/1", "Solaris", "SunOS", "Neutrino", "OS/2", "BeOS", "OpenVMS", "other") not null;
-
-6/22/99 Added an entry to the attachments table to record who the submitter
-was.  Nothing uses this yet, but it still should be recorded.
-
-	alter table attachments add column submitter_id mediumint not null;
-
-You should also run this script to populate the new field:
-
-#!/usr/bonsaitools/bin/perl -w
-use diagnostics;
-use strict;
-require "globals.pl";
-$|=1;
-ConnectToDatabase();
-SendSQL("select bug_id, attach_id from attachments order by bug_id");
-my @list;
-while (MoreSQLData()) {
-    my @row = FetchSQLData();
-    push(@list, \@row);
-}
-foreach my $ref (@list) {
-    my ($bug, $attach) = (@$ref);
-    SendSQL("select long_desc from bugs where bug_id = $bug");
-    my $comment = FetchOneColumn() . "Created an attachment (id=$attach)";
-
-    if ($comment =~ m@-* Additional Comments From ([^ ]*)[- 0-9/:]*\nCreated an attachment \(id=$attach\)@) {
-	print "Found $1\n";
-	SendSQL("select userid from profiles where login_name=" .
-		SqlQuote($1));
-	my $userid = FetchOneColumn();
-	if (defined $userid && $userid > 0) {
-	    SendSQL("update attachments set submitter_id=$userid where attach_id = $attach");
-	}
-    } else {
-	print "Bug $bug can't find comment for attachment $attach\n";
-    }
-}
-
-
-
-
-
-
-6/14/99 Added "BeOS" to the list of OS's. Feed this to mysql:
-
-	alter table bugs change column op_sys op_sys enum("All", "Windows 3.1", "Windows 95", "Windows 98", "Windows NT", "Mac System 7", "Mac System 7.5", "Mac System 7.6.1", "Mac System 8.0", "Mac System 8.5", "Mac System 8.6", "AIX", "BSDI", "HP-UX", "IRIX", "Linux", "FreeBSD", "OSF/1", "Solaris", "SunOS", "Neutrino", "OS/2", "BeOS", "other") not null;
-
-
-5/27/99 Added support for dependency information.  You must run the new
-"makedependenciestable.sh" script.  You can turn off dependencies with the new
-"usedependencies" param, but it defaults to being on.  Also, read very
-carefully the description for the new "webdotbase" param; you will almost
-certainly need to tweak it.
-
-
-5/24/99 Added "Mac System 8.6" and "Neutrino" to the list of OS's.
-Feed this to mysql:
-
-	alter table bugs change column op_sys op_sys enum("All", "Windows 3.1", "Windows 95", "Windows 98", "Windows NT", "Mac System 7", "Mac System 7.5", "Mac System 7.6.1", "Mac System 8.0", "Mac System 8.5", "Mac System 8.6", "AIX", "BSDI", "HP-UX", "IRIX", "Linux", "FreeBSD", "OSF/1", "Solaris", "SunOS", "Neutrino", "OS/2", "other") not null;
-
-
-5/12/99 Added a pref to control how much email you get.  This needs a new
-column in the profiles table, so feed the following to mysql:
-
-	alter table profiles add column emailnotification enum("ExcludeSelfChanges", "CConly", "All") not null default "ExcludeSelfChanges";
-
-5/5/99 Added the ability to search by creation date.  To make this perform
-well, you ought to do the following:
-
-	alter table bugs change column creation_ts creation_ts datetime not null, add index (creation_ts);
-
-
-4/30/99 Added a new severity, "blocker".  To get this into your running
-Bugzilla, do the following:
-
-	alter table bugs change column bug_severity bug_severity enum("blocker", "critical", "major", "normal", "minor", "trivial", "enhancement") not null;
-
-
-4/22/99 There was a bug where the long descriptions of bugs had a variety of
-newline characters at the end, depending on the operating system of the browser
-that submitted the text.  This bug has been fixed, so that no further changes
-like that will happen.  But to fix problems that have already crept into your
-database, you can run the following perl script (which is slow and ugly, but
-does work:)
-#!/usr/bonsaitools/bin/perl -w
-use diagnostics;
-use strict;
-require "globals.pl";
-$|=1;
-ConnectToDatabase();
-SendSQL("select bug_id from bugs order by bug_id");
-my @list;
-while (MoreSQLData()) {
-    push(@list, FetchOneColumn());
-}
-foreach my $id (@list) {
-    if ($id % 50 == 0) {
-	print "\n$id ";
-    }
-    SendSQL("select long_desc from bugs where bug_id = $id");
-    my $comment = FetchOneColumn();
-    my $orig = $comment;
-    $comment =~ s/\r\n/\n/g;     # Get rid of windows-style line endings.
-    $comment =~ s/\r/\n/g;       # Get rid of mac-style line endings.
-    if ($comment ne $orig) {
-	SendSQL("update bugs set long_desc = " . SqlQuote($comment) .
-		" where bug_id = $id");
-	print ".";
-    } else {
-	print "-";
-    }
-}
-
-
-
-4/8/99 Added ability to store patches with bugs.  This requires a new table
-to store the data, so you will need to run the "makeattachmenttable.sh" script.
-
-3/25/99 Unfortunately, the HTML::FromText CPAN module had too many bugs, and
-so I had to roll my own.  We no longer use the HTML::FromText CPAN module.
-
-3/24/99 (This entry has been removed.  It used to say that we required the
-HTML::FromText CPAN module, but that's no longer true.)
-
-3/22/99 Added the ability to query by fields which have changed within a date
-range.  To make this perform a bit better, we need a new index:
-
-	alter table bugs_activity add index (field);
-
-3/10/99 Added 'groups' stuff, where we have different group bits that we can
-put on a person or on a bug.  Some of the group bits control access to bugzilla
-features.  And a person can't access a bug unless he has every group bit set
-that is also set on the bug.  See the comments in makegroupstable.sh for a bit
-more info.
-
-The 'maintainer' param is now used only as an email address for people to send
-complaints to.  The groups table is what is now used to determine permissions.
-
-You will need to run the new script "makegroupstable.sh".  And then you need to
-feed the following lines to MySQL (replace XXX with the login name of the
-maintainer, the person you wish to be all-powerful).
-
-	alter table bugs add column groupset bigint not null;
-	alter table profiles add column groupset bigint not null;
-	update profiles set groupset=0x7fffffffffffffff where login_name = XXX;
-
-
-
-3/8/99 Added params to control how priorities are set in a new bug.  You can
-now choose whether to let submitters of new bugs choose a priority, or whether
-they should just accept the default priority (which is now no longer hardcoded
-to "P2", but is instead a param.)  The default value of the params will cause
-the same behavior as before.
-
-3/3/99 Added a "disallownew" field to the products table.  If non-zero, then
-don't let people file new bugs against this product.  (This is for when a 
-product is retired, but you want to keep the bug reports around for posterity.)
-Feed this to MySQL:
-
-	alter table products add column disallownew tinyint not null;
-
-
-2/8/99 Added FreeBSD to the list of OS's.  Feed this to MySQL:
-
-	alter table bugs change column op_sys op_sys enum("All", "Windows 3.1", "Windows 95", "Windows 98", "Windows NT", "Mac System 7", "Mac System 7.5", "Mac System 7.6.1", "Mac System 8.0", "Mac System 8.5", "AIX", "BSDI", "HP-UX", "IRIX", "Linux", "FreeBSD", "OSF/1", "Solaris", "SunOS", "OS/2", "other") not null;
-
-
-2/4/99 Added a new column "description" to the components table, and added 
-links to a new page which will use this to describe the components of a 
-given product.  Feed this to MySQL:
-
-	alter table components add column description mediumtext not null;
-
-
-2/3/99 Added a new column "initialqacontact" to the components table that gives
-an initial QA contact field.  It may be empty if you wish the initial qa
-contact to be empty.  If you're not using the QA contact field, you don't need
-to add this column, but you might as well be safe and add it anyway:
-
-	alter table components add column initialqacontact tinytext not null;
-
-
-2/2/99 Added a new column "milestoneurl" to the products table that gives a URL
-which is to describe the currently defined milestones for a product.  If you
-don't use target milestone, you might be able to get away without adding this
-column, but you might as well be safe and add it anyway:
-
-	alter table products add column milestoneurl tinytext not null;
-
-
-1/29/99 Whoops; had a misspelled op_sys.  It was "Mac System 7.1.6"; it should
-be "Mac System 7.6.1".  It turns out I had no bugs with this value set, so I
-could just do the below simple command.  If you have bugs with this value, you
-may need to do something more complicated.
-
-	alter table bugs change column op_sys op_sys enum("All", "Windows 3.1", "Windows 95", "Windows 98", "Windows NT", "Mac System 7", "Mac System 7.5", "Mac System 7.6.1", "Mac System 8.0", "Mac System 8.5", "AIX", "BSDI", "HP-UX", "IRIX", "Linux", "OSF/1", "Solaris", "SunOS", "OS/2", "other") not null;
-
-
-
-1/20/99 Added new fields: Target Milestone, QA Contact, and Status Whiteboard.
-These fields are all optional in the UI; there are parameters to turn them on.
-However, whether or not you use them, the fields need to be in the DB.  There
-is some code that needs them, even if you don't.
-
-To update your DB to have these fields, send the following to MySQL:
-
-        alter table bugs add column target_milestone varchar(20) not null,
-                add column qa_contact mediumint not null,
-                add column status_whiteboard mediumtext not null,
-                add index (target_milestone), add index (qa_contact);
-
-
-
-1/18/99 You can now query by CC.  To make this perform reasonably, the CC table
-needs some indices.  The following MySQL does the necessary stuff:
-
-	alter table cc add index (bug_id), add index (who);
-
-
-1/15/99 The op_sys field can now be queried by (and more easily tweaked).
-To make this perform reasonably, it needs an index.  The following MySQL 
-command will create the necessary index:
-
-	alter table bugs add index (op_sys);
-
-
-12/2/98 The op_sys and rep_platform fields have been tweaked.  op_sys
-is now an enum, rather than having the legal values all hard-coded in
-perl.  rep_platform now no longer allows a value of "X-Windows".
-
-Here's how I ported to the new world.  This ought to work for you too.
-Actually, it's probably overkill.  I had a lot of illegal values for op_sys
-in my tables, from importing bugs from strange places.  If you haven't done 
-anything funky, then much of the below will be a no-op.
-
-First, send the following commands to MySQL to make sure all your values for
-rep_platform and op_sys are legal in the new world..
-
-	update bugs set rep_platform="Sun" where rep_platform="X-Windows" and op_sys like "Solaris%";
-	update bugs set rep_platform="SGI" where rep_platform="X-Windows" and op_sys = "IRIX";
-	update bugs set rep_platform="SGI" where rep_platform="X-Windows" and op_sys = "HP-UX";
-	update bugs set rep_platform="DEC" where rep_platform="X-Windows" and op_sys = "OSF/1";
-	update bugs set rep_platform="PC" where rep_platform="X-Windows" and op_sys = "Linux";
-	update bugs set rep_platform="other" where rep_platform="X-Windows";
-	update bugs set rep_platform="other" where rep_platform="";
-	update bugs set op_sys="Mac System 7" where op_sys="System 7";
-	update bugs set op_sys="Mac System 7.5" where op_sys="System 7.5";
-	update bugs set op_sys="Mac System 8.0" where op_sys="8.0";
-	update bugs set op_sys="OSF/1" where op_sys="Digital Unix 4.0";
-	update bugs set op_sys="IRIX" where op_sys like "IRIX %";
-	update bugs set op_sys="HP-UX" where op_sys like "HP-UX %";
-	update bugs set op_sys="Windows NT" where op_sys like "NT %";
-	update bugs set op_sys="OSF/1" where op_sys like "OSF/1 %";
-	update bugs set op_sys="Solaris" where op_sys like "Solaris %";
-	update bugs set op_sys="SunOS" where op_sys like "SunOS%";
-	update bugs set op_sys="other" where op_sys = "Motif";
-	update bugs set op_sys="other" where op_sys = "Other";
-
-Next, send the following commands to make sure you now have only legal
-entries in your table.  If either of the queries do not come up empty, then
-you have to do more stuff like the above.
-
-	select bug_id,op_sys,rep_platform from bugs where rep_platform not regexp "^(All|DEC|HP|Macintosh|PC|SGI|Sun|X-Windows|Other)$";
-	select bug_id,op_sys,rep_platform from bugs where op_sys not regexp "^(All|Windows 3.1|Windows 95|Windows 98|Windows NT|Mac System 7|Mac System 7.5|Mac System 7.1.6|Mac System 8.0|AIX|BSDI|HP-UX|IRIX|Linux|OSF/1|Solaris|SunOS|other)$";
-
-Finally, once that's all clear, alter the table to make enforce the new legal
-entries:
-
-	alter table bugs change column op_sys op_sys enum("All", "Windows 3.1", "Windows 95", "Windows 98", "Windows NT", "Mac System 7", "Mac System 7.5", "Mac System 7.1.6", "Mac System 8.0", "AIX", "BSDI", "HP-UX", "IRIX", "Linux", "OSF/1", "Solaris", "SunOS", "other") not null, change column rep_platform rep_platform enum("All", "DEC", "HP", "Macintosh", "PC", "SGI", "Sun", "Other");
-
-
-
-
-
-11/20/98 Added searching of CC field.  To better support this, added
-some indexes to the CC table.  You probably want to execute the following
-mysql commands:
-
-	alter table cc add index (bug_id);
-	alter table cc add index (who);
-
-
-10/27/98 security check for legal products in place. bug charts are not
-available as an option if collectstats.pl has never been run. all products 
-get daily stats collected now. README updated: Chart::Base is listed as
-a requirement, instructions for using collectstats.pl included as 
-an optional step. also got silly and added optional quips to bug
-reports. 
-
-10/17/98 modified README installation instructions slightly. 
-
-10/7/98 Added a new table called "products".  Right now, this is used
-only to have a description for each product, and that description is
-only used when initially adding a new bug.  Anyway, you *must* create
-the new table (which you can do by running the new makeproducttable.sh
-script).  If you just leave it empty, things will work much as they
-did before, or you can add descriptions for some or all of your
-products.
-
-
-9/15/98 Everything has been ported to Perl.  NO MORE TCL.  This
-transition should be relatively painless, except for the "params"
-file.  This is the file that contains parameters you've set up on the
-editparams.cgi page.  Before changing to Perl, this was a tcl-syntax
-file, stored in the same directory as the code; after the change to
-Perl, it becomes a perl-syntax file, stored in a subdirectory named
-"data".  See the README file for more details on what version of Perl
-you need.
-
-So, if updating from an older version of Bugzilla, you will need to
-edit data/param, change the email address listed for
-$::param{'maintainer'}, and then go revisit the editparams.cgi page
-and reset all the parameters to your taste.  Fortunately, your old
-params file will still be around, and so you ought to be able to
-cut&paste important bits from there.
-
-Also, note that the "whineatnews" script has changed name (it now has
-an extension of .pl instead of .tcl), so you'll need to change your
-cron job.
-
-And the "comments" file has been moved to the data directory.  Just do
-"cat comments >> data/comments" to restore any old comments that may
-have been lost.
-
-
-
-9/2/98 Changed the way password validation works.  We now keep a
-crypt'd version of the password in the database, and check against
-that.  (This is silly, because we're also keeping the plaintext
-version there, but I have plans...)  Stop passing the plaintext
-password around as a cookie; instead, we have a cookie that references
-a record in a new database table, logincookies.
-
-IMPORTANT: if updating from an older version of Bugzilla, you must run
-the following commands to keep things working:
-
- ./makelogincookiestable.sh
- echo "alter table profiles add column cryptpassword varchar(64);" | mysql bugs
- echo "update profiles set cryptpassword = encrypt(password,substring(rand(),3, 4));" | mysql bugs
-

mozilla/webtools/bugzilla/attachment.cgi

@@ -1,788 +0,0 @@
-#!/usr/bonsaitools/bin/perl -wT
-# -*- Mode: perl; indent-tabs-mode: nil -*-
-#
-# 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>
-#                 Myk Melez <myk@mozilla.org>
-
-################################################################################
-# Script Initialization
-################################################################################
-
-# Make it harder for us to do dangerous things in Perl.
-use diagnostics;
-use strict;
-
-use lib qw(.);
-
-use vars qw(
-  $template
-  $vars
-);
-
-# Include the Bugzilla CGI and general utility library.
-require "CGI.pl";
-
-# Establish a connection to the database backend.
-ConnectToDatabase();
-
-# Check whether or not the user is logged in and, if so, set the $userid 
-my $userid = quietly_check_login();
-
-################################################################################
-# Main Body Execution
-################################################################################
-
-# All calls to this script should contain an "action" variable whose value
-# determines what the user wants to do.  The code below checks the value of
-# that variable and runs the appropriate code.
-
-# Determine whether to use the action specified by the user or the default.
-my $action = $::FORM{'action'} || 'view';
-
-if ($action eq "view")  
-{ 
-  validateID();
-  view(); 
-}
-elsif ($action eq "viewall") 
-{ 
-  ValidateBugID($::FORM{'bugid'}, $userid);
-  viewall(); 
-}
-elsif ($action eq "enter") 
-{ 
-  my $userid = confirm_login();
-  ValidateBugID($::FORM{'bugid'}, $userid);
-  enter(); 
-}
-elsif ($action eq "insert")
-{
-  my $userid = confirm_login();
-  ValidateBugID($::FORM{'bugid'}, $userid);
-  ValidateComment($::FORM{'comment'});
-  validateFilename();
-  validateData();
-  validateDescription();
-  validateIsPatch();
-  validateContentType() unless $::FORM{'ispatch'};
-  validateObsolete() if $::FORM{'obsolete'};
-  insert();
-}
-elsif ($action eq "edit") 
-{ 
-  quietly_check_login();
-  validateID();
-  validateCanEdit($::FORM{'id'});
-  edit(); 
-}
-elsif ($action eq "update") 
-{ 
-  my $userid = confirm_login();
-  UserInGroup($userid, "editbugs")
-    || DisplayError("You are not authorized to edit attachments.")
-    && exit;
-  ValidateComment($::FORM{'comment'});
-  validateID();
-  validateCanEdit($::FORM{'id'});
-  validateDescription();
-  validateIsPatch();
-  validateContentType() unless $::FORM{'ispatch'};
-  validateIsObsolete();
-  validateStatuses();
-  update();
-}
-else 
-{ 
-  DisplayError("I could not figure out what you wanted to do.")
-}
-
-exit;
-
-################################################################################
-# Data Validation / Security Authorization
-################################################################################
-
-sub validateID
-{
-  # Validate the value of the "id" form field, which must contain an
-  # integer that is the ID of an existing attachment.
-
-  detaint_natural($::FORM{'id'})
-    || DisplayError("You did not enter a valid attachment number.") 
-      && exit;
-  
-  # Make sure the attachment exists in the database.
-  SendSQL("SELECT bug_id FROM attachments WHERE attach_id = $::FORM{'id'}");
-  MoreSQLData()
-    || DisplayError("Attachment #$::FORM{'id'} does not exist.") 
-    && exit;
-
-  # Make sure the user is authorized to access this attachment's bug.
-  my ($bugid) = FetchSQLData();
-  ValidateBugID($bugid, $userid);
-}
-
-sub validateCanEdit
-{
-    my ($attach_id) = (@_);
-
-    # If the user is not logged in, claim that they can edit. This allows
-    # the edit scrren to be displayed to people who aren't logged in.
-    # People not logged in can't actually commit changes, because that code
-    # calls confirm_login, not quietly_check_login, before calling this sub
-    return if $userid == 0;
-
-    # People in editbugs can edit all attachments
-    return if UserInGroup($userid, "editbugs");
-
-    # Bug 97729 - the submitter can edit their attachments
-    SendSQL("SELECT attach_id FROM attachments WHERE " .
-            "attach_id = $attach_id AND submitter_id = $userid");
-
-    FetchSQLData()
-      || DisplayError("You are not authorised to edit attachment #$attach_id")
-      && exit;
-}
-
-sub validateDescription
-{
-  $::FORM{'description'}
-    || DisplayError("You must enter a description for the attachment.")
-      && exit;
-}
-
-sub validateIsPatch
-{
-  # Set the ispatch flag to zero if it is undefined, since the UI uses
-  # an HTML checkbox to represent this flag, and unchecked HTML checkboxes
-  # do not get sent in HTML requests.
-  $::FORM{'ispatch'} = $::FORM{'ispatch'} ? 1 : 0;
-
-  # Set the content type to text/plain if the attachment is a patch.
-  $::FORM{'contenttype'} = "text/plain" if $::FORM{'ispatch'};
-}
-
-sub validateContentType
-{
-  if (!$::FORM{'contenttypemethod'})
-  {
-    DisplayError("You must choose a method for determining the content type,
-      either <em>auto-detect</em>, <em>select from list</em>, or <em>enter 
-      manually</em>.");
-    exit;
-  }
-  elsif ($::FORM{'contenttypemethod'} eq 'autodetect')
-  {
-    # The user asked us to auto-detect the content type, so use the type
-    # specified in the HTTP request headers.
-    if ( !$::FILE{'data'}->{'contenttype'} )
-    {
-      DisplayError("You asked Bugzilla to auto-detect the content type, but
-        your browser did not specify a content type when uploading the file, 
-        so you must enter a content type manually.");
-      exit;
-    }
-    $::FORM{'contenttype'} = $::FILE{'data'}->{'contenttype'};
-  }
-  elsif ($::FORM{'contenttypemethod'} eq 'list')
-  {
-    # The user selected a content type from the list, so use their selection.
-    $::FORM{'contenttype'} = $::FORM{'contenttypeselection'};
-  }
-  elsif ($::FORM{'contenttypemethod'} eq 'manual')
-  {
-    # The user entered a content type manually, so use their entry.
-    $::FORM{'contenttype'} = $::FORM{'contenttypeentry'};
-  }
-  else
-  {
-    my $htmlcontenttypemethod = html_quote($::FORM{'contenttypemethod'});
-    DisplayError("Your form submission got corrupted somehow.  The <em>content
-      method</em> field, which specifies how the content type gets determined,
-      should have been either <em>autodetect</em>, <em>list</em>, 
-      or <em>manual</em>, but was instead <em>$htmlcontenttypemethod</em>.");
-    exit;
-  }
-
-  if ( $::FORM{'contenttype'} !~ /^(application|audio|image|message|model|multipart|text|video)\/.+$/ )
-  {
-    my $htmlcontenttype = html_quote($::FORM{'contenttype'});
-    DisplayError("The content type <em>$htmlcontenttype</em> is invalid.
-      Valid types must be of the form <em>foo/bar</em> where <em>foo</em> 
-      is either <em>application, audio, image, message, model, multipart, 
-      text,</em> or <em>video</em>.");
-    exit;
-  }
-}
-
-sub validateIsObsolete
-{
-  # Set the isobsolete flag to zero if it is undefined, since the UI uses
-  # an HTML checkbox to represent this flag, and unchecked HTML checkboxes
-  # do not get sent in HTML requests.
-  $::FORM{'isobsolete'} = $::FORM{'isobsolete'} ? 1 : 0;
-}
-
-sub validateStatuses
-{
-  # Get a list of attachment statuses that are valid for this attachment.
-  PushGlobalSQLState();
-  SendSQL("SELECT  attachstatusdefs.id
-           FROM    attachments, bugs, attachstatusdefs
-           WHERE   attachments.attach_id = $::FORM{'id'}
-           AND     attachments.bug_id = bugs.bug_id
-           AND     attachstatusdefs.product = bugs.product");
-  my @statusdefs;
-  push(@statusdefs, FetchSQLData()) while MoreSQLData();
-  PopGlobalSQLState();
-  
-  foreach my $status (@{$::MFORM{'status'}})
-  {
-    grep($_ == $status, @statusdefs)
-      || DisplayError("One of the statuses you entered is not a valid status
-                       for this attachment.")
-        && exit;
-    # We have tested that the status is valid, so it can be detainted
-    detaint_natural($status);
-  }
-}
-
-sub validateData
-{
-  $::FORM{'data'}
-    || DisplayError("The file you are trying to attach is empty!")
-      && exit;
-
-  my $len = length($::FORM{'data'});
-
-  my $maxpatchsize = Param('maxpatchsize');
-  my $maxattachmentsize = Param('maxattachmentsize');
-  
-  # Makes sure the attachment does not exceed either the "maxpatchsize" or 
-  # the "maxattachmentsize" parameter.
-  if ( $::FORM{'ispatch'} && $maxpatchsize && $len > $maxpatchsize*1024 )
-  {
-    my $lenkb = sprintf("%.0f", $len/1024);
-    DisplayError("The file you are trying to attach is ${lenkb} kilobytes (KB) in size.  
-                  Patches cannot be more than ${maxpatchsize}KB in size.
-                  Try breaking your patch into several pieces.");
-    exit;
-  } elsif ( !$::FORM{'ispatch'} && $maxattachmentsize && $len > $maxattachmentsize*1024 ) {
-    my $lenkb = sprintf("%.0f", $len/1024);
-    DisplayError("The file you are trying to attach is ${lenkb} kilobytes (KB) in size.  
-                  Non-patch attachments cannot be more than ${maxattachmentsize}KB.
-                  If your attachment is an image, try converting it to a compressable
-                  format like JPG or PNG, or put it elsewhere on the web and
-                  link to it from the bug's URL field or in a comment on the bug.");
-    exit;
-  }
-}
-
-sub validateFilename
-{
-  defined $::FILE{'data'}
-    || DisplayError("You did not specify a file to attach.")
-      && exit;
-}
-
-sub validateObsolete
-{
-  # Make sure the attachment id is valid and the user has permissions to view
-  # the bug to which it is attached.
-  foreach my $attachid (@{$::MFORM{'obsolete'}}) {
-    detaint_natural($attachid)
-      || DisplayError("The attachment number of one of the attachments 
-           you wanted to obsolete is invalid.") 
-        && exit;
-  
-    SendSQL("SELECT bug_id, isobsolete, description 
-             FROM attachments WHERE attach_id = $attachid");
-
-    # Make sure the attachment exists in the database.
-    MoreSQLData()
-      || DisplayError("Attachment #$attachid does not exist.") 
-        && exit;
-
-    my ($bugid, $isobsolete, $description) = FetchSQLData();
-
-    if ($bugid != $::FORM{'bugid'})
-    {
-      $description = html_quote($description);
-      DisplayError("Attachment #$attachid ($description) is attached 
-        to bug #$bugid, but you tried to flag it as obsolete while
-        creating a new attachment to bug #$::FORM{'bugid'}.");
-      exit;
-    }
-
-    if ( $isobsolete )
-    {
-      $description = html_quote($description);
-      DisplayError("Attachment #$attachid ($description) is already obsolete.");
-      exit;
-    }
-
-    # Check that the user can modify this attachment
-    validateCanEdit($attachid);
-  }
-
-}
-
-################################################################################
-# Functions
-################################################################################
-
-sub view
-{
-  # Display an attachment.
-
-  # Retrieve the attachment content and its content type from the database.
-  SendSQL("SELECT mimetype, thedata FROM attachments WHERE attach_id = $::FORM{'id'}");
-  my ($contenttype, $thedata) = FetchSQLData();
-    
-  # Return the appropriate HTTP response headers.
-  print "Content-Type: $contenttype\n\n";
-
-  print $thedata;
-}
-
-
-sub viewall
-{
-  # Display all attachments for a given bug in a series of IFRAMEs within one HTML page.
-
-  # Retrieve the attachments from the database and write them into an array
-  # of hashes where each hash represents one attachment.
-  SendSQL("SELECT attach_id, creation_ts, mimetype, description, ispatch, isobsolete 
-           FROM attachments WHERE bug_id = $::FORM{'bugid'} ORDER BY attach_id");
-  my @attachments; # the attachments array
-  while (MoreSQLData())
-  {
-    my %a; # the attachment hash
-    ($a{'attachid'}, $a{'date'}, $a{'contenttype'}, 
-     $a{'description'}, $a{'ispatch'}, $a{'isobsolete'}) = FetchSQLData();
-
-    # Format the attachment's creation/modification date into something readable.
-    if ($a{'date'} =~ /^(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)$/) {
-        $a{'date'} = "$3/$4/$2&nbsp;$5:$6";
-    }
-
-    # Flag attachments as to whether or not they can be viewed (as opposed to
-    # being downloaded).  Currently I decide they are viewable if their MIME type 
-    # is either text/*, image/*, or application/vnd.mozilla.*.
-    # !!! Yuck, what an ugly hack.  Fix it!
-    $a{'isviewable'} = ( $a{'contenttype'} =~ /^(text|image|application\/vnd\.mozilla\.)/ );
-
-    # Retrieve a list of status flags that have been set on the attachment.
-    PushGlobalSQLState();
-    SendSQL("SELECT    name 
-             FROM      attachstatuses, attachstatusdefs 
-             WHERE     attach_id = $a{'attachid'} 
-             AND       attachstatuses.statusid = attachstatusdefs.id
-             ORDER BY  sortkey");
-    my @statuses;
-    push(@statuses, FetchSQLData()) while MoreSQLData();
-    $a{'statuses'} = \@statuses;
-    PopGlobalSQLState();
-
-    # Add the hash representing the attachment to the array of attachments.
-    push @attachments, \%a;
-  }
-
-  # Retrieve the bug summary for displaying on screen.
-  SendSQL("SELECT short_desc FROM bugs WHERE bug_id = $::FORM{'bugid'}");
-  my ($bugsummary) = FetchSQLData();
-
-  # Define the variables and functions that will be passed to the UI template.
-  $vars->{'bugid'} = $::FORM{'bugid'};
-  $vars->{'bugsummary'} = $bugsummary;
-  $vars->{'attachments'} = \@attachments;
-
-  # Return the appropriate HTTP response headers.
-  print "Content-Type: text/html\n\n";
-
-  # Generate and return the UI (HTML page) from the appropriate template.
-  $template->process("attachment/show-multiple.html.tmpl", $vars)
-    || ThrowTemplateError($template->error());
-}
-
-
-sub enter
-{
-  # Display a form for entering a new attachment.
-
-  # Retrieve the attachments the user can edit from the database and write
-  # them into an array of hashes where each hash represents one attachment.
-  my $canEdit = "";
-  if (!UserInGroup($userid, "editbugs")) {
-      $canEdit = "AND submitter_id = $userid";
-  }
-  SendSQL("SELECT attach_id, description 
-           FROM attachments
-           WHERE bug_id = $::FORM{'bugid'}
-           AND isobsolete = 0 $canEdit
-           ORDER BY attach_id");
-  my @attachments; # the attachments array
-  while ( MoreSQLData() ) {
-    my %a; # the attachment hash
-    ($a{'id'}, $a{'description'}) = FetchSQLData();
-
-    # Add the hash representing the attachment to the array of attachments.
-    push @attachments, \%a;
-  }
-
-  # Retrieve the bug summary for displaying on screen.
-  SendSQL("SELECT short_desc FROM bugs WHERE bug_id = $::FORM{'bugid'}");
-  my ($bugsummary) = FetchSQLData();
-
-  # Define the variables and functions that will be passed to the UI template.
-  $vars->{'bugid'} = $::FORM{'bugid'};
-  $vars->{'bugsummary'} = $bugsummary;
-  $vars->{'attachments'} = \@attachments;
-
-  # Return the appropriate HTTP response headers.
-  print "Content-Type: text/html\n\n";
-
-  # Generate and return the UI (HTML page) from the appropriate template.
-  $template->process("attachment/create.html.tmpl", $vars)
-    || ThrowTemplateError($template->error());
-}
-
-
-sub insert
-{
-  # Insert a new attachment into the database.
-
-  # Escape characters in strings that will be used in SQL statements.
-  my $filename = SqlQuote($::FILE{'data'}->{'filename'});
-  my $description = SqlQuote($::FORM{'description'});
-  my $contenttype = SqlQuote($::FORM{'contenttype'});
-  my $thedata = SqlQuote($::FORM{'data'});
-
-  # Insert the attachment into the database.
-  SendSQL("INSERT INTO attachments (bug_id, filename, description, mimetype, ispatch, submitter_id, thedata) 
-           VALUES ($::FORM{'bugid'}, $filename, $description, $contenttype, $::FORM{'ispatch'}, $userid, $thedata)");
-
-  # Retrieve the ID of the newly created attachment record.
-  SendSQL("SELECT LAST_INSERT_ID()");
-  my $attachid = FetchOneColumn();
-
-  # Insert a comment about the new attachment into the database.
-  my $comment = "Created an attachment (id=$attachid)\n$::FORM{'description'}\n";
-  $comment .= ("\n" . $::FORM{'comment'}) if $::FORM{'comment'};
-
-  use Text::Wrap;
-  $Text::Wrap::columns = 80;
-  $Text::Wrap::huge = 'overflow';
-  $comment = Text::Wrap::wrap('', '', $comment);
-
-  AppendComment($::FORM{'bugid'}, 
-                $::COOKIE{"Bugzilla_login"},
-                $comment);
-
-  # Make existing attachments obsolete.
-  my $fieldid = GetFieldID('attachments.isobsolete');
-  foreach my $attachid (@{$::MFORM{'obsolete'}}) {
-    SendSQL("UPDATE attachments SET isobsolete = 1 WHERE attach_id = $attachid");
-    SendSQL("INSERT INTO bugs_activity (bug_id, attach_id, who, bug_when, fieldid, removed, added) 
-             VALUES ($::FORM{'bugid'}, $attachid, $userid, NOW(), $fieldid, '0', '1')");
-  }
-
-  # Send mail to let people know the attachment has been created.  Uses a 
-  # special syntax of the "open" and "exec" commands to capture the output of 
-  # "processmail", which "system" doesn't allow, without running the command 
-  # through a shell, which backticks (``) do.
-  #system ("./processmail", $bugid , $userid);
-  #my $mailresults = `./processmail $bugid $::userid`;
-  my $mailresults = '';
-  open(PMAIL, "-|") or exec('./processmail', $::FORM{'bugid'}, $::COOKIE{'Bugzilla_login'});
-  $mailresults .= $_ while <PMAIL>;
-  close(PMAIL);
- 
-  # Define the variables and functions that will be passed to the UI template.
-  $vars->{'bugid'} = $::FORM{'bugid'};
-  $vars->{'attachid'} = $attachid;
-  $vars->{'description'} = $description;
-  $vars->{'mailresults'} = $mailresults;
-  $vars->{'contenttypemethod'} = $::FORM{'contenttypemethod'};
-  $vars->{'contenttype'} = $::FORM{'contenttype'};
-
-  # Return the appropriate HTTP response headers.
-  print "Content-Type: text/html\n\n";
-
-  # Generate and return the UI (HTML page) from the appropriate template.
-  $template->process("attachment/created.html.tmpl", $vars)
-    || ThrowTemplateError($template->error());
-}
-
-
-sub edit
-{
-  # Edit an attachment record.  Users with "editbugs" privileges, (or the 
-  # original attachment's submitter) can edit the attachment's description,
-  # content type, ispatch and isobsolete flags, and statuses, and they can
-  # also submit a comment that appears in the bug.
-  # Users cannot edit the content of the attachment itself.
-
-  # Retrieve the attachment from the database.
-  SendSQL("SELECT description, mimetype, bug_id, ispatch, isobsolete 
-           FROM attachments WHERE attach_id = $::FORM{'id'}");
-  my ($description, $contenttype, $bugid, $ispatch, $isobsolete) = FetchSQLData();
-
-  # Flag attachment as to whether or not it can be viewed (as opposed to
-  # being downloaded).  Currently I decide it is viewable if its content
-  # type is either text/.* or application/vnd.mozilla.*.
-  # !!! Yuck, what an ugly hack.  Fix it!
-  my $isviewable = ( $contenttype =~ /^(text|image|application\/vnd\.mozilla\.)/ );
-
-  # Retrieve a list of status flags that have been set on the attachment.
-  my %statuses;
-  SendSQL("SELECT  id, name 
-           FROM    attachstatuses JOIN attachstatusdefs 
-           WHERE   attachstatuses.statusid = attachstatusdefs.id 
-           AND     attach_id = $::FORM{'id'}");
-  while ( my ($id, $name) = FetchSQLData() )
-  {
-    $statuses{$id} = $name;
-  }
-
-  # Retrieve a list of statuses for this bug's product, and build an array 
-  # of hashes in which each hash is a status flag record.
-  # ???: Move this into versioncache or its own routine?
-  my @statusdefs;
-  SendSQL("SELECT   id, name 
-           FROM     attachstatusdefs, bugs 
-           WHERE    bug_id = $bugid 
-           AND      attachstatusdefs.product = bugs.product 
-           ORDER BY sortkey");
-  while ( MoreSQLData() )
-  {
-    my ($id, $name) = FetchSQLData();
-    push @statusdefs, { 'id' => $id , 'name' => $name };
-  }
-
-  # Retrieve a list of attachments for this bug as well as a summary of the bug
-  # to use in a navigation bar across the top of the screen.
-  SendSQL("SELECT attach_id FROM attachments WHERE bug_id = $bugid ORDER BY attach_id");
-  my @bugattachments;
-  push(@bugattachments, FetchSQLData()) while (MoreSQLData());
-  SendSQL("SELECT short_desc FROM bugs WHERE bug_id = $bugid");
-  my ($bugsummary) = FetchSQLData();
-
-  # Define the variables and functions that will be passed to the UI template.
-  $vars->{'attachid'} = $::FORM{'id'}; 
-  $vars->{'description'} = $description; 
-  $vars->{'contenttype'} = $contenttype; 
-  $vars->{'bugid'} = $bugid; 
-  $vars->{'bugsummary'} = $bugsummary; 
-  $vars->{'ispatch'} = $ispatch; 
-  $vars->{'isobsolete'} = $isobsolete; 
-  $vars->{'isviewable'} = $isviewable; 
-  $vars->{'statuses'} = \%statuses; 
-  $vars->{'statusdefs'} = \@statusdefs; 
-  $vars->{'attachments'} = \@bugattachments; 
-
-  # Return the appropriate HTTP response headers.
-  print "Content-Type: text/html\n\n";
-
-  # Generate and return the UI (HTML page) from the appropriate template.
-  $template->process("attachment/edit.html.tmpl", $vars)
-    || ThrowTemplateError($template->error());
-}
-
-
-sub update
-{
-  # Update an attachment record.
-
-  # Get the bug ID for the bug to which this attachment is attached.
-  SendSQL("SELECT bug_id FROM attachments WHERE attach_id = $::FORM{'id'}");
-  my $bugid = FetchSQLData() 
-    || DisplayError("Cannot figure out bug number.")
-    && exit;
-
-  # Lock database tables in preparation for updating the attachment.
-  SendSQL("LOCK TABLES attachments WRITE , attachstatuses WRITE , 
-           attachstatusdefs READ , fielddefs READ , bugs_activity WRITE");
-
-  # Get a copy of the attachment record before we make changes
-  # so we can record those changes in the activity table.
-  SendSQL("SELECT description, mimetype, ispatch, isobsolete 
-           FROM attachments WHERE attach_id = $::FORM{'id'}");
-  my ($olddescription, $oldcontenttype, $oldispatch, $oldisobsolete) = FetchSQLData();
-
-  # Get the list of old status flags.
-  SendSQL("SELECT    attachstatusdefs.name 
-           FROM      attachments, attachstatuses, attachstatusdefs
-           WHERE     attachments.attach_id = $::FORM{'id'}
-           AND       attachments.attach_id = attachstatuses.attach_id
-           AND       attachstatuses.statusid = attachstatusdefs.id
-           ORDER BY  attachstatusdefs.sortkey
-          ");
-  my @oldstatuses;
-  while (MoreSQLData()) {
-    push(@oldstatuses, FetchSQLData());
-  }
-  my $oldstatuslist = join(', ', @oldstatuses);
-
-  # Update the database with the new status flags.
-  SendSQL("DELETE FROM attachstatuses WHERE attach_id = $::FORM{'id'}");
-  foreach my $statusid (@{$::MFORM{'status'}}) 
-  {
-    SendSQL("INSERT INTO attachstatuses (attach_id, statusid) VALUES ($::FORM{'id'}, $statusid)");
-  }
-
-  # Get the list of new status flags.
-  SendSQL("SELECT    attachstatusdefs.name 
-           FROM      attachments, attachstatuses, attachstatusdefs
-           WHERE     attachments.attach_id = $::FORM{'id'}
-           AND       attachments.attach_id = attachstatuses.attach_id
-           AND       attachstatuses.statusid = attachstatusdefs.id
-           ORDER BY  attachstatusdefs.sortkey
-          ");
-  my @newstatuses;
-  while (MoreSQLData()) {
-    push(@newstatuses, FetchSQLData());
-  }
-  my $newstatuslist = join(', ', @newstatuses);
-
-  # Quote the description and content type for use in the SQL UPDATE statement.
-  my $quoteddescription = SqlQuote($::FORM{'description'});
-  my $quotedcontenttype = SqlQuote($::FORM{'contenttype'});
-
-  # Update the attachment record in the database.
-  # Sets the creation timestamp to itself to avoid it being updated automatically.
-  SendSQL("UPDATE  attachments 
-           SET     description = $quoteddescription , 
-                   mimetype = $quotedcontenttype , 
-                   ispatch = $::FORM{'ispatch'} , 
-                   isobsolete = $::FORM{'isobsolete'} , 
-                   creation_ts = creation_ts
-           WHERE   attach_id = $::FORM{'id'}
-         ");
-
-  # Record changes in the activity table.
-  if ($olddescription ne $::FORM{'description'}) {
-    my $quotedolddescription = SqlQuote($olddescription);
-    my $fieldid = GetFieldID('attachments.description');
-    SendSQL("INSERT INTO bugs_activity (bug_id, attach_id, who, bug_when, fieldid, removed, added) 
-             VALUES ($bugid, $::FORM{'id'}, $userid, NOW(), $fieldid, $quotedolddescription, $quoteddescription)");
-  }
-  if ($oldcontenttype ne $::FORM{'contenttype'}) {
-    my $quotedoldcontenttype = SqlQuote($oldcontenttype);
-    my $fieldid = GetFieldID('attachments.mimetype');
-    SendSQL("INSERT INTO bugs_activity (bug_id, attach_id, who, bug_when, fieldid, removed, added) 
-             VALUES ($bugid, $::FORM{'id'}, $userid, NOW(), $fieldid, $quotedoldcontenttype, $quotedcontenttype)");
-  }
-  if ($oldispatch ne $::FORM{'ispatch'}) {
-    my $fieldid = GetFieldID('attachments.ispatch');
-    SendSQL("INSERT INTO bugs_activity (bug_id, attach_id, who, bug_when, fieldid, removed, added) 
-             VALUES ($bugid, $::FORM{'id'}, $userid, NOW(), $fieldid, $oldispatch, $::FORM{'ispatch'})");
-  }
-  if ($oldisobsolete ne $::FORM{'isobsolete'}) {
-    my $fieldid = GetFieldID('attachments.isobsolete');
-    SendSQL("INSERT INTO bugs_activity (bug_id, attach_id, who, bug_when, fieldid, removed, added) 
-             VALUES ($bugid, $::FORM{'id'}, $userid, NOW(), $fieldid, $oldisobsolete, $::FORM{'isobsolete'})");
-  }
-  if ($oldstatuslist ne $newstatuslist) {
-    my ($removed, $added) = DiffStrings($oldstatuslist, $newstatuslist);
-    my $quotedremoved = SqlQuote($removed);
-    my $quotedadded = SqlQuote($added);
-    my $fieldid = GetFieldID('attachstatusdefs.name');
-    SendSQL("INSERT INTO bugs_activity (bug_id, attach_id, who, bug_when, fieldid, removed, added) 
-             VALUES ($bugid, $::FORM{'id'}, $userid, NOW(), $fieldid, $quotedremoved, $quotedadded)");
-  }
-
-  # Unlock all database tables now that we are finished updating the database.
-  SendSQL("UNLOCK TABLES");
-
-  # If this installation has enabled the request manager, let the manager know
-  # an attachment was updated so it can check for requests on that attachment
-  # and fulfill them.  The request manager allows users to request database
-  # changes of other users and tracks the fulfillment of those requests.  When
-  # an attachment record is updated and the request manager is called, it will
-  # fulfill those requests that were requested of the user performing the update
-  # which are requests for the attachment being updated.
-  #my $requests;
-  #if (Param('userequestmanager'))
-  #{
-  #  use Request;
-  #  # Specify the fieldnames that have been updated.
-  #  my @fieldnames = ('description', 'mimetype', 'status', 'ispatch', 'isobsolete');
-  #  # Fulfill pending requests.
-  #  $requests = Request::fulfillRequest('attachment', $::FORM{'id'}, @fieldnames);
-  #  $vars->{'requests'} = $requests; 
-  #}
-
-  # If the user submitted a comment while editing the attachment, 
-  # add the comment to the bug.
-  if ( $::FORM{'comment'} )
-  {
-    use Text::Wrap;
-    $Text::Wrap::columns = 80;
-    $Text::Wrap::huge = 'wrap';
-
-    # Append a string to the comment to let users know that the comment came from
-    # the "edit attachment" screen.
-    my $comment = qq|(From update of attachment $::FORM{'id'})\n| . $::FORM{'comment'};
-
-    my $wrappedcomment = "";
-    foreach my $line (split(/\r\n|\r|\n/, $comment))
-    {
-      if ( $line =~ /^>/ )
-      {
-        $wrappedcomment .= $line . "\n";
-      }
-      else
-      {
-        $wrappedcomment .= wrap('', '', $line) . "\n";
-      }
-    }
-
-    # Get the user's login name since the AppendComment function needs it.
-    my $who = DBID_to_name($userid);
-
-    # Append the comment to the list of comments in the database.
-    AppendComment($bugid, $who, $wrappedcomment);
-
-  }
-
-  # Send mail to let people know the bug has changed.  Uses a special syntax
-  # of the "open" and "exec" commands to capture the output of "processmail",
-  # which "system" doesn't allow, without running the command through a shell,
-  # which backticks (``) do.
-  #system ("./processmail", $bugid , $userid);
-  #my $mailresults = `./processmail $bugid $userid`;
-  my $mailresults = '';
-  open(PMAIL, "-|") or exec('./processmail', $bugid, DBID_to_name($userid));
-  $mailresults .= $_ while <PMAIL>;
-  close(PMAIL);
- 
-  # Define the variables and functions that will be passed to the UI template.
-  $vars->{'attachid'} = $::FORM{'id'}; 
-  $vars->{'bugid'} = $bugid; 
-  $vars->{'mailresults'} = $mailresults; 
-
-  # Return the appropriate HTTP response headers.
-  print "Content-Type: text/html\n\n";
-
-  # Generate and return the UI (HTML page) from the appropriate template.
-  $template->process("attachment/updated.html.tmpl", $vars)
-    || ThrowTemplateError($template->error());
-}

mozilla/webtools/bugzilla/bug_form.pl

@@ -1,329 +0,0 @@
-# -*- Mode: perl; indent-tabs-mode: nil -*-
-#
-# 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>
-#                 Dave Miller <justdave@syndicomm.com>
-
-use diagnostics;
-use strict;
-
-use RelationSet;
-
-# Use the Attachment module to display attachments for the bug.
-use Attachment;
-
-sub show_bug {    
-    # Shut up misguided -w warnings about "used only once".  For some reason,
-    # "use vars" chokes on me when I try it here.
-    sub bug_form_pl_sillyness {
-        my $zz;
-        $zz = %::FORM;
-        $zz = %::proddesc;
-        $zz = %::prodmaxvotes;
-        $zz = @::enterable_products;                                            
-        $zz = @::settable_resolution;
-        $zz = $::unconfirmedstate;
-        $zz = $::milestoneurl;
-        $zz = $::template;
-        $zz = $::vars;
-        $zz = @::legal_priority;
-        $zz = @::legal_platform;
-        $zz = @::legal_severity;
-        $zz = @::legal_bug_status;
-        $zz = @::target_milestone;
-        $zz = @::components;
-        $zz = @::legal_keywords;
-        $zz = @::versions;
-        $zz = @::legal_opsys;
-    }
-
-    # Use templates
-    my $template = $::template;
-    my $vars = $::vars;
-    
-    $vars->{'GetBugLink'} = \&GetBugLink;
-    $vars->{'quoteUrls'} = \&quoteUrls,
-    $vars->{'lsearch'} = \&lsearch,
-    $vars->{'header_done'} = (@_),
-
-    my $userid = quietly_check_login();
-
-    my $id = $::FORM{'id'};
-    
-    if (!defined($id)) {
-      $template->process("bug/choose.html.tmpl", $vars)
-        || ThrowTemplateError($template->error());
-      exit;
-    }
-    
-    my %user = %{$vars->{'user'}};
-    my %bug;
-
-    # Populate the bug hash with the info we get directly from the DB.
-    my $query = "
-    SELECT bugs.bug_id, product, version, rep_platform, 
-        op_sys, bug_status, resolution, priority, 
-        bug_severity, component, assigned_to, reporter, 
-        bug_file_loc, short_desc, target_milestone, 
-        qa_contact, status_whiteboard, 
-        date_format(creation_ts,'%Y-%m-%d %H:%i'),
-        delta_ts, sum(votes.count)
-    FROM bugs LEFT JOIN votes USING(bug_id)
-    WHERE bugs.bug_id = $id
-    GROUP BY bugs.bug_id";
-
-    SendSQL($query);
-
-    my $value;
-    my @row = FetchSQLData();
-    foreach my $field ("bug_id", "product", "version", "rep_platform",
-                       "op_sys", "bug_status", "resolution", "priority",
-                       "bug_severity", "component", "assigned_to", "reporter",
-                       "bug_file_loc", "short_desc", "target_milestone",
-                       "qa_contact", "status_whiteboard", "creation_ts",
-                       "delta_ts", "votes") 
-    {
-        $value = shift(@row);
-        $bug{$field} = defined($value) ? $value : "";
-    }
-
-    # General arrays of info about the database state
-    GetVersionTable();
-
-    # Fiddle the product list.
-    my $seen_curr_prod;
-    my @prodlist;
-    
-    foreach my $product (@::enterable_products) {
-        if ($product eq $bug{'product'}) {
-            # if it's the product the bug is already in, it's ALWAYS in
-            # the popup, period, whether the user can see it or not, and
-            # regardless of the disallownew setting.
-            $seen_curr_prod = 1;
-            push(@prodlist, $product);
-            next;
-        }
-
-        if (Param("usebuggroupsentry")
-          && GroupExists($product)
-          && !UserInGroup($userid, $product))
-        {
-            # If we're using bug groups to restrict entry on products, and
-            # this product has a bug group, and the user is not in that
-            # group, we don't want to include that product in this list.
-            next;
-        }
-
-        push(@prodlist, $product);
-    }
-
-    # The current product is part of the popup, even if new bugs are no longer
-    # allowed for that product
-    if (!$seen_curr_prod) {
-        push (@prodlist, $bug{'product'});
-        @prodlist = sort @prodlist;
-    }
-
-    $vars->{'product'} = \@prodlist;
-    $vars->{'rep_platform'} = \@::legal_platform;
-    $vars->{'priority'} = \@::legal_priority;
-    $vars->{'bug_severity'} = \@::legal_severity;
-    $vars->{'op_sys'} = \@::legal_opsys;
-    $vars->{'bug_status'} = \@::legal_bug_status;
-
-    # Hack - this array contains "" for some reason. See bug 106589.
-    shift @::settable_resolution; 
-    $vars->{'resolution'} = \@::settable_resolution;
-
-    $vars->{'component_'} = $::components{$bug{'product'}};
-    $vars->{'version'} = $::versions{$bug{'product'}};
-    $vars->{'target_milestone'} = $::target_milestone{$bug{'product'}};
-    $bug{'milestoneurl'} = $::milestoneurl{$bug{'product'}} || 
-                           "notargetmilestone.html";
-
-    $vars->{'use_votes'} = $::prodmaxvotes{$bug{'product'}};
-
-    # Add additional, calculated fields to the bug hash
-    if (@::legal_keywords) {
-        $vars->{'use_keywords'} = 1;
-
-        SendSQL("SELECT keyworddefs.name 
-                 FROM keyworddefs, keywords
-                 WHERE keywords.bug_id = $id 
-                 AND keyworddefs.id = keywords.keywordid
-                 ORDER BY keyworddefs.name");
-        my @keywords;
-        while (MoreSQLData()) {
-            push(@keywords, FetchOneColumn());
-        }
-
-        $bug{'keywords'} = \@keywords;
-    }    
-
-    # Attachments
-    $bug{'attachments'} = Attachment::query($id);
-
-    # Dependencies
-    my @list;
-    SendSQL("SELECT dependson FROM dependencies WHERE  
-             blocked = $id ORDER BY dependson");
-    while (MoreSQLData()) {
-        my ($i) = FetchSQLData();
-        push(@list, $i);
-    }
-
-    $bug{'dependson'} = \@list;
-
-    my @list2;
-    SendSQL("SELECT blocked FROM dependencies WHERE  
-             dependson = $id ORDER BY blocked");
-    while (MoreSQLData()) {
-        my ($i) = FetchSQLData();
-        push(@list2, $i);
-    }
-
-    $bug{'blocked'} = \@list2;
-
-    # Groups
-    my @groups;
-    my (%buggroups, %usergroups);
-
-    # Find out if this bug is private to any group
-    SendSQL("SELECT group_id FROM bug_group_map WHERE bug_id = $id");
-    while (my $group_id = FetchOneColumn()) {
-        $buggroups{$group_id} = 1;
-    }
-
-    # Get a list of active groups the user is in, subject to the above conditions
-    if ($userid) {
-        # NB - the number of groups is likely to be small - should we just select
-        # everything, and weed manually? OTOH, the number of products is likely
-        # to be small, too. This buggroup stuff needs to be rethought
-        SendSQL("SELECT groups.group_id, groups.isactive " .
-                "FROM user_group_map, " .
-                "groups LEFT JOIN products ON groups.name = products.product " .
-                "WHERE groups.group_id = user_group_map.group_id AND " .
-                "user_group_map.user_id = $userid AND groups.isbuggroup != 0 AND " .
-                "(groups.name = " . SqlQuote($bug{'product'}) . " OR " .
-                "products.product IS NULL)");
-        while (my $group_id = FetchOneColumn()) {
-            $usergroups{$group_id} = 1;
-        }
-
-        # Now get information about each group
-        SendSQL("SELECT group_id, name, description " .
-                "FROM groups " .
-                # "WHERE group_id IN (" . join(',', @groups) . ") " .
-                "ORDER BY description");
-        while (MoreSQLData()) {
-            my ($group_id, $name, $description) = FetchSQLData();
-            my ($ison, $ingroup);
-    
-            if ($buggroups{$group_id} || 
-                ($usergroups{$group_id} && (($name eq $bug{'product'}) || 
-                                (!defined $::proddesc{$name})))) 
-            {
-                $user{'inallgroups'} &= $ingroup;
-
-                push (@groups, { "bit" => $group_id,
-                                 "ison" => $buggroups{$group_id},
-                                 "ingroup" => $usergroups{$group_id},
-                                 "description" => $description });
-            }
-        }
-
-        # If the bug is restricted to a group, display checkboxes that allow
-        # the user to set whether or not the reporter 
-        # and cc list can see the bug even if they are not members of all 
-        # groups to which the bug is restricted.
-        if (%buggroups) {
-            $bug{'inagroup'} = 1;
-
-            # Determine whether or not the bug is always accessible by the
-            # reporter, QA contact, and/or users on the cc: list.
-            SendSQL("SELECT reporter_accessible, cclist_accessible
-                     FROM   bugs
-                     WHERE  bug_id = $id
-                    ");
-            ($bug{'reporter_accessible'}, 
-             $bug{'cclist_accessible'}) = FetchSQLData();        
-        }
-    }
-    $vars->{'groups'} = \@groups;
-
-    my $movers = Param("movers");
-    $user{'canmove'} = Param("move-enabled") 
-                       && (defined $::COOKIE{"Bugzilla_login"}) 
-                       && ($::COOKIE{"Bugzilla_login"} =~ /\Q$movers\E/);
-
-    # User permissions
-
-    # In the below, if the person hasn't logged in ($userid == 0), then
-    # we treat them as if they can do anything.  That's because we don't
-    # know why they haven't logged in; it may just be because they don't
-    # use cookies.  Display everything as if they have all the permissions
-    # in the world; their permissions will get checked when they log in
-    # and actually try to make the change.
-    $user{'canedit'} = $userid == 0
-                       || $userid == $bug{'reporter'}
-                       || $userid == $bug{'qa_contact'}
-                       || $userid == $bug{'assigned_to'}
-                       || UserInGroup("editbugs");                   
-    $user{'canconfirm'} = ($userid == 0) || UserInGroup($userid, "canconfirm");
-
-    # Bug states
-    $bug{'isunconfirmed'} = ($bug{'bug_status'} eq $::unconfirmedstate);
-    $bug{'isopened'} = IsOpenedState($bug{'bug_status'});
-
-    # People involved with the bug
-    $bug{'assigned_to_email'} = DBID_to_name($bug{'assigned_to'});
-    $bug{'assigned_to'} = DBID_to_real_or_loginname($bug{'assigned_to'});
-    $bug{'reporter'} = DBID_to_real_or_loginname($bug{'reporter'});
-    $bug{'qa_contact'} = $bug{'qa_contact'} > 0 ? 
-                                          DBID_to_name($bug{'qa_contact'}) : "";
-
-    my $ccset = new RelationSet;
-    $ccset->mergeFromDB("SELECT who FROM cc WHERE bug_id=$id");
-    
-    my @cc = $ccset->toArrayOfStrings();
-    $bug{'cc'} = \@cc if $cc[0];
-
-    # Next bug in list (if there is one)
-    my @bug_list;
-    if ($::COOKIE{"BUGLIST"} && $id) 
-    {
-        @bug_list = split(/:/, $::COOKIE{"BUGLIST"});
-    }
-    $vars->{'bug_list'} = \@bug_list;
-
-    $bug{'comments'} = GetComments($bug{'bug_id'});
-
-    # This is length in number of comments
-    $bug{'longdesclength'} = scalar(@{$bug{'comments'}});
-
-    # Add the bug and user hashes to the variables
-    $vars->{'bug'} = \%bug;
-    $vars->{'user'} = \%user;
-
-    # Generate and return the UI (HTML page) from the appropriate template.
-    $template->process("bug/edit.html.tmpl", $vars)
-      || ThrowTemplateError($template->error());
-}
- 
-1;

mozilla/webtools/bugzilla/bug_status.html

@@ -1,206 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<HTML>
-
-<!--
-     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): 
-
-     Contributor(s): Terry Weissman <terry@mozilla.org>
--->
-
-<head>
-<TITLE>A Bug's Life Cycle</TITLE>
-<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-</head>
-<body>
-
-<h1 ALIGN=CENTER>A Bug's Life Cycle</h1>
-
-The <B>status</B> and <B>resolution</B> field define and track the
-life cycle of a bug.
-
-<a name="status"></a>
-<p>
-<TABLE BORDER=1 CELLPADDING=4>
-
-<TR ALIGN=CENTER VALIGN=TOP>
-<TD WIDTH="50%"><H1>STATUS</H1> <TD><H1>RESOLUTION</H1>
-
-<TR VALIGN=TOP>
-<TD>The <B>status</B> field indicates the general health of a bug. Only
-certain status transitions are allowed.
-<TD>The <b>resolution</b> field indicates what happened to this bug.
-
-<TR VALIGN=TOP><TD>
-<DL><DT><B>
-<A HREF="confirmhelp.html">UNCONFIRMED</A></B> 
-<DD> This bug has recently been added to the database.  Nobody has
-     validated that this bug is true.  Users who have the "canconfirm"
-     permission set may confirm this bug, changing its state to NEW.
-     Or, it may be directly resolved and marked RESOLVED.
-<DT><B>NEW</B> 
-<DD> This bug has recently been added to the assignee's list of bugs
-     and must be processed. Bugs in this state may be accepted, and
-     become <B>ASSIGNED</B>, passed on to someone else, and remain
-     <B>NEW</B>, or resolved and marked <B>RESOLVED</B>.
-<DT><B>ASSIGNED</B> 
-<DD> This bug is not yet resolved, but is assigned to the proper
-     person. From here bugs can be given to another person and become
-     <B>NEW</B>, or resolved and become <B>RESOLVED</B>.
-<DT><B>REOPENED</B>
-<DD>This bug was once resolved, but the resolution was deemed
-     incorrect.  For example, a <B>WORKSFORME</B> bug is
-     <B>REOPENED</B> when more information shows up and the bug is now
-     reproducible.  From here bugs are either marked <B>ASSIGNED</B>
-     or <B>RESOLVED</B>.
-</DL>
-<TD>
-<DL>
-<DD> No resolution yet. All bugs which are in one of these "open" states
-     have the resolution set to blank. All other bugs
-     will be marked with one of the following resolutions.
-</DL>
-
-<TR VALIGN=TOP><TD>
-<DL>
-<DT><B>RESOLVED</B> 
-<DD> A resolution has been taken, and it is awaiting verification by
-     QA. From here bugs are either re-opened and become
-     <B>REOPENED</B>, are marked <B>VERIFIED</B>, or are closed for good
-     and marked <B>CLOSED</B>.
-<DT><B>VERIFIED</B>
-<DD> QA has looked at the bug and the resolution and agrees that the
-     appropriate resolution has been taken.  Bugs remain in this state
-     until the product they were reported against actually ships, at
-     which point they become <B>CLOSED</B>.
-<DT><B>CLOSED</B> 
-<DD> The bug is considered dead, the resolution is correct. Any zombie
-     bugs who choose to walk the earth again must do so by becoming
-     <B>REOPENED</B>.
-</DL>
-
-<TD>
-<DL>
-<DT><B>FIXED</B>
-<DD> A fix for this bug is checked into the tree and tested.
-<DT><B>INVALID</B>
-<DD> The problem described is not a bug 
-<DT><B>WONTFIX</B>
-<DD> The problem described is a bug which will never be fixed.
-<DT><B>LATER</B>
-<DD> The problem described is a bug which will not be fixed in this
-     version of the product.
-<DT><B>REMIND</B>
-<DD> The problem described is a bug which will probably not be fixed in this
-     version of the product, but might still be.
-<DT><B>DUPLICATE</B>
-<DD> The problem is a duplicate of an existing bug. Marking a bug
-     duplicate requires the bug# of the duplicating bug and will at
-     least put that bug number in the description field.
-<DT><B>WORKSFORME</B>
-<DD> All attempts at reproducing this bug were futile, reading the
-     code produces no clues as to why this behavior would occur. If
-     more information appears later, please re-assign the bug, for
-     now, file it.
-</DL>
-</TABLE>
-
-<H1>Other Fields</H1>
-
-<table border=1 cellpadding=4><tr><td>
-<h2><a name="severity">Severity</a></h2>
-
-This field describes the impact of a bug.
-
-<p>
-<p>
- 
-<table>
-<tr><th>Blocker</th><td>Blocks development and/or testing work
-<tr><th>Critical</th><td>crashes, loss of data, severe memory leak 
-<tr><th>Major</th><td>major loss of function 
-<tr><th>Minor</th><td>minor loss of function, or other problem where easy workaround is present 
-<tr><th>Trivial</th><td>cosmetic problem like misspelled words or misaligned text 
-<tr><th>Enhancement</th><td>Request for enhancement
-</table> 
-
-</td><td>
-
-<h2><a name="priority">Priority</a></h2>
-
-This field describes the importance and order in which a bug should be
-fixed.  This field is utilized by the programmers/engineers to
-prioritize their work to be done.  The available priorities are:
-
-<p>
-<p>
-
-<table>
-<tr><th>P1</th><td>Most important
-<tr><th>P2</th><td>
-<tr><th>P3</th><td>
-<tr><th>P4</th><td>
-<tr><th>P5</th><td>Least important
-</table>
-</tr></table>
-
-<h2><a name="rep_platform">Platform</a></h2>
-This is the hardware platform against which the bug was reported.  Legal
-platforms include:
-
-<UL>
-<LI> All (happens on all platform; cross-platform bug)
-<LI> Macintosh
-<LI> PC
-<LI> Sun
-<LI> HP
-</UL>
-
-<b>Note:</b> Selecting the option "All" does not select bugs assigned against all platforms.  It
-merely selects bugs that <b>occur</b> on all platforms.
-
-<h2><a name="op_sys">Operating System</a></h2>
-This is the operating system against which the bug was reported.  Legal
-operating systems include:
-
-<UL>
-<LI> All (happens on all operating systems; cross-platform bug)
-<LI> Windows 95
-<LI> Mac System 8.0
-<LI> Linux
-</UL>
-
-Note that the operating system implies the platform, but not always.
-For example, Linux can run on PC and Macintosh and others.
-
-<h2><a name="assigned_to">Assigned To</a></h2>
-
-This is the person in charge of resolving the bug.  Every time this
-field changes, the status changes to <B>NEW</B> to make it easy to see
-which new bugs have appeared on a person's list.
-
-The default status for queries is set to NEW, ASSIGNED and REOPENED. When
-searching for bugs that have been resolved or verified, remember to set the
-status field appropriately. 
-
-<hr>
-<!-- hhmts start -->
-Last modified: Sun Apr 14 12:51:23 EST 2002
-<!-- hhmts end -->
-</body> </html>

mozilla/webtools/bugzilla/bugwritinghelp.html

@@ -1,392 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<html>
-<head>
-<meta http-equiv="content-type" content="text/html; charset=iso-8859-1">
-<title>Bug Writing Guidelines</title>
-</head>
-<body>
-<center>
-<h1>Bug Writing Guidelines</h1>
-</center>
-
-<h3>Why You Should Read This</h3>
-
-<blockquote>
-<p>Simply put, the more effectively you report a bug, the more
-likely an engineer will actually fix it.</p>
-
-<p>These guidelines are a general
-tutorial to teach novice and intermediate bug reporters how to compose effective bug reports. Not every sentence may precisely apply to
-your software project.</p>
-</blockquote>
-
-<h3>How to Write a Useful Bug Report</h3>
-
-<blockquote>
-<p>Useful bug reports are ones that get bugs fixed. A useful bug
-report normally has two qualities:</p>
-
-<ol>
-<li><b>Reproducible.</b> If an engineer can't see the bug herself to prove that it exists, she'll probably stamp your bug report "WORKSFORME" or "INVALID" and move on to the next bug. Every detail you can provide helps.<br>
-<br>
-</li>
-
-<li><b>Specific.</b> The quicker the engineer can isolate the bug
-to a specific area, the more likely she'll expediently fix it. 
-(If a programmer or tester has to decypher a bug, they may spend
-more time cursing the submitter than solving the problem.)
-<br>
-<br>
-[ <a href="#tips" name="Anchor">Tell Me More</a> ]
-</li>
-</ol>
-
-<p>Let's say the application you're testing is a web browser. You
-crash at foo.com, and want to write up a bug report:</p>
-
-<blockquote>
-<p><b>BAD:</b> "My browser crashed. I think I was on www.foo.com. I play golf with Bill Gates, so you better fix this problem, or I'll report you to him. By the way, your Back icon looks like a squashed rodent. UGGGLY. And my grandmother's home page is all messed up in your browser. Thx 4 UR help."
-</p>
-
-<p>
- <b>GOOD:</b> "I crashed each time I went to www.foo.com, using
-the 2002-02-25 build on a Windows 2000 system. I also
-rebooted into Linux, and reproduced this problem using the 2002-02-24
-Linux build.
-</p>
-
-<p>
- It again crashed each time upon drawing the Foo banner at the top
-of the page. I broke apart the page, and discovered that the
-following image link will crash the application reproducibly,
-unless you remove the "border=0" attribute:
-</p>
-
-<p>
- <tt>&lt;IMG SRC="http://www.foo.com/images/topics/topicfoos.gif"
-width="34" height="44" border="0" alt="News"&gt;</tt>
-</p>
-</blockquote>
-</blockquote>
-
-<h3>How to Enter your Useful Bug Report into Bugzilla:</h3>
-
-<blockquote>
-<p>Before you enter your bug, use Bugzilla's 
-<a href="query.cgi">search page</a> to determine whether the defect you've discovered is a known, already-reported bug. If your bug is the 37th duplicate of a known issue, you're more likely to annoy the engineer. (Annoyed
-engineers fix fewer bugs.)
-</p>
-
-<p>
-Next, be sure to reproduce your bug using a recent
-build. Engineers tend to be most interested in problems affecting
-the code base that they're actively working on. After all, the bug you're reporting
-may already be fixed.
-
-</p>
-
-<p>
- If you've discovered a new bug using a current build, report it in
-Bugzilla:
-</p>
-
-<ol>
-<li>From your Bugzilla main page, choose 
-"<a href="enter_bug.cgi">Enter a new bug</a>".</li>
-
-<li>Select the product that you've found a bug in.</li>
-
-<li>Enter your e-mail address, password, and press the "Login"
-button. (If you don't yet have a password, leave the password field empty, 
-and press the "E-mail me a password" button instead.
-You'll quickly receive an e-mail message with your password.)</li>
-</ol>
-
-<p>Now, fill out the form. Here's what it all means:</p>
-
-<p><b>Where did you find the bug?</b></p>
-
-<blockquote>
-<p><b>Product: In which product did you find the bug?</b><br>
- You just specified this on the last page, so you can't edit it here.</p>
-
-<p><b>Version: In which product version did you find the
-bug?</b><br>
- (If applicable)</p>
-
-<p><b>Component: In which component does the bug exist?</b><br>
-Bugzilla requires that you select a component to enter a bug. (Not sure which to choose? 
-Click on the Component link. You'll see a description of each component, to help you make the best choice.)</p>
-
-<p><b>OS: On which Operating System (OS) did you find this bug?</b>
-(e.g. Linux, Windows 2000, Mac OS 9.)<br>
- If you know the bug happens on all OSs, choose 'All'. Otherwise,
-select the OS that you found the bug on, or "Other" if your OS
-isn't listed.</p>
-</blockquote>
-
-<p><b>How important is the bug?</b></p>
-
-<blockquote>
-<p><b>Severity: How damaging is the bug?</b><br>
- This item defaults to 'normal'. If you're not sure what severity your bug deserves, click on the Severity link.
- You'll see a description of each severity rating. <br>
-</p>
-</blockquote>
-
-<p><b>Who will be following up on the bug?</b></p>
-
-<blockquote>
-<p><b>Assigned To: Which engineer should be responsible for fixing
-this bug?</b><br>
- Bugzilla will automatically assign the bug to a default engineer
-upon submitting a bug report. If you'd prefer to directly assign the bug to
-someone else, enter their e-mail address into this field. (To see the list of
-default engineers for each component, click on the Component
-link.)</p>
-
-<p><b>Cc: Who else should receive e-mail updates on changes to this
-bug?</b><br>
- List the full e-mail addresses of other individuals who should
-receive an e-mail update upon every change to the bug report. You
-can enter as many e-mail addresses as you'd like, separated by spaces or commas, as long as those
-people have Bugzilla accounts.</p>
-</blockquote>
-
-<p><b>What else can you tell the engineer about the bug?</b></p>
-
-<blockquote>
-
-<p><b>Summary:</b> <b>How would you describe the bug, in
-approximately 60 or fewer characters?</b><br>
- A good summary should <b>quickly and uniquely identify a bug
-report</b>. Otherwise, an engineer cannot meaningfully identify
-your bug by its summary, and will often fail to pay attention to
-your bug report when skimming through a 10 page bug list.<br>
-<br>
- A useful summary might be 
- "<tt>PCMCIA install fails on Tosh Tecra 780DVD w/ 3c589C</tt>". 
- "<tt>Software fails</tt>" or "<tt>install problem</tt>" would be
-examples of a bad summary.<br>
-<br>
- [ <a href="#summary">Tell Me More</a> ]<br>
-<br>
- <b>Description: </b><br>
- Please provide a detailed problem report in this field.
-Your bug's recipients will most likely expect the following information:</p>
-
-<blockquote>
-<p><b>Overview Description:</b> More detailed expansion of
-summary.</p>
-
-<blockquote>
-<pre>
-Drag-selecting any page crashes Mac builds in NSGetFactory
-</pre>
-</blockquote>
-
-<p><b>Steps to Reproduce:</b> Minimized, easy-to-follow steps that will
-trigger the bug. Include any special setup steps.</p>
-
-<blockquote>
-<pre>
-1) View any web page. (I used the default sample page,
-resource:/res/samples/test0.html)
-                          
-2) Drag-select the page. (Specifically, while holding down 
-the mouse button, drag the mouse pointer downwards from any 
-point in the browser's content region to the bottom of the 
-browser's content region.)                   
-</pre>
-</blockquote>
-
-<p>
- <b>Actual Results:</b> What the application did after performing
-the above steps. 
-</p>
-
-<blockquote>
-<pre>
-The application crashed. Stack crawl appended below from MacsBug.
-</pre>
-</blockquote>
-
-<p><b>Expected Results:</b> What the application should have done,
-were the bug not present.</p>
-
-<blockquote>
-<pre>
-The window should scroll downwards. Scrolled content should be selected. 
-(Or, at least, the application should not crash.)
-</pre>
-</blockquote>
-
-<p><b>Build Date &amp; Platform:</b> Date and platform of the build
-that you first encountered the bug in.</p>
-
-<blockquote>
-<pre>
-Build 2002-03-15 on Mac OS 9.0
-</pre>
-</blockquote>
-
-<p><b>Additional Builds and Platforms:</b> Whether or not the bug
-takes place on other platforms (or browsers, if applicable).</p>
-
-<blockquote>
-<pre>
-- Also Occurs On        
-    Mozilla (2002-03-15 build on Windows NT 4.0) 
-                                    
-- Doesn't Occur On        
-    Mozilla (2002-03-15 build on Red Hat Linux; feature not supported)        
-    Internet Explorer 5.0 (shipping build on Windows NT 4.0)        
-    Netscape Communicator 4.5 (shipping build on Mac OS 9.0)
-</pre>
-</blockquote>
-
-<p><b>Additional Information:</b> Any other debugging information.
-For crashing bugs:</p>
-
-<ul>
-<li><b>Win32:</b> if you receive a Dr. Watson error, please note
-the type of the crash, and the module that the application crashed
-in. (e.g. access violation in apprunner.exe)</li>
-
-<li><b>Mac OS:</b> if you're running MacsBug, please provide the
-results of a <b>how</b> and an <b>sc</b>:</li>
-</ul>
-
-<blockquote>
-<pre>
-*** MACSBUG STACK CRAWL OF CRASH (Mac OS)
-Calling chain using A6/R1 links 
-    Back chain  ISA  Caller 
-    00000000    PPC  0BA85E74   
-    03AEFD80    PPC  0B742248   
-    03AEFD30    PPC  0B50FDDC  NSGetFactory+027FC
-PowerPC unmapped memory exception at 0B512BD0 NSGetFactory+055F0
-</pre>
-</blockquote>
-</blockquote>
-</blockquote>
-
-<p>You're done!<br>
-<br>
- After double-checking your entries for any possible errors, press
-the "Commit" button, and your bug report will now be in the
-Bugzilla database.<br>
-</p>
-</blockquote>
-
-<hr>
-<h3>More Information on Writing Good Bugs</h3>
-
-<blockquote>
-<p><b><a name="tips"></a> 1. General Tips for a Useful Bug
-Report</b>
-</p>
-
-<blockquote>
-<p>
- <b>Use an explicit structure, so your bug reports are easy to
-skim.</b> Bug report users often need immediate access to specific
-sections of your bug. If your Bugzilla installation supports the
-Bugzilla Helper, use it.
-</p>
-
-<p>
- <b>Avoid cuteness if it costs clarity.</b> Nobody will be laughing
-at your funny bug title at 3:00 AM when they can't remember how to
-find your bug.
-</p>
-
-<p>
- <b>One bug per report.</b> Completely different people typically
-fix, verify, and prioritize different bugs. If you mix a handful of
-bugs into a single report, the right people probably won't discover
-your bugs in a timely fashion, or at all. Certain bugs are also
-more important than others. It's impossible to prioritize a bug
-report when it contains four different issues, all of differing
-importance.
-</p>
-
-<p>
- <b>No bug is too trivial to report.</b> Unless you're reading the
-source code, you can't see actual software bugs, like a dangling
-pointer -- you'll see their visible manifestations, such as the
-segfault when the application finally crashes. Severe software
-problems can manifest themselves in superficially trivial ways.
-File them anyway.<br>
-</p>
-</blockquote>
-
-<p><b><a name="summary"></a>2. How and Why to Write Good Bug Summaries</b>
-</p>
-
-<blockquote>
-<p><b>You want to make a good first impression on the bug
-recipient.</b> Just like a New York Times headline guides readers
-towards a relevant article from dozens of choices, will your bug summary
-suggest that your bug report is worth reading from dozens or hundreds of
-choices?
-</p>
-
-<p>
- Conversely, a vague bug summary like <tt>install problem</tt> forces anyone
-reviewing installation bugs to waste time opening up your bug to
-determine whether it matters.
-</p>
-
-<p>
- <b>Your bug will often be searched by its summary.</b> Just as
-you'd find web pages with Google by searching by keywords through
-intuition, so will other people locate your bugs. Descriptive bug
-summaries are naturally keyword-rich, and easier to find.
-</p>
-
-<p>
- For example, you'll find a bug titled "<tt>Dragging icons from List View to
-gnome-terminal doesn't paste path</tt>" if you search on "List",
-"terminal", or "path". Those search keywords wouldn't have found a
-bug titled "<tt>Dragging icons
-doesn't paste</tt>".
-</p>
-
-<p>
- Ask yourself, "Would someone understand my bug from just this
-summary?" If so, you've written a fine summary.
-</p>
-
-<p><b>Don't write titles like these:</b></p>
-
-<ol>
- <li>"Can't install" - Why can't you install? What happens when you
-try to install?</li>
-<li>"Severe Performance Problems" - ...and they occur when you do
-what?</li>
-<li>"back button does not work" - Ever? At all?</li>
-</ol>
-
-<p><b>Good bug titles:</b></p>
-<ol>
-<li>"1.0 upgrade installation fails if Mozilla M18 package present"
-- Explains problem and the context.</li>
-<li>"RPM 4 installer crashes if launched on Red Hat 6.2 (RPM 3)
-system" - Explains what happens, and the context.</li>
-</ol>
-
-
-
-</blockquote>
-</blockquote>
-
-<p>(Written and maintained by 
-<a href="http://www.prometheus-music.com/eli">Eli Goldberg</a>. Claudius
-Gayle, Gervase Markham, Peter Mock, Chris Pratt, Tom Schutter and Chris Yeh also
-contributed significant changes. Constructive 
-<a href="mailto:eli@prometheus-music.com">suggestions</a> welcome.)</p>
-
-</body>
-</html>
-

mozilla/webtools/bugzilla/bugzilla.dtd

@@ -1,46 +0,0 @@
-<!ELEMENT bugzilla (bug+)>
-<!ATTLIST bugzilla
-	version CDATA #REQUIRED
-	urlbase CDATA #REQUIRED
-	maintainer CDATA #REQUIRED
-	exporter CDATA #IMPLIED
->
-<!ELEMENT bug (bug_id, (bug_status, product, priority, version, rep_platform, assigned_to, delta_ts, component, reporter, target_milestone?, bug_severity, creation_ts, qa_contact?, op_sys, resolution?, bug_file_loc?, short_desc?, keywords*, status_whiteboard?, dependson*, blocks*, cc*, long_desc*, attachment*)?)>
-<!ATTLIST bug
-	error (NotFound | NotPermitted | InvalidBugId) #IMPLIED
->
-<!ELEMENT bug_id (#PCDATA)>
-<!ELEMENT exporter (#PCDATA)>
-<!ELEMENT urlbase (#PCDATA)>
-<!ELEMENT bug_status (#PCDATA)>
-<!ELEMENT product (#PCDATA)>
-<!ELEMENT priority (#PCDATA)>
-<!ELEMENT version (#PCDATA)>
-<!ELEMENT rep_platform (#PCDATA)>
-<!ELEMENT assigned_to (#PCDATA)>
-<!ELEMENT delta_ts (#PCDATA)>
-<!ELEMENT component (#PCDATA)>
-<!ELEMENT reporter (#PCDATA)>
-<!ELEMENT target_milestone (#PCDATA)>
-<!ELEMENT bug_severity (#PCDATA)>
-<!ELEMENT creation_ts (#PCDATA)>
-<!ELEMENT qa_contact (#PCDATA)>
-<!ELEMENT status_whiteboard (#PCDATA)>
-<!ELEMENT op_sys (#PCDATA)>
-<!ELEMENT resolution (#PCDATA)>
-<!ELEMENT bug_file_loc (#PCDATA)>
-<!ELEMENT short_desc (#PCDATA)>
-<!ELEMENT keywords (#PCDATA)>
-<!ELEMENT dependson (#PCDATA)>
-<!ELEMENT blocks (#PCDATA)>
-<!ELEMENT cc (#PCDATA)>
-<!ELEMENT long_desc (who, bug_when, thetext)>
-<!ELEMENT who (#PCDATA)>
-<!ELEMENT bug_when (#PCDATA)>
-<!ELEMENT thetext (#PCDATA)>
-<!ELEMENT attachment (attachid, date, desc, type?, data?)>
-<!ELEMENT attachid (#PCDATA)>
-<!ELEMENT date (#PCDATA)>
-<!ELEMENT desc (#PCDATA)>
-<!ELEMENT type (#PCDATA)>
-<!ELEMENT data (#PCDATA)>

mozilla/webtools/bugzilla/changepassword.cgi

@@ -1,39 +0,0 @@
-#!/usr/bonsaitools/bin/perl -wT
-# -*- Mode: perl; indent-tabs-mode: nil -*-
-#
-# 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>
-
-use strict;
-
-print q{Content-type: text/html
-
-<HTML>
-<HEAD>
-<META HTTP-EQUIV="Refresh"
-  CONTENT="0; URL=userprefs.cgi">
-</HEAD>
-<BODY>
-This URL is obsolete.  Forwarding you to the correct one.
-<P>
-Going to <A HREF="userprefs.cgi">userprefs.cgi</A>
-<BR>
-</BODY>
-</HTML>
-}

mozilla/webtools/bugzilla/colchange.cgi

@@ -1,156 +0,0 @@
-#!/usr/bonsaitools/bin/perl -wT
-# -*- Mode: perl; indent-tabs-mode: nil -*-
-#
-# 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>
-
-use diagnostics;
-use strict;
-
-use lib qw(.);
-
-use vars qw(
-  @legal_keywords
-  $buffer
-  $template
-  $vars
-);
-
-require "CGI.pl";
-
-# Use the template toolkit (http://www.template-toolkit.org/) to generate
-# the user interface (HTML pages and mail messages) using templates in the
-# "template/" subdirectory.
-use Template;
-
-# Create the global template object that processes templates and specify
-# configuration parameters that apply to all templates processed in this script.
-my $template = Template->new(
-{
-    # Colon-separated list of directories containing templates.
-    INCLUDE_PATH => "template/custom:template/default",
-    # Allow templates to be specified with relative paths.
-    RELATIVE => 1,
-    PRE_CHOMP => 1,
-});
-
-# Define the global variables and functions that will be passed to the UI 
-# template.  Individual functions add their own values to this hash before
-# sending them to the templates they process.
-my $vars = 
-{
-    # Function for retrieving global parameters.
-    'Param' => \&Param, 
-
-    # Function for processing global parameters that contain references
-    # to other global parameters.
-    'PerformSubsts' => \&PerformSubsts,
-
-    # Function to search an array for a value   
-    'lsearch' => \&lsearch,
-};
-
-print "Content-type: text/html\n";
-
-# The master list not only says what fields are possible, but what order
-# they get displayed in.
-
-ConnectToDatabase();
-GetVersionTable();
-
-my @masterlist = ("opendate", "changeddate", "severity", "priority",
-                  "platform", "owner", "reporter", "status", "resolution",
-                  "product", "component", "version", "os", "votes");
-
-if (Param("usetargetmilestone")) {
-    push(@masterlist, "target_milestone");
-}
-if (Param("useqacontact")) {
-    push(@masterlist, "qa_contact");
-}
-if (Param("usestatuswhiteboard")) {
-    push(@masterlist, "status_whiteboard");
-}
-if (@::legal_keywords) {
-    push(@masterlist, "keywords");
-}
-
-
-push(@masterlist, ("summary", "summaryfull"));
-
-$vars->{masterlist} = \@masterlist;
-
-my @collist;
-if (defined $::FORM{'rememberedquery'}) {
-    my $splitheader = 0;
-    if (defined $::FORM{'resetit'}) {
-        @collist = @::default_column_list;
-    } else {
-        foreach my $i (@masterlist) {
-            if (defined $::FORM{"column_$i"}) {
-                push @collist, $i;
-            }
-        }
-        if (exists $::FORM{'splitheader'}) {
-            $splitheader = $::FORM{'splitheader'};
-        }
-    }
-    my $list = join(" ", @collist);
-    my $urlbase = Param("urlbase");
-    my $cookiepath = Param("cookiepath");
-    print "Set-Cookie: COLUMNLIST=$list ; path=$cookiepath ; expires=Sun, 30-Jun-2029 00:00:00 GMT\n";
-    print "Set-Cookie: SPLITHEADER=$::FORM{'splitheader'} ; path=$cookiepath ; expires=Sun, 30-Jun-2029 00:00:00 GMT\n";
-    print "Refresh: 0; URL=buglist.cgi?$::FORM{'rememberedquery'}\n";
-    print "\n";
-    print "<META HTTP-EQUIV=Refresh CONTENT=\"1; URL=$urlbase"."buglist.cgi?$::FORM{'rememberedquery'}\">\n";
-    print "<TITLE>What a hack.</TITLE>\n";
-    PutHeader ("Change columns");
-    print "Resubmitting your query with new columns...\n";
-    exit;
-}
-
-if (defined $::COOKIE{'COLUMNLIST'}) {
-    @collist = split(/ /, $::COOKIE{'COLUMNLIST'});
-} else {
-    @collist = @::default_column_list;
-}
-
-$vars->{collist} = \@collist;
-
-$vars->{splitheader} = 0;
-if ($::COOKIE{'SPLITHEADER'}) {
-    $vars->{splitheader} = 1;
-}
-
-my %desc = ();
-foreach my $i (@masterlist) {
-    $desc{$i} = $i;
-}
-
-$desc{'summary'} = "Summary (first 60 characters)";
-$desc{'summaryfull'} = "Full Summary";
-
-$vars->{desc} = \%desc;
-$vars->{buffer} = $::buffer;
-
-# Generate and return the UI (HTML page) from the appropriate template.
-print "Content-type: text/html\n\n";
-$template->process("list/change-columns.html.tmpl", $vars)
-  || ThrowTemplateError($template->error());
-

mozilla/webtools/bugzilla/collectstats.pl

@@ -1,202 +0,0 @@
-#!/usr/bonsaitools/bin/perl -w
-# -*- Mode: perl; indent-tabs-mode: nil -*-
-#
-# 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>,
-#                 Harrison Page <harrison@netscape.com>
-#         Gervase Markham <gerv@gerv.net>
-
-# Run me out of cron at midnight to collect Bugzilla statistics.
-
-
-use AnyDBM_File;
-use diagnostics;
-use strict;
-use vars @::legal_product;
-
-require "globals.pl";
-
-# tidy up after graphing module
-if (chdir("graphs")) {
-    unlink <./*.gif>;
-    unlink <./*.png>;
-    chdir("..");
-}
-
-ConnectToDatabase(1);
-GetVersionTable();
-
-my @myproducts;
-push( @myproducts, "-All-", @::legal_product );
-
-foreach (@myproducts) {
-    my $dir = "data/mining";
-
-    &check_data_dir ($dir);
-    &collect_stats ($dir, $_);
-}
-
-&calculate_dupes();
-
-sub check_data_dir {
-    my $dir = shift;
-
-    if (! -d) {
-        mkdir $dir, 0777;
-        chmod 0777, $dir;
-    }
-}
-
-sub collect_stats {
-    my $dir = shift;
-    my $product = shift;
-    my $when = localtime (time);
-
-    # NB: Need to mangle the product for the filename, but use the real
-    # product name in the query
-    my $file_product = $product;
-    $file_product =~ s/\//-/gs;
-    my $file = join '/', $dir, $file_product;
-    my $exists = -f $file;
-
-    if (open DATA, ">>$file") {
-        push my @row, &today;
-
-        foreach my $status ('NEW', 'ASSIGNED', 'REOPENED', 'UNCONFIRMED', 'RESOLVED', 'VERIFIED', 'CLOSED') {
-            if( $product eq "-All-" ) {
-                SendSQL("select count(bug_status) from bugs where bug_status='$status'");
-            } else {
-                SendSQL("select count(bug_status) from bugs where bug_status='$status' and product='$product'");
-            }
-
-            push @row, FetchOneColumn();
-        }
-
-        foreach my $resolution ('FIXED', 'INVALID', 'WONTFIX', 'LATER', 'REMIND', 'DUPLICATE', 'WORKSFORME', 'MOVED') {
-            if( $product eq "-All-" ) {
-                SendSQL("select count(resolution) from bugs where resolution='$resolution'");
-            } else {
-                SendSQL("select count(resolution) from bugs where resolution='$resolution' and product='$product'");
-            }
-
-            push @row, FetchOneColumn();
-        }
-
-        if (! $exists) {
-            print DATA <<FIN;
-# Bugzilla Daily Bug Stats
-#
-# Do not edit me! This file is generated.
-#
-# fields: DATE|NEW|ASSIGNED|REOPENED|UNCONFIRMED|RESOLVED|VERIFIED|CLOSED|FIXED|INVALID|WONTFIX|LATER|REMIND|DUPLICATE|WORKSFORME|MOVED
-# Product: $product
-# Created: $when
-FIN
-        }
-
-        print DATA (join '|', @row) . "\n";
-        close DATA;
-    } else {
-        print "$0: $file, $!";
-    }
-}
-
-sub calculate_dupes {
-    SendSQL("SELECT * FROM duplicates");
-
-    my %dupes;
-    my %count;
-    my @row;
-    my $key;
-    my $changed = 1;
-
-    my $today = &today_dash;
-
-    # Save % count here in a date-named file
-    # so we can read it back in to do changed counters
-    # First, delete it if it exists, so we don't add to the contents of an old file
-    if (my @files = <data/duplicates/dupes$today*>) {
-        unlink @files;
-    }
-   
-    dbmopen(%count, "data/duplicates/dupes$today", 0644) || die "Can't open DBM dupes file: $!";
-
-    # Create a hash with key "a bug number", value "bug which that bug is a
-    # direct dupe of" - straight from the duplicates table.
-    while (@row = FetchSQLData()) {
-        my $dupe_of = shift @row;
-        my $dupe = shift @row;
-        $dupes{$dupe} = $dupe_of;
-    }
-
-    # Total up the number of bugs which are dupes of a given bug
-    # count will then have key = "bug number", 
-    # value = "number of immediate dupes of that bug".
-    foreach $key (keys(%dupes)) 
-    {
-        my $dupe_of = $dupes{$key};
-
-        if (!defined($count{$dupe_of})) {
-            $count{$dupe_of} = 0;
-        }
-
-        $count{$dupe_of}++;
-    }   
-
-    # Now we collapse the dupe tree by iterating over %count until
-    # there is no further change.
-    while ($changed == 1)
-    {
-        $changed = 0;
-        foreach $key (keys(%count)) {
-            # if this bug is actually itself a dupe, and has a count...
-            if (defined($dupes{$key}) && $count{$key} > 0) {
-                # add that count onto the bug it is a dupe of,
-                # and zero the count; the check is to avoid
-                # loops
-                if ($count{$dupes{$key}} != 0) {
-                    $count{$dupes{$key}} += $count{$key};
-                    $count{$key} = 0;
-                    $changed = 1;
-                }
-            }
-        }
-    }
-
-    # Remove the values for which the count is zero
-    foreach $key (keys(%count))
-    {
-        if ($count{$key} == 0) {
-            delete $count{$key};
-        }
-    }
-   
-    dbmclose(%count);
-}
-
-sub today {
-    my ($dom, $mon, $year) = (localtime(time))[3, 4, 5];
-    return sprintf "%04d%02d%02d", 1900 + $year, ++$mon, $dom;
-}
-
-sub today_dash {
-    my ($dom, $mon, $year) = (localtime(time))[3, 4, 5];
-    return sprintf "%04d-%02d-%02d", 1900 + $year, ++$mon, $dom;
-}
-

mozilla/webtools/bugzilla/confirmhelp.html

@@ -1,168 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
-<html><head>
-
-<!--
-     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) 2000 Netscape Communications Corporation. All
-     Rights Reserved.
-    
-     Contributor(s): Terry Weissman <terry@mozilla.org>
--->
-
-<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-<title>Understanding the UNCONFIRMED state, and other recent changes</title>
-</head>
-
-<body>
-<h1>Understanding the UNCONFIRMED state, and other recent changes</h1>
-
-<p>
-[This document is aimed primarily at people who have used Bugzilla
-before the UNCONFIRMED state was implemented.  It might be helpful for
-newer users as well.]
-</p>
-
-<p>
-
-New bugs in some products will now show up in a new state,
-UNCONFIRMED.  This means that we have nobody has confirmed that the
-bug is real.  Very busy engineers will probably generally ignore
-UNCONFIRMED that have been assigned to them, until they have been
-confirmed in one way or another.  (Engineers with more time will
-hopefully glance over their UNCONFIRMED bugs regularly.)
-</p>
-
-<p>
-The <a href="bug_status.html">page describing bug fields</a> has been
-updated to include UNCONFIRMED.
-</p>
-
-<p>
-There are two basic ways that a bug can become confirmed (and enter
-the NEW) state.
-</p>
-
-<ul>
-  <li> A user with the appropriate permissions (see below for more on
-       permissions) decides that the bug is a valid one, and confirms
-       it.  We hope to gather a small army of responsible volunteers
-       to regularly go through bugs for us.</li>
-  <li> The bug gathers a certain number of votes. <b>Any</b> valid Bugzilla user may vote for 
-bugs (each user gets a certain number of bugs); any UNCONFIRMED bug which 
-gets enough votes becomes automatically confirmed, and enters the NEW state.</li>
-</ul>
-
-<p>
-One implication of this is that it is worth your time to search the
-bug system for duplicates of your bug to vote on them, before
-submitting your own bug.  If we can spread around knowledge of this
-fact, it ought to help cut down the number of duplicate bugs in the
-system. 
-</p>
-
-<h2>Permissions.</h2>
-
-<p>
-Users now have a certain set of permissions.  To see your permissions,
-check out the
-<a href="userprefs.cgi?bank=permissions">user preferences</a> page.
-</p>
-
-<p>
-If you have the "Can confirm a bug" permission, then you will be able
-to move UNCONFIRMED bugs into the NEW state.
-</p>
-
-<p>
-If you have the "Can edit all aspects of any bug" permission, then you
-can tweak anything about any bug.  If not, you may only edit those
-bugs that you have submitted, or that you have assigned to you (or
-qa-assigned to you).  However, anyone may add a comment to any bug.
-</p>
-
-<p>
-Some people (initially, the initial owners and initial qa-contacts for
-components in the system) have the ability to give the above two
-permissions to other people.  So, if you really feel that you ought to
-have one of these permissions, a good person to ask (via private
-email, please!) is the person who is assigned a relevant bug.
-</p>
-
-<h2>Other details.</h2>
-
-<p>
-An initial stab was taken to decide who would be given which of the
-above permissions.  This was determined by some simple heurstics of
-who was assigned bugs, and who the default owners of bugs were, and a
-look at people who seem to have submitted several bugs that appear to
-have been interesting and valid.  Inevitably, we have failed to give
-someone the permissions they deserve.  Please don't take it
-personally; just bear with us as we shake out the new system.
-</p>
-
-<p>
-People with one of the two bits above can easily confirm their own
-bugs, so bugs they submit will actually start out in the NEW state.
-They can override this when submitting a bug.
-</p>
-
-<p>
-People can ACCEPT or RESOLVE a bug assigned to them, even if they
-aren't allowed to confirm it.  However, the system remembers, and if
-the bug gets REOPENED or reassigned to someone else, it will revert
-back to the UNCONFIRMED state.  If the bug has ever been confirmed,
-then REOPENing or reassigning will cause it to go to the NEW or
-REOPENED state.
-</p>
-
-<p>
-Note that only some products support the UNCONFIRMED state.  In other
-products, all new bugs will automatically start in the NEW state.
-</p>
-
-<h2>Things still to be done.</h2>
-
-<p>
-There probably ought to be a way to get a bug back into the
-UNCONFIRMED state, but there isn't yet.
-</p>
-
-<p>
-If a person has submitted several bugs that get confirmed, then this
-is probably a person who understands the system well, and deserves the
-"Can confirm a bug" permission.  This kind of person should be
-detected and promoted automatically.
-</p>
-
-<p>
-There should also be a way to automatically promote people to get the
-"Can edit all aspects of any bug" permission.
-</p>
-
-<p>
-The "enter a new bug" page needs to be revamped with easy ways for new
-people to educate themselves on the benefit of searching for a bug
-like the one they're about to submit and voting on it, rather than
-adding a new useless duplicate.
-</p>
-
-<hr>
-<p>
-<!-- hhmts start -->
-Last modified: Sun Apr 14 12:55:14 EST 2002
-<!-- hhmts end -->
-</p>
-</body> </html>

mozilla/webtools/bugzilla/contrib/BugzillaEmail.pm

@@ -1,79 +0,0 @@
-# -*- Mode: perl; indent-tabs-mode: nil -*-
-
-# 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.
-#
-# This code is based on code found in bug_email.pl from the bugzilla
-# email tracker.  Initial contributors are :: 
-#                 Terry Weissman <terry@mozilla.org>
-#                 Gregor Fischer <fischer@suse.de>
-#                 Klaas Freitag  <freitag@suse.de>
-#                 Seth Landsman  <seth@dworkin.net>
-
-# The purpose of this module is to abstract out a bunch of the code
-#  that is central to email interfaces to bugzilla and its database
-
-# Contributor : Seth Landsman <seth@dworkin.net>
-
-# Initial checkin : 03/15/00 (SML)
-#  findUser() function moved from bug_email.pl to here
-
-push @INC, "../."; # this script now lives in contrib
-
-require "globals.pl";
-
-use diagnostics;
-use strict;
-
-my $EMAIL_TRANSFORM_NONE = "email_transform_none";
-my $EMAIL_TRANSFORM_BASE_DOMAIN = "email_transform_base_domain";
-my $EMAIL_TRANSFORM_NAME_ONLY = "email_transform_name_only";
-
-# change to do incoming email address fuzzy matching
-my $email_transform = $EMAIL_TRANSFORM_NAME_ONLY;
-
-# findUser()
-# This function takes an email address and returns the user email.
-# matching is sloppy based on the $email_transform parameter
-sub findUser($) {
-  my ($address) = @_;
-  # if $email_transform is $EMAIL_TRANSFORM_NONE, return the address, otherwise, return undef
-  if ($email_transform eq $EMAIL_TRANSFORM_NONE) {
-    my $stmt = "SELECT login_name FROM profiles WHERE profiles.login_name = \'$address\';";
-    SendSQL($stmt);
-    my $found_address = FetchOneColumn();
-    return $found_address;
-  } elsif ($email_transform eq $EMAIL_TRANSFORM_BASE_DOMAIN) {
-    my ($username) = ($address =~ /(.+)@/);
-    my $stmt = "SELECT login_name FROM profiles WHERE profiles.login_name RLIKE \'$username\';";
-    SendSQL($stmt);
-
-    my $domain;
-    my $found = undef;
-    my $found_address;
-    my $new_address = undef;
-    while ((!$found) && ($found_address = FetchOneColumn())) {
-      ($domain) = ($found_address =~ /.+@(.+)/);
-      if ($address =~ /$domain/) {
-        $found = 1;
-        $new_address = $found_address;
-      }
-    }
-    return $new_address;
-  } elsif ($email_transform eq $EMAIL_TRANSFORM_NAME_ONLY) {
-    my ($username) = ($address =~ /(.+)@/);
-    my $stmt = "SELECT login_name FROM profiles WHERE profiles.login_name RLIKE \'$username\';";
-    SendSQL($stmt);
-    my $found_address = FetchOneColumn();
-    return $found_address;
-  }
-}
-
-1;

mozilla/webtools/bugzilla/contrib/README

@@ -1,22 +0,0 @@
-This directory contains contributed software related to Bugzilla.
-Things in here have not necessarily been tested or tried by anyone
-except the original contributor, so tred carefully.  But it may still
-be useful to you.
-
-This directory includes:
-
-  mysqld-watcher.pl --  This script can be installed as a frequent cron 
-                        job to clean up stalled/dead queries.
-        gnats2bz.pl --  A perl script to help import bugs from a GNATS 
-                        database into a Bugzilla database.  Contributed by
-                        Tom Schutter <tom@platte.com>
-
-       bug_email.pl --  A perl script that can receive email containing
-                        bug reports (email-interface). Contributed by
-                        Klaas Freitag <freitag@SuSE.de>
-	
-      README.Mailif --  Readme describing the mail interface.
-  bugmail_help.html --  User help page for the mail interface.
-
-       yp_nomail.sh --  Script you can run via cron that regularly updates
-                        the nomail file for terminated employees 

mozilla/webtools/bugzilla/contrib/README.Mailif

@@ -1,80 +0,0 @@
-
-The Bugzilla Mail interface
-===========================
-
-(UPDATE 03/14/00 to better reflect reality by SML)
-
-The Bugzilla Mail interface allows to submit bugs to Bugzilla by email.
-
-The Mail Interface Contribution consists of three files:
-README.Mailif - this readme.
-bug_email.pl  - the script
-bugmail_help.html - a user help html site
-
-Installation:
-
-Next is to add a user who receives the bugmails, e. g. bugmail. Create a 
-mail account and a home directory for the user. 
-
-The mailinterface script bug_email.pl needs to get the mail through stdin.
-I use procmail for that, with the following line in the .procmailrc:
-
-BUGZILLA_HOME=/usr/local/httpd/htdocs/bugzilla
-:0 c
-|(cd $BUGZILLA_HOME/contrib; ./bug_email.pl)
-
-This defines the Bugzilla directory as the variable BUGZILLA_HOME and passes
-all incoming mail to the script after cd'ing into the bugzilla home.
-
-In some cases, it is necessary to alter the headers of incoming email.  The 
-additional line to procmail :
-
-:0 fhw
-| formail -I "From " -a "From "
-
-fixes many problems.
-
-See bugzilla.procmailrc for a sample procmailrc that works for me (SML) and
-also deals with bugzilla_email_append.pl
-
-Customation:
-
-There are some values inside the script which need to be customized for your
-needs:
-
-1. In sub-routine Reply (search 'sub Reply':
-there is the line
-    print MAIL "From: Bugzilla Mailinterface<yourmail\@here.com>\n";
-                                            ^^^^^^^^^^^^^^^^^^^^
-Fill in your correct mail here. That will make it easy for people to reply
-to the mail.
-
-2. check, if your sendmail resides in /usr/sbin/sendmail, change the path if neccessary.
-Search the script after 'default' - you find some default-Settings for bug
-reports, which are used, if the sender did not send a field for it. The defaults
-should be checked and changed.
-
-Thats hopefully all, we will come up with any configuration file or something.
-
-
-If your mail works, your script will insert mails from now on.
-
-The mailinterface supports two commandline switches:
-
-There are two command line switches :
-
--t: Testmode
-    The mailinterface does not really insert the bug into the database, but
-    writes some debug output to stdout and writes the mail into the file
-    bug_email_test.log in the data-dir.
-
--r: restricted mode
-    All lines before the first line with a keyword character are skipped.
-    In not restricted, default mode, these lines are added to the long 
-    description of the bug.
-
-
-02/2000 - Klaas Freitag, SuSE GmbH <freitag@suse.de>
-03/2000 - Seth M. Landsman <seth@cs.brandeis.edu>
- bug_email.pl now lives out of bugzilla/contrib
- added line about formail

mozilla/webtools/bugzilla/contrib/bugmail_help.html

@@ -1,223 +0,0 @@
-<HTML>
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
-<!--
-     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.
-    
-     Contributor(s): Klaas Freitag <Freitag@SuSE.de>
--->
-
-<HEAD> <TITLE>Bugzilla Mail Interface</TITLE> </HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER><H1>The Bugzilla Mail Interface</H1>
-Contributor: <A HREF="mailto:freitag@suse.de">Klaas Freitag</A>, SuSE GmbH 
-</CENTER>
-<P>
-The bugzilla Mail interface allows the registered bugzilla users to submit bugs by 
-sending email with a bug description. This is usefull for people, who do not work 
-inhouse and want to submitt bugs to the bugzilla system.
-<p>
-
-
-I know, show me the <A HREF="#examplemail">example-mail !</A>
-
-
-<H2>What do you need to do to submitt a bug by mail ?</H2>
-You need to send a email in the described format to the bugmail-user of the 
-bugzilla-system. This is <A HREF="mailto:our_bugzilla@xyz.com">yourbugzilla@here.com</A>
-
-You receive a reply mail with the new bug-ID if your request was ok. 
-If not, you get a mail with 
-some help on the bugmail system and a specific analysis of your request.
-<P>
-Please dont refuse to send one or two wrong mails, you will get all the information 
-you need in the replies, and <I>only</I> in the mail replies. The information on this
-page, concerning available products, versions and so on, is not dynamicly generated and 
-may  be old therefore.
-
-<H1>The Mail Format</H1>
-The bugmail needs a special format , which consists of some keywords and suitable 
-values for them and a description text. Note that the keyword block needs to be
-above of the description text.
-
-<H2>Keywords</H2>
-You need to tell bugzilla some properties of the bugs. This is done by keywords, which
-start on a new line with a @, followed by the keyword and and equal-sign, followed by a
-hopefully valid value.
-
-
-<TABLE BORDER=4 FRAME=box CELLSPACING="5" width=95%> <COLGROUP> <col width="2*"> 
-<col width="5*"> <col width="1*"> </COLGROUP>
-	<TR>
-		<TH>Keyword</TH>
-		<TH>Value description</TH>
-		<TH>required and default value</TH>
-	</TR>
-	<TR>
-	        <TD>@product</TD>
-	        <TD>The product which has a bug</TD>
-	        <TD>yes. <br> This is the most important information. Many other
-		fields depend on the product.</TD>
-	</TR>
-	<TR>
-	        <TD>@component</TD>
-	        <TD>the desired component which is affected by the bug</TD>
-	        <TD>yes. <br> As the @product, this is a very important 
-		field.</TD>
-	</TR>
-	<TR>
-	        <TD>@version</TD>
-	        <TD>The version of the product</TD>
-	        <TD>yes. <br>See @product and @component</TD>
-	</TR>
-	<TR>
-	        <TD>@short_desc</TD>
-	        <TD>A summary of your bug report</TD>
-	        <TD>yes. <br>This summary of the error you want to report 
-		describes what happen. You may skip the long description,
-		but not this summary.<br>
-		<b>Note:</b>The short description may be given in the mail subject
-		instead of using the keyword !</TD>
-	</TR>
-	<TR>
-	        <TD>@rep_platform</TD>
-	        <TD>The desired platform</TD>
-	        <TD>no.<br>If you dont give a value, this field is set to <I>All</I>.</TD>
-	</TR>
-	<TR>
-	        <TD>@bug_severity</TD>
-	        <TD>The severity of the bug</TD>
-	        <TD>no. <br> If you dont give a value, this field is set to 
-		<I>normal</I></TD>
-	</TR>
-	<TR>
-	        <TD>@priority</TD>
-	        <TD>The priority of the bug</TD>
-	        <TD>no.<br>If you dont give a value, this field is set to <I>P3</I></TD>
-	</TR>
-	<TR>
-	        <TD>@op_sys</TD>
-	        <TD>The operating system</TD>
-	        <TD>no.<br>If you dont give a value, this field is set to <I>Linux</I>.</TD>
-	</TR>
-	<TR>
-	        <TD>@assigned_to</TD>
-	        <TD>The one to whom the bug is assigned to</TD>
-	        <TD>no. <br>There is an initial owner for every product/version/component.
-		He owns the bug by default. The initial owner can only be found if 
-		product, version and component are valid.</TD>
-	</TR>
-	<TR>
-	        <TD>@bug_file_loc</TD>
-	        <TD>?</TD>
-	        <TD>no.</TD>
-	</TR>
-	<TR>
-	        <TD>@status_whiteboard</TD>
-	        <TD>?</TD>
-	        <TD>no.</TD>
-	</TR>
-	<TR>
-	        <TD>@target_milestone</TD>
-	        <TD>?</TD>
-	        <TD>no.</TD>
-	</TR>
-	<TR>
-	        <TD>@groupset</TD>
-	        <TD>rules the visibility of the bug.</TD>
-	        <TD>no.<br>This value defaults to the smallest of the available groups,
-		which is <I>readInternal</I>.</TD>
-	</TR>
-	<TR>
-	        <TD>@qa_contact</TD>
-	        <TD>the quality manager for the product</TD>
-	        <TD>no.<br>This value can be retrieved from product, component and 
-		version</TD>
-	</TR>
-
-</TABLE>
-<H2>Valid values</H2>
-Give string values for the most keys above. Some keywords  require special values:<br>
-<ol>
-<li>E-Mail adresses: If you want to set the qa-contact, specify a email-adress for @qa_contact. The email must be known by bugzilla of course.</li>
-<li>Listvalues: Most of the values have to be one of a list of valid values. Try by sending
-a mail and read the reply. Skip fields if you dont get help for them unless you dont know
-which values you may choose.</li>
-<li>free Text: The descriptions may be free text. </li>
-<li>Special: The field groupset may be specified in different in three different kinds:
- <ol>
-    <li> A plain numeric way, which is one usually huge number, e. g. <I>65536</I></li>
-    <li> a string with added numbers e.g. <I>65536+131072</I></li>
-    <li> a string list, e.g. <I>ReadInternal, ReadBeta </I></li>
- </ol>
-</li>
-</ol>
-
-<p>
-
-But most of them need <b>valid</b> values.
-<p>
-Sorry, you will not find lists of valid products, components and the other stuff
-here. Send a mail to with any text, and you will get a list of valid keywords in the reply.
-
-<p>
-Some of the values must be choosen from a list:<br>
-<ol>
-  <li>bug_severity: blocker, critical, major, normal, minor, trivial, enhancement</li>
-  <li>op_sys: Linux </li>
-  <li>priority: P1, P2, P3, P4, P5</li>
-  <li>rep_platform: All, i386, AXP, i686, Other</li></ol>
-  
-
-<p>
-
-After you have specified the required keywords and maybe some other value, you may 
-describe your bug. You dont need  a keyword for starting your bug description. All 
-text which follows the keyword block is handled as long description of the bug.
-<p>
-
-The bugmail interface is able to find required information by itself. E.g. if you specify
-a product which has exactly one component, this component will be found by the interface
-automatically. 
-
-<H1>Attachments</H1>
-
-The mail interface is able to cope with MIME-attachments. 
-People could for example add a logfile as a mail attachment, and it will appear in 
-bugzilla as attachment. A comment for the attachment should be added, it will describe
-the attachment in bugzilla.
-
-<H1><A NAME="examplemail">Example Mail</A></H1>
-
-See the example of the mail <b>body</b> (Dont forget to specify the short description
-in the mail subject):<hr><pre>
-
-  @product      = Bugzilla
-  @component    = general
-  @version      = All
-  @groupset     = ReadWorld ReadPartners
-  @op_sys       = Linux
-  @priority     = P3
-  @rep_platform = i386
-
-
-  This is the description of the bug I found. It is not neccessary to start
-  it with a keyword. 
-
-  Note: The short_description is neccessary and may be given with the keyword
-  @short_description or will be retrieved from the mail subject.
-
-
-</pre><hr>
-
-</BODY>
-</HTML>

mozilla/webtools/bugzilla/contrib/bugzilla.procmailrc

@@ -1,30 +0,0 @@
-:0 fhw
-| formail -I "From " -a "From "
-
-BUGZILLA_HOME=/home/bugzilla/WEB/bugzilla/contrib
-
-:0
-* ^Subject: .*\[Bug .*\]
-RESULT=|(cd $BUGZILLA_HOME && ./bugzilla_email_append.pl)
-
-
-# Feed mail to stdin of bug_email.pl
-:0 Ec
-#* !^Subject: .*[Bug .*]
-RESULT=|(cd $BUGZILLA_HOME && ./bug_email.pl )
-
-# write result to a logfile
-:0 c
-|echo `date '+%d.%m.%y %H:%M:  '` $RESULT >> $HOME/bug_email.log
-
-
-:0 c
-|echo "----------------------------------" >> $HOME/bug_email.log
-
-:0 c
-$HOME/bug_email.log
- 
-# Move mail to the inbox
-:0
-$HOME/Mail/INBOX
-

mozilla/webtools/bugzilla/contrib/bugzilla_email_append.pl

@@ -1,189 +0,0 @@
-#!/usr/bin/perl -w
-# -*- Mode: perl; indent-tabs-mode: nil -*-
-
-# 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 purpose of this script is to take an email message, which
-# specifies a bugid and append it to the bug as part of the longdesc
-# table
-
-# Contributor : Seth M. Landsman <seth@dworkin.net>
-
-# 03/15/00 : Initial version by SML
-# 03/15/00 : processmail gets called
-
-# Email subject must be of format :
-# .* Bug ### .*
-# replying to a typical bugzilla email should be valid
-
-# TODO : 
-# 1. better way to get the body text (I don't know what dump_entity() is 
-#   actually doing
-
-use diagnostics;
-use strict;
-use MIME::Parser;
-
-push @INC, "../."; # this script lives in contrib
-require "globals.pl";
-require "BugzillaEmail.pm";
-
-# Create a new MIME parser:
-my $parser = new MIME::Parser;
-
-my $Comment = "";
-
-# Create and set the output directory:
-# FIXME: There should be a $BUGZILLA_HOME variable (SML)
-(-d "../data/mimedump-tmp") or mkdir "../data/mimedump-tmp",0755 or die "mkdir: $!";
-(-w "../data/mimedump-tmp") or die "can't write to directory";
-
-$parser->output_dir("../data/mimedump-tmp");
-    
-# Read the MIME message:
-my $entity = $parser->read(\*STDIN) or die "couldn't parse MIME stream";
-$entity->remove_sig(10);          # Removes the signature in the last 10 lines
-
-# Getting values from parsed mail
-my $Sender = $entity->get( 'From' );
-$Sender ||=  $entity->get( 'Reply-To' );
-my $Message_ID = $entity->get( 'Message-Id' );
-
-die (" *** Cant find Sender-adress in sent mail ! ***\n" ) unless defined( $Sender );
-chomp( $Sender );
-chomp( $Message_ID );
-
-print "Dealing with the sender $Sender\n";
-
-ConnectToDatabase();
-
-my $SenderShort = $Sender;
-$SenderShort =~ s/^.*?([a-zA-Z0-9_.-]+?\@[a-zA-Z0-9_.-]+\.[a-zA-Z0-9_.-]+).*$/$1/;
-
-$SenderShort = findUser($SenderShort);
-
-print "SenderShort is $SenderShort\n";
-if (!defined($SenderShort)) {
-  $SenderShort = $Sender;
-  $SenderShort =~ s/^.*?([a-zA-Z0-9_.-]+?\@[a-zA-Z0-9_.-]+\.[a-zA-Z0-9_.-]+).*$/$1/;
-}
-print "The sendershort is now $SenderShort\n";
-
-if (!defined($SenderShort)) {
-  DealWithError("No such user $SenderShort exists.");
-}
-
-my $Subject = $entity->get('Subject');
-print "The subject is $Subject\n";
-
-my ($bugid) = ($Subject =~ /\[Bug ([\d]+)\]/);
-print "The bugid is $bugid\n";
-
-# make sure the bug exists
-
-SendSQL("SELECT bug_id FROM bugs WHERE bug_id = $bugid;");
-my $found_id = FetchOneColumn();
-print "Did we find the bug? $found_id-\n";
-if (!defined($found_id)) {
-  DealWithError("Bug $bugid does not exist");
-}
-
-# get the user id
-SendSQL("SELECT userid FROM profiles WHERE login_name = \'$SenderShort\';");
-my $userid = FetchOneColumn();
-if (!defined($userid)) {
-  DealWithError("Userid not found for $SenderShort");
-}
-
-# parse out the text of the message
-dump_entity($entity);
-
-# Get rid of the bug id
-$Subject =~ s/\[Bug [\d]+\]//;
-#my $Comment = "This is only a test ...";
-my $Body = "Subject: " . $Subject . "\n" . $Comment;
-
-# shove it in the table
-my $long_desc_query = "INSERT INTO longdescs SET bug_id=$found_id, who=$userid, bug_when=NOW(), thetext=" . SqlQuote($Body) . ";";
-SendSQL($long_desc_query);
-
-system("cd .. ; ./processmail $found_id '$SenderShort'");
-
-sub DealWithError {
-  my ($reason) = @_;
-  print $reason . "\n";
-}
-
-# Yanking this wholesale from bug_email, 'cause I know this works.  I'll
-#  figure out what it really does later
-#------------------------------
-#
-# dump_entity ENTITY, NAME
-#
-# Recursive routine for parsing a mime coded mail.
-# One mail may contain more than one mime blocks, which need to be
-# handled. Therefore, this function is called recursively.
-#
-# It gets the for bugzilla important information from the mailbody and 
-# stores them into the global attachment-list @attachments. The attachment-list
-# is needed in storeAttachments.
-#
-sub dump_entity {
-    my ($entity, $name) = @_;
-    defined($name) or $name = "'anonymous'";
-    my $IO;
-
-
-    # Output the body:
-    my @parts = $entity->parts;
-    if (@parts) {                     # multipart...
-	my $i;
-	foreach $i (0 .. $#parts) {       # dump each part...
-	    dump_entity($parts[$i], ("$name, part ".(1+$i)));
-	}
-    } else {                            # single part...	
-
-	# Get MIME type, and display accordingly...
-	my $msg_part = $entity->head->get( 'Content-Disposition' );
-	
-	$msg_part ||= ""; 
-
-	my ($type, $subtype) = split('/', $entity->head->mime_type);
-	my $body = $entity->bodyhandle;
-	my ($data, $on_disk );
-
-	if(  $msg_part =~ /^attachment/ ) {
-	    # Attached File
-	    my $des = $entity->head->get('Content-Description');
-	    $des ||= "";
-
-	    if( defined( $body->path )) { # Data is on disk
-		$on_disk = 1;
-		$data = $body->path;
-		
-	    } else {                      # Data is in core
-		$on_disk = 0;
-		$data = $body->as_string;
-	    }
-#	    push ( @attachments, [ $data, $entity->head->mime_type, $on_disk, $des ] );
-	} else {
-	    # Real Message
-	    if ($type =~ /^(text|message)$/) {     # text: display it...
-		if ($IO = $body->open("r")) {
-		    $Comment .=  $_ while (defined($_ = $IO->getline));
-		    $IO->close;
-		} else {       # d'oh!
-		    print "$0: couldn't find/open '$name': $!";
-		}
-	    } else { print "Oooops - no Body !\n"; }
-	}
-    }
-}

mozilla/webtools/bugzilla/contrib/cmdline/buglist

@@ -1,94 +0,0 @@
-#!/bin/sh
-# 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 
-# Andreas Franke <afranke@ags.uni-sb.de>.
-# Corporation. Portions created by Andreas Franke are
-# Copyright (C) 2001 Andreas Franke. All
-# Rights Reserved.
-#
-# Contributor(s): 
-
-conf="`dirname $0`/query.conf"
-
-query="http://bugzilla.mozilla.org/buglist.cgi?cmd=doit"
-defaultcolumnlist="severity priority platform status resolution target_milestone status_whiteboard keywords summaryfull"
-
-chart=0
-and=0
-while test "$1" != ""; do
-    arg=$1
-    arg_len=`expr length ${arg}`
-    if test `expr substr "${arg}" 1 2` == "--"; then
-        eq_pos=`expr match ${arg} '--.*='`
-        if test "${eq_pos}" == "0"; then
-            echo 'Missing value for long option '"${arg}"' ("=" not found)' 1>&2
-            exit 1;
-        fi
-        # extract option name
-        let name_len=${eq_pos}-3
-        name=`expr substr ${arg} 3 ${name_len}`
-        # extract option value
-        let val_start=${eq_pos}+1
-        let val_len=${arg_len}-${eq_pos}
-        val=`expr substr ${arg} ${val_start} ${val_len}`
-    elif test `expr substr ${arg} 1 1` == "-" &&
-         test "`expr substr ${arg} 2 1`" != ""; then
-        # extract
-        name=`expr substr ${arg} 2 1`
-        let val_len=${arg_len}-2
-        val=`expr substr ${arg} 3 ${val_len}`
-    else
-        name="default"
-        val="${arg}"
-        #echo "Unrecognized option ${arg}" 1>&2
-        #exit 1
-    fi
-
-    # find field and comparison type for option ${name}
-    field=`grep '"'${name}'"' ${conf} | awk '{printf $1}'`
-    type=`grep '"'${name}'"' ${conf} | awk '{printf $2}'`
-    if test "${field}" == ""  || test "${type}" == ""; then
-        echo "Field name & comparison type not found for option ${name}." 1>&2
-        exit 1;
-    fi
-
-    or=0
-    while test "${val}" != ""; do
-        comma_idx=`expr index ${val} ,`
-        if test ${comma_idx} == "0"; then
-            val1="${val}"
-            val=""
-        else
-            let val1_len=${comma_idx}-1
-            val1=`expr substr ${val} 1 ${val1_len}`
-            val_len=`expr length ${val}`
-            let rest_start=${comma_idx}+1
-            let rest_len=${val_len}-${comma_idx}
-            val=`expr substr ${val} ${rest_start} ${rest_len}`
-        fi
-        query="${query}&field${chart}-${and}-${or}=${field}"
-        query="${query}&type${chart}-${and}-${or}=${type}"
-        query="${query}&value${chart}-${and}-${or}=${val1}"
-        #echo "----- ${name} : ${field} : ${type} : ${val1} -----" 1>&2
-        let or=${or}+1
-    done
-    let chart=${chart}+1
-    shift
-done
-
-outputfile="/dev/stdout"
-#outputfile="buglist.html"
-#\rm -f ${outputfile}
-wget -q -O ${outputfile} --header="Cookie: COLUMNLIST=${COLUMNLIST-${defaultcolumnlist}}" "${query}"
-

mozilla/webtools/bugzilla/contrib/cmdline/bugs

@@ -1,31 +0,0 @@
-#!/bin/sh
-# 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 
-# Andreas Franke <afranke@ags.uni-sb.de>.
-# Corporation. Portions created by Andreas Franke are
-# Copyright (C) 2001 Andreas Franke. All
-# Rights Reserved.
-#
-# Contributor(s): 
-
-buglist="`dirname $0`/buglist"
-htmlfile="`dirname $0`/buglist.html"
-
-${buglist} "$@" 2>&1 1>${htmlfile}
-if test ${?} == "0"; then
-    echo `grep 'TR VALIGN=TOP ALIGN=LEFT CLASS=' ${htmlfile} | sed -e 's/<TR.*id=//' | sed -e 's/".*//'` | sed -e 's/ /\,/g'
-else
-    cat ${htmlfile} 1>&2
-    exit 1
-fi

mozilla/webtools/bugzilla/contrib/cmdline/query.conf

@@ -1,49 +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 the Bugzilla Bug Tracking System.
-#
-# The Initial Developer of the Original Code is 
-# Andreas Franke <afranke@ags.uni-sb.de>.
-# Corporation. Portions created by Andreas Franke are
-# Copyright (C) 2001 Andreas Franke. All
-# Rights Reserved.
-#
-# Contributor(s): 
-
-#
-# This is `query.conf', the config file for `buglist'.
-#
-# Columns: 1: field_name, 2: comparison_type, 3: cmd-line options
-#
-bug_status              substring       "s","status"
-resolution              substring       "r","resolution"
-rep_platform            substring       "p","platform"
-op_sys                  substring       "o","os","opsys"
-priority                substring       "p","priority"
-bug_severity            substring       "S","severity"
-assigned_to             substring       "A","O","owner","assignedto"
-reporter                substring       "R","reporter"
-qa_contact              substring       "Q","qa","qacontact"
-cc                      substring       "C","cc"
-product                 substring       "product"
-version                 substring       "V","version"
-component               substring       "c","component"
-target_milestone        substring       "M","milestone"
-short_desc              substring       "default","summary"
-longdesc                substring       "d","description","longdesc"
-bug_file_loc            substring       "u","url"
-status_whiteboard       substring       "w","whiteboard"
-keywords                substring       "k","K","keywords"
-attachments.description substring       "attachdesc"
-attachments.thedata     substring       "attachdata"
-attachments.mimetype    substring       "attachmime"
-dependson               substring       # bug 30823
-blocked                 substring       # bug 30823

mozilla/webtools/bugzilla/contrib/cvs-update.sh

@@ -1,40 +0,0 @@
-#!/bin/sh
-#
-# 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): Dawn Endico <endico@mozilla.org>
-
-
-# Keep a record of all cvs updates made from a given directory.
-#
-# Later, if changes need to be backed out, look at the log file
-# and run the cvs command with the date that you want to back
-# out to. (Probably the second to last entry).
-
-#DATE=`date +%e/%m/%Y\ %k:%M:%S\ %Z`
-DATE=`date`
-COMMAND="cvs update -d -P -D" 
-echo $COMMAND \"$DATE\" >> cvs-update.log
-$COMMAND "$DATE"
-
-
-# sample log file
-#cvs update -P -D "11/04/2000 20:22:08 PDT"
-#cvs update -P -D "11/05/2000 20:22:22 PDT"
-#cvs update -P -D "11/07/2000 20:26:29 PDT"
-#cvs update -P -D "11/08/2000 20:27:10 PDT"

mozilla/webtools/bugzilla/contrib/jb2bz.py

@@ -1,303 +0,0 @@
-#!/usr/local/bin/python
-# -*- mode: python -*-
-
-"""
-jb2bz.py - a nonce script to import bugs from JitterBug to Bugzilla
-Written by Tom Emerson, tree@basistech.com
-
-This script is provided in the hopes that it will be useful.  No
-rights reserved. No guarantees expressed or implied. Use at your own
-risk. May be dangerous if swallowed. If it doesn't work for you, don't
-blame me. It did what I needed it to do.
-
-This code requires a recent version of Andy Dustman's MySQLdb interface,
-
-    http://sourceforge.net/projects/mysql-python
-
-Share and enjoy.
-"""
-
-import rfc822, mimetools, multifile, mimetypes
-import sys, re, glob, StringIO, os, stat, time
-import MySQLdb, getopt
-
-# mimetypes doesn't include everything we might encounter, yet.
-if not mimetypes.types_map.has_key('.doc'):
-    mimetypes.types_map['.doc'] = 'application/msword'
-
-if not mimetypes.encodings_map.has_key('.bz2'):
-    mimetypes.encodings_map['.bz2'] = "bzip2"
-
-bug_status='NEW'
-component="default"
-version=""
-product="" # this is required, the rest of these are defaulted as above
-
-"""
-Each bug in JitterBug is stored as a text file named by the bug number.
-Additions to the bug are indicated by suffixes to this:
-
-<bug>
-<bug>.followup.*
-<bug>.reply.*
-<bug>.notes
-
-The dates on the files represent the respective dates they were created/added.
-
-All <bug>s and <bug>.reply.*s include RFC 822 mail headers. These could include
-MIME file attachments as well that would need to be extracted.
-
-There are other additions to the file names, such as
-
-<bug>.notify
-
-which are ignored.
-
-Bugs in JitterBug are organized into directories. At Basis we used the following
-naming conventions:
-
-<product>-bugs         Open bugs
-<product>-requests     Open Feature Requests
-<product>-resolved     Bugs/Features marked fixed by engineering, but not verified
-<product>-verified     Resolved defects that have been verified by QA
-
-where <product> is either:
-
-<product-name>
-
-or
-
-<product-name>-<version>
-"""
-
-def process_notes_file(current, fname):
-    try:
-        new_note = {}
-        notes = open(fname, "r")
-        s = os.fstat(notes.fileno())
-
-        new_note['text']  = notes.read()
-        new_note['timestamp'] = time.gmtime(s[stat.ST_MTIME])
-
-        notes.close()
-
-        current['notes'].append(new_note)
-
-    except IOError:
-        pass
-
-def process_reply_file(current, fname):
-    new_note = {}
-    reply = open(fname, "r")
-    msg = rfc822.Message(reply)
-    new_note['text'] = "%s\n%s" % (msg['From'], msg.fp.read())
-    new_note['timestamp'] = rfc822.parsedate_tz(msg['Date'])
-    current["notes"].append(new_note)
-
-def add_notes(current):
-    """Add any notes that have been recorded for the current bug."""
-    process_notes_file(current, "%d.notes" % current['number'])
-
-    for f in glob.glob("%d.reply.*" % current['number']):
-        process_reply_file(current, f)
-
-    for f in glob.glob("%d.followup.*" % current['number']):
-        process_reply_file(current, f)
-
-def maybe_add_attachment(current, file, submsg):
-    """Adds the attachment to the current record"""
-    cd = submsg["Content-Disposition"]
-    m = re.search(r'filename="([^"]+)"', cd)
-    if m == None:
-        return
-    attachment_filename = m.group(1)
-    if (submsg.gettype() == 'application/octet-stream'):
-        # try get a more specific content-type for this attachment
-        type, encoding = mimetypes.guess_type(m.group(1))
-        if type == None:
-            type = submsg.gettype()
-    else:
-        type = submsg.gettype()
-
-    try:
-        data = StringIO.StringIO()
-        mimetools.decode(file, data, submsg.getencoding())
-    except:
-        return
-
-    current['attachments'].append( ( attachment_filename, type, data.getvalue() ) )
-
-def process_mime_body(current, file, submsg):
-    data = StringIO.StringIO()
-    mimetools.decode(file, data, submsg.getencoding())
-    current['description'] = data.getvalue()
-
-
-
-def process_text_plain(msg, current):
-    print "Processing: %d" % current['number']
-    current['description'] = msg.fp.read()
-
-def process_multi_part(file, msg, current):
-    print "Processing: %d" % current['number']
-    mf = multifile.MultiFile(file)
-    mf.push(msg.getparam("boundary"))
-    while mf.next():
-        submsg = mimetools.Message(file)
-        if submsg.has_key("Content-Disposition"):
-            maybe_add_attachment(current, mf, submsg)
-        else:
-            # This is the message body itself (always?), so process
-            # accordingly
-            process_mime_body(current, mf, submsg)
-
-def process_jitterbug(filename):
-    current = {}
-    current['number'] = int(filename)
-    current['notes'] = []
-    current['attachments'] = []
-    current['description'] = ''
-    current['date-reported'] = ()
-    current['short-description'] = ''
-    
-    file = open(filename, "r")
-    msg = mimetools.Message(file)
-
-    msgtype = msg.gettype()
-
-    add_notes(current)
-    current['date-reported'] = rfc822.parsedate_tz(msg['Date'])
-    current['short-description'] = msg['Subject']
-
-    if msgtype[:5] == 'text/':
-        process_text_plain(msg, current)
-    elif msgtype[:10] == "multipart/":
-        process_multi_part(file, msg, current)
-    else:
-        # Huh? This should never happen.
-        print "Unknown content-type: %s" % msgtype
-        sys.exit(1)
-
-    # At this point we have processed the message: we have all of the notes and
-    # attachments stored, so it's time to add things to the database.
-    # The schema for JitterBug 2.14 can be found at:
-    #
-    #    http://www.trilobyte.net/barnsons/html/dbschema.html
-    #
-    # The following fields need to be provided by the user:
-    #
-    # bug_status
-    # product
-    # version
-    # reporter
-    # component
-    # resolution
-
-    # change this to the user_id of the Bugzilla user who is blessed with the
-    # imported defects
-    reporter=6
-
-    # the resolution will need to be set manually
-    resolution=""
-
-    db = MySQLdb.connect(db='bugs',user='root',host='localhost')
-    cursor = db.cursor()
-
-    cursor.execute( "INSERT INTO bugs SET " \
-                    "bug_id=%s," \
-                    "bug_severity='normal',"  \
-                    "bug_status=%s," \
-                    "creation_ts=%s,"  \
-                    "short_desc=%s," \
-                    "product=%s," \
-                    "rep_platform='All'," \
-                    "assigned_to=%s,"
-                    "reporter=%s," \
-                    "version=%s,"  \
-                    "component=%s,"  \
-                    "resolution=%s",
-                    [ current['number'],
-                      bug_status,
-                      time.strftime("%Y-%m-%d %H:%M:%S", current['date-reported'][:9]),
-                      current['short-description'],
-                      product,
-                      reporter,
-                      reporter,
-                      version,
-                      component,
-                      resolution] )
-
-    # This is the initial long description associated with the bug report
-    cursor.execute( "INSERT INTO longdescs VALUES (%s,%s,%s,%s)",
-                    [ current['number'],
-                      reporter,
-                      time.strftime("%Y-%m-%d %H:%M:%S", current['date-reported'][:9]),
-                      current['description'] ] )
-
-    # Add whatever notes are associated with this defect
-    for n in current['notes']:
-        cursor.execute( "INSERT INTO longdescs VALUES (%s,%s,%s,%s)",
-                        [current['number'],
-                         reporter,
-                         time.strftime("%Y-%m-%d %H:%M:%S", n['timestamp'][:9]),
-                         n['text']])
-
-    # add attachments associated with this defect
-    for a in current['attachments']:
-        cursor.execute( "INSERT INTO attachments SET " \
-                        "bug_id=%s, creation_ts=%s, description='', mimetype=%s," \
-                        "filename=%s, thedata=%s, submitter_id=%s",
-                        [ current['number'],
-                          time.strftime("%Y-%m-%d %H:%M:%S", current['date-reported'][:9]),
-                          a[1], a[0], a[2], reporter ])
-
-    cursor.close()
-    db.close()
-
-def usage():
-    print """Usage: jb2bz.py [OPTIONS] Product
-
-Where OPTIONS are one or more of the following:
-
-  -h                This help information.
-  -s STATUS         One of UNCONFIRMED, NEW, ASSIGNED, REOPENED, RESOLVED, VERIFIED, CLOSED
-                    (default is NEW)
-  -c COMPONENT      The component to attach to each bug as it is important. This should be
-                    valid component for the Product.
-  -v VERSION        Version to assign to these defects.
-
-Product is the Product to assign these defects to.
-
-All of the JitterBugs in the current directory are imported, including replies, notes,
-attachments, and similar noise.
-"""
-    sys.exit(1)
-
-
-def main():
-    global bug_status, component, version, product
-    opts, args = getopt.getopt(sys.argv[1:], "hs:c:v:")
-
-    for o,a in opts:
-        if o == "-s":
-            if a in ('UNCONFIRMED','NEW','ASSIGNED','REOPENED','RESOLVED','VERIFIED','CLOSED'):
-                bug_status = a
-        elif o == '-c':
-            component = a
-        elif o == '-v':
-            version = a
-        elif o == '-h':
-            usage()
-
-    if len(args) != 1:
-        sys.stderr.write("Must specify the Product.\n")
-        sys.exit(1)
-
-    product = args[0]
-
-    for bug in filter(lambda x: re.match(r"\d+$", x), glob.glob("*")):
-        process_jitterbug(bug)
-        
-
-if __name__ == "__main__":
-    main()

mozilla/webtools/bugzilla/contrib/mysqld-watcher.pl

@@ -1,102 +0,0 @@
-#!/usr/bonsaitools/bin/perl -w
-#
-# 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) 2000 Netscape Communications Corporation.  All
-# Rights Reserved.
-# 
-# Contributor(s): Dan Mosedale <dmose@mozilla.org>
-#
-
-# mysqld-watcher.pl - a script that watches the running instance of
-# mysqld and kills off any long-running SELECTs against the shadow_db
-# 
-use diagnostics;
-use strict;
-
-require "globals.pl";
-
-# some configurables: 
-
-# length of time before a thread is eligible to be killed, in seconds
-#
-my $long_query_time = 600;
-#
-# the From header for any messages sent out
-#
-my $mail_from = "root\@lounge.mozilla.org";
-#
-# mail transfer agent.  this should probably really be converted to a Param().
-#
-my $mta_program = "/usr/lib/sendmail -t -ODeliveryMode=deferred";
-
-# and STDIN is where we get the info about running threads
-#
-close(STDIN);
-open(STDIN, "/usr/bonsaitools/bin/mysqladmin processlist |");
-
-# iterate through the running threads
-#
-my @LONGEST = (0,0,0,0,0,0,0,0,0);
-while ( <STDIN> ) { 
-    my @F = split(/\|/);
-
-    # if this line is not the correct number of fields, or if the thread-id
-    # field contains Id, skip this line.  both these cases indicate that this
-    # line contains pretty-printing gunk and not thread info.
-    #
-    next if ( $#F != 9 || $F[1] =~ /Id/); 
-
-    if ( $F[4] =~ /shadow_bugs/             # shadowbugs database in use
-         && $F[5] =~ /Query/                # this is actually a query
-         && $F[6] > $long_query_time        # this query has taken too long
-         && $F[8] =~ /(select|SELECT)/      # only kill a select
-         && $F[6] > $LONGEST[6] ) {         # the longest running query seen
-        @LONGEST = @F;
-    }
-}
-
-# send an email message
-#
-# should perhaps be moved to somewhere more global for use in bugzilla as a 
-# whole; should also do more error-checking
-#
-sub sendEmail($$$$) {
-    ($#_ == 3) || die("sendEmail: invalid number of arguments");
-    my ($from, $to, $subject, $body) = @_;
-
-    open(MTA, "|$mta_program");
-    print MTA "From: $from\n";
-    print MTA "To: $to\n";
-    print MTA "Subject: $subject\n";
-    print MTA "\n";
-    print MTA $body;
-    print MTA "\n";
-    close(MTA);
-   
-}
-
-# if we found anything, kill the database thread and send mail about it
-#
-if ($LONGEST[6] != 0) {
-
-    system ("/usr/bonsaitools/bin/mysqladmin", "kill", $LONGEST[1]);
-
-    # fire off an email telling the maintainer that we had to kill a thread
-    #
-    sendEmail($mail_from, Param("maintainer"), 
-	     "long running MySQL thread killed",
-	     join(" ", @LONGEST) . "\n");
-}

mozilla/webtools/bugzilla/contrib/yp_nomail.sh

@@ -1,78 +0,0 @@
-#!/bin/sh
-# -*- Mode: ksh -*-
-##############################################################################
-# $Id: yp_nomail.sh,v 1.1 2000-09-12 23:50:31 cyeh%bluemartini.com Exp $
-# yp_nomail
-#
-# Our mail admins got annoyed when bugzilla kept sending email
-# to people who'd had bugzilla entries and left the company.  They
-# were no longer in the list of valid email users so it'd bounce.
-# Maintaining the 'data/nomail' file was a pain.  Luckily, our UNIX
-# admins list all the users that ever were, but the people who've left
-# have a distinct marker in their password file. For example:
-#
-# fired:*LK*:2053:1010:You're Fired Dude:/home/loser:/bin/false
-#
-# This script takes advantage of the "*LK*" convention seen via 
-# ypcat passwd and dumps those people into the nomail file. Any
-# manual additions are kept in a "nomail.(domainname)" file and 
-# appended to the list of yp lockouts every night via Cron
-#
-# 58 23 * * * /export/bugzilla/contrib/yp_nomail.sh > /dev/null 2>&1
-#
-# Tak ( Mark Takacs ) 08/2000
-#
-# XXX: Maybe should crosscheck w/bugzilla users?
-##############################################################################
-
-####
-# Configure this section to suite yer installation
-####
-
-DOMAIN=`domainname`
-MOZILLA_HOME="/export/mozilla"
-BUGZILLA_HOME="${MOZILLA_HOME}/bugzilla"
-NOMAIL_DIR="${BUGZILLA_HOME}/data"
-NOMAIL="${NOMAIL_DIR}/nomail"
-NOMAIL_ETIME="${NOMAIL}.${DOMAIN}"
-NOMAIL_YP="${NOMAIL}.yp"
-FIRED_FLAG="\*LK\*"
-
-YPCAT="/usr/bin/ypcat"
-GREP="/usr/bin/grep"
-SORT="/usr/bin/sort"
-
-########################## no more config needed  #################
-
-# This dir comes w/Bugzilla. WAY too paranoid
-if [ ! -d ${NOMAIL_DIR} ] ; then
-    echo "Creating $date_dir"
-    mkdir -p ${NOMAIL_DIR}
-fi
-
-#
-# Do some (more) paranoid checking
-#
-touch ${NOMAIL}
-if [ ! -w ${NOMAIL} ] ; then
-    echo "Can't write nomail file: ${NOMAIL} -- exiting"
-    exit
-fi
-if [ ! -r ${NOMAIL_ETIME} ] ; then
-    echo "Can't access custom nomail file: ${NOMAIL_ETIME} -- skipping"
-    NOMAIL_ETIME=""
-fi
-
-#
-# add all the people with '*LK*' password to the nomail list
-# XXX: maybe I should customize the *LK* string. Doh.
-#
-
-LOCKOUT=`$YPCAT passwd | $GREP "${FIRED_FLAG}" | cut -d: -f1 | sort > ${NOMAIL_YP}`
-`cat ${NOMAIL_YP} ${NOMAIL_ETIME} > ${NOMAIL}`
-
-exit
-
-
-# end
-

mozilla/webtools/bugzilla/createaccount.cgi

@@ -1,87 +0,0 @@
-#!/usr/bonsaitools/bin/perl -wT
-# -*- Mode: perl; indent-tabs-mode: nil -*-
-#
-# 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>
-#                 David Gardiner <david.gardiner@unisa.edu.au>
-#                 Joe Robins <jmrobins@tgix.com>
-#                 Christopher Aillon <christopher@aillon.com>
-#                 Gervase Markham <gerv@gerv.net>
-
-use diagnostics;
-use strict;
-
-use lib qw(.);
-
-require "CGI.pl";
-
-# Shut up misguided -w warnings about "used only once":
-use vars qw(
-%FORM
-$template
-$vars
-);
-
-ConnectToDatabase();
-
-# If we're using LDAP for login, then we can't create a new account here.
-if(Param('useLDAP')) {
-  DisplayError("This site is using LDAP for authentication.  Please contact 
-                an LDAP administrator to get a new account created.",
-               "Can't create LDAP accounts");
-  PutFooter();
-  exit;
-}
-
-# Clear out the login cookies.  Make people log in again if they create an
-# account; otherwise, they'll probably get confused.
-my $cookiepath = Param("cookiepath");
-print "Set-Cookie: Bugzilla_login= ; path=$cookiepath; expires=Sun, 30-Jun-80 00:00:00 GMT
-Set-Cookie: Bugzilla_logincookie= ; path=$cookiepath; expires=Sun, 30-Jun-80 00:00:00 GMT\n";
-
-print "Content-Type: text/html\n\n";
-
-my $login = $::FORM{'login'};
-my $realname = trim($::FORM{'realname'});
-
-if (defined($login)) {
-    # We've been asked to create an account.
-    CheckEmailSyntax($login);
-    trick_taint($login);
-    $vars->{'login'} = $login;
-    
-    if (!ValidateNewUser($login)) {
-        # Account already exists        
-        $template->process("account/exists.html.tmpl", $vars)
-          || ThrowTemplateError($template->error());
-        exit;
-    }
-    
-    # Create account
-    my $password = InsertNewUser($login, $realname);
-    MailPassword($login, $password);
-    
-    $template->process("account/created.html.tmpl", $vars)
-      || ThrowTemplateError($template->error());
-    exit;
-}
-
-# Show the standard "would you like to create an account?" form.
-$template->process("account/create.html.tmpl", $vars)
-  || ThrowTemplateError($template->error());

mozilla/webtools/bugzilla/css/buglist.css

@@ -1,38 +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 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): Myk Melez <myk@mozilla.org>
-  */
-
-/* Right align bug IDs. */
-.bz_id_column { text-align: right; }
-
-/* Style bug rows according to severity. */
-.bz_blocker { color: red; font-weight: bold; }
-.bz_critical { color: red; }
-.bz_enhancement { font-style: italic; }
-
-/* Style secure bugs if the installation is not using bug groups.
- * Installations that *are* using bug groups are likely to be using
- * them for almost all bugs, in which case special styling is not
- * informative and generally a nuisance.
- */
-.bz_secure { color: black; background-color: lightgrey; }
-
-/* Align columns in the "change multiple bugs" form to the right. */
-table#form tr th { text-align: right; }
-

mozilla/webtools/bugzilla/css/panel.css

@@ -1,37 +0,0 @@
-body
-  {
-    font-family:       sans-serif;
-    font-size:        10pt;
-    background-color:  white;
-  }
-
-ul
-  {
-    padding-left: 12px;
-  }
-
-radio
-  {
-    -moz-user-select: ignore;
-  }
-
-.text-link
-  {
-    margin-left:      3px;
-  }
-
-.text-link:hover
-  {
-    text-decoration:  underline;
-    cursor:           pointer;
-  }
-
-.descriptive-content
-  {
-    color:            #AAAAAA;
-  }
-
-.descriptive-content[focused=true]
-  {
-    color:            black;
-  }

mozilla/webtools/bugzilla/defparams.pl

@@ -1,601 +0,0 @@
-# -*- Mode: perl; indent-tabs-mode: nil -*-
-#
-# 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>
-#                 Dawn Endico <endico@mozilla.org>
-#                 Dan Mosedale <dmose@mozilla.org>
-#                 Joe Robins <jmrobins@tgix.com>
-#                 Jake <jake@acutex.net>
-#
-
-# This file defines all the parameters that we have a GUI to edit within
-# Bugzilla.
-
-# ATTENTION!!!!   THIS FILE ONLY CONTAINS THE DEFAULTS.
-# You cannot change your live settings by editing this file.
-# Only adding new parameters is done here.  Once the parameter exists, you 
-# must use %baseurl%/editparams.cgi from the web to edit the settings.
-
-use diagnostics;
-use strict;
-
-# Shut up misguided -w warnings about "used only once".  For some reason,
-# "use vars" chokes on me when I try it here.
-
-sub defparams_pl_sillyness {
-    my $zz;
-    $zz = %::param_checker;
-    $zz = %::param_desc;
-    $zz = %::param_type;
-}
-
-sub WriteParams {
-    foreach my $i (@::param_list) {
-        if (!defined $::param{$i}) {
-            $::param{$i} = $::param_default{$i};
-            if (!defined $::param{$i}) {
-                die "No default parameter ever specified for $i";
-            }
-        }
-    }
-
-    my $tmpname = "data/params.$$";
-    open(FID, ">$tmpname") || die "Can't create $tmpname";
-    my $v = $::param{'version'};
-    delete $::param{'version'};  # Don't write the version number out to
-                                # the params file.
-    print FID GenerateCode('%::param');
-    $::param{'version'} = $v;
-    print FID "1;\n";
-    close FID;
-    rename $tmpname, "data/params" || die "Can't rename $tmpname to data/params";
-    ChmodDataFile('data/params', 0666);
-}
-    
-
-sub DefParam {
-    my ($id, $desc, $type, $default, $checker) = (@_);
-    push @::param_list, $id;
-    $::param_desc{$id} = $desc;
-    $::param_type{$id} = $type;
-    $::param_default{$id} = $default;
-    if (defined $checker) {
-        $::param_checker{$id} = $checker;
-    }
-}
-
-
-sub check_numeric {
-    my ($value) = (@_);
-    if ($value !~ /^[0-9]+$/) {
-        return "must be a numeric value";
-    }
-    return "";
-}
-    
-sub check_shadowdb {
-    my ($value) = (@_);
-    $value = trim($value);
-    if ($value eq "") {
-        return "";
-    }
-    SendSQL("SHOW DATABASES");
-    while (MoreSQLData()) {
-        my $n = FetchOneColumn();
-        if (lc($n) eq lc($value)) {
-            return "The $n database already exists.  If that's really the name you want to use for the backup, please CAREFULLY make the existing database go away somehow, and then try again.";
-        }
-    }
-    SendSQL("CREATE DATABASE $value");
-    SendSQL("INSERT INTO shadowlog (command) VALUES ('SYNCUP')", 1);
-    return "";
-}
-
-@::param_list = ();
-
-
-
-# OK, here are the definitions themselves.
-#
-# The type of parameters (the third parameter to DefParam) can be one
-# of the following:
-#
-# t -- A short text entry field (suitable for a single line)
-# l -- A long text field (suitable for many lines)
-# b -- A boolean value (either 1 or 0)
-
-DefParam("maintainer",
-         "The email address of the person who maintains this installation of Bugzilla.",
-         "t",
-         'THE MAINTAINER HAS NOT YET BEEN SET');
-
-DefParam("urlbase",
-         "The URL that is the common initial leading part of all Bugzilla URLs.",
-         "t",
-         "http://cvs-mirror.mozilla.org/webtools/bugzilla/",
-         \&check_urlbase);
-
-sub check_urlbase {
-    my ($url) = (@_);
-    if ($url !~ m:^http.*/$:) {
-        return "must be a legal URL, that starts with http and ends with a slash.";
-    }
-    return "";
-}
-
-DefParam("cookiepath", 
-  "Directory path under your document root that holds your Bugzilla installation. Make sure to begin with a /.",
-  "t",
-  "/");
-
-DefParam("usequip",
-        "If this is on, Bugzilla displays a silly quip at the beginning of buglists, and lets users add to the list of quips.",
-        "b",
-        1);
-
-# Added parameter - JMR, 2/16/00
-DefParam("usebuggroups",
-         "If this is on, Bugzilla will associate a bug group with each product in the database, and use it for querying bugs.",
-         "b",
-         0); 
-
-# Added parameter - JMR, 2/16/00
-DefParam("usebuggroupsentry",
-         "If this is on, Bugzilla will use product bug groups to restrict who can enter bugs.  Requires usebuggroups to be on as well.",
-         "b",
-         0); 
-
-DefParam("shadowdb",
-         "If non-empty, then this is the name of another database in which Bugzilla will keep a shadow read-only copy of everything.  This is done so that long slow read-only operations can be used against this db, and not lock up things for everyone else.  Turning on this parameter will create the given database; be careful not to use the name of an existing database with useful data in it!",
-         "t",
-         "",
-         \&check_shadowdb);
-
-DefParam("queryagainstshadowdb",
-         "If this is on, and the shadowdb is set, then queries will happen against the shadow database.",
-         "b",
-         0);
-         
-
-# Adding in four parameters for LDAP authentication.  -JMR, 7/28/00
-DefParam("useLDAP",
-         "Turn this on to use an LDAP directory for user authentication ".
-         "instead of the Bugzilla database.  (User profiles will still be ".
-         "stored in the database, and will match against the LDAP user by ".
-         "email address.)",
-         "b",
-         0);
-
-
-DefParam("LDAPserver",
-         "The name (and optionally port) of your LDAP server. (e.g. ldap.company.com, or ldap.company.com:portnum)",
-         "t",
-         "");
-
-
-DefParam("LDAPBaseDN",
-         "The BaseDN for authenticating users against. (e.g. \"ou=People,o=Company\")",
-         "t",
-         "");
-
-
-DefParam("LDAPmailattribute",
-         "The name of the attribute of a user in your directory that ".
-         "contains the email address.",
-         "t",
-         "mail");
-#End of LDAP parameters
-
-
-DefParam("mostfreqthreshold",
-         "The minimum number of duplicates a bug needs to show up on the <A HREF=\"duplicates.cgi\">most frequently reported bugs page</a>. If you have a large database and this page takes a long time to load, try increasing this number.",
-         "t",
-         "2");
-
-
-DefParam("mybugstemplate",
-         "This is the URL to use to bring up a simple 'all of my bugs' list for a user.  %userid% will get replaced with the login name of a user.",
-         "t",
-         "buglist.cgi?bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;email1=%userid%&amp;emailtype1=exact&amp;emailassigned_to1=1&amp;emailreporter1=1");
-    
-
-DefParam("shutdownhtml",
-         "If this field is non-empty, then Bugzilla will be completely disabled and this text will be displayed instead of all the Bugzilla pages.",
-         "l",
-         "");
-
-DefParam("sendmailnow",
-         "If this is on, Bugzilla will tell sendmail to send any e-mail immediately. If you have a large number of users with a large amount of e-mail traffic, enabling this option may dramatically slow down Bugzilla. Best used for smaller installations of Bugzilla.",
-         "b",
-         0);
-
-DefParam("passwordmail",
-q{The email that gets sent to people to tell them their password.  Within
-this text, %mailaddress% gets replaced by the person's email address,
-%login% gets replaced by the person's login (usually the same thing), and
-%password% gets replaced by their password.  %<i>anythingelse</i>% gets
-replaced by the definition of that parameter (as defined on this page).},
-         "l",
-         q{From: bugzilla-daemon
-To: %mailaddress%
-Subject: Your Bugzilla password.
-
-To use the wonders of Bugzilla, you can use the following:
-
- E-mail address: %login%
-       Password: %password%
-
- To change your password, go to:
- %urlbase%userprefs.cgi
-});
-
-
-DefParam("newchangedmail",
-q{The email that gets sent to people when a bug changes.  Within this
-text, %to% gets replaced with the e-mail address of the person recieving
-the mail.  %bugid% gets replaced by the bug number.  %diffs% gets
-replaced with what's changed.  %neworchanged% is "New:" if this mail is
-reporting a new bug or empty if changes were made to an existing one.
-%summary% gets replaced by the summary of this bug. %reasonsheader% 
-is replaced by an abbreviated list of reasons why the user is getting the email,
-suitable for use in an email header (such as X-Bugzilla-Reason).
-%reasonsbody% is replaced by text that explains why the user is getting the email 
-in more user friendly text than %reasonsheader%.
-%<i>anythingelse</i>% gets replaced by the definition of 
-that parameter (as defined on this
-page).},
-         "l",
-"From: bugzilla-daemon
-To: %to%
-Subject: [Bug %bugid%] %neworchanged%%summary%
-X-Bugzilla-Reason: %reasonsheader%
-
-%urlbase%show_bug.cgi?id=%bugid%
-
-%diffs%
-
-
-
-%reasonsbody%");
-
-
-
-DefParam("whinedays",
-         "The number of days that we'll let a bug sit untouched in a NEW state before our cronjob will whine at the owner.",
-         "t",
-         7,
-         \&check_numeric);
-
-
-DefParam("whinemail",
-         "The email that gets sent to anyone who has a NEW bug that hasn't been touched for more than <b>whinedays</b>.  Within this text, %email% gets replaced by the offender's email address.  %userid% gets replaced by the offender's bugzilla login (which, in most installations, is the same as the email address.)  %<i>anythingelse</i>% gets replaced by the definition of that parameter (as defined on this page).<p> It is a good idea to make sure this message has a valid From: address, so that if the mail bounces, a real person can know that there are bugs assigned to an invalid address.",
-         "l",
-         q{From: %maintainer%
-To: %email%
-Subject: Your Bugzilla buglist needs attention.
-
-[This e-mail has been automatically generated.]
-
-You have one or more bugs assigned to you in the Bugzilla 
-bugsystem (%urlbase%) that require
-attention.
-
-All of these bugs are in the NEW state, and have not been touched
-in %whinedays% days or more.  You need to take a look at them, and 
-decide on an initial action.
-
-Generally, this means one of three things:
-
-(1) You decide this bug is really quick to deal with (like, it's INVALID),
-    and so you get rid of it immediately.
-(2) You decide the bug doesn't belong to you, and you reassign it to someone
-    else.  (Hint: if you don't know who to reassign it to, make sure that
-    the Component field seems reasonable, and then use the "Reassign bug to
-    owner of selected component" option.)
-(3) You decide the bug belongs to you, but you can't solve it this moment.
-    Just use the "Accept bug" command.
-
-To get a list of all NEW bugs, you can use this URL (bookmark it if you like!):
-
-    %urlbase%buglist.cgi?bug_status=NEW&assigned_to=%userid%
-
-Or, you can use the general query page, at
-%urlbase%query.cgi.
-
-Appended below are the individual URLs to get to all of your NEW bugs that 
-haven't been touched for a week or more.
-
-You will get this message once a day until you've dealt with these bugs!
-
-});
-
-
-
-DefParam("defaultquery",
-          "This is the default query that initially comes up when you submit a bug.  It's in URL parameter format, which makes it hard to read.  Sorry!",
-         "t",
-         "bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&emailassigned_to1=1&emailassigned_to2=1&emailreporter2=1&emailcc2=1&emailqa_contact2=1&order=%22Importance%22");
-
-
-DefParam("letsubmitterchoosepriority",
-         "If this is on, then people submitting bugs can choose an initial priority for that bug.  If off, then all bugs initially have the default priority selected below.",
-         "b",
-         1);
-
-
-sub check_priority {
-    my ($value) = (@_);
-    GetVersionTable();
-    if (lsearch(\@::legal_priority, $value) < 0) {
-        return "Must be a legal priority value: one of " .
-            join(", ", @::legal_priority);
-    }
-    return "";
-}
-
-DefParam("defaultpriority",
-         "This is the priority that newly entered bugs are set to.",
-         "t",
-         "P2",
-         \&check_priority);
-
-
-DefParam("usetargetmilestone",
-         "Do you wish to use the Target Milestone field?",
-         "b",
-         0);
-
-DefParam("nummilestones",
-         "If using Target Milestone, how many milestones do you wish to
-          appear?",
-         "t",
-         10,
-         \&check_numeric);
-
-DefParam("curmilestone",
-         "If using Target Milestone, Which milestone are we working toward right now?",
-         "t",
-         1,
-         \&check_numeric);
-
-DefParam("musthavemilestoneonaccept",
-         "If you are using Target Milestone, do you want to require that the milestone be set in order for a user to ACCEPT a bug?",
-         "b",
-         0);
-
-DefParam("useqacontact",
-         "Do you wish to use the QA Contact field?",
-         "b",
-         0);
-
-DefParam("usestatuswhiteboard",
-         "Do you wish to use the Status Whiteboard field?",
-         "b",
-         0);
-
-DefParam("usebrowserinfo",
-         "Do you want bug reports to be assigned an OS & Platform based on the browser
-          the user makes the report from?",
-         "b",
-         1);
-
-DefParam("usedependencies",
-         "Do you wish to use dependencies (allowing you to mark which bugs depend on which other ones)?",
-         "b",
-         1);
-
-DefParam("webdotbase",
-         "It is possible to show graphs of dependent bugs. You may set this parameter to
-any of the following:
-<ul>
-<li>A complete file path to \'dot\' (part of <a
-href=\"http://www.graphviz.org\">GraphViz</a>) will generate the graphs
-locally.</li>
-<li>A URL prefix pointing to an installation of the <a
-href=\"http://www.research.att.com/~north/cgi-bin/webdot.cgi\">webdot
-package</a> will generate the graphs remotely.</li>
-<li>A blank value will disable dependency graphing.</li>
-</ul>
-The default value is a publically-accessible webdot server.",
-         "t",
-         "http://www.research.att.com/~north/cgi-bin/webdot.cgi/%urlbase%",
-         \&check_webdotbase);
-
-sub check_webdotbase {
-    my ($value) = (@_);
-    $value = trim($value);
-    if ($value eq "") {
-        return "";
-    }
-    if($value !~ /^https?:/) {
-        if(! -x $value) {
-            return "The file path \"$value\" is not a valid executable.  Please specify the complete file path to 'dot' if you intend to generate graphs locally.";
-        }
-        # Check .htaccess allows access to generated images
-        if(-e "data/webdot/.htaccess") {
-            open HTACCESS, "data/webdot/.htaccess";
-            if(! grep(/png/,<HTACCESS>)) {
-                print "Dependency graph images are not accessible.\nDelete data/webdot/.htaccess and re-run checksetup.pl to rectify.\n";
-            }
-            close HTACCESS;
-        }
-    }
-    return "";
-}
-
-DefParam("expectbigqueries",
-         "If this is on, then we will tell mysql to <tt>set option SQL_BIG_TABLES=1</tt> before doing queries on bugs.  This will be a little slower, but one will not get the error <tt>The table ### is full</tt> for big queries that require a big temporary table.",
-         "b",
-         0);
-
-DefParam("emailregexp",
-         'This defines the regexp to use for legal email addresses.  The default tries to match fully qualified email addresses.  Another popular value to put here is <tt>^[^@]+$</tt>, which means "local usernames, no @ allowed."',
-         "t",
-         q:^[^@]+@[^@]+\\.[^@]+$:);
-
-DefParam("emailregexpdesc",
-         "This describes in english words what kinds of legal addresses are allowed by the <tt>emailregexp</tt> param.",
-         "l",
-         "A legal address must contain exactly one '\@', and at least one '.' after the \@.");
-
-DefParam("emailsuffix",
-         "This is a string to append to any email addresses when actually sending mail to that address.  It is useful if you have changed the <tt>emailregexp</tt> param to only allow local usernames, but you want the mail to be delivered to username\@my.local.hostname.",
-         "t",
-         "");
-
-
-DefParam("voteremovedmail",
-q{This is a mail message to send to anyone who gets a vote removed from a bug for any reason.  %to% gets replaced by the person who used to be voting for this bug.  %bugid% gets replaced by the bug number.  %reason% gets replaced by a short reason describing why the vote(s) were removed.  %votesremoved%, %votesold% and %votesnew% is the number of votes removed, before and after respectively.  %votesremovedtext%, %votesoldtext% and %votesnewtext% are these as sentences, eg "You had 2 votes on this bug."  %count% is also supported for backwards compatibility.  %<i>anythingelse</i>% gets replaced by the definition of that parameter (as defined on this page).},
-         "l",
-"From: bugzilla-daemon
-To: %to%
-Subject: [Bug %bugid%] Some or all of your votes have been removed.
-
-Some or all of your votes have been removed from bug %bugid%.
-
-%votesoldtext%
-
-%votesnewtext%
-
-Reason: %reason%
-
-%urlbase%show_bug.cgi?id=%bugid%
-");
-         
-DefParam("allowbugdeletion",
-         q{The pages to edit products and components and versions can delete all associated bugs when you delete a product (or component or version).  Since that is a pretty scary idea, you have to turn on this option before any such deletions will ever happen.},
-         "b",
-         0);
-
-
-DefParam("allowemailchange",
-         q{Users can change their own email address through the preferences.  Note that the change is validated by emailing both addresses, so switching this option on will not let users use an invalid address.},
-         "b",
-         0);
-
-
-DefParam("allowuserdeletion",
-         q{The pages to edit users can also let you delete a user.  But there is no code that goes and cleans up any references to that user in other tables, so such deletions are kinda scary.  So, you have to turn on this option before any such deletions will ever happen.},
-         "b",
-         0);
-
-DefParam("browserbugmessage",
-         "If bugzilla gets unexpected data from the browser, in addition to displaying the cause of the problem, it will output this HTML as well.",
-         "l",
-         "this may indicate a bug in your browser.\n");
-
-#
-# Parameters to force users to comment their changes for different actions.
-DefParam("commentonaccept", 
-         "If this option is on, the user needs to enter a short comment if he accepts the bug",
-         "b", 0 );
-DefParam("commentonclearresolution", 
-         "If this option is on, the user needs to enter a short comment if the bugs resolution is cleared",
-         "b", 0 );
-DefParam("commentonconfirm", 
-         "If this option is on, the user needs to enter a short comment when confirming a bug",
-         "b", 0 );
-DefParam("commentonresolve", 
-         "If this option is on, the user needs to enter a short comment if the bug is resolved",
-         "b", 0 );
-DefParam("commentonreassign", 
-         "If this option is on, the user needs to enter a short comment if the bug is reassigned",
-         "b", 0 );
-DefParam("commentonreassignbycomponent", 
-         "If this option is on, the user needs to enter a short comment if the bug is reassigned by component",
-         "b", 0 );
-DefParam("commentonreopen", 
-         "If this option is on, the user needs to enter a short comment if the bug is reopened",
-         "b", 0 );
-DefParam("commentonverify", 
-         "If this option is on, the user needs to enter a short comment if the bug is verified",
-         "b", 0 );
-DefParam("commentonclose", 
-         "If this option is on, the user needs to enter a short comment if the bug is closed",
-         "b", 0 );
-DefParam("commentonduplicate",
-         "If this option is on, the user needs to enter a short comment if the bug is marked as duplicate",
-         "b", 0 );
-DefParam("supportwatchers",
-         "Support one user watching (ie getting copies of all related email" .
-         " about) another's bugs.  Useful for people going on vacation, and" .
-         " QA folks watching particular developers' bugs",
-         "b", 0 );
-
-
-DefParam("move-enabled",
-         "If this is on, Bugzilla will allow certain people to move bugs to the defined database.",
-         "b",
-         0);
-DefParam("move-button-text",
-         "The text written on the Move button. Explain where the bug is being moved to.",
-         "t",
-         'Move To Bugscape');
-DefParam("move-to-url",
-         "The URL of the database we allow some of our bugs to be moved to.",
-         "t",
-         '');
-DefParam("move-to-address",
-         "To move bugs, an email is sent to the target database. This is the email address that database
-          uses to listen for incoming bugs.",
-         "t",
-         'bugzilla-import');
-DefParam("moved-from-address",
-         "To move bugs, an email is sent to the target database. This is the email address from which
-          this mail, and error messages are sent.",
-         "t",
-         'bugzilla-admin');
-DefParam("movers",
-         "A list of people with permission to move bugs and reopen moved bugs (in case the move operation fails).",
-         "t",
-         '');
-DefParam("moved-default-product",
-         "Bugs moved from other databases to here are assigned to this product.",
-         "t",
-         '');
-DefParam("moved-default-component",
-         "Bugs moved from other databases to here are assigned to this component.",
-         "t",
-         '');
-
-# The maximum size (in bytes) for patches and non-patch attachments.
-# The default limit is 1000KB, which is 24KB less than mysql's default
-# maximum packet size (which determines how much data can be sent in a
-# single mysql packet and thus how much data can be inserted into the
-# database) to provide breathing space for the data in other fields of
-# the attachment record as well as any mysql packet overhead (I don't
-# know of any, but I suspect there may be some.)
-
-DefParam("maxpatchsize",
-         "The maximum size (in kilobytes) of patches.  Bugzilla will not 
-          accept patches greater than this number of kilobytes in size.
-          To accept patches of any size (subject to the limitations of 
-          your server software), set this value to zero." ,
-         "t",
-         '1000');
-
-DefParam("maxattachmentsize" , 
-         "The maximum size (in kilobytes) of non-patch attachments.  Bugzilla 
-          will not accept attachments greater than this number of kilobytes 
-          in size.  To accept attachments of any size (subject to the
-          limitations of your server software), set this value to zero." , 
-         "t" , 
-         '1000');
-
-1;

mozilla/webtools/bugzilla/describecomponents.cgi

@@ -1,129 +0,0 @@
-#!/usr/bonsaitools/bin/perl -wT
-# -*- Mode: perl; indent-tabs-mode: nil -*-
-#
-# 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>
-#                 Bradley Baetz <bbaetz@student.usyd.edu.au>
-
-use vars qw(
-  %FORM
-  $userid
-);
-
-use diagnostics;
-use strict;
-
-use lib qw(.);
-
-require "CGI.pl";
-
-ConnectToDatabase();
-GetVersionTable();
-
-my $userid = quietly_check_login();
-
-if (!defined $::FORM{'product'}) {
-    # Reference to a subset of %::proddesc, which the user is allowed to see
-    my %products;
-
-    foreach my $p (@::legal_product) {
-        next if !CanSeeProduct($userid, $p);
-        $products{$p} = $::proddesc{$p};
-    }
-
-    my $prodsize = scalar(keys %products);
-    if ($prodsize == 0) {
-        DisplayError("Either no products have been defined ".
-                     "or you have not been given access to any.\n");
-        exit;
-    }
-    elsif ($prodsize > 1) {
-        $::vars->{'proddesc'} = \%products;
-        $::vars->{'target'} = "describecomponents.cgi";
-        $::vars->{'title'} = "Bugzilla component description";
-        $::vars->{'h2'} = 
-          "Please specify the product whose components you want described.";
-
-        print "Content-type: text/html\n\n";
-        $::template->process("global/choose-product.html.tmpl", $::vars)
-          || ThrowTemplateError($::template->error());
-        exit;
-    }
-
-    $::FORM{'product'} = (keys %::proddesc)[0];
-}
-
-my $product = $::FORM{'product'};
-
-# Make sure the user specified a valid product name.  Note that
-# if the user specifies a valid product name but is not authorized
-# to access that product, they will receive a different error message
-# which could enable people guessing product names to determine
-# whether or not certain products exist in Bugzilla, even if they
-# cannot get any other information about that product.
-grep($product eq $_ , @::legal_product)
-    || DisplayError("The product name is invalid.")
-    && exit;
-
-# Make sure the user is authorized to access this product.
-!CanSeeProduct($userid, $product)
-      && DisplayError("You are not authorized to access that product.")
-      && exit;
-
-# Make sure the user specified a valid product name.  Note that
-# if the user specifies a valid product name but is not authorized
-# to access that product, they will receive a different error message
-# which could enable people guessing product names to determine
-# whether or not certain products exist in Bugzilla, even if they
-# cannot get any other information about that product.
-grep($product eq $_ , @::legal_product)
-  || DisplayError("The product name is invalid.")
-  && exit;
-
-######################################################################
-# End Data/Security Validation
-######################################################################
-
-my @components;
-SendSQL("SELECT value, initialowner, initialqacontact, description FROM " .
-        "components WHERE program = " . SqlQuote($product) . " ORDER BY " .
-        "value");
-while (MoreSQLData()) {
-    my ($name, $initialowner, $initialqacontact, $description) =
-      FetchSQLData();
-
-    my %component;
-
-    $component{'name'} = $name;
-    $component{'initialowner'} = $initialowner ?
-      DBID_to_name($initialowner) : '';
-    $component{'initialqacontact'} = $initialqacontact ?
-      DBID_to_name($initialqacontact) : '';
-    $component{'description'} = $description;
-
-    push @components, \%component;
-}
-
-$::vars->{'product'} = $product;
-$::vars->{'components'} = \@components;
-
-print "Content-type: text/html\n\n";
-$::template->process("reports/components.html.tmpl", $::vars)
-  || ThrowTemplateError($::template->error());
-

mozilla/webtools/bugzilla/describekeywords.cgi

@@ -1,58 +0,0 @@
-#!/usr/bonsaitools/bin/perl -wT
-# -*- Mode: perl; indent-tabs-mode: nil -*-
-#
-# 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 Terry Weissman.
-# Portions created by Terry Weissman are
-# Copyright (C) 2000 Terry Weissman. All
-# Rights Reserved.
-#
-# Contributor(s): Terry Weissman <terry@mozilla.org>
-# Contributor(s): Gervase Markham <gerv@gerv.net>
-
-use diagnostics;
-use strict;
-use lib ".";
-
-require "CGI.pl";
-
-# Use the global template variables. 
-use vars qw($vars $template);
-
-ConnectToDatabase();
-
-my $userid = quietly_check_login();
-
-SendSQL("SELECT keyworddefs.name, keyworddefs.description, 
-                COUNT(keywords.bug_id)
-         FROM keyworddefs LEFT JOIN keywords ON keyworddefs.id=keywords.keywordid
-         GROUP BY keyworddefs.id
-         ORDER BY keyworddefs.name");
-
-my @keywords;
-
-while (MoreSQLData()) {
-    my ($name, $description, $bugs) = FetchSQLData();
-   
-    push (@keywords, { name => $name, 
-                       description => $description,
-                       bugcount => $bugs });
-}
-   
-$vars->{'keywords'} = \@keywords;
-$vars->{'caneditkeywords'} = UserInGroup($userid, "editkeywords");
-
-print "Content-type: text/html\n\n";
-$template->process("reports/keywords.html.tmpl", $vars)
-  || ThrowTemplateError($template->error());

mozilla/webtools/bugzilla/docs/README.docs

@@ -1,149 +0,0 @@
-Welcome to the Bugzilla documentation project!
-You'll find these directories and files here:
-
-README.docs	# This README file
-html/		# The compiled HTML docs from SGML sources (do not edit)
-sgml/		# The original SGML doc sources (edit these)
-txt/		# The compiled text docs from SGML sources
-ps/		# The compiled PostScript docs from SGML sources
-pdf/		# The compiled Adobe PDF docs from SGML sources
-
-A note about SGML:
-  The documentation is written in DocBook 3.1/4.1 SGML, and attempts to adhere
-to the LinuxDoc standards everywhere applicable (http://www.linuxdoc.org).
-Please consult "The LDP Author Guide" at linuxdoc.org for details on how
-to set up your personal environment for compiling SGML files.
-  If you need to make corrections to typographical errors, or other minor
-editing duties, feel free to use any text editor to make the changes.  SGML
-is not rocket science -- simply make sure your text appears between 
-appropriate tags (like <para>This is a paragraph</para>) and we'll be fine.
-If you are making more extensive changes, please ensure you at least validate
-your SGML before checking it in with something like:
-	nsgmls -s Bugzilla-Guide.sgml
-
-  When you validate, please validate the master document (Bugzilla-Guide.sgml)
-as well as the document you edited to ensure there are no critical errors.
-The following errors are considered "normal" when validating with nsgmls:
-
- DTDDECL catalog entries are not supported
- "DOCTYPE" declaration not allowed in instance
-
-  The reason these occur is that free sgml validators do not yet support
-the DTDDECL catalog entries, and I've included DOCTYPE declarations in
-entities referenced from Bugzilla-Guide.sgml so these entities can compile
-individually, if necessary.  I suppose I ought to comment them out at some
-point, but for now they are convenient and don't hurt anything.
-
-  Thanks for taking the time to read these notes and consulting the
-documentation.  Please address comments and questions to the newsgroup:
-news://news.mozilla.org/netscape/public/mozilla/webtools .
-
-==========
-HOW TO SET UP YOUR OWN SGML EDITING ENVIRONMENT:
-==========
-
-Trying to set up an SGML/XML Docbook editing environment the 
-first time can be a daunting task.
-I use Linux-Mandrake, in part, because it has a fully-functional
-SGML/XML Docbook editing environment included as part of the
-distribution CD's.  If you have easier instructions for how to
-do this for a particular Linux distribution or platform, please
-let the team know at the mailing list: mozilla-webtools@mozilla.org.
-
-The following text is taken nearly verbatim from
-http://bugzilla.mozilla.org/show_bug.cgi?id=95970, where I gave
-these instructions to someone who wanted the greater manageability
-maintaining a document in Docbook brings:
-
-This is just off the top of my head, but here goes.  Note some of these may 
-NOT be necessary, but I don't think they hurt anything by being installed.
-
-rpms:
-
-openjade
-jadetex
-docbook-dtds
-docbook-style-dsssl
-docbook-style-dsssl-doc
-docbook-utils
-xemacs
-psgml
-sgml-tools
-sgml-common
-
-
-If you're getting these from RedHat, make sure you get the ones in the
-rawhide area.  The ones in the 7.2 distribution are too old and don't
-include the XML stuff.
-
-Download "ldp.dsl" from the Resources page on linuxdoc.org.  This is the 
-stylesheet I use to get the HTML and text output.  It works well, and has a 
-nice, consistent look with the rest of the linuxdoc documents.  You'll have to 
-adjust the paths in ldp.dsl at the top of the file to reflect the actual 
-locations of your docbook catalog files.  I created a directory, 
-/usr/share/sgml/docbook/ldp, and put the ldp.dsl file there.  I then edited 
-ldp.dsl and changed two lines near the top:
-<!ENTITY docbook.dsl SYSTEM "../dsssl-stylesheets/html/docbook.dsl" CDATA 
-dsssl>
-...and...
-<!ENTITY docbook.dsl SYSTEM "../dsssl-stylesheets/print/docbook.dsl" CDATA
-dsssl>
-
-Note the difference is the top one points to the HTML docbook stylesheet, 
-and the next one points to the PRINT docbook stylesheet.
-
-  You know, this sure looks awful involved.  Anyway, once you have this in
-place, add to your .bashrc:
-export SGML_CATALOG_FILES=/etc/sgml/catalog
-export LDP_HOME=/usr/share/sgml/docbook/ldp
-export JADE_PUB=/usr/share/doc/openjade-1.3.1/pubtext
-
-or in .tcshrc:
-setenv SGML_CATALOG_FILES /etc/sgml/catalog
-setenv LDP_HOME /usr/share/sgml/docbook/ldp
-setenv JADE_PUB /usr/share/doc/openjade-1.3.1/pubtext
-
-  If you have root access and want to set this up for anyone on your box,
-you can add those lines to /etc/profile for bash users and /etc/csh.login
-for tcsh users.
-
-  Make sure you edit the paths in the above environment variables if those
-folders are anywhere else on your system (for example, the openjade version
-might change if you get a new version at some point).
-
-  I suggest xemacs for editing your SGML/XML Docbook documents.  The darn
-thing just works, and generally includes PSGML mode by default.  Not to
-mention you can validate the SGML from right within it without having to
-remember the command-line syntax for nsgml (not that it's that hard
-anyway).  If not, you can download psgml at
-http://www.sourceforge.net/projects/psgml.
-
-==========
-NOTES:
-==========
-
-  Here are the commands I use to maintain this documentation.
-  You MUST have DocBook 4.1.2 set up correctly in order for this to work.
-
-To create HTML documentation:
-bash$ cd html
-bash$ jade -t sgml -i html -d $LDP_HOME/ldp.dsl\#html \
-$JADE_PUB/xml.dcl ../sgml/Bugzilla-Guide.sgml
-
-To create HTML documentation as a single big HTML file:
-bash$ cd html
-bash$ jade -V nochunks -t sgml -i html -d $LDP_HOME/ldp.dsl\#html \
-$JADE_PUB/xml.dcl ../sgml/Bugzilla-Guide.sgml >Bugzilla-Guide.html
-
-To create TXT documentation as a single big TXT file:
-bash$ cd txt
-bash$ lynx -dump -nolist ../html/Bugzilla-Guide.html >Bugzilla-Guide.txt
-
-
-Sincerely,
- Matthew P. Barnson
- The Bugzilla "Doc Knight"
- mbarnson@sisna.com
-
- with major edits by Dave Miller <justdave@syndicomm.com> based on
- experience setting this up on the Landfill test server.

mozilla/webtools/bugzilla/docs/html/about.html

@@ -1,178 +0,0 @@
-<HTML
-><HEAD
-><TITLE
->About This Guide</TITLE
-><META
-NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
-"><LINK
-REL="HOME"
-TITLE="The Bugzilla Guide"
-HREF="index.html"><LINK
-REL="PREVIOUS"
-TITLE="The Bugzilla Guide"
-HREF="index.html"><LINK
-REL="NEXT"
-TITLE="Purpose and Scope of this Guide"
-HREF="aboutthisguide.html"></HEAD
-><BODY
-CLASS="chapter"
-BGCOLOR="#FFFFFF"
-TEXT="#000000"
-LINK="#0000FF"
-VLINK="#840084"
-ALINK="#0000FF"
-><DIV
-CLASS="NAVHEADER"
-><TABLE
-SUMMARY="Header navigation table"
-WIDTH="100%"
-BORDER="0"
-CELLPADDING="0"
-CELLSPACING="0"
-><TR
-><TH
-COLSPAN="3"
-ALIGN="center"
->The Bugzilla Guide</TH
-></TR
-><TR
-><TD
-WIDTH="10%"
-ALIGN="left"
-VALIGN="bottom"
-><A
-HREF="index.html"
-ACCESSKEY="P"
->Prev</A
-></TD
-><TD
-WIDTH="80%"
-ALIGN="center"
-VALIGN="bottom"
-></TD
-><TD
-WIDTH="10%"
-ALIGN="right"
-VALIGN="bottom"
-><A
-HREF="aboutthisguide.html"
-ACCESSKEY="N"
->Next</A
-></TD
-></TR
-></TABLE
-><HR
-ALIGN="LEFT"
-WIDTH="100%"></DIV
-><DIV
-CLASS="chapter"
-><H1
-><A
-NAME="about">Chapter 1. About This Guide</H1
-><DIV
-CLASS="TOC"
-><DL
-><DT
-><B
->Table of Contents</B
-></DT
-><DT
->1.1. <A
-HREF="aboutthisguide.html"
->Purpose and Scope of this Guide</A
-></DT
-><DT
->1.2. <A
-HREF="copyright.html"
->Copyright Information</A
-></DT
-><DT
->1.3. <A
-HREF="disclaimer.html"
->Disclaimer</A
-></DT
-><DT
->1.4. <A
-HREF="newversions.html"
->New Versions</A
-></DT
-><DT
->1.5. <A
-HREF="credits.html"
->Credits</A
-></DT
-><DT
->1.6. <A
-HREF="translations.html"
->Translations</A
-></DT
-><DT
->1.7. <A
-HREF="conventions.html"
->Document Conventions</A
-></DT
-></DL
-></DIV
-></DIV
-><DIV
-CLASS="NAVFOOTER"
-><HR
-ALIGN="LEFT"
-WIDTH="100%"><TABLE
-SUMMARY="Footer navigation table"
-WIDTH="100%"
-BORDER="0"
-CELLPADDING="0"
-CELLSPACING="0"
-><TR
-><TD
-WIDTH="33%"
-ALIGN="left"
-VALIGN="top"
-><A
-HREF="index.html"
-ACCESSKEY="P"
->Prev</A
-></TD
-><TD
-WIDTH="34%"
-ALIGN="center"
-VALIGN="top"
-><A
-HREF="index.html"
-ACCESSKEY="H"
->Home</A
-></TD
-><TD
-WIDTH="33%"
-ALIGN="right"
-VALIGN="top"
-><A
-HREF="aboutthisguide.html"
-ACCESSKEY="N"
->Next</A
-></TD
-></TR
-><TR
-><TD
-WIDTH="33%"
-ALIGN="left"
-VALIGN="top"
->The Bugzilla Guide</TD
-><TD
-WIDTH="34%"
-ALIGN="center"
-VALIGN="top"
->&nbsp;</TD
-><TD
-WIDTH="33%"
-ALIGN="right"
-VALIGN="top"
->Purpose and Scope of this Guide</TD
-></TR
-></TABLE
-></DIV
-></BODY
-></HTML
->