svx/source/form/fmscriptingenv.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #include "fmscriptingenv.hxx"
  30 #include "svx/fmmodel.hxx"
  31
  32 /** === begin UNO includes === **/
  33 #include <com/sun/star/lang/IllegalArgumentException.hpp>
  34 #include <com/sun/star/script/XScriptListener.hpp>
  35 #include <com/sun/star/container/XHierarchicalNameAccess.hpp>
  36 #include <com/sun/star/reflection/XInterfaceMethodTypeDescription.hpp>
  37 #include <com/sun/star/lang/DisposedException.hpp>
  38 #include <com/sun/star/lang/EventObject.hpp>
  39 #include <com/sun/star/awt/XControl.hpp>
  40 /** === end UNO includes === **/
  41
  42 #include <tools/diagnose_ex.h>
  43 #include <cppuhelper/implbase1.hxx>
  44 #include <comphelper/implementationreference.hxx>
  45 #include <comphelper/componentcontext.hxx>
  46 #include <comphelper/processfactory.hxx>
  47 #include <vcl/svapp.hxx>
  48 #include <osl/mutex.hxx>
  49 #include <sfx2/objsh.hxx>
  50 #include <sfx2/app.hxx>
  51 #include <basic/basmgr.hxx>
  52
  53 #include <boost/shared_ptr.hpp>
  54
  55 //........................................................................
  56 namespace svxform
  57 {
  58 //........................................................................
  59
  60     /** === begin UNO using === **/
  61     using ::com::sun::star::uno::Reference;
  62     using ::com::sun::star::script::XEventAttacherManager;
  63     using ::com::sun::star::lang::IllegalArgumentException;
  64     using ::com::sun::star::script::XScriptListener;
  65     using ::com::sun::star::script::ScriptEvent;
  66     using ::com::sun::star::uno::RuntimeException;
  67     using ::com::sun::star::lang::EventObject;
  68     using ::com::sun::star::reflection::InvocationTargetException;
  69     using ::com::sun::star::uno::Any;
  70     using ::com::sun::star::container::XHierarchicalNameAccess;
  71     using ::com::sun::star::reflection::XInterfaceMethodTypeDescription;
  72     using ::com::sun::star::uno::UNO_QUERY_THROW;
  73     using ::com::sun::star::lang::DisposedException;
  74     using ::com::sun::star::uno::RuntimeException;
  75     using ::com::sun::star::uno::Exception;
  76     using ::com::sun::star::uno::Sequence;
  77     using ::com::sun::star::uno::XInterface;
  78     using ::com::sun::star::lang::EventObject;
  79     using ::com::sun::star::awt::XControl;
  80     using ::com::sun::star::beans::XPropertySet;
  81     /** === end UNO using === **/
  82
  83     class FormScriptingEnvironment;
  84
  85     //====================================================================
  86     //= FormScriptListener
  87     //====================================================================
  88     typedef ::cppu::WeakImplHelper1 <   XScriptListener
  89                                     >   FormScriptListener_Base;
  90
  91     /** implements the XScriptListener interface, is used by FormScriptingEnvironment
  92     */
  93     class FormScriptListener    :public FormScriptListener_Base
  94     {
  95     private:
  96         ::osl::Mutex m_aMutex;
  97         FormScriptingEnvironment *m_pScriptExecutor;
  98
  99     public:
 100         FormScriptListener( FormScriptingEnvironment * pScriptExecutor );
 101
 102         // XScriptListener
 103         virtual void SAL_CALL firing( const ScriptEvent& aEvent ) throw (RuntimeException);
 104         virtual Any SAL_CALL approveFiring( const ScriptEvent& aEvent ) throw (InvocationTargetException, RuntimeException);
 105         // XEventListener
 106         virtual void SAL_CALL disposing( const EventObject& Source ) throw (RuntimeException);
 107
 108         // lifetime control
 109         void SAL_CALL dispose();
 110
 111     protected:
 112         ~FormScriptListener();
 113
 114     private:
 115         /** determines whether calling a given method at a given listener interface can be done asynchronously
 116
 117             @param _rListenerType
 118                 the name of the UNO type whose method is to be checked
 119             @param _rMethodName
 120                 the name of the method at the interface determined by _rListenerType
 121
 122             @return
 123                 <TRUE/> if and only if the method is declared <code>oneway</code>, i.e. can be called asynchronously
 124         */
 125         bool    impl_allowAsynchronousCall_nothrow( const ::rtl::OUString& _rListenerType, const ::rtl::OUString& _rMethodName ) const;
 126
 127         /** determines whether the instance is already disposed
 128         */
 129         bool    impl_isDisposed_nothrow() const { return !m_pScriptExecutor; }
 130
 131         /** fires the given script event in a thread-safe manner
 132
 133             This methods calls our script executor's doFireScriptEvent, with previously releasing the given mutex guard,
 134             but ensuring that our script executor is not deleted between this release and the actual call.
 135
 136             @param _rGuard
 137                 a clearable guard to our mutex. Must be the only active guard to our mutex.
 138             @param _rEvent
 139                 the event to fire
 140             @param _pSyncronousResult
 141                 a place to take a possible result of the script call.
 142
 143             @precond
 144                 m_pScriptExecutor is not <NULL/>.
 145         */
 146         void    impl_doFireScriptEvent_nothrow( ::osl::ClearableMutexGuard& _rGuard, const ScriptEvent& _rEvent, Any* _pSyncronousResult );
 147
 148     private:
 149         DECL_LINK( OnAsyncScriptEvent, ScriptEvent* );
 150     };
 151
 152     //====================================================================
 153     //= FormScriptingEnvironment
 154     //====================================================================
 155     class FormScriptingEnvironment : public IFormScriptingEnvironment
 156     {
 157     private:
 158         typedef ::comphelper::ImplementationReference< FormScriptListener, XScriptListener >    ListenerImplementation;
 159
 160     private:
 161         ::osl::Mutex            m_aMutex;
 162         oslInterlockedCount     m_refCount;
 163         ListenerImplementation  m_pScriptListener;
 164         FmFormModel&            m_rFormModel;
 165         bool                    m_bDisposed;
 166
 167     public:
 168         FormScriptingEnvironment( FmFormModel& _rModel );
 169         virtual ~FormScriptingEnvironment();
 170
 171         // callback for FormScriptListener
 172         void doFireScriptEvent( const ScriptEvent& _rEvent, Any* _pSyncronousResult );
 173
 174         // IFormScriptingEnvironment
 175         virtual void registerEventAttacherManager( const Reference< XEventAttacherManager >& _rxManager );
 176         virtual void revokeEventAttacherManager( const Reference< XEventAttacherManager >& _rxManager );
 177         virtual void dispose();
 178
 179         // IReference
 180         virtual oslInterlockedCount SAL_CALL acquire();
 181         virtual oslInterlockedCount SAL_CALL release();
 182
 183     private:
 184         void impl_registerOrRevoke_throw( const Reference< XEventAttacherManager >& _rxManager, bool _bRegister );
 185
 186     private:
 187         FormScriptingEnvironment();                                                 // never implemented
 188         FormScriptingEnvironment( const FormScriptingEnvironment& );                // never implemented
 189         FormScriptingEnvironment& operator=( const FormScriptingEnvironment& );     // never implemented
 190     };
 191
 192     //====================================================================
 193     //= FormScriptListener
 194     //====================================================================
 195     //--------------------------------------------------------------------
 196     FormScriptListener::FormScriptListener( FormScriptingEnvironment* pScriptExecutor )
 197         :m_pScriptExecutor( pScriptExecutor )
 198     {
 199     }
 200
 201     //--------------------------------------------------------------------
 202     FormScriptListener::~FormScriptListener()
 203     {
 204     }
 205
 206     //--------------------------------------------------------------------
 207     bool FormScriptListener::impl_allowAsynchronousCall_nothrow( const ::rtl::OUString& _rListenerType, const ::rtl::OUString& _rMethodName ) const
 208     {
 209         bool bAllowAsynchronousCall = false;
 210         try
 211         {
 212             ::comphelper::ComponentContext aContext( ::comphelper::getProcessServiceFactory() );
 213             Reference< XHierarchicalNameAccess > xTypeDescriptions( aContext.getSingleton( "com.sun.star.reflection.theTypeDescriptionManager" ), UNO_QUERY_THROW );
 214
 215             ::rtl::OUString sMethodDescription( _rListenerType );
 216             sMethodDescription += ::rtl::OUString(RTL_CONSTASCII_USTRINGPARAM( "::" ));
 217             sMethodDescription += _rMethodName;
 218
 219             Reference< XInterfaceMethodTypeDescription > xMethod( xTypeDescriptions->getByHierarchicalName( sMethodDescription ), UNO_QUERY_THROW );
 220             bAllowAsynchronousCall = xMethod->isOneway();
 221         }
 222         catch( const Exception& )
 223         {
 224             DBG_UNHANDLED_EXCEPTION();
 225         }
 226         return bAllowAsynchronousCall;
 227     }
 228
 229     //--------------------------------------------------------------------
 230     void FormScriptListener::impl_doFireScriptEvent_nothrow( ::osl::ClearableMutexGuard& _rGuard, const ScriptEvent& _rEvent, Any* _pSyncronousResult )
 231     {
 232         OSL_PRECOND( m_pScriptExecutor, "FormScriptListener::impl_doFireScriptEvent_nothrow: this will crash!" );
 233
 234         _rGuard.clear();
 235         m_pScriptExecutor->doFireScriptEvent( _rEvent, _pSyncronousResult );
 236     }
 237
 238     //--------------------------------------------------------------------
 239     void SAL_CALL FormScriptListener::firing( const ScriptEvent& _rEvent ) throw (RuntimeException)
 240     {
 241         ::osl::ClearableMutexGuard aGuard( m_aMutex );
 242        static const ::rtl::OUString vbaInterOp( RTL_CONSTASCII_USTRINGPARAM("VBAInterop") );
 243        if ( _rEvent.ScriptType.equals(vbaInterOp) )
 244            return; // not handled here
 245
 246         if ( impl_isDisposed_nothrow() )
 247             return;
 248
 249         if ( !impl_allowAsynchronousCall_nothrow( _rEvent.ListenerType.getTypeName(), _rEvent.MethodName ) )
 250         {
 251             impl_doFireScriptEvent_nothrow( aGuard, _rEvent, NULL );
 252             return;
 253         }
 254
 255         acquire();
 256         Application::PostUserEvent( LINK( this, FormScriptListener, OnAsyncScriptEvent ), new ScriptEvent( _rEvent ) );
 257     }
 258
 259     //--------------------------------------------------------------------
 260     Any SAL_CALL FormScriptListener::approveFiring( const ScriptEvent& _rEvent ) throw (InvocationTargetException, RuntimeException)
 261     {
 262         Any aResult;
 263
 264         ::osl::ClearableMutexGuard aGuard( m_aMutex );
 265         if ( !impl_isDisposed_nothrow() )
 266             impl_doFireScriptEvent_nothrow( aGuard, _rEvent, &aResult );
 267
 268         return aResult;
 269     }
 270
 271     //--------------------------------------------------------------------
 272     void SAL_CALL FormScriptListener::disposing( const EventObject& /*Source*/ ) throw (RuntimeException)
 273     {
 274         // not interested in
 275     }
 276
 277     //--------------------------------------------------------------------
 278     void SAL_CALL FormScriptListener::dispose()
 279     {
 280         ::osl::MutexGuard aGuard( m_aMutex );
 281         m_pScriptExecutor = NULL;
 282     }
 283
 284     //--------------------------------------------------------------------
 285     IMPL_LINK( FormScriptListener, OnAsyncScriptEvent, ScriptEvent*, _pEvent )
 286     {
 287         OSL_PRECOND( _pEvent != NULL, "FormScriptListener::OnAsyncScriptEvent: invalid event!" );
 288         if ( !_pEvent )
 289             return 1L;
 290
 291         {
 292             ::osl::ClearableMutexGuard aGuard( m_aMutex );
 293
 294             if ( !impl_isDisposed_nothrow() )
 295                 impl_doFireScriptEvent_nothrow( aGuard, *_pEvent, NULL );
 296         }
 297
 298         delete _pEvent;
 299         // we acquired ourself immediately before posting the event
 300         release();
 301         return 0L;
 302     }
 303
 304     //====================================================================
 305     //= FormScriptingEnvironment
 306     //====================================================================
 307     //--------------------------------------------------------------------
 308     FormScriptingEnvironment::FormScriptingEnvironment( FmFormModel& _rModel )
 309         :m_refCount( 0 )
 310         ,m_pScriptListener( NULL )
 311         ,m_rFormModel( _rModel )
 312         ,m_bDisposed( false )
 313     {
 314         m_pScriptListener = ListenerImplementation( new FormScriptListener( this ) );
 315         // note that this is a cyclic reference between the FormScriptListener and the FormScriptingEnvironment
 316         // This cycle is broken up when our instance is disposed.
 317     }
 318
 319     //--------------------------------------------------------------------
 320     FormScriptingEnvironment::~FormScriptingEnvironment()
 321     {
 322     }
 323
 324     //--------------------------------------------------------------------
 325     void FormScriptingEnvironment::impl_registerOrRevoke_throw( const Reference< XEventAttacherManager >& _rxManager, bool _bRegister )
 326     {
 327         ::osl::MutexGuard aGuard( m_aMutex );
 328
 329         if ( !_rxManager.is() )
 330             throw IllegalArgumentException();
 331         if ( m_bDisposed )
 332             throw DisposedException();
 333
 334         try
 335         {
 336             if ( _bRegister )
 337                 _rxManager->addScriptListener( m_pScriptListener.getRef() );
 338             else
 339                 _rxManager->removeScriptListener( m_pScriptListener.getRef() );
 340         }
 341         catch( const RuntimeException& ) { throw; }
 342         catch( const Exception& )
 343         {
 344             DBG_UNHANDLED_EXCEPTION();
 345         }
 346     }
 347
 348     //--------------------------------------------------------------------
 349     void FormScriptingEnvironment::registerEventAttacherManager( const Reference< XEventAttacherManager >& _rxManager )
 350     {
 351         impl_registerOrRevoke_throw( _rxManager, true );
 352     }
 353
 354     //--------------------------------------------------------------------
 355     void FormScriptingEnvironment::revokeEventAttacherManager( const Reference< XEventAttacherManager >& _rxManager )
 356     {
 357         impl_registerOrRevoke_throw( _rxManager, false );
 358     }
 359
 360     //--------------------------------------------------------------------
 361     oslInterlockedCount SAL_CALL FormScriptingEnvironment::acquire()
 362     {
 363         return osl_incrementInterlockedCount( &m_refCount );
 364     }
 365
 366     //--------------------------------------------------------------------
 367     oslInterlockedCount SAL_CALL FormScriptingEnvironment::release()
 368     {
 369         if ( 0 == osl_decrementInterlockedCount( &m_refCount ) )
 370         {
 371            delete this;
 372            return 0;
 373         }
 374         return m_refCount;
 375     }
 376
 377     //--------------------------------------------------------------------
 378     IFormScriptingEnvironment::~IFormScriptingEnvironment()
 379     {
 380     }
 381
 382     //--------------------------------------------------------------------
 383     namespace
 384     {
 385         //................................................................
 386         //. NewStyleUNOScript
 387         //................................................................
 388         class SAL_NO_VTABLE IScript
 389         {
 390         public:
 391             virtual void invoke( const Sequence< Any >& _rArguments, Any& _rSynchronousResult ) = 0;
 392
 393             virtual ~IScript() { }
 394         };
 395         typedef ::boost::shared_ptr< IScript >  PScript;
 396
 397         //................................................................
 398         //. NewStyleUNOScript
 399         //................................................................
 400         class NewStyleUNOScript : public IScript
 401         {
 402             SfxObjectShell&         m_rObjectShell;
 403             const ::rtl::OUString   m_sScriptCode;
 404
 405         public:
 406             NewStyleUNOScript( SfxObjectShell& _rObjectShell, const ::rtl::OUString& _rScriptCode )
 407                 :m_rObjectShell( _rObjectShell )
 408                 ,m_sScriptCode( _rScriptCode )
 409             {
 410             }
 411
 412             // IScript
 413             virtual void invoke( const Sequence< Any >& _rArguments, Any& _rSynchronousResult );
 414         };
 415
 416         //................................................................
 417         void NewStyleUNOScript::invoke( const Sequence< Any >& _rArguments, Any& _rSynchronousResult )
 418         {
 419             Sequence< sal_Int16 > aOutArgsIndex;
 420             Sequence< Any > aOutArgs;
 421             EventObject aEvent;
 422             Any aCaller;
 423             if ( ( _rArguments.getLength() > 0 ) && ( _rArguments[ 0 ] >>= aEvent ) )
 424             {
 425                 try
 426                 {
 427                     Reference< XControl > xControl( aEvent.Source, UNO_QUERY_THROW );
 428                     Reference< XPropertySet > xProps( xControl->getModel(), UNO_QUERY_THROW );
 429                     aCaller = xProps->getPropertyValue( rtl::OUString( RTL_CONSTASCII_USTRINGPARAM("Name") ) );
 430                 }
 431                 catch( Exception& ) {}
 432             }
 433             m_rObjectShell.CallXScript( m_sScriptCode, _rArguments, _rSynchronousResult, aOutArgsIndex, aOutArgs, true, aCaller.hasValue() ? &aCaller : 0 );
 434         }
 435     }
 436
 437     //--------------------------------------------------------------------
 438     void FormScriptingEnvironment::doFireScriptEvent( const ScriptEvent& _rEvent, Any* _pSyncronousResult )
 439     {
 440 #ifdef DISABLE_SCRIPTING
 441         (void) _rEvent;
 442         (void) _pSyncronousResult;
 443 #else
 444         SolarMutexClearableGuard aSolarGuard;
 445         ::osl::ClearableMutexGuard aGuard( m_aMutex );
 446
 447         if ( m_bDisposed )
 448             return;
 449
 450         // SfxObjectShellRef is good here since the model controls the lifetime of the object
 451         SfxObjectShellRef xObjectShell = m_rFormModel.GetObjectShell();
 452         if( !xObjectShell.Is() )
 453             return;
 454
 455         // the script to execute
 456         PScript pScript;
 457
 458         if ( _rEvent.ScriptType != "StarBasic" )
 459         {
 460             pScript.reset( new NewStyleUNOScript( *xObjectShell, _rEvent.ScriptCode ) );
 461         }
 462         else
 463         {
 464             ::rtl::OUString sScriptCode = _rEvent.ScriptCode;
 465             ::rtl::OUString sMacroLocation;
 466
 467             // is there a location in the script name ("application" or "document")?
 468             sal_Int32 nPrefixLen = sScriptCode.indexOf( ':' );
 469             DBG_ASSERT( 0 <= nPrefixLen, "FormScriptingEnvironment::doFireScriptEvent: Basic script name in old format encountered!" );
 470
 471             if ( 0 <= nPrefixLen )
 472             {
 473                 // and it has such a prefix
 474                 sMacroLocation = sScriptCode.copy( 0, nPrefixLen );
 475                 DBG_ASSERT( 0 == sMacroLocation.compareToAscii( "document" )
 476                         ||  0 == sMacroLocation.compareToAscii( "application" ),
 477                         "FormScriptingEnvironment::doFireScriptEvent: invalid (unknown) prefix!" );
 478
 479                 // strip the prefix: the SfxObjectShell::CallScript knows nothing about such prefixes
 480                 sScriptCode = sScriptCode.copy( nPrefixLen + 1 );
 481             }
 482
 483             if ( sMacroLocation.isEmpty() )
 484             {
 485                 // legacy format: use the app-wide Basic, if it has a respective method, otherwise fall back to the doc's Basic
 486                 if ( SFX_APP()->GetBasicManager()->HasMacro( sScriptCode ) )
 487                     sMacroLocation = ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "application" ) );
 488                 else
 489                     sMacroLocation = ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "document" ) );
 490             }
 491
 492             ::rtl::OUStringBuffer aScriptURI;
 493             aScriptURI.appendAscii( "vnd.sun.star.script:" );
 494             aScriptURI.append( sScriptCode );
 495             aScriptURI.appendAscii( "?language=Basic" );
 496             aScriptURI.appendAscii( "&location=" );
 497             aScriptURI.append( sMacroLocation );
 498
 499             const ::rtl::OUString sScriptURI( aScriptURI.makeStringAndClear() );
 500             pScript.reset( new NewStyleUNOScript( *xObjectShell, sScriptURI ) );
 501         }
 502
 503         OSL_ENSURE( pScript.get(), "FormScriptingEnvironment::doFireScriptEvent: no script to execute!" );
 504         if ( !pScript.get() )
 505             // this is an internal error in the above code
 506             throw RuntimeException();
 507
 508         aGuard.clear();
 509         aSolarGuard.clear();
 510
 511         Any aIgnoreResult;
 512         pScript->invoke( _rEvent.Arguments, _pSyncronousResult ? *_pSyncronousResult : aIgnoreResult );
 513         pScript.reset();
 514
 515         {
 516             // object shells are not thread safe, so guard the destruction
 517             SolarMutexGuard aSolarGuarsReset;
 518             xObjectShell = NULL;
 519         }
 520 #endif
 521     }
 522
 523     //--------------------------------------------------------------------
 524     void FormScriptingEnvironment::dispose()
 525     {
 526         ::osl::MutexGuard aGuard( m_aMutex );
 527         m_bDisposed = true;
 528         m_pScriptListener->dispose();
 529     }
 530
 531     //--------------------------------------------------------------------
 532     PFormScriptingEnvironment createDefaultFormScriptingEnvironment( FmFormModel& _rModel )
 533     {
 534         return new FormScriptingEnvironment( _rModel );
 535     }
 536
 537 //........................................................................
 538 } // namespace svxform
 539 //........................................................................
 540
 541 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */