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
|
/* -*- 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/.
*/
#include <swmodeltestbase.hxx>
#include <comphelper/processfactory.hxx>
#include <osl/file.hxx>
#include <comphelper/propertyvalue.hxx>
#include <comphelper/scopeguard.hxx>
#include <vcl/scheduler.hxx>
#include <com/sun/star/frame/XDispatchHelper.hpp>
#include <com/sun/star/frame/XDispatchProvider.hpp>
#include <com/sun/star/frame/XComponentLoader.hpp>
#include <com/sun/star/frame/XStorable2.hpp>
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
#include <com/sun/star/packages/zip/ZipFileAccess.hpp>
#include <com/sun/star/view/XSelectionSupplier.hpp>
#include <unotxdoc.hxx>
#include <docsh.hxx>
#include <wrtsh.hxx>
#include <swmodule.hxx>
#include <view.hxx>
constexpr OUStringLiteral DATA_DIRECTORY = u"/sw/qa/uibase/uiview/data/";
/// Covers sw/source/uibase/uiview/ fixes.
class SwUibaseUiviewTest : public SwModelTestBase
{
};
CPPUNIT_TEST_FIXTURE(SwUibaseUiviewTest, testUpdateAllObjectReplacements)
{
// Make a temporary copy of the test document
utl::TempFile tmp;
tmp.EnableKillingFile();
OUString sTempCopy = tmp.GetURL();
CPPUNIT_ASSERT_EQUAL(osl::FileBase::E_None,
osl::File::copy(m_directories.getURLFromSrc(DATA_DIRECTORY)
+ "updateall-objectreplacements.odt",
sTempCopy));
/* BASIC code that exhibits the problem:
desktop = CreateUnoService("com.sun.star.frame.Desktop")
Dim props(0) as new com.sun.star.beans.PropertyValue
props(0).Name = "Hidden"
props(0).Value = true
component = desktop.loadComponentFromURL("file://.../test.odt", "_default", 0, props)
Wait 1000 ' workaround
dispatcher = createUnoService("com.sun.star.frame.DispatchHelper")
frame = component.CurrentController.Frame
dispatcher.executeDispatch(frame, ".uno:UpdateAll", "", 0, Array())
component.storeSelf(Array())
component.dispose()
*/
uno::Reference<lang::XMultiServiceFactory> xFactory(comphelper::getProcessServiceFactory());
// Load the copy
uno::Reference<uno::XInterface> xInterface
= xFactory->createInstance("com.sun.star.frame.Desktop");
uno::Reference<frame::XComponentLoader> xComponentLoader(xInterface, uno::UNO_QUERY);
uno::Sequence<beans::PropertyValue> aLoadArgs{ comphelper::makePropertyValue("Hidden", true) };
mxComponent = xComponentLoader->loadComponentFromURL(sTempCopy, "_default", 0, aLoadArgs);
// Perform the .uno:UpdateAll call and save
xInterface = xFactory->createInstance("com.sun.star.frame.DispatchHelper");
uno::Reference<frame::XDispatchHelper> xDispatchHelper(xInterface, uno::UNO_QUERY);
uno::Reference<frame::XModel> xModel(mxComponent, uno::UNO_QUERY);
uno::Reference<frame::XDispatchProvider> xDispatchProvider(
xModel->getCurrentController()->getFrame(), uno::UNO_QUERY);
uno::Sequence<beans::PropertyValue> aNoArgs;
xDispatchHelper->executeDispatch(xDispatchProvider, ".uno:UpdateAll", OUString(), 0, aNoArgs);
uno::Reference<frame::XStorable2> xStorable(mxComponent, uno::UNO_QUERY);
xStorable->storeSelf(aNoArgs);
// Check the contents of the updated copy and verify that ObjectReplacements are there
uno::Reference<packages::zip::XZipFileAccess2> xNameAccess
= packages::zip::ZipFileAccess::createWithURL(comphelper::getComponentContext(xFactory),
sTempCopy);
CPPUNIT_ASSERT(xNameAccess->hasByName("ObjectReplacements/Components"));
CPPUNIT_ASSERT(xNameAccess->hasByName("ObjectReplacements/Components_1"));
}
CPPUNIT_TEST_FIXTURE(SwUibaseUiviewTest, testUpdateReplacementNosetting)
{
// Load a copy of the document in hidden mode.
OUString aSourceURL
= m_directories.getURLFromSrc(DATA_DIRECTORY) + "update-replacement-nosetting.odt";
CPPUNIT_ASSERT_EQUAL(osl::FileBase::E_None, osl::File::copy(aSourceURL, maTempFile.GetURL()));
mxComponent = loadFromDesktop(maTempFile.GetURL(), "com.sun.star.text.TextDocument",
{ comphelper::makePropertyValue("Hidden", true) });
// Update "everything" (including object replacements) and save it.
dispatchCommand(mxComponent, ".uno:UpdateAll", {});
uno::Reference<frame::XStorable2> xStorable(mxComponent, uno::UNO_QUERY);
xStorable->storeSelf({});
// Check the contents of the updated copy.
uno::Reference<uno::XComponentContext> xContext = comphelper::getProcessComponentContext();
uno::Reference<packages::zip::XZipFileAccess2> xNameAccess
= packages::zip::ZipFileAccess::createWithURL(xContext, maTempFile.GetURL());
// Without the accompanying fix in place, this test would have failed, because the embedded
// object replacement image was not generated.
CPPUNIT_ASSERT(xNameAccess->hasByName("ObjectReplacements/Components"));
}
CPPUNIT_TEST_FIXTURE(SwUibaseUiviewTest, testKeepRatio)
{
// Given a document with a custom KeepRatio:
OUString aURL = m_directories.getURLFromSrc(DATA_DIRECTORY) + "keep-ratio.fodt";
// When loading that document:
mxComponent = loadFromDesktop(aURL);
// Then make sure we read the custom value:
auto pXTextDocument = dynamic_cast<SwXTextDocument*>(mxComponent.get());
SwWrtShell* pWrtShell = pXTextDocument->GetDocShell()->GetWrtShell();
const SwViewOption* pViewOption = pWrtShell->GetViewOptions();
comphelper::ScopeGuard g([pWrtShell, pViewOption] {
SwViewOption aViewOption(*pViewOption);
aViewOption.SetKeepRatio(false);
SW_MOD()->ApplyUsrPref(aViewOption, &pWrtShell->GetView());
});
// Without the accompanying fix in place, this test would have failed, because KeepRatio was not
// mapped to settings.xml
CPPUNIT_ASSERT(pViewOption->IsKeepRatio());
// Then export as well:
uno::Reference<frame::XStorable2> xStorable(mxComponent, uno::UNO_QUERY);
uno::Sequence<beans::PropertyValue> aStoreArgs = {
comphelper::makePropertyValue("FilterName", OUString("writer8")),
};
xStorable->storeToURL(maTempFile.GetURL(), aStoreArgs);
mbExported = true;
xmlDocUniquePtr pXmlDoc = parseExport("settings.xml");
assertXPathContent(pXmlDoc, "//config:config-item[@config:name='KeepRatio']", "true");
}
namespace
{
/// Interception implementation that disables .uno:Zoom on Image1, but not on Image2.
struct ImageInterceptor : public cppu::WeakImplHelper<frame::XDispatchProviderInterceptor>
{
uno::Reference<view::XSelectionSupplier> m_xSelectionSupplier;
uno::Reference<frame::XDispatchProvider> m_xMaster;
uno::Reference<frame::XDispatchProvider> m_xSlave;
int m_nEnabled = 0;
int m_nDisabled = 0;
public:
ImageInterceptor(const uno::Reference<lang::XComponent>& xComponent);
// XDispatchProviderInterceptor
uno::Reference<frame::XDispatchProvider> SAL_CALL getMasterDispatchProvider() override;
uno::Reference<frame::XDispatchProvider> SAL_CALL getSlaveDispatchProvider() override;
void SAL_CALL setMasterDispatchProvider(
const uno::Reference<frame::XDispatchProvider>& xNewSupplier) override;
void SAL_CALL
setSlaveDispatchProvider(const uno::Reference<frame::XDispatchProvider>& xNewSupplier) override;
// XDispatchProvider
uno::Reference<frame::XDispatch> SAL_CALL queryDispatch(const util::URL& rURL,
const OUString& rTargetFrameName,
sal_Int32 SearchFlags) override;
uno::Sequence<uno::Reference<frame::XDispatch>> SAL_CALL
queryDispatches(const uno::Sequence<frame::DispatchDescriptor>& rRequests) override;
};
}
ImageInterceptor::ImageInterceptor(const uno::Reference<lang::XComponent>& xComponent)
{
uno::Reference<frame::XModel2> xModel(xComponent, uno::UNO_QUERY);
CPPUNIT_ASSERT(xModel.is());
m_xSelectionSupplier.set(xModel->getCurrentController(), uno::UNO_QUERY);
CPPUNIT_ASSERT(m_xSelectionSupplier.is());
}
uno::Reference<frame::XDispatchProvider> ImageInterceptor::getMasterDispatchProvider()
{
return m_xMaster;
}
uno::Reference<frame::XDispatchProvider> ImageInterceptor::getSlaveDispatchProvider()
{
return m_xSlave;
}
void ImageInterceptor::setMasterDispatchProvider(
const uno::Reference<frame::XDispatchProvider>& xNewSupplier)
{
m_xMaster = xNewSupplier;
}
void ImageInterceptor::setSlaveDispatchProvider(
const uno::Reference<frame::XDispatchProvider>& xNewSupplier)
{
m_xSlave = xNewSupplier;
}
uno::Reference<frame::XDispatch> ImageInterceptor::queryDispatch(const util::URL& rURL,
const OUString& rTargetFrameName,
sal_Int32 nSearchFlags)
{
// Disable the UNO command based on the currently selected image, i.e. this can't be cached when
// a different image is selected. Originally this was .uno:SetBorderStyle, but let's pick a
// command which is active when running cppunit tests:
if (rURL.Complete == ".uno:Zoom")
{
uno::Reference<container::XNamed> xImage;
m_xSelectionSupplier->getSelection() >>= xImage;
if (xImage.is() && xImage->getName() == "Image1")
{
++m_nDisabled;
return {};
}
++m_nEnabled;
}
return m_xSlave->queryDispatch(rURL, rTargetFrameName, nSearchFlags);
}
uno::Sequence<uno::Reference<frame::XDispatch>>
ImageInterceptor::queryDispatches(const uno::Sequence<frame::DispatchDescriptor>& /*rRequests*/)
{
return {};
}
CPPUNIT_TEST_FIXTURE(SwUibaseUiviewTest, testSwitchBetweenImages)
{
// Given a document with 2 images, and an interceptor catching an UNO command that specific to
// the current selection:
SwDoc* pDoc = createSwDoc();
SwWrtShell* pWrtShell = pDoc->GetDocShell()->GetWrtShell();
uno::Reference<lang::XMultiServiceFactory> xMSF(mxComponent, uno::UNO_QUERY);
uno::Reference<text::XTextDocument> xTextDocument(mxComponent, uno::UNO_QUERY);
uno::Reference<text::XText> xText = xTextDocument->getText();
uno::Reference<text::XTextCursor> xCursor = xText->createTextCursor();
for (int i = 0; i < 2; ++i)
{
uno::Reference<beans::XPropertySet> xTextGraphic(
xMSF->createInstance("com.sun.star.text.TextGraphicObject"), uno::UNO_QUERY);
xTextGraphic->setPropertyValue("AnchorType",
uno::Any(text::TextContentAnchorType_AS_CHARACTER));
xTextGraphic->setPropertyValue("Size", uno::Any(awt::Size(5000, 5000)));
uno::Reference<text::XTextContent> xTextContent(xTextGraphic, uno::UNO_QUERY);
xText->insertTextContent(xCursor, xTextContent, false);
}
pWrtShell->SttEndDoc(/*bStt=*/false);
uno::Reference<frame::XModel> xModel(mxComponent, uno::UNO_QUERY);
uno::Reference<frame::XDispatchProviderInterception> xRegistration(
xModel->getCurrentController()->getFrame(), uno::UNO_QUERY);
rtl::Reference pInterceptor(new ImageInterceptor(mxComponent));
xRegistration->registerDispatchProviderInterceptor(pInterceptor);
pInterceptor->m_nEnabled = 0;
pInterceptor->m_nDisabled = 0;
// When selecting the first image:
uno::Reference<text::XTextGraphicObjectsSupplier> xGraphicObjectsSupplier(mxComponent,
uno::UNO_QUERY);
uno::Reference<container::XIndexAccess> xGraphicObjects(
xGraphicObjectsSupplier->getGraphicObjects(), uno::UNO_QUERY);
pInterceptor->m_xSelectionSupplier->select(xGraphicObjects->getByIndex(0));
Scheduler::ProcessEventsToIdle();
SwView* pView = pDoc->GetDocShell()->GetView();
pView->StopShellTimer();
// Then make sure the UNO command is disabled:
CPPUNIT_ASSERT_EQUAL(0, pInterceptor->m_nEnabled);
CPPUNIT_ASSERT_GREATEREQUAL(1, pInterceptor->m_nDisabled);
// Given a clean state:
pInterceptor->m_nEnabled = 0;
pInterceptor->m_nDisabled = 0;
// When selecting the second image:
pInterceptor->m_xSelectionSupplier->select(xGraphicObjects->getByIndex(1));
Scheduler::ProcessEventsToIdle();
pView->StopShellTimer();
// Then make sure the UNO command is enabled:
CPPUNIT_ASSERT_GREATEREQUAL(1, pInterceptor->m_nEnabled);
CPPUNIT_ASSERT_EQUAL(0, pInterceptor->m_nDisabled);
// Given a clean state:
pInterceptor->m_nEnabled = 0;
pInterceptor->m_nDisabled = 0;
// When selecting the first image, again (this time not changing the selection type):
pInterceptor->m_xSelectionSupplier->select(xGraphicObjects->getByIndex(0));
Scheduler::ProcessEventsToIdle();
pView->StopShellTimer();
// Then make sure the UNO command is disabled:
CPPUNIT_ASSERT_EQUAL(0, pInterceptor->m_nEnabled);
// Without the accompanying fix in place, this test would have failed with:
// - Expected greater or equal than: 1
// - Actual : 0
// i.e. selecting the first image didn't result in a disabled UNO command.
CPPUNIT_ASSERT_GREATEREQUAL(1, pInterceptor->m_nDisabled);
}
CPPUNIT_PLUGIN_IMPLEMENT();
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
