Prepare ULS for EventLogging

This change introduces a new configuration variable, $wgULSEventLogging. When
set to true, ULS will register an EventLogging schema module for
<http://meta.wikimedia.org/wiki/Schema:UniversalLanguageSelector>,
making it possible to log events using `mw.uls.logEvent`. When false, the
schema module is not loaded, and `mw.uls.logEvent` is a no-op.

Change-Id: I7139e67cc2f830a6b4b3c8ff1fc72dfcdec9a699

UniversalLanguageSelector.hooks.php

@@ -43,11 +43,16 @@ class UniversalLanguageSelectorHooks {
 	 * Hook: BeforePageDisplay
 	 */
 	public static function addModules( $out, $skin ) {
-		global $wgULSGeoService;
+		global $wgULSGeoService, $wgULSEventLogging;
 
 		// Load the style for users without JS, to hide the useless links
 		$out->addModuleStyles( 'ext.uls.nojs' );
 
+		// If EventLogging integration is enabled, load the schema module.
+		if ( $wgULSEventLogging ) {
+			$out->addModules( 'schema.UniversalLanguageSelector' );
+		}
+
 		// If the extension is enabled, basic features (API, language data) available.
 		$out->addModules( 'ext.uls.init' );
 
@@ -240,7 +245,7 @@ class UniversalLanguageSelectorHooks {
 	 */
 	public static function addConfig( &$vars ) {
 		global $wgULSGeoService, $wgULSIMEEnabled, $wgULSPosition,
-			$wgULSAnonCanChangeLanguage;
+			$wgULSAnonCanChangeLanguage, $wgULSEventLogging;
 
 		// Place constant stuff here (not depending on request context)
 		if ( is_string( $wgULSGeoService ) ) {
@@ -249,6 +254,7 @@ class UniversalLanguageSelectorHooks {
 		$vars['wgULSIMEEnabled'] = $wgULSIMEEnabled;
 		$vars['wgULSPosition'] = $wgULSPosition;
 		$vars['wgULSAnonCanChangeLanguage'] = $wgULSAnonCanChangeLanguage;
+		$vars['wgULSEventLogging'] = $wgULSEventLogging;
 
 		// ULS is localized using jquery.i18n library. Unless it knows
 		// the localized locales, it can create 404 response. To avoid that,

UniversalLanguageSelector.php

@@ -116,6 +116,13 @@ $wgULSIMEEnabled = true;
  */
 $wgULSPosition = 'personal';
 
+/**
+ * Whether to use EventLogging. The EventLogging extension must be installed
+ * if this option is enabled.
+ * @since 2013.06
+ */
+$wgULSEventLogging = false;
+
 $dir = __DIR__;
 
 // Internationalization
@@ -139,11 +146,12 @@ $wgHooks['UserGetLanguageObject'][] = 'UniversalLanguageSelectorHooks::getLangua
 $wgHooks['SkinTemplateOutputPageBeforeExec'][] =
 	'UniversalLanguageSelectorHooks::onSkinTemplateOutputPageBeforeExec';
 
+
 $wgDefaultUserOptions['uls-preferences'] = '';
 $wgHooks['GetPreferences'][] = 'UniversalLanguageSelectorHooks::onGetPreferences';
 
 $wgExtensionFunctions[] = function() {
-	global $wgHooks, $wgULSGeoService;
+	global $wgHooks, $wgResourceModules, $wgULSEventLogging, $wgULSGeoService;
 
 	if ( $wgULSGeoService === true ) {
 		$wgHooks['BeforePageDisplay'][] = function( &$out ) {
@@ -153,6 +161,24 @@ $wgExtensionFunctions[] = function() {
 		};
 	}
 
+	// If EventLogging integration is enabled, first ensure that the
+	// EventLogging extension is present, then declare schema module.
+	// If it is not present, emit a warning and disable logging.
+	if ( $wgULSEventLogging ) {
+		if ( class_exists( 'ResourceLoaderSchemaModule' ) ) {
+			/// @see https://meta.wikimedia.org/wiki/Schema:UniversalLanguageSelector
+			$wgResourceModules['schema.UniversalLanguageSelector'] = array(
+				'class'  => 'ResourceLoaderSchemaModule',
+				'schema' => 'UniversalLanguageSelector',
+				'revision' => 5573536,
+			);
+		} else {
+			wfWarn( 'UniversalLanguageSelector is configured to use EventLogging, but '
+					. 'the extension is is not available. Disabling wgULSEventLogging.' );
+			$wgULSEventLogging = false;
+		}
+	}
+
 	return true;
 };
 

resources/js/ext.uls.init.js

@@ -116,6 +116,33 @@
 		return !/MSIE [67]/i.test( navigator.userAgent );
 	};
 
+	/**
+	 * Local wrapper for 'mw.eventLog.logEvent' which handles default params
+	 * and ensures the correct schema is loaded.
+	 *
+	 * @param {Object} data Event action and optional fields
+	 * @since 2013.07
+	 * @see https://meta.wikimedia.org/wiki/Schema:UniversalLanguageSelector
+	 */
+	mw.uls.logEvent = $.noop;
+
+	// If EventLogging integration is enabled, set event defaults and make the
+	// the function call event logging with correct schema.
+	if ( mw.config.get( 'wgULSEventLogging' ) ) {
+		mw.loader.using( 'schema.UniversalLanguageSelector', function () {
+			mw.eventLog.setDefaults( 'UniversalLanguageSelector', {
+				version: 1,
+				token: mw.user.id(),
+				contentLanguage: mw.config.get( 'wgContentLanguage' ),
+				interfaceLanguage: currentLang
+			} );
+
+			mw.uls.logEvent = function ( event ) {
+				mw.eventLog.logEvent( 'UniversalLanguageSelector', event );
+			};
+		} );
+	}
+
 	/**
 	 * i18n initialization
 	 */