svx/source/form/databaselocationinput.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
  21 #include <svx/databaselocationinput.hxx>
  22 #include <svx/dialmgr.hxx>
  23
  24 #include <svx/strings.hrc>
  25
  26 #include <com/sun/star/ui/dialogs/TemplateDescription.hpp>
  27 #include <com/sun/star/container/XNameAccess.hpp>
  28 #include <com/sun/star/uno/XComponentContext.hpp>
  29
  30 #include <comphelper/namedvaluecollection.hxx>
  31 #include <rtl/ustrbuf.hxx>
  32 #include <sfx2/filedlghelper.hxx>
  33 #include <svl/filenotation.hxx>
  34 #include <svtools/inettbc.hxx>
  35 #include <tools/diagnose_ex.h>
  36 #include <unotools/confignode.hxx>
  37 #include <unotools/ucbhelper.hxx>
  38 #include <vcl/button.hxx>
  39 #include <vcl/svapp.hxx>
  40 #include <vcl/weld.hxx>
  41
  42 namespace svx
  43 {
  44     using ::com::sun::star::uno::Sequence;
  45     using ::com::sun::star::uno::Reference;
  46     using ::com::sun::star::uno::XComponentContext;
  47     using ::com::sun::star::container::XNameAccess;
  48     using ::com::sun::star::uno::UNO_QUERY_THROW;
  49     using ::com::sun::star::uno::Exception;
  50
  51     namespace TemplateDescription = ::com::sun::star::ui::dialogs::TemplateDescription;
  52
  53     class DatabaseLocationInputController_Impl
  54     {
  55     public:
  56         DatabaseLocationInputController_Impl(
  57             const Reference<XComponentContext>&     _rContext,
  58             URLBox& _rLocationInput,
  59             weld::Button& _rBrowseButton,
  60             weld::Window& _rDialog
  61         );
  62
  63         bool     prepareCommit();
  64         void     setURL( const OUString& _rURL );
  65         OUString getURL() const;
  66
  67     private:
  68         void     impl_initFilterProperties_nothrow();
  69         void     impl_onBrowseButtonClicked();
  70         OUString impl_getCurrentURL() const;
  71
  72         DECL_LINK( OnButtonAction, weld::Button&, void );
  73
  74     private:
  75         const Reference<XComponentContext>      m_xContext;
  76         URLBox& m_rLocationInput;
  77         weld::Window& m_rDialog;
  78         Sequence< OUString >             m_aFilterExtensions;
  79         OUString                         m_sFilterUIName;
  80         bool                                    m_bNeedExistenceCheck;
  81     };
  82
  83     DatabaseLocationInputController_Impl::DatabaseLocationInputController_Impl(const Reference<XComponentContext>& _rContext,
  84             URLBox& _rLocationInput, weld::Button& _rBrowseButton, weld::Window& _rDialog)
  85         :m_xContext( _rContext )
  86         ,m_rLocationInput( _rLocationInput )
  87         ,m_rDialog( _rDialog )
  88         ,m_aFilterExtensions()
  89         ,m_sFilterUIName()
  90         ,m_bNeedExistenceCheck( true )
  91     {
  92         impl_initFilterProperties_nothrow();
  93
  94         // forward the allowed extensions to the input control
  95         OUStringBuffer aExtensionList;
  96         for ( auto const & extension : std::as_const(m_aFilterExtensions) )
  97         {
  98             aExtensionList.append( extension );
  99             aExtensionList.append( ';' );
 100         }
 101         m_rLocationInput.SetFilter( aExtensionList.makeStringAndClear() );
 102         _rBrowseButton.connect_clicked(LINK(this, DatabaseLocationInputController_Impl, OnButtonAction));
 103     }
 104
 105     bool DatabaseLocationInputController_Impl::prepareCommit()
 106     {
 107         OUString sURL( impl_getCurrentURL() );
 108         if ( sURL.isEmpty() )
 109             return false;
 110
 111         // check if the name exists
 112         if ( m_bNeedExistenceCheck )
 113         {
 114             if ( ::utl::UCBContentHelper::Exists( sURL ) )
 115             {
 116                 std::unique_ptr<weld::MessageDialog> xQueryBox(Application::CreateMessageDialog(m_rLocationInput.getWidget(),
 117                                                                VclMessageType::Question, VclButtonsType::YesNo,
 118                                                                SvxResId(RID_STR_ALREADYEXISTOVERWRITE)));
 119                 if (xQueryBox->run() != RET_YES)
 120                     return false;
 121             }
 122         }
 123
 124         return true;
 125     }
 126
 127     void DatabaseLocationInputController_Impl::setURL( const OUString& _rURL )
 128     {
 129         ::svt::OFileNotation aTransformer( _rURL );
 130         m_rLocationInput.set_entry_text( aTransformer.get( ::svt::OFileNotation::N_SYSTEM ) );
 131     }
 132
 133     OUString DatabaseLocationInputController_Impl::getURL() const
 134     {
 135         return impl_getCurrentURL();
 136     }
 137
 138     void DatabaseLocationInputController_Impl::impl_initFilterProperties_nothrow()
 139     {
 140         try
 141         {
 142             // get the name of the default filter for database documents
 143             ::utl::OConfigurationTreeRoot aConfig(
 144                 ::utl::OConfigurationTreeRoot::createWithComponentContext(
 145                     m_xContext,
 146                     "/org.openoffice.Setup/Office/Factories/com.sun.star.sdb.OfficeDatabaseDocument"
 147             ) );
 148             OUString sDatabaseFilter;
 149             OSL_VERIFY( aConfig.getNodeValue( "ooSetupFactoryActualFilter" ) >>= sDatabaseFilter );
 150
 151             // get the type this filter is responsible for
 152             Reference< XNameAccess > xFilterFactory(
 153                 m_xContext->getServiceManager()->createInstanceWithContext("com.sun.star.document.FilterFactory", m_xContext),
 154                 UNO_QUERY_THROW );
 155             ::comphelper::NamedValueCollection aFilterProperties( xFilterFactory->getByName( sDatabaseFilter ) );
 156             OUString sDocumentType = aFilterProperties.getOrDefault( "Type", OUString() );
 157
 158             // get the extension(s) for this type
 159             Reference< XNameAccess > xTypeDetection(
 160                 m_xContext->getServiceManager()->createInstanceWithContext("com.sun.star.document.TypeDetection", m_xContext),
 161                 UNO_QUERY_THROW );
 162
 163             ::comphelper::NamedValueCollection aTypeProperties( xTypeDetection->getByName( sDocumentType ) );
 164             m_aFilterExtensions = aTypeProperties.getOrDefault( "Extensions", m_aFilterExtensions );
 165             m_sFilterUIName = aTypeProperties.getOrDefault( "UIName", m_sFilterUIName );
 166         }
 167         catch( const Exception& )
 168         {
 169             DBG_UNHANDLED_EXCEPTION("svx");
 170         }
 171
 172         // ensure we have at least one extension
 173         OSL_ENSURE( m_aFilterExtensions.hasElements(),
 174             "DatabaseLocationInputController_Impl::impl_initFilterProperties_nothrow: unable to determine the file extension(s)!" );
 175         if ( !m_aFilterExtensions.hasElements() )
 176         {
 177             m_aFilterExtensions.realloc(1);
 178             m_aFilterExtensions[0] = "*.odb";
 179         }
 180     }
 181
 182     IMPL_LINK_NOARG(DatabaseLocationInputController_Impl, OnButtonAction, weld::Button&, void)
 183     {
 184         impl_onBrowseButtonClicked();
 185     }
 186
 187     OUString DatabaseLocationInputController_Impl::impl_getCurrentURL() const
 188     {
 189         OUString sCurrentFile( m_rLocationInput.get_active_text() );
 190         if ( !sCurrentFile.isEmpty() )
 191         {
 192             ::svt::OFileNotation aCurrentFile( sCurrentFile );
 193             sCurrentFile = aCurrentFile.get( ::svt::OFileNotation::N_URL );
 194         }
 195         return sCurrentFile;
 196     }
 197
 198     void DatabaseLocationInputController_Impl::impl_onBrowseButtonClicked()
 199     {
 200         ::sfx2::FileDialogHelper aFileDlg(
 201             TemplateDescription::FILESAVE_AUTOEXTENSION,
 202             FileDialogFlags::NONE,
 203             &m_rDialog
 204         );
 205         aFileDlg.SetDisplayDirectory( impl_getCurrentURL() );
 206
 207         aFileDlg.AddFilter( m_sFilterUIName, "*." + m_aFilterExtensions[0] );
 208         aFileDlg.SetCurrentFilter( m_sFilterUIName );
 209
 210         if ( aFileDlg.Execute() == ERRCODE_NONE )
 211         {
 212             INetURLObject aURL( aFileDlg.GetPath() );
 213             if( aURL.GetProtocol() != INetProtocol::NotValid )
 214             {
 215                 ::svt::OFileNotation aFileNotation( aURL.GetMainURL( INetURLObject::DecodeMechanism::NONE ) );
 216                 m_rLocationInput.set_entry_text(aFileNotation.get(::svt::OFileNotation::N_SYSTEM));
 217                 m_rLocationInput.trigger_changed();
 218                 // the dialog already checked for the file's existence, so we don't need to, again
 219                 m_bNeedExistenceCheck = false;
 220             }
 221         }
 222     }
 223
 224     DatabaseLocationInputController::DatabaseLocationInputController( const Reference<XComponentContext>& _rContext,
 225             URLBox& _rLocationInput, weld::Button& _rBrowseButton, weld::Window& _rDialog )
 226         :m_pImpl( new DatabaseLocationInputController_Impl( _rContext, _rLocationInput, _rBrowseButton, _rDialog ) )
 227     {
 228     }
 229
 230     DatabaseLocationInputController::~DatabaseLocationInputController()
 231     {
 232     }
 233
 234     bool DatabaseLocationInputController::prepareCommit()
 235     {
 236         return m_pImpl->prepareCommit();
 237     }
 238
 239     void DatabaseLocationInputController::setURL( const OUString& _rURL )
 240     {
 241         m_pImpl->setURL( _rURL );
 242     }
 243
 244     OUString DatabaseLocationInputController::getURL() const
 245     {
 246         return m_pImpl->getURL();
 247     }
 248 }
 249
 250 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */