Files
libreoffice/scripting/source/protocolhandler/scripthandler.cxx
Rüdiger Timm 3bbb985ba7 INTEGRATION: CWS scriptingf10 (1.21.4); FILE MERGED
2005/01/24 17:50:14 toconnor 1.21.4.3: #i40429# clean up debug and exception handling
2005/01/12 14:03:57 toconnor 1.21.4.2: #i40429# remove OSL_TRACE calls before beta
2005/01/07 19:18:48 toconnor 1.21.4.1: #i39386# cannot execute script assigned to toolbar item of backing window
2005-01-27 14:31:10 +00:00

611 lines
20 KiB
C++

/*************************************************************************
*
* $RCSfile: scripthandler.cxx,v $
*
* $Revision: 1.22 $
*
* last change: $Author: rt $ $Date: 2005-01-27 15:31:10 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (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.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#include "scripthandler.hxx"
#include <osl/mutex.hxx>
#include <com/sun/star/frame/DispatchResultEvent.hpp>
#include <com/sun/star/frame/DispatchResultState.hpp>
#include <com/sun/star/frame/XController.hpp>
#include <com/sun/star/frame/XModel.hpp>
#include <com/sun/star/document/MacroExecMode.hpp>
#include <com/sun/star/lang/XSingleServiceFactory.hpp>
#include <com/sun/star/script/provider/XScriptProviderSupplier.hpp>
#include <com/sun/star/script/provider/XScriptProviderFactory.hpp>
#include <sfx2/objsh.hxx>
#include <sfx2/frame.hxx>
#include <sfx2/sfxdlg.hxx>
#include <vcl/abstdlg.hxx>
#include <cppuhelper/factory.hxx>
#include <util/util.hxx>
#include "com/sun/star/uno/XComponentContext.hpp"
#include "com/sun/star/uri/XUriReference.hpp"
#include "com/sun/star/uri/XUriReferenceFactory.hpp"
#include "com/sun/star/uri/XVndSunStarScriptUrl.hpp"
#include "com/sun/star/beans/XPropertySet.hpp"
using namespace ::com::sun::star;
using namespace ::com::sun::star::uno;
using namespace ::com::sun::star::frame;
using namespace ::com::sun::star::util;
using namespace ::com::sun::star::beans;
using namespace ::com::sun::star::lang;
using namespace ::com::sun::star::script;
using namespace ::scripting_util;
namespace scripting_protocolhandler
{
const sal_Char * const MYSERVICENAME = "com.sun.star.frame.ProtocolHandler";
const sal_Char * const MYIMPLNAME = "com.sun.star.comp.ScriptProtocolHandler";
const sal_Char * MYSCHEME = "vnd.sun.star.script";
const sal_Int32 MYSCHEME_LEN = 20;
void SAL_CALL ScriptProtocolHandler::initialize(
const css::uno::Sequence < css::uno::Any >& aArguments )
throw ( css::uno::Exception )
{
if ( m_bInitialised )
{
return ;
}
// first argument contains a reference to the frame (may be empty or the desktop,
// but usually it's a "real" frame)
if ( aArguments.getLength() &&
sal_False == ( aArguments[ 0 ] >>= m_xFrame ) )
{
::rtl::OUString temp = OUSTR( "ScriptProtocolHandler::initialize: could not extract reference to the frame" );
throw RuntimeException( temp, Reference< XInterface >() );
}
validateXRef( m_xFactory,
"ScriptProtocolHandler::initialize: No Service Manager available" );
m_bInitialised = true;
}
Reference< XDispatch > SAL_CALL ScriptProtocolHandler::queryDispatch(
const URL& aURL, const ::rtl::OUString& sTargetFrameName, sal_Int32 nSearchFlags )
throw( ::com::sun::star::uno::RuntimeException )
{
Reference< XDispatch > xDispatcher;
// get scheme of url
Reference< uri::XUriReferenceFactory > xFac (
m_xFactory->createInstance( rtl::OUString::createFromAscii(
"com.sun.star.uri.UriReferenceFactory") ) , UNO_QUERY );
if ( xFac.is() )
{
Reference< uri::XUriReference > uriRef(
xFac->parse( aURL.Complete ), UNO_QUERY );
if ( uriRef.is() )
{
if ( uriRef->getScheme().equals( ::rtl::OUString::createFromAscii( ::scripting_protocolhandler::MYSCHEME ) ) )
{
xDispatcher = this;
}
}
}
return xDispatcher;
}
Sequence< Reference< XDispatch > > SAL_CALL
ScriptProtocolHandler::queryDispatches(
const Sequence < DispatchDescriptor >& seqDescriptor )
throw( RuntimeException )
{
sal_Int32 nCount = seqDescriptor.getLength();
Sequence< Reference< XDispatch > > lDispatcher( nCount );
for ( sal_Int32 i = 0; i < nCount; ++i )
{
lDispatcher[ i ] = this->queryDispatch( seqDescriptor[ i ].FeatureURL,
seqDescriptor[ i ].FrameName,
seqDescriptor[ i ].SearchFlags );
}
return lDispatcher;
}
void SAL_CALL ScriptProtocolHandler::dispatchWithNotification(
const URL& aURL, const Sequence < PropertyValue >& lArgs,
const Reference< XDispatchResultListener >& xListener )
throw ( RuntimeException )
{
sal_Bool bSuccess = sal_False;
Any invokeResult;
bool bCaughtException = FALSE;
Any aException;
if ( m_bInitialised )
{
try
{
// obtain the SfxObject shell for our security check
SfxObjectShell* pDocShell = NULL;
if ( m_xFrame != NULL )
{
Reference < XFrame > xFrame( m_xFrame.get(), UNO_QUERY );
if ( xFrame.is() )
{
SfxFrame* pFrame = SfxFrame::GetFirst();
for ( ; pFrame; pFrame = SfxFrame::GetNext( *pFrame ) )
{
if ( pFrame->GetFrameInterface() == xFrame )
break;
}
if ( pFrame )
pDocShell = pFrame->GetCurrentDocument();
}
}
// Security check
if ( pDocShell && aURL.Complete.indexOf( ::rtl::OUString::createFromAscii("document") )!=-1 )
{
pDocShell->AdjustMacroMode( String() );
if ( pDocShell->GetMacroMode() ==
::com::sun::star::document::MacroExecMode::NEVER_EXECUTE )
{
return;
}
}
// Creates a ScriptProvider ( if one is not created allready )
createScriptProvider( aURL.Complete );
Reference< provider::XScript > xFunc =
m_xScriptProvider->getScript( aURL.Complete );
validateXRef( xFunc,
"ScriptProtocolHandler::dispatchWithNotification: validate xFunc - unable to obtain XScript interface" );
Sequence< Any > inArgs( 0 );
Sequence< Any > outArgs( 0 );
Sequence< sal_Int16 > outIndex;
if ( lArgs.getLength() > 0 )
{
int argCount = 0;
for ( int index = 0; index < lArgs.getLength(); index++ )
{
// Sometimes we get a propertyval with name = "Referer"
// this is not an argument to be passed to script, so
// ignore.
if ( lArgs[ index ].Name.compareToAscii("Referer") != 0 ||
lArgs[ index ].Name.getLength() == 0 )
{
inArgs.realloc( ++argCount );
inArgs[ index ] = lArgs[ index ].Value;
}
}
}
invokeResult = xFunc->invoke( inArgs, outIndex, outArgs );
bSuccess = sal_True;
}
// Office doesn't handle exceptions rethrown here very well, it cores,
// all we can is log them and then set fail for the dispatch event!
// (if there is a listener of course)
catch ( reflection::InvocationTargetException & ite )
{
::rtl::OUString reason = ::rtl::OUString::createFromAscii(
"ScriptProtocolHandler::dispatch: caught InvocationTargetException: " );
reason = reason.concat( ite.Message );
invokeResult <<= reason;
aException = makeAny( ite );
bCaughtException = TRUE;
}
catch ( provider::ScriptFrameworkErrorException& se )
{
::rtl::OUString reason = ::rtl::OUString::createFromAscii(
"ScriptProtocolHandler::dispatch: caught ScriptFrameworkErrorException: " );
reason = reason.concat( se.Message );
invokeResult <<= reason;
aException = makeAny( se );
bCaughtException = TRUE;
}
catch ( ::com::sun::star::uno::RuntimeException& rte )
{
::rtl::OUString reason = ::rtl::OUString::createFromAscii(
"ScriptProtocolHandler::dispatch: caught RuntimeException: " );
reason = reason.concat( rte.Message );
invokeResult <<= reason;
aException = makeAny( rte );
bCaughtException = TRUE;
}
catch ( Exception & e )
{
::rtl::OUString reason = ::rtl::OUString::createFromAscii(
"ScriptProtocolHandler::dispatch: caught Exception: " );
reason = reason.concat( e.Message );
invokeResult <<= reason;
aException = makeAny( e );
bCaughtException = TRUE;
}
#ifdef _DEBUG
catch ( ... )
{
::rtl::OUString reason = ::rtl::OUString::createFromAscii(
"ScriptProtocolHandler::dispatch: caught unknown exception" );
invokeResult <<= reason;
}
#endif
}
else
{
::rtl::OUString reason = ::rtl::OUString::createFromAscii(
"ScriptProtocolHandler::dispatchWithNotification failed, ScriptProtocolHandler not initialised"
);
invokeResult <<= reason;
}
if ( bCaughtException )
{
SfxAbstractDialogFactory* pFact = SfxAbstractDialogFactory::Create();
if ( pFact != NULL )
{
VclAbstractDialog* pDlg =
pFact->CreateScriptErrorDialog( NULL, aException );
if ( pDlg != NULL )
{
pDlg->Execute();
delete pDlg;
}
}
}
if ( xListener.is() )
{
// always call dispatchFinished(), because we didn't load a document but
// executed a macro instead!
::com::sun::star::frame::DispatchResultEvent aEvent;
aEvent.Source = static_cast< ::cppu::OWeakObject* >( this );
aEvent.Result = invokeResult;
if ( bSuccess )
{
aEvent.State = ::com::sun::star::frame::DispatchResultState::SUCCESS;
}
else
{
aEvent.State = ::com::sun::star::frame::DispatchResultState::FAILURE;
}
try
{
xListener->dispatchFinished( aEvent ) ;
}
catch(RuntimeException & e)
{
OSL_TRACE(
"ScriptProtocolHandler::dispatchWithNotification: caught RuntimeException"
"while dispatchFinished %s",
::rtl::OUStringToOString( e.Message,
RTL_TEXTENCODING_ASCII_US ).pData->buffer );
}
}
}
void SAL_CALL ScriptProtocolHandler::dispatch(
const URL& aURL, const Sequence< PropertyValue >& lArgs )
throw ( RuntimeException )
{
dispatchWithNotification( aURL, lArgs, Reference< XDispatchResultListener >() );
}
void SAL_CALL ScriptProtocolHandler::addStatusListener(
const Reference< XStatusListener >& xControl, const URL& aURL )
throw ( RuntimeException )
{
// implement if status is supported
}
void SAL_CALL ScriptProtocolHandler::removeStatusListener(
const Reference< XStatusListener >& xControl, const URL& aURL )
throw ( RuntimeException )
{}
void
ScriptProtocolHandler::createScriptProvider( const ::rtl::OUString& url )
throw ( RuntimeException )
{
if ( m_xScriptProvider.is() )
{
return;
}
try
{
css::uno::Sequence < css::uno::Any > args( 1 );
Reference< XModel > xModel;
if ( m_xFrame.is() )
{
Reference< XController > xController = m_xFrame->getController();
if ( xController .is() )
{
xModel = xController->getModel();
args[ 0 ] <<= xModel;
Reference< provider::XScriptProviderSupplier > xSPS =
Reference< provider::XScriptProviderSupplier >
( xModel, UNO_QUERY );
if ( xSPS.is() )
{
m_xScriptProvider = xSPS->getScriptProvider();
}
}
}
if ( !m_xScriptProvider.is() )
{
Reference< XPropertySet > xProps( m_xFactory, UNO_QUERY_THROW );
::rtl::OUString dc(
RTL_CONSTASCII_USTRINGPARAM( "DefaultContext" ) );
Reference< XComponentContext > xCtx(
xProps->getPropertyValue( dc ), UNO_QUERY_THROW );
::rtl::OUString tmspf = ::rtl::OUString::createFromAscii(
"/singletons/com.sun.star.script.provider.theMasterScriptProviderFactory");
Reference< provider::XScriptProviderFactory > xFac(
xCtx->getValueByName( tmspf ), UNO_QUERY_THROW );
Any aContext;
m_xScriptProvider = Reference< provider::XScriptProvider > (
xFac->createScriptProvider( aContext ), UNO_QUERY_THROW );
}
}
catch ( RuntimeException & e )
{
::rtl::OUString temp = OUSTR( "ScriptProtocolHandler::createScriptProvider(), " );
throw RuntimeException( temp.concat( e.Message ), Reference< XInterface >() );
}
catch ( Exception & e )
{
::rtl::OUString temp = OUSTR( "ScriptProtocolHandler::createScriptProvider: " );
throw RuntimeException( temp.concat( e.Message ), Reference< XInterface >() );
}
#ifdef _DEBUG
catch ( ... )
{
throw RuntimeException(
OUSTR( "ScriptProtocolHandler::createScriptProvider: UnknownException: " ),
Reference< XInterface > () );
}
#endif
}
ScriptProtocolHandler::ScriptProtocolHandler(
Reference< css::lang::XMultiServiceFactory > const& rFact ) :
m_bInitialised( false ), m_xFactory( rFact )
{
}
ScriptProtocolHandler::~ScriptProtocolHandler()
{
}
/* XServiceInfo */
::rtl::OUString SAL_CALL ScriptProtocolHandler::getImplementationName( )
throw( RuntimeException )
{
return impl_getStaticImplementationName();
}
/* XServiceInfo */
sal_Bool SAL_CALL ScriptProtocolHandler::supportsService(
const ::rtl::OUString& sServiceName )
throw( RuntimeException )
{
Sequence< ::rtl::OUString > seqServiceNames = getSupportedServiceNames();
const ::rtl::OUString* pArray = seqServiceNames.getConstArray();
for ( sal_Int32 nCounter = 0; nCounter < seqServiceNames.getLength(); nCounter++ )
{
if ( pArray[ nCounter ] == sServiceName )
{
return sal_True ;
}
}
return sal_False ;
}
/* XServiceInfo */
Sequence< ::rtl::OUString > SAL_CALL ScriptProtocolHandler::getSupportedServiceNames()
throw( RuntimeException )
{
return impl_getStaticSupportedServiceNames();
}
/* Helper for XServiceInfo */
Sequence< ::rtl::OUString > ScriptProtocolHandler::impl_getStaticSupportedServiceNames()
{
::osl::MutexGuard aGuard( ::osl::Mutex::getGlobalMutex() );
Sequence< ::rtl::OUString > seqServiceNames( 1 );
seqServiceNames.getArray() [ 0 ] =
::rtl::OUString::createFromAscii( ::scripting_protocolhandler::MYSERVICENAME );
return seqServiceNames ;
}
/* Helper for XServiceInfo */
::rtl::OUString ScriptProtocolHandler::impl_getStaticImplementationName()
{
return ::rtl::OUString::createFromAscii( ::scripting_protocolhandler::MYIMPLNAME );
}
/* Helper for registry */
Reference< XInterface > SAL_CALL ScriptProtocolHandler::impl_createInstance(
const Reference< css::lang::XMultiServiceFactory >& xServiceManager )
throw( RuntimeException )
{
return Reference< XInterface > ( *new ScriptProtocolHandler( xServiceManager ) );
}
/* Factory for registration */
Reference< XSingleServiceFactory > ScriptProtocolHandler::impl_createFactory(
const Reference< XMultiServiceFactory >& xServiceManager )
{
Reference< XSingleServiceFactory > xReturn (
cppu::createSingleFactory( xServiceManager,
ScriptProtocolHandler::impl_getStaticImplementationName(),
ScriptProtocolHandler::impl_createInstance,
ScriptProtocolHandler::impl_getStaticSupportedServiceNames() )
);
return xReturn;
}
} // namespace scripting_protocolhandler
/* exported functions for registration */
extern "C"
{
void SAL_CALL component_getImplementationEnvironment(
const sal_Char** ppEnvironmentTypeName, uno_Environment** ppEnvironment )
{
*ppEnvironmentTypeName = CPPU_CURRENT_LANGUAGE_BINDING_NAME ;
}
sal_Bool SAL_CALL component_writeInfo( void * pServiceManager ,
void * pRegistryKey )
{
Reference< css::registry::XRegistryKey > xKey(
reinterpret_cast< css::registry::XRegistryKey* >( pRegistryKey ) ) ;
::rtl::OUString aStr = ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "/" ) );
aStr +=
::scripting_protocolhandler::ScriptProtocolHandler::impl_getStaticImplementationName();
aStr += ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "/UNO/SERVICES" ) );
Reference< css::registry::XRegistryKey > xNewKey = xKey->createKey( aStr );
xNewKey->createKey(
::rtl::OUString::createFromAscii( ::scripting_protocolhandler::MYSERVICENAME )
);
return sal_True;
}
void* SAL_CALL component_getFactory( const sal_Char * pImplementationName ,
void * pServiceManager ,
void * pRegistryKey )
{
// Set default return value for this operation - if it failed.
void * pReturn = NULL ;
if (
( pImplementationName != NULL ) &&
( pServiceManager != NULL )
)
{
// Define variables which are used in following macros.
::com::sun::star::uno::Reference<
::com::sun::star::lang::XSingleServiceFactory > xFactory ;
::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >
xServiceManager( reinterpret_cast<
::com::sun::star::lang::XMultiServiceFactory* >( pServiceManager ) ) ;
if ( ::scripting_protocolhandler::ScriptProtocolHandler::impl_getStaticImplementationName().equals(
::rtl::OUString::createFromAscii( pImplementationName ) ) )
{
xFactory = ::scripting_protocolhandler::ScriptProtocolHandler::impl_createFactory( xServiceManager );
}
// Factory is valid - service was found.
if ( xFactory.is() )
{
xFactory->acquire();
pReturn = xFactory.get();
}
}
// Return with result of this operation.
return pReturn ;
}
} // extern "C"