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  *  <<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 getDefaultArguments() {
  59         return array( 'src'     => false, // the src url to include
  60                       'title'   =>  _("Transcluded page"), // title of the iframe
  61                       'height'  => 450, // height of the iframe
  62                       'quiet'   => false // if set, iframe appears as normal content
  63                     );
  64     }
  65
  66     function run($dbi, $argstr, &$request, $basepage) {
  67         global $WikiTheme;
  68
  69         $args = ($this->getArgs($argstr, $request));
  70         extract($args);
  71
  72         if (!$src) {
  73             return $this->error(fmt("%s parameter missing", "'src'"));
  74         }
  75         // Expand possible interwiki link for src
  76         if (strstr($src,':')
  77             and (!strstr($src,'://'))
  78             and ($intermap = getInterwikiMap())
  79             and preg_match("/^" . $intermap->getRegexp() . ":/", $src))
  80         {
  81             $link = $intermap->link($src);
  82             $src = $link->getAttr('href');
  83         }
  84
  85         // FIXME: Better recursion detection.
  86         // FIXME: Currently this doesnt work at all.
  87         if ($src == $request->getURLtoSelf() ) {
  88             return $this->error(fmt("recursive inclusion of url %s", $src));
  89         }
  90         if (! IsSafeURL($src)) {
  91             return $this->error(_("Bad url in src: remove all of <, >, \""));
  92         }
  93
  94         $params = array('title' => $title,
  95                         'src' => $src,
  96                         'width' => "100%",
  97                         'height' => $height,
  98                         'marginwidth' => 0,
  99                         'marginheight' => 0,
 100                         'class' => 'transclude',
 101                         "onload" => "adjust_iframe_height(this);");
 102
 103         $noframe_msg[] = fmt("See: %s", HTML::a(array('href' => $src), $src));
 104
 105         $noframe_msg = HTML::div(array('class' => 'transclusion'),
 106                                  HTML::p(array(), $noframe_msg));
 107
 108         $iframe = HTML::iframe($params, $noframe_msg);
 109
 110         /* This doesn't work very well...  maybe because CSS screws up NS4 anyway...
 111         $iframe = new HtmlElement('ilayer', array('src' => $src), $iframe);
 112         */
 113
 114         if ($quiet) {
 115             return HTML($this->_js(), $iframe);
 116         } else {
 117             return HTML(HTML::p(array('class' => 'transclusion-title'),
 118                                 fmt("Transcluded from %s", LinkURL($src))),
 119                         $this->_js(), $iframe);
 120         }
 121     }
 122
 123     /**
 124      * Produce our javascript.
 125      *
 126      * This is used to resize the iframe to fit the content.
 127      * Currently it only works if the transcluded document comes
 128      * from the same server as the wiki server.
 129      *
 130      * @access private
 131      */
 132     function _js() {
 133         static $seen = false;
 134
 135         if ($seen)
 136             return '';
 137         $seen = true;
 138
 139         return JavaScript('
 140           function adjust_iframe_height(frame) {
 141             var content = frame.contentDocument;
 142             try {
 143                 frame.height = content.height + 2 * frame.marginHeight;
 144             }
 145             catch (e) {
 146               // Can not get content.height unless transcluded doc
 147               // is from the same server...
 148               return;
 149             }
 150           }
 151
 152           window.addEventListener("resize", function() {
 153             f = this.document.body.getElementsByTagName("iframe");
 154             for (var i = 0; i < f.length; i++)
 155               adjust_iframe_height(f[i]);
 156           }, false);
 157           ');
 158     }
 159 };
 160
 161 // Local Variables:
 162 // mode: php
 163 // tab-width: 8
 164 // c-basic-offset: 4
 165 // c-hanging-comment-ender-p: nil
 166 // indent-tabs-mode: nil
 167 // End:
 168 ?>