+Real implementation of 'captive-cmdline' client
[captive.git] / src / client / cmdline / main.c
1 /* $Id$
2  * client cmdline interface for libcaptive
3  * Copyright (C) 2002-2003 Jan Kratochvil <project-captive@jankratochvil.net>
4  * 
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; exactly version 2 of June 1991 is required
8  * 
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  * 
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17  */
18
19
20 #include "config.h"
21
22 #include <glib/gmessages.h>
23 #include <stdlib.h>
24 #include <glib/giochannel.h>
25 #include <glib/gerror.h>
26 #include <popt.h>
27 #include <string.h>
28 #include <glib/gprintf.h>
29
30 #include <captive/client.h>     /* for captive_init() */
31
32 #include "main.h"       /* self */
33 #include "cmd_shell.h"
34 #include "cmd_cd.h"
35 #include "cmd_lcd.h"
36 #include "cmd_ls.h"
37 #include "cmd_get.h"
38 #include "cmd_put.h"
39 #include "cmd_rm.h"
40 #include "cmd_mv.h"
41 #include "cmd_mkdir.h"
42 #include "cmd_rmdir.h"
43 #include "cmd_quit.h"
44 #include "cmd_help.h"
45
46
47 GQuark cmdline_main_error_quark(void)
48 {
49 GQuark r=0;
50
51         if (!r)
52                 r=g_quark_from_static_string("cmdline-main");
53
54         return r;
55 }
56
57
58 static const struct poptOption popt_table[]={
59                 CAPTIVE_POPT_INCLUDE,
60                 POPT_AUTOHELP
61                 POPT_TABLEEND
62                 };
63
64 const struct cmdline_command cmdline_command_table[]={
65                 /* First entry is the default if no command name was specified. */
66                 { "shell",N_("Interactive commands shell.")                        ,cmd_shell_table,cmd_shell,0,0 },
67                 { "cd"   ,N_("Print or change current guest-os directory[1].")     ,cmd_cd_table   ,cmd_cd   ,0,1 },
68                 { "lcd"  ,N_("Print or change current host-os  directory[1].")     ,cmd_lcd_table  ,cmd_lcd  ,0,1 },
69                 { "ls"   ,N_("Directory[1] listing.")                              ,cmd_ls_table   ,cmd_ls   ,0,1 },
70                 { "get"  ,N_("Copy guest-os file[1] to host-os (opt. file[2]).")   ,cmd_get_table  ,cmd_get  ,1,2 },
71                 { "put"  ,N_("Copy host-os file[1] to guest-os (opt. file[2]).")   ,cmd_put_table  ,cmd_put  ,1,2 },
72                 { "rm"   ,N_("Remove guest-os file[1].")                           ,cmd_rm_table   ,cmd_rm   ,1,1 },
73                 { "mv"   ,N_("Move (rename) guest-os item[1] to guest-os item[2]."),cmd_mv_table   ,cmd_mv   ,2,2 },
74                 { "mkdir",N_("Create guest-os directory[1].")                      ,cmd_mkdir_table,cmd_mkdir,1,1 },
75                 { "rmdir",N_("Remove guest-os directory[1].")                      ,cmd_rmdir_table,cmd_rmdir,1,1 },
76                 { "quit" ,N_("Quit this program.")                                 ,cmd_quit_table ,cmd_quit ,0,0 },
77                 { "help" ,N_("Show this list of commands.")                        ,cmd_help_table ,cmd_help ,0,0 },
78                 { NULL },       /* G_N_ELEMENTS() not usable as sizeof() is not visible for 'extern' */
79                 };
80
81
82 static void invoke_cmd_err(int cmd_argc,const char **cmd_argv,GError **errp)
83 {
84 const struct cmdline_command *commandp;
85 const char *cmd_name=NULL;
86 poptContext cmd_context;
87 int errint;
88 const char **cmdarg_argv;
89 int cmdarg_argc;
90 const char **csp;
91 const char *emptyargv_NULL=NULL;
92
93         g_return_if_fail(cmd_argc>=0);
94         g_return_if_fail(!errp || !*errp);
95
96         /* poptGetContext() cannot be passed argc==0 even if we lass POPT_CONTEXT_KEEP_FIRST
97          * as it is buggy. Workaround it by keeping the command name as argv[0].
98          */
99         if (!cmd_argc) {
100 const char *stub_shell[]={ cmdline_command_table[0].name,NULL };
101                 
102                 cmd_argc=1;
103                 cmd_argv=stub_shell;
104                 }
105
106         cmd_name=*cmd_argv;
107         for (commandp=cmdline_command_table;commandp->name;commandp++) {
108                 if (!cmd_name   /* NULL cmd_name fallback to the first table entry - "shell" */
109                                 || !strcasecmp(cmd_name,commandp->name))
110                         break;
111                 }
112         if (!commandp->name) {
113                 g_set_error(errp,CMDLINE_MAIN_ERROR,CMDLINE_MAIN_ERROR_UNKNOWN_COMMAND,
114                                 _("Unknown command, try 'help': %s"),cmd_name);
115                 return;
116                 }
117         cmd_context=poptGetContext(
118                         PACKAGE,        /* name */
119                         cmd_argc,cmd_argv,      /* argc,argv */
120                         commandp->table,        /* options */
121                         POPT_CONTEXT_POSIXMEHARDER);    /* flags; !POPT_CONTEXT_KEEP_FIRST */
122         if (cmd_context==NULL) {
123                 g_set_error(errp,CMDLINE_MAIN_ERROR,CMDLINE_MAIN_ERROR_INVALID_COMMAND_ARGUMENTS,
124                                 _("Invalid arguments for command: %s"),cmd_name);
125                 return;
126                 }
127         errint=poptReadDefaultConfig(cmd_context,
128                         TRUE);  /* useEnv */
129         if (errint!=0) {
130                 g_set_error(errp,CMDLINE_MAIN_ERROR,CMDLINE_MAIN_ERROR_READING_COMMAND_CONFIG,
131                                 _("Error reading default configuration for command: %s"),cmd_name);
132                 return;
133                 }
134         errint=poptGetNextOpt(cmd_context);
135         if (errint!=-1) {
136                 g_set_error(errp,CMDLINE_MAIN_ERROR,CMDLINE_MAIN_ERROR_EXCEEDING_COMMAND_OPTION,
137                                 _("Exceeding command option for command: %s"),cmd_name);
138                 return;
139                 }
140         if (!(cmdarg_argv=poptGetArgs(cmd_context)))
141                 cmdarg_argv=&emptyargv_NULL;
142         
143         for (csp=cmdarg_argv,cmdarg_argc=0;*csp;csp++)
144                 cmdarg_argc++;
145         if (cmdarg_argc<commandp->argsn_min || cmdarg_argc>commandp->argsn_max) {
146                 g_set_error(errp,CMDLINE_MAIN_ERROR,CMDLINE_MAIN_ERROR_INVALID_COMMAND_ARGUMENT_COUNT,
147                                 _("Invalid number of command '%s' arguments: %d; expected from %d to %d incl."),
148                                 cmd_name,cmdarg_argc,commandp->argsn_min,commandp->argsn_max);
149                 return;
150                 }
151
152         (*commandp->func)(cmdarg_argv,errp);
153
154         poptFreeContext(cmd_context);
155 }
156
157
158 void err_cleanup(GError **errp)
159 {
160         g_return_if_fail(errp!=NULL);
161
162         if (!*errp)
163                 return;
164         g_printf("\nERROR: %s\n",(*errp)->message);
165         g_clear_error(errp);
166 }
167
168
169 void invoke_cmd(int cmd_argc,const char **cmd_argv)
170 {
171 GError *gerr=NULL;
172
173         invoke_cmd_err(cmd_argc,cmd_argv,&gerr);
174         err_cleanup(&gerr);
175 }
176
177
178 /* Returns: Success (no error occured). */
179 gboolean errvfsresult_to_gerr(GError **errp,GnomeVFSResult errvfsresult)
180 {
181         g_return_val_if_fail(!errp || !*errp,FALSE);
182
183         if (errvfsresult==GNOME_VFS_OK)
184                 return TRUE;
185
186         g_set_error(errp,CMDLINE_MAIN_ERROR,CMDLINE_MAIN_ERROR_GENERIC_ERROR,
187                         _("Generic error: %s"),gnome_vfs_result_to_string(errvfsresult));
188         return FALSE;
189 }
190
191 int main(int argc,char **argv)
192 {
193 poptContext context;
194 int errint;
195 const char **cmd_argv,**csp;
196 int cmd_argc;
197 GError *gerr=NULL;
198 const char *cmd_cd_root_args[]={"/",NULL};
199
200         context=poptGetContext(
201                         PACKAGE,        /* name */
202                         argc,(/*en-const*/const char **)argv,   /* argc,argv */
203                         popt_table,     /* options */
204                         POPT_CONTEXT_POSIXMEHARDER);    /* flags; && !POPT_CONTEXT_KEEP_FIRST */
205         if (context==NULL) {
206                 g_assert_not_reached(); /* argument recognization args_error */
207                 return EXIT_FAILURE;
208                 }
209         errint=poptReadDefaultConfig(context,
210                         TRUE);  /* useEnv */
211         if (errint!=0) {
212                 g_assert_not_reached(); /* argument recognization args_error */
213                 return EXIT_FAILURE;
214                 }
215         errint=poptGetNextOpt(context);
216         if (errint!=-1) {
217                 g_assert_not_reached(); /* some non-callbacked argument reached */
218                 return EXIT_FAILURE;
219                 }
220         cmd_argv=poptGetArgs(context);
221         for (csp=cmd_argv,cmd_argc=0;csp && *csp;csp++)
222                 cmd_argc++;
223
224         if (TRUE!=captive_init(NULL,    /* captive_args; already parsed above */
225                         (               /* image_iochannel */
226                                         !cmd_argc ? NULL : g_io_channel_new_file(       /* FIXME: g_io_channel_new_file() is NOT 64-bit compliant! */
227                                                         cmd_argv[cmd_argc-1],   /* filename */
228                                                         (captive_option_rwmode==CAPTIVE_OPTION_RWMODE_RW ? "r+" : "r"), /* mode */
229                                                         NULL))))        /* error */
230                 g_error(_("captive_init image_iochannel FAIL"));
231         cmd_argc--;     /* image file */
232
233         cmd_cd(cmd_cd_root_args,&gerr);
234         if (gerr) {
235                 err_cleanup(&gerr);
236                 return EXIT_FAILURE;
237                 }
238
239         invoke_cmd(cmd_argc,cmd_argv);
240
241         /* 'cmd_argv' gets cleared by 'poptFreeContext(context);' below */
242         poptFreeContext(context);
243
244         return EXIT_SUCCESS;
245 }