Aude has uploaded a new change for review.
https://gerrit.wikimedia.org/r/101185
Change subject: Style cleanup in scribunto code
......................................................................
Style cleanup in scribunto code
Change-Id: Ia62819507fde9d576335353be8053e1d5a89ea2c
---
A client/includes/WikibaseLibrary.php
M client/includes/scribunto/Scribunto_LuaWikibaseLibrary.php
2 files changed, 152 insertions(+), 1 deletion(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/Wikibase
refs/changes/85/101185/1
diff --git a/client/includes/WikibaseLibrary.php
b/client/includes/WikibaseLibrary.php
new file mode 100644
index 0000000..3fda3f2
--- /dev/null
+++ b/client/includes/WikibaseLibrary.php
@@ -0,0 +1,146 @@
+<?php
+
+use ValueParsers\ParseException;
+use Wikibase\Client\WikibaseClient;
+use Wikibase\Lib\Serializers\SerializationOptions;
+use Wikibase\Lib\Serializers\SerializerFactory;
+use Wikibase\LanguageFallbackChainFactory;
+use Wikibase\Utils;
+
+/**
+ * Registers and defines functions to access Wikibase through the Scribunto
extension
+ *
+ * @since 0.4
+ *
+ * @licence GNU GPL v2+
+ * @author Jens Ohlig < jens.oh...@wikimedia.de >
+ */
+
+class Scribunto_LuaWikibaseLibrary extends Scribunto_LuaLibraryBase {
+
+ /**
+ * Register mw.wikibase.lua library
+ *
+ * @since 0.4
+ */
+ public function register() {
+ $lib = array(
+ 'getEntity' => array( $this, 'getEntity' ),
+ 'getEntityId' => array( $this, 'getEntityId' ),
+ 'getGlobalSiteId' => array( $this, 'getGlobalSiteId' )
+ );
+ $this->getEngine()->registerInterface( dirname( __FILE__ ) .
'/../resources/' . 'mw.wikibase.lua', $lib, array() );
+ }
+
+ /**
+ * Get entity from prefixed ID (e.g. "Q23") and return it as serialized
array.
+ *
+ * @since 0.4
+ *
+ * @param string $prefixedEntityId
+ *
+ * @throws ScribuntoException
+ * @return array $entityArr
+ */
+ public function getEntity( $prefixedEntityId = null ) {
+ echo __METHOD__;
+ $this->checkType( 'getEntity', 1, $prefixedEntityId, 'string' );
+ $prefixedEntityId = trim( $prefixedEntityId );
+ echo $prefixedEntityId;
+ wfDebugLog( 'wikidata', var_export( $prefixedEntityId, true ) );
+ $entityIdParser =
WikibaseClient::getDefaultInstance()->getEntityIdParser();
+
+ try {
+ $entityId = $entityIdParser->parse( $prefixedEntityId );
+ }
+ catch ( ParseException $parseException ) {
+ wfDebugLog( 'wikidata', 'invalid id' );
+ throw $this->getEngine()->newException(
'wikibase-error-invalid-entity-id' );
+ }
+
+ $entityObject =
WikibaseClient::getDefaultInstance()->getStore()->getEntityLookup()->getEntity(
+ $entityId
+ );
+
+ wfDebugLog( 'wikidata', var_export( $entityObject, true ) );
+
+ if ( $entityObject == null ) {
+ return array( null );
+ }
+
+ $opt = new SerializationOptions();
+ $serializerFactory = new SerializerFactory( $opt );
+
+ // Using "ID_KEYS_BOTH" here means that all lists of Snaks or
Claims will be listed
+ // twice, once with a lower case key and once with an upper
case key.
+ // This is a B/C hack to allow existing lua code to use
hardcoded IDs
+ // in both lower (legacy) and upper case.
+ $opt->setIdKeyMode( SerializationOptions::ID_KEYS_BOTH );
+
+ // This is $wgContLang, not parser target language or anything
else.
+ // See Scribunto_LuaLanguageLibrary::getContLangCode().
+ global $wgContLang;
+
+ // See mw.wikibase.lua. This is the only way to inject values
into mw.wikibase.label( ),
+ // so any customized Lua modules can access labels of another
entity written in another variant,
+ // unless we give them the ability to getEntity() any entity by
specifying its ID, not just self.
+ $chain =
WikibaseClient::getDefaultInstance()->getLanguageFallbackChainFactory()->newFromLanguage(
+ $wgContLang,
LanguageFallbackChainFactory::FALLBACK_SELF |
LanguageFallbackChainFactory::FALLBACK_VARIANTS
+ );
+ // SerializationOptions accepts mixed types of keys happily.
+ $opt->setLanguages( Utils::getLanguageCodes() + array(
$wgContLang->getCode() => $chain ) );
+
+ $serializer = $serializerFactory->newSerializerForObject(
$entityObject, $opt );
+
+ try {
+ $entityArr = $serializer->getSerialized( $entityObject
);
+ return array( $entityArr );
+ } catch ( \Exception $e ) {
+ throw $this->getEngine()->newException(
'wikibase-error-serialize-error' );
+ }
+ }
+
+ /**
+ * Get entity id from page title.
+ *
+ * @since 0.4
+ *
+ * @param string $pageTitle
+ *
+ * @return string $id
+ */
+ public function getEntityId( $pageTitle = null ) {
+ $this->checkType( 'getEntityByTitle', 1, $pageTitle, 'string' );
+ $globalSiteId = \Wikibase\Settings::get( 'siteGlobalID' );
+ $table =
WikibaseClient::getDefaultInstance()->getStore()->getSiteLinkTable();
+ if ( $table == null ) {
+ return array( null );
+ }
+
+ $numericId = $table->getItemIdForLink( $globalSiteId,
$pageTitle );
+ if ( !is_int( $numericId ) ) {
+ return array( null );
+ }
+
+ $id = new Wikibase\EntityId( \Wikibase\Item::ENTITY_TYPE,
$numericId );
+ if ( $id == null ) {
+ return array( null );
+ }
+
+ $idFormatter =
WikibaseClient::getDefaultInstance()->getEntityIdFormatter();
+
+ return array( $idFormatter->format( $id ) );
+ }
+
+ /**
+ * Get global site ID (e.g. "enwiki")
+ * This is basically a helper function.
+ * I can see this becoming part of mw.site in the Scribunto extension.
+ *
+ * @since 0.4
+ *
+ */
+ public function getGlobalSiteId() {
+ return array( \Wikibase\Settings::get( 'siteGlobalID' ) );
+ }
+}
diff --git a/client/includes/scribunto/Scribunto_LuaWikibaseLibrary.php
b/client/includes/scribunto/Scribunto_LuaWikibaseLibrary.php
index 007d5ef..2d7c373 100644
--- a/client/includes/scribunto/Scribunto_LuaWikibaseLibrary.php
+++ b/client/includes/scribunto/Scribunto_LuaWikibaseLibrary.php
@@ -46,7 +46,12 @@
* @since 0.4
*/
public function register() {
- $lib = array( 'getEntity' => array( $this, 'getEntity' ),
'getEntityId' => array( $this, 'getEntityId' ), 'getGlobalSiteId' => array(
$this, 'getGlobalSiteId' ) );
+ $lib = array(
+ 'getEntity' => array( $this, 'getEntity' ),
+ 'getEntityId' => array( $this, 'getEntityId' ),
+ 'getGlobalSiteId' => array( $this, 'getGlobalSiteId' )
+ );
+
$this->getEngine()->registerInterface( dirname( __FILE__ ) .
'/mw.wikibase.lua', $lib, array() );
}
--
To view, visit https://gerrit.wikimedia.org/r/101185
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: Ia62819507fde9d576335353be8053e1d5a89ea2c
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/Wikibase
Gerrit-Branch: master
Gerrit-Owner: Aude <aude.w...@gmail.com>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
