Vissarion Fisikopoulos
b75d3c0dd5
When editing an SQL query in SQL view it is important to keep the formating. To secure this this fix implements a warning dialogue that fires in the case a query is last saved in SQL view and the user tries to open it in Design view and when the user switches from SQL view to Design view since editing in Design view may canonicalize and rewrite the query thus destroying its formatting. This is related to tdf#42713 that impements something similar but for queries with comments. Note that after this fix the mechanism implemented for tdf#42713 is only kept for backward compatibility and could be removed in the future. Change-Id: I47f46d8953dc4b1e7326413d6f97ca35eeaa3a22 Reviewed-on: https://gerrit.libreoffice.org/c/core/+/208786 Reviewed-by: Vissarion Fisikopoulos <vfisikop@libreoffice.org> Tested-by: Jenkins
378 lines
17 KiB
C++
378 lines
17 KiB
C++
/* -*- 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 <databaseobjectview.hxx>
|
|
#include <strings.hxx>
|
|
#include <strings.hrc>
|
|
#include <query.hrc>
|
|
#include <core_resource.hxx>
|
|
#include <asyncmodaldialog.hxx>
|
|
|
|
#include <com/sun/star/lang/XSingleServiceFactory.hpp>
|
|
#include <com/sun/star/frame/TaskCreator.hpp>
|
|
#include <com/sun/star/frame/XFrame.hpp>
|
|
#include <com/sun/star/sdb/CommandType.hpp>
|
|
#include <com/sun/star/sdb/XQueriesSupplier.hpp>
|
|
#include <com/sun/star/sdb/application/XTableUIProvider.hpp>
|
|
#include <com/sun/star/beans/NamedValue.hpp>
|
|
#include <com/sun/star/beans/XPropertySet.hpp>
|
|
#include <com/sun/star/container/XNameAccess.hpp>
|
|
#include <com/sun/star/util/XCloseable.hpp>
|
|
|
|
#include <connectivity/dbtools.hxx>
|
|
#include <o3tl/test_info.hxx>
|
|
#include <osl/diagnose.h>
|
|
#include <toolkit/helper/vclunohelper.hxx>
|
|
#include <comphelper/diagnose_ex.hxx>
|
|
#include <utility>
|
|
#include <vcl/stdtext.hxx>
|
|
#include <vcl/svapp.hxx>
|
|
#include <vcl/vclenum.hxx>
|
|
#include <vcl/weld/MessageDialog.hxx>
|
|
#include <vcl/weld/Window.hxx>
|
|
#include <vcl/window.hxx>
|
|
|
|
namespace dbaui
|
|
{
|
|
|
|
using namespace ::com::sun::star::uno;
|
|
using namespace ::com::sun::star::sdbc;
|
|
using namespace ::com::sun::star::sdb;
|
|
using namespace ::com::sun::star::sdb::application;
|
|
using namespace ::com::sun::star::ui::dialogs;
|
|
using namespace ::com::sun::star::frame;
|
|
using namespace ::com::sun::star::lang;
|
|
using namespace ::com::sun::star::beans;
|
|
using namespace ::com::sun::star::awt;
|
|
|
|
// DatabaseObjectView
|
|
DatabaseObjectView::DatabaseObjectView( const Reference< XComponentContext >& _rxORB,
|
|
const Reference< XDatabaseDocumentUI >& _rxApplication,
|
|
const Reference< XFrame >& _rxParentFrame,
|
|
OUString _sComponentURL )
|
|
:m_xORB ( _rxORB )
|
|
,m_xParentFrame ( _rxParentFrame )
|
|
,m_xApplication ( _rxApplication )
|
|
,m_sComponentURL (std::move( _sComponentURL ))
|
|
{
|
|
OSL_ENSURE( m_xORB.is(), "DatabaseObjectView::DatabaseObjectView: invalid service factory!" );
|
|
OSL_ENSURE( m_xApplication.is(), "DatabaseObjectView::DatabaseObjectView: invalid connection!" );
|
|
}
|
|
|
|
Reference< XConnection > DatabaseObjectView::getConnection() const
|
|
{
|
|
Reference< XConnection > xConnection;
|
|
if ( m_xApplication.is() )
|
|
xConnection = m_xApplication->getActiveConnection();
|
|
return xConnection;
|
|
}
|
|
|
|
Reference< XComponent > DatabaseObjectView::createNew( const Reference< XDataSource >& _xDataSource, const ::comphelper::NamedValueCollection& i_rDispatchArgs )
|
|
{
|
|
return doCreateView( Any( _xDataSource ), OUString(), i_rDispatchArgs );
|
|
}
|
|
|
|
Reference< XComponent > DatabaseObjectView::openExisting( const Any& _rDataSource, const OUString& _rName,
|
|
const ::comphelper::NamedValueCollection& i_rDispatchArgs )
|
|
{
|
|
return doCreateView( _rDataSource, _rName, i_rDispatchArgs );
|
|
}
|
|
|
|
Reference< XComponent > DatabaseObjectView::doCreateView( const Any& _rDataSource, const OUString& _rObjectName,
|
|
const ::comphelper::NamedValueCollection& i_rCreationArgs )
|
|
{
|
|
::comphelper::NamedValueCollection aDispatchArgs;
|
|
|
|
aDispatchArgs.merge( i_rCreationArgs, false ); // false => do not overwrite
|
|
fillDispatchArgs( aDispatchArgs, _rDataSource, _rObjectName );
|
|
aDispatchArgs.merge( i_rCreationArgs, true ); // true => do overwrite
|
|
|
|
return doDispatch( aDispatchArgs );
|
|
}
|
|
|
|
Reference< XComponent > DatabaseObjectView::doDispatch( const ::comphelper::NamedValueCollection& i_rDispatchArgs )
|
|
{
|
|
Reference< XComponent > xReturn;
|
|
if ( m_xORB.is() )
|
|
{
|
|
const bool bWeCreateTheFrame = !m_xFrameLoader.is();
|
|
try
|
|
{
|
|
// if we have no externally provided frame, create one
|
|
if ( bWeCreateTheFrame )
|
|
{
|
|
Reference< XSingleServiceFactory > xFact = TaskCreator::create(m_xORB);
|
|
Sequence< Any > lArgs{ Any(NamedValue(u"ParentFrame"_ustr, Any(m_xParentFrame))),
|
|
Any(NamedValue(u"TopWindow"_ustr, Any(true))),
|
|
Any(NamedValue(u"SupportPersistentWindowState"_ustr,
|
|
Any(true))) };
|
|
|
|
m_xFrameLoader.set(xFact->createInstanceWithArguments(lArgs), UNO_QUERY_THROW);
|
|
|
|
// everything we load can be considered a "top level document", so set the respective bit at the window.
|
|
// This, amongst other things, triggers that the component in this task participates in the
|
|
// "ThisComponent"-game for the global application Basic.
|
|
const Reference< XFrame > xFrame( m_xFrameLoader, UNO_QUERY_THROW );
|
|
const Reference< XWindow > xFrameWindow( xFrame->getContainerWindow(), UNO_SET_THROW );
|
|
VclPtr<vcl::Window> pContainerWindow = VCLUnoHelper::GetWindow( xFrameWindow );
|
|
ENSURE_OR_THROW( pContainerWindow, "no implementation access to the frame's container window!" );
|
|
pContainerWindow->SetExtendedStyle( pContainerWindow->GetExtendedStyle() | WindowExtendedStyle::Document );
|
|
}
|
|
|
|
Reference< XComponentLoader > xFrameLoader( m_xFrameLoader, UNO_SET_THROW );
|
|
xReturn = xFrameLoader->loadComponentFromURL(
|
|
m_sComponentURL,
|
|
u"_self"_ustr,
|
|
0,
|
|
i_rDispatchArgs.getPropertyValues()
|
|
);
|
|
|
|
// close the frame if the user hit "Cancel" on the SQL-comments warning, see
|
|
// OQueryController::impl_reset
|
|
if ( !xReturn.is() && bWeCreateTheFrame && m_xFrameLoader.is() )
|
|
{
|
|
try
|
|
{
|
|
Reference< css::util::XCloseable > xCloseable( m_xFrameLoader, UNO_QUERY );
|
|
if ( xCloseable.is() )
|
|
xCloseable->close( true );
|
|
}
|
|
catch( const Exception& )
|
|
{
|
|
DBG_UNHANDLED_EXCEPTION("dbaccess");
|
|
}
|
|
m_xFrameLoader.clear();
|
|
}
|
|
}
|
|
catch( const Exception& )
|
|
{
|
|
DBG_UNHANDLED_EXCEPTION("dbaccess");
|
|
}
|
|
}
|
|
return xReturn;
|
|
}
|
|
|
|
void DatabaseObjectView::fillDispatchArgs(
|
|
::comphelper::NamedValueCollection& i_rDispatchArgs,
|
|
const Any& _aDataSource,
|
|
const OUString& /* _rName */
|
|
)
|
|
{
|
|
OUString sDataSource;
|
|
Reference<XDataSource> xDataSource;
|
|
if ( _aDataSource >>= sDataSource )
|
|
{
|
|
i_rDispatchArgs.put( PROPERTY_DATASOURCENAME, sDataSource );
|
|
}
|
|
else if ( _aDataSource >>= xDataSource )
|
|
{
|
|
i_rDispatchArgs.put( PROPERTY_DATASOURCE, xDataSource );
|
|
}
|
|
|
|
i_rDispatchArgs.put( PROPERTY_ACTIVE_CONNECTION, getConnection() );
|
|
}
|
|
|
|
// QueryDesigner
|
|
QueryDesigner::QueryDesigner( const Reference< XComponentContext >& _rxORB, const Reference< XDatabaseDocumentUI >& _rxApplication,
|
|
const Reference< XFrame >& _rxParentFrame, bool _bCreateView )
|
|
:DatabaseObjectView( _rxORB, _rxApplication, _rxParentFrame, _bCreateView ? URL_COMPONENT_VIEWDESIGN : URL_COMPONENT_QUERYDESIGN )
|
|
,m_nCommandType( _bCreateView ? CommandType::TABLE : CommandType::QUERY )
|
|
{
|
|
}
|
|
|
|
void QueryDesigner::fillDispatchArgs( ::comphelper::NamedValueCollection& i_rDispatchArgs, const Any& _aDataSource,
|
|
const OUString& _rObjectName )
|
|
{
|
|
DatabaseObjectView::fillDispatchArgs( i_rDispatchArgs, _aDataSource, _rObjectName );
|
|
|
|
const bool bIncludeQueryName = !_rObjectName.isEmpty();
|
|
const bool bGraphicalDesign = i_rDispatchArgs.getOrDefault( PROPERTY_GRAPHICAL_DESIGN, true );
|
|
const bool bEditViewAsSQLCommand = ( m_nCommandType == CommandType::TABLE ) && !bGraphicalDesign;
|
|
|
|
i_rDispatchArgs.put( PROPERTY_COMMAND_TYPE, m_nCommandType );
|
|
|
|
if ( bIncludeQueryName )
|
|
{
|
|
i_rDispatchArgs.put( PROPERTY_COMMAND, _rObjectName );
|
|
}
|
|
|
|
if ( bEditViewAsSQLCommand )
|
|
{
|
|
i_rDispatchArgs.put( PROPERTY_ESCAPE_PROCESSING, false );
|
|
}
|
|
}
|
|
|
|
Reference< XComponent > QueryDesigner::doCreateView( const Any& _rDataSource, const OUString& _rObjectName,
|
|
const ::comphelper::NamedValueCollection& i_rCreationArgs )
|
|
{
|
|
const bool bHeadingIntoDesignView = i_rCreationArgs.getOrDefault( PROPERTY_GRAPHICAL_DESIGN, true );
|
|
if ( m_nCommandType == CommandType::QUERY && !_rObjectName.isEmpty() && bHeadingIntoDesignView
|
|
&& !Application::IsHeadlessModeEnabled() && !o3tl::IsRunningUITest() )
|
|
{
|
|
try
|
|
{
|
|
Reference< XQueriesSupplier > xSupplier( getConnection(), UNO_QUERY );
|
|
Reference< css::container::XNameAccess > xQueries( xSupplier.is() ? xSupplier->getQueries() : Reference< css::container::XNameAccess >() );
|
|
Reference< XPropertySet > xQuery;
|
|
if ( xQueries.is() && xQueries->hasByName( _rObjectName ) )
|
|
xQueries->getByName( _rObjectName ) >>= xQuery;
|
|
|
|
Sequence< PropertyValue > aLayoutInformation;
|
|
if ( xQuery.is() )
|
|
xQuery->getPropertyValue( PROPERTY_LAYOUTINFORMATION ) >>= aLayoutInformation;
|
|
|
|
const ::comphelper::NamedValueCollection aSettings( aLayoutInformation );
|
|
const bool bLastEditedInSqlView = aSettings.getOrDefault( u"LastEditedInSqlView"_ustr, false );
|
|
|
|
if ( bLastEditedInSqlView )
|
|
{
|
|
OUString sMessage = DBA_RES( STR_QRY_FORMAT_WARNING_3CHOICES );
|
|
sMessage = sMessage.replaceFirst( "$object$", DBA_RES( RSC_QUERY_OBJECT_TYPE[ m_nCommandType ] ) );
|
|
|
|
const Reference< XFrame >& xParentFrame( getParentFrame() );
|
|
VclPtr<vcl::Window> pParentWindow = xParentFrame.is()
|
|
? VCLUnoHelper::GetWindow( xParentFrame->getContainerWindow() ) : nullptr;
|
|
weld::Window* pParent = pParentWindow ? pParentWindow->GetFrameWeld() : nullptr;
|
|
std::unique_ptr<weld::MessageDialog> xDlg(
|
|
Application::CreateMessageDialog(
|
|
pParent, VclMessageType::Warning,
|
|
VclButtonsType::NONE, sMessage ) );
|
|
xDlg->add_button( u"SQL View"_ustr, RET_NO );
|
|
xDlg->add_button( u"Continue"_ustr, RET_YES );
|
|
xDlg->add_button( GetStandardText( StandardButtonType::Cancel ), RET_CANCEL );
|
|
xDlg->set_default_response( RET_NO );
|
|
sal_uInt16 nResult = xDlg->run();
|
|
|
|
if ( nResult == RET_CANCEL )
|
|
return Reference< XComponent >();
|
|
|
|
// tell the controller we already show the warning, so it doesn't show it again in impl_reset()
|
|
// this should be removed in the future together with the comment specific warning
|
|
::comphelper::NamedValueCollection aForcedArgs( i_rCreationArgs );
|
|
aForcedArgs.put( PROPERTY_FORMAT_WARNING_SHOWN, true );
|
|
|
|
if ( nResult == RET_NO )
|
|
{
|
|
aForcedArgs.put( PROPERTY_GRAPHICAL_DESIGN, false );
|
|
}
|
|
return DatabaseObjectView::doCreateView( _rDataSource, _rObjectName, aForcedArgs );
|
|
}
|
|
}
|
|
catch ( const Exception& )
|
|
{
|
|
DBG_UNHANDLED_EXCEPTION( "dbaccess" );
|
|
}
|
|
}
|
|
|
|
return DatabaseObjectView::doCreateView( _rDataSource, _rObjectName, i_rCreationArgs );
|
|
}
|
|
|
|
// TableDesigner
|
|
TableDesigner::TableDesigner( const Reference< XComponentContext >& _rxORB, const Reference< XDatabaseDocumentUI >& _rxApplication, const Reference< XFrame >& _rxParentFrame )
|
|
:DatabaseObjectView( _rxORB, _rxApplication, _rxParentFrame, URL_COMPONENT_TABLEDESIGN )
|
|
{
|
|
}
|
|
|
|
void TableDesigner::fillDispatchArgs( ::comphelper::NamedValueCollection& i_rDispatchArgs, const Any& _aDataSource,
|
|
const OUString& _rObjectName )
|
|
{
|
|
DatabaseObjectView::fillDispatchArgs( i_rDispatchArgs, _aDataSource, _rObjectName );
|
|
|
|
if ( !_rObjectName.isEmpty() )
|
|
{
|
|
i_rDispatchArgs.put( PROPERTY_CURRENTTABLE, _rObjectName );
|
|
}
|
|
}
|
|
|
|
Reference< XComponent > TableDesigner::doCreateView( const Any& _rDataSource, const OUString& _rObjectName,
|
|
const ::comphelper::NamedValueCollection& i_rCreationArgs )
|
|
{
|
|
bool bIsNewDesign = _rObjectName.isEmpty();
|
|
|
|
// let's see whether the connection can provide a dedicated table designer
|
|
Reference< XInterface > xDesigner;
|
|
if ( !bIsNewDesign )
|
|
xDesigner = impl_getConnectionProvidedDesigner_nothrow( _rObjectName );
|
|
|
|
if ( !xDesigner.is() )
|
|
return DatabaseObjectView::doCreateView( _rDataSource, _rObjectName, i_rCreationArgs );
|
|
|
|
// try whether the designer is a dialog
|
|
Reference< XExecutableDialog > xDialog( xDesigner, UNO_QUERY_THROW );
|
|
try { AsyncDialogExecutor::executeModalDialogAsync( xDialog ); }
|
|
catch( const Exception& ) { DBG_UNHANDLED_EXCEPTION("dbaccess"); }
|
|
return nullptr;
|
|
}
|
|
|
|
Reference< XInterface > TableDesigner::impl_getConnectionProvidedDesigner_nothrow( const OUString& _rTableName )
|
|
{
|
|
Reference< XInterface > xDesigner;
|
|
try
|
|
{
|
|
Reference< XTableUIProvider > xTableUIProv( getConnection(), UNO_QUERY );
|
|
if ( xTableUIProv.is() )
|
|
xDesigner = xTableUIProv->getTableEditor( getApplicationUI(), _rTableName );
|
|
}
|
|
catch( const Exception& )
|
|
{
|
|
DBG_UNHANDLED_EXCEPTION("dbaccess");
|
|
}
|
|
return xDesigner;
|
|
}
|
|
|
|
// ResultSetBrowser
|
|
ResultSetBrowser::ResultSetBrowser( const Reference< XComponentContext >& _rxORB, const Reference< XDatabaseDocumentUI >& _rxApplication, const Reference< XFrame >& _rxParentFrame,
|
|
bool _bTable )
|
|
:DatabaseObjectView( _rxORB, _rxApplication, _rxParentFrame, URL_COMPONENT_DATASOURCEBROWSER )
|
|
,m_bTable(_bTable)
|
|
{
|
|
}
|
|
|
|
void ResultSetBrowser::fillDispatchArgs( ::comphelper::NamedValueCollection& i_rDispatchArgs, const Any& _aDataSource,
|
|
const OUString& _rQualifiedName)
|
|
{
|
|
DatabaseObjectView::fillDispatchArgs( i_rDispatchArgs, _aDataSource, _rQualifiedName );
|
|
OSL_ENSURE( !_rQualifiedName.isEmpty(),"A Table name must be set");
|
|
i_rDispatchArgs.put( PROPERTY_COMMAND, _rQualifiedName );
|
|
i_rDispatchArgs.put( PROPERTY_ENABLE_BROWSER, false );
|
|
|
|
if ( m_bTable )
|
|
{
|
|
OUString sCatalog;
|
|
OUString sSchema;
|
|
OUString sTable;
|
|
::dbtools::qualifiedNameComponents( getConnection()->getMetaData(), _rQualifiedName, sCatalog, sSchema, sTable, ::dbtools::EComposeRule::InDataManipulation );
|
|
i_rDispatchArgs.put( PROPERTY_UPDATE_CATALOGNAME, sCatalog );
|
|
i_rDispatchArgs.put( PROPERTY_UPDATE_SCHEMANAME, sSchema );
|
|
i_rDispatchArgs.put( PROPERTY_UPDATE_TABLENAME, sTable );
|
|
i_rDispatchArgs.put( PROPERTY_COMMAND_TYPE, CommandType::TABLE );
|
|
}
|
|
else
|
|
i_rDispatchArgs.put( PROPERTY_COMMAND_TYPE, CommandType::QUERY );
|
|
}
|
|
|
|
// RelationDesigner
|
|
RelationDesigner::RelationDesigner( const Reference< XComponentContext >& _rxORB, const Reference< XDatabaseDocumentUI >& _rxApplication, const Reference< XFrame >& _rxParentFrame )
|
|
:DatabaseObjectView( _rxORB, _rxApplication, _rxParentFrame, URL_COMPONENT_RELATIONDESIGN )
|
|
{
|
|
}
|
|
} // namespace dbaui
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|