libmysql.c 145 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(0);
211
  }
unknown's avatar
unknown committed
212
  else
unknown's avatar
unknown committed
213
  {
214
    free_charsets();
unknown's avatar
unknown committed
215
    mysql_thread_end();
unknown's avatar
unknown committed
216 217
  }

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

228
static MYSQL_PARAMETERS mysql_internal_parameters=
229
{&max_allowed_packet, &net_buffer_length, 0};
230

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

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

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

unknown's avatar
unknown committed
252 253 254 255
/*
  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.
*/
256 257 258 259 260
static MYSQL* spawn_init(MYSQL* parent, const char* host,
			 unsigned int port,
			 const char* user,
			 const char* passwd);

261

unknown's avatar
unknown committed
262 263

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

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;
  }
}


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

void STDCALL
unknown's avatar
unknown committed
293
mysql_debug(const char *debug __attribute__((unused)))
unknown's avatar
unknown committed
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
{
#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];
312 313
      buff[sizeof(buff)-1]= 0;
      strxnmov(buff,sizeof(buff)-1,"libmysql: ", env, NullS);
unknown's avatar
unknown committed
314 315 316 317 318 319 320 321 322
      MessageBox((HWND) 0,"Debugging variable MYSQL_DEBUG used",buff,MB_OK);
    }
#endif
  }
#endif
}


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

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

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

unknown's avatar
SCRUM  
unknown committed
346 347
my_bool STDCALL mysql_master_send_query(MYSQL *mysql, const char *q,
					unsigned long length)
unknown's avatar
unknown committed
348
{
unknown's avatar
SCRUM  
unknown committed
349 350 351 352
  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);
353
  master->reconnect= 1;
unknown's avatar
SCRUM  
unknown committed
354
  mysql->last_used_con = master;
355
  DBUG_RETURN(simple_command(master, COM_QUERY, (const uchar*) q, length, 1));
unknown's avatar
unknown committed
356 357 358
}


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


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

unknown's avatar
SCRUM  
unknown committed
376 377 378 379 380 381 382 383 384 385
  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
386
						    0,0,0,0))
unknown's avatar
SCRUM  
unknown committed
387
    DBUG_RETURN(1);
388
  slave_to_use->reconnect= 1;
389 390
  DBUG_RETURN(simple_command(slave_to_use, COM_QUERY, (const uchar*) q,
                             length, 1));
unknown's avatar
SCRUM  
unknown committed
391
}
unknown's avatar
unknown committed
392 393


unknown's avatar
SCRUM  
unknown committed
394 395 396
/* 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
397
{
unknown's avatar
SCRUM  
unknown committed
398
  mysql->options.rpl_parse = 1;
unknown's avatar
unknown committed
399 400
}

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

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

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

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

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

429 430 431 432 433

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

static void expand_error(MYSQL* mysql, int error)
437 438
{
  char tmp[MYSQL_ERRMSG_SIZE];
439 440
  char *p;
  uint err_length;
unknown's avatar
unknown committed
441 442 443
  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);
444
  strmake(p, tmp, MYSQL_ERRMSG_SIZE-1 - err_length);
unknown's avatar
unknown committed
445
  mysql->net.last_errno = error;
446 447
}

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

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

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

467 468 469 470

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

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

482 483 484
  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
485
    DBUG_RETURN(1);
486
  }
487
  mysql->reconnect= 1;
488 489

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

496
  switch (mysql_num_fields(res)) {
unknown's avatar
unknown committed
497 498 499 500 501 502 503 504
  case 5:
    has_auth_info = 0;
    port_ind=2;
    break;
  case 7:
    has_auth_info = 1;
    port_ind=4;
    break;
505 506 507 508 509 510 511 512 513 514 515
  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
516 517
      tmp_user = row[2];
      tmp_pass = row[3];
518 519 520 521 522 523 524
    }
    else
    {
      tmp_user = mysql->user;
      tmp_pass = mysql->passwd;
    }

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

529 530 531 532 533 534
    /* 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
535
  if (res)
unknown's avatar
unknown committed
536
    mysql_free_result(res);
unknown's avatar
unknown committed
537
  DBUG_RETURN(error);
538 539
}

540

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

548 549 550 551 552
  /*
    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
553
    a non-empty master host. However, it is more reliable to check
554
    for empty master than whether the slave thread is actually running
555
  */
556
  if (mysql_query(mysql, "SHOW SLAVE STATUS") ||
557
      !(res = mysql_store_result(mysql)))
558 559
  {
    expand_error(mysql, CR_PROBE_SLAVE_STATUS);
unknown's avatar
unknown committed
560
    DBUG_RETURN(1);
561
  }
unknown's avatar
unknown committed
562

563 564 565 566 567 568
  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]))
569 570
  {
    /* this is a slave, ask it for the master */
571
    if (get_master(mysql, res, row) || get_slaves_from_master(mysql))
572 573 574 575 576
      goto err;
  }
  else
  {
    mysql->master = mysql;
577
    if (get_slaves_from_master(mysql))
578 579 580 581 582
      goto err;
  }

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


589 590 591 592 593 594 595 596 597 598
/*
  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
599
*/
600

601 602
enum mysql_rpl_type
STDCALL mysql_rpl_query_type(const char* q, int len)
603
{
unknown's avatar
unknown committed
604
  const char *q_end= q + len;
605
  for (; q < q_end; ++q)
606 607
  {
    char c;
608
    if (my_isalpha(&my_charset_latin1, (c= *q)))
609
    {
610
      switch (my_tolower(&my_charset_latin1,c)) {
611 612 613 614 615 616 617
      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 */
618
	return my_tolower(&my_charset_latin1,q[1]) == 'h' ? MYSQL_RPL_ADMIN :
unknown's avatar
unknown committed
619
	  MYSQL_RPL_MASTER;
620
      case 's': /* select or show */
621
	return my_tolower(&my_charset_latin1,q[1]) == 'h' ? MYSQL_RPL_ADMIN :
unknown's avatar
unknown committed
622
	  MYSQL_RPL_SLAVE;
623 624 625
      case 'f': /* flush */
      case 'r': /* repair */
      case 'g': /* grant */
unknown's avatar
SCRUM  
unknown committed
626 627 628 629 630
	return MYSQL_RPL_ADMIN;
      default:
	return MYSQL_RPL_SLAVE;
      }
    }
unknown's avatar
unknown committed
631
  }
unknown's avatar
SCRUM  
unknown committed
632
  return MYSQL_RPL_MASTER;		/* By default, send to master */
unknown's avatar
unknown committed
633 634 635
}


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

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

661

unknown's avatar
unknown committed
662
/**************************************************************************
unknown's avatar
unknown committed
663
  Change user and database
unknown's avatar
unknown committed
664
**************************************************************************/
665

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

671
  pkt_length= cli_safe_read(mysql);
672 673 674 675 676 677 678 679 680 681 682 683
  
  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);
684 685
    if (my_net_write(net, (uchar*) buff, SCRAMBLE_LENGTH_323 + 1) ||
        net_flush(net))
686
    {
687
      set_mysql_error(mysql, CR_SERVER_LOST, unknown_sqlstate);
688 689 690
      return 1;
    }
    /* Read what server thinks about out new auth message report */
691
    if (cli_safe_read(mysql) == packet_error)
692 693 694 695
      return 1;
  }
  return 0;
}
unknown's avatar
unknown committed
696

unknown's avatar
unknown committed
697
my_bool	STDCALL mysql_change_user(MYSQL *mysql, const char *user,
unknown's avatar
unknown committed
698 699
				  const char *passwd, const char *db)
{
700 701
  char buff[USERNAME_LENGTH+SCRAMBLED_PASSWORD_CHAR_LENGTH+NAME_LEN+2];
  char *end= buff;
702
  int rc;
703 704
  CHARSET_INFO *saved_cs= mysql->charset;

unknown's avatar
unknown committed
705 706
  DBUG_ENTER("mysql_change_user");

707 708 709 710 711 712 713 714 715 716
  /* Get the connection-default character set. */

  if (mysql_init_character_set(mysql))
  {
    mysql->charset= saved_cs;
    DBUG_RETURN(TRUE);
  }

  /* Use an empty string instead of NULL. */

unknown's avatar
unknown committed
717 718 719 720
  if (!user)
    user="";
  if (!passwd)
    passwd="";
unknown's avatar
unknown committed
721

722 723 724 725
  /*
    Store user into the buffer.
    Advance position as strmake returns a pointer to the closing NUL.
  */
726
  end= strmake(end, user, USERNAME_LENGTH) + 1;
unknown's avatar
unknown committed
727

728 729
  /* write scrambled password according to server capabilities */
  if (passwd[0])
unknown's avatar
unknown committed
730
  {
unknown's avatar
unknown committed
731
    if (mysql->server_capabilities & CLIENT_SECURE_CONNECTION)
unknown's avatar
unknown committed
732
    {
unknown's avatar
unknown committed
733 734 735
      *end++= SCRAMBLE_LENGTH;
      scramble(end, mysql->scramble, passwd);
      end+= SCRAMBLE_LENGTH;
unknown's avatar
unknown committed
736
    }
unknown's avatar
unknown committed
737
    else
738 739 740
    {
      scramble_323(end, mysql->scramble, passwd);
      end+= SCRAMBLE_LENGTH_323 + 1;
unknown's avatar
unknown committed
741
    }
unknown's avatar
unknown committed
742 743
  }
  else
744
    *end++= '\0';                               /* empty password */
unknown's avatar
unknown committed
745
  /* Add database if needed */
746
  end= strmake(end, db ? db : "", NAME_LEN) + 1;
unknown's avatar
unknown committed
747

748 749 750 751
  /* Add character set number. */

  if (mysql->server_capabilities & CLIENT_SECURE_CONNECTION)
  {
752 753
    int2store(end, (ushort) mysql->charset->number);
    end+= 2;
754 755
  }

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

759 760 761 762 763 764
  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.
  */
765
  mysql_detach_stmt_list(&mysql->stmts, "mysql_change_user");
766 767 768 769 770 771 772 773 774 775 776 777
  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;
  }
778 779 780 781 782
  else
  {
    mysql->charset= saved_cs;
  }

783
  DBUG_RETURN(rc);
unknown's avatar
unknown committed
784 785
}

unknown's avatar
unknown committed
786 787 788 789 790 791
#if defined(HAVE_GETPWUID) && defined(NO_GETPWUID_DECL)
struct passwd *getpwuid(uid_t);
char* getlogin(void);
#endif

#if defined(__NETWARE__)
792
/* Default to value of USER on NetWare, if unset use "UNKNOWN_USER" */
unknown's avatar
unknown committed
793 794 795 796 797 798
void read_user_name(char *name)
{
  char *str=getenv("USER");
  strmake(name, str ? str : "UNKNOWN_USER", USERNAME_LENGTH);
}

799
#elif !defined(MSDOS) && ! defined(VMS) && !defined(__WIN__)
unknown's avatar
unknown committed
800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838

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

839
my_bool handle_local_infile(MYSQL *mysql, const char *net_filename)
unknown's avatar
unknown committed
840 841 842 843
{
  my_bool result= 1;
  uint packet_length=MY_ALIGN(mysql->net.max_packet-16,IO_SIZE);
  NET *net= &mysql->net;
844 845
  int readcount;
  void *li_ptr;          /* pass state to local_infile functions */
unknown's avatar
unknown committed
846
  char *buf;		/* buffer to be filled by local_infile_read */
unknown's avatar
unknown committed
847
  struct st_mysql_options *options= &mysql->options;
848 849 850
  DBUG_ENTER("handle_local_infile");

  /* check that we've got valid callback functions */
unknown's avatar
unknown committed
851 852 853 854
  if (!(options->local_infile_init &&
	options->local_infile_read &&
	options->local_infile_end &&
	options->local_infile_error))
unknown's avatar
unknown committed
855
  {
856
    /* if any of the functions is invalid, set the default */
unknown's avatar
unknown committed
857
    mysql_set_local_infile_default(mysql);
unknown's avatar
unknown committed
858 859
  }

860
  /* copy filename into local memory and allocate read buffer */
unknown's avatar
unknown committed
861 862
  if (!(buf=my_malloc(packet_length, MYF(0))))
  {
863
    set_mysql_error(mysql, CR_OUT_OF_MEMORY, unknown_sqlstate);
unknown's avatar
unknown committed
864 865
    DBUG_RETURN(1);
  }
866 867

  /* initialize local infile (open file, usually) */
868 869
  if ((*options->local_infile_init)(&li_ptr, net_filename,
    options->local_infile_userdata))
unknown's avatar
unknown committed
870
  {
871
    VOID(my_net_write(net,(const uchar*) "",0)); /* Server needs one packet */
unknown's avatar
unknown committed
872 873
    net_flush(net);
    strmov(net->sqlstate, unknown_sqlstate);
unknown's avatar
unknown committed
874
    net->last_errno=
875
      (*options->local_infile_error)(li_ptr,
unknown's avatar
unknown committed
876 877
                                     net->last_error,
                                     sizeof(net->last_error)-1);
unknown's avatar
unknown committed
878 879 880
    goto err;
  }

881
  /* read blocks of data from local infile callback */
unknown's avatar
unknown committed
882 883 884
  while ((readcount =
	  (*options->local_infile_read)(li_ptr, buf,
					packet_length)) > 0)
unknown's avatar
unknown committed
885
  {
886
    if (my_net_write(net, (uchar*) buf, readcount))
unknown's avatar
unknown committed
887
    {
unknown's avatar
unknown committed
888 889
      DBUG_PRINT("error",
		 ("Lost connection to MySQL server during LOAD DATA of local file"));
890
      set_mysql_error(mysql, CR_SERVER_LOST, unknown_sqlstate);
unknown's avatar
unknown committed
891 892 893
      goto err;
    }
  }
894

unknown's avatar
unknown committed
895
  /* Send empty packet to mark end of file */
896
  if (my_net_write(net, (const uchar*) "", 0) || net_flush(net))
unknown's avatar
unknown committed
897
  {
898
    set_mysql_error(mysql, CR_SERVER_LOST, unknown_sqlstate);
unknown's avatar
unknown committed
899 900
    goto err;
  }
901

unknown's avatar
unknown committed
902 903
  if (readcount < 0)
  {
unknown's avatar
unknown committed
904
    net->last_errno=
905
      (*options->local_infile_error)(li_ptr,
unknown's avatar
unknown committed
906 907
                                     net->last_error,
                                     sizeof(net->last_error)-1);
unknown's avatar
unknown committed
908 909
    goto err;
  }
910

unknown's avatar
unknown committed
911 912 913
  result=0;					/* Ok */

err:
914
  /* free up memory allocated with _init, usually */
unknown's avatar
unknown committed
915
  (*options->local_infile_end)(li_ptr);
916
  my_free(buf, MYF(0));
unknown's avatar
unknown committed
917
  DBUG_RETURN(result);
918 919 920
}


unknown's avatar
unknown committed
921 922 923 924 925 926
/****************************************************************************
  Default handlers for LOAD LOCAL INFILE
****************************************************************************/

typedef struct st_default_local_infile
{
927 928
  int fd;
  int error_num;
unknown's avatar
unknown committed
929
  const char *filename;
930 931 932 933
  char error_msg[LOCAL_INFILE_ERROR_LEN];
} default_local_infile_data;


unknown's avatar
unknown committed
934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951
/*
  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
*/

952 953
static int default_local_infile_init(void **ptr, const char *filename,
             void *userdata __attribute__ ((unused)))
954 955
{
  default_local_infile_data *data;
unknown's avatar
unknown committed
956
  char tmp_name[FN_REFLEN];
957 958

  if (!(*ptr= data= ((default_local_infile_data *)
unknown's avatar
unknown committed
959 960
		     my_malloc(sizeof(default_local_infile_data),  MYF(0)))))
    return 1; /* out of memory */
961 962 963

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

unknown's avatar
unknown committed
966 967
  fn_format(tmp_name, filename, "", "", MY_UNPACK_FILENAME);
  if ((data->fd = my_open(tmp_name, O_RDONLY, MYF(0))) < 0)
968
  {
unknown's avatar
unknown committed
969
    data->error_num= my_errno;
970
    my_snprintf(data->error_msg, sizeof(data->error_msg)-1,
unknown's avatar
unknown committed
971 972
                EE(EE_FILENOTFOUND), tmp_name, data->error_num);
    return 1;
973 974 975 976 977
  }
  return 0; /* ok */
}


unknown's avatar
unknown committed
978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993
/*
  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)
994
{
unknown's avatar
unknown committed
995 996
  int count;
  default_local_infile_data*data = (default_local_infile_data *) ptr;
997

998
  if ((count= (int) my_read(data->fd, (uchar *) buf, buf_len, MYF(0))) < 0)
unknown's avatar
unknown committed
999 1000 1001 1002 1003 1004 1005
  {
    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;
1006 1007 1008
}


unknown's avatar
unknown committed
1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
/*
  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)
1021
{
unknown's avatar
unknown committed
1022 1023
  default_local_infile_data *data= (default_local_infile_data *) ptr;
  if (data)					/* If not error on open */
1024
  {
unknown's avatar
unknown committed
1025 1026 1027
    if (data->fd >= 0)
      my_close(data->fd, MYF(MY_WME));
    my_free(ptr, MYF(MY_WME));
1028 1029 1030 1031
  }
}


unknown's avatar
unknown committed
1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046
/*
  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
1047 1048
default_local_infile_error(void *ptr, char *error_msg, uint error_msg_len)
{
unknown's avatar
unknown committed
1049 1050 1051
  default_local_infile_data *data = (default_local_infile_data *) ptr;
  if (data)					/* If not error on open */
  {
1052 1053 1054
    strmake(error_msg, data->error_msg, error_msg_len);
    return data->error_num;
  }
unknown's avatar
unknown committed
1055 1056 1057
  /* 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;
1058 1059 1060
}


unknown's avatar
unknown committed
1061
void
1062
mysql_set_local_infile_handler(MYSQL *mysql,
1063 1064
                               int (*local_infile_init)(void **, const char *,
                               void *),
1065
                               int (*local_infile_read)(void *, char *, uint),
unknown's avatar
unknown committed
1066
                               void (*local_infile_end)(void *),
1067 1068
                               int (*local_infile_error)(void *, char *, uint),
                               void *userdata)
1069
{
unknown's avatar
unknown committed
1070 1071 1072 1073
  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;
1074
  mysql->options.local_infile_userdata = userdata;
1075 1076 1077
}


unknown's avatar
unknown committed
1078
void mysql_set_local_infile_default(MYSQL *mysql)
1079 1080 1081 1082 1083
{
  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
1084 1085 1086
}


unknown's avatar
unknown committed
1087
/**************************************************************************
1088 1089
  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
1090 1091 1092 1093 1094 1095 1096 1097
**************************************************************************/

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

unknown's avatar
unknown committed
1098

1099
static MYSQL* spawn_init(MYSQL* parent, const char* host,
unknown's avatar
unknown committed
1100 1101
			 unsigned int port, const char* user,
			 const char* passwd)
1102 1103
{
  MYSQL* child;
1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119
  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
1120
  if (parent->db)
1121
    child->options.db= my_strdup(parent->db, MYF(0));
unknown's avatar
unknown committed
1122
  else if (parent->options.db)
1123
    child->options.db= my_strdup(parent->options.db, MYF(0));
1124

1125 1126 1127 1128 1129 1130
  /*
    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);
1131 1132 1133 1134 1135
}


int
STDCALL mysql_set_master(MYSQL* mysql, const char* host,
unknown's avatar
unknown committed
1136 1137
			 unsigned int port, const char* user,
			 const char* passwd)
1138 1139 1140
{
  if (mysql->master != mysql && !mysql->master->rpl_pivot)
    mysql_close(mysql->master);
unknown's avatar
unknown committed
1141
  if (!(mysql->master = spawn_init(mysql, host, port, user, passwd)))
1142 1143 1144 1145
    return 1;
  return 0;
}

1146

1147 1148
int
STDCALL mysql_add_slave(MYSQL* mysql, const char* host,
unknown's avatar
unknown committed
1149 1150 1151
			unsigned int port,
			const char* user,
			const char* passwd)
1152 1153
{
  MYSQL* slave;
unknown's avatar
unknown committed
1154
  if (!(slave = spawn_init(mysql, host, port, user, passwd)))
1155 1156 1157 1158 1159 1160
    return 1;
  slave->next_slave = mysql->next_slave;
  mysql->next_slave = slave;
  return 0;
}

unknown's avatar
unknown committed
1161
/**************************************************************************
1162
  Return next field of the query results
unknown's avatar
unknown committed
1163 1164 1165 1166 1167 1168 1169 1170 1171 1172
**************************************************************************/

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

1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189

/**************************************************************************
  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
1190
/*************************************************************************
1191 1192 1193
  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
1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213
*************************************************************************/

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;
}

1214

unknown's avatar
unknown committed
1215
/*****************************************************************************
1216
  List all databases
unknown's avatar
unknown committed
1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232
*****************************************************************************/

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));
}


/*****************************************************************************
1233 1234
  List all tables in a database
  If wild is given then only the tables matching wild is returned
unknown's avatar
unknown committed
1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248
*****************************************************************************/

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));
}

1249

unknown's avatar
unknown committed
1250
MYSQL_FIELD *cli_list_fields(MYSQL *mysql)
unknown's avatar
SCRUM  
unknown committed
1251 1252 1253 1254 1255 1256
{
  MYSQL_DATA *query;
  if (!(query= cli_read_rows(mysql,(MYSQL_FIELD*) 0, 
			     protocol_41(mysql) ? 8 : 6)))
    return NULL;

unknown's avatar
unknown committed
1257
  mysql->field_count= (uint) query->rows;
unknown's avatar
SCRUM  
unknown committed
1258
  return unpack_fields(query,&mysql->field_alloc,
unknown's avatar
unknown committed
1259
		       mysql->field_count, 1, mysql->server_capabilities);
unknown's avatar
SCRUM  
unknown committed
1260 1261 1262
}


unknown's avatar
unknown committed
1263
/**************************************************************************
1264 1265 1266 1267
  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
1268 1269 1270
**************************************************************************/

MYSQL_RES * STDCALL
unknown's avatar
SCRUM  
unknown committed
1271
mysql_list_fields(MYSQL *mysql, const char *table, const char *wild)
unknown's avatar
unknown committed
1272
{
unknown's avatar
SCRUM  
unknown committed
1273 1274
  MYSQL_RES   *result;
  MYSQL_FIELD *fields;
1275
  char	     buff[258],*end;
unknown's avatar
unknown committed
1276 1277 1278 1279
  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
1280
  free_old_query(mysql);
1281 1282
  if (simple_command(mysql, COM_FIELD_LIST, (uchar*) buff,
                     (ulong) (end-buff), 1) ||
unknown's avatar
SCRUM  
unknown committed
1283
      !(fields= (*mysql->methods->list_fields)(mysql)))
unknown's avatar
unknown committed
1284 1285 1286 1287 1288
    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
1289

1290
  result->methods= mysql->methods;
unknown's avatar
unknown committed
1291 1292
  result->field_alloc=mysql->field_alloc;
  mysql->fields=0;
unknown's avatar
SCRUM  
unknown committed
1293 1294
  result->field_count = mysql->field_count;
  result->fields= fields;
unknown's avatar
unknown committed
1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314
  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
1315 1316
  if (!(fields = (*mysql->methods->read_rows)(mysql,(MYSQL_FIELD*) 0,
					      protocol_41(mysql) ? 7 : 5)))
unknown's avatar
unknown committed
1317 1318
    DBUG_RETURN(NULL);
  if (!(mysql->fields=unpack_fields(fields,&mysql->field_alloc,field_count,0,
1319
				    mysql->server_capabilities)))
unknown's avatar
unknown committed
1320 1321 1322 1323 1324 1325
    DBUG_RETURN(0);
  mysql->status=MYSQL_STATUS_GET_RESULT;
  mysql->field_count=field_count;
  DBUG_RETURN(mysql_store_result(mysql));
}

1326

1327
#ifdef USE_OLD_FUNCTIONS
unknown's avatar
unknown committed
1328 1329 1330 1331 1332
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
1333
  DBUG_RETURN(simple_command(mysql,COM_CREATE_DB,db, (ulong) strlen(db),0));
unknown's avatar
unknown committed
1334 1335 1336 1337 1338 1339 1340 1341
}


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
1342
  DBUG_RETURN(simple_command(mysql,COM_DROP_DB,db,(ulong) strlen(db),0));
unknown's avatar
unknown committed
1343
}
1344
#endif
unknown's avatar
unknown committed
1345 1346 1347


int STDCALL
1348
mysql_shutdown(MYSQL *mysql, enum mysql_enum_shutdown_level shutdown_level)
unknown's avatar
unknown committed
1349
{
1350
  uchar level[1];
unknown's avatar
unknown committed
1351
  DBUG_ENTER("mysql_shutdown");
unknown's avatar
unknown committed
1352
  level[0]= (uchar) shutdown_level;
1353
  DBUG_RETURN(simple_command(mysql, COM_SHUTDOWN, level, 1, 0));
unknown's avatar
unknown committed
1354 1355 1356 1357 1358 1359 1360 1361 1362
}


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

1366

unknown's avatar
unknown committed
1367 1368 1369
int STDCALL
mysql_kill(MYSQL *mysql,ulong pid)
{
1370
  uchar buff[4];
unknown's avatar
unknown committed
1371 1372
  DBUG_ENTER("mysql_kill");
  int4store(buff,pid);
1373 1374 1375 1376 1377 1378 1379
  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)
{
1380
  uchar buff[2];
1381 1382 1383
  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
1384 1385 1386 1387 1388 1389 1390 1391 1392 1393
}


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

1394

unknown's avatar
unknown committed
1395
const char *cli_read_statistics(MYSQL *mysql)
unknown's avatar
unknown committed
1396 1397 1398 1399
{
  mysql->net.read_pos[mysql->packet_length]=0;	/* End of stat string */
  if (!mysql->net.read_pos[0])
  {
1400
    set_mysql_error(mysql, CR_WRONG_HOST_INFO, unknown_sqlstate);
unknown's avatar
unknown committed
1401
    return mysql->net.last_error;
unknown's avatar
unknown committed
1402
  }
unknown's avatar
unknown committed
1403 1404 1405
  return (char*) mysql->net.read_pos;
}

1406

unknown's avatar
unknown committed
1407 1408 1409 1410 1411
const char * STDCALL
mysql_stat(MYSQL *mysql)
{
  DBUG_ENTER("mysql_stat");
  if (simple_command(mysql,COM_STATISTICS,0,0,0))
unknown's avatar
unknown committed
1412
    DBUG_RETURN(mysql->net.last_error);
unknown's avatar
unknown committed
1413
  DBUG_RETURN((*mysql->methods->read_statistics)(mysql));
unknown's avatar
unknown committed
1414 1415 1416 1417 1418 1419
}


int STDCALL
mysql_ping(MYSQL *mysql)
{
1420
  int res;
unknown's avatar
unknown committed
1421
  DBUG_ENTER("mysql_ping");
1422 1423 1424 1425
  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
1426 1427 1428
}


unknown's avatar
unknown committed
1429
const char * STDCALL
unknown's avatar
unknown committed
1430 1431 1432 1433 1434 1435
mysql_get_server_info(MYSQL *mysql)
{
  return((char*) mysql->server_version);
}


unknown's avatar
unknown committed
1436
const char * STDCALL
unknown's avatar
unknown committed
1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448
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
1449
const char * STDCALL
unknown's avatar
unknown committed
1450 1451 1452 1453 1454
mysql_get_client_info(void)
{
  return (char*) MYSQL_SERVER_VERSION;
}

unknown's avatar
unknown committed
1455 1456 1457 1458 1459
ulong STDCALL mysql_get_client_version(void)
{
  return MYSQL_VERSION_ID;
}

unknown's avatar
unknown committed
1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474
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
1475
MYSQL_ROW_OFFSET STDCALL mysql_row_tell(MYSQL_RES *res)
unknown's avatar
unknown committed
1476 1477 1478 1479
{
  return res->data_cursor;
}

unknown's avatar
unknown committed
1480
MYSQL_FIELD_OFFSET STDCALL mysql_field_tell(MYSQL_RES *res)
unknown's avatar
unknown committed
1481 1482 1483 1484 1485 1486 1487 1488
{
  return (res)->current_field;
}

/* MYSQL */

unsigned int STDCALL mysql_field_count(MYSQL *mysql)
{
1489
  return mysql->last_used_con->field_count;
unknown's avatar
unknown committed
1490 1491 1492 1493
}

my_ulonglong STDCALL mysql_affected_rows(MYSQL *mysql)
{
1494
  return mysql->last_used_con->affected_rows;
unknown's avatar
unknown committed
1495 1496 1497 1498
}

my_ulonglong STDCALL mysql_insert_id(MYSQL *mysql)
{
1499
  return mysql->last_used_con->insert_id;
unknown's avatar
unknown committed
1500 1501
}

1502 1503
const char *STDCALL mysql_sqlstate(MYSQL *mysql)
{
1504
  return mysql ? mysql->net.sqlstate : cant_connect_sqlstate;
1505 1506
}

1507 1508 1509 1510 1511
uint STDCALL mysql_warning_count(MYSQL *mysql)
{
  return mysql->warning_count;
}

unknown's avatar
unknown committed
1512
const char *STDCALL mysql_info(MYSQL *mysql)
unknown's avatar
unknown committed
1513
{
1514
  return mysql->info;
unknown's avatar
unknown committed
1515 1516 1517 1518 1519 1520 1521 1522 1523
}

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
1524
  return mysql->charset->csname;
unknown's avatar
unknown committed
1525 1526
}

1527
void STDCALL mysql_get_character_set_info(MYSQL *mysql, MY_CHARSET_INFO *csinfo)
unknown's avatar
unknown committed
1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541
{
  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
1542

unknown's avatar
unknown committed
1543 1544 1545 1546 1547 1548 1549 1550 1551
uint STDCALL mysql_thread_safe(void)
{
#ifdef THREAD
  return 1;
#else
  return 0;
#endif
}

1552 1553 1554 1555 1556 1557 1558 1559 1560 1561

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

unknown's avatar
unknown committed
1562
/****************************************************************************
1563
  Some support functions
unknown's avatar
unknown committed
1564 1565
****************************************************************************/

unknown's avatar
unknown committed
1566 1567 1568 1569 1570 1571 1572
/*
  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;
1573 1574
  my_net_set_read_timeout(net, CLIENT_NET_READ_TIMEOUT);
  my_net_set_write_timeout(net, CLIENT_NET_WRITE_TIMEOUT);
1575
  net->retry_count=  1;
unknown's avatar
unknown committed
1576 1577 1578
  net->max_packet_size= max(net_buffer_length, max_allowed_packet);
}

unknown's avatar
unknown committed
1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598
/*
  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
1599 1600
ulong STDCALL
mysql_hex_string(char *to, const char *from, ulong length)
unknown's avatar
unknown committed
1601 1602 1603 1604 1605 1606
{
  char *to0= to;
  const char *end;
            
  for (end= from + length; from < end; from++)
  {
unknown's avatar
unknown committed
1607 1608
    *to++= _dig_vec_upper[((unsigned char) *from) >> 4];
    *to++= _dig_vec_upper[((unsigned char) *from) & 0x0F];
unknown's avatar
unknown committed
1609 1610 1611 1612 1613
  }
  *to= '\0';
  return (ulong) (to-to0);
}

unknown's avatar
unknown committed
1614
/*
1615 1616 1617
  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
1618 1619 1620 1621 1622
*/

ulong STDCALL
mysql_escape_string(char *to,const char *from,ulong length)
{
1623
  return (uint) escape_string_for_mysql(default_charset_info, to, 0, from, length);
unknown's avatar
unknown committed
1624 1625 1626 1627 1628 1629
}

ulong STDCALL
mysql_real_escape_string(MYSQL *mysql, char *to,const char *from,
			 ulong length)
{
1630
  if (mysql->server_status & SERVER_STATUS_NO_BACKSLASH_ESCAPES)
1631 1632
    return (uint) escape_quotes_for_mysql(mysql->charset, to, 0, from, length);
  return (uint) escape_string_for_mysql(mysql->charset, to, 0, from, length);
unknown's avatar
unknown committed
1633 1634 1635 1636 1637 1638 1639 1640
}

void STDCALL
myodbc_remove_escape(MYSQL *mysql,char *name)
{
  char *to;
#ifdef USE_MB
  my_bool use_mb_flag=use_mb(mysql->charset);
1641
  char *UNINIT_VAR(end);
unknown's avatar
unknown committed
1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663
  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;
}
1664 1665

/********************************************************************
1666
 Implementation of new client API for 4.1 version.
1667

1668
 mysql_stmt_* are real prototypes used by applications.
1669

1670 1671 1672 1673 1674
 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.
1675 1676
*********************************************************************/

1677
/******************* Declarations ***********************************/
1678

1679
/* Default number of rows fetched per one COM_STMT_FETCH command. */
1680

unknown's avatar
unknown committed
1681
#define DEFAULT_PREFETCH_ROWS (ulong) 1
1682

1683
/*
1684 1685 1686 1687 1688
  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)
1689 1690
*/

1691 1692
static int stmt_read_row_unbuffered(MYSQL_STMT *stmt, unsigned char **row);
static int stmt_read_row_buffered(MYSQL_STMT *stmt, unsigned char **row);
1693
static int stmt_read_row_from_cursor(MYSQL_STMT *stmt, unsigned char **row);
1694
static int stmt_read_row_no_data(MYSQL_STMT *stmt, unsigned char **row);
unknown's avatar
unknown committed
1695
static int stmt_read_row_no_result_set(MYSQL_STMT *stmt, unsigned char **row);
1696

1697 1698 1699 1700 1701
/*
  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);
1702
static my_bool setup_one_fetch_function(MYSQL_BIND *, MYSQL_FIELD *field);
1703

1704 1705 1706 1707
/* Auxilary function used to reset statement handle. */

#define RESET_SERVER_SIDE 1
#define RESET_LONG_DATA 2
1708
#define RESET_STORE_RESULT 4
1709
#define RESET_CLEAR_ERROR 8
1710 1711 1712

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

1713 1714 1715 1716 1717 1718
/*
  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) */
1719
#define MAX_DATE_REP_LENGTH 5
1720 1721 1722 1723 1724

/*
  1 (length) + 1 (is negative) + 4 (day count) + 1 (hour)
  + 1 (minute) + 1 (seconds) + 4 (microseconds)
*/
1725
#define MAX_TIME_REP_LENGTH 13
1726 1727 1728 1729 1730

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

1733
#define MAX_DOUBLE_STRING_REP_LENGTH 331
1734

1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748
/* 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

1749
/**************** Misc utility functions ****************************/
1750 1751

/*
1752
  Reallocate the NET package to have at least length bytes available.
1753

1754
  SYNPOSIS
1755 1756 1757 1758
    my_realloc_str()
    net                 The NET structure to modify.
    length              Ensure that net->buff has space for at least
                        this number of bytes.
1759

1760
  RETURN VALUES
1761 1762 1763
    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.
1764 1765
*/

1766
static my_bool my_realloc_str(NET *net, ulong length)
1767
{
1768 1769 1770 1771
  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)
1772
  {
1773
    res= net_realloc(net, buf_length + length);
1774 1775 1776
    if (res)
    {
      strmov(net->sqlstate, unknown_sqlstate);
unknown's avatar
unknown committed
1777
      strmov(net->last_error, ER(net->last_errno));
1778
    }
1779
    net->write_pos= net->buff+ buf_length;
1780
  }
1781
  DBUG_RETURN(res);
1782 1783 1784
}


1785 1786 1787 1788 1789 1790 1791 1792 1793 1794
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);
  }
}

1795
/**
1796 1797 1798 1799
  Set statement error code, sqlstate, and error message
  from given errcode and sqlstate.
*/

1800 1801
void set_stmt_error(MYSQL_STMT * stmt, int errcode,
                    const char *sqlstate, const char *err)
1802 1803 1804 1805 1806
{
  DBUG_ENTER("set_stmt_error");
  DBUG_PRINT("enter", ("error: %d '%s'", errcode, ER(errcode)));
  DBUG_ASSERT(stmt != 0);

1807 1808 1809
  if (err == 0)
    err= ER(errcode);

1810 1811 1812 1813 1814 1815 1816 1817
  stmt->last_errno= errcode;
  strmov(stmt->last_error, ER(errcode));
  strmov(stmt->sqlstate, sqlstate);

  DBUG_VOID_RETURN;
}


1818 1819 1820 1821 1822
/**
  Set statement error code, sqlstate, and error message from NET.

  @param stmt  a statement handle. Copy the error here.
  @param net   mysql->net. Source of the error.
1823 1824
*/

1825
void set_stmt_errmsg(MYSQL_STMT *stmt, NET *net)
1826 1827
{
  DBUG_ENTER("set_stmt_errmsg");
1828
  DBUG_PRINT("enter", ("error: %d/%s '%s'",
unknown's avatar
unknown committed
1829
                       net->last_errno,
1830
                       net->sqlstate,
unknown's avatar
unknown committed
1831
                       net->last_error));
1832 1833
  DBUG_ASSERT(stmt != 0);

unknown's avatar
unknown committed
1834 1835 1836
  stmt->last_errno= net->last_errno;
  if (net->last_error && net->last_error[0])
    strmov(stmt->last_error, net->last_error);
1837
  strmov(stmt->sqlstate, net->sqlstate);
1838 1839 1840

  DBUG_VOID_RETURN;
}
1841

1842
/*
1843
  Read and unpack server reply to COM_STMT_PREPARE command (sent from
1844
  mysql_stmt_prepare).
1845

1846 1847 1848 1849
  SYNOPSIS
    cli_read_prepare_result()
    mysql   connection handle
    stmt    statement handle
1850 1851 1852 1853

  RETURN VALUES
    0	ok
    1	error
1854 1855
*/

unknown's avatar
unknown committed
1856
my_bool cli_read_prepare_result(MYSQL *mysql, MYSQL_STMT *stmt)
1857 1858
{
  uchar *pos;
1859 1860
  uint field_count, param_count;
  ulong packet_length;
1861
  MYSQL_DATA *fields_data;
1862
  DBUG_ENTER("cli_read_prepare_result");
1863

1864
  mysql= mysql->last_used_con;
1865
  if ((packet_length= cli_safe_read(mysql)) == packet_error)
1866
    DBUG_RETURN(1);
unknown's avatar
unknown committed
1867
  mysql->warning_count= 0;
1868

1869
  pos= (uchar*) mysql->net.read_pos;
1870
  stmt->stmt_id= uint4korr(pos+1); pos+= 5;
1871
  /* Number of columns in result set */
1872
  field_count=   uint2korr(pos);   pos+= 2;
1873
  /* Number of placeholders in the statement */
1874
  param_count=   uint2korr(pos);   pos+= 2;
unknown's avatar
unknown committed
1875 1876
  if (packet_length >= 12)
    mysql->warning_count= uint2korr(pos+1);
1877

1878 1879 1880 1881 1882 1883 1884 1885 1886 1887
  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);
  }

1888 1889 1890 1891
  if (field_count != 0)
  {
    if (!(mysql->server_status & SERVER_STATUS_AUTOCOMMIT))
      mysql->server_status|= SERVER_STATUS_IN_TRANS;
1892

unknown's avatar
SCRUM  
unknown committed
1893
    if (!(fields_data= (*mysql->methods->read_rows)(mysql,(MYSQL_FIELD*)0,7)))
1894 1895 1896 1897 1898 1899
      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
1900
  stmt->field_count=  field_count;
1901
  stmt->param_count=  (ulong) param_count;
unknown's avatar
unknown committed
1902 1903
  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
1904

1905 1906 1907 1908 1909
  DBUG_RETURN(0);
}


/*
1910 1911
  Allocate memory and init prepared statement structure.

1912 1913
  SYNOPSIS
    mysql_stmt_init()
1914 1915 1916 1917 1918 1919 1920
    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
1921
    handle provided to this call: its lifetime is limited by lifetime
1922 1923 1924 1925 1926 1927
    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
1928
    - close statement handle and free its memory (mysql_stmt_close()),
1929 1930 1931 1932 1933
    - 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).
1934

1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952
  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);
  }

1953
  init_alloc_root(&stmt->mem_root, 2048, 2048);
1954 1955
  init_alloc_root(&stmt->result.alloc, 4096, 4096);
  stmt->result.alloc.min_malloc= sizeof(MYSQL_ROWS);
1956 1957
  mysql->stmts= list_add(mysql->stmts, &stmt->list);
  stmt->list.data= stmt;
1958
  stmt->state= MYSQL_STMT_INIT_DONE;
1959
  stmt->mysql= mysql;
unknown's avatar
unknown committed
1960
  stmt->read_row_func= stmt_read_row_no_result_set;
1961
  stmt->prefetch_rows= DEFAULT_PREFETCH_ROWS;
1962
  strmov(stmt->sqlstate, not_error_sqlstate);
1963
  /* The rest of statement members was bzeroed inside malloc */
1964 1965 1966 1967

  DBUG_RETURN(stmt);
}

1968

1969
/*
1970 1971
  Prepare server side statement with query.

1972 1973
  SYNOPSIS
    mysql_stmt_prepare()
1974 1975 1976
    stmt    statement handle
    query   statement to prepare
    length  statement length
1977 1978

  DESCRIPTION
1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991
    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
1992
    structure on the server and free old statement data
1993
  - then send the query to server and get back number of placeholders,
1994
    number of columns in result set (if any), and result set metadata.
1995
    At the same time allocate memory for input and output parameters
1996
    to have less checks in mysql_stmt_bind_{param, result}.
1997

1998 1999
  RETURN VALUES
    0  success
2000
   !0  error
2001 2002
*/

2003 2004
int STDCALL
mysql_stmt_prepare(MYSQL_STMT *stmt, const char *query, ulong length)
2005
{
2006 2007 2008
  MYSQL *mysql= stmt->mysql;
  DBUG_ENTER("mysql_stmt_prepare");

2009
  if (!mysql)
2010
  {
2011
    /* mysql can be reset in mysql_close called from mysql_reconnect */
2012
    set_stmt_error(stmt, CR_SERVER_LOST, unknown_sqlstate, NULL);
2013
    DBUG_RETURN(1);
2014
  }
2015

2016 2017 2018 2019 2020 2021 2022
  /*
    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';

2023 2024 2025
  if ((int) stmt->state > (int) MYSQL_STMT_INIT_DONE)
  {
    /* This is second prepare with another statement */
2026
    uchar buff[MYSQL_STMT_HEADER];               /* 4 bytes - stmt id */
2027

2028
    if (reset_stmt_handle(stmt, RESET_LONG_DATA | RESET_STORE_RESULT))
2029
      DBUG_RETURN(1);
2030
    /*
2031
      These members must be reset for API to
2032 2033 2034 2035 2036 2037 2038
      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);
2039

2040
    /*
2041 2042
      Close statement in server

2043 2044 2045 2046
      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.
    */
2047
    stmt->state= MYSQL_STMT_INIT_DONE;
2048
    if (stmt_command(mysql, COM_STMT_CLOSE, buff, 4, stmt))
2049
    {
2050
      set_stmt_errmsg(stmt, &mysql->net);
2051 2052 2053 2054
      DBUG_RETURN(1);
    }
  }

2055
  if (stmt_command(mysql, COM_STMT_PREPARE, (const uchar*) query, length, stmt))
2056
  {
2057
    set_stmt_errmsg(stmt, &mysql->net);
2058
    DBUG_RETURN(1);
2059 2060
  }

unknown's avatar
SCRUM  
unknown committed
2061
  if ((*mysql->methods->read_prepare_result)(mysql, stmt))
2062
  {
2063
    set_stmt_errmsg(stmt, &mysql->net);
2064
    DBUG_RETURN(1);
2065
  }
unknown's avatar
unknown committed
2066

2067
  /*
2068
    alloc_root will return valid address even in case when param_count
2069 2070 2071 2072
    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
2073 2074
  if (!(stmt->params= (MYSQL_BIND *) alloc_root(&stmt->mem_root,
						sizeof(MYSQL_BIND)*
2075
                                                (stmt->param_count +
unknown's avatar
unknown committed
2076 2077
                                                 stmt->field_count))))
  {
2078
    set_stmt_error(stmt, CR_OUT_OF_MEMORY, unknown_sqlstate, NULL);
2079
    DBUG_RETURN(1);
unknown's avatar
unknown committed
2080 2081
  }
  stmt->bind= stmt->params + stmt->param_count;
2082
  stmt->state= MYSQL_STMT_PREPARE_DONE;
unknown's avatar
unknown committed
2083
  DBUG_PRINT("info", ("Parameter count: %u", stmt->param_count));
2084
  DBUG_RETURN(0);
2085 2086
}

2087
/*
2088 2089 2090 2091
  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.
2092 2093
*/

2094
static void alloc_stmt_fields(MYSQL_STMT *stmt)
2095
{
2096 2097
  MYSQL_FIELD *fields, *field, *end;
  MEM_ROOT *alloc= &stmt->mem_root;
unknown's avatar
unknown committed
2098
  MYSQL *mysql= stmt->mysql->last_used_con;
2099

unknown's avatar
unknown committed
2100
  stmt->field_count= mysql->field_count;
2101

2102
  /*
2103
    Get the field information for non-select statements
2104 2105
    like SHOW and DESCRIBE commands
  */
2106
  if (!(stmt->fields= (MYSQL_FIELD *) alloc_root(alloc,
2107
						 sizeof(MYSQL_FIELD) *
2108 2109
						 stmt->field_count)) ||
      !(stmt->bind= (MYSQL_BIND *) alloc_root(alloc,
2110 2111
					      sizeof(MYSQL_BIND) *
					      stmt->field_count)))
2112 2113 2114 2115
  {
    set_stmt_error(stmt, CR_OUT_OF_MEMORY, unknown_sqlstate, NULL);
    return;
  }
2116 2117

  for (fields= mysql->fields, end= fields+stmt->field_count,
2118
	 field= stmt->fields;
2119 2120 2121 2122 2123 2124 2125
       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);
2126
    field->charsetnr= fields->charsetnr;
2127 2128 2129 2130 2131 2132 2133
    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;
  }
2134
}
2135

2136

2137
/**
2138
  Update result set columns metadata if it was sent again in
2139
  reply to COM_STMT_EXECUTE.
2140 2141 2142

  @note If the new field count is different from the original one,
        an error is set and no update is performed.
2143 2144 2145 2146 2147 2148 2149
*/

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;
2150
  MYSQL_BIND *my_bind= stmt->bind_result_done ? stmt->bind : 0;
2151

2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167
  if (stmt->field_count != stmt->mysql->field_count)
  {
    /*
      The tables used in the statement were altered,
      and the query now returns a different number of columns.
      There is no way to continue without reallocating the bind
      array:
      - if the number of columns increased, mysql_stmt_fetch()
      will write beyond allocated memory
      - if the number of columns decreased, some user-bound
      buffers will be left unassigned without user knowing
      that.
    */
    set_stmt_error(stmt, CR_NEW_STMT_METADATA, unknown_sqlstate, NULL);
    return;
  }
2168 2169 2170 2171 2172 2173 2174 2175

  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;
2176
    if (my_bind)
2177 2178
    {
      /* Ignore return value: it should be 0 if bind_result succeeded. */
2179
      (void) setup_one_fetch_function(my_bind++, stmt_field);
2180
    }
2181 2182 2183
  }
}

2184
/*
2185 2186 2187 2188 2189 2190 2191 2192 2193
  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
2194
    mysql_stmt_field_count(): if number of fields is not zero, you can call
2195 2196 2197 2198
    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
2199
      mysql_stmt_field_count())
2200 2201 2202 2203
    - 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.
2204 2205 2206 2207 2208 2209

  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
2210 2211 2212
*/

MYSQL_RES * STDCALL
2213
mysql_stmt_result_metadata(MYSQL_STMT *stmt)
2214 2215
{
  MYSQL_RES *result;
2216
  DBUG_ENTER("mysql_stmt_result_metadata");
2217

2218 2219 2220 2221 2222 2223 2224 2225 2226
  /*
    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))))
2227
  {
2228
    set_stmt_error(stmt, CR_OUT_OF_MEMORY, unknown_sqlstate, NULL);
2229 2230
    DBUG_RETURN(0);
  }
unknown's avatar
unknown committed
2231

2232 2233
  result->methods=	stmt->mysql->methods;
  result->eof=		1;                      /* Marker for buffered */
2234 2235
  result->fields=	stmt->fields;
  result->field_count=	stmt->field_count;
2236
  /* The rest of members of 'result' was bzeroed inside malloc */
2237
  DBUG_RETURN(result);
2238 2239
}

2240

2241
/*
2242 2243
  Returns parameter columns meta information in the form of
  result set.
2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256

  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.
2257 2258 2259
*/

MYSQL_RES * STDCALL
2260
mysql_stmt_param_metadata(MYSQL_STMT *stmt)
2261
{
2262
  DBUG_ENTER("mysql_stmt_param_metadata");
2263

2264 2265 2266 2267
  if (!stmt->param_count)
    DBUG_RETURN(0);

  /*
2268 2269
    TODO: Fix this when server sends the information.
    Till then keep a dummy prototype.
2270 2271 2272 2273 2274
  */
  DBUG_RETURN(0); 
}


2275 2276
/* Store type of parameter in network buffer. */

2277
static void store_param_type(unsigned char **pos, MYSQL_BIND *param)
2278 2279 2280 2281 2282 2283 2284
{
  uint typecode= param->buffer_type | (param->is_unsigned ? 32768 : 0);
  int2store(*pos, typecode);
  *pos+= 2;
}


2285 2286
/*
  Functions to store parameter data in network packet.
2287

2288 2289 2290 2291 2292
  SYNOPSIS
    store_param_xxx()
    net			MySQL NET connection
    param		MySQL bind param

2293
  DESCRIPTION
2294 2295 2296 2297 2298
    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).
2299
*/
2300 2301 2302

static void store_param_tinyint(NET *net, MYSQL_BIND *param)
{
2303
  *(net->write_pos++)= *(uchar *) param->buffer;
2304 2305
}

2306 2307 2308 2309 2310 2311
static void store_param_short(NET *net, MYSQL_BIND *param)
{
  short value= *(short*) param->buffer;
  int2store(net->write_pos,value);
  net->write_pos+=2;
}
2312

2313
static void store_param_int32(NET *net, MYSQL_BIND *param)
2314
{
2315 2316 2317 2318
  int32 value= *(int32*) param->buffer;
  int4store(net->write_pos,value);
  net->write_pos+=4;
}
2319

2320 2321 2322 2323 2324 2325
static void store_param_int64(NET *net, MYSQL_BIND *param)
{
  longlong value= *(longlong*) param->buffer;
  int8store(net->write_pos,value);
  net->write_pos+= 8;
}
2326

2327 2328 2329 2330 2331
static void store_param_float(NET *net, MYSQL_BIND *param)
{
  float value= *(float*) param->buffer;
  float4store(net->write_pos, value);
  net->write_pos+= 4;
2332 2333
}

2334 2335 2336 2337 2338 2339
static void store_param_double(NET *net, MYSQL_BIND *param)
{
  double value= *(double*) param->buffer;
  float8store(net->write_pos, value);
  net->write_pos+= 8;
}
2340

unknown's avatar
unknown committed
2341 2342 2343
static void store_param_time(NET *net, MYSQL_BIND *param)
{
  MYSQL_TIME *tm= (MYSQL_TIME *) param->buffer;
2344
  char buff[MAX_TIME_REP_LENGTH], *pos;
unknown's avatar
unknown committed
2345 2346 2347 2348 2349 2350 2351 2352 2353 2354
  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)
2355
    length= 12;
unknown's avatar
unknown committed
2356 2357 2358 2359
  else if (tm->hour || tm->minute || tm->second || tm->day)
    length= 8;
  else
    length= 0;
2360
  buff[0]= (char) length++;
unknown's avatar
unknown committed
2361 2362 2363 2364 2365 2366
  memcpy((char *)net->write_pos, buff, length);
  net->write_pos+= length;
}

static void net_store_datetime(NET *net, MYSQL_TIME *tm)
{
2367
  char buff[MAX_DATETIME_REP_LENGTH], *pos;
unknown's avatar
unknown committed
2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386
  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;
2387
  buff[0]= (char) length++;
unknown's avatar
unknown committed
2388 2389 2390 2391 2392 2393
  memcpy((char *)net->write_pos, buff, length);
  net->write_pos+= length;
}

static void store_param_date(NET *net, MYSQL_BIND *param)
{
2394 2395 2396
  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
2397 2398 2399 2400 2401 2402 2403
}

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

2405
static void store_param_str(NET *net, MYSQL_BIND *param)
2406
{
2407 2408
  /* param->length is always set in mysql_stmt_bind_param */
  ulong length= *param->length;
2409
  uchar *to= net_store_length(net->write_pos, length);
2410
  memcpy(to, param->buffer, length);
2411
  net->write_pos= to+length;
2412 2413
}

2414

2415
/*
2416 2417 2418 2419 2420 2421 2422 2423 2424
  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
2425 2426
    if a parameter is NULL. Unlike bit string in result set row, here
    we don't have reserved bits for OK/error packet.
2427 2428
*/

2429
static void store_param_null(NET *net, MYSQL_BIND *param)
2430
{
2431
  uint pos= param->param_number;
unknown's avatar
unknown committed
2432
  net->buff[pos/8]|=  (uchar) (1 << (pos & 7));
2433
}
2434 2435 2436


/*
2437 2438 2439
  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.
2440 2441
*/

2442
static my_bool store_param(MYSQL_STMT *stmt, MYSQL_BIND *param)
2443
{
2444
  NET *net= &stmt->mysql->net;
2445
  DBUG_ENTER("store_param");
unknown's avatar
unknown committed
2446
  DBUG_PRINT("enter",("type: %d  buffer: 0x%lx  length: %lu  is_null: %d",
unknown's avatar
unknown committed
2447
		      param->buffer_type,
unknown's avatar
unknown committed
2448 2449
		      (long) (param->buffer ? param->buffer : NullS),
                      *param->length, *param->is_null));
unknown's avatar
unknown committed
2450 2451

  if (*param->is_null)
2452 2453
    store_param_null(net, param);
  else
unknown's avatar
unknown committed
2454
  {
unknown's avatar
unknown committed
2455 2456
    /*
      Param->length should ALWAYS point to the correct length for the type
2457
      Either to the length pointer given by the user or param->buffer_length
unknown's avatar
unknown committed
2458
    */
2459
    if ((my_realloc_str(net, *param->length)))
unknown's avatar
unknown committed
2460
    {
2461
      set_stmt_errmsg(stmt, net);
unknown's avatar
unknown committed
2462
      DBUG_RETURN(1);
unknown's avatar
unknown committed
2463
    }
2464
    (*param->store_param_func)(net, param);
unknown's avatar
unknown committed
2465 2466
  }
  DBUG_RETURN(0);
2467 2468
}

unknown's avatar
unknown committed
2469

2470
/*
2471
  Auxilary function to send COM_STMT_EXECUTE packet to server and read reply.
2472
  Used from cli_stmt_execute, which is in turn used by mysql_stmt_execute.
2473 2474
*/

2475
static my_bool execute(MYSQL_STMT *stmt, char *packet, ulong length)
2476
{
2477 2478
  MYSQL *mysql= stmt->mysql;
  NET	*net= &mysql->net;
2479 2480
  uchar buff[4 /* size of stmt id */ +
             5 /* execution flags */];
2481
  my_bool res;
2482
  DBUG_ENTER("execute");
unknown's avatar
unknown committed
2483
  DBUG_DUMP("packet", (uchar *) packet, length);
2484

2485 2486
  mysql->last_used_con= mysql;
  int4store(buff, stmt->stmt_id);		/* Send stmt id to server */
2487
  buff[4]= (char) stmt->flags;
2488
  int4store(buff+5, 1);                         /* iteration count */
2489

2490
  res= test(cli_advanced_command(mysql, COM_STMT_EXECUTE, buff, sizeof(buff),
2491
                                 (uchar*) packet, length, 1, stmt) ||
2492 2493
            (*mysql->methods->read_query_result)(mysql));
  stmt->affected_rows= mysql->affected_rows;
2494
  stmt->server_status= mysql->server_status;
2495 2496
  stmt->insert_id= mysql->insert_id;
  if (res)
2497
  {
2498 2499 2500 2501 2502 2503
    /* 
      Don't set stmt error if stmt->mysql is NULL, as the error in this case 
      has already been set by mysql_prune_stmt_list(). 
    */
    if (stmt->mysql)
      set_stmt_errmsg(stmt, net);
2504
    DBUG_RETURN(1);
2505 2506 2507 2508
  }
  DBUG_RETURN(0);
}

unknown's avatar
unknown committed
2509 2510

int cli_stmt_execute(MYSQL_STMT *stmt)
2511
{
unknown's avatar
SCRUM  
unknown committed
2512
  DBUG_ENTER("cli_stmt_execute");
2513 2514 2515

  if (stmt->param_count)
  {
2516 2517
    MYSQL *mysql= stmt->mysql;
    NET        *net= &mysql->net;
2518
    MYSQL_BIND *param, *param_end;
2519
    char       *param_data;
unknown's avatar
unknown committed
2520 2521 2522
    ulong length;
    uint null_count;
    my_bool    result;
2523

2524 2525
    if (!stmt->bind_param_done)
    {
2526
      set_stmt_error(stmt, CR_PARAMS_NOT_BOUND, unknown_sqlstate, NULL);
2527 2528
      DBUG_RETURN(1);
    }
2529 2530
    if (mysql->status != MYSQL_STATUS_READY ||
        mysql->server_status & SERVER_MORE_RESULTS_EXISTS)
2531
    {
2532
      set_stmt_error(stmt, CR_COMMANDS_OUT_OF_SYNC, unknown_sqlstate, NULL);
2533 2534
      DBUG_RETURN(1);
    }
2535

2536
    net_clear(net, 1);				/* Sets net->write_pos */
2537 2538
    /* Reserve place for null-marker bytes */
    null_count= (stmt->param_count+7) /8;
2539 2540
    if (my_realloc_str(net, null_count + 1))
    {
2541
      set_stmt_errmsg(stmt, net);
2542 2543
      DBUG_RETURN(1);
    }
2544 2545 2546 2547 2548
    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
2549 2550
    *(net->write_pos)++= (uchar) stmt->send_types_to_server;
    if (stmt->send_types_to_server)
2551
    {
2552 2553
      if (my_realloc_str(net, 2 * stmt->param_count))
      {
2554
        set_stmt_errmsg(stmt, net);
2555 2556
        DBUG_RETURN(1);
      }
2557 2558 2559 2560 2561
      /*
	Store types of parameters in first in first package
	that is sent to the server.
      */
      for (param= stmt->params;	param < param_end ; param++)
2562
        store_param_type(&net->write_pos, param);
2563 2564 2565
    }

    for (param= stmt->params; param < param_end; param++)
2566
    {
2567
      /* check if mysql_stmt_send_long_data() was used */
unknown's avatar
unknown committed
2568 2569
      if (param->long_data_used)
	param->long_data_used= 0;	/* Clear for next execute call */
2570
      else if (store_param(stmt, param))
unknown's avatar
unknown committed
2571
	DBUG_RETURN(1);
2572
    }
2573 2574
    length= (ulong) (net->write_pos - net->buff);
    /* TODO: Look into avoding the following memdup */
2575
    if (!(param_data= my_memdup(net->buff, length, MYF(0))))
2576
    {
2577
      set_stmt_error(stmt, CR_OUT_OF_MEMORY, unknown_sqlstate, NULL);
2578
      DBUG_RETURN(1);
2579
    }
2580
    result= execute(stmt, param_data, length);
unknown's avatar
unknown committed
2581
    stmt->send_types_to_server=0;
2582
    my_free(param_data, MYF(MY_WME));
2583 2584 2585
    DBUG_RETURN(result);
  }
  DBUG_RETURN((int) execute(stmt,0,0));
2586 2587
}

2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601
/*
  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)
{
2602
  if (stmt->data_cursor)
2603
  {
2604 2605
    *row= (uchar *) stmt->data_cursor->data;
    stmt->data_cursor= stmt->data_cursor->next;
2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625
    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
2626
                  stmt->last_{errno,error}; *row is not changed
2627
  MYSQL_NO_DATA - end of file was read from network;
2628
                  *row is set to NULL
2629 2630 2631 2632 2633 2634
*/

static int stmt_read_row_unbuffered(MYSQL_STMT *stmt, unsigned char **row)
{
  int rc= 1;
  MYSQL *mysql= stmt->mysql;
2635
  /*
2636 2637 2638 2639 2640
    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)
  {
2641
    set_stmt_error(stmt, CR_SERVER_LOST, unknown_sqlstate, NULL);
2642 2643 2644 2645 2646
    return 1;
  }
  if (mysql->status != MYSQL_STATUS_GET_RESULT)
  {
    set_stmt_error(stmt, stmt->unbuffered_fetch_cancelled ?
unknown's avatar
unknown committed
2647
                   CR_FETCH_CANCELED : CR_COMMANDS_OUT_OF_SYNC,
2648
                   unknown_sqlstate, NULL);
2649 2650 2651 2652
    goto error;
  }
  if ((*mysql->methods->unbuffered_fetch)(mysql, (char**) row))
  {
2653
    set_stmt_errmsg(stmt, &mysql->net);
2654 2655 2656 2657 2658 2659 2660
    /*
      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;
2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675
    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;
}

2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700

/*
  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;
2701 2702
    uchar buff[4 /* statement id */ +
               4 /* number of rows to fetch */];
2703 2704 2705 2706 2707 2708

    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);
2709
    int4store(buff + 4, stmt->prefetch_rows); /* number of rows to fetch */
2710
    if ((*mysql->methods->advanced_command)(mysql, COM_STMT_FETCH,
2711
                                            buff, sizeof(buff), (uchar*) 0, 0,
2712
                                            1, stmt))
2713
    {
2714 2715 2716 2717 2718 2719
      /* 
        Don't set stmt error if stmt->mysql is NULL, as the error in this case 
        has already been set by mysql_prune_stmt_list(). 
      */
      if (stmt->mysql)
        set_stmt_errmsg(stmt, net);
2720 2721
      return 1;
    }
2722
    if ((*mysql->methods->read_rows_from_cursor)(stmt))
2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733
      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;
}


2734 2735 2736 2737 2738 2739 2740 2741
/*
  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
2742 2743 2744 2745 2746 2747 2748
{
  return MYSQL_NO_DATA;
}

static int
stmt_read_row_no_result_set(MYSQL_STMT *stmt  __attribute__((unused)),
                      unsigned char **row  __attribute__((unused)))
2749
{
2750
  set_stmt_error(stmt, CR_NO_RESULT_SET, unknown_sqlstate, NULL);
2751
  return 1;
2752 2753
}

2754 2755 2756 2757 2758 2759 2760 2761

/*
  Get/set statement attributes

  SYNOPSIS
    mysql_stmt_attr_get()
    mysql_stmt_attr_set()

unknown's avatar
unknown committed
2762
    attr_type  statement attribute
2763 2764 2765 2766 2767 2768
    value      casted to const void * pointer to value.

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

2770 2771 2772 2773 2774 2775 2776 2777
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;
2778
  case STMT_ATTR_CURSOR_TYPE:
2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792
  {
    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;
2793
    break;
2794
  }
2795
  default:
2796
    goto err_not_implemented;
2797 2798
  }
  return FALSE;
2799
err_not_implemented:
2800
  set_stmt_error(stmt, CR_NOT_IMPLEMENTED, unknown_sqlstate, NULL);
2801
  return TRUE;
2802 2803 2804
}


2805
my_bool STDCALL mysql_stmt_attr_get(MYSQL_STMT *stmt,
2806 2807 2808 2809 2810
                                    enum enum_stmt_attr_type attr_type,
                                    void *value)
{
  switch (attr_type) {
  case STMT_ATTR_UPDATE_MAX_LENGTH:
2811
    *(my_bool*) value= stmt->update_max_length;
2812
    break;
2813
  case STMT_ATTR_CURSOR_TYPE:
2814
    *(ulong*) value= stmt->flags;
2815
    break;
2816 2817 2818
  case STMT_ATTR_PREFETCH_ROWS:
    *(ulong*) value= stmt->prefetch_rows;
    break;
2819
  default:
2820 2821 2822 2823 2824 2825
    return TRUE;
  }
  return FALSE;
}


2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869
/**
  Update statement result set metadata from with the new field
  information sent during statement execute.

  @pre mysql->field_count is not zero

  @retval TRUE   if error: out of memory or the new
                 result set has a different number of columns
  @retval FALSE  success
*/

static void reinit_result_set_metadata(MYSQL_STMT *stmt)
{
  /* 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
      COM_STMT_EXECUTE (even if it is not necessary), so either this or
      previous branch always works.
      TODO: send metadata only when it's really necessary and add a warning
      'Metadata changed' when it's sent twice.
      */
    update_stmt_fields(stmt);
  }
}


unknown's avatar
SCRUM  
unknown committed
2870
/*
2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911
  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
2912 2913
*/

2914
int STDCALL mysql_stmt_execute(MYSQL_STMT *stmt)
unknown's avatar
SCRUM  
unknown committed
2915
{
2916
  MYSQL *mysql= stmt->mysql;
2917
  DBUG_ENTER("mysql_stmt_execute");
unknown's avatar
SCRUM  
unknown committed
2918

2919 2920
  if (!mysql)
  {
2921
    /* Error is already set in mysql_detatch_stmt_list */
unknown's avatar
SCRUM  
unknown committed
2922
    DBUG_RETURN(1);
2923 2924
  }

2925
  if (reset_stmt_handle(stmt, RESET_STORE_RESULT | RESET_CLEAR_ERROR))
2926
    DBUG_RETURN(1);
2927 2928
  /*
    No need to check for stmt->state: if the statement wasn't
unknown's avatar
unknown committed
2929
    prepared we'll get 'unknown statement handler' error from server.
2930 2931 2932 2933
  */
  if (mysql->methods->stmt_execute(stmt))
    DBUG_RETURN(1);
  stmt->state= MYSQL_STMT_EXECUTE_DONE;
2934
  if (mysql->field_count)
2935
  {
2936
    reinit_result_set_metadata(stmt);
2937 2938 2939 2940 2941
    if (stmt->server_status & SERVER_STATUS_CURSOR_EXISTS)
    {
      mysql->status= MYSQL_STATUS_READY;
      stmt->read_row_func= stmt_read_row_from_cursor;
    }
2942 2943 2944 2945 2946 2947 2948 2949 2950
    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.
      */
2951
      mysql_stmt_store_result(stmt);
2952
    }
2953 2954 2955 2956 2957 2958
    else
    {
      stmt->mysql->unbuffered_fetch_owner= &stmt->unbuffered_fetch_cancelled;
      stmt->unbuffered_fetch_cancelled= FALSE;
      stmt->read_row_func= stmt_read_row_unbuffered;
    }
2959
  }
2960
  DBUG_RETURN(test(stmt->last_errno));
unknown's avatar
SCRUM  
unknown committed
2961 2962
}

2963

2964 2965 2966 2967
/*
  Return total parameters count in the statement
*/

2968
ulong STDCALL mysql_stmt_param_count(MYSQL_STMT * stmt)
2969
{
2970
  DBUG_ENTER("mysql_stmt_param_count");
2971 2972 2973
  DBUG_RETURN(stmt->param_count);
}

2974 2975 2976 2977 2978 2979
/*
  Return total affected rows from the last statement
*/

my_ulonglong STDCALL mysql_stmt_affected_rows(MYSQL_STMT *stmt)
{
2980
  return stmt->affected_rows;
2981
}
2982

unknown's avatar
unknown committed
2983

unknown's avatar
unknown committed
2984 2985 2986 2987 2988 2989 2990 2991 2992 2993
/*
  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;
}

2994
/*
2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007
  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.
3008 3009 3010 3011 3012 3013 3014
*/

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

3015

unknown's avatar
unknown committed
3016 3017 3018
static my_bool int_is_null_true= 1;		/* Used for MYSQL_TYPE_NULL */
static my_bool int_is_null_false= 0;

3019

3020
/*
3021
  Set up input data buffers for a statement.
3022 3023 3024 3025 3026

  SYNOPSIS
    mysql_stmt_bind_param()
    stmt    statement handle
            The statement must be prepared with mysql_stmt_prepare().
3027
    my_bind Array of mysql_stmt_param_count() bind parameters.
3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042
            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
3043
    bind structure before setting its members. This will both shorten
3044 3045
    your application code and make it robust to future extensions of
    MYSQL_BIND structure.
3046
    Then you need to assign typecode of your application buffer to
3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 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
    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:

3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 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
    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.
3162 3163 3164 3165 3166

    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
3167
    data in pieces, examples in tests/mysql_client_test.c.
3168 3169 3170 3171 3172 3173 3174 3175 3176 3177
    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
3178 3179
    to call this routine after each assignment to bind buffers, you
    need to call it each time you change parameter typecodes, or other
3180 3181 3182
    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.
3183 3184 3185 3186

  RETURN
    0  success
    1  error, can be retrieved with mysql_stmt_error.
3187 3188
*/

3189
my_bool STDCALL mysql_stmt_bind_param(MYSQL_STMT *stmt, MYSQL_BIND *my_bind)
3190
{
3191 3192
  uint count=0;
  MYSQL_BIND *param, *end;
3193
  DBUG_ENTER("mysql_stmt_bind_param");
3194

3195 3196 3197 3198
  if (!stmt->param_count)
  {
    if ((int) stmt->state < (int) MYSQL_STMT_PREPARE_DONE)
    {
3199
      set_stmt_error(stmt, CR_NO_PREPARE_STMT, unknown_sqlstate, NULL);
3200 3201 3202 3203 3204
      DBUG_RETURN(1);
    }
    DBUG_RETURN(0);
  }

3205
  /* Allocated on prepare */
3206
  memcpy((char*) stmt->params, (char*) my_bind,
3207 3208 3209 3210 3211
	 sizeof(MYSQL_BIND) * stmt->param_count);

  for (param= stmt->params, end= param+stmt->param_count;
       param < end ;
       param++)
3212
  {
3213
    param->param_number= count++;
3214 3215
    param->long_data_used= 0;

unknown's avatar
unknown committed
3216 3217 3218 3219
    /* 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;

3220 3221
    /* Setup data copy functions for the different supported types */
    switch (param->buffer_type) {
unknown's avatar
unknown committed
3222
    case MYSQL_TYPE_NULL:
unknown's avatar
unknown committed
3223
      param->is_null= &int_is_null_true;
unknown's avatar
unknown committed
3224
      break;
3225
    case MYSQL_TYPE_TINY:
unknown's avatar
unknown committed
3226
      /* Force param->length as this is fixed for this type */
3227 3228
      param->length= &param->buffer_length;
      param->buffer_length= 1;
3229 3230 3231
      param->store_param_func= store_param_tinyint;
      break;
    case MYSQL_TYPE_SHORT:
3232 3233
      param->length= &param->buffer_length;
      param->buffer_length= 2;
3234 3235 3236
      param->store_param_func= store_param_short;
      break;
    case MYSQL_TYPE_LONG:
3237 3238
      param->length= &param->buffer_length;
      param->buffer_length= 4;
3239 3240 3241
      param->store_param_func= store_param_int32;
      break;
    case MYSQL_TYPE_LONGLONG:
3242 3243
      param->length= &param->buffer_length;
      param->buffer_length= 8;
3244 3245 3246
      param->store_param_func= store_param_int64;
      break;
    case MYSQL_TYPE_FLOAT:
3247 3248
      param->length= &param->buffer_length;
      param->buffer_length= 4;
3249 3250 3251
      param->store_param_func= store_param_float;
      break;
    case MYSQL_TYPE_DOUBLE:
3252 3253
      param->length= &param->buffer_length;
      param->buffer_length= 8;
3254 3255
      param->store_param_func= store_param_double;
      break;
unknown's avatar
unknown committed
3256 3257
    case MYSQL_TYPE_TIME:
      param->store_param_func= store_param_time;
3258
      param->buffer_length= MAX_TIME_REP_LENGTH;
unknown's avatar
unknown committed
3259 3260 3261
      break;
    case MYSQL_TYPE_DATE:
      param->store_param_func= store_param_date;
3262
      param->buffer_length= MAX_DATE_REP_LENGTH;
unknown's avatar
unknown committed
3263 3264 3265 3266
      break;
    case MYSQL_TYPE_DATETIME:
    case MYSQL_TYPE_TIMESTAMP:
      param->store_param_func= store_param_datetime;
3267
      param->buffer_length= MAX_DATETIME_REP_LENGTH;
unknown's avatar
unknown committed
3268
      break;
3269 3270 3271
    case MYSQL_TYPE_TINY_BLOB:
    case MYSQL_TYPE_MEDIUM_BLOB:
    case MYSQL_TYPE_LONG_BLOB:
unknown's avatar
unknown committed
3272
    case MYSQL_TYPE_BLOB:
3273
    case MYSQL_TYPE_VARCHAR:
3274 3275
    case MYSQL_TYPE_VAR_STRING:
    case MYSQL_TYPE_STRING:
unknown's avatar
unknown committed
3276 3277
    case MYSQL_TYPE_DECIMAL:
    case MYSQL_TYPE_NEWDECIMAL:
3278
      param->store_param_func= store_param_str;
3279
      /*
3280 3281
        For variable length types user must set either length or
        buffer_length.
3282
      */
3283 3284
      break;
    default:
3285
      strmov(stmt->sqlstate, unknown_sqlstate);
unknown's avatar
unknown committed
3286 3287
      sprintf(stmt->last_error,
	      ER(stmt->last_errno= CR_UNSUPPORTED_PARAM_TYPE),
3288
	      param->buffer_type, count);
3289
      DBUG_RETURN(1);
3290
    }
3291 3292 3293 3294 3295 3296
    /*
      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;
3297
  }
3298
  /* We have to send/resend type information to MySQL */
3299 3300
  stmt->send_types_to_server= TRUE;
  stmt->bind_param_done= TRUE;
3301 3302 3303
  DBUG_RETURN(0);
}

3304

3305 3306 3307 3308 3309
/********************************************************************
 Long data implementation
*********************************************************************/

/*
3310 3311 3312
  Send long data in pieces to the server

  SYNOPSIS
3313
    mysql_stmt_send_long_data()
3314 3315 3316 3317
    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
3318

3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342
  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.

3343
  RETURN VALUES
unknown's avatar
unknown committed
3344 3345
    0	ok
    1	error
3346 3347
*/

3348
my_bool STDCALL
3349
mysql_stmt_send_long_data(MYSQL_STMT *stmt, uint param_number,
unknown's avatar
unknown committed
3350
		     const char *data, ulong length)
3351 3352
{
  MYSQL_BIND *param;
3353
  DBUG_ENTER("mysql_stmt_send_long_data");
3354
  DBUG_ASSERT(stmt != 0);
unknown's avatar
unknown committed
3355 3356
  DBUG_PRINT("enter",("param no: %d  data: 0x%lx, length : %ld",
		      param_number, (long) data, length));
3357

3358 3359 3360 3361 3362 3363
  /*
    We only need to check for stmt->param_count, if it's not null
    prepare was done.
  */
  if (param_number >= stmt->param_count)
  {
3364
    set_stmt_error(stmt, CR_INVALID_PARAMETER_NO, unknown_sqlstate, NULL);
3365 3366
    DBUG_RETURN(1);
  }
3367

3368
  param= stmt->params+param_number;
3369
  if (!IS_LONGDATA(param->buffer_type))
unknown's avatar
unknown committed
3370
  {
3371
    /* Long data handling should be used only for string/binary types */
3372
    strmov(stmt->sqlstate, unknown_sqlstate);
unknown's avatar
unknown committed
3373 3374 3375 3376
    sprintf(stmt->last_error, ER(stmt->last_errno= CR_INVALID_BUFFER_USE),
	    param->param_number);
    DBUG_RETURN(1);
  }
3377

3378
  /*
3379 3380 3381
    Send long data packet if there is data or we're sending long data
    for the first time.
  */
3382
  if (length || param->long_data_used == 0)
3383
  {
3384
    MYSQL *mysql= stmt->mysql;
3385
    /* Packet header: stmt id (4 bytes), param no (2 bytes) */
3386
    uchar buff[MYSQL_LONG_DATA_HEADER];
3387

3388 3389
    int4store(buff, stmt->stmt_id);
    int2store(buff + 4, param_number);
3390 3391
    param->long_data_used= 1;

3392 3393 3394 3395
    /*
      Note that we don't get any ok packet from the server in this case
      This is intentional to save bandwidth.
    */
3396
    if ((*mysql->methods->advanced_command)(mysql, COM_STMT_SEND_LONG_DATA,
3397
                                            buff, sizeof(buff), (uchar*) data,
3398
                                            length, 1, stmt))
3399
    {
3400 3401 3402 3403 3404 3405
      /* 
        Don't set stmt error if stmt->mysql is NULL, as the error in this case 
        has already been set by mysql_prune_stmt_list(). 
      */
      if (stmt->mysql)
        set_stmt_errmsg(stmt, &mysql->net);
3406 3407 3408 3409 3410 3411
      DBUG_RETURN(1);
    }
  }
  DBUG_RETURN(0);
}

3412

3413
/********************************************************************
3414
 Fetch and conversion of result set rows (binary protocol).
3415 3416
*********************************************************************/

3417 3418 3419 3420 3421 3422 3423 3424
/*
  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
3425 3426
          These functions increase pos to point to the beginning of the
          next column.
3427 3428 3429 3430 3431 3432

  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
3433
static void read_binary_time(MYSQL_TIME *tm, uchar **pos)
unknown's avatar
unknown committed
3434
{
3435
  /* net_field_length will set pos to the first byte of data */
unknown's avatar
unknown committed
3436 3437 3438
  uint length= net_field_length(pos);

  if (length)
unknown's avatar
unknown committed
3439 3440
  {
    uchar *to= *pos;
3441
    tm->neg=    to[0];
unknown's avatar
unknown committed
3442

unknown's avatar
unknown committed
3443 3444 3445 3446 3447 3448
    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;
3449 3450 3451 3452 3453 3454
    if (tm->day)
    {
      /* Convert days to hours at once */
      tm->hour+= tm->day*24;
      tm->day= 0;
    }
3455 3456
    tm->time_type= MYSQL_TIMESTAMP_TIME;

unknown's avatar
unknown committed
3457
    *pos+= length;
unknown's avatar
unknown committed
3458
  }
unknown's avatar
unknown committed
3459
  else
3460
    set_zero_time(tm, MYSQL_TIMESTAMP_TIME);
unknown's avatar
unknown committed
3461 3462
}

unknown's avatar
unknown committed
3463
static void read_binary_datetime(MYSQL_TIME *tm, uchar **pos)
unknown's avatar
unknown committed
3464
{
unknown's avatar
unknown committed
3465
  uint length= net_field_length(pos);
3466

unknown's avatar
unknown committed
3467
  if (length)
unknown's avatar
unknown committed
3468 3469
  {
    uchar *to= *pos;
3470

unknown's avatar
unknown committed
3471 3472 3473 3474
    tm->neg=    0;
    tm->year=   (uint) sint2korr(to);
    tm->month=  (uint) to[2];
    tm->day=    (uint) to[3];
3475

unknown's avatar
unknown committed
3476 3477 3478 3479 3480 3481 3482 3483 3484
    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;
3485
    tm->time_type= MYSQL_TIMESTAMP_DATETIME;
unknown's avatar
unknown committed
3486 3487

    *pos+= length;
unknown's avatar
unknown committed
3488
  }
unknown's avatar
unknown committed
3489
  else
3490
    set_zero_time(tm, MYSQL_TIMESTAMP_DATETIME);
unknown's avatar
unknown committed
3491 3492
}

unknown's avatar
unknown committed
3493
static void read_binary_date(MYSQL_TIME *tm, uchar **pos)
unknown's avatar
unknown committed
3494
{
unknown's avatar
unknown committed
3495
  uint length= net_field_length(pos);
3496

unknown's avatar
unknown committed
3497
  if (length)
unknown's avatar
unknown committed
3498 3499 3500 3501 3502
  {
    uchar *to= *pos;
    tm->year =  (uint) sint2korr(to);
    tm->month=  (uint) to[2];
    tm->day= (uint) to[3];
unknown's avatar
unknown committed
3503

unknown's avatar
unknown committed
3504 3505 3506
    tm->hour= tm->minute= tm->second= 0;
    tm->second_part= 0;
    tm->neg= 0;
3507
    tm->time_type= MYSQL_TIMESTAMP_DATE;
unknown's avatar
unknown committed
3508 3509

    *pos+= length;
unknown's avatar
unknown committed
3510
  }
unknown's avatar
unknown committed
3511
  else
3512
    set_zero_time(tm, MYSQL_TIMESTAMP_DATE);
3513 3514
}

3515

unknown's avatar
unknown committed
3516 3517 3518 3519 3520 3521 3522 3523 3524
/*
  Convert string to supplied buffer of any type.

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

unknown's avatar
unknown committed
3526 3527
static void fetch_string_with_conversion(MYSQL_BIND *param, char *value,
                                         uint length)
3528
{
3529
  char *buffer= (char *)param->buffer;
unknown's avatar
unknown committed
3530
  int err= 0;
3531
  char *endptr= value + length;
3532

unknown's avatar
unknown committed
3533 3534 3535 3536
  /*
    This function should support all target buffer types: the rest
    of conversion functions can delegate conversion to it.
  */
3537
  switch (param->buffer_type) {
unknown's avatar
unknown committed
3538 3539
  case MYSQL_TYPE_NULL: /* do nothing */
    break;
3540
  case MYSQL_TYPE_TINY:
unknown's avatar
unknown committed
3541
  {
3542
    longlong data= my_strtoll10(value, &endptr, &err);
3543
    *param->error= (IS_TRUNCATED(data, param->is_unsigned,
3544
                                 INT_MIN8, INT_MAX8, UINT_MAX8) || err > 0);
3545
    *buffer= (uchar) data;
3546
    break;
unknown's avatar
unknown committed
3547
  }
3548
  case MYSQL_TYPE_SHORT:
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_MIN16, INT_MAX16, UINT_MAX16) || err > 0);
3553
    shortstore(buffer, (short) data);
3554
    break;
unknown's avatar
unknown committed
3555
  }
3556
  case MYSQL_TYPE_LONG:
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_MIN32, INT_MAX32, UINT_MAX32) || err > 0);
3561
    longstore(buffer, (int32) data);
3562
    break;
unknown's avatar
unknown committed
3563
  }
3564
  case MYSQL_TYPE_LONGLONG:
unknown's avatar
unknown committed
3565
  {
3566 3567 3568
    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
3569
    longlongstore(buffer, data);
3570
    break;
unknown's avatar
unknown committed
3571
  }
3572
  case MYSQL_TYPE_FLOAT:
3573
  {
3574 3575 3576 3577
    double data= my_strntod(&my_charset_latin1, value, length, &endptr, &err);
    float fdata= (float) data;
    *param->error= (fdata != data) | test(err);
    floatstore(buffer, fdata);
3578 3579
    break;
  }
3580
  case MYSQL_TYPE_DOUBLE:
3581
  {
3582 3583
    double data= my_strntod(&my_charset_latin1, value, length, &endptr, &err);
    *param->error= test(err);
3584
    doublestore(buffer, data);
3585 3586
    break;
  }
unknown's avatar
unknown committed
3587 3588 3589 3590
  case MYSQL_TYPE_TIME:
  {
    MYSQL_TIME *tm= (MYSQL_TIME *)buffer;
    str_to_time(value, length, tm, &err);
3591
    *param->error= test(err);
unknown's avatar
unknown committed
3592 3593 3594 3595
    break;
  }
  case MYSQL_TYPE_DATE:
  case MYSQL_TYPE_DATETIME:
3596
  case MYSQL_TYPE_TIMESTAMP:
unknown's avatar
unknown committed
3597 3598
  {
    MYSQL_TIME *tm= (MYSQL_TIME *)buffer;
3599
    (void) str_to_datetime(value, length, tm, TIME_FUZZY_DATE, &err);
3600 3601
    *param->error= test(err) && (param->buffer_type == MYSQL_TYPE_DATE &&
                                 tm->time_type != MYSQL_TIMESTAMP_DATE);
unknown's avatar
unknown committed
3602 3603 3604 3605 3606 3607
    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
3608 3609
  case MYSQL_TYPE_DECIMAL:
  case MYSQL_TYPE_NEWDECIMAL:
3610
  default:
3611
  {
unknown's avatar
unknown committed
3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625
    /*
      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
3626
    else
unknown's avatar
unknown committed
3627 3628 3629
      copy_length= 0;
    if (copy_length < param->buffer_length)
      buffer[copy_length]= '\0';
3630
    *param->error= copy_length > param->buffer_length;
unknown's avatar
unknown committed
3631 3632 3633 3634
    /*
      param->length will always contain length of entire column;
      number of copied bytes may be way different:
    */
3635
    *param->length= length;
unknown's avatar
unknown committed
3636
    break;
3637
  }
3638
  }
3639 3640
}

3641

unknown's avatar
unknown committed
3642 3643
/*
  Convert integer value to client buffer of any type.
3644

unknown's avatar
unknown committed
3645 3646 3647 3648 3649 3650
  SYNOPSIS
    fetch_long_with_conversion()
    param   output buffer descriptor
    field   column metadata
    value   column data
*/
3651

unknown's avatar
unknown committed
3652
static void fetch_long_with_conversion(MYSQL_BIND *param, MYSQL_FIELD *field,
3653
                                       longlong value, my_bool is_unsigned)
3654
{
3655
  char *buffer= (char *)param->buffer;
3656

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

    if (field->flags & ZEROFILL_FLAG && length < field->length &&
        field->length < 21)
    {
3738 3739
      bmove_upp(buff+field->length,buff+length, length);
      bfill(buff, field->length - length,'0');
3740 3741
      length= field->length;
    }
3742
    fetch_string_with_conversion(param, (char*) buff, length);
unknown's avatar
unknown committed
3743
    break;
unknown's avatar
unknown committed
3744
  }
3745
  }
3746 3747
}

unknown's avatar
unknown committed
3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758
/*
  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
3759

unknown's avatar
unknown committed
3760 3761
static void fetch_float_with_conversion(MYSQL_BIND *param, MYSQL_FIELD *field,
                                        double value, int width)
3762
{
3763
  char *buffer= (char *)param->buffer;
3764
  double val64 = (value < 0 ? -floor(-value) : floor(value));
3765

unknown's avatar
unknown committed
3766
  switch (param->buffer_type) {
unknown's avatar
unknown committed
3767 3768
  case MYSQL_TYPE_NULL: /* do nothing */
    break;
3769
  case MYSQL_TYPE_TINY:
3770 3771 3772 3773 3774 3775
    /*
      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.
    */
3776
    if (param->is_unsigned)
3777
      *buffer= (uint8) value;
3778
    else
3779
      *buffer= (int8) value;
3780 3781
    *param->error= val64 != (param->is_unsigned ? (double)((uint8) *buffer) :
                                                  (double)((int8) *buffer));
3782 3783
    break;
  case MYSQL_TYPE_SHORT:
3784 3785 3786 3787 3788 3789 3790 3791 3792 3793
    if (param->is_unsigned)
    {
      ushort data= (ushort) value;
      shortstore(buffer, data);
    }
    else
    {
      short data= (short) value;
      shortstore(buffer, data);
    }
3794
    *param->error= val64 != (param->is_unsigned ? (double) (*(ushort*) buffer):
3795
                                                  (double) (*(short*) buffer));
3796 3797
    break;
  case MYSQL_TYPE_LONG:
3798 3799 3800 3801 3802 3803 3804 3805 3806 3807
    if (param->is_unsigned)
    {
      uint32 data= (uint32) value;
      longstore(buffer, data);
    }
    else
    {
      int32 data= (int32) value;
      longstore(buffer, data);
    }
3808
    *param->error= val64 != (param->is_unsigned ? (double) (*(uint32*) buffer):
3809 3810
                                                  (double) (*(int32*) buffer));
      break;
3811
  case MYSQL_TYPE_LONGLONG:
3812 3813 3814 3815 3816 3817 3818 3819 3820 3821
    if (param->is_unsigned)
    {
      ulonglong data= (ulonglong) value;
      longlongstore(buffer, data);
    }
    else
    {
      longlong data= (longlong) value;
      longlongstore(buffer, data);
    }
3822
    *param->error= val64 != (param->is_unsigned ?
unknown's avatar
unknown committed
3823
                             ulonglong2double(*(ulonglong*) buffer) :
3824
                             (double) (*(longlong*) buffer));
3825 3826 3827
    break;
  case MYSQL_TYPE_FLOAT:
  {
unknown's avatar
unknown committed
3828
    float data= (float) value;
3829
    floatstore(buffer, data);
3830
    *param->error= (*(float*) buffer) != value;
3831 3832 3833 3834
    break;
  }
  case MYSQL_TYPE_DOUBLE:
  {
unknown's avatar
unknown committed
3835
    doublestore(buffer, value);
3836 3837
    break;
  }
3838
  default:
3839
  {
unknown's avatar
unknown committed
3840 3841 3842 3843 3844
    /*
      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
    */
3845
    char buff[MAX_DOUBLE_STRING_REP_LENGTH];
unknown's avatar
unknown committed
3846 3847 3848
    char *end;
    /* TODO: move this to a header shared between client and server. */
#define NOT_FIXED_DEC  31
unknown's avatar
unknown committed
3849
    if (field->decimals >= NOT_FIXED_DEC)
unknown's avatar
unknown committed
3850 3851
#undef NOT_FIXED_DEC
    {
3852
      /*
3853
        DBL_DIG below is to ensure that the server and client has the same
3854 3855 3856 3857 3858
        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),
3859
              min(DBL_DIG, width), value);
unknown's avatar
unknown committed
3860 3861 3862
      end= strcend(buff, ' ');
      *end= 0;
    }
unknown's avatar
unknown committed
3863
    else
unknown's avatar
unknown committed
3864
    {
unknown's avatar
unknown committed
3865
      sprintf(buff, "%.*f", (int) field->decimals, value);
unknown's avatar
unknown committed
3866 3867
      end= strend(buff);
    }
3868

3869
    {
3870 3871 3872 3873
      size_t length= end - buff;
      if (field->flags & ZEROFILL_FLAG && length < field->length &&
          field->length < MAX_DOUBLE_STRING_REP_LENGTH - 1)
      {
3874 3875
        bmove_upp((uchar*) buff + field->length, (uchar*) buff + length,
                  length);
3876 3877 3878 3879
        bfill((char*) buff, field->length - length, '0');
        length= field->length;
      }
      fetch_string_with_conversion(param, buff, length);
3880
    }
3881

3882 3883
    break;
  }
unknown's avatar
unknown committed
3884
  }
3885 3886
}

unknown's avatar
unknown committed
3887

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

unknown's avatar
unknown committed
3953

unknown's avatar
unknown committed
3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968
/*
  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.
*/
3969

unknown's avatar
unknown committed
3970 3971
static void fetch_result_with_conversion(MYSQL_BIND *param, MYSQL_FIELD *field,
                                         uchar **row)
3972
{
unknown's avatar
unknown committed
3973
  enum enum_field_types field_type= field->type;
unknown's avatar
unknown committed
3974
  uint field_is_unsigned= field->flags & UNSIGNED_FLAG;
unknown's avatar
unknown committed
3975

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

unknown's avatar
unknown committed
4035
    read_binary_date(&tm, row);
4036
    fetch_datetime_with_conversion(param, field, &tm);
4037 4038 4039 4040
    break;
  }
  case MYSQL_TYPE_TIME:
  {
unknown's avatar
unknown committed
4041
    MYSQL_TIME tm;
4042

unknown's avatar
unknown committed
4043
    read_binary_time(&tm, row);
4044
    fetch_datetime_with_conversion(param, field, &tm);
unknown's avatar
unknown committed
4045 4046 4047 4048 4049 4050
    break;
  }
  case MYSQL_TYPE_DATETIME:
  case MYSQL_TYPE_TIMESTAMP:
  {
    MYSQL_TIME tm;
4051

unknown's avatar
unknown committed
4052
    read_binary_datetime(&tm, row);
4053
    fetch_datetime_with_conversion(param, field, &tm);
4054 4055
    break;
  }
4056
  default:
unknown's avatar
unknown committed
4057 4058
  {
    ulong length= net_field_length(row);
unknown's avatar
unknown committed
4059
    fetch_string_with_conversion(param, (char*) *row, length);
unknown's avatar
unknown committed
4060
    *row+= length;
4061 4062
    break;
  }
unknown's avatar
unknown committed
4063
  }
4064 4065
}

unknown's avatar
unknown committed
4066

4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085
/*
  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
*/

4086 4087
static void fetch_result_tinyint(MYSQL_BIND *param, MYSQL_FIELD *field,
                                 uchar **row)
unknown's avatar
unknown committed
4088
{
4089 4090 4091
  my_bool field_is_unsigned= test(field->flags & UNSIGNED_FLAG);
  uchar data= **row;
  *(uchar *)param->buffer= data;
4092
  *param->error= param->is_unsigned != field_is_unsigned && data > INT_MAX8;
4093
  (*row)++;
unknown's avatar
unknown committed
4094 4095
}

4096 4097
static void fetch_result_short(MYSQL_BIND *param, MYSQL_FIELD *field,
                               uchar **row)
unknown's avatar
unknown committed
4098
{
4099 4100 4101
  my_bool field_is_unsigned= test(field->flags & UNSIGNED_FLAG);
  ushort data= (ushort) sint2korr(*row);
  shortstore(param->buffer, data);
4102
  *param->error= param->is_unsigned != field_is_unsigned && data > INT_MAX16;
4103
  *row+= 2;
unknown's avatar
unknown committed
4104 4105
}

4106 4107 4108
static void fetch_result_int32(MYSQL_BIND *param,
                               MYSQL_FIELD *field __attribute__((unused)),
                               uchar **row)
unknown's avatar
unknown committed
4109
{
4110 4111 4112
  my_bool field_is_unsigned= test(field->flags & UNSIGNED_FLAG);
  uint32 data= (uint32) sint4korr(*row);
  longstore(param->buffer, data);
4113
  *param->error= param->is_unsigned != field_is_unsigned && data > INT_MAX32;
4114
  *row+= 4;
unknown's avatar
unknown committed
4115 4116
}

4117 4118 4119
static void fetch_result_int64(MYSQL_BIND *param,
                               MYSQL_FIELD *field __attribute__((unused)),
                               uchar **row)
4120
{
4121 4122
  my_bool field_is_unsigned= test(field->flags & UNSIGNED_FLAG);
  ulonglong data= (ulonglong) sint8korr(*row);
4123
  *param->error= param->is_unsigned != field_is_unsigned && data > LONGLONG_MAX;
4124
  longlongstore(param->buffer, data);
4125
  *row+= 8;
unknown's avatar
unknown committed
4126 4127
}

4128 4129 4130
static void fetch_result_float(MYSQL_BIND *param,
                               MYSQL_FIELD *field __attribute__((unused)),
                               uchar **row)
unknown's avatar
unknown committed
4131 4132 4133
{
  float value;
  float4get(value,*row);
4134
  floatstore(param->buffer, value);
4135
  *row+= 4;
unknown's avatar
unknown committed
4136 4137
}

4138 4139 4140
static void fetch_result_double(MYSQL_BIND *param,
                                MYSQL_FIELD *field __attribute__((unused)),
                                uchar **row)
unknown's avatar
unknown committed
4141 4142 4143
{
  double value;
  float8get(value,*row);
4144
  doublestore(param->buffer, value);
4145
  *row+= 8;
unknown's avatar
unknown committed
4146 4147
}

4148 4149 4150
static void fetch_result_time(MYSQL_BIND *param,
                              MYSQL_FIELD *field __attribute__((unused)),
                              uchar **row)
unknown's avatar
unknown committed
4151 4152
{
  MYSQL_TIME *tm= (MYSQL_TIME *)param->buffer;
unknown's avatar
unknown committed
4153
  read_binary_time(tm, row);
unknown's avatar
unknown committed
4154 4155
}

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

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

4172 4173 4174
static void fetch_result_bin(MYSQL_BIND *param,
                             MYSQL_FIELD *field __attribute__((unused)),
                             uchar **row)
4175
{
unknown's avatar
unknown committed
4176 4177 4178
  ulong length= net_field_length(row);
  ulong copy_length= min(length, param->buffer_length);
  memcpy(param->buffer, (char *)*row, copy_length);
4179
  *param->length= length;
4180
  *param->error= copy_length < length;
unknown's avatar
unknown committed
4181 4182
  *row+= length;
}
4183

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

unknown's avatar
unknown committed
4199

4200 4201 4202 4203 4204 4205 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
/*
  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;
}


4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253
/*
  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
4254 4255 4256
    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 },
4257 4258 4259
    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,
4260 4261
                MYSQL_TYPE_DECIMAL, MYSQL_TYPE_NULL };
  static const enum enum_field_types
4262 4263
   *range_list[]= { range1, range2, range3, range4 },
   **range_list_end= range_list + sizeof(range_list)/sizeof(*range_list);
4264
   const enum enum_field_types **range, *type;
4265 4266 4267 4268 4269 4270

  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 */
4271
    my_bool type1_found= FALSE, type2_found= FALSE;
4272
    for (type= *range; *type != MYSQL_TYPE_NULL; type++)
4273 4274 4275 4276 4277 4278 4279 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
    {
      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)
{
4311 4312
  DBUG_ENTER("setup_one_fetch_function");

4313 4314 4315 4316 4317 4318 4319 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
  /* 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
4365
  case MYSQL_TYPE_BIT:
4366 4367 4368 4369 4370
    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
4371 4372
  case MYSQL_TYPE_DECIMAL:
  case MYSQL_TYPE_NEWDECIMAL:
4373
  case MYSQL_TYPE_NEWDATE:
4374 4375 4376 4377
    DBUG_ASSERT(param->buffer_length != 0);
    param->fetch_result= fetch_result_str;
    break;
  default:
4378 4379 4380
    DBUG_PRINT("error", ("Unknown param->buffer_type: %u",
                         (uint) param->buffer_type));
    DBUG_RETURN(TRUE);
4381 4382 4383 4384 4385 4386 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
  }
  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
4435
  case MYSQL_TYPE_NEWDECIMAL:
4436 4437 4438 4439 4440 4441 4442 4443 4444
  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
4445
  case MYSQL_TYPE_BIT:
4446
  case MYSQL_TYPE_NEWDATE:
4447 4448 4449
    param->skip_result= skip_result_string;
    break;
  default:
4450 4451
    DBUG_PRINT("error", ("Unknown field->type: %u", (uint) field->type));
    DBUG_RETURN(TRUE);
4452
  }
4453
  DBUG_RETURN(FALSE);
4454 4455 4456
}


4457
/*
4458
  Setup the bind buffers for resultset processing
4459 4460
*/

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

4470
  if (!bind_count)
4471
  {
4472 4473
    int errorcode= (int) stmt->state < (int) MYSQL_STMT_PREPARE_DONE ?
                   CR_NO_PREPARE_STMT : CR_NO_STMT_METADATA;
4474
    set_stmt_error(stmt, errorcode, unknown_sqlstate, NULL);
4475
    DBUG_RETURN(1);
4476 4477 4478 4479 4480
  }

  /*
    We only need to check that stmt->field_count - if it is not null
    stmt->bind was initialized in mysql_stmt_prepare
4481 4482 4483
    stmt->bind overlaps with bind if mysql_stmt_bind_param
    is called from mysql_stmt_store_result.
  */
4484

4485 4486 4487
  if (stmt->bind != my_bind)
    memcpy((char*) stmt->bind, (char*) my_bind,
           sizeof(MYSQL_BIND) * bind_count);
4488

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

unknown's avatar
unknown committed
4502
    if (!param->length)
4503 4504 4505 4506
      param->length= &param->length_value;

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

4508
    param->param_number= param_count++;
unknown's avatar
unknown committed
4509 4510
    param->offset= 0;

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

4524 4525 4526
  DBUG_RETURN(0);
}

unknown's avatar
unknown committed
4527

4528
/*
4529
  Fetch row data to bind buffers
4530 4531
*/

4532
static int stmt_fetch_row(MYSQL_STMT *stmt, uchar *row)
4533
{
4534
  MYSQL_BIND  *my_bind, *end;
4535
  MYSQL_FIELD *field;
unknown's avatar
unknown committed
4536
  uchar *null_ptr, bit;
4537
  int truncation_count= 0;
4538 4539 4540 4541 4542 4543
  /*
    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);
4544

4545 4546 4547
  if (!stmt->bind_result_done)
  {
    /* If output parameters were not bound we should just return success */
4548
    return 0;
4549
  }
4550 4551

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

unknown's avatar
unknown committed
4555
  /* Copy complete row to application buffers */
4556 4557 4558 4559
  for (my_bind= stmt->bind, end= my_bind + stmt->field_count,
         field= stmt->fields ;
       my_bind < end ;
       my_bind++, field++)
4560
  {
4561
    *my_bind->error= 0;
4562
    if (*null_ptr & bit)
4563 4564
    {
      /*
4565
        We should set both row_ptr and is_null to be able to see
4566 4567 4568 4569 4570
        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.
      */
4571 4572
      my_bind->row_ptr= NULL;
      *my_bind->is_null= 1;
4573
    }
4574
    else
4575
    {
4576 4577 4578 4579
      *my_bind->is_null= 0;
      my_bind->row_ptr= row;
      (*my_bind->fetch_result)(my_bind, field, &row);
      truncation_count+= *my_bind->error;
4580
    }
unknown's avatar
unknown committed
4581
    if (!((bit<<=1) & 255))
4582
    {
4583
      bit= 1;					/* To next uchar */
4584
      null_ptr++;
4585 4586
    }
  }
4587 4588
  if (truncation_count && (stmt->bind_result_done & REPORT_DATA_TRUNCATION))
    return MYSQL_DATA_TRUNCATED;
4589 4590 4591
  return 0;
}

4592

unknown's avatar
unknown committed
4593
int cli_unbuffered_fetch(MYSQL *mysql, char **row)
unknown's avatar
SCRUM  
unknown committed
4594
{
4595
  if (packet_error == cli_safe_read(mysql))
unknown's avatar
SCRUM  
unknown committed
4596 4597
    return 1;

unknown's avatar
unknown committed
4598 4599
  *row= ((mysql->net.read_pos[0] == 254) ? NULL :
	 (char*) (mysql->net.read_pos+1));
unknown's avatar
SCRUM  
unknown committed
4600 4601
  return 0;
}
unknown's avatar
unknown committed
4602

4603

4604
/*
4605
  Fetch and return row data to bound buffers, if any
4606 4607
*/

4608
int STDCALL mysql_stmt_fetch(MYSQL_STMT *stmt)
4609
{
4610
  int rc;
4611
  uchar *row;
4612
  DBUG_ENTER("mysql_stmt_fetch");
4613

4614
  if ((rc= (*stmt->read_row_func)(stmt, &row)) ||
4615
      ((rc= stmt_fetch_row(stmt, row)) && rc != MYSQL_DATA_TRUNCATED))
4616
  {
4617
    stmt->state= MYSQL_STMT_PREPARE_DONE;       /* XXX: this is buggy */
unknown's avatar
unknown committed
4618 4619
    stmt->read_row_func= (rc == MYSQL_NO_DATA) ? 
      stmt_read_row_no_data : stmt_read_row_no_result_set;
unknown's avatar
unknown committed
4620
  }
4621
  else
4622
  {
4623 4624
    /* 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
4625
  }
4626
  DBUG_RETURN(rc);
4627 4628
}

unknown's avatar
unknown committed
4629

unknown's avatar
unknown committed
4630
/*
unknown's avatar
unknown committed
4631
  Fetch data for one specified column data
unknown's avatar
unknown committed
4632 4633

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

4646
int STDCALL mysql_stmt_fetch_column(MYSQL_STMT *stmt, MYSQL_BIND *my_bind,
4647
                                    uint column, ulong offset)
unknown's avatar
unknown committed
4648
{
4649
  MYSQL_BIND *param= stmt->bind+column;
4650
  DBUG_ENTER("mysql_stmt_fetch_column");
unknown's avatar
unknown committed
4651

4652 4653
  if ((int) stmt->state < (int) MYSQL_STMT_FETCH_DONE)
  {
4654
    set_stmt_error(stmt, CR_NO_DATA, unknown_sqlstate, NULL);
4655 4656 4657 4658
    return 1;
  }
  if (column >= stmt->field_count)
  {
4659
    set_stmt_error(stmt, CR_INVALID_PARAMETER_NO, unknown_sqlstate, NULL);
4660 4661 4662
    DBUG_RETURN(1);
  }

4663 4664 4665
  if (!my_bind->error)
    my_bind->error= &my_bind->error_value;
  *my_bind->error= 0;
4666
  if (param->row_ptr)
unknown's avatar
unknown committed
4667
  {
4668
    MYSQL_FIELD *field= stmt->fields+column;
4669
    uchar *row= param->row_ptr;
4670 4671 4672 4673 4674
    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
4675
    else
4676 4677
      my_bind->length= &param->length_value;       /* Needed for fetch_result() */
    fetch_result_with_conversion(my_bind, field, &row);
unknown's avatar
unknown committed
4678
  }
4679 4680
  else
  {
4681 4682
    if (my_bind->is_null)
      *my_bind->is_null= 1;
4683
  }
unknown's avatar
unknown committed
4684 4685 4686 4687
  DBUG_RETURN(0);
}


4688
/*
4689 4690 4691
  Read all rows of data from server  (binary format)
*/

4692
int cli_read_binary_rows(MYSQL_STMT *stmt)
4693 4694 4695 4696
{
  ulong      pkt_len;
  uchar      *cp;
  MYSQL      *mysql= stmt->mysql;
4697 4698
  MYSQL_DATA *result= &stmt->result;
  MYSQL_ROWS *cur, **prev_ptr= &result->data;
4699 4700
  NET        *net;

unknown's avatar
unknown committed
4701
  DBUG_ENTER("cli_read_binary_rows");
unknown's avatar
unknown committed
4702

4703 4704
  if (!mysql)
  {
4705
    set_stmt_error(stmt, CR_SERVER_LOST, unknown_sqlstate, NULL);
unknown's avatar
unknown committed
4706
    DBUG_RETURN(1);
4707 4708 4709
  }

  net = &mysql->net;
4710
  mysql= mysql->last_used_con;
4711

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

err:
4744
  DBUG_RETURN(1);
4745 4746
}

4747

4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761
/*
  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)
{
4762
  MYSQL_BIND  *my_bind, *end;
4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773
  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 */

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


4791 4792 4793 4794 4795 4796 4797
/*
  Store or buffer the binary results to stmt
*/

int STDCALL mysql_stmt_store_result(MYSQL_STMT *stmt)
{
  MYSQL *mysql= stmt->mysql;
4798
  MYSQL_DATA *result= &stmt->result;
4799
  DBUG_ENTER("mysql_stmt_store_result");
4800

4801 4802 4803
  if (!mysql)
  {
    /* mysql can be reset in mysql_close called from mysql_reconnect */
unknown's avatar
unknown committed
4804
    set_stmt_error(stmt, CR_SERVER_LOST, unknown_sqlstate, NULL);
4805 4806 4807
    DBUG_RETURN(1);
  }

4808 4809 4810 4811
  mysql= mysql->last_used_con;

  if (!stmt->field_count)
    DBUG_RETURN(0);
4812 4813 4814

  if ((int) stmt->state < (int) MYSQL_STMT_EXECUTE_DONE)
  {
4815
    set_stmt_error(stmt, CR_COMMANDS_OUT_OF_SYNC, unknown_sqlstate, NULL);
4816 4817 4818
    DBUG_RETURN(1);
  }

4819 4820 4821 4822 4823 4824
  if (stmt->last_errno)
  {
    /* An attempt to use an invalid statement handle. */
    DBUG_RETURN(1);
  }

4825 4826 4827 4828 4829 4830 4831
  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;
4832 4833
    uchar buff[4 /* statement id */ +
               4 /* number of rows to fetch */];
4834 4835 4836 4837 4838

    /* 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),
4839
                             (uchar*) 0, 0, 1, stmt))
4840
    {
4841 4842 4843 4844 4845 4846
      /* 
        Don't set stmt error if stmt->mysql is NULL, as the error in this case 
        has already been set by mysql_prune_stmt_list(). 
      */
      if (stmt->mysql)
        set_stmt_errmsg(stmt, net);
4847 4848 4849 4850
      DBUG_RETURN(1);
    }
  }
  else if (mysql->status != MYSQL_STATUS_GET_RESULT)
4851
  {
4852
    set_stmt_error(stmt, CR_COMMANDS_OUT_OF_SYNC, unknown_sqlstate, NULL);
4853
    DBUG_RETURN(1);
4854
  }
4855

4856 4857 4858 4859 4860 4861
  if (stmt->update_max_length && !stmt->bind_result_done)
  {
    /*
      We must initalize the bind structure to be able to calculate
      max_length
    */
4862
    MYSQL_BIND  *my_bind, *end;
4863 4864 4865
    MYSQL_FIELD *field;
    bzero((char*) stmt->bind, sizeof(*stmt->bind)* stmt->field_count);

4866 4867 4868 4869
    for (my_bind= stmt->bind, end= my_bind + stmt->field_count,
           field= stmt->fields;
	 my_bind < end ;
	 my_bind++, field++)
4870
    {
4871 4872
      my_bind->buffer_type= MYSQL_TYPE_NULL;
      my_bind->buffer_length=1;
4873 4874
    }

4875 4876
    if (mysql_stmt_bind_result(stmt, stmt->bind))
      DBUG_RETURN(1);
4877 4878 4879
    stmt->bind_result_done= 0;			/* No normal bind done */
  }

4880
  if ((*mysql->methods->read_binary_rows)(stmt))
4881
  {
4882 4883 4884
    free_root(&result->alloc, MYF(MY_KEEP_PREALLOC));
    result->data= NULL;
    result->rows= 0;
4885
    mysql->status= MYSQL_STATUS_READY;
4886
    DBUG_RETURN(1);
4887
  }
4888

4889 4890 4891 4892
  /* 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));

4893 4894 4895 4896 4897 4898 4899
  if (stmt->update_max_length)
  {
    MYSQL_ROWS *cur= result->data;
    for(; cur; cur=cur->next)
      stmt_update_metadata(stmt, cur);
  }

4900 4901
  stmt->data_cursor= result->data;
  mysql->affected_rows= stmt->affected_rows= result->rows;
4902 4903 4904
  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 */
4905
  DBUG_RETURN(0); /* Data buffered, must be fetched with mysql_stmt_fetch() */
4906 4907
}

4908

4909 4910 4911 4912 4913 4914 4915
/*
  Seek to desired row in the statement result set
*/

MYSQL_ROW_OFFSET STDCALL
mysql_stmt_row_seek(MYSQL_STMT *stmt, MYSQL_ROW_OFFSET row)
{
4916
  MYSQL_ROW_OFFSET offset= stmt->data_cursor;
4917
  DBUG_ENTER("mysql_stmt_row_seek");
4918

4919 4920
  stmt->data_cursor= row;
  DBUG_RETURN(offset);
4921 4922
}

4923

4924 4925 4926 4927
/*
  Return the current statement row cursor position
*/

4928
MYSQL_ROW_OFFSET STDCALL
4929 4930 4931
mysql_stmt_row_tell(MYSQL_STMT *stmt)
{
  DBUG_ENTER("mysql_stmt_row_tell");
4932

4933
  DBUG_RETURN(stmt->data_cursor);
4934 4935
}

unknown's avatar
unknown committed
4936

4937 4938 4939 4940 4941 4942 4943
/*
  Move the stmt result set data cursor to specified row
*/

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

4948 4949 4950
  for (; tmp && row; --row, tmp= tmp->next)
    ;
  stmt->data_cursor= tmp;
unknown's avatar
unknown committed
4951 4952 4953 4954 4955 4956
  if (!row && tmp)
  {
       /*  Rewind the counter */
    stmt->read_row_func= stmt_read_row_buffered;
    stmt->state= MYSQL_STMT_EXECUTE_DONE;
  }
4957
  DBUG_VOID_RETURN;
4958 4959
}

unknown's avatar
unknown committed
4960

4961 4962 4963 4964 4965 4966 4967
/*
  Return total rows the current statement result set
*/

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

4969
  DBUG_RETURN(stmt->result.rows);
4970
}
4971

4972

4973 4974 4975 4976 4977
/*
  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.
*/
4978

4979 4980 4981
static my_bool reset_stmt_handle(MYSQL_STMT *stmt, uint flags)
{
  /* If statement hasn't been prepared there is nothing to reset */
4982 4983 4984
  if ((int) stmt->state > (int) MYSQL_STMT_INIT_DONE)
  {
    MYSQL *mysql= stmt->mysql;
4985
    MYSQL_DATA *result= &stmt->result;
4986

4987 4988 4989 4990
    /*
      Reset stored result set if so was requested or it's a part
      of cursor fetch.
    */
4991
    if (flags & RESET_STORE_RESULT)
4992 4993
    {
      /* Result buffered */
4994 4995 4996 4997
      free_root(&result->alloc, MYF(MY_KEEP_PREALLOC));
      result->data= NULL;
      result->rows= 0;
      stmt->data_cursor= NULL;
4998
    }
4999
    if (flags & RESET_LONG_DATA)
5000
    {
5001 5002 5003 5004 5005
      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
5006
    stmt->read_row_func= stmt_read_row_no_result_set;
5007 5008 5009
    if (mysql)
    {
      if ((int) stmt->state > (int) MYSQL_STMT_PREPARE_DONE)
5010
      {
5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021
        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;
        }
      }
5022
      if (flags & RESET_SERVER_SIDE)
5023 5024 5025 5026 5027
      {
        /*
          Reset the server side statement and close the server side
          cursor if it exists.
        */
5028
        uchar buff[MYSQL_STMT_HEADER]; /* packet header: 4 bytes for stmt id */
5029
        int4store(buff, stmt->stmt_id);
5030
        if ((*mysql->methods->advanced_command)(mysql, COM_STMT_RESET, buff,
5031
                                                sizeof(buff), 0, 0, 0, stmt))
5032
        {
5033
          set_stmt_errmsg(stmt, &mysql->net);
5034 5035 5036
          stmt->state= MYSQL_STMT_INIT_DONE;
          return 1;
        }
5037 5038
      }
    }
5039 5040
    if (flags & RESET_CLEAR_ERROR)
      stmt_clear_error(stmt);
5041 5042
    stmt->state= MYSQL_STMT_PREPARE_DONE;
  }
5043 5044 5045 5046 5047 5048 5049 5050
  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 */
5051 5052
  DBUG_RETURN(reset_stmt_handle(stmt, RESET_LONG_DATA | RESET_STORE_RESULT |
                                RESET_CLEAR_ERROR));
5053 5054
}

5055
/********************************************************************
5056
 statement error handling and close
5057
*********************************************************************/
5058

5059
/*
unknown's avatar
unknown committed
5060
  Close the statement handle by freeing all alloced resources
5061

unknown's avatar
unknown committed
5062
  SYNOPSIS
5063
    mysql_stmt_close()
unknown's avatar
unknown committed
5064
    stmt	       Statement handle
5065

unknown's avatar
unknown committed
5066 5067 5068 5069
  RETURN VALUES
    0	ok
    1	error
*/
5070

5071
my_bool STDCALL mysql_stmt_close(MYSQL_STMT *stmt)
5072
{
5073 5074 5075
  MYSQL *mysql= stmt->mysql;
  int rc= 0;
  DBUG_ENTER("mysql_stmt_close");
5076

5077
  free_root(&stmt->result.alloc, MYF(0));
5078 5079 5080
  free_root(&stmt->mem_root, MYF(0));

  if (mysql)
5081
  {
5082
    mysql->stmts= list_delete(mysql->stmts, &stmt->list);
unknown's avatar
unknown committed
5083 5084 5085 5086 5087
    /*
      Clear NET error state: if the following commands come through
      successfully, connection will still be usable for other commands.
    */
    net_clear_error(&mysql->net);
5088
    if ((int) stmt->state > (int) MYSQL_STMT_INIT_DONE)
5089
    {
5090
      uchar buff[MYSQL_STMT_HEADER];             /* 4 bytes - stmt id */
5091 5092 5093 5094 5095

      if (mysql->unbuffered_fetch_owner == &stmt->unbuffered_fetch_cancelled)
        mysql->unbuffered_fetch_owner= 0;
      if (mysql->status != MYSQL_STATUS_READY)
      {
5096
        /*
5097 5098 5099
          Flush result set of the connection. If it does not belong
          to this statement, set a warning.
        */
5100
        (*mysql->methods->flush_use_result)(mysql);
5101 5102 5103 5104 5105
        if (mysql->unbuffered_fetch_owner)
          *mysql->unbuffered_fetch_owner= TRUE;
        mysql->status= MYSQL_STATUS_READY;
      }
      int4store(buff, stmt->stmt_id);
5106
      if ((rc= stmt_command(mysql, COM_STMT_CLOSE, buff, 4, stmt)))
5107
      {
5108
        set_stmt_errmsg(stmt, &mysql->net);
5109
      }
5110
    }
5111
  }
5112

5113
  my_free((uchar*) stmt, MYF(MY_WME));
unknown's avatar
unknown committed
5114

5115
  DBUG_RETURN(test(rc));
unknown's avatar
unknown committed
5116 5117
}

5118 5119 5120 5121 5122 5123 5124 5125
/*
  Reset the statement buffers in server
*/

my_bool STDCALL mysql_stmt_reset(MYSQL_STMT *stmt)
{
  DBUG_ENTER("mysql_stmt_reset");
  DBUG_ASSERT(stmt != 0);
5126 5127 5128
  if (!stmt->mysql)
  {
    /* mysql can be reset in mysql_close called from mysql_reconnect */
5129
    set_stmt_error(stmt, CR_SERVER_LOST, unknown_sqlstate, NULL);
5130 5131
    DBUG_RETURN(1);
  }
5132
  /* Reset the client and server sides of the prepared statement */
5133 5134 5135
  DBUG_RETURN(reset_stmt_handle(stmt,
                                RESET_SERVER_SIDE | RESET_LONG_DATA |
                                RESET_CLEAR_ERROR));
5136 5137
}

5138 5139 5140 5141 5142 5143 5144
/*
  Return statement error code
*/

uint STDCALL mysql_stmt_errno(MYSQL_STMT * stmt)
{
  DBUG_ENTER("mysql_stmt_errno");
5145
  DBUG_RETURN(stmt->last_errno);
5146 5147
}

5148 5149 5150 5151 5152 5153
const char *STDCALL mysql_stmt_sqlstate(MYSQL_STMT * stmt)
{
  DBUG_ENTER("mysql_stmt_sqlstate");
  DBUG_RETURN(stmt->sqlstate);
}

5154 5155 5156 5157 5158 5159 5160
/*
  Return statement error message
*/

const char *STDCALL mysql_stmt_error(MYSQL_STMT * stmt)
{
  DBUG_ENTER("mysql_stmt_error");
5161
  DBUG_RETURN(stmt->last_error);
5162 5163
}

5164

5165 5166 5167 5168
/********************************************************************
 Transactional APIs
*********************************************************************/

5169 5170 5171 5172
/*
  Commit the current transaction
*/

5173
my_bool STDCALL mysql_commit(MYSQL * mysql)
5174 5175
{
  DBUG_ENTER("mysql_commit");
5176
  DBUG_RETURN((my_bool) mysql_real_query(mysql, "commit", 6));
5177 5178 5179
}

/*
5180
  Rollback the current transaction
5181 5182
*/

5183
my_bool STDCALL mysql_rollback(MYSQL * mysql)
5184 5185
{
  DBUG_ENTER("mysql_rollback");
5186
  DBUG_RETURN((my_bool) mysql_real_query(mysql, "rollback", 8));
5187 5188 5189 5190 5191 5192 5193
}


/*
  Set autocommit to either true or false
*/

5194
my_bool STDCALL mysql_autocommit(MYSQL * mysql, my_bool auto_mode)
5195 5196 5197 5198
{
  DBUG_ENTER("mysql_autocommit");
  DBUG_PRINT("enter", ("mode : %d", auto_mode));

5199 5200 5201
  DBUG_RETURN((my_bool) mysql_real_query(mysql, auto_mode ?
                                         "set autocommit=1":"set autocommit=0",
                                         16));
5202
}
5203 5204 5205


/********************************************************************
5206
 Multi query execution + SPs APIs
5207 5208 5209
*********************************************************************/

/*
unknown's avatar
unknown committed
5210 5211
  Returns true/false to indicate whether any more query results exist
  to be read using mysql_next_result()
5212 5213 5214 5215
*/

my_bool STDCALL mysql_more_results(MYSQL *mysql)
{
5216
  my_bool res;
5217
  DBUG_ENTER("mysql_more_results");
5218 5219

  res= ((mysql->last_used_con->server_status & SERVER_MORE_RESULTS_EXISTS) ?
5220
	1: 0);
5221
  DBUG_PRINT("exit",("More results exists ? %d", res));
5222
  DBUG_RETURN(res);
5223 5224
}

5225

5226 5227 5228
/*
  Reads and returns the next query results
*/
5229
int STDCALL mysql_next_result(MYSQL *mysql)
5230
{
5231
  DBUG_ENTER("mysql_next_result");
5232

5233 5234
  if (mysql->status != MYSQL_STATUS_READY)
  {
5235
    set_mysql_error(mysql, CR_COMMANDS_OUT_OF_SYNC, unknown_sqlstate);
5236 5237 5238
    DBUG_RETURN(1);
  }

5239
  net_clear_error(&mysql->net);
5240 5241 5242
  mysql->affected_rows= ~(my_ulonglong) 0;

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

5245
  DBUG_RETURN(-1);				/* No more results */
5246
}
unknown's avatar
unknown committed
5247

5248

unknown's avatar
unknown committed
5249 5250 5251 5252 5253 5254 5255 5256 5257 5258
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);
}