MediaWiki 1.30.2

[autoinstallsdev/mediawiki.git] / includes / site / SiteExporter.php

diff --git a/includes/site/SiteExporter.php b/includes/site/SiteExporter.php
new file mode 100644 (file)
index 0000000..01b838e
--- /dev/null
+++ b/includes/site/SiteExporter.php
@@ -0,0 +1,114 @@
+<?php
+
+/**
+ * Utility for exporting site entries to XML.
+ * For the output file format, see docs/sitelist.txt and docs/sitelist-1.0.xsd.
+ *
+ * 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
+ *
+ * @since 1.25
+ *
+ * @file
+ * @ingroup Site
+ *
+ * @license GNU GPL v2+
+ * @author Daniel Kinzler
+ */
+class SiteExporter {
+
+       /**
+        * @var resource
+        */
+       private $sink;
+
+       /**
+        * @param resource $sink A file handle open for writing
+        */
+       public function __construct( $sink ) {
+               if ( !is_resource( $sink ) || get_resource_type( $sink ) !== 'stream' ) {
+                       throw new InvalidArgumentException( '$sink must be a file handle' );
+               }
+
+               $this->sink = $sink;
+       }
+
+       /**
+        * Writes a <site> tag for each Site object in $sites, and encloses the entire list
+        * between <sites> tags.
+        *
+        * @param Site[]|SiteList $sites
+        */
+       public function exportSites( $sites ) {
+               $attributes = [
+                       'version' => '1.0',
+                       'xmlns' => 'http://www.mediawiki.org/xml/sitelist-1.0/',
+               ];
+
+               fwrite( $this->sink, Xml::openElement( 'sites', $attributes ) . "\n" );
+
+               foreach ( $sites as $site ) {
+                       $this->exportSite( $site );
+               }
+
+               fwrite( $this->sink, Xml::closeElement( 'sites' ) . "\n" );
+               fflush( $this->sink );
+       }
+
+       /**
+        * Writes a <site> tag representing the given Site object.
+        *
+        * @param Site $site
+        */
+       private function exportSite( Site $site ) {
+               if ( $site->getType() !== Site::TYPE_UNKNOWN ) {
+                       $siteAttr = [ 'type' => $site->getType() ];
+               } else {
+                       $siteAttr = null;
+               }
+
+               fwrite( $this->sink, "\t" . Xml::openElement( 'site', $siteAttr ) . "\n" );
+
+               fwrite( $this->sink, "\t\t" . Xml::element( 'globalid', null, $site->getGlobalId() ) . "\n" );
+
+               if ( $site->getGroup() !== Site::GROUP_NONE ) {
+                       fwrite( $this->sink, "\t\t" . Xml::element( 'group', null, $site->getGroup() ) . "\n" );
+               }
+
+               if ( $site->getSource() !== Site::SOURCE_LOCAL ) {
+                       fwrite( $this->sink, "\t\t" . Xml::element( 'source', null, $site->getSource() ) . "\n" );
+               }
+
+               if ( $site->shouldForward() ) {
+                       fwrite( $this->sink, "\t\t" . Xml::element( 'forward', null, '' ) . "\n" );
+               }
+
+               foreach ( $site->getAllPaths() as $type => $path ) {
+                       fwrite( $this->sink, "\t\t" . Xml::element( 'path', [ 'type' => $type ], $path ) . "\n" );
+               }
+
+               foreach ( $site->getLocalIds() as $type => $ids ) {
+                       foreach ( $ids as $id ) {
+                               fwrite( $this->sink, "\t\t" . Xml::element( 'localid', [ 'type' => $type ], $id ) . "\n" );
+                       }
+               }
+
+               // @todo: export <data>
+               // @todo: export <config>
+
+               fwrite( $this->sink, "\t" . Xml::closeElement( 'site' ) . "\n" );
+       }
+
+}