Skip to content

Commit

Permalink
Minor fixes to #545
Browse files Browse the repository at this point in the history
  • Loading branch information
@pyllyukko
pyllyukko committed Jul 8, 2023
1 parent 8e55d26 commit f2efa62
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 49 deletions.
91 changes: 45 additions & 46 deletions Makefile
View file
@@ -1,59 +1,58 @@
SHELL=/bin/bash

.PHONY: all
all: whatdoesitdo tests

.PHONY: FORCE
FORCE:

##### INSTALLATION METHODS #####

.PHONY: locked_user.js # generate a locked configuration file
locked_user.js: user.js
sed 's/^user_pref/lockPref/' $< >| locked_user.js
locked_user.js: user.js FORCE # generate a locked configuration file
sed 's/^user_pref/lockPref/' $< >| $@

.PHONY: systemwide_user.js # generate a system-wide configuration file
systemwide_user.js: user.js
sed 's/user_pref(/pref(/' $< >| systemwide_user.js
systemwide_user.js: user.js FORCE # generate a system-wide configuration file
sed 's/user_pref(/pref(/' $< >| $@

.PHONY: debian_locked.js # # generate a locked, system-wide configuration file
debian_locked.js: user.js
sed 's/^user_pref(\("[^"]\+"\),\s\+\([^)]\+\));\(\s*\/\/.*\)\?$$/pref(\1, \2, locked);/' $< >| debian_locked.js
debian_locked.js: user.js FORCE # generate a locked, system-wide configuration file
sed 's/^user_pref(\("[^"]\+"\),\s\+\([^)]\+\));\(\s*\/\/.*\)\?$$/pref(\1, \2, locked);/' $< >| $@

.PHONY: policies.json # generate policy file (https://github.com/mozilla/policy-templates/blob/master/README.md)
policies.json:
jq -n -M "{\"policies\": {\"OfferToSaveLogins\": false, \"DisableBuiltinPDFViewer\": true, \"DisablePocket\": true, \"DisableFormHistory\": true, \"SanitizeOnShutdown\": true, \"SearchBar\": \"separate\", \"DisableTelemetry\": true, \"Cookies\": {\"AcceptThirdParty\": \"never\", \"ExpireAtSessionEnd\": true}, \"EnableTrackingProtection\": {\"Value\": true}, \"PopupBlocking\": {\"Default\": true}, \"FlashPlugin\": {\"Default\": false}, \"DisableFirefoxStudies\": true}}" >| policies.json
policies.json: FORCE # generate policy file (https://github.com/mozilla/policy-templates/blob/master/README.md)
jq -n -M "{\"policies\": {\"OfferToSaveLogins\": false, \"DisableBuiltinPDFViewer\": true, \"DisablePocket\": true, \"DisableFormHistory\": true, \"SanitizeOnShutdown\": true, \"SearchBar\": \"separate\", \"DisableTelemetry\": true, \"Cookies\": {\"AcceptThirdParty\": \"never\", \"ExpireAtSessionEnd\": true}, \"EnableTrackingProtection\": {\"Value\": true}, \"PopupBlocking\": {\"Default\": true}, \"FlashPlugin\": {\"Default\": false}, \"DisableFirefoxStudies\": true}}" >| $@


##### TESTS #####
# Requirements: node-acorn shellcheck

.PHONY: tests # run all tests
tests: test-acorn test-shellcheck
.PHONY: tests
tests: test-acorn test-shellcheck # run all tests

.PHONY: test-acorn # validate user.js syntax
test-acorn:
.PHONY: test-acorn
test-acorn: # validate user.js syntax
acorn --silent user.js

.PHONY: test-shellcheck # check/lint shell scripts
test-shellcheck:
.PHONY: test-shellcheck
test-shellcheck: # check/lint shell scripts
shellcheck *.sh


##### DIFF GENERATION/COMPARISONS WIT UPSTREAM/TOR BROWSER #####

TBBBRANCH=tor-browser-68.8.0esr-9.5-1
.PHONY: diff-000-tor-browser.js # download Tor Browser custom configuration reference
diff-000-tor-browser.js:
wget -nv "https://gitweb.torproject.org/tor-browser.git/plain/browser/app/profile/firefox.js?h=$(TBBBRANCH)" -O 000-tor-browser.js
000-tor-browser.js: FORCE # download Tor Browser custom configuration reference
wget -nv "https://gitweb.torproject.org/tor-browser.git/plain/browser/app/profile/firefox.js?h=$(TBBBRANCH)" -O $@

PREF_REGEX = ^\(user_\)\?pref/s/^.*pref("\([^"]\+\)",\s*\([^)]\+\).*$$
.PHONY: diff-tbb # differences between values from this user.js and tor browser's values
diff-tbb: 000-tor-browser.js
.PHONY: diff-tbb
diff-tbb: 000-tor-browser.js # differences between values from this user.js and tor browser's values
diff <(sed -n '/$(PREF_REGEX)/\1 = \2/p' user.js | sort) <(sed -n '/$(PREF_REGEX)/\1 = \2/p' $< | sort)

.PHONY: diff-tbb-2 # differences between values from this user.js and tor browser's values (alternate method)
diff-tbb-2: 000-tor-browser.js
.PHONY: diff-tbb-2
diff-tbb-2: 000-tor-browser.js # differences between values from this user.js and tor browser's values (alternate method)
for setting in $$( comm -12 <(sed -n '/$(PREF_REGEX)/\1/p' user.js | sort) <(sed -n '/$(PREF_REGEX)/\1/p' $< | sort)); do diff <(grep "^\(user_\)\?pref(\"$${setting}\"" user.js | sed -n '/$(regex)/\1 = \2/p' | sort) <(grep "^\(user_\)\?pref(\"$${setting}\"" $< | sed -n '/$(regex)/\1 = \2/p' | sort); done

.PHONY: diff-tbb-missing-from-user.js # preferences that are present in tor browser's defaults, but not in this user.js
diff-tbb-missing-from-user.js: 000-tor-browser.js
.PHONY: diff-tbb-missing-from-user.js
diff-tbb-missing-from-user.js: 000-tor-browser.js # preferences that are present in tor browser's defaults, but not in this user.js
comm -13 <(sed -n '/$(PREF_REGEX)/\1/p' user.js | sort) <(sed -n '/$(PREF_REGEX)/\1/p' $< | sort)

# specify wanted Firefox version/revision below (eg. "tip", "FIREFOX_AURORA_45_BASE", "9577ddeaafd85554c2a855f385a87472a089d5c0"). See https://hg.mozilla.org/mozilla-central/tags
Expand All @@ -71,57 +70,57 @@ FIREFOX_SOURCE_PREFS= \
https://hg.mozilla.org/mozilla-central/raw-file/tip/browser/branding/aurora/pref/firefox-branding.js \
https://hg.mozilla.org/mozilla-central/raw-file/tip/browser/locales/en-US/firefox-l10n.js \
https://hg.mozilla.org/mozilla-central/raw-file/tip/browser/app/profile/channel-prefs.js
.PHONY: diff-sourceprefs.js # download and sort all known preferences files from Firefox (mozilla-central) source
diff-sourceprefs.js:
.PHONY: diff-sourceprefs.js
diff-sourceprefs.js: # download and sort all known preferences files from Firefox (mozilla-central) source
@for SOURCEFILE in $(FIREFOX_SOURCE_PREFS); do wget -nv "$$SOURCEFILE" -O - ; done | egrep "(^pref|^user_pref)" | sort --unique >| sourceprefs.js

.PHONY: diff-upstream-duplicates # preferences with common values with default Firefox configuration
diff-upstream-duplicates: diff-sourceprefs.js
.PHONY: diff-upstream-duplicates
diff-upstream-duplicates: diff-sourceprefs.js # preferences with common values with default Firefox configuration
@sed 's/^pref(/user_pref(/' sourceprefs.js | sed -E "s/[[:space:]]+/ /g" | sort > sourceprefs_sorted.js
@grep "^user_pref" user.js | sed -E "s/[[:space:]]+/ /g" | sort > userjs_sorted.js
@comm -1 -2 sourceprefs_sorted.js userjs_sorted.js

.PHONY: diff-upstream-missing-from-user.js # preferences present in firefox source but not covered by user.js
diff-upstream-missing-from-user.js: diff-sourceprefs.js
.PHONY: diff-upstream-missing-from-user.js
diff-upstream-missing-from-user.js: diff-sourceprefs.js # preferences present in firefox source but not covered by user.js
# configure ignored preferences in ignore.list
@SOURCE_PREFS=$$(egrep '(^pref|^user_pref)' $< | awk -F'"' '{print $$2}'); \
for SOURCE_PREF in $$SOURCE_PREFS; do \
grep "\"$$SOURCE_PREF\"" user.js ignore.list >/dev/null || echo "Not covered by user.js : $$SOURCE_PREF"; \
done | sort --unique

.PHONY: diff-upstream-deprecated # preferences in hardened user.js that are no longer present in firefox source
diff-upstream-deprecated: diff-sourceprefs.js
.PHONY: diff-upstream-deprecated
diff-upstream-deprecated: diff-sourceprefs.js # preferences in hardened user.js that are no longer present in firefox source
@HARDENED_PREFS=$$(egrep "^user_pref" user.js | cut -d'"' -f2); \
for HARDENED_PREF in $$HARDENED_PREFS; do \
grep "\"$$HARDENED_PREF\"" $< >/dev/null || echo "Deprecated : $$HARDENED_PREF"; \
done | sort --unique

.PHONY: diff-stats # count preferences number, various stats
diff-stats: diff-sourceprefs.js
.PHONY: diff-stats
diff-stats: diff-sourceprefs.js # count preferences number, various stats
@echo "$$(egrep "^user_pref" user.js | wc -l | cut -f1) preferences in user.js"
@echo "$$(wc -l $< | cut -d" " -f1) preferences in Firefox source"


##### MISC #####

.PHONY: clean # clean automatically generated files/build/test artifacts
clean:
.PHONY: clean
clean: # clean automatically generated files/build/test artifacts
@rm -f sourceprefs.js sourceprefs_sorted.js userjs_sorted.js 000-tor-browser.js debian_locked.js systemwide_user.js

##### DOCUMENTATION GENERATION #####

.PHONY: doc-whatdoesitdo # generate the README "What does it do?" section
doc-whatdoesitdo:
.PHONY: doc-whatdoesitdo
doc-whatdoesitdo: # generate the README "What does it do?" section
@./gen-readme.sh

.PHONY: doc-toc # generate the README table of contents
doc-toc:
.PHONY: doc-toc
doc-toc: # generate the README table of contents
@l2headers=$$(egrep "^## " README.md |cut -d" " -f1 --complement ); \
echo "$$l2headers" | while read line; do \
anchor=$$(echo "$$line" | tr '[:upper:]' '[:lower:]' | sed 's/ /-/g' | sed 's/\?//g'); \
echo "* [$$line](#$$anchor)"; \
done

.PHONY: help # generate list of targets with descriptions
help:
@grep '^.PHONY: .* #' Makefile | sed 's/\.PHONY: \(.*\) # \(.*\)/\1 \2/' | expand -t20
.PHONY: help
help: # generate list of targets with descriptions
@sed -n '/^[a-z0-9]/s/^\(.\+\):.*\s\+#\s\+\(.\+\)$$/\1\t\2/p' $(MAKEFILE_LIST) | expand -t20
5 changes: 2 additions & 3 deletions README.md
View file
Expand Up @@ -613,13 +613,12 @@ Run `make help` to get a list of makefile targets used for frequent maintenance
$ make help
locked_user.js generate a locked configuration file
systemwide_user.js generate a system-wide configuration file
debian_locked.js # generate a locked, system-wide configuration file
debian_locked.js generate a locked, system-wide configuration file
policies.json generate policy file (https://github.com/mozilla/policy-templates/blob/master/README.md)
tests run all tests
test-acorn validate user.js syntax
test-bash-syntax check syntax of all bash scripts
test-shellcheck check/lint shell scripts
diff-000-tor-browser.js download Tor Browser custom configuration reference
000-tor-browser.js download Tor Browser custom configuration reference
diff-tbb differences between values from this user.js and tor browser's values
diff-tbb-2 differences between values from this user.js and tor browser's values (alternate method)
diff-tbb-missing-from-user.js preferences that are present in tor browser's defaults, but not in this user.js
Expand Down

0 comments on commit f2efa62

Please sign in to comment.