lib/plugin/Transclude.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id$');
   3 /**
   4  Copyright 1999,2000,2001,2002,2006 $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  * Transclude:  Include an external web page within the body of a wiki page.
  25  *
  26  * Usage:
  27  *  <?plugin Transclude
  28  *           src=http://www.internet-technology.de/fourwins_de.htm
  29  *  ?>
  30  *
  31  * @author Geoffrey T. Dairiki
  32  *
  33  * @see http://www.cs.tut.fi/~jkorpela/html/iframe.html
  34  *
  35  * KNOWN ISSUES
  36  *  Will only work if the browser supports <iframe>s (which is a recent,
  37  *  but standard tag)
  38  *
  39  *  The auto-vertical resize javascript code only works if the transcluded
  40  *  page comes from the PhpWiki server.  Otherwise (due to "tainting"
  41  *  security checks in JavaScript) I can't figure out how to deduce the
  42  *  height of the transcluded page via JavaScript... :-/
  43  *
  44  *  Sometimes the auto-vertical resize code doesn't seem to make the iframe
  45  *  quite big enough --- the scroll bars remain.  Not sure why.
  46  */
  47 class WikiPlugin_Transclude
  48 extends WikiPlugin
  49 {
  50     function getName() {
  51         return _("Transclude");
  52     }
  53
  54     function getDescription() {
  55       return _("Include an external web page within the body of a wiki page.");
  56     }
  57
  58     function getVersion() {
  59         return preg_replace("/[Revision: $]/", '',
  60                             "\$Revision$");
  61     }
  62
  63     function getDefaultArguments() {
  64         return array( 'src'     => false, // the src url to include
  65                       'title'   =>  _("Transcluded page"), // title of the iframe
  66                       'height'  => 450, // height of the iframe
  67                       'quiet'   => false // if set, iframe appears as normal content
  68                     );
  69     }
  70
  71     function run($dbi, $argstr, &$request, $basepage) {
  72         global $WikiTheme;
  73
  74         $args = ($this->getArgs($argstr, $request));
  75         extract($args);
  76
  77         if (!$src) {
  78             return $this->error(fmt("%s parameter missing", "'src'"));
  79         }
  80         // Expand possible interwiki link for src
  81         if (strstr($src,':')
  82             and (!strstr($src,'://'))
  83             and ($intermap = getInterwikiMap())
  84             and preg_match("/^" . $intermap->getRegexp() . ":/", $src))
  85         {
  86             $link = $intermap->link($src);
  87             $src = $link->getAttr('href');
  88         }
  89
  90         // FIXME: Better recursion detection.
  91         // FIXME: Currently this doesnt work at all.
  92         if ($src == $request->getURLtoSelf() ) {
  93             return $this->error(fmt("recursive inclusion of url %s", $src));
  94         }
  95         if (! IsSafeURL($src)) {
  96             return $this->error(_("Bad url in src: remove all of <, >, \""));
  97         }
  98
  99         $params = array('title' => $title,
 100                         'src' => $src,
 101                         'width' => "100%",
 102                         'height' => $height,
 103                         'marginwidth' => 0,
 104                         'marginheight' => 0,
 105                         'class' => 'transclude',
 106                         "onload" => "adjust_iframe_height(this);");
 107
 108         $noframe_msg[] = fmt("See: %s", HTML::a(array('href' => $src), $src));
 109
 110         $noframe_msg = HTML::div(array('class' => 'transclusion'),
 111                                  HTML::p(array(), $noframe_msg));
 112
 113         $iframe = HTML::div(HTML::iframe($params, $noframe_msg));
 114
 115         /* This doesn't work very well...  maybe because CSS screws up NS4 anyway...
 116         $iframe = new HtmlElement('ilayer', array('src' => $src), $iframe);
 117         */
 118
 119         if ($quiet) {
 120             return HTML($this->_js(), $iframe);
 121         } else {
 122             return HTML(HTML::p(array('class' => 'transclusion-title'),
 123                                 fmt("Transcluded from %s", LinkURL($src))),
 124                         $this->_js(), $iframe);
 125         }
 126     }
 127
 128     /**
 129      * Produce our javascript.
 130      *
 131      * This is used to resize the iframe to fit the content.
 132      * Currently it only works if the transcluded document comes
 133      * from the same server as the wiki server.
 134      *
 135      * @access private
 136      */
 137     function _js() {
 138         static $seen = false;
 139
 140         if ($seen)
 141             return '';
 142         $seen = true;
 143
 144         return JavaScript('
 145           function adjust_iframe_height(frame) {
 146             var content = frame.contentDocument;
 147             try {
 148                 frame.height = content.height + 2 * frame.marginHeight;
 149             }
 150             catch (e) {
 151               // Can not get content.height unless transcluded doc
 152               // is from the same server...
 153               return;
 154             }
 155           }
 156
 157           window.addEventListener("resize", function() {
 158             f = this.document.body.getElementsByTagName("iframe");
 159             for (var i = 0; i < f.length; i++)
 160               adjust_iframe_height(f[i]);
 161           }, false);
 162           ');
 163     }
 164 };
 165
 166 // (c-file-style: "gnu")
 167 // Local Variables:
 168 // mode: php
 169 // tab-width: 8
 170 // c-basic-offset: 4
 171 // c-hanging-comment-ender-p: nil
 172 // indent-tabs-mode: nil
 173 // End:
 174 ?>