php_pdo_mysql_int.h

Go to the documentation of this file.

/*
  +----------------------------------------------------------------------+
  | Copyright (c) The PHP Group                                          |
  +----------------------------------------------------------------------+
  | This source file is subject to version 3.01 of the PHP license,      |
  | that is bundled with this package in the file LICENSE, and is        |
  | available through the world-wide-web at the following url:           |
  | https://www.php.net/license/3_01.txt                                 |
  | If you did not receive a copy of the PHP license and are unable to   |
  | obtain it through the world-wide-web, please send a note to          |
  | license@php.net so we can mail you a copy immediately.               |
  +----------------------------------------------------------------------+
  | Author: George Schlossnagle <george@omniti.com>                      |
  |         Wez Furlong <wez@php.net>                                    |
  |         Johannes Schlueter <johannes@mysql.com>                      |
  +----------------------------------------------------------------------+
*/
 
/* internal header; not supposed to be installed */
 
#ifndef PHP_PDO_MYSQL_INT_H
#define PHP_PDO_MYSQL_INT_H
 
#ifdef PDO_USE_MYSQLND
#   include "ext/mysqlnd/mysqlnd.h"
#   include "ext/mysqlnd/mysqlnd_libmysql_compat.h"
#   define PDO_MYSQL_PARAM_BIND MYSQLND_PARAM_BIND
#else
#   include <mysql.h>
#if MYSQL_VERSION_ID >= 80000 &&  MYSQL_VERSION_ID < 100000
typedef _Bool       my_bool;
#endif
#   define PDO_MYSQL_PARAM_BIND MYSQL_BIND
#endif
 
#if defined(PDO_USE_MYSQLND) && PHP_DEBUG && !defined(PHP_WIN32)
#define PDO_DBG_ENABLED 1
 
#define PDO_DBG_INF(msg) do { if (!dbg_skip_trace) PDO_MYSQL_G(dbg)->m->log(PDO_MYSQL_G(dbg), __LINE__, __FILE__, -1, "info : ", (msg)); } while (0)
#define PDO_DBG_ERR(msg) do { if (!dbg_skip_trace) PDO_MYSQL_G(dbg)->m->log(PDO_MYSQL_G(dbg), __LINE__, __FILE__, -1, "error: ", (msg)); } while (0)
#define PDO_DBG_INF_FMT(...) do { if (!dbg_skip_trace) PDO_MYSQL_G(dbg)->m->log_va(PDO_MYSQL_G(dbg), __LINE__, __FILE__, -1, "info : ", __VA_ARGS__); } while (0)
#define PDO_DBG_ERR_FMT(...) do { if (!dbg_skip_trace) PDO_MYSQL_G(dbg)->m->log_va(PDO_MYSQL_G(dbg), __LINE__, __FILE__, -1, "error: ", __VA_ARGS__); } while (0)
#define PDO_DBG_ENTER(func_name) \
    bool dbg_skip_trace = true; \
    ((void) dbg_skip_trace); \
    if (PDO_MYSQL_G(dbg)) \
        dbg_skip_trace = !PDO_MYSQL_G(dbg)->m->func_enter(PDO_MYSQL_G(dbg), __LINE__, __FILE__, func_name, strlen(func_name));
 
#define PDO_DBG_RETURN(value)   do { if (PDO_MYSQL_G(dbg)) PDO_MYSQL_G(dbg)->m->func_leave(PDO_MYSQL_G(dbg), __LINE__, __FILE__, 0); return (value); } while (0)
#define PDO_DBG_VOID_RETURN     do { if (PDO_MYSQL_G(dbg)) PDO_MYSQL_G(dbg)->m->func_leave(PDO_MYSQL_G(dbg), __LINE__, __FILE__, 0); return; } while (0)
 
#else
#define PDO_DBG_ENABLED 0
 
static inline void PDO_DBG_INF(char *msg) {}
static inline void PDO_DBG_ERR(char *msg) {}
static inline void PDO_DBG_INF_FMT(char *format, ...) {}
static inline void PDO_DBG_ERR_FMT(char *format, ...) {}
static inline void PDO_DBG_ENTER(char *func_name) {}
#define PDO_DBG_RETURN(value)   return (value)
#define PDO_DBG_VOID_RETURN     return;
 
#endif
 
#ifdef PDO_USE_MYSQLND
#include "ext/mysqlnd/mysqlnd_debug.h"
#endif
 
ZEND_BEGIN_MODULE_GLOBALS(pdo_mysql)
#ifndef PHP_WIN32
    char          *default_socket;
#endif
#if PDO_DBG_ENABLED
    char          *debug; /* The actual string */
    MYSQLND_DEBUG *dbg; /* The DBG object */
#endif
#if defined(PHP_WIN32) && !PDO_DBG_ENABLED
    /* dummy member so we get at least one member in the struct
     * and avoids build errors.
     */
    void *dummymemmber;
#endif
ZEND_END_MODULE_GLOBALS(pdo_mysql)
 
ZEND_EXTERN_MODULE_GLOBALS(pdo_mysql)
#define PDO_MYSQL_G(v) ZEND_MODULE_GLOBALS_ACCESSOR(pdo_mysql, v)
 
#if defined(ZTS) && defined(COMPILE_DL_PDO_MYSQL)
ZEND_TSRMLS_CACHE_EXTERN()
#endif
 
 
typedef struct {
    const char *file;
    int line;
    unsigned int errcode;
    char *errmsg;
} pdo_mysql_error_info;
 
/* stuff we use in a mySQL database handle */
typedef struct {
    MYSQL      *server;
 
    unsigned assume_national_character_set_strings:1;
    unsigned attached:1;
    unsigned buffered:1;
    unsigned emulate_prepare:1;
    unsigned fetch_table_names:1;
    unsigned local_infile:1;
#ifndef PDO_USE_MYSQLND
    zend_ulong max_buffer_size;
#endif
 
    pdo_mysql_error_info einfo;
} pdo_mysql_db_handle;
 
typedef struct {
    MYSQL_FIELD      *def;
} pdo_mysql_column;
 
typedef struct {
    pdo_mysql_db_handle  *H;
    MYSQL_RES              *result;
    const MYSQL_FIELD        *fields;
    pdo_mysql_error_info    einfo;
#ifdef PDO_USE_MYSQLND
    MYSQLND_STMT            *stmt;
#else
    MYSQL_STMT                *stmt;
#endif
    int                     num_params;
    PDO_MYSQL_PARAM_BIND    *params;
#ifndef PDO_USE_MYSQLND
    my_bool                  *in_null;
    zend_ulong            *in_length;
    PDO_MYSQL_PARAM_BIND    *bound_result;
    my_bool                  *out_null;
    zend_ulong                *out_length;
    MYSQL_ROW              current_data;
    unsigned long           *current_lengths;
#else
    zval                    *current_row;
#endif
    unsigned                max_length:1;
    /* Whether all result sets have been fully consumed.
     * If this flag is not set, they need to be consumed during destruction. */
    unsigned                done:1;
} pdo_mysql_stmt;
 
extern const pdo_driver_t pdo_mysql_driver;
 
extern int pdo_mysql_scanner(pdo_scanner_t *s);
 
extern int _pdo_mysql_error(pdo_dbh_t *dbh, pdo_stmt_t *stmt, const char *file, int line);
#define pdo_mysql_error(s) _pdo_mysql_error(s, NULL, __FILE__, __LINE__)
#define pdo_mysql_error_stmt(s) _pdo_mysql_error(stmt->dbh, stmt, __FILE__, __LINE__)
 
extern const struct pdo_stmt_methods mysql_stmt_methods;
 
enum {
    PDO_MYSQL_ATTR_USE_BUFFERED_QUERY = PDO_ATTR_DRIVER_SPECIFIC,
    PDO_MYSQL_ATTR_LOCAL_INFILE,
    PDO_MYSQL_ATTR_INIT_COMMAND,
#ifndef PDO_USE_MYSQLND
    PDO_MYSQL_ATTR_READ_DEFAULT_FILE,
    PDO_MYSQL_ATTR_READ_DEFAULT_GROUP,
    PDO_MYSQL_ATTR_MAX_BUFFER_SIZE,
#endif
    PDO_MYSQL_ATTR_COMPRESS,
    PDO_MYSQL_ATTR_DIRECT_QUERY,
    PDO_MYSQL_ATTR_FOUND_ROWS,
    PDO_MYSQL_ATTR_IGNORE_SPACE,
    PDO_MYSQL_ATTR_SSL_KEY,
    PDO_MYSQL_ATTR_SSL_CERT,
    PDO_MYSQL_ATTR_SSL_CA,
    PDO_MYSQL_ATTR_SSL_CAPATH,
    PDO_MYSQL_ATTR_SSL_CIPHER,
#if MYSQL_VERSION_ID > 50605 || defined(PDO_USE_MYSQLND)
    PDO_MYSQL_ATTR_SERVER_PUBLIC_KEY,
#endif
    PDO_MYSQL_ATTR_MULTI_STATEMENTS,
#ifdef PDO_USE_MYSQLND
    PDO_MYSQL_ATTR_SSL_VERIFY_SERVER_CERT,
#endif
#if MYSQL_VERSION_ID >= 80021 || defined(PDO_USE_MYSQLND)
    PDO_MYSQL_ATTR_LOCAL_INFILE_DIRECTORY,
#endif
};
 
#endif