aboutsummaryrefslogtreecommitdiff
path: root/srcs/phpmyadmin/libraries/classes/Plugins/Export/ExportCodegen.php
diff options
context:
space:
mode:
Diffstat (limited to 'srcs/phpmyadmin/libraries/classes/Plugins/Export/ExportCodegen.php')
-rw-r--r--srcs/phpmyadmin/libraries/classes/Plugins/Export/ExportCodegen.php447
1 files changed, 447 insertions, 0 deletions
diff --git a/srcs/phpmyadmin/libraries/classes/Plugins/Export/ExportCodegen.php b/srcs/phpmyadmin/libraries/classes/Plugins/Export/ExportCodegen.php
new file mode 100644
index 0000000..8a29538
--- /dev/null
+++ b/srcs/phpmyadmin/libraries/classes/Plugins/Export/ExportCodegen.php
@@ -0,0 +1,447 @@
+<?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
+ */
+declare(strict_types=1);
+
+namespace PhpMyAdmin\Plugins\Export;
+
+use PhpMyAdmin\Export;
+use PhpMyAdmin\Plugins\Export\Helpers\TableProperty;
+use PhpMyAdmin\Plugins\ExportPlugin;
+use PhpMyAdmin\Properties\Options\Groups\OptionsPropertyMainGroup;
+use PhpMyAdmin\Properties\Options\Groups\OptionsPropertyRootGroup;
+use PhpMyAdmin\Properties\Options\Items\HiddenPropertyItem;
+use PhpMyAdmin\Properties\Options\Items\SelectPropertyItem;
+use PhpMyAdmin\Properties\Plugins\ExportPluginProperties;
+use PhpMyAdmin\Util;
+
+/**
+ * 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()
+ {
+ parent::__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(
+ [
+ "NHibernate C# DO",
+ "NHibernate XML",
+ ]
+ );
+
+ $this->_setCgHandlers(
+ [
+ "_handleNHibernateCSBody",
+ "_handleNHibernateXMLBody",
+ ]
+ );
+ }
+
+ /**
+ * Sets the export CodeGen properties
+ *
+ * @return void
+ */
+ protected function setProperties()
+ {
+ $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(
+ "Format Specific Options"
+ );
+
+ // general options main group
+ $generalOptions = new OptionsPropertyMainGroup("general_opts");
+ // create primary items and add them to the group
+ $leaf = new HiddenPropertyItem("structure_or_data");
+ $generalOptions->addProperty($leaf);
+ $leaf = new SelectPropertyItem(
+ "format",
+ __('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,
+ array $aliases = []
+ ) {
+ $CG_FORMATS = $this->_getCgFormats();
+ $CG_HANDLERS = $this->_getCgHandlers();
+
+ $format = $GLOBALS['codegen_format'];
+ if (isset($CG_FORMATS[$format])) {
+ $method = $CG_HANDLERS[$format];
+
+ return $this->export->outputHandler(
+ $this->$method($db, $table, $crlf, $aliases)
+ );
+ }
+
+ return $this->export->outputHandler(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, array $aliases = [])
+ {
+ $db_alias = $db;
+ $table_alias = $table;
+ $this->initAlias($aliases, $db_alias, $table_alias);
+ $lines = [];
+
+ $result = $GLOBALS['dbi']->query(
+ sprintf(
+ 'DESC %s.%s',
+ Util::backquote($db),
+ Util::backquote($table)
+ )
+ );
+ if ($result) {
+ /** @var TableProperty[] $tableProperties */
+ $tableProperties = [];
+ 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 = [];
+ 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,
+ array $aliases = []
+ ) {
+ $db_alias = $db;
+ $table_alias = $table;
+ $this->initAlias($aliases, $db_alias, $table_alias);
+ $lines = [];
+ $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",
+ Util::backquote($db),
+ 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(array $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(array $CG_HANDLERS)
+ {
+ $this->_cgHandlers = $CG_HANDLERS;
+ }
+}
generated by cgit (git 2.34.1) at 2026-05-16 01:11:55 +0000