sourcemm/metamod_plugins.cpp
author David Anderson <dvander@alliedmods.net>
Thu Jan 10 19:05:59 2008 +0000 (2008-01-10)
changeset 489 77c6b0da24ec
parent 481 5a2e34651450
child 495 e091f2b5e913
permissions -rw-r--r--
fixed FormatMessage() misuse and improver error handling
dvander@371
     1
/**
dvander@371
     2
 * vim: set ts=4 :
dvander@371
     3
 * ======================================================
dvander@371
     4
 * Metamod:Source
dvander@371
     5
 * Copyright (C) 2004-2007 AlliedModders LLC and authors.
dvander@371
     6
 * All rights reserved.
dvander@371
     7
 * ======================================================
dvander@371
     8
 *
dvander@371
     9
 * This software is provided 'as-is', without any express or implied warranty.
dvander@371
    10
 * In no event will the authors be held liable for any damages arising from 
dvander@371
    11
 * the use of this software.
dvander@371
    12
 * 
dvander@371
    13
 * Permission is granted to anyone to use this software for any purpose, 
dvander@371
    14
 * including commercial applications, and to alter it and redistribute it 
dvander@371
    15
 * freely, subject to the following restrictions:
dvander@371
    16
 *
dvander@371
    17
 * 1. The origin of this software must not be misrepresented; you must not 
dvander@371
    18
 * claim that you wrote the original software. If you use this software in a 
dvander@371
    19
 * product, an acknowledgment in the product documentation would be 
dvander@371
    20
 * appreciated but is not required.
dvander@371
    21
 * 2. Altered source versions must be plainly marked as such, and must not be
dvander@371
    22
 * misrepresented as being the original software.
dvander@371
    23
 * 3. This notice may not be removed or altered from any source distribution.
dvander@371
    24
 *
dvander@371
    25
 * Version: $Id$
dvander@371
    26
 */
dvander@371
    27
dvander@481
    28
#include "metamod_oslink.h"
dvander@371
    29
#if defined _DEBUG
dvander@371
    30
#define DEBUG2
dvander@371
    31
#undef _DEBUG
dvander@371
    32
#endif
dvander@371
    33
#include "metamod.h"
dvander@371
    34
#include "metamod_plugins.h"
dvander@371
    35
#include "metamod_util.h"
dvander@371
    36
#if defined DEBUG2
dvander@371
    37
#undef DEBUG2
dvander@371
    38
#define _DEBUG
dvander@371
    39
#endif
dvander@371
    40
dvander@371
    41
/** 
dvander@371
    42
 * @brief Implements functions from CPlugin.h
dvander@371
    43
 * @file CPlugin.cpp
dvander@371
    44
 */
dvander@371
    45
dvander@371
    46
using namespace SourceMM;
dvander@371
    47
dvander@371
    48
#define ITER_PLEVENT(evn, plid) \
dvander@371
    49
	CPluginManager::CPlugin *_Xpl; \
dvander@371
    50
	SourceHook::List<IMetamodListener *>::iterator event; \
dvander@371
    51
	IMetamodListener *api; \
dvander@371
    52
	for (PluginIter iter = g_PluginMngr._begin(); iter != g_PluginMngr._end(); iter++) { \
dvander@371
    53
		_Xpl = (*iter); \
dvander@371
    54
		if (_Xpl->m_Id == plid) \
dvander@371
    55
			continue; \
dvander@371
    56
		for (event=_Xpl->m_Events.begin(); event!=_Xpl->m_Events.end(); event++) { \
dvander@371
    57
			api = (*event); \
dvander@371
    58
			api->evn(plid); \
dvander@371
    59
		} \
dvander@371
    60
	}
dvander@371
    61
dvander@371
    62
CPluginManager g_PluginMngr;
dvander@371
    63
dvander@400
    64
MetamodVersionInfo GlobVersionInfo = 
dvander@400
    65
{
dvander@400
    66
	METAMOD_API_MAJOR,
dvander@400
    67
	METAMOD_API_MINOR,
dvander@400
    68
	SH_IFACE_VERSION,
dvander@400
    69
	SH_IMPL_VERSION,
dvander@400
    70
	PLAPI_MIN_VERSION,
dvander@400
    71
	METAMOD_PLAPI_VERSION,
dvander@400
    72
	SOURCE_ENGINE_UNKNOWN
dvander@400
    73
};
dvander@400
    74
dvander@371
    75
CPluginManager::CPluginManager()
dvander@371
    76
{
dvander@371
    77
	m_LastId = Pl_MinId;
dvander@371
    78
	m_AllLoaded = false;
dvander@371
    79
}
dvander@371
    80
dvander@371
    81
CPluginManager::~CPluginManager()
dvander@371
    82
{
dvander@371
    83
	SourceHook::List<CNameAlias *>::iterator iter;
dvander@371
    84
dvander@371
    85
	for (iter = m_Aliases.begin(); iter != m_Aliases.end(); iter++)
dvander@371
    86
	{
dvander@371
    87
		delete (*iter);
dvander@371
    88
	}
dvander@371
    89
dvander@371
    90
	m_Aliases.clear();
dvander@371
    91
}
dvander@371
    92
dvander@371
    93
const char *CPluginManager::LookupAlias(const char *alias)
dvander@371
    94
{
dvander@371
    95
	SourceHook::List<CNameAlias *>::iterator iter;
dvander@371
    96
	CNameAlias *p;
dvander@371
    97
dvander@371
    98
	for (iter = m_Aliases.begin(); iter != m_Aliases.end(); iter++)
dvander@371
    99
	{
dvander@371
   100
		p = (*iter);
dvander@371
   101
		if (p->alias.compare(alias) == 0)
dvander@371
   102
		{
dvander@371
   103
			return p->value.c_str();
dvander@371
   104
		}
dvander@371
   105
	}
dvander@371
   106
dvander@371
   107
	return NULL;
dvander@371
   108
}
dvander@371
   109
dvander@396
   110
SourceHook::List<CNameAlias *>::iterator CPluginManager::_alias_begin()
dvander@371
   111
{
dvander@371
   112
	return m_Aliases.begin();
dvander@371
   113
}
dvander@371
   114
dvander@396
   115
SourceHook::List<CNameAlias *>::iterator CPluginManager::_alias_end()
dvander@371
   116
{
dvander@371
   117
	return m_Aliases.end();
dvander@371
   118
}
dvander@371
   119
dvander@371
   120
void CPluginManager::SetAlias(const char *alias, const char *value)
dvander@371
   121
{
dvander@371
   122
	SourceHook::List<CNameAlias *>::iterator iter;
dvander@371
   123
	CNameAlias *p;
dvander@371
   124
dvander@371
   125
	for (iter = m_Aliases.begin(); iter != m_Aliases.end(); iter++)
dvander@371
   126
	{
dvander@371
   127
		p = (*iter);
dvander@371
   128
		if (p->alias.compare(alias) == 0)
dvander@371
   129
		{
dvander@371
   130
			if (value[0] == '\0')
dvander@371
   131
			{
dvander@371
   132
				iter = m_Aliases.erase(iter);
dvander@371
   133
				return;
dvander@371
   134
			}
dvander@371
   135
			else
dvander@371
   136
			{
dvander@371
   137
				p->value.assign(value);
dvander@371
   138
				return;
dvander@371
   139
			}
dvander@371
   140
		}
dvander@371
   141
	}
dvander@371
   142
dvander@371
   143
	if (value[0] != '\0')
dvander@371
   144
	{
dvander@371
   145
		p = new CNameAlias;
dvander@371
   146
	
dvander@371
   147
		p->alias.assign(alias);
dvander@371
   148
		p->value.assign(value);
dvander@371
   149
	
dvander@371
   150
		m_Aliases.push_back(p);
dvander@371
   151
	}
dvander@371
   152
}
dvander@371
   153
dvander@400
   154
CPluginManager::CPlugin::CPlugin() : m_Id(0), m_Source(0), m_API(NULL), m_Lib(NULL), m_UnloadFn(NULL)
dvander@371
   155
{
dvander@371
   156
dvander@371
   157
}
dvander@371
   158
dvander@371
   159
PluginId CPluginManager::Load(const char *file, PluginId source, bool &already, char *error, size_t maxlen)
dvander@371
   160
{
dvander@371
   161
	already = false;
dvander@371
   162
	//Check if we're about to reload an old plugin
dvander@371
   163
	PluginIter i = m_Plugins.begin();
dvander@371
   164
	while (i != m_Plugins.end())
dvander@371
   165
	{
dvander@371
   166
		if ((*i) && UTIL_PathCmp(file, (*i)->m_File.c_str()))
dvander@371
   167
		{
dvander@371
   168
			if ((*i)->m_Status < Pl_Paused)
dvander@371
   169
			{
dvander@371
   170
				//Attempt to load the plugin again
dvander@371
   171
				already = true;
dvander@371
   172
				i = m_Plugins.erase(i);
dvander@371
   173
				continue;
dvander@371
   174
			}
dvander@371
   175
			else
dvander@371
   176
			{
dvander@371
   177
				//No need to load it
dvander@371
   178
				already = true;
dvander@371
   179
				return (*i)->m_Id;
dvander@371
   180
			}
dvander@371
   181
		}
dvander@371
   182
		i++;
dvander@371
   183
	}
dvander@371
   184
dvander@371
   185
	CPlugin *pl = _Load(file, source, error, maxlen);
dvander@371
   186
dvander@371
   187
	if (!pl)
dvander@371
   188
	{
dvander@371
   189
		return Pl_BadLoad;
dvander@371
   190
	}
dvander@371
   191
dvander@371
   192
	ITER_PLEVENT(OnPluginLoad, pl->m_Id);
dvander@371
   193
dvander@371
   194
	return pl->m_Id;
dvander@371
   195
}
dvander@371
   196
dvander@371
   197
CPluginManager::CPlugin *CPluginManager::FindById(PluginId id)
dvander@371
   198
{
dvander@371
   199
	PluginIter i;
dvander@371
   200
dvander@371
   201
	for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
dvander@371
   202
	{
dvander@371
   203
		if ( (*i)->m_Id == id )\
dvander@371
   204
		{
dvander@371
   205
			return (*i);
dvander@371
   206
		}
dvander@371
   207
	}
dvander@371
   208
dvander@371
   209
	return NULL;
dvander@371
   210
}
dvander@371
   211
dvander@371
   212
void CPluginManager::SetAllLoaded()
dvander@371
   213
{
dvander@481
   214
	if (m_AllLoaded)
dvander@481
   215
	{
dvander@481
   216
		return;
dvander@481
   217
	}
dvander@481
   218
dvander@371
   219
	m_AllLoaded = true;
dvander@371
   220
	PluginIter i;
dvander@371
   221
dvander@371
   222
	for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
dvander@371
   223
	{
dvander@371
   224
		if ( (*i) && (*i)->m_Status == Pl_Running && (*i)->m_API )
dvander@371
   225
		{
dvander@371
   226
			//API 4 is when we added this callback
dvander@371
   227
			//Min version is now 5, so we ignore this check
dvander@371
   228
			//if ( (*i)->m_API->GetApiVersion() >= 004 )
dvander@371
   229
			(*i)->m_API->AllPluginsLoaded();
dvander@371
   230
		}
dvander@371
   231
	}
dvander@371
   232
}
dvander@371
   233
dvander@371
   234
bool CPluginManager::Pause(PluginId id, char *error, size_t maxlen)
dvander@371
   235
{
dvander@371
   236
	CPlugin *pl = FindById(id);
dvander@371
   237
	
dvander@371
   238
	if (!pl)
dvander@371
   239
	{
dvander@371
   240
		UTIL_Format(error, maxlen, "Plugin id not found");
dvander@371
   241
		return false;
dvander@371
   242
	}
dvander@371
   243
dvander@371
   244
	bool ret;
dvander@371
   245
	
dvander@371
   246
	if ((ret=_Pause(pl, error, maxlen)) == true)
dvander@371
   247
	{
dvander@371
   248
		ITER_PLEVENT(OnPluginPause, pl->m_Id);
dvander@371
   249
	}
dvander@371
   250
dvander@371
   251
	return ret;
dvander@371
   252
}
dvander@371
   253
dvander@371
   254
bool CPluginManager::Unpause(PluginId id, char *error, size_t maxlen)
dvander@371
   255
{
dvander@371
   256
	CPlugin *pl = FindById(id);
dvander@371
   257
	
dvander@371
   258
	if (!pl)
dvander@371
   259
	{
dvander@371
   260
		UTIL_Format(error, maxlen, "Plugin id not found");
dvander@371
   261
		return false;
dvander@371
   262
	}
dvander@371
   263
dvander@371
   264
	bool ret;
dvander@371
   265
	
dvander@371
   266
	if ( (ret=_Unpause(pl, error, maxlen)) == true )
dvander@371
   267
	{
dvander@371
   268
		ITER_PLEVENT(OnPluginUnpause, pl->m_Id);
dvander@371
   269
	}
dvander@371
   270
dvander@371
   271
	return ret;
dvander@371
   272
}
dvander@371
   273
dvander@371
   274
bool CPluginManager::Unload(PluginId id, bool force, char *error, size_t maxlen)
dvander@371
   275
{
dvander@371
   276
	CPlugin *pl = FindById(id);
dvander@371
   277
	
dvander@371
   278
	if (!pl)
dvander@371
   279
	{
dvander@371
   280
		UTIL_Format(error, maxlen, "Plugin %d not found", id);
dvander@371
   281
		return false;
dvander@371
   282
	}
dvander@371
   283
dvander@371
   284
	bool ret;
dvander@371
   285
	PluginId old_id = pl->m_Id;
dvander@371
   286
	if ( (ret=_Unload(pl, force, error, maxlen)) == true )
dvander@371
   287
	{
dvander@371
   288
		ITER_PLEVENT(OnPluginUnload, old_id);
dvander@371
   289
	}
dvander@371
   290
dvander@371
   291
	return ret;
dvander@371
   292
}
dvander@371
   293
dvander@371
   294
bool CPluginManager::Retry(PluginId id, char *error, size_t len)
dvander@371
   295
{
dvander@371
   296
	PluginIter i;
dvander@371
   297
	char buffer[64];
dvander@371
   298
	for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
dvander@371
   299
	{
dvander@371
   300
		if ( (*i) && (*i)->m_Id == id )
dvander@371
   301
		{
dvander@371
   302
			if ( (*i)->m_Status >= Pl_Paused)
dvander@371
   303
			{
dvander@371
   304
				UTIL_Format(error, len, "Plugin %d is already running.", id);
dvander@371
   305
				return false;
dvander@371
   306
			}
dvander@371
   307
			CPlugin *pl = _Load((*i)->m_File.c_str(), Pl_Console, error, len);
dvander@371
   308
			if (!pl)
dvander@371
   309
			{
dvander@371
   310
				return false;
dvander@371
   311
			}
dvander@371
   312
			if (pl->m_Status >= Pl_Paused)
dvander@371
   313
			{
dvander@371
   314
				//Now it gets crazy... unload the original copy.
dvander@371
   315
				_Unload( (*i), true, buffer, sizeof(buffer)-1 );
dvander@371
   316
				
dvander@371
   317
				//Set the new copy's id
dvander@371
   318
				pl->m_Id = id;
dvander@371
   319
dvander@371
   320
				//We just wasted an id... reclaim it
dvander@371
   321
				m_LastId--;
dvander@371
   322
				
dvander@371
   323
				return true;
dvander@371
   324
			}
dvander@371
   325
			else
dvander@371
   326
			{
dvander@371
   327
				//don't really care about the buffer here
dvander@371
   328
				_Unload(pl, true, buffer, sizeof(buffer)-1);
dvander@371
   329
dvander@371
   330
				//We just wasted an id... reclaim it
dvander@371
   331
				m_LastId--;
dvander@371
   332
				return false;
dvander@371
   333
			}
dvander@371
   334
		}
dvander@371
   335
	}
dvander@371
   336
dvander@371
   337
	UTIL_Format(error, len, "Plugin %d not found,", id);
dvander@371
   338
	return false;
dvander@371
   339
}
dvander@371
   340
dvander@371
   341
CPluginManager::CPlugin *CPluginManager::FindByAPI(ISmmPlugin *api)
dvander@371
   342
{
dvander@371
   343
	PluginIter i;
dvander@371
   344
dvander@371
   345
	//don't find bad plugins!
dvander@371
   346
	if (!api)
dvander@371
   347
	{
dvander@371
   348
		return NULL;
dvander@371
   349
	}
dvander@371
   350
dvander@371
   351
	for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
dvander@371
   352
	{
dvander@371
   353
		if ((*i)->m_API == api)
dvander@371
   354
		{
dvander@371
   355
			return (*i);
dvander@371
   356
		}
dvander@371
   357
	}
dvander@371
   358
dvander@371
   359
	return NULL;
dvander@371
   360
}
dvander@371
   361
dvander@371
   362
int CPluginManager::GetPluginCount()
dvander@371
   363
{
dvander@371
   364
	return (int)m_Plugins.size();
dvander@371
   365
}
dvander@371
   366
dvander@371
   367
const char *CPluginManager::GetStatusText(CPlugin *pl)
dvander@371
   368
{
dvander@371
   369
	switch (pl->m_Status)
dvander@371
   370
	{
dvander@371
   371
	case Pl_NotFound:
dvander@371
   372
		return "NOFILE";
dvander@371
   373
	case Pl_Error:
dvander@371
   374
		return "ERROR";
dvander@371
   375
	case Pl_Refused:
dvander@371
   376
		return "FAILED";
dvander@371
   377
	case Pl_Paused:
dvander@371
   378
		return "PAUSED";
dvander@371
   379
	case Pl_Running:
dvander@371
   380
		{
dvander@371
   381
			if (pl->m_API && pl->m_API->QueryRunning(NULL, 0))
dvander@371
   382
			{
dvander@371
   383
				return "STOPPED";
dvander@371
   384
			} else {
dvander@371
   385
				return "RUNNING";
dvander@371
   386
			}
dvander@371
   387
		}
dvander@371
   388
	default:
dvander@371
   389
		return "-";
dvander@371
   390
	}
dvander@371
   391
}
dvander@371
   392
dvander@371
   393
CPluginManager::CPlugin *CPluginManager::_Load(const char *file, PluginId source, char *error, size_t maxlen)
dvander@371
   394
{
dvander@371
   395
	FILE *fp;
dvander@371
   396
	CPlugin *pl;
dvander@371
   397
dvander@371
   398
	pl = new CPlugin();
dvander@371
   399
	*error = '\0';
dvander@371
   400
	
dvander@371
   401
	//Add plugin to list
dvander@371
   402
	pl->m_Id = m_LastId;
dvander@371
   403
	pl->m_File.assign(file);
dvander@371
   404
	m_Plugins.push_back(pl);
dvander@371
   405
	m_LastId++;
dvander@371
   406
dvander@371
   407
	//Check if the file even exists
dvander@371
   408
	fp = fopen(file, "r");
dvander@371
   409
	if (!fp)
dvander@371
   410
	{
dvander@371
   411
		if (error)
dvander@371
   412
		{
dvander@371
   413
			UTIL_Format(error, maxlen, "File not found: %s", file);
dvander@371
   414
		}
dvander@371
   415
		pl->m_Status = Pl_NotFound;
dvander@371
   416
	}
dvander@371
   417
dvander@371
   418
	if (fp)
dvander@371
   419
	{
dvander@371
   420
		fclose(fp);
dvander@371
   421
		fp = NULL;
dvander@371
   422
		
dvander@371
   423
		//Load the file
dvander@371
   424
		pl->m_Lib = dlmount(file);
dvander@371
   425
		if (!pl->m_Lib)
dvander@371
   426
		{
dvander@371
   427
			if (error)
dvander@371
   428
			{
dvander@371
   429
				UTIL_Format(error, maxlen, "%s", dlerror());
dvander@371
   430
			}
dvander@371
   431
			pl->m_Status = Pl_Error;
dvander@371
   432
		}
dvander@371
   433
		else
dvander@371
   434
		{
dvander@400
   435
			pl->m_API = NULL;
dvander@400
   436
			
dvander@400
   437
			/**
dvander@400
   438
			 * First, try the new "advanced" interface
dvander@400
   439
			 */
dvander@400
   440
			METAMOD_FN_LOAD fnLoad = (METAMOD_FN_LOAD)dlsym(pl->m_Lib, "CreateInterface_MMS");
dvander@400
   441
			if (fnLoad != NULL)
dvander@371
   442
			{
dvander@400
   443
				if (GlobVersionInfo.source_engine == SOURCE_ENGINE_UNKNOWN)
dvander@371
   444
				{
dvander@400
   445
					GlobVersionInfo.source_engine = g_Metamod.GetSourceEngineBuild();
dvander@371
   446
				}
dvander@400
   447
dvander@407
   448
				/* Build path information */
dvander@407
   449
				char file_path[256];
dvander@407
   450
				size_t len = g_Metamod.PathFormat(file_path, sizeof(file_path), "%s", file);
dvander@407
   451
dvander@407
   452
				for (size_t i = len - 1; i >= 0 && i < len; i--)
dvander@407
   453
				{
dvander@407
   454
					if (_IsPathSepChar(file_path[i]))
dvander@407
   455
					{
dvander@407
   456
						file_path[i] = '\0';
dvander@407
   457
						break;
dvander@407
   458
					}
dvander@407
   459
				}
dvander@407
   460
dvander@407
   461
				MetamodLoaderInfo info;
dvander@407
   462
				info.pl_file = file;
dvander@407
   463
				info.pl_path = file_path;
dvander@407
   464
dvander@407
   465
				pl->m_API = fnLoad(&GlobVersionInfo, &info);
dvander@400
   466
				pl->m_UnloadFn = (METAMOD_FN_UNLOAD)dlsym(pl->m_Lib, "UnloadInterface_MMS");
dvander@371
   467
			}
dvander@400
   468
dvander@400
   469
			/**
dvander@400
   470
			 * If we didn't get anything, try the normal/simple interface.
dvander@400
   471
			 */
dvander@400
   472
			if (pl->m_API == NULL)
dvander@371
   473
			{
dvander@400
   474
				CreateInterfaceFn pfn = (CreateInterfaceFn)(dlsym(pl->m_Lib, PL_EXPOSURE_C));
dvander@400
   475
				if (!pfn)
dvander@371
   476
				{
dvander@371
   477
					if (error)
dvander@371
   478
					{
dvander@400
   479
						UTIL_Format(error, maxlen, "Function %s not found", PL_EXPOSURE_C);
dvander@371
   480
					}
dvander@371
   481
					pl->m_Status = Pl_Error;
dvander@371
   482
				}
dvander@371
   483
				else
dvander@371
   484
				{
dvander@400
   485
					pl->m_API = static_cast<ISmmPlugin *>((pfn)(METAMOD_PLAPI_NAME, NULL));
dvander@400
   486
dvander@400
   487
					if (!pl->m_API)
dvander@371
   488
					{
dvander@371
   489
						if (error)
dvander@371
   490
						{
dvander@400
   491
							UTIL_Format(error, maxlen, "Failed to get API");
dvander@371
   492
						}
dvander@371
   493
						pl->m_Status = Pl_Error;
dvander@371
   494
					}
dvander@400
   495
				}
dvander@400
   496
			}
dvander@400
   497
dvander@400
   498
			if (pl->m_API != NULL)
dvander@400
   499
			{
dvander@400
   500
				int api = pl->m_API->GetApiVersion();
dvander@400
   501
				if (api < PLAPI_MIN_VERSION)
dvander@400
   502
				{
dvander@400
   503
					if (error)
dvander@371
   504
					{
dvander@400
   505
						if (api == 13)
dvander@371
   506
						{
dvander@400
   507
							UTIL_Format(error, maxlen, "Plugin uses experimental Metamod build, probably 1.6.x (%d < %d)", api, PLAPI_MIN_VERSION);
dvander@400
   508
						}
dvander@400
   509
						else if (api <= 12 && api >= 7)
dvander@400
   510
						{
dvander@400
   511
							UTIL_Format(error, maxlen, "Older Metamod version required, probably 1.4.x (%d < %d)", api, PLAPI_MIN_VERSION);
dvander@371
   512
						}
dvander@371
   513
						else
dvander@371
   514
						{
dvander@400
   515
							UTIL_Format(error, maxlen, "Older Metamod version required, probably 1.0 (%d < %d)", api, PLAPI_MIN_VERSION);
dvander@371
   516
						}
dvander@371
   517
					}
dvander@400
   518
					pl->m_Status = Pl_Error;
dvander@400
   519
				}
dvander@400
   520
				else if (api > METAMOD_PLAPI_VERSION)
dvander@400
   521
				{
dvander@400
   522
					if (error)
dvander@400
   523
					{
dvander@400
   524
						UTIL_Format(error, maxlen, "Plugin requires newer Metamod version (%d > %d)", api, METAMOD_PLAPI_VERSION);
dvander@400
   525
					}
dvander@400
   526
					pl->m_Status = Pl_Error;
dvander@400
   527
				}
dvander@400
   528
				else
dvander@400
   529
				{
dvander@400
   530
					if (pl->m_API->Load(pl->m_Id, &g_Metamod, error, maxlen, m_AllLoaded))
dvander@400
   531
					{
dvander@400
   532
						pl->m_Status = Pl_Running;
dvander@400
   533
						if (m_AllLoaded)
dvander@400
   534
						{
dvander@400
   535
							pl->m_API->AllPluginsLoaded();
dvander@400
   536
						}
dvander@400
   537
					}
dvander@400
   538
					else
dvander@400
   539
					{
dvander@400
   540
						pl->m_Status = Pl_Refused;
dvander@400
   541
					}
dvander@371
   542
				}
dvander@371
   543
			}
dvander@371
   544
		}
dvander@371
   545
	}
dvander@371
   546
dvander@371
   547
	if (pl->m_Lib && (pl->m_Status < Pl_Paused))
dvander@371
   548
	{
dvander@371
   549
		pl->m_Events.clear();
dvander@371
   550
		g_SourceHook.UnloadPlugin(pl->m_Id);
dvander@371
   551
		UnregAllConCmds(pl);
dvander@371
   552
dvander@400
   553
		if (pl->m_UnloadFn != NULL)
dvander@400
   554
		{
dvander@400
   555
			pl->m_UnloadFn();
dvander@400
   556
		}
dvander@400
   557
dvander@371
   558
		dlclose(pl->m_Lib);
dvander@371
   559
		pl->m_Lib = NULL;
dvander@371
   560
		pl->m_API = NULL;
dvander@371
   561
	}
dvander@371
   562
dvander@371
   563
	return pl;
dvander@371
   564
}
dvander@371
   565
dvander@371
   566
bool CPluginManager::_Unload(CPluginManager::CPlugin *pl, bool force, char *error, size_t maxlen)
dvander@371
   567
{
dvander@371
   568
	if (error)
dvander@371
   569
	{
dvander@371
   570
		*error = '\0';
dvander@371
   571
	}
dvander@371
   572
dvander@371
   573
	if (pl->m_API && pl->m_Lib)
dvander@371
   574
	{
dvander@371
   575
		//Note, we'll always tell the plugin it will be unloading...
dvander@371
   576
		if (pl->m_API->Unload(error, maxlen) || force)
dvander@371
   577
		{
dvander@371
   578
			//Make sure to detach it from sourcehook!
dvander@371
   579
			g_SourceHook.UnloadPlugin(pl->m_Id);
dvander@371
   580
dvander@371
   581
			pl->m_Events.clear();
dvander@371
   582
dvander@371
   583
			UnregAllConCmds(pl);
dvander@371
   584
dvander@400
   585
			if (pl->m_UnloadFn != NULL)
dvander@400
   586
			{
dvander@400
   587
				pl->m_UnloadFn();
dvander@400
   588
			}
dvander@400
   589
dvander@371
   590
			//Clean up the DLL
dvander@371
   591
			dlclose(pl->m_Lib);
dvander@371
   592
			pl->m_Lib = NULL;
dvander@371
   593
			pl->m_API = NULL;
dvander@371
   594
dvander@371
   595
			//Remove the plugin from the list
dvander@371
   596
			PluginIter i;
dvander@371
   597
			for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
dvander@371
   598
			{
dvander@371
   599
				if ( (*i)->m_Id == pl->m_Id )
dvander@371
   600
				{
dvander@371
   601
					i = m_Plugins.erase(i);
dvander@371
   602
					break;
dvander@371
   603
				}
dvander@371
   604
			}
dvander@371
   605
			//Free its memory
dvander@371
   606
			delete pl;
dvander@371
   607
dvander@371
   608
			return true;
dvander@371
   609
		}
dvander@371
   610
	} else {
dvander@371
   611
		//The plugin is not valid, and let's just remove it from the list anyway
dvander@371
   612
		PluginIter i;
dvander@371
   613
		for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
dvander@371
   614
		{
dvander@371
   615
			if ( (*i)->m_Id == pl->m_Id )
dvander@371
   616
			{
dvander@371
   617
				i = m_Plugins.erase(i);
dvander@371
   618
				break;
dvander@371
   619
			}
dvander@371
   620
		}
dvander@371
   621
		delete pl;
dvander@371
   622
dvander@371
   623
		return true;
dvander@371
   624
	}
dvander@371
   625
dvander@371
   626
	return false;
dvander@371
   627
}
dvander@371
   628
dvander@371
   629
bool CPluginManager::_Pause(CPluginManager::CPlugin *pl, char *error, size_t maxlen)
dvander@371
   630
{
dvander@371
   631
	if (error)
dvander@371
   632
	{
dvander@371
   633
		*error = '\0';
dvander@371
   634
	}
dvander@371
   635
dvander@371
   636
	if (pl->m_Status != Pl_Running || !pl->m_API)
dvander@371
   637
	{
dvander@371
   638
		if (error)
dvander@371
   639
		{
dvander@371
   640
			UTIL_Format(error, maxlen, "Plugin cannot be paused");
dvander@371
   641
		}
dvander@371
   642
	}
dvander@371
   643
	else
dvander@371
   644
	{
dvander@371
   645
		if (pl->m_API->Pause(error, maxlen))
dvander@371
   646
		{
dvander@371
   647
			g_SourceHook.PausePlugin(pl->m_Id);
dvander@371
   648
			pl->m_Status = Pl_Paused;
dvander@371
   649
dvander@371
   650
			return true;
dvander@371
   651
		}
dvander@371
   652
	}
dvander@371
   653
dvander@371
   654
	return false;
dvander@371
   655
}
dvander@371
   656
dvander@371
   657
bool CPluginManager::_Unpause(CPluginManager::CPlugin *pl, char *error, size_t maxlen)
dvander@371
   658
{
dvander@371
   659
	if (error)
dvander@371
   660
	{
dvander@371
   661
		*error = '\0';
dvander@371
   662
	}
dvander@371
   663
dvander@371
   664
	if (pl->m_Status != Pl_Paused || !pl->m_API)
dvander@371
   665
	{
dvander@371
   666
		if (error)
dvander@371
   667
		{
dvander@371
   668
			UTIL_Format(error, maxlen, "Plugin cannot be unpaused");
dvander@371
   669
		}
dvander@371
   670
	}
dvander@371
   671
	else
dvander@371
   672
	{
dvander@371
   673
		if (pl->m_API->Unpause(error, maxlen))
dvander@371
   674
		{
dvander@371
   675
			g_SourceHook.UnpausePlugin(pl->m_Id);
dvander@371
   676
			pl->m_Status = Pl_Running;
dvander@371
   677
dvander@371
   678
			return true;
dvander@371
   679
		}
dvander@371
   680
	}
dvander@371
   681
dvander@371
   682
	return false;
dvander@371
   683
}
dvander@371
   684
dvander@371
   685
bool CPluginManager::UnloadAll()
dvander@371
   686
{
dvander@371
   687
	PluginIter i;
dvander@371
   688
dvander@371
   689
	char error[128];
dvander@371
   690
	bool status = true;
dvander@371
   691
dvander@371
   692
	while ((i = m_Plugins.begin()) != m_Plugins.end())
dvander@371
   693
	{
dvander@371
   694
		if ( !_Unload( (*i), true, error, sizeof(error)) )
dvander@371
   695
		{
dvander@371
   696
			status = false;
dvander@371
   697
		}
dvander@371
   698
	}
dvander@371
   699
dvander@371
   700
	return status;
dvander@371
   701
}
dvander@371
   702
dvander@397
   703
bool CPluginManager::Query(PluginId id, const char **file, Pl_Status *status, PluginId *source)
dvander@371
   704
{
dvander@371
   705
	CPlugin *pl = FindById(id);
dvander@371
   706
dvander@371
   707
	if (!pl)
dvander@371
   708
	{
dvander@371
   709
		return false;
dvander@371
   710
	}
dvander@371
   711
dvander@397
   712
	if (file != NULL)
dvander@397
   713
	{
dvander@397
   714
		*file = pl->m_File.c_str();
dvander@397
   715
	}
dvander@397
   716
dvander@397
   717
	if (status != NULL)
dvander@397
   718
	{
dvander@397
   719
		*status = pl->m_Status;
dvander@397
   720
	}
dvander@397
   721
dvander@397
   722
	if (source != NULL)
dvander@397
   723
	{
dvander@397
   724
		*source = pl->m_Source;
dvander@397
   725
	}
dvander@371
   726
dvander@371
   727
	return true;
dvander@371
   728
}
dvander@371
   729
dvander@371
   730
bool CPluginManager::QueryRunning(PluginId id, char *error, size_t maxlength)
dvander@371
   731
{
dvander@371
   732
	CPlugin *pl = FindById(id);
dvander@371
   733
dvander@371
   734
	if (!pl || !pl->m_API)
dvander@371
   735
	{
dvander@371
   736
		if (error)
dvander@371
   737
		{
dvander@371
   738
			UTIL_Format(error, maxlength, "Plugin not valid");
dvander@371
   739
		}
dvander@371
   740
		return false;
dvander@371
   741
	}
dvander@371
   742
dvander@371
   743
	return pl->m_API->QueryRunning(error, maxlength);
dvander@371
   744
}
dvander@371
   745
dvander@397
   746
bool CPluginManager::QueryHandle(PluginId id, void **handle)
dvander@371
   747
{
dvander@371
   748
	CPlugin *pl = FindById(id);
dvander@371
   749
dvander@371
   750
	if (!pl)
dvander@371
   751
	{
dvander@371
   752
		return false;
dvander@371
   753
	}
dvander@371
   754
dvander@397
   755
	if (handle)
dvander@397
   756
	{
dvander@397
   757
		*handle = static_cast<void *>(pl->m_Lib);
dvander@397
   758
	}
dvander@371
   759
dvander@371
   760
	return true;
dvander@371
   761
}
dvander@371
   762
dvander@371
   763
PluginIter CPluginManager::_begin()
dvander@371
   764
{
dvander@371
   765
	return m_Plugins.begin();
dvander@371
   766
}
dvander@371
   767
dvander@371
   768
PluginIter CPluginManager::_end()
dvander@371
   769
{
dvander@371
   770
	return m_Plugins.end();
dvander@371
   771
}
dvander@371
   772
dvander@371
   773
void CPluginManager::AddPluginCvar(ISmmPlugin *api, ConCommandBase *pCvar)
dvander@371
   774
{
dvander@371
   775
	CPlugin *pl = FindByAPI(api);
dvander@371
   776
dvander@371
   777
	if (!pl)
dvander@371
   778
	{
dvander@371
   779
		return;
dvander@371
   780
	}
dvander@371
   781
dvander@371
   782
	pl->m_Cvars.push_back(pCvar);
dvander@371
   783
}
dvander@371
   784
dvander@371
   785
void CPluginManager::AddPluginCmd(ISmmPlugin *api, ConCommandBase *pCmd)
dvander@371
   786
{
dvander@371
   787
	CPlugin *pl = FindByAPI(api);
dvander@371
   788
dvander@371
   789
	if (!pl)
dvander@371
   790
	{
dvander@371
   791
		return;
dvander@371
   792
	}
dvander@371
   793
dvander@371
   794
	pl->m_Cmds.push_back(pCmd);
dvander@371
   795
}
dvander@371
   796
dvander@371
   797
void CPluginManager::RemovePluginCvar(ISmmPlugin *api, ConCommandBase *pCvar)
dvander@371
   798
{
dvander@371
   799
	CPlugin *pl = FindByAPI(api);
dvander@371
   800
dvander@371
   801
	if (!pl)
dvander@371
   802
	{
dvander@371
   803
		return;
dvander@371
   804
	}
dvander@371
   805
dvander@371
   806
	pl->m_Cvars.remove(pCvar);
dvander@371
   807
}
dvander@371
   808
dvander@371
   809
void CPluginManager::RemovePluginCmd(ISmmPlugin *api, ConCommandBase *pCmd)
dvander@371
   810
{
dvander@371
   811
	CPlugin *pl = FindByAPI(api);
dvander@371
   812
dvander@371
   813
	if (!pl)
dvander@371
   814
	{
dvander@371
   815
		return;
dvander@371
   816
	}
dvander@371
   817
dvander@371
   818
	pl->m_Cmds.remove(pCmd);
dvander@371
   819
}
dvander@371
   820
dvander@371
   821
void CPluginManager::UnregAllConCmds(CPlugin *pl)
dvander@371
   822
{
dvander@371
   823
	SourceHook::List<ConCommandBase *>::iterator i;
dvander@371
   824
dvander@371
   825
	/* :TODO: */
dvander@371
   826
	for (i=pl->m_Cvars.begin(); i!=pl->m_Cvars.end(); i++)
dvander@371
   827
	{
dvander@371
   828
		g_Metamod.UnregisterConCommandBase(pl->m_Id, (*i) );
dvander@371
   829
	}
dvander@371
   830
	pl->m_Cvars.clear();
dvander@371
   831
dvander@371
   832
	for (i=pl->m_Cmds.begin(); i!=pl->m_Cmds.end(); i++)
dvander@371
   833
	{
dvander@371
   834
		g_Metamod.UnregisterConCommandBase(pl->m_Id, (*i) );
dvander@371
   835
	}
dvander@371
   836
	pl->m_Cmds.clear();
dvander@371
   837
}
dvander@371
   838