Ticket #1450: FISH: timestamps don't show correctly
[midnight-commander.git] / vfs / fish.c
blobc16a7600a8db2324b655eade8a48e52d06a8ed75
1 /* Virtual File System: FISH implementation for transfering files over
2 shell connections.
4 Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
5 2007 Free Software Foundation, Inc.
7 Written by: 1998 Pavel Machek
8 Spaces fix: 2000 Michal Svec
10 Derived from ftpfs.c.
12 This program is free software; you can redistribute it and/or
13 modify it under the terms of the GNU Library General Public License
14 as published by the Free Software Foundation; either version 2 of
15 the License, or (at your option) any later version.
17 This program is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 GNU Library General Public License for more details.
22 You should have received a copy of the GNU Library General Public
23 License along with this program; if not, write to the Free Software
24 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
26 /**
27 * \file
28 * \brief Source: Virtual File System: FISH implementation for transfering files over
29 * shell connections
30 * \author Pavel Machek
31 * \author Michal Svec
32 * \date 1998, 2000
34 * Derived from ftpfs.c
35 * Read README.fish for protocol specification.
37 * Syntax of path is: /#sh:user@host[:Cr]/path
38 * where C means you want compressed connection,
39 * and r means you want to use rsh
41 * Namespace: fish_vfs_ops exported.
44 /* Define this if your ssh can take -I option */
46 #include <config.h>
47 #include <errno.h>
48 #include <fcntl.h>
49 #include <pwd.h>
50 #include <grp.h>
51 #include <sys/time.h> /* gettimeofday() */
52 #include <stdlib.h>
53 #include <string.h>
55 #include "../src/global.h"
57 #include "../src/tty/tty.h" /* enable/disable interrupt key */
59 #include "../src/wtools.h" /* message() */
60 #include "../src/main.h" /* print_vfs_message */
61 #include "../src/util.h"
62 #include "../src/strescape.h"
63 #include "../src/unixcompat.h"
64 #include "../src/fs.h"
65 #include "utilvfs.h"
66 #include "xdirentry.h"
67 #include "vfs.h"
68 #include "vfs-impl.h"
69 #include "gc.h" /* vfs_stamp_create */
70 #include "tcputil.h"
71 #include "fish.h"
73 int fish_directory_timeout = 900;
75 #define DO_RESOLVE_SYMLINK 1
76 #define DO_OPEN 2
77 #define DO_FREE_RESOURCE 4
79 #define FISH_FLAG_COMPRESSED 1
80 #define FISH_FLAG_RSH 2
82 #define OPT_FLUSH 1
83 #define OPT_IGNORE_ERROR 2
86 * Reply codes.
88 #define PRELIM 1 /* positive preliminary */
89 #define COMPLETE 2 /* positive completion */
90 #define CONTINUE 3 /* positive intermediate */
91 #define TRANSIENT 4 /* transient negative completion */
92 #define ERROR 5 /* permanent negative completion */
94 /* command wait_flag: */
95 #define NONE 0x00
96 #define WAIT_REPLY 0x01
97 #define WANT_STRING 0x02
98 static char reply_str [80];
100 static struct vfs_class vfs_fish_ops;
102 static int
103 fish_command (struct vfs_class *me, struct vfs_s_super *super,
104 int wait_reply, const char *fmt, ...)
105 __attribute__ ((format (__printf__, 4, 5)));
107 static int fish_decode_reply (char *s, int was_garbage)
109 int code;
110 if (!sscanf(s, "%d", &code)) {
111 code = 500;
112 return 5;
114 if (code<100) return was_garbage ? ERROR : (!code ? COMPLETE : PRELIM);
115 return code / 100;
118 /* Returns a reply code, check /usr/include/arpa/ftp.h for possible values */
119 static int fish_get_reply (struct vfs_class *me, int sock, char *string_buf, int string_len)
121 char answer[1024];
122 int was_garbage = 0;
124 for (;;) {
125 if (!vfs_s_get_line(me, sock, answer, sizeof(answer), '\n')) {
126 if (string_buf)
127 *string_buf = 0;
128 return 4;
131 if (strncmp(answer, "### ", 4)) {
132 was_garbage = 1;
133 if (string_buf)
134 g_strlcpy(string_buf, answer, string_len);
135 } else return fish_decode_reply(answer+4, was_garbage);
139 #define SUP super->u.fish
141 static int
142 fish_command (struct vfs_class *me, struct vfs_s_super *super,
143 int wait_reply, const char *fmt, ...)
145 va_list ap;
146 char *str;
147 int status;
148 FILE *logfile = MEDATA->logfile;
150 va_start (ap, fmt);
152 str = g_strdup_vprintf (fmt, ap);
153 va_end (ap);
155 if (logfile) {
156 fwrite (str, strlen (str), 1, logfile);
157 fflush (logfile);
160 tty_enable_interrupt_key ();
162 status = write (SUP.sockw, str, strlen (str));
163 g_free (str);
165 tty_disable_interrupt_key ();
166 if (status < 0)
167 return TRANSIENT;
169 if (wait_reply)
170 return fish_get_reply (me, SUP.sockr,
171 (wait_reply & WANT_STRING) ? reply_str :
172 NULL, sizeof (reply_str) - 1);
173 return COMPLETE;
176 static void
177 fish_free_archive (struct vfs_class *me, struct vfs_s_super *super)
179 if ((SUP.sockw != -1) || (SUP.sockr != -1)) {
180 print_vfs_message (_("fish: Disconnecting from %s"),
181 super->name ? super->name : "???");
182 fish_command (me, super, NONE, "#BYE\nexit\n");
183 close (SUP.sockw);
184 close (SUP.sockr);
185 SUP.sockw = SUP.sockr = -1;
187 g_free (SUP.host);
188 g_free (SUP.user);
189 g_free (SUP.cwdir);
190 g_free (SUP.password);
193 static void
194 fish_pipeopen(struct vfs_s_super *super, const char *path, const char *argv[])
196 int fileset1[2], fileset2[2];
197 int res;
199 if ((pipe(fileset1)<0) || (pipe(fileset2)<0))
200 vfs_die("Cannot pipe(): %m.");
202 if ((res = fork())) {
203 if (res<0) vfs_die("Cannot fork(): %m.");
204 /* We are the parent */
205 close(fileset1[0]);
206 SUP.sockw = fileset1[1];
207 close(fileset2[1]);
208 SUP.sockr = fileset2[0];
209 } else {
210 close(0);
211 dup(fileset1[0]);
212 close(fileset1[0]); close(fileset1[1]);
213 close(1); close(2);
214 dup(fileset2[1]);
215 /* stderr to /dev/null */
216 open ("/dev/null", O_WRONLY);
217 close(fileset2[0]); close(fileset2[1]);
218 execvp(path, const_cast(char **, argv));
219 _exit(3);
223 /* The returned directory should always contain a trailing slash */
224 static char *fish_getcwd(struct vfs_class *me, struct vfs_s_super *super)
226 if (fish_command (me, super, WANT_STRING, "#PWD\npwd; echo '### 200'\n") == COMPLETE)
227 return g_strconcat (reply_str, "/", (char *) NULL);
228 ERRNOR (EIO, NULL);
231 static int
232 fish_open_archive_int (struct vfs_class *me, struct vfs_s_super *super)
235 char gbuf[10];
236 const char *argv[10]; /* All of 10 is used now */
237 const char *xsh = (SUP.flags == FISH_FLAG_RSH ? "rsh" : "ssh");
238 int i = 0;
240 argv[i++] = xsh;
241 if (SUP.flags == FISH_FLAG_COMPRESSED)
242 argv[i++] = "-C";
244 if (SUP.flags > FISH_FLAG_RSH)
246 argv[i++] = "-p";
247 g_snprintf (gbuf, sizeof (gbuf), "%d", SUP.flags);
248 argv[i++] = gbuf;
251 argv[i++] = "-l";
252 argv[i++] = SUP.user;
253 argv[i++] = SUP.host;
254 argv[i++] = "echo FISH:; /bin/sh";
255 argv[i++] = NULL;
257 fish_pipeopen (super, xsh, argv);
260 char answer[2048];
261 print_vfs_message (_("fish: Waiting for initial line..."));
262 if (!vfs_s_get_line (me, SUP.sockr, answer, sizeof (answer), ':'))
263 ERRNOR (E_PROTO, -1);
264 print_vfs_message ("%s", answer);
265 if (strstr (answer, "assword")) {
267 /* Currently, this does not work. ssh reads passwords from
268 /dev/tty, not from stdin :-(. */
270 message (D_ERROR, MSG_ERROR,
272 ("Sorry, we cannot do password authenticated connections for now."));
273 ERRNOR (EPERM, -1);
274 if (!SUP.password) {
275 char *p, *op;
276 p = g_strconcat (_(" fish: Password required for "),
277 SUP.user, " ", (char *) NULL);
278 op = vfs_get_password (p);
279 g_free (p);
280 if (op == NULL)
281 ERRNOR (EPERM, -1);
282 SUP.password = op;
284 print_vfs_message (_("fish: Sending password..."));
285 write (SUP.sockw, SUP.password, strlen (SUP.password));
286 write (SUP.sockw, "\n", 1);
290 print_vfs_message (_("fish: Sending initial line..."));
292 * Run `start_fish_server'. If it doesn't exist - no problem,
293 * we'll talk directly to the shell.
295 if (fish_command
296 (me, super, WAIT_REPLY,
297 "#FISH\necho; start_fish_server 2>&1; echo '### 200'\n") !=
298 COMPLETE)
299 ERRNOR (E_PROTO, -1);
301 print_vfs_message (_("fish: Handshaking version..."));
302 if (fish_command
303 (me, super, WAIT_REPLY,
304 "#VER 0.0.0\necho '### 000'\n") != COMPLETE)
305 ERRNOR (E_PROTO, -1);
307 /* Set up remote locale to C, otherwise dates cannot be recognized */
308 if (fish_command
309 (me, super, WAIT_REPLY,
310 "LANG=C; LC_ALL=C; LC_TIME=C\n"
311 "export LANG; export LC_ALL; export LC_TIME\n" "echo '### 200'\n")
312 != COMPLETE)
313 ERRNOR (E_PROTO, -1);
315 print_vfs_message (_("fish: Setting up current directory..."));
316 SUP.cwdir = fish_getcwd (me, super);
317 print_vfs_message (_("fish: Connected, home %s."), SUP.cwdir);
318 #if 0
319 super->name =
320 g_strconcat ("/#sh:", SUP.user, "@", SUP.host, "/", (char *) NULL);
321 #endif
322 super->name = g_strdup (PATH_SEP_STR);
324 super->root =
325 vfs_s_new_inode (me, super,
326 vfs_s_default_stat (me, S_IFDIR | 0755));
327 return 0;
330 static int
331 fish_open_archive (struct vfs_class *me, struct vfs_s_super *super,
332 const char *archive_name, char *op)
334 char *host, *user, *password, *p;
335 int flags;
337 (void) archive_name;
339 p = vfs_split_url (strchr (op, ':') + 1, &host, &user, &flags,
340 &password, 0, URL_NOSLASH);
342 g_free (p);
344 SUP.host = host;
345 SUP.user = user;
346 SUP.flags = flags;
347 if (!strncmp (op, "rsh:", 4))
348 SUP.flags = FISH_FLAG_RSH;
349 SUP.cwdir = NULL;
350 if (password)
351 SUP.password = password;
352 return fish_open_archive_int (me, super);
355 static int
356 fish_archive_same (struct vfs_class *me, struct vfs_s_super *super,
357 const char *archive_name, char *op, void *cookie)
359 char *host, *user;
360 int flags;
362 (void) me;
363 (void) archive_name;
364 (void) cookie;
366 op = vfs_split_url (strchr (op, ':') + 1, &host, &user, &flags, 0, 0,
367 URL_NOSLASH);
369 g_free (op);
371 flags = ((strcmp (host, SUP.host) == 0)
372 && (strcmp (user, SUP.user) == 0) && (flags == SUP.flags));
373 g_free (host);
374 g_free (user);
376 return flags;
379 static int
380 fish_dir_load(struct vfs_class *me, struct vfs_s_inode *dir, char *remote_path)
382 struct vfs_s_super *super = dir->super;
383 char buffer[8192];
384 struct vfs_s_entry *ent = NULL;
385 FILE *logfile;
386 char *quoted_path;
387 int reply_code;
388 gchar *shell_commands;
390 #if 0
392 * Simple FISH debug interface :]
394 if (!(MEDATA->logfile))
396 MEDATA->logfile = fopen("/tmp/mc-FISH.sh", "w");
398 #endif /* 0 */
400 logfile = MEDATA->logfile;
402 print_vfs_message(_("fish: Reading directory %s..."), remote_path);
404 gettimeofday(&dir->timestamp, NULL);
405 dir->timestamp.tv_sec += fish_directory_timeout;
406 quoted_path = strutils_shell_escape (remote_path);
407 shell_commands = g_strconcat(
408 "#LIST /%s\n"
409 "if `perl -v > /dev/null 2>&1` ; then\n"
410 "perl -e '\n"
411 "use strict;\n"
412 "use POSIX;\n"
413 "use Fcntl;\n"
414 "use POSIX \":fcntl_h\"; #S_ISLNK was here until 5.6\n"
415 "import Fcntl \":mode\" unless defined &S_ISLNK; #and is now here\n"
416 "my $dirname = $ARGV[0];\n"
417 "if (opendir ( DIR, $dirname )) {\n"
418 "while( (my $filename = readdir(DIR))){\n"
419 "my ($dev,$ino,$mode,$nlink,$uid,$gid,$rdev,$size,$atime,$mtime,$ctime,$blksize,$blocks) = lstat(\"$dirname/$filename\");\n"
420 "my $mloctime= strftime(\"%%m-%%d-%%Y %%H:%%M\", localtime $mtime);\n"
422 "my $strutils_shell_escape_regex= s/([;<>\\*\\|`&\\$!#\\(\\)\\[\\]\\{\\}:'\\''\"\\ \\\\])/\\\\$1/g;\n"
423 "my $e_filename = $filename;\n"
424 "$e_filename =~ $strutils_shell_escape_regex;\n"
425 "if (S_ISLNK($mode) ) {\n"
426 "my $linkname = readlink (\"$dirname/$filename\");\n"
427 "$linkname =~ $strutils_shell_escape_regex;\n"
428 "\n"
429 "printf(\"R%%o %%o $uid.$gid\\n"
430 "S$size\\n"
431 "d$mloctime\\n"
432 ":\\\"$e_filename\\\" -> \\\"$linkname\\\"\\n"
433 "\\n\", S_IMODE($mode), S_IFMT($mode));\n"
434 "} else {\n"
435 "printf(\"R%%o %%o $uid.$gid\\n"
436 "S$size\\n"
437 "d$mloctime\\n"
438 ":\\\"$e_filename\\\"\\n"
439 "\\n\", S_IMODE($mode), S_IFMT($mode));\n"
440 "}}\n"
442 "printf(\"### 200\\n\");\n"
443 "closedir(DIR);\n"
444 "} else {\n"
445 "printf(\"### 500\\n\");\n"
446 "}\n"
447 "exit 0\n"
448 "' /%s ||\n" /* ARGV[0] - path to browse */
449 " echo '### 500'\n" /* do not hang if perl is to eval it */
450 "elif `ls -1 /%s >/dev/null 2>&1` ; then\n"
451 "if `ls -Q /%s >/dev/null 2>&1`; then\n"
452 "LSOPT=\"-Qlan\";\n"
453 "ADD=0;\n"
454 "else\n"
455 "LSOPT=\"-lan\";\n"
456 "ADD=1;\n"
457 "fi\n"
458 "ls $LSOPT /%s 2>/dev/null | grep '^[^cbt]' | (\n"
459 "while read p l u g s m d y n; do\n"
460 "if [ $ADD = 0 ]; then\n"
461 "echo \"P$p $u.$g\nS$s\nd$m $d $y\n:$n\n\"\n"
462 "elif `sed --version >/dev/null 2>&1` ; then\n"
463 "file=`echo $n | sed -e 's#^\\(.*\\) -> \\(.*\\)#\\1\" -> \"\\2#'`\n"
465 "echo \"P$p $u $g\nS$s\nd$m $d $y\n:\"$file\"\n\"\n"
466 "else\n"
467 "echo \"P$p $u $g\nS$s\nd$m $d $y\n:\"$n\"\n\"\n"
468 "fi\n"
469 "done )\n"
470 "ls $LSOPT /%s 2>/dev/null | grep '^[cb]' | (\n"
471 "while read p l u g a i m d y n; do\n"
472 "if [ $ADD = 0 ]; then\n"
473 "echo \"P$p $u.$g\nE$a$i\nd$m $d $y\n:$n\n\"\n"
474 "elif `sed --version >/dev/null 2>&1` ; then\n"
475 "file=`echo $n | sed -e 's#^\\(.*\\) -> \\(.*\\)#\\1\" -> \"\\2#'`\n"
476 "echo \"P$p $u $g\nS$s\nd$m $d $y\n:\"$file\"\n\"\n"
477 "else\n"
478 "echo \"P$p $u $g\nS$s\nd$m $d $y\n:\"$n\"\n\"\n"
479 "fi\n"
480 "done)\n"
481 "echo '### 200'\n"
482 "else\n"
483 "echo '### 500'\n"
484 "fi\n"
486 NULL
489 fish_command (me, super, NONE, shell_commands,
490 quoted_path, quoted_path, quoted_path, quoted_path, quoted_path, quoted_path);
492 g_free(shell_commands);
493 g_free (quoted_path);
494 ent = vfs_s_generate_entry(me, NULL, dir, 0);
495 while (1) {
496 int res = vfs_s_get_line_interruptible (me, buffer, sizeof (buffer), SUP.sockr);
497 if ((!res) || (res == EINTR)) {
498 vfs_s_free_entry(me, ent);
499 me->verrno = ECONNRESET;
500 goto error;
502 if (logfile) {
503 fputs (buffer, logfile);
504 fputs ("\n", logfile);
505 fflush (logfile);
507 if (!strncmp(buffer, "### ", 4))
508 break;
509 if ((!buffer[0])) {
510 if (ent->name) {
511 vfs_s_insert_entry(me, dir, ent);
512 ent = vfs_s_generate_entry(me, NULL, dir, 0);
514 continue;
517 #define ST ent->ino->st
519 switch(buffer[0]) {
520 case ':': {
521 char *temp;
522 char *data_start = buffer+1;
523 char *filename = data_start;
524 char *linkname = data_start;
525 char *filename_bound = filename + strlen(filename);
526 char *linkname_bound = filename_bound;
527 if (!strcmp(data_start, "\".\"") || !strcmp(data_start, "\"..\""))
528 break; /* We'll do "." and ".." ourselves */
530 if (S_ISLNK(ST.st_mode)) {
531 /* we expect: "escaped-name" -> "escaped-name"
532 // -> cannot occur in filenames,
533 // because it will be escaped to -\> */
535 if (*filename == '"')
536 ++filename;
538 linkname = strstr(filename, "\" -> \"");
539 if (!linkname)
541 /* broken client, or smth goes wrong */
542 linkname = filename_bound;
543 if (filename_bound > filename
544 && *(filename_bound - 1) == '"')
545 --filename_bound; /* skip trailing " */
547 else
549 filename_bound = linkname;
550 linkname += 6; /* strlen ("\" -> \"") */
551 if (*(linkname_bound - 1) == '"')
552 --linkname_bound; /* skip trailing " */
555 ent->name = str_dup_range(filename, filename_bound);
556 temp = ent->name;
557 ent->name = strutils_shell_unescape(ent->name);
558 g_free(temp);
560 ent->ino->linkname = str_dup_range(linkname, linkname_bound);
561 temp = ent->ino->linkname;
562 ent->ino->linkname = strutils_shell_unescape(ent->ino->linkname);
563 g_free(temp);
564 } else {
565 /* we expect: "escaped-name" */
566 if (filename_bound - filename > 2)
569 there is at least 2 "
570 and we skip them
572 if (*filename == '"')
573 ++filename;
574 if (*(filename_bound - 1) == '"')
575 --filename_bound;
577 ent->name = str_dup_range(filename, filename_bound);
578 temp = ent->name;
579 ent->name = strutils_shell_unescape(ent->name);
580 g_free(temp);
582 break;
584 case 'S':
585 #ifdef HAVE_ATOLL
586 ST.st_size = (off_t) atoll (buffer+1);
587 #else
588 ST.st_size = (off_t) atof (buffer+1);
589 #endif
590 break;
591 case 'P': {
592 size_t skipped;
593 vfs_parse_filemode (buffer + 1, &skipped, &ST.st_mode);
594 break;
596 case 'R': {
598 raw filemode:
599 we expect: Roctal-filemode octal-filetype uid.gid
601 size_t skipped;
602 vfs_parse_raw_filemode (buffer + 1, &skipped, &ST.st_mode);
603 break;
605 case 'd': {
606 vfs_split_text(buffer+1);
607 if (!vfs_parse_filedate(0, &ST.st_ctime))
608 break;
609 ST.st_atime = ST.st_mtime = ST.st_ctime;
611 break;
612 case 'D': {
613 struct tm tim;
614 if (sscanf(buffer+1, "%d %d %d %d %d %d", &tim.tm_year, &tim.tm_mon,
615 &tim.tm_mday, &tim.tm_hour, &tim.tm_min, &tim.tm_sec) != 6)
616 break;
617 ST.st_atime = ST.st_mtime = ST.st_ctime = mktime(&tim);
619 break;
620 case 'E': {
621 int maj, min;
622 if (sscanf(buffer+1, "%d,%d", &maj, &min) != 2)
623 break;
624 #ifdef HAVE_STRUCT_STAT_ST_RDEV
625 ST.st_rdev = makedev (maj, min);
626 #endif
631 vfs_s_free_entry (me, ent);
632 reply_code = fish_decode_reply(buffer + 4, 0);
633 if (reply_code == COMPLETE) {
634 g_free (SUP.cwdir);
635 SUP.cwdir = g_strdup (remote_path);
636 print_vfs_message (_("%s: done."), me->name);
637 return 0;
638 } else if (reply_code == ERROR) {
639 me->verrno = EACCES;
640 } else {
641 me->verrno = E_REMOTE;
644 error:
645 print_vfs_message (_("%s: failure"), me->name);
646 return -1;
649 static int
650 fish_file_store(struct vfs_class *me, struct vfs_s_fh *fh, char *name, char *localname)
652 struct vfs_s_super *super = FH_SUPER;
653 int n, total;
654 char buffer[8192];
655 struct stat s;
656 int was_error = 0;
657 int h;
658 char *quoted_name;
660 h = open (localname, O_RDONLY);
662 if (h == -1)
663 ERRNOR (EIO, -1);
664 if (fstat(h, &s)<0) {
665 close (h);
666 ERRNOR (EIO, -1);
669 /* First, try this as stor:
671 * ( head -c number ) | ( cat > file; cat >/dev/null )
673 * If `head' is not present on the remote system, `dd' will be used.
674 * Unfortunately, we cannot trust most non-GNU `head' implementations
675 * even if `-c' options is supported. Therefore, we separate GNU head
676 * (and other modern heads?) using `-q' and `-' . This causes another
677 * implementations to fail (because of "incorrect options").
679 * Fallback is:
681 * rest=<number>
682 * while [ $rest -gt 0 ]
683 * do
684 * cnt=`expr \( $rest + 255 \) / 256`
685 * n=`dd bs=256 count=$cnt | tee -a <target_file> | wc -c`
686 * rest=`expr $rest - $n`
687 * done
689 * `dd' was not designed for full filling of input buffers,
690 * and does not report exact number of bytes (not blocks).
691 * Therefore a more complex shell script is needed.
693 * On some systems non-GNU head writes "Usage:" error report to stdout
694 * instead of stderr. It makes impossible the use of "head || dd"
695 * algorithm for file appending case, therefore just "dd" is used for it.
698 quoted_name = strutils_shell_escape(name);
699 print_vfs_message(_("fish: store %s: sending command..."), quoted_name );
701 /* FIXME: File size is limited to ULONG_MAX */
702 if (!fh->u.fish.append)
703 n = fish_command (me, super, WAIT_REPLY,
704 "#STOR %lu /%s\n"
705 "echo '### 001'\n"
706 "file=/%s\n"
707 "res=`exec 3>&1\n"
708 "(\n"
709 "head -c %lu -q - || echo DD >&3\n"
710 ") 2>/dev/null | (\n"
711 "cat > $file\n"
712 "cat > /dev/null\n"
713 ")`; [ \"$res\" = DD ] && {\n"
714 "> \"$file\"\n"
715 "rest=%lu\n"
716 "while [ $rest -gt 0 ]\n"
717 "do\n"
718 " cnt=`expr \\( $rest + 255 \\) / 256`\n"
719 " n=`dd bs=256 count=$cnt | tee -a \"$file\" | wc -c`\n"
720 " rest=`expr $rest - $n`\n"
721 "done\n"
722 "}; echo '### 200'\n",
723 (unsigned long) s.st_size, quoted_name,
724 quoted_name, (unsigned long) s.st_size,
725 (unsigned long) s.st_size);
726 else
727 n = fish_command (me, super, WAIT_REPLY,
728 "#STOR %lu /%s\n"
729 "echo '### 001'\n"
730 "{\n"
731 "file=/%s\n"
732 "rest=%lu\n"
733 "while [ $rest -gt 0 ]\n"
734 "do\n"
735 " cnt=`expr \\( $rest + 255 \\) / 256`\n"
736 " n=`dd bs=256 count=$cnt | tee -a $file | wc -c`\n"
737 " rest=`expr $rest - $n`\n"
738 "done\n"
739 "}; echo '### 200'\n",
740 (unsigned long) s.st_size, quoted_name,
741 quoted_name, (unsigned long) s.st_size);
743 if (n != PRELIM) {
744 close (h);
745 ERRNOR(E_REMOTE, -1);
747 total = 0;
749 while (1) {
750 int t;
751 while ((n = read(h, buffer, sizeof(buffer))) < 0) {
752 if ((errno == EINTR) && tty_got_interrupt ())
753 continue;
754 print_vfs_message(_("fish: Local read failed, sending zeros") );
755 close(h);
756 h = open( "/dev/zero", O_RDONLY );
758 if (n == 0)
759 break;
760 if ((t = write (SUP.sockw, buffer, n)) != n) {
761 if (t == -1) {
762 me->verrno = errno;
763 } else {
764 me->verrno = EIO;
766 goto error_return;
768 tty_disable_interrupt_key ();
769 total += n;
770 print_vfs_message(_("fish: storing %s %d (%lu)"),
771 was_error ? _("zeros") : _("file"), total,
772 (unsigned long) s.st_size);
774 close(h);
775 g_free(quoted_name);
776 if ((fish_get_reply (me, SUP.sockr, NULL, 0) != COMPLETE) || was_error)
777 ERRNOR (E_REMOTE, -1);
778 return 0;
779 error_return:
780 close(h);
781 fish_get_reply(me, SUP.sockr, NULL, 0);
782 g_free(quoted_name);
783 return -1;
786 static int
787 fish_linear_start (struct vfs_class *me, struct vfs_s_fh *fh, off_t offset)
789 char *name;
790 char *quoted_name;
791 if (offset)
792 ERRNOR (E_NOTSUPP, 0);
793 name = vfs_s_fullpath (me, fh->ino);
794 if (!name)
795 return 0;
796 quoted_name = strutils_shell_escape(name);
797 fh->u.fish.append = 0;
800 * Check whether the remote file is readable by using `dd' to copy
801 * a single byte from the remote file to /dev/null. If `dd' completes
802 * with exit status of 0 use `cat' to send the file contents to the
803 * standard output (i.e. over the network).
805 offset = fish_command (me, FH_SUPER, WANT_STRING,
806 "#RETR /%s\n"
807 "if dd if=/%s of=/dev/null bs=1 count=1 2>/dev/null ;\n"
808 "then\n"
809 "ls -ln /%s 2>/dev/null | (\n"
810 "read p l u g s r\n"
811 "echo $s\n"
812 ")\n"
813 "echo '### 100'\n"
814 "cat /%s\n"
815 "echo '### 200'\n"
816 "else\n"
817 "echo '### 500'\n"
818 "fi\n",
819 quoted_name, quoted_name, quoted_name, quoted_name );
820 g_free (quoted_name);
821 if (offset != PRELIM) ERRNOR (E_REMOTE, 0);
822 fh->linear = LS_LINEAR_OPEN;
823 fh->u.fish.got = 0;
824 errno = 0;
825 #if SIZEOF_OFF_T == SIZEOF_LONG
826 fh->u.fish.total = strtol (reply_str, NULL, 10);
827 #else
828 fh->u.fish.total = strtoll (reply_str, NULL, 10);
829 #endif
830 if (errno != 0)
831 ERRNOR (E_REMOTE, 0);
832 return 1;
835 static void
836 fish_linear_abort (struct vfs_class *me, struct vfs_s_fh *fh)
838 struct vfs_s_super *super = FH_SUPER;
839 char buffer[8192];
840 int n;
842 print_vfs_message( _("Aborting transfer...") );
843 do {
844 n = MIN(8192, fh->u.fish.total - fh->u.fish.got);
845 if (n) {
846 if ((n = read(SUP.sockr, buffer, n)) < 0)
847 return;
848 fh->u.fish.got += n;
850 } while (n);
852 if (fish_get_reply (me, SUP.sockr, NULL, 0) != COMPLETE)
853 print_vfs_message( _("Error reported after abort.") );
854 else
855 print_vfs_message( _("Aborted transfer would be successful.") );
858 static int
859 fish_linear_read (struct vfs_class *me, struct vfs_s_fh *fh, void *buf, int len)
861 struct vfs_s_super *super = FH_SUPER;
862 int n = 0;
863 len = MIN( fh->u.fish.total - fh->u.fish.got, len );
864 tty_disable_interrupt_key ();
865 while (len && ((n = read (SUP.sockr, buf, len))<0)) {
866 if ((errno == EINTR) && !tty_got_interrupt ())
867 continue;
868 break;
870 tty_enable_interrupt_key();
872 if (n>0) fh->u.fish.got += n;
873 if (n<0) fish_linear_abort(me, fh);
874 if ((!n) && ((fish_get_reply (me, SUP.sockr, NULL, 0) != COMPLETE)))
875 ERRNOR (E_REMOTE, -1);
876 ERRNOR (errno, n);
879 static void
880 fish_linear_close (struct vfs_class *me, struct vfs_s_fh *fh)
882 if (fh->u.fish.total != fh->u.fish.got)
883 fish_linear_abort(me, fh);
886 static int
887 fish_ctl (void *fh, int ctlop, void *arg)
889 (void) arg;
890 (void) fh;
891 (void) ctlop;
892 return 0;
893 #if 0
894 switch (ctlop) {
895 case VFS_CTL_IS_NOTREADY:
897 int v;
899 if (!FH->linear)
900 vfs_die ("You may not do this");
901 if (FH->linear == LS_LINEAR_CLOSED || FH->linear == LS_LINEAR_PREOPEN)
902 return 0;
904 v = vfs_s_select_on_two (FH_SUPER->u.fish.sockr, 0);
905 if (((v < 0) && (errno == EINTR)) || v == 0)
906 return 1;
907 return 0;
909 default:
910 return 0;
912 #endif
915 static int
916 fish_send_command(struct vfs_class *me, struct vfs_s_super *super, const char *cmd, int flags)
918 int r;
920 r = fish_command (me, super, WAIT_REPLY, "%s", cmd);
921 vfs_stamp_create (&vfs_fish_ops, super);
922 if (r != COMPLETE) ERRNOR (E_REMOTE, -1);
923 if (flags & OPT_FLUSH)
924 vfs_s_invalidate(me, super);
925 return 0;
928 #define PREFIX \
929 char buf[BUF_LARGE]; \
930 const char *crpath; \
931 char *rpath, *mpath = g_strdup (path); \
932 struct vfs_s_super *super; \
933 if (!(crpath = vfs_s_get_path_mangle (me, mpath, &super, 0))) { \
934 g_free (mpath); \
935 return -1; \
937 rpath = strutils_shell_escape(crpath); \
938 g_free (mpath);
940 #define POSTFIX(flags) \
941 g_free (rpath); \
942 return fish_send_command(me, super, buf, flags);
944 static int
945 fish_chmod (struct vfs_class *me, const char *path, int mode)
947 PREFIX
948 g_snprintf(buf, sizeof(buf), "#CHMOD %4.4o /%s\n"
949 "if chmod %4.4o /%s 2>/dev/null; then\n"
950 "echo '### 000'\n"
951 "else\n"
952 "echo '### 500'\n"
953 "fi\n",
954 mode & 07777, rpath,
955 mode & 07777, rpath);
956 POSTFIX(OPT_FLUSH);
959 #define FISH_OP(name, string) \
960 static int fish_##name (struct vfs_class *me, const char *path1, const char *path2) \
962 char buf[BUF_LARGE]; \
963 const char *crpath1, *crpath2; \
964 char *rpath1, *rpath2, *mpath1, *mpath2; \
965 struct vfs_s_super *super1, *super2; \
966 if (!(crpath1 = vfs_s_get_path_mangle (me, mpath1 = g_strdup(path1), &super1, 0))) { \
967 g_free (mpath1); \
968 return -1; \
970 if (!(crpath2 = vfs_s_get_path_mangle (me, mpath2 = g_strdup(path2), &super2, 0))) { \
971 g_free (mpath1); \
972 g_free (mpath2); \
973 return -1; \
975 rpath1 = strutils_shell_escape (crpath1); \
976 g_free (mpath1); \
977 rpath2 = strutils_shell_escape (crpath2); \
978 g_free (mpath2); \
979 g_snprintf(buf, sizeof(buf), string "\n", rpath1, rpath2, rpath1, rpath2); \
980 g_free (rpath1); \
981 g_free (rpath2); \
982 return fish_send_command(me, super2, buf, OPT_FLUSH); \
985 FISH_OP(rename, "#RENAME /%s /%s\n"
986 "if mv /%s /%s 2>/dev/null; then\n"
987 "echo '### 000'\n"
988 "else\n"
989 "echo '### 500'\n"
990 "fi\n")
991 FISH_OP(link, "#LINK /%s /%s\n"
992 "if ln /%s /%s 2>/dev/null; then\n"
993 "echo '### 000'\n"
994 "else\n"
995 "echo '### 500'\n"
996 "fi\n")
998 static int fish_symlink (struct vfs_class *me, const char *setto, const char *path)
1000 char *qsetto;
1001 PREFIX
1002 qsetto = strutils_shell_escape (setto);
1003 g_snprintf(buf, sizeof(buf),
1004 "#SYMLINK %s /%s\n"
1005 "if ln -s %s /%s 2>/dev/null; then\n"
1006 "echo '### 000'\n"
1007 "else\n"
1008 "echo '### 500'\n"
1009 "fi\n",
1010 qsetto, rpath, qsetto, rpath);
1011 g_free (qsetto);
1012 POSTFIX(OPT_FLUSH);
1015 static int
1016 fish_chown (struct vfs_class *me, const char *path, int owner, int group)
1018 char *sowner, *sgroup;
1019 struct passwd *pw;
1020 struct group *gr;
1022 if ((pw = getpwuid (owner)) == NULL)
1023 return 0;
1025 if ((gr = getgrgid (group)) == NULL)
1026 return 0;
1028 sowner = pw->pw_name;
1029 sgroup = gr->gr_name;
1031 PREFIX
1032 g_snprintf (buf, sizeof(buf),
1033 "#CHOWN %s:%s /%s\n"
1034 "if chown %s:%s /%s 2>/dev/null; then\n"
1035 "echo '### 000'\n"
1036 "else\n"
1037 "echo '### 500'\n"
1038 "fi\n",
1039 sowner, sgroup, rpath,
1040 sowner, sgroup, rpath);
1041 fish_send_command (me, super, buf, OPT_FLUSH);
1042 /* FIXME: what should we report if chgrp succeeds but chown fails? */
1043 /* fish_send_command(me, super, buf, OPT_FLUSH); */
1044 POSTFIX (OPT_FLUSH)
1048 static int fish_unlink (struct vfs_class *me, const char *path)
1050 PREFIX
1051 g_snprintf(buf, sizeof(buf),
1052 "#DELE /%s\n"
1053 "if rm -f /%s 2>/dev/null; then\n"
1054 "echo '### 000'\n"
1055 "else\n"
1056 "echo '### 500'\n"
1057 "fi\n",
1058 rpath, rpath);
1059 POSTFIX(OPT_FLUSH);
1062 static int fish_exists (struct vfs_class *me, const char *path)
1064 PREFIX
1066 g_snprintf(buf, sizeof(buf),
1067 "#ISEXISTS /%s\n"
1068 "ls -l /%s >/dev/null 2>/dev/null\n"
1069 "echo '### '$?\n",
1070 rpath, rpath);
1072 g_free (rpath);
1074 if ( fish_send_command(me, super, buf, OPT_FLUSH) == 0 )
1075 return 1;
1077 return 0;
1081 static int fish_mkdir (struct vfs_class *me, const char *path, mode_t mode)
1083 int ret_code;
1085 PREFIX
1087 (void) mode;
1089 g_snprintf(buf, sizeof(buf),
1090 "#MKD /%s\n"
1091 "if mkdir /%s 2>/dev/null; then\n"
1092 "echo '### 000'\n"
1093 "else\n"
1094 "echo '### 500'\n"
1095 "fi\n",
1096 rpath, rpath);
1098 g_free (rpath);
1099 ret_code = fish_send_command(me, super, buf, OPT_FLUSH);
1101 if ( ret_code != 0 )
1102 return ret_code;
1104 if ( ! fish_exists (me, path) ){
1105 ERRNOR (EACCES, -1);
1107 return 0;
1110 static int fish_rmdir (struct vfs_class *me, const char *path)
1112 PREFIX
1113 g_snprintf(buf, sizeof(buf),
1114 "#RMD /%s\n"
1115 "if rmdir /%s 2>/dev/null; then\n"
1116 "echo '### 000'\n"
1117 "else\n"
1118 "echo '### 500'\n"
1119 "fi\n",
1120 rpath, rpath);
1121 POSTFIX(OPT_FLUSH);
1124 static int
1125 fish_fh_open (struct vfs_class *me, struct vfs_s_fh *fh, int flags,
1126 int mode)
1128 (void) mode;
1130 fh->u.fish.append = 0;
1131 /* File will be written only, so no need to retrieve it */
1132 if (((flags & O_WRONLY) == O_WRONLY) && !(flags & (O_RDONLY | O_RDWR))) {
1133 fh->u.fish.append = flags & O_APPEND;
1134 if (!fh->ino->localname) {
1135 int tmp_handle =
1136 vfs_mkstemps (&fh->ino->localname, me->name,
1137 fh->ino->ent->name);
1138 if (tmp_handle == -1)
1139 return -1;
1140 close (tmp_handle);
1142 return 0;
1144 if (!fh->ino->localname)
1145 if (vfs_s_retrieve_file (me, fh->ino) == -1)
1146 return -1;
1147 if (!fh->ino->localname)
1148 vfs_die ("retrieve_file failed to fill in localname");
1149 return 0;
1152 static void
1153 fish_fill_names (struct vfs_class *me, fill_names_f func)
1155 struct vfs_s_super *super = MEDATA->supers;
1156 char *name;
1158 char gbuf[10];
1160 while (super)
1162 const char *flags = "";
1163 switch (SUP.flags)
1165 case FISH_FLAG_RSH:
1166 flags = ":r";
1167 break;
1168 case FISH_FLAG_COMPRESSED:
1169 flags = ":C";
1170 break;
1171 default:
1172 if (SUP.flags > FISH_FLAG_RSH)
1174 break;
1175 g_snprintf (gbuf, sizeof (gbuf), ":%d", SUP.flags);
1176 flags = gbuf;
1178 break;
1181 name = g_strconcat ("/#sh:", SUP.user, "@", SUP.host, flags,
1182 "/", SUP.cwdir, (char *) NULL);
1183 (*func)(name);
1184 g_free (name);
1185 super = super->next;
1189 static void *
1190 fish_open (struct vfs_class *me, const char *file, int flags, int mode)
1193 sorry, i've places hack here
1194 cause fish don't able to open files with O_EXCL flag
1196 flags &= ~O_EXCL;
1197 return vfs_s_open (me, file, flags, mode);
1201 void
1202 init_fish (void)
1204 static struct vfs_s_subclass fish_subclass;
1206 fish_subclass.flags = VFS_S_REMOTE;
1207 fish_subclass.archive_same = fish_archive_same;
1208 fish_subclass.open_archive = fish_open_archive;
1209 fish_subclass.free_archive = fish_free_archive;
1210 fish_subclass.fh_open = fish_fh_open;
1211 fish_subclass.dir_load = fish_dir_load;
1212 fish_subclass.file_store = fish_file_store;
1213 fish_subclass.linear_start = fish_linear_start;
1214 fish_subclass.linear_read = fish_linear_read;
1215 fish_subclass.linear_close = fish_linear_close;
1217 vfs_s_init_class (&vfs_fish_ops, &fish_subclass);
1218 vfs_fish_ops.name = "fish";
1219 vfs_fish_ops.prefix = "sh:";
1220 vfs_fish_ops.fill_names = fish_fill_names;
1221 vfs_fish_ops.chmod = fish_chmod;
1222 vfs_fish_ops.chown = fish_chown;
1223 vfs_fish_ops.open = fish_open;
1224 vfs_fish_ops.symlink = fish_symlink;
1225 vfs_fish_ops.link = fish_link;
1226 vfs_fish_ops.unlink = fish_unlink;
1227 vfs_fish_ops.rename = fish_rename;
1228 vfs_fish_ops.mkdir = fish_mkdir;
1229 vfs_fish_ops.rmdir = fish_rmdir;
1230 vfs_fish_ops.ctl = fish_ctl;
1231 vfs_register_class (&vfs_fish_ops);