From 634da2e10da02575949c67f090dc580a42ab042e Mon Sep 17 00:00:00 2001 From: Aryeh Gregor Date: Sun, 26 Jul 2009 04:09:16 +0000 Subject: [PATCH] Remove obsolete CBT stuff --- includes/cbt/CBTCompiler.php | 366 --------- includes/cbt/CBTProcessor.php | 539 ------------ includes/cbt/README | 108 --- skins/disabled/MonoBook.tpl | 200 ----- skins/disabled/MonoBookCBT.php | 1400 -------------------------------- 5 files changed, 2613 deletions(-) delete mode 100644 includes/cbt/CBTCompiler.php delete mode 100644 includes/cbt/CBTProcessor.php delete mode 100644 includes/cbt/README delete mode 100644 skins/disabled/MonoBook.tpl delete mode 100644 skins/disabled/MonoBookCBT.php diff --git a/includes/cbt/CBTCompiler.php b/includes/cbt/CBTCompiler.php deleted file mode 100644 index 759557978c..0000000000 --- a/includes/cbt/CBTCompiler.php +++ /dev/null @@ -1,366 +0,0 @@ -opcode = $opcode; - $this->arg1 = $arg1; - $this->arg2 = $arg2; - } - - function name() { - $opcodeNames = array( - CBT_PUSH => 'PUSH', - CBT_CAT => 'CAT', - CBT_CATS => 'CATS', - CBT_CALL => 'CALL', - CBT_HX => 'HX', - ); - return $opcodeNames[$this->opcode]; - } -}; - -class CBTCompiler { - var $mOps = array(); - var $mCode; - - function CBTCompiler( $text ) { - $this->mText = $text; - } - - /** - * Compile the text. - * Returns true on success, error message on failure - */ - function compile() { - $this->mLastError = false; - $this->mOps = array(); - - $this->doText( 0, strlen( $this->mText ) ); - - if ( $this->mLastError !== false ) { - $pos = $this->mErrorPos; - - // Find the line number at which the error occurred - $startLine = 0; - $endLine = 0; - $line = 0; - do { - if ( $endLine ) { - $startLine = $endLine + 1; - } - $endLine = strpos( $this->mText, "\n", $startLine ); - ++$line; - } while ( $endLine !== false && $endLine < $pos ); - - $text = "Template error at line $line: $this->mLastError\n
\n";
-
-			$context = rtrim( str_replace( "\t", " ", substr( $this->mText, $startLine, $endLine - $startLine ) ) );
-			$text .= htmlspecialchars( $context ) . "\n" . str_repeat( ' ', $pos - $startLine ) . "^\n
\n"; - } else { - $text = true; - } - - return $text; - } - - /** Shortcut for doOpenText( $start, $end, false */ - function doText( $start, $end ) { - return $this->doOpenText( $start, $end, false ); - } - - function phpQuote( $text ) { - return "'" . strtr( $text, array( "\\" => "\\\\", "'" => "\\'" ) ) . "'"; - } - - function op( $opcode, $arg1 = null, $arg2 = null) { - return new CBTOp( $opcode, $arg1, $arg2 ); - } - - /** - * Recursive workhorse for text mode. - * - * Processes text mode starting from offset $p, until either $end is - * reached or a closing brace is found. If $needClosing is false, a - * closing brace will flag an error, if $needClosing is true, the lack - * of a closing brace will flag an error. - * - * The parameter $p is advanced to the position after the closing brace, - * or after the end. A CBTValue is returned. - * - * @private - */ - function doOpenText( &$p, $end, $needClosing = true ) { - $in =& $this->mText; - $start = $p; - $atStart = true; - - $foundClosing = false; - while ( $p < $end ) { - $matchLength = strcspn( $in, CBT_BRACE, $p, $end - $p ); - $pToken = $p + $matchLength; - - if ( $pToken >= $end ) { - // No more braces, output remainder - if ( $atStart ) { - $this->mOps[] = $this->op( CBT_PUSH, substr( $in, $p ) ); - $atStart = false; - } else { - $this->mOps[] = $this->op( CBT_CAT, substr( $in, $p ) ); - } - $p = $end; - break; - } - - // Output the text before the brace - if ( $atStart ) { - $this->mOps[] = $this->op( CBT_PUSH, substr( $in, $p, $matchLength ) ); - $atStart = false; - } else { - $this->mOps[] = $this->op( CBT_CAT, substr( $in, $p, $matchLength ) ); - } - - // Advance the pointer - $p = $pToken + 1; - - // Check for closing brace - if ( $in[$pToken] == '}' ) { - $foundClosing = true; - break; - } - - // Handle the "{fn}" special case - if ( $pToken > 0 && $in[$pToken-1] == '"' ) { - $this->doOpenFunction( $p, $end ); - if ( $p < $end && $in[$p] == '"' ) { - $this->mOps[] = $this->op( CBT_HX ); - } - } else { - $this->doOpenFunction( $p, $end ); - } - if ( $atStart ) { - $atStart = false; - } else { - $this->mOps[] = $this->op( CBT_CATS ); - } - } - if ( $foundClosing && !$needClosing ) { - $this->error( 'Errant closing brace', $p ); - } elseif ( !$foundClosing && $needClosing ) { - $this->error( 'Unclosed text section', $start ); - } else { - if ( $atStart ) { - $this->mOps[] = $this->op( CBT_PUSH, '' ); - } - } - } - - /** - * Recursive workhorse for function mode. - * - * Processes function mode starting from offset $p, until either $end is - * reached or a closing brace is found. If $needClosing is false, a - * closing brace will flag an error, if $needClosing is true, the lack - * of a closing brace will flag an error. - * - * The parameter $p is advanced to the position after the closing brace, - * or after the end. A CBTValue is returned. - * - * @private - */ - function doOpenFunction( &$p, $end, $needClosing = true ) { - $in =& $this->mText; - $start = $p; - $argCount = 0; - - $foundClosing = false; - while ( $p < $end ) { - $char = $in[$p]; - if ( $char == '{' ) { - // Switch to text mode - ++$p; - $this->doOpenText( $p, $end ); - ++$argCount; - } elseif ( $char == '}' ) { - // Block end - ++$p; - $foundClosing = true; - break; - } elseif ( false !== strpos( CBT_WHITE, $char ) ) { - // Whitespace - // Consume the rest of the whitespace - $p += strspn( $in, CBT_WHITE, $p, $end - $p ); - } else { - // Token, find the end of it - $tokenLength = strcspn( $in, CBT_DELIM, $p, $end - $p ); - $this->mOps[] = $this->op( CBT_PUSH, substr( $in, $p, $tokenLength ) ); - - // Execute the token as a function if it's not the function name - if ( $argCount ) { - $this->mOps[] = $this->op( CBT_CALL, 1 ); - } - - $p += $tokenLength; - ++$argCount; - } - } - if ( !$foundClosing && $needClosing ) { - $this->error( 'Unclosed function', $start ); - return ''; - } - - $this->mOps[] = $this->op( CBT_CALL, $argCount ); - } - - /** - * Set a flag indicating that an error has been found. - */ - function error( $text, $pos = false ) { - $this->mLastError = $text; - if ( $pos === false ) { - $this->mErrorPos = $this->mCurrentPos; - } else { - $this->mErrorPos = $pos; - } - } - - function getLastError() { - return $this->mLastError; - } - - function opsToString() { - $s = ''; - foreach( $this->mOps as $op ) { - $s .= $op->name(); - if ( !is_null( $op->arg1 ) ) { - $s .= ' ' . var_export( $op->arg1, true ); - } - if ( !is_null( $op->arg2 ) ) { - $s .= ' ' . var_export( $op->arg2, true ); - } - $s .= "\n"; - } - return $s; - } - - function generatePHP( $functionObj ) { - $fname = 'CBTCompiler::generatePHP'; - wfProfileIn( $fname ); - $stack = array(); - - foreach( $this->mOps as $op ) { - switch( $op->opcode ) { - case CBT_PUSH: - $stack[] = $this->phpQuote( $op->arg1 ); - break; - case CBT_CAT: - $val = array_pop( $stack ); - array_push( $stack, "$val . " . $this->phpQuote( $op->arg1 ) ); - break; - case CBT_CATS: - $right = array_pop( $stack ); - $left = array_pop( $stack ); - array_push( $stack, "$left . $right" ); - break; - case CBT_CALL: - $args = array_slice( $stack, count( $stack ) - $op->arg1, $op->arg1 ); - $stack = array_slice( $stack, 0, count( $stack ) - $op->arg1 ); - - // Some special optimised expansions - if ( $op->arg1 == 0 ) { - $result = ''; - } else { - $func = array_shift( $args ); - if ( substr( $func, 0, 1 ) == "'" && substr( $func, -1 ) == "'" ) { - $func = substr( $func, 1, strlen( $func ) - 2 ); - if ( $func == "if" ) { - if ( $op->arg1 < 3 ) { - // This should have been caught during processing - return "Not enough arguments to if"; - } elseif ( $op->arg1 == 3 ) { - $result = "(({$args[0]} != '') ? ({$args[1]}) : '')"; - } else { - $result = "(({$args[0]} != '') ? ({$args[1]}) : ({$args[2]}))"; - } - } elseif ( $func == "true" ) { - $result = "true"; - } elseif( $func == "lbrace" || $func == "{" ) { - $result = "{"; - } elseif( $func == "rbrace" || $func == "}" ) { - $result = "}"; - } elseif ( $func == "escape" || $func == "~" ) { - $result = "htmlspecialchars({$args[0]})"; - } else { - // Known function name - $result = "{$functionObj}->{$func}(" . implode( ', ', $args ) . ')'; - } - } else { - // Unknown function name - $result = "call_user_func(array($functionObj, $func), " . implode( ', ', $args ) . ' )'; - } - } - array_push( $stack, $result ); - break; - case CBT_HX: - $val = array_pop( $stack ); - array_push( $stack, "htmlspecialchars( $val )" ); - break; - default: - return "Unknown opcode {$op->opcode}\n"; - } - } - wfProfileOut( $fname ); - if ( count( $stack ) !== 1 ) { - return "Error, stack count incorrect\n"; - } - return ' - global $cbtExecutingGenerated; - ++$cbtExecutingGenerated; - $output = ' . $stack[0] . '; - --$cbtExecutingGenerated; - return $output; - '; - } -} diff --git a/includes/cbt/CBTProcessor.php b/includes/cbt/CBTProcessor.php deleted file mode 100644 index 4fa1a93b88..0000000000 --- a/includes/cbt/CBTProcessor.php +++ /dev/null @@ -1,539 +0,0 @@ - '{[}', '}' => '{]}' ) ); -} - -/** - * Create a CBTValue - */ -function cbt_value( $text = '', $deps = array(), $isTemplate = false ) { - global $cbtExecutingGenerated; - if ( $cbtExecutingGenerated ) { - return $text; - } else { - return new CBTValue( $text, $deps, $isTemplate ); - } -} - -/** - * A dependency-tracking value class - * Callback functions should return one of these, unless they have - * no dependencies in which case they can return a string. - */ -class CBTValue { - var $mText, $mDeps, $mIsTemplate; - - /** - * Create a new value - * @param $text String: , default ''. - * @param $deps Array: what this value depends on - * @param $isTemplate Bool: whether the result needs compilation/execution, default 'false'. - */ - function CBTValue( $text = '', $deps = array(), $isTemplate = false ) { - $this->mText = $text; - if ( !is_array( $deps ) ) { - $this->mDeps = array( $deps ) ; - } else { - $this->mDeps = $deps; - } - $this->mIsTemplate = $isTemplate; - } - - /** Concatenate two values, merging their dependencies */ - function cat( $val ) { - if ( is_object( $val ) ) { - $this->addDeps( $val ); - $this->mText .= $val->mText; - } else { - $this->mText .= $val; - } - } - - /** Add the dependencies of another value to this one */ - function addDeps( $values ) { - if ( !is_array( $values ) ) { - $this->mDeps = array_merge( $this->mDeps, $values->mDeps ); - } else { - foreach ( $values as $val ) { - if ( !is_object( $val ) ) { - var_dump( debug_backtrace() ); - exit; - } - $this->mDeps = array_merge( $this->mDeps, $val->mDeps ); - } - } - } - - /** Remove a list of dependencies */ - function removeDeps( $deps ) { - $this->mDeps = array_diff( $this->mDeps, $deps ); - } - - function setText( $text ) { - $this->mText = $text; - } - - function getText() { - return $this->mText; - } - - function getDeps() { - return $this->mDeps; - } - - /** If the value is a template, execute it */ - function execute( &$processor ) { - if ( $this->mIsTemplate ) { - $myProcessor = new CBTProcessor( $this->mText, $processor->mFunctionObj, $processor->mIgnorableDeps ); - $myProcessor->mCompiling = $processor->mCompiling; - $val = $myProcessor->doText( 0, strlen( $this->mText ) ); - if ( $myProcessor->getLastError() ) { - $processor->error( $myProcessor->getLastError() ); - $this->mText = ''; - } else { - $this->mText = $val->mText; - $this->addDeps( $val ); - } - if ( !$processor->mCompiling ) { - $this->mIsTemplate = false; - } - } - } - - /** If the value is plain text, escape it for inclusion in a template */ - function templateEscape() { - if ( !$this->mIsTemplate ) { - $this->mText = cbt_escape( $this->mText ); - } - } - - /** Return true if the value has no dependencies */ - function isStatic() { - return count( $this->mDeps ) == 0; - } -} - -/** - * Template processor, for compilation and execution - */ -class CBTProcessor { - var $mText, # The text being processed - $mFunctionObj, # The object containing callback functions - $mCompiling = false, # True if compiling to a template, false if executing to text - $mIgnorableDeps = array(), # Dependency names which should be treated as static - $mFunctionCache = array(), # A cache of function results keyed by argument hash - $mLastError = false, # Last error message or false for no error - $mErrorPos = 0, # Last error position - - /** Built-in functions */ - $mBuiltins = array( - 'if' => 'bi_if', - 'true' => 'bi_true', - '[' => 'bi_lbrace', - 'lbrace' => 'bi_lbrace', - ']' => 'bi_rbrace', - 'rbrace' => 'bi_rbrace', - 'escape' => 'bi_escape', - '~' => 'bi_escape', - ); - - /** - * Create a template processor for a given text, callback object and static dependency list - */ - function CBTProcessor( $text, $functionObj, $ignorableDeps = array() ) { - $this->mText = $text; - $this->mFunctionObj = $functionObj; - $this->mIgnorableDeps = $ignorableDeps; - } - - /** - * Execute the template. - * If $compile is true, produces an optimised template where functions with static - * dependencies have been replaced by their return values. - */ - function execute( $compile = false ) { - $fname = 'CBTProcessor::execute'; - wfProfileIn( $fname ); - $this->mCompiling = $compile; - $this->mLastError = false; - $val = $this->doText( 0, strlen( $this->mText ) ); - $text = $val->getText(); - if ( $this->mLastError !== false ) { - $pos = $this->mErrorPos; - - // Find the line number at which the error occurred - $startLine = 0; - $endLine = 0; - $line = 0; - do { - if ( $endLine ) { - $startLine = $endLine + 1; - } - $endLine = strpos( $this->mText, "\n", $startLine ); - ++$line; - } while ( $endLine !== false && $endLine < $pos ); - - $text = "Template error at line $line: $this->mLastError\n
\n";
-
-			$context = rtrim( str_replace( "\t", " ", substr( $this->mText, $startLine, $endLine - $startLine ) ) );
-			$text .= htmlspecialchars( $context ) . "\n" . str_repeat( ' ', $pos - $startLine ) . "^\n
\n"; - } - wfProfileOut( $fname ); - return $text; - } - - /** Shortcut for execute(true) */ - function compile() { - $fname = 'CBTProcessor::compile'; - wfProfileIn( $fname ); - $s = $this->execute( true ); - wfProfileOut( $fname ); - return $s; - } - - /** Shortcut for doOpenText( $start, $end, false */ - function doText( $start, $end ) { - return $this->doOpenText( $start, $end, false ); - } - - /** - * Escape text for a template if we are producing a template. Do nothing - * if we are producing plain text. - */ - function templateEscape( $text ) { - if ( $this->mCompiling ) { - return cbt_escape( $text ); - } else { - return $text; - } - } - - /** - * Recursive workhorse for text mode. - * - * Processes text mode starting from offset $p, until either $end is - * reached or a closing brace is found. If $needClosing is false, a - * closing brace will flag an error, if $needClosing is true, the lack - * of a closing brace will flag an error. - * - * The parameter $p is advanced to the position after the closing brace, - * or after the end. A CBTValue is returned. - * - * @private - */ - function doOpenText( &$p, $end, $needClosing = true ) { - $fname = 'CBTProcessor::doOpenText'; - wfProfileIn( $fname ); - $in =& $this->mText; - $start = $p; - $ret = new CBTValue( '', array(), $this->mCompiling ); - - $foundClosing = false; - while ( $p < $end ) { - $matchLength = strcspn( $in, CBT_BRACE, $p, $end - $p ); - $pToken = $p + $matchLength; - - if ( $pToken >= $end ) { - // No more braces, output remainder - $ret->cat( substr( $in, $p ) ); - $p = $end; - break; - } - - // Output the text before the brace - $ret->cat( substr( $in, $p, $matchLength ) ); - - // Advance the pointer - $p = $pToken + 1; - - // Check for closing brace - if ( $in[$pToken] == '}' ) { - $foundClosing = true; - break; - } - - // Handle the "{fn}" special case - if ( $pToken > 0 && $in[$pToken-1] == '"' ) { - wfProfileOut( $fname ); - $val = $this->doOpenFunction( $p, $end ); - wfProfileIn( $fname ); - if ( $p < $end && $in[$p] == '"' ) { - $val->setText( htmlspecialchars( $val->getText() ) ); - } - $ret->cat( $val ); - } else { - // Process the function mode component - wfProfileOut( $fname ); - $ret->cat( $this->doOpenFunction( $p, $end ) ); - wfProfileIn( $fname ); - } - } - if ( $foundClosing && !$needClosing ) { - $this->error( 'Errant closing brace', $p ); - } elseif ( !$foundClosing && $needClosing ) { - $this->error( 'Unclosed text section', $start ); - } - wfProfileOut( $fname ); - return $ret; - } - - /** - * Recursive workhorse for function mode. - * - * Processes function mode starting from offset $p, until either $end is - * reached or a closing brace is found. If $needClosing is false, a - * closing brace will flag an error, if $needClosing is true, the lack - * of a closing brace will flag an error. - * - * The parameter $p is advanced to the position after the closing brace, - * or after the end. A CBTValue is returned. - * - * @private - */ - function doOpenFunction( &$p, $end, $needClosing = true ) { - $in =& $this->mText; - $start = $p; - $tokens = array(); - $unexecutedTokens = array(); - - $foundClosing = false; - while ( $p < $end ) { - $char = $in[$p]; - if ( $char == '{' ) { - // Switch to text mode - ++$p; - $tokenStart = $p; - $token = $this->doOpenText( $p, $end ); - $tokens[] = $token; - $unexecutedTokens[] = '{' . substr( $in, $tokenStart, $p - $tokenStart - 1 ) . '}'; - } elseif ( $char == '}' ) { - // Block end - ++$p; - $foundClosing = true; - break; - } elseif ( false !== strpos( CBT_WHITE, $char ) ) { - // Whitespace - // Consume the rest of the whitespace - $p += strspn( $in, CBT_WHITE, $p, $end - $p ); - } else { - // Token, find the end of it - $tokenLength = strcspn( $in, CBT_DELIM, $p, $end - $p ); - $token = new CBTValue( substr( $in, $p, $tokenLength ) ); - // Execute the token as a function if it's not the function name - if ( count( $tokens ) ) { - $tokens[] = $this->doFunction( array( $token ), $p ); - } else { - $tokens[] = $token; - } - $unexecutedTokens[] = $token->getText(); - - $p += $tokenLength; - } - } - if ( !$foundClosing && $needClosing ) { - $this->error( 'Unclosed function', $start ); - return ''; - } - - $val = $this->doFunction( $tokens, $start ); - if ( $this->mCompiling && !$val->isStatic() ) { - $compiled = ''; - $first = true; - foreach( $tokens as $i => $token ) { - if ( $first ) { - $first = false; - } else { - $compiled .= ' '; - } - if ( $token->isStatic() ) { - if ( $i !== 0 ) { - $compiled .= '{' . $token->getText() . '}'; - } else { - $compiled .= $token->getText(); - } - } else { - $compiled .= $unexecutedTokens[$i]; - } - } - - // The dynamic parts of the string are still represented as functions, and - // function invocations have no dependencies. Thus the compiled result has - // no dependencies. - $val = new CBTValue( "{{$compiled}}", array(), true ); - } - return $val; - } - - /** - * Execute a function, caching and returning the result value. - * $tokens is an array of CBTValue objects. $tokens[0] is the function - * name, the others are arguments. $p is the string position, and is used - * for error messages only. - */ - function doFunction( $tokens, $p ) { - if ( count( $tokens ) == 0 ) { - return new CBTValue; - } - $fname = 'CBTProcessor::doFunction'; - wfProfileIn( $fname ); - - $ret = new CBTValue; - - // All functions implicitly depend on their arguments, and the function name - // While this is not strictly necessary for all functions, it's true almost - // all the time and so convenient to do automatically. - $ret->addDeps( $tokens ); - - $this->mCurrentPos = $p; - $func = array_shift( $tokens ); - $func = $func->getText(); - - // Extract the text component from all the tokens - // And convert any templates to plain text - $textArgs = array(); - foreach ( $tokens as $token ) { - $token->execute( $this ); - $textArgs[] = $token->getText(); - } - - // Try the local cache - $cacheKey = $func . "\n" . implode( "\n", $textArgs ); - if ( isset( $this->mFunctionCache[$cacheKey] ) ) { - $val = $this->mFunctionCache[$cacheKey]; - } elseif ( isset( $this->mBuiltins[$func] ) ) { - $func = $this->mBuiltins[$func]; - $val = call_user_func_array( array( &$this, $func ), $tokens ); - $this->mFunctionCache[$cacheKey] = $val; - } elseif ( method_exists( $this->mFunctionObj, $func ) ) { - $profName = get_class( $this->mFunctionObj ) . '::' . $func; - wfProfileIn( "$fname-callback" ); - wfProfileIn( $profName ); - $val = call_user_func_array( array( &$this->mFunctionObj, $func ), $textArgs ); - wfProfileOut( $profName ); - wfProfileOut( "$fname-callback" ); - $this->mFunctionCache[$cacheKey] = $val; - } else { - $this->error( "Call of undefined function \"$func\"", $p ); - $val = new CBTValue; - } - if ( !is_object( $val ) ) { - $val = new CBTValue((string)$val); - } - - if ( CBT_DEBUG ) { - $unexpanded = $val; - } - - // If the output was a template, execute it - $val->execute( $this ); - - if ( $this->mCompiling ) { - // Escape any braces so that the output will be a valid template - $val->templateEscape(); - } - $val->removeDeps( $this->mIgnorableDeps ); - $ret->addDeps( $val ); - $ret->setText( $val->getText() ); - - if ( CBT_DEBUG ) { - wfDebug( "doFunction $func args = " - . var_export( $tokens, true ) - . "unexpanded return = " - . var_export( $unexpanded, true ) - . "expanded return = " - . var_export( $ret, true ) - ); - } - - wfProfileOut( $fname ); - return $ret; - } - - /** - * Set a flag indicating that an error has been found. - */ - function error( $text, $pos = false ) { - $this->mLastError = $text; - if ( $pos === false ) { - $this->mErrorPos = $this->mCurrentPos; - } else { - $this->mErrorPos = $pos; - } - } - - function getLastError() { - return $this->mLastError; - } - - /** 'if' built-in function */ - function bi_if( $condition, $trueBlock, $falseBlock = null ) { - if ( is_null( $condition ) ) { - $this->error( "Missing condition in if" ); - return ''; - } - - if ( $condition->getText() != '' ) { - return new CBTValue( $trueBlock->getText(), - array_merge( $condition->getDeps(), $trueBlock->getDeps() ), - $trueBlock->mIsTemplate ); - } else { - if ( !is_null( $falseBlock ) ) { - return new CBTValue( $falseBlock->getText(), - array_merge( $condition->getDeps(), $falseBlock->getDeps() ), - $falseBlock->mIsTemplate ); - } else { - return new CBTValue( '', $condition->getDeps() ); - } - } - } - - /** 'true' built-in function */ - function bi_true() { - return "true"; - } - - /** left brace built-in */ - function bi_lbrace() { - return '{'; - } - - /** right brace built-in */ - function bi_rbrace() { - return '}'; - } - - /** - * escape built-in. - * Escape text for inclusion in an HTML attribute - */ - function bi_escape( $val ) { - return new CBTValue( htmlspecialchars( $val->getText() ), $val->getDeps() ); - } -} diff --git a/includes/cbt/README b/includes/cbt/README deleted file mode 100644 index 3058166136..0000000000 --- a/includes/cbt/README +++ /dev/null @@ -1,108 +0,0 @@ -Overview --------- - -CBT (callback-based templates) is an experimental system for improving skin -rendering time in MediaWiki and similar applications. The fundamental concept is -a template language which contains tags which pull text from PHP callbacks. -These PHP callbacks do not simply return text, they also return a description of -the dependencies -- the global data upon which the returned text depends. This -allows a compiler to produce a template optimised for a certain context. For -example, a user-dependent template can be produced, with the username replaced -by static text, as well as all user preference dependent text. - -This was an experimental project to prove the concept -- to explore possible -efficiency gains and techniques. TemplateProcessor was the first element of this -experiment. It is a class written in PHP which parses a template, and produces -either an optimised template with dependencies removed, or the output text -itself. I found that even with a heavily optimised template, this processor was -not fast enough to match the speed of the original MonoBook. - -To improve the efficiency, I wrote TemplateCompiler, which takes a template, -preferably pre-optimised by TemplateProcessor, and generates PHP code from it. -The generated code is a single expression, concatenating static text and -callback results. This approach turned out to be very efficient, making -significant time savings compared to the original MonoBook. - -Despite this success, the code has been shelved for the time being. There were -a number of unresolved implementation problems, and I felt that there were more -pressing priorities for MediaWiki development than solving them and bringing -this module to completion. I also believe that more research is needed into -other possible template architectures. There is nothing fundamentally wrong with -the CBT concept, and I would encourage others to continue its development. - -The problems I saw were: - -* Extensibility. Can non-Wikimedia installations easily extend and modify CBT - skins? Patching seems to be necessary, is this acceptable? MediaWiki - extensions are another problem. Unless the interfaces allow them to return - dependencies, any hooks will have to be marked dynamic and thus inefficient. - -* Cache invalidation. This is a simple implementation issue, although it would - require extensive modification to the MediaWiki core. - -* Syntax. The syntax is minimalistic and easy to parse, but can be quite ugly. - Will generations of MediaWiki users curse my name? - -* Security. The code produced by TemplateCompiler is best stored in memcached - and executed with eval(). This allows anyone with access to the memcached port - to run code as the apache user. - - -Template syntax ---------------- - -There are two modes: text mode and function mode. The brace characters "{" -and "}" are the only reserved characters. Either one of them will switch from -text mode to function mode wherever they appear, no exceptions. - -In text mode, all characters are passed through to the output. In function -mode, text is split into tokens, delimited either by whitespace or by -matching pairs of braces. The first token is taken to be a function name. The -other tokens are first processed in function mode themselves, then they are -passed to the named function as parameters. The return value of the function -is passed through to the output. - -Example: - {escape {"hello"}} - -First brace switches to function mode. The function name is escape, the first -and only parameter is {"hello"}. This parameter is executed. The braces around -the parameter cause the parser to switch to text mode, thus the string "hello", -including the quotes, is passed back and used as an argument to the escape -function. - -Example: - {if title {

{title}

}} - -The function name is "if". The first parameter is the result of calling the -function "title". The second parameter is a level 1 HTML heading containing -the result of the function "title". "if" is a built-in function which will -return the second parameter only if the first is non-blank, so the effect of -this is to return a heading element only if a title exists. - -As a shortcut for generation of HTML attributes, if a function mode segment is -surrounded by double quotes, quote characters in the return value will be -escaped. This only applies if the quote character immediately precedes the -opening brace, and immediately follows the closing brace, with no whitespace. - -User callback functions are defined by passing a function object to the -template processor. Function names appearing in the text are first checked -against built-in function names, then against the method names in the function -object. The function object forms a sandbox for execution of the template, so -security-conscious users may wish to avoid including functions that allow -arbitrary filesystem access or code execution. - -The callback function will receive its parameters as strings. If the -result of the function depends only on the arguments, and certain things -understood to be "static", such as the source code, then the callback function -should return a string. If the result depends on other things, then the function -should call cbt_value() to get a return value: - - return cbt_value( $text, $deps ); - -where $deps is an array of string tokens, each one naming a dependency. As a -shortcut, if there is only one dependency, $deps may be a string. - - ---------------------- -Tim Starling 2006 diff --git a/skins/disabled/MonoBook.tpl b/skins/disabled/MonoBook.tpl deleted file mode 100644 index 58bc4f5ceb..0000000000 --- a/skins/disabled/MonoBook.tpl +++ /dev/null @@ -1,200 +0,0 @@ - - - - - {headlinks} - {headscripts} - {pagetitle} - - - - - - - - - - {if jsvarurl {}} - {if pagecss {}} - {usercss} - {sitecss} - {gencss} - {if userjs {}} - {if userjsprev {}} - {trackbackhtml} - - -
-
-
- - {if sitenotice {
{sitenotice}
}} -

{title}

-
-

{msg {tagline}}

-
{subtitle}
- {if undelete {
{undelete}
}} - {if newtalk {
{newtalk}
}} - {if showjumplinks { - - }} - - {bodytext} - {if catlinks { }} - -
-
-
-
-
-
-
{msg {views}}
- -
-
-
{msg {personaltools}}
-
-
    - {personal_urls {
  • $text
  • }} -
-
-
- - - {sidebar { -
-
$barname
-
-
    - } { -
-
-
- } {
  • $text
  • - } - } - - -
    -
    {msg {toolbox}}
    -
    - -
    -
    - {language_urls { -
    -
    {msg {otherlanguages}}
    -
    -
      - $body -
    -
    -
    - } { -
  • $text
  • - }} -
    -
    - - -
    -{reporttime} -{if {} { vim: set syn=html ts=2 : }} - diff --git a/skins/disabled/MonoBookCBT.php b/skins/disabled/MonoBookCBT.php deleted file mode 100644 index 9f8098c917..0000000000 --- a/skins/disabled/MonoBookCBT.php +++ /dev/null @@ -1,1400 +0,0 @@ -execute( $out ); - } - - function execute( &$out ) { - global $wgTitle, $wgStyleDirectory, $wgParserCacheType; - $fname = 'SkinMonoBookCBT::execute'; - wfProfileIn( $fname ); - wfProfileIn( "$fname-setup" ); - Skin::initPage( $out ); - - $this->mOut =& $out; - $this->mTitle =& $wgTitle; - - $sourceFile = "$wgStyleDirectory/MonoBook.tpl"; - - wfProfileOut( "$fname-setup" ); - - if ( $wgParserCacheType == CACHE_NONE ) { - $template = file_get_contents( $sourceFile ); - $text = $this->executeTemplate( $template ); - } else { - $compiled = $this->getCompiledTemplate( $sourceFile ); - - wfProfileIn( "$fname-eval" ); - $text = eval( $compiled ); - wfProfileOut( "$fname-eval" ); - } - wfProfileOut( $fname ); - return $text; - } - - function getCompiledTemplate( $sourceFile ) { - global $wgDBname, $wgMemc, $wgRequest, $wgUser, $parserMemc; - $fname = 'SkinMonoBookCBT::getCompiledTemplate'; - - $expiry = 3600; - - // Sandbox template execution - if ( $this->mCompiling ) { - return; - } - - wfProfileIn( $fname ); - - // Is the request an ordinary page view? - if ( $wgRequest->wasPosted() || - count( array_diff( array_keys( $_GET ), array( 'title', 'useskin', 'recompile' ) ) ) != 0 ) - { - $type = 'nonview'; - } else { - $type = 'view'; - } - - // Per-user compiled template - // Put all logged-out users on the same cache key - $cacheKey = "$wgDBname:monobookcbt:$type:" . $wgUser->getId(); - - $recompile = $wgRequest->getVal( 'recompile' ); - if ( $recompile == 'user' ) { - $recompileUser = true; - $recompileGeneric = false; - } elseif ( $recompile ) { - $recompileUser = true; - $recompileGeneric = true; - } else { - $recompileUser = false; - $recompileGeneric = false; - } - - if ( !$recompileUser ) { - $php = $parserMemc->get( $cacheKey ); - } - if ( $recompileUser || !$php ) { - if ( $wgUser->isLoggedIn() ) { - // Perform staged compilation - // First compile a generic template for all logged-in users - $genericKey = "$wgDBname:monobookcbt:$type:loggedin"; - if ( !$recompileGeneric ) { - $template = $parserMemc->get( $genericKey ); - } - if ( $recompileGeneric || !$template ) { - $template = file_get_contents( $sourceFile ); - $ignore = array( 'loggedin', '!loggedin dynamic' ); - if ( $type == 'view' ) { - $ignore[] = 'nonview dynamic'; - } - $template = $this->compileTemplate( $template, $ignore ); - $parserMemc->set( $genericKey, $template, $expiry ); - } - } else { - $template = file_get_contents( $sourceFile ); - } - - $ignore = array( 'lang', 'loggedin', 'user' ); - if ( $wgUser->isLoggedIn() ) { - $ignore[] = '!loggedin dynamic'; - } else { - $ignore[] = 'loggedin dynamic'; - } - if ( $type == 'view' ) { - $ignore[] = 'nonview dynamic'; - } - $compiled = $this->compileTemplate( $template, $ignore ); - - // Reduce whitespace - // This is done here instead of in CBTProcessor because we can be - // more sure it is safe here. - $compiled = preg_replace( '/^[ \t]+/m', '', $compiled ); - $compiled = preg_replace( '/[\r\n]+/', "\n", $compiled ); - - // Compile to PHP - $compiler = new CBTCompiler( $compiled ); - $ret = $compiler->compile(); - if ( $ret !== true ) { - echo $ret; - wfErrorExit(); - } - $php = $compiler->generatePHP( '$this' ); - - $parserMemc->set( $cacheKey, $php, $expiry ); - } - wfProfileOut( $fname ); - return $php; - } - - function compileTemplate( $template, $ignore ) { - $tp = new CBTProcessor( $template, $this, $ignore ); - $tp->mFunctionCache = $this->mFunctionCache; - - $this->mCompiling = true; - $compiled = $tp->compile(); - $this->mCompiling = false; - - if ( $tp->getLastError() ) { - // If there was a compile error, don't save the template - // Instead just print the error and exit - echo $compiled; - wfErrorExit(); - } - $this->mFunctionCache = $tp->mFunctionCache; - return $compiled; - } - - function executeTemplate( $template ) { - $fname = 'SkinMonoBookCBT::executeTemplate'; - wfProfileIn( $fname ); - $tp = new CBTProcessor( $template, $this ); - $tp->mFunctionCache = $this->mFunctionCache; - - $this->mCompiling = true; - $text = $tp->execute(); - $this->mCompiling = false; - - $this->mFunctionCache = $tp->mFunctionCache; - wfProfileOut( $fname ); - return $text; - } - - /****************************************************** - * Callbacks * - ******************************************************/ - - function lang() { return $GLOBALS['wgContLanguageCode']; } - - function dir() { - global $wgContLang; - return $wgContLang->isRTL() ? 'rtl' : 'ltr'; - } - - function mimetype() { return $GLOBALS['wgMimeType']; } - function charset() { return $GLOBALS['wgOutputEncoding']; } - function headlinks() { - return cbt_value( $this->mOut->getHeadLinks(), 'dynamic' ); - } - function headscripts() { - return cbt_value( $this->mOut->getScript(), 'dynamic' ); - } - - function pagetitle() { - return cbt_value( $this->mOut->getHTMLTitle(), array( 'title', 'lang' ) ); - } - - function stylepath() { return $GLOBALS['wgStylePath']; } - function stylename() { return $this->mStyleName; } - - function notprintable() { - global $wgRequest; - return cbt_value( !$wgRequest->getBool( 'printable' ), 'nonview dynamic' ); - } - - function jsmimetype() { return $GLOBALS['wgJsMimeType']; } - - function jsvarurl() { - global $wgUseSiteJs, $wgUser; - if ( !$wgUseSiteJs ) return ''; - - if ( $wgUser->isLoggedIn() ) { - $url = self::makeUrl( '-','action=raw&smaxage=0&gen=js' ); - } else { - $url = self::makeUrl( '-','action=raw&gen=js' ); - } - return cbt_value( $url, 'loggedin' ); - } - - function pagecss() { - global $wgHooks; - - $out = false; - wfRunHooks( 'SkinTemplateSetupPageCss', array( &$out ) ); - - // Unknown dependencies - return cbt_value( $out, 'dynamic' ); - } - - function usercss() { - if ( $this->isCssPreview() ) { - global $wgRequest; - $usercss = $this->makeStylesheetCdata( $wgRequest->getText('wpTextbox1') ); - } else { - $usercss = $this->makeStylesheetLink( self::makeUrl($this->getUserPageText() . - '/'.$this->mStyleName.'.css', 'action=raw&ctype=text/css' ) ); - } - - // Dynamic when not an ordinary page view, also depends on the username - return cbt_value( $usercss, array( 'nonview dynamic', 'user' ) ); - } - - function sitecss() { - global $wgUseSiteCss; - if ( !$wgUseSiteCss ) { - return ''; - } - - global $wgSquidMaxage, $wgContLang, $wgStylePath; - - $query = "action=raw&ctype=text/css&smaxage=$wgSquidMaxage"; - - $sitecss = ''; - if ( $wgContLang->isRTL() ) { - $sitecss .= $this->makeStylesheetLink( $wgStylePath . '/' . $this->mStyleName . '/rtl.css' ) . "\n"; - } - - $sitecss .= $this->makeStylesheetLink( self::makeNSUrl( 'Common.css', $query, NS_MEDIAWIKI ) ) . "\n"; - $sitecss .= $this->makeStylesheetLink( self::makeNSUrl( ucfirst( $this->mStyleName ) . '.css', $query, NS_MEDIAWIKI ) ) . "\n"; - - // No deps - return $sitecss; - } - - function gencss() { - global $wgUseSiteCss; - if ( !$wgUseSiteCss ) return ''; - - global $wgSquidMaxage, $wgUser, $wgAllowUserCss; - if ( $this->isCssPreview() ) { - $siteargs = '&smaxage=0&maxage=0'; - } else { - $siteargs = '&maxage=' . $wgSquidMaxage; - } - if ( $wgAllowUserCss && $wgUser->isLoggedIn() ) { - $siteargs .= '&ts={user_touched}'; - $isTemplate = true; - } else { - $isTemplate = false; - } - - $link = $this->makeStylesheetLink( self::makeUrl('-','action=raw&gen=css' . $siteargs) ) . "\n"; - - if ( $wgAllowUserCss ) { - $deps = 'loggedin'; - } else { - $deps = array(); - } - return cbt_value( $link, $deps, $isTemplate ); - } - - function user_touched() { - global $wgUser; - return cbt_value( $wgUser->mTouched, 'dynamic' ); - } - - function userjs() { - global $wgAllowUserJs, $wgJsMimeType; - if ( !$wgAllowUserJs ) return ''; - - if ( $this->isJsPreview() ) { - $url = ''; - } else { - $url = self::makeUrl($this->getUserPageText().'/'.$this->mStyleName.'.js', 'action=raw&ctype='.$wgJsMimeType.'&dontcountme=s'); - } - return cbt_value( $url, array( 'nonview dynamic', 'user' ) ); - } - - function userjsprev() { - global $wgAllowUserJs, $wgRequest; - if ( !$wgAllowUserJs ) return ''; - if ( $this->isJsPreview() ) { - $js = '/*getText('wpTextbox1') . ' /*]]>*/'; - } else { - $js = ''; - } - return cbt_value( $js, array( 'nonview dynamic' ) ); - } - - function trackbackhtml() { - global $wgUseTrackbacks; - if ( !$wgUseTrackbacks ) return ''; - - if ( $this->mOut->isArticleRelated() ) { - $tb = $this->mTitle->trackbackRDF(); - } else { - $tb = ''; - } - return cbt_value( $tb, 'dynamic' ); - } - - function body_ondblclick() { - global $wgUser; - if( $this->isEditable() && $wgUser->getOption("editondblclick") ) { - $js = 'document.location = "' . $this->getEditUrl() .'";'; - } else { - $js = ''; - } - - if ( User::getDefaultOption('editondblclick') ) { - return cbt_value( $js, 'user', 'title' ); - } else { - // Optimise away for logged-out users - return cbt_value( $js, 'loggedin dynamic' ); - } - } - - function body_onload() { - global $wgUser; - if ( $this->isEditable() && $wgUser->getOption( 'editsectiononrightclick' ) ) { - $js = 'setupRightClickEdit()'; - } else { - $js = ''; - } - return cbt_value( $js, 'loggedin dynamic' ); - } - - function nsclass() { - return cbt_value( 'ns-' . $this->mTitle->getNamespace(), 'title' ); - } - - function sitenotice() { - // Perhaps this could be given special dependencies using our knowledge of what - // wfGetSiteNotice() depends on. - return cbt_value( wfGetSiteNotice(), 'dynamic' ); - } - - function title() { - return cbt_value( $this->mOut->getPageTitle(), array( 'title', 'lang' ) ); - } - - function title_urlform() { - return cbt_value( $this->getThisTitleUrlForm(), 'title' ); - } - - function title_userurl() { - return cbt_value( urlencode( $this->mTitle->getDBkey() ), 'title' ); - } - - function subtitle() { - $subpagestr = $this->subPageSubtitle(); - if ( !empty( $subpagestr ) ) { - $s = ''.$subpagestr.''.$this->mOut->getSubtitle(); - } else { - $s = $this->mOut->getSubtitle(); - } - return cbt_value( $s, array( 'title', 'nonview dynamic' ) ); - } - - function undelete() { - return cbt_value( $this->getUndeleteLink(), array( 'title', 'lang' ) ); - } - - function newtalk() { - global $wgUser, $wgDBname; - $newtalks = $wgUser->getNewMessageLinks(); - - if (count($newtalks) == 1 && $newtalks[0]["wiki"] === $wgDBname) { - $usertitle = $this->getUserPageTitle(); - $usertalktitle = $usertitle->getTalkPage(); - - if( !$usertalktitle->equals( $this->mTitle ) ) { - $newmessageslink = $this->link( - $usertalktitle, - wfMsgHtml( 'newmessageslink' ), - array(), - array( 'redirect' => 'no' ), - array( 'known', 'noclasses' ) - ); - - $newmessagesdifflink = $this->link( - $usertalktitle, - wfMsgHtml( 'newmessagesdifflink' ), - array(), - array( 'diff' => 'cur' ), - array( 'known', 'noclasses' ) - ); - - $ntl = wfMsg( - 'youhavenewmessages', - $newmessageslink, - $newmessagesdifflink - ); - - # Disable Cache - $this->mOut->setSquidMaxage(0); - } - } else if (count($newtalks)) { - $sep = str_replace("_", " ", wfMsgHtml("newtalkseparator")); - $msgs = array(); - foreach ($newtalks as $newtalk) { - $msgs[] = wfElement("a", - array('href' => $newtalk["link"]), $newtalk["wiki"]); - } - $parts = implode($sep, $msgs); - $ntl = wfMsgHtml('youhavenewmessagesmulti', $parts); - $this->mOut->setSquidMaxage(0); - } else { - $ntl = ''; - } - return cbt_value( $ntl, 'dynamic' ); - } - - function showjumplinks() { - global $wgUser; - return cbt_value( $wgUser->getOption( 'showjumplinks' ) ? 'true' : '', 'user' ); - } - - function bodytext() { - return cbt_value( $this->mOut->getHTML(), 'dynamic' ); - } - - function catlinks() { - if ( !isset( $this->mCatlinks ) ) { - $this->mCatlinks = $this->getCategories(); - } - return cbt_value( $this->mCatlinks, 'dynamic' ); - } - - function extratabs( $itemTemplate ) { - global $wgContLang, $wgDisableLangConversion; - - $etpl = cbt_escape( $itemTemplate ); - - /* show links to different language variants */ - $variants = $wgContLang->getVariants(); - $s = ''; - if ( !$wgDisableLangConversion && count( $wgContLang->getVariants() ) > 1 ) { - $vcount=0; - foreach ( $variants as $code ) { - $name = $wgContLang->getVariantname( $code ); - if ( $name == 'disable' ) { - continue; - } - $code = cbt_escape( $code ); - $name = cbt_escape( $name ); - $s .= "{ca_variant {{$code}} {{$name}} {{$vcount}} {{$etpl}}}\n"; - $vcount ++; - } - } - return cbt_value( $s, array(), true ); - } - - function is_special() { return cbt_value( $this->mTitle->getNamespace() == NS_SPECIAL, 'title' ); } - function can_edit() { return cbt_value( (string)($this->mTitle->userCan( 'edit' )), 'dynamic' ); } - function can_move() { return cbt_value( (string)($this->mTitle->userCan( 'move' )), 'dynamic' ); } - function is_talk() { return cbt_value( (string)($this->mTitle->isTalkPage()), 'title' ); } - function is_protected() { return cbt_value( (string)$this->mTitle->isProtected(), 'dynamic' ); } - function nskey() { return cbt_value( $this->mTitle->getNamespaceKey(), 'title' ); } - - function request_url() { - global $wgRequest; - return cbt_value( $wgRequest->getRequestURL(), 'dynamic' ); - } - - function subject_url() { - $title = $this->getSubjectPage(); - if ( $title->exists() ) { - $url = $title->getLocalUrl(); - } else { - $url = $title->getLocalUrl( 'action=edit' ); - } - return cbt_value( $url, 'title' ); - } - - function talk_url() { - $title = $this->getTalkPage(); - if ( $title->exists() ) { - $url = $title->getLocalUrl(); - } else { - $url = $title->getLocalUrl( 'action=edit' ); - } - return cbt_value( $url, 'title' ); - } - - function edit_url() { - return cbt_value( $this->getEditUrl(), array( 'title', 'nonview dynamic' ) ); - } - - function move_url() { - return cbt_value( $this->makeSpecialParamUrl( 'Movepage' ), array(), true ); - } - - function localurl( $query ) { - return cbt_value( $this->mTitle->getLocalURL( $query ), 'title' ); - } - - function selecttab( $tab, $extraclass = '' ) { - if ( !isset( $this->mSelectedTab ) ) { - $prevent_active_tabs = false ; - wfRunHooks( 'SkinTemplatePreventOtherActiveTabs', array( &$this , &$preventActiveTabs ) ); - - $actionTabs = array( - 'edit' => 'edit', - 'submit' => 'edit', - 'history' => 'history', - 'protect' => 'protect', - 'unprotect' => 'protect', - 'delete' => 'delete', - 'watch' => 'watch', - 'unwatch' => 'watch', - ); - if ( $preventActiveTabs ) { - $this->mSelectedTab = false; - } else { - $action = $this->getAction(); - $section = $this->getSection(); - - if ( isset( $actionTabs[$action] ) ) { - $this->mSelectedTab = $actionTabs[$action]; - - if ( $this->mSelectedTab == 'edit' && $section == 'new' ) { - $this->mSelectedTab = 'addsection'; - } - } elseif ( $this->mTitle->isTalkPage() ) { - $this->mSelectedTab = 'talk'; - } else { - $this->mSelectedTab = 'subject'; - } - } - } - if ( $extraclass ) { - if ( $this->mSelectedTab == $tab ) { - $s = 'class="selected ' . htmlspecialchars( $extraclass ) . '"'; - } else { - $s = 'class="' . htmlspecialchars( $extraclass ) . '"'; - } - } else { - if ( $this->mSelectedTab == $tab ) { - $s = 'class="selected"'; - } else { - $s = ''; - } - } - return cbt_value( $s, array( 'nonview dynamic', 'title' ) ); - } - - function subject_newclass() { - $title = $this->getSubjectPage(); - $class = $title->exists() ? '' : 'new'; - return cbt_value( $class, 'dynamic' ); - } - - function talk_newclass() { - $title = $this->getTalkPage(); - $class = $title->exists() ? '' : 'new'; - return cbt_value( $class, 'dynamic' ); - } - - function ca_variant( $code, $name, $index, $template ) { - global $wgContLang; - $selected = ($code == $wgContLang->getPreferredVariant()); - $action = $this->getAction(); - $actstr = ''; - if( $action ) - $actstr = 'action=' . $action . '&'; - $s = strtr( $template, array( - '$id' => htmlspecialchars( 'varlang-' . $index ), - '$class' => $selected ? 'class="selected"' : '', - '$text' => $name, - '$href' => htmlspecialchars( $this->mTitle->getLocalUrl( $actstr . 'variant=' . $code ) ) - )); - return cbt_value( $s, 'dynamic' ); - } - - function is_watching() { - return cbt_value( (string)$this->mTitle->userIsWatching(), array( 'dynamic' ) ); - } - - - function personal_urls( $itemTemplate ) { - global $wgShowIPinHeader, $wgContLang; - - # Split this function up into many small functions, to obtain the - # best specificity in the dependencies of each one. The template below - # has no dependencies, so its generation, and any static subfunctions, - # can be optimised away. - $etpl = cbt_escape( $itemTemplate ); - $s = " - {userpage {{$etpl}}} - {mytalk {{$etpl}}} - {preferences {{$etpl}}} - {watchlist {{$etpl}}} - {mycontris {{$etpl}}} - {logout {{$etpl}}} - "; - - if ( $wgShowIPinHeader ) { - $s .= " - {anonuserpage {{$etpl}}} - {anontalk {{$etpl}}} - {anonlogin {{$etpl}}} - "; - } else { - $s .= "{login {{$etpl}}}\n"; - } - // No dependencies - return cbt_value( $s, array(), true /*this is a template*/ ); - } - - function userpage( $itemTemplate ) { - global $wgUser; - if ( $this->isLoggedIn() ) { - $userPage = $this->getUserPageTitle(); - $s = $this->makeTemplateLink( $itemTemplate, 'userpage', $userPage, $wgUser->getName() ); - } else { - $s = ''; - } - return cbt_value( $s, 'user' ); - } - - function mytalk( $itemTemplate ) { - global $wgUser; - if ( $this->isLoggedIn() ) { - $userPage = $this->getUserPageTitle(); - $talkPage = $userPage->getTalkPage(); - $s = $this->makeTemplateLink( $itemTemplate, 'mytalk', $talkPage, wfMsg('mytalk') ); - } else { - $s = ''; - } - return cbt_value( $s, 'user' ); - } - - function preferences( $itemTemplate ) { - if ( $this->isLoggedIn() ) { - $s = $this->makeSpecialTemplateLink( $itemTemplate, 'preferences', - 'Preferences', wfMsg( 'preferences' ) ); - } else { - $s = ''; - } - return cbt_value( $s, array( 'loggedin', 'lang' ) ); - } - - function watchlist( $itemTemplate ) { - if ( $this->isLoggedIn() ) { - $s = $this->makeSpecialTemplateLink( $itemTemplate, 'watchlist', - 'Watchlist', wfMsg( 'watchlist' ) ); - } else { - $s = ''; - } - return cbt_value( $s, array( 'loggedin', 'lang' ) ); - } - - function mycontris( $itemTemplate ) { - if ( $this->isLoggedIn() ) { - global $wgUser; - $s = $this->makeSpecialTemplateLink( $itemTemplate, 'mycontris', - "Contributions/" . $wgUser->getTitleKey(), wfMsg('mycontris') ); - } else { - $s = ''; - } - return cbt_value( $s, 'user' ); - } - - function logout( $itemTemplate ) { - if ( $this->isLoggedIn() ) { - $s = $this->makeSpecialTemplateLink( $itemTemplate, 'logout', - 'Userlogout', wfMsg( 'userlogout' ), - $this->mTitle->getNamespace() === NS_SPECIAL && $this->mTitle->getText() === 'Preferences' - ? '' : "returnto=" . $this->mTitle->getPrefixedURL() ); - } else { - $s = ''; - } - return cbt_value( $s, 'loggedin dynamic' ); - } - - function anonuserpage( $itemTemplate ) { - if ( $this->isLoggedIn() ) { - $s = ''; - } else { - global $wgUser; - $userPage = $this->getUserPageTitle(); - $s = $this->makeTemplateLink( $itemTemplate, 'userpage', $userPage, $wgUser->getName() ); - } - return cbt_value( $s, '!loggedin dynamic' ); - } - - function anontalk( $itemTemplate ) { - if ( $this->isLoggedIn() ) { - $s = ''; - } else { - $userPage = $this->getUserPageTitle(); - $talkPage = $userPage->getTalkPage(); - $s = $this->makeTemplateLink( $itemTemplate, 'mytalk', $talkPage, wfMsg('anontalk') ); - } - return cbt_value( $s, '!loggedin dynamic' ); - } - - function anonlogin( $itemTemplate ) { - if ( $this->isLoggedIn() ) { - $s = ''; - } else { - $s = $this->makeSpecialTemplateLink( $itemTemplate, 'anonlogin', 'Userlogin', - wfMsg( 'userlogin' ), 'returnto=' . urlencode( $this->getThisPDBK() ) ); - } - return cbt_value( $s, '!loggedin dynamic' ); - } - - function login( $itemTemplate ) { - if ( $this->isLoggedIn() ) { - $s = ''; - } else { - $s = $this->makeSpecialTemplateLink( $itemTemplate, 'login', 'Userlogin', - wfMsg( 'userlogin' ), 'returnto=' . urlencode( $this->getThisPDBK() ) ); - } - return cbt_value( $s, '!loggedin dynamic' ); - } - - function logopath() { return $GLOBALS['wgLogo']; } - function mainpage() { return self::makeMainPageUrl(); } - - function sidebar( $startSection, $endSection, $innerTpl ) { - $s = ''; - $lines = explode( "\n", wfMsgForContent( 'sidebar' ) ); - $firstSection = true; - foreach ($lines as $line) { - if (strpos($line, '*') !== 0) - continue; - if (strpos($line, '**') !== 0) { - $bar = trim($line, '* '); - $name = wfMsg( $bar ); - if (wfEmptyMsg($bar, $name)) { - $name = $bar; - } - if ( $firstSection ) { - $firstSection = false; - } else { - $s .= $endSection; - } - $s .= strtr( $startSection, - array( - '$bar' => htmlspecialchars( $bar ), - '$barname' => $name - ) ); - } else { - if (strpos($line, '|') !== false) { // sanity check - $line = explode( '|' , trim($line, '* '), 2 ); - $link = wfMsgForContent( $line[0] ); - if ($link == '-') - continue; - if (wfEmptyMsg($line[1], $text = wfMsg($line[1]))) - $text = $line[1]; - if (wfEmptyMsg($line[0], $link)) - $link = $line[0]; - $href = self::makeInternalOrExternalUrl( $link ); - - $s .= strtr( $innerTpl, - array( - '$text' => htmlspecialchars( $text ), - '$href' => htmlspecialchars( $href ), - '$id' => htmlspecialchars( 'n-' . strtr($line[1], ' ', '-') ), - '$classactive' => '' - ) ); - } else { continue; } - } - } - if ( !$firstSection ) { - $s .= $endSection; - } - - // Depends on user language only - return cbt_value( $s, 'lang' ); - } - - function searchaction() { - // Static link - return $this->getSearchLink(); - } - - function search() { - global $wgRequest; - return cbt_value( trim( $this->getSearch() ), 'special dynamic' ); - } - - function notspecialpage() { - return cbt_value( $this->mTitle->getNamespace() != NS_SPECIAL, 'special' ); - } - - function nav_whatlinkshere() { - return cbt_value( $this->makeSpecialParamUrl('Whatlinkshere' ), array(), true ); - } - - function article_exists() { - return cbt_value( (string)($this->mTitle->getArticleId() !== 0), 'title' ); - } - - function nav_recentchangeslinked() { - return cbt_value( $this->makeSpecialParamUrl('Recentchangeslinked' ), array(), true ); - } - - function feeds( $itemTemplate = '' ) { - if ( !$this->mOut->isSyndicated() ) { - $feeds = ''; - } elseif ( $itemTemplate == '' ) { - // boolean only required - $feeds = 'true'; - } else { - $feeds = ''; - global $wgFeedClasses, $wgRequest; - foreach( $wgFeedClasses as $format => $class ) { - $feeds .= strtr( $itemTemplate, - array( - '$key' => htmlspecialchars( $format ), - '$text' => $format, - '$href' => $wgRequest->appendQuery( "feed=$format" ) - ) ); - } - } - return cbt_value( $feeds, 'special dynamic' ); - } - - function is_userpage() { - list( $id, $ip ) = $this->getUserPageIdIp(); - return cbt_value( (string)($id || $ip), 'title' ); - } - - function is_ns_mediawiki() { - return cbt_value( (string)$this->mTitle->getNamespace() == NS_MEDIAWIKI, 'title' ); - } - - function is_loggedin() { - global $wgUser; - return cbt_value( (string)($wgUser->isLoggedIn()), 'loggedin' ); - } - - function nav_contributions() { - $url = $this->makeSpecialParamUrl( 'Contributions', '', '{title_userurl}' ); - return cbt_value( $url, array(), true ); - } - - function is_allowed( $right ) { - global $wgUser; - return cbt_value( (string)$wgUser->isAllowed( $right ), 'user' ); - } - - function nav_blockip() { - $url = $this->makeSpecialParamUrl( 'Blockip', '', '{title_userurl}' ); - return cbt_value( $url, array(), true ); - } - - function nav_emailuser() { - global $wgEnableEmail, $wgEnableUserEmail, $wgUser; - if ( !$wgEnableEmail || !$wgEnableUserEmail ) return ''; - - $url = $this->makeSpecialParamUrl( 'Emailuser', '', '{title_userurl}' ); - return cbt_value( $url, array(), true ); - } - - function nav_upload() { - global $wgEnableUploads, $wgUploadNavigationUrl; - if ( !$wgEnableUploads ) { - return ''; - } elseif ( $wgUploadNavigationUrl ) { - return $wgUploadNavigationUrl; - } else { - return self::makeSpecialUrl('Upload'); - } - } - - function nav_specialpages() { - return self::makeSpecialUrl('Specialpages'); - } - - function nav_print() { - global $wgRequest, $wgArticle; - $action = $this->getAction(); - $url = ''; - if( $this->mTitle->getNamespace() !== NS_SPECIAL - && ($action == '' || $action == 'view' || $action == 'purge' ) ) - { - $revid = $wgArticle->getLatest(); - if ( $revid != 0 ) { - $url = $wgRequest->appendQuery( 'printable=yes' ); - } - } - return cbt_value( $url, array( 'nonview dynamic', 'title' ) ); - } - - function nav_permalink() { - $url = (string)$this->getPermalink(); - return cbt_value( $url, 'dynamic' ); - } - - function nav_trackbacklink() { - global $wgUseTrackbacks; - if ( !$wgUseTrackbacks ) return ''; - - return cbt_value( $this->mTitle->trackbackURL(), 'title' ); - } - - function is_permalink() { - return cbt_value( (string)($this->getPermalink() === false), 'nonview dynamic' ); - } - - function toolboxend() { - // This is where the MonoBookTemplateToolboxEnd hook went in the old skin - return ''; - } - - function language_urls( $outer, $inner ) { - global $wgHideInterlanguageLinks, $wgOut, $wgContLang; - if ( $wgHideInterlanguageLinks ) return ''; - - $links = $wgOut->getLanguageLinks(); - $s = ''; - if ( count( $links ) ) { - foreach( $links as $l ) { - $tmp = explode( ':', $l, 2 ); - $nt = Title::newFromText( $l ); - $s .= strtr( $inner, - array( - '$class' => htmlspecialchars( 'interwiki-' . $tmp[0] ), - '$href' => htmlspecialchars( $nt->getFullURL() ), - '$text' => ($wgContLang->getLanguageName( $nt->getInterwiki() ) != ''? - $wgContLang->getLanguageName( $nt->getInterwiki() ) : $l ), - ) - ); - } - $s = str_replace( '$body', $s, $outer ); - } - return cbt_value( $s, 'dynamic' ); - } - - function poweredbyico() { return $this->getPoweredBy(); } - function copyrightico() { return $this->getCopyrightIcon(); } - - function lastmod() { - global $wgMaxCredits; - if ( $wgMaxCredits ) return ''; - - if ( !isset( $this->mLastmod ) ) { - if ( $this->isCurrentArticleView() ) { - $this->mLastmod = $this->lastModified(); - } else { - $this->mLastmod = ''; - } - } - return cbt_value( $this->mLastmod, 'dynamic' ); - } - - function viewcount() { - global $wgDisableCounters; - if ( $wgDisableCounters ) return ''; - - global $wgLang, $wgArticle; - if ( is_object( $wgArticle ) ) { - $viewcount = $wgLang->formatNum( $wgArticle->getCount() ); - if ( $viewcount ) { - $viewcount = wfMsg( "viewcount", $viewcount ); - } else { - $viewcount = ''; - } - } else { - $viewcount = ''; - } - return cbt_value( $viewcount, 'dynamic' ); - } - - function numberofwatchingusers() { - global $wgPageShowWatchingUsers; - if ( !$wgPageShowWatchingUsers ) return ''; - - $dbr = wfGetDB( DB_SLAVE ); - extract( $dbr->tableNames( 'watchlist' ) ); - $sql = "SELECT COUNT(*) AS n FROM $watchlist - WHERE wl_title='" . $dbr->strencode($this->mTitle->getDBkey()) . - "' AND wl_namespace=" . $this->mTitle->getNamespace() ; - $res = $dbr->query( $sql, 'SkinTemplate::outputPage'); - $row = $dbr->fetchObject( $res ); - $num = $row->n; - if ($num > 0) { - $s = wfMsg('number_of_watching_users_pageview', $num); - } else { - $s = ''; - } - return cbt_value( $s, 'dynamic' ); - } - - function credits() { - global $wgMaxCredits; - if ( !$wgMaxCredits ) return ''; - - if ( $this->isCurrentArticleView() ) { - require_once("Credits.php"); - global $wgArticle, $wgShowCreditsIfMax; - $credits = getCredits($wgArticle, $wgMaxCredits, $wgShowCreditsIfMax); - } else { - $credits = ''; - } - return cbt_value( $credits, 'view dynamic' ); - } - - function normalcopyright() { - return $this->getCopyright( 'normal' ); - } - - function historycopyright() { - return $this->getCopyright( 'history' ); - } - - function is_currentview() { - global $wgRequest; - return cbt_value( (string)$this->isCurrentArticleView(), 'view' ); - } - - function usehistorycopyright() { - global $wgRequest; - if ( wfMsgForContent( 'history_copyright' ) == '-' ) return ''; - - $oldid = $this->getOldId(); - $diff = $this->getDiff(); - $use = (string)(!is_null( $oldid ) && is_null( $diff )); - return cbt_value( $use, 'nonview dynamic' ); - } - - function privacy() { - return cbt_value( $this->privacyLink(), 'lang' ); - } - function about() { - return cbt_value( $this->aboutLink(), 'lang' ); - } - function disclaimer() { - return cbt_value( $this->disclaimerLink(), 'lang' ); - } - function tagline() { - # A reference to this tag existed in the old MonoBook.php, but the - # template data wasn't set anywhere - return ''; - } - function reporttime() { - return cbt_value( $this->mOut->reportTime(), 'dynamic' ); - } - - function msg( $name ) { - return cbt_value( wfMsg( $name ), 'lang' ); - } - - function fallbackmsg( $name, $fallback ) { - $text = wfMsg( $name ); - if ( wfEmptyMsg( $name, $text ) ) { - $text = $fallback; - } - return cbt_value( $text, 'lang' ); - } - - /****************************************************** - * Utility functions * - ******************************************************/ - - /** Return true if this request is a valid, secure CSS preview */ - function isCssPreview() { - if ( !isset( $this->mCssPreview ) ) { - global $wgRequest, $wgAllowUserCss, $wgUser; - $this->mCssPreview = - $wgAllowUserCss && - $wgUser->isLoggedIn() && - $this->mTitle->isCssSubpage() && - $this->userCanPreview( $this->getAction() ); - } - return $this->mCssPreview; - } - - /** Return true if this request is a valid, secure JS preview */ - function isJsPreview() { - if ( !isset( $this->mJsPreview ) ) { - global $wgRequest, $wgAllowUserJs, $wgUser; - $this->mJsPreview = - $wgAllowUserJs && - $wgUser->isLoggedIn() && - $this->mTitle->isJsSubpage() && - $this->userCanPreview( $this->getAction() ); - } - return $this->mJsPreview; - } - - /** Get the title of the $wgUser's user page */ - function getUserPageTitle() { - if ( !isset( $this->mUserPageTitle ) ) { - global $wgUser; - $this->mUserPageTitle = $wgUser->getUserPage(); - } - return $this->mUserPageTitle; - } - - /** Get the text of the user page title */ - function getUserPageText() { - if ( !isset( $this->mUserPageText ) ) { - $userPage = $this->getUserPageTitle(); - $this->mUserPageText = $userPage->getPrefixedText(); - } - return $this->mUserPageText; - } - - /** Make an HTML element for a stylesheet link */ - function makeStylesheetLink( $url ) { - return '"; - } - - /** Make an XHTML element for inline CSS */ - function makeStylesheetCdata( $style ) { - return ""; - } - - /** Get the edit URL for this page */ - function getEditUrl() { - if ( !isset( $this->mEditUrl ) ) { - $this->mEditUrl = $this->mTitle->getLocalUrl( $this->editUrlOptions() ); - } - return $this->mEditUrl; - } - - /** Get the prefixed DB key for this page */ - function getThisPDBK() { - if ( !isset( $this->mThisPDBK ) ) { - $this->mThisPDBK = $this->mTitle->getPrefixedDbKey(); - } - return $this->mThisPDBK; - } - - function getThisTitleUrlForm() { - if ( !isset( $this->mThisTitleUrlForm ) ) { - $this->mThisTitleUrlForm = $this->mTitle->getPrefixedURL(); - } - return $this->mThisTitleUrlForm; - } - - /** - * If the current page is a user page, get the user's ID and IP. Otherwise return array(0,false) - */ - function getUserPageIdIp() { - if ( !isset( $this->mUserPageId ) ) { - if( $this->mTitle->getNamespace() == NS_USER || $this->mTitle->getNamespace() == NS_USER_TALK ) { - $this->mUserPageId = User::idFromName($this->mTitle->getText()); - $this->mUserPageIp = User::isIP($this->mTitle->getText()); - } else { - $this->mUserPageId = 0; - $this->mUserPageIp = false; - } - } - return array( $this->mUserPageId, $this->mUserPageIp ); - } - - /** - * Returns a permalink URL, or false if the current page is already a - * permalink, or blank if a permalink shouldn't be displayed - */ - function getPermalink() { - if ( !isset( $this->mPermalink ) ) { - global $wgRequest, $wgArticle; - $action = $this->getAction(); - $oldid = $this->getOldId(); - $url = ''; - if( $this->mTitle->getNamespace() !== NS_SPECIAL - && $this->mTitle->getArticleId() != 0 - && ($action == '' || $action == 'view' || $action == 'purge' ) ) - { - if ( !$oldid ) { - $revid = $wgArticle->getLatest(); - $url = $this->mTitle->getLocalURL( "oldid=$revid" ); - } else { - $url = false; - } - } else { - $url = ''; - } - } - return $url; - } - - /** - * Returns true if the current page is an article, not a special page, - * and we are viewing a revision, not a diff - */ - function isArticleView() { - global $wgOut, $wgArticle, $wgRequest; - if ( !isset( $this->mIsArticleView ) ) { - $oldid = $this->getOldId(); - $diff = $this->getDiff(); - $this->mIsArticleView = $wgOut->isArticle() and - (!is_null( $oldid ) or is_null( $diff )) and 0 != $wgArticle->getID(); - } - return $this->mIsArticleView; - } - - function isCurrentArticleView() { - if ( !isset( $this->mIsCurrentArticleView ) ) { - global $wgOut, $wgArticle, $wgRequest; - $oldid = $this->getOldId(); - $this->mIsCurrentArticleView = $wgOut->isArticle() && is_null( $oldid ) && 0 != $wgArticle->getID(); - } - return $this->mIsCurrentArticleView; - } - - - /** - * Return true if the current page is editable; if edit section on right - * click should be enabled. - */ - function isEditable() { - global $wgRequest; - $action = $this->getAction(); - return ($this->mTitle->getNamespace() != NS_SPECIAL and !($action == 'edit' or $action == 'submit')); - } - - /** Return true if the user is logged in */ - function isLoggedIn() { - global $wgUser; - return $wgUser->isLoggedIn(); - } - - /** Get the local URL of the current page */ - function getPageUrl() { - if ( !isset( $this->mPageUrl ) ) { - $this->mPageUrl = $this->mTitle->getLocalURL(); - } - return $this->mPageUrl; - } - - /** Make a link to a title using a template */ - function makeTemplateLink( $template, $key, $title, $text ) { - $url = $title->getLocalUrl(); - return strtr( $template, - array( - '$key' => $key, - '$classactive' => ($url == $this->getPageUrl()) ? 'class="active"' : '', - '$class' => $title->getArticleID() == 0 ? 'class="new"' : '', - '$href' => htmlspecialchars( $url ), - '$text' => $text - ) ); - } - - /** Make a link to a URL using a template */ - function makeTemplateLinkUrl( $template, $key, $url, $text ) { - return strtr( $template, - array( - '$key' => $key, - '$classactive' => ($url == $this->getPageUrl()) ? 'class="active"' : '', - '$class' => '', - '$href' => htmlspecialchars( $url ), - '$text' => $text - ) ); - } - - /** Make a link to a special page using a template */ - function makeSpecialTemplateLink( $template, $key, $specialName, $text, $query = '' ) { - $url = self::makeSpecialUrl( $specialName, $query ); - // Ignore the query when comparing - $active = ($this->mTitle->getNamespace() == NS_SPECIAL && $this->mTitle->getDBkey() == $specialName); - return strtr( $template, - array( - '$key' => $key, - '$classactive' => $active ? 'class="active"' : '', - '$class' => '', - '$href' => htmlspecialchars( $url ), - '$text' => $text - ) ); - } - - function loadRequestValues() { - global $wgRequest; - $this->mAction = $wgRequest->getText( 'action' ); - $this->mOldId = $wgRequest->getVal( 'oldid' ); - $this->mDiff = $wgRequest->getVal( 'diff' ); - $this->mSection = $wgRequest->getVal( 'section' ); - $this->mSearch = $wgRequest->getVal( 'search' ); - $this->mRequestValuesLoaded = true; - } - - - - /** Get the action parameter of the request */ - function getAction() { - if ( !isset( $this->mRequestValuesLoaded ) ) { - $this->loadRequestValues(); - } - return $this->mAction; - } - - /** Get the oldid parameter */ - function getOldId() { - if ( !isset( $this->mRequestValuesLoaded ) ) { - $this->loadRequestValues(); - } - return $this->mOldId; - } - - /** Get the diff parameter */ - function getDiff() { - if ( !isset( $this->mRequestValuesLoaded ) ) { - $this->loadRequestValues(); - } - return $this->mDiff; - } - - function getSection() { - if ( !isset( $this->mRequestValuesLoaded ) ) { - $this->loadRequestValues(); - } - return $this->mSection; - } - - function getSearch() { - if ( !isset( $this->mRequestValuesLoaded ) ) { - $this->loadRequestValues(); - } - return $this->mSearch; - } - - /** Make a special page URL of the form [[Special:Somepage/{title_urlform}]] */ - function makeSpecialParamUrl( $name, $query = '', $param = '{title_urlform}' ) { - // Abuse makeTitle's lax validity checking to slip a control character into the URL - $title = Title::makeTitle( NS_SPECIAL, "$name/\x1a" ); - $url = cbt_escape( $title->getLocalURL( $query ) ); - // Now replace it with the parameter - return str_replace( '%1A', $param, $url ); - } - - function getSubjectPage() { - if ( !isset( $this->mSubjectPage ) ) { - $this->mSubjectPage = $this->mTitle->getSubjectPage(); - } - return $this->mSubjectPage; - } - - function getTalkPage() { - if ( !isset( $this->mTalkPage ) ) { - $this->mTalkPage = $this->mTitle->getTalkPage(); - } - return $this->mTalkPage; - } -} - -- 2.20.1