    /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
    /*
     * This file is part of the LibreOffice project.
     *
     * 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/.
     *
     * This file incorporates work covered by the following license notice:
     *
     *   Licensed to the Apache Software Foundation (ASF) under one or more
     *   contributor license agreements. See the NOTICE file distributed
     *   with this work for additional information regarding copyright
     *   ownership. The ASF licenses this file to you under the Apache
     *   License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 .
     */

    #include <sal/config.h>

    #include <memory>

    #include "advancedsettings.hxx"
    #include <advancedsettingsdlg.hxx>
    #include <dsitems.hxx>
    #include "DbAdminImpl.hxx"
    #include "DriverSettings.hxx"
    #include "optionalboolitem.hxx"
    #include <dbu_pageids.hxx>
    #include <dbu_dlg.hxx>

    #include <svl/eitem.hxx>
    #include <svl/intitem.hxx>
    #include <svl/stritem.hxx>

    namespace dbaui
    {

        using ::com::sun::star::uno::Reference;
        using ::com::sun::star::uno::Any;
        using ::com::sun::star::uno::XComponentContext;
        using ::com::sun::star::beans::XPropertySet;
        using ::com::sun::star::sdbc::XConnection;
        using ::com::sun::star::sdbc::XDriver;

        // SpecialSettingsPage
        struct BooleanSettingDesc
        {
            VclPtr<CheckBox>* ppControl;    // the dialog's control which displays this setting
            OString     sControlId;         // the widget name of the control in the .ui
            sal_uInt16  nItemId;            // the ID of the item (in an SfxItemSet) which corresponds to this setting
            bool        bInvertedDisplay;   // true if and only if the checkbox is checked when the item is sal_False, and vice versa
        };

        // SpecialSettingsPage
        SpecialSettingsPage::SpecialSettingsPage( vcl::Window* pParent, const SfxItemSet& _rCoreAttrs, const DataSourceMetaData& _rDSMeta )
            : OGenericAdministrationPage(pParent, "SpecialSettingsPage",
                "dbaccess/ui/specialsettingspage.ui", _rCoreAttrs)
            , m_pIsSQL92Check( nullptr )
            , m_pAppendTableAlias( nullptr )
            , m_pAsBeforeCorrelationName( nullptr )
            , m_pEnableOuterJoin( nullptr )
            , m_pIgnoreDriverPrivileges( nullptr )
            , m_pParameterSubstitution( nullptr )
            , m_pSuppressVersionColumn( nullptr )
            , m_pCatalog( nullptr )
            , m_pSchema( nullptr )
            , m_pIndexAppendix( nullptr )
            , m_pDosLineEnds( nullptr )
            , m_pCheckRequiredFields( nullptr )
            , m_pIgnoreCurrency(nullptr)
            , m_pEscapeDateTime(nullptr)
            , m_pPrimaryKeySupport(nullptr)
            , m_pRespectDriverResultSetType(nullptr)
            , m_pBooleanComparisonModeLabel( nullptr )
            , m_pBooleanComparisonMode( nullptr )
            , m_pMaxRowScanLabel( nullptr )
            , m_pMaxRowScan( nullptr )
            , m_aControlDependencies()
            , m_aBooleanSettings()
            , m_bHasBooleanComparisonMode( _rDSMeta.getFeatureSet().has( DSID_BOOLEANCOMPARISON ) )
            , m_bHasMaxRowScan( _rDSMeta.getFeatureSet().has( DSID_MAX_ROW_SCAN ) )
        {
            impl_initBooleanSettings();

            const FeatureSet& rFeatures( _rDSMeta.getFeatureSet() );
            // create all the check boxes for the boolean settings
            for (auto const& booleanSetting : m_aBooleanSettings)
            {
                sal_uInt16 nItemId = booleanSetting.nItemId;
                if ( rFeatures.has( nItemId ) )
                {
                    get(*booleanSetting.ppControl, booleanSetting.sControlId);
                    (*booleanSetting.ppControl)->SetClickHdl( LINK(this, OGenericAdministrationPage, OnControlModifiedClick) );
                    (*booleanSetting.ppControl)->Show();

                    // check whether this must be a tristate check box
                    const SfxPoolItem& rItem = _rCoreAttrs.Get( nItemId );
                    if ( nullptr != dynamic_cast< const OptionalBoolItem* >(&rItem) )
                        (*booleanSetting.ppControl)->EnableTriState();
                }
            }

            if ( m_pAsBeforeCorrelationName && m_pAppendTableAlias )
                // make m_pAsBeforeCorrelationName depend on m_pAppendTableAlias
                m_aControlDependencies.enableOnCheckMark( *m_pAppendTableAlias, *m_pAsBeforeCorrelationName );

            // create the controls for the boolean comparison mode
            if ( m_bHasBooleanComparisonMode )
            {
                get(m_pBooleanComparisonModeLabel, "comparisonft");
                get(m_pBooleanComparisonMode, "comparison");
                m_pBooleanComparisonMode->SetDropDownLineCount( 4 );
                m_pBooleanComparisonMode->SetSelectHdl( LINK(this, SpecialSettingsPage, BooleanComparisonSelectHdl) );
                m_pBooleanComparisonModeLabel->Show();
                m_pBooleanComparisonMode->Show();
            }
            // create the controls for the max row scan
            if ( m_bHasMaxRowScan )
            {
                get(m_pMaxRowScanLabel, "rowsft");
                get(m_pMaxRowScan, "rows");
                m_pMaxRowScan->SetModifyHdl(LINK(this, OGenericAdministrationPage, OnControlEditModifyHdl));
                m_pMaxRowScan->SetUseThousandSep(false);
                m_pMaxRowScanLabel->Show();
                m_pMaxRowScan->Show();
            }
        }

        IMPL_LINK(SpecialSettingsPage, BooleanComparisonSelectHdl, ListBox&, rControl, void)
        {
            callModifiedHdl(&rControl);
        }

        SpecialSettingsPage::~SpecialSettingsPage()
        {
            disposeOnce();
        }

        void SpecialSettingsPage::dispose()
        {
            m_aControlDependencies.clear();
            m_pIsSQL92Check.clear();
            m_pAppendTableAlias.clear();
            m_pAsBeforeCorrelationName.clear();
            m_pEnableOuterJoin.clear();
            m_pIgnoreDriverPrivileges.clear();
            m_pParameterSubstitution.clear();
            m_pSuppressVersionColumn.clear();
            m_pCatalog.clear();
            m_pSchema.clear();
            m_pIndexAppendix.clear();
            m_pDosLineEnds.clear();
            m_pCheckRequiredFields.clear();
            m_pIgnoreCurrency.clear();
            m_pEscapeDateTime.clear();
            m_pPrimaryKeySupport.clear();
            m_pRespectDriverResultSetType.clear();
            m_pBooleanComparisonModeLabel.clear();
            m_pBooleanComparisonMode.clear();
            m_pMaxRowScanLabel.clear();
            m_pMaxRowScan.clear();
            OGenericAdministrationPage::dispose();
        }

        void SpecialSettingsPage::impl_initBooleanSettings()
        {
            OSL_PRECOND( m_aBooleanSettings.empty(), "SpecialSettingsPage::impl_initBooleanSettings: called twice!" );

            // for easier maintenance, write the table in this form, then copy it to m_aBooleanSettings
            BooleanSettingDesc aSettings[] = {
                { std::addressof(m_pIsSQL92Check),                 "usesql92",        DSID_SQL92CHECK,            false },
                { std::addressof(m_pAppendTableAlias),             "append",          DSID_APPEND_TABLE_ALIAS,    false },
                { std::addressof(m_pAsBeforeCorrelationName),      "useas",           DSID_AS_BEFORE_CORRNAME,    false },
                { std::addressof(m_pEnableOuterJoin),              "useoj",           DSID_ENABLEOUTERJOIN,       false },
                { std::addressof(m_pIgnoreDriverPrivileges),       "ignoreprivs",     DSID_IGNOREDRIVER_PRIV,     false },
                { std::addressof(m_pParameterSubstitution),        "replaceparams",   DSID_PARAMETERNAMESUBST,    false },
                { std::addressof(m_pSuppressVersionColumn),        "displayver",      DSID_SUPPRESSVERSIONCL,     true  },
                { std::addressof(m_pCatalog),                      "usecatalogname",  DSID_CATALOG,               false },
                { std::addressof(m_pSchema),                       "useschemaname",   DSID_SCHEMA,                false },
                { std::addressof(m_pIndexAppendix),                "createindex",     DSID_INDEXAPPENDIX,         false },
                { std::addressof(m_pDosLineEnds),                  "eol",             DSID_DOSLINEENDS,           false },
                { std::addressof(m_pCheckRequiredFields),          "ignorecurrency",  DSID_CHECK_REQUIRED_FIELDS, false },
                { std::addressof(m_pIgnoreCurrency),               "inputchecks",     DSID_IGNORECURRENCY,        false },
                { std::addressof(m_pEscapeDateTime),               "useodbcliterals", DSID_ESCAPE_DATETIME,       false },
                { std::addressof(m_pPrimaryKeySupport),            "primarykeys",     DSID_PRIMARY_KEY_SUPPORT,   false },
                { std::addressof(m_pRespectDriverResultSetType),   "resulttype",      DSID_RESPECTRESULTSETTYPE,  false }
            };

            for ( const BooleanSettingDesc& rDesc : aSettings )
            {
                m_aBooleanSettings.push_back( rDesc );
            }
        }

        void SpecialSettingsPage::fillWindows( std::vector< std::unique_ptr<ISaveValueWrapper> >& _rControlList )
        {
            if ( m_bHasBooleanComparisonMode )
            {
                _rControlList.emplace_back( new ODisableWrapper< FixedText >( m_pBooleanComparisonModeLabel ) );
            }
            if ( m_bHasMaxRowScan )
            {
                _rControlList.emplace_back( new ODisableWrapper< FixedText >( m_pMaxRowScanLabel ) );
            }
        }

        void SpecialSettingsPage::fillControls(std::vector< std::unique_ptr<ISaveValueWrapper> >& _rControlList)
        {
            for (auto const& booleanSetting : m_aBooleanSettings)
            {
                if ( *booleanSetting.ppControl )
                {
                    _rControlList.emplace_back( new OSaveValueWrapper< CheckBox >( *booleanSetting.ppControl ) );
                }
            }

            if ( m_bHasBooleanComparisonMode )
                _rControlList.emplace_back( new OSaveValueWrapper< ListBox >( m_pBooleanComparisonMode ) );
            if ( m_bHasMaxRowScan )
                _rControlList.emplace_back(new OSaveValueWrapper<NumericField>(m_pMaxRowScan));
        }

        void SpecialSettingsPage::implInitControls(const SfxItemSet& _rSet, bool _bSaveValue)
        {
            // check whether or not the selection is invalid or readonly (invalid implies readonly, but not vice versa)
            bool bValid, bReadonly;
            getFlags( _rSet, bValid, bReadonly );

            if ( !bValid )
            {
                OGenericAdministrationPage::implInitControls(_rSet, _bSaveValue);
                return;
            }

            // the boolean items
            for (auto const& booleanSetting : m_aBooleanSettings)
            {
                if ( !(*booleanSetting.ppControl) )
                    continue;

                ::boost::optional< bool > aValue(false);
                aValue.reset();

                const SfxPoolItem* pItem = _rSet.GetItem<SfxPoolItem>(booleanSetting.nItemId);
                if (const SfxBoolItem *pBoolItem = dynamic_cast<const SfxBoolItem*>( pItem) )
                {
                    aValue.reset( pBoolItem->GetValue() );
                }
                else if (const OptionalBoolItem *pOptionalItem = dynamic_cast<const OptionalBoolItem*>( pItem) )
                {
                    aValue = pOptionalItem->GetFullValue();
                }
                else
                    OSL_FAIL( "SpecialSettingsPage::implInitControls: unknown boolean item type!" );

                if ( !aValue )
                {
                    (*booleanSetting.ppControl)->SetState( TRISTATE_INDET );
                }
                else
                {
                    bool bValue = *aValue;
                    if ( booleanSetting.bInvertedDisplay )
                        bValue = !bValue;
                    (*booleanSetting.ppControl)->Check( bValue );
                }
            }

            // the non-boolean items
            if ( m_bHasBooleanComparisonMode )
            {
                const SfxInt32Item* pBooleanComparison = _rSet.GetItem<SfxInt32Item>(DSID_BOOLEANCOMPARISON);
                m_pBooleanComparisonMode->SelectEntryPos( static_cast< sal_uInt16 >( pBooleanComparison->GetValue() ) );
            }

            if ( m_bHasMaxRowScan )
            {
                const SfxInt32Item* pMaxRowScan = _rSet.GetItem<SfxInt32Item>(DSID_MAX_ROW_SCAN);
                m_pMaxRowScan->SetValue(pMaxRowScan->GetValue());
            }

            OGenericAdministrationPage::implInitControls(_rSet, _bSaveValue);
        }

        bool SpecialSettingsPage::FillItemSet( SfxItemSet* _rSet )
        {
            bool bChangedSomething = false;

            // the boolean items
            for (auto const& booleanSetting : m_aBooleanSettings)
            {
                if ( !*booleanSetting.ppControl )
                    continue;
                fillBool( *_rSet, *booleanSetting.ppControl, booleanSetting.nItemId, bChangedSomething, booleanSetting.bInvertedDisplay );
            }

            // the non-boolean items
            if ( m_bHasBooleanComparisonMode )
            {
                if ( m_pBooleanComparisonMode->IsValueChangedFromSaved() )
                {
                    _rSet->Put( SfxInt32Item( DSID_BOOLEANCOMPARISON, m_pBooleanComparisonMode->GetSelectedEntryPos() ) );
                    bChangedSomething = true;
                }
            }
            if ( m_bHasMaxRowScan )
            {
                fillInt32(*_rSet,m_pMaxRowScan,DSID_MAX_ROW_SCAN,bChangedSomething);
            }
            return bChangedSomething;
        }

        // GeneratedValuesPage
        GeneratedValuesPage::GeneratedValuesPage( vcl::Window* pParent, const SfxItemSet& _rCoreAttrs )
            : OGenericAdministrationPage(pParent, "GeneratedValuesPage",
                "dbaccess/ui/generatedvaluespage.ui", _rCoreAttrs)
        {
            get(m_pAutoFrame, "GeneratedValuesPage");
            get(m_pAutoRetrievingEnabled, "autoretrieve");
            get(m_pAutoIncrementLabel, "statementft");
            get(m_pAutoIncrement, "statement");
            get(m_pAutoRetrievingLabel, "queryft");
            get(m_pAutoRetrieving, "query");

            m_pAutoRetrievingEnabled->SetClickHdl( LINK(this, OGenericAdministrationPage, OnControlModifiedClick) );
            m_pAutoIncrement->SetModifyHdl( LINK(this, OGenericAdministrationPage, OnControlEditModifyHdl) );
            m_pAutoRetrieving->SetModifyHdl( LINK(this, OGenericAdministrationPage, OnControlEditModifyHdl) );

            m_aControlDependencies.enableOnCheckMark( *m_pAutoRetrievingEnabled,
                *m_pAutoIncrementLabel, *m_pAutoIncrement, *m_pAutoRetrievingLabel, *m_pAutoRetrieving );
        }

        GeneratedValuesPage::~GeneratedValuesPage()
        {
            disposeOnce();
        }

        void GeneratedValuesPage::dispose()
        {
            m_aControlDependencies.clear();
            m_pAutoFrame.clear();
            m_pAutoRetrievingEnabled.clear();
            m_pAutoIncrementLabel.clear();
            m_pAutoIncrement.clear();
            m_pAutoRetrievingLabel.clear();
            m_pAutoRetrieving.clear();
            OGenericAdministrationPage::dispose();
        }

        void GeneratedValuesPage::fillWindows( std::vector< std::unique_ptr<ISaveValueWrapper> >& _rControlList )
        {
            _rControlList.emplace_back( new ODisableWrapper< VclFrame >( m_pAutoFrame ) );
        }

        void GeneratedValuesPage::fillControls( std::vector< std::unique_ptr<ISaveValueWrapper> >& _rControlList )
        {
            _rControlList.emplace_back( new OSaveValueWrapper< CheckBox >( m_pAutoRetrievingEnabled ) );
            _rControlList.emplace_back( new OSaveValueWrapper< Edit >( m_pAutoIncrement ) );
            _rControlList.emplace_back( new OSaveValueWrapper< Edit >( m_pAutoRetrieving ) );
        }

        void GeneratedValuesPage::implInitControls( const SfxItemSet& _rSet, bool _bSaveValue )
        {
            // check whether or not the selection is invalid or readonly (invalid implies readonly, but not vice versa)
            bool bValid, bReadonly;
            getFlags(_rSet, bValid, bReadonly);

            // collect the items
            const SfxStringItem* pAutoIncrementItem = _rSet.GetItem<SfxStringItem>(DSID_AUTOINCREMENTVALUE);
            const SfxStringItem* pAutoRetrieveValueItem = _rSet.GetItem<SfxStringItem>(DSID_AUTORETRIEVEVALUE);
            const SfxBoolItem* pAutoRetrieveEnabledItem = _rSet.GetItem<SfxBoolItem>(DSID_AUTORETRIEVEENABLED);

            // forward the values to the controls
            if (bValid)
            {
                bool bEnabled = pAutoRetrieveEnabledItem->GetValue();
                m_pAutoRetrievingEnabled->Check( bEnabled );

                m_pAutoIncrement->SetText( pAutoIncrementItem->GetValue() );
                m_pAutoIncrement->ClearModifyFlag();
                m_pAutoRetrieving->SetText( pAutoRetrieveValueItem->GetValue() );
                m_pAutoRetrieving->ClearModifyFlag();
            }
            OGenericAdministrationPage::implInitControls( _rSet, _bSaveValue );
        }

        bool GeneratedValuesPage::FillItemSet(SfxItemSet* _rSet)
        {
            bool bChangedSomething = false;

            fillString( *_rSet, m_pAutoIncrement, DSID_AUTOINCREMENTVALUE, bChangedSomething );
            fillBool( *_rSet, m_pAutoRetrievingEnabled, DSID_AUTORETRIEVEENABLED, bChangedSomething );
            fillString( *_rSet, m_pAutoRetrieving, DSID_AUTORETRIEVEVALUE, bChangedSomething );

            return bChangedSomething;
        }

        // AdvancedSettingsDialog
        AdvancedSettingsDialog::AdvancedSettingsDialog( vcl::Window* _pParent, SfxItemSet* _pItems,
            const Reference< XComponentContext >& _rxContext, const Any& _aDataSourceName )
            : SfxTabDialog(_pParent, "AdvancedSettingsDialog",
                "dbaccess/ui/advancedsettingsdialog.ui", _pItems)
        {
            m_pImpl.reset(new ODbDataSourceAdministrationHelper(_rxContext,_pParent,this));
            m_pImpl->setDataSourceOrName(_aDataSourceName);
            Reference< XPropertySet > xDatasource = m_pImpl->getCurrentDataSource();
            m_pImpl->translateProperties(xDatasource, *_pItems);
            SetInputSet(_pItems);
            // propagate this set as our new input set and reset the example set
            delete m_pExampleSet;
            m_pExampleSet = new SfxItemSet(*GetInputSetImpl());

            const OUString eType = dbaui::ODbDataSourceAdministrationHelper::getDatasourceType(*_pItems);

            DataSourceMetaData aMeta( eType );
            const FeatureSet& rFeatures( aMeta.getFeatureSet() );

            // auto-generated values?
            if (rFeatures.supportsGeneratedValues())
                AddTabPage("generated", ODriversSettings::CreateGeneratedValuesPage, nullptr);
            else
                RemoveTabPage("generated");

            // any "special settings"?
            if (rFeatures.supportsAnySpecialSetting())
                AddTabPage("special", ODriversSettings::CreateSpecialSettingsPage, nullptr);
            else
                RemoveTabPage("special");

            // remove the reset button - it's meaning is much too ambiguous in this dialog
            RemoveResetButton();
        }

        AdvancedSettingsDialog::~AdvancedSettingsDialog()
        {
            disposeOnce();
        }

        void AdvancedSettingsDialog::dispose()
        {
            SetInputSet(nullptr);
            DELETEZ(m_pExampleSet);
            SfxTabDialog::dispose();
        }

        bool AdvancedSettingsDialog::doesHaveAnyAdvancedSettings( const OUString& _sURL )
        {
            DataSourceMetaData aMeta( _sURL );
            const FeatureSet& rFeatures( aMeta.getFeatureSet() );
            return rFeatures.supportsGeneratedValues() || rFeatures.supportsAnySpecialSetting();
        }

        short AdvancedSettingsDialog::Execute()
        {
            short nRet = SfxTabDialog::Execute();
            if ( nRet == RET_OK )
            {
                m_pExampleSet->Put(*GetOutputItemSet());
                m_pImpl->saveChanges(*m_pExampleSet);
            }
            return nRet;
        }

        void AdvancedSettingsDialog::PageCreated(sal_uInt16 _nId, SfxTabPage& _rPage)
        {
            // register ourself as modified listener
            static_cast<OGenericAdministrationPage&>(_rPage).SetServiceFactory( getORB() );
            static_cast<OGenericAdministrationPage&>(_rPage).SetAdminDialog(this,this);

            vcl::Window *pWin = GetViewWindow();
            if(pWin)
                pWin->Invalidate();

            SfxTabDialog::PageCreated(_nId, _rPage);
        }

        const SfxItemSet* AdvancedSettingsDialog::getOutputSet() const
        {
            return m_pExampleSet;
        }

        SfxItemSet* AdvancedSettingsDialog::getWriteOutputSet()
        {
            return m_pExampleSet;
        }

        std::pair< Reference< XConnection >, bool > AdvancedSettingsDialog::createConnection()
        {
            return m_pImpl->createConnection();
        }

        Reference< XComponentContext > AdvancedSettingsDialog::getORB() const
        {
            return m_pImpl->getORB();
        }

        Reference< XDriver > AdvancedSettingsDialog::getDriver()
        {
            return m_pImpl->getDriver();
        }

        OUString AdvancedSettingsDialog::getDatasourceType(const SfxItemSet& _rSet) const
        {
            return dbaui::ODbDataSourceAdministrationHelper::getDatasourceType(_rSet);
        }

        void AdvancedSettingsDialog::clearPassword()
        {
            m_pImpl->clearPassword();
        }

        void AdvancedSettingsDialog::setTitle(const OUString& _sTitle)
        {
            SetText(_sTitle);
        }

        void AdvancedSettingsDialog::enableConfirmSettings( bool ) {}

        void AdvancedSettingsDialog::saveDatasource()
        {
            PrepareLeaveCurrentPage();
        }

    } // namespace dbaui

    /* vim:set shiftwidth=4 softtabstop=4 expandtab: */

↑ V1023 A pointer without owner is added to the '_rControlList' container by the 'emplace_back' method. A memory leak will occur in case of an exception.

↑ V1023 A pointer without owner is added to the '_rControlList' container by the 'emplace_back' method. A memory leak will occur in case of an exception.

↑ V1023 A pointer without owner is added to the '_rControlList' container by the 'emplace_back' method. A memory leak will occur in case of an exception.

↑ V1023 A pointer without owner is added to the '_rControlList' container by the 'emplace_back' method. A memory leak will occur in case of an exception.

↑ V1023 A pointer without owner is added to the '_rControlList' container by the 'emplace_back' method. A memory leak will occur in case of an exception.

↑ V1023 A pointer without owner is added to the '_rControlList' container by the 'emplace_back' method. A memory leak will occur in case of an exception.

↑ V1023 A pointer without owner is added to the '_rControlList' container by the 'emplace_back' method. A memory leak will occur in case of an exception.

↑ V1023 A pointer without owner is added to the '_rControlList' container by the 'emplace_back' method. A memory leak will occur in case of an exception.

↑ V1023 A pointer without owner is added to the '_rControlList' container by the 'emplace_back' method. A memory leak will occur in case of an exception.