MediaWiki  master
SiteImporter.php
Go to the documentation of this file.
1 <?php
2 
30 class SiteImporter {
31 
35  private $store;
36 
41 
45  public function __construct( SiteStore $store ) {
46  $this->store = $store;
47  }
48 
52  public function getExceptionCallback() {
54  }
55 
60  $this->exceptionCallback = $exceptionCallback;
61  }
62 
66  public function importFromFile( $file ) {
67  $xml = file_get_contents( $file );
68 
69  if ( $xml === false ) {
70  throw new RuntimeException( 'Failed to read ' . $file . '!' );
71  }
72 
73  $this->importFromXML( $xml );
74  }
75 
81  public function importFromXML( $xml ) {
82  $document = new DOMDocument();
83 
84  $oldLibXmlErrors = libxml_use_internal_errors( true );
85  $ok = $document->loadXML( $xml, LIBXML_NONET );
86 
87  if ( !$ok ) {
88  $errors = libxml_get_errors();
89  libxml_use_internal_errors( $oldLibXmlErrors );
90 
91  foreach ( $errors as $error ) {
93  throw new InvalidArgumentException(
94  'Malformed XML: ' . $error->message . ' in line ' . $error->line
95  );
96  }
97 
98  throw new InvalidArgumentException( 'Malformed XML!' );
99  }
100 
101  libxml_use_internal_errors( $oldLibXmlErrors );
102  $this->importFromDOM( $document->documentElement );
103  }
104 
108  private function importFromDOM( DOMElement $root ) {
109  $sites = $this->makeSiteList( $root );
110  $this->store->saveSites( $sites );
111  }
112 
118  private function makeSiteList( DOMElement $root ) {
119  $sites = [];
120 
121  // Old sites, to get the row IDs that correspond to the global site IDs.
122  // TODO: Get rid of internal row IDs, they just get in the way. Get rid of ORMRow, too.
123  $oldSites = $this->store->getSites();
124 
125  $current = $root->firstChild;
126  while ( $current ) {
127  if ( $current instanceof DOMElement && $current->tagName === 'site' ) {
128  try {
129  $site = $this->makeSite( $current );
130  $key = $site->getGlobalId();
131 
132  if ( $oldSites->hasSite( $key ) ) {
133  $oldSite = $oldSites->getSite( $key );
134  $site->setInternalId( $oldSite->getInternalId() );
135  }
136 
137  $sites[$key] = $site;
138  } catch ( Exception $ex ) {
139  $this->handleException( $ex );
140  }
141  }
142 
143  $current = $current->nextSibling;
144  }
145 
146  return $sites;
147  }
148 
155  public function makeSite( DOMElement $siteElement ) {
156  if ( $siteElement->tagName !== 'site' ) {
157  throw new InvalidArgumentException( 'Expected <site> tag, found ' . $siteElement->tagName );
158  }
159 
160  $type = $this->getAttributeValue( $siteElement, 'type', Site::TYPE_UNKNOWN );
161  $site = Site::newForType( $type );
162 
163  $site->setForward( $this->hasChild( $siteElement, 'forward' ) );
164  $site->setGlobalId( $this->getChildText( $siteElement, 'globalid' ) );
165  $site->setGroup( $this->getChildText( $siteElement, 'group', Site::GROUP_NONE ) );
166  $site->setSource( $this->getChildText( $siteElement, 'source', Site::SOURCE_LOCAL ) );
167 
168  $pathTags = $siteElement->getElementsByTagName( 'path' );
169  for ( $i = 0; $i < $pathTags->length; $i++ ) {
170  $pathElement = $pathTags->item( $i );
171  $pathType = $this->getAttributeValue( $pathElement, 'type' );
172  $path = $pathElement->textContent;
173 
174  $site->setPath( $pathType, $path );
175  }
176 
177  $idTags = $siteElement->getElementsByTagName( 'localid' );
178  for ( $i = 0; $i < $idTags->length; $i++ ) {
179  $idElement = $idTags->item( $i );
180  $idType = $this->getAttributeValue( $idElement, 'type' );
181  $id = $idElement->textContent;
182 
183  $site->addLocalId( $idType, $id );
184  }
185 
186  // @todo: import <data>
187  // @todo: import <config>
188 
189  return $site;
190  }
191 
200  private function getAttributeValue( DOMElement $element, $name, $default = false ) {
201  $node = $element->getAttributeNode( $name );
202 
203  if ( !$node ) {
204  if ( $default !== false ) {
205  return $default;
206  } else {
207  throw new MWException(
208  'Required ' . $name . ' attribute not found in <' . $element->tagName . '> tag'
209  );
210  }
211  }
212 
213  return $node->textContent;
214  }
215 
224  private function getChildText( DOMElement $element, $name, $default = false ) {
225  $elements = $element->getElementsByTagName( $name );
226 
227  if ( $elements->length < 1 ) {
228  if ( $default !== false ) {
229  return $default;
230  } else {
231  throw new MWException(
232  'Required <' . $name . '> tag not found inside <' . $element->tagName . '> tag'
233  );
234  }
235  }
236 
237  $node = $elements->item( 0 );
238  return $node->textContent;
239  }
240 
248  private function hasChild( DOMElement $element, $name ) {
249  return $this->getChildText( $element, $name, null ) !== null;
250  }
251 
255  private function handleException( Exception $ex ) {
256  if ( $this->exceptionCallback ) {
257  call_user_func( $this->exceptionCallback, $ex );
258  } else {
259  wfLogWarning( $ex->getMessage() );
260  }
261  }
262 
263 }
importFromDOM(DOMElement $root)
importFromFile( $file)
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Definition: router.php:42
SiteStore $store
wfLogWarning( $msg, $callerOffset=1, $level=E_USER_WARNING)
Send a warning as a PHP error and the debug log.
hasChild(DOMElement $element, $name)
getChildText(DOMElement $element, $name, $default=false)
static newForType( $siteType)
Definition: Site.php:646
const TYPE_UNKNOWN
Definition: Site.php:30
getAttributeValue(DOMElement $element, $name, $default=false)
const SOURCE_LOCAL
Definition: Site.php:38
const GROUP_NONE
Definition: Site.php:33
callable null $exceptionCallback
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
makeSiteList(DOMElement $root)
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
importFromXML( $xml)
handleException(Exception $ex)
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
setExceptionCallback( $exceptionCallback)
makeSite(DOMElement $siteElement)
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
__construct(SiteStore $store)