123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666 |
- <?php
- /* vim: set expandtab sw=4 ts=4 sts=4: */
- /**
- * HTML-Word export code
- *
- * @package PhpMyAdmin-Export
- * @subpackage HTML-Word
- */
- namespace PhpMyAdmin\Plugins\Export;
- use PhpMyAdmin\DatabaseInterface;
- use PhpMyAdmin\Export;
- use PhpMyAdmin\Plugins\ExportPlugin;
- use PhpMyAdmin\Properties\Plugins\ExportPluginProperties;
- use PhpMyAdmin\Properties\Options\Groups\OptionsPropertyMainGroup;
- use PhpMyAdmin\Properties\Options\Groups\OptionsPropertyRootGroup;
- use PhpMyAdmin\Properties\Options\Items\BoolPropertyItem;
- use PhpMyAdmin\Properties\Options\Items\RadioPropertyItem;
- use PhpMyAdmin\Properties\Options\Items\TextPropertyItem;
- use PhpMyAdmin\Relation;
- use PhpMyAdmin\Transformations;
- use PhpMyAdmin\Util;
- /**
- * Handles the export for the HTML-Word format
- *
- * @package PhpMyAdmin-Export
- * @subpackage HTML-Word
- */
- class ExportHtmlword extends ExportPlugin
- {
- /**
- * Constructor
- */
- public function __construct()
- {
- parent::__construct();
- $this->setProperties();
- }
- /**
- * Sets the export HTML-Word properties
- *
- * @return void
- */
- protected function setProperties()
- {
- $exportPluginProperties = new ExportPluginProperties();
- $exportPluginProperties->setText('Microsoft Word 2000');
- $exportPluginProperties->setExtension('doc');
- $exportPluginProperties->setMimeType('application/vnd.ms-word');
- $exportPluginProperties->setForceFile(true);
- $exportPluginProperties->setOptionsText(__('Options'));
- // create the root group that will be the options field for
- // $exportPluginProperties
- // this will be shown as "Format specific options"
- $exportSpecificOptions = new OptionsPropertyRootGroup(
- "Format Specific Options"
- );
- // what to dump (structure/data/both)
- $dumpWhat = new OptionsPropertyMainGroup(
- "dump_what", __('Dump table')
- );
- // create primary items and add them to the group
- $leaf = new RadioPropertyItem("structure_or_data");
- $leaf->setValues(
- array(
- 'structure' => __('structure'),
- 'data' => __('data'),
- 'structure_and_data' => __('structure and data'),
- )
- );
- $dumpWhat->addProperty($leaf);
- // add the main group to the root group
- $exportSpecificOptions->addProperty($dumpWhat);
- // data options main group
- $dataOptions = new OptionsPropertyMainGroup(
- "dump_what", __('Data dump options')
- );
- $dataOptions->setForce('structure');
- // create primary items and add them to the group
- $leaf = new TextPropertyItem(
- "null",
- __('Replace NULL with:')
- );
- $dataOptions->addProperty($leaf);
- $leaf = new BoolPropertyItem(
- "columns",
- __('Put columns names in the first row')
- );
- $dataOptions->addProperty($leaf);
- // add the main group to the root group
- $exportSpecificOptions->addProperty($dataOptions);
- // set the options for the export plugin property item
- $exportPluginProperties->setOptions($exportSpecificOptions);
- $this->properties = $exportPluginProperties;
- }
- /**
- * Outputs export header
- *
- * @return bool Whether it succeeded
- */
- public function exportHeader()
- {
- global $charset;
- return Export::outputHandler(
- '<html xmlns:o="urn:schemas-microsoft-com:office:office"
- xmlns:x="urn:schemas-microsoft-com:office:word"
- xmlns="http://www.w3.org/TR/REC-html40">
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"'
- . ' "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html>
- <head>
- <meta http-equiv="Content-type" content="text/html;charset='
- . (isset($charset) ? $charset : 'utf-8') . '" />
- </head>
- <body>'
- );
- }
- /**
- * Outputs export footer
- *
- * @return bool Whether it succeeded
- */
- public function exportFooter()
- {
- return Export::outputHandler('</body></html>');
- }
- /**
- * Outputs database header
- *
- * @param string $db Database name
- * @param string $db_alias Aliases of db
- *
- * @return bool Whether it succeeded
- */
- public function exportDBHeader($db, $db_alias = '')
- {
- if (empty($db_alias)) {
- $db_alias = $db;
- }
- return Export::outputHandler(
- '<h1>' . __('Database') . ' ' . htmlspecialchars($db_alias) . '</h1>'
- );
- }
- /**
- * Outputs database footer
- *
- * @param string $db Database name
- *
- * @return bool Whether it succeeded
- */
- public function exportDBFooter($db)
- {
- return true;
- }
- /**
- * Outputs CREATE DATABASE statement
- *
- * @param string $db Database name
- * @param string $export_type 'server', 'database', 'table'
- * @param string $db_alias Aliases of db
- *
- * @return bool Whether it succeeded
- */
- public function exportDBCreate($db, $export_type, $db_alias = '')
- {
- return true;
- }
- /**
- * Outputs the content of a table in HTML-Word format
- *
- * @param string $db database name
- * @param string $table table name
- * @param string $crlf the end of line sequence
- * @param string $error_url the url to go back in case of error
- * @param string $sql_query SQL query for obtaining data
- * @param array $aliases Aliases of db/table/columns
- *
- * @return bool Whether it succeeded
- */
- public function exportData(
- $db,
- $table,
- $crlf,
- $error_url,
- $sql_query,
- array $aliases = array()
- ) {
- global $what;
- $db_alias = $db;
- $table_alias = $table;
- $this->initAlias($aliases, $db_alias, $table_alias);
- if (!Export::outputHandler(
- '<h2>'
- . __('Dumping data for table') . ' ' . htmlspecialchars($table_alias)
- . '</h2>'
- )
- ) {
- return false;
- }
- if (!Export::outputHandler(
- '<table class="width100" cellspacing="1">'
- )
- ) {
- return false;
- }
- // Gets the data from the database
- $result = $GLOBALS['dbi']->query(
- $sql_query,
- DatabaseInterface::CONNECT_USER,
- DatabaseInterface::QUERY_UNBUFFERED
- );
- $fields_cnt = $GLOBALS['dbi']->numFields($result);
- // If required, get fields name at the first line
- if (isset($GLOBALS['htmlword_columns'])) {
- $schema_insert = '<tr class="print-category">';
- for ($i = 0; $i < $fields_cnt; $i++) {
- $col_as = $GLOBALS['dbi']->fieldName($result, $i);
- if (!empty($aliases[$db]['tables'][$table]['columns'][$col_as])) {
- $col_as = $aliases[$db]['tables'][$table]['columns'][$col_as];
- }
- $col_as = stripslashes($col_as);
- $schema_insert .= '<td class="print"><strong>'
- . htmlspecialchars($col_as)
- . '</strong></td>';
- } // end for
- $schema_insert .= '</tr>';
- if (!Export::outputHandler($schema_insert)) {
- return false;
- }
- } // end if
- // Format the data
- while ($row = $GLOBALS['dbi']->fetchRow($result)) {
- $schema_insert = '<tr class="print-category">';
- for ($j = 0; $j < $fields_cnt; $j++) {
- if (!isset($row[$j]) || is_null($row[$j])) {
- $value = $GLOBALS[$what . '_null'];
- } elseif ($row[$j] == '0' || $row[$j] != '') {
- $value = $row[$j];
- } else {
- $value = '';
- }
- $schema_insert .= '<td class="print">'
- . htmlspecialchars($value)
- . '</td>';
- } // end for
- $schema_insert .= '</tr>';
- if (!Export::outputHandler($schema_insert)) {
- return false;
- }
- } // end while
- $GLOBALS['dbi']->freeResult($result);
- return Export::outputHandler('</table>');
- }
- /**
- * Returns a stand-in CREATE definition to resolve view dependencies
- *
- * @param string $db the database name
- * @param string $view the view name
- * @param string $crlf the end of line sequence
- * @param array $aliases Aliases of db/table/columns
- *
- * @return string resulting definition
- */
- public function getTableDefStandIn($db, $view, $crlf, $aliases = array())
- {
- $schema_insert = '<table class="width100" cellspacing="1">'
- . '<tr class="print-category">'
- . '<th class="print">'
- . __('Column')
- . '</th>'
- . '<td class="print"><strong>'
- . __('Type')
- . '</strong></td>'
- . '<td class="print"><strong>'
- . __('Null')
- . '</strong></td>'
- . '<td class="print"><strong>'
- . __('Default')
- . '</strong></td>'
- . '</tr>';
- /**
- * Get the unique keys in the view
- */
- $unique_keys = array();
- $keys = $GLOBALS['dbi']->getTableIndexes($db, $view);
- foreach ($keys as $key) {
- if ($key['Non_unique'] == 0) {
- $unique_keys[] = $key['Column_name'];
- }
- }
- $columns = $GLOBALS['dbi']->getColumns($db, $view);
- foreach ($columns as $column) {
- $col_as = $column['Field'];
- if (!empty($aliases[$db]['tables'][$view]['columns'][$col_as])) {
- $col_as = $aliases[$db]['tables'][$view]['columns'][$col_as];
- }
- $schema_insert .= $this->formatOneColumnDefinition(
- $column,
- $unique_keys,
- $col_as
- );
- $schema_insert .= '</tr>';
- }
- $schema_insert .= '</table>';
- return $schema_insert;
- }
- /**
- * Returns $table's CREATE definition
- *
- * @param string $db the database name
- * @param string $table the table name
- * @param bool $do_relation whether to include relation comments
- * @param bool $do_comments whether to include the pmadb-style column
- * comments as comments in the structure;
- * this is deprecated but the parameter is
- * left here because export.php calls
- * PMA_exportStructure() also for other
- * export types which use this parameter
- * @param bool $do_mime whether to include mime comments
- * at the end
- * @param bool $view whether we're handling a view
- * @param array $aliases Aliases of db/table/columns
- *
- * @return string resulting schema
- */
- public function getTableDef(
- $db,
- $table,
- $do_relation,
- $do_comments,
- $do_mime,
- $view = false,
- array $aliases = array()
- ) {
- // set $cfgRelation here, because there is a chance that it's modified
- // since the class initialization
- global $cfgRelation;
- $schema_insert = '';
- /**
- * Gets fields properties
- */
- $GLOBALS['dbi']->selectDb($db);
- // Check if we can use Relations
- list($res_rel, $have_rel) = $this->relation->getRelationsAndStatus(
- $do_relation && !empty($cfgRelation['relation']),
- $db,
- $table
- );
- /**
- * Displays the table structure
- */
- $schema_insert .= '<table class="width100" cellspacing="1">';
- $schema_insert .= '<tr class="print-category">';
- $schema_insert .= '<th class="print">'
- . __('Column')
- . '</th>';
- $schema_insert .= '<td class="print"><strong>'
- . __('Type')
- . '</strong></td>';
- $schema_insert .= '<td class="print"><strong>'
- . __('Null')
- . '</strong></td>';
- $schema_insert .= '<td class="print"><strong>'
- . __('Default')
- . '</strong></td>';
- if ($do_relation && $have_rel) {
- $schema_insert .= '<td class="print"><strong>'
- . __('Links to')
- . '</strong></td>';
- }
- if ($do_comments) {
- $schema_insert .= '<td class="print"><strong>'
- . __('Comments')
- . '</strong></td>';
- $comments = $this->relation->getComments($db, $table);
- }
- if ($do_mime && $cfgRelation['mimework']) {
- $schema_insert .= '<td class="print"><strong>'
- . htmlspecialchars('MIME')
- . '</strong></td>';
- $mime_map = Transformations::getMIME($db, $table, true);
- }
- $schema_insert .= '</tr>';
- $columns = $GLOBALS['dbi']->getColumns($db, $table);
- /**
- * Get the unique keys in the table
- */
- $unique_keys = array();
- $keys = $GLOBALS['dbi']->getTableIndexes($db, $table);
- foreach ($keys as $key) {
- if ($key['Non_unique'] == 0) {
- $unique_keys[] = $key['Column_name'];
- }
- }
- foreach ($columns as $column) {
- $col_as = $column['Field'];
- if (!empty($aliases[$db]['tables'][$table]['columns'][$col_as])) {
- $col_as = $aliases[$db]['tables'][$table]['columns'][$col_as];
- }
- $schema_insert .= $this->formatOneColumnDefinition(
- $column,
- $unique_keys,
- $col_as
- );
- $field_name = $column['Field'];
- if ($do_relation && $have_rel) {
- $schema_insert .= '<td class="print">'
- . htmlspecialchars(
- $this->getRelationString(
- $res_rel,
- $field_name,
- $db,
- $aliases
- )
- )
- . '</td>';
- }
- if ($do_comments && $cfgRelation['commwork']) {
- $schema_insert .= '<td class="print">'
- . (isset($comments[$field_name])
- ? htmlspecialchars($comments[$field_name])
- : '') . '</td>';
- }
- if ($do_mime && $cfgRelation['mimework']) {
- $schema_insert .= '<td class="print">'
- . (isset($mime_map[$field_name]) ?
- htmlspecialchars(
- str_replace('_', '/', $mime_map[$field_name]['mimetype'])
- )
- : '') . '</td>';
- }
- $schema_insert .= '</tr>';
- } // end foreach
- $schema_insert .= '</table>';
- return $schema_insert;
- }
- /**
- * Outputs triggers
- *
- * @param string $db database name
- * @param string $table table name
- *
- * @return string Formatted triggers list
- */
- protected function getTriggers($db, $table)
- {
- $dump = '<table class="width100" cellspacing="1">';
- $dump .= '<tr class="print-category">';
- $dump .= '<th class="print">' . __('Name') . '</th>';
- $dump .= '<td class="print"><strong>' . __('Time') . '</strong></td>';
- $dump .= '<td class="print"><strong>' . __('Event') . '</strong></td>';
- $dump .= '<td class="print"><strong>' . __('Definition') . '</strong></td>';
- $dump .= '</tr>';
- $triggers = $GLOBALS['dbi']->getTriggers($db, $table);
- foreach ($triggers as $trigger) {
- $dump .= '<tr class="print-category">';
- $dump .= '<td class="print">'
- . htmlspecialchars($trigger['name'])
- . '</td>'
- . '<td class="print">'
- . htmlspecialchars($trigger['action_timing'])
- . '</td>'
- . '<td class="print">'
- . htmlspecialchars($trigger['event_manipulation'])
- . '</td>'
- . '<td class="print">'
- . htmlspecialchars($trigger['definition'])
- . '</td>'
- . '</tr>';
- }
- $dump .= '</table>';
- return $dump;
- }
- /**
- * Outputs table's structure
- *
- * @param string $db database name
- * @param string $table table name
- * @param string $crlf the end of line sequence
- * @param string $error_url the url to go back in case of error
- * @param string $export_mode 'create_table', 'triggers', 'create_view',
- * 'stand_in'
- * @param string $export_type 'server', 'database', 'table'
- * @param bool $do_relation whether to include relation comments
- * @param bool $do_comments whether to include the pmadb-style column
- * comments as comments in the structure;
- * this is deprecated but the parameter is
- * left here because export.php calls
- * PMA_exportStructure() also for other
- * export types which use this parameter
- * @param bool $do_mime whether to include mime comments
- * @param bool $dates whether to include creation/update/check dates
- * @param array $aliases Aliases of db/table/columns
- *
- * @return bool Whether it succeeded
- */
- public function exportStructure(
- $db,
- $table,
- $crlf,
- $error_url,
- $export_mode,
- $export_type,
- $do_relation = false,
- $do_comments = false,
- $do_mime = false,
- $dates = false,
- array $aliases = array()
- ) {
- $db_alias = $db;
- $table_alias = $table;
- $this->initAlias($aliases, $db_alias, $table_alias);
- $dump = '';
- switch ($export_mode) {
- case 'create_table':
- $dump .= '<h2>'
- . __('Table structure for table') . ' '
- . htmlspecialchars($table_alias)
- . '</h2>';
- $dump .= $this->getTableDef(
- $db,
- $table,
- $do_relation,
- $do_comments,
- $do_mime,
- false,
- $aliases
- );
- break;
- case 'triggers':
- $dump = '';
- $triggers = $GLOBALS['dbi']->getTriggers($db, $table);
- if ($triggers) {
- $dump .= '<h2>'
- . __('Triggers') . ' ' . htmlspecialchars($table_alias)
- . '</h2>';
- $dump .= $this->getTriggers($db, $table);
- }
- break;
- case 'create_view':
- $dump .= '<h2>'
- . __('Structure for view') . ' ' . htmlspecialchars($table_alias)
- . '</h2>';
- $dump .= $this->getTableDef(
- $db,
- $table,
- $do_relation,
- $do_comments,
- $do_mime,
- true,
- $aliases
- );
- break;
- case 'stand_in':
- $dump .= '<h2>'
- . __('Stand-in structure for view') . ' '
- . htmlspecialchars($table_alias)
- . '</h2>';
- // export a stand-in definition to resolve view dependencies
- $dump .= $this->getTableDefStandIn($db, $table, $crlf, $aliases);
- } // end switch
- return Export::outputHandler($dump);
- }
- /**
- * Formats the definition for one column
- *
- * @param array $column info about this column
- * @param array $unique_keys unique keys of the table
- * @param string $col_alias Column Alias
- *
- * @return string Formatted column definition
- */
- protected function formatOneColumnDefinition(
- array $column,
- array $unique_keys,
- $col_alias = ''
- ) {
- if (empty($col_alias)) {
- $col_alias = $column['Field'];
- }
- $definition = '<tr class="print-category">';
- $extracted_columnspec = Util::extractColumnSpec($column['Type']);
- $type = htmlspecialchars($extracted_columnspec['print_type']);
- if (empty($type)) {
- $type = ' ';
- }
- if (!isset($column['Default'])) {
- if ($column['Null'] != 'NO') {
- $column['Default'] = 'NULL';
- }
- }
- $fmt_pre = '';
- $fmt_post = '';
- if (in_array($column['Field'], $unique_keys)) {
- $fmt_pre = '<strong>' . $fmt_pre;
- $fmt_post = $fmt_post . '</strong>';
- }
- if ($column['Key'] == 'PRI') {
- $fmt_pre = '<em>' . $fmt_pre;
- $fmt_post = $fmt_post . '</em>';
- }
- $definition .= '<td class="print">' . $fmt_pre
- . htmlspecialchars($col_alias) . $fmt_post . '</td>';
- $definition .= '<td class="print">' . htmlspecialchars($type) . '</td>';
- $definition .= '<td class="print">'
- . (($column['Null'] == '' || $column['Null'] == 'NO')
- ? __('No')
- : __('Yes'))
- . '</td>';
- $definition .= '<td class="print">'
- . htmlspecialchars(isset($column['Default']) ? $column['Default'] : '')
- . '</td>';
- return $definition;
- }
- }
|