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