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 blink {
  43
  44 class FormData;
  45 class LocalFrame;
  46 class KURL;
  47 class ResourceRequest;
  48
  49 // Issue an asynchronous, one-directional request at some resources, ignoring
  50 // any response. The request is made independent of any LocalFrame staying alive,
  51 // and must only stay alive until the transmission has completed successfully
  52 // (or not -- errors are not propagated back either.) Upon transmission, the
  53 // the load is cancelled and the loader cancels itself.
  54 //
  55 // The ping loader is used by audit pings, beacon transmissions and image loads
  56 // during page unloading.
  57 //
  58 class PingLoader : public PageLifecycleObserver, private blink::WebURLLoaderClient {
  59     WTF_MAKE_NONCOPYABLE(PingLoader);
  60     WTF_MAKE_FAST_ALLOCATED;
  61 public:
  62     virtual ~PingLoader();
  63
  64     enum ViolationReportType {
  65         ContentSecurityPolicyViolationReport,
  66         XSSAuditorViolationReport
  67     };
  68
  69     static void loadImage(LocalFrame*, const KURL& url);
  70     static void sendLinkAuditPing(LocalFrame*, const KURL& pingURL, const KURL& destinationURL);
  71     static void sendViolationReport(LocalFrame*, const KURL& reportURL, PassRefPtr<FormData> report, ViolationReportType);
  72
  73 protected:
  74     PingLoader(LocalFrame*, ResourceRequest&, const FetchInitiatorInfo&, StoredCredentials);
  75
  76     static void start(LocalFrame*, ResourceRequest&, const FetchInitiatorInfo&, StoredCredentials = AllowStoredCredentials);
  77
  78 private:
  79     virtual void didReceiveResponse(blink::WebURLLoader*, const blink::WebURLResponse&) OVERRIDE;
  80     virtual void didReceiveData(blink::WebURLLoader*, const char*, int, int) OVERRIDE;
  81     virtual void didFinishLoading(blink::WebURLLoader*, double, int64_t) OVERRIDE;
  82     virtual void didFail(blink::WebURLLoader*, const blink::WebURLError&) OVERRIDE;
  83
  84     void timeout(Timer<PingLoader>*);
  85
  86     OwnPtr<blink::WebURLLoader> m_loader;
  87     Timer<PingLoader> m_timeout;
  88     String m_url;
  89     unsigned long m_identifier;
  90 };
  91
  92 }
  93
  94 #endif // PingLoader_h