From fd5fd11c95ebac5894aefb2ff9a818b2c5319b6e Mon Sep 17 00:00:00 2001
From: Cameron Kaiser <classilla@floodgap.com>
Date: Mon, 11 Feb 2019 22:34:42 -0800
Subject: [PATCH] #164: busy property; prohibit properties on new tab creation

---
 .../Contents/Resources/scripting.sdef.in      |  3 ++
 .../applescript/src/MacScripting.mm           | 52 ++++++++++++++++---
 2 files changed, 49 insertions(+), 6 deletions(-)

diff --git a/browser/app/macbuild/Contents/Resources/scripting.sdef.in b/browser/app/macbuild/Contents/Resources/scripting.sdef.in
index 77a5b95a8..922293721 100644
--- a/browser/app/macbuild/Contents/Resources/scripting.sdef.in
+++ b/browser/app/macbuild/Contents/Resources/scripting.sdef.in
@@ -290,6 +290,9 @@
       <property name="name" code="pnam" type="text" access="r" description="The name of the tab.">
         <cocoa key="title"/>
       </property>
+      <property name="busy" code="pBzy" type="boolean" access="r" description="Whether the tab is busy.">
+        <cocoa key="busy"/>
+      </property>
       <property name="index" code="pidx" type="integer" access="r" description="The index of the tab, ordered left to right.">
         <cocoa key="orderedIndex"/>
       </property>
diff --git a/toolkit/components/applescript/src/MacScripting.mm b/toolkit/components/applescript/src/MacScripting.mm
index 1f92a0931..8c3040537 100644
--- a/toolkit/components/applescript/src/MacScripting.mm
+++ b/toolkit/components/applescript/src/MacScripting.mm
@@ -493,6 +493,9 @@ static GeckoScriptingRoot *sharedScriptingRoot = nil;
 
 - (void)insertInScriptTabs:(id)value {
   NS_WARNING("AppleScript: window insertInScriptTabs");
+  if (![(NSObject*)value isKindOfClass:[GeckoTab class]])
+    return;
+
   [self insertObject:value inScriptTabsAtIndex:[[self scriptTabs] count]];
 }
 
@@ -515,6 +518,10 @@ static GeckoScriptingRoot *sharedScriptingRoot = nil;
   return [[[self alloc] initWithIndex:index andContentWindow:contentWindow andWindow:window] autorelease];
 }
 
+- (id)init {
+  /* AppleScript may call directly. */
+}
+
 - (id)initWithIndex:(NSUInteger)index andContentWindow:(nsIDOMWindow*)contentWindow andWindow:(GeckoWindow*)window {
   self = [super init];
   
@@ -523,7 +530,7 @@ static GeckoScriptingRoot *sharedScriptingRoot = nil;
     mWindow = [window retain];
     mContentWindow = contentWindow;
   }
-  
+
   return self;
 }
 
@@ -603,21 +610,54 @@ static GeckoScriptingRoot *sharedScriptingRoot = nil;
   return @"";
 }
 
+- (BOOL)busy
+{
+  NS_WARNING("AppleScript: tab busy");
+
+  // This is deliberately inexact and is designed to mostly tell the caller when
+  // it's okay to start working with the tab's properties.
+  nsCOMPtr<nsPIDOMWindow> piWindow = do_QueryInterface(mContentWindow);
+  if (!piWindow)
+    return YES; // Gecko is still creating this tab.
+  nsCOMPtr<nsIDocShell> d = piWindow->GetDocShell();
+  if (!d)
+    return YES; // Ditto.
+  uint32_t bz;
+  if (NS_FAILED(d->GetBusyFlags(&bz)))
+    return YES; // Hmmm.
+  return (bz == nsIDocShell::BUSY_FLAGS_NONE) ? NO : YES;
+}
+
 - (void)setURL:(NSString*)newURL
 {
   NS_WARNING("AppleScript: tab newURL");
   nsAutoCString geckoURL;
   nsIURI* uri;
+  NSScriptCommand* c = [NSScriptCommand currentCommand];
+  nsCOMPtr<nsIDocShell> d;
 
   geckoURL.Assign([newURL UTF8String]);
-  if (NS_FAILED(NS_NewURI(&uri, geckoURL, nullptr, nullptr, nsContentUtils::GetIOService())))
+  if (NS_FAILED(NS_NewURI(&uri, geckoURL, nullptr, nullptr, nsContentUtils::GetIOService()))) {
+    if (c) {
+      [c setScriptErrorNumber:-1700]; // errAECoercionFail
+      [c setScriptErrorString:@"Parameter Error: URL is not valid."];
+    }
     return;
+  }
   nsCOMPtr<nsPIDOMWindow> piWindow = do_QueryInterface(mContentWindow);
-  if (!piWindow)
-    return;
-  nsCOMPtr<nsIDocShell> d = piWindow->GetDocShell();
-  if (!d)
+  if (piWindow)
+    d = piWindow->GetDocShell();
+  if (!d) {
+    // XXX: This usually happens when we try to open a new tab with properties.
+    // Gecko's asynchronous nature doesn't work well with this, so right now
+    // we just return a fatal error so people learn right away this won't fly.
+    // The busy property would tell the caller if we're ready.
+    if (c) {
+      [c setScriptErrorNumber:-10003]; // errAENotModifiable
+      [c setScriptErrorString:@"Parameter Error: The tab is busy. Don't use properties when creating a tab. Check busy first."];
+    }
     return;
+  }
   d->LoadURI(uri, nullptr, nsIWebNavigation::LOAD_FLAGS_NONE, true);
 }