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