1 /* 2 * Copyright (C) 2006 Apple Computer, Inc. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 1. Redistributions of source code must retain the above copyright 8 * notice, this list of conditions and the following disclaimer. 9 * 2. Redistributions in binary form must reproduce the above copyright 10 * notice, this list of conditions and the following disclaimer in the 11 * documentation and/or other materials provided with the distribution. 12 * 13 * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY 14 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 16 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE COMPUTER, INC. OR 17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 18 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 19 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 20 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY 21 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 23 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 24 */ 25 26 #ifndef ResourceHandleClient_h 27 #define ResourceHandleClient_h 28 29 #include <wtf/CurrentTime.h> 30 #include <wtf/RefCounted.h> 31 #include <wtf/RefPtr.h> 32 33 #if USE(CFNETWORK) 34 #include <CFNetwork/CFURLCachePriv.h> 35 #include <CFNetwork/CFURLResponsePriv.h> 36 #endif 37 38 #if PLATFORM(WIN) && USE(CFNETWORK) 39 #include <ConditionalMacros.h> 40 #endif 41 42 #if PLATFORM(MAC) 43 #ifdef __OBJC__ 44 @class NSCachedURLResponse; 45 #else 46 class NSCachedURLResponse; 47 #endif 48 #endif 49 50 namespace WebCore { 51 class AsyncFileStream; 52 class AuthenticationChallenge; 53 class Credential; 54 class FileStreamClient; 55 class KURL; 56 class ProtectionSpace; 57 class ResourceHandle; 58 class ResourceError; 59 class ResourceRequest; 60 class ResourceResponse; 61 62 enum CacheStoragePolicy { 63 StorageAllowed, 64 StorageAllowedInMemoryOnly, 65 StorageNotAllowed 66 }; 67 68 class ResourceHandleClient { 69 public: ~ResourceHandleClient()70 virtual ~ResourceHandleClient() { } 71 72 // request may be modified willSendRequest(ResourceHandle *,ResourceRequest &,const ResourceResponse &)73 virtual void willSendRequest(ResourceHandle*, ResourceRequest&, const ResourceResponse& /*redirectResponse*/) { } didSendData(ResourceHandle *,unsigned long long,unsigned long long)74 virtual void didSendData(ResourceHandle*, unsigned long long /*bytesSent*/, unsigned long long /*totalBytesToBeSent*/) { } 75 didReceiveResponse(ResourceHandle *,const ResourceResponse &)76 virtual void didReceiveResponse(ResourceHandle*, const ResourceResponse&) { } didReceiveData(ResourceHandle *,const char *,int,int)77 virtual void didReceiveData(ResourceHandle*, const char*, int, int /*encodedDataLength*/) { } didReceiveCachedMetadata(ResourceHandle *,const char *,int)78 virtual void didReceiveCachedMetadata(ResourceHandle*, const char*, int) { } didFinishLoading(ResourceHandle *,double)79 virtual void didFinishLoading(ResourceHandle*, double /*finishTime*/) { } didFail(ResourceHandle *,const ResourceError &)80 virtual void didFail(ResourceHandle*, const ResourceError&) { } wasBlocked(ResourceHandle *)81 virtual void wasBlocked(ResourceHandle*) { } cannotShowURL(ResourceHandle *)82 virtual void cannotShowURL(ResourceHandle*) { } 83 84 #if HAVE(CFNETWORK_DATA_ARRAY_CALLBACK) supportsDataArray()85 virtual bool supportsDataArray() { return false; } didReceiveDataArray(ResourceHandle *,CFArrayRef)86 virtual void didReceiveDataArray(ResourceHandle*, CFArrayRef) { } 87 #endif 88 willCacheResponse(ResourceHandle *,CacheStoragePolicy &)89 virtual void willCacheResponse(ResourceHandle*, CacheStoragePolicy&) { } 90 shouldUseCredentialStorage(ResourceHandle *)91 virtual bool shouldUseCredentialStorage(ResourceHandle*) { return false; } didReceiveAuthenticationChallenge(ResourceHandle *,const AuthenticationChallenge &)92 virtual void didReceiveAuthenticationChallenge(ResourceHandle*, const AuthenticationChallenge&) { } didCancelAuthenticationChallenge(ResourceHandle *,const AuthenticationChallenge &)93 virtual void didCancelAuthenticationChallenge(ResourceHandle*, const AuthenticationChallenge&) { } 94 #if USE(PROTECTION_SPACE_AUTH_CALLBACK) canAuthenticateAgainstProtectionSpace(ResourceHandle *,const ProtectionSpace &)95 virtual bool canAuthenticateAgainstProtectionSpace(ResourceHandle*, const ProtectionSpace&) { return false; } 96 #endif receivedCancellation(ResourceHandle *,const AuthenticationChallenge &)97 virtual void receivedCancellation(ResourceHandle*, const AuthenticationChallenge&) { } 98 99 #if PLATFORM(MAC) 100 #if USE(CFNETWORK) willCacheResponse(ResourceHandle *,CFCachedURLResponseRef response)101 virtual CFCachedURLResponseRef willCacheResponse(ResourceHandle*, CFCachedURLResponseRef response) { return response; } 102 #else willCacheResponse(ResourceHandle *,NSCachedURLResponse * response)103 virtual NSCachedURLResponse* willCacheResponse(ResourceHandle*, NSCachedURLResponse* response) { return response; } 104 #endif willStopBufferingData(ResourceHandle *,const char *,int)105 virtual void willStopBufferingData(ResourceHandle*, const char*, int) { } 106 #endif // PLATFORM(MAC) 107 #if PLATFORM(WIN) && USE(CFNETWORK) shouldCacheResponse(ResourceHandle *,CFCachedURLResponseRef)108 virtual bool shouldCacheResponse(ResourceHandle*, CFCachedURLResponseRef) { return true; } 109 #endif 110 #if ENABLE(BLOB) createAsyncFileStream(FileStreamClient *)111 virtual AsyncFileStream* createAsyncFileStream(FileStreamClient*) { return 0; } 112 #endif 113 }; 114 115 } 116 117 #endif 118