Source for file mysql.dbtools.php

Documentation is available at mysql.dbtools.php

  1. <?php
  2. /**
  3. @package    jelix
  4. @subpackage db_driver
  5. @author     GĂ©rald Croes, Laurent Jouanneau
  6. @contributor Laurent Jouanneau
  7. @copyright  2001-2005 CopixTeam, 2005-2011 Laurent Jouanneau
  8. *  This class was get originally from the Copix project (CopixDbToolsMysql, Copix 2.3dev20050901, http://www.copix.org)
  9. *  Some lines of code are copyrighted 2001-2005 CopixTeam (LGPL licence).
  10. *  Initial authors of this Copix class are Gerald Croes and Laurent Jouanneau,
  11. *  and this class was adapted/improved for Jelix by Laurent Jouanneau
  12. *
  13. @link      http://www.jelix.org
  14. @licence  http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public Licence, see LICENCE file
  15. */
  16.  
  17. /**
  18.  * Provides utilities methods for a mysql database
  19.  * @package    jelix
  20.  * @subpackage db_driver
  21.  */
  22. class mysqlDbTools extends jDbTools {
  23.  
  24.     protected $typesInfo = array(
  25.       // type                  native type        unified type  minvalue     maxvalue   minlength  maxlength
  26.       'bool'            =>array('boolean',          'boolean',  0,           1,          null,     null),
  27.       'boolean'         =>array('boolean',          'boolean',  0,           1,          null,     null),
  28.       'bit'             =>array('bit',              'integer',  0,           1,          null,     null),
  29.       'tinyint'         =>array('tinyint',          'integer',  -128,        127,        null,     null),
  30.       'smallint'        =>array('smallint',         'integer',  -32768,      32767,      null,     null),
  31.       'mediumint'       =>array('mediumint',        'integer',  -8388608,    8388607,    null,     null),
  32.       'integer'         =>array('integer',          'integer',  -21474836482147483647null,     null),
  33.       'int'             =>array('integer',          'integer',  -21474836482147483647null,     null),
  34.       'bigint'          =>array('bigint',           'numeric',  '-9223372036854775808''9223372036854775807'nullnull),
  35.       'serial'          =>array('integer',          'numeric',  '-9223372036854775808''9223372036854775807'nullnull),
  36.       'bigserial'       =>array('integer',          'numeric',  '-9223372036854775808''9223372036854775807'nullnull),
  37.       'autoincrement'   =>array('integer',          'integer',  -21474836482147483647null,     null)// for old dao files
  38.       'bigautoincrement'=>array('bigint',           'numeric',  '-9223372036854775808''9223372036854775807'nullnull),// for old dao files
  39.  
  40.       'float'           =>array('float',            'float',    null,       null,       null,     null)//4bytes
  41.       'money'           =>array('float',            'float',    null,       null,       null,     null)//4bytes
  42.       'double precision'=>array('double precision''decimal',  null,       null,       null,     null)//8bytes
  43.       'double'          =>array('double precision''decimal',  null,       null,       null,     null)//8bytes
  44.       'real'            =>array('real',             'decimal',  null,       null,       null,     null)//8bytes
  45.       'number'          =>array('real',             'decimal',  null,       null,       null,     null)//8bytes
  46.       'binary_float'    =>array('float',            'float',    null,       null,       null,     null)//4bytes
  47.       'binary_double'   =>array('real',             'decimal',  null,       null,       null,     null)//8bytes
  48.  
  49.       'numeric'         =>array('numeric',          'numeric',  null,       null,       null,     null),
  50.       'decimal'         =>array('decimal',          'decimal',  null,       null,       null,     null),
  51.       'dec'             =>array('decimal',          'decimal',  null,       null,       null,     null),
  52.  
  53.       'date'            =>array('date',       'date',       null,       null,       10,    10),
  54.       'time'            =>array('time',       'time',       null,       null,       8,     8),
  55.       'datetime'        =>array('datetime',   'datetime',   null,       null,       19,    19),
  56.       'timestamp'       =>array('datetime',   'datetime',   null,       null,       19,    19)// oracle/pgsql timestamp
  57.       'utimestamp'      =>array('timestamp',  'integer',    0,          2147483647null,  null)// mysql timestamp
  58.       'year'            =>array('year',       'year',       null,       null,       2,     4),
  59.       'interval'        =>array('datetime',   'datetime',   null,       null,       19,    19),
  60.  
  61.       'char'            =>array('char',       'char',       null,       null,       0,     255),
  62.       'nchar'           =>array('char',       'char',       null,       null,       0,     255),
  63.       'varchar'         =>array('varchar',    'varchar',    null,       null,       0,     65535),
  64.       'varchar2'        =>array('varchar',    'varchar',    null,       null,       0,     4000),
  65.       'nvarchar2'       =>array('varchar',    'varchar',    null,       null,       0,     4000),
  66.       'character'       =>array('varchar',    'varchar',    null,       null,       0,     65535),
  67.       'character varying'=>array('varchar',   'varchar',    null,       null,       0,     65535),
  68.       'name'            =>array('varchar',    'varchar',    null,       null,       0,     64),
  69.       'longvarchar'     =>array('varchar',    'varchar',    null,       null,       0,     65535),
  70.       'string'          =>array('varchar',    'varchar',    null,       null,       0,     65535),// for old dao files
  71.  
  72.       'tinytext'        =>array('tinytext',   'text',       null,       null,       0,     255),
  73.       'text'            =>array('text',       'text',       null,       null,       0,     65535),
  74.       'mediumtext'      =>array('mediumtext''text',       null,       null,       0,     16777215),
  75.       'longtext'        =>array('longtext',   'text',       null,       null,       0,     0),
  76.       'long'            =>array('longtext',   'text',       null,       null,       0,     0),
  77.       'clob'            =>array('longtext',   'text',       null,       null,       0,     0),
  78.       'nclob'           =>array('longtext',   'text',       null,       null,       0,     0),
  79.  
  80.  
  81.       'tinyblob'        =>array('tinyblob',   'varbinary',  null,       null,       0,     255),
  82.       'blob'            =>array('blob',       'varbinary',  null,       null,       0,     65535),
  83.       'mediumblob'      =>array('mediumblob''varbinary',  null,       null,       0,     16777215),
  84.       'longblob'        =>array('longblob',   'varbinary',  null,       null,       0,     0),
  85.       'bfile'           =>array('longblob',   'varbinary',  null,       null,       0,     0),
  86.  
  87.       'bytea'           =>array('longblob',   'varbinary',  null,       null,       0,     0),
  88.       'binary'          =>array('binary',     'binary',     null,       null,       0,     255),
  89.       'varbinary'       =>array('varbinary',  'varbinary',  null,       null,       0,     255),
  90.       'raw'             =>array('varbinary',  'varbinary',  null,       null,       0,     2000),
  91.       'long raw'        =>array('varbinary',  'varbinary',  null,       null,       0,     0),
  92.  
  93.       'enum'            =>array('varchar',    'varchar',    null,       null,       0,     65535),
  94.       'set'             =>array('varchar',    'varchar',    null,       null,       0,     65535),
  95.       'xmltype'         =>array('varchar',    'varchar',    null,       null,       0,     65535),
  96.  
  97.       'point'           =>array('varchar',    'varchar',    null,       null,       0,     16),
  98.       'line'            =>array('varchar',    'varchar',    null,       null,       0,     32),
  99.       'lsed'            =>array('varchar',    'varchar',    null,       null,       0,     32),
  100.       'box'             =>array('varchar',    'varchar',    null,       null,       0,     32),
  101.       'path'            =>array('varchar',    'varchar',    null,       null,       0,     65535),
  102.       'polygon'         =>array('varchar',    'varchar',    null,       null,       0,     65535),
  103.       'circle'          =>array('varchar',    'varchar',    null,       null,       0,     24),
  104.       'cidr'            =>array('varchar',    'varchar',    null,       null,       0,     24),
  105.       'inet'            =>array('varchar',    'varchar',    null,       null,       0,     24),
  106.       'macaddr'         =>array('integer',    'integer',    0,          0xFFFFFFFFFFFFnull,       null),
  107.       'bit varying'     =>array('varchar',    'varchar',    null,       null,       0,     65535),
  108.       'arrays'          =>array('varchar',    'varchar',    null,       null,       0,     65535),
  109.       'complex types'   =>array('varchar',    'varchar',    null,       null,       0,     65535),
  110.     );
  111.  
  112.     public function encloseName($name){
  113.         return '`'.$name.'`';
  114.     }
  115.  
  116.     /**
  117.     * returns the list of tables
  118.     * @return   array    list of table names
  119.     */
  120.     public function getTableList ({
  121.         $results array ();
  122.         if (isset($this->_conn->profile['database'])) {
  123.             $db $this->_conn->profile['database'];
  124.         }
  125.         else if (isset($this->_conn->profile['dsn'])
  126.                  && preg_match('/dbname=([a-z0-9_ ]*)/'$this->_conn->profile['dsn']$m)){
  127.             $db $m[1];
  128.         }
  129.         else {
  130.             throw new jException("jelix~error.no.database.name"$this->_conn->profile['name']);
  131.         }
  132.         $rs $this->_conn->query ('SHOW TABLES FROM '.$this->encloseName($db));
  133.         $col_name 'Tables_in_'.$db;
  134.  
  135.         while ($line $rs->fetch ()){
  136.             $results[$line->$col_name;
  137.         }
  138.  
  139.         return $results;
  140.     }
  141.  
  142.     /**
  143.     * retrieve the list of fields of a table
  144.     * @param string $tableName the name of the table
  145.     * @param string $sequence  the sequence used to auto increment the primary key (not supported here)
  146.     * @return   array    keys are field names and values are jDbFieldProperties objects
  147.     */
  148.     public function getFieldList ($tableName$sequence=''{
  149.  
  150.         $tableName $this->_conn->prefixTable($tableName);
  151.         $results array ();
  152.  
  153.         $rs $this->_conn->query ('SHOW FIELDS FROM `'.$tableName.'`');
  154.  
  155.         while ($line $rs->fetch ()){
  156.             $field new jDbFieldProperties();
  157.  
  158.             if (preg_match('/^(\w+)\s*(\((\d+)\))?.*$/',$line->Type,$m)) {
  159.                 $field->type strtolower($m[1]);
  160.                 if ($field->type == 'varchar' && isset($m[3])) {
  161.                     $field->length intval($m[3]);
  162.                 }
  163.             else {
  164.                 $field->type $line->Type;
  165.             }
  166.             $typeinfo $this->getTypeInfo($field->type);
  167.             $field->unifiedType $typeinfo[1];
  168.             $field->maxValue $typeinfo[3];
  169.             $field->minValue $typeinfo[2];
  170.             $field->maxLength $typeinfo[5];
  171.             $field->minLength $typeinfo[4];
  172.             if ($field->length !=0)
  173.                 $field->maxLength $field->length;
  174.  
  175.             $field->name $line->Field;
  176.             $field->notNull ($line->Null == 'NO');
  177.             $field->primary ($line->Key == 'PRI');
  178.             $field->autoIncrement  ($line->Extra == 'auto_increment');
  179.             $field->hasDefault ($line->Default != '' || !($line->Default == null && $field->notNull));
  180.             // to fix a bug in php 5.2.5 or mysql 5.0.51
  181.             if($field->notNull && $line->Default === null && !$field->autoIncrement)
  182.                 $field->default ='';
  183.             else
  184.                 $field->default $line->Default;
  185.             $results[$line->Field$field;
  186.         }
  187.         return $results;
  188.     }
  189.  
  190.     public function execSQLScript ($file{
  191.         if(!isset($this->_conn->profile['table_prefix']))
  192.             $prefix '';
  193.         else
  194.             $prefix $this->_conn->profile['table_prefix'];
  195.         $sqlQueries str_replace('%%PREFIX%%'$prefixfile_get_contents($file));
  196.         $queries $this->parseSQLScript($sqlQueries);
  197.         foreach($queries as $query)
  198.             $this->_conn->exec($query);
  199.         return count($queries);
  200.     }
  201.  
  202.     /**
  203.      *
  204.      */
  205.     protected function parseSQLScript($script{
  206.  
  207.         $delimiters array();
  208.         $distinctDelimiters array(';');
  209.         if(preg_match_all("/DELIMITER ([^\n]*)/i"$script$dPREG_SET_ORDER)) {
  210.             $delimiters $d[1];
  211.             $distinctDelimiters array_unique(array_merge($distinctDelimiters,$delimiters));
  212.         }
  213.         $preg'';
  214.         foreach($distinctDelimiters as $dd{
  215.             $preg.='|'.preg_quote($dd);
  216.         }
  217.  
  218.         $tokens preg_split('!(\'|"|\\\\|`|DELIMITER |#|/\\*|\\*/|\\-\\-(?=\s)|'."\n".$preg.')!i'$script-1PREG_SPLIT_DELIM_CAPTURE PREG_SPLIT_NO_EMPTY);
  219.  
  220.         $currentDelimiter ';';
  221.         $context 0;
  222.         $queries array();
  223.         $query '';
  224.         $previousToken '';
  225.         foreach ($tokens as $k=>$token{
  226.             switch ($context{
  227.             // 0 : statement
  228.             case 0:
  229.                 $previousToken $token;
  230.                 switch($token{
  231.                 case $currentDelimiter:
  232.                     if (preg_replace("/\s/","",$query!= ''{
  233.                         $queries[trim($query);
  234.                     }
  235.                     $query '';
  236.                     break;
  237.                 case '\'':
  238.                     $context 1;
  239.                     $previousToken '';
  240.                     $query.=$token;
  241.                     break;
  242.                 case '"':
  243.                     $context 2;
  244.                     $previousToken '';
  245.                     $query.=$token;
  246.                     break;
  247.                 case '`':
  248.                     $context 3;
  249.                     $query.=$token;
  250.                     $previousToken '';
  251.                     break;
  252.                 case 'DELIMITER ':
  253.                     $context 6;
  254.                     break;
  255.                 case '#':
  256.                 case '--':
  257.                     $context 4;
  258.                     break;
  259.                 case '/*':
  260.                     $context 5;
  261.                     break;
  262.                 case "\n":
  263.                 default :
  264.                     $query.=$token;
  265.                 }
  266.                 break;
  267.             // 1 : string '
  268.             case 1:
  269.                 if ($token =="'"{
  270.                     if ($previousToken != "\\" && $previousToken != "'"{
  271.                         if(isset($tokens[$k+1])) {
  272.                             if ($tokens[$k+1!= "'"{
  273.                                 $context 0;
  274.                             }
  275.                         }
  276.                         else
  277.                             $context 0;
  278.                     }
  279.                 }
  280.                 $previousToken $token;
  281.                 $query.=$token;
  282.                 break;
  283.             // 2 : string "
  284.             case 2:
  285.                 if ($token =='"'{
  286.                     if ($previousToken != "\\" && $previousToken != '"'{
  287.                         if(isset($tokens[$k+1])) {
  288.                             if ($tokens[$k+1!= '"'{
  289.                                 $context 0;
  290.                             }
  291.                         }
  292.                         else
  293.                             $context 0;
  294.                     }
  295.                 }
  296.                 $previousToken $token;
  297.                 $query.=$token;
  298.                 break;
  299.             // 3 : name with `
  300.             case 3:
  301.                 if ($token =='`'{
  302.                     if ($previousToken != "\\" && $previousToken != '`'{
  303.                         if(isset($tokens[$k+1])) {
  304.                             if ($tokens[$k+1!= '`'{
  305.                                 $context 0;
  306.                             }
  307.                         }
  308.                         else
  309.                             $context 0;
  310.                     }
  311.                 }
  312.                 $previousToken $token;
  313.                 $query.=$token;
  314.                 break;
  315.             // 4 : comment single line
  316.             case 4:
  317.                 if ($token == "\n"{
  318.                     //$query.=$token;
  319.                     $context 0;
  320.                 }
  321.                 break;
  322.             // 5 : comment multi line
  323.             case 5:
  324.                 if ($token == "*/"{
  325.                     $context 0;
  326.                 }
  327.                 break;
  328.             // 6 : delimiter definition
  329.             case 6:
  330.                 $currentDelimiter $token;
  331.                 $context 0;
  332.                 break;
  333.             }
  334.  
  335.         }
  336.         if (preg_replace("/\s/","",$query!= ''{
  337.             $queries[trim($query);
  338.         }
  339.         return $queries;
  340.     }
  341. }

Documentation generated on Mon, 26 Oct 2015 21:57:40 +0100 by phpDocumentor 1.4.3