lib/plugin/RedirectTo.php

   1 <?php // -*-php-*-
   2
   3 /*
   4  * Copyright 2002 $ThePhpWikiProgrammingTeam
   5  *
   6  * This file is part of PhpWiki.
   7  *
   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.
  12  *
  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.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with PhpWiki; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  21  */
  22
  23 /**
  24  * Redirect to another page or external uri. Kind of PageAlias.
  25  * Usage:
  26  * <<RedirectTo href="http://www.internet-technology.de/fourwins_de.htm" >>
  27  *      or  <<RedirectTo page=AnotherPage >>
  28  *
  29  * Author:  Reini Urban <rurban@x-ray.at>
  30  *
  31  * BUGS/COMMENTS:
  32  * Todo: fix with USE_PATH_INFO = false
  33  *
  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.
  37  */
  38
  39 class WikiPlugin_RedirectTo
  40 extends WikiPlugin
  41 {
  42     function getName() {
  43         return _("RedirectTo");
  44     }
  45
  46     function getDescription() {
  47         return _("Redirects to another URL or page.");
  48     }
  49
  50     function getDefaultArguments() {
  51         return array( 'href' => '',
  52                       'page' => false,
  53                       );
  54     }
  55
  56     function run($dbi, $argstr, &$request, $basepage) {
  57         $args = ($this->getArgs($argstr, $request));
  58
  59         $href = $args['href'];
  60         $page = $args['page'];
  61         if ($href) {
  62             // If URL is urlencoded, decode it.
  63             if (strpos('%', $href) !== false) {
  64                 $href = urldecode($href);
  65             }
  66             $url = strip_tags($href);
  67             if ($url != $href) { // URL contains tags
  68                 return $this->disabled(_("Illegal characters in external URL."));
  69             }
  70             $thispage = $request->getPage();
  71             if (! $thispage->get('locked')) {
  72                 return $this->disabled(_("Redirect to an external URL is only allowed in locked pages."));
  73             }
  74         }
  75         else if ($page) {
  76             $url = WikiURL($page,
  77                            array('redirectfrom' => $request->getArg('pagename')),
  78                            'abs_path');
  79         }
  80         else {
  81             return $this->error(_("'href' or 'page' parameter missing."));
  82         }
  83
  84         if ($page == $request->getArg('pagename')) {
  85             return $this->error(fmt("Recursive redirect to self: '%s'", $url));
  86         }
  87
  88         if ($request->getArg('action') != 'browse') {
  89             return $this->disabled(_("Plugin not run: not in browse mode"));
  90         }
  91
  92         $redirectfrom = $request->getArg('redirectfrom');
  93         if ($redirectfrom !== false) {
  94             if ($redirectfrom)
  95                 return $this->disabled(_("Double redirect not allowed."));
  96             else {
  97                 // Got here by following the "Redirected from ..." link
  98                 // on a browse page.
  99                 return $this->disabled(_("Viewing redirecting page."));
 100             }
 101         }
 102
 103         return $request->redirect($url);
 104     }
 105 };
 106
 107 // Local Variables:
 108 // mode: php
 109 // tab-width: 8
 110 // c-basic-offset: 4
 111 // c-hanging-comment-ender-p: nil
 112 // indent-tabs-mode: nil
 113 // End: