PluginManager.h File Reference

#include "..\Settings\Settings.h"
#include "..\Menu\Menu.h"
#include <vector>
#include <string>
#include <windows.h>
#include <stdio.h>
#include <commdlg.h>
#include <wininet.h>
#include <locale.h>

Classes
struct	pluginItem
class	PluginManager

Typedefs
typedef int(*	beginPluginExFunc) (HINSTANCE, HWND)
typedef int(*	beginPluginFunc) (HINSTANCE)
typedef int(*	beginSlitPluginFunc) (HINSTANCE, HWND)
typedef int(*	endPluginFunc) (HINSTANCE)
typedef LPCSTR(*	pluginInfoFunc) (int)
typedef vector< pluginItem >	PluginsVector

Functions
void	checkForUpdates (void *param)
void	periodicCheckForUpdates (void *)

Typedef Documentation

beginPluginExFunc

typedef int(* beginPluginExFunc) (HINSTANCE, HWND)

beginPluginFunc

typedef int(* beginPluginFunc) (HINSTANCE)

beginSlitPluginFunc

typedef int(* beginSlitPluginFunc) (HINSTANCE, HWND)

endPluginFunc

typedef int(* endPluginFunc) (HINSTANCE)

pluginInfoFunc

typedef LPCSTR(* pluginInfoFunc) (int)

PluginsVector

typedef vector<pluginItem> PluginsVector

Function Documentation

checkForUpdates()

void checkForUpdates

(

void *

param

)

{
    if (pSettings->checkingForUpdates) _endthread();
    else
    {
        // Display "<->" icon in toolbar.windowLabel -> update in progress!
        pSettings->checkingForUpdates = true;
//      if ((pSettings->toolbarMode == TOOLBAR_MODE_WINDOWLABEL) && pToolbar) pToolbar->UpdateToolbarWindow();
//      SendMessage(GetBBWnd(), BB_CONSOLEMESSAGE, (WPARAM)CONSOLE_REGULAR_MESSAGE, (LPARAM)"xoblite -> Checking for updates...");
    }
 
    bool silent = *((bool*)param);
    int updates = 0;
    char listOfURLs[MAX_LINE_LENGTH] = "", path[MAX_LINE_LENGTH], msg[MAX_LINE_LENGTH], listOfUpdates[MAX_LINE_LENGTH] = "";
 
    //====================
/*
    // Extract distributed repository URLs from all
    // plugins that support automatic updating...
    for (int i=0; i < (int)pPluginManager->pluginList.size(); i++)
    {
        pPluginManager->pluginInfo = (pluginInfoFunc)GetProcAddress(pPluginManager->pluginList[i].hModule, "pluginInfo");
        if (pPluginManager->pluginInfo)
        {
            strcpy(msg, pPluginManager->pluginInfo(PLUGIN_UPDATE_URL));
 
            // Make sure the string supplied by the plugin is a valid URL
            // and that it isn't the same URL as for the central repository...
            if (IsInString(msg, "http://") && !IsInString(msg, pSettings->pluginsRepository))
            {
                if (!IsInString(listOfURLs, msg))
                {
                    strcat(listOfURLs, msg);
                    strcat(listOfURLs, " ");
                }
            }
        }
    }
*/
    // Finally, we add the central repository URL at the end of the list
    // (i.e. if a plugin does not return a URL for automatic updating we fall
    // back to the central plugin repository defined in xoblite.rc, which means
    // that the information provided by the distributed repositories
    // will have precedence in case of duplicate plugin update information! :D )
    strcat(listOfURLs, pSettings->pluginsRepository);
 
    //====================
 
    if (IsInString(listOfURLs, "http://"))
    {
        GetBlackboxPath(path, sizeof(path));
        strcat(path, "update.log");
 
        if (FileExists(path)) remove(path); // Delete existing update.log file...
 
        //====================
 
        if (DownloadFile(listOfURLs, 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];
            char onlineAuthor[MAX_LINE_LENGTH];
 
            for (int i=0; i < (int)pPluginManager->pluginList.size(); i++)
            {
                pPluginManager->pluginInfo = (pluginInfoFunc)GetProcAddress(pPluginManager->pluginList[i].hModule, "pluginInfo");
                if (pPluginManager->pluginInfo)
                {
                    strcpy(plugin, pPluginManager->pluginInfo(PLUGIN_NAME));
                    strcpy(currentVersion, pPluginManager->pluginInfo(PLUGIN_VERSION));
                    strcpy(currentDate, pPluginManager->pluginInfo(PLUGIN_RELEASEDATE));
 
                    sprintf(parameter, "%s.version:", plugin);
                    strcpy(onlineVersion, ReadString(path, parameter, ""));
                    if (!strlen(onlineVersion))
                    {
                        // The plugin was not not supported by the specified repository (or invalid syntax)...
                        pPluginManager->pluginList[i].UpdateAvailable = false;
                        continue;
                    }
                    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))
                        {
                            // If not, continue looking...
                            pPluginManager->pluginList[i].UpdateAvailable = false;
                            continue;
                        }
                    }
 
                    // ...but if it differs we have found an updated plugin!
                    pPluginManager->pluginList[i].UpdateAvailable = true;
 
                    sprintf(parameter, "%s.author:", plugin);
                    strcpy(onlineAuthor, ReadString(path, parameter, (LPSTR)pPluginManager->pluginInfo(PLUGIN_AUTHOR)));
 
                    sprintf(msg, "\n%s %s by %s (%s)   ", plugin, onlineVersion, onlineAuthor, onlineDate);
                    strcat(listOfUpdates, msg);
                    updates++;
                }
                else pPluginManager->pluginList[i].UpdateAvailable = false;
            }
        }
        else
        {
            strcpy(msg, "Note: Some repositories were not currently available,   \nwhich may affect the result of this check for updates.   ");
            MessageBox(GetBBWnd(), msg, "xoblite", MB_OK | MB_ICONINFORMATION | MB_SETFOREGROUND | MB_TOPMOST);
        }
    }
 
    //====================
 
    if (!silent)
    {
        char xobVersion[MAX_LINE_LENGTH], xobOnlineVersion[MAX_LINE_LENGTH];
        ULONG *size = 0;
        void *versionPtr;
        UINT bytes;
 
        // Extract currently running xoblite version...
        // (make sure the correct version encoding is used, currently "000004b0" = language neutral)
        DWORD number = GetFileVersionInfoSize("Blackbox.exe", size);
        char temp[MAX_LINE_LENGTH];
        GetFileVersionInfo("Blackbox.exe", NULL, number, (LPVOID)temp);
        VerQueryValue(temp, TEXT("\\StringFileInfo\\000004b0\\FileVersion"), &versionPtr, &bytes);
        strcpy(xobVersion, (LPCSTR)versionPtr);
        if ((xobVersion[strlen(xobVersion)-1] == '\n') || (xobVersion[strlen(xobVersion)-1] == '\r')) xobVersion[strlen(xobVersion)-1] = '\0'; // Failsafe
 
        // ...and compare that with the xoblite version available online...
        strcpy(xobOnlineVersion, ReadString(path, "xoblite.version:", ""));
        if ((xobOnlineVersion[strlen(xobOnlineVersion)-1] == '\n') || (xobOnlineVersion[strlen(xobOnlineVersion)-1] == '\r')) xobOnlineVersion[strlen(xobOnlineVersion)-1] = '\0'; // Failsafe
 
        bool xobliteUpdateFound = false;
        if (strlen(xobOnlineVersion) && _stricmp(xobVersion, xobOnlineVersion)) xobliteUpdateFound = true;
 
        //====================
 
        // Display result of the check for updates in the console...
        if (updates > 0)
        {
            if (xobliteUpdateFound) sprintf(msg, "Checking for updates -> xoblite %s and %d updated plugin", xobOnlineVersion, updates);
            else sprintf(msg, "Checking for updates -> %d updated plugin", updates);
            if (updates > 1) strcat(msg, "s");
            strcat(msg, " available.");
        }
        else if (xobliteUpdateFound) sprintf(msg, "Checking for updates -> xoblite %s available.", xobOnlineVersion);
        else strcpy(msg, "Checking for updates -> No updates were found.");
 
        SendMessage(GetBBWnd(), BB_CONSOLEMESSAGE, (WPARAM)CONSOLE_INFORMATION_MESSAGE, (LPARAM)msg);
 
        //====================
 
        if (xobliteUpdateFound)
        {
            sprintf(msg, "Shell update found!   \n\nCurrent version:   \nxoblite %s   \n\nOnline version:   \nxoblite %s   \n\nDo you want to download this update?   \n(clicking \"Yes\" will take you to the xoblite website)   ", xobVersion, xobOnlineVersion);
 
            if (MessageBox(GetBBWnd(), msg, "xoblite", MB_YESNO | MB_ICONQUESTION | MB_SETFOREGROUND | MB_TOPMOST) == IDYES)
            {
                // Choosing to download an update will (for now) take the user to the xoblite
                // website to manually download the latest build (mostly to reduce maintenance
                // overhead, however this could possibly change in a future release...)
                BBExecute(GetDesktopWindow(), NULL, "http://xoblite.net/", NULL, NULL, SW_SHOWNORMAL, true);
            }
 
            // Choosing to download an update will (for now) take the user to the xoblite
            // website to manually download the latest build (mostly to reduce maintenance
            // overhead, however this could possibly change in a future release...)
//          SendMessage(GetBBWnd(), BB_POPUPMESSAGE, (WPARAM)msg, (LPARAM)"@GoToURL http://xoblite.net/");
        }
 
        //====================
 
        if (updates > 0)
        {
            sprintf(msg, "Found %d updated plugins:   \n", updates);
            strcat(msg, listOfUpdates);
            if (updates == 1) strcat(msg, "\n\nDo you want to download this update?   ");
            else strcat(msg, "\n\nDo you want to download any of these updates?   ");
 
            if (MessageBox(GetBBWnd(), msg, "xoblite", MB_YESNO | MB_ICONQUESTION | MB_SETFOREGROUND | MB_TOPMOST) == IDYES)
            {
                for (int i=0; i < (int)pPluginManager->pluginList.size(); i++)
                {
                    if (pPluginManager->pluginList[i].UpdateAvailable)
                    {
                        pSettings->checkingForUpdates = false; // Disable update lock to access updatePlugin() ...
                        pPluginManager->UpdatePlugin(NULL, i, false);
                        pSettings->checkingForUpdates = true; // Re-enable update lock...
                    }
                }
            }
        }
        else
        {
            strcpy(msg, "No updated plugins were found.   ");
            MessageBox(GetBBWnd(), msg, "xoblite", MB_OK | MB_ICONINFORMATION | MB_SETFOREGROUND | MB_TOPMOST);
        }
    }
 
    //====================
 
    // Finally, we update xoblite.checked.for.updates in xoblite.rc... (temporarily disable write protection if necessary!)
    time_t systemTime;
    struct tm localTime;
    time(&systemTime);
    localtime_s(&localTime, &systemTime);
 
    _locale_t timestampLocale = _create_locale(LC_TIME, "en-US"); // -> Always use en-US format for the "checked for updates" timestamp...
    _strftime_l(pSettings->checkedForUpdates, 20, "#%j / %Y-%m-%d", &localTime, timestampLocale);
    _free_locale(timestampLocale);
 
    bool tempBool = pSettings->writeProtection;
    pSettings->writeProtection = false;
    WriteString(pSettings->xobrcDefaultFile, "xoblite.checked.for.updates:", pSettings->checkedForUpdates);
    pSettings->writeProtection = tempBool;
 
    //====================
 
    // Remove "<->" icon from toolbar.windowLabel -> update no longer in progress
    pSettings->checkingForUpdates = false;
//  if ((pSettings->toolbarMode == TOOLBAR_MODE_WINDOWLABEL) && pToolbar) pToolbar->UpdateToolbarWindow();
 
    _endthread();
}

periodicCheckForUpdates()

void periodicCheckForUpdates

(

void *

)

{
    if (pSettings->checkingForUpdates) _endthread();
 
    char temp[MAX_LINE_LENGTH];// , windowLabel[25];
 
    // Get current day of the year...
    time_t systemTime;
    struct tm localTime;
    time(&systemTime);
    localtime_s(&localTime, &systemTime);
    int currentDay = localTime.tm_yday + 1;
 
    // Extract day of the year for the last check...
//  strncpy(temp, &pSettings->checkedForUpdates[1], 3);
    strncpy_s(temp, sizeof(temp), &pSettings->checkedForUpdates[1], 3);
    temp[3] = 0;
    int checkedDay = atoi(temp);
 
    // Calculate the number of days since the last check for updates...
    int interval;
    if (currentDay >= checkedDay) interval = currentDay - checkedDay;
    else interval = 366 - checkedDay + currentDay;
 
    //====================
/*
    // Is the last checked date in xoblite.rc == the default?
    // If so, xoblite is running for the first time -> display a nice welcome screen! =]
    if (!_stricmp(pSettings->checkedForUpdates, "#001 / 2006-01-01"))
    {
        interval = 365; // ...just to trigger the update messagebox below! <g>
        strcpy(windowLabel, "Welcome to xoblite!");
        strcpy(temp,
                "You seem to be running xoblite for the first time.   \n\n"
                "xoblite features a mechanism to notify you of available updates to the core (Blackbox.exe) and your loaded plugins.   \n\n"
                "A check for updates can be triggered using:   \n"
                "- The \"Check for updates...\" item in the Configuration/Global menu   \n"
                "- The core broadcast message: @xoblite CheckForUpdates   \n"
                "- Monthly periodic checking (user is notified if/when more than 30 days have passed since the last check)   \n\n"
                "Do you want to check for updates now?   ");
    }
    else
    {
        strcpy(windowLabel, "xoblite");
        sprintf(temp, "%d days have passed since you last checked for updates.   \n\nDo you want to check for updates now?   ", interval);
    }
*/
    //====================
 
    if (interval > 30) // Has more than 30 days passed since the last check for updates?
    {
/*
        // Ask the user if he/she wants to check for updates...
        if (MessageBox(NULL, temp, windowLabel, MB_YESNO | MB_ICONQUESTION | MB_SETFOREGROUND | MB_TOPMOST) == IDYES)
        {
            bool silent = false;
            checkForUpdates(&silent); // We're already running in a separate thread! (NOTE: checkForUpdates will terminate the thread)
        }
        else
        {
            // Update xoblite.checked.for.updates in xoblite.rc... (temporarily disable write protection if necessary!)
            _locale_t timestampLocale = _create_locale(LC_TIME, "en-US"); // -> Always use en-US format for the checked for updates timestamp...
            _strftime_l(pSettings->checkedForUpdates, 20, "#%j / %Y-%m-%d", localTime, timestampLocale);
            _free_locale(timestampLocale);
 
            bool tempBool = pSettings->writeProtection;
            pSettings->writeProtection = false;
            WriteString(pSettings->xobrcDefaultFile, "xoblite.checked.for.updates:", pSettings->checkedForUpdates);
            pSettings->writeProtection = tempBool;
        }
*/
        bool silent = false;
        checkForUpdates(&silent); // We're already running in a separate thread! (NOTE: checkForUpdates will terminate the thread)
    }
 
    //====================
 
    _endthread();
}