total99resources.cpp

/********************************************************************************
 *  FARSA - Total99                                                             *
 *  Copyright (C) 2005-2011 Gianluca Massera <emmegian@yahoo.it>                *
 *                                                                              *
 *  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., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA  *
 ********************************************************************************/

#include "total99resources.h"
#include <cstdlib>
#include <QApplication>
#include <QFile>
#include <QDir>
#include <QFileInfo>
#include <QPluginLoader>
#include <QStringList>
#include "configurationparameters.h"
#include "factory.h"
#include "farsaplugin.h"
#include "icubsimulator.h"
#include "icubsimulatorviewer.h"
#include "evorobotviewer.h"
#include "logger.h"

// All the suff below is to avoid warnings on Windows about the use of the
// unsafe function getenv
#if defined(_MSC_VER)
    #pragma warning(push)
    #pragma warning(disable:4996)
#endif

using namespace farsa;

QString Total99Resources::findResource( QString resourceName ) {
    //--- search in the user directory
    if ( QFile::exists( confUserPath + "/" + resourceName ) ) {
        return ( confUserPath + "/" + resourceName );
    }
    //--- search in the template user directory
    if ( QFile::exists( confUserPath + "/templates/" + uiTemplate + "/" + resourceName ) ) {
        return ( confUserPath + "/templates/" + uiTemplate + "/" + resourceName );
    }
    //--- search in the global directory
    if ( QFile::exists( confBasePath + "/" + resourceName ) ) {
        return ( confBasePath + "/" + resourceName );
    }
    //--- search in the global template directory
    if ( QFile::exists( confBasePath + "/templates/" + uiTemplate + "/" + resourceName ) ) {
        return ( confBasePath + "/templates/" + uiTemplate + "/" + resourceName );
    }
    //--- not find anything
    return QString();
}

QString Total99Resources::confBasePath;
QString Total99Resources::confUserPath;
QString Total99Resources::pluginBasePath;
QString Total99Resources::pluginUserPath;
QString Total99Resources::uiTemplate;

bool Total99Resources::loadPlugin( QString filename ) {
    QPluginLoader loader( filename );
    FarsaPlugin* plugin = qobject_cast<FarsaPlugin*>( loader.instance() );
    if ( !plugin ) {
        // error on loading the plugin
        return false;
    }
    //--- register all types and widgets defined in the plugin
    plugin->registerTypesOnFactory();
    return true;
}

void Total99Resources::loadPlugins( QDir dir ) {
    foreach( QString pluginfile, dir.entryList() ) {
        if ( ! QLibrary::isLibrary( pluginfile ) ) continue;
        if ( loadPlugin( dir.absoluteFilePath(pluginfile) ) ) {
            Logger::info( "Loaded Plugin \"" + pluginfile + "\"");
        }
    }
}

void Total99Resources::loadPlugins( const farsa::ConfigurationParameters& params ) {
    QStringList pluginPaths = params.getParametersWithPrefixList( "TOTAL99", "pluginPath" );
    foreach( QString path, pluginPaths ) {
        QString value = params.getValue( "TOTAL99/"+path );
        if ( ! QFileInfo( value ).isDir() ) {
            Logger::warning( "Ignoring un-existing plugin path \"" + value + "\"" );
            continue;
        }
        loadPlugins( QDir( value ) );
    }
}

void Total99Resources::initialize() {
#ifdef FARSA_WIN
    confBasePath = qApp->applicationDirPath() + "/../conf";
    pluginBasePath = qApp->applicationDirPath() + "/../plugins";
#else
    confBasePath = qApp->applicationDirPath() + "/../share/FARSA/conf";
    pluginBasePath = qApp->applicationDirPath() + "/../share/FARSA/plugins";
#endif
#ifdef FARSA_LINUX
    confUserPath = QString(getenv("HOME")) + "/.FARSA/total99";
    pluginUserPath = QString(getenv("HOME")) + "/.FARSA/total99/plugins";
#endif
#ifdef FARSA_MAC
    confUserPath = QString(getenv("HOME")) + "/Library/Application Support/FARSA/Total99";
    pluginUserPath = QString(getenv("HOME")) + "/Library/Application Support/FARSA/Total99/plugins";
#endif
#ifdef FARSA_WIN
    confUserPath = QString(getenv("APPDATA")) + "/FARSA/Total99";
    pluginUserPath = QString(getenv("APPDATA")) + "/FARSA/Total99/plugins";
#endif

    QDir dir;
    dir.mkpath( confUserPath );
    dir.mkpath( pluginUserPath );

    // Loading plugins from default directories
    loadPlugins( QDir( pluginBasePath ) );
    loadPlugins( QDir( pluginUserPath ) );

    uiTemplate = "kids";
    Logger::info( "Total99 Resources Initialized" );
}

// All the suff below is to restore the warning state on Windows
#if defined(_MSC_VER)
    #pragma warning(pop)
#endif