connectivity/source/drivers/file/FConnection.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #include <sal/config.h>
  21
  22 #include <comphelper/processfactory.hxx>
  23 #include <comphelper/servicehelper.hxx>
  24 #include <cppuhelper/typeprovider.hxx>
  25 #include <file/FConnection.hxx>
  26 #include <file/FDatabaseMetaData.hxx>
  27 #include <file/FDriver.hxx>
  28 #include <file/FStatement.hxx>
  29 #include <file/FPreparedStatement.hxx>
  30 #include <com/sun/star/container/XChild.hpp>
  31 #include <com/sun/star/ucb/ContentCreationException.hpp>
  32 #include <com/sun/star/ucb/XContent.hpp>
  33 #include <com/sun/star/ucb/XContentIdentifier.hpp>
  34 #include <tools/urlobj.hxx>
  35 #include <file/FCatalog.hxx>
  36 #include <unotools/pathoptions.hxx>
  37 #include <ucbhelper/content.hxx>
  38 #include <connectivity/dbcharset.hxx>
  39 #include <connectivity/dbexception.hxx>
  40 #include <o3tl/any.hxx>
  41 #include <osl/thread.h>
  42 #include <strings.hrc>
  43
  44 using namespace connectivity::file;
  45 using namespace dbtools;
  46
  47 using namespace com::sun::star::uno;
  48 using namespace com::sun::star::lang;
  49 using namespace com::sun::star::beans;
  50 using namespace com::sun::star::sdbc;
  51 using namespace com::sun::star::sdbcx;
  52 using namespace com::sun::star::container;
  53 using namespace com::sun::star::ucb;
  54 using namespace ::ucbhelper;
  55 typedef connectivity::OMetaConnection OConnection_BASE;
  56
  57 OConnection::OConnection(OFileDriver*   _pDriver)
  58     : m_pDriver(_pDriver)
  59     , m_bAutoCommit(false)
  60     , m_bReadOnly(false)
  61     , m_bShowDeleted(false)
  62     , m_bCaseSensitiveExtension( true )
  63     , m_bCheckSQL92(false)
  64     , m_bDefaultTextEncoding(false)
  65 {
  66     m_nTextEncoding = RTL_TEXTENCODING_DONTKNOW;
  67 }
  68
  69 OConnection::~OConnection()
  70 {
  71     if(!isClosed(  ))
  72         close();
  73 }
  74
  75 bool OConnection::matchesExtension( const OUString& _rExt ) const
  76 {
  77     if ( isCaseSensitiveExtension() )
  78         return ( getExtension() == _rExt );
  79
  80     OUString sMyExtension( getExtension().toAsciiLowerCase() );
  81     OUString sExt( _rExt.toAsciiLowerCase() );
  82
  83     return sMyExtension == sExt;
  84 }
  85
  86
  87 void OConnection::construct(const OUString& url,const Sequence< PropertyValue >& info)
  88 {
  89     osl_atomic_increment( &m_refCount );
  90
  91     OUString aExt;
  92     const PropertyValue *pIter  = info.getConstArray();
  93     const PropertyValue *pEnd    = pIter + info.getLength();
  94     for(;pIter != pEnd;++pIter)
  95     {
  96         if( pIter->Name == "Extension" )
  97             OSL_VERIFY( pIter->Value >>= aExt );
  98         else if( pIter->Name == "CharSet" )
  99         {
 100             if (auto const numeric = o3tl::tryAccess<sal_uInt16>(pIter->Value))
 101             {
 102                 m_nTextEncoding = *numeric;
 103             }
 104             else
 105             {
 106                 OUString sIanaName;
 107                 OSL_VERIFY( pIter->Value >>= sIanaName );
 108
 109                 ::dbtools::OCharsetMap aLookupIanaName;
 110                 ::dbtools::OCharsetMap::const_iterator aLookup = aLookupIanaName.findIanaName(sIanaName);
 111                 if (aLookup != aLookupIanaName.end())
 112                     m_nTextEncoding = (*aLookup).getEncoding();
 113                 else
 114                     m_nTextEncoding = RTL_TEXTENCODING_DONTKNOW;
 115             }
 116         }
 117         else if( pIter->Name == "ShowDeleted" )
 118         {
 119             OSL_VERIFY( pIter->Value >>= m_bShowDeleted );
 120         }
 121         else if( pIter->Name == "EnableSQL92Check" )
 122         {
 123             pIter->Value >>= m_bCheckSQL92;
 124         }
 125     } // for(;pIter != pEnd;++pIter)
 126
 127     {
 128         sal_Int32 nLen = url.indexOf(':');
 129         nLen = url.indexOf(':',nLen+1);
 130         OUString aDSN(url.copy(nLen+1));
 131
 132         OUString aFileName = aDSN;
 133         INetURLObject aURL;
 134         aURL.SetSmartProtocol(INetProtocol::File);
 135         {
 136             SvtPathOptions aPathOptions;
 137             aFileName = aPathOptions.SubstituteVariable(aFileName);
 138         }
 139
 140         aURL.SetSmartURL(aFileName);
 141
 142         setURL(aURL.GetMainURL(INetURLObject::DecodeMechanism::NONE));
 143     }
 144
 145     if ( m_nTextEncoding == RTL_TEXTENCODING_DONTKNOW )
 146     {
 147         //m_nTextEncoding = osl_getTextEncodingFromLocale(NULL);
 148         m_nTextEncoding = osl_getThreadTextEncoding();
 149         m_bDefaultTextEncoding = true;
 150     }
 151
 152     if ( !aExt.isEmpty() )
 153         m_aFilenameExtension = aExt;
 154
 155     try
 156     {
 157         ::ucbhelper::Content aFile;
 158         try
 159         {
 160             aFile = ::ucbhelper::Content(getURL(), Reference< XCommandEnvironment >(), comphelper::getProcessComponentContext());
 161         }
 162         catch(ContentCreationException& e)
 163         {
 164             throwUrlNotValid(getURL(),e.Message);
 165         }
 166
 167         // set fields to fetch
 168         Sequence< OUString > aProps { "Title" };
 169
 170         try
 171         {
 172             if (aFile.isFolder())
 173             {
 174                 m_xDir = aFile.createDynamicCursor(aProps, ::ucbhelper::INCLUDE_DOCUMENTS_ONLY );
 175                 m_xContent = aFile.get();
 176             }
 177             else if (aFile.isDocument())
 178             {
 179                 Reference<XContent> xParent(Reference<XChild>(aFile.get(),UNO_QUERY_THROW)->getParent(),UNO_QUERY_THROW);
 180                 Reference<XContentIdentifier> xIdent = xParent->getIdentifier();
 181                 m_xContent = xParent;
 182
 183                 ::ucbhelper::Content aParent(xIdent->getContentIdentifier(), Reference< XCommandEnvironment >(), comphelper::getProcessComponentContext());
 184                 m_xDir = aParent.createDynamicCursor(aProps, ::ucbhelper::INCLUDE_DOCUMENTS_ONLY );
 185             }
 186             else
 187             {
 188                 OSL_FAIL("OConnection::construct: ::ucbhelper::Content is neither a folder nor a document! How's that?!");
 189                 throw SQLException();
 190             }
 191         }
 192         catch(Exception& e) // an exception is thrown when no file exists
 193         {
 194             throwUrlNotValid(getURL(),e.Message);
 195         }
 196         if(!m_xDir.is() || !m_xContent.is())
 197             throwUrlNotValid(getURL(),OUString());
 198
 199         if (m_aFilenameExtension.indexOf('*') >= 0 || m_aFilenameExtension.indexOf('?') >= 0)
 200             throw SQLException();
 201     }
 202     catch(const Exception&)
 203     {
 204         osl_atomic_decrement( &m_refCount );
 205         throw;
 206     }
 207
 208     osl_atomic_decrement( &m_refCount );
 209 }
 210 // XServiceInfo
 211
 212 IMPLEMENT_SERVICE_INFO(OConnection, "com.sun.star.sdbc.drivers.file.Connection", "com.sun.star.sdbc.Connection")
 213
 214
 215 Reference< XStatement > SAL_CALL OConnection::createStatement(  )
 216 {
 217     ::osl::MutexGuard aGuard( m_aMutex );
 218     checkDisposed(OConnection_BASE::rBHelper.bDisposed);
 219
 220
 221     Reference< XStatement > xReturn = new OStatement(this);
 222     m_aStatements.push_back(WeakReferenceHelper(xReturn));
 223     return xReturn;
 224 }
 225
 226 Reference< XPreparedStatement > SAL_CALL OConnection::prepareStatement( const OUString& sql )
 227 {
 228     ::osl::MutexGuard aGuard( m_aMutex );
 229     checkDisposed(OConnection_BASE::rBHelper.bDisposed);
 230
 231
 232     OPreparedStatement* pStmt = new OPreparedStatement(this);
 233     Reference< XPreparedStatement > xHoldAlive = pStmt;
 234     pStmt->construct(sql);
 235     m_aStatements.push_back(WeakReferenceHelper(*pStmt));
 236     return pStmt;
 237 }
 238
 239 Reference< XPreparedStatement > SAL_CALL OConnection::prepareCall( const OUString& /*sql*/ )
 240 {
 241     throwFeatureNotImplementedSQLException( "XConnection::prepareCall", *this );
 242     return nullptr;
 243 }
 244
 245 OUString SAL_CALL OConnection::nativeSQL( const OUString& sql )
 246 {
 247     return sql;
 248 }
 249
 250 void SAL_CALL OConnection::setAutoCommit( sal_Bool autoCommit )
 251 {
 252     ::osl::MutexGuard aGuard( m_aMutex );
 253     checkDisposed(OConnection_BASE::rBHelper.bDisposed);
 254
 255     m_bAutoCommit = autoCommit;
 256 }
 257
 258 sal_Bool SAL_CALL OConnection::getAutoCommit(  )
 259 {
 260     ::osl::MutexGuard aGuard( m_aMutex );
 261     checkDisposed(OConnection_BASE::rBHelper.bDisposed);
 262
 263     return m_bAutoCommit;
 264 }
 265
 266 void SAL_CALL OConnection::commit(  )
 267 {
 268 }
 269
 270 void SAL_CALL OConnection::rollback(  )
 271 {
 272 }
 273
 274 sal_Bool SAL_CALL OConnection::isClosed(  )
 275 {
 276     ::osl::MutexGuard aGuard( m_aMutex );
 277
 278     return OConnection_BASE::rBHelper.bDisposed;
 279 }
 280
 281 Reference< XDatabaseMetaData > SAL_CALL OConnection::getMetaData(  )
 282 {
 283     ::osl::MutexGuard aGuard( m_aMutex );
 284     checkDisposed(OConnection_BASE::rBHelper.bDisposed);
 285
 286
 287     Reference< XDatabaseMetaData > xMetaData = m_xMetaData;
 288     if(!xMetaData.is())
 289     {
 290         xMetaData = new ODatabaseMetaData(this);
 291         m_xMetaData = xMetaData;
 292     }
 293
 294     return xMetaData;
 295 }
 296
 297 void SAL_CALL OConnection::setReadOnly( sal_Bool readOnly )
 298 {
 299     ::osl::MutexGuard aGuard( m_aMutex );
 300     checkDisposed(OConnection_BASE::rBHelper.bDisposed);
 301
 302
 303     m_bReadOnly = readOnly;
 304 }
 305
 306 sal_Bool SAL_CALL OConnection::isReadOnly(  )
 307 {
 308     ::osl::MutexGuard aGuard( m_aMutex );
 309     checkDisposed(OConnection_BASE::rBHelper.bDisposed);
 310
 311
 312     return m_bReadOnly;
 313 }
 314
 315 void SAL_CALL OConnection::setCatalog( const OUString& /*catalog*/ )
 316 {
 317     throwFeatureNotImplementedSQLException( "XConnection::setCatalog", *this );
 318 }
 319
 320 OUString SAL_CALL OConnection::getCatalog(  )
 321 {
 322     return OUString();
 323 }
 324
 325 void SAL_CALL OConnection::setTransactionIsolation( sal_Int32 /*level*/ )
 326 {
 327     throwFeatureNotImplementedSQLException( "XConnection::setTransactionIsolation", *this );
 328 }
 329
 330 sal_Int32 SAL_CALL OConnection::getTransactionIsolation(  )
 331 {
 332     return 0;
 333 }
 334
 335 Reference< XNameAccess > SAL_CALL OConnection::getTypeMap(  )
 336 {
 337     return nullptr;
 338 }
 339
 340 void SAL_CALL OConnection::setTypeMap( const Reference< XNameAccess >& /*typeMap*/ )
 341 {
 342 }
 343
 344 // XCloseable
 345 void SAL_CALL OConnection::close(  )
 346 {
 347     {
 348         ::osl::MutexGuard aGuard( m_aMutex );
 349         checkDisposed(OConnection_BASE::rBHelper.bDisposed);
 350
 351     }
 352     dispose();
 353 }
 354
 355 // XWarningsSupplier
 356 Any SAL_CALL OConnection::getWarnings(  )
 357 {
 358     return Any();
 359 }
 360
 361 void SAL_CALL OConnection::clearWarnings(  )
 362 {
 363 }
 364
 365 void OConnection::disposing()
 366 {
 367     ::osl::MutexGuard aGuard(m_aMutex);
 368     OConnection_BASE::disposing();
 369
 370     m_xDir.clear();
 371     m_xContent.clear();
 372     m_xCatalog  = WeakReference< XTablesSupplier>();
 373 }
 374
 375 Reference< XTablesSupplier > OConnection::createCatalog()
 376 {
 377     ::osl::MutexGuard aGuard( m_aMutex );
 378     Reference< XTablesSupplier > xTab = m_xCatalog;
 379     if(!xTab.is())
 380     {
 381         xTab = new OFileCatalog(this);
 382         m_xCatalog = xTab;
 383     }
 384     return xTab;
 385 }
 386
 387 Reference< XDynamicResultSet > OConnection::getDir() const
 388 {
 389     Reference<XDynamicResultSet> xContent;
 390     Sequence< OUString > aProps { "Title" };
 391     try
 392     {
 393         Reference<XContentIdentifier> xIdent = getContent()->getIdentifier();
 394         ::ucbhelper::Content aParent(xIdent->getContentIdentifier(), Reference< XCommandEnvironment >(), comphelper::getProcessComponentContext());
 395         xContent = aParent.createDynamicCursor(aProps, ::ucbhelper::INCLUDE_DOCUMENTS_ONLY );
 396     }
 397     catch(Exception&)
 398     {
 399     }
 400     return xContent;
 401 }
 402
 403 sal_Int64 SAL_CALL OConnection::getSomething( const Sequence< sal_Int8 >& rId )
 404 {
 405     return (isUnoTunnelId<OConnection>(rId))
 406         ? reinterpret_cast< sal_Int64 >( this )
 407         : sal_Int64(0);
 408 }
 409
 410 Sequence< sal_Int8 > OConnection::getUnoTunnelId()
 411 {
 412     static ::cppu::OImplementationId implId;
 413
 414     return implId.getImplementationId();
 415 }
 416
 417 void OConnection::throwUrlNotValid(const OUString & _rsUrl,const OUString & _rsMessage)
 418 {
 419     SQLException aError;
 420     aError.Message = getResources().getResourceStringWithSubstitution(
 421                 STR_NO_VALID_FILE_URL,
 422                 "$URL$", _rsUrl
 423             );
 424
 425     aError.SQLState = "S1000";
 426     aError.ErrorCode = 0;
 427     aError.Context = static_cast< XConnection* >(this);
 428     if (!_rsMessage.isEmpty())
 429         aError.NextException <<= SQLException(_rsMessage, aError.Context, OUString(), 0, Any());
 430
 431     throw aError;
 432 }
 433
 434
 435 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */