ModuleManager Class Reference

#include <ModuleManager.h>

Collaboration diagram for ModuleManager:

Public Member Functions
void	Initialize ()
int	Dispatch (ModuleDispatchTypes type)
bool	DiscoverProviders ()
auto	Providers () const
auto	Providers ()
bool	RegisterEffectPlugin (const PluginID &provider, const PluginPath &path, TranslatableString &errMsg)
PluginProvider *	CreateProviderInstance (const PluginID &provider, const PluginPath &path)
std::unique_ptr< ComponentInterface >	LoadPlugin (const PluginID &provider, const PluginPath &path)
bool	IsProviderValid (const PluginID &provider, const PluginPath &path)
bool	CheckPluginExist (const PluginID &providerId, const PluginPath &path)

Static Public Member Functions
static ModuleManager &	Get ()
static wxString	GetPluginTypeString ()
static PluginID	GetID (PluginProvider *provider)

Private Types
using	DelayedErrors = std::vector< std::pair< std::unique_ptr< Module >, wxString > >

Private Member Functions
	ModuleManager ()
	~ModuleManager ()
	ModuleManager (const ModuleManager &)=delete
ModuleManager &	operator= (const ModuleManager &)=delete
void	InitializeBuiltins ()

Static Private Member Functions
static void	FindModules (FilePaths &files)
static void	TryLoadModules (const FilePaths &files, FilePaths &decided, DelayedErrors &errors)

Private Attributes
PluginProviderHandlesMap	mProviders
std::vector< std::unique_ptr< Module > >	mModules

Static Private Attributes
static std::unique_ptr< ModuleManager >	mInstance {}

Friends
std::unique_ptr< ModuleManager >	std::make_unique ()

Detailed Description

Definition at line 85 of file ModuleManager.h.

Member Typedef Documentation

DelayedErrors

using ModuleManager::DelayedErrors = std::vector< std::pair< std::unique_ptr<Module>, wxString > >

private

Definition at line 103 of file ModuleManager.h.

Constructor & Destructor Documentation

ModuleManager() [1/2]

ModuleManager::ModuleManager ( )

private

Definition at line 210 of file ModuleManager.cpp.

{
}

~ModuleManager()

ModuleManager::~ModuleManager ( )

private

Definition at line 214 of file ModuleManager.cpp.

{
   mProviders.clear();
   builtinProviderList().clear();
}

References anonymous_namespace{ModuleManager.cpp}::builtinProviderList(), and mProviders.

Here is the call graph for this function:

ModuleManager() [2/2]

ModuleManager::ModuleManager ( const ModuleManager &  )

privatedelete

Member Function Documentation

CheckPluginExist()

bool ModuleManager::CheckPluginExist	(	const PluginID &	providerId,
		const PluginPath &	path
	)

Definition at line 525 of file ModuleManager.cpp.

{
   if(mProviders.find(providerId) == mProviders.end())
      return false;
 
   return mProviders[providerId]->CheckPluginExist(path);
}

References mProviders.

Referenced by PluginManager::InitializePlugins().

Here is the caller graph for this function:

CreateProviderInstance()

PluginProvider * ModuleManager::CreateProviderInstance	(	const PluginID &	provider,
		const PluginPath &	path
	)

Definition at line 504 of file ModuleManager.cpp.

{
   if (path.empty() && mProviders.find(providerID) != mProviders.end())
   {
      return mProviders[providerID].get();
   }
 
   return nullptr;
}

References mProviders.

Referenced by PluginManager::IsPluginAvailable(), and PluginManager::Load().

Here is the caller graph for this function:

DiscoverProviders()

bool ModuleManager::DiscoverProviders

(

)

Definition at line 437 of file ModuleManager.cpp.

{
   InitializeBuiltins();
 
// The commented out code loads modules whether or not they are enabled.
// none of our modules is a 'provider' of effects, so this code commented out. 
#if 0
   FilePaths provList;
   FilePaths pathList;
 
   // Code from LoadLadspa that might be useful in load modules.
   wxString pathVar = wxString::FromUTF8(getenv("AUDACITY_MODULES_PATH"));
 
   if (!pathVar.empty())
   {
      FileNames::AddMultiPathsToPathList(pathVar, pathList);
   }
   else
   {
      FileNames::AddUniquePathToPathList(FileNames::ModulesDir(), pathList);
   }
 
#if defined(__WXMSW__)
   FileNames::FindFilesInPathList(wxT("*.dll"), pathList, provList);
#elif defined(__WXMAC__)
   FileNames::FindFilesInPathList(wxT("*.dylib"), pathList, provList);
#else
   FileNames::FindFilesInPathList(wxT("*.so"), pathList, provList);
#endif
 
   for ( const auto &path : provList )
      LoadModule(path);
#endif
 
   return true;
}

References FileNames::AddMultiPathsToPathList(), FileNames::AddUniquePathToPathList(), FileNames::FindFilesInPathList(), InitializeBuiltins(), FileNames::ModulesDir(), and wxT().

Here is the call graph for this function:

Dispatch()

int ModuleManager::Dispatch

(

ModuleDispatchTypes

type

)

Definition at line 377 of file ModuleManager.cpp.

{
   for (const auto &module: mModules) {
      module->Dispatch(type);
   }
   return 0;
}

References mModules.

Referenced by AudacityApp::InitPart2(), ProjectManager::New(), ProjectManager::OnCloseWindow(), and QuitAudacity().

Here is the caller graph for this function:

FindModules()

void ModuleManager::FindModules ( FilePaths &  files )

staticprivate

Definition at line 221 of file ModuleManager.cpp.

{
   const auto &audacityPathList = FileNames::AudacityPathList();
   FilePaths pathList;
   wxString pathVar;
 
   // Code from LoadLadspa that might be useful in load modules.
   pathVar = wxGetenv(wxT("AUDACITY_MODULES_PATH"));
   if (!pathVar.empty())
      FileNames::AddMultiPathsToPathList(pathVar, pathList);
 
   for (const auto &path : audacityPathList) {
      wxString prefix = path + wxFILE_SEP_PATH;
      FileNames::AddUniquePathToPathList(prefix + wxT("modules"),
                                         pathList);
      if (files.size()) {
         break;
      }
   }
 
   #if defined(__WXMSW__)
   FileNames::FindFilesInPathList(wxT("*.dll"), pathList, files);
   #else
   FileNames::FindFilesInPathList(wxT("*.so"), pathList, files);
   #endif
}

References FileNames::AddMultiPathsToPathList(), FileNames::AddUniquePathToPathList(), FileNames::AudacityPathList(), FileNames::FindFilesInPathList(), and wxT().

Referenced by Initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

Get()

ModuleManager & ModuleManager::Get ( )

static

Definition at line 414 of file ModuleManager.cpp.

{
   if (!mInstance)
      mInstance = std::make_unique<ModuleManager>();
 
   return *mInstance;
}

References mInstance.

Referenced by PluginDataModel::ApplyChanges(), PluginManager::CheckPluginUpdates(), PluginManager::ClearEffectPlugins(), anonymous_namespace{PluginHost.cpp}::Discover(), PluginManager::DropFile(), PluginManager::Initialize(), PluginManager::InitializePlugins(), AudacityApp::InitPart2(), PluginManager::IsPluginAvailable(), PluginManager::Load(), ProjectManager::New(), ProjectManager::OnCloseWindow(), PluginHost::PluginHost(), PluginRegistrationDialog::PopulateOrExchange(), QuitAudacity(), and TryLoadModules().

Here is the caller graph for this function:

GetID()

PluginID ModuleManager::GetID ( PluginProvider *  provider )

static

Definition at line 427 of file ModuleManager.cpp.

{
   return wxString::Format(wxT("%s_%s_%s_%s_%s"),
                           GetPluginTypeString(),
                           wxEmptyString,
                           provider->GetVendor().Internal(),
                           provider->GetSymbol().Internal(),
                           provider->GetPath());
}

References ComponentInterface::GetPath(), GetPluginTypeString(), ComponentInterface::GetSymbol(), ComponentInterface::GetVendor(), ComponentInterfaceSymbol::Internal(), and wxT().

Referenced by PluginManager::GetID(), and InitializeBuiltins().

Here is the call graph for this function:

Here is the caller graph for this function:

GetPluginTypeString()

wxString ModuleManager::GetPluginTypeString ( )

static

Definition at line 422 of file ModuleManager.cpp.

{
   return L"Module";
}

Referenced by GetID(), and PluginManager::GetPluginTypeString().

Here is the caller graph for this function:

Initialize()

void ModuleManager::Initialize

(

)

Definition at line 350 of file ModuleManager.cpp.

{
   FilePaths files;
   FindModules(files);
 
   FilePaths decided;
   DelayedErrors errors;
   size_t numDecided = 0;
 
   // Multiple passes give modules multiple chances to load in case they
   // depend on some other module not yet loaded
   do {
      numDecided = decided.size();
      errors.clear();
      TryLoadModules(files, decided, errors);
   }
   while ( errors.size() && numDecided < decided.size() );
 
   // Only now show accumulated errors of modules that failed to load
   for ( const auto &pair : errors ) {
      auto &pModule = pair.first;
      pModule->ShowLoadFailureError(pair.second);
      ModuleSettings::SetModuleStatus( pModule->GetName(), kModuleFailed );
   }
}

References FindModules(), kModuleFailed, ModuleSettings::SetModuleStatus(), and TryLoadModules().

Referenced by AudacityApp::InitPart2().

Here is the call graph for this function:

Here is the caller graph for this function:

InitializeBuiltins()

void ModuleManager::InitializeBuiltins ( )

private

Definition at line 474 of file ModuleManager.cpp.

{
   for (const auto& pluginProviderFactory : builtinProviderList())
   {
      auto pluginProvider = pluginProviderFactory();
      
      if (pluginProvider && pluginProvider->Initialize()) {
         PluginProviderUniqueHandle handle { std::move(pluginProvider) };
         
         auto id = GetID(handle.get());
 
         // Need to remember it 
         mProviders[id] = std::move(handle);
      }
   }
}

References anonymous_namespace{ModuleManager.cpp}::builtinProviderList(), GetID(), id, and mProviders.

Referenced by DiscoverProviders().

Here is the call graph for this function:

Here is the caller graph for this function:

IsProviderValid()

bool ModuleManager::IsProviderValid	(	const PluginID &	provider,
		const PluginPath &	path
	)

Definition at line 533 of file ModuleManager.cpp.

{
   // Builtin modules do not have a path
   if (path.empty())
   {
      return true;  
   }
 
   wxFileName lib(path);
   if (lib.FileExists() || lib.DirExists())
   {
      return true;
   }
 
   return false;
}

LoadPlugin()

std::unique_ptr< ComponentInterface > ModuleManager::LoadPlugin	(	const PluginID &	provider,
		const PluginPath &	path
	)

Definition at line 515 of file ModuleManager.cpp.

{
   if (auto iter = mProviders.find(providerID);
       iter == mProviders.end())
      return nullptr;
   else
      return iter->second->LoadPlugin(path);
}

References mProviders.

operator=()

ModuleManager & ModuleManager::operator= ( const ModuleManager &  )

privatedelete

Providers() [1/2]

auto ModuleManager::Providers ( )

inline

Definition at line 120 of file ModuleManager.h.

   { return make_iterator_range(mProviders.begin(), mProviders.end()); }

References make_iterator_range().

Here is the call graph for this function:

Providers() [2/2]

auto ModuleManager::Providers ( ) const

inline

Definition at line 117 of file ModuleManager.h.

   { return make_iterator_range(mProviders.cbegin(), mProviders.cend()); }

References make_iterator_range().

Here is the call graph for this function:

RegisterEffectPlugin()

bool ModuleManager::RegisterEffectPlugin	(	const PluginID &	provider,
		const PluginPath &	path,
		TranslatableString &	errMsg
	)

Definition at line 491 of file ModuleManager.cpp.

{
   errMsg = {};
   if (mProviders.find(providerID) == mProviders.end())
   {
      return false;
   }
 
   auto nFound = mProviders[providerID]->DiscoverPluginsAtPath(path, errMsg, PluginManagerInterface::DefaultRegistrationCallback);
 
   return nFound > 0;
}

References PluginManagerInterface::DefaultRegistrationCallback(), and mProviders.

Here is the call graph for this function:

TryLoadModules()

void ModuleManager::TryLoadModules ( const FilePaths &  files, FilePaths &  decided, DelayedErrors &  errors  )

staticprivate

Definition at line 248 of file ModuleManager.cpp.

{
   FilePaths checked;
   wxString saveOldCWD = ::wxGetCwd();
   auto cleanup = finally([&]{ ::wxSetWorkingDirectory(saveOldCWD); });
   for (const auto &file : files) {
      // As a courtesy to some modules that might be bridges to
      // open other modules, we set the current working
      // directory to be the module's directory.
      auto prefix = ::wxPathOnly(file);
      ::wxSetWorkingDirectory(prefix);
 
      // Only process the first module encountered in the
      // defined search sequence.
      wxString ShortName = wxFileName( file ).GetName();
      if( checked.Index( ShortName, false ) != wxNOT_FOUND )
         continue;
      checked.Add( ShortName );
 
      // Skip if a previous pass through this function decided it already
      if( decided.Index( ShortName, false ) != wxNOT_FOUND )
         continue;
 
      int iModuleStatus = ModuleSettings::GetModuleStatus( file );
      if( iModuleStatus == kModuleDisabled )
         continue;
      if( iModuleStatus == kModuleFailed )
         continue;
      // New module?  You have to go and explicitly enable it.
      if( iModuleStatus == kModuleNew ){
         // To ensure it is noted in config file and so
         // appears on modules page.
         ModuleSettings::SetModuleStatus( file, kModuleNew);
         continue;
      }
 
      if( iModuleStatus == kModuleAsk )
      // JKC: I don't like prompting for the plug-ins individually
      // I think it would be better to show the module prefs page,
      // and let the user decide for each one.
      {
         auto msg = XO("Module \"%s\" found.").Format( ShortName );
         msg += XO("\n\nOnly use modules from trusted sources");
         const TranslatableStrings buttons{
            XO("Yes"), XO("No"),
         };  // could add a button here for 'yes and remember that', and put it into the cfg file.  Needs more thought.
         int action = BasicUI::ShowMultiDialog(msg,
            XO("Audacity Module Loader"),
            buttons,
            "",
            XO("Try and load this module?"),
            false);
         // If we're not prompting always, accept the answer permanently
         if( iModuleStatus == kModuleNew ){
            iModuleStatus = (action==1)?kModuleDisabled : kModuleEnabled;
            ModuleSettings::SetModuleStatus( file, iModuleStatus );
         }
         if(action == 1){   // "No"
            decided.Add( ShortName );
            continue;
         }
      }
      // Before attempting to load, we set the state to bad.
      // That way, if we crash, we won't try again.
      ModuleSettings::SetModuleStatus( file, kModuleFailed );
 
      wxString Error;
      auto umodule = std::make_unique<Module>(file);
         if (umodule->Load(Error))   // it will get rejected if there are version problems
      {
         decided.Add( ShortName );
         auto module = umodule.get();
 
         if (!module->HasDispatch())
         {
            auto ShortName = wxFileName(file).GetName();
            DoMessageBox(
               XO("The module \"%s\" does not provide any of the required functions.\n\nIt will not be loaded.")
                  .Format(ShortName));
            wxLogMessage(wxT("The module \"%s\" does not provide any of the required functions. It will not be loaded."), file);
            module->Unload();
         }
         else
         {
            Get().mModules.push_back(std::move(umodule));
 
            // Loaded successfully, restore the status.
            ModuleSettings::SetModuleStatus(file, iModuleStatus);
         }
      }
      else if (!Error.empty()) {
         // Module is not yet decided in this pass.
         // Maybe it depends on another which has not yet been loaded.
         // But don't take the kModuleAsk path again in a later pass.
         ModuleSettings::SetModuleStatus( file, kModuleEnabled );
         errors.emplace_back( std::move( umodule ), Error );
      }
   }
}

References DoMessageBox(), Error, Get(), ModuleSettings::GetModuleStatus(), kModuleAsk, kModuleDisabled, kModuleEnabled, kModuleFailed, kModuleNew, mModules, ModuleSettings::SetModuleStatus(), BasicUI::ShowMultiDialog(), wxT(), and XO().

Referenced by Initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

std::make_unique

std::unique_ptr< ModuleManager > std::make_unique ( )

friend

Member Data Documentation

mInstance

std::unique_ptr< ModuleManager > ModuleManager::mInstance {}

staticprivate

Definition at line 146 of file ModuleManager.h.

Referenced by Get().

mModules

std::vector<std::unique_ptr<Module> > ModuleManager::mModules

private

Definition at line 155 of file ModuleManager.h.

Referenced by Dispatch(), and TryLoadModules().

mProviders

PluginProviderHandlesMap ModuleManager::mProviders

private

Definition at line 151 of file ModuleManager.h.

Referenced by CheckPluginExist(), CreateProviderInstance(), InitializeBuiltins(), LoadPlugin(), RegisterEffectPlugin(), and ~ModuleManager().

---

The documentation for this class was generated from the following files:

• ModuleManager.h
• ModuleManager.cpp