Source/WebCore/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 "ResourceHandleClient.h"
  36 #include "Timer.h"
  37 #include <wtf/Noncopyable.h>
  38 #include <wtf/RefPtr.h>
  39
  40 namespace WebCore {
  41
  42 class FormData;
  43 class Frame;
  44 class URL;
  45 class ResourceError;
  46 class ResourceHandle;
  47 class ResourceResponse;
  48
  49 // This class triggers asynchronous loads independent of Frame staying alive (i.e., auditing pingbacks).
  50 // Since nothing depends on resources loaded through this class, we just want
  51 // to allow the load to live long enough to ensure the message was actually sent.
  52 // Therefore, as soon as a callback is received from the ResourceHandle, this class
  53 // will cancel the load and delete itself.
  54 class PingLoader : private ResourceHandleClient {
  55     WTF_MAKE_NONCOPYABLE(PingLoader); WTF_MAKE_FAST_ALLOCATED;
  56 public:
  57     static void loadImage(Frame*, const URL& url);
  58     static void sendPing(Frame*, const URL& pingURL, const URL& destinationURL);
  59     static void sendViolationReport(Frame*, const URL& reportURL, PassRefPtr<FormData> report);
  60
  61     virtual ~PingLoader();
  62
  63 private:
  64     static void createPingLoader(Frame*, ResourceRequest&);
  65     PingLoader(Frame*, ResourceRequest&);
  66
  67     virtual void didReceiveResponse(ResourceHandle*, const ResourceResponse&) OVERRIDE { delete this; }
  68     virtual void didReceiveData(ResourceHandle*, const char*, int, int) OVERRIDE { delete this; }
  69     virtual void didFinishLoading(ResourceHandle*, double) OVERRIDE { delete this; }
  70     virtual void didFail(ResourceHandle*, const ResourceError&) OVERRIDE { delete this; }
  71     virtual bool shouldUseCredentialStorage(ResourceHandle*)  OVERRIDE { return m_shouldUseCredentialStorage; }
  72     void timeout(Timer<PingLoader>*) { delete this; }
  73
  74     RefPtr<ResourceHandle> m_handle;
  75     Timer<PingLoader> m_timeout;
  76     bool m_shouldUseCredentialStorage;
  77 };
  78
  79 }
  80
  81 #endif