src/third_party/WebKit/Source/core/loader/PrerenderHandle.cpp

   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 #include "config.h"
  32 #include "core/loader/PrerenderHandle.h"
  33
  34 #include "core/dom/Document.h"
  35 #include "core/frame/Frame.h"
  36 #include "core/loader/FrameLoader.h"
  37 #include "core/loader/PrerendererClient.h"
  38 #include "platform/Prerender.h"
  39 #include "platform/weborigin/ReferrerPolicy.h"
  40 #include "platform/weborigin/SecurityPolicy.h"
  41
  42 namespace WebCore {
  43
  44 // static
  45 PassOwnPtr<PrerenderHandle> PrerenderHandle::create(Document& document, PrerenderClient* client, const KURL& url, const unsigned prerenderRelTypes)
  46 {
  47     // Prerenders are unlike requests in most ways (for instance, they pass down fragments, and they don't return data),
  48     // but they do have referrers.
  49     const ReferrerPolicy referrerPolicy = document.referrerPolicy();
  50
  51     if (!document.frame())
  52         return PassOwnPtr<PrerenderHandle>();
  53
  54     const String referrer = SecurityPolicy::generateReferrerHeader(referrerPolicy, url, document.outgoingReferrer());
  55
  56     RefPtr<Prerender> prerender = Prerender::create(client, url, prerenderRelTypes, referrer, referrerPolicy);
  57
  58     PrerendererClient* prerendererClient = PrerendererClient::from(document.page());
  59     if (prerendererClient)
  60         prerendererClient->willAddPrerender(prerender.get());
  61     prerender->add();
  62
  63     return adoptPtr(new PrerenderHandle(document, prerender.release()));
  64 }
  65
  66 PrerenderHandle::PrerenderHandle(Document& document, PassRefPtr<Prerender> prerender)
  67     : DocumentLifecycleObserver(&document)
  68     , m_prerender(prerender)
  69 {
  70 }
  71
  72 PrerenderHandle::~PrerenderHandle()
  73 {
  74     if (m_prerender)
  75         detach();
  76 }
  77
  78 void PrerenderHandle::cancel()
  79 {
  80     // Avoid both abandoning and canceling the same prerender. In the abandon case, the LinkLoader cancels the
  81     // PrerenderHandle as the Document is destroyed, even through the DocumentLifecycleObserver has already abandoned
  82     // it.
  83     if (!m_prerender)
  84         return;
  85     m_prerender->cancel();
  86     detach();
  87 }
  88
  89 const KURL& PrerenderHandle::url() const
  90 {
  91     return m_prerender->url();
  92 }
  93
  94 void PrerenderHandle::documentWasDetached()
  95 {
  96     ASSERT(m_prerender);
  97     m_prerender->abandon();
  98     detach();
  99 }
 100
 101
 102 void PrerenderHandle::detach()
 103 {
 104     m_prerender->removeClient();
 105     m_prerender.clear();
 106 }
 107
 108 }