aboutsummaryrefslogtreecommitdiff
path: root/src/clients/cave/cmd_print_ids.cc
blob: e987d8e90cc8e16d83c8b19d014ea7b0cc54f0e5 (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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
/* vim: set sw=4 sts=4 et foldmethod=syntax : */

/*
 * Copyright (c) 2008, 2009, 2010, 2011 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 "cmd_print_ids.hh"
#include "format_string.hh"
#include <paludis/args/args.hh>
#include <paludis/args/do_help.hh>
#include <paludis/name.hh>
#include <paludis/environment.hh>
#include <paludis/package_database.hh>
#include <paludis/repository.hh>
#include <paludis/util/set.hh>
#include <paludis/util/wrapped_forward_iterator.hh>
#include <paludis/util/indirect_iterator-impl.hh>
#include <paludis/util/visitor_cast.hh>
#include <paludis/util/map.hh>
#include <paludis/util/make_null_shared_ptr.hh>
#include <paludis/generator.hh>
#include <paludis/filtered_generator.hh>
#include <paludis/filter.hh>
#include <paludis/filter_handler.hh>
#include <paludis/selection.hh>
#include <paludis/user_dep_spec.hh>
#include <paludis/package_id.hh>
#include <paludis/mask.hh>
#include <paludis/metadata_key.hh>
#include <cstdlib>
#include <iostream>
#include <algorithm>

#include "command_command_line.hh"

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

namespace
{
    struct PrintIDsCommandLine :
        CaveCommandCommandLine
    {
        virtual std::string app_name() const
        {
            return "cave print-ids";
        }

        virtual std::string app_synopsis() const
        {
            return "Prints a list of known IDs.";
        }

        virtual std::string app_description() const
        {
            return "Prints a list of known IDs. No formatting is used, making the output suitable for "
                "parsing by scripts.";
        }

        args::ArgsGroup g_filters;
        args::StringSetArg a_matching;
        args::StringSetArg a_supporting;
        args::StringSetArg a_with_mask;

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

        PrintIDsCommandLine() :
            g_filters(main_options_section(), "Filters", "Filter the output. Each filter may be specified more than once."),
            a_matching(&g_filters, "matching", 'm', "Show only IDs matching this spec. If specified multiple "
                    "times, only IDs matching every spec are selected.",
                    args::StringSetArg::StringSetArgOptions()),
            a_supporting(&g_filters, "supporting", 's', "Show only IDs supporting this action. If specified "
                    "multiple times, all listed actions must be supported.",
                    args::StringSetArg::StringSetArgOptions
                    ("install",       "able to be installed")
                    ("uninstall",     "able to be uninstalled")
                    ("pretend",       "has pretend-install-time checks")
                    ("config",        "supports post-install configuration")
                    ("fetch",         "able to have sources fetched")
                    ("pretend-fetch", "able to have sources pretend-fetched")
                    ("info",          "provides extra pre- or post-install information")
                    ),
            a_with_mask(&g_filters, "with-mask", 'M', "Show only IDs with this kind of mask. If specified "
                    "multiple times, all listed masks must be present.",
                    args::StringSetArg::StringSetArgOptions
                    ("none",          "no mask")
                    ("any",           "any kind of mask")
                    ("user",          "masked by user")
                    ("unaccepted",    "masked by unaccepted key")
                    ("repository",    "masked by repository")
                    ("unsupported",   "masked because it is unsupported")
                    ("association",   "masked by association")
                   ),
            g_display_options(main_options_section(), "Display Options", "Controls the output format."),
            a_format(&g_display_options, "format", 'f', "Select the output format. Special tokens recognised are "
                    "%c for category, %p for package, %v for version, %s for slot, %: for ':' if we have a slot and "
                    "empty otherwise, %r for repository, %F for the canonical full form, %V for the canonical full "
                    "version, %W for the canonical full unversioned form, %N for the canonical full unnamed form, "
                    "\\n for newline, \\t for tab. Default is '%F\\n'.")
        {
            add_usage_line("[ --matching spec ] [ --supporting action ] [ --with-mask mask-kind ]");
            a_format.set_argument("%F\\n");
        }
    };

    struct WithMaskFilterHandler :
        FilterHandler
    {
        const PrintIDsCommandLine & cmdline;
        const std::string mask;

        WithMaskFilterHandler(const PrintIDsCommandLine & c, const std::string & f) :
            cmdline(c),
            mask(f)
        {
        }

        virtual std::string as_string() const
        {
            return "with mask '" + mask + "'";
        }

        virtual std::shared_ptr<const RepositoryNameSet> repositories(
                const Environment * const,
                const std::shared_ptr<const RepositoryNameSet> & r) const
        {
            return r;
        }

        virtual std::shared_ptr<const CategoryNamePartSet> categories(
                const Environment * const,
                const std::shared_ptr<const RepositoryNameSet> &,
                const std::shared_ptr<const CategoryNamePartSet> & c) const
        {
            return c;
        }

        virtual std::shared_ptr<const QualifiedPackageNameSet> packages(
                const Environment * const,
                const std::shared_ptr<const RepositoryNameSet> &,
                const std::shared_ptr<const QualifiedPackageNameSet> & q) const
        {
            return q;
        }

        virtual std::shared_ptr<const PackageIDSet> ids(
                const Environment * const,
                const std::shared_ptr<const PackageIDSet> & c) const
        {
            std::shared_ptr<PackageIDSet> result(std::make_shared<PackageIDSet>());

            for (PackageIDSet::ConstIterator i(c->begin()), i_end(c->end()) ;
                    i != i_end ; ++i)
            {
                if (mask == "none")
                {
                    if (! (*i)->masked())
                        result->insert(*i);
                }
                else if (mask == "any")
                {
                    if ((*i)->masked())
                        result->insert(*i);
                }
                else if (mask == "user")
                {
                    for (PackageID::MasksConstIterator m((*i)->begin_masks()), m_end((*i)->end_masks()) ;
                            m != m_end ; ++m)
                        if (visitor_cast<const UserMask>(**m))
                        {
                            result->insert(*i);
                            break;
                        }
                }
                else if (mask == "unaccepted")
                {
                    for (PackageID::MasksConstIterator m((*i)->begin_masks()), m_end((*i)->end_masks()) ;
                            m != m_end ; ++m)
                        if (visitor_cast<const UnacceptedMask>(**m))
                        {
                            result->insert(*i);
                            break;
                        }
                }
                else if (mask == "repository")
                {
                    for (PackageID::MasksConstIterator m((*i)->begin_masks()), m_end((*i)->end_masks()) ;
                            m != m_end ; ++m)
                        if (visitor_cast<const RepositoryMask>(**m))
                        {
                            result->insert(*i);
                            break;
                        }
                }
                else if (mask == "unsupported")
                {
                    for (PackageID::MasksConstIterator m((*i)->begin_masks()), m_end((*i)->end_masks()) ;
                            m != m_end ; ++m)
                        if (visitor_cast<const UnsupportedMask>(**m))
                        {
                            result->insert(*i);
                            break;
                        }
                }
                else if (mask == "association")
                {
                    for (PackageID::MasksConstIterator m((*i)->begin_masks()), m_end((*i)->end_masks()) ;
                            m != m_end ; ++m)
                        if (visitor_cast<const AssociationMask>(**m))
                        {
                            result->insert(*i);
                            break;
                        }
                }
                else
                    throw args::DoHelp("Unknown --" + cmdline.a_with_mask.long_name() + " value '" + mask + "'");
            }

            return result;
        }
    };

    struct WithMaskFilter :
        Filter
    {
        WithMaskFilter(const PrintIDsCommandLine & c, const std::string & f) :
            Filter(std::make_shared<WithMaskFilterHandler>(c, f))
        {
        }
    };

    std::string format_id(
            const PrintIDsCommandLine & c,
            const std::shared_ptr<const PackageID> & i)
    {
        std::shared_ptr<Map<char, std::string> > m(std::make_shared<Map<char, std::string>>());
        m->insert('c', stringify(i->name().category()));
        m->insert('p', stringify(i->name().package()));
        m->insert('v', stringify(i->version()));
        m->insert('s', i->slot_key() ? stringify(i->slot_key()->value()) : "");
        m->insert(':', i->slot_key() ? ":" : "");
        m->insert('r', stringify(i->repository_name()));
        m->insert('F', i->canonical_form(idcf_full));
        m->insert('V', i->canonical_form(idcf_version));
        m->insert('W', i->canonical_form(idcf_no_version));
        m->insert('N', i->canonical_form(idcf_no_name));
        return format_string(c.a_format.argument(), m);
    }
}

int
PrintIDsCommand::run(
        const std::shared_ptr<Environment> & env,
        const std::shared_ptr<const Sequence<std::string > > & args
        )
{
    PrintIDsCommandLine cmdline;
    cmdline.run(args, "CAVE", "CAVE_PRINT_IDS_OPTIONS", "CAVE_PRINT_IDS_CMDLINE");

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

    if (cmdline.begin_parameters() != cmdline.end_parameters())
        throw args::DoHelp("print-ids takes no parameters");

    Generator g((generator::All()));
    if (cmdline.a_matching.specified())
    {
        for (args::StringSetArg::ConstIterator m(cmdline.a_matching.begin_args()),
                m_end(cmdline.a_matching.end_args()) ;
                m != m_end ; ++m)
        {
            PackageDepSpec s(parse_user_package_dep_spec(*m, env.get(), { updso_allow_wildcards }));
            g = g & generator::Matches(s, make_null_shared_ptr(), { });
        }
    }

    FilteredGenerator fg(g);

    if (cmdline.a_supporting.specified())
    {
        for (args::StringSetArg::ConstIterator m(cmdline.a_supporting.begin_args()),
                m_end(cmdline.a_supporting.end_args()) ;
                m != m_end ; ++m)
        {
            if (*m == "install")
                fg = fg | filter::SupportsAction<InstallAction>();
            else if (*m == "uninstall")
                fg = fg | filter::SupportsAction<UninstallAction>();
            else if (*m == "pretend")
                fg = fg | filter::SupportsAction<PretendAction>();
            else if (*m == "config")
                fg = fg | filter::SupportsAction<ConfigAction>();
            else if (*m == "fetch")
                fg = fg | filter::SupportsAction<FetchAction>();
            else if (*m == "pretend-fetch")
                fg = fg | filter::SupportsAction<PretendFetchAction>();
            else if (*m == "info")
                fg = fg | filter::SupportsAction<InfoAction>();
            else
                throw args::DoHelp("Unknown --" + cmdline.a_supporting.long_name() + " value '" + *m + "'");
        }
    }

    if (cmdline.a_with_mask.specified())
    {
        for (args::StringSetArg::ConstIterator m(cmdline.a_with_mask.begin_args()),
                m_end(cmdline.a_with_mask.end_args()) ;
                m != m_end ; ++m)
        {
            fg = fg | WithMaskFilter(cmdline, *m);
        }
    }

    const std::shared_ptr<const PackageIDSequence> ids((*env)[selection::AllVersionsSorted(fg)]);
    for (PackageIDSequence::ConstIterator i(ids->begin()), i_end(ids->end()) ;
            i != i_end ; ++i)
        cout << format_id(cmdline, *i);

    return EXIT_SUCCESS;
}

std::shared_ptr<args::ArgsHandler>
PrintIDsCommand::make_doc_cmdline()
{
    return std::make_shared<PrintIDsCommandLine>();
}