CTK/Libs/PluginFramework/ctkPluginFramework.cpp

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

  Library: CTK

  Copyright (c) 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 "ctkPlugin_p.h"
#include "ctkPluginArchive_p.h"
#include "ctkPluginConstants.h"
#include "ctkPluginFramework.h"
#include "ctkPluginFramework_p.h"
#include "ctkPluginFrameworkContext_p.h"

#include "service/event/ctkEvent.h"

//----------------------------------------------------------------------------
ctkPluginFramework::ctkPluginFramework()
  : ctkPlugin()
{
  qRegisterMetaType<ctkPluginFrameworkEvent>("ctkPluginFrameworkEvent");
  qRegisterMetaType<ctkPluginEvent>("ctkPluginEvent");
  qRegisterMetaType<ctkServiceEvent>("ctkServiceEvent");
  qRegisterMetaType<ctkEvent>("ctkEvent");
  qRegisterMetaType<ctkProperties>("ctkProperties");
  qRegisterMetaType<ctkDictionary>("ctkDictionary");
  qRegisterMetaType<ctkServiceReference>("ctkServiceReference");
  qRegisterMetaType<QSharedPointer<ctkPlugin> >("QSharedPointer<ctkPlugin>");
  //TODO: register all ctk Framework defined MetaType.
}

//----------------------------------------------------------------------------
void ctkPluginFramework::init()
{
  Q_D(ctkPluginFramework);

  ctkPluginPrivate::Locker sync(&d->lock);
  d->waitOnOperation(&d->lock, "Framework.init", true);
  switch (d->state)
  {
  case ctkPlugin::INSTALLED:
  case ctkPlugin::RESOLVED:
    break;
  case ctkPlugin::STARTING:
  case ctkPlugin::ACTIVE:
    return;
  default:
    throw ctkIllegalStateException("INTERNAL ERROR, Illegal state");
  }
  d->init();
}

//----------------------------------------------------------------------------
ctkPluginFrameworkEvent ctkPluginFramework::waitForStop(unsigned long timeout)
{
  Q_D(ctkPluginFramework);

  ctkPluginPrivate::Locker sync(&d->lock);

  // Already stopped?
  if ((d->state & (INSTALLED | RESOLVED)) == 0)
  {
    d->stopEvent.isNull = true;
    d->lock.wait(timeout ? timeout : ULONG_MAX);

    if (d->stopEvent.isNull)
    {
      return ctkPluginFrameworkEvent(ctkPluginFrameworkEvent::FRAMEWORK_WAIT_TIMEDOUT, this->d_func()->q_func());
    }
  }
  else if (d->stopEvent.isNull)
  {
    // Return this if stop or update have not been called and framework is stopped.
    d->stopEvent.isNull = false;
    d->stopEvent.type = ctkPluginFrameworkEvent::FRAMEWORK_STOPPED;
  }
  return d->stopEvent.isNull ? ctkPluginFrameworkEvent() :
                               ctkPluginFrameworkEvent(ctkPluginFrameworkEvent::FRAMEWORK_STOPPED, this->d_func()->q_func());
}

//----------------------------------------------------------------------------
void ctkPluginFramework::start(const ctkPlugin::StartOptions& options)
{
  Q_UNUSED(options);
  Q_D(ctkPluginFramework);

  QStringList pluginsToStart;
  {
    ctkPluginPrivate::Locker sync(&d->lock);
    d->waitOnOperation(&d->lock, "ctkPluginFramework::start", true);

    switch (d->state)
    {
    case INSTALLED:
    case RESOLVED:
      d->init();
    case STARTING:
      d->operation.fetchAndStoreOrdered(ctkPluginPrivate::ACTIVATING);
      break;
    case ACTIVE:
      return;
    default:
      throw ctkIllegalStateException("INTERNAL ERROR, Illegal state");
    }

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

  d->activate(d->pluginContext.data());

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

  {
    ctkPluginPrivate::Locker sync(&d->lock);
    d->state = ACTIVE;
    d->operation = ctkPluginPrivate::IDLE;
    d->lock.wakeAll();
    d->fwCtx->listeners.emitFrameworkEvent(
        ctkPluginFrameworkEvent(ctkPluginFrameworkEvent::FRAMEWORK_STARTED, this->d_func()->q_func()));
  }
}

//----------------------------------------------------------------------------
void ctkPluginFramework::stop(const StopOptions& options)
{
  Q_UNUSED(options)

  Q_D(ctkPluginFramework);
  d->shutdown(false);
}

//----------------------------------------------------------------------------
void ctkPluginFramework::uninstall()
{
  throw ctkPluginException("uninstall of System plugin is not allowed",
                           ctkPluginException::INVALID_OPERATION);
}

//----------------------------------------------------------------------------
QStringList ctkPluginFramework::getResourceList(const QString& path) const
{
  QString resourcePath = QString(":/") + ctkPluginConstants::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 ctkPluginFramework::getResource(const QString& path) const
{
  QString resourcePath = QString(":/") + ctkPluginConstants::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> ctkPluginFramework::getHeaders()
{
  //TODO security
  Q_D(ctkPluginFramework);
  return d->systemHeaders;
}