Branch data Line data Source code
1 : : /*-
2 : : * Copyright (c) 2011-2012 Baptiste Daroussin <bapt@FreeBSD.org>
3 : : * Copyright (c) 2011-2012 Julien Laffaye <jlaffaye@FreeBSD.org>
4 : : * Copyright (c) 2011-2012 Marin Atanasov Nikolov <dnaeon@gmail.com>
5 : : * Copyright (c) 2012-2013 Bryan Drewery <bdrewery@FreeBSD.org>
6 : : * Copyright (c) 2014 Matthew Seaman <matthew@FreeBSD.org>
7 : : * All rights reserved.
8 : : *
9 : : * Redistribution and use in source and binary forms, with or without
10 : : * modification, are permitted provided that the following conditions
11 : : * are met:
12 : : * 1. Redistributions of source code must retain the above copyright
13 : : * notice, this list of conditions and the following disclaimer
14 : : * in this position and unchanged.
15 : : * 2. Redistributions in binary form must reproduce the above copyright
16 : : * notice, this list of conditions and the following disclaimer in the
17 : : * documentation and/or other materials provided with the distribution.
18 : : *
19 : : * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
20 : : * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21 : : * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22 : : * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
23 : : * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24 : : * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 : : * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 : : * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 : : * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28 : : * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 : : */
30 : :
31 : : #include <err.h>
32 : : #include <getopt.h>
33 : : #include <stdio.h>
34 : : #include <stdlib.h>
35 : : #include <string.h>
36 : : #include <unistd.h>
37 : :
38 : : #include <pkg.h>
39 : :
40 : : #include "pkgcli.h"
41 : :
42 : : typedef struct _cliopt {
43 : : const char *option;
44 : : char key;
45 : : } cliopt;
46 : :
47 : : /* an option string should not be a prefix of any other option string */
48 : : static const cliopt search_label[] = {
49 : : { "comment", 'c' },
50 : : { "description", 'd' },
51 : : { "name", 'n' },
52 : : { "origin", 'o' },
53 : : { "pkg-name", 'p' },
54 : : { NULL, '\0' },
55 : : };
56 : :
57 : : static const cliopt modifiers[] = {
58 : : { "annotations", 'A' },
59 : : { "arch", 'a' },
60 : : { "categories", 'C' },
61 : : { "comment", 'c' },
62 : : { "depends-on", 'd' },
63 : : { "description", 'D' },
64 : : { "full", 'f' },
65 : : { "licenses", 'l' },
66 : : { "maintainer", 'm' },
67 : : { "name", 'n' },
68 : : { "options", 'o' },
69 : : { "pkg-size", 'P' },
70 : : { "prefix", 'p' },
71 : : { "repository", 'R' },
72 : : { "required-by", 'r' },
73 : : { "shared-libs-required", 'B' },
74 : : { "shared-libs-provided", 'b' },
75 : : { "size", 's' },
76 : : { "url", 'u' },
77 : : { "version", 'v' },
78 : : { "www", 'w' },
79 : : { NULL, '\0' },
80 : : };
81 : :
82 : : static char
83 : 4 : match_optarg(const cliopt *optlist, const char *opt)
84 : : {
85 : 4 : int i, matched = -1;
86 : 4 : char key = '\0';
87 : : size_t optlen;
88 : :
89 : 4 : optlen = strlen(opt);
90 : :
91 : : /* Match any unique prefix from optlist */
92 [ + + ]: 40 : for (i = 0; optlist[i].option != NULL; i++) {
93 [ + + ]: 36 : if (strncmp(opt, optlist[i].option, optlen) != 0)
94 : 32 : continue;
95 [ - + ]: 4 : if (matched > 0) {
96 : 0 : warnx("\"%s\" is ambiguous. Was "
97 : 0 : "\"%s\" or \"%s\" meant?", opt,
98 : 0 : optlist[matched].option, optlist[i].option);
99 : 0 : key = '\0';
100 : 0 : break;
101 : : }
102 : 4 : matched = i;
103 : 4 : key = optlist[i].key;
104 : 4 : }
105 : 4 : return (key);
106 : : }
107 : :
108 : : static pkgdb_field
109 : 3 : search_label_opt(const char *optionarg)
110 : : {
111 : : pkgdb_field field;
112 : :
113 : : /* label options */
114 [ - - + + : 3 : switch(match_optarg(search_label, optionarg)) {
- - ]
115 : : case 'o':
116 : 2 : field = FIELD_ORIGIN;
117 : 2 : break;
118 : : case 'n':
119 : 1 : field = FIELD_NAME;
120 : 1 : break;
121 : : case 'p':
122 : 0 : field = FIELD_NAMEVER;
123 : 0 : break;
124 : : case 'c':
125 : 0 : field = FIELD_COMMENT;
126 : 0 : break;
127 : : case 'd':
128 : 0 : field = FIELD_DESC;
129 : 0 : break;
130 : : default:
131 : 0 : usage_search();
132 : 0 : errx(EXIT_FAILURE, "Unknown search/label option: %s", optionarg);
133 : : /* NOTREACHED */
134 : : }
135 : 3 : return field;
136 : : }
137 : :
138 : : static unsigned int
139 : 1 : modifier_opt(const char *optionarg)
140 : : {
141 : : unsigned int opt;
142 : :
143 : : /* output modifiers */
144 [ - - - + : 1 : switch(match_optarg(modifiers, optionarg)) {
- - - - -
- - - - -
- - - - -
- - - ]
145 : : case 'A':
146 : 0 : opt = INFO_ANNOTATIONS;
147 : 0 : break;
148 : : case 'a':
149 : 0 : opt = INFO_ARCH;
150 : 0 : break;
151 : : case 'C':
152 : 0 : opt = INFO_CATEGORIES;
153 : 0 : break;
154 : : case 'c':
155 : 1 : opt = INFO_COMMENT;
156 : 1 : break;
157 : : case 'd':
158 : 0 : opt = INFO_DEPS;
159 : 0 : break;
160 : : case 'D':
161 : 0 : opt = INFO_DESCR;
162 : 0 : break;
163 : : case 'f':
164 : 0 : opt = INFO_FULL;
165 : 0 : break;
166 : : case 'l':
167 : 0 : opt = INFO_LICENSES;
168 : 0 : break;
169 : : case 'm':
170 : 0 : opt = INFO_MAINTAINER;
171 : 0 : break;
172 : : case 'n':
173 : 0 : opt = INFO_NAME;
174 : 0 : break;
175 : : case 'o':
176 : 0 : opt = INFO_OPTIONS;
177 : 0 : break;
178 : : case 'P':
179 : 0 : opt = INFO_PKGSIZE;
180 : 0 : break;
181 : : case 'p':
182 : 0 : opt = INFO_PREFIX;
183 : 0 : break;
184 : : case 'R':
185 : 0 : opt = INFO_REPOSITORY;
186 : 0 : break;
187 : : case 'r':
188 : 0 : opt = INFO_RDEPS;
189 : 0 : break;
190 : : case 'B':
191 : 0 : opt = INFO_SHLIBS_REQUIRED;
192 : 0 : break;
193 : : case 'b':
194 : 0 : opt = INFO_SHLIBS_PROVIDED;
195 : 0 : break;
196 : : case 's':
197 : 0 : opt = INFO_FLATSIZE;
198 : 0 : break;
199 : : case 'u':
200 : 0 : opt = INFO_REPOURL;
201 : 0 : break;
202 : : case 'v':
203 : 0 : opt = INFO_VERSION;
204 : 0 : break;
205 : : case 'w':
206 : 0 : opt = INFO_WWW;
207 : 0 : break;
208 : : default:
209 : 0 : usage_search();
210 : 0 : errx(EXIT_FAILURE, "Unkown modifier option %s", optionarg);
211 : : /* NOTREACHED */
212 : : }
213 : 1 : return opt;
214 : : }
215 : :
216 : : void
217 : 0 : usage_search(void)
218 : : {
219 : : int i, n;
220 : :
221 : 0 : fprintf(stderr, "Usage: pkg search [-eU] [-r repo] [-S search] "
222 : : "[-L label] [-Q mod]... [-Cgix] <pkg-name>\n");
223 : 0 : fprintf(stderr, " pkg search [-cDdefopqRU] [-r repo] "
224 : : "[-Cgix] <pattern>\n\n");
225 : 0 : n = fprintf(stderr, " Search and Label options:");
226 [ # # ]: 0 : for (i = 0; search_label[i].option != NULL; i++) {
227 [ # # ]: 0 : if (n > 72)
228 : 0 : n = fprintf(stderr, "\n ");
229 : 0 : n += fprintf(stderr, " %s", search_label[i].option);
230 : 0 : }
231 : 0 : fprintf(stderr, "\n");
232 : 0 : n = fprintf(stderr, " Output Modifiers:");
233 [ # # ]: 0 : for (i = 0; modifiers[i].option != NULL; i++) {
234 [ # # ]: 0 : if (n > 68)
235 : 0 : n = fprintf(stderr, "\n ");
236 : 0 : n += fprintf(stderr, " %s", modifiers[i].option);
237 : 0 : }
238 : 0 : fprintf(stderr, "\n");
239 : 0 : fprintf(stderr, "For more information see 'pkg help search'.\n");
240 : 0 : }
241 : :
242 : : int
243 : 9 : exec_search(int argc, char **argv)
244 : : {
245 : 9 : const char *pattern = NULL;
246 : 9 : int ret = EPKG_OK, ch;
247 : : int flags;
248 : 9 : uint64_t opt = 0;
249 : 9 : match_t match = MATCH_REGEX;
250 : 9 : pkgdb_field search = FIELD_NONE;
251 : 9 : pkgdb_field label = FIELD_NONE;
252 : 9 : struct pkgdb *db = NULL;
253 : 9 : struct pkgdb_it *it = NULL;
254 : 9 : struct pkg *pkg = NULL;
255 : 9 : bool atleastone = false;
256 : : bool old_quiet;
257 : : c_charv_t reponames;
258 : :
259 : 9 : struct option longopts[] = {
260 : : { "case-sensitive", no_argument, NULL, 'C' },
261 : : { "comment", no_argument, NULL, 'c' },
262 : : { "description", no_argument, NULL, 'D' },
263 : : { "depends-on", no_argument, NULL, 'd' },
264 : : { "exact", no_argument, NULL, 'e' },
265 : : { "full", no_argument, NULL, 'f' },
266 : : { "glob", no_argument, NULL, 'g' },
267 : : { "case-insensitive", no_argument, NULL, 'i' },
268 : : { "label", required_argument, NULL, 'L' },
269 : : { "origins", no_argument, NULL, 'o' },
270 : : { "prefix", no_argument, NULL, 'p' },
271 : : { "quiet", no_argument, NULL, 'q' },
272 : : { "query-modifier", required_argument, NULL, 'Q' },
273 : : { "repository", required_argument, NULL, 'r' },
274 : : { "raw", no_argument, NULL, 'R' },
275 : : { "search", required_argument, NULL, 'S' },
276 : : { "size", no_argument, NULL, 's' },
277 : : { "no-repo-update", no_argument, NULL, 'U' },
278 : : { "regex", no_argument, NULL, 'x' },
279 : : { "raw-format", required_argument, NULL, 1 },
280 : : { NULL, 0, NULL, 0 },
281 : : };
282 : :
283 : 9 : pkgvec_init(&reponames);
284 [ + + ]: 16 : while ((ch = getopt_long(argc, argv, "+CcDdefgiL:opqQ:r:RS:sUx", longopts, NULL)) != -1) {
285 [ - - - - : 7 : switch (ch) {
- - - + -
+ - - - +
+ - - + -
- - ]
286 : : case 'C':
287 : 0 : pkgdb_set_case_sensitivity(true);
288 : 0 : break;
289 : : case 'c': /* Same as -S comment */
290 : 0 : search = search_label_opt("comment");
291 : 0 : break;
292 : : case 'D': /* Same as -S description */
293 : 0 : search = search_label_opt("description");
294 : 0 : break;
295 : : case 'd': /* Same as -Q depends-on */
296 : 0 : opt |= modifier_opt("depends-on");
297 : 0 : break;
298 : : case 'e':
299 : 1 : match = MATCH_EXACT;
300 : 1 : break;
301 : : case 'f': /* Same as -Q full */
302 : 0 : opt |= modifier_opt("full");
303 : 0 : break;
304 : : case 'g':
305 : 0 : match = MATCH_GLOB;
306 : 0 : break;
307 : : case 'i':
308 : 0 : pkgdb_set_case_sensitivity(false);
309 : 0 : break;
310 : : case 'L':
311 : 0 : label = search_label_opt(optarg);
312 : 0 : break;
313 : : case 'o': /* Same as -L origin */
314 : 2 : label = search_label_opt("origin");
315 : 2 : break;
316 : : case 'p': /* Same as -Q prefix */
317 : 0 : opt |= modifier_opt("prefix");
318 : 0 : break;
319 : : case 'q':
320 : 2 : quiet = true;
321 : 2 : break;
322 : : case 'Q':
323 : 1 : opt |= modifier_opt(optarg);
324 : 1 : break;
325 : : case 'r':
326 [ # # # # : 0 : pkgvec_push(&reponames, optarg);
# # ]
327 : 0 : break;
328 : : case 'R':
329 : 0 : opt = INFO_RAW;
330 : 0 : break;
331 : : case 'S':
332 : 1 : search = search_label_opt(optarg);
333 : 1 : break;
334 : : case 's': /* Same as -Q size */
335 : 0 : opt |= modifier_opt("size");
336 : 0 : break;
337 : : case 'U':
338 : 0 : auto_update = false;
339 : 0 : break;
340 : : case 'x':
341 : 0 : match = MATCH_REGEX;
342 : 0 : break;
343 : : case 1:
344 [ # # ]: 0 : if (STRIEQ(optarg, "json"))
345 : 0 : opt |= INFO_RAW_JSON;
346 [ # # ]: 0 : else if (STRIEQ(optarg, "json-compact"))
347 : 0 : opt |= INFO_RAW_JSON_COMPACT;
348 [ # # ]: 0 : else if (STRIEQ(optarg, "yaml"))
349 : 0 : opt |= INFO_RAW_YAML;
350 [ # # ]: 0 : else if (STRIEQ(optarg, "ucl"))
351 : 0 : opt |= INFO_RAW_UCL;
352 : : else
353 : 0 : errx(EXIT_FAILURE, "Invalid format '%s' for the "
354 : : "raw output, expecting json, json-compact "
355 : 0 : "or yaml", optarg);
356 : 0 : break;
357 : : default:
358 : 0 : usage_search();
359 : 0 : return (EXIT_FAILURE);
360 : : }
361 : : }
362 : :
363 : 9 : argc -= optind;
364 : 9 : argv += optind;
365 : :
366 [ - + ]: 9 : if (argc != 1) {
367 : 0 : usage_search();
368 : 0 : return (EXIT_FAILURE);
369 : : }
370 : :
371 : 9 : pattern = argv[0];
372 [ + - ]: 9 : if (pattern[0] == '\0') {
373 : 0 : fprintf(stderr, "Pattern must not be empty.\n");
374 : 0 : return (EXIT_FAILURE);
375 : : }
376 [ + + ]: 9 : if (search == FIELD_NONE) {
377 [ - + ]: 8 : if (strchr(pattern, '/') != NULL) {
378 [ # # ]: 0 : if (strchr(pattern, '@') != NULL)
379 : 0 : search = FIELD_FLAVOR;
380 : : else
381 : 0 : search = FIELD_ORIGIN;
382 : 0 : } else
383 : 8 : search = FIELD_NAMEVER; /* Default search */
384 : 8 : }
385 [ + + ]: 9 : if (label == FIELD_NONE)
386 : 7 : label = search; /* By default, show what was searched */
387 : :
388 [ - + - - : 9 : switch(label) {
+ + - - ]
389 : : case FIELD_NONE:
390 : 0 : break; /* should never happen */
391 : : case FIELD_ORIGIN:
392 [ + + ]: 2 : if (quiet) {
393 : 1 : opt = INFO_TAG_ORIGIN;
394 : 1 : quiet = false;
395 : 1 : } else {
396 : 1 : opt |= INFO_TAG_ORIGIN|INFO_COMMENT;
397 : : }
398 : 3 : break;
399 : : case FIELD_FLAVOR:
400 : : case FIELD_NAME:
401 : 1 : opt |= INFO_TAG_NAME|INFO_COMMENT;
402 : 1 : break;
403 : : case FIELD_NAMEVER:
404 : 6 : opt |= INFO_TAG_NAMEVER|INFO_COMMENT;
405 : 6 : break;
406 : : case FIELD_COMMENT:
407 : 0 : opt |= INFO_TAG_NAMEVER|INFO_COMMENT;
408 : 0 : break;
409 : : case FIELD_DESC:
410 : 0 : opt |= INFO_TAG_NAMEVER|INFO_DESCR;
411 : 0 : break;
412 : : }
413 : :
414 [ + + ]: 9 : if (quiet) {
415 : 1 : opt = INFO_TAG_NAMEVER;
416 : 1 : quiet = false;
417 : 1 : }
418 : :
419 : 9 : ret = pkgdb_access2(PKGDB_MODE_READ, PKGDB_DB_REPO, &reponames);
420 [ - - + + ]: 9 : switch(ret) {
421 : : case EPKG_ENOACCESS:
422 : 0 : warnx("Insufficient privileges to query the package database");
423 : 0 : return (EXIT_FAILURE);
424 : : case EPKG_ENODB:
425 [ + - ]: 1 : if (!auto_update) {
426 : 0 : warnx("Unable to open remote repository catalogues. Try running '%s update' first.", getprogname());
427 : 0 : return (EXIT_FAILURE);
428 : : }
429 : 1 : break;
430 : : case EPKG_OK:
431 : 8 : break;
432 : : default:
433 : 0 : return (EXIT_FAILURE);
434 : : }
435 : :
436 : : /* first update the remote repositories if needed */
437 : 9 : old_quiet = quiet;
438 : 9 : quiet = true;
439 [ + - + + ]: 9 : if (auto_update && (ret = pkgcli_update(false, false, &reponames)) != EPKG_OK)
440 : 1 : return (ret);
441 : 8 : quiet = old_quiet;
442 : :
443 [ - + ]: 8 : if (pkgdb_open_all2(&db, PKGDB_REMOTE, &reponames) != EPKG_OK)
444 : 0 : return (EXIT_FAILURE);
445 : :
446 [ + - + - ]: 16 : if ((it = pkgdb_repo_search2(db, pattern, match, search, search,
447 : 8 : &reponames)) == NULL) {
448 : 0 : pkgdb_close(db);
449 : 0 : return (EXIT_FAILURE);
450 : : }
451 : :
452 [ + - ]: 8 : if (opt & INFO_RAW) {
453 [ # # ]: 0 : if ((opt & (INFO_RAW_JSON|INFO_RAW_JSON_COMPACT|INFO_RAW_UCL)) == 0)
454 : 0 : opt |= INFO_RAW_YAML;
455 : 0 : }
456 : :
457 : 8 : flags = info_flags(opt, true);
458 [ + + ]: 20 : while ((ret = pkgdb_it_next(it, &pkg, flags)) == EPKG_OK) {
459 : 12 : print_info(pkg, opt);
460 : 12 : atleastone = true;
461 : : }
462 : :
463 : 8 : pkg_free(pkg);
464 : 8 : pkgdb_it_free(it);
465 : 8 : pkgdb_close(db);
466 : :
467 [ + - ]: 8 : if (!atleastone)
468 : 0 : ret = EPKG_FATAL;
469 : :
470 [ + - + - ]: 8 : return ((ret == EPKG_OK || ret == EPKG_END) ? EXIT_SUCCESS : EXIT_FAILURE);
471 : 9 : }
|