2007-03-22 10:30:00 -07:00
|
|
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
|
|
/* ***** 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 mozilla.org code.
|
|
|
|
*
|
|
|
|
* The Initial Developer of the Original Code is
|
|
|
|
* Netscape Communications Corporation.
|
|
|
|
* Portions created by the Initial Developer are Copyright (C) 1998
|
|
|
|
* the Initial Developer. All Rights Reserved.
|
|
|
|
*
|
|
|
|
* Contributor(s):
|
|
|
|
*
|
|
|
|
* 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 ***** */
|
|
|
|
#ifndef __nsmultimixedconv__h__
|
|
|
|
#define __nsmultimixedconv__h__
|
|
|
|
|
|
|
|
#include "nsIStreamConverter.h"
|
|
|
|
#include "nsIChannel.h"
|
|
|
|
#include "nsIURI.h"
|
|
|
|
#include "nsString.h"
|
|
|
|
#include "nsXPIDLString.h"
|
|
|
|
#include "nsCOMPtr.h"
|
2010-08-30 13:20:39 -07:00
|
|
|
#include "nsInt64.h"
|
2007-03-22 10:30:00 -07:00
|
|
|
#include "nsIByteRangeRequest.h"
|
|
|
|
#include "nsIMultiPartChannel.h"
|
|
|
|
#include "nsAutoPtr.h"
|
|
|
|
|
|
|
|
#define NS_MULTIMIXEDCONVERTER_CID \
|
|
|
|
{ /* 7584CE90-5B25-11d3-A175-0050041CAF44 */ \
|
|
|
|
0x7584ce90, \
|
|
|
|
0x5b25, \
|
|
|
|
0x11d3, \
|
|
|
|
{0xa1, 0x75, 0x0, 0x50, 0x4, 0x1c, 0xaf, 0x44} \
|
|
|
|
}
|
|
|
|
|
|
|
|
//
|
|
|
|
// nsPartChannel is a "dummy" channel which represents an individual part of
|
|
|
|
// a multipart/mixed stream...
|
|
|
|
//
|
|
|
|
// Instances on this channel are passed out to the consumer through the
|
|
|
|
// nsIStreamListener interface.
|
|
|
|
//
|
|
|
|
class nsPartChannel : public nsIChannel,
|
|
|
|
public nsIByteRangeRequest,
|
|
|
|
public nsIMultiPartChannel
|
|
|
|
{
|
|
|
|
public:
|
2010-04-10 09:10:21 -07:00
|
|
|
nsPartChannel(nsIChannel *aMultipartChannel, PRUint32 aPartID,
|
|
|
|
nsIStreamListener* aListener);
|
2007-03-22 10:30:00 -07:00
|
|
|
|
|
|
|
void InitializeByteRange(PRInt64 aStart, PRInt64 aEnd);
|
|
|
|
void SetIsLastPart() { mIsLastPart = PR_TRUE; }
|
2010-04-10 09:10:21 -07:00
|
|
|
nsresult SendOnStartRequest(nsISupports* aContext);
|
|
|
|
nsresult SendOnDataAvailable(nsISupports* aContext, nsIInputStream* aStream,
|
|
|
|
PRUint32 aOffset, PRUint32 aLen);
|
|
|
|
nsresult SendOnStopRequest(nsISupports* aContext, nsresult aStatus);
|
2007-03-22 10:30:00 -07:00
|
|
|
|
|
|
|
NS_DECL_ISUPPORTS
|
|
|
|
NS_DECL_NSIREQUEST
|
|
|
|
NS_DECL_NSICHANNEL
|
|
|
|
NS_DECL_NSIBYTERANGEREQUEST
|
|
|
|
NS_DECL_NSIMULTIPARTCHANNEL
|
|
|
|
|
|
|
|
protected:
|
|
|
|
~nsPartChannel();
|
|
|
|
|
|
|
|
protected:
|
|
|
|
nsCOMPtr<nsIChannel> mMultipartChannel;
|
2010-04-10 09:10:21 -07:00
|
|
|
nsCOMPtr<nsIStreamListener> mListener;
|
2007-03-22 10:30:00 -07:00
|
|
|
|
|
|
|
nsresult mStatus;
|
|
|
|
nsLoadFlags mLoadFlags;
|
|
|
|
|
|
|
|
nsCOMPtr<nsILoadGroup> mLoadGroup;
|
|
|
|
|
|
|
|
nsCString mContentType;
|
|
|
|
nsCString mContentCharset;
|
|
|
|
nsCString mContentDisposition;
|
2009-08-12 01:51:46 -07:00
|
|
|
PRUint64 mContentLength;
|
2007-03-22 10:30:00 -07:00
|
|
|
|
|
|
|
PRBool mIsByteRangeRequest;
|
2010-08-30 13:20:39 -07:00
|
|
|
nsInt64 mByteRangeStart;
|
|
|
|
nsInt64 mByteRangeEnd;
|
2007-03-22 10:30:00 -07:00
|
|
|
|
|
|
|
PRUint32 mPartID; // unique ID that can be used to identify
|
|
|
|
// this part of the multipart document
|
|
|
|
PRBool mIsLastPart;
|
|
|
|
};
|
|
|
|
|
|
|
|
// The nsMultiMixedConv stream converter converts a stream of type "multipart/x-mixed-replace"
|
|
|
|
// to it's subparts. There was some debate as to whether or not the functionality desired
|
|
|
|
// when HTTP confronted this type required a stream converter. After all, this type really
|
|
|
|
// prompts various viewer related actions rather than stream conversion. There simply needs
|
|
|
|
// to be a piece in place that can strip out the multiple parts of a stream of this type, and
|
|
|
|
// "display" them accordingly.
|
|
|
|
//
|
|
|
|
// With that said, this "stream converter" spends more time packaging up the sub parts of the
|
|
|
|
// main stream and sending them off the destination stream listener, than doing any real
|
|
|
|
// stream parsing/converting.
|
|
|
|
//
|
|
|
|
// WARNING: This converter requires that it's destination stream listener be able to handle
|
|
|
|
// multiple OnStartRequest(), OnDataAvailable(), and OnStopRequest() call combinations.
|
|
|
|
// Each series represents the beginning, data production, and ending phase of each sub-
|
|
|
|
// part of the original stream.
|
|
|
|
//
|
|
|
|
// NOTE: this MIME-type is used by HTTP, *not* SMTP, or IMAP.
|
|
|
|
//
|
|
|
|
// NOTE: For reference, a general description of how this MIME type should be handled via
|
|
|
|
// HTTP, see http://home.netscape.com/assist/net_sites/pushpull.html . Note that
|
|
|
|
// real world server content deviates considerably from this overview.
|
|
|
|
//
|
|
|
|
// Implementation assumptions:
|
|
|
|
// Assumed structue:
|
|
|
|
// --BoundaryToken[\r]\n
|
|
|
|
// content-type: foo/bar[\r]\n
|
|
|
|
// ... (other headers if any)
|
|
|
|
// [\r]\n (second line feed to delimit end of headers)
|
|
|
|
// data
|
|
|
|
// --BoundaryToken-- (end delimited by final "--")
|
|
|
|
//
|
2010-04-15 21:12:08 -07:00
|
|
|
// linebreaks can be either CRLF or LFLF. linebreaks preceding
|
2007-03-22 10:30:00 -07:00
|
|
|
// boundary tokens are considered part of the data. BoundaryToken
|
|
|
|
// is any opaque string.
|
|
|
|
//
|
|
|
|
//
|
|
|
|
|
|
|
|
class nsMultiMixedConv : public nsIStreamConverter {
|
|
|
|
public:
|
|
|
|
NS_DECL_ISUPPORTS
|
|
|
|
NS_DECL_NSISTREAMCONVERTER
|
|
|
|
NS_DECL_NSISTREAMLISTENER
|
|
|
|
NS_DECL_NSIREQUESTOBSERVER
|
|
|
|
|
|
|
|
nsMultiMixedConv();
|
|
|
|
virtual ~nsMultiMixedConv();
|
|
|
|
|
|
|
|
protected:
|
|
|
|
nsresult SendStart(nsIChannel *aChannel);
|
|
|
|
nsresult SendStop(nsresult aStatus);
|
|
|
|
nsresult SendData(char *aBuffer, PRUint32 aLen);
|
|
|
|
nsresult ParseHeaders(nsIChannel *aChannel, char *&aPtr,
|
|
|
|
PRUint32 &aLen, PRBool *_retval);
|
|
|
|
PRInt32 PushOverLine(char *&aPtr, PRUint32 &aLen);
|
|
|
|
char *FindToken(char *aCursor, PRUint32 aLen);
|
|
|
|
nsresult BufferData(char *aData, PRUint32 aLen);
|
|
|
|
|
|
|
|
// member data
|
|
|
|
PRBool mNewPart; // Are we processing the beginning of a part?
|
|
|
|
PRBool mProcessingHeaders;
|
|
|
|
nsCOMPtr<nsIStreamListener> mFinalListener; // this guy gets the converted data via his OnDataAvailable()
|
|
|
|
|
|
|
|
nsCString mToken;
|
|
|
|
PRUint32 mTokenLen;
|
|
|
|
|
|
|
|
nsRefPtr<nsPartChannel> mPartChannel; // the channel for the given part we're processing.
|
|
|
|
// one channel per part.
|
|
|
|
nsCOMPtr<nsISupports> mContext;
|
|
|
|
nsCString mContentType;
|
|
|
|
nsCString mContentDisposition;
|
2009-08-12 01:51:46 -07:00
|
|
|
PRUint64 mContentLength;
|
2007-03-22 10:30:00 -07:00
|
|
|
|
|
|
|
char *mBuffer;
|
|
|
|
PRUint32 mBufLen;
|
2009-08-12 01:51:46 -07:00
|
|
|
PRUint64 mTotalSent;
|
2007-03-22 10:30:00 -07:00
|
|
|
PRBool mFirstOnData; // used to determine if we're in our first OnData callback.
|
|
|
|
|
|
|
|
// The following members are for tracking the byte ranges in
|
|
|
|
// multipart/mixed content which specified the 'Content-Range:'
|
|
|
|
// header...
|
2010-08-30 13:20:39 -07:00
|
|
|
nsInt64 mByteRangeStart;
|
|
|
|
nsInt64 mByteRangeEnd;
|
2007-03-22 10:30:00 -07:00
|
|
|
PRBool mIsByteRangeRequest;
|
|
|
|
|
|
|
|
PRUint32 mCurrentPartID;
|
|
|
|
};
|
|
|
|
|
|
|
|
#endif /* __nsmultimixedconv__h__ */
|