1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
|
<?php // -*-php-*-
rcs_id('$Id: Transclude.php,v 1.9 2004/06/14 11:31:39 rurban Exp $');
/**
Copyright 1999, 2000, 2001, 2002 $ThePhpWikiProgrammingTeam
This file is part of PhpWiki.
PhpWiki is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
PhpWiki is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with PhpWiki; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
/**
* Transclude: Include an external web page within the body of a wiki page.
*
* Usage:
* <?plugin Transclude
* src=http://www.internet-technology.de/fourwins_de.htm
* ?>
*
* @author Geoffrey T. Dairiki
*
* @see http://www.cs.tut.fi/~jkorpela/html/iframe.html
*
* KNOWN ISSUES
* Will only work if the browser supports <iframe>s (which is a recent,
* but standard tag)
*
* The auto-vertical resize javascript code only works if the transcluded
* page comes from the PhpWiki server. Otherwise (due to "tainting"
* security checks in JavaScript) I can't figure out how to deduce the
* height of the transcluded page via JavaScript... :-/
*
* Sometimes the auto-vertical resize code doesn't seem to make the iframe
* quite big enough --- the scroll bars remain. Not sure why.
*/
class WikiPlugin_Transclude
extends WikiPlugin
{
function getName() {
return _("Transclude");
}
function getDescription() {
return _("Include an external web page within the body of a wiki page.");
}
function getVersion() {
return preg_replace("/[Revision: $]/", '',
"\$Revision: 1.9 $");
}
function getDefaultArguments() {
return array( 'src' => false, // the src url to include
'height' => 450 // height of the iframe
);
}
function run($dbi, $argstr, &$request, $basepage) {
global $WikiTheme;
$args = ($this->getArgs($argstr, $request));
extract($args);
if (!$src) {
return $this->error(fmt("%s parameter missing", "'src'"));
}
// FIXME: Better recursion detection.
// FIXME: Currently this doesnt work at all.
if ($src == $request->getURLtoSelf() ) {
return $this->error(fmt("recursive inclusion of url %s", $src));
}
if (! IsSafeURL($src)) {
return $this->error(_("Bad url in src: remove all of <, >, \""));
}
$params = array('title' => _("Transcluded page"),
'src' => $src,
'width' => "100%",
'height' => $height,
'marginwidth' => 0,
'marginheight' => 0,
'class' => 'transclude',
"onload" => "adjust_iframe_height(this);");
$noframe_msg[] = fmt("See: %s", HTML::a(array('href' => $src), $src));
$noframe_msg = HTML::div(array('class' => 'transclusion'),
HTML::p(array(), $noframe_msg));
$iframe = HTML::div(HTML::iframe($params, $noframe_msg));
/* This doesn't work very well... maybe because CSS screws up NS4 anyway...
$iframe = new HtmlElement('ilayer', array('src' => $src), $iframe);
*/
return HTML(HTML::p(array('class' => 'transclusion-title'),
fmt("Transcluded from %s", LinkURL($src))),
$this->_js(), $iframe);
}
/**
* Produce our javascript.
*
* This is used to resize the iframe to fit the content.
* Currently it only works if the transcluded document comes
* from the same server as the wiki server.
*
* @access private
*/
function _js() {
static $seen = false;
if ($seen)
return '';
$seen = true;
return JavaScript('
function adjust_iframe_height(frame) {
var content = frame.contentDocument;
try {
frame.height = content.height + 2 * frame.marginHeight;
}
catch (e) {
// Can not get content.height unless transcluded doc
// is from the same server...
return;
}
}
window.addEventListener("resize", function() {
f = this.document.body.getElementsByTagName("iframe");
for (var i = 0; i < f.length; i++)
adjust_iframe_height(f[i]);
}, false);
');
}
};
// $Log: Transclude.php,v $
// Revision 1.9 2004/06/14 11:31:39 rurban
// renamed global $Theme to $WikiTheme (gforge nameclash)
// inherit PageList default options from PageList
// default sortby=pagename
// use options in PageList_Selectable (limit, sortby, ...)
// added action revert, with button at action=diff
// added option regex to WikiAdminSearchReplace
//
// Revision 1.8 2004/02/17 12:11:36 rurban
// 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, ...)
//
// Revision 1.7 2003/02/27 22:47:27 dairiki
// New functions in HtmlElement:
//
// JavaScript($js)
// Helper for generating javascript.
//
// IfJavaScript($if_content, $else_content)
// Helper for generating
// <script>document.write('...')</script><noscript>...</noscript>
// constructs.
//
// Revision 1.6 2003/02/25 05:45:34 carstenklapp
// Added "See: " in front of url, so for browsers that do not support
// <iframe> at least there is an indication to the user that this
// plugin is actually doing something while at the same time without
// being (subjectively) too disruptive to page content.
//
// Revision 1.5 2003/02/24 14:34:44 carstenklapp
// Added iframe title (bobby.org accessibility guidelines).
// Simplified output for non-iframe and non-visual browsers (as suggested
// by http://www.uwosh.edu/programs/accessibility/tutorial.html).
//
// Revision 1.4 2003/01/18 22:08:01 carstenklapp
// Code cleanup:
// Reformatting & tabs to spaces;
// Added copyleft, getVersion, getDescription, rcs_id.
//
// (c-file-style: "gnu")
// Local Variables:
// mode: php
// tab-width: 8
// c-basic-offset: 4
// c-hanging-comment-ender-p: nil
// indent-tabs-mode: nil
// End:
?>
|