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