=====DbInfo Action===== //Now implemented as a [[WikkaBetaFeatures beta feature]] on this server.// >>==See also:== Documentation: ~-[[Docs:DbInfoActionInfo DbInfoActionInfo]] Supporting code: ~-AdvancedFormOpen ~-GenerateUniqueId >>This is the development page for the DbInfo action.::c:: ====What==== Just a little action that provides Admins an easy way to inspect the **structure** of the tables Wikka is using. (It's not a data browser!) ====Why==== Admins, and especially admins that like to tweak Wikka and create their own extensions, frequently need to check what exactly the database structure is that Wikka is using. Column names and sizes, indexes, and such are importantthings to know when creating extensions. Of course it's possible to use an external client like ""PhpMyAdmin"" or a desktop client but for a quick lookup it's handy to have that information available right inside Wikka. ====How==== Although the PHP implementation of MySQL provides a few shortcuts with special functions, these don't support all information that we need. However, the MySQL **##SHOW##** command can reveal all we need to know, and it can be used with the PHP PHP:mysql_query function. ===Limitations=== Since revealing database structure is a potential security risk, only adminstrators will be able to see what this little action has on offer. Apart from that, it makes use of the configured Wikka database user; what this user can see, really depends on what permissions it has been given prior to installation of Wikka, so your mileage may vary. ===The Code=== Save as **##actions/dbinfo.php##**: %%(php;1)IsAdmin(); $database = $this->config['mysql_database']; $prefix = $this->config['table_prefix']; // ---------------------- processsing -------------------------- // --------------- get parameters ---------------- if ($isAdmin) { if (is_array($vars)) { foreach ($vars as $param => $value) { switch ($param) { case 'all': if ($value == 1) $bAll = TRUE; break; case 'prefix': if ($value == 0) $bPrefix = FALSE; break; } } } } // ------------------ get data ------------------- if ($isAdmin) { // list of databases to choose from $aDbList = array(); if ($bAll) { $query = 'SHOW DATABASES'; $tableresult = mysql_query($query); if ($tableresult) { while ($row = mysql_fetch_assoc($tableresult)) { $aDbList[] = $row['Database']; } } else # catch-all if no databases are / can be shown { $aDbList[] = $database; } } else { $aDbList[] = $database; } // data for selected database if ($bAll) { if (isset($_POST['dbselect']) || isset($_POST['tableselect'])) # form submitted { if (isset($_POST['seldb']) && in_array($_POST['seldb'],$aDbList)) # valid choice { $seldb = $_POST['seldb']; } else # ignore invalid choice { $seldb = $database; } } } else { $seldb = $database; # no choice: wikka database } if (isset($seldb)) { $query = 'SHOW CREATE DATABASE '.$seldb; $dbcreateresult = mysql_query($query); if ($dbcreateresult) { $row = mysql_fetch_assoc($dbcreateresult); $dbcreate = $row['Create Database']; } } // table list $aTableList = array(); if (isset($seldb)) { $query = 'SHOW TABLES FROM '.$seldb; if ($bPrefix) { $pattern = $prefix.'%'; $query .= " LIKE '".$pattern."'"; } $tablelistresult = mysql_query($query); if ($tablelistresult) { $colname = 'Tables_in_'.$seldb; if ($bPrefix) { $colname .= ' ('.$pattern.')'; } while ($row = mysql_fetch_assoc($tablelistresult)) { $aTableList[] = $row[$colname]; } } } // data for selected table if (isset($_POST['tableselect'])) # form submitted { if (isset($_POST['seltable']) && in_array($_POST['seltable'],$aTableList)) # valid choice { $seltable = $_POST['seltable']; $query = 'SHOW CREATE TABLE '.$seltable; $tablecreateresult = mysql_query($query); if ($tablecreateresult) { $row = mysql_fetch_assoc($tablecreateresult); $tablecreate = $row['Create Table']; } } } } // ---------------- build forms ------------------ if ($isAdmin) { // build datatabase selection form if more than one database to show if (count($aDbList) > 1) { $dbselform = $this->FormOpen('','','POST','dbsel'); $dbselform .= '
'."\n"; $dbselform .= ' '.FORM_SELDB_LEGEND.''."\n"; $dbselform .= ' '."\n"; $dbselform .= ' \n"; $dbselform .= ' '."\n"; $dbselform .= "
\n"; $dbselform .= $this->FormClose(); } else { $dbselmsg = '

'.sprintf(MSG_SINGLE_DB,$aDbList[0])."

\n"; } // build table selection form if (isset($seldb)) { if (count($aTableList) > 0) { $tableselform = $this->FormOpen('','','POST','tablesel'); $tableselform .= ''."\n"; $tableselform .= '
'."\n"; $tableselform .= ' '.FORM_SELTABLE_LEGEND.''."\n"; $tableselform .= ' '."\n"; $tableselform .= ' \n"; $tableselform .= ' '."\n"; $tableselform .= "
\n"; $tableselform .= $this->FormClose(); } else { $tableselmsg = '

'.sprintf(MSG_NO_TABLES,$seldb)."

\n"; } } // build results if (isset($seldb)) { $hdDbDdl = sprintf(HD_DB_CREATE_DDL,$seldb); if (isset($dbcreate)) { $dbresult = $this->Format('% %(sql)'.$dbcreate.'% %'); } else { $dbresult = '

'.sprintf(MSG_NO_DB_DDL,$seldb).'

'; } if (isset($seltable)) { $hdTableDdl = sprintf(HD_TABLE_CREATE_DDL,$seltable); if (isset($tablecreate)) { $tableresult = $this->Format('% %(sql)'.$tablecreate.'% %'); } else { $tableresult = '

'.sprintf(MSG_NO_TABLE_DDL,$seltable).'

'; } } } // ids - use constant for variable-content heading $idDbInfo = $this->makeId('div','dbinfo'); $idDbDdl = $this->makeId('hn','ddl_for_database'); $idTableDdl = $this->makeId('hn','ddl_for_table'); } // ------------ show data and forms -------------- echo '
'."\n"; echo '

'.$hdDbInfo.'

'."\n"; if ($isAdmin) { echo '

'.$txtActionInfo."

\n"; echo '

'.$hdDatabase.'

'."\n"; if (isset($dbselform)) { echo $dbselform; } elseif (isset($dbselmsg)) { echo $dbselmsg; } if (isset($seldb)) { echo "
\n"; echo '
'.$hdDbDdl.'
'."\n"; echo $dbresult; echo "
\n"; echo '

'.$hdTables.'

'."\n"; if (isset($tableselform)) { echo $tableselform; } elseif (isset($tableselmsg)) { echo $tableselmsg; } if (isset($seltable)) { echo "
\n"; echo '
'.$hdTableDdl.'
'."\n"; echo $tableresult; } } echo "
\n"; } else { echo '

'.$msgOnlyAdmin."

\n"; } ?> %% ''Make sure to replace all occurrences of '**% %**' with '**""%%""**'!'' ====Supporting methods==== As can be seen (and is documented in the docblock) the new ##""DbInfo()""## action uses two methods that are themselves beta features - both of them documented already: [[AdvancedFormOpen FormOpen()]] (in its beta version!) and [[GenerateUniqueId makeId()]]. See the documentation pages for for each for necessary supporting code for the DbInfo action! ====Styling==== >>**see also:** ""refmenu.css"" on AdvancedReferrersHandler >>The forms the action display are accessible. Like those for the AdvancedReferrersHandler, they need corresponding styling. In fact the styling is the same, but since these are stillbeta features they have not been turned into a general "forms" styling yet (as will eventually have to happen to give all forms a constent look and feel). For now, the solution was to extend the extra stylesheet created for the AdvancedReferrersHandler; it looks as follows now: ::c:: **##css/refmenu.css##** %%(css;1)/* This stylesheet is for the referrers and blacklist handlers. It will need to be integrated with the main stylesheet. JW 2005-07-08 - extended for the dbinfo action and forms. */ h4 { margin-top: 0.3em !important; /* remove !important when integrating into main stylesheet or including it after that */ } .refmenu { margin: 0; padding: 0; margin-top: 1em; } .refmenu .menu { margin: 0; padding: 0; } .refmenu .menu li { list-style: none; float: left; margin-right: 3px; /* margin-right goes together with float left (or vice versa) */ padding: 1px 2px; font-size: 85%; line-height: 1.2em; color: #000000; background-color: #DDDDDD; } br.clear { clear: both; } form fieldset.hidden { /* for all forms! not just referrers/dbinfo */ display: none; } #refform, #dbinfo { color: inherit; background-color: inherit; margin-top: 1em; margin-bottom: 1em; } #refform { width: 32em; } #form_dbsel, #form_tablesel { width: 40em; } #refform fieldset, #form_dbsel fieldset, #form_tablesel fieldset { padding: 1em; margin-bottom: 0.3em; border: 1px solid #666666; } #refform legend, #form_dbsel legend, #form_tablesel legend { padding: 0 2px; color: #000000; background-color: #DDDDDD; border: 1px solid #666666; margin-bottom: 0.3em; } #refform .mainlabel { float: left; width: 4.6em; /* width will work on _floated_ element, even if not a block! */ padding-right: 0.5em; } #form_dbsel .mainlabel, #form_tablesel .mainlabel { float: left; width: 9.8em; /* width will work on _floated_ element, even if not a block! */ padding-right: 0.5em; } #q, #qo, #ho { width: 10em; } #h { width: 3em; text-align: right; } #reflist { margin-top: 1em; margin-bottom: 1em; border: none; } #reflist .hits { width: 3em; padding-right: 5px; text-align: right; vertical-align: middle; } #reflist .action { width: 5em; padding-left: 5px; padding-right: 5px; text-align: center; vertical-align: middle; } #reflist .refs { padding-left: 5px; text-align: left; vertical-align: middle; } %% The little stylesheet file to import into your own "skin" has been extended accordingly: **##css/refmenu_col.css##** %%(css;1)/* For custom stylesheets: copy this into your stylesheet; the adapt the colors here (made to match the default Wikka skin) to match your own. JW 2005-07-08 - extended for the dbinfo action and forms. */ .refmenu .menu li { color: #000000; background-color: #DDDDDD; } form fieldset.hidden { /* for all forms! not just referrers/dbinfo */ display: none; } #refform fieldset, #form_dbsel fieldset, #form_tablesel fieldset { border: 1px solid #666666; } #refform legend, #form_dbsel legend, #form_tablesel legend { color: #000000; background-color: #DDDDDD; border: 1px solid #666666; } %% ====Todo==== Not a real todo, but it could potentially be extended to prompt for a user/password combination for another database user; that might be handy for Admins taking care of several Wikis installed on the same server. Let us know if you'd be interested in such a feature. ====Comments?==== As always, comments and suggestions very welcome. ---- CategoryDevelopmentActions