libmysql.c 144 KB
Newer Older
1
/* Copyright (C) 2000-2004 MySQL AB
unknown's avatar
unknown committed
2 3 4

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
5 6 7 8
   the Free Software Foundation.

   There are special exceptions to the terms and conditions of the GPL as it
   is applied to this software. View the full text of the exception in file
9
   EXCEPTIONS-CLIENT in the directory of this software distribution.
unknown's avatar
unknown committed
10 11

   This program is distributed in the hope that it will be useful,
unknown's avatar
unknown committed
12
   but WITHOUT ANY WARRANTY; without even the implied warranty of
unknown's avatar
unknown committed
13 14 15 16 17 18
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA */
unknown's avatar
unknown committed
19

unknown's avatar
unknown committed
20
#include <my_global.h>
unknown's avatar
unknown committed
21
#include <my_sys.h>
22
#include <my_time.h>
unknown's avatar
unknown committed
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
#include <mysys_err.h>
#include <m_string.h>
#include <m_ctype.h>
#include "mysql.h"
#include "mysql_version.h"
#include "mysqld_error.h"
#include "errmsg.h"
#include <violite.h>
#include <sys/stat.h>
#include <signal.h>
#include <time.h>
#ifdef	 HAVE_PWD_H
#include <pwd.h>
#endif
#if !defined(MSDOS) && !defined(__WIN__)
#include <sys/socket.h>
#include <netinet/in.h>
#include <arpa/inet.h>
#include <netdb.h>
#ifdef HAVE_SELECT_H
43
#include <select.h>
unknown's avatar
unknown committed
44 45 46 47
#endif
#ifdef HAVE_SYS_SELECT_H
#include <sys/select.h>
#endif
unknown's avatar
unknown committed
48
#endif /* !defined(MSDOS) && !defined(__WIN__) */
49 50
#ifdef HAVE_POLL
#include <sys/poll.h>
unknown's avatar
unknown committed
51 52
#endif
#ifdef HAVE_SYS_UN_H
53
#include <sys/un.h>
unknown's avatar
unknown committed
54 55 56 57 58 59 60 61
#endif
#if defined(THREAD) && !defined(__WIN__)
#include <my_pthread.h>				/* because of signal()	*/
#endif
#ifndef INADDR_NONE
#define INADDR_NONE	-1
#endif

unknown's avatar
unknown committed
62
#include <sql_common.h>
unknown's avatar
SCRUM  
unknown committed
63
#include "client_settings.h"
unknown's avatar
unknown committed
64

65 66
#undef net_buffer_length
#undef max_allowed_packet
67

unknown's avatar
unknown committed
68
ulong 		net_buffer_length=8192;
69
ulong		max_allowed_packet= 1024L*1024L*1024L;
unknown's avatar
unknown committed
70

unknown's avatar
unknown committed
71

unknown's avatar
SCRUM  
unknown committed
72 73 74 75 76
#ifdef EMBEDDED_LIBRARY
#undef net_flush
my_bool	net_flush(NET *net);
#endif

unknown's avatar
unknown committed
77
#if defined(MSDOS) || defined(__WIN__)
unknown's avatar
unknown committed
78
/* socket_errno is defined in my_global.h for all platforms */
unknown's avatar
unknown committed
79 80 81 82
#define perror(A)
#else
#include <errno.h>
#define SOCKET_ERROR -1
unknown's avatar
unknown committed
83
#endif /* __WIN__ */
unknown's avatar
unknown committed
84

85 86 87 88 89
/*
  If allowed through some configuration, then this needs to
  be changed
*/
#define MAX_LONG_DATA_LENGTH 8192
90 91
#define unsigned_field(A) ((A)->flags & UNSIGNED_FLAG)

unknown's avatar
unknown committed
92
static void append_wild(char *to,char *end,const char *wild);
93
sig_handler my_pipe_sig_handler(int sig);
94 95 96 97

static my_bool mysql_client_init= 0;
static my_bool org_my_init_done= 0;

unknown's avatar
unknown committed
98 99

/*
unknown's avatar
merge  
unknown committed
100
  Initialize the MySQL client library
unknown's avatar
unknown committed
101 102

  SYNOPSIS
unknown's avatar
merge  
unknown committed
103
    mysql_server_init()
unknown's avatar
unknown committed
104 105

  NOTES
unknown's avatar
merge  
unknown committed
106 107 108 109 110
    Should be called before doing any other calls to the MySQL
    client library to initialize thread specific variables etc.
    It's called by mysql_init() to ensure that things will work for
    old not threaded applications that doesn't call mysql_server_init()
    directly.
unknown's avatar
unknown committed
111 112 113 114 115 116

  RETURN
    0  ok
    1  could not initialize environment (out of memory or thread keys)
*/

unknown's avatar
unknown committed
117 118 119
int STDCALL mysql_server_init(int argc __attribute__((unused)),
			      char **argv __attribute__((unused)),
			      char **groups __attribute__((unused)))
120
{
121
  int result= 0;
122 123 124 125
  if (!mysql_client_init)
  {
    mysql_client_init=1;
    org_my_init_done=my_init_done;
unknown's avatar
unknown committed
126 127
    if (my_init())				/* Will init threads */
      return 1;
128 129 130 131 132 133 134 135
    init_client_errs();
    if (!mysql_port)
    {
      mysql_port = MYSQL_PORT;
#ifndef MSDOS
      {
	struct servent *serv_ptr;
	char	*env;
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152

        /*
          if builder specifically requested a default port, use that
          (even if it coincides with our factory default).
          only if they didn't do we check /etc/services (and, failing
          on that, fall back to the factory default of 3306).
          either default can be overridden by the environment variable
          MYSQL_TCP_PORT, which in turn can be overridden with command
          line options.
        */

#if MYSQL_PORT_DEFAULT == 0
        if ((serv_ptr = getservbyname("mysql", "tcp")))
          mysql_port = (uint) ntohs((ushort) serv_ptr->s_port);
#endif
        if ((env = getenv("MYSQL_TCP_PORT")))
          mysql_port =(uint) atoi(env);
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167
      }
#endif
    }
    if (!mysql_unix_port)
    {
      char *env;
#ifdef __WIN__
      mysql_unix_port = (char*) MYSQL_NAMEDPIPE;
#else
      mysql_unix_port = (char*) MYSQL_UNIX_ADDR;
#endif
      if ((env = getenv("MYSQL_UNIX_PORT")))
	mysql_unix_port = env;
    }
    mysql_debug(NullS);
168
#if defined(SIGPIPE) && !defined(__WIN__) && !defined(__NETWARE__)
unknown's avatar
unknown committed
169
    (void) signal(SIGPIPE, SIG_IGN);
170
#endif
unknown's avatar
unknown committed
171
#ifdef EMBEDDED_LIBRARY
172
    if (argc > -1)
173
       result= init_embedded_server(argc, argv, groups);
unknown's avatar
unknown committed
174
#endif
175 176 177
  }
#ifdef THREAD
  else
unknown's avatar
unknown committed
178
    result= (int)my_thread_init();         /* Init if new thread */
179
#endif
180
  return result;
unknown's avatar
unknown committed
181
}
unknown's avatar
unknown committed
182

183

184 185 186 187 188 189 190 191 192 193 194 195
/*
  Free all memory and resources used by the client library

  NOTES
    When calling this there should not be any other threads using
    the library.

    To make things simpler when used with windows dll's (which calls this
    function automaticly), it's safe to call this function multiple times.
*/


196
void STDCALL mysql_server_end()
197
{
198 199 200
  if (!mysql_client_init)
    return;

unknown's avatar
unknown committed
201
#ifdef EMBEDDED_LIBRARY
202
  end_embedded_server();
unknown's avatar
unknown committed
203
#endif
204
  finish_client_errs();
unknown's avatar
unknown committed
205 206
  vio_end();

207 208
  /* If library called my_init(), free memory allocated by it */
  if (!org_my_init_done)
209
  {
210
    my_end(MY_DONT_FREE_DBUG);
211
    /* Remove TRACING, if enabled by mysql_debug() */
212 213
    DBUG_POP();
  }
unknown's avatar
unknown committed
214
  else
unknown's avatar
unknown committed
215 216
  {
    free_charsets();
unknown's avatar
unknown committed
217
    mysql_thread_end();
unknown's avatar
unknown committed
218 219
  }

220
  mysql_client_init= org_my_init_done= 0;
221 222 223 224 225 226 227
#ifdef EMBEDDED_SERVER
  if (stderror_file)
  {
    fclose(stderror_file);
    stderror_file= 0;
  }
#endif
228
}
unknown's avatar
unknown committed
229

230
static MYSQL_PARAMETERS mysql_internal_parameters=
231
{&max_allowed_packet, &net_buffer_length, 0};
232

233
MYSQL_PARAMETERS *STDCALL mysql_get_parameters(void)
234 235 236 237
{
  return &mysql_internal_parameters;
}

238
my_bool STDCALL mysql_thread_init()
unknown's avatar
unknown committed
239 240
{
#ifdef THREAD
241
  return my_thread_init();
unknown's avatar
unknown committed
242
#else
243
  return 0;
unknown's avatar
unknown committed
244 245 246
#endif
}

247
void STDCALL mysql_thread_end()
unknown's avatar
unknown committed
248 249
{
#ifdef THREAD
250
  my_thread_end();
unknown's avatar
unknown committed
251 252 253
#endif
}

unknown's avatar
unknown committed
254 255 256 257
/*
  Let the user specify that we don't want SIGPIPE;  This doesn't however work
  with threaded applications as we can have multiple read in progress.
*/
258 259 260 261 262
static MYSQL* spawn_init(MYSQL* parent, const char* host,
			 unsigned int port,
			 const char* user,
			 const char* passwd);

263

unknown's avatar
unknown committed
264 265

/*
266
  Expand wildcard to a sql string
unknown's avatar
unknown committed
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
*/

static void
append_wild(char *to, char *end, const char *wild)
{
  end-=5;					/* Some extra */
  if (wild && wild[0])
  {
    to=strmov(to," like '");
    while (*wild && to < end)
    {
      if (*wild == '\\' || *wild == '\'')
	*to++='\\';
      *to++= *wild++;
    }
    if (*wild)					/* Too small buffer */
      *to++='%';				/* Nicer this way */
    to[0]='\'';
    to[1]=0;
  }
}


/**************************************************************************
291
  Init debugging if MYSQL_DEBUG environment variable is found
unknown's avatar
unknown committed
292 293 294
**************************************************************************/

void STDCALL
unknown's avatar
unknown committed
295
mysql_debug(const char *debug __attribute__((unused)))
unknown's avatar
unknown committed
296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
{
#ifndef DBUG_OFF
  char	*env;
  if (debug)
  {
    DBUG_PUSH(debug);
  }
  else if ((env = getenv("MYSQL_DEBUG")))
  {
    DBUG_PUSH(env);
#if !defined(_WINVER) && !defined(WINVER)
    puts("\n-------------------------------------------------------");
    puts("MYSQL_DEBUG found. libmysql started with the following:");
    puts(env);
    puts("-------------------------------------------------------\n");
#else
    {
      char buff[80];
314 315
      buff[sizeof(buff)-1]= 0;
      strxnmov(buff,sizeof(buff)-1,"libmysql: ", env, NullS);
unknown's avatar
unknown committed
316 317 318 319 320 321 322 323 324
      MessageBox((HWND) 0,"Debugging variable MYSQL_DEBUG used",buff,MB_OK);
    }
#endif
  }
#endif
}


/**************************************************************************
325
  Close the server connection if we get a SIGPIPE
unknown's avatar
unknown committed
326 327 328
   ARGSUSED
**************************************************************************/

unknown's avatar
unknown committed
329
sig_handler
330
my_pipe_sig_handler(int sig __attribute__((unused)))
unknown's avatar
unknown committed
331 332 333
{
  DBUG_PRINT("info",("Hit by signal %d",sig));
#ifdef DONT_REMEMBER_SIGNAL
334
  (void) signal(SIGPIPE, my_pipe_sig_handler);
unknown's avatar
unknown committed
335 336 337
#endif
}

unknown's avatar
SCRUM  
unknown committed
338 339
/* perform query on master */
my_bool STDCALL mysql_master_query(MYSQL *mysql, const char *q,
unknown's avatar
unknown committed
340
				   unsigned long length)
unknown's avatar
SCRUM  
unknown committed
341 342 343 344
{
  DBUG_ENTER("mysql_master_query");
  if (mysql_master_send_query(mysql, q, length))
    DBUG_RETURN(1);
unknown's avatar
unknown committed
345
  DBUG_RETURN((*mysql->methods->read_query_result)(mysql));
unknown's avatar
SCRUM  
unknown committed
346
}
unknown's avatar
unknown committed
347

unknown's avatar
SCRUM  
unknown committed
348 349
my_bool STDCALL mysql_master_send_query(MYSQL *mysql, const char *q,
					unsigned long length)
unknown's avatar
unknown committed
350
{
unknown's avatar
SCRUM  
unknown committed
351 352 353 354
  MYSQL *master = mysql->master;
  DBUG_ENTER("mysql_master_send_query");
  if (!master->net.vio && !mysql_real_connect(master,0,0,0,0,0,0,0))
    DBUG_RETURN(1);
355
  master->reconnect= 1;
unknown's avatar
SCRUM  
unknown committed
356
  mysql->last_used_con = master;
357
  DBUG_RETURN(simple_command(master, COM_QUERY, (const uchar*) q, length, 1));
unknown's avatar
unknown committed
358 359 360
}


unknown's avatar
SCRUM  
unknown committed
361 362 363
/* perform query on slave */
my_bool STDCALL mysql_slave_query(MYSQL *mysql, const char *q,
				  unsigned long length)
unknown's avatar
unknown committed
364
{
unknown's avatar
SCRUM  
unknown committed
365 366 367
  DBUG_ENTER("mysql_slave_query");
  if (mysql_slave_send_query(mysql, q, length))
    DBUG_RETURN(1);
unknown's avatar
unknown committed
368
  DBUG_RETURN((*mysql->methods->read_query_result)(mysql));
unknown's avatar
unknown committed
369 370 371
}


unknown's avatar
SCRUM  
unknown committed
372 373
my_bool STDCALL mysql_slave_send_query(MYSQL *mysql, const char *q,
				   unsigned long length)
unknown's avatar
unknown committed
374
{
unknown's avatar
SCRUM  
unknown committed
375 376
  MYSQL* last_used_slave, *slave_to_use = 0;
  DBUG_ENTER("mysql_slave_send_query");
unknown's avatar
unknown committed
377

unknown's avatar
SCRUM  
unknown committed
378 379 380 381 382 383 384 385 386 387
  if ((last_used_slave = mysql->last_used_slave))
    slave_to_use = last_used_slave->next_slave;
  else
    slave_to_use = mysql->next_slave;
  /*
    Next_slave is always safe to use - we have a circular list of slaves
    if there are no slaves, mysql->next_slave == mysql
  */
  mysql->last_used_con = mysql->last_used_slave = slave_to_use;
  if (!slave_to_use->net.vio && !mysql_real_connect(slave_to_use, 0,0,0,
unknown's avatar
unknown committed
388
						    0,0,0,0))
unknown's avatar
SCRUM  
unknown committed
389
    DBUG_RETURN(1);
390
  slave_to_use->reconnect= 1;
391 392
  DBUG_RETURN(simple_command(slave_to_use, COM_QUERY, (const uchar*) q,
                             length, 1));
unknown's avatar
SCRUM  
unknown committed
393
}
unknown's avatar
unknown committed
394 395


unknown's avatar
SCRUM  
unknown committed
396 397 398
/* enable/disable parsing of all queries to decide
   if they go on master or slave */
void STDCALL mysql_enable_rpl_parse(MYSQL* mysql)
unknown's avatar
unknown committed
399
{
unknown's avatar
SCRUM  
unknown committed
400
  mysql->options.rpl_parse = 1;
unknown's avatar
unknown committed
401 402
}

unknown's avatar
SCRUM  
unknown committed
403
void STDCALL mysql_disable_rpl_parse(MYSQL* mysql)
unknown's avatar
unknown committed
404
{
unknown's avatar
SCRUM  
unknown committed
405
  mysql->options.rpl_parse = 0;
unknown's avatar
unknown committed
406 407
}

unknown's avatar
SCRUM  
unknown committed
408 409
/* get the value of the parse flag */
int STDCALL mysql_rpl_parse_enabled(MYSQL* mysql)
unknown's avatar
unknown committed
410
{
unknown's avatar
SCRUM  
unknown committed
411
  return mysql->options.rpl_parse;
unknown's avatar
unknown committed
412 413
}

unknown's avatar
SCRUM  
unknown committed
414 415
/*  enable/disable reads from master */
void STDCALL mysql_enable_reads_from_master(MYSQL* mysql)
unknown's avatar
unknown committed
416
{
unknown's avatar
SCRUM  
unknown committed
417 418
  mysql->options.no_master_reads = 0;
}
unknown's avatar
unknown committed
419

unknown's avatar
SCRUM  
unknown committed
420
void STDCALL mysql_disable_reads_from_master(MYSQL* mysql)
421 422 423 424
{
  mysql->options.no_master_reads = 1;
}

unknown's avatar
unknown committed
425
/* get the value of the master read flag */
426
my_bool STDCALL mysql_reads_from_master_enabled(MYSQL* mysql)
427 428 429 430
{
  return !(mysql->options.no_master_reads);
}

431 432 433 434 435

/*
  We may get an error while doing replication internals.
  In this case, we add a special explanation to the original
  error
436
*/
437 438

static void expand_error(MYSQL* mysql, int error)
439 440
{
  char tmp[MYSQL_ERRMSG_SIZE];
441 442 443 444 445 446
  char *p;
  uint err_length;
  strmake(tmp, mysql->net.last_error, MYSQL_ERRMSG_SIZE-1);
  p = strmake(mysql->net.last_error, ER(error), MYSQL_ERRMSG_SIZE-1);
  err_length= (uint) (p - mysql->net.last_error);
  strmake(p, tmp, MYSQL_ERRMSG_SIZE-1 - err_length);
447 448 449
  mysql->net.last_errno = error;
}

450 451 452
/*
  This function assumes we have just called SHOW SLAVE STATUS and have
  read the given result and row
453
*/
454

455
static my_bool get_master(MYSQL* mysql, MYSQL_RES* res, MYSQL_ROW row)
456 457
{
  MYSQL* master;
unknown's avatar
unknown committed
458
  DBUG_ENTER("get_master");
unknown's avatar
unknown committed
459
  if (mysql_num_fields(res) < 3)
unknown's avatar
unknown committed
460
    DBUG_RETURN(1); /* safety */
unknown's avatar
unknown committed
461

462
  /* use the same username and password as the original connection */
unknown's avatar
unknown committed
463
  if (!(master = spawn_init(mysql, row[0], atoi(row[2]), 0, 0)))
unknown's avatar
unknown committed
464
    DBUG_RETURN(1);
465
  mysql->master = master;
unknown's avatar
unknown committed
466
  DBUG_RETURN(0);
467 468
}

469 470 471 472

/*
  Assuming we already know that mysql points to a master connection,
  retrieve all the slaves
473
*/
474

475
static my_bool get_slaves_from_master(MYSQL* mysql)
476
{
477 478
  MYSQL_RES* res = 0;
  MYSQL_ROW row;
479
  my_bool error = 1;
480
  int has_auth_info;
unknown's avatar
unknown committed
481
  int port_ind;
unknown's avatar
unknown committed
482
  DBUG_ENTER("get_slaves_from_master");
unknown's avatar
unknown committed
483

484 485 486
  if (!mysql->net.vio && !mysql_real_connect(mysql,0,0,0,0,0,0,0))
  {
    expand_error(mysql, CR_PROBE_MASTER_CONNECT);
unknown's avatar
unknown committed
487
    DBUG_RETURN(1);
488
  }
489
  mysql->reconnect= 1;
490 491

  if (mysql_query(mysql, "SHOW SLAVE HOSTS") ||
492
      !(res = mysql_store_result(mysql)))
493 494
  {
    expand_error(mysql, CR_PROBE_SLAVE_HOSTS);
unknown's avatar
unknown committed
495
    DBUG_RETURN(1);
496 497
  }

498
  switch (mysql_num_fields(res)) {
unknown's avatar
unknown committed
499 500 501 502 503 504 505 506
  case 5:
    has_auth_info = 0;
    port_ind=2;
    break;
  case 7:
    has_auth_info = 1;
    port_ind=4;
    break;
507 508 509 510 511 512 513 514 515 516 517
  default:
    goto err;
  }

  while ((row = mysql_fetch_row(res)))
  {
    MYSQL* slave;
    const char* tmp_user, *tmp_pass;

    if (has_auth_info)
    {
unknown's avatar
unknown committed
518 519
      tmp_user = row[2];
      tmp_pass = row[3];
520 521 522 523 524 525 526
    }
    else
    {
      tmp_user = mysql->user;
      tmp_pass = mysql->passwd;
    }

unknown's avatar
unknown committed
527
    if (!(slave = spawn_init(mysql, row[1], atoi(row[port_ind]),
unknown's avatar
unknown committed
528
			     tmp_user, tmp_pass)))
529
      goto err;
unknown's avatar
unknown committed
530

531 532 533 534 535 536
    /* Now add slave into the circular linked list */
    slave->next_slave = mysql->next_slave;
    mysql->next_slave = slave;
  }
  error = 0;
err:
unknown's avatar
unknown committed
537
  if (res)
unknown's avatar
unknown committed
538
    mysql_free_result(res);
unknown's avatar
unknown committed
539
  DBUG_RETURN(error);
540 541
}

542

543
my_bool STDCALL mysql_rpl_probe(MYSQL* mysql)
544
{
unknown's avatar
unknown committed
545
  MYSQL_RES *res= 0;
546
  MYSQL_ROW row;
547
  my_bool error= 1;
unknown's avatar
unknown committed
548 549
  DBUG_ENTER("mysql_rpl_probe");

550 551 552 553 554
  /*
    First determine the replication role of the server we connected to
    the most reliable way to do this is to run SHOW SLAVE STATUS and see
    if we have a non-empty master host. This is still not fool-proof -
    it is not a sin to have a master that has a dormant slave thread with
unknown's avatar
unknown committed
555
    a non-empty master host. However, it is more reliable to check
556
    for empty master than whether the slave thread is actually running
557
  */
558
  if (mysql_query(mysql, "SHOW SLAVE STATUS") ||
559
      !(res = mysql_store_result(mysql)))
560 561
  {
    expand_error(mysql, CR_PROBE_SLAVE_STATUS);
unknown's avatar
unknown committed
562
    DBUG_RETURN(1);
563
  }
unknown's avatar
unknown committed
564

565 566 567 568 569 570
  row= mysql_fetch_row(res);
  /*
    Check master host for emptiness/NULL
    For MySQL 4.0 it's enough to check for row[0]
  */
  if (row && row[0] && *(row[0]))
571 572
  {
    /* this is a slave, ask it for the master */
573
    if (get_master(mysql, res, row) || get_slaves_from_master(mysql))
574 575 576 577 578
      goto err;
  }
  else
  {
    mysql->master = mysql;
579
    if (get_slaves_from_master(mysql))
580 581 582 583 584
      goto err;
  }

  error = 0;
err:
unknown's avatar
unknown committed
585
  if (res)
586
    mysql_free_result(res);
unknown's avatar
unknown committed
587
  DBUG_RETURN(error);
588 589 590
}


591 592 593 594 595 596 597 598 599 600
/*
  Make a not so fool-proof decision on where the query should go, to
  the master or the slave. Ideally the user should always make this
  decision himself with mysql_master_query() or mysql_slave_query().
  However, to be able to more easily port the old code, we support the
  option of an educated guess - this should work for most applications,
  however, it may make the wrong decision in some particular cases. If
  that happens, the user would have to change the code to call
  mysql_master_query() or mysql_slave_query() explicitly in the place
  where we have made the wrong decision
601
*/
602

603 604
enum mysql_rpl_type
STDCALL mysql_rpl_query_type(const char* q, int len)
605
{
unknown's avatar
unknown committed
606
  const char *q_end= q + len;
607
  for (; q < q_end; ++q)
608 609
  {
    char c;
610
    if (my_isalpha(&my_charset_latin1, (c= *q)))
611
    {
612
      switch (my_tolower(&my_charset_latin1,c)) {
613 614 615 616 617 618 619
      case 'i':  /* insert */
      case 'u':  /* update or unlock tables */
      case 'l':  /* lock tables or load data infile */
      case 'd':  /* drop or delete */
      case 'a':  /* alter */
	return MYSQL_RPL_MASTER;
      case 'c':  /* create or check */
620
	return my_tolower(&my_charset_latin1,q[1]) == 'h' ? MYSQL_RPL_ADMIN :
unknown's avatar
unknown committed
621
	  MYSQL_RPL_MASTER;
622
      case 's': /* select or show */
623
	return my_tolower(&my_charset_latin1,q[1]) == 'h' ? MYSQL_RPL_ADMIN :
unknown's avatar
unknown committed
624
	  MYSQL_RPL_SLAVE;
625 626 627
      case 'f': /* flush */
      case 'r': /* repair */
      case 'g': /* grant */
unknown's avatar
SCRUM  
unknown committed
628 629 630 631 632
	return MYSQL_RPL_ADMIN;
      default:
	return MYSQL_RPL_SLAVE;
      }
    }
unknown's avatar
unknown committed
633
  }
unknown's avatar
SCRUM  
unknown committed
634
  return MYSQL_RPL_MASTER;		/* By default, send to master */
unknown's avatar
unknown committed
635 636 637
}


unknown's avatar
SCRUM  
unknown committed
638 639 640 641
/**************************************************************************
  Connect to sql server
  If host == 0 then use localhost
**************************************************************************/
642

unknown's avatar
SCRUM  
unknown committed
643 644 645 646
#ifdef USE_OLD_FUNCTIONS
MYSQL * STDCALL
mysql_connect(MYSQL *mysql,const char *host,
	      const char *user, const char *passwd)
unknown's avatar
unknown committed
647
{
unknown's avatar
SCRUM  
unknown committed
648 649
  MYSQL *res;
  mysql=mysql_init(mysql);			/* Make it thread safe */
unknown's avatar
unknown committed
650
  {
unknown's avatar
SCRUM  
unknown committed
651 652 653 654
    DBUG_ENTER("mysql_connect");
    if (!(res=mysql_real_connect(mysql,host,user,passwd,NullS,0,NullS,0)))
    {
      if (mysql->free_me)
655
	my_free((uchar*) mysql,MYF(0));
unknown's avatar
SCRUM  
unknown committed
656
    }
657
    mysql->reconnect= 1;
unknown's avatar
SCRUM  
unknown committed
658
    DBUG_RETURN(res);
unknown's avatar
unknown committed
659
  }
unknown's avatar
unknown committed
660
}
unknown's avatar
SCRUM  
unknown committed
661
#endif
unknown's avatar
unknown committed
662

663

unknown's avatar
unknown committed
664
/**************************************************************************
unknown's avatar
unknown committed
665
  Change user and database
unknown's avatar
unknown committed
666
**************************************************************************/
667

668 669 670 671 672
int cli_read_change_user_result(MYSQL *mysql, char *buff, const char *passwd)
{
  NET *net= &mysql->net;
  ulong pkt_length;

673
  pkt_length= cli_safe_read(mysql);
674 675 676 677 678 679 680 681 682 683 684 685
  
  if (pkt_length == packet_error)
    return 1;

  if (pkt_length == 1 && net->read_pos[0] == 254 &&
      mysql->server_capabilities & CLIENT_SECURE_CONNECTION)
  {
    /*
      By sending this very specific reply server asks us to send scrambled
      password in old format. The reply contains scramble_323.
    */
    scramble_323(buff, mysql->scramble, passwd);
686 687
    if (my_net_write(net, (uchar*) buff, SCRAMBLE_LENGTH_323 + 1) ||
        net_flush(net))
688 689 690 691 692 693 694
    {
      net->last_errno= CR_SERVER_LOST;
      strmov(net->sqlstate, unknown_sqlstate);
      strmov(net->last_error,ER(net->last_errno));
      return 1;
    }
    /* Read what server thinks about out new auth message report */
695
    if (cli_safe_read(mysql) == packet_error)
696 697 698 699
      return 1;
  }
  return 0;
}
unknown's avatar
unknown committed
700

701

unknown's avatar
unknown committed
702
my_bool	STDCALL mysql_change_user(MYSQL *mysql, const char *user,
unknown's avatar
unknown committed
703 704
				  const char *passwd, const char *db)
{
unknown's avatar
unknown committed
705
  char buff[512],*end=buff;
706
  int rc;
unknown's avatar
unknown committed
707 708 709 710 711 712
  DBUG_ENTER("mysql_change_user");

  if (!user)
    user="";
  if (!passwd)
    passwd="";
unknown's avatar
unknown committed
713

714
  /* Store user into the buffer */
unknown's avatar
unknown committed
715
  end=strmov(end,user)+1;
unknown's avatar
unknown committed
716

717 718
  /* write scrambled password according to server capabilities */
  if (passwd[0])
unknown's avatar
unknown committed
719
  {
unknown's avatar
unknown committed
720
    if (mysql->server_capabilities & CLIENT_SECURE_CONNECTION)
unknown's avatar
unknown committed
721
    {
unknown's avatar
unknown committed
722 723 724
      *end++= SCRAMBLE_LENGTH;
      scramble(end, mysql->scramble, passwd);
      end+= SCRAMBLE_LENGTH;
unknown's avatar
unknown committed
725
    }
unknown's avatar
unknown committed
726
    else
727 728 729
    {
      scramble_323(end, mysql->scramble, passwd);
      end+= SCRAMBLE_LENGTH_323 + 1;
unknown's avatar
unknown committed
730
    }
unknown's avatar
unknown committed
731 732
  }
  else
733
    *end++= '\0';                               /* empty password */
unknown's avatar
unknown committed
734
  /* Add database if needed */
unknown's avatar
unknown committed
735
  end= strmov(end, db ? db : "") + 1;
unknown's avatar
unknown committed
736 737

  /* Write authentication package */
738
  simple_command(mysql,COM_CHANGE_USER, (uchar*) buff, (ulong) (end-buff), 1);
unknown's avatar
unknown committed
739

740 741 742 743 744 745
  rc= (*mysql->methods->read_change_user_result)(mysql, buff, passwd);

  /*
    The server will close all statements no matter was the attempt
    to change user successful or not.
  */
746
  mysql_detach_stmt_list(&mysql->stmts, "mysql_change_user");
747 748 749 750 751 752 753 754 755 756 757 758 759
  if (rc == 0)
  {
    /* Free old connect information */
    my_free(mysql->user,MYF(MY_ALLOW_ZERO_PTR));
    my_free(mysql->passwd,MYF(MY_ALLOW_ZERO_PTR));
    my_free(mysql->db,MYF(MY_ALLOW_ZERO_PTR));

    /* alloc new connect information */
    mysql->user=  my_strdup(user,MYF(MY_WME));
    mysql->passwd=my_strdup(passwd,MYF(MY_WME));
    mysql->db=    db ? my_strdup(db,MYF(MY_WME)) : 0;
  }
  DBUG_RETURN(rc);
unknown's avatar
unknown committed
760 761
}

unknown's avatar
unknown committed
762 763 764 765 766 767
#if defined(HAVE_GETPWUID) && defined(NO_GETPWUID_DECL)
struct passwd *getpwuid(uid_t);
char* getlogin(void);
#endif

#if defined(__NETWARE__)
768
/* Default to value of USER on NetWare, if unset use "UNKNOWN_USER" */
unknown's avatar
unknown committed
769 770 771 772 773 774
void read_user_name(char *name)
{
  char *str=getenv("USER");
  strmake(name, str ? str : "UNKNOWN_USER", USERNAME_LENGTH);
}

775
#elif !defined(MSDOS) && ! defined(VMS) && !defined(__WIN__)
unknown's avatar
unknown committed
776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814

void read_user_name(char *name)
{
  DBUG_ENTER("read_user_name");
  if (geteuid() == 0)
    (void) strmov(name,"root");		/* allow use of surun */
  else
  {
#ifdef HAVE_GETPWUID
    struct passwd *skr;
    const char *str;
    if ((str=getlogin()) == NULL)
    {
      if ((skr=getpwuid(geteuid())) != NULL)
	str=skr->pw_name;
      else if (!(str=getenv("USER")) && !(str=getenv("LOGNAME")) &&
	       !(str=getenv("LOGIN")))
	str="UNKNOWN_USER";
    }
    (void) strmake(name,str,USERNAME_LENGTH);
#elif HAVE_CUSERID
    (void) cuserid(name);
#else
    strmov(name,"UNKNOWN_USER");
#endif
  }
  DBUG_VOID_RETURN;
}

#else /* If MSDOS || VMS */

void read_user_name(char *name)
{
  char *str=getenv("USER");		/* ODBC will send user variable */
  strmake(name,str ? str : "ODBC", USERNAME_LENGTH);
}

#endif

815
my_bool handle_local_infile(MYSQL *mysql, const char *net_filename)
unknown's avatar
unknown committed
816 817 818 819
{
  my_bool result= 1;
  uint packet_length=MY_ALIGN(mysql->net.max_packet-16,IO_SIZE);
  NET *net= &mysql->net;
820 821
  int readcount;
  void *li_ptr;          /* pass state to local_infile functions */
unknown's avatar
unknown committed
822
  char *buf;		/* buffer to be filled by local_infile_read */
unknown's avatar
unknown committed
823
  struct st_mysql_options *options= &mysql->options;
824 825 826
  DBUG_ENTER("handle_local_infile");

  /* check that we've got valid callback functions */
unknown's avatar
unknown committed
827 828 829 830
  if (!(options->local_infile_init &&
	options->local_infile_read &&
	options->local_infile_end &&
	options->local_infile_error))
unknown's avatar
unknown committed
831
  {
832
    /* if any of the functions is invalid, set the default */
unknown's avatar
unknown committed
833
    mysql_set_local_infile_default(mysql);
unknown's avatar
unknown committed
834 835
  }

836
  /* copy filename into local memory and allocate read buffer */
unknown's avatar
unknown committed
837 838 839 840 841 842
  if (!(buf=my_malloc(packet_length, MYF(0))))
  {
    strmov(net->sqlstate, unknown_sqlstate);
    strmov(net->last_error, ER(net->last_errno=CR_OUT_OF_MEMORY));
    DBUG_RETURN(1);
  }
843 844

  /* initialize local infile (open file, usually) */
845 846
  if ((*options->local_infile_init)(&li_ptr, net_filename,
    options->local_infile_userdata))
unknown's avatar
unknown committed
847
  {
848
    VOID(my_net_write(net,(const uchar*) "",0)); /* Server needs one packet */
unknown's avatar
unknown committed
849 850
    net_flush(net);
    strmov(net->sqlstate, unknown_sqlstate);
unknown's avatar
unknown committed
851 852 853
    net->last_errno= (*options->local_infile_error)(li_ptr,
						    net->last_error,
						    sizeof(net->last_error)-1);
unknown's avatar
unknown committed
854 855 856
    goto err;
  }

857
  /* read blocks of data from local infile callback */
unknown's avatar
unknown committed
858 859 860
  while ((readcount =
	  (*options->local_infile_read)(li_ptr, buf,
					packet_length)) > 0)
unknown's avatar
unknown committed
861
  {
862
    if (my_net_write(net, (uchar*) buf, readcount))
unknown's avatar
unknown committed
863
    {
unknown's avatar
unknown committed
864 865
      DBUG_PRINT("error",
		 ("Lost connection to MySQL server during LOAD DATA of local file"));
unknown's avatar
unknown committed
866 867 868 869 870 871
      strmov(net->sqlstate, unknown_sqlstate);
      net->last_errno=CR_SERVER_LOST;
      strmov(net->last_error,ER(net->last_errno));
      goto err;
    }
  }
872

unknown's avatar
unknown committed
873
  /* Send empty packet to mark end of file */
874
  if (my_net_write(net, (const uchar*) "", 0) || net_flush(net))
unknown's avatar
unknown committed
875 876 877 878 879 880
  {
    strmov(net->sqlstate, unknown_sqlstate);
    net->last_errno=CR_SERVER_LOST;
    sprintf(net->last_error,ER(net->last_errno),errno);
    goto err;
  }
881

unknown's avatar
unknown committed
882 883
  if (readcount < 0)
  {
unknown's avatar
unknown committed
884 885 886
    net->last_errno= (*options->local_infile_error)(li_ptr,
						    net->last_error,
						    sizeof(net->last_error)-1);
unknown's avatar
unknown committed
887 888
    goto err;
  }
889

unknown's avatar
unknown committed
890 891 892
  result=0;					/* Ok */

err:
893
  /* free up memory allocated with _init, usually */
unknown's avatar
unknown committed
894
  (*options->local_infile_end)(li_ptr);
895
  my_free(buf, MYF(0));
unknown's avatar
unknown committed
896
  DBUG_RETURN(result);
897 898 899
}


unknown's avatar
unknown committed
900 901 902 903 904 905
/****************************************************************************
  Default handlers for LOAD LOCAL INFILE
****************************************************************************/

typedef struct st_default_local_infile
{
906 907
  int fd;
  int error_num;
unknown's avatar
unknown committed
908
  const char *filename;
909 910 911 912
  char error_msg[LOCAL_INFILE_ERROR_LEN];
} default_local_infile_data;


unknown's avatar
unknown committed
913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930
/*
  Open file for LOAD LOCAL INFILE

  SYNOPSIS
    default_local_infile_init()
    ptr			Store pointer to internal data here
    filename		File name to open. This may be in unix format !


  NOTES
    Even if this function returns an error, the load data interface
    guarantees that default_local_infile_end() is called.

  RETURN
    0	ok
    1	error
*/

931 932
static int default_local_infile_init(void **ptr, const char *filename,
             void *userdata __attribute__ ((unused)))
933 934
{
  default_local_infile_data *data;
unknown's avatar
unknown committed
935
  char tmp_name[FN_REFLEN];
936 937

  if (!(*ptr= data= ((default_local_infile_data *)
unknown's avatar
unknown committed
938 939
		     my_malloc(sizeof(default_local_infile_data),  MYF(0)))))
    return 1; /* out of memory */
940 941 942

  data->error_msg[0]= 0;
  data->error_num=    0;
unknown's avatar
unknown committed
943
  data->filename= filename;
944

unknown's avatar
unknown committed
945 946
  fn_format(tmp_name, filename, "", "", MY_UNPACK_FILENAME);
  if ((data->fd = my_open(tmp_name, O_RDONLY, MYF(0))) < 0)
947
  {
unknown's avatar
unknown committed
948
    data->error_num= my_errno;
949
    my_snprintf(data->error_msg, sizeof(data->error_msg)-1,
unknown's avatar
unknown committed
950 951
                EE(EE_FILENOTFOUND), tmp_name, data->error_num);
    return 1;
952 953 954 955 956
  }
  return 0; /* ok */
}


unknown's avatar
unknown committed
957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972
/*
  Read data for LOAD LOCAL INFILE

  SYNOPSIS
    default_local_infile_read()
    ptr			Points to handle allocated by _init
    buf			Read data here
    buf_len		Ammount of data to read

  RETURN
    > 0		number of bytes read
    == 0	End of data
    < 0		Error
*/

static int default_local_infile_read(void *ptr, char *buf, uint buf_len)
973
{
unknown's avatar
unknown committed
974 975
  int count;
  default_local_infile_data*data = (default_local_infile_data *) ptr;
976

977
  if ((count= (int) my_read(data->fd, (uchar *) buf, buf_len, MYF(0))) < 0)
unknown's avatar
unknown committed
978 979 980 981 982 983 984
  {
    data->error_num= EE_READ; /* the errmsg for not entire file read */
    my_snprintf(data->error_msg, sizeof(data->error_msg)-1,
		EE(EE_READ),
		data->filename, my_errno);
  }
  return count;
985 986 987
}


unknown's avatar
unknown committed
988 989 990 991 992 993 994 995 996 997 998 999
/*
  Read data for LOAD LOCAL INFILE

  SYNOPSIS
    default_local_infile_end()
    ptr			Points to handle allocated by _init
			May be NULL if _init failed!

  RETURN
*/

static void default_local_infile_end(void *ptr)
1000
{
unknown's avatar
unknown committed
1001 1002
  default_local_infile_data *data= (default_local_infile_data *) ptr;
  if (data)					/* If not error on open */
1003
  {
unknown's avatar
unknown committed
1004 1005 1006
    if (data->fd >= 0)
      my_close(data->fd, MYF(MY_WME));
    my_free(ptr, MYF(MY_WME));
1007 1008 1009 1010
  }
}


unknown's avatar
unknown committed
1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025
/*
  Return error from LOAD LOCAL INFILE

  SYNOPSIS
    default_local_infile_end()
    ptr			Points to handle allocated by _init
			May be NULL if _init failed!
    error_msg		Store error text here
    error_msg_len	Max lenght of error_msg

  RETURN
    error message number
*/

static int
1026 1027
default_local_infile_error(void *ptr, char *error_msg, uint error_msg_len)
{
unknown's avatar
unknown committed
1028 1029 1030
  default_local_infile_data *data = (default_local_infile_data *) ptr;
  if (data)					/* If not error on open */
  {
1031 1032 1033
    strmake(error_msg, data->error_msg, error_msg_len);
    return data->error_num;
  }
unknown's avatar
unknown committed
1034 1035 1036
  /* This can only happen if we got error on malloc of handle */
  strmov(error_msg, ER(CR_OUT_OF_MEMORY));
  return CR_OUT_OF_MEMORY;
1037 1038 1039
}


unknown's avatar
unknown committed
1040
void
1041
mysql_set_local_infile_handler(MYSQL *mysql,
1042 1043
                               int (*local_infile_init)(void **, const char *,
                               void *),
1044
                               int (*local_infile_read)(void *, char *, uint),
unknown's avatar
unknown committed
1045
                               void (*local_infile_end)(void *),
1046 1047
                               int (*local_infile_error)(void *, char *, uint),
                               void *userdata)
1048
{
unknown's avatar
unknown committed
1049 1050 1051 1052
  mysql->options.local_infile_init=  local_infile_init;
  mysql->options.local_infile_read=  local_infile_read;
  mysql->options.local_infile_end=   local_infile_end;
  mysql->options.local_infile_error= local_infile_error;
1053
  mysql->options.local_infile_userdata = userdata;
1054 1055 1056
}


unknown's avatar
unknown committed
1057
void mysql_set_local_infile_default(MYSQL *mysql)
1058 1059 1060 1061 1062
{
  mysql->options.local_infile_init=  default_local_infile_init;
  mysql->options.local_infile_read=  default_local_infile_read;
  mysql->options.local_infile_end=   default_local_infile_end;
  mysql->options.local_infile_error= default_local_infile_error;
unknown's avatar
unknown committed
1063 1064 1065
}


unknown's avatar
unknown committed
1066
/**************************************************************************
1067 1068
  Do a query. If query returned rows, free old rows.
  Read data by mysql_store_result or by repeat call of mysql_fetch_row
unknown's avatar
unknown committed
1069 1070 1071 1072 1073 1074 1075 1076
**************************************************************************/

int STDCALL
mysql_query(MYSQL *mysql, const char *query)
{
  return mysql_real_query(mysql,query, (uint) strlen(query));
}

unknown's avatar
unknown committed
1077

1078
static MYSQL* spawn_init(MYSQL* parent, const char* host,
unknown's avatar
unknown committed
1079 1080
			 unsigned int port, const char* user,
			 const char* passwd)
1081 1082
{
  MYSQL* child;
1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098
  DBUG_ENTER("spawn_init");
  if (!(child= mysql_init(0)))
    DBUG_RETURN(0);

  child->options.user= my_strdup((user) ? user :
				 (parent->user ? parent->user :
				  parent->options.user), MYF(0));
  child->options.password= my_strdup((passwd) ? passwd :
				     (parent->passwd ?
				      parent->passwd :
				      parent->options.password), MYF(0));
  child->options.port= port;
  child->options.host= my_strdup((host) ? host :
				 (parent->host ?
				  parent->host :
				  parent->options.host), MYF(0));
unknown's avatar
unknown committed
1099
  if (parent->db)
1100
    child->options.db= my_strdup(parent->db, MYF(0));
unknown's avatar
unknown committed
1101
  else if (parent->options.db)
1102
    child->options.db= my_strdup(parent->options.db, MYF(0));
1103

1104 1105 1106 1107 1108 1109
  /*
    rpl_pivot is set to 1 in mysql_init();  Reset it as we are not doing
    replication here
  */
  child->rpl_pivot= 0;
  DBUG_RETURN(child);
1110 1111 1112 1113 1114
}


int
STDCALL mysql_set_master(MYSQL* mysql, const char* host,
unknown's avatar
unknown committed
1115 1116
			 unsigned int port, const char* user,
			 const char* passwd)
1117 1118 1119
{
  if (mysql->master != mysql && !mysql->master->rpl_pivot)
    mysql_close(mysql->master);
unknown's avatar
unknown committed
1120
  if (!(mysql->master = spawn_init(mysql, host, port, user, passwd)))
1121 1122 1123 1124
    return 1;
  return 0;
}

1125

1126 1127
int
STDCALL mysql_add_slave(MYSQL* mysql, const char* host,
unknown's avatar
unknown committed
1128 1129 1130
			unsigned int port,
			const char* user,
			const char* passwd)
1131 1132
{
  MYSQL* slave;
unknown's avatar
unknown committed
1133
  if (!(slave = spawn_init(mysql, host, port, user, passwd)))
1134 1135 1136 1137 1138 1139
    return 1;
  slave->next_slave = mysql->next_slave;
  mysql->next_slave = slave;
  return 0;
}

unknown's avatar
unknown committed
1140
/**************************************************************************
1141
  Return next field of the query results
unknown's avatar
unknown committed
1142 1143 1144 1145 1146 1147 1148 1149 1150 1151
**************************************************************************/

MYSQL_FIELD * STDCALL
mysql_fetch_field(MYSQL_RES *result)
{
  if (result->current_field >= result->field_count)
    return(NULL);
  return &result->fields[result->current_field++];
}

1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168

/**************************************************************************
  Move to a specific row and column
**************************************************************************/

void STDCALL
mysql_data_seek(MYSQL_RES *result, my_ulonglong row)
{
  MYSQL_ROWS	*tmp=0;
  DBUG_PRINT("info",("mysql_data_seek(%ld)",(long) row));
  if (result->data)
    for (tmp=result->data->data; row-- && tmp ; tmp = tmp->next) ;
  result->current_row=0;
  result->data_cursor = tmp;
}


unknown's avatar
unknown committed
1169
/*************************************************************************
1170 1171 1172
  put the row or field cursor one a position one got from mysql_row_tell()
  This doesn't restore any data. The next mysql_fetch_row or
  mysql_fetch_field will return the next row or field after the last used
unknown's avatar
unknown committed
1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192
*************************************************************************/

MYSQL_ROW_OFFSET STDCALL
mysql_row_seek(MYSQL_RES *result, MYSQL_ROW_OFFSET row)
{
  MYSQL_ROW_OFFSET return_value=result->data_cursor;
  result->current_row= 0;
  result->data_cursor= row;
  return return_value;
}


MYSQL_FIELD_OFFSET STDCALL
mysql_field_seek(MYSQL_RES *result, MYSQL_FIELD_OFFSET field_offset)
{
  MYSQL_FIELD_OFFSET return_value=result->current_field;
  result->current_field=field_offset;
  return return_value;
}

1193

unknown's avatar
unknown committed
1194
/*****************************************************************************
1195
  List all databases
unknown's avatar
unknown committed
1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211
*****************************************************************************/

MYSQL_RES * STDCALL
mysql_list_dbs(MYSQL *mysql, const char *wild)
{
  char buff[255];
  DBUG_ENTER("mysql_list_dbs");

  append_wild(strmov(buff,"show databases"),buff+sizeof(buff),wild);
  if (mysql_query(mysql,buff))
    DBUG_RETURN(0);
  DBUG_RETURN (mysql_store_result(mysql));
}


/*****************************************************************************
1212 1213
  List all tables in a database
  If wild is given then only the tables matching wild is returned
unknown's avatar
unknown committed
1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227
*****************************************************************************/

MYSQL_RES * STDCALL
mysql_list_tables(MYSQL *mysql, const char *wild)
{
  char buff[255];
  DBUG_ENTER("mysql_list_tables");

  append_wild(strmov(buff,"show tables"),buff+sizeof(buff),wild);
  if (mysql_query(mysql,buff))
    DBUG_RETURN(0);
  DBUG_RETURN (mysql_store_result(mysql));
}

1228

unknown's avatar
unknown committed
1229
MYSQL_FIELD *cli_list_fields(MYSQL *mysql)
unknown's avatar
SCRUM  
unknown committed
1230 1231 1232 1233 1234 1235
{
  MYSQL_DATA *query;
  if (!(query= cli_read_rows(mysql,(MYSQL_FIELD*) 0, 
			     protocol_41(mysql) ? 8 : 6)))
    return NULL;

unknown's avatar
unknown committed
1236
  mysql->field_count= (uint) query->rows;
unknown's avatar
SCRUM  
unknown committed
1237
  return unpack_fields(query,&mysql->field_alloc,
unknown's avatar
unknown committed
1238
		       mysql->field_count, 1, mysql->server_capabilities);
unknown's avatar
SCRUM  
unknown committed
1239 1240 1241
}


unknown's avatar
unknown committed
1242
/**************************************************************************
1243 1244 1245 1246
  List all fields in a table
  If wild is given then only the fields matching wild is returned
  Instead of this use query:
  show fields in 'table' like "wild"
unknown's avatar
unknown committed
1247 1248 1249
**************************************************************************/

MYSQL_RES * STDCALL
unknown's avatar
SCRUM  
unknown committed
1250
mysql_list_fields(MYSQL *mysql, const char *table, const char *wild)
unknown's avatar
unknown committed
1251
{
unknown's avatar
SCRUM  
unknown committed
1252 1253
  MYSQL_RES   *result;
  MYSQL_FIELD *fields;
unknown's avatar
unknown committed
1254 1255 1256 1257 1258
  char	     buff[257],*end;
  DBUG_ENTER("mysql_list_fields");
  DBUG_PRINT("enter",("table: '%s'  wild: '%s'",table,wild ? wild : ""));

  end=strmake(strmake(buff, table,128)+1,wild ? wild : "",128);
unknown's avatar
SCRUM  
unknown committed
1259
  free_old_query(mysql);
1260 1261
  if (simple_command(mysql, COM_FIELD_LIST, (uchar*) buff,
                     (ulong) (end-buff), 1) ||
unknown's avatar
SCRUM  
unknown committed
1262
      !(fields= (*mysql->methods->list_fields)(mysql)))
unknown's avatar
unknown committed
1263 1264 1265 1266 1267
    DBUG_RETURN(NULL);

  if (!(result = (MYSQL_RES *) my_malloc(sizeof(MYSQL_RES),
					 MYF(MY_WME | MY_ZEROFILL))))
    DBUG_RETURN(NULL);
unknown's avatar
SCRUM  
unknown committed
1268

1269
  result->methods= mysql->methods;
unknown's avatar
unknown committed
1270 1271
  result->field_alloc=mysql->field_alloc;
  mysql->fields=0;
unknown's avatar
SCRUM  
unknown committed
1272 1273
  result->field_count = mysql->field_count;
  result->fields= fields;
unknown's avatar
unknown committed
1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293
  result->eof=1;
  DBUG_RETURN(result);
}

/* List all running processes (threads) in server */

MYSQL_RES * STDCALL
mysql_list_processes(MYSQL *mysql)
{
  MYSQL_DATA *fields;
  uint field_count;
  uchar *pos;
  DBUG_ENTER("mysql_list_processes");

  LINT_INIT(fields);
  if (simple_command(mysql,COM_PROCESS_INFO,0,0,0))
    DBUG_RETURN(0);
  free_old_query(mysql);
  pos=(uchar*) mysql->net.read_pos;
  field_count=(uint) net_field_length(&pos);
unknown's avatar
SCRUM  
unknown committed
1294 1295
  if (!(fields = (*mysql->methods->read_rows)(mysql,(MYSQL_FIELD*) 0,
					      protocol_41(mysql) ? 7 : 5)))
unknown's avatar
unknown committed
1296 1297
    DBUG_RETURN(NULL);
  if (!(mysql->fields=unpack_fields(fields,&mysql->field_alloc,field_count,0,
1298
				    mysql->server_capabilities)))
unknown's avatar
unknown committed
1299 1300 1301 1302 1303 1304
    DBUG_RETURN(0);
  mysql->status=MYSQL_STATUS_GET_RESULT;
  mysql->field_count=field_count;
  DBUG_RETURN(mysql_store_result(mysql));
}

1305

1306
#ifdef USE_OLD_FUNCTIONS
unknown's avatar
unknown committed
1307 1308 1309 1310 1311
int  STDCALL
mysql_create_db(MYSQL *mysql, const char *db)
{
  DBUG_ENTER("mysql_createdb");
  DBUG_PRINT("enter",("db: %s",db));
unknown's avatar
unknown committed
1312
  DBUG_RETURN(simple_command(mysql,COM_CREATE_DB,db, (ulong) strlen(db),0));
unknown's avatar
unknown committed
1313 1314 1315 1316 1317 1318 1319 1320
}


int  STDCALL
mysql_drop_db(MYSQL *mysql, const char *db)
{
  DBUG_ENTER("mysql_drop_db");
  DBUG_PRINT("enter",("db: %s",db));
unknown's avatar
unknown committed
1321
  DBUG_RETURN(simple_command(mysql,COM_DROP_DB,db,(ulong) strlen(db),0));
unknown's avatar
unknown committed
1322
}
1323
#endif
unknown's avatar
unknown committed
1324 1325 1326


int STDCALL
1327
mysql_shutdown(MYSQL *mysql, enum mysql_enum_shutdown_level shutdown_level)
unknown's avatar
unknown committed
1328
{
1329
  uchar level[1];
unknown's avatar
unknown committed
1330
  DBUG_ENTER("mysql_shutdown");
unknown's avatar
unknown committed
1331
  level[0]= (uchar) shutdown_level;
1332
  DBUG_RETURN(simple_command(mysql, COM_SHUTDOWN, level, 1, 0));
unknown's avatar
unknown committed
1333 1334 1335 1336 1337 1338 1339 1340 1341
}


int STDCALL
mysql_refresh(MYSQL *mysql,uint options)
{
  uchar bits[1];
  DBUG_ENTER("mysql_refresh");
  bits[0]= (uchar) options;
1342
  DBUG_RETURN(simple_command(mysql, COM_REFRESH, bits, 1, 0));
unknown's avatar
unknown committed
1343 1344
}

1345

unknown's avatar
unknown committed
1346 1347 1348
int STDCALL
mysql_kill(MYSQL *mysql,ulong pid)
{
1349
  uchar buff[4];
unknown's avatar
unknown committed
1350 1351
  DBUG_ENTER("mysql_kill");
  int4store(buff,pid);
1352 1353 1354 1355 1356 1357 1358
  DBUG_RETURN(simple_command(mysql,COM_PROCESS_KILL,buff,sizeof(buff),0));
}


int STDCALL
mysql_set_server_option(MYSQL *mysql, enum enum_mysql_set_option option)
{
1359
  uchar buff[2];
1360 1361 1362
  DBUG_ENTER("mysql_set_server_option");
  int2store(buff, (uint) option);
  DBUG_RETURN(simple_command(mysql, COM_SET_OPTION, buff, sizeof(buff), 0));
unknown's avatar
unknown committed
1363 1364 1365 1366 1367 1368 1369 1370 1371 1372
}


int STDCALL
mysql_dump_debug_info(MYSQL *mysql)
{
  DBUG_ENTER("mysql_dump_debug_info");
  DBUG_RETURN(simple_command(mysql,COM_DEBUG,0,0,0));
}

1373

unknown's avatar
unknown committed
1374
const char *cli_read_statistics(MYSQL *mysql)
unknown's avatar
unknown committed
1375 1376 1377 1378
{
  mysql->net.read_pos[mysql->packet_length]=0;	/* End of stat string */
  if (!mysql->net.read_pos[0])
  {
1379
    strmov(mysql->net.sqlstate, unknown_sqlstate);
unknown's avatar
unknown committed
1380 1381 1382 1383
    mysql->net.last_errno=CR_WRONG_HOST_INFO;
    strmov(mysql->net.last_error, ER(mysql->net.last_errno));
    return mysql->net.last_error;
  }
unknown's avatar
unknown committed
1384 1385 1386
  return (char*) mysql->net.read_pos;
}

1387

unknown's avatar
unknown committed
1388 1389 1390 1391 1392
const char * STDCALL
mysql_stat(MYSQL *mysql)
{
  DBUG_ENTER("mysql_stat");
  if (simple_command(mysql,COM_STATISTICS,0,0,0))
1393
    DBUG_RETURN(mysql->net.last_error);
unknown's avatar
unknown committed
1394
  DBUG_RETURN((*mysql->methods->read_statistics)(mysql));
unknown's avatar
unknown committed
1395 1396 1397 1398 1399 1400
}


int STDCALL
mysql_ping(MYSQL *mysql)
{
1401
  int res;
unknown's avatar
unknown committed
1402
  DBUG_ENTER("mysql_ping");
1403 1404 1405 1406
  res= simple_command(mysql,COM_PING,0,0,0);
  if (res == CR_SERVER_LOST && mysql->reconnect)
    res= simple_command(mysql,COM_PING,0,0,0);
  DBUG_RETURN(res);
unknown's avatar
unknown committed
1407 1408 1409
}


unknown's avatar
unknown committed
1410
const char * STDCALL
unknown's avatar
unknown committed
1411 1412 1413 1414 1415 1416
mysql_get_server_info(MYSQL *mysql)
{
  return((char*) mysql->server_version);
}


unknown's avatar
unknown committed
1417
const char * STDCALL
unknown's avatar
unknown committed
1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429
mysql_get_host_info(MYSQL *mysql)
{
  return(mysql->host_info);
}


uint STDCALL
mysql_get_proto_info(MYSQL *mysql)
{
  return (mysql->protocol_version);
}

unknown's avatar
unknown committed
1430
const char * STDCALL
unknown's avatar
unknown committed
1431 1432 1433 1434 1435
mysql_get_client_info(void)
{
  return (char*) MYSQL_SERVER_VERSION;
}

unknown's avatar
unknown committed
1436 1437 1438 1439 1440
ulong STDCALL mysql_get_client_version(void)
{
  return MYSQL_VERSION_ID;
}

unknown's avatar
unknown committed
1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455
my_bool STDCALL mysql_eof(MYSQL_RES *res)
{
  return res->eof;
}

MYSQL_FIELD * STDCALL mysql_fetch_field_direct(MYSQL_RES *res,uint fieldnr)
{
  return &(res)->fields[fieldnr];
}

MYSQL_FIELD * STDCALL mysql_fetch_fields(MYSQL_RES *res)
{
  return (res)->fields;
}

unknown's avatar
unknown committed
1456
MYSQL_ROW_OFFSET STDCALL mysql_row_tell(MYSQL_RES *res)
unknown's avatar
unknown committed
1457 1458 1459 1460
{
  return res->data_cursor;
}

unknown's avatar
unknown committed
1461
MYSQL_FIELD_OFFSET STDCALL mysql_field_tell(MYSQL_RES *res)
unknown's avatar
unknown committed
1462 1463 1464 1465 1466 1467 1468 1469
{
  return (res)->current_field;
}

/* MYSQL */

unsigned int STDCALL mysql_field_count(MYSQL *mysql)
{
1470
  return mysql->last_used_con->field_count;
unknown's avatar
unknown committed
1471 1472 1473 1474
}

my_ulonglong STDCALL mysql_affected_rows(MYSQL *mysql)
{
1475
  return mysql->last_used_con->affected_rows;
unknown's avatar
unknown committed
1476 1477 1478 1479
}

my_ulonglong STDCALL mysql_insert_id(MYSQL *mysql)
{
1480
  return mysql->last_used_con->insert_id;
unknown's avatar
unknown committed
1481 1482
}

1483 1484 1485 1486 1487
const char *STDCALL mysql_sqlstate(MYSQL *mysql)
{
  return mysql->net.sqlstate;
}

1488 1489 1490 1491 1492
uint STDCALL mysql_warning_count(MYSQL *mysql)
{
  return mysql->warning_count;
}

unknown's avatar
unknown committed
1493
const char *STDCALL mysql_info(MYSQL *mysql)
unknown's avatar
unknown committed
1494
{
1495
  return mysql->info;
unknown's avatar
unknown committed
1496 1497 1498 1499 1500 1501 1502 1503 1504
}

ulong STDCALL mysql_thread_id(MYSQL *mysql)
{
  return (mysql)->thread_id;
}

const char * STDCALL mysql_character_set_name(MYSQL *mysql)
{
unknown's avatar
unknown committed
1505
  return mysql->charset->csname;
unknown's avatar
unknown committed
1506 1507
}

1508
void STDCALL mysql_get_character_set_info(MYSQL *mysql, MY_CHARSET_INFO *csinfo)
unknown's avatar
unknown committed
1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522
{
  csinfo->number   = mysql->charset->number;
  csinfo->state    = mysql->charset->state;
  csinfo->csname   = mysql->charset->csname;
  csinfo->name     = mysql->charset->name;
  csinfo->comment  = mysql->charset->comment;
  csinfo->mbminlen = mysql->charset->mbminlen;
  csinfo->mbmaxlen = mysql->charset->mbmaxlen;

  if (mysql->options.charset_dir)
    csinfo->dir = mysql->options.charset_dir;
  else
    csinfo->dir = charsets_dir;
}
unknown's avatar
unknown committed
1523

unknown's avatar
unknown committed
1524 1525 1526 1527 1528 1529 1530 1531 1532
uint STDCALL mysql_thread_safe(void)
{
#ifdef THREAD
  return 1;
#else
  return 0;
#endif
}

1533 1534 1535 1536 1537 1538 1539 1540 1541 1542

my_bool STDCALL mysql_embedded(void)
{
#ifdef EMBEDDED_LIBRARY
  return 1;
#else
  return 0;
#endif
}

unknown's avatar
unknown committed
1543
/****************************************************************************
1544
  Some support functions
unknown's avatar
unknown committed
1545 1546
****************************************************************************/

unknown's avatar
unknown committed
1547 1548 1549 1550 1551 1552 1553
/*
  Functions called my my_net_init() to set some application specific variables
*/

void my_net_local_init(NET *net)
{
  net->max_packet=   (uint) net_buffer_length;
1554 1555
  my_net_set_read_timeout(net, CLIENT_NET_READ_TIMEOUT);
  my_net_set_write_timeout(net, CLIENT_NET_WRITE_TIMEOUT);
1556
  net->retry_count=  1;
unknown's avatar
unknown committed
1557 1558 1559
  net->max_packet_size= max(net_buffer_length, max_allowed_packet);
}

unknown's avatar
unknown committed
1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579
/*
  This function is used to create HEX string that you
  can use in a SQL statement in of the either ways:
    INSERT INTO blob_column VALUES (0xAABBCC);  (any MySQL version)
    INSERT INTO blob_column VALUES (X'AABBCC'); (4.1 and higher)
  
  The string in "from" is encoded to a HEX string.
  The result is placed in "to" and a terminating null byte is appended.
  
  The string pointed to by "from" must be "length" bytes long.
  You must allocate the "to" buffer to be at least length*2+1 bytes long.
  Each character needs two bytes, and you need room for the terminating
  null byte. When mysql_hex_string() returns, the contents of "to" will
  be a null-terminated string. The return value is the length of the
  encoded string, not including the terminating null character.

  The return value does not contain any leading 0x or a leading X' and
  trailing '. The caller must supply whichever of those is desired.
*/

unknown's avatar
unknown committed
1580 1581
ulong STDCALL
mysql_hex_string(char *to, const char *from, ulong length)
unknown's avatar
unknown committed
1582 1583 1584 1585 1586 1587
{
  char *to0= to;
  const char *end;
            
  for (end= from + length; from < end; from++)
  {
unknown's avatar
unknown committed
1588 1589
    *to++= _dig_vec_upper[((unsigned char) *from) >> 4];
    *to++= _dig_vec_upper[((unsigned char) *from) & 0x0F];
unknown's avatar
unknown committed
1590 1591 1592 1593 1594
  }
  *to= '\0';
  return (ulong) (to-to0);
}

unknown's avatar
unknown committed
1595
/*
1596 1597 1598
  Add escape characters to a string (blob?) to make it suitable for a insert
  to should at least have place for length*2+1 chars
  Returns the length of the to string
unknown's avatar
unknown committed
1599 1600 1601 1602 1603
*/

ulong STDCALL
mysql_escape_string(char *to,const char *from,ulong length)
{
unknown's avatar
unknown committed
1604
  return escape_string_for_mysql(default_charset_info, to, 0, from, length);
unknown's avatar
unknown committed
1605 1606 1607 1608 1609 1610
}

ulong STDCALL
mysql_real_escape_string(MYSQL *mysql, char *to,const char *from,
			 ulong length)
{
1611 1612
  if (mysql->server_status & SERVER_STATUS_NO_BACKSLASH_ESCAPES)
    return escape_quotes_for_mysql(mysql->charset, to, 0, from, length);
unknown's avatar
unknown committed
1613
  return escape_string_for_mysql(mysql->charset, to, 0, from, length);
unknown's avatar
unknown committed
1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717
}


char * STDCALL
mysql_odbc_escape_string(MYSQL *mysql,
			 char *to, ulong to_length,
			 const char *from, ulong from_length,
			 void *param,
			 char * (*extend_buffer)
			 (void *, char *, ulong *))
{
  char *to_end=to+to_length-5;
  const char *end;
#ifdef USE_MB
  my_bool use_mb_flag=use_mb(mysql->charset);
#endif

  for (end=from+from_length; from != end ; from++)
  {
    if (to >= to_end)
    {
      to_length = (ulong) (end-from)+512;	/* We want this much more */
      if (!(to=(*extend_buffer)(param, to, &to_length)))
	return to;
      to_end=to+to_length-5;
    }
#ifdef USE_MB
    {
      int l;
      if (use_mb_flag && (l = my_ismbchar(mysql->charset, from, end)))
      {
	while (l--)
	  *to++ = *from++;
	from--;
	continue;
      }
    }
#endif
    switch (*from) {
    case 0:				/* Must be escaped for 'mysql' */
      *to++= '\\';
      *to++= '0';
      break;
    case '\n':				/* Must be escaped for logs */
      *to++= '\\';
      *to++= 'n';
      break;
    case '\r':
      *to++= '\\';
      *to++= 'r';
      break;
    case '\\':
      *to++= '\\';
      *to++= '\\';
      break;
    case '\'':
      *to++= '\\';
      *to++= '\'';
      break;
    case '"':				/* Better safe than sorry */
      *to++= '\\';
      *to++= '"';
      break;
    case '\032':			/* This gives problems on Win32 */
      *to++= '\\';
      *to++= 'Z';
      break;
    default:
      *to++= *from;
    }
  }
  return to;
}

void STDCALL
myodbc_remove_escape(MYSQL *mysql,char *name)
{
  char *to;
#ifdef USE_MB
  my_bool use_mb_flag=use_mb(mysql->charset);
  char *end;
  LINT_INIT(end);
  if (use_mb_flag)
    for (end=name; *end ; end++) ;
#endif

  for (to=name ; *name ; name++)
  {
#ifdef USE_MB
    int l;
    if (use_mb_flag && (l = my_ismbchar( mysql->charset, name , end ) ) )
    {
      while (l--)
	*to++ = *name++;
      name--;
      continue;
    }
#endif
    if (*name == '\\' && name[1])
      name++;
    *to++= *name;
  }
  *to=0;
}
1718 1719

/********************************************************************
1720
 Implementation of new client API for 4.1 version.
1721

1722
 mysql_stmt_* are real prototypes used by applications.
1723

1724 1725 1726 1727 1728
 To make API work in embedded library all functions performing
 real I/O are prefixed with 'cli_' (abbreviated from 'Call Level
 Interface'). This functions are invoked via pointers set in
 MYSQL::methods structure. Embedded counterparts, prefixed with
 'emb_' reside in libmysqld/lib_sql.cc.
1729 1730
*********************************************************************/

1731
/******************* Declarations ***********************************/
1732

1733
/* Default number of rows fetched per one COM_STMT_FETCH command. */
1734

unknown's avatar
unknown committed
1735
#define DEFAULT_PREFETCH_ROWS (ulong) 1
1736

1737
/*
1738 1739 1740 1741 1742
  These functions are called by function pointer MYSQL_STMT::read_row_func.
  Each function corresponds to one of the read methods:
  - mysql_stmt_fetch without prior mysql_stmt_store_result,
  - mysql_stmt_fetch when result is stored,
  - mysql_stmt_fetch when there are no rows (always returns MYSQL_NO_DATA)
1743 1744
*/

1745 1746
static int stmt_read_row_unbuffered(MYSQL_STMT *stmt, unsigned char **row);
static int stmt_read_row_buffered(MYSQL_STMT *stmt, unsigned char **row);
1747
static int stmt_read_row_from_cursor(MYSQL_STMT *stmt, unsigned char **row);
1748
static int stmt_read_row_no_data(MYSQL_STMT *stmt, unsigned char **row);
unknown's avatar
unknown committed
1749
static int stmt_read_row_no_result_set(MYSQL_STMT *stmt, unsigned char **row);
1750

1751 1752 1753 1754 1755
/*
  This function is used in mysql_stmt_store_result if
  STMT_ATTR_UPDATE_MAX_LENGTH attribute is set.
*/
static void stmt_update_metadata(MYSQL_STMT *stmt, MYSQL_ROWS *data);
1756
static my_bool setup_one_fetch_function(MYSQL_BIND *, MYSQL_FIELD *field);
1757

1758 1759 1760 1761
/* Auxilary function used to reset statement handle. */

#define RESET_SERVER_SIDE 1
#define RESET_LONG_DATA 2
1762
#define RESET_STORE_RESULT 4
1763 1764 1765

static my_bool reset_stmt_handle(MYSQL_STMT *stmt, uint flags);

1766 1767 1768 1769 1770 1771
/*
  Maximum sizes of MYSQL_TYPE_DATE, MYSQL_TYPE_TIME, MYSQL_TYPE_DATETIME
  values stored in network buffer.
*/

/* 1 (length) + 2 (year) + 1 (month) + 1 (day) */
1772
#define MAX_DATE_REP_LENGTH 5
1773 1774 1775 1776 1777

/*
  1 (length) + 1 (is negative) + 4 (day count) + 1 (hour)
  + 1 (minute) + 1 (seconds) + 4 (microseconds)
*/
1778
#define MAX_TIME_REP_LENGTH 13
1779 1780 1781 1782 1783

/*
  1 (length) + 2 (year) + 1 (month) + 1 (day) +
  1 (hour) + 1 (minute) + 1 (second) + 4 (microseconds)
*/
1784
#define MAX_DATETIME_REP_LENGTH 12
1785

1786
#define MAX_DOUBLE_STRING_REP_LENGTH 331
1787

1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801
/* A macro to check truncation errors */

#define IS_TRUNCATED(value, is_unsigned, min, max, umax) \
        ((is_unsigned) ? (((value) > (umax) || (value) < 0) ? 1 : 0) : \
                         (((value) > (max)  || (value) < (min)) ? 1 : 0))

#define BIND_RESULT_DONE 1
/*
  We report truncations only if at least one of MYSQL_BIND::error
  pointers is set. In this case stmt->bind_result_done |-ed with
  this flag.
*/
#define REPORT_DATA_TRUNCATION 2

1802
/**************** Misc utility functions ****************************/
1803 1804

/*
1805
  Reallocate the NET package to have at least length bytes available.
1806

1807
  SYNPOSIS
1808 1809 1810 1811
    my_realloc_str()
    net                 The NET structure to modify.
    length              Ensure that net->buff has space for at least
                        this number of bytes.
1812

1813
  RETURN VALUES
1814 1815 1816
    0   Success.
    1   Error, i.e. out of memory or requested packet size is bigger
        than max_allowed_packet. The error code is stored in net->last_errno.
1817 1818
*/

1819
static my_bool my_realloc_str(NET *net, ulong length)
1820
{
1821 1822 1823 1824
  ulong buf_length= (ulong) (net->write_pos - net->buff);
  my_bool res=0;
  DBUG_ENTER("my_realloc_str");
  if (buf_length + length > net->max_packet)
1825
  {
1826 1827
    res= net_realloc(net, buf_length + length);
    net->write_pos= net->buff+ buf_length;
1828
  }
1829
  DBUG_RETURN(res);
1830 1831 1832
}


1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844
/* Clear possible error statee of struct NET */

static void net_clear_error(NET *net)
{
  if (net->last_errno)
  {
    net->last_errno= 0;
    net->last_error[0]= '\0';
    strmov(net->sqlstate, not_error_sqlstate);
  }
}

1845 1846 1847 1848 1849 1850 1851 1852 1853 1854
static void stmt_clear_error(MYSQL_STMT *stmt)
{
  if (stmt->last_errno)
  {
    stmt->last_errno= 0;
    stmt->last_error[0]= '\0';
    strmov(stmt->sqlstate, not_error_sqlstate);
  }
}

1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892
/*
  Set statement error code, sqlstate, and error message
  from given errcode and sqlstate.
*/

static void set_stmt_error(MYSQL_STMT * stmt, int errcode,
                           const char *sqlstate)
{
  DBUG_ENTER("set_stmt_error");
  DBUG_PRINT("enter", ("error: %d '%s'", errcode, ER(errcode)));
  DBUG_ASSERT(stmt != 0);

  stmt->last_errno= errcode;
  strmov(stmt->last_error, ER(errcode));
  strmov(stmt->sqlstate, sqlstate);

  DBUG_VOID_RETURN;
}


/*
  Set statement error code, sqlstate, and error message.
*/

void set_stmt_errmsg(MYSQL_STMT * stmt, const char *err, int errcode,
                     const char *sqlstate)
{
  DBUG_ENTER("set_stmt_errmsg");
  DBUG_PRINT("enter", ("error: %d/%s '%s'", errcode, sqlstate, err));
  DBUG_ASSERT(stmt != 0);

  stmt->last_errno= errcode;
  if (err && err[0])
    strmov(stmt->last_error, err);
  strmov(stmt->sqlstate, sqlstate);

  DBUG_VOID_RETURN;
}
1893

1894
/*
1895
  Read and unpack server reply to COM_STMT_PREPARE command (sent from
1896
  mysql_stmt_prepare).
1897

1898 1899 1900 1901
  SYNOPSIS
    cli_read_prepare_result()
    mysql   connection handle
    stmt    statement handle
1902 1903 1904 1905

  RETURN VALUES
    0	ok
    1	error
1906 1907
*/

unknown's avatar
unknown committed
1908
my_bool cli_read_prepare_result(MYSQL *mysql, MYSQL_STMT *stmt)
1909 1910
{
  uchar *pos;
1911 1912
  uint field_count, param_count;
  ulong packet_length;
1913
  MYSQL_DATA *fields_data;
1914
  DBUG_ENTER("cli_read_prepare_result");
1915

1916
  mysql= mysql->last_used_con;
1917
  if ((packet_length= cli_safe_read(mysql)) == packet_error)
1918
    DBUG_RETURN(1);
unknown's avatar
unknown committed
1919
  mysql->warning_count= 0;
1920

1921
  pos= (uchar*) mysql->net.read_pos;
1922
  stmt->stmt_id= uint4korr(pos+1); pos+= 5;
1923
  /* Number of columns in result set */
1924
  field_count=   uint2korr(pos);   pos+= 2;
1925
  /* Number of placeholders in the statement */
1926
  param_count=   uint2korr(pos);   pos+= 2;
unknown's avatar
unknown committed
1927 1928
  if (packet_length >= 12)
    mysql->warning_count= uint2korr(pos+1);
1929

1930 1931 1932 1933 1934 1935 1936 1937 1938 1939
  if (param_count != 0)
  {
    MYSQL_DATA *param_data;

    /* skip parameters data: we don't support it yet */
    if (!(param_data= (*mysql->methods->read_rows)(mysql, (MYSQL_FIELD*)0, 7)))
      DBUG_RETURN(1);
    free_rows(param_data);
  }

1940 1941 1942 1943
  if (field_count != 0)
  {
    if (!(mysql->server_status & SERVER_STATUS_AUTOCOMMIT))
      mysql->server_status|= SERVER_STATUS_IN_TRANS;
1944

unknown's avatar
SCRUM  
unknown committed
1945
    if (!(fields_data= (*mysql->methods->read_rows)(mysql,(MYSQL_FIELD*)0,7)))
1946 1947 1948 1949 1950 1951
      DBUG_RETURN(1);
    if (!(stmt->fields= unpack_fields(fields_data,&stmt->mem_root,
				      field_count,0,
				      mysql->server_capabilities)))
      DBUG_RETURN(1);
  }
unknown's avatar
unknown committed
1952
  stmt->field_count=  field_count;
1953
  stmt->param_count=  (ulong) param_count;
unknown's avatar
unknown committed
1954 1955
  DBUG_PRINT("exit",("field_count: %u  param_count: %u  warning_count: %u",
                     field_count, param_count, (uint) mysql->warning_count));
unknown's avatar
SCRUM  
unknown committed
1956

1957 1958 1959 1960 1961
  DBUG_RETURN(0);
}


/*
1962 1963
  Allocate memory and init prepared statement structure.

1964 1965
  SYNOPSIS
    mysql_stmt_init()
1966 1967 1968 1969 1970 1971 1972
    mysql   connection handle

  DESCRIPTION
    This is an entry point of the new API. Returned handle stands for
    a server-side prepared statement. Memory for this structure (~700
    bytes) is allocated using 'malloc'. Once created, the handle can be
    reused many times. Created statement handle is bound to connection
unknown's avatar
unknown committed
1973
    handle provided to this call: its lifetime is limited by lifetime
1974 1975 1976 1977 1978 1979
    of connection.
    'mysql_stmt_init()' is a pure local call, server side structure is
    created only in mysql_stmt_prepare.
    Next steps you may want to make:
    - set a statement attribute (mysql_stmt_attr_set()),
    - prepare statement handle with a query (mysql_stmt_prepare()),
unknown's avatar
unknown committed
1980
    - close statement handle and free its memory (mysql_stmt_close()),
1981 1982 1983 1984 1985
    - reset statement with mysql_stmt_reset() (a no-op which will
      just return).
    Behaviour of the rest of API calls on this statement is not defined yet
    (though we're working on making each wrong call sequence return
    error).
1986

1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004
  RETURN VALUE
    statement structure upon success and NULL if out of
    memory
*/

MYSQL_STMT * STDCALL
mysql_stmt_init(MYSQL *mysql)
{
  MYSQL_STMT *stmt;
  DBUG_ENTER("mysql_stmt_init");

  if (!(stmt= (MYSQL_STMT *) my_malloc(sizeof(MYSQL_STMT),
                                       MYF(MY_WME | MY_ZEROFILL))))
  {
    set_mysql_error(mysql, CR_OUT_OF_MEMORY, unknown_sqlstate);
    DBUG_RETURN(0);
  }

2005
  init_alloc_root(&stmt->mem_root, 2048, 2048);
2006 2007
  init_alloc_root(&stmt->result.alloc, 4096, 4096);
  stmt->result.alloc.min_malloc= sizeof(MYSQL_ROWS);
2008 2009
  mysql->stmts= list_add(mysql->stmts, &stmt->list);
  stmt->list.data= stmt;
2010
  stmt->state= MYSQL_STMT_INIT_DONE;
2011
  stmt->mysql= mysql;
unknown's avatar
unknown committed
2012
  stmt->read_row_func= stmt_read_row_no_result_set;
2013
  stmt->prefetch_rows= DEFAULT_PREFETCH_ROWS;
2014
  strmov(stmt->sqlstate, not_error_sqlstate);
2015
  /* The rest of statement members was bzeroed inside malloc */
2016 2017 2018 2019

  DBUG_RETURN(stmt);
}

2020

2021
/*
2022 2023
  Prepare server side statement with query.

2024 2025
  SYNOPSIS
    mysql_stmt_prepare()
2026 2027 2028
    stmt    statement handle
    query   statement to prepare
    length  statement length
2029 2030

  DESCRIPTION
2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043
    Associate statement with statement handle. This is done both on
    client and server sides. At this point the server parses given query
    and creates an internal structure to represent it.
    Next steps you may want to make:
    - find out if this statement returns a result set by
      calling mysql_stmt_field_count(), and get result set metadata
      with mysql_stmt_result_metadata(),
    - if query contains placeholders, bind input parameters to placeholders
      using mysql_stmt_bind_param(),
    - otherwise proceed directly to mysql_stmt_execute().

  IMPLEMENTATION NOTES
  - if this is a re-prepare of the statement, first close previous data
2044
    structure on the server and free old statement data
2045
  - then send the query to server and get back number of placeholders,
2046
    number of columns in result set (if any), and result set metadata.
2047
    At the same time allocate memory for input and output parameters
2048
    to have less checks in mysql_stmt_bind_{param, result}.
2049

2050 2051
  RETURN VALUES
    0  success
2052
   !0  error
2053 2054
*/

2055 2056
int STDCALL
mysql_stmt_prepare(MYSQL_STMT *stmt, const char *query, ulong length)
2057
{
2058 2059 2060
  MYSQL *mysql= stmt->mysql;
  DBUG_ENTER("mysql_stmt_prepare");

2061
  if (!mysql)
2062
  {
2063 2064
    /* mysql can be reset in mysql_close called from mysql_reconnect */
    set_stmt_error(stmt, CR_SERVER_LOST, unknown_sqlstate);
2065
    DBUG_RETURN(1);
2066
  }
2067

2068 2069 2070 2071 2072 2073 2074
  /*
    Reset the last error in any case: that would clear the statement
    if the previous prepare failed.
  */
  stmt->last_errno= 0;
  stmt->last_error[0]= '\0';

2075 2076 2077
  if ((int) stmt->state > (int) MYSQL_STMT_INIT_DONE)
  {
    /* This is second prepare with another statement */
2078
    uchar buff[MYSQL_STMT_HEADER];               /* 4 bytes - stmt id */
2079

2080
    if (reset_stmt_handle(stmt, RESET_LONG_DATA | RESET_STORE_RESULT))
2081
      DBUG_RETURN(1);
2082
    /*
2083
      These members must be reset for API to
2084 2085 2086 2087 2088 2089 2090
      function in case of error or misuse.
    */
    stmt->bind_param_done= stmt->bind_result_done= FALSE;
    stmt->param_count= stmt->field_count= 0;
    free_root(&stmt->mem_root, MYF(MY_KEEP_PREALLOC));

    int4store(buff, stmt->stmt_id);
2091

2092
    /*
2093 2094
      Close statement in server

2095 2096 2097 2098
      If there was a 'use' result from another statement, or from
      mysql_use_result it won't be freed in mysql_stmt_free_result and
      we should get 'Commands out of sync' here.
    */
2099
    stmt->state= MYSQL_STMT_INIT_DONE;
2100
    if (stmt_command(mysql, COM_STMT_CLOSE, buff, 4, stmt))
2101 2102 2103 2104 2105 2106 2107
    {
      set_stmt_errmsg(stmt, mysql->net.last_error, mysql->net.last_errno,
                      mysql->net.sqlstate);
      DBUG_RETURN(1);
    }
  }

2108
  if (stmt_command(mysql, COM_STMT_PREPARE, (const uchar*) query, length, stmt))
2109
  {
2110 2111 2112
    set_stmt_errmsg(stmt, mysql->net.last_error, mysql->net.last_errno,
                    mysql->net.sqlstate);
    DBUG_RETURN(1);
2113 2114
  }

unknown's avatar
SCRUM  
unknown committed
2115
  if ((*mysql->methods->read_prepare_result)(mysql, stmt))
2116 2117 2118
  {
    set_stmt_errmsg(stmt, mysql->net.last_error, mysql->net.last_errno,
                    mysql->net.sqlstate);
2119
    DBUG_RETURN(1);
2120
  }
unknown's avatar
unknown committed
2121

2122
  /*
2123
    alloc_root will return valid address even in case when param_count
2124 2125 2126 2127
    and field_count are zero. Thus we should never rely on stmt->bind
    or stmt->params when checking for existence of placeholders or
    result set.
  */
unknown's avatar
unknown committed
2128 2129
  if (!(stmt->params= (MYSQL_BIND *) alloc_root(&stmt->mem_root,
						sizeof(MYSQL_BIND)*
2130
                                                (stmt->param_count +
unknown's avatar
unknown committed
2131 2132 2133
                                                 stmt->field_count))))
  {
    set_stmt_error(stmt, CR_OUT_OF_MEMORY, unknown_sqlstate);
2134
    DBUG_RETURN(1);
unknown's avatar
unknown committed
2135 2136
  }
  stmt->bind= stmt->params + stmt->param_count;
2137
  stmt->state= MYSQL_STMT_PREPARE_DONE;
unknown's avatar
unknown committed
2138
  DBUG_PRINT("info", ("Parameter count: %u", stmt->param_count));
2139
  DBUG_RETURN(0);
2140 2141
}

2142
/*
2143 2144 2145 2146
  Get result set metadata from reply to mysql_stmt_execute.
  This is used mainly for SHOW commands, as metadata for these
  commands is sent only with result set.
  To be removed when all commands will fully support prepared mode.
2147 2148
*/

2149
static unsigned int alloc_stmt_fields(MYSQL_STMT *stmt)
2150
{
2151 2152
  MYSQL_FIELD *fields, *field, *end;
  MEM_ROOT *alloc= &stmt->mem_root;
unknown's avatar
unknown committed
2153
  MYSQL *mysql= stmt->mysql->last_used_con;
2154

unknown's avatar
unknown committed
2155
  stmt->field_count= mysql->field_count;
2156

2157
  /*
2158
    Get the field information for non-select statements
2159 2160
    like SHOW and DESCRIBE commands
  */
2161
  if (!(stmt->fields= (MYSQL_FIELD *) alloc_root(alloc,
2162
						 sizeof(MYSQL_FIELD) *
2163 2164
						 stmt->field_count)) ||
      !(stmt->bind= (MYSQL_BIND *) alloc_root(alloc,
2165 2166
					      sizeof(MYSQL_BIND) *
					      stmt->field_count)))
2167
    return 0;
2168 2169

  for (fields= mysql->fields, end= fields+stmt->field_count,
2170
	 field= stmt->fields;
2171 2172 2173 2174 2175 2176 2177
       field && fields < end; fields++, field++)
  {
    field->db       = strdup_root(alloc,fields->db);
    field->table    = strdup_root(alloc,fields->table);
    field->org_table= strdup_root(alloc,fields->org_table);
    field->name     = strdup_root(alloc,fields->name);
    field->org_name = strdup_root(alloc,fields->org_name);
2178
    field->charsetnr= fields->charsetnr;
2179 2180 2181 2182 2183 2184 2185
    field->length   = fields->length;
    field->type     = fields->type;
    field->flags    = fields->flags;
    field->decimals = fields->decimals;
    field->def      = fields->def ? strdup_root(alloc,fields->def): 0;
    field->max_length= 0;
  }
2186 2187
  return stmt->field_count;
}
2188

2189 2190 2191

/*
  Update result set columns metadata if it was sent again in
2192
  reply to COM_STMT_EXECUTE.
2193 2194 2195 2196 2197 2198 2199
*/

static void update_stmt_fields(MYSQL_STMT *stmt)
{
  MYSQL_FIELD *field= stmt->mysql->fields;
  MYSQL_FIELD *field_end= field + stmt->field_count;
  MYSQL_FIELD *stmt_field= stmt->fields;
2200
  MYSQL_BIND *my_bind= stmt->bind_result_done ? stmt->bind : 0;
2201 2202 2203 2204 2205 2206 2207 2208 2209 2210

  DBUG_ASSERT(stmt->field_count == stmt->mysql->field_count);

  for (; field < field_end; ++field, ++stmt_field)
  {
    stmt_field->charsetnr= field->charsetnr;
    stmt_field->length   = field->length;
    stmt_field->type     = field->type;
    stmt_field->flags    = field->flags;
    stmt_field->decimals = field->decimals;
2211
    if (my_bind)
2212 2213
    {
      /* Ignore return value: it should be 0 if bind_result succeeded. */
2214
      (void) setup_one_fetch_function(my_bind++, stmt_field);
2215
    }
2216 2217 2218
  }
}

2219
/*
2220 2221 2222 2223 2224 2225 2226 2227 2228
  Returns prepared statement metadata in the form of a result set.

  SYNOPSIS
    mysql_stmt_result_metadata()
    stmt  statement handle

  DESCRIPTION
    This function should be used after mysql_stmt_execute().
    You can safely check that prepared statement has a result set by calling
2229
    mysql_stmt_field_count(): if number of fields is not zero, you can call
2230 2231 2232 2233
    this function to get fields metadata.
    Next steps you may want to make:
    - find out number of columns in result set by calling
      mysql_num_fields(res) (the same value is returned by
2234
      mysql_stmt_field_count())
2235 2236 2237 2238
    - fetch metadata for any column with mysql_fetch_field,
      mysql_fetch_field_direct, mysql_fetch_fields, mysql_field_seek.
    - free returned MYSQL_RES structure with mysql_free_result.
    - proceed to binding of output parameters.
2239 2240 2241 2242 2243 2244

  RETURN
    NULL  statement contains no result set or out of memory.
          In the latter case you can retreive error message
          with mysql_stmt_error.
    MYSQL_RES  a result set with no rows
2245 2246 2247
*/

MYSQL_RES * STDCALL
2248
mysql_stmt_result_metadata(MYSQL_STMT *stmt)
2249 2250
{
  MYSQL_RES *result;
2251
  DBUG_ENTER("mysql_stmt_result_metadata");
2252

2253 2254 2255 2256 2257 2258 2259 2260 2261
  /*
    stmt->fields is only defined if stmt->field_count is not null;
    stmt->field_count is initialized in prepare.
  */
  if (!stmt->field_count)
     DBUG_RETURN(0);

  if (!(result=(MYSQL_RES*) my_malloc(sizeof(*result),
                                      MYF(MY_WME | MY_ZEROFILL))))
2262
  {
2263 2264 2265
    set_stmt_error(stmt, CR_OUT_OF_MEMORY, unknown_sqlstate);
    DBUG_RETURN(0);
  }
unknown's avatar
unknown committed
2266

2267 2268
  result->methods=	stmt->mysql->methods;
  result->eof=		1;                      /* Marker for buffered */
2269 2270
  result->fields=	stmt->fields;
  result->field_count=	stmt->field_count;
2271
  /* The rest of members of 'result' was bzeroed inside malloc */
2272
  DBUG_RETURN(result);
2273 2274
}

2275

2276
/*
2277 2278
  Returns parameter columns meta information in the form of
  result set.
2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291

  SYNOPSYS
    mysql_stmt_param_metadata()
    stmt    statement handle

  DESCRIPTION
    This function can be called after you prepared the statement handle
    with mysql_stmt_prepare().
    XXX: not implemented yet.

  RETURN
    MYSQL_RES on success, 0 if there is no metadata.
    Currently this function always returns 0.
2292 2293 2294
*/

MYSQL_RES * STDCALL
2295
mysql_stmt_param_metadata(MYSQL_STMT *stmt)
2296
{
2297
  DBUG_ENTER("mysql_stmt_param_metadata");
2298

2299 2300 2301 2302
  if (!stmt->param_count)
    DBUG_RETURN(0);

  /*
2303 2304
    TODO: Fix this when server sends the information.
    Till then keep a dummy prototype.
2305 2306 2307 2308 2309
  */
  DBUG_RETURN(0); 
}


2310 2311 2312 2313 2314 2315 2316 2317 2318 2319
/* Store type of parameter in network buffer. */

static void store_param_type(char **pos, MYSQL_BIND *param)
{
  uint typecode= param->buffer_type | (param->is_unsigned ? 32768 : 0);
  int2store(*pos, typecode);
  *pos+= 2;
}


2320 2321
/*
  Functions to store parameter data in network packet.
2322

2323 2324 2325 2326 2327
  SYNOPSIS
    store_param_xxx()
    net			MySQL NET connection
    param		MySQL bind param

2328
  DESCRIPTION
2329 2330 2331 2332 2333
    These funtions are invoked from mysql_stmt_execute() by
    MYSQL_BIND::store_param_func pointer. This pointer is set once per
    many executions in mysql_stmt_bind_param(). The caller must ensure
    that network buffer have enough capacity to store parameter
    (MYSQL_BIND::buffer_length contains needed number of bytes).
2334
*/
2335 2336 2337

static void store_param_tinyint(NET *net, MYSQL_BIND *param)
{
2338
  *(net->write_pos++)= *(uchar *) param->buffer;
2339 2340
}

2341 2342 2343 2344 2345 2346
static void store_param_short(NET *net, MYSQL_BIND *param)
{
  short value= *(short*) param->buffer;
  int2store(net->write_pos,value);
  net->write_pos+=2;
}
2347

2348
static void store_param_int32(NET *net, MYSQL_BIND *param)
2349
{
2350 2351 2352 2353
  int32 value= *(int32*) param->buffer;
  int4store(net->write_pos,value);
  net->write_pos+=4;
}
2354

2355 2356 2357 2358 2359 2360
static void store_param_int64(NET *net, MYSQL_BIND *param)
{
  longlong value= *(longlong*) param->buffer;
  int8store(net->write_pos,value);
  net->write_pos+= 8;
}
2361

2362 2363 2364 2365 2366
static void store_param_float(NET *net, MYSQL_BIND *param)
{
  float value= *(float*) param->buffer;
  float4store(net->write_pos, value);
  net->write_pos+= 4;
2367 2368
}

2369 2370 2371 2372 2373 2374
static void store_param_double(NET *net, MYSQL_BIND *param)
{
  double value= *(double*) param->buffer;
  float8store(net->write_pos, value);
  net->write_pos+= 8;
}
2375

unknown's avatar
unknown committed
2376 2377 2378
static void store_param_time(NET *net, MYSQL_BIND *param)
{
  MYSQL_TIME *tm= (MYSQL_TIME *) param->buffer;
2379
  char buff[MAX_TIME_REP_LENGTH], *pos;
unknown's avatar
unknown committed
2380 2381 2382 2383 2384 2385 2386 2387 2388 2389
  uint length;

  pos= buff+1;
  pos[0]= tm->neg ? 1: 0;
  int4store(pos+1, tm->day);
  pos[5]= (uchar) tm->hour;
  pos[6]= (uchar) tm->minute;
  pos[7]= (uchar) tm->second;
  int4store(pos+8, tm->second_part);
  if (tm->second_part)
2390
    length= 12;
unknown's avatar
unknown committed
2391 2392 2393 2394
  else if (tm->hour || tm->minute || tm->second || tm->day)
    length= 8;
  else
    length= 0;
2395
  buff[0]= (char) length++;
unknown's avatar
unknown committed
2396 2397 2398 2399 2400 2401
  memcpy((char *)net->write_pos, buff, length);
  net->write_pos+= length;
}

static void net_store_datetime(NET *net, MYSQL_TIME *tm)
{
2402
  char buff[MAX_DATETIME_REP_LENGTH], *pos;
unknown's avatar
unknown committed
2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421
  uint length;

  pos= buff+1;

  int2store(pos, tm->year);
  pos[2]= (uchar) tm->month;
  pos[3]= (uchar) tm->day;
  pos[4]= (uchar) tm->hour;
  pos[5]= (uchar) tm->minute;
  pos[6]= (uchar) tm->second;
  int4store(pos+7, tm->second_part);
  if (tm->second_part)
    length= 11;
  else if (tm->hour || tm->minute || tm->second)
    length= 7;
  else if (tm->year || tm->month || tm->day)
    length= 4;
  else
    length= 0;
2422
  buff[0]= (char) length++;
unknown's avatar
unknown committed
2423 2424 2425 2426 2427 2428
  memcpy((char *)net->write_pos, buff, length);
  net->write_pos+= length;
}

static void store_param_date(NET *net, MYSQL_BIND *param)
{
2429 2430 2431
  MYSQL_TIME tm= *((MYSQL_TIME *) param->buffer);
  tm.hour= tm.minute= tm.second= tm.second_part= 0;
  net_store_datetime(net, &tm);
unknown's avatar
unknown committed
2432 2433 2434 2435 2436 2437 2438
}

static void store_param_datetime(NET *net, MYSQL_BIND *param)
{
  MYSQL_TIME *tm= (MYSQL_TIME *) param->buffer;
  net_store_datetime(net, tm);
}
2439

2440
static void store_param_str(NET *net, MYSQL_BIND *param)
2441
{
2442 2443
  /* param->length is always set in mysql_stmt_bind_param */
  ulong length= *param->length;
2444
  uchar *to= net_store_length(net->write_pos, length);
2445
  memcpy(to, param->buffer, length);
2446
  net->write_pos= to+length;
2447 2448
}

2449

2450
/*
2451 2452 2453 2454 2455 2456 2457 2458 2459
  Mark if the parameter is NULL.

  SYNOPSIS
    store_param_null()
    net			MySQL NET connection
    param		MySQL bind param

  DESCRIPTION
    A data package starts with a string of bits where we set a bit
2460 2461
    if a parameter is NULL. Unlike bit string in result set row, here
    we don't have reserved bits for OK/error packet.
2462 2463
*/

2464
static void store_param_null(NET *net, MYSQL_BIND *param)
2465
{
2466
  uint pos= param->param_number;
unknown's avatar
unknown committed
2467
  net->buff[pos/8]|=  (uchar) (1 << (pos & 7));
2468
}
2469 2470 2471


/*
2472 2473 2474
  Store one parameter in network packet: data is read from
  client buffer and saved in network packet by means of one
  of store_param_xxxx functions.
2475 2476
*/

2477
static my_bool store_param(MYSQL_STMT *stmt, MYSQL_BIND *param)
2478
{
2479
  NET *net= &stmt->mysql->net;
2480
  DBUG_ENTER("store_param");
unknown's avatar
unknown committed
2481
  DBUG_PRINT("enter",("type: %d  buffer: 0x%lx  length: %lu  is_null: %d",
unknown's avatar
unknown committed
2482
		      param->buffer_type,
unknown's avatar
unknown committed
2483 2484
		      (long) (param->buffer ? param->buffer : NullS),
                      *param->length, *param->is_null));
unknown's avatar
unknown committed
2485 2486

  if (*param->is_null)
2487 2488
    store_param_null(net, param);
  else
unknown's avatar
unknown committed
2489
  {
unknown's avatar
unknown committed
2490 2491
    /*
      Param->length should ALWAYS point to the correct length for the type
2492
      Either to the length pointer given by the user or param->buffer_length
unknown's avatar
unknown committed
2493
    */
2494
    if ((my_realloc_str(net, *param->length)))
unknown's avatar
unknown committed
2495
    {
2496
      set_stmt_error(stmt, net->last_errno, unknown_sqlstate);
unknown's avatar
unknown committed
2497
      DBUG_RETURN(1);
unknown's avatar
unknown committed
2498
    }
2499
    (*param->store_param_func)(net, param);
unknown's avatar
unknown committed
2500 2501
  }
  DBUG_RETURN(0);
2502 2503
}

unknown's avatar
unknown committed
2504

2505
/*
2506
  Auxilary function to send COM_STMT_EXECUTE packet to server and read reply.
2507
  Used from cli_stmt_execute, which is in turn used by mysql_stmt_execute.
2508 2509
*/

2510
static my_bool execute(MYSQL_STMT *stmt, char *packet, ulong length)
2511
{
2512 2513
  MYSQL *mysql= stmt->mysql;
  NET	*net= &mysql->net;
2514 2515
  uchar buff[4 /* size of stmt id */ +
             5 /* execution flags */];
2516
  my_bool res;
2517
  DBUG_ENTER("execute");
2518
  DBUG_DUMP("packet", packet, length);
2519

2520 2521
  mysql->last_used_con= mysql;
  int4store(buff, stmt->stmt_id);		/* Send stmt id to server */
2522
  buff[4]= (char) stmt->flags;
2523
  int4store(buff+5, 1);                         /* iteration count */
2524

2525
  res= test(cli_advanced_command(mysql, COM_STMT_EXECUTE, buff, sizeof(buff),
2526
                                 (uchar*) packet, length, 1, NULL) ||
2527 2528
            (*mysql->methods->read_query_result)(mysql));
  stmt->affected_rows= mysql->affected_rows;
2529
  stmt->server_status= mysql->server_status;
2530 2531
  stmt->insert_id= mysql->insert_id;
  if (res)
2532
  {
2533
    set_stmt_errmsg(stmt, net->last_error, net->last_errno, net->sqlstate);
2534
    DBUG_RETURN(1);
2535 2536 2537 2538
  }
  DBUG_RETURN(0);
}

unknown's avatar
unknown committed
2539 2540

int cli_stmt_execute(MYSQL_STMT *stmt)
2541
{
unknown's avatar
SCRUM  
unknown committed
2542
  DBUG_ENTER("cli_stmt_execute");
2543 2544 2545

  if (stmt->param_count)
  {
2546 2547
    MYSQL *mysql= stmt->mysql;
    NET        *net= &mysql->net;
2548
    MYSQL_BIND *param, *param_end;
2549
    char       *param_data;
unknown's avatar
unknown committed
2550 2551 2552
    ulong length;
    uint null_count;
    my_bool    result;
2553

2554 2555 2556 2557 2558
    if (!stmt->bind_param_done)
    {
      set_stmt_error(stmt, CR_PARAMS_NOT_BOUND, unknown_sqlstate);
      DBUG_RETURN(1);
    }
2559 2560
    if (mysql->status != MYSQL_STATUS_READY ||
        mysql->server_status & SERVER_MORE_RESULTS_EXISTS)
2561 2562 2563 2564
    {
      set_stmt_error(stmt, CR_COMMANDS_OUT_OF_SYNC, unknown_sqlstate);
      DBUG_RETURN(1);
    }
2565

2566
    net_clear(net, 1);				/* Sets net->write_pos */
2567 2568
    /* Reserve place for null-marker bytes */
    null_count= (stmt->param_count+7) /8;
2569 2570 2571 2572 2573
    if (my_realloc_str(net, null_count + 1))
    {
      set_stmt_error(stmt, net->last_errno, unknown_sqlstate);
      DBUG_RETURN(1);
    }
2574 2575 2576 2577 2578
    bzero((char*) net->write_pos, null_count);
    net->write_pos+= null_count;
    param_end= stmt->params + stmt->param_count;

    /* In case if buffers (type) altered, indicate to server */
unknown's avatar
unknown committed
2579 2580
    *(net->write_pos)++= (uchar) stmt->send_types_to_server;
    if (stmt->send_types_to_server)
2581
    {
2582 2583 2584 2585 2586
      if (my_realloc_str(net, 2 * stmt->param_count))
      {
        set_stmt_error(stmt, net->last_errno, unknown_sqlstate);
        DBUG_RETURN(1);
      }
2587 2588 2589 2590 2591
      /*
	Store types of parameters in first in first package
	that is sent to the server.
      */
      for (param= stmt->params;	param < param_end ; param++)
2592
        store_param_type((char**) &net->write_pos, param);
2593 2594 2595
    }

    for (param= stmt->params; param < param_end; param++)
2596
    {
2597
      /* check if mysql_stmt_send_long_data() was used */
unknown's avatar
unknown committed
2598 2599
      if (param->long_data_used)
	param->long_data_used= 0;	/* Clear for next execute call */
2600
      else if (store_param(stmt, param))
unknown's avatar
unknown committed
2601
	DBUG_RETURN(1);
2602
    }
2603 2604
    length= (ulong) (net->write_pos - net->buff);
    /* TODO: Look into avoding the following memdup */
2605
    if (!(param_data= my_memdup(net->buff, length, MYF(0))))
2606
    {
2607
      set_stmt_error(stmt, CR_OUT_OF_MEMORY, unknown_sqlstate);
2608
      DBUG_RETURN(1);
2609
    }
2610
    result= execute(stmt, param_data, length);
unknown's avatar
unknown committed
2611
    stmt->send_types_to_server=0;
2612
    my_free(param_data, MYF(MY_WME));
2613 2614 2615
    DBUG_RETURN(result);
  }
  DBUG_RETURN((int) execute(stmt,0,0));
2616 2617
}

2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631
/*
  Read one row from buffered result set.  Result set is created by prior
  call to mysql_stmt_store_result().
  SYNOPSIS
    stmt_read_row_buffered()

  RETURN VALUE
    0             - success; *row is set to valid row pointer (row data
                    is stored in result set buffer)
    MYSQL_NO_DATA - end of result set. *row is set to NULL
*/

static int stmt_read_row_buffered(MYSQL_STMT *stmt, unsigned char **row)
{
2632
  if (stmt->data_cursor)
2633
  {
2634 2635
    *row= (uchar *) stmt->data_cursor->data;
    stmt->data_cursor= stmt->data_cursor->next;
2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655
    return 0;
  }
  *row= 0;
  return MYSQL_NO_DATA;
}

/*
  Read one row from network: unbuffered non-cursor fetch.
  If last row was read, or error occured, erase this statement
  from record pointing to object unbuffered fetch is performed from.

  SYNOPSIS
    stmt_read_row_unbuffered()
    stmt  statement handle
    row   pointer to write pointer to row data;

  RETURN VALUE
    0           - success; *row contains valid address of a row;
                  row data is stored in network buffer
    1           - error; error code is written to
2656
                  stmt->last_{errno,error}; *row is not changed
2657
  MYSQL_NO_DATA - end of file was read from network;
2658
                  *row is set to NULL
2659 2660 2661 2662 2663 2664
*/

static int stmt_read_row_unbuffered(MYSQL_STMT *stmt, unsigned char **row)
{
  int rc= 1;
  MYSQL *mysql= stmt->mysql;
2665
  /*
2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676
    This function won't be called if stmt->field_count is zero
    or execution wasn't done: this is ensured by mysql_stmt_execute.
  */
  if (!mysql)
  {
    set_stmt_error(stmt, CR_SERVER_LOST, unknown_sqlstate);
    return 1;
  }
  if (mysql->status != MYSQL_STATUS_GET_RESULT)
  {
    set_stmt_error(stmt, stmt->unbuffered_fetch_cancelled ?
unknown's avatar
unknown committed
2677
                   CR_FETCH_CANCELED : CR_COMMANDS_OUT_OF_SYNC,
2678 2679 2680 2681 2682 2683 2684
                   unknown_sqlstate);
    goto error;
  }
  if ((*mysql->methods->unbuffered_fetch)(mysql, (char**) row))
  {
    set_stmt_errmsg(stmt, mysql->net.last_error, mysql->net.last_errno,
                    mysql->net.sqlstate);
2685 2686 2687 2688 2689 2690 2691
    /*
      If there was an error, there are no more pending rows:
      reset statement status to not hang up in following
      mysql_stmt_close (it will try to flush result set before
      closing the statement).
    */
    mysql->status= MYSQL_STATUS_READY;
2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706
    goto error;
  }
  if (!*row)
  {
    mysql->status= MYSQL_STATUS_READY;
    rc= MYSQL_NO_DATA;
    goto error;
  }
  return 0;
error:
  if (mysql->unbuffered_fetch_owner == &stmt->unbuffered_fetch_cancelled)
    mysql->unbuffered_fetch_owner= 0;
  return rc;
}

2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731

/*
  Fetch statement row using server side cursor.

  SYNOPSIS
    stmt_read_row_from_cursor()

  RETURN VALUE
    0            success
    1            error
  MYSQL_NO_DATA  end of data
*/

static int
stmt_read_row_from_cursor(MYSQL_STMT *stmt, unsigned char **row)
{
  if (stmt->data_cursor)
    return stmt_read_row_buffered(stmt, row);
  if (stmt->server_status & SERVER_STATUS_LAST_ROW_SENT)
    stmt->server_status &= ~SERVER_STATUS_LAST_ROW_SENT;
  else
  {
    MYSQL *mysql= stmt->mysql;
    NET *net= &mysql->net;
    MYSQL_DATA *result= &stmt->result;
2732 2733
    uchar buff[4 /* statement id */ +
               4 /* number of rows to fetch */];
2734 2735 2736 2737 2738 2739

    free_root(&result->alloc, MYF(MY_KEEP_PREALLOC));
    result->data= NULL;
    result->rows= 0;
    /* Send row request to the server */
    int4store(buff, stmt->stmt_id);
2740
    int4store(buff + 4, stmt->prefetch_rows); /* number of rows to fetch */
2741
    if ((*mysql->methods->advanced_command)(mysql, COM_STMT_FETCH,
2742
                                            buff, sizeof(buff), (uchar*) 0, 0,
unknown's avatar
unknown committed
2743
                                            1, NULL))
2744 2745 2746 2747
    {
      set_stmt_errmsg(stmt, net->last_error, net->last_errno, net->sqlstate);
      return 1;
    }
2748
    if ((*mysql->methods->read_rows_from_cursor)(stmt))
2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759
      return 1;
    stmt->server_status= mysql->server_status;

    stmt->data_cursor= result->data;
    return stmt_read_row_buffered(stmt, row);
  }
  *row= 0;
  return MYSQL_NO_DATA;
}


2760 2761 2762 2763 2764 2765 2766 2767
/*
  Default read row function to not SIGSEGV in client in
  case of wrong sequence of API calls.
*/

static int
stmt_read_row_no_data(MYSQL_STMT *stmt  __attribute__((unused)),
                      unsigned char **row  __attribute__((unused)))
unknown's avatar
unknown committed
2768 2769 2770 2771 2772 2773 2774
{
  return MYSQL_NO_DATA;
}

static int
stmt_read_row_no_result_set(MYSQL_STMT *stmt  __attribute__((unused)),
                      unsigned char **row  __attribute__((unused)))
2775
{
2776 2777
  set_stmt_error(stmt, CR_NO_RESULT_SET, unknown_sqlstate);
  return 1;
2778 2779
}

2780 2781 2782 2783 2784 2785 2786 2787

/*
  Get/set statement attributes

  SYNOPSIS
    mysql_stmt_attr_get()
    mysql_stmt_attr_set()

unknown's avatar
unknown committed
2788
    attr_type  statement attribute
2789 2790 2791 2792 2793 2794
    value      casted to const void * pointer to value.

  RETURN VALUE
    0 success
   !0 wrong attribute type
*/
2795

2796 2797 2798 2799 2800 2801 2802 2803
my_bool STDCALL mysql_stmt_attr_set(MYSQL_STMT *stmt,
                                    enum enum_stmt_attr_type attr_type,
                                    const void *value)
{
  switch (attr_type) {
  case STMT_ATTR_UPDATE_MAX_LENGTH:
    stmt->update_max_length= value ? *(const my_bool*) value : 0;
    break;
2804
  case STMT_ATTR_CURSOR_TYPE:
2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818
  {
    ulong cursor_type;
    cursor_type= value ? *(ulong*) value : 0UL;
    if (cursor_type > (ulong) CURSOR_TYPE_READ_ONLY)
      goto err_not_implemented;
    stmt->flags= cursor_type;
    break;
  }
  case STMT_ATTR_PREFETCH_ROWS:
  {
    ulong prefetch_rows= value ? *(ulong*) value : DEFAULT_PREFETCH_ROWS;
    if (value == 0)
      return TRUE;
    stmt->prefetch_rows= prefetch_rows;
2819
    break;
2820
  }
2821
  default:
2822
    goto err_not_implemented;
2823 2824
  }
  return FALSE;
2825 2826 2827
err_not_implemented:
  set_stmt_error(stmt, CR_NOT_IMPLEMENTED, unknown_sqlstate);
  return TRUE;
2828 2829 2830
}


2831
my_bool STDCALL mysql_stmt_attr_get(MYSQL_STMT *stmt,
2832 2833 2834 2835 2836
                                    enum enum_stmt_attr_type attr_type,
                                    void *value)
{
  switch (attr_type) {
  case STMT_ATTR_UPDATE_MAX_LENGTH:
2837
    *(my_bool*) value= stmt->update_max_length;
2838
    break;
2839
  case STMT_ATTR_CURSOR_TYPE:
2840
    *(ulong*) value= stmt->flags;
2841
    break;
2842 2843 2844
  case STMT_ATTR_PREFETCH_ROWS:
    *(ulong*) value= stmt->prefetch_rows;
    break;
2845
  default:
2846 2847 2848 2849 2850 2851
    return TRUE;
  }
  return FALSE;
}


unknown's avatar
SCRUM  
unknown committed
2852
/*
2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893
  Send placeholders data to server (if there are placeholders)
  and execute prepared statement.

  SYNOPSIS
    mysql_stmt_execute()
    stmt  statement handle. The handle must be created
          with mysql_stmt_init() and prepared with
          mysql_stmt_prepare(). If there are placeholders
          in the statement they must be bound to local
          variables with mysql_stmt_bind_param().

  DESCRIPTION
    This function will automatically flush pending result
    set (if there is one), send parameters data to the server
    and read result of statement execution.
    If previous result set was cached with mysql_stmt_store_result()
    it will also be freed in the beginning of this call.
    The server can return 3 types of responses to this command:
    - error, can be retrieved with mysql_stmt_error()
    - ok, no result set pending. In this case we just update
      stmt->insert_id and stmt->affected_rows.
    - the query returns a result set: there could be 0 .. N
    rows in it. In this case the server can also send updated
    result set metadata.

    Next steps you may want to make:
    - find out if there is result set with mysql_stmt_field_count().
    If there is one:
    - optionally, cache entire result set on client to unblock
    connection with mysql_stmt_store_result()
    - bind client variables to result set columns and start read rows
    with mysql_stmt_fetch().
    - reset statement with mysql_stmt_reset() or close it with
    mysql_stmt_close()
    Otherwise:
    - find out last insert id and number of affected rows with
    mysql_stmt_insert_id(), mysql_stmt_affected_rows()

  RETURN
    0   success
    1   error, message can be retrieved with mysql_stmt_error().
unknown's avatar
SCRUM  
unknown committed
2894 2895
*/

2896
int STDCALL mysql_stmt_execute(MYSQL_STMT *stmt)
unknown's avatar
SCRUM  
unknown committed
2897
{
2898
  MYSQL *mysql= stmt->mysql;
2899
  DBUG_ENTER("mysql_stmt_execute");
unknown's avatar
SCRUM  
unknown committed
2900

2901 2902
  if (!mysql)
  {
2903
    /* Error is already set in mysql_detatch_stmt_list */
unknown's avatar
SCRUM  
unknown committed
2904
    DBUG_RETURN(1);
2905 2906
  }

2907
  if (reset_stmt_handle(stmt, RESET_STORE_RESULT))
2908
    DBUG_RETURN(1);
2909 2910
  /*
    No need to check for stmt->state: if the statement wasn't
unknown's avatar
unknown committed
2911
    prepared we'll get 'unknown statement handler' error from server.
2912 2913 2914
  */
  if (mysql->methods->stmt_execute(stmt))
    DBUG_RETURN(1);
2915
  if (mysql->field_count)
2916
  {
2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937
    /* Server has sent result set metadata */
    if (stmt->field_count == 0)
    {
      /*
        This is 'SHOW'/'EXPLAIN'-like query. Current implementation of
        prepared statements can't send result set metadata for these queries
        on prepare stage. Read it now.
      */
      alloc_stmt_fields(stmt);
    }
    else
    {
      /*
        Update result set metadata if it for some reason changed between
        prepare and execute, i.e.:
        - in case of 'SELECT ?' we don't know column type unless data was
          supplied to mysql_stmt_execute, so updated column type is sent
          now.
        - if data dictionary changed between prepare and execute, for
          example a table used in the query was altered.
        Note, that now (4.1.3) we always send metadata in reply to
2938
        COM_STMT_EXECUTE (even if it is not necessary), so either this or
2939
        previous branch always works.
2940 2941 2942 2943 2944
        TODO: send metadata only when it's really necessary and add a warning
        'Metadata changed' when it's sent twice.
      */
      update_stmt_fields(stmt);
    }
2945 2946 2947 2948
  }
  stmt->state= MYSQL_STMT_EXECUTE_DONE;
  if (stmt->field_count)
  {
2949 2950 2951 2952 2953
    if (stmt->server_status & SERVER_STATUS_CURSOR_EXISTS)
    {
      mysql->status= MYSQL_STATUS_READY;
      stmt->read_row_func= stmt_read_row_from_cursor;
    }
2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964
    else if (stmt->flags & CURSOR_TYPE_READ_ONLY)
    {
      /*
        This is a single-row result set, a result set with no rows, EXPLAIN,
        SHOW VARIABLES, or some other command which either a) bypasses the
        cursors framework in the server and writes rows directly to the
        network or b) is more efficient if all (few) result set rows are
        precached on client and server's resources are freed.
      */
      DBUG_RETURN(mysql_stmt_store_result(stmt));
    }
2965 2966 2967 2968 2969 2970
    else
    {
      stmt->mysql->unbuffered_fetch_owner= &stmt->unbuffered_fetch_cancelled;
      stmt->unbuffered_fetch_cancelled= FALSE;
      stmt->read_row_func= stmt_read_row_unbuffered;
    }
2971
  }
unknown's avatar
SCRUM  
unknown committed
2972 2973 2974
  DBUG_RETURN(0);
}

2975

2976 2977 2978 2979
/*
  Return total parameters count in the statement
*/

2980
ulong STDCALL mysql_stmt_param_count(MYSQL_STMT * stmt)
2981
{
2982
  DBUG_ENTER("mysql_stmt_param_count");
2983 2984 2985
  DBUG_RETURN(stmt->param_count);
}

2986 2987 2988 2989 2990 2991
/*
  Return total affected rows from the last statement
*/

my_ulonglong STDCALL mysql_stmt_affected_rows(MYSQL_STMT *stmt)
{
2992
  return stmt->affected_rows;
2993
}
2994

unknown's avatar
unknown committed
2995

unknown's avatar
unknown committed
2996 2997 2998 2999 3000 3001 3002 3003 3004 3005
/*
  Returns the number of result columns for the most recent query
  run on this statement.
*/

unsigned int STDCALL mysql_stmt_field_count(MYSQL_STMT *stmt)
{
  return stmt->field_count;
}

3006
/*
3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019
  Return last inserted id for auto_increment columns.

  SYNOPSIS
    mysql_stmt_insert_id()
    stmt    statement handle

  DESCRIPTION
    Current implementation of this call has a caveat: stmt->insert_id is
    unconditionally updated from mysql->insert_id in the end of each
    mysql_stmt_execute(). This works OK if mysql->insert_id contains new
    value (sent in reply to mysql_stmt_execute()), otherwise stmt->insert_id
    value gets undefined, as it's updated from some arbitrary value saved in
    connection structure during some other call.
3020 3021 3022 3023 3024 3025 3026
*/

my_ulonglong STDCALL mysql_stmt_insert_id(MYSQL_STMT *stmt)
{
  return stmt->insert_id;
}

3027

unknown's avatar
unknown committed
3028 3029 3030
static my_bool int_is_null_true= 1;		/* Used for MYSQL_TYPE_NULL */
static my_bool int_is_null_false= 0;

3031

3032
/*
3033
  Set up input data buffers for a statement.
3034 3035 3036 3037 3038

  SYNOPSIS
    mysql_stmt_bind_param()
    stmt    statement handle
            The statement must be prepared with mysql_stmt_prepare().
3039
    my_bind Array of mysql_stmt_param_count() bind parameters.
3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054
            This function doesn't check that size of this argument
            is >= mysql_stmt_field_count(): it's user's responsibility.

  DESCRIPTION
    Use this call after mysql_stmt_prepare() to bind user variables to
    placeholders.
    Each element of bind array stands for a placeholder. Placeholders
    are counted from 0.  For example statement
    'INSERT INTO t (a, b) VALUES (?, ?)'
    contains two placeholders, and for such statement you should supply
    bind array of two elements (MYSQL_BIND bind[2]).

    By properly initializing bind array you can bind virtually any
    C language type to statement's placeholders:
    First, it's strongly recommended to always zero-initialize entire
unknown's avatar
unknown committed
3055
    bind structure before setting its members. This will both shorten
3056 3057
    your application code and make it robust to future extensions of
    MYSQL_BIND structure.
3058
    Then you need to assign typecode of your application buffer to
3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113
    MYSQL_BIND::buffer_type. The following typecodes with their
    correspondence to C language types are supported:
    MYSQL_TYPE_TINY       for 8-bit integer variables. Normally it's
                          'signed char' and 'unsigned char';
    MYSQL_TYPE_SHORT      for 16-bit signed and unsigned variables. This
                          is usually 'short' and 'unsigned short';
    MYSQL_TYPE_LONG       for 32-bit signed and unsigned variables. It
                          corresponds to 'int' and 'unsigned int' on
                          vast majority of platforms. On IA-32 and some
                          other 32-bit systems you can also use 'long'
                          here;
    MYSQL_TYPE_LONGLONG   64-bit signed or unsigned integer.  Stands for
                          '[unsigned] long long' on most platforms;
    MYSQL_TYPE_FLOAT      32-bit floating point type, 'float' on most
                          systems;
    MYSQL_TYPE_DOUBLE     64-bit floating point type, 'double' on most
                          systems;
    MYSQL_TYPE_TIME       broken-down time stored in MYSQL_TIME
                          structure
    MYSQL_TYPE_DATE       date stored in MYSQL_TIME structure
    MYSQL_TYPE_DATETIME   datetime stored in MYSQL_TIME structure See
                          more on how to use these types for sending
                          dates and times below;
    MYSQL_TYPE_STRING     character string, assumed to be in
                          character-set-client. If character set of
                          client is not equal to character set of
                          column, value for this placeholder will be
                          converted to destination character set before
                          insert.
    MYSQL_TYPE_BLOB       sequence of bytes. This sequence is assumed to
                          be in binary character set (which is the same
                          as no particular character set), and is never
                          converted to any other character set. See also
                          notes about supplying string/blob length
                          below.
    MYSQL_TYPE_NULL       special typecode for binding nulls.
    These C/C++ types are not supported yet by the API: long double,
    bool.

    As you can see from the list above, it's responsibility of
    application programmer to ensure that chosen typecode properly
    corresponds to host language type. For example on all platforms
    where we build MySQL packages (as of MySQL 4.1.4) int is a 32-bit
    type. So for int you can always assume that proper typecode is
    MYSQL_TYPE_LONG (however queer it sounds, the name is legacy of the
    old MySQL API). In contrary sizeof(long) can be 4 or 8 8-bit bytes,
    depending on platform.

    TODO: provide client typedefs for each integer and floating point
    typecode, i. e. int8, uint8, float32, etc.

    Once typecode was set, it's necessary to assign MYSQL_BIND::buffer
    to point to the buffer of given type. Finally, additional actions
    may be taken for some types or use cases:

3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173
    Binding integer types.
      For integer types you might also need to set MYSQL_BIND::is_unsigned
      member. Set it to TRUE when binding unsigned char, unsigned short,
      unsigned int, unsigned long, unsigned long long.

    Binding floating point types.
      For floating point types you just need to set
      MYSQL_BIND::buffer_type and MYSQL_BIND::buffer. The rest of the
      members should be zero-initialized.

    Binding NULLs.
      You might have a column always NULL, never NULL, or sometimes
      NULL.  For an always NULL column set MYSQL_BIND::buffer_type to
      MYSQL_TYPE_NULL.  The rest of the members just need to be
      zero-initialized.  For never NULL columns set
      MYSQL_BIND::is_null to 0, or this has already been done if you
      zero-initialized the entire structure.  If you set
      MYSQL_TYPE::is_null to point to an application buffer of type
      'my_bool', then this buffer will be checked on each execution:
      this way you can set the buffer to TRUE, or any non-0 value for
      NULLs, and to FALSE or 0 for not NULL data.

    Binding text strings and sequences of bytes.
      For strings, in addition to MYSQL_BIND::buffer_type and
      MYSQL_BIND::buffer you need to set MYSQL_BIND::length or
      MYSQL_BIND::buffer_length.  If 'length' is set, 'buffer_length'
      is ignored. 'buffer_length' member should be used when size of
      string doesn't change between executions. If you want to vary
      buffer length for each value, set 'length' to point to an
      application buffer of type 'unsigned long' and set this long to
      length of the string before each mysql_stmt_execute().

    Binding dates and times.
      For binding dates and times prepared statements API provides
      clients with MYSQL_TIME structure. A pointer to instance of this
      structure should be assigned to MYSQL_BIND::buffer whenever
      MYSQL_TYPE_TIME, MYSQL_TYPE_DATE, MYSQL_TYPE_DATETIME typecodes
      are used.  When typecode is MYSQL_TYPE_TIME, only members
      'hour', 'minute', 'second' and 'neg' (is time offset negative)
      are used. These members only will be sent to the server.
      MYSQL_TYPE_DATE implies use of 'year', 'month', 'day', 'neg'.
      MYSQL_TYPE_DATETIME utilizes both parts of MYSQL_TIME structure.
      You don't have to set MYSQL_TIME::time_type member: it's not
      used when sending data to the server, typecode information is
      enough.  'second_part' member can hold microsecond precision of
      time value, but now it's only supported on protocol level: you
      can't store microsecond in a column, or use in temporal
      calculations. However, if you send a time value with microsecond
      part for 'SELECT ?', statement, you'll get it back unchanged
      from the server.

    Data conversion.
      If conversion from host language type to data representation,
      corresponding to SQL type, is required it's done on the server.
      Data truncation is possible when conversion is lossy. For
      example, if you supply MYSQL_TYPE_DATETIME value out of valid
      SQL type TIMESTAMP range, the same conversion will be applied as
      if this value would have been sent as string in the old
      protocol.  TODO: document how the server will behave in case of
      truncation/data loss.
3174 3175 3176 3177 3178

    After variables were bound, you can repeatedly set/change their
    values and mysql_stmt_execute() the statement.

    See also: mysql_stmt_send_long_data() for sending long text/blob
3179
    data in pieces, examples in tests/mysql_client_test.c.
3180 3181 3182 3183 3184 3185 3186 3187 3188 3189
    Next steps you might want to make:
    - execute statement with mysql_stmt_execute(),
    - reset statement using mysql_stmt_reset() or reprepare it with
      another query using mysql_stmt_prepare()
    - close statement with mysql_stmt_close().

  IMPLEMENTATION
    The function copies given bind array to internal storage of the
    statement, and sets up typecode-specific handlers to perform
    serialization of bound data. This means that although you don't need
3190 3191
    to call this routine after each assignment to bind buffers, you
    need to call it each time you change parameter typecodes, or other
3192 3193 3194
    members of MYSQL_BIND array.
    This is a pure local call. Data types of client buffers are sent
    along with buffers' data at first execution of the statement.
3195 3196 3197 3198

  RETURN
    0  success
    1  error, can be retrieved with mysql_stmt_error.
3199 3200
*/

3201
my_bool STDCALL mysql_stmt_bind_param(MYSQL_STMT *stmt, MYSQL_BIND *my_bind)
3202
{
3203 3204
  uint count=0;
  MYSQL_BIND *param, *end;
3205
  DBUG_ENTER("mysql_stmt_bind_param");
3206

3207 3208 3209 3210 3211 3212 3213 3214 3215 3216
  if (!stmt->param_count)
  {
    if ((int) stmt->state < (int) MYSQL_STMT_PREPARE_DONE)
    {
      set_stmt_error(stmt, CR_NO_PREPARE_STMT, unknown_sqlstate);
      DBUG_RETURN(1);
    }
    DBUG_RETURN(0);
  }

3217
  /* Allocated on prepare */
3218
  memcpy((char*) stmt->params, (char*) my_bind,
3219 3220 3221 3222 3223
	 sizeof(MYSQL_BIND) * stmt->param_count);

  for (param= stmt->params, end= param+stmt->param_count;
       param < end ;
       param++)
3224
  {
3225
    param->param_number= count++;
3226 3227
    param->long_data_used= 0;

unknown's avatar
unknown committed
3228 3229 3230 3231
    /* If param->is_null is not set, then the value can never be NULL */
    if (!param->is_null)
      param->is_null= &int_is_null_false;

3232 3233
    /* Setup data copy functions for the different supported types */
    switch (param->buffer_type) {
unknown's avatar
unknown committed
3234
    case MYSQL_TYPE_NULL:
unknown's avatar
unknown committed
3235
      param->is_null= &int_is_null_true;
unknown's avatar
unknown committed
3236
      break;
3237
    case MYSQL_TYPE_TINY:
unknown's avatar
unknown committed
3238
      /* Force param->length as this is fixed for this type */
3239 3240
      param->length= &param->buffer_length;
      param->buffer_length= 1;
3241 3242 3243
      param->store_param_func= store_param_tinyint;
      break;
    case MYSQL_TYPE_SHORT:
3244 3245
      param->length= &param->buffer_length;
      param->buffer_length= 2;
3246 3247 3248
      param->store_param_func= store_param_short;
      break;
    case MYSQL_TYPE_LONG:
3249 3250
      param->length= &param->buffer_length;
      param->buffer_length= 4;
3251 3252 3253
      param->store_param_func= store_param_int32;
      break;
    case MYSQL_TYPE_LONGLONG:
3254 3255
      param->length= &param->buffer_length;
      param->buffer_length= 8;
3256 3257 3258
      param->store_param_func= store_param_int64;
      break;
    case MYSQL_TYPE_FLOAT:
3259 3260
      param->length= &param->buffer_length;
      param->buffer_length= 4;
3261 3262 3263
      param->store_param_func= store_param_float;
      break;
    case MYSQL_TYPE_DOUBLE:
3264 3265
      param->length= &param->buffer_length;
      param->buffer_length= 8;
3266 3267
      param->store_param_func= store_param_double;
      break;
unknown's avatar
unknown committed
3268 3269
    case MYSQL_TYPE_TIME:
      param->store_param_func= store_param_time;
3270
      param->buffer_length= MAX_TIME_REP_LENGTH;
unknown's avatar
unknown committed
3271 3272 3273
      break;
    case MYSQL_TYPE_DATE:
      param->store_param_func= store_param_date;
3274
      param->buffer_length= MAX_DATE_REP_LENGTH;
unknown's avatar
unknown committed
3275 3276 3277 3278
      break;
    case MYSQL_TYPE_DATETIME:
    case MYSQL_TYPE_TIMESTAMP:
      param->store_param_func= store_param_datetime;
3279
      param->buffer_length= MAX_DATETIME_REP_LENGTH;
unknown's avatar
unknown committed
3280
      break;
3281 3282 3283
    case MYSQL_TYPE_TINY_BLOB:
    case MYSQL_TYPE_MEDIUM_BLOB:
    case MYSQL_TYPE_LONG_BLOB:
unknown's avatar
unknown committed
3284
    case MYSQL_TYPE_BLOB:
3285
    case MYSQL_TYPE_VARCHAR:
3286 3287
    case MYSQL_TYPE_VAR_STRING:
    case MYSQL_TYPE_STRING:
unknown's avatar
unknown committed
3288 3289
    case MYSQL_TYPE_DECIMAL:
    case MYSQL_TYPE_NEWDECIMAL:
3290
      param->store_param_func= store_param_str;
3291
      /*
3292 3293
        For variable length types user must set either length or
        buffer_length.
3294
      */
3295 3296
      break;
    default:
3297
      strmov(stmt->sqlstate, unknown_sqlstate);
unknown's avatar
unknown committed
3298 3299
      sprintf(stmt->last_error,
	      ER(stmt->last_errno= CR_UNSUPPORTED_PARAM_TYPE),
3300
	      param->buffer_type, count);
3301
      DBUG_RETURN(1);
3302
    }
3303 3304 3305 3306 3307 3308
    /*
      If param->length is not given, change it to point to buffer_length.
      This way we can always use *param->length to get the length of data
    */
    if (!param->length)
      param->length= &param->buffer_length;
3309
  }
3310
  /* We have to send/resend type information to MySQL */
3311 3312
  stmt->send_types_to_server= TRUE;
  stmt->bind_param_done= TRUE;
3313 3314 3315
  DBUG_RETURN(0);
}

3316

3317 3318 3319 3320 3321
/********************************************************************
 Long data implementation
*********************************************************************/

/*
3322 3323 3324
  Send long data in pieces to the server

  SYNOPSIS
3325
    mysql_stmt_send_long_data()
3326 3327 3328 3329
    stmt			Statement handler
    param_number		Parameter number (0 - N-1)
    data			Data to send to server
    length			Length of data to send (may be 0)
unknown's avatar
unknown committed
3330

3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354
  DESCRIPTION
    This call can be used repeatedly to send long data in pieces
    for any string/binary placeholder. Data supplied for
    a placeholder is saved at server side till execute, and then
    used instead of value from MYSQL_BIND object. More precisely,
    if long data for a parameter was supplied, MYSQL_BIND object
    corresponding to this parameter is not sent to server. In the
    end of execution long data states of placeholders are reset,
    so next time values of such placeholders will be taken again
    from MYSQL_BIND array.
    The server does not reply to this call: if there was an error
    in data handling (which now only can happen if server run out
    of memory) it would be returned in reply to
    mysql_stmt_execute().
    You should choose type of long data carefully if you care
    about character set conversions performed by server when the
    statement is executed.  No conversion is performed at all for
    MYSQL_TYPE_BLOB and other binary typecodes. For
    MYSQL_TYPE_STRING and the rest of text placeholders data is
    converted from client character set to character set of
    connection. If these character sets are different, this
    conversion may require additional memory at server, equal to
    total size of supplied pieces.

3355
  RETURN VALUES
unknown's avatar
unknown committed
3356 3357
    0	ok
    1	error
3358 3359
*/

3360
my_bool STDCALL
3361
mysql_stmt_send_long_data(MYSQL_STMT *stmt, uint param_number,
unknown's avatar
unknown committed
3362
		     const char *data, ulong length)
3363 3364
{
  MYSQL_BIND *param;
3365
  DBUG_ENTER("mysql_stmt_send_long_data");
3366
  DBUG_ASSERT(stmt != 0);
unknown's avatar
unknown committed
3367 3368
  DBUG_PRINT("enter",("param no: %d  data: 0x%lx, length : %ld",
		      param_number, (long) data, length));
3369

3370 3371 3372 3373 3374 3375 3376 3377 3378
  /*
    We only need to check for stmt->param_count, if it's not null
    prepare was done.
  */
  if (param_number >= stmt->param_count)
  {
    set_stmt_error(stmt, CR_INVALID_PARAMETER_NO, unknown_sqlstate);
    DBUG_RETURN(1);
  }
3379

3380
  param= stmt->params+param_number;
3381
  if (!IS_LONGDATA(param->buffer_type))
unknown's avatar
unknown committed
3382
  {
3383
    /* Long data handling should be used only for string/binary types */
3384
    strmov(stmt->sqlstate, unknown_sqlstate);
unknown's avatar
unknown committed
3385 3386 3387 3388
    sprintf(stmt->last_error, ER(stmt->last_errno= CR_INVALID_BUFFER_USE),
	    param->param_number);
    DBUG_RETURN(1);
  }
3389

3390
  /*
3391 3392 3393
    Send long data packet if there is data or we're sending long data
    for the first time.
  */
3394
  if (length || param->long_data_used == 0)
3395
  {
3396
    MYSQL *mysql= stmt->mysql;
3397
    /* Packet header: stmt id (4 bytes), param no (2 bytes) */
3398
    uchar buff[MYSQL_LONG_DATA_HEADER];
3399

3400 3401
    int4store(buff, stmt->stmt_id);
    int2store(buff + 4, param_number);
3402 3403
    param->long_data_used= 1;

3404 3405 3406 3407
    /*
      Note that we don't get any ok packet from the server in this case
      This is intentional to save bandwidth.
    */
3408
    if ((*mysql->methods->advanced_command)(mysql, COM_STMT_SEND_LONG_DATA,
3409
                                            buff, sizeof(buff), (uchar*) data,
3410
                                            length, 1, NULL))
3411
    {
3412 3413
      set_stmt_errmsg(stmt, mysql->net.last_error,
		      mysql->net.last_errno, mysql->net.sqlstate);
3414 3415 3416 3417 3418 3419
      DBUG_RETURN(1);
    }
  }
  DBUG_RETURN(0);
}

3420

3421
/********************************************************************
3422
 Fetch and conversion of result set rows (binary protocol).
3423 3424
*********************************************************************/

3425 3426 3427 3428 3429 3430 3431 3432
/*
  Read date, (time, datetime) value from network buffer and store it
  in MYSQL_TIME structure.

  SYNOPSIS
    read_binary_{date,time,datetime}()
    tm    MYSQL_TIME structure to fill
    pos   pointer to current position in network buffer.
unknown's avatar
unknown committed
3433 3434
          These functions increase pos to point to the beginning of the
          next column.
3435 3436 3437 3438 3439 3440

  Auxiliary functions to read time (date, datetime) values from network
  buffer and store in MYSQL_TIME structure. Jointly used by conversion
  and no-conversion fetching.
*/

unknown's avatar
unknown committed
3441
static void read_binary_time(MYSQL_TIME *tm, uchar **pos)
unknown's avatar
unknown committed
3442
{
3443
  /* net_field_length will set pos to the first byte of data */
unknown's avatar
unknown committed
3444 3445 3446
  uint length= net_field_length(pos);

  if (length)
unknown's avatar
unknown committed
3447 3448 3449
  {
    uchar *to= *pos;
    tm->neg= (bool) to[0];
unknown's avatar
unknown committed
3450

unknown's avatar
unknown committed
3451 3452 3453 3454 3455 3456
    tm->day=    (ulong) sint4korr(to+1);
    tm->hour=   (uint) to[5];
    tm->minute= (uint) to[6];
    tm->second= (uint) to[7];
    tm->second_part= (length > 8) ? (ulong) sint4korr(to+8) : 0;
    tm->year= tm->month= 0;
3457 3458 3459 3460 3461 3462
    if (tm->day)
    {
      /* Convert days to hours at once */
      tm->hour+= tm->day*24;
      tm->day= 0;
    }
3463 3464
    tm->time_type= MYSQL_TIMESTAMP_TIME;

unknown's avatar
unknown committed
3465
    *pos+= length;
unknown's avatar
unknown committed
3466
  }
unknown's avatar
unknown committed
3467
  else
3468
    set_zero_time(tm, MYSQL_TIMESTAMP_TIME);
unknown's avatar
unknown committed
3469 3470
}

unknown's avatar
unknown committed
3471
static void read_binary_datetime(MYSQL_TIME *tm, uchar **pos)
unknown's avatar
unknown committed
3472
{
unknown's avatar
unknown committed
3473
  uint length= net_field_length(pos);
3474

unknown's avatar
unknown committed
3475
  if (length)
unknown's avatar
unknown committed
3476 3477
  {
    uchar *to= *pos;
3478

unknown's avatar
unknown committed
3479 3480 3481 3482
    tm->neg=    0;
    tm->year=   (uint) sint2korr(to);
    tm->month=  (uint) to[2];
    tm->day=    (uint) to[3];
3483

unknown's avatar
unknown committed
3484 3485 3486 3487 3488 3489 3490 3491 3492
    if (length > 4)
    {
      tm->hour=   (uint) to[4];
      tm->minute= (uint) to[5];
      tm->second= (uint) to[6];
    }
    else
      tm->hour= tm->minute= tm->second= 0;
    tm->second_part= (length > 7) ? (ulong) sint4korr(to+7) : 0;
3493
    tm->time_type= MYSQL_TIMESTAMP_DATETIME;
unknown's avatar
unknown committed
3494 3495

    *pos+= length;
unknown's avatar
unknown committed
3496
  }
unknown's avatar
unknown committed
3497
  else
3498
    set_zero_time(tm, MYSQL_TIMESTAMP_DATETIME);
unknown's avatar
unknown committed
3499 3500
}

unknown's avatar
unknown committed
3501
static void read_binary_date(MYSQL_TIME *tm, uchar **pos)
unknown's avatar
unknown committed
3502
{
unknown's avatar
unknown committed
3503
  uint length= net_field_length(pos);
3504

unknown's avatar
unknown committed
3505
  if (length)
unknown's avatar
unknown committed
3506 3507 3508 3509 3510
  {
    uchar *to= *pos;
    tm->year =  (uint) sint2korr(to);
    tm->month=  (uint) to[2];
    tm->day= (uint) to[3];
unknown's avatar
unknown committed
3511

unknown's avatar
unknown committed
3512 3513 3514
    tm->hour= tm->minute= tm->second= 0;
    tm->second_part= 0;
    tm->neg= 0;
3515
    tm->time_type= MYSQL_TIMESTAMP_DATE;
unknown's avatar
unknown committed
3516 3517

    *pos+= length;
unknown's avatar
unknown committed
3518
  }
unknown's avatar
unknown committed
3519
  else
3520
    set_zero_time(tm, MYSQL_TIMESTAMP_DATE);
3521 3522
}

3523

unknown's avatar
unknown committed
3524 3525 3526 3527 3528 3529 3530 3531 3532
/*
  Convert string to supplied buffer of any type.

  SYNOPSIS
    fetch_string_with_conversion()
    param   output buffer descriptor
    value   column data
    length  data length
*/
3533

unknown's avatar
unknown committed
3534 3535
static void fetch_string_with_conversion(MYSQL_BIND *param, char *value,
                                         uint length)
3536
{
3537
  char *buffer= (char *)param->buffer;
unknown's avatar
unknown committed
3538
  int err= 0;
3539
  char *endptr= value + length;
3540

unknown's avatar
unknown committed
3541 3542 3543 3544
  /*
    This function should support all target buffer types: the rest
    of conversion functions can delegate conversion to it.
  */
3545
  switch (param->buffer_type) {
unknown's avatar
unknown committed
3546 3547
  case MYSQL_TYPE_NULL: /* do nothing */
    break;
3548
  case MYSQL_TYPE_TINY:
unknown's avatar
unknown committed
3549
  {
3550
    longlong data= my_strtoll10(value, &endptr, &err);
3551
    *param->error= (IS_TRUNCATED(data, param->is_unsigned,
3552
                                 INT_MIN8, INT_MAX8, UINT_MAX8) || err > 0);
3553
    *buffer= (uchar) data;
3554
    break;
unknown's avatar
unknown committed
3555
  }
3556
  case MYSQL_TYPE_SHORT:
unknown's avatar
unknown committed
3557
  {
3558
    longlong data= my_strtoll10(value, &endptr, &err);
3559
    *param->error= (IS_TRUNCATED(data, param->is_unsigned,
3560
                                 INT_MIN16, INT_MAX16, UINT_MAX16) || err > 0);
3561
    shortstore(buffer, (short) data);
3562
    break;
unknown's avatar
unknown committed
3563
  }
3564
  case MYSQL_TYPE_LONG:
unknown's avatar
unknown committed
3565
  {
3566
    longlong data= my_strtoll10(value, &endptr, &err);
3567
    *param->error= (IS_TRUNCATED(data, param->is_unsigned,
3568
                                 INT_MIN32, INT_MAX32, UINT_MAX32) || err > 0);
3569
    longstore(buffer, (int32) data);
3570
    break;
unknown's avatar
unknown committed
3571
  }
3572
  case MYSQL_TYPE_LONGLONG:
unknown's avatar
unknown committed
3573
  {
3574 3575 3576
    longlong data= my_strtoll10(value, &endptr, &err);
    *param->error= param->is_unsigned ? err != 0 :
                                       (err > 0 || (err == 0 && data < 0));
unknown's avatar
unknown committed
3577
    longlongstore(buffer, data);
3578
    break;
unknown's avatar
unknown committed
3579
  }
3580
  case MYSQL_TYPE_FLOAT:
3581
  {
3582 3583 3584 3585
    double data= my_strntod(&my_charset_latin1, value, length, &endptr, &err);
    float fdata= (float) data;
    *param->error= (fdata != data) | test(err);
    floatstore(buffer, fdata);
3586 3587
    break;
  }
3588
  case MYSQL_TYPE_DOUBLE:
3589
  {
3590 3591
    double data= my_strntod(&my_charset_latin1, value, length, &endptr, &err);
    *param->error= test(err);
3592
    doublestore(buffer, data);
3593 3594
    break;
  }
unknown's avatar
unknown committed
3595 3596 3597 3598
  case MYSQL_TYPE_TIME:
  {
    MYSQL_TIME *tm= (MYSQL_TIME *)buffer;
    str_to_time(value, length, tm, &err);
3599
    *param->error= test(err);
unknown's avatar
unknown committed
3600 3601 3602 3603
    break;
  }
  case MYSQL_TYPE_DATE:
  case MYSQL_TYPE_DATETIME:
3604
  case MYSQL_TYPE_TIMESTAMP:
unknown's avatar
unknown committed
3605 3606
  {
    MYSQL_TIME *tm= (MYSQL_TIME *)buffer;
3607
    (void) str_to_datetime(value, length, tm, TIME_FUZZY_DATE, &err);
3608 3609
    *param->error= test(err) && (param->buffer_type == MYSQL_TYPE_DATE &&
                                 tm->time_type != MYSQL_TIMESTAMP_DATE);
unknown's avatar
unknown committed
3610 3611 3612 3613 3614 3615
    break;
  }
  case MYSQL_TYPE_TINY_BLOB:
  case MYSQL_TYPE_MEDIUM_BLOB:
  case MYSQL_TYPE_LONG_BLOB:
  case MYSQL_TYPE_BLOB:
unknown's avatar
unknown committed
3616 3617
  case MYSQL_TYPE_DECIMAL:
  case MYSQL_TYPE_NEWDECIMAL:
3618
  default:
3619
  {
unknown's avatar
unknown committed
3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633
    /*
      Copy column data to the buffer taking into account offset,
      data length and buffer length.
    */
    char *start= value + param->offset;
    char *end= value + length;
    ulong copy_length;
    if (start < end)
    {
      copy_length= end - start;
      /* We've got some data beyond offset: copy up to buffer_length bytes */
      if (param->buffer_length)
        memcpy(buffer, start, min(copy_length, param->buffer_length));
    }
unknown's avatar
unknown committed
3634
    else
unknown's avatar
unknown committed
3635 3636 3637
      copy_length= 0;
    if (copy_length < param->buffer_length)
      buffer[copy_length]= '\0';
3638
    *param->error= copy_length > param->buffer_length;
unknown's avatar
unknown committed
3639 3640 3641 3642
    /*
      param->length will always contain length of entire column;
      number of copied bytes may be way different:
    */
3643
    *param->length= length;
unknown's avatar
unknown committed
3644
    break;
3645
  }
3646
  }
3647 3648
}

3649

unknown's avatar
unknown committed
3650 3651
/*
  Convert integer value to client buffer of any type.
3652

unknown's avatar
unknown committed
3653 3654 3655 3656 3657 3658
  SYNOPSIS
    fetch_long_with_conversion()
    param   output buffer descriptor
    field   column metadata
    value   column data
*/
3659

unknown's avatar
unknown committed
3660
static void fetch_long_with_conversion(MYSQL_BIND *param, MYSQL_FIELD *field,
3661
                                       longlong value, my_bool is_unsigned)
3662
{
3663
  char *buffer= (char *)param->buffer;
3664

unknown's avatar
unknown committed
3665
  switch (param->buffer_type) {
unknown's avatar
unknown committed
3666 3667
  case MYSQL_TYPE_NULL: /* do nothing */
    break;
3668
  case MYSQL_TYPE_TINY:
3669
    *param->error= IS_TRUNCATED(value, param->is_unsigned,
3670
                                INT_MIN8, INT_MAX8, UINT_MAX8);
unknown's avatar
unknown committed
3671
    *(uchar *)param->buffer= (uchar) value;
3672 3673
    break;
  case MYSQL_TYPE_SHORT:
3674
    *param->error= IS_TRUNCATED(value, param->is_unsigned,
3675
                                INT_MIN16, INT_MAX16, UINT_MAX16);
3676
    shortstore(buffer, (short) value);
3677 3678
    break;
  case MYSQL_TYPE_LONG:
3679
    *param->error= IS_TRUNCATED(value, param->is_unsigned,
3680
                                INT_MIN32, INT_MAX32, UINT_MAX32);
3681
    longstore(buffer, (int32) value);
3682 3683
    break;
  case MYSQL_TYPE_LONGLONG:
unknown's avatar
unknown committed
3684
    longlongstore(buffer, value);
3685
    *param->error= param->is_unsigned != is_unsigned && value < 0;
3686 3687
    break;
  case MYSQL_TYPE_FLOAT:
unknown's avatar
unknown committed
3688
  {
3689
    /*
3690
      We need to mark the local variable volatile to
3691 3692 3693
      workaround Intel FPU executive precision feature.
      (See http://gcc.gnu.org/bugzilla/show_bug.cgi?id=323 for details)
    */
3694
    volatile float data;
3695
    if (is_unsigned)
3696
    {
3697
      data= (float) ulonglong2double(value);
3698 3699
      *param->error= ((ulonglong) value) != ((ulonglong) data);
    }
3700
    else
3701 3702 3703 3704
    {
      data= (float)value;
      *param->error= value != ((longlong) data);
    }
3705
    floatstore(buffer, data);
unknown's avatar
unknown committed
3706 3707
    break;
  }
3708
  case MYSQL_TYPE_DOUBLE:
unknown's avatar
unknown committed
3709
  {
3710
    volatile double data;
3711
    if (is_unsigned)
3712
    {
3713
      data= ulonglong2double(value);
3714 3715
      *param->error= ((ulonglong) value) != ((ulonglong) data);
    }
3716
    else
3717
    {
3718
      data= (double)value;
3719 3720
      *param->error= value != ((longlong) data);
    }
unknown's avatar
unknown committed
3721
    doublestore(buffer, data);
unknown's avatar
unknown committed
3722 3723
    break;
  }
3724 3725 3726 3727 3728 3729
  case MYSQL_TYPE_TIME:
  case MYSQL_TYPE_DATE:
  case MYSQL_TYPE_TIMESTAMP:
  case MYSQL_TYPE_DATETIME:
  {
    int error;
3730 3731
    value= number_to_datetime(value, (MYSQL_TIME *) buffer, TIME_FUZZY_DATE,
                              &error);
3732 3733 3734
    *param->error= test(error);
    break;
  }
3735
  default:
unknown's avatar
unknown committed
3736
  {
3737 3738 3739
    uchar buff[22];                              /* Enough for longlong */
    uchar *end= (uchar*) longlong10_to_str(value, (char*) buff,
                                           is_unsigned ? 10: -10);
unknown's avatar
unknown committed
3740
    /* Resort to string conversion which supports all typecodes */
3741 3742 3743 3744 3745
    uint length= (uint) (end-buff);

    if (field->flags & ZEROFILL_FLAG && length < field->length &&
        field->length < 21)
    {
3746 3747
      bmove_upp(buff+field->length,buff+length, length);
      bfill(buff, field->length - length,'0');
3748 3749
      length= field->length;
    }
3750
    fetch_string_with_conversion(param, (char*) buff, length);
unknown's avatar
unknown committed
3751
    break;
unknown's avatar
unknown committed
3752
  }
3753
  }
3754 3755
}

unknown's avatar
unknown committed
3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766
/*
  Convert double/float column to supplied buffer of any type.

  SYNOPSIS
    fetch_float_with_conversion()
    param   output buffer descriptor
    field   column metadata
    value   column data
    width   default number of significant digits used when converting
            float/double to string
*/
unknown's avatar
unknown committed
3767

unknown's avatar
unknown committed
3768 3769
static void fetch_float_with_conversion(MYSQL_BIND *param, MYSQL_FIELD *field,
                                        double value, int width)
3770
{
3771
  char *buffer= (char *)param->buffer;
3772
  double val64 = (value < 0 ? -floor(-value) : floor(value));
3773

unknown's avatar
unknown committed
3774
  switch (param->buffer_type) {
unknown's avatar
unknown committed
3775 3776
  case MYSQL_TYPE_NULL: /* do nothing */
    break;
3777
  case MYSQL_TYPE_TINY:
3778 3779 3780 3781 3782 3783
    /*
      We need to _store_ data in the buffer before the truncation check to
      workaround Intel FPU executive precision feature.
      (See http://gcc.gnu.org/bugzilla/show_bug.cgi?id=323 for details)
      Sic: AFAIU it does not guarantee to work.
    */
3784
    if (param->is_unsigned)
3785
      *buffer= (uint8) value;
3786
    else
3787
      *buffer= (int8) value;
3788 3789
    *param->error= val64 != (param->is_unsigned ? (double)((uint8) *buffer) :
                                                  (double)((int8) *buffer));
3790 3791
    break;
  case MYSQL_TYPE_SHORT:
3792 3793 3794 3795 3796 3797 3798 3799 3800 3801
    if (param->is_unsigned)
    {
      ushort data= (ushort) value;
      shortstore(buffer, data);
    }
    else
    {
      short data= (short) value;
      shortstore(buffer, data);
    }
3802
    *param->error= val64 != (param->is_unsigned ? (double) (*(ushort*) buffer):
3803
                                                  (double) (*(short*) buffer));
3804 3805
    break;
  case MYSQL_TYPE_LONG:
3806 3807 3808 3809 3810 3811 3812 3813 3814 3815
    if (param->is_unsigned)
    {
      uint32 data= (uint32) value;
      longstore(buffer, data);
    }
    else
    {
      int32 data= (int32) value;
      longstore(buffer, data);
    }
3816
    *param->error= val64 != (param->is_unsigned ? (double) (*(uint32*) buffer):
3817 3818
                                                  (double) (*(int32*) buffer));
      break;
3819
  case MYSQL_TYPE_LONGLONG:
3820 3821 3822 3823 3824 3825 3826 3827 3828 3829
    if (param->is_unsigned)
    {
      ulonglong data= (ulonglong) value;
      longlongstore(buffer, data);
    }
    else
    {
      longlong data= (longlong) value;
      longlongstore(buffer, data);
    }
3830
    *param->error= val64 != (param->is_unsigned ?
unknown's avatar
unknown committed
3831
                             ulonglong2double(*(ulonglong*) buffer) :
3832
                             (double) (*(longlong*) buffer));
3833 3834 3835
    break;
  case MYSQL_TYPE_FLOAT:
  {
unknown's avatar
unknown committed
3836
    float data= (float) value;
3837
    floatstore(buffer, data);
3838
    *param->error= (*(float*) buffer) != value;
3839 3840 3841 3842
    break;
  }
  case MYSQL_TYPE_DOUBLE:
  {
unknown's avatar
unknown committed
3843
    doublestore(buffer, value);
3844 3845
    break;
  }
3846
  default:
3847
  {
unknown's avatar
unknown committed
3848 3849 3850 3851 3852
    /*
      Resort to fetch_string_with_conversion: this should handle
      floating point -> string conversion nicely, honor all typecodes
      and param->offset possibly set in mysql_stmt_fetch_column
    */
3853
    char buff[MAX_DOUBLE_STRING_REP_LENGTH];
unknown's avatar
unknown committed
3854 3855 3856
    char *end;
    /* TODO: move this to a header shared between client and server. */
#define NOT_FIXED_DEC  31
unknown's avatar
unknown committed
3857
    if (field->decimals >= NOT_FIXED_DEC)
unknown's avatar
unknown committed
3858 3859
#undef NOT_FIXED_DEC
    {
3860 3861 3862 3863 3864 3865 3866 3867
      /*
        The 14 below is to ensure that the server and client has the same
        precisions. This will ensure that on the same machine you get the
        same value as a string independent of the protocol you use.
      */
      sprintf(buff, "%-*.*g", (int) min(sizeof(buff)-1,
                                        param->buffer_length),
	      min(14,width), value);
unknown's avatar
unknown committed
3868 3869 3870
      end= strcend(buff, ' ');
      *end= 0;
    }
unknown's avatar
unknown committed
3871
    else
unknown's avatar
unknown committed
3872
    {
unknown's avatar
unknown committed
3873
      sprintf(buff, "%.*f", (int) field->decimals, value);
unknown's avatar
unknown committed
3874 3875
      end= strend(buff);
    }
3876

3877
    {
3878 3879 3880 3881 3882 3883 3884 3885 3886
      size_t length= end - buff;
      if (field->flags & ZEROFILL_FLAG && length < field->length &&
          field->length < MAX_DOUBLE_STRING_REP_LENGTH - 1)
      {
        bmove_upp((char*) buff + field->length, buff + length, length);
        bfill((char*) buff, field->length - length, '0');
        length= field->length;
      }
      fetch_string_with_conversion(param, buff, length);
3887
    }
3888

3889 3890
    break;
  }
unknown's avatar
unknown committed
3891
  }
3892 3893
}

unknown's avatar
unknown committed
3894

unknown's avatar
unknown committed
3895 3896 3897 3898 3899 3900 3901 3902 3903
/*
  Fetch time/date/datetime to supplied buffer of any type

  SYNOPSIS
    param   output buffer descriptor
    time    column data
*/

static void fetch_datetime_with_conversion(MYSQL_BIND *param,
3904
                                           MYSQL_FIELD *field,
3905
                                           MYSQL_TIME *my_time)
unknown's avatar
unknown committed
3906 3907
{
  switch (param->buffer_type) {
unknown's avatar
unknown committed
3908 3909
  case MYSQL_TYPE_NULL: /* do nothing */
    break;
unknown's avatar
unknown committed
3910
  case MYSQL_TYPE_DATE:
3911 3912
    *(MYSQL_TIME *)(param->buffer)= *my_time;
    *param->error= my_time->time_type != MYSQL_TIMESTAMP_DATE;
3913
    break;
unknown's avatar
unknown committed
3914
  case MYSQL_TYPE_TIME:
3915 3916
    *(MYSQL_TIME *)(param->buffer)= *my_time;
    *param->error= my_time->time_type != MYSQL_TIMESTAMP_TIME;
3917
    break;
unknown's avatar
unknown committed
3918 3919
  case MYSQL_TYPE_DATETIME:
  case MYSQL_TYPE_TIMESTAMP:
3920
    *(MYSQL_TIME *)(param->buffer)= *my_time;
3921
    /* No error: time and date are compatible with datetime */
3922
    break;
3923
  case MYSQL_TYPE_YEAR:
3924
    shortstore(param->buffer, my_time->year);
3925 3926 3927 3928 3929
    *param->error= 1;
    break;
  case MYSQL_TYPE_FLOAT:
  case MYSQL_TYPE_DOUBLE:
  {
3930
    ulonglong value= TIME_to_ulonglong(my_time);
3931 3932 3933
    fetch_float_with_conversion(param, field,
                                ulonglong2double(value), DBL_DIG);
    break;
3934 3935 3936 3937 3938 3939 3940
  }
  case MYSQL_TYPE_TINY:
  case MYSQL_TYPE_SHORT:
  case MYSQL_TYPE_INT24:
  case MYSQL_TYPE_LONG:
  case MYSQL_TYPE_LONGLONG:
  {
3941
    longlong value= (longlong) TIME_to_ulonglong(my_time);
3942
    fetch_long_with_conversion(param, field, value, TRUE);
3943
    break;
3944
  }
unknown's avatar
unknown committed
3945 3946
  default:
  {
unknown's avatar
unknown committed
3947 3948 3949 3950
    /*
      Convert time value  to string and delegate the rest to
      fetch_string_with_conversion:
    */
3951
    char buff[MAX_DATE_STRING_REP_LENGTH];
3952
    uint length= my_TIME_to_str(my_time, buff);
unknown's avatar
unknown committed
3953 3954 3955
    /* Resort to string conversion */
    fetch_string_with_conversion(param, (char *)buff, length);
    break;
unknown's avatar
unknown committed
3956 3957 3958
  }
  }
}
3959

unknown's avatar
unknown committed
3960

unknown's avatar
unknown committed
3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975
/*
  Fetch and convert result set column to output buffer.

  SYNOPSIS
    fetch_result_with_conversion()
    param   output buffer descriptor
    field   column metadata
    row     points to a column of result set tuple in binary format

  DESCRIPTION
    This is a fallback implementation of column fetch used
    if column and output buffer types do not match.
    Increases tuple pointer to point at the next column within the
    tuple.
*/
3976

unknown's avatar
unknown committed
3977 3978
static void fetch_result_with_conversion(MYSQL_BIND *param, MYSQL_FIELD *field,
                                         uchar **row)
3979
{
unknown's avatar
unknown committed
3980
  enum enum_field_types field_type= field->type;
unknown's avatar
unknown committed
3981
  uint field_is_unsigned= field->flags & UNSIGNED_FLAG;
unknown's avatar
unknown committed
3982

3983 3984 3985
  switch (field_type) {
  case MYSQL_TYPE_TINY:
  {
3986 3987 3988 3989
    uchar value= **row;
    /* sic: we need to cast to 'signed char' as 'char' may be unsigned */
    longlong data= field_is_unsigned ? (longlong) value :
                                       (longlong) (signed char) value;
3990
    fetch_long_with_conversion(param, field, data, 0);
unknown's avatar
unknown committed
3991
    *row+= 1;
3992 3993 3994 3995 3996
    break;
  }
  case MYSQL_TYPE_SHORT:
  case MYSQL_TYPE_YEAR:
  {
3997
    short value= sint2korr(*row);
unknown's avatar
unknown committed
3998 3999
    longlong data= field_is_unsigned ? (longlong) (unsigned short) value :
                                       (longlong) value;
4000
    fetch_long_with_conversion(param, field, data, 0);
unknown's avatar
unknown committed
4001
    *row+= 2;
4002 4003
    break;
  }
4004
  case MYSQL_TYPE_INT24: /* mediumint is sent as 4 bytes int */
4005 4006
  case MYSQL_TYPE_LONG:
  {
4007 4008
    int32 value= sint4korr(*row);
    longlong data= field_is_unsigned ? (longlong) (uint32) value :
unknown's avatar
unknown committed
4009
                                       (longlong) value;
4010
    fetch_long_with_conversion(param, field, data, 0);
unknown's avatar
unknown committed
4011
    *row+= 4;
4012 4013 4014 4015 4016
    break;
  }
  case MYSQL_TYPE_LONGLONG:
  {
    longlong value= (longlong)sint8korr(*row);
4017 4018
    fetch_long_with_conversion(param, field, value,
                               field->flags & UNSIGNED_FLAG);
unknown's avatar
unknown committed
4019
    *row+= 8;
4020 4021 4022 4023 4024 4025
    break;
  }
  case MYSQL_TYPE_FLOAT:
  {
    float value;
    float4get(value,*row);
unknown's avatar
unknown committed
4026
    fetch_float_with_conversion(param, field, value, FLT_DIG);
unknown's avatar
unknown committed
4027
    *row+= 4;
4028 4029 4030 4031 4032 4033
    break;
  }
  case MYSQL_TYPE_DOUBLE:
  {
    double value;
    float8get(value,*row);
unknown's avatar
unknown committed
4034
    fetch_float_with_conversion(param, field, value, DBL_DIG);
unknown's avatar
unknown committed
4035
    *row+= 8;
4036 4037 4038 4039
    break;
  }
  case MYSQL_TYPE_DATE:
  {
unknown's avatar
unknown committed
4040
    MYSQL_TIME tm;
4041

unknown's avatar
unknown committed
4042
    read_binary_date(&tm, row);
4043
    fetch_datetime_with_conversion(param, field, &tm);
4044 4045 4046 4047
    break;
  }
  case MYSQL_TYPE_TIME:
  {
unknown's avatar
unknown committed
4048
    MYSQL_TIME tm;
4049

unknown's avatar
unknown committed
4050
    read_binary_time(&tm, row);
4051
    fetch_datetime_with_conversion(param, field, &tm);
unknown's avatar
unknown committed
4052 4053 4054 4055 4056 4057
    break;
  }
  case MYSQL_TYPE_DATETIME:
  case MYSQL_TYPE_TIMESTAMP:
  {
    MYSQL_TIME tm;
4058

unknown's avatar
unknown committed
4059
    read_binary_datetime(&tm, row);
4060
    fetch_datetime_with_conversion(param, field, &tm);
4061 4062
    break;
  }
4063
  default:
unknown's avatar
unknown committed
4064 4065
  {
    ulong length= net_field_length(row);
unknown's avatar
unknown committed
4066
    fetch_string_with_conversion(param, (char*) *row, length);
unknown's avatar
unknown committed
4067
    *row+= length;
4068 4069
    break;
  }
unknown's avatar
unknown committed
4070
  }
4071 4072
}

unknown's avatar
unknown committed
4073

4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092
/*
  Functions to fetch data to application buffers without conversion.

  All functions have the following characteristics:

  SYNOPSIS
    fetch_result_xxx()
    param   MySQL bind param
    pos     Row value

  DESCRIPTION
    These are no-conversion functions, used in binary protocol to store
    rows in application buffers. A function used only if type of binary data
    is compatible with type of application buffer.

  RETURN
    none
*/

4093 4094
static void fetch_result_tinyint(MYSQL_BIND *param, MYSQL_FIELD *field,
                                 uchar **row)
unknown's avatar
unknown committed
4095
{
4096 4097 4098
  my_bool field_is_unsigned= test(field->flags & UNSIGNED_FLAG);
  uchar data= **row;
  *(uchar *)param->buffer= data;
4099
  *param->error= param->is_unsigned != field_is_unsigned && data > INT_MAX8;
4100
  (*row)++;
unknown's avatar
unknown committed
4101 4102
}

4103 4104
static void fetch_result_short(MYSQL_BIND *param, MYSQL_FIELD *field,
                               uchar **row)
unknown's avatar
unknown committed
4105
{
4106 4107 4108
  my_bool field_is_unsigned= test(field->flags & UNSIGNED_FLAG);
  ushort data= (ushort) sint2korr(*row);
  shortstore(param->buffer, data);
4109
  *param->error= param->is_unsigned != field_is_unsigned && data > INT_MAX16;
4110
  *row+= 2;
unknown's avatar
unknown committed
4111 4112
}

4113 4114 4115
static void fetch_result_int32(MYSQL_BIND *param,
                               MYSQL_FIELD *field __attribute__((unused)),
                               uchar **row)
unknown's avatar
unknown committed
4116
{
4117 4118 4119
  my_bool field_is_unsigned= test(field->flags & UNSIGNED_FLAG);
  uint32 data= (uint32) sint4korr(*row);
  longstore(param->buffer, data);
4120
  *param->error= param->is_unsigned != field_is_unsigned && data > INT_MAX32;
4121
  *row+= 4;
unknown's avatar
unknown committed
4122 4123
}

4124 4125 4126
static void fetch_result_int64(MYSQL_BIND *param,
                               MYSQL_FIELD *field __attribute__((unused)),
                               uchar **row)
4127
{
4128 4129
  my_bool field_is_unsigned= test(field->flags & UNSIGNED_FLAG);
  ulonglong data= (ulonglong) sint8korr(*row);
4130
  *param->error= param->is_unsigned != field_is_unsigned && data > LONGLONG_MAX;
4131
  longlongstore(param->buffer, data);
4132
  *row+= 8;
unknown's avatar
unknown committed
4133 4134
}

4135 4136 4137
static void fetch_result_float(MYSQL_BIND *param,
                               MYSQL_FIELD *field __attribute__((unused)),
                               uchar **row)
unknown's avatar
unknown committed
4138 4139 4140
{
  float value;
  float4get(value,*row);
4141
  floatstore(param->buffer, value);
4142
  *row+= 4;
unknown's avatar
unknown committed
4143 4144
}

4145 4146 4147
static void fetch_result_double(MYSQL_BIND *param,
                                MYSQL_FIELD *field __attribute__((unused)),
                                uchar **row)
unknown's avatar
unknown committed
4148 4149 4150
{
  double value;
  float8get(value,*row);
4151
  doublestore(param->buffer, value);
4152
  *row+= 8;
unknown's avatar
unknown committed
4153 4154
}

4155 4156 4157
static void fetch_result_time(MYSQL_BIND *param,
                              MYSQL_FIELD *field __attribute__((unused)),
                              uchar **row)
unknown's avatar
unknown committed
4158 4159
{
  MYSQL_TIME *tm= (MYSQL_TIME *)param->buffer;
unknown's avatar
unknown committed
4160
  read_binary_time(tm, row);
unknown's avatar
unknown committed
4161 4162
}

4163 4164 4165
static void fetch_result_date(MYSQL_BIND *param,
                              MYSQL_FIELD *field __attribute__((unused)),
                              uchar **row)
unknown's avatar
unknown committed
4166 4167
{
  MYSQL_TIME *tm= (MYSQL_TIME *)param->buffer;
unknown's avatar
unknown committed
4168
  read_binary_date(tm, row);
unknown's avatar
unknown committed
4169 4170
}

4171 4172 4173
static void fetch_result_datetime(MYSQL_BIND *param,
                                  MYSQL_FIELD *field __attribute__((unused)),
                                  uchar **row)
unknown's avatar
unknown committed
4174 4175
{
  MYSQL_TIME *tm= (MYSQL_TIME *)param->buffer;
unknown's avatar
unknown committed
4176
  read_binary_datetime(tm, row);
unknown's avatar
unknown committed
4177 4178
}

4179 4180 4181
static void fetch_result_bin(MYSQL_BIND *param,
                             MYSQL_FIELD *field __attribute__((unused)),
                             uchar **row)
4182
{
unknown's avatar
unknown committed
4183 4184 4185
  ulong length= net_field_length(row);
  ulong copy_length= min(length, param->buffer_length);
  memcpy(param->buffer, (char *)*row, copy_length);
4186
  *param->length= length;
4187
  *param->error= copy_length < length;
unknown's avatar
unknown committed
4188 4189
  *row+= length;
}
4190

4191 4192 4193
static void fetch_result_str(MYSQL_BIND *param,
                             MYSQL_FIELD *field __attribute__((unused)),
                             uchar **row)
unknown's avatar
unknown committed
4194 4195
{
  ulong length= net_field_length(row);
4196 4197
  ulong copy_length= min(length, param->buffer_length);
  memcpy(param->buffer, (char *)*row, copy_length);
4198 4199
  /* Add an end null if there is room in the buffer */
  if (copy_length != param->buffer_length)
4200
    ((uchar *)param->buffer)[copy_length]= '\0';
4201
  *param->length= length;			/* return total length */
4202
  *param->error= copy_length < length;
4203
  *row+= length;
unknown's avatar
unknown committed
4204 4205
}

unknown's avatar
unknown committed
4206

4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242
/*
  functions to calculate max lengths for strings during
  mysql_stmt_store_result()
*/

static void skip_result_fixed(MYSQL_BIND *param,
			      MYSQL_FIELD *field __attribute__((unused)),
			      uchar **row)

{
  (*row)+= param->pack_length;
}


static void skip_result_with_length(MYSQL_BIND *param __attribute__((unused)),
				    MYSQL_FIELD *field __attribute__((unused)),
				    uchar **row)

{
  ulong length= net_field_length(row);
  (*row)+= length;
}


static void skip_result_string(MYSQL_BIND *param __attribute__((unused)),
			       MYSQL_FIELD *field,
			       uchar **row)

{
  ulong length= net_field_length(row);
  (*row)+= length;
  if (field->max_length < length)
    field->max_length= length;
}


4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260
/*
  Check that two field types are binary compatible i. e.
  have equal representation in the binary protocol and
  require client-side buffers of the same type.

  SYNOPSIS
    is_binary_compatible()
    type1   parameter type supplied by user
    type2   field type, obtained from result set metadata

  RETURN
    TRUE or FALSE
*/

static my_bool is_binary_compatible(enum enum_field_types type1,
                                    enum enum_field_types type2)
{
  static const enum enum_field_types
4261 4262 4263
    range1[]= { MYSQL_TYPE_SHORT, MYSQL_TYPE_YEAR, MYSQL_TYPE_NULL },
    range2[]= { MYSQL_TYPE_INT24, MYSQL_TYPE_LONG, MYSQL_TYPE_NULL },
    range3[]= { MYSQL_TYPE_DATETIME, MYSQL_TYPE_TIMESTAMP, MYSQL_TYPE_NULL },
4264 4265 4266
    range4[]= { MYSQL_TYPE_ENUM, MYSQL_TYPE_SET, MYSQL_TYPE_TINY_BLOB,
                MYSQL_TYPE_MEDIUM_BLOB, MYSQL_TYPE_LONG_BLOB, MYSQL_TYPE_BLOB,
                MYSQL_TYPE_VAR_STRING, MYSQL_TYPE_STRING, MYSQL_TYPE_GEOMETRY,
4267 4268
                MYSQL_TYPE_DECIMAL, MYSQL_TYPE_NULL };
  static const enum enum_field_types
4269 4270
   *range_list[]= { range1, range2, range3, range4 },
   **range_list_end= range_list + sizeof(range_list)/sizeof(*range_list);
4271
   const enum enum_field_types **range, *type;
4272 4273 4274 4275 4276 4277 4278

  if (type1 == type2)
    return TRUE;
  for (range= range_list; range != range_list_end; ++range)
  {
    /* check that both type1 and type2 are in the same range */
    bool type1_found= FALSE, type2_found= FALSE;
4279
    for (type= *range; *type != MYSQL_TYPE_NULL; type++)
4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317
    {
      type1_found|= type1 == *type;
      type2_found|= type2 == *type;
    }
    if (type1_found || type2_found)
      return type1_found && type2_found;
  }
  return FALSE;
}


/*
  Setup a fetch function for one column of a result set.

  SYNOPSIS
    setup_one_fetch_function()
    param    output buffer descriptor
    field    column descriptor

  DESCRIPTION
    When user binds result set buffers or when result set
    metadata is changed, we need to setup fetch (and possibly
    conversion) functions for all columns of the result set.
    In addition to that here we set up skip_result function, used
    to update result set metadata in case when
    STMT_ATTR_UPDATE_MAX_LENGTH attribute is set.
    Notice that while fetch_result is chosen depending on both
    field->type and param->type, skip_result depends on field->type
    only.

  RETURN
    TRUE   fetch function for this typecode was not found (typecode
          is not supported by the client library)
    FALSE  success
*/

static my_bool setup_one_fetch_function(MYSQL_BIND *param, MYSQL_FIELD *field)
{
4318 4319
  DBUG_ENTER("setup_one_fetch_function");

4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371
  /* Setup data copy functions for the different supported types */
  switch (param->buffer_type) {
  case MYSQL_TYPE_NULL: /* for dummy binds */
    /*
      It's not binary compatible with anything the server can return:
      no need to setup fetch_result, as it'll be reset anyway
    */
    *param->length= 0;
    break;
  case MYSQL_TYPE_TINY:
    param->fetch_result= fetch_result_tinyint;
    *param->length= 1;
    break;
  case MYSQL_TYPE_SHORT:
  case MYSQL_TYPE_YEAR:
    param->fetch_result= fetch_result_short;
    *param->length= 2;
    break;
  case MYSQL_TYPE_INT24:
  case MYSQL_TYPE_LONG:
    param->fetch_result= fetch_result_int32;
    *param->length= 4;
    break;
  case MYSQL_TYPE_LONGLONG:
    param->fetch_result= fetch_result_int64;
    *param->length= 8;
    break;
  case MYSQL_TYPE_FLOAT:
    param->fetch_result= fetch_result_float;
    *param->length= 4;
    break;
  case MYSQL_TYPE_DOUBLE:
    param->fetch_result= fetch_result_double;
    *param->length= 8;
    break;
  case MYSQL_TYPE_TIME:
    param->fetch_result= fetch_result_time;
    *param->length= sizeof(MYSQL_TIME);
    break;
  case MYSQL_TYPE_DATE:
    param->fetch_result= fetch_result_date;
    *param->length= sizeof(MYSQL_TIME);
    break;
  case MYSQL_TYPE_DATETIME:
  case MYSQL_TYPE_TIMESTAMP:
    param->fetch_result= fetch_result_datetime;
    *param->length= sizeof(MYSQL_TIME);
    break;
  case MYSQL_TYPE_TINY_BLOB:
  case MYSQL_TYPE_MEDIUM_BLOB:
  case MYSQL_TYPE_LONG_BLOB:
  case MYSQL_TYPE_BLOB:
unknown's avatar
unknown committed
4372
  case MYSQL_TYPE_BIT:
4373 4374 4375 4376 4377
    DBUG_ASSERT(param->buffer_length != 0);
    param->fetch_result= fetch_result_bin;
    break;
  case MYSQL_TYPE_VAR_STRING:
  case MYSQL_TYPE_STRING:
unknown's avatar
unknown committed
4378 4379
  case MYSQL_TYPE_DECIMAL:
  case MYSQL_TYPE_NEWDECIMAL:
4380 4381 4382 4383
    DBUG_ASSERT(param->buffer_length != 0);
    param->fetch_result= fetch_result_str;
    break;
  default:
4384 4385 4386
    DBUG_PRINT("error", ("Unknown param->buffer_type: %u",
                         (uint) param->buffer_type));
    DBUG_RETURN(TRUE);
4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440
  }
  if (! is_binary_compatible(param->buffer_type, field->type))
    param->fetch_result= fetch_result_with_conversion;

  /* Setup skip_result functions (to calculate max_length) */
  param->skip_result= skip_result_fixed;
  switch (field->type) {
  case MYSQL_TYPE_NULL: /* for dummy binds */
    param->pack_length= 0;
    field->max_length= 0;
    break;
  case MYSQL_TYPE_TINY:
    param->pack_length= 1;
    field->max_length= 4;                     /* as in '-127' */
    break;
  case MYSQL_TYPE_YEAR:
  case MYSQL_TYPE_SHORT:
    param->pack_length= 2;
    field->max_length= 6;                     /* as in '-32767' */
    break;
  case MYSQL_TYPE_INT24:
    field->max_length= 9;  /* as in '16777216' or in '-8388607' */
    param->pack_length= 4;
    break;
  case MYSQL_TYPE_LONG:
    field->max_length= 11;                    /* '-2147483647' */
    param->pack_length= 4;
    break;
  case MYSQL_TYPE_LONGLONG:
    field->max_length= 21;                    /* '18446744073709551616' */
    param->pack_length= 8;
    break;
  case MYSQL_TYPE_FLOAT:
    param->pack_length= 4;
    field->max_length= MAX_DOUBLE_STRING_REP_LENGTH;
    break;
  case MYSQL_TYPE_DOUBLE:
    param->pack_length= 8;
    field->max_length= MAX_DOUBLE_STRING_REP_LENGTH;
    break;
  case MYSQL_TYPE_TIME:
    field->max_length= 15;                    /* 19:23:48.123456 */
    param->skip_result= skip_result_with_length;
  case MYSQL_TYPE_DATE:
    field->max_length= 10;                    /* 2003-11-11 */
    param->skip_result= skip_result_with_length;
    break;
    break;
  case MYSQL_TYPE_DATETIME:
  case MYSQL_TYPE_TIMESTAMP:
    param->skip_result= skip_result_with_length;
    field->max_length= MAX_DATE_STRING_REP_LENGTH;
    break;
  case MYSQL_TYPE_DECIMAL:
unknown's avatar
unknown committed
4441
  case MYSQL_TYPE_NEWDECIMAL:
4442 4443 4444 4445 4446 4447 4448 4449 4450
  case MYSQL_TYPE_ENUM:
  case MYSQL_TYPE_SET:
  case MYSQL_TYPE_GEOMETRY:
  case MYSQL_TYPE_TINY_BLOB:
  case MYSQL_TYPE_MEDIUM_BLOB:
  case MYSQL_TYPE_LONG_BLOB:
  case MYSQL_TYPE_BLOB:
  case MYSQL_TYPE_VAR_STRING:
  case MYSQL_TYPE_STRING:
unknown's avatar
unknown committed
4451
  case MYSQL_TYPE_BIT:
4452 4453 4454
    param->skip_result= skip_result_string;
    break;
  default:
4455 4456
    DBUG_PRINT("error", ("Unknown field->type: %u", (uint) field->type));
    DBUG_RETURN(TRUE);
4457
  }
4458
  DBUG_RETURN(FALSE);
4459 4460 4461
}


4462
/*
4463
  Setup the bind buffers for resultset processing
4464 4465
*/

4466
my_bool STDCALL mysql_stmt_bind_result(MYSQL_STMT *stmt, MYSQL_BIND *my_bind)
4467
{
4468
  MYSQL_BIND *param, *end;
4469
  MYSQL_FIELD *field;
4470
  ulong       bind_count= stmt->field_count;
4471
  uint        param_count= 0;
4472
  DBUG_ENTER("mysql_stmt_bind_result");
unknown's avatar
unknown committed
4473
  DBUG_PRINT("enter",("field_count: %lu", bind_count));
4474

4475
  if (!bind_count)
4476
  {
4477 4478 4479 4480
    int errorcode= (int) stmt->state < (int) MYSQL_STMT_PREPARE_DONE ?
                   CR_NO_PREPARE_STMT : CR_NO_STMT_METADATA;
    set_stmt_error(stmt, errorcode, unknown_sqlstate);
    DBUG_RETURN(1);
4481 4482 4483 4484 4485
  }

  /*
    We only need to check that stmt->field_count - if it is not null
    stmt->bind was initialized in mysql_stmt_prepare
4486 4487 4488
    stmt->bind overlaps with bind if mysql_stmt_bind_param
    is called from mysql_stmt_store_result.
  */
4489

4490 4491 4492
  if (stmt->bind != my_bind)
    memcpy((char*) stmt->bind, (char*) my_bind,
           sizeof(MYSQL_BIND) * bind_count);
4493

4494 4495 4496
  for (param= stmt->bind, end= param + bind_count, field= stmt->fields ;
       param < end ;
       param++, field++)
4497
  {
4498 4499
    DBUG_PRINT("info",("buffer_type: %u  field_type: %u",
                       (uint) param->buffer_type, (uint) field->type));
unknown's avatar
unknown committed
4500 4501
    /*
      Set param->is_null to point to a dummy variable if it's not set.
4502
      This is to make the execute code easier
unknown's avatar
unknown committed
4503 4504
    */
    if (!param->is_null)
4505
      param->is_null= &param->is_null_value;
unknown's avatar
unknown committed
4506

unknown's avatar
unknown committed
4507
    if (!param->length)
4508 4509 4510 4511
      param->length= &param->length_value;

    if (!param->error)
      param->error= &param->error_value;
unknown's avatar
unknown committed
4512

4513
    param->param_number= param_count++;
unknown's avatar
unknown committed
4514 4515
    param->offset= 0;

4516 4517
    if (setup_one_fetch_function(param, field))
    {
4518 4519
      strmov(stmt->sqlstate, unknown_sqlstate);
      sprintf(stmt->last_error,
4520 4521
              ER(stmt->last_errno= CR_UNSUPPORTED_PARAM_TYPE),
              field->type, param_count);
4522 4523
      DBUG_RETURN(1);
    }
4524
  }
4525 4526 4527 4528
  stmt->bind_result_done= BIND_RESULT_DONE;
  if (stmt->mysql->options.report_data_truncation)
    stmt->bind_result_done|= REPORT_DATA_TRUNCATION;

4529 4530 4531
  DBUG_RETURN(0);
}

unknown's avatar
unknown committed
4532

4533
/*
4534
  Fetch row data to bind buffers
4535 4536
*/

4537
static int stmt_fetch_row(MYSQL_STMT *stmt, uchar *row)
4538
{
4539
  MYSQL_BIND  *my_bind, *end;
4540
  MYSQL_FIELD *field;
unknown's avatar
unknown committed
4541
  uchar *null_ptr, bit;
4542
  int truncation_count= 0;
4543 4544 4545 4546 4547 4548
  /*
    Precondition: if stmt->field_count is zero or row is NULL, read_row_*
    function must return no data.
  */
  DBUG_ASSERT(stmt->field_count);
  DBUG_ASSERT(row);
4549

4550 4551 4552
  if (!stmt->bind_result_done)
  {
    /* If output parameters were not bound we should just return success */
4553
    return 0;
4554
  }
4555 4556

  null_ptr= row;
unknown's avatar
unknown committed
4557 4558
  row+= (stmt->field_count+9)/8;		/* skip null bits */
  bit= 4;					/* first 2 bits are reserved */
4559

unknown's avatar
unknown committed
4560
  /* Copy complete row to application buffers */
4561 4562 4563 4564
  for (my_bind= stmt->bind, end= my_bind + stmt->field_count,
         field= stmt->fields ;
       my_bind < end ;
       my_bind++, field++)
4565
  {
4566
    *my_bind->error= 0;
4567
    if (*null_ptr & bit)
4568 4569
    {
      /*
4570
        We should set both row_ptr and is_null to be able to see
4571 4572 4573 4574 4575
        nulls in mysql_stmt_fetch_column. This is because is_null may point
        to user data which can be overwritten between mysql_stmt_fetch and
        mysql_stmt_fetch_column, and in this case nullness of column will be
        lost. See mysql_stmt_fetch_column for details.
      */
4576 4577
      my_bind->row_ptr= NULL;
      *my_bind->is_null= 1;
4578
    }
4579
    else
4580
    {
4581 4582 4583 4584
      *my_bind->is_null= 0;
      my_bind->row_ptr= row;
      (*my_bind->fetch_result)(my_bind, field, &row);
      truncation_count+= *my_bind->error;
4585
    }
unknown's avatar
unknown committed
4586
    if (!((bit<<=1) & 255))
4587
    {
4588
      bit= 1;					/* To next uchar */
4589
      null_ptr++;
4590 4591
    }
  }
4592 4593
  if (truncation_count && (stmt->bind_result_done & REPORT_DATA_TRUNCATION))
    return MYSQL_DATA_TRUNCATED;
4594 4595 4596
  return 0;
}

4597

unknown's avatar
unknown committed
4598
int cli_unbuffered_fetch(MYSQL *mysql, char **row)
unknown's avatar
SCRUM  
unknown committed
4599
{
4600
  if (packet_error == cli_safe_read(mysql))
unknown's avatar
SCRUM  
unknown committed
4601 4602
    return 1;

unknown's avatar
unknown committed
4603 4604
  *row= ((mysql->net.read_pos[0] == 254) ? NULL :
	 (char*) (mysql->net.read_pos+1));
unknown's avatar
SCRUM  
unknown committed
4605 4606
  return 0;
}
unknown's avatar
unknown committed
4607

4608

4609
/*
4610
  Fetch and return row data to bound buffers, if any
4611 4612
*/

4613
int STDCALL mysql_stmt_fetch(MYSQL_STMT *stmt)
4614
{
4615
  int rc;
4616
  uchar *row;
4617
  DBUG_ENTER("mysql_stmt_fetch");
4618

4619
  if ((rc= (*stmt->read_row_func)(stmt, &row)) ||
4620
      ((rc= stmt_fetch_row(stmt, row)) && rc != MYSQL_DATA_TRUNCATED))
4621
  {
4622
    stmt->state= MYSQL_STMT_PREPARE_DONE;       /* XXX: this is buggy */
unknown's avatar
unknown committed
4623 4624
    stmt->read_row_func= (rc == MYSQL_NO_DATA) ? 
      stmt_read_row_no_data : stmt_read_row_no_result_set;
unknown's avatar
unknown committed
4625
  }
4626
  else
4627
  {
4628 4629
    /* This is to know in mysql_stmt_fetch_column that data was fetched */
    stmt->state= MYSQL_STMT_FETCH_DONE;
unknown's avatar
SCRUM  
unknown committed
4630
  }
4631
  DBUG_RETURN(rc);
4632 4633
}

unknown's avatar
unknown committed
4634

unknown's avatar
unknown committed
4635
/*
unknown's avatar
unknown committed
4636
  Fetch data for one specified column data
unknown's avatar
unknown committed
4637 4638

  SYNOPSIS
4639
    mysql_stmt_fetch_column()
unknown's avatar
unknown committed
4640
    stmt		Prepared statement handler
4641
    my_bind		Where data should be placed. Should be filled in as
4642
			when calling mysql_stmt_bind_result()
unknown's avatar
unknown committed
4643 4644 4645
    column		Column to fetch (first column is 0)
    ulong offset	Offset in result data (to fetch blob in pieces)
			This is normally 0
4646
  RETURN
unknown's avatar
unknown committed
4647 4648
    0	ok
    1	error
unknown's avatar
unknown committed
4649 4650
*/

4651
int STDCALL mysql_stmt_fetch_column(MYSQL_STMT *stmt, MYSQL_BIND *my_bind,
4652
                                    uint column, ulong offset)
unknown's avatar
unknown committed
4653
{
4654
  MYSQL_BIND *param= stmt->bind+column;
4655
  DBUG_ENTER("mysql_stmt_fetch_column");
unknown's avatar
unknown committed
4656

4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667
  if ((int) stmt->state < (int) MYSQL_STMT_FETCH_DONE)
  {
    set_stmt_error(stmt, CR_NO_DATA, unknown_sqlstate);
    return 1;
  }
  if (column >= stmt->field_count)
  {
    set_stmt_error(stmt, CR_INVALID_PARAMETER_NO, unknown_sqlstate);
    DBUG_RETURN(1);
  }

4668 4669 4670
  if (!my_bind->error)
    my_bind->error= &my_bind->error_value;
  *my_bind->error= 0;
4671
  if (param->row_ptr)
unknown's avatar
unknown committed
4672
  {
4673
    MYSQL_FIELD *field= stmt->fields+column;
4674
    uchar *row= param->row_ptr;
4675 4676 4677 4678 4679
    my_bind->offset= offset;
    if (my_bind->is_null)
      *my_bind->is_null= 0;
    if (my_bind->length) /* Set the length if non char/binary types */
      *my_bind->length= *param->length;
unknown's avatar
unknown committed
4680
    else
4681 4682
      my_bind->length= &param->length_value;       /* Needed for fetch_result() */
    fetch_result_with_conversion(my_bind, field, &row);
unknown's avatar
unknown committed
4683
  }
4684 4685
  else
  {
4686 4687
    if (my_bind->is_null)
      *my_bind->is_null= 1;
4688
  }
unknown's avatar
unknown committed
4689 4690 4691 4692
  DBUG_RETURN(0);
}


4693
/*
4694 4695 4696
  Read all rows of data from server  (binary format)
*/

4697
int cli_read_binary_rows(MYSQL_STMT *stmt)
4698 4699 4700 4701
{
  ulong      pkt_len;
  uchar      *cp;
  MYSQL      *mysql= stmt->mysql;
4702 4703
  MYSQL_DATA *result= &stmt->result;
  MYSQL_ROWS *cur, **prev_ptr= &result->data;
4704 4705
  NET        *net;

unknown's avatar
unknown committed
4706
  DBUG_ENTER("cli_read_binary_rows");
4707

4708 4709 4710
  if (!mysql)
  {
    set_stmt_error(stmt, CR_SERVER_LOST, unknown_sqlstate);
unknown's avatar
unknown committed
4711
    DBUG_RETURN(1);
4712 4713 4714
  }

  net = &mysql->net;
4715
  mysql= mysql->last_used_con;
4716

4717
  while ((pkt_len= cli_safe_read(mysql)) != packet_error)
4718
  {
4719 4720
    cp= net->read_pos;
    if (cp[0] != 254 || pkt_len >= 8)
4721
    {
4722 4723 4724 4725
      if (!(cur= (MYSQL_ROWS*) alloc_root(&result->alloc,
                                          sizeof(MYSQL_ROWS) + pkt_len - 1)))
      {
        set_stmt_error(stmt, CR_OUT_OF_MEMORY, unknown_sqlstate);
4726
        goto err;
4727 4728 4729 4730 4731
      }
      cur->data= (MYSQL_ROW) (cur+1);
      *prev_ptr= cur;
      prev_ptr= &cur->next;
      memcpy((char *) cur->data, (char *) cp+1, pkt_len-1);
4732 4733
      cur->length= pkt_len;		/* To allow us to do sanity checks */
      result->rows++;
4734
    }
4735
    else
4736
    {
4737 4738 4739 4740
      /* end of data */
      *prev_ptr= 0;
      mysql->warning_count= uint2korr(cp+1);
      mysql->server_status= uint2korr(cp+3);
4741 4742
      DBUG_PRINT("info",("status: %u  warning_count: %u",
                         mysql->server_status, mysql->warning_count));
4743 4744 4745
      DBUG_RETURN(0);
    }
  }
4746
  set_stmt_errmsg(stmt, net->last_error, net->last_errno, net->sqlstate);
4747 4748

err:
4749
  DBUG_RETURN(1);
4750 4751
}

4752

4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766
/*
  Update meta data for statement

  SYNOPSIS
    stmt_update_metadata()
    stmt			Statement handler
    row				Binary data

  NOTES
    Only updates MYSQL_FIELD->max_length for strings
*/

static void stmt_update_metadata(MYSQL_STMT *stmt, MYSQL_ROWS *data)
{
4767
  MYSQL_BIND  *my_bind, *end;
4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778
  MYSQL_FIELD *field;
  uchar *null_ptr, bit;
  uchar *row= (uchar*) data->data;
#ifndef DBUG_OFF
  uchar *row_end= row + data->length;
#endif

  null_ptr= row;
  row+= (stmt->field_count+9)/8;		/* skip null bits */
  bit= 4;					/* first 2 bits are reserved */

4779
  /* Go through all fields and calculate metadata */
4780 4781 4782
  for (my_bind= stmt->bind, end= my_bind + stmt->field_count, field= stmt->fields ;
       my_bind < end ;
       my_bind++, field++)
4783 4784
  {
    if (!(*null_ptr & bit))
4785
      (*my_bind->skip_result)(my_bind, field, &row);
4786 4787 4788
    DBUG_ASSERT(row <= row_end);
    if (!((bit<<=1) & 255))
    {
4789
      bit= 1;					/* To next uchar */
4790 4791 4792 4793 4794 4795
      null_ptr++;
    }
  }
}


4796 4797 4798 4799 4800 4801 4802
/*
  Store or buffer the binary results to stmt
*/

int STDCALL mysql_stmt_store_result(MYSQL_STMT *stmt)
{
  MYSQL *mysql= stmt->mysql;
4803
  MYSQL_DATA *result= &stmt->result;
4804
  DBUG_ENTER("mysql_stmt_store_result");
4805 4806 4807 4808 4809

  mysql= mysql->last_used_con;

  if (!stmt->field_count)
    DBUG_RETURN(0);
4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823

  if ((int) stmt->state < (int) MYSQL_STMT_EXECUTE_DONE)
  {
    set_stmt_error(stmt, CR_COMMANDS_OUT_OF_SYNC, unknown_sqlstate);
    DBUG_RETURN(1);
  }

  if (mysql->status == MYSQL_STATUS_READY &&
      stmt->server_status & SERVER_STATUS_CURSOR_EXISTS)
  {
    /*
      Server side cursor exist, tell server to start sending the rows
    */
    NET *net= &mysql->net;
4824 4825
    uchar buff[4 /* statement id */ +
               4 /* number of rows to fetch */];
4826 4827 4828 4829 4830

    /* Send row request to the server */
    int4store(buff, stmt->stmt_id);
    int4store(buff + 4, (int)~0); /* number of rows to fetch */
    if (cli_advanced_command(mysql, COM_STMT_FETCH, buff, sizeof(buff),
4831
                             (uchar*) 0, 0, 1, NULL))
4832 4833 4834 4835 4836 4837
    {
      set_stmt_errmsg(stmt, net->last_error, net->last_errno, net->sqlstate);
      DBUG_RETURN(1);
    }
  }
  else if (mysql->status != MYSQL_STATUS_GET_RESULT)
4838
  {
4839
    set_stmt_error(stmt, CR_COMMANDS_OUT_OF_SYNC, unknown_sqlstate);
4840
    DBUG_RETURN(1);
4841
  }
4842

4843 4844 4845 4846 4847 4848
  if (stmt->update_max_length && !stmt->bind_result_done)
  {
    /*
      We must initalize the bind structure to be able to calculate
      max_length
    */
4849
    MYSQL_BIND  *my_bind, *end;
4850 4851 4852
    MYSQL_FIELD *field;
    bzero((char*) stmt->bind, sizeof(*stmt->bind)* stmt->field_count);

4853 4854 4855 4856
    for (my_bind= stmt->bind, end= my_bind + stmt->field_count,
           field= stmt->fields;
	 my_bind < end ;
	 my_bind++, field++)
4857
    {
4858 4859
      my_bind->buffer_type= MYSQL_TYPE_NULL;
      my_bind->buffer_length=1;
4860 4861
    }

4862 4863
    if (mysql_stmt_bind_result(stmt, stmt->bind))
      DBUG_RETURN(1);
4864 4865 4866
    stmt->bind_result_done= 0;			/* No normal bind done */
  }

4867
  if ((*mysql->methods->read_binary_rows)(stmt))
4868
  {
4869 4870 4871
    free_root(&result->alloc, MYF(MY_KEEP_PREALLOC));
    result->data= NULL;
    result->rows= 0;
4872
    mysql->status= MYSQL_STATUS_READY;
4873
    DBUG_RETURN(1);
4874
  }
4875

4876 4877 4878 4879
  /* Assert that if there was a cursor, all rows have been fetched */
  DBUG_ASSERT(mysql->status != MYSQL_STATUS_READY ||
              (mysql->server_status & SERVER_STATUS_LAST_ROW_SENT));

4880 4881 4882 4883 4884 4885 4886
  if (stmt->update_max_length)
  {
    MYSQL_ROWS *cur= result->data;
    for(; cur; cur=cur->next)
      stmt_update_metadata(stmt, cur);
  }

4887 4888
  stmt->data_cursor= result->data;
  mysql->affected_rows= stmt->affected_rows= result->rows;
4889 4890 4891
  stmt->read_row_func= stmt_read_row_buffered;
  mysql->unbuffered_fetch_owner= 0;             /* set in stmt_execute */
  mysql->status= MYSQL_STATUS_READY;		/* server is ready */
4892
  DBUG_RETURN(0); /* Data buffered, must be fetched with mysql_stmt_fetch() */
4893 4894
}

4895

4896 4897 4898 4899 4900 4901 4902
/*
  Seek to desired row in the statement result set
*/

MYSQL_ROW_OFFSET STDCALL
mysql_stmt_row_seek(MYSQL_STMT *stmt, MYSQL_ROW_OFFSET row)
{
4903
  MYSQL_ROW_OFFSET offset= stmt->data_cursor;
4904
  DBUG_ENTER("mysql_stmt_row_seek");
4905

4906 4907
  stmt->data_cursor= row;
  DBUG_RETURN(offset);
4908 4909
}

4910

4911 4912 4913 4914
/*
  Return the current statement row cursor position
*/

4915
MYSQL_ROW_OFFSET STDCALL
4916 4917 4918
mysql_stmt_row_tell(MYSQL_STMT *stmt)
{
  DBUG_ENTER("mysql_stmt_row_tell");
4919

4920
  DBUG_RETURN(stmt->data_cursor);
4921 4922
}

unknown's avatar
unknown committed
4923

4924 4925 4926 4927 4928 4929 4930
/*
  Move the stmt result set data cursor to specified row
*/

void STDCALL
mysql_stmt_data_seek(MYSQL_STMT *stmt, my_ulonglong row)
{
4931
  MYSQL_ROWS *tmp= stmt->result.data;
4932 4933
  DBUG_ENTER("mysql_stmt_data_seek");
  DBUG_PRINT("enter",("row id to seek: %ld",(long) row));
4934

4935 4936 4937
  for (; tmp && row; --row, tmp= tmp->next)
    ;
  stmt->data_cursor= tmp;
unknown's avatar
unknown committed
4938 4939 4940 4941 4942 4943
  if (!row && tmp)
  {
       /*  Rewind the counter */
    stmt->read_row_func= stmt_read_row_buffered;
    stmt->state= MYSQL_STMT_EXECUTE_DONE;
  }
4944
  DBUG_VOID_RETURN;
4945 4946
}

unknown's avatar
unknown committed
4947

4948 4949 4950 4951 4952 4953 4954
/*
  Return total rows the current statement result set
*/

my_ulonglong STDCALL mysql_stmt_num_rows(MYSQL_STMT *stmt)
{
  DBUG_ENTER("mysql_stmt_num_rows");
4955

4956
  DBUG_RETURN(stmt->result.rows);
4957
}
4958

4959

4960 4961 4962 4963 4964
/*
  Free the client side memory buffers, reset long data state
  on client if necessary, and reset the server side statement if
  this has been requested.
*/
4965

4966 4967 4968
static my_bool reset_stmt_handle(MYSQL_STMT *stmt, uint flags)
{
  /* If statement hasn't been prepared there is nothing to reset */
4969 4970 4971
  if ((int) stmt->state > (int) MYSQL_STMT_INIT_DONE)
  {
    MYSQL *mysql= stmt->mysql;
4972
    MYSQL_DATA *result= &stmt->result;
4973

4974 4975 4976 4977
    /*
      Reset stored result set if so was requested or it's a part
      of cursor fetch.
    */
4978
    if (flags & RESET_STORE_RESULT)
4979 4980
    {
      /* Result buffered */
4981 4982 4983 4984
      free_root(&result->alloc, MYF(MY_KEEP_PREALLOC));
      result->data= NULL;
      result->rows= 0;
      stmt->data_cursor= NULL;
4985
    }
4986
    if (flags & RESET_LONG_DATA)
4987
    {
4988 4989 4990 4991 4992
      MYSQL_BIND *param= stmt->params, *param_end= param + stmt->param_count;
      /* Clear long_data_used flags */
      for (; param < param_end; param++)
        param->long_data_used= 0;
    }
unknown's avatar
unknown committed
4993
    stmt->read_row_func= stmt_read_row_no_result_set;
4994 4995 4996
    if (mysql)
    {
      if ((int) stmt->state > (int) MYSQL_STMT_PREPARE_DONE)
4997
      {
4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008
        if (mysql->unbuffered_fetch_owner == &stmt->unbuffered_fetch_cancelled)
          mysql->unbuffered_fetch_owner= 0;
        if (stmt->field_count && mysql->status != MYSQL_STATUS_READY)
        {
          /* There is a result set and it belongs to this statement */
          (*mysql->methods->flush_use_result)(mysql);
          if (mysql->unbuffered_fetch_owner)
            *mysql->unbuffered_fetch_owner= TRUE;
          mysql->status= MYSQL_STATUS_READY;
        }
      }
5009
      if (flags & RESET_SERVER_SIDE)
5010 5011 5012 5013 5014
      {
        /*
          Reset the server side statement and close the server side
          cursor if it exists.
        */
5015
        uchar buff[MYSQL_STMT_HEADER]; /* packet header: 4 bytes for stmt id */
5016
        int4store(buff, stmt->stmt_id);
5017
        if ((*mysql->methods->advanced_command)(mysql, COM_STMT_RESET, buff,
unknown's avatar
unknown committed
5018
                                                sizeof(buff), 0, 0, 0, NULL))
5019 5020 5021 5022 5023 5024
        {
          set_stmt_errmsg(stmt, mysql->net.last_error, mysql->net.last_errno,
                          mysql->net.sqlstate);
          stmt->state= MYSQL_STMT_INIT_DONE;
          return 1;
        }
5025
        stmt_clear_error(stmt);
5026 5027 5028 5029
      }
    }
    stmt->state= MYSQL_STMT_PREPARE_DONE;
  }
5030 5031 5032 5033 5034 5035 5036 5037
  return 0;
}

my_bool STDCALL mysql_stmt_free_result(MYSQL_STMT *stmt)
{
  DBUG_ENTER("mysql_stmt_free_result");

  /* Free the client side and close the server side cursor if there is one */
5038
  DBUG_RETURN(reset_stmt_handle(stmt, RESET_LONG_DATA | RESET_STORE_RESULT));
5039 5040
}

5041
/********************************************************************
5042
 statement error handling and close
5043
*********************************************************************/
5044

5045
/*
unknown's avatar
unknown committed
5046
  Close the statement handle by freeing all alloced resources
5047

unknown's avatar
unknown committed
5048
  SYNOPSIS
5049
    mysql_stmt_close()
unknown's avatar
unknown committed
5050
    stmt	       Statement handle
5051

unknown's avatar
unknown committed
5052 5053 5054 5055
  RETURN VALUES
    0	ok
    1	error
*/
5056

5057
my_bool STDCALL mysql_stmt_close(MYSQL_STMT *stmt)
5058
{
5059 5060 5061
  MYSQL *mysql= stmt->mysql;
  int rc= 0;
  DBUG_ENTER("mysql_stmt_close");
5062

5063
  free_root(&stmt->result.alloc, MYF(0));
5064 5065 5066
  free_root(&stmt->mem_root, MYF(0));

  if (mysql)
5067
  {
5068
    mysql->stmts= list_delete(mysql->stmts, &stmt->list);
unknown's avatar
unknown committed
5069 5070 5071 5072 5073
    /*
      Clear NET error state: if the following commands come through
      successfully, connection will still be usable for other commands.
    */
    net_clear_error(&mysql->net);
5074
    if ((int) stmt->state > (int) MYSQL_STMT_INIT_DONE)
5075
    {
5076
      uchar buff[MYSQL_STMT_HEADER];             /* 4 bytes - stmt id */
5077 5078 5079 5080 5081

      if (mysql->unbuffered_fetch_owner == &stmt->unbuffered_fetch_cancelled)
        mysql->unbuffered_fetch_owner= 0;
      if (mysql->status != MYSQL_STATUS_READY)
      {
5082
        /*
5083 5084 5085
          Flush result set of the connection. If it does not belong
          to this statement, set a warning.
        */
5086
        (*mysql->methods->flush_use_result)(mysql);
5087 5088 5089 5090 5091
        if (mysql->unbuffered_fetch_owner)
          *mysql->unbuffered_fetch_owner= TRUE;
        mysql->status= MYSQL_STATUS_READY;
      }
      int4store(buff, stmt->stmt_id);
5092
      if ((rc= stmt_command(mysql, COM_STMT_CLOSE, buff, 4, stmt)))
5093 5094 5095 5096
      {
        set_stmt_errmsg(stmt, mysql->net.last_error, mysql->net.last_errno,
                        mysql->net.sqlstate);
      }
5097
    }
5098
  }
5099

5100
  my_free((uchar*) stmt, MYF(MY_WME));
unknown's avatar
unknown committed
5101

5102
  DBUG_RETURN(test(rc));
unknown's avatar
unknown committed
5103 5104
}

5105 5106 5107 5108 5109 5110 5111 5112
/*
  Reset the statement buffers in server
*/

my_bool STDCALL mysql_stmt_reset(MYSQL_STMT *stmt)
{
  DBUG_ENTER("mysql_stmt_reset");
  DBUG_ASSERT(stmt != 0);
5113 5114 5115 5116
  if (!stmt->mysql)
  {
    /* mysql can be reset in mysql_close called from mysql_reconnect */
    set_stmt_error(stmt, CR_SERVER_LOST, unknown_sqlstate);
5117 5118
    DBUG_RETURN(1);
  }
5119 5120
  /* Reset the client and server sides of the prepared statement */
  DBUG_RETURN(reset_stmt_handle(stmt, RESET_SERVER_SIDE | RESET_LONG_DATA));
5121 5122
}

5123 5124 5125 5126 5127 5128 5129
/*
  Return statement error code
*/

uint STDCALL mysql_stmt_errno(MYSQL_STMT * stmt)
{
  DBUG_ENTER("mysql_stmt_errno");
5130
  DBUG_RETURN(stmt->last_errno);
5131 5132
}

5133 5134 5135 5136 5137 5138
const char *STDCALL mysql_stmt_sqlstate(MYSQL_STMT * stmt)
{
  DBUG_ENTER("mysql_stmt_sqlstate");
  DBUG_RETURN(stmt->sqlstate);
}

5139 5140 5141 5142 5143 5144 5145
/*
  Return statement error message
*/

const char *STDCALL mysql_stmt_error(MYSQL_STMT * stmt)
{
  DBUG_ENTER("mysql_stmt_error");
5146
  DBUG_RETURN(stmt->last_error);
5147 5148
}

5149

5150 5151 5152 5153
/********************************************************************
 Transactional APIs
*********************************************************************/

5154 5155 5156 5157
/*
  Commit the current transaction
*/

5158
my_bool STDCALL mysql_commit(MYSQL * mysql)
5159 5160
{
  DBUG_ENTER("mysql_commit");
5161
  DBUG_RETURN((my_bool) mysql_real_query(mysql, "commit", 6));
5162 5163 5164
}

/*
5165
  Rollback the current transaction
5166 5167
*/

5168
my_bool STDCALL mysql_rollback(MYSQL * mysql)
5169 5170
{
  DBUG_ENTER("mysql_rollback");
5171
  DBUG_RETURN((my_bool) mysql_real_query(mysql, "rollback", 8));
5172 5173 5174 5175 5176 5177 5178
}


/*
  Set autocommit to either true or false
*/

5179
my_bool STDCALL mysql_autocommit(MYSQL * mysql, my_bool auto_mode)
5180 5181 5182 5183
{
  DBUG_ENTER("mysql_autocommit");
  DBUG_PRINT("enter", ("mode : %d", auto_mode));

5184 5185 5186
  DBUG_RETURN((my_bool) mysql_real_query(mysql, auto_mode ?
                                         "set autocommit=1":"set autocommit=0",
                                         16));
5187
}
5188 5189 5190


/********************************************************************
5191
 Multi query execution + SPs APIs
5192 5193 5194
*********************************************************************/

/*
unknown's avatar
unknown committed
5195 5196
  Returns true/false to indicate whether any more query results exist
  to be read using mysql_next_result()
5197 5198 5199 5200
*/

my_bool STDCALL mysql_more_results(MYSQL *mysql)
{
5201
  my_bool res;
5202
  DBUG_ENTER("mysql_more_results");
5203 5204

  res= ((mysql->last_used_con->server_status & SERVER_MORE_RESULTS_EXISTS) ?
5205
	1: 0);
5206
  DBUG_PRINT("exit",("More results exists ? %d", res));
5207
  DBUG_RETURN(res);
5208 5209
}

5210

5211 5212 5213
/*
  Reads and returns the next query results
*/
5214
int STDCALL mysql_next_result(MYSQL *mysql)
5215
{
5216
  DBUG_ENTER("mysql_next_result");
5217

5218 5219 5220 5221 5222 5223 5224 5225
  if (mysql->status != MYSQL_STATUS_READY)
  {
    strmov(mysql->net.sqlstate, unknown_sqlstate);
    strmov(mysql->net.last_error,
	   ER(mysql->net.last_errno=CR_COMMANDS_OUT_OF_SYNC));
    DBUG_RETURN(1);
  }

5226 5227
  mysql->net.last_error[0]= 0;
  mysql->net.last_errno= 0;
5228
  strmov(mysql->net.sqlstate, not_error_sqlstate);
5229 5230 5231
  mysql->affected_rows= ~(my_ulonglong) 0;

  if (mysql->last_used_con->server_status & SERVER_MORE_RESULTS_EXISTS)
unknown's avatar
unknown committed
5232 5233
    DBUG_RETURN((*mysql->methods->next_result)(mysql));

5234
  DBUG_RETURN(-1);				/* No more results */
5235
}
unknown's avatar
unknown committed
5236

5237

unknown's avatar
unknown committed
5238 5239 5240 5241 5242 5243 5244 5245 5246 5247
MYSQL_RES * STDCALL mysql_use_result(MYSQL *mysql)
{
  return (*mysql->methods->use_result)(mysql);
}

my_bool STDCALL mysql_read_query_result(MYSQL *mysql)
{
  return (*mysql->methods->read_query_result)(mysql);
}