diff --git a/include/sal/log-areas.dox b/include/sal/log-areas.dox index f6b67006b255..b365b20e1622 100644 --- a/include/sal/log-areas.dox +++ b/include/sal/log-areas.dox @@ -456,6 +456,7 @@ certain functionality. @section stoc @li @c stoc.corerefl - CoreReflection +@li @c stoc.java - javaloader and javavm @section VCL diff --git a/officecfg/registry/schema/org/openoffice/Office/Java.xcs b/officecfg/registry/schema/org/openoffice/Office/Java.xcs index 72ec1b8cea02..cda437daa9bb 100644 --- a/officecfg/registry/schema/org/openoffice/Office/Java.xcs +++ b/officecfg/registry/schema/org/openoffice/Office/Java.xcs @@ -104,6 +104,13 @@ Specifies properties for use with the Java VM. + + + Specifies whether JVM based UNO components are run via uno command outside the LibreOffice process. + + + false + diff --git a/solenv/gbuild/CppunitTest.mk b/solenv/gbuild/CppunitTest.mk index 995910cfbd0c..9545f0c52f1d 100644 --- a/solenv/gbuild/CppunitTest.mk +++ b/solenv/gbuild/CppunitTest.mk @@ -93,7 +93,7 @@ $(if $(URE),\ $(if $(strip $(UNO_TYPES)),\ "-env:UNO_TYPES=$(foreach item,$(UNO_TYPES),$(call gb_Helper_make_url,$(item)))") \ $(if $(strip $(UNO_SERVICES)),\ - "-env:UNO_SERVICES=$(foreach item,$(UNO_SERVICES),$(call gb_Helper_make_url,$(item)))") \ + "-env:UNO_SERVICES=$(foreach item,$(UNO_SERVICES),$(call gb_Helper_make_url,$(item)))" -env:URE_BIN_DIR=$(call gb_Helper_make_url,$(INSTROOT)/$(LIBO_URE_BIN_FOLDER))) \ -env:URE_INTERNAL_LIB_DIR=$(call gb_Helper_make_url,$(INSTROOT)/$(LIBO_URE_LIB_FOLDER)) \ -env:LO_LIB_DIR=$(call gb_Helper_make_url,$(INSTROOT)/$(LIBO_LIB_FOLDER)) \ -env:LO_JAVA_DIR=$(call gb_Helper_make_url,$(INSTROOT)/$(LIBO_SHARE_JAVA_FOLDER)) \ diff --git a/stoc/source/javaloader/javaloader.component b/stoc/source/javaloader/javaloader.component index cc4ae610bdb2..e8d1533bac51 100644 --- a/stoc/source/javaloader/javaloader.component +++ b/stoc/source/javaloader/javaloader.component @@ -20,7 +20,8 @@ + constructor="stoc_JavaComponentLoader_get_implementation" + single-instance="true"> diff --git a/stoc/source/javaloader/javaloader.cxx b/stoc/source/javaloader/javaloader.cxx index be8e1c2a01ba..9b9195fbda66 100644 --- a/stoc/source/javaloader/javaloader.cxx +++ b/stoc/source/javaloader/javaloader.cxx @@ -43,20 +43,31 @@ #pragma clang diagnostic pop #endif +#include +#include +#include +#include #include -#include +#include +#include #include +#include +#include #include #include #include #include +#include #include #include +// this one is header-only +#include + namespace com::sun::star::registry { class XRegistryKey; } using namespace css::java; @@ -72,10 +83,167 @@ namespace stoc_javaloader { namespace { -class JavaComponentLoader : public WeakImplHelper +// from desktop/source/deployment/misc/dp_misc.cxx +OUString generateRandomPipeId() { + // compute some good pipe id: + static rtlRandomPool s_hPool = rtl_random_createPool(); + if (s_hPool == nullptr) + throw RuntimeException( "cannot create random pool!?", nullptr ); + sal_uInt8 bytes[ 32 ]; + if (rtl_random_getBytes( + s_hPool, bytes, SAL_N_ELEMENTS(bytes) ) != rtl_Random_E_None) { + throw RuntimeException( "random pool error!?", nullptr ); + } + OUStringBuffer buf; + for (unsigned char byte : bytes) { + buf.append( static_cast(byte), 0x10 ); + } + return buf.makeStringAndClear(); +} + +// from desktop/source/deployment/registry/component/dp_component.cxx +/** return a vector of bootstrap variables which have been provided + as command arguments. +*/ +std::vector getCmdBootstrapVariables() +{ + std::vector ret; + sal_uInt32 count = osl_getCommandArgCount(); + for (sal_uInt32 i = 0; i < count; i++) + { + OUString arg; + osl_getCommandArg(i, &arg.pData); + if (arg.startsWith("-env:")) + ret.push_back(arg); + } + return ret; +} + +// from desktop/source/deployment/misc/dp_misc.cxx +oslProcess raiseProcess( + OUString const & appURL, Sequence const & args ) +{ + ::osl::Security sec; + oslProcess hProcess = nullptr; + oslProcessError rc = osl_executeProcess( + appURL.pData, + reinterpret_cast( + const_cast(args.getConstArray()) ), + args.getLength(), + osl_Process_DETACHED, + sec.getHandle(), + nullptr, // => current working dir + nullptr, 0, // => no env vars + &hProcess ); + + switch (rc) { + case osl_Process_E_None: + break; + case osl_Process_E_NotFound: + throw RuntimeException( "image not found!", nullptr ); + case osl_Process_E_TimedOut: + throw RuntimeException( "timeout occurred!", nullptr ); + case osl_Process_E_NoPermission: + throw RuntimeException( "permission denied!", nullptr ); + case osl_Process_E_Unknown: + throw RuntimeException( "unknown error!", nullptr ); + case osl_Process_E_InvalidError: + default: + throw RuntimeException( "unmapped error!", nullptr ); + } + + return hProcess; +} + +// from desktop/source/deployment/registry/component/dp_component.cxx +Reference raise_uno_process( + Reference const & xContext) +{ + OSL_ASSERT( xContext.is() ); + + OUString const url(css::util::theMacroExpander::get(xContext)->expandMacros("$URE_BIN_DIR/uno")); + + const OUString connectStr = "uno:pipe,name=" + generateRandomPipeId() + ";urp;uno.ComponentContext"; + + // raise core UNO process to register/run a component, + // javavm service uses unorc next to executable to retrieve deployed + // jar typelibs + + std::vector args{ +#if OSL_DEBUG_LEVEL == 0 + "--quiet", +#endif + "--singleaccept", + "-u", + connectStr, + // don't inherit from unorc: + "-env:INIFILENAME=" }; + + //now add the bootstrap variables which were supplied on the command line + std::vector bootvars = getCmdBootstrapVariables(); + args.insert(args.end(), bootvars.begin(), bootvars.end()); + + oslProcess hProcess; + try { + hProcess = raiseProcess(url, comphelper::containerToSequence(args)); + } + catch (...) { + OUStringBuffer sMsg = "error starting process: " + url; + for (const auto& arg : args) { + sMsg.append(" " + arg); + } + throw css::uno::RuntimeException(sMsg.makeStringAndClear()); + } + try { + // from desktop/source/deployment/misc/dp_misc.cxx + Reference const xUnoUrlResolver( + css::bridge::UnoUrlResolver::create(xContext) ); + + for (int i = 0; i <= 40; ++i) // 20 seconds + { + try { + return Reference( + xUnoUrlResolver->resolve(connectStr), + UNO_QUERY_THROW ); + } + catch (const css::connection::NoConnectException &) { + if (i < 40) { + ::osl::Thread::wait( std::chrono::milliseconds(500) ); + } + else throw; + } + } + return nullptr; // warning C4715 + } + catch (...) { + // try to terminate process: + if ( osl_terminateProcess( hProcess ) != osl_Process_E_None ) + { + OSL_ASSERT( false ); + } + throw; + } +} + +class JavaComponentLoader + : protected ::cppu::BaseMutex + , public WeakComponentImplHelper +{ + /** local context */ css::uno::Reference m_xComponentContext; + + /** possible remote process' context (use depends on configuration). + note: lifetime must be effectively "static" as this JavaComponentLoader + has no control over the lifetime of the services created via this + context; hence JavaComponentLoader is a single-instance service. + */ + css::uno::Reference m_xRemoteComponentContext; + /** Do not use m_javaLoader directly. Instead use getJavaLoader. + This is either an in-process loader implemented in Java, + or a remote instance of JavaComponentLoader running in uno process, + acting as a proxy. */ css::uno::Reference m_javaLoader; /** The returned Reference contains a null pointer if the office is not configured @@ -85,7 +253,7 @@ class JavaComponentLoader : public WeakImplHelper & getJavaLoader(); + const css::uno::Reference & getJavaLoader(OUString &); public: @@ -98,6 +266,8 @@ public: virtual sal_Bool SAL_CALL supportsService(const OUString& ServiceName) override; virtual Sequence SAL_CALL getSupportedServiceNames() override; + virtual void SAL_CALL disposing() override; + // XImplementationLoader virtual css::uno::Reference SAL_CALL activate( const OUString& implementationName, const OUString& implementationLoaderUrl, @@ -109,7 +279,21 @@ public: } -const css::uno::Reference & JavaComponentLoader::getJavaLoader() +void JavaComponentLoader::disposing() +{ + // Explicitly drop all remote refs to shut down the uno.bin process + // and particularly the connection to it, so that it can't do more calls + // during late shutdown. + m_javaLoader.clear(); + if (m_xRemoteComponentContext.is()) { + Reference const xComp(m_xRemoteComponentContext, UNO_QUERY); + assert(xComp.is()); + xComp->dispose(); + m_xRemoteComponentContext.clear(); + } +} + +const css::uno::Reference & JavaComponentLoader::getJavaLoader(OUString & rRemoteArg) { static Mutex ourMutex; MutexGuard aGuard(ourMutex); @@ -117,6 +301,42 @@ const css::uno::Reference & JavaComponentLoader::getJavaL if (m_javaLoader.is()) return m_javaLoader; + // check if the JVM should be instantiated out-of-process + if (rRemoteArg.isEmpty()) { + if (!m_xRemoteComponentContext.is()) { + Reference const xConf( + m_xComponentContext->getServiceManager()->createInstanceWithArgumentsAndContext( + "com.sun.star.configuration.ReadOnlyAccess", + { Any(OUString("*")) }, // locale isn't relevant here + m_xComponentContext), + UNO_QUERY); + + // configmgr is not part of URE, so may not exist! + if (xConf.is()) { + Any const value(xConf->getByHierarchicalName( + "org.openoffice.Office.Java/VirtualMachine/RunUnoComponentsOutOfProcess")); + bool b; + if ((value >>= b) && b) { + SAL_INFO("stoc.java", "JavaComponentLoader: starting uno process"); + m_xRemoteComponentContext = raise_uno_process(m_xComponentContext); + } + } + } + if (m_xRemoteComponentContext.is()) { + SAL_INFO("stoc.java", "JavaComponentLoader: creating remote instance to start JVM in uno process"); + // create JVM service in remote uno.bin process + Reference const xLoader( + m_xRemoteComponentContext->getServiceManager()->createInstanceWithContext( + "com.sun.star.loader.Java2", m_xRemoteComponentContext), + UNO_QUERY_THROW); + assert(xLoader.is()); + m_javaLoader = xLoader; + rRemoteArg = "remote"; + SAL_INFO("stoc.java", "JavaComponentLoader: remote proxy instance created: " << m_javaLoader.get()); + return m_javaLoader; + } + } + uno_Environment * pJava_environment = nullptr; uno_Environment * pUno_environment = nullptr; typelib_InterfaceTypeDescription * pType_XImplementationLoader = nullptr; @@ -275,9 +495,9 @@ const css::uno::Reference & JavaComponentLoader::getJavaL return m_javaLoader; } -JavaComponentLoader::JavaComponentLoader(const css::uno::Reference & xCtx) : - m_xComponentContext(xCtx) - +JavaComponentLoader::JavaComponentLoader(const css::uno::Reference & xCtx) + : WeakComponentImplHelper(m_aMutex) + , m_xComponentContext(xCtx) { } @@ -304,27 +524,29 @@ sal_Bool SAL_CALL JavaComponentLoader::writeRegistryInfo( const css::uno::Reference & xKey, const OUString & blabla, const OUString & rLibName) { - const css::uno::Reference & loader = getJavaLoader(); + OUString remoteArg(blabla); + const css::uno::Reference & loader = getJavaLoader(remoteArg); if (!loader.is()) throw CannotRegisterImplementationException("Could not create Java implementation loader"); - return loader->writeRegistryInfo(xKey, blabla, rLibName); + return loader->writeRegistryInfo(xKey, remoteArg, rLibName); } css::uno::Reference SAL_CALL JavaComponentLoader::activate( const OUString & rImplName, const OUString & blabla, const OUString & rLibName, const css::uno::Reference & xKey) { + OUString remoteArg(blabla); if (rImplName.isEmpty() && blabla.isEmpty() && rLibName.isEmpty()) { // preload JVM was requested - (void)getJavaLoader(); + (void)getJavaLoader(remoteArg); return css::uno::Reference(); } - const css::uno::Reference & loader = getJavaLoader(); + const css::uno::Reference & loader = getJavaLoader(remoteArg); if (!loader.is()) throw CannotActivateFactoryException("Could not create Java implementation loader"); - return loader->activate(rImplName, blabla, rLibName, xKey); + return loader->activate(rImplName, remoteArg, rLibName, xKey); } extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface*