Files
tubestation/widget/nsDragServiceProxy.cpp
David P e844cdeed5 Bug 1893119: Part 21 - Separate nsIDragService and nsIDragSession implementations r=gstoll,geckoview-reviewers,rkraesig,win-reviewers,m_kato
Split the class inheritance trees for nsIDragService and nsIDragSession.
Remember that, before the start of this patch series, the inheritance
diagram was:

nsDragService -> nsBaseDragService -> nsIDragService + nsIDragSession

and the only instance was a singleton.  We switched it to:

nsDragService -> nsDragSession -> nsBaseDragService -> nsIDragService + nsBaseDragSession -> nsIDragSession

and maintained the singleton.  This allowed us to allow us to move things to
the new classes without breaking behavior.  We are done with that,
so we can now change the inheritance to its final form:

nsDragService -> nsBaseDragService -> nsIDragService

nsDragSession -> nsBaseDragSession -> nsIDragSession

Of course, we also need to properly construct and release the
nsIDragSessions (formerly part of the singleton), so that is done here as
well.  That happens in nsBaseDrag[Service|Session] for parent process drags
and in nsDrag[Service|Session]Proxy for content.  This is all fairly
straightforward, except in the case of gtk, where we need to change
some callback behavior.

Differential Revision: https://phabricator.services.mozilla.com/D211084
2024-07-04 07:48:11 +00:00

203 lines
7.0 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "nsDragServiceProxy.h"
#include "mozilla/dom/Document.h"
#include "mozilla/dom/BrowserChild.h"
#include "mozilla/gfx/2D.h"
#include "mozilla/net/CookieJarSettings.h"
#include "mozilla/UniquePtr.h"
#include "mozilla/Unused.h"
#include "nsContentUtils.h"
using mozilla::CSSIntRegion;
using mozilla::LayoutDeviceIntRect;
using mozilla::Maybe;
using mozilla::Nothing;
using mozilla::Some;
using mozilla::dom::BrowserChild;
using mozilla::gfx::DataSourceSurface;
using mozilla::gfx::SourceSurface;
using mozilla::gfx::SurfaceFormat;
using mozilla::ipc::Shmem;
nsDragServiceProxy::~nsDragServiceProxy() = default;
nsDragSessionProxy::~nsDragSessionProxy() = default;
already_AddRefed<nsIDragSession> nsDragServiceProxy::CreateDragSession() {
RefPtr<nsIDragSession> session = new nsDragSessionProxy();
return session.forget();
}
nsresult nsDragSessionProxy::InvokeDragSession(
nsIWidget* aWidget, nsINode* aDOMNode, nsIPrincipal* aPrincipal,
nsIContentSecurityPolicy* aCsp, nsICookieJarSettings* aCookieJarSettings,
nsIArray* aTransferableArray, uint32_t aActionType,
nsContentPolicyType aContentPolicyType) {
BrowserChild* sourceBrowser = aWidget->GetOwningBrowserChild();
NS_ENSURE_TRUE(sourceBrowser, NS_ERROR_INVALID_ARG);
[[maybe_unused]] RefPtr<nsIDragSession> sourceSession =
sourceBrowser->GetDragSession();
MOZ_ASSERT(!sourceSession);
nsresult rv = nsBaseDragSession::InvokeDragSession(aWidget, aDOMNode,
aPrincipal, aCsp, aCookieJarSettings, aTransferableArray, aActionType,
aContentPolicyType);
if (NS_SUCCEEDED(rv)) {
MOZ_ALWAYS_SUCCEEDS(sourceBrowser->GetWeakReference(getter_AddRefs(mSourceBrowser)));
sourceBrowser->SetDragSession(this);
}
return rv;
}
nsresult nsDragSessionProxy::InvokeDragSessionImpl(
nsIWidget* aWidget, nsIArray* aArrayTransferables,
const Maybe<CSSIntRegion>& aRegion, uint32_t aActionType) {
NS_ENSURE_STATE(mSourceDocument->GetDocShell());
BrowserChild* child = BrowserChild::GetFrom(mSourceDocument->GetDocShell());
NS_ENSURE_STATE(child);
nsTArray<mozilla::dom::IPCTransferableData> transferables;
nsContentUtils::TransferablesToIPCTransferableDatas(
aArrayTransferables, transferables, false, nullptr);
nsCOMPtr<nsIPrincipal> principal;
if (mSourceNode) {
principal = mSourceNode->NodePrincipal();
}
nsCOMPtr<nsIContentSecurityPolicy> csp;
if (mSourceDocument) {
csp = mSourceDocument->GetCsp();
// XXX why do we need this here? Shouldn't they be set properly in
// nsBaseDragService already?
mSourceWindowContext = mSourceDocument->GetWindowContext();
mSourceTopWindowContext = mSourceWindowContext
? mSourceWindowContext->TopWindowContext()
: nullptr;
}
nsCOMPtr<nsICookieJarSettings> cookieJarSettings;
cookieJarSettings = mSourceDocument->CookieJarSettings();
mozilla::net::CookieJarSettingsArgs csArgs;
mozilla::net::CookieJarSettings::Cast(cookieJarSettings)->Serialize(csArgs);
LayoutDeviceIntRect dragRect;
if (mHasImage || mSelection) {
nsPresContext* pc;
RefPtr<SourceSurface> surface;
DrawDrag(mSourceNode, aRegion, mScreenPosition, &dragRect, &surface, &pc);
if (surface) {
RefPtr<DataSourceSurface> dataSurface = surface->GetDataSurface();
if (dataSurface) {
size_t length;
int32_t stride;
auto surfaceData =
nsContentUtils::GetSurfaceData(*dataSurface, &length, &stride);
if (surfaceData.isNothing()) {
NS_WARNING("Failed to create shared memory for drag session.");
return NS_ERROR_FAILURE;
}
mozilla::Unused << child->SendInvokeDragSession(
std::move(transferables), aActionType, std::move(surfaceData),
stride, dataSurface->GetFormat(), dragRect, principal, csp, csArgs,
mSourceWindowContext, mSourceTopWindowContext);
return NS_OK;
}
}
}
mozilla::Unused << child->SendInvokeDragSession(
std::move(transferables), aActionType, Nothing(), 0,
static_cast<SurfaceFormat>(0), dragRect, principal, csp, csArgs,
mSourceWindowContext, mSourceTopWindowContext);
return NS_OK;
}
NS_IMETHODIMP
nsDragServiceProxy::StartDragSession(nsISupports* aWidgetProvider) {
nsIWidget* widget = GetWidgetFromWidgetProvider(aWidgetProvider);
NS_ENSURE_TRUE(widget, NS_ERROR_INVALID_ARG);
BrowserChild* targetBrowser = widget->GetOwningBrowserChild();
NS_ENSURE_TRUE(targetBrowser, NS_ERROR_INVALID_ARG);
RefPtr<nsIDragSession> session = targetBrowser->GetDragSession();
if (session) {
// session already exists on the browser
return NS_OK;
}
session = CreateDragSession();
MOZ_ASSERT(session);
static_cast<nsDragSessionProxy*>(session.get())->SetDragTarget(targetBrowser);
targetBrowser->SetDragSession(session);
return NS_OK;
}
NS_IMETHODIMP
nsDragServiceProxy::GetCurrentSession(nsISupports* aWidgetProvider,
nsIDragSession** aSession) {
if (!aSession) {
return NS_ERROR_INVALID_ARG;
}
*aSession = nullptr;
nsIWidget* widget = GetWidgetFromWidgetProvider(aWidgetProvider);
NS_ENSURE_TRUE(widget, NS_ERROR_INVALID_ARG);
BrowserChild* browser = widget->GetOwningBrowserChild();
NS_ENSURE_TRUE(browser, NS_ERROR_INVALID_ARG);
RefPtr<nsIDragSession> session = browser->GetDragSession();
if (!mSuppressLevel && session) {
session.forget(aSession);
}
return NS_OK;
}
void nsDragSessionProxy::SetDragTarget(BrowserChild* aTarget) {
if (!aTarget) {
if (mTargetBrowser) {
nsCOMPtr<BrowserChild> targetBC = do_QueryReferent(mTargetBrowser);
MOZ_ASSERT(targetBC);
if (targetBC) {
targetBC->SetDragSession(nullptr);
}
mTargetBrowser = nullptr;
}
return;
}
[[maybe_unused]] RefPtr<nsIDragSession> session =
aTarget->GetDragSession();
MOZ_ASSERT(!session);
MOZ_ALWAYS_SUCCEEDS(aTarget->GetWeakReference(getter_AddRefs(mTargetBrowser)));
}
nsresult nsDragSessionProxy::EndDragSessionImpl(bool aDoneDrag,
uint32_t aKeyModifiers) {
if (mSourceBrowser) {
nsCOMPtr<BrowserChild> sourceBC = do_QueryReferent(mSourceBrowser);
MOZ_ASSERT(sourceBC);
[[maybe_unused]] RefPtr<nsIDragSession> session =
sourceBC->GetDragSession();
MOZ_ASSERT(session == this);
sourceBC->SetDragSession(nullptr);
mSourceBrowser = nullptr;
}
if (mTargetBrowser) {
nsCOMPtr<BrowserChild> targetBC = do_QueryReferent(mTargetBrowser);
MOZ_ASSERT(targetBC);
[[maybe_unused]] RefPtr<nsIDragSession> session =
targetBC->GetDragSession();
MOZ_ASSERT(session == this);
targetBC->SetDragSession(nullptr);
mTargetBrowser = nullptr;
}
return nsBaseDragSession::EndDragSessionImpl(aDoneDrag, aKeyModifiers);
}