summaryrefslogtreecommitdiffstats
path: root/cmodule.cpp
blob: ca0ae9f577bba64302ba9f8196e166a721161eb2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
/*  Copyright 2008,2009,2010 Edwin Eefting (edwin@datux.nl) 

    This file is part of Synapse.

    Synapse is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    Synapse is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with Synapse.  If not, see <http://www.gnu.org/licenses/>. */













#include "cmodule.h"
#include "clog.h"
#include <dlfcn.h>
#include <boost/regex.hpp> 
#include <boost/foreach.hpp>
namespace synapse
{



Cmodule::Cmodule()
{
	maxThreads=1;
	currentThreads=0;
	broadcastMulti=false;
	broadcastCookie=false;
	soHandle=NULL;
	defaultSessionId=SESSION_DISABLED;
	soDefaultHandler=NULL;
	readySession=SESSION_DISABLED;	
}


Cmodule::~Cmodule()
{
	//unload the module on destruction.
	//Destruction only happens when nobody is using the Cmodule object anymore, since we only
	//use shared_ptrs.
	if (soHandle)
	{
		DEB(name << " is unused - auto unloading");
		unload();
	}
}




/*!
    \fn Cmodule::startThread()
 */
bool Cmodule::startThread()
{
	if (currentThreads<maxThreads)
	{
		currentThreads++;
		return true;
	}
	return false;
}


/*!
    \fn Cmodule::endThread()
 */
void Cmodule::endThread()
{
	currentThreads--;
	assert(currentThreads>=0);
}


/*!
    \fn Cmodule::load(string name)
 */
bool Cmodule::load(string path)
{
	this->name=getName(path);
	this->path=path;
	INFO("Loading module " << name << " from: " << path );
	soHandle=dlopen(path.c_str(),RTLD_NOW);
	if (soHandle==NULL)
	{
		ERROR("Error loading module " << name << ": " << dlerror());
	}
	else
	{
		//check api version of the module
		FsoVersion version;
		version=(FsoVersion)resolve("synapseVersion");
		if (version!=NULL)
		{	
			if (version()!=SYNAPSE_API_VERSION)
			{
				ERROR("Module " << name << " has API version " << version() << " instead of : " << SYNAPSE_API_VERSION);
			}
			else 
			{
				//init function is MANDATORY
				soInit=(FsoInit)resolve("synapseInit");
				if (soInit!=NULL)
				{
					INFO("Module loading of " << name  << " complete.");
					return true;
				}
			}
		}

		DEB("Unloading because of previous error");
		dlclose(soHandle);
		soHandle=NULL;
	}
	return false;
}


/*!
    \fn Cmodule::unload()
 */
bool Cmodule::unload()
{
	if (soHandle!=NULL)
	{
		INFO("Unloading module " << name);

		FsoCleanup soCleanup;
		soCleanup=(FsoCleanup)resolve("synapseCleanup");
		if (soCleanup!=NULL)
		{
			DEB("Calling cleanup");
			soCleanup();
		}

		DEB("Calling dlclose on " << soHandle);
		if (dlclose(soHandle))
		{
			ERROR("Error unloading module " << name << ": " << dlerror());
		}
		DEB("Unload success");
	}
	return true;
}


/*!
    \fn Cmodule::getHandler(string name)
 */
FsoHandler Cmodule::getHandler(string eventName)
{
	ChandlerHashMap::iterator handlerI;
	handlerI=handlers.find(eventName);
	//not found?
	if (handlerI==handlers.end())
	{
		//return default handler
		return(soDefaultHandler);
	}
	else
	{
		return (handlerI->second);
	}
}

bool Cmodule::setHandler(const string & eventName, const string & functionName)
{
	FsoHandler soHandler;
	soHandler=(FsoHandler)resolve("synapse_"+functionName);
	if (soHandler!=NULL)
	{
		DEB(eventName << " -> " << functionName << "@" << name );
		handlers[eventName]=soHandler;

		return true;
	}

	return false;

}

bool Cmodule::setDefaultHandler(const string & functionName)
{
	FsoHandler soHandler;
	soHandler=(FsoHandler)resolve("synapse_"+functionName);
	if (soHandler!=NULL)
	{
		DEB("(default handler) -> " << functionName << "@" << name );
		soDefaultHandler=soHandler;
		return true;
	}

	return false;

}

/*!
    \fn Cmodule::resolve(const string * functionName)
 */
void * Cmodule::resolve(const string & functionName)
{
	if (soHandle==NULL)
	{
		ERROR("Cannot resolve function " << functionName << ". There is no module loaded! (yet?)");
		return NULL;
	}

	void * function;
	function=dlsym(soHandle, functionName.c_str());
	if (function==NULL)
	{
		ERROR("Could not find function " << functionName << " in module " << name << ": " << dlerror());
	}
	return (function);
}


/*!
    \fn Cmodule::isLoaded(string path)
 */
bool Cmodule::isLoaded(string path)
{
	return (dlopen(path.c_str(),RTLD_NOW|RTLD_NOLOAD)!=NULL);

}


/*!
    \fn Cmodule::getName(string path)
 */
string Cmodule::getName(string path)
{
	//calculate the name from a module path
	regex expression(".*/lib(.*).so$");
	cmatch what; 
	if(!regex_match(path.c_str(), what, expression))
	{
		ERROR("Cannot determine module name of path " << path);
		return (path);
	} 
	else
	{
		return (what[1]);
	}
	
}

void Cmodule::getEvents(Cvar & var)
{
	//traverse the events that have been created by calls to sendMessage
	BOOST_FOREACH( ChandlerHashMap::value_type handler, handlers)
	{
		var[handler.first]=1;
	}
}

}