/*
* This file is part of Code::Blocks Studio, an open-source cross-platform IDE
* Copyright (C) 2003 Yiannis An. Mandravellos
*
* This program 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 2 of the License, or
* (at your option) any later version.
*
* This program 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 this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Contact e-mail: Yiannis An. Mandravellos <mandrav@codeblocks.org>
* Program URL : http://www.codeblocks.org
*
* $Id: pluginmanager.cpp,v 1.27.2.1 2005/10/25 07:59:03 mandrav Exp $
* $Date: 2005/10/25 07:59:03 $
*/
#include "sdk_precomp.h"
#include <wx/string.h>
#include <wx/dir.h>
#include <wx/menu.h>
#include <wx/dynlib.h>
#include <wx/intl.h>
#include "cbexception.h" // class's header file
#include "pluginmanager.h" // class's header file
#include "cbplugin.h"
#include "messagemanager.h"
#include "manager.h"
#include "editormanager.h"
#include "pluginsconfigurationdlg.h"
#include "configmanager.h"
#include "managerproxy.h"
#include "personalitymanager.h"
PluginManager* PluginManager::Get()
{
if(Manager::isappShuttingDown()) // The mother of all sanity checks
PluginManager::Free();
else
if (!PluginManagerProxy::Get())
{
PluginManagerProxy::Set( new PluginManager() );
Manager::Get()->GetMessageManager()->Log(_("PluginManager initialized"));
}
return PluginManagerProxy::Get();
}
void PluginManager::Free()
{
if (PluginManagerProxy::Get())
{
delete PluginManagerProxy::Get();
PluginManagerProxy::Set( 0L );
}
}
// class constructor
PluginManager::PluginManager()
{
SC_CONSTRUCTOR_BEGIN
const wxString& personalityKey = Manager::Get()->GetPersonalityManager()->GetPersonalityKey();
ConfigManager::AddConfiguration(_("Plugin Manager"), _T("/plugins"));
if (!personalityKey.IsEmpty())
ConfigManager::AddConfiguration(_("Plugin Manager"), personalityKey + _T("/plugins"));
}
// class destructor
PluginManager::~PluginManager()
{
SC_DESTRUCTOR_BEGIN
UnloadAllPlugins();
SC_DESTRUCTOR_END
}
void PluginManager::CreateMenu(wxMenuBar* menuBar)
{
SANITY_CHECK();
}
void PluginManager::ReleaseMenu(wxMenuBar* menuBar)
{
SANITY_CHECK();
}
int PluginManager::ScanForPlugins(const wxString& path)
{
SANITY_CHECK(0);
#ifdef __WXMSW__
#define PLUGINS_MASK _T("*.dll")
#else
#define PLUGINS_MASK _T("*.so")
#endif
int count = 0;
wxDir dir(path);
if (!dir.IsOpened())
return count;
wxString filename;
wxString failed;
bool ok = dir.GetFirst(&filename, PLUGINS_MASK, wxDIR_FILES);
while (ok)
{
// Manager::Get()->GetMessageManager()->AppendDebugLog(_("Trying %s: "), filename.c_str());
if (LoadPlugin(path + _T('/') + filename))
++count;
else
failed << filename << _T(" ");
ok = dir.GetNext(&filename);
}
if (!failed.IsEmpty())
Manager::Get()->GetMessageManager()->Log(_("*****\nPlugins that failed to load: %s\n*****"), failed.c_str());
return count;
#undef PLUGINS_MASK
}
cbPlugin* PluginManager::LoadPlugin(const wxString& pluginName)
{
SANITY_CHECK(0L);
wxLogNull zero; // no need for error messages; we check everything ourselves...
//MessageManager* msgMan = Manager::Get()->GetMessageManager();
wxDynamicLibrary* lib = new wxDynamicLibrary();
lib->Load(pluginName);
if (!lib->IsLoaded())
{
//msgMan->DebugLog(_("not loaded (file exists?)"));
delete lib;
return 0L;
}
// first get the SDK version entry points
GetSDKVersionMajorProc majorproc = (GetSDKVersionMajorProc)lib->GetSymbol(_T("GetSDKVersionMajor"));
GetSDKVersionMinorProc minorproc = (GetSDKVersionMinorProc)lib->GetSymbol(_T("GetSDKVersionMinor"));
// if no SDK version entry points, abort
if (!majorproc || !minorproc)
{
//msgMan->DebugLog(_("no SDK version entry points"));
delete lib;
return 0L;
}
// check if it is the correct SDK version
if (majorproc() != PLUGIN_SDK_VERSION_MAJOR ||
minorproc() != PLUGIN_SDK_VERSION_MINOR)
{
// in this case, inform the user...
wxString fmt;
fmt.Printf(_("The plugin \"%s\" failed to load because it was built with a different Code::Blocks SDK version:\n\n"
"Plugin's SDK version: %d.%d\n"
"Your SDK version: %d.%d"),
pluginName.c_str(),
majorproc(),
minorproc(),
PLUGIN_SDK_VERSION_MAJOR,
PLUGIN_SDK_VERSION_MINOR);
wxMessageBox(fmt, _("Error loading plugin"), wxICON_ERROR);
lib->Unload();
delete lib;
return 0L;
}
// get the plugin's entry point
GetPluginProc proc = (GetPluginProc)lib->GetSymbol(_T("GetPlugin"));
if (!proc)
{
lib->Unload();
delete lib;
//msgMan->DebugLog(_("not a plugin"));
return 0L;
}
// try to load the plugin
cbPlugin* plug = 0L;
try
{
plug = proc();
}
catch (cbException& exception)
{
exception.ShowErrorMessage(false);
lib->Unload();
delete lib;
return 0L;
}
// check if we have already loaded a plugin by that name
wxString plugName = plug->GetInfo()->name;
if (FindPluginByName(plugName))
{
//msgMan->DebugLog(_("another plugin with name \"%s\" is already loaded..."), plugName.c_str());
lib->Unload();
delete lib;
return 0L;
}
PluginElement* plugElem = new PluginElement;
plugElem->fileName = pluginName;
plugElem->name = plugName;
plugElem->library = lib;
plugElem->plugin = plug;
m_Plugins.Add(plugElem);
//msgMan->DebugLog(_("loaded %s"), plugName.c_str());
return plug;
}
void PluginManager::LoadAllPlugins()
{
SANITY_CHECK();
const wxString& personalityKey = Manager::Get()->GetPersonalityManager()->GetPersonalityKey();
// check if a plugin crashed the app last time
wxString probPlugin = ConfigManager::Get()->Read(personalityKey + _T("/plugins/try_to_activate"), wxEmptyString);
if (!probPlugin.IsEmpty())
{
wxString msg;
msg.Printf(_("Plugin \"%s\" failed to load last time Code::Blocks was executed.\n"
"Do you want to disable this plugin from loading?"), probPlugin.c_str());
if (wxMessageBox(msg, _("Warning"), wxICON_WARNING | wxYES_NO) == wxNO)
probPlugin = _T("");
}
for (unsigned int i = 0; i < m_Plugins.GetCount(); ++i)
{
cbPlugin* plug = m_Plugins[i]->plugin;
// do not load it if the user has explicitly asked not to...
wxString baseKey;
baseKey << personalityKey << _T("/plugins/") << m_Plugins[i]->name;
bool loadIt = ConfigManager::Get()->Read(baseKey, true);
// if we have a problematic plugin, check if this is it
if (loadIt && !probPlugin.IsEmpty())
{
loadIt = plug->GetInfo()->title != probPlugin;
// if this is the problematic plugin, don't load it
if (!loadIt)
ConfigManager::Get()->Write(baseKey, false);
}
if (loadIt && !plug->IsAttached())
{
ConfigManager::Get()->Write(personalityKey + _T("/plugins/try_to_activate"), plug->GetInfo()->title);
Manager::Get()->GetMessageManager()->AppendLog(_("%s "), m_Plugins[i]->name.c_str());
try
{
plug->Attach();
ConfigManager::Get()->DeleteEntry(personalityKey + _T("/plugins/try_to_activate"));
}
catch (cbException& exception)
{
Manager::Get()->GetMessageManager()->AppendLog(_T("[failed] "));
exception.ShowErrorMessage(false);
wxString msg;
msg.Printf(_("Plugin \"%s\" failed to load...\n"
"Do you want to disable this plugin from loading next time?"), plug->GetInfo()->title.c_str());
if (wxMessageBox(msg, _("Warning"), wxICON_WARNING | wxYES_NO) == wxYES)
ConfigManager::Get()->Write(baseKey, false);
}
}
}
Manager::Get()->GetMessageManager()->Log(_T(""));
wxLogNull ln;
ConfigManager::Get()->DeleteEntry(personalityKey + _T("/plugins/try_to_activate"));
}
void PluginManager::UnloadAllPlugins()
{
SANITY_CHECK_ADVANCED(); // don't use "normal" sanity check because
// this function is called by the destructor
// Manager::Get()->GetMessageManager()->DebugLog("Count %d", m_Plugins.GetCount());
unsigned int i = m_Plugins.GetCount();
while (i > 0)
{
--i;
// Manager::Get()->GetMessageManager()->DebugLog(_("At %d"), i);
cbPlugin* plug = m_Plugins[i]->plugin;
if (!plug)
continue;
// Manager::Get()->GetMessageManager()->DebugLog(_("Doing '%s'"), m_Plugins[i]->name.c_str());
plug->Release(true);
//it->first->library->Unload();
// Manager::Get()->GetMessageManager()->DebugLog(_("Plugin '%s' unloaded"), m_Plugins[i]->name.c_str());
// FIXME: find a way to delete the toolbars too...
}
}
cbPlugin* PluginManager::FindPluginByName(const wxString& pluginName)
{
SANITY_CHECK(0L);
for (unsigned int i = 0; i < m_Plugins.GetCount(); ++i)
{
PluginElement* plugElem = m_Plugins[i];
if (plugElem->name == pluginName)
return m_Plugins[i]->plugin;
}
return NULL;
}
cbPlugin* PluginManager::FindPluginByFileName(const wxString& pluginFileName)
{
SANITY_CHECK(0L);
for (unsigned int i = 0; i < m_Plugins.GetCount(); ++i)
{
PluginElement* plugElem = m_Plugins[i];
if (plugElem->fileName == pluginFileName)
return m_Plugins[i]->plugin;
}
return NULL;
}
const PluginInfo* PluginManager::GetPluginInfo(const wxString& pluginName)
{
SANITY_CHECK(0L);
cbPlugin* plug = FindPluginByName(pluginName);
if (plug)
return plug->GetInfo();
return NULL;
}
int PluginManager::ExecutePlugin(const wxString& pluginName)
{
SANITY_CHECK(0);
cbPlugin* plug = FindPluginByName(pluginName);
if (plug)
{
if (plug->GetType() != ptTool)
{
MessageManager* msgMan = Manager::Get()->GetMessageManager();
msgMan->DebugLog(_("Plugin %s is not a tool to have Execute() method!"), plug->GetInfo()->name.c_str());
}
else
{
try
{
return ((cbToolPlugin*)plug)->Execute();
}
catch (cbException& exception)
{
exception.ShowErrorMessage(false);
}
}
}
return 0;
}
int PluginManager::ConfigurePlugin(const wxString& pluginName)
{
SANITY_CHECK(0);
cbPlugin* plug = FindPluginByName(pluginName);
if (plug)
{
try
{
return plug->Configure();
}
catch (cbException& exception)
{
exception.ShowErrorMessage(false);
}
}
return 0;
}
PluginsArray PluginManager::GetToolOffers()
{
return GetOffersFor(ptTool);
}
PluginsArray PluginManager::GetMimeOffers()
{
return GetOffersFor(ptMime);
}
PluginsArray PluginManager::GetCompilerOffers()
{
return GetOffersFor(ptCompiler);
}
PluginsArray PluginManager::GetCodeCompletionOffers()
{
return GetOffersFor(ptCodeCompletion);
}
PluginsArray PluginManager::GetOffersFor(PluginType type)
{
PluginsArray arr;
SANITY_CHECK(arr);
// special case for MIME plugins
// we 'll add the default MIME handler, last in the returned array
cbPlugin* dflt = 0;
for (unsigned int i = 0; i < m_Plugins.GetCount(); ++i)
{
cbPlugin* plug = m_Plugins[i]->plugin;
if (plug->IsAttached() && plug->GetType() == type)
{
if (type == ptMime)
{
// default MIME handler?
if (((cbMimePlugin*)plug)->HandlesEverything())
dflt = plug;
else
arr.Add(plug);
}
else
arr.Add(plug);
}
}
// add default MIME handler last
if (dflt)
arr.Add(dflt);
return arr;
}
void PluginManager::AskPluginsForModuleMenu(const ModuleType type, wxMenu* menu, const wxString& arg)
{
SANITY_CHECK();
for (unsigned int i = 0; i < m_Plugins.GetCount(); ++i)
{
cbPlugin* plug = m_Plugins[i]->plugin;
if (plug)
{
try
{
plug->BuildModuleMenu(type, menu, arg);
}
catch (cbException& exception)
{
exception.ShowErrorMessage(false);
}
}
}
}
void PluginManager::NotifyPlugins(CodeBlocksEvent& event)
{
SANITY_CHECK();
/*
A plugin might process the event we 'll send it or not. The event then
"travels" up the chain of plugins. If one plugin (say in the middle) is
disabled, it's not processing events and so the event "travelling" stops.
The rest of the plugins never "hear" about this event.
The solution is that the plugin manager checks for disabled plugins and
posts the event not only to the last plugin but also to all plugins that
are followed by a disabled plugin (skipping the chain-breakers that is)...
*/
if (!m_Plugins.GetCount())
return;
bool sendEvt = true;
for (unsigned int i = m_Plugins.GetCount() - 1; i > 0; --i)
{
cbPlugin* plug = m_Plugins[i]->plugin;
if (!plug || (plug && !plug->IsAttached()))
sendEvt = true;
else if (sendEvt)
{
plug->ProcessEvent(event); // Plugins require immediate attention
// wxPostEvent(plug, event);
sendEvt = false;
}
}
}
cbMimePlugin* PluginManager::GetMIMEHandlerForFile(const wxString& filename)
{
PluginsArray mimes = GetMimeOffers();
for (unsigned int i = 0; i < mimes.GetCount(); ++i)
{
cbMimePlugin* plugin = (cbMimePlugin*)mimes[i];
if (plugin && plugin->CanHandleFile(filename))
return plugin;
}
return 0;
}
int PluginManager::Configure()
{
SANITY_CHECK(wxID_CANCEL);
PluginsConfigurationDlg dlg(Manager::Get()->GetAppWindow());
if (dlg.ShowModal() == wxID_CANCEL)
return wxID_CANCEL;
// mandrav: disabled on-the-fly plugins enabling/disabling (still has glitches)
/*
for (unsigned int i = 0; i < m_Plugins.GetCount(); ++i)
{
cbPlugin* plug = m_Plugins[i]->plugin;
// do not load it if the user has explicitely asked not to...
wxString baseKey;
baseKey << _T("/plugins/") << m_Plugins[i]->name;
bool loadIt = ConfigManager::Get()->Read(baseKey, true);
if (!loadIt && plug->IsAttached())
plug->Release(false);
else if (loadIt && !plug->IsAttached())
{
ConfigManager::Get()->Write(_("/plugins/try_to_activate"), plug->GetInfo()->title);
plug->Attach();
}
}
wxLogNull ln;
ConfigManager::Get()->DeleteEntry(_T("/plugins/try_to_activate"));
*/
return wxID_OK;
}
syntax highlighted by Code2HTML, v. 0.9.1