jvmfwk/source/fwkbase.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 <rtl/ustring.hxx>
  21 #include <rtl/ustrbuf.hxx>
  22 #include <sal/log.hxx>
  23 #include <libxml/xpathInternals.h>
  24 #include <osl/file.hxx>
  25 #include <osl/thread.hxx>
  26 #include <o3tl/string_view.hxx>
  27 #include "framework.hxx"
  28 #include <fwkutil.hxx>
  29 #include <elements.hxx>
  30 #include <fwkbase.hxx>
  31
  32 using namespace osl;
  33
  34
  35 #define UNO_JAVA_JFW_PARAMETER "UNO_JAVA_JFW_PARAMETER_"
  36 #define UNO_JAVA_JFW_JREHOME "UNO_JAVA_JFW_JREHOME"
  37 #define UNO_JAVA_JFW_ENV_JREHOME "UNO_JAVA_JFW_ENV_JREHOME"
  38 #define UNO_JAVA_JFW_CLASSPATH "UNO_JAVA_JFW_CLASSPATH"
  39 #define UNO_JAVA_JFW_ENV_CLASSPATH "UNO_JAVA_JFW_ENV_CLASSPATH"
  40 #define UNO_JAVA_JFW_CLASSPATH_URLS "UNO_JAVA_JFW_CLASSPATH_URLS"
  41 #define UNO_JAVA_JFW_VENDOR_SETTINGS "UNO_JAVA_JFW_VENDOR_SETTINGS"
  42
  43 namespace jfw
  44 {
  45 static bool  g_bJavaSet = false;
  46
  47 namespace {
  48
  49 #if defined _WIN32
  50     // The paths are used in libxml. On Windows, it takes UTF-8 paths.
  51 constexpr rtl_TextEncoding PathEncoding() { return RTL_TEXTENCODING_UTF8; }
  52 #else
  53 rtl_TextEncoding PathEncoding() { return osl_getThreadTextEncoding(); }
  54 #endif
  55
  56 OString getVendorSettingsPath(OUString const & sURL)
  57 {
  58     if (sURL.isEmpty())
  59         return OString();
  60     OUString sSystemPathSettings;
  61     if (osl_getSystemPathFromFileURL(sURL.pData,
  62         & sSystemPathSettings.pData) != osl_File_E_None)
  63         throw FrameworkException(
  64             JFW_E_ERROR,
  65             "[Java framework] Error in function getVendorSettingsPath (fwkbase.cxx) ");
  66     OString osSystemPathSettings = OUStringToOString(sSystemPathSettings, PathEncoding());
  67     return osSystemPathSettings;
  68 }
  69
  70 OUString getParam(OUString const & name)
  71 {
  72     OUString retVal;
  73     bool b = Bootstrap()->getFrom(name, retVal);
  74     SAL_INFO(
  75         "jfw",
  76         "Using bootstrap parameter " << name << " = \"" << retVal << "\""
  77             << (b ? "" : " (undefined)"));
  78     return retVal;
  79 }
  80
  81 OUString getParamFirstUrl(OUString const & name)
  82 {
  83     // Some parameters can consist of multiple URLs (separated by space
  84     // characters, although trim() harmlessly also removes other white-space),
  85     // of which only the first is used:
  86     return getParam(name).trim().getToken(0, ' ');
  87 }
  88
  89 }//blind namespace
  90
  91
  92 VendorSettings::VendorSettings()
  93 {
  94     OUString xmlDocVendorSettingsFileUrl(BootParams::getVendorSettings());
  95     //Prepare the xml document and context
  96     OString sSettingsPath = getVendorSettingsPath(xmlDocVendorSettingsFileUrl);
  97     if (sSettingsPath.isEmpty())
  98     {
  99         OString sMsg("[Java framework] A vendor settings file was not specified."
 100                "Check the bootstrap parameter " UNO_JAVA_JFW_VENDOR_SETTINGS ".");
 101         SAL_WARN( "jfw", sMsg );
 102         throw FrameworkException(JFW_E_CONFIGURATION, sMsg);
 103     }
 104     if (sSettingsPath.isEmpty())
 105         return;
 106
 107     m_xmlDocVendorSettings = xmlParseFile(sSettingsPath.getStr());
 108     if (m_xmlDocVendorSettings == nullptr)
 109         throw FrameworkException(
 110             JFW_E_ERROR,
 111             OString::Concat("[Java framework] Error while parsing file: ")
 112             + sSettingsPath + ".");
 113
 114     m_xmlPathContextVendorSettings = xmlXPathNewContext(m_xmlDocVendorSettings);
 115     int res = xmlXPathRegisterNs(
 116         m_xmlPathContextVendorSettings, reinterpret_cast<xmlChar const *>("jf"),
 117         reinterpret_cast<xmlChar const *>(NS_JAVA_FRAMEWORK));
 118     if (res == -1)
 119         throw FrameworkException(JFW_E_ERROR,
 120                 "[Java framework] Error in constructor VendorSettings::VendorSettings() (fwkbase.cxx)");
 121 }
 122
 123 VersionInfo VendorSettings::getVersionInformation(std::u16string_view sVendor) const
 124 {
 125     OSL_ASSERT(!sVendor.empty());
 126     OString osVendor = OUStringToOString(sVendor, RTL_TEXTENCODING_UTF8);
 127     CXPathObjectPtr pathObject = xmlXPathEvalExpression(
 128         reinterpret_cast<xmlChar const *>(
 129             OString(
 130                 "/jf:javaSelection/jf:vendorInfos/jf:vendor[@name=\"" + osVendor
 131                 + "\"]/jf:minVersion").getStr()),
 132         m_xmlPathContextVendorSettings);
 133     if (xmlXPathNodeSetIsEmpty(pathObject->nodesetval))
 134     {
 135         return {
 136             {},
 137 #if defined MACOSX && defined __aarch64__
 138             "17",
 139 #else
 140             "1.8.0",
 141 #endif
 142             ""};
 143     }
 144
 145     VersionInfo aVersionInfo;
 146     //Get minVersion
 147     OString sExpression =
 148         "/jf:javaSelection/jf:vendorInfos/jf:vendor[@name=\"" +
 149         osVendor + "\"]/jf:minVersion";
 150
 151     CXPathObjectPtr xPathObjectMin =
 152         xmlXPathEvalExpression(reinterpret_cast<xmlChar const *>(sExpression.getStr()),
 153                                m_xmlPathContextVendorSettings);
 154     if (xmlXPathNodeSetIsEmpty(xPathObjectMin->nodesetval))
 155     {
 156         aVersionInfo.sMinVersion.clear();
 157     }
 158     else
 159     {
 160         CXmlCharPtr sVersion = xmlNodeListGetString(
 161             m_xmlDocVendorSettings,
 162             xPathObjectMin->nodesetval->nodeTab[0]->xmlChildrenNode, 1);
 163         OString osVersion(sVersion);
 164         aVersionInfo.sMinVersion = OStringToOUString(
 165             osVersion, RTL_TEXTENCODING_UTF8);
 166     }
 167
 168     //Get maxVersion
 169     sExpression = "/jf:javaSelection/jf:vendorInfos/jf:vendor[@name=\"" +
 170         osVendor + "\"]/jf:maxVersion";
 171     CXPathObjectPtr xPathObjectMax = xmlXPathEvalExpression(
 172         reinterpret_cast<xmlChar const *>(sExpression.getStr()),
 173         m_xmlPathContextVendorSettings);
 174     if (xmlXPathNodeSetIsEmpty(xPathObjectMax->nodesetval))
 175     {
 176         aVersionInfo.sMaxVersion.clear();
 177     }
 178     else
 179     {
 180         CXmlCharPtr sVersion = xmlNodeListGetString(
 181             m_xmlDocVendorSettings,
 182             xPathObjectMax->nodesetval->nodeTab[0]->xmlChildrenNode, 1);
 183         OString osVersion(sVersion);
 184         aVersionInfo.sMaxVersion = OStringToOUString(
 185             osVersion, RTL_TEXTENCODING_UTF8);
 186     }
 187
 188     //Get excludeVersions
 189     sExpression = "/jf:javaSelection/jf:vendorInfos/jf:vendor[@name=\"" +
 190         osVendor + "\"]/jf:excludeVersions/jf:version";
 191     CXPathObjectPtr xPathObjectVersions =
 192         xmlXPathEvalExpression(reinterpret_cast<xmlChar const *>(sExpression.getStr()),
 193                                m_xmlPathContextVendorSettings);
 194     if (!xmlXPathNodeSetIsEmpty(xPathObjectVersions->nodesetval))
 195     {
 196         xmlNode* cur = xPathObjectVersions->nodesetval->nodeTab[0];
 197         while (cur != nullptr)
 198         {
 199             if (cur->type == XML_ELEMENT_NODE )
 200             {
 201                 if (xmlStrcmp(cur->name, reinterpret_cast<xmlChar const *>("version")) == 0)
 202                 {
 203                     CXmlCharPtr sVersion = xmlNodeListGetString(
 204                         m_xmlDocVendorSettings, cur->xmlChildrenNode, 1);
 205                     OString osVersion(sVersion);
 206                     OUString usVersion = OStringToOUString(
 207                         osVersion, RTL_TEXTENCODING_UTF8);
 208                     aVersionInfo.vecExcludeVersions.push_back(usVersion);
 209                 }
 210             }
 211             cur = cur->next;
 212         }
 213     }
 214     return aVersionInfo;
 215 }
 216
 217 ::std::vector<OString> BootParams::getVMParameters()
 218 {
 219     ::std::vector<OString> vecParams;
 220
 221     for (sal_Int32 i = 1; ; i++)
 222     {
 223         OUString sName = UNO_JAVA_JFW_PARAMETER + OUString::number(i);
 224         OUString sValue;
 225         if (Bootstrap()->getFrom(sName, sValue))
 226         {
 227             OString sParam =
 228                 OUStringToOString(sValue, osl_getThreadTextEncoding());
 229             vecParams.push_back(sParam);
 230             SAL_INFO(
 231                 "jfw.level2",
 232                 "Using bootstrap parameter " << sName << " = " << sParam);
 233         }
 234         else
 235             break;
 236     }
 237     return vecParams;
 238 }
 239
 240 OUString BootParams::getUserData()
 241 {
 242     return getParamFirstUrl("UNO_JAVA_JFW_USER_DATA");
 243 }
 244
 245 OUString BootParams::getSharedData()
 246 {
 247     return getParamFirstUrl("UNO_JAVA_JFW_SHARED_DATA");
 248 }
 249
 250 OString BootParams::getClasspath()
 251 {
 252     OString sClassPath;
 253     OUString sCP;
 254     if (Bootstrap()->getFrom( UNO_JAVA_JFW_CLASSPATH, sCP ))
 255     {
 256         sClassPath = OUStringToOString(sCP, PathEncoding());
 257         SAL_INFO(
 258             "jfw.level2",
 259             "Using bootstrap parameter " UNO_JAVA_JFW_CLASSPATH " = "
 260                 << sClassPath);
 261     }
 262
 263     OUString sEnvCP;
 264     if (Bootstrap()->getFrom( UNO_JAVA_JFW_ENV_CLASSPATH, sEnvCP ))
 265     {
 266         char * pCp = getenv("CLASSPATH");
 267         if (pCp)
 268         {
 269             sClassPath += OStringChar(SAL_PATHSEPARATOR) + pCp;
 270         }
 271         SAL_INFO(
 272             "jfw.level2",
 273             "Using bootstrap parameter " UNO_JAVA_JFW_ENV_CLASSPATH
 274                 " and class path is: " << (pCp ? pCp : ""));
 275     }
 276
 277     return sClassPath;
 278 }
 279
 280 OUString BootParams::getVendorSettings()
 281 {
 282     OUString sVendor;
 283     if (Bootstrap()->getFrom(UNO_JAVA_JFW_VENDOR_SETTINGS, sVendor))
 284     {
 285         //check the value of the bootstrap variable
 286         jfw::FileStatus s = checkFileURL(sVendor);
 287         if (s != FILE_OK)
 288         {
 289             //This bootstrap parameter can contain a relative URL
 290             OUString sAbsoluteUrl;
 291             OUString sBaseDir = getLibraryLocation();
 292             if (File::getAbsoluteFileURL(sBaseDir, sVendor, sAbsoluteUrl)
 293                 != File::E_None)
 294                 throw FrameworkException(
 295                     JFW_E_CONFIGURATION,
 296                     "[Java framework] Invalid value for bootstrap variable: "
 297                              UNO_JAVA_JFW_VENDOR_SETTINGS);
 298             sVendor = sAbsoluteUrl;
 299             s = checkFileURL(sVendor);
 300             if (s == jfw::FILE_INVALID || s == jfw::FILE_DOES_NOT_EXIST)
 301             {
 302                 throw FrameworkException(
 303                     JFW_E_CONFIGURATION,
 304                     "[Java framework] Invalid value for bootstrap variable: "
 305                                  UNO_JAVA_JFW_VENDOR_SETTINGS);
 306             }
 307         }
 308         SAL_INFO(
 309         "jfw.level2",
 310         "Using bootstrap parameter " UNO_JAVA_JFW_VENDOR_SETTINGS " = "
 311             << sVendor);
 312     }
 313     return sVendor;
 314 }
 315
 316 OUString BootParams::getJREHome()
 317 {
 318     OUString sJRE;
 319     OUString sEnvJRE;
 320     bool bJRE = Bootstrap()->getFrom(UNO_JAVA_JFW_JREHOME, sJRE);
 321     bool bEnvJRE = Bootstrap()->getFrom(UNO_JAVA_JFW_ENV_JREHOME, sEnvJRE);
 322
 323     if (bJRE && bEnvJRE)
 324     {
 325         throw FrameworkException(
 326             JFW_E_CONFIGURATION,
 327             "[Java framework] Both bootstrap parameter "
 328             UNO_JAVA_JFW_JREHOME" and "
 329             UNO_JAVA_JFW_ENV_JREHOME" are set. However only one of them can be set."
 330             "Check bootstrap parameters: environment variables, command line "
 331             "arguments, rc/ini files for executable and java framework library.");
 332     }
 333     else if (bEnvJRE)
 334     {
 335         const char * pJRE = getenv("JAVA_HOME");
 336         if (pJRE == nullptr)
 337         {
 338             throw FrameworkException(
 339                 JFW_E_CONFIGURATION,
 340                 "[Java framework] Both bootstrap parameter "
 341                 UNO_JAVA_JFW_ENV_JREHOME" is set, but the environment variable "
 342                 "JAVA_HOME is not set.");
 343         }
 344         OString osJRE(pJRE);
 345         OUString usJRE = OStringToOUString(osJRE, osl_getThreadTextEncoding());
 346         if (File::getFileURLFromSystemPath(usJRE, sJRE) != File::E_None)
 347             throw FrameworkException(
 348                 JFW_E_ERROR,
 349                 "[Java framework] Error in function BootParams::getJREHome() "
 350                 "(fwkbase.cxx).");
 351         SAL_INFO(
 352             "jfw.level2",
 353             "Using bootstrap parameter " UNO_JAVA_JFW_ENV_JREHOME
 354                 " with JAVA_HOME = " << pJRE);
 355     }
 356     else if (getMode() == JFW_MODE_DIRECT && !bJRE)
 357     {
 358         throw FrameworkException(
 359             JFW_E_CONFIGURATION,
 360             "[Java framework] The bootstrap parameter "
 361             UNO_JAVA_JFW_ENV_JREHOME" or " UNO_JAVA_JFW_JREHOME
 362             " must be set in direct mode.");
 363     }
 364
 365     SAL_INFO_IF(
 366         bJRE, "jfw.level2",
 367         "Using bootstrap parameter " UNO_JAVA_JFW_JREHOME " = " << sJRE);
 368     return sJRE;
 369 }
 370
 371 OUString BootParams::getClasspathUrls()
 372 {
 373     OUString sParams;
 374     Bootstrap()->getFrom( UNO_JAVA_JFW_CLASSPATH_URLS, sParams);
 375     SAL_INFO(
 376         "jfw.level2",
 377         "Using bootstrap parameter " UNO_JAVA_JFW_CLASSPATH_URLS " = "
 378             << sParams);
 379     return sParams;
 380 }
 381
 382 JFW_MODE getMode()
 383 {
 384     static bool g_bMode = false;
 385     static JFW_MODE g_mode = JFW_MODE_APPLICATION;
 386
 387     if (!g_bMode)
 388     {
 389         //check if either of the "direct mode" bootstrap variables is set
 390         bool bDirectMode = true;
 391         OUString sValue;
 392         const rtl::Bootstrap * aBoot = Bootstrap();
 393         if (!aBoot->getFrom(UNO_JAVA_JFW_JREHOME, sValue))
 394         {
 395             if (!aBoot->getFrom(UNO_JAVA_JFW_ENV_JREHOME, sValue))
 396             {
 397                 if (!aBoot->getFrom(UNO_JAVA_JFW_CLASSPATH, sValue))
 398                 {
 399                     if (!aBoot->getFrom(UNO_JAVA_JFW_ENV_CLASSPATH, sValue))
 400                     {
 401                         OUString sParams = UNO_JAVA_JFW_PARAMETER +
 402                             OUString::number(1);
 403                         if (!aBoot->getFrom(sParams, sValue))
 404                         {
 405                             bDirectMode = false;
 406                         }
 407                     }
 408                 }
 409             }
 410         }
 411
 412         if (bDirectMode)
 413             g_mode = JFW_MODE_DIRECT;
 414         else
 415             g_mode = JFW_MODE_APPLICATION;
 416         g_bMode = true;
 417     }
 418
 419     return g_mode;
 420 }
 421
 422 OUString getApplicationClassPath()
 423 {
 424     OSL_ASSERT(getMode() == JFW_MODE_APPLICATION);
 425     OUString sParams = BootParams::getClasspathUrls();
 426     if (sParams.isEmpty())
 427         return OUString();
 428
 429     OUStringBuffer buf;
 430     sal_Int32 index = 0;
 431     do
 432     {
 433         OUString token( o3tl::trim(o3tl::getToken(sParams, 0, ' ', index )) );
 434         if (!token.isEmpty())
 435         {
 436             OUString systemPathElement;
 437             oslFileError rc = osl_getSystemPathFromFileURL(
 438                 token.pData, &systemPathElement.pData );
 439             OSL_ASSERT( rc == osl_File_E_None );
 440             if (rc == osl_File_E_None && !systemPathElement.isEmpty())
 441             {
 442                 if (buf.getLength() > 0)
 443                     buf.append( SAL_PATHSEPARATOR );
 444                 buf.append( systemPathElement );
 445             }
 446         }
 447     }
 448     while (index >= 0);
 449     return buf.makeStringAndClear();
 450 }
 451
 452 OString makeClassPathOption(std::u16string_view sUserClassPath)
 453 {
 454     //Compose the class path
 455     OString sPaths;
 456     OUStringBuffer sBufCP(4096);
 457
 458     // append all user selected jars to the class path
 459     if (!sUserClassPath.empty())
 460         sBufCP.append(sUserClassPath);
 461
 462     //append all jar libraries and components to the class path
 463     OUString sAppCP = getApplicationClassPath();
 464     if (!sAppCP.isEmpty())
 465     {
 466         if (!sUserClassPath.empty())
 467         {
 468             sBufCP.append(SAL_PATHSEPARATOR);
 469         }
 470         sBufCP.append(sAppCP);
 471     }
 472
 473     sPaths = OUStringToOString(sBufCP.makeStringAndClear(), PathEncoding());
 474     if (sPaths.isEmpty()) {
 475         return "";
 476     }
 477
 478     OString sOptionClassPath = "-Djava.class.path=" + sPaths;
 479     return sOptionClassPath;
 480 }
 481
 482 OString getUserSettingsPath()
 483 {
 484     return getSettingsPath(BootParams::getUserData());
 485 }
 486
 487 OString getSharedSettingsPath()
 488 {
 489     return getSettingsPath(BootParams::getSharedData());
 490 }
 491
 492 OString getSettingsPath( const OUString & sURL)
 493 {
 494     if (sURL.isEmpty())
 495         return OString();
 496     OUString sPath;
 497     if (osl_getSystemPathFromFileURL(sURL.pData,
 498         & sPath.pData) != osl_File_E_None)
 499         throw FrameworkException(
 500             JFW_E_ERROR,
 501             "[Java framework] Error in function ::getSettingsPath (fwkbase.cxx).");
 502     return OUStringToOString(sPath, PathEncoding());
 503 }
 504
 505 OString getVendorSettingsPath()
 506 {
 507     return getVendorSettingsPath(BootParams::getVendorSettings());
 508 }
 509
 510 void setJavaSelected()
 511 {
 512     g_bJavaSet = true;
 513 }
 514
 515 bool wasJavaSelectedInSameProcess()
 516 {
 517     //g_setJavaProcId not set means no Java selected
 518     return g_bJavaSet;
 519 }
 520
 521
 522 }
 523
 524 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */