sourcemm/CPlugin.cpp
author David Anderson <dvander@alliedmods.net>
Thu May 26 08:06:23 2005 +0000 (2005-05-26)
changeset 67 1753f7a9b2f2
parent 51 7985801b5b42
child 69 a9eb19e40927
permissions -rw-r--r--
Working ConCommandBase replacement code
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@67
    14
#include "concommands.h"
dvander@7
    15
dvander@7
    16
/** 
dvander@7
    17
 * @brief Implements functions from CPlugin.h
dvander@7
    18
 * @file CPlugin.cpp
dvander@7
    19
 */
dvander@7
    20
dvander@7
    21
using namespace SourceMM;
dvander@7
    22
dvander@7
    23
CPluginManager g_PluginMngr;
dvander@7
    24
dvander@7
    25
CPluginManager::CPluginManager()
dvander@7
    26
{
dvander@7
    27
	m_LastId = Pl_MinId;
dvander@18
    28
	m_AllLoaded = false;
dvander@7
    29
}
dvander@7
    30
dvander@7
    31
CPluginManager::~CPluginManager()
dvander@7
    32
{
dvander@7
    33
	if (m_Plugins.size())
dvander@7
    34
	{
dvander@7
    35
		UnloadAll();
dvander@7
    36
		m_Plugins.clear();
dvander@7
    37
	}
dvander@7
    38
}
dvander@7
    39
dvander@7
    40
CPluginManager::CPlugin::CPlugin() : m_Lib(NULL), m_API(NULL), m_Id(0), m_Source(0)
dvander@7
    41
{
dvander@9
    42
	memset(&fac_list, 0, sizeof(factories));
dvander@7
    43
}
dvander@7
    44
dvander@7
    45
PluginId CPluginManager::Load(const char *file, PluginId source, bool &already, char *error, size_t maxlen)
dvander@7
    46
{
dvander@7
    47
	PluginIter i;
dvander@7
    48
dvander@7
    49
	already = false;
dvander@7
    50
	//Check if we're about to reload an old plugin
dvander@7
    51
	for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
dvander@7
    52
	{
dvander@7
    53
		if ( (*i) && (*i)->m_File.compare(file)==0 )
dvander@7
    54
		{
dvander@7
    55
			if ( (*i)->m_Status < Pl_Paused )
dvander@7
    56
			{
dvander@7
    57
				//Attempt to load the plugin again
dvander@7
    58
				already = true;
dvander@7
    59
				i = m_Plugins.erase(i);
dvander@7
    60
			} else {
dvander@7
    61
				//No need to load it
dvander@7
    62
				already = true;
dvander@7
    63
				return (*i)->m_Id;
dvander@7
    64
			}
dvander@7
    65
		}
dvander@7
    66
	}
dvander@7
    67
dvander@7
    68
	CPlugin *pl = _Load(file, source, error, maxlen);
dvander@7
    69
dvander@7
    70
	if (!pl)
dvander@7
    71
		return Pl_BadLoad;
dvander@7
    72
dvander@7
    73
	return pl->m_Id;
dvander@7
    74
}
dvander@7
    75
dvander@7
    76
CPluginManager::CPlugin *CPluginManager::FindById(PluginId id)
dvander@7
    77
{
dvander@7
    78
	PluginIter i;
dvander@7
    79
dvander@7
    80
	for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
dvander@7
    81
	{
dvander@7
    82
		if ( (*i)->m_Id == id )
dvander@7
    83
			return (*i);
dvander@7
    84
	}
dvander@7
    85
dvander@7
    86
	return NULL;
dvander@7
    87
}
dvander@7
    88
dvander@18
    89
void CPluginManager::SetAllLoaded()
dvander@18
    90
{
dvander@18
    91
	m_AllLoaded = true;
dvander@18
    92
	PluginIter i;
dvander@18
    93
dvander@18
    94
	for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
dvander@18
    95
	{
dvander@18
    96
		if ( (*i) && (*i)->m_Status == Pl_Running && (*i)->m_API )
dvander@18
    97
		{
dvander@51
    98
			//API 4 is when we added this callback
dvander@51
    99
			//Min version is now 5, so we ignore this check
dvander@51
   100
			//if ( (*i)->m_API->GetApiVersion() >= 004 )
dvander@51
   101
			(*i)->m_API->AllPluginsLoaded();
dvander@18
   102
		}
dvander@18
   103
	}
dvander@18
   104
}
dvander@18
   105
dvander@7
   106
bool CPluginManager::Pause(PluginId id, char *error, size_t maxlen)
dvander@7
   107
{
dvander@7
   108
	CPlugin *pl = FindById(id);
dvander@7
   109
	
dvander@7
   110
	if (!pl)
dvander@7
   111
	{
dvander@7
   112
		snprintf(error, maxlen, "Plugin id not found");
dvander@7
   113
		return false;
dvander@7
   114
	}
dvander@7
   115
dvander@7
   116
	return _Pause(pl, error, maxlen);
dvander@7
   117
}
dvander@7
   118
dvander@7
   119
bool CPluginManager::Unpause(PluginId id, char *error, size_t maxlen)
dvander@7
   120
{
dvander@7
   121
	CPlugin *pl = FindById(id);
dvander@7
   122
	
dvander@7
   123
	if (!pl)
dvander@7
   124
	{
dvander@7
   125
		snprintf(error, maxlen, "Plugin id not found");
dvander@7
   126
		return false;
dvander@7
   127
	}
dvander@7
   128
dvander@7
   129
	return _Unpause(pl, error, maxlen);
dvander@7
   130
}
dvander@7
   131
dvander@9
   132
bool CPluginManager::Unload(PluginId id, bool force, char *error, size_t maxlen)
dvander@7
   133
{
dvander@7
   134
	CPlugin *pl = FindById(id);
dvander@7
   135
	
dvander@7
   136
	if (!pl)
dvander@7
   137
	{
dvander@9
   138
		snprintf(error, maxlen, "Plugin %d not found", id);
dvander@7
   139
		return false;
dvander@7
   140
	}
dvander@7
   141
dvander@9
   142
	return _Unload(pl, force, error, maxlen);
dvander@7
   143
}
dvander@7
   144
dvander@29
   145
bool CPluginManager::Retry(PluginId id, char *error, size_t len)
dvander@29
   146
{
dvander@29
   147
	PluginIter i;
dvander@29
   148
	char buffer[64];
dvander@29
   149
	for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
dvander@29
   150
	{
dvander@29
   151
		if ( (*i) && (*i)->m_Id == id )
dvander@29
   152
		{
dvander@29
   153
			if ( (*i)->m_Status >= Pl_Paused)
dvander@29
   154
			{
dvander@29
   155
				snprintf(error, len, "Plugin %d is already running.", id);
dvander@29
   156
				return false;
dvander@29
   157
			}
dvander@29
   158
			CPlugin *pl = _Load((*i)->m_File.c_str(), Pl_Console, error, len);
dvander@29
   159
			if (!pl)
dvander@29
   160
				return false;
dvander@29
   161
			if (pl->m_Status >= Pl_Paused)
dvander@29
   162
			{
dvander@29
   163
				//Now it gets crazy... unload the original copy.
dvander@29
   164
				_Unload( (*i), true, buffer, sizeof(buffer)-1 );
dvander@29
   165
				
dvander@29
   166
				//Set the new copy's id
dvander@29
   167
				pl->m_Id = id;
dvander@29
   168
dvander@29
   169
				//We just wasted an id... reclaim it
dvander@29
   170
				m_LastId--;
dvander@29
   171
				
dvander@29
   172
				return true;
dvander@29
   173
			} else {
dvander@29
   174
				//don't really care about the buffer here
dvander@29
   175
				_Unload(pl, true, buffer, sizeof(buffer)-1);
dvander@29
   176
dvander@29
   177
				//We just wasted an id... reclaim it
dvander@29
   178
				m_LastId--;
dvander@29
   179
				return false;
dvander@29
   180
			}
dvander@29
   181
		}
dvander@29
   182
	}
dvander@29
   183
dvander@29
   184
	snprintf(error, len, "Plugin %d not found,", id);
dvander@29
   185
	return false;
dvander@29
   186
}
dvander@29
   187
dvander@67
   188
CPluginManager::CPlugin *CPluginManager::FindByAPI(ISmmPlugin *api)
dvander@67
   189
{
dvander@67
   190
	PluginIter i;
dvander@67
   191
dvander@67
   192
	//don't find bad plugins!
dvander@67
   193
	if (!api)
dvander@67
   194
		return NULL;
dvander@67
   195
dvander@67
   196
	for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
dvander@67
   197
	{
dvander@67
   198
		if ( (*i)->m_API == api )
dvander@67
   199
			return (*i);
dvander@67
   200
	}
dvander@67
   201
dvander@67
   202
	return NULL;
dvander@67
   203
}
dvander@67
   204
dvander@7
   205
CPluginManager::CPlugin *CPluginManager::_Load(const char *file, PluginId source, char *error, size_t maxlen)
dvander@7
   206
{
dvander@7
   207
	FILE *fp;
dvander@7
   208
	CPlugin *pl;
dvander@7
   209
dvander@7
   210
	pl = new CPlugin();
dvander@7
   211
	*error = '\0';
dvander@7
   212
	
dvander@7
   213
	//Add plugin to list
dvander@7
   214
	pl->m_Id = m_LastId;
dvander@7
   215
	pl->m_File.assign(file);
dvander@7
   216
	m_Plugins.push_back(pl);
dvander@7
   217
	m_LastId++;
dvander@7
   218
dvander@7
   219
	//Check if the file even exists
dvander@7
   220
	fp = fopen(file, "r");
dvander@7
   221
	if (!fp)
dvander@7
   222
	{
dvander@7
   223
		if (error)
dvander@7
   224
			snprintf(error, maxlen, "File not found: %s", file);
dvander@7
   225
		pl->m_Status = Pl_NotFound;
dvander@7
   226
	} else {
dvander@7
   227
		fclose(fp);
dvander@7
   228
		fp = NULL;
dvander@7
   229
		
dvander@7
   230
		//Load the file
dvander@7
   231
		pl->m_Lib = dlmount(file);
dvander@7
   232
		if (!pl->m_Lib)
dvander@7
   233
		{
dvander@7
   234
			if (error)
dvander@7
   235
				snprintf(error, maxlen, "%s", dlerror());
dvander@7
   236
			pl->m_Status = Pl_Error;
dvander@7
   237
		} else {
dvander@7
   238
			CreateInterfaceFn pfn = reinterpret_cast<CreateInterfaceFn>(dlsym(pl->m_Lib, PL_EXPOSURE_C));
dvander@7
   239
			if (!pfn)
dvander@7
   240
			{
dvander@7
   241
				if (error)
dvander@7
   242
					snprintf(error, maxlen, "Function %s not found", PL_EXPOSURE_C);
dvander@7
   243
				pl->m_Status = Pl_Error;
dvander@7
   244
			} else {
dvander@7
   245
				pl->m_API = static_cast<ISmmPlugin *>((pfn)(PLAPI_NAME, NULL));
dvander@7
   246
				if (!pl->m_API)
dvander@7
   247
				{
dvander@7
   248
					if (error)
dvander@7
   249
						snprintf(error, maxlen, "Failed to get API");
dvander@7
   250
					pl->m_Status = Pl_Error;
dvander@7
   251
				} else {
dvander@7
   252
					if (pl->m_API->GetApiVersion() < PLAPI_MIN_VERSION)
dvander@7
   253
					{
dvander@7
   254
						if (error)
dvander@7
   255
							snprintf(error, maxlen, "Plugin API %d is out of date with required minimum (%d)", pl->m_API->GetApiVersion(), PLAPI_MIN_VERSION);
dvander@7
   256
						pl->m_Status = Pl_Error;
dvander@7
   257
					} else {
dvander@7
   258
						if (pl->m_API->Load(pl->m_Id, static_cast<ISmmAPI *>(&g_SmmAPI), &(pl->fac_list), error, maxlen))
dvander@7
   259
						{
dvander@7
   260
							pl->m_Status = Pl_Running;
dvander@18
   261
							if (m_AllLoaded)
dvander@18
   262
							{
dvander@51
   263
								//API 4 is when we added this callback
dvander@51
   264
								//Removing this code as the min version is now 5
dvander@51
   265
								//if (pl->m_API->GetApiVersion() >= 4)
dvander@51
   266
								pl->m_API->AllPluginsLoaded();
dvander@18
   267
							}
dvander@7
   268
						} else {
dvander@7
   269
							pl->m_Status = Pl_Refused;
dvander@7
   270
						}
dvander@7
   271
					}
dvander@7
   272
				}
dvander@7
   273
			}
dvander@7
   274
		}
dvander@7
   275
	}
dvander@7
   276
dvander@7
   277
	if (pl->m_Lib && (pl->m_Status < Pl_Paused))
dvander@7
   278
	{
dvander@7
   279
		dlclose(pl->m_Lib);
dvander@7
   280
		pl->m_Lib = NULL;
dvander@7
   281
		pl->m_API = NULL;
dvander@7
   282
	}
dvander@7
   283
dvander@7
   284
	return pl;
dvander@7
   285
}
dvander@7
   286
dvander@9
   287
bool CPluginManager::_Unload(CPluginManager::CPlugin *pl, bool force, char *error, size_t maxlen)
dvander@7
   288
{
dvander@7
   289
	if (error)
dvander@7
   290
		*error = '\0';
dvander@7
   291
	if (pl->m_API && pl->m_Lib)
dvander@7
   292
	{
dvander@9
   293
		//Note, we'll always tell the plugin it will be unloading...
dvander@9
   294
		if (pl->m_API->Unload(error, maxlen) || force)
dvander@7
   295
		{
dvander@9
   296
			//Make sure to detach it from sourcehook!
dvander@9
   297
			g_SourceHook.UnloadPlugin(pl->m_Id);
dvander@9
   298
dvander@67
   299
			UnregAllConCmds(pl);
dvander@67
   300
dvander@9
   301
			//Clean up the DLL
dvander@7
   302
			dlclose(pl->m_Lib);
dvander@7
   303
			pl->m_Lib = NULL;
dvander@7
   304
			pl->m_API = NULL;
dvander@7
   305
dvander@7
   306
			//Remove the plugin from the list
dvander@7
   307
			PluginIter i;
dvander@7
   308
			for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
dvander@7
   309
			{
dvander@7
   310
				if ( (*i)->m_Id == pl->m_Id )
dvander@7
   311
				{
dvander@7
   312
					i = m_Plugins.erase(i);
dvander@7
   313
					break;
dvander@7
   314
				}
dvander@7
   315
			}
dvander@9
   316
			//Free its memory
dvander@7
   317
			delete pl;
dvander@7
   318
dvander@7
   319
			return true;
dvander@7
   320
		}
dvander@7
   321
	} else {
dvander@7
   322
		//The plugin is not valid, and let's just remove it from the list anyway
dvander@7
   323
		PluginIter i;
dvander@7
   324
		for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
dvander@7
   325
		{
dvander@7
   326
			if ( (*i)->m_Id == pl->m_Id )
dvander@7
   327
			{
dvander@7
   328
				i = m_Plugins.erase(i);
dvander@7
   329
				break;
dvander@7
   330
			}
dvander@7
   331
		}
dvander@7
   332
		delete pl;
dvander@7
   333
dvander@7
   334
		return true;
dvander@7
   335
	}
dvander@7
   336
dvander@7
   337
	return false;
dvander@7
   338
}
dvander@7
   339
dvander@7
   340
bool CPluginManager::_Pause(CPluginManager::CPlugin *pl, char *error, size_t maxlen)
dvander@7
   341
{
dvander@7
   342
	if (error)
dvander@7
   343
		*error = '\0';
dvander@7
   344
	if (pl->m_Status != Pl_Running || !pl->m_API)
dvander@7
   345
	{
dvander@7
   346
		if (error)
dvander@7
   347
			snprintf(error, maxlen, "Plugin cannot be paused");
dvander@7
   348
	} else {
dvander@9
   349
		if (pl->m_API->Pause(error, maxlen))
dvander@9
   350
		{
dvander@9
   351
			g_SourceHook.PausePlugin(pl->m_Id);
dvander@12
   352
			pl->m_Status = Pl_Paused;
dvander@12
   353
dvander@12
   354
			return true;
dvander@9
   355
		}
dvander@7
   356
	}
dvander@7
   357
dvander@7
   358
	return false;
dvander@7
   359
}
dvander@7
   360
dvander@7
   361
bool CPluginManager::_Unpause(CPluginManager::CPlugin *pl, char *error, size_t maxlen)
dvander@7
   362
{
dvander@7
   363
	if (error)
dvander@7
   364
		*error = '\0';
dvander@7
   365
dvander@7
   366
	if (pl->m_Status != Pl_Paused || !pl->m_API)
dvander@7
   367
	{
dvander@7
   368
		if (error)
dvander@7
   369
			snprintf(error, maxlen, "Plugin cannot be unpaused");
dvander@7
   370
	} else {
dvander@9
   371
		if (pl->m_API->Unpause(error, maxlen))
dvander@9
   372
		{
dvander@9
   373
			g_SourceHook.UnpausePlugin(pl->m_Id);
dvander@12
   374
			pl->m_Status = Pl_Running;
dvander@12
   375
dvander@12
   376
			return true;
dvander@9
   377
		}
dvander@7
   378
	}
dvander@7
   379
dvander@7
   380
	return false;
dvander@7
   381
}
dvander@7
   382
dvander@7
   383
bool CPluginManager::UnloadAll()
dvander@7
   384
{
dvander@7
   385
	PluginIter i;
dvander@7
   386
	bool status = true;
dvander@7
   387
dvander@7
   388
	for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
dvander@7
   389
	{
dvander@7
   390
		if ( (*i) )
dvander@7
   391
		{
dvander@7
   392
			if ( (*i)->m_API )
dvander@7
   393
			{
dvander@7
   394
				if ( (*i)->m_API->Unload(NULL, 0) )
dvander@7
   395
					status = false;
dvander@7
   396
dvander@67
   397
				UnregAllConCmds( (*i) );
dvander@67
   398
dvander@9
   399
				//Unlink from SourceHook
dvander@9
   400
				g_SourceHook.UnloadPlugin( (*i)->m_Id );
dvander@9
   401
dvander@9
   402
				//Free the DLL
dvander@7
   403
				dlclose( (*i)->m_Lib );
dvander@7
   404
			}
dvander@7
   405
			delete (*i);
dvander@7
   406
		}
dvander@67
   407
	}
dvander@7
   408
dvander@67
   409
	m_Plugins.clear();
dvander@7
   410
dvander@7
   411
	return status;
dvander@7
   412
}
dvander@7
   413
dvander@7
   414
bool CPluginManager::Query(PluginId id, const char *&file, factories *&list, Pl_Status &status, PluginId &source)
dvander@7
   415
{
dvander@7
   416
	CPlugin *pl = FindById(id);
dvander@7
   417
dvander@7
   418
	if (!pl)
dvander@7
   419
		return false;
dvander@7
   420
dvander@7
   421
	file = pl->m_File.c_str();
dvander@7
   422
	list = &(pl->fac_list);
dvander@7
   423
	status = pl->m_Status;
dvander@7
   424
	source = pl->m_Source;
dvander@7
   425
dvander@7
   426
	return true;
dvander@7
   427
}
dvander@7
   428
dvander@7
   429
PluginIter CPluginManager::_begin()
dvander@7
   430
{
dvander@7
   431
	return m_Plugins.begin();
dvander@7
   432
}
dvander@7
   433
dvander@7
   434
PluginIter CPluginManager::_end()
dvander@7
   435
{
dvander@7
   436
	return m_Plugins.end();
dvander@7
   437
}
dvander@67
   438
dvander@67
   439
void CPluginManager::AddPluginCvar(ISmmPlugin *api, ConCommandBase *pCvar)
dvander@67
   440
{
dvander@67
   441
	CPlugin *pl = FindByAPI(api);
dvander@67
   442
dvander@67
   443
	if (!pl)
dvander@67
   444
		return;
dvander@67
   445
dvander@67
   446
	pl->m_Cvars.push_back(pCvar);
dvander@67
   447
}
dvander@67
   448
dvander@67
   449
void CPluginManager::AddPluginCmd(ISmmPlugin *api, ConCommandBase *pCmd)
dvander@67
   450
{
dvander@67
   451
	CPlugin *pl = FindByAPI(api);
dvander@67
   452
dvander@67
   453
	if (!pl)
dvander@67
   454
		return;
dvander@67
   455
dvander@67
   456
	pl->m_Cmds.push_back(pCmd);
dvander@67
   457
}
dvander@67
   458
dvander@67
   459
void CPluginManager::RemovePluginCvar(ISmmPlugin *api, ConCommandBase *pCvar)
dvander@67
   460
{
dvander@67
   461
	CPlugin *pl = FindByAPI(api);
dvander@67
   462
dvander@67
   463
	if (!pl)
dvander@67
   464
		return;
dvander@67
   465
dvander@67
   466
	pl->m_Cvars.remove(pCvar);
dvander@67
   467
}
dvander@67
   468
dvander@67
   469
void CPluginManager::RemovePluginCmd(ISmmPlugin *api, ConCommandBase *pCmd)
dvander@67
   470
{
dvander@67
   471
	CPlugin *pl = FindByAPI(api);
dvander@67
   472
dvander@67
   473
	if (!pl)
dvander@67
   474
		return;
dvander@67
   475
dvander@67
   476
	pl->m_Cmds.remove(pCmd);
dvander@67
   477
}
dvander@67
   478
dvander@67
   479
void CPluginManager::UnregAllConCmds(CPlugin *pl)
dvander@67
   480
{
dvander@67
   481
	std::list<ConCommandBase *>::iterator i;
dvander@67
   482
dvander@67
   483
	for (i=pl->m_Cvars.begin(); i!=pl->m_Cvars.end(); i++)
dvander@67
   484
		g_SMConVarAccessor.Unregister( (*i) );
dvander@67
   485
dvander@67
   486
	pl->m_Cvars.clear();
dvander@67
   487
dvander@67
   488
	for (i=pl->m_Cmds.begin(); i!=pl->m_Cmds.end(); i++)
dvander@67
   489
		g_SMConVarAccessor.Unregister( (*i) );
dvander@67
   490
dvander@67
   491
	pl->m_Cmds.clear();
dvander@67
   492
}