parse_file.cc 24 KB
Newer Older
unknown's avatar
unknown committed
1 2 3 4
/* Copyright (C) 2004 MySQL AB

   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
unknown's avatar
unknown committed
5
   the Free Software Foundation; version 2 of the License.
unknown's avatar
unknown committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   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 */

// Text .frm files management routines

#include "mysql_priv.h"
#include <errno.h>
#include <m_ctype.h>
#include <my_sys.h>
#include <my_dir.h>


/*
  write string with escaping

  SYNOPSIS
    write_escaped_string()
    file	- IO_CACHE for record
    val_s	- string for writing

  RETURN
    FALSE - OK
    TRUE  - error
*/

static my_bool
write_escaped_string(IO_CACHE *file, LEX_STRING *val_s)
{
  char *eos= val_s->str + val_s->length;
  char *ptr= val_s->str;

  for (; ptr < eos; ptr++)
  {
    /*
      Should be in sync with read_escaped_string() and
48
      parse_quoted_escaped_string()
unknown's avatar
unknown committed
49 50 51
    */
    switch(*ptr) {
    case '\\': // escape character
52
      if (my_b_append(file, (const byte *)STRING_WITH_LEN("\\\\")))
unknown's avatar
unknown committed
53 54 55
	return TRUE;
      break;
    case '\n': // parameter value delimiter
56
      if (my_b_append(file, (const byte *)STRING_WITH_LEN("\\n")))
unknown's avatar
unknown committed
57 58
	return TRUE;
      break;
59
    case '\0': // problem for some string processing utilities
60
      if (my_b_append(file, (const byte *)STRING_WITH_LEN("\\0")))
unknown's avatar
unknown committed
61 62
	return TRUE;
      break;
63
    case 26: // problem for windows utilities (Ctrl-Z)
64
      if (my_b_append(file, (const byte *)STRING_WITH_LEN("\\z")))
unknown's avatar
unknown committed
65 66 67
	return TRUE;
      break;
    case '\'': // list of string delimiter
68
      if (my_b_append(file, (const byte *)STRING_WITH_LEN("\\\'")))
unknown's avatar
unknown committed
69 70 71
	return TRUE;
      break;
    default:
unknown's avatar
unknown committed
72
      if (my_b_append(file, (const byte *)ptr, 1))
unknown's avatar
unknown committed
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
	return TRUE;
    }
  }
  return FALSE;
}


/*
  write parameter value to IO_CACHE

  SYNOPSIS
    write_parameter()
    file	pointer to IO_CACHE structure for writing
    base	pointer to data structure
    parameter	pointer to parameter descriptor
    old_version	for returning back old version number value

  RETURN
    FALSE - OK
    TRUE  - error
*/

static my_bool
write_parameter(IO_CACHE *file, gptr base, File_option *parameter,
		ulonglong *old_version)
{
  char num_buf[20];			// buffer for numeric operations
  // string for numeric operations
  String num(num_buf, sizeof(num_buf), &my_charset_bin);
  DBUG_ENTER("write_parameter");

  switch (parameter->type) {
  case FILE_OPTIONS_STRING:
  {
    LEX_STRING *val_s= (LEX_STRING *)(base + parameter->offset);
unknown's avatar
unknown committed
108
    if (my_b_append(file, (const byte *)val_s->str, val_s->length))
unknown's avatar
unknown committed
109 110 111 112 113 114 115 116 117 118 119 120
      DBUG_RETURN(TRUE);
    break;
  }
  case FILE_OPTIONS_ESTRING:
  {
    if (write_escaped_string(file, (LEX_STRING *)(base + parameter->offset)))
      DBUG_RETURN(TRUE);
    break;
  }
  case FILE_OPTIONS_ULONGLONG:
  {
    num.set(*((ulonglong *)(base + parameter->offset)), &my_charset_bin);
unknown's avatar
unknown committed
121
    if (my_b_append(file, (const byte *)num.ptr(), num.length()))
unknown's avatar
unknown committed
122 123 124 125 126 127 128 129
      DBUG_RETURN(TRUE);
    break;
  }
  case FILE_OPTIONS_REV:
  {
    ulonglong *val_i= (ulonglong *)(base + parameter->offset);
    *old_version= (*val_i)++;
    num.set(*val_i, &my_charset_bin);
unknown's avatar
unknown committed
130
    if (my_b_append(file, (const byte *)num.ptr(), num.length()))
unknown's avatar
unknown committed
131 132 133 134 135 136 137 138 139 140 141 142
      DBUG_RETURN(TRUE);
    break;
  }
  case FILE_OPTIONS_TIMESTAMP:
  {
    /* string have to be allocated already */
    LEX_STRING *val_s= (LEX_STRING *)(base + parameter->offset);
    time_t tm= time(NULL);

    get_date(val_s->str, GETDATE_DATE_TIME|GETDATE_GMT|GETDATE_FIXEDLENGTH,
	     tm);
    val_s->length= PARSE_FILE_TIMESTAMPLENGTH;
unknown's avatar
unknown committed
143 144
    if (my_b_append(file, (const byte *)val_s->str,
                    PARSE_FILE_TIMESTAMPLENGTH))
unknown's avatar
unknown committed
145 146 147 148 149 150 151 152 153 154 155
      DBUG_RETURN(TRUE);
    break;
  }
  case FILE_OPTIONS_STRLIST:
  {
    List_iterator_fast<LEX_STRING> it(*((List<LEX_STRING>*)
					(base + parameter->offset)));
    bool first= 1;
    LEX_STRING *str;
    while ((str= it++))
    {
156
      // We need ' ' after string to detect list continuation
157 158
      if ((!first && my_b_append(file, (const byte *)STRING_WITH_LEN(" "))) ||
	  my_b_append(file, (const byte *)STRING_WITH_LEN("\'")) ||
159
          write_escaped_string(file, str) ||
160
	  my_b_append(file, (const byte *)STRING_WITH_LEN("\'")))
unknown's avatar
unknown committed
161 162 163 164 165 166 167
      {
	DBUG_RETURN(TRUE);
      }
      first= 0;
    }
    break;
  }
168 169 170 171 172 173 174 175 176 177
  case FILE_OPTIONS_ULLLIST:
  {
    List_iterator_fast<ulonglong> it(*((List<ulonglong>*)
                                       (base + parameter->offset)));
    bool first= 1;
    ulonglong *val;
    while ((val= it++))
    {
      num.set(*val, &my_charset_bin);
      // We need ' ' after string to detect list continuation
178
      if ((!first && my_b_append(file, (const byte *)STRING_WITH_LEN(" "))) ||
179 180 181 182 183 184 185 186
          my_b_append(file, (const byte *)num.ptr(), num.length()))
      {
        DBUG_RETURN(TRUE);
      }
      first= 0;
    }
    break;
  }
unknown's avatar
unknown committed
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
  default:
    DBUG_ASSERT(0); // never should happened
  }
  DBUG_RETURN(FALSE);
}


/*
  write new .frm

  SYNOPSIS
    sql_create_definition_file()
    dir			directory where put .frm
    file		.frm file name
    type		.frm type string (VIEW, TABLE)
    base		base address for parameter reading (structure like
			TABLE)
    parameters		parameters description
    max_versions	number of versions to save

  RETURN
    FALSE - OK
    TRUE - error
*/

my_bool
sql_create_definition_file(const LEX_STRING *dir, const LEX_STRING *file_name,
			   const LEX_STRING *type,
			   gptr base, File_option *parameters,
			   uint max_versions)
{
  File handler;
  IO_CACHE file;
  char path[FN_REFLEN+1];	// +1 to put temporary file name for sure
  ulonglong old_version= ULONGLONG_MAX;
  int path_end;
unknown's avatar
unknown committed
223
  File_option *param;
unknown's avatar
unknown committed
224 225
  DBUG_ENTER("sql_create_definition_file");
  DBUG_PRINT("enter", ("Dir: %s, file: %s, base 0x%lx",
226 227
		       dir ? dir->str : "(null)",
                       file_name->str, (ulong) base));
unknown's avatar
unknown committed
228

229 230
  if (dir)
  {
unknown's avatar
unknown committed
231
    fn_format(path, file_name->str, dir->str, "", MY_UNPACK_FILENAME);
232 233 234 235 236 237 238 239 240 241 242
    path_end= strlen(path);
  }
  else
  {
    /*
      if not dir is passed, it means file_name is a full path,
      including dir name, file name itself, and an extension,
      and with unpack_filename() executed over it.
    */    
    path_end= strxnmov(path, FN_REFLEN, file_name->str, NullS) - path;
  }
unknown's avatar
unknown committed
243 244 245 246 247 248 249 250 251 252 253 254 255 256

  // temporary file name
  path[path_end]='~';
  path[path_end+1]= '\0';
  if ((handler= my_create(path, CREATE_MODE, O_RDWR | O_TRUNC,
			  MYF(MY_WME))) <= 0)
  {
    DBUG_RETURN(TRUE);
  }

  if (init_io_cache(&file, handler, 0, SEQ_READ_APPEND, 0L, 0, MYF(MY_WME)))
    goto err_w_file;

  // write header (file signature)
257
  if (my_b_append(&file, (const byte *)STRING_WITH_LEN("TYPE=")) ||
unknown's avatar
unknown committed
258
      my_b_append(&file, (const byte *)type->str, type->length) ||
259
      my_b_append(&file, (const byte *)STRING_WITH_LEN("\n")))
unknown's avatar
unknown committed
260 261 262
    goto err_w_file;

  // write parameters to temporary file
unknown's avatar
unknown committed
263
  for (param= parameters; param->name.str; param++)
unknown's avatar
unknown committed
264
  {
unknown's avatar
unknown committed
265 266
    if (my_b_append(&file, (const byte *)param->name.str,
                    param->name.length) ||
267
	my_b_append(&file, (const byte *)STRING_WITH_LEN("=")) ||
unknown's avatar
unknown committed
268
	write_parameter(&file, base, param, &old_version) ||
269
	my_b_append(&file, (const byte *)STRING_WITH_LEN("\n")))
unknown's avatar
unknown committed
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
      goto err_w_cache;
  }

  if (end_io_cache(&file))
    goto err_w_file;

  if (my_close(handler, MYF(MY_WME)))
  {
    DBUG_RETURN(TRUE);
  }

  // archive copies management
  path[path_end]='\0';
  if (!access(path, F_OK))
  {
    if (old_version != ULONGLONG_MAX && max_versions != 0)
    {
287
      // save backup
unknown's avatar
unknown committed
288 289 290 291 292 293 294 295 296 297 298 299 300 301
      char path_arc[FN_REFLEN];
      // backup old version
      char path_to[FN_REFLEN];

      // check archive directory existence
      fn_format(path_arc, "arc", dir->str, "", MY_UNPACK_FILENAME);
      if (access(path_arc, F_OK))
      {
	if (my_mkdir(path_arc, 0777, MYF(MY_WME)))
	{
	  DBUG_RETURN(TRUE);
	}
      }

302 303
      my_snprintf(path_to, FN_REFLEN, "%s/%s-%04lu",
		  path_arc, file_name->str, (ulong) old_version);
unknown's avatar
unknown committed
304 305 306 307 308 309 310 311
      if (my_rename(path, path_to, MYF(MY_WME)))
      {
	DBUG_RETURN(TRUE);
      }

      // remove very old version
      if (old_version > max_versions)
      {
312
	my_snprintf(path_to, FN_REFLEN, "%s/%s-%04lu",
unknown's avatar
unknown committed
313
		    path_arc, file_name->str,
314
		    (ulong)(old_version - max_versions));
unknown's avatar
unknown committed
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347
	if (!access(path_arc, F_OK) && my_delete(path_to, MYF(MY_WME)))
	{
	  DBUG_RETURN(TRUE);
	}
      }
    }
    else
    {
      if (my_delete(path, MYF(MY_WME)))	// no backups
      {
	DBUG_RETURN(TRUE);
      }
    }
  }

  {
    // rename temporary file
    char path_to[FN_REFLEN];
    memcpy(path_to, path, path_end+1);
    path[path_end]='~';
    if (my_rename(path, path_to, MYF(MY_WME)))
    {
      DBUG_RETURN(TRUE);
    }
  }
  DBUG_RETURN(FALSE);
err_w_cache:
  end_io_cache(&file);
err_w_file:
  my_close(handler, MYF(MY_WME));
  DBUG_RETURN(TRUE);
}

348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369
/*
  Renames a frm file (including backups) in same schema

  SYNOPSIS
    rename_in_schema_file
    schema            name of given schema           
    old_name          original file name
    new_name          new file name
    revision          revision number
    num_view_backups  number of backups

  RETURN
    0 - OK 
    1 - Error (only if renaming of frm failed)

*/
my_bool rename_in_schema_file(const char *schema, const char *old_name, 
                              const char *new_name, ulonglong revision, 
                              uint num_view_backups)
{
  char old_path[FN_REFLEN], new_path[FN_REFLEN], arc_path[FN_REFLEN];

370 371 372 373
  build_table_filename(old_path, sizeof(old_path) - 1,
                       schema, old_name, reg_ext, 0);
  build_table_filename(new_path, sizeof(new_path) - 1,
                       schema, new_name, reg_ext, 0);
374 375 376 377 378

  if (my_rename(old_path, new_path, MYF(MY_WME)))
    return 1;

  /* check if arc_dir exists */
379
  build_table_filename(arc_path, sizeof(arc_path) - 1, schema, "arc", "", 0);
380 381 382
  
  if (revision > 0 && !access(arc_path, F_OK))
  {
383
    char old_name_buf[FN_REFLEN], new_name_buf[FN_REFLEN];
unknown's avatar
unknown committed
384 385
    ulonglong limit= ((revision > num_view_backups) ?
                      revision - num_view_backups : 0);
386 387 388 389

    VOID(tablename_to_filename(old_name, old_name_buf, sizeof(old_name_buf)));
    VOID(tablename_to_filename(new_name, new_name_buf, sizeof(new_name_buf)));

unknown's avatar
unknown committed
390 391
    for (; revision > limit ; revision--)
    {
392
      my_snprintf(old_path, FN_REFLEN, "%s/%s%s-%04lu",
393
		  arc_path, old_name_buf, reg_ext, (ulong) revision);
394 395
      (void) unpack_filename(old_path, old_path);
      my_snprintf(new_path, FN_REFLEN, "%s/%s%s-%04lu",
396
		  arc_path, new_name_buf, reg_ext, (ulong) revision);
397 398 399 400 401 402
      (void) unpack_filename(new_path, new_path);
      my_rename(old_path, new_path, MYF(0));
    }
  }
  return 0;
}
unknown's avatar
unknown committed
403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429

/*
  Prepare frm to parse (read to memory)

  SYNOPSIS
    sql_parse_prepare()
    file_name		- path & filename to .frm file
    mem_root		- MEM_ROOT for buffer allocation
    bad_format_errors	- send errors on bad content

  RETURN
    0 - error
    parser object

  NOTE
    returned pointer + 1 will be type of .frm
*/

File_parser * 
sql_parse_prepare(const LEX_STRING *file_name, MEM_ROOT *mem_root,
		  bool bad_format_errors)
{
  MY_STAT stat_info;
  uint len;
  char *end, *sign;
  File_parser *parser;
  File file;
unknown's avatar
unknown committed
430
  DBUG_ENTER("sql_parse_prepare");
unknown's avatar
unknown committed
431 432 433 434 435 436 437 438

  if (!my_stat(file_name->str, &stat_info, MYF(MY_WME)))
  {
    DBUG_RETURN(0);
  }

  if (stat_info.st_size > INT_MAX-1)
  {
439
    my_error(ER_FPARSER_TOO_BIG_FILE, MYF(0), file_name->str);
unknown's avatar
unknown committed
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457
    DBUG_RETURN(0);
  }

  if (!(parser= new(mem_root) File_parser))
  {
    DBUG_RETURN(0);
  }

  if (!(parser->buff= alloc_root(mem_root, stat_info.st_size+1)))
  {
    DBUG_RETURN(0);
  }

  if ((file= my_open(file_name->str, O_RDONLY | O_SHARE, MYF(MY_WME))) < 0)
  {
    DBUG_RETURN(0);
  }
  
unknown's avatar
unknown committed
458 459
  if ((len= my_read(file, (byte *)parser->buff,
                    stat_info.st_size, MYF(MY_WME))) ==
unknown's avatar
unknown committed
460 461 462 463 464 465 466 467 468 469 470 471
      MY_FILE_ERROR)
  {
    my_close(file, MYF(MY_WME));
    DBUG_RETURN(0);
  }

  if (my_close(file, MYF(MY_WME)))
  {
    DBUG_RETURN(0);
  }

  end= parser->end= parser->buff + len;
472
  *end= '\0'; // barrier for more simple parsing
unknown's avatar
unknown committed
473

474
  // 7 = 5 (TYPE=) + 1 (letter at least of type name) + 1 ('\n')
unknown's avatar
unknown committed
475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
  if (len < 7 ||
      parser->buff[0] != 'T' ||
      parser->buff[1] != 'Y' ||
      parser->buff[2] != 'P' ||
      parser->buff[3] != 'E' ||
      parser->buff[4] != '=')
    goto frm_error;

  // skip signature;
  parser->file_type.str= sign= parser->buff + 5;
  while (*sign >= 'A' && *sign <= 'Z' && sign < end)
    sign++;
  if (*sign != '\n')
    goto frm_error;
  parser->file_type.length= sign - parser->file_type.str;
  // EOS for file signature just for safety
  *sign= '\0';

  parser->start= sign + 1;
  parser->content_ok= 1;

  DBUG_RETURN(parser);

frm_error:
  if (bad_format_errors)
  {
501
    my_error(ER_FPARSER_BAD_HEADER, MYF(0), file_name->str);
unknown's avatar
unknown committed
502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548
    DBUG_RETURN(0);
  }
  else
    DBUG_RETURN(parser); // upper level have to check parser->ok()
}


/*
  parse LEX_STRING

  SYNOPSIS
    parse_string()
    ptr		- pointer on string beginning
    end		- pointer on symbol after parsed string end (still owned
		  by buffer and can be accessed
    mem_root	- MEM_ROOT for parameter allocation
    str		- pointer on string, where results should be stored

  RETURN
    0	- error
    #	- pointer on symbol after string
*/

static char *
parse_string(char *ptr, char *end, MEM_ROOT *mem_root, LEX_STRING *str)
{
  // get string length
  char *eol= strchr(ptr, '\n');

  if (eol >= end)
    return 0;

  str->length= eol - ptr;

  if (!(str->str= alloc_root(mem_root, str->length+1)))
    return 0;

  memcpy(str->str, ptr, str->length);
  str->str[str->length]= '\0'; // just for safety
  return eol+1;
}


/*
  read escaped string from ptr to eol in already allocated str

  SYNOPSIS
549
    read_escaped_string()
unknown's avatar
unknown committed
550 551 552 553 554 555 556 557 558 559 560 561 562 563
    ptr		- pointer on string beginning
    eol		- pointer on character after end of string
    str		- target string

  RETURN
    FALSE - OK
    TRUE  - error
*/

my_bool
read_escaped_string(char *ptr, char *eol, LEX_STRING *str)
{
  char *write_pos= str->str;

unknown's avatar
unknown committed
564
  for (; ptr < eol; ptr++, write_pos++)
unknown's avatar
unknown committed
565 566 567 568 569 570 571 572 573
  {
    char c= *ptr;
    if (c == '\\')
    {
      ptr++;
      if (ptr >= eol)
	return TRUE;
      /*
	Should be in sync with write_escaped_string() and
574
	parse_quoted_escaped_string()
unknown's avatar
unknown committed
575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590
      */
      switch(*ptr) {
      case '\\':
	*write_pos= '\\';
	break;
      case 'n':
	*write_pos= '\n';
	break;
      case '0':
	*write_pos= '\0';
	break;
      case 'z':
	*write_pos= 26;
	break;
      case '\'':
	*write_pos= '\'';
591
        break;
unknown's avatar
unknown committed
592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619
      default:
	return TRUE;
      }
    }
    else
      *write_pos= c;
  }
  str->str[str->length= write_pos-str->str]= '\0'; // just for safety
  return FALSE;
}


/*
  parse \n delimited escaped string

  SYNOPSIS
    parse_escaped_string()
    ptr		- pointer on string beginning
    end		- pointer on symbol after parsed string end (still owned
		  by buffer and can be accessed
    mem_root	- MEM_ROOT for parameter allocation
    str		- pointer on string, where results should be stored

  RETURN
    0	- error
    #	- pointer on symbol after string
*/

620
char *
unknown's avatar
unknown committed
621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637
parse_escaped_string(char *ptr, char *end, MEM_ROOT *mem_root, LEX_STRING *str)
{
  char *eol= strchr(ptr, '\n');

  if (eol == 0 || eol >= end ||
      !(str->str= alloc_root(mem_root, (eol - ptr) + 1)) ||
      read_escaped_string(ptr, eol, str))
    return 0;
    
  return eol+1;
}


/*
  parse '' delimited escaped string

  SYNOPSIS
638
    parse_quoted_escaped_string()
unknown's avatar
unknown committed
639 640 641 642 643 644 645 646 647 648 649 650
    ptr		- pointer on string beginning
    end		- pointer on symbol after parsed string end (still owned
		  by buffer and can be accessed
    mem_root	- MEM_ROOT for parameter allocation
    str		- pointer on string, where results should be stored

  RETURN
    0	- error
    #	- pointer on symbol after string
*/

static char *
651
parse_quoted_escaped_string(char *ptr, char *end,
unknown's avatar
unknown committed
652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678
			    MEM_ROOT *mem_root, LEX_STRING *str)
{
  char *eol;
  uint result_len= 0;
  bool escaped= 0;

  // starting '
  if (*(ptr++) != '\'')
    return 0;

  // find ending '
  for (eol= ptr; (*eol != '\'' || escaped) && eol < end; eol++)
  {
    if (!(escaped= (*eol == '\\' && !escaped)))
      result_len++;
  }

  // process string
  if (eol >= end ||
      !(str->str= alloc_root(mem_root, result_len + 1)) ||
      read_escaped_string(ptr, eol, str))
    return 0;

  return eol+1;
}


679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733
/*
  Parser for FILE_OPTIONS_ULLLIST type value.

  SYNOPSIS
    get_file_options_ulllist()
    ptr                  [in/out] pointer to parameter
    end                  [in] end of the configuration
    line                 [in] pointer to the line begining
    base                 [in] base address for parameter writing (structure
                              like TABLE)
    parameter            [in] description
    mem_root             [in] MEM_ROOT for parameters allocation
*/

bool get_file_options_ulllist(char *&ptr, char *end, char *line,
                              gptr base, File_option *parameter,
                              MEM_ROOT *mem_root)
{
  List<ulonglong> *nlist= (List<ulonglong>*)(base + parameter->offset);
  ulonglong *num;
  nlist->empty();
  // list parsing
  while (ptr < end)
  {
    int not_used;
    char *num_end= end;
    if (!(num= (ulonglong*)alloc_root(mem_root, sizeof(ulonglong))) ||
        nlist->push_back(num, mem_root))
      goto nlist_err;
    *num= my_strtoll10(ptr, &num_end, &not_used);
    ptr= num_end;
    switch (*ptr) {
    case '\n':
      goto end_of_nlist;
    case ' ':
      // we cant go over buffer bounds, because we have \0 at the end
      ptr++;
      break;
    default:
      goto nlist_err_w_message;
    }
  }

end_of_nlist:
  if (*(ptr++) != '\n')
    goto nlist_err;
  return FALSE;

nlist_err_w_message:
  my_error(ER_FPARSER_ERROR_IN_PARAMETER, MYF(0), parameter->name.str, line);
nlist_err:
  return TRUE;
}


unknown's avatar
unknown committed
734 735
/*
  parse parameters
unknown's avatar
unknown committed
736

unknown's avatar
unknown committed
737 738 739 740 741 742
  SYNOPSIS
    File_parser::parse()
    base                base address for parameter writing (structure like
                        TABLE)
    mem_root            MEM_ROOT for parameters allocation
    parameters          parameters description
unknown's avatar
unknown committed
743 744 745 746 747
    required            number of parameters in the above list. If the file
                        contains more parameters than "required", they will
                        be ignored. If the file contains less parameters
                        then "required", non-existing parameters will
                        remain their values.
748 749
    hook                hook called for unknown keys
    hook_data           some data specific for the hook
unknown's avatar
unknown committed
750 751 752 753 754 755 756 757

  RETURN
    FALSE - OK
    TRUE - error
*/

my_bool
File_parser::parse(gptr base, MEM_ROOT *mem_root,
758 759
                   struct File_option *parameters, uint required,
                   Unknown_key_hook *hook)
unknown's avatar
unknown committed
760 761
{
  uint first_param= 0, found= 0;
762
  char *ptr= start;
unknown's avatar
unknown committed
763 764 765 766 767 768 769 770 771 772 773 774 775
  char *eol;
  LEX_STRING *str;
  List<LEX_STRING> *list;
  DBUG_ENTER("File_parser::parse");

  while (ptr < end && found < required)
  {
    char *line= ptr;
    if (*ptr == '#')
    {
      // it is comment
      if (!(ptr= strchr(ptr, '\n')))
      {
776
	my_error(ER_FPARSER_EOF_IN_COMMENT, MYF(0), line);
unknown's avatar
unknown committed
777 778 779 780 781 782 783 784 785
	DBUG_RETURN(TRUE);
      }
      ptr++;
    }
    else
    {
      File_option *parameter= parameters+first_param,
	*parameters_end= parameters+required;
      int len= 0;
unknown's avatar
unknown committed
786
      for (; parameter < parameters_end; parameter++)
unknown's avatar
unknown committed
787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817
      {
	len= parameter->name.length;
	// check length
	if (len < (end-ptr) && ptr[len] != '=')
	  continue;
	// check keyword
	if (memcmp(parameter->name.str, ptr, len) == 0)
	  break;
      }

      if (parameter < parameters_end)
      {
	found++;
	/*
	  if we found first parameter, start search from next parameter
	  next time.
	  (this small optimisation should work, because they should be
	  written in same order)
	*/
	if (parameter == parameters+first_param)
	  first_param++;

	// get value
	ptr+= (len+1);
	switch (parameter->type) {
	case FILE_OPTIONS_STRING:
	{
	  if (!(ptr= parse_string(ptr, end, mem_root,
				  (LEX_STRING *)(base +
						 parameter->offset))))
	  {
818 819
	    my_error(ER_FPARSER_ERROR_IN_PARAMETER, MYF(0),
                     parameter->name.str, line);
unknown's avatar
unknown committed
820 821 822 823 824 825 826 827 828 829
	    DBUG_RETURN(TRUE);
	  }
	  break;
	}
	case FILE_OPTIONS_ESTRING:
	{
	  if (!(ptr= parse_escaped_string(ptr, end, mem_root,
					  (LEX_STRING *)
					  (base + parameter->offset))))
	  {
830 831
	    my_error(ER_FPARSER_ERROR_IN_PARAMETER, MYF(0),
                     parameter->name.str, line);
unknown's avatar
unknown committed
832 833 834 835 836 837 838 839
	    DBUG_RETURN(TRUE);
	  }
	  break;
	}
	case FILE_OPTIONS_ULONGLONG:
	case FILE_OPTIONS_REV:
	  if (!(eol= strchr(ptr, '\n')))
	  {
840 841
	    my_error(ER_FPARSER_ERROR_IN_PARAMETER, MYF(0),
                     parameter->name.str, line);
unknown's avatar
unknown committed
842 843
	    DBUG_RETURN(TRUE);
	  }
unknown's avatar
unknown committed
844 845 846 847 848
          {
            int not_used;
	    *((ulonglong*)(base + parameter->offset))=
              my_strtoll10(ptr, 0, &not_used);
          }
unknown's avatar
unknown committed
849 850 851 852 853 854 855 856 857
	  ptr= eol+1;
	  break;
	case FILE_OPTIONS_TIMESTAMP:
	{
	  /* string have to be allocated already */
	  LEX_STRING *val= (LEX_STRING *)(base + parameter->offset);
	  /* yyyy-mm-dd HH:MM:SS = 19(PARSE_FILE_TIMESTAMPLENGTH) characters */
	  if (ptr[PARSE_FILE_TIMESTAMPLENGTH] != '\n')
	  {
858 859
	    my_error(ER_FPARSER_ERROR_IN_PARAMETER, MYF(0),
                     parameter->name.str, line);
unknown's avatar
unknown committed
860 861 862 863 864 865 866 867 868
	    DBUG_RETURN(TRUE);
	  }
	  memcpy(val->str, ptr, PARSE_FILE_TIMESTAMPLENGTH);
	  val->str[val->length= PARSE_FILE_TIMESTAMPLENGTH]= '\0';
	  ptr+= (PARSE_FILE_TIMESTAMPLENGTH+1);
	  break;
	}
	case FILE_OPTIONS_STRLIST:
	{
unknown's avatar
unknown committed
869
          list= (List<LEX_STRING>*)(base + parameter->offset);
870

unknown's avatar
unknown committed
871 872 873 874 875 876
	  list->empty();
	  // list parsing
	  while (ptr < end)
	  {
	    if (!(str= (LEX_STRING*)alloc_root(mem_root,
					       sizeof(LEX_STRING))) ||
unknown's avatar
unknown committed
877
		list->push_back(str, mem_root))
unknown's avatar
unknown committed
878
	      goto list_err;
unknown's avatar
unknown committed
879
	    if (!(ptr= parse_quoted_escaped_string(ptr, end, mem_root, str)))
unknown's avatar
unknown committed
880 881 882 883 884 885 886 887 888 889 890 891
	      goto list_err_w_message;
	    switch (*ptr) {
	    case '\n':
	      goto end_of_list;
	    case ' ':
	      // we cant go over buffer bounds, because we have \0 at the end
	      ptr++;
	      break;
	    default:
	      goto list_err_w_message;
	    }
	  }
892 893

end_of_list:
unknown's avatar
unknown committed
894 895 896 897
	  if (*(ptr++) != '\n')
	    goto list_err;
	  break;

898
list_err_w_message:
899 900
	  my_error(ER_FPARSER_ERROR_IN_PARAMETER, MYF(0),
                   parameter->name.str, line);
901
list_err:
unknown's avatar
unknown committed
902 903
	  DBUG_RETURN(TRUE);
	}
904
        case FILE_OPTIONS_ULLLIST:
905 906 907
          if (get_file_options_ulllist(ptr, end, line, base,
                                       parameter, mem_root))
            DBUG_RETURN(TRUE);
908
          break;
unknown's avatar
unknown committed
909 910 911 912 913 914
	default:
	  DBUG_ASSERT(0); // never should happened
	}
      }
      else
      {
915 916 917 918 919 920 921 922 923 924 925 926
        ptr= line;
        if (hook->process_unknown_string(ptr, base, mem_root, end))
        {
          DBUG_RETURN(TRUE);
        }
        // skip unknown parameter
        if (!(ptr= strchr(ptr, '\n')))
        {
          my_error(ER_FPARSER_EOF_IN_UNKNOWN_PARAMETER, MYF(0), line);
          DBUG_RETURN(TRUE);
        }
        ptr++;
unknown's avatar
unknown committed
927 928 929
      }
    }
  }
unknown's avatar
unknown committed
930 931 932 933 934 935 936

  /*
    NOTE: if we read less than "required" parameters, it is still Ok.
    Probably, we've just read the file of the previous version, which
    contains less parameters.
  */

unknown's avatar
unknown committed
937 938
  DBUG_RETURN(FALSE);
}
939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969


/*
  Dummy unknown key hook

  SYNOPSIS
    File_parser_dummy_hook::process_unknown_string()
    unknown_key          [in/out] reference on the line with unknown
                                  parameter and the parsing point
    base                 [in] base address for parameter writing (structure like
                              TABLE)
    mem_root             [in] MEM_ROOT for parameters allocation
    end                  [in] the end of the configuration

  NOTE
    This hook used to catch no longer supported keys and process them for
    backward compatibility, but it will not slow down processing of modern
    format files.
    This hook does nothing except debug output.

  RETURN
    FALSE OK
    TRUE  Error
*/

bool
File_parser_dummy_hook::process_unknown_string(char *&unknown_key,
                                               gptr base, MEM_ROOT *mem_root,
                                               char *end)
{
  DBUG_ENTER("file_parser_dummy_hook::process_unknown_string");
unknown's avatar
unknown committed
970
  DBUG_PRINT("info", ("Unknown key: '%60s'", unknown_key));
971 972
  DBUG_RETURN(FALSE);
}