2fe6ff4655
Set namespace on DbQbe. Set namespace to 'DbSearch'. Split Advisor.class.php file. Change Advisor namespace. Rename DbQbe class and file. Set namespace on DisplayResults. Set namespace on Error. Use namespace for ErrorHandler. Add class autoloader. Change ErrorHandler filename. Remove some require. Update Config namespace path. Update PMA_Util to PMA\libraries\Util. Rename Font and File classes files. Use namespace for Footer. Set namespace in all libraries classes. Namespace OutputBuffering. Export SubPartition. Rename Partition file. Namespace PDF. Namespace RecentFavoriteTable. Replace PMA_Response by Response and PMA_Message by Message. Update uses and calls. Fix unit tests. Fix SqlParser autoload. Signed-off-by: Hugues Peccatte <hugues.peccatte@gmail.com>
436 lines
14 KiB
PHP
436 lines
14 KiB
PHP
<?php
|
|
/* vim: set expandtab sw=4 ts=4 sts=4: */
|
|
/**
|
|
* Set of functions used to build NHibernate dumps of tables
|
|
*
|
|
* @package PhpMyAdmin-Export
|
|
* @subpackage CodeGen
|
|
*/
|
|
if (! defined('PHPMYADMIN')) {
|
|
exit;
|
|
}
|
|
|
|
/* Get the export interface */
|
|
require_once 'libraries/plugins/ExportPlugin.class.php';
|
|
/* Get the table property class */
|
|
require_once 'libraries/plugins/export/TableProperty.class.php';
|
|
|
|
/**
|
|
* Handles the export for the CodeGen class
|
|
*
|
|
* @package PhpMyAdmin-Export
|
|
* @subpackage CodeGen
|
|
*/
|
|
class ExportCodegen extends ExportPlugin
|
|
{
|
|
/**
|
|
* CodeGen Formats
|
|
*
|
|
* @var array
|
|
*/
|
|
private $_cgFormats;
|
|
|
|
/**
|
|
* CodeGen Handlers
|
|
*
|
|
* @var array
|
|
*/
|
|
private $_cgHandlers;
|
|
|
|
/**
|
|
* Constructor
|
|
*/
|
|
public function __construct()
|
|
{
|
|
// initialize the specific export CodeGen variables
|
|
$this->initSpecificVariables();
|
|
$this->setProperties();
|
|
}
|
|
|
|
/**
|
|
* Initialize the local variables that are used for export CodeGen
|
|
*
|
|
* @return void
|
|
*/
|
|
protected function initSpecificVariables()
|
|
{
|
|
$this->_setCgFormats(
|
|
array(
|
|
"NHibernate C# DO",
|
|
"NHibernate XML"
|
|
)
|
|
);
|
|
|
|
$this->_setCgHandlers(
|
|
array(
|
|
"_handleNHibernateCSBody",
|
|
"_handleNHibernateXMLBody"
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Sets the export CodeGen properties
|
|
*
|
|
* @return void
|
|
*/
|
|
protected function setProperties()
|
|
{
|
|
$props = 'libraries/properties/';
|
|
include_once "$props/plugins/ExportPluginProperties.class.php";
|
|
include_once "$props/options/groups/OptionsPropertyRootGroup.class.php";
|
|
include_once "$props/options/groups/OptionsPropertyMainGroup.class.php";
|
|
include_once "$props/options/items/HiddenPropertyItem.class.php";
|
|
include_once "$props/options/items/SelectPropertyItem.class.php";
|
|
|
|
$exportPluginProperties = new ExportPluginProperties();
|
|
$exportPluginProperties->setText('CodeGen');
|
|
$exportPluginProperties->setExtension('cs');
|
|
$exportPluginProperties->setMimeType('text/cs');
|
|
$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();
|
|
$exportSpecificOptions->setName("Format Specific Options");
|
|
|
|
// general options main group
|
|
$generalOptions = new OptionsPropertyMainGroup();
|
|
$generalOptions->setName("general_opts");
|
|
// create primary items and add them to the group
|
|
$leaf = new HiddenPropertyItem();
|
|
$leaf->setName("structure_or_data");
|
|
$generalOptions->addProperty($leaf);
|
|
$leaf = new SelectPropertyItem();
|
|
$leaf->setName("format");
|
|
$leaf->setText(__('Format:'));
|
|
$leaf->setValues($this->_getCgFormats());
|
|
$generalOptions->addProperty($leaf);
|
|
// add the main group to the root group
|
|
$exportSpecificOptions->addProperty($generalOptions);
|
|
|
|
// 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()
|
|
{
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Outputs export footer
|
|
*
|
|
* @return bool Whether it succeeded
|
|
*/
|
|
public function exportFooter()
|
|
{
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* 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 = '')
|
|
{
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* 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 NHibernate 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, $aliases = array()
|
|
) {
|
|
$CG_FORMATS = $this->_getCgFormats();
|
|
$CG_HANDLERS = $this->_getCgHandlers();
|
|
|
|
$format = $GLOBALS['codegen_format'];
|
|
if (isset($CG_FORMATS[$format])) {
|
|
$method = $CG_HANDLERS[$format];
|
|
return PMA_exportOutputHandler(
|
|
$this->$method($db, $table, $crlf, $aliases)
|
|
);
|
|
}
|
|
return PMA_exportOutputHandler(sprintf("%s is not supported.", $format));
|
|
}
|
|
|
|
/**
|
|
* Used to make identifiers (from table or database names)
|
|
*
|
|
* @param string $str name to be converted
|
|
* @param bool $ucfirst whether to make the first character uppercase
|
|
*
|
|
* @return string identifier
|
|
*/
|
|
public static function cgMakeIdentifier($str, $ucfirst = true)
|
|
{
|
|
// remove unsafe characters
|
|
$str = preg_replace('/[^\p{L}\p{Nl}_]/u', '', $str);
|
|
// make sure first character is a letter or _
|
|
if (! preg_match('/^\pL/u', $str)) {
|
|
$str = '_' . $str;
|
|
}
|
|
if ($ucfirst) {
|
|
$str = ucfirst($str);
|
|
}
|
|
return $str;
|
|
}
|
|
|
|
/**
|
|
* C# Handler
|
|
*
|
|
* @param string $db database name
|
|
* @param string $table table name
|
|
* @param string $crlf line separator
|
|
* @param array $aliases Aliases of db/table/columns
|
|
*
|
|
* @return string containing C# code lines, separated by "\n"
|
|
*/
|
|
private function _handleNHibernateCSBody($db, $table, $crlf, $aliases = array())
|
|
{
|
|
$db_alias = $db;
|
|
$table_alias = $table;
|
|
$this->initAlias($aliases, $db_alias, $table_alias);
|
|
$lines = array();
|
|
|
|
$result = $GLOBALS['dbi']->query(
|
|
sprintf(
|
|
'DESC %s.%s', PMA\libraries\Util::backquote($db),
|
|
PMA\libraries\Util::backquote($table)
|
|
)
|
|
);
|
|
if ($result) {
|
|
/** @var TableProperty[] $tableProperties */
|
|
$tableProperties = array();
|
|
while ($row = $GLOBALS['dbi']->fetchRow($result)) {
|
|
$col_as = $this->getAlias($aliases, $row[0], 'col', $db, $table);
|
|
if (!empty($col_as)) {
|
|
$row[0] = $col_as;
|
|
}
|
|
$tableProperties[] = new TableProperty($row);
|
|
}
|
|
$GLOBALS['dbi']->freeResult($result);
|
|
$lines[] = 'using System;';
|
|
$lines[] = 'using System.Collections;';
|
|
$lines[] = 'using System.Collections.Generic;';
|
|
$lines[] = 'using System.Text;';
|
|
$lines[] = 'namespace ' . ExportCodegen::cgMakeIdentifier($db_alias);
|
|
$lines[] = '{';
|
|
$lines[] = ' #region '
|
|
. ExportCodegen::cgMakeIdentifier($table_alias);
|
|
$lines[] = ' public class '
|
|
. ExportCodegen::cgMakeIdentifier($table_alias);
|
|
$lines[] = ' {';
|
|
$lines[] = ' #region Member Variables';
|
|
foreach ($tableProperties as $tableProperty) {
|
|
$lines[] = $tableProperty->formatCs(
|
|
' protected #dotNetPrimitiveType# _#name#;'
|
|
);
|
|
}
|
|
$lines[] = ' #endregion';
|
|
$lines[] = ' #region Constructors';
|
|
$lines[] = ' public '
|
|
. ExportCodegen::cgMakeIdentifier($table_alias) . '() { }';
|
|
$temp = array();
|
|
foreach ($tableProperties as $tableProperty) {
|
|
if (! $tableProperty->isPK()) {
|
|
$temp[] = $tableProperty->formatCs(
|
|
'#dotNetPrimitiveType# #name#'
|
|
);
|
|
}
|
|
}
|
|
$lines[] = ' public '
|
|
. ExportCodegen::cgMakeIdentifier($table_alias)
|
|
. '('
|
|
. implode(', ', $temp)
|
|
. ')';
|
|
$lines[] = ' {';
|
|
foreach ($tableProperties as $tableProperty) {
|
|
if (! $tableProperty->isPK()) {
|
|
$lines[] = $tableProperty->formatCs(
|
|
' this._#name#=#name#;'
|
|
);
|
|
}
|
|
}
|
|
$lines[] = ' }';
|
|
$lines[] = ' #endregion';
|
|
$lines[] = ' #region Public Properties';
|
|
foreach ($tableProperties as $tableProperty) {
|
|
$lines[] = $tableProperty->formatCs(
|
|
' public virtual #dotNetPrimitiveType# #ucfirstName#'
|
|
. "\n"
|
|
. ' {' . "\n"
|
|
. ' get {return _#name#;}' . "\n"
|
|
. ' set {_#name#=value;}' . "\n"
|
|
. ' }'
|
|
);
|
|
}
|
|
$lines[] = ' #endregion';
|
|
$lines[] = ' }';
|
|
$lines[] = ' #endregion';
|
|
$lines[] = '}';
|
|
}
|
|
return implode($crlf, $lines);
|
|
}
|
|
|
|
/**
|
|
* XML Handler
|
|
*
|
|
* @param string $db database name
|
|
* @param string $table table name
|
|
* @param string $crlf line separator
|
|
* @param array $aliases Aliases of db/table/columns
|
|
*
|
|
* @return string containing XML code lines, separated by "\n"
|
|
*/
|
|
private function _handleNHibernateXMLBody(
|
|
$db, $table, $crlf, $aliases = array()
|
|
) {
|
|
$db_alias = $db;
|
|
$table_alias = $table;
|
|
$this->initAlias($aliases, $db_alias, $table_alias);
|
|
$lines = array();
|
|
$lines[] = '<?xml version="1.0" encoding="utf-8" ?' . '>';
|
|
$lines[] = '<hibernate-mapping xmlns="urn:nhibernate-mapping-2.2" '
|
|
. 'namespace="' . ExportCodegen::cgMakeIdentifier($db_alias) . '" '
|
|
. 'assembly="' . ExportCodegen::cgMakeIdentifier($db_alias) . '">';
|
|
$lines[] = ' <class '
|
|
. 'name="' . ExportCodegen::cgMakeIdentifier($table_alias) . '" '
|
|
. 'table="' . ExportCodegen::cgMakeIdentifier($table_alias) . '">';
|
|
$result = $GLOBALS['dbi']->query(
|
|
sprintf(
|
|
"DESC %s.%s", PMA\libraries\Util::backquote($db),
|
|
PMA\libraries\Util::backquote($table)
|
|
)
|
|
);
|
|
if ($result) {
|
|
while ($row = $GLOBALS['dbi']->fetchRow($result)) {
|
|
$col_as = $this->getAlias($aliases, $row[0], 'col', $db, $table);
|
|
if (!empty($col_as)) {
|
|
$row[0] = $col_as;
|
|
}
|
|
$tableProperty = new TableProperty($row);
|
|
if ($tableProperty->isPK()) {
|
|
$lines[] = $tableProperty->formatXml(
|
|
' <id name="#ucfirstName#" type="#dotNetObjectType#"'
|
|
. ' unsaved-value="0">' . "\n"
|
|
. ' <column name="#name#" sql-type="#type#"'
|
|
. ' not-null="#notNull#" unique="#unique#"'
|
|
. ' index="PRIMARY"/>' . "\n"
|
|
. ' <generator class="native" />' . "\n"
|
|
. ' </id>'
|
|
);
|
|
} else {
|
|
$lines[] = $tableProperty->formatXml(
|
|
' <property name="#ucfirstName#"'
|
|
. ' type="#dotNetObjectType#">' . "\n"
|
|
. ' <column name="#name#" sql-type="#type#"'
|
|
. ' not-null="#notNull#" #indexName#/>' . "\n"
|
|
. ' </property>'
|
|
);
|
|
}
|
|
}
|
|
$GLOBALS['dbi']->freeResult($result);
|
|
}
|
|
$lines[] = ' </class>';
|
|
$lines[] = '</hibernate-mapping>';
|
|
return implode($crlf, $lines);
|
|
}
|
|
|
|
|
|
/* ~~~~~~~~~~~~~~~~~~~~ Getters and Setters ~~~~~~~~~~~~~~~~~~~~ */
|
|
|
|
|
|
/**
|
|
* Getter for CodeGen formats
|
|
*
|
|
* @return array
|
|
*/
|
|
private function _getCgFormats()
|
|
{
|
|
return $this->_cgFormats;
|
|
}
|
|
|
|
/**
|
|
* Setter for CodeGen formats
|
|
*
|
|
* @param array $CG_FORMATS contains CodeGen Formats
|
|
*
|
|
* @return void
|
|
*/
|
|
private function _setCgFormats($CG_FORMATS)
|
|
{
|
|
$this->_cgFormats = $CG_FORMATS;
|
|
}
|
|
|
|
/**
|
|
* Getter for CodeGen handlers
|
|
*
|
|
* @return array
|
|
*/
|
|
private function _getCgHandlers()
|
|
{
|
|
return $this->_cgHandlers;
|
|
}
|
|
|
|
/**
|
|
* Setter for CodeGen handlers
|
|
*
|
|
* @param array $CG_HANDLERS contains CodeGen handler methods
|
|
*
|
|
* @return void
|
|
*/
|
|
private function _setCgHandlers($CG_HANDLERS)
|
|
{
|
|
$this->_cgHandlers = $CG_HANDLERS;
|
|
}
|
|
}
|
