/usr/share/phpmyadmin/libraries/classes
Edit: /usr/share/phpmyadmin/libraries/classes/Export.php (47351B)
dbi = $dbi;
}
/**
* Sets a session variable upon a possible fatal error during export
*/
public function shutdown(): void
{
$error = error_get_last();
if ($error == null || ! mb_strpos($error['message'], 'execution time')) {
return;
}
//set session variable to check if there was error while exporting
$_SESSION['pma_export_error'] = $error['message'];
}
/**
* Detect ob_gzhandler
*/
public function isGzHandlerEnabled(): bool
{
return in_array('ob_gzhandler', ob_list_handlers());
}
/**
* Detect whether gzencode is needed; it might not be needed if
* the server is already compressing by itself
*
* @return bool Whether gzencode is needed
*/
public function gzencodeNeeded(): bool
{
/*
* We should gzencode only if the function exists
* but we don't want to compress twice, therefore
* gzencode only if transparent compression is not enabled
* and gz compression was not asked via $cfg['OBGzip']
* but transparent compression does not apply when saving to server
*/
$chromeAndGreaterThan43 = PMA_USR_BROWSER_AGENT == 'CHROME'
&& PMA_USR_BROWSER_VER >= 43; // see bug #4942
return function_exists('gzencode')
&& ((! ini_get('zlib.output_compression')
&& ! $this->isGzHandlerEnabled())
|| $GLOBALS['save_on_server']
|| $chromeAndGreaterThan43);
}
/**
* Output handler for all exports, if needed buffering, it stores data into
* $dump_buffer, otherwise it prints them out.
*
* @param string $line the insert statement
*
* @return bool Whether output succeeded
*/
public function outputHandler(?string $line): bool
{
global $time_start, $dump_buffer, $dump_buffer_len, $save_filename;
// Kanji encoding convert feature
if ($GLOBALS['output_kanji_conversion']) {
$line = Encoding::kanjiStrConv(
$line,
$GLOBALS['knjenc'],
$GLOBALS['xkana'] ?? ''
);
}
// If we have to buffer data, we will perform everything at once at the end
if ($GLOBALS['buffer_needed']) {
$dump_buffer .= $line;
if ($GLOBALS['onfly_compression']) {
$dump_buffer_len += strlen((string) $line);
if ($dump_buffer_len > $GLOBALS['memory_limit']) {
if ($GLOBALS['output_charset_conversion']) {
$dump_buffer = Encoding::convertString(
'utf-8',
$GLOBALS['charset'],
$dump_buffer
);
}
if ($GLOBALS['compression'] === 'gzip'
&& $this->gzencodeNeeded()
) {
// as a gzipped file
// without the optional parameter level because it bugs
$dump_buffer = gzencode($dump_buffer);
}
if ($GLOBALS['save_on_server']) {
$write_result = @fwrite($GLOBALS['file_handle'], (string) $dump_buffer);
// Here, use strlen rather than mb_strlen to get the length
// in bytes to compare against the number of bytes written.
if ($write_result != strlen((string) $dump_buffer)) {
$GLOBALS['message'] = Message::error(
__('Insufficient space to save the file %s.')
);
$GLOBALS['message']->addParam($save_filename);
return false;
}
} else {
echo $dump_buffer;
}
$dump_buffer = '';
$dump_buffer_len = 0;
}
} else {
$time_now = time();
if ($time_start >= $time_now + 30) {
$time_start = $time_now;
header('X-pmaPing: Pong');
}
}
} elseif ($GLOBALS['asfile']) {
if ($GLOBALS['output_charset_conversion']) {
$line = Encoding::convertString(
'utf-8',
$GLOBALS['charset'],
$line
);
}
if ($GLOBALS['save_on_server'] && mb_strlen((string) $line) > 0) {
if ($GLOBALS['file_handle'] !== null) {
$write_result = @fwrite($GLOBALS['file_handle'], (string) $line);
} else {
$write_result = false;
}
// Here, use strlen rather than mb_strlen to get the length
// in bytes to compare against the number of bytes written.
if (! $write_result
|| $write_result != strlen((string) $line)
) {
$GLOBALS['message'] = Message::error(
__('Insufficient space to save the file %s.')
);
$GLOBALS['message']->addParam($save_filename);
return false;
}
$time_now = time();
if ($time_start >= $time_now + 30) {
$time_start = $time_now;
header('X-pmaPing: Pong');
}
} else {
// We export as file - output normally
echo $line;
}
} else {
// We export as html - replace special chars
echo htmlspecialchars((string) $line);
}
return true;
}
/**
* Returns HTML containing the footer for a displayed export
*
* @param string $back_button the link for going Back
* @param string $refreshButton the link for refreshing page
*
* @return string the HTML output
*/
public function getHtmlForDisplayedExportFooter(
string $back_button,
string $refreshButton
): string {
/**
* Close the html tags and add the footers for on-screen export
*/
return ''
. ' '
. '
'
// bottom back button
. $back_button
. $refreshButton
. '
'
. '' . "\n";
}
/**
* Computes the memory limit for export
*
* @return int the memory limit
*/
public function getMemoryLimit(): int
{
$memory_limit = trim((string) ini_get('memory_limit'));
$memory_limit_num = (int) substr($memory_limit, 0, -1);
$lowerLastChar = strtolower(substr($memory_limit, -1));
// 2 MB as default
if (empty($memory_limit) || $memory_limit == '-1') {
$memory_limit = 2 * 1024 * 1024;
} elseif ($lowerLastChar === 'm') {
$memory_limit = $memory_limit_num * 1024 * 1024;
} elseif ($lowerLastChar === 'k') {
$memory_limit = $memory_limit_num * 1024;
} elseif ($lowerLastChar === 'g') {
$memory_limit = $memory_limit_num * 1024 * 1024 * 1024;
} else {
$memory_limit = (int) $memory_limit;
}
// Some of memory is needed for other things and as threshold.
// During export I had allocated (see memory_get_usage function)
// approx 1.2MB so this comes from that.
if ($memory_limit > 1500000) {
$memory_limit -= 1500000;
}
// Some memory is needed for compression, assume 1/3
$memory_limit /= 8;
return $memory_limit;
}
/**
* Returns the filename and MIME type for a compression and an export plugin
*
* @param ExportPlugin $exportPlugin the export plugin
* @param string $compression compression asked
* @param string $filename the filename
*
* @return string[] the filename and mime type
*/
public function getFinalFilenameAndMimetypeForFilename(
ExportPlugin $exportPlugin,
string $compression,
string $filename
): array {
// Grab basic dump extension and mime type
// Check if the user already added extension;
// get the substring where the extension would be if it was included
$extensionStartPos = mb_strlen($filename) - mb_strlen(
$exportPlugin->getProperties()->getExtension()
) - 1;
$userExtension = mb_substr(
$filename,
$extensionStartPos,
mb_strlen($filename)
);
$requiredExtension = '.' . $exportPlugin->getProperties()->getExtension();
if (mb_strtolower($userExtension) != $requiredExtension) {
$filename .= $requiredExtension;
}
$mime_type = $exportPlugin->getProperties()->getMimeType();
// If dump is going to be compressed, set correct mime_type and add
// compression to extension
if ($compression === 'gzip') {
$filename .= '.gz';
$mime_type = 'application/x-gzip';
} elseif ($compression === 'zip') {
$filename .= '.zip';
$mime_type = 'application/zip';
}
return [
$filename,
$mime_type,
];
}
/**
* Return the filename and MIME type for export file
*
* @param string $export_type type of export
* @param string $remember_template whether to remember template
* @param ExportPlugin $export_plugin the export plugin
* @param string $compression compression asked
* @param string $filename_template the filename template
*
* @return string[] the filename template and mime type
*/
public function getFilenameAndMimetype(
string $export_type,
string $remember_template,
ExportPlugin $export_plugin,
string $compression,
string $filename_template
): array {
if ($export_type === 'server') {
if (! empty($remember_template)) {
$GLOBALS['PMA_Config']->setUserValue(
'pma_server_filename_template',
'Export/file_template_server',
$filename_template
);
}
} elseif ($export_type === 'database') {
if (! empty($remember_template)) {
$GLOBALS['PMA_Config']->setUserValue(
'pma_db_filename_template',
'Export/file_template_database',
$filename_template
);
}
} elseif ($export_type === 'raw') {
if (! empty($remember_template)) {
$GLOBALS['PMA_Config']->setUserValue(
'pma_raw_filename_template',
'Export/file_template_raw',
$filename_template
);
}
} else {
if (! empty($remember_template)) {
$GLOBALS['PMA_Config']->setUserValue(
'pma_table_filename_template',
'Export/file_template_table',
$filename_template
);
}
}
$filename = Util::expandUserString($filename_template);
// remove dots in filename (coming from either the template or already
// part of the filename) to avoid a remote code execution vulnerability
$filename = Sanitize::sanitizeFilename($filename, true);
return $this->getFinalFilenameAndMimetypeForFilename(
$export_plugin,
$compression,
$filename
);
}
/**
* Open the export file
*
* @param string $filename the export filename
* @param bool $quick_export whether it's a quick export or not
*
* @return array the full save filename, possible message and the file handle
*/
public function openFile(string $filename, bool $quick_export): array
{
$file_handle = null;
$message = '';
$doNotSaveItOver = true;
if (isset($_POST['quick_export_onserver_overwrite'])) {
$doNotSaveItOver = $_POST['quick_export_onserver_overwrite'] !== 'saveitover';
}
$save_filename = Util::userDir($GLOBALS['cfg']['SaveDir'])
. preg_replace('@[/\\\\]@', '_', $filename);
if (@file_exists($save_filename)
&& ((! $quick_export && empty($_POST['onserver_overwrite']))
|| ($quick_export
&& $doNotSaveItOver))
) {
$message = Message::error(
__(
'File %s already exists on server, '
. 'change filename or check overwrite option.'
)
);
$message->addParam($save_filename);
} elseif (@is_file($save_filename) && ! @is_writable($save_filename)) {
$message = Message::error(
__(
'The web server does not have permission '
. 'to save the file %s.'
)
);
$message->addParam($save_filename);
} else {
$file_handle = @fopen($save_filename, 'w');
if ($file_handle === false) {
$message = Message::error(
__(
'The web server does not have permission '
. 'to save the file %s.'
)
);
$message->addParam($save_filename);
}
}
return [
$save_filename,
$message,
$file_handle,
];
}
/**
* Close the export file
*
* @param resource $file_handle the export file handle
* @param string $dump_buffer the current dump buffer
* @param string $save_filename the export filename
*
* @return Message a message object (or empty string)
*/
public function closeFile(
$file_handle,
string $dump_buffer,
string $save_filename
): Message {
$write_result = @fwrite($file_handle, $dump_buffer);
fclose($file_handle);
// Here, use strlen rather than mb_strlen to get the length
// in bytes to compare against the number of bytes written.
if (strlen($dump_buffer) > 0
&& (! $write_result || $write_result != strlen($dump_buffer))
) {
$message = new Message(
__('Insufficient space to save the file %s.'),
Message::ERROR,
[$save_filename]
);
} else {
$message = new Message(
__('Dump has been saved to file %s.'),
Message::SUCCESS,
[$save_filename]
);
}
return $message;
}
/**
* Compress the export buffer
*
* @param array|string $dump_buffer the current dump buffer
* @param string $compression the compression mode
* @param string $filename the filename
*
* @return array|string|bool
*/
public function compress($dump_buffer, string $compression, string $filename)
{
if ($compression === 'zip' && function_exists('gzcompress')) {
$zipExtension = new ZipExtension();
$filename = substr($filename, 0, -4); // remove extension (.zip)
$dump_buffer = $zipExtension->createFile($dump_buffer, $filename);
} elseif ($compression === 'gzip' && $this->gzencodeNeeded() && is_string($dump_buffer)) {
// without the optional parameter level because it bugs
$dump_buffer = gzencode($dump_buffer);
}
return $dump_buffer;
}
/**
* Saves the dump_buffer for a particular table in an array
* Used in separate files export
*
* @param string $object_name the name of current object to be stored
* @param bool $append optional boolean to append to an existing index or not
*/
public function saveObjectInBuffer(string $object_name, bool $append = false): void
{
global $dump_buffer_objects, $dump_buffer, $dump_buffer_len;
if (! empty($dump_buffer)) {
if ($append && isset($dump_buffer_objects[$object_name])) {
$dump_buffer_objects[$object_name] .= $dump_buffer;
} else {
$dump_buffer_objects[$object_name] = $dump_buffer;
}
}
// Re - initialize
$dump_buffer = '';
$dump_buffer_len = 0;
}
/**
* Returns HTML containing the header for a displayed export
*
* @param string $export_type the export type
* @param string $db the database name
* @param string $table the table name
*
* @return string[] the generated HTML and back button
*/
public function getHtmlForDisplayedExportHeader(
string $export_type,
string $db,
string $table
): array {
$html = '