/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ /* ***** BEGIN LICENSE BLOCK ***** * Version: NPL 1.1/GPL 2.0/LGPL 2.1 * * 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 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 NPL, 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 NPL, the GPL or the LGPL. * * ***** END LICENSE BLOCK ***** */ #ifndef nsNetUtil_h__ #define nsNetUtil_h__ #include "nsIURI.h" #include "netCore.h" #include "nsIInputStream.h" #include "nsIOutputStream.h" #include "nsIStreamListener.h" #include "nsIStreamProvider.h" #include "nsIRequestObserverProxy.h" #include "nsILoadGroup.h" #include "nsIInterfaceRequestor.h" #include "nsIInterfaceRequestorUtils.h" #include "nsString.h" #include "nsReadableUtils.h" #include "nsIIOService.h" #include "nsIServiceManager.h" #include "nsIChannel.h" #include "nsIStreamIOChannel.h" #include "nsITransport.h" #include "nsMemory.h" #include "nsCOMPtr.h" #include "nsIDownloader.h" #include "nsIStreamLoader.h" #include "nsIStreamIO.h" #include "nsIPipe.h" #include "nsIProtocolHandler.h" #include "nsIStringStream.h" #include "nsILocalFile.h" #include "nsIFileStreams.h" #include "nsXPIDLString.h" #include "nsIProtocolProxyService.h" #include "prio.h" // for read/write flags, permissions, etc. #include "nsNetCID.h" // Helper, to simplify getting the I/O service. inline const nsGetServiceByCID do_GetIOService(nsresult* error = 0) { static NS_DEFINE_CID(kIOServiceCID, NS_IOSERVICE_CID); return nsGetServiceByCID(kIOServiceCID, 0, error); } inline nsresult NS_NewURI(nsIURI* *result, const char* spec, nsIURI* baseURI = nsnull, nsIIOService* ioService = nsnull) // pass in nsIIOService to optimize callers { nsresult rv; nsCOMPtr serv; if (ioService == nsnull) { serv = do_GetIOService(&rv); if (NS_FAILED(rv)) return rv; ioService = serv.get(); } return ioService->NewURI(spec, baseURI, result); } inline nsresult NS_NewURI(nsIURI* *result, const nsAReadableString& spec, nsIURI* baseURI = nsnull, nsIIOService* ioService = nsnull) // pass in nsIIOService to optimize callers { NS_ConvertUCS2toUTF8 specStr(spec); // this forces a single byte char* if (!spec.IsEmpty() && specStr.IsEmpty()) return NS_ERROR_OUT_OF_MEMORY; return NS_NewURI(result, specStr.get(), baseURI, ioService); } inline nsresult NS_NewFileURI(nsIURI* *result, nsIFile* spec, nsIIOService* ioService = nsnull) // pass in nsIIOService to optimize callers { nsresult rv; nsCOMPtr serv; if (ioService == nsnull) { serv = do_GetIOService(&rv); if (NS_FAILED(rv)) return rv; ioService = serv.get(); } return ioService->NewFileURI(spec, result); } inline nsresult NS_OpenURI(nsIChannel* *result, nsIURI* uri, nsIIOService* ioService = nsnull, // pass in nsIIOService to optimize callers nsILoadGroup* loadGroup = nsnull, nsIInterfaceRequestor* notificationCallbacks = nsnull, nsLoadFlags loadAttributes = NS_STATIC_CAST(nsLoadFlags, nsIRequest::LOAD_NORMAL)) { nsresult rv; nsCOMPtr serv; if (ioService == nsnull) { serv = do_GetIOService(&rv); if (NS_FAILED(rv)) return rv; ioService = serv.get(); } nsIChannel* channel = nsnull; rv = ioService->NewChannelFromURI(uri, &channel); if (NS_FAILED(rv)) return rv; if (loadGroup) { rv = channel->SetLoadGroup(loadGroup); if (NS_FAILED(rv)) return rv; } if (notificationCallbacks) { rv = channel->SetNotificationCallbacks(notificationCallbacks); if (NS_FAILED(rv)) return rv; } if (loadAttributes != nsIRequest::LOAD_NORMAL) { rv = channel->SetLoadFlags(loadAttributes); if (NS_FAILED(rv)) return rv; } *result = channel; return rv; } // Use this function with CAUTION. And do not use it on // the UI thread. It creates a stream that blocks when // you Read() from it and blocking the UI thread is // illegal. If you don't want to implement a full // blown asyncrhonous consumer (via nsIStreamListener) // look at nsIStreamLoader instead. inline nsresult NS_OpenURI(nsIInputStream* *result, nsIURI* uri, nsIIOService* ioService = nsnull, // pass in nsIIOService to optimize callers nsILoadGroup* loadGroup = nsnull, nsIInterfaceRequestor* notificationCallbacks = nsnull, nsLoadFlags loadAttributes = NS_STATIC_CAST(nsLoadFlags, nsIRequest::LOAD_NORMAL)) { nsresult rv; nsCOMPtr channel; rv = NS_OpenURI(getter_AddRefs(channel), uri, ioService, loadGroup, notificationCallbacks, loadAttributes); if (NS_FAILED(rv)) return rv; nsIInputStream* inStr; rv = channel->Open(&inStr); if (NS_FAILED(rv)) return rv; *result = inStr; return rv; } inline nsresult NS_OpenURI(nsIStreamListener* aConsumer, nsISupports* context, nsIURI* uri, nsIIOService* ioService = nsnull, // pass in nsIIOService to optimize callers nsILoadGroup* loadGroup = nsnull, nsIInterfaceRequestor* notificationCallbacks = nsnull, nsLoadFlags loadAttributes = NS_STATIC_CAST(nsLoadFlags, nsIRequest::LOAD_NORMAL)) { nsresult rv; nsCOMPtr channel; rv = NS_OpenURI(getter_AddRefs(channel), uri, ioService, loadGroup, notificationCallbacks, loadAttributes); if (NS_FAILED(rv)) return rv; rv = channel->AsyncOpen(aConsumer, context); return rv; } inline nsresult NS_MakeAbsoluteURI(char* *result, const char* spec, nsIURI* baseURI = nsnull, nsIIOService* ioService = nsnull) // pass in nsIIOService to optimize callers { NS_ASSERTION(baseURI, "It doesn't make sense to not supply a base URI"); if (spec == nsnull) return baseURI->GetSpec(result); return baseURI->Resolve(spec, result); } inline nsresult NS_MakeAbsoluteURI(nsAWritableString& result, const nsAReadableString& spec, nsIURI* baseURI = nsnull, nsIIOService* ioService = nsnull) // pass in nsIIOService to optimize callers { char* resultStr; char* specStr = ToNewUTF8String(spec); if (!specStr) { return NS_ERROR_OUT_OF_MEMORY; } nsresult rv = NS_MakeAbsoluteURI(&resultStr, specStr, baseURI, ioService); nsMemory::Free(specStr); if (NS_FAILED(rv)) return rv; result.Assign(NS_ConvertUTF8toUCS2(resultStr)); nsMemory::Free(resultStr); return rv; } inline nsresult NS_NewPostDataStream(nsIInputStream **result, PRBool isFile, const char *data, PRUint32 encodeFlags, nsIIOService* ioService = nsnull) // pass in nsIIOService to optimize callers { nsresult rv; if (isFile) { nsCOMPtr file; nsCOMPtr fileStream; rv = NS_NewLocalFile(data, PR_FALSE, getter_AddRefs(file)); if (NS_FAILED(rv)) return rv; rv = NS_NewLocalFileInputStream(getter_AddRefs(fileStream), file); if (NS_FAILED(rv)) return rv; // wrap the file stream with a buffered input stream return NS_NewBufferedInputStream(result, fileStream, 8192); } // otherwise, create a string stream for the data return NS_NewCStringInputStream(result, nsDependentCString(data)); } inline nsresult NS_NewStreamIOChannel(nsIStreamIOChannel **result, nsIURI* uri, nsIStreamIO* io) { nsresult rv; nsCOMPtr channel; static NS_DEFINE_CID(kStreamIOChannelCID, NS_STREAMIOCHANNEL_CID); rv = nsComponentManager::CreateInstance(kStreamIOChannelCID, nsnull, NS_GET_IID(nsIStreamIOChannel), getter_AddRefs(channel)); if (NS_FAILED(rv)) return rv; rv = channel->Init(uri, io); if (NS_FAILED(rv)) return rv; *result = channel; NS_ADDREF(*result); return NS_OK; } inline nsresult NS_NewInputStreamChannel(nsIChannel **result, nsIURI* uri, nsIInputStream* inStr, const char* contentType, PRInt32 contentLength) { nsresult rv; nsXPIDLCString spec; rv = uri->GetSpec(getter_Copies(spec)); if (NS_FAILED(rv)) return rv; nsCOMPtr io; rv = NS_NewInputStreamIO(getter_AddRefs(io), spec, inStr, contentType, contentLength); if (NS_FAILED(rv)) return rv; nsCOMPtr channel; rv = NS_NewStreamIOChannel(getter_AddRefs(channel), uri, io); if (NS_FAILED(rv)) return rv; *result = channel; NS_ADDREF(*result); return NS_OK; } inline nsresult NS_NewLoadGroup(nsILoadGroup* *result, nsIRequestObserver* obs) { nsresult rv; nsCOMPtr group; static NS_DEFINE_CID(kLoadGroupCID, NS_LOADGROUP_CID); rv = nsComponentManager::CreateInstance(kLoadGroupCID, nsnull, NS_GET_IID(nsILoadGroup), getter_AddRefs(group)); if (NS_FAILED(rv)) return rv; rv = group->SetGroupObserver(obs); if (NS_FAILED(rv)) return rv; *result = group; NS_ADDREF(*result); return NS_OK; } inline nsresult NS_NewDownloader(nsIDownloader* *result, nsIURI* uri, nsIDownloadObserver* observer, nsISupports* context = nsnull, PRBool synchronous = PR_FALSE, nsILoadGroup* loadGroup = nsnull, nsIInterfaceRequestor* notificationCallbacks = nsnull, nsLoadFlags loadAttributes = NS_STATIC_CAST(nsLoadFlags, nsIRequest::LOAD_NORMAL)) { nsresult rv; nsCOMPtr downloader; static NS_DEFINE_CID(kDownloaderCID, NS_DOWNLOADER_CID); rv = nsComponentManager::CreateInstance(kDownloaderCID, nsnull, NS_GET_IID(nsIDownloader), getter_AddRefs(downloader)); if (NS_FAILED(rv)) return rv; rv = downloader->Init(uri, observer, context, synchronous, loadGroup, notificationCallbacks, loadAttributes); if (NS_FAILED(rv)) return rv; *result = downloader; NS_ADDREF(*result); return rv; } inline nsresult NS_NewStreamLoader(nsIStreamLoader* *result, nsIURI* uri, nsIStreamLoaderObserver* observer, nsISupports* context = nsnull, nsILoadGroup* loadGroup = nsnull, nsIInterfaceRequestor* notificationCallbacks = nsnull, nsLoadFlags loadAttributes = NS_STATIC_CAST(nsLoadFlags, nsIRequest::LOAD_NORMAL), nsIURI* referrer = nsnull, PRUint32 referrerFlags = 0) { nsresult rv; nsCOMPtr loader; static NS_DEFINE_CID(kStreamLoaderCID, NS_STREAMLOADER_CID); rv = nsComponentManager::CreateInstance(kStreamLoaderCID, nsnull, NS_GET_IID(nsIStreamLoader), getter_AddRefs(loader)); if (NS_FAILED(rv)) return rv; rv = loader->Init(uri, observer, context, loadGroup, notificationCallbacks, loadAttributes, referrer, referrerFlags); if (NS_FAILED(rv)) return rv; *result = loader; NS_ADDREF(*result); return rv; } inline nsresult NS_NewRequestObserverProxy(nsIRequestObserver **aResult, nsIRequestObserver *aObserver, nsIEventQueue *aEventQ=nsnull) { NS_ENSURE_ARG_POINTER(aResult); nsresult rv; nsCOMPtr proxy; static NS_DEFINE_CID(kRequestObserverProxyCID, NS_REQUESTOBSERVERPROXY_CID); rv = nsComponentManager::CreateInstance(kRequestObserverProxyCID, nsnull, NS_GET_IID(nsIRequestObserverProxy), getter_AddRefs(proxy)); if (NS_FAILED(rv)) return rv; rv = proxy->Init(aObserver, aEventQ); if (NS_FAILED(rv)) return rv; return CallQueryInterface(proxy, aResult); } inline nsresult NS_NewStreamListenerProxy(nsIStreamListener **aResult, nsIStreamListener *aListener, nsIEventQueue *aEventQ=nsnull, PRUint32 aBufferSegmentSize=0, PRUint32 aBufferMaxSize=0) { NS_ENSURE_ARG_POINTER(aResult); nsresult rv; nsCOMPtr proxy; static NS_DEFINE_CID(kStreamListenerProxyCID, NS_STREAMLISTENERPROXY_CID); rv = nsComponentManager::CreateInstance(kStreamListenerProxyCID, nsnull, NS_GET_IID(nsIStreamListenerProxy), getter_AddRefs(proxy)); if (NS_FAILED(rv)) return rv; rv = proxy->Init(aListener, aEventQ, aBufferSegmentSize, aBufferMaxSize); if (NS_FAILED(rv)) return rv; NS_ADDREF(*aResult = proxy); return NS_OK; } inline nsresult NS_NewStreamProviderProxy(nsIStreamProvider **aResult, nsIStreamProvider *aProvider, nsIEventQueue *aEventQ=nsnull, PRUint32 aBufferSegmentSize=0, PRUint32 aBufferMaxSize=0) { NS_ENSURE_ARG_POINTER(aResult); nsresult rv; nsCOMPtr proxy; static NS_DEFINE_CID(kStreamProviderProxyCID, NS_STREAMPROVIDERPROXY_CID); rv = nsComponentManager::CreateInstance(kStreamProviderProxyCID, nsnull, NS_GET_IID(nsIStreamProviderProxy), getter_AddRefs(proxy)); if (NS_FAILED(rv)) return rv; rv = proxy->Init(aProvider, aEventQ, aBufferSegmentSize, aBufferMaxSize); if (NS_FAILED(rv)) return rv; NS_ADDREF(*aResult = proxy); return NS_OK; } inline nsresult NS_NewSimpleStreamListener(nsIStreamListener **aResult, nsIOutputStream *aSink, nsIRequestObserver *aObserver=nsnull) { NS_ENSURE_ARG_POINTER(aResult); nsresult rv; nsCOMPtr listener; static NS_DEFINE_CID(kSimpleStreamListenerCID, NS_SIMPLESTREAMLISTENER_CID); rv = nsComponentManager::CreateInstance(kSimpleStreamListenerCID, nsnull, NS_GET_IID(nsISimpleStreamListener), getter_AddRefs(listener)); if (NS_FAILED(rv)) return rv; rv = listener->Init(aSink, aObserver); if (NS_FAILED(rv)) return rv; NS_ADDREF(*aResult = listener); return NS_OK; } inline nsresult NS_NewSimpleStreamProvider(nsIStreamProvider **aResult, nsIInputStream *aSource, nsIRequestObserver *aObserver=nsnull) { NS_ENSURE_ARG_POINTER(aResult); nsresult rv; nsCOMPtr provider; static NS_DEFINE_CID(kSimpleStreamProviderCID, NS_SIMPLESTREAMPROVIDER_CID); rv = nsComponentManager::CreateInstance(kSimpleStreamProviderCID, nsnull, NS_GET_IID(nsISimpleStreamProvider), getter_AddRefs(provider)); if (NS_FAILED(rv)) return rv; rv = provider->Init(aSource, aObserver); if (NS_FAILED(rv)) return rv; NS_ADDREF(*aResult = provider); return NS_OK; } /* // Depracated, prefer NS_NewStreamObserverProxy inline nsresult NS_NewAsyncStreamObserver(nsIRequestObserver **result, nsIRequestObserver *receiver, nsIEventQueue *eventQueue) { nsresult rv; nsCOMPtr obs; static NS_DEFINE_CID(kAsyncStreamObserverCID, NS_ASYNCSTREAMOBSERVER_CID); rv = nsComponentManager::CreateInstance(kAsyncStreamObserverCID, nsnull, NS_GET_IID(nsIAsyncStreamObserver), getter_AddRefs(obs)); if (NS_FAILED(rv)) return rv; rv = obs->Init(receiver, eventQueue); if (NS_FAILED(rv)) return rv; NS_ADDREF(*result = obs); return NS_OK; } */ // Depracated, prefer NS_NewStreamListenerProxy inline nsresult NS_NewAsyncStreamListener(nsIStreamListener **result, nsIStreamListener *receiver, nsIEventQueue *eventQueue) { nsresult rv; nsCOMPtr lsnr; static NS_DEFINE_CID(kAsyncStreamListenerCID, NS_ASYNCSTREAMLISTENER_CID); rv = nsComponentManager::CreateInstance(kAsyncStreamListenerCID, nsnull, NS_GET_IID(nsIAsyncStreamListener), getter_AddRefs(lsnr)); if (NS_FAILED(rv)) return rv; rv = lsnr->Init(receiver, eventQueue); if (NS_FAILED(rv)) return rv; NS_ADDREF(*result = lsnr); return NS_OK; } // Depracated, prefer a true synchonous implementation inline nsresult NS_NewSyncStreamListener(nsIInputStream **aInStream, nsIOutputStream **aOutStream, nsIStreamListener **aResult) { nsresult rv; NS_ENSURE_ARG_POINTER(aInStream); NS_ENSURE_ARG_POINTER(aOutStream); nsCOMPtr pipeIn; nsCOMPtr pipeOut; rv = NS_NewPipe(getter_AddRefs(pipeIn), getter_AddRefs(pipeOut), 4*1024, // NS_SYNC_STREAM_LISTENER_SEGMENT_SIZE 32*1024); // NS_SYNC_STREAM_LISTENER_BUFFER_SIZE if (NS_FAILED(rv)) return rv; rv = NS_NewSimpleStreamListener(aResult, pipeOut); if (NS_FAILED(rv)) return rv; NS_ADDREF(*aInStream = pipeIn); NS_ADDREF(*aOutStream = pipeOut); return NS_OK; } // // Calls AsyncWrite on the specified transport, with a stream provider that // reads data from the specified input stream. // inline nsresult NS_AsyncWriteFromStream(nsIRequest **aRequest, nsITransport *aTransport, nsIInputStream *aSource, PRUint32 aOffset=0, PRUint32 aCount=0, PRUint32 aFlags=0, nsIRequestObserver *aObserver=NULL, nsISupports *aContext=NULL) { NS_ENSURE_ARG_POINTER(aTransport); nsresult rv; nsCOMPtr provider; rv = NS_NewSimpleStreamProvider(getter_AddRefs(provider), aSource, aObserver); if (NS_FAILED(rv)) return rv; // // We can safely allow the transport impl to bypass proxying the provider // since we are using a simple stream provider. // // A simple stream provider masks the OnDataWritable from consumers. // Moreover, it makes an assumption about the underlying nsIInputStream // implementation: namely, that it is thread-safe and blocking. // // So, let's always make this optimization. // aFlags |= nsITransport::DONT_PROXY_PROVIDER; return aTransport->AsyncWrite(provider, aContext, aOffset, aCount, aFlags, aRequest); } // // Calls AsyncRead on the specified transport, with a stream listener that // writes data to the specified output stream. // inline nsresult NS_AsyncReadToStream(nsIRequest **aRequest, nsITransport *aTransport, nsIOutputStream *aSink, PRUint32 aOffset=0, PRUint32 aCount=0, PRUint32 aFlags=0, nsIRequestObserver *aObserver=NULL, nsISupports *aContext=NULL) { NS_ENSURE_ARG_POINTER(aTransport); nsresult rv; nsCOMPtr listener; rv = NS_NewSimpleStreamListener(getter_AddRefs(listener), aSink, aObserver); if (NS_FAILED(rv)) return rv; return aTransport->AsyncRead(listener, aContext, aOffset, aCount, aFlags, aRequest); } inline nsresult NS_CheckPortSafety(PRInt32 port, const char* scheme, nsIIOService* ioService = nsnull) { nsresult rv; nsCOMPtr serv; if (ioService == nsnull) { serv = do_GetIOService(&rv); if (NS_FAILED(rv)) return rv; ioService = serv.get(); } PRBool allow; rv = ioService->AllowPort(port, scheme, &allow); if (NS_FAILED(rv)) { NS_ERROR("NS_CheckPortSafety: ioService->AllowPort failed\n"); return rv; } if (!allow) return NS_ERROR_PORT_ACCESS_NOT_ALLOWED; return NS_OK; } inline nsresult NS_NewProxyInfo(const char* type, const char* host, PRInt32 port, nsIProxyInfo* *result) { nsresult rv; static NS_DEFINE_CID(kPPSServiceCID, NS_PROTOCOLPROXYSERVICE_CID); nsCOMPtr pps = do_GetService(kPPSServiceCID,&rv); if (NS_FAILED(rv)) return rv; return pps->NewProxyInfo(type, host, port, result); } inline nsresult NS_InitFileFromURLSpec(nsIFile* aFile, const char *inURL, nsIIOService *ioService=nsnull) { nsCOMPtr serv; if (ioService == nsnull) { nsresult rv; serv = do_GetIOService(&rv); if (NS_FAILED(rv)) return rv; ioService = serv.get(); } return ioService->InitFileFromURLSpec(aFile, inURL); } inline nsresult NS_GetURLSpecFromFile(nsIFile* aFile, char **aUrl, nsIIOService *ioService=nsnull) { nsCOMPtr serv; if (ioService == nsnull) { nsresult rv; serv = do_GetIOService(&rv); if (NS_FAILED(rv)) return rv; ioService = serv.get(); } return ioService->GetURLSpecFromFile(aFile, aUrl); } #endif // nsNetUtil_h__