From 55875bcd2d24ce976d97376496268b5038064bf3 Mon Sep 17 00:00:00 2001
From: Timo Tijhof <krinklemail@gmail.com>
Date: Thu, 2 Aug 2018 06:10:29 +0100
Subject: [PATCH] maintenance: Move backup.inc to a regular php class file

Move the class to maintenance/includes/, following the precedent
set by d7886920762.

Bug: T184782
Change-Id: I0ba86e4401e2c97db4cf2ad9f0e78c04b5565ee8
---
 .phpcs.xml                                           |  1 -
 autoload.php                                         |  2 +-
 maintenance/dumpBackup.php                           |  5 +++--
 maintenance/dumpTextPass.php                         |  2 +-
 .../{backup.inc => includes/BackupDumper.php}        | 12 +++++++-----
 tests/phan/config.php                                |  1 -
 6 files changed, 12 insertions(+), 11 deletions(-)
 rename maintenance/{backup.inc => includes/BackupDumper.php} (98%)

diff --git a/.phpcs.xml b/.phpcs.xml
index 2a34154689..53f0d93755 100644
--- a/.phpcs.xml
+++ b/.phpcs.xml
@@ -138,7 +138,6 @@
 		<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/backup.inc</exclude-pattern>
 		<exclude-pattern>*/maintenance/benchmarks/bench_HTTP_HTTPS\.php</exclude-pattern>
 		<exclude-pattern>*/maintenance/benchmarks/bench_Wikimedia_base_convert\.php</exclude-pattern>
 		<exclude-pattern>*/maintenance/benchmarks/bench_delete_truncate\.php</exclude-pattern>
diff --git a/autoload.php b/autoload.php
index 38f6ba9cd8..ef1bd4f168 100644
--- a/autoload.php
+++ b/autoload.php
@@ -173,7 +173,7 @@ $wgAutoloadLocalClasses = [
 	'AvroValidator' => __DIR__ . '/includes/utils/AvroValidator.php',
 	'BacklinkCache' => __DIR__ . '/includes/cache/BacklinkCache.php',
 	'BacklinkJobUtils' => __DIR__ . '/includes/jobqueue/utils/BacklinkJobUtils.php',
-	'BackupDumper' => __DIR__ . '/maintenance/backup.inc',
+	'BackupDumper' => __DIR__ . '/maintenance/includes/BackupDumper.php',
 	'BackupReader' => __DIR__ . '/maintenance/importDump.php',
 	'BadRequestError' => __DIR__ . '/includes/exception/BadRequestError.php',
 	'BadTitleError' => __DIR__ . '/includes/exception/BadTitleError.php',
diff --git a/maintenance/dumpBackup.php b/maintenance/dumpBackup.php
index 6bbd86d542..b942302e46 100644
--- a/maintenance/dumpBackup.php
+++ b/maintenance/dumpBackup.php
@@ -22,10 +22,11 @@
  * http://www.gnu.org/copyleft/gpl.html
  *
  * @file
- * @ingroup Dump Maintenance
+ * @ingroup Dump
+ * @ingroup Maintenance
  */
 
-require_once __DIR__ . '/backup.inc';
+require_once __DIR__ . '/includes/BackupDumper.php';
 
 class DumpBackup extends BackupDumper {
 	function __construct( $args = null ) {
diff --git a/maintenance/dumpTextPass.php b/maintenance/dumpTextPass.php
index 95dd4dab39..603708e4a1 100644
--- a/maintenance/dumpTextPass.php
+++ b/maintenance/dumpTextPass.php
@@ -24,7 +24,7 @@
  * @ingroup Maintenance
  */
 
-require_once __DIR__ . '/backup.inc';
+require_once __DIR__ . '/includes/BackupDumper.php';
 require_once __DIR__ . '/7zip.inc';
 require_once __DIR__ . '/../includes/export/WikiExporter.php';
 
diff --git a/maintenance/backup.inc b/maintenance/includes/BackupDumper.php
similarity index 98%
rename from maintenance/backup.inc
rename to maintenance/includes/BackupDumper.php
index 6eeb81bc71..e8993e4200 100644
--- a/maintenance/backup.inc
+++ b/maintenance/includes/BackupDumper.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Base classes for database dumpers
+ * Base classes for database-dumping maintenance scripts.
  *
  * Copyright © 2005 Brion Vibber <brion@pobox.com>
  * https://www.mediawiki.org/
@@ -21,19 +21,21 @@
  * http://www.gnu.org/copyleft/gpl.html
  *
  * @file
- * @ingroup Dump Maintenance
+ * @ingroup Dump
+ * @ingroup Maintenance
  */
 
-require_once __DIR__ . '/Maintenance.php';
+require_once __DIR__ . '/../Maintenance.php';
 
 use MediaWiki\MediaWikiServices;
 use Wikimedia\Rdbms\LoadBalancer;
 use Wikimedia\Rdbms\IDatabase;
 
 /**
- * @ingroup Dump Maintenance
+ * @ingroup Dump
+ * @ingroup Maintenance
  */
-class BackupDumper extends Maintenance {
+abstract class BackupDumper extends Maintenance {
 	public $reporting = true;
 	public $pages = null; // all pages
 	public $skipHeader = false; // don't output <mediawiki> and <siteinfo>
diff --git a/tests/phan/config.php b/tests/phan/config.php
index bcb3379351..f76b1e370d 100644
--- a/tests/phan/config.php
+++ b/tests/phan/config.php
@@ -44,7 +44,6 @@ return [
 		class_exists( PHPUnit_TextUI_Command::class ) ? [] : [ 'tests/phan/stubs/phpunit4.php' ],
 		[
 			'maintenance/7zip.inc',
-			'maintenance/backup.inc',
 			'maintenance/cleanupTable.inc',
 			'maintenance/CodeCleanerGlobalsPass.inc',
 			'maintenance/commandLine.inc',
-- 
2.20.1