Source for file backupdatabase.php

Documentation is available at backupdatabase.php

  1. <?php
  2. /**
  3. * Create a dump of the database for backup purposes
  4. *
  5. * @author    Stuart Prescott
  6. * @copyright  Copyright Stuart Prescott
  7. * @license    http://opensource.org/licenses/gpl-license.php GNU Public License
  8. * @version    $Id$
  9. * @package    Bumblebee
  10. * @subpackage Actions
  11. *
  12. *  path (bumblebee root)/inc/actions/backupdatabase.php
  13. */
  14.  
  15. /** Load ancillary functions */
  16. require_once 'inc/typeinfo.php';
  17. checkValidInclude();
  18.  
  19. require_once 'inc/bb/configreader.php';
  20.  
  21. /** parent object */
  22. require_once 'inc/actions/bufferedaction.php';
  23. /** status codes for success/failure of database actions */
  24. require_once 'inc/statuscodes.php';
  25.  
  26. /**
  27. * Create a dump of the database for backup purposes
  28. * @package    Bumblebee
  29. * @subpackage Actions
  30. */
  31. class ActionBackupDB extends BufferedAction {
  32.  
  33.   /**
  34.   * Initialising the class
  35.   *
  36.   * @param  BumblebeeAuth $auth  Authorisation object
  37.   * @param  array $pdata   extra state data from the call path
  38.   * @return void nothing
  39.   */
  40.   function ActionBackupDB($auth, $pdata) {
  41.     parent::BufferedAction($auth, $pdata);
  42.   }
  43.  
  44.   function go() {
  45.     $success = $this->makeDump();
  46.     //echo $success;
  47.     //echo $this->errorMessage;
  48.     echo $this->reportAction($success,
  49.               array(STATUS_ERR =>  T_('Error making backup: ').$this->errorMessage
  50.                    )
  51.                );
  52.   }
  53.  
  54.   /**
  55.   * Make the sql dump and save it to memory for output later
  56.   */
  57.   function makeDump() {
  58.     // get a MySQL dump of the database
  59.     $conf = ConfigReader::getInstance();
  60.     $output = array();
  61.     $retstring = exec($this->_mysqldump_invocation() .' 2>&1',
  62.                 $output,
  63.                 $returnError);
  64.     $dump = join($output, "\n");
  65.     if ($returnError) {
  66.       return $this->unbufferForError($dump);
  67.     } else {
  68.       // $dump now contains the data stream.
  69.       // let's work out a nice filename and dump it out
  70.       $this->filename = $this->getFilename('backup', $conf->value('database', 'dbname'), 'sql');
  71.       $this->bufferedStream = $dump;
  72.       // the data itself will be dumped later by the action driver (index.php)
  73.     }
  74.   }
  75.  
  76.  
  77.   /**
  78.   * Send the sql dump to the browser immediately
  79.   * (can't be used if you have heavy HTML templates)
  80.   */
  81.   function godirect() {
  82.     $this->startOutputTextFile($filename);
  83.     system($this->_mysqldump_invocation(),
  84.                 $returnError);
  85.   }
  86.  
  87.   /**
  88.   * Obtain the correct mysqldump command line to make the backup
  89.   */
  90.   function _mysqldump_invocation() {
  91.     $conf = ConfigReader::getInstance();
  92.     return $conf->value('sqldump', 'mysqldump').' '
  93.                 .$conf->value('sqldump', 'options')
  94.                 .' --host='.escapeshellarg($conf->value('database', 'host'))
  95.                 .' --user='.escapeshellarg($conf->value('database', 'username'))
  96.                 .' --password='.escapeshellarg($conf->value('database', 'passwd'))
  97.                 .' '.escapeshellarg($conf->value('database', 'database'))
  98.             ;
  99.   }
  100. }
  101.  
  102. ?>

Documentation generated on Tue, 06 Mar 2007 10:00:37 +0000 by phpDocumentor 1.3.0