CTK/Libs/PluginFramework/ctkPluginFrameworkContext.cxx

/*=============================================================================

  Library: CTK

  Copyright (c) 2010 German Cancer Research Center,
    Division of Medical and Biological Informatics

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

=============================================================================*/

#include "ctkPluginFrameworkContext_p.h"

#include "ctkPluginFrameworkPrivate_p.h"
#include "ctkPluginArchive_p.h"
#include "ctkPluginConstants.h"

namespace ctk {

  QMutex PluginFrameworkContext::globalFwLock;
  int PluginFrameworkContext::globalId = 1;


  PluginFrameworkContext::PluginFrameworkContext(
      const PluginFrameworkFactory::Properties& initProps)
        : plugins(0), /*services(this),*/ systemPlugin(this),
        storage(this), props(initProps)
  {

    {
      QMutexLocker lock(&globalFwLock);
      id = globalId++;
    }

    log() << "created";
  }

  void PluginFrameworkContext::init()
  {
    log() << "initializing";

//    if (Constants.FRAMEWORK_STORAGE_CLEAN_ONFIRSTINIT
//        .equals(props.getProperty(Constants.FRAMEWORK_STORAGE_CLEAN))) {
//      deleteFWDir();
//      // Must remove the storage clean property since it should not be
//      // used more than once!
//      props.removeProperty(Constants.FRAMEWORK_STORAGE_CLEAN);
//    }
//    props.save();

    PluginFrameworkPrivate* const systemPluginPrivate = systemPlugin.d_func();
    systemPluginPrivate->initSystemPlugin();

    plugins = new Plugins(this);

    plugins->load();

    log() << "inited";

    log() << "Installed plugins:";
    // Use the ordering in the plugin storage to get a sorted list of plugins.
    QList<PluginArchive*> allPAs = storage.getAllPluginArchives();
    for (int i = 0; i < allPAs.size(); ++i)
    {
      PluginArchive* pa = allPAs[i];
      Plugin* p = plugins->getPlugin(pa->getPluginLocation().toString());
      log() << " #" << p->getPluginId() << " " << p->getSymbolicName() << ":"
          << p->getVersion() << " location:" << p->getLocation();
    }
  }

  void PluginFrameworkContext::uninit()
  {
    log() << "uninit";

    //PluginFrameworkPrivate* const systemPluginPrivate = systemPlugin.d_func();
    //systemPluginPrivate->uninitSystemBundle();

    plugins->clear();
    delete plugins;
    plugins = 0;

    storage.close();

  }

  int PluginFrameworkContext::getId() const
  {
    return id;
  }

  void PluginFrameworkContext::checkOurPlugin(Plugin* plugin) const
  {
    PluginPrivate* pp = plugin->d_func();
    if (this != pp->fwCtx)
    {
      throw std::invalid_argument("Plugin does not belong to this framework: " + plugin->getSymbolicName().toStdString());
    }
  }

  QDebug PluginFrameworkContext::log() const
  {
    QDebug dbg(qDebug());
    dbg << "Framework instance " << getId() << ": ";
    return dbg;
  }

  void PluginFrameworkContext::resolvePlugin(PluginPrivate* plugin)
  {
    qDebug() << "resolve:" << plugin->symbolicName << "[" << plugin->id << "]";

    // If we enter with tempResolved set, it means that we already have
    // resolved plugins. Check that it is true!
    if (tempResolved.size() > 0 && !tempResolved.contains(plugin))
    {
      PluginException pe("resolve: InternalError1!", PluginException::RESOLVE_ERROR);
      listeners.frameworkError(plugin->q_func(), pe);
      throw pe;
    }

    tempResolved.clear();
    tempResolved.insert(plugin);

    checkRequirePlugin(plugin);

    tempResolved.clear();

    qDebug() << "resolve: Done for" << plugin->symbolicName << "[" << plugin->id << "]";
  }

  void PluginFrameworkContext::checkRequirePlugin(PluginPrivate *plugin)
  {
    if (!plugin->require.isEmpty())
    {
      qDebug() << "checkRequirePlugin: check requiring plugin" << plugin->id;

      QListIterator<RequirePlugin*> i(plugin->require);
      while (i.hasNext())
      {
        RequirePlugin* pr = i.next();
        QList<Plugin*> pl = plugins->getPlugins(pr->name, pr->pluginRange);
        PluginPrivate* ok = 0;
        for (QListIterator<Plugin*> pci(pl); pci.hasNext() && ok == 0; )
        {
          PluginPrivate* p2 = pci.next()->d_func();
          if (tempResolved.contains(p2))
          {
            ok = p2;
          }
          else if (PluginPrivate::RESOLVED_FLAGS & p2->state)
          {
            ok = p2;
          }
          else if (p2->state == Plugin::INSTALLED) {
            QSet<PluginPrivate*> oldTempResolved = tempResolved;
            tempResolved.insert(p2);
            checkRequirePlugin(p2);
            tempResolved = oldTempResolved;
            ok = p2;
          }
        }

        if (!ok && pr->resolution == PluginConstants::RESOLUTION_MANDATORY)
        {
          tempResolved.clear();
          qDebug() << "checkRequirePlugin: failed to satisfy:" << pr->name;
          throw PluginException(QString("Failed to resolve required plugin: %1").arg(pr->name));
        }
      }
    }
  }


}