Issue 431/432 - Remove special handling for the $sitekey option

lib/filterClasses.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 306 matching lines @@
    * @type Boolean
    */
   domainSourceIsUpperCase: false,
 
   /**
    * Map containing domains that this filter should match on/not match on or null if the filter should match on all domains
    * @type Object
    */
   get domains()
   {
+    // Despite this property being cached, the getter is called
+    // several times on Safari, due to WebKit bug 132872
+    let prop = Object.getOwnPropertyDescriptor(this, "domains");
+    if (prop)
+      return prop.value;
+
     let domains = null;
 
     if (this.domainSource)
     {
       let source = this.domainSource;
       if (!this.domainSourceIsUpperCase) {
         // RegExpFilter already have uppercase domains
         source = source.toUpperCase();
       }
       let list = source.split(this.domainSeparator);
@@ skipping 50 matching lines @@
   sitekeys: null,
 
   /**
    * Checks whether this filter is active on a domain.
    * @param {String} docDomain domain name of the document that loads the URL
    * @param {String} [sitekey] public key provided by the document
    * @return {Boolean} true in case of the filter being active
    */
   isActiveOnDomain: function(docDomain, sitekey)
   {
+    // Sitekeys are case-sensitive so we shouldn't convert them to upper-case to avoid false
+    // positives here. Instead we need to change the way filter options are parsed.
     if (this.sitekeys && (!sitekey || this.sitekeys.indexOf(sitekey.toUpperCase()) < 0))

[Wladimir Palant, 2014/08/29 20:13:59]

Ok, we have an issue here. This code works in the first approximation, but
sitekeys are actually case-sensitive. There is a very slight chance that two
different sitekeys will be identical when converted to upper-case.

Given that this issue was present in the original code as well, and that fixing
it is non-trivial (we would need to change the way filter options are parsed) -
could you just add a comment noting this problem?

[Thomas Greiner, 2014/09/01 09:51:46]

Done.

       return false;
 
     // If no domains are set the rule matches everywhere
     if (!this.domains)
       return true;
 
     // If the document has no host name, match only if the filter isn't restricted to specific domains
     if (!docDomain)
       return this.domains[""];
 
@@ skipping 114 matching lines @@
    * Expression from which a regular expression should be generated - for delayed creation of the regexp property
    * @type String
    */
   regexpSource: null,
   /**
    * Regular expression to be used when testing against this filter
    * @type RegExp
    */
   get regexp()
   {
+    // Despite this property being cached, the getter is called
+    // several times on Safari, due to WebKit bug 132872
+    let prop = Object.getOwnPropertyDescriptor(this, "regexp");
+    if (prop)
+      return prop.value;
+
     // Remove multiple wildcards
     let source = this.regexpSource
       .replace(/\*+/g, "*")        // remove multiple wildcards
       .replace(/\^\|$/, "^")       // remove anchors following separator placeholder
       .replace(/\W/g, "\\$&")      // escape special symbols
       .replace(/\\\*/g, ".*")      // replace wildcards by .*
       // process separator placeholders (all ANSI characters but alphanumeric characters and _%.-)
       .replace(/\\\^/g, "(?:[\\x00-\\x24\\x26-\\x2C\\x2F\\x3A-\\x40\\x5B-\\x5E\\x60\\x7B-\\x7F]|$)")
       .replace(/^\\\|\\\|/, "^[\\w\\-]+:\\/+(?!\\/)(?:[^\\/]+\\.)?") // process extended anchor at expression start
       .replace(/^\\\|/, "^")       // process anchor at expression start
@@ skipping 26 matching lines @@
    * @type String
    */
   sitekeySource: null,
 
   /**
    * Array containing public keys of websites that this filter should apply to
    * @type Array of String
    */
   get sitekeys()
   {
+    // Despite this property being cached, the getter is called
+    // several times on Safari, due to WebKit bug 132872
+    let prop = Object.getOwnPropertyDescriptor(this, "sitekeys");
+    if (prop)
+      return prop.value;
+
     let sitekeys = null;
 
     if (this.sitekeySource)
     {
       sitekeys = this.sitekeySource.split("|");
       this.sitekeySource = null;
     }
 
     Object.defineProperty(this, "sitekeys", {value: sitekeys, enumerable: true});
     return this.sitekeys;
@@ skipping 332 matching lines @@
 function ElemHideException(text, domains, selector)
 {
   ElemHideBase.call(this, text, domains, selector);
 }
 exports.ElemHideException = ElemHideException;
 
 ElemHideException.prototype =
 {
   __proto__: ElemHideBase.prototype
 };