sourcemm/CPlugin.cpp
author David Anderson <dvander@alliedmods.net>
Mon Apr 18 18:26:40 2005 +0000 (2005-04-18)
changeset 19 774dd1f7210f
parent 18 8848d3ef28d8
child 29 10e6dc40505e
permissions -rw-r--r--
Ehh, retarded mistake
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@7
   145
CPluginManager::CPlugin *CPluginManager::_Load(const char *file, PluginId source, char *error, size_t maxlen)
dvander@7
   146
{
dvander@7
   147
	FILE *fp;
dvander@7
   148
	CPlugin *pl;
dvander@7
   149
dvander@7
   150
	pl = new CPlugin();
dvander@7
   151
	*error = '\0';
dvander@7
   152
	
dvander@7
   153
	//Add plugin to list
dvander@7
   154
	pl->m_Id = m_LastId;
dvander@7
   155
	pl->m_File.assign(file);
dvander@7
   156
	m_Plugins.push_back(pl);
dvander@7
   157
	m_LastId++;
dvander@7
   158
dvander@7
   159
	//Check if the file even exists
dvander@7
   160
	fp = fopen(file, "r");
dvander@7
   161
	if (!fp)
dvander@7
   162
	{
dvander@7
   163
		if (error)
dvander@7
   164
			snprintf(error, maxlen, "File not found: %s", file);
dvander@7
   165
		pl->m_Status = Pl_NotFound;
dvander@7
   166
	} else {
dvander@7
   167
		fclose(fp);
dvander@7
   168
		fp = NULL;
dvander@7
   169
		
dvander@7
   170
		//Load the file
dvander@7
   171
		pl->m_Lib = dlmount(file);
dvander@7
   172
		if (!pl->m_Lib)
dvander@7
   173
		{
dvander@7
   174
			if (error)
dvander@7
   175
				snprintf(error, maxlen, "%s", dlerror());
dvander@7
   176
			pl->m_Status = Pl_Error;
dvander@7
   177
		} else {
dvander@7
   178
			CreateInterfaceFn pfn = reinterpret_cast<CreateInterfaceFn>(dlsym(pl->m_Lib, PL_EXPOSURE_C));
dvander@7
   179
			if (!pfn)
dvander@7
   180
			{
dvander@7
   181
				if (error)
dvander@7
   182
					snprintf(error, maxlen, "Function %s not found", PL_EXPOSURE_C);
dvander@7
   183
				pl->m_Status = Pl_Error;
dvander@7
   184
			} else {
dvander@7
   185
				pl->m_API = static_cast<ISmmPlugin *>((pfn)(PLAPI_NAME, NULL));
dvander@7
   186
				if (!pl->m_API)
dvander@7
   187
				{
dvander@7
   188
					if (error)
dvander@7
   189
						snprintf(error, maxlen, "Failed to get API");
dvander@7
   190
					pl->m_Status = Pl_Error;
dvander@7
   191
				} else {
dvander@7
   192
					if (pl->m_API->GetApiVersion() < PLAPI_MIN_VERSION)
dvander@7
   193
					{
dvander@7
   194
						if (error)
dvander@7
   195
							snprintf(error, maxlen, "Plugin API %d is out of date with required minimum (%d)", pl->m_API->GetApiVersion(), PLAPI_MIN_VERSION);
dvander@7
   196
						pl->m_Status = Pl_Error;
dvander@7
   197
					} else {
dvander@7
   198
						if (pl->m_API->Load(pl->m_Id, static_cast<ISmmAPI *>(&g_SmmAPI), &(pl->fac_list), error, maxlen))
dvander@7
   199
						{
dvander@7
   200
							pl->m_Status = Pl_Running;
dvander@18
   201
							if (m_AllLoaded)
dvander@18
   202
							{
dvander@18
   203
								//API 004 is when we added this callback
dvander@18
   204
								if (pl->m_API->GetApiVersion() >= 4)
dvander@18
   205
									pl->m_API->AllPluginsLoaded();
dvander@18
   206
							}
dvander@7
   207
						} else {
dvander@7
   208
							pl->m_Status = Pl_Refused;
dvander@7
   209
						}
dvander@7
   210
					}
dvander@7
   211
				}
dvander@7
   212
			}
dvander@7
   213
		}
dvander@7
   214
	}
dvander@7
   215
dvander@7
   216
	if (pl->m_Lib && (pl->m_Status < Pl_Paused))
dvander@7
   217
	{
dvander@7
   218
		dlclose(pl->m_Lib);
dvander@7
   219
		pl->m_Lib = NULL;
dvander@7
   220
		pl->m_API = NULL;
dvander@7
   221
	}
dvander@7
   222
dvander@7
   223
	return pl;
dvander@7
   224
}
dvander@7
   225
dvander@9
   226
bool CPluginManager::_Unload(CPluginManager::CPlugin *pl, bool force, char *error, size_t maxlen)
dvander@7
   227
{
dvander@7
   228
	if (error)
dvander@7
   229
		*error = '\0';
dvander@7
   230
	if (pl->m_API && pl->m_Lib)
dvander@7
   231
	{
dvander@9
   232
		//Note, we'll always tell the plugin it will be unloading...
dvander@9
   233
		if (pl->m_API->Unload(error, maxlen) || force)
dvander@7
   234
		{
dvander@9
   235
			//Make sure to detach it from sourcehook!
dvander@9
   236
			g_SourceHook.UnloadPlugin(pl->m_Id);
dvander@9
   237
dvander@9
   238
			//Clean up the DLL
dvander@7
   239
			dlclose(pl->m_Lib);
dvander@7
   240
			pl->m_Lib = NULL;
dvander@7
   241
			pl->m_API = NULL;
dvander@7
   242
dvander@7
   243
			//Remove the plugin from the list
dvander@7
   244
			PluginIter i;
dvander@7
   245
			for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
dvander@7
   246
			{
dvander@7
   247
				if ( (*i)->m_Id == pl->m_Id )
dvander@7
   248
				{
dvander@7
   249
					i = m_Plugins.erase(i);
dvander@7
   250
					break;
dvander@7
   251
				}
dvander@7
   252
			}
dvander@9
   253
			//Free its memory
dvander@7
   254
			delete pl;
dvander@7
   255
dvander@7
   256
			return true;
dvander@7
   257
		}
dvander@7
   258
	} else {
dvander@7
   259
		//The plugin is not valid, and let's just remove it from the list anyway
dvander@7
   260
		PluginIter i;
dvander@7
   261
		for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
dvander@7
   262
		{
dvander@7
   263
			if ( (*i)->m_Id == pl->m_Id )
dvander@7
   264
			{
dvander@7
   265
				i = m_Plugins.erase(i);
dvander@7
   266
				break;
dvander@7
   267
			}
dvander@7
   268
		}
dvander@7
   269
		delete pl;
dvander@7
   270
dvander@7
   271
		return true;
dvander@7
   272
	}
dvander@7
   273
dvander@7
   274
	return false;
dvander@7
   275
}
dvander@7
   276
dvander@7
   277
bool CPluginManager::_Pause(CPluginManager::CPlugin *pl, char *error, size_t maxlen)
dvander@7
   278
{
dvander@7
   279
	if (error)
dvander@7
   280
		*error = '\0';
dvander@7
   281
	if (pl->m_Status != Pl_Running || !pl->m_API)
dvander@7
   282
	{
dvander@7
   283
		if (error)
dvander@7
   284
			snprintf(error, maxlen, "Plugin cannot be paused");
dvander@7
   285
	} else {
dvander@9
   286
		if (pl->m_API->Pause(error, maxlen))
dvander@9
   287
		{
dvander@9
   288
			g_SourceHook.PausePlugin(pl->m_Id);
dvander@12
   289
			pl->m_Status = Pl_Paused;
dvander@12
   290
dvander@12
   291
			return true;
dvander@9
   292
		}
dvander@7
   293
	}
dvander@7
   294
dvander@7
   295
	return false;
dvander@7
   296
}
dvander@7
   297
dvander@7
   298
bool CPluginManager::_Unpause(CPluginManager::CPlugin *pl, char *error, size_t maxlen)
dvander@7
   299
{
dvander@7
   300
	if (error)
dvander@7
   301
		*error = '\0';
dvander@7
   302
dvander@7
   303
	if (pl->m_Status != Pl_Paused || !pl->m_API)
dvander@7
   304
	{
dvander@7
   305
		if (error)
dvander@7
   306
			snprintf(error, maxlen, "Plugin cannot be unpaused");
dvander@7
   307
	} else {
dvander@9
   308
		if (pl->m_API->Unpause(error, maxlen))
dvander@9
   309
		{
dvander@9
   310
			g_SourceHook.UnpausePlugin(pl->m_Id);
dvander@12
   311
			pl->m_Status = Pl_Running;
dvander@12
   312
dvander@12
   313
			return true;
dvander@9
   314
		}
dvander@7
   315
	}
dvander@7
   316
dvander@7
   317
	return false;
dvander@7
   318
}
dvander@7
   319
dvander@7
   320
bool CPluginManager::UnloadAll()
dvander@7
   321
{
dvander@7
   322
	PluginIter i;
dvander@7
   323
	bool status = true;
dvander@7
   324
dvander@7
   325
	for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
dvander@7
   326
	{
dvander@7
   327
		if ( (*i) )
dvander@7
   328
		{
dvander@7
   329
			if ( (*i)->m_API )
dvander@7
   330
			{
dvander@7
   331
				if ( (*i)->m_API->Unload(NULL, 0) )
dvander@7
   332
					status = false;
dvander@7
   333
dvander@9
   334
				//Unlink from SourceHook
dvander@9
   335
				g_SourceHook.UnloadPlugin( (*i)->m_Id );
dvander@9
   336
dvander@9
   337
				//Free the DLL
dvander@7
   338
				dlclose( (*i)->m_Lib );
dvander@7
   339
			}
dvander@7
   340
			delete (*i);
dvander@7
   341
		}
dvander@7
   342
dvander@7
   343
		i = m_Plugins.erase(i);
dvander@7
   344
	}
dvander@7
   345
dvander@7
   346
	return status;
dvander@7
   347
}
dvander@7
   348
dvander@7
   349
bool CPluginManager::Query(PluginId id, const char *&file, factories *&list, Pl_Status &status, PluginId &source)
dvander@7
   350
{
dvander@7
   351
	CPlugin *pl = FindById(id);
dvander@7
   352
dvander@7
   353
	if (!pl)
dvander@7
   354
		return false;
dvander@7
   355
dvander@7
   356
	file = pl->m_File.c_str();
dvander@7
   357
	list = &(pl->fac_list);
dvander@7
   358
	status = pl->m_Status;
dvander@7
   359
	source = pl->m_Source;
dvander@7
   360
dvander@7
   361
	return true;
dvander@7
   362
}
dvander@7
   363
dvander@7
   364
PluginIter CPluginManager::_begin()
dvander@7
   365
{
dvander@7
   366
	return m_Plugins.begin();
dvander@7
   367
}
dvander@7
   368
dvander@7
   369
PluginIter CPluginManager::_end()
dvander@7
   370
{
dvander@7
   371
	return m_Plugins.end();
dvander@7
   372
}