michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: #include "TabParent.h"
michael@0: 
michael@0: // TabParent.h transitively includes <windows.h>, which does
michael@0: //   #define CreateEvent CreateEventW
michael@0: // That messes up our call to EventDispatcher::CreateEvent below.
michael@0: 
michael@0: #ifdef CreateEvent
michael@0: #undef CreateEvent
michael@0: #endif
michael@0: 
michael@0: #include "BrowserElementParent.h"
michael@0: #include "mozilla/EventDispatcher.h"
michael@0: #include "mozilla/dom/HTMLIFrameElement.h"
michael@0: #include "nsIDOMCustomEvent.h"
michael@0: #include "nsIInterfaceRequestorUtils.h"
michael@0: #include "nsVariant.h"
michael@0: #include "mozilla/dom/BrowserElementDictionariesBinding.h"
michael@0: #include "nsCxPusher.h"
michael@0: #include "GeneratedEventClasses.h"
michael@0: 
michael@0: using namespace mozilla;
michael@0: using namespace mozilla::dom;
michael@0: 
michael@0: namespace {
michael@0: 
michael@0: using mozilla::BrowserElementParent;
michael@0: /**
michael@0:  * Create an <iframe mozbrowser> owned by the same document as
michael@0:  * aOpenerFrameElement.
michael@0:  */
michael@0: already_AddRefed<HTMLIFrameElement>
michael@0: CreateIframe(Element* aOpenerFrameElement, const nsAString& aName, bool aRemote)
michael@0: {
michael@0:   nsNodeInfoManager *nodeInfoManager =
michael@0:     aOpenerFrameElement->OwnerDoc()->NodeInfoManager();
michael@0: 
michael@0:   nsCOMPtr<nsINodeInfo> nodeInfo =
michael@0:     nodeInfoManager->GetNodeInfo(nsGkAtoms::iframe,
michael@0:                                  /* aPrefix = */ nullptr,
michael@0:                                  kNameSpaceID_XHTML,
michael@0:                                  nsIDOMNode::ELEMENT_NODE);
michael@0: 
michael@0:   nsRefPtr<HTMLIFrameElement> popupFrameElement =
michael@0:     static_cast<HTMLIFrameElement*>(
michael@0:       NS_NewHTMLIFrameElement(nodeInfo.forget(), mozilla::dom::NOT_FROM_PARSER));
michael@0: 
michael@0:   popupFrameElement->SetMozbrowser(true);
michael@0: 
michael@0:   // Copy the opener frame's mozapp attribute to the popup frame.
michael@0:   if (aOpenerFrameElement->HasAttr(kNameSpaceID_None, nsGkAtoms::mozapp)) {
michael@0:     nsAutoString mozapp;
michael@0:     aOpenerFrameElement->GetAttr(kNameSpaceID_None, nsGkAtoms::mozapp, mozapp);
michael@0:     popupFrameElement->SetAttr(kNameSpaceID_None, nsGkAtoms::mozapp,
michael@0:                                mozapp, /* aNotify = */ false);
michael@0:   }
michael@0: 
michael@0:   // Copy the opener frame's parentApp attribute to the popup frame.
michael@0:   if (aOpenerFrameElement->HasAttr(kNameSpaceID_None, nsGkAtoms::parentapp)) {
michael@0:     nsAutoString parentApp;
michael@0:     aOpenerFrameElement->GetAttr(kNameSpaceID_None, nsGkAtoms::parentapp,
michael@0:                                  parentApp);
michael@0:     popupFrameElement->SetAttr(kNameSpaceID_None, nsGkAtoms::parentapp,
michael@0:                                parentApp, /* aNotify = */ false);
michael@0:   }
michael@0: 
michael@0:   // Copy the window name onto the iframe.
michael@0:   popupFrameElement->SetAttr(kNameSpaceID_None, nsGkAtoms::name,
michael@0:                              aName, /* aNotify = */ false);
michael@0: 
michael@0:   // Indicate whether the iframe is should be remote.
michael@0:   popupFrameElement->SetAttr(kNameSpaceID_None, nsGkAtoms::Remote,
michael@0:                              aRemote ? NS_LITERAL_STRING("true") :
michael@0:                                        NS_LITERAL_STRING("false"),
michael@0:                              /* aNotify = */ false);
michael@0: 
michael@0:   return popupFrameElement.forget();
michael@0: }
michael@0: 
michael@0: bool
michael@0: DispatchCustomDOMEvent(Element* aFrameElement, const nsAString& aEventName,
michael@0:                        JSContext* cx, JS::Handle<JS::Value> aDetailValue,
michael@0:                        nsEventStatus *aStatus)
michael@0: {
michael@0:   NS_ENSURE_TRUE(aFrameElement, false);
michael@0:   nsIPresShell *shell = aFrameElement->OwnerDoc()->GetShell();
michael@0:   nsRefPtr<nsPresContext> presContext;
michael@0:   if (shell) {
michael@0:     presContext = shell->GetPresContext();
michael@0:   }
michael@0: 
michael@0:   nsCOMPtr<nsIDOMEvent> domEvent;
michael@0:   EventDispatcher::CreateEvent(aFrameElement, presContext, nullptr,
michael@0:                                NS_LITERAL_STRING("customevent"),
michael@0:                                getter_AddRefs(domEvent));
michael@0:   NS_ENSURE_TRUE(domEvent, false);
michael@0: 
michael@0:   nsCOMPtr<nsIDOMCustomEvent> customEvent = do_QueryInterface(domEvent);
michael@0:   NS_ENSURE_TRUE(customEvent, false);
michael@0:   ErrorResult res;
michael@0:   CustomEvent* event = static_cast<CustomEvent*>(customEvent.get());
michael@0:   event->InitCustomEvent(cx,
michael@0:                          aEventName,
michael@0:                          /* bubbles = */ true,
michael@0:                          /* cancelable = */ true,
michael@0:                          aDetailValue,
michael@0:                          res);
michael@0:   if (res.Failed()) {
michael@0:     return false;
michael@0:   }
michael@0:   customEvent->SetTrusted(true);
michael@0:   // Dispatch the event.
michael@0:   *aStatus = nsEventStatus_eConsumeNoDefault;
michael@0:   nsresult rv =
michael@0:     EventDispatcher::DispatchDOMEvent(aFrameElement, nullptr,
michael@0:                                       domEvent, presContext, aStatus);
michael@0:   return NS_SUCCEEDED(rv);
michael@0: }
michael@0: 
michael@0: } // anonymous namespace
michael@0: 
michael@0: namespace mozilla {
michael@0: 
michael@0: /**
michael@0:  * Dispatch a mozbrowseropenwindow event to the given opener frame element.
michael@0:  * The "popup iframe" (event.detail.frameElement) will be |aPopupFrameElement|.
michael@0:  *
michael@0:  * Returns true iff there were no unexpected failures and the window.open call
michael@0:  * was accepted by the embedder.
michael@0:  */
michael@0: /*static*/
michael@0: BrowserElementParent::OpenWindowResult
michael@0: BrowserElementParent::DispatchOpenWindowEvent(Element* aOpenerFrameElement,
michael@0:                         Element* aPopupFrameElement,
michael@0:                         const nsAString& aURL,
michael@0:                         const nsAString& aName,
michael@0:                         const nsAString& aFeatures)
michael@0: {
michael@0:   // Dispatch a CustomEvent at aOpenerFrameElement with a detail object
michael@0:   // (OpenWindowEventDetail) containing aPopupFrameElement, aURL, aName, and
michael@0:   // aFeatures.
michael@0: 
michael@0:   // Create the event's detail object.
michael@0:   OpenWindowEventDetail detail;
michael@0:   detail.mUrl = aURL;
michael@0:   detail.mName = aName;
michael@0:   detail.mFeatures = aFeatures;
michael@0:   detail.mFrameElement = aPopupFrameElement;
michael@0: 
michael@0:   AutoJSContext cx;
michael@0:   JS::Rooted<JS::Value> val(cx);
michael@0: 
michael@0:   nsIGlobalObject* sgo = aPopupFrameElement->OwnerDoc()->GetScopeObject();
michael@0:   if (!sgo) {
michael@0:     return BrowserElementParent::OPEN_WINDOW_IGNORED;
michael@0:   }
michael@0: 
michael@0:   JS::Rooted<JSObject*> global(cx, sgo->GetGlobalJSObject());
michael@0:   JSAutoCompartment ac(cx, global);
michael@0:   if (!detail.ToObject(cx, &val)) {
michael@0:     MOZ_CRASH("Failed to convert dictionary to JS::Value due to OOM.");
michael@0:     return BrowserElementParent::OPEN_WINDOW_IGNORED;
michael@0:   }
michael@0: 
michael@0:   nsEventStatus status;
michael@0:   bool dispatchSucceeded =
michael@0:     DispatchCustomDOMEvent(aOpenerFrameElement,
michael@0:                            NS_LITERAL_STRING("mozbrowseropenwindow"),
michael@0:                            cx,
michael@0:                            val, &status);
michael@0: 
michael@0:   if (dispatchSucceeded) {
michael@0:     if (aPopupFrameElement->IsInDoc()) {
michael@0:       return BrowserElementParent::OPEN_WINDOW_ADDED;
michael@0:     } else if (status == nsEventStatus_eConsumeNoDefault) {
michael@0:       // If the frame was not added to a document, report to callers whether
michael@0:       // preventDefault was called on or not
michael@0:       return BrowserElementParent::OPEN_WINDOW_CANCELLED;
michael@0:     }
michael@0:   }
michael@0: 
michael@0:   return BrowserElementParent::OPEN_WINDOW_IGNORED;
michael@0: }
michael@0: 
michael@0: /*static*/
michael@0: BrowserElementParent::OpenWindowResult
michael@0: BrowserElementParent::OpenWindowOOP(TabParent* aOpenerTabParent,
michael@0:                                     TabParent* aPopupTabParent,
michael@0:                                     const nsAString& aURL,
michael@0:                                     const nsAString& aName,
michael@0:                                     const nsAString& aFeatures)
michael@0: {
michael@0:   // Create an iframe owned by the same document which owns openerFrameElement.
michael@0:   nsCOMPtr<Element> openerFrameElement = aOpenerTabParent->GetOwnerElement();
michael@0:   NS_ENSURE_TRUE(openerFrameElement,
michael@0:                  BrowserElementParent::OPEN_WINDOW_IGNORED);
michael@0:   nsRefPtr<HTMLIFrameElement> popupFrameElement =
michael@0:     CreateIframe(openerFrameElement, aName, /* aRemote = */ true);
michael@0: 
michael@0:   // Normally an <iframe> element will try to create a frameLoader when the
michael@0:   // page touches iframe.contentWindow or sets iframe.src.
michael@0:   //
michael@0:   // But in our case, we want to delay the creation of the frameLoader until
michael@0:   // we've verified that the popup has gone through successfully.  If the popup
michael@0:   // is "blocked" by the embedder, we don't want to load the popup's url.
michael@0:   //
michael@0:   // Therefore we call DisallowCreateFrameLoader() on the element and call
michael@0:   // AllowCreateFrameLoader() only after we've verified that the popup was
michael@0:   // allowed.
michael@0:   popupFrameElement->DisallowCreateFrameLoader();
michael@0: 
michael@0:   OpenWindowResult opened =
michael@0:     DispatchOpenWindowEvent(openerFrameElement, popupFrameElement,
michael@0:                             aURL, aName, aFeatures);
michael@0: 
michael@0:   if (opened != BrowserElementParent::OPEN_WINDOW_ADDED) {
michael@0:     return opened;
michael@0:   }
michael@0: 
michael@0:   // The popup was not blocked, so hook up the frame element and the popup tab
michael@0:   // parent, and return success.
michael@0:   aPopupTabParent->SetOwnerElement(popupFrameElement);
michael@0:   popupFrameElement->AllowCreateFrameLoader();
michael@0:   popupFrameElement->CreateRemoteFrameLoader(aPopupTabParent);
michael@0:   return opened;
michael@0: }
michael@0: 
michael@0: /* static */
michael@0: BrowserElementParent::OpenWindowResult
michael@0: BrowserElementParent::OpenWindowInProcess(nsIDOMWindow* aOpenerWindow,
michael@0:                                           nsIURI* aURI,
michael@0:                                           const nsAString& aName,
michael@0:                                           const nsACString& aFeatures,
michael@0:                                           nsIDOMWindow** aReturnWindow)
michael@0: {
michael@0:   *aReturnWindow = nullptr;
michael@0: 
michael@0:   // If we call window.open from an <iframe> inside an <iframe mozbrowser>,
michael@0:   // it's as though the top-level document inside the <iframe mozbrowser>
michael@0:   // called window.open.  (Indeed, in the OOP case, the inner <iframe> lives
michael@0:   // out-of-process, so we couldn't touch it if we tried.)
michael@0:   //
michael@0:   // GetScriptableTop gets us the <iframe mozbrowser>'s window; we'll use its
michael@0:   // frame element, rather than aOpenerWindow's frame element, as our "opener
michael@0:   // frame element" below.
michael@0:   nsCOMPtr<nsIDOMWindow> topWindow;
michael@0:   aOpenerWindow->GetScriptableTop(getter_AddRefs(topWindow));
michael@0: 
michael@0:   nsCOMPtr<nsPIDOMWindow> win = do_QueryInterface(topWindow);
michael@0: 
michael@0:   nsCOMPtr<Element> openerFrameElement = win->GetFrameElementInternal();
michael@0:   NS_ENSURE_TRUE(openerFrameElement, BrowserElementParent::OPEN_WINDOW_IGNORED);
michael@0: 
michael@0: 
michael@0:   nsRefPtr<HTMLIFrameElement> popupFrameElement =
michael@0:     CreateIframe(openerFrameElement, aName, /* aRemote = */ false);
michael@0:   NS_ENSURE_TRUE(popupFrameElement, BrowserElementParent::OPEN_WINDOW_IGNORED);
michael@0: 
michael@0:   nsAutoCString spec;
michael@0:   if (aURI) {
michael@0:     aURI->GetSpec(spec);
michael@0:   }
michael@0: 
michael@0:   OpenWindowResult opened =
michael@0:     DispatchOpenWindowEvent(openerFrameElement, popupFrameElement,
michael@0:                             NS_ConvertUTF8toUTF16(spec),
michael@0:                             aName,
michael@0:                             NS_ConvertUTF8toUTF16(aFeatures));
michael@0: 
michael@0:   if (opened != BrowserElementParent::OPEN_WINDOW_ADDED) {
michael@0:     return opened;
michael@0:   }
michael@0: 
michael@0:   // Return popupFrameElement's window.
michael@0:   nsCOMPtr<nsIFrameLoader> frameLoader;
michael@0:   popupFrameElement->GetFrameLoader(getter_AddRefs(frameLoader));
michael@0:   NS_ENSURE_TRUE(frameLoader, BrowserElementParent::OPEN_WINDOW_IGNORED);
michael@0: 
michael@0:   nsCOMPtr<nsIDocShell> docshell;
michael@0:   frameLoader->GetDocShell(getter_AddRefs(docshell));
michael@0:   NS_ENSURE_TRUE(docshell, BrowserElementParent::OPEN_WINDOW_IGNORED);
michael@0: 
michael@0:   nsCOMPtr<nsIDOMWindow> window = do_GetInterface(docshell);
michael@0:   window.forget(aReturnWindow);
michael@0: 
michael@0:   return !!*aReturnWindow ? opened : BrowserElementParent::OPEN_WINDOW_CANCELLED;
michael@0: }
michael@0: 
michael@0: class DispatchAsyncScrollEventRunnable : public nsRunnable
michael@0: {
michael@0: public:
michael@0:   DispatchAsyncScrollEventRunnable(TabParent* aTabParent,
michael@0:                                    const CSSRect& aContentRect,
michael@0:                                    const CSSSize& aContentSize)
michael@0:     : mTabParent(aTabParent)
michael@0:     , mContentRect(aContentRect)
michael@0:     , mContentSize(aContentSize)
michael@0:   {}
michael@0: 
michael@0:   NS_IMETHOD Run();
michael@0: 
michael@0: private:
michael@0:   nsRefPtr<TabParent> mTabParent;
michael@0:   const CSSRect mContentRect;
michael@0:   const CSSSize mContentSize;
michael@0: };
michael@0: 
michael@0: NS_IMETHODIMP DispatchAsyncScrollEventRunnable::Run()
michael@0: {
michael@0:   nsCOMPtr<Element> frameElement = mTabParent->GetOwnerElement();
michael@0:   NS_ENSURE_STATE(frameElement);
michael@0:   nsIDocument *doc = frameElement->OwnerDoc();
michael@0:   nsCOMPtr<nsIGlobalObject> globalObject = doc->GetScopeObject();
michael@0:   NS_ENSURE_TRUE(globalObject, NS_ERROR_UNEXPECTED);
michael@0: 
michael@0:   // Create the event's detail object.
michael@0:   AsyncScrollEventDetail detail;
michael@0:   detail.mLeft = mContentRect.x;
michael@0:   detail.mTop = mContentRect.y;
michael@0:   detail.mWidth = mContentRect.width;
michael@0:   detail.mHeight = mContentRect.height;
michael@0:   detail.mScrollWidth = mContentRect.width;
michael@0:   detail.mScrollHeight = mContentRect.height;
michael@0: 
michael@0:   AutoSafeJSContext cx;
michael@0:   JS::Rooted<JSObject*> globalJSObject(cx, globalObject->GetGlobalJSObject());
michael@0:   NS_ENSURE_TRUE(globalJSObject, NS_ERROR_UNEXPECTED);
michael@0: 
michael@0:   JSAutoCompartment ac(cx, globalJSObject);
michael@0:   JS::Rooted<JS::Value> val(cx);
michael@0: 
michael@0:   if (!detail.ToObject(cx, &val)) {
michael@0:     MOZ_CRASH("Failed to convert dictionary to JS::Value due to OOM.");
michael@0:     return NS_ERROR_FAILURE;
michael@0:   }
michael@0: 
michael@0:   nsEventStatus status = nsEventStatus_eIgnore;
michael@0:   DispatchCustomDOMEvent(frameElement,
michael@0:                          NS_LITERAL_STRING("mozbrowserasyncscroll"),
michael@0:                          cx,
michael@0:                          val, &status);
michael@0:   return NS_OK;
michael@0: }
michael@0: 
michael@0: bool
michael@0: BrowserElementParent::DispatchAsyncScrollEvent(TabParent* aTabParent,
michael@0:                                                const CSSRect& aContentRect,
michael@0:                                                const CSSSize& aContentSize)
michael@0: {
michael@0:   nsRefPtr<DispatchAsyncScrollEventRunnable> runnable =
michael@0:     new DispatchAsyncScrollEventRunnable(aTabParent, aContentRect,
michael@0:                                          aContentSize);
michael@0:   return NS_SUCCEEDED(NS_DispatchToMainThread(runnable));
michael@0: }
michael@0: 
michael@0: } // namespace mozilla