hk_connection.h

// ****************************************************************************
// copyright (c) 2000-2005 Horst Knorr <hk_classes@knoda.org>
// This file is part of the hk_classes library.
// This file may be distributed and/or modified under the terms of the
// GNU Library Public License version 2 as published by the Free Software
// Foundation and appearing in the file COPYING included in the
// packaging of this file.
// This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
// WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
// ****************************************************************************
#ifndef HK_CONNECTION
#define HK_CONNECTION
#include "hk_class.h"
#include <list>
#include <vector>
#include <algorithm>
using namespace std;
class hk_drivermanager;
class hk_connectionprivate;

class hk_database;
class hk_connection:public hk_class
{
    friend class hk_database;
    friend class hk_drivermanager;
    public:
        virtual     ~hk_connection();
        void    set_host(const hk_string& h);
        hk_string   host(void);
        void    set_user(const hk_string& u);
        hk_string   user(void);
        void    set_password(const hk_string& p);
        hk_string   password(void);
        void        set_tcp_port(unsigned int t);
        unsigned int    tcp_port(void);
        void set_defaultdatabase(const hk_string&);
        hk_string defaultdatabase(void) const;
        virtual unsigned int    default_tcp_port(void) const;
        bool    connect(enum_interaction c=interactive);
        bool    disconnect(void);
        bool    is_connected(void);
        vector<hk_string>* dblist(void);
        hk_database* new_database(const hk_string& name="");

        bool rename_database(const hk_string& originalname, const hk_string& new_name);
        enum support_enum
        {
            SUPPORTS_AUTOINCCOLUMN=1,
            SUPPORTS_BOOLCOLUMN=2,
            SUPPORTS_DATECOLUMN=3,
            SUPPORTS_TIMECOLUMN=4,
            SUPPORTS_DATETIMECOLUMN=5,
            SUPPORTS_BINARYCOLUMN=6,
            SUPPORTS_MEMOCOLUMN=7,
            SUPPORTS_TIMESTAMPCOLUMN=8,

            SUPPORTS_TEXTCOLUMN=9,
            SUPPORTS_INTEGERCOLUMN=10,
            SUPPORTS_SMALLINTEGERCOLUMN=11,
            SUPPORTS_FLOATINGCOLUMN=12,
            SUPPORTS_SMALLFLOATINGCOLUMN=13,

            SUPPORTS_PROPRIETARYCOLUMN=19,//driver specific datatype that can not be mapped to a hk_classes type

            SUPPORTS_SQL=100,
            SUPPORTS_TRANSACTIONS=101,
            SUPPORTS_REFERENTIALINTEGRITY=102,
            SUPPORTS_NEW_DATABASE=103,
            SUPPORTS_DELETE_DATABASE=104,
            SUPPORTS_NEW_TABLE=105,
            SUPPORTS_ALTER_TABLE=106,
            SUPPORTS_DELETE_TABLE=107,
            SUPPORTS_CREATE_INDEX=108,
            SUPPORTS_DELETE_INDEX=109,
            SUPPORTS_CHANGE_PASSWORD=110,
            SUPPORTS_RENAME_DATABASE=111,
            SUPPORTS_RENAME_TABLE=112,
            SUPPORTS_VIEWS=113,
            SUPPORTS_NEW_VIEW=114,
            SUPPORTS_ALTER_VIEW=115,
            SUPPORTS_DELETE_VIEW=116,
            SUPPORTS_ADD_COLUMN=117,
            SUPPORTS_DELETE_COLUMN=118,
            SUPPORTS_CHANGE_COLUMNTYPE=119,
            SUPPORTS_CHANGE_COLUMNNAME=120,
            SUPPORTS_ALTER_PRIMARY_KEY=121,
            SUPPORTS_ALTER_NOT_NULL=122,

            SUPPORTS_SQL_GROUP_BY=180,
            SUPPORTS_SQL_ORDER_BY=181,
            SUPPORTS_SQL_HAVING=182,
            SUPPORTS_SQL_WHERE=183,
            SUPPORTS_SQL_ALIAS=184,

            SUPPORTS_LOCAL_FILEFORMAT=200,
            SUPPORTS_NONALPHANUM_FIELDNAMES=201, // if not set field name can only have [a-zA-Z0-9]
            SUPPORTS_NONASCII_FIELDNAMES=202, //unicode characters etc
            SUPPORTS_SPACE_FIELDNAMES=203 // means  a space character can be part
        };

        virtual bool server_supports(support_enum) const{return false;}
        enum need_enum
        {

            NEEDS_NOTHING=0,
            NEEDS_HOST=1,
            NEEDS_USERNAME=2,
            NEEDS_PASSWORD=3,
            NEEDS_SQLDELIMITER=4,
            NEEDS_PORT=5,
            NEEDS_DATABASENAME=6,
            NEEDS_BOOLEANEMULATION=7,//e.g. Mysql  doesn't have natively a boolean type, so tinyint is used
            NEEDS_NULL_TERMINATED_SQL=8, //e.g. Postgres needs null terminated strings in PQExec
            NEEDS_TABLE_ALIAS_AS=9 // set if the server needs 'AS' between the table name and its alias name in a FROM clause
        };
        virtual bool server_needs(need_enum) const {return false;}
        static  void    set_passworddialog(password_dialogtype*);
virtual        bool    create_database(const hk_string& dbase);
virtual        bool    delete_database(const hk_string& dbase);
        bool    database_exists(const hk_string& databasename);
        bool set_newpassword(const hk_string& newpassword);
        void show_newpassworddialog(void);
        static void set_newpassworddialog(newpassword_dialogtype*);
/*
 *shows a password dialog
 *@return false if it has been cancelled else true
 */
        bool show_passworddialog(void);
        virtual hk_string drivername(void) const;
        void set_booleanemulation(bool emulate);
        bool booleanemulation(void) const;
        hk_drivermanager* drivermanager(void);
        bool copy_database(hk_database* fromdatabase,bool schema_and_data,bool copy_local_files,progress_dialogtype* progressdialog=NULL);
        hk_string last_servermessage(void){return p_lastservermessage;}
        hk_string databasepath(void);
static    hk_string check_capabilities(hk_connection* from,hk_connection* to);

virtual hk_string mimetype(void) const {return "";}
virtual unsigned int maxfieldnamesize(void) const {return (unsigned int)-1;}

virtual long int maxcharsize(void) const {return 255;}



    protected:
        hk_connection(hk_drivermanager* c);
        bool    p_connected;
        virtual bool    driver_specific_connect(void){return false;}
        virtual bool    driver_specific_disconnect(void){return false;}
        virtual bool    driver_specific_rename_database(const hk_string& oldname,const hk_string& newname){return false;}
        virtual  vector<hk_string>* driver_specific_dblist(void){return NULL;}
        virtual hk_database* driver_specific_new_database(void){return NULL;}
        virtual bool    driver_specific_new_password(const hk_string&){return false;}
        virtual bool    driver_specific_delete_database(const hk_string& dbase);

        void    db_remove(hk_database* d);
        hk_string sqldelimiter(void) ;
        void inform_databases_connect(void);
        void inform_databases_disconnect(void);
        vector<hk_string> p_databaselist;
        virtual void savedata(ostream& s);
        virtual void loaddata(const hk_string& definition);

        void set_last_servermessage(const hk_string& m);
        hk_database* database(void) const {return p_database;}
        static bool internal_copy_check(hk_connection* from, hk_connection* to,support_enum);
        void delete_databasedirectory(const hk_string& db);
        void delete_directory(const hk_string& d);
    private:
        void load_configuration(void);
        void save_configuration(void);
        bool copy_local_files(hk_database* fromdb,hk_database* todb,objecttype f,progress_dialogtype* progressdialog);
        hk_string ask_dbname(void);
        void make_databasedir(const hk_string& dbname);
        void set_classespath(hk_string& p);

        hk_database* p_database;
        unsigned int p_debug_counter;
        static  password_dialogtype* p_passworddialog;
        static  newpassword_dialogtype* p_newpassworddialog;
        hk_drivermanager* p_drivermanager;
        hk_string   p_lastservermessage;
      hk_connectionprivate* p_private;
} ;
#endif

---