diff options
Diffstat (limited to 'MLEB/Translate/api/ApiAggregateGroups.php')
| -rw-r--r-- | MLEB/Translate/api/ApiAggregateGroups.php | 305 |
1 files changed, 305 insertions, 0 deletions
diff --git a/MLEB/Translate/api/ApiAggregateGroups.php b/MLEB/Translate/api/ApiAggregateGroups.php new file mode 100644 index 00000000..f3c30548 --- /dev/null +++ b/MLEB/Translate/api/ApiAggregateGroups.php @@ -0,0 +1,305 @@ +<?php +/** + * API module for managing aggregate message groups + * @file + * @author Santhosh Thottingal + * @author Niklas Laxström + * @copyright Copyright © 2012-2013, Santhosh Thottingal + * @license GPL-2.0+ + */ + +/** + * API module for managing aggregate message groups + * Only supports aggregate message groups defined inside the wiki. + * Aggregate message group defined in YAML configuration cannot be altered. + * + * @ingroup API TranslateAPI + */ +class ApiAggregateGroups extends ApiBase { + protected static $right = 'translate-manage'; + protected static $salt = 'translate-manage'; + + public function execute() { + if ( !$this->getUser()->isAllowed( self::$right ) ) { + $this->dieUsage( 'Permission denied', 'permissiondenied' ); + } + + $params = $this->extractRequestParams(); + $action = $params['do']; + $output = array(); + if ( $action === 'associate' || $action === 'dissociate' ) { + // Group is mandatory only for these two actions + if ( !isset( $params['group'] ) ) { + $this->dieUsageMsg( array( 'missingparam', 'group' ) ); + } + if ( !isset( $params['aggregategroup'] ) ) { + $this->dieUsageMsg( array( 'missingparam', 'aggregategroup' ) ); + } + $aggregateGroup = $params['aggregategroup']; + $subgroups = TranslateMetadata::getSubgroups( $aggregateGroup ); + if ( count( $subgroups ) === 0 ) { + // For newly created groups the subgroups value might be empty, + // but check that. + if ( TranslateMetadata::get( $aggregateGroup, 'name' ) === false ) { + $this->dieUsage( 'Invalid aggregate message group', 'invalidaggregategroup' ); + } + $subgroups = array(); + } + + $subgroupId = $params['group']; + $group = MessageGroups::getGroup( $subgroupId ); + + // Add or remove from the list + if ( $action === 'associate' ) { + if ( !$group instanceof WikiPageMessageGroup ) { + $this->dieUsage( 'Group does not exist or invalid', 'invalidgroup' ); + } + + $subgroups[] = $subgroupId; + $subgroups = array_unique( $subgroups ); + } elseif ( $action === 'dissociate' ) { + // Allow removal of non-existing groups + $subgroups = array_flip( $subgroups ); + unset( $subgroups[$subgroupId] ); + $subgroups = array_flip( $subgroups ); + } + + TranslateMetadata::setSubgroups( $aggregateGroup, $subgroups ); + + $logParams = array( + 'aggregategroup' => TranslateMetadata::get( $aggregateGroup, 'name' ), + 'aggregategroup-id' => $aggregateGroup, + ); + + /* Note that to allow removing no longer existing groups from + * aggregate message groups, the message group object $group + * might not always be available. In this case we need to fake + * some title. */ + $title = $group ? + $group->getTitle() : + Title::newFromText( "Special:Translate/$subgroupId" ); + + $entry = new ManualLogEntry( 'pagetranslation', $action ); + $entry->setPerformer( $this->getUser() ); + $entry->setTarget( $title ); + // @todo + // $entry->setComment( $comment ); + $entry->setParameters( $logParams ); + + $logid = $entry->insert(); + $entry->publish( $logid ); + } elseif ( $action === 'remove' ) { + if ( !isset( $params['aggregategroup'] ) ) { + $this->dieUsageMsg( array( 'missingparam', 'aggregategroup' ) ); + } + TranslateMetadata::deleteGroup( $params['aggregategroup'] ); + // @todo Logging + + } elseif ( $action === 'add' ) { + if ( !isset( $params['groupname'] ) ) { + $this->dieUsageMsg( array( 'missingparam', 'groupname' ) ); + } + $name = trim( $params['groupname'] ); + if ( strlen( $name ) === 0 ) { + $this->dieUsage( 'Invalid aggregate message group name', 'invalidaggregategroupname' ); + } + + if ( !isset( $params['groupdescription'] ) ) { + $this->dieUsageMsg( array( 'missingparam', 'groupdescription' ) ); + } + $desc = trim( $params['groupdescription'] ); + + $aggregateGroupId = self::generateAggregateGroupId( $name ); + + // Throw error if group already exists + $nameExists = MessageGroups::labelExists( $name ); + if ( $nameExists ) { + $this->dieUsage( 'Message group already exists', 'duplicateaggregategroup' ); + } + + // ID already exists- Generate a new ID by adding a number to it. + $idExists = MessageGroups::getGroup( $aggregateGroupId ); + if ( $idExists ) { + $i = 1; + while( $idExists ) { + $tempId = $aggregateGroupId . "-" . $i; + $idExists = MessageGroups::getGroup( $tempId ); + $i++; + } + $aggregateGroupId = $tempId; + } + + TranslateMetadata::set( $aggregateGroupId, 'name', $name ); + TranslateMetadata::set( $aggregateGroupId, 'description', $desc ); + TranslateMetadata::setSubgroups( $aggregateGroupId, array() ); + + // Once new aggregate group added, we need to show all the pages that can be added to that. + $output['groups'] = self::getAllPages(); + $output['aggregategroupId'] = $aggregateGroupId; + // @todo Logging + } elseif ( $action === 'update' ) { + if ( !isset( $params['groupname'] ) ) { + $this->dieUsageMsg( array( 'missingparam', 'groupname' ) ); + } + $name = trim( $params['groupname'] ); + if ( strlen( $name ) === 0 ) { + $this->dieUsage( 'Invalid aggregate message group name', 'invalidaggregategroupname' ); + } + $desc = trim( $params['groupdescription'] ); + $aggregateGroupId = $params['aggregategroup']; + + $oldName = TranslateMetadata::get( $aggregateGroupId, 'name' ); + $oldDesc = TranslateMetadata::get( $aggregateGroupId, 'description' ); + + // Error if the label exists already + $exists = MessageGroups::labelExists( $name ); + if ( $exists && $oldName !== $name ) { + $this->dieUsage( 'Message group name already exists', 'duplicateaggregategroup' ); + } + + if ( $oldName === $name && $oldDesc === $desc ) { + $this->dieUsage( 'Invalid update', 'invalidupdate' ); + } + TranslateMetadata::set( $aggregateGroupId, 'name', $name ); + TranslateMetadata::set( $aggregateGroupId, 'description', $desc ); + } + + // If we got this far, nothing has failed + $output['result'] = 'ok'; + $this->getResult()->addValue( null, $this->getModuleName(), $output ); + // Cache needs to be cleared after any changes to groups + MessageGroups::clearCache(); + MessageIndexRebuildJob::newJob()->insert(); + } + + protected function generateAggregateGroupId( $aggregateGroupName, $prefix = "agg-" ) { + // The database field has maximum limit of 200 bytes + if ( strlen( $aggregateGroupName ) + strlen( $prefix ) >= 200 ) { + return $prefix . substr( sha1( $aggregateGroupName ), 0, 5 ); + } else { + $pattern = '/[\x00-\x1f\x23\x27\x2c\x2e\x3c\x3e\x5b\x5d\x7b\x7c\x7d\x7f\s]+/i'; + return $prefix . preg_replace( $pattern, '_', $aggregateGroupName ); + } + } + + public function isWriteMode() { + return true; + } + + public function getTokenSalt() { + return self::$salt; + } + + public function needsToken() { + return 'csrf'; + } + + // This function maintains backwards compatibility with self::getToken() + // below. If salt is removed from self::getToken() and nothing else (e.g. + // JS) generates the token directly, this could probably be removed. + protected function getWebUITokenSalt( array $params ) { + return self::$salt; + } + + public function getAllowedParams() { + return array( + 'do' => array( + ApiBase::PARAM_TYPE => array( 'associate', 'dissociate', 'remove', 'add', 'update' ), + ApiBase::PARAM_REQUIRED => true, + ), + 'aggregategroup' => array( + ApiBase::PARAM_TYPE => 'string', + ), + 'group' => array( + // Not providing list of values, to allow dissociation of unknown groups + ApiBase::PARAM_TYPE => 'string', + ), + 'groupname' => array( + ApiBase::PARAM_TYPE => 'string', + ), + 'groupdescription' => array( + ApiBase::PARAM_TYPE => 'string', + ), + 'token' => array( + ApiBase::PARAM_TYPE => 'string', + ApiBase::PARAM_REQUIRED => false, + ), + ); + } + + /** + * @deprecated since MediaWiki core 1.25 + */ + public function getParamDescription() { + $action = TranslateUtils::getTokenAction( 'aggregategroups' ); + + return array( + 'do' => 'What to do with aggregate message group', + 'group' => 'Message group id', + 'aggregategroup' => 'Aggregate message group id', + 'groupname' => 'Aggregate message group name', + 'groupdescription' => 'Aggregate message group description', + 'token' => "A token previously acquired with $action", + ); + } + + /** + * @deprecated since MediaWiki core 1.25 + */ + public function getDescription() { + return 'Manage aggregate message groups. You can add and remove aggregate message' . + 'groups and associate or dissociate message groups from them (one at a time).'; + } + + /** + * @deprecated since MediaWiki core 1.25 + */ + public function getExamples() { + return array( + "api.php?action=aggregategroups&do=associate&group=groupId&aggregategroup=aggregateGroupId", + ); + } + + /** + * @see ApiBase::getExamplesMessages() + */ + protected function getExamplesMessages() { + return array( + 'action=aggregategroups&do=associate&group=groupId&aggregategroup=aggregateGroupId' + => 'apihelp-aggregategroups-example-1', + ); + } + + public static function getAllPages() { + $groups = MessageGroups::getAllGroups(); + $pages = array(); + foreach ( $groups as $group ) { + if ( $group instanceof WikiPageMessageGroup ) { + $pages[$group->getId()] = $group->getTitle()->getPrefixedText(); + } + } + + return $pages; + } + + // These two functions implement pre-1.24 token fetching via the + // ApiTokensGetTokenTypes hook, kept for backwards compatibility. + public static function getToken() { + $user = RequestContext::getMain()->getUser(); + if ( !$user->isAllowed( self::$right ) ) { + return false; + } + + return $user->getEditToken( self::$salt ); + } + + public static function injectTokenFunction( &$list ) { + $list['aggregategroups'] = array( __CLASS__, 'getToken' ); + + return true; // Hooks must return bool + } + + public static function getRight() { + return self::$right; + } +} |