src/third_party/WebKit/Source/core/loader/PingLoader.h

   1 /*
   2  * Copyright (C) 2010 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
  32 #ifndef PingLoader_h
  33 #define PingLoader_h
  34
  35 #include "core/fetch/ResourceLoaderOptions.h"
  36 #include "core/page/PageLifecycleObserver.h"
  37 #include "platform/Timer.h"
  38 #include "public/platform/WebURLLoaderClient.h"
  39 #include "wtf/Noncopyable.h"
  40 #include "wtf/RefPtr.h"
  41
  42 namespace WebCore {
  43
  44 class FormData;
  45 class LocalFrame;
  46 class KURL;
  47 class ResourceError;
  48 class ResourceHandle;
  49 class ResourceRequest;
  50 class ResourceResponse;
  51
  52 // This class triggers asynchronous loads independent of LocalFrame staying alive (i.e., auditing pingbacks).
  53 // Since nothing depends on resources loaded through this class, we just want
  54 // to allow the load to live long enough to ensure the message was actually sent.
  55 // Therefore, as soon as a callback is received from the ResourceHandle, this class
  56 // will cancel the load and delete itself.
  57 class PingLoader FINAL : public PageLifecycleObserver, private blink::WebURLLoaderClient {
  58     WTF_MAKE_NONCOPYABLE(PingLoader); WTF_MAKE_FAST_ALLOCATED;
  59 public:
  60     enum ViolationReportType {
  61         ContentSecurityPolicyViolationReport,
  62         XSSAuditorViolationReport
  63     };
  64
  65     static void loadImage(LocalFrame*, const KURL& url);
  66     static void sendPing(LocalFrame*, const KURL& pingURL, const KURL& destinationURL);
  67     static void sendViolationReport(LocalFrame*, const KURL& reportURL, PassRefPtr<FormData> report, ViolationReportType);
  68
  69     virtual ~PingLoader();
  70
  71 private:
  72     PingLoader(LocalFrame*, ResourceRequest&, const FetchInitiatorInfo&, StoredCredentials);
  73
  74     static void start(LocalFrame*, ResourceRequest&, const FetchInitiatorInfo&, StoredCredentials = AllowStoredCredentials);
  75
  76     virtual void didReceiveResponse(blink::WebURLLoader*, const blink::WebURLResponse&) OVERRIDE;
  77     virtual void didReceiveData(blink::WebURLLoader*, const char*, int, int) OVERRIDE;
  78     virtual void didFinishLoading(blink::WebURLLoader*, double, int64_t) OVERRIDE;
  79     virtual void didFail(blink::WebURLLoader*, const blink::WebURLError&) OVERRIDE;
  80
  81     void timeout(Timer<PingLoader>*);
  82
  83     OwnPtr<blink::WebURLLoader> m_loader;
  84     Timer<PingLoader> m_timeout;
  85     String m_url;
  86     unsigned long m_identifier;
  87 };
  88
  89 }
  90
  91 #endif