Finders.cpp

Go to the documentation of this file.

/*
  Copyright (C) 2008 National Institute For Space Research (INPE) - Brazil.

  This file is part of the TerraLib - a Framework for building GIS enabled
  applications.

  TerraLib is free software: you can redistribute it and/or modify
  it under the terms of the GNU Lesser General Public License as published by
  the Free Software Foundation, either version 3 of the License,
  or (at your option) any later version.

  TerraLib 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 Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License
  along with TerraLib. See COPYING. If not, write to
  TerraLib Team at <terralib-team@terralib.org>.
 */

/*!
  \file terralib/core/plugin/Finders.cpp

  \brief General utilities for searching for plugins.

  \author Gilberto Ribeiro de Queiroz
  \author Matheus Cavassan Zaglia
 */

// TerraLib
#include "Finders.h"
#include "../filesystem/FileSystem.h"
#include "../utils/Platform.h"
#include "Exception.h"
#include "Serializers.h"
#include "Utils.h"

// Boost
#include <boost/algorithm/string/predicate.hpp>
#include <boost/filesystem.hpp>

static std::vector<std::string> GetDefaultLookupDirs();

static std::vector<te::core::PluginInfo> GetPluginsInfo(const std::vector<std::string>& lookup_dirs)
{
  std::vector<te::core::PluginInfo> found_plugins;

  for (const std::string& plugins_dir : lookup_dirs)
  {
    if (plugins_dir.empty() || !te::core::FileSystem::isDirectory(plugins_dir))
      continue;

    boost::filesystem::path p(plugins_dir);

    std::vector<std::string> dir =
      te::core::FileSystem::listDirectory(p.string());
    for (std::string file : dir)
    {
      if (!te::core::FileSystem::isRegularFile(file))
        continue;
      if (boost::algorithm::ends_with(file, ".teplg.json"))
      {
        te::core::PluginInfo pinfo = te::core::JSONPluginInfoSerializer(file);

        found_plugins.push_back(pinfo);
      }
    }
  }

  return found_plugins;
}

std::vector<te::core::PluginInfo> te::core::DefaultPluginFinder()
{
  // Retrieve the list of default directories to look up.
  std::vector<std::string> lookup_dirs = GetDefaultLookupDirs();

  return GetPluginsInfo(lookup_dirs);
}

static std::vector<std::string> GetDefaultLookupDirs()
{
  std::vector<std::string> plugin_directories;

  // Add application current directory as a search path
  plugin_directories.push_back(
      te::core::FileSystem::systemCompletePath("."));

  // Let's check if there is a directory called "share/terralib/plugins" in the
  // application path
  std::string plg_dir = te::core::FindInTerraLibPath("share/terralib/plugins");

  if (!plg_dir.empty())
    plugin_directories.push_back(plg_dir);

  return plugin_directories;
}

std::vector<te::core::PluginInfo> te::core::PluginFinder(const std::vector<std::string>& dirs)
{
  // Getting default plugins info 
  std::vector<te::core::PluginInfo> info = DefaultPluginFinder();

  // Getting addtional plug-ins info from configuration files
  std::vector<te::core::PluginInfo> add_info = GetPluginsInfo(dirs);

  if (!add_info.empty())
    info.insert(info.end(), add_info.begin(), add_info.end());

  return info;
}