mediawiki-extensions-UniversalLanguageSelector/UniversalLanguageSelector.hooks.php

<?php
/**
 * Hooks for UniversalLanguageSelector extension.
 *
 * Copyright (C) 2012 Alolita Sharma, Amir Aharoni, Arun Ganesh, Brandon Harris,
 * Niklas Laxström, Pau Giner, Santhosh Thottingal, Siebrand Mazeland and other
 * contributors. See CREDITS for a list.
 *
 * UniversalLanguageSelector is dual licensed GPLv2 or later and MIT. You don't
 * have to do anything special to choose one license or the other and you don't
 * have to notify anyone which license you are using. You are free to use
 * UniversalLanguageSelector in commercial projects as long as the copyright
 * header is left intact. See files GPL-LICENSE and MIT-LICENSE for details.
 *
 * @file
 * @ingroup Extensions
 * @licence GNU General Public Licence 2.0 or later
 * @licence MIT License
 */

class UniversalLanguageSelectorHooks {
	public static function isToolbarEnabled( $user ) {
		global $wgULSEnable, $wgULSEnableAnon;
		if ( !$wgULSEnable ) {
			return false;
		}
		if ( !$wgULSEnableAnon ) {
			if ( $user->isAnon() ) {
				return false;
			}
		}
		return true;
	}

	/**
	 * BeforePageDisplay hook handler.
	 * @param $out OutputPage
	 * @param $skin Skin
	 * @return bool
	 */
	public static function addModules( $out, $skin ) {
		// If extension is enabled, basic features(API, language data) available.
		$out->addModules( 'ext.uls.init' );
		$out->addModules( 'ext.uls.geoclient' );
		if ( self::isToolbarEnabled( $out->getUser() ) ) {
			// Enable UI language selection for the user.
			$out->addModules( 'ext.uls.interface' );
		}

		return true;
	}

	/**
	 * ResourceLoaderTestModules hook handler.
	 * @param $testModules array of javascript testing modules. 'qunit' is fed using tests/qunit/QUnitTestResources.php.
	 * @param $resourceLoader ResourceLoader
	 * @return bool
	 */
	public static function addTestModules( array &$testModules, ResourceLoader &$resourceLoader ) {
		$testModules['qunit']['ext.uls.tests'] = array(
			'scripts' => array( 'tests/qunit/ext.uls.tests.js' ),
			'dependencies' => array( 'ext.uls.init', 'ext.uls.interface' ),
			'localBasePath' => __DIR__,
			'remoteExtPath' => 'UniversalLanguageSelector',
		);

		return true;
	}

	/**
	 * Add some tabs for navigation for users who do not use Ajax interface.
	 * Hooks: SkinTemplateNavigation, SkinTemplateTabs
	 */
	static function addTrigger( array &$personal_urls, &$title ) {
		global $wgLang, $wgUser;
		if ( !self::isToolbarEnabled( $wgUser ) ) {
			return true;
		}

		$personal_urls = array(
			'uls' => array(
				'text' => $wgLang->getLanguageName( $wgLang->getCode() ),
				'href' => '#',
				'class' => 'uls-trigger',
				'active' => true
			)
		) + $personal_urls;

		return true;
	}

	protected static function isSupportedLanguage( $language ) {
		wfProfileIn( __METHOD__ );
		$supported = Language::fetchLanguageNames( null, 'mwfile' );
		wfProfileOut( __METHOD__ );

		return isset( $supported[$language] );
	}

	/**
	 * @param array $preferred
	 * @return string
	 */
	protected static function getDefaultLanguage( array $preferred ) {
		wfProfileIn( __METHOD__ );
		$supported = Language::fetchLanguageNames( null, 'mwfile' );
		// look for a language that is acceptable to the client
		// and known to the wiki.
		foreach ( $preferred as $code => $weight ) {
			if ( isset( $supported[$code] ) ) {
				wfProfileOut( __METHOD__ );
				return $code;
			}
		}

		// Some browsers might only send codes like de-de.
		// Try with bare code.
		foreach ( $preferred as $code => $weight ) {
			$parts = explode( '-', $code, 2 );
			$code = $parts[0];
			if ( isset( $supported[$code] ) ) {
				wfProfileOut( __METHOD__ );
				return $code;
			}
		}

		wfProfileOut( __METHOD__ );
		return '';
	}

	/**
	 * Hook to UserGetLanguageObject
	 * @param  $user User
	 * @param  $code String
	 * @return bool
	 */
	public static function getLanguage( $user, &$code, $context = null ) {
		global $wgUser, $wgRequest, $wgULSLanguageDetection;
		if ( !self::isToolbarEnabled( $user ) ) {
			return true;
		}

		/* Before $request is passed to this, check if the given user
		 * name matches the current user name to detect if we are not
		 * running in the primary request context. See bug 44010 */
		if ( !$context instanceof RequestContext ) {
			if ( $wgUser->getName() !== $user->getName() ) {
				return true;
			}

			// Should be safe to use the global request now
			$request = $wgRequest;
		} else {
			$request = $context->getRequest();
		}

		$languageToSave = $request->getVal( 'setlang' );
		if ( $request->getVal( 'uselang' ) && !$languageToSave ) {
			// uselang can be used for temporary override of language preference
			// when setlang is not provided
			return true;
		}

		$languageToUse = null;
		if ( self::isSupportedLanguage( $languageToSave ) ) {
			if ( $user->isAnon() ) {
				$request->response()->setcookie( 'language', $languageToSave );
			} else {
				$user->setOption( 'language', $languageToSave );
				$user->saveSettings();
			}
			$languageToUse = $languageToSave;
		}

		// Load from cookie unless overriden
		if ( $languageToUse === null && $user->isAnon() ) {
			$languageToUse = $request->getCookie( 'language' );
		}

		// Check whether we got valid language from store or
		// explicit language change.
		if ( self::isSupportedLanguage( $languageToUse ) ) {
			$code = $languageToUse;
		} elseif ( $user->isAnon() && $wgULSLanguageDetection ) {
			$preferred = $request->getAcceptLang();
			$default = self::getDefaultLanguage( $preferred );
			if ( $default !== '' ) {
				$code = $default;
			}
		}

		// Fall back to content language
		return true;
	}

	/**
	 * Hook: ResourceLoaderGetConfigVars
	 * @param $vars Array
	 * @return bool
	 */
	public static function addConfig( &$vars ) {
		global $wgULSGeoService, $wgULSIMEEnabled;
		$vars['wgULSGeoService'] = $wgULSGeoService;

		$vars['wgULSIMEEnabled'] = $wgULSIMEEnabled;

		// ULS is localized using jquery.i18n library. Unless it knows
		// the localized locales, it can create 404 response. To avoid that,
		// send the locales available at server. Also avoid directory scanning
		// in each request by putting the locale list in cache.
		$cache = wfGetCache( CACHE_ANYTHING );
		$key = wfMemcKey( 'uls', 'i18n', 'locales' );
		$result = $cache->get( $key );

		if ( $result ) {
			$vars['wgULSi18nLocales'] = $result;
		} else {
			$mwULSL10nFiles = glob( __DIR__ . '/i18n/*.json' );

			foreach ( $mwULSL10nFiles as $localeFile ) {
				$mwULSL10nLocales[] = basename( $localeFile, '.json' );
			}

			$mwULSL10nFiles = glob( __DIR__ . '/lib/jquery.uls/i18n/*.json' );

			foreach ( $mwULSL10nFiles as $localeFile ) {
				$jqueryULSL10nLocales[] = basename( $localeFile, '.json' );
			}

			$vars['wgULSi18nLocales'] = array(
				// Locales to which jQuery ULS is localized.
				'uls' => $jqueryULSL10nLocales,
				// Locales to which Mediawiki ULS is localized.
				'ext-uls' => $mwULSL10nLocales,
			);

			// Cache it for 1 hour
			$cache->set( $key, $vars['wgULSi18nLocales'], 3600 );
		}
		return true;
	}

	/**
	 * Hook: MakeGlobalVariablesScript
	 * @param array $vars
	 * @param OutputPage $out
	 * @return bool
	 */
	public static function addVariables( &$vars, OutputPage $out ) {
		$vars['wgULSLanguages'] = Language::fetchLanguageNames(
			$out->getLanguage()->getCode(), 'mwfile'
		);
		$vars['wgULSAcceptLanguageList'] = array_keys( $out->getRequest()->getAcceptLang() );

		return true;
	}

	public static function onGetPreferences( $user, &$preferences ) {
		$preferences['uls-preferences'] = array(
			'type' => 'api',
		);

		return true;
	}
}