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
|
/* -*- 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 <config_features.h>
#include <macroloader.hxx>
#include <com/sun/star/frame/DispatchResultState.hpp>
#include <basic/basmgr.hxx>
#include <basic/sbuno.hxx>
#include <basic/sberrors.hxx>
#include <cppuhelper/supportsservice.hxx>
#include <cppuhelper/weak.hxx>
#include <cppuhelper/weakref.hxx>
#include <framework/documentundoguard.hxx>
#include <sfx2/app.hxx>
#include <sfx2/frame.hxx>
#include <sfx2/objsh.hxx>
#include <tools/urlobj.hxx>
#include <vcl/svapp.hxx>
#include <memory>
using namespace ::com::sun::star;
using namespace ::com::sun::star::frame;
using namespace ::com::sun::star::lang;
using namespace ::com::sun::star::uno;
using namespace ::com::sun::star::util;
SfxMacroLoader::SfxMacroLoader(const css::uno::Sequence< css::uno::Any >& aArguments)
{
Reference < XFrame > xFrame;
if ( aArguments.hasElements() )
{
aArguments[0] >>= xFrame;
m_xFrame = xFrame;
}
}
OUString SAL_CALL SfxMacroLoader::getImplementationName()
{
return u"com.sun.star.comp.sfx2.SfxMacroLoader"_ustr;
}
sal_Bool SAL_CALL SfxMacroLoader::supportsService(OUString const & ServiceName)
{
return cppu::supportsService(this, ServiceName);
}
css::uno::Sequence<OUString> SAL_CALL SfxMacroLoader::getSupportedServiceNames()
{
return { u"com.sun.star.frame.ProtocolHandler"_ustr };
}
SfxObjectShell* SfxMacroLoader::GetObjectShell(const Reference <XFrame>& xFrame)
{
SfxObjectShell* pDocShell = nullptr;
if ( xFrame.is() )
{
SfxFrame* pFrame=nullptr;
for ( pFrame = SfxFrame::GetFirst(); pFrame; pFrame = SfxFrame::GetNext( *pFrame ) )
{
if ( pFrame->GetFrameInterface() == xFrame )
break;
}
if ( pFrame )
pDocShell = pFrame->GetCurrentDocument();
}
return pDocShell;
}
SfxObjectShell* SfxMacroLoader::GetObjectShell_Impl()
{
Reference < XFrame > xFrame( m_xFrame.get(), UNO_QUERY );
return SfxMacroLoader::GetObjectShell(xFrame);
}
uno::Reference<frame::XDispatch> SAL_CALL SfxMacroLoader::queryDispatch(
const util::URL& aURL ,
const OUString& /*sTargetFrameName*/,
sal_Int32 /*nSearchFlags*/ )
{
uno::Reference<frame::XDispatch> xDispatcher;
if(aURL.Complete.startsWith("macro:"))
xDispatcher = this;
return xDispatcher;
}
uno::Sequence< uno::Reference<frame::XDispatch> > SAL_CALL
SfxMacroLoader::queryDispatches( const uno::Sequence < frame::DispatchDescriptor >& seqDescriptor )
{
sal_Int32 nCount = seqDescriptor.getLength();
uno::Sequence< uno::Reference<frame::XDispatch> > lDispatcher(nCount);
std::transform(seqDescriptor.begin(), seqDescriptor.end(), lDispatcher.getArray(),
[this](const frame::DispatchDescriptor& rDescr) -> uno::Reference<frame::XDispatch> {
return queryDispatch(rDescr.FeatureURL, rDescr.FrameName, rDescr.SearchFlags); });
return lDispatcher;
}
void SAL_CALL SfxMacroLoader::dispatchWithNotification(
const util::URL& aURL, const uno::Sequence<beans::PropertyValue>& /*lArgs*/,
const uno::Reference<frame::XDispatchResultListener>& xListener )
{
SolarMutexGuard aGuard;
uno::Any aAny;
ErrCode nErr = loadMacro( aURL.Complete, aAny, GetObjectShell_Impl() );
if( !xListener.is() )
return;
// always call dispatchFinished(), because we didn't load a document but
// executed a macro instead!
frame::DispatchResultEvent aEvent;
aEvent.Source = getXWeak();
if( nErr == ERRCODE_NONE )
aEvent.State = frame::DispatchResultState::SUCCESS;
else
aEvent.State = frame::DispatchResultState::FAILURE;
xListener->dispatchFinished( aEvent ) ;
}
uno::Any SAL_CALL SfxMacroLoader::dispatchWithReturnValue(
const util::URL& aURL, const uno::Sequence<beans::PropertyValue>& )
{
uno::Any aRet;
ErrCode nErr = loadMacro( aURL.Complete, aRet, GetObjectShell_Impl() );
// aRet gets set to a different value only if nErr == ERRCODE_NONE
// Return it in such case to preserve the original behaviour
// In all other cases (nErr != ERRCODE_NONE), the calling code gets
// the actual error code back
if ( nErr != ERRCODE_NONE )
{
beans::PropertyValue aErrorCode;
aErrorCode.Name = "ErrorCode";
aErrorCode.Value <<= sal_uInt32(nErr);
aRet <<= aErrorCode;
}
return aRet;
}
void SAL_CALL SfxMacroLoader::dispatch(
const util::URL& aURL, const uno::Sequence<beans::PropertyValue>& /*lArgs*/ )
{
SolarMutexGuard aGuard;
uno::Any aAny;
loadMacro( aURL.Complete, aAny, GetObjectShell_Impl() );
}
void SAL_CALL SfxMacroLoader::addStatusListener(
const uno::Reference< frame::XStatusListener >& ,
const util::URL& )
{
/* TODO
How we can handle different listener for further coming or currently running dispatch() jobs
without any inconsistency!
*/
}
void SAL_CALL SfxMacroLoader::removeStatusListener(
const uno::Reference< frame::XStatusListener >&,
const util::URL& )
{
}
ErrCode SfxMacroLoader::loadMacro( const OUString& rURL, css::uno::Any& rRetval, SfxObjectShell* pSh )
{
#if !HAVE_FEATURE_SCRIPTING
(void) rURL;
(void) rRetval;
(void) pSh;
return ERRCODE_BASIC_PROC_UNDEFINED;
#else
SfxObjectShell* pCurrent = pSh;
if ( !pCurrent )
// all not full qualified names use the BASIC of the given or current document
pCurrent = SfxObjectShell::Current();
// 'macro:///lib.mod.proc(args)' => macro of App-BASIC
// 'macro://[docname|.]/lib.mod.proc(args)' => macro of current or qualified document
// 'macro://obj.method(args)' => direct API call, execute it via App-BASIC
const OUString& aMacro( rURL );
sal_Int32 nThirdSlashPos = aMacro.indexOf( '/', 8 );
sal_Int32 nArgsPos = aMacro.indexOf( '(' );
BasicManager *pAppMgr = SfxApplication::GetBasicManager();
BasicManager *pBasMgr = nullptr;
ErrCode nErr = ERRCODE_NONE;
// should a macro function be executed ( no direct API call)?
if ( -1 != nThirdSlashPos && ( -1 == nArgsPos || nThirdSlashPos < nArgsPos ) )
{
// find BasicManager
SfxObjectShell* pDoc = nullptr;
OUString aBasMgrName( INetURLObject::decode(aMacro.subView( 8, nThirdSlashPos-8 ), INetURLObject::DecodeMechanism::WithCharset) );
if ( aBasMgrName.isEmpty() )
pBasMgr = pAppMgr;
else if ( aBasMgrName == "." )
{
// current/actual document
pDoc = pCurrent;
if (pDoc)
pBasMgr = pDoc->GetBasicManager();
}
else
{
// full qualified name, find document by name
for ( SfxObjectShell *pObjSh = SfxObjectShell::GetFirst();
pObjSh && !pBasMgr;
pObjSh = SfxObjectShell::GetNext(*pObjSh) )
if ( aBasMgrName == pObjSh->GetTitle(SFX_TITLE_APINAME) )
{
pDoc = pObjSh;
pBasMgr = pDoc->GetBasicManager();
}
}
if ( pBasMgr )
{
const bool bIsAppBasic = ( pBasMgr == pAppMgr );
const bool bIsDocBasic = ( pBasMgr != pAppMgr );
if ( pDoc )
{
// security check for macros from document basic if an SFX doc is given
if ( !pDoc->AdjustMacroMode() )
// check forbids execution
return ERRCODE_IO_ACCESSDENIED;
}
// find BASIC method
OUString aQualifiedMethod( INetURLObject::decode(aMacro.subView( nThirdSlashPos+1 ), INetURLObject::DecodeMechanism::WithCharset) );
OUString aArgs;
if ( -1 != nArgsPos )
{
// remove arguments from macro name
aArgs = aQualifiedMethod.copy( nArgsPos - nThirdSlashPos - 1 );
aQualifiedMethod = aQualifiedMethod.copy( 0, nArgsPos - nThirdSlashPos - 1 );
}
if ( pBasMgr->HasMacro( aQualifiedMethod ) )
{
Any aOldThisComponent;
const bool bSetDocMacroMode = ( pDoc != nullptr ) && bIsDocBasic;
const bool bSetGlobalThisComponent = ( pDoc != nullptr ) && bIsAppBasic;
if ( bSetDocMacroMode )
{
// mark document: it executes an own macro, so it's in a modal mode
pDoc->SetMacroMode_Impl();
}
if ( bSetGlobalThisComponent )
{
// document is executed via AppBASIC, adjust ThisComponent variable
pAppMgr->SetGlobalUNOConstant( u"ThisComponent"_ustr, Any( pDoc->GetModel() ), &aOldThisComponent );
}
// just to let the shell be alive
SfxObjectShellRef xKeepDocAlive = pDoc;
{
// attempt to protect the document against the script tampering with its Undo Context
std::optional< ::framework::DocumentUndoGuard > pUndoGuard;
if ( bIsDocBasic )
pUndoGuard.emplace( pDoc->GetModel() );
// execute the method
SbxVariableRef retValRef = new SbxVariable;
nErr = pBasMgr->ExecuteMacro( aQualifiedMethod, aArgs, retValRef.get() );
if ( nErr == ERRCODE_NONE )
rRetval = sbxToUnoValue( retValRef.get() );
}
if ( bSetGlobalThisComponent )
{
pAppMgr->SetGlobalUNOConstant( u"ThisComponent"_ustr, aOldThisComponent );
}
if ( bSetDocMacroMode )
{
// remove flag for modal mode
pDoc->SetMacroMode_Impl( false );
}
}
else
nErr = ERRCODE_BASIC_PROC_UNDEFINED;
}
else
nErr = ERRCODE_IO_NOTEXISTS;
}
else
{
// direct API call on a specified object
OUString aCall =
"[" +
INetURLObject::decode(aMacro.subView(6),
INetURLObject::DecodeMechanism::WithCharset) +
"]";
pAppMgr->GetLib(0)->Execute(aCall);
nErr = SbxBase::GetError();
}
SbxBase::ResetError();
return nErr;
#endif
}
extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface *
com_sun_star_comp_sfx2_SfxMacroLoader_get_implementation(
css::uno::XComponentContext *,
css::uno::Sequence<css::uno::Any> const &arguments)
{
return cppu::acquire(new SfxMacroLoader(arguments));
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
