MediaWiki REL1_31
BaseDump.php
Go to the documentation of this file.
1<?php
42class BaseDump {
44 protected $reader = null;
45 protected $atEnd = false;
46 protected $atPageEnd = false;
47 protected $lastPage = 0;
48 protected $lastRev = 0;
49 protected $infiles = null;
50
51 public function __construct( $infile ) {
52 $this->infiles = explode( ';', $infile );
53 $this->reader = new XMLReader();
54 $infile = array_shift( $this->infiles );
55 if ( defined( 'LIBXML_PARSEHUGE' ) ) {
56 $this->reader->open( $infile, null, LIBXML_PARSEHUGE );
57 } else {
58 $this->reader->open( $infile );
59 }
60 }
61
71 function prefetch( $page, $rev ) {
72 $page = intval( $page );
73 $rev = intval( $rev );
74 while ( $this->lastPage < $page && !$this->atEnd ) {
75 $this->debug( "BaseDump::prefetch at page $this->lastPage, looking for $page" );
76 $this->nextPage();
77 }
78 if ( $this->lastPage > $page || $this->atEnd ) {
79 $this->debug( "BaseDump::prefetch already past page $page "
80 . "looking for rev $rev [$this->lastPage, $this->lastRev]" );
81
82 return null;
83 }
84 while ( $this->lastRev < $rev && !$this->atEnd && !$this->atPageEnd ) {
85 $this->debug( "BaseDump::prefetch at page $this->lastPage, rev $this->lastRev, "
86 . "looking for $page, $rev" );
87 $this->nextRev();
88 }
89 if ( $this->lastRev == $rev && !$this->atEnd ) {
90 $this->debug( "BaseDump::prefetch hit on $page, $rev [$this->lastPage, $this->lastRev]" );
91
92 return $this->nextText();
93 } else {
94 $this->debug( "BaseDump::prefetch already past rev $rev on page $page "
95 . "[$this->lastPage, $this->lastRev]" );
96
97 return null;
98 }
99 }
100
101 function debug( $str ) {
102 wfDebug( $str . "\n" );
103 // global $dumper;
104 // $dumper->progress( $str );
105 }
106
110 function nextPage() {
111 if ( $this->skipTo( 'page', 'mediawiki' ) ) {
112 if ( $this->skipTo( 'id' ) ) {
113 $this->lastPage = intval( $this->nodeContents() );
114 $this->lastRev = 0;
115 $this->atPageEnd = false;
116 }
117 } else {
118 $this->close();
119 if ( count( $this->infiles ) ) {
120 $infile = array_shift( $this->infiles );
121 $this->reader->open( $infile );
122 $this->atEnd = false;
123 }
124 }
125 }
126
130 function nextRev() {
131 if ( $this->skipTo( 'revision' ) ) {
132 if ( $this->skipTo( 'id' ) ) {
133 $this->lastRev = intval( $this->nodeContents() );
134 }
135 } else {
136 $this->atPageEnd = true;
137 }
138 }
139
144 function nextText() {
145 $this->skipTo( 'text' );
146
147 return strval( $this->nodeContents() );
148 }
149
156 function skipTo( $name, $parent = 'page' ) {
157 if ( $this->atEnd ) {
158 return false;
159 }
160 while ( $this->reader->read() ) {
161 if ( $this->reader->nodeType == XMLReader::ELEMENT
162 && $this->reader->name == $name
163 ) {
164 return true;
165 }
166 if ( $this->reader->nodeType == XMLReader::END_ELEMENT
167 && $this->reader->name == $parent
168 ) {
169 $this->debug( "BaseDump::skipTo found </$parent> searching for <$name>" );
170
171 return false;
172 }
173 }
174
175 return $this->close();
176 }
177
186 function nodeContents() {
187 if ( $this->atEnd ) {
188 return null;
189 }
190 if ( $this->reader->isEmptyElement ) {
191 return "";
192 }
193 $buffer = "";
194 while ( $this->reader->read() ) {
195 switch ( $this->reader->nodeType ) {
196 case XMLReader::TEXT:
197 // case XMLReader::WHITESPACE:
198 case XMLReader::SIGNIFICANT_WHITESPACE:
199 $buffer .= $this->reader->value;
200 break;
201 case XMLReader::END_ELEMENT:
202 return $buffer;
203 }
204 }
205
206 return $this->close();
207 }
208
213 function close() {
214 $this->reader->close();
215 $this->atEnd = true;
216
217 return null;
218 }
219}
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
Readahead helper for making large MediaWiki data dumps; reads in a previous XML dump to sequentially ...
Definition BaseDump.php:42
__construct( $infile)
Definition BaseDump.php:51
debug( $str)
Definition BaseDump.php:101
nodeContents()
Shouldn't something like this be built-in to XMLReader? Fetches text contents of the current element,...
Definition BaseDump.php:186
skipTo( $name, $parent='page')
Definition BaseDump.php:156
prefetch( $page, $rev)
Attempts to fetch the text of a particular page revision from the dump stream.
Definition BaseDump.php:71
XMLReader $reader
Definition BaseDump.php:44
presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc $rev
Definition hooks.txt:1777
$buffer