dbaccess/source/ui/app/AppController.hxx

   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 #pragma once
  21
  22 #include <AppElementType.hxx>
  23 #include <callbacks.hxx>
  24 #include <commontypes.hxx>
  25 #include <dsntypes.hxx>
  26 #include <dbaccess/genericcontroller.hxx>
  27 #include <linkeddocuments.hxx>
  28 #include <TableCopyHelper.hxx>
  29
  30 #include <com/sun/star/beans/XPropertyChangeListener.hpp>
  31 #include <com/sun/star/container/XContainerListener.hpp>
  32 #include <com/sun/star/sdb/application/XDatabaseDocumentUI.hpp>
  33 #include <com/sun/star/ui/XContextMenuInterception.hpp>
  34
  35 #include <comphelper/namedvaluecollection.hxx>
  36 #include <comphelper/uno3.hxx>
  37 #include <cppuhelper/implbase5.hxx>
  38 #include <comphelper/interfacecontainer2.hxx>
  39 #include <vcl/transfer.hxx>
  40 #include <svx/dataaccessdescriptor.hxx>
  41
  42 #include <memory>
  43
  44 class TransferableHelper;
  45 class TransferableClipboardListener;
  46
  47 namespace com::sun::star {
  48     namespace container {
  49         class XNameContainer;
  50         class XContainer;
  51     }
  52     namespace ucb {
  53         class XContent;
  54     }
  55 }
  56
  57 namespace svx
  58 {
  59     class OComponentTransferable;
  60 }
  61
  62 namespace weld
  63 {
  64     class TreeView;
  65 }
  66
  67 namespace dbaui
  68 {
  69     class ODataClipboard;
  70     class TreeListBox;
  71     class SubComponentManager;
  72     class OApplicationController;
  73     class OApplicationView;
  74     class OLinkedDocumentsAccess;
  75     class SelectionNotifier;
  76
  77     typedef ::cppu::ImplHelper5 <   css::container::XContainerListener
  78                                 ,   css::beans::XPropertyChangeListener
  79                                 ,   css::sdb::application::XDatabaseDocumentUI
  80                                 ,   css::ui::XContextMenuInterception
  81                                 ,   css::view::XSelectionSupplier
  82                                 >   OApplicationController_Base;
  83
  84
  85     class OApplicationController
  86             :public OGenericUnoController
  87             ,public OApplicationController_Base
  88             ,public IControlActionListener
  89             ,public IContextMenuProvider
  90     {
  91     public:
  92         typedef std::vector< css::uno::Reference< css::container::XContainer > >  TContainerVector;
  93
  94     private:
  95
  96         OTableCopyHelper::DropDescriptor            m_aAsyncDrop;
  97
  98         SharedConnection        m_xDataSourceConnection;
  99         css::uno::Reference< css::sdbc::XDatabaseMetaData >
 100                                 m_xMetaData;
 101
 102         TransferableDataHelper  m_aSystemClipboard;     // content of the clipboard
 103         css::uno::Reference< css::beans::XPropertySet >
 104                                 m_xDataSource;
 105         css::uno::Reference< css::frame::XModel >
 106                                 m_xModel;
 107         ::comphelper::OInterfaceContainerHelper2
 108                                 m_aContextMenuInterceptors;
 109
 110         TContainerVector        m_aCurrentContainers;       // the containers where we are listener on
 111         ::rtl::Reference< SubComponentManager >
 112                                 m_pSubComponentManager;
 113         ::dbaccess::ODsnTypeCollection
 114                                 m_aTypeCollection;
 115         OTableCopyHelper        m_aTableCopyHelper;
 116         rtl::Reference<TransferableClipboardListener>
 117                                 m_pClipboardNotifier;        // notifier for changes in the clipboard
 118         ImplSVEvent *           m_nAsyncDrop;
 119         OAsynchronousLink       m_aSelectContainerEvent;
 120         PreviewMode             m_ePreviewMode;             // the mode of the preview
 121         ElementType             m_eCurrentType;
 122         bool                    m_bNeedToReconnect;         // true when the settings of the data source were modified and the connection is no longer up to date
 123         bool                    m_bSuspended;               // is true when the controller was already suspended
 124
 125         std::unique_ptr< SelectionNotifier >
 126                                 m_pSelectionNotifier;
 127         typedef std::map< ElementType, std::vector< OUString > > SelectionByElementType;
 128         SelectionByElementType  m_aPendingSelection;
 129
 130     private:
 131
 132         OApplicationView*       getContainer() const;
 133
 134         /** returns the database name
 135             @return
 136                 the database name
 137         */
 138         OUString getDatabaseName() const;
 139
 140         /** return the element type for given container
 141             @param  _xContainer The container where the element type has to be found
 142             @return the element type corresponding to the given container
 143         */
 144         static ElementType getElementType(const css::uno::Reference< css::container::XContainer >& _xContainer);
 145
 146         /** opens a new sub frame with a table/query/form/report/view, passing additional arguments
 147         */
 148         css::uno::Reference< css::lang::XComponent > openElementWithArguments(
 149             const OUString& _sName,
 150             ElementType _eType,
 151             ElementOpenMode _eOpenMode,
 152             sal_uInt16 _nInstigatorCommand,
 153             const ::comphelper::NamedValueCollection& _rAdditionalArguments
 154         );
 155
 156         /** opens a new frame for creation or auto pilot
 157             @param  _eType
 158                 Defines the type to open
 159             @param  i_rAdditionalArguments
 160                 Additional arguments to pass when creating the component
 161         */
 162         css::uno::Reference< css::lang::XComponent >
 163             newElement(
 164                 ElementType _eType,
 165                 const ::comphelper::NamedValueCollection& i_rAdditionalArguments,
 166                 css::uno::Reference< css::lang::XComponent >& o_rDocumentDefinition
 167             );
 168
 169         /** creates a new database object, using an auto pilot
 170             @param _eType
 171                 Defines the type of the object to create
 172             @precond
 173                 Our mutex must not be locked.
 174             @since #i39203#
 175         */
 176         void newElementWithPilot( ElementType _eType );
 177
 178         /** converts the query to a view
 179             @param  _sName
 180                 The name of the query.
 181         */
 182         void convertToView(const OUString& _sName);
 183
 184         /** checks if the connection for the selected data source is read only. If the connection doesn't exist, <TRUE/> will be returned.
 185             @return
 186                 <TRUE/> if read only or doesn't exist, otherwise <FALSE/>
 187         */
 188         bool isConnectionReadOnly() const;
 189
 190         /// fills the list with the selected entries.
 191         void getSelectionElementNames( std::vector< OUString>& _rNames ) const;
 192
 193         /// deletes the entries selected.
 194         void deleteEntries();
 195
 196         /// renames the selected entry in the detail page
 197         void renameEntry();
 198
 199         /** deletes queries, forms, or reports
 200             @param  _eType
 201                 the type of the objects
 202             @param  _rList
 203                 The names of the elements to delete
 204             @param  _bConfirm
 205                 determines whether the user must confirm the deletion
 206         */
 207         void deleteObjects( ElementType _eType,
 208                             const std::vector< OUString>& _rList,
 209                             bool _bConfirm );
 210
 211         /** deletes tables.
 212             @param  _rList
 213                 The list of tables.
 214         */
 215         void deleteTables(const std::vector< OUString>& _rList);
 216
 217         /// copies the current object into clipboard
 218         rtl::Reference<TransferableHelper> copyObject();
 219
 220         /// fills rExchange with current object if it's a Table or Query
 221         bool copySQLObject(ODataClipboard& rExchange);
 222
 223         /// fills rExchange with current object if it's a Form or Report
 224         bool copyDocObject(svx::OComponentTransferable& rExchange);
 225
 226         /// returns the nameaccess
 227         css::uno::Reference< css::container::XNameAccess > getElements(ElementType _eType);
 228
 229         /** returns the document access for the specific type
 230             @param  _eType
 231                 the type
 232             @return std::unique_ptr<OLinkedDocumentsAccess>
 233         */
 234         std::unique_ptr<OLinkedDocumentsAccess> getDocumentsAccess(ElementType _eType);
 235
 236         /// returns the query definitions of the active data source.
 237         css::uno::Reference< css::container::XNameContainer> getQueryDefinitions() const;
 238
 239         /** pastes a special format from the system clipboard to the currently selected object types
 240             @param  _nFormatId
 241                 The format to be copied.
 242         */
 243         void pasteFormat(SotClipboardFormatId _nFormatId);
 244
 245         /** pastes a query, form or report into the data source
 246             @param  _eType
 247                 The type of the object to paste.
 248             @param  _rPasteData
 249                 The data descriptor.
 250             @param  _sParentFolder
 251                 The name of the parent folder if it exists.
 252             @param  _bMove
 253                 if <TRUE/> the name of the content must be inserted without any change, otherwise not.
 254             @return
 255                 <TRUE/> if the paste operations was successful, otherwise <FALSE/>.
 256         */
 257         bool paste( ElementType _eType, const svx::ODataAccessDescriptor& _rPasteData, const OUString& _sParentFolder = OUString(), bool _bMove = false);
 258
 259         /// returns the system clipboard.
 260         const TransferableDataHelper& getViewClipboard() const { return m_aSystemClipboard; }
 261
 262         /// returns <TRUE/> if the clipboard supports a table format, otherwise <FALSE/>.
 263         bool isTableFormat() const;
 264
 265         /** fills the vector with all supported formats
 266             @param  _eType
 267                 The type for which we need the formats
 268             @param  _rFormatIds
 269                 The vector to be filled up.
 270         */
 271         static void getSupportedFormats(ElementType _eType,std::vector<SotClipboardFormatId>& _rFormatIds);
 272
 273         /** adds a listener to the current name access.
 274             @param  _xCollection
 275                 The collection where we want to listen on.
 276         */
 277         void addContainerListener(const css::uno::Reference< css::container::XNameAccess>& _xCollection);
 278
 279         /** opens a uno dialog with the currently selected data source as initialize argument
 280             @param  _sServiceName
 281                 The service name of the dialog to be executed.
 282         */
 283         void openDialog(const OUString& _sServiceName);
 284
 285         /** when the settings of the data source changed,
 286             it opens a dialog which ask to close all depending documents, then recreate the connection.
 287             The SolarMutex has to be locked before calling this.
 288         */
 289         void askToReconnect();
 290
 291         /** remember a newly opened sub document for later access
 292         */
 293         void onDocumentOpened(
 294             const OUString&  _rName,
 295             const sal_Int32         _nType,
 296             const ElementOpenMode   _eMode,
 297             const css::uno::Reference< css::lang::XComponent >& _xDocument,
 298             const css::uno::Reference< css::lang::XComponent >& _xDefinition
 299         );
 300
 301         /** Inserts a new object into the hierarchy given be the type.
 302             @param  _eType
 303                 Where to insert the new item.
 304             @param  _sParentFolder
 305                 The name of the parent folder if it exists.
 306             @param  _xContent
 307                 The content to insert.
 308             @param  _bMove
 309                 if <TRUE/> the name of the content must be inserted without any change, otherwise not.
 310             @return
 311                 <TRUE/> if the insert operations was successful, otherwise <FALSE/>.
 312         */
 313         bool insertHierarchyElement(  ElementType _eType
 314                                     ,const OUString& _sParentFolder
 315                                     ,bool _bCollection = true
 316                                     ,const css::uno::Reference< css::ucb::XContent>& _xContent = css::uno::Reference< css::ucb::XContent>()
 317                                     ,bool _bMove = false);
 318         /** checks if delete command or rename command is allowed
 319             @param  _eType
 320                 The element type.
 321             @param  _bDelete
 322                 If <TRUE> then the delete command should be checked.
 323             @return
 324                 <TRUE> if the command is allowed
 325         */
 326         bool isRenameDeleteAllowed(ElementType _eType, bool _bDelete) const;
 327         /** all selected entries will be opened, or edited, or converted to a view
 328             @param  _nId
 329                 The slot which should be executed.
 330             @param  _eOpenMode
 331                 Defines the mode of opening. @see ElementOpenMode
 332         */
 333         void doAction(sal_uInt16 _nId, ElementOpenMode _eOpenMode);
 334
 335         /** returns the currently selected table or query name.
 336         *
 337         * \return the name of the currently table or query. If the tables or query container is selected otherwise an empty string will be returned.
 338         */
 339         OUString getCurrentlySelectedName(sal_Int32& _rnCommandType) const;
 340
 341         /** shows the preview for the given entry
 342         */
 343         void showPreviewFor( const ElementType _eType,const OUString& _sName );
 344
 345         /** called we were attached to a frame
 346
 347             In particular, this is called *after* the controller has been announced to the model
 348             (XModel::connectController)
 349         */
 350         void onAttachedFrame();
 351
 352         /// determines whether the given table name denotes a view which can be altered
 353         bool    impl_isAlterableView_nothrow( const OUString& _rTableOrViewName ) const;
 354
 355         /** verifies the object type denotes a valid DatabaseObject, and the object name denotes an existing
 356             object of this type. Throws if not.
 357         */
 358         void    impl_validateObjectTypeAndName_throw( const sal_Int32 _nObjectType, const ::std::optional< OUString >& i_rObjectName );
 359
 360     protected:
 361         // initializing members
 362
 363         // state of a feature. 'feature' may be the handle of a css::util::URL somebody requested a dispatch interface for OR a toolbar slot.
 364         virtual FeatureState    GetState(sal_uInt16 nId) const override;
 365         // execute a feature
 366         virtual void            Execute(sal_uInt16 nId, const css::uno::Sequence< css::beans::PropertyValue>& aArgs) override;
 367
 368         // OGenericUnoController
 369         virtual void            onLoadedMenu( const css::uno::Reference< css::frame::XLayoutManager >& _xLayoutManager ) override;
 370
 371         virtual css::uno::Reference< css::frame::XModel > getPrivateModel() const override
 372         {
 373             return m_xModel;
 374         }
 375
 376         virtual ~OApplicationController() override;
 377
 378     public:
 379         explicit OApplicationController(const css::uno::Reference< css::uno::XComponentContext >& _rxORB);
 380
 381         DECLARE_XINTERFACE( )
 382         DECLARE_XTYPEPROVIDER( )
 383
 384         // XServiceInfo
 385         virtual OUString SAL_CALL getImplementationName() override;
 386         virtual css::uno::Sequence< OUString> SAL_CALL getSupportedServiceNames() override;
 387
 388         // css::frame::XController
 389         virtual void SAL_CALL attachFrame(const css::uno::Reference< css::frame::XFrame > & xFrame) override;
 390         virtual sal_Bool SAL_CALL suspend(sal_Bool bSuspend) override;
 391         virtual sal_Bool SAL_CALL attachModel(const css::uno::Reference< css::frame::XModel > & xModel) override;
 392         virtual css::uno::Reference< css::frame::XModel >  SAL_CALL getModel() override;
 393
 394         // css::container::XContainerListener
 395         virtual void SAL_CALL elementInserted(const css::container::ContainerEvent& Event) override;
 396         virtual void SAL_CALL elementRemoved(const css::container::ContainerEvent& Event) override;
 397         virtual void SAL_CALL elementReplaced(const css::container::ContainerEvent& Event) override;
 398
 399         // XPropertyChangeListener
 400         virtual void SAL_CALL propertyChange( const css::beans::PropertyChangeEvent& evt ) override;
 401
 402         // XDatabaseDocumentUI
 403         virtual css::uno::Reference< css::sdbc::XDataSource > SAL_CALL getDataSource() override;
 404         virtual css::uno::Reference< css::awt::XWindow > SAL_CALL getApplicationMainWindow() override;
 405         virtual css::uno::Reference< css::sdbc::XConnection > SAL_CALL getActiveConnection() override;
 406         virtual css::uno::Sequence< css::uno::Reference< css::lang::XComponent > > SAL_CALL getSubComponents() override;
 407         virtual sal_Bool SAL_CALL isConnected(  ) override;
 408         // DO NOT CALL with getMutex() held!!
 409         virtual void SAL_CALL connect(  ) override;
 410         virtual css::beans::Pair< ::sal_Int32, OUString > SAL_CALL identifySubComponent( const css::uno::Reference< css::lang::XComponent >& SubComponent ) override;
 411         virtual sal_Bool SAL_CALL closeSubComponents(  ) override;
 412         virtual css::uno::Reference< css::lang::XComponent > SAL_CALL loadComponent( ::sal_Int32 ObjectType, const OUString& ObjectName, sal_Bool ForEditing ) override;
 413         virtual css::uno::Reference< css::lang::XComponent > SAL_CALL loadComponentWithArguments( ::sal_Int32 ObjectType, const OUString& ObjectName, sal_Bool ForEditing, const css::uno::Sequence< css::beans::PropertyValue >& Arguments ) override;
 414         virtual css::uno::Reference< css::lang::XComponent > SAL_CALL createComponent( ::sal_Int32 ObjectType, css::uno::Reference< css::lang::XComponent >& o_DocumentDefinition ) override;
 415         virtual css::uno::Reference< css::lang::XComponent > SAL_CALL createComponentWithArguments( ::sal_Int32 ObjectType, const css::uno::Sequence< css::beans::PropertyValue >& Arguments, css::uno::Reference< css::lang::XComponent >& o_DocumentDefinition ) override;
 416
 417         // XContextMenuInterception
 418         virtual void SAL_CALL registerContextMenuInterceptor( const css::uno::Reference< css::ui::XContextMenuInterceptor >& Interceptor ) override;
 419         virtual void SAL_CALL releaseContextMenuInterceptor( const css::uno::Reference< css::ui::XContextMenuInterceptor >& Interceptor ) override;
 420
 421         // XSelectionSupplier
 422         virtual sal_Bool SAL_CALL select( const css::uno::Any& xSelection ) override;
 423         virtual css::uno::Any SAL_CALL getSelection(  ) override;
 424         virtual void SAL_CALL addSelectionChangeListener( const css::uno::Reference< css::view::XSelectionChangeListener >& xListener ) override;
 425         virtual void SAL_CALL removeSelectionChangeListener( const css::uno::Reference< css::view::XSelectionChangeListener >& xListener ) override;
 426
 427         /** retrieves the current connection, creates it if necessary
 428
 429             If an error occurs, then this is either stored in the location pointed to by <arg>_pErrorInfo</arg>,
 430             or, if <code>_pErrorInfo</code> is <NULL/>, then the error is displayed to the user.
 431
 432             DO NOT CALL with getMutex() held!!
 433         */
 434         const SharedConnection& ensureConnection( ::dbtools::SQLExceptionInfo* _pErrorInfo = nullptr );
 435
 436         /** retrieves the current connection
 437         */
 438         const SharedConnection& getConnection() const { return m_xDataSourceConnection; }
 439
 440         /// determines whether we're currently connected to the database
 441         bool isConnected() const { return m_xDataSourceConnection.is(); }
 442
 443         /** refreshes the tables
 444         */
 445         void refreshTables();
 446
 447         /** called when an entry in a tree list box has been double-clicked
 448             @param  _rTree
 449                 The tree list box.
 450             @return
 451                 <TRUE/> if the double click event has been handled by the called, and should not
 452                 be processed further.
 453         */
 454         bool onEntryDoubleClick(const weld::TreeView& rTree);
 455
 456         /** called when a container (category) in the application view has been selected
 457             @param  _pTree
 458                 The tree list box.
 459             @return
 460                 <TRUE/> if the container could be changed otherwise <FALSE/>
 461         */
 462         bool onContainerSelect(ElementType _eType);
 463
 464         /** called when an entry in a tree view has been selected
 465             @param  _pEntry
 466                 the selected entry
 467         */
 468         void onSelectionChanged();
 469
 470         /** called when a "Copy" command is executed in a tree view
 471         */
 472         void onCopyEntry();
 473
 474         /** called when a "Paste" command is executed in a tree view
 475         */
 476         void onPasteEntry();
 477
 478         /** called when a "Delete" command is executed in a tree view
 479         */
 480         void onDeleteEntry();
 481
 482         /// called when the preview mode was changed
 483         void previewChanged( sal_Int32 _nMode);
 484
 485         /// called when an object container of any kind was found during enumerating tree view elements
 486         void containerFound( const css::uno::Reference< css::container::XContainer >& _xContainer);
 487
 488         // IController
 489         virtual bool        isDataSourceReadOnly() const override;
 490
 491         // IControlActionListener overridables
 492         virtual bool        requestQuickHelp(const void* pUserData, OUString& rText) const override;
 493         virtual bool        requestDrag(const weld::TreeIter& rEntry) override;
 494         virtual sal_Int8    queryDrop( const AcceptDropEvent& _rEvt, const DataFlavorExVector& _rFlavors ) override;
 495         virtual sal_Int8    executeDrop( const ExecuteDropEvent& _rEvt ) override;
 496
 497         // IContextMenuProvider
 498         virtual OUString          getContextMenuResourceName() const override;
 499         virtual IController&      getCommandController() override;
 500         virtual ::comphelper::OInterfaceContainerHelper2*
 501                                 getContextMenuInterceptors() override;
 502         virtual css::uno::Any getCurrentSelection(weld::TreeView& rControl) const override;
 503         virtual vcl::Window* getMenuParent() const override;
 504         virtual void adjustMenuPosition(const weld::TreeView& rControl, ::Point& rPos) const override;
 505
 506         void OnInvalidateClipboard();
 507         DECL_LINK( OnClipboardChanged, TransferableDataHelper*, void );
 508         DECL_LINK( OnAsyncDrop, void*, void );
 509         DECL_LINK( OnCreateWithPilot, void*, void );
 510         DECL_LINK( OnSelectContainer, void*, void );
 511         void OnFirstControllerConnected();
 512
 513     protected:
 514         using OGenericUnoController::connect;
 515
 516         /** disconnects from our XConnection, and cleans up this connection
 517         */
 518         void        disconnect();
 519
 520         // late construction
 521         virtual bool        Construct(vcl::Window* pParent) override;
 522         virtual void        describeSupportedFeatures() override;
 523
 524     protected:
 525         // XEventListener
 526         virtual void SAL_CALL disposing(const css::lang::EventObject& Source) override;
 527
 528         // OComponentHelper
 529         virtual void SAL_CALL disposing() override;
 530     };
 531
 532 }   // namespace dbaui
 533
 534 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */