00001
00002
00003
00004
00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020
00021
00022
00023
00024
00025
00026
00027
00028 #ifdef HAVE_CONFIG_H
00029 # include <config.h>
00030 #endif
00031
00032 #include "plugin_p.h"
00033 #include <gwenhywfar/buffer.h>
00034 #include <gwenhywfar/debug.h>
00035 #include <gwenhywfar/directory.h>
00036 #include <gwenhywfar/pathmanager.h>
00037 #include <gwenhywfar/gwenhywfar.h>
00038
00039 #include <sys/types.h>
00040 #include <sys/stat.h>
00041 #ifdef HAVE_UNISTD_H
00042 # include <unistd.h>
00043 #endif
00044 #include <errno.h>
00045 #include <string.h>
00046 #ifdef HAVE_STRINGS_H
00047 # include <strings.h>
00048 #endif
00049 #include <ctype.h>
00050
00051 #ifdef OS_WIN32
00052 # include <windows.h>
00053 #endif
00054
00055 static GWEN_PLUGIN_MANAGER_LIST *gwen_plugin_manager__list=0;
00056
00057
00058 GWEN_INHERIT_FUNCTIONS(GWEN_PLUGIN)
00059 GWEN_LIST_FUNCTIONS(GWEN_PLUGIN, GWEN_Plugin)
00060 GWEN_INHERIT_FUNCTIONS(GWEN_PLUGIN_MANAGER)
00061 GWEN_LIST_FUNCTIONS(GWEN_PLUGIN_MANAGER, GWEN_PluginManager)
00062
00063
00064
00065 int GWEN_Plugin_ModuleInit(){
00066 gwen_plugin_manager__list=GWEN_PluginManager_List_new();
00067 return 0;
00068 }
00069
00070
00071
00072 int GWEN_Plugin_ModuleFini(){
00073 GWEN_PluginManager_List_free(gwen_plugin_manager__list);
00074 return 0;
00075 }
00076
00077
00078
00079 GWEN_PLUGIN *GWEN_Plugin_new(GWEN_PLUGIN_MANAGER *pm,
00080 const char *name,
00081 const char *fileName){
00082 GWEN_PLUGIN *p;
00083
00084 assert(pm);
00085 assert(name);
00086 GWEN_NEW_OBJECT(GWEN_PLUGIN, p);
00087 DBG_MEM_INC("GWEN_PLUGIN", 0);
00088 p->refCount=1;
00089 GWEN_INHERIT_INIT(GWEN_PLUGIN, p);
00090 GWEN_LIST_INIT(GWEN_PLUGIN, p);
00091 p->manager=pm;
00092 p->name=strdup(name);
00093 if (fileName)
00094 p->fileName=strdup(fileName);
00095
00096 return p;
00097 }
00098
00099
00100
00101 void GWEN_Plugin_free(GWEN_PLUGIN *p){
00102 if (p) {
00103 DBG_MEM_DEC("GWEN_PLUGIN");
00104 assert(p->refCount);
00105 if (--(p->refCount)==0) {
00106 GWEN_INHERIT_FINI(GWEN_PLUGIN, p);
00107 free(p->name);
00108 free(p->fileName);
00109 if (p->libLoader) {
00110 GWEN_LibLoader_CloseLibrary(p->libLoader);
00111 GWEN_LibLoader_free(p->libLoader);
00112 }
00113 GWEN_LIST_FINI(GWEN_PLUGIN, p);
00114 GWEN_FREE_OBJECT(p);
00115 }
00116 }
00117 }
00118
00119
00120
00121 void GWEN_Plugin_Attach(GWEN_PLUGIN *p){
00122 assert(p);
00123 assert(p->refCount);
00124 DBG_MEM_INC("GWEN_PLUGIN", 1);
00125 p->refCount++;
00126 }
00127
00128
00129
00130 GWEN_PLUGIN_MANAGER *GWEN_Plugin_GetManager(const GWEN_PLUGIN *p){
00131 assert(p);
00132 return p->manager;
00133 }
00134
00135
00136
00137 const char *GWEN_Plugin_GetName(const GWEN_PLUGIN *p){
00138 assert(p);
00139 return p->name;
00140 }
00141
00142
00143
00144 const char *GWEN_Plugin_GetFileName(const GWEN_PLUGIN *p){
00145 assert(p);
00146 return p->fileName;
00147 }
00148
00149
00150
00151 GWEN_LIBLOADER *GWEN_Plugin_GetLibLoader(const GWEN_PLUGIN *p){
00152 assert(p);
00153 return p->libLoader;
00154 }
00155
00156
00157
00158 void GWEN_Plugin_SetLibLoader(GWEN_PLUGIN *p, GWEN_LIBLOADER *ll){
00159 assert(p);
00160 p->libLoader=ll;
00161 }
00162
00163
00164
00165
00166
00167
00168
00169
00170 GWEN_PLUGIN_MANAGER *GWEN_PluginManager_new(const char *name,
00171 const char *destLib){
00172 GWEN_PLUGIN_MANAGER *pm;
00173
00174 assert(name);
00175 assert(destLib);
00176 GWEN_NEW_OBJECT(GWEN_PLUGIN_MANAGER, pm);
00177 DBG_MEM_INC("GWEN_PLUGIN_MANAGER", 0);
00178 GWEN_INHERIT_INIT(GWEN_PLUGIN_MANAGER, pm);
00179 GWEN_LIST_INIT(GWEN_PLUGIN_MANAGER, pm);
00180 pm->name=strdup(name);
00181 pm->destLib=strdup(destLib);
00182 pm->plugins=GWEN_Plugin_List_new();
00183
00184 return pm;
00185 }
00186
00187
00188
00189 void GWEN_PluginManager_free(GWEN_PLUGIN_MANAGER *pm){
00190 if (pm) {
00191 DBG_MEM_DEC("GWEN_PLUGIN_MANAGER");
00192 GWEN_Plugin_List_free(pm->plugins);
00193 GWEN_INHERIT_FINI(GWEN_PLUGIN_MANAGER, pm);
00194 free(pm->destLib);
00195 free(pm->name);
00196 GWEN_LIST_FINI(GWEN_PLUGIN_MANAGER, pm);
00197 GWEN_FREE_OBJECT(pm);
00198 }
00199 }
00200
00201
00202
00203 const char *GWEN_PluginManager_GetName(const GWEN_PLUGIN_MANAGER *pm){
00204 assert(pm);
00205 return pm->name;
00206 }
00207
00208
00209
00210 int GWEN_PluginManager_AddPath(GWEN_PLUGIN_MANAGER *pm,
00211 const char *callingLib,
00212 const char *s){
00213 assert(pm);
00214 return GWEN_PathManager_AddPath(callingLib,
00215 pm->destLib,
00216 pm->name,
00217 s);
00218 }
00219
00220
00221
00222 int GWEN_PluginManager_AddRelPath(GWEN_PLUGIN_MANAGER *pm,
00223 const char *callingLib,
00224 const char *s,
00225 GWEN_PATHMANAGER_RELMODE rm) {
00226 assert(pm);
00227 return GWEN_PathManager_AddRelPath(callingLib,
00228 pm->destLib,
00229 pm->name,
00230 s,
00231 rm);
00232 }
00233
00234
00235
00236 int GWEN_PluginManager_InsertPath(GWEN_PLUGIN_MANAGER *pm,
00237 const char *callingLib,
00238 const char *s) {
00239 assert(pm);
00240 return GWEN_PathManager_InsertPath(callingLib,
00241 pm->destLib,
00242 pm->name,
00243 s);
00244 }
00245
00246
00247
00248 int GWEN_PluginManager_RemovePath(GWEN_PLUGIN_MANAGER *pm,
00249 const char *callingLib,
00250 const char *s) {
00251 assert(pm);
00252 return GWEN_PathManager_RemovePath(callingLib,
00253 pm->destLib,
00254 pm->name,
00255 s);
00256 }
00257
00258
00259
00260 int GWEN_PluginManager_AddPathFromWinReg(GWEN_PLUGIN_MANAGER *pm,
00261 const char *callingLib,
00262 const char *keypath,
00263 const char *varname){
00264 #ifdef OS_WIN32
00265 HKEY hkey;
00266 TCHAR nbuffer[MAX_PATH];
00267 BYTE vbuffer[MAX_PATH];
00268 DWORD nsize;
00269 DWORD vsize;
00270 DWORD typ;
00271 int i;
00272
00273 assert(pm);
00274
00275 snprintf(nbuffer, sizeof(nbuffer), keypath);
00276
00277
00278 if (RegOpenKey(HKEY_LOCAL_MACHINE, nbuffer, &hkey)){
00279 DBG_INFO(GWEN_LOGDOMAIN, "RegOpenKey %s failed.", keypath);
00280 return 1;
00281 }
00282
00283
00284 for (i=0;; i++) {
00285 nsize=sizeof(nbuffer);
00286 vsize=sizeof(vbuffer);
00287 if (ERROR_SUCCESS!=RegEnumValue(hkey,
00288 i,
00289 nbuffer,
00290 &nsize,
00291 0,
00292 &typ,
00293 vbuffer,
00294 &vsize))
00295 break;
00296 if (strcasecmp(nbuffer, varname)==0 && typ==REG_SZ) {
00297
00298 RegCloseKey(hkey);
00299 return GWEN_PathManager_AddPath(callingLib,
00300 pm->destLib,
00301 pm->name,
00302 (char*)vbuffer);
00303 }
00304 }
00305
00306 RegCloseKey(hkey);
00307 DBG_INFO(GWEN_LOGDOMAIN,
00308 "In RegKey \"%s\" the variable \"%s\" does not exist",
00309 keypath, varname);
00310 return 1;
00311
00312 #else
00313 return 0;
00314 #endif
00315 }
00316
00317
00318
00319 GWEN_PLUGIN *GWEN_PluginManager_LoadPlugin(GWEN_PLUGIN_MANAGER *pm,
00320 const char *modname){
00321 #ifdef ENABLE_PLUGIN_LOADING
00322 GWEN_LIBLOADER *ll;
00323 GWEN_PLUGIN *plugin;
00324 GWEN_PLUGIN_FACTORYFN fn;
00325 void *p;
00326 GWEN_BUFFER *nbuf;
00327 const char *s;
00328 const char *fname;
00329 int err;
00330 GWEN_STRINGLIST *sl;
00331 GWEN_STRINGLISTENTRY *se;
00332
00333 assert(pm);
00334 ll=GWEN_LibLoader_new();
00335 sl=GWEN_PathManager_GetPaths(pm->destLib, pm->name);
00336 if (sl==NULL) {
00337 DBG_ERROR(GWEN_LOGDOMAIN, "No paths for plugins (%s)", pm->name);
00338 GWEN_LibLoader_free(ll);
00339 return NULL;
00340 }
00341 nbuf=GWEN_Buffer_new(0, 128, 0, 1);
00342 s=modname;
00343 while(*s) GWEN_Buffer_AppendByte(nbuf, tolower(*(s++)));
00344 se=GWEN_StringList_FirstEntry(sl);
00345 fname=0;
00346 while(se) {
00347 fname=GWEN_StringListEntry_Data(se);
00348 assert(fname);
00349 if (GWEN_LibLoader_OpenLibraryWithPath(ll, fname,
00350 GWEN_Buffer_GetStart(nbuf))==0)
00351 break;
00352 else {
00353 DBG_DEBUG(GWEN_LOGDOMAIN,
00354 "Could not load plugin \"%s\" from \"%s\"", modname, fname);
00355 }
00356 se=GWEN_StringListEntry_Next(se);
00357 }
00358 if (!se) {
00359 DBG_ERROR(GWEN_LOGDOMAIN, "Plugin \"%s\" not found.", modname);
00360 GWEN_Buffer_free(nbuf);
00361 GWEN_StringList_free(sl);
00362 GWEN_LibLoader_free(ll);
00363 return NULL;
00364 }
00365 GWEN_Buffer_free(nbuf);
00366
00367
00368 nbuf=GWEN_Buffer_new(0, 128, 0, 1);
00369 s=pm->name;
00370 while(*s) GWEN_Buffer_AppendByte(nbuf, tolower(*(s++)));
00371 GWEN_Buffer_AppendByte(nbuf, '_');
00372 s=modname;
00373 while(*s) GWEN_Buffer_AppendByte(nbuf, tolower(*(s++)));
00374 GWEN_Buffer_AppendString(nbuf, "_factory");
00375
00376
00377 err=GWEN_LibLoader_Resolve(ll, GWEN_Buffer_GetStart(nbuf), &p);
00378 if (err) {
00379 DBG_ERROR_ERR(GWEN_LOGDOMAIN, err);
00380 GWEN_Buffer_free(nbuf);
00381 GWEN_LibLoader_CloseLibrary(ll);
00382 GWEN_StringList_free(sl);
00383 GWEN_LibLoader_free(ll);
00384 return 0;
00385 }
00386 GWEN_Buffer_free(nbuf);
00387
00388 fn=(GWEN_PLUGIN_FACTORYFN)p;
00389 assert(fn);
00390 plugin=fn(pm, modname, fname);
00391 if (!plugin) {
00392 DBG_ERROR(GWEN_LOGDOMAIN, "Error in plugin: No plugin created");
00393 GWEN_LibLoader_CloseLibrary(ll);
00394 GWEN_StringList_free(sl);
00395 GWEN_LibLoader_free(ll);
00396 return 0;
00397 }
00398
00399
00400 GWEN_StringList_free(sl);
00401 GWEN_Plugin_SetLibLoader(plugin, ll);
00402 return plugin;
00403 #else
00404 DBG_ERROR(GWEN_LOGDOMAIN, "Loading of plugins is disabled");
00405 return NULL;
00406 #endif
00407 }
00408
00409
00410
00411 GWEN_PLUGIN *GWEN_PluginManager_LoadPluginFile(GWEN_PLUGIN_MANAGER *pm,
00412 const char *modname,
00413 const char *fname){
00414 #ifdef ENABLE_PLUGIN_LOADING
00415 GWEN_LIBLOADER *ll;
00416 GWEN_PLUGIN *plugin;
00417 GWEN_PLUGIN_FACTORYFN fn;
00418 void *p;
00419 GWEN_BUFFER *nbuf;
00420 const char *s;
00421 int err;
00422
00423 ll=GWEN_LibLoader_new();
00424 if (GWEN_LibLoader_OpenLibrary(ll, fname)) {
00425 DBG_INFO(GWEN_LOGDOMAIN,
00426 "Could not load plugin \"%s\" (%s)", modname, fname);
00427 GWEN_LibLoader_free(ll);
00428 return 0;
00429 }
00430
00431
00432 nbuf=GWEN_Buffer_new(0, 128, 0, 1);
00433 s=pm->name;
00434 while(*s) GWEN_Buffer_AppendByte(nbuf, tolower(*(s++)));
00435 GWEN_Buffer_AppendByte(nbuf, '_');
00436 s=modname;
00437 while(*s) GWEN_Buffer_AppendByte(nbuf, tolower(*(s++)));
00438 GWEN_Buffer_AppendString(nbuf, "_factory");
00439
00440
00441 err=GWEN_LibLoader_Resolve(ll, GWEN_Buffer_GetStart(nbuf), &p);
00442 if (err) {
00443 DBG_INFO_ERR(GWEN_LOGDOMAIN, err);
00444 GWEN_Buffer_free(nbuf);
00445 GWEN_LibLoader_CloseLibrary(ll);
00446 GWEN_LibLoader_free(ll);
00447 return 0;
00448 }
00449 GWEN_Buffer_free(nbuf);
00450
00451 fn=(GWEN_PLUGIN_FACTORYFN)p;
00452 assert(fn);
00453 plugin=fn(pm, modname, fname);
00454 if (!plugin) {
00455 DBG_INFO(GWEN_LOGDOMAIN, "Error in plugin: No plugin created");
00456 GWEN_LibLoader_CloseLibrary(ll);
00457 GWEN_LibLoader_free(ll);
00458 return 0;
00459 }
00460
00461
00462 GWEN_Plugin_SetLibLoader(plugin, ll);
00463
00464 return plugin;
00465 #else
00466 DBG_ERROR(GWEN_LOGDOMAIN, "Loading of plugins is disabled");
00467 return NULL;
00468 #endif
00469 }
00470
00471
00472
00473 GWEN_PLUGIN *GWEN_PluginManager__FindPlugin(GWEN_PLUGIN_MANAGER *pm,
00474 const char *s){
00475 GWEN_PLUGIN *p;
00476
00477 assert(pm);
00478 p=GWEN_Plugin_List_First(pm->plugins);
00479 while(p) {
00480 if (strcasecmp(p->name, s)==0)
00481 break;
00482 p=GWEN_Plugin_List_Next(p);
00483 }
00484
00485 return p;
00486 }
00487
00488
00489
00490 GWEN_PLUGIN *GWEN_PluginManager_GetPlugin(GWEN_PLUGIN_MANAGER *pm,
00491 const char *s){
00492 GWEN_PLUGIN *p;
00493
00494 p=GWEN_PluginManager__FindPlugin(pm, s);
00495 if (p)
00496 return p;
00497 p=GWEN_PluginManager_LoadPlugin(pm, s);
00498 if (p) {
00499 GWEN_Plugin_List_Add(p, pm->plugins);
00500 return p;
00501 }
00502 DBG_INFO(GWEN_LOGDOMAIN, "Plugin \"%s\" not found", s);
00503 return 0;
00504 }
00505
00506
00507
00508 GWEN_PLUGIN_MANAGER *GWEN_PluginManager_FindPluginManager(const char *s){
00509 GWEN_PLUGIN_MANAGER *pm;
00510
00511 pm=GWEN_PluginManager_List_First(gwen_plugin_manager__list);
00512 while(pm) {
00513 if (strcasecmp(pm->name, s)==0)
00514 break;
00515 pm=GWEN_PluginManager_List_Next(pm);
00516 }
00517
00518 return pm;
00519 }
00520
00521
00522
00523 int GWEN_PluginManager_Register(GWEN_PLUGIN_MANAGER *pm){
00524 GWEN_PLUGIN_MANAGER *tpm;
00525 int rv;
00526
00527 assert(gwen_plugin_manager__list);
00528 assert(pm);
00529 tpm=GWEN_PluginManager_FindPluginManager(pm->name);
00530 if (tpm) {
00531 DBG_ERROR(GWEN_LOGDOMAIN,
00532 "Plugin type \"%s\" already registered",
00533 pm->name);
00534 return -1;
00535 }
00536
00537 rv=GWEN_PathManager_DefinePath(pm->destLib, pm->name);
00538 if (rv) {
00539 DBG_INFO(GWEN_LOGDOMAIN, "Could not define path for plugin [%s:%s]",
00540 pm->destLib, pm->name);
00541 return rv;
00542 }
00543
00544 GWEN_PluginManager_List_Add(pm, gwen_plugin_manager__list);
00545 DBG_INFO(GWEN_LOGDOMAIN,
00546 "Plugin type \"%s\" registered",
00547 pm->name);
00548 return 0;
00549 }
00550
00551
00552
00553 int GWEN_PluginManager_Unregister(GWEN_PLUGIN_MANAGER *pm){
00554 GWEN_PLUGIN_MANAGER *tpm;
00555 int rv;
00556
00557 assert(gwen_plugin_manager__list);
00558 assert(pm);
00559 tpm=GWEN_PluginManager_FindPluginManager(pm->name);
00560 if (!tpm) {
00561 DBG_ERROR(GWEN_LOGDOMAIN,
00562 "Plugin type \"%s\" not registered",
00563 pm->name);
00564 return -1;
00565 }
00566
00567 rv=GWEN_PathManager_UndefinePath(pm->destLib, pm->name);
00568 if (rv) {
00569 DBG_INFO(GWEN_LOGDOMAIN, "Could not undefine path for plugin [%s:%s]",
00570 pm->destLib, pm->name);
00571 return rv;
00572 }
00573
00574 GWEN_PluginManager_List_Del(pm);
00575 DBG_INFO(GWEN_LOGDOMAIN,
00576 "Plugin type \"%s\" unregistered",
00577 pm->name);
00578 return 0;
00579 }
00580
00581
00582
00583 GWEN_PLUGIN_DESCRIPTION_LIST2*
00584 GWEN_PluginManager_GetPluginDescrs(GWEN_PLUGIN_MANAGER *pm){
00585 GWEN_PLUGIN_DESCRIPTION_LIST2 *pl;
00586 GWEN_STRINGLIST *sl;
00587 GWEN_STRINGLISTENTRY *se;
00588
00589 sl=GWEN_PathManager_GetPaths(pm->destLib, pm->name);
00590 if (sl==NULL) {
00591 DBG_ERROR(GWEN_LOGDOMAIN, "No paths for plugins (%s)", pm->name);
00592 return NULL;
00593 }
00594 se=GWEN_StringList_FirstEntry(sl);
00595 if (!se) {
00596 DBG_ERROR(GWEN_LOGDOMAIN, "No paths given");
00597 GWEN_StringList_free(sl);
00598 return 0;
00599 }
00600
00601 pl=GWEN_PluginDescription_List2_new();
00602 while(se) {
00603 int rv;
00604 const char *path;
00605
00606 path=GWEN_StringListEntry_Data(se);
00607 assert(path);
00608 rv=GWEN_LoadPluginDescrsByType(path, pm->name, pl);
00609 if (rv) {
00610 DBG_INFO(GWEN_LOGDOMAIN,
00611 "Error loading plugin description in \"%s\"", path);
00612 }
00613 se=GWEN_StringListEntry_Next(se);
00614 }
00615
00616 if (GWEN_PluginDescription_List2_GetSize(pl)==0) {
00617 GWEN_PluginDescription_List2_free(pl);
00618 GWEN_StringList_free(sl);
00619 return 0;
00620 }
00621
00622 GWEN_StringList_free(sl);
00623 return pl;
00624 }
00625
00626
00627 GWEN_STRINGLIST *GWEN_PluginManager_GetPaths(const GWEN_PLUGIN_MANAGER *pm){
00628 assert(pm);
00629 return GWEN_PathManager_GetPaths(pm->destLib, pm->name);
00630 }
00631
00632
00633
00634 GWEN_PLUGIN_DESCRIPTION*
00635 GWEN_PluginManager_GetPluginDescr(GWEN_PLUGIN_MANAGER *pm,
00636 const char *modName) {
00637 GWEN_PLUGIN_DESCRIPTION_LIST2 *dl;
00638
00639 dl=GWEN_PluginManager_GetPluginDescrs(pm);
00640 if (dl==0)
00641 return 0;
00642 else {
00643 GWEN_PLUGIN_DESCRIPTION_LIST2_ITERATOR *dit;
00644
00645 dit=GWEN_PluginDescription_List2_First(dl);
00646 if (dit) {
00647 GWEN_PLUGIN_DESCRIPTION *d;
00648
00649 d=GWEN_PluginDescription_List2Iterator_Data(dit);
00650 while(d) {
00651 if (strcasecmp(GWEN_PluginDescription_GetName(d), modName)==0)
00652 break;
00653 d=GWEN_PluginDescription_List2Iterator_Next(dit);
00654 }
00655 GWEN_PluginDescription_List2Iterator_free(dit);
00656
00657 if (d) {
00658 d=GWEN_PluginDescription_dup(d);
00659 GWEN_PluginDescription_List2_freeAll(dl);
00660 return d;
00661 }
00662 }
00663 GWEN_PluginDescription_List2_freeAll(dl);
00664 }
00665
00666 return 0;
00667 }
00668
00669
00670
00671 void GWEN_PluginManager_AddPlugin(GWEN_PLUGIN_MANAGER *pm, GWEN_PLUGIN *p) {
00672 #if 0
00673 DBG_ERROR(0, "Adding plugin [%s] of type [%s]",
00674 p->name, pm->name);
00675 #endif
00676 GWEN_Plugin_List_Add(p, pm->plugins);
00677 }
00678
00679
00680
00681
00682
00683