Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
Total | |
0.00% |
0 / 70 |
|
0.00% |
0 / 3 |
CRAP | |
0.00% |
0 / 1 |
DumpBackup | |
0.00% |
0 / 67 |
|
0.00% |
0 / 3 |
306 | |
0.00% |
0 / 1 |
__construct | |
0.00% |
0 / 27 |
|
0.00% |
0 / 1 |
6 | |||
execute | |
0.00% |
0 / 13 |
|
0.00% |
0 / 1 |
56 | |||
processOptions | |
0.00% |
0 / 27 |
|
0.00% |
0 / 1 |
72 |
1 | <?php |
2 | /** |
3 | * Script that dumps wiki pages or logging database into an XML interchange |
4 | * wrapper format for export or backup |
5 | * |
6 | * Copyright © 2005 Brooke Vibber <bvibber@wikimedia.org> |
7 | * https://www.mediawiki.org/ |
8 | * |
9 | * This program is free software; you can redistribute it and/or modify |
10 | * it under the terms of the GNU General Public License as published by |
11 | * the Free Software Foundation; either version 2 of the License, or |
12 | * (at your option) any later version. |
13 | * |
14 | * This program is distributed in the hope that it will be useful, |
15 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
17 | * GNU General Public License for more details. |
18 | * |
19 | * You should have received a copy of the GNU General Public License along |
20 | * with this program; if not, write to the Free Software Foundation, Inc., |
21 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
22 | * http://www.gnu.org/copyleft/gpl.html |
23 | * |
24 | * @file |
25 | * @ingroup Dump |
26 | * @ingroup Maintenance |
27 | */ |
28 | |
29 | require_once __DIR__ . '/includes/BackupDumper.php'; |
30 | |
31 | class DumpBackup extends BackupDumper { |
32 | public function __construct( $args = null ) { |
33 | parent::__construct(); |
34 | |
35 | $this->addDescription( <<<TEXT |
36 | This script dumps the wiki page or logging database into an |
37 | XML interchange wrapper format for export or backup. |
38 | |
39 | XML output is sent to stdout; progress reports are sent to stderr. |
40 | |
41 | WARNING: this is not a full database dump! It is merely for public export |
42 | of your wiki. For full backup, see our online help at: |
43 | https://www.mediawiki.org/wiki/Backup |
44 | TEXT |
45 | ); |
46 | |
47 | // Actions |
48 | $this->addOption( 'full', 'Dump all revisions of every page' ); |
49 | $this->addOption( 'current', 'Dump only the latest revision of every page.' ); |
50 | $this->addOption( 'logs', 'Dump all log events' ); |
51 | $this->addOption( 'stable', 'Dump stable versions of pages' ); |
52 | $this->addOption( 'revrange', 'Dump range of revisions specified by revstart and ' . |
53 | 'revend parameters' ); |
54 | $this->addOption( 'orderrevs', 'Dump revisions in ascending revision order ' . |
55 | '(implies dump of a range of pages)' ); |
56 | $this->addOption( 'pagelist', |
57 | 'Dump only pages included in the file', false, true ); |
58 | // Options |
59 | $this->addOption( 'start', 'Start from page_id or log_id', false, true ); |
60 | $this->addOption( 'end', 'Stop before page_id or log_id n (exclusive)', false, true ); |
61 | $this->addOption( 'revstart', 'Start from rev_id', false, true ); |
62 | $this->addOption( 'revend', 'Stop before rev_id n (exclusive)', false, true ); |
63 | $this->addOption( 'skip-header', 'Don\'t output the <mediawiki> header' ); |
64 | $this->addOption( 'skip-footer', 'Don\'t output the </mediawiki> footer' ); |
65 | $this->addOption( 'stub', 'Don\'t perform old_text lookups; for 2-pass dump' ); |
66 | $this->addOption( 'uploads', 'Include upload records without files' ); |
67 | $this->addOption( 'include-files', 'Include files within the XML stream' ); |
68 | $this->addOption( 'namespaces', 'Limit to this comma-separated list of namespace numbers' ); |
69 | |
70 | if ( $args ) { |
71 | $this->loadWithArgv( $args ); |
72 | $this->processOptions(); |
73 | } |
74 | } |
75 | |
76 | public function execute() { |
77 | $this->processOptions(); |
78 | |
79 | $textMode = $this->hasOption( 'stub' ) ? WikiExporter::STUB : WikiExporter::TEXT; |
80 | |
81 | if ( $this->hasOption( 'full' ) ) { |
82 | $this->dump( WikiExporter::FULL, $textMode ); |
83 | } elseif ( $this->hasOption( 'current' ) ) { |
84 | $this->dump( WikiExporter::CURRENT, $textMode ); |
85 | } elseif ( $this->hasOption( 'stable' ) ) { |
86 | $this->dump( WikiExporter::STABLE, $textMode ); |
87 | } elseif ( $this->hasOption( 'logs' ) ) { |
88 | $this->dump( WikiExporter::LOGS ); |
89 | } elseif ( $this->hasOption( 'revrange' ) ) { |
90 | $this->dump( WikiExporter::RANGE, $textMode ); |
91 | } else { |
92 | $this->fatalError( 'No valid action specified.' ); |
93 | } |
94 | } |
95 | |
96 | protected function processOptions() { |
97 | parent::processOptions(); |
98 | |
99 | // Evaluate options specific to this class |
100 | $this->reporting = !$this->hasOption( 'quiet' ); |
101 | |
102 | if ( $this->hasOption( 'pagelist' ) ) { |
103 | $filename = $this->getOption( 'pagelist' ); |
104 | $pages = file( $filename ); |
105 | if ( $pages === false ) { |
106 | $this->fatalError( "Unable to open file {$filename}\n" ); |
107 | } |
108 | $pages = array_map( 'trim', $pages ); |
109 | $this->pages = array_filter( $pages, static function ( $x ) { |
110 | return $x !== ''; |
111 | } ); |
112 | } |
113 | |
114 | if ( $this->hasOption( 'start' ) ) { |
115 | $this->startId = intval( $this->getOption( 'start' ) ); |
116 | } |
117 | |
118 | if ( $this->hasOption( 'end' ) ) { |
119 | $this->endId = intval( $this->getOption( 'end' ) ); |
120 | } |
121 | |
122 | if ( $this->hasOption( 'revstart' ) ) { |
123 | $this->revStartId = intval( $this->getOption( 'revstart' ) ); |
124 | } |
125 | |
126 | if ( $this->hasOption( 'revend' ) ) { |
127 | $this->revEndId = intval( $this->getOption( 'revend' ) ); |
128 | } |
129 | |
130 | $this->skipHeader = $this->hasOption( 'skip-header' ); |
131 | $this->skipFooter = $this->hasOption( 'skip-footer' ); |
132 | $this->dumpUploads = $this->hasOption( 'uploads' ); |
133 | $this->dumpUploadFileContents = $this->hasOption( 'include-files' ); |
134 | $this->orderRevs = $this->hasOption( 'orderrevs' ); |
135 | if ( $this->hasOption( 'namespaces' ) ) { |
136 | $this->limitNamespaces = explode( ',', $this->getOption( 'namespaces' ) ); |
137 | } else { |
138 | $this->limitNamespaces = null; |
139 | } |
140 | } |
141 | } |
142 | |
143 | $maintClass = DumpBackup::class; |
144 | require_once RUN_MAINTENANCE_IF_MAIN; |