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 <stdio.h>
  29 #include <locale.h>
  30
  31 #include <captive/client-vfs.h>
  32
  33 #include "main.h"       /* self */
  34 #include "cmd_shell.h"
  35 #include "cmd_cd.h"
  36 #include "cmd_lcd.h"
  37 #include "cmd_ls.h"
  38 #include "cmd_get.h"
  39 #include "cmd_put.h"
  40 #include "cmd_info.h"
  41 #include "cmd_volume.h"
  42 #include "cmd_rm.h"
  43 #include "cmd_mv.h"
  44 #include "cmd_mkdir.h"
  45 #include "cmd_rmdir.h"
  46 #include "cmd_commit.h"
  47 #include "cmd_quit.h"
  48 #include "cmd_help.h"
  49
  50
  51 CaptiveVfsObject *cmdline_captive_vfs_object;
  52
  53
  54 GQuark cmdline_main_error_quark(void)
  55 {
  56 GQuark r=0;
  57
  58         if (!r)
  59                 r=g_quark_from_static_string("cmdline-main");
  60
  61         return r;
  62 }
  63
  64
  65 static const struct poptOption popt_table[]={
  66                 CAPTIVE_POPT_INCLUDE,
  67                 POPT_AUTOHELP
  68                 POPT_TABLEEND
  69                 };
  70
  71 const struct cmdline_command cmdline_command_table[]={
  72                 /* First entry is the default if no command name was specified. */
  73                 { "shell" ,N_("Interactive commands shell.")                        ,cmd_shell_table ,cmd_shell ,0,0 },
  74                 { "cd"    ,N_("Print or change current guest-os directory[1].")     ,cmd_cd_table    ,cmd_cd    ,0,1 },
  75                 { "lcd"   ,N_("Print or change current host-os  directory[1].")     ,cmd_lcd_table   ,cmd_lcd   ,0,1 },
  76                 { "ls"    ,N_("Directory[1] listing.")                              ,cmd_ls_table    ,cmd_ls    ,0,1 },
  77                 { "get"   ,N_("Copy guest-os file[1] to host-os (opt. file[2]).")   ,cmd_get_table   ,cmd_get   ,1,2 },
  78                 { "put"   ,N_("Copy host-os file[1] to guest-os (opt. file[2]).")   ,cmd_put_table   ,cmd_put   ,1,2 },
  79                 { "info"  ,N_("Query information about guest-os item[1].")          ,cmd_info_table  ,cmd_info  ,1,1 },
  80                 { "volume",N_("Query information about guest-os volume.")           ,cmd_volume_table,cmd_volume,0,0 },
  81                 { "rm"    ,N_("Remove guest-os file[1].")                           ,cmd_rm_table    ,cmd_rm    ,1,1 },
  82                 { "mv"    ,N_("Move (rename) guest-os item[1] to guest-os item[2]."),cmd_mv_table    ,cmd_mv    ,2,2 },
  83                 { "mkdir" ,N_("Create guest-os directory[1].")                      ,cmd_mkdir_table ,cmd_mkdir ,1,1 },
  84                 { "rmdir" ,N_("Remove guest-os directory[1].")                      ,cmd_rmdir_table ,cmd_rmdir ,1,1 },
  85                 { "commit",N_("Write any pending changes and remount the volume.")  ,cmd_commit_table,cmd_commit,0,0 },
  86                 { "quit"  ,N_("Quit this program.")                                 ,cmd_quit_table  ,cmd_quit  ,0,0 },
  87                 { "help"  ,N_("Show this list of commands.")                        ,cmd_help_table  ,cmd_help  ,0,0 },
  88                 { NULL },       /* G_N_ELEMENTS() not usable as sizeof() is not visible for 'extern' */
  89                 };
  90
  91
  92 static void invoke_cmd_err(int cmd_argc,const char **cmd_argv,GError **errp)
  93 {
  94 const struct cmdline_command *commandp;
  95 const char *cmd_name=NULL;
  96 poptContext cmd_context;
  97 int errint;
  98 const char **cmdarg_argv;
  99 int cmdarg_argc;
 100 const char **csp;
 101 const char *emptyargv_NULL=NULL;
 102
 103         g_return_if_fail(cmd_argc>=0);
 104         g_return_if_fail(!errp || !*errp);
 105
 106         /* poptGetContext() cannot be passed argc==0 even if we lass POPT_CONTEXT_KEEP_FIRST
 107          * as it is buggy. Workaround it by keeping the command name as argv[0].
 108          */
 109         if (!cmd_argc) {
 110 const char *stub_shell[]={ cmdline_command_table[0].name,NULL };
 111
 112                 cmd_argc=1;
 113                 cmd_argv=stub_shell;
 114                 }
 115
 116         cmd_name=*cmd_argv;
 117         for (commandp=cmdline_command_table;commandp->name;commandp++) {
 118                 if (!cmd_name   /* NULL cmd_name fallback to the first table entry - "shell" */
 119                                 || !strcasecmp(cmd_name,commandp->name))
 120                         break;
 121                 }
 122         if (!commandp->name) {
 123                 g_set_error(errp,CMDLINE_MAIN_ERROR,CMDLINE_MAIN_ERROR_UNKNOWN_COMMAND,
 124                                 _("Unknown command, try 'help': %s"),cmd_name);
 125                 return;
 126                 }
 127         cmd_context=poptGetContext(
 128                         PACKAGE,        /* name */
 129                         cmd_argc,cmd_argv,      /* argc,argv */
 130                         commandp->table,        /* options */
 131                         POPT_CONTEXT_POSIXMEHARDER);    /* flags; !POPT_CONTEXT_KEEP_FIRST */
 132         if (cmd_context==NULL) {
 133                 g_set_error(errp,CMDLINE_MAIN_ERROR,CMDLINE_MAIN_ERROR_INVALID_COMMAND_ARGUMENTS,
 134                                 _("Invalid arguments for command: %s"),cmd_name);
 135                 return;
 136                 }
 137         errint=poptReadDefaultConfig(cmd_context,
 138                         TRUE);  /* useEnv */
 139         if (errint!=0) {
 140                 g_set_error(errp,CMDLINE_MAIN_ERROR,CMDLINE_MAIN_ERROR_READING_COMMAND_CONFIG,
 141                                 _("Error '%s' reading default configuration for command: %s"),poptStrerror(errint),cmd_name);
 142                 return;
 143                 }
 144         errint=poptGetNextOpt(cmd_context);
 145         if (errint!=-1) {
 146                 g_set_error(errp,CMDLINE_MAIN_ERROR,CMDLINE_MAIN_ERROR_EXCEEDING_COMMAND_OPTION,
 147                                 _("Exceeding command option for command: %s"),cmd_name);
 148                 return;
 149                 }
 150         if (!(cmdarg_argv=poptGetArgs(cmd_context)))
 151                 cmdarg_argv=&emptyargv_NULL;
 152
 153         for (csp=cmdarg_argv,cmdarg_argc=0;*csp;csp++)
 154                 cmdarg_argc++;
 155         if (cmdarg_argc<commandp->argsn_min || cmdarg_argc>commandp->argsn_max) {
 156                 g_set_error(errp,CMDLINE_MAIN_ERROR,CMDLINE_MAIN_ERROR_INVALID_COMMAND_ARGUMENT_COUNT,
 157                                 _("Invalid number of command '%s' arguments: %d; expected from %d to %d incl."),
 158                                 cmd_name,cmdarg_argc,commandp->argsn_min,commandp->argsn_max);
 159                 return;
 160                 }
 161
 162         (*commandp->func)(cmdarg_argv,errp);
 163
 164         poptFreeContext(cmd_context);
 165 }
 166
 167
 168 void err_cleanup(GError **errp)
 169 {
 170         g_return_if_fail(errp!=NULL);
 171
 172         if (!*errp)
 173                 return;
 174         printf("\nERROR: %s\n",(*errp)->message);
 175         g_clear_error(errp);
 176 }
 177
 178
 179 void invoke_cmd(int cmd_argc,const char **cmd_argv)
 180 {
 181 GError *gerr=NULL;
 182
 183         invoke_cmd_err(cmd_argc,cmd_argv,&gerr);
 184         err_cleanup(&gerr);
 185 }
 186
 187
 188 /* Returns: Success (no error occured). */
 189 gboolean errvfsresult_to_gerr(GError **errp,GnomeVFSResult errvfsresult)
 190 {
 191         g_return_val_if_fail(!errp || !*errp,FALSE);
 192
 193         if (errvfsresult==GNOME_VFS_OK)
 194                 return TRUE;
 195
 196         g_set_error(errp,CMDLINE_MAIN_ERROR,CMDLINE_MAIN_ERROR_GENERIC_ERROR,
 197                         _("Generic error: %s"),gnome_vfs_result_to_string(errvfsresult));
 198         return FALSE;
 199 }
 200
 201 static GIOChannel *main_giochannel;
 202
 203 void main_exit(void) G_GNUC_NORETURN;
 204 void main_exit(void)
 205 {
 206         if (cmdline_captive_vfs_object) {
 207                 g_object_unref(cmdline_captive_vfs_object);
 208                 cmdline_captive_vfs_object=NULL;
 209                 }
 210         if (main_giochannel) {
 211                 g_io_channel_unref(main_giochannel);
 212                 main_giochannel=NULL;
 213                 }
 214         exit(EXIT_SUCCESS);
 215 }
 216
 217 int main(int argc,char **argv)
 218 {
 219 poptContext context;
 220 int errint;
 221 const char **cmd_argv,**csp;
 222 int cmd_argc;
 223 GError *gerr=NULL;
 224 const char *cmd_cd_root_args[]={"/",NULL};
 225 struct captive_options options;
 226
 227         /* Do not set g_log_set_always_fatal() here as we would not be able
 228          * to restart failed children due to communication-failure alarms.
 229          */
 230
 231         /* Prevent output block buffering if redirecting stdout to file. */
 232         setvbuf(stdout,(char *)NULL,_IONBF,0);
 233         setvbuf(stderr,(char *)NULL,_IONBF,0);
 234
 235         /* Initialize the i18n stuff */
 236         setlocale(LC_ALL,"");
 237         bindtextdomain(PACKAGE,LOCALEDIR);
 238         textdomain(PACKAGE);
 239
 240         /* Initialize GObject subsystem of GLib. */
 241         g_type_init();
 242
 243         captive_options_init(&options);
 244         captive_options=&options;       /* for parsing by 'CAPTIVE_POPT_INCLUDE' */
 245
 246         context=poptGetContext(
 247                         PACKAGE,        /* name */
 248                         argc,(/*en-const*/const char **)argv,   /* argc,argv */
 249                         popt_table,     /* options */
 250                         POPT_CONTEXT_POSIXMEHARDER);    /* flags; && !POPT_CONTEXT_KEEP_FIRST */
 251         if (context==NULL) {
 252                 g_assert_not_reached(); /* argument recognization args_error */
 253                 return EXIT_FAILURE;
 254                 }
 255         errint=poptReadDefaultConfig(context,
 256                         TRUE);  /* useEnv */
 257         if (errint!=0) {
 258                 g_assert_not_reached(); /* argument recognization args_error */
 259                 return EXIT_FAILURE;
 260                 }
 261         errint=poptGetNextOpt(context);
 262         if (errint!=-1) {
 263                 g_assert_not_reached(); /* some non-callbacked argument reached */
 264                 return EXIT_FAILURE;
 265                 }
 266         cmd_argv=poptGetArgs(context);
 267         for (csp=cmd_argv,cmd_argc=0;csp && *csp;csp++)
 268                 cmd_argc++;
 269
 270         captive_options=NULL;   /* already parsed by 'CAPTIVE_POPT_INCLUDE' */
 271
 272         /* image_iochannel */
 273         if (cmd_argc) {
 274                 g_assert(options.image_iochannel==NULL);
 275                 if (!(options.image_iochannel=g_io_channel_new_file(
 276                                 cmd_argv[0],    /* filename */
 277                                 (options.rwmode==CAPTIVE_OPTION_RWMODE_RW ? "r+" : "r"),        /* mode */
 278                                 NULL))) {       /* error */
 279                         g_error(_("image_iochannel open failed"));
 280                         return EXIT_FAILURE;
 281                         }
 282                 }
 283         if (cmd_argc>0) {
 284                 /* image file */
 285                 cmd_argc--;
 286                 cmd_argv++;
 287                 }
 288
 289         if (GNOME_VFS_OK!=captive_vfs_new(&cmdline_captive_vfs_object,&options)) {
 290                 g_error(_("captive_vfs_new() failed"));
 291                 return EXIT_FAILURE;
 292                 }
 293         captive_options_free(&options);
 294
 295         cmd_cd(cmd_cd_root_args,&gerr);
 296         if (gerr) {
 297                 err_cleanup(&gerr);
 298                 return EXIT_FAILURE;
 299                 }
 300
 301         invoke_cmd(cmd_argc,cmd_argv);
 302
 303         /* 'cmd_argv' gets cleared by 'poptFreeContext(context);' below */
 304         poptFreeContext(context);
 305
 306         main_exit();    /* unref 'cmdline_captive_vfs_object' */
 307         /* NOTREACHED */
 308 }