---

dbimport.h

/* liblookdb: dbimport.h - Database import from flat file 
    Copyright (C) 1998-2001 LOOK Systems

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) any later version.

    This library 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
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this library; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/
#ifndef LIBLOOKDB_DBIMPORT_H
#define LIBLOOKDB_DBIMPORT_H

// $Id: dbimport.h,v 1.13 2001/09/07 12:41:04 clive Exp $

#include "lookdbutils.h"
#include "lkstring.h"
#include "lookstringlist.h"
#include "looklonglist.h"
#include "lookboollist.h"
#include "dbdescribetable.h"
#include "lkdatetimereader.h"
#include <vector>
#include <deque>

namespace look {

typedef std::vector<std::string> StringVector;

class DbConnection;
class DbRow;


class LOOKDBUTILITIES_DLL DbImport
{
public:

        // what are we allowed to do with columns?
        enum ColumnAllowance
        {
                EXACT = 0,                     
                ALLOW_EXTRA_IN_FILE,           
                ALLOW_EXTRA_IN_DATABASE,       
                ALLOW_ANY_EXTRA                
        };

        // import types - behaviour on finding match
        enum ImportMatchBehaviour
        {
                FAIL_IMPORT = 0,              
                FAIL_BUT_IGNORE_DUPLICATE,    
                UPDATE,                       
                IGNORE_NEW                    
        };

        // this is to cope with export files generated by Q&E (or in Q&E style)
        // normal assumes control chars are escaped
        enum TextConversionMode
        {
                CONVERT_NORMAL = 1, 
                CONVERT_TO_QE       
        };

        enum DateFormat
        {
                DATE_FORMAT_NORMAL = 1, 
                DATE_FORMAT_EXTENDED    
        };

        enum ErrorAction
        {
                CONTINUE = 0,  
                ABORT          
        };

        DbImport( DbConnection* theConnection = NULL );

        ~DbImport();

        bool DoImport( const LookString& theFileName );

        void SetPrimaryColumns( const LookString& theColumnNames );
        void SetFromTable( const LookString& theTableName );
        void SetToTable( const LookString& theTableName );

        void SetColumnAllowances( ColumnAllowance theAllowance )
        {
                itsColumnAllowance = theAllowance;
        }

        void SetImportMatchBehaviour( ImportMatchBehaviour theImportMatchBehaviour )
        {
                itsImportMatchBehaviour = theImportMatchBehaviour;
        }

        void SetNULLString( const LookString& theString )
        {
                itsNULLString = theString;
        }

        void SetTextConversionMode( TextConversionMode theConversionMode )
        {
                itsTextConversionMode = theConversionMode;
        }

        void SetDOSLineEnds( bool useCRLF )
        {
                if( useCRLF )
                {
                        itsLFString = "\r\n";
                }
                else
                {
                        itsLFString = "\n";
                }
        }

        long GetNRowsInserted( void )
        {
                return itsNRowsInserted;
        }

        long GetNRowsUpdated( void )
        {
                return itsNRowsUpdated;
        }

        long GetNRowsWithErrors( void )
        {
                return itsNRowsWithErrors;
        }

        void SetAllowNullDates( bool allowNullDates = true )
        {
                itAllowsNullDates = allowNullDates;
        }

        void SetErrorAction( ErrorAction theErrorAction )
        {
                itsErrorAction = theErrorAction;
        }

        void SetDateFormat( DateFormat theDateFormat )
        {
                itsDateFormat = theDateFormat;
        }

        void SetExDatePartOrder( LookDateTimeReader::DatePartOrder theExDatePartOrder )
        {
                itsExDatePartOrder = theExDatePartOrder;
        }

        void SetExDateTimeOrder( LookDateTimeReader::DateTimeOrder theExDateTimeOrder )
        {
                itsExDateTimeOrder = theExDateTimeOrder;
        }


        void SetNCommitRows( long theNRows )
        {
                itsNCommitRows = theNRows;
        }

protected:

        // forward declaration;
        struct SaveRow;

        LookString GetNextLine( std::istream& theStream, bool& finished );
        LookString GetColumn( const LookString& theLine, int theColumnIndex );

        bool CheckColumnNames( void );

        void MakeUpper( LookStringList& theStringList );
        void MakeUpper( DbDescribeTable::ColumnInfoList& theColumnList );

        void AddParameterToQuery( DbQuery* theQuery, const LookString& theString,
                DbDescribeTable::SColumnInfo& theColumnDescription );

        bool InitialiseDuplicateCheckQuery( void );

        bool LoadRowForImport( const LookString& theRowString,
                int theRowNumber );

        void TokeniseAndConvertRow( const LookString& theInString,
                StringVector& theReturnStrings );

        bool CheckMatchingRows( SaveRow& theRow, int theRowNumber );
        bool CheckStoredRowPK( SaveRow& theNewRow,
                SaveRow& theOldRow );

        bool RowsIdentical( SaveRow& theNewRow,
                SaveRow& theOldRow );

        bool RowsIdentical( SaveRow& theNewRow,
                DbRow* theOldRow );

        // saving methods
        DbQuery* InitialiseInsertQuery( DbConnection* theConnection );
        DbQuery* InitialiseUpdateQuery( DbConnection* theConnection );

        bool InsertRow( SaveRow& theRow, DbQuery* theQuery );
        bool UpdateRow( SaveRow& theRow, DbQuery* theQuery );

        bool SaveImport( void );

        // setup data

        LookStringList itsPrimaryColumns;

        LookString itsToTable;    // table we're saving the data in
        LookString itsFromTable;  // table it was originally saved as

        ColumnAllowance itsColumnAllowance;
        ImportMatchBehaviour itsImportMatchBehaviour;
        bool itAllowsNullDates;

        TextConversionMode itsTextConversionMode;
        DateFormat itsDateFormat;
        LookDateTimeReader::DatePartOrder itsExDatePartOrder;
        LookDateTimeReader::DateTimeOrder itsExDateTimeOrder;

        ErrorAction itsErrorAction;
        
        LookString itsNULLString;
        LookString itsLFString;

        DbConnection* itsConnection;
        bool itCommits;

        long itsNCommitRows;

        // result data
        long itsNRowsInserted;
        long itsNRowsUpdated;
        long itsNRowsWithErrors;

        // data processing data

        // this is not necessarily the to table - that could be empty
        LookString itsDestinationTable;
        DbDescribeTable::ColumnInfoList itsColumnDescriptions;
        LookStringList itsColumnNames;

        LongValList itsPrimaryColumnIndices;
        // used to get types of primary columns
        LongValList itsPrimaryColumnDatabaseIndices;

        // these are lists of the columns shared by both file and table
        LookStringList itsCommonColumnNames;
        LongValList itsCommonColumnFileIndices;
        LongValList itsCommonColumnTableIndices;
        BoolValList itsCommonColumnPrimaryFlags;

        // no update possible if all columns are primary
        bool itsUpdateIsAllowed;

        bool itIsLoadingData;

        DbQuery* itsDuplicateCheckQuery;

        struct SaveRow
        {
                enum RowStatus
                {
                        INSERT,
                        UPDATE,
                        IGNORE,
                        INVALID
                };

                StringVector itsColumns;
                RowStatus itsStatus;
                int itsRowNumber;

                SaveRow( int theReserveColumns )
                        : itsStatus( INVALID ),
                        itsRowNumber( 0 )
                {
                        itsColumns.reserve( theReserveColumns );
                }

                ~SaveRow()
                {
                }

                SaveRow( const SaveRow& theOther )
                {
                        *this = theOther;
                }

                SaveRow& operator=( const SaveRow& theOther )
                {
                        itsStatus = theOther.itsStatus;
                        itsRowNumber = theOther.itsRowNumber;
                        itsColumns = theOther.itsColumns;
                        return *this;
                }

                // dummy for lists
                bool operator==( const SaveRow& theOther )
                {
                        return false;
                }
        };

        typedef std::deque<SaveRow> SaveRowList;

        SaveRowList itsRowsToSave;

};


} // end of "look" namespace
#endif

---