X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FSMESHUtils%2FSMESH_MGLicenseKeyGen.cxx;h=d97680956bde331b37bfda6382af6f5209ebdf46;hb=HEAD;hp=1b5655e0c934686e5ab8345af3295ed7d473af85;hpb=dacd89c7dfc779f4a8249ff08ca15f7b963408a5;p=modules%2Fsmesh.git diff --git a/src/SMESHUtils/SMESH_MGLicenseKeyGen.cxx b/src/SMESHUtils/SMESH_MGLicenseKeyGen.cxx index 1b5655e0c..d97680956 100644 --- a/src/SMESHUtils/SMESH_MGLicenseKeyGen.cxx +++ b/src/SMESHUtils/SMESH_MGLicenseKeyGen.cxx @@ -1,4 +1,4 @@ -// Copyright (C) 2007-2022 CEA/DEN, EDF R&D, OPEN CASCADE +// Copyright (C) 2007-2024 CEA, EDF, OPEN CASCADE // // This library is free software; you can redistribute it and/or // modify it under the terms of the GNU Lesser General Public @@ -61,6 +61,7 @@ namespace boofs = boost::filesystem; #define SMESH_CAUGHT error = constexpr char MESHGEMS_OLD_STYLE[] = "MESHGEMS_OLD_STYLE"; +constexpr char SPATIAL_LICENSE[] = "SPATIAL_LICENSE"; namespace @@ -309,7 +310,7 @@ namespace buffer[length] = '\0'; infile.read(const_cast( buffer.get() ),length); - MESSAGE( buffer.get() ) + MESSAGE( buffer.get() ); } { SMESH_File redirectFile( redirect, /*open=*/false ); @@ -429,12 +430,72 @@ namespace SMESHUtils_MGLicenseKeyGen // API implementation } return ok; } - + + //================================================================================ + /*! + * \brief Unlock a specific MeshGems product (for products called as a library) + * \param [in] product - product of MeshGems to unlock + * \param [out] error - return error description + * \return bool - is a success + */ + //================================================================================ + bool UnlockProduct( const std::string& product, std::string& error ) + { + MESSAGE("SMESH UnlockProduct: " << product); + LibraryFile libraryFile; + if ( !loadLibrary( error, libraryFile )) + return false; + + bool ok = false; + typedef bool (*SignFun)(const std::string& ); + + // specific function to unlock each product + std::string function = "UnlockProduct"; + + SignFun signFun = (SignFun) GetProc( theLibraryHandle, function.c_str() ); + if ( !signFun ) + { + if ( ! getLastError( error )) + error = SMESH_Comment( "Can't find symbol '") << function << "' in '" << getenv( theEnvVar ) << "'"; + } + else + { + SMESH_TRY; + + ok = signFun( product.c_str() ); + + SMESH_CATCH( SMESH::returnError ); + + if ( !error.empty() ) + { + std::cerr << "error: " << error << std::endl; + ok = false; + } + else if ( !ok ) + error = "UnlockProduct() failed (located in '" + libraryFile._name + "')"; + } + return ok; + } + + //================================================================================ + /*! + * \brief Sign a CAD (or don't do it if env MESHGEMS_OLD_STYLE is set) + * \param [in] meshgems_cad - pointer to a MG CAD object (meshgems_cad_t) + * \param [out] error - return error description + * \return bool - is a success + */ + //================================================================================ bool SignCAD( void* meshgems_cad, std::string& error ) { const char *meshGemsOldStyleEnvVar( getenv( MESHGEMS_OLD_STYLE ) ); if ( !meshGemsOldStyleEnvVar || strlen(meshGemsOldStyleEnvVar) == 0 ) - return SignCAD_After(meshgems_cad, error); + { + if (NeedsMGSpatialEnvLicense(error)) + // SignCAD is only called by cadsurf. Other components call SignMesh + return UnlockProduct("cadsurf", error); + else + return SignCAD_After(meshgems_cad, error); + } else return true; } @@ -477,13 +538,30 @@ namespace SMESHUtils_MGLicenseKeyGen // API implementation } return ok; } - - bool SignMesh( void* meshgems_mesh, std::string& error ) + + //================================================================================ + /*! + * \brief Sign a mesh (or don't do it if env MESHGEMS_OLD_STYLE is set) + * \param [in] meshgems_mesh - pointer to a MG mesh (meshgems_mesh_t) + * \param [in] product - product of MeshGems to unlock + * \param [out] error - return error description + * \return bool - is a success + */ + //================================================================================ + bool SignMesh( void* meshgems_mesh, const std::string& product, std::string& error ) { const char *meshGemsOldStyleEnvVar( getenv( MESHGEMS_OLD_STYLE ) ); if ( !meshGemsOldStyleEnvVar || strlen(meshGemsOldStyleEnvVar) == 0 ) - return SignMesh_After(meshgems_mesh, error); + { + if (NeedsMGSpatialEnvLicense(error)) + // unlock product (MG 2.15) + return UnlockProduct(product, error); + else + // sign the mesh (MG 2.13 and 2.14) + return SignMesh_After(meshgems_mesh, error); + } else + // use DLIM8 server (nothing to do here) return true; } @@ -498,11 +576,11 @@ namespace SMESHUtils_MGLicenseKeyGen // API implementation //================================================================================ std::string GetKey_After(const std::string& gmfFile, - int nbVertex, - int nbEdge, - int nbFace, - int nbVol, - std::string& error) + int nbVertex, + int nbEdge, + int nbFace, + int nbVol, + std::string& error) { std::string key; LibraryFile libraryFile; @@ -526,18 +604,252 @@ namespace SMESHUtils_MGLicenseKeyGen // API implementation return key; } + //================================================================================ + /*! + * \brief Return a license key to pass as argument to a MG mesher executable (>2.15) + * \param [out] error - return error description + * \return std::string - the key + */ + //================================================================================ + + std::string GetKey_After(std::string& error) + { + std::string key; + LibraryFile libraryFile; + if ( !loadLibrary( error, libraryFile )) + return key; + + typedef std::string (*GetKeyFun)(); + GetKeyFun keyFun = (GetKeyFun) GetProc( theLibraryHandle, "GetKey" ); + if ( !keyFun ) + { + if ( ! getLastError( error )) + error = SMESH_Comment( "Can't find symbol 'GetKey' in '") << getenv( theEnvVar ) << "'"; + } + else + { + key = keyFun( ); + } + if ( key.empty() ) + error = "GetKey() failed (located in '" + libraryFile._name + "')"; + + return key; + } + + //================================================================================ + /*! + * \brief Get MeshGems version major/minor/patch from the environment variables + * \param [out] error - return error description + * \return int - the version + */ + //================================================================================ + int GetMGVersionFromEnv(const char* env_variable) + { + MESSAGE("Entering GetMGVersionFromEnv and calling " << env_variable); + int version = -1; + if (getenv(env_variable) == nullptr ) + { + MESSAGE("Could not find " << env_variable << " from environment"); + } + else + { + version = std::stoi(std::string(getenv(env_variable))); + } + return version; + } + //================================================================================ + /*! + * \brief Get MeshGems version major/minor/patch from the keygen library and meshgems built-in functions + * \param [out] error - return error description + * \return int - the function implemented in the library + */ + //================================================================================ + int GetMGVersionFromFunction(const char* function_name) + { + MESSAGE("Entering GetMGVersionFromFunction and calling " << function_name); + int version = -1; + typedef int (*GetKeyFun)(); + GetKeyFun keyFun = (GetKeyFun) GetProc( theLibraryHandle, function_name); + if ( !keyFun ) + { + MESSAGE("Could not find " << function_name << " from library"); + } + else + { + version = keyFun(); + } + return version; + } + + //================================================================================ + /*! + * \brief Get MeshGems version from the keygen library or meshgems built-in functions + * \param [out] error - return error description + * \return int - the version + */ + //================================================================================ + int GetMGVersionHex(std::string& error) + { + // load mgkeygen library + int v_min = -1; + LibraryFile libraryFile; + if ( !loadLibrary( error, libraryFile )) + return v_min; + MESSAGE("Extracting MeshGems version"); + + // get minor version + v_min = GetMGVersionFromFunction("meshgems_core_get_version_minor"); + if (v_min == -1) + v_min = GetMGVersionFromFunction("GetVersionMinor"); + if (v_min == -1) + v_min = GetMGVersionFromEnv("MESHGEMS_VERSION_MINOR"); + if (v_min == -1) + error = "could not retrieve minor version (located in '" + libraryFile._name + "')"; + MESSAGE("MeshGems minor version = " << v_min); + + // get major version + int v_maj = GetMGVersionFromFunction("meshgems_core_get_version_major"); + if (v_maj == -1) + v_maj = GetMGVersionFromFunction("GetVersionMajor"); + if (v_maj == -1) + v_maj = GetMGVersionFromEnv("MESHGEMS_VERSION_MAJOR"); + if (v_maj == -1) + error = "could not retrieve major version (located in '" + libraryFile._name + "')"; + MESSAGE("MeshGems major version = " << v_maj); + + // get patch version + int v_patch = GetMGVersionFromFunction("meshgems_core_get_version_patch"); + if (v_patch == -1) + v_patch = GetMGVersionFromFunction("GetVersionPatch"); + if (v_patch == -1) + v_patch = GetMGVersionFromEnv("MESHGEMS_VERSION_PATCH"); + if (v_patch == -1) + error = "could not retrieve patch version (located in '" + libraryFile._name + "')"; + MESSAGE("MeshGems patch version = " << v_patch); + + int v_hex = (v_maj << 16 | v_min << 8 | v_patch); + MESSAGE("v_hex: " << v_hex); + + return v_hex; + } + + //================================================================================ + /*! + * \brief Guess if the Spatial license is needed (if MeshGems is > 2.15.0) + * \param [out] error - return error description + * \return bool - true if MeshGems is > 2.15.0 + */ + //================================================================================ + bool NeedsMGSpatialEnvLicense(std::string& error) + { + // if MeshGems version is > 2.15.0, need to set SPATIAL_LICENSE + int v_hex = GetMGVersionHex(error); + bool ok = (v_hex > MESHGEMS_215); + if (ok) + MESSAGE("MeshGems version is > 2.15.0, need to set SPATIAL_LICENSE"); + return ok; + } + + //================================================================================ + /*! + * \brief Set the SPATIAL_LICENSE environment variable + * \param [out] error - return error description + * \return bool - true in case of success + */ + //================================================================================ + bool SetMGSpatialEnvLicense(std::string& error) + { + int ok; + std::string key = GetKey(error); +#ifndef WIN32 + ok = setenv(SPATIAL_LICENSE, key.c_str(), 0); // 0 means do not overwrite +#else + ok = Kernel_Utils::setenv(SPATIAL_LICENSE, key.c_str(), 0 ); +#endif + MESSAGE("Set SPATIAL_LICENSE"); + return (ok==0); + } + + //================================================================================ + /*! + * \brief Get the license key from libMeshGemsKeyGenerator.so or $SPATIAL_LICENSE + * Called by plugins calling MG products as executables. + * If MESHGEMS_OLD_STYLE is set, return "0", to use old DLIM8 server license + * instead of the key. + * \param [in] gmfFile - path to an input mesh file + * \param [in] nb* - nb of entities in the input mesh + * \param [out] error - return error description + * \return std::string - the key + */ + //================================================================================ std::string GetKey(const std::string& gmfFile, - int nbVertex, - int nbEdge, - int nbFace, - int nbVol, - std::string& error) + int nbVertex, + int nbEdge, + int nbFace, + int nbVol, + std::string& error) { + // default key if MESHGEMS_OLD_STYLE or SPATIAL_LICENSE is set + std::string key("0"); const char *meshGemsOldStyleEnvVar( getenv( MESHGEMS_OLD_STYLE ) ); if ( !meshGemsOldStyleEnvVar || strlen(meshGemsOldStyleEnvVar) == 0 ) - return GetKey_After(gmfFile,nbVertex,nbEdge,nbFace,nbVol,error); - else - return std::string("0"); + { + const char *spatialLicenseEnvVar( getenv( SPATIAL_LICENSE ) ); + if ( !spatialLicenseEnvVar || strlen(spatialLicenseEnvVar) == 0 ) + { + if (NeedsMGSpatialEnvLicense(error)) + { + // if MG version > 2.15, set environment license, don't return it as a key + // otherwise it will be printed in the command line + MESSAGE("SPATIAL_LICENSE not in env => we add it from MGKeygen .so"); + SetMGSpatialEnvLicense(error); + } + else + { + // generate the key from the mesh info (MG 2.13 and 2.14) + MESSAGE("MG < 2.15 => get the key from MGKeygen .so and this mesh info"); + key = GetKey_After(gmfFile,nbVertex,nbEdge,nbFace,nbVol,error); + } + } + else + MESSAGE("SPATIAL_LICENSE already in env => we use it"); + } + if (! error.empty()) + std::cerr << error; + return key; + } + + //================================================================================ + /*! + * \brief Get the license key from libMeshGemsKeyGenerator.so or $SPATIAL_LICENSE + * Called for MG 2.15 by CADSurf and MG plugins calling MG products as library, + * i.e. compiled as library with -DSALOME_USE_MG_LIBS=ON + * \param [out] error - return error description + * \return std::string - the key + */ + //================================================================================ + std::string GetKey(std::string& error) + { + // default key if not found in .so or in SPATIAL_LICENSE + std::string key("0"); + const char *meshGemsOldStyleEnvVar( getenv( MESHGEMS_OLD_STYLE ) ); + if ( !meshGemsOldStyleEnvVar || strlen(meshGemsOldStyleEnvVar) == 0 ){ + const char *spatialLicenseEnvVar( getenv( SPATIAL_LICENSE ) ); + if ( !spatialLicenseEnvVar || strlen(spatialLicenseEnvVar) == 0 ) + { + MESSAGE("SPATIAL_LICENSE not in env => we add it from MGKeygen .so"); + // use new style, i.e. key in a library + key = GetKey_After(error); + } + else + { + MESSAGE("SPATIAL_LICENSE already in env => we use it"); + key = std::string(spatialLicenseEnvVar); + } + } + if (! error.empty()) + std::cerr << error; + return key; } //================================================================================