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 <ConditionalMacros.h> 35 #include <CFNetwork/CFURLCachePriv.h> 36 #include <CFNetwork/CFURLResponsePriv.h> 37 #endif 38 39 #if PLATFORM(MAC) 40 #ifdef __OBJC__ 41 @class NSCachedURLResponse; 42 #else 43 class NSCachedURLResponse; 44 #endif 45 #endif 46 47 namespace WebCore { 48 class AsyncFileStream; 49 class AuthenticationChallenge; 50 class Credential; 51 class FileStreamClient; 52 class KURL; 53 class ProtectionSpace; 54 class ResourceHandle; 55 class ResourceError; 56 class ResourceRequest; 57 class ResourceResponse; 58 59 enum CacheStoragePolicy { 60 StorageAllowed, 61 StorageAllowedInMemoryOnly, 62 StorageNotAllowed 63 }; 64 65 class ResourceHandleClient { 66 public: ~ResourceHandleClient()67 virtual ~ResourceHandleClient() { } 68 69 // request may be modified willSendRequest(ResourceHandle *,ResourceRequest &,const ResourceResponse &)70 virtual void willSendRequest(ResourceHandle*, ResourceRequest&, const ResourceResponse& /*redirectResponse*/) { } didSendData(ResourceHandle *,unsigned long long,unsigned long long)71 virtual void didSendData(ResourceHandle*, unsigned long long /*bytesSent*/, unsigned long long /*totalBytesToBeSent*/) { } 72 didReceiveResponse(ResourceHandle *,const ResourceResponse &)73 virtual void didReceiveResponse(ResourceHandle*, const ResourceResponse&) { } didReceiveData(ResourceHandle *,const char *,int,int)74 virtual void didReceiveData(ResourceHandle*, const char*, int, int /*encodedDataLength*/) { } didReceiveCachedMetadata(ResourceHandle *,const char *,int)75 virtual void didReceiveCachedMetadata(ResourceHandle*, const char*, int) { } didFinishLoading(ResourceHandle *,double)76 virtual void didFinishLoading(ResourceHandle*, double /*finishTime*/) { } didFail(ResourceHandle *,const ResourceError &)77 virtual void didFail(ResourceHandle*, const ResourceError&) { } wasBlocked(ResourceHandle *)78 virtual void wasBlocked(ResourceHandle*) { } cannotShowURL(ResourceHandle *)79 virtual void cannotShowURL(ResourceHandle*) { } 80 81 #if HAVE(CFNETWORK_DATA_ARRAY_CALLBACK) supportsDataArray()82 virtual bool supportsDataArray() { return false; } didReceiveDataArray(ResourceHandle *,CFArrayRef)83 virtual void didReceiveDataArray(ResourceHandle*, CFArrayRef) { } 84 #endif 85 willCacheResponse(ResourceHandle *,CacheStoragePolicy &)86 virtual void willCacheResponse(ResourceHandle*, CacheStoragePolicy&) { } 87 shouldUseCredentialStorage(ResourceHandle *)88 virtual bool shouldUseCredentialStorage(ResourceHandle*) { return false; } didReceiveAuthenticationChallenge(ResourceHandle *,const AuthenticationChallenge &)89 virtual void didReceiveAuthenticationChallenge(ResourceHandle*, const AuthenticationChallenge&) { } didCancelAuthenticationChallenge(ResourceHandle *,const AuthenticationChallenge &)90 virtual void didCancelAuthenticationChallenge(ResourceHandle*, const AuthenticationChallenge&) { } 91 #if USE(PROTECTION_SPACE_AUTH_CALLBACK) canAuthenticateAgainstProtectionSpace(ResourceHandle *,const ProtectionSpace &)92 virtual bool canAuthenticateAgainstProtectionSpace(ResourceHandle*, const ProtectionSpace&) { return false; } 93 #endif receivedCancellation(ResourceHandle *,const AuthenticationChallenge &)94 virtual void receivedCancellation(ResourceHandle*, const AuthenticationChallenge&) { } 95 96 #if PLATFORM(MAC) willCacheResponse(ResourceHandle *,NSCachedURLResponse * response)97 virtual NSCachedURLResponse* willCacheResponse(ResourceHandle*, NSCachedURLResponse* response) { return response; } willStopBufferingData(ResourceHandle *,const char *,int)98 virtual void willStopBufferingData(ResourceHandle*, const char*, int) { } 99 #endif 100 #if USE(CFNETWORK) shouldCacheResponse(ResourceHandle *,CFCachedURLResponseRef response)101 virtual bool shouldCacheResponse(ResourceHandle*, CFCachedURLResponseRef response) { return true; } 102 #endif 103 #if ENABLE(BLOB) createAsyncFileStream(FileStreamClient *)104 virtual AsyncFileStream* createAsyncFileStream(FileStreamClient*) { return 0; } 105 #endif 106 }; 107 108 } 109 110 #endif 111