From f9c29173bfb080910e15ac46c6a34f8be8aac51e Mon Sep 17 00:00:00 2001 From: Adnan Date: Wed, 14 Jul 2010 02:32:57 +0500 Subject: [PATCH] Dia Schem Class: documented + implemented --- libraries/schema/Dia_Relation_Schema.class.php | 726 ++++++++++++++++++++++++- 1 file changed, 720 insertions(+), 6 deletions(-) diff --git a/libraries/schema/Dia_Relation_Schema.class.php b/libraries/schema/Dia_Relation_Schema.class.php index 30982a308..79141f7af 100644 --- a/libraries/schema/Dia_Relation_Schema.class.php +++ b/libraries/schema/Dia_Relation_Schema.class.php @@ -1,18 +1,732 @@ + * @copyright + * @license + * @access public + * @see http://php.net/manual/en/book.xmlwriter.php + */ + class PMA_DIA extends XMLWriter { public $title; - public $author; - public $font; - public $fontSize; - - + public $author; + public $font; + public $fontSize; + + function __construct() + { + $this->openMemory(); + /* + * Set indenting using three spaces, + * so output is formatted + */ + + $this->setIndent(TRUE); + $this->setIndentString(' '); + /* + * Create the XML document + */ + + $this->startDocument('1.0','UTF-8'); + } + + function startDiaDoc($paper,$topMargin,$bottomMargin,$leftMargin,$rightMargin,$portrait) + { + if($portrait == 'P'){ + $isPortrait='true'; + }else{ + $isPortrait='false'; + } + $this->startElement('dia:diagram'); + $this->writeAttribute('xmlns:dia', 'http://www.lysator.liu.se/~alla/dia/'); + $this->startElement('dia:diagramdata'); + $this->writeRaw ( + ' + + + + + + + + + #'.$paper.'# + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + '); + $this->endElement(); + $this->startElement('dia:layer'); + $this->writeAttribute('name', 'Background'); + $this->writeAttribute('visible', 'true'); + $this->writeAttribute('active', 'true'); + + } + + function endDiaDoc() + { + $this->endElement(); + $this->endDocument(); + } + + function showOutput() + { + if(ob_end_clean()){ + ob_end_clean(); + //ob_start(); + } + //header('Content-type: text/xml'); + header('Content-Disposition: attachment; filename="downloaded.dia"'); + $output = $this->flush(); + print $output; + } +} + +/** + * Table preferences/statistics + * + * This class preserves the table co-ordinates,fields + * and helps in drawing/generating the Tables in dia XML document. + * + * @name Table_Stats + * @author Muhammad Adnan + * @copyright + * @license + * @see PMA_DIA + */ +class Table_Stats +{ + /** + * Defines properties + */ + public $tableName; + public $fields = array(); + public $x, $y; + public $primary = array(); + public $tableId; + public $tableColor; + + /** + * The "Table_Stats" constructor + * + * @param string table_name The table name + * @param integer pageNumber The current page number (from the + * $cfg['Servers'][$i]['table_coords'] table) + * @param boolean showKeys Whether to display ONLY keys or not + * @return void + * @global object The current dia document + * @global array The relations settings + * @global string The current db name + * @see PMA_DIA + */ + function __construct($tableName, $pageNumber, $showKeys = false) + { + global $dia, $cfgRelation, $db; + + $this->tableName = $tableName; + $sql = 'DESCRIBE ' . PMA_backquote($tableName); + $result = PMA_DBI_try_query($sql, null, PMA_DBI_QUERY_STORE); + if (!$result || !PMA_DBI_num_rows($result)) { + //$dia->Error(sprintf(__('The %s table doesn\'t exist!'), $tableName)); + } + /* + * load fields + * check to see if it will load all fields or only the foreign keys + */ + if ($showKeys) { + $indexes = PMA_Index::getFromTable($this->tableName, $db); + $all_columns = array(); + foreach ($indexes as $index) { + $all_columns = array_merge($all_columns, array_flip(array_keys($index->getColumns()))); + } + $this->fields = array_keys($all_columns); + } else { + while ($row = PMA_DBI_fetch_row($result)) { + $this->fields[] = $row[0]; + } + } + + $sql = 'SELECT x, y FROM ' + . PMA_backquote($GLOBALS['cfgRelation']['db']) . '.' . PMA_backquote($cfgRelation['table_coords']) + . ' WHERE db_name = \'' . PMA_sqlAddslashes($db) . '\'' + . ' AND table_name = \'' . PMA_sqlAddslashes($tableName) . '\'' + . ' AND pdf_page_number = ' . $pageNumber; + $result = PMA_query_as_controluser($sql, false, PMA_DBI_QUERY_STORE); + if (!$result || !PMA_DBI_num_rows($result)) { + // $dia->Error(sprintf(__('Please configure the coordinates for table %s'), $tableName)); + } + list($this->x, $this->y) = PMA_DBI_fetch_row($result); + $this->x = (double) $this->x; + $this->y = (double) $this->y; + /* + * displayfield + */ + $this->displayfield = PMA_getDisplayField($db, $tableName); + /* + * index + */ + $result = PMA_DBI_query('SHOW INDEX FROM ' . PMA_backquote($tableName) . ';', null, PMA_DBI_QUERY_STORE); + if (PMA_DBI_num_rows($result) > 0) { + while ($row = PMA_DBI_fetch_assoc($result)) { + if ($row['Key_name'] == 'PRIMARY') { + $this->primary[] = $row['Column_name']; + } + } + } + /** + * Every object in Dia document needs an ID to identify + * so, we used a static variable to keep the things unique + */ + PMA_Dia_Relation_Schema::$objectId += 1; + $this->tableId = PMA_Dia_Relation_Schema::$objectId; + } + + /** + * Do draw the table + * + * Tables are generated using object type Database - Table + * primary fields are underlined in tables. Dia object + * is used to generate the XML of Dia Document. Database Table + * Object and their attributes are involved in the combination + * of displaing Database - Table on Dia Document. + + * @param boolean changeColor Whether to show color for tables text or not + if changeColor is true then an array of $listOfColors + will be used to choose the random colors for tables text + we can change/add more colors to this array + @return void + * @global object The current Dia document + * @access public + * @see PMA_DIA + */ + public function tableDraw($changeColor) + { + global $dia; + + if ($changeColor) { + $listOfColors = array( + 'FF0000', + '000099', + '00FF00' + ); + shuffle($listOfColors); + $this->tableColor = '#'.$listOfColors[0].''; + } else { + $this->tableColor = '#000000'; + } + + $dia->startElement('dia:object'); + $dia->writeAttribute('type', 'Database - Table'); + $dia->writeAttribute('version', '0'); + $dia->writeAttribute('id', ''.$this->tableId.''); + $dia->writeRaw( + ' + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + #'.$this->_tableName.'# + + + ## + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ' + ); + + $dia->startElement('dia:attribute'); + $dia->writeAttribute('name', 'attributes'); + + foreach ($this->fields as $field) { + $dia->writeRaw( + ' + + #'.$field.'# + + + ## + + + ## + ' + ); + unset($pm); + $pm = 'false'; + if (in_array($field, $this->primary)) { + $pm = 'true'; + } + if ($field == $this->displayfield) { + $pm = 'false'; + } + $dia->writeRaw( + ' + + + + + + + + + ' + ); + } + $dia->endElement(); + $dia->endElement(); + } } +/** + * Relation preferences/statistics + * + * This class fetches the table master and foreign fields positions + * and helps in generating the Table references and then connects + * master table's master field to foreign table's foreign key + * in dia XML document. + * + * @name Relation_Stats + * @author Muhammad Adnan + * @copyright + * @license + * @see PMA_DIA + */ +class Relation_Stats +{ + /** + * Defines properties + */ + public $srcConnPointsRight; + public $srcConnPointsLeft; + public $destConnPointsRight; + public $destConnPointsLeft; + public $masterTableId; + public $foreignTableId; + public $masterTablePos; + public $foreignTablePos; + public $referenceColor; + + /** + * The "Relation_Stats" constructor + * + * @param string master_table The master table name + * @param string master_field The relation field in the master table + * @param string foreign_table The foreign table name + * @param string foreigh_field The relation field in the foreign table + * @return void + * @see Relation_Stats::_getXy + */ + function __construct($master_table, $master_field, $foreign_table, $foreign_field) + { + $src_pos = $this->_getXy($master_table, $master_field); + $dest_pos = $this->_getXy($foreign_table, $foreign_field); + $this->srcConnPointsLeft = $src_pos[0]; + $this->srcConnPointsRight = $src_pos[1]; + $this->destConnPointsLeft = $dest_pos[0]; + $this->destConnPointsRight = $dest_pos[1]; + $this->masterTablePos = $src_pos[2]; + $this->foreignTablePos = $dest_pos[2]; + $this->masterTableId = $master_table->tableId; + $this->foreignTableId = $foreign_table->tableId; + } + + /** + * Each Table object have connection points + * which is used to connect to other objects in Dia + * we detect the position of key in fields and + * then determines its left and right connection + * points. + * + * @param string table The current table name + * @param string column The relation column name + * @return array Table right,left connection points and key position + * @access private + */ + private function _getXy($table, $column) + { + $pos = array_search($column, $table->fields); + // left, right, position + $value = 12; + if($pos != 0) + { + return array($pos + $value + $pos, $pos + $value + $pos + 1, $pos); + } + return array($pos + $value , $pos + $value + 1, $pos); + } + + /** + * Draws relation references + * + * connects master table's master field to foreign table's + * forein field using Dia object type Database - Reference + * Dia object is used to generate the XML of Dia Document. + * Database reference Object and their attributes are involved + * in the combination of displaing Database - reference on Dia Document. + * + * @param boolean changeColor Whether to use one color per relation or not + if changeColor is true then an array of $listOfColors + will be used to choose the random colors for references + lines. we can change/add more colors to this array + * @return void + * @global object The current Dia document + * @access public + * @see PMA_PDF + */ + public function relationDraw($changeColor) + { + global $dia; + + PMA_Dia_Relation_Schema::$objectId += 1; + /* + * if source connection points and destination connection + * points are same then return it false and don't draw that + * relation + */ + if ( $this->srcConnPointsRight == $this->destConnPointsRight ){ + if ( $this->srcConnPointsLeft == $this->destConnPointsLeft ){ + return false; + } + } + + if ($changeColor) { + $listOfColors = array( + 'FF0000', + '000099', + '00FF00' + ); + shuffle($listOfColors); + $this->referenceColor = '#'.$listOfColors[0].''; + } else { + $this->referenceColor = '#000000'; + } + + $dia->writeRaw( + ' + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + #1# + + + #n# + + + + + + + + + + + + ' + ); + } +} + +/** + * Dia Relation Schema Class + * + * Purpose of this class is to generate the Dia XML Document + * which is used for representing the database diagrams in Dia IDE + * This class uses Database Table and Reference Objects of Dia and with + * the combination of these objects actually helps in preparing Dia XML. + * + * Dia XML is generated by using XMLWriter php extension and this class + * inherits Export_Relation_Schema class has common functionality added + * to this class + * + * @name Dia_Relation_Schema + * @author Muhammad Adnan + * @copyright + * @license + */ class PMA_Dia_Relation_Schema extends PMA_Export_Relation_Schema { - + /** + * Defines properties + */ + private $_tables = array(); + private $_relations = array(); + private $_topMargin = 2.8222000598907471; + private $_bottomMargin = 2.8222000598907471; + private $_leftMargin = 2.8222000598907471; + private $_rightMargin = 2.8222000598907471; + public static $objectId = 0; + + function __construct() + { + global $dia,$db; + + $this->setPageNumber($_POST['pdf_page_number']); + $this->setShowGrid($_POST['show_grid']); + $this->setShowColor($_POST['show_color']); + $this->setShowKeys($_POST['show_keys']); + $this->setOrientation($_POST['orientation']); + $this->setPaper($_POST['paper']); + $this->setExportType($_POST['export_type']); + + $dia = new PMA_DIA(); + $dia->startDiaDoc($this->paper,$this->_topMargin,$this->_bottomMargin,$this->_leftMargin,$this->_rightMargin,$this->orientation); + $alltables = $this->getAllTables($db,$this->pageNumber); + foreach ($alltables as $table) { + if (!isset($this->tables[$table])) { + $this->tables[$table] = new Table_Stats($table, $this->pageNumber, $this->showKeys); + } + } + + $seen_a_relation = false; + foreach ($alltables as $one_table) { + $exist_rel = PMA_getForeigners($db, $one_table, '', 'both'); + if ($exist_rel) { + $seen_a_relation = true; + foreach ($exist_rel as $master_field => $rel) { + /* put the foreign table on the schema only if selected + * by the user + * (do not use array_search() because we would have to + * to do a === FALSE and this is not PHP3 compatible) + */ + if (in_array($rel['foreign_table'], $alltables)) { + $this->_addRelation($one_table, $master_field, $rel['foreign_table'], $rel['foreign_field'],$this->showKeys); + } + } + } + } + $this->_drawTables($this->showColor); + + if ($seen_a_relation) { + $this->_drawRelations($this->showColor); + } + $dia->endDiaDoc(); + $dia->showOutput(); + exit(); + print '
';
+        print_r(get_object_vars($dia));
+        print_r(get_object_vars($this));
+        print '
'; + } + + /** + * Defines relation objects + * + * @param string masterTable The master table name + * @param string masterField The relation field in the master table + * @param string foreignTable The foreign table name + * @param string foreignField The relation field in the foreign table + * @return void + * @access private + * @see Table_Stats::__construct(),Relation_Stats::__construct() + */ + private function _addRelation($masterTable, $masterField, $foreignTable, $foreignField, $showKeys) + { + if (!isset($this->tables[$masterTable])) { + $this->tables[$masterTable] = new Table_Stats($masterTable, $this->pageNumber, $showKeys); + } + if (!isset($this->tables[$foreignTable])) { + $this->tables[$foreignTable] = new Table_Stats($foreignTable, $this->pageNumber, $showKeys); + } + $this->_relations[] = new Relation_Stats($this->tables[$masterTable], $masterField, $this->tables[$foreignTable], $foreignField); + } + + /** + * Draws relation references + * + * connects master table's master field to + * foreign table's forein field using Dia object + * type Database - Reference + * + * @param boolean changeColor Whether to use one color per relation or not + * @return void + * @access private + * @see Relation_Stats::relationDraw() + */ + private function _drawRelations($changeColor) + { + foreach ($this->_relations as $relation) { + $relation->relationDraw($changeColor); + } + } + + /** + * Draws tables + * + * Tables are generated using Dia object type Database - Table + * primary fields are underlined and bold in tables + * + * @param boolean changeColor Whether to show color for tables text or not + * @return void + * @access private + * @see Table_Stats::tableDraw() + */ + private function _drawTables($changeColor) + { + foreach ($this->tables as $table) { + $table->tableDraw($changeColor); + } + } } ?> \ No newline at end of file -- 2.11.4.GIT