third_party/blink/renderer/core/loader/private/prerender_handle.cc

/*
 * Copyright (C) 2013 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#include "third_party/blink/renderer/core/loader/private/prerender_handle.h"

#include "services/network/public/mojom/referrer_policy.mojom-blink.h"
#include "third_party/blink/public/common/browser_interface_broker_proxy.h"
#include "third_party/blink/renderer/core/dom/document.h"
#include "third_party/blink/renderer/core/frame/local_frame.h"
#include "third_party/blink/renderer/core/frame/local_frame_client.h"
#include "third_party/blink/renderer/core/loader/private/prerender_client.h"
#include "third_party/blink/renderer/platform/heap/heap.h"
#include "third_party/blink/renderer/platform/weborigin/security_policy.h"

namespace blink {

// static
PrerenderHandle* PrerenderHandle::Create(Document& document,
                                         PrerenderClient* client,
                                         const KURL& url,
                                         const unsigned prerender_rel_types) {
  // Prerenders are unlike requests in most ways (for instance, they pass down
  // fragments, and they don't return data), but they do have referrers.

  if (!document.GetFrame())
    return nullptr;

  ExecutionContext* context = document.GetExecutionContext();
  Referrer referrer = SecurityPolicy::GenerateReferrer(
      context->GetReferrerPolicy(), url, context->OutgoingReferrer());

  mojom::blink::PrerenderAttributesPtr attributes =
      mojom::blink::PrerenderAttributes::New();
  attributes->url = url;
  attributes->rel_types = prerender_rel_types;
  attributes->referrer = mojom::blink::Referrer::New(
      KURL(NullURL(), referrer.referrer), referrer.referrer_policy);
  attributes->initiator_origin = context->GetSecurityOrigin();
  attributes->view_size =
      gfx::Size(document.GetFrame()->GetMainFrameViewportSize());

  mojo::Remote<mojom::blink::PrerenderProcessor> prerender_processor;
  context->GetBrowserInterfaceBroker().GetInterface(
      prerender_processor.BindNewPipeAndPassReceiver());

  mojo::PendingRemote<mojom::blink::PrerenderHandleClient>
      prerender_handle_client;
  auto receiver = prerender_handle_client.InitWithNewPipeAndPassReceiver();

  HeapMojoRemote<mojom::blink::PrerenderHandle,
                 HeapMojoWrapperMode::kForceWithoutContextObserver>
      remote_handle(context);
  prerender_processor->AddPrerender(
      std::move(attributes), std::move(prerender_handle_client),
      remote_handle.BindNewPipeAndPassReceiver(
          context->GetTaskRunner(TaskType::kMiscPlatformAPI)));

  return MakeGarbageCollected<PrerenderHandle>(PassKey(), context, client, url,
                                               std::move(remote_handle),
                                               std::move(receiver));
}

PrerenderHandle::PrerenderHandle(
    PassKey pass_key,
    ExecutionContext* context,
    PrerenderClient* client,
    const KURL& url,
    HeapMojoRemote<mojom::blink::PrerenderHandle,
                   HeapMojoWrapperMode::kForceWithoutContextObserver>
        remote_handle,
    mojo::PendingReceiver<mojom::blink::PrerenderHandleClient> receiver)
    : ExecutionContextLifecycleObserver(context),
      url_(url),
      client_(client),
      remote_handle_(std::move(remote_handle)),
      receiver_(this, context) {
  receiver_.Bind(std::move(receiver),
                 context->GetTaskRunner(TaskType::kMiscPlatformAPI));
}

PrerenderHandle::~PrerenderHandle() = default;

void PrerenderHandle::Dispose() {
  if (remote_handle_.is_bound())
    remote_handle_->Abandon();
  Detach();
}

void PrerenderHandle::Cancel() {
  // Avoid both abandoning and canceling the same prerender. In the abandon
  // case, the LinkLoader cancels the PrerenderHandle as the Document is
  // destroyed, even through the ExecutionContextLifecycleObserver has already
  // abandoned it.
  if (remote_handle_.is_bound())
    remote_handle_->Cancel();
  Detach();
}

const KURL& PrerenderHandle::Url() const {
  return url_;
}

void PrerenderHandle::ContextDestroyed() {
  // A PrerenderHandle is not removed from LifecycleNotifier::m_observers until
  // the next GC runs. Thus contextDestroyed() can be called for a
  // PrerenderHandle that is already cancelled (and thus detached). In that
  // case, we should not detach the PrerenderHandle again.
  Dispose();
}

void PrerenderHandle::OnPrerenderStart() {
  if (client_)
    client_->DidStartPrerender();
}

void PrerenderHandle::OnPrerenderStopLoading() {
  if (client_)
    client_->DidSendLoadForPrerender();
}

void PrerenderHandle::OnPrerenderDomContentLoaded() {
  if (client_)
    client_->DidSendDOMContentLoadedForPrerender();
}

void PrerenderHandle::OnPrerenderStop() {
  if (client_)
    client_->DidStopPrerender();
}

void PrerenderHandle::Trace(Visitor* visitor) const {
  visitor->Trace(client_);
  visitor->Trace(remote_handle_);
  visitor->Trace(receiver_);
  ExecutionContextLifecycleObserver::Trace(visitor);
}

void PrerenderHandle::Detach() {
  remote_handle_.reset();
  receiver_.reset();
}

}  // namespace blink