Translate.php

Go to the documentation of this file.

<?php
if ( !defined( 'MEDIAWIKI' ) ) {
    die();
}
define( 'TRANSLATE_VERSION', '2013-10-15' );

$wgExtensionCredits['specialpage'][] = array(
    'path' => __FILE__,
    'name' => 'Translate',
    'version' => TRANSLATE_VERSION,
    'author' => array( 'Niklas Laxström', 'Siebrand Mazeland' ),
    'descriptionmsg' => 'translate-desc',
    'url' => 'https://www.mediawiki.org/wiki/Extension:Translate',
);

$dir = __DIR__;
require_once "$dir/_autoload.php";
// Register extension messages and other localisation.
$wgExtensionMessagesFiles['Translate'] = "$dir/Translate.i18n.php";
$wgExtensionMessagesFiles['FirstSteps'] = "$dir/FirstSteps.i18n.php";
$wgExtensionMessagesFiles['PageTranslation'] = "$dir/PageTranslation.i18n.php";
$wgExtensionMessagesFiles['TranslateGroupDescriptions'] =
    "$dir/TranslateGroupDescriptions.i18n.php";
$wgExtensionMessagesFiles['TranslateSearch'] = "$dir/TranslateSearch.i18n.php";
$wgExtensionMessagesFiles['TranslateSandbox'] = "$dir/TranslateSandbox.i18n.php";
$wgExtensionMessagesFiles['TranslateAlias'] = "$dir/Translate.alias.php";

// Register initialization code
$wgExtensionFunctions[] = 'TranslateHooks::setupTranslate';
$wgHooks['CanonicalNamespaces'][] = 'TranslateHooks::setupNamespaces';
$wgHooks['UnitTestsList'][] = 'TranslateHooks::setupUnitTests';
$wgHooks['LoadExtensionSchemaUpdates'][] = 'TranslateHooks::schemaUpdates';
$wgHooks['ParserTestTables'][] = 'TranslateHooks::parserTestTables';
$wgHooks['PageContentLanguage'][] = 'TranslateHooks::onPageContentLanguage';

// Register special pages into MediaWiki
$wgSpecialPages['Translate'] = 'SpecialTranslate';
$wgSpecialPageGroups['Translate'] = 'wiki';
$wgSpecialPages['Translations'] = 'SpecialTranslations';
$wgSpecialPageGroups['Translations'] = 'pages';
// Disabled by default
// $wgSpecialPages['Magic'] = 'SpecialMagic';
$wgSpecialPageGroups['Magic'] = 'wiki';
$wgSpecialPages['TranslationStats'] = 'SpecialTranslationStats';
$wgSpecialPageGroups['TranslationStats'] = 'wiki';
$wgSpecialPages['LanguageStats'] = 'SpecialLanguageStats';
$wgSpecialPageGroups['LanguageStats'] = 'wiki';
$wgSpecialPages['MessageGroupStats'] = 'SpecialMessageGroupStats';
$wgSpecialPageGroups['MessageGroupStats'] = 'wiki';
$wgSpecialPages['ImportTranslations'] = 'SpecialImportTranslations';
$wgSpecialPageGroups['ImportTranslations'] = 'wiki';
$wgSpecialPages['ManageMessageGroups'] = 'SpecialManageGroups';
$wgSpecialPageGroups['ManageMessageGroups'] = 'wiki';
// Unlisted special page; does not need $wgSpecialPageGroups.
$wgSpecialPages['FirstSteps'] = 'SpecialFirstSteps';
$wgSpecialPages['SupportedLanguages'] = 'SpecialSupportedLanguages';
$wgSpecialPageGroups['SupportedLanguages'] = 'wiki';
// Unlisted special page; does not need $wgSpecialPageGroups.
$wgSpecialPages['MyLanguage'] = 'SpecialMyLanguage';
$wgSpecialPages['AggregateGroups'] = 'SpecialAggregateGroups';
$wgSpecialPageGroups['AggregateGroups'] = 'wiki';
$wgSpecialPages['SearchTranslations'] = 'SpecialSearchTranslations';
$wgSpecialPageGroups['SearchTranslations'] = 'wiki';
$wgSpecialPages['TranslateSandbox'] = 'SpecialTranslateSandbox';
$wgSpecialPages['TranslationStash'] = 'SpecialTranslationStash';
$wgSpecialPageGroups['TranslationStash'] = 'wiki';

// API
$wgAPIGeneratorModules['messagecollection'] = 'ApiQueryMessageCollection';
$wgAPIListModules['messagecollection'] = 'ApiQueryMessageCollection';
$wgAPIMetaModules['languagestats'] = 'ApiQueryLanguageStats';
$wgAPIMetaModules['messagegroups'] = 'ApiQueryMessageGroups';
$wgAPIMetaModules['messagegroupstats'] = 'ApiQueryMessageGroupStats';
$wgAPIMetaModules['messagetranslations'] = 'ApiQueryMessageTranslations';
$wgAPIModules['aggregategroups'] = 'ApiAggregateGroups';
$wgAPIModules['groupreview'] = 'ApiGroupReview';
$wgAPIModules['hardmessages'] = 'ApiHardMessages';
$wgAPIModules['translatesandbox'] = 'ApiTranslateSandbox';
$wgAPIModules['translateuser'] = 'ApiTranslateUser';
$wgAPIModules['translationaids'] = 'ApiTranslationAids';
$wgAPIModules['translationreview'] = 'ApiTranslationReview';
$wgAPIModules['translationstash'] = 'ApiTranslationStash';
$wgAPIModules['ttmserver'] = 'ApiTTMServer';

// Before MW 1.20
$wgHooks['APIQueryInfoTokens'][] = 'ApiTranslationReview::injectTokenFunction';
$wgHooks['APIQueryInfoTokens'][] = 'ApiGroupReview::injectTokenFunction';
$wgHooks['APIQueryInfoTokens'][] = 'ApiAggregateGroups::injectTokenFunction';
$wgHooks['APIQueryInfoTokens'][] = 'ApiHardMessages::injectTokenFunction';
$wgHooks['APIQueryInfoTokens'][] = 'ApiTranslateSandbox::injectTokenFunction';
// After MW 1.20
$wgHooks['ApiTokensGetTokenTypes'][] = 'ApiTranslationReview::injectTokenFunction';
$wgHooks['ApiTokensGetTokenTypes'][] = 'ApiGroupReview::injectTokenFunction';
$wgHooks['ApiTokensGetTokenTypes'][] = 'ApiAggregateGroups::injectTokenFunction';
$wgHooks['ApiTokensGetTokenTypes'][] = 'ApiHardMessages::injectTokenFunction';
$wgHooks['ApiTokensGetTokenTypes'][] = 'ApiTranslateSandbox::injectTokenFunction';
$wgHooks['ApiTokensGetTokenTypes'][] = 'ApiTranslationStash::injectTokenFunction';
// Register hooks.
$wgHooks['EditPage::showEditForm:initial'][] = 'TranslateEditAddons::addTools';
$wgHooks['SkinTemplateNavigation'][] = 'TranslateEditAddons::addNavigationTabs';
$wgHooks['AlternateEdit'][] = 'TranslateEditAddons::intro';
$wgHooks['EditPageBeforeEditButtons'][] = 'TranslateEditAddons::buttonHack';
$wgHooks['EditPage::showEditForm:fields'][] = 'TranslateEditAddons::keepFields';
$wgHooks['LanguageGetTranslatedLanguageNames'][] =
    'TranslateHooks::translateMessageDocumentationLanguage';
$wgHooks['TranslateSupportedLanguages'][] =
    'TranslateHooks::translateMessageDocumentationLanguage';
$wgHooks['ArticlePrepareTextForEdit'][] = 'TranslateEditAddons::disablePreSaveTransform';
// Prevent translations creating bogus categories
$wgHooks['LinksUpdate'][] = 'TranslateHooks::preventCategorization';
// Fuzzy tags for speed.
if ( !defined( 'MW_SUPPORTS_CONTENTHANDLER' ) ) {
    // BC 1.20
    $wgHooks['ArticleSaveComplete'][] = 'TranslateEditAddons::onSave';
} else {
    $wgHooks['PageContentSaveComplete'][] = 'TranslateEditAddons::onSave';
}

$wgHooks['Translate:newTranslation'][] = 'TranslateEditAddons::updateTransverTag';

$wgHooks['SkinTemplateNavigation::SpecialPage'][] = 'SpecialTranslate::tabify';
$wgHooks['SkinTemplateNavigation::SpecialPage'][] = 'SpecialManageGroups::tabify';

// Custom preferences
$wgDefaultUserOptions['translate'] = 0;
$wgDefaultUserOptions['translate-editlangs'] = 'default';
$wgDefaultUserOptions['translate-jsedit'] = 1;
$wgDefaultUserOptions['translate-recent-groups'] = '';
$wgHooks['GetPreferences'][] = 'TranslatePreferences::onGetPreferences';
$wgHooks['GetPreferences'][] = 'TranslatePreferences::translationAssistLanguages';
$wgHooks['GetPreferences'][] = 'TranslatePreferences::translationJsedit';

// Recent changes filters
$wgHooks['SpecialRecentChangesQuery'][] = 'TranslateRcFilter::translationFilter';
$wgHooks['SpecialRecentChangesPanel'][] = 'TranslateRcFilter::translationFilterForm';
$wgHooks['SkinTemplateToolboxEnd'][] = 'TranslateToolbox::toolboxAllTranslations';

// Translation memory related
$wgHooks['ArticleDeleteComplete'][] = 'TTMServer::onDelete';
$wgHooks['TranslateEventMessageMembershipChange'][] = 'TTMServer::onGroupChange';

// Translation display related
$wgHooks['ArticleContentOnDiff'][] = 'TranslateEditAddons::displayOnDiff';

// Search profile
$wgHooks['SpecialSearchProfiles'][] = 'TranslateHooks::searchProfile';
$wgHooks['SpecialSearchProfileForm'][] = 'TranslateHooks::searchProfileForm';
$wgHooks['SpecialSearchSetupEngine'][] = 'TranslateHooks::searchProfileSetupEngine';

$wgHooks['LinkBegin'][] = 'SpecialMyLanguage::linkfix';

// Stats table manipulation
$wgHooks['Translate:MessageGroupStats:isIncluded'][] = 'TranslateHooks::hideDiscouragedFromStats';
$wgHooks['Translate:MessageGroupStats:isIncluded'][] = 'TranslateHooks::hideRestrictedFromStats';

$wgHooks['MakeGlobalVariablesScript'][] = 'TranslateHooks::addConfig';

// Sandbox
$wgDefaultUserOptions['translate-sandbox'] = '';
$wgHooks['GetPreferences'][] = 'TranslateSandbox::onGetPreferences';
$wgHooks['UserGetRights'][] = 'TranslateSandbox::enforcePermissions';
$wgHooks['ApiCheckCanExecute'][] = 'TranslateSandbox::onApiCheckCanExecute';

// Internal event listeners
$wgHooks['TranslateEventTranslationEdit'][] = 'MessageGroupStats::clear';
$wgHooks['TranslateEventTranslationReview'][] = 'MessageGroupStats::clear';
$wgHooks['TranslateEventTranslationEdit'][] = 'MessageGroupStatesUpdaterJob::onChange';
$wgHooks['TranslateEventTranslationReview'][] = 'MessageGroupStatesUpdaterJob::onChange';

// New rights
$wgAvailableRights[] = 'translate';
$wgAvailableRights[] = 'translate-import';
$wgAvailableRights[] = 'translate-manage';
$wgAvailableRights[] = 'translate-messagereview';
$wgAvailableRights[] = 'translate-groupreview';
$wgAvailableRights[] = 'translate-sandboxmanage';

// New rights group
$wgGroupPermissions['translate-proofr']['translate-messagereview'] = true;
$wgAddGroups['translate-proofr'] = array( 'translate-proofr' );

// Logs. More logs are defined in TranslateHooks::setupTranslate
$wgLogTypes[] = 'translationreview';
$wgLogActionsHandlers['translationreview/message'] = 'TranslateLogFormatter';
$wgLogActionsHandlers['translationreview/group'] = 'TranslateLogFormatter';

// New jobs
$wgJobClasses['MessageIndexRebuildJob'] = 'MessageIndexRebuildJob';
$wgJobClasses['MessageUpdateJob'] = 'MessageUpdateJob';
$wgJobClasses['MessageGroupStatesUpdaterJob'] = 'MessageGroupStatesUpdaterJob';
$wgJobClasses['TTMServerMessageUpdateJob'] = 'TTMServerMessageUpdateJob';
$wgJobClasses['TranslateSandboxReminderJob'] = 'TranslateSandboxReminderJob';

require "$dir/Resources.php";
# == Configuration variables ==

# === Basic configuration ===
# <source lang=php>

$wgTranslateDocumentationLanguageCode = false;

$wgTranslateFuzzyBotName = 'FuzzyBot';

$wgTranslateNewsletterPreference = false;

$wgTranslateLanguageFallbacks = array();

if ( !defined( 'TRANSLATE_FUZZY' ) ) {
    define( 'TRANSLATE_FUZZY', '!!FUZZY!!' );
}

$wgTranslateTranslationServices = array();
$wgTranslateTranslationServices['TTMServer'] = array(
    'database' => false, // Passed to wfGetDB
    'cutoff' => 0.75,
    'type' => 'ttmserver',
    'public' => false,
);
$wgTranslateTranslationServices['Microsoft'] = array(
    'url' => 'http://api.microsofttranslator.com/V2/Http.svc/Translate',
    'key' => null,
    'timeout' => 3,
    'type' => 'microsoft',
);
$wgTranslateTranslationServices['Apertium'] = array(
    'url' => 'http://api.apertium.org/json/translate',
    'pairs' => 'http://api.apertium.org/json/listPairs',
    'key' => null,
    'timeout' => 3,
    'type' => 'apertium',
);
$wgTranslateTranslationServices['Yandex'] = array(
    'url' => 'https://translate.yandex.net/api/v1.5/tr.json/translate',
    'key' => null,
    'pairs' => 'https://translate.yandex.net/api/v1.5/tr.json/getLangs',
    'timeout' => 3,
    'langorder' => array( 'en', 'ru', 'uk', 'de', 'fr', 'pl', 'it', 'es', 'tr' ),
    'langlimit' => 1,
    'type' => 'yandex',
);
/* Example configuration for remote TTMServer
$wgTranslateTranslationServices['example'] = array(
    'url' => 'http://example.com/w/api.php',
    'viewurl' => '//example.com/wiki/',
    'displayname' => 'example.com',
    'cutoff' => 0.75,
    'timeout-sync' => 4,
    'timeout-async' => 4,
    'type' => 'ttmserver',
    'class' => 'RemoteTTMServer',
);
*/

$wgTranslateTasks = array(
    'view' => 'ViewMessagesTask',
    'untranslated' => 'ViewUntranslatedTask',
    'optional' => 'ViewOptionalTask',
    'acceptqueue' => 'AcceptQueueMessagesTask',
    'reviewall' => 'ReviewAllMessagesTask',
    'export-as-po' => 'ExportasPoMessagesTask',
    'export-to-file' => 'ExportToFileMessagesTask',
    'custom' => 'CustomFilteredMessagesTask',
);

$wgTranslateSupportUrl = false;

$wgTranslatePermissionUrl = 'Project:Translator';

# </source>
# === Page translation feature ===
# <source lang=php>

$wgEnablePageTranslation = true;

$wgPageTranslationNamespace = 1198;

$wgTranslatePageTranslationULS = false;

# </source>
# === Message group configuration ===
# <source lang=php>

$wgTranslateBlacklist = array();

$wgTranslateCheckBlacklist = false;

$wgTranslateAuthorBlacklist = array();
$wgTranslateAuthorBlacklist[] = array( 'black', '/^.*;.*;.*Bot$/Ui' );

$wgTranslateMessageNamespaces = array( NS_MEDIAWIKI );

$wgTranslateCC = array();

$wgTranslateGroupRoot = '/var/www/externals';

$wgTranslateGroupFiles = array();

$wgTranslateWorkflowStates = false;

# </source>
# === System setup related configuration ===
# <source lang=php>

$wgTranslateExtensionDirectory = "$IP/extensions/";

$wgTranslateCacheDirectory = false;

$wgTranslateMessageIndex = array( 'DatabaseMessageIndex' );
// $wgTranslateMessageIndex = array( 'SerializedMessageIndex' );
// $wgTranslateMessageIndex = array( 'CDBMessageIndex' );

$wgTranslateDelayedMessageIndexRebuild = false;

# </source>
# ==== PHPlot ====
# <source lang=php>

$wgTranslatePHPlot = false;

$wgTranslatePHPlotFont = '/usr/share/fonts/truetype/ttf-dejavu/DejaVuSans.ttf';

# </source>
# ==== YAML driver ====
# <source lang=php>

$wgTranslateYamlLibrary = 'spyc';

# </source>
# ==== Sandbox ====
# <source lang=php>

$wgTranslateUseSandbox = false;

$wgTranslateSandboxPromotedGroup = false;

$wgTranslateSandboxSuggestions = array();

$wgTranslateSandboxLimit = 20;

# </source>
# === Unsorted ===
# <source lang=php>

$wgTranslateUsePreSaveTransform = false;

$wgTranslateRcFilterDefault = 'filter';

$wgTranslateTestTTMServer = null;

$wgTranslateUseTux = true;

$wgTranslateTestUsers = array();

# </source>

function wfAddNamespace( $id, $name ) {
    global $wgExtraNamespaces, $wgContentNamespaces, $wgTranslateMessageNamespaces,
        $wgNamespaceProtection, $wgNamespacesWithSubpages, $wgNamespacesToBeSearchedDefault;

    $constant = strtoupper( "NS_$name" );

    define( $constant, $id );
    define( $constant . '_TALK', $id + 1 );

    $wgExtraNamespaces[$id] = $name;
    $wgExtraNamespaces[$id + 1] = $name . '_talk';

    $wgContentNamespaces[] = $id;
    $wgTranslateMessageNamespaces[] = $id;

    $wgNamespacesWithSubpages[$id] = true;
    $wgNamespacesWithSubpages[$id + 1] = true;

    $wgNamespaceProtection[$id] = array( 'translate' );

    $wgNamespacesToBeSearchedDefault[$id] = true;
}