1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
|
/* -*- 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 .
*/
#ifndef INCLUDED_SW_INC_DBMGR_HXX
#define INCLUDED_SW_INC_DBMGR_HXX
#include <rtl/ustring.hxx>
#include <tools/link.hxx>
#include <com/sun/star/util/Date.hpp>
#include "swdllapi.h"
#include <swdbdata.hxx>
#include <com/sun/star/uno/Reference.h>
#include <com/sun/star/uno/Sequence.hxx>
#include <com/sun/star/lang/Locale.hpp>
#include <com/sun/star/beans/PropertyValue.hpp>
#include <com/sun/star/frame/XStorable.hpp>
#include <com/sun/star/embed/XStorage.hpp>
#include <memory>
#include <vector>
namespace com{namespace sun{namespace star{
namespace sdbc{
class XConnection;
class XStatement;
class XDataSource;
class XResultSet;
}
namespace beans{
class XPropertySet;
struct PropertyValue;
}
namespace sdbcx{
class XColumnsSupplier;
}
namespace util{
class XNumberFormatter;
}
namespace mail{
class XSmtpService;
}
}}}
namespace svx {
class ODataAccessDescriptor;
}
struct SwDBFormatData
{
com::sun::star::util::Date aNullDate;
com::sun::star::uno::Reference< com::sun::star::util::XNumberFormatter> xFormatter;
com::sun::star::lang::Locale aLocale;
};
namespace vcl {
class Window;
}
class SwView;
class SwWrtShell;
class SfxProgress;
class ListBox;
class Button;
class SvNumberFormatter;
class SwXMailMerge;
class SwMailMergeConfigItem;
class SwCalc;
class INetURLObject;
class SwDocShell;
enum DBManagerOptions
{
DBMGR_MERGE, ///< Data records in fields.
DBMGR_MERGE_PRINTER, ///< Print mail merge.
DBMGR_MERGE_EMAIL, ///< Send mail merge as email.
DBMGR_MERGE_FILE, ///< Save mail merge as files.
DBMGR_MERGE_SHELL ///< Create merge doc and keep the doc shell.
};
// Administration of (new) logical databases.
enum class SwDBSelect
{
UNKNOWN, TABLE, QUERY
};
struct SwDSParam : public SwDBData
{
com::sun::star::util::Date aNullDate;
::com::sun::star::uno::Reference<com::sun::star::util::XNumberFormatter> xFormatter;
::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection> xConnection;
::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XStatement> xStatement;
::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSet> xResultSet;
::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any > aSelection;
bool bScrollable;
bool bEndOfDB;
bool bAfterSelection;
long nSelectionIndex;
SwDSParam(const SwDBData& rData) :
SwDBData(rData),
bScrollable(false),
bEndOfDB(false),
bAfterSelection(false),
nSelectionIndex(0)
{}
SwDSParam(const SwDBData& rData,
const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSet>& xResSet,
const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >& rSelection) :
SwDBData(rData),
xResultSet(xResSet),
aSelection(rSelection),
bScrollable(true),
bEndOfDB(false),
bAfterSelection(false),
nSelectionIndex(0)
{}
void CheckEndOfDB()
{
if(bEndOfDB)
bAfterSelection = true;
}
};
typedef std::vector<std::unique_ptr<SwDSParam>> SwDSParams_t;
struct SwMergeDescriptor
{
DBManagerOptions nMergeType;
SwWrtShell& rSh;
const svx::ODataAccessDescriptor& rDescriptor;
OUString sSaveToFilter; ///< export filter to save resulting files
OUString sSaveToFilterOptions;
css::uno::Sequence< css::beans::PropertyValue > aSaveToFilterData;
OUString sSubject;
OUString sAddressFromColumn;
OUString sMailBody;
OUString sAttachmentName;
css::uno::Sequence< OUString > aCopiesTo;
css::uno::Sequence< OUString > aBlindCopiesTo;
css::uno::Reference< css::mail::XSmtpService > xSmtpServer;
bool bSendAsHTML;
bool bSendAsAttachment;
bool bPrintAsync;
bool bCreateSingleFile;
bool bSubjectIsFilename;
SwMailMergeConfigItem* pMailMergeConfigItem;
::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue > aPrintOptions;
SwMergeDescriptor( DBManagerOptions nType, SwWrtShell& rShell, svx::ODataAccessDescriptor& rDesc ) :
nMergeType(nType),
rSh(rShell),
rDescriptor(rDesc),
bSendAsHTML( true ),
bSendAsAttachment( false ),
bPrintAsync( false ),
bCreateSingleFile( false ),
bSubjectIsFilename( false ),
pMailMergeConfigItem(0)
{}
};
struct SwDBManager_Impl;
class SwConnectionDisposedListener_Impl;
class AbstractMailMergeDlg;
class SwDoc;
class SW_DLLPUBLIC SwDBManager
{
friend class SwConnectionDisposedListener_Impl;
OUString sEMailAddrField; ///< Mailing: Column name of email address.
OUString sSubject; ///< Mailing: Subject
bool bCancel; ///< Mail merge canceled.
bool bInitDBFields : 1;
bool bInMerge : 1; ///< merge process active
bool bMergeSilent : 1; ///< suppress display of dialogs/boxes (used when called over API)
bool bMergeLock : 1; /**< prevent update of database fields while document is
actually printed at the SwViewShell */
SwDSParams_t m_DataSourceParams;
SwDBManager_Impl* pImpl;
const SwXMailMerge* pMergeEvtSrc; ///< != 0 if mail merge events are to be send
/// Name of the embedded database that's included in the current document.
OUString m_sEmbeddedName;
/// The document that owns this manager.
SwDoc* m_pDoc;
SAL_DLLPRIVATE SwDSParam* FindDSData(const SwDBData& rData, bool bCreate);
SAL_DLLPRIVATE SwDSParam* FindDSConnection(const OUString& rSource, bool bCreate);
DECL_DLLPRIVATE_LINK_TYPED( PrtCancelHdl, Button *, void );
/// Insert data record as text into document.
SAL_DLLPRIVATE void ImportFromConnection( SwWrtShell* pSh);
/// Insert a single data record as text into document.
SAL_DLLPRIVATE void ImportDBEntry(SwWrtShell* pSh);
/// merge to file _and_ merge to e-Mail
SAL_DLLPRIVATE bool MergeMailFiles(SwWrtShell* pSh,
const SwMergeDescriptor& rMergeDescriptor, vcl::Window* pParent );
SAL_DLLPRIVATE bool ToNextRecord(SwDSParam* pParam);
SwDBManager(SwDBManager const&) = delete;
SwDBManager& operator=(SwDBManager const&) = delete;
public:
SwDBManager(SwDoc* pDoc);
~SwDBManager();
enum DBConnURITypes {
DBCONN_UNKNOWN = 0,
DBCONN_ODB,
DBCONN_CALC,
DBCONN_DBASE,
DBCONN_FLAT,
DBCONN_MSJET,
DBCONN_MSACE
};
/// MailMergeEvent source
const SwXMailMerge * GetMailMergeEvtSrc() const { return pMergeEvtSrc; }
void SetMailMergeEvtSrc( const SwXMailMerge *pSrc ) { pMergeEvtSrc = pSrc; }
inline bool IsMergeSilent() const { return bMergeSilent; }
inline void SetMergeSilent( bool bVal ) { bMergeSilent = bVal; }
/// Merging of data records into fields.
bool MergeNew( const SwMergeDescriptor& rMergeDesc, vcl::Window* pParent = NULL );
static bool Merge(SwWrtShell* pSh);
void MergeCancel();
/// Initialize data fields that lack name of database.
inline bool IsInitDBFields() const { return bInitDBFields; }
inline void SetInitDBFields(bool b) { bInitDBFields = b; }
/// Mailing: Set email data.
inline void SetEMailColumn(const OUString& sColName) { sEMailAddrField = sColName; }
inline void SetSubject(const OUString& sSbj) { sSubject = sSbj; }
/// Fill listbox with all table names of a database.
bool GetTableNames(ListBox* pListBox, const OUString& rDBName );
/// Fill listbox with all column names of a database table.
void GetColumnNames(ListBox* pListBox,
const OUString& rDBName, const OUString& rTableName, bool bAppend = false);
static void GetColumnNames(ListBox* pListBox,
css::uno::Reference< css::sdbc::XConnection> xConnection,
const OUString& rTableName, bool bAppend = false);
static sal_uLong GetColumnFormat( ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XDataSource> xSource,
::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection> xConnection,
::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet> xColumn,
SvNumberFormatter* pNFormatr,
long nLanguage );
sal_uLong GetColumnFormat( const OUString& rDBName,
const OUString& rTableName,
const OUString& rColNm,
SvNumberFormatter* pNFormatr,
long nLanguage );
sal_Int32 GetColumnType( const OUString& rDBName,
const OUString& rTableName,
const OUString& rColNm );
inline bool IsInMerge() const { return bInMerge; }
void ExecuteFormLetter(SwWrtShell& rSh,
const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue>& rProperties,
bool bWithDataSourceBrowser = false);
static void InsertText(SwWrtShell& rSh,
const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue>& rProperties);
/// check if a data source is open
bool IsDataSourceOpen(const OUString& rDataSource,
const OUString& rTableOrQuery, bool bMergeShell);
/// open the source while fields are updated - for the calculator only!
bool OpenDataSource(const OUString& rDataSource, const OUString& rTableOrQuery,
sal_Int32 nCommandType = -1, bool bCreate = false);
sal_uInt32 GetSelectedRecordId(const OUString& rDataSource, const OUString& rTableOrQuery, sal_Int32 nCommandType = -1);
bool GetColumnCnt(const OUString& rSourceName, const OUString& rTableName,
const OUString& rColumnName, sal_uInt32 nAbsRecordId, long nLanguage,
OUString& rResult, double* pNumber);
/** create and store or find an already stored connection to a data source for use
in SwFieldMgr and SwDBTreeList */
::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection>
RegisterConnection(OUString const& rSource);
const SwDSParam* CreateDSData(const SwDBData& rData)
{return FindDSData(rData, true);}
const SwDSParams_t& GetDSParamArray() const { return m_DataSourceParams; }
/// close all data sources - after fields were updated
void CloseAll(bool bIncludingMerge = true);
bool GetMergeColumnCnt(const OUString& rColumnName, sal_uInt16 nLanguage,
OUString &rResult, double *pNumber);
bool FillCalcWithMergeData(SvNumberFormatter *pDocFormatter,
sal_uInt16 nLanguage, bool asString, SwCalc &aCalc);
bool ToNextMergeRecord();
bool ToNextRecord(const OUString& rDataSource, const OUString& rTableOrQuery, sal_Int32 nCommandType = -1);
bool ExistsNextRecord()const;
sal_uInt32 GetSelectedRecordId();
bool ToRecordId(sal_Int32 nSet);
static const SwDBData& GetAddressDBName();
static OUString GetDBField(
::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet > xColumnProp,
const SwDBFormatData& rDBFormatData,
double *pNumber = NULL);
static ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection>
GetConnection(const OUString& rDataSource,
::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XDataSource>& rxSource);
static ::com::sun::star::uno::Reference< ::com::sun::star::sdbcx::XColumnsSupplier>
GetColumnSupplier(::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection>,
const OUString& rTableOrQuery,
SwDBSelect eTableOrQuery = SwDBSelect::UNKNOWN);
static ::com::sun::star::uno::Sequence<OUString> GetExistingDatabaseNames();
static DBConnURITypes GetDBunoURI(const OUString &rURI, ::com::sun::star::uno::Any &aURLAny);
/**
Loads a data source from file and registers it.
This function requires GUI interaction, as it loads the data source from
the filename returned by a file picker and additional settings dialog.
In case of success it returns the registered name, otherwise an empty string.
*/
static OUString LoadAndRegisterDataSource(SwDocShell* pDocShell = 0);
/**
Loads a data source from file and registers it.
In case of success it returns the registered name, otherwise an empty string.
Optionally add a prefix to the registered DB name.
*/
static OUString LoadAndRegisterDataSource(const DBConnURITypes type, const ::com::sun::star::uno::Any &rUnoURI,
const ::com::sun::star::uno::Reference < ::com::sun::star::beans::XPropertySet > *pSettings,
const OUString &rURI, const OUString *pPrefix = 0, const OUString *pDestDir = 0,
SwDocShell* pDocShell = 0);
/**
Loads a data source from file and registers it.
Convenience function, which calls GetDBunoURI and has just one mandatory parameter.
In case of success it returns the registered name, otherwise an empty string.
*/
static OUString LoadAndRegisterDataSource(const OUString& rURI, const OUString *pPrefix = 0, const OUString *pDestDir = 0,
const ::com::sun::star::uno::Reference < ::com::sun::star::beans::XPropertySet > *pSettings = 0);
/// Load the embedded data source of the document and also register it.
void LoadAndRegisterEmbeddedDataSource(const SwDBData& rData, const SwDocShell& rDocShell);
/// Unregister a data source.
static void RevokeDataSource(const OUString& rName);
/** try to get the data source from the given connection through the XChild interface.
If this is not possible, the data source will be created through its name.
@param _xConnection
The connection which should support the XChild interface. (not a must)
@param _sDataSourceName
The data source name will be used to create the data source when the connection can not be used for it.
@return
The data source.
*/
static ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XDataSource>
getDataSourceAsParent(const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection>& _xConnection,const OUString& _sDataSourceName);
/** creates a RowSet, which must be disposed after use.
@param _sDataSourceName
The data source name
@param _sCommand
The command.
@param _nCommandType
The type of the command.
@param _xConnection
The active connection which may be <NULL/>.
@return
The new created RowSet.
*/
static ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSet>
createCursor( const OUString& _sDataSourceName,
const OUString& _sCommand,
sal_Int32 _nCommandType,
const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection>& _xConnection
);
void setEmbeddedName(const OUString& rEmbeddedName, SwDocShell& rDocShell);
OUString getEmbeddedName() const;
static void StoreEmbeddedDataSource(const css::uno::Reference<css::frame::XStorable>& xStorable,
const css::uno::Reference<css::embed::XStorage>& xStorage,
const OUString& rStreamRelPath,
const OUString& rOwnURL);
SwDoc* getDoc() const;
/// Stop reacting to removed database registrations.
void releaseRevokeListener();
};
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|