Fix crash due to not removing dead windows from the window map, by removing the correct pointer and making the hashtable key typesafe (bug 336780). r=marria. Not part of any default builds.

extensions/metrics/src/nsMetricsService.cpp

@@ -86,8 +86,10 @@
 #include "nsMemory.h"
 #include "nsIBadCertListener.h"
 #include "nsIInterfaceRequestor.h"
+#include "nsIInterfaceRequestorUtils.h"
 #include "nsIX509Cert.h"
 #include "nsAutoPtr.h"
+#include "nsIDOMWindow.h"
 
 // We need to suppress inclusion of nsString.h
 #define nsString_h___
@@ -886,7 +888,13 @@ nsMetricsService::Observe(nsISupports *subject, const char *topic,
     obsSvc->NotifyObservers(subject, newTopic, data);
 
     // Remove the window from our map.
-    mWindowMap.Remove(subject);
+    nsCOMPtr<nsIDOMWindow> window = do_GetInterface(subject);
+    if (window) {
+      MS_LOG(("Removing window from map: %p", window.get()));
+      mWindowMap.Remove(window);
+    } else {
+      MS_LOG(("Couldn't get window to remove from map"));
+    }
   } else if (strcmp(topic, NS_HTTP_ON_MODIFY_REQUEST_TOPIC) == 0) {
     // Check whether this channel if one of ours.  If it is, clear the cookies.
     nsCOMPtr<nsIPropertyBag2> props = do_QueryInterface(subject);
@@ -1411,6 +1419,7 @@ nsMetricsService::GetWindowIDInternal(nsIDOMWindow *window)
   PRUint32 id;
   if (!mWindowMap.Get(window, &id)) {
     id = mNextWindowID++;
+    MS_LOG(("Adding window %p to map with id %d", window, id));
     mWindowMap.Put(window, id);
   }
 

extensions/metrics/src/nsMetricsService.h

@@ -58,6 +58,7 @@
 #include "nsIWritablePropertyBag2.h"
 #include "nsDataHashtable.h"
 #include "nsInterfaceHashtable.h"
+#include "nsPtrHashKey.h"
 
 class nsILocalFile;
 class nsIDOMWindow;
@@ -129,7 +130,8 @@ public:
   nsresult Init();
 
   // Returns the window id map (readonly)
-  const nsDataHashtable<nsVoidPtrHashKey, PRUint32>& WindowMap() const
+  const nsDataHashtable< nsPtrHashKey<nsIDOMWindow>, PRUint32 >&
+  WindowMap() const
   {
     return mWindowMap;
   }
@@ -232,7 +234,7 @@ private:
   nsCOMPtr<nsICryptoHash> mCryptoHash;
 
   // Window to incrementing-id map.  The keys are nsIDOMWindow*.
-  nsDataHashtable<nsVoidPtrHashKey, PRUint32> mWindowMap;
+  nsDataHashtable< nsPtrHashKey<nsIDOMWindow>, PRUint32 > mWindowMap;
 
   // All of the active observers, keyed by name.
   nsInterfaceHashtable<nsStringHashKey, nsIMetricsCollector> mCollectorMap;

extensions/metrics/src/nsPtrHashKey.h

@@ -0,0 +1,78 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim:set ts=2 sw=2 sts=2 et cindent: */
+/* ***** BEGIN LICENSE BLOCK *****
+ * Version: MPL 1.1/GPL 2.0/LGPL 2.1
+ *
+ * The contents of this file are subject to the Mozilla Public License Version
+ * 1.1 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ * http://www.mozilla.org/MPL/
+ *
+ * Software distributed under the License is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
+ * for the specific language governing rights and limitations under the
+ * License.
+ *
+ * The Original Code is the Metrics extension.
+ *
+ * The Initial Developer of the Original Code is Google Inc.
+ * Portions created by the Initial Developer are Copyright (C) 2006
+ * the Initial Developer. All Rights Reserved.
+ *
+ * Contributor(s):
+ *  Brian Ryner <bryner@brianryner.com>
+ *
+ * Alternatively, the contents of this file may be used under the terms of
+ * either the GNU General Public License Version 2 or later (the "GPL"), or
+ * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
+ * in which case the provisions of the GPL or the LGPL are applicable instead
+ * of those above. If you wish to allow use of your version of this file only
+ * under the terms of either the GPL or the LGPL, and not to allow others to
+ * use your version of this file under the terms of the MPL, indicate your
+ * decision by deleting the provisions above and replace them with the notice
+ * and other provisions required by the GPL or the LGPL. If you do not delete
+ * the provisions above, a recipient may use your version of this file under
+ * the terms of any one of the MPL, the GPL or the LGPL.
+ *
+ * ***** END LICENSE BLOCK ***** */
+
+// This class defines a templatized hash key type for holding raw pointers.
+// Use it like this:
+//   nsDataHashtable< nsPtrHashKey<SomeClass>, SomeValueType > mTable;
+//
+// This is identical to nsVoidPtrHashKey with void* replaced by T*.
+
+#ifndef nsPtrHashKey_h_
+#define nsPtrHashKey_h_
+
+#include "pldhash.h"
+#include "nscore.h"
+
+template<class T>
+class nsPtrHashKey : public PLDHashEntryHdr
+{
+ public:
+  typedef const T *KeyType;
+  typedef const T *KeyTypePointer;
+
+  nsPtrHashKey(const T *key) : mKey(key) {}
+  nsPtrHashKey(const nsPtrHashKey<T> &toCopy) : mKey(toCopy.mKey) {}
+  ~nsPtrHashKey() {}
+
+  KeyType GetKey() const { return mKey; }
+  KeyTypePointer GetKeyPointer() const { return mKey; }
+
+  PRBool KeyEquals(KeyTypePointer key) const { return key == mKey; }
+
+  static KeyTypePointer KeyToPointer(KeyType key) { return key; }
+  static PLDHashNumber HashKey(KeyTypePointer key)
+  {
+    return NS_PTR_TO_INT32(key) >> 2;
+  }
+  enum { ALLOW_MEMMOVE = PR_TRUE };
+
+ private:
+  const T *mKey;
+};
+
+#endif  // nsPtrHashKey_h_

extensions/metrics/src/nsUICommandCollector.cpp

@@ -61,11 +61,10 @@ NS_IMPL_ISUPPORTS3(nsUICommandCollector, nsIObserver, nsIDOMEventListener,
 
 /* static */
 PLDHashOperator PR_CALLBACK nsUICommandCollector::RemoveCommandEventListener(
-const void* key, PRUint32 windowID, void* userArg)
+const nsIDOMWindow* key, PRUint32 windowID, void* userArg)
 {
-  const nsIDOMWindow* window = NS_STATIC_CAST(const nsIDOMWindow*, key);
-  nsIDOMWindow* window2 = NS_CONST_CAST(nsIDOMWindow*, window);
-  nsCOMPtr<nsIDOMEventTarget> windowTarget = do_QueryInterface(window2);
+  nsCOMPtr<nsIDOMEventTarget> windowTarget =
+    do_QueryInterface(NS_CONST_CAST(nsIDOMWindow *, key));
   if (!windowTarget) {
     MS_LOG(("Error casting domeventtarget"));
     return PL_DHASH_NEXT;

extensions/metrics/src/nsUICommandCollector.h

@@ -45,6 +45,8 @@
 
 #include "nsDataHashtable.h"
 
+class nsIDOMWindow;
+
 class nsUICommandCollector : public nsIObserver,
                              public nsIDOMEventListener,
                              public nsIMetricsCollector
@@ -57,7 +59,7 @@ class nsUICommandCollector : public nsIObserver,
   NS_DECL_NSIMETRICSCOLLECTOR
   
   static PLDHashOperator PR_CALLBACK RemoveCommandEventListener(
-    const void* key, PRUint32 windowID, void* userArg);
+    const nsIDOMWindow* key, PRUint32 windowID, void* userArg);
 
   nsUICommandCollector();