-<?php\r
-\r
-\r
-/*\r
- * Created on Sep 4, 2006\r
- *\r
- * API for MediaWiki 1.8+\r
- *\r
- * Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@gmail.com>\r
- *\r
- * This program is free software; you can redistribute it and/or modify\r
- * it under the terms of the GNU General Public License as published by\r
- * the Free Software Foundation; either version 2 of the License, or\r
- * (at your option) any later version.\r
- *\r
- * This program is distributed in the hope that it will be useful,\r
- * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
- * GNU General Public License for more details.\r
- *\r
- * You should have received a copy of the GNU General Public License along\r
- * with this program; if not, write to the Free Software Foundation, Inc.,\r
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.\r
- * http://www.gnu.org/copyleft/gpl.html\r
- */\r
-\r
-if (!defined('MEDIAWIKI')) {\r
- // Eclipse helper - will be ignored in production\r
- require_once ('ApiBase.php');\r
-}\r
-\r
-class ApiResult extends ApiBase {\r
-\r
- private $mData;\r
-\r
- /**\r
- * Constructor\r
- */\r
- public function __construct($main) {\r
- parent :: __construct($main);\r
- $this->Reset();\r
- }\r
-\r
- public function Reset() {\r
- $this->mData = array ();\r
- }\r
-\r
- function & getData() {\r
- return $this->mData;\r
- }\r
-\r
- /**\r
- * Add an output value to the array by name.\r
- * Verifies that value with the same name has not been added before.\r
- */\r
- public static function addElement(& $arr, $name, $value) {\r
- if ($arr === null || $name === null || $value === null || !is_array($arr) || is_array($name))\r
- ApiBase :: dieDebug('Bad parameter for ' . __FUNCTION__);\r
- if (isset ($arr[$name]))\r
- ApiBase :: dieDebug("Attempting to add element $name=$value, existing value is {$arr[$name]}");\r
- $arr[$name] = $value;\r
- }\r
-\r
- /**\r
- * Adds the content element to the array.\r
- * Use this function instead of hardcoding the '*' element.\r
- */\r
- public static function addContent(& $arr, $value) {\r
- if (is_array($value))\r
- ApiBase :: dieDebug('Bad parameter for ' . __FUNCTION__);\r
- ApiResult :: addElement($arr, '*', $value);\r
- }\r
-\r
- // public static function makeContentElement($tag, $value) {\r
- // $result = array();\r
- // ApiResult::addContent($result, )\r
- // }\r
- //\r
- /**\r
- * In case the array contains indexed values (in addition to named),\r
- * all indexed values will have the given tag name.\r
- */\r
- public static function setIndexedTagName(& $arr, $tag) {\r
- // Do not use addElement() as it is ok to call this more than once\r
- if ($arr === null || $tag === null || !is_array($arr) || is_array($tag))\r
- ApiBase :: dieDebug('Bad parameter for ' . __FUNCTION__);\r
- $arr['_element'] = $tag;\r
- }\r
-\r
- /**\r
- * Add value to the output data at the given path.\r
- * Path is an indexed array, each element specifing the branch at which to add the new value\r
- * Setting $path to array('a','b','c') is equivalent to data['a']['b']['c'] = $value \r
- */\r
- public function addValue($path, $name, $value) {\r
-\r
- $data = & $this->getData();\r
-\r
- if (isset ($path)) {\r
- if (is_array($path)) {\r
- foreach ($path as $p) {\r
- if (!isset ($data[$p]))\r
- $data[$p] = array ();\r
- $data = & $data[$p];\r
- }\r
- } else {\r
- if (!isset ($data[$path]))\r
- $data[$path] = array ();\r
- $data = & $data[$path];\r
- }\r
- }\r
-\r
- ApiResult :: addElement($data, $name, $value);\r
- }\r
-\r
- /**\r
- * Recursivelly removes any elements from the array that begin with an '_'.\r
- * The content element '*' is the only special element that is left.\r
- * Use this method when the entire data object gets sent to the user.\r
- */\r
- public function SanitizeData() {\r
- ApiResult :: SanitizeDataInt($this->mData);\r
- }\r
-\r
- private static function SanitizeDataInt(& $data) {\r
- foreach ($data as $key => & $value) {\r
- if ($key[0] === '_') {\r
- unset ($data[$key]);\r
- }\r
- elseif ($key === '*' && $value === '') {\r
- unset ($data[$key]);\r
- }\r
- elseif (is_array($value)) {\r
- ApiResult :: SanitizeDataInt($value);\r
- }\r
- }\r
- }\r
-\r
- public function execute() {\r
- $this->dieDebug('execute() is not supported on Result object');\r
- }\r
-}\r
-?>\r
+<?php
+
+/**
+ * Created on Sep 4, 2006
+ *
+ * API for MediaWiki 1.8+
+ *
+ * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ */
+
+if ( !defined( 'MEDIAWIKI' ) ) {
+ // Eclipse helper - will be ignored in production
+ require_once( 'ApiBase.php' );
+}
+
+/**
+ * This class represents the result of the API operations.
+ * It simply wraps a nested array() structure, adding some functions to simplify array's modifications.
+ * As various modules execute, they add different pieces of information to this result,
+ * structuring it as it will be given to the client.
+ *
+ * Each subarray may either be a dictionary - key-value pairs with unique keys,
+ * or lists, where the items are added using $data[] = $value notation.
+ *
+ * There are two special key values that change how XML output is generated:
+ * '_element' This key sets the tag name for the rest of the elements in the current array.
+ * It is only inserted if the formatter returned true for getNeedsRawData()
+ * '*' This key has special meaning only to the XML formatter, and is outputed as is
+ * for all others. In XML it becomes the content of the current element.
+ *
+ * @ingroup API
+ */
+class ApiResult extends ApiBase {
+
+ private $mData, $mIsRawMode, $mSize, $mCheckingSize;
+
+ /**
+ * Constructor
+ * @param $main ApiMain object
+ */
+ public function __construct( $main ) {
+ parent::__construct( $main, 'result' );
+ $this->mIsRawMode = false;
+ $this->mCheckingSize = true;
+ $this->reset();
+ }
+
+ /**
+ * Clear the current result data.
+ */
+ public function reset() {
+ $this->mData = array();
+ $this->mSize = 0;
+ }
+
+ /**
+ * Call this function when special elements such as '_element'
+ * are needed by the formatter, for example in XML printing.
+ */
+ public function setRawMode() {
+ $this->mIsRawMode = true;
+ }
+
+ /**
+ * Returns true whether the formatter requested raw data.
+ * @return bool
+ */
+ public function getIsRawMode() {
+ return $this->mIsRawMode;
+ }
+
+ /**
+ * Get the result's internal data array (read-only)
+ * @return array
+ */
+ public function getData() {
+ return $this->mData;
+ }
+
+ /**
+ * Get the 'real' size of a result item. This means the strlen() of the item,
+ * or the sum of the strlen()s of the elements if the item is an array.
+ * @param $value mixed
+ * @return int
+ */
+ public static function size( $value ) {
+ $s = 0;
+ if ( is_array( $value ) ) {
+ foreach ( $value as $v ) {
+ $s += self::size( $v );
+ }
+ } elseif ( !is_object( $value ) ) {
+ // Objects can't always be cast to string
+ $s = strlen( $value );
+ }
+ return $s;
+ }
+
+ /**
+ * Get the size of the result, i.e. the amount of bytes in it
+ * @return int
+ */
+ public function getSize() {
+ return $this->mSize;
+ }
+
+ /**
+ * Disable size checking in addValue(). Don't use this unless you
+ * REALLY know what you're doing. Values added while size checking
+ * was disabled will not be counted (ever)
+ */
+ public function disableSizeCheck() {
+ $this->mCheckingSize = false;
+ }
+
+ /**
+ * Re-enable size checking in addValue()
+ */
+ public function enableSizeCheck() {
+ $this->mCheckingSize = true;
+ }
+
+ /**
+ * Add an output value to the array by name.
+ * Verifies that value with the same name has not been added before.
+ * @param $arr array to add $value to
+ * @param $name string Index of $arr to add $value at
+ * @param $value mixed
+ */
+ public static function setElement( &$arr, $name, $value ) {
+ if ( $arr === null || $name === null || $value === null || !is_array( $arr ) || is_array( $name ) ) {
+ ApiBase::dieDebug( __METHOD__, 'Bad parameter' );
+ }
+
+ if ( !isset ( $arr[$name] ) ) {
+ $arr[$name] = $value;
+ } elseif ( is_array( $arr[$name] ) && is_array( $value ) ) {
+ $merged = array_intersect_key( $arr[$name], $value );
+ if ( !count( $merged ) ) {
+ $arr[$name] += $value;
+ } else {
+ ApiBase::dieDebug( __METHOD__, "Attempting to merge element $name" );
+ }
+ } else {
+ ApiBase::dieDebug( __METHOD__, "Attempting to add element $name=$value, existing value is {$arr[$name]}" );
+ }
+ }
+
+ /**
+ * Adds a content element to an array.
+ * Use this function instead of hardcoding the '*' element.
+ * @param $arr array to add the content element to
+ * @param $value Mixed
+ * @param $subElemName string when present, content element is created
+ * as a sub item of $arr. Use this parameter to create elements in
+ * format <elem>text</elem> without attributes
+ */
+ public static function setContent( &$arr, $value, $subElemName = null ) {
+ if ( is_array( $value ) ) {
+ ApiBase::dieDebug( __METHOD__, 'Bad parameter' );
+ }
+ if ( is_null( $subElemName ) ) {
+ ApiResult::setElement( $arr, '*', $value );
+ } else {
+ if ( !isset( $arr[$subElemName] ) ) {
+ $arr[$subElemName] = array();
+ }
+ ApiResult::setElement( $arr[$subElemName], '*', $value );
+ }
+ }
+
+ /**
+ * In case the array contains indexed values (in addition to named),
+ * give all indexed values the given tag name. This function MUST be
+ * called on every arrray that has numerical indexes.
+ * @param $arr array
+ * @param $tag string Tag name
+ */
+ public function setIndexedTagName( &$arr, $tag ) {
+ // In raw mode, add the '_element', otherwise just ignore
+ if ( !$this->getIsRawMode() ) {
+ return;
+ }
+ if ( $arr === null || $tag === null || !is_array( $arr ) || is_array( $tag ) )
+ {
+ ApiBase::dieDebug( __METHOD__, 'Bad parameter' );
+ }
+ // Do not use setElement() as it is ok to call this more than once
+ $arr['_element'] = $tag;
+ }
+
+ /**
+ * Calls setIndexedTagName() on each sub-array of $arr
+ * @param $arr array
+ * @param $tag string Tag name
+ */
+ public function setIndexedTagName_recursive( &$arr, $tag ) {
+ if ( !is_array( $arr ) ) {
+ return;
+ }
+ foreach ( $arr as &$a ) {
+ if ( !is_array( $a ) ) {
+ continue;
+ }
+ $this->setIndexedTagName( $a, $tag );
+ $this->setIndexedTagName_recursive( $a, $tag );
+ }
+ }
+
+ /**
+ * Calls setIndexedTagName() on an array already in the result.
+ * Don't specify a path to a value that's not in the result, or
+ * you'll get nasty errors.
+ * @param $path array Path to the array, like addValue()'s $path
+ * @param $tag string
+ */
+ public function setIndexedTagName_internal( $path, $tag ) {
+ $data = &$this->mData;
+ foreach ( (array)$path as $p ) {
+ if ( !isset( $data[$p] ) ) {
+ $data[$p] = array();
+ }
+ $data = &$data[$p];
+ }
+ if ( is_null( $data ) ) {
+ return;
+ }
+ $this->setIndexedTagName( $data, $tag );
+ }
+
+ /**
+ * Add value to the output data at the given path.
+ * Path is an indexed array, each element specifing the branch at which to add the new value
+ * Setting $path to array('a','b','c') is equivalent to data['a']['b']['c'] = $value
+ * If $name is empty, the $value is added as a next list element data[] = $value
+ * @return bool True if $value fits in the result, false if not
+ */
+ public function addValue( $path, $name, $value ) {
+ global $wgAPIMaxResultSize;
+ $data = &$this->mData;
+ if ( $this->mCheckingSize ) {
+ $newsize = $this->mSize + self::size( $value );
+ if ( $newsize > $wgAPIMaxResultSize ) {
+ return false;
+ }
+ $this->mSize = $newsize;
+ }
+
+ if ( !is_null( $path ) ) {
+ if ( is_array( $path ) ) {
+ foreach ( $path as $p ) {
+ if ( !isset( $data[$p] ) ) {
+ $data[$p] = array();
+ }
+ $data = &$data[$p];
+ }
+ } else {
+ if ( !isset( $data[$path] ) ) {
+ $data[$path] = array();
+ }
+ $data = &$data[$path];
+ }
+ }
+
+ if ( !$name ) {
+ $data[] = $value; // Add list element
+ } else {
+ ApiResult::setElement( $data, $name, $value ); // Add named element
+ }
+ return true;
+ }
+
+ /**
+ * Unset a value previously added to the result set.
+ * Fails silently if the value isn't found.
+ * For parameters, see addValue()
+ * @param $path array
+ * @param $name string
+ */
+ public function unsetValue( $path, $name ) {
+ $data = &$this->mData;
+ if ( !is_null( $path ) ) {
+ foreach ( (array)$path as $p ) {
+ if ( !isset( $data[$p] ) ) {
+ return;
+ }
+ $data = &$data[$p];
+ }
+ }
+ $this->mSize -= self::size( $data[$name] );
+ unset( $data[$name] );
+ }
+
+ /**
+ * Ensure all values in this result are valid UTF-8.
+ */
+ public function cleanUpUTF8() {
+ array_walk_recursive( $this->mData, array( 'ApiResult', 'cleanUp_helper' ) );
+ }
+
+ /**
+ * Callback function for cleanUpUTF8()
+ */
+ private static function cleanUp_helper( &$s ) {
+ if ( !is_string( $s ) ) {
+ return;
+ }
+ global $wgContLang;
+ $s = $wgContLang->normalize( $s );
+ }
+
+ public function execute() {
+ ApiBase::dieDebug( __METHOD__, 'execute() is not supported on Result object' );
+ }
+
+ public function getVersion() {
+ return __CLASS__ . ': $Id$';
+ }
+}
dépôts / lhc / web / wiklou.git / blobdiff