libraries/export/htmlword.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Set of functions used to export a set of queries to a MS Word document
   5  *
   6  * @package PhpMyAdmin-Export
   7  * @subpackage HTMLWord
   8  */
   9 if (! defined('PHPMYADMIN')) {
  10     exit;
  11 }
  12
  13 /**
  14  *
  15  */
  16 if (isset($plugin_list)) {
  17     $plugin_list['htmlword'] = array(
  18         'text' => __('Microsoft Word 2000'),
  19         'extension' => 'doc',
  20         'mime_type' => 'application/vnd.ms-word',
  21         'force_file' => true,
  22         'options' => array(
  23             /* what to dump (structure/data/both) */
  24             array('type' => 'begin_group', 'name' => 'dump_what', 'text' => __('Dump table')),
  25             array('type' => 'radio', 'name' => 'structure_or_data', 'values' => array('structure' => __('structure'), 'data' => __('data'), 'structure_and_data' => __('structure and data'))),
  26             array('type' => 'end_group'),
  27             /* data options */
  28             array('type' => 'begin_group', 'name' => 'data', 'text' => __('Data dump options'), 'force' => 'structure'),
  29             array('type' => 'text', 'name' => 'null', 'text' => __('Replace NULL with:')),
  30             array('type' => 'bool', 'name' => 'columns', 'text' => __('Put columns names in the first row')),
  31             array('type' => 'end_group'),
  32             ),
  33         'options_text' => __('Options'),
  34         );
  35 } else {
  36
  37     /**
  38      * Outputs export footer
  39      *
  40      * @return  bool        Whether it suceeded
  41      *
  42      * @access  public
  43      */
  44     function PMA_exportFooter() {
  45         return PMA_exportOutputHandler('</body></html>');
  46     }
  47
  48     /**
  49      * Outputs export header
  50      *
  51      * @return  bool        Whether it suceeded
  52      *
  53      * @access  public
  54      */
  55     function PMA_exportHeader() {
  56         global $charset_of_file;
  57         return PMA_exportOutputHandler('<html xmlns:o="urn:schemas-microsoft-com:office:office"
  58     xmlns:x="urn:schemas-microsoft-com:office:word"
  59     xmlns="http://www.w3.org/TR/REC-html40">
  60
  61     <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  62     <html>
  63     <head>
  64         <meta http-equiv="Content-type" content="text/html;charset=' . (isset($charset_of_file) ? $charset_of_file : 'utf-8') . '" />
  65     </head>
  66     <body>');
  67     }
  68
  69     /**
  70      * Outputs database header
  71      *
  72      * @param string  $db Database name
  73      * @return  bool        Whether it suceeded
  74      *
  75      * @access  public
  76      */
  77     function PMA_exportDBHeader($db) {
  78         return PMA_exportOutputHandler('<h1>' . __('Database') . ' ' . htmlspecialchars($db) . '</h1>');
  79     }
  80
  81     /**
  82      * Outputs database footer
  83      *
  84      * @param string  $db Database name
  85      * @return  bool        Whether it suceeded
  86      *
  87      * @access  public
  88      */
  89     function PMA_exportDBFooter($db) {
  90         return true;
  91     }
  92
  93     /**
  94      * Outputs CREATE DATABASE statement
  95      *
  96      * @param string  $db Database name
  97      * @return  bool        Whether it suceeded
  98      *
  99      * @access  public
 100      */
 101     function PMA_exportDBCreate($db) {
 102         return true;
 103     }
 104
 105     /**
 106      * Outputs the content of a table in HTML (Microsoft Word) format
 107      *
 108      * @param string  $db         database name
 109      * @param string  $table      table name
 110      * @param string  $crlf       the end of line sequence
 111      * @param string  $error_url  the url to go back in case of error
 112      * @param string  $sql_query  SQL query for obtaining data
 113      * @return  bool        Whether it suceeded
 114      *
 115      * @access  public
 116      */
 117     function PMA_exportData($db, $table, $crlf, $error_url, $sql_query)
 118     {
 119         global $what;
 120
 121         if (! PMA_exportOutputHandler('<h2>' . __('Dumping data for table') . ' ' . htmlspecialchars($table) . '</h2>')) {
 122             return false;
 123         }
 124         if (! PMA_exportOutputHandler('<table class="width100" cellspacing="1">')) {
 125             return false;
 126         }
 127
 128         // Gets the data from the database
 129         $result      = PMA_DBI_query($sql_query, null, PMA_DBI_QUERY_UNBUFFERED);
 130         $fields_cnt  = PMA_DBI_num_fields($result);
 131
 132         // If required, get fields name at the first line
 133         if (isset($GLOBALS['htmlword_columns'])) {
 134             $schema_insert = '<tr class="print-category">';
 135             for ($i = 0; $i < $fields_cnt; $i++) {
 136                 $schema_insert .= '<td class="print"><b>' . htmlspecialchars(stripslashes(PMA_DBI_field_name($result, $i))) . '</b></td>';
 137             } // end for
 138             $schema_insert .= '</tr>';
 139             if (! PMA_exportOutputHandler($schema_insert)) {
 140                 return false;
 141             }
 142         } // end if
 143
 144         // Format the data
 145         while ($row = PMA_DBI_fetch_row($result)) {
 146             $schema_insert = '<tr class="print-category">';
 147             for ($j = 0; $j < $fields_cnt; $j++) {
 148                 if (! isset($row[$j]) || is_null($row[$j])) {
 149                     $value = $GLOBALS[$what . '_null'];
 150                 } elseif ($row[$j] == '0' || $row[$j] != '') {
 151                     $value = $row[$j];
 152                 } else {
 153                     $value = '';
 154                 }
 155                 $schema_insert .= '<td class="print">' . htmlspecialchars($value) . '</td>';
 156             } // end for
 157             $schema_insert .= '</tr>';
 158             if (! PMA_exportOutputHandler($schema_insert)) {
 159                 return false;
 160             }
 161         } // end while
 162         PMA_DBI_free_result($result);
 163         if (! PMA_exportOutputHandler('</table>')) {
 164             return false;
 165         }
 166
 167         return true;
 168     }
 169
 170     /**
 171      * Outputs table's structure
 172      *
 173      * @param string  $db           database name
 174      * @param string  $table        table name
 175      * @param string  $crlf         the end of line sequence
 176      * @param string  $error_url    the url to go back in case of error
 177      * @param bool    $do_relation  whether to include relation comments
 178      * @param bool    $do_comments  whether to include the pmadb-style column comments
 179      *                                as comments in the structure; this is deprecated
 180      *                                but the parameter is left here because export.php
 181      *                                calls PMA_exportStructure() also for other export
 182      *                                types which use this parameter
 183      * @param bool    $do_mime      whether to include mime comments
 184      * @param bool    $dates        whether to include creation/update/check dates
 185      * @param string  $export_mode  'create_table', 'triggers', 'create_view', 'stand_in'
 186      * @param string  $export_type  'server', 'database', 'table'
 187      * @return  bool      Whether it suceeded
 188      *
 189      * @access  public
 190      */
 191     function PMA_exportStructure($db, $table, $crlf, $error_url, $do_relation = false, $do_comments = false, $do_mime = false, $dates = false, $export_mode, $export_type)
 192     {
 193         global $cfgRelation;
 194
 195         if (! PMA_exportOutputHandler('<h2>' . __('Table structure for table') . ' ' . htmlspecialchars($table) . '</h2>')) {
 196             return false;
 197         }
 198
 199         /**
 200          * Get the unique keys in the table
 201          */
 202         $unique_keys = array();
 203         $keys        = PMA_DBI_get_table_indexes($db, $table);
 204         foreach ($keys as $key) {
 205             if ($key['Non_unique'] == 0) {
 206                 $unique_keys[] = $key['Column_name'];
 207             }
 208         }
 209
 210         /**
 211          * Gets fields properties
 212          */
 213         PMA_DBI_select_db($db);
 214
 215         // Check if we can use Relations
 216         if ($do_relation && ! empty($cfgRelation['relation'])) {
 217             // Find which tables are related with the current one and write it in
 218             // an array
 219             $res_rel = PMA_getForeigners($db, $table);
 220
 221             if ($res_rel && count($res_rel) > 0) {
 222                 $have_rel = true;
 223             } else {
 224                 $have_rel = false;
 225             }
 226         } else {
 227                $have_rel = false;
 228         } // end if
 229
 230         /**
 231          * Displays the table structure
 232          */
 233         if (! PMA_exportOutputHandler('<table class="width100" cellspacing="1">')) {
 234             return false;
 235         }
 236
 237         $columns_cnt = 4;
 238         if ($do_relation && $have_rel) {
 239             $columns_cnt++;
 240         }
 241         if ($do_comments && $cfgRelation['commwork']) {
 242             $columns_cnt++;
 243         }
 244         if ($do_mime && $cfgRelation['mimework']) {
 245             $columns_cnt++;
 246         }
 247
 248         $schema_insert = '<tr class="print-category">';
 249         $schema_insert .= '<th class="print">' . __('Column') . '</th>';
 250         $schema_insert .= '<td class="print"><b>' . __('Type') . '</b></td>';
 251         $schema_insert .= '<td class="print"><b>' . __('Null') . '</b></td>';
 252         $schema_insert .= '<td class="print"><b>' . __('Default') . '</b></td>';
 253         if ($do_relation && $have_rel) {
 254             $schema_insert .= '<td class="print"><b>' . __('Links to') . '</b></td>';
 255         }
 256         if ($do_comments) {
 257             $schema_insert .= '<td class="print"><b>' . __('Comments') . '</b></td>';
 258             $comments = PMA_getComments($db, $table);
 259         }
 260         if ($do_mime && $cfgRelation['mimework']) {
 261             $schema_insert .= '<td class="print"><b>' . htmlspecialchars('MIME') . '</b></td>';
 262             $mime_map = PMA_getMIME($db, $table, true);
 263         }
 264         $schema_insert .= '</tr>';
 265
 266         if (! PMA_exportOutputHandler($schema_insert)) {
 267             return false;
 268         }
 269
 270         $columns = PMA_DBI_get_columns($db, $table);
 271         foreach ($columns as $column) {
 272
 273             $schema_insert = '<tr class="print-category">';
 274
 275             $extracted_fieldspec = PMA_extractFieldSpec($column['Type']);
 276             $type = htmlspecialchars($extracted_fieldspec['print_type']);
 277             if (empty($type)) {
 278                 $type     = '&nbsp;';
 279             }
 280
 281             if (! isset($column['Default'])) {
 282                 if ($column['Null'] != 'NO') {
 283                     $column['Default'] = 'NULL';
 284                 }
 285             }
 286
 287             $fmt_pre = '';
 288             $fmt_post = '';
 289             if (in_array($column['Field'], $unique_keys)) {
 290                 $fmt_pre = '<b>' . $fmt_pre;
 291                 $fmt_post = $fmt_post . '</b>';
 292             }
 293             if ($column['Key'] == 'PRI') {
 294                 $fmt_pre = '<i>' . $fmt_pre;
 295                 $fmt_post = $fmt_post . '</i>';
 296             }
 297             $schema_insert .= '<td class="print">' . $fmt_pre . htmlspecialchars($column['Field']) . $fmt_post . '</td>';
 298             $schema_insert .= '<td class="print">' . htmlspecialchars($type) . '</td>';
 299             $schema_insert .= '<td class="print">' . (($column['Null'] == '' || $column['Null'] == 'NO') ? __('No') : __('Yes')) . '</td>';
 300             $schema_insert .= '<td class="print">' . htmlspecialchars(isset($column['Default']) ? $column['Default'] : '') . '</td>';
 301
 302             $field_name = $column['Field'];
 303
 304             if ($do_relation && $have_rel) {
 305                 $schema_insert .= '<td class="print">' . (isset($res_rel[$field_name]) ? htmlspecialchars($res_rel[$field_name]['foreign_table'] . ' (' . $res_rel[$field_name]['foreign_field'] . ')') : '') . '</td>';
 306             }
 307             if ($do_comments && $cfgRelation['commwork']) {
 308                 $schema_insert .= '<td class="print">' . (isset($comments[$field_name]) ? htmlspecialchars($comments[$field_name]) : '') . '</td>';
 309             }
 310             if ($do_mime && $cfgRelation['mimework']) {
 311                 $schema_insert .= '<td class="print">' . (isset($mime_map[$field_name]) ? htmlspecialchars(str_replace('_', '/', $mime_map[$field_name]['mimetype'])) : '') . '</td>';
 312             }
 313
 314             $schema_insert .= '</tr>';
 315
 316             if (! PMA_exportOutputHandler($schema_insert)) {
 317                 return false;
 318             }
 319         } // end while
 320
 321         return PMA_exportOutputHandler('</table>');
 322     }
 323
 324 }
 325 ?>