PluginManager Class Reference

#include <PluginManager.h>

Public Member Functions
	PluginManager (HINSTANCE)
	~PluginManager ()
bool	LoadPlugin (LPSTR pluginPath)
bool	StartPlugin (HMODULE hModule, LPSTR pluginPath, bool dockingEnabled)
void	UnloadPlugin (LPSTR pluginPath, int pluginNumber)
void	UpdatePlugin (LPSTR pluginPath, int pluginNumber, bool forceUpdate)
void	AboutPlugins ()
LPCSTR	GetPluginInfo (int pluginNumber, int infoParam)
bool	WritePluginsRC ()
void	LoadPluginDialog ()
bool	IsPluginLoaded (LPSTR pluginPath)

Public Attributes
PluginsVector	pluginList
bool	startupLock
char	pluginName [MAX_LINE_LENGTH]
HINSTANCE	hModule
beginPluginExFunc	beginPluginEx
beginPluginFunc	beginPlugin
beginSlitPluginFunc	beginSlitPlugin
endPluginFunc	endPlugin
pluginInfoFunc	pluginInfo

Constructor & Destructor Documentation

PluginManager()

PluginManager::PluginManager

(

HINSTANCE

hMainInstance

)

{
    char szBuffer[MAX_LINE_LENGTH]="";
 
    startupLock = true;
 
    // SAFE MODE: Hold down control to disable loading of plugins at startup
    // ### Beware! -> Do not load any plugins when running in safe mode or you
    // will overwrite the contents of your plugins.rc! ###
    if (!(GetAsyncKeyState(VK_CONTROL) & 0x8000))
    {
        FILE *f = FileOpen(plugrcPath());
        while (ReadNextCommand(f, szBuffer, sizeof(szBuffer))) LoadPlugin(szBuffer);
        FileClose(f);
    }
    else SendMessage(GetBBWnd(), BB_CONSOLEMESSAGE, (WPARAM)CONSOLE_WARNING_MESSAGE, (LPARAM)"Safe mode: Holding down the Ctrl key disables loading of plugins at startup.");
 
    //====================
 
    if (!pluginList.empty())
    {
        char szCurrentPlugin[MAX_LINE_LENGTH] = "", szPreviousPlugin[MAX_LINE_LENGTH] = "";
        char szMultiplier[10];
        int numberOfInstances = 1;
 
        // Display the names of all loaded plugins in the console...
        // (nb. grouped together if more than one plugin of the same name is loaded in succession)
        strcpy(szBuffer, "Loading plugins -> ");
        for (int i=0; i < (int)pluginList.size(); i++)
        {
            pluginInfo = (pluginInfoFunc)GetProcAddress(pluginList[i].hModule, "pluginInfo");
            if (pluginInfo)
            {
                strcpy(szCurrentPlugin, pluginInfo(PLUGIN_NAME));
 
                if (!_stricmp(szCurrentPlugin, szPreviousPlugin))
                {
                    numberOfInstances++;
                    continue;
                }
                else
                {
                    if (numberOfInstances > 1)
                    {
                        sprintf(szMultiplier, " x %d", numberOfInstances);
                        strcat(szBuffer, szMultiplier);
                        numberOfInstances = 1;
                    }
 
                    if (i > 0) strcat(szBuffer, " | ");
                    strcat(szBuffer, szCurrentPlugin);
 
                    strcpy(szPreviousPlugin, szCurrentPlugin);
                }
            }
            else // Extract name from file name...
            {
                char pluginName[MAX_PATH];
                strcpy(pluginName, pluginList[i].path);
                int n = GetParentFolder(pluginName);
                strcpy(pluginName, &pluginList[i].path[n]);
                PathRemoveExtension(pluginName);
                if (i > 0) strcat(szBuffer, " | ");
                strcat(szBuffer, pluginName);
            }
        }
 
        if (numberOfInstances > 1)
        {
            sprintf(szMultiplier, " x %d", numberOfInstances);
            strcat(szBuffer, szMultiplier);
        }
 
        SendMessage(GetBBWnd(), BB_CONSOLEMESSAGE, (WPARAM)CONSOLE_REGULAR_MESSAGE, (LPARAM)szBuffer);
    }
 
    //====================
 
    startupLock = false;
    pSettings->checkingForUpdates = false;
 
    // Automatic checking for updates at startup? (note: call later moved to Blackbox.cpp, kept here only for reference)
//  if (_stricmp(pSettings->checkedForUpdates, "*Disabled*")) _beginthread(periodicCheckForUpdates, 0, NULL);
}

~PluginManager()

PluginManager::~PluginManager

(

)

{
    for (int i=0; i < (int)pluginList.size(); i++)
    {
        endPlugin = (endPluginFunc)GetProcAddress(pluginList[i].hModule, "endPlugin");
        endPlugin(pluginList[i].hModule);
        FreeLibrary(pluginList[i].hModule);
    }
 
    pluginList.clear();
}

Member Function Documentation

LoadPlugin()

bool PluginManager::LoadPlugin

(

LPSTR

pluginPath

)

{
    char msg[MAX_LINE_LENGTH];
 
    //====================
    
    if (strchr(pluginPath, '\"')) StrRemoveEncap(pluginPath);
    if (strchr(pluginPath, '$')) ReplaceShellFolders(pluginPath);
    if (strchr(pluginPath, '%')) ReplaceEnvVars(pluginPath);
    
    if (IsInString(pluginPath, "BBSystemBar.dll") ||      // Do not load the BBSystemBar plugin (integrated functionality in xoblite)
        IsInString(pluginPath, "BBSystemBarEx.dll") ||        // Do not load the BBSystemBarEx plugin (similar to integrated functionality in xoblite)
        IsInString(pluginPath, "SystemBarEx.dll") ||      // Do not load the SystemBarEx plugin (similar to integrated functionality in xoblite)
        IsInString(pluginPath, "BBSlit.dll") ||               // Do not load the BBSlit plugin (integrated functionality in xoblite)
        IsInString(pluginPath, "BBKeys.dll") ||               // Do not load the BBKeys plugin (integrated functionality in xoblite)
        IsInString(pluginPath, "RandomStyle.dll") ||      // Do not load the RandomStyle plugin (integrated functionality in xoblite)
        IsInString(pluginPath, "BBDDE.dll"))              // Do not load the BBDDE plugin (integrated functionality in xoblite)
    {
        strcpy(msg, "The following plugins are automatically excluded   \n"
            "because the functionality they provide (or similar   \n"
            "functionality) is already part of xoblite itself:   \n\n"
            "BBSystemBar\nBBSystemBarEx/SystemBarEx\nBBSlit\nBBKeys\nRandomStyle\nBBDDE   \n");
        MessageBox(GetBBWnd(), msg, "xoblite", MB_OK | MB_ICONINFORMATION | MB_TOPMOST);
        return false;
    }
 
    //====================
 
    // Check if this particular plugin has already been loaded...
 
    char dllName[MAX_LINE_LENGTH], dllTempName[MAX_LINE_LENGTH];
    strcpy(dllName, pluginPath);
    int nLen = strlen(dllName) - 1;
    if (IsInString(dllName, "/")) while (nLen >0 && dllName[nLen] != '/') nLen--;
    else while (nLen >0 && dllName[nLen] != '\\') nLen--;
    strcpy(dllName, &pluginPath[nLen+1]);
 
    for (int i=0; i < (int)pluginList.size(); i++)
    {
        strcpy(dllTempName, pluginList[i].path);
        nLen = strlen(dllTempName) - 1;
        if (IsInString(dllTempName, "/")) while ((nLen > 0) && (dllTempName[nLen] != '/')) nLen--;
        else while ((nLen > 0) && (dllTempName[nLen] != '\\')) nLen--;
        strcpy(dllTempName, &pluginList[i].path[nLen+1]);
 
        if (!_stricmp(dllName, dllTempName))
        {
            strcpy(msg, pluginPath);
            strcat(msg, "   \n\nThis plugin is already loaded.   ");
            MessageBox(GetBBWnd(), msg, "xoblite", MB_OK | MB_ICONINFORMATION | MB_TOPMOST);
            return false;
        }
    }
 
    //====================
 
    bool dockingEnabled;
 
    if (pluginPath[0] == '&') // dock plugin?
    {
        dockingEnabled = true;
        hModule = LoadLibrary(&pluginPath[1]);
    }
    else // normal plugin
    {
        dockingEnabled = false;
        hModule = LoadLibrary(pluginPath);
    }
 
    if (hModule)
    {
        if (StartPlugin(hModule, pluginPath, dockingEnabled))
        {
            pluginItem plg;
            plg.hModule = hModule;
            plg.DockingEnabled = dockingEnabled;
            strcpy(plg.path, pluginPath);
            plg.UpdateAvailable = false;
            pluginList.push_back(plg);
 
            if (IsInString(pluginPath, "xDesignerGUI.dll")) pSettings->designerModeEnabled = true; // Safeguard ;)
 
//          if (!startupLock) // ...writing to plugins.rc during startup is not a good idea... <g>
            else if (!startupLock) // ...writing to plugins.rc during startup is not a good idea... <g>
            {
                if (!WritePluginsRC()) MessageBox(GetBBWnd(), "Could not write to plugins.rc!", "xoblite", MB_OK | MB_ICONERROR | MB_TOPMOST);
            }
 
            return true;
        }
    }
    else
    {
        strcpy(msg, pluginPath);
        strcat(msg, " (LoadLibrary failed)");
        Log("Plugin error", msg);
        strcpy(msg, pluginPath);
        strcat(msg, "   \n\nThe plugin you are trying to load does not exist,   \nor is not compatible with your operating system.   \n\nPlease check your plugin configuration file.   ");
        MessageBox(GetBBWnd(), msg, "xoblite", MB_OK | MB_ICONERROR | MB_TOPMOST);
    }
 
    return false;
}

StartPlugin()

bool PluginManager::StartPlugin	(	HMODULE	hModule,
		LPSTR	pluginPath,
		bool	dockingEnabled )

{
    beginPluginEx = (beginPluginExFunc)GetProcAddress(hModule, "beginPluginEx");
    beginPlugin = (beginPluginFunc)GetProcAddress(hModule, "beginPlugin");
    beginSlitPlugin = (beginSlitPluginFunc)GetProcAddress(hModule, "beginSlitPlugin");
    endPlugin = (endPluginFunc)GetProcAddress(hModule, "endPlugin");
 
    if (!beginPluginEx && !beginPlugin && !beginSlitPlugin)
    {
        FreeLibrary(hModule);
        char msg[MAX_LINE_LENGTH];
        strcpy(msg, pluginPath);
        strcat(msg, " (entry point missing)");
        Log("Plugin failed", msg);
        strcpy(msg, pluginPath);
        strcat(msg, "   \n\nThe plugin you are trying to load is   \nmissing the necessary entry point.   \n\nPlease contact the plugin author.   ");
        MessageBox(GetBBWnd(), msg, "xoblite", MB_OK | MB_ICONERROR | MB_TOPMOST);
        return false;
    }
 
    if (!endPlugin)
    {
        FreeLibrary(hModule);
        char msg[MAX_LINE_LENGTH];
        strcpy(msg, pluginPath);
        strcat(msg, " (exit point missing)");
        Log("Plugin failed", msg);
        strcpy(msg, pluginPath);
        strcat(msg, "   \n\nThe plugin you are trying to load is   \nmissing the necessary exit point.   \n\nPlease contact the plugin author.   ");
        MessageBox(GetBBWnd(), msg, "xoblite", MB_OK | MB_ICONERROR | MB_TOPMOST);
        return false;
    }
 
    // Show plugins if they are hidden and we're not starting up...
    // (needed for visibility consistency when loading a new plugin)
    if (pSettings->pluginsHidden && !startupLock && !IsInString(pluginPath, "xDesignerGUI.dll")) PostMessage(GetBBWnd(), BB_TOGGLEPLUGINS, 0, 0);
 
    //====================
 
    try
    {
        if (pDock)
        {
            if (beginPluginEx) beginPluginEx(hModule, pDock->hDockWnd);
            else if (beginSlitPlugin && dockingEnabled) beginSlitPlugin(hModule, pDock->hDockWnd);
            else if (beginPlugin) beginPlugin(hModule);
            else if (beginSlitPlugin) beginSlitPlugin(hModule, pDock->hDockWnd);
        }
        else if (beginPlugin) beginPlugin(hModule);
    }
    catch (...)
    {
        FreeLibrary(hModule);
        char msg[MAX_LINE_LENGTH];
        strcpy(msg, pluginPath);
        strcat(msg, " (try/catch exception)");
        Log("Plugin failed", msg);
        strcpy(msg, pluginPath);
        strcat(msg, "   \n\nThe plugin you are trying to load has failed.   \n\nPlease contact the plugin author.   ");
        MessageBox(GetBBWnd(), msg, "xoblite", MB_OK | MB_ICONERROR | MB_TOPMOST);
        return false;
    }
 
    //====================
 
    return true;
}

UnloadPlugin()

void PluginManager::UnloadPlugin	(	LPSTR	pluginPath,
		int	pluginNumber )

{
    if (pluginNumber != -1)
    {
        endPlugin = (endPluginFunc)GetProcAddress(pluginList[pluginNumber].hModule, "endPlugin");
        endPlugin(pluginList[pluginNumber].hModule);
        FreeLibrary(pluginList[pluginNumber].hModule);
 
        if (IsInString(pluginList[pluginNumber].path, "xDesignerGUI.dll")) pSettings->designerModeEnabled = false; // Safeguard ;)
 
        pluginList.erase(pluginList.begin() + pluginNumber);
 
        if (!WritePluginsRC()) MessageBox(GetBBWnd(), "Could not write to plugins.rc!", "xoblite", MB_OK | MB_ICONERROR | MB_TOPMOST);
 
        return;
    }
 
    //====================
 
    if (strchr(pluginPath, '\"')) StrRemoveEncap(pluginPath);
    if (strchr(pluginPath, '$')) ReplaceShellFolders(pluginPath);
    if (strchr(pluginPath, '%')) ReplaceEnvVars(pluginPath);
 
    char dllName[MAX_LINE_LENGTH], dllTempName[MAX_LINE_LENGTH];
    int nLen;
 
    // Extract the name of the .dll to unload (disregard the full path)...
    strcpy(dllName, pluginPath);
    nLen = strlen(dllName) - 1;
    if (strchr(dllName, '/')) while (nLen >0 && dllName[nLen] != '/') nLen--;
    else while (nLen >0 && dllName[nLen] != '\\') nLen--;
    strcpy(dllName, &pluginPath[nLen+1]);
 
    //====================
 
    for (int i=0; i < (int)pluginList.size(); i++)
    {
        // Extract the name of the current .dll (disregard the full path)...
        strcpy(dllTempName, pluginList[i].path);
        nLen = strlen(dllTempName) - 1;
        if (strchr(dllName, '/')) while (nLen >0 && dllTempName[nLen] != '/') nLen--;
        else while (nLen >0 && dllTempName[nLen] != '\\') nLen--;
        strcpy(dllTempName, &pluginList[i].path[nLen+1]);
 
        // Is the current plugin the plugin we wish to unload?
        if (!_stricmp(dllName, dllTempName))
        {
            endPlugin = (endPluginFunc)GetProcAddress(pluginList[i].hModule, "endPlugin");
            endPlugin(pluginList[i].hModule);
            FreeLibrary(pluginList[i].hModule);
 
            if (IsInString(pluginPath, "xDesignerGUI.dll")) pSettings->designerModeEnabled = false; // Safeguard ;)
 
            pluginList.erase(pluginList.begin() + i);
 
            if (!WritePluginsRC()) MessageBox(GetBBWnd(), "Could not write to plugins.rc!", "xoblite", MB_OK | MB_ICONERROR | MB_TOPMOST);
 
            return;
        }
    }
/*
    char msg[MAX_LINE_LENGTH];
    strcpy(msg, pluginPath);
    strcat(msg, "   \n\nThe plugin you were trying to unload was not found running.   ");
    MessageBox(GetBBWnd(), msg, "xoblite", MB_OK | MB_ICONERROR | MB_TOPMOST);
*/
}

UpdatePlugin()

void PluginManager::UpdatePlugin	(	LPSTR	pluginPath,
		int	pluginNumber,
		bool	forceUpdate )

{
    if (pSettings->checkingForUpdates) return;
 
    char msg[MAX_LINE_LENGTH], temp[MAX_LINE_LENGTH], path[MAX_LINE_LENGTH];
 
    // Make sure the updates metafile exists...
    GetBlackboxPath(path, sizeof(path));
    strcat(path, "update.log");
    if (!FileExists(path) || forceUpdate)
    {
        bool silent = true;
        _beginthread(checkForUpdates, 0, &silent);
    }
 
    //====================
 
    // Display "<->" icon in toolbar.windowLabel -> update in progress!
    pSettings->checkingForUpdates = true;
//  if ((pSettings->toolbarMode == TOOLBAR_MODE_WINDOWLABEL) && pToolbar) pToolbar->UpdateToolbarWindow();
 
    //====================
 
    if (pluginNumber != -1)
    {
        pluginInfo = (pluginInfoFunc)GetProcAddress(pluginList[pluginNumber].hModule, "pluginInfo");
        if (pluginInfo)
        {
            if (FileExists(path))
            {
                char plugin[MAX_LINE_LENGTH], parameter[MAX_LINE_LENGTH];
                char onlineVersion[MAX_LINE_LENGTH], currentVersion[MAX_LINE_LENGTH];
                char onlineDate[MAX_LINE_LENGTH], currentDate[MAX_LINE_LENGTH];
 
                strcpy(plugin, pluginInfo(PLUGIN_NAME));
                strcpy(currentVersion, pluginInfo(PLUGIN_VERSION));
                strcpy(currentDate, pluginInfo(PLUGIN_RELEASEDATE));
 
                sprintf(parameter, "%s.version:", plugin);
                strcpy(onlineVersion, ReadString(path, parameter, ""));
                if (!strlen(onlineVersion))
                {
                    pluginList[pluginNumber].UpdateAvailable = false;
                    strcpy(temp, pluginInfo(PLUGIN_UPDATE_URL));
                    if (!IsInString(temp, "http://")) strcpy(temp, pSettings->pluginsRepository);
                    sprintf(msg, "%s   \n\n%s is not supported by the specified repository!   ", temp, plugin);
                    MessageBox(GetBBWnd(), msg, "xoblite", MB_OK | MB_SETFOREGROUND | MB_ICONERROR);
                    return;
                }
                sprintf(parameter, "%s.date:", plugin);
                strcpy(onlineDate, ReadString(path, parameter, "xxxx-xx-xx"));
 
                //====================
 
                // Check if online version/date differs from the current version/date...
                if (!_stricmp(currentDate, onlineDate))
                {
                    if (!_stricmp(currentVersion, onlineVersion))
                    {
                        pluginList[pluginNumber].UpdateAvailable = false;
                        sprintf(msg, "You are already using the latest version of %s.   ", plugin);
                        MessageBox(GetBBWnd(), msg, "xoblite", MB_OK | MB_SETFOREGROUND | MB_ICONINFORMATION);
                        return;
                    }
                }
 
                //====================
 
                sprintf(msg, "%s update found!\n\nCurrent version:\t %s \t%s   \nOnline version:\t %s \t%s   ", plugin, currentVersion, currentDate, onlineVersion, onlineDate);
 
                sprintf(parameter, "%s.changes:", plugin);
                strcpy(temp, ReadString(path, parameter, ""));
                if (strlen(temp))
                {
                    strcat(msg, "\n\nUpdate information:\n");
                    strcat(msg, temp);
                }
 
                strcat(msg, "\n\nDo you want to download this update?   ");
 
                //====================
 
                if (MessageBox(GetBBWnd(), msg, "xoblite", MB_YESNO | MB_ICONQUESTION | MB_SETFOREGROUND | MB_TOPMOST) == IDYES)
                {
                    int nLen;
                    char token[MAX_LINE_LENGTH], extra[MAX_LINE_LENGTH], filename[MAX_LINE_LENGTH], pluginPath[MAX_LINE_LENGTH];
                    char savedfiles[MAX_LINE_LENGTH] = "";
                    LPSTR tokens[1];
                    tokens[0] = token;
 
                    // Copy the path to the plugin + the URL...
                    bool dllFound = false, zipFound = false;
 
                    if (!strstr(pluginList[pluginNumber].path, ":\\"))
                    {
                        // Make sure we use the full path of the plugin and
                        // not just a path relative to the Blackbox folder...
                        GetBlackboxPath(filename, MAX_LINE_LENGTH);
                        strcat(filename, pluginList[pluginNumber].path);
                    }
                    else strcpy(filename, pluginList[pluginNumber].path);
 
                    sprintf(parameter, "%s.files:", plugin);
                    strcpy(temp, ReadString(path, parameter, ""));
                    if (!strlen(temp))
                    {
                        // Download the plugin .zip archive if no
                        // list of updated files was specified...
                        sprintf(parameter, "%s.archive:", plugin);
                        strcpy(temp, ReadString(path, parameter, ""));
                    }
 
                    if (IsInString(temp, ".dll")) dllFound = true;
                    else if (IsInString(temp, ".zip")) zipFound = true;
 
                    if (!dllFound && !zipFound)
                    {
                        // Neither an archive (.zip) nor individual files (including at least one .dll)
                        // was directly linked to -> Open the link in the user's default browser...
                        if (IsInString(temp, "http")) BBSmartExecute(temp);
                        else
                        {
                            sprintf(msg, "Invalid update link detected for %s:   \n\n%s   ", plugin, temp);
                            if (strlen(temp) == 0) strcat(msg, "<empty>   ");
                            strcat(msg, "\n\nUpdate request aborted. Click OK to continue.");
                            MessageBox(GetBBWnd(), msg, "Error updating plugin!", MB_ICONERROR | MB_SETFOREGROUND | MB_TOPMOST);
                        }
                        return;
                    }
 
                    if (dllFound)
                    {
                        // Unload the plugin...
                        strcpy(pluginPath, pluginList[pluginNumber].path);
                        endPlugin = (endPluginFunc)GetProcAddress(pluginList[pluginNumber].hModule, "endPlugin");
                        endPlugin(pluginList[pluginNumber].hModule);
                        FreeLibrary(pluginList[pluginNumber].hModule);
                        pluginList.erase(pluginList.begin() + pluginNumber);
                    }
 
                    // Download the updated files...
                    while(strlen(temp))
                    {
                        token[0] = extra[0] = '\0';
                        BBTokenize (temp, tokens, 1, extra);
                        strcpy(temp, extra);
 
                        // Extract the plugin folder from the plugin path...
                        nLen = strlen(filename) - 1;
                        if (IsInString(filename, "/")) while (nLen >0 && filename[nLen] != '/') nLen--;
                        else while (nLen >0 && filename[nLen] != '\\') nLen--;
                        filename[nLen + 1] = 0;
 
                        // Extract the name of the file from the URL...
                        nLen = strlen(token) - 1;
                        while (nLen >0 && token[nLen] != '/') nLen--;
                        strcat(filename, &token[nLen+1]);
 
                        // Download the file and save it in the plugin folder...
                        DownloadFile(token, filename);
 
                        // Copy the path of the saved file to the list of updated files...
                        strcat(savedfiles, "\n");
                        strcat(savedfiles, filename);
                        strcat(savedfiles, "   ");
                    }
 
                    if (dllFound)
                    {
                        // Reload the plugin...
                        bool dockingEnabled;
 
                        if (pluginPath[0] == '&') // dock plugin?
                        {
                            dockingEnabled = true;
                            hModule = LoadLibrary(&pluginPath[1]);
                        }
                        else // normal plugin
                        {
                            dockingEnabled = false;
                            hModule = LoadLibrary(pluginPath);
                        }
 
                        if (hModule)
                        {
                            if (StartPlugin(hModule, pluginPath, dockingEnabled))
                            {
                                pluginItem plg;
                                plg.hModule = hModule;
                                plg.DockingEnabled = dockingEnabled;
                                strcpy(plg.path, pluginPath);
                                plg.UpdateAvailable = false;
                                pluginList.insert(pluginList.begin() + pluginNumber, plg);
                            }
                        }
                        else return;
 
                        sprintf(msg, "%s update downloaded and installed.   \n%s", plugin, savedfiles);
                        MessageBox(GetBBWnd(), msg, "xoblite", MB_OK | MB_SETFOREGROUND | MB_TOPMOST | MB_ICONINFORMATION);
                    }
                    else if (zipFound)
                    {
                        sprintf(msg, "%s update in .zip format downloaded,   \nsee archive for further instructions.   \n%s", plugin, savedfiles);
                        if (MessageBox(GetBBWnd(), msg, "xoblite", MB_OK | MB_SETFOREGROUND | MB_TOPMOST | MB_ICONINFORMATION))
                        {
                            char arg[MAX_LINE_LENGTH];
                            strcpy(arg, "/e,/select,");
                            strcat(arg, savedfiles);
                            BBExecute(GetDesktopWindow(), NULL, "explorer.exe", arg, NULL, SW_SHOWNORMAL, false);
                            return;
                        }
                    }
                    else
                    {
                        sprintf(msg, "%s update downloaded.   \n%s", plugin, savedfiles);
                        MessageBox(GetBBWnd(), msg, "xoblite", MB_OK | MB_SETFOREGROUND | MB_TOPMOST | MB_ICONINFORMATION);
                    }
                }
 
                // Turn off the "update available" indicator...
                pluginList[pluginNumber].UpdateAvailable = false;
            }
            else MessageBox(GetBBWnd(), "Could not find the updates metafile! [update.log]   ", "xoblite", MB_OK | MB_SETFOREGROUND | MB_TOPMOST | MB_ICONERROR);
        }
        else MessageBox(GetBBWnd(), "This plugin does not support automatic updating.   ", "xoblite", MB_OK | MB_SETFOREGROUND | MB_TOPMOST | MB_ICONERROR);
    }
 
    // Remove "<->" icon from toolbar.windowLabel -> update no longer in progress
    pSettings->checkingForUpdates = false;
//  if ((pSettings->toolbarMode == TOOLBAR_MODE_WINDOWLABEL) && pToolbar) pToolbar->UpdateToolbarWindow();
}

AboutPlugins()

void PluginManager::AboutPlugins

(

)

{
    char msg[MAX_LINE_LENGTH] = "", temp[MAX_LINE_LENGTH];
 
    for (int i=0; i < (int)pluginList.size(); i++)
    {
        pluginInfo = (pluginInfoFunc)GetProcAddress(pluginList[i].hModule, "pluginInfo");
        if (pluginInfo)
        {
            sprintf(temp, "%s %s by %s (%s)", pluginInfo(PLUGIN_NAME), pluginInfo(PLUGIN_VERSION), pluginInfo(PLUGIN_AUTHOR), pluginInfo(PLUGIN_RELEASEDATE));
            strcat(msg, temp);
            if (pluginList[i].path[0] == '&') strcat(msg, " *\n"); // &-loaded plugin (beginSlitPlugin)
            else strcat(msg, "\n"); // Normal plugin (beginPlugin, beginPluginEx)
        }
        else
        {
            strcat(msg, pluginList[i].path);
            if (pluginList[i].path[0] == '&') strcat(msg, " *\n"); // &-loaded plugin (beginSlitPlugin)
            else strcat(msg, "\n"); // Normal plugin (beginPlugin, beginPluginEx)
        }
    }
 
    if (strlen(msg))
    {
        msg[strlen(msg)-1] = '\0'; // Remove the last line feed auto-generated above...
        SendMessage(GetBBWnd(), BB_POPUPMESSAGE, (WPARAM)"About the loaded plugins...", (LPARAM)msg);
    }
    else SendMessage(GetBBWnd(), BB_POPUPMESSAGE, (WPARAM)"About the loaded plugins...", (LPARAM)"--- No plugins loaded ---   ");
}

GetPluginInfo()

LPCSTR PluginManager::GetPluginInfo	(	int	pluginNumber,
		int	infoParam )

{
    pluginInfo = (pluginInfoFunc)GetProcAddress(pluginList[pluginNumber].hModule, "pluginInfo");
    if (pluginInfo)
    {
        LPCSTR result = pluginInfo(infoParam); // e.g. PLUGIN_VERSION (see BBApi.h)
        if (result) return result;
        // Fetch default fallback string in case the result was NULL
        // (i.e. if the requested field was not supported/defined)
//      else return pluginInfo(-1);
        else return pluginInfo(PLUGIN_NAME);
    }
    else
    {
        // Extract the name of the plugin...
        strcpy(pluginName, pluginList[pluginNumber].path);
        int nLen = strlen(pluginName) - 1;
        if (IsInString(pluginName, "/")) while (nLen >0 && pluginName[nLen] != '/') nLen--;
        else while (nLen >0 && pluginName[nLen] != '\\') nLen--;
        strcpy(pluginName, &pluginList[pluginNumber].path[nLen+1]);
        pluginName[strlen(pluginName)-4] = 0; // Remove .dll at the end...
        return pluginName;
    }
}

WritePluginsRC()

bool PluginManager::WritePluginsRC

(

)

{
    if (pSettings->writeProtection) return true;
    
    HANDLE f = CreateFile(plugrcPath(), GENERIC_WRITE, FILE_SHARE_READ, NULL, CREATE_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);
    if (f)
    {
        char szTemp[MAX_LINE_LENGTH];
        DWORD retLength = 0;
 
        for (int i=0; i < (int)pluginList.size(); i++)
        {
            // If the full path to the plugin is specified (e.g. from drag'n'drop) and it is in
            // a subfolder to the Blackbox folder, extract the relative path to the plugin
            // -> full path minus Blackbox folder path.
            // Example: "C:\Blackbox\plugins\BBbin\BBbin.dll" becomes "plugins\BBbin\BBbin.dll"
            // This way the Blackbox folder can be moved, and the plugin path will still work! :D
 
            if (!pSettings->usingDefaultTheme && IsInString(pluginList[i].path, pSettings->SF_currentThemePath))
            {
                strcpy(szTemp, "$CurrentTheme$");
                strcat(szTemp, &pluginList[i].path[(strlen(pSettings->SF_currentThemePath))]);
            }
            else if (IsInString(pluginList[i].path, pSettings->SF_blackboxPath))
            {
                strcpy(szTemp, &pluginList[i].path[(strlen(pSettings->SF_blackboxPath)+1)]);
            }
            else strcpy(szTemp, pluginList[i].path);
 
            strcat(szTemp, "\r\n");
            WriteFile(f, szTemp, strlen(szTemp), &retLength, NULL);
        }
 
        CloseHandle(f);
        return true;
    }
    else
    {
        CloseHandle(f);
        return false;
    }
}

LoadPluginDialog()

void PluginManager::LoadPluginDialog

(

)

{
    char msg[MAX_LINE_LENGTH];
    strcpy(msg, "Always be careful when loading plugins and   \nrunning scripts downloaded from the internet.   \n\nEnsure they are from a trusted source.   \n\nDo you want to continue?   ");
 
    if (MessageBox(GetBBWnd(), msg, "xoblite", MB_YESNO | MB_ICONQUESTION | MB_SETFOREGROUND | MB_TOPMOST) == IDYES)
    {
        char file[MAX_PATH] = "", path[MAX_PATH];
 
        if (pSettings->usingDefaultTheme)
        {
            strcpy(path, pSettings->SF_blackboxPath);
            strcat(path, "\\plugins");
        }
        else
        {
            strcpy(path, pSettings->SF_currentThemePath);
            strcat(path, "\\plugins");
            if (!FolderExists(path))
            {
                strcpy(path, pSettings->SF_blackboxPath);
                strcat(path, "\\plugins");
            }
        }
 
        // Set the required formats for the file dialog...
        OPENFILENAME ofn;
        ZeroMemory(&ofn, sizeof(ofn));
        ofn.lStructSize = sizeof(ofn);
        ofn.hwndOwner = NULL;
        ofn.lpstrFilter = "Plugins (*.dll)\0*.dll", NULL, NULL;
        ofn.lpstrFile = file;
        ofn.nMaxFile = MAX_PATH;
        ofn.lpstrInitialDir = path;
        ofn.lpstrTitle = "Load plugin...";
        ofn.lpstrDefExt = NULL;
        ofn.Flags = OFN_FILEMUSTEXIST | OFN_PATHMUSTEXIST | OFN_EXPLORER;
 
        if (GetOpenFileName(&ofn)) LoadPlugin(ofn.lpstrFile);
    }
}

IsPluginLoaded()

bool PluginManager::IsPluginLoaded

(

LPSTR

pluginPath

)

{
    bool fileNameOnly = false;
    if (!strchr(pluginPath, '\\')) fileNameOnly = true;
 
    for (int i=0; i < (int)pluginList.size(); i++)
    {
        if (fileNameOnly)
        {
            if (IsInString(pluginList[i].path, pluginPath)) return true;
        }
        else
        {
            if (!_stricmp(pluginList[i].path, pluginPath)) return true;
        }
    }
 
    return false;
}

Member Data Documentation

pluginList

PluginsVector PluginManager::pluginList

startupLock

bool PluginManager::startupLock

pluginName

char PluginManager::pluginName[MAX_LINE_LENGTH]

hModule

HINSTANCE PluginManager::hModule

beginPluginEx

beginPluginExFunc PluginManager::beginPluginEx

beginPlugin

beginPluginFunc PluginManager::beginPlugin

beginSlitPlugin

beginSlitPluginFunc PluginManager::beginSlitPlugin

endPlugin

endPluginFunc PluginManager::endPlugin

pluginInfo

pluginInfoFunc PluginManager::pluginInfo