Moved widget-rendering functions into a new file, WidgetRenderer.php, for greater modularity
This commit is contained in:
Yaron Koren
Родитель
f0a6dbe8eb
Коммит
e277b3f1d0
|
|
@ -0,0 +1,193 @@
|
||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* Class holding functions for displaying widgets.
|
||||||
|
*/
|
||||||
|
|
||||||
|
if ( !defined( 'MEDIAWIKI' ) ) {
|
||||||
|
echo "This file is not a valid entry point.";
|
||||||
|
exit( 1 );
|
||||||
|
}
|
||||||
|
|
||||||
|
class WidgetRenderer {
|
||||||
|
|
||||||
|
public static function renderWidget ( &$parser, $widgetName ) {
|
||||||
|
global $IP;
|
||||||
|
|
||||||
|
$smarty = new Smarty;
|
||||||
|
$smarty->left_delimiter = '<!--{';
|
||||||
|
$smarty->right_delimiter = '}-->';
|
||||||
|
$smarty->compile_dir = "$IP/extensions/Widgets/compiled_templates/";
|
||||||
|
|
||||||
|
// registering custom Smarty plugins
|
||||||
|
$smarty->plugins_dir[] = "$IP/extensions/Widgets/smarty_plugins/";
|
||||||
|
|
||||||
|
$smarty->security = true;
|
||||||
|
$smarty->security_settings = array(
|
||||||
|
'IF_FUNCS' => array(
|
||||||
|
'is_array',
|
||||||
|
'isset',
|
||||||
|
'array',
|
||||||
|
'list',
|
||||||
|
'count',
|
||||||
|
'sizeof',
|
||||||
|
'in_array',
|
||||||
|
'true',
|
||||||
|
'false',
|
||||||
|
'null'
|
||||||
|
),
|
||||||
|
'MODIFIER_FUNCS' => array( 'validate' )
|
||||||
|
);
|
||||||
|
|
||||||
|
// register the resource name "db"
|
||||||
|
$smarty->register_resource(
|
||||||
|
'wiki',
|
||||||
|
array(
|
||||||
|
'WidgetRenderer::wiki_get_template',
|
||||||
|
'WidgetRenderer::wiki_get_timestamp',
|
||||||
|
'WidgetRenderer::wiki_get_secure',
|
||||||
|
'WidgetRenderer::wiki_get_trusted'
|
||||||
|
)
|
||||||
|
);
|
||||||
|
|
||||||
|
$params = func_get_args();
|
||||||
|
array_shift( $params ); # first one is parser - we don't need it
|
||||||
|
array_shift( $params ); # second one is widget name
|
||||||
|
|
||||||
|
$params_tree = array();
|
||||||
|
|
||||||
|
foreach ( $params as $param ) {
|
||||||
|
$pair = explode('=', $param, 2);
|
||||||
|
|
||||||
|
if ( count( $pair ) == 2 ) {
|
||||||
|
$key = trim($pair[0]);
|
||||||
|
$val = trim($pair[1]);
|
||||||
|
} else {
|
||||||
|
$key = $param;
|
||||||
|
$val = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
if ( $val == 'false' ) {
|
||||||
|
$val = false;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* If the name of the parameter has object notation
|
||||||
|
|
||||||
|
a.b.c.d
|
||||||
|
|
||||||
|
then we assign stuff to hash of hashes, not scalar
|
||||||
|
|
||||||
|
*/
|
||||||
|
$keys = explode( '.', $key );
|
||||||
|
|
||||||
|
// $subtree will be moved from top to the bottom and at the end will point to the last level
|
||||||
|
$subtree =& $params_tree;
|
||||||
|
|
||||||
|
// go throught all the keys but last one
|
||||||
|
$last_key = array_pop( $keys );
|
||||||
|
|
||||||
|
foreach ( $keys as $subkey ) {
|
||||||
|
// if next level of subtree doesn't exist yet, create an empty one
|
||||||
|
if ( !array_key_exists( $subkey, $subtree ) ) {
|
||||||
|
$subtree[$subkey] = array();
|
||||||
|
}
|
||||||
|
|
||||||
|
// move to the lower level
|
||||||
|
$subtree =& $subtree[$subkey];
|
||||||
|
}
|
||||||
|
|
||||||
|
// last portion of the key points to itself
|
||||||
|
if ( isset( $subtree[$last_key] ) ) {
|
||||||
|
// if already an array, push into it, otherwise, convert into array first
|
||||||
|
if ( !is_array( $subtree[$last_key] ) ) {
|
||||||
|
$subtree[$last_key] = array( $subtree[$last_key] );
|
||||||
|
}
|
||||||
|
|
||||||
|
$subtree[$last_key][] = $val;
|
||||||
|
} else {
|
||||||
|
// doesn't exist yet, just setting a value
|
||||||
|
$subtree[$last_key] = $val;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$smarty->assign( $params_tree );
|
||||||
|
|
||||||
|
try {
|
||||||
|
$output = $smarty->fetch( "wiki:$widgetName" );
|
||||||
|
} catch ( Exception $e ) {
|
||||||
|
wfLoadExtensionMessages( 'Widgets' );
|
||||||
|
return '<div class=\"error\">' . wfMsgExt( 'widgets-desc', array( 'parsemag' ), htmlentities($widgetName) ) . '</div>';
|
||||||
|
}
|
||||||
|
|
||||||
|
// Hide the widget from the parser
|
||||||
|
$output = 'ENCODED_CONTENT '.base64_encode($output).' END_ENCODED_CONTENT';
|
||||||
|
return $output;
|
||||||
|
}
|
||||||
|
|
||||||
|
public static function processEncodedWidgetOutput( &$out, &$text ) {
|
||||||
|
// Find all hidden content and restore to normal
|
||||||
|
$text = preg_replace(
|
||||||
|
'/ENCODED_CONTENT ([0-9a-zA-Z\/+]+=*)* END_ENCODED_CONTENT/esm',
|
||||||
|
'base64_decode("$1")',
|
||||||
|
$text
|
||||||
|
);
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
// the following four functions are all registered with Smarty
|
||||||
|
public static function wiki_get_template( $widgetName, &$widgetCode, &$smarty_obj ) {
|
||||||
|
global $wgWidgetsUseFlaggedRevs;
|
||||||
|
|
||||||
|
$widgetTitle = Title::newFromText($widgetName, NS_WIDGET);
|
||||||
|
if ( $widgetTitle && $widgetTitle->exists() ) {
|
||||||
|
if ($wgWidgetsUseFlaggedRevs)
|
||||||
|
{
|
||||||
|
$flaggedWidgetArticle = FlaggedArticle::getTitleInstance( $widgetTitle );
|
||||||
|
$flaggedWidgetArticleRevision = $flaggedWidgetArticle->getStableRev();
|
||||||
|
if ($flaggedWidgetArticleRevision)
|
||||||
|
{
|
||||||
|
$widgetCode = $flaggedWidgetArticleRevision->getRevText();
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
$widgetCode = '';
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
$widgetArticle = new Article( $widgetTitle, 0 );
|
||||||
|
$widgetCode = $widgetArticle->getContent();
|
||||||
|
}
|
||||||
|
|
||||||
|
// Remove <noinclude> sections and <includeonly> tags from form definition
|
||||||
|
$widgetCode = StringUtils::delimiterReplace( '<noinclude>', '</noinclude>', '', $widgetCode );
|
||||||
|
$widgetCode = strtr( $widgetCode, array( '<includeonly>' => '', '</includeonly>' => '' ) );
|
||||||
|
|
||||||
|
return true;
|
||||||
|
} else {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public static function wiki_get_timestamp( $widgetName, &$widgetTimestamp, &$smarty_obj ) {
|
||||||
|
$widgetTitle = Title::newFromText( $widgetName, NS_WIDGET );
|
||||||
|
if ($widgetTitle && $widgetTitle->exists()) {
|
||||||
|
$widgetArticle = new Article( $widgetTitle, 0 );
|
||||||
|
$widgetTimestamp = $widgetArticle->getTouched();
|
||||||
|
|
||||||
|
return true;
|
||||||
|
} else {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public static function wiki_get_secure( $tpl_name, &$smarty_obj ) {
|
||||||
|
// assume all templates are secure
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
public static function wiki_get_trusted( $tpl_name, &$smarty_obj ) {
|
||||||
|
// not used for templates
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
174
Widgets.php
174
Widgets.php
|
|
@ -16,7 +16,7 @@ $wgExtensionCredits['parserhook'][] = array(
|
||||||
'path' => __FILE__,
|
'path' => __FILE__,
|
||||||
'name' => 'Widgets',
|
'name' => 'Widgets',
|
||||||
'descriptionmsg' => 'widgets-desc',
|
'descriptionmsg' => 'widgets-desc',
|
||||||
'version' => '0.9.1-dev',
|
'version' => '0.9.1',
|
||||||
'author' => '[http://www.sergeychernyshev.com Sergey Chernyshev]',
|
'author' => '[http://www.sergeychernyshev.com Sergey Chernyshev]',
|
||||||
'url' => 'http://www.mediawiki.org/wiki/Extension:Widgets'
|
'url' => 'http://www.mediawiki.org/wiki/Extension:Widgets'
|
||||||
);
|
);
|
||||||
|
|
@ -51,6 +51,7 @@ $dir = dirname( __FILE__ ) . '/';
|
||||||
// Initialize Smarty
|
// Initialize Smarty
|
||||||
require_once( $dir . 'smarty/Smarty.class.php' );
|
require_once( $dir . 'smarty/Smarty.class.php' );
|
||||||
$wgExtensionMessagesFiles['Widgets'] = $dir . 'Widgets.i18n.php';
|
$wgExtensionMessagesFiles['Widgets'] = $dir . 'Widgets.i18n.php';
|
||||||
|
$wgAutoloadClasses['WidgetRenderer'] = $dir . 'WidgetRenderer.php';
|
||||||
|
|
||||||
if( defined('MW_SUPPORTS_LOCALISATIONCACHE') ) {
|
if( defined('MW_SUPPORTS_LOCALISATIONCACHE') ) {
|
||||||
$wgExtensionMessagesFiles['WidgetsMagic'] = $dir . 'Widgets.i18n.magic.php';
|
$wgExtensionMessagesFiles['WidgetsMagic'] = $dir . 'Widgets.i18n.magic.php';
|
||||||
|
|
@ -73,124 +74,11 @@ $wgHooks['ParserFirstCallInit'][] = 'widgetParserFunctions';
|
||||||
$wgHooks['ParserAfterTidy'][] = 'processEncodedWidgetOutput';
|
$wgHooks['ParserAfterTidy'][] = 'processEncodedWidgetOutput';
|
||||||
|
|
||||||
function widgetParserFunctions( &$parser ) {
|
function widgetParserFunctions( &$parser ) {
|
||||||
$parser->setFunctionHook( 'widget', 'renderWidget' );
|
$parser->setFunctionHook( 'widget', array( 'WidgetRenderer', 'renderWidget' ) );
|
||||||
|
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
function renderWidget ( &$parser, $widgetName ) {
|
|
||||||
global $IP;
|
|
||||||
|
|
||||||
$smarty = new Smarty;
|
|
||||||
$smarty->left_delimiter = '<!--{';
|
|
||||||
$smarty->right_delimiter = '}-->';
|
|
||||||
$smarty->compile_dir = "$IP/extensions/Widgets/compiled_templates/";
|
|
||||||
|
|
||||||
// registering custom Smarty plugins
|
|
||||||
$smarty->plugins_dir[] = "$IP/extensions/Widgets/smarty_plugins/";
|
|
||||||
|
|
||||||
$smarty->security = true;
|
|
||||||
$smarty->security_settings = array(
|
|
||||||
'IF_FUNCS' => array(
|
|
||||||
'is_array',
|
|
||||||
'isset',
|
|
||||||
'array',
|
|
||||||
'list',
|
|
||||||
'count',
|
|
||||||
'sizeof',
|
|
||||||
'in_array',
|
|
||||||
'true',
|
|
||||||
'false',
|
|
||||||
'null'
|
|
||||||
),
|
|
||||||
'MODIFIER_FUNCS' => array( 'validate' )
|
|
||||||
);
|
|
||||||
|
|
||||||
// register the resource name "db"
|
|
||||||
$smarty->register_resource(
|
|
||||||
'wiki',
|
|
||||||
array(
|
|
||||||
'wiki_get_template',
|
|
||||||
'wiki_get_timestamp',
|
|
||||||
'wiki_get_secure',
|
|
||||||
'wiki_get_trusted'
|
|
||||||
)
|
|
||||||
);
|
|
||||||
|
|
||||||
$params = func_get_args();
|
|
||||||
array_shift( $params ); # first one is parser - we don't need it
|
|
||||||
array_shift( $params ); # second one is widget name
|
|
||||||
|
|
||||||
$params_tree = array();
|
|
||||||
|
|
||||||
foreach ( $params as $param ) {
|
|
||||||
$pair = explode('=', $param, 2);
|
|
||||||
|
|
||||||
if ( count( $pair ) == 2 ) {
|
|
||||||
$key = trim($pair[0]);
|
|
||||||
$val = trim($pair[1]);
|
|
||||||
} else {
|
|
||||||
$key = $param;
|
|
||||||
$val = true;
|
|
||||||
}
|
|
||||||
|
|
||||||
if ( $val == 'false' ) {
|
|
||||||
$val = false;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* If the name of the parameter has object notation
|
|
||||||
|
|
||||||
a.b.c.d
|
|
||||||
|
|
||||||
then we assign stuff to hash of hashes, not scalar
|
|
||||||
|
|
||||||
*/
|
|
||||||
$keys = explode( '.', $key );
|
|
||||||
|
|
||||||
// $subtree will be moved from top to the bottom and at the end will point to the last level
|
|
||||||
$subtree =& $params_tree;
|
|
||||||
|
|
||||||
// go throught all the keys but last one
|
|
||||||
$last_key = array_pop( $keys );
|
|
||||||
|
|
||||||
foreach ( $keys as $subkey ) {
|
|
||||||
// if next level of subtree doesn't exist yet, create an empty one
|
|
||||||
if ( !array_key_exists( $subkey, $subtree ) ) {
|
|
||||||
$subtree[$subkey] = array();
|
|
||||||
}
|
|
||||||
|
|
||||||
// move to the lower level
|
|
||||||
$subtree =& $subtree[$subkey];
|
|
||||||
}
|
|
||||||
|
|
||||||
// last portion of the key points to itself
|
|
||||||
if ( isset( $subtree[$last_key] ) ) {
|
|
||||||
// if already an array, push into it, otherwise, convert into array first
|
|
||||||
if ( !is_array( $subtree[$last_key] ) ) {
|
|
||||||
$subtree[$last_key] = array( $subtree[$last_key] );
|
|
||||||
}
|
|
||||||
|
|
||||||
$subtree[$last_key][] = $val;
|
|
||||||
} else {
|
|
||||||
// doesn't exist yet, just setting a value
|
|
||||||
$subtree[$last_key] = $val;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
$smarty->assign( $params_tree );
|
|
||||||
|
|
||||||
try {
|
|
||||||
$output = $smarty->fetch( "wiki:$widgetName" );
|
|
||||||
} catch ( Exception $e ) {
|
|
||||||
wfLoadExtensionMessages( 'Widgets' );
|
|
||||||
return '<div class=\"error\">' . wfMsgExt( 'widgets-desc', array( 'parsemag' ), htmlentities($widgetName) ) . '</div>';
|
|
||||||
}
|
|
||||||
|
|
||||||
// Hide the widget from the parser
|
|
||||||
$output = 'ENCODED_CONTENT '.base64_encode($output).' END_ENCODED_CONTENT';
|
|
||||||
return $output;
|
|
||||||
}
|
|
||||||
|
|
||||||
function processEncodedWidgetOutput( &$out, &$text ) {
|
function processEncodedWidgetOutput( &$out, &$text ) {
|
||||||
// Find all hidden content and restore to normal
|
// Find all hidden content and restore to normal
|
||||||
$text = preg_replace(
|
$text = preg_replace(
|
||||||
|
|
@ -215,59 +103,3 @@ function widgetNamespacesInit() {
|
||||||
$wgNamespaceProtection[NS_WIDGET] = array( 'editwidgets' );
|
$wgNamespaceProtection[NS_WIDGET] = array( 'editwidgets' );
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// put these function somewhere in your application
|
|
||||||
function wiki_get_template( $widgetName, &$widgetCode, &$smarty_obj ) {
|
|
||||||
global $wgWidgetsUseFlaggedRevs;
|
|
||||||
|
|
||||||
$widgetTitle = Title::newFromText($widgetName, NS_WIDGET);
|
|
||||||
if ( $widgetTitle && $widgetTitle->exists() ) {
|
|
||||||
if ($wgWidgetsUseFlaggedRevs)
|
|
||||||
{
|
|
||||||
$flaggedWidgetArticle = FlaggedArticle::getTitleInstance( $widgetTitle );
|
|
||||||
$flaggedWidgetArticleRevision = $flaggedWidgetArticle->getStableRev();
|
|
||||||
if ($flaggedWidgetArticleRevision)
|
|
||||||
{
|
|
||||||
$widgetCode = $flaggedWidgetArticleRevision->getRevText();
|
|
||||||
}
|
|
||||||
else
|
|
||||||
{
|
|
||||||
$widgetCode = '';
|
|
||||||
}
|
|
||||||
}
|
|
||||||
else
|
|
||||||
{
|
|
||||||
$widgetArticle = new Article( $widgetTitle, 0 );
|
|
||||||
$widgetCode = $widgetArticle->getContent();
|
|
||||||
}
|
|
||||||
|
|
||||||
// Remove <noinclude> sections and <includeonly> tags from form definition
|
|
||||||
$widgetCode = StringUtils::delimiterReplace( '<noinclude>', '</noinclude>', '', $widgetCode );
|
|
||||||
$widgetCode = strtr( $widgetCode, array( '<includeonly>' => '', '</includeonly>' => '' ) );
|
|
||||||
|
|
||||||
return true;
|
|
||||||
} else {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
function wiki_get_timestamp( $widgetName, &$widgetTimestamp, &$smarty_obj ) {
|
|
||||||
$widgetTitle = Title::newFromText( $widgetName, NS_WIDGET );
|
|
||||||
if ($widgetTitle && $widgetTitle->exists()) {
|
|
||||||
$widgetArticle = new Article( $widgetTitle, 0 );
|
|
||||||
$widgetTimestamp = $widgetArticle->getTouched();
|
|
||||||
|
|
||||||
return true;
|
|
||||||
} else {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
function wiki_get_secure( $tpl_name, &$smarty_obj ) {
|
|
||||||
// assume all templates are secure
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
function wiki_get_trusted( $tpl_name, &$smarty_obj ) {
|
|
||||||
// not used for templates
|
|
||||||
}
|
|
||||||
|
|
|
||||||
Загрузка…
Ссылка в новой задаче