basic/source/classes/eventatt.cxx

   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
  21 #include <osl/mutex.hxx>
  22 #include <comphelper/processfactory.hxx>
  23 #include <comphelper/string.hxx>
  24
  25 #include <com/sun/star/awt/XControlContainer.hpp>
  26 #include <com/sun/star/awt/XControlModel.hpp>
  27 #include <com/sun/star/awt/XControl.hpp>
  28 #include <com/sun/star/awt/XDialog.hpp>
  29 #include <com/sun/star/awt/XWindow.hpp>
  30 #include <com/sun/star/awt/DialogProvider.hpp>
  31 #include <com/sun/star/beans/XPropertySet.hpp>
  32 #include <com/sun/star/container/XEnumerationAccess.hpp>
  33 #include <com/sun/star/container/XNameContainer.hpp>
  34 #include <com/sun/star/frame/XModel.hpp>
  35 #include <com/sun/star/frame/Desktop.hpp>
  36 #include <com/sun/star/resource/XStringResourceSupplier.hpp>
  37 #include <com/sun/star/resource/XStringResourceManager.hpp>
  38 #include <com/sun/star/script/XEventAttacher.hpp>
  39 #include <com/sun/star/script/XAllListener.hpp>
  40 #include <com/sun/star/script/XScriptEventsSupplier.hpp>
  41 #include <com/sun/star/script/XScriptEventsAttacher.hpp>
  42 #include <com/sun/star/script/ScriptEventDescriptor.hpp>
  43 #include <com/sun/star/script/XLibraryContainer.hpp>
  44 #include <com/sun/star/script/provider/theMasterScriptProviderFactory.hpp>
  45 #include <com/sun/star/script/provider/XScriptProviderSupplier.hpp>
  46 #include <com/sun/star/script/provider/XScriptProvider.hpp>
  47
  48 #include <basic/basicmanagerrepository.hxx>
  49 #include <basic/basmgr.hxx>
  50 //==================================================================================================
  51
  52 #include <xmlscript/xmldlg_imexp.hxx>
  53 #include <sbunoobj.hxx>
  54 #include <basic/sbstar.hxx>
  55 #include <basic/sbmeth.hxx>
  56 #include <basic/sbuno.hxx>
  57 #include <runtime.hxx>
  58 #include <sbintern.hxx>
  59
  60
  61 #include <cppuhelper/implbase1.hxx>
  62 using namespace ::com::sun::star;
  63 using namespace ::com::sun::star::uno;
  64 using namespace ::com::sun::star::script;
  65 using namespace ::com::sun::star::resource;
  66 using namespace ::com::sun::star::lang;
  67 using namespace ::com::sun::star::beans;
  68 using namespace ::com::sun::star::container;
  69 using namespace ::com::sun::star::reflection;
  70 using namespace ::com::sun::star::awt;
  71 using namespace ::com::sun::star::io;
  72 using namespace ::cppu;
  73 using namespace ::osl;
  74
  75
  76 void SFURL_firing_impl( const ScriptEvent& aScriptEvent, Any* pRet, const Reference< frame::XModel >& xModel )
  77 {
  78         OSL_TRACE("SFURL_firing_impl() processing script url %s",
  79             OUStringToOString( aScriptEvent.ScriptCode,
  80                 RTL_TEXTENCODING_ASCII_US ).pData->buffer );
  81         try
  82         {
  83             Reference< provider::XScriptProvider > xScriptProvider;
  84             if ( xModel.is() )
  85             {
  86                 Reference< provider::XScriptProviderSupplier > xSupplier( xModel, UNO_QUERY );
  87                 OSL_ENSURE( xSupplier.is(), "SFURL_firing_impl: failed to get script provider supplier" );
  88                 if ( xSupplier.is() )
  89                     xScriptProvider.set( xSupplier->getScriptProvider() );
  90             }
  91             else
  92             {
  93                 Reference< XComponentContext > xContext(
  94                     comphelper::getProcessComponentContext() );
  95                 Reference< provider::XScriptProviderFactory > xFactory =
  96                     provider::theMasterScriptProviderFactory::get( xContext );
  97
  98                 Any aCtx;
  99                 aCtx <<= OUString("user");
 100                 xScriptProvider.set( xFactory->createScriptProvider( aCtx ), UNO_QUERY );
 101             }
 102
 103             if ( !xScriptProvider.is() )
 104             {
 105                 OSL_TRACE("SFURL_firing_impl() Failed to create msp");
 106                 return;
 107             }
 108             Sequence< Any > inArgs( 0 );
 109             Sequence< Any > outArgs( 0 );
 110             Sequence< sal_Int16 > outIndex;
 111
 112             // get Arguments for script
 113             inArgs = aScriptEvent.Arguments;
 114
 115             Reference< provider::XScript > xScript = xScriptProvider->getScript( aScriptEvent.ScriptCode );
 116
 117             if ( !xScript.is() )
 118             {
 119                 OSL_TRACE("SFURL_firing_impl() Failed to obtain XScript");
 120                 return;
 121             }
 122
 123             Any result = xScript->invoke( inArgs, outIndex, outArgs );
 124             if ( pRet )
 125             {
 126                 *pRet = result;
 127             }
 128         }
 129         catch ( const RuntimeException& re )
 130         {
 131             OSL_TRACE("SFURL_firing_impl() Caught RuntimeException reason %s.",
 132                 OUStringToOString( re.Message,
 133                     RTL_TEXTENCODING_ASCII_US ).pData->buffer );
 134         }
 135         catch ( const Exception& e )
 136         {
 137             OSL_TRACE("SFURL_firing_impl() Caught Exception reason %s.",
 138                 OUStringToOString( e.Message,
 139                     RTL_TEXTENCODING_ASCII_US ).pData->buffer );
 140         }
 141
 142 }
 143
 144
 145 class BasicScriptListener_Impl : public WeakImplHelper1< XScriptListener >
 146 {
 147     StarBASICRef maBasicRef;
 148         Reference< frame::XModel > m_xModel;
 149
 150     virtual void firing_impl(const ScriptEvent& aScriptEvent, Any* pRet);
 151
 152 public:
 153     BasicScriptListener_Impl( StarBASIC* pBasic, const Reference< frame::XModel >& xModel )
 154         : maBasicRef( pBasic ), m_xModel( xModel ) {}
 155
 156     // Methods of XAllListener
 157     virtual void SAL_CALL firing(const ScriptEvent& aScriptEvent)
 158         throw( RuntimeException );
 159     virtual Any SAL_CALL approveFiring(const ScriptEvent& aScriptEvent)
 160         throw( InvocationTargetException, RuntimeException );
 161
 162     // Methods of XEventListener
 163     virtual void SAL_CALL disposing(const EventObject& Source)
 164         throw( RuntimeException );
 165 };
 166
 167 // Methods XAllListener
 168 void BasicScriptListener_Impl::firing( const ScriptEvent& aScriptEvent ) throw ( RuntimeException )
 169 {
 170     firing_impl( aScriptEvent, NULL );
 171 }
 172
 173 Any BasicScriptListener_Impl::approveFiring( const ScriptEvent& aScriptEvent )
 174     throw ( InvocationTargetException, RuntimeException )
 175 {
 176     Any aRetAny;
 177     firing_impl( aScriptEvent, &aRetAny );
 178     return aRetAny;
 179 }
 180
 181 // Methods XEventListener
 182 void BasicScriptListener_Impl::disposing(const EventObject& ) throw ( RuntimeException )
 183 {
 184     // TODO: ???
 185     //SolarMutexGuard aGuard;
 186     //xSbxObj.Clear();
 187 }
 188
 189
 190 void BasicScriptListener_Impl::firing_impl( const ScriptEvent& aScriptEvent, Any* pRet )
 191 {
 192     if( aScriptEvent.ScriptType.compareToAscii( "StarBasic" ) == 0 )
 193     {
 194         // Full qualified name?
 195         OUString aMacro( aScriptEvent.ScriptCode );
 196         OUString aLibName;
 197         OUString aLocation;
 198         if( comphelper::string::getTokenCount(aMacro, '.') == 3 )
 199         {
 200             sal_Int32 nLast = 0;
 201             OUString aFullLibName = aMacro.getToken( (sal_Int32)0, (sal_Unicode)'.', nLast );
 202
 203             sal_Int32 nIndex = aFullLibName.indexOf( (sal_Unicode)':' );
 204             if (nIndex >= 0)
 205             {
 206                 aLocation = aFullLibName.copy( 0, nIndex );
 207                 aLibName = aFullLibName.copy( nIndex + 1 );
 208             }
 209
 210             aMacro = aMacro.copy( nLast );
 211         }
 212
 213         SbxObject* p = maBasicRef;
 214         SbxObject* pParent = p->GetParent();
 215         SbxObject* pParentParent = pParent ? pParent->GetParent() : NULL;
 216
 217         StarBASICRef xAppStandardBasic;
 218         StarBASICRef xDocStandardBasic;
 219         if( pParentParent )
 220         {
 221             // Own basic must be document library
 222             xAppStandardBasic = (StarBASIC*)pParentParent;
 223             xDocStandardBasic = (StarBASIC*)pParent;
 224         }
 225         else if( pParent )
 226         {
 227             OUString aName = p->GetName();
 228             if( aName.equalsAscii("Standard") )
 229             {
 230                 // Own basic is doc standard lib
 231                 xDocStandardBasic = (StarBASIC*)p;
 232             }
 233             xAppStandardBasic = (StarBASIC*)pParent;
 234         }
 235         else
 236         {
 237             xAppStandardBasic = (StarBASIC*)p;
 238         }
 239
 240         bool bSearchLib = true;
 241         StarBASICRef xLibSearchBasic;
 242         if( aLocation.equalsAscii("application") )
 243         {
 244             xLibSearchBasic = xAppStandardBasic;
 245         }
 246         else if( aLocation.equalsAscii("document") )
 247         {
 248             xLibSearchBasic = xDocStandardBasic;
 249         }
 250         else
 251         {
 252             bSearchLib = false;
 253         }
 254         SbxVariable* pMethVar = NULL;
 255         // Be still tolerant and make default search if no search basic exists
 256         if( bSearchLib && xLibSearchBasic.Is() )
 257         {
 258             StarBASICRef xLibBasic;
 259             sal_Int16 nCount = xLibSearchBasic->GetObjects()->Count();
 260             for( sal_Int16 nObj = -1; nObj < nCount ; nObj++ )
 261             {
 262                 StarBASIC* pBasic;
 263                 if( nObj == -1 )
 264                 {
 265                     pBasic = (StarBASIC*)xLibSearchBasic;
 266                 }
 267                 else
 268                 {
 269                     SbxVariable* pVar = xLibSearchBasic->GetObjects()->Get( nObj );
 270                     pBasic = PTR_CAST(StarBASIC,pVar);
 271                 }
 272                 if( pBasic )
 273                 {
 274                     OUString aName = pBasic->GetName();
 275                     if( aName == aLibName )
 276                     {
 277                         // Search only in the lib, not automatically in application basic
 278                         sal_uInt16 nFlags = pBasic->GetFlags();
 279                         pBasic->ResetFlag( SBX_GBLSEARCH );
 280                         pMethVar = pBasic->Find( aMacro, SbxCLASS_DONTCARE );
 281                         pBasic->SetFlags( nFlags );
 282                         break;
 283                     }
 284                 }
 285             }
 286         }
 287
 288         // Default: Be tolerant and search everywhere
 289         if( (!pMethVar || !pMethVar->ISA(SbMethod)) && maBasicRef.Is() )
 290         {
 291             pMethVar = maBasicRef->FindQualified( aMacro, SbxCLASS_DONTCARE );
 292         }
 293         SbMethod* pMeth = PTR_CAST(SbMethod,pMethVar);
 294         if( !pMeth )
 295         {
 296             return;
 297         }
 298         // Setup parameters
 299         SbxArrayRef xArray;
 300         sal_Int32 nCnt = aScriptEvent.Arguments.getLength();
 301         if( nCnt )
 302         {
 303             xArray = new SbxArray;
 304             const Any *pArgs = aScriptEvent.Arguments.getConstArray();
 305             for( sal_Int32 i = 0; i < nCnt; i++ )
 306             {
 307                 SbxVariableRef xVar = new SbxVariable( SbxVARIANT );
 308                 unoToSbxValue( (SbxVariable*)xVar, pArgs[i] );
 309                 xArray->Put( xVar, sal::static_int_cast< sal_uInt16 >(i+1) );
 310             }
 311         }
 312
 313         // Call method
 314         SbxVariableRef xValue = pRet ? new SbxVariable : 0;
 315         if( xArray.Is() )
 316         {
 317             pMeth->SetParameters( xArray );
 318         }
 319         pMeth->Call( xValue );
 320         if( pRet )
 321         {
 322             *pRet = sbxToUnoValue( xValue );
 323         }
 324         pMeth->SetParameters( NULL );
 325     }
 326     else // scripting framework script
 327     {
 328         //callBasic via scripting framework
 329         SFURL_firing_impl( aScriptEvent, pRet, m_xModel );
 330     }
 331 }
 332
 333 css::uno::Reference< css::container::XNameContainer > implFindDialogLibForDialog( const Any& rDlgAny, SbxObject* pBasic )
 334 {
 335     css::uno::Reference< css::container::XNameContainer > aRetDlgLib;
 336
 337     SbxVariable* pDlgLibContVar = pBasic->Find(OUString("DialogLibraries"), SbxCLASS_OBJECT);
 338     if( pDlgLibContVar && pDlgLibContVar->ISA(SbUnoObject) )
 339     {
 340         SbUnoObject* pDlgLibContUnoObj = (SbUnoObject*)(SbxBase*)pDlgLibContVar;
 341         Any aDlgLibContAny = pDlgLibContUnoObj->getUnoAny();
 342
 343         Reference< XLibraryContainer > xDlgLibContNameAccess( aDlgLibContAny, UNO_QUERY );
 344         OSL_ENSURE( xDlgLibContNameAccess.is(), "implFindDialogLibForDialog: no lib container for the given dialog!" );
 345         if( xDlgLibContNameAccess.is() )
 346         {
 347             Sequence< OUString > aLibNames = xDlgLibContNameAccess->getElementNames();
 348             const OUString* pLibNames = aLibNames.getConstArray();
 349             sal_Int32 nLibNameCount = aLibNames.getLength();
 350
 351             for( sal_Int32 iLib = 0 ; iLib < nLibNameCount ; iLib++ )
 352             {
 353                 if ( !xDlgLibContNameAccess->isLibraryLoaded( pLibNames[ iLib ] ) )
 354                     // if the library isn't loaded, then the dialog cannot originate from this lib
 355                     continue;
 356
 357                 Any aDlgLibAny = xDlgLibContNameAccess->getByName( pLibNames[ iLib ] );
 358
 359                 Reference< XNameContainer > xDlgLibNameCont( aDlgLibAny, UNO_QUERY );
 360                 OSL_ENSURE( xDlgLibNameCont.is(), "implFindDialogLibForDialog: invalid dialog lib!" );
 361                 if( xDlgLibNameCont.is() )
 362                 {
 363                     Sequence< OUString > aDlgNames = xDlgLibNameCont->getElementNames();
 364                     const OUString* pDlgNames = aDlgNames.getConstArray();
 365                     sal_Int32 nDlgNameCount = aDlgNames.getLength();
 366
 367                     for( sal_Int32 iDlg = 0 ; iDlg < nDlgNameCount ; iDlg++ )
 368                     {
 369                         Any aDlgAny = xDlgLibNameCont->getByName( pDlgNames[ iDlg ] );
 370                         if( aDlgAny == rDlgAny )
 371                         {
 372                             aRetDlgLib = xDlgLibNameCont;
 373                             break;
 374                         }
 375                     }
 376                 }
 377             }
 378         }
 379     }
 380
 381     return aRetDlgLib;
 382 }
 383
 384 css::uno::Reference< css::container::XNameContainer > implFindDialogLibForDialogBasic( const Any& aAnyISP, SbxObject* pBasic, StarBASIC*& pFoundBasic )
 385 {
 386     css::uno::Reference< css::container::XNameContainer > aDlgLib;
 387     // Find dialog library for dialog, direct access is not possible here
 388     StarBASIC* pStartedBasic = (StarBASIC*)pBasic;
 389     SbxObject* pParentBasic = pStartedBasic ? pStartedBasic->GetParent() : NULL;
 390     SbxObject* pParentParentBasic = pParentBasic ? pParentBasic->GetParent() : NULL;
 391
 392     SbxObject* pSearchBasic1 = NULL;
 393     SbxObject* pSearchBasic2 = NULL;
 394     if( pParentParentBasic )
 395     {
 396         pSearchBasic1 = pParentBasic;
 397         pSearchBasic2 = pParentParentBasic;
 398     }
 399     else
 400     {
 401         pSearchBasic1 = pStartedBasic;
 402         pSearchBasic2 = pParentBasic;
 403     }
 404     if( pSearchBasic1 )
 405     {
 406         aDlgLib = implFindDialogLibForDialog( aAnyISP, pSearchBasic1 );
 407
 408         if ( aDlgLib.is() )
 409             pFoundBasic = (StarBASIC*)pSearchBasic1;
 410
 411         else if( pSearchBasic2 )
 412         {
 413             aDlgLib = implFindDialogLibForDialog( aAnyISP, pSearchBasic2 );
 414             if ( aDlgLib.is() )
 415                 pFoundBasic = (StarBASIC*)pSearchBasic2;
 416         }
 417     }
 418     return aDlgLib;
 419 }
 420
 421 void RTL_Impl_CreateUnoDialog( StarBASIC* pBasic, SbxArray& rPar, sal_Bool bWrite )
 422 {
 423     (void)pBasic;
 424     (void)bWrite;
 425
 426     Reference< XMultiServiceFactory > xMSF( comphelper::getProcessServiceFactory() );
 427
 428     // We need at least 1 parameter
 429     if ( rPar.Count() < 2 )
 430     {
 431         StarBASIC::Error( SbERR_BAD_ARGUMENT );
 432         return;
 433     }
 434
 435     // Get dialog
 436     SbxBaseRef pObj = (SbxBase*)rPar.Get( 1 )->GetObject();
 437     if( !(pObj && pObj->ISA(SbUnoObject)) )
 438     {
 439         StarBASIC::Error( SbERR_BAD_ARGUMENT );
 440         return;
 441     }
 442     SbUnoObject* pUnoObj = (SbUnoObject*)(SbxBase*)pObj;
 443     Any aAnyISP = pUnoObj->getUnoAny();
 444     TypeClass eType = aAnyISP.getValueType().getTypeClass();
 445
 446     if( eType != TypeClass_INTERFACE )
 447     {
 448         StarBASIC::Error( SbERR_BAD_ARGUMENT );
 449         return;
 450     }
 451
 452     // Create new uno dialog
 453     Reference< XNameContainer > xDialogModel( xMSF->createInstance(
 454                       OUString("com.sun.star.awt.UnoControlDialogModel")), UNO_QUERY );
 455     if( !xDialogModel.is() )
 456     {
 457         return;
 458     }
 459     Reference< XInputStreamProvider > xISP;
 460     aAnyISP >>= xISP;
 461     if( !xISP.is() )
 462     {
 463         return;
 464     }
 465     Reference< XComponentContext > xContext( comphelper::getComponentContext( xMSF ) );
 466
 467     // Import the DialogModel
 468     Reference< XInputStream > xInput( xISP->createInputStream() );
 469
 470     // i83963 Force decoration
 471     uno::Reference< beans::XPropertySet > xDlgModPropSet( xDialogModel, uno::UNO_QUERY );
 472     if( xDlgModPropSet.is() )
 473     {
 474         bool bDecoration = true;
 475         try
 476         {
 477             OUString aDecorationPropName("Decoration");
 478             Any aDecorationAny = xDlgModPropSet->getPropertyValue( aDecorationPropName );
 479             aDecorationAny >>= bDecoration;
 480             if( !bDecoration )
 481             {
 482                 xDlgModPropSet->setPropertyValue( aDecorationPropName, makeAny( true ) );
 483
 484                 OUString aTitlePropName("Title");
 485                 xDlgModPropSet->setPropertyValue( aTitlePropName, makeAny( OUString() ) );
 486             }
 487         }
 488         catch(const UnknownPropertyException& )
 489         {}
 490     }
 491
 492     css::uno::Reference< css::container::XNameContainer > aDlgLib;
 493     bool bDocDialog = false;
 494     StarBASIC* pFoundBasic = NULL;
 495     OSL_TRACE("About to try get a hold of ThisComponent");
 496     Reference< frame::XModel > xModel = StarBASIC::GetModelFromBasic( GetSbData()->pInst->GetBasic() ) ;
 497     aDlgLib = implFindDialogLibForDialogBasic( aAnyISP, GetSbData()->pInst->GetBasic(), pFoundBasic );
 498     // If we found the dialog then it belongs to the Search basic
 499     if ( !pFoundBasic )
 500     {
 501         Reference< frame::XDesktop2 > xDesktop = frame::Desktop::create( xContext );
 502         Reference< container::XEnumeration > xModels;
 503         Reference< container::XEnumerationAccess > xComponents( xDesktop->getComponents(), UNO_QUERY );
 504         if ( xComponents.is() )
 505         {
 506             xModels.set( xComponents->createEnumeration(), UNO_QUERY );
 507         }
 508         if ( xModels.is() )
 509         {
 510             while ( xModels->hasMoreElements() )
 511             {
 512                 Reference< frame::XModel > xNextModel( xModels->nextElement(), UNO_QUERY );
 513                 if ( xNextModel.is() )
 514                 {
 515                     BasicManager* pMgr = basic::BasicManagerRepository::getDocumentBasicManager( xNextModel );
 516                     if ( pMgr )
 517                     {
 518                         aDlgLib = implFindDialogLibForDialogBasic( aAnyISP, pMgr->GetLib(0), pFoundBasic );
 519                     }
 520                     if ( aDlgLib.is() )
 521                     {
 522                         bDocDialog = true;
 523                         xModel = xNextModel;
 524                         break;
 525                     }
 526                 }
 527             }
 528         }
 529     }
 530     if ( pFoundBasic )
 531     {
 532         bDocDialog = pFoundBasic->IsDocBasic();
 533     }
 534     Reference< XScriptListener > xScriptListener = new BasicScriptListener_Impl( GetSbData()->pInst->GetBasic(), xModel );
 535
 536     // Create a "living" Dialog
 537     Reference< XControl > xCntrl;
 538     try
 539     {
 540        Reference< XDialogProvider >  xDlgProv;;
 541        if( bDocDialog )
 542            xDlgProv = css::awt::DialogProvider::createWithModelAndScripting( xContext, xModel, xInput, aDlgLib, xScriptListener );
 543        else
 544            xDlgProv = css::awt::DialogProvider::createWithModelAndScripting( xContext, uno::Reference< frame::XModel >(), xInput, aDlgLib, xScriptListener );
 545
 546        xCntrl.set( xDlgProv->createDialog(OUString() ), UNO_QUERY_THROW );
 547        // Add dialog model to dispose vector
 548        Reference< XComponent > xDlgComponent( xCntrl->getModel(), UNO_QUERY );
 549        GetSbData()->pInst->getComponentVector().push_back( xDlgComponent );
 550        // need ThisCompoent from calling script
 551     }
 552     // preserve existing bad behaviour, it's possible... but probably
 553     // illegal to open 2 dialogs ( they ARE modal ) when this happens, sometimes
 554     // create dialog fails.  So, in this case let's not throw, just leave basic
 555     // detect the unset object.
 556     catch(const uno::Exception& )
 557     {
 558     }
 559
 560     // Return dialog
 561     Any aRetVal;
 562     aRetVal <<= xCntrl;
 563     SbxVariableRef refVar = rPar.Get(0);
 564     unoToSbxValue( (SbxVariable*)refVar, aRetVal );
 565 }
 566
 567
 568 //===================================================================
 569
 570 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */