sapphire/src/servers/sapphire_zone/Script/ScriptLoader.cpp

#include <boost/format.hpp>
#include <boost/algorithm/string/predicate.hpp>
#include <boost/filesystem.hpp>


#include <common/Logging/Logger.h>
#include <common/Config/XMLConfig.h>

#include "ScriptLoader.h"
#include "Framework.h"

extern Core::Framework g_framework;

namespace fs = boost::filesystem;

Core::Scripting::ScriptLoader::ScriptLoader()
{}

const std::string Core::Scripting::ScriptLoader::getModuleExtension()
{
#ifdef _WIN32
   return ".dll";
#elif __APPLE__
   return ".dylib";
#else
   return ".so";
#endif
}

bool Core::Scripting::ScriptLoader::unloadModule( ModuleHandle handle )
{
#ifdef _WIN32
   bool success = FreeLibrary( handle ) != 0;
#else
   bool success = dlclose( handle ) == 0;
#endif

   if ( !success )
   {
      g_framework.getLogger().error( "Failed to unload module @ 0x" + boost::str( boost::format( "%|08X|" ) % handle ) );

      return false;
   }

   g_framework.getLogger().debug( "Unloaded module @ 0x" + boost::str( boost::format( "%|08X|" ) % handle ) );

   return true;
}

Core::Scripting::ScriptInfo* Core::Scripting::ScriptLoader::loadModule( const std::string& path )
{
   fs::path f( path );

   if ( isModuleLoaded( f.stem().string() ) )
   {
      g_framework.getLogger().error( "Unable to load module '" + f.stem().string() + "' as it is already loaded" );
      return nullptr;
   }

   // copy to temp dir
   fs::path cacheDir( f.parent_path() /= g_framework.getServerZone().getConfig()->getValue< std::string >( "Settings.General.Scripts.CachePath", "./cache/" ) );
   fs::create_directories( cacheDir );
   fs::path dest( cacheDir /= f.filename().string() );

   try
   {
      fs::copy_file( f, dest, fs::copy_option::overwrite_if_exists );
   }
   catch ( const boost::filesystem::filesystem_error& err )
   {
      g_log.error( "Error copying file to cache: " + err.code().message() );

      return nullptr;
   }


#ifdef _WIN32
   ModuleHandle handle = LoadLibrary( dest.string().c_str() );
#else
   ModuleHandle handle = dlopen( dest.string().c_str(), RTLD_LAZY );
#endif

   if ( !handle )
   {
      g_framework.getLogger().error( "Failed to load module from: " + path );

      return nullptr;
   }

   g_framework.getLogger().debug( "Loaded module '" + f.filename().string() + "' @ 0x" + boost::str( boost::format( "%|08X|" ) % handle ) );

   auto info = new ScriptInfo;
   info->handle = handle;
   info->library_name = f.stem().string();
   info->cache_path = dest.string();
   info->library_path = f.string();

   m_scriptMap.insert( std::make_pair( f.stem().string(), info ) );

   return info;
}

ScriptObject** Core::Scripting::ScriptLoader::getScripts( ModuleHandle handle )
{
   using getScripts = ScriptObject**( *)( );

#ifdef _WIN32
   getScripts func = reinterpret_cast< getScripts >( GetProcAddress( handle, "getScripts" ) );
#else
   getScripts func = reinterpret_cast< getScripts >( dlsym( handle, "getScripts" ) );
#endif

   if ( func )
   {
      auto ptr = func();

      g_framework.getLogger().debug( "got ScriptObject array @ 0x" + boost::str( boost::format( "%|08X|" ) % ptr ) );

      return ptr;
   }
   else
      return nullptr;
}

bool Core::Scripting::ScriptLoader::unloadScript( Core::Scripting::ScriptInfo* info )
{
   return unloadScript( info->handle );
}

bool Core::Scripting::ScriptLoader::unloadScript( ModuleHandle handle )
{
   for ( auto it = m_scriptMap.begin(); it != m_scriptMap.end(); ++it )
   {
      if ( it->second->handle == handle )
      {
         auto info = it->second;

         if ( unloadModule( handle ) )
         {
            m_scriptMap.erase( it );

            // remove cached file
            fs::remove( info->cache_path );

            delete info;

            return true;
         }

         g_framework.getLogger().error( "failed to unload module: " + info->library_name );

         return false;
      }
   }

   return false;
}

bool Core::Scripting::ScriptLoader::isModuleLoaded( std::string name )
{
   for ( auto it = m_scriptMap.begin(); it != m_scriptMap.end(); ++it )
   {
      if ( boost::iequals( it->second->library_name, name ) )
         return true;
   }

   return false;
}

Core::Scripting::ScriptInfo* Core::Scripting::ScriptLoader::getScriptInfo( std::string name )
{
   for ( auto it = m_scriptMap.begin(); it != m_scriptMap.end(); ++it )
   {
      if ( it->second->library_name == name )
      {
         return it->second;
      }
   }

   return nullptr;
}

void Core::Scripting::ScriptLoader::findScripts( std::set< Core::Scripting::ScriptInfo* >& scripts, const std::string& search )
{
   for ( auto it = m_scriptMap.begin(); it != m_scriptMap.end(); ++it )
   {
      if ( it->second->library_name.find( search ) != std::string::npos )
      {
         scripts.insert( it->second );
      }
   }
}