http://www.mediawiki.org/wiki/Special:Code/MediaWiki/73737
Revision: 73737
Author: nikerabbit
Date: 2010-09-25 08:58:03 +0000 (Sat, 25 Sep 2010)
Log Message:
-----------
First Api module for Translate Extension
Modified Paths:
--------------
trunk/extensions/Translate/MessageCollection.php
trunk/extensions/Translate/README
trunk/extensions/Translate/Translate.php
trunk/extensions/Translate/_autoload.php
Added Paths:
-----------
trunk/extensions/Translate/api/
trunk/extensions/Translate/api/ApiQueryMessageCollection.php
Modified: trunk/extensions/Translate/MessageCollection.php
===================================================================
--- trunk/extensions/Translate/MessageCollection.php 2010-09-25 08:23:47 UTC
(rev 73736)
+++ trunk/extensions/Translate/MessageCollection.php 2010-09-25 08:58:03 UTC
(rev 73737)
@@ -2,7 +2,6 @@
/**
* This file contains classes that implements message collections.
*
- * @ingroup Extensions
* @file
* @author Niklas Laxström
* @copyright Copyright © 2007-2010, Niklas Laxström
@@ -252,6 +251,17 @@
}
}
+ public static function getAvailableFilters() {
+ return array(
+ 'fuzzy',
+ 'optional',
+ 'ignored',
+ 'hastranslation',
+ 'changed',
+ 'translated',
+ );
+ }
+
/**
* Really apply a filter. Some filters need multiple conditions.
* @param $filter \string Filter name.
Modified: trunk/extensions/Translate/README
===================================================================
--- trunk/extensions/Translate/README 2010-09-25 08:23:47 UTC (rev 73736)
+++ trunk/extensions/Translate/README 2010-09-25 08:58:03 UTC (rev 73737)
@@ -31,6 +31,8 @@
== Change log ==
=== Changes in ??? ===
+* 2010-09-25
+- First Api Query Module messagecollection
* 2010-08-23
- Fixed multiple bugs in Special:TranslationStats
* 2010-08-20
Modified: trunk/extensions/Translate/Translate.php
===================================================================
--- trunk/extensions/Translate/Translate.php 2010-09-25 08:23:47 UTC (rev
73736)
+++ trunk/extensions/Translate/Translate.php 2010-09-25 08:58:03 UTC (rev
73737)
@@ -77,6 +77,9 @@
// Unlisted special page; does not need $wgSpecialPageGroups.
$wgSpecialPages['MyLanguage'] = 'SpecialMyLanguage';
+// API
+$wgAPIListModules['messagecollection'] = 'ApiQueryMessageCollection';
+
// Register hooks.
$wgHooks['EditPage::showEditForm:initial'][] = 'TranslateEditAddons::addTools';
$wgHooks['OutputPageBeforeHTML'][] = 'TranslateEditAddons::addNavigation';
Modified: trunk/extensions/Translate/_autoload.php
===================================================================
--- trunk/extensions/Translate/_autoload.php 2010-09-25 08:23:47 UTC (rev
73736)
+++ trunk/extensions/Translate/_autoload.php 2010-09-25 08:58:03 UTC (rev
73737)
@@ -172,3 +172,11 @@
$wgAutoloadClasses['RawHtml'] = $dir . 'utils/Html.php';
$wgAutoloadClasses['TagContainer'] = $dir . 'utils/Html.php';
/*...@}*/
+
+/**
+ * @name API modules
+ * @{
+ */
+$wgAutoloadClasses['ApiQueryMessageCollection'] = $dir .
'api/ApiQueryMessageCollection.php';
+
+/*...@}*/
Added: trunk/extensions/Translate/api/ApiQueryMessageCollection.php
===================================================================
--- trunk/extensions/Translate/api/ApiQueryMessageCollection.php
(rev 0)
+++ trunk/extensions/Translate/api/ApiQueryMessageCollection.php
2010-09-25 08:58:03 UTC (rev 73737)
@@ -0,0 +1,192 @@
+<?php
+/**
+ * Api module for querying MessageCollection.
+ *
+ * @file
+ * @author Niklas Laxström
+ * @copyright Copyright © 2007-2010, Niklas Laxström
+ * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License
2.0 or later
+ */
+
+/**
+ * Api module for querying MessageCollection.
+ *
+ * @ingroup API TranslateAPI
+ */
+class ApiQueryMessageCollection extends ApiQueryGeneratorBase {
+
+ public function __construct( $query, $moduleName ) {
+ parent::__construct( $query, $moduleName, 'mc' );
+ }
+
+ public function execute() {
+ $this->run();
+ }
+
+ public function getCacheMode( $params ) {
+ return 'public';
+ }
+
+ public function executeGenerator( $resultPageSet ) {
+ $this->run( $resultPageSet );
+ }
+
+ private function run( $resultPageSet = null ) {
+ $db = $this->getDB();
+ $params = $this->extractRequestParams();
+
+ $group = MessageGroups::getGroup( $params['group'] );
+ $messages = $group->initCollection( $params['language'] );
+ $messages->setInFile( $group->load( $params['language'] ) );
+
+ foreach ( $params['filter'] as $filter ) {
+ /* The filtering params here are swapped wrt
MessageCollection.
+ * There (fuzzy) means do not show fuzzy, which is the
same as !fuzzy
+ * here and fuzzy here means (fuzzy, false) there. */
+ if ( $filter[0] === '!' ) {
+ $messages->filter( substr( $filter, 1 ) );
+ } else {
+ $messages->filter( $filter, false );
+ }
+ }
+
+ $messages->slice( $params['offset'], $params['limit'] + 1 );
+
+
+ $messages->loadTranslations();
+
+ $result = $this->getResult();
+ $pages = array();
+ $count = 0;
+
+ $props = array_flip( $params['prop'] );
+ foreach ( $messages->keys() as $key => $dbkey ) {
+ if ( ++$count > $params['limit'] ) {
+ $this->setContinueEnumParameter(
'offset', $params['offset'] + $count - 1 );
+ break;
+ }
+
+ if ( is_null( $resultPageSet ) ) {
+ $data = $this->extractMessageData( $result,
$props, $messages[$key] );
+ $fit = $result->addValue( array( 'query',
$this->getModuleName() ), null, $data );
+ if ( !$fit ) {
+ $this->setContinueEnumParameter(
'offset', $params['offset'] + $count - 1 );
+ break;
+ }
+ } else {
+ $pages[] = Title::makeTitleSafe(
$group->getNamespace(), $dbkey );
+ }
+ }
+
+ if ( is_null( $resultPageSet ) ) {
+ $result->setIndexedTagName_internal( array( 'query',
$this->getModuleName() ), 'message' );
+ } else {
+ $resultPageSet->populateFromTitles( $pages );
+ }
+
+ }
+
+ public function extractMessageData( $result, $props, $message ) {
+ $data['key'] = $message->key();
+ if ( isset( $props['definition'] ) ) {
+ $data['definition'] = $message->definition();
+ }
+ if ( isset( $props['translation'] ) ) {
+ $data['translation'] = $message->translation();
+ }
+ if ( isset( $props['tags'] ) ) {
+ $data['tags'] = $message->getTags();
+ $result->setIndexedTagName( $data['tags'], 'tag' );
+ }
+ return $data;
+ }
+
+ public function getFilters() {
+ $basic = MessageCollection::getAvailableFilters();
+ $full = array();
+ foreach ( $basic as $filter ) {
+ $full[] = $filter;
+ $full[] = "!$filter";
+ }
+ return $full;
+ }
+
+ public function getAllowedParams() {
+ return array(
+ 'group' => array(
+ ApiBase::PARAM_TYPE => array_keys(
MessageGroups::singleton()->getGroups() ),
+ ApiBase::PARAM_REQUIRED => true,
+ ),
+ 'language' => array(
+ ApiBase::PARAM_TYPE => 'string',
+ ApiBase::PARAM_DFLT => 'en',
+ ),
+ 'limit' => array(
+ ApiBase::PARAM_DFLT => 500,
+ ApiBase::PARAM_TYPE => 'limit',
+ ApiBase::PARAM_MIN => 1,
+ ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
+ ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
+ ),
+ 'offset' => array(
+ ApiBase::PARAM_DFLT => 0,
+ ApiBase::PARAM_TYPE => 'integer',
+ ),
+ 'filter' => array(
+ ApiBase::PARAM_TYPE => $this->getFilters(),
+ ApiBase::PARAM_DFLT => '!optional|!ignored',
+ ApiBase::PARAM_ISMULTI => true,
+ ),
+ 'prop' => array(
+ ApiBase::PARAM_TYPE => array( 'definition',
'translation', 'tags' ),
+ ApiBase::PARAM_DFLT => 'definition|translation',
+ ApiBase::PARAM_ISMULTI => true,
+ ),
+ );
+ }
+
+ public function getParamDescription() {
+ return array(
+ 'group' => 'Message group',
+ 'language' => 'Language code',
+ 'offset' => 'How many messages to skip (after
filtering)',
+ 'limit' => 'How many messages to show (after
filtering)',
+ 'prop' => array(
+ 'Which properties to get',
+ 'definition - message definition',
+ 'translation - current translation',
+ 'tags - message tags, like optional,
ignored and fuzzy',
+ 'author - last author of the message',
+ ),
+ 'filter' => array(
+ 'Message collection filters. Use ! to negate
condition. For example !fuzzy means list only all non-fuzzy messages. Filters
are applied in the order given.',
+ 'fuzzy - messages with fuzzy tag',
+ 'optional - messages which should be
translated only if changes are necessary',
+ 'ignored - messages which are never
translated',
+ 'hastranslation - messages which have a
translation regardless if it is fuzzy or not',
+ 'translated - messages which have a
translation which is not fuzzy',
+ 'changed - messages which has been
translated or changed since last export',
+ ),
+ );
+ }
+
+ public function getDescription() {
+ return 'Query MessageCollection about translations';
+ }
+
+ protected function getExamples() {
+ $groups = MessageGroups::singleton()->getGroups();
+ $group = key( $groups );
+
+ return array(
+ 'api.php?action=query&meta=siteinfo&siprop=languages
List of support languages',
+
"api.php?action=query&list=messagecollection&mcgroup=$group List of
non-optional message definitions",
+
"api.php?action=query&list=messagecollection&mcgroup=$group&mclanguage=fi&mcprop=definition|translation|tags&mcfilter=optional
List of optional messages in Finnish with tags",
+
"api.php?action=query&generator=messagecollection&gmcgroup=$group&gmclanguage=nl&prop=revisions
More information about latest translation revisions",
+ );
+ }
+
+ public function getVersion() {
+ return __CLASS__ . ': $Id$';
+ }
+}
Property changes on:
trunk/extensions/Translate/api/ApiQueryMessageCollection.php
___________________________________________________________________
Added: svn:keywords
+ Id
Added: svn:eol-style
+ native
_______________________________________________
MediaWiki-CVS mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-cvs
