libraries/export/codegen.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Set of functions used to build NHibernate dumps of tables
   5  *
   6  * @version $Id$
   7  */
   8 if (! defined('PHPMYADMIN')) {
   9     exit;
  10 }
  11
  12 // this gets executed twice so avoid a notice
  13 if (! defined('CG_FORMAT_NHIBERNATE_CS')) {
  14     define("CG_FORMAT_NHIBERNATE_CS", "NHibernate C# DO");
  15     define("CG_FORMAT_NHIBERNATE_XML", "NHibernate XML");
  16
  17     define("CG_HANDLER_NHIBERNATE_CS_BODY", "handleNHibernateCSBody");
  18     define("CG_HANDLER_NHIBERNATE_XML_BODY", "handleNHibernateXMLBody");
  19 }
  20
  21 $CG_FORMATS = array(CG_FORMAT_NHIBERNATE_CS, CG_FORMAT_NHIBERNATE_XML);
  22 $CG_HANDLERS = array(CG_HANDLER_NHIBERNATE_CS_BODY, CG_HANDLER_NHIBERNATE_XML_BODY);
  23
  24 /**
  25  *
  26  */
  27 if (isset($plugin_list)) {
  28     $plugin_list['codegen'] = array(
  29         'text' => 'CodeGen',
  30         'extension' => 'cs',
  31         'mime_type' => 'text/cs',
  32           'options' => array(
  33                 array('type' => 'hidden', 'name' => 'data'),
  34             array('type' => 'select', 'name' => 'format', 'text' => 'strFormat', 'values' => $CG_FORMATS),
  35             ),
  36         'options_text' => 'strOptions',
  37         );
  38 } else {
  39
  40 /**
  41  * Set of functions used to build exports of tables
  42  */
  43
  44 /**
  45  * Outputs comment
  46  *
  47  * @param   string      Text of comment
  48  *
  49  * @return  bool        Whether it suceeded
  50  */
  51 function PMA_exportComment($text)
  52 {
  53     return TRUE;
  54 }
  55
  56 /**
  57  * Outputs export footer
  58  *
  59  * @return  bool        Whether it suceeded
  60  *
  61  * @access  public
  62  */
  63 function PMA_exportFooter()
  64 {
  65     return TRUE;
  66 }
  67
  68 /**
  69  * Outputs export header
  70  *
  71  * @return  bool        Whether it suceeded
  72  *
  73  * @access  public
  74  */
  75 function PMA_exportHeader()
  76 {
  77     return TRUE;
  78 }
  79
  80 /**
  81  * Outputs database header
  82  *
  83  * @param   string      Database name
  84  *
  85  * @return  bool        Whether it suceeded
  86  *
  87  * @access  public
  88  */
  89 function PMA_exportDBHeader($db)
  90 {
  91     return TRUE;
  92 }
  93
  94 /**
  95  * Outputs database footer
  96  *
  97  * @param   string      Database name
  98  *
  99  * @return  bool        Whether it suceeded
 100  *
 101  * @access  public
 102  */
 103 function PMA_exportDBFooter($db)
 104 {
 105     return TRUE;
 106 }
 107
 108 /**
 109  * Outputs create database database
 110  *
 111  * @param   string      Database name
 112  *
 113  * @return  bool        Whether it suceeded
 114  *
 115  * @access  public
 116  */
 117 function PMA_exportDBCreate($db)
 118 {
 119     return TRUE;
 120 }
 121
 122 /**
 123  * Outputs the content of a table in NHibernate format
 124  *
 125  * @param   string      the database name
 126  * @param   string      the table name
 127  * @param   string      the end of line sequence
 128  * @param   string      the url to go back in case of error
 129  * @param   string      SQL query for obtaining data
 130  *
 131  * @return  bool        Whether it suceeded
 132  *
 133  * @access  public
 134  */
 135 function PMA_exportData($db, $table, $crlf, $error_url, $sql_query)
 136 {
 137         global $CG_FORMATS, $CG_HANDLERS;
 138         $format = cgGetOption("format");
 139         $index = array_search($format, $CG_FORMATS);
 140         if ($index >= 0)
 141                 return PMA_exportOutputHandler($CG_HANDLERS[$index]($db, $table, $crlf));
 142         return PMA_exportOutputHandler(sprintf("%s is not supported.", $format));
 143 }
 144
 145 class TableProperty
 146 {
 147         public $name;
 148         public $type;
 149         public $nullable;
 150         public $key;
 151         public $defaultValue;
 152         public $ext;
 153         function __construct($row)
 154         {
 155                 $this->name = trim($row[0]);
 156                 $this->type = trim($row[1]);
 157                 $this->nullable = trim($row[2]);
 158                 $this->key = trim($row[3]);
 159                 $this->defaultValue = trim($row[4]);
 160                 $this->ext = trim($row[5]);
 161         }
 162         function getPureType()
 163         {
 164                 $pos=strpos($this->type, "(");
 165                 if ($pos > 0)
 166                         return substr($this->type, 0, $pos);
 167                 return $this->type;
 168         }
 169         function isNotNull()
 170         {
 171                 return $this->nullable == "NO" ? "true" : "false";
 172         }
 173         function isUnique()
 174         {
 175                 return $this->key == "PRI" || $this->key == "UNI" ? "true" : "false";
 176         }
 177         function getDotNetPrimitiveType()
 178         {
 179                 if (strpos($this->type, "int") === 0) return "int";
 180                 if (strpos($this->type, "long") === 0) return "long";
 181                 if (strpos($this->type, "char") === 0) return "string";
 182                 if (strpos($this->type, "varchar") === 0) return "string";
 183                 if (strpos($this->type, "text") === 0) return "string";
 184                 if (strpos($this->type, "longtext") === 0) return "string";
 185                 if (strpos($this->type, "tinyint") === 0) return "bool";
 186                 if (strpos($this->type, "datetime") === 0) return "DateTime";
 187                 return "unknown";
 188         }
 189         function getDotNetObjectType()
 190         {
 191                 if (strpos($this->type, "int") === 0) return "Int32";
 192                 if (strpos($this->type, "long") === 0) return "Long";
 193                 if (strpos($this->type, "char") === 0) return "String";
 194                 if (strpos($this->type, "varchar") === 0) return "String";
 195                 if (strpos($this->type, "text") === 0) return "String";
 196                 if (strpos($this->type, "longtext") === 0) return "String";
 197                 if (strpos($this->type, "tinyint") === 0) return "Boolean";
 198                 if (strpos($this->type, "datetime") === 0) return "DateTime";
 199                 return "Unknown";
 200         }
 201         function getIndexName()
 202         {
 203                 if (strlen($this->key)>0)
 204                         return "index=\"" . $this->name . "\"";
 205                 return "";
 206         }
 207         function isPK()
 208         {
 209                 return $this->key=="PRI";
 210         }
 211         function format($pattern)
 212         {
 213                 $text=$pattern;
 214                 $text=str_replace("#name#", $this->name, $text);
 215                 $text=str_replace("#type#", $this->getPureType(), $text);
 216                 $text=str_replace("#notNull#", $this->isNotNull(), $text);
 217                 $text=str_replace("#unique#", $this->isUnique(), $text);
 218                 $text=str_replace("#ucfirstName#", ucfirst($this->name), $text);
 219                 $text=str_replace("#dotNetPrimitiveType#", $this->getDotNetPrimitiveType(), $text);
 220                 $text=str_replace("#dotNetObjectType#", $this->getDotNetObjectType(), $text);
 221                 $text=str_replace("#indexName#", $this->getIndexName(), $text);
 222                 return $text;
 223         }
 224 }
 225
 226         function handleNHibernateCSBody($db, $table, $crlf)
 227         {
 228                 $lines=array();
 229                 $result=PMA_DBI_query(sprintf("DESC %s.%s", PMA_backquote($db), PMA_backquote($table)));
 230                 if ($result)
 231                 {
 232                         $tableProperties=array();
 233                         while ($row = PMA_DBI_fetch_row($result))
 234                                 $tableProperties[] = new TableProperty($row);
 235                         $lines[] = "using System;";
 236                         $lines[] = "using System.Collections;";
 237                         $lines[] = "using System.Collections.Generic;";
 238                         $lines[] = "using System.Text;";
 239                         $lines[] = "namespace ".ucfirst($db);
 240                         $lines[] = "{";
 241                         $lines[] = "    #region ".ucfirst($table);
 242                         $lines[] = "    public class ".ucfirst($table);
 243                         $lines[] = "    {";
 244                         $lines[] = "            #region Member Variables";
 245                         foreach ($tableProperties as $tablePropertie)
 246                                 $lines[] = $tablePropertie->format("            protected #dotNetPrimitiveType# _#name#;");
 247                         $lines[] = "            #endregion";
 248                         $lines[] = "            #region Constructors";
 249                         $lines[] = "            public ".ucfirst($table)."() { }";
 250                         $temp = array();
 251                         foreach ($tableProperties as $tablePropertie)
 252                                 if (! $tablePropertie->isPK())
 253                                         $temp[] = $tablePropertie->format("#dotNetPrimitiveType# #name#");
 254                         $lines[] = "            public ".ucfirst($table)."(".implode(", ", $temp).")";
 255                         $lines[] = "            {";
 256                         foreach ($tableProperties as $tablePropertie)
 257                                 if (! $tablePropertie->isPK())
 258                                         $lines[] = $tablePropertie->format("                    this._#name#=#name#;");
 259                         $lines[] = "            }";
 260                         $lines[] = "            #endregion";
 261                         $lines[] = "            #region Public Properties";
 262                         foreach ($tableProperties as $tablePropertie)
 263                                 $lines[] = $tablePropertie->format("            public virtual #dotNetPrimitiveType# _#ucfirstName#\n           {\n                     get {return _#name#;}\n                 set {_#name#=value;}\n          }");
 264                         $lines[] = "            #endregion";
 265                         $lines[] = "    }";
 266                         $lines[] = "    #endregion";
 267                         $lines[] = "}";
 268                         PMA_DBI_free_result($result);
 269                 }
 270                 return implode("\n", $lines);
 271         }
 272
 273         function handleNHibernateXMLBody($db, $table, $crlf)
 274         {
 275                 $lines=array();
 276                 $lines[] = "<?xml version=\"1.0\" encoding=\"utf-8\" ?>";
 277                 $lines[] = "<hibernate-mapping xmlns=\"urn:nhibernate-mapping-2.2\" namespace=\"".ucfirst($db)."\" assembly=\"".ucfirst($db)."\">";
 278                 $lines[] = "    <class name=\"".ucfirst($table)."\" table=\"".$table."\">";
 279                 $result = PMA_DBI_query(sprintf("DESC %s.%s", PMA_backquote($db), PMA_backquote($table)));
 280                 if ($result)
 281                 {
 282                         $tableProperties = array();
 283                         while ($row = PMA_DBI_fetch_row($result))
 284                                 $tableProperties[] = new TableProperty($row);
 285                         foreach ($tableProperties as $tablePropertie)
 286                         {
 287                                 if ($tablePropertie->isPK())
 288                                         $lines[] = $tablePropertie->format("            <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>");
 289                                 else
 290                                         $lines[] = $tablePropertie->format("            <property name=\"#ucfirstName#\" type=\"#dotNetObjectType#\">\n                 <column name=\"#name#\" sql-type=\"#type#\" not-null=\"#notNull#\" #indexName#/>\n              </property>");
 291                         }
 292                         PMA_DBI_free_result($result);
 293                 }
 294                 $lines[]="      </class>";
 295                 $lines[]="</hibernate-mapping>";
 296                 return implode("\n", $lines);
 297         }
 298
 299         function cgGetOption($optionName)
 300         {
 301                 global $what;
 302                 return $GLOBALS[$what . "_" . $optionName];
 303         }
 304 }
 305 ?>