issue #290 - [seamonkey] blockable items list persists on tab changes

lib/appSupport.js

 /*
  * This file is part of Adblock Plus <http://adblockplus.org/>,
  * Copyright (C) 2006-2014 Eyeo GmbH
  *
  * Adblock Plus is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 3 as
  * published by the Free Software Foundation.
  *
  * Adblock Plus is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ skipping 342 matching lines @@
           return null;
         }
       }
       else
       {
         let browser = exports.getBrowser(window);
         return (browser ? browser.currentURI : null);
       }
     };
     
-    /**
-     * Makes sure that a function is called whenever the displayed browser location changes.
-     * For Seamonkey ignoreSameDoc attribute is useless while aFlags attribute is missing in onLocationChange Listener.
-     */
-    exports.addBrowserLocationListener = function addBrowserLocationListener(/**Window*/ window, /**Function*/ callback, /**Boolean*/ ignoreSameDoc)
-    {
-      let browser = (exports.getBrowser ? exports.getBrowser(window) : null);
-      if (browser)
-      {
-        let dummy = function() {};
-        let progressListener =
-        {
-          callback: callback,
-          onLocationChange: function(progress, request, uri)

[saroyanm, 2014/07/06 13:01:02]

The issue looks caused by ​onLocationChange method's aFlags attribute.
While in Firefox it's implemented as optional attribute:
​http://mxr.mozilla.org/mozilla-central/source/uriloader/base/nsIWebProgressListener.idl#344
In Seamonkey the implementation for the attribute is missing:
​http://mxr.mozilla.org/seamonkey/source/uriloader/base/nsIWebProgressListener.idl#322

Not sure if this is the best approach, also not sure if there is a better way to
determine whether the listener is triggered by anchor scroll, while it's being
hard to determine if the page was reloaded (ctrl+r) or moved to anchor.

[Wladimir Palant, 2014/07/07 12:21:21]

The code you are linking to is very outdated, the description on MXR says: "This
the old code in CVS for Gecko, XULRunner, Firefox, Thunderbird, Calendar,
Camino, and SeaMonkey. CVS trunk is only used for Gecko 1.9.0 / Firefox 3 and
the 1.9.0.* / 3.0.* security releases." For current SeaMonkey and Thunderbird
releases you should be looking at the comm-central repository:
http://mxr.mozilla.org/comm-central/source/mozilla/uriloader/base/nsIWebProgr...

Note than an additional parameter wouldn't be an issue, our code is
backwards-compatible and can deal with that parameter not being there. The issue
is really that the flag is there in SeaMonkey and its value is 1
(LOCATION_CHANGE_SAME_DOCUMENT). This appears to be a SeaMonkey bug, we'll need
to check it.

[saroyanm, 2014/07/07 13:12:23]

Thanks Wladimir for pointing on correct repository, my bad went on big Seamonkey
text :) will take into consideration for future.
Anyway I have a doubt, why in that case aFlag always 1 for seamonkey should we
also consider it as a bug in Seamonkey ? Anyway will have a closer look on that
also.
Good point, BTW LOCATION_CHANGE_SAME_DOCUMENT flag's value is 1 also for Firefox
not only Seamonkey.

-          {
-              this.callback();
-          },
-          onProgressChange: dummy,
-          onSecurityChange: dummy,
-          onStateChange: dummy,
-          onStatusChange: dummy,
-          QueryInterface: XPCOMUtils.generateQI([Ci.nsIWebProgressListener, Ci.nsISupportsWeakReference])
-        };
-        browser.addProgressListener(progressListener);
-    
-        if (progressListeners.has(window))
-          progressListeners.get(window).push(progressListener);
-        else
-          progressListeners.set(window, [progressListener]);
-      }
+    // for Seamonkey we have to ignore same document flag because of
+    // bug #1035171 (https://bugzilla.mozilla.org/show_bug.cgi?id=1035171)
+    let origAddBrowserLocationListener = exports.addBrowserLocationListener;
+    exports.addBrowserLocationListener = function sm_addBrowserLocationListener(window, callback, ignoreSameDoc)
+    {
+      origAddBrowserLocationListener(window, callback, false);
     };
 
     exports.contentContextMenu = ["contentAreaContextMenu", "mailContext"];
 
     exports.defaultToolbarPosition = {
       parent: ["PersonalToolbar", "msgToolbar"],
       before: ["bookmarks-button", "button-junk"]
     };
 
     exports.statusbarPosition = {
@@ skipping 568 matching lines @@
             event.state = {id: require("info").addonID};
             browser._contentWindow.dispatchEvent(event);
           });
         });
       }, true);
     };
 
     break;
   }
 }