move 7zip.inc to a regular php file
authorAriel T. Glenn <ariel@wikimedia.org>
Mon, 13 May 2019 10:38:37 +0000 (13:38 +0300)
committerJforrester <jforrester@wikimedia.org>
Mon, 13 May 2019 11:25:24 +0000 (11:25 +0000)
Bug: T182814
Change-Id: I53746333fe3c1cdc357bf46d71a351231a845e2f

.phpcs.xml
autoload.php
maintenance/7zip.inc [deleted file]
maintenance/includes/SevenZipStream.php [new file with mode: 0644]
maintenance/includes/TextPassDumper.php

index 38fb952..22b74b5 100644 (file)
                <exclude-pattern>*/includes/specials/SpecialWantedpages\.php</exclude-pattern>
                <exclude-pattern>*/includes/specials/SpecialWantedtemplates\.php</exclude-pattern>
                <exclude-pattern>*/includes/specials/SpecialWithoutinterwiki\.php</exclude-pattern>
-               <exclude-pattern>*/maintenance/7zip.inc</exclude-pattern>
                <exclude-pattern>*/maintenance/CodeCleanerGlobalsPass.inc</exclude-pattern>
                <exclude-pattern>*/maintenance/archives/upgradeLogging\.php</exclude-pattern>
                <exclude-pattern>*/maintenance/benchmarks/bench_HTTP_HTTPS\.php</exclude-pattern>
                -->
                <exclude-pattern>*/includes/GlobalFunctions\.php</exclude-pattern>
                <exclude-pattern>*/includes/libs/filebackend/FSFileBackend\.php</exclude-pattern>
-               <exclude-pattern>*/maintenance/7zip\.inc</exclude-pattern>
+               <exclude-pattern>*/maintenance/includes/SevenZipStream\.php</exclude-pattern>
                <exclude-pattern>*/maintenance/populateImageSha1\.php</exclude-pattern>
        </rule>
        <rule ref="MediaWiki.Usage.ForbiddenFunctions.proc_open">
index 31d9159..b80efcf 100644 (file)
@@ -1321,7 +1321,7 @@ $wgAutoloadLocalClasses = [
        'SearchUpdate' => __DIR__ . '/includes/deferred/SearchUpdate.php',
        'SectionProfileCallback' => __DIR__ . '/includes/profiler/SectionProfileCallback.php',
        'SectionProfiler' => __DIR__ . '/includes/profiler/SectionProfiler.php',
-       'SevenZipStream' => __DIR__ . '/maintenance/7zip.inc',
+       'SevenZipStream' => __DIR__ . '/maintenance/includes/SevenZipStream.php',
        'ShiConverter' => __DIR__ . '/languages/classes/LanguageShi.php',
        'ShortPagesPage' => __DIR__ . '/includes/specials/SpecialShortpages.php',
        'ShowJobs' => __DIR__ . '/maintenance/showJobs.php',
diff --git a/maintenance/7zip.inc b/maintenance/7zip.inc
deleted file mode 100644 (file)
index 6a763f2..0000000
+++ /dev/null
@@ -1,98 +0,0 @@
-<?php
-/**
- * 7z stream wrapper
- *
- * Copyright © 2005 Brion Vibber <brion@pobox.com>
- * https://www.mediawiki.org/
- *
- * 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
- * @ingroup Maintenance
- */
-
-use MediaWiki\Shell\Shell;
-
-/**
- * Stream wrapper around 7za filter program.
- * Required since we can't pass an open file resource to XMLReader->open()
- * which is used for the text prefetch.
- *
- * @ingroup Maintenance
- */
-class SevenZipStream {
-       protected $stream;
-
-       private function stripPath( $path ) {
-               $prefix = 'mediawiki.compress.7z://';
-
-               return substr( $path, strlen( $prefix ) );
-       }
-
-       function stream_open( $path, $mode, $options, &$opened_path ) {
-               if ( $mode[0] == 'r' ) {
-                       $options = 'e -bd -so';
-               } elseif ( $mode[0] == 'w' ) {
-                       $options = 'a -bd -si';
-               } else {
-                       return false;
-               }
-               $arg = Shell::escape( $this->stripPath( $path ) );
-               $command = "7za $options $arg";
-               if ( !wfIsWindows() ) {
-                       // Suppress the stupid messages on stderr
-                       $command .= ' 2>/dev/null';
-               }
-               $this->stream = popen( $command, $mode[0] ); // popen() doesn't like two-letter modes
-               return ( $this->stream !== false );
-       }
-
-       function url_stat( $path, $flags ) {
-               return stat( $this->stripPath( $path ) );
-       }
-
-       // This is all so lame; there should be a default class we can extend
-
-       function stream_close() {
-               return fclose( $this->stream );
-       }
-
-       function stream_flush() {
-               return fflush( $this->stream );
-       }
-
-       function stream_read( $count ) {
-               return fread( $this->stream, $count );
-       }
-
-       function stream_write( $data ) {
-               return fwrite( $this->stream, $data );
-       }
-
-       function stream_tell() {
-               return ftell( $this->stream );
-       }
-
-       function stream_eof() {
-               return feof( $this->stream );
-       }
-
-       function stream_seek( $offset, $whence ) {
-               return fseek( $this->stream, $offset, $whence );
-       }
-}
-
-stream_wrapper_register( 'mediawiki.compress.7z', SevenZipStream::class );
diff --git a/maintenance/includes/SevenZipStream.php b/maintenance/includes/SevenZipStream.php
new file mode 100644 (file)
index 0000000..6a763f2
--- /dev/null
@@ -0,0 +1,98 @@
+<?php
+/**
+ * 7z stream wrapper
+ *
+ * Copyright © 2005 Brion Vibber <brion@pobox.com>
+ * https://www.mediawiki.org/
+ *
+ * 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
+ * @ingroup Maintenance
+ */
+
+use MediaWiki\Shell\Shell;
+
+/**
+ * Stream wrapper around 7za filter program.
+ * Required since we can't pass an open file resource to XMLReader->open()
+ * which is used for the text prefetch.
+ *
+ * @ingroup Maintenance
+ */
+class SevenZipStream {
+       protected $stream;
+
+       private function stripPath( $path ) {
+               $prefix = 'mediawiki.compress.7z://';
+
+               return substr( $path, strlen( $prefix ) );
+       }
+
+       function stream_open( $path, $mode, $options, &$opened_path ) {
+               if ( $mode[0] == 'r' ) {
+                       $options = 'e -bd -so';
+               } elseif ( $mode[0] == 'w' ) {
+                       $options = 'a -bd -si';
+               } else {
+                       return false;
+               }
+               $arg = Shell::escape( $this->stripPath( $path ) );
+               $command = "7za $options $arg";
+               if ( !wfIsWindows() ) {
+                       // Suppress the stupid messages on stderr
+                       $command .= ' 2>/dev/null';
+               }
+               $this->stream = popen( $command, $mode[0] ); // popen() doesn't like two-letter modes
+               return ( $this->stream !== false );
+       }
+
+       function url_stat( $path, $flags ) {
+               return stat( $this->stripPath( $path ) );
+       }
+
+       // This is all so lame; there should be a default class we can extend
+
+       function stream_close() {
+               return fclose( $this->stream );
+       }
+
+       function stream_flush() {
+               return fflush( $this->stream );
+       }
+
+       function stream_read( $count ) {
+               return fread( $this->stream, $count );
+       }
+
+       function stream_write( $data ) {
+               return fwrite( $this->stream, $data );
+       }
+
+       function stream_tell() {
+               return ftell( $this->stream );
+       }
+
+       function stream_eof() {
+               return feof( $this->stream );
+       }
+
+       function stream_seek( $offset, $whence ) {
+               return fseek( $this->stream, $offset, $whence );
+       }
+}
+
+stream_wrapper_register( 'mediawiki.compress.7z', SevenZipStream::class );
index a5dee98..03cad5c 100644 (file)
@@ -26,7 +26,7 @@
  */
 
 require_once __DIR__ . '/BackupDumper.php';
-require_once __DIR__ . '/../7zip.inc';
+require_once __DIR__ . '/SevenZipStream.php';
 require_once __DIR__ . '/../../includes/export/WikiExporter.php';
 
 use MediaWiki\MediaWikiServices;