doc/webserver/user-manual/appendix.html

   1 <HTML
   2 ><HEAD
   3 ><TITLE
   4 >Appendix</TITLE
   5 ><META
   6 NAME="GENERATOR"
   7 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
   8 "><LINK
   9 REL="HOME"
  10 TITLE="Privoxy 3.0.6 User Manual"
  11 HREF="index.html"><LINK
  12 REL="PREVIOUS"
  13 TITLE="See Also"
  14 HREF="seealso.html"><LINK
  15 REL="STYLESHEET"
  16 TYPE="text/css"
  17 HREF="../p_doc.css">
  18 <LINK REL="STYLESHEET" TYPE="text/css" HREF="p_doc.css">
  19 </head
  20 ><BODY
  21 CLASS="SECT1"
  22 BGCOLOR="#EEEEEE"
  23 TEXT="#000000"
  24 LINK="#0000FF"
  25 VLINK="#840084"
  26 ALINK="#0000FF"
  27 ><DIV
  28 CLASS="NAVHEADER"
  29 ><TABLE
  30 SUMMARY="Header navigation table"
  31 WIDTH="100%"
  32 BORDER="0"
  33 CELLPADDING="0"
  34 CELLSPACING="0"
  35 ><TR
  36 ><TH
  37 COLSPAN="3"
  38 ALIGN="center"
  39 >Privoxy 3.0.6 User Manual</TH
  40 ></TR
  41 ><TR
  42 ><TD
  43 WIDTH="10%"
  44 ALIGN="left"
  45 VALIGN="bottom"
  46 ><A
  47 HREF="seealso.html"
  48 ACCESSKEY="P"
  49 >Prev</A
  50 ></TD
  51 ><TD
  52 WIDTH="80%"
  53 ALIGN="center"
  54 VALIGN="bottom"
  55 ></TD
  56 ><TD
  57 WIDTH="10%"
  58 ALIGN="right"
  59 VALIGN="bottom"
  60 >&nbsp;</TD
  61 ></TR
  62 ></TABLE
  63 ><HR
  64 ALIGN="LEFT"
  65 WIDTH="100%"></DIV
  66 ><DIV
  67 CLASS="SECT1"
  68 ><H1
  69 CLASS="SECT1"
  70 ><A
  71 NAME="APPENDIX"
  72 ></A
  73 >14. Appendix</H1
  74 ><DIV
  75 CLASS="SECT2"
  76 ><H2
  77 CLASS="SECT2"
  78 ><A
  79 NAME="REGEX"
  80 ></A
  81 >14.1. Regular Expressions</H2
  82 ><P
  83 > <SPAN
  84 CLASS="APPLICATION"
  85 >Privoxy</SPAN
  86 > uses Perl-style <SPAN
  87 CLASS="QUOTE"
  88 >"regular
  89  expressions"</SPAN
  90 > in its <A
  91 HREF="actions-file.html"
  92 >actions
  93  files</A
  94 > and <A
  95 HREF="filter-file.html"
  96 >filter file</A
  97 >,
  98  through the <A
  99 HREF="http://www.pcre.org/"
 100 TARGET="_top"
 101 >PCRE</A
 102 > and
 103  <SPAN
 104 CLASS="APPLICATION"
 105 >PCRS</SPAN
 106 > libraries.</P
 107 ><P
 108 > If you are reading this, you probably don't understand what <SPAN
 109 CLASS="QUOTE"
 110 >"regular
 111  expressions"</SPAN
 112 > are, or what they can do. So this will be a very brief
 113  introduction only. A full explanation would require a <A
 114 HREF="http://www.oreilly.com/catalog/regex/"
 115 TARGET="_top"
 116 >book</A
 117 > ;-)</P
 118 ><P
 119 > Regular expressions provide a language to describe patterns that can be
 120  run against strings of characters (letter, numbers, etc), to see if they
 121  match the string or not. The  patterns are themselves (sometimes complex)
 122  strings of literal characters, combined with  wild-cards, and other special
 123  characters, called meta-characters. The <SPAN
 124 CLASS="QUOTE"
 125 >"meta-characters"</SPAN
 126 > have
 127  special meanings and are used to build complex patterns to be matched against.
 128  Perl Compatible Regular Expressions are an especially convenient
 129  <SPAN
 130 CLASS="QUOTE"
 131 >"dialect"</SPAN
 132 > of the regular expression language.</P
 133 ><P
 134 > To make a simple analogy, we do something similar when we use wild-card
 135  characters when listing files with the <B
 136 CLASS="COMMAND"
 137 >dir</B
 138 > command in DOS.
 139  <TT
 140 CLASS="LITERAL"
 141 >*.*</TT
 142 > matches all filenames. The <SPAN
 143 CLASS="QUOTE"
 144 >"special"</SPAN
 145 >
 146  character here is the asterisk which matches any and all characters. We can be
 147  more specific and use <TT
 148 CLASS="LITERAL"
 149 >?</TT
 150 > to match just individual
 151  characters. So <SPAN
 152 CLASS="QUOTE"
 153 >"dir file?.text"</SPAN
 154 > would match
 155  <SPAN
 156 CLASS="QUOTE"
 157 >"file1.txt"</SPAN
 158 >, <SPAN
 159 CLASS="QUOTE"
 160 >"file2.txt"</SPAN
 161 >, etc. We are pattern
 162  matching, using a similar technique to <SPAN
 163 CLASS="QUOTE"
 164 >"regular expressions"</SPAN
 165 >!</P
 166 ><P
 167 > Regular expressions do essentially the same thing, but are much, much more
 168  powerful. There are many more <SPAN
 169 CLASS="QUOTE"
 170 >"special characters"</SPAN
 171 > and ways of
 172  building complex patterns however. Let's look at a few of the common ones,
 173  and then some examples:</P
 174 ><P
 175 ><P
 176 ></P
 177 ><TABLE
 178 BORDER="0"
 179 ><TBODY
 180 ><TR
 181 ><TD
 182 >  <SPAN
 183 CLASS="emphasis"
 184 ><I
 185 CLASS="EMPHASIS"
 186 >.</I
 187 ></SPAN
 188 > - Matches any single character, e.g. <SPAN
 189 CLASS="QUOTE"
 190 >"a"</SPAN
 191 >,
 192   <SPAN
 193 CLASS="QUOTE"
 194 >"A"</SPAN
 195 >, <SPAN
 196 CLASS="QUOTE"
 197 >"4"</SPAN
 198 >, <SPAN
 199 CLASS="QUOTE"
 200 >":"</SPAN
 201 >, or <SPAN
 202 CLASS="QUOTE"
 203 >"@"</SPAN
 204 >.
 205  </TD
 206 ></TR
 207 ></TBODY
 208 ></TABLE
 209 ><P
 210 ></P
 211 ></P
 212 ><P
 213 ><P
 214 ></P
 215 ><TABLE
 216 BORDER="0"
 217 ><TBODY
 218 ><TR
 219 ><TD
 220 >  <SPAN
 221 CLASS="emphasis"
 222 ><I
 223 CLASS="EMPHASIS"
 224 >?</I
 225 ></SPAN
 226 > - The preceding character or expression is matched ZERO or ONE
 227   times. Either/or.
 228  </TD
 229 ></TR
 230 ></TBODY
 231 ></TABLE
 232 ><P
 233 ></P
 234 ></P
 235 ><P
 236 ><P
 237 ></P
 238 ><TABLE
 239 BORDER="0"
 240 ><TBODY
 241 ><TR
 242 ><TD
 243 >  <SPAN
 244 CLASS="emphasis"
 245 ><I
 246 CLASS="EMPHASIS"
 247 >+</I
 248 ></SPAN
 249 > - The preceding character or expression is matched ONE or MORE
 250   times.
 251  </TD
 252 ></TR
 253 ></TBODY
 254 ></TABLE
 255 ><P
 256 ></P
 257 ></P
 258 ><P
 259 ><P
 260 ></P
 261 ><TABLE
 262 BORDER="0"
 263 ><TBODY
 264 ><TR
 265 ><TD
 266 >  <SPAN
 267 CLASS="emphasis"
 268 ><I
 269 CLASS="EMPHASIS"
 270 >*</I
 271 ></SPAN
 272 > - The preceding character or expression is matched ZERO or MORE
 273   times.
 274  </TD
 275 ></TR
 276 ></TBODY
 277 ></TABLE
 278 ><P
 279 ></P
 280 ></P
 281 ><P
 282 ><P
 283 ></P
 284 ><TABLE
 285 BORDER="0"
 286 ><TBODY
 287 ><TR
 288 ><TD
 289 >  <SPAN
 290 CLASS="emphasis"
 291 ><I
 292 CLASS="EMPHASIS"
 293 >\</I
 294 ></SPAN
 295 > - The <SPAN
 296 CLASS="QUOTE"
 297 >"escape"</SPAN
 298 > character denotes that
 299   the following character should be taken literally. This is used where one of the
 300   special characters (e.g. <SPAN
 301 CLASS="QUOTE"
 302 >"."</SPAN
 303 >) needs to be taken literally and
 304   not as a special meta-character. Example: <SPAN
 305 CLASS="QUOTE"
 306 >"example\.com"</SPAN
 307 >, makes
 308   sure the period is recognized only as a period (and not expanded to its
 309   meta-character meaning of any single character).
 310  </TD
 311 ></TR
 312 ></TBODY
 313 ></TABLE
 314 ><P
 315 ></P
 316 ></P
 317 ><P
 318 ><P
 319 ></P
 320 ><TABLE
 321 BORDER="0"
 322 ><TBODY
 323 ><TR
 324 ><TD
 325 >  <SPAN
 326 CLASS="emphasis"
 327 ><I
 328 CLASS="EMPHASIS"
 329 >[ ]</I
 330 ></SPAN
 331 > - Characters enclosed in brackets will be matched if
 332   any of the enclosed characters are encountered. For instance, <SPAN
 333 CLASS="QUOTE"
 334 >"[0-9]"</SPAN
 335 >
 336   matches any numeric digit (zero through nine). As an example, we can combine
 337   this with <SPAN
 338 CLASS="QUOTE"
 339 >"+"</SPAN
 340 > to match any digit one of more times: <SPAN
 341 CLASS="QUOTE"
 342 >"[0-9]+"</SPAN
 343 >.
 344  </TD
 345 ></TR
 346 ></TBODY
 347 ></TABLE
 348 ><P
 349 ></P
 350 ></P
 351 ><P
 352 ><P
 353 ></P
 354 ><TABLE
 355 BORDER="0"
 356 ><TBODY
 357 ><TR
 358 ><TD
 359 >  <SPAN
 360 CLASS="emphasis"
 361 ><I
 362 CLASS="EMPHASIS"
 363 >( )</I
 364 ></SPAN
 365 > - parentheses are used to group a sub-expression,
 366   or multiple sub-expressions.
 367  </TD
 368 ></TR
 369 ></TBODY
 370 ></TABLE
 371 ><P
 372 ></P
 373 ></P
 374 ><P
 375 ><P
 376 ></P
 377 ><TABLE
 378 BORDER="0"
 379 ><TBODY
 380 ><TR
 381 ><TD
 382 >  <SPAN
 383 CLASS="emphasis"
 384 ><I
 385 CLASS="EMPHASIS"
 386 >|</I
 387 ></SPAN
 388 > - The <SPAN
 389 CLASS="QUOTE"
 390 >"bar"</SPAN
 391 > character works like an
 392   <SPAN
 393 CLASS="QUOTE"
 394 >"or"</SPAN
 395 > conditional statement. A match is successful if the
 396   sub-expression on either side of <SPAN
 397 CLASS="QUOTE"
 398 >"|"</SPAN
 399 > matches. As an example:
 400   <SPAN
 401 CLASS="QUOTE"
 402 >"/(this|that) example/"</SPAN
 403 > uses grouping and the bar character
 404   and would match either <SPAN
 405 CLASS="QUOTE"
 406 >"this example"</SPAN
 407 > or <SPAN
 408 CLASS="QUOTE"
 409 >"that
 410   example"</SPAN
 411 >, and nothing else.
 412  </TD
 413 ></TR
 414 ></TBODY
 415 ></TABLE
 416 ><P
 417 ></P
 418 ></P
 419 ><P
 420 > These are just some of the ones you are likely to use when matching URLs with
 421  <SPAN
 422 CLASS="APPLICATION"
 423 >Privoxy</SPAN
 424 >, and is a long way from a definitive
 425  list. This is enough to get us started with a few simple examples which may
 426  be more illuminating:</P
 427 ><P
 428 > <SPAN
 429 CLASS="emphasis"
 430 ><I
 431 CLASS="EMPHASIS"
 432 ><TT
 433 CLASS="LITERAL"
 434 >/.*/banners/.*</TT
 435 ></I
 436 ></SPAN
 437 > - A  simple example
 438  that uses the common combination of <SPAN
 439 CLASS="QUOTE"
 440 >"."</SPAN
 441 > and <SPAN
 442 CLASS="QUOTE"
 443 >"*"</SPAN
 444 > to
 445  denote any character, zero or more times. In other words, any string at all.
 446  So we start with a literal forward slash, then our regular expression pattern
 447  (<SPAN
 448 CLASS="QUOTE"
 449 >".*"</SPAN
 450 >) another literal forward slash, the string
 451  <SPAN
 452 CLASS="QUOTE"
 453 >"banners"</SPAN
 454 >, another forward slash, and lastly another
 455  <SPAN
 456 CLASS="QUOTE"
 457 >".*"</SPAN
 458 >. We are building
 459  a directory path here. This will match any file with the path that has a
 460  directory named <SPAN
 461 CLASS="QUOTE"
 462 >"banners"</SPAN
 463 > in it. The <SPAN
 464 CLASS="QUOTE"
 465 >".*"</SPAN
 466 > matches
 467  any characters, and this could conceivably be more forward slashes, so it
 468  might expand into a much longer looking path. For example, this could match:
 469  <SPAN
 470 CLASS="QUOTE"
 471 >"/eye/hate/spammers/banners/annoy_me_please.gif"</SPAN
 472 >, or just
 473  <SPAN
 474 CLASS="QUOTE"
 475 >"/banners/annoying.html"</SPAN
 476 >, or almost an infinite number of other
 477  possible combinations, just so it has <SPAN
 478 CLASS="QUOTE"
 479 >"banners"</SPAN
 480 > in the path
 481  somewhere.</P
 482 ><P
 483 > And now something a little more complex:</P
 484 ><P
 485 > <SPAN
 486 CLASS="emphasis"
 487 ><I
 488 CLASS="EMPHASIS"
 489 ><TT
 490 CLASS="LITERAL"
 491 >/.*/adv((er)?ts?|ertis(ing|ements?))?/</TT
 492 ></I
 493 ></SPAN
 494 > -
 495  We have several literal forward slashes again (<SPAN
 496 CLASS="QUOTE"
 497 >"/"</SPAN
 498 >), so we are
 499  building another expression that is a file path statement. We have another
 500  <SPAN
 501 CLASS="QUOTE"
 502 >".*"</SPAN
 503 >, so we are matching against any conceivable sub-path, just so
 504  it matches our expression. The only true literal that <SPAN
 505 CLASS="emphasis"
 506 ><I
 507 CLASS="EMPHASIS"
 508 >must
 509  match</I
 510 ></SPAN
 511 > our pattern is <SPAN
 512 CLASS="APPLICATION"
 513 >adv</SPAN
 514 >, together with
 515  the forward slashes. What comes after the <SPAN
 516 CLASS="QUOTE"
 517 >"adv"</SPAN
 518 > string is the
 519  interesting part. </P
 520 ><P
 521 > Remember the <SPAN
 522 CLASS="QUOTE"
 523 >"?"</SPAN
 524 > means the preceding expression (either a
 525  literal character or anything grouped with <SPAN
 526 CLASS="QUOTE"
 527 >"(...)"</SPAN
 528 > in this case)
 529  can exist or not, since this means either zero or one match. So
 530  <SPAN
 531 CLASS="QUOTE"
 532 >"((er)?ts?|ertis(ing|ements?))"</SPAN
 533 > is optional, as are the
 534  individual sub-expressions: <SPAN
 535 CLASS="QUOTE"
 536 >"(er)"</SPAN
 537 >,
 538  <SPAN
 539 CLASS="QUOTE"
 540 >"(ing|ements?)"</SPAN
 541 >, and the <SPAN
 542 CLASS="QUOTE"
 543 >"s"</SPAN
 544 >. The <SPAN
 545 CLASS="QUOTE"
 546 >"|"</SPAN
 547 >
 548  means <SPAN
 549 CLASS="QUOTE"
 550 >"or"</SPAN
 551 >. We have two of those. For instance,
 552  <SPAN
 553 CLASS="QUOTE"
 554 >"(ing|ements?)"</SPAN
 555 >, can expand to match either <SPAN
 556 CLASS="QUOTE"
 557 >"ing"</SPAN
 558 >
 559  <SPAN
 560 CLASS="emphasis"
 561 ><I
 562 CLASS="EMPHASIS"
 563 >OR</I
 564 ></SPAN
 565 > <SPAN
 566 CLASS="QUOTE"
 567 >"ements?"</SPAN
 568 >. What is being done here, is an
 569  attempt at matching as many variations of <SPAN
 570 CLASS="QUOTE"
 571 >"advertisement"</SPAN
 572 >, and
 573  similar, as possible. So this would expand to match just <SPAN
 574 CLASS="QUOTE"
 575 >"adv"</SPAN
 576 >,
 577  or <SPAN
 578 CLASS="QUOTE"
 579 >"advert"</SPAN
 580 >, or <SPAN
 581 CLASS="QUOTE"
 582 >"adverts"</SPAN
 583 >, or
 584  <SPAN
 585 CLASS="QUOTE"
 586 >"advertising"</SPAN
 587 >, or <SPAN
 588 CLASS="QUOTE"
 589 >"advertisement"</SPAN
 590 >, or
 591  <SPAN
 592 CLASS="QUOTE"
 593 >"advertisements"</SPAN
 594 >. You get the idea. But it would not match
 595  <SPAN
 596 CLASS="QUOTE"
 597 >"advertizements"</SPAN
 598 > (with a <SPAN
 599 CLASS="QUOTE"
 600 >"z"</SPAN
 601 >). We could fix that by
 602  changing our regular expression to:
 603  <SPAN
 604 CLASS="QUOTE"
 605 >"/.*/adv((er)?ts?|erti(s|z)(ing|ements?))?/"</SPAN
 606 >, which would then match
 607  either spelling.</P
 608 ><P
 609 > <SPAN
 610 CLASS="emphasis"
 611 ><I
 612 CLASS="EMPHASIS"
 613 ><TT
 614 CLASS="LITERAL"
 615 >/.*/advert[0-9]+\.(gif|jpe?g)</TT
 616 ></I
 617 ></SPAN
 618 > - Again
 619  another path statement with forward slashes. Anything in the square brackets
 620  <SPAN
 621 CLASS="QUOTE"
 622 >"[ ]"</SPAN
 623 > can be matched. This is using <SPAN
 624 CLASS="QUOTE"
 625 >"0-9"</SPAN
 626 > as a
 627  shorthand expression to mean any digit one through nine. It is the same as
 628  saying <SPAN
 629 CLASS="QUOTE"
 630 >"0123456789"</SPAN
 631 >. So any digit matches. The <SPAN
 632 CLASS="QUOTE"
 633 >"+"</SPAN
 634 >
 635  means one or more of the preceding expression must be included. The preceding
 636  expression here is what is in the square brackets -- in this case, any digit
 637  one through nine. Then, at the end, we have a grouping: <SPAN
 638 CLASS="QUOTE"
 639 >"(gif|jpe?g)"</SPAN
 640 >.
 641  This includes a <SPAN
 642 CLASS="QUOTE"
 643 >"|"</SPAN
 644 >, so this needs to match the expression on
 645  either side of that bar character also. A simple <SPAN
 646 CLASS="QUOTE"
 647 >"gif"</SPAN
 648 > on one side, and the other
 649  side will in turn match either <SPAN
 650 CLASS="QUOTE"
 651 >"jpeg"</SPAN
 652 > or <SPAN
 653 CLASS="QUOTE"
 654 >"jpg"</SPAN
 655 >,
 656  since the <SPAN
 657 CLASS="QUOTE"
 658 >"?"</SPAN
 659 > means the letter <SPAN
 660 CLASS="QUOTE"
 661 >"e"</SPAN
 662 > is optional and
 663  can be matched once or not at all. So we are building an expression here to
 664  match image GIF or JPEG type image file. It must include the literal
 665  string <SPAN
 666 CLASS="QUOTE"
 667 >"advert"</SPAN
 668 >, then one or more digits, and a <SPAN
 669 CLASS="QUOTE"
 670 >"."</SPAN
 671 >
 672  (which is now a literal, and not a special character, since it is escaped
 673  with <SPAN
 674 CLASS="QUOTE"
 675 >"\"</SPAN
 676 >), and lastly either <SPAN
 677 CLASS="QUOTE"
 678 >"gif"</SPAN
 679 >, or
 680  <SPAN
 681 CLASS="QUOTE"
 682 >"jpeg"</SPAN
 683 >, or <SPAN
 684 CLASS="QUOTE"
 685 >"jpg"</SPAN
 686 >. Some possible matches would
 687  include: <SPAN
 688 CLASS="QUOTE"
 689 >"//advert1.jpg"</SPAN
 690 >,
 691  <SPAN
 692 CLASS="QUOTE"
 693 >"/nasty/ads/advert1234.gif"</SPAN
 694 >,
 695  <SPAN
 696 CLASS="QUOTE"
 697 >"/banners/from/hell/advert99.jpg"</SPAN
 698 >. It would not match
 699  <SPAN
 700 CLASS="QUOTE"
 701 >"advert1.gif"</SPAN
 702 > (no leading slash), or
 703  <SPAN
 704 CLASS="QUOTE"
 705 >"/adverts232.jpg"</SPAN
 706 > (the expression does not include an
 707  <SPAN
 708 CLASS="QUOTE"
 709 >"s"</SPAN
 710 >), or <SPAN
 711 CLASS="QUOTE"
 712 >"/advert1.jsp"</SPAN
 713 > (<SPAN
 714 CLASS="QUOTE"
 715 >"jsp"</SPAN
 716 > is not
 717  in the expression anywhere).</P
 718 ><P
 719 > We are barely scratching the surface of regular expressions here so that you
 720  can understand the default <SPAN
 721 CLASS="APPLICATION"
 722 >Privoxy</SPAN
 723 >
 724  configuration files, and maybe use this knowledge to customize your own
 725  installation. There is much, much more that can be done with regular
 726  expressions. Now that you know enough to get started, you can learn more on
 727  your own :/</P
 728 ><P
 729 > More reading on Perl Compatible Regular expressions:
 730  <A
 731 HREF="http://perldoc.perl.org/perlre.html"
 732 TARGET="_top"
 733 >http://perldoc.perl.org/perlre.html</A
 734 ></P
 735 ><P
 736 > For information on regular expression based substitutions and their applications
 737  in filters, please see the <A
 738 HREF="filter-file.html"
 739 >filter file tutorial</A
 740 >
 741  in this manual.</P
 742 ></DIV
 743 ><DIV
 744 CLASS="SECT2"
 745 ><H2
 746 CLASS="SECT2"
 747 ><A
 748 NAME="AEN4992"
 749 ></A
 750 >14.2. Privoxy's Internal Pages</H2
 751 ><P
 752 > Since <SPAN
 753 CLASS="APPLICATION"
 754 >Privoxy</SPAN
 755 > proxies each requested
 756  web page, it is easy for <SPAN
 757 CLASS="APPLICATION"
 758 >Privoxy</SPAN
 759 > to
 760  trap certain special URLs. In this way, we can talk directly to
 761  <SPAN
 762 CLASS="APPLICATION"
 763 >Privoxy</SPAN
 764 >, and see how it is
 765  configured, see how our rules are being applied, change these
 766  rules and other configuration options, and even turn
 767  <SPAN
 768 CLASS="APPLICATION"
 769 >Privoxy's</SPAN
 770 > filtering off, all with
 771  a web browser.&#13;</P
 772 ><P
 773 > The URLs listed below are the special ones that allow direct access
 774  to <SPAN
 775 CLASS="APPLICATION"
 776 >Privoxy</SPAN
 777 >. Of course,
 778  <SPAN
 779 CLASS="APPLICATION"
 780 >Privoxy</SPAN
 781 > must be running to access these. If
 782  not, you will get a friendly error message. Internet access is not
 783  necessary either.</P
 784 ><P
 785 > <P
 786 ></P
 787 ><UL
 788 ><LI
 789 ><P
 790 >
 791    Privoxy main page:
 792   </P
 793 ><A
 794 NAME="AEN5006"
 795 ></A
 796 ><BLOCKQUOTE
 797 CLASS="BLOCKQUOTE"
 798 ><P
 799 >
 800      <A
 801 HREF="http://config.privoxy.org/"
 802 TARGET="_top"
 803 >http://config.privoxy.org/</A
 804 >
 805    </P
 806 ></BLOCKQUOTE
 807 ><P
 808 >   There is a shortcut: <A
 809 HREF="http://p.p/"
 810 TARGET="_top"
 811 >http://p.p/</A
 812 > (But it
 813    doesn't provide a fall-back to a real page, in case the request is not
 814    sent through <SPAN
 815 CLASS="APPLICATION"
 816 >Privoxy</SPAN
 817 >)
 818   </P
 819 ></LI
 820 ><LI
 821 ><P
 822 >
 823     Show information about the current configuration, including viewing and
 824     editing of actions files:
 825   </P
 826 ><A
 827 NAME="AEN5014"
 828 ></A
 829 ><BLOCKQUOTE
 830 CLASS="BLOCKQUOTE"
 831 ><P
 832 >
 833     <A
 834 HREF="http://config.privoxy.org/show-status"
 835 TARGET="_top"
 836 >http://config.privoxy.org/show-status</A
 837 >
 838    </P
 839 ></BLOCKQUOTE
 840 ></LI
 841 ><LI
 842 ><P
 843 >
 844     Show the source code version numbers:
 845   </P
 846 ><A
 847 NAME="AEN5019"
 848 ></A
 849 ><BLOCKQUOTE
 850 CLASS="BLOCKQUOTE"
 851 ><P
 852 >
 853     <A
 854 HREF="http://config.privoxy.org/show-version"
 855 TARGET="_top"
 856 >http://config.privoxy.org/show-version</A
 857 >
 858    </P
 859 ></BLOCKQUOTE
 860 ></LI
 861 ><LI
 862 ><P
 863 >
 864    Show the browser's request headers:
 865   </P
 866 ><A
 867 NAME="AEN5024"
 868 ></A
 869 ><BLOCKQUOTE
 870 CLASS="BLOCKQUOTE"
 871 ><P
 872 >
 873     <A
 874 HREF="http://config.privoxy.org/show-request"
 875 TARGET="_top"
 876 >http://config.privoxy.org/show-request</A
 877 >
 878    </P
 879 ></BLOCKQUOTE
 880 ></LI
 881 ><LI
 882 ><P
 883 >
 884    Show which actions apply to a URL and why:
 885   </P
 886 ><A
 887 NAME="AEN5029"
 888 ></A
 889 ><BLOCKQUOTE
 890 CLASS="BLOCKQUOTE"
 891 ><P
 892 >
 893     <A
 894 HREF="http://config.privoxy.org/show-url-info"
 895 TARGET="_top"
 896 >http://config.privoxy.org/show-url-info</A
 897 >
 898    </P
 899 ></BLOCKQUOTE
 900 ></LI
 901 ><LI
 902 ><P
 903 >
 904    Toggle Privoxy on or off. In this case, <SPAN
 905 CLASS="QUOTE"
 906 >"Privoxy"</SPAN
 907 > continues
 908    to run, but only as a pass-through proxy, with no actions taking place:
 909   </P
 910 ><A
 911 NAME="AEN5035"
 912 ></A
 913 ><BLOCKQUOTE
 914 CLASS="BLOCKQUOTE"
 915 ><P
 916 >
 917     <A
 918 HREF="http://config.privoxy.org/toggle"
 919 TARGET="_top"
 920 >http://config.privoxy.org/toggle</A
 921 >
 922    </P
 923 ></BLOCKQUOTE
 924 ><P
 925 >   Short cuts. Turn off, then on:
 926   </P
 927 ><A
 928 NAME="AEN5039"
 929 ></A
 930 ><BLOCKQUOTE
 931 CLASS="BLOCKQUOTE"
 932 ><P
 933 >
 934      <A
 935 HREF="http://config.privoxy.org/toggle?set=disable"
 936 TARGET="_top"
 937 >http://config.privoxy.org/toggle?set=disable</A
 938 >
 939    </P
 940 ></BLOCKQUOTE
 941 ><A
 942 NAME="AEN5042"
 943 ></A
 944 ><BLOCKQUOTE
 945 CLASS="BLOCKQUOTE"
 946 ><P
 947 >
 948      <A
 949 HREF="http://config.privoxy.org/toggle?set=enable"
 950 TARGET="_top"
 951 >http://config.privoxy.org/toggle?set=enable</A
 952 >
 953    </P
 954 ></BLOCKQUOTE
 955 ></LI
 956 ></UL
 957 ></P
 958 ><P
 959 > These may be bookmarked for quick reference. See next.&#13;</P
 960 ><DIV
 961 CLASS="SECT3"
 962 ><H3
 963 CLASS="SECT3"
 964 ><A
 965 NAME="BOOKMARKLETS"
 966 ></A
 967 >14.2.1. Bookmarklets</H3
 968 ><P
 969 > Below are some <SPAN
 970 CLASS="QUOTE"
 971 >"bookmarklets"</SPAN
 972 > to allow you to easily access a
 973  <SPAN
 974 CLASS="QUOTE"
 975 >"mini"</SPAN
 976 > version of some of <SPAN
 977 CLASS="APPLICATION"
 978 >Privoxy's</SPAN
 979 >
 980  special pages. They are designed for MS Internet Explorer, but should work
 981  equally well in Netscape, Mozilla, and other browsers which support
 982  JavaScript. They are designed to run directly from your bookmarks - not by
 983  clicking the links below (although that should work for testing).</P
 984 ><P
 985 > To save them, right-click the link and choose <SPAN
 986 CLASS="QUOTE"
 987 >"Add to Favorites"</SPAN
 988 >
 989  (IE) or <SPAN
 990 CLASS="QUOTE"
 991 >"Add Bookmark"</SPAN
 992 > (Netscape). You will get a warning that
 993  the bookmark <SPAN
 994 CLASS="QUOTE"
 995 >"may not be safe"</SPAN
 996 > - just click OK. Then you can run the
 997  Bookmarklet directly from your favorites/bookmarks. For even faster access,
 998  you can put them on the <SPAN
 999 CLASS="QUOTE"
1000 >"Links"</SPAN
1001 > bar (IE) or the <SPAN
1002 CLASS="QUOTE"
1003 >"Personal
1004  Toolbar"</SPAN
1005 > (Netscape), and run them with a single click. </P
1006 ><P
1007 > <P
1008 ></P
1009 ><UL
1010 ><LI
1011 ><P
1012 >    <A
1013 HREF="javascript:void(window.open('http://config.privoxy.org/toggle?mini=y&set=enabled','ijbstatus','width=250,height=100,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());"
1014 TARGET="_top"
1015 >Privoxy - Enable</A
1016 >
1017    </P
1018 ></LI
1019 ><LI
1020 ><P
1021 >    <A
1022 HREF="javascript:void(window.open('http://config.privoxy.org/toggle?mini=y&set=disabled','ijbstatus','width=250,height=100,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());"
1023 TARGET="_top"
1024 >Privoxy - Disable</A
1025 >
1026    </P
1027 ></LI
1028 ><LI
1029 ><P
1030 >    <A
1031 HREF="javascript:void(window.open('http://config.privoxy.org/toggle?mini=y&set=toggle','ijbstatus','width=250,height=100,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());"
1032 TARGET="_top"
1033 >Privoxy - Toggle Privoxy</A
1034 > (Toggles between enabled and disabled)
1035    </P
1036 ></LI
1037 ><LI
1038 ><P
1039 >    <A
1040 HREF="javascript:void(window.open('http://config.privoxy.org/toggle?mini=y','ijbstatus','width=250,height=2,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());"
1041 TARGET="_top"
1042 >Privoxy- View Status</A
1043 >
1044    </P
1045 ></LI
1046 ><LI
1047 ><P
1048 >    <A
1049 HREF="javascript:void(window.open('http://config.privoxy.org/show-url-info?url='+escape(location.href),'Why').focus());"
1050 TARGET="_top"
1051 >Privoxy - Why?</A
1052 >
1053    </P
1054 ></LI
1055 ></UL
1056 ></P
1057 ><P
1058 > Credit: The site which gave us the general idea for these bookmarklets is
1059  <A
1060 HREF="http://www.bookmarklets.com/"
1061 TARGET="_top"
1062 >www.bookmarklets.com</A
1063 >. They
1064  have more information about bookmarklets. </P
1065 ></DIV
1066 ></DIV
1067 ><DIV
1068 CLASS="SECT2"
1069 ><H2
1070 CLASS="SECT2"
1071 ><A
1072 NAME="CHAIN"
1073 ></A
1074 >14.3. Chain of Events</H2
1075 ><P
1076 > Let's take a quick look at the basic sequence of events when a web page is
1077  requested by your browser and <SPAN
1078 CLASS="APPLICATION"
1079 >Privoxy</SPAN
1080 > is on duty:</P
1081 ><P
1082 > <P
1083 ></P
1084 ><UL
1085 ><LI
1086 ><P
1087 >   First, your web browser requests a web page. The browser knows to send
1088    the request to <SPAN
1089 CLASS="APPLICATION"
1090 >Privoxy</SPAN
1091 >, which will in turn,
1092    relay the request to the remote web server after passing the following
1093    tests:
1094   </P
1095 ></LI
1096 ><LI
1097 ><P
1098 >   <SPAN
1099 CLASS="APPLICATION"
1100 >Privoxy</SPAN
1101 > traps any request for its own internal CGI
1102    pages (e.g <A
1103 HREF="http://p.p/"
1104 TARGET="_top"
1105 >http://p.p/</A
1106 >) and sends the CGI page back to the browser.
1107   </P
1108 ></LI
1109 ><LI
1110 ><P
1111 >   Next, <SPAN
1112 CLASS="APPLICATION"
1113 >Privoxy</SPAN
1114 > checks to see if the URL
1115    matches any <A
1116 HREF="actions-file.html#BLOCK"
1117 ><SPAN
1118 CLASS="QUOTE"
1119 >"+block"</SPAN
1120 ></A
1121 > patterns. If
1122    so, the URL is then blocked, and the remote web server will not be contacted.
1123    <A
1124 HREF="actions-file.html#HANDLE-AS-IMAGE"
1125 ><SPAN
1126 CLASS="QUOTE"
1127 >"+handle-as-image"</SPAN
1128 ></A
1129 >
1130    is then checked and if it does not match, an
1131    HTML <SPAN
1132 CLASS="QUOTE"
1133 >"BLOCKED"</SPAN
1134 > page is sent back. Otherwise, if it does match,
1135    an image is returned. The type of image depends on the setting of <A
1136 HREF="actions-file.html#SET-IMAGE-BLOCKER"
1137 ><SPAN
1138 CLASS="QUOTE"
1139 >"+set-image-blocker"</SPAN
1140 ></A
1141 >
1142    (blank, checkerboard pattern, or an HTTP redirect to an image elsewhere).
1143   </P
1144 ></LI
1145 ><LI
1146 ><P
1147 >   Untrusted URLs are blocked. If URLs are being added to the
1148    <TT
1149 CLASS="FILENAME"
1150 >trust</TT
1151 > file, then that is done.
1152   </P
1153 ></LI
1154 ><LI
1155 ><P
1156 >   If the URL pattern matches the <A
1157 HREF="actions-file.html#FAST-REDIRECTS"
1158 ><SPAN
1159 CLASS="QUOTE"
1160 >"+fast-redirects"</SPAN
1161 ></A
1162 > action,
1163    it is then processed. Unwanted parts of the requested URL are stripped.
1164   </P
1165 ></LI
1166 ><LI
1167 ><P
1168 >   Now the rest of the client browser's request headers are processed. If any
1169    of these match any of the relevant actions (e.g. <A
1170 HREF="actions-file.html#HIDE-USER-AGENT"
1171 ><SPAN
1172 CLASS="QUOTE"
1173 >"+hide-user-agent"</SPAN
1174 ></A
1175 >,
1176    etc.), headers are suppressed or forged as determined by these actions and
1177    their parameters.
1178   </P
1179 ></LI
1180 ><LI
1181 ><P
1182 >   Now the web server starts sending its response back (i.e. typically a web page and related
1183    data).
1184   </P
1185 ></LI
1186 ><LI
1187 ><P
1188 >   First, the server headers are read and processed to determine, among other
1189    things, the MIME type (document type) and encoding. The headers are then
1190    filtered as determined by the
1191    <A
1192 HREF="actions-file.html#CRUNCH-INCOMING-COOKIES"
1193 ><SPAN
1194 CLASS="QUOTE"
1195 >"+crunch-incoming-cookies"</SPAN
1196 ></A
1197 >,
1198    <A
1199 HREF="actions-file.html#SESSION-COOKIES-ONLY"
1200 ><SPAN
1201 CLASS="QUOTE"
1202 >"+session-cookies-only"</SPAN
1203 ></A
1204 >,
1205    and <A
1206 HREF="actions-file.html#DOWNGRADE-HTTP-VERSION"
1207 ><SPAN
1208 CLASS="QUOTE"
1209 >"+downgrade-http-version"</SPAN
1210 ></A
1211 >
1212    actions.
1213   </P
1214 ></LI
1215 ><LI
1216 ><P
1217 >   If the <A
1218 HREF="actions-file.html#KILL-POPUPS"
1219 ><SPAN
1220 CLASS="QUOTE"
1221 >"+kill-popups"</SPAN
1222 ></A
1223 >
1224    action applies, and it is an HTML or JavaScript document, the popup-code in the
1225    response is filtered on-the-fly as it is received.
1226   </P
1227 ></LI
1228 ><LI
1229 ><P
1230 >   If a <A
1231 HREF="actions-file.html#FILTER"
1232 ><SPAN
1233 CLASS="QUOTE"
1234 >"+filter"</SPAN
1235 ></A
1236 >
1237    or <A
1238 HREF="actions-file.html#DEANIMATE-GIFS"
1239 ><SPAN
1240 CLASS="QUOTE"
1241 >"+deanimate-gifs"</SPAN
1242 ></A
1243 >
1244    action applies (and the document type fits the action), the rest of the page is
1245    read into memory (up to a configurable limit). Then the filter rules (from
1246    <TT
1247 CLASS="FILENAME"
1248 >default.filter</TT
1249 > and any other filter files) are
1250    processed against the buffered content. Filters are applied in the order
1251    they are specified in one of the filter files. Animated GIFs, if present,
1252    are reduced to either the first or last frame, depending on the action
1253    setting.The entire page, which is now filtered, is then sent by
1254    <SPAN
1255 CLASS="APPLICATION"
1256 >Privoxy</SPAN
1257 > back to your browser.
1258   </P
1259 ><P
1260 >   If neither <A
1261 HREF="actions-file.html#FILTER"
1262 ><SPAN
1263 CLASS="QUOTE"
1264 >"+filter"</SPAN
1265 ></A
1266 >
1267    or <A
1268 HREF="actions-file.html#DEANIMATE-GIFS"
1269 ><SPAN
1270 CLASS="QUOTE"
1271 >"+deanimate-gifs"</SPAN
1272 ></A
1273 >
1274    matches, then <SPAN
1275 CLASS="APPLICATION"
1276 >Privoxy</SPAN
1277 > passes the raw data through
1278    to the client browser as it becomes available.
1279   </P
1280 ></LI
1281 ><LI
1282 ><P
1283 >   As the browser receives the now (possibly filtered) page content, it
1284    reads and then requests any URLs that may be embedded within the page
1285    source, e.g. ad images, stylesheets, JavaScript, other HTML documents (e.g.
1286    frames), sounds, etc. For each of these objects, the browser issues a new
1287    request. And each such request is in turn processed as above. Note that a
1288    complex web page may have many such embedded URLs.
1289   </P
1290 ></LI
1291 ></UL
1292 ></P
1293 ></DIV
1294 ><DIV
1295 CLASS="SECT2"
1296 ><H2
1297 CLASS="SECT2"
1298 ><A
1299 NAME="ACTIONSANAT"
1300 ></A
1301 >14.4. Troubleshooting: Anatomy of an Action</H2
1302 ><P
1303 > The way <SPAN
1304 CLASS="APPLICATION"
1305 >Privoxy</SPAN
1306 > applies
1307  <A
1308 HREF="actions-file.html#ACTIONS"
1309 >actions</A
1310 > and <A
1311 HREF="actions-file.html#FILTER"
1312 >filters</A
1313 >
1314  to any given URL can be complex, and not always so
1315  easy to understand what is happening. And sometimes we need to be able to
1316  <SPAN
1317 CLASS="emphasis"
1318 ><I
1319 CLASS="EMPHASIS"
1320 >see</I
1321 ></SPAN
1322 > just what <SPAN
1323 CLASS="APPLICATION"
1324 >Privoxy</SPAN
1325 > is
1326  doing. Especially, if something <SPAN
1327 CLASS="APPLICATION"
1328 >Privoxy</SPAN
1329 > is doing
1330  is causing us a problem inadvertently. It can be a little daunting to look at
1331  the actions and filters files themselves, since they tend to be filled with
1332  <A
1333 HREF="appendix.html#REGEX"
1334 >regular expressions</A
1335 > whose consequences are not
1336  always so obvious. </P
1337 ><P
1338 > One quick test to see if <SPAN
1339 CLASS="APPLICATION"
1340 >Privoxy</SPAN
1341 > is causing a problem
1342  or not, is to disable it temporarily. This should be the first troubleshooting
1343  step. See <A
1344 HREF="appendix.html#BOOKMARKLETS"
1345 >the Bookmarklets</A
1346 > section on a quick
1347  and easy way to do this (be sure to flush caches afterward!). Looking at the
1348  logs is a good idea too.</P
1349 ><P
1350 > Another easy troubleshooting step to try is if you have done any
1351  customization of your installation, revert back to the installed
1352  defaults and see if that helps. There are times the developers get complaints
1353  about one thing or another, and the problem is more related to a customized
1354  configuration issue.</P
1355 ><P
1356 > <SPAN
1357 CLASS="APPLICATION"
1358 >Privoxy</SPAN
1359 > also provides the
1360  <A
1361 HREF="http://config.privoxy.org/show-url-info"
1362 TARGET="_top"
1363 >http://config.privoxy.org/show-url-info</A
1364 >
1365  page that can show us very specifically how <SPAN
1366 CLASS="APPLICATION"
1367 >actions</SPAN
1368 >
1369  are being applied to any given URL. This is a big help for troubleshooting.</P
1370 ><P
1371 > First, enter one URL (or partial URL) at the prompt, and then
1372  <SPAN
1373 CLASS="APPLICATION"
1374 >Privoxy</SPAN
1375 > will tell us
1376  how the current configuration will handle it. This will not
1377  help with filtering effects (i.e. the <A
1378 HREF="actions-file.html#FILTER"
1379 ><SPAN
1380 CLASS="QUOTE"
1381 >"+filter"</SPAN
1382 ></A
1383 > action) from
1384  one of the filter files since this is handled very
1385  differently and not so easy to trap! It also will not tell you about any other
1386  URLs that may be embedded within the URL you are testing. For instance, images
1387  such as ads are expressed as URLs within the raw page source of HTML pages. So
1388  you will only get info for the actual URL that is pasted into the prompt area
1389  -- not any sub-URLs. If you want to know about embedded URLs like ads, you
1390  will have to dig those out of the HTML source. Use your browser's <SPAN
1391 CLASS="QUOTE"
1392 >"View
1393  Page Source"</SPAN
1394 > option for this. Or right click on the ad, and grab the
1395  URL.</P
1396 ><P
1397 > Let's try an example, <A
1398 HREF="http://google.com"
1399 TARGET="_top"
1400 >google.com</A
1401 >,
1402  and look at it one section at a time in a sample configuration (your real
1403  configuration may vary):</P
1404 ><P
1405 > <TABLE
1406 BORDER="0"
1407 BGCOLOR="#E0E0E0"
1408 WIDTH="100%"
1409 ><TR
1410 ><TD
1411 ><PRE
1412 CLASS="SCREEN"
1413 > Matches for http://google.com:
1414
1415  In file: default.action <SPAN
1416 CLASS="GUIBUTTON"
1417 >[ View ]</SPAN
1418 > <SPAN
1419 CLASS="GUIBUTTON"
1420 >[ Edit ]</SPAN
1421 >
1422
1423  {-add-header
1424  -block
1425  -content-type-overwrite
1426  -crunch-client-header
1427  -crunch-if-none-match
1428  -crunch-incoming-cookies
1429  -crunch-outgoing-cookies
1430  -crunch-server-header
1431  +deanimate-gifs {last}
1432  -downgrade-http-version
1433  +fast-redirects {check-decoded-url}
1434  -filter {js-events}
1435  -filter {content-cookies}
1436  -filter {all-popups}
1437  -filter {banners-by-link}
1438  -filter {tiny-textforms}
1439  -filter {frameset-borders}
1440  -filter {demoronizer}
1441  -filter {shockwave-flash}
1442  -filter {quicktime-kioskmode}
1443  -filter {fun}
1444  -filter {crude-parental}
1445  -filter {site-specifics}
1446  -filter {js-annoyances}
1447  -filter {html-annoyances}
1448  +filter {refresh-tags}
1449  -filter {unsolicited-popups}
1450  +filter {img-reorder}
1451  +filter {banners-by-size}
1452  +filter {webbugs}
1453  +filter {jumping-windows}
1454  +filter {ie-exploits}
1455  -filter {google}
1456  -filter {yahoo}
1457  -filter {msn}
1458  -filter {blogspot}
1459  -filter {xml-to-html}
1460  -filter {html-to-xml}
1461  -filter-client-headers
1462  -filter-server-headers
1463  -force-text-mode
1464  -handle-as-empty-document
1465  -handle-as-image
1466  -hide-accept-language
1467  -hide-content-disposition
1468  +hide-forwarded-for-headers
1469  +hide-from-header {block}
1470  -hide-if-modified-since
1471  +hide-referrer {forge}
1472  -hide-user-agent
1473  -inspect-jpegs
1474  -kill-popups
1475  -limit-connect
1476  -overwrite-last-modified
1477  +prevent-compression
1478  -redirect
1479  -send-vanilla-wafer
1480  -send-wafer
1481  +session-cookies-only
1482  +set-image-blocker {pattern}
1483  -treat-forbidden-connects-like-blocks }
1484 /
1485
1486  { -session-cookies-only }
1487  .google.com
1488
1489  { -fast-redirects }
1490  .google.com
1491
1492 In file: user.action <SPAN
1493 CLASS="GUIBUTTON"
1494 >[ View ]</SPAN
1495 > <SPAN
1496 CLASS="GUIBUTTON"
1497 >[ Edit ]</SPAN
1498 >
1499 (no matches in this file)  </PRE
1500 ></TD
1501 ></TR
1502 ></TABLE
1503 ></P
1504 ><P
1505 > This is telling us how we have defined our
1506  <A
1507 HREF="actions-file.html#ACTIONS"
1508 ><SPAN
1509 CLASS="QUOTE"
1510 >"actions"</SPAN
1511 ></A
1512 >, and
1513  which ones match for our test case, <SPAN
1514 CLASS="QUOTE"
1515 >"google.com"</SPAN
1516 >.
1517  Displayed is all the actions that are available to us. Remember,
1518  the <TT
1519 CLASS="LITERAL"
1520 >+</TT
1521 > sign denotes <SPAN
1522 CLASS="QUOTE"
1523 >"on"</SPAN
1524 >. <TT
1525 CLASS="LITERAL"
1526 >-</TT
1527 >
1528  denotes <SPAN
1529 CLASS="QUOTE"
1530 >"off"</SPAN
1531 >. So some are <SPAN
1532 CLASS="QUOTE"
1533 >"on"</SPAN
1534 > here, but many
1535  are <SPAN
1536 CLASS="QUOTE"
1537 >"off"</SPAN
1538 >. Each example we try may provide a slightly different
1539  end result, depending on our configuration directives.</P
1540 ><P
1541 > The first listing
1542   is for our <TT
1543 CLASS="FILENAME"
1544 >default.action</TT
1545 > file. The large, multi-line
1546   listing, is how the actions are set to match for all URLs, i.e. our default
1547   settings. If you look at your <SPAN
1548 CLASS="QUOTE"
1549 >"actions"</SPAN
1550 > file, this would be the
1551   section just below the <SPAN
1552 CLASS="QUOTE"
1553 >"aliases"</SPAN
1554 > section near the top. This
1555   will apply to all URLs as signified by the single forward slash at the end
1556   of the listing -- <SPAN
1557 CLASS="QUOTE"
1558 >" / "</SPAN
1559 >.</P
1560 ><P
1561 > But we have defined additional actions that would be exceptions to these general
1562  rules, and then we list specific URLs (or patterns) that these exceptions
1563  would apply to. Last match wins. Just below this then are two explicit
1564  matches for <SPAN
1565 CLASS="QUOTE"
1566 >".google.com"</SPAN
1567 >. The first is negating our previous
1568  cookie setting, which was for <A
1569 HREF="actions-file.html#SESSION-COOKIES-ONLY"
1570 ><SPAN
1571 CLASS="QUOTE"
1572 >"+session-cookies-only"</SPAN
1573 ></A
1574 >
1575  (i.e. not persistent). So we will allow persistent cookies for google, at
1576  least that is how it is in this example. The second turns
1577  <SPAN
1578 CLASS="emphasis"
1579 ><I
1580 CLASS="EMPHASIS"
1581 >off</I
1582 ></SPAN
1583 > any <A
1584 HREF="actions-file.html#FAST-REDIRECTS"
1585 ><SPAN
1586 CLASS="QUOTE"
1587 >"+fast-redirects"</SPAN
1588 ></A
1589 >
1590  action, allowing this to take place unmolested. Note that there is a leading
1591  dot here -- <SPAN
1592 CLASS="QUOTE"
1593 >".google.com"</SPAN
1594 >. This will match any hosts and
1595  sub-domains, in the google.com domain also, such as
1596  <SPAN
1597 CLASS="QUOTE"
1598 >"www.google.com"</SPAN
1599 > or <SPAN
1600 CLASS="QUOTE"
1601 >"mail.google.com"</SPAN
1602 >. But it would not
1603  match <SPAN
1604 CLASS="QUOTE"
1605 >"www.google.de"</SPAN
1606 >! So, apparently, we have these two actions
1607  defined as exceptions to the general rules at the top somewhere in the lower
1608  part of our <TT
1609 CLASS="FILENAME"
1610 >default.action</TT
1611 > file, and
1612  <SPAN
1613 CLASS="QUOTE"
1614 >"google.com"</SPAN
1615 > is referenced somewhere in these latter sections.</P
1616 ><P
1617 > Then, for our <TT
1618 CLASS="FILENAME"
1619 >user.action</TT
1620 > file, we again have no hits.
1621  So there is nothing google-specific that we might have added to our own, local
1622  configuration. If there was, those actions would over-rule any actions from
1623  previously processed files, such as <TT
1624 CLASS="FILENAME"
1625 >default.action</TT
1626 >.
1627  <TT
1628 CLASS="FILENAME"
1629 >user.action</TT
1630 > typically has the last word. This is the
1631  best place to put hard and fast exceptions,</P
1632 ><P
1633 > And finally we pull it all together in the bottom section and summarize how
1634  <SPAN
1635 CLASS="APPLICATION"
1636 >Privoxy</SPAN
1637 > is applying all its <SPAN
1638 CLASS="QUOTE"
1639 >"actions"</SPAN
1640 >
1641  to <SPAN
1642 CLASS="QUOTE"
1643 >"google.com"</SPAN
1644 >:&#13;</P
1645 ><P
1646 > <TABLE
1647 BORDER="0"
1648 BGCOLOR="#E0E0E0"
1649 WIDTH="100%"
1650 ><TR
1651 ><TD
1652 ><PRE
1653 CLASS="SCREEN"
1654 >&#13; Final results:
1655
1656  -add-header
1657  -block
1658  -content-type-overwrite
1659  -crunch-client-header
1660  -crunch-if-none-match
1661  -crunch-incoming-cookies
1662  -crunch-outgoing-cookies
1663  -crunch-server-header
1664  +deanimate-gifs {last}
1665  -downgrade-http-version
1666  +fast-redirects {check-decoded-url}
1667  -filter {js-events}
1668  -filter {content-cookies}
1669  -filter {all-popups}
1670  -filter {banners-by-link}
1671  -filter {tiny-textforms}
1672  -filter {frameset-borders}
1673  -filter {demoronizer}
1674  -filter {shockwave-flash}
1675  -filter {quicktime-kioskmode}
1676  -filter {fun}
1677  -filter {crude-parental}
1678  -filter {site-specifics}
1679  -filter {js-annoyances}
1680  -filter {html-annoyances}
1681  +filter {refresh-tags}
1682  -filter {unsolicited-popups}
1683  +filter {img-reorder}
1684  +filter {banners-by-size}
1685  +filter {webbugs}
1686  +filter {jumping-windows}
1687  +filter {ie-exploits}
1688  -filter {google}
1689  -filter {yahoo}
1690  -filter {msn}
1691  -filter {blogspot}
1692  -filter {xml-to-html}
1693  -filter {html-to-xml}
1694  -filter-client-headers
1695  -filter-server-headers
1696  -force-text-mode
1697  -handle-as-empty-document
1698  -handle-as-image
1699  -hide-accept-language
1700  -hide-content-disposition
1701  +hide-forwarded-for-headers
1702  +hide-from-header {block}
1703  -hide-if-modified-since
1704  +hide-referrer {forge}
1705  -hide-user-agent
1706  -inspect-jpegs
1707  -kill-popups
1708  -limit-connect
1709  -overwrite-last-modified
1710  +prevent-compression
1711  -redirect
1712  -send-vanilla-wafer
1713  -send-wafer
1714  -session-cookies-only
1715  +set-image-blocker {pattern}
1716  -treat-forbidden-connects-like-blocks </PRE
1717 ></TD
1718 ></TR
1719 ></TABLE
1720 ></P
1721 ><P
1722 > Notice the only difference here to the previous listing, is to
1723  <SPAN
1724 CLASS="QUOTE"
1725 >"fast-redirects"</SPAN
1726 > and <SPAN
1727 CLASS="QUOTE"
1728 >"session-cookies-only"</SPAN
1729 >,
1730  which are activated specifically for this site in our configuration,
1731  and thus show in the <SPAN
1732 CLASS="QUOTE"
1733 >"Final Results"</SPAN
1734 >.</P
1735 ><P
1736 > Now another example, <SPAN
1737 CLASS="QUOTE"
1738 >"ad.doubleclick.net"</SPAN
1739 >:</P
1740 ><P
1741 > <TABLE
1742 BORDER="0"
1743 BGCOLOR="#E0E0E0"
1744 WIDTH="100%"
1745 ><TR
1746 ><TD
1747 ><PRE
1748 CLASS="SCREEN"
1749 >&#13; { +block }
1750   ad*.
1751
1752  { +block }
1753   .ad.
1754
1755  { +block +handle-as-image }
1756   .[a-vx-z]*.doubleclick.net</PRE
1757 ></TD
1758 ></TR
1759 ></TABLE
1760 ></P
1761 ><P
1762 > We'll just show the interesting part here - the explicit matches. It is
1763  matched three different times. Two <SPAN
1764 CLASS="QUOTE"
1765 >"+block"</SPAN
1766 > sections,
1767  and a <SPAN
1768 CLASS="QUOTE"
1769 >"+block +handle-as-image"</SPAN
1770 >,
1771  which is the expanded form of one of our aliases that had been defined as:
1772  <SPAN
1773 CLASS="QUOTE"
1774 >"+block-as-image"</SPAN
1775 >. (<A
1776 HREF="actions-file.html#ALIASES"
1777 ><SPAN
1778 CLASS="QUOTE"
1779 >"Aliases"</SPAN
1780 ></A
1781 > are defined in
1782  the first section of the actions file and typically used to combine more
1783  than one action.)</P
1784 ><P
1785 > Any one of these would have done the trick and blocked this as an unwanted
1786  image. This is unnecessarily redundant since the last case effectively
1787  would also cover the first. No point in taking chances with these guys
1788  though ;-) Note that if you want an ad or obnoxious
1789  URL to be invisible, it should be defined as <SPAN
1790 CLASS="QUOTE"
1791 >"ad.doubleclick.net"</SPAN
1792 >
1793  is done here -- as both a <A
1794 HREF="actions-file.html#BLOCK"
1795 ><SPAN
1796 CLASS="QUOTE"
1797 >"+block"</SPAN
1798 ></A
1799 >
1800  <SPAN
1801 CLASS="emphasis"
1802 ><I
1803 CLASS="EMPHASIS"
1804 >and</I
1805 ></SPAN
1806 > an
1807  <A
1808 HREF="actions-file.html#HANDLE-AS-IMAGE"
1809 ><SPAN
1810 CLASS="QUOTE"
1811 >"+handle-as-image"</SPAN
1812 ></A
1813 >.
1814  The custom alias <SPAN
1815 CLASS="QUOTE"
1816 >"<TT
1817 CLASS="LITERAL"
1818 >+block-as-image</TT
1819 >"</SPAN
1820 > just
1821  simplifies the process and make it more readable.</P
1822 ><P
1823 > One last example. Let's try <SPAN
1824 CLASS="QUOTE"
1825 >"http://www.example.net/adsl/HOWTO/"</SPAN
1826 >.
1827  This one is giving us problems. We are getting a blank page. Hmmm ...</P
1828 ><P
1829 > <TABLE
1830 BORDER="0"
1831 BGCOLOR="#E0E0E0"
1832 WIDTH="100%"
1833 ><TR
1834 ><TD
1835 ><PRE
1836 CLASS="SCREEN"
1837 >&#13; Matches for http://www.example.net/adsl/HOWTO/:
1838
1839  In file: default.action <SPAN
1840 CLASS="GUIBUTTON"
1841 >[ View ]</SPAN
1842 > <SPAN
1843 CLASS="GUIBUTTON"
1844 >[ Edit ]</SPAN
1845 >
1846
1847  {-add-header
1848   -block
1849   -content-type-overwrite
1850   -crunch-client-header
1851   -crunch-if-none-match
1852   -crunch-incoming-cookies
1853   -crunch-outgoing-cookies
1854   -crunch-server-header
1855   +deanimate-gifs
1856   -downgrade-http-version
1857   +fast-redirects {check-decoded-url}
1858   -filter {js-events}
1859   -filter {content-cookies}
1860   -filter {all-popups}
1861   -filter {banners-by-link}
1862   -filter {tiny-textforms}
1863   -filter {frameset-borders}
1864   -filter {demoronizer}
1865   -filter {shockwave-flash}
1866   -filter {quicktime-kioskmode}
1867   -filter {fun}
1868   -filter {crude-parental}
1869   -filter {site-specifics}
1870   -filter {js-annoyances}
1871   -filter {html-annoyances}
1872   +filter {refresh-tags}
1873   -filter {unsolicited-popups}
1874   +filter {img-reorder}
1875   +filter {banners-by-size}
1876   +filter {webbugs}
1877   +filter {jumping-windows}
1878   +filter {ie-exploits}
1879   -filter {google}
1880   -filter {yahoo}
1881   -filter {msn}
1882   -filter {blogspot}
1883   -filter {xml-to-html}
1884   -filter {html-to-xml}
1885   -filter-client-headers
1886   -filter-server-headers
1887   -force-text-mode
1888   -handle-as-empty-document
1889   -handle-as-image
1890   -hide-accept-language
1891   -hide-content-disposition
1892   +hide-forwarded-for-headers
1893   +hide-from-header{block}
1894   +hide-referer{forge}
1895   -hide-user-agent
1896   -inspect-jpegs
1897   -kill-popups
1898   -overwrite-last-modified
1899   +prevent-compression
1900   -redirect
1901   -send-vanilla-wafer
1902   -send-wafer
1903   +session-cookies-only
1904   +set-image-blocker{blank}
1905   -treat-forbidden-connects-like-blocks }
1906    /
1907
1908  { +block +handle-as-image }
1909   /ads</PRE
1910 ></TD
1911 ></TR
1912 ></TABLE
1913 ></P
1914 ><P
1915 > Ooops, the <SPAN
1916 CLASS="QUOTE"
1917 >"/adsl/"</SPAN
1918 > is matching <SPAN
1919 CLASS="QUOTE"
1920 >"/ads"</SPAN
1921 > in our
1922  configuration! But we did not want this at all! Now we see why we get the
1923  blank page. It is actually triggering two different actions here, and
1924  the effects are aggregated so that the URL is blocked, and <SPAN
1925 CLASS="APPLICATION"
1926 >Privoxy</SPAN
1927 > is told
1928  to treat the block as if it were an image. But this is, of course, all wrong.
1929   We could now add a new action below this (or better in our own
1930   <TT
1931 CLASS="FILENAME"
1932 >user.action</TT
1933 > file) that explicitly
1934   <SPAN
1935 CLASS="emphasis"
1936 ><I
1937 CLASS="EMPHASIS"
1938 >un</I
1939 ></SPAN
1940 > blocks (
1941   <A
1942 HREF="actions-file.html#BLOCK"
1943 ><SPAN
1944 CLASS="QUOTE"
1945 >"{-block}"</SPAN
1946 ></A
1947 >) paths with
1948   <SPAN
1949 CLASS="QUOTE"
1950 >"adsl"</SPAN
1951 > in them (remember, last match in the configuration
1952   wins). There are various ways to handle such exceptions. Example:</P
1953 ><P
1954 > <TABLE
1955 BORDER="0"
1956 BGCOLOR="#E0E0E0"
1957 WIDTH="100%"
1958 ><TR
1959 ><TD
1960 ><PRE
1961 CLASS="SCREEN"
1962 >&#13; { -block }
1963   /adsl</PRE
1964 ></TD
1965 ></TR
1966 ></TABLE
1967 ></P
1968 ><P
1969 > Now the page displays ;-)
1970  Remember to flush your browser's caches when making these kinds of changes to
1971  your configuration to insure that you get a freshly delivered page! Or, try
1972  using <TT
1973 CLASS="LITERAL"
1974 >Shift+Reload</TT
1975 >.</P
1976 ><P
1977 > But now what about a situation where we get no explicit matches like
1978  we did with:</P
1979 ><P
1980 > <TABLE
1981 BORDER="0"
1982 BGCOLOR="#E0E0E0"
1983 WIDTH="100%"
1984 ><TR
1985 ><TD
1986 ><PRE
1987 CLASS="SCREEN"
1988 >&#13; { +block +handle-as-image }
1989  /ads</PRE
1990 ></TD
1991 ></TR
1992 ></TABLE
1993 ></P
1994 ><P
1995 > That actually was very helpful and pointed us quickly to where the problem
1996  was. If you don't get this kind of match, then it means one of the default
1997  rules in the first section of <TT
1998 CLASS="FILENAME"
1999 >default.action</TT
2000 > is causing
2001  the problem. This would require some guesswork, and maybe a little trial and
2002  error to isolate the offending rule. One likely cause would be one of the
2003  <A
2004 HREF="actions-file.html#FILTER"
2005 ><SPAN
2006 CLASS="QUOTE"
2007 >"+filter"</SPAN
2008 ></A
2009 > actions.
2010  These tend to be harder to troubleshoot.
2011  Try adding the URL for the site to one of aliases that turn off
2012  <A
2013 HREF="actions-file.html#FILTER"
2014 ><SPAN
2015 CLASS="QUOTE"
2016 >"+filter"</SPAN
2017 ></A
2018 >:</P
2019 ><P
2020 > <TABLE
2021 BORDER="0"
2022 BGCOLOR="#E0E0E0"
2023 WIDTH="100%"
2024 ><TR
2025 ><TD
2026 ><PRE
2027 CLASS="SCREEN"
2028 >&#13; { shop }
2029  .quietpc.com
2030  .worldpay.com   # for quietpc.com
2031  .jungle.com
2032  .scan.co.uk
2033  .forbes.com</PRE
2034 ></TD
2035 ></TR
2036 ></TABLE
2037 ></P
2038 ><P
2039 > <SPAN
2040 CLASS="QUOTE"
2041 >"<TT
2042 CLASS="LITERAL"
2043 >{ shop }</TT
2044 >"</SPAN
2045 > is an <SPAN
2046 CLASS="QUOTE"
2047 >"alias"</SPAN
2048 > that expands to
2049  <SPAN
2050 CLASS="QUOTE"
2051 >"<TT
2052 CLASS="LITERAL"
2053 >{ -filter -session-cookies-only }</TT
2054 >"</SPAN
2055 >.
2056  Or you could do your own exception to negate filtering:&#13;</P
2057 ><P
2058 > <TABLE
2059 BORDER="0"
2060 BGCOLOR="#E0E0E0"
2061 WIDTH="100%"
2062 ><TR
2063 ><TD
2064 ><PRE
2065 CLASS="SCREEN"
2066 >&#13; { -filter }
2067  # Disable ALL filter actions for sites in this section
2068  .forbes.com
2069  developer.ibm.com
2070  localhost</PRE
2071 ></TD
2072 ></TR
2073 ></TABLE
2074 ></P
2075 ><P
2076 > This would turn off all filtering for these sites. This is best
2077  put in <TT
2078 CLASS="FILENAME"
2079 >user.action</TT
2080 >, for local site
2081  exceptions. Note that when a simple domain pattern is used by itself (without
2082  the subsequent path portion), all sub-pages within that domain are included
2083  automatcially in the scope of the action.</P
2084 ><P
2085 > Images that are inexplicably being blocked, may well be hitting the
2086 <A
2087 HREF="actions-file.html#FILTER-BANNERS-BY-SIZE"
2088 ><SPAN
2089 CLASS="QUOTE"
2090 >"+filter{banners-by-size}"</SPAN
2091 ></A
2092 >
2093  rule, which assumes
2094  that images of certain sizes are ad banners (works well
2095  <SPAN
2096 CLASS="emphasis"
2097 ><I
2098 CLASS="EMPHASIS"
2099 >most of the time</I
2100 ></SPAN
2101 >  since these tend to be standardized).</P
2102 ><P
2103 > <SPAN
2104 CLASS="QUOTE"
2105 >"<TT
2106 CLASS="LITERAL"
2107 >{ fragile }</TT
2108 >"</SPAN
2109 > is an alias that disables most
2110  actions that are the most likely to cause trouble. This can be used as a
2111  last resort for problem sites. </P
2112 ><P
2113 > <TABLE
2114 BORDER="0"
2115 BGCOLOR="#E0E0E0"
2116 WIDTH="100%"
2117 ><TR
2118 ><TD
2119 ><PRE
2120 CLASS="SCREEN"
2121 >&#13; { fragile }
2122  # Handle with care: easy to break
2123  mail.google.
2124  mybank.example.com</PRE
2125 ></TD
2126 ></TR
2127 ></TABLE
2128 ></P
2129 ><P
2130 > <SPAN
2131 CLASS="emphasis"
2132 ><I
2133 CLASS="EMPHASIS"
2134 >Remember to flush caches!</I
2135 ></SPAN
2136 > Note that the
2137  <TT
2138 CLASS="LITERAL"
2139 >mail.google</TT
2140 > reference lacks the TLD portion (e.g.
2141  <SPAN
2142 CLASS="QUOTE"
2143 >".com"</SPAN
2144 >. This will effectively match any TLD with
2145  <TT
2146 CLASS="LITERAL"
2147 >google</TT
2148 > in it, such as <TT
2149 CLASS="LITERAL"
2150 >mail.google.de</TT
2151 >,
2152  just as an example.</P
2153 ><P
2154 >
2155  If this still does not work, you will have to go through the remaining
2156  actions one by one to find which one(s) is causing the problem.</P
2157 ></DIV
2158 ></DIV
2159 ><DIV
2160 CLASS="NAVFOOTER"
2161 ><HR
2162 ALIGN="LEFT"
2163 WIDTH="100%"><TABLE
2164 SUMMARY="Footer navigation table"
2165 WIDTH="100%"
2166 BORDER="0"
2167 CELLPADDING="0"
2168 CELLSPACING="0"
2169 ><TR
2170 ><TD
2171 WIDTH="33%"
2172 ALIGN="left"
2173 VALIGN="top"
2174 ><A
2175 HREF="seealso.html"
2176 ACCESSKEY="P"
2177 >Prev</A
2178 ></TD
2179 ><TD
2180 WIDTH="34%"
2181 ALIGN="center"
2182 VALIGN="top"
2183 ><A
2184 HREF="index.html"
2185 ACCESSKEY="H"
2186 >Home</A
2187 ></TD
2188 ><TD
2189 WIDTH="33%"
2190 ALIGN="right"
2191 VALIGN="top"
2192 >&nbsp;</TD
2193 ></TR
2194 ><TR
2195 ><TD
2196 WIDTH="33%"
2197 ALIGN="left"
2198 VALIGN="top"
2199 >See Also</TD
2200 ><TD
2201 WIDTH="34%"
2202 ALIGN="center"
2203 VALIGN="top"
2204 >&nbsp;</TD
2205 ><TD
2206 WIDTH="33%"
2207 ALIGN="right"
2208 VALIGN="top"
2209 >&nbsp;</TD
2210 ></TR
2211 ></TABLE
2212 ></DIV
2213 ></BODY
2214 ></HTML
2215 >