df02eef939f8b20ea9a5df72416abd12d94475f3
[oweals/opkg-lede.git] / libopkg / args.c
1 /* args.c - parse command-line args
2  
3   Carl D. Worth
4
5   Copyright 2001 University of Southern California
6  
7   This program is free software; you can redistribute it and/or modify
8   it under the terms of the GNU General Public License as published by
9   the Free Software Foundation; either version 2, or (at your option)
10   any later version.
11  
12   This program is distributed in the hope that it will be useful,
13   but WITHOUT ANY WARRANTY; without even the implied warranty of
14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15   GNU General Public License for more details.
16  */
17
18 #include <getopt.h>
19 #include <stdlib.h>
20 #include <string.h>
21 #include <unistd.h>
22
23 #include "includes.h"
24
25 #include "config.h"
26 #include "args.h"
27 #include "sprintf_alloc.h"
28
29 static void print_version(void);
30
31 enum long_args_opt
32 {
33      ARGS_OPT_FORCE_DEFAULTS = 129,
34      ARGS_OPT_FORCE_DEPENDS,
35      ARGS_OPT_FORCE_OVERWRITE,
36      ARGS_OPT_FORCE_DOWNGRADE,
37      ARGS_OPT_FORCE_REINSTALL,
38      ARGS_OPT_FORCE_REMOVAL_OF_DEPENDENT_PACKAGES,
39      ARGS_OPT_FORCE_REMOVAL_OF_ESSENTIAL_PACKAGES,
40      ARGS_OPT_FORCE_SPACE,
41      ARGS_OPT_NOACTION,
42      ARGS_OPT_NODEPS,
43      ARGS_OPT_VERBOSITY,
44      ARGS_OPT_MULTIPLE_PROVIDERS,
45      ARGS_OPT_AUTOREMOVE,
46      ARGS_OPT_CACHE,
47 };
48
49 int args_init(args_t *args)
50 {
51      char *conf_file_dir;
52
53      if (!args) {
54           return EFAULT;
55      }
56      memset(args, 0, sizeof(args_t));
57
58      args->dest = ARGS_DEFAULT_DEST;
59
60      conf_file_dir = getenv("OPKG_CONF_DIR");
61      if (conf_file_dir == NULL || conf_file_dir[0] == '\0') {
62           conf_file_dir = ARGS_DEFAULT_CONF_FILE_DIR;
63      }
64      sprintf_alloc(&args->conf_file, "%s/%s", conf_file_dir,
65                    ARGS_DEFAULT_CONF_FILE_NAME);
66
67      args->force_defaults = ARGS_DEFAULT_FORCE_DEFAULTS;
68      args->force_depends = ARGS_DEFAULT_FORCE_DEPENDS;
69      args->force_overwrite = ARGS_DEFAULT_FORCE_OVERWRITE;
70      args->force_downgrade = ARGS_DEFAULT_FORCE_DOWNGRADE;
71      args->force_reinstall = ARGS_DEFAULT_FORCE_REINSTALL;
72      args->force_removal_of_dependent_packages = ARGS_DEFAULT_FORCE_REMOVAL_OF_DEPENDENT_PACKAGES;
73      args->force_removal_of_essential_packages = ARGS_DEFAULT_FORCE_REMOVAL_OF_ESSENTIAL_PACKAGES;
74      args->autoremove = ARGS_DEFAULT_AUTOREMOVE;
75      args->noaction = ARGS_DEFAULT_NOACTION;
76      args->nodeps = ARGS_DEFAULT_NODEPS;
77      args->verbosity = ARGS_DEFAULT_VERBOSITY;
78      args->offline_root = ARGS_DEFAULT_OFFLINE_ROOT;
79      args->offline_root_pre_script_cmd = ARGS_DEFAULT_OFFLINE_ROOT_PRE_SCRIPT_CMD;
80      args->offline_root_post_script_cmd = ARGS_DEFAULT_OFFLINE_ROOT_POST_SCRIPT_CMD;
81      args->multiple_providers = 0;
82      args->nocheckfordirorfile = 0;
83      args->noreadfeedsfile = 0;
84
85      return 0;
86 }
87
88 void args_deinit(args_t *args)
89 {
90      free (args->offline_root);
91      free (args->offline_root_pre_script_cmd);
92      free (args->offline_root_post_script_cmd);
93
94      free (args->dest);
95      free (args->tmp_dir);
96      free (args->cache);
97      free(args->conf_file);
98      args->conf_file = NULL;
99 }
100
101 int args_parse(args_t *args, int argc, char *argv[])
102 {
103      int c;
104      int option_index = 0;
105      int parse_err = 0;
106      static struct option long_options[] = {
107           {"query-all", 0, 0, 'A'},
108           {"autoremove", 0, 0, ARGS_OPT_AUTOREMOVE},
109           {"cache", 1, 0, ARGS_OPT_CACHE},
110           {"conf-file", 1, 0, 'f'},
111           {"conf", 1, 0, 'f'},
112           {"dest", 1, 0, 'd'},
113           {"force-defaults", 0, 0, ARGS_OPT_FORCE_DEFAULTS},
114           {"force_defaults", 0, 0, ARGS_OPT_FORCE_DEFAULTS},
115           {"force-depends", 0, 0, ARGS_OPT_FORCE_DEPENDS},
116           {"force_depends", 0, 0, ARGS_OPT_FORCE_DEPENDS},
117           {"force-overwrite", 0, 0, ARGS_OPT_FORCE_OVERWRITE},
118           {"force_overwrite", 0, 0, ARGS_OPT_FORCE_OVERWRITE},
119           {"force_downgrade", 0, 0, ARGS_OPT_FORCE_DOWNGRADE},
120           {"force-downgrade", 0, 0, ARGS_OPT_FORCE_DOWNGRADE},
121           {"force-reinstall", 0, 0, ARGS_OPT_FORCE_REINSTALL},
122           {"force_reinstall", 0, 0, ARGS_OPT_FORCE_REINSTALL},
123           {"force-space", 0, 0, ARGS_OPT_FORCE_SPACE},
124           {"force_space", 0, 0, ARGS_OPT_FORCE_SPACE},
125           {"recursive", 0, 0,
126            ARGS_OPT_FORCE_REMOVAL_OF_DEPENDENT_PACKAGES},
127           {"force-removal-of-dependent-packages", 0, 0,
128            ARGS_OPT_FORCE_REMOVAL_OF_DEPENDENT_PACKAGES},
129           {"force_removal_of_dependent_packages", 0, 0,
130            ARGS_OPT_FORCE_REMOVAL_OF_DEPENDENT_PACKAGES},
131           {"force-removal-of-essential-packages", 0, 0,
132            ARGS_OPT_FORCE_REMOVAL_OF_ESSENTIAL_PACKAGES},
133           {"force_removal_of_essential_packages", 0, 0,
134            ARGS_OPT_FORCE_REMOVAL_OF_ESSENTIAL_PACKAGES},
135           {"multiple-providers", 0, 0, ARGS_OPT_MULTIPLE_PROVIDERS},
136           {"multiple_providers", 0, 0, ARGS_OPT_MULTIPLE_PROVIDERS},
137           {"noaction", 0, 0, ARGS_OPT_NOACTION},
138           {"nodeps", 0, 0, ARGS_OPT_NODEPS},
139           {"offline", 1, 0, 'o'},
140           {"offline-root", 1, 0, 'o'},
141           {"test", 0, 0, ARGS_OPT_NOACTION},
142           {"tmp-dir", 1, 0, 't'},
143           {"verbosity", 2, 0, 'V'},
144           {"version", 0, 0, 'v'},
145           {0, 0, 0, 0}
146      };
147
148      while (1) {
149           c = getopt_long_only(argc, argv, "Ad:f:no:t:vV:", long_options, &option_index);
150           if (c == -1)
151                break;
152
153           switch (c) {
154           case 'A':
155                args->query_all = 1;
156                break;
157           case 'd':
158                args->dest = strdup (optarg);
159                break;
160           case 'f':
161                free(args->conf_file);
162                args->conf_file = strdup(optarg);
163                break;
164           case 'o':
165                args->offline_root = strdup (optarg);
166                break;
167           case 'n':
168                args->noaction = 1;
169                break;
170           case 't':
171                args->tmp_dir = strdup(optarg);
172                break;
173           case 'v':
174                print_version();
175                exit(0);
176           case 'V':
177           case ARGS_OPT_VERBOSITY:
178                if (optarg)
179                     args->verbosity = atoi(optarg);
180                else
181                     args->verbosity += 1;
182                break;
183           case ARGS_OPT_AUTOREMOVE:
184                args->autoremove = 1;
185                break;
186           case ARGS_OPT_CACHE:
187                free(args->cache);
188                args->cache = strdup(optarg);
189                break;
190           case ARGS_OPT_FORCE_DEFAULTS:
191                args->force_defaults = 1;
192                break;
193           case ARGS_OPT_FORCE_DEPENDS:
194                args->force_depends = 1;
195                break;
196           case ARGS_OPT_FORCE_OVERWRITE:
197                args->force_overwrite = 1;
198                break;
199           case ARGS_OPT_FORCE_DOWNGRADE:
200                args->force_downgrade = 1;
201                break;
202           case ARGS_OPT_FORCE_REINSTALL:
203                args->force_reinstall = 1;
204                break;
205           case ARGS_OPT_FORCE_REMOVAL_OF_ESSENTIAL_PACKAGES:
206                args->force_removal_of_essential_packages = 1;
207                break;
208           case ARGS_OPT_FORCE_REMOVAL_OF_DEPENDENT_PACKAGES:
209                args->force_removal_of_dependent_packages = 1;
210                break;
211           case ARGS_OPT_FORCE_SPACE:
212                args->force_space = 1;
213                break;
214           case ARGS_OPT_MULTIPLE_PROVIDERS:
215                args->multiple_providers = 1;
216                break;
217           case ARGS_OPT_NODEPS:
218                args->nodeps = 1;
219                break;
220           case ARGS_OPT_NOACTION:
221                args->noaction = 1;
222                break;
223           case ':':
224                parse_err++;
225                break;
226           case '?':
227                parse_err++;
228                break;
229           default:
230                printf("Confusion: getopt_long returned %d\n", c);
231           }
232      }
233     
234      if (parse_err) {
235           return -parse_err;
236      } else {
237           return optind;
238      }
239 }
240
241 void args_usage(char *complaint)
242 {
243      if (complaint) {
244           printf("opkg: %s\n", complaint);
245      }
246      print_version();
247      printf("usage: opkg [options...] sub-command [arguments...]\n");
248      printf("where sub-command is one of:\n");
249     
250      printf("\nPackage Manipulation:\n");
251      printf("\tupdate           Update list of available packages\n");
252      printf("\tupgrade                  Upgrade all installed packages to latest version\n");
253      printf("\tinstall <pkg>            Download and install <pkg> (and dependencies)\n");
254      printf("\tinstall <file.opk>       Install package <file.opk>\n");
255      printf("\tconfigure [<pkg>]        Configure unpacked packages\n");
256      printf("\tremove <pkg|regexp>      Remove package <pkg|packages following regexp>\n");
257      printf("\tflag <flag> <pkg> ...    Flag package(s) <pkg>\n");
258      printf("\t <flag>=hold|noprune|user|ok|installed|unpacked (one per invocation)     \n");
259     
260      printf("\nInformational Commands:\n");
261      printf("\tlist             List available packages and descriptions\n");
262      printf("\tlist_installed           List all and only the installed packages and description \n");
263      printf("\tfiles <pkg>              List all files belonging to <pkg>\n");
264      printf("\tsearch <file|regexp>             Search for a package providing <file>\n");
265      printf("\tinfo [pkg|regexp]                Display all info for <pkg>\n");
266      printf("\tstatus [pkg|regexp]              Display all status for <pkg>\n");
267      printf("\tdownload <pkg>           Download <pkg> to current directory.\n");
268      printf("\tcompare_versions <v1> <op> <v2>\n");
269      printf("\t                          compare versions using <= < > >= = << >>\n");
270      printf("\tprint_architecture      prints the architecture.\n");
271      printf("\tprint_installation_architecture\n");
272      printf("\twhatdepends [-A] [pkgname|pat]+\n");
273      printf("\twhatdependsrec [-A] [pkgname|pat]+\n");
274      printf("\twhatprovides [-A] [pkgname|pat]+\n");
275      printf("\twhatconflicts [-A] [pkgname|pat]+\n");
276      printf("\twhatreplaces [-A] [pkgname|pat]+\n");
277      printf("\t                        prints the installation architecture.\n");    
278      printf("\nOptions:\n");
279      printf("\t-A                      Query all packages with whatdepends, whatprovides, whatreplaces, whatconflicts\n"); 
280      printf("\t-V <level>               Set verbosity level to <level>. If no value is\n");
281      printf("\t--verbosity <level>      provided increase verbosity by one. Verbosity levels:\n");
282      printf("\t                         0 errors only\n");
283      printf("\t                         1 normal messages (default)\n");
284      printf("\t                         2 informative messages\n");
285      printf("\t                         3 debug output\n");
286      printf("\t-f <conf_file>           Use <conf_file> as the opkg configuration file\n");
287      printf("\t--cache <directory>      Use a package cache\n");
288      printf("\t-conf <conf_file>        Default configuration file location\n");
289      printf("                           is %s/%s\n", ARGS_DEFAULT_CONF_FILE_DIR, ARGS_DEFAULT_CONF_FILE_NAME);
290      printf("\t-d <dest_name>           Use <dest_name> as the the root directory for\n");
291      printf("\t-dest <dest_name>        package installation, removal, upgrading.\n");
292      printf("                           <dest_name> should be a defined dest name from\n");
293      printf("                           the configuration file, (but can also be a\n");
294      printf("                           directory name in a pinch).\n");
295      printf("\t-o <offline_root>        Use <offline_root> as the root directory for\n");
296      printf("\t-offline <offline_root>  offline installation of packages.\n");
297     
298      printf("\tForce Options (use when opkg is too smart for its own good):\n");
299      printf("\t-force-depends           Make dependency checks warnings instead of errors\n");
300      printf("\t                         Install/remove package in spite of failed dependences\n");
301      printf("\t-force-defaults          Use default options for questions asked by opkg.\n");
302      printf("                           (no prompts). Note that this will not prevent\n");
303      printf("                           package installation scripts from prompting.\n");
304      printf("\t-force-reinstall         Allow opkg to reinstall a package.\n");
305      printf("\t-force-overwrite         Allow opkg to overwrite files from another package during an install.\n");
306      printf("\t-force-downgrade         Allow opkg to downgrade packages.\n");
307      printf("\t-force_space            Install even if there does not seem to be enough space.\n");
308      printf("\t-noaction               No action -- test only\n");
309      printf("\t-nodeps                 Do not follow dependences\n");
310      printf("\t-force-removal-of-dependent-packages\n");
311      printf("\t-recursive               Allow opkg to remove package and all that depend on it.\n");
312      printf("\t-autoremove              Allow opkg to remove packages that where installed automatically to satisfy dependencies.\n");
313      printf("\t-test                   No action -- test only\n");
314      printf("\t-t                       Specify tmp-dir.\n");
315      printf("\t--tmp-dir                Specify tmp-dir.\n");
316      printf("\n");
317      printf("\tregexp could be something like 'pkgname*' '*file*' or similar\n");
318      printf("\teg: opkg info 'libstd*'  or opkg search '*libop*' or opkg remove 'libncur*'\n");
319      /* -force-removal-of-essential-packages    Let opkg remove essential packages. 
320         Using this option is almost guaranteed to break your system, hence this option
321         is not even advertised in the usage statement. */
322      exit(1);
323 }
324
325 static void print_version(void)
326 {
327      printf("opkg version %s\n", VERSION);
328 }