includes/export/Dump7ZipOutput.php

   1 <?php
   2 /**
   3  * Sends dump output via the p7zip compressor.
   4  *
   5  * Copyright © 2003, 2005, 2006 Brion Vibber <brion@pobox.com>
   6  * https://www.mediawiki.org/
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with this program; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  21  * http://www.gnu.org/copyleft/gpl.html
  22  *
  23  * @file
  24  */
  25
  26 /**
  27  * @ingroup Dump
  28  */
  29 class Dump7ZipOutput extends DumpPipeOutput {
  30         /**
  31          * @var int
  32          */
  33         protected $compressionLevel;
  34
  35         /**
  36          * @param string $file
  37          * @param int $cmpLevel Compression level passed to 7za command's -mx
  38          */
  39         function __construct( $file, $cmpLevel = 4 ) {
  40                 $this->compressionLevel = $cmpLevel;
  41                 $command = $this->setup7zCommand( $file );
  42                 parent::__construct( $command );
  43                 $this->filename = $file;
  44         }
  45
  46         /**
  47          * @param string $file
  48          * @return string
  49          */
  50         function setup7zCommand( $file ) {
  51                 $command = "7za a -bd -si -mx=";
  52                 $command .= wfEscapeShellArg( $this->compressionLevel ) . ' ';
  53                 $command .= wfEscapeShellArg( $file );
  54                 // Suppress annoying useless crap from p7zip
  55                 // Unfortunately this could suppress real error messages too
  56                 $command .= ' >' . wfGetNull() . ' 2>&1';
  57                 return $command;
  58         }
  59
  60         /**
  61          * @param string $newname
  62          * @param bool $open
  63          */
  64         function closeAndRename( $newname, $open = false ) {
  65                 $newname = $this->checkRenameArgCount( $newname );
  66                 if ( $newname ) {
  67                         fclose( $this->handle );
  68                         proc_close( $this->procOpenResource );
  69                         $this->renameOrException( $newname );
  70                         if ( $open ) {
  71                                 $command = $this->setup7zCommand( $this->filename );
  72                                 $this->startCommand( $command );
  73                         }
  74                 }
  75         }
  76 }