pyuno/source/loader/pyuno_loader.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 #include <config_features.h>
  21 #include <config_folders.h>
  22
  23 #include <pyuno.hxx>
  24
  25 #include <o3tl/any.hxx>
  26 #include <o3tl/char16_t2wchar_t.hxx>
  27
  28 #include <osl/process.h>
  29 #include <osl/file.hxx>
  30 #include <osl/thread.h>
  31
  32 #include <rtl/ustrbuf.hxx>
  33 #include <rtl/bootstrap.hxx>
  34
  35 #include <cppuhelper/factory.hxx>
  36
  37 #include <com/sun/star/uno/XComponentContext.hpp>
  38
  39 // apparently PATH_MAX is not standard and not defined by MSVC
  40 #ifndef PATH_MAX
  41 #ifdef _MAX_PATH
  42 #define PATH_MAX _MAX_PATH
  43 #else
  44 #ifdef MAX_PATH
  45 #define PATH_MAX MAX_PATH
  46 #else
  47 #error no PATH_MAX
  48 #endif
  49 #endif
  50 #endif
  51
  52 using pyuno::PyRef;
  53 using pyuno::NOT_NULL;
  54 using pyuno::Runtime;
  55 using pyuno::PyThreadAttach;
  56
  57 using com::sun::star::uno::Reference;
  58 using com::sun::star::uno::XInterface;
  59 using com::sun::star::uno::Sequence;
  60 using com::sun::star::uno::XComponentContext;
  61 using com::sun::star::uno::RuntimeException;
  62
  63 namespace pyuno_loader
  64 {
  65
  66 /// @throws RuntimeException
  67 static void raiseRuntimeExceptionWhenNeeded()
  68 {
  69     if( PyErr_Occurred() )
  70     {
  71         PyRef excType, excValue, excTraceback;
  72         PyErr_Fetch(reinterpret_cast<PyObject **>(&excType), reinterpret_cast<PyObject**>(&excValue), reinterpret_cast<PyObject**>(&excTraceback));
  73         Runtime runtime;
  74         css::uno::Any a = runtime.extractUnoException( excType, excValue, excTraceback );
  75         OUStringBuffer buf;
  76         buf.append( "python-loader:" );
  77         if( auto e = o3tl::tryAccess<css::uno::Exception>(a) )
  78             buf.append( e->Message );
  79         throw RuntimeException( buf.makeStringAndClear() );
  80     }
  81 }
  82
  83 /// @throws RuntimeException
  84 static PyRef getLoaderModule()
  85 {
  86     PyRef module(
  87         PyImport_ImportModule( "pythonloader" ),
  88         SAL_NO_ACQUIRE );
  89     raiseRuntimeExceptionWhenNeeded();
  90     if( !module.is() )
  91     {
  92         throw RuntimeException( "pythonloader: Couldn't load pythonloader module" );
  93     }
  94     return PyRef( PyModule_GetDict( module.get() ));
  95 }
  96
  97 /// @throws RuntimeException
  98 static PyRef getObjectFromLoaderModule( const char * func )
  99 {
 100     PyRef object( PyDict_GetItemString(getLoaderModule().get(), func ) );
 101     if( !object.is() )
 102     {
 103         throw RuntimeException( "pythonloader: couldn't find core element pythonloader." +
 104                 OUString::createFromAscii( func ));
 105     }
 106     return object;
 107 }
 108
 109 static void setPythonHome ( const OUString & pythonHome )
 110 {
 111     OUString systemPythonHome;
 112     osl_getSystemPathFromFileURL( pythonHome.pData, &(systemPythonHome.pData) );
 113     // static because Py_SetPythonHome just copies the "wide" pointer
 114     static wchar_t wide[PATH_MAX + 1];
 115 #if defined _WIN32
 116     const size_t len = systemPythonHome.getLength();
 117     if (len < std::size(wide))
 118         wcsncpy(wide, o3tl::toW(systemPythonHome.getStr()), len + 1);
 119 #else
 120     OString o = OUStringToOString(systemPythonHome, osl_getThreadTextEncoding());
 121     size_t len = mbstowcs(wide, o.pData->buffer, PATH_MAX + 1);
 122     if(len == size_t(-1))
 123     {
 124         PyErr_SetString(PyExc_SystemError, "invalid multibyte sequence in python home path");
 125         return;
 126     }
 127 #endif
 128     if(len >= PATH_MAX + 1)
 129     {
 130         PyErr_SetString(PyExc_SystemError, "python home path is too long");
 131         return;
 132     }
 133     Py_SetPythonHome(wide);
 134 }
 135
 136 static void prependPythonPath( const OUString & pythonPathBootstrap )
 137 {
 138     OUStringBuffer bufPYTHONPATH( 256 );
 139     bool bAppendSep = false;
 140     sal_Int32 nIndex = 0;
 141     while( true )
 142     {
 143         sal_Int32 nNew = pythonPathBootstrap.indexOf( ' ', nIndex );
 144         OUString fileUrl;
 145         if( nNew == -1 )
 146         {
 147             fileUrl = pythonPathBootstrap.copy(nIndex);
 148         }
 149         else
 150         {
 151             fileUrl = pythonPathBootstrap.copy(nIndex, nNew - nIndex);
 152         }
 153         OUString systemPath;
 154         osl_getSystemPathFromFileURL( fileUrl.pData, &(systemPath.pData) );
 155         if (!systemPath.isEmpty())
 156         {
 157             if (bAppendSep)
 158                 bufPYTHONPATH.append(static_cast<sal_Unicode>(SAL_PATHSEPARATOR));
 159             bufPYTHONPATH.append(systemPath);
 160             bAppendSep = true;
 161         }
 162         if( nNew == -1 )
 163             break;
 164         nIndex = nNew + 1;
 165     }
 166     const char * oldEnv = getenv( "PYTHONPATH");
 167     if( oldEnv )
 168     {
 169         if (bAppendSep)
 170             bufPYTHONPATH.append( static_cast<sal_Unicode>(SAL_PATHSEPARATOR) );
 171         bufPYTHONPATH.append( OUString(oldEnv, strlen(oldEnv), osl_getThreadTextEncoding()) );
 172     }
 173
 174     OUString envVar("PYTHONPATH");
 175     OUString envValue(bufPYTHONPATH.makeStringAndClear());
 176     osl_setEnvironment(envVar.pData, envValue.pData);
 177 }
 178
 179 namespace {
 180
 181 void pythonInit() {
 182     if ( Py_IsInitialized()) // may be inited by getComponentContext() already
 183         return;
 184
 185     OUString pythonPath;
 186     OUString pythonHome;
 187     OUString path( "$BRAND_BASE_DIR/" LIBO_ETC_FOLDER "/" SAL_CONFIGFILE("pythonloader.uno" ));
 188     rtl::Bootstrap::expandMacros(path); //TODO: detect failure
 189     rtl::Bootstrap bootstrap(path);
 190
 191     // look for pythonhome
 192     bootstrap.getFrom( "PYUNO_LOADER_PYTHONHOME", pythonHome );
 193     bootstrap.getFrom( "PYUNO_LOADER_PYTHONPATH", pythonPath );
 194
 195     // pythonhome+pythonpath must be set before Py_Initialize(), otherwise there appear warning on the console
 196     // sadly, there is no api for setting the pythonpath, we have to use the environment variable
 197     if( !pythonHome.isEmpty() )
 198         setPythonHome( pythonHome );
 199
 200     if( !pythonPath.isEmpty() )
 201         prependPythonPath( pythonPath );
 202
 203 #ifdef _WIN32
 204     //extend PATH under windows to include the branddir/program so ssl libs will be found
 205     //for use by terminal mailmerge dependency _ssl.pyd
 206     OUString sEnvName("PATH");
 207     OUString sPath;
 208     osl_getEnvironment(sEnvName.pData, &sPath.pData);
 209     OUString sBrandLocation("$BRAND_BASE_DIR/program");
 210     rtl::Bootstrap::expandMacros(sBrandLocation);
 211     osl::FileBase::getSystemPathFromFileURL(sBrandLocation, sBrandLocation);
 212     sPath = OUStringBuffer(sPath).
 213         append(static_cast<sal_Unicode>(SAL_PATHSEPARATOR)).
 214         append(sBrandLocation).makeStringAndClear();
 215     osl_setEnvironment(sEnvName.pData, sPath.pData);
 216 #endif
 217
 218     PyImport_AppendInittab( "pyuno", PyInit_pyuno );
 219
 220 #if HAVE_FEATURE_READONLY_INSTALLSET
 221     Py_DontWriteBytecodeFlag = 1;
 222 #endif
 223
 224     // initialize python
 225     Py_Initialize();
 226 #if PY_VERSION_HEX < 0x03090000
 227     PyEval_InitThreads();
 228 #endif
 229
 230     PyThreadState *tstate = PyThreadState_Get();
 231     PyEval_ReleaseThread( tstate );
 232 #if PY_VERSION_HEX < 0x030B0000
 233     // This tstate is never used again, so delete it here.
 234     // This prevents an assertion in PyThreadState_Swap on the
 235     // PyThreadAttach below.
 236     PyThreadState_Delete(tstate);
 237 #endif
 238 }
 239
 240 }
 241
 242 extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface*
 243 pyuno_Loader_get_implementation(
 244     css::uno::XComponentContext* ctx , css::uno::Sequence<css::uno::Any> const&)
 245 {
 246     // tdf#114815 init python only once, via single-instace="true" in pythonloader.component
 247     pythonInit();
 248
 249     Reference< XInterface > ret;
 250
 251     PyThreadAttach attach( PyInterpreterState_Head() );
 252     {
 253         // note: this can't race against getComponentContext() because
 254         // either (in soffice.bin) CreateInstance() must be called before
 255         // getComponentContext() can be called, or (in python.bin) the other
 256         // way around
 257         if( ! Runtime::isInitialized() )
 258         {
 259             Runtime::initialize( ctx );
 260         }
 261         Runtime runtime;
 262
 263         PyRef pyCtx = runtime.any2PyObject(
 264             css::uno::makeAny( css::uno::Reference(ctx) ) );
 265
 266         PyRef clazz = getObjectFromLoaderModule( "Loader" );
 267         PyRef args ( PyTuple_New( 1 ), SAL_NO_ACQUIRE, NOT_NULL );
 268         PyTuple_SetItem( args.get(), 0 , pyCtx.getAcquired() );
 269         PyRef pyInstance( PyObject_CallObject( clazz.get() , args.get() ), SAL_NO_ACQUIRE );
 270         runtime.pyObject2Any( pyInstance ) >>= ret;
 271     }
 272     ret->acquire();
 273     return ret.get();
 274 }
 275
 276 }
 277
 278 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */