path: root/utils/instruo.cpp

/* This file was partly copied from Paludis src/clients/instruo/instruo.cc.
 * The metadata generation logic is reimplemented with libbash. This file is
 * licensed as follows: */

/*
 * Copyright (c) 2007, 2008, 2009, 2010 Ciaran McCreesh
 *
 * This file is part of the Paludis package manager. Paludis is free software;
 * you can redistribute it and/or modify it under the terms of the GNU General
 * Public License version 2, as published by the Free Software Foundation.
 *
 * Paludis 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., 59 Temple
 * Place, Suite 330, Boston, MA  02111-1307  USA
 */

#include <algorithm>
#include <fstream>
#include <functional>
#include <iostream>
#include <map>

#include <paludis/args/do_help.hh>
#include <paludis/about.hh>
#include <paludis/action.hh>
#include <paludis/package_id.hh>
#include <paludis/generator.hh>
#include <paludis/filter.hh>
#include <paludis/filtered_generator.hh>
#include <paludis/selection.hh>
#include <paludis/util/system.hh>
#include <paludis/util/join.hh>
#include <paludis/util/log.hh>
#include <paludis/util/sequence.hh>
#include <paludis/util/map.hh>
#include <paludis/util/visitor_cast.hh>
#include <paludis/util/set.hh>
#include <paludis/util/make_named_values.hh>
#include <paludis/util/mutex.hh>
#include <paludis/util/thread_pool.hh>
#include <paludis/util/destringify.hh>
#include <paludis/util/safe_ofstream.hh>
#include <paludis/util/pretty_print.hh>
#include <paludis/util/indirect_iterator-impl.hh>
#include <paludis/util/timestamp.hh>
#include <paludis/util/accept_visitor.hh>
#include <paludis/environments/no_config/no_config_environment.hh>
#include <paludis/package_database.hh>
#include <paludis/metadata_key.hh>

#include "builtins/builtin_exceptions.h"
#include "command_line.h"
#include "libbash.h"
#include "utils/metadata.h"

using namespace paludis;
using std::cout;
using std::cerr;
using std::endl;

void worker(const std::shared_ptr<PackageIDSequence> &ids)
{
  std::unordered_map<std::string, std::vector<std::string>> variables;

  std::shared_ptr<const PackageID> id;
  unsigned total(0);
  CategoryNamePart old_cat("OLDCAT");
  while(!ids->empty())
  {
    id = *ids->begin();
    ids->pop_front();
    if (id->name().category() != old_cat)
    {
      std::cout << "Processing " << stringify(id->name().category()) << "..." << std::endl;
      old_cat = id->name().category();
      FSPath(CommandLine::get_instance()->a_output_directory.argument() + "/" +
          stringify(id->name().category())).mkdir(0755,  {fspmkdo_ok_if_exists});
      ++total;
    }

    Context i_context("When generating metadata for ID '" + stringify(*id) + "':");

    variables.clear();
    variables["PN"].push_back(stringify(id->name().package()));
    variables["PV"].push_back(stringify(id->version().remove_revision()));
    variables["P"].push_back(stringify(id->name().package()) + "-" +
                             stringify(id->version().remove_revision()));
    variables["PR"].push_back(id->version().revision_only());
    variables["PVR"].push_back(stringify(id->version()));
    variables["PF"].push_back(stringify(id->name().package()) + "-" + stringify(id->version()));
    variables["CATEGORY"].push_back(stringify(id->name().category()));
    std::vector<std::string> functions;

    std::string ebuild_path(CommandLine::get_instance()->a_repository_directory.argument() +
                            variables["CATEGORY"][0] + "/" +
                            variables["PN"][0] + "/" +
                            variables["PN"][0] + "-" +
                            variables["PVR"][0] + ".ebuild");
    try
    {
      libbash::interpret(ebuild_path, "utils/isolated-functions.sh", variables, functions);
    }
    catch(const interpreter_exception& e)
    {
      cerr << "Exception occurred while interpreting " << ebuild_path << ". The error message is:\n"
        << e.what() << endl;
      continue;
    }
    catch(const return_exception& e)
    {
      cerr << "Unhandled return exception in " << ebuild_path << ". The error message is:\n"
        << e.what() << endl;
      continue;
    }
    catch (...)
    {
      cerr << "Unhandled exception in " << ebuild_path << endl;
      continue;
    }

    std::string output_path(CommandLine::get_instance()->a_output_directory.argument() + "/" +
                            variables["CATEGORY"][0] + "/" +
                            variables["PN"][0] + "-" +
                            variables["PVR"][0]);
    FSPath(output_path).dirname().mkdir(0755, {fspmkdo_ok_if_exists});
    std::ofstream output(output_path, std::ofstream::out | std::ofstream::trunc);
    write_metadata(output, variables, functions);
  }
}

int main(int argc, char** argv)
{
  try
  {
    std::string options(paludis::getenv_with_default("INSTRUO_OPTIONS", ""));
    if (! options.empty())
        options = "(" + options + ") ";
    options += join(argv + 1, argv + argc, " ");

    Context context(std::string("In program ") + argv[0] + " " + options + ":");

    CommandLine::get_instance()->run(argc, argv, "instruo", "INSTRUO_OPTIONS", "INSTRUO_CMDLINE");

    if (CommandLine::get_instance()->a_help.specified())
        throw args::DoHelp();

    if (CommandLine::get_instance()->a_log_level.specified())
        Log::get_instance()->set_log_level(CommandLine::get_instance()->a_log_level.option());
    else
        Log::get_instance()->set_log_level(ll_qa);

    if (1 < (
                CommandLine::get_instance()->a_generate_cache.specified() +
                CommandLine::get_instance()->a_version.specified()
            ))
        throw args::DoHelp("you should specify exactly one action");

    if (! CommandLine::get_instance()->a_repository_directory.specified())
        CommandLine::get_instance()->a_repository_directory.set_argument(stringify(FSPath::cwd()));

    if (CommandLine::get_instance()->a_version.specified())
    {
        cout << "instruo, part of " << PALUDIS_PACKAGE << " " << PALUDIS_VERSION_MAJOR << "."
            << PALUDIS_VERSION_MINOR << "." << PALUDIS_VERSION_MICRO << PALUDIS_VERSION_SUFFIX;
        if (! std::string(PALUDIS_GIT_HEAD).empty())
            cout << " git " << PALUDIS_GIT_HEAD;
        cout << endl << endl;
        cout << "Paludis comes with ABSOLUTELY NO WARRANTY. Paludis is free software, and you" << endl;
        cout << "are welcome to redistribute it under the terms of the GNU General Public" << endl;
        cout << "License, version 2." << endl;

        return EXIT_SUCCESS;
    }

    if ((
                CommandLine::get_instance()->a_repository_directory.specified() +
                CommandLine::get_instance()->a_output_directory.specified()
        ) < 1)
        throw args::DoHelp("at least one of '--" + CommandLine::get_instance()->a_repository_directory.long_name() + "' or '--"
                + CommandLine::get_instance()->a_output_directory.long_name() + "' must be specified");

    if (! CommandLine::get_instance()->a_output_directory.specified())
        CommandLine::get_instance()->a_output_directory.set_argument(stringify(FSPath::cwd()));

    std::shared_ptr<FSPathSequence> extra_repository_dirs(std::make_shared<FSPathSequence>());
    for (args::StringSequenceArg::ConstIterator d(CommandLine::get_instance()->a_extra_repository_dir.begin_args()),
            d_end(CommandLine::get_instance()->a_extra_repository_dir.end_args()) ;
            d != d_end ; ++d)
        extra_repository_dirs->push_back(FSPath(*d));

    std::shared_ptr<Map<std::string, std::string> > keys(std::make_shared<Map<std::string, std::string>>());
    keys->insert("append_repository_name_to_write_cache", "false");
    NoConfigEnvironment env(make_named_values<no_config_environment::Params>(
                n::accept_unstable() = true,
                n::disable_metadata_cache() = true,
                n::extra_accept_keywords() = "",
                n::extra_params() = keys,
                n::extra_repository_dirs() = extra_repository_dirs,
                n::master_repository_name() = CommandLine::get_instance()->a_master_repository_name.argument(),
                n::profiles_if_not_auto() = "",
                n::repository_dir() = CommandLine::get_instance()->a_repository_directory.argument(),
                n::repository_type() = no_config_environment::ncer_ebuild,
                n::write_cache() = CommandLine::get_instance()->a_output_directory.argument()
            ));

    FSPath(CommandLine::get_instance()->a_output_directory.argument()).mkdir(0755,  {fspmkdo_ok_if_exists});

    std::shared_ptr<PackageIDSequence> ids(env[selection::AllVersionsSorted(
                generator::InRepository(env.main_repository()->name()))]);
    worker(ids);
  }
  catch (const paludis::args::ArgsError & e)
  {
      cerr << "Usage error: " << e.message() << endl;
      cerr << "Try " << argv[0] << " --help" << endl;
      return EXIT_FAILURE;
  }
  catch (const args::DoHelp & h)
  {
      if (h.message.empty())
      {
          cout << "Usage: " << argv[0] << " [options]" << endl;
          cout << endl;
          cout << *CommandLine::get_instance();
          return EXIT_SUCCESS;
      }
      else
      {
          cerr << "Usage error: " << h.message << endl;
          cerr << "Try " << argv[0] << " --help" << endl;
          return EXIT_FAILURE;
      }
  }
  catch (const Exception & e)
  {
      cout << endl;
      cerr << "Unhandled exception:" << endl
          << "  * " << e.backtrace("\n  * ")
          << e.message() << " (" << e.what() << ")" << endl;
      return EXIT_FAILURE;
  }
  catch (const std::exception & e)
  {
      cout << endl;
      cerr << "Unhandled exception:" << endl
          << "  * " << e.what() << endl;
      return EXIT_FAILURE;
  }
  catch (...)
  {
      cout << endl;
      cerr << "Unhandled exception:" << endl
          << "  * Unknown exception type. Ouch..." << endl;
      return EXIT_FAILURE;
  }

  return EXIT_SUCCESS;
}