diff options
Diffstat (limited to 'www/wiki/extensions/SemanticMediaWiki/src/GlobalFunctions.php')
| -rw-r--r-- | www/wiki/extensions/SemanticMediaWiki/src/GlobalFunctions.php | 282 |
1 files changed, 282 insertions, 0 deletions
diff --git a/www/wiki/extensions/SemanticMediaWiki/src/GlobalFunctions.php b/www/wiki/extensions/SemanticMediaWiki/src/GlobalFunctions.php new file mode 100644 index 00000000..7fa3a9e8 --- /dev/null +++ b/www/wiki/extensions/SemanticMediaWiki/src/GlobalFunctions.php @@ -0,0 +1,282 @@ +<?php + +use SMW\CompatibilityMode; +use SMW\DataValues\Number\IntlNumberFormatter; +use SMW\Highlighter; +use SMW\NamespaceManager; +use SMW\ProcessingErrorMsgHandler; + +/** + * Global functions specified and used by Semantic MediaWiki. In general, it is + * tried to fit functions in suitable classes as static methods if they clearly + * belong to some particular sub-function of SMW. Most functions here are used + * in diverse contexts so that they do not have fonud a place in any such class + * yet. + * @ingroup SMW + */ + +/** + * Takes a title text and turns it safely into its DBKey. This function + * reimplements most of the title normalization as done in Title.php in order + * to achieve conversion with less overhead. The official code could be called + * here if more advanced normalization is needed. + * + * @param string $text + */ +function smwfNormalTitleDBKey( $text ) { + global $wgCapitalLinks; + + $text = trim( $text ); + + if ( $wgCapitalLinks ) { + $text = ucfirst( $text ); + } + + return str_replace( ' ', '_', $text ); +} + +/** + * Takes a text and turns it into a normalised version. This function + * reimplements the title normalization as done in Title.php in order to + * achieve conversion with less overhead. The official code could be called + * here if more advanced normalization is needed. + * + * @param string $text + */ +function smwfNormalTitleText( $text ) { + global $wgCapitalLinks, $wgContLang; + + $text = trim( $text ); + + if ( $wgCapitalLinks ) { + $text = $wgContLang->ucfirst( $text ); + } + + return str_replace( '_', ' ', $text ); +} + +/** + * Escapes text in a way that allows it to be used as XML content (e.g. as a + * string value for some property). + * + * @param string $text + */ +function smwfXMLContentEncode( $text ) { + return str_replace( [ '&', '<', '>' ], [ '&', '<', '>' ], Sanitizer::decodeCharReferences( $text ) ); +} + +/** + * Decodes character references and inserts Unicode characters instead, using + * the MediaWiki Sanitizer. + * + * @param string $text + */ +function smwfHTMLtoUTF8( $text ) { + return Sanitizer::decodeCharReferences( $text ); +} + +/** + * @deprecated since 2.1, use NumberFormatter instead + */ +function smwfNumberFormat( $value, $decplaces = 3 ) { + return IntlNumberFormatter::getInstance()->getLocalizedFormattedNumber( $value, $decplaces ); +} + +/** + * @since 3.0 + * + * @param string $text + */ +function smwfAbort( $text ) { + + if ( PHP_SAPI === 'cli' && PHP_SAPI === 'phpdbg' ) { + die( $text ); + } + + $html = "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\n"; + $html .= "<html xmlns=\"http://www.w3.org/1999/xhtml\" xml:lang=\"en\" lang=\"en\" dir=\"ltr\">\n"; + $html .= "<head><meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />"; + $html .= "<title>Error</title></head><body><h2>Error</h2><hr style='border: 0; height: 0; border-top: 1px solid rgba(0, 0, 0, 0.1); border-bottom: 1px solid rgba(255, 255, 255, 0.3);'>"; + $html .= "<p>{$text}</p></body></html>"; + + die( $html ); +} + +/** + * Formats an array of message strings so that it appears as a tooltip. + * $icon should be one of: 'warning' (default), 'info'. + * + * @param array $messages + * @param string $icon Acts like an enum. Callers must ensure safety, since this value is used directly in the output. + * @param string $seperator + * @param boolean $escape Should the messages be escaped or not (ie when they already are) + * + * @return string + */ +function smwfEncodeMessages( array $messages, $type = 'warning', $seperator = ' <!--br-->', $escape = true ) { + + $messages = ProcessingErrorMsgHandler::normalizeAndDecodeMessages( $messages ); + + if ( $messages === [] ) { + return ''; + } + + if ( $escape ) { + $messages = array_map( 'htmlspecialchars', $messages ); + } + + if ( count( $messages ) == 1 ) { + $content = $messages[0]; + } else { + foreach ( $messages as &$message ) { + $message = '<li>' . $message . '</li>'; + } + + $content = '<ul>' . implode( $seperator, $messages ) . '</ul>'; + } + + // Stop when a previous processing produced an error and it is expected to be + // added to a new tooltip (e.g {{#info {{#show ...}} }} ) instance + if ( Highlighter::hasHighlighterClass( $content, 'warning' ) ) { + return $content; + } + + $highlighter = Highlighter::factory( $type ); + + $highlighter->setContent( [ + 'caption' => null, + 'content' => Highlighter::decode( $content ) + ] ); + + return $highlighter->getHtml(); +} + +/** + * Returns an instance for the storage back-end + * + * @return SMWStore + */ +function &smwfGetStore() { + $store = \SMW\StoreFactory::getStore(); + return $store; +} + +/** + * @since 3.0 + * + * @param string $namespace + * @param string $key + * + * @return string + */ +function smwfCacheKey( $namespace, $key ) { + + $cachePrefix = $GLOBALS['wgCachePrefix'] === false ? wfWikiID() : $GLOBALS['wgCachePrefix']; + + if ( $namespace{0} !== ':' ) { + $namespace = ':' . $namespace; + } + + if ( is_array( $key ) ) { + $key = json_encode( $key ); + } + + return $cachePrefix . $namespace . ':' . md5( $key ); +} + +/** + * Compatibility helper for using Linker methods. + * MW 1.16 has a Linker with non-static methods, + * where in MW 1.19 they are static, and a DummyLinker + * class is introduced, which can be instantiated for + * compat reasons. As of MW 1.28, DummyLinker is being + * deprecated, so always use Linker. + * + * @since 1.6 + * + * @return Linker + */ +function smwfGetLinker() { + static $linker = false; + + if ( $linker === false ) { + $linker = new Linker(); + } + + return $linker; +} + +/** + * @private + * + * Copied from wfCountDown as it became deprecated in 1.31 + * + * @since 3.0 + */ +function swfCountDown( $seconds ) { + for ( $i = $seconds; $i >= 0; $i-- ) { + if ( $i != $seconds ) { + echo str_repeat( "\x08", strlen( $i + 1 ) ); + } + echo $i; + flush(); + if ( $i ) { + sleep( 1 ); + } + } + echo "\n"; +} + +/** + * Function to switch on Semantic MediaWiki. This function must be called in + * LocalSettings.php after including SMW_Settings.php. It is used to ensure + * that required parameters for SMW are really provided explicitly. For + * readability, this is the only global function that does not adhere to the + * naming conventions. + * + * This function also sets up all autoloading, such that all SMW classes are + * available as early on. Moreover, jobs and special pages are registered. + * + * @param mixed $namespace + * @param boolean $complete + * + * @return true + * + * @codeCoverageIgnore + */ +function enableSemantics( $namespace = null, $complete = false ) { + global $smwgNamespace; + + // #1732 + #2813 + wfLoadExtension( 'SemanticMediaWiki', dirname( __DIR__ ) . '/extension.json' ); + + // Apparently this is required (1.28+) as the earliest possible execution + // point in order for settings that refer to the SMW_NS_PROPERTY namespace + // to be available in LocalSettings + NamespaceManager::initCustomNamespace( $GLOBALS ); + + if ( !$complete && ( $smwgNamespace !== '' ) ) { + // The dot tells that the domain is not complete. It will be completed + // in the Export since we do not want to create a title object here when + // it is not needed in many cases. + $smwgNamespace = '.' . $namespace; + } else { + $smwgNamespace = $namespace; + } + + $GLOBALS['smwgSemanticsEnabled'] = true; + + return true; +} + +/** + * To disable Semantic MediaWiki's operational functionality + * + * @note This function can be used to temporary disable SMW but it is paramount + * that after SMW is re-enabled to run `rebuildData.php` in order for data to + * represent a state that mirrors the actual environment (deleted, moved pages + * are not tracked when disabled). + */ +function disableSemantics() { + CompatibilityMode::disableSemantics(); +} |