Clean up and add comments.

jsha · jsha · commit 515819f87b1e · 2016-02-08T18:27:34.000-08:00
diff --git a/makexpi.sh b/makexpi.sh
@@ -17,7 +17,7 @@ APP_NAME=https-everywhere
 
 cd "`dirname $0`"
 RULESETS_UNVALIDATED="$PWD/pkg/rulesets.unvalidated.sqlite"
-RULESETS_SQLITE="$PWD/src/defaults/rulesets.sqlite"
+RULESETS_JSON="$PWD/src/defaults/rulesets.json"
 ANDROID_APP_ID=org.mozilla.firefox
 VERSION=`echo $1 | cut -d "-" -f 2`
 
@@ -55,7 +55,7 @@ if [ -n "$1" ] && [ "$2" != "--no-recurse" ] ; then
   exit 0
 fi
 
-# Only generate the sqlite database if any rulesets have changed. Tried
+# Only generate the ruleset database if any rulesets have changed. Tried
 # implementing this with make, but make is very slow with 15k+ input files.
 needs_update() {
   find src/chrome/content/rules/ -newer $RULESETS_UNVALIDATED |\
@@ -69,7 +69,7 @@ if [ ! -f "$RULESETS_UNVALIDATED" ] || needs_update ; then
     # Those cover everything but it wouldn't matter if they didn't
     nohup cat src/chrome/content/rules/"$firstchar"*.xml >/dev/null 2>/dev/null &
   done
-  echo "Generating sqlite DB"
+  echo "Generating ruleset DB"
   python2.7 ./utils/make-sqlite.py
 fi
 
@@ -81,11 +81,7 @@ die() {
   exit 1
 }
 
-# If the unvalidated rulesets have changed, validate and copy to the validated
-# rulesets file.
-if [ "$RULESETS_UNVALIDATED" -nt "$RULESETS_SQLITE" ] ; then
-  bash utils/validate.sh
-fi
+bash utils/validate.sh
 
 # The name/version of the XPI we're building comes from src/install.rdf
 XPI_NAME="pkg/$APP_NAME-`grep em:version src/install.rdf | sed -e 's/[<>]/	/g' | cut -f3`"
@@ -128,7 +124,7 @@ rm -f "${XPI_NAME}-amo.xpi"
 python2.7 utils/create_xpi.py -n "${XPI_NAME}-eff.xpi" -x ".build_exclusions" "pkg/xpi-eff"
 python2.7 utils/create_xpi.py -n "${XPI_NAME}-amo.xpi" -x ".build_exclusions" "pkg/xpi-amo"
 
-echo >&2 "Total included rules: `sqlite3 $RULESETS_SQLITE 'select count(*) from rulesets'`"
+echo >&2 "Total included rules: `find src/chrome/content/rules -name "*.xml" | wc -l`"
 echo >&2 "Rules disabled by default: `find src/chrome/content/rules -name "*.xml" | xargs grep -F default_off | wc -l`"
 echo >&2 "Created ${XPI_NAME}-eff.xpi and ${XPI_NAME}-amo.xpi"
 
diff --git a/src/chrome/content/code/HTTPSRules.js b/src/chrome/content/code/HTTPSRules.js
@@ -402,11 +402,16 @@ const HTTPSRules = {
     return;
   },
 
+  /**
+   * Read and parse the ruleset JSON.
+   * Note: This only parses the outer JSON wrapper. Each ruleset is itself an
+   * XML string, which will be parsed on an as-needed basis.
+   */
   loadTargets: function() {
     var file = new FileUtils.File(RuleWriter.chromeToPath("chrome://https-everywhere/content/rulesets.json"));
     var rules = JSON.parse(RuleWriter.read(file));
     this.targets = rules.targets;
-    this.rules_list = rules.rules_list;
+    this.rulesetStrings = rules.rulesetStrings;
   },
 
   checkMixedContentHandling: function() {
@@ -562,7 +567,7 @@ const HTTPSRules = {
 
   // Load a ruleset by numeric id, e.g. 234
   loadRulesetById: function(ruleset_id) {
-    RuleWriter.readFromString(this.rules_list[ruleset_id], this, ruleset_id);
+    RuleWriter.readFromString(this.rulesetStrings[ruleset_id], this, ruleset_id);
   },
 
   // Get all rulesets matching a given target, lazy-loading from DB as necessary.
diff --git a/utils/make-sqlite.py b/utils/make-sqlite.py
@@ -1,6 +1,9 @@
 #!/usr/bin/env python2.7
 #
-# Builds an sqlite DB containing all the rulesets, indexed by target.
+# Builds an sqlite DB and a JSON DB containing all the rulesets, indexed by target.
+# The sqlite DB is used by trivial-validate.py. The JSON DB is used by the
+# Firefox addon.
+#
 
 import glob
 import locale
@@ -37,7 +40,7 @@
               ruleset_id INTEGER)''')
 
 json_output = {
-    "rules_list": [],
+    "rulesetStrings": [],
     "targets": collections.defaultdict(list)
 }
 
@@ -99,8 +102,8 @@
         c.execute('''INSERT INTO targets (host, ruleset_id) VALUES(?, ?)''', (target, ruleset_id))
         # id is the current length of the rules list - i.e. the offset at which
         # this rule will be added in the list.
-        json_output["targets"][target].append(len(json_output["rules_list"]))
-    json_output["rules_list"].append(etree.tostring(tree))
+        json_output["targets"][target].append(len(json_output["rulesetStrings"]))
+    json_output["rulesetStrings"].append(etree.tostring(tree))
 
 conn.commit()
 conn.execute("VACUUM")
