Improve new MG license mechanism to make it work on Windows

Use additional functions of MGKEYGEN for version detection to work on Windows (thanks to Nabil)

Use spaces instead of tabs

Ensure backward compatibility using either functions from .so/dll or environment variables MESHGEMS_VERSION_MAJOR/MINOR/PATCH defined in SAT

remove blank space

Fix coding style

src/SMESHUtils/SMESH_MGLicenseKeyGen.cxx

@@ -447,12 +447,10 @@ namespace SMESHUtils_MGLicenseKeyGen // API implementation
       return false;
 
     bool ok = false;
-    // get the key from KeyGen
+    typedef bool (*SignFun)(const std::string& );
-    std::string key = SMESHUtils_MGLicenseKeyGen::GetKey(error);
-    typedef int (*SignFun)(const char* );
 
     // specific function to unlock each product
-    std::string function = "meshgems_" + product + "_unlock_product";
+    std::string function = "UnlockProduct";
 
     SignFun signFun = (SignFun) GetProc( theLibraryHandle, function.c_str() );
     if ( !signFun )
@@ -464,14 +462,13 @@ namespace SMESHUtils_MGLicenseKeyGen // API implementation
     {
       SMESH_TRY;
 
-      int status = signFun( key.c_str() );
+      ok = signFun( product.c_str() );
-      // MeshGems status: 0: OK, 1: warning, -1: error
-      ok = status >= 0;
 
       SMESH_CATCH( SMESH::returnError );
 
       if ( !error.empty() )
       {
+        std::cerr << "error: " << error << std::endl;
         ok = false;
       }
       else if ( !ok )
@@ -639,78 +636,98 @@ namespace SMESHUtils_MGLicenseKeyGen // API implementation
     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 and meshgems built-in functions
+   * \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)
   {
-    // get minor version
+    // load mgkeygen library
     int v_min = -1;
     LibraryFile libraryFile;
     if ( !loadLibrary( error, libraryFile ))
       return v_min;
+    MESSAGE("Extracting MeshGems version");
 
-    typedef int (*GetKeyFun)();
+    // get minor version
-    GetKeyFun keyFun = (GetKeyFun) GetProc( theLibraryHandle, "meshgems_core_get_version_minor" );
+    v_min = GetMGVersionFromFunction("meshgems_core_get_version_minor");
-    if ( !keyFun )
-    {
-      if ( ! getLastError( error ))
-	error = SMESH_Comment( "Can't find symbol 'meshgems_core_get_version_minor' in '") << getenv( theEnvVar ) << "'";
-    }
-    else
-    {
-	v_min = keyFun( );
-    }
     if (v_min == -1)
-      error = "meshgems_core_get_version_minor() failed (located in '" + libraryFile._name + "')";
+      v_min = GetMGVersionFromFunction("GetVersionMinor");
-
+    if (v_min == -1)
-    MESSAGE("meshgems_core_get_version_minor: " << v_min);
+      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 = -1;
+    int v_maj = GetMGVersionFromFunction("meshgems_core_get_version_major");
-
-    typedef int (*GetKeyFun)();
-    keyFun = (GetKeyFun) GetProc( theLibraryHandle, "meshgems_core_get_version_major" );
-    if ( !keyFun )
-    {
-      if ( ! getLastError( error ))
-	error = SMESH_Comment( "Can't find symbol 'meshgems_core_get_version_major' in '") << getenv( theEnvVar ) << "'";
-    }
-    else
-    {
-	v_maj = keyFun( );
-    }
     if (v_maj == -1)
-      error = "meshgems_core_get_version_major() failed (located in '" + libraryFile._name + "')";
+      v_maj = GetMGVersionFromFunction("GetVersionMajor");
-
+    if (v_maj == -1)
-    MESSAGE("meshgems_core_get_version_major: " << v_maj);
+      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 = -1;
+    int v_patch = GetMGVersionFromFunction("meshgems_core_get_version_patch");
-
-    typedef int (*GetKeyFun)();
-    keyFun = (GetKeyFun) GetProc( theLibraryHandle, "meshgems_core_get_version_patch" );
-    if ( !keyFun )
-    {
-      if ( ! getLastError( error ))
-	error = SMESH_Comment( "Can't find symbol 'meshgems_core_get_version_patch' in '") << getenv( theEnvVar ) << "'";
-    }
-    else
-    {
-	v_patch = keyFun( );
-    }
     if (v_patch == -1)
-      error = "meshgems_core_get_version_patch() failed (located in '" + libraryFile._name + "')";
+      v_patch = GetMGVersionFromFunction("GetVersionPatch");
-
+    if (v_patch == -1)
-    MESSAGE("meshgems_core_get_version_patch: " << v_patch );
+      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;

src/SMESHUtils/SMESH_MGLicenseKeyGen.hxx

@@ -58,7 +58,8 @@ namespace SMESHUtils_MGLicenseKeyGen
   SMESHUtils_EXPORT bool        CheckKeyGenLibrary( std::string& error );
 
   SMESHUtils_EXPORT std::string GetLibraryName();
-
+  SMESHUtils_EXPORT int         GetMGVersionFromFunction(const char* function_name);
+  SMESHUtils_EXPORT int         GetMGVersionFromEnv(const char* env_variable);
   SMESHUtils_EXPORT int         GetMGVersionHex(std::string& error);
   SMESHUtils_EXPORT bool        NeedsMGSpatialEnvLicense(std::string& error);
   SMESHUtils_EXPORT bool        SetMGSpatialEnvLicense(std::string& error);