#include #include "pluginmanager.h" #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include // lets disable the plugin system for now, as it's unfinished. #ifdef WINDOWS_SYS #include "dlfcn_win32.h" #else #include #endif // #define DEBUG_PLUGIN_MANAGER 1 std::string RsPluginManager::_plugin_entry_symbol = "RETROSHARE_PLUGIN_provide" ; std::string RsPluginManager::_plugin_revision_symbol = "RETROSHARE_PLUGIN_revision" ; std::string RsPluginManager::_plugin_API_symbol = "RETROSHARE_PLUGIN_api" ; std::string RsPluginManager::_local_cache_dir ; std::string RsPluginManager::_remote_cache_dir ; std::vector RsPluginManager::_plugin_directories ; ftServer *RsPluginManager::_ftserver = NULL ; p3LinkMgr *RsPluginManager::_linkmgr = NULL ; typedef RsPlugin *(*RetroSharePluginEntry)(void) ; RsPluginHandler *rsPlugins ; RsPluginManager::RsPluginManager(const RsFileHash &hash) : p3Config(CONFIG_TYPE_PLUGINS),_current_executable_hash(hash) { _allow_all_plugins = false ; } void RsPluginManager::loadConfiguration() { RsFileHash dummyHash ; p3Config::loadConfiguration(dummyHash); } void RsPluginManager::setInterfaces(RsPlugInInterfaces &interfaces) { std::cerr << "RsPluginManager::setInterfaces() " << std::endl; for(uint32_t i=0;i<_plugins.size();++i) if(_plugins[i].plugin != NULL) { std::cerr << " setting iterface for plugin " << _plugins[i].plugin->getPluginName() << ", with RS_ID " << _plugins[i].plugin->rs_service_id() << std::endl ; _plugins[i].plugin->setInterfaces(interfaces); } } void RsPluginManager::setCacheDirectories(const std::string& local_cache, const std::string& remote_cache) { _local_cache_dir = local_cache ; _remote_cache_dir = remote_cache ; } bool RsPluginManager::acceptablePluginName(const std::string& name) { // Needs some windows specific code here // #ifdef WINDOWS_SYS return name.size() > 4 && name.substr(name.size() - 4) == ".dll"; #else return name.size() > 3 && !strcmp(name.c_str()+name.size()-3,".so") ; #endif } void RsPluginManager::disablePlugin(const RsFileHash& hash) { std::set::iterator it = _accepted_hashes.find(hash) ; if(it != _accepted_hashes.end()) { std::cerr << "RsPluginManager::disablePlugin(): removing hash " << hash << " from white list" << std::endl; _accepted_hashes.erase(it) ; IndicateConfigChanged() ; } if(_rejected_hashes.find(hash) == _rejected_hashes.end()) { std::cerr << "RsPluginManager::enablePlugin(): inserting hash " << hash << " in black list" << std::endl; _rejected_hashes.insert(hash) ; IndicateConfigChanged() ; } } void RsPluginManager::enablePlugin(const RsFileHash& hash) { if(_accepted_hashes.find(hash) == _accepted_hashes.end()) { std::cerr << "RsPluginManager::enablePlugin(): inserting hash " << hash << " in white list" << std::endl; _accepted_hashes.insert(hash) ; IndicateConfigChanged() ; } std::set::const_iterator it(_rejected_hashes.find(hash)) ; if(it != _rejected_hashes.end()) { std::cerr << "RsPluginManager::enablePlugin(): removing hash " << hash << " from black list" << std::endl; _rejected_hashes.erase(it) ; IndicateConfigChanged() ; } } void RsPluginManager::loadPlugins(const std::vector& plugin_directories) { _plugin_directories = plugin_directories ; _plugin_entry_symbol = "RETROSHARE_PLUGIN_provide" ; _plugin_revision_symbol = "RETROSHARE_PLUGIN_revision" ; // 0 - get the list of files to read for(uint32_t i=0;istop(); // delete _plugins[i].plugin; // _plugins[i].plugin = NULL; } } } void RsPluginManager::getPluginStatus(int i,uint32_t& status,std::string& file_name,RsFileHash &hash,uint32_t& svn_revision,std::string& error_string) const { if((uint32_t)i >= _plugins.size()) return ; status = _plugins[i].status ; error_string = _plugins[i].info_string ; hash = _plugins[i].file_hash ; file_name = _plugins[i].file_name ; svn_revision = _plugins[i].svn_revision ; } bool RsPluginManager::getAllowAllPlugins() const { return _allow_all_plugins ; } void RsPluginManager::allowAllPlugins(bool b) { _allow_all_plugins = b ; IndicateConfigChanged() ; } RsSerialiser *RsPluginManager::setupSerialiser() { RsSerialiser *rss = new RsSerialiser ; rss->addSerialType(new RsPluginSerialiser()) ; rss->addSerialType(new RsGeneralConfigSerialiser()) ; return rss ; } void RsPluginManager::loadPlugins(const std::vector& plugins) { for(uint32_t i=0;isetPlugInHandler(this); // WIN fix, cannot share global space with shared libraries // The following choice is conservative by forcing RS to resolve all dependencies at // the time of loading the plugin. pinfo.status = PLUGIN_STATUS_LOADED ; _plugins.push_back(pinfo) ; return true; } bool RsPluginManager::loadPlugin(const std::string& plugin_name) { std::cerr << " Loading plugin " << plugin_name << std::endl; PluginInfo pf ; pf.plugin = NULL ; pf.file_name = plugin_name ; pf.info_string = "" ; std::cerr << " -> hashing." << std::endl; uint64_t size ; // Stage 1 - get information related to file (hash, name, ...) // if(!RsDirUtil::getFileHash(plugin_name,pf.file_hash,size)) { std::cerr << " -> cannot hash file. Plugin read canceled." << std::endl; return false; } _plugins.push_back(pf) ; PluginInfo& pinfo(_plugins.back()) ; std::cerr << " -> hash = " << pinfo.file_hash << std::endl; if(!_allow_all_plugins) { if(_accepted_hashes.find(pinfo.file_hash) == _accepted_hashes.end() && _rejected_hashes.find(pinfo.file_hash) == _rejected_hashes.end() ) if(!RsServer::notify()->askForPluginConfirmation(pinfo.file_name,pinfo.file_hash.toStdString())) _rejected_hashes.insert(pinfo.file_hash) ; // accepted hashes are treated at the end, for security. if(_rejected_hashes.find(pinfo.file_hash) != _rejected_hashes.end() ) { pinfo.status = PLUGIN_STATUS_REJECTED_HASH ; std::cerr << " -> hash rejected. Giving up plugin. " << std::endl; return false ; } } else std::cerr << " -> ALLOW_ALL_PLUGINS Enabled => plugin loaded by default." << std::endl; std::cerr << " -> hash authorized. Loading plugin. " << std::endl; // Stage 2 - open with dlopen, and get some basic info. // // The following choice is conservative by forcing RS to resolve all dependencies at // the time of loading the plugin. int link_mode = RTLD_NOW | RTLD_GLOBAL ; void *handle = dlopen(plugin_name.c_str(),link_mode) ; if(handle == NULL) { const char *val = dlerror() ; std::cerr << " Cannot open plugin: " << val << std::endl ; pinfo.status = PLUGIN_STATUS_DLOPEN_ERROR ; pinfo.info_string = val ; return false ; } void *prev = dlsym(handle,_plugin_revision_symbol.c_str()) ; pinfo.svn_revision = (prev == NULL) ? 0 : (*(uint32_t *)prev) ; void *papi = dlsym(handle,_plugin_API_symbol.c_str()) ; pinfo.API_version = (papi == NULL) ? 0 : (*(uint32_t *)papi) ; std::cerr << " -> plugin revision number: " << pinfo.svn_revision << std::endl; std::cerr << " plugin API number : " << std::hex << pinfo.API_version << std::dec << std::endl; std::cerr << " retroshare svn number: " << RsUtil::retroshareRevision() << std::endl; // Check that the plugin provides a svn revision number and a API number // if(pinfo.API_version == 0) { std::cerr << " -> No API version number." << std::endl; pinfo.status = PLUGIN_STATUS_MISSING_API ; pinfo.info_string = "" ; return false ; } if(pinfo.svn_revision == 0) { std::cerr << " -> No svn revision number." << std::endl; pinfo.status = PLUGIN_STATUS_MISSING_SVN ; pinfo.info_string = "" ; return false ; } // Now look for the plugin class symbol. // void *pfe = dlsym(handle,_plugin_entry_symbol.c_str()) ; if(pfe == NULL) { std::cerr << dlerror() << std::endl ; pinfo.status = PLUGIN_STATUS_MISSING_SYMBOL ; pinfo.info_string = _plugin_entry_symbol ; return false ; } std::cerr << " -> Added function entry for symbol " << _plugin_entry_symbol << std::endl ; RsPlugin *p = ( (*(RetroSharePluginEntry)pfe)() ) ; if(p == NULL) { std::cerr << " Plugin entry function " << _plugin_entry_symbol << " returns NULL ! It should return an object of type RsPlugin* " << std::endl; pinfo.status = PLUGIN_STATUS_NULL_PLUGIN ; pinfo.info_string = "Plugin entry " + _plugin_entry_symbol + "() return NULL" ; return false ; } pinfo.status = PLUGIN_STATUS_LOADED ; pinfo.plugin = p ; p->setPlugInHandler(this); // WIN fix, cannot share global space with shared libraries pinfo.info_string = "" ; _accepted_hashes.insert(pinfo.file_hash) ; // do it now, to avoid putting in list a plugin that might have crashed during the load. return true; } p3LinkMgr *RsPluginManager::getLinkMgr() const { assert(_linkmgr != NULL) ; return _linkmgr ; } ftServer *RsPluginManager::getFileServer() const { assert(_ftserver != NULL) ; return _ftserver ; } const std::string& RsPluginManager::getLocalCacheDir() const { assert(!_local_cache_dir.empty()) ; return _local_cache_dir ; } const std::string& RsPluginManager::getRemoteCacheDir() const { assert(!_remote_cache_dir.empty()) ; return _remote_cache_dir ; } void RsPluginManager::slowTickPlugins(time_t seconds) { for(uint32_t i=0;i<_plugins.size();++i) if(_plugins[i].plugin != NULL && _plugins[i].plugin->rs_cache_service() != NULL && (seconds % _plugins[i].plugin->rs_cache_service()->tickDelay() )) { #ifdef DEBUG_PLUGIN_MANAGER std::cerr << " ticking plugin " << _plugins[i].plugin->getPluginName() << std::endl; #endif _plugins[i].plugin->rs_cache_service()->tick() ; } } void RsPluginManager::registerCacheServices() { std::cerr << " Registering cache services." << std::endl; for(uint32_t i=0;i<_plugins.size();++i) if(_plugins[i].plugin != NULL && _plugins[i].plugin->rs_cache_service() != NULL) { rsFiles->getCacheStrapper()->addCachePair(CachePair(_plugins[i].plugin->rs_cache_service(),_plugins[i].plugin->rs_cache_service(),CacheId(_plugins[i].plugin->rs_service_id(), 0))) ; std::cerr << " adding new cache pair for plugin " << _plugins[i].plugin->getPluginName() << ", with RS_ID " << _plugins[i].plugin->rs_service_id() << std::endl ; } } void RsPluginManager::registerClientServices(p3ServiceServer *pqih) { std::cerr << " Registering pqi services." << std::endl; for(uint32_t i=0;i<_plugins.size();++i) if(_plugins[i].plugin != NULL && _plugins[i].plugin->rs_pqi_service() != NULL) { pqih->addService(_plugins[i].plugin->rs_pqi_service()) ; std::cerr << " Added pqi service for plugin " << _plugins[i].plugin->getPluginName() << std::endl; } } void RsPluginManager::addConfigurations(p3ConfigMgr *ConfigMgr) { std::cerr << " Registering configuration files." << std::endl; for(uint32_t i=0;i<_plugins.size();++i) if(_plugins[i].plugin != NULL && _plugins[i].plugin->configurationFileName().length() > 0) { if( _plugins[i].plugin->rs_cache_service() != NULL) ConfigMgr->addConfiguration(_plugins[i].plugin->configurationFileName(), _plugins[i].plugin->rs_cache_service()); else if(_plugins[i].plugin->rs_pqi_service() != NULL) ConfigMgr->addConfiguration(_plugins[i].plugin->configurationFileName(), _plugins[i].plugin->rs_pqi_service()); else continue ; std::cerr << " Added configuration for plugin " << _plugins[i].plugin->getPluginName() << ", with file " << _plugins[i].plugin->configurationFileName() << std::endl; } } bool RsPluginManager::loadList(std::list& list) { std::set accepted_hash_candidates ; std::set rejected_hash_candidates ; std::cerr << "RsPluginManager::loadList(): " << std::endl; RsFileHash reference_executable_hash ; std::list::iterator it; for(it = list.begin(); it != list.end(); it++) { RsConfigKeyValueSet *witem = dynamic_cast(*it) ; if(witem) for(std::list::const_iterator kit = witem->tlvkvs.pairs.begin(); kit != witem->tlvkvs.pairs.end(); ++kit) { if((*kit).key == "ALLOW_ALL_PLUGINS") { _allow_all_plugins = (kit->value == "YES"); if(_allow_all_plugins) std::cerr << "WARNING: Allowing all plugins. No hash will be checked. Be careful! " << std::endl ; } else if((*kit).key == "REFERENCE_EXECUTABLE_HASH") { reference_executable_hash = kit->value ; std::cerr << " Reference executable hash: " << kit->value << std::endl; } else if((*kit).key == "ACCEPTED") { accepted_hash_candidates.insert(RsFileHash((*kit).value)) ; std::cerr << " Accepted hash: " << (*kit).value << std::endl; } else if((*kit).key == "REJECTED") { rejected_hash_candidates.insert(RsFileHash((*kit).value)) ; std::cerr << " Rejected hash: " << (*kit).value << std::endl; } } delete (*it); } if(reference_executable_hash == _current_executable_hash) { std::cerr << "(II) Executable hash matches. Updating the list of accepted/rejected plugins." << std::endl; _accepted_hashes = accepted_hash_candidates ; _rejected_hashes = rejected_hash_candidates ; } else std::cerr << "(WW) Executable hashes do not match. Executable hash has changed. Discarding the list of accepted/rejected plugins." << std::endl; return true; } bool RsPluginManager::saveList(bool& cleanup, std::list& list) { std::cerr << "PluginManager: saving list." << std::endl; cleanup = true ; RsConfigKeyValueSet *witem = new RsConfigKeyValueSet ; RsTlvKeyValue kv; kv.key = "ALLOW_ALL_PLUGINS" ; kv.value = _allow_all_plugins?"YES":"NO" ; witem->tlvkvs.pairs.push_back(kv) ; kv.key = "REFERENCE_EXECUTABLE_HASH" ; kv.value = _current_executable_hash.toStdString() ; witem->tlvkvs.pairs.push_back(kv) ; std::cerr << " Saving current executable hash: " << kv.value << std::endl; // now push accepted and rejected hashes. for(std::set::const_iterator it(_accepted_hashes.begin());it!=_accepted_hashes.end();++it) { witem->tlvkvs.pairs.push_back( RsTlvKeyValue( "ACCEPTED", (*it).toStdString() ) ) ; std::cerr << " " << *it << " : " << "ACCEPTED" << std::endl; } for(std::set::const_iterator it(_rejected_hashes.begin());it!=_rejected_hashes.end();++it) { witem->tlvkvs.pairs.push_back( RsTlvKeyValue( "REJECTED", (*it).toStdString() ) ) ; std::cerr << " " << *it << " : " << "REJECTED" << std::endl; } list.push_back(witem) ; return true; } RsCacheService::RsCacheService(uint16_t service_type,uint32_t config_type,uint32_t tick_delay, RsPluginHandler* pgHandler) : CacheSource(service_type, true, pgHandler->getFileServer()->getCacheStrapper(), pgHandler->getLocalCacheDir()), CacheStore (service_type, true, pgHandler->getFileServer()->getCacheStrapper(), pgHandler->getFileServer()->getCacheTransfer(), pgHandler->getRemoteCacheDir()), p3Config(config_type), // CONFIG_TYPE_RANK_LINK _tick_delay_in_seconds(tick_delay) { } RsPQIService::RsPQIService(uint16_t service_type,uint32_t config_type,uint32_t /*tick_delay_in_seconds*/, RsPluginHandler* /*pgHandler*/) : p3Service(service_type),p3Config(config_type) { }