|
|
| (18 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| − | <?
| + | {{svn|http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/Livelets}} |
| − | # Extension:Livelets{{#Security:*|dev}}{{#Security:view|*}}{{php}}
| |
| − | # - Allows live articles to be transcluded which update automatically on change in a non-polling, fully event-driven way
| |
| − | # - See http://www.mediawiki.org/wiki/Extension:Livelets for installation and usage details
| |
| − | # - Licenced under LGPL (http://www.gnu.org/copyleft/lesser.html)
| |
| − | # - Author: http://www.organicdesign.co.nz/nad
| |
| | | | |
| − | define('LIVELETS_VERSION', '0.1.0, 2007-05-11');
| + | == Notes == |
| − | | + | Add dev notes here, e.g. regarding the SWF live updates |
| − | $wgLiveletsMagic = "live"; # the parser-function name for doing live-transclusions
| |
| − | $wgExtensionFunctions[] = 'wfSetupLivelets';
| |
| − | $wgHooks['LanguageGetMagic'][] = 'wfLiveletsLanguageGetMagic';
| |
| − | | |
| − | $wgExtensionCredits['parserhook'][] = array(
| |
| − | 'name' => 'Livelets',
| |
| − | 'author' => '[http://www.organicdesign.co.nz/User:Nad User:Nad]',
| |
| − | 'description' => 'dynamic non-polling updates of articles',
| |
| − | 'url' => 'http://www.mediawiki.org/wiki/Extension:Livelets',
| |
| − | 'version' => LIVELETS_VERSION
| |
| − | );
| |
| − | | |
| − | class Livelets {
| |
| − | | |
| − | var $version = LIVELETS_VERSION;
| |
| − | var $id = 0;
| |
| − | | |
| − | # Constructor
| |
| − | function Livelets($magic) {
| |
| − | global $wgParser,$wgHooks,$wgOut,$wgScript,$wgLiveletsPath;
| |
| − | $live = array_key_exists('live',$_REQUEST);
| |
| − | $wgParser->setFunctionHook($magic,array($this,'functionHook'));
| |
| − | }
| |
| − | | |
| − | # Remove live container content
| |
| − | function functionHook(&$parser,$title) {
| |
| − | global $wgScript,$wgLiveletsPath;
| |
| − | $this->addJSandSWF();
| |
| − | $id = 'livelet'.$this->id++; # this should be a GUID
| |
| − | $url = Title::newFromText($title)->getFullURL('action=render');
| |
| − | $html = "<div class='livelet' id='$id' url='$url'><div style='text-align:center'><img src='$wgLiveletsPath/wait.gif'/></div></div>";
| |
| − | $html .= "<script type='text/javascript'>liveletRequest('$id')</script>";
| |
| − | return array($html,isHTML => true);
| |
| − | }
| |
| − | | |
| − | function addJSandSWF() {
| |
| − | global $wgOut,$wgLiveletsPath,$wgAddJavaScriptFunctions;
| |
| − | | |
| − | # Add the livelets JavaScript functions to the output page
| |
| − | $wgAddJavaScriptFunctions['Livelets'] = "
| |
| − | | |
| − | // Keep record of livelets on page
| |
| − | var livelets = new Array();
| |
| − | | |
| − | // Request an URL
| |
| − | function liveletRequest(id) {
| |
| − | livelet = document.getElementById(id)
| |
| − | livelets.push(livelet);
| |
| − | livelet.id = id
| |
| − | livelet.url = livelet.getAttribute(url);
| |
| − | livelet.xmlhttp = null
| |
| − | if (window.XMLHttpRequest) livelet.xmlhttp = new XMLHttpRequest()
| |
| − | else if (window.ActiveXObject) livelet.xmlhttp = new ActiveXObject('Microsoft.XMLHTTP')
| |
| − | if (livelet.xmlhttp != null) {
| |
| − | livelet.xmlhttp.onreadystatechange = stateChange
| |
| − | livelet.xmlhttp.open('GET',livelet.url,true)
| |
| − | livelet.xmlhttp.send(null)
| |
| − | }
| |
| − | else alert('Your browser does not support XMLHTTP!')
| |
| − | }
| |
| − | | |
| − | // Update the livelet content when loaded
| |
| − | function stateChange() {
| |
| − | for (var i = 0; i < livelets.length; i++) {
| |
| − | var livelet = livelets[i];
| |
| − | var xmlhttp = livelet.xmlhttp
| |
| − | if (xmlhttp.readyState == 4) {
| |
| − | if (xmlhttp.status == 200) livelet.innerHTML = xmlhttp.responseText
| |
| − | else alert('Problem retrieving XML data!')
| |
| − | xmlhttp.readyState = 0;
| |
| − | }
| |
| − | }
| |
| − | }
| |
| − | | |
| − | // Trap fscommands from the SWF movie
| |
| − | function livelets_DoFScommand(cmd,args) {
| |
| − | alert(args)
| |
| − | }";
| |
| − | | |
| − | # Embed livelets.swf into the output page
| |
| − | # NOTE: this actually needs to be served by the WikiDaemon, not the PHP
| |
| − | $swf = "$wgLiveletsPath/livelets.swf";
| |
| − | $wgOut->addHTML("<object classid='clsid:D27CDB6E-AE6D-11cf-96B8-444553540000' codebase='http://active.macromedia.com/flash2/cabs/swflash.cab#version=4,0,0,0'
| |
| − | id='livelets' width=100 height=100>
| |
| − | <param name='movie' value='$swf'>
| |
| − | <embed swliveconnect='true' name='livelets' src='$swf' width=100 height=100 type='application/x-shockwave-flash' pluginspage='http://www.macromedia.com/shockwave/download/index.cgi?P1_Prod_Version=ShockwaveFlash'>
| |
| − | </embed></object>");
| |
| − | }
| |
| − | | |
| − | }
| |
| − | | |
| − | # Called from $wgExtensionFunctions array when initialising extensions
| |
| − | function wfSetupLivelets() {
| |
| − | global $wgLivelets,$wgLiveletsMagic,$wgScriptPath,$wgLiveletsPath;
| |
| − | $wgLivelets = new Livelets($wgLiveletsMagic);
| |
| − | if ($wgLiveletsPath == '') $wgLiveletsPath = "$wgScriptPath/extensions/livelets";
| |
| − | }
| |
| − | | |
| − | # Needed in MediaWiki >1.8.0 for magic word hooks to work properly
| |
| − | function wfLiveletsLanguageGetMagic(&$magicWords,$langCode = 0) {
| |
| − | global $wgLiveletsMagic;
| |
| − | $magicWords[$wgLiveletsMagic] = array(0,$wgLiveletsMagic);
| |
| − | return true;
| |
| − | }
| |
| − | | |
| − | {{AddJavaScript}}
| |
| − | ?>
| |
