/************************************************************************* * * $RCSfile: dbadmin.hxx,v $ * * $Revision: 1.27 $ * * last change: $Author: fs $ $Date: 2001-10-24 10:30:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses * * - GNU Lesser General Public License Version 2.1 * - Sun Industry Standards Source License Version 1.1 * * Sun Microsystems Inc., October, 2000 * * GNU Lesser General Public License Version 2.1 * ============================================= * Copyright 2000 by Sun Microsystems, Inc. * 901 San Antonio Road, Palo Alto, CA 94303, USA * * 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 * * * Sun Industry Standards Source License Version 1.1 * ================================================= * The contents of this file are subject to the Sun Industry Standards * Source License Version 1.1 (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.openoffice.org/license.html. * * Software provided under this License is provided on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. * See the License for the specific provisions governing your rights and * obligations concerning the Software. * * The Initial Developer of the Original Code is: Sun Microsystems, Inc.. * * Copyright: 2000 by Sun Microsystems, Inc. * * All Rights Reserved. * * Contributor(s): _______________________________________ * * ************************************************************************/ #ifndef _DBAUI_DBADMIN_HXX_ #define _DBAUI_DBADMIN_HXX_ #ifndef _SFXTABDLG_HXX #include #endif #ifndef _SV_EDIT_HXX #include #endif //#ifndef _SV_BUTTON_HXX //#include //#endif #ifndef _COMPHELPER_STLTYPES_HXX_ #include #endif #ifndef _DBAUI_DSNTYPES_HXX_ #include "dsntypes.hxx" #endif #ifndef DBAUI_DATASOURCEMAP_HXX #include "datasourcemap.hxx" #endif #ifndef DBAUI_DATASOURCESELECTOR_HXX #include "datasourceselector.hxx" #endif #ifndef _COM_SUN_STAR_LANG_XMULTISERVICEFACTORY_HPP_ #include #endif #ifndef _COM_SUN_STAR_CONTAINER_XNAMEACCESS_HPP_ #include #endif #ifndef _COM_SUN_STAR_UNO_XNAMINGSERVICE_HPP_ #include #endif #ifndef _COM_SUN_STAR_BEANS_XPROPERTYSET_HPP_ #include #endif #ifndef _COM_SUN_STAR_BEANS_PROPERTYVALUE_HPP_ #include #endif #ifndef _COM_SUN_STAR_SDBC_XCONNECTION_HPP_ #include #endif #ifndef _COM_SUN_STAR_SDBC_XDRIVER_HPP_ #include #endif //......................................................................... namespace dbaui { //......................................................................... class ODsnTypeCollection; //========================================================================= //= ODbAdminDialog //========================================================================= class OGeneralPage; struct OPageSettings; /** tab dialog for administrating the office wide registered data sources */ class ODbAdminDialog : public SfxTabDialog { public: /** modes the dialog can be operated in */ enum OperationMode { omFull, // full administration of data sources omSingleEdit, // edit a single data source only omSingleEditFixedType // edit a single data source only, don't allow a type change }; private: ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory > m_xORB; /// service factory ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameAccess > m_xDatabaseContext; /// database context we're working in ::com::sun::star::uno::Reference< ::com::sun::star::uno::XNamingService > m_xDynamicContext; /// just another interface of the context ... ODatasourceMap m_aDatasources; typedef ::std::stack< sal_Int32 > PageStack; PageStack m_aCurrentDetailPages; // ids of all currently enabled (type-dependent) detail pages ::rtl::OUString m_sCurrentDatasource; /// name of the currently selected data source, empty if deleted typedef ::std::set< ::rtl::OUString > StringSet; typedef StringSet::const_iterator ConstStringSetIterator; StringSet m_aValidDatasources; /// names of all data sources except the currently selected one DECLARE_STL_MAP(sal_Int32, ::rtl::OUString, ::std::less< sal_Int32 >, MapInt2String); MapInt2String m_aDirectPropTranslator; /// translating property id's into names (direct properties of a data source) MapInt2String m_aIndirectPropTranslator; /// translating property id's into names (indirect properties of a data source) sal_Bool m_bResetting : 1; /// sal_True while we're resetting the pages sal_Bool m_bApplied : 1; /// sal_True if any changes have been applied while the dialog was executing sal_Bool m_bUIEnabled : 1; /// if the UI is enabled, false otherwise. Cannot be switched back to , once it is sal_Int32 m_nCurrentDeletedDataSource; sal_Int16 m_nPostApplyPage; // the page to be activated after an async apply operation const OPageSettings* m_pPostApplyPageSettings; // the page data to pass to this page OperationMode m_eMode; // the mode we're working in private: ODatasourceSelector m_aSelector; public: /** ctor. The itemset given should have been created by createItemSet and should be destroyed after the dialog has been destroyed */ ODbAdminDialog(Window* pParent, SfxItemSet* _pItems, const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rxORB); ~ODbAdminDialog(); // SfxTabDialog overridables virtual short Execute(); /** select a data source given by name

This method is used by the UNO wrapper for the dialog to set the initial selection.
If no data source with the given name exists, nothing is changed at all. */ void selectDataSource(const ::rtl::OUString& _rName); /** inserts a new data source with the given name.

The name must not already exist in the list of available, non-deleted data sources.

@return if the data source could not be inserted. Possible Reasons for this include:
  • the currently selected data source could not be deselected (because it's data as entered by the user is inconsistent)
  • the name given is invalid
*/ sal_Bool insertDataSource(const ::rtl::OUString& _rName); /// retrieves the current operation mode OperationMode getMode() const { return m_eMode; } /** sets a new operation mode

Must not be called if the dialog is beeind executed.

*/ void setMode(const OperationMode _eMode); /** create and return an item set for use with the dialog. @param _pTypeCollection pointer to an ODatasourceMap. May be NULL, in this case the pool will not contain a typecollection default. */ static SfxItemSet* createItemSet(SfxItemSet*& _rpSet, SfxItemPool*& _rpPool, SfxPoolItem**& _rppDefaults, ODsnTypeCollection* _pTypeCollection); /** destroy and item set / item pool / pool defaults previously created by createItemSet */ static void destroyItemSet(SfxItemSet*& _rpSet, SfxItemPool*& _rpPool, SfxPoolItem**& _rppDefaults); /** translate the current dialog SfxItems into driver relevant PropertyValues @see successfullyConnected */ sal_Bool getCurrentSettings(::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& _rDriverParams); /** to be called if the settings got from getCurrentSettings have been used for successfully connecting @see getCurrentSettings */ void successfullyConnected(); /// clear the password in the current data source's item set void clearPassword(); /// apply the current changes, return sal_True if successfull void applyChangesAsync(const OPageSettings* _pUseTheseSettings = NULL); /// return if in the current state, the changes can be saved (i.e. they produce no conflict) sal_Bool isApplyable() const; /// return if the currently selected data (if any) source is modified sal_Bool isCurrentModified() const; ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory > getORB() const { return m_xORB; } /** creates a new connection. The caller is responsible to dispose it !!!! */ ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection > createConnection(); /** return the corresponding driver for the selected URL */ ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XDriver > getDriver(); /** returns the data source the dialog is currently working with */ ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet > getCurrentDataSource(); protected: // adds a new detail page and remove all the old ones void addDetailPage(USHORT _nPageId,USHORT _nTextId,CreateTabPage pCreateFunc); // removes all detail pages void removeDetailPages(); virtual void PageCreated(USHORT _nId, SfxTabPage& _rPage); virtual short Ok(); protected: sal_Bool isUIEnabled() const { return m_bUIEnabled; } void disabledUI() { m_bUIEnabled = sal_False; } /// select a (scheduled-to-be-)deleted data source, given by it's access key void implSelectDeleted(sal_Int32 _nKey); /// select a datasource with a given name, adjust the item set accordingly, and everything like that .. void implSelectDatasource(const ::rtl::OUString& _rRegisteredName); /// reset the tag pages according to m_sCurrentDatasource and _rxDatasource void resetPages(const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxDatasource, sal_Bool _bDeleted); /** translate properties of an UNO data source into SfxItems */ void translateProperties( const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxSource, SfxItemSet& _rDest); /** translate SfxItems into properties of an UNO data source */ void translateProperties( const SfxItemSet& _rSource, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxDest); /** fill a data source info array with the settings from a given item set */ void fillDatasourceInfo(const SfxItemSet& _rSource, ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& _rInfo); /** get the property set for the data source with the given name */ ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet > getDatasource(const ::rtl::OUString& _rName); /** get a unique new datasource name */ ::rtl::OUString getUniqueName() const; /// translate the given value into an SfxPoolItem, put this into the given set under the given id void implTranslateProperty(SfxItemSet& _rSet, sal_Int32 _nId, const ::com::sun::star::uno::Any& _rValue); /// translate the given SfxPoolItem into an uno ::com::sun::star::uno::Any implTranslateProperty(const SfxPoolItem* _pItem); /// translate the given SfxPoolItem into an uno, set it (under the given name) on the given property set void implTranslateProperty(const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxSet, const ::rtl::OUString& _rName, const SfxPoolItem* _pItem); enum ApplyResult { AR_LEAVE_MODIFIED, // somthing was modified and has successfully been committed AR_LEAVE_UNCHANGED, // no changes were made AR_KEEP // don't leave the page (e.g. because an error occured) }; /** apply all changes made */ ApplyResult implApplyChanges(); /** extracts the connection type from the given set

The connection type is determined by the value of the DSN item, analyzed by the TypeCollection item. */ DATASOURCE_TYPE getDatasourceType(const SfxItemSet& _rSet) const; /** get a list of items relevant for the curently selected type.

The type is calculated from the DSN item in the given set.
The usual items such as DSN, NAME etc. are not returned, only the special ones not common to all types. */ const sal_Int32* getRelevantItems(const SfxItemSet& _rSet) const; /** check if the data source described by the given set needs authentication

The return value depends on the data source type only. */ sal_Bool hasAuthentication(const SfxItemSet& _rSet) const; /// prepares switching to another data source sal_Bool prepareSwitchDatasource(); /** checks if the name given can be used as name for a new data source

The method does not check if the name is empty for performance reasons: If so, is returned, though the name is not valid at all.

*/ sal_Bool isValidNewName(const ::rtl::OUString& _rName) const; /** inserts a new data source and selects it

no checks are made if the name is valid, or the currently selected data source can be left. This has to be done by the caller.

@return in case no new com.sun.star.sdb.DataSource could be created */ sal_Bool implInsertNew_noCheck(const ::rtl::OUString& _rName); #ifdef DBG_UTIL ::rtl::OString translatePropertyId( sal_Int32 _nId ); #endif private: DECL_LINK(OnDatasourceSelected, ListBox*); DECL_LINK(OnTypeSelected, OGeneralPage*); DECL_LINK(OnNameModified, OGeneralPage*); DECL_LINK(OnValidateName, OGeneralPage*); DECL_LINK(OnDatasourceModifed, SfxTabPage*); DECL_LINK(OnNewDatasource, Window*); DECL_LINK(OnDeleteDatasource, Window*); DECL_LINK(OnRestoreDatasource, Window*); DECL_LINK(OnApplyChanges, PushButton*); DECL_LINK(OnAsyncApplyChanges, void*); DECL_LINK(OnAsyncSelectDetailsPage, void*); String getConnectionURL() const; }; //......................................................................... } // namespace dbaui //......................................................................... #endif // _DBAUI_DBADMIN_HXX_ /************************************************************************* * history: * $Log: not supported by cvs2svn $ * Revision 1.26 2001/09/18 14:55:45 vg * #65293# changed to void type of function * * Revision 1.25 2001/09/11 15:08:49 fs * #91304# +isUIEnabled / disableUI * * Revision 1.24 2001/08/30 16:11:51 fs * #88427# +OnValidateName * * Revision 1.23 2001/08/14 14:08:55 fs * #86945# +getCurrentDataSource * * Revision 1.22 2001/07/31 15:58:55 fs * #88530# +omSingleEditFixedType * * Revision 1.21 2001/07/30 11:31:03 fs * #88530# changes to allow operating the dialog in a 'edit one single data source only' mode * * Revision 1.20 2001/06/25 16:03:39 fs * #88004# outsourced ODataSourceMap and ODataSourceSelector * * Revision 1.19 2001/06/20 07:04:10 oj * #88434# new method to get the driver * * Revision 1.18 2001/05/29 13:11:51 oj * #87149# addressbook ui impl * * Revision 1.17 2001/05/15 15:06:25 fs * #86991# +prepareSwitchDatasource * * Revision 1.16 2001/05/10 12:12:46 fs * #86223# remember view settings while applying (no matter if synchron or asynchronously * * Revision 1.15 2001/04/26 11:49:58 fs * file is alive, again - added support for data source associated bookmarks * * Revision 1.14 2001/03/29 07:44:46 fs * #84826# +clearPassword * * Revision 1.13 2001/03/27 06:59:28 oj * new method createConnection and export of ORB * * Revision 1.12 2001/03/13 10:21:25 fs * #84827# #84908# allow changes to be applied without re-initializing the page (which could lead to opening a connection) * * Revision 1.11 2001/02/20 13:15:59 fs * #84151# applyChanges -> applyChangesAsync / +OnAsyncapplyChanges * * Revision 1.10 2001/02/05 13:47:11 fs * #83430# +applyChanges / +isApplyable * * Revision 1.9 2000/11/30 08:33:51 fs * #80003# changed some sal_uInt16 to sal_Int32 (need some -1's) * * Revision 1.8 2000/11/28 13:49:41 fs * #80152# +ODatasourceSelector::count * * Revision 1.7 2000/11/28 11:45:46 oj * #80827# check dbroot if dbconfig failed * * Revision 1.6 2000/11/23 02:04:35 svesik * Remove stl/ from #include statement * * Revision 1.5 2000/11/10 17:36:50 fs * small bug fixes * * Revision 1.4 2000/10/31 08:03:33 fs * +selectDataSource - supporting an initial selecting when creating as service * * Revision 1.3 2000/10/30 08:00:23 fs * +getDatasourceType / +getRelevantItems / +hasAuthentication * * Revision 1.2 2000/10/26 07:33:19 fs * fillDatasourceInfo * * Revision 1.1 2000/10/25 12:49:01 fs * moved herein from ..\dlg * * Revision 1.7 2000/10/24 12:12:26 fs * ODatasourceMap::update takes a non-constant set (to reset the ORIGINALNAME item) * * Revision 1.6 2000/10/23 12:56:50 fs * added apply functionality * * Revision 1.5 2000/10/13 16:06:21 fs * implemented the usage if the 'Info' property of the data sources / allow key usage in the data source list * * Revision 1.4 2000/10/12 16:20:42 fs * new implementations ... still under construction * * Revision 1.3 2000/10/11 11:31:03 fs * new implementations - still under construction * * Revision 1.2 2000/10/09 12:39:29 fs * some (a lot of) new imlpementations - still under development * * Revision 1.1 2000/10/05 10:04:54 fs * initial checkin * * * Revision 1.0 20.09.00 13:09:03 fs ************************************************************************/