MediaWiki  REL1_31
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  $oldDisable = libxml_disable_entity_loader( true );
86  $ok = $document->loadXML( $xml, LIBXML_NONET );
87 
88  if ( !$ok ) {
89  $errors = libxml_get_errors();
90  libxml_use_internal_errors( $oldLibXmlErrors );
91  libxml_disable_entity_loader( $oldDisable );
92 
93  foreach ( $errors as $error ) {
95  throw new InvalidArgumentException(
96  'Malformed XML: ' . $error->message . ' in line ' . $error->line
97  );
98  }
99 
100  throw new InvalidArgumentException( 'Malformed XML!' );
101  }
102 
103  libxml_use_internal_errors( $oldLibXmlErrors );
104  libxml_disable_entity_loader( $oldDisable );
105  $this->importFromDOM( $document->documentElement );
106  }
107 
111  private function importFromDOM( DOMElement $root ) {
112  $sites = $this->makeSiteList( $root );
113  $this->store->saveSites( $sites );
114  }
115 
121  private function makeSiteList( DOMElement $root ) {
122  $sites = [];
123 
124  // Old sites, to get the row IDs that correspond to the global site IDs.
125  // TODO: Get rid of internal row IDs, they just get in the way. Get rid of ORMRow, too.
126  $oldSites = $this->store->getSites();
127 
128  $current = $root->firstChild;
129  while ( $current ) {
130  if ( $current instanceof DOMElement && $current->tagName === 'site' ) {
131  try {
132  $site = $this->makeSite( $current );
133  $key = $site->getGlobalId();
134 
135  if ( $oldSites->hasSite( $key ) ) {
136  $oldSite = $oldSites->getSite( $key );
137  $site->setInternalId( $oldSite->getInternalId() );
138  }
139 
140  $sites[$key] = $site;
141  } catch ( Exception $ex ) {
142  $this->handleException( $ex );
143  }
144  }
145 
146  $current = $current->nextSibling;
147  }
148 
149  return $sites;
150  }
151 
158  public function makeSite( DOMElement $siteElement ) {
159  if ( $siteElement->tagName !== 'site' ) {
160  throw new InvalidArgumentException( 'Expected <site> tag, found ' . $siteElement->tagName );
161  }
162 
163  $type = $this->getAttributeValue( $siteElement, 'type', Site::TYPE_UNKNOWN );
164  $site = Site::newForType( $type );
165 
166  $site->setForward( $this->hasChild( $siteElement, 'forward' ) );
167  $site->setGlobalId( $this->getChildText( $siteElement, 'globalid' ) );
168  $site->setGroup( $this->getChildText( $siteElement, 'group', Site::GROUP_NONE ) );
169  $site->setSource( $this->getChildText( $siteElement, 'source', Site::SOURCE_LOCAL ) );
170 
171  $pathTags = $siteElement->getElementsByTagName( 'path' );
172  for ( $i = 0; $i < $pathTags->length; $i++ ) {
173  $pathElement = $pathTags->item( $i );
174  $pathType = $this->getAttributeValue( $pathElement, 'type' );
175  $path = $pathElement->textContent;
176 
177  $site->setPath( $pathType, $path );
178  }
179 
180  $idTags = $siteElement->getElementsByTagName( 'localid' );
181  for ( $i = 0; $i < $idTags->length; $i++ ) {
182  $idElement = $idTags->item( $i );
183  $idType = $this->getAttributeValue( $idElement, 'type' );
184  $id = $idElement->textContent;
185 
186  $site->addLocalId( $idType, $id );
187  }
188 
189  // @todo: import <data>
190  // @todo: import <config>
191 
192  return $site;
193  }
194 
203  private function getAttributeValue( DOMElement $element, $name, $default = false ) {
204  $node = $element->getAttributeNode( $name );
205 
206  if ( !$node ) {
207  if ( $default !== false ) {
208  return $default;
209  } else {
210  throw new MWException(
211  'Required ' . $name . ' attribute not found in <' . $element->tagName . '> tag'
212  );
213  }
214  }
215 
216  return $node->textContent;
217  }
218 
227  private function getChildText( DOMElement $element, $name, $default = false ) {
228  $elements = $element->getElementsByTagName( $name );
229 
230  if ( $elements->length < 1 ) {
231  if ( $default !== false ) {
232  return $default;
233  } else {
234  throw new MWException(
235  'Required <' . $name . '> tag not found inside <' . $element->tagName . '> tag'
236  );
237  }
238  }
239 
240  $node = $elements->item( 0 );
241  return $node->textContent;
242  }
243 
251  private function hasChild( DOMElement $element, $name ) {
252  return $this->getChildText( $element, $name, null ) !== null;
253  }
254 
258  private function handleException( Exception $ex ) {
259  if ( $this->exceptionCallback ) {
260  call_user_func( $this->exceptionCallback, $ex );
261  } else {
262  wfLogWarning( $ex->getMessage() );
263  }
264  }
265 
266 }
SiteImporter\getExceptionCallback
getExceptionCallback()
Definition: SiteImporter.php:52
SiteImporter\$exceptionCallback
callable null $exceptionCallback
Definition: SiteImporter.php:40
SiteImporter\getAttributeValue
getAttributeValue(DOMElement $element, $name, $default=false)
Definition: SiteImporter.php:203
SiteImporter\hasChild
hasChild(DOMElement $element, $name)
Definition: SiteImporter.php:251
SiteImporter\importFromXML
importFromXML( $xml)
Definition: SiteImporter.php:81
SiteImporter\makeSiteList
makeSiteList(DOMElement $root)
Definition: SiteImporter.php:121
SiteImporter
Definition: SiteImporter.php:30
wfLogWarning
wfLogWarning( $msg, $callerOffset=1, $level=E_USER_WARNING)
Send a warning as a PHP error and the debug log.
Definition: GlobalFunctions.php:1150
SiteImporter\__construct
__construct(SiteStore $store)
Definition: SiteImporter.php:45
SiteImporter\$store
SiteStore $store
Definition: SiteImporter.php:35
php
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:37
Site\newForType
static newForType( $siteType)
Definition: Site.php:646
SiteStore
Definition: SiteStore.php:29
MWException
MediaWiki exception.
Definition: MWException.php:26
Site\TYPE_UNKNOWN
const TYPE_UNKNOWN
Definition: Site.php:30
store
MediaWiki s SiteStore can be cached and stored in a flat in a json format If the SiteStore is frequently the file cache may provide a performance benefit over a database store
Definition: sitescache.txt:4
SiteImporter\getChildText
getChildText(DOMElement $element, $name, $default=false)
Definition: SiteImporter.php:227
SiteImporter\setExceptionCallback
setExceptionCallback( $exceptionCallback)
Definition: SiteImporter.php:59
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
SiteImporter\handleException
handleException(Exception $ex)
Definition: SiteImporter.php:258
$path
$path
Definition: NoLocalSettings.php:25
as
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:22
Site\GROUP_NONE
const GROUP_NONE
Definition: Site.php:33
Site\SOURCE_LOCAL
const SOURCE_LOCAL
Definition: Site.php:38
SiteImporter\importFromDOM
importFromDOM(DOMElement $root)
Definition: SiteImporter.php:111
SiteImporter\importFromFile
importFromFile( $file)
Definition: SiteImporter.php:66
SiteImporter\makeSite
makeSite(DOMElement $siteElement)
Definition: SiteImporter.php:158
$type
$type
Definition: testCompression.php:48