X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fsource%2Fuser-manual.sgml;h=5a6e063064c962065ae61c5f15e57f08b5a1372e;hp=87f06d19248b22244f4782387510ec782c25fdc2;hb=653d134eb615d75976cd5ba73bba23db3838655e;hpb=04a7234f8b72d38913cc13a92c0706f070ca3f1b diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml index 87f06d19..5a6e0630 100644 --- a/doc/source/user-manual.sgml +++ b/doc/source/user-manual.sgml @@ -9,8 +9,10 @@ + + @@ -19,6 +21,7 @@ + ]> Debian - FIXME. + DEBs can be installed with dpkg -i + privoxy_&p-version;-1.deb, and will use + /etc/privoxy for the location of configuration + files. @@ -341,13 +347,13 @@ automatically start Privoxy in the boot process. and Privoxy configurations will need to be ported. The functionalities of the old blockfile, cookiefile and imagelist - are now combined into the actions - files. + are now combined into the actions + files. default.action, is the main actions file. Local exceptions should best be put into user.action. - A filter file (typically + A filter file (typically default.filter) is new as of Privoxy 2.9.x, and provides some of the new sophistication (explained below). config is much the same as before. @@ -391,10 +397,10 @@ automatically start Privoxy in the boot process. - The primary configuration file for cookie management, ad and banner + The primary configuration files for cookie management, ad and banner blocking, and many other aspects of Privoxy - configuration is in the actions - files. It is strongly recommended to become familiar with the new + configuration are the actions + files. It is strongly recommended to become familiar with the new actions concept below, before modifying these files. Locally defined rules should go into user.action. @@ -419,61 +425,87 @@ automatically start Privoxy in the boot process. - If upgrading, please back up any configuration files. See - the Note to Upgraders Section. - + If upgrading, from versions before 2.9.16, please back up any configuration + files. See the Note to Upgraders Section. + + Install Privoxy. See the Installation Section for platform specific + linkend="installation">Installation Section below for platform specific information. - Start Privoxy, if the installation program has - not done this already. See the section Starting - Privoxy. + Advanced users and those who want to offer Privoxy + service to more than just their local machine should check the main config file, especially the security-relevant options. These are + off by default. - Set your browser to use Privoxy as HTTP and HTTPS - proxy by setting the proxy configuration for address of - 127.0.0.1 and port 8118. - (Junkbuster and earlier versions of - Privoxy used port 8000.) See the section Starting Privoxy. + Start Privoxy, if the installation program has + not done this already (may vary according to platform). See the section + Starting Privoxy. + + + + + + Set your browser to use Privoxy as HTTP and + HTTPS proxy by setting the proxy configuration for address of + 127.0.0.1 and port 8118. + (Junkbuster and earlier versions of + Privoxy used port 8000.) See the section Starting Privoxy below + for more details on this. - Flush your browser's caches, to remove any cached ad images. + Flush your browser's disk and memory caches, to remove any cached ad images. - + - Enjoy surfing with enhanced comfort and privacy. You may want to customize the - user.action file to - personalize your new browsing experience. See the Configuration section for more configuration - options, and how to further customize your installation. + A default installation should provide a reasonable starting point for + most. There will undoubtedly be occasions where you will want to adjust the + configuration, but that can be dealt with as the need arises. Little + to no initial configuration is required in most cases. + + + See the Configuration section for more + configuration options, and how to customize your installation. + next section for a quick + introduction to how Privoxy blocks ads and + banners.]]> - + - If you experience problems with sites that misbehave, see - the Anatomy of an Action section in the - Appendix. + If you experience ads that slipped through, innocent images that are + blocked, or otherwise feel the need to fine-tune + Privoxy's behaviour, take a look at the actions files. As a quick start, you might + find the richly commented examples + helpful. You can also view and edit the actions files through the web-based user interface. The + Appendix Anatomy of an + Action has hints how to debug actions that + misbehave. - + Please see the section Contacting the @@ -482,11 +514,262 @@ automatically start Privoxy in the boot process. + + + Now enjoy surfing with enhanced comfort and privacy! + + + + + + + + + + +Quickstart to Ad Blocking + + + Ad blocking is but one of Privoxy's + array of features. Many of these features are for the technically minded advanced + user. But, ad and banner blocking is surely common ground for everybody. + + + This section will provide a quick summary of ad blocking so + you can get up to speed quickly without having to read the more extensive + information provided below, though this is highly recommeneded. + + + First a bit of a warning ... blocking ads is much like blocking SPAM: the + more aggressive you are about it, the more likely you are to block + things that were not intended. So there is a trade off here. If you want + extreme ad free browsing, be prepared to deal with more + problem sites, and to spend more time adjusting the + configuration to solve these unintended consequences. In short, there is + not an easy way to eliminate all ads. Either take + the easy way and settle for most ads blocked with the + default configuration, or jump in and tweak it for your personal surfing + habits and preferences. + + + Secondly, a brief explanation of Privoxy's + actions. Actions in this context, are + the directives we use to tell Privoxy to perform + some task relating to HTTP transactions (i.e. web browsing). We tell + Privoxy to take some action. Each + action has a unique name and function. While there are many potential + actions in Privoxy's + arsenal, only a few are used for ad blocking. Actions, and action + configuration files, are explained in depth below. + + + Actions are specified in Privoxy's configuration, + followed by one or more URLs to which the action should apply. URLs + can actually be URL type patterns that use + wildcards so they can apply potentially to a range of similar URLs. The + actions, together with the URL patterns are called a section. + + + When you connect to a website, the full URL will either match one or more + of the sections as defined in Privoxy's configuration, + or not. If so, then Privoxy will perform the + respective actions. If not, then nothing special happens. Futhermore, web + pages may contain embedded, secondary URLs that your web browser will + use to load additional components of the page, as it parses the + original page's HTML content. An ad image for instance, is just a URL + embedded in the page somewhere. The image itself may be on the same server, + or a server somewhere else on the Internet. Complex web pages will have many + such embedded URLs. + + + + The actions we need to know about for ad blocking are: block, handle-as-image, and + set-image-blocker: + + + + + + + + block - this action stops + any contact between your browser and any URL patterns that match this + action's configuration. It can be used for blocking ads, but also anything + that is determined to be unwanted. By itself, it simply stops any + communication with the remote server and sends Privoxy's + own built-in BLOCKED page instead to let you now what has happened. + + + + + + handle-as-image - + tells Privoxy to treat this URL as an image. + Privoxy's default configuration already does this + for all common image types (e.g. GIF), but there are many situations where this + is not as easy to determine. So we'll force it in these cases. This is particularly + important for ad blocking, since only if we know that it's an image, we can replace + it by an image instead of the BLOCKED page, which would only result in a + broken image icon. There are some limitations to this though. For + instance, you can't just brute-force an image substituion for an entire HTML page + in most situations. + + + + + + set-image-blocker - tells + Privoxy what to display in place of an ad image that + has hit a block rule. For this to come into play, the URL must match a + block action somewhere in the + configuration, and, it must also match an + handle-as-image action. + + + The configuration options on what to display instead of the ad are: + + + +    pattern - a checkboard pattern, so that an ad + replacement is obvious. This is the default. + + + + +    blank - A very small empty GIF image is displayed. + This is the so-called invisible configuration option. + + + + +    http://<URL> - A redirect to any image anywhere + of the user's choosing (advanced usage). + + + + + + + + + The quickest way to adjust any of these settings is with your browser through + the special Privoxy editor at http://config.privoxy.org/show-status + (shortcut: http://p.p/show-status). This + is an internal page, and does not require Internet access. Select the + appropriate actions file, and click + Edit. It is best to put personal or + local preferences in user.action since this is not + meant to be overwritten during upgrades, and will over-ride the settings in + other files. Here you can insert new actions, and URLs for ad + blocking or other purposes, and make other adjustments to the configuration. + Privoxy will detect these changes automatically. + + + + A quick and simple step by step example: + + + + + + + + Right click on the ad image to be blocked, then select + Copy Link Location from the + pop-up menu. + + + + + Set your browser to + http://config.privoxy.org/show-status + + + + + Find user.action in the top section, and click + on Edit: + + + + +
Actions Files in Use + + + + + + Screenshot of Files in Use + + +
+ + + + + + You should have a section with only + block listed under + Actions:. + If not, click a Insert new section below + button, and in the new section that just appeared, click the + Edit button right under the word Actions:. + This will bring up a list of all actions. Find + block near the top, and click + in the Enabled column, then Submit + just below the list. + + + + + Now, in the block actions section, + click the Add button, and paste the URL the + browser got from Copy Link Location. + Remove the http:// at the beginning of the URL. Then, click + Submit (or + OK if in a pop-up window). + + + + + Now go back to the original page, and press SHIFT-Reload + (or flush all browser caches). The image should be gone now. + + + + + This is a very crude and simple example. There might be good reasons to use a + wildcard pattern match to include potentially similar images from the same + site. For a more extensive explanation of patterns, and + the entire actions concept, see the Actions + section. + + + + For advanced users who want to hand edit their config files, you might want + to now go to the Actions Files Tutorial. + The ideas explained thererin also apply to the web-based editor. + + + + + + + Starting <application>Privoxy</application> @@ -523,12 +806,12 @@ automatically start Privoxy in the boot process. directory. Except on Win32 where it will try config.txt. - -RedHat, Conectiva and Debian + +RedHat and Conectiva We use a script. Note that RedHat does not start Privoxy upon booting per default. It will use the file /etc/privoxy/config as its -main configuration file. FIXME: Debian?? +main configuration file. @@ -537,6 +820,21 @@ main configuration file. FIXME: Debian?? + +Debian + + We use a script. Note that Debian starts Privoxy upon booting per + default. It will use the file + /etc/privoxy/config as its main configuration + file. + + + + # /etc/init.d/privoxy start + + + + SuSE @@ -1136,7 +1434,7 @@ actionsfile - Default value: + Default values: @@ -1189,7 +1487,7 @@ actionsfile Specifies: - The filter file to use + The filter file to use @@ -1210,7 +1508,7 @@ actionsfile No textual content filtering takes place, i.e. all - +filter{name} + +filter{name} actions in the actions files are turned neutral. @@ -1219,13 +1517,25 @@ actionsfile Notes: - The default.filter file contains content modification rules - that use regular expressions. These rules permit powerful - changes on the content of Web pages, e.g., you could disable your favorite + The filter file contains content modification + rules that use regular expressions. These rules permit + powerful changes on the content of Web pages, e.g., you could disable your favorite JavaScript annoyances, re-write the actual displayed text, or just have some fun replacing Microsoft with MicroSuck wherever it appears on a Web page. + + The + +filter{name} + actions rely on the relevant filter (name) + to be defined in the filter file! + + + A pre-defined filter file called default.filter that contains + a bunch of handy filters for common problems is included in the distribution. + See the section on the filter + action for a list. + @@ -1818,8 +2128,16 @@ actionsfile If you leave out the IP address, Privoxy will bind to all interfaces (addresses) on your machine and may become reachable - from the Internet. In that case, consider using access control lists (ACL's) - (see ACLs below), or a firewall. + from the Internet. In that case, consider using access control lists (ACL's, see below), and/or + a firewall. + + + If you open Privoxy to untrusted users, you will + also want to turn off the enable-edit-actions and + enable-remote-toggle + options! @@ -2005,8 +2323,8 @@ actionsfile ACLs: permit-access and deny-access - - + + @@ -2668,16 +2986,6 @@ forward-socks4 and forward-socks4a - - - standard.action - is used by the web based editor, - to set various pre-defined sets of rules for the default actions section - in default.action. These have increasing levels of - aggressiveness and have no influence on your browsing unless - you select them explicitly in the editor. It is not recommend - to edit this file. - - default.action - is the primary action file @@ -2697,6 +3005,16 @@ forward-socks4 and forward-socks4a thing should go here. This file will not be upgraded. + + + standard.action - is used by the web based editor, + to set various pre-defined sets of rules for the default actions section + in default.action. These have increasing levels of + aggressiveness and have no influence on your browsing unless + you select them explicitly in the editor. It is not recommend + to edit this file. + + @@ -2775,15 +3093,15 @@ forward-socks4 and forward-socks4a - + How Actions are Applied to URLs Actions files are divided into sections. There are special sections, - like the alias sections which will be discussed later. For now - let's concentrate on regular sections: They have a heading line (often split - up to multiple lines for readability) which consist of a list of actions, - separated by whitespace and enclosed in curly braces. Below that, there - is a list of URL patterns, each on a separate line. + like the alias sections which will + be discussed later. For now let's concentrate on regular sections: They have a + heading line (often split up to multiple lines for readability) which consist + of a list of actions, separated by whitespace and enclosed in curly braces. + Below that, there is a list of URL patterns, each on a separate line. @@ -2792,10 +3110,12 @@ forward-socks4 and forward-socks4a applicable actions for the URL is incrementally updated, using the heading of the section in which the pattern is located. If multiple matches for the same URL set the same action differently, the last match wins. If not, - the effects are aggregated (e.g. a URL might match both the - +handle-as-image - and +block actions). - + the effects are aggregated. E.g. a URL might match a regular section with + a heading line of { + +handle-as-image }, + then later another one with just { + +block }, resulting + in both actions to apply. @@ -2984,12 +3304,10 @@ forward-socks4 and forward-socks4a - Please also note that matching in the path is case - INSENSITIVE by default, but you can switch to case - sensitive at any point in the pattern by using the - (?-i) switch: - www.example.com/(?-i)PaTtErN.* will match only - documents whose path starts with PaTtErN in + Please also note that matching in the path is CASE INSENSITIVE + by default, but you can switch to case sensitive at any point in the pattern by using the + (?-i) switch: www.example.com/(?-i)PaTtErN.* will match + only documents whose path starts with PaTtErN in exactly this capitalization. @@ -3126,7 +3444,7 @@ forward-socks4 and forward-socks4a -<emphasis>add-header</emphasis> +add-header @@ -3190,7 +3508,7 @@ forward-socks4 and forward-socks4a -<emphasis>block</emphasis> +block @@ -3284,7 +3602,7 @@ forward-socks4 and forward-socks4a -<emphasis>crunch-incoming-cookies</emphasis> +crunch-incoming-cookies @@ -3353,7 +3671,7 @@ forward-socks4 and forward-socks4a -<emphasis>crunch-outgoing-cookies</emphasis> +crunch-outgoing-cookies @@ -3423,7 +3741,7 @@ forward-socks4 and forward-socks4a -<emphasis>deanimate-gifs</emphasis> +deanimate-gifs @@ -3491,7 +3809,7 @@ forward-socks4 and forward-socks4a -<emphasis>downgrade-http-version</emphasis> +downgrade-http-version @@ -3555,7 +3873,7 @@ problem-host.example.com -<emphasis>fast-redirects</emphasis> +fast-redirects @@ -3634,7 +3952,7 @@ problem-host.example.com -<emphasis>filter</emphasis> +filter @@ -3771,7 +4089,7 @@ problem-host.example.com -<emphasis>handle-as-image</emphasis> +handle-as-image @@ -3861,7 +4179,7 @@ ad.doubleclick.net -<emphasis>hide-forwarded-for-headers</emphasis> +hide-forwarded-for-headers @@ -3927,7 +4245,7 @@ ad.doubleclick.net -<emphasis>hide-from-header</emphasis> +hide-from-header @@ -3999,7 +4317,7 @@ ad.doubleclick.net -<emphasis>hide-referrer</emphasis> +hide-referrer @@ -4078,7 +4396,7 @@ ad.doubleclick.net -<emphasis>hide-user-agent</emphasis> +hide-user-agent @@ -4160,7 +4478,7 @@ ad.doubleclick.net -<emphasis>kill-popups<anchor id="kill-popup"></emphasis> +kill-popups<anchor id="kill-popup"> @@ -4215,7 +4533,7 @@ ad.doubleclick.net sense to combine it with any filter action, since as soon as one filter applies, the whole document needs to be buffered anyway, which destroys the advantage of - the kill-popups action over it's filter equivalent. + the kill-popups action over its filter equivalent. Killing all pop-ups is a dangerous business. Many shops and banks rely on @@ -4250,7 +4568,7 @@ ad.doubleclick.net -<emphasis>limit-connect</emphasis> +limit-connect @@ -4331,7 +4649,7 @@ ad.doubleclick.net -<emphasis>prevent-compression</emphasis> +prevent-compression @@ -4420,7 +4738,7 @@ www.pclinuxonline.com -<emphasis>send-vanilla-wafer</emphasis> +send-vanilla-wafer @@ -4486,7 +4804,7 @@ www.pclinuxonline.com -<emphasis>send-wafer</emphasis> +send-wafer @@ -4552,7 +4870,7 @@ my-internal-testing-server.void -<emphasis>session-cookies-only</emphasis> +session-cookies-only @@ -4633,7 +4951,7 @@ my-internal-testing-server.void -<emphasis>set-image-blocker</emphasis> +set-image-blocker @@ -4815,18 +5133,20 @@ my-internal-testing-server.void {{alias}} # These aliases just save typing later: + # (Note that some already use other aliases!) # +crunch-all-cookies = +crunch-incoming-cookies +crunch-outgoing-cookies -crunch-all-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies - +imageblock = +block +handle-as-image + block-as-image = +block +handle-as-image + mercy-for-cookies = -crunch-all-cookies -session-cookies-only # These aliases define combinations of actions # that are useful for certain types of sites: # fragile = -block -crunch-all-cookies -filter -fast-redirects -hide-referer -kill-popups - shop = -crunch-all-cookies -fast-redirects + shop = -crunch-all-cookies -filter{popups} -kill-popups - # Aliases defined from other aliases, for really lazy people ;-) + # Short names for other aliases, for really lazy people ;-) # c0 = +crunch-all-cookies c1 = -crunch-all-cookies @@ -4872,434 +5192,871 @@ my-internal-testing-server.void -Sample Actions Files +Actions Files Tutorial - Remember that the meaning of each action is reversed by preceding - the action with a -, in place of the +. Also, - that some actions are turned on in the default section of the actions file, - and require little to no additional configuration. These are just on. + The above chapters have shown which actions files + there are and how they are organized, how actions are specified and applied + to URLs, how patterns work, and how to + define and use aliases. Now, let's look at an + example default.action and user.action + file and see how all these pieces come together: +default.action + - But, other actions that are turned on in the default section do - typically require exceptions to be listed in the latter sections of - one of our actions file. For instance, by default no URLs are - blocked (i.e. in the default definitions of - default.action). We need exceptions to this in order to - enable ad blocking in the lower sections. But we need to - be very selective about what we do block. Thus, the default is off - for blocking. +Every config file should start with a short comment stating its purpose: - Below is a liberally commented sample default.action file - to demonstrate how all the pieces come together. And to show how exceptions - to the default policies can be handled. This is followed by a brief - user.action with similar examples. + # Sample default.action file <developers@privoxy.org> - - - -# Sample default.action file <developers@privoxy.org> +Then, since this is the default.action file, the +first section is a special section for internal use that you needn't +change or worry about: + + + +########################################################################## # Settings -- Don't change! For internal Privoxy use ONLY. +########################################################################## + {{settings}} -for-privoxy-version=3.0 +for-privoxy-version=3.0 + + +After that comes the (optional) alias section. We'll use the example +section from the above chapter on aliases, +that also explains why and how aliases are used: + + + ########################################################################## -# Aliases must be defined *before* they are used. These are -# easier to remember, and can combine several actions into one. Once -# defined they can be used just like any built-in action -- but within -# this file only! Aliases do not require a + or - sign. +# Aliases ########################################################################## {{alias}} -# Some useful aliases. -# Alias to turn off cookie handling, ie allow all cookies unmolested. +# These aliases just save typing later: +# (Note that some already use other aliases!) # -mercy-for-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies \ - -session-cookies-only ++crunch-all-cookies = +crunch-incoming-cookies +crunch-outgoing-cookies +-crunch-all-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies +block-as-image = +block +handle-as-image +mercy-for-cookies = -crunch-all-cookies -session-cookies-only -# Alias to both block and treat as if an image for ad blocking -# purposes. +# These aliases define combinations of actions +# that are useful for certain types of sites: # -+block-as-image = +block +handle-as-image +fragile = -block -crunch-all-cookies -filter -fast-redirects -hide-referer -kill-popups +shop = mercy-for-cookies -filter{popups} -kill-popups + + + + Now come the regular sections, i.e. sets of actions, accompanied + by URL patterns to which they apply. Remember all actions + are disabled when matching starts, so we have to explicitly + enable the ones we want. + + + + The first regular section is probably the most important. It has only + one pattern, /, but this pattern + matches all URLs.. Therefore, the + set of actions used in this default section will + be applied to all requests as a start. It can be partly or + wholly overridden by later matches further down this file, or in user.action, + but it will still be largely responsible for your overall browsing + experience. + + + + Again, at the start of matching, all actions are disabled, so there is + no real need to disable any actions here, but we will do that nonetheless, + to have a complete listing for your reference. (Remember: A + + preceding the action name enables the action, a - disables!). + Also note how this long line has been made more readable by splitting it into + multiple lines with line continuation. + + + + +########################################################################## +# "Defaults" section: +########################################################################## + { \ + -add-header \ + -block \ + -crunch-incoming-cookies \ + -crunch-outgoing-cookies \ + +deanimate-gifs \ + -downgrade-http-version \ + +fast-redirects \ + +filter{html-annoyances} \ + +filter{js-annoyances} \ + -filter{content-cookies} \ + +filter{popups} \ + +filter{webbugs} \ + -filter{refresh-tags} \ + -filter{fun} \ + +filter{nimda} \ + +filter{banners-by-size} \ + -filter{shockwave-flash} \ + -filter{crude-parental} \ + -handle-as-image \ + +hide-forwarded-for-headers \ + +hide-from-header{block} \ + +hide-referrer{forge} \ + -hide-user-agent \ + -kill-popups \ + -limit-connect \ + +prevent-compression \ + -send-vanilla-wafer \ + -send-wafer \ + +session-cookies-only \ + +set-image-blocker{pattern} \ + } + / # forward slash will match *all* potential URL patterns. + + + + The default behavior is now set. Note that some actions, like not hiding + the user agent, are part of a general policy that applies + universally and won't get any exceptions defined later. Other choices, + like not blocking (which is understandably the + default!) need exceptions, i.e. we need to specify explicitly what we + want to block in later sections. + We will also want to make exceptions from our general pop-up-killing, + and use our defined aliases for that. + + + + The first of our specialized sections is concerned with fragile + sites, i.e. sites that require minimum interference, because they are either + very complex or very keen on tracking you (and have mechanisms in place that + make them unusable for people who avoid being tracked). We will simply use + our pre-defined fragile alias instead of stating the list + of actions explicitly: + + + + +########################################################################## +# Exceptions for sites that'll break under the default action set: +########################################################################## -# Shops should be allowed to set persistent cookies +# "Fragile" Use a minimum set of actions for these sites (see alias above): +# +{ fragile } +.office.microsoft.com # surprise, surprise! +.windowsupdate.microsoft.com + + + + Shopping sites are not as fragile, but they typically + require cookies to log in, and pop-up windows for shopping + carts or item details. Again, we'll use a pre-defined alias: + + + + +# Shopping sites: # -shop = -filter mercy-for-cookies +{ shop } +.quietpc.com +.worldpay.com # for quietpc.com +.jungle.com +.scan.co.uk + + + + Then, there are sites which rely on pop-up windows (yuck!) to work. + Since we made pop-up-killing our default above, we need to make exceptions + now. Mozilla users, who + can turn on smart handling of unwanted pop-ups in their browsers, can + safely choose + -filter{popups} (and + -kill-popups) above + and hence don't need this section. Anyway, disabling an already disabled + action doesn't hurt, so we'll define our exceptions regardless of what was + chosen in the defaults section: + -# Fragile sites should receive minimum interference: + + +# These sites require pop-ups too :( # -fragile = -block -deanimate-gifs -fast-redirects -filter -hide-referer \ - mercy-for-cookies -kill-popups +{ -kill-popups -filter{popups} } +.dabs.com +.overclockers.co.uk +.deutsche-bank-24.de + + + + The fast-redirects + action, which we enabled per default above, breaks some sites. So disable + it for popular sites where we know it misbehaves: + + + + +{ -fast-redirects } +login.yahoo.com +edit.*.yahoo.com +.google.com +.altavista.com/.*(like|url|link):http +.altavista.com/trans.*urltext=http +.nytimes.com + + + + It is important that Privoxy knows which + URLs belong to images, so that if they are to + be blocked, a substitute image can be sent, rather than an HTML page. + Contacting the remote site to find out is not an option, since it + would destroy the loading time advantage of banner blocking, and it + would feed the advertisers (in terms of money and + information). We can mark any URL as an image with the handle-as-image action, + and marking all URLs that end in a known image file extension is a + good start: + + + +########################################################################## +# Images: ########################################################################## -# Matching starts here. Remember that at this time, all actions are -# disabled, so we need to explicitly enable the ones we want. + +# Define which file types will be treated as images, in case they get +# blocked further down this file: # -# We begin with "default" action settings, i.e. we define a set of actions -# for a pattern ("/") that matches all URLs. This default set will be -# applied to all requests as a start, and can be partly or wholly overridden -# by later matches further down this file, or in user.action. +{ +handle-as-image } +/.*\.(gif|jpe?g|png|bmp|ico)$ + + + + And then there are known banner sources. They often use scripts to + generate the banners, so it won't be visible from the URL that the + request is for an image. Hence we block them and + mark them as images in one go, with the help of our + block-as-image alias defined above. (We could of + course just as well use +block + +handle-as-image here.) + Remember that the type of the replacement image is chosen by the + set-image-blocker + action. Since all URLs have matched the default section with its + +set-image-blocker{pattern} + action before, it still applies and needn't be repeated: + + + + +# Known ad generators: # -# We will show all potential actions here whether they are enabled -# or not. We could omit any disabled action if we wanted, since all -# actions are 'off' by default anyway. Shown for completeness only. -# Actions are enabled if preceded by a '+', otherwise they are disabled -# (unless an alias has been defined without this). +{ block-as-image } +ar.atwola.com +.ad.doubleclick.net +.ad.*.doubleclick.net +.a.yimg.com/(?:(?!/i/).)*$ +.a[0-9].yimg.com/(?:(?!/i/).)*$ +bs*.gsanet.com +bs*.einets.com +.qkimg.net + + + + One of the most important jobs of Privoxy + is to block banners. A huge bunch of them are already blocked + by the filter{banners-by-size} + action, which we enabled above, and which deletes the references to banner + images from the pages while they are loaded, so the browser doesn't request + them anymore, and hence they don't need to be blocked here. But this naturally + doesn't catch all banners, and some people choose not to use filters, so we + need a comprehensive list of patterns for banner URLs here, and apply the + block action to them. + + + First comes a bunch of generic patterns, which do most of the work, by + matching typical domain and path name components of banners. Then comes + a list of individual patterns for specific sites, which is omitted here + to keep the example short: + + + + ########################################################################## - { \ - -add-header \ - -block \ - -deanimate-gifs \ - -downgrade-http-version \ - +fast-redirects \ - +filter{html-annoyances} \ - +filter{js-annoyances} \ - -filter{content-cookies} \ - -filter{popups} \ - +filter{webbugs} \ - -filter{refresh-tags} \ - -filter{fun} \ - +filter{nimda} \ - +filter{banners-by-size} \ - -filter{shockwave-flash} \ - -filter{crude-parental} \ - +hide-forwarded-for-headers \ - +hide-from-header{block} \ - -hide-referrer \ - -hide-user-agent \ - -handle-as-image \ - +set-image-blocker{pattern} \ - -limit-connect \ - +prevent-compression \ - -session-cookies-only \ - -crunch-outgoing-cookies \ - -crunch-incoming-cookies \ - -kill-popups \ - -send-vanilla-wafer \ - -send-wafer \ - } - / # forward slash will match *all* potential URL patterns. +# Block these fine banners: +########################################################################## +{ +block } + +# Generic patterns: +# +ad*. +.*ads. +banner?. +count*. +/.*count(er)?\.(pl|cgi|exe|dll|asp|php[34]?) +/(?:.*/)?(publicite|werbung|rekla(ma|me|am)|annonse|maino(kset|nta|s)?)/ + +# Site-specific patterns (abbreviated): +# +.hitbox.com + + + + You wouldn't believe how many advertisers actually call their banner + servers ads.company.com, or call the directory + in which the banners are stored simply banners. So the above + generic patterns are surprisingly effective. + + + But being very generic, they necessarily also catch URLs that we don't want + to block. The pattern .*ads. e.g. catches + nasty-ads.nasty-corp.com as intended, + but also downloads.sourcefroge.net or + adsl.some-provider.net. So here come some + well-known exceptions to the +block + section above. + + + Note that these are exceptions to exceptions from the default! Consider the URL + downloads.sourcefroge.net: Initially, all actions are deactivated, + so it wouldn't get blocked. Then comes the defaults section, which matches the + URL, but just deactivates the block + action once again. Then it matches .*ads., an exception to the + general non-blocking policy, and suddenly + +block applies. And now, it'll match + .*loads., where -block + applies, so (unless it matches again further down) it ends up + with no block action applying. + + + ########################################################################## -# Default behavior is now set. Now we will define some exceptions to our -# default action policies. +# Save some innocent victims of the above generic block patterns: ########################################################################## -# These sites are very complex and require very minimal interference. -# We'll disable most actions with our 'fragile' alias: - { fragile } - .office.microsoft.com # surprise, surprise! - .windowsupdate.microsoft.com +# By domain: +# +{ -block } +adv[io]*. # (for advogato.org and advice.*) +adsl. # (has nothing to do with ads) +ad[ud]*. # (adult.* and add.*) +.edu # (universities don't host banners (yet!)) +.*loads. # (downloads, uploads etc) +# By path: +# +/.*loads/ -# Shopping sites - not as fragile but require some special -# handling. We still want to block ads, and we will allow -# persistent cookies via the 'shop' alias: - { shop } - .quietpc.com - .worldpay.com # for quietpc.com - .jungle.com - .scan.co.uk +# Site-specific: +# +www.globalintersec.com/adv # (adv = advanced) +www.ugu.com/sui/ugu/adv + + + Filtering source code can have nasty side effects, + so make an exception for our friends at sourceforge.net, + and all paths with cvs in them. Note that + -filter + disables all filters in one fell swoop! + -# These sites require pop-ups too :( We'll combine our 'shop' -# alias with two other actions into one rule to allow all popups. - { shop -kill-popups -filter{popups} } - .dabs.com - .overclockers.co.uk + + +# Don't filter code! +# +{ -filter } +/.*cvs +.sourceforge.net + + + The actual default.action is of course more + comprehensive, but we hope this example made clear how it works. + -# The 'Fast-redirects' action breaks some sites. Disable this action -# for these known sensitive sites: - { -fast-redirects } - login.yahoo.com - edit.europe.yahoo.com - .google.com - .altavista.com/.*(like|url|link):http - .altavista.com/trans.*urltext=http - .nytimes.com + +user.action -# Define which file types will be treated as images. Important -# for ad blocking. - { +handle-as-image } - /.*\.(gif|jpe?g|png|bmp|ico) - - -# Now lets list some domains that are known ad generators. And -# our alias that we use here will block these as well as force -# them to be treated as images. This combination of actions is -# important for ad blocking. What the browser will show instead is -# determined by the setting of +set-image-blocker - { +imageblock } - ar.atwola.com - .ad.doubleclick.net - .a.yimg.com/(?:(?!/i/).)*$ - .a[0-9].yimg.com/(?:(?!/i/).)*$ - bs*.gsanet.com - bs*.einets.com - .qkimg.net - ad.*.doubleclick.net - - -# These will just simply be blocked. They will generate the BLOCKED -# banner page, if matched. Heavy use of wildcards and regular -# expressions in this example. Enable block action: - { +block } - ad*. - .*ads. - banner?. - count*. - /.*count(er)?\.(pl|cgi|exe|dll|asp|php[34]?) - /(?:.*/)?(publicite|werbung|rekla(ma|me|am)|annonse|maino(kset|nta|s)?)/ - .hitbox.com - - -# The above block section will probably inadvertently catch some -# sites we DO NOT want blocked via the wildcards and regular expressions. -# Now let's set exceptions to the exceptions so the good guys get better -# treatment. Disable block action: - { -block } - advogato.org - adsl. - ad[ud]*. - advice. -# Let's just trust all .edu top level domains. - .edu - www.ugu.com/sui/ugu/adv -# We'll need to access to path names containing 'download' - .*downloads. - /downloads/ -# 'adv' is for globalintersec and means advanced, not advertisement - www.globalintersec.com/adv - - -# Don't filter *anything* from our friends at sourceforge. -# Notice we don't have to name the individual filter -# identifiers -- we just turn them all off in one fell swoop. -# Disable all filters for this one site: - { -filter } - .sourceforge.net - - - + + So far we are painting with a broad brush by setting general policies, + which would be a reasonable starting point for many people. Now, + you'd maybe want to be more specific and have customized rules that + are more suitable to your personal habits and preferences. These would + be for narrowly defined situations like your ISP or your bank, and should + be placed in user.action, which is parsed after all other + actions files and hence has the last word, over-riding any previously + defined actions. user.action is also a + safe place for your personal settings, since + default.action is actively maintained by the + Privoxy developers and you'll probably want + to install updated versions from time to time. - So far we are painting with a broad brush by setting general policies. - The above would be a reasonable starting point for many situations. Now, - we want to be more specific and have customized rules that are more suitable - to our personal habits and preferences. These would be for narrowly defined - situations like your ISP or your bank, and should be placed in - user.action, which is parsed after all other - actions files and should not be clobbered by upgrades. So any settings here, - will have the last word and over-ride any previously defined actions. + So let's look at a few examples of things that one might typically do in + user.action: + + + - Now a few examples of some things that one might do with a - user.action file. + +# My user.action file. <fred@foobar.com> - + + As aliases are local to the actions + file that they are defined in, you can't use the ones from + default.action, unless you repeat them here: + - - - -# Sample user.action file. - -# Any aliases you want to use need to be re-defined here. -# Alias to turn off cookie handling, ie allow all cookies unmolested. - -crunch-all-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies \ - -session-cookies-only - -# Fragile sites should have the minimum changes: - fragile = -block -deanimate-gifs -fast-redirects -filter -hide-referer \ - -crunch-all-cookies -kill-popups - -# Allow persistent cookies for a few regular sites that we -# trust via our above alias. These will be saved from one browser session -# to the next. We are explicitly turning off any and all cookie handling, -# even though the crunch-*-cookies settings were disabled in our above -# default.action anyway. So cookies from these domains will come through -# unmolested. - { -crunch-all-cookies } - .sun.com - .yahoo.com - .msdn.microsoft.com - .redhat.com - - -# My ISP uses obnoxious self promoting images on many pages. -# Nuke them :) Note that +handle-as-image need not be specified, -# since all URLs ending in .gif will be tagged as images by the -# general rules in default.action anyway. - { +block } - www.my-isp-example.com/logo[0-9].gif - - -# Say the site where you do your home banking needs to open -# popup windows, but you have chosen to kill popups by -# default. This will allow it for your-example-bank.com: + +# (Re-)define aliases for this file: # - { -filter{popups} -kill-popups } - .my-example-bank.com +{{alias}} +-crunch-all-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies +mercy-for-cookies = -crunch-all-cookies -session-cookies-only +fragile = -block -crunch-all-cookies -filter -fast-redirects -hide-referer -kill-popups +shop = mercy-for-cookies -filter{popups} -kill-popups +allow-ads = -block -filter{banners-by-size} # (see below) + + + + Say you have accounts on some sites that you visit regularly, and + you don't want to have to log in manually each time. So you'd like + to allow persistent cookies for these sites. The + mercy-for-cookies alias defined above does exactly + that, i.e. it disables crunching of cookies in any direction, and + processing of cookies to make them temporary. + -# This site is delicate, and requires kid-glove -# treatment. - { fragile } - .forbes.com - - - + + +{ mercy-for-cookies } +sunsolve.sun.com +slashdot.org +.yahoo.com +.msdn.microsoft.com +.redhat.com - - + + Your bank needs popups and is allergic to some filter, but you don't + know which, so you disable them all: + + + +{ -filter -kill-popups } +.your-home-banking-site.com + + + While browsing the web with Privoxy you + noticed some ads that sneaked through, but you were too lazy to + report them through our fine and easy feedback + system, so you have added them here: + - + + +{ +block } +www.a-popular-site.com/some/unobvious/path +another.popular.site.net/more/junk/here/ + + + + Note that, assuming the banners in the above example have regular image + extensions (most do), + +handle-as-image + need not be specified, since all URLs ending in these extensions will + already have been tagged as images in the relevant section of + default.action by now. + + + + Then you noticed that the default configuration breaks Forbes Magazine, + but you were too lazy to find out which action is the culprit, and you + were again too lazy to give feedback, so + you just used the fragile alias on the site, and + -- whoa! -- it worked: + + + + +{ fragile } +.forbes.com + + + + You like the fun text replacements in default.filter, + but it is disabled in the distributed actions file. (My colleagues on the team just + don't have a sense of humour, that's why! ;-). So you'd like to turn it on in your private, + update-safe config, once and for all: + + + + +{ +filter{fun} } +/ # For ALL sites! + + + + Note that the above is not really a good idea: There are exceptions + to the filters in default.action for things that + really shouldn't be filtered, like code on CVS->Web interfaces. Since + user.action has the last word, these exceptions + won't be valid for the fun filtering specified here. + + + + Finally, you might think about how your favourite free websites are + funded, and find that they rely on displaying banner advertisements + to survive. So you might want to specifically allow banners for those + sites that you feel provide value to you: + + + + +{ allow-ads } +.sourceforge.net +.slashdot.org +.osdn.net + + + + Note that allow-ads has been aliased to + -block + -filter{banners-by-size} + above. + + + + + The Filter File + - Any web page can be dynamically modified with the filter file. This - modification can be removal, or re-writing, of any web page content, - including tags and non-visible content. The default filter file is - oddly enough default.filter, located in the config - directory. + All text substitutions that can be invoked through the + filter action + must first be defined in the filter file, which is typically + called default.filter and which can be + selected through the + filterfile config + option. - This is potentially a very powerful feature, and requires knowledge of both - regular expression and HTML in order create custom - filters. But, there are a number of useful filters included with - Privoxy for many common situations. + Typical reasons for doing such substitutions are to eliminate + common annoyances in HTML and JavaScript, such as pop-up windows, + exit consoles, crippled windows without navigation tools, the + infamous <BLINK> tag etc, to suppress images with certain + width and height attributes (standard banner sizes or web-bugs), + or just to have fun. The possibilities are endless. - The included example file is divided into sections. Each section begins - with the FILTER keyword, followed by the identifier - for that section, e.g. FILTER: webbugs. Each section performs - a similar type of filtering, such as html-annoyances. + Filtering works on any text-based document type, including plain + text, HTML, JavaScript, CSS etc. (all text/* + MIME types). Substitutions are made at the source level, so if + you want to roll your own filters, you should be + familiar with HTML syntax. - This file uses regular expressions to alter or remove any string in the - target page. The expressions can only operate on one line at a time. Some - examples from the included default default.filter: + Just like the actions files, the + filter file is organized in sections, which are called filters + here. Each filter consists of a heading line, that starts with the + keyword FILTER:, followed by + the filter's name, and a short (one line) + description of what it does. Below that line + come the jobs, i.e. lines that define the actual + text substitutions. By convention, the name of a filter + should describe what the filter eliminates. The + comment is used in the web-based + user interface. - Stop web pages from displaying annoying messages in the status bar by - deleting such references: + Once a filter called name has been defined + in the filter file, it can be invoked by using an action of the form + +filter{name} + in any actions file. + + + + A filter header line for a filter called foo could look + like this: - - - - FILTER: html-annoyances + FILTER: foo Replace all "foo" with "bar" + - # New browser windows should be resizeable and have a location and status - # bar. Make it so. - # - s/resizable="?(no|0)"?/resizable=1/ig s/noresize/yesresize/ig - s/location="?(no|0)"?/location=1/ig s/status="?(no|0)"?/status=1/ig - s/scrolling="?(no|0|Auto)"?/scrolling=1/ig - s/menubar="?(no|0)"?/menubar=1/ig + + Below that line, and up to the next header line, come the jobs that + define what text replacements the filter executes. They are specified + in a syntax that imitates Perl's + s/// operator. If you are familiar with Perl, you + will find this to be quite intuitive, and may want to look at the + PCRS man page + for the subtle differences to Perl behaviour. Most notably, the non-standard + option letter U is supported, which turns the default + to ungreedy matching. + - # The <BLINK> tag was a crime! - # - s*<blink>|</blink>**ig + + If you are new to regular expressions, you might want to take a look at + the Appendix on regular expressions, and + see the Perl + manual for + the + s/// operator's syntax and Perl-style regular + expressions in general. + The below examples might also help to get you started. + - # Is this evil? - # - #s/framespacing="?(no|0)"?//ig - #s/margin(height|width)=[0-9]*//gi - - - + + +Filter File Tutorial + + Now, let's complete our foo filter. We have already defined + the heading, but the jobs are still missing. Since all it does is to replace + foo with bar, there is only one (trivial) job + needed: - Just for kicks, replace any occurrence of Microsoft with - MicroSuck, and have a little fun with topical buzzwords: + s/foo/bar/ - - - - FILTER: fun + But wait! Didn't the comment say that all occurrences + of foo should be replaced? Our current job will only take + care of the first foo on each page. For global substitution, + we'll need to add the g option: + - s/microsoft(?!.com)/MicroSuck/ig + + s/foo/bar/g + - # Buzzword Bingo: - # - s/industry-leading|cutting-edge|award-winning/<font color=red><b>BINGO!</b></font>/ig - - - + + Our complete filter now looks like this: + + + FILTER: foo Replace all "foo" with "bar" +s/foo/bar/g - Kill those pesky little web-bugs: + Let's look at some real filters for more interesting examples. Here you see + a filter that protects against some common annoyances that arise from JavaScript + abuse. Let's look at its jobs one after the other: + - - - - # webbugs: Squish WebBugs (1x1 invisible GIFs used for user tracking) - FILTER: webbugs + +FILTER: js-annoyances Get rid of particularly annoying JavaScript abuse - s/<img\s+[^>]*?(width|height)\s*=\s*['"]?1\D[^>]*?(width|height)\s*=\s*['"]?1(\D[^>]*?)?>/<!-- Squished WebBug -->/sig - - - +# Get rid of JavaScript referrer tracking. Test page: http://www.randomoddness.com/untitled.htm +# +s|(<script.*)document\.referrer(.*</script>)|$1"Not Your Business!"$2|Usg + + Following the header line and a comment, you see the job. Note that it uses + | as the delimiter instead of /, because + the pattern contains a forward slash, which would otherwise have to be escaped + by a backslash (\). + - - -The <emphasis>+filter</emphasis> Action - Filters are enabled with the +filter action from within - one of the actions files. +filter requires one parameter, which - should match one of the section identifiers in the filter file itself. Example: + Now, let's examine the pattern: it starts with the text <script.* + enclosed in parentheses. Since the dot matches any character, and * + means: Match an arbitrary number of the element left of myself, this + matches <script, followed by any text, i.e. + it matches the whole page, from the start of the first <script> tag. - - +filter{html-annoyances} - + + That's more than we want, but the pattern continues: document\.referrer + matches only the exact string document.referrer. The dot needed to + be escaped, i.e. preceded by a backslash, to take away its + special meaning as a joker, and make it just a regular dot. So far, the meaning is: + Match from the start of the first <script> tag in a the page, up to, and including, + the text document.referrer, if both are present + in the page (and appear in that order). + - This would activate that particular filter. Similarly, +filter - can be turned off for selected sites as: - -filter{html-annoyances}. Remember - too, all actions are off by default, unless they are explicitly enabled in one - of the actions files. + But there's still more pattern to go. The next element, again enclosed in parentheses, + is .*</script>. You already know what .* + means, so the whole pattern translates to: Match from the start of the first <script> + tag in a page to the end of the last <script> tag, provided that the text + document.referrer appears somewhere in between. - + + This is still not the whole story, since we have ignored the options and the parentheses: + The portions of the page matched by sub-patterns that are enclosed in parentheses, will be + remembered and be available through the variables $1, $2, ... in + the substitute. The U option switches to ungreedy matching, which means + that the first .* in the pattern will only eat up all + text in between <script and the first occurrence + of document.referrer, and that the second .* will + only span the text up to the first </script> + tag. Furthermore, the s option says that the match may span + multiple lines in the page, and the g option again means that the + substitution is global. + + + + So, to summarize, the pattern means: Match all scripts that contain the text + document.referrer. Remember the parts of the script from + (and including) the start tag up to (and excluding) the string + document.referrer as $1, and the part following + that string, up to and including the closing tag, as $2. + + + + Now the pattern is deciphered, but wasn't this about substituting things? So + lets look at the substitute: $1"Not Your Business!"$2 is + easy to read: The text remembered as $1, followed by + "Not Your Business!" (including + the quotation marks!), followed by the text remembered as $2. + This produces an exact copy of the original string, with the middle part + (the document.referrer) replaced by "Not Your + Business!". + + + + The whole job now reads: Replace document.referrer by + "Not Your Business!" wherever it appears inside a + <script> tag. Note that this job won't break JavaScript syntax, + since both the original and the replacement are syntactically valid + string objects. The script just won't have access to the referrer + information anymore. + + + + We'll show you two other jobs from the JavaScript taming department, but + this time only point out the constructs of special interest: + + + + +# The status bar is for displaying link targets, not pointless blahblah +# +s/window\.status\s*=\s*['"].*?['"]/dUmMy=1/ig + + + + \s stands for whitespace characters (space, tab, newline, + carriage return, form feed), so that \s* means: zero + or more whitespace. The ? in .*? + makes this matching of arbitrary text ungreedy. (Note that the U + option is not set). The ['"] construct means: a single + or a double quote. + + + + So what does this job do? It replaces assignments of single- or double-quoted + strings to the window.status object with a dummy assignment + (using a variable name that is hopefully odd enough not to conflict with + real variables in scripts). Thus, it catches many cases where e.g. pointless + descriptions are displayed in the status bar instead of the link target when + you move your mouse over links. + + + +# Kill OnUnload popups. Yummy. Test: http://www.zdnet.com/zdsubs/yahoo/tree/yfs.html +# +s/(<body .*)onunload(.*>)/$1never$2/iU + + + + Including the + OnUnload + event binding in the HTML DOM was a CRIME. + When I close a browser window, I want it to close and die. Basta. + This job replaces the onunload attribute in + <body> tags with the dummy word never. + Note that the i option makes the pattern matching + case-insensitive. + + + + The last example is from the fun department: + + + + +FILTER: fun Fun text replacements + +# Spice the daily news: +# +s/microsoft(?!\.com)/MicroSuck/ig + + + + Note the (?!\.com) part (a so-called negative lookahead) + in the job's pattern, which means: Don't match, if the string + .com appears directly following microsoft + in the page. This prevents links to microsoft.com from being messed, while + still replacing the word everywhere else. + + + + +# Buzzword Bingo (example for extended regex syntax) +# +s* industry[ -]leading \ +| cutting[ -]edge \ +| award[ -]winning # Comments are OK, too! \ +| high[ -]performance \ +| solutions[ -]based \ +| unmatched \ +| unparalleled \ +| unrivalled \ +*<font color="red"><b>BINGO!</b></font> \ +*igx + + + + The x option in this job turns on extended syntax, and allows for + e.g. the liberal use of (non-interpreted!) whitespace for nicer formatting. + + + + You get the idea? + + @@ -5311,23 +6068,80 @@ fragile = -block -deanimate-gifs -fast-redirects -filter -hide-referer \ Templates - When Privoxy displays one of its internal - pages, such as a 404 Not Found error page - (Privoxy must be running for link to work as - intended), it uses the appropriate template. On Linux, BSD, and Unix, these - are located in /etc/privoxy/templates by default. These - may be customized, if desired. cgi-style.css is used to - control the HTML attributes (fonts, etc). + All Privoxy built-in pages, i.e. error pages such as the + 404 - No Such Domain + error page, the BLOCKED + page + and all pages of its web-based + user interface, are generated from templates. + (Privoxy must be running for the above links to work as + intended) + - The default - Blocked - (Privoxy needs to be running for page to - display) banner page with the bright red top banner, is called just - blocked. This may be customized or - replaced with something else if desired (not recommended for the casual - user). + These templates are stored in a subdirectory of the configuration + directory called templates. On unixish platforms, + this is typically + /etc/privoxy/templates/. + + + + The templates are basically normal HTML files, but with place-holders (called symbols + or exports), which Privoxy fills at run time. You can + edit the templates with a normal text editor, should you want to customize them. + (Not recommended for the casual user). Note that + just like in configuration files, lines starting with # are + ignored when the templates are filled in. + + + + The place-holders are of the form @name@, and you will + find a list of available symbols, which vary from template to template, + in the comments at the start of each file. Note that these comments are not + always accurate, and that it's probably best to look at the existing HTML + code to find out which symbols are supported and what they are filled in with. + + + + A special application of this substitution mechanism is to make whole + blocks of HTML code disappear when a specific symbol is set. We use this + for many purposes, one of them being to include the beta warning in all + our user interface (CGI) pages when Privoxy + in in an alpha or beta development stage: + + + + +<!-- @if-unstable-start --> + + ... beta warning HTML code goes here ... + +<!-- if-unstable-end@ --> + + + + If the "unstable" symbol is set, everything in between and including + @if-unstable-start and if-unstable-end@ + will disappear, leaving nothing but an empty comment: + + + + <!-- --> + + + + There's also an if-then-else construct and an #include + mechanism, but you'll sure find out if you are inclined to edit the + templates ;-) + + + + All templates refer to a style located at + http://config.privoxy.org/send-stylesheet. + This is, of course, locally served by Privoxy + and the source for it can be found and edited in the + cgi-style.css template. @@ -5373,6 +6187,13 @@ Requests &history; + +Authors + + &p-authors; + + + @@ -5395,30 +6216,29 @@ Requests Regular Expressions - Privoxy can use regular expressions - in various config files. Assuming support for pcre (Perl - Compatible Regular Expressions) is compiled in, which is the default. Such - configuration directives do not require regular expressions, but they can be - used to increase flexibility by matching a pattern with wild-cards against - URLs. + Privoxy uses Perl-style regular + expressions in its actions + files and filter file, + through the PCRE and + PCRS libraries. If you are reading this, you probably don't understand what regular expressions are, or what they can do. So this will be a very brief - introduction only. A full explanation would require a book ;-) + introduction only. A full explanation would require a book ;-) - Regular expressions is a way of matching one character - expression against another to see if it matches or not. One of the - expressions is a literal string of readable characters - (letter, numbers, etc), and the other is a complex string of literal - characters combined with wild-cards, and other special characters, called - meta-characters. The meta-characters have special meanings and - are used to build the complex pattern to be matched against. Perl Compatible - Regular Expressions is an enhanced form of the regular expression language - with backward compatibility. + Regular expressions provide a language to describe patterns that can be + run against strings of characters (letter, numbers, etc), to see if they + match the string or not. The patterns are themselves (sometimes complex) + strings of literal characters, combined with wild-cards, and other special + characters, called meta-characters. The meta-characters have + special meanings and are used to build complex patterns to be matched against. + Perl Compatible Regular Expressions are an especially convenient + dialect of the regular expression language. @@ -5505,14 +6325,6 @@ Requests - - - s/string1/string2/g - This is used to rewrite strings of text. - string1 is replaced by string2 in this - example. There must of course be a match on string1 first. - - - These are just some of the ones you are likely to use when matching URLs with Privoxy, and is a long way from a definitive @@ -5602,16 +6414,6 @@ Requests in the expression anywhere). - - s/microsoft(?!.com)/MicroSuck/i - This is - a substitution. MicroSuck will replace any occurrence of - microsoft. The i at the end of the expression - means ignore case. The (?!.com) means - the match should fail if microsoft is followed by - .com. In other words, this acts like a NOT - modifier. In case this is a hyperlink, we don't want to break it ;-). - - We are barely scratching the surface of regular expressions here so that you can understand the default Privoxy @@ -5626,6 +6428,11 @@ Requests http://www.perldoc.com/perl5.6/pod/perlre.html + + For information on regular expression based substititions and their applications + in filters, please see the filter file tutorial + in this manual. + @@ -5668,9 +6475,9 @@ Requests - Alternately, this may be reached at http://p.p/, but this - variation may not work as reliably as the above in some configurations. + There is a shortcut: http://p.p/ (But it + doesn't provide a fallback to a real page, in case the request is not + sent through Privoxy) @@ -5804,17 +6611,19 @@ Requests - Privoxy - Submit Filter Feedback + Privoxy - Submit Actions File Feedback + + + + + Privoxy - Why? - - - - Credit: The site which gave me the general idea for these bookmarklets is + Credit: The site which gave us the general idea for these bookmarklets is www.bookmarklets.com. They have more information about bookmarklets. @@ -5852,14 +6661,14 @@ Requests Next, Privoxy checks to see if the URL - matches any +block patterns. If + matches any +block patterns. If so, the URL is then blocked, and the remote web server will not be contacted. - +handle-as-image + +handle-as-image is then checked and if it does not match, an HTML BLOCKED page is sent back. Otherwise, if it does match, - an image is returned. The type of image depends on the setting of +set-image-blocker + an image is returned. The type of image depends on the setting of +set-image-blocker (blank, checkerboard pattern, or an HTTP redirect to an image elsewhere). @@ -5871,16 +6680,16 @@ Requests - If the URL pattern matches the +fast-redirects action, + If the URL pattern matches the +fast-redirects action, it is then processed. Unwanted parts of the requested URL are stripped. Now the rest of the client browser's request headers are processed. If any - of these match any of the relevant actions (e.g. +hide-user-agent, + of these match any of the relevant actions (e.g. +hide-user-agent, etc.), headers are suppressed or forged as determined by these actions and their parameters. @@ -5895,25 +6704,25 @@ Requests First, the server headers are read and processed to determine, among other things, the MIME type (document type) and encoding. The headers are then - filtered as determined by the - +crunch-incoming-cookies, - +session-cookies-only, - and +downgrade-http-version + filtered as deterimed by the + +crunch-incoming-cookies, + +session-cookies-only, + and +downgrade-http-version actions. - If the +kill-popups + If the +kill-popups action applies, and it is an HTML or JavaScript document, the popup-code in the response is filtered on-the-fly as it is received. - If a +filter - or +deanimate-gifs + If a +filter + or +deanimate-gifs action applies (and the document type fits the action), the rest of the page is read into memory (up to a configurable limit). Then the filter rules (from default.filter) are processed against the buffered @@ -5924,9 +6733,9 @@ Requests Privoxy back to your browser. - If neither +filter - or +deanimate-gifs + If neither +filter + or +deanimate-gifs matches, then Privoxy passes the raw data through to the client browser as it becomes available. @@ -5954,16 +6763,15 @@ Requests The way Privoxy applies - actions - and filters + actions and filters to any given URL can be complex, and not always so easy to understand what is happening. And sometimes we need to be able to see just what Privoxy is doing. Especially, if something Privoxy is doing is causing us a problem inadvertently. It can be a little daunting to look at the actions and filters files themselves, since they tend to be filled with - regular expressions whose consequences are not always - so obvious. + regular expressions whose consequences are not + always so obvious. @@ -5984,8 +6792,8 @@ Requests First, enter one URL (or partial URL) at the prompt, and then Privoxy will tell us how the current configuration will handle it. This will not - help with filtering effects (i.e. the +filter action) from + help with filtering effects (i.e. the +filter action) from the default.filter file since this is handled very differently and not so easy to trap! It also will not tell you about any other URLs that may be embedded within the URL you are testing. For instance, images @@ -6006,19 +6814,38 @@ Requests Matches for http://google.com: ---- File standard --- -(no matches in this file) - ---- File default --- - -{ -add-header -block +deanimate-gifs{last} -downgrade-http-version +fast-redirects - -filter{popups} -filter{fun} -filter{shockwave-flash} -filter{crude-parental} - +filter{html-annoyances} +filter{js-annoyances} +filter{content-cookies} - +filter{webbugs} +filter{refresh-tags} +filter{nimda} +filter{banners-by-size} - +hide-forwarded-for-headers +hide-from-header{block} +hide-referer{forge} - -hide-user-agent -handle-as-image +set-image-blocker{pattern} -limit-connect - +prevent-compression +session-cookies-only -crunch-outgoing-cookies - -crunch-incoming-cookies -kill-popups -send-vanilla-wafer -send-wafer } + In file: default.action [ View ] [ Edit ] + +{-add-header + -block + -crunch-outgoing-cookies + -crunch-incoming-cookies + +deanimate-gifs{last} + -downgrade-http-version + +fast-redirects + -filter{popups} + -filter{fun} + -filter{shockwave-flash} + -filter{crude-parental} + +filter{html-annoyances} + +filter{js-annoyances} + +filter{content-cookies} + +filter{webbugs} + +filter{refresh-tags} + +filter{nimda} + +filter{banners-by-size} + +hide-forwarded-for-headers + +hide-from-header{block} + +hide-referer{forge} + -hide-user-agent + -handle-as-image + -kill-popups + -limit-connect + +prevent-compression + -send-vanilla-wafer + -send-wafer + +session-cookies-only + +set-image-blocker{pattern} } / { -session-cookies-only } @@ -6027,14 +6854,14 @@ Requests { -fast-redirects } .google.com ---- File user --- +In file: user.action [ View ] [ Edit ] (no matches in this file) This tells us how we have defined our - actions, and + actions, and which ones match for our example, google.com. The first listing is any matches for the standard.action file. No hits at all here on standard. Then next is default, or @@ -6051,12 +6878,12 @@ Requests rules, and then list specific URLs (or patterns) that these exceptions would apply to. Last match wins. Just below this then are two explicit matches for .google.com. The first is negating our previous cookie setting, - which was for +session-cookies-only + which was for +session-cookies-only (i.e. not persistent). So we will allow persistent cookies for google. The second turns off any - +fast-redirects + +fast-redirects action, allowing this to take place unmolested. Note that there is a leading dot here -- .google.com. This will match any hosts and sub-domains, in the google.com domain also, such as @@ -6081,14 +6908,37 @@ Requests Final results: - -add-header -block +deanimate-gifs{last} -downgrade-http-version -fast-redirects - -filter{popups} -filter{fun} -filter{shockwave-flash} -filter{crude-parental} - +filter{html-annoyances} +filter{js-annoyances} +filter{content-cookies} - +filter{webbugs} +filter{refresh-tags} +filter{nimda} +filter{banners-by-size} - +hide-forwarded-for-headers +hide-from-header{block} +hide-referer{forge} - -hide-user-agent -handle-as-image +set-image-blocker{pattern} -limit-connect - +prevent-compression -session-cookies-only -crunch-outgoing-cookies - -crunch-incoming-cookies -kill-popups -send-vanilla-wafer -send-wafer + + -add-header + -block + -crunch-outgoing-cookies + -crunch-incoming-cookies + +deanimate-gifs{last} + -downgrade-http-version + -fast-redirects + -filter{popups} + -filter{fun} + -filter{shockwave-flash} + -filter{crude-parental} + +filter{html-annoyances} + +filter{js-annoyances} + +filter{content-cookies} + +filter{webbugs} + +filter{refresh-tags} + +filter{nimda} + +filter{banners-by-size} + +hide-forwarded-for-headers + +hide-from-header{block} + +hide-referer{forge} + -hide-user-agent + -handle-as-image + -kill-popups + -limit-connect + +prevent-compression + -send-vanilla-wafer + -send-wafer + -session-cookies-only + +set-image-blocker{pattern} @@ -6119,8 +6969,8 @@ Requests We'll just show the interesting part here, the explicit matches. It is matched three different times. Each as an +block +handle-as-image, which is the expanded form of one of our aliases that had been defined as: - +imageblock. (Aliases are defined in + +imageblock. (Aliases are defined in the first section of the actions file and typically used to combine more than one action.) @@ -6131,11 +6981,11 @@ Requests would also cover the first. No point in taking chances with these guys though ;-) Note that if you want an ad or obnoxious URL to be invisible, it should be defined as ad.doubleclick.net - is done here -- as both a +block + is done here -- as both a +block and an - +handle-as-image. + +handle-as-image. The custom alias +imageblock just simplifies the process and make it more readable. @@ -6150,13 +7000,34 @@ Requests Matches for http://www.rhapsodyk.net/adsl/HOWTO/: - { -add-header -block +deanimate-gifs -downgrade-http-version +fast-redirects - +filter{html-annoyances} +filter{js-annoyances} +filter{kill-popups} - +filter{webbugs} +filter{nimda} +filter{banners-by-size} +filter{hal} - +filter{fun} +hide-forwarded-for-headers +hide-from-header{block} - +hide-referer{forge} -hide-user-agent -handle-as-image +set-image-blocker{blank} - +prevent-compression +session-cookies-only -crunch-incoming-cookies - -crunch-outgoing-cookies +kill-popups -send-vanilla-wafer -send-wafer } + In file: default.action [ View ] [ Edit ] + + {-add-header + -block + -crunch-incoming-cookies + -crunch-outgoing-cookies + +deanimate-gifs + -downgrade-http-version + +fast-redirects + +filter{html-annoyances} + +filter{js-annoyances} + +filter{kill-popups} + +filter{webbugs} + +filter{nimda} + +filter{banners-by-size} + +filter{hal} + +filter{fun} + +hide-forwarded-for-headers + +hide-from-header{block} + +hide-referer{forge} + -hide-user-agent + -handle-as-image + +kill-popups + +prevent-compression + -send-vanilla-wafer + -send-wafer + +session-cookies-only + +set-image-blocker{blank} } / { +block +handle-as-image } @@ -6271,8 +7142,47 @@ Requests Temple Place - Suite 330, Boston, MA 02111-1307, USA. $Log: user-manual.sgml,v $ + Revision 1.121 2002/05/23 23:20:17 oes + - Changed more (all?) references to actions to the + style. + - Small fixes in the actions chapter + - Small clarifications in the quickstart to ad blocking + - Removed from s since the new doc CSS + renders them red (bad in TOC). + + Revision 1.120 2002/05/23 19:16:43 roro + Correct Debian specials (installation and startup). + + Revision 1.119 2002/05/22 17:17:05 oes + Added Security hint + + Revision 1.118 2002/05/21 04:54:55 hal9 + -New Section: Quickstart to Ad Blocking + -Reformat Actions Anatomy to match new CGI layout + + Revision 1.117 2002/05/17 13:56:16 oes + - Reworked & extended Templates chapter + - Small changes to Regex appendix + - #included authors.sgml into (C) and hist chapter + + Revision 1.116 2002/05/17 03:23:46 hal9 + Fixing merge conflict in Quickstart section. + + Revision 1.115 2002/05/16 16:25:00 oes + Extended the Filter File chapter & minor fixes + + Revision 1.114 2002/05/16 09:42:50 oes + More ulink->link, added some hints to Quickstart section + + Revision 1.113 2002/05/15 21:07:25 oes + Extended and further commented the example actions files + + Revision 1.112 2002/05/15 03:57:14 hal9 + Spell check. A few minor edits here and there for better syntax and + clarification. + Revision 1.111 2002/05/14 23:01:36 oes - Fixing the fixes + Fixing the fixes Revision 1.110 2002/05/14 19:10:45 oes Restored alphabetical order of actions