aboutsummaryrefslogtreecommitdiff
path: root/src/clients/cave/cmd_print_id_environment_variable.cc
blob: 6dc82b785605d3f5b4f993d65d61d0daeb574033 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
/* vim: set sw=4 sts=4 et foldmethod=syntax : */

/*
 * Copyright (c) 2008, 2009, 2010 Ciaran McCreesh
 * Copyright (c) 2010 David Leverton
 *
 * 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 "cmd_print_id_environment_variable.hh"
#include "format_string.hh"
#include "exceptions.hh"
#include <paludis/args/args.hh>
#include <paludis/args/do_help.hh>
#include <paludis/util/map.hh>
#include <paludis/environment.hh>
#include <paludis/user_dep_spec.hh>
#include <paludis/filtered_generator.hh>
#include <paludis/generator.hh>
#include <paludis/selection.hh>
#include <paludis/package_id.hh>
#include <paludis/repository.hh>
#include <iostream>
#include <cstdlib>

#include "command_command_line.hh"

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

namespace
{
    struct PrintIDEnvironmentVariableCommandLine :
        CaveCommandCommandLine
    {
        virtual std::string app_name() const
        {
            return "cave print-id-environment-variable";
        }

        virtual std::string app_synopsis() const
        {
            return "Prints ID environment variables.";
        }

        virtual std::string app_description() const
        {
            return "Prints ID environment variables. No formatting is used, "
                "making the output suitable for parsing by scripts.";
        }

        args::ArgsGroup g_spec_options;
        args::SwitchArg a_all;
        args::SwitchArg a_best;

        args::ArgsGroup g_filters;
        args::StringSequenceArg a_variable_name;

        args::ArgsGroup g_display_options;
        args::StringArg a_format;

        PrintIDEnvironmentVariableCommandLine() :
            g_spec_options(main_options_section(), "Spec Options", "Alter how the supplied spec is used."),
            a_all(&g_spec_options, "all", 'a', "If the spec matches multiple IDs, display all matches.", true),
            a_best(&g_spec_options, "best", '\0', "If the spec matches multiple IDs, select the best ID rather than giving an error.", true),
            g_filters(main_options_section(), "Filters", "Filter the output. Each filter may be specified more than once."),
            a_variable_name(&g_filters, "variable-name", '\0', "Show this environment variable. If specified more than once, "
                    "any name match is accepted.  Must be specified at least once."),
            g_display_options(main_options_section(), "Display Options", "Controls the output format."),
            a_format(&g_display_options, "format", '\0', "Select the output format. Special tokens recognised are "
                    "%n for variable name, %v for value, "
                    "\\n for newline, \\t for tab. Default is '%n=%v\\n'.")
        {
            a_format.set_argument("%n=%v\\n");
            add_usage_line("--variable-name var [ --format format ] spec");
        }
    };

    void do_one_var(
            const PackageDepSpec & s,
            const std::shared_ptr<const PackageID> & id,
            const std::string & n,
            const PrintIDEnvironmentVariableCommandLine & cmdline
            )
    {
        std::shared_ptr<const Repository> r(id->repository());

        if (0 != r->environment_variable_interface())
        {
            std::shared_ptr<Map<char, std::string> > m(std::make_shared<Map<char, std::string>>());
            m->insert('n', n);
            m->insert('v', r->environment_variable_interface()->get_environment_variable(id, n));

            cout << format_string(cmdline.a_format.argument(), m);
        }
        else
            throw BadIDForCommand(s, id, "does not support getting environment variables");
    }
}

int
PrintIDEnvironmentVariableCommand::run(
        const std::shared_ptr<Environment> & env,
        const std::shared_ptr<const Sequence<std::string > > & args
        )
{
    PrintIDEnvironmentVariableCommandLine cmdline;
    cmdline.run(args, "CAVE", "CAVE_PRINT_ID_ENVIRONMENT_VARIABLE_OPTIONS", "CAVE_PRINT_ID_ENVIRONMENT_VARIABLE_CMDLINE");

    if (cmdline.a_help.specified())
    {
        cout << cmdline;
        return EXIT_SUCCESS;
    }

    if (1 != std::distance(cmdline.begin_parameters(), cmdline.end_parameters()))
        throw args::DoHelp("print-id-environment-variable takes exactly one parameter");

    PackageDepSpec spec(parse_user_package_dep_spec(*cmdline.begin_parameters(), env.get(), { updso_allow_wildcards }));

    std::shared_ptr<const PackageIDSequence> entries(
            (*env)[selection::AllVersionsSorted(generator::Matches(spec, { }))]);

    if (entries->empty())
        throw NothingMatching(spec);

    if ((! cmdline.a_best.specified()) && (! cmdline.a_all.specified())
            && (next(entries->begin()) != entries->end()))
        throw BeMoreSpecific(spec, entries);

    if (! cmdline.a_variable_name.specified())
        throw args::DoHelp("print-id-enviroment-variable requires at least one variable name");

    for (auto i(cmdline.a_best.specified() ? entries->last() : entries->begin()), i_end(entries->end()) ;
            i != i_end ; ++i)
        for (args::StringSequenceArg::ConstIterator v(cmdline.a_variable_name.begin_args()), v_end(cmdline.a_variable_name.end_args()) ;
                v != v_end ; ++v)
            do_one_var(spec, *i, *v, cmdline);

    return EXIT_SUCCESS;
}

std::shared_ptr<args::ArgsHandler>
PrintIDEnvironmentVariableCommand::make_doc_cmdline()
{
    return std::make_shared<PrintIDEnvironmentVariableCommandLine>();
}