third_party/WebKit/Source/core/fetch/FetchContext.h

   1 /*
   2  * Copyright (C) 2013 Google 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 are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef FetchContext_h
  32 #define FetchContext_h
  33
  34 #include "core/CoreExport.h"
  35 #include "core/fetch/CachePolicy.h"
  36 #include "core/fetch/FetchInitiatorInfo.h"
  37 #include "core/fetch/FetchRequest.h"
  38 #include "core/fetch/Resource.h"
  39 #include "platform/heap/Handle.h"
  40 #include "platform/network/ResourceLoadPriority.h"
  41 #include "wtf/Noncopyable.h"
  42
  43 namespace blink {
  44
  45 class KURL;
  46 class ResourceError;
  47 class ResourceLoader;
  48 class ResourceResponse;
  49 class ResourceRequest;
  50 class ResourceTimingInfo;
  51
  52 enum FetchResourceType {
  53     FetchMainResource,
  54     FetchSubresource
  55 };
  56
  57 class CORE_EXPORT FetchContext : public GarbageCollectedFinalized<FetchContext> {
  58     WTF_MAKE_NONCOPYABLE(FetchContext);
  59 public:
  60     static FetchContext& nullInstance();
  61
  62     virtual ~FetchContext() { }
  63     DEFINE_INLINE_VIRTUAL_TRACE() { }
  64
  65     virtual bool isLiveContext() { return false; }
  66     virtual void countClientHintsDPR() { }
  67     virtual void countClientHintsResourceWidth() { }
  68     virtual void countClientHintsViewportWidth() { }
  69
  70     virtual void addAdditionalRequestHeaders(ResourceRequest&, FetchResourceType);
  71     virtual void setFirstPartyForCookies(ResourceRequest&);
  72     virtual CachePolicy cachePolicy() const;
  73     virtual ResourceRequestCachePolicy resourceRequestCachePolicy(const ResourceRequest&, Resource::Type) const;
  74
  75     virtual void dispatchDidChangeResourcePriority(unsigned long identifier, ResourceLoadPriority, int intraPriorityValue);
  76     virtual void dispatchWillSendRequest(unsigned long identifier, ResourceRequest&, const ResourceResponse& redirectResponse, const FetchInitiatorInfo& = FetchInitiatorInfo());
  77     virtual void dispatchDidLoadResourceFromMemoryCache(const Resource*);
  78     virtual void dispatchDidReceiveResponse(unsigned long identifier, const ResourceResponse&, ResourceLoader* = 0);
  79     virtual void dispatchDidReceiveData(unsigned long identifier, const char* data, int dataLength, int encodedDataLength);
  80     virtual void dispatchDidDownloadData(unsigned long identifier, int dataLength, int encodedDataLength);
  81     virtual void dispatchDidFinishLoading(unsigned long identifier, double finishTime, int64_t encodedDataLength);
  82     virtual void dispatchDidFail(unsigned long identifier, const ResourceError&, bool isInternalRequest);
  83
  84     virtual bool shouldLoadNewResource(Resource::Type) const { return false; }
  85     virtual void willStartLoadingResource(ResourceRequest&);
  86     virtual void didLoadResource();
  87
  88     virtual void addResourceTiming(const ResourceTimingInfo&);
  89     virtual bool allowImage(bool, const KURL&) const { return false; }
  90     virtual bool canRequest(Resource::Type, const ResourceRequest&, const KURL&, const ResourceLoaderOptions&, bool forPreload, FetchRequest::OriginRestriction) const { return false; }
  91
  92     virtual bool isControlledByServiceWorker() const { return false; }
  93     virtual int64_t serviceWorkerID() const { return -1; }
  94
  95     virtual bool isMainFrame() const { return true; }
  96     virtual bool defersLoading() const { return false; }
  97     virtual bool isLoadComplete() const { return false; }
  98     virtual bool pageDismissalEventBeingDispatched() const { return false; }
  99     virtual bool updateTimingInfoForIFrameNavigation(ResourceTimingInfo*) { return false; }
 100     virtual void sendImagePing(const KURL&);
 101     virtual void addConsoleMessage(const String&) const;
 102     virtual SecurityOrigin* securityOrigin() const { return nullptr; }
 103     virtual void upgradeInsecureRequest(FetchRequest&);
 104     virtual void addClientHintsIfNecessary(FetchRequest&);
 105     virtual void addCSPHeaderIfNecessary(Resource::Type, FetchRequest&);
 106
 107     virtual bool fetchIncreasePriorities() const { return false; }
 108     virtual ResourceLoadPriority modifyPriorityForExperiments(ResourceLoadPriority priority, Resource::Type, const FetchRequest&) { return priority; }
 109
 110 protected:
 111     FetchContext() { }
 112 };
 113
 114 }
 115
 116 #endif