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
|
/* -*- 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 <sal/config.h>
#include <osl/diagnose.h>
#include <tools/diagnose_ex.h>
#include <com/sun/star/datatransfer/clipboard/ClipboardEvent.hpp>
#include <com/sun/star/lang/DisposedException.hpp>
#include <com/sun/star/lang/IllegalArgumentException.hpp>
#include <com/sun/star/uno/XComponentContext.hpp>
#include <cppuhelper/supportsservice.hxx>
#include <cppuhelper/weak.hxx>
#include <vcl/svapp.hxx>
#include <svdata.hxx>
#include <salinst.hxx>
#include <com/sun/star/datatransfer/clipboard/RenderingCapabilities.hpp>
#include "XNotifyingDataObject.hxx"
#include <systools/win32/comtools.hxx>
#include "DtObjFactory.hxx"
#include "APNDataObject.hxx"
#include "DOTransferable.hxx"
#include "WinClipboard.hxx"
#if !defined WIN32_LEAN_AND_MEAN
#define WIN32_LEAN_AND_MEAN
#endif
#include <windows.h>
#include <ole2.h>
#include <objidl.h>
using namespace com::sun::star;
namespace
{
CWinClipboard* s_pCWinClipbImpl = nullptr;
osl::Mutex s_aClipboardSingletonMutex;
}
/*XEventListener,*/
CWinClipboard::CWinClipboard(const uno::Reference<uno::XComponentContext>& rxContext,
const OUString& aClipboardName)
: WeakComponentImplHelper<XSystemClipboard, XFlushableClipboard, XServiceInfo>(m_aMutex)
, m_xContext(rxContext)
, m_itsName(aClipboardName)
, m_pCurrentClipContent(nullptr)
{
// necessary to reassociate from
// the static callback function
{
osl::MutexGuard aGuard(s_aClipboardSingletonMutex);
s_pCWinClipbImpl = this;
}
registerClipboardViewer();
}
CWinClipboard::~CWinClipboard()
{
{
osl::MutexGuard aGuard(s_aClipboardSingletonMutex);
s_pCWinClipbImpl = nullptr;
}
unregisterClipboardViewer();
}
// XClipboard
// to avoid unnecessary traffic we check first if there is a clipboard
// content which was set via setContent, in this case we don't need
// to query the content from the clipboard, create a new wrapper object
// and so on, we simply return the original XTransferable instead of our
// DOTransferable
uno::Reference<datatransfer::XTransferable> SAL_CALL CWinClipboard::getContents()
{
osl::MutexGuard aGuard(m_aContentMutex);
if (rBHelper.bDisposed)
throw lang::DisposedException("object is already disposed",
static_cast<XClipboardEx*>(this));
// use the shortcut or create a transferable from
// system clipboard
{
osl::MutexGuard aGuard2(m_aContentCacheMutex);
if (nullptr != m_pCurrentClipContent)
return m_pCurrentClipContent->m_XTransferable;
// Content cached?
if (m_foreignContent.is())
return m_foreignContent;
// release the mutex, so that the variable may be
// changed by other threads
}
uno::Reference<datatransfer::XTransferable> rClipContent;
// get the current format list from clipboard
if (UINT nFormats; !GetUpdatedClipboardFormats(nullptr, 0, &nFormats)
&& GetLastError() == ERROR_INSUFFICIENT_BUFFER)
{
std::vector<UINT> aUINTFormats(nFormats);
if (GetUpdatedClipboardFormats(aUINTFormats.data(), nFormats, &nFormats))
{
std::vector<sal_uInt32> aFormats(aUINTFormats.begin(), aUINTFormats.end());
rClipContent = new CDOTransferable(m_xContext, this, aFormats);
osl::MutexGuard aGuard2(m_aContentCacheMutex);
m_foreignContent = rClipContent;
}
}
return rClipContent;
}
IDataObjectPtr CWinClipboard::getIDataObject()
{
osl::MutexGuard aGuard(m_aContentMutex);
if (rBHelper.bDisposed)
throw lang::DisposedException("object is already disposed",
static_cast<XClipboardEx*>(this));
// get the current dataobject from clipboard
IDataObjectPtr pIDataObject;
HRESULT hr = m_MtaOleClipboard.getClipboard(&pIDataObject);
if (SUCCEEDED(hr))
{
// create an apartment neutral dataobject and initialize it with a
// com smart pointer to the IDataObject from clipboard
pIDataObject = new CAPNDataObject(pIDataObject);
}
return pIDataObject;
}
void SAL_CALL CWinClipboard::setContents(
const uno::Reference<datatransfer::XTransferable>& xTransferable,
const uno::Reference<datatransfer::clipboard::XClipboardOwner>& xClipboardOwner)
{
osl::MutexGuard aGuard(m_aContentMutex);
if (rBHelper.bDisposed)
throw lang::DisposedException("object is already disposed",
static_cast<XClipboardEx*>(this));
IDataObjectPtr pIDataObj;
if (xTransferable.is())
{
{
osl::MutexGuard aGuard2(m_aContentCacheMutex);
m_foreignContent.clear();
m_pCurrentClipContent = new CXNotifyingDataObject(
CDTransObjFactory::createDataObjFromTransferable(m_xContext, xTransferable),
xTransferable, xClipboardOwner, this);
}
pIDataObj = IDataObjectPtr(m_pCurrentClipContent);
}
m_MtaOleClipboard.setClipboard(pIDataObj.get());
}
OUString SAL_CALL CWinClipboard::getName()
{
if (rBHelper.bDisposed)
throw lang::DisposedException("object is already disposed",
static_cast<XClipboardEx*>(this));
return m_itsName;
}
// XFlushableClipboard
void SAL_CALL CWinClipboard::flushClipboard()
{
osl::MutexGuard aGuard(m_aContentMutex);
if (rBHelper.bDisposed)
throw lang::DisposedException("object is already disposed",
static_cast<XClipboardEx*>(this));
// actually it should be ClearableMutexGuard aGuard( m_aContentCacheMutex );
// but it does not work since FlushClipboard does a callback and frees DataObject
// which results in a deadlock in onReleaseDataObject.
// FlushClipboard had to be synchron in order to prevent shutdown until all
// clipboard-formats are rendered.
// The request is needed to prevent flushing if we are not clipboard owner (it is
// not known what happens if we flush but aren't clipboard owner).
// It may be possible to move the request to the clipboard STA thread by saving the
// DataObject and call OleIsCurrentClipboard before flushing.
if (nullptr != m_pCurrentClipContent)
m_MtaOleClipboard.flushClipboard();
}
// XClipboardEx
sal_Int8 SAL_CALL CWinClipboard::getRenderingCapabilities()
{
if (rBHelper.bDisposed)
throw lang::DisposedException("object is already disposed",
static_cast<XClipboardEx*>(this));
using namespace datatransfer::clipboard::RenderingCapabilities;
return (Delayed | Persistant);
}
// XClipboardNotifier
void SAL_CALL CWinClipboard::addClipboardListener(
const uno::Reference<datatransfer::clipboard::XClipboardListener>& listener)
{
if (rBHelper.bDisposed)
throw lang::DisposedException("object is already disposed",
static_cast<XClipboardEx*>(this));
// check input parameter
if (!listener.is())
throw lang::IllegalArgumentException("empty reference", static_cast<XClipboardEx*>(this),
1);
rBHelper.aLC.addInterface(cppu::UnoType<decltype(listener)>::get(), listener);
}
void SAL_CALL CWinClipboard::removeClipboardListener(
const uno::Reference<datatransfer::clipboard::XClipboardListener>& listener)
{
if (rBHelper.bDisposed)
throw lang::DisposedException("object is already disposed",
static_cast<XClipboardEx*>(this));
// check input parameter
if (!listener.is())
throw lang::IllegalArgumentException("empty reference", static_cast<XClipboardEx*>(this),
1);
rBHelper.aLC.removeInterface(cppu::UnoType<decltype(listener)>::get(), listener);
}
void CWinClipboard::notifyAllClipboardListener()
{
if (rBHelper.bDisposed)
return;
osl::ClearableMutexGuard aGuard(rBHelper.rMutex);
if (rBHelper.bDisposed)
return;
aGuard.clear();
cppu::OInterfaceContainerHelper* pICHelper = rBHelper.aLC.getContainer(
cppu::UnoType<datatransfer::clipboard::XClipboardListener>::get());
if (!pICHelper)
return;
try
{
cppu::OInterfaceIteratorHelper iter(*pICHelper);
uno::Reference<datatransfer::XTransferable> rXTransf(getContents());
datatransfer::clipboard::ClipboardEvent aClipbEvent(static_cast<XClipboard*>(this),
rXTransf);
while (iter.hasMoreElements())
{
try
{
uno::Reference<datatransfer::clipboard::XClipboardListener> xCBListener(
iter.next(), uno::UNO_QUERY);
if (xCBListener.is())
xCBListener->changedContents(aClipbEvent);
}
catch (uno::RuntimeException&)
{
TOOLS_WARN_EXCEPTION("vcl", "");
}
}
}
catch (const lang::DisposedException&)
{
OSL_FAIL("Service Manager disposed");
// no further clipboard changed notifications
unregisterClipboardViewer();
}
}
// XServiceInfo
OUString SAL_CALL CWinClipboard::getImplementationName()
{
return "com.sun.star.datatransfer.clipboard.ClipboardW32";
}
sal_Bool SAL_CALL CWinClipboard::supportsService(const OUString& ServiceName)
{
return cppu::supportsService(this, ServiceName);
}
uno::Sequence<OUString> SAL_CALL CWinClipboard::getSupportedServiceNames()
{
return { "com.sun.star.datatransfer.clipboard.SystemClipboard" };
}
// We run unit tests in parallel, which is a problem when touching a shared resource
// the system clipboard, so rather use the dummy GenericClipboard.
const bool bRunningUnitTest = getenv("LO_TESTNAME");
extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface*
dtrans_CWinClipboard_get_implementation(css::uno::XComponentContext* context,
css::uno::Sequence<css::uno::Any> const& args)
{
if (bRunningUnitTest)
{
SolarMutexGuard aGuard;
auto xClipboard = ImplGetSVData()->mpDefInst->CreateClipboard(args);
if (xClipboard.is())
xClipboard->acquire();
return xClipboard.get();
}
else
{
return cppu::acquire(new CWinClipboard(context, ""));
}
}
void CWinClipboard::onReleaseDataObject(CXNotifyingDataObject* theCaller)
{
OSL_ASSERT(nullptr != theCaller);
if (theCaller)
theCaller->lostOwnership();
// if the current caller is the one we currently hold, then set it to NULL
// because an external source must be the clipboardowner now
osl::MutexGuard aGuard(m_aContentCacheMutex);
if (m_pCurrentClipContent == theCaller)
m_pCurrentClipContent = nullptr;
}
void CWinClipboard::registerClipboardViewer()
{
m_MtaOleClipboard.registerClipViewer(CWinClipboard::onClipboardContentChanged);
}
void CWinClipboard::unregisterClipboardViewer() { m_MtaOleClipboard.registerClipViewer(nullptr); }
void WINAPI CWinClipboard::onClipboardContentChanged()
{
osl::MutexGuard aGuard(s_aClipboardSingletonMutex);
// reassociation to instance through static member
if (nullptr != s_pCWinClipbImpl)
{
s_pCWinClipbImpl->m_foreignContent.clear();
s_pCWinClipbImpl->notifyAllClipboardListener();
}
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|