export.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Main export handling code
   5  *
   6  * @package PhpMyAdmin
   7  */
   8 use PMA\libraries\Encoding;
   9 use PMA\libraries\plugins\ExportPlugin;
  10 use PMA\libraries\URL;
  11 use PMA\libraries\Sanitize;
  12
  13 /**
  14  * Get the variables sent or posted to this script and a core script
  15  */
  16 /**
  17  * If we are sending the export file (as opposed to just displaying it
  18  * as text), we have to bypass the usual PMA\libraries\Response mechanism
  19  */
  20 if (isset($_POST['output_format']) && $_POST['output_format'] == 'sendit') {
  21     define('PMA_BYPASS_GET_INSTANCE', 1);
  22 }
  23 include_once 'libraries/common.inc.php';
  24 include_once 'libraries/plugin_interface.lib.php';
  25 include_once 'libraries/export.lib.php';
  26
  27 //check if it's the GET request to check export time out
  28 if (isset($_GET['check_time_out'])) {
  29     if (isset($_SESSION['pma_export_error'])) {
  30         $err = $_SESSION['pma_export_error'];
  31         unset($_SESSION['pma_export_error']);
  32         echo "timeout";
  33     } else {
  34         echo "success";
  35     }
  36     exit;
  37 }
  38 /**
  39  * Sets globals from $_POST
  40  *
  41  * - Please keep the parameters in order of their appearance in the form
  42  * - Some of these parameters are not used, as the code below directly
  43  *   verifies from the superglobal $_POST or $_REQUEST
  44  * TODO: this should be removed to avoid passing user input to GLOBALS
  45  * without checking
  46  */
  47 $post_params = array(
  48         'db',
  49         'table',
  50         'what',
  51         'single_table',
  52         'export_type',
  53         'export_method',
  54         'quick_or_custom',
  55         'db_select',
  56         'table_select',
  57         'table_structure',
  58         'table_data',
  59         'limit_to',
  60         'limit_from',
  61         'allrows',
  62         'lock_tables',
  63         'output_format',
  64         'filename_template',
  65         'maxsize',
  66         'remember_template',
  67         'charset',
  68         'compression',
  69         'as_separate_files',
  70         'knjenc',
  71         'xkana',
  72         'htmlword_structure_or_data',
  73         'htmlword_null',
  74         'htmlword_columns',
  75         'mediawiki_headers',
  76         'mediawiki_structure_or_data',
  77         'mediawiki_caption',
  78         'pdf_structure_or_data',
  79         'odt_structure_or_data',
  80         'odt_relation',
  81         'odt_comments',
  82         'odt_mime',
  83         'odt_columns',
  84         'odt_null',
  85         'codegen_structure_or_data',
  86         'codegen_format',
  87         'excel_null',
  88         'excel_removeCRLF',
  89         'excel_columns',
  90         'excel_edition',
  91         'excel_structure_or_data',
  92         'yaml_structure_or_data',
  93         'ods_null',
  94         'ods_structure_or_data',
  95         'ods_columns',
  96         'json_structure_or_data',
  97         'json_pretty_print',
  98         'xml_structure_or_data',
  99         'xml_export_events',
 100         'xml_export_functions',
 101         'xml_export_procedures',
 102         'xml_export_tables',
 103         'xml_export_triggers',
 104         'xml_export_views',
 105         'xml_export_contents',
 106         'texytext_structure_or_data',
 107         'texytext_columns',
 108         'texytext_null',
 109         'phparray_structure_or_data',
 110         'sql_include_comments',
 111         'sql_header_comment',
 112         'sql_dates',
 113         'sql_relation',
 114         'sql_mime',
 115         'sql_use_transaction',
 116         'sql_disable_fk',
 117         'sql_compatibility',
 118         'sql_structure_or_data',
 119         'sql_create_database',
 120         'sql_drop_table',
 121         'sql_procedure_function',
 122         'sql_create_table',
 123         'sql_create_view',
 124         'sql_create_trigger',
 125         'sql_if_not_exists',
 126         'sql_auto_increment',
 127         'sql_backquotes',
 128         'sql_truncate',
 129         'sql_delayed',
 130         'sql_ignore',
 131         'sql_type',
 132         'sql_insert_syntax',
 133         'sql_max_query_size',
 134         'sql_hex_for_binary',
 135         'sql_utc_time',
 136         'sql_drop_database',
 137         'sql_views_as_tables',
 138         'sql_metadata',
 139         'csv_separator',
 140         'csv_enclosed',
 141         'csv_escaped',
 142         'csv_terminated',
 143         'csv_null',
 144         'csv_removeCRLF',
 145         'csv_columns',
 146         'csv_structure_or_data',
 147         // csv_replace should have been here but we use it directly from $_POST
 148         'latex_caption',
 149         'latex_structure_or_data',
 150         'latex_structure_caption',
 151         'latex_structure_continued_caption',
 152         'latex_structure_label',
 153         'latex_relation',
 154         'latex_comments',
 155         'latex_mime',
 156         'latex_columns',
 157         'latex_data_caption',
 158         'latex_data_continued_caption',
 159         'latex_data_label',
 160         'latex_null',
 161         'aliases'
 162 );
 163
 164 foreach ($post_params as $one_post_param) {
 165     if (isset($_POST[$one_post_param])) {
 166         $GLOBALS[$one_post_param] = $_POST[$one_post_param];
 167     }
 168 }
 169
 170 $table = $GLOBALS['table'];
 171
 172 PMA\libraries\Util::checkParameters(array('what', 'export_type'));
 173
 174 // sanitize this parameter which will be used below in a file inclusion
 175 $what = PMA_securePath($_POST['what']);
 176
 177 // export class instance, not array of properties, as before
 178 /* @var $export_plugin ExportPlugin */
 179 $export_plugin = PMA_getPlugin(
 180     "export",
 181     $what,
 182     'libraries/plugins/export/',
 183     array(
 184         'export_type' => $export_type,
 185         'single_table' => isset($single_table)
 186     )
 187 );
 188
 189 // Backward compatibility
 190 $type = $what;
 191
 192 // Check export type
 193 if (empty($export_plugin)) {
 194     PMA_fatalError(__('Bad type!'));
 195 }
 196
 197 /**
 198  * valid compression methods
 199  */
 200 $compression_methods = array(
 201     'zip',
 202     'gzip'
 203 );
 204
 205 /**
 206  * init and variable checking
 207  */
 208 $compression = false;
 209 $onserver = false;
 210 $save_on_server = false;
 211 $buffer_needed = false;
 212 $back_button = '';
 213 $save_filename = '';
 214 $file_handle = '';
 215 $err_url = '';
 216 $filename = '';
 217 $separate_files = '';
 218
 219 // Is it a quick or custom export?
 220 if (isset($_REQUEST['quick_or_custom'])
 221     && $_REQUEST['quick_or_custom'] == 'quick'
 222 ) {
 223     $quick_export = true;
 224 } else {
 225     $quick_export = false;
 226 }
 227
 228 if ($_REQUEST['output_format'] == 'astext') {
 229     $asfile = false;
 230 } else {
 231     $asfile = true;
 232     if (isset($_REQUEST['as_separate_files'])
 233         && ! empty($_REQUEST['as_separate_files'])
 234     ) {
 235         if (isset($_REQUEST['compression'])
 236             && ! empty($_REQUEST['compression'])
 237             && $_REQUEST['compression'] == 'zip'
 238         ) {
 239             $separate_files = $_REQUEST['as_separate_files'];
 240         }
 241     }
 242     if (in_array($_REQUEST['compression'], $compression_methods)) {
 243         $compression = $_REQUEST['compression'];
 244         $buffer_needed = true;
 245     }
 246     if (($quick_export && ! empty($_REQUEST['quick_export_onserver']))
 247         || (! $quick_export && ! empty($_REQUEST['onserver']))
 248     ) {
 249         if ($quick_export) {
 250             $onserver = $_REQUEST['quick_export_onserver'];
 251         } else {
 252             $onserver = $_REQUEST['onserver'];
 253         }
 254         // Will we save dump on server?
 255         $save_on_server = ! empty($cfg['SaveDir']) && $onserver;
 256     }
 257 }
 258
 259 // Generate error url and check for needed variables
 260 if ($export_type == 'server') {
 261     $err_url = 'server_export.php' . URL::getCommon();
 262 } elseif ($export_type == 'database' && strlen($db) > 0) {
 263     $err_url = 'db_export.php' . URL::getCommon(array('db' => $db));
 264     // Check if we have something to export
 265     if (isset($table_select)) {
 266         $tables = $table_select;
 267     } else {
 268         $tables = array();
 269     }
 270 } elseif ($export_type == 'table' && strlen($db) > 0 && strlen($table) > 0) {
 271     $err_url = 'tbl_export.php' . URL::getCommon(
 272         array(
 273             'db' => $db, 'table' => $table
 274         )
 275     );
 276 } else {
 277     PMA_fatalError(__('Bad parameters!'));
 278 }
 279
 280 // Merge SQL Query aliases with Export aliases from
 281 // export page, Export page aliases are given more
 282 // preference over SQL Query aliases.
 283 $parser = new SqlParser\Parser($sql_query);
 284 $aliases = array();
 285 if ((!empty($parser->statements[0]))
 286     && ($parser->statements[0] instanceof SqlParser\Statements\SelectStatement)
 287 ) {
 288     $aliases = SqlParser\Utils\Misc::getAliases($parser->statements[0], $db);
 289 }
 290 if (!empty($_REQUEST['aliases'])) {
 291     $aliases = PMA_mergeAliases($aliases, $_REQUEST['aliases']);
 292     $_SESSION['tmpval']['aliases'] = $_REQUEST['aliases'];
 293 }
 294
 295 /**
 296  * Increase time limit for script execution and initializes some variables
 297  */
 298 @set_time_limit($cfg['ExecTimeLimit']);
 299 if (! empty($cfg['MemoryLimit'])) {
 300     @ini_set('memory_limit', $cfg['MemoryLimit']);
 301 }
 302 register_shutdown_function('PMA_shutdownDuringExport');
 303 // Start with empty buffer
 304 $dump_buffer = '';
 305 $dump_buffer_len = 0;
 306
 307 // Array of dump_buffers - used in separate file exports
 308 $dump_buffer_objects = array();
 309
 310 // We send fake headers to avoid browser timeout when buffering
 311 $time_start = time();
 312
 313 // Defines the default <CR><LF> format.
 314 // For SQL always use \n as MySQL wants this on all platforms.
 315 if ($what == 'sql') {
 316     $crlf = "\n";
 317 } else {
 318     $crlf = PMA\libraries\Util::whichCrlf();
 319 }
 320
 321 $output_kanji_conversion = Encoding::canConvertKanji() && $type != 'xls';
 322
 323 // Do we need to convert charset?
 324 $output_charset_conversion = $asfile
 325     && Encoding::isSupported()
 326     && isset($charset) && $charset != 'utf-8'
 327     && $type != 'xls';
 328
 329 // Use on the fly compression?
 330 $GLOBALS['onfly_compression'] = $GLOBALS['cfg']['CompressOnFly']
 331     && $compression == 'gzip';
 332 if ($GLOBALS['onfly_compression']) {
 333     $GLOBALS['memory_limit'] = PMA_getMemoryLimitForExport();
 334 }
 335
 336 // Generate filename and mime type if needed
 337 if ($asfile) {
 338     if (empty($remember_template)) {
 339         $remember_template = '';
 340     }
 341     list($filename, $mime_type) = PMA_getExportFilenameAndMimetype(
 342         $export_type, $remember_template, $export_plugin, $compression,
 343         $filename_template
 344     );
 345 } else {
 346     $mime_type = '';
 347 }
 348
 349 // Open file on server if needed
 350 if ($save_on_server) {
 351     list($save_filename, $message, $file_handle) = PMA_openExportFile(
 352         $filename, $quick_export
 353     );
 354
 355     // problem opening export file on server?
 356     if (! empty($message)) {
 357         PMA_showExportPage($db, $table, $export_type);
 358     }
 359 } else {
 360     /**
 361      * Send headers depending on whether the user chose to download a dump file
 362      * or not
 363      */
 364     if ($asfile) {
 365         // Download
 366         // (avoid rewriting data containing HTML with anchors and forms;
 367         // this was reported to happen under Plesk)
 368         @ini_set('url_rewriter.tags', '');
 369         $filename = Sanitize::sanitizeFilename($filename);
 370
 371         PMA_downloadHeader($filename, $mime_type);
 372     } else {
 373         // HTML
 374         if ($export_type == 'database') {
 375             $num_tables = count($tables);
 376             if ($num_tables == 0) {
 377                 $message = PMA\libraries\Message::error(
 378                     __('No tables found in database.')
 379                 );
 380                 $active_page = 'db_export.php';
 381                 include 'db_export.php';
 382                 exit();
 383             }
 384         }
 385         list($html, $back_button) = PMA_getHtmlForDisplayedExportHeader(
 386             $export_type, $db, $table
 387         );
 388         echo $html;
 389         unset($html);
 390     } // end download
 391 }
 392
 393 // Fake loop just to allow skip of remain of this code by break, I'd really
 394 // need exceptions here :-)
 395 do {
 396     // Re - initialize
 397     $dump_buffer = '';
 398     $dump_buffer_len = 0;
 399
 400     // Add possibly some comments to export
 401     if (! $export_plugin->exportHeader()) {
 402         break;
 403     }
 404
 405     // Will we need relation & co. setup?
 406     $do_relation = isset($GLOBALS[$what . '_relation']);
 407     $do_comments = isset($GLOBALS[$what . '_include_comments'])
 408         || isset($GLOBALS[$what . '_comments']);
 409     $do_mime     = isset($GLOBALS[$what . '_mime']);
 410     if ($do_relation || $do_comments || $do_mime) {
 411         $cfgRelation = PMA_getRelationsParam();
 412     }
 413     if ($do_mime) {
 414         include_once 'libraries/transformations.lib.php';
 415     }
 416
 417     // Include dates in export?
 418     $do_dates = isset($GLOBALS[$what . '_dates']);
 419
 420     $whatStrucOrData = $GLOBALS[$what . '_structure_or_data'];
 421
 422     /**
 423      * Builds the dump
 424      */
 425     if ($export_type == 'server') {
 426         if (! isset($db_select)) {
 427             $db_select = '';
 428         }
 429         PMA_exportServer(
 430             $db_select, $whatStrucOrData, $export_plugin, $crlf, $err_url,
 431             $export_type, $do_relation, $do_comments, $do_mime, $do_dates,
 432             $aliases, $separate_files
 433         );
 434     } elseif ($export_type == 'database') {
 435         if (!isset($table_structure) || !is_array($table_structure)) {
 436             $table_structure = array();
 437         }
 438         if (!isset($table_data) || !is_array($table_data)) {
 439             $table_data = array();
 440         }
 441         if (!empty($_REQUEST['structure_or_data_forced'])) {
 442             $table_structure = $tables;
 443             $table_data = $tables;
 444         }
 445         if (isset($lock_tables)) {
 446             PMA_lockTables($db, $tables, "READ");
 447             try {
 448                 PMA_exportDatabase(
 449                     $db, $tables, $whatStrucOrData, $table_structure,
 450                     $table_data, $export_plugin, $crlf, $err_url, $export_type,
 451                     $do_relation, $do_comments, $do_mime, $do_dates, $aliases,
 452                     $separate_files
 453                 );
 454             } finally {
 455                 PMA_unlockTables();
 456             }
 457         } else {
 458             PMA_exportDatabase(
 459                 $db, $tables, $whatStrucOrData, $table_structure, $table_data,
 460                 $export_plugin, $crlf, $err_url, $export_type, $do_relation,
 461                 $do_comments, $do_mime, $do_dates, $aliases, $separate_files
 462             );
 463         }
 464     } else {
 465         // We export just one table
 466         // $allrows comes from the form when "Dump all rows" has been selected
 467         if (! isset($allrows)) {
 468             $allrows = '';
 469         }
 470         if (! isset($limit_to)) {
 471             $limit_to = 0;
 472         }
 473         if (! isset($limit_from)) {
 474             $limit_from = 0;
 475         }
 476         if (isset($lock_tables)) {
 477             try {
 478                 PMA_lockTables($db, array($table), "READ");
 479                 PMA_exportTable(
 480                     $db, $table, $whatStrucOrData, $export_plugin, $crlf,
 481                     $err_url, $export_type, $do_relation, $do_comments,
 482                     $do_mime, $do_dates, $allrows, $limit_to, $limit_from,
 483                     $sql_query, $aliases
 484                 );
 485             } finally {
 486                 PMA_unlockTables();
 487             }
 488         } else {
 489             PMA_exportTable(
 490                 $db, $table, $whatStrucOrData, $export_plugin, $crlf, $err_url,
 491                 $export_type, $do_relation, $do_comments, $do_mime, $do_dates,
 492                 $allrows, $limit_to, $limit_from, $sql_query, $aliases
 493             );
 494         }
 495     }
 496     if (! $export_plugin->exportFooter()) {
 497         break;
 498     }
 499
 500 } while (false);
 501 // End of fake loop
 502
 503 if ($save_on_server && ! empty($message)) {
 504     PMA_showExportPage($db, $table, $export_type);
 505 }
 506
 507 /**
 508  * Send the dump as a file...
 509  */
 510 if (empty($asfile)) {
 511     echo PMA_getHtmlForDisplayedExportFooter($back_button);
 512     return;
 513 } // end if
 514
 515 // Convert the charset if required.
 516 if ($output_charset_conversion) {
 517     $dump_buffer = Encoding::convertString(
 518         'utf-8',
 519         $GLOBALS['charset'],
 520         $dump_buffer
 521     );
 522 }
 523
 524 // Compression needed?
 525 if ($compression) {
 526     if (! empty($separate_files)) {
 527         $dump_buffer = PMA_compressExport(
 528             $dump_buffer_objects, $compression, $filename
 529         );
 530     } else {
 531         $dump_buffer = PMA_compressExport($dump_buffer, $compression, $filename);
 532     }
 533
 534 }
 535
 536 /* If we saved on server, we have to close file now */
 537 if ($save_on_server) {
 538     $message = PMA_closeExportFile(
 539         $file_handle, $dump_buffer, $save_filename
 540     );
 541     PMA_showExportPage($db, $table, $export_type);
 542 } else {
 543     echo $dump_buffer;
 544 }