lib/plugin/FrameInclude.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id$');
   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  * FrameInclude:  Displays a url or page in a seperate frame inside our body.
  25  *
  26  * Usage:
  27  *  <?plugin FrameInclude src=http://www.internet-technology.de/fourwins_de.htm ?>
  28  *  <?plugin FrameInclude page=OtherPage ?>
  29  *  at the VERY BEGINNING in the content!
  30  *
  31  * Author:  Reini Urban <rurban@x-ray.at>, rewrite by Jeff Dairiki <dairiki@dairiki.org>
  32  *
  33  * KNOWN ISSUES:
  34  *
  35  * This is a dirty hack into the whole system. To display the page as
  36  * frameset we:
  37  *
  38  *  1. Discard any output buffered so far.
  39  *  2. Recursively call displayPage with magic arguments to generate
  40  *     the frameset (or individual frame contents.)
  41  *  3. Exit early.  (So this plugin is usually a no-return.)
  42  *
  43  *  In any cases we can now serve only specific templates with the new
  44  *  frame argument. The whole page is now ?frame=html (before it was
  45  *  named "top") For the Sidebar theme (or derived from it) we provide
  46  *  a left frame also, otherwise only top, content and bottom.
  47  */
  48 class WikiPlugin_FrameInclude
  49 extends WikiPlugin
  50 {
  51     function getName() {
  52         return _("FrameInclude");
  53     }
  54
  55     function getDescription() {
  56         return _("Displays a url in a seperate frame inside our body. Only one frame allowed.");
  57     }
  58
  59     function getVersion() {
  60         return preg_replace("/[Revision: $]/", '',
  61                             "\$Revision$");
  62     }
  63
  64     function getDefaultArguments() {
  65         return array( 'src'         => false,       // the src url to include
  66                       'page'        => false,
  67                       'name'        => 'content',   // name of our frame
  68                       'title'       => false,
  69                       'rows'        => '18%,*,15%', // names: top, $name, bottom
  70                       'cols'        => '20%,*',     // names: left, $name
  71                                                     // only useful on Theme "Sidebar"
  72                       'frameborder' => 1,
  73                       'marginwidth'  => false,
  74                       'marginheight' => false,
  75                       'noresize'    => false,
  76                       'scrolling'   => 'auto',  // '[ yes | no | auto ]'
  77                     );
  78     }
  79
  80     function run($dbi, $argstr, &$request, $basepage) {
  81         global $WikiTheme;
  82
  83         $args = ($this->getArgs($argstr, $request));
  84         extract($args);
  85
  86         if ($request->getArg('action') != 'browse')
  87             return $this->disabled("(action != 'browse')");
  88         if (! $request->isGetOrHead())
  89             return $this->disabled("(method != 'GET')");
  90
  91         if (!$src and $page) {
  92             if ($page == $request->get('pagename')) {
  93                 return $this->error(sprintf(_("recursive inclusion of page %s"),
  94                                             $page));
  95             }
  96             $src = WikiURL($page);
  97         }
  98         if (!$src) {
  99             return $this->error(sprintf(_("%s or %s parameter missing"),
 100                                         'src', 'page'));
 101         }
 102
 103         // FIXME: How to normalize url's to compare against recursion?
 104         if ($src == $request->getURLtoSelf() ) {
 105             return $this->error(sprintf(_("recursive inclusion of url %s"),
 106                                         $src));
 107         }
 108
 109         static $noframes = false;
 110         if ($noframes) {
 111             // Content for noframes version of page.
 112             return HTML::p(fmt("See %s",
 113                                HTML::a(array('href' => $src), $src)));
 114         }
 115         $noframes = true;
 116
 117         if (($which = $request->getArg('frame'))) {
 118             // Generate specialized frame output (header, footer, etc...)
 119             $request->discardOutput();
 120             displayPage($request, new Template("frame-$which", $request));
 121             $request->finish(); //noreturn
 122         }
 123
 124         // Generate the outer frameset
 125         $frame = HTML::frame(array('name' => $name,
 126                                    'src' => $src,
 127                                    'title' => $title,
 128                                    'frameborder' => (int)$frameborder,
 129                                    'scrolling' => (string)$scrolling,
 130                                    'noresize' => (bool)$noresize,
 131                                    ));
 132
 133         if ($marginwidth)
 134             $frame->setArg('marginwidth', $marginwidth);
 135         if ($marginheight)
 136             $frame->setArg('marginheight', $marginheight);
 137
 138         $tokens = array('CONTENT_FRAME' => $frame,
 139                         'ROWS' => $rows,
 140                         'COLS' => $cols,
 141                         'FRAMEARGS' => sprintf('frameborder="%d"', $frameborder),
 142                         );
 143
 144         // Produce the frameset.
 145         $request->discardOutput();
 146         displayPage($request, new Template('frameset', $request, $tokens));
 147         $request->finish(); //noreturn
 148     }
 149 };
 150
 151 // $Log: not supported by cvs2svn $
 152 // Revision 1.9  2004/02/17 12:11:36  rurban
 153 // added missing 4th basepage arg at plugin->run() to almost all plugins. This caused no harm so far, because it was silently dropped on normal usage. However on plugin internal ->run invocations it failed. (InterWikiSearch, IncludeSiteMap, ...)
 154 //
 155 // Revision 1.8  2003/02/26 22:32:06  dairiki
 156 // Wups.  Delete disused cruft.
 157 //
 158 // Revision 1.7  2003/02/26 22:27:19  dairiki
 159 // Fix and refactor FrameInclude plugin (more or less).
 160 //
 161 // (This should now generate valid HTML.  Woohoo!)
 162 //
 163 // The output when using the Sidebar theme is ugly enough that it should
 164 // be considered broken.  (But the Sidebar theme appears pretty broken in
 165 // general right now.)
 166 //
 167 // (Personal comment (not to be taken personally): I must say that I
 168 // remain unconvinced of the usefulness of this plugin.)
 169 //
 170 // Revision 1.6  2003/01/18 21:41:01  carstenklapp
 171 // Code cleanup:
 172 // Reformatting & tabs to spaces;
 173 // Added copyleft, getVersion, getDescription, rcs_id.
 174 //
 175
 176 // For emacs users
 177 // Local Variables:
 178 // mode: php
 179 // tab-width: 8
 180 // c-basic-offset: 4
 181 // c-hanging-comment-ender-p: nil
 182 // indent-tabs-mode: nil
 183 // End:
 184 ?>