Difference between revisions of "Extension:Selenium.php"

From Organic Design wiki
(comments for selenium tag)
(stripping <html> ... </html> plus debugging)
Line 32: Line 32:
 
function Selenium() {
 
function Selenium() {
 
global $wgHooks,$wgParser,$wgSeleniumTag;
 
global $wgHooks,$wgParser,$wgSeleniumTag;
−
+
 
 
# Add the tagHook
 
# Add the tagHook
 
$wgParser->setHook($wgSeleniumTag,array($this,'tagSelenium'));
 
$wgParser->setHook($wgSeleniumTag,array($this,'tagSelenium'));
Line 41: Line 41:
 
# Convert the <selenium> tags to HTML
 
# Convert the <selenium> tags to HTML
 
function tagSelenium($text,$argv,&$parser) {
 
function tagSelenium($text,$argv,&$parser) {
 +
# ------------------------------- Debugging ----------------------------------- #
 +
 +
# Logging to file -only works in preview mode
 +
function logFile($file, $msg) {
 +
$fh = fopen($file,'a');
 +
$ts = $GLOBALS['wgLang']->timeanddate(wfTimestampNow(),true);
 +
if(is_array($msg)) $msg = print_r($msg, true);
 +
fwrite($fh, "\n---------- $ts ---------> $msg");
 +
}
 +
logFile("/tmp/MWdump.txt", "Before regex:\n$text");
 +
 
# Want the selenium tag to strip out and <html>...</html> enclosing tags
 
# Want the selenium tag to strip out and <html>...</html> enclosing tags
−
+
$text = eregi_replace('<html>.+<table', '<table', $text);
 +
$text = eregi_replace('</table>.+', '</table>', $text);
 +
 
 +
logFile("/tmp/MWdump.txt", "After regex:\n$text");
 +
 
 +
 
 +
# ------------------------------- Debugging ----------------------------------- #
 +
 
 
# Bypass the 2nd stage of the wiki parser returning htmlspecialchars($text)
 
# Bypass the 2nd stage of the wiki parser returning htmlspecialchars($text)
 
$args = '';
 
$args = '';
 
foreach ($argv as $k => $v) $args .= "<li><b>$k:</b> <i>$v</i></li>\n";
 
foreach ($argv as $k => $v) $args .= "<li><b>$k:</b> <i>$v</i></li>\n";
−
return "<h3>tagSelenium():</h3>\n<ul>htmlspecialchars($args)<li>Content:</b> htmlspecialchars($text)</ul>\n";
+
return "<h3>tagSelenium():</h3>\n<ul>$args<li>Content:</b>$text</ul>\n";
 
}
 
}
 
 

Revision as of 01:16, 11 December 2007

<?php

  1. Extension:Selenium
Info.svg These are the MediaWiki extensions we're using and/or developing. Please refer to the information on the mediawiki.org wiki for installation and usage details. Extensions here which have no corresponding mediawiki article are either not ready for use or have been superseded. You can also browse our extension code in our local Subversion repository or our GitHub mirror.

Template:PhpCategory:Extensions created with Template:SpecialPage

  1. - Licenced under LGPL http://www.gnu.org/copyleft/lesser.html
  2. - Author: http://www.organicdesign.co.nz/User:Sven

if (!defined('MEDIAWIKI')) die('Not an entry point.');

define('SELENIUM_VERSION','0.0.1, 2007-12-03 (selenium-core version 0.8.3');

$wgSeleniumTag = "selenium"; $wgExtensionFunctions[] = 'wfSetupSelenium'; $wgExtensionFunctions[] = 'wfSetupSpecialSelenium'; $wgHooks['LanguageGetMagic'][] = 'wfSeleniumLanguageGetMagic';

$wgExtensionCredits['specialpage'][] = array( 'name' => 'Special:Selenium', 'author' => 'User:Sven', 'description' => 'Incorporating Selenium tests into the MediaWiki environment', 'url' => 'http://www.mediawiki.org/wiki/Extension:Selenium', 'version' => SELENIUM_VERSION );

require_once "$IP/includes/SpecialPage.php";

class Selenium {

  1. Properties

var $prop1 = 'default value'; var $prop2 = 'default value';

  1. Constructor

function Selenium() { global $wgHooks,$wgParser,$wgSeleniumTag;

  1. Add the tagHook

$wgParser->setHook($wgSeleniumTag,array($this,'tagSelenium'));

}

  1. 1) ------------ Deploy tags to allow additional html table tags ------------- #
  2. Convert the <selenium> tags to HTML

function tagSelenium($text,$argv,&$parser) {

  1. ------------------------------- Debugging ----------------------------------- #
  1. Logging to file -only works in preview mode

function logFile($file, $msg) { $fh = fopen($file,'a'); $ts = $GLOBALS['wgLang']->timeanddate(wfTimestampNow(),true); if(is_array($msg)) $msg = print_r($msg, true); fwrite($fh, "\n---------- $ts ---------> $msg"); } logFile("/tmp/MWdump.txt", "Before regex:\n$text");

  1. Want the selenium tag to strip out and ... enclosing tags

$text = eregi_replace('<html>.+<table', '<table', $text);

$text = eregi_replace('.+', '', $text);

logFile("/tmp/MWdump.txt", "After regex:\n$text");


  1. ------------------------------- Debugging ----------------------------------- #
  1. Bypass the 2nd stage of the wiki parser returning htmlspecialchars($text)

$args = ;

foreach ($argv as $k => $v) $args .= "

  • $k: $v

    • \n"; return "

    tagSelenium():

    \n

      $args
    • Content:$text

    \n";

    }

    1. Needed in some versions to prevent Special:Version from breaking

    function __toString() { return 'Selenium'; } }

    1. Called from $wgExtensionFunctions array when initialising extensions

    function wfSetupSelenium() { global $wgSelenium; $wgSelenium = new Selenium(); }

    1. Needed in MediaWiki >1.8.0 for magic word hooks to work properly

    function wfSeleniumLanguageGetMagic(&$magicWords,$langCode = 0) { global $wgSeleniumMagic; $magicWords[$wgSeleniumMagic] = array(0,$wgSeleniumMagic); return true; }

    1. Define a new class based on the SpecialPage class

    class SpecialSelenium extends SpecialPage {

    1. Constructor

    function SpecialSelenium() { SpecialPage::SpecialPage( 'Selenium', # name as seen in links etc 'sysop', # user rights required true, # listed in special:specialpages false, # function called by execute() - defaults to wfSpecial{$name} false, # file included by execute() - defaults to Special{$name}.php, only used if no function false # includable ); }

    1. 2) -------------------- Create form for Special:Selenium -------------------- #
    2. Override SpecialPage::execute() $param is from the URL, eg Special:Selenium/param

    function execute($param) { global $wgOut; $this->setHeaders(); $title = Title::makeTitle(NS_SPECIAL,'Selenium'); $wgOut->addWikiText(wfMsg('example-message','exampleParameter')); $wgOut->addHTML( wfElement('form',array('action' => $title->getLocalURL('action=submit'),'method' => 'post'),null) . '<textarea name="target" cols=25 rows=10></textarea>' . wfElement('input',array('type' => 'submit')) . '</form>' ); }

    1. 3) -- Create rendering on the fly of a test article to the suite html code -- #
    1. 4) ---------------- Some sort of validation of article ---------------------- #

    }


    1. Called from $wgExtensionFunctions array when initialising extensions

    function wfSetupSpecialSelenium() { global $wgLanguageCode,$wgMessageCache;

    1. Add the messages used by the specialpage

    if ($wgLanguageCode == 'en') { $wgMessageCache->addMessages(array( 'selenium' => 'Example Specialpage', # The friendly page title 'exampleMessage' => "Example message: $1", )); }

    1. Add the specialpage to the environment

    SpecialPage::addPage(new SpecialSelenium()); } ?>

    Retrieved from "https://organicdesign.nz/wiki/index.php?title=Extension:Selenium.php&oldid=79913"