libraries/dbi/mysql.dbi.lib.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Interface to the classic MySQL extension
   5  *
   6  * @package phpMyAdmin-DBI-MySQL
   7  */
   8 if (! defined('PHPMYADMIN')) {
   9     exit;
  10 }
  11
  12 require_once './libraries/logging.lib.php';
  13
  14 /**
  15  * MySQL client API
  16  */
  17 if (! defined('PMA_MYSQL_CLIENT_API')) {
  18     $client_api = explode('.', mysql_get_client_info());
  19     define('PMA_MYSQL_CLIENT_API', (int)sprintf('%d%02d%02d', $client_api[0], $client_api[1], intval($client_api[2])));
  20     unset($client_api);
  21 }
  22
  23 function PMA_DBI_real_connect($server, $user, $password, $client_flags, $persistant=false)
  24 {
  25     global $cfg;
  26
  27     if (empty($client_flags)) {
  28         if ($cfg['PersistentConnections'] || $persistant) {
  29             $link = @mysql_pconnect($server, $user, $password);
  30         } else {
  31             $link = @mysql_connect($server, $user, $password);
  32         }
  33     } else {
  34         if ($cfg['PersistentConnections'] || $persistant) {
  35             $link = @mysql_pconnect($server, $user, $password, $client_flags);
  36         } else {
  37             $link = @mysql_connect($server, $user, $password, false, $client_flags);
  38         }
  39     }
  40
  41     return $link;
  42 }
  43 /**
  44  * @param   string  $user           mysql user name
  45  * @param   string  $password       mysql user password
  46  * @param   boolean $is_controluser
  47  * @param   array   $server host/port/socket/persistant
  48  * @param   boolean $auxiliary_connection (when true, don't go back to login if connection fails)
  49  * @return  mixed   false on error or a mysqli object on success
  50  */
  51 function PMA_DBI_connect($user, $password, $is_controluser = false, $server = null, $auxiliary_connection = false)
  52 {
  53     global $cfg, $php_errormsg;
  54
  55     if ($server) {
  56         $server_port = (empty($server['port']))
  57             ? ''
  58             : ':' . (int)$server['port'];
  59         $server_socket = (empty($server['socket']))
  60             ? ''
  61             : ':' . $server['socket'];
  62         $server_persistant = (empty($server['persistant']))
  63             ? false
  64             : true;
  65     } else {
  66           $server_port   = (empty($cfg['Server']['port']))
  67                    ? ''
  68                    : ':' . (int)$cfg['Server']['port'];
  69           $server_socket = (empty($cfg['Server']['socket']))
  70                    ? ''
  71                    : ':' . $cfg['Server']['socket'];
  72     }
  73
  74     if (strtolower($cfg['Server']['connect_type']) == 'tcp') {
  75         $cfg['Server']['socket'] = '';
  76     }
  77
  78     $client_flags = 0;
  79
  80     // always use CLIENT_LOCAL_FILES as defined in mysql_com.h
  81     // for the case where the client library was not compiled
  82     // with --enable-local-infile
  83     $client_flags |= 128;
  84
  85     /* Optionally compress connection */
  86     if (defined('MYSQL_CLIENT_COMPRESS') && $cfg['Server']['compress']) {
  87         $client_flags |= MYSQL_CLIENT_COMPRESS;
  88     }
  89
  90     /* Optionally enable SSL */
  91     if (defined('MYSQL_CLIENT_SSL') && $cfg['Server']['ssl']) {
  92         $client_flags |= MYSQL_CLIENT_SSL;
  93     }
  94
  95     if (!$server) {
  96         $link = PMA_DBI_real_connect($cfg['Server']['host'] . $server_port . $server_socket, $user, $password, empty($client_flags) ? NULL : $client_flags);
  97
  98       // Retry with empty password if we're allowed to
  99         if (empty($link) && $cfg['Server']['nopassword'] && !$is_controluser) {
 100                 $link = PMA_DBI_real_connect($cfg['Server']['host'] . $server_port . $server_socket, $user, '', empty($client_flags) ? NULL : $client_flags);
 101         }
 102     } else {
 103         if (!isset($server['host'])) {
 104                 $link = PMA_DBI_real_connect($server_socket, $user, $password, NULL, $server_persistant);
 105         } else {
 106             $link = PMA_DBI_real_connect($server['host'] . $server_port . $server_socket, $user, $password, NULL, $server_persistant);
 107         }
 108     }
 109     if (empty($link)) {
 110         if ($is_controluser) {
 111             trigger_error(__('Connection for controluser as defined in your configuration failed.'), E_USER_WARNING);
 112             return false;
 113         }
 114         // we could be calling PMA_DBI_connect() to connect to another
 115         // server, for example in the Synchronize feature, so do not
 116         // go back to main login if it fails
 117         if (! $auxiliary_connection) {
 118             PMA_log_user($user, 'mysql-denied');
 119             PMA_auth_fails();
 120         } else {
 121             return false;
 122         }
 123     } // end if
 124     if (! $server) {
 125         PMA_DBI_postConnect($link, $is_controluser);
 126     }
 127     return $link;
 128 }
 129
 130 /**
 131  * select a db
 132  *
 133  * @param string $dbname name of db to select
 134  * @param resource $link mysql link resource
 135  * @return boolean success
 136  */
 137 function PMA_DBI_select_db($dbname, $link = null)
 138 {
 139     if (empty($link)) {
 140         if (isset($GLOBALS['userlink'])) {
 141             $link = $GLOBALS['userlink'];
 142         } else {
 143             return false;
 144         }
 145     }
 146     return mysql_select_db($dbname, $link);
 147 }
 148
 149 /**
 150  * runs a query and returns the result
 151  *
 152  * @param string $query query to run
 153  * @param resource $link mysql link resource
 154  * @param integer $options
 155  * @return mixed
 156  */
 157 function PMA_DBI_try_query($query, $link = null, $options = 0)
 158 {
 159     if (empty($link)) {
 160         if (isset($GLOBALS['userlink'])) {
 161             $link = $GLOBALS['userlink'];
 162         } else {
 163             return false;
 164         }
 165     }
 166
 167     if ($GLOBALS['cfg']['DBG']['sql']) {
 168         $time = microtime(true);
 169     }
 170     if ($options == ($options | PMA_DBI_QUERY_STORE)) {
 171         $r = mysql_query($query, $link);
 172     } elseif ($options == ($options | PMA_DBI_QUERY_UNBUFFERED)) {
 173         $r = mysql_unbuffered_query($query, $link);
 174     } else {
 175         $r = mysql_query($query, $link);
 176     }
 177
 178     if ($GLOBALS['cfg']['DBG']['sql']) {
 179         $time = microtime(true) - $time;
 180
 181         $hash = md5($query);
 182
 183         if (isset($_SESSION['debug']['queries'][$hash])) {
 184             $_SESSION['debug']['queries'][$hash]['count']++;
 185         } else {
 186             $_SESSION['debug']['queries'][$hash] = array();
 187             $_SESSION['debug']['queries'][$hash]['count'] = 1;
 188             $_SESSION['debug']['queries'][$hash]['query'] = $query;
 189             $_SESSION['debug']['queries'][$hash]['time'] = $time;
 190         }
 191
 192         $trace = array();
 193         foreach (debug_backtrace() as $trace_step) {
 194             $trace[] = PMA_Error::relPath($trace_step['file']) . '#'
 195                 . $trace_step['line'] . ': '
 196                 . (isset($trace_step['class']) ? $trace_step['class'] : '')
 197                 //. (isset($trace_step['object']) ? get_class($trace_step['object']) : '')
 198                 . (isset($trace_step['type']) ? $trace_step['type'] : '')
 199                 . (isset($trace_step['function']) ? $trace_step['function'] : '')
 200                 . '('
 201                 . (isset($trace_step['params']) ? implode(', ', $trace_step['params']) : '')
 202                 . ')'
 203                 ;
 204         }
 205         $_SESSION['debug']['queries'][$hash]['trace'][] = $trace;
 206     }
 207     if ($r != FALSE && PMA_Tracker::isActive() == TRUE ) {
 208         PMA_Tracker::handleQuery($query);
 209     }
 210
 211     return $r;
 212 }
 213
 214 function PMA_DBI_fetch_array($result)
 215 {
 216     return mysql_fetch_array($result, MYSQL_BOTH);
 217 }
 218
 219 function PMA_DBI_fetch_assoc($result) {
 220     return mysql_fetch_array($result, MYSQL_ASSOC);
 221 }
 222
 223 function PMA_DBI_fetch_row($result)
 224 {
 225     return mysql_fetch_array($result, MYSQL_NUM);
 226 }
 227
 228 /*
 229  * Adjusts the result pointer to an arbitrary row in the result
 230  *
 231  * @uses    mysql_data_seek()
 232  * @param   $result
 233  * @param   $offset
 234  * @return  boolean true on success, false on failure
 235  */
 236 function PMA_DBI_data_seek($result, $offset)
 237 {
 238     return mysql_data_seek($result, $offset);
 239 }
 240
 241 /**
 242  * Frees the memory associated with the results
 243  *
 244  * @param result    $result,...     one or more mysql result resources
 245  */
 246 function PMA_DBI_free_result()
 247 {
 248     foreach (func_get_args() as $result) {
 249         if (is_resource($result)
 250          && get_resource_type($result) === 'mysql result') {
 251             mysql_free_result($result);
 252         }
 253     }
 254 }
 255
 256 /**
 257  * Returns a string representing the type of connection used
 258  * @uses    mysql_get_host_info()
 259  * @uses    $GLOBALS['userlink']    as default for $link
 260  * @param   resource        $link   mysql link
 261  * @return  string          type of connection used
 262  */
 263 function PMA_DBI_get_host_info($link = null)
 264 {
 265     if (null === $link) {
 266         if (isset($GLOBALS['userlink'])) {
 267             $link = $GLOBALS['userlink'];
 268         } else {
 269             return false;
 270         }
 271     }
 272     return mysql_get_host_info($link);
 273 }
 274
 275 /**
 276  * Returns the version of the MySQL protocol used
 277  * @uses    mysql_get_proto_info()
 278  * @uses    $GLOBALS['userlink']    as default for $link
 279  * @param   resource        $link   mysql link
 280  * @return  integer         version of the MySQL protocol used
 281  */
 282 function PMA_DBI_get_proto_info($link = null)
 283 {
 284     if (null === $link) {
 285         if (isset($GLOBALS['userlink'])) {
 286             $link = $GLOBALS['userlink'];
 287         } else {
 288             return false;
 289         }
 290     }
 291     return mysql_get_proto_info($link);
 292 }
 293
 294 /**
 295  * returns a string that represents the client library version
 296  * @uses    mysql_get_client_info()
 297  * @return  string          MySQL client library version
 298  */
 299 function PMA_DBI_get_client_info()
 300 {
 301     return mysql_get_client_info();
 302 }
 303
 304 /**
 305  * returns last error message or false if no errors occured
 306  *
 307  * @uses    PMA_DBI_convert_message()
 308  * @uses    $GLOBALS['errno']
 309  * @uses    $GLOBALS['userlink']
 310  * @uses    mysql_errno()
 311  * @uses    mysql_error()
 312  * @uses    defined()
 313  * @uses    PMA_generate_common_url()
 314  * @param   resource        $link   mysql link
 315  * @return  string|boolean  $error or false
 316  */
 317 function PMA_DBI_getError($link = null)
 318 {
 319     $GLOBALS['errno'] = 0;
 320
 321     /* Treat false same as null because of controllink */
 322     if ($link === false) {
 323         $link = null;
 324     }
 325
 326     if (null === $link && isset($GLOBALS['userlink'])) {
 327         $link =& $GLOBALS['userlink'];
 328
 329 // Do not stop now. On the initial connection, we don't have a $link,
 330 // we don't have a $GLOBALS['userlink'], but we can catch the error code
 331 //    } else {
 332 //            return false;
 333     }
 334
 335     if (null !== $link && false !== $link) {
 336         $error_number = mysql_errno($link);
 337         $error_message = mysql_error($link);
 338     } else {
 339         $error_number = mysql_errno();
 340         $error_message = mysql_error();
 341     }
 342     if (0 == $error_number) {
 343         return false;
 344     }
 345
 346     // keep the error number for further check after the call to PMA_DBI_getError()
 347     $GLOBALS['errno'] = $error_number;
 348
 349     if (! empty($error_message)) {
 350         $error_message = PMA_DBI_convert_message($error_message);
 351     }
 352
 353     $error_message = htmlspecialchars($error_message);
 354
 355     // Some errors messages cannot be obtained by mysql_error()
 356     if ($error_number == 2002) {
 357         $error = '#' . ((string) $error_number) . ' - ' . __('The server is not responding') . ' ' . __('(or the local MySQL server\'s socket is not correctly configured)');
 358     } elseif ($error_number == 2003) {
 359         $error = '#' . ((string) $error_number) . ' - ' . __('The server is not responding');
 360     } elseif ($error_number == 1005) {
 361         /* InnoDB contraints, see
 362          * http://dev.mysql.com/doc/refman/5.0/en/innodb-foreign-key-constraints.html
 363          */
 364         $error = '#' . ((string) $error_number) . ' - ' . $error_message .
 365             ' (<a href="server_engines.php' . PMA_generate_common_url(array('engine' => 'InnoDB', 'page' => 'Status')).
 366             '">' . __('Details...') . '</a>)';
 367     } else {
 368         $error = '#' . ((string) $error_number) . ' - ' . $error_message;
 369     }
 370     return $error;
 371 }
 372
 373 function PMA_DBI_num_rows($result)
 374 {
 375     if (!is_bool($result)) {
 376         return mysql_num_rows($result);
 377     } else {
 378         return 0;
 379     }
 380 }
 381
 382 function PMA_DBI_insert_id($link = null)
 383 {
 384     if (empty($link)) {
 385         if (isset($GLOBALS['userlink'])) {
 386             $link = $GLOBALS['userlink'];
 387         } else {
 388             return false;
 389         }
 390     }
 391     //$insert_id = mysql_insert_id($link);
 392     // if the primary key is BIGINT we get an incorrect result
 393     // (sometimes negative, sometimes positive)
 394     // and in the present function we don't know if the PK is BIGINT
 395     // so better play safe and use LAST_INSERT_ID()
 396     //
 397     // by the way, no problem with mysqli_insert_id()
 398     return PMA_DBI_fetch_value('SELECT LAST_INSERT_ID();', 0, 0, $link);
 399 }
 400
 401 function PMA_DBI_affected_rows($link = null)
 402 {
 403     if (empty($link)) {
 404         if (isset($GLOBALS['userlink'])) {
 405             $link = $GLOBALS['userlink'];
 406         } else {
 407             return false;
 408         }
 409     }
 410     return mysql_affected_rows($link);
 411 }
 412
 413 /**
 414  * @todo add missing keys like in from mysqli_query (orgname, orgtable, flags, decimals)
 415  */
 416 function PMA_DBI_get_fields_meta($result)
 417 {
 418     $fields       = array();
 419     $num_fields   = mysql_num_fields($result);
 420     for ($i = 0; $i < $num_fields; $i++) {
 421         $fields[] = mysql_fetch_field($result, $i);
 422     }
 423     return $fields;
 424 }
 425
 426 function PMA_DBI_num_fields($result)
 427 {
 428     return mysql_num_fields($result);
 429 }
 430
 431 function PMA_DBI_field_len($result, $i)
 432 {
 433     return mysql_field_len($result, $i);
 434 }
 435
 436 function PMA_DBI_field_name($result, $i)
 437 {
 438     return mysql_field_name($result, $i);
 439 }
 440
 441 function PMA_DBI_field_flags($result, $i)
 442 {
 443     return mysql_field_flags($result, $i);
 444 }
 445
 446 ?>