/* Virtual File System: FISH implementation for transfering files over shell connections. Copyright (C) 1998-2022 Free Software Foundation, Inc. Written by: Pavel Machek, 1998 Michal Svec, 2000 Andrew Borodin , 2010-2022 Slava Zanko , 2010, 2013 Ilia Maslakov , 2010 Derived from ftpfs.c. This file is part of the Midnight Commander. The Midnight Commander is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. The Midnight Commander 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, see . */ /** * \file * \brief Source: Virtual File System: FISH implementation for transfering files over * shell connections * \author Pavel Machek * \author Michal Svec * \date 1998, 2000 * * Derived from ftpfs.c * Read README.fish for protocol specification. * * Syntax of path is: \verbatim sh://user@host[:Cr]/path \endverbatim * where C means you want compressed connection, * and r means you want to use rsh * * Namespace: fish_vfs_ops exported. */ /* Define this if your ssh can take -I option */ #include #include #include #include #include #include #include /* uintmax_t */ #include "lib/global.h" #include "lib/tty/tty.h" /* enable/disable interrupt key */ #include "lib/strescape.h" #include "lib/unixcompat.h" #include "lib/fileloc.h" #include "lib/util.h" /* my_exit() */ #include "lib/mcconfig.h" #include "src/execute.h" /* pre_exec, post_exec */ #include "lib/vfs/vfs.h" #include "lib/vfs/utilvfs.h" #include "lib/vfs/netutil.h" #include "lib/vfs/xdirentry.h" #include "lib/vfs/gc.h" /* vfs_stamp_create */ #include "fish.h" #include "fishdef.h" /*** global variables ****************************************************************************/ int fish_directory_timeout = 900; /*** file scope macro definitions ****************************************************************/ #define DO_RESOLVE_SYMLINK 1 #define DO_OPEN 2 #define DO_FREE_RESOURCE 4 #define FISH_FLAG_COMPRESSED 1 #define FISH_FLAG_RSH 2 #define OPT_FLUSH 1 #define OPT_IGNORE_ERROR 2 /* * Reply codes. */ #define PRELIM 1 /* positive preliminary */ #define COMPLETE 2 /* positive completion */ #define CONTINUE 3 /* positive intermediate */ #define TRANSIENT 4 /* transient negative completion */ #define ERROR 5 /* permanent negative completion */ /* command wait_flag: */ #define NONE 0x00 #define WAIT_REPLY 0x01 #define WANT_STRING 0x02 /* environment flags */ #define FISH_HAVE_HEAD 1 #define FISH_HAVE_SED 2 #define FISH_HAVE_AWK 4 #define FISH_HAVE_PERL 8 #define FISH_HAVE_LSQ 16 #define FISH_HAVE_DATE_MDYT 32 #define FISH_HAVE_TAIL 64 #define FISH_SUPER(super) ((fish_super_t *) (super)) #define FISH_FILE_HANDLER(fh) ((fish_file_handler_t *) fh) /*** file scope type declarations ****************************************************************/ typedef struct { struct vfs_s_super base; /* base class */ int sockr; int sockw; char *scr_ls; char *scr_chmod; char *scr_utime; char *scr_exists; char *scr_mkdir; char *scr_unlink; char *scr_chown; char *scr_rmdir; char *scr_ln; char *scr_mv; char *scr_hardlink; char *scr_get; char *scr_send; char *scr_append; char *scr_info; int host_flags; char *scr_env; } fish_super_t; typedef struct { vfs_file_handler_t base; /* base class */ off_t got; off_t total; gboolean append; } fish_file_handler_t; /*** file scope variables ************************************************************************/ static char reply_str[80]; static struct vfs_s_subclass fish_subclass; static struct vfs_class *vfs_fish_ops = VFS_CLASS (&fish_subclass); /* --------------------------------------------------------------------------------------------- */ /*** file scope functions ************************************************************************/ /* --------------------------------------------------------------------------------------------- */ static void fish_set_blksize (struct stat *s) { #ifdef HAVE_STRUCT_STAT_ST_BLKSIZE /* redefine block size */ s->st_blksize = 64 * 1024; /* FIXME */ #endif } /* --------------------------------------------------------------------------------------------- */ static struct stat * fish_default_stat (struct vfs_class *me) { struct stat *s; s = vfs_s_default_stat (me, S_IFDIR | 0755); fish_set_blksize (s); vfs_adjust_stat (s); return s; } /* --------------------------------------------------------------------------------------------- */ static char * fish_load_script_from_file (const char *hostname, const char *script_name, const char *def_content) { char *scr_filename = NULL; char *scr_content; gsize scr_len = 0; /* 1st: scan user directory */ scr_filename = g_build_path (PATH_SEP_STR, mc_config_get_data_path (), FISH_PREFIX, hostname, script_name, (char *) NULL); /* silent about user dir */ g_file_get_contents (scr_filename, &scr_content, &scr_len, NULL); g_free (scr_filename); /* 2nd: scan system dir */ if (scr_content == NULL) { scr_filename = g_build_path (PATH_SEP_STR, LIBEXECDIR, FISH_PREFIX, script_name, (char *) NULL); g_file_get_contents (scr_filename, &scr_content, &scr_len, NULL); g_free (scr_filename); } if (scr_content != NULL) return scr_content; return g_strdup (def_content); } /* --------------------------------------------------------------------------------------------- */ static int fish_decode_reply (char *s, gboolean was_garbage) { int code; /* cppcheck-suppress invalidscanf */ if (sscanf (s, "%d", &code) == 0) { code = 500; return 5; } if (code < 100) return was_garbage ? ERROR : (code == 0 ? COMPLETE : PRELIM); return code / 100; } /* --------------------------------------------------------------------------------------------- */ /* Returns a reply code, check /usr/include/arpa/ftp.h for possible values */ static int fish_get_reply (struct vfs_class *me, int sock, char *string_buf, int string_len) { char answer[BUF_1K]; gboolean was_garbage = FALSE; while (TRUE) { if (!vfs_s_get_line (me, sock, answer, sizeof (answer), '\n')) { if (string_buf != NULL) *string_buf = '\0'; return 4; } if (strncmp (answer, "### ", 4) == 0) return fish_decode_reply (answer + 4, was_garbage ? 1 : 0); was_garbage = TRUE; if (string_buf != NULL) g_strlcpy (string_buf, answer, string_len); } } /* --------------------------------------------------------------------------------------------- */ static int fish_command (struct vfs_class *me, struct vfs_s_super *super, int wait_reply, const char *cmd, size_t cmd_len) { ssize_t status; FILE *logfile = me->logfile; if (cmd_len == (size_t) (-1)) cmd_len = strlen (cmd); if (logfile != NULL) { size_t ret; ret = fwrite (cmd, cmd_len, 1, logfile); ret = fflush (logfile); (void) ret; } tty_enable_interrupt_key (); status = write (FISH_SUPER (super)->sockw, cmd, cmd_len); tty_disable_interrupt_key (); if (status < 0) return TRANSIENT; if (wait_reply) return fish_get_reply (me, FISH_SUPER (super)->sockr, (wait_reply & WANT_STRING) != 0 ? reply_str : NULL, sizeof (reply_str) - 1); return COMPLETE; } /* --------------------------------------------------------------------------------------------- */ static int G_GNUC_PRINTF (5, 0) fish_command_va (struct vfs_class *me, struct vfs_s_super *super, int wait_reply, const char *scr, const char *vars, va_list ap) { int r; GString *command; command = g_string_new (FISH_SUPER (super)->scr_env); g_string_append_vprintf (command, vars, ap); g_string_append (command, scr); r = fish_command (me, super, wait_reply, command->str, command->len); g_string_free (command, TRUE); return r; } /* --------------------------------------------------------------------------------------------- */ static int G_GNUC_PRINTF (5, 6) fish_command_v (struct vfs_class *me, struct vfs_s_super *super, int wait_reply, const char *scr, const char *vars, ...) { int r; va_list ap; va_start (ap, vars); r = fish_command_va (me, super, wait_reply, scr, vars, ap); va_end (ap); return r; } /* --------------------------------------------------------------------------------------------- */ static int G_GNUC_PRINTF (5, 6) fish_send_command (struct vfs_class *me, struct vfs_s_super *super, int flags, const char *scr, const char *vars, ...) { int r; va_list ap; va_start (ap, vars); r = fish_command_va (me, super, WAIT_REPLY, scr, vars, ap); va_end (ap); vfs_stamp_create (vfs_fish_ops, super); if (r != COMPLETE) ERRNOR (E_REMOTE, -1); if ((flags & OPT_FLUSH) != 0) vfs_s_invalidate (me, super); return 0; } /* --------------------------------------------------------------------------------------------- */ static struct vfs_s_super * fish_new_archive (struct vfs_class *me) { fish_super_t *arch; arch = g_new0 (fish_super_t, 1); arch->base.me = me; return VFS_SUPER (arch); } /* --------------------------------------------------------------------------------------------- */ static void fish_free_archive (struct vfs_class *me, struct vfs_s_super *super) { fish_super_t *fish_super = FISH_SUPER (super); if ((fish_super->sockw != -1) || (fish_super->sockr != -1)) vfs_print_message (_("fish: Disconnecting from %s"), super->name ? super->name : "???"); if (fish_super->sockw != -1) { fish_command (me, super, NONE, "#BYE\nexit\n", -1); close (fish_super->sockw); fish_super->sockw = -1; } if (fish_super->sockr != -1) { close (fish_super->sockr); fish_super->sockr = -1; } g_free (fish_super->scr_ls); g_free (fish_super->scr_exists); g_free (fish_super->scr_mkdir); g_free (fish_super->scr_unlink); g_free (fish_super->scr_chown); g_free (fish_super->scr_chmod); g_free (fish_super->scr_utime); g_free (fish_super->scr_rmdir); g_free (fish_super->scr_ln); g_free (fish_super->scr_mv); g_free (fish_super->scr_hardlink); g_free (fish_super->scr_get); g_free (fish_super->scr_send); g_free (fish_super->scr_append); g_free (fish_super->scr_info); g_free (fish_super->scr_env); } /* --------------------------------------------------------------------------------------------- */ static void fish_pipeopen (struct vfs_s_super *super, const char *path, const char *argv[]) { int fileset1[2], fileset2[2]; int res; if ((pipe (fileset1) < 0) || (pipe (fileset2) < 0)) vfs_die ("Cannot pipe(): %m."); res = fork (); if (res != 0) { if (res < 0) vfs_die ("Cannot fork(): %m."); /* We are the parent */ close (fileset1[0]); FISH_SUPER (super)->sockw = fileset1[1]; close (fileset2[1]); FISH_SUPER (super)->sockr = fileset2[0]; } else { res = dup2 (fileset1[0], STDIN_FILENO); close (fileset1[0]); close (fileset1[1]); res = dup2 (fileset2[1], STDOUT_FILENO); close (STDERR_FILENO); /* stderr to /dev/null */ res = open ("/dev/null", O_WRONLY); close (fileset2[0]); close (fileset2[1]); execvp (path, (char **) argv); my_exit (3); } } /* --------------------------------------------------------------------------------------------- */ static char * fish_set_env (int flags) { GString *tmp; tmp = g_string_sized_new (250); if ((flags & FISH_HAVE_HEAD) != 0) g_string_append (tmp, "FISH_HAVE_HEAD=1 export FISH_HAVE_HEAD; "); if ((flags & FISH_HAVE_SED) != 0) g_string_append (tmp, "FISH_HAVE_SED=1 export FISH_HAVE_SED; "); if ((flags & FISH_HAVE_AWK) != 0) g_string_append (tmp, "FISH_HAVE_AWK=1 export FISH_HAVE_AWK; "); if ((flags & FISH_HAVE_PERL) != 0) g_string_append (tmp, "FISH_HAVE_PERL=1 export FISH_HAVE_PERL; "); if ((flags & FISH_HAVE_LSQ) != 0) g_string_append (tmp, "FISH_HAVE_LSQ=1 export FISH_HAVE_LSQ; "); if ((flags & FISH_HAVE_DATE_MDYT) != 0) g_string_append (tmp, "FISH_HAVE_DATE_MDYT=1 export FISH_HAVE_DATE_MDYT; "); if ((flags & FISH_HAVE_TAIL) != 0) g_string_append (tmp, "FISH_HAVE_TAIL=1 export FISH_HAVE_TAIL; "); return g_string_free (tmp, FALSE); } /* --------------------------------------------------------------------------------------------- */ static gboolean fish_info (struct vfs_class *me, struct vfs_s_super *super) { fish_super_t *fish_super = FISH_SUPER (super); if (fish_command (me, super, NONE, fish_super->scr_info, -1) == COMPLETE) { while (TRUE) { int res; char buffer[BUF_8K] = ""; res = vfs_s_get_line_interruptible (me, buffer, sizeof (buffer), fish_super->sockr); if ((res == 0) || (res == EINTR)) ERRNOR (ECONNRESET, FALSE); if (strncmp (buffer, "### ", 4) == 0) break; fish_super->host_flags = atol (buffer); } return TRUE; } ERRNOR (E_PROTO, FALSE); } /* --------------------------------------------------------------------------------------------- */ static void fish_open_archive_pipeopen (struct vfs_s_super *super) { char gbuf[10]; const char *argv[10]; /* All of 10 is used now */ const char *xsh = (super->path_element->port == FISH_FLAG_RSH ? "rsh" : "ssh"); int i = 0; argv[i++] = xsh; if (super->path_element->port == FISH_FLAG_COMPRESSED) argv[i++] = "-C"; if (super->path_element->port > FISH_FLAG_RSH) { argv[i++] = "-p"; g_snprintf (gbuf, sizeof (gbuf), "%d", super->path_element->port); argv[i++] = gbuf; } /* * Add the user name to the ssh command line only if it was explicitly * set in vfs URL. rsh/ssh will get current user by default * plus we can set convenient overrides in ~/.ssh/config (explicit -l * option breaks it for some) */ if (super->path_element->user != NULL) { argv[i++] = "-l"; argv[i++] = super->path_element->user; } else { /* The rest of the code assumes it to be a valid username */ super->path_element->user = vfs_get_local_username (); } argv[i++] = super->path_element->host; argv[i++] = "echo FISH:; /bin/sh"; argv[i++] = NULL; fish_pipeopen (super, xsh, argv); } /* --------------------------------------------------------------------------------------------- */ static gboolean fish_open_archive_talk (struct vfs_class *me, struct vfs_s_super *super) { fish_super_t *fish_super = FISH_SUPER (super); char answer[2048]; printf ("\n%s\n", _("fish: Waiting for initial line...")); if (vfs_s_get_line (me, fish_super->sockr, answer, sizeof (answer), ':') == 0) return FALSE; if (strstr (answer, "assword") != NULL) { /* Currently, this does not work. ssh reads passwords from /dev/tty, not from stdin :-(. */ printf ("\n%s\n", _("Sorry, we cannot do password authenticated connections for now.")); return FALSE; #if 0 if (super->path_element->password == NULL) { char *p, *op; p = g_strdup_printf (_("fish: Password is required for %s"), super->path_element->user); op = vfs_get_password (p); g_free (p); if (op == NULL) return FALSE; super->path_element->password = op; } printf ("\n%s\n", _("fish: Sending password...")); { size_t str_len; str_len = strlen (super->path_element->password); if ((write (fish_super.sockw, super->path_element->password, str_len) != (ssize_t) str_len) || (write (fish_super->sockw, "\n", 1) != 1)) return FALSE; } #endif } return TRUE; } /* --------------------------------------------------------------------------------------------- */ static int fish_open_archive_int (struct vfs_class *me, struct vfs_s_super *super) { gboolean ftalk; /* hide panels */ pre_exec (); /* open pipe */ fish_open_archive_pipeopen (super); /* Start talk with ssh-server (password prompt, etc ) */ ftalk = fish_open_archive_talk (me, super); /* show panels */ post_exec (); if (!ftalk) ERRNOR (E_PROTO, -1); vfs_print_message ("%s", _("fish: Sending initial line...")); /* * Run 'start_fish_server'. If it doesn't exist - no problem, * we'll talk directly to the shell. */ if (fish_command (me, super, WAIT_REPLY, "#FISH\necho; start_fish_server 2>&1; echo '### 200'\n", -1) != COMPLETE) ERRNOR (E_PROTO, -1); vfs_print_message ("%s", _("fish: Handshaking version...")); if (fish_command (me, super, WAIT_REPLY, "#VER 0.0.3\necho '### 000'\n", -1) != COMPLETE) ERRNOR (E_PROTO, -1); /* Set up remote locale to C, otherwise dates cannot be recognized */ if (fish_command (me, super, WAIT_REPLY, "LANG=C LC_ALL=C LC_TIME=C; export LANG LC_ALL LC_TIME;\n" "echo '### 200'\n", -1) != COMPLETE) ERRNOR (E_PROTO, -1); vfs_print_message ("%s", _("fish: Getting host info...")); if (fish_info (me, super)) FISH_SUPER (super)->scr_env = fish_set_env (FISH_SUPER (super)->host_flags); #if 0 super->name = g_strconcat ("sh://", super->path_element->user, "@", super->path_element->host, PATH_SEP_STR, (char *) NULL); #else super->name = g_strdup (PATH_SEP_STR); #endif super->root = vfs_s_new_inode (me, super, fish_default_stat (me)); return 0; } /* --------------------------------------------------------------------------------------------- */ static int fish_open_archive (struct vfs_s_super *super, const vfs_path_t * vpath, const vfs_path_element_t * vpath_element) { fish_super_t *fish_super = FISH_SUPER (super); (void) vpath; super->path_element = vfs_path_element_clone (vpath_element); if (strncmp (vpath_element->vfs_prefix, "rsh", 3) == 0) super->path_element->port = FISH_FLAG_RSH; fish_super->scr_ls = fish_load_script_from_file (super->path_element->host, FISH_LS_FILE, FISH_LS_DEF_CONTENT); fish_super->scr_exists = fish_load_script_from_file (super->path_element->host, FISH_EXISTS_FILE, FISH_EXISTS_DEF_CONTENT); fish_super->scr_mkdir = fish_load_script_from_file (super->path_element->host, FISH_MKDIR_FILE, FISH_MKDIR_DEF_CONTENT); fish_super->scr_unlink = fish_load_script_from_file (super->path_element->host, FISH_UNLINK_FILE, FISH_UNLINK_DEF_CONTENT); fish_super->scr_chown = fish_load_script_from_file (super->path_element->host, FISH_CHOWN_FILE, FISH_CHOWN_DEF_CONTENT); fish_super->scr_chmod = fish_load_script_from_file (super->path_element->host, FISH_CHMOD_FILE, FISH_CHMOD_DEF_CONTENT); fish_super->scr_utime = fish_load_script_from_file (super->path_element->host, FISH_UTIME_FILE, FISH_UTIME_DEF_CONTENT); fish_super->scr_rmdir = fish_load_script_from_file (super->path_element->host, FISH_RMDIR_FILE, FISH_RMDIR_DEF_CONTENT); fish_super->scr_ln = fish_load_script_from_file (super->path_element->host, FISH_LN_FILE, FISH_LN_DEF_CONTENT); fish_super->scr_mv = fish_load_script_from_file (super->path_element->host, FISH_MV_FILE, FISH_MV_DEF_CONTENT); fish_super->scr_hardlink = fish_load_script_from_file (super->path_element->host, FISH_HARDLINK_FILE, FISH_HARDLINK_DEF_CONTENT); fish_super->scr_get = fish_load_script_from_file (super->path_element->host, FISH_GET_FILE, FISH_GET_DEF_CONTENT); fish_super->scr_send = fish_load_script_from_file (super->path_element->host, FISH_SEND_FILE, FISH_SEND_DEF_CONTENT); fish_super->scr_append = fish_load_script_from_file (super->path_element->host, FISH_APPEND_FILE, FISH_APPEND_DEF_CONTENT); fish_super->scr_info = fish_load_script_from_file (super->path_element->host, FISH_INFO_FILE, FISH_INFO_DEF_CONTENT); return fish_open_archive_int (vpath_element->class, super); } /* --------------------------------------------------------------------------------------------- */ static int fish_archive_same (const vfs_path_element_t * vpath_element, struct vfs_s_super *super, const vfs_path_t * vpath, void *cookie) { vfs_path_element_t *path_element; int result; (void) vpath; (void) cookie; path_element = vfs_path_element_clone (vpath_element); if (path_element->user == NULL) path_element->user = vfs_get_local_username (); result = ((strcmp (path_element->host, super->path_element->host) == 0) && (strcmp (path_element->user, super->path_element->user) == 0) && (path_element->port == super->path_element->port)) ? 1 : 0; vfs_path_element_free (path_element); return result; } /* --------------------------------------------------------------------------------------------- */ static void fish_parse_ls (char *buffer, struct vfs_s_entry *ent) { #define ST ent->ino->st buffer++; switch (buffer[-1]) { case ':': { char *filename; char *filename_bound; char *temp; filename = buffer; if (strcmp (filename, "\".\"") == 0 || strcmp (filename, "\"..\"") == 0) break; /* We'll do "." and ".." ourselves */ filename_bound = filename + strlen (filename); if (S_ISLNK (ST.st_mode)) { char *linkname; char *linkname_bound; /* we expect: "escaped-name" -> "escaped-name" // -> cannot occur in filenames, // because it will be escaped to -\> */ linkname_bound = filename_bound; if (*filename == '"') ++filename; linkname = strstr (filename, "\" -> \""); if (linkname == NULL) { /* broken client, or smth goes wrong */ linkname = filename_bound; if (filename_bound > filename && *(filename_bound - 1) == '"') --filename_bound; /* skip trailing " */ } else { filename_bound = linkname; linkname += 6; /* strlen ("\" -> \"") */ if (*(linkname_bound - 1) == '"') --linkname_bound; /* skip trailing " */ } ent->name = g_strndup (filename, filename_bound - filename); temp = ent->name; ent->name = strutils_shell_unescape (ent->name); g_free (temp); ent->ino->linkname = g_strndup (linkname, linkname_bound - linkname); temp = ent->ino->linkname; ent->ino->linkname = strutils_shell_unescape (ent->ino->linkname); g_free (temp); } else { /* we expect: "escaped-name" */ if (filename_bound - filename > 2) { /* there is at least 2 " and we skip them */ if (*filename == '"') ++filename; if (*(filename_bound - 1) == '"') --filename_bound; } ent->name = g_strndup (filename, filename_bound - filename); temp = ent->name; ent->name = strutils_shell_unescape (ent->name); g_free (temp); } break; } case 'S': ST.st_size = (off_t) g_ascii_strtoll (buffer, NULL, 10); break; case 'P': { size_t skipped; vfs_parse_filemode (buffer, &skipped, &ST.st_mode); break; } case 'R': { /* raw filemode: we expect: Roctal-filemode octal-filetype uid.gid */ size_t skipped; vfs_parse_raw_filemode (buffer, &skipped, &ST.st_mode); break; } case 'd': vfs_split_text (buffer); if (vfs_parse_filedate (0, &ST.st_ctime) == 0) break; ST.st_atime = ST.st_mtime = ST.st_ctime; #ifdef HAVE_STRUCT_STAT_ST_MTIM ST.st_atim.tv_nsec = ST.st_mtim.tv_nsec = ST.st_ctim.tv_nsec = 0; #endif break; case 'D': { struct tm tim; memset (&tim, 0, sizeof (tim)); /* cppcheck-suppress invalidscanf */ if (sscanf (buffer, "%d %d %d %d %d %d", &tim.tm_year, &tim.tm_mon, &tim.tm_mday, &tim.tm_hour, &tim.tm_min, &tim.tm_sec) != 6) break; ST.st_atime = ST.st_mtime = ST.st_ctime = mktime (&tim); #ifdef HAVE_STRUCT_STAT_ST_MTIM ST.st_atim.tv_nsec = ST.st_mtim.tv_nsec = ST.st_ctim.tv_nsec = 0; #endif } break; case 'E': { int maj, min; /* cppcheck-suppress invalidscanf */ if (sscanf (buffer, "%d,%d", &maj, &min) != 2) break; #ifdef HAVE_STRUCT_STAT_ST_RDEV ST.st_rdev = makedev (maj, min); #endif } break; default: break; } #undef ST } /* --------------------------------------------------------------------------------------------- */ static int fish_dir_load (struct vfs_class *me, struct vfs_s_inode *dir, const char *remote_path) { struct vfs_s_super *super = dir->super; char buffer[BUF_8K] = "\0"; struct vfs_s_entry *ent = NULL; char *quoted_path; int reply_code; /* * Simple FISH debug interface :] */ #if 0 if (me->logfile == NULL) me->logfile = fopen ("/tmp/mc-FISH.sh", "w"); #endif vfs_print_message (_("fish: Reading directory %s..."), remote_path); dir->timestamp = g_get_monotonic_time () + fish_directory_timeout * G_USEC_PER_SEC; quoted_path = strutils_shell_escape (remote_path); (void) fish_command_v (me, super, NONE, FISH_SUPER (super)->scr_ls, "FISH_FILENAME=%s;\n", quoted_path); g_free (quoted_path); ent = vfs_s_generate_entry (me, NULL, dir, 0); while (TRUE) { int res; res = vfs_s_get_line_interruptible (me, buffer, sizeof (buffer), FISH_SUPER (super)->sockr); if ((res == 0) || (res == EINTR)) { vfs_s_free_entry (me, ent); me->verrno = ECONNRESET; goto error; } if (me->logfile != NULL) { fputs (buffer, me->logfile); fputs ("\n", me->logfile); fflush (me->logfile); } if (strncmp (buffer, "### ", 4) == 0) break; if (buffer[0] != '\0') fish_parse_ls (buffer, ent); else if (ent->name != NULL) { vfs_s_insert_entry (me, dir, ent); ent = vfs_s_generate_entry (me, NULL, dir, 0); } } vfs_s_free_entry (me, ent); reply_code = fish_decode_reply (buffer + 4, 0); if (reply_code == COMPLETE) { vfs_print_message (_("%s: done."), me->name); return 0; } me->verrno = reply_code == ERROR ? EACCES : E_REMOTE; error: vfs_print_message (_("%s: failure"), me->name); return -1; } /* --------------------------------------------------------------------------------------------- */ static int fish_file_store (struct vfs_class *me, vfs_file_handler_t * fh, char *name, char *localname) { fish_file_handler_t *fish = FISH_FILE_HANDLER (fh); struct vfs_s_super *super = VFS_FILE_HANDLER_SUPER (fh); fish_super_t *fish_super = FISH_SUPER (super); int code; off_t total = 0; char buffer[BUF_8K]; struct stat s; int h; char *quoted_name; h = open (localname, O_RDONLY); if (h == -1) ERRNOR (EIO, -1); if (fstat (h, &s) < 0) { close (h); ERRNOR (EIO, -1); } /* First, try this as stor: * * ( head -c number ) | ( cat > file; cat >/dev/null ) * * If 'head' is not present on the remote system, 'dd' will be used. * Unfortunately, we cannot trust most non-GNU 'head' implementations * even if '-c' options is supported. Therefore, we separate GNU head * (and other modern heads?) using '-q' and '-' . This causes another * implementations to fail (because of "incorrect options"). * * Fallback is: * * rest= * while [ $rest -gt 0 ] * do * cnt=`expr \( $rest + 255 \) / 256` * n=`dd bs=256 count=$cnt | tee -a | wc -c` * rest=`expr $rest - $n` * done * * 'dd' was not designed for full filling of input buffers, * and does not report exact number of bytes (not blocks). * Therefore a more complex shell script is needed. * * On some systems non-GNU head writes "Usage:" error report to stdout * instead of stderr. It makes impossible the use of "head || dd" * algorithm for file appending case, therefore just "dd" is used for it. */ quoted_name = strutils_shell_escape (name); vfs_print_message (_("fish: store %s: sending command..."), quoted_name); /* FIXME: File size is limited to ULONG_MAX */ code = fish_command_v (me, super, WAIT_REPLY, fish->append ? fish_super->scr_append : fish_super->scr_send, "FISH_FILENAME=%s FISH_FILESIZE=%" PRIuMAX ";\n", quoted_name, (uintmax_t) s.st_size); g_free (quoted_name); if (code != PRELIM) { close (h); ERRNOR (E_REMOTE, -1); } while (TRUE) { ssize_t n, t; while ((n = read (h, buffer, sizeof (buffer))) < 0) { if ((errno == EINTR) && tty_got_interrupt ()) continue; vfs_print_message ("%s", _("fish: Local read failed, sending zeros")); close (h); h = open ("/dev/zero", O_RDONLY); } if (n == 0) break; t = write (fish_super->sockw, buffer, n); if (t != n) { if (t == -1) me->verrno = errno; else me->verrno = EIO; goto error_return; } tty_disable_interrupt_key (); total += n; vfs_print_message ("%s: %" PRIuMAX "/%" PRIuMAX, _("fish: storing file"), (uintmax_t) total, (uintmax_t) s.st_size); } close (h); if (fish_get_reply (me, fish_super->sockr, NULL, 0) != COMPLETE) ERRNOR (E_REMOTE, -1); return 0; error_return: close (h); fish_get_reply (me, fish_super->sockr, NULL, 0); return -1; } /* --------------------------------------------------------------------------------------------- */ static int fish_linear_start (struct vfs_class *me, vfs_file_handler_t * fh, off_t offset) { fish_file_handler_t *fish = FISH_FILE_HANDLER (fh); struct vfs_s_super *super = VFS_FILE_HANDLER_SUPER (fh); char *name; char *quoted_name; name = vfs_s_fullpath (me, fh->ino); if (name == NULL) return 0; quoted_name = strutils_shell_escape (name); g_free (name); fish->append = FALSE; /* * Check whether the remote file is readable by using 'dd' to copy * a single byte from the remote file to /dev/null. If 'dd' completes * with exit status of 0 use 'cat' to send the file contents to the * standard output (i.e. over the network). */ offset = fish_command_v (me, super, WANT_STRING, FISH_SUPER (super)->scr_get, "FISH_FILENAME=%s FISH_START_OFFSET=%" PRIuMAX ";\n", quoted_name, (uintmax_t) offset); g_free (quoted_name); if (offset != PRELIM) ERRNOR (E_REMOTE, 0); fh->linear = LS_LINEAR_OPEN; fish->got = 0; errno = 0; #if SIZEOF_OFF_T == SIZEOF_LONG fish->total = (off_t) strtol (reply_str, NULL, 10); #else fish->total = (off_t) g_ascii_strtoll (reply_str, NULL, 10); #endif if (errno != 0) ERRNOR (E_REMOTE, 0); return 1; } /* --------------------------------------------------------------------------------------------- */ static void fish_linear_abort (struct vfs_class *me, vfs_file_handler_t * fh) { fish_file_handler_t *fish = FISH_FILE_HANDLER (fh); struct vfs_s_super *super = VFS_FILE_HANDLER_SUPER (fh); char buffer[BUF_8K]; ssize_t n; vfs_print_message ("%s", _("Aborting transfer...")); do { n = MIN ((off_t) sizeof (buffer), (fish->total - fish->got)); if (n != 0) { n = read (FISH_SUPER (super)->sockr, buffer, n); if (n < 0) return; fish->got += n; } } while (n != 0); if (fish_get_reply (me, FISH_SUPER (super)->sockr, NULL, 0) != COMPLETE) vfs_print_message ("%s", _("Error reported after abort.")); else vfs_print_message ("%s", _("Aborted transfer would be successful.")); } /* --------------------------------------------------------------------------------------------- */ static ssize_t fish_linear_read (struct vfs_class *me, vfs_file_handler_t * fh, void *buf, size_t len) { fish_file_handler_t *fish = FISH_FILE_HANDLER (fh); struct vfs_s_super *super = VFS_FILE_HANDLER_SUPER (fh); ssize_t n = 0; len = MIN ((size_t) (fish->total - fish->got), len); tty_disable_interrupt_key (); while (len != 0 && ((n = read (FISH_SUPER (super)->sockr, buf, len)) < 0)) { if ((errno == EINTR) && !tty_got_interrupt ()) continue; break; } tty_enable_interrupt_key (); if (n > 0) fish->got += n; else if (n < 0) fish_linear_abort (me, fh); else if (fish_get_reply (me, FISH_SUPER (super)->sockr, NULL, 0) != COMPLETE) ERRNOR (E_REMOTE, -1); ERRNOR (errno, n); } /* --------------------------------------------------------------------------------------------- */ static void fish_linear_close (struct vfs_class *me, vfs_file_handler_t * fh) { fish_file_handler_t *fish = FISH_FILE_HANDLER (fh); if (fish->total != fish->got) fish_linear_abort (me, fh); } /* --------------------------------------------------------------------------------------------- */ static int fish_ctl (void *fh, int ctlop, void *arg) { (void) arg; (void) fh; (void) ctlop; return 0; #if 0 switch (ctlop) { case VFS_CTL_IS_NOTREADY: { vfs_file_handler_t *file = VFS_FILE_HANDLER (fh); int v; if (file->linear == LS_NOT_LINEAR) vfs_die ("You may not do this"); if (file->linear == LS_LINEAR_CLOSED || file->linear == LS_LINEAR_PREOPEN) return 0; v = vfs_s_select_on_two (VFS_FILE_HANDLER_SUPER (fh)->u.fish.sockr, 0); return (((v < 0) && (errno == EINTR)) || v == 0) ? 1 : 0; } default: return 0; } #endif } /* --------------------------------------------------------------------------------------------- */ static int fish_rename (const vfs_path_t * vpath1, const vfs_path_t * vpath2) { const char *crpath1, *crpath2; char *rpath1, *rpath2; struct vfs_s_super *super, *super2; const vfs_path_element_t *path_element; int ret; path_element = vfs_path_get_by_index (vpath1, -1); crpath1 = vfs_s_get_path (vpath1, &super, 0); if (crpath1 == NULL) return -1; crpath2 = vfs_s_get_path (vpath2, &super2, 0); if (crpath2 == NULL) return -1; rpath1 = strutils_shell_escape (crpath1); rpath2 = strutils_shell_escape (crpath2); ret = fish_send_command (path_element->class, super2, OPT_FLUSH, FISH_SUPER (super)->scr_mv, "FISH_FILEFROM=%s FISH_FILETO=%s;\n", rpath1, rpath2); g_free (rpath1); g_free (rpath2); return ret; } /* --------------------------------------------------------------------------------------------- */ static int fish_link (const vfs_path_t * vpath1, const vfs_path_t * vpath2) { const char *crpath1, *crpath2; char *rpath1, *rpath2; struct vfs_s_super *super, *super2; const vfs_path_element_t *path_element; int ret; path_element = vfs_path_get_by_index (vpath1, -1); crpath1 = vfs_s_get_path (vpath1, &super, 0); if (crpath1 == NULL) return -1; crpath2 = vfs_s_get_path (vpath2, &super2, 0); if (crpath2 == NULL) return -1; rpath1 = strutils_shell_escape (crpath1); rpath2 = strutils_shell_escape (crpath2); ret = fish_send_command (path_element->class, super2, OPT_FLUSH, FISH_SUPER (super)->scr_hardlink, "FISH_FILEFROM=%s FISH_FILETO=%s;\n", rpath1, rpath2); g_free (rpath1); g_free (rpath2); return ret; } /* --------------------------------------------------------------------------------------------- */ static int fish_symlink (const vfs_path_t * vpath1, const vfs_path_t * vpath2) { char *qsetto; const char *crpath; char *rpath; struct vfs_s_super *super; const vfs_path_element_t *path_element; int ret; path_element = vfs_path_get_by_index (vpath2, -1); crpath = vfs_s_get_path (vpath2, &super, 0); if (crpath == NULL) return -1; rpath = strutils_shell_escape (crpath); qsetto = strutils_shell_escape (vfs_path_get_by_index (vpath1, -1)->path); ret = fish_send_command (path_element->class, super, OPT_FLUSH, FISH_SUPER (super)->scr_ln, "FISH_FILEFROM=%s FISH_FILETO=%s;\n", qsetto, rpath); g_free (qsetto); g_free (rpath); return ret; } /* --------------------------------------------------------------------------------------------- */ static int fish_stat (const vfs_path_t * vpath, struct stat *buf) { int ret; ret = vfs_s_stat (vpath, buf); fish_set_blksize (buf); return ret; } /* --------------------------------------------------------------------------------------------- */ static int fish_lstat (const vfs_path_t * vpath, struct stat *buf) { int ret; ret = vfs_s_lstat (vpath, buf); fish_set_blksize (buf); return ret; } /* --------------------------------------------------------------------------------------------- */ static int fish_fstat (void *vfs_info, struct stat *buf) { int ret; ret = vfs_s_fstat (vfs_info, buf); fish_set_blksize (buf); return ret; } /* --------------------------------------------------------------------------------------------- */ static int fish_chmod (const vfs_path_t * vpath, mode_t mode) { const char *crpath; char *rpath; struct vfs_s_super *super; const vfs_path_element_t *path_element; int ret; path_element = vfs_path_get_by_index (vpath, -1); crpath = vfs_s_get_path (vpath, &super, 0); if (crpath == NULL) return -1; rpath = strutils_shell_escape (crpath); ret = fish_send_command (path_element->class, super, OPT_FLUSH, FISH_SUPER (super)->scr_chmod, "FISH_FILENAME=%s FISH_FILEMODE=%4.4o;\n", rpath, (unsigned int) (mode & 07777)); g_free (rpath); return ret;; } /* --------------------------------------------------------------------------------------------- */ static int fish_chown (const vfs_path_t * vpath, uid_t owner, gid_t group) { char *sowner, *sgroup; struct passwd *pw; struct group *gr; const char *crpath; char *rpath; struct vfs_s_super *super; const vfs_path_element_t *path_element; int ret; pw = getpwuid (owner); if (pw == NULL) return 0; gr = getgrgid (group); if (gr == NULL) return 0; sowner = pw->pw_name; sgroup = gr->gr_name; path_element = vfs_path_get_by_index (vpath, -1); crpath = vfs_s_get_path (vpath, &super, 0); if (crpath == NULL) return -1; rpath = strutils_shell_escape (crpath); /* FIXME: what should we report if chgrp succeeds but chown fails? */ ret = fish_send_command (path_element->class, super, OPT_FLUSH, FISH_SUPER (super)->scr_chown, "FISH_FILENAME=%s FISH_FILEOWNER=%s FISH_FILEGROUP=%s;\n", rpath, sowner, sgroup); g_free (rpath); return ret; } /* --------------------------------------------------------------------------------------------- */ static void fish_get_atime (mc_timesbuf_t * times, time_t * sec, long *nsec) { #ifdef HAVE_UTIMENSAT *sec = (*times)[0].tv_sec; *nsec = (*times)[0].tv_nsec; #else *sec = times->actime; *nsec = 0; #endif } /* --------------------------------------------------------------------------------------------- */ static void fish_get_mtime (mc_timesbuf_t * times, time_t * sec, long *nsec) { #ifdef HAVE_UTIMENSAT *sec = (*times)[1].tv_sec; *nsec = (*times)[1].tv_nsec; #else *sec = times->modtime; *nsec = 0; #endif } /* --------------------------------------------------------------------------------------------- */ static int fish_utime (const vfs_path_t * vpath, mc_timesbuf_t * times) { char utcatime[16], utcmtime[16]; char utcatime_w_nsec[30], utcmtime_w_nsec[30]; time_t atime, mtime; long atime_nsec, mtime_nsec; struct tm *gmt; const char *crpath; char *rpath; struct vfs_s_super *super; const vfs_path_element_t *path_element; int ret; path_element = vfs_path_get_by_index (vpath, -1); crpath = vfs_s_get_path (vpath, &super, 0); if (crpath == NULL) return -1; rpath = strutils_shell_escape (crpath); fish_get_atime (times, &atime, &atime_nsec); gmt = gmtime (&atime); g_snprintf (utcatime, sizeof (utcatime), "%04d%02d%02d%02d%02d.%02d", gmt->tm_year + 1900, gmt->tm_mon + 1, gmt->tm_mday, gmt->tm_hour, gmt->tm_min, gmt->tm_sec); g_snprintf (utcatime_w_nsec, sizeof (utcatime_w_nsec), "%04d-%02d-%02d %02d:%02d:%02d.%09ld", gmt->tm_year + 1900, gmt->tm_mon + 1, gmt->tm_mday, gmt->tm_hour, gmt->tm_min, gmt->tm_sec, atime_nsec); fish_get_mtime (times, &mtime, &mtime_nsec); gmt = gmtime (&mtime); g_snprintf (utcmtime, sizeof (utcmtime), "%04d%02d%02d%02d%02d.%02d", gmt->tm_year + 1900, gmt->tm_mon + 1, gmt->tm_mday, gmt->tm_hour, gmt->tm_min, gmt->tm_sec); g_snprintf (utcmtime_w_nsec, sizeof (utcmtime_w_nsec), "%04d-%02d-%02d %02d:%02d:%02d.%09ld", gmt->tm_year + 1900, gmt->tm_mon + 1, gmt->tm_mday, gmt->tm_hour, gmt->tm_min, gmt->tm_sec, mtime_nsec); ret = fish_send_command (path_element->class, super, OPT_FLUSH, FISH_SUPER (super)->scr_utime, "FISH_FILENAME=%s FISH_FILEATIME=%ld FISH_FILEMTIME=%ld " "FISH_TOUCHATIME=%s FISH_TOUCHMTIME=%s FISH_TOUCHATIME_W_NSEC=\"%s\" " "FISH_TOUCHMTIME_W_NSEC=\"%s\";\n", rpath, (long) atime, (long) mtime, utcatime, utcmtime, utcatime_w_nsec, utcmtime_w_nsec); g_free (rpath); return ret; } /* --------------------------------------------------------------------------------------------- */ static int fish_unlink (const vfs_path_t * vpath) { const char *crpath; char *rpath; struct vfs_s_super *super; const vfs_path_element_t *path_element; int ret; path_element = vfs_path_get_by_index (vpath, -1); crpath = vfs_s_get_path (vpath, &super, 0); if (crpath == NULL) return -1; rpath = strutils_shell_escape (crpath); ret = fish_send_command (path_element->class, super, OPT_FLUSH, FISH_SUPER (super)->scr_unlink, "FISH_FILENAME=%s;\n", rpath); g_free (rpath); return ret; } /* --------------------------------------------------------------------------------------------- */ static int fish_exists (const vfs_path_t * vpath) { const char *crpath; char *rpath; struct vfs_s_super *super; const vfs_path_element_t *path_element; int ret; path_element = vfs_path_get_by_index (vpath, -1); crpath = vfs_s_get_path (vpath, &super, 0); if (crpath == NULL) return -1; rpath = strutils_shell_escape (crpath); ret = fish_send_command (path_element->class, super, OPT_FLUSH, FISH_SUPER (super)->scr_exists, "FISH_FILENAME=%s;\n", rpath); g_free (rpath); return (ret == 0 ? 1 : 0); } /* --------------------------------------------------------------------------------------------- */ static int fish_mkdir (const vfs_path_t * vpath, mode_t mode) { const char *crpath; char *rpath; struct vfs_s_super *super; const vfs_path_element_t *path_element; int ret; (void) mode; path_element = vfs_path_get_by_index (vpath, -1); crpath = vfs_s_get_path (vpath, &super, 0); if (crpath == NULL) return -1; rpath = strutils_shell_escape (crpath); ret = fish_send_command (path_element->class, super, OPT_FLUSH, FISH_SUPER (super)->scr_mkdir, "FISH_FILENAME=%s;\n", rpath); g_free (rpath); if (ret != 0) return ret; if (fish_exists (vpath) == 0) { path_element->class->verrno = EACCES; return -1; } return 0; } /* --------------------------------------------------------------------------------------------- */ static int fish_rmdir (const vfs_path_t * vpath) { const char *crpath; char *rpath; struct vfs_s_super *super; const vfs_path_element_t *path_element; int ret; path_element = vfs_path_get_by_index (vpath, -1); crpath = vfs_s_get_path (vpath, &super, 0); if (crpath == NULL) return -1; rpath = strutils_shell_escape (crpath); ret = fish_send_command (path_element->class, super, OPT_FLUSH, FISH_SUPER (super)->scr_rmdir, "FISH_FILENAME=%s;\n", rpath); g_free (rpath); return ret; } /* --------------------------------------------------------------------------------------------- */ static vfs_file_handler_t * fish_fh_new (struct vfs_s_inode *ino, gboolean changed) { fish_file_handler_t *fh; fh = g_new0 (fish_file_handler_t, 1); vfs_s_init_fh (VFS_FILE_HANDLER (fh), ino, changed); return VFS_FILE_HANDLER (fh); } /* --------------------------------------------------------------------------------------------- */ static int fish_fh_open (struct vfs_class *me, vfs_file_handler_t * fh, int flags, mode_t mode) { fish_file_handler_t *fish = FISH_FILE_HANDLER (fh); (void) mode; /* File will be written only, so no need to retrieve it */ if (((flags & O_WRONLY) == O_WRONLY) && ((flags & (O_RDONLY | O_RDWR)) == 0)) { /* user pressed the button [ Append ] in the "Copy" dialog */ if ((flags & O_APPEND) != 0) fish->append = TRUE; if (fh->ino->localname == NULL) { vfs_path_t *vpath = NULL; int tmp_handle; tmp_handle = vfs_mkstemps (&vpath, me->name, fh->ino->ent->name); if (tmp_handle == -1) return (-1); fh->ino->localname = vfs_path_free (vpath, FALSE); close (tmp_handle); } return 0; } if (fh->ino->localname == NULL && vfs_s_retrieve_file (me, fh->ino) == -1) return (-1); if (fh->ino->localname == NULL) vfs_die ("retrieve_file failed to fill in localname"); return 0; } /* --------------------------------------------------------------------------------------------- */ static void fish_fill_names (struct vfs_class *me, fill_names_f func) { GList *iter; for (iter = VFS_SUBCLASS (me)->supers; iter != NULL; iter = g_list_next (iter)) { const struct vfs_s_super *super = (const struct vfs_s_super *) iter->data; char *name; char gbuf[10]; const char *flags = ""; switch (super->path_element->port) { case FISH_FLAG_RSH: flags = ":r"; break; case FISH_FLAG_COMPRESSED: flags = ":C"; break; default: if (super->path_element->port > FISH_FLAG_RSH) { g_snprintf (gbuf, sizeof (gbuf), ":%d", super->path_element->port); flags = gbuf; } break; } name = g_strconcat (vfs_fish_ops->prefix, VFS_PATH_URL_DELIMITER, super->path_element->user, "@", super->path_element->host, flags, PATH_SEP_STR, super->path_element->path, (char *) NULL); func (name); g_free (name); } } /* --------------------------------------------------------------------------------------------- */ static void * fish_open (const vfs_path_t * vpath, int flags, mode_t mode) { /* sorry, i've places hack here cause fish don't able to open files with O_EXCL flag */ flags &= ~O_EXCL; return vfs_s_open (vpath, flags, mode); } /* --------------------------------------------------------------------------------------------- */ /*** public functions ****************************************************************************/ /* --------------------------------------------------------------------------------------------- */ void vfs_init_fish (void) { tcp_init (); vfs_init_subclass (&fish_subclass, "fish", VFSF_REMOTE | VFSF_USETMP, "sh"); vfs_fish_ops->fill_names = fish_fill_names; vfs_fish_ops->stat = fish_stat; vfs_fish_ops->lstat = fish_lstat; vfs_fish_ops->fstat = fish_fstat; vfs_fish_ops->chmod = fish_chmod; vfs_fish_ops->chown = fish_chown; vfs_fish_ops->utime = fish_utime; vfs_fish_ops->open = fish_open; vfs_fish_ops->symlink = fish_symlink; vfs_fish_ops->link = fish_link; vfs_fish_ops->unlink = fish_unlink; vfs_fish_ops->rename = fish_rename; vfs_fish_ops->mkdir = fish_mkdir; vfs_fish_ops->rmdir = fish_rmdir; vfs_fish_ops->ctl = fish_ctl; fish_subclass.archive_same = fish_archive_same; fish_subclass.new_archive = fish_new_archive; fish_subclass.open_archive = fish_open_archive; fish_subclass.free_archive = fish_free_archive; fish_subclass.fh_new = fish_fh_new; fish_subclass.fh_open = fish_fh_open; fish_subclass.dir_load = fish_dir_load; fish_subclass.file_store = fish_file_store; fish_subclass.linear_start = fish_linear_start; fish_subclass.linear_read = fish_linear_read; fish_subclass.linear_close = fish_linear_close; vfs_register_class (vfs_fish_ops); } /* --------------------------------------------------------------------------------------------- */