Opened 7 years ago

Closed 7 years ago

#5237 closed enhancement (fixed)

Show rulesets and what file they originate from in the web browser

Reported by: frak Owned by: pde
Priority: Medium Milestone:
Component: HTTPS Everywhere/EFF-HTTPS Everywhere Version:
Severity: Keywords:
Cc: nullishzero@… Actual Points:
Parent ID: Points:
Reviewer: Sponsor:

Description

I'm using the current development version (2.0development.6) and this doesn't appear to have been implemented yet.

I think it would be useful if, when you click a ruleset name in the HTTPS Everywhere Preferences window, the ruleset would be displayed in a resizeable lower pane.

Since rulesets are more complex than http->https, this is the only way to know what a given ruleset actually does.

One can dig the ruleset out of the appropriate file, or look it up in the git repository, but being able to view it immediately in the browser is more efficient.

The rulesets also come from multiple different files in different places, so it would be helpful to display the pathname to the file a particular ruleset comes from in the lower pane as well. At the moment, if you didn't remember where it was from, you'd have to check every file in your rulesets directories until you found it.

Child Tickets

Change History (3)

comment:1 Changed 7 years ago by pde

We'd be happy to take patches to implement this.  One thing that will make implementation tricky is that our .xpi files no longer contain the original rulesets in their source form.  In order to keep the .xpi file smaller, they're piled into default.rulesets, and they have comments stripped out at build time.

So an implementation could attempt to reconstruct the human-legible XML.  But it might actually be better to obtain the ruleset from a cleverly constructed URL at gitweb.torproject.org that fetches the version of the file from the current build's tag.

comment:2 Changed 7 years ago by nullishzero

Cc: nullishzero@… added

I am currently working on a patch for this, and my idea for a possible solution looks like this: http://i.imgur.com/A1XTd.jpg

I made the makexpi script include filename.xml for each ruleset into the default.rulesets, which does unfortunately bloat the .xpi a bit. Also, I use .git/refs/heads/master during makexpi to get the current branch information. If the branch doesn't exist in the official repository (e.g. the project is newer than the official source or it is a fork), then the program will use the HEAD tag to pull the XML file.

Here is my code so far: https://github.com/nullishzero/https-everywhere

comment:3 Changed 7 years ago by pde

Resolution: fixed
Status: newclosed

This has been merged and is about to be released in 3.0development.1

Note: See TracTickets for help on using tickets.