← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to plugin/drizzle_protocol/drizzle_protocol.cc

  • Committer: Mark Atwood
  • Date: 2010-06-24 03:15:21 UTC
  • mto: (1637.2.4 build)
  • mto: This revision was merged to the branch mainline in revision 1639.
  • Revision ID: me@mark.atwood.name-20100624031521-gafmppfbf5afm68w
new syslog module, with plugins for query log, error message, and SYSLOG() function

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin/drizzle_protocol/drizzle_protocol.cc
1
 
/* - mode: c; c-basic-offset: 2; indent-tabs-mode: nil; -*-
 
1
/* -*- mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; -*-
2
2
 *  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
3
3
 *
4
 
 *  Copyright (C) 2010 Brian Aker
5
 
 *
6
 
 *  This program is free software; you can redistribute it and/or modify
7
 
 *  it under the terms of the GNU General Public License as published by
8
 
 *  the Free Software Foundation; either version 2 of the License, or
9
 
 *  (at your option) any later version.
10
 
 *
11
 
 *  This program is distributed in the hope that it will be useful,
12
 
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13
 
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14
 
 *  GNU General Public License for more details.
15
 
 *
16
 
 *  You should have received a copy of the GNU General Public License
17
 
 *  along with this program; if not, write to the Free Software
18
 
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
4
 *  Copyright (C) 2008 Sun Microsystems
 
5
 *
 
6
 * This program is free software; you can redistribute it and/or modify
 
7
 * it under the terms of the GNU General Public License as published by
 
8
 * the Free Software Foundation; version 2 of the License.
 
9
 *
 
10
 * This program is distributed in the hope that it will be useful,
 
11
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 
12
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
13
 * GNU General Public License for more details.
 
14
 *
 
15
 * You should have received a copy of the GNU General Public License
 
16
 * along with this program; if not, write to the Free Software
 
17
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19
18
 */
20
19
 
21
 
 
22
 
#include <config.h>
 
20
#include "config.h"
23
21
#include <drizzled/gettext.h>
24
22
#include <drizzled/error.h>
25
23
#include <drizzled/query_id.h>
 
24
#include <drizzled/sql_state.h>
26
25
#include <drizzled/session.h>
27
 
#include <drizzled/internal/my_sys.h>
28
 
#include <drizzled/internal/m_string.h>
 
26
#include "drizzled/internal/my_sys.h"
 
27
#include "drizzled/internal/m_string.h"
29
28
#include <algorithm>
30
 
#include <iostream>
31
 
#include <boost/program_options.hpp>
32
 
#include <drizzled/module/option_map.h>
33
 
#include <drizzled/util/tokenize.h>
 
29
 
 
30
#include "pack.h"
 
31
#include "errmsg.h"
34
32
#include "drizzle_protocol.h"
35
 
 
36
 
namespace po= boost::program_options;
 
33
#include "options.h"
 
34
 
 
35
#define PROTOCOL_VERSION 10
 
36
 
 
37
namespace drizzled
 
38
{
 
39
extern uint32_t global_thread_id;
 
40
}
 
41
 
37
42
using namespace drizzled;
38
43
using namespace std;
39
44
 
40
 
namespace drizzle_plugin
41
 
{
42
45
namespace drizzle_protocol
43
46
{
44
47
 
45
 
std::vector<std::string> ClientDrizzleProtocol::drizzle_admin_ip_addresses;
46
 
static port_constraint port;
47
 
static timeout_constraint connect_timeout;
48
 
static timeout_constraint read_timeout;
49
 
static timeout_constraint write_timeout;
50
 
static retry_constraint retry_count;
51
 
static buffer_constraint buffer_length;
52
48
 
53
49
static const uint32_t DRIZZLE_TCP_PORT= 4427;
54
 
 
55
 
ProtocolCounters *ListenDrizzleProtocol::drizzle_counters= new ProtocolCounters();
56
 
 
57
 
ListenDrizzleProtocol::~ListenDrizzleProtocol()
 
50
static const unsigned int PACKET_BUFFER_EXTRA_ALLOC= 1024;
 
51
static uint32_t port;
 
52
static uint32_t connect_timeout;
 
53
static uint32_t read_timeout;
 
54
static uint32_t write_timeout;
 
55
static uint32_t retry_count;
 
56
static uint32_t buffer_length;
 
57
static char* bind_address;
 
58
 
 
59
const char* ListenDrizzleProtocol::getHost(void) const
58
60
{
 
61
  return bind_address;
59
62
}
60
63
 
61
64
in_port_t ListenDrizzleProtocol::getPort(void) const
62
65
{
63
 
  return port;
64
 
}
 
66
  char *env;
65
67
 
66
 
void ClientDrizzleProtocol::drizzle_compose_ip_addresses(vector<string> options)
67
 
{
68
 
  for (vector<string>::iterator it= options.begin();
69
 
       it != options.end();
70
 
       ++it)
 
68
  if (port == 0)
71
69
  {
72
 
    tokenize(*it, drizzle_admin_ip_addresses, ",", true);
 
70
    port= DRIZZLE_TCP_PORT;
 
71
 
 
72
    if ((env = getenv("DRIZZLE_TCP_PORT")))
 
73
      port= (uint32_t) atoi(env);
 
74
 
 
75
    assert(port != 0);
73
76
  }
74
 
}
75
 
 
76
 
bool ClientDrizzleProtocol::isAdminAllowed(void)
77
 
{
78
 
  if (std::find(drizzle_admin_ip_addresses.begin(), drizzle_admin_ip_addresses.end(), session->user()->address()) != drizzle_admin_ip_addresses.end())
79
 
    return true;
80
 
 
81
 
  return false;
 
77
 
 
78
  return (in_port_t) port;
82
79
}
83
80
 
84
81
plugin::Client *ListenDrizzleProtocol::getClient(int fd)
88
85
  if (new_fd == -1)
89
86
    return NULL;
90
87
 
91
 
  return new ClientDrizzleProtocol(new_fd, getCounters());
92
 
}
93
 
 
94
 
static int init(drizzled::module::Context &context)
95
 
{  
96
 
  const module::option_map &vm= context.getOptions();
97
 
 
98
 
  ListenDrizzleProtocol *protocol=new ListenDrizzleProtocol("drizzle_protocol", vm["bind-address"].as<std::string>(), true);
99
 
  protocol->addCountersToTable();
100
 
  context.add(protocol);
101
 
  context.registerVariable(new sys_var_constrained_value_readonly<in_port_t>("port", port));
102
 
  context.registerVariable(new sys_var_constrained_value_readonly<uint32_t>("connect_timeout", connect_timeout));
103
 
  context.registerVariable(new sys_var_constrained_value_readonly<uint32_t>("read_timeout", read_timeout));
104
 
  context.registerVariable(new sys_var_constrained_value_readonly<uint32_t>("write_timeout", write_timeout));
105
 
  context.registerVariable(new sys_var_constrained_value_readonly<uint32_t>("retry_count", retry_count));
106
 
  context.registerVariable(new sys_var_constrained_value_readonly<uint32_t>("buffer_length", buffer_length));
107
 
  context.registerVariable(new sys_var_const_string_val("bind_address",
108
 
                                                        vm["bind-address"].as<std::string>()));
109
 
 
110
 
  context.registerVariable(new sys_var_uint32_t_ptr("max-connections", &ListenDrizzleProtocol::drizzle_counters->max_connections));
111
 
 
112
 
  return 0;
113
 
}
114
 
 
115
 
 
116
 
static void init_options(drizzled::module::option_context &context)
117
 
{
118
 
  context("port",
119
 
          po::value<port_constraint>(&port)->default_value(DRIZZLE_TCP_PORT),
120
 
          N_("Port number to use for connection or 0 for default to with Drizzle/MySQL protocol."));
121
 
  context("connect-timeout",
122
 
          po::value<timeout_constraint>(&connect_timeout)->default_value(10),
123
 
          N_("Connect Timeout."));
124
 
  context("read-timeout",
125
 
          po::value<timeout_constraint>(&read_timeout)->default_value(30),
126
 
          N_("Read Timeout."));
127
 
  context("write-timeout",
128
 
          po::value<timeout_constraint>(&write_timeout)->default_value(60),
129
 
          N_("Write Timeout."));
130
 
  context("retry-count",
131
 
          po::value<retry_constraint>(&retry_count)->default_value(10),
132
 
          N_("Retry Count."));
133
 
  context("buffer-length",
134
 
          po::value<buffer_constraint>(&buffer_length)->default_value(16384),
135
 
          N_("Buffer length."));
136
 
  context("bind-address",
137
 
          po::value<std::string>()->default_value(""),
138
 
          N_("Address to bind to."));
139
 
  context("max-connections",
140
 
          po::value<uint32_t>(&ListenDrizzleProtocol::drizzle_counters->max_connections)->default_value(1000),
141
 
          N_("Maximum simultaneous connections."));
142
 
  context("admin-ip-addresses",
143
 
          po::value<vector<string> >()->composing()->notifier(&ClientDrizzleProtocol::drizzle_compose_ip_addresses),
144
 
          N_("A restrictive IP address list for incoming admin connections."));
145
 
}
 
88
  return new (nothrow) ClientDrizzleProtocol(new_fd, using_mysql41_protocol);
 
89
}
 
90
 
 
91
ClientDrizzleProtocol::ClientDrizzleProtocol(int fd, bool using_mysql41_protocol_arg):
 
92
  using_mysql41_protocol(using_mysql41_protocol_arg)
 
93
{
 
94
  net.vio= 0;
 
95
 
 
96
  if (fd == -1)
 
97
    return;
 
98
 
 
99
  if (drizzleclient_net_init_sock(&net, fd, 0, buffer_length))
 
100
    throw bad_alloc();
 
101
 
 
102
  drizzleclient_net_set_read_timeout(&net, read_timeout);
 
103
  drizzleclient_net_set_write_timeout(&net, write_timeout);
 
104
  net.retry_count=retry_count;
 
105
}
 
106
 
 
107
ClientDrizzleProtocol::~ClientDrizzleProtocol()
 
108
{
 
109
  if (net.vio)
 
110
    drizzleclient_vio_close(net.vio);
 
111
}
 
112
 
 
113
int ClientDrizzleProtocol::getFileDescriptor(void)
 
114
{
 
115
  return drizzleclient_net_get_sd(&net);
 
116
}
 
117
 
 
118
bool ClientDrizzleProtocol::isConnected()
 
119
{
 
120
  return net.vio != 0;
 
121
}
 
122
 
 
123
bool ClientDrizzleProtocol::isReading(void)
 
124
{
 
125
  return net.reading_or_writing == 1;
 
126
}
 
127
 
 
128
bool ClientDrizzleProtocol::isWriting(void)
 
129
{
 
130
  return net.reading_or_writing == 2;
 
131
}
 
132
 
 
133
bool ClientDrizzleProtocol::flush()
 
134
{
 
135
  if (net.vio == NULL)
 
136
    return false;
 
137
  bool ret= drizzleclient_net_write(&net, (unsigned char*) packet.ptr(),
 
138
                           packet.length());
 
139
  packet.length(0);
 
140
  return ret;
 
141
}
 
142
 
 
143
void ClientDrizzleProtocol::close(void)
 
144
{
 
145
  if (net.vio)
 
146
  { 
 
147
    drizzleclient_net_close(&net);
 
148
    drizzleclient_net_end(&net);
 
149
  }
 
150
}
 
151
 
 
152
bool ClientDrizzleProtocol::authenticate()
 
153
{
 
154
  bool connection_is_valid;
 
155
 
 
156
  /* Use "connect_timeout" value during connection phase */
 
157
  drizzleclient_net_set_read_timeout(&net, connect_timeout);
 
158
  drizzleclient_net_set_write_timeout(&net, connect_timeout);
 
159
 
 
160
  connection_is_valid= checkConnection();
 
161
 
 
162
  if (connection_is_valid)
 
163
    sendOK();
 
164
  else
 
165
  {
 
166
    sendError(session->main_da.sql_errno(), session->main_da.message());
 
167
    return false;
 
168
  }
 
169
 
 
170
  /* Connect completed, set read/write timeouts back to default */
 
171
  drizzleclient_net_set_read_timeout(&net, read_timeout);
 
172
  drizzleclient_net_set_write_timeout(&net, write_timeout);
 
173
  return true;
 
174
}
 
175
 
 
176
bool ClientDrizzleProtocol::readCommand(char **l_packet, uint32_t *packet_length)
 
177
{
 
178
  /*
 
179
    This thread will do a blocking read from the client which
 
180
    will be interrupted when the next command is received from
 
181
    the client, the connection is closed or "net_wait_timeout"
 
182
    number of seconds has passed
 
183
  */
 
184
#ifdef NEVER
 
185
  /* We can do this much more efficiently with poll timeouts or watcher thread,
 
186
     disabling for now, which means net_wait_timeout == read_timeout. */
 
187
  drizzleclient_net_set_read_timeout(&net,
 
188
                                     session->variables.net_wait_timeout);
 
189
#endif
 
190
 
 
191
  net.pkt_nr=0;
 
192
 
 
193
  *packet_length= drizzleclient_net_read(&net);
 
194
  if (*packet_length == packet_error)
 
195
  {
 
196
    /* Check if we can continue without closing the connection */
 
197
 
 
198
    if(net.last_errno== CR_NET_PACKET_TOO_LARGE)
 
199
      my_error(ER_NET_PACKET_TOO_LARGE, MYF(0));
 
200
    if (session->main_da.status() == Diagnostics_area::DA_ERROR)
 
201
      sendError(session->main_da.sql_errno(), session->main_da.message());
 
202
    else
 
203
      sendOK();
 
204
 
 
205
    if (net.error != 3)
 
206
      return false;                       // We have to close it.
 
207
 
 
208
    net.error= 0;
 
209
    *packet_length= 0;
 
210
    return true;
 
211
  }
 
212
 
 
213
  *l_packet= (char*) net.read_pos;
 
214
 
 
215
  /*
 
216
    'packet_length' contains length of data, as it was stored in packet
 
217
    header. In case of malformed header, drizzleclient_net_read returns zero.
 
218
    If packet_length is not zero, drizzleclient_net_read ensures that the returned
 
219
    number of bytes was actually read from network.
 
220
    There is also an extra safety measure in drizzleclient_net_read:
 
221
    it sets packet[packet_length]= 0, but only for non-zero packets.
 
222
  */
 
223
 
 
224
  if (*packet_length == 0)                       /* safety */
 
225
  {
 
226
    /* Initialize with COM_SLEEP packet */
 
227
    (*l_packet)[0]= (unsigned char) COM_SLEEP;
 
228
    *packet_length= 1;
 
229
  }
 
230
  else if (using_mysql41_protocol)
 
231
  {
 
232
    /* Map from MySQL commands to Drizzle commands. */
 
233
    switch ((int)(*l_packet)[0])
 
234
    {
 
235
    case 0: /* SLEEP */
 
236
    case 1: /* QUIT */
 
237
    case 2: /* INIT_DB */
 
238
    case 3: /* QUERY */
 
239
      break;
 
240
 
 
241
    case 8: /* SHUTDOWN */
 
242
      (*l_packet)[0]= (unsigned char) COM_SHUTDOWN;
 
243
      break;
 
244
 
 
245
    case 14: /* PING */
 
246
      (*l_packet)[0]= (unsigned char) COM_SHUTDOWN;
 
247
      break;
 
248
 
 
249
 
 
250
    default:
 
251
      /* Just drop connection for MySQL commands we don't support. */
 
252
      (*l_packet)[0]= (unsigned char) COM_QUIT;
 
253
      *packet_length= 1;
 
254
      break;
 
255
    }
 
256
  }
 
257
 
 
258
  /* Do not rely on drizzleclient_net_read, extra safety against programming errors. */
 
259
  (*l_packet)[*packet_length]= '\0';                  /* safety */
 
260
 
 
261
#ifdef NEVER
 
262
  /* See comment above. */
 
263
  /* Restore read timeout value */
 
264
  drizzleclient_net_set_read_timeout(&net,
 
265
                                     session->variables.net_read_timeout);
 
266
#endif
 
267
 
 
268
  return true;
 
269
}
 
270
 
 
271
/**
 
272
  Return ok to the client.
 
273
 
 
274
  The ok packet has the following structure:
 
275
 
 
276
  - 0               : Marker (1 byte)
 
277
  - affected_rows    : Stored in 1-9 bytes
 
278
  - id        : Stored in 1-9 bytes
 
279
  - server_status    : Copy of session->server_status;  Can be used by client
 
280
  to check if we are inside an transaction.
 
281
  New in 4.0 client
 
282
  - warning_count    : Stored in 2 bytes; New in 4.1 client
 
283
  - message        : Stored as packed length (1-9 bytes) + message.
 
284
  Is not stored if no message.
 
285
 
 
286
  @param session           Thread handler
 
287
  @param affected_rows       Number of rows changed by statement
 
288
  @param id           Auto_increment id for first row (if used)
 
289
  @param message       Message to send to the client (Used by mysql_status)
 
290
*/
 
291
 
 
292
void ClientDrizzleProtocol::sendOK()
 
293
{
 
294
  unsigned char buff[DRIZZLE_ERRMSG_SIZE+10],*pos;
 
295
  const char *message= NULL;
 
296
  uint32_t tmp;
 
297
 
 
298
  if (!net.vio)    // hack for re-parsing queries
 
299
  {
 
300
    return;
 
301
  }
 
302
 
 
303
  buff[0]=0;                    // No fields
 
304
  if (session->main_da.status() == Diagnostics_area::DA_OK)
 
305
  {
 
306
    if (client_capabilities & CLIENT_FOUND_ROWS && session->main_da.found_rows())
 
307
      pos=drizzleclient_net_store_length(buff+1,session->main_da.found_rows());
 
308
    else
 
309
      pos=drizzleclient_net_store_length(buff+1,session->main_da.affected_rows());
 
310
    pos=drizzleclient_net_store_length(pos, session->main_da.last_insert_id());
 
311
    int2store(pos, session->main_da.server_status());
 
312
    pos+=2;
 
313
    tmp= min(session->main_da.total_warn_count(), (uint32_t)65535);
 
314
    message= session->main_da.message();
 
315
  }
 
316
  else
 
317
  {
 
318
    pos=drizzleclient_net_store_length(buff+1,0);
 
319
    pos=drizzleclient_net_store_length(pos, 0);
 
320
    int2store(pos, session->server_status);
 
321
    pos+=2;
 
322
    tmp= min(session->total_warn_count, (uint32_t)65535);
 
323
  }
 
324
 
 
325
  /* We can only return up to 65535 warnings in two bytes */
 
326
  int2store(pos, tmp);
 
327
  pos+= 2;
 
328
 
 
329
  session->main_da.can_overwrite_status= true;
 
330
 
 
331
  if (message && message[0])
 
332
  {
 
333
    size_t length= strlen(message);
 
334
    pos=drizzleclient_net_store_length(pos,length);
 
335
    memcpy(pos,(unsigned char*) message,length);
 
336
    pos+=length;
 
337
  }
 
338
  drizzleclient_net_write(&net, buff, (size_t) (pos-buff));
 
339
  drizzleclient_net_flush(&net);
 
340
 
 
341
  session->main_da.can_overwrite_status= false;
 
342
}
 
343
 
 
344
/**
 
345
  Send eof (= end of result set) to the client.
 
346
 
 
347
  The eof packet has the following structure:
 
348
 
 
349
  - 254    (DRIZZLE_PROTOCOL_NO_MORE_DATA)    : Marker (1 byte)
 
350
  - warning_count    : Stored in 2 bytes; New in 4.1 client
 
351
  - status_flag    : Stored in 2 bytes;
 
352
  For flags like SERVER_MORE_RESULTS_EXISTS.
 
353
 
 
354
  Note that the warning count will not be sent if 'no_flush' is set as
 
355
  we don't want to report the warning count until all data is sent to the
 
356
  client.
 
357
*/
 
358
 
 
359
void ClientDrizzleProtocol::sendEOF()
 
360
{
 
361
  /* Set to true if no active vio, to work well in case of --init-file */
 
362
  if (net.vio != 0)
 
363
  {
 
364
    session->main_da.can_overwrite_status= true;
 
365
    writeEOFPacket(session->main_da.server_status(),
 
366
                   session->main_da.total_warn_count());
 
367
    drizzleclient_net_flush(&net);
 
368
    session->main_da.can_overwrite_status= false;
 
369
  }
 
370
  packet.shrink(buffer_length);
 
371
}
 
372
 
 
373
 
 
374
void ClientDrizzleProtocol::sendError(uint32_t sql_errno, const char *err)
 
375
{
 
376
  uint32_t length;
 
377
  /*
 
378
    buff[]: sql_errno:2 + ('#':1 + SQLSTATE_LENGTH:5) + DRIZZLE_ERRMSG_SIZE:512
 
379
  */
 
380
  unsigned char buff[2+1+SQLSTATE_LENGTH+DRIZZLE_ERRMSG_SIZE], *pos;
 
381
 
 
382
  assert(sql_errno);
 
383
  assert(err && err[0]);
 
384
 
 
385
  /*
 
386
    It's one case when we can push an error even though there
 
387
    is an OK or EOF already.
 
388
  */
 
389
  session->main_da.can_overwrite_status= true;
 
390
 
 
391
  /* Abort multi-result sets */
 
392
  session->server_status&= ~SERVER_MORE_RESULTS_EXISTS;
 
393
 
 
394
  /**
 
395
    Send a error string to client.
 
396
 
 
397
    For SIGNAL/RESIGNAL and GET DIAGNOSTICS functionality it's
 
398
    critical that every error that can be intercepted is issued in one
 
399
    place only, my_message_sql.
 
400
  */
 
401
 
 
402
  if (net.vio == 0)
 
403
  {
 
404
    return;
 
405
  }
 
406
 
 
407
  int2store(buff,sql_errno);
 
408
  pos= buff+2;
 
409
 
 
410
  /* The first # is to make the client backward compatible */
 
411
  buff[2]= '#';
 
412
  pos= (unsigned char*) strcpy((char*) buff+3, drizzle_errno_to_sqlstate(sql_errno));
 
413
  pos+= strlen(drizzle_errno_to_sqlstate(sql_errno));
 
414
 
 
415
  char *tmp= strncpy((char*)pos, err, DRIZZLE_ERRMSG_SIZE-1);
 
416
  tmp+= strlen((char*)pos);
 
417
  tmp[0]= '\0';
 
418
  length= (uint32_t)(tmp-(char*)buff);
 
419
  err= (char*) buff;
 
420
 
 
421
  drizzleclient_net_write_command(&net,(unsigned char) 255, (unsigned char*) "", 0, (unsigned char*) err, length);
 
422
 
 
423
  session->main_da.can_overwrite_status= false;
 
424
}
 
425
 
 
426
/**
 
427
  Send name and type of result to client.
 
428
 
 
429
  Sum fields has table name empty and field_name.
 
430
 
 
431
  @param Session        Thread data object
 
432
  @param list            List of items to send to client
 
433
  @param flag            Bit mask with the following functions:
 
434
                        - 1 send number of rows
 
435
                        - 2 send default values
 
436
                        - 4 don't write eof packet
 
437
 
 
438
  @retval
 
439
    0    ok
 
440
  @retval
 
441
    1    Error  (Note that in this case the error is not sent to the
 
442
    client)
 
443
*/
 
444
bool ClientDrizzleProtocol::sendFields(List<Item> *list)
 
445
{
 
446
  List_iterator_fast<Item> it(*list);
 
447
  Item *item;
 
448
  unsigned char buff[80];
 
449
  String tmp((char*) buff,sizeof(buff),&my_charset_bin);
 
450
 
 
451
  unsigned char *row_pos= drizzleclient_net_store_length(buff, list->elements);
 
452
  (void) drizzleclient_net_write(&net, buff, (size_t) (row_pos-buff));
 
453
 
 
454
  while ((item=it++))
 
455
  {
 
456
    char *pos;
 
457
    SendField field;
 
458
    item->make_field(&field);
 
459
 
 
460
    packet.length(0);
 
461
 
 
462
    if (store(STRING_WITH_LEN("def")) ||
 
463
        store(field.db_name) ||
 
464
        store(field.table_name) ||
 
465
        store(field.org_table_name) ||
 
466
        store(field.col_name) ||
 
467
        store(field.org_col_name) ||
 
468
        packet.realloc(packet.length()+12))
 
469
      goto err;
 
470
 
 
471
    /* Store fixed length fields */
 
472
    pos= (char*) packet.ptr()+packet.length();
 
473
    *pos++= 12;                // Length of packed fields
 
474
    /* No conversion */
 
475
    int2store(pos, field.charsetnr);
 
476
    int4store(pos+2, field.length);
 
477
 
 
478
    if (using_mysql41_protocol)
 
479
    {
 
480
      /* Switch to MySQL field numbering. */
 
481
      switch (field.type)
 
482
      {
 
483
      case DRIZZLE_TYPE_LONG:
 
484
        pos[6]= 3;
 
485
        break;
 
486
 
 
487
      case DRIZZLE_TYPE_DOUBLE:
 
488
        pos[6]= 5;
 
489
        break;
 
490
 
 
491
      case DRIZZLE_TYPE_NULL:
 
492
        pos[6]= 6;
 
493
        break;
 
494
 
 
495
      case DRIZZLE_TYPE_TIMESTAMP:
 
496
        pos[6]= 7;
 
497
        break;
 
498
 
 
499
      case DRIZZLE_TYPE_LONGLONG:
 
500
        pos[6]= 8;
 
501
        break;
 
502
 
 
503
      case DRIZZLE_TYPE_DATETIME:
 
504
        pos[6]= 12;
 
505
        break;
 
506
 
 
507
      case DRIZZLE_TYPE_DATE:
 
508
        pos[6]= 14;
 
509
        break;
 
510
 
 
511
      case DRIZZLE_TYPE_VARCHAR:
 
512
        pos[6]= 15;
 
513
        break;
 
514
 
 
515
      case DRIZZLE_TYPE_DECIMAL:
 
516
        pos[6]= (char)246;
 
517
        break;
 
518
 
 
519
      case DRIZZLE_TYPE_ENUM:
 
520
        pos[6]= (char)247;
 
521
        break;
 
522
 
 
523
      case DRIZZLE_TYPE_BLOB:
 
524
        pos[6]= (char)252;
 
525
        break;
 
526
      }
 
527
    }
 
528
    else
 
529
    {
 
530
      /* Add one to compensate for tinyint removal from enum. */
 
531
      pos[6]= field.type + 1;
 
532
    }
 
533
 
 
534
    int2store(pos+7,field.flags);
 
535
    pos[9]= (char) field.decimals;
 
536
    pos[10]= 0;                // For the future
 
537
    pos[11]= 0;                // For the future
 
538
    pos+= 12;
 
539
 
 
540
    packet.length((uint32_t) (pos - packet.ptr()));
 
541
    if (flush())
 
542
      break;
 
543
  }
 
544
 
 
545
  /*
 
546
    Mark the end of meta-data result set, and store session->server_status,
 
547
    to show that there is no cursor.
 
548
    Send no warning information, as it will be sent at statement end.
 
549
  */
 
550
  writeEOFPacket(session->server_status, session->total_warn_count);
 
551
  return 0;
 
552
 
 
553
err:
 
554
  my_message(ER_OUT_OF_RESOURCES, ER(ER_OUT_OF_RESOURCES),
 
555
             MYF(0));
 
556
  return 1;
 
557
}
 
558
 
 
559
bool ClientDrizzleProtocol::store(Field *from)
 
560
{
 
561
  if (from->is_null())
 
562
    return store();
 
563
  char buff[MAX_FIELD_WIDTH];
 
564
  String str(buff,sizeof(buff), &my_charset_bin);
 
565
 
 
566
  from->val_str(&str);
 
567
 
 
568
  return netStoreData((const unsigned char *)str.ptr(), str.length());
 
569
}
 
570
 
 
571
bool ClientDrizzleProtocol::store(void)
 
572
{
 
573
  char buff[1];
 
574
  buff[0]= (char)251;
 
575
  return packet.append(buff, sizeof(buff), PACKET_BUFFER_EXTRA_ALLOC);
 
576
}
 
577
 
 
578
bool ClientDrizzleProtocol::store(int32_t from)
 
579
{
 
580
  char buff[12];
 
581
  return netStoreData((unsigned char*) buff,
 
582
                      (size_t) (internal::int10_to_str(from, buff, -10) - buff));
 
583
}
 
584
 
 
585
bool ClientDrizzleProtocol::store(uint32_t from)
 
586
{
 
587
  char buff[11];
 
588
  return netStoreData((unsigned char*) buff,
 
589
                      (size_t) (internal::int10_to_str(from, buff, 10) - buff));
 
590
}
 
591
 
 
592
bool ClientDrizzleProtocol::store(int64_t from)
 
593
{
 
594
  char buff[22];
 
595
  return netStoreData((unsigned char*) buff,
 
596
                      (size_t) (internal::int64_t10_to_str(from, buff, -10) - buff));
 
597
}
 
598
 
 
599
bool ClientDrizzleProtocol::store(uint64_t from)
 
600
{
 
601
  char buff[21];
 
602
  return netStoreData((unsigned char*) buff,
 
603
                      (size_t) (internal::int64_t10_to_str(from, buff, 10) - buff));
 
604
}
 
605
 
 
606
bool ClientDrizzleProtocol::store(double from, uint32_t decimals, String *buffer)
 
607
{
 
608
  buffer->set_real(from, decimals, session->charset());
 
609
  return netStoreData((unsigned char*) buffer->ptr(), buffer->length());
 
610
}
 
611
 
 
612
bool ClientDrizzleProtocol::store(const char *from, size_t length)
 
613
{
 
614
  return netStoreData((const unsigned char *)from, length);
 
615
}
 
616
 
 
617
bool ClientDrizzleProtocol::wasAborted(void)
 
618
{
 
619
  return net.error && net.vio != 0;
 
620
}
 
621
 
 
622
bool ClientDrizzleProtocol::haveMoreData(void)
 
623
{
 
624
  return drizzleclient_net_more_data(&net);
 
625
}
 
626
 
 
627
bool ClientDrizzleProtocol::haveError(void)
 
628
{
 
629
  return net.error || net.vio == 0;
 
630
}
 
631
 
 
632
bool ClientDrizzleProtocol::checkConnection(void)
 
633
{
 
634
  uint32_t pkt_len= 0;
 
635
  char *end;
 
636
 
 
637
  // TCP/IP connection
 
638
  {
 
639
    char ip[NI_MAXHOST];
 
640
    uint16_t peer_port;
 
641
 
 
642
    if (drizzleclient_net_peer_addr(&net, ip, &peer_port, NI_MAXHOST))
 
643
    {
 
644
      my_error(ER_BAD_HOST_ERROR, MYF(0), session->getSecurityContext().getIp().c_str());
 
645
      return false;
 
646
    }
 
647
 
 
648
    session->getSecurityContext().setIp(ip);
 
649
  }
 
650
  drizzleclient_net_keepalive(&net, true);
 
651
 
 
652
  uint32_t server_capabilites;
 
653
  {
 
654
    /* buff[] needs to big enough to hold the server_version variable */
 
655
    char buff[SERVER_VERSION_LENGTH + SCRAMBLE_LENGTH + 64];
 
656
 
 
657
    server_capabilites= CLIENT_BASIC_FLAGS;
 
658
 
 
659
    if (using_mysql41_protocol)
 
660
      server_capabilites|= CLIENT_PROTOCOL_MYSQL41;
 
661
 
 
662
#ifdef HAVE_COMPRESS
 
663
    server_capabilites|= CLIENT_COMPRESS;
 
664
#endif /* HAVE_COMPRESS */
 
665
 
 
666
    end= buff + strlen(PANDORA_RELEASE_VERSION);
 
667
    if ((end - buff) >= SERVER_VERSION_LENGTH)
 
668
      end= buff + (SERVER_VERSION_LENGTH - 1);
 
669
    memcpy(buff, PANDORA_RELEASE_VERSION, end - buff);
 
670
    *end= 0;
 
671
    end++;
 
672
 
 
673
    int4store((unsigned char*) end, global_thread_id);
 
674
    end+= 4;
 
675
 
 
676
    /* We don't use scramble anymore. */
 
677
    memset(end, 'X', SCRAMBLE_LENGTH_323);
 
678
    end+= SCRAMBLE_LENGTH_323;
 
679
    *end++= 0; /* an empty byte for some reason */
 
680
 
 
681
    int2store(end, server_capabilites);
 
682
    /* write server characteristics: up to 16 bytes allowed */
 
683
    end[2]=(char) default_charset_info->number;
 
684
    int2store(end+3, session->server_status);
 
685
    memset(end+5, 0, 13);
 
686
    end+= 18;
 
687
 
 
688
    /* Write scramble tail. */
 
689
    memset(end, 'X', SCRAMBLE_LENGTH - SCRAMBLE_LENGTH_323);
 
690
    end+= (SCRAMBLE_LENGTH - SCRAMBLE_LENGTH_323);
 
691
    *end++= 0; /* an empty byte for some reason */
 
692
 
 
693
    /* At this point we write connection message and read reply */
 
694
    if (drizzleclient_net_write_command(&net
 
695
          , (unsigned char) PROTOCOL_VERSION
 
696
          , (unsigned char*) ""
 
697
          , 0
 
698
          , (unsigned char*) buff
 
699
          , (size_t) (end-buff)) 
 
700
        ||    (pkt_len= drizzleclient_net_read(&net)) == packet_error 
 
701
        || pkt_len < MIN_HANDSHAKE_SIZE)
 
702
    {
 
703
      my_error(ER_HANDSHAKE_ERROR, MYF(0), session->getSecurityContext().getIp().c_str());
 
704
      return false;
 
705
    }
 
706
  }
 
707
  if (packet.alloc(buffer_length))
 
708
    return false; /* The error is set by alloc(). */
 
709
 
 
710
  client_capabilities= uint2korr(net.read_pos);
 
711
 
 
712
 
 
713
  client_capabilities|= ((uint32_t) uint2korr(net.read_pos + 2)) << 16;
 
714
  session->max_client_packet_length= uint4korr(net.read_pos + 4);
 
715
  end= (char*) net.read_pos + 32;
 
716
 
 
717
  /*
 
718
    Disable those bits which are not supported by the server.
 
719
    This is a precautionary measure, if the client lies. See Bug#27944.
 
720
  */
 
721
  client_capabilities&= server_capabilites;
 
722
 
 
723
  if (end >= (char*) net.read_pos + pkt_len + 2)
 
724
  {
 
725
    my_error(ER_HANDSHAKE_ERROR, MYF(0), session->getSecurityContext().getIp().c_str());
 
726
    return false;
 
727
  }
 
728
 
 
729
  net.return_status= &session->server_status;
 
730
 
 
731
  char *user= end;
 
732
  char *passwd= strchr(user, '\0')+1;
 
733
  uint32_t user_len= passwd - user - 1;
 
734
  char *l_db= passwd;
 
735
 
 
736
  /*
 
737
    Old clients send null-terminated string as password; new clients send
 
738
    the size (1 byte) + string (not null-terminated). Hence in case of empty
 
739
    password both send '\0'.
 
740
 
 
741
    This strlen() can't be easily deleted without changing client.
 
742
 
 
743
    Cast *passwd to an unsigned char, so that it doesn't extend the sign for
 
744
    *passwd > 127 and become 2**32-127+ after casting to uint.
 
745
  */
 
746
  uint32_t passwd_len= client_capabilities & CLIENT_SECURE_CONNECTION ?
 
747
    (unsigned char)(*passwd++) : strlen(passwd);
 
748
  l_db= client_capabilities & CLIENT_CONNECT_WITH_DB ? l_db + passwd_len + 1 : 0;
 
749
 
 
750
  /* strlen() can't be easily deleted without changing client */
 
751
  uint32_t db_len= l_db ? strlen(l_db) : 0;
 
752
 
 
753
  if (passwd + passwd_len + db_len > (char *) net.read_pos + pkt_len)
 
754
  {
 
755
    my_error(ER_HANDSHAKE_ERROR, MYF(0), session->getSecurityContext().getIp().c_str());
 
756
    return false;
 
757
  }
 
758
 
 
759
  /* If username starts and ends in "'", chop them off */
 
760
  if (user_len > 1 && user[0] == '\'' && user[user_len - 1] == '\'')
 
761
  {
 
762
    user[user_len-1]= 0;
 
763
    user++;
 
764
    user_len-= 2;
 
765
  }
 
766
 
 
767
  session->getSecurityContext().setUser(user);
 
768
 
 
769
  return session->checkUser(passwd, passwd_len, l_db);
 
770
}
 
771
 
 
772
bool ClientDrizzleProtocol::netStoreData(const unsigned char *from, size_t length)
 
773
{
 
774
  size_t packet_length= packet.length();
 
775
  /*
 
776
     The +9 comes from that strings of length longer than 16M require
 
777
     9 bytes to be stored (see drizzleclient_net_store_length).
 
778
  */
 
779
  if (packet_length+9+length > packet.alloced_length() &&
 
780
      packet.realloc(packet_length+9+length))
 
781
    return 1;
 
782
  unsigned char *to= drizzleclient_net_store_length((unsigned char*) packet.ptr()+packet_length, length);
 
783
  memcpy(to,from,length);
 
784
  packet.length((size_t) (to+length-(unsigned char*) packet.ptr()));
 
785
  return 0;
 
786
}
 
787
 
 
788
/**
 
789
  Format EOF packet according to the current client and
 
790
  write it to the network output buffer.
 
791
*/
 
792
 
 
793
void ClientDrizzleProtocol::writeEOFPacket(uint32_t server_status,
 
794
                                         uint32_t total_warn_count)
 
795
{
 
796
  unsigned char buff[5];
 
797
  /*
 
798
    Don't send warn count during SP execution, as the warn_list
 
799
    is cleared between substatements, and mysqltest gets confused
 
800
  */
 
801
  uint32_t tmp= min(total_warn_count, (uint32_t)65535);
 
802
  buff[0]= DRIZZLE_PROTOCOL_NO_MORE_DATA;
 
803
  int2store(buff+1, tmp);
 
804
  /*
 
805
    The following test should never be true, but it's better to do it
 
806
    because if 'is_fatal_error' is set the server is not going to execute
 
807
    other queries (see the if test in dispatch_command / COM_QUERY)
 
808
  */
 
809
  if (session->is_fatal_error)
 
810
    server_status&= ~SERVER_MORE_RESULTS_EXISTS;
 
811
  int2store(buff + 3, server_status);
 
812
  drizzleclient_net_write(&net, buff, 5);
 
813
}
 
814
 
 
815
static ListenDrizzleProtocol *listen_obj= NULL;
 
816
 
 
817
static int init(module::Context &context)
 
818
{
 
819
  listen_obj= new ListenDrizzleProtocol("drizzle_protocol", false);
 
820
  context.add(listen_obj); 
 
821
  return 0;
 
822
}
 
823
 
 
824
static DRIZZLE_SYSVAR_UINT(port, port, PLUGIN_VAR_RQCMDARG,
 
825
                           N_("Port number to use for connection or 0 for "
 
826
                              "default to, in order of "
 
827
                              "preference, drizzle.cnf, $DRIZZLE_TCP_PORT, "
 
828
                              "built-in default (4427)."),
 
829
                           NULL, NULL, 0, 0, 65535, 0);
 
830
static DRIZZLE_SYSVAR_UINT(connect_timeout, connect_timeout,
 
831
                           PLUGIN_VAR_RQCMDARG, N_("Connect Timeout."),
 
832
                           NULL, NULL, 10, 1, 300, 0);
 
833
static DRIZZLE_SYSVAR_UINT(read_timeout, read_timeout, PLUGIN_VAR_RQCMDARG,
 
834
                           N_("Read Timeout."), NULL, NULL, 30, 1, 300, 0);
 
835
static DRIZZLE_SYSVAR_UINT(write_timeout, write_timeout, PLUGIN_VAR_RQCMDARG,
 
836
                           N_("Write Timeout."), NULL, NULL, 60, 1, 300, 0);
 
837
static DRIZZLE_SYSVAR_UINT(retry_count, retry_count, PLUGIN_VAR_RQCMDARG,
 
838
                           N_("Retry Count."), NULL, NULL, 10, 1, 100, 0);
 
839
static DRIZZLE_SYSVAR_UINT(buffer_length, buffer_length, PLUGIN_VAR_RQCMDARG,
 
840
                           N_("Buffer length."), NULL, NULL, 16384, 1024,
 
841
                           1024*1024, 0);
 
842
static DRIZZLE_SYSVAR_STR(bind_address, bind_address, PLUGIN_VAR_READONLY,
 
843
                          N_("Address to bind to."), NULL, NULL, NULL);
 
844
 
 
845
static drizzle_sys_var* sys_variables[]= {
 
846
  DRIZZLE_SYSVAR(port),
 
847
  DRIZZLE_SYSVAR(connect_timeout),
 
848
  DRIZZLE_SYSVAR(read_timeout),
 
849
  DRIZZLE_SYSVAR(write_timeout),
 
850
  DRIZZLE_SYSVAR(retry_count),
 
851
  DRIZZLE_SYSVAR(buffer_length),
 
852
  DRIZZLE_SYSVAR(bind_address),
 
853
  NULL
 
854
};
146
855
 
147
856
} /* namespace drizzle_protocol */
148
 
} /* namespace drizzle_plugin */
149
857
 
150
 
DRIZZLE_PLUGIN(drizzle_plugin::drizzle_protocol::init, NULL, drizzle_plugin::drizzle_protocol::init_options);
 
858
DRIZZLE_PLUGIN(drizzle_protocol::init, drizzle_protocol::sys_variables);