db_datadict.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Renders data dictionary
   5  *
   6  * @package PhpMyAdmin
   7  */
   8
   9 /**
  10  * Gets the variables sent or posted to this script, then displays headers
  11  */
  12 require_once 'libraries/common.inc.php';
  13
  14 if (! isset($selected_tbl)) {
  15     include 'libraries/db_common.inc.php';
  16     include 'libraries/db_info.inc.php';
  17 }
  18
  19 $response = PMA_Response::getInstance();
  20 $header   = $response->getHeader();
  21 $header->enablePrintView();
  22
  23 /**
  24  * Gets the relations settings
  25  */
  26 $cfgRelation  = PMA_getRelationsParam();
  27
  28 require_once 'libraries/transformations.lib.php';
  29 require_once 'libraries/Index.class.php';
  30
  31 /**
  32  * Check parameters
  33  */
  34 PMA_Util::checkParameters(array('db'));
  35
  36 /**
  37  * Defines the url to return to in case of error in a sql statement
  38  */
  39 $err_url = 'db_sql.php' . PMA_URL_getCommon(array('db' => $db));
  40
  41 if ($cfgRelation['commwork']) {
  42     $comment = PMA_getDbComment($db);
  43
  44     /**
  45      * Displays DB comment
  46      */
  47     if ($comment) {
  48         echo '<p>' . __('Database comment')
  49             . '<br /><i>' . htmlspecialchars($comment) . '</i></p>';
  50     } // end if
  51 }
  52
  53 /**
  54  * Selects the database and gets tables names
  55  */
  56 $GLOBALS['dbi']->selectDb($db);
  57 $tables = $GLOBALS['dbi']->getTables($db);
  58
  59 $count  = 0;
  60 foreach ($tables as $table) {
  61     $comments = PMA_getComments($db, $table);
  62
  63     echo '<div>' . "\n";
  64
  65     echo '<h2>' . htmlspecialchars($table) . '</h2>' . "\n";
  66
  67     /**
  68      * Gets table information
  69      */
  70     $show_comment = $GLOBALS['dbi']->getTable($db, $table)
  71         ->sGetStatusInfo('TABLE_COMMENT');
  72
  73     /**
  74      * Gets table keys and retains them
  75      */
  76     $GLOBALS['dbi']->selectDb($db);
  77     $indexes = $GLOBALS['dbi']->getTableIndexes($db, $table);
  78     list($primary, $pk_array, $indexes_info, $indexes_data)
  79         = PMA_Util::processIndexData($indexes);
  80
  81     /**
  82      * Gets columns properties
  83      */
  84     $columns = $GLOBALS['dbi']->getColumns($db, $table);
  85
  86     // Check if we can use Relations
  87     list($res_rel, $have_rel) = PMA_getRelationsAndStatus(
  88         ! empty($cfgRelation['relation']), $db, $table
  89     );
  90
  91     /**
  92      * Displays the comments of the table if MySQL >= 3.23
  93      */
  94     if (!empty($show_comment)) {
  95         echo __('Table comments:') . ' ';
  96         echo htmlspecialchars($show_comment) . '<br /><br />';
  97     }
  98
  99     /**
 100      * Displays the table structure
 101      */
 102
 103     echo '<table width="100%" class="print">';
 104     echo '<tr><th width="50">' . __('Column') . '</th>';
 105     echo '<th width="80">' . __('Type') . '</th>';
 106     echo '<th width="40">' . __('Null') . '</th>';
 107     echo '<th width="70">' . __('Default') . '</th>';
 108     if ($have_rel) {
 109         echo '    <th>' . __('Links to') . '</th>' . "\n";
 110     }
 111     echo '    <th>' . __('Comments') . '</th>' . "\n";
 112     if ($cfgRelation['mimework']) {
 113         echo '    <th>MIME</th>' . "\n";
 114     }
 115     echo '</tr>';
 116     $odd_row = true;
 117     foreach ($columns as $row) {
 118
 119         if ($row['Null'] == '') {
 120             $row['Null'] = 'NO';
 121         }
 122         $extracted_columnspec
 123             = PMA_Util::extractColumnSpec($row['Type']);
 124
 125         // reformat mysql query output
 126         // set or enum types: slashes single quotes inside options
 127
 128         $type = htmlspecialchars($extracted_columnspec['print_type']);
 129         $attribute     = $extracted_columnspec['attribute'];
 130         if (! isset($row['Default'])) {
 131             if ($row['Null'] != 'NO') {
 132                 $row['Default'] = '<i>NULL</i>';
 133             }
 134         } else {
 135             $row['Default'] = htmlspecialchars($row['Default']);
 136         }
 137         $column_name = $row['Field'];
 138
 139         echo '<tr class="';
 140         echo $odd_row ? 'odd' : 'even'; $odd_row = ! $odd_row;
 141         echo '">';
 142         echo '<td class="nowrap">';
 143         echo htmlspecialchars($column_name);
 144
 145         if (isset($pk_array[$row['Field']])) {
 146             echo ' <em>(' . __('Primary') . ')</em>';
 147         }
 148         echo '</td>';
 149         echo '<td'
 150             . PMA_Util::getClassForType(
 151                 $extracted_columnspec['type']
 152             )
 153             . ' lang="en" dir="ltr">' . $type . '</td>';
 154
 155         echo '<td>';
 156         echo (($row['Null'] == 'NO') ? __('No') : __('Yes'));
 157         echo '</td>';
 158         echo '<td class="nowrap">';
 159         if (isset($row['Default'])) {
 160             echo $row['Default'];
 161         }
 162         echo '</td>';
 163
 164         if ($have_rel) {
 165             echo '    <td>';
 166             if ($foreigner = PMA_searchColumnInForeigners($res_rel, $column_name)) {
 167                 echo htmlspecialchars(
 168                     $foreigner['foreign_table']
 169                     . ' -> '
 170                     . $foreigner['foreign_field']
 171                 );
 172             }
 173             echo '</td>' . "\n";
 174         }
 175         echo '    <td>';
 176         if (isset($comments[$column_name])) {
 177             echo htmlspecialchars($comments[$column_name]);
 178         }
 179         echo '</td>' . "\n";
 180         if ($cfgRelation['mimework']) {
 181             $mime_map = PMA_getMIME($db, $table, true);
 182
 183             echo '    <td>';
 184             if (isset($mime_map[$column_name])) {
 185                 echo htmlspecialchars(
 186                     str_replace('_', '/', $mime_map[$column_name]['mimetype'])
 187                 );
 188             }
 189             echo '</td>' . "\n";
 190         }
 191         echo '</tr>';
 192     } // end foreach
 193     $count++;
 194     echo '</table>';
 195     // display indexes information
 196     if (count(PMA_Index::getFromTable($table, $db)) > 0) {
 197         echo PMA_Index::getHtmlForIndexes($table, $db, true);
 198     }
 199     echo '</div>';
 200 } //ends main while
 201
 202 /**
 203  * Displays the footer
 204  */
 205 echo PMA_Util::getButton();