forum/Sources/DumpDatabase.php

<?php
/******************************************************************************
* DumpDatabase.php                                                            *
*******************************************************************************
* SMF: Simple Machines Forum                                                  *
* Open-Source Project Inspired by Zef Hemel (zef@zefhemel.com)                *
* =========================================================================== *
* Software Version:           SMF 1.0                                         *
* Software by:                Simple Machines (http://www.simplemachines.org) *
* Copyright 2001-2004 by:     Lewis Media (http://www.lewismedia.com)         *
* Support, News, Updates at:  http://www.simplemachines.org                   *
*******************************************************************************
* This program is free software; you may redistribute it and/or modify it     *
* under the terms of the provided license as published by Lewis Media.        *
*                                                                             *
* This program is distributed in the hope that it is and will be useful,      *
* but WITHOUT ANY WARRANTIES; without even any implied warranty of            *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                        *
*                                                                             *
* See the "license.txt" file for details of the Simple Machines license.      *
* The latest version can always be found at http://www.simplemachines.org.    *
******************************************************************************/
if (!defined('SMF'))
	die('Hacking attempt...');

/*	This file has a single job - database backup.  Note that, because of the
	nature of its output, it uses the mysql_query() function instead of
	db_query(), so errors won't be outputted.

	void DumpDatabase2()
		- writes all of the database to standard output.
		- uses gzip compression if compress is set in the URL/post data.
		- may possibly time out in some cases.
		- the data dumped depends on whether "struct" and "data" are passed.
		- requires an administrator and the session hash by get.
		- is accessed via ?action=dumpdb.

	string getTableContent(string table_name)
		- gets all the necessary INSERTs for the table named table_name.
		- goes in 250 row segments.
		- returns the query to insert the data back in.
		- returns an empty string if the table was empty.

	string getTableSQLData(string table_name)
		- dumps the CREATE for the specified table. (by table_name.)
		- returns the CREATE statement.
*/

// Dumps the database to a file.
function DumpDatabase2()
{
	global $db_name, $db_prefix, $scripturl, $context, $modSettings, $crlf, $db_connection;

	// Administrators only!
	if (!allowedTo('admin_forum'))
		fatal_lang_error('no_dump_database');

	// You can't dump nothing!
	if (!isset($_GET['struct']) && !isset($_GET['data']))
		$_GET['data'] = true;

	checkSession('get');

	// Attempt to stop from dying...
	@set_time_limit(600);

	// Start saving the output... (don't do it otherwise for memory reasons.)
	if (isset($_REQUEST['compress']) && function_exists('gzencode'))
	{
		// Make sure we're gzipping output, but then say we're not in the header ^_^.
		if (empty($modSettings['enableCompressedOutput']))
			@ob_start('ob_gzhandler');
		// Try to clean any data already outputted.
		elseif (ob_get_length() != 0)
		{
			ob_end_clean();
			@ob_start('ob_gzhandler');
		}

		// Send faked headers so it will just save the compressed output as a gzip.
		header('Content-Type: application/x-gzip');
		header('Accept-Ranges: bytes');
		header('Content-Encoding: none');

		// Gecko browsers... don't like this. (Mozilla, Firefox, etc.)
		if (!$context['browser']['is_gecko'])
			header('Content-Transfer-Encoding: binary');

		// The file extension will include .gz...
		$extension = '.sql.gz';
	}
	else
	{
		// Get rid of the gzipping alreading being done.
		if (!empty($modSettings['enableCompressedOutput']))
			@ob_end_clean();
		// If we can, clean anything already sent from the output buffer...
		elseif (function_exists('ob_clean') && ob_get_length() != 0)
			ob_clean();

		// Tell the client to save this file, even though it's text.
		header('Content-Type: application/octetstream');
		header('Content-Encoding: none');

		// This time the extension should just be .sql.
		$extension = '.sql';
	}

	// This should turn off the session URL parser.
	$scripturl = '';

	// Send the proper headers to let them download this file.
	header('Content-Disposition: filename="' . $db_name . '-' . (empty($_GET['struct']) ? 'data' : (empty($_GET['data']) ? 'structure' : 'complete')) . '_' . strftime('%Y-%m-%d') . $extension . '"');
	header('Cache-Control: private');
	header('Connection: close');

	// This makes things simpler when using it so very very often.
	$crlf = "\r\n";

	// SQL Dump Header.
	echo
		'# ==========================================================', $crlf,
		'#', $crlf,
		'# Database dump of tables in `', $db_name, '`', $crlf,
		'# ', timeformat(time(), false), $crlf,
		'#', $crlf,
		'# ==========================================================', $crlf,
		$crlf;

	// Get all tables in the database....
	$queryTables = mysql_query("
		SHOW TABLES
		LIKE '" . strtr($db_prefix, array('_' => '\\_', '%' => '\\%')) . "%'", $db_connection);

	// Dump each table.
	while ($tableName = mysql_fetch_row($queryTables))
	{
		// Are we dumping the structures?
		if (isset($_GET['struct']))
		{
			echo
				$crlf,
				'#', $crlf,
				'# Table structure for table `', $tableName[0], '`', $crlf,
				'#', $crlf,
				$crlf,
				'DROP TABLE IF EXISTS `', $tableName[0], '`;', $crlf,
				$crlf,
				getTableSQLData($tableName[0]), ';', $crlf;
		}

		// How about the data?
		if (!isset($_GET['data']))
			continue;

		// Are there any rows in this table?
		$get_rows = getTableContent($tableName[0]);

		// No rows to get - skip it.
		if (empty($get_rows))
			continue;

		echo
			$crlf,
			'#', $crlf,
			'# Dumping data in `', $tableName[0], '`', $crlf,
			'#', $crlf,
			$crlf,
			$get_rows,
			'# --------------------------------------------------------', $crlf;
	}

	echo
		$crlf,
		'# Done', $crlf;

	exit;
}

// Get the content (INSERTs) for a table.
function getTableContent($tableName)
{
	global $crlf, $db_connection;

	// Get everything from the table.
	$result = mysql_query("
		SELECT *
		FROM `$tableName`", $db_connection);

	// The number of rows, just for record keeping and breaking INSERTs up.
	$num_rows = mysql_num_rows($result);
	$current_row = 0;

	if ($num_rows == 0)
		return '';

	$fields = array_keys(mysql_fetch_assoc($result));
	mysql_data_seek($result, 0);

	// Start it off with the basic INSERT INTO.
	$data = 'INSERT INTO `' . $tableName . '`' . $crlf . "\t(`" . implode('`, `', $fields) . '`)' . $crlf . 'VALUES ';

	// Loop through each row.
	while ($row = mysql_fetch_row($result))
	{
		$current_row++;

		// Get the fields in this row...
		$field_list = array();
		for ($j = 0; $j < mysql_num_fields($result); $j++)
		{
			// Try to figure out the type of each field. (NULL, number, or 'string'.)
			if (!isset($row[$j]))
				$field_list[] = 'NULL';
			elseif (is_numeric($row[$j]))
				$field_list[] = $row[$j];
			else
				$field_list[] = "'" . mysql_escape_string($row[$j]) . "'";
		}

		// 'Insert' the data.
		$data .= '(' . implode(', ', $field_list) . ')';

		// Start a new INSERT statement after every 250....
		if ($current_row > 249 && $current_row % 250 == 0)
			$data .= ';' . $crlf . 'INSERT INTO `' . $tableName . '`' . $crlf . "\t(`" . implode('`, `', $fields) . '`)' . $crlf . 'VALUES ';
		// All done!
		elseif ($current_row == $num_rows)
			$data .= ';' . $crlf;
		// Otherwise, go to the next line.
		else
			$data .= ',' . $crlf . "\t";
	}
	mysql_free_result($result);

	// Return an empty string if there were no rows.
	return $data;
}

// Get the schema (CREATE) for a table.
function getTableSQLData($tableName)
{
	global $crlf, $db_connection;

	// Start the create table...
	$schema_create = 'CREATE TABLE `' . $tableName . '` (' . $crlf;

	// Find all the fields.
	$result = mysql_query("
		SHOW FIELDS
		FROM `$tableName`", $db_connection);
	while ($row = mysql_fetch_assoc($result))
	{
		// Make the CREATE for this column.
		$schema_create .= '  ' . $row['Field'] . ' ' . $row['Type'] . ($row['Null'] != 'YES' ? ' NOT NULL' : '');

		// Add a default...?
		if (isset($row['Default']))
			$schema_create .= ' default ' . (is_numeric($row['Default']) ? $row['Default'] : "'" . mysql_escape_string($row['Default']) . "'");

		// And now any extra information. (such as auto_increment.)
		$schema_create .= ($row['Extra'] != '' ? ' ' . $row['Extra'] : '') . ',' . $crlf;
	}
	mysql_free_result($result);

	// Take off the last comma.
	$schema_create = substr($schema_create, 0, -strlen($crlf) - 1);

	// Find the keys.
	$result = mysql_query("
		SHOW KEYS
		FROM `$tableName`", $db_connection);
	$indexes = array();
	while ($row = mysql_fetch_array($result))
	{
		// IS this a primary key, unique index, or regular index?
		$row['Key_name'] = $row['Key_name'] == 'PRIMARY' ? 'PRIMARY KEY' : (empty($row['Non_unique']) ? 'UNIQUE ' : ($row['Comment'] == 'FULLTEXT' ? 'FULLTEXT ' : 'KEY ')) . $row['Key_name'];

		// Is this the first column in the index?
		if (empty($indexes[$row['Key_name']]))
			$indexes[$row['Key_name']] = array();

		// A sub part, like only indexing 15 characters of a varchar.
		if (!empty($row['Sub_part']))
			$indexes[$row['Key_name']][$row['Seq_in_index']] = $row['Column_name'] . '(' . $row['Sub_part'] . ')';
		else
			$indexes[$row['Key_name']][$row['Seq_in_index']] = $row['Column_name'];
	}
	mysql_free_result($result);

	// Build the CREATEs for the keys.
	foreach ($indexes as $keyname => $columns)
	{
		// Ensure the columns are in proper order.
		ksort($columns);

		$schema_create .= ',' . $crlf . '  ' . $keyname . ' (' . implode($columns, ', ') . ')';
	}

	// Now just get the comment and type... (MyISAM, etc.)
	$result = mysql_query("
		SHOW TABLE STATUS
		LIKE '" . strtr($tableName, array('_' => '\\_', '%' => '\\%')) . "'", $db_connection);
	$row = mysql_fetch_assoc($result);
	mysql_free_result($result);

	// Probably MyISAM.... and it might have a comment.
	$schema_create .= $crlf . ') TYPE=' . (isset($row['Type']) ? $row['Type'] : $row['Engine']) . ($row['Comment'] != '' ? ' COMMENT="' . $row['Comment'] . '"' : '');

	return $schema_create;
}

?>