Line data Source code
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 :
20 : #include "basprov.hxx"
21 : #include "basscript.hxx"
22 : #include "baslibnode.hxx"
23 : #include <com/sun/star/frame/XModel.hpp>
24 : #include <com/sun/star/script/browse/BrowseNodeTypes.hpp>
25 : #include <com/sun/star/script/provider/ScriptFrameworkErrorType.hpp>
26 : #include <com/sun/star/document/XEmbeddedScripts.hpp>
27 : #include <com/sun/star/uri/UriReferenceFactory.hpp>
28 :
29 : #include <cppuhelper/implementationentry.hxx>
30 : #include <cppuhelper/supportsservice.hxx>
31 : #include <rtl/uri.hxx>
32 : #include <osl/process.h>
33 : #include <osl/file.hxx>
34 : #include <osl/mutex.hxx>
35 : #include <vcl/svapp.hxx>
36 : #include <basic/sbx.hxx>
37 : #include <basic/basmgr.hxx>
38 : #include <basic/basicmanagerrepository.hxx>
39 : #include <basic/sbstar.hxx>
40 : #include <basic/sbmod.hxx>
41 : #include <basic/sbmeth.hxx>
42 : #include <sfx2/app.hxx>
43 : #include <sfx2/objsh.hxx>
44 :
45 : #include <com/sun/star/util/theMacroExpander.hpp>
46 : #include <com/sun/star/script/XLibraryContainer2.hpp>
47 : #include <com/sun/star/uri/XUriReference.hpp>
48 : #include <com/sun/star/uri/XUriReferenceFactory.hpp>
49 : #include <com/sun/star/uri/XVndSunStarScriptUrl.hpp>
50 :
51 : #include <util/MiscUtils.hxx>
52 :
53 :
54 : using namespace ::com::sun::star;
55 : using namespace ::com::sun::star::lang;
56 : using namespace ::com::sun::star::uno;
57 : using namespace ::com::sun::star::script;
58 : using namespace ::com::sun::star::document;
59 : using namespace ::sf_misc;
60 :
61 :
62 : namespace basprov
63 : {
64 :
65 :
66 :
67 : // component operations
68 :
69 :
70 6 : static OUString getImplementationName_BasicProviderImpl()
71 : {
72 6 : return OUString( "com.sun.star.comp.scripting.ScriptProviderForBasic" );
73 : }
74 :
75 :
76 :
77 6 : static Sequence< OUString > getSupportedServiceNames_BasicProviderImpl()
78 : {
79 : static Sequence< OUString >* pNames = 0;
80 6 : if ( !pNames )
81 : {
82 5 : ::osl::MutexGuard aGuard( ::osl::Mutex::getGlobalMutex() );
83 5 : if ( !pNames )
84 : {
85 5 : static Sequence< OUString > aNames(4);
86 5 : aNames.getArray()[0] = "com.sun.star.script.provider.ScriptProviderForBasic";
87 5 : aNames.getArray()[1] = "com.sun.star.script.provider.LanguageScriptProvider";
88 5 : aNames.getArray()[2] = "com.sun.star.script.provider.ScriptProvider";
89 5 : aNames.getArray()[3] = "com.sun.star.script.browse.BrowseNode";
90 5 : pNames = &aNames;
91 5 : }
92 : }
93 6 : return *pNames;
94 : }
95 :
96 :
97 : // BasicProviderImpl
98 :
99 :
100 32 : BasicProviderImpl::BasicProviderImpl( const Reference< XComponentContext >& xContext )
101 : :m_pAppBasicManager( 0 )
102 : ,m_pDocBasicManager( 0 )
103 : ,m_xLibContainerApp( 0 )
104 : ,m_xLibContainerDoc( 0 )
105 : ,m_xContext( xContext )
106 : ,m_bIsAppScriptCtx( true )
107 32 : ,m_bIsUserCtx(true)
108 : {
109 32 : }
110 :
111 :
112 :
113 64 : BasicProviderImpl::~BasicProviderImpl()
114 : {
115 64 : }
116 :
117 :
118 :
119 0 : bool BasicProviderImpl::isLibraryShared( const Reference< script::XLibraryContainer >& rxLibContainer, const OUString& rLibName )
120 : {
121 0 : bool bIsShared = false;
122 :
123 0 : Reference< script::XLibraryContainer2 > xLibContainer( rxLibContainer, UNO_QUERY );
124 0 : if ( xLibContainer.is() && xLibContainer->hasByName( rLibName ) && xLibContainer->isLibraryLink( rLibName ) )
125 : {
126 0 : OUString aFileURL;
127 0 : if ( m_xContext.is() )
128 : {
129 0 : Reference< uri::XUriReferenceFactory > xUriFac( uri::UriReferenceFactory::create( m_xContext ) );
130 :
131 0 : OUString aLinkURL( xLibContainer->getLibraryLinkURL( rLibName ) );
132 0 : Reference< uri::XUriReference > xUriRef( xUriFac->parse( aLinkURL ), UNO_QUERY );
133 :
134 0 : if ( xUriRef.is() )
135 : {
136 0 : OUString aScheme = xUriRef->getScheme();
137 0 : if ( aScheme.equalsIgnoreAsciiCase("file") )
138 : {
139 0 : aFileURL = aLinkURL;
140 : }
141 0 : else if ( aScheme.equalsIgnoreAsciiCase("vnd.sun.star.pkg") )
142 : {
143 0 : OUString aAuthority = xUriRef->getAuthority();
144 0 : if ( aAuthority.matchIgnoreAsciiCase( "vnd.sun.star.expand:" ) )
145 : {
146 0 : OUString aDecodedURL( aAuthority.copy( sizeof ( "vnd.sun.star.expand:" ) - 1 ) );
147 0 : aDecodedURL = ::rtl::Uri::decode( aDecodedURL, rtl_UriDecodeWithCharset, RTL_TEXTENCODING_UTF8 );
148 : Reference<util::XMacroExpander> xMacroExpander =
149 0 : util::theMacroExpander::get(m_xContext);
150 0 : aFileURL = xMacroExpander->expandMacros( aDecodedURL );
151 0 : }
152 0 : }
153 0 : }
154 : }
155 :
156 0 : if ( !aFileURL.isEmpty() )
157 : {
158 0 : osl::DirectoryItem aFileItem;
159 0 : osl::FileStatus aFileStatus( osl_FileStatus_Mask_FileURL );
160 0 : OSL_VERIFY( osl::DirectoryItem::get( aFileURL, aFileItem ) == osl::FileBase::E_None );
161 0 : OSL_VERIFY( aFileItem.getFileStatus( aFileStatus ) == osl::FileBase::E_None );
162 0 : OUString aCanonicalFileURL( aFileStatus.getFileURL() );
163 :
164 0 : OUString aSearchURL1( "share/basic" );
165 0 : OUString aSearchURL2( "share/uno_packages" );
166 0 : if( aCanonicalFileURL.indexOf( aSearchURL1 ) != -1 || aCanonicalFileURL.indexOf( aSearchURL2 ) != -1 )
167 0 : bIsShared = true;
168 0 : }
169 : }
170 :
171 0 : return bIsShared;
172 : }
173 :
174 : // XServiceInfo
175 1 : OUString BasicProviderImpl::getImplementationName( ) throw (RuntimeException, std::exception)
176 : {
177 1 : return getImplementationName_BasicProviderImpl();
178 : }
179 :
180 0 : sal_Bool BasicProviderImpl::supportsService( const OUString& rServiceName ) throw (RuntimeException, std::exception)
181 : {
182 0 : return cppu::supportsService(this, rServiceName);
183 : }
184 :
185 1 : Sequence< OUString > BasicProviderImpl::getSupportedServiceNames( ) throw (RuntimeException, std::exception)
186 : {
187 1 : return getSupportedServiceNames_BasicProviderImpl();
188 : }
189 :
190 :
191 : // XInitialization
192 :
193 :
194 31 : void BasicProviderImpl::initialize( const Sequence< Any >& aArguments ) throw (Exception, RuntimeException, std::exception)
195 : {
196 : // TODO
197 :
198 31 : SolarMutexGuard aGuard;
199 :
200 31 : if ( aArguments.getLength() != 1 )
201 : {
202 : throw IllegalArgumentException(
203 : "BasicProviderImpl::initialize: incorrect argument count.",
204 : *this,
205 : 1
206 0 : );
207 : }
208 :
209 62 : Reference< frame::XModel > xModel;
210 :
211 31 : m_xInvocationContext.set( aArguments[0], UNO_QUERY );
212 31 : if ( m_xInvocationContext.is() )
213 : {
214 0 : xModel.set( m_xInvocationContext->getScriptContainer(), UNO_QUERY );
215 0 : if ( !xModel.is() )
216 : {
217 : throw IllegalArgumentException(
218 : "BasicProviderImpl::initialize: unable to determine the document model from the script invocation context.",
219 : *this,
220 : 1
221 0 : );
222 : }
223 : }
224 : else
225 : {
226 31 : if ( !( aArguments[0] >>= m_sScriptingContext ) )
227 : {
228 : throw IllegalArgumentException(
229 0 : "BasicProviderImpl::initialize: incorrect argument type " + aArguments[0].getValueTypeName(),
230 : *this,
231 : 1
232 0 : );
233 : }
234 :
235 31 : OUString sDoc = "vnd.sun.star.tdoc";
236 31 : if ( m_sScriptingContext.startsWith( sDoc ) )
237 : {
238 31 : xModel = MiscUtils::tDocUrlToModel( m_sScriptingContext );
239 : // TODO: use ScriptingContantsPool for SCRIPTING_DOC_REF
240 31 : }
241 : }
242 :
243 31 : if ( xModel.is() )
244 : {
245 31 : Reference< XEmbeddedScripts > xDocumentScripts( xModel, UNO_QUERY );
246 31 : if ( xDocumentScripts.is() )
247 : {
248 31 : m_pDocBasicManager = ::basic::BasicManagerRepository::getDocumentBasicManager( xModel );
249 31 : m_xLibContainerDoc.set( xDocumentScripts->getBasicLibraries(), UNO_QUERY );
250 : OSL_ENSURE( m_pDocBasicManager && m_xLibContainerDoc.is(),
251 : "BasicProviderImpl::initialize: invalid BasicManager, or invalid script container!" );
252 : }
253 31 : m_bIsAppScriptCtx = false;
254 : }
255 : else
256 : {
257 : // Provider has been created with application context for user
258 : // or share
259 0 : if ( m_sScriptingContext != "user" )
260 : {
261 0 : m_bIsUserCtx = false;
262 : }
263 : else
264 : {
265 : /*
266 : throw RuntimeException(
267 : "BasicProviderImpl::initialize: no scripting context!" );
268 : */
269 : }
270 : }
271 :
272 : // TODO
273 31 : if ( !m_pAppBasicManager )
274 31 : m_pAppBasicManager = SfxApplication::GetBasicManager();
275 :
276 31 : if ( !m_xLibContainerApp.is() )
277 62 : m_xLibContainerApp = Reference< script::XLibraryContainer >( SfxGetpApp()->GetBasicContainer(), UNO_QUERY );
278 31 : }
279 :
280 :
281 :
282 : // XScriptProvider
283 :
284 :
285 80 : Reference < provider::XScript > BasicProviderImpl::getScript( const OUString& scriptURI )
286 : throw ( provider::ScriptFrameworkErrorException, RuntimeException, std::exception)
287 : {
288 : // TODO
289 :
290 80 : SolarMutexGuard aGuard;
291 :
292 80 : Reference< provider::XScript > xScript;
293 160 : Reference< uri::XUriReferenceFactory > xFac ( uri::UriReferenceFactory::create( m_xContext ) );
294 :
295 : Reference< uri::XUriReference > uriRef(
296 160 : xFac->parse( scriptURI ), UNO_QUERY );
297 :
298 160 : Reference < uri::XVndSunStarScriptUrl > sfUri( uriRef, UNO_QUERY );
299 :
300 80 : if ( !uriRef.is() || !sfUri.is() )
301 : {
302 0 : OUString errorMsg("BasicProviderImpl::getScript: failed to parse URI: ");
303 0 : errorMsg = errorMsg.concat( scriptURI );
304 : throw provider::ScriptFrameworkErrorException(
305 : errorMsg, Reference< XInterface >(),
306 : scriptURI, "Basic",
307 0 : provider::ScriptFrameworkErrorType::MALFORMED_URL );
308 : }
309 :
310 :
311 160 : OUString aDescription = sfUri->getName();
312 160 : OUString aLocation = sfUri->getParameter( OUString("location") );
313 :
314 80 : sal_Int32 nIndex = 0;
315 : // In some strange circumstances the Library name can have an
316 : // apparently illegal '.' in it ( in imported VBA )
317 :
318 80 : BasicManager* pBasicMgr = NULL;
319 80 : if ( aLocation == "document" )
320 : {
321 80 : pBasicMgr = m_pDocBasicManager;
322 : }
323 0 : else if ( aLocation == "application" )
324 : {
325 0 : pBasicMgr = m_pAppBasicManager;
326 : }
327 160 : OUString sProjectName;
328 80 : if ( pBasicMgr )
329 80 : sProjectName = pBasicMgr->GetName();
330 :
331 160 : OUString aLibrary;
332 80 : if ( !sProjectName.isEmpty() && aDescription.match( sProjectName ) )
333 : {
334 : OSL_TRACE("LibraryName %s is part of the url %s",
335 : OUStringToOString( sProjectName, RTL_TEXTENCODING_UTF8 ).getStr(),
336 : OUStringToOString( aDescription, RTL_TEXTENCODING_UTF8 ).getStr() );
337 73 : aLibrary = sProjectName;
338 73 : nIndex = sProjectName.getLength() + 1;
339 : }
340 : else
341 7 : aLibrary = aDescription.getToken( 0, (sal_Unicode)'.', nIndex );
342 160 : OUString aModule;
343 80 : if ( nIndex != -1 )
344 80 : aModule = aDescription.getToken( 0, (sal_Unicode)'.', nIndex );
345 160 : OUString aMethod;
346 80 : if ( nIndex != -1 )
347 80 : aMethod = aDescription.getToken( 0, (sal_Unicode)'.', nIndex );
348 :
349 80 : if ( !aLibrary.isEmpty() && !aModule.isEmpty() && !aMethod.isEmpty() && !aLocation.isEmpty() )
350 : {
351 :
352 80 : if ( pBasicMgr )
353 : {
354 80 : StarBASIC* pBasic = pBasicMgr->GetLib( aLibrary );
355 80 : if ( !pBasic )
356 : {
357 0 : sal_uInt16 nId = pBasicMgr->GetLibId( aLibrary );
358 0 : if ( nId != LIB_NOTFOUND )
359 : {
360 0 : pBasicMgr->LoadLib( nId );
361 0 : pBasic = pBasicMgr->GetLib( aLibrary );
362 : }
363 : }
364 80 : if ( pBasic )
365 : {
366 80 : SbModule* pModule = pBasic->FindModule( aModule );
367 80 : if ( pModule )
368 : {
369 80 : SbxArray* pMethods = pModule->GetMethods();
370 80 : if ( pMethods )
371 : {
372 80 : SbMethod* pMethod = static_cast< SbMethod* >( pMethods->Find( aMethod, SbxCLASS_METHOD ) );
373 80 : if ( pMethod && !pMethod->IsHidden() )
374 : {
375 80 : if ( m_pDocBasicManager == pBasicMgr )
376 80 : xScript = new BasicScriptImpl( aDescription, pMethod, *m_pDocBasicManager, m_xInvocationContext );
377 : else
378 0 : xScript = new BasicScriptImpl( aDescription, pMethod );
379 : }
380 : }
381 : }
382 : }
383 : }
384 : }
385 :
386 80 : if ( !xScript.is() )
387 : {
388 0 : OUStringBuffer aMessage;
389 0 : aMessage.appendAscii( "The following Basic script could not be found:\n" );
390 0 : aMessage.appendAscii( "library: '" ).append( aLibrary ).appendAscii( "'\n" );
391 0 : aMessage.appendAscii( "module: '" ).append( aModule ).appendAscii( "'\n" );
392 0 : aMessage.appendAscii( "method: '" ).append( aMethod ).appendAscii( "'\n" );
393 0 : aMessage.appendAscii( "location: '" ).append( aLocation ).appendAscii( "'\n" );
394 : throw provider::ScriptFrameworkErrorException(
395 : aMessage.makeStringAndClear(),
396 : Reference< XInterface >(),
397 : scriptURI, "Basic",
398 0 : provider::ScriptFrameworkErrorType::NO_SUCH_SCRIPT );
399 : }
400 :
401 160 : return xScript;
402 : }
403 :
404 :
405 : // XBrowseNode
406 :
407 :
408 0 : OUString BasicProviderImpl::getName( ) throw (RuntimeException, std::exception)
409 : {
410 0 : return OUString("Basic");
411 : }
412 :
413 :
414 :
415 0 : Sequence< Reference< browse::XBrowseNode > > BasicProviderImpl::getChildNodes( ) throw (RuntimeException, std::exception)
416 : {
417 0 : SolarMutexGuard aGuard;
418 :
419 0 : Reference< script::XLibraryContainer > xLibContainer;
420 0 : BasicManager* pBasicManager = NULL;
421 :
422 0 : if ( m_bIsAppScriptCtx )
423 : {
424 0 : xLibContainer = m_xLibContainerApp;
425 0 : pBasicManager = m_pAppBasicManager;
426 : }
427 : else
428 : {
429 0 : xLibContainer = m_xLibContainerDoc;
430 0 : pBasicManager = m_pDocBasicManager;
431 : }
432 :
433 0 : Sequence< Reference< browse::XBrowseNode > > aChildNodes;
434 :
435 0 : if ( pBasicManager && xLibContainer.is() )
436 : {
437 0 : Sequence< OUString > aLibNames = xLibContainer->getElementNames();
438 0 : sal_Int32 nLibCount = aLibNames.getLength();
439 0 : const OUString* pLibNames = aLibNames.getConstArray();
440 0 : aChildNodes.realloc( nLibCount );
441 0 : Reference< browse::XBrowseNode >* pChildNodes = aChildNodes.getArray();
442 0 : sal_Int32 childrenFound = 0;
443 :
444 0 : for ( sal_Int32 i = 0 ; i < nLibCount ; ++i )
445 : {
446 0 : bool bCreate = false;
447 0 : if ( m_bIsAppScriptCtx )
448 : {
449 0 : bool bShared = isLibraryShared( xLibContainer, pLibNames[i] );
450 0 : if ( ( m_bIsUserCtx && !bShared ) || ( !m_bIsUserCtx && bShared ) )
451 0 : bCreate = true;
452 : }
453 : else
454 : {
455 0 : bCreate = true;
456 : }
457 0 : if ( bCreate )
458 : {
459 0 : pChildNodes[childrenFound++] = static_cast< browse::XBrowseNode* >( new BasicLibraryNodeImpl(
460 0 : m_xContext, m_sScriptingContext, pBasicManager, xLibContainer, pLibNames[i], m_bIsAppScriptCtx ) );
461 : }
462 : }
463 :
464 0 : if ( childrenFound != nLibCount )
465 0 : aChildNodes.realloc( childrenFound );
466 : }
467 :
468 0 : return aChildNodes;
469 : }
470 :
471 :
472 :
473 0 : sal_Bool BasicProviderImpl::hasChildNodes( ) throw (RuntimeException, std::exception)
474 : {
475 0 : SolarMutexGuard aGuard;
476 :
477 0 : bool bReturn = false;
478 0 : Reference< script::XLibraryContainer > xLibContainer;
479 0 : if ( m_bIsAppScriptCtx )
480 : {
481 0 : xLibContainer = m_xLibContainerApp;
482 : }
483 : else
484 : {
485 0 : xLibContainer = m_xLibContainerDoc;
486 : }
487 0 : if ( xLibContainer.is() )
488 0 : bReturn = xLibContainer->hasElements();
489 :
490 0 : return bReturn;
491 : }
492 :
493 :
494 :
495 0 : sal_Int16 BasicProviderImpl::getType( ) throw (RuntimeException, std::exception)
496 : {
497 0 : SolarMutexGuard aGuard;
498 :
499 0 : return browse::BrowseNodeTypes::CONTAINER;
500 : }
501 :
502 :
503 : // component operations
504 :
505 :
506 32 : static Reference< XInterface > SAL_CALL create_BasicProviderImpl(
507 : Reference< XComponentContext > const & xContext )
508 : {
509 32 : return static_cast< lang::XTypeProvider * >( new BasicProviderImpl( xContext ) );
510 : }
511 :
512 :
513 :
514 : static struct ::cppu::ImplementationEntry s_component_entries [] =
515 : {
516 : {
517 : create_BasicProviderImpl, getImplementationName_BasicProviderImpl,
518 : getSupportedServiceNames_BasicProviderImpl, ::cppu::createSingleComponentFactory,
519 : 0, 0
520 : },
521 : { 0, 0, 0, 0, 0, 0 }
522 : };
523 :
524 :
525 :
526 :
527 : } // namespace basprov
528 :
529 :
530 :
531 :
532 : // component exports
533 :
534 :
535 : extern "C"
536 : {
537 5 : SAL_DLLPUBLIC_EXPORT void * SAL_CALL basprov_component_getFactory(
538 : const sal_Char * pImplName, void * pServiceManager,
539 : void * pRegistryKey )
540 : {
541 : return ::cppu::component_getFactoryHelper(
542 5 : pImplName, pServiceManager, pRegistryKey, ::basprov::s_component_entries );
543 : }
544 : }
545 :
546 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
