1
0
Fork 0
libreoffice/connectivity/source/drivers/postgresql/pq_connection.cxx
Daniel Baumann 8e63e14cf6
Adding upstream version 4:25.2.3.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
2025-06-22 16:20:04 +02:00

579 lines
17 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* Effective License of whole file:
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* 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
*
* Parts "Copyright by Sun Microsystems, Inc" prior to August 2011:
*
* The Contents of this file are made available subject to the terms of
* the GNU Lesser General Public License Version 2.1
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* Contributor(s): Joerg Budischewski
*
* All parts contributed on or after August 2011:
*
* 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/.
*
************************************************************************/
#include <utility>
#include <vector>
#include <string.h>
#include <memory>
#include "pq_connection.hxx"
#include "pq_statement.hxx"
#include "pq_tools.hxx"
#include "pq_preparedstatement.hxx"
#include "pq_databasemetadata.hxx"
#include "pq_xtables.hxx"
#include "pq_xviews.hxx"
#include "pq_xusers.hxx"
#include <rtl/ref.hxx>
#include <rtl/uuid.h>
#include <sal/log.hxx>
#include <cppuhelper/implbase.hxx>
#include <com/sun/star/beans/PropertyValue.hpp>
#include <com/sun/star/script/Converter.hpp>
#include <com/sun/star/sdbc/SQLException.hpp>
using osl::MutexGuard;
using com::sun::star::container::XNameAccess;
using com::sun::star::lang::XComponent;
using com::sun::star::lang::IllegalArgumentException;
using com::sun::star::script::Converter;
using com::sun::star::script::XTypeConverter;
using com::sun::star::uno::RuntimeException;
using com::sun::star::uno::Sequence;
using com::sun::star::uno::Reference;
using com::sun::star::uno::XInterface;
using com::sun::star::uno::UNO_QUERY;
using com::sun::star::uno::UNO_QUERY_THROW;
using com::sun::star::uno::XComponentContext;
using com::sun::star::uno::Any;
using com::sun::star::beans::PropertyValue;
using com::sun::star::sdbc::XCloseable;
using com::sun::star::sdbc::SQLException;
using com::sun::star::sdbc::XPreparedStatement;
using com::sun::star::sdbc::XStatement;
using com::sun::star::sdbc::XDatabaseMetaData;
namespace pq_sdbc_driver
{
namespace {
// Helper class for statement lifetime management
class ClosableReference : public cppu::WeakImplHelper< css::uno::XReference >
{
rtl::Reference<Connection> m_conn;
::rtl::ByteSequence m_id;
public:
ClosableReference( ::rtl::ByteSequence id , Connection *that )
: m_conn( that ), m_id(std::move( id ))
{
}
virtual void SAL_CALL dispose() override
{
if( m_conn.is() )
{
m_conn->removeFromWeakMap(m_id);
m_conn.clear();
}
}
};
}
Connection::Connection(
const rtl::Reference< comphelper::RefCountedMutex > &refMutex,
css::uno::Reference< css::uno::XComponentContext > ctx )
: ConnectionBase( refMutex->GetMutex() ),
m_ctx(std::move( ctx )) ,
m_xMutex( refMutex )
{
}
Connection::~Connection()
{
if( m_settings.pConnection )
{
PQfinish( m_settings.pConnection );
m_settings.pConnection = nullptr;
}
}
void Connection::close()
{
std::vector< css::uno::Reference< css::sdbc::XCloseable > > vectorCloseable;
std::vector< css::uno::Reference< css::lang::XComponent > > vectorDispose;
{
MutexGuard guard( m_xMutex->GetMutex() );
// silently ignore, if the connection has been closed already
if( m_settings.pConnection )
{
SAL_INFO("connectivity.postgresql", "closing connection");
PQfinish( m_settings.pConnection );
m_settings.pConnection = nullptr;
}
vectorDispose.push_back( Reference< XComponent > ( m_settings.users, UNO_QUERY ) );
vectorDispose.push_back( Reference< XComponent > ( m_settings.tables , UNO_QUERY ) );
m_meta.clear();
m_settings.tables.clear();
m_settings.users.clear();
for (auto const& statement : m_myStatements)
{
Reference< XCloseable > r = statement.second;
if( r.is() )
vectorCloseable.push_back( r );
}
}
// close all created statements
for (auto const& elem : vectorCloseable)
elem->close();
// close all created statements
for (auto const& elem : vectorDispose)
{
if( elem.is() )
elem->dispose();
}
}
void Connection::removeFromWeakMap( const ::rtl::ByteSequence & id )
{
// shrink the list !
MutexGuard guard( m_xMutex->GetMutex() );
WeakHashMap::iterator ii = m_myStatements.find( id );
if( ii != m_myStatements.end() )
m_myStatements.erase( ii );
}
Reference< XStatement > Connection::createStatement()
{
MutexGuard guard( m_xMutex->GetMutex() );
checkClosed();
rtl::Reference<Statement> stmt = new Statement( m_xMutex, this , &m_settings );
::rtl::ByteSequence id( 16 );
rtl_createUuid( reinterpret_cast<sal_uInt8*>(id.getArray()), nullptr, false );
m_myStatements[ id ] = Reference< XCloseable > ( stmt );
stmt->queryAdapter()->addReference( new ClosableReference( std::move(id), this ) );
return stmt;
}
Reference< XPreparedStatement > Connection::prepareStatement( const OUString& sql )
{
MutexGuard guard( m_xMutex->GetMutex() );
checkClosed();
OString byteSql = OUStringToOString( sql, ConnectionSettings::encoding );
rtl::Reference<PreparedStatement> stmt
= new PreparedStatement( m_xMutex, this, &m_settings, byteSql );
::rtl::ByteSequence id( 16 );
rtl_createUuid( reinterpret_cast<sal_uInt8*>(id.getArray()), nullptr, false );
m_myStatements[ id ] = Reference< XCloseable > ( stmt );
stmt->queryAdapter()->addReference(new ClosableReference(std::move(id), this));
return stmt;
}
Reference< XPreparedStatement > Connection::prepareCall( const OUString& )
{
throw SQLException(
u"pq_driver: Callable statements not supported"_ustr,
Reference< XInterface > (), OUString() , 1, Any() );
}
OUString Connection::nativeSQL( const OUString& sql )
{
return sql;
}
void Connection::setAutoCommit( sal_Bool )
{
// UNSUPPORTED
}
sal_Bool Connection::getAutoCommit()
{
// UNSUPPORTED
return true;
}
void Connection::commit()
{
// UNSUPPORTED
}
void Connection::rollback()
{
// UNSUPPORTED
}
sal_Bool Connection::isClosed()
{
return m_settings.pConnection == nullptr;
}
Reference< XDatabaseMetaData > Connection::getMetaData()
{
MutexGuard guard( m_xMutex->GetMutex() );
checkClosed();
if( ! m_meta.is() )
m_meta = new DatabaseMetaData( m_xMutex, this, &m_settings );
return m_meta;
}
void Connection::setReadOnly( sal_Bool )
{
// UNSUPPORTED
}
sal_Bool Connection::isReadOnly()
{
// UNSUPPORTED
return false;
}
void Connection::setCatalog( const OUString& )
{
// UNSUPPORTED
}
OUString Connection::getCatalog()
{
MutexGuard guard( m_xMutex->GetMutex() );
if( m_settings.pConnection == nullptr )
{
throw SQLException( u"pq_connection: connection is closed"_ustr, *this,
OUString(), 1, Any() );
}
char * p = PQdb(m_settings.pConnection );
return OUString( p, strlen(p) , ConnectionSettings::encoding );
}
void Connection::setTransactionIsolation( sal_Int32 )
{
// UNSUPPORTED
}
sal_Int32 Connection::getTransactionIsolation()
{
// UNSUPPORTED
return 0;
}
Reference< XNameAccess > Connection::getTypeMap()
{
Reference< XNameAccess > t;
{
MutexGuard guard( m_xMutex->GetMutex() );
t = m_typeMap;
}
return t;
}
void Connection::setTypeMap( const Reference< XNameAccess >& typeMap )
{
MutexGuard guard( m_xMutex->GetMutex() );
m_typeMap = typeMap;
}
Any Connection::getWarnings()
{
return Any();
}
void Connection::clearWarnings()
{
}
namespace {
class cstr_vector
{
std::vector<char*> values;
std::vector<bool> acquired;
public:
#if defined __GNUC__ && !defined __clang__ && __GNUC__ == 14
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Warray-bounds"
#pragma GCC diagnostic ignored "-Wstringop-overflow"
#endif
cstr_vector () { values.reserve(8); acquired.reserve(8); }
#if defined __GNUC__ && !defined __clang__ && __GNUC__ == 14
#pragma GCC diagnostic pop
#endif
~cstr_vector ()
{
OSL_ENSURE(values.size() == acquired.size(), "pq_connection: cstr_vector values and acquired size mismatch");
std::vector<bool>::const_iterator pa = acquired.begin();
for( const auto& v : values )
{
if (*pa)
free(v);
++pa;
}
}
void push_back(const char* s, __sal_NoAcquire)
{
values.push_back(const_cast<char*>(s));
acquired.push_back(false);
}
void push_back(char* s)
{
values.push_back(s);
acquired.push_back(true);
}
// This const_cast is there for compatibility with PostgreSQL <= 9.1;
// PostgreSQL >= 9.2 has the right const qualifiers in the headers
// for a return type of "char const*const*".
char const** c_array() const { return const_cast <const char**>(values.data()); }
};
}
static void properties2arrays( const Sequence< PropertyValue > & args,
const Reference< XTypeConverter> &tc,
rtl_TextEncoding enc,
cstr_vector &keywords,
cstr_vector &values)
{
// LEM TODO: can we just blindly take all properties?
// I.e. they are prefiltered to have only relevant ones?
// Else, at least support all keywords from
// http://www.postgresql.org/docs/9.0/interactive/libpq-connect.html
static const char* keyword_list[] = {
"password",
"user",
"port",
"dbname",
"connect_timeout",
"options",
"requiressl"
};
for( PropertyValue const & prop : args )
{
bool append = false;
for(const char* j : keyword_list)
{
if( prop.Name.equalsIgnoreAsciiCaseAscii( j ))
{
keywords.push_back( j, SAL_NO_ACQUIRE );
append = true;
break;
}
}
if( append )
{
OUString value;
tc->convertTo( prop.Value, cppu::UnoType<decltype(value)>::get() ) >>= value;
char *v = strdup(OUStringToOString(value, enc).getStr());
values.push_back ( v );
}
else
{
// ignore for now
SAL_WARN("connectivity.postgresql", "sdbc-postgresql: unknown argument '" << prop.Name << "' having value: " << prop.Value );
}
}
}
void Connection::initialize( const Sequence< Any >& aArguments )
{
OUString url;
Sequence< PropertyValue > args;
Reference< XTypeConverter > tc( Converter::create(m_ctx) );
if( ! tc.is() )
{
throw RuntimeException(
u"pq_driver: Couldn't instantiate converter service"_ustr );
}
if( aArguments.getLength() != 2 )
{
throw IllegalArgumentException(
"pq_driver: expected 2 arguments, got " + OUString::number( aArguments.getLength( ) ),
Reference< XInterface > () , 0 );
}
if( ! (aArguments[0] >>= url) )
{
throw IllegalArgumentException(
"pq_driver: expected string as first argument, got "
+ aArguments[0].getValueTypeName(),
*this, 0 );
}
tc->convertTo( aArguments[1], cppu::UnoType<decltype(args)>::get() ) >>= args;
OString o;
int nColon = url.indexOf( ':' );
if( nColon != -1 )
{
nColon = url.indexOf( ':' , 1+ nColon );
if( nColon != -1 )
{
o = rtl::OUStringToOString( url.subView(nColon+1), ConnectionSettings::encoding );
}
}
{
cstr_vector keywords;
cstr_vector values;
if ( o.getLength() > 0 )
{
char *err;
const std::unique_ptr<PQconninfoOption, deleter_from_fn<PQconninfoFree>>
oOpts(PQconninfoParse(o.getStr(), &err));
if (oOpts == nullptr)
{
OUString errorMessage;
if ( err != nullptr)
{
errorMessage = OUString( err, strlen(err), ConnectionSettings::encoding );
PQfreemem(err);
}
else
errorMessage = "#no error message#";
// HY092 is "Invalid attribute/option identifier."
// Just the most likely error; the error might be HY024 "Invalid attribute value".
throw SQLException(
"Error in database URL '" + url + "':\n" + errorMessage,
*this, u"HY092"_ustr, 5, Any() );
}
for ( PQconninfoOption * opt = oOpts.get(); opt->keyword != nullptr; ++opt)
{
if ( opt->val != nullptr )
{
keywords.push_back(strdup(opt->keyword));
values.push_back(strdup(opt->val));
}
}
}
properties2arrays( args , tc, ConnectionSettings::encoding, keywords, values );
keywords.push_back(nullptr, SAL_NO_ACQUIRE);
values.push_back(nullptr, SAL_NO_ACQUIRE);
m_settings.pConnection = PQconnectdbParams( keywords.c_array(), values.c_array(), 0 );
}
if( ! m_settings.pConnection )
throw RuntimeException(u"pq_driver: out of memory"_ustr );
if( PQstatus( m_settings.pConnection ) == CONNECTION_BAD )
{
const char * error = PQerrorMessage( m_settings.pConnection );
OUString errorMessage( error, strlen( error) , RTL_TEXTENCODING_ASCII_US );
PQfinish( m_settings.pConnection );
m_settings.pConnection = nullptr;
throw SQLException(
"Couldn't establish database connection to '" + url + "'\n"
+ errorMessage,
*this, errorMessage, CONNECTION_BAD, Any() );
}
PQsetClientEncoding( m_settings.pConnection, "UNICODE" );
char *p = PQuser( m_settings.pConnection );
m_settings.user = OUString( p, strlen(p), RTL_TEXTENCODING_UTF8);
p = PQdb( m_settings.pConnection );
m_settings.catalog = OUString( p, strlen(p), RTL_TEXTENCODING_UTF8);
m_settings.tc = std::move(tc);
SAL_INFO("connectivity.postgresql", "connection to '" << url << "' successfully opened");
}
void Connection::disposing()
{
close();
}
void Connection::checkClosed()
{
if( !m_settings.pConnection )
throw SQLException( u"pq_connection: Connection already closed"_ustr,
*this, OUString(), 1, Any() );
}
Reference< XNameAccess > Connection::getTables()
{
SAL_INFO("connectivity.postgresql", "Connection::getTables() got called");
MutexGuard guard( m_xMutex->GetMutex() );
if( !m_settings.tables.is() )
m_settings.tables = Tables::create( m_xMutex, this, &m_settings , &m_settings.pTablesImpl);
else
// TODO: how to overcome the performance problem ?
Reference< css::util::XRefreshable > ( m_settings.tables, UNO_QUERY_THROW )->refresh();
return m_settings.tables;
}
Reference< XNameAccess > Connection::getViews()
{
SAL_INFO("connectivity.postgresql", "Connection::getViews() got called");
MutexGuard guard( m_xMutex->GetMutex() );
if( !m_settings.views.is() )
m_settings.views = Views::create( m_xMutex, this, &m_settings, &(m_settings.pViewsImpl) );
else
// TODO: how to overcome the performance problem ?
Reference< css::util::XRefreshable > ( m_settings.views, UNO_QUERY_THROW )->refresh();
return m_settings.views;
}
Reference< XNameAccess > Connection::getUsers()
{
SAL_INFO("connectivity.postgresql", "Connection::getUsers() got called");
MutexGuard guard( m_xMutex->GetMutex() );
if( !m_settings.users.is() )
m_settings.users = Users::create( m_xMutex, this, &m_settings );
return m_settings.users;
}
} // end namespace
extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface*
connectivity_postgresql_Connection_get_implementation(
css::uno::XComponentContext* context , css::uno::Sequence<css::uno::Any> const&)
{
::rtl::Reference< comphelper::RefCountedMutex > ref = new comphelper::RefCountedMutex;
return cppu::acquire(new pq_sdbc_driver::Connection( ref, context ));
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */