dbaccess/source/ui/dlg/DbAdminImpl.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef _DBAUI_DBADMINIMPL_HXX_
  30 #define _DBAUI_DBADMINIMPL_HXX_
  31
  32 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  33 #include <com/sun/star/container/XNameAccess.hpp>
  34 #include <com/sun/star/uno/XNamingService.hpp>
  35 #include <com/sun/star/beans/XPropertySet.hpp>
  36 #include <com/sun/star/beans/PropertyValue.hpp>
  37 #include <com/sun/star/sdbc/XConnection.hpp>
  38 #include <com/sun/star/sdbc/XDriver.hpp>
  39 #include <comphelper/stl_types.hxx>
  40 #include "dsntypes.hxx"
  41 #include <svl/itemset.hxx>
  42 #include <com/sun/star/frame/XModel.hpp>
  43 #include <svl/poolitem.hxx>
  44
  45 class Window;
  46 //.........................................................................
  47 namespace dbaui
  48 {
  49 //.........................................................................
  50     class DataSourceInfoConverter
  51     {
  52         ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory > m_xFactory;
  53     public:
  54         DataSourceInfoConverter(const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _xFactory)
  55             :m_xFactory(_xFactory)
  56         {
  57         }
  58         void convert(const ::dbaccess::ODsnTypeCollection* _pCollection,const ::rtl::OUString& _sOldURLPrefix,const ::rtl::OUString& _sNewURLPrefix,const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _xDatasource);
  59     };
  60     class IItemSetHelper;
  61     //========================================================================
  62     //= ODbDataSourceAdministrationHelper
  63     //========================================================================
  64     class ODbDataSourceAdministrationHelper
  65     {
  66     public:
  67         DECLARE_STL_MAP(sal_Int32, ::rtl::OUString, ::std::less< sal_Int32 >, MapInt2String);
  68
  69     private:
  70         ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >
  71                             m_xORB;                 /// service factory
  72         ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameAccess >
  73                                 m_xDatabaseContext;     /// database context we're working in
  74         ::com::sun::star::uno::Reference< ::com::sun::star::uno::XNamingService >
  75                                 m_xDynamicContext;      /// just another interface of the context ...
  76         ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >   m_xDatasource;
  77         ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel >         m_xModel;
  78
  79         ::com::sun::star::uno::Any              m_aDataSourceOrName;
  80         typedef ::std::set< ::rtl::OUString >   StringSet;
  81         typedef StringSet::const_iterator       ConstStringSetIterator;
  82
  83
  84         MapInt2String           m_aDirectPropTranslator;    /// translating property id's into names (direct properties of a data source)
  85         MapInt2String           m_aIndirectPropTranslator;  /// translating property id's into names (indirect properties of a data source)
  86         Window*                 m_pParent;
  87         IItemSetHelper*         m_pItemSetHelper;
  88     public:
  89
  90         ODbDataSourceAdministrationHelper(const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _xORB
  91                                         ,Window* _pParent
  92                                         ,IItemSetHelper* _pItemSetHelper);
  93
  94         /** translate the current dialog SfxItems into driver relevant PropertyValues
  95             @see successfullyConnected
  96         */
  97         sal_Bool    getCurrentSettings(::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& _rDriverParams);
  98
  99         /** to be called if the settings got from getCurrentSettings have been used for successfully connecting
 100             @see getCurrentSettings
 101         */
 102         void        successfullyConnected();
 103
 104         /// clear the password in the current data source's item set
 105         void        clearPassword();
 106
 107         inline ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory > getORB() const { return m_xORB; }
 108
 109         ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameAccess > getDatabaseContext() const { return m_xDatabaseContext; }
 110         ::com::sun::star::uno::Reference< ::com::sun::star::uno::XNamingService > getDynamicContext() const { return m_xDynamicContext; }
 111
 112         /** creates a new connection. The caller is responsible to dispose it !!!!
 113         */
 114         ::std::pair< ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection >,sal_Bool>      createConnection();
 115
 116         /** return the corresponding driver for the selected URL
 117         */
 118         ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XDriver >         getDriver();
 119         ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XDriver >         getDriver(const ::rtl::OUString& _sURL);
 120
 121         /** returns the data source the dialog is currently working with
 122         */
 123         ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >   getCurrentDataSource();
 124         // returns the Url of a database document
 125         String              getDocumentUrl(SfxItemSet& _rDest);
 126
 127         void setDataSourceOrName( const ::com::sun::star::uno::Any& _rDataSourceOrName );
 128
 129         /** extracts the connection type from the given set<p/>
 130             The connection type is determined by the value of the DSN item, analyzed by the TypeCollection item.
 131         */
 132         static ::rtl::OUString getDatasourceType( const SfxItemSet& _rSet );
 133
 134         /** returns the connection URL
 135             @return
 136                 The connection URL
 137         */
 138         String getConnectionURL() const;
 139
 140         /// fill the necessary information from the url line
 141         void convertUrl(SfxItemSet& _rDest);
 142
 143         const MapInt2String& getIndirectProperties() const { return m_aIndirectPropTranslator; }
 144
 145         /** translates properties of an UNO data source into SfxItems
 146             @param  _rxSource
 147                 The data source
 148             @param  _rDest
 149                 The item set to fill.
 150         */
 151         void translateProperties(
 152                 const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxSource,
 153                 SfxItemSet& _rDest);
 154
 155         /** translate SfxItems into properties of an UNO data source
 156             @param  _rSource
 157                 The item set to read from.
 158             @param  _rxDest
 159                 The data source to fill.
 160         */
 161         void translateProperties(
 162                 const SfxItemSet& _rSource,
 163                 const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxDest);
 164
 165         sal_Bool saveChanges(const SfxItemSet& _rSource);
 166     protected:
 167         /** fill a data source info array with the settings from a given item set
 168         */
 169         void fillDatasourceInfo(const SfxItemSet& _rSource, ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& _rInfo);
 170
 171         /// translate the given value into an SfxPoolItem, put this into the given set under the given id
 172         void        implTranslateProperty(SfxItemSet& _rSet, sal_Int32  _nId, const ::com::sun::star::uno::Any& _rValue);
 173
 174         /// translate the given SfxPoolItem into an <type scope="com.sun.star.Any">uno</type>
 175         ::com::sun::star::uno::Any implTranslateProperty(const SfxPoolItem* _pItem);
 176
 177         /// translate the given SfxPoolItem into an <type scope="com.sun.star.Any">uno</type>, set it (under the given name) on the given property set
 178         void        implTranslateProperty(const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxSet, const ::rtl::OUString& _rName, const SfxPoolItem* _pItem);
 179
 180         /** check if the data source described by the given set needs authentication<p/>
 181             The return value depends on the data source type only.
 182         */
 183         sal_Bool            hasAuthentication(const SfxItemSet& _rSet) const;
 184
 185 #if OSL_DEBUG_LEVEL > 0
 186         ::rtl::OString translatePropertyId( sal_Int32 _nId );
 187 #endif
 188     };
 189
 190 //.........................................................................
 191 }   // namespace dbaui
 192 //.........................................................................
 193
 194 #endif // _DBAUI_DBADMINIMPL_HXX_
 195
 196 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */