summaryrefslogtreecommitdiff
path: root/includes/XmlTypeCheck.php
diff options
context:
space:
mode:
authorPierre Schmitz <pierre@archlinux.de>2014-12-27 15:41:37 +0100
committerPierre Schmitz <pierre@archlinux.de>2014-12-31 11:43:28 +0100
commitc1f9b1f7b1b77776192048005dcc66dcf3df2bfb (patch)
tree2b38796e738dd74cb42ecd9bfd151803108386bc /includes/XmlTypeCheck.php
parentb88ab0086858470dd1f644e64cb4e4f62bb2be9b (diff)
Update to MediaWiki 1.24.1
Diffstat (limited to 'includes/XmlTypeCheck.php')
-rw-r--r--includes/XmlTypeCheck.php264
1 files changed, 0 insertions, 264 deletions
diff --git a/includes/XmlTypeCheck.php b/includes/XmlTypeCheck.php
deleted file mode 100644
index aca857e9..00000000
--- a/includes/XmlTypeCheck.php
+++ /dev/null
@@ -1,264 +0,0 @@
-<?php
-/**
- * XML syntax and type checker.
- *
- * 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.,
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- * http://www.gnu.org/copyleft/gpl.html
- *
- * @file
- */
-
-class XmlTypeCheck {
- /**
- * Will be set to true or false to indicate whether the file is
- * well-formed XML. Note that this doesn't check schema validity.
- */
- public $wellFormed = false;
-
- /**
- * Will be set to true if the optional element filter returned
- * a match at some point.
- */
- public $filterMatch = false;
-
- /**
- * Name of the document's root element, including any namespace
- * as an expanded URL.
- */
- public $rootElement = '';
-
- /**
- * A stack of strings containing the data of each xml element as it's processed. Append
- * data to the top string of the stack, then pop off the string and process it when the
- * element is closed.
- */
- protected $elementData = array();
-
- /**
- * A stack of element names and attributes, as we process them.
- */
- protected $elementDataContext = array();
-
- /**
- * Current depth of the data stack.
- */
- protected $stackDepth = 0;
-
- /**
- * Additional parsing options
- */
- private $parserOptions = array(
- 'processing_instruction_handler' => '',
- );
-
- /**
- * @param string $input a filename or string containing the XML element
- * @param callable $filterCallback (optional)
- * Function to call to do additional custom validity checks from the
- * SAX element handler event. This gives you access to the element
- * namespace, name, attributes, and text contents.
- * Filter should return 'true' to toggle on $this->filterMatch
- * @param boolean $isFile (optional) indicates if the first parameter is a
- * filename (default, true) or if it is a string (false)
- * @param array $options list of additional parsing options:
- * processing_instruction_handler: Callback for xml_set_processing_instruction_handler
- */
- function __construct( $input, $filterCallback = null, $isFile = true, $options = array() ) {
- $this->filterCallback = $filterCallback;
- $this->parserOptions = array_merge( $this->parserOptions, $options );
-
- if ( $isFile ) {
- $this->validateFromFile( $input );
- } else {
- $this->validateFromString( $input );
- }
- }
-
- /**
- * Alternative constructor: from filename
- *
- * @param string $fname the filename of an XML document
- * @param callable $filterCallback (optional)
- * Function to call to do additional custom validity checks from the
- * SAX element handler event. This gives you access to the element
- * namespace, name, and attributes, but not to text contents.
- * Filter should return 'true' to toggle on $this->filterMatch
- * @return XmlTypeCheck
- */
- public static function newFromFilename( $fname, $filterCallback = null ) {
- return new self( $fname, $filterCallback, true );
- }
-
- /**
- * Alternative constructor: from string
- *
- * @param string $string a string containing an XML element
- * @param callable $filterCallback (optional)
- * Function to call to do additional custom validity checks from the
- * SAX element handler event. This gives you access to the element
- * namespace, name, and attributes, but not to text contents.
- * Filter should return 'true' to toggle on $this->filterMatch
- * @return XmlTypeCheck
- */
- public static function newFromString( $string, $filterCallback = null ) {
- return new self( $string, $filterCallback, false );
- }
-
- /**
- * Get the root element. Simple accessor to $rootElement
- *
- * @return string
- */
- public function getRootElement() {
- return $this->rootElement;
- }
-
- /**
- * Get an XML parser with the root element handler.
- * @see XmlTypeCheck::rootElementOpen()
- * @return resource a resource handle for the XML parser
- */
- private function getParser() {
- $parser = xml_parser_create_ns( 'UTF-8' );
- // case folding violates XML standard, turn it off
- xml_parser_set_option( $parser, XML_OPTION_CASE_FOLDING, false );
- xml_set_element_handler( $parser, array( $this, 'rootElementOpen' ), false );
- if ( $this->parserOptions['processing_instruction_handler'] ) {
- xml_set_processing_instruction_handler(
- $parser,
- array( $this, 'processingInstructionHandler' )
- );
- }
- return $parser;
- }
-
- /**
- * @param string $fname the filename
- */
- private function validateFromFile( $fname ) {
- $parser = $this->getParser();
-
- if ( file_exists( $fname ) ) {
- $file = fopen( $fname, "rb" );
- if ( $file ) {
- do {
- $chunk = fread( $file, 32768 );
- $ret = xml_parse( $parser, $chunk, feof( $file ) );
- if ( $ret == 0 ) {
- $this->wellFormed = false;
- fclose( $file );
- xml_parser_free( $parser );
- return;
- }
- } while ( !feof( $file ) );
-
- fclose( $file );
- }
- }
- $this->wellFormed = true;
-
- xml_parser_free( $parser );
- }
-
- /**
- *
- * @param string $string the XML-input-string to be checked.
- */
- private function validateFromString( $string ) {
- $parser = $this->getParser();
- $ret = xml_parse( $parser, $string, true );
- xml_parser_free( $parser );
- if ( $ret == 0 ) {
- $this->wellFormed = false;
- return;
- }
- $this->wellFormed = true;
- }
-
- /**
- * @param $parser
- * @param $name
- * @param $attribs
- */
- private function rootElementOpen( $parser, $name, $attribs ) {
- $this->rootElement = $name;
-
- if ( is_callable( $this->filterCallback ) ) {
- xml_set_element_handler(
- $parser,
- array( $this, 'elementOpen' ),
- array( $this, 'elementClose' )
- );
- xml_set_character_data_handler( $parser, array( $this, 'elementData' ) );
- $this->elementOpen( $parser, $name, $attribs );
- } else {
- // We only need the first open element
- xml_set_element_handler( $parser, false, false );
- }
- }
-
- /**
- * @param $parser
- * @param $name
- * @param $attribs
- */
- private function elementOpen( $parser, $name, $attribs ) {
- $this->elementDataContext[] = array( $name, $attribs );
- $this->elementData[] = '';
- $this->stackDepth++;
- }
-
- /**
- * @param $parser
- * @param $name
- */
- private function elementClose( $parser, $name ) {
- list( $name, $attribs ) = array_pop( $this->elementDataContext );
- $data = array_pop( $this->elementData );
- $this->stackDepth--;
-
- if ( call_user_func(
- $this->filterCallback,
- $name,
- $attribs,
- $data
- ) ) {
- // Filter hit!
- $this->filterMatch = true;
- }
- }
-
- /**
- * @param $parser
- * @param $data
- */
- private function elementData( $parser, $data ) {
- // xml_set_character_data_handler breaks the data on & characters, so
- // we collect any data here, and we'll run the callback in elementClose
- $this->elementData[ $this->stackDepth - 1 ] .= trim( $data );
- }
-
- /**
- * @param $parser
- * @param $target
- * @param $data
- */
- private function processingInstructionHandler( $parser, $target, $data ) {
- if ( call_user_func( $this->parserOptions['processing_instruction_handler'], $target, $data ) ) {
- // Filter hit!
- $this->filterMatch = true;
- }
- }
-}