sourcemm/CPlugin.cpp
author David Anderson <dvander@alliedmods.net>
Sat Apr 16 23:33:39 2005 +0000 (2005-04-16)
changeset 9 01b8b7435e67
parent 7 8ef11f6189e4
child 12 9fd53562f68c
permissions -rw-r--r--
Implemented factory hooks
Added commands: clear, load, pause, unload, unpause
Rewrote headers
     1 /* ======== SourceMM ========
     2 * Copyright (C) 2004-2005 Metamod:Source Development Team
     3 * No warranties of any kind
     4 *
     5 * License: zlib/libpng
     6 *
     7 * Author(s): David "BAILOPAN" Anderson
     8 * ============================
     9 */
    10 
    11 #include "CPlugin.h"
    12 #include "CSmmAPI.h"
    13 #include "sourcemm.h"
    14 
    15 /** 
    16  * @brief Implements functions from CPlugin.h
    17  * @file CPlugin.cpp
    18  */
    19 
    20 using namespace SourceMM;
    21 
    22 CPluginManager g_PluginMngr;
    23 
    24 CPluginManager::CPluginManager()
    25 {
    26 	m_LastId = Pl_MinId;
    27 }
    28 
    29 CPluginManager::~CPluginManager()
    30 {
    31 	if (m_Plugins.size())
    32 	{
    33 		UnloadAll();
    34 		m_Plugins.clear();
    35 	}
    36 }
    37 
    38 CPluginManager::CPlugin::CPlugin() : m_Lib(NULL), m_API(NULL), m_Id(0), m_Source(0)
    39 {
    40 	memset(&fac_list, 0, sizeof(factories));
    41 }
    42 
    43 PluginId CPluginManager::Load(const char *file, PluginId source, bool &already, char *error, size_t maxlen)
    44 {
    45 	PluginIter i;
    46 
    47 	already = false;
    48 	//Check if we're about to reload an old plugin
    49 	for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
    50 	{
    51 		if ( (*i) && (*i)->m_File.compare(file)==0 )
    52 		{
    53 			if ( (*i)->m_Status < Pl_Paused )
    54 			{
    55 				//Attempt to load the plugin again
    56 				already = true;
    57 				i = m_Plugins.erase(i);
    58 			} else {
    59 				//No need to load it
    60 				already = true;
    61 				return (*i)->m_Id;
    62 			}
    63 		}
    64 	}
    65 
    66 	CPlugin *pl = _Load(file, source, error, maxlen);
    67 
    68 	if (!pl)
    69 		return Pl_BadLoad;
    70 
    71 	return pl->m_Id;
    72 }
    73 
    74 CPluginManager::CPlugin *CPluginManager::FindById(PluginId id)
    75 {
    76 	PluginIter i;
    77 
    78 	for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
    79 	{
    80 		if ( (*i)->m_Id == id )
    81 			return (*i);
    82 	}
    83 
    84 	return NULL;
    85 }
    86 
    87 bool CPluginManager::Pause(PluginId id, char *error, size_t maxlen)
    88 {
    89 	CPlugin *pl = FindById(id);
    90 	
    91 	if (!pl)
    92 	{
    93 		snprintf(error, maxlen, "Plugin id not found");
    94 		return false;
    95 	}
    96 
    97 	return _Pause(pl, error, maxlen);
    98 }
    99 
   100 bool CPluginManager::Unpause(PluginId id, char *error, size_t maxlen)
   101 {
   102 	CPlugin *pl = FindById(id);
   103 	
   104 	if (!pl)
   105 	{
   106 		snprintf(error, maxlen, "Plugin id not found");
   107 		return false;
   108 	}
   109 
   110 	return _Unpause(pl, error, maxlen);
   111 }
   112 
   113 bool CPluginManager::Unload(PluginId id, bool force, char *error, size_t maxlen)
   114 {
   115 	CPlugin *pl = FindById(id);
   116 	
   117 	if (!pl)
   118 	{
   119 		snprintf(error, maxlen, "Plugin %d not found", id);
   120 		return false;
   121 	}
   122 
   123 	return _Unload(pl, force, error, maxlen);
   124 }
   125 
   126 CPluginManager::CPlugin *CPluginManager::_Load(const char *file, PluginId source, char *error, size_t maxlen)
   127 {
   128 	FILE *fp;
   129 	CPlugin *pl;
   130 
   131 	pl = new CPlugin();
   132 	*error = '\0';
   133 	
   134 	//Add plugin to list
   135 	pl->m_Id = m_LastId;
   136 	pl->m_File.assign(file);
   137 	m_Plugins.push_back(pl);
   138 	m_LastId++;
   139 
   140 	//Check if the file even exists
   141 	fp = fopen(file, "r");
   142 	if (!fp)
   143 	{
   144 		if (error)
   145 			snprintf(error, maxlen, "File not found: %s", file);
   146 		pl->m_Status = Pl_NotFound;
   147 	} else {
   148 		fclose(fp);
   149 		fp = NULL;
   150 		
   151 		//Load the file
   152 		pl->m_Lib = dlmount(file);
   153 		if (!pl->m_Lib)
   154 		{
   155 			if (error)
   156 				snprintf(error, maxlen, "%s", dlerror());
   157 			pl->m_Status = Pl_Error;
   158 		} else {
   159 			CreateInterfaceFn pfn = reinterpret_cast<CreateInterfaceFn>(dlsym(pl->m_Lib, PL_EXPOSURE_C));
   160 			if (!pfn)
   161 			{
   162 				if (error)
   163 					snprintf(error, maxlen, "Function %s not found", PL_EXPOSURE_C);
   164 				pl->m_Status = Pl_Error;
   165 			} else {
   166 				pl->m_API = static_cast<ISmmPlugin *>((pfn)(PLAPI_NAME, NULL));
   167 				if (!pl->m_API)
   168 				{
   169 					if (error)
   170 						snprintf(error, maxlen, "Failed to get API");
   171 					pl->m_Status = Pl_Error;
   172 				} else {
   173 					if (pl->m_API->GetApiVersion() < PLAPI_MIN_VERSION)
   174 					{
   175 						if (error)
   176 							snprintf(error, maxlen, "Plugin API %d is out of date with required minimum (%d)", pl->m_API->GetApiVersion(), PLAPI_MIN_VERSION);
   177 						pl->m_Status = Pl_Error;
   178 					} else {
   179 						if (pl->m_API->Load(pl->m_Id, static_cast<ISmmAPI *>(&g_SmmAPI), &(pl->fac_list), error, maxlen))
   180 						{
   181 							pl->m_Status = Pl_Running;
   182 						} else {
   183 							pl->m_Status = Pl_Refused;
   184 						}
   185 					}
   186 				}
   187 			}
   188 		}
   189 	}
   190 
   191 	if (pl->m_Lib && (pl->m_Status < Pl_Paused))
   192 	{
   193 		dlclose(pl->m_Lib);
   194 		pl->m_Lib = NULL;
   195 		pl->m_API = NULL;
   196 	}
   197 
   198 	return pl;
   199 }
   200 
   201 bool CPluginManager::_Unload(CPluginManager::CPlugin *pl, bool force, char *error, size_t maxlen)
   202 {
   203 	if (error)
   204 		*error = '\0';
   205 	if (pl->m_API && pl->m_Lib)
   206 	{
   207 		//Note, we'll always tell the plugin it will be unloading...
   208 		if (pl->m_API->Unload(error, maxlen) || force)
   209 		{
   210 			//Make sure to detach it from sourcehook!
   211 			g_SourceHook.UnloadPlugin(pl->m_Id);
   212 
   213 			//Clean up the DLL
   214 			dlclose(pl->m_Lib);
   215 			pl->m_Lib = NULL;
   216 			pl->m_API = NULL;
   217 
   218 			//Remove the plugin from the list
   219 			PluginIter i;
   220 			for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
   221 			{
   222 				if ( (*i)->m_Id == pl->m_Id )
   223 				{
   224 					i = m_Plugins.erase(i);
   225 					break;
   226 				}
   227 			}
   228 			//Free its memory
   229 			delete pl;
   230 
   231 			return true;
   232 		}
   233 	} else {
   234 		//The plugin is not valid, and let's just remove it from the list anyway
   235 		PluginIter i;
   236 		for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
   237 		{
   238 			if ( (*i)->m_Id == pl->m_Id )
   239 			{
   240 				i = m_Plugins.erase(i);
   241 				break;
   242 			}
   243 		}
   244 		delete pl;
   245 
   246 		return true;
   247 	}
   248 
   249 	return false;
   250 }
   251 
   252 bool CPluginManager::_Pause(CPluginManager::CPlugin *pl, char *error, size_t maxlen)
   253 {
   254 	if (error)
   255 		*error = '\0';
   256 	if (pl->m_Status != Pl_Running || !pl->m_API)
   257 	{
   258 		if (error)
   259 			snprintf(error, maxlen, "Plugin cannot be paused");
   260 	} else {
   261 		if (pl->m_API->Pause(error, maxlen))
   262 		{
   263 			g_SourceHook.PausePlugin(pl->m_Id);
   264 		}
   265 	}
   266 
   267 	return false;
   268 }
   269 
   270 bool CPluginManager::_Unpause(CPluginManager::CPlugin *pl, char *error, size_t maxlen)
   271 {
   272 	if (error)
   273 		*error = '\0';
   274 
   275 	if (pl->m_Status != Pl_Paused || !pl->m_API)
   276 	{
   277 		if (error)
   278 			snprintf(error, maxlen, "Plugin cannot be unpaused");
   279 	} else {
   280 		if (pl->m_API->Unpause(error, maxlen))
   281 		{
   282 			g_SourceHook.UnpausePlugin(pl->m_Id);
   283 		}
   284 	}
   285 
   286 	return false;
   287 }
   288 
   289 bool CPluginManager::UnloadAll()
   290 {
   291 	PluginIter i;
   292 	bool status = true;
   293 
   294 	for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
   295 	{
   296 		if ( (*i) )
   297 		{
   298 			if ( (*i)->m_API )
   299 			{
   300 				if ( (*i)->m_API->Unload(NULL, 0) )
   301 					status = false;
   302 
   303 				//Unlink from SourceHook
   304 				g_SourceHook.UnloadPlugin( (*i)->m_Id );
   305 
   306 				//Free the DLL
   307 				dlclose( (*i)->m_Lib );
   308 			}
   309 			delete (*i);
   310 		}
   311 
   312 		i = m_Plugins.erase(i);
   313 	}
   314 
   315 	return status;
   316 }
   317 
   318 bool CPluginManager::Query(PluginId id, const char *&file, factories *&list, Pl_Status &status, PluginId &source)
   319 {
   320 	CPlugin *pl = FindById(id);
   321 
   322 	if (!pl)
   323 		return false;
   324 
   325 	file = pl->m_File.c_str();
   326 	list = &(pl->fac_list);
   327 	status = pl->m_Status;
   328 	source = pl->m_Source;
   329 
   330 	return true;
   331 }
   332 
   333 PluginIter CPluginManager::_begin()
   334 {
   335 	return m_Plugins.begin();
   336 }
   337 
   338 PluginIter CPluginManager::_end()
   339 {
   340 	return m_Plugins.end();
   341 }