2013-05-10 18:21:30 +00:00
|
|
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
2013-07-26 20:11:41 +02:00
|
|
|
/*
|
|
|
|
* This file is part of the LibreOffice project.
|
2013-05-10 18:21:30 +00:00
|
|
|
*
|
2013-07-26 20:11:41 +02:00
|
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
2013-05-10 18:21:30 +00:00
|
|
|
*
|
2013-07-26 20:11:41 +02:00
|
|
|
* This file incorporates work covered by the following license notice:
|
2013-05-10 18:21:30 +00:00
|
|
|
*
|
2013-07-26 20:11:41 +02:00
|
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
|
|
* contributor license agreements. See the NOTICE file distributed
|
|
|
|
* with this work for additional information regarding copyright
|
|
|
|
* ownership. The ASF licenses this file to you under the Apache
|
|
|
|
* License, Version 2.0 (the "License"); you may not use this file
|
|
|
|
* except in compliance with the License. You may obtain a copy of
|
|
|
|
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
|
|
|
|
*/
|
2013-05-10 18:21:30 +00:00
|
|
|
|
2013-07-22 21:33:06 +02:00
|
|
|
#ifndef CONNECTIVITY_FIREBIRD_CONNECTION_HXX
|
|
|
|
#define CONNECTIVITY_FIREBIRD_CONNECTION_HXX
|
2013-05-10 18:21:30 +00:00
|
|
|
|
2013-07-21 17:45:08 +02:00
|
|
|
#include "Blob.hxx"
|
2013-07-31 16:03:29 +02:00
|
|
|
#include "SubComponent.hxx"
|
|
|
|
|
|
|
|
#include <ibase.h>
|
|
|
|
|
2013-09-05 17:16:02 +01:00
|
|
|
#include <boost/scoped_ptr.hpp>
|
2013-07-31 16:03:29 +02:00
|
|
|
#include <connectivity/CommonTools.hxx>
|
|
|
|
#include <connectivity/OSubComponent.hxx>
|
2013-08-12 16:47:18 +01:00
|
|
|
#include <cppuhelper/compbase4.hxx>
|
2013-07-31 16:03:29 +02:00
|
|
|
#include <cppuhelper/weakref.hxx>
|
|
|
|
#include <map>
|
|
|
|
#include <OTypeInfo.hxx>
|
2013-09-05 17:16:02 +01:00
|
|
|
#include <unotools/tempfile.hxx>
|
2013-07-21 17:45:08 +02:00
|
|
|
|
2013-05-10 18:21:30 +00:00
|
|
|
#include <com/sun/star/beans/PropertyValue.hpp>
|
2013-07-11 15:26:48 +01:00
|
|
|
#include <com/sun/star/document/DocumentEvent.hpp>
|
|
|
|
#include <com/sun/star/document/XDocumentEventListener.hpp>
|
|
|
|
#include <com/sun/star/embed/XStorage.hpp>
|
2013-05-10 18:21:30 +00:00
|
|
|
#include <com/sun/star/lang/DisposedException.hpp>
|
|
|
|
#include <com/sun/star/lang/XServiceInfo.hpp>
|
|
|
|
#include <com/sun/star/lang/XUnoTunnel.hpp>
|
2013-07-31 16:03:29 +02:00
|
|
|
#include <com/sun/star/sdbc/SQLWarning.hpp>
|
2013-05-10 18:21:30 +00:00
|
|
|
#include <com/sun/star/sdbc/XConnection.hpp>
|
2013-07-31 16:03:29 +02:00
|
|
|
#include <com/sun/star/sdbc/XWarningsSupplier.hpp>
|
2013-08-08 18:04:18 +01:00
|
|
|
#include <com/sun/star/sdbcx/XTablesSupplier.hpp>
|
2013-11-10 08:34:27 +00:00
|
|
|
#include <com/sun/star/util/XModifiable.hpp>
|
2013-05-27 12:27:23 +00:00
|
|
|
|
2013-05-10 18:21:30 +00:00
|
|
|
namespace connectivity
|
|
|
|
{
|
|
|
|
namespace firebird
|
|
|
|
{
|
|
|
|
|
2013-08-12 16:47:18 +01:00
|
|
|
typedef ::cppu::WeakComponentImplHelper4< ::com::sun::star::document::XDocumentEventListener,
|
2013-08-08 18:04:18 +01:00
|
|
|
::com::sun::star::lang::XServiceInfo,
|
|
|
|
::com::sun::star::sdbc::XConnection,
|
2013-08-12 16:47:18 +01:00
|
|
|
::com::sun::star::sdbc::XWarningsSupplier
|
2013-09-09 17:28:08 +01:00
|
|
|
> Connection_BASE;
|
2013-05-10 18:21:30 +00:00
|
|
|
|
2013-07-23 19:04:33 +02:00
|
|
|
class OStatementCommonBase;
|
2013-05-10 18:21:30 +00:00
|
|
|
class FirebirdDriver;
|
|
|
|
class ODatabaseMetaData;
|
|
|
|
|
2013-05-27 12:27:23 +00:00
|
|
|
|
2013-05-10 18:21:30 +00:00
|
|
|
typedef ::std::vector< ::connectivity::OTypeInfo> TTypeInfoVector;
|
|
|
|
typedef std::vector< ::com::sun::star::uno::WeakReferenceHelper > OWeakRefArray;
|
|
|
|
|
2013-09-09 17:28:08 +01:00
|
|
|
class Connection : public Connection_BASE,
|
|
|
|
public connectivity::OSubComponent<Connection, Connection_BASE>
|
2013-05-10 18:21:30 +00:00
|
|
|
{
|
2013-09-09 17:28:08 +01:00
|
|
|
friend class connectivity::OSubComponent<Connection, Connection_BASE>;
|
2013-05-10 18:21:30 +00:00
|
|
|
|
2013-09-09 17:28:08 +01:00
|
|
|
/**
|
|
|
|
* Location within the .odb that an embedded .fdb will be stored.
|
|
|
|
* Only relevant for embedded dbs.
|
|
|
|
*/
|
|
|
|
static const OUString our_sDBLocation;
|
2013-05-10 18:21:30 +00:00
|
|
|
protected:
|
2013-09-09 20:03:38 +01:00
|
|
|
::osl::Mutex m_aMutex;
|
2013-09-09 17:28:08 +01:00
|
|
|
|
2013-09-09 20:03:38 +01:00
|
|
|
TTypeInfoVector m_aTypeInfo; // vector containing an entry
|
2013-05-10 18:21:30 +00:00
|
|
|
// for each row returned by
|
|
|
|
// DatabaseMetaData.getTypeInfo.
|
2013-09-09 17:28:08 +01:00
|
|
|
/** The parent driver that created this connection. */
|
|
|
|
FirebirdDriver* m_pDriver;
|
2013-05-10 18:21:30 +00:00
|
|
|
|
2013-09-09 17:28:08 +01:00
|
|
|
/** The URL passed to us when opening, i.e. of the form sdbc:* */
|
|
|
|
::rtl::OUString m_sConnectionURL;
|
|
|
|
/**
|
|
|
|
* The URL passed to firebird, i.e. either a local file (for a
|
|
|
|
* temporary .fdb extracted from a .odb or a normal local file) or
|
|
|
|
* a remote url.
|
|
|
|
*/
|
|
|
|
::rtl::OUString m_sFirebirdURL;
|
2013-05-10 18:21:30 +00:00
|
|
|
|
2013-09-09 17:28:08 +01:00
|
|
|
/* EMBEDDED MODE DATA */
|
|
|
|
/** Denotes that we have a .fdb stored within a .odb file. */
|
|
|
|
sal_Bool m_bIsEmbedded;
|
2013-11-10 08:34:27 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Handle for the parent DatabaseDocument. We need to notify this
|
|
|
|
* whenever any data is written to our temporary database so that
|
|
|
|
* the user is able to save this back to the .odb file.
|
|
|
|
*
|
|
|
|
* Note that this is ONLY set in embedded mode.
|
|
|
|
*/
|
|
|
|
::com::sun::star::uno::Reference< ::com::sun::star::util::XModifiable >
|
|
|
|
m_xParentDocument;
|
|
|
|
|
2013-09-09 17:28:08 +01:00
|
|
|
/**
|
|
|
|
* Handle for the folder within the .odb where we store our .fdb
|
|
|
|
* (Only used if m_bIsEmbedded is true).
|
|
|
|
*/
|
|
|
|
::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >
|
|
|
|
m_xEmbeddedStorage;
|
|
|
|
/**
|
|
|
|
* The temporary folder where we extract the .fdb from a .odb.
|
|
|
|
* It is only valid if m_bIsEmbedded is true.
|
|
|
|
*/
|
|
|
|
::boost::scoped_ptr< ::utl::TempFile > m_pExtractedFDBFile;
|
2013-05-10 18:21:30 +00:00
|
|
|
|
2013-07-12 09:11:52 +01:00
|
|
|
|
2013-09-20 15:00:48 +01:00
|
|
|
/** We are using an external (local) file */
|
|
|
|
bool m_bIsFile;
|
|
|
|
|
2013-09-09 17:28:08 +01:00
|
|
|
/* REMOTE CONNECTION DATA */
|
|
|
|
::rtl::OUString m_sUser;
|
2013-07-12 09:11:52 +01:00
|
|
|
|
2013-09-09 17:28:08 +01:00
|
|
|
/* CONNECTION PROPERTIES */
|
|
|
|
sal_Bool m_bIsAutoCommit;
|
|
|
|
sal_Bool m_bIsReadOnly;
|
|
|
|
sal_Int32 m_aTransactionIsolation;
|
|
|
|
|
|
|
|
isc_db_handle m_aDBHandle;
|
|
|
|
isc_tr_handle m_aTransactionHandle;
|
2013-05-10 18:21:30 +00:00
|
|
|
|
2013-08-12 16:47:18 +01:00
|
|
|
::com::sun::star::uno::WeakReference< ::com::sun::star::sdbcx::XTablesSupplier>
|
|
|
|
m_xCatalog;
|
2013-09-09 17:28:08 +01:00
|
|
|
::com::sun::star::uno::WeakReference< ::com::sun::star::sdbc::XDatabaseMetaData >
|
|
|
|
m_xMetaData;
|
|
|
|
/** Statements owned by this connection. */
|
|
|
|
OWeakRefArray m_aStatements;
|
2013-07-11 20:15:41 +01:00
|
|
|
|
2013-09-06 10:55:40 +01:00
|
|
|
/**
|
|
|
|
* Firebird stores binary collations for indexes on Character based
|
|
|
|
* columns, these can be binary-incompatible between different icu
|
|
|
|
* version, hence we need to rebuild the indexes when switching icu
|
|
|
|
* versions.
|
|
|
|
*/
|
2013-09-09 20:03:38 +01:00
|
|
|
void rebuildIndexes()
|
2013-09-09 17:28:08 +01:00
|
|
|
throw(::com::sun::star::sdbc::SQLException);
|
2013-09-09 20:03:38 +01:00
|
|
|
void buildTypeInfo()
|
2013-09-09 17:28:08 +01:00
|
|
|
throw(::com::sun::star::sdbc::SQLException);
|
2013-05-10 18:21:30 +00:00
|
|
|
|
2013-09-09 17:28:08 +01:00
|
|
|
/**
|
|
|
|
* Creates a new transaction with the desired parameters, if
|
|
|
|
* necessary discarding an existing transaction. This has to be done
|
|
|
|
* anytime we change the transaction isolation, or autocommiting.
|
|
|
|
*/
|
2013-09-09 20:03:38 +01:00
|
|
|
void setupTransaction()
|
2013-09-09 17:28:08 +01:00
|
|
|
throw(::com::sun::star::sdbc::SQLException);
|
2013-09-09 20:03:38 +01:00
|
|
|
void disposeStatements();
|
|
|
|
|
2013-11-07 19:12:23 +01:00
|
|
|
/** transform named parameters into unnamed parameters
|
|
|
|
@param _sSQL
|
|
|
|
The SQL statement to transform.
|
|
|
|
@return
|
|
|
|
The new statement with unnamed parameters
|
|
|
|
*/
|
|
|
|
OUString transformPreparedStatement(const OUString& _sSQL);
|
|
|
|
|
2013-05-10 18:21:30 +00:00
|
|
|
public:
|
2013-09-09 20:03:38 +01:00
|
|
|
Connection(FirebirdDriver* _pDriver);
|
|
|
|
virtual ~Connection();
|
|
|
|
|
2013-07-11 10:14:58 +01:00
|
|
|
virtual void construct( const ::rtl::OUString& url,
|
2013-07-11 15:26:48 +01:00
|
|
|
const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& info)
|
2013-09-06 08:35:19 +01:00
|
|
|
throw(::com::sun::star::sdbc::SQLException,
|
|
|
|
::com::sun::star::uno::RuntimeException);
|
2013-05-10 18:21:30 +00:00
|
|
|
|
2013-09-09 20:03:38 +01:00
|
|
|
FirebirdDriver* getDriver() const {return m_pDriver;}
|
|
|
|
|
|
|
|
::rtl::OUString getConnectionURL() const {return m_sConnectionURL;}
|
|
|
|
sal_Bool isEmbedded() const {return m_bIsEmbedded;}
|
|
|
|
::rtl::OUString getUserName() const {return m_sUser;}
|
|
|
|
isc_db_handle& getDBHandle() {return m_aDBHandle;}
|
|
|
|
isc_tr_handle& getTransaction()
|
|
|
|
throw(::com::sun::star::sdbc::SQLException);
|
2013-11-10 08:40:36 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Must be called anytime the underlying database is likely to have
|
|
|
|
* changed.
|
|
|
|
*
|
|
|
|
* This is used to notify the database document of any changes, so
|
|
|
|
* that the user is informed of any pending changes needing to be
|
|
|
|
* saved.
|
|
|
|
*/
|
|
|
|
void notifyDatabaseModified();
|
2013-05-10 18:21:30 +00:00
|
|
|
|
2013-09-09 20:03:38 +01:00
|
|
|
/**
|
|
|
|
* Create a new Blob tied to this connection. Blobs are tied to a
|
|
|
|
* transaction and not to a statement, hence the connection should
|
|
|
|
* deal with their management.
|
|
|
|
*/
|
|
|
|
::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XBlob>
|
|
|
|
createBlob(ISC_QUAD* pBlobID)
|
|
|
|
throw(::com::sun::star::sdbc::SQLException,
|
|
|
|
::com::sun::star::uno::RuntimeException);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Create and/or connect to the sdbcx Catalog. This is completely
|
|
|
|
* unrelated to the SQL "Catalog".
|
|
|
|
*/
|
|
|
|
virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbcx::XTablesSupplier >
|
|
|
|
createCatalog();
|
2013-05-10 18:21:30 +00:00
|
|
|
|
|
|
|
// OComponentHelper
|
|
|
|
virtual void SAL_CALL disposing(void);
|
|
|
|
// XInterface
|
|
|
|
virtual void SAL_CALL release() throw();
|
|
|
|
|
|
|
|
// XServiceInfo
|
|
|
|
DECLARE_SERVICE_INFO();
|
|
|
|
// XConnection
|
|
|
|
virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XStatement > SAL_CALL createStatement( ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
|
|
|
|
virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XPreparedStatement > SAL_CALL prepareStatement( const ::rtl::OUString& sql ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
|
|
|
|
virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XPreparedStatement > SAL_CALL prepareCall( const ::rtl::OUString& sql ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
|
|
|
|
virtual ::rtl::OUString SAL_CALL nativeSQL( const ::rtl::OUString& sql ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
|
|
|
|
virtual void SAL_CALL setAutoCommit( sal_Bool autoCommit ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
|
|
|
|
virtual sal_Bool SAL_CALL getAutoCommit( ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
|
|
|
|
virtual void SAL_CALL commit( ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
|
|
|
|
virtual void SAL_CALL rollback( ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
|
|
|
|
virtual sal_Bool SAL_CALL isClosed( ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
|
|
|
|
virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XDatabaseMetaData > SAL_CALL getMetaData( ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
|
|
|
|
virtual void SAL_CALL setReadOnly( sal_Bool readOnly ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
|
|
|
|
virtual sal_Bool SAL_CALL isReadOnly( ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
|
|
|
|
virtual void SAL_CALL setCatalog( const ::rtl::OUString& catalog ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
|
|
|
|
virtual ::rtl::OUString SAL_CALL getCatalog( ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
|
|
|
|
virtual void SAL_CALL setTransactionIsolation( sal_Int32 level ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
|
|
|
|
virtual sal_Int32 SAL_CALL getTransactionIsolation( ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
|
|
|
|
virtual ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameAccess > SAL_CALL getTypeMap( ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
|
|
|
|
virtual void SAL_CALL setTypeMap( const ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameAccess >& typeMap ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
|
|
|
|
// XCloseable
|
|
|
|
virtual void SAL_CALL close( ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
|
|
|
|
// XWarningsSupplier
|
|
|
|
virtual ::com::sun::star::uno::Any SAL_CALL getWarnings( ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
|
|
|
|
virtual void SAL_CALL clearWarnings( ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
|
2013-07-11 15:26:48 +01:00
|
|
|
// XDocumentEventListener
|
|
|
|
virtual void SAL_CALL documentEventOccured( const ::com::sun::star::document::DocumentEvent& Event ) throw(::com::sun::star::uno::RuntimeException);
|
|
|
|
// css.lang.XEventListener
|
|
|
|
virtual void SAL_CALL disposing( const ::com::sun::star::lang::EventObject& Source ) throw (::com::sun::star::uno::RuntimeException);
|
2013-05-10 18:21:30 +00:00
|
|
|
|
|
|
|
};
|
|
|
|
}
|
|
|
|
}
|
|
|
|
#endif // CONNECTIVITY_SCONNECTION_HXX
|
|
|
|
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|