Add Prerenderer, PrerenderHandle and a chromium interface for Prerendering.
[WebKit-https.git] / Source / WebCore / loader / Prerenderer.cpp
1 /*
2  * Copyright (C) 2012 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 #include "config.h"
33 #include "Prerenderer.h"
34
35 #if ENABLE(LINK_PRERENDER)
36
37 #include "Document.h"
38 #include "Frame.h"
39 #include "FrameLoader.h"
40 #include "PrerenderHandle.h"
41 #include "PrerendererClient.h"
42 #include "ReferrerPolicy.h"
43 #include "SecurityPolicy.h"
44
45 #include <wtf/PassOwnPtr.h>
46 #include <wtf/PassRefPtr.h>
47 #include <wtf/RefPtr.h>
48 #include <wtf/text/WTFString.h>
49
50 namespace WebCore {
51
52 // static
53 PassOwnPtr<Prerenderer> Prerenderer::create(Document* document)
54 {
55     Prerenderer* prerenderer = new Prerenderer(document);
56     prerenderer->suspendIfNeeded();
57     return adoptPtr(prerenderer);
58 }
59
60 Prerenderer::Prerenderer(Document* document)
61     : ActiveDOMObject(document, this)
62     , m_client(0)
63 {
64 }
65
66 Prerenderer::~Prerenderer()
67 {
68 }
69
70 PassRefPtr<PrerenderHandle> Prerenderer::render(const KURL& url)
71 {
72     // Prerenders are unlike requests in most ways (for instance, they pass down fragments, and they don't return data),
73     // but they do have referrers.
74     const ReferrerPolicy referrerPolicy = document()->referrerPolicy();
75     const String referrer = SecurityPolicy::generateReferrerHeader(referrerPolicy, url, document()->frame()->loader()->outgoingReferrer());
76
77     RefPtr<PrerenderHandle> prerenderHandle = PrerenderHandle::create(url, referrer, referrerPolicy);
78
79     client()->willAddPrerender(prerenderHandle.get());
80     prerenderHandle->add();
81
82     m_activeHandles.append(prerenderHandle);
83     return prerenderHandle;
84 }
85
86 void Prerenderer::stop()
87 {
88     while (!m_activeHandles.isEmpty()) {
89         RefPtr<PrerenderHandle> handle = m_activeHandles[0].release();
90         m_activeHandles.remove(0);
91         handle->abandon();
92     }
93     while (!m_suspendedHandles.isEmpty()) {
94         RefPtr<PrerenderHandle> handle = m_suspendedHandles[0].release();
95         m_suspendedHandles.remove(0);
96         handle->abandon();
97     }
98 }
99
100 void Prerenderer::suspend(ReasonForSuspension reason)
101 {
102     if (reason == DocumentWillBecomeInactive || reason == PageWillBeSuspended) {
103         while (!m_activeHandles.isEmpty()) {
104             RefPtr<PrerenderHandle> handle = m_activeHandles[0].release();
105             m_activeHandles.remove(0);
106             handle->suspend();
107             m_suspendedHandles.append(handle);
108         }
109     }
110 }
111
112 void Prerenderer::resume()
113 {
114     while (!m_suspendedHandles.isEmpty()) {
115         RefPtr<PrerenderHandle> handle = m_suspendedHandles[0].release();
116         m_suspendedHandles.remove(0);
117         handle->resume();
118         m_activeHandles.append(handle);
119     }
120 }
121
122 Document* Prerenderer::document()
123 {
124     ASSERT(scriptExecutionContext()->isDocument());
125     return static_cast<Document*>(scriptExecutionContext());
126 }
127
128 PrerendererClient* Prerenderer::client()
129 {
130     if (!m_client)
131         m_client = PrerendererClient::from(document()->page());
132     return m_client;
133 }
134
135 }
136
137 #endif // ENABLE(LINK_PRERENDER)