sw/inc/dbmgr.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 #ifndef INCLUDED_SW_INC_DBMGR_HXX
  20 #define INCLUDED_SW_INC_DBMGR_HXX
  21
  22 #include <rtl/ustring.hxx>
  23 #include <tools/solar.h>
  24 #include <tools/long.hxx>
  25 #include <i18nlangtag/lang.h>
  26 #include <com/sun/star/util/Date.hpp>
  27 #include "swdllapi.h"
  28 #include "swdbdata.hxx"
  29 #include <com/sun/star/uno/Reference.h>
  30 #include <com/sun/star/uno/Sequence.hxx>
  31 #include <com/sun/star/lang/Locale.hpp>
  32 #include <com/sun/star/beans/PropertyValue.hpp>
  33
  34 #include <memory>
  35 #include <utility>
  36 #include <vector>
  37
  38 namespace com::sun::star{
  39     namespace sdbc{
  40         class XConnection;
  41         class XStatement;
  42         class XDataSource;
  43         class XResultSet;
  44     }
  45     namespace beans{
  46
  47         class XPropertySet;
  48     }
  49     namespace sdbcx{
  50         class XColumnsSupplier;
  51     }
  52     namespace util{
  53         class XNumberFormatter;
  54     }
  55     namespace mail{
  56         class XSmtpService;
  57     }
  58     namespace embed { class XStorage; }
  59     namespace frame { class XStorable; }
  60 }
  61 namespace svx {
  62     class ODataAccessDescriptor;
  63 }
  64
  65 struct SwDBFormatData
  66 {
  67     css::util::Date aNullDate;
  68     css::uno::Reference< css::util::XNumberFormatter> xFormatter;
  69     css::lang::Locale aLocale;
  70 };
  71
  72 namespace weld {
  73     class ComboBox;
  74     class Window;
  75 }
  76
  77 class SwView;
  78 class SwWrtShell;
  79 class ListBox;
  80 class SvNumberFormatter;
  81 class SwXMailMerge;
  82 class SwMailMergeConfigItem;
  83 class SwCalc;
  84 class INetURLObject;
  85 class SwDocShell;
  86
  87 enum DBManagerOptions
  88 {
  89     DBMGR_MERGE,             ///< Data records in fields.
  90     DBMGR_MERGE_PRINTER,     ///< Print mail merge.
  91     DBMGR_MERGE_EMAIL,       ///< Send mail merge as email.
  92     DBMGR_MERGE_FILE,        ///< Save mail merge as files.
  93     DBMGR_MERGE_SHELL        ///< Create merge doc and keep the doc shell.
  94 };
  95
  96 // Administration of (new) logical databases.
  97 enum class SwDBSelect
  98 {
  99     UNKNOWN, TABLE, QUERY
 100 };
 101
 102 struct SwDSParam : public SwDBData
 103 {
 104     css::util::Date  aNullDate;
 105
 106     css::uno::Reference<css::util::XNumberFormatter>    xFormatter;
 107     css::uno::Reference< css::sdbc::XConnection>       xConnection;
 108     css::uno::Reference< css::sdbc::XStatement>        xStatement;
 109     css::uno::Reference< css::sdbc::XResultSet>        xResultSet;
 110     css::uno::Sequence<  css::uno::Any >               aSelection;
 111     bool bScrollable;
 112     bool bEndOfDB;
 113     tools::Long nSelectionIndex;
 114
 115     SwDSParam(const SwDBData& rData) :
 116         SwDBData(rData),
 117         bScrollable(false),
 118         bEndOfDB(false),
 119         nSelectionIndex(0)
 120         {}
 121
 122     SwDSParam(const SwDBData& rData,
 123         css::uno::Reference< css::sdbc::XResultSet> xResSet,
 124         const css::uno::Sequence<  css::uno::Any >&   rSelection) :
 125         SwDBData(rData),
 126         xResultSet(std::move(xResSet)),
 127         aSelection(rSelection),
 128         bScrollable(true),
 129         bEndOfDB(false),
 130         nSelectionIndex(0)
 131         {}
 132
 133     bool HasValidRecord() const
 134         { return( !bEndOfDB && xResultSet.is() ); }
 135 };
 136
 137 typedef std::vector<std::unique_ptr<SwDSParam>> SwDSParams_t;
 138
 139 struct SwMergeDescriptor
 140 {
 141     const DBManagerOptions                              nMergeType;
 142     SwWrtShell&                                         rSh;
 143     const svx::ODataAccessDescriptor&                   rDescriptor;
 144
 145     /**
 146      * Create a single or multiple results
 147      *
 148      * This currently just affects FILE, as EMAIL is always
 149      * multiple and SHELL and PRINTER are always single.
 150      */
 151     bool                                                bCreateSingleFile;
 152
 153     /**
 154      * @defgroup save Export filter settings
 155      * @addtogroup save
 156      * @{ */
 157     OUString                                            sSaveToFilter;
 158     OUString                                            sSaveToFilterOptions;
 159     css::uno::Sequence< css::beans::PropertyValue >     aSaveToFilterData;
 160     /** @} */
 161
 162     /**
 163      * @defgroup file Mail merge as File settings
 164      * @addtogroup file
 165      * @{ */
 166
 167     /**
 168      * Basename incl. the path for the generated files.
 169      *
 170      * The final filename will be created by concatenating a number to prevent
 171      * overwriting an existing file and the extension based on the filter
 172      * settings.
 173      */
 174     OUString                                            sPrefix;
 175     /**
 176      * Use the sPrefix as the target filename also overwriting an existing
 177      * target file.
 178      *
 179      * Just used for the internal mail merge dialogs as mail merge never
 180      * overwrites existing files (see SwDBManager::ExecuteFormLetter).
 181      */
 182     bool                                                bPrefixIsFilename;
 183     /** @} */
 184
 185     /**
 186      * @defgroup email Mail merge as eMail settings
 187      * @addtogroup email
 188      * @{ */
 189     OUString                                            sSubject;
 190     OUString                                            sMailBody;
 191     OUString                                            sAttachmentName;
 192     css::uno::Sequence< OUString >                      aCopiesTo;
 193     css::uno::Sequence< OUString >                      aBlindCopiesTo;
 194     css::uno::Reference< css::mail::XSmtpService >      xSmtpServer;
 195     bool                                                bSendAsHTML;
 196     bool                                                bSendAsAttachment;
 197     /** @} */
 198
 199     /**
 200      * @addtogroup file email
 201      * @{ */
 202
 203     /** DB column to fetch EMail of Filename from
 204      */
 205     OUString                                            sDBcolumn;
 206
 207     /** DB column to fetch password
 208      */
 209     OUString                                            sDBPasswordColumn;
 210
 211     /** @} */
 212
 213     /**
 214      * @defgroup print Mail merge to Printer
 215      * @addtogroup print
 216      * @{ */
 217     css::uno::Sequence<  css::beans::PropertyValue >    aPrintOptions;
 218     /** @} */
 219
 220     SwMailMergeConfigItem*                              pMailMergeConfigItem;
 221
 222     SwMergeDescriptor( const DBManagerOptions nType,
 223                        SwWrtShell& rShell,
 224                        const svx::ODataAccessDescriptor& rDesc ) :
 225         nMergeType(nType),
 226         rSh(rShell),
 227         rDescriptor(rDesc),
 228         bCreateSingleFile( false ),
 229         bPrefixIsFilename( false ),
 230         bSendAsHTML( true ),
 231         bSendAsAttachment( false ),
 232         pMailMergeConfigItem( nullptr )
 233     {
 234         if( nType == DBMGR_MERGE_SHELL || nType == DBMGR_MERGE_PRINTER )
 235             bCreateSingleFile = true;
 236     }
 237 };
 238
 239 class SwDoc;
 240
 241 class SW_DLLPUBLIC SwDBManager
 242 {
 243     struct SwDBManager_Impl;
 244     class SAL_DLLPRIVATE ConnectionDisposedListener_Impl;
 245     class MailDispatcherListener_Impl;
 246
 247     enum class MergeStatus
 248     {
 249         Ok = 0, Cancel, Error
 250     };
 251
 252     MergeStatus     m_aMergeStatus;     ///< current / last merge status
 253     bool            m_bInitDBFields : 1;
 254     bool            m_bInMerge    : 1;    ///< merge process active
 255     bool            m_bMergeSilent : 1;   ///< suppress display of dialogs/boxes (used when called over API)
 256     SwDSParams_t    m_DataSourceParams;
 257     std::unique_ptr<SwDBManager_Impl>  m_pImpl;
 258     const SwXMailMerge* m_pMergeEvtSrc;   ///< != 0 if mail merge events are to be send
 259     /// Name of the embedded database that's included in the current document.
 260     OUString     m_sEmbeddedName;
 261
 262     /// Store last registrations to revoke or commit
 263     static std::vector<std::pair<SwDocShell*, OUString>> s_aUncommittedRegistrations;
 264
 265     /// Not used connections.
 266     std::vector<OUString> m_aNotUsedConnections;
 267
 268     /// Set connection as used.
 269     void SetAsUsed(const OUString& rName);
 270
 271     /// The document that owns this manager.
 272     SwDoc* m_pDoc;
 273
 274     SAL_DLLPRIVATE SwDSParam*          FindDSData(const SwDBData& rData, bool bCreate);
 275     SAL_DLLPRIVATE SwDSParam*          FindDSConnection(const OUString& rSource, bool bCreate);
 276
 277     /// Insert data record as text into document.
 278     SAL_DLLPRIVATE void ImportFromConnection( SwWrtShell* pSh);
 279
 280     /// Insert a single data record as text into document.
 281     SAL_DLLPRIVATE void ImportDBEntry(SwWrtShell* pSh);
 282
 283     /// Run the mail merge for defined modes, except DBMGR_MERGE
 284     SAL_DLLPRIVATE bool MergeMailFiles( SwWrtShell* pSh,
 285                                         const SwMergeDescriptor& rMergeDescriptor );
 286
 287     SAL_DLLPRIVATE bool ToNextMergeRecord();
 288     SAL_DLLPRIVATE bool IsValidMergeRecord() const;
 289     SAL_DLLPRIVATE void ImplDestroy();
 290
 291     SwDBManager(SwDBManager const&) = delete;
 292     SwDBManager& operator=(SwDBManager const&) = delete;
 293
 294 public:
 295     SwDBManager(SwDoc* pDoc);
 296     ~SwDBManager();
 297
 298     /// MailMergeEvent source
 299     const SwXMailMerge *    GetMailMergeEvtSrc() const  { return m_pMergeEvtSrc; }
 300     void SetMailMergeEvtSrc( const SwXMailMerge *pSrc ) { m_pMergeEvtSrc = pSrc; }
 301
 302     bool     IsMergeSilent() const           { return m_bMergeSilent; }
 303     void     SetMergeSilent( bool bVal )     { m_bMergeSilent = bVal; }
 304
 305     /// Merging of data records into fields.
 306     bool            Merge( const SwMergeDescriptor& rMergeDesc );
 307     void            MergeCancel();
 308
 309     bool     IsMergeOk() const     { return MergeStatus::Ok     == m_aMergeStatus; }
 310     bool     IsMergeError() const  { return MergeStatus::Error  <= m_aMergeStatus; }
 311
 312     static std::shared_ptr<SwMailMergeConfigItem> PerformMailMerge(SwView const * pView);
 313
 314     /// Initialize data fields that lack name of database.
 315     bool     IsInitDBFields() const  { return m_bInitDBFields; }
 316     void     SetInitDBFields(bool b) { m_bInitDBFields = b;    }
 317
 318     /// Fill listbox with all table names of a database.
 319     bool            GetTableNames(weld::ComboBox& rBox, const OUString& rDBName);
 320
 321     /// Fill listbox with all column names of a database table.
 322     void            GetColumnNames(weld::ComboBox& rBox,
 323                             const OUString& rDBName, const OUString& rTableName);
 324     static void GetColumnNames(weld::ComboBox& rBox,
 325                             css::uno::Reference< css::sdbc::XConnection> const & xConnection,
 326                             const OUString& rTableName);
 327
 328     static sal_uLong GetColumnFormat( css::uno::Reference< css::sdbc::XDataSource> const & xSource,
 329                             css::uno::Reference< css::sdbc::XConnection> const & xConnection,
 330                             css::uno::Reference< css::beans::XPropertySet> const & xColumn,
 331                             SvNumberFormatter* pNFormatr,
 332                             LanguageType nLanguage );
 333
 334     sal_uLong GetColumnFormat( const OUString& rDBName,
 335                             const OUString& rTableName,
 336                             const OUString& rColNm,
 337                             SvNumberFormatter* pNFormatr,
 338                             LanguageType nLanguage );
 339     sal_Int32 GetColumnType( const OUString& rDBName,
 340                           const OUString& rTableName,
 341                           const OUString& rColNm );
 342
 343     bool     IsInMerge() const   { return m_bInMerge; }
 344
 345     void            ExecuteFormLetter(SwWrtShell& rSh,
 346                         const css::uno::Sequence< css::beans::PropertyValue>& rProperties);
 347
 348     static void     InsertText(SwWrtShell& rSh,
 349                         const css::uno::Sequence< css::beans::PropertyValue>& rProperties);
 350
 351     /// check if a data source is open
 352     bool            IsDataSourceOpen(const OUString& rDataSource,
 353                                     const OUString& rTableOrQuery, bool bMergeShell);
 354
 355     /// open the source while fields are updated - for the calculator only!
 356     bool            OpenDataSource(const OUString& rDataSource, const OUString& rTableOrQuery);
 357     sal_uInt32      GetSelectedRecordId(const OUString& rDataSource, const OUString& rTableOrQuery, sal_Int32 nCommandType = -1);
 358     bool            GetColumnCnt(const OUString& rSourceName, const OUString& rTableName,
 359                             const OUString& rColumnName, sal_uInt32 nAbsRecordId, LanguageType nLanguage,
 360                             OUString& rResult, double* pNumber);
 361     /** create and store or find an already stored connection to a data source for use
 362     in SwFieldMgr and SwDBTreeList */
 363     css::uno::Reference< css::sdbc::XConnection> const &
 364                     RegisterConnection(OUString const& rSource);
 365
 366     void            CreateDSData(const SwDBData& rData)
 367                         { FindDSData(rData, true); }
 368     const SwDSParams_t& GetDSParamArray() const { return m_DataSourceParams; }
 369
 370     /// close all data sources - after fields were updated
 371     void            CloseAll(bool bIncludingMerge = true);
 372
 373     bool            GetMergeColumnCnt(const OUString& rColumnName, LanguageType nLanguage,
 374                                       OUString &rResult, double *pNumber);
 375     bool            FillCalcWithMergeData(SvNumberFormatter *pDocFormatter,
 376                                           LanguageType nLanguage, SwCalc &aCalc);
 377     void            ToNextRecord(const OUString& rDataSource, const OUString& rTableOrQuery);
 378
 379     sal_uInt32      GetSelectedRecordId();
 380     bool            ToRecordId(sal_Int32 nSet);
 381
 382     static const SwDBData& GetAddressDBName();
 383
 384     static OUString GetDBField(
 385                     css::uno::Reference< css::beans::XPropertySet > const & xColumnProp,
 386                     const SwDBFormatData& rDBFormatData,
 387                     double *pNumber = nullptr);
 388
 389     static css::uno::Reference< css::sdbc::XConnection>
 390             GetConnection(const OUString& rDataSource,
 391                 css::uno::Reference< css::sdbc::XDataSource>& rxSource,
 392                 const SwView* pView);
 393
 394     static css::uno::Reference< css::sdbcx::XColumnsSupplier>
 395             GetColumnSupplier(css::uno::Reference< css::sdbc::XConnection> const & xConnection,
 396                                     const OUString& rTableOrQuery,
 397                                     SwDBSelect eTableOrQuery = SwDBSelect::UNKNOWN);
 398
 399     static css::uno::Sequence<OUString> GetExistingDatabaseNames();
 400
 401     /**
 402      Loads a data source from file and registers it.
 403
 404      This function requires GUI interaction, as it loads the data source from
 405      the filename returned by a file picker and additional settings dialog.
 406      In case of success it returns the registered name, otherwise an empty string.
 407      */
 408     static OUString            LoadAndRegisterDataSource(weld::Window* pParent, SwDocShell* pDocShell = nullptr);
 409
 410     /**
 411      Loads a data source from file and registers it.
 412
 413      Convenience function, which calls GetDBunoURI and has just one mandatory parameter.
 414      In case of success it returns the registered name, otherwise an empty string.
 415      */
 416     static OUString            LoadAndRegisterDataSource(std::u16string_view rURI, const OUString *pDestDir);
 417
 418     /// Load the embedded data source of the document and also register it.
 419     void LoadAndRegisterEmbeddedDataSource(const SwDBData& rData, const SwDocShell& rDocShell);
 420
 421     /// Unregister a data source.
 422     static void RevokeDataSource(const OUString& rName);
 423
 424     /** try to get the data source from the given connection through the XChild interface.
 425         If this is not possible, the data source will be created through its name.
 426         @param _xConnection
 427             The connection which should support the XChild interface. (not a must)
 428         @param _sDataSourceName
 429             The data source name will be used to create the data source when the connection can not be used for it.
 430         @return
 431             The data source.
 432     */
 433     static css::uno::Reference< css::sdbc::XDataSource>
 434             getDataSourceAsParent(const css::uno::Reference< css::sdbc::XConnection>& _xConnection,const OUString& _sDataSourceName);
 435
 436     /** creates a RowSet, which must be disposed after use.
 437         @param  _sDataSourceName
 438             The data source name
 439         @param  _sCommand
 440             The command.
 441         @param  _nCommandType
 442             The type of the command.
 443         @param  _xConnection
 444             The active connection which may be <NULL/>.
 445         @return
 446             The new created RowSet.
 447
 448     */
 449     static css::uno::Reference< css::sdbc::XResultSet>
 450             createCursor(const OUString& _sDataSourceName,
 451                          const OUString& _sCommand,
 452                          sal_Int32 _nCommandType,
 453                          const css::uno::Reference< css::sdbc::XConnection>& _xConnection,
 454                          const SwView* pView);
 455
 456     void setEmbeddedName(const OUString& rEmbeddedName, SwDocShell& rDocShell);
 457     const OUString& getEmbeddedName() const;
 458
 459     // rOwnURL should be taken using INetURLObject::GetMainURL(INetURLObject::DecodeMechanism::NONE)
 460     static void StoreEmbeddedDataSource(const css::uno::Reference<css::frame::XStorable>& xStorable,
 461                                         const css::uno::Reference<css::embed::XStorage>& xStorage,
 462                                         const OUString& rStreamRelPath,
 463                                         const OUString& rOwnURL, bool bCopyTo = false);
 464
 465     SwDoc* getDoc() const;
 466     /// Stop reacting to removed database registrations.
 467     void releaseRevokeListener();
 468
 469     /// Revoke not committed registrations in case of mail merge cancel
 470     void RevokeLastRegistrations();
 471
 472     /// Accept not committed registrations
 473     void CommitLastRegistrations();
 474
 475     /// Remove not used connections.
 476     void RevokeNotUsedConnections();
 477 };
 478
 479 namespace sw
 480 {
 481 enum class DBConnURIType
 482 {
 483     UNKNOWN = 0,
 484     ODB,
 485     CALC,
 486     DBASE,
 487     FLAT,
 488     MSJET,
 489     MSACE,
 490     WRITER
 491 };
 492
 493 DBConnURIType SW_DLLPUBLIC GetDBunoType(const INetURLObject &rURL);
 494 }
 495
 496 #endif
 497
 498 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */