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