Source for file mysql.php

Documentation is available at mysql.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Libraries
  4.  * @subpackage  Schema
  5.  *
  6.  * @copyright   Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
  7.  * @license     GNU General Public License version 2 or later; see LICENSE
  8.  */
  9.  
  10. defined('_JEXEC') or die;
  11.  
  12. /**
  13.  * Checks the database schema against one MySQL DDL query to see if it has been run.
  14.  *
  15.  * @package     Joomla.Libraries
  16.  * @subpackage  Schema
  17.  * @since       2.5
  18.  */
  19. class JSchemaChangeitemMysql extends JSchemaChangeitem
  20. {
  21.     /**
  22.      * Checks a DDL query to see if it is a known type
  23.      * If yes, build a check query to see if the DDL has been run on the database.
  24.      * If successful, the $msgElements, $queryType, $checkStatus and $checkQuery fields are populated.
  25.      * The $msgElements contains the text to create the user message.
  26.      * The $checkQuery contains the SQL query to check whether the schema change has
  27.      * been run against the current database. The $queryType contains the type of
  28.      * DDL query that was run (for example, CREATE_TABLE, ADD_COLUMN, CHANGE_COLUMN_TYPE, ADD_INDEX).
  29.      * The $checkStatus field is set to zero if the query is created
  30.      *
  31.      * If not successful, $checkQuery is empty and , and $checkStatus is -1.
  32.      * For example, this will happen if the current line is a non-DDL statement.
  33.      *
  34.      * @return void 
  35.      *
  36.      * @since  2.5
  37.      */
  38.     protected function buildCheckQuery()
  39.     {
  40.         // Initialize fields in case we can't create a check query
  41.         $this->checkStatus = -1; // change status to skipped
  42.         $result = null;
  43.  
  44.         // Remove any newlines
  45.         $this->updateQuery = str_replace("\n", '', $this->updateQuery);
  46.  
  47.         // Fix up extra spaces around () and in general
  48.         $find = array('#((\s*)\(\s*([^)\s]+)\s*)(\))#', '#(\s)(\s*)#');
  49.         $replace = array('($3)', '$1');
  50.         $updateQuery = preg_replace($find, $replace, $this->updateQuery);
  51.         $wordArray = explode(' ', $updateQuery);
  52.  
  53.         // First, make sure we have an array of at least 6 elements
  54.         // if not, we can't make a check query for this one
  55.         if (count($wordArray) < 6)
  56.         {
  57.             // Done with method
  58.             return;
  59.         }
  60.  
  61.         // We can only make check queries for alter table and create table queries
  62.         $command = strtoupper($wordArray[0] . ' ' . $wordArray[1]);
  63.         if ($command === 'ALTER TABLE')
  64.         {
  65.             $alterCommand = strtoupper($wordArray[3] . ' ' . $wordArray[4]);
  66.             if ($alterCommand == 'ADD COLUMN')
  67.             {
  68.                 $result = 'SHOW COLUMNS IN ' . $wordArray[2] . ' WHERE field = ' . $this->fixQuote($wordArray[5]);
  69.                 $this->queryType = 'ADD_COLUMN';
  70.                 $this->msgElements = array($this->fixQuote($wordArray[2]), $this->fixQuote($wordArray[5]));
  71.             }
  72.             elseif ($alterCommand == 'ADD INDEX' || $alterCommand == 'ADD UNIQUE')
  73.             {
  74.                 if ($pos = strpos($wordArray[5], '('))
  75.                 {
  76.                     $index = $this->fixQuote(substr($wordArray[5], 0, $pos));
  77.                 }
  78.                 else
  79.                 {
  80.                     $index = $this->fixQuote($wordArray[5]);
  81.                 }
  82.                 $result = 'SHOW INDEXES IN ' . $wordArray[2] . ' WHERE Key_name = ' . $index;
  83.                 $this->queryType = 'ADD_INDEX';
  84.                 $this->msgElements = array($this->fixQuote($wordArray[2]), $index);
  85.             }
  86.             elseif ($alterCommand == 'DROP INDEX')
  87.             {
  88.                 $index = $this->fixQuote($wordArray[5]);
  89.                 $result = 'SHOW INDEXES IN ' . $wordArray[2] . ' WHERE Key_name = ' . $index;
  90.                 $this->queryType = 'DROP_INDEX';
  91.                 $this->checkQueryExpected = 0;
  92.                 $this->msgElements = array($this->fixQuote($wordArray[2]), $index);
  93.             }
  94.             elseif ($alterCommand == 'DROP COLUMN')
  95.             {
  96.                 $index = $this->fixQuote($wordArray[5]);
  97.                 $result = 'SHOW COLUMNS IN ' . $wordArray[2] . ' WHERE Field = ' . $index;
  98.                 $this->queryType = 'DROP_COLUMN';
  99.                 $this->checkQueryExpected = 0;
  100.                 $this->msgElements = array($this->fixQuote($wordArray[2]), $index);
  101.             }
  102.             elseif (strtoupper($wordArray[3]) == 'MODIFY')
  103.             {
  104.                 // Kludge to fix problem with "integer unsigned"
  105.                 $type = $this->fixQuote($wordArray[5]);
  106.                 if (isset($wordArray[6]))
  107.                 {
  108.                     $type = $this->fixQuote($this->fixInteger($wordArray[5], $wordArray[6]));
  109.                 }
  110.                 $result = 'SHOW COLUMNS IN ' . $wordArray[2] . ' WHERE field = ' . $this->fixQuote($wordArray[4]) . ' AND type = ' . $type;
  111.                 $this->queryType = 'CHANGE_COLUMN_TYPE';
  112.                 $this->msgElements = array($this->fixQuote($wordArray[2]), $this->fixQuote($wordArray[4]), $type);
  113.             }
  114.             elseif (strtoupper($wordArray[3]) == 'CHANGE')
  115.             {
  116.                 // Kludge to fix problem with "integer unsigned"
  117.                 $type = $this->fixQuote($this->fixInteger($wordArray[6], $wordArray[7]));
  118.                 $result = 'SHOW COLUMNS IN ' . $wordArray[2] . ' WHERE field = ' . $this->fixQuote($wordArray[4]) . ' AND type = ' . $type;
  119.                 $this->queryType = 'CHANGE_COLUMN_TYPE';
  120.                 $this->msgElements = array($this->fixQuote($wordArray[2]), $this->fixQuote($wordArray[4]), $type);
  121.             }
  122.         }
  123.  
  124.         if ($command == 'CREATE TABLE')
  125.         {
  126.             if (strtoupper($wordArray[2] . $wordArray[3] . $wordArray[4]) == 'IFNOTEXISTS')
  127.             {
  128.                 $table = $wordArray[5];
  129.             }
  130.             else
  131.             {
  132.                 $table = $wordArray[2];
  133.             }
  134.             $result = 'SHOW TABLES LIKE ' . $this->fixQuote($table);
  135.             $this->queryType = 'CREATE_TABLE';
  136.             $this->msgElements = array($this->fixQuote($table));
  137.         }
  138.  
  139.         // Set fields based on results
  140.         if ($this->checkQuery = $result)
  141.         {
  142.             // Unchecked status
  143.             $this->checkStatus = 0;
  144.         }
  145.         else
  146.         {
  147.             // Skipped
  148.             $this->checkStatus = -1;
  149.         }
  150.     }
  151.  
  152.     /**
  153.      * Fix up integer. Fixes problem with MySQL integer descriptions.
  154.      * If you change a column to "integer unsigned" it shows
  155.      * as "int(10) unsigned" in the check query.
  156.      *
  157.      * @param   string  $type1  the column type
  158.      * @param   string  $type2  the column attributes
  159.      *
  160.      * @return  string  The original or changed column type.
  161.      *
  162.      * @since   2.5
  163.      */
  164.     private function fixInteger($type1, $type2)
  165.     {
  166.         $result = $type1;
  167.         if (strtolower($type1) == "integer" && strtolower(substr($type2, 0, 8)) == 'unsigned')
  168.         {
  169.             $result = 'int(10) unsigned';
  170.         }
  171.         return $result;
  172.     }
  173.  
  174.     /**
  175.      * Fixes up a string for inclusion in a query.
  176.      * Replaces name quote character with normal quote for literal.
  177.      * Drops trailing semi-colon. Injects the database prefix.
  178.      *
  179.      * @param   string  $string  The input string to be cleaned up.
  180.      *
  181.      * @return  string  The modified string.
  182.      *
  183.      * @since   2.5
  184.      */
  185.     private function fixQuote($string)
  186.     {
  187.         $string = str_replace('`', '', $string);
  188.         $string = str_replace(';', '', $string);
  189.         $string = str_replace('#__', $this->db->getPrefix(), $string);
  190.         return $this->db->quote($string);
  191.     }
  192. }

Documentation generated on Tue, 19 Nov 2013 15:09:07 +0100 by phpDocumentor 1.4.3