2 rcs_id('$Id: RedirectTo.php,v 1.8 2003-02-16 19:49:18 dairiki Exp $');
4 Copyright 2002 $ThePhpWikiProgrammingTeam
6 This file is part of PhpWiki.
8 PhpWiki is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 PhpWiki is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with PhpWiki; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 * Redirect to another page or external uri. Kind of PageAlias.
26 * <?plugin-head RedirectTo href="http://www.internet-technology.de/fourwins_de.htm" ?>
27 * or <?plugin-head RedirectTo page=AnotherPage ?>
28 * at the VERY FIRST LINE in the content! Otherwise it will be ignored.
30 * Author: Reini Urban <rurban@x-ray.at>
34 * This plugin could probably result in a lot of confusion, especially when
35 * redirecting to external sites. (Perhaps it can even be used for dastardly
36 * purposes?) Maybe it should be disabled by default.
38 * It would be nice, when redirecting to another wiki page, to (as
39 * UseModWiki does) add a note to the top of the target page saying
40 * something like "(Redirected from SomeRedirectingPage)".
42 class WikiPlugin_RedirectTo
46 return _("RedirectTo");
49 function getDescription() {
50 return _("Redirects to another url or page.");
53 function getVersion() {
54 return preg_replace("/[Revision: $]/", '',
58 function getDefaultArguments() {
59 return array( 'href' => '',
60 // 'type' => 'Temp' // or 'Permanent' // so far ignored
65 function run($dbi, $argstr, $request) {
66 $args = ($this->getArgs($argstr, $request));
68 $href = $args['href'];
69 $page = $args['page'];
72 * Use quotes on the href argument value, like:
73 * <?plugin RedirectTo href="http://funky.com/a b \" c.htm" ?>
75 * Do we want some checking on href to avoid malicious
76 * uses of the plugin? Like stripping tags or hexcode.
78 $url = preg_replace('/%\d\d/','',strip_tags($href));
79 $thispage = $request->getPage();
80 if (! $thispage->get('locked')) {
81 return $this->disabled(fmt(_("%s is only allowed in locked pages."),
82 _("Redirect to an external url")));
87 array('redirectfrom' => $request->getArg('pagename')),
91 return $this->error(fmt("%s or %s parameter missing",
95 if ($page == $request->getArg('pagename')) {
96 return $this->error(fmt("Recursive redirect to self: '%s'", $url));
99 if ($request->getArg('action') != 'browse')
100 return $this->disabled("(action != 'browse')");
102 $redirectfrom = $request->getArg('redirectfrom');
103 if ($redirectfrom !== false) {
105 return $this->disabled(_("Double redirect not allowed."));
107 // Got here by following the "Redirected from ..." link
109 return $this->disabled(_("Viewing redirecting page."));
113 return $request->redirect($url);
117 // $Log: not supported by cvs2svn $
118 // Revision 1.7 2003/02/15 23:32:56 dairiki
119 // Usability improvements for the RedirectTo plugin.
121 // (Mostly this applies when using RedirectTo with a page=OtherPage
122 // argument to redirect to another page in the same wiki.)
124 // (Most of these ideas are stolen verbatim from UseModWiki.)
126 // o Multiple redirects (PageOne -> PageTwo -> PageThree) not allowed.
128 // o Redirects are not activated except when action == 'browse'.
130 // o When redirections are disabled, (hopefully understandable)
131 // diagnostics are displayed.
133 // o A link to the redirecting page is displayed after the title
134 // of the target page. If the user follows this link, redirects
135 // are disabled. This allows for easy editing of the redirecting
138 // FIXME: Stylesheets, and perhaps templates other than the defaults
139 // will probably have to be updated before this works well in other
140 // styles and/or themes.
142 // Revision 1.6 2003/01/18 22:01:44 carstenklapp
144 // Reformatting & tabs to spaces;
145 // Added copyleft, getVersion, getDescription, rcs_id.
153 // c-hanging-comment-ender-p: nil
154 // indent-tabs-mode: nil