~drizzle-trunk/drizzle/development

/* Copyright (C) 2000-2006 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

   the Free Software Foundation; version 2 of the License.

   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 */

/* Copy data from a textfile to table */

/* 2006-12 Erik Wetterberg : LOAD XML added */

#include "mysql_priv.h"

#include <my_dir.h>

#include <m_ctype.h>

#include "sql_repl.h"

class XML_TAG {

public:

  int level;

  String field;

  String value;

  XML_TAG(int l, String f, String v);

};

XML_TAG::XML_TAG(int l, String f, String v)

{

  level= l;

  field.append(f);

  value.append(v);

}

class READ_INFO {

  File	file;

  uchar	*buffer,			/* Buffer for read text */

	*end_of_buff;			/* Data in bufferts ends here */

  uint	buff_length,			/* Length of buffert */

	max_length;			/* Max length of row */

  char	*field_term_ptr,*line_term_ptr,*line_start_ptr,*line_start_end;

  uint	field_term_length,line_term_length,enclosed_length;

  int	field_term_char,line_term_char,enclosed_char,escape_char;

  int	*stack,*stack_pos;

  bool	found_end_of_line,start_of_line,eof;

  bool  need_end_io_cache;

  IO_CACHE cache;

  NET *io_net;

  int level; /* for load xml */

public:

  bool error,line_cuted,found_null,enclosed;

  uchar	*row_start,			/* Found row starts here */

	*row_end;			/* Found row ends here */

  CHARSET_INFO *read_charset;

  READ_INFO(File file,uint tot_length,CHARSET_INFO *cs,

	    String &field_term,String &line_start,String &line_term,

	    String &enclosed,int escape,bool get_it_from_net, bool is_fifo);

  ~READ_INFO();

  int read_field();

  int read_fixed_length(void);

  int next_line(void);

  char unescape(char chr);

  int terminator(char *ptr,uint length);

  bool find_start_of_fields();

  /* load xml */

  List<XML_TAG> taglist;

  int read_value(int delim, String *val);

  int read_xml();

  int clear_level(int level);

  /*

    We need to force cache close before destructor is invoked to log

    the last read block

  */

  void end_io_cache()

  {

    ::end_io_cache(&cache);

    need_end_io_cache = 0;

  }

  /*

    Either this method, or we need to make cache public

    Arg must be set from mysql_load() since constructor does not see

    either the table or THD value

  */

  void set_io_cache_arg(void* arg) { cache.arg = arg; }

};

static int read_fixed_length(THD *thd, COPY_INFO &info, TABLE_LIST *table_list,

                             List<Item> &fields_vars, List<Item> &set_fields,

                             List<Item> &set_values, READ_INFO &read_info,

			     ulong skip_lines,

			     bool ignore_check_option_errors);

static int read_sep_field(THD *thd, COPY_INFO &info, TABLE_LIST *table_list,

                          List<Item> &fields_vars, List<Item> &set_fields,

                          List<Item> &set_values, READ_INFO &read_info,

			  String &enclosed, ulong skip_lines,

			  bool ignore_check_option_errors);

static int read_xml_field(THD *thd, COPY_INFO &info, TABLE_LIST *table_list,

                          List<Item> &fields_vars, List<Item> &set_fields,

                          List<Item> &set_values, READ_INFO &read_info,

                          String &enclosed, ulong skip_lines,

                          bool ignore_check_option_errors);

static bool write_execute_load_query_log_event(THD *thd,

					       bool duplicates, bool ignore,

					       bool transactional_table,

                                               THD::killed_state killed_status);

/*

  Execute LOAD DATA query

  SYNOPSYS

    mysql_load()

      thd - current thread

      ex  - sql_exchange object representing source file and its parsing rules

      table_list  - list of tables to which we are loading data

      fields_vars - list of fields and variables to which we read

                    data from file

      set_fields  - list of fields mentioned in set clause

      set_values  - expressions to assign to fields in previous list

      handle_duplicates - indicates whenever we should emit error or

                          replace row if we will meet duplicates.

      ignore -          - indicates whenever we should ignore duplicates

      read_file_from_client - is this LOAD DATA LOCAL ?

  RETURN VALUES

    true - error / false - success

*/

int mysql_load(THD *thd,sql_exchange *ex,TABLE_LIST *table_list,

	        List<Item> &fields_vars, List<Item> &set_fields,

                List<Item> &set_values,

                enum enum_duplicates handle_duplicates, bool ignore,

                bool read_file_from_client)

{

  char name[FN_REFLEN];

  File file;

  TABLE *table= NULL;

  int error;

  String *field_term=ex->field_term,*escaped=ex->escaped;

  String *enclosed=ex->enclosed;

  bool is_fifo=0;

  LOAD_FILE_INFO lf_info;

  char *db = table_list->db;			// This is never null

  /*

    If path for file is not defined, we will use the current database.

    If this is not set, we will use the directory where the table to be

    loaded is located

  */

  char *tdb= thd->db ? thd->db : db;		// Result is never null

  ulong skip_lines= ex->skip_lines;

  bool transactional_table;

  THD::killed_state killed_status= THD::NOT_KILLED;

  if (escaped->length() > 1 || enclosed->length() > 1)

  {

    my_message(ER_WRONG_FIELD_TERMINATORS,ER(ER_WRONG_FIELD_TERMINATORS),

	       MYF(0));

    return(true);

  }

  if (open_and_lock_tables(thd, table_list))

    return(true);

  if (setup_tables_and_check_access(thd, &thd->lex->select_lex.context,

                                    &thd->lex->select_lex.top_join_list,

                                    table_list,

                                    &thd->lex->select_lex.leaf_tables, true))

     return(-1);

  /*

    Let us emit an error if we are loading data to table which is used

    in subselect in SET clause like we do it for INSERT.

    The main thing to fix to remove this restriction is to ensure that the

    table is marked to be 'used for insert' in which case we should never

    mark this table as 'const table' (ie, one that has only one row).

  */

  if (unique_table(thd, table_list, table_list->next_global, 0))

  {

    my_error(ER_UPDATE_TABLE_USED, MYF(0), table_list->table_name);

    return(true);

  }

  table= table_list->table;

  transactional_table= table->file->has_transactions();

  if (!fields_vars.elements)

  {

    Field **field;

    for (field=table->field; *field ; field++)

      fields_vars.push_back(new Item_field(*field));

    bitmap_set_all(table->write_set);

    table->timestamp_field_type= TIMESTAMP_NO_AUTO_SET;

    /*

      Let us also prepare SET clause, altough it is probably empty

      in this case.

    */

    if (setup_fields(thd, 0, set_fields, MARK_COLUMNS_WRITE, 0, 0) ||

        setup_fields(thd, 0, set_values, MARK_COLUMNS_READ, 0, 0))

      return(true);

  }

  else

  {						// Part field list

    /* TODO: use this conds for 'WITH CHECK OPTIONS' */

    if (setup_fields(thd, 0, fields_vars, MARK_COLUMNS_WRITE, 0, 0) ||

        setup_fields(thd, 0, set_fields, MARK_COLUMNS_WRITE, 0, 0) ||

        check_that_all_fields_are_given_values(thd, table, table_list))

      return(true);

    /*

      Check whenever TIMESTAMP field with auto-set feature specified

      explicitly.

    */

    if (table->timestamp_field)

    {

      if (bitmap_is_set(table->write_set,

                        table->timestamp_field->field_index))

        table->timestamp_field_type= TIMESTAMP_NO_AUTO_SET;

      else

      {

        bitmap_set_bit(table->write_set,

                       table->timestamp_field->field_index);

      }

    }

    /* Fix the expressions in SET clause */

    if (setup_fields(thd, 0, set_values, MARK_COLUMNS_READ, 0, 0))

      return(true);

  }

  table->mark_columns_needed_for_insert();

  uint tot_length=0;

  bool use_blobs= 0, use_vars= 0;

  List_iterator_fast<Item> it(fields_vars);

  Item *item;

  while ((item= it++))

  {

    Item *real_item= item->real_item();

    if (real_item->type() == Item::FIELD_ITEM)

    {

      Field *field= ((Item_field*)real_item)->field;

      if (field->flags & BLOB_FLAG)

      {

        use_blobs= 1;

        tot_length+= 256;			// Will be extended if needed

      }

      else

        tot_length+= field->field_length;

    }

    else if (item->type() == Item::STRING_ITEM)

      use_vars= 1;

  }

  if (use_blobs && !ex->line_term->length() && !field_term->length())

  {

    my_message(ER_BLOBS_AND_NO_TERMINATED,ER(ER_BLOBS_AND_NO_TERMINATED),

	       MYF(0));

    return(true);

  }

  if (use_vars && !field_term->length() && !enclosed->length())

  {

    my_error(ER_LOAD_FROM_FIXED_SIZE_ROWS_TO_VAR, MYF(0));

    return(true);

  }

  /* We can't give an error in the middle when using LOCAL files */

  if (read_file_from_client && handle_duplicates == DUP_ERROR)

    ignore= 1;

  if (read_file_from_client)

  {

    (void)net_request_file(&thd->net,ex->file_name);

    file = -1;

  }

  else

  {

#ifdef DONT_ALLOW_FULL_LOAD_DATA_PATHS

    ex->file_name+=dirname_length(ex->file_name);

#endif

    if (!dirname_length(ex->file_name))

    {

      strxnmov(name, FN_REFLEN-1, mysql_real_data_home, tdb, NullS);

      (void) fn_format(name, ex->file_name, name, "",

		       MY_RELATIVE_PATH | MY_UNPACK_FILENAME);

    }

    else

    {

      (void) fn_format(name, ex->file_name, mysql_real_data_home, "",

		       MY_RELATIVE_PATH | MY_UNPACK_FILENAME);

      if (opt_secure_file_priv &&

          strncmp(opt_secure_file_priv, name, strlen(opt_secure_file_priv)))

      {

        /* Read only allowed from within dir specified by secure_file_priv */

        my_error(ER_OPTION_PREVENTS_STATEMENT, MYF(0), "--secure-file-priv");

        return(true);

      }

      struct stat stat_info;

      if (stat(name,&stat_info))

	return(true);

      // if we are not in slave thread, the file must be:

      if (!thd->slave_thread &&

	  !((stat_info.st_mode & S_IROTH) == S_IROTH &&  // readable by others

	    (stat_info.st_mode & S_IFLNK) != S_IFLNK && // and not a symlink

	    ((stat_info.st_mode & S_IFREG) == S_IFREG ||

	     (stat_info.st_mode & S_IFIFO) == S_IFIFO)))

      {

	my_error(ER_TEXTFILE_NOT_READABLE, MYF(0), name);

	return(true);

      }

      if ((stat_info.st_mode & S_IFIFO) == S_IFIFO)

	is_fifo = 1;

    }

    if ((file=my_open(name,O_RDONLY,MYF(MY_WME))) < 0)

      return(true);

  }

  COPY_INFO info;

  bzero((char*) &info,sizeof(info));

  info.ignore= ignore;

  info.handle_duplicates=handle_duplicates;

  info.escape_char=escaped->length() ? (*escaped)[0] : INT_MAX;

  READ_INFO read_info(file,tot_length,

                      ex->cs ? ex->cs : thd->variables.collation_database,

		      *field_term,*ex->line_start, *ex->line_term, *enclosed,

		      info.escape_char, read_file_from_client, is_fifo);

  if (read_info.error)

  {

    if	(file >= 0)

      my_close(file,MYF(0));			// no files in net reading

    return(true);				// Can't allocate buffers

  }

  if (mysql_bin_log.is_open())

  {

    lf_info.thd = thd;

    lf_info.wrote_create_file = 0;

    lf_info.last_pos_in_file = HA_POS_ERROR;

    lf_info.log_delayed= transactional_table;

    read_info.set_io_cache_arg((void*) &lf_info);

  }

  thd->count_cuted_fields= CHECK_FIELD_WARN;		/* calc cuted fields */

  thd->cuted_fields=0L;

  /* Skip lines if there is a line terminator */

  if (ex->line_term->length() && ex->filetype != FILETYPE_XML)

  {

    /* ex->skip_lines needs to be preserved for logging */

    while (skip_lines > 0)

    {

      skip_lines--;

      if (read_info.next_line())

	break;

    }

  }

  if (!(error=test(read_info.error)))

  {

    table->next_number_field=table->found_next_number_field;

    if (ignore ||

	handle_duplicates == DUP_REPLACE)

      table->file->extra(HA_EXTRA_IGNORE_DUP_KEY);

    if (handle_duplicates == DUP_REPLACE)

        table->file->extra(HA_EXTRA_WRITE_CAN_REPLACE);

    table->file->ha_start_bulk_insert((ha_rows) 0);

    table->copy_blobs=1;

    thd->abort_on_warning= (!ignore &&

                            (thd->variables.sql_mode &

                             (MODE_STRICT_TRANS_TABLES |

                              MODE_STRICT_ALL_TABLES)));

    if (ex->filetype == FILETYPE_XML) /* load xml */

      error= read_xml_field(thd, info, table_list, fields_vars,

                            set_fields, set_values, read_info,

                            *(ex->line_term), skip_lines, ignore);

    else if (!field_term->length() && !enclosed->length())

      error= read_fixed_length(thd, info, table_list, fields_vars,

                               set_fields, set_values, read_info,

			       skip_lines, ignore);

    else

      error= read_sep_field(thd, info, table_list, fields_vars,

                            set_fields, set_values, read_info,

			    *enclosed, skip_lines, ignore);

    if (table->file->ha_end_bulk_insert() && !error)

    {

      table->file->print_error(my_errno, MYF(0));

      error= 1;

    }

    table->file->extra(HA_EXTRA_NO_IGNORE_DUP_KEY);

    table->file->extra(HA_EXTRA_WRITE_CANNOT_REPLACE);

    table->next_number_field=0;

  }

  if (file >= 0)

    my_close(file,MYF(0));

  free_blobs(table);				/* if pack_blob was used */

  table->copy_blobs=0;

  thd->count_cuted_fields= CHECK_FIELD_IGNORE;

  /* 

     simulated killing in the middle of per-row loop

     must be effective for binlogging

  */

  killed_status= (error == 0)? THD::NOT_KILLED : thd->killed;

  if (error)

  {

    if (read_file_from_client)

      while (!read_info.next_line())

	;

    if (mysql_bin_log.is_open())

    {

      {

	/*

	  Make sure last block (the one which caused the error) gets

	  logged.  This is needed because otherwise after write of (to

	  the binlog, not to read_info (which is a cache))

	  Delete_file_log_event the bad block will remain in read_info

	  (because pre_read is not called at the end of the last

	  block; remember pre_read is called whenever a new block is

	  read from disk).  At the end of mysql_load(), the destructor

	  of read_info will call end_io_cache() which will flush

	  read_info, so we will finally have this in the binlog:

	  Append_block # The last successfull block

	  Delete_file

	  Append_block # The failing block

	  which is nonsense.

	  Or could also be (for a small file)

	  Create_file  # The failing block

	  which is nonsense (Delete_file is not written in this case, because:

	  Create_file has not been written, so Delete_file is not written, then

	  when read_info is destroyed end_io_cache() is called which writes

	  Create_file.

	*/

	read_info.end_io_cache();

	/* If the file was not empty, wrote_create_file is true */

	if (lf_info.wrote_create_file)

	{

	  if (thd->transaction.stmt.modified_non_trans_table)

	    write_execute_load_query_log_event(thd, handle_duplicates,

					       ignore, transactional_table,

                                               killed_status);

	  else

	  {

	    Delete_file_log_event d(thd, db, transactional_table);

            d.flags|= LOG_EVENT_UPDATE_TABLE_MAP_VERSION_F;

	    mysql_bin_log.write(&d);

	  }

	}

      }

    }

    error= -1;				// Error on read

    goto err;

  }

  sprintf(name, ER(ER_LOAD_INFO), (ulong) info.records, (ulong) info.deleted,

	  (ulong) (info.records - info.copied), (ulong) thd->cuted_fields);

  if (thd->transaction.stmt.modified_non_trans_table)

    thd->transaction.all.modified_non_trans_table= true;

  if (mysql_bin_log.is_open())

  {

    /*

      We need to do the job that is normally done inside

      binlog_query() here, which is to ensure that the pending event

      is written before tables are unlocked and before any other

      events are written.  We also need to update the table map

      version for the binary log to mark that table maps are invalid

      after this point.

     */

    if (thd->current_stmt_binlog_row_based)

      thd->binlog_flush_pending_rows_event(true);

    else

    {

      /*

        As already explained above, we need to call end_io_cache() or the last

        block will be logged only after Execute_load_query_log_event (which is

        wrong), when read_info is destroyed.

      */

      read_info.end_io_cache();

      if (lf_info.wrote_create_file)

      {

        write_execute_load_query_log_event(thd, handle_duplicates, ignore,

                                           transactional_table,killed_status);

      }

    }

  }

  /* ok to client sent only after binlog write and engine commit */

  my_ok(thd, info.copied + info.deleted, 0L, name);

err:

  assert(transactional_table || !(info.copied || info.deleted) ||

              thd->transaction.stmt.modified_non_trans_table);

  table->file->ha_release_auto_increment();

  table->auto_increment_field_not_null= false;

  thd->abort_on_warning= 0;

  return(error);

}

/* Not a very useful function; just to avoid duplication of code */

static bool write_execute_load_query_log_event(THD *thd,

					       bool duplicates, bool ignore,

					       bool transactional_table,

                                               THD::killed_state killed_err_arg)

{

  Execute_load_query_log_event

    e(thd, thd->query, thd->query_length,

      (char*)thd->lex->fname_start - (char*)thd->query,

      (char*)thd->lex->fname_end - (char*)thd->query,

      (duplicates == DUP_REPLACE) ? LOAD_DUP_REPLACE :

      (ignore ? LOAD_DUP_IGNORE : LOAD_DUP_ERROR),

      transactional_table, false, killed_err_arg);

  e.flags|= LOG_EVENT_UPDATE_TABLE_MAP_VERSION_F;

  return mysql_bin_log.write(&e);

}

/****************************************************************************

** Read of rows of fixed size + optional garage + optonal newline

****************************************************************************/

static int

read_fixed_length(THD *thd, COPY_INFO &info, TABLE_LIST *table_list,

                  List<Item> &fields_vars, List<Item> &set_fields,

                  List<Item> &set_values, READ_INFO &read_info,

                  ulong skip_lines, bool ignore_check_option_errors)

{

  List_iterator_fast<Item> it(fields_vars);

  Item_field *sql_field;

  TABLE *table= table_list->table;

  uint64_t id;

  bool err;

  id= 0;

  while (!read_info.read_fixed_length())

  {

    if (thd->killed)

    {

      thd->send_kill_message();

      return(1);

    }

    if (skip_lines)

    {

      /*

	We could implement this with a simple seek if:

	- We are not using DATA INFILE LOCAL

	- escape character is  ""

	- line starting prefix is ""

      */

      skip_lines--;

      continue;

    }

    it.rewind();

    uchar *pos=read_info.row_start;

#ifdef HAVE_purify

    read_info.row_end[0]=0;

#endif

    restore_record(table, s->default_values);

    /*

      There is no variables in fields_vars list in this format so

      this conversion is safe.

    */

    while ((sql_field= (Item_field*) it++))

    {

      Field *field= sql_field->field;                  

      if (field == table->next_number_field)

        table->auto_increment_field_not_null= true;

      /*

        No fields specified in fields_vars list can be null in this format.

        Mark field as not null, we should do this for each row because of

        restore_record...

      */

      field->set_notnull();

      if (pos == read_info.row_end)

      {

        thd->cuted_fields++;			/* Not enough fields */

        push_warning_printf(thd, MYSQL_ERROR::WARN_LEVEL_WARN, 

                            ER_WARN_TOO_FEW_RECORDS, 

                            ER(ER_WARN_TOO_FEW_RECORDS), thd->row_count);

        if (!field->maybe_null() && field->type() == FIELD_TYPE_TIMESTAMP)

            ((Field_timestamp*) field)->set_time();

      }

      else

      {

	uint length;

	uchar save_chr;

	if ((length=(uint) (read_info.row_end-pos)) >

	    field->field_length)

	  length=field->field_length;

	save_chr=pos[length]; pos[length]='\0'; // Safeguard aganst malloc

        field->store((char*) pos,length,read_info.read_charset);

	pos[length]=save_chr;

	if ((pos+=length) > read_info.row_end)

	  pos= read_info.row_end;	/* Fills rest with space */

      }

    }

    if (pos != read_info.row_end)

    {

      thd->cuted_fields++;			/* To long row */

      push_warning_printf(thd, MYSQL_ERROR::WARN_LEVEL_WARN, 

                          ER_WARN_TOO_MANY_RECORDS, 

                          ER(ER_WARN_TOO_MANY_RECORDS), thd->row_count); 

    }

    if (thd->killed ||

        fill_record(thd, set_fields, set_values,

                    ignore_check_option_errors))

      return(1);

    err= write_record(thd, table, &info);

    table->auto_increment_field_not_null= false;

    if (err)

      return(1);

    /*

      We don't need to reset auto-increment field since we are restoring

      its default value at the beginning of each loop iteration.

    */

    if (read_info.next_line())			// Skip to next line

      break;

    if (read_info.line_cuted)

    {

      thd->cuted_fields++;			/* To long row */

      push_warning_printf(thd, MYSQL_ERROR::WARN_LEVEL_WARN, 

                          ER_WARN_TOO_MANY_RECORDS, 

                          ER(ER_WARN_TOO_MANY_RECORDS), thd->row_count); 

    }

    thd->row_count++;

  }

  return(test(read_info.error));

}

static int

read_sep_field(THD *thd, COPY_INFO &info, TABLE_LIST *table_list,

               List<Item> &fields_vars, List<Item> &set_fields,

               List<Item> &set_values, READ_INFO &read_info,

	       String &enclosed, ulong skip_lines,

	       bool ignore_check_option_errors)

{

  List_iterator_fast<Item> it(fields_vars);

  Item *item;

  TABLE *table= table_list->table;

  uint enclosed_length;

  uint64_t id;

  bool err;

  enclosed_length=enclosed.length();

  id= 0;

  for (;;it.rewind())

  {

    if (thd->killed)

    {

      thd->send_kill_message();

      return(1);

    }

    restore_record(table, s->default_values);

    while ((item= it++))

    {

      uint length;

      uchar *pos;

      Item *real_item;

      if (read_info.read_field())

	break;

      /* If this line is to be skipped we don't want to fill field or var */

      if (skip_lines)

        continue;

      pos=read_info.row_start;

      length=(uint) (read_info.row_end-pos);

      real_item= item->real_item();

      if ((!read_info.enclosed && (enclosed_length && length == 4 && !memcmp(pos, STRING_WITH_LEN("NULL")))) ||

	  (length == 1 && read_info.found_null))

      {

        if (real_item->type() == Item::FIELD_ITEM)

        {

          Field *field= ((Item_field *)real_item)->field;

          if (field->reset())

          {

            my_error(ER_WARN_NULL_TO_NOTNULL, MYF(0), field->field_name,

                     thd->row_count);

            return(1);

          }

          field->set_null();

          if (!field->maybe_null())

          {

            if (field->type() == MYSQL_TYPE_TIMESTAMP)

              ((Field_timestamp*) field)->set_time();

            else if (field != table->next_number_field)

              field->set_warning(MYSQL_ERROR::WARN_LEVEL_WARN,

                                 ER_WARN_NULL_TO_NOTNULL, 1);

          }

	}

        else if (item->type() == Item::STRING_ITEM)

        {

          ((Item_user_var_as_out_param *)item)->set_null_value(

                                                  read_info.read_charset);

        }

        else

        {

          my_error(ER_LOAD_DATA_INVALID_COLUMN, MYF(0), item->full_name());

          return(1);

        }

	continue;

      }

      if (real_item->type() == Item::FIELD_ITEM)

      {

        Field *field= ((Item_field *)real_item)->field;