lib/plugin/RedirectTo.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id: RedirectTo.php,v 1.6 2003-01-18 22:01:44 carstenklapp Exp $');
   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
  19  along with PhpWiki; if not, write to the Free Software
  20  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 /**
  24  * Redirect to another page or external uri. Kind of PageAlias.
  25  * Usage:
  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.
  29  *
  30  * Author:  Reini Urban <rurban@x-ray.at>
  31  *
  32  * BUGS/COMMENTS:
  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  * 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)".
  41  */
  42 class WikiPlugin_RedirectTo
  43 extends WikiPlugin
  44 {
  45     function getName() {
  46         return _("RedirectTo");
  47     }
  48
  49     function getDescription() {
  50         return _("Redirects to another url or page.");
  51     }
  52
  53     function getVersion() {
  54         return preg_replace("/[Revision: $]/", '',
  55                             "\$Revision: 1.6 $");
  56     }
  57
  58     function getDefaultArguments() {
  59         return array( 'href' => '',
  60                       // 'type' => 'Temp' // or 'Permanent' // so far ignored
  61                       'page' => false,
  62                       'args' => false,  // pass more args to the page. TestMe!
  63                       );
  64     }
  65
  66     function run($dbi, $argstr, $request) {
  67         $args = ($this->getArgs($argstr, $request));
  68         $href = $args['href'];
  69         $page = $args['page'];
  70         if ($href) {
  71             /*
  72              * Use quotes on the href argument value, like:
  73              *   <?plugin RedirectTo href="http://funky.com/a b \" c.htm" ?>
  74              *
  75              * Do we want some checking on href to avoid malicious
  76              * uses of the plugin? Like stripping tags or hexcode.
  77              */
  78             $url = preg_replace('/%\d\d/','',strip_tags($href));
  79             $thispage = $request->getPage();
  80             if (! $thispage->get('locked')) {
  81                 return $this->error(HTML(fmt(_("%s is only allowed in locked pages."),
  82                                              _("Redirect to an external url")),
  83                                          HTML::br(),
  84                                          fmt("url=\"%s\"", $url)));
  85             }
  86         }
  87         else if ($page) {
  88             $url = $request->getURLtoSelf(array_merge(array('pagename' => $page,
  89                                                             'redirectfrom' => $request->getArg('pagename')),
  90                                                       SplitQueryArgs($args['args'])));
  91         }
  92         else
  93             return $this->error(sprintf(_("%s or %s parameter missing"),
  94                                         "'href'", "'page'"));
  95
  96         if ($page == $request->getArg('pagename')) {
  97             return $this->error(sprintf(_("Recursive redirect to self: '%s'"),
  98                                         $url));
  99         }
 100         return $request->redirect($url);
 101     }
 102 };
 103
 104 // $Log: not supported by cvs2svn $
 105
 106 // For emacs users
 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:
 114 ?>