Set and make use of siteurl in testpages.adblockplus.org

[Ross]

Background

The testpages currently have hard coded urls in several places:

• The subscription link.
• The filters displayed under each test case.
• The filters contained inside of the subscription.

This means to test/develop the testpages you must redirect the testpages.adblockplus.org domain in your hosts file to your local machine and run the cms server on port 80.

It would be useful/easier if the base/site url was set in one place such as the settings.ini file.

What to change

• Add siteurl = https://testpages.adblockplus.org to settings.ini.
• Instead of hardcoding that elsewhere use the site_url variable: {{ site_url }}.
• Have abp-testcases-subscription.txt generated by the CMS too, instead of being a static file, so that the site_url variable can be used for it too.
• Revise the usage instructions, so that we no longer mention messing with the hosts file nor specifying port 80.

[Ross]

I've played around with various methods of doing this (such as a global python function, adding a jinja filter, using a macro) and in my opinion using a macro seems to be easiest.

A macro imported with context could access the config.get() function and then perform the string replace on the url.

[Ross]

I've tried to implement this several times. Getting URL's for use in the filters listed on the page as the documentation part/for copy paste is easy enough:

{% macro siteurl_full() -%}
  {{config.get("general", "siteurl")}}
{%- endmacro %}

{% macro siteurl_noprotocol() -%}
  {% set v = config.get("general", "siteurl").split('://') %}
  {{v[1]}}
{%- endmacro %}

{% from 'macros/siteurl' import siteurl_noprotocol with context %}
||{{siteurl_noprotocol()}}##.examplefilter

But I haven't been able to figure out how to use these in the subscription itself. Currently the subscription file is in /static/ which means it's just a non-transformed text file and the macro cannot be used there. I attmpted to make a "raw" template like so:

{{ body }}

and then have the subscription file like so:

template = raw

{% from 'macros/siteurl' import siteurl_noprotocol with context %}

[Adblock Plus 2.0]

! filters/blocking
||{{siteurl_noprotocol()}}/testcasefiles/blocking/addresscomplete/image.jpg
/testcasefiles/blocking/addresspart/abptestcasepath/
||{{siteurl_noprotocol()}}/testcasefiles/blocking/wildcard/*/image.jpg

However this still outputs with HTML and ABP refuses to accept it as a valid subscription file. I don't have enough cms project knowledge to figure out a way around this.

Essentially, what we want is the ability to output a text/.txt file that can use the macros to get the URL (I think). Although any solution that works is welcome.

[abpbot]

A commit referencing this issue has landed:
​Issue 6769 - Avoid hardcoding the URL