ExitPlugin < TWiki

---+!! <nop>%TOPIC%
<!--
   Contributions to this TWiki plugin are appreciated. Please update the plugin page at
   http://twiki.org/cgi-bin/view/Plugins/ExitPlugin or provide feedback at
   http://twiki.org/cgi-bin/view/Plugins/ExitPluginDev.
   If you are a TWiki contributor please update the plugin in the SVN repository.
-->
<sticky><div style="float:right; background-color:#EBEEF0; margin:0 0 20px 20px; padding: 0 10px 0 10px;">
%TOC{title="Page contents"}%
</div></sticky>
%SHORTDESCRIPTION%

---++ Introduction

This plugin redirects links to external sites via a page of your choice. You might want to do that to display a disclaimer ("You are leaving %WIKITOOLNAME%, come back soon.") or to remove topic names from HTTP referrer headers.

---++ Syntax Rules

This plugin does not extend TWiki markup syntax.

---++ Examples

If <nop>%TOPIC% is installed, the following link should take you to =<nop>%REDIRECTVIA%http://www.google.com/=

http://www.google.com/

Note that these links will not be affected if the =NOEXIT= setting lists =twiki.org=.

http://twiki.org/download.html

http://develop.twiki.org/

---+++ Known Issues

---++++ Cross linked images

Cross linked images (like the following) are not handled by this plugin and can still leak page names via HTTP referer headers.

<verbatim>
<img src="http://www.example.com/logo.png" alt="Someone else's logo"/>
</verbatim>

As images are loaded with the page (unlike links) no user action is needed to leak page names.

---++ Plugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, i.e. ==%<nop>INTERWIKIPLUGIN_SHORTDESCRIPTION%==

   * One line description, is shown in the %SYSTEMWEB%.TextFormattingRules topic:
      * Set SHORTDESCRIPTION = Redirect links to external sites via a page of your choice, such as to remove topic names from HTTP referrer headers

   * Debug plugin: (See output in =data/debug.txt=)
      * Set DEBUG = 0

   * Disable exit page - sitewide (here), per web (in WebPreferences) or per topic
      * Set DISABLEEXITPLUGIN = 0

   * URI schemes to be redirected
      * Set SCHEMES = http https

   * Exit handler
      * Set REDIRECTVIA = %SCRIPTURL%/exit.cgi?url=

   * Hosts for which no exit page should be shown.
      * Set NOEXIT = .bygrave.me.uk .ibygrave.no-ip.org

   * External link marks (you can use an image if you want). These are optional.
      * Set PREMARK =
      * Set POSTMARK =
      * #Set POSTMARK = &nbsp;<image src="%PUBURL%/%SYSTEMWEB%/ExitPlugin/external.png" />
      * Set MARKSINLINK = off

---++ Plugin Installation Instructions

__Note:__ You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the server where TWiki is running. 

   * Download the ZIP file from the Plugin web (see below)
   * Unzip ==%TOPIC%.zip== in your twiki installation directory. Content:
     | *File:* | *Description:* |
     | ==data/TWiki/%TOPIC%.txt== | Plugin topic |
     | ==data/TWiki/%TOPIC%.txt,v== | Plugin topic repository |
     | ==lib/TWiki/Plugins/%TOPIC%.pm== | Plugin Perl module |
     | ==bin/exit.cgi== | CGI script to generate the redirction page |
   * Visit =configure= in your TWiki installation, and enable the plugin in the {Plugins} section.
   * Test if the installation was successful:
      * Click on links in above examples, and check that they are redirected via =<nop>%REDIRECTVIA%=
      * Check that internal links do not redirect. Fix the setting of =NOEXIT= if they do.

---++ Plugin Info

|  Plugin Author: | TWiki:Main.IanBygrave |
|  Copyright: | &copy; 2006-2009 TWiki:Main.IanBygrave <br /> &copy; 2006-2010 TWiki:TWiki.TWikiContributor |
|  Plugin Version: | 2010-12-12 (V1.6) |
|  Change History: | <!-- versions below in reverse order -->&nbsp; |
|  2010-12-12: | TWikibug:Item6530: Doc improvements, changing TWIKIWEB to SYSTEMWEB -- TWiki:Main.PeterThoeny |
|  13 Jan 2009: | Remove <nop> tags from the url. |
|  08 Jan 2007: | New DISABLEEXITPLUGIN preference to allow per-web or -topic disabling of the plugin. Stop using deprecated handler. |
|  21 Jul 2006: | Make the set of redirectable URI schemes configurable with SCHEMES preference. |
|  26 Mar 2006: | Performance improvements. |
|  24 Mar 2006: | Add MARKSINLINK pref. Match more links. |
|  22 Mar 2006: | Add TWiki:Plugins.ExternalLinkPlugin functionality to ExitPlugin. |
|  13 Feb 2006: | Fix url escaping, which got removed by a previous change. |
|  11 Feb 2006: | The NOEXIT configuration parameter is now a whitespace seperated list of internal domains. |
|  04 Feb 2006: | Initial version |
|  TWiki Dependency: | $TWiki::Plugins::VERSION 1.024 |
|  CPAN Dependencies: | ==CGI== %BR% ==URI::Escape== |
|  Other Dependencies: | none |
|  Perl Version: | 5.005 |
|  License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) |
|  [[TWiki:Plugins/Benchmark][Benchmarks]]: | %SYSTEMWEB%.GoodStyle 95%, %SYSTEMWEB%.FormattedSearch 96%, %TOPIC% 95% |
|  Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% |
|  Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev |
|  Appraisal: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal |

__Related Topics:__ %SYSTEMWEB%.TWikiPreferences, %SYSTEMWEB%.TWikiPlugins
This topic: TWiki > TWikiPreferences > ExitPlugin
Topic revision: r1 - 2020-05-29 - TWikiAdminUser
Copyright © 1999-2025 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.ExitPlugin.