From 8e93f5bc28709b307f233f2326093ca47e0e4aba Mon Sep 17 00:00:00 2001
From: Stephen Blott
Date: Thu, 4 Jun 2015 12:35:31 +0100
Subject: Global marks; better comments and minor refactoring.

---
 background_scripts/marks.coffee | 37 ++++++++++++++++++++-----------------
 1 file changed, 20 insertions(+), 17 deletions(-)

(limited to 'background_scripts')

diff --git a/background_scripts/marks.coffee b/background_scripts/marks.coffee
index 94633c36..c6c76dbb 100644
--- a/background_scripts/marks.coffee
+++ b/background_scripts/marks.coffee
@@ -1,17 +1,21 @@
 
 Marks =
-  marks: {}
-
   # This returns the key which is used for storing mark locations in chrome.storage.local.
   getLocationKey: (markName) -> "vimiumGlobalMark|#{markName}"
 
+  # Get the part of a URL we use for matching here (that is, everything up to the first anchor).
+  getBaseUrl: (url) -> url.split("#")[0]
+
+  # Create a global mark.  We record vimiumSecret with the mark so that we can tell later, when the mark is
+  # used, whether this is the original Vimium instantiation or a subsequent instantiation.  This affects
+  # whether or not tabId can be considered valid.
   create: (req, sender) ->
     chrome.storage.local.get "vimiumSecret", (items) =>
       item = {}
       item[@getLocationKey req.markName] =
         vimiumSecret: items.vimiumSecret
         tabId: sender.tab.id
-        url: sender.tab.url
+        url: @getBaseUrl sender.tab.url
         scrollX: req.scrollX
         scrollY: req.scrollY
         markName: req.markName
@@ -31,14 +35,15 @@ Marks =
         # This is a different Vimium instantiation, so markInfo.tabId is definitely out of date.
         @focusOrLaunch markInfo
       else
-        # Check whether markInfo.tabId still exists.
+        # Check whether markInfo.tabId still exists.  According to here (https://developer.chrome.com/extensions/tabs),
+        # tab Ids are unqiue within a Chrome session.  So, if we find a match, we can use.
         chrome.tabs.get markInfo.tabId, (tab) =>
-          if chrome.runtime.lastError or not tab
-            # The original tab no longer exists.
-            @focusOrLaunch markInfo
-          else
+          if not chrome.runtime.lastError and tab?.url and markInfo.url == @getBaseUrl tab.url
             # The original tab still exists.
             @gotoPositionInTab markInfo
+          else
+            # The original tab no longer exists.
+            @focusOrLaunch markInfo
 
   gotoPositionInTab: ({ tabId, scrollX, scrollY, markName }) ->
     chrome.tabs.update tabId, { selected: true }, ->
@@ -49,23 +54,21 @@ Marks =
             text: "Jumped to global mark '#{markName}'."
             duration: 1000
 
-  # The tab we're trying to find no longer exists.  Either find another tab with a matching URL and use it, or
-  # create a new tab.
+  # The tab we're trying to find no longer exists.  We either find another tab with a matching URL and use it,
+  # or we create a new tab.
   focusOrLaunch: (markInfo) ->
     chrome.windows.getAll { populate: true }, (windows) =>
-      baseUrl = @getBaseUrl markInfo.url
       for window in windows
         for tab in window.tabs
-          if baseUrl == @getBaseUrl tab.url
-            # We have a matching tab.  We'll use it.
-            return @gotoPositionInTab extend markInfo, tabId: tab.id
+          if markInfo.url == @getBaseUrl tab.url
+            # We have a matching tab: use it.
+            @gotoPositionInTab extend markInfo, tabId: tab.id
+            return
       # There is no existing matching tab, we'll have to create one.
       chrome.tabs.create { url: @getBaseUrl(markInfo.url) }, (tab) =>
-        # Note. tabLoadedHandlers is defined in "main.coffee".  This handler will be called when the tab has
+        # Note. tabLoadedHandlers is defined in "main.coffee".  The handler below will be called when the tab
         # is loaded, its DOM is ready and it registers with the background page.
         tabLoadedHandlers[tab.id] = => @gotoPositionInTab extend markInfo, tabId: tab.id
 
-  getBaseUrl: (url) -> url.split("#")[0]
-
 root = exports ? window
 root.Marks = Marks
-- 
cgit v1.2.3