|
dvander@7
|
1 |
/* ======== SourceMM ======== |
|
dvander@7
|
2 |
* Copyright (C) 2004-2005 SourceMM 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@7
|
12 |
#include "CISmmAPI.h" |
|
dvander@7
|
13 |
|
|
dvander@7
|
14 |
/** |
|
dvander@7
|
15 |
* @brief Implements functions from CPlugin.h |
|
dvander@7
|
16 |
* @file CPlugin.cpp |
|
dvander@7
|
17 |
*/ |
|
dvander@7
|
18 |
|
|
dvander@7
|
19 |
using namespace SourceMM; |
|
dvander@7
|
20 |
|
|
dvander@7
|
21 |
CPluginManager g_PluginMngr; |
|
dvander@7
|
22 |
|
|
dvander@7
|
23 |
CPluginManager::CPluginManager() |
|
dvander@7
|
24 |
{ |
|
dvander@7
|
25 |
m_LastId = Pl_MinId; |
|
dvander@7
|
26 |
} |
|
dvander@7
|
27 |
|
|
dvander@7
|
28 |
CPluginManager::~CPluginManager() |
|
dvander@7
|
29 |
{ |
|
dvander@7
|
30 |
if (m_Plugins.size()) |
|
dvander@7
|
31 |
{ |
|
dvander@7
|
32 |
UnloadAll(); |
|
dvander@7
|
33 |
m_Plugins.clear(); |
|
dvander@7
|
34 |
} |
|
dvander@7
|
35 |
} |
|
dvander@7
|
36 |
|
|
dvander@7
|
37 |
CPluginManager::CPlugin::CPlugin() : m_Lib(NULL), m_API(NULL), m_Id(0), m_Source(0) |
|
dvander@7
|
38 |
{ |
|
dvander@7
|
39 |
} |
|
dvander@7
|
40 |
|
|
dvander@7
|
41 |
PluginId CPluginManager::Load(const char *file, PluginId source, bool &already, char *error, size_t maxlen) |
|
dvander@7
|
42 |
{ |
|
dvander@7
|
43 |
PluginIter i; |
|
dvander@7
|
44 |
|
|
dvander@7
|
45 |
already = false; |
|
dvander@7
|
46 |
//Check if we're about to reload an old plugin |
|
dvander@7
|
47 |
for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++) |
|
dvander@7
|
48 |
{ |
|
dvander@7
|
49 |
if ( (*i) && (*i)->m_File.compare(file)==0 ) |
|
dvander@7
|
50 |
{ |
|
dvander@7
|
51 |
if ( (*i)->m_Status < Pl_Paused ) |
|
dvander@7
|
52 |
{ |
|
dvander@7
|
53 |
//Attempt to load the plugin again |
|
dvander@7
|
54 |
already = true; |
|
dvander@7
|
55 |
i = m_Plugins.erase(i); |
|
dvander@7
|
56 |
} else { |
|
dvander@7
|
57 |
//No need to load it |
|
dvander@7
|
58 |
already = true; |
|
dvander@7
|
59 |
return (*i)->m_Id; |
|
dvander@7
|
60 |
} |
|
dvander@7
|
61 |
} |
|
dvander@7
|
62 |
} |
|
dvander@7
|
63 |
|
|
dvander@7
|
64 |
CPlugin *pl = _Load(file, source, error, maxlen); |
|
dvander@7
|
65 |
|
|
dvander@7
|
66 |
if (!pl) |
|
dvander@7
|
67 |
return Pl_BadLoad; |
|
dvander@7
|
68 |
|
|
dvander@7
|
69 |
return pl->m_Id; |
|
dvander@7
|
70 |
} |
|
dvander@7
|
71 |
|
|
dvander@7
|
72 |
CPluginManager::CPlugin *CPluginManager::FindById(PluginId id) |
|
dvander@7
|
73 |
{ |
|
dvander@7
|
74 |
PluginIter i; |
|
dvander@7
|
75 |
|
|
dvander@7
|
76 |
for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++) |
|
dvander@7
|
77 |
{ |
|
dvander@7
|
78 |
if ( (*i)->m_Id == id ) |
|
dvander@7
|
79 |
return (*i); |
|
dvander@7
|
80 |
} |
|
dvander@7
|
81 |
|
|
dvander@7
|
82 |
return NULL; |
|
dvander@7
|
83 |
} |
|
dvander@7
|
84 |
|
|
dvander@7
|
85 |
bool CPluginManager::Pause(PluginId id, char *error, size_t maxlen) |
|
dvander@7
|
86 |
{ |
|
dvander@7
|
87 |
CPlugin *pl = FindById(id); |
|
dvander@7
|
88 |
|
|
dvander@7
|
89 |
if (!pl) |
|
dvander@7
|
90 |
{ |
|
dvander@7
|
91 |
snprintf(error, maxlen, "Plugin id not found"); |
|
dvander@7
|
92 |
return false; |
|
dvander@7
|
93 |
} |
|
dvander@7
|
94 |
|
|
dvander@7
|
95 |
return _Pause(pl, error, maxlen); |
|
dvander@7
|
96 |
} |
|
dvander@7
|
97 |
|
|
dvander@7
|
98 |
bool CPluginManager::Unpause(PluginId id, char *error, size_t maxlen) |
|
dvander@7
|
99 |
{ |
|
dvander@7
|
100 |
CPlugin *pl = FindById(id); |
|
dvander@7
|
101 |
|
|
dvander@7
|
102 |
if (!pl) |
|
dvander@7
|
103 |
{ |
|
dvander@7
|
104 |
snprintf(error, maxlen, "Plugin id not found"); |
|
dvander@7
|
105 |
return false; |
|
dvander@7
|
106 |
} |
|
dvander@7
|
107 |
|
|
dvander@7
|
108 |
return _Unpause(pl, error, maxlen); |
|
dvander@7
|
109 |
} |
|
dvander@7
|
110 |
|
|
dvander@7
|
111 |
bool CPluginManager::Unload(PluginId id, char *error, size_t maxlen) |
|
dvander@7
|
112 |
{ |
|
dvander@7
|
113 |
CPlugin *pl = FindById(id); |
|
dvander@7
|
114 |
|
|
dvander@7
|
115 |
if (!pl) |
|
dvander@7
|
116 |
{ |
|
dvander@7
|
117 |
snprintf(error, maxlen, "Plugin id not found"); |
|
dvander@7
|
118 |
return false; |
|
dvander@7
|
119 |
} |
|
dvander@7
|
120 |
|
|
dvander@7
|
121 |
return _Unload(pl, error, maxlen); |
|
dvander@7
|
122 |
} |
|
dvander@7
|
123 |
|
|
dvander@7
|
124 |
CPluginManager::CPlugin *CPluginManager::_Load(const char *file, PluginId source, char *error, size_t maxlen) |
|
dvander@7
|
125 |
{ |
|
dvander@7
|
126 |
FILE *fp; |
|
dvander@7
|
127 |
CPlugin *pl; |
|
dvander@7
|
128 |
|
|
dvander@7
|
129 |
pl = new CPlugin(); |
|
dvander@7
|
130 |
*error = '\0'; |
|
dvander@7
|
131 |
|
|
dvander@7
|
132 |
//Add plugin to list |
|
dvander@7
|
133 |
pl->m_Id = m_LastId; |
|
dvander@7
|
134 |
pl->m_File.assign(file); |
|
dvander@7
|
135 |
m_Plugins.push_back(pl); |
|
dvander@7
|
136 |
m_LastId++; |
|
dvander@7
|
137 |
|
|
dvander@7
|
138 |
//Check if the file even exists |
|
dvander@7
|
139 |
fp = fopen(file, "r"); |
|
dvander@7
|
140 |
if (!fp) |
|
dvander@7
|
141 |
{ |
|
dvander@7
|
142 |
if (error) |
|
dvander@7
|
143 |
snprintf(error, maxlen, "File not found: %s", file); |
|
dvander@7
|
144 |
pl->m_Status = Pl_NotFound; |
|
dvander@7
|
145 |
} else { |
|
dvander@7
|
146 |
fclose(fp); |
|
dvander@7
|
147 |
fp = NULL; |
|
dvander@7
|
148 |
|
|
dvander@7
|
149 |
//Load the file |
|
dvander@7
|
150 |
pl->m_Lib = dlmount(file); |
|
dvander@7
|
151 |
if (!pl->m_Lib) |
|
dvander@7
|
152 |
{ |
|
dvander@7
|
153 |
if (error) |
|
dvander@7
|
154 |
snprintf(error, maxlen, "%s", dlerror()); |
|
dvander@7
|
155 |
pl->m_Status = Pl_Error; |
|
dvander@7
|
156 |
} else { |
|
dvander@7
|
157 |
CreateInterfaceFn pfn = reinterpret_cast<CreateInterfaceFn>(dlsym(pl->m_Lib, PL_EXPOSURE_C)); |
|
dvander@7
|
158 |
if (!pfn) |
|
dvander@7
|
159 |
{ |
|
dvander@7
|
160 |
if (error) |
|
dvander@7
|
161 |
snprintf(error, maxlen, "Function %s not found", PL_EXPOSURE_C); |
|
dvander@7
|
162 |
pl->m_Status = Pl_Error; |
|
dvander@7
|
163 |
} else { |
|
dvander@7
|
164 |
pl->m_API = static_cast<ISmmPlugin *>((pfn)(PLAPI_NAME, NULL)); |
|
dvander@7
|
165 |
if (!pl->m_API) |
|
dvander@7
|
166 |
{ |
|
dvander@7
|
167 |
if (error) |
|
dvander@7
|
168 |
snprintf(error, maxlen, "Failed to get API"); |
|
dvander@7
|
169 |
pl->m_Status = Pl_Error; |
|
dvander@7
|
170 |
} else { |
|
dvander@7
|
171 |
if (pl->m_API->GetApiVersion() < PLAPI_MIN_VERSION) |
|
dvander@7
|
172 |
{ |
|
dvander@7
|
173 |
if (error) |
|
dvander@7
|
174 |
snprintf(error, maxlen, "Plugin API %d is out of date with required minimum (%d)", pl->m_API->GetApiVersion(), PLAPI_MIN_VERSION); |
|
dvander@7
|
175 |
pl->m_Status = Pl_Error; |
|
dvander@7
|
176 |
} else { |
|
dvander@7
|
177 |
if (pl->m_API->Load(pl->m_Id, static_cast<ISmmAPI *>(&g_SmmAPI), &(pl->fac_list), error, maxlen)) |
|
dvander@7
|
178 |
{ |
|
dvander@7
|
179 |
pl->m_Status = Pl_Running; |
|
dvander@7
|
180 |
} else { |
|
dvander@7
|
181 |
pl->m_Status = Pl_Refused; |
|
dvander@7
|
182 |
} |
|
dvander@7
|
183 |
} |
|
dvander@7
|
184 |
} |
|
dvander@7
|
185 |
} |
|
dvander@7
|
186 |
} |
|
dvander@7
|
187 |
} |
|
dvander@7
|
188 |
|
|
dvander@7
|
189 |
if (pl->m_Lib && (pl->m_Status < Pl_Paused)) |
|
dvander@7
|
190 |
{ |
|
dvander@7
|
191 |
dlclose(pl->m_Lib); |
|
dvander@7
|
192 |
pl->m_Lib = NULL; |
|
dvander@7
|
193 |
pl->m_API = NULL; |
|
dvander@7
|
194 |
} |
|
dvander@7
|
195 |
|
|
dvander@7
|
196 |
return pl; |
|
dvander@7
|
197 |
} |
|
dvander@7
|
198 |
|
|
dvander@7
|
199 |
bool CPluginManager::_Unload(CPluginManager::CPlugin *pl, char *error, size_t maxlen) |
|
dvander@7
|
200 |
{ |
|
dvander@7
|
201 |
if (error) |
|
dvander@7
|
202 |
*error = '\0'; |
|
dvander@7
|
203 |
if (pl->m_API && pl->m_Lib) |
|
dvander@7
|
204 |
{ |
|
dvander@7
|
205 |
if (pl->m_API->Unload(error, maxlen)) |
|
dvander@7
|
206 |
{ |
|
dvander@7
|
207 |
dlclose(pl->m_Lib); |
|
dvander@7
|
208 |
pl->m_Lib = NULL; |
|
dvander@7
|
209 |
pl->m_API = NULL; |
|
dvander@7
|
210 |
|
|
dvander@7
|
211 |
//Remove the plugin from the list |
|
dvander@7
|
212 |
PluginIter i; |
|
dvander@7
|
213 |
for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++) |
|
dvander@7
|
214 |
{ |
|
dvander@7
|
215 |
if ( (*i)->m_Id == pl->m_Id ) |
|
dvander@7
|
216 |
{ |
|
dvander@7
|
217 |
i = m_Plugins.erase(i); |
|
dvander@7
|
218 |
break; |
|
dvander@7
|
219 |
} |
|
dvander@7
|
220 |
} |
|
dvander@7
|
221 |
delete pl; |
|
dvander@7
|
222 |
|
|
dvander@7
|
223 |
return true; |
|
dvander@7
|
224 |
} |
|
dvander@7
|
225 |
} else { |
|
dvander@7
|
226 |
//The plugin is not valid, and let's just remove it from the list anyway |
|
dvander@7
|
227 |
PluginIter i; |
|
dvander@7
|
228 |
for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++) |
|
dvander@7
|
229 |
{ |
|
dvander@7
|
230 |
if ( (*i)->m_Id == pl->m_Id ) |
|
dvander@7
|
231 |
{ |
|
dvander@7
|
232 |
i = m_Plugins.erase(i); |
|
dvander@7
|
233 |
break; |
|
dvander@7
|
234 |
} |
|
dvander@7
|
235 |
} |
|
dvander@7
|
236 |
delete pl; |
|
dvander@7
|
237 |
|
|
dvander@7
|
238 |
return true; |
|
dvander@7
|
239 |
} |
|
dvander@7
|
240 |
|
|
dvander@7
|
241 |
return false; |
|
dvander@7
|
242 |
} |
|
dvander@7
|
243 |
|
|
dvander@7
|
244 |
bool CPluginManager::_Pause(CPluginManager::CPlugin *pl, char *error, size_t maxlen) |
|
dvander@7
|
245 |
{ |
|
dvander@7
|
246 |
if (error) |
|
dvander@7
|
247 |
*error = '\0'; |
|
dvander@7
|
248 |
if (pl->m_Status != Pl_Running || !pl->m_API) |
|
dvander@7
|
249 |
{ |
|
dvander@7
|
250 |
if (error) |
|
dvander@7
|
251 |
snprintf(error, maxlen, "Plugin cannot be paused"); |
|
dvander@7
|
252 |
} else { |
|
dvander@7
|
253 |
return pl->m_API->Pause(error, maxlen); |
|
dvander@7
|
254 |
} |
|
dvander@7
|
255 |
|
|
dvander@7
|
256 |
return false; |
|
dvander@7
|
257 |
} |
|
dvander@7
|
258 |
|
|
dvander@7
|
259 |
bool CPluginManager::_Unpause(CPluginManager::CPlugin *pl, char *error, size_t maxlen) |
|
dvander@7
|
260 |
{ |
|
dvander@7
|
261 |
if (error) |
|
dvander@7
|
262 |
*error = '\0'; |
|
dvander@7
|
263 |
|
|
dvander@7
|
264 |
if (pl->m_Status != Pl_Paused || !pl->m_API) |
|
dvander@7
|
265 |
{ |
|
dvander@7
|
266 |
if (error) |
|
dvander@7
|
267 |
snprintf(error, maxlen, "Plugin cannot be unpaused"); |
|
dvander@7
|
268 |
} else { |
|
dvander@7
|
269 |
return pl->m_API->Unpause(error, maxlen); |
|
dvander@7
|
270 |
} |
|
dvander@7
|
271 |
|
|
dvander@7
|
272 |
return false; |
|
dvander@7
|
273 |
} |
|
dvander@7
|
274 |
|
|
dvander@7
|
275 |
|
|
dvander@7
|
276 |
bool CPluginManager::UnloadAll() |
|
dvander@7
|
277 |
{ |
|
dvander@7
|
278 |
PluginIter i; |
|
dvander@7
|
279 |
bool status = true; |
|
dvander@7
|
280 |
|
|
dvander@7
|
281 |
for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++) |
|
dvander@7
|
282 |
{ |
|
dvander@7
|
283 |
if ( (*i) ) |
|
dvander@7
|
284 |
{ |
|
dvander@7
|
285 |
if ( (*i)->m_API ) |
|
dvander@7
|
286 |
{ |
|
dvander@7
|
287 |
if ( (*i)->m_API->Unload(NULL, 0) ) |
|
dvander@7
|
288 |
status = false; |
|
dvander@7
|
289 |
|
|
dvander@7
|
290 |
dlclose( (*i)->m_Lib ); |
|
dvander@7
|
291 |
} |
|
dvander@7
|
292 |
delete (*i); |
|
dvander@7
|
293 |
} |
|
dvander@7
|
294 |
|
|
dvander@7
|
295 |
i = m_Plugins.erase(i); |
|
dvander@7
|
296 |
} |
|
dvander@7
|
297 |
|
|
dvander@7
|
298 |
return status; |
|
dvander@7
|
299 |
} |
|
dvander@7
|
300 |
|
|
dvander@7
|
301 |
bool CPluginManager::Query(PluginId id, const char *&file, factories *&list, Pl_Status &status, PluginId &source) |
|
dvander@7
|
302 |
{ |
|
dvander@7
|
303 |
CPlugin *pl = FindById(id); |
|
dvander@7
|
304 |
|
|
dvander@7
|
305 |
if (!pl) |
|
dvander@7
|
306 |
return false; |
|
dvander@7
|
307 |
|
|
dvander@7
|
308 |
file = pl->m_File.c_str(); |
|
dvander@7
|
309 |
list = &(pl->fac_list); |
|
dvander@7
|
310 |
status = pl->m_Status; |
|
dvander@7
|
311 |
source = pl->m_Source; |
|
dvander@7
|
312 |
|
|
dvander@7
|
313 |
return true; |
|
dvander@7
|
314 |
} |
|
dvander@7
|
315 |
|
|
dvander@7
|
316 |
PluginIter CPluginManager::_begin() |
|
dvander@7
|
317 |
{ |
|
dvander@7
|
318 |
return m_Plugins.begin(); |
|
dvander@7
|
319 |
} |
|
dvander@7
|
320 |
|
|
dvander@7
|
321 |
PluginIter CPluginManager::_end() |
|
dvander@7
|
322 |
{ |
|
dvander@7
|
323 |
return m_Plugins.end(); |
|
dvander@7
|
324 |
} |