a=brendan,av

r=av
bug=50811

This bug fix was suggested by Stanley Ho <stanley.ho@eng.sun.com>.

Stanley proposed we overload the meaning of the nsIPluginStreamListener
argument to nsIPluginManager::{GetURL,PostURL}() so that it also may
implement an interface for reading headers.  Thus, the browser could QI
the plugin's nsIPluginStreamListener instance to this headers reading
interface and send the plugin the headers from the response.

I have implemented Stanley's above proposal.  I have defined a new
interface, nsIHTTPHeaderListener.idl with one method:

  /**

   * Called for each HTTP Response header.

   * NOTE: You must copy the values of the params.

   */

  void newResponseHeader(in string headerName, in string headerValue);

To affect this fix, I have added a new private method

nsPluginStreamListenerPeer::
ReadHeadersFromChannelAndPostToListener(nsIHTTPChannel *httpChannel,
                                        nsIHTTPHeaderListener *listener)

Then, modified nsPluginStreamListenerPeer::OnDataAvailable() to call
this method BEFORE reading the content data.  However, this fix makes
two important assumptions I would like to check out:

   * Assumption

   * By the time nsPluginStreamListenerPeer::OnDataAvailable() gets
   * called, all the headers have been read.

       * Assumption:

       * The return value from nsIHTTPHeader->{GetFieldName,GetValue}()
       * must be freed.

The following files are included in this fix:

A modules/plugin/public/nsIHTTPHeaderListener.idl
A modules/plugin/public/makefile.win
A modules/plugin/public/Makefile.in
M modules/plugin/nglsrc/nsPluginHostImpl.cpp

modules/plugin/base/public/Makefile.in

@@ -65,6 +65,7 @@ EXPORTS		+= \
 
 XPIDLSRCS 	= \
 		nsIScriptablePlugin.idl \
+		nsIHTTPHeaderListener.idl     \
 		$(NULL)
 
 EXPORTS		:= $(addprefix $(srcdir)/, $(EXPORTS))

modules/plugin/base/public/makefile.win

@@ -54,7 +54,9 @@ EXPORTS = $(EXPORTS)                          \
         nsIPluginInputStream2.h
 
 XPIDLSRCS = 				      \
-	.\nsIScriptablePlugin.idl
+	.\nsIScriptablePlugin.idl             \
+	.\nsIHTTPHeaderListener.idl     \
+	$(NULL)
 
 include <$(DEPTH)/config/rules.mak>
 

modules/plugin/base/public/nsIHTTPHeaderListener.idl

@@ -0,0 +1,57 @@
+/* -*- 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): Ed Burns <edburns@acm.org>
+ */
+
+#include "nsPluginDefs.idl"
+
+/**
+ 
+ * The nsIHTTPHeaderListener interface allows plugin authors to
+ * access HTTP Response headers after issuing an
+ * nsIPluginManager::{GetURL,PostURL}() call. <P>
+
+ * IMPORTANT NOTE: The plugin author must provide an instance to
+ * {GetURL,PostURL}() that implements both nsIPluginStreamListener and
+ * nsIHTTPHeaderListener.  This instance is passed in through
+ * {GetURL,PostURL}()'s streamListener parameter.  The browser will then
+ * QI thi streamListener to see if it implements
+ * nsIHTTPHeaderListener.
+
+ */
+
+[scriptable, uuid(8b246748-1dd2-11b2-9512-9dc84a95fc2f)]
+interface nsIHTTPHeaderListener : nsISupports
+{
+
+  /**
+
+   * Called for each HTTP Response header.
+
+   * NOTE: You must copy the values of the params.  
+
+   */
+
+  void newResponseHeader(in string headerName, in string headerValue);
+};
+
+////////////////////////////////////////////////////////////////////////////////
+
+#endif /* nsIPluginStreamListener_h___ */

modules/plugin/public/Makefile.in

@@ -65,6 +65,7 @@ EXPORTS		+= \
 
 XPIDLSRCS 	= \
 		nsIScriptablePlugin.idl \
+		nsIHTTPHeaderListener.idl     \
 		$(NULL)
 
 EXPORTS		:= $(addprefix $(srcdir)/, $(EXPORTS))

modules/plugin/public/makefile.win

@@ -54,7 +54,9 @@ EXPORTS = $(EXPORTS)                          \
         nsIPluginInputStream2.h
 
 XPIDLSRCS = 				      \
-	.\nsIScriptablePlugin.idl
+	.\nsIScriptablePlugin.idl             \
+	.\nsIHTTPHeaderListener.idl     \
+	$(NULL)
 
 include <$(DEPTH)/config/rules.mak>
 

modules/plugin/public/nsIHTTPHeaderListener.idl

@@ -0,0 +1,57 @@
+/* -*- 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): Ed Burns <edburns@acm.org>
+ */
+
+#include "nsPluginDefs.idl"
+
+/**
+ 
+ * The nsIHTTPHeaderListener interface allows plugin authors to
+ * access HTTP Response headers after issuing an
+ * nsIPluginManager::{GetURL,PostURL}() call. <P>
+
+ * IMPORTANT NOTE: The plugin author must provide an instance to
+ * {GetURL,PostURL}() that implements both nsIPluginStreamListener and
+ * nsIHTTPHeaderListener.  This instance is passed in through
+ * {GetURL,PostURL}()'s streamListener parameter.  The browser will then
+ * QI thi streamListener to see if it implements
+ * nsIHTTPHeaderListener.
+
+ */
+
+[scriptable, uuid(8b246748-1dd2-11b2-9512-9dc84a95fc2f)]
+interface nsIHTTPHeaderListener : nsISupports
+{
+
+  /**
+
+   * Called for each HTTP Response header.
+
+   * NOTE: You must copy the values of the params.  
+
+   */
+
+  void newResponseHeader(in string headerName, in string headerValue);
+};
+
+////////////////////////////////////////////////////////////////////////////////
+
+#endif /* nsIPluginStreamListener_h___ */