sourcemm/CPlugin.cpp
author David Anderson <dvander@alliedmods.net>
Tue Apr 19 07:41:07 2005 +0000 (2005-04-19)
changeset 29 10e6dc40505e
parent 19 774dd1f7210f
child 51 7985801b5b42
permissions -rw-r--r--
Fixed retry command
Fixed ids starting at 3 (changed Pl_MinId)
Doxyfile is no longer subdir based
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@18
    27
	m_AllLoaded = false;
dvander@7
    28
}
dvander@7
    29
dvander@7
    30
CPluginManager::~CPluginManager()
dvander@7
    31
{
dvander@7
    32
	if (m_Plugins.size())
dvander@7
    33
	{
dvander@7
    34
		UnloadAll();
dvander@7
    35
		m_Plugins.clear();
dvander@7
    36
	}
dvander@7
    37
}
dvander@7
    38
dvander@7
    39
CPluginManager::CPlugin::CPlugin() : m_Lib(NULL), m_API(NULL), m_Id(0), m_Source(0)
dvander@7
    40
{
dvander@9
    41
	memset(&fac_list, 0, sizeof(factories));
dvander@7
    42
}
dvander@7
    43
dvander@7
    44
PluginId CPluginManager::Load(const char *file, PluginId source, bool &already, char *error, size_t maxlen)
dvander@7
    45
{
dvander@7
    46
	PluginIter i;
dvander@7
    47
dvander@7
    48
	already = false;
dvander@7
    49
	//Check if we're about to reload an old plugin
dvander@7
    50
	for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
dvander@7
    51
	{
dvander@7
    52
		if ( (*i) && (*i)->m_File.compare(file)==0 )
dvander@7
    53
		{
dvander@7
    54
			if ( (*i)->m_Status < Pl_Paused )
dvander@7
    55
			{
dvander@7
    56
				//Attempt to load the plugin again
dvander@7
    57
				already = true;
dvander@7
    58
				i = m_Plugins.erase(i);
dvander@7
    59
			} else {
dvander@7
    60
				//No need to load it
dvander@7
    61
				already = true;
dvander@7
    62
				return (*i)->m_Id;
dvander@7
    63
			}
dvander@7
    64
		}
dvander@7
    65
	}
dvander@7
    66
dvander@7
    67
	CPlugin *pl = _Load(file, source, error, maxlen);
dvander@7
    68
dvander@7
    69
	if (!pl)
dvander@7
    70
		return Pl_BadLoad;
dvander@7
    71
dvander@7
    72
	return pl->m_Id;
dvander@7
    73
}
dvander@7
    74
dvander@7
    75
CPluginManager::CPlugin *CPluginManager::FindById(PluginId id)
dvander@7
    76
{
dvander@7
    77
	PluginIter i;
dvander@7
    78
dvander@7
    79
	for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
dvander@7
    80
	{
dvander@7
    81
		if ( (*i)->m_Id == id )
dvander@7
    82
			return (*i);
dvander@7
    83
	}
dvander@7
    84
dvander@7
    85
	return NULL;
dvander@7
    86
}
dvander@7
    87
dvander@18
    88
void CPluginManager::SetAllLoaded()
dvander@18
    89
{
dvander@18
    90
	m_AllLoaded = true;
dvander@18
    91
	PluginIter i;
dvander@18
    92
dvander@18
    93
	for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
dvander@18
    94
	{
dvander@18
    95
		if ( (*i) && (*i)->m_Status == Pl_Running && (*i)->m_API )
dvander@18
    96
		{
dvander@18
    97
			//004 is when we added this callback
dvander@19
    98
			if ( (*i)->m_API->GetApiVersion() >= 004 )
dvander@18
    99
			{
dvander@18
   100
				(*i)->m_API->AllPluginsLoaded();
dvander@18
   101
			}
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@7
   188
CPluginManager::CPlugin *CPluginManager::_Load(const char *file, PluginId source, char *error, size_t maxlen)
dvander@7
   189
{
dvander@7
   190
	FILE *fp;
dvander@7
   191
	CPlugin *pl;
dvander@7
   192
dvander@7
   193
	pl = new CPlugin();
dvander@7
   194
	*error = '\0';
dvander@7
   195
	
dvander@7
   196
	//Add plugin to list
dvander@7
   197
	pl->m_Id = m_LastId;
dvander@7
   198
	pl->m_File.assign(file);
dvander@7
   199
	m_Plugins.push_back(pl);
dvander@7
   200
	m_LastId++;
dvander@7
   201
dvander@7
   202
	//Check if the file even exists
dvander@7
   203
	fp = fopen(file, "r");
dvander@7
   204
	if (!fp)
dvander@7
   205
	{
dvander@7
   206
		if (error)
dvander@7
   207
			snprintf(error, maxlen, "File not found: %s", file);
dvander@7
   208
		pl->m_Status = Pl_NotFound;
dvander@7
   209
	} else {
dvander@7
   210
		fclose(fp);
dvander@7
   211
		fp = NULL;
dvander@7
   212
		
dvander@7
   213
		//Load the file
dvander@7
   214
		pl->m_Lib = dlmount(file);
dvander@7
   215
		if (!pl->m_Lib)
dvander@7
   216
		{
dvander@7
   217
			if (error)
dvander@7
   218
				snprintf(error, maxlen, "%s", dlerror());
dvander@7
   219
			pl->m_Status = Pl_Error;
dvander@7
   220
		} else {
dvander@7
   221
			CreateInterfaceFn pfn = reinterpret_cast<CreateInterfaceFn>(dlsym(pl->m_Lib, PL_EXPOSURE_C));
dvander@7
   222
			if (!pfn)
dvander@7
   223
			{
dvander@7
   224
				if (error)
dvander@7
   225
					snprintf(error, maxlen, "Function %s not found", PL_EXPOSURE_C);
dvander@7
   226
				pl->m_Status = Pl_Error;
dvander@7
   227
			} else {
dvander@7
   228
				pl->m_API = static_cast<ISmmPlugin *>((pfn)(PLAPI_NAME, NULL));
dvander@7
   229
				if (!pl->m_API)
dvander@7
   230
				{
dvander@7
   231
					if (error)
dvander@7
   232
						snprintf(error, maxlen, "Failed to get API");
dvander@7
   233
					pl->m_Status = Pl_Error;
dvander@7
   234
				} else {
dvander@7
   235
					if (pl->m_API->GetApiVersion() < PLAPI_MIN_VERSION)
dvander@7
   236
					{
dvander@7
   237
						if (error)
dvander@7
   238
							snprintf(error, maxlen, "Plugin API %d is out of date with required minimum (%d)", pl->m_API->GetApiVersion(), PLAPI_MIN_VERSION);
dvander@7
   239
						pl->m_Status = Pl_Error;
dvander@7
   240
					} else {
dvander@7
   241
						if (pl->m_API->Load(pl->m_Id, static_cast<ISmmAPI *>(&g_SmmAPI), &(pl->fac_list), error, maxlen))
dvander@7
   242
						{
dvander@7
   243
							pl->m_Status = Pl_Running;
dvander@18
   244
							if (m_AllLoaded)
dvander@18
   245
							{
dvander@18
   246
								//API 004 is when we added this callback
dvander@18
   247
								if (pl->m_API->GetApiVersion() >= 4)
dvander@18
   248
									pl->m_API->AllPluginsLoaded();
dvander@18
   249
							}
dvander@7
   250
						} else {
dvander@7
   251
							pl->m_Status = Pl_Refused;
dvander@7
   252
						}
dvander@7
   253
					}
dvander@7
   254
				}
dvander@7
   255
			}
dvander@7
   256
		}
dvander@7
   257
	}
dvander@7
   258
dvander@7
   259
	if (pl->m_Lib && (pl->m_Status < Pl_Paused))
dvander@7
   260
	{
dvander@7
   261
		dlclose(pl->m_Lib);
dvander@7
   262
		pl->m_Lib = NULL;
dvander@7
   263
		pl->m_API = NULL;
dvander@7
   264
	}
dvander@7
   265
dvander@7
   266
	return pl;
dvander@7
   267
}
dvander@7
   268
dvander@9
   269
bool CPluginManager::_Unload(CPluginManager::CPlugin *pl, bool force, char *error, size_t maxlen)
dvander@7
   270
{
dvander@7
   271
	if (error)
dvander@7
   272
		*error = '\0';
dvander@7
   273
	if (pl->m_API && pl->m_Lib)
dvander@7
   274
	{
dvander@9
   275
		//Note, we'll always tell the plugin it will be unloading...
dvander@9
   276
		if (pl->m_API->Unload(error, maxlen) || force)
dvander@7
   277
		{
dvander@9
   278
			//Make sure to detach it from sourcehook!
dvander@9
   279
			g_SourceHook.UnloadPlugin(pl->m_Id);
dvander@9
   280
dvander@9
   281
			//Clean up the DLL
dvander@7
   282
			dlclose(pl->m_Lib);
dvander@7
   283
			pl->m_Lib = NULL;
dvander@7
   284
			pl->m_API = NULL;
dvander@7
   285
dvander@7
   286
			//Remove the plugin from the list
dvander@7
   287
			PluginIter i;
dvander@7
   288
			for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
dvander@7
   289
			{
dvander@7
   290
				if ( (*i)->m_Id == pl->m_Id )
dvander@7
   291
				{
dvander@7
   292
					i = m_Plugins.erase(i);
dvander@7
   293
					break;
dvander@7
   294
				}
dvander@7
   295
			}
dvander@9
   296
			//Free its memory
dvander@7
   297
			delete pl;
dvander@7
   298
dvander@7
   299
			return true;
dvander@7
   300
		}
dvander@7
   301
	} else {
dvander@7
   302
		//The plugin is not valid, and let's just remove it from the list anyway
dvander@7
   303
		PluginIter i;
dvander@7
   304
		for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
dvander@7
   305
		{
dvander@7
   306
			if ( (*i)->m_Id == pl->m_Id )
dvander@7
   307
			{
dvander@7
   308
				i = m_Plugins.erase(i);
dvander@7
   309
				break;
dvander@7
   310
			}
dvander@7
   311
		}
dvander@7
   312
		delete pl;
dvander@7
   313
dvander@7
   314
		return true;
dvander@7
   315
	}
dvander@7
   316
dvander@7
   317
	return false;
dvander@7
   318
}
dvander@7
   319
dvander@7
   320
bool CPluginManager::_Pause(CPluginManager::CPlugin *pl, char *error, size_t maxlen)
dvander@7
   321
{
dvander@7
   322
	if (error)
dvander@7
   323
		*error = '\0';
dvander@7
   324
	if (pl->m_Status != Pl_Running || !pl->m_API)
dvander@7
   325
	{
dvander@7
   326
		if (error)
dvander@7
   327
			snprintf(error, maxlen, "Plugin cannot be paused");
dvander@7
   328
	} else {
dvander@9
   329
		if (pl->m_API->Pause(error, maxlen))
dvander@9
   330
		{
dvander@9
   331
			g_SourceHook.PausePlugin(pl->m_Id);
dvander@12
   332
			pl->m_Status = Pl_Paused;
dvander@12
   333
dvander@12
   334
			return true;
dvander@9
   335
		}
dvander@7
   336
	}
dvander@7
   337
dvander@7
   338
	return false;
dvander@7
   339
}
dvander@7
   340
dvander@7
   341
bool CPluginManager::_Unpause(CPluginManager::CPlugin *pl, char *error, size_t maxlen)
dvander@7
   342
{
dvander@7
   343
	if (error)
dvander@7
   344
		*error = '\0';
dvander@7
   345
dvander@7
   346
	if (pl->m_Status != Pl_Paused || !pl->m_API)
dvander@7
   347
	{
dvander@7
   348
		if (error)
dvander@7
   349
			snprintf(error, maxlen, "Plugin cannot be unpaused");
dvander@7
   350
	} else {
dvander@9
   351
		if (pl->m_API->Unpause(error, maxlen))
dvander@9
   352
		{
dvander@9
   353
			g_SourceHook.UnpausePlugin(pl->m_Id);
dvander@12
   354
			pl->m_Status = Pl_Running;
dvander@12
   355
dvander@12
   356
			return true;
dvander@9
   357
		}
dvander@7
   358
	}
dvander@7
   359
dvander@7
   360
	return false;
dvander@7
   361
}
dvander@7
   362
dvander@7
   363
bool CPluginManager::UnloadAll()
dvander@7
   364
{
dvander@7
   365
	PluginIter i;
dvander@7
   366
	bool status = true;
dvander@7
   367
dvander@7
   368
	for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
dvander@7
   369
	{
dvander@7
   370
		if ( (*i) )
dvander@7
   371
		{
dvander@7
   372
			if ( (*i)->m_API )
dvander@7
   373
			{
dvander@7
   374
				if ( (*i)->m_API->Unload(NULL, 0) )
dvander@7
   375
					status = false;
dvander@7
   376
dvander@9
   377
				//Unlink from SourceHook
dvander@9
   378
				g_SourceHook.UnloadPlugin( (*i)->m_Id );
dvander@9
   379
dvander@9
   380
				//Free the DLL
dvander@7
   381
				dlclose( (*i)->m_Lib );
dvander@7
   382
			}
dvander@7
   383
			delete (*i);
dvander@7
   384
		}
dvander@7
   385
dvander@7
   386
		i = m_Plugins.erase(i);
dvander@7
   387
	}
dvander@7
   388
dvander@7
   389
	return status;
dvander@7
   390
}
dvander@7
   391
dvander@7
   392
bool CPluginManager::Query(PluginId id, const char *&file, factories *&list, Pl_Status &status, PluginId &source)
dvander@7
   393
{
dvander@7
   394
	CPlugin *pl = FindById(id);
dvander@7
   395
dvander@7
   396
	if (!pl)
dvander@7
   397
		return false;
dvander@7
   398
dvander@7
   399
	file = pl->m_File.c_str();
dvander@7
   400
	list = &(pl->fac_list);
dvander@7
   401
	status = pl->m_Status;
dvander@7
   402
	source = pl->m_Source;
dvander@7
   403
dvander@7
   404
	return true;
dvander@7
   405
}
dvander@7
   406
dvander@7
   407
PluginIter CPluginManager::_begin()
dvander@7
   408
{
dvander@7
   409
	return m_Plugins.begin();
dvander@7
   410
}
dvander@7
   411
dvander@7
   412
PluginIter CPluginManager::_end()
dvander@7
   413
{
dvander@7
   414
	return m_Plugins.end();
dvander@7
   415
}