xref: /trunk/main/connectivity/source/inc/adabas/BDriver.hxx (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1 /*************************************************************************
2  *
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * Copyright 2000, 2010 Oracle and/or its affiliates.
6  *
7  * OpenOffice.org - a multi-platform office productivity suite
8  *
9  * This file is part of OpenOffice.org.
10  *
11  * OpenOffice.org is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * OpenOffice.org is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Lesser General Public License version 3 for more details
19  * (a copy is included in the LICENSE file that accompanied this code).
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * version 3 along with OpenOffice.org.  If not, see
23  * <http://www.openoffice.org/license.html>
24  * for a copy of the LGPLv3 License.
25  *
26  ************************************************************************/
27 
28 #ifndef _CONNECTIVITY_ADABAS_BDRIVER_HXX_
29 #define _CONNECTIVITY_ADABAS_BDRIVER_HXX_
30 
31 #include <com/sun/star/sdbc/XDriver.hpp>
32 #include <com/sun/star/sdbcx/XDataDefinitionSupplier.hpp>
33 #include <com/sun/star/sdbcx/XTablesSupplier.hpp>
34 #include <com/sun/star/sdbcx/XCreateCatalog.hpp>
35 #include <com/sun/star/sdbcx/XDropCatalog.hpp>
36 
37 #include <com/sun/star/lang/XEventListener.hpp>
38 
39 //#include <unotools/tempfile.hxx>
40 #include <cppuhelper/implbase4.hxx>
41 #include "odbc/OFunctiondefs.hxx"
42 #include "odbc/ODriver.hxx"
43 
44 namespace connectivity
45 {
46     namespace adabas
47     {
48         ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > SAL_CALL ODriver_CreateInstance(const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rxFactory) throw( ::com::sun::star::uno::Exception );
49 
50         typedef ::cppu::ImplHelper4<    ::com::sun::star::sdbcx::XCreateCatalog,
51                                         ::com::sun::star::sdbcx::XDataDefinitionSupplier,
52                                         ::com::sun::star::lang::XEventListener,
53                                         ::com::sun::star::sdbcx::XDropCatalog> ODriver_BASE2;
54 
55         typedef odbc::ODBCDriver ODriver_BASE;
56 
57         class ODriver : public ODriver_BASE,
58                         public ODriver_BASE2
59         {
60             typedef struct DatabaseStruct
61             {
62                 ::rtl::OUString sControlUser;
63                 ::rtl::OUString sControlPassword;
64                 ::rtl::OUString sSysUser;
65                 ::rtl::OUString sSysPassword;
66                 ::rtl::OUString sDomainPassword;
67                 ::rtl::OUString sCacheSize;
68                 ::rtl::OUString sBackupFile;
69                 ::rtl::OUString sDataDevName;
70                 ::rtl::OUString sSysDevSpace;
71                 ::rtl::OUString sTransLogName;
72                 ::rtl::OUString sDBName;
73                 sal_Int32       nDataIncrement;     // which size the database should grow
74                 sal_Int32       nDataSize;
75                 sal_Int32       nLogSize;
76                 sal_Bool        bShutDown;
77                 sal_Bool        bRestoreDatabase;
78 
79                 DatabaseStruct() : nDataIncrement(0),nDataSize(0),nLogSize(0),bShutDown(sal_False),bRestoreDatabase(sal_False){ }
80             } TDatabaseStruct;
81 
82             DECLARE_STL_USTRINGACCESS_MAP(TDatabaseStruct,TDatabaseMap);
83             TDatabaseMap    m_aDatabaseMap; // contains all adabas databases with their flag to shut down or not
84 
85             // environment vars
86             ::rtl::OUString m_sDbWork;
87             ::rtl::OUString m_sDbConfig;
88             ::rtl::OUString m_sDbRoot;
89             ::rtl::OUString m_sDbWorkURL;
90             ::rtl::OUString m_sDbConfigURL;
91             ::rtl::OUString m_sDbRootURL;
92             ::rtl::OUString m_sDbRunDir;
93             ::rtl::OUString m_sDelimit;
94 
95             void checkAndInsertNewDevSpace(const ::rtl::OUString& _rDBName,const TDatabaseStruct& _rDBInfo);
96             void checkAndRestart(const ::rtl::OUString& _rDBName,const TDatabaseStruct& _rDbInfo);
97             void X_CONS(const ::rtl::OUString& _DBNAME,const ::rtl::OString& _ACTION,const ::rtl::OUString& _FILENAME);
98             sal_Bool getDBName(const ::rtl::OUString& _rName,::rtl::OUString& _rDBName) const;
99             ::rtl::OUString getDatabaseInitFile(  const TDatabaseStruct& _aInfo);
100             ::rtl::OUString generateInitFile()  const;
101             void fillEnvironmentVariables();
102             void fillInfo(const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& info, TDatabaseStruct& _rDBInfo /*out*/);
103             void LoadBatch(const ::rtl::OUString& _rDBNAME,
104                         const ::rtl::OUString& _rUSR,
105                         const ::rtl::OUString& _rPWD,
106                         const ::rtl::OUString& _rBatch);
107             void XUTIL(const ::rtl::OUString& _rParam,
108                     const ::rtl::OUString& _DBNAME,
109                     const ::rtl::OUString& _USRNAME,
110                     const ::rtl::OUString& _USRPWD);
111             int X_STOP(const ::rtl::OUString& _DBNAME);
112             int X_START(const ::rtl::OUString& _DBNAME);
113             void createDb(const TDatabaseStruct& _aInfo);
114             void clearDatabase(const ::rtl::OUString& _rDBName);
115             int X_PARAM(const ::rtl::OUString& _DBNAME,
116                         const ::rtl::OUString& _USR,
117                         const ::rtl::OUString& _PWD,
118                         const ::rtl::OUString& _CMD);
119             sal_Int32 CreateFiles(const TDatabaseStruct& _aInfo);
120             sal_Bool CreateFile(const ::rtl::OUString &_FileName,
121                                 sal_Int32 _nSize);
122             void PutParam(const ::rtl::OUString& rDBNAME,
123                         const ::rtl::OUString& rWhat,
124                         const ::rtl::OUString& rHow);
125             void createNeededDirs(      const ::rtl::OUString& _rDBName);
126             sal_Bool isKernelVersion(const char* _pVersion);
127             sal_Bool isVersion(     const ::rtl::OUString& _rDBName,
128                                     const char* _pVersion);
129 
130             void convertOldVersion(     const ::rtl::OUString& _rDBName,
131                                         const TDatabaseStruct& _rDbInfo);
132 
133             void installSystemTables(   const TDatabaseStruct& _aInfo);
134 
135         protected:
136             virtual SQLHANDLE EnvironmentHandle(::rtl::OUString &_rPath);
137             virtual ~ODriver();
138         public:
139             explicit ODriver(const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rxFactory);
140 
141             // XInterface
142             static ::rtl::OUString getImplementationName_Static(  ) throw(::com::sun::star::uno::RuntimeException);
143             static ::com::sun::star::uno::Sequence< ::rtl::OUString > getSupportedServiceNames_Static(  ) throw (::com::sun::star::uno::RuntimeException);
144         private:
145             DECLARE_SERVICE_INFO();
146 
147             virtual oslGenericFunction getOdbcFunction(sal_Int32 _nIndex)  const;
148             // OComponentHelper
149             virtual void SAL_CALL disposing(void);
150             virtual ::com::sun::star::uno::Any SAL_CALL queryInterface( const ::com::sun::star::uno::Type & rType ) throw(::com::sun::star::uno::RuntimeException);
151             virtual void SAL_CALL acquire() throw();
152             virtual void SAL_CALL release() throw();
153 
154             // XDriver
155             ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection > SAL_CALL connect( const ::rtl::OUString& url, const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& info ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
156             virtual sal_Bool SAL_CALL acceptsURL( const ::rtl::OUString& url ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
157             virtual ::com::sun::star::uno::Sequence< ::com::sun::star::sdbc::DriverPropertyInfo > SAL_CALL getPropertyInfo( const ::rtl::OUString& url, const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& info ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
158             virtual sal_Int32 SAL_CALL getMajorVersion(  ) throw(::com::sun::star::uno::RuntimeException);
159             virtual sal_Int32 SAL_CALL getMinorVersion(  ) throw(::com::sun::star::uno::RuntimeException);
160 
161             // XDataDefinitionSupplier
162             virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbcx::XTablesSupplier > SAL_CALL getDataDefinitionByConnection( const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection >& connection ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
163             virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbcx::XTablesSupplier > SAL_CALL getDataDefinitionByURL( const ::rtl::OUString& url, const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& info ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
164 
165             // XCreateCatalog
166             virtual void SAL_CALL createCatalog( const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& info ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::container::ElementExistException, ::com::sun::star::uno::RuntimeException);
167             // XDropCatalog
168             virtual void SAL_CALL dropCatalog( const ::rtl::OUString& catalogName, const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& info ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::container::NoSuchElementException, ::com::sun::star::uno::RuntimeException);
169             // XEventListener
170             virtual void SAL_CALL disposing( const ::com::sun::star::lang::EventObject& Source ) throw(::com::sun::star::uno::RuntimeException);
171         };
172     }
173 
174 }
175 #endif //_CONNECTIVITY_ADABAS_BDRIVER_HXX_
176 
177 
178