scripting/source/provider/MasterScriptProvider.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: MasterScriptProvider.cxx,v $
  10  * $Revision: 1.23 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_scripting.hxx"
  33
  34 #include <comphelper/documentinfo.hxx>
  35
  36 #include <cppuhelper/implementationentry.hxx>
  37 #include <cppuhelper/exc_hlp.hxx>
  38 #include <cppuhelper/factory.hxx>
  39 #include <com/sun/star/frame/XModel.hpp>
  40 #include <com/sun/star/lang/EventObject.hpp>
  41 #include <com/sun/star/container/XContentEnumerationAccess.hpp>
  42 #include <com/sun/star/document/XScriptInvocationContext.hpp>
  43
  44 #include <com/sun/star/uri/XUriReference.hpp>
  45 #include <com/sun/star/uri/XUriReferenceFactory.hpp>
  46 #include <com/sun/star/uri/XVndSunStarScriptUrl.hpp>
  47
  48 #include <com/sun/star/deployment/XPackage.hpp>
  49 #include <com/sun/star/script/browse/BrowseNodeTypes.hpp>
  50 #include <com/sun/star/script/provider/XScriptProviderFactory.hpp>
  51 #include <com/sun/star/script/provider/ScriptFrameworkErrorType.hpp>
  52
  53 #include <util/scriptingconstants.hxx>
  54 #include <util/util.hxx>
  55 #include <util/MiscUtils.hxx>
  56
  57 #include "ActiveMSPList.hxx"
  58 #include "MasterScriptProvider.hxx"
  59 #include "URIHelper.hxx"
  60
  61 using namespace ::com::sun::star;
  62 using namespace ::com::sun::star::uno;
  63 using namespace ::com::sun::star::script;
  64 using namespace ::com::sun::star::document;
  65 using namespace ::sf_misc;
  66 using namespace ::scripting_util;
  67
  68 namespace func_provider
  69 {
  70 //*************************************************************************
  71 //  Definitions for MasterScriptProviderFactory global methods.
  72 //*************************************************************************
  73
  74 ::rtl::OUString SAL_CALL mspf_getImplementationName() ;
  75 Reference< XInterface > SAL_CALL mspf_create( Reference< XComponentContext > const & xComponentContext );
  76 Sequence< ::rtl::OUString > SAL_CALL mspf_getSupportedServiceNames();
  77
  78
  79 bool endsWith( const ::rtl::OUString& target,
  80     const ::rtl::OUString& item )
  81 {
  82     sal_Int32 index = 0;
  83     if (  ( index = target.indexOf( item ) ) != -1  &&
  84        ( index == ( target.getLength() - item.getLength() ) ) )
  85     {
  86         return true;
  87     }
  88     return false;
  89 }
  90 //::rtl_StandardModuleCount s_moduleCount = MODULE_COUNT_INIT;
  91
  92 /* should be available in some central location. */
  93 //*************************************************************************
  94 // XScriptProvider implementation
  95 //
  96 //*************************************************************************
  97 MasterScriptProvider::MasterScriptProvider( const Reference< XComponentContext > & xContext ) throw ( RuntimeException ):
  98         m_xContext( xContext ), m_bIsValid( false ), m_bInitialised( false ),
  99         m_bIsPkgMSP( false ), m_pPCache( 0 )
 100 {
 101     validateXRef( m_xContext, "MasterScriptProvider::MasterScriptProvider: No context available\n" );
 102     m_xMgr = m_xContext->getServiceManager();
 103     validateXRef( m_xMgr,
 104                   "MasterScriptProvider::MasterScriptProvider: No service manager available\n" );
 105     m_bIsValid = true;
 106 }
 107
 108 //*************************************************************************
 109 MasterScriptProvider::~MasterScriptProvider()
 110 {
 111     //s_moduleCount.modCnt.release( &s_moduleCount.modCnt );
 112     if ( m_pPCache )
 113     {
 114         delete m_pPCache;
 115     }
 116     m_pPCache = 0;
 117 }
 118
 119 //*************************************************************************
 120 void SAL_CALL MasterScriptProvider::initialize( const Sequence < Any >& args )
 121 throw ( Exception, RuntimeException )
 122 {
 123     if ( m_bInitialised )
 124         return;
 125
 126     m_bIsValid = false;
 127
 128     sal_Int32 len = args.getLength();
 129     if ( len > 1  )
 130     {
 131         throw RuntimeException(
 132             OUSTR( "MasterScriptProvider::initialize: invalid number of arguments" ),
 133             Reference< XInterface >() );
 134     }
 135
 136     Sequence< Any > invokeArgs( len );
 137
 138     if ( len != 0 )
 139     {
 140         // check if first parameter is a string
 141         // if it is, this implies that this is a MSP created
 142         // with a user or share ctx ( used for browse functionality )
 143         //
 144         if ( args[ 0 ] >>= m_sCtxString )
 145         {
 146             invokeArgs[ 0  ] = args[ 0 ];
 147             if ( m_sCtxString.indexOfAsciiL( RTL_CONSTASCII_STRINGPARAM( "vnd.sun.star.tdoc" ) ) == 0 )
 148             {
 149                 m_xModel =  MiscUtils::tDocUrlToModel( m_sCtxString );
 150             }
 151         }
 152         else if ( args[ 0 ] >>= m_xInvocationContext )
 153         {
 154             m_xModel.set( m_xInvocationContext->getScriptContainer(), UNO_QUERY_THROW );
 155         }
 156         else
 157         {
 158             args[ 0 ] >>= m_xModel;
 159         }
 160
 161         if ( m_xModel.is() )
 162         {
 163             // from the arguments, we were able to deduce a model. That alone doesn't
 164             // suffice, we also need an XEmbeddedScripts which actually indicates support
 165             // for embeddeding scripts
 166             Reference< XEmbeddedScripts > xScripts( m_xModel, UNO_QUERY );
 167             if ( !xScripts.is() )
 168             {
 169                 throw lang::IllegalArgumentException(
 170                     ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM(
 171                         "The given document does not support embedding scripts into it, and cannot be associated with such a document."
 172                     ) ),
 173                     *this,
 174                     1
 175                 );
 176             }
 177
 178             try
 179             {
 180                 m_sCtxString =  MiscUtils::xModelToTdocUrl( m_xModel, m_xContext );
 181             }
 182             catch ( const Exception& )
 183             {
 184                 Any aError( ::cppu::getCaughtException() );
 185
 186                 ::rtl::OUStringBuffer buf;
 187                 buf.appendAscii( "MasterScriptProvider::initialize: caught " );
 188                 buf.append     ( aError.getValueTypeName() );
 189                 buf.appendAscii( ":" );
 190
 191                 Exception aException; aError >>= aException;
 192                 buf.append     ( aException.Message );
 193                 throw lang::WrappedTargetException( buf.makeStringAndClear(), *this, aError );
 194             }
 195
 196             if ( m_xInvocationContext.is() && m_xInvocationContext != m_xModel )
 197                 invokeArgs[ 0 ] <<= m_xInvocationContext;
 198             else
 199                 invokeArgs[ 0 ] <<= m_sCtxString;
 200         }
 201
 202         ::rtl::OUString pkgSpec = OUSTR("uno_packages");
 203         sal_Int32 indexOfPkgSpec = m_sCtxString.lastIndexOf( pkgSpec );
 204
 205         // if contex string ends with "uno_packages"
 206         if ( indexOfPkgSpec > -1 && ( m_sCtxString.match( pkgSpec, indexOfPkgSpec ) == sal_True ) )
 207         {
 208             m_bIsPkgMSP = sal_True;
 209         }
 210         else
 211         {
 212             m_bIsPkgMSP = sal_False;
 213         }
 214     }
 215     else // no args
 216     {
 217         // use either scriping context or maybe zero args?
 218         invokeArgs = Sequence< Any >( 0 ); // no arguments
 219     }
 220     m_sAargs = invokeArgs;
 221     // don't create pkg mgr MSP for documents, not supported
 222     if ( m_bIsPkgMSP == sal_False && !m_xModel.is() )
 223     {
 224         createPkgProvider();
 225     }
 226
 227     m_bInitialised = true;
 228     m_bIsValid = true;
 229 }
 230
 231
 232 //*************************************************************************
 233 void MasterScriptProvider::createPkgProvider()
 234 {
 235     try
 236     {
 237         ::rtl::OUString loc = m_sCtxString;
 238         Any location;
 239         ::rtl::OUString sPkgCtx =  m_sCtxString.concat( OUSTR(":uno_packages") );
 240         location <<= sPkgCtx;
 241
 242         Reference< provider::XScriptProviderFactory > xFac(
 243             m_xContext->getValueByName(
 244                 OUSTR( "/singletons/com.sun.star.script.provider.theMasterScriptProviderFactory") ), UNO_QUERY_THROW );
 245
 246         m_xMSPPkg.set(
 247             xFac->createScriptProvider( location ), UNO_QUERY_THROW );
 248
 249     }
 250     catch ( Exception& e )
 251     {
 252         (void)e;
 253         OSL_TRACE("Exception creating MasterScriptProvider for uno_packages in context %s: %s",
 254                 ::rtl::OUStringToOString( m_sCtxString,
 255                     RTL_TEXTENCODING_ASCII_US ).pData->buffer,
 256                 ::rtl::OUStringToOString( e.Message,
 257                     RTL_TEXTENCODING_ASCII_US ).pData->buffer );
 258     }
 259 }
 260
 261 //*************************************************************************
 262 Reference< provider::XScript >
 263 MasterScriptProvider::getScript( const ::rtl::OUString& scriptURI )
 264 throw ( provider::ScriptFrameworkErrorException,
 265         RuntimeException )
 266 {
 267     if ( !isValid() )
 268     {
 269         throw provider::ScriptFrameworkErrorException(
 270             OUSTR( "MasterScriptProvider not initialised" ), Reference< XInterface >(),
 271             scriptURI, OUSTR(""),
 272             provider::ScriptFrameworkErrorType::UNKNOWN );
 273     }
 274
 275     // need to get the language from the string
 276
 277     Reference< uri::XUriReferenceFactory > xFac (
 278          m_xMgr->createInstanceWithContext( rtl::OUString::createFromAscii(
 279             "com.sun.star.uri.UriReferenceFactory"), m_xContext ) , UNO_QUERY );
 280     if ( !xFac.is() )
 281     {
 282         ::rtl::OUString message = ::rtl::OUString::createFromAscii("Failed to instantiate  UriReferenceFactory");
 283         throw provider::ScriptFrameworkErrorException(
 284             message, Reference< XInterface >(),
 285             scriptURI, ::rtl::OUString(),
 286             provider::ScriptFrameworkErrorType::UNKNOWN );
 287     }
 288
 289     Reference<  uri::XUriReference > uriRef(
 290         xFac->parse( scriptURI ), UNO_QUERY );
 291
 292     Reference < uri::XVndSunStarScriptUrl > sfUri( uriRef, UNO_QUERY );
 293
 294     if ( !uriRef.is() || !sfUri.is() )
 295     {
 296         ::rtl::OUString errorMsg = OUSTR( "Incorrect format for Script URI: " );
 297         errorMsg = errorMsg.concat( scriptURI );
 298         throw provider::ScriptFrameworkErrorException(
 299             errorMsg, Reference< XInterface >(),
 300             scriptURI, OUSTR(""),
 301             provider::ScriptFrameworkErrorType::UNKNOWN );
 302     }
 303
 304     ::rtl::OUString langKey = ::rtl::OUString::createFromAscii( "language" );
 305     ::rtl::OUString locKey = ::rtl::OUString::createFromAscii( "location" );
 306
 307     if ( sfUri->hasParameter( langKey ) == sal_False ||
 308          sfUri->hasParameter( locKey ) == sal_False ||
 309          ( sfUri->getName().getLength() == 0  ) )
 310     {
 311         ::rtl::OUString errorMsg = OUSTR( "Incorrect format for Script URI: " );
 312         errorMsg = errorMsg.concat( scriptURI );
 313         throw provider::ScriptFrameworkErrorException(
 314             errorMsg, Reference< XInterface >(),
 315             scriptURI, OUSTR(""),
 316             provider::ScriptFrameworkErrorType::UNKNOWN );
 317     }
 318
 319     ::rtl::OUString language = sfUri->getParameter( langKey );
 320     ::rtl::OUString location = sfUri->getParameter( locKey );
 321
 322     // if script us located in uno pkg
 323     sal_Int32 index = -1;
 324     ::rtl::OUString pkgTag =
 325         ::rtl::OUString::createFromAscii( ":uno_packages" );
 326     // for languages other than basic,  scripts located in uno packages
 327     // are merged into the user/share location context.
 328     // For other languages the location attribute in script url has the form
 329     // location = [user|share]:uno_packages or location :uno_pacakges/xxxx.uno.pkg
 330     // we need to extract the value of location part from the
 331     // location attribute of the script, if the script is located in an
 332     // uno package then that is the location part up to and including
 333     // ":uno_packages", if the script is not in an uno package then the
 334     // normal value is used e.g. user or share.
 335     // The value extracted will be used to determine if the script is
 336     // located in the same location context as this MSP.
 337     // For Basic, the language script provider can handle the execution of a
 338     // script in any location context
 339     if ( ( index = location.indexOf( pkgTag ) ) > -1 )
 340     {
 341         location = location.copy( 0, index + pkgTag.getLength() );
 342     }
 343
 344     Reference< provider::XScript > xScript;
 345
 346     // If the script location is in the same location context as this
 347     // MSP then delate to the lanaguage provider controlled by this MSP
 348     // ** Special case is BASIC, all calls to getScript will be handled
 349     // by the language script provider in the current location context
 350     // even if its different
 351     if  (   (   location.equals( OUSTR( "document" ) )
 352             &&  m_xModel.is()
 353             )
 354             ||  ( endsWith( m_sCtxString, location ) )
 355             ||  ( language.equals( OUSTR( "Basic" ) ) )
 356          )
 357     {
 358         Reference< provider::XScriptProvider > xScriptProvider;
 359         ::rtl::OUStringBuffer buf( 80 );
 360         buf.appendAscii( "com.sun.star.script.provider.ScriptProviderFor");
 361         buf.append( language );
 362         ::rtl::OUString serviceName = buf.makeStringAndClear();
 363         if ( providerCache() )
 364         {
 365             try
 366             {
 367                 xScriptProvider.set(
 368                     providerCache()->getProvider( serviceName ),
 369                     UNO_QUERY_THROW );
 370             }
 371             catch( const Exception& e )
 372             {
 373                 throw provider::ScriptFrameworkErrorException(
 374                     e.Message, Reference< XInterface >(),
 375                     sfUri->getName(), language,
 376                     provider::ScriptFrameworkErrorType::NOTSUPPORTED );
 377             }
 378         }
 379         else
 380         {
 381             throw provider::ScriptFrameworkErrorException(
 382                 OUSTR( "No LanguageProviders detected" ),
 383                 Reference< XInterface >(),
 384                 sfUri->getName(), language,
 385                 provider::ScriptFrameworkErrorType::NOTSUPPORTED );
 386         }
 387         xScript=xScriptProvider->getScript( scriptURI );
 388     }
 389     else
 390     {
 391         Reference< provider::XScriptProviderFactory > xFac_(
 392             m_xContext->getValueByName(
 393                 OUSTR( "/singletons/com.sun.star.script.provider.theMasterScriptProviderFactory") ), UNO_QUERY_THROW );
 394
 395         Reference< provider::XScriptProvider > xSP(
 396             xFac_->createScriptProvider( makeAny( location ) ), UNO_QUERY_THROW );
 397         xScript = xSP->getScript( scriptURI );
 398     }
 399
 400     return xScript;
 401 }
 402 //*************************************************************************
 403 bool
 404 MasterScriptProvider::isValid()
 405 {
 406     return m_bIsValid;
 407 }
 408
 409 //*************************************************************************
 410 ProviderCache*
 411 MasterScriptProvider::providerCache()
 412 {
 413     if ( !m_pPCache )
 414     {
 415         ::osl::MutexGuard aGuard( m_mutex );
 416         if ( !m_pPCache )
 417         {
 418             ::rtl::OUString serviceName1 = OUSTR("com.sun.star.script.provider.ScriptProviderForBasic");
 419             Sequence< ::rtl::OUString > blacklist(1);
 420             blacklist[ 0 ] = serviceName1;
 421
 422             if ( !m_bIsPkgMSP )
 423             {
 424                 m_pPCache = new ProviderCache( m_xContext, m_sAargs );
 425             }
 426             else
 427             {
 428                 m_pPCache = new ProviderCache( m_xContext, m_sAargs, blacklist );
 429             }
 430         }
 431     }
 432     return m_pPCache;
 433 }
 434
 435
 436 //*************************************************************************
 437 ::rtl::OUString SAL_CALL
 438 MasterScriptProvider::getName()
 439         throw ( css::uno::RuntimeException )
 440 {
 441     if ( !isPkgProvider() )
 442     {
 443         ::rtl::OUString sCtx = getContextString();
 444         if ( sCtx.indexOf( OUSTR( "vnd.sun.star.tdoc" ) ) == 0 )
 445         {
 446             Reference< frame::XModel > xModel = m_xModel;
 447             if ( !xModel.is() )
 448             {
 449                 xModel = MiscUtils::tDocUrlToModel( sCtx );
 450             }
 451
 452             m_sNodeName = ::comphelper::DocumentInfo::getDocumentTitle( xModel );
 453         }
 454         else
 455         {
 456             m_sNodeName = parseLocationName( getContextString() );
 457         }
 458     }
 459     else
 460     {
 461         m_sNodeName = OUSTR("uno_packages");
 462     }
 463     return m_sNodeName;
 464 }
 465
 466 //*************************************************************************
 467 Sequence< Reference< browse::XBrowseNode > > SAL_CALL
 468 MasterScriptProvider::getChildNodes()
 469         throw ( css::uno::RuntimeException )
 470 {
 471     Sequence< Reference< provider::XScriptProvider > > providers = getAllProviders();
 472
 473     Reference< provider::XScriptProvider > pkgProv = getPkgProvider();
 474     sal_Int32 size = providers.getLength();
 475     bool hasPkgs = pkgProv.is();
 476     if ( hasPkgs  )
 477     {
 478         size++;
 479     }
 480     Sequence<  Reference< browse::XBrowseNode > > children( size );
 481     sal_Int32 provIndex = 0;
 482     for ( ; provIndex < providers.getLength(); provIndex++ )
 483     {
 484         children[ provIndex ] = Reference< browse::XBrowseNode >( providers[ provIndex ], UNO_QUERY );
 485     }
 486
 487     if ( hasPkgs  )
 488     {
 489         children[ provIndex ] = Reference< browse::XBrowseNode >( pkgProv, UNO_QUERY );
 490
 491     }
 492
 493     return children;
 494 }
 495
 496 //*************************************************************************
 497 sal_Bool SAL_CALL
 498 MasterScriptProvider::hasChildNodes()
 499         throw ( css::uno::RuntimeException )
 500 {
 501     return sal_True;
 502 }
 503
 504 //*************************************************************************
 505 sal_Int16 SAL_CALL
 506 MasterScriptProvider::getType()
 507         throw ( css::uno::RuntimeException )
 508 {
 509     return browse::BrowseNodeTypes::CONTAINER;
 510 }
 511
 512 //*************************************************************************
 513
 514 ::rtl::OUString
 515 MasterScriptProvider::parseLocationName( const ::rtl::OUString& location )
 516 {
 517     // strip out the last leaf of location name
 518     // e.g. file://dir1/dir2/Blah.sxw - > Blah.sxw
 519     ::rtl::OUString temp = location;
 520     INetURLObject aURLObj( temp );
 521     if ( !aURLObj.HasError() )
 522         temp = aURLObj.getName( INetURLObject::LAST_SEGMENT, true, INetURLObject::DECODE_WITH_CHARSET );
 523     return temp;
 524 }
 525
 526 //*************************************************************************
 527 // Register Package
 528 void SAL_CALL
 529 MasterScriptProvider::insertByName( const ::rtl::OUString& aName, const Any& aElement ) throw ( lang::IllegalArgumentException, container::ElementExistException, lang::WrappedTargetException, css::uno::RuntimeException)
 530 {
 531     if ( !m_bIsPkgMSP )
 532     {
 533         if ( m_xMSPPkg.is() )
 534         {
 535             Reference< container::XNameContainer > xCont( m_xMSPPkg, UNO_QUERY );
 536             if ( !xCont.is() )
 537             {
 538                 throw RuntimeException(
 539                     OUSTR("PackageMasterScriptProvider doesn't implement XNameContainer"),
 540                     Reference< XInterface >() );
 541             }
 542             xCont->insertByName( aName, aElement );
 543         }
 544         else
 545         {
 546             throw RuntimeException( OUSTR("PackageMasterScriptProvider is unitialised"),
 547                                         Reference< XInterface >() );
 548         }
 549
 550     }
 551     else
 552     {
 553         Reference< deployment::XPackage > xPkg( aElement, UNO_QUERY );
 554         if ( !xPkg.is() )
 555         {
 556             throw lang::IllegalArgumentException( OUSTR("Couldn't convert to XPackage"),
 557                                                       Reference < XInterface > (), 2 );
 558         }
 559         if ( !aName.getLength() )
 560         {
 561             throw lang::IllegalArgumentException( OUSTR("Name not set!!"),
 562                                                       Reference < XInterface > (), 1 );
 563         }
 564         // TODO for library pacakge parse the language, for the moment will try
 565         // to get each provider to process the new Package, the first one the succeeds
 566         // will terminate processing
 567         if ( !providerCache() )
 568         {
 569             throw RuntimeException(
 570                 OUSTR("insertByName cannot instantiate "
 571                     "child script providers."),
 572                 Reference< XInterface >() );
 573         }
 574         Sequence < Reference< provider::XScriptProvider > > xSProviders =
 575             providerCache()->getAllProviders();
 576         sal_Int32 index = 0;
 577
 578         for ( ; index < xSProviders.getLength(); index++ )
 579         {
 580             Reference< container::XNameContainer > xCont( xSProviders[ index ], UNO_QUERY );
 581             if ( !xCont.is() )
 582             {
 583                 continue;
 584             }
 585             try
 586             {
 587                 xCont->insertByName( aName, aElement );
 588                 break;
 589             }
 590             catch ( Exception& )
 591             {
 592             }
 593
 594         }
 595         if ( index == xSProviders.getLength() )
 596         {
 597             // No script providers could process the package
 598             ::rtl::OUString message = OUSTR("Failed to register package for ");
 599             message = message.concat( aName );
 600             throw lang::IllegalArgumentException( message,
 601                 Reference < XInterface > (), 2 );
 602         }
 603    }
 604 }
 605
 606 //*************************************************************************
 607 // Revoke Package
 608 void SAL_CALL
 609 MasterScriptProvider::removeByName( const ::rtl::OUString& Name ) throw ( container::NoSuchElementException, lang::WrappedTargetException, RuntimeException)
 610 {
 611     if ( !m_bIsPkgMSP )
 612     {
 613         if ( m_xMSPPkg.is() )
 614         {
 615             Reference< container::XNameContainer > xCont( m_xMSPPkg, UNO_QUERY );
 616             if ( !xCont.is() )
 617             {
 618                 throw RuntimeException(
 619                     OUSTR("PackageMasterScriptProvider doesn't implement XNameContainer"),
 620                     Reference< XInterface >() );
 621             }
 622             xCont->removeByName( Name );
 623         }
 624         else
 625         {
 626             throw RuntimeException( OUSTR("PackageMasterScriptProvider is unitialised"),
 627                                         Reference< XInterface >() );
 628         }
 629
 630    }
 631    else
 632    {
 633         if ( !Name.getLength() )
 634         {
 635             throw lang::IllegalArgumentException( OUSTR("Name not set!!"),
 636                                                       Reference < XInterface > (), 1 );
 637         }
 638         // TODO for Script library pacakge url parse the language,
 639         // for the moment will just try to get each provider to process remove/revoke
 640         // request, the first one the succeeds will terminate processing
 641
 642         if ( !providerCache() )
 643         {
 644             throw RuntimeException(
 645                 OUSTR("removeByName() cannot instantiate "
 646                     "child script providers."),
 647                 Reference< XInterface >() );
 648         }
 649         Sequence < Reference< provider::XScriptProvider > > xSProviders =
 650             providerCache()->getAllProviders();
 651         sal_Int32 index = 0;
 652         for ( ; index < xSProviders.getLength(); index++ )
 653         {
 654             Reference< container::XNameContainer > xCont( xSProviders[ index ], UNO_QUERY );
 655             if ( !xCont.is() )
 656             {
 657                 continue;
 658             }
 659             try
 660             {
 661                 xCont->removeByName( Name );
 662                 break;
 663             }
 664             catch ( Exception& )
 665             {
 666             }
 667
 668         }
 669         if ( index == xSProviders.getLength() )
 670         {
 671             // No script providers could process the package
 672             ::rtl::OUString message = OUSTR("Failed to revoke package for ");
 673             message = message.concat( Name );
 674             throw lang::IllegalArgumentException( message,
 675                                                       Reference < XInterface > (), 1 );
 676         }
 677
 678     }
 679 }
 680
 681 //*************************************************************************
 682 void SAL_CALL
 683 MasterScriptProvider::replaceByName( const ::rtl::OUString& aName, const Any& aElement ) throw ( lang::IllegalArgumentException, container::NoSuchElementException, lang::WrappedTargetException, RuntimeException)
 684 {
 685     (void)aName;
 686     (void)aElement;
 687
 688     // TODO needs implementing
 689     if ( true )
 690     {
 691         throw RuntimeException(  OUSTR("replaceByName not implemented!!!!") ,
 692                 Reference< XInterface >() );
 693     }
 694 }
 695 //*************************************************************************
 696 Any SAL_CALL
 697 MasterScriptProvider::getByName( const ::rtl::OUString& aName ) throw ( container::NoSuchElementException, lang::WrappedTargetException, RuntimeException)
 698 {
 699     (void)aName;
 700
 701     // TODO needs to be implemented
 702     Any result;
 703     if ( true )
 704     {
 705         throw RuntimeException(  OUSTR("getByName not implemented!!!!") ,
 706                 Reference< XInterface >() );
 707     }
 708     return result;
 709 }
 710 //*************************************************************************
 711 sal_Bool SAL_CALL
 712 MasterScriptProvider::hasByName( const ::rtl::OUString& aName ) throw (RuntimeException)
 713 {
 714     sal_Bool result = sal_False;
 715     if ( !m_bIsPkgMSP )
 716     {
 717         if ( m_xMSPPkg.is() )
 718         {
 719             Reference< container::XNameContainer > xCont( m_xMSPPkg, UNO_QUERY );
 720             if ( !xCont.is() )
 721             {
 722                 throw RuntimeException(
 723                     OUSTR("PackageMasterScriptProvider doesn't implement XNameContainer"),
 724                     Reference< XInterface >() );
 725             }
 726
 727             result = xCont->hasByName( aName );
 728         }
 729         else
 730         {
 731             throw RuntimeException( OUSTR("PackageMasterScriptProvider is unitialised"),
 732                                         Reference< XInterface >() );
 733         }
 734
 735    }
 736    else
 737    {
 738         if ( !aName.getLength() )
 739         {
 740             throw lang::IllegalArgumentException( OUSTR("Name not set!!"),
 741                                                       Reference < XInterface > (), 1 );
 742         }
 743         // TODO for Script library pacakge url parse the language,
 744         // for the moment will just try to get each provider to see if the
 745         // package exists in any provider, first one that succeed will
 746         // terminate the loop
 747
 748         if ( !providerCache() )
 749         {
 750             throw RuntimeException(
 751                 OUSTR("removeByName() cannot instantiate "
 752                     "child script providers."),
 753                 Reference< XInterface >() );
 754         }
 755         Sequence < Reference< provider::XScriptProvider > > xSProviders =
 756             providerCache()->getAllProviders();
 757         for ( sal_Int32 index = 0; index < xSProviders.getLength(); index++ )
 758         {
 759             Reference< container::XNameContainer > xCont( xSProviders[ index ], UNO_QUERY );
 760             if ( !xCont.is() )
 761             {
 762                 continue;
 763             }
 764             try
 765             {
 766                 result = xCont->hasByName( aName );
 767                 if ( result == sal_True )
 768                 {
 769                     break;
 770                 }
 771             }
 772             catch ( Exception& )
 773             {
 774             }
 775
 776         }
 777     }
 778     return result;
 779 }
 780
 781 //*************************************************************************
 782 Sequence< ::rtl::OUString > SAL_CALL
 783 MasterScriptProvider::getElementNames(  ) throw ( RuntimeException)
 784 {
 785     // TODO needs implementing
 786     Sequence< ::rtl::OUString >  names;
 787     if ( true )
 788     {
 789         throw RuntimeException(  OUSTR("getElementNames not implemented!!!!") ,
 790                 Reference< XInterface >() );
 791     }
 792     return names;
 793 }
 794 //*************************************************************************
 795 Type SAL_CALL
 796 MasterScriptProvider::getElementType(  ) throw ( RuntimeException)
 797 {
 798     // TODO needs implementing
 799     Type t;
 800     return t;
 801 }
 802 //*************************************************************************
 803 sal_Bool SAL_CALL MasterScriptProvider::hasElements(  ) throw ( RuntimeException)
 804 {
 805     // TODO needs implementing
 806     if ( true )
 807     {
 808         throw RuntimeException(  OUSTR("hasElements not implemented!!!!") ,
 809                 Reference< XInterface >() );
 810     }
 811     return false;
 812 }
 813
 814 //*************************************************************************
 815 Sequence< Reference< provider::XScriptProvider > > SAL_CALL
 816 MasterScriptProvider::getAllProviders() throw ( css::uno::RuntimeException )
 817 {
 818     if ( providerCache() )
 819     {
 820         return providerCache()->getAllProviders();
 821     }
 822     else
 823     {
 824         ::rtl::OUString errorMsg = ::rtl::OUString::createFromAscii(
 825             "MasterScriptProvider::getAllProviders, cache not initialised");
 826         throw RuntimeException( errorMsg.concat( errorMsg ),
 827             Reference< XInterface >() );
 828     }
 829 }
 830
 831
 832 //*************************************************************************
 833 ::rtl::OUString SAL_CALL MasterScriptProvider::getImplementationName( )
 834 throw( RuntimeException )
 835 {
 836     return ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM (
 837         "com.sun.star.script.provider.MasterScriptProvider" ) );
 838 }
 839
 840 //*************************************************************************
 841 sal_Bool SAL_CALL MasterScriptProvider::supportsService( const ::rtl::OUString& serviceName )
 842 throw( RuntimeException )
 843 {
 844     Sequence< ::rtl::OUString > serviceNames( getSupportedServiceNames() );
 845     ::rtl::OUString const * pNames = serviceNames.getConstArray();
 846     for ( sal_Int32 nPos = serviceNames.getLength(); nPos--; )
 847     {
 848         if ( serviceName.equals( pNames[ nPos ] ) )
 849         {
 850             return sal_True;
 851         }
 852     }
 853     return sal_False;
 854 }
 855
 856 //*************************************************************************
 857 Sequence< ::rtl::OUString > SAL_CALL MasterScriptProvider::getSupportedServiceNames( )
 858 throw( RuntimeException )
 859 {
 860     ::rtl::OUString names[3];
 861
 862     names[0] = ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM (
 863         "com.sun.star.script.provider.MasterScriptProvider" ) );
 864     names[1] = ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM (
 865         "com.sun.star.script.browse.BrowseNode" ) );
 866     names[2] = ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM (
 867         "com.sun.star.script.provider.ScriptProvider" ) );
 868
 869     return Sequence< ::rtl::OUString >( names, 3 );
 870 }
 871
 872 } // namespace func_provider
 873
 874
 875 namespace browsenodefactory
 876 {
 877 ::rtl::OUString SAL_CALL bnf_getImplementationName() ;
 878 Reference< XInterface > SAL_CALL bnf_create( Reference< XComponentContext > const & xComponentContext );
 879 Sequence< ::rtl::OUString > SAL_CALL bnf_getSupportedServiceNames();
 880 }
 881
 882 namespace scripting_runtimemgr
 883 {
 884 //*************************************************************************
 885 Reference< XInterface > SAL_CALL sp_create(
 886     const Reference< XComponentContext > & xCompC )
 887 {
 888     return ( cppu::OWeakObject * ) new ::func_provider::MasterScriptProvider( xCompC );
 889 }
 890
 891 //*************************************************************************
 892 Sequence< ::rtl::OUString > sp_getSupportedServiceNames( )
 893     SAL_THROW( () )
 894 {
 895     ::rtl::OUString names[3];
 896
 897     names[0] = ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM (
 898         "com.sun.star.script.provider.MasterScriptProvider" ) );
 899     names[1] = ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM (
 900         "com.sun.star.script.browse.BrowseNode" ) );
 901     names[2] = ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM (
 902         "com.sun.star.script.provider.ScriptProvider" ) );
 903
 904     return Sequence< ::rtl::OUString >( names, 3 );
 905 }
 906
 907 //*************************************************************************
 908 ::rtl::OUString sp_getImplementationName( )
 909 SAL_THROW( () )
 910 {
 911     return ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM (
 912         "com.sun.star.script.provider.MasterScriptProvider" ) );
 913 }
 914
 915 // ***** registration or ScriptingFrameworkURIHelper
 916 Reference< XInterface > SAL_CALL urihelper_create(
 917     const Reference< XComponentContext > & xCompC )
 918 {
 919     return ( cppu::OWeakObject * )
 920         new ::func_provider::ScriptingFrameworkURIHelper( xCompC );
 921 }
 922
 923 Sequence< ::rtl::OUString > urihelper_getSupportedServiceNames( )
 924     SAL_THROW( () )
 925 {
 926     ::rtl::OUString serviceNameList[] = {
 927         ::rtl::OUString::createFromAscii(
 928             "com.sun.star.script.provider.ScriptURIHelper" ) };
 929
 930     Sequence< ::rtl::OUString > serviceNames = Sequence <
 931         ::rtl::OUString > ( serviceNameList, 1 );
 932
 933     return serviceNames;
 934 }
 935
 936 ::rtl::OUString urihelper_getImplementationName( )
 937     SAL_THROW( () )
 938 {
 939     return ::rtl::OUString::createFromAscii(
 940         "com.sun.star.script.provider.ScriptURIHelper");
 941 }
 942
 943 static struct cppu::ImplementationEntry s_entries [] =
 944     {
 945         {
 946             sp_create, sp_getImplementationName,
 947             sp_getSupportedServiceNames, cppu::createSingleComponentFactory,
 948             0, 0
 949         },
 950         {
 951             urihelper_create,
 952             urihelper_getImplementationName,
 953             urihelper_getSupportedServiceNames,
 954             cppu::createSingleComponentFactory,
 955             0, 0
 956         },
 957         {
 958             func_provider::mspf_create, func_provider::mspf_getImplementationName,
 959             func_provider::mspf_getSupportedServiceNames, cppu::createSingleComponentFactory,
 960             0, 0
 961         },
 962         {
 963             browsenodefactory::bnf_create, browsenodefactory::bnf_getImplementationName,
 964             browsenodefactory::bnf_getSupportedServiceNames, cppu::createSingleComponentFactory,
 965             0, 0
 966         },
 967         { 0, 0, 0, 0, 0, 0 }
 968     };
 969 }
 970
 971 //############################################################################
 972 //#### EXPORTED ##############################################################
 973 //############################################################################
 974
 975 /**
 976  * Gives the environment this component belongs to.
 977  */
 978 extern "C"
 979 {
 980     SAL_DLLPUBLIC_EXPORT void SAL_CALL component_getImplementationEnvironment(
 981             const sal_Char ** ppEnvTypeName, uno_Environment ** ppEnv )
 982     {
 983         (void)ppEnv;
 984         *ppEnvTypeName = CPPU_CURRENT_LANGUAGE_BINDING_NAME;
 985     }
 986
 987     /**
 988      * This function creates an implementation section in the registry and another subkey
 989      *
 990      * for each supported service.
 991      * @param pServiceManager   the service manager
 992      * @param pRegistryKey      the registry key
 993      */
 994     SAL_DLLPUBLIC_EXPORT sal_Bool SAL_CALL component_writeInfo(
 995             lang::XMultiServiceFactory * pServiceManager,
 996             registry::XRegistryKey * pRegistryKey )
 997     {
 998         if (::cppu::component_writeInfoHelper( pServiceManager, pRegistryKey,
 999             ::scripting_runtimemgr::s_entries ))
1000         {
1001             try
1002             {
1003                 // MasterScriptProviderFactory Mangager singleton
1004                 registry::XRegistryKey * pKey =
1005                     reinterpret_cast< registry::XRegistryKey * >(pRegistryKey);
1006
1007                 Reference< registry::XRegistryKey >xKey = pKey->createKey(
1008                     OUSTR("com.sun.star.script.provider.MasterScriptProviderFactory/UNO/SINGLETONS/com.sun.star.script.provider.theMasterScriptProviderFactory"));
1009                 xKey->setStringValue( OUSTR("com.sun.star.script.provider.MasterScriptProviderFactory") );
1010                 // BrowseNodeFactory Mangager singleton
1011                 xKey = pKey->createKey(
1012                     OUSTR("com.sun.star.script.browse.BrowseNodeFactory/UNO/SINGLETONS/com.sun.star.script.browse.theBrowseNodeFactory"));
1013                 xKey->setStringValue( OUSTR("com.sun.star.script.browse.BrowseNodeFactory") );
1014                 return sal_True;
1015             }
1016             catch (Exception &)
1017             {
1018             }
1019         }
1020         return sal_False;
1021     }
1022
1023     /**
1024      * This function is called to get service factories for an implementation.
1025      *
1026      * @param pImplName       name of implementation
1027      * @param pServiceManager a service manager, need for component creation
1028      * @param pRegistryKey    the registry key for this component, need for persistent
1029      *                        data
1030      * @return a component factory
1031      */
1032     SAL_DLLPUBLIC_EXPORT void * SAL_CALL component_getFactory(
1033         const sal_Char * pImplName,
1034         lang::XMultiServiceFactory * pServiceManager,
1035         registry::XRegistryKey * pRegistryKey )
1036     {
1037         return ::cppu::component_getFactoryHelper( pImplName, pServiceManager,
1038             pRegistryKey, ::scripting_runtimemgr::s_entries );
1039     }
1040 }