*** empty log message ***

git-svn-id: svn://10.0.0.236/branches/devel-branch-1_1@18195 18797224-902f-48f8-a5cc-f745e15eee43

mozilla/directory/perldap/ChangeLog

@@ -0,0 +1,298 @@
+1999-01-06  Leif Hedstrom  <leif@netscape.com>
+
+	* Conn.pm (nextEntry): Fixed (tried to fix...) the bug with
+	missing attributes. I hope this will work, at a minimum I'm sure
+	it won't hurt. The idea is to keep the case on the attribute type
+	when requesting the values_len().
+
+1999-01-11  Leif Hedstrom  <leif@netscape.com>
+
+	* API.xs: Added IF statements around all ldap_value_free() calls.
+
+1999-01-05  Leif Hedstrom  <leif@netscape.com>
+
+	* Conn.pm (getRes): Ooops, didn't return the appropriate
+	value... :(
+	(init): Changed test for LDAP_SUCCESS, to always return 0 or 1.
+	(close): Dito.
+	(delete): Dito.
+	(add): Dito.
+	(modifyRDN): Dito.
+	(update): Dito.
+	(simpleAuth): Dito.
+
+	* Entry.pm (NEXTKEY): Don't return the last $key if it's one that
+	should be hidden.
+
+	* Conn.pm (newEntry): New method, to create an empty LDAP::Entry
+	object. It is properly "tied" into the appropriate object.
+
+1999-01-04  Leif Hedstrom  <leif@netscape.com>
+
+	* Entry.pm (setDN): Added third optional argument, to enfoce DN
+	normalization.
+	(getDN): Dito.
+	(hasDNValue): Dito.
+	(matchDNValue): Dito.
+
+	* Entry.pm (removeValue): Added support for DN normalization
+	(optional argument).
+	(addValue): Dito
+	(getDN): Dito.
+
+1998-12-31  Leif Hedstrom  <leif@netscape.com>
+
+	* Entry.pm (DESTROY): Added this method, don't know if it actually
+	makes any sense at all... :(
+
+	* Conn.pm (add): Use _oc_order_ to find a list of attributes, to
+	avoide calling the TIEHASH methods.
+	(update): Dito.
+	(ALL): Clean out some "my" definitions.
+
+	* Entry.pm (unRemove): New function, to undo remove opertaions on
+	an attribute.
+	(DELETE): Bug-fix, don't undef the attribute, it would prevent us
+	from updating it properly in the Conn::update() method.
+	(remove): Dito.
+
+	* Conn.pm (nextEntry): Return $obj instead of blessing the %entry
+	(again).
+
+1998-12-25  Leif Hedstrom  <leif@netscape.com>
+
+	* Conn.pm (POD): Changed examples from $conn -> $entry.
+
+1998-12-17  Leif Hedstrom  <leif@netscape.com>
+
+	* Conn.pm (DESTROY): undef the Perl data after doing a
+	ldap_msgfree(), bug #1964.
+	(search): Dito.
+	(searchURL): Dito.
+	(nextEntry): Changed the order of setting numattr, to make sure
+	it's zero if we don't find anything.
+
+1998-12-16  Leif Hedstrom  <leif@netscape.com>
+
+	* Entry.pm (FIRSTKEY): Modified to honor the oc_order.
+	(NEXTKEY): Dito.
+	(markModified): Made as an alias for attrModified().
+
+	* Conn.pm (nextEntry): Added code to handle internal counters for
+	number of attributes in oc_order. This is used/needed for the
+	FIRSTKEY and NEXTKEY methods in the Entry/Tie::Hash object.
+
+	* Entry.pm (isAttr): New method, to make sure an attribute name
+	really is a valid LDAP attribute.
+	(FIRSTKEY): Now we'll handle each() and keys() properly, whooohoo!
+	(NEXTKEY): Dito.
+
+1998-12-15  Leif Hedstrom  <leif@netscape.com>
+
+	* Entry.pm (isDeleted): Added new method, almost identical to isModified().
+	(EXISTS): New method, to implement the EXISTS functionality.
+
+	* API.xs (RET_CPP): Test for NULL pointers, bug #1387.
+	(RET_BVPP): Dito.
+
+	* Utils.pm (ldapArgs): Fixed bug where "-s 0" would not be honored
+	(I'm an idiot, OK?).
+
+1998-12-14  Leif Hedstrom  <leif@netscape.com>
+
+	* Conn.pm (getRes): New method, to return the internal result message.
+	(getLD): Use defined() around test for existence.
+
+1998-12-11  Leif Hedstrom  <leif@netscape.com>
+
+	* Conn.pm (new): Make sure binddn and bindpasswd are set to the
+	empty string unless specified.
+	(init): Make sure certdb is defined before trying to use it.
+	(setDefaultRebindProc): Added default auth method, unless
+	explicitly specified.
+
+	* Utils.pm (askPassword): Added support for Term::ReadKey.
+	(askPassword): Moved the eval "use ..." here.
+	(userCredentials): Removed verbose print statement.
+	(askPassword): Added an optional argument to print a prompt;
+
+	* Conn.pm (setDefaultRebindProc): Added a default "auth" value, if
+	not provided in the call.
+
+1998-12-04  Leif Hedstrom  <leif@netscape.com>
+
+	* Makefile.PL: Modified so that "silent" install will actually
+	echo what options it's setting.
+	It will now croak() if the SDK dir specified doesn't exist.
+
+	* INSTALL: Updated to reflect new v1.1 stuff. Added links to the
+	FAQ.
+
+	* README: Dito. Also changed some of the binary install
+	information, which might not be useful anyways...
+
+	* Makefile.PL: Added "filters" to remove .dll and .sl from shared
+	libraries when creating link options. I also replaced the code to
+	put the valid library extensions into a variable (bug #1344).
+
+	* Makefile.PL: Fixed some crap with the config parsing, and ENV
+	handling (for silent installs).
+
+1998-12-03  Leif Hedstrom  <leif@netscape.com>
+
+	* Conn.pm (update): Bug fix, now we empty the hash array before
+	examining changed attributes (bug #1385).
+
+	* Makefile.PL: Added the "-nolinenumbers" XSUBS options (bug #1329).
+
+1998-09-26  Leif Hedstrom  <leif@netscape.com>
+
+	* Conn.pm (init): Cleaned out _perror() calls.
+	(delete): Added support for calling delete() with an Entry::
+	object as paramter.
+	(new): Cleaned out some dead code for $ref.
+
+	* Entry.pm (setValue): New method, to avoid having to use Perl
+	assignment statements to set an entire attribute value.
+
+1998-09-18  Leif Hedstrom  <leif@netscape.com>
+
+	* Conn.pm (init): Changed call to ldapssl_client_init() to pass a
+	0 value as the handle pointer. This avoids a Perl compiler warning.
+
+1998-09-12  Leif Hedstrom  <leif@netscape.com>
+
+	* LDIF.pm (readEntries): Changed tests for empty arguments, to use
+	defined().
+
+	* Utils.pm (ldapArgs): Bug fix, we used the wrong option for the
+	certificate (-P) when checking to set the LDAP port.
+	(normalizeDN): Chagned tests for empty arguments, to use use defined().
+
+	* Entry.pm (STORE): Changed tests for empty arguments, to use
+	defined().
+	(DELETE): Dito.
+	(attrModified): Dito.
+	(isModified): Dito.
+	(remove): Dito.
+	(removeValue): Dito.
+	(addValue): Dito.
+	(hasValue): Dito.
+	(matchValue): Dito.
+	(setDN): Dito.
+	(size): Dito.
+	(exists): Dito.
+
+	* Conn.pm (printError): Changed test for $str to see if it's defined.
+	(delete): Cleaned up code around $dn.
+	(modifyRDN): Cleaned up testes around $dn and $del.
+
+1998-09-11  Leif Hedstrom  <leif@netscape.com>
+
+	* Conn.pm (modifyRDN): We now preserve the case of the DN/RDN, but
+	still treat RDNs as CIS when comparing strings.
+
+1998-09-08  Leif Hedstrom  <leif@netscape.com>
+
+	* Conn.pm (setDefaultRebindProc): Bug fix, it had the Ldapc:: crap
+	stil in there... :-(.
+	(simpleAuth): New method, to do simple authentication rebind.
+
+1998-09-07  Leif Hedstrom  <leif@netscape.com>
+
+	* Makefile.PL: Changed all <> to <STDIN>, to support command line
+	arguments for MakeMaker.
+
+1998-09-03  Leif Hedstrom  <leif@netscape.com>
+
+	* Conn.pm (nextEntry): Fixed bug with case sensitivity.
+
+1998-08-18  Leif Hedstrom  <leif@netscape.com>
+
+	* Conn.pm (setDefaultRebindProc): It's back!
+	Officially released PerLDAP v1.0.
+
+1998-08-13  Leif Hedstrom  <leif@netscape.com>
+
+	* Makefile.PL: Fixed so that automated installs works.
+
+	* Conn.pm (update): Fixed narly bug with ldap_modify()...
+
+	* All: Cleaned up some hash indexes, to make sure they are
+	properly quoted, and there are no conflicts to resolve.
+	
+	* Entry.pm (STORE): Fixed a bug with attribute names not being
+	properly added to _oc_order_.
+	(addValue): Dito, added the same code as for STORE.
+
+1998-08-06  Leif Hedstrom  <leif@netscape.com>
+
+	* Entry.pm (printLDIF): Copied/modified from the Utils.pm library.
+	(isModified): Added this function, thought it might be useful.
+
+1998-08-03  Leif Hedstrom  <leif@netscape.com>
+
+	* Conn.pm (modifyRDN): Fixed! It also has an option to take an
+	"external" DN as an argument, if supplied.
+
+1998-08-02  Leif Hedstrom  <leif@netscape.com>
+
+	* Conn.pm (getErrorCode): Now takes two optional arguments, to
+	return the match string, and extra error string. Note that these
+	two arguments are pointers to strings!
+
+	* API.xs(ldap_get_lderrno): Fixed this function, at least it seems
+	to work now...
+
+	* Conn.pm (getLD): Added this function, convenient way to get the
+	LD from the OO layer.
+
+1998-07-30  Leif Hedstrom  <leif@netscape.com>
+
+	* Conn.pm (modifyRDN): New method, to rename the RDN of the entry.
+
+	* Utils.pm (answer): New function, from LdapUtils.pm.
+
+	* Conn.pm (delete): Fixed references to normalizeDN.
+
+	* Utils.pm (userCredentials): Added this function, to make it easy
+	to get credentials when binding as a user.
+	(normalizeDN): Fixed bugs, because of calling convention...
+
+	* Conn.pm (getError): Fixed bug with passing read-only argument.
+
+1998-07-29  Leif Hedstrom  <leif@netscape.com>
+
+	* Utils.pm (unixCrypt): Moved from my LdapUtils.pm module.
+	Added askPassword to the export tag.
+
+	* Conn.pm (new): Added support for passing a hash array of all the
+	parameters, as returned by the ldapArgs() function.
+
+	* Utils.pm (str2Scope): New function, for converting strings
+	(subtree) to a numerical scope value (2).
+	(askPassword): Dito, ask for a password, interactively.
+	(ldapArgs): Dito, handle common LDAP command line arguments.
+
+	* Makefile.PL: Minor change, to do regex match on OS version for
+	MSWin.
+
+	* Entry.pm: Changed all _XXX hash values to also end with a _,
+	hence making it easier to isolate them (/^_.*_$/).
+
+	* Conn.pm (nextEntry): Changed to accept that the attributes are
+	now arrays, not pointers to arrays. We still consider them as
+	pointers internally though, it's cleaner API.
+
+	* API.pm: Changed to use the native Exporter function to export
+	tags into EXPORT_OK.
+
+1998-07-22  Leif Hedstrom  <leif@netscape.com>
+
+	* LDIF.pm (readEntry): Moved from my LdapUtils.pm package.
+
+	* Utils.pm (printEntry): Moved from the ::Connection class, and
+	marked it as "obsolete".
+	(encodeBase64): Moved from my LdapUtils.pm package.
+	(decodeBase64): Dito.
+

mozilla/directory/perldap/Entry.pm

@@ -0,0 +1,949 @@
+#############################################################################
+# $Id: Entry.pm,v 1.9.2.5 1999-01-05 12:26:35 leif%netscape.com Exp $
+#
+# The contents of this file are subject to the Mozilla Public License
+# Version 1.0 (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 PerLDAP. The Initial Developer of the Original
+# Code is Netscape Communications Corp. and Clayton Donley. Portions
+# created by Netscape are Copyright (C) Netscape Communications
+# Corp., portions created by Clayton Donley are Copyright (C) Clayton
+# Donley. All Rights Reserved.
+#
+# Contributor(s):
+#
+# DESCRIPTION
+#    This package defines an object class to manage one single LDAP
+#    entry. This entry can either be a newly created one, or one
+#    retrieved from an LDAP server, using the Mozilla::LDAP::Conn class.
+#
+#############################################################################
+
+package Mozilla::LDAP::Entry;
+
+use Mozilla::LDAP::Utils qw(normalizeDN);
+require Tie::Hash;
+@ISA = (Tie::StdHash);
+
+
+#############################################################################
+# Creator, make a new tie hash instance, which will keep track of all
+# changes made to the hash array. This is needed so we only update modified
+# attributes.
+#
+sub TIEHASH
+{
+  my $class = shift;
+  my $self = {};
+
+  return bless $self, $class;
+}
+
+
+#############################################################################
+# Destructor.
+#
+#sub DESTROY
+#{
+#}
+
+
+#############################################################################
+# Store method, to keep track of changes.
+#
+sub STORE
+{
+  my ($self, $attr, $val) = ($_[$[], lc $_[$[ + 1], $_[$[ + 2]);
+
+  return unless (defined($val) && ($val ne ""));
+  return unless (defined($attr) && ($attr ne ""));
+
+  if (defined($self->{$attr}))
+    {
+      @{$self->{"_${attr}_save_"}} = @{$self->{$attr}}
+        unless $self->{"_${attr}_save_"};
+    }
+  $self->{$attr} = $val;
+  $self->{"_${attr}_modified_"} = 1;
+
+  # Potentially add the attribute to the OC order list.
+  if (($attr ne "dn") && !grep(/^$attr$/i, @{$self->{"_oc_order_"}}))
+    {
+      push(@{$self->{"_oc_order_"}}, $attr);
+      $self->{"_oc_numattr_"}++;
+    }
+}
+
+
+#############################################################################
+# Fetch method, this is case insensitive (since LDAP is...).
+#
+sub FETCH
+{
+  my ($self, $attr) = ($_[$[], lc $_[$[ + 1]);
+
+  return unless defined($self->{$attr});
+  return if $self->{"_${attr}_deleted_"};
+
+  return $self->{$attr};
+}
+
+
+#############################################################################
+# Delete method, to keep track of changes. Note that we actually don't
+# delete the attribute, just mark it as deleted.
+#
+sub DELETE
+{
+  my ($self, $attr) = ($_[$[], lc $_[$[ + 1]);
+
+  return unless (defined($attr) && ($attr ne ""));
+  return unless defined($self->{$attr});
+
+  $self->{"_${attr}_deleted_"} = 1;
+}
+
+
+#############################################################################
+# See if an attribute/key exists in the entry (could still be undefined).
+#
+sub EXISTS
+{
+  my ($self, $attr) = ($_[$[], lc $_[$[ + 1]);
+
+  return 0 unless (defined($attr) && ($attr ne ""));
+  return 0 if $self->{"_${attr}_deleted_"};
+
+  return exists $self->{$attr};
+}
+
+
+#############################################################################
+# Reset the each()/key() session, and return the first key. This honors
+# the oc_order, i.e. the order the attributes were returned in.
+#
+sub FIRSTKEY
+{
+  my ($self, $idx) = ($_[$[], 0);
+  my @attrs = @{$self->{"_oc_order_"}};
+  my $key;
+
+  while ($idx < $self->{"_oc_numattr_"})
+    {
+      $key = $attrs[$idx++];
+      next if ($key =~ /^_.+_$/);
+      next if $self->{"_${key}_deleted_"};
+      last;
+    }
+  $self->{"_oc_keyidx_"} = $idx;
+
+  return $key;
+}
+
+
+#############################################################################
+# Get the next key, if appropriate.
+#
+sub NEXTKEY
+{
+  my $self = $_[$[];
+  my $idx = $self->{"_oc_keyidx_"};
+  my @attrs = @{$self->{"_oc_order_"}};
+  my $key;
+
+  while ($idx < $self->{"_oc_numattr_"})
+    {
+      $key = $attrs[$idx++];
+      next if ($key =~ /^_.+_$/);
+      next if $self->{"_${key}_deleted_"};
+      last;
+    }
+  $self->{"_oc_keyidx_"} = $idx;
+
+  return if ($key =~ /^_.+_$/);
+  return if $self->{"_${key}_deleted_"};
+  return $key;
+}
+
+
+#############################################################################
+# Mark an attribute as changed. Normally you shouldn't have to use this,
+# unless you're doing something really weird...
+#
+sub attrModified
+{
+  my ($self, $attr) = ($_[$[], lc $_[$[ + 1]);
+
+  return 0 unless (defined($attr) && ($attr ne ""));
+  return 0 unless defined($self->{$attr});
+  return 0 if $self->{"_${attr}_deleted_"};
+
+  @{$self->{"_${attr}_save_"}} = @{$self->{$attr}}
+    unless $self->{"_${attr}_save_"};
+  $self->{"_self_obj_"}->{"_${attr}_modified_"} = 1;
+
+  return 1;
+}
+*markModified = \*attrModified;
+
+
+#############################################################################
+# Ask if a particular attribute has been modified already. Return True or
+# false depending on the internal status of the attribute.
+#
+sub isModified
+{
+  my ($self, $attr) = ($_[$[], lc $_[$[ + 1]);
+
+  return 0 unless (defined($attr) && ($attr ne ""));
+  return 0 unless defined($self->{$attr});
+  return $self->{"_self_obj_"}->{"_${attr}_modified_"};
+}
+
+
+#############################################################################
+# Ask if a particular attribute has been deleted already. Return True or
+# false depending on the internal status of the attribute.
+#
+sub isDeleted
+{
+  my ($self, $attr) = ($_[$[], lc $_[$[ + 1]);
+
+  return 0 unless (defined($attr) && ($attr ne ""));
+  return 0 unless defined($self->{$attr});
+
+  return $self->{"_self_obj_"}->{"_${attr}_deleted_"};
+}
+
+
+#############################################################################
+# Test if a attribute name is actually a real attribute, and not part of
+# the internal structures.
+#
+sub isAttr
+{
+  my ($self, $attr) = ($_[$[], lc $_[$[ + 1]);
+
+  return 0 unless (defined($attr) && ($attr ne ""));
+  return 0 unless defined($self->{$attr});
+  return 0 if $self->{"_${attr}_deleted_"};
+
+  return ($attr !~ /^_.+_$/);
+}
+
+
+#############################################################################
+# Remove an attribute from the entry, basically the same as the DELETE
+# method. We also make an alias for "delete" here, just in case (and to be
+# somewhat backward compatible).
+#
+sub remove
+{
+  my ($self, $attr) = ($_[$[], lc $_[$[ + 1]);
+
+  return 0 unless (defined($attr) && ($attr ne ""));
+  return 0 unless defined($self->{$attr});
+
+  $self->{"_self_obj_"}->{"_${attr}_deleted_"} = 1;
+
+  return 1;
+}
+*delete = \*remove;
+
+
+#############################################################################
+# Undo a remove(), or set of removeValues() fairly useless, to restore an
+# attribute to it's original state. This is fairly useless, but hey...
+#
+sub unRemove
+{
+  my ($self, $attr) = ($_[$[], lc $_[$[ + 1]);
+
+  return 0 unless (defined($attr) && ($attr ne ""));
+  return 0 unless defined($self->{$attr});
+
+  undef $self->{"_self_obj_"}->{"_${attr}_deleted_"};
+  if (defined $self->{"_${attr}_save_"})
+    {
+      @{$self->{$attr}} = @{$self->{"_${attr}_save_"}};
+      undef @{$selfl->{"_${key}_save_"}};
+    }
+
+  return 1;
+}
+*unDelete = \*unRemove;
+
+
+#############################################################################
+# Delete a value from an attribute, if it exists. NOTE: If it was the last
+# value, we'll actually remove the entire attribute! We should then also
+# remove it from the _oc_order_ list...
+#
+sub removeValue
+{
+  my ($self, $attr, $val, $norm) = ($_[$[], lc $_[$[ + 1], $_[$[ + 2],
+				    $_[$[ + 3]);
+  my $i = 0;
+  local $_;
+
+  return 0 unless (defined($val) && ($val ne ""));
+  return 0 unless (defined($attr) && ($attr ne ""));
+  return 0 unless defined($self->{$attr});
+
+  $val = normalizeDN($val) if (defined($norm) && $norm);
+  @{$self->{"_${attr}_save_"}} = @{$self->{$attr}} unless
+    defined $self->{"_${attr}_save_"};
+
+  foreach (@{$self->{$attr}})
+    {
+      $_ = normalizeDN($_) if (defined($norm) && $norm);
+      if ($_ eq $val)
+	{
+	  splice(@{$self->{$attr}}, $i, 1);
+	  if ($self->size($attr) > 0)
+	    {
+	      $self->{"_self_obj_"}->{"_${attr}_modified_"} = 1;
+	    }
+	  else
+	    {
+	      $self->{"_self_obj_"}->{"_${attr}_deleted_"} = 1;
+	    }
+
+	  return 1;
+	}
+      $i++;
+    }
+
+  return 0;
+}
+*deleteValue = \*removeValue;
+
+
+#############################################################################
+# Just like removeValue(), but force the DN normalization of the value.
+#
+sub removeDNValue
+{
+  my ($self, $attr, $val) = ($_[$[], lc $_[$[ + 1], $_[$[ + 2]);
+
+  return $self->removeValue($attr, $val, 1);
+}
+*deleteDNValue = \*removeDNValue;
+
+
+#############################################################################
+# Add a value to an attribute. The optional third argument indicates that
+# we should not enforce the uniqueness on this attibute, thus bypassing
+# the test and always add the value.
+#
+sub addValue
+{
+  my $self = shift;
+  my ($attr, $val, $force, $norm) = (lc $_[$[], $_[$[ + 1], $_[$[ + 2],
+				     $_[$[ + 3]);
+  local $_;
+
+  return 0 unless (defined($val) && ($val ne ""));
+  return 0 unless (defined($attr) && ($attr ne ""));
+
+  if (!defined($force) || !$force)
+    {
+      my $nval = $val;
+
+      $nval = normalizeDN($val) if (defined($norm) && $norm);
+      foreach (@{$self->{$attr}})
+        {
+	  $_ = normalizeDN($_) if (defined($norm) && $norm);
+          return 0 if ($_ eq $nval);
+        }
+    }
+
+  if (defined($self->{$attr}))
+    {
+      @{$self->{"_${attr}_save_"}} = @{$self->{$attr}}
+        unless $self->{"_${attr}_save_"};
+    }
+
+  $self->{"_self_obj_"}->{"_${attr}_modified_"} = 1;
+  push(@{$self->{$attr}}, $val);
+
+  # Potentially add the attribute to the OC order list.
+  if (($attr ne "dn") && !grep(/^$attr$/i, @{$self->{"_oc_order_"}}))
+    {
+      push(@{$self->{"_oc_order_"}}, $attr);
+      $self->{"_oc_numattr_"}++;
+    }
+
+  return 1;
+}
+
+
+#############################################################################
+# Just like addValue(), but force the DN normalization of the value. Note
+# that we also have an $norm argument here, to normalize the DN value
+# before we add it.
+#
+sub addDNValue
+{
+  my $self = shift;
+  my ($attr, $val, $force, $norm) = (lc $_[$[], $_[$[ + 1], $_[$[ + 2],
+				     $_[$[ + 2]);
+
+  $val = normalizeDN($val) if (defined($norm) && $norm);
+  return $self->addValue($attr, $val, $force, 1);
+}
+
+
+#############################################################################
+# Set the entire value of an attribute, removing whatever was already set.
+# The arguments are the name of the attribute, and then one or more values,
+# passed as scalar or an array (not pointer).
+#
+sub setValue
+{
+  my ($self, $attr) = (shift, lc shift);
+  my (@vals) = @_;
+  local $_;
+
+  return 0 unless (defined(@vals) && ($#vals >= $[));
+  return 0 unless (defined($attr) && ($attr ne ""));
+
+  $self->{$attr} = [@vals];
+  return 1;
+}
+
+
+#############################################################################
+# Return TRUE or FALSE, if the attribute has the specified value. The
+# optional third argument says we should do case insensitive search.
+#
+sub hasValue
+{
+  my($self, $attr, $val, $nocase, $norm) = @_;
+
+  return 0 unless (defined($val) && ($val ne ""));
+  return 0 unless (defined($attr) && ($attr ne ""));
+  return 0 unless defined($self->{$attr});
+
+  $val = normalizeDN($val) if (defined($norm) && $norm);
+  if ($nocase)
+    {
+      foreach (@{$self->{$attr}})
+	{
+	  $_ = normalizeDN($_) if (defined($norm) && $norm);
+	  return 1 if /^\Q$val\E$/i;
+	}
+    }
+  else
+    {
+      foreach (@{$self->{$attr}})
+	{
+	  $_ = normalizeDN($_) if (defined($norm) && $norm);
+	  return 1 if /^\Q$val\E$/;
+	}
+    }
+
+  return 0;
+}
+
+
+#############################################################################
+# Just like hasValue(), but force the DN normalization of the value.
+#
+sub hasDNValue
+{
+  my($self, $attr, $val, $nocase) = @_;
+
+  return $self->hasValue($attr, $val, $nocase, 1);
+}
+
+
+#############################################################################
+# Return TRUE or FALSE, if the attribute matches the specified regexp. The
+# optional third argument says we should do case insensitive search.
+#
+sub matchValue
+{
+  my($self, $attr, $reg, $nocase) = @_;
+
+  return 0 unless (defined($reg) && ($reg ne ""));
+  return 0 unless (defined($attr) && ($attr ne ""));
+  return 0 unless defined($self->{$attr});
+
+  if ($nocase)
+    {
+      foreach (@{$self->{$attr}})
+	{
+	  $_ = normalizeDN($_);
+	  return 1 if /$reg/i;
+	}
+    }
+  else
+    {
+      foreach (@{$self->{$attr}})
+	{
+	  $_ = normalizeDN($_);
+	  return 1 if /$reg/;
+	}
+    }
+
+  return 0;
+}
+
+
+#############################################################################
+# Just like matchValue(), but force the DN normalization of the values.
+#
+sub matchDNValue
+{
+  my($self, $attr, $reg, $nocase) = @_;
+
+  return $self->matchValue($attr, $reg, $nocase, 1);
+}
+
+
+#############################################################################
+# Set the DN of this entry.
+#
+sub setDN
+{
+  my ($self, $val, $norm) = @_;
+
+  return 0 unless (defined($val) && ($val ne ""));
+
+  $val = normalizeDN($val) if (defined($norm) && $norm);
+  $self->{"dn"} = $val;
+
+  return 1;
+}
+
+
+#############################################################################
+# Get the DN of this entry.
+#
+sub getDN
+{
+  my ($self, $norm) = @_;
+
+  return normalizeDN($self->{"dn"}) if (defined($norm) && $norm);
+  return $self->{"dn"};
+}
+
+
+#############################################################################
+#
+# Return the number of elements in an attribute.
+#
+sub size
+{
+  my ($self, $attr) = ($_[$[], lc $_[$[ + 1]);
+  my @val;
+
+  return 0 unless (defined($attr) && ($attr ne ""));
+  return 0 unless defined($self->{$attr});
+
+  @val = @{$self->{$attr}};
+  return $#val + 1;
+}
+
+
+#############################################################################
+#
+# Return TRUE if the attribute name is in the LDAP entry.
+#
+sub exists
+{
+  my ($self, $attr) = ($_[$[], lc $_[$[ + 1]);
+
+  return 0 unless (defined($attr) && ($attr ne ""));
+
+  return defined($self->{$attr});
+}
+
+
+#############################################################################
+# Print an entry, in LDIF format. This is idential to the Utils::printEntry
+# function, but this is sort of neat... Note that the support for Base64
+# encoding isn't finished.
+#
+sub printLDIF
+{
+  my ($self, $base64) = @_;
+  my $attr;
+
+  print "dn: ", $self->getDN(),"\n";
+  foreach $attr (@{$self->{"_oc_order_"}})
+    {
+      next if ($attr =~ /^_.+_$/);
+      next if $self->{"_${attr}_deleted_"};
+      grep((print "$attr: $_\n"), @{$self->{$attr}});
+    }
+
+  print "\n";
+}
+
+
+#############################################################################
+# Mandatory TRUE return value.
+#
+1;
+
+
+#############################################################################
+# POD documentation...
+#
+__END__
+
+=head1 NAME
+
+  Mozilla::LDAP::Entry.pm - Object class to hold one LDAP entry.
+
+=head1 SYNOPSIS
+
+  use Mozilla::LDAP::Conn;
+  use Mozilla::LDAP::Entry;
+
+=head1 ABSTRACT
+
+The LDAP::Conn object is used to perform LDAP searches, updates, adds and
+deletes. All such functions works on LDAP::Entry objects only. All
+modifications and additions you'll do to an LDAP entry, will be done
+through this object class.
+
+=head1 DESCRIPTION
+
+The LDAP::Entry object class is built on top of the Tie::Hash standard
+object class. This gives us several powerful features, the main one being
+to keep track of what is changing in the LDAP entry. This makes it very
+easy to write LDAP clients that needs to update/modify entries, since
+you'll just do the changes, and this object class will take care of the
+rest.
+
+We define local functions for STORE, FETCH, DELETE, EXISTS, FIRSTKEY and
+NEXTKEY in this object class, and inherit the rest from the super
+class. Overloading these specific functions is how we can keep track of
+what is changing in the entry, which turns out to be very convenient. We
+can also easily "loop" over the attribute types, ignoring internal data,
+or deleted attributes.
+
+Most of the methods here either return the requested LDAP value, or a
+status code. The status code (either 0 or 1) indicates the failure or
+success of a certain operation. 0 (False) meaning the operation failed,
+and a return code of 1 (True) means complete success.
+
+One thing to remember is that in LDAP, attribute names are case
+insensitive. All methods in this class are aware of this, and will convert
+all attribute name arguments to lower case before performing any
+operations. This does not mean that the values are case insensitive. On
+the contrary, all values are considered case sensitive by this module,
+even if the LDAP server itself treats it as a CIS attribute.
+
+=head1 OBJECT CLASS METHODS
+
+The LDAP::Entry class implements many methods you can use to access and
+modify LDAP entries. It is strongly recommended that you use this API as
+much as possible, and avoid using the internals of the class
+directly. Failing to do so may actually break the functionality.
+
+=head2 Creating a new entry
+
+To create a completely new entry, use the B<new> method, for instance
+
+    $entry = new Mozilla::LDAP::Entry()
+    $entry->setDN("uid=leif,ou=people,dc=netscape,dc=com");
+    $entry->{objectclass} = [ "top", "person", "inetOrgPerson" ];
+    $entry->addValue("cn", "Leif Hedstrom");
+    $entry->addValue("sn", "Hedstrom");
+    $entry->addValue("givenName", "Leif");
+    $entry->addValue("mail", "leif@netscape.com);
+
+    $conn->add($entry);
+
+This is the minimum requirements for an LDAP entry. It must have a DN, and
+it must have at least one objectclass. As it turns out, by adding the
+I<person> and I<inetOrgPerson> classes, we also must provide some more
+attributes, like I<CN> and I<SN>. This is because the object classes have
+these attributes marked as "required", and we'd get a schema violation
+without those values.
+
+In the example above we use both native API methods to add values, and
+setting an attribute entire value set directly. Note that the value set is
+a pointer to an array, and not the array itself. In the example above, the
+object classes are set using an anonymous array, which the API handles
+properly. It's important to be aware that the attribute value list is
+indeed a pointer.
+
+Finally, as you can see there's only only one way to add new LDAP entries,
+and it's called add(). It normally takes an LDAP::Entry object instance as
+argument, but it can also be called with a regular hash array if so
+desired.
+
+=head2 Adding and removing attributes and values
+
+This is the main functionality of this module. Use these methods to do any
+modifications and updates to your LDAP entries.
+
+=over 13
+
+=item B<attrModified>
+
+This is an internal function, that can be used to force the API to
+consider an attribute (value) to have been modified. The only argument is
+the name of the attribute. In almost all situation, you never, ever,
+should call this. If you do, please contact the developers, and as us to
+fix the API. Example
+
+    $entry->attrModified("cn");
+
+=item B<isModified>
+
+This is a somewhat more useful method, which will return the internal
+modification status of a particular attribute. The argument is the name of
+the attribute, and the return value is True or False. If the attribute has
+been modified, in any way, we return True (1), otherwise we return False
+(0). For example:
+
+    if ($entry->isModified("cn")) { # do something }
+
+=item B<isDeleted>
+
+This is almost identical to B<isModified>, except it tests if an attribute
+has been deleted. You use it the same way as above, like
+
+    if (! $entry->isDeleted("cn")) { # do something }
+
+=item B<isAttr>
+
+This method can be used to decide if an attribute name really is a valid
+LDAP attribute in the current entry. Use of this method is fairly limited,
+but could potentially be useful. Usage is like previous examples, like
+
+    if ($entry->isAttr("cn")) { # do something }
+
+The code section will only be executed if these criterias are true:
+
+    1. The name of the attribute is a non-empty string.
+    2. The name of the attribute does not begin, and end, with an
+       underscore character (_).
+    2. The attribute has one or more values in the entry.
+
+=item B<remove>
+
+This will remove the entire attribute, including all it's values, from the
+entry. The only argument is the name of the attribute to remove. Let's say
+you want to nuke all I<mailAlternateAddress> values (i.e. the entire
+attribute should be removed from the entry):
+
+    $entry->remove("mailAlternateAddress");
+
+=item B<removeValue>
+
+Remove a value from an attribute, if it exists. Of course, if the
+attribute has no such value, we won't try to remove it, and instead return
+a False (0) status code. The arguments are the name of the attribute, and
+the particular value to remove. Note that values are considered case
+sensitive, so make sure you preserve case properly. An example is:
+
+    $entry->removeValue("objectclass", "nscpPerson");
+
+=item B<removeDNValue>
+
+This is almost identical to B<removeValue>, except it will normalize the
+attribute values before trying to remove them. This is useful if you know
+that the attribute is a DN value, but perhaps the values are not cosistent
+in all LDAP entries. For example
+
+   $dn = "uid=Leif, dc=Netscape, dc=COM";
+   $entry->removeDNValue("owner", $dn);
+
+
+will remove the owner "uid=leif,dc=netscape,dc=com", no matter how it's
+capitalized and formatted in the entry.
+
+=item B<addValue>
+
+Add a value to an attribute. If the attribute value already exists, or we
+couldn't add the value for any other reason, we'll return FALSE (0),
+otherwise we return TRUE (1). The first two arguments are the attribute
+name, and the value to add.
+
+The optional third argument is a flag, indicating that we want to add the
+attribute without checking for duplicates. This is useful if you know the
+values are unique already, or if you perhaps want to allow duplicates for
+a particular attribute. To add a CN to an existing entry/attribute, do:
+
+    $entry->addValue("cn", "Leif Hedstrom");
+
+=item B<addDNValue>
+
+Just like B<addValue>, except this method assume the value is a DN
+attribute. For instance
+
+   $dn = "uid=Leif, dc=Netscape, dc=COM";
+   $entry->addDNValue("uniqueMember", $dn);
+
+
+will only add the DN for "uid=leif" if it does not exist as a DN in the
+uniqueMember attribute.
+
+=item B<setValue>
+
+Set the specified attribute to the new value (or values), overwriting
+whatever old values it had before. This is a little dangerous, since you
+can lose attribute values you didn't intend to remove. Therefore, it's
+usually recommended to use B<removeValue()> and B<setValue()>. If you know
+exactly what the new values should be like, you can use this method like
+
+    $entry->setValue("cn", "Leif Hedstrom", "The Swede");
+    $entry->setValue("mail", @mailAddresses);
+
+or if it's a single value attribute,
+
+    $entry->setValue("uidNumber", "12345");
+
+=item B<hasValue>
+
+Return TRUE or FALSE if the attribute has the specified value. A typical
+usage is to see if an entry is of a certain object class, e.g.
+
+    if ($entry->hasValue("objectclass", "person", 1)) { # do something }
+
+The (optional) third argument indicates if the string comparison should be
+case insensitive or not. The first two arguments are the name and value of
+the attribute, as usual.
+
+=item B<hasDNValue>
+
+Exactly like B<hasValue>, except we assume the attribute values are DN
+attributes.
+
+=item B<matchValue>
+
+This is very similar to B<hasValue>, except it does a regular expression
+match instead of a full string match. It takes the same arguments,
+including the optional third argument to specify case insensitive
+matching. The usage is identical to the example for hasValue, e.g.
+
+    if ($entry->matchValue("objectclass", "pers", 1)) { # do something }
+
+=item B<matchDNValue>
+
+Like B<matchValue>, except the attribute values are considered being DNs.
+
+=item B<setDN>
+
+Set the DN to the specified value. Only do this on new entries, it will
+not work well if you try to do this on an existing entry. If you wish to
+renamed an entry, use the Mozilla::Conn::modifyRDN method instead.
+Eventually we'll provide a complete "rename" method. To set the DN for a
+newly created entry, we can do
+
+    $entry->setDN("uid=leif,ou=people,dc=netscape,dc=com");
+
+There is an optional third argument, a boolean flag, indicating that we
+should normalize the DN before setting it. This will assure a consistent
+format of your DNs.
+
+=item B<getDN>
+
+Return the DN for the entry. For instance
+
+    print "The DN is: ", $entry->getDN(), "\n";
+
+Just like B<setDN>, this method also has an optional argument, which
+indicates we should normalize the DN before returning it to the caller.
+
+=item B<size>
+
+Return the number of values for a particular attribute. For instance
+
+    $entry->{cn} = [ "Leif Hedstrom", "The Swede" ];
+    $numVals = $entry->size("cn");
+
+This will set C<$numVals> to two (2). The only argument is the name of the
+attribute, and the return value is the size of the value array.
+
+=item B<exists>
+
+Return TRUE if the specified attribute is defined in the LDAP entry. This
+is useful to know if an entry has a particular attribute, regardless of
+the value. For instance:
+
+    if ($entry->exists("jpegphoto")) { # do something special }
+
+=item B<printLDIF>
+
+Print the entry (on STDOUT) in a format called LDIF (LDAP Data Interchange
+Format, RFC xxxx). An example of an LDIF entry is:
+
+    dn: uid=leif,ou=people,dc=netscape,dc=com
+    objectclass: top
+    objectclass: person
+    objectclass: inetOrgPerson
+    uid: leif
+    cn: Leif Hedstrom
+    mail: leif@netscape.com
+
+The above would be the result of
+
+    $entry->printLDIF();
+
+If you need to write to a file, close STDOUT, and open up a file with that
+file handle instead. For more useful LDIF functionality, check out the
+Mozilla::LDAP::LDIF.pm module.
+
+=back
+
+=head2 Deleting entries
+
+To delete an LDAP entry from the LDAP server, you have to use the
+B<delete> method from the Mozilla::LDAP::Conn module. It will actually
+delete any entry, if you provide an legitimate DN.
+
+=head2 Renaming entries
+
+Again, there's no functionality in this object class to rename the entry
+(i.e. changing it's DN). For now, there is a way to modify the RDN
+component of a DN through the Mozilla::LDAP::Conn module, with
+B<modifyRDN>. Eventually we hope to have a complete B<rename> method,
+which should be capable of renaming any entry, in any way, including
+moving it to a different part of the DIT (Directory Information Tree).
+
+=head1 EXAMPLES
+
+There are plenty of examples to look at, in the examples directory. We are
+adding more examples every day (almost).
+
+=head1 INSTALLATION
+
+Installing this package is part of the Makefile supplied in the
+package. See the installation procedures which are part of this package.
+
+=head1 AVAILABILITY
+
+This package can be retrieved from a number of places, including:
+
+    http://www.mozilla.org/directory/
+    Your local CPAN server
+
+=head1 CREDITS
+
+Most of this code was developed by Leif Hedstrom, Netscape Communications
+Corporation. 
+
+=head1 BUGS
+
+None. :)
+
+=head1 SEE ALSO
+
+L<Mozilla::LDAP::Conn>, L<Mozilla::LDAP::API>, and of course L<Perl>.
+
+=cut

mozilla/directory/perldap/INSTALL

@@ -0,0 +1,98 @@
+PerLDAP installation instructions
+==================================
+
+Building this package is fairly straight forward, but requires some
+knowledge about using compilers and compiler tools on your system. If you
+are uncomfortable using these tools, we recommend you get one of the
+prebuilt binary distributions instead.
+
+
+Prerequisites
+=============
+
+In order to build the module, you'll need
+
+	- Perl, version 5.003 or later. We definitely recommend you to use
+          v5.004 or later.
+
+	- An ANSI-C compiler, e.g. gcc-2.x, or Visual C++ 5.0.
+
+	- The LDAP client libraries and include files, e.g. the SDK from
+	Netscape Communications. See the README file for information on
+	retrieving binaries.
+
+You can download (or CVS checkout) the Directory SDK source, see further
+information available on
+
+	http://www.mozilla.org/directory/
+
+and the FAQ at
+
+	http://www.mozilla.org/directory/faq/perldap-faq.html
+
+
+
+Building
+========
+
+This package uses the normal Perl5 MakeMaker installation system. To
+generate a Makefile appropriate for your platform, run perl on the
+provided Makefile.PL script, e.g.
+
+	% perl Makefile.PL
+
+
+You might have to use the command `perl5' or `perl-5.004', depending on
+how you installed Perl-5. The script will now ask you a few questions to
+find the necessary library and include files. A typical configuration
+session is
+
+    data 195% perl5 Makefile.PL
+
+    PerLDAP - Perl 5 Module for LDAP
+    ================================
+    Directory containing 'include' and 'lib' directory of the Netscape
+    LDAP Software Developer Kit (default: /usr): /opt/ldapsdk3
+    Using LDAPv3 Developer Kit (default: yes)?  
+    Include SSL Support (default: yes)?  
+    Libraries to link with (default: -L/opt/pkg/ldapsdk3/lib -lldapssl30):  
+    Checking if your kit is complete...
+    Looks good
+    Writing Makefile for Mozilla::LDAP::API
+
+
+
+The important question is where your LDAP SDK is installed, in the example
+above the base directory is /opt/ldapsdk3. This directory should have two
+subdirectories, named "lib" and "include". If you installed the SDK in the
+standard /usr hierarchy, use the default value as provided by the install
+script.
+
+Assuming you get no errors or warning, proceed with the build and install:
+
+	% make
+	% make install
+
+
+That should be it!
+
+
+Automated Configuration and Installs
+====================================
+
+The Makefile.PL script also honors a set of environment variables to make
+it possible to do configuration and installs non-interactively. The
+variables are
+
+        LDAPSDKDIR    - Full path to the C SDK base directory
+        LDAPV3ON      - Set to "N" to diable LDAP v3 (on by default)
+        LDAPSDKSSL    - Set to "N" to disable SSL (SSL is default)
+
+
+With these variables set, you will not be asked any of the questions above
+(but it will echo the paramaters). Just run the Makefile.PL script, and
+finish the build, e.g.
+
+        % perl5 Makefile.PL
+	% make
+	% make install

mozilla/directory/perldap/LDIF.pm

@@ -0,0 +1,274 @@
+#############################################################################
+# $Id: LDIF.pm,v 1.5.2.3 1998-09-27 00:08:09 leif%netscape.com Exp $
+#
+# The contents of this file are subject to the Mozilla Public License
+# Version 1.0 (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 PerLDAP. The Initial Developer of the Original
+# Code is Netscape Communications Corp. and Clayton Donley. Portions
+# created by Netscape are Copyright (C) Netscape Communications
+# Corp., portions created by Clayton Donley are Copyright (C) Clayton
+# Donley. All Rights Reserved.
+#
+# Contributor(s):
+#
+# DESCRIPTION
+#    Simple routines to read and write LDIF style files. You should open
+#    the input/output file manually, or use STDIN/STDOUT.
+#
+#############################################################################
+
+package Mozilla::LDAP::LDIF;
+
+use Mozilla::LDAP::Entry;
+use Mozilla::LDAP::Utils(qw(decodeBase64));
+
+
+#############################################################################
+# Creator, the argument (optional) is the file handle.
+#
+sub new
+{
+  my ($class, $fh) = @_;
+  my $self = {};
+
+  if ($fh)
+    {
+      $self->{"_fh_"} = $fh;
+      $self->{"_canRead_"} = 1;
+      $self->{"_canWrite_"} = 1;
+    }
+  else
+    {
+      $self->{"_fh_"} = STDIN;
+      $self->{"_canRead_"} = 1;
+      $self->{"_canWrite_"} = 0;
+    }
+
+  return bless $self, $class;
+}
+
+
+#############################################################################
+# Destructor, close file descriptors etc. (???)
+#
+#sub DESTROY
+#{
+#  my $self = shift;
+#}
+
+
+#############################################################################
+# Read the next $entry from an ::LDIF object. No arguments
+#
+sub readOneEntry
+{
+  my ($self) = @_;
+  my ($attr, $val, $entry, $base64, $fh);
+  local $_;
+
+  return unless $self->{"_canRead_"};
+  return unless defined($self->{"_fh_"});
+
+  # Skip leading empty lines.
+  $fh = $self->{"_fh_"};
+  while (<$fh>)
+    {
+      chop;
+      last unless /^\s*$/;
+    }
+  return if /^$/;		# EOF
+
+  $self->{"_canWrite_"} = 0 if $self->{"_canWrite_"};
+
+  $entry = new Mozilla::LDAP::Entry();
+  do
+    {
+      # See if it's a continuation line.
+      if (/^ /o)
+	{
+	  $val .= substr($_, 1);
+	}
+      else
+	{
+	  if ($val && $attr)
+	    {
+	      if ($attr eq "dn")
+		{
+		  $entry->setDN($val);
+		}
+	      else
+		{
+		  $val = decodeBase64($val) if $base64;
+		  $entry->addValue($attr, "$val", 1);
+		}
+	    }
+	  ($attr, $val) = split(/:\s+/, $_, 2);
+	  $attr = lc $attr;
+
+	  # Handle base64'ed data.
+	  if ($attr =~ /:$/o)
+	    {
+	      $base64 = 1;
+	      chop($attr);
+	    }
+	  else
+	    {
+	      $base64 = 0;
+	    }
+	}
+
+      $_ = <$fh>;
+      chop;
+    } until /^\s*$/;
+
+  # Do the last attribute...
+  if ($attr && ($attr ne "dn"))
+    {
+      $val = decodeBase64($val) if $base64;
+      $entry->addValue($attr, "$val", 1);
+    }
+
+  return $entry;
+}
+*readEntry = \readOneEntry;
+
+
+#############################################################################
+# Print one entry, to the file handle. Note that we actually use some
+# internals from the ::Entry object here, which is a no-no... Also, we need
+# to support Base64 encoding of Binary attributes here.
+#
+sub writeOneEntry
+{
+  my ($self, $entry) = @_;
+  my ($fh, $attr);
+
+  return unless $self->{"_canWrite_"};
+  $self->{"_canRead_"} = 0 if $self->{"_canRead_"};
+
+  $fh = $self->{"_fh_"};
+  print $fh "dn: ", $entry->getDN(),"\n";
+  foreach $attr (@{$entry->{"_oc_order_"}})
+    {
+      next if ($attr =~ /^_.+_$/);
+      next if $entry->{"_${attr}_deleted_"};
+      # TODO: Add support for Binary attributes.
+      grep((print $fh "$attr: $_\n"), @{$entry->{$attr}});
+    }
+
+  print $fh "\n";
+}
+*writeEntry = \writeOneEntry;
+
+
+#############################################################################
+# Read multiple entries, and return an array of Entry objects. The argument
+# is the number to read, or read them all if not specified.
+#
+sub readEntries
+{
+  my ($self, $num) = @_;
+  my $entry;
+  my (@entries);
+
+  return if (defined($num) && ($num ne "") && ($num <= 0));
+  $num = (-1) unless defined($num);
+
+  do 
+    {
+      $entry = $self->readOneEntry();
+      push(@entries, $entry) if ($entry);
+      $num--;
+    } until (! $entry || $num == 0);
+      
+  return @entries;
+}
+
+
+#############################################################################
+# Write multiple entries, the argument is the array of Entry objects.
+#
+sub writeEntries
+{
+  my ($self, @entries) = @_;
+  local $_;
+  
+  foreach (@entries)
+    {
+      $self->writeOneEntry($_);
+    }
+}
+
+
+#############################################################################
+# Mandatory TRUE return value.
+#
+1;
+
+
+#############################################################################
+# POD documentation...
+#
+__END__
+
+=head1 NAME
+
+Mozilla::LDAP::LDIF - Read, write and modify LDIF files.
+
+=head1 SYNOPSIS
+
+  use Mozilla::LDAP::LDIF;
+
+=head1 ABSTRACT
+
+This package is used to read and write LDIF information from files
+(actually, file handles). It can also be used to generate LDIF modify
+files from changes made to an entry.
+
+=head1 DESCRIPTION
+
+The LDIF format is a simple, yet useful, text representation of an LDAP
+database. The goal of this package is to make it as easy as possible to
+read, parse and use LDIF data, possible generated from other information
+sources.
+
+=head1 EXAMPLES
+
+There are plenty of examples to look at, in the examples directory. We are
+adding more examples every day (almost).
+
+=head1 INSTALLATION
+
+Installing this package is part of the Makefile supplied in the
+package. See the installation procedures which are part of this package.
+
+=head1 AVAILABILITY
+
+This package can be retrieved from a number of places, including:
+
+    http://www.mozilla.org/directory/
+    Your local CPAN server
+
+=head1 CREDITS
+
+Most of this code was developed by Leif Hedstrom, Netscape Communications
+Corporation. 
+
+=head1 BUGS
+
+None. :)
+
+=head1 SEE ALSO
+
+L<Mozilla::LDAP::Conn>, L<Mozilla::LDAP::Entry>, L<Mozilla::LDAP::API>,
+and of course L<Perl>.
+
+=cut

mozilla/directory/perldap/MANIFEST

@@ -0,0 +1,33 @@
+ChangeLog
+API.pm
+API.xs
+MANIFEST
+Makefile.PL
+constant.h
+test.pl
+typemap
+Entry.pm
+Conn.pm
+LDIF.pm
+Utils.pm
+README
+INSTALL
+MPL-1.0.txt
+test_api/search.pl
+test_api/write.pl
+test_api/api.pl
+t/conn.pl
+t/entry.pl
+t/ChangeLog
+examples/ChangeLog
+examples/lfinger.pl
+examples/qsearch.pl
+examples/monitor.pl
+examples/ldappasswd.pl
+examples/rmentry.pl
+examples/tabdump.pl
+examples/modattr.pl
+examples/rename.pl
+examples/psoftsync.pl
+examples/changes2ldif.pl
+install-bin

mozilla/directory/perldap/MPL-1.0.txt

@@ -0,0 +1,360 @@
+                           MOZILLA PUBLIC LICENSE
+                                Version 1.0
+
+                              ----------------
+
+1. Definitions.
+
+     1.1. ``Contributor'' means each entity that creates or contributes to
+     the creation of Modifications.
+
+     1.2. ``Contributor Version'' means the combination of the Original
+     Code, prior Modifications used by a Contributor, and the Modifications
+     made by that particular Contributor.
+
+     1.3. ``Covered Code'' means the Original Code or Modifications or the
+     combination of the Original Code and Modifications, in each case
+     including portions thereof.
+
+     1.4. ``Electronic Distribution Mechanism'' means a mechanism generally
+     accepted in the software development community for the electronic
+     transfer of data.
+
+     1.5. ``Executable'' means Covered Code in any form other than Source
+     Code.
+
+     1.6. ``Initial Developer'' means the individual or entity identified as
+     the Initial Developer in the Source Code notice required by Exhibit A.
+
+     1.7. ``Larger Work'' means a work which combines Covered Code or
+     portions thereof with code not governed by the terms of this License.
+
+     1.8. ``License'' means this document.
+
+     1.9. ``Modifications'' means any addition to or deletion from the
+     substance or structure of either the Original Code or any previous
+     Modifications. When Covered Code is released as a series of files, a
+     Modification is:
+
+          A. Any addition to or deletion from the contents of a file
+          containing Original Code or previous Modifications.
+
+          B. Any new file that contains any part of the Original Code or
+          previous Modifications.
+
+     1.10. ``Original Code'' means Source Code of computer software code
+     which is described in the Source Code notice required by Exhibit A as
+     Original Code, and which, at the time of its release under this License
+     is not already Covered Code governed by this License.
+
+     1.11. ``Source Code'' means the preferred form of the Covered Code for
+     making modifications to it, including all modules it contains, plus any
+     associated interface definition files, scripts used to control
+     compilation and installation of an Executable, or a list of source code
+     differential comparisons against either the Original Code or another
+     well known, available Covered Code of the Contributor's choice. The
+     Source Code can be in a compressed or archival form, provided the
+     appropriate decompression or de-archiving software is widely available
+     for no charge.
+
+     1.12. ``You'' means an individual or a legal entity exercising rights
+     under, and complying with all of the terms of, this License or a future
+     version of this License issued under Section 6.1. For legal entities,
+     ``You'' includes any entity which controls, is controlled by, or is
+     under common control with You. For purposes of this definition,
+     ``control'' means (a) the power, direct or indirect, to cause the
+     direction or management of such entity, whether by contract or
+     otherwise, or (b) ownership of fifty percent (50%) or more of the
+     outstanding shares or beneficial ownership of such entity.
+
+2. Source Code License.
+
+     2.1. The Initial Developer Grant.
+     The Initial Developer hereby grants You a world-wide, royalty-free,
+     non-exclusive license, subject to third party intellectual property
+     claims:
+
+          (a) to use, reproduce, modify, display, perform, sublicense and
+          distribute the Original Code (or portions thereof) with or without
+          Modifications, or as part of a Larger Work; and
+
+          (b) under patents now or hereafter owned or controlled by Initial
+          Developer, to make, have made, use and sell (``Utilize'') the
+          Original Code (or portions thereof), but solely to the extent that
+          any such patent is reasonably necessary to enable You to Utilize
+          the Original Code (or portions thereof) and not to any greater
+          extent that may be necessary to Utilize further Modifications or
+          combinations.
+
+     2.2. Contributor Grant.
+     Each Contributor hereby grants You a world-wide, royalty-free,
+     non-exclusive license, subject to third party intellectual property
+     claims:
+
+          (a) to use, reproduce, modify, display, perform, sublicense and
+          distribute the Modifications created by such Contributor (or
+          portions thereof) either on an unmodified basis, with other
+          Modifications, as Covered Code or as part of a Larger Work; and
+
+          (b) under patents now or hereafter owned or controlled by
+          Contributor, to Utilize the Contributor Version (or portions
+          thereof), but solely to the extent that any such patent is
+          reasonably necessary to enable You to Utilize the Contributor
+          Version (or portions thereof), and not to any greater extent that
+          may be necessary to Utilize further Modifications or combinations.
+
+3. Distribution Obligations.
+
+     3.1. Application of License.
+     The Modifications which You create or to which You contribute are
+     governed by the terms of this License, including without limitation
+     Section 2.2. The Source Code version of Covered Code may be distributed
+     only under the terms of this License or a future version of this
+     License released under Section 6.1, and You must include a copy of this
+     License with every copy of the Source Code You distribute. You may not
+     offer or impose any terms on any Source Code version that alters or
+     restricts the applicable version of this License or the recipients'
+     rights hereunder. However, You may include an additional document
+     offering the additional rights described in Section 3.5.
+
+     3.2. Availability of Source Code.
+     Any Modification which You create or to which You contribute must be
+     made available in Source Code form under the terms of this License
+     either on the same media as an Executable version or via an accepted
+     Electronic Distribution Mechanism to anyone to whom you made an
+     Executable version available; and if made available via Electronic
+     Distribution Mechanism, must remain available for at least twelve (12)
+     months after the date it initially became available, or at least six
+     (6) months after a subsequent version of that particular Modification
+     has been made available to such recipients. You are responsible for
+     ensuring that the Source Code version remains available even if the
+     Electronic Distribution Mechanism is maintained by a third party.
+
+     3.3. Description of Modifications.
+     You must cause all Covered Code to which you contribute to contain a
+     file documenting the changes You made to create that Covered Code and
+     the date of any change. You must include a prominent statement that the
+     Modification is derived, directly or indirectly, from Original Code
+     provided by the Initial Developer and including the name of the Initial
+     Developer in (a) the Source Code, and (b) in any notice in an
+     Executable version or related documentation in which You describe the
+     origin or ownership of the Covered Code.
+
+     3.4. Intellectual Property Matters
+
+          (a) Third Party Claims.
+          If You have knowledge that a party claims an intellectual property
+          right in particular functionality or code (or its utilization
+          under this License), you must include a text file with the source
+          code distribution titled ``LEGAL'' which describes the claim and
+          the party making the claim in sufficient detail that a recipient
+          will know whom to contact. If you obtain such knowledge after You
+          make Your Modification available as described in Section 3.2, You
+          shall promptly modify the LEGAL file in all copies You make
+          available thereafter and shall take other steps (such as notifying
+          appropriate mailing lists or newsgroups) reasonably calculated to
+          inform those who received the Covered Code that new knowledge has
+          been obtained.
+
+          (b) Contributor APIs.
+          If Your Modification is an application programming interface and
+          You own or control patents which are reasonably necessary to
+          implement that API, you must also include this information in the
+          LEGAL file.
+
+     3.5. Required Notices.
+     You must duplicate the notice in Exhibit A in each file of the Source
+     Code, and this License in any documentation for the Source Code, where
+     You describe recipients' rights relating to Covered Code. If You
+     created one or more Modification(s), You may add your name as a
+     Contributor to the notice described in Exhibit A. If it is not possible
+     to put such notice in a particular Source Code file due to its
+     structure, then you must include such notice in a location (such as a
+     relevant directory file) where a user would be likely to look for such
+     a notice. You may choose to offer, and to charge a fee for, warranty,
+     support, indemnity or liability obligations to one or more recipients
+     of Covered Code. However, You may do so only on Your own behalf, and
+     not on behalf of the Initial Developer or any Contributor. You must
+     make it absolutely clear than any such warranty, support, indemnity or
+     liability obligation is offered by You alone, and You hereby agree to
+     indemnify the Initial Developer and every Contributor for any liability
+     incurred by the Initial Developer or such Contributor as a result of
+     warranty, support, indemnity or liability terms You offer.
+
+     3.6. Distribution of Executable Versions.
+     You may distribute Covered Code in Executable form only if the
+     requirements of Section 3.1-3.5 have been met for that Covered Code,
+     and if You include a notice stating that the Source Code version of the
+     Covered Code is available under the terms of this License, including a
+     description of how and where You have fulfilled the obligations of
+     Section 3.2. The notice must be conspicuously included in any notice in
+     an Executable version, related documentation or collateral in which You
+     describe recipients' rights relating to the Covered Code. You may
+     distribute the Executable version of Covered Code under a license of
+     Your choice, which may contain terms different from this License,
+     provided that You are in compliance with the terms of this License and
+     that the license for the Executable version does not attempt to limit
+     or alter the recipient's rights in the Source Code version from the
+     rights set forth in this License. If You distribute the Executable
+     version under a different license You must make it absolutely clear
+     that any terms which differ from this License are offered by You alone,
+     not by the Initial Developer or any Contributor. You hereby agree to
+     indemnify the Initial Developer and every Contributor for any liability
+     incurred by the Initial Developer or such Contributor as a result of
+     any such terms You offer.
+
+     3.7. Larger Works.
+     You may create a Larger Work by combining Covered Code with other code
+     not governed by the terms of this License and distribute the Larger
+     Work as a single product. In such a case, You must make sure the
+     requirements of this License are fulfilled for the Covered Code.
+
+4. Inability to Comply Due to Statute or Regulation.
+
+     If it is impossible for You to comply with any of the terms of this
+     License with respect to some or all of the Covered Code due to statute
+     or regulation then You must: (a) comply with the terms of this License
+     to the maximum extent possible; and (b) describe the limitations and
+     the code they affect. Such description must be included in the LEGAL
+     file described in Section 3.4 and must be included with all
+     distributions of the Source Code. Except to the extent prohibited by
+     statute or regulation, such description must be sufficiently detailed
+     for a recipient of ordinary skill to be able to understand it.
+
+5. Application of this License.
+
+     This License applies to code to which the Initial Developer has
+     attached the notice in Exhibit A, and to related Covered Code.
+
+6. Versions of the License.
+
+     6.1. New Versions.
+     Netscape Communications Corporation (``Netscape'') may publish revised
+     and/or new versions of the License from time to time. Each version will
+     be given a distinguishing version number.
+
+     6.2. Effect of New Versions.
+     Once Covered Code has been published under a particular version of the
+     License, You may always continue to use it under the terms of that
+     version. You may also choose to use such Covered Code under the terms
+     of any subsequent version of the License published by Netscape. No one
+     other than Netscape has the right to modify the terms applicable to
+     Covered Code created under this License.
+
+     6.3. Derivative Works.
+     If you create or use a modified version of this License (which you may
+     only do in order to apply it to code which is not already Covered Code
+     governed by this License), you must (a) rename Your license so that the
+     phrases ``Mozilla'', ``MOZILLAPL'', ``MOZPL'', ``Netscape'', ``NPL'' or
+     any confusingly similar phrase do not appear anywhere in your license
+     and (b) otherwise make it clear that your version of the license
+     contains terms which differ from the Mozilla Public License and
+     Netscape Public License. (Filling in the name of the Initial Developer,
+     Original Code or Contributor in the notice described in Exhibit A shall
+     not of themselves be deemed to be modifications of this License.)
+
+7. DISCLAIMER OF WARRANTY.
+
+     COVERED CODE IS PROVIDED UNDER THIS LICENSE ON AN ``AS IS'' BASIS,
+     WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+     WITHOUT LIMITATION, WARRANTIES THAT THE COVERED CODE IS FREE OF
+     DEFECTS, MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE OR NON-INFRINGING.
+     THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE COVERED CODE
+     IS WITH YOU. SHOULD ANY COVERED CODE PROVE DEFECTIVE IN ANY RESPECT,
+     YOU (NOT THE INITIAL DEVELOPER OR ANY OTHER CONTRIBUTOR) ASSUME THE
+     COST OF ANY NECESSARY SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER
+     OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS LICENSE. NO USE OF
+     ANY COVERED CODE IS AUTHORIZED HEREUNDER EXCEPT UNDER THIS DISCLAIMER.
+
+8. TERMINATION.
+
+     This License and the rights granted hereunder will terminate
+     automatically if You fail to comply with terms herein and fail to cure
+     such breach within 30 days of becoming aware of the breach. All
+     sublicenses to the Covered Code which are properly granted shall
+     survive any termination of this License. Provisions which, by their
+     nature, must remain in effect beyond the termination of this License
+     shall survive.
+
+9. LIMITATION OF LIABILITY.
+
+     UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL THEORY, WHETHER TORT
+     (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE, SHALL THE INITIAL
+     DEVELOPER, ANY OTHER CONTRIBUTOR, OR ANY DISTRIBUTOR OF COVERED CODE,
+     OR ANY SUPPLIER OF ANY OF SUCH PARTIES, BE LIABLE TO YOU OR ANY OTHER
+     PERSON FOR ANY INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
+     OF ANY CHARACTER INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF
+     GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR MALFUNCTION, OR ANY AND
+     ALL OTHER COMMERCIAL DAMAGES OR LOSSES, EVEN IF SUCH PARTY SHALL HAVE
+     BEEN INFORMED OF THE POSSIBILITY OF SUCH DAMAGES. THIS LIMITATION OF
+     LIABILITY SHALL NOT APPLY TO LIABILITY FOR DEATH OR PERSONAL INJURY
+     RESULTING FROM SUCH PARTY'S NEGLIGENCE TO THE EXTENT APPLICABLE LAW
+     PROHIBITS SUCH LIMITATION. SOME JURISDICTIONS DO NOT ALLOW THE
+     EXCLUSION OR LIMITATION OF INCIDENTAL OR CONSEQUENTIAL DAMAGES, SO THAT
+     EXCLUSION AND LIMITATION MAY NOT APPLY TO YOU.
+
+10. U.S. GOVERNMENT END USERS.
+
+     The Covered Code is a ``commercial item,'' as that term is defined in
+     48 C.F.R. 2.101 (Oct. 1995), consisting of ``commercial computer
+     software'' and ``commercial computer software documentation,'' as such
+     terms are used in 48 C.F.R. 12.212 (Sept. 1995). Consistent with 48
+     C.F.R. 12.212 and 48 C.F.R. 227.7202-1 through 227.7202-4 (June 1995),
+     all U.S. Government End Users acquire Covered Code with only those
+     rights set forth herein.
+
+11. MISCELLANEOUS.
+
+     This License represents the complete agreement concerning subject
+     matter hereof. If any provision of this License is held to be
+     unenforceable, such provision shall be reformed only to the extent
+     necessary to make it enforceable. This License shall be governed by
+     California law provisions (except to the extent applicable law, if any,
+     provides otherwise), excluding its conflict-of-law provisions. With
+     respect to disputes in which at least one party is a citizen of, or an
+     entity chartered or registered to do business in, the United States of
+     America: (a) unless otherwise agreed in writing, all disputes relating
+     to this License (excepting any dispute relating to intellectual
+     property rights) shall be subject to final and binding arbitration,
+     with the losing party paying all costs of arbitration; (b) any
+     arbitration relating to this Agreement shall be held in Santa Clara
+     County, California, under the auspices of JAMS/EndDispute; and (c) any
+     litigation relating to this Agreement shall be subject to the
+     jurisdiction of the Federal Courts of the Northern District of
+     California, with venue lying in Santa Clara County, California, with
+     the losing party responsible for costs, including without limitation,
+     court costs and reasonable attorneys fees and expenses. The application
+     of the United Nations Convention on Contracts for the International
+     Sale of Goods is expressly excluded. Any law or regulation which
+     provides that the language of a contract shall be construed against the
+     drafter shall not apply to this License.
+
+12. RESPONSIBILITY FOR CLAIMS.
+
+     Except in cases where another Contributor has failed to comply with
+     Section 3.4, You are responsible for damages arising, directly or
+     indirectly, out of Your utilization of rights under this License, based
+     on the number of copies of Covered Code you made available, the
+     revenues you received from utilizing such rights, and other relevant
+     factors. You agree to work with affected parties to distribute
+     responsibility on an equitable basis.
+
+EXHIBIT A.
+
+     ``The contents of this file are subject to the Mozilla Public License
+     Version 1.0 (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 Initial Developer of the Original Code is ________________________.
+     Portions created by ______________________ are Copyright (C) ______
+     _______________________. All Rights Reserved.
+
+     Contributor(s): ______________________________________.''

mozilla/directory/perldap/Makefile.PL

@@ -0,0 +1,173 @@
+#############################################################################
+# $Id: Makefile.PL,v 1.13.2.6 1998-12-04 11:17:37 leif%netscape.com Exp $
+#
+# The contents of this file are subject to the Mozilla Public License
+# Version 1.0 (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 PerLDAP. The Initial Developer of the Original
+# Code is Netscape Communications Corp. and Clayton Donley. Portions
+# created by Netscape are Copyright (C) Netscape Communications
+# Corp., portions created by Clayton Donley are Copyright (C) Clayton
+# Donley. All Rights Reserved.
+#
+# Contributor(s):
+#
+# DESCRIPTION
+#    The Makefile "source".
+#
+#############################################################################
+
+use ExtUtils::MakeMaker;
+use Config;
+use Carp;
+
+$perlpath = $Config{'perlpath'};
+$osname   = $Config{'osname'};
+
+$ldapsdk_loc = $ENV{"LDAPSDKDIR"}; # Full Path to C SDK Top-Level
+$ldapsdk_ssl = $ENV{"LDAPSDKSSL"}; # N to exclude SSL
+$ldapsdk_ver = $ENV{"LDAPV3ON"};   # N to exclude LDAP v3 features
+
+$libexts = "so|sl|a|lib";
+
+
+print "\nPerLDAP - Perl 5 Module for LDAP\n";
+print     "================================\n";
+
+$silent = 1;
+print "Directory containing 'include' and 'lib' directory of the Netscape\n";
+print "LDAP Software Developer Kit (default: /usr): ";
+if (!$ldapsdk_loc)
+{
+   $silent = 0;
+   chomp ($ldapsdk_loc = <STDIN>);
+   $ldapsdk_loc = "/usr" unless $ldapsdk_loc =~ /\S/;
+} else {
+  print "$ldapsdk_loc\n";
+}
+croak("Directory $ldapsdk_loc does not exist!") unless -d $ldapsdk_loc;
+
+if ($osname =~ /mswin/i)
+{
+   $dir_sep = "\\";
+} else {
+   $dir_sep = "/";
+}
+
+$include_ldap = $ldapsdk_loc . $dir_sep . "include";
+$lib_ldap = $ldapsdk_loc . $dir_sep . "lib";
+
+print "Using LDAPv3 Developer Kit (default: yes)?  ";
+if (!$ldapsdk_ver)
+{
+   $silent = 0;
+   chomp ($ldapsdk_ver = <STDIN>);
+} else {
+  print "YES\n";
+}
+$v3_def = "-DLDAPV3" unless ($ldapsdk_ver =~ /^n/i);
+
+   
+print "Include SSL Support (default: yes)?  ";
+if (!$ldapsdk_ssl)
+{
+   $silent = 0;
+   chomp ($ldapsdk_ssl = <STDIN>);
+} else {
+  print "YES\n";
+}
+$ssl_def = "-DUSE_SSL" unless ($ldapsdk_ssl =~ /^n/i);
+
+
+opendir(DIR,$lib_ldap);
+@files = grep{/ldap|lber/} readdir(DIR);
+closedir(DIR);
+
+if (!((@ldaplib = grep{/ldapssl.*\.($libexts)$/} @files) && $ssl_def))
+{
+   @ldaplib = grep{/ldap.*\.($libexts)$/} @files;
+   @lberlib = grep{/lber.*\.($libexts)$/} @files;
+}
+
+if ($#ldaplib < 0)
+{
+   die "No LDAP libraries found.";
+}
+
+if ($#ldaplib > 0)
+{
+   print "Located multiple libraries:\n";
+   foreach $alib (@ldaplib)
+   {
+      print " - $alib\n";
+   }
+}
+
+$lline_ldap = $ldaplib[0];
+$lline_ldap =~ s/^lib//;
+$lline_ldap =~ s/\.($libexts)$//;
+$lline = "-L$lib_ldap -l$lline_ldap";
+
+if ($#lberlib >= 0 && $lline =~ /ldap$/)
+{
+   $lline_lber = $lberlib[0];
+   $lline_lber =~ s/^lib//;
+   $lline_lber =~ s/\.($libexts)$//;
+   $lline .= " -l$lline_lber";
+}
+
+print "Libraries to link with (default: $lline):  ";
+if (!$silent)
+{
+   chomp ($lib_line = <STDIN>);
+   $lib_line = $lline unless $lib_line =~ /\S/;
+} else {
+  print "\n";
+}
+
+
+if ($osname =~ /mswin/i)
+{
+   $myextlib = "$lib_ldap\\$ldaplib[0]";
+   if ($lber_lib)
+   {
+      $myextlib .= " $lib_ldap\\$lberlib[0]";
+   }
+} else {
+   $myextlib = "";
+}
+
+@extras = ();
+
+push(@extras,
+     CAPI => 'TRUE')
+    if ($] >= 5.005 and $^O eq 'MSWin32'
+        and $Config{archname} =~ /-object\b/i);
+
+push(@extras,
+     ABSTRACT => 'Perl methods for LDAP C API calls',
+     AUTHOR   => 'Netscape Communications Corp., Inc. and Clayton Donley')
+    if ($ExtUtils::MakeMaker::Version >= 5.4301);
+
+WriteMakefile(
+	'NAME'		=> 	'Mozilla::LDAP::API',
+        'DISTNAME'	=>  'PerLDAP',
+	'VERSION_FROM'	=> 	'API.pm',
+	($include_ldap ne "/usr/include" ? (
+	'INC'		=> 	"-I$include_ldap",
+	) : (
+	'INC'		=> 	"",
+	)),
+	'LIBS'		=> 	[$lib_line],
+	'MYEXTLIB'	=>	$myextlib,
+	'DEFINE'	=> 	"$v3_def $ssl_def",
+	'XSOPT'		=>	"-nolinenumbers",
+    @extras
+);

mozilla/directory/perldap/README

@@ -0,0 +1,183 @@
+#############################################################################
+#                                                                           #
+#            PerLDAP v1.0 - A Perl Developers' Kit for LDAP                 #
+#                                                                           #
+#############################################################################
+
+
+What is PerLDAP?
+================
+
+PerLDAP is a set of modules written in Perl and C that allow developers to
+leverage their existing Perl knowledge to easily access and manage LDAP-
+enabled directories.  PerLDAP makes it very easy to search, add, delete,
+and modify directory entries.  For example, Perl developers can easily
+build web applications to access information stored in a directory or
+create directory sync tools between directories and other services.
+
+PerLDAP is an open source development project, the result of a joint effort
+between Netscape and Clayton Donley, an open source developer.  PerLDAP
+currently provides the basic functions to allow Perl users to access and
+manipulate directories easily.  Based on developer feedback and
+involvement, PerLDAP will continue to evolve to include additional
+functionality in future releases.
+
+
+Installing PerLDAP Binaries
+===========================
+
+You will first need version 3.0 of the LDAP C SDK from Netscape.  This is
+available from the DevEdge page at:
+
+    http://developer.netscape.com/tech/directory/
+
+You will also need Perl v5.004, available at http://www.perl.com/.
+Earlier, or later, versions of Perl will NOT work with these binaries. If
+you wish to use v5.005, you will need to compile PerLDAP from source.
+
+On Unix (Solaris Only...HPUX, IRIX, AIX to follow):
+  1. Be sure that the libraries from the C SDK are installed in locations
+     referenced by the environment variable LD_LIBRARY_PATH, or one of the
+     default system lib directories (e.g. /usr/lib). Alternatively you can
+     later also copy the SDK libraries to the same "site" directory where
+     Perl installed the PerLDAP libraries.
+
+  2. Save the file in a temporary location
+
+  3. Unzip the file by entering the command:
+      gunzip <filename>.tar.gz
+
+  4. Untar the resulting tar file by entering the command:
+      tar xvof <filename>.tar
+
+  5. Change to the extract directory:
+      cd PerLDAP-1.1
+
+  6. Execute the following command in as the super-user (root):
+      perl install-bin
+
+On Windows NT:
+  1. Put the LDAP C SDK DLL in the same directory as the perl.exe
+  binary. You can also set your PATH to point to the directory where you
+  have the C SDK installed. Alternatively, you can put the DLL in the
+  system32 folder, but avoid that if possible.
+
+  2. Save the file in a temporary location
+
+  3. Unzip the file by entering the command:
+      I don't have a tool for creating self-extracting archives...
+
+  4. Change to the extract directory:
+      cd PerLDAP-1.1
+
+  5. Execute the following command:
+      perl install-bin
+
+
+Compiling the PerLDAP Sources
+=============================
+
+The source to PerLDAP is available on the Mozilla site at:
+
+  http://www.mozilla.org/directory/
+
+You can either retrieve the .tar file with the source distribution, or use
+CVS to checkout the module directly. The name of the CVS module is
+PerLDAP, and it checks out the directory
+
+  mozilla/directory/perldap
+
+Further instructions for using CVS and Mozilla is available at
+
+  http://www.mozilla.org/cvs.html
+
+and an FAQ is at
+
+  http://www.mozilla.org/directory/faq/perldap-faq.html
+
+
+Instructions for building the source can be found in the INSTALL file
+in the source distribution.
+
+
+Getting Started
+===============
+
+Documentation for this module is in standard Perl 'pod' format.  HTML
+versions of this documentation can also be found on the Netscape DevEdge
+site at:  http://developer.netscape.com/tech/directory/.
+
+Additionally, many good examples can be found in the 'examples' directory.
+
+
+Modules and Examples Included
+=============================
+
+Mozilla::LDAP::API - Low level interface between Perl and the LDAP C API
+Mozilla::LDAP::Entry - Perl methods for manipulating entry objects
+Mozilla::LDAP::Conn - Perl methods for performing LDAP operations
+Mozilla::LDAP::LDIF - Perl methods for utilizing LDIF
+Mozilla::LDAP::Utils - Some convenient LDAP related utilities
+test_api/search.pl - Tests low level API search calls
+test_api/write.pl  - Tests low level API write calls
+test_api/api.pl - Tests ALL low level LDAPv2 calls
+examples/lfinger.pl - LDAP version of the regular Unix finger command.
+examples/qsearch.pl - Simple ldapsearch replacement.
+examples/monitor.pl - Retrieve status information from an LDAP server.
+examples/ldappasswd.pl - Change the LDAP password for a user.
+examples/rmentry.pl - Remove an entire entry from the database.
+examples/rename.pl - Rename (modRDN) an entry.
+examples/tabdump.pl - Dump LDAP information into a tab separated file.
+examples/psoftsync.pl - Synchronize LDAP with a PeopleSoft "dump" file.
+
+
+All examples support the "standard" LDAP command line options, which are
+
+        -h hostname     LDAP server name
+        -p port #       LDAP port, default is 389 (or 636 for SSL)
+        -b base DN      LDAP Base-DN
+        -D bind DN      LDAP bind DN (connect to server as this "user")
+        -w bind pswd    Password to bind to the server
+        -P certfile     Use SSL, with the publick keys from this file
+
+
+Note that the examples currently only support Simple Authentication
+(passwords), the Client Authentication features (using certificates) will
+be used in the next release. All examples also honors the environment
+variable LDAP_BASEDN, set it to your systems base DN, e.g.
+
+        % setenv LDAP_BASEDN 'dc=netscape,dc=com'
+
+or for Bourne shell
+
+        # LDAP_BASEDN='dc=netscape,dc=com'; export LDAP_BASEDN
+
+
+Reporting problems and bugs
+===========================
+
+Address all bug reports and comments to the Mozilla newsgroups at:
+
+   news://news.mozilla.org/netscape.public.mozilla.directory
+
+
+License/Copyright
+=================
+
+Portions by Netscape (c) Copyright 1998 Netscape Communications Corp, Inc.
+Portions by Clayton Donley (c) Copyright 1998 Clayton Donley
+
+Please read the MPL-1.0.txt file included for information on the Mozilla
+Public License, which covers all files in this distribution.
+
+Known Bugs
+==========
+
+There are a number of issues still outstanding at the time of release.  Most
+of these are already in the process of being resolved.
+
+ - There is a possible memory leak in the search routines. The OO layer
+   is also more memory than it should.
+ - The Rebind operation on NT does NOT work properly when set to a Perl
+   function.  This is being investigated.
+ - Some of the documentation is incomplete.

mozilla/directory/perldap/Utils.pm

@@ -0,0 +1,380 @@
+#############################################################################
+# $Id: Utils.pm,v 1.10.2.4 1998-12-15 12:01:33 leif%netscape.com Exp $
+#
+# The contents of this file are subject to the Mozilla Public License
+# Version 1.0 (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 PerLDAP. The Initial Developer of the Original
+# Code is Netscape Communications Corp. and Clayton Donley. Portions
+# created by Netscape are Copyright (C) Netscape Communications
+# Corp., portions created by Clayton Donley are Copyright (C) Clayton
+# Donley. All Rights Reserved.
+#
+# Contributor(s):
+#
+# DESCRIPTION
+#    Lots of Useful Little Utilities, for LDAP related operations.
+#
+#############################################################################
+
+package Mozilla::LDAP::Utils;
+
+use Mozilla::LDAP::API qw(:constant);
+use Mozilla::LDAP::Conn;
+use vars qw(@ISA %EXPORT_TAGS);
+
+require Exporter;
+
+@ISA = qw(Exporter);
+%EXPORT_TAGS = (
+		all => [qw(normalizeDN
+			   isUrl
+			   printEntry
+			   printentry
+			   encodeBase64
+			   decodeBase64
+			   str2Scope
+			   askPassword
+			   ldapArgs
+			   unixCrypt
+			   userCredentials
+			   answer)]
+		);
+
+
+# Add Everything in %EXPORT_TAGS to @EXPORT_OK
+Exporter::export_ok_tags('all');
+
+
+#############################################################################
+# Normalize the DN string (first argument), and return the new, normalized,
+# string (DN). This is useful to make sure that two syntactically
+# identical DNs compare (eq) as the same string.
+#
+sub normalizeDN
+{
+  my ($dn) = @_;
+  my (@vals);
+
+  return "" unless (defined($dn) && ($dn ne ""));
+
+  @vals = Mozilla::LDAP::API::ldap_explode_dn(lc $dn, 0);
+
+  return join(",", @vals);
+}
+
+
+#############################################################################
+# Checks if a string is a properly formed LDAP URL.
+#
+sub isURL
+{
+  return ldap_is_ldap_url($_[0]);
+}
+
+
+#############################################################################
+# Print an entry, in LDIF format. This is sort of obsolete, we encourage
+# you to use the :;LDAP::LDIF class instead.
+#
+sub printEntry
+{
+  my $entry = $_[0];
+  my $attr;
+  local $_;
+
+  print "dn: ", $entry->{"dn"},"\n";
+  foreach $attr (@{$entry->{"_oc_order_"}})
+    {
+      next if ($attr =~ /^_.+_$/);
+      next if $entry->{"_${attr}_deleted_"};
+      foreach (@{$entry->{$attr}})
+	{
+	  print "$attr: $_\n";
+	}
+    }
+
+  print "\n";
+}
+*printentry = \*printEntry;
+
+
+#############################################################################
+# Perform Base64 encoding, this is based on MIME::Base64.pm, written
+# by Gisle Aas <gisle@aas.no>. If possible, use the MIME:: package instead.
+#
+sub encodeBase64
+{
+  my $res = "";
+  my $eol = "$_[1]";
+  my $padding;
+
+  pos($_[0]) = 0;                          # ensure start at the beginning
+  while ($_[0] =~ /(.{1,45})/gs) {
+    $res .= substr(pack('u', $1), 1);
+    chop($res);
+  }
+
+  $res =~ tr|` -_|AA-Za-z0-9+/|;               # `# help emacs
+  $padding = (3 - length($_[0]) % 3) % 3;
+  $res =~ s/.{$padding}$/'=' x $padding/e if $padding;
+
+  if (length $eol) {
+    $res =~ s/(.{1,76})/$1$eol/g;
+  }
+
+  return $res;
+}
+ 
+ 
+#############################################################################
+# Perform Base64 decoding, this is based on MIME::Base64.pm, written
+# by Gisle Aas <gisle@aas.no>. If possible, use the MIME:: package instead.
+#
+sub decodeBase64
+{
+  my $str = shift;
+  my $res = "";
+  my $len;
+ 
+  $str =~ tr|A-Za-z0-9+=/||cd;
+  Carp::croak("Base64 decoder requires string length to be a multiple of 4")
+    if length($str) % 4;
+
+  $str =~ s/=+$//;                        # remove padding
+  $str =~ tr|A-Za-z0-9+/| -_|;            # convert to uuencoded format
+  while ($str =~ /(.{1,60})/gs)
+    {
+      $len = chr(32 + length($1)*3/4);
+      $res .= unpack("u", $len . $1 );    # uudecode
+    }
+
+  return $res;
+}
+
+
+#############################################################################
+# Convert a "human" readable string to an LDAP scope value
+#
+sub str2Scope
+{
+  my $str = $_[0];
+
+  return $str if ($str =~ /^[0-9]+$/);
+
+  if ($str =~ /^sub/i)
+    {
+      return LDAP_SCOPE_SUBTREE;
+    }
+  elsif ($str =~ /^base/i)
+    {
+      return LDAP_SCOPE_BASE;
+    }
+  elsif ($str =~ /^one/i)
+    {
+      return LDAP_SCOPE_ONELEVEL;
+    }
+
+  # Default...
+  return LDAP_SCOPE_SUBTREE;
+}
+
+
+#############################################################################
+# Ask for a password, without displaying it on the TTY.
+#
+sub askPassword
+{
+  my $prompt = $_[0];
+  my $hasReadKey = 0;
+
+  eval "use Term::ReadKey";
+  $hasReadKey=1 unless ($@);
+
+  print "LDAP password: " if $prompt;
+  if ($hasReadKey)
+    {
+      ReadMode(2);
+      chop($_ = ReadLine(0));
+      ReadMode(0);
+    }
+  else
+    {
+      system('/bin/stty -echo');
+      chop($_ = <STDIN>);
+      system('/bin/stty echo');
+    }
+  print "\n";
+
+  return $_;
+}
+
+
+#############################################################################
+# Handle some standard LDAP options, and construct a nice little structure
+# that we can use later on. We really should have some appropriate defaults,
+# perhaps from an Mozilla::LDAP::Config module.
+#
+sub ldapArgs
+{
+  my ($bind, $base) = @_;
+  my %ld;
+
+  $main::opt_v = $main::opt_n if defined($main::opt_n);
+  $main::opt_p = LDAPS_PORT if (!defined($main::opt_p) &&
+				defined($main::opt_P) &&
+				($main::opt_P ne ""));
+
+  $ld{"host"} = $main::opt_h || "ldap";
+  $ld{"port"} = $main::opt_p || LDAP_PORT;
+  $ld{"root"} = $main::opt_b || $base || $ENV{'LDAP_BASEDN'};
+  $ld{"bind"} = $main::opt_D || $bind || "";
+  $ld{"pswd"} = $main::opt_w || "";
+  $ld{"cert"} = $main::opt_P || "";
+  $ld{"scope"} = (defined($main::opt_s) ? $main::opt_s : LDAP_SCOPE_SUBTREE);
+
+  if (($ld{"bind"} ne "") && ($ld{"pswd"} eq ""))
+    {
+      $ld{pswd} = askPassword(1);
+    }
+
+  return %ld;
+}
+
+
+#############################################################################
+# Create a Unix-type password, using the "crypt" function. A random salt
+# is always generated, perhaps it should be an optional argument?
+#
+sub unixCrypt
+{
+   my $ascii =
+      "./0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
+   my $salt = substr($ascii, rand(62), 1) . substr($ascii, rand(62), 1);
+
+   srand(time ^ $$);
+   crypt($_[0], $salt);
+}
+
+
+#############################################################################
+# Try to find a user to bind as, and possibly ask for the password. Pass
+# a pointer to the hash array with LDAP parameters to this function.
+#
+sub userCredentials
+{
+  my ($ld) = @_;
+  my ($conn, $entry, $pswd);
+
+  if ($ld->{"bind"} eq "")
+    {
+      $conn = new Mozilla::LDAP::Conn($ld);
+      die "Could't connect to LDAP server " . $ld->{"host"} unless $conn;
+
+      $search = "(&(objectclass=inetOrgPerson)(uid=$ENV{USER}))";
+      $entry = $conn->search($ld->{"root"}, "subtree", $search, 0, ("uid"));
+      return 0 if (!$entry || $conn->nextEntry());
+
+      $conn->close();
+      $ld->{"bind"} = $entry->getDN();
+    }
+
+  if ($ld->{"pswd"} eq "")
+    {
+      $ld->{"pswd"} = Mozilla::LDAP::Utils::askPassword(1);
+    }
+}
+
+
+#############################################################################
+# Ask a Y/N question, return "Y" or "N".
+#
+sub answer
+{
+  die "Default string must be Y or N."
+    unless (($_[0] eq "Y") || ($_[0] eq "N"));
+
+  chop($_ = <STDIN>);
+
+  return $_[0] if /^$/;
+  return "Y" if /^[yY]/;
+  return "N" if /^[nN]/;
+}
+
+
+#############################################################################
+# Mandatory TRUE return value.
+#
+1;
+
+
+#############################################################################
+# POD documentation...
+#
+__END__
+
+=head1 NAME
+
+  Mozilla::LDAP::Utils.pm - Collection of useful little utilities.
+
+=head1 SYNOPSIS
+
+  use Mozilla::LDAP::Utils;
+
+=head1 ABSTRACT
+
+
+=head1 DESCRIPTION
+
+
+=head1 OBJECT CLASS METHODS
+
+=over 13
+
+=item B<normalizeDN>
+
+This function will remove all extraneous white spaces in the DN, and also
+change all upper case characters to lower case. The only argument is the
+DN string to normalize, and the return value is the new, clean DN.
+
+=back
+
+=head1 EXAMPLES
+
+There are plenty of examples to look at, in the examples directory. We are
+adding more examples every day (almost).
+
+=head1 INSTALLATION
+
+Installing this package is part of the Makefile supplied in the
+package. See the installation procedures which are part of this package.
+
+=head1 AVAILABILITY
+
+This package can be retrieved from a number of places, including:
+
+    http://www.mozilla.org/directory/
+    Your local CPAN server
+
+=head1 CREDITS
+
+Most of this code was developed by Leif Hedstrom, Netscape Communications
+Corporation. 
+
+=head1 BUGS
+
+None. :)
+
+=head1 SEE ALSO
+
+L<Mozilla::LDAP::Conn>, L<Mozilla::LDAP::Entry>, L<Mozilla::LDAP::API>, and
+of course L<Perl>.
+
+=cut

mozilla/directory/perldap/constant.h

@@ -0,0 +1,954 @@
+/*
+ *******************************************************************************
+ * $Id: constant.h,v 1.7 1998-08-13 09:14:14 leif Exp $
+ *
+ * The contents of this file are subject to the Mozilla Public License
+ * Version 1.0 (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 PerLDAP. The Initial Developer of the Original
+ * Code is Netscape Communications Corp. and Clayton Donley. Portions
+ * created by Netscape are Copyright (C) Netscape Communications
+ * Corp., portions created by Clayton Donley are Copyright (C) Clayton
+ * Donley. All Rights Reserved.
+ *
+ * Contributor(s):
+ *
+ * DESCRIPTION
+ *    Constants.
+ *
+ *******************************************************************************/
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+#include "EXTERN.h"
+#include "perl.h"
+#include "XSUB.h"
+#ifdef __cplusplus
+}
+#endif
+
+#include <ldap.h>
+
+static int
+not_here(s)
+char *s;
+{
+    croak("%s not implemented on this architecture", s);
+    return -1;
+}
+
+double
+constant(name, arg)
+char *name;
+int arg;
+{
+    errno = 0;
+    if (name[0] == 'L' && name[1] == 'D' && name[2] == 'A' && name[3] == 'P'
+       && name[4] == '_')
+    {
+      switch (name[5]) {
+       case 'A':
+	if (strEQ(name, "LDAP_ADMINLIMIT_EXCEEDED"))
+#ifdef LDAP_ADMINLIMIT_EXCEEDED
+	    return LDAP_ADMINLIMIT_EXCEEDED;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_AFFECTS_MULTIPLE_DSAS"))
+#ifdef LDAP_AFFECTS_MULTIPLE_DSAS
+	    return LDAP_AFFECTS_MULTIPLE_DSAS;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_ALIAS_DEREF_PROBLEM"))
+#ifdef LDAP_ALIAS_DEREF_PROBLEM
+	    return LDAP_ALIAS_DEREF_PROBLEM;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_ALIAS_PROBLEM"))
+#ifdef LDAP_ALIAS_PROBLEM
+	    return LDAP_ALIAS_PROBLEM;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_ALREADY_EXISTS"))
+#ifdef LDAP_ALREADY_EXISTS
+	    return LDAP_ALREADY_EXISTS;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_AUTH_METHOD_NOT_SUPPORTED"))
+#ifdef LDAP_AUTH_METHOD_NOT_SUPPORTED
+	    return LDAP_AUTH_METHOD_NOT_SUPPORTED;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_AUTH_NONE"))
+#ifdef LDAP_AUTH_NONE
+	    return LDAP_AUTH_NONE;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_AUTH_SASL"))
+#ifdef LDAP_AUTH_SASL
+	    return LDAP_AUTH_SASL;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_AUTH_SIMPLE"))
+#ifdef LDAP_AUTH_SIMPLE
+	    return LDAP_AUTH_SIMPLE;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_AUTH_UNKNOWN"))
+#ifdef LDAP_AUTH_UNKNOWN
+	    return LDAP_AUTH_UNKNOWN;
+#else
+	    goto not_there;
+#endif
+        break;
+      case 'B':
+	if (strEQ(name, "LDAP_BUSY"))
+#ifdef LDAP_BUSY
+	    return LDAP_BUSY;
+#else
+	    goto not_there;
+#endif
+	break;
+      case 'C':
+	if (strEQ(name, "LDAP_CACHE_CHECK"))
+#ifdef LDAP_CACHE_CHECK
+	    return LDAP_CACHE_CHECK;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_CACHE_LOCALDB"))
+#ifdef LDAP_CACHE_LOCALDB
+	    return LDAP_CACHE_LOCALDB;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_CACHE_POPULATE"))
+#ifdef LDAP_CACHE_POPULATE
+	    return LDAP_CACHE_POPULATE;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_CHANGETYPE_ADD"))
+#ifdef LDAP_CHANGETYPE_ADD
+	    return LDAP_CHANGETYPE_ADD;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_CHANGETYPE_ANY"))
+#ifdef LDAP_CHANGETYPE_ANY
+	    return LDAP_CHANGETYPE_ANY;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_CHANGETYPE_DELETE"))
+#ifdef LDAP_CHANGETYPE_DELETE
+	    return LDAP_CHANGETYPE_DELETE;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_CHANGETYPE_MODDN"))
+#ifdef LDAP_CHANGETYPE_MODDN
+	    return LDAP_CHANGETYPE_MODDN;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_CHANGETYPE_MODIFY"))
+#ifdef LDAP_CHANGETYPE_MODIFY
+	    return LDAP_CHANGETYPE_MODIFY;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_CLIENT_LOOP"))
+#ifdef LDAP_CLIENT_LOOP
+	    return LDAP_CLIENT_LOOP;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_COMPARE_FALSE"))
+#ifdef LDAP_COMPARE_FALSE
+	    return LDAP_COMPARE_FALSE;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_COMPARE_TRUE"))
+#ifdef LDAP_COMPARE_TRUE
+	    return LDAP_COMPARE_TRUE;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_CONFIDENTIALITY_REQUIRED"))
+#ifdef LDAP_CONFIDENTIALITY_REQUIRED
+	    return LDAP_CONFIDENTIALITY_REQUIRED;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_CONNECT_ERROR"))
+#ifdef LDAP_CONNECT_ERROR
+	    return LDAP_CONNECT_ERROR;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_CONSTRAINT_VIOLATION"))
+#ifdef LDAP_CONSTRAINT_VIOLATION
+	    return LDAP_CONSTRAINT_VIOLATION;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_DECODING_ERROR"))
+#ifdef LDAP_DECODING_ERROR
+	    return LDAP_DECODING_ERROR;
+#else
+	    goto not_there;
+#endif
+	break;
+      case 'D':
+	if (strEQ(name, "LDAP_DEREF_ALWAYS"))
+#ifdef LDAP_DEREF_ALWAYS
+	    return LDAP_DEREF_ALWAYS;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_DEREF_FINDING"))
+#ifdef LDAP_DEREF_FINDING
+	    return LDAP_DEREF_FINDING;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_DEREF_NEVER"))
+#ifdef LDAP_DEREF_NEVER
+	    return LDAP_DEREF_NEVER;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_DEREF_SEARCHING"))
+#ifdef LDAP_DEREF_SEARCHING
+	    return LDAP_DEREF_SEARCHING;
+#else
+	    goto not_there;
+#endif
+	break;
+      case 'E':
+	if (strEQ(name, "LDAP_ENCODING_ERROR"))
+#ifdef LDAP_ENCODING_ERROR
+	    return LDAP_ENCODING_ERROR;
+#else
+	    goto not_there;
+#endif
+	break;
+      case 'F':
+	if (strEQ(name, "LDAP_FILTER_ERROR"))
+#ifdef LDAP_FILTER_ERROR
+	    return LDAP_FILTER_ERROR;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_FILT_MAXSIZ"))
+#ifdef LDAP_FILT_MAXSIZ
+	    return LDAP_FILT_MAXSIZ;
+#else
+	    goto not_there;
+#endif
+	break;
+      case 'I':
+	if (strEQ(name, "LDAP_INAPPROPRIATE_AUTH"))
+#ifdef LDAP_INAPPROPRIATE_AUTH
+	    return LDAP_INAPPROPRIATE_AUTH;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_INAPPROPRIATE_MATCHING"))
+#ifdef LDAP_INAPPROPRIATE_MATCHING
+	    return LDAP_INAPPROPRIATE_MATCHING;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_INSUFFICIENT_ACCESS"))
+#ifdef LDAP_INSUFFICIENT_ACCESS
+	    return LDAP_INSUFFICIENT_ACCESS;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_INVALID_CREDENTIALS"))
+#ifdef LDAP_INVALID_CREDENTIALS
+	    return LDAP_INVALID_CREDENTIALS;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_INVALID_DN_SYNTAX"))
+#ifdef LDAP_INVALID_DN_SYNTAX
+	    return LDAP_INVALID_DN_SYNTAX;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_INVALID_SYNTAX"))
+#ifdef LDAP_INVALID_SYNTAX
+	    return LDAP_INVALID_SYNTAX;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_IS_LEAF"))
+#ifdef LDAP_IS_LEAF
+	    return LDAP_IS_LEAF;
+#else
+	    goto not_there;
+#endif
+	break;
+      case 'L':
+	if (strEQ(name, "LDAP_LOCAL_ERROR"))
+#ifdef LDAP_LOCAL_ERROR
+	    return LDAP_LOCAL_ERROR;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_LOOP_DETECT"))
+#ifdef LDAP_LOOP_DETECT
+	    return LDAP_LOOP_DETECT;
+#else
+	    goto not_there;
+#endif
+	break;
+      case 'M':
+	if (strEQ(name, "LDAP_MOD_ADD"))
+#ifdef LDAP_MOD_ADD
+	    return LDAP_MOD_ADD;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_MOD_BVALUES"))
+#ifdef LDAP_MOD_BVALUES
+	    return LDAP_MOD_BVALUES;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_MOD_DELETE"))
+#ifdef LDAP_MOD_DELETE
+	    return LDAP_MOD_DELETE;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_MOD_REPLACE"))
+#ifdef LDAP_MOD_REPLACE
+	    return LDAP_MOD_REPLACE;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_MORE_RESULTS_TO_RETURN"))
+#ifdef LDAP_MORE_RESULTS_TO_RETURN
+	    return LDAP_MORE_RESULTS_TO_RETURN;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_MSG_ALL"))
+#ifdef LDAP_MSG_ALL
+	    return LDAP_MSG_ALL;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_MSG_ONE"))
+#ifdef LDAP_MSG_ONE
+	    return LDAP_MSG_ONE;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_MSG_RECEIVED"))
+#ifdef LDAP_MSG_RECEIVED
+	    return LDAP_MSG_RECEIVED;
+#else
+	    goto not_there;
+#endif
+	break;
+      case 'N':
+	if (strEQ(name, "LDAP_NAMING_VIOLATION"))
+#ifdef LDAP_NAMING_VIOLATION
+	    return LDAP_NAMING_VIOLATION;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_NOT_ALLOWED_ON_NONLEAF"))
+#ifdef LDAP_NOT_ALLOWED_ON_NONLEAF
+	    return LDAP_NOT_ALLOWED_ON_NONLEAF;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_NOT_ALLOWED_ON_RDN"))
+#ifdef LDAP_NOT_ALLOWED_ON_RDN
+	    return LDAP_NOT_ALLOWED_ON_RDN;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_NOT_SUPPORTED"))
+#ifdef LDAP_NOT_SUPPORTED
+	    return LDAP_NOT_SUPPORTED;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_NO_LIMIT"))
+#ifdef LDAP_NO_LIMIT
+	    return LDAP_NO_LIMIT;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_NO_MEMORY"))
+#ifdef LDAP_NO_MEMORY
+	    return LDAP_NO_MEMORY;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_NO_OBJECT_CLASS_MODS"))
+#ifdef LDAP_NO_OBJECT_CLASS_MODS
+	    return LDAP_NO_OBJECT_CLASS_MODS;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_NO_RESULTS_RETURNED"))
+#ifdef LDAP_NO_RESULTS_RETURNED
+	    return LDAP_NO_RESULTS_RETURNED;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_NO_SUCH_ATTRIBUTE"))
+#ifdef LDAP_NO_SUCH_ATTRIBUTE
+	    return LDAP_NO_SUCH_ATTRIBUTE;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_NO_SUCH_OBJECT"))
+#ifdef LDAP_NO_SUCH_OBJECT
+	    return LDAP_NO_SUCH_OBJECT;
+#else
+	    goto not_there;
+#endif
+	break;
+      case 'O':
+	if (strEQ(name, "LDAP_OBJECT_CLASS_VIOLATION"))
+#ifdef LDAP_OBJECT_CLASS_VIOLATION
+	    return LDAP_OBJECT_CLASS_VIOLATION;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_OPERATIONS_ERROR"))
+#ifdef LDAP_OPERATIONS_ERROR
+	    return LDAP_OPERATIONS_ERROR;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_OPT_CACHE_ENABLE"))
+#ifdef LDAP_OPT_CACHE_ENABLE
+	    return LDAP_OPT_CACHE_ENABLE;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_OPT_CACHE_FN_PTRS"))
+#ifdef LDAP_OPT_CACHE_FN_PTRS
+	    return LDAP_OPT_CACHE_FN_PTRS;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_OPT_CACHE_STRATEGY"))
+#ifdef LDAP_OPT_CACHE_STRATEGY
+	    return LDAP_OPT_CACHE_STRATEGY;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_OPT_CLIENT_CONTROLS"))
+#ifdef LDAP_OPT_CLIENT_CONTROLS
+	    return LDAP_OPT_CLIENT_CONTROLS;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_OPT_DEREF"))
+#ifdef LDAP_OPT_DEREF
+	    return LDAP_OPT_DEREF;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_OPT_DESC"))
+#ifdef LDAP_OPT_DESC
+	    return LDAP_OPT_DESC;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_OPT_DNS"))
+#ifdef LDAP_OPT_DNS
+	    return LDAP_OPT_DNS;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_OPT_DNS_FN_PTRS"))
+#ifdef LDAP_OPT_DNS_FN_PTRS
+	    return LDAP_OPT_DNS_FN_PTRS;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_OPT_ERROR_NUMBER"))
+#ifdef LDAP_OPT_ERROR_NUMBER
+	    return LDAP_OPT_ERROR_NUMBER;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_OPT_ERROR_STRING"))
+#ifdef LDAP_OPT_ERROR_STRING
+	    return LDAP_OPT_ERROR_STRING;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_OPT_HOST_NAME"))
+#ifdef LDAP_OPT_HOST_NAME
+	    return LDAP_OPT_HOST_NAME;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_OPT_IO_FN_PTRS"))
+#ifdef LDAP_OPT_IO_FN_PTRS
+	    return LDAP_OPT_IO_FN_PTRS;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_OPT_MEMALLOC_FN_PTRS"))
+#ifdef LDAP_OPT_MEMALLOC_FN_PTRS
+	    return LDAP_OPT_MEMALLOC_FN_PTRS;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_OPT_PREFERRED_LANGUAGE"))
+#ifdef LDAP_OPT_PREFERRED_LANGUAGE
+	    return LDAP_OPT_PREFERRED_LANGUAGE;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_OPT_PROTOCOL_VERSION"))
+#ifdef LDAP_OPT_PROTOCOL_VERSION
+	    return LDAP_OPT_PROTOCOL_VERSION;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_OPT_REBIND_ARG"))
+#ifdef LDAP_OPT_REBIND_ARG
+	    return LDAP_OPT_REBIND_ARG;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_OPT_REBIND_FN"))
+#ifdef LDAP_OPT_REBIND_FN
+	    return LDAP_OPT_REBIND_FN;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_OPT_RECONNECT"))
+#ifdef LDAP_OPT_RECONNECT
+	    return LDAP_OPT_RECONNECT;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_OPT_REFERRALS"))
+#ifdef LDAP_OPT_REFERRALS
+	    return LDAP_OPT_REFERRALS;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_OPT_REFERRAL_HOP_LIMIT"))
+#ifdef LDAP_OPT_REFERRAL_HOP_LIMIT
+	    return LDAP_OPT_REFERRAL_HOP_LIMIT;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_OPT_RESTART"))
+#ifdef LDAP_OPT_RESTART
+	    return LDAP_OPT_RESTART;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_OPT_RETURN_REFERRALS"))
+#ifdef LDAP_OPT_RETURN_REFERRALS
+	    return LDAP_OPT_RETURN_REFERRALS;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_OPT_SERVER_CONTROLS"))
+#ifdef LDAP_OPT_SERVER_CONTROLS
+	    return LDAP_OPT_SERVER_CONTROLS;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_OPT_SIZELIMIT"))
+#ifdef LDAP_OPT_SIZELIMIT
+	    return LDAP_OPT_SIZELIMIT;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_OPT_SSL"))
+#ifdef LDAP_OPT_SSL
+	    return LDAP_OPT_SSL;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_OPT_THREAD_FN_PTRS"))
+#ifdef LDAP_OPT_THREAD_FN_PTRS
+	    return LDAP_OPT_THREAD_FN_PTRS;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_OPT_TIMELIMIT"))
+#ifdef LDAP_OPT_TIMELIMIT
+	    return LDAP_OPT_TIMELIMIT;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_OTHER"))
+#ifdef LDAP_OTHER
+	    return LDAP_OTHER;
+#else
+	    goto not_there;
+#endif
+	break;
+      case 'P':
+	if (strEQ(name, "LDAP_PARAM_ERROR"))
+#ifdef LDAP_PARAM_ERROR
+	    return LDAP_PARAM_ERROR;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_PARTIAL_RESULTS"))
+#ifdef LDAP_PARTIAL_RESULTS
+	    return LDAP_PARTIAL_RESULTS;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_PORT"))
+#ifdef LDAP_PORT
+	    return LDAP_PORT;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_PORT_MAX"))
+#ifdef LDAP_PORT_MAX
+	    return LDAP_PORT_MAX;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_PROTOCOL_ERROR"))
+#ifdef LDAP_PROTOCOL_ERROR
+	    return LDAP_PROTOCOL_ERROR;
+#else
+	    goto not_there;
+#endif
+	break;
+      case 'R':
+	if (strEQ(name, "LDAP_REFERRAL"))
+#ifdef LDAP_REFERRAL
+	    return LDAP_REFERRAL;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_REFERRAL_LIMIT_EXCEEDED"))
+#ifdef LDAP_REFERRAL_LIMIT_EXCEEDED
+	    return LDAP_REFERRAL_LIMIT_EXCEEDED;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_RESULTS_TOO_LARGE"))
+#ifdef LDAP_RESULTS_TOO_LARGE
+	    return LDAP_RESULTS_TOO_LARGE;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_RES_ADD"))
+#ifdef LDAP_RES_ADD
+	    return LDAP_RES_ADD;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_RES_ANY"))
+#ifdef LDAP_RES_ANY
+	    return LDAP_RES_ANY;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_RES_BIND"))
+#ifdef LDAP_RES_BIND
+	    return LDAP_RES_BIND;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_RES_COMPARE"))
+#ifdef LDAP_RES_COMPARE
+	    return LDAP_RES_COMPARE;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_RES_DELETE"))
+#ifdef LDAP_RES_DELETE
+	    return LDAP_RES_DELETE;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_RES_EXTENDED"))
+#ifdef LDAP_RES_EXTENDED
+	    return LDAP_RES_EXTENDED;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_RES_MODIFY"))
+#ifdef LDAP_RES_MODIFY
+	    return LDAP_RES_MODIFY;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_RES_MODRDN"))
+#ifdef LDAP_RES_MODRDN
+	    return LDAP_RES_MODRDN;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_RES_RENAME"))
+#ifdef LDAP_RES_RENAME
+	    return LDAP_RES_RENAME;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_RES_SEARCH_ENTRY"))
+#ifdef LDAP_RES_SEARCH_ENTRY
+	    return LDAP_RES_SEARCH_ENTRY;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_RES_SEARCH_REFERENCE"))
+#ifdef LDAP_RES_SEARCH_REFERENCE
+	    return LDAP_RES_SEARCH_REFERENCE;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_RES_SEARCH_RESULT"))
+#ifdef LDAP_RES_SEARCH_RESULT
+	    return LDAP_RES_SEARCH_RESULT;
+#else
+	    goto not_there;
+#endif
+	break;
+      case 'S':
+	if (strEQ(name, "LDAP_SASL_BIND_IN_PROGRESS"))
+#ifdef LDAP_SASL_BIND_IN_PROGRESS
+	    return LDAP_SASL_BIND_IN_PROGRESS;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_SASL_SIMPLE"))
+#ifdef LDAP_SASL_SIMPLE
+	    return LDAP_SASL_SIMPLE;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_SCOPE_BASE"))
+#ifdef LDAP_SCOPE_BASE
+	    return LDAP_SCOPE_BASE;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_SCOPE_ONELEVEL"))
+#ifdef LDAP_SCOPE_ONELEVEL
+	    return LDAP_SCOPE_ONELEVEL;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_SCOPE_SUBTREE"))
+#ifdef LDAP_SCOPE_SUBTREE
+	    return LDAP_SCOPE_SUBTREE;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_SECURITY_NONE"))
+#ifdef LDAP_SECURITY_NONE
+	    return LDAP_SECURITY_NONE;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_SERVER_DOWN"))
+#ifdef LDAP_SERVER_DOWN
+	    return LDAP_SERVER_DOWN;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_SIZELIMIT_EXCEEDED"))
+#ifdef LDAP_SIZELIMIT_EXCEEDED
+	    return LDAP_SIZELIMIT_EXCEEDED;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_SORT_CONTROL_MISSING"))
+#ifdef LDAP_SORT_CONTROL_MISSING
+	    return LDAP_SORT_CONTROL_MISSING;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_STRONG_AUTH_NOT_SUPPORTED"))
+#ifdef LDAP_STRONG_AUTH_NOT_SUPPORTED
+	    return LDAP_STRONG_AUTH_NOT_SUPPORTED;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_STRONG_AUTH_REQUIRED"))
+#ifdef LDAP_STRONG_AUTH_REQUIRED
+	    return LDAP_STRONG_AUTH_REQUIRED;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_SUCCESS"))
+#ifdef LDAP_SUCCESS
+	    return LDAP_SUCCESS;
+#else
+	    goto not_there;
+#endif
+	break;
+      case 'T':
+	if (strEQ(name, "LDAP_TIMELIMIT_EXCEEDED"))
+#ifdef LDAP_TIMELIMIT_EXCEEDED
+	    return LDAP_TIMELIMIT_EXCEEDED;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_TIMEOUT"))
+#ifdef LDAP_TIMEOUT
+	    return LDAP_TIMEOUT;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_TYPE_OR_VALUE_EXISTS"))
+#ifdef LDAP_TYPE_OR_VALUE_EXISTS
+	    return LDAP_TYPE_OR_VALUE_EXISTS;
+#else
+	    goto not_there;
+#endif
+	break;
+      case 'U':
+	if (strEQ(name, "LDAP_UNAVAILABLE"))
+#ifdef LDAP_UNAVAILABLE
+	    return LDAP_UNAVAILABLE;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_UNAVAILABLE_CRITICAL_EXTENSION"))
+#ifdef LDAP_UNAVAILABLE_CRITICAL_EXTENSION
+	    return LDAP_UNAVAILABLE_CRITICAL_EXTENSION;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_UNDEFINED_TYPE"))
+#ifdef LDAP_UNDEFINED_TYPE
+	    return LDAP_UNDEFINED_TYPE;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_UNWILLING_TO_PERFORM"))
+#ifdef LDAP_UNWILLING_TO_PERFORM
+	    return LDAP_UNWILLING_TO_PERFORM;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_URL_ERR_BADSCOPE"))
+#ifdef LDAP_URL_ERR_BADSCOPE
+	    return LDAP_URL_ERR_BADSCOPE;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_URL_ERR_MEM"))
+#ifdef LDAP_URL_ERR_MEM
+	    return LDAP_URL_ERR_MEM;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_URL_ERR_NODN"))
+#ifdef LDAP_URL_ERR_NODN
+	    return LDAP_URL_ERR_NODN;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_URL_ERR_NOTLDAP"))
+#ifdef LDAP_URL_ERR_NOTLDAP
+	    return LDAP_URL_ERR_NOTLDAP;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_URL_ERR_PARAM"))
+#ifdef LDAP_URL_ERR_PARAM
+	    return LDAP_URL_ERR_PARAM;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_URL_OPT_SECURE"))
+#ifdef LDAP_URL_OPT_SECURE
+	    return LDAP_URL_OPT_SECURE;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_USER_CANCELLED"))
+#ifdef LDAP_USER_CANCELLED
+	    return LDAP_USER_CANCELLED;
+#else
+	    goto not_there;
+#endif
+	break;
+      case 'V':
+	if (strEQ(name, "LDAP_VERSION"))
+#ifdef LDAP_VERSION
+	    return LDAP_VERSION;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_VERSION1"))
+#ifdef LDAP_VERSION1
+	    return LDAP_VERSION1;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_VERSION2"))
+#ifdef LDAP_VERSION2
+	    return LDAP_VERSION2;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_VERSION3"))
+#ifdef LDAP_VERSION3
+	    return LDAP_VERSION3;
+#else
+	    goto not_there;
+#endif
+	if (strEQ(name, "LDAP_VERSION_MAX"))
+#ifdef LDAP_VERSION_MAX
+	    return LDAP_VERSION_MAX;
+#else
+	    goto not_there;
+#endif
+	break;
+      }
+    } else {
+	if (strEQ(name, "LDAPS_PORT"))
+#ifdef LDAPS_PORT
+	    return LDAPS_PORT;
+#else
+	    goto not_there;
+#endif
+    }
+
+    errno = EINVAL;
+    return 0;
+
+not_there:
+    errno = ENOENT;
+    return 0;
+}

mozilla/directory/perldap/examples/ChangeLog

@@ -0,0 +1,31 @@
+1999-01-05  Leif Hedstrom  <leif@netscape.com>
+
+	* psoftsync.pl (delAttr): Fixed annoying bug where I missed to
+	"my" $entry.
+
+1999-01-04  Leif Hedstrom  <leif@netscape.com>
+
+	* modattr.pl: Bug fixes for handling bad cases better (like
+	missing attribute, adding empty values etc).
+
+1998-12-11  Leif Hedstrom  <leif@netscape.com>
+
+	* modattr.pl: Modified slightly to enable the rebind proc.
+
+1998-08-03  Leif Hedstrom  <leif@netscape.com>
+
+	* psoftsync.pl: New file, also merged in some modules from
+	LdapUtils.pm, to make sure this works. NOTE: This script currently
+	doesn't work, since all "modify" operations are horked.
+
+1998-07-30  Leif Hedstrom  <leif@netscape.com>
+
+	* tabdump.pl: Actually works!
+
+	* ldappasswd.pl: Cleaned out some code, and moved it over to the
+	::Utils module.
+
+1998-07-29  Leif Hedstrom  <leif@netscape.com>
+
+	* qsearch.pl: First working version.
+

mozilla/directory/perldap/examples/changes2ldif.pl

@@ -0,0 +1,118 @@
+#!/usr/bin/perl5
+#############################################################################
+# $Id: changes2ldif.pl,v 1.1.2.6 1998-10-26 03:44:54 leif%netscape.com Exp $
+#
+# The contents of this file are subject to the Mozilla Public License
+# Version 1.0 (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 PerLDAP. The Initial Developer of the Original
+# Code is Netscape Communications Corp. and Clayton Donley. Portions
+# created by Netscape are Copyright (C) Netscape Communications
+# Corp., portions created by Clayton Donley are Copyright (C) Clayton
+# Donley. All Rights Reserved.
+#
+# Contributor(s):
+#
+# DESCRIPTION
+#    Search the changelog, and produce an LDIF file suitable for ldapmodify
+#    for instance. This should be merged into LDIF.pm eventually.
+#
+#############################################################################
+
+use Getopt::Std;			# To parse command line arguments.
+use Mozilla::LDAP::Conn;		# Main "OO" layer for LDAP
+use Mozilla::LDAP::Utils;		# LULU, utilities.
+
+use strict;
+no strict "vars";
+
+
+#################################################################################
+# Constants, shouldn't have to edit these...
+#
+$APPNAM	= "changes2ldif";
+$USAGE	= "$APPNAM [-nv] -b base -h host -D bind -w pswd -P cert [min [max]]";
+
+
+#################################################################################
+# Check arguments, and configure some parameters accordingly..
+#
+if (!getopts('nvb:h:D:p:s:w:P:'))
+{
+   print "usage: $APPNAM $USAGE\n";
+   exit;
+}
+%ld = Mozilla::LDAP::Utils::ldapArgs();
+$ld{root} = "cn=changelog" if (!defined($ld{root}) || $ld{root} eq "");
+
+
+#################################################################################
+# Instantiate an LDAP object, which also binds to the LDAP server.
+#
+$conn = new Mozilla::LDAP::Conn(\%ld);
+die "Could't connect to LDAP server $ld{host}" unless $conn;
+
+
+#################################################################################
+# Create the search filter.
+#
+$min = $ARGV[$[];
+$max = $ARGV[$[ + 1];
+
+if ($min ne "")
+{
+  if ($max ne "")
+    {
+      $search = "(&(changenumber>=$min)(changenumber<=$max))";
+    }
+  else
+    {
+      $search = "(changenumber>=$min)";
+    }
+}
+else
+{
+  $search = "(changenumber=*)";
+}
+  
+
+#################################################################################
+# Do the searches, and print the results.
+#
+$entry = $conn->search($ld{root}, "ONE", "$search");
+while ($entry)
+{
+  print "dn: ", $entry->{targetdn}[0], "\n";
+  $type = $entry->{changetype}[0];
+  print "changetype: $type\n";
+  if ($type =~ /modify/i)
+    {
+      # Should we filter out modifiersname and modifytimestamp ? We do chop
+      # off the trailing \0 though.
+      chop($entry->{changes}[0]);
+      print $entry->{changes}[0], "\n";
+    }
+  elsif ($type =~ /add/i)
+    {
+      print $entry->{changes}[0], "\n";
+    }
+  else
+    {
+      print "\n";
+    }
+
+  $entry = $conn->nextEntry;
+}
+
+
+#################################################################################
+# Close the connection.
+#
+$ld{conn}->close if $ld{conn};

mozilla/directory/perldap/examples/ldappasswd.pl

@@ -0,0 +1,104 @@
+#!/usr/bin/perl5
+#############################################################################
+# $Id: ldappasswd.pl,v 1.6 1998-08-13 09:13:23 leif Exp $
+#
+# The contents of this file are subject to the Mozilla Public License
+# Version 1.0 (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 PerLDAP. The Initial Developer of the Original
+# Code is Netscape Communications Corp. and Clayton Donley. Portions
+# created by Netscape are Copyright (C) Netscape Communications
+# Corp., portions created by Clayton Donley are Copyright (C) Clayton
+# Donley. All Rights Reserved.
+#
+# Contributor(s):
+#
+# DESCRIPTION
+#    This is an LDAP version of the normal passwd/yppasswd command found
+#    on most Unix systems. Note that this will only use the {crypt}
+#    encryption/hash algorithm (at this point).
+#
+#############################################################################
+
+use Getopt::Std;			# To parse command line arguments.
+use Mozilla::LDAP::Conn;		# Main "OO" layer for LDAP
+use Mozilla::LDAP::Utils;		# LULU, utilities.
+
+
+#############################################################################
+# Constants, shouldn't have to edit these...
+#
+$APPNAM	= "ldappasswd";
+$USAGE	= "$APPNAM [-nv] -b base -h host -D bind -w pswd -P cert search ...";
+
+@ATTRIBUTES = ("uid", "userpassword");
+
+
+#############################################################################
+# Check arguments, and configure some parameters accordingly..
+#
+if (!getopts('nvb:s:h:D:w:P:')) {
+   print "usage: $APPNAM $USAGE\n";
+   exit;
+}
+%ld = Mozilla::LDAP::Utils::ldapArgs();
+Mozilla::LDAP::Utils::userCredentials(\%ld) unless $opt_n;
+
+
+#############################################################################
+# Ask for the new password, and confirm it's correct.
+#
+do
+{
+  print "New password: ";
+  $new = Mozilla::LDAP::Utils::askPassword();
+  print "New password (again): ";
+  $new2 = Mozilla::LDAP::Utils::askPassword();
+  print "Passwords didn't match, try again!\n\n" if ($new ne $new2);
+} until ($new eq $new2);
+print "\n";
+
+$crypted = Mozilla::LDAP::Utils::unixCrypt("$new");
+
+
+#############################################################################
+# Now do all the searches, one by one. If there are no search criteria, we
+# will change the password for the user running the script.
+#
+$conn = new Mozilla::LDAP::Conn(\%ld);
+die "Could't connect to LDAP server $ld{host}" unless $conn;
+
+foreach $search ($#ARGV >= $[ ? @ARGV : $ld{bind})
+{
+  $entry = $conn->search($search, "subtree", "ALL", 0, @ATTRIBUTES);
+  $entry = $conn->search($ld{root}, "subtree", $search, 0, @ATTRIBUTES)
+    unless $entry;
+  print "No such user: $search\n" unless $entry;
+
+  while ($entry)
+    {
+      $entry->{userpassword} = ["{crypt}" . $crypted];
+      print "Changing password for: $entry->{dn}\n" if $opt_v;
+
+      if (!$opt_n)
+	{
+	  $conn->update($entry);
+	  $conn->printError() if $conn->getErrorCode();
+	}
+
+      $entry = $conn->nextEntry();
+    }
+}
+
+
+#############################################################################
+# Close the connection.
+#
+$conn->close if $conn;

mozilla/directory/perldap/examples/lfinger.pl

@@ -0,0 +1,128 @@
+#!/usr/bin/perl5
+#############################################################################
+# $Id: lfinger.pl,v 1.10 1998-08-13 09:13:08 leif Exp $
+#
+# The contents of this file are subject to the Mozilla Public License
+# Version 1.0 (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 PerLDAP. The Initial Developer of the Original
+# Code is Netscape Communications Corp. and Clayton Donley. Portions
+# created by Netscape are Copyright (C) Netscape Communications
+# Corp., portions created by Clayton Donley are Copyright (C) Clayton
+# Donley. All Rights Reserved.
+#
+# Contributor(s):
+#
+# DESCRIPTION
+#    "finger" version using LDAP information (using RFC 2307 objectclass).
+#
+#############################################################################
+
+use Getopt::Std;			# To parse command line arguments.
+use Mozilla::LDAP::Conn;		# Main "OO" layer for LDAP
+use Mozilla::LDAP::Utils;		# LULU, utilities.
+
+
+#############################################################################
+# Constants, shouldn't have to edit these... The HIDE mechanism is a very
+# Netscape internal specific feature. We use this objectclass to mark some
+# entries to be "hidden", and some of our applications will honor this. With
+# more recent versions of the Directory Server this can be accomplished more
+# effectively with appropriate ACI/ACLs.
+#
+$APPNAM	= "lfinger";
+$USAGE	= "$APPNAM -m -b base -h host -D bind -w pswd -P cert user_info";
+
+@ATTRIBUTES = ("uid", "cn", "homedirectory", "loginshell", "pager",
+	       "telephonenumber", "facsimiletelephonenumber", "mobile");
+$HIDE = "(objectclass=nscphidethis)";
+
+
+
+#############################################################################
+# Print a "finger" entry.
+#
+sub printIt
+{
+  my($entry) = @_;
+
+  print "Login name: $entry->{uid}[0]";
+  print " " x (39 - 11 - length($entry->{uid}[0]));
+  print "In real life: $entry->{cn}[0]\n";
+  if ($entry->{homedirectory}[0] || $entry->{loginshell}[0])
+    {
+      print "Directory: $entry->{homedirectory}[0]";
+      print " " x (39 - 10 - length($entry->{homedirectory}[0]));
+      print "Shell: $entry->{loginshell}[0]\n";
+    }
+
+  if ($entry->{telephonenumber}[0] || $entry->{pager}[0])
+    {
+      print "Phone: $entry->{telephonenumber}[0]";
+      print " " x (39 - 6 - length($entry->{telephonenumber}[0]));
+      print "Pager: $entry->{pager}[0]\n";
+    }
+
+  if ($entry->{mobile}[0] || $entry->{facsimiletelephonenumber}[0])
+    {
+      print "Mobile: $entry->{mobile}[0]";
+      print " " x (39 - 7 - length($entry->{mobile}[0]));
+      print "Fax: $entry->{facsimiletelephonenumber}[0]\n";
+    }
+
+  print "\n";
+}
+
+
+#############################################################################
+# Check arguments, and configure some parameters accordingly..
+#
+if (!getopts('mb:h:D:p:w:P:') || !defined($ARGV[$[]))
+{
+   print "usage: $APPNAM $USAGE\n";
+   exit;
+}
+%ld = Mozilla::LDAP::Utils::ldapArgs();
+$user=$ARGV[$[];
+
+
+#############################################################################
+# Instantiate an LDAP object, which also binds to the LDAP server.
+#
+$conn = new Mozilla::LDAP::Conn(\%ld);
+die "Could't connect to LDAP server $ld{host}" unless $conn;
+
+
+#############################################################################
+# Ok, lets generate the filter, and do the search!
+#
+if ($opt_m)
+{
+  $search = "(&(uid=$user)(!$HIDE))";
+}
+else
+{
+  $search = "(&(|(cn=*$user*)(uid=*$user*)(telephonenumber=*$user*))(!$HIDE))";
+}
+
+$entry = $conn->search($ld{root}, "subtree", $search, 0, @ATTRIBUTES);
+$conn->printError() if $conn->getErrorCode();
+
+while($entry)
+{
+  printIt($entry);
+  $entry = $conn->nextEntry();
+}
+
+
+#############################################################################
+# Close the connection.
+#
+$conn->close if $conn;

mozilla/directory/perldap/examples/modattr.pl

@@ -0,0 +1,331 @@
+#!/usr/bin/perl5
+#############################################################################
+# $Id: modattr.pl,v 1.7.2.4 1999-01-05 07:41:46 leif%netscape.com Exp $
+#
+# The contents of this file are subject to the Mozilla Public License
+# Version 1.0 (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 PerLDAP. The Initial Developer of the Original
+# Code is Netscape Communications Corp. and Clayton Donley. Portions
+# created by Netscape are Copyright (C) Netscape Communications
+# Corp., portions created by Clayton Donley are Copyright (C) Clayton
+# Donley. All Rights Reserved.
+#
+# Contributor(s):
+#
+# DESCRIPTION
+#    This script can be used to do a number of different modification
+#    operations on a script. Like adding/deleting values, or entire
+#    attributes.
+#
+#############################################################################
+
+use Getopt::Std;			# To parse command line arguments.
+use Mozilla::LDAP::Conn;		# Main "OO" layer for LDAP
+use Mozilla::LDAP::Utils;		# LULU, utilities.
+
+use strict;
+no strict "vars";
+
+
+#############################################################################
+# Constants, shouldn't have to edit these...
+#
+$APPNAM	= "modattr";
+$USAGE	= "$APPNAM [-dnvW] -b base -h host -D bind -w pswd -P cert attr=value filter";
+
+
+#############################################################################
+# Check arguments, and configure some parameters accordingly..
+#
+if (!getopts('adnvWb:h:D:p:s:w:P:'))
+{
+  print "usage: $APPNAM $USAGE\n";
+  exit;
+}
+%ld = Mozilla::LDAP::Utils::ldapArgs();
+Mozilla::LDAP::Utils::userCredentials(\%ld) unless $opt_n;
+
+
+#############################################################################
+# Let's process the changes requested, and commit them unless the "-n"
+# option was given.
+#
+$conn = new Mozilla::LDAP::Conn(\%ld);
+die "Could't connect to LDAP server $ld{host}" unless $conn;
+
+$conn->setDefaultRebindProc($ld{bind}, $ld{pswd});
+
+($change, $search) = @ARGV;
+if (($change eq "") || ($search eq ""))
+{
+  print "usage: $APPNAM $USAGE\n";
+  exit;
+}
+($attr, $value) = split(/=/, $change, 2);
+
+$entry = $conn->search($ld{root}, $ld{scope}, $search);
+while ($entry)
+{
+  $changed = 0;
+
+  if ($opt_d)
+    {
+      if (defined $entry->{$attr})
+	{
+	  if ($value)
+	    {
+	      $changed = $entry->removeValue($attr, $value);
+	      if ($changed && $opt_v)
+		{
+		  print "Removed value from ", $entry->getDN(), "\n" if $opt_v;
+		}
+	    }
+	  else
+	    {
+	      delete $entry->{$attr};
+	      print "Deleted attribute $attr for ", $entry->getDN(), "\n" if $opt_v;
+	      $changed = 1;
+	    }
+	}
+      else
+	{
+	  print "No attribute values for: $attr\n";
+	}
+    }
+  else
+    {
+      if (!defined($value) || !$value)
+	{
+	  print "No value provided for the attribute $attr\n";
+	}
+      elsif ($opt_a)
+	{
+	  $changed = $entry->addValue($attr, $value);
+	  if ($changed && $opt_v)
+	    {
+	      print "Added attribute to ", $entry->getDN(), "\n" if $opt_v;
+	    }
+	}
+      else
+	{
+	  $entry->setValue($attr, $value);
+	  $changed = 1;
+	  print "Set attribute for ", $entry->getDN(), "\n" if $opt_v;
+	}
+    }
+  if ($changed && ! $opt_n)
+    {
+      $conn->update($entry);
+      $conn->printError() if $conn->getErrorCode();
+    }
+
+  $entry = $conn->nextEntry();
+}
+
+
+#############################################################################
+# Close the connection.
+#
+$conn->close if $conn;
+
+
+#############################################################################
+# POD documentation...
+#
+__END__
+
+=head1 NAME
+
+  modattr - Modify an attribute for one or more LDAP entries
+
+=head1 SYNOPSIS
+
+  modattr [-adnvW] -b base -h host -D bind DN -w pwd -P cert attr=value filter
+
+=head1 ABSTRACT
+
+This command line utility can be used to modify one attribute for one or
+more LDAP entries. As simple as this sounds, this turns out to be a very
+common operation. For instance, let's say you want to change "mailHost"
+for all users on a machine named I<dredd>, to be I<judge>. With this
+script all you have to do is
+
+    modattr mailHost=judge '(mailHost=dredd)'
+
+=head1 DESCRIPTION
+
+There are four primary operations that can be made with this utility:
+
+=over 4
+
+=item *
+
+Set an attribute to a (single) specified value.
+
+=item *
+
+Add a value to an attribute (for multi-value attributes).
+
+=item *
+
+Delete a value from an attribute. If it's the last value (or if it's a
+single value), this will remove the entire attribute.
+
+=item *
+
+Delete an entire attribute, even if it has multiple values.
+
+=back
+
+The first three requires an option of the form B<attr=value>, while the
+last one only takes the name of the attribute as the option. The last
+argument is always an LDAP search filter, specifying which entries the
+operation should be applied to.
+
+=head1 OPTIONS
+
+All but the first two command line options for this tool are standard LDAP
+options, to set parameters for the LDAP connection. The two new options
+are I<-a> and I<-d> to add and remove attribute values.
+
+Without either of these two options specified (they are both optional),
+the default action is to set the attribute to the specified value. That
+will effectively remove any existing values for this attribute.
+
+=over 12
+
+=item -a
+
+Specify that the operation is an I<add>, to add a value to the
+attribute. If there is no existing value for this attribute, we'll create
+a new attribute, otherwise we add the new value if it's not already there.
+
+=item -d
+
+Delete the attribute value, or the entire attribute if there's no value
+specified. As you can see this option has two forms, and it's function
+depends on the last arguments. Be careful here, if you forget to specify
+the value to delete, you will remove all of them.
+
+=item -h <host>
+
+Name of the LDAP server to connect to.
+
+=item -p <port>
+
+TCP port for the LDAP connection.
+
+=item -b <DN>
+
+Base DN for the search
+
+=item -D <bind>
+
+User (DN) to bind as. We support a few convenience shortcuts here, like
+I<root>, I<user> and I<repl>.
+
+=item -w <passwd>
+
+This specifies the password to use when connecting to the LDAP
+server. This is strongly discouraged, and without this option the script
+will ask for the password interactively.
+
+=item -s <scope>
+
+Search scope, default is I<sub>, the other possible values are I<base> and
+I<one>. You can also specify the numeric scopes, I<0>, I<1> or I<2>.
+
+=item -P
+
+Use SSL for the LDAP connection, using the specified cert.db file for
+certificate information.
+
+=item -n
+
+Don't do anything, only show the changes that would have been made. This
+is very convenient, and can save you from embarrassing mistakes.
+
+=item -v
+
+Verbose output.
+
+=back
+
+The last two arguments are special for this script. The first
+argument specifies the attribute (and possibly the value) to operate on,
+and the last argument is a properly formed LDAP search filter.
+
+=head1 EXAMPLES
+
+We'll give one example for each of the four operations this script can
+currently handle. Since the script itself is quite flexible, you'll
+probably find you can use this script for a lot of other applications, or
+call it from other scripts. Note that we don't specify any LDAP specific
+options here, we assume you have configured your defaults properly.
+
+To set the I<description> attribute for user "leif", you would do
+
+    modattr 'description=Company Swede' '(uid=leif)'
+
+The examples shows how to use this command without either of the I<-a> or
+the I<-d> argument. To add an e-mail alias (alternate address) to the same
+user, you would do
+
+    modattr -a 'mailAlternateAddress=theSwede@netscape.com' '(uid=leif)'
+
+To remove an object class from all entries which uses it, you could do
+
+    modattr -d 'objectclass=dummyClass' '(objectclass=dummyClass)'
+
+This example is not great, since unless you've assured that no entries
+uses any of the attributes in this class, you'll get schema
+violations. But don't despair, you can use this tool to clean up all
+entries first! To completely remove all usage of an attribute named
+I<dummyAttr>, you'd simply do
+
+    modattr -d dummyAttr '(dummyAttr=*)'
+
+This shows the final format of this command, notice how we don't specify a
+value, to assure that the entire attribute is removed. This is potentially
+dangerous, so again be careful.
+
+=head1 INSTALLATION
+
+In order to use this script, you'll need Perl version 5.004 or later, the
+LDAP SDK, and also the LDAP Perl module (aka PerLDAP). Once you've installed
+these packages, just copy this file to where you keep your admin binaries,
+e.g. /usr/local/bin.
+
+In order to get good performance, you should make sure you have indexes on
+the attributes you typically use with this script. Our experience has been
+that in most cases the standard indexes in the Directory Server are
+sufficient, e.g. I<CN>, I<UID> and I<MAIL>.
+
+=head1 AVAILABILITY
+
+This package can be retrieved from a number of places, including:
+
+    http://www.mozilla.org/directory/
+    Your local CPAN server
+
+=head1 CREDITS
+
+This little tool was developed internally at Netscape, by Leif Hedstrom.
+
+=head1 BUGS
+
+None, of course...
+
+=head1 SEE ALSO
+
+L<Mozilla::LDAP::API> and L<Perl>
+
+=cut

mozilla/directory/perldap/examples/monitor.pl

@@ -0,0 +1,67 @@
+#!/usr/bin/perl5
+#############################################################################
+# $Id: monitor.pl,v 1.2 1998-08-13 09:12:05 leif Exp $
+#
+# The contents of this file are subject to the Mozilla Public License
+# Version 1.0 (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 PerLDAP. The Initial Developer of the Original
+# Code is Netscape Communications Corp. and Clayton Donley. Portions
+# created by Netscape are Copyright (C) Netscape Communications
+# Corp., portions created by Clayton Donley are Copyright (C) Clayton
+# Donley. All Rights Reserved.
+#
+# Contributor(s):
+#
+# DESCRIPTION
+#    Ask the directory server for it's monitor entry, to see some
+#    performance and usage stats.
+#
+#############################################################################
+
+use Getopt::Std;			# To parse command line arguments.
+use Mozilla::LDAP::Conn;		# Main "OO" layer for LDAP
+use Mozilla::LDAP::Utils;		# LULU, utilities.
+
+
+#################################################################################
+# Constants, shouldn't have to edit these...
+#
+$APPNAM	= "monitor";
+$USAGE	= "$APPNAM [-nv] -b base -h host -D bind -w pswd -P cert";
+
+
+#################################################################################
+# Check arguments, and configure some parameters accordingly..
+#
+if (!getopts('b:h:D:p:w:P:'))
+{
+   print "usage: $APPNAM $USAGE\n";
+   exit;
+}
+%ld = Mozilla::LDAP::Utils::ldapArgs("", "cn=monitor");
+
+
+#################################################################################
+# Instantiate an LDAP object, which also binds to the LDAP server, and then
+# do the simple search.
+#
+$conn = new Mozilla::LDAP::Conn(\%ld);
+die "Could't connect to LDAP server $ld{host}" unless $conn;
+
+$entry = $conn->search($ld{root}, "base", "objectclass=*");
+Mozilla::LDAP::Utils::printEntry($entry)
+  if ($entry);
+
+
+#################################################################################
+# Close the connection.
+#
+$conn->close if $conn;

mozilla/directory/perldap/examples/psoftsync.pl

@@ -0,0 +1,615 @@
+#!/usr/bin/perl5
+#############################################################################
+# $Id: psoftsync.pl,v 1.4.2.1 1999-01-05 11:33:46 leif%netscape.com Exp $
+#
+# The contents of this file are subject to the Mozilla Public License
+# Version 1.0 (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 PerLDAP. The Initial Developer of the Original
+# Code is Netscape Communications Corp. and Clayton Donley. Portions
+# created by Netscape are Copyright (C) Netscape Communications
+# Corp., portions created by Clayton Donley are Copyright (C) Clayton
+# Donley. All Rights Reserved.
+#
+# Contributor(s):
+#
+# DESCRIPTION
+#    Synchronise some LDAP info with a PeopleSoft "dump". This "dump" file
+#    is a "tab" separated file, as generated by an SQL utility on the
+#    Oracle server.
+#
+#############################################################################
+
+use Getopt::Std;			# To parse command line arguments.
+use Mozilla::LDAP::Conn;		# Main "OO" layer for LDAP
+use Mozilla::LDAP::Utils;		# LULU, utilities.
+
+
+#############################################################################
+# Local configurations, check these out . Note that SYNCS and ORDER has to
+# have the same fields, this is because the hash array doesn't preserve
+# the order of it's entries... :-( The "codes" are bit fields, where the
+# three LSB are used as
+#
+#	 1  Force the update, even if attribute is empty (i.e. delete it)
+#	 2  The attribute is the base for a DN (e.g. "manager").
+#	 4  The attribute should be deleted if the user is not in PeopleSoft.
+#	 8  Don't warn if the attribute is missing in the Psoft file (-W option).
+#	16  Always delete this attribute in the PeopleSoft entry.
+#	32  Delete this attribute if the account has "expired".
+#
+%SYNCS = (
+	  "nscpharold" => 1 + 4,
+	  "uid" => 0,
+	  "" => 0,
+	  "" => 0,
+	  "employeenumber" => 1 + 4 + 32,
+	  "departmentnumber" => 1 + 4,
+	  "" => 0,
+	  "" => 0,
+	  "" => 0,
+	  "manager" => 1 + 2,
+	  "title" => 1 + 4 + 16 + 32,
+	  "ou" =>  1 + 4 + 32,
+	  "businesscategory" => 1 + 4 + 32,
+	  "employeetype" => 0,
+	  "nscppersonexpdate" => 1 + 8
+	  );
+
+@ORDER = (
+	  "nscpharold",
+	  "uid",
+	  "",
+	  "",
+	  "employeenumber",
+	  "departmentnumber",
+	  "",
+	  "",
+	  "",
+	  "manager",
+	  "title",
+	  "ou",
+	  "businesscategory",
+	  "employeetype",
+	  "nscppersonexpdate"
+	  );
+
+# This is used for mapping the employeeType attribute into a readable format.
+%EMPCODES = (
+	     "A" => "Applicant",
+	     "C" => "Contractor",
+	     "E" => "Employee",
+	     "O" => "OEM Partner",
+	     "T" => "Interim",
+	     "V" => "Vendor"
+	     );
+
+# Expiration policy for other attributes, the EXPDELAY is a convenience
+# default setting.
+$EXPDELAY = 24 * 7;
+%EXPIRES = (
+	    "carlicense"		=> $EXPDELAY,
+	    "mailautoreplymode"		=> $EXPDELAY,
+	    "mailautoreplytext"		=> $EXPDELAY,
+	    "mailforwardingaddress"	=> $EXPDELAY,
+	    "facsimiletelephonenumber"	=> $EXPDELAY
+	    );
+	    
+
+$NOTYPE = "Unknown";
+$DELIMITER = "%%";
+$SENDMAIL = "/usr/lib/sendmail";
+
+$SEARCH = "(&(uid=*)(!(objectclass=pseudoAccount)))";
+$MAILTO = "leif\@netscape.com";
+
+#$LDAP_DEBUG = 1;
+
+
+#############################################################################
+# Constants, shouldn't have to edit these...
+#
+$APPNAM	= "psoftsync";
+$USAGE	= "$APPNAM [-nvW] -b base -h host -D bind -w passwd -P cert PS_file";
+
+@ATTRIBUTES = uniq(@ORDER);
+push(@ATTRIBUTES, "objectclass");
+
+$TODAY = `/usr/bin/date '+%Y%m%d'`;
+chop($TODAY);
+
+
+#############################################################################
+# Print an error for the PeopleSoft data. Note that we use the "__XXX__" fields
+# here, to avoid the problem when an attribute is "expired" or modified.
+#
+sub psoftError
+{
+  my ($str, $entry) = @_;
+
+  print "Error: $str: ";
+  print $entry->key(), " (";
+  print $entry->{__employeenumber__}, ", ";
+  print $entry->{__employeetype__}, ", ";
+  print $entry->{__departmentnumber__}, ")\n";
+}
+
+
+#############################################################################
+# Read in a PeopleSoft file, and create all the entries.
+#
+sub readDump
+{
+  my ($file) = @_;
+  my (@info, %entries);
+  my $val;
+
+  if (!open(PSOFT, $file))
+    {
+      print "Error: Can't read file $file\n";
+
+      exit(1);
+    }
+
+  while (<PSOFT>)
+    {
+      next unless /$DELIMITER/;
+
+      @info = split(/\s*%%\s*/);
+      $entry = new PsoftEntry($info[$[]);
+      foreach $attr (@ORDER)
+	{
+	  $val = shift(@info);
+	  next if ($attr eq "");
+
+	  $entry->add($attr, $val, $SYNCS{$attr});
+	}
+      #
+      # Perhaps we should do some sanity checks here on the PeopleSoft data?
+      #
+
+      # Clean up some data if the user has expired ("best before...")
+      if ($entry->expired($entry->{nscppersonexpdate}))
+	{
+	  foreach $attr (@ORDER)
+	    {
+	      next unless $attr;
+
+	      delete($entry->{$attr}) if ($SYNCS{$attr} & 32);
+	    }
+	}
+
+      if ($entry->{uid})
+	{
+	  $entries{$entry->{uid}} = $entry;
+	}
+      elsif ($opt_W)
+	{
+	  psoftError("No UID", $entry);
+	}
+    }
+  close(PSOFT);
+
+  return %entries;
+}
+
+
+#############################################################################
+# Make a list "uniq", just like the Unix command.
+#
+sub uniq {				# uniq(elements[])
+  my %tmp;
+   
+  grep($tmp{$_}++, @_);
+  return sort(keys(%tmp));
+}
+
+
+#############################################################################
+# Delete an attribute from an entry.
+#
+sub delAttr {				# delAttr(ENTRY, ATTR)
+  my ($entry, $attr) = @_;
+
+  if (defined($entry->{$attr}))
+    {
+      $out->write("Deleted $attr for user: $entry->{uid}[0]") if $opt_v;
+      delete($entry->{$attr});
+
+      return 1;
+    }
+
+  return 0;
+}
+
+
+#############################################################################
+# Check arguments, and configure some parameters accordingly..
+#
+if (!getopts('nvMWb:h:D:p:s:w:P:'))
+{
+  print "usage: $APPNAM $USAGE\n";
+  exit;
+}
+%ld = Mozilla::LDAP::Utils::ldapArgs();
+Mozilla::LDAP::Utils::userCredentials(\%ld) unless $opt_n;
+
+$out = new Mail();
+if ($opt_M)
+{
+  $out->set("to", $MAILTO);
+  $out->set("subject", "Hoth: PeopleSoft synchronization report");
+}
+else
+{
+  $out->echo();
+  $out->nomail();
+}
+
+
+#############################################################################
+# Read in all the PeopleSoft entries, and then instantiate an LDAP object,
+# which also binds to the LDAP server.
+#
+%psoft = readDump(@ARGV[$[]);
+$conn = new Mozilla::LDAP::Conn(\%ld);
+die "Could't connect to LDAP server $ld{host}" unless $conn;
+
+
+#############################################################################
+# Now process all the users, one by one.
+#
+$entry = $conn->search($ld{root}, "subtree", $SEARCH, 0, @ATTRIBUTES);
+
+while ($entry)
+{
+  $uid = $entry->{"uid"}[0];
+  $changed = 0;
+
+  $psent = $psoft{$uid};
+  if (!$psent)
+    {
+      print "Error: LDAP user $uid: No entry in PeopleSoft\n" if $opt_W;
+      foreach $attr (@ORDER)
+	{
+	  next unless $attr;
+	  $changed += delAttr($entry, $attr) if ($SYNCS{$attr} & 4);
+	}
+      if ($entry->{employeetype}[0] ne "$NOTYPE")
+	{
+	  $entry->{employeetype} = ["$NOTYPE"];
+	  $changed = 1;
+	  $out->write("Set employeeType to $NOTYPE for user: $uid") if $opt_v;
+	}
+	  
+    }
+  else
+    {
+      $psent->handled(1);
+      foreach $attr (@ORDER)
+	{
+	  next unless $attr;
+
+	  if (!defined($psent->{$attr}) || ($psent->{$attr} eq ""))
+	    {
+	      $changed += delAttr($entry, $attr) if ($SYNCS{$attr} & 1);
+	    }
+	  elsif ($entry->{$attr}[0] ne $psent->{$attr})
+	    {
+	      $entry->{$attr} = [$psent->{$attr}];
+	      $changed = 1;
+	      $out->write("Set $attr to $psent->{$attr} for user: $uid") if $opt_v;
+	    }
+	}
+      # Now handle the Expire date special case...
+      if ($psent->expired() ne "")
+	{
+	  if ($entry->addValue("objectclass", "nscphidethis"))
+	    {
+	      $changed = 1;
+	      $out->write("Expiring the user: $uid") if $opt_v;
+	    }
+
+	  # Expire other attributes, IFF the expire is over a certain
+	  # treshhold (e.g. a week).
+	}
+      elsif ($entry->removeValue("objectclass", "nscphidethis"))
+	{
+	  $changed = 1;
+	  $out->write("Enabling the user: $uid") if $opt_v;
+	}
+    }
+
+  $conn->update($entry) if ($changed && ! $opt_n);
+  $entry = $conn->nextEntry();
+}
+
+
+#############################################################################
+# Close the LDAP connection.
+#
+$conn->close if $conn;
+
+
+#############################################################################
+# Post process, figure out which PSoft entries have no entry in LDAP.
+#
+if ($opt_W)
+{
+  foreach (keys(%psoft))
+    {
+      $ent=$psoft{$_};
+      
+      psoftError("No LDAP entry", $ent) unless $ent->handled();
+    }
+}
+
+
+
+#############################################################################
+# Package to an entry from the PeopleSoft database.
+#
+package PsoftEntry;
+
+
+#############################################################################
+# Creator.
+#
+sub new
+{
+  my ($class, $key) = @_;
+  my $self = {};
+  
+  bless $self, ref $class || $class;
+  $self->{__key__} = $key;
+
+  return $self;
+}
+
+
+#############################################################################
+# Add an attribute/field to the entry.
+#
+sub add
+{
+  my ($self, $attr, $val, $lev) = @_;
+
+  return if ($lev & 16);
+
+  $attr = lc $attr;
+  if ($attr eq "employeetype")
+    {
+      if (defined($main::EMPCODES{$val}))
+	{
+	  $self->{$attr} = $main::EMPCODES{$val};
+	}
+      else
+	{
+	  $self->{$attr} = $main::NOTYPE;
+	}
+      $self->{__employeetype__} = $val;
+    }
+  elsif (!defined($val) || ($val eq ""))
+    {
+      main::psoftError("No attribute $attr", $self)
+	if ($main::opt_W && ($lev & 1) && !($lev & 8));
+    }
+  else
+    {
+      $self->{$attr} = ($lev & 2) ? "uid=$val,$main::ld{root}" : $val;
+      $self->{"__${attr}__"} = $val;
+    }
+}
+
+
+#############################################################################
+# Return the value for an attribute/field.
+#
+sub get
+{
+  my ($self, $attr) = @_;
+
+  return $self->{$attr};
+}
+
+
+#############################################################################
+# Mark the entry as "expired". If there is no "date" argument, we'll return
+# the current entries expire status.
+#
+sub expired
+{
+  my ($self, $date) = @_;
+
+  if ($date)
+    {
+      # Only expire entries with reasonable expire dates...
+      if (length($date) != 8)
+	{
+	  main::psoftError("Bad expire date", $self) if $main::opt_W;
+
+	  return 0;
+	}
+
+      if ($date lt $main::TODAY)
+	{
+	  $self->{employeetype} = "$main::NOTYPE";
+	  $self->{__expired__} = 1;
+
+	  return 1;
+	}
+    }
+
+  return $self->{__expired__};
+}
+
+
+#############################################################################
+# Mark the entry as "handled", i.e. it exists in LDAP.
+#
+sub handled
+{
+  my ($self, $flag) = @_;
+
+  $self->{__handled__} = 1 if $flag;
+
+  return $self->{__handled__};
+}
+
+
+#############################################################################
+# Return the "key" of this entry, typically the name field.
+#
+sub key
+{
+  my ($self) = @_;
+
+  return $self->{__key__};
+}
+
+
+#################################################################################
+# This sub-package will send mail to some recipients, IFF there is anything to
+# send, or your force it to send. Note that the Subject doesn't qualify it to
+# send a message (force it to send if you have to).
+#
+package Mail;
+
+
+#################################################################################
+# The constructor, which optionally takes the TO, FROM and SUBJECT.
+#
+sub new
+{
+  my ($class, $to, $from, $subject) = @_;
+  my $self = {};
+
+  bless $self, ref $class || $class;
+
+  $self->{to} = $to || "root";
+  $self->{from} = $from || "ldap";
+  $self->{subject} = $subject || "Output from LDAP script\n";
+  @{$self->{message}} = ();
+  $self->{send} = 0;
+  $self->{nomail} = 0;
+  $self->{echo} = 0;
+
+  return $self;
+}
+
+
+#################################################################################
+# Destructor, which will also send the message, if appropriate.
+#
+sub DESTROY
+{
+  my ($self) = @_;
+
+  if ($self->{send} && !$self->{nomail})
+    {
+      $self->send();
+      $self->{send} = 0;
+    }
+}
+
+
+#################################################################################
+# Set a field for this entry, e.g. From:, To: etc.
+#
+sub set
+{
+  my ($self, $field, $string) = @_;
+
+  if ($field && $string)
+    {
+      $field = lc $field;
+      $self->{$field} = $string;
+    }
+}
+
+
+#################################################################################
+# Add a line to the message, the argument is the string.
+#
+sub write
+{
+  my ($self, $string) = @_;
+
+  if ($string ne "")
+    {
+      push(@{$self->{message}}, $string);
+      print "$string\n" if $self->{echo};
+
+      $self->{send}++;
+    }
+}
+
+
+#################################################################################
+# Force the object to send the message, no matter if there's anything in the
+# body or not.
+#
+sub force
+{
+  my ($self) = @_;
+
+  $self->{send} = 1;
+  $self->{nomail} = 0;
+}
+
+
+#################################################################################
+# Don't send the mail, this is the oppositte to "force...
+#
+sub nomail
+{
+  my ($self) = @_;
+
+  $self->{send} = 0;
+  $self->{nomail} = 1;
+}
+
+
+#################################################################################
+# Enable echo-mode, where we will also print everything to STDOUT.
+#
+sub echo
+{
+  my ($self) = @_;
+
+  $self->{echo} = 1;
+}
+
+
+#################################################################################
+# Actually send the message. This is automatically done by the DESTROY method,
+# but we can force it to do it this way.
+#
+sub send
+{
+  my ($self) = @_;
+
+  if ($self->{send} && !$self->{nomail})
+    {
+      open(MAILER, "|$main::SENDMAIL -t");
+      print MAILER "From: $self->{from}\n";
+      print MAILER "To: $self->{to}\n";
+      print MAILER "Subject: $self->{subject}\n\n";
+
+      foreach (@{$self->{message}})
+	{
+	  print MAILER "$_\n";
+	}
+      print MAILER ".\n";
+
+      close(MAILER);
+      $self->{send} = 0;
+    }
+}

mozilla/directory/perldap/examples/qsearch.pl

@@ -0,0 +1,98 @@
+#!/usr/bin/perl5
+#############################################################################
+# $Id: qsearch.pl,v 1.7.2.2 1999-01-05 07:30:42 leif%netscape.com Exp $
+#
+# The contents of this file are subject to the Mozilla Public License
+# Version 1.0 (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 PerLDAP. The Initial Developer of the Original
+# Code is Netscape Communications Corp. and Clayton Donley. Portions
+# created by Netscape are Copyright (C) Netscape Communications
+# Corp., portions created by Clayton Donley are Copyright (C) Clayton
+# Donley. All Rights Reserved.
+#
+# Contributor(s):
+#
+# DESCRIPTION
+#    Quick Search, like ldapsearch, but in Perl. Look how simple it is.
+#
+#############################################################################
+
+use Getopt::Std;			# To parse command line arguments.
+use Mozilla::LDAP::Conn;		# Main "OO" layer for LDAP
+use Mozilla::LDAP::Utils;		# LULU, utilities.
+
+use strict;
+no strict "vars";
+
+
+#################################################################################
+# Constants, shouldn't have to edit these...
+#
+$APPNAM	= "qsearch";
+$USAGE	= "$APPNAM -b base -h host -D bind -w pswd -P cert filter [attr...]";
+
+
+#################################################################################
+# Check arguments, and configure some parameters accordingly..
+#
+if (!getopts('b:h:D:p:s:w:P:'))
+{
+   print "usage: $APPNAM $USAGE\n";
+   exit;
+}
+%ld = Mozilla::LDAP::Utils::ldapArgs();
+
+
+#################################################################################
+# Now do all the searches, one by one.
+#
+$conn = new Mozilla::LDAP::Conn(\%ld);
+die "Could't connect to LDAP server $ld{host}" unless $conn;
+
+foreach (@ARGV)
+{
+  if (/\=/)
+    {
+      push(@srch, $_);
+    }
+  else
+    {
+      push(@attr, $_);
+    }
+}
+
+foreach $search (@srch)
+{
+  if ($#attr >= $[)
+    {
+      $entry = $conn->search($ld{root}, $ld{scope}, $search, 0, @attr);
+    }
+  else
+    {
+      $entry = $conn->search($ld{root}, $ld{scope}, "$search");
+    }
+
+  print "Searched for `$search':\n\n";
+  $conn->printError() if $conn->getErrorCode();
+
+  while ($entry)
+    {
+      $entry->printLDIF();
+      $entry = $conn->nextEntry;
+    }
+  print "\n";
+}
+
+
+#################################################################################
+# Close the connection.
+#
+$conn->close if $conn;

mozilla/directory/perldap/examples/rename.pl

@@ -0,0 +1,98 @@
+#!/usr/bin/perl5
+#############################################################################
+# $Id: rename.pl,v 1.3.2.1 1998-09-08 06:37:33 leif%netscape.com Exp $
+#
+# The contents of this file are subject to the Mozilla Public License
+# Version 1.0 (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 PerLDAP. The Initial Developer of the Original
+# Code is Netscape Communications Corp. and Clayton Donley. Portions
+# created by Netscape are Copyright (C) Netscape Communications
+# Corp., portions created by Clayton Donley are Copyright (C) Clayton
+# Donley. All Rights Reserved.
+#
+# Contributor(s):
+#
+# DESCRIPTION
+#    Rename an LDAP entry, changing it's DN. Note that currently this only
+#    works with RDNs.
+#
+#############################################################################
+
+use Getopt::Std;			# To parse command line arguments.
+use Mozilla::LDAP::Conn;		# Main "OO" layer for LDAP
+use Mozilla::LDAP::Utils;		# LULU, utilities.
+
+
+#############################################################################
+# Constants, shouldn't have to edit these...
+#
+$APPNAM	= "rename";
+$USAGE	= "$APPNAM [-nvI] -b base -h host -D bind -w pswd -P cert filter new_rdn";
+
+
+#############################################################################
+# Check arguments, and configure some parameters accordingly..
+#
+if (!getopts('nvIb:h:D:w:P:'))
+{
+  print "usage: $APPNAM $USAGE\n";
+  exit;
+}
+%ld = Mozilla::LDAP::Utils::ldapArgs();
+Mozilla::LDAP::Utils::userCredentials(\%ld) unless $opt_n;
+
+($search, $rdn) = @ARGV;
+if (($search eq "") || ($rdn eq ""))
+{
+  print "usage: $APPNAM $USAGE\n";
+  exit;
+}
+
+
+#############################################################################
+# Instantiate an LDAP object, which also binds to the LDAP server.
+#
+$conn = new Mozilla::LDAP::Conn(\%ld);
+die "Could't connect to LDAP server $ld{host}" unless $conn;
+
+$key = "Y" if $opt_I;
+$entry = $conn->search($ld{root}, $ld{scope}, $search, 0, @ATTRIBUTES);
+$conn->printError() if $conn->getErrorCode();
+
+if (! $entry || $conn->nextEntry())
+{
+  print "Error: The search did not return exactly one match, abort!\n";
+  exit;
+}
+
+if (! $opt_I)
+{
+  print "Rename ", $entry->getDN(), " with $rdn [N]? ";
+  $key = Mozilla::LDAP::Utils::answer("N") unless $opt_I;
+}
+
+if ($key eq "Y")
+{
+  # Note: I have to explicitly specify the original DN below, since the call
+  # to nextEntry() above blows the DN away from the ::Conn object.
+  if (! $opt_n)
+    {
+      $conn->modifyRDN($rdn, $entry->getDN());
+      $conn->printError() if $conn->getErrorCode();
+    }
+  print "Renamed $entry->{dn}\n" if $opt_v;
+}
+
+
+#################################################################################
+# Close the connection.
+#
+$conn->close if $conn;

mozilla/directory/perldap/examples/rmentry.pl

@@ -0,0 +1,94 @@
+#!/usr/bin/perl5
+#############################################################################
+# $Id: rmentry.pl,v 1.3.2.1 1998-09-29 07:33:09 leif%netscape.com Exp $
+#
+# The contents of this file are subject to the Mozilla Public License
+# Version 1.0 (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 PerLDAP. The Initial Developer of the Original
+# Code is Netscape Communications Corp. and Clayton Donley. Portions
+# created by Netscape are Copyright (C) Netscape Communications
+# Corp., portions created by Clayton Donley are Copyright (C) Clayton
+# Donley. All Rights Reserved.
+#
+# Contributor(s):
+#
+# DESCRIPTION
+#    Remove one or several LDAP objects. By default this tool is
+#    interactive, which can be disabled with the "-I" option (but
+#    please be careful...).
+#
+#############################################################################
+
+use Getopt::Std;			# To parse command line arguments.
+use Mozilla::LDAP::Conn;		# Main "OO" layer for LDAP
+use Mozilla::LDAP::Utils;		# LULU, utilities.
+
+
+#################################################################################
+# Constants, shouldn't have to edit these...
+#
+$APPNAM	= "rmentry";
+$USAGE	= "$APPNAM [-nvI] -b base -h host -D bind -w pswd -P cert filter ...";
+
+@ATTRIBUTES = ("uid");
+
+
+#################################################################################
+# Check arguments, and configure some parameters accordingly..
+#
+if (!getopts('nvIb:h:D:w:P:'))
+{
+  print "usage: $APPNAM $USAGE\n";
+  exit;
+}
+%ld = Mozilla::LDAP::Utils::ldapArgs();
+Mozilla::LDAP::Utils::userCredentials(\%ld) unless $opt_n;
+
+
+#################################################################################
+# Do the search, and process all the entries.
+#
+$conn = new Mozilla::LDAP::Conn(\%ld);
+die "Could't connect to LDAP server $ld{host}" unless $conn;
+
+$key = "Y" if $opt_I;
+foreach $search (@ARGV)
+{
+  $entry = $conn->search($ld{root}, $ld{scope}, $search, 0, @ATTRIBUTES);
+  $conn->printError() if $conn->getErrorCode();
+
+  while ($entry)
+    {
+      if (! $opt_I)
+	{
+	  print "Delete $entry->{dn} [N]? ";
+	  $key = Mozilla::LDAP::Utils::answer("N") unless $opt_I;
+	}
+
+      if ($key eq "Y")
+	{
+	  if (! $opt_n)
+	    {
+	      $conn->delete($entry);
+	      $conn->printError() if $conn->getErrorCode();
+	    }
+	  print "Deleted $entry->{dn}\n" if $opt_v;
+	}
+
+      $entry = $conn->nextEntry();
+    }
+}
+
+
+#################################################################################
+# Close the connection.
+#
+$conn->close if $conn;

mozilla/directory/perldap/examples/tabdump.pl

@@ -0,0 +1,81 @@
+#!/usr/bin/perl5
+#############################################################################
+# $Id: tabdump.pl,v 1.3 1998-08-13 09:11:10 leif Exp $
+#
+# The contents of this file are subject to the Mozilla Public License
+# Version 1.0 (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 PerLDAP. The Initial Developer of the Original
+# Code is Netscape Communications Corp. and Clayton Donley. Portions
+# created by Netscape are Copyright (C) Netscape Communications
+# Corp., portions created by Clayton Donley are Copyright (C) Clayton
+# Donley. All Rights Reserved.
+#
+# Contributor(s):
+#
+# DESCRIPTION
+#    Generate a TAB separate "dump" of entries matching the search criteria,
+#    using the list of attributes specified.
+#
+#############################################################################
+
+use Getopt::Std;			# To parse command line arguments.
+use Mozilla::LDAP::Conn;		# Main "OO" layer for LDAP
+use Mozilla::LDAP::Utils;		# LULU, utilities.
+
+
+#################################################################################
+# Constants, shouldn't have to edit these...
+#
+$APPNAM	= "tabdump";
+$USAGE	= "$APPNAM [-nv] -b base -h host -D bind -w pswd -P cert attr1,attr2,.. srch";
+
+
+#################################################################################
+# Check arguments, and configure some parameters accordingly..
+#
+if (!getopts('nvb:h:D:p:s:w:P:'))
+{
+   print "usage: $APPNAM $USAGE\n";
+   exit;
+}
+%ld = Mozilla::LDAP::Utils::ldapArgs();
+
+$attributes = $ARGV[$[];
+$search = $ARGV[$[ + 1];
+die "Need to specify a list of attributes and the search filter.\n"
+  unless ($attributes && $search);
+
+
+#################################################################################
+# Do the searches, and produce the output.
+#
+$conn = new Mozilla::LDAP::Conn(\%ld);
+die "Could't connect to LDAP server $ld{host}" unless $conn;
+
+@attr = split(/,/, $attributes);
+$entry = $conn->search($ld{root}, $ld{scope}, $search, 0, @attr);
+$conn->printError() if $conn->getErrorCode();
+
+while ($entry)
+{
+  foreach (@attr)
+    {
+      print $entry->{$_}[0], "\t";
+    }
+  print "\n";
+  $entry = $conn->nextEntry;
+}
+
+
+#################################################################################
+# Close the connection.
+#
+$conn->close if $conn;

mozilla/directory/perldap/install-bin

@@ -0,0 +1,59 @@
+#!/usr/bin/perl -w
+#############################################################################
+#
+# The contents of this file are subject to the Mozilla Public License
+# Version 1.0 (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 PerLDAP. The Initial Developer of the Original
+# Code is Netscape Communications Corp. and Clayton Donley. Portions
+# created by Netscape are Copyright (C) Netscape Communications
+# Corp., portions created by Clayton Donley are Copyright (C) Clayton
+# Donley. All Rights Reserved.
+#
+# Contributor(s):
+#
+# DESCRIPTION
+#    Perl Script to Install PerLDAP Binaries without a Makefile.
+#    For use with the binary distribution of PerLDAP.
+#
+#############################################################################
+
+use File::Path;
+use File::Copy;
+use Config;
+
+print "\n##############################################\n";
+print "#       Installing Netscape PerLDAP v1.0     #\n";
+print "##############################################\n\n";
+
+$ARCH_LIB = $Config{'sitearchexp'} . "/auto/Mozilla/LDAP/API";
+$PERL_LIB = $Config{'sitelibexp'};
+
+print "Creating Directory '$ARCH_LIB'...\n";
+File::Path::mkpath "$ARCH_LIB";
+print "Creating Directory '$PERL_LIB/Mozilla/LDAP'...\n";
+File::Path::mkpath "$PERL_LIB/Mozilla/LDAP";
+
+print "Copying Architecture Dependent Files...\n";
+
+foreach $file (glob "blib/arch/auto/Mozilla/LDAP/API/*")
+{
+   copy($file,"$ARCH_LIB");
+}
+
+print "Copying Module Components...\n";
+
+foreach $file (glob "blib/lib/Mozilla/LDAP/*")
+{
+   copy($file,"$PERL_LIB/Mozilla/LDAP");
+}
+
+print "Finished!\n\n";
+exit 0;

mozilla/directory/perldap/t/ChangeLog

@@ -0,0 +1,6 @@
+1999-01-05  Leif Hedstrom  <leif@netscape.com>
+
+	* entry.pl: New script, to test all Entry:: methods.
+
+	* conn.pl (attributeEQ): Added test for modifyRDN().
+

mozilla/directory/perldap/t/conn.pl

@@ -0,0 +1,270 @@
+#!/usr/bin/perl5
+#############################################################################
+# $Id: conn.pl,v 1.1.2.5 1999-01-13 08:02:48 leif%netscape.com Exp $
+#
+# The contents of this file are subject to the Mozilla Public License
+# Version 1.0 (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 PerLDAP. The Initial Developer of the Original
+# Code is Netscape Communications Corp. and Clayton Donley. Portions
+# created by Netscape are Copyright (C) Netscape Communications
+# Corp., portions created by Clayton Donley are Copyright (C) Clayton
+# Donley. All Rights Reserved.
+#
+# Contributor(s):
+#
+# DESCRIPTION
+#    Test most (all?) of the LDAP::Mozilla::Conn methods.
+#
+#############################################################################
+
+use Getopt::Std;			# To parse command line arguments.
+use Mozilla::LDAP::Conn;		# Main "OO" layer for LDAP
+use Mozilla::LDAP::Utils;		# LULU, utilities.
+use Mozilla::LDAP::API;
+
+use strict;
+no strict "vars";
+
+
+#################################################################################
+# Configurations, modify these as needed.
+#
+$BIND	= "uid=ldapadmin";
+$BASE	= "o=Netscape Communications Corp.,c=US";
+$PEOPLE	= "ou=people";
+$GROUPS	= "ou=groups";
+$UID	= "leif-test";
+$CN	= "test-group-1";
+
+
+#################################################################################
+# Constants, shouldn't have to edit these...
+#
+$APPNAM	= "conn.pl";
+$USAGE	= "$APPNAM -b base -h host -D bind -w pswd -P cert";
+
+
+#################################################################################
+# Check arguments, and configure some parameters accordingly..
+#
+if (!getopts('b:h:D:p:s:w:P:'))
+{
+   print "usage: $APPNAM $USAGE\n";
+   exit;
+}
+%ld = Mozilla::LDAP::Utils::ldapArgs($BIND, $BASE);
+
+
+#################################################################################
+# Get an LDAP connection
+#
+sub getConn
+{
+  my $conn;
+
+  if ($main::reuseConn)
+    {
+      if (!defined($main::mainConn))
+	{
+	  $main::mainConn = new Mozilla::LDAP::Conn(\%main::ld);
+	  die "Could't connect to LDAP server $main::ld{host}"
+	    unless $main::mainConn;
+	}
+      return $main::mainConn;
+    }
+  else
+    {
+      $conn = new Mozilla::LDAP::Conn(\%main::ld);
+      die "Could't connect to LDAP server $main::ld{host}" unless $conn;
+    }
+
+  return $conn;
+}
+
+
+#################################################################################
+# Some small help functions...
+#
+sub dotPrint
+{
+  my $str = shift;
+
+  print $str . '.' x (20 - length($str));
+}
+
+sub attributeEQ
+{
+  my @a, @b;
+  my $i;
+
+  @a = @{$_[0]};
+  @b = @{$_[1]};
+  return 1 if (($#a < 0) && ($#b < 0));
+  return 0 unless ($#a == $#b);
+
+  @a = sort(@a);
+  @b = sort(@b);
+  for ($i = 0; $i <= $#a; $i++)
+    {
+      return 0 unless ($a[$i] eq $b[$i]);;
+    }
+
+  return 1;             # We passed all the tests, we're ok.
+}
+
+
+#################################################################################
+# Test adding, deleting and retrieving entries.
+#
+$filter = "(uid=$UID)";
+$conn = getConn();
+$nentry = $conn->newEntry();
+
+$nentry->setDN("uid=$UID, $PEOPLE, $BASE");
+$nentry->{objectclass} = [ "top", "person", "inetOrgPerson", "mailRecipient" ];
+$nentry->addValue("uid", $UID);
+$nentry->addValue("sn", "Hedstrom");
+$nentry->addValue("givenName", "Leif");
+$nentry->addValue("cn", "Leif Hedstrom");
+$nentry->addValue("cn", "Leif P. Hedstrom");
+$nentry->addValue("cn", "The Swede");
+$nentry->addValue("mail", "leif\@ogre.com");
+
+$ent = $conn->search($ld{root}, $ld{scope}, $filter);
+$conn->delete($ent->getDN()) if $ent;
+
+dotPrint("Conn/newEntry");
+$conn->add($nentry) || print "not ";
+print "ok\n";
+
+dotPrint("Conn/delete");
+$conn->delete($nentry) || print "not ";
+print "ok\n";
+
+dotPrint("Conn/add");
+$conn->add($nentry) || print "not ";
+print "ok\n";
+
+dotPrint("Conn/delete(DN)");
+$conn->delete($nentry->getDN()) || print "not ";
+print "ok\n";
+
+$conn->add($nentry) || die "Can't create entry again...\n";
+dotPrint("Conn/search");
+$ent = $conn->search($ld{root}, $ld{scope}, $filter);
+$err = 0;
+foreach (keys (%{$nentry}))
+{
+  $err = 1 unless (defined($ent->{$_})
+		   && attributeEQ($nentry->{$_}, $ent->{$_}));
+}
+print "not " if $err;
+print "ok\n";
+
+$conn->close();
+
+
+#################################################################################
+# Test LDAP URL handling.
+#
+$conn = getConn();
+
+$url1 = "ldap:///" . $ld{root} . "??sub?$filter";
+$url2 = "ldaps:///" . $ld{root} . "??sub?$filter";
+$badurl1 = "ldap:" . $ld{root} . "??sub?$filter";
+$badurl2 = "http://" . $ld{root} . "??sub?$filter";
+
+dotPrint("Conn/isURL");
+print "not " unless ($conn->isURL($url1) && $conn->isURL($url2) &&
+		     !$conn->isURL($badurl2) && !$conn->isURL($badurl1));
+print "ok\n";
+
+dotPrint("Conn/searchURL");
+$ent = $conn->searchURL($url1);
+$err = 0;
+foreach (keys (%{$nentry}))
+{
+  
+  $err = 1 unless (defined($ent->{$_})
+		   && attributeEQ($nentry->{$_}, $ent->{$_}));
+}
+print "not " if $err;
+print "ok\n";
+
+$conn->close();
+
+
+#################################################################################
+# Test some small internal stuff.
+#
+$conn = getConn();
+
+$ent = $conn->search($ld{root}, $ld{scope}, $filter);
+print "Can't locate entry again" unless $ent;
+
+dotPrint("Conn/getLD+getRes");
+$err = 0;
+$cld = $conn->getLD();
+$res = $conn->getRes();
+
+$err = 1 unless $cld;
+$err = 1 unless $res;
+
+$count = Mozilla::LDAP::API::ldap_count_entries($cld, $res);
+$err = 1 unless ($count == 1);
+print "not " if $err;
+print "ok\n";
+
+$conn->close();
+
+
+#################################################################################
+# Test the simple authentication method
+#
+$conn = new Mozilla::LDAP::Conn($ld{host}, $ld{port});
+$ent = $conn->search($ld{root}, $ld{scope}, $filter);
+die "Can't locate entry again" unless $ent;
+
+dotPrint("Conn/simpleAuth");
+$err = 0;
+$conn->simpleAuth($ld{bind}, $ld{pswd}) || ($err = 1);
+$ent = $conn->search($ld{root}, $ld{scope}, $filter);
+$err = 1 unless $ent;
+print "not " if $err;
+print "ok\n";
+
+$conn->close();
+
+
+#################################################################################
+# Test the modifyRDN functionality
+#
+$conn = getConn();
+$ent = $conn->search($ld{root}, $ld{scope}, $filter);
+die "Can't locate entry again" unless $ent;
+
+dotPrint("Conn/modifyRDN");
+$err = 0;
+$rdn = "uid=$UID-rdn";
+$conn->modifyRDN($rdn, $ent->getDN()) || ($err = 1);
+
+$filter = "($rdn)";
+$ent = $conn->search($ld{root}, $ld{scope}, $filter);
+$err = 1 unless $ent;
+print "not " if $err;
+print "ok\n";
+
+$conn->delete($ent->getDN()) if $ent;
+
+
+#################################################################################
+# Test error handling (ToDo!)
+#

mozilla/directory/perldap/t/entry.pl

@@ -0,0 +1,150 @@
+#!/usr/bin/perl5
+#############################################################################
+# $Id: entry.pl,v 1.1.2.2 1999-01-13 08:02:49 leif%netscape.com Exp $
+#
+# The contents of this file are subject to the Mozilla Public License
+# Version 1.0 (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 PerLDAP. The Initial Developer of the Original
+# Code is Netscape Communications Corp. and Clayton Donley. Portions
+# created by Netscape are Copyright (C) Netscape Communications
+# Corp., portions created by Clayton Donley are Copyright (C) Clayton
+# Donley. All Rights Reserved.
+#
+# Contributor(s):
+#
+# DESCRIPTION
+#    Test most (all?) of the LDAP::Mozilla::Conn methods.
+#
+#############################################################################
+
+use Getopt::Std;			# To parse command line arguments.
+use Mozilla::LDAP::Conn;		# Main "OO" layer for LDAP
+use Mozilla::LDAP::Utils;		# LULU, utilities.
+use Mozilla::LDAP::API;
+
+use strict;
+no strict "vars";
+
+
+#################################################################################
+# Configurations, modify these as needed.
+#
+$BIND	= "uid=ldapadmin";
+$BASE	= "o=Netscape Communications Corp.,c=US";
+$PEOPLE	= "ou=people";
+$GROUPS	= "ou=groups";
+$UID	= "leif-test";
+$CN	= "test-group-1";
+
+
+#################################################################################
+# Constants, shouldn't have to edit these...
+#
+$APPNAM	= "entry.pl";
+$USAGE	= "$APPNAM -b base -h host -D bind -w pswd -P cert";
+
+
+#################################################################################
+# Check arguments, and configure some parameters accordingly..
+#
+if (!getopts('b:h:D:p:s:w:P:'))
+{
+   print "usage: $APPNAM $USAGE\n";
+   exit;
+}
+%ld = Mozilla::LDAP::Utils::ldapArgs($BIND, $BASE);
+
+
+#################################################################################
+# Get an LDAP connection
+#
+sub getConn
+{
+  my $conn;
+
+  if ($main::reuseConn)
+    {
+      if (!defined($main::mainConn))
+	{
+	  $main::mainConn = new Mozilla::LDAP::Conn(\%main::ld);
+	  die "Could't connect to LDAP server $main::ld{host}"
+	    unless $main::mainConn;
+	}
+      return $main::mainConn;
+    }
+  else
+    {
+      $conn = new Mozilla::LDAP::Conn(\%main::ld);
+      die "Could't connect to LDAP server $main::ld{host}" unless $conn;
+    }
+
+  return $conn;
+}
+
+
+#################################################################################
+# Some small help functions...
+#
+sub dotPrint
+{
+  my $str = shift;
+
+  print $str . '.' x (20 - length($str));
+}
+
+sub attributeEQ
+{
+  my @a, @b;
+  my $i;
+
+  @a = @{$_[0]};
+  @b = @{$_[1]};
+  return 1 if (($#a < 0) && ($#b < 0));
+  return 0 unless ($#a == $#b);
+
+  @a = sort(@a);
+  @b = sort(@b);
+  for ($i = 0; $i <= $#a; $i++)
+    {
+      return 0 unless ($a[$i] eq $b[$i]);;
+    }
+
+  return 1;             # We passed all the tests, we're ok.
+}
+
+
+#################################################################################
+# Setup the test entries.
+#
+$filter = "(uid=$UID)";
+$conn = getConn();
+$nentry = $conn->newEntry();
+
+$nentry->setDN("uid=$UID, $PEOPLE, $BASE");
+$nentry->{objectclass} = [ "top", "person", "inetOrgPerson", "mailRecipient" ];
+$nentry->addValue("uid", $UID);
+$nentry->addValue("sn", "Hedstrom");
+$nentry->addValue("givenName", "Leif");
+$nentry->addValue("cn", "Leif Hedstrom");
+$nentry->addValue("cn", "Leif P. Hedstrom");
+$nentry->addValue("cn", "The Swede");
+$nentry->addValue("description", "Test1");
+$nentry->addValue("description", "Test2");
+$nentry->addValue("description", "Test3");
+$nentry->addValue("description", "Test4");
+$nentry->addValue("description", "Test5");
+$nentry->addValue("mail", "leif\@ogre.com");
+
+$ent = $conn->search($ld{root}, $ld{scope}, $filter);
+$conn->delete($ent->getDN()) if $ent;
+$conn->add($nentry);
+
+$conn->close();

mozilla/directory/perldap/test.pl

@@ -0,0 +1,162 @@
+#############################################################################
+# $Id: test.pl,v 1.6 1998-08-13 09:14:44 leif Exp $
+#
+# The contents of this file are subject to the Mozilla Public License
+# Version 1.0 (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 PerLDAP. The Initial Developer of the Original
+# Code is Netscape Communications Corp. and Clayton Donley. Portions
+# created by Netscape are Copyright (C) Netscape Communications
+# Corp., portions created by Clayton Donley are Copyright (C) Clayton
+# Donley. All Rights Reserved.
+#
+# Contributor(s):
+#
+# DESCRIPTION
+#    Before `make install' is performed this script should be runnable with
+#    `make test'. After `make install' it should work as `perl test.pl'
+#
+#############################################################################
+
+######################### We start with some black magic to print on failure.
+
+# Change 1..1 below to 1..last_test_to_print .
+# (It may become useful if the test is moved to ./t subdirectory.)
+
+BEGIN { $| = 1; print "1..8\n"; }
+END {print "modinit  - not ok\n" unless $loaded;}
+use Mozilla::LDAP::API qw(:constant :api :ssl);
+$loaded = 1;
+print "modinit  - ok\n";
+
+######################### End of black magic.
+
+
+$attrs = [];
+
+$ldap_host = $ENV{"LDAPHOST"};
+$filter = $ENV{"TESTFILTER"};
+$BASEDN = $ENV{"LDAPBASE"};
+
+if (!$ldap_host)
+{
+   print "\nEnter LDAP Server: ";
+   chomp($ldap_host = <>);
+}
+
+if (!$filter)
+{
+   print "Enter Search Filter (ex. uid=abc123): ";
+   chomp($filter = <>);
+}
+
+if (!$BASEDN)
+{
+   print "Enter LDAP Search Base (ex. o=Org, c=US): ";
+   chomp($BASEDN = <>);
+}
+
+print "\n";
+
+
+##
+##  Initialize LDAP Connection
+##
+
+if (($ld = ldap_init($ldap_host,LDAP_PORT)) == -1)
+{
+   print "open     - not ok\n";
+   exit -1; 
+}
+print "open     - ok\n";
+
+##
+##  Bind as DN, PASSWORD (NULL,NULL) on LDAP connection $ld
+##
+
+if (ldap_simple_bind_s($ld,"","") != LDAP_SUCCESS)
+{
+   ldap_perror($ld,"bind_s");
+   print "bind     - not ok\n";
+   exit -1;
+}
+print "bind     - ok\n";
+
+##
+## ldap_search_s - Synchronous Search
+##
+
+if (ldap_search_s($ld,$BASEDN,LDAP_SCOPE_SUBTREE,$filter,$attrs,0,$result) != LDAP_SUCCESS)
+{
+   ldap_perror($ld,"search_s");
+   print  "search   - not ok\n";
+}
+print "search   - ok\n";
+
+##
+## ldap_count_entries - Count Matched Entries
+##
+
+if (($count = ldap_count_entries($ld,$result)) == -1)
+{
+   ldap_perror($ld,"count_entry");
+   print "count    - not ok\n";
+}
+print "count    - ok	- $count\n";
+
+##
+## first_entry - Get First Matched Entry
+## next_entry  - Get Next Matched Entry
+##
+
+   for ($ent = ldap_first_entry($ld,$result); $ent; $ent = ldap_next_entry($ld,$ent))
+   {
+      
+##
+## ldap_get_dn  -  Get DN for Matched Entries
+##
+
+      if (($dn = ldap_get_dn($ld,$ent)) ne "")
+      {
+         print "getdn    - ok	- $dn\n";
+      } else {
+         ldap_perror($ld,"get_dn");
+         print "getdn    - not ok\n";
+      }
+
+      for ($attr = ldap_first_attribute($ld,$ent,$ber); $attr; $attr = ldap_next_attribute($ld,$ent,$ber))
+      {
+         print "firstatt - ok	- $attr\n";
+
+##
+## ldap_get_values
+##
+
+         @vals = ldap_get_values($ld,$ent,$attr);
+         if ($#vals >= 0)
+         {
+            foreach $val (@vals)
+            {
+               print "getvals  - ok	- $val\n";
+            }
+         } else {
+            print "getvals  - not ok\n";
+         }
+      }
+
+
+   }
+
+##
+##  Unbind LDAP Connection
+##
+
+ldap_unbind($ld);
+

mozilla/directory/perldap/test_api/api.pl

@@ -0,0 +1,280 @@
+#!/usr/bin/perl -w
+#############################################################################
+# $Id: api.pl,v 1.6.2.1 1998-09-20 03:21:58 donley%tekka.wwa.com Exp $
+#
+# The contents of this file are subject to the Mozilla Public License
+# Version 1.0 (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 PerLDAP. The Initial Developer of the Original
+# Code is Netscape Communications Corp. and Clayton Donley. Portions
+# created by Netscape are Copyright (C) Netscape Communications
+# Corp., portions created by Clayton Donley are Copyright (C) Clayton
+# Donley. All Rights Reserved.
+#
+# Contributor(s):
+#
+# DESCRIPTION
+#   api.pl - Test all LDAPv2 API function
+#   Author:  Clayton Donley <donley@wwa.com>
+#
+#   Performs all API calls directly in order to test for possible issues
+#   on a particular platform.
+#
+#############################################################################
+
+use Mozilla::LDAP::API qw(:api :constant);
+use strict;
+
+my $BASE = "ou=Test,o=Test,c=US";
+my $DN = "cn=Directory Manager";
+my $PASS = "abcd1234";
+my $HOST = "";
+my $PORT = 389;
+
+if (!$HOST)
+{
+   print "Please edit the variables at the top of this file.\n";
+   exit -1;
+}
+
+print "\nPerLDAP API TestSuite\n";
+print "\nNote: Failures in earlier tests will cause later tests to fail.\n";
+print "\n";
+
+my $howmany = 10;
+
+# Initialize the Connection
+{
+my $ld = ldap_init($HOST,$PORT);
+if ($ld <0)
+{
+   print "init			- Failed!\n";
+   die;
+}
+print "init		- OK\n";
+
+# Set an LDAP Session Option
+if (ldap_set_option($ld,LDAP_OPT_PROTOCOL_VERSION,LDAP_VERSION3)
+      != LDAP_SUCCESS)
+{
+   print "set_option	- Failed!\n";
+} else {
+   print "set_option	- OK\n";
+}
+
+# Get an LDAP Session Option
+my $option;
+ldap_get_option($ld,LDAP_OPT_REFERRALS,$option);
+
+if ($option != 1)
+{
+   print "get_option	- Failed!\n";
+} else {
+   print "get_option	- OK\n";
+}
+
+# Anonymous Bind
+if (ldap_simple_bind_s($ld,"","") != LDAP_SUCCESS)
+{
+   print "anon_bind	- Failed!\n";
+} else {
+   print "anon_bind	- OK\n";
+}
+
+# Authenticated Simple Bind
+if (ldap_simple_bind_s($ld,$DN,$PASS) != LDAP_SUCCESS)
+{
+   print "simple_bind	- Failed!\n";
+} else {
+   print "simple_bind	- OK\n";
+}
+
+# Set Rebind Process
+my $rebindproc = sub { return($DN,$PASS,LDAP_AUTH_SIMPLE); };
+ldap_set_rebind_proc($ld,$rebindproc);
+print "set_rebind	- OK\n";
+
+# Add an OrgUnit Entry
+my $entry = {
+	"objectclass" => ["top","organizationalUnit"],
+	"ou" => "Test",
+};
+
+if (ldap_add_s($ld,$BASE,$entry) != LDAP_SUCCESS)
+{
+   print "add_org		- Failed!\n";
+} else {
+   print "add_org		- OK\n";
+}
+
+
+# Add People
+foreach my $number (1..$howmany)
+{
+   $entry = {
+	"objectclass" => ["top","person"],
+	"cn" => "Mozilla $number",
+	"sn" => ["$number"],
+   };
+   if (ldap_add_s($ld,"cn=Mozilla $number,$BASE",$entry)
+	 != LDAP_SUCCESS)
+   {
+      print "add_user_$number	- Failed!\n";
+   } else {
+      print "add_user_$number	- OK\n";
+   }
+}
+
+# Modify People
+foreach my $number (1..$howmany)
+{
+   $entry = {
+	"sn" => {"ab",["Test"]},
+        "telephoneNumber" => {"ab",[123.456]},
+#	"telephoneNumber" => "800-555-111$number",
+   };
+   if (ldap_modify_s($ld,"cn=Mozilla $number,$BASE",$entry)
+	  != LDAP_SUCCESS)
+   {
+      print "mod_user_$number	- Failed!\n";
+   } else {
+      print "mod_user_$number	- OK\n";
+   }
+}
+
+
+# Search People
+my $filter = "(sn=Test)";
+my $attrs = ["cn","sn"];
+my $res;
+if (ldap_search_s($ld,$BASE,LDAP_SCOPE_SUBTREE,$filter,$attrs,0,$res)
+     != LDAP_SUCCESS)
+{
+   print "search_user	- Failed!\n";
+} else {
+   print "search_user	- OK\n";
+}
+
+# Count Results
+if (ldap_count_entries($ld,$res) != $howmany)
+{
+   print "count_res	- Failed!\n";
+} else {
+   print "count_res	- OK\n";
+}
+
+# Sort Results
+if (ldap_sort_entries($ld,$res,"sn") != LDAP_SUCCESS)
+{
+   print "sort_ent	- Failed!\n";
+} else {
+   print "sort_ent	- OK\n";
+}
+
+# Multisort Results
+if (ldap_multisort_entries($ld,$res,["sn","telephoneNumber"]) != LDAP_SUCCESS)
+{
+   print "multisort	- Failed!\n";
+} else {
+   print "multisort	- OK\n";
+}
+
+# Get First Entry
+my $ent = ldap_first_entry($ld,$res);
+if (!$ent)
+{
+   print "first_entry	- Failed!\n";
+} else {
+   print "first_entry	- OK\n";
+}
+
+# Get Next Entry
+$ent = ldap_next_entry($ld,$ent);
+if (!$ent)
+{
+   print "next_entry	- Failed!\n";
+} else {
+   print "next_entry	- OK\n";
+}
+
+# Get DN
+my $dn = ldap_get_dn($ld,$ent);
+if (!$dn)
+{
+   print "get_dn		- Failed!\n";
+} else {
+   print "get_dn		- OK\n";
+}
+
+# Get First Attribute
+my $ber;
+my $attr = ldap_first_attribute($ld,$ent,$ber);
+if (!$attr)
+{
+   print "first_attr	- Failed!\n";
+} else {
+   print "first_attr	- OK\n";
+}
+
+# Get Next Attribute
+$attr = ldap_next_attribute($ld,$ent,$ber);
+if (!$attr)
+{
+   print "next_attr	- Failed!\n";
+} else {
+   print "next_attr	- OK\n";
+}
+
+# Get Attribute Values
+my @vals = ldap_get_values($ld,$ent,$attr);
+if ($#vals < 0)
+{
+   print "get_values	- Failed!\n";
+} else {
+   print "get_values	- OK\n";
+}
+
+# Free structures pointed to by $ber and $res to prevent memory leak
+ldap_ber_free($ber,1);
+ldap_msgfree($res);
+
+# Compare Attribute Values
+foreach my $number (1..$howmany)
+{
+   if(ldap_compare_s($ld,"cn=Mozilla $number,$BASE","sn",$number)
+	 != LDAP_COMPARE_TRUE)
+   {
+      print "comp_user_$number	- Failed!\n";
+   } else {
+      print "comp_user_$number	- OK\n";
+   }
+}
+
+# Delete Users
+foreach my $number (1..$howmany)
+{
+   if (ldap_delete_s($ld,"cn=Mozilla $number,$BASE") != LDAP_SUCCESS)
+   {
+      print "del_user_$number	- Failed!\n";
+   } else {
+      print "del_user_$number	- OK\n";
+   }
+}
+
+if (ldap_delete_s($ld,"$BASE") != LDAP_SUCCESS)
+{
+   print "del_org		- Failed!\n";
+} else {
+   print "del_org		- OK\n";
+}
+
+# Unbind
+ldap_unbind($ld);
+}

mozilla/directory/perldap/test_api/search.pl

@@ -0,0 +1,131 @@
+#!/usr/bin/perl
+#############################################################################
+# $Id: search.pl,v 1.4 1998-08-13 04:40:01 clayton Exp $
+#
+# The contents of this file are subject to the Mozilla Public License
+# Version 1.0 (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 PerlDAP. The Initial Developer of the Original
+# Code is Netscape Communications Corp. and Clayton Donley. Portions
+# created by Netscape are Copyright (C) Netscape Communications
+# Corp., portions created by Clayton Donley are Copyright (C) Clayton
+# Donley. All Rights Reserved.
+#
+# Contributor(s):
+#
+# DESCRIPTION
+#    Test the search capabilities of the API, similar to write.pl.
+#
+#############################################################################
+
+use Mozilla::LDAP::API qw(:api :constant);
+use strict;
+
+
+my $ldap_host = "";
+my $BASEDN = "o=Org,c=US";
+my $filter = $ARGV[0];
+
+if (!$ldap_host)
+{
+   print "Edit the top portion of this file before continuing.\n";
+   exit -1;
+}
+
+my $attrs = [];
+
+my ($ld,$result,$count);
+
+##
+##  Initialize LDAP Connection
+##
+
+if (($ld = ldap_init($ldap_host,LDAP_PORT)) == -1)
+{
+   die "Can not open LDAP connection to $ldap_host";
+}
+
+##
+##  Bind as DN, PASSWORD (NULL,NULL) on LDAP connection $ld
+##
+
+if (ldap_simple_bind_s($ld,"","") != LDAP_SUCCESS)
+{
+   ldap_perror($ld,"bind_s");
+   die;
+}
+
+##
+## ldap_search_s - Synchronous Search
+##
+
+if (ldap_search_s($ld,$BASEDN,LDAP_SCOPE_SUBTREE,$filter,$attrs,0,$result) != LDAP_SUCCESS)
+{
+   ldap_perror($ld,"search_s");
+   die;
+}
+
+##
+## ldap_count_entries - Count Matched Entries
+##
+
+if (($count = ldap_count_entries($ld,$result)) == -1)
+{
+   ldap_perror($ld,"count_entry");
+   die;
+}
+
+##
+## first_entry - Get First Matched Entry
+## next_entry  - Get Next Matched Entry
+##
+
+for (my $ent = ldap_first_entry($ld,$result); $ent; $ent = ldap_next_entry($ld,$ent))
+{
+      
+##
+## ldap_get_dn  -  Get DN for Matched Entries
+##
+
+   my ($dn,$attr,@vals,$val,$ber);
+   if (($dn = ldap_get_dn($ld,$ent)) ne "")
+   {
+      print "dn: $dn\n";
+   } else {
+      ldap_perror($ld,"get_dn");
+      die;
+   }
+
+   for ($attr = ldap_first_attribute($ld,$ent,$ber); $attr; $attr = ldap_next_attribute($ld,$ent,$ber))
+   {
+
+##
+## ldap_get_values
+##
+
+      @vals = ldap_get_values($ld,$ent,$attr);
+      if ($#vals >= 0)
+      {
+         foreach $val (@vals)
+         {
+            print "$attr: $val\n";
+         }
+      }
+   }
+   ldap_ber_free($ber,0);
+}
+ldap_msgfree($result);
+
+##
+##  Unbind LDAP Connection
+##
+
+ldap_unbind($ld);
+

mozilla/directory/perldap/test_api/write.pl

@@ -0,0 +1,110 @@
+#!/usr/bin/perl -w
+#############################################################################
+# $Id: write.pl,v 1.4 1998-08-13 04:40:02 clayton Exp $
+#
+# The contents of this file are subject to the Mozilla Public License
+# Version 1.0 (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 PerlDAP. The Initial Developer of the Original
+# Code is Netscape Communications Corp. and Clayton Donley. Portions
+# created by Netscape are Copyright (C) Netscape Communications
+# Corp., portions created by Clayton Donley are Copyright (C) Clayton
+# Donley. All Rights Reserved.
+#
+# Contributor(s):
+#
+# DESCRIPTION
+#   write.pl - Test of LDAP Modify Operations in Perl5
+#   Author:  Clayton Donley <donley@wwa.com>
+#
+#   This utility is mostly to demonstrate all the write operations
+#   that can be done with LDAP through this PERL5 module.
+#
+#############################################################################
+
+use strict;
+use Mozilla::LDAP::API qw(:constant :api);
+
+
+# This is the entry we will be adding.  Do not use a pre-existing entry.
+my $ENTRYDN = "cn=Test Guy, o=Org, c=US";
+
+# This is the DN and password for an Administrator
+my $ROOTDN = "cn=DSManager,o=Org,c=US";
+my $ROOTPW = "";
+
+my $ldap_server = "";
+
+if (!$ldap_server)
+{
+   print "Edit the top portion of this file before continuing.\n";
+   exit -1;
+}
+
+my $ld = ldap_init($ldap_server,LDAP_PORT);
+
+if ($ld == -1)
+{
+   die "Connection to LDAP Server Failed";
+}
+
+if (ldap_simple_bind_s($ld,$ROOTDN,$ROOTPW) != LDAP_SUCCESS)
+{
+   ldap_perror($ld,"bind_s");
+   die;
+}
+
+my %testwrite = (
+	"cn" => "Test User",
+	"sn" => "User",
+        "givenName" => "Test",
+	"telephoneNumber" => "8475551212",
+	"objectClass" => ["top","person","organizationalPerson",
+           "inetOrgPerson"],
+        "mail" => "tuser\@my.org",
+);
+
+if (ldap_add_s($ld,$ENTRYDN,\%testwrite) != LDAP_SUCCESS)
+{
+   ldap_perror($ld,"add_s");
+   die;
+}
+
+print "Entry Added.\n";
+
+
+%testwrite = (
+	"telephoneNumber" => "7085551212",
+        "mail" => {"a",["Test_User\@my.org"]},
+);
+
+if (ldap_modify_s($ld,$ENTRYDN,\%testwrite) != LDAP_SUCCESS)
+{
+   ldap_perror($ld,"modify_s");
+   die;
+}
+
+print "Entry Modified.\n";
+
+#
+# Delete the entry for $ENTRYDN
+#
+if (ldap_delete_s($ld,$ENTRYDN) != LDAP_SUCCESS)
+{
+   ldap_perror($ld,"delete_s");
+   die;
+}
+
+print "Entry Deleted.\n";
+
+# Unbind to LDAP server
+ldap_unbind($ld);
+
+exit;

mozilla/directory/perldap/typemap

@@ -0,0 +1,70 @@
+#############################################################################
+# $Id: typemap,v 1.4 1998-08-13 09:15:00 leif Exp $
+#
+# The contents of this file are subject to the Mozilla Public License
+# Version 1.0 (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 PerLDAP. The Initial Developer of the Original
+# Code is Netscape Communications Corp. and Clayton Donley. Portions
+# created by Netscape are Copyright (C) Netscape Communications
+# Corp., portions created by Clayton Donley are Copyright (C) Clayton
+# Donley. All Rights Reserved.
+#
+# Contributor(s):
+#
+# DESCRIPTION
+#    Typemap to declare XSUB data types.
+#
+#############################################################################
+
+const int		T_IV
+char *			T_PV
+const char *		T_PV
+char **			T_charptrptr
+LDAP *			T_PTR
+LDAPMessage *		T_PTR
+LDAPMessage **		T_PTR
+BerElement *		T_PTR
+LDAPControl *		T_PTR
+LDAPVersion *		T_PTR
+struct berval 		T_berval
+struct berval **	T_bervalptrptr
+FriendlyMap *		T_PTR
+LDAPsortkey **		T_PTR
+LDAPVirtualList *	T_PTR
+LDAPURLDesc *		T_PTR
+LDAPControl **		T_PTR
+LDAPFiltDesc *		T_PTR
+LDAPFiltInfo *		T_PTR
+LDAPMemCache *		T_PTR
+LDAPMemCache **		T_PTR
+struct ldap_thread_fns *	T_PTR
+LDAPMod **		T_PTR
+LDAP_CMP_CALLBACK *	T_PTR
+LDAP_REBINDPROC_CALLBACK *	T_PTR
+struct timeval		T_timeval
+
+#########
+INPUT
+T_timeval
+	$var.tv_sec = atof((char *)SvPV($arg,na));
+	$var.tv_usec = 0
+T_berval
+	$var.bv_val = (char *)SvPV($arg,na);
+	$var.bv_len = na
+T_charptrptr
+        $var = (char **)avref2charptrptr($arg)
+T_bervalptrptr
+	$var = (struct berval **)avref2berptrptr($arg)
+OUTPUT
+T_charptrptr
+	$arg = charptrptr2avref($var);
+T_bervalptrptr
+	$arg = berptrptr2avref((struct berval **)$var);

mozilla/netwerk/cache/Makefile.in

@@ -1,38 +0,0 @@
-#
-# 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

@@ -1,33 +0,0 @@
-#!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

@@ -1,54 +0,0 @@
-#
-# 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		= nkcache
-LIBRARY_NAME	= nkcache
-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

@@ -1,51 +0,0 @@
-#!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

@@ -1,49 +0,0 @@
- /* -*- 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

@@ -1,56 +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 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
-
-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

@@ -1,44 +0,0 @@
-#!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

@@ -1,351 +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 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>
- */
-
-// FUR - Add overall description comment here
-
-#include "nsDBAccessor.h"
-#include "nscore.h"
-
-#include "prtypes.h"
-#include "plhash.h"
-#include "nsCRT.h"
-#include "nsAutoLock.h"
-
-nsDBAccessor::nsDBAccessor() :
-  mDB(0) ,
-  mSessionID(0) ,
-  mSessionCntr(0)
-{
-
-  NS_INIT_REFCNT();
-}
-
-nsDBAccessor::~nsDBAccessor()
-{
-  printf(" ~nsDBAccessor\n") ;
-  Shutdown() ;
-}
-
-//
-// Implement nsISupports methods
-//
-NS_IMPL_ISUPPORTS(nsDBAccessor, NS_GET_IID(nsIDBAccessor))
-
-
-///////////////////////////////////////////////////////////
-// nsIDBAccessor methods 
-
-NS_IMETHODIMP
-nsDBAccessor::Init(nsIFileSpec* dbfile)
-{
-  // FUR - lock not needed
-  m_Lock = PR_NewLock() ;
-  if(!m_Lock)
-    return NS_ERROR_OUT_OF_MEMORY ;
-
-  char* dbname ;
-
-  // this should cover all platforms. 
-  dbfile->GetNativePath(&dbname) ;
-
-  // 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 */
-
-  // FUR - lock not needed
-  nsAutoLock lock(m_Lock) ;
-
-  mDB = dbopen(dbname,
-               O_RDWR | O_CREAT ,
-               0600 ,
-               DB_HASH ,
-               & hash_info) ;
-
-  // FUR - does dbname have to be free'ed ?
-
-  if(!mDB)
-    return NS_ERROR_FAILURE ;
-
-  // set mSessionID
-  // FUR - Why the +1 ?  (No need for key to be NUL-terminated string.)
-  PRUint32 len = PL_strlen(SessionKey)+1 ;
-  DBT db_key, db_data ;
-
-  db_key.data = NS_CONST_CAST(char*, SessionKey) ;
-  db_key.size = len ;
-
-  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 ;
-    }
-
-    // FUR - need to comment out all printfs, or turn them into PR_LOG statements
-    printf("found previous session, id = %d\n", *old_ID) ;
-    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) ;
-    return NS_OK ;
-  } 
-  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 ;
-  }
-
-  // FUR - locks not necessary
-  if(m_Lock) 
-    PR_DestroyLock(m_Lock);
-  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") ;
-
-  // Lock the db
-  nsAutoLock lock(m_Lock) ;
-  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") ;
-
-  // Lock the db
-  nsAutoLock lock(m_Lock) ;
-  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)) {
-    // FUR - I would avoid unnecessary sync'ing for performance's
-    // sake.  Maybe you could limit sync to max rate of, say, once
-    // every few seconds by keeping track of last sync time, using PR_Now().
-    (*mDB->sync)(mDB, 0) ;
-    return NS_OK ;
-  }
-  else {
-    // FUR - Try to avoid using NS_ERROR unless error is unrecoverable and serious
-    NS_ERROR("ERROR: Failed to put anEntry into db.\n") ;
-    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") ;
-
-  // FUR - no locks necessary
-  // Lock the db
-  nsAutoLock lock(m_Lock) ;
-  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) {
-    // FUR - no printf's, use PR_LOG, NS_WARNING, or NS_ASSERTION, as the situation warrants
-    printf(" delete error\n") ;
-    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) {
-    // FUR - no printf's
-    printf(" delete error\n") ;
-    return NS_ERROR_FAILURE ;
-  } 
-
-  // FUR - Defer sync ?  See above
-  (*mDB->sync)(mDB, 0) ;
-
-  return NS_OK ;
-}
-
-NS_IMETHODIMP
-nsDBAccessor::GetID(const char* key, PRUint32 length, PRInt32* aID) 
-{
-  NS_ASSERTION(mDB, "no database") ;
-
-  // Lock the db
-  nsAutoLock lock(m_Lock) ;
-
-  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 ;
-    }
-    // FUR - defer sync ?
-    (*mDB->sync)(mDB, 0) ;
-    *aID = id ;
-    return NS_OK ;
-  } 
-  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 ;
-
-  // Lock the db
-  nsAutoLock lock(m_Lock) ;
-  DBT db_key, db_data ;
-
-  // FUR - +1 unnecessary ?
-  PRUint32 len = PL_strlen(SessionKey)+1 ;
-
-  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 ;
-}

mozilla/netwerk/cache/filecache/nsDBAccessor.h

@@ -1,68 +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 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>
- */
-
-// FUR - Add overall description comment here
-
-#ifndef _NSIDBACCESSOR_H_
-#define _NSIDBACCESSOR_H_
-
-#include "nsIDBAccessor.h"
-#include "mcom_db.h"
-
-// bogus string for the key of session id 
-// FUR - suggest "SK" instead of "^^"
-static const char * const SessionKey = "^^" ;
-
-// initial session id number 
-static const PRInt16 ini_sessionID = 0xff ;
-
-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) ;
-
-  protected:
-
-  private:
-  DB *                          mDB ;
-  PRInt16                       mSessionID ;
-  PRInt16                       mSessionCntr ;
-  PRLock *                      m_Lock ;
-} ;
-
-#endif // _NSIDBACCESSOR_H_

mozilla/netwerk/cache/filecache/nsDBEnumerator.cpp

@@ -1,97 +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 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>
- */
-
-// FUR - Add overall description comment here
-
-#include "nsDBEnumerator.h"
-#include "nsDiskCacheRecord.h"
-
-nsDBEnumerator::nsDBEnumerator(nsIDBAccessor* aDB, nsNetDiskCache* aCache) :
-  m_DB(aDB) ,
-  m_DiskCache(aCache) ,
-  tempEntry(0) ,
-  tempEntry_length(0) ,
-  m_CacheEntry(0) ,
-  bReset(PR_TRUE) 
-{
-  NS_INIT_REFCNT();
-
-}
-
-nsDBEnumerator::~nsDBEnumerator()
-{
-//  printf(" ~nsDBEnumerator()\n") ;
-  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 ;
-
-  m_DB->EnumEntry(&tempEntry, &tempEntry_length, bReset) ;
-  bReset = PR_FALSE ;
-
-  if(tempEntry && 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(tempEntry, 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

@@ -1,61 +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 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>
- */
-
-// FUR - Add overall description comment here
-
-#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
-
-    // FUR can use NS_DECL_NSISIMPLEENUMERATOR here
-    /* boolean HasMoreElements (); */
-    NS_IMETHOD HasMoreElements(PRBool *_retval) ;
-
-    /* nsISupports GetNext (); */
-    NS_IMETHOD GetNext(nsISupports **_retval) ;
-
-    nsDBEnumerator(nsIDBAccessor* aDB, nsNetDiskCache* aCache) ;
-    virtual ~nsDBEnumerator() ;
-
-    // FUR all members should be prefixed by 'm', e.g. mbReset
-private:
-    nsCOMPtr<nsIDBAccessor>                m_DB ;
-    nsCOMPtr<nsNetDiskCache>                        m_DiskCache ;
-    void *                                 tempEntry ;
-    PRUint32                               tempEntry_length ;
-    nsDiskCacheRecord*                    m_CacheEntry ;
-    PRBool                                 bReset ;
-};
-
-#endif // _NS_DBENUMERATOR_H_

mozilla/netwerk/cache/filecache/nsDiskCacheRecord.cpp

@@ -1,451 +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 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();
-}
-
-// mem alloced. so caller should do free() on key. 
-NS_IMETHODIMP
-nsDiskCacheRecord::Init(const char* key, PRUint32 length) 
-{
-  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
-  // FUR!! Another disk access ?  If called from GetCachedData, ID is already known
-  mDB->GetID(key, length, &mRecordID) ;
-  // FUR - check for GetID failure
-
-  // 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] ;
-  
-  // FUR!! - should the format string be "%.02x".  How does this work !?
-  PR_snprintf(dirName, 3, "%.2x", (((PRUint32)mRecordID) % 32)) ;
-  mFile->AppendRelativeUnixPath(dirName) ;
-
-  // FUR!! - should the format string be "%.08x".  How does this work !?
-  PR_snprintf(filename, 9, "%.8x", mRecordID) ;
-  mFile->AppendRelativeUnixPath(filename) ;
-
-  return NS_OK ;
-}
-
-nsDiskCacheRecord::~nsDiskCacheRecord()
-{
-//  printf(" ~nsDiskCacheRecord()\n") ;
-  if(mKey)
-    nsAllocator::Free(mKey) ;
-  if(mMetaData)
-    nsAllocator::Free(mMetaData) ;
-
-}
-
-//
-// 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) ;
-
-  // FUR - mInfo leaking ?
-  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 
-    return mFile->Truncate(aStoredContentLength) ;
-}
-
-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

@@ -1,70 +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 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) ;
-
-  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 ;
-  nsCOMPtr<nsNetDiskCache>           mDiskCache ;
-
-  friend class nsDiskCacheRecordChannel ;
-  friend class nsDBEnumerator ;
-  friend class nsNetDiskCache ;
-} ;
-
-#endif // _NET_CACHEDDISKDATA_H_

mozilla/netwerk/cache/filecache/nsDiskCacheRecordChannel.cpp

@@ -1,392 +0,0 @@
-/* -*- 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 "nsDiskCacheRecordChannel.h"
-//#include "nsFileTransport.h"
-#include "nsIIOService.h"
-#include "nsIServiceManager.h"
-
-#include "nsIOutputStream.h"
-
-static NS_DEFINE_CID(kIOServiceCID, NS_IOSERVICE_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() ;
-  mRecord->mNumChannels++ ;
-}
-
-nsDiskCacheRecordChannel::~nsDiskCacheRecordChannel()
-{
-  mRecord->mNumChannels-- ;
-}
-
-// FUR!!
-//
-//  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) 
-{
-  char* urlStr ;
-  mRecord->mFile->GetURLString(&urlStr) ;
-
-  nsresult rv ;
-  NS_WITH_SERVICE(nsIIOService, serv, kIOServiceCID, &rv);
-  if (NS_FAILED(rv)) return rv;
-
-  rv = serv->NewChannel("load",    // XXX what should this be?
-                        urlStr,
-                        nsnull,    // no base uri
-                        mLoadGroup,
-                        nsnull,    // no eventsink getter
-                        0,
-                        nsnull,    // no original URI
-                        0,
-                        0,
-                        getter_AddRefs(mFileTransport));
-  return rv ;
-}
-
-nsresult 
-nsDiskCacheRecordChannel::NotifyStorageInUse(PRInt32 aBytesUsed)
-{
-  return mRecord->mDiskCache->m_StorageInUse += aBytesUsed ;
-}
-
-// implement nsISupports
-NS_IMPL_ISUPPORTS(nsDiskCacheRecordChannel, NS_GET_IID(nsIChannel))
-
-// 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::GetURI(nsIURI * *aURI)
-{
-  if(!mFileTransport)
-    return NS_ERROR_FAILURE ;
-
-  return mFileTransport->GetURI(aURI) ;
-}
-
-NS_IMETHODIMP
-nsDiskCacheRecordChannel::OpenInputStream(PRUint32 aStartPosition, 
-                                          PRInt32 aReadCount,
-                                          nsIInputStream* *aResult)
-{
-  if(!mFileTransport)
-    return NS_ERROR_FAILURE ;
-
-  return mFileTransport->OpenInputStream(aStartPosition,
-                                         aReadCount,
-                                         aResult) ;
-}
-
-NS_IMETHODIMP
-nsDiskCacheRecordChannel::OpenOutputStream(PRUint32 startPosition, 
-                                           nsIOutputStream* *aResult)
-{
-  nsresult rv ;
-  NS_ENSURE_ARG(aResult) ;
-
-  nsCOMPtr<nsIOutputStream> outputStream ;
-
-  PRUint32 oldLength ;
-  mRecord->GetStoredContentLength(&oldLength) ;
-
-  if(startPosition < oldLength) {
-    NotifyStorageInUse(startPosition - oldLength) ;
-
-    // we should truncate the file at here. 
-    rv = mRecord->SetStoredContentLength(startPosition) ;
-    if(NS_FAILED(rv)) {
-      printf(" failed to truncate\n") ;
-      return rv ;
-    }
-  }
-
-  rv = mFileTransport->OpenOutputStream(startPosition, getter_AddRefs(outputStream)) ;
-  if(NS_FAILED(rv)) return rv ;
-
-  return WriteStreamWrapper::Create(this, outputStream, aResult) ;
-}
-
-NS_IMETHODIMP
-nsDiskCacheRecordChannel::AsyncOpen(nsIStreamObserver *observer, 
-                                    nsISupports *ctxt)
-{
-  if(!mFileTransport)
-    return NS_ERROR_FAILURE ;
-
-  return mFileTransport->AsyncOpen(observer, ctxt) ;
-}
-
-NS_IMETHODIMP
-nsDiskCacheRecordChannel::AsyncRead(PRUint32 aStartPosition, 
-                                    PRInt32 aReadCount,
-                                    nsISupports *aContext, 
-                                    nsIStreamListener *aListener)
-{
-  if(!mFileTransport)
-    return NS_ERROR_FAILURE ;
-
-  return mFileTransport->AsyncRead(aStartPosition , 
-                                   aReadCount , 
-                                   aContext , 
-                                   aListener) ;
-}
-
-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)
-{
-  if(!mFileTransport)
-    return NS_ERROR_FAILURE ;
-
-  return mFileTransport->GetLoadAttributes(aLoadAttributes) ;
-}
-
-NS_IMETHODIMP
-nsDiskCacheRecordChannel::SetLoadAttributes(nsLoadFlags aLoadAttributes)
-{
-  if(!mFileTransport)
-    return NS_ERROR_FAILURE ;
-
-  return mFileTransport->SetLoadAttributes(aLoadAttributes) ;
-}
-
-NS_IMETHODIMP
-nsDiskCacheRecordChannel::GetContentType(char * *aContentType)
-{
-  if(!mFileTransport)
-    return NS_ERROR_FAILURE ;
-
-  return mFileTransport->GetContentType(aContentType) ;
-}
-
-NS_IMETHODIMP
-nsDiskCacheRecordChannel::GetContentLength(PRInt32 *aContentLength)
-{
-  if(!mFileTransport)
-    return NS_ERROR_FAILURE ;
-
-  return mFileTransport->GetContentLength(aContentLength) ;
-}
-
-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::GetOriginalURI(nsIURI* *aURI)
-{
-  // FUR - might need to implement this - not sure
-  return NS_ERROR_NOT_IMPLEMENTED ;
-}
-
-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;
-}

mozilla/netwerk/cache/filecache/nsDiskCacheRecordChannel.h

@@ -1,65 +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 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"
-
-/*
- * This class is plagiarized from nsMemCacheChannel
- */
-
-class nsDiskCacheRecordChannel : public nsIChannel
-{
-  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
-
-  nsresult Init(void) ;
-
-  private:
-
-  nsresult NotifyStorageInUse(PRInt32 aBytesUsed) ;
-
-  nsCOMPtr<nsDiskCacheRecord>           mRecord ;
-  nsCOMPtr<nsILoadGroup>                mLoadGroup ;
-  nsCOMPtr<nsISupports>                 mOwner ;
-  nsCOMPtr<nsIChannel>                  mFileTransport ;
-
-  friend class WriteStreamWrapper ;
-} ;
-
-#endif // _ns_DiskCacheRecordChannel_h_
-

mozilla/netwerk/cache/filecache/nsIDBAccessor.h

@@ -1,60 +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 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 ;
-
-} ;
-
-#endif // _NS_IDBACCESSOR_H_
-

mozilla/netwerk/cache/filecache/nsNetDiskCache.cpp

@@ -1,691 +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 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 "nsIComponentManager.h"
-#include "nsIServiceManager.h"
-
-#include "nsIPref.h"
-#include "mcom_db.h"
-#include "nsDBEnumerator.h"
-
-#include "nsDiskCacheRecord.h"
-
-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_BaseDirNum(32) 
-{
-  // set it to INF for now 
-  m_MaxEntries = (PRUint32)-1 ;
-
-  NS_INIT_REFCNT();
-
-}
-
-nsNetDiskCache::~nsNetDiskCache()
-{
-  printf("~nsNetDiskCache\n") ;
-
-  NS_IF_RELEASE(m_DB) ;
-
-  // FUR!!
-  // You shouldn't rely on the value of m_BaseDirNum to diagnose whether or not
-  // a cache corruption has occurred since it's possible that the app does not
-  // shut down cleanly and a corrupted cache has still not been cleaned up from
-  // a previous session.  My suggestion is that you pick a different scheme for
-  // renaming the dirs, e.g. rename them as "trash*" and remove all directories
-  // with this name pattern on shutdown.
-
-  // 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_BaseDirNum > 32)
-    RemoveDirs(32) ;
-}
-
-NS_IMETHODIMP
-nsNetDiskCache::Init(void) 
-{
-  nsresult rv ;
-
-  // FUR!!
-  // I really don't think prefs belong here, since that breaks modularity.  It
-  // presupposes that the file cache code is embedded in the browser or some
-  // other application that uses the prefs, i.e. the code might be used in a
-  // standalone cache manipulation tool or, someday, in server code.  Pref
-  // reading belongs at a higher level, either in the application itself or
-  // possibly the I/O manager.
-
-
-  // Also, Init() needs to be lazy, since folder name is not set on startup,
-  // i.e. need a call to MaybeInit() at the beginning of every public method
-
-  NS_WITH_SERVICE(nsIPref, pref, kPrefCID, &rv) ;
-  if (NS_FAILED(rv)) 
-    NS_ERROR("Failed to get globle preference!\n") ;
-
-  rv = NS_NewFileSpec(getter_AddRefs(m_pDiskCacheFolder));
-  if (!m_pDiskCacheFolder) {
-    NS_ERROR("ERROR: Could not make a file spec.\n") ;
-    return NS_ERROR_OUT_OF_MEMORY ;
-  }
-
-  char* tempPref = 0 ;
-  if(pref) {
-    PRInt32 nTemp = 0 ;
-
-    /*
-    rv = pref->CopyCharPref(CACHE_DIR_PREF, &tempPref) ;
-    if (NS_SUCCEEDED(rv)) {
-      printf("cache dir is %s\n", tempPref) ;
-      m_pDiskCacheFolder->SetUnixStyleFilePath(tempPref) ;
-	  PR_Free(tempPref) ;
-    } else */
-    {
-      m_pDiskCacheFolder->SetUnixStyleFilePath("/tmp") ;
-      printf("using default folder, /tmp\n") ;
-    }
-  }
-  else {
-    // temp hack for now. change later for other platform
-    m_pDiskCacheFolder->SetUnixStyleFilePath("/tmp") ;
-  }
-
-  // FUR - suggest you use nsCOMPtr for m_DB - it will eliminate
-  //       manual addref/release and reduce likelihood of bugs
-  NS_IF_RELEASE(m_DB) ;
-  m_DB = new nsDBAccessor() ;
-  if(!m_DB)
-    return NS_ERROR_OUT_OF_MEMORY ;
-  else
-    NS_ADDREF(m_DB) ;
-
-  rv = InitDB() ;
-
-  // try once for recovery
-  if(rv == NS_ERROR_FAILURE) {
-    rv = DBRecovery() ;
-    return rv ;
-  }
-
-  rv = UpdateInfo() ;
-  return rv ;
-}
-
-NS_IMETHODIMP
-nsNetDiskCache::InitDB(void)
-{
-  // create cache sub directories
-  nsresult rv ; 
-  nsCOMPtr<nsIFileSpec> cacheSubDir;
-  rv = NS_NewFileSpec(getter_AddRefs(cacheSubDir));
-
-  // FUR - any way to avoid doing this, if it's already been done ?
-  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);
-  }
-
-  NS_NewFileSpec(getter_AddRefs(m_DBFile)) ;
-  // FUR - check for NS_NewFileSpec failure
-  rv = m_DBFile->FromFileSpec(m_pDiskCacheFolder) ;
-  if(NS_FAILED(rv))
-    return rv ;
-
-  m_DBFile->AppendRelativeUnixPath("cache.db") ;
-
-  rv = m_DB->Init(m_DBFile) ;
-  return rv ;
-}
-
-//////////////////////////////////////////////////////////////////////////
-// nsISupports methods
-
-// FUR - Suggest you use NS_IMPL_ISUPPORTS3() macro instead
-NS_IMETHODIMP
-nsNetDiskCache::QueryInterface(const nsIID& aIID, void** aInstancePtr)
-{
-  NS_ASSERTION(aInstancePtr, "no instance pointer");
-  if(aIID.Equals(NS_GET_IID(nsINetDataDiskCache)) ||
-     aIID.Equals(NS_GET_IID(nsINetDataCache)) ||
-     aIID.Equals(NS_GET_IID(nsISupports))) {
-    *aInstancePtr = NS_STATIC_CAST(nsINetDataDiskCache*, this);
-    NS_ADDREF_THIS();
-    return NS_OK;
-  }
-  else
-    return NS_NOINTERFACE ;
-}
-
-NS_IMPL_ADDREF(nsNetDiskCache) ;
-NS_IMPL_RELEASE(nsNetDiskCache) ;
-
-///////////////////////////////////////////////////////////////////////////
-// 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 ;
-  m_DB->GetID(key, length, &id) ;
-  // FUR - Check for GetID failure ?
-
-  void* info = 0 ;
-  PRUint32 info_size = 0 ;
-
-  nsresult rv = m_DB->Get(id, &info, &info_size) ;
-  if(NS_SUCCEEDED(rv) && info) 
-    *_retval = PR_TRUE ;
-        
-  return NS_OK ;
-}
-
-/* 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 ;
-  m_DB->GetID(key, length, &id) ;
-  // FUR - Check for GetID failure ?
-
-  // construct an empty record
-  nsDiskCacheRecord* newRecord = new nsDiskCacheRecord(m_DB, this) ;
-  if(!newRecord) 
-    return NS_ERROR_OUT_OF_MEMORY ;
-
-  rv = newRecord->Init(key, length) ;
-  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) {
-
-    nsresult r1 ;
-    r1 = newRecord->RetrieveInfo(info, info_size) ;
-
-    // FUR!! need to release and return error if RetrieveInfo() fails
-    if(NS_SUCCEEDED(rv)) 
-      return NS_OK ;
-    else 
-      return r1;
-    
-  } else if (NS_SUCCEEDED(rv) && !info) {
-    // this is a new record. 
-    m_NumEntries ++ ;
-    return NS_OK ;
-  } else 
-    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") ;
-    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) 
-{
-  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)
-{
-  PRUint32 total_size = m_StorageInUse, len = 0 ;
-
-  // FUR!!
-  // GetStorageInUse() can be called hundreds of times per second, i.e. every
-  // time a buffer of data is written to the cache, so we can't afford to stat
-  // the db file on every call.  I would suggest caching the size of the db and
-  // invalidating that cached value every time a record is written to the db,
-  // or even every ten written records.
-
-  // add the size of the db.
-  //  m_DBFile->GetFileSize(&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)
-{
-  nsresult rv = RemoveDirs(0) ;
-  if(NS_FAILED(rv))
-    return rv ;
-
-  // don't forget the db file itself
-  m_DB->Shutdown() ;
-  nsFileSpec dbfile ;
-  m_DBFile->GetFileSpec(&dbfile) ;
-  dbfile.Delete(PR_TRUE) ;
-
-  // reinitilize
-  rv = InitDB() ;
-  if(NS_FAILED(rv))
-    return rv ;
-
-  rv = UpdateInfo() ;
-  return rv ;
-}
-
-//////////////////////////////////////////////////////////////////
-// nsINetDataDiskCache methods
-
-NS_IMETHODIMP
-nsNetDiskCache::GetDiskCacheFolder(nsIFileSpec * *aDiskCacheFolder)
-{
-  *aDiskCacheFolder = m_pDiskCacheFolder ;
-  NS_ADDREF(*aDiskCacheFolder) ;
-  return NS_OK ;
-}
-
-NS_IMETHODIMP
-nsNetDiskCache::SetDiskCacheFolder(nsIFileSpec * aDiskCacheFolder)
-{
-  char *newfolder, *oldfolder ;
-  m_pDiskCacheFolder->GetNativePath(&oldfolder) ;
-  aDiskCacheFolder->GetNativePath(&newfolder) ;
-
-  if(PL_strcmp(newfolder, oldfolder) == 0) {
-    m_pDiskCacheFolder = aDiskCacheFolder ;
-
-    // should we do this? 
-    // FUR - no
-    nsresult rv = RemoveAll() ;
-    return rv ;
-  }
-  else 
-    // FUR
-    // Need to blow away old cache, build new one
-    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 ;
-
-  dir_spec->GetParent(getter_AddRefs(p_spec)) ;
-  // FUR - check return value
-  p_spec->Exists(&does_exist) ;
-  if(!does_exist) {
-    CreateDir(p_spec) ;
-    dir_spec->CreateDir() ;
-    // FUR - check return value
-  }
-  else {
-    dir_spec->CreateDir() ;
-    // FUR - check return value
-  }
-  
-  return NS_OK ;
-}
-
-// FUR!!
-// 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.
-
-// this will walk through db and update m_NumEntries and m_StorageInUse
-NS_IMETHODIMP
-nsNetDiskCache::UpdateInfo(void)
-{
-  // count num of entries in db
-//  NS_ADDREF(this) ; // addref before assign to a nsCOMPtr. 
-  nsISimpleEnumerator* dbEnumerator = new nsDBEnumerator(m_DB, this) ;
-  if(dbEnumerator)
-    NS_ADDREF(dbEnumerator) ;
-  else
-    return NS_ERROR_FAILURE ;
-
-  PRUint32 numEntries = 0, storageInUse = 0, len = 0 ;
-  PRBool more = PR_FALSE ;
-
-  do {
-    dbEnumerator->HasMoreElements(&more) ;
-    if(more) {
-      // update entry number
-      numEntries++ ;
-
-      // update storage in use
-      nsINetDataCacheRecord* record ;
-      dbEnumerator->GetNext((nsISupports**)&record) ;
-      record->GetStoredContentLength(&len) ;
-      storageInUse += len ;
-      NS_IF_RELEASE(record) ;
-    }
-  } while (more) ;
-
-  NS_IF_RELEASE(dbEnumerator) ;
-
-  m_NumEntries = numEntries ;
-  m_StorageInUse = storageInUse ;
-
-  printf(" m_NumEntries = %d, size is %d.\n", m_NumEntries, m_StorageInUse) ;
-
-  return NS_OK ;
-}
-
-// this routine will add m_BaseDirNum to current CacheSubDir names. 
-// e.g. 00->20, 1f->5f. and update the m_BaseDirNum to another 32. 
-// the idea is as long as we remember the base number,
-// we know how many dirs needs to be removed during shutdown period
-// it will be from 0x20 to m_BaseDirNum. 
-// also, we assume that this operation will not be performed 3 times more
-// within a single session. it is part of scavenging routine. 
-
-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 dirName[3];
-    PR_snprintf(dirName, 3, "%0.2x", i) ;
-    cacheSubDir->AppendRelativeUnixPath(dirName) ;
-
-    // re-name the directory
-    PR_snprintf(dirName, 3, "%0.2x", i+m_BaseDirNum) ;
-    rv = cacheSubDir->Rename(dirName) ;
-    if(NS_FAILED(rv))
-      return NS_ERROR_FAILURE ;
-  }
-
-  // update m_BaseDirNum 
-  m_BaseDirNum += 32 ;
-
-  return NS_OK ;
-}
-
-// this routine will be called everytime we have a db corruption. 
-NS_IMETHODIMP
-nsNetDiskCache::DBRecovery(void)
-{
-  nsresult rv = RenameCacheSubDirs() ;
-  if(NS_FAILED(rv))
-    return rv ;
-
-  // remove corrupted db file
-  rv = m_DB->Shutdown() ;
-  
-  // FUR!!
-  // You shouldn't return if this fails.  Otherwise, it might prevent db deletion
-  if(NS_FAILED(rv))
-    return rv ;
-
-  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
-  rv = InitDB() ;
-  if(NS_FAILED(rv))
-    return rv ;
-
-  rv = UpdateInfo() ;
-  return rv ;
-}
-
-// this routine is used by dtor and RemoveAll() to clean up dirs.
-// All directory named from aNum - m_BasedDirNum will be deleted. 
-NS_IMETHODIMP
-nsNetDiskCache::RemoveDirs(PRUint32 aNum)
-{
-  nsCOMPtr<nsIFileSpec> cacheSubDir;
-  nsresult rv = NS_NewFileSpec(getter_AddRefs(cacheSubDir));
-  if(NS_FAILED(rv))
-    return NS_ERROR_FAILURE ;
-
-  for (int i=aNum; i < m_BaseDirNum; i++) {
-    cacheSubDir->FromFileSpec(m_pDiskCacheFolder) ;
-
-    char dirName[3];
-    PR_snprintf (dirName, 3, "%0.2x", i);
-    cacheSubDir->AppendRelativeUnixPath (dirName) ;
-
-    nsFileSpec subdir ;
-    cacheSubDir->GetFileSpec(&subdir) ;
-
-    for(nsDirectoryIterator di(subdir, PR_FALSE); di.Exists(); di++) {
-      di.Spec().Delete(PR_TRUE) ;
-    }
-
-    subdir.Delete(PR_FALSE) ; // recursive delete
-  }
-
-  return NS_OK ;
-}

mozilla/netwerk/cache/filecache/nsNetDiskCache.h

@@ -1,82 +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 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>
- */
-
-// FUR - Add overall description comment here
-
-#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 UpdateInfo(void) ;
-
-  NS_IMETHOD RenameCacheSubDirs(void) ;
-  NS_IMETHOD DBRecovery(void) ;
-  NS_IMETHOD RemoveDirs(PRUint32 aNum) ;
-
-  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
-  PRInt32                           m_BaseDirNum ;
-
-  friend class nsDiskCacheRecord ;
-  friend class nsDiskCacheRecordChannel ;
-} ;
-
-#endif /* __gen_nsNetDiskCache_h__ */

mozilla/netwerk/cache/filecache/nsNetDiskCacheCID.h

@@ -1,32 +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 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

@@ -1,50 +0,0 @@
-#
-# 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

@@ -1,836 +0,0 @@
-/* -*- 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

@@ -1,46 +0,0 @@
-# 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
-
-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

@@ -1,42 +0,0 @@
-#!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

@@ -1,334 +0,0 @@
-/* -*- 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

@@ -1,83 +0,0 @@
-/* -*- 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

@@ -1,36 +0,0 @@
-/* -*- 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

@@ -1,464 +0,0 @@
-/* -*- 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), mChannel(aChannel), mAvailable(0), mAborted(false), mSuspended(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 = true;
-        return mStreamListener->OnStopRequest(mChannel, mContext, NS_BINDING_ABORTED, nsnull);
-    }
-
-    nsresult
-    Suspend(void) { mSuspended = true; return NS_OK; }
-
-    nsresult
-    Resume(void) {
-        if (!mSuspended)
-            return NS_ERROR_FAILURE;
-        mSuspended = 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 = 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
-    bool                        mAborted;        // Abort() has been called
-    bool                        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");
-    // FIXME - lying for the purpose of testing
-    *aContentType = strdup("text/html");
-    return NS_OK;
-}
-
-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

@@ -1,61 +0,0 @@
-/* -*- 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

@@ -1,164 +0,0 @@
-/* -*- 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

@@ -1,65 +0,0 @@
-/* -*- 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 "nsCOMPtr.h"
-
-class nsMemCache;
-class nsIStorageStream;
-
-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

@@ -1,51 +0,0 @@
-#
-# 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
-
-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

@@ -1,45 +0,0 @@
-#!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

@@ -1,260 +0,0 @@
-/* -*- 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() {}
-
-    NS_DECL_ISUPPORTS
-
-    NS_IMETHOD Close() {
-        mCacheEntry->NoteDownloadTime(mStartTime, PR_Now());
-        mCacheEntry->ClearFlag(nsCachedNetData::UPDATE_IN_PROGRESS);
-        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 : 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

@@ -1,82 +0,0 @@
-/* -*- 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

@@ -1,496 +0,0 @@
-/* -*- 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  2000
-#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) || !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

@@ -1,99 +0,0 @@
-/* -*- 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 "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

@@ -1,242 +0,0 @@
-/* -*- 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(bool 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

@@ -1,658 +0,0 @@
-/* -*- 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;
-    // Sanity-check
-    if (!duration)
-        return;
-
-    // Compute download rate in kB/s
-    rate = mLogicalLength / (duration * (1e-6 /1024.0));
-    
-    // Exponentially smooth download rate
-    const double alpha = 0.5;
-    mDownloadRate = (float)(mDownloadRate * alpha + rate * (1.0 - alpha));
-}
-
-// 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;
-    bool 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 = true;
-        halfLife = mStaleTime - docTime;
-    } else {
-        potentiallyStale = 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 * 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

@@ -1,136 +0,0 @@
-/* -*- 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

@@ -1,39 +0,0 @@
-#
-# 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
-
-EXPORTS		= \
-		nsICacheManager.h \
-		nsICacheObject.h \
-		nsICachePref.h \
-		nsICacheModule.h \
-		$(NULL)
-
-EXPORTS		:= $(addprefix $(srcdir)/, $(EXPORTS))
-
-include $(topsrcdir)/config/rules.mk
-

mozilla/netwerk/cache/public/Makefile.win

@@ -1,41 +0,0 @@
-#!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

@@ -1,229 +0,0 @@
-/* -*- 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

@@ -1,143 +0,0 @@
-/* -*- 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

@@ -1,163 +0,0 @@
-/* -*- 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

@@ -1,125 +0,0 @@
-/* -*- 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

@@ -1,42 +0,0 @@
-/* -*- 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

@@ -1,106 +0,0 @@
-/* -*- 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);
-};