Difference between revisions of "Extension:Selenium.php"

From Organic Design wiki
(splitting sections into an array)
m (organising comments/todo)
Line 39: Line 39:
 
}
 
}
  
# 1) ------------ Deploy tags to allow additional html table tags ------------- #
+
# Deploy tags to allow additional html table tags
# Convert the <selenium> tags to HTML
 
 
function tagSelenium($text,$argv,&$parser) {
 
function tagSelenium($text,$argv,&$parser) {
  
Line 49: Line 48:
 
# Need to convert {{{VARIABLES}}} with parser; [[MWManual:Tag_extensions#Extensions_and_Templates]]
 
# Need to convert {{{VARIABLES}}} with parser; [[MWManual:Tag_extensions#Extensions_and_Templates]]
 
#$parser->replaceVariables($wikitext,$args,true);
 
#$parser->replaceVariables($wikitext,$args,true);
 
# Bypass the 2nd stage of the wiki parser returning htmlspecialchars($text)
 
# $args = '';
 
# foreach ($argv as $k => $v) $args .= "<li><b>$k:</b> <i>$v</i></li>\n";
 
# return "<h3>tagSelenium():</h3>\n<ul>$args<li>Content:</b>$text</ul>\n";
 
  
 
return($text);
 
return($text);
Line 91: Line 85:
  
 
SpecialPage::SpecialPage(
 
SpecialPage::SpecialPage(
'Selenium',     # name as seen in links etc
+
'Selenium',   # name as seen in links etc
 
'sysop',      # user rights required
 
'sysop',      # user rights required
 
true,          # listed in special:specialpages
 
true,          # listed in special:specialpages
Line 100: Line 94:
 
}  
 
}  
  
# 2) -------------------- Create form for Special:Selenium -------------------- #
+
# -------------------- Create form for Special:Selenium --------------------
 
# Override SpecialPage::execute() $param is from the URL, eg Special:Selenium/param
 
# Override SpecialPage::execute() $param is from the URL, eg Special:Selenium/param
 
function execute($param) {
 
function execute($param) {
 
global $wgOut;
 
global $wgOut;
 
global $wgParser;
 
global $wgParser;
 
 
 
 
if($param) {
 
if($param) {
# A) Need to bypass $wgOut and render only Selenium html here
+
# Note: Need to bypass $wgOut and render only Selenium html here
  
 
# Grab article $param and process contents  
 
# Grab article $param and process contents  
Line 119: Line 112:
 
# Split wikitext on sections
 
# Split wikitext on sections
 
$sections = preg_split('/^=+\\s*(.+?)\\s*=+$/ms', $wikitext);
 
$sections = preg_split('/^=+\\s*(.+?)\\s*=+$/ms', $wikitext);
 +
 
foreach($sections as $key => $value) {
 
foreach($sections as $key => $value) {
 
  if($key) {
 
  if($key) {
Line 124: Line 118:
 
  }
 
  }
 
}
 
}
# preg_match_all('/^=+\\s*(.+?)\\s*=+([^=]+)/ms',$wikitext,$m1);
 
# print $wikitext;
 
 
# ---------------- DEBUG --------------- #
 
# ---------------- DEBUG --------------- #
 
$fh = fopen("/tmp/MWdump",'w');
 
$fh = fopen("/tmp/MWdump",'w');
Line 140: Line 132:
 
# 1.3 build output html
 
# 1.3 build output html
 
 
# Process array of matched sections
 
# while (count($m1[1])) {
 
#     $section = array_shift($m1[1]);
 
#            print("SECTION: $section ");
 
#    }
 
 
# print ($wikitext);
 
 
 
# Tranclusion expanding braces  
 
# Tranclusion expanding braces  
 
$wikitext = $wgParser->preprocess($wikitext,$paramTitle,new ParserOptions());
 
$wikitext = $wgParser->preprocess($wikitext,$paramTitle,new ParserOptions());

Revision as of 00:24, 13 December 2007

<?php

  1. Extension:Selenium Template:Php
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.
  1. Category:SeleniumCategory:Extensions created with Template:SpecialPage
  2. - Licenced under LGPL http://www.gnu.org/copyleft/lesser.html
  3. - Author: http://www.organicdesign.co.nz/User:Sven

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

define('SELENIUM_VERSION','0.1.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. Deploy tags to allow additional html table tags

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

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

$text = eregi_replace('.+.+', '', $text); # Need to convert {{{VARIABLES}}} with parser; [[MWManual:Tag_extensions#Extensions_and_Templates]] #$parser->replaceVariables($wikitext,$args,true); return($text); } # Needed in some versions to prevent Special:Version from breaking function __toString() { return 'Selenium'; } } # Called from $wgExtensionFunctions array when initialising extensions function wfSetupSelenium() { global $wgSelenium; $wgSelenium = new Selenium(); } # 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; } # Define a new class based on the SpecialPage class class SpecialSelenium extends SpecialPage { # Properties var $suiteTitle = 'Selenium suite'; var $testName = 'Selenium test'; var $htmlSnippet = array( 'suiteHeader' => '$suiteTitle', 'testHeader' => '$testName', 'Footer' => '', );

  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. -------------------- Create form for Special:Selenium --------------------
  2. Override SpecialPage::execute() $param is from the URL, eg Special:Selenium/param

function execute($param) { global $wgOut; global $wgParser;

if($param) {

  1. Note: Need to bypass $wgOut and render only Selenium html here
  1. Grab article $param and process contents

$paramTitle = Title::newFromText($param); $article = new Article($paramTitle); $wikitext = $article->getContent();

  1. Match sections

preg_match_all('/^=+\\s*(.+?)\\s*=+$/m',$wikitext,$sectionNames);

  1. Split wikitext on sections

$sections = preg_split('/^=+\\s*(.+?)\\s*=+$/ms', $wikitext);

foreach($sections as $key => $value) { if($key) { print("KEY: $key
----
VALUE: $value
----
"); } }

  1. ---------------- DEBUG --------------- #

$fh = fopen("/tmp/MWdump",'w'); $ts = `date`; while (count($sectionNames[1])) { $content = array_shift($sectionNames[1]); print("M1: $content
"); fwrite($fh, "\n$ts$content"); }

  1. ---------------- DEBUG --------------- #
  1. 1.1 for each section
  2. 1.2 determine if selenium tag is present
  3. 1.3 build output html
  1. Tranclusion expanding braces

$wikitext = $wgParser->preprocess($wikitext,$paramTitle,new ParserOptions());

  1. print ($wikitext);

} else {

  1. B) Render Special:Selenium form

$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()); } ?>