connectivity/source/drivers/postgresql/pq_resultsetmetadata.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  *  Effective License of whole file:
   5  *
   6  *    This library is free software; you can redistribute it and/or
   7  *    modify it under the terms of the GNU Lesser General Public
   8  *    License version 2.1, as published by the Free Software Foundation.
   9  *
  10  *    This library is distributed in the hope that it will be useful,
  11  *    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  *    Lesser General Public License for more details.
  14  *
  15  *    You should have received a copy of the GNU Lesser General Public
  16  *    License along with this library; if not, write to the Free Software
  17  *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  18  *    MA  02111-1307  USA
  19  *
  20  *  Parts "Copyright by Sun Microsystems, Inc" prior to August 2011:
  21  *
  22  *    The Contents of this file are made available subject to the terms of
  23  *    the GNU Lesser General Public License Version 2.1
  24  *
  25  *    Copyright: 2000 by Sun Microsystems, Inc.
  26  *
  27  *    Contributor(s): Joerg Budischewski
  28  *
  29  *  All parts contributed on or after August 2011:
  30  *
  31  *    This Source Code Form is subject to the terms of the Mozilla Public
  32  *    License, v. 2.0. If a copy of the MPL was not distributed with this
  33  *    file, You can obtain one at http://mozilla.org/MPL/2.0/.
  34  *
  35  ************************************************************************/
  36
  37 #include <rtl/ustrbuf.hxx>
  38
  39 #include "pq_resultsetmetadata.hxx"
  40 #include "pq_resultset.hxx"
  41 #include "pq_tools.hxx"
  42 #include "pq_statics.hxx"
  43
  44 #include <com/sun/star/sdbcx/XColumnsSupplier.hpp>
  45 #include <com/sun/star/sdbc/ColumnValue.hpp>
  46 #include <com/sun/star/sdbc/SQLException.hpp>
  47 #include <com/sun/star/sdbc/XRow.hpp>
  48
  49 #include <string.h>
  50
  51 using osl::MutexGuard;
  52
  53
  54 using com::sun::star::uno::Any;
  55 using com::sun::star::uno::Exception;
  56 using com::sun::star::uno::Reference;
  57 using com::sun::star::uno::UNO_QUERY;
  58
  59
  60 using com::sun::star::sdbc::SQLException;
  61 using com::sun::star::sdbc::XStatement;
  62 using com::sun::star::sdbc::XRow;
  63 using com::sun::star::sdbc::XResultSet;
  64 using com::sun::star::sdbcx::XColumnsSupplier;
  65 using com::sun::star::sdbcx::XTablesSupplier;
  66
  67 using com::sun::star::beans::XPropertySet;
  68 using com::sun::star::container::XNameAccess;
  69
  70
  71 namespace pq_sdbc_driver
  72 {
  73
  74 // struct ColumnMetaData
  75 // {
  76 //     OUString tableName;
  77 //     OUString schemaTableName;
  78 //     OUString typeName;
  79 //     css::sdbc::DataType type;
  80 //     sal_Int32 precision;
  81 //     sal_Int32 scale;
  82 //     sal_Bool isCurrency;
  83 //     sal_Bool isNullable;
  84 //     sal_Bool isAutoIncrement;
  85 //     sal_Bool isReadOnly;
  86 //     sal_Bool isSigned;
  87 // };
  88
  89 // is not exported by the postgres header
  90 const static int PQ_VARHDRSZ = sizeof( sal_Int32 );
  91
  92 static void extractPrecisionAndScale( sal_Int32 atttypmod, sal_Int32 *precision, sal_Int32 *scale )
  93 {
  94     if( atttypmod < PQ_VARHDRSZ )
  95     {
  96         *precision = 0;
  97         *scale = 0;
  98     }
  99     else
 100     {
 101         if( atttypmod & 0xffff0000 )
 102         {
 103             *precision = ( ( atttypmod - PQ_VARHDRSZ ) >> 16 ) & 0xffff;
 104             *scale = (atttypmod - PQ_VARHDRSZ ) & 0xffff;
 105         }
 106         else
 107         {
 108             *precision = atttypmod - PQ_VARHDRSZ;
 109             *scale = 0;
 110         }
 111     }
 112 }
 113
 114 ResultSetMetaData::ResultSetMetaData(
 115     const ::rtl::Reference< comphelper::RefCountedMutex > & refMutex,
 116     const css::uno::Reference< css::sdbc::XResultSet >  & origin,
 117     ResultSet * pResultSet,
 118     ConnectionSettings **ppSettings,
 119     PGresult const *pResult,
 120     const OUString &schemaName,
 121     const OUString &tableName ) :
 122     m_xMutex( refMutex ),
 123     m_ppSettings( ppSettings ),
 124     m_origin( origin ),
 125     m_tableName( tableName ),
 126     m_schemaName( schemaName ),
 127     m_colDesc( PQnfields( pResult ) ),
 128     m_pResultSet( pResultSet ),
 129     m_checkedForTable( false ),
 130     m_checkedForTypes( false ),
 131     m_colCount( PQnfields( pResult ) )
 132 {
 133
 134     // extract all needed information from the result object, so that we don't
 135     // need it anymore after this call !
 136     for( int col = 0; col < m_colCount ; col ++ )
 137     {
 138         sal_Int32 size = PQfsize( pResult, col );
 139         size = -1 == size ? 25 : size;
 140         m_colDesc[col].displaySize = size;
 141
 142         extractPrecisionAndScale(
 143             PQfmod( pResult, col ),
 144             & ( m_colDesc[col].precision ),
 145             & ( m_colDesc[col].scale ) );
 146         char *name = PQfname( pResult, col );
 147         m_colDesc[col].name = OUString( name, strlen(name) , ConnectionSettings::encoding );
 148         m_colDesc[col].typeOid = PQftype( pResult, col );
 149         m_colDesc[col].type = css::sdbc::DataType::LONGVARCHAR;
 150     }
 151 }
 152
 153 void ResultSetMetaData::checkForTypes()
 154 {
 155     if( ! m_checkedForTypes )
 156     {
 157         Reference< XStatement > stmt =
 158             extractConnectionFromStatement( m_origin->getStatement() )->createStatement();
 159         DisposeGuard guard( stmt );
 160         OUStringBuffer buf(128);
 161         buf.append( "SELECT oid, typname, typtype FROM pg_type WHERE ");
 162         for( int i  = 0 ; i < m_colCount ; i ++ )
 163         {
 164             if( i > 0 )
 165                 buf.append( " OR " );
 166             int oid = m_colDesc[i].typeOid;
 167             buf.append( "oid=" );
 168             buf.append( static_cast<sal_Int32>(oid) );
 169         }
 170         Reference< XResultSet > rs = stmt->executeQuery( buf.makeStringAndClear() );
 171         Reference< XRow > xRow( rs, UNO_QUERY );
 172         while( rs->next() )
 173         {
 174             Oid oid = xRow->getInt( 1 );
 175             OUString typeName = xRow->getString( 2 );
 176             OUString typType = xRow->getString( 3 );
 177
 178             sal_Int32 type = typeNameToDataType( typeName, typType );
 179
 180             for( sal_Int32 j = 0; j < m_colCount ; j ++ )
 181             {
 182                 if( m_colDesc[j].typeOid == oid )
 183                 {
 184                     m_colDesc[j].typeName = typeName;
 185                     m_colDesc[j].type = type;
 186                 }
 187             }
 188         }
 189         m_checkedForTypes = true;
 190     }
 191 }
 192
 193 void ResultSetMetaData::checkTable()
 194 {
 195     if( ! m_checkedForTable )
 196     {
 197         m_checkedForTable = true;
 198         if( m_tableName.getLength() )
 199         {
 200
 201             Reference< css::container::XNameAccess > tables = (*m_ppSettings)->tables;
 202             if( ! tables.is() )
 203             {
 204
 205                 Reference< XTablesSupplier > supplier =
 206                     Reference< XTablesSupplier > (
 207                         extractConnectionFromStatement( m_origin->getStatement() ), UNO_QUERY);
 208                 if( supplier.is() )
 209                     tables = supplier->getTables();
 210             }
 211             if( tables.is() )
 212             {
 213                 const OUString name   (getTableName ( 1 ));
 214                 const OUString schema (getSchemaName( 1 ));
 215                 const OUString composedName( schema.isEmpty() ? name : (schema + "." + name) );
 216                 tables->getByName( composedName ) >>= m_table;
 217             }
 218         }
 219     }
 220 }
 221
 222 sal_Int32 ResultSetMetaData::getIntColumnProperty( const OUString & name, int index, int def )
 223 {
 224     sal_Int32 ret = def; // give defensive answers, when data is not available
 225     try
 226     {
 227         MutexGuard guard( m_xMutex->GetMutex() );
 228         checkColumnIndex( index );
 229         Reference< XPropertySet > set = getColumnByIndex( index );
 230
 231         if( set.is() )
 232         {
 233             set->getPropertyValue( name ) >>= ret;
 234         }
 235     }
 236     catch( css::uno::Exception & )
 237     {
 238     }
 239     return ret;
 240 }
 241
 242 bool ResultSetMetaData::getBoolColumnProperty( const OUString & name, int index, bool def )
 243 {
 244     bool ret = def;
 245     try
 246     {
 247         MutexGuard guard( m_xMutex->GetMutex() );
 248         checkColumnIndex( index );
 249         Reference< XPropertySet > set = getColumnByIndex( index );
 250         if( set.is() )
 251         {
 252             set->getPropertyValue( name ) >>= ret;
 253         }
 254     }
 255     catch( css::uno::Exception & )
 256     {
 257     }
 258
 259     return ret;
 260 }
 261
 262 Reference< css::beans::XPropertySet > ResultSetMetaData::getColumnByIndex( int index )
 263 {
 264     Reference< XPropertySet > ret;
 265     checkTable();
 266     if( m_table.is() )
 267     {
 268         OUString columnName = getColumnName( index );
 269         Reference< XColumnsSupplier > supplier( m_table, UNO_QUERY );
 270         if( supplier.is() )
 271         {
 272             Reference< XNameAccess > columns = supplier->getColumns();
 273             if( columns.is() && columns->hasByName( columnName ) )
 274             {
 275                 columns->getByName( columnName ) >>= ret;
 276             }
 277         }
 278     }
 279     return ret;
 280 }
 281
 282 // Methods
 283 sal_Int32 ResultSetMetaData::getColumnCount(  )
 284 {
 285     return m_colCount;
 286 }
 287
 288 sal_Bool ResultSetMetaData::isAutoIncrement( sal_Int32 column )
 289 {
 290
 291     bool ret = getBoolColumnProperty( getStatics().IS_AUTO_INCREMENT, column, false );
 292     return ret;
 293 }
 294
 295 sal_Bool ResultSetMetaData::isCaseSensitive( sal_Int32 )
 296 {
 297     return true; // ??? hmm, numeric types or
 298 }
 299
 300 sal_Bool ResultSetMetaData::isSearchable( sal_Int32 )
 301 {
 302     return true; // mmm, what types are not searchable ?
 303 }
 304
 305 sal_Bool ResultSetMetaData::isCurrency( sal_Int32 column )
 306 {
 307     return getBoolColumnProperty( getStatics().IS_CURRENCY, column, false );
 308 }
 309
 310 sal_Int32 ResultSetMetaData::isNullable( sal_Int32 column )
 311 {
 312     return getIntColumnProperty(
 313         getStatics().IS_NULLABLE, column, css::sdbc::ColumnValue::NULLABLE_UNKNOWN );
 314 }
 315
 316 sal_Bool ResultSetMetaData::isSigned( sal_Int32 )
 317 {
 318     return true;
 319 }
 320
 321 sal_Int32 ResultSetMetaData::getColumnDisplaySize( sal_Int32 column )
 322 {
 323     MutexGuard guard( m_xMutex->GetMutex() );
 324     checkColumnIndex( column );
 325     return m_colDesc[column-1].displaySize;
 326 }
 327
 328 OUString ResultSetMetaData::getColumnLabel( sal_Int32 column )
 329 {
 330     return getColumnName( column);
 331 }
 332
 333 OUString ResultSetMetaData::getColumnName( sal_Int32 column )
 334 {
 335     MutexGuard guard( m_xMutex->GetMutex() );
 336     checkColumnIndex( column );
 337
 338     return m_colDesc[column-1].name;
 339 }
 340
 341 OUString ResultSetMetaData::getSchemaName( sal_Int32 )
 342 {
 343     return m_schemaName;
 344 }
 345
 346 sal_Int32 ResultSetMetaData::getPrecision( sal_Int32 column )
 347 {
 348     MutexGuard guard( m_xMutex->GetMutex() );
 349     checkColumnIndex( column );
 350     return m_colDesc[column-1].precision;
 351 }
 352
 353 sal_Int32 ResultSetMetaData::getScale( sal_Int32 column )
 354 {
 355     MutexGuard guard( m_xMutex->GetMutex() );
 356     checkColumnIndex( column );
 357     return m_colDesc[column-1].scale;
 358 }
 359
 360 OUString ResultSetMetaData::getTableName( sal_Int32 )
 361 {
 362 // LEM TODO This is very fishy.. Should probably return the table to which that column belongs!
 363     return m_tableName;
 364 }
 365
 366 OUString ResultSetMetaData::getCatalogName( sal_Int32 )
 367 {
 368     // can do this through XConnection.getCatalog() !
 369     return OUString();
 370 }
 371 sal_Int32 ResultSetMetaData::getColumnType( sal_Int32 column )
 372 {
 373     int ret = getIntColumnProperty( getStatics().TYPE, column, -100 );
 374     if( -100 == ret )
 375     {
 376         checkForTypes();
 377         if( css::sdbc::DataType::LONGVARCHAR == m_colDesc[column-1].type && m_pResultSet )
 378             m_colDesc[column-1].type = m_pResultSet->guessDataType( column );
 379         ret = m_colDesc[column-1].type;
 380     }
 381     return ret;
 382 }
 383
 384 OUString ResultSetMetaData::getColumnTypeName( sal_Int32 column )
 385 {
 386     OUString ret; // give defensive answers, when data is not available
 387     try
 388     {
 389         MutexGuard guard( m_xMutex->GetMutex() );
 390         checkColumnIndex( column );
 391         Reference< XPropertySet > set = getColumnByIndex( column );
 392
 393         if( set.is() )
 394         {
 395             set->getPropertyValue( getStatics().TYPE_NAME ) >>= ret;
 396         }
 397         else
 398         {
 399             checkForTypes();
 400             ret = m_colDesc[column-1].typeName;
 401         }
 402     }
 403     catch( css::uno::Exception & )
 404     {
 405     }
 406     return ret;
 407 }
 408
 409
 410 sal_Bool ResultSetMetaData::isReadOnly( sal_Int32 )
 411 {
 412     return false;
 413 }
 414
 415 sal_Bool ResultSetMetaData::isWritable( sal_Int32 column )
 416 {
 417     return ! isReadOnly( column ); // what's the sense if this method ?
 418 }
 419
 420 sal_Bool ResultSetMetaData::isDefinitelyWritable( sal_Int32 column )
 421 {
 422     return isWritable(column); // uhh, now it becomes really esoteric ....
 423 }
 424 OUString ResultSetMetaData::getColumnServiceName( sal_Int32 )
 425 {
 426     return OUString();
 427 }
 428
 429 void ResultSetMetaData::checkColumnIndex(sal_Int32 columnIndex)
 430 {
 431     if( columnIndex < 1 || columnIndex > m_colCount )
 432     {
 433         throw SQLException(
 434             "pq_resultsetmetadata: index out of range (expected 1 to "
 435             + OUString::number( m_colCount ) + ", got " + OUString::number( columnIndex ),
 436             *this, OUString(), 1, Any() );
 437     }
 438 }
 439
 440 }
 441
 442 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */