%PDF-
%PDF-
Mini Shell
Mini Shell
<?php
/**
* Api module for querying MessageGroups.
*
* @file
* @author Niklas Laxström
* @author Harry Burt
* @copyright Copyright © 2012-2013, Harry Burt
* @license GPL-2.0-or-later
*/
/**
* Api module for querying MessageGroups.
*
* @ingroup API TranslateAPI
*/
class ApiQueryMessageGroups extends ApiQueryBase {
public function __construct( $query, $moduleName ) {
parent::__construct( $query, $moduleName, 'mg' );
}
public function execute() {
$params = $this->extractRequestParams();
$filter = $params['filter'];
$groups = [];
// Parameter root as all for all pages subgroups
if ( $params['root'] === 'all' ) {
$allGroups = MessageGroups::getAllGroups();
foreach ( $allGroups as $group ) {
if ( $group instanceof WikiPageMessageGroup ) {
$groups[] = $group;
}
}
} elseif ( $params['format'] === 'flat' ) {
if ( $params['root'] !== '' ) {
$group = MessageGroups::getGroup( $params['root'] );
if ( $group ) {
$groups[$params['root']] = $group;
}
} else {
$groups = MessageGroups::getAllGroups();
// Not sorted by default, so do it now
// Work around php bug: https://bugs.php.net/bug.php?id=50688
MediaWiki\suppressWarnings();
usort( $groups, [ 'MessageGroups', 'groupLabelSort' ] );
MediaWiki\restoreWarnings();
}
} elseif ( $params['root'] !== '' ) {
// format=tree from now on, as it is the only other valid option
$group = MessageGroups::getGroup( $params['root'] );
if ( $group instanceof AggregateMessageGroup ) {
$groups = MessageGroups::subGroups( $group );
// The parent group is the first, ignore it
array_shift( $groups );
}
} else {
$groups = MessageGroups::getGroupStructure();
}
if ( $params['root'] === '' ) {
$dynamicGroups = [];
foreach ( array_keys( MessageGroups::getDynamicGroups() ) as $id ) {
$dynamicGroups[$id] = MessageGroups::getGroup( $id );
}
// Have dynamic groups appear first in the list
$groups = $dynamicGroups + $groups;
}
// Do not list the sandbox group. The code that knows it
// exists can access it directly.
if ( isset( $groups['!sandbox'] ) ) {
unset( $groups['!sandbox'] );
}
$props = array_flip( $params['prop'] );
$result = $this->getResult();
$matcher = new StringMatcher( '', $filter );
/**
* @var MessageGroup $mixed
*/
foreach ( $groups as $mixed ) {
if ( $filter !== [] && !$matcher->match( $mixed->getId() ) ) {
continue;
}
$a = $this->formatGroup( $mixed, $props );
$result->setIndexedTagName( $a, 'group' );
// @todo Add a continue?
$fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $a );
if ( !$fit ) {
// Even if we're not going to give a continue, no point carrying on
// if the result is full
break;
}
}
$result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'group' );
}
/**
* @param array|MessageGroup $mixed
* @param array $props List of props as the array keys
* @param int $depth
* @return array
*/
protected function formatGroup( $mixed, $props, $depth = 0 ) {
$params = $this->extractRequestParams();
$context = $this->getContext();
// Default
$g = $mixed;
$subgroups = [];
// Format = tree and has subgroups
if ( is_array( $mixed ) ) {
$g = array_shift( $mixed );
$subgroups = $mixed;
}
$a = [];
$groupId = $g->getId();
if ( isset( $props['id'] ) ) {
$a['id'] = $groupId;
}
if ( isset( $props['label'] ) ) {
$a['label'] = $g->getLabel( $context );
}
if ( isset( $props['description'] ) ) {
$a['description'] = $g->getDescription( $context );
}
if ( isset( $props['class'] ) ) {
$a['class'] = get_class( $g );
}
if ( isset( $props['namespace'] ) ) {
$a['namespace'] = $g->getNamespace();
}
if ( isset( $props['exists'] ) ) {
$a['exists'] = $g->exists();
}
if ( isset( $props['icon'] ) ) {
$formats = TranslateUtils::getIcon( $g, $params['iconsize'] );
if ( $formats ) {
$a['icon'] = $formats;
}
}
if ( isset( $props['priority'] ) ) {
$priority = MessageGroups::getPriority( $g );
$a['priority'] = $priority ?: 'default';
}
if ( isset( $props['prioritylangs'] ) ) {
$prioritylangs = TranslateMetadata::get( $groupId, 'prioritylangs' );
$a['prioritylangs'] = $prioritylangs ? explode( ',', $prioritylangs ) : false;
}
if ( isset( $props['priorityforce'] ) ) {
$a['priorityforce'] = ( TranslateMetadata::get( $groupId, 'priorityforce' ) === 'on' );
}
if ( isset( $props['workflowstates'] ) ) {
$a['workflowstates'] = $this->getWorkflowStates( $g );
}
Hooks::run(
'TranslateProcessAPIMessageGroupsProperties',
[ &$a, $props, $params, $g ]
);
// Depth only applies to tree format
if ( $depth >= $params['depth'] && $params['format'] === 'tree' ) {
$a['groupcount'] = count( $subgroups );
// Prevent going further down in the three
return $a;
}
// Always empty array for flat format, only sometimes for tree format
if ( $subgroups !== [] ) {
foreach ( $subgroups as $sg ) {
$a['groups'][] = $this->formatGroup( $sg, $props );
}
$result = $this->getResult();
$result->setIndexedTagName( $a['groups'], 'group' );
}
return $a;
}
/**
* Get the workflow states applicable to the given message group
*
* @param MessageGroup $group
* @return bool|array Associative array with states as key and localized state
* labels as values
*/
protected function getWorkflowStates( MessageGroup $group ) {
if ( MessageGroups::isDynamic( $group ) ) {
return false;
}
$stateConfig = $group->getMessageGroupStates()->getStates();
if ( !is_array( $stateConfig ) || $stateConfig === [] ) {
return false;
}
$user = $this->getUser();
foreach ( $stateConfig as $state => $config ) {
if ( is_array( $config ) ) {
// Check if user is allowed to change states generally
$allowed = $user->isAllowed( 'translate-groupreview' );
// Check further restrictions
if ( $allowed && isset( $config['right'] ) ) {
$allowed = $user->isAllowed( $config['right'] );
}
if ( $allowed ) {
$stateConfig[$state]['canchange'] = 1;
}
$stateConfig[$state]['name'] =
$this->msg( "translate-workflow-state-$state" )->text();
}
}
return $stateConfig;
}
public function getAllowedParams() {
$allowedParams = [
'depth' => [
ApiBase::PARAM_TYPE => 'integer',
ApiBase::PARAM_DFLT => 100,
],
'filter' => [
ApiBase::PARAM_TYPE => 'string',
ApiBase::PARAM_DFLT => '',
ApiBase::PARAM_ISMULTI => true,
],
'format' => [
ApiBase::PARAM_TYPE => [ 'flat', 'tree' ],
ApiBase::PARAM_DFLT => 'flat',
],
'iconsize' => [
ApiBase::PARAM_TYPE => 'integer',
ApiBase::PARAM_DFLT => 64,
],
'prop' => [
ApiBase::PARAM_TYPE => array_keys( self::getPropertyList() ),
ApiBase::PARAM_DFLT => 'id|label|description|class|exists',
ApiBase::PARAM_ISMULTI => true,
],
'root' => [
ApiBase::PARAM_TYPE => 'string',
ApiBase::PARAM_DFLT => '',
],
];
Hooks::run( 'TranslateGetAPIMessageGroupsParameterList', [ &$allowedParams ] );
return $allowedParams;
}
/**
* Returns array of key value pairs of properties and their descriptions
*
* @return array
*/
protected static function getPropertyList() {
$properties = [
'id' => ' id - Include id of the group',
'label' => ' label - Include label of the group',
'description' => ' description - Include description of the group',
'class' => ' class - Include class name of the group',
'namespace' =>
' namespace - Include namespace of the group. Not all groups belong ' .
'to a single namespace.',
'exists' =>
' exists - Include self-calculated existence property of the group',
'icon' => ' icon - Include urls to icon of the group',
'priority' => ' priority - Include priority status like discouraged',
'prioritylangs' =>
' prioritylangs - Include preferred languages. If not set, this returns false',
'priorityforce' =>
' priorityforce - Include priority status - is the priority languages ' .
'setting forced',
'workflowstates' =>
' workflowstates - Include the workflow states for the message group',
];
Hooks::run( 'TranslateGetAPIMessageGroupsPropertyDescs', [ &$properties ] );
return $properties;
}
protected function getExamplesMessages() {
return [
'action=query&meta=messagegroups'
=> 'apihelp-query+messagegroups-example-1',
];
}
}
Zerion Mini Shell 1.0