CTK/Libs/PluginFramework/ctkPluginFramework.cpp

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

  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 "ctkPluginFramework.h"

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


namespace ctk {

  PluginFramework::PluginFramework(PluginFrameworkContext* fw)
    : Plugin(*new PluginFrameworkPrivate(*this, fw))
  {
    qRegisterMetaType<PluginFrameworkEvent>("PluginFrameworkEvent");
  }

  void PluginFramework::init()
  {
    Q_D(PluginFramework);

    QMutexLocker sync(&d->lock);
    // waitOnActivation(d->lock, "Framework.init", true);
    switch (d->state)
    {
    case Plugin::INSTALLED:
    case Plugin::RESOLVED:
      break;
    case Plugin::STARTING:
    case Plugin::ACTIVE:
      return;
    default:
      throw std::logic_error("INTERNAL ERROR, Illegal state");
    }
    d->init();
  }

  void PluginFramework::start(const Plugin::StartOptions& options)
  {
    Q_UNUSED(options);
    Q_D(PluginFramework);

    QStringList pluginsToStart;
    {
      QMutexLocker sync(&d->lock);
      // TODO: parallel start
      //waitOnActivation(lock, "PluginFramework::start", true);

      switch (d->state)
      {
      case INSTALLED:
      case RESOLVED:
        d->init();
      case STARTING:
        d->activating = true;
        break;
      case ACTIVE:
        return;
      default:
        throw std::logic_error("INTERNAL ERROR, Illegal state");
      }

      pluginsToStart = d->fwCtx->storage.getStartOnLaunchPlugins();
    }

    // Start plugins according to their autostart setting.
    QStringListIterator i(pluginsToStart);
    while (i.hasNext())
    {
      Plugin* p = d->fwCtx->plugins->getPlugin(i.next());
      try {
        const int autostartSetting = p->d_func()->archive->getAutostartSetting();
        // Launch must not change the autostart setting of a plugin
        StartOptions option = Plugin::START_TRANSIENT;
        if (Plugin::START_ACTIVATION_POLICY == autostartSetting)
        {
          // Transient start according to the plugins activation policy.
          option |= Plugin::START_ACTIVATION_POLICY;
        }
        p->start(option);
      }
      catch (const PluginException& pe)
      {
        d->fwCtx->listeners.frameworkError(p, pe);
      }
    }

    {
      QMutexLocker sync(&d->lock);
      d->state = ACTIVE;
      d->activating = false;
      d->fwCtx->listeners.emitFrameworkEvent(
          PluginFrameworkEvent(PluginFrameworkEvent::STARTED, this));
    }
  }

  QStringList PluginFramework::getResourceList(const QString& path) const
  {
    QString resourcePath = QString(":/") + PluginConstants::SYSTEM_PLUGIN_SYMBOLICNAME;
    if (path.startsWith('/'))
      resourcePath += path;
    else
      resourcePath += QString("/") + path;

    QStringList paths;
    QFileInfoList entryInfoList = QDir(resourcePath).entryInfoList();
    QListIterator<QFileInfo> infoIter(entryInfoList);
    while (infoIter.hasNext())
    {
      const QFileInfo& resInfo = infoIter.next();
      QString entry = resInfo.canonicalFilePath().mid(resourcePath.size());
      if (resInfo.isDir())
        entry += "/";

      paths << entry;
    }

    return paths;
  }

  QByteArray PluginFramework::getResource(const QString& path) const
  {
    QString resourcePath = QString(":/") + PluginConstants::SYSTEM_PLUGIN_SYMBOLICNAME;
    if (path.startsWith('/'))
      resourcePath += path;
    else
      resourcePath += QString("/") + path;

    QFile resourceFile(resourcePath);
    resourceFile.open(QIODevice::ReadOnly);
    return resourceFile.readAll();
  }

  QHash<QString, QString> PluginFramework::getHeaders()
  {
    //TODO security
    Q_D(PluginFramework);
    return d->systemHeaders;
  }

}