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