scripting/source/storage/ScriptStorageManager.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 // MARKER(update_precomp.py): autogen include statement, do not remove
  30 #include "precompiled_scripting.hxx"
  31
  32 #include <stdio.h>
  33
  34 #include <cppuhelper/implementationentry.hxx>
  35 #include <sal/config.h>
  36 #include <rtl/uri.hxx>
  37
  38 #include <com/sun/star/ucb/XSimpleFileAccess.hpp>
  39 #include <com/sun/star/util/XMacroExpander.hpp>
  40 #include <com/sun/star/lang/XComponent.hpp>
  41 #include <com/sun/star/lang/XMultiComponentFactory.hpp>
  42 #include <com/sun/star/beans/XPropertySet.hpp>
  43 #include <com/sun/star/frame/XModel.hpp>
  44 #include <drafts/com/sun/star/script/framework/storage/XScriptInfoAccess.hpp>
  45
  46 #include "ScriptStorageManager.hxx"
  47 #include <util/util.hxx>
  48 #include <util/scriptingconstants.hxx>
  49
  50 using namespace ::rtl;
  51 using namespace ::com::sun::star;
  52 using namespace ::com::sun::star::uno;
  53 using namespace ::drafts::com::sun::star::script::framework;
  54
  55 namespace scripting_impl
  56 {
  57
  58 static OUString s_implName =
  59     ::rtl::OUString::createFromAscii(
  60         "drafts.com.sun.star.script.framework.storage.ScriptStorageManager" );
  61 static OUString s_serviceName =
  62     ::rtl::OUString::createFromAscii(
  63         "drafts.com.sun.star.script.framework.storage.ScriptStorageManager" );
  64 static Sequence< OUString > s_serviceNames = Sequence< OUString >( &s_serviceName, 1 );
  65
  66 //extern ::rtl_StandardModuleCount s_moduleCount = MODULE_COUNT_INIT;
  67 //extern ::rtl_StandardModuleCount s_moduleCount;
  68
  69
  70 //*************************************************************************
  71 // ScriptStorageManager Constructor
  72 ScriptStorageManager::ScriptStorageManager( const Reference<
  73         XComponentContext > & xContext ) SAL_THROW ( ( RuntimeException ) )
  74         : m_xContext( xContext ), m_count( 0 ), m_securityMgr( xContext )
  75 {
  76     OSL_TRACE( "< ScriptStorageManager ctor called >\n" );
  77     //s_moduleCount.modCnt.acquire( &s_moduleCount.modCnt );
  78
  79     validateXRef( m_xContext,
  80                   "ScriptStorageManager::ScriptStorageManager : cannot get component context" );
  81
  82     m_xMgr = m_xContext->getServiceManager();
  83     validateXRef( m_xMgr,
  84                   "ScriptStorageManager::ScriptStorageManager : cannot get service manager" );
  85
  86     try
  87     {
  88         // obtain the macro expander singleton to use in determining the
  89         // location of the application script storage
  90         Any aAny = m_xContext->getValueByName( OUString::createFromAscii(
  91                                                    "/singletons/com.sun.star.util.theMacroExpander" ) );
  92         Reference< util::XMacroExpander > xME;
  93         if ( sal_False == ( aAny >>= xME ) )
  94         {
  95             throw RuntimeException(
  96                 OUSTR( "ScriptStorageManager::ScriptStorageManager: can't get XMacroExpander" ),
  97                 Reference< XInterface >() );
  98         }
  99         validateXRef( xME, "ScriptStorageManager constructor: can't get MacroExpander" );
 100
 101         OUString base = OUString::createFromAscii(
 102                             SAL_CONFIGFILE( "${$BRAND_BASE_DIR/program/bootstrap" ) );
 103
 104         setupAppStorage( xME,
 105                          base.concat( OUString::createFromAscii( "::BaseInstallation}/share" ) ),
 106                          OUSTR( "SHARE" ) );
 107         setupAppStorage( xME,
 108                          base.concat( OUString::createFromAscii( "::UserInstallation}/user" ) ),
 109                          OUSTR( "USER" ) );
 110
 111     }
 112     catch ( Exception & e )
 113     {
 114         throw RuntimeException( OUSTR( "ScriptStorageManager::ScriptStorageManager: " ).concat( e.Message ), Reference< XInterface >() );
 115     }
 116     OSL_ASSERT( m_count == 2 );
 117 }
 118
 119 //*************************************************************************
 120 // ScriptStorageManager setupAppStorage
 121 void
 122 ScriptStorageManager::setupAppStorage(
 123     const Reference< util::XMacroExpander > & xME,
 124     const OUString & storageStr,
 125     const OUString & appStr)
 126 SAL_THROW ( ( RuntimeException ) )
 127 {
 128     try
 129     {
 130         Reference< XInterface > xInterface =
 131             m_xMgr->createInstanceWithContext(
 132                 OUString::createFromAscii( "com.sun.star.ucb.SimpleFileAccess" ), m_xContext );
 133         validateXRef( xInterface,
 134                       "ScriptStorageManager constructor: can't get SimpleFileAccess XInterface" );
 135         Reference< ucb::XSimpleFileAccess > xSFA( xInterface, UNO_QUERY_THROW );
 136
 137         setupAnyStorage( xSFA, xME->expandMacros( storageStr ), appStr );
 138     }
 139     catch ( Exception & e )
 140     {
 141         throw RuntimeException(
 142             OUSTR( "ScriptStorageManager::setupAppStorage: " ).concat( e.Message ),
 143             Reference< XInterface >() );
 144     }
 145 }
 146
 147 //*************************************************************************
 148 // ScriptStorageManager setupAnyStorage
 149 sal_Int32
 150 ScriptStorageManager::setupAnyStorage(
 151     const Reference< ucb::XSimpleFileAccess > & xSFA,
 152     const OUString & storageStr,
 153     const OUString & origStringURI )
 154 SAL_THROW ( ( RuntimeException ) )
 155 {
 156     // Required for scope of fnc to protect all access read and writes to m_count
 157     ::osl::Guard< ::osl::Mutex > aGuard( m_mutex );
 158     try
 159     {
 160
 161         // create a ScriptingStorage using the SimpleFileAccess, the storageID
 162         // (from the count), and the URL to the application's shared area
 163         Sequence < Any > aArgs( 3 );
 164         aArgs[ 0 ] <<= xSFA;
 165         aArgs[ 1 ] <<= m_count;
 166         aArgs[ 2 ] <<= storageStr;
 167
 168         OSL_TRACE( "creating storage for: %s\n",
 169                    ::rtl::OUStringToOString( storageStr,
 170                                              RTL_TEXTENCODING_ASCII_US ).pData->buffer );
 171
 172         Reference< XInterface > xInterface =
 173             m_xMgr->createInstanceWithArgumentsAndContext(
 174                 OUString::createFromAscii(
 175                     "drafts.com.sun.star.script.framework.storage.ScriptStorage" ),
 176                 aArgs, m_xContext );
 177
 178         validateXRef( xInterface, "ScriptStorageManager:: setupAnyStorage: Can't create ScriptStorage for share" );
 179
 180         // and place it in the hash_map. Increment the counter
 181         m_ScriptStorageMap[ m_count++ ] = xInterface;
 182         sal_Int32 sid =  m_count - 1;
 183
 184         // create hash of original uri i.e. file:///home/users/docs/mydoc.sxw
 185         // and storage id (sid) this will allow us to retrieve
 186         // the sid based on the url of the document.
 187         m_StorageIdOrigURIHash [ origStringURI ] = sid;
 188         OSL_TRACE( "\tcreated with ID=%d\n", m_count - 1 );
 189
 190     }
 191     catch ( Exception & e )
 192     {
 193         throw RuntimeException(
 194             OUSTR( "ScriptStorageManager::setupAnyStorage: " ).concat(
 195                 e.Message ), Reference< XInterface >() );
 196     }
 197
 198     return m_count -1;
 199 }
 200
 201 //*************************************************************************
 202 // ScriptStorageManager Destructor
 203 ScriptStorageManager::~ScriptStorageManager()
 204 SAL_THROW ( () )
 205 {
 206     OSL_TRACE( "< ScriptStorageManager dtor called >\n" );
 207 //    s_moduleCount.modCnt.release( &s_moduleCount.modCnt );
 208 }
 209
 210 //*************************************************************************
 211 // This method assumes that the XSimpleFileAccess knows it's on root URL
 212 // and can be used with relative URLs
 213 sal_Int32 SAL_CALL
 214 ScriptStorageManager::createScriptStorage(
 215     const Reference< ucb::XSimpleFileAccess >& xSFA )
 216 throw ( RuntimeException )
 217 {
 218     OSL_TRACE( "** ==> ScriptStorageManager in createScriptingStorage\n" );
 219     validateXRef( xSFA,
 220                   "ScriptStorageManager::createScriptStorage: XSimpleFileAccess is not valid" );
 221
 222     return setupAnyStorage( xSFA, ::rtl::OUString::createFromAscii( "" ),
 223                             ::rtl::OUString::createFromAscii( "" ) );
 224 }
 225
 226 //*************************************************************************
 227 sal_Int32 SAL_CALL
 228 ScriptStorageManager::createScriptStorageWithURI(
 229     const Reference< ucb::XSimpleFileAccess >& xSFA, const OUString & cStringURI )
 230 throw ( RuntimeException )
 231 {
 232     OSL_TRACE( "** ==> ScriptStorageManager in createScriptingStorageWithURI\n" );
 233     validateXRef( xSFA, "ScriptStorageManager::createScriptStorage: XSimpleFileAccess is not valid" );
 234
 235     // related to issue 11866
 236     // warning dialog gets launched when adding binding to script in doc
 237     // workaround issue: no functionProvider created on doc open
 238     // if NODIALOG tag, strip from stringURI, set boolean=true
 239     bool displayDialog = true;
 240     ::rtl::OUString dialogTag = ::rtl::OUString::createFromAscii( "NoDialog::" );
 241     ::rtl::OUString stringURI = cStringURI;
 242     if( stringURI.indexOf( dialogTag ) == 0 )
 243     {
 244         OSL_TRACE( "ScriptStorageManager::createScriptStorage: will not display security dialogs" );
 245         stringURI = stringURI.copy( dialogTag.getLength() );
 246         displayDialog = false;
 247     }
 248     sal_Int32 returnedID = getScriptStorageID(stringURI);
 249
 250
 251     // convert file:///... url to vnd... syntax
 252     ::rtl::OUString canonicalURI(
 253         ::rtl::OUString::createFromAscii( "vnd.sun.star.pkg://" ) );
 254     canonicalURI = canonicalURI.concat( ::rtl::Uri::encode( stringURI,
 255                                         rtl_UriCharClassUricNoSlash, rtl_UriEncodeCheckEscapes,
 256                                         RTL_TEXTENCODING_ASCII_US ) );
 257
 258     if (returnedID == -1)
 259     {
 260         OSL_TRACE("Creating new storage for %s",
 261             ::rtl::OUStringToOString( stringURI,
 262                 RTL_TEXTENCODING_ASCII_US ).pData->buffer );
 263         returnedID = setupAnyStorage( xSFA, canonicalURI, stringURI );
 264     }
 265     else
 266     {
 267        OSL_TRACE("Using existing storage for %s",
 268            ::rtl::OUStringToOString( stringURI,
 269                RTL_TEXTENCODING_ASCII_US ).pData->buffer );
 270     }
 271
 272 // np - removed previous scripting framework security handling
 273 // now handled by modification to existing calls in sfx for basic
 274 //
 275 /*    if( displayDialog )
 276     {
 277         try
 278         {
 279            OSL_TRACE("Adding to security mgr for %s",
 280                ::rtl::OUStringToOString( stringURI,
 281                    RTL_TEXTENCODING_ASCII_US ).pData->buffer );
 282             m_securityMgr.addScriptStorage( stringURI, returnedID );
 283         }
 284         catch ( RuntimeException & rte )
 285         {
 286             throw RuntimeException(
 287                 OUSTR( "ScriptStorageManager::createScriptStorageWithURI: " ).concat(
 288                     rte.Message ), Reference< XInterface >() );
 289         }
 290     }
 291     else
 292     {
 293        OSL_TRACE("No need to security mgr for %s",
 294            ::rtl::OUStringToOString( stringURI,
 295                RTL_TEXTENCODING_ASCII_US ).pData->buffer );
 296     }*/
 297     return returnedID;
 298 }
 299
 300 //*************************************************************************
 301 Reference < XInterface > SAL_CALL
 302 ScriptStorageManager::getScriptStorage( sal_Int32 scriptStorageID )
 303 throw( RuntimeException )
 304 {
 305     OSL_TRACE( "** ==> ScriptStorageManager in getStorageInstance\n" );
 306     OSL_TRACE( "** ==> request for id=%d",scriptStorageID );
 307
 308     ScriptStorage_map::const_iterator itr =
 309         m_ScriptStorageMap.find( scriptStorageID );
 310
 311     if ( itr == m_ScriptStorageMap.end() )
 312     {
 313         throw RuntimeException(
 314             OUSTR( "ScriptStorageManager::getScriptStorage: invalid storage ID" ),
 315             Reference< XInterface >() );
 316     }
 317     validateXRef( itr->second,
 318                   "ScriptStorageManager::getScriptStorage: Cannot get ScriptStorage from ScriptStorageHash" );
 319     return itr->second;
 320 }
 321
 322 //*******************************************************************
 323 sal_Int32 SAL_CALL
 324 ScriptStorageManager::getScriptStorageID( const ::rtl::OUString& origURI )
 325         throw (::com::sun::star::uno::RuntimeException)
 326 {
 327     StorageId_hash::const_iterator it = m_StorageIdOrigURIHash.find( origURI );
 328
 329     if ( it == m_StorageIdOrigURIHash.end() )
 330     {
 331         OUString message = OUSTR( "ScriptStorageManager::getScriptStorageID(): Cannot find storage for " );
 332         if ( origURI.getLength() == 0 )
 333         {
 334             message = message.concat( OUSTR("Empty URI") );
 335         }
 336         else
 337         {
 338             message = message.concat( origURI );
 339         }
 340         OSL_TRACE( ::rtl::OUStringToOString( message,
 341                                             RTL_TEXTENCODING_ASCII_US ).pData->buffer );
 342         return -1;
 343     }
 344
 345     return it->second;
 346 }
 347
 348 //*******************************************************************
 349 void
 350 ScriptStorageManager::removeScriptDocURIHashEntry( const OUString & origURI )
 351 {
 352     StorageId_hash::iterator it = m_StorageIdOrigURIHash.find( origURI );
 353     if ( it == m_StorageIdOrigURIHash.end() )
 354     {
 355         OSL_TRACE( "ScriptStorageManager::removeScriptDocURIHashEntry: no entry to remove" );
 356         return;
 357     }
 358
 359     // remove entry for this doc url from orig uri map.
 360     m_StorageIdOrigURIHash.erase( it );
 361 }
 362
 363 //*******************************************************************
 364 void SAL_CALL
 365 ScriptStorageManager::refreshScriptStorage( const OUString & stringURI )
 366 throw( RuntimeException )
 367 {
 368     OSL_TRACE( "** => ScriptStorageManager in refreshScriptStorage\n" );
 369     OSL_TRACE( "** => refreshing URI: %s\n",
 370                ::rtl::OUStringToOString(
 371                    stringURI, RTL_TEXTENCODING_ASCII_US ).pData->buffer);
 372
 373     sal_Int32 storageID = getScriptStorageID( stringURI );
 374
 375     if ( storageID == -1 )
 376     {
 377         OSL_TRACE( "** id was -1, no storage");
 378         // Refreshing noexistent storage - just return
 379         return;
 380     }
 381
 382     try
 383     {
 384         Reference < storage::XScriptStorageRefresh > xSSR(
 385             getScriptStorage( storageID ), UNO_QUERY );
 386
 387         xSSR->refresh();
 388     }
 389     catch ( RuntimeException & e )
 390     {
 391         throw RuntimeException(
 392             OUSTR( "ScriptStorageManager::refreshScriptStorage: " ).concat(
 393                 e.Message ), Reference< XInterface >() );
 394     }
 395     catch ( Exception & e )
 396     {
 397         throw RuntimeException(
 398             OUSTR( "ScriptStorageManager::refreshScriptStorage: " ).concat(
 399                 e.Message ), Reference< XInterface >() );
 400     }
 401 }
 402
 403 //*************************************************************************
 404 void SAL_CALL
 405 ScriptStorageManager::checkPermission( const OUString &
 406 scriptStorageURI, const OUString & permissionRequest )
 407 throw ( RuntimeException, lang::IllegalArgumentException, css::security::AccessControlException )
 408 {
 409     try
 410     {
 411         m_securityMgr.checkPermission( scriptStorageURI, permissionRequest );
 412     }
 413     catch ( css::security::AccessControlException & e )
 414     {
 415         throw css::security::AccessControlException(
 416             OUSTR( "ScriptStorageManager::checkPermission: AccessControlException: " ).concat(
 417                 e.Message ), Reference< XInterface >(), e.LackingPermission );
 418     }
 419     catch ( lang::IllegalArgumentException & e )
 420     {
 421         throw lang::IllegalArgumentException(
 422             OUSTR( "ScriptStorageManager::checkPermission: IllegalArgumentException: " ).concat(
 423                 e.Message ), Reference< XInterface >(), e.ArgumentPosition );
 424     }
 425     catch ( RuntimeException & e )
 426     {
 427         throw RuntimeException(
 428             OUSTR( "ScriptStorageManager::checkPermission: RuntimeException: " ).concat(
 429                 e.Message ), Reference< XInterface >() );
 430     }
 431 }
 432
 433 //*************************************************************************
 434 OUString SAL_CALL
 435 ScriptStorageManager::getImplementationName( )
 436 throw( RuntimeException )
 437 {
 438     return s_implName;
 439 }
 440
 441 //*************************************************************************
 442 sal_Bool SAL_CALL
 443 ScriptStorageManager::supportsService( const OUString& serviceName )
 444 throw( RuntimeException )
 445 {
 446     OUString const * pNames = s_serviceNames.getConstArray();
 447     for ( sal_Int32 nPos = s_serviceNames.getLength(); nPos--; )
 448     {
 449         if ( serviceName.equals( pNames[ nPos ] ) )
 450         {
 451             return sal_True;
 452         }
 453     }
 454     return sal_False;
 455 }
 456
 457 //*************************************************************************
 458 Sequence< OUString > SAL_CALL
 459 ScriptStorageManager::getSupportedServiceNames( )
 460 throw( RuntimeException )
 461 {
 462     return s_serviceNames;
 463 }
 464
 465 //*************************************************************************
 466 void SAL_CALL
 467 ScriptStorageManager::disposing( const ::com::sun::star::lang::EventObject& Source )
 468 throw ( ::com::sun::star::uno::RuntimeException )
 469 {
 470     OSL_TRACE( "ScriptStorageManager::disposing started" );
 471     OSL_TRACE( "event object type=%s",
 472                       ::rtl::OUStringToOString( getCppuType( &Source ).getTypeName(),
 473                                                 RTL_TEXTENCODING_ASCII_US ).pData->buffer );
 474     OUString storageURI;
 475     bool removeSecurityPermission = true;
 476     try
 477     {
 478         Reference< XInterface > xInterface = Source.Source;
 479         // no UNO_QUERY_THROW since we want a 2nd change to query if it's
 480         // not a document being disposed
 481         Reference< frame::XModel > xModel = Reference< frame::XModel > ( xInterface, UNO_QUERY );
 482         if( xModel.is() )
 483         {
 484             storageURI = xModel->getURL();
 485         }
 486         else
 487         {
 488             // UNO_QURY_THROW here since it's supposed to be either a doc
 489             // or a XScriptInfo (in the case of a filesys script)
 490             Reference< storage::XScriptInfo > xScriptInfo = Reference< storage::XScriptInfo > ( xInterface, UNO_QUERY_THROW );
 491             storageURI = xScriptInfo->getParcelURI().concat( xScriptInfo->getFunctionName() );
 492             // to save the user seeing the security dialogs every time they
 493             // run the script we hang on to the permission for a given script
 494             // for the lifetime of the Office
 495             removeSecurityPermission = false;
 496             // possibly need to encode it??
 497         }
 498         if ( storageURI.getLength() > 0 )
 499         {
 500             OSL_TRACE( "URI disposing is ... %s",
 501                       ::rtl::OUStringToOString( storageURI,
 502                                                 RTL_TEXTENCODING_ASCII_US ).pData->buffer );
 503         }
 504     }
 505     catch ( RuntimeException& e )
 506     {
 507         OUString message =
 508             OUSTR(
 509                 "ScriptStorageManager::disposing: can't get script context, reason = " );
 510         message = message.concat( e.Message );
 511         OSL_TRACE( ::rtl::OUStringToOString( message,
 512                                             RTL_TEXTENCODING_ASCII_US ).pData->buffer );
 513         return;
 514     }
 515
 516
 517     // grab storage id.
 518     sal_Int32 scriptStorageID = getScriptStorageID( storageURI );
 519
 520     // no need to do anything if there's no doc storage
 521     if( scriptStorageID == -1 )
 522     {
 523         return;
 524     }
 525
 526     OSL_TRACE( "disposing storageID = %d", scriptStorageID );
 527
 528     // attempt to get the storage from the hash to ensure that we have a
 529     // valid storageID
 530     ScriptStorage_map::const_iterator itr =
 531         m_ScriptStorageMap.find( scriptStorageID );
 532
 533     if ( itr == m_ScriptStorageMap.end() )
 534     {
 535         OSL_TRACE( "Entry for storage id %d doesn't exist in map", scriptStorageID );
 536         return;
 537     }
 538
 539     // erase the entry from the hash
 540     m_ScriptStorageMap.erase( scriptStorageID );
 541     removeScriptDocURIHashEntry( storageURI );
 542     if ( removeSecurityPermission )
 543     {
 544         m_securityMgr.removePermissionSettings ( storageURI );
 545     }
 546 }
 547 } // Namespace
 548
 549 namespace scripting_runtimemgr
 550 {
 551 //*************************************************************************
 552 Reference< XInterface > SAL_CALL
 553 ssm_create(
 554     const Reference< XComponentContext > & xCompC )
 555 {
 556     return ( cppu::OWeakObject * ) new ::scripting_impl::ScriptStorageManager( xCompC );
 557 }
 558
 559 //*************************************************************************
 560 Sequence< OUString >
 561 ssm_getSupportedServiceNames( )
 562 SAL_THROW( () )
 563 {
 564     return ::scripting_impl::s_serviceNames;
 565 }
 566
 567 //*************************************************************************
 568 OUString
 569 ssm_getImplementationName( )
 570 SAL_THROW( () )
 571 {
 572     return ::scripting_impl::s_implName;
 573 }
 574 }
 575
 576 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */