From f6d65e533c62f6deb21342d4901ece24497b433e Mon Sep 17 00:00:00 2001 From: Pierre Schmitz Date: Thu, 4 Jun 2015 07:31:04 +0200 Subject: Update to MediaWiki 1.25.1 --- includes/api/ApiContinuationManager.php | 238 ++++++++++++++++++++++++++++++++ 1 file changed, 238 insertions(+) create mode 100644 includes/api/ApiContinuationManager.php (limited to 'includes/api/ApiContinuationManager.php') diff --git a/includes/api/ApiContinuationManager.php b/includes/api/ApiContinuationManager.php new file mode 100644 index 00000000..354f4e7d --- /dev/null +++ b/includes/api/ApiContinuationManager.php @@ -0,0 +1,238 @@ +source = get_class( $module ); + $request = $module->getRequest(); + + $this->generatedModules = $generatedModules + ? array_combine( $generatedModules, $generatedModules ) + : array(); + + $skip = array(); + $continue = $request->getVal( 'continue', '' ); + if ( $continue !== '' ) { + $continue = explode( '||', $continue ); + if ( count( $continue ) !== 2 ) { + throw new UsageException( + 'Invalid continue param. You should pass the original value returned by the previous query', + 'badcontinue' + ); + } + $this->generatorDone = ( $continue[0] === '-' ); + $skip = explode( '|', $continue[1] ); + if ( !$this->generatorDone ) { + $params = explode( '|', $continue[0] ); + if ( $params ) { + $this->generatorParams = array_intersect_key( + $request->getValues(), + array_flip( $params ) + ); + } + } else { + // When the generator is complete, don't run any modules that + // depend on it. + $skip += $this->generatedModules; + } + } + + foreach ( $allModules as $module ) { + $name = $module->getModuleName(); + if ( in_array( $name, $skip, true ) ) { + $this->allModules[$name] = false; + // Prevent spurious "unused parameter" warnings + $module->extractRequestParams(); + } else { + $this->allModules[$name] = $module; + } + } + } + + /** + * Get the class that created this manager + * @return string + */ + public function getSource() { + return $this->source; + } + + /** + * Is the generator done? + * @return bool + */ + public function isGeneratorDone() { + return $this->generatorDone; + } + + /** + * Get the list of modules that should actually be run + * @return ApiBase[] + */ + public function getRunModules() { + return array_values( array_filter( $this->allModules ) ); + } + + /** + * Set the continuation parameter for a module + * @param ApiBase $module + * @param string $paramName + * @param string|array $paramValue + * @throws UnexpectedValueException + */ + public function addContinueParam( ApiBase $module, $paramName, $paramValue ) { + $name = $module->getModuleName(); + if ( !isset( $this->allModules[$name] ) ) { + throw new UnexpectedValueException( + "Module '$name' called " . __METHOD__ . + ' but was not passed to ' . __CLASS__ . '::__construct' + ); + } + if ( !$this->allModules[$name] ) { + throw new UnexpectedValueException( + "Module '$name' was not supposed to have been executed, but " . + 'it was executed anyway' + ); + } + $paramName = $module->encodeParamName( $paramName ); + if ( is_array( $paramValue ) ) { + $paramValue = join( '|', $paramValue ); + } + $this->continuationData[$name][$paramName] = $paramValue; + } + + /** + * Set the continuation parameter for the generator module + * @param ApiBase $module + * @param string $paramName + * @param string|array $paramValue + */ + public function addGeneratorContinueParam( ApiBase $module, $paramName, $paramValue ) { + $name = $module->getModuleName(); + $paramName = $module->encodeParamName( $paramName ); + if ( is_array( $paramValue ) ) { + $paramValue = join( '|', $paramValue ); + } + $this->generatorContinuationData[$name][$paramName] = $paramValue; + } + + /** + * Fetch raw continuation data + * @return array + */ + public function getRawContinuation() { + return array_merge_recursive( $this->continuationData, $this->generatorContinuationData ); + } + + /** + * Fetch continuation result data + * @return array Array( (array)$data, (bool)$batchcomplete ) + */ + public function getContinuation() { + $data = array(); + $batchcomplete = false; + + $finishedModules = array_diff( + array_keys( $this->allModules ), + array_keys( $this->continuationData ) + ); + + // First, grab the non-generator-using continuation data + $continuationData = array_diff_key( $this->continuationData, $this->generatedModules ); + foreach ( $continuationData as $module => $kvp ) { + $data += $kvp; + } + + // Next, handle the generator-using continuation data + $continuationData = array_intersect_key( $this->continuationData, $this->generatedModules ); + if ( $continuationData ) { + // Some modules are unfinished: include those params, and copy + // the generator params. + foreach ( $continuationData as $module => $kvp ) { + $data += $kvp; + } + $data += $this->generatorParams; + $generatorKeys = join( '|', array_keys( $this->generatorParams ) ); + } elseif ( $this->generatorContinuationData ) { + // All the generator-using modules are complete, but the + // generator isn't. Continue the generator and restart the + // generator-using modules + $generatorParams = array(); + foreach ( $this->generatorContinuationData as $kvp ) { + $generatorParams += $kvp; + } + $data += $generatorParams; + $finishedModules = array_diff( $finishedModules, $this->generatedModules ); + $generatorKeys = join( '|', array_keys( $generatorParams ) ); + $batchcomplete = true; + } else { + // Generator and prop modules are all done. Mark it so. + $generatorKeys = '-'; + $batchcomplete = true; + } + + // Set 'continue' if any continuation data is set or if the generator + // still needs to run + if ( $data || $generatorKeys !== '-' ) { + $data['continue'] = $generatorKeys . '||' . join( '|', $finishedModules ); + } + + return array( $data, $batchcomplete ); + } + + /** + * Store the continuation data into the result + * @param ApiResult $result + */ + public function setContinuationIntoResult( ApiResult $result ) { + list( $data, $batchcomplete ) = $this->getContinuation(); + if ( $data ) { + $result->addValue( null, 'continue', $data, + ApiResult::ADD_ON_TOP | ApiResult::NO_SIZE_CHECK ); + } + if ( $batchcomplete ) { + $result->addValue( null, 'batchcomplete', true, + ApiResult::ADD_ON_TOP | ApiResult::NO_SIZE_CHECK ); + } + } +} -- cgit v1.2.3-54-g00ecf