| blob | 56424f794764a6b52dce067dbc2e6de8e629a427 |
1 ;;; tramp-sh.el --- Tramp access functions for (s)sh-like connections
3 ;; Copyright (C) 1998-2011 Free Software Foundation, Inc.
5 ;; (copyright statements below in code to be updated with the above notice)
7 ;; Author: Kai Großjohann <kai.grossjohann@gmx.net>
8 ;; Michael Albinus <michael.albinus@gmx.de>
9 ;; Keywords: comm, processes
10 ;; Package: tramp
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;;; Code:
32 ;; Pacify byte-compiler. The function is needed on XEmacs only. I'm
33 ;; not sure at all that this is the right way to do it, but let's hope
34 ;; it works for now, and wait for a guru to point out the Right Way to
35 ;; achieve this.
36 ;;(eval-when-compile
37 ;; (unless (fboundp 'dired-insert-set-properties)
38 ;; (fset 'dired-insert-set-properties 'ignore)))
39 ;; Gerd suggests this:
41 ;; Note that dired is required at run-time, too, when it is needed.
42 ;; It is only needed on XEmacs for the function
43 ;; `dired-insert-set-properties'.
46 "*The minimum size of compressing where inline transfer.
47 When inline transfer, compress transfered data of file
48 whose size is this value or above (up to `tramp-copy-size-limit').
49 If it is nil, no compression at all will be applied."
54 "*The maximum file size where inline copying is preferred over an out-of-the-band copy.
55 If it is nil, inline out-of-the-band copy will be used without a check."
59 ;;;###tramp-autoload
61 "*Value of TERM environment variable for logging in to remote host.
62 Because Tramp wants to parse the output of the remote shell, it is easily
63 confused by ANSI color escape sequences and suchlike. Often, shell init
64 files conditionalize this setup based on the TERM environment variable."
71 ;; ksh on OpenBSD 4.5 requires that $PS1 contains a `#' character for
72 ;; root users. It uses the `$' character for other users. In order
73 ;; to guarantee a proper prompt, we use "#$ " for the prompt.
77 "///%s#$"
79 "String used to recognize end of output.
80 The '$' character at the end is quoted; the string cannot be
83 ;;;###tramp-autoload
87 ;; Initialize `tramp-methods' with the supported methods.
88 ;;;###tramp-autoload
99 ;;;###tramp-autoload
109 ;;;###tramp-autoload
125 ;;;###tramp-autoload
142 ;;;###tramp-autoload
159 ;;;###tramp-autoload
180 ;;;###tramp-autoload
198 ;;;###tramp-autoload
207 ;;;###tramp-autoload
220 ;;;###tramp-autoload
235 "ssh"
236 " -o ControlPath=%t.%%r@%%h:%%p"
241 ;;;###tramp-autoload
248 ;;;###tramp-autoload
255 ;;;###tramp-autoload
267 ;;;###tramp-autoload
280 ;;;###tramp-autoload
293 ;;;###tramp-autoload
307 ;;;###tramp-autoload
315 ;;;###tramp-autoload
322 ;;;###tramp-autoload
329 ;;;###tramp-autoload
336 ;;;###tramp-autoload
343 ;;;###tramp-autoload
352 ;;;###tramp-autoload
361 ;;;###tramp-autoload
365 ;; ("%h") must be a single element, see
366 ;; `tramp-compute-multi-hops'.
369 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
370 tramp-terminal-type
371 tramp-initial-end-of-output))
375 ;;;###tramp-autoload
389 ;;;###tramp-autoload
402 ;;;###tramp-autoload
413 ;;;###tramp-autoload
417 ;;;###tramp-autoload
421 ;; Do not add "ssh" based methods, otherwise ~/.ssh/config would be ignored.
422 ;;;###tramp-autoload
432 ;;;###tramp-autoload
438 ;;;###tramp-autoload
454 ;;;###tramp-autoload
459 ;;;###tramp-autoload
464 ;;;###tramp-autoload
470 ;;;###tramp-autoload
509 ;; "getconf PATH" yields:
510 ;; HP-UX: /usr/bin:/usr/ccs/bin:/opt/ansic/bin:/opt/langtools/bin:/opt/fortran/bin
511 ;; Solaris: /usr/xpg4/bin:/usr/ccs/bin:/usr/bin:/opt/SUNWspro/bin
512 ;; GNU/Linux (Debian, Suse): /bin:/usr/bin
513 ;; FreeBSD: /usr/bin:/bin:/usr/sbin:/sbin: - beware trailing ":"!
514 ;; IRIX64: /usr/bin
519 "*List of directories to search for executables on remote host.
520 For every remote host, this variable will be set buffer local,
521 keeping the list of existing directories on that host.
523 You can use `~' in this list, but when searching for a shell which groks
524 tilde expansion, all directory names starting with `~' will be ignored.
526 `Default Directories' represent the list of directories given by
528 entry on top of this list, because these are the default
529 directories for POSIX compatible commands. On remote hosts which
530 do not offer the getconf command (like cygwin), the value
533 `Private Directories' are the settings of the $PATH environment,
534 as given in your `~/.profile'."
549 "*List of environment variables to be set on the remote host.
551 Each element should be a string of the form ENVVARNAME=VALUE. An
552 entry ENVVARNAME= diables the corresponding environment variable,
553 which might have been set in the init files like ~/.profile.
555 Special handling is applied to the PATH environment, which should
556 not be set here. Instead, it should be set via `tramp-remote-path'."
561 "*Alist specifying extra arguments to pass to the remote shell.
562 Entries are (REGEXP . ARGS) where REGEXP is a regular expression
563 matching the shell file name and ARGS is a string specifying the
564 arguments.
566 This variable is only used when Tramp needs to start up another shell
567 for tilde expansion. The extra arguments should typically prevent the
568 shell from reading its init file."
570 ;; This might be the wrong way to test whether the widget type
571 ;; `alist' is available. Who knows the right way to test it?
586 "List of pattern/action pairs.
587 Whenever a pattern matches, the corresponding action is performed.
588 Each item looks like (PATTERN ACTION).
590 The PATTERN should be a symbol, a variable. The value of this
591 variable gives the regular expression to search for. Note that the
593 appended to it.
595 The ACTION should also be a symbol, but a function. When the
603 "List of pattern/action pairs.
604 This list is used for copying/renaming with out-of-band methods.
609 "(echo begin 600 /tmp/tramp.$$; tail +2) | uudecode
610 cat /tmp/tramp.$$
611 rm -f /tmp/tramp.$$"
612 "Shell function to implement `uudecode' to standard output.
613 Many systems support `uudecode -o /dev/stdout' or `uudecode -o -'
614 for this or `uudecode -p', but some systems don't, and for them
618 "%s -e '
619 use File::Spec;
622 sub recursive {
623 my ($volume, @dirs) = @_;
624 my $real = realpath(File::Spec->catpath(
626 if ($real) {
627 my ($vol, $dir) = File::Spec->splitpath($real, 1);
628 return ($vol, File::Spec->splitdir($dir));
629 }
630 else {
631 my $last = pop(@dirs);
632 ($volume, @dirs) = recursive($volume, @dirs);
633 push(@dirs, $last);
634 return ($volume, @dirs);
635 }
636 }
638 $result = realpath($ARGV[0]);
639 if (!$result) {
640 my ($vol, $dir) = File::Spec->splitpath($ARGV[0], 1);
641 ($vol, @dirs) = recursive($vol, File::Spec->splitdir($dir));
644 }
648 }
652 "Perl script to produce output suitable for use with `file-truename'
653 on the remote file system.
654 Escape sequence %s is replaced with name of Perl binary.
658 "%s -e 'sub case {
659 my $str = shift;
660 if ($ARGV[2]) {
661 return lc($str);
662 }
663 else {
664 return $str;
665 }
666 }
668 @files = readdir(d); closedir(d);
669 foreach $f (@files) {
670 if (case(substr($f, 0, length($ARGV[1]))) eq case($ARGV[1])) {
673 }
674 else {
676 }
677 }
678 }
681 "Perl script to produce output suitable for use with
682 `file-name-all-completions' on the remote file system. Escape
683 sequence %s is replaced with name of Perl binary. This string is
686 ;; Perl script to implement `file-attributes' in a Lisp `read'able
687 ;; output. If you are hacking on this, note that you get *no* output
688 ;; unless this spits out a complete line, including the '\n' at the
689 ;; end.
690 ;; The device number is returned as "-1", because there will be a virtual
691 ;; device number set in `tramp-sh-handle-file-attributes'.
693 "%s -e '
694 @stat = lstat($ARGV[0]);
695 if (!@stat) {
697 exit 0;
698 }
699 if (($stat[2] & 0170000) == 0120000)
700 {
701 $type = readlink($ARGV[0]);
703 }
704 elsif (($stat[2] & 0170000) == 040000)
705 {
707 }
708 else
709 {
711 };
714 printf(
716 $type,
717 $stat[3],
718 $uid,
719 $gid,
720 $stat[8] >> 16 & 0xffff,
721 $stat[8] & 0xffff,
722 $stat[9] >> 16 & 0xffff,
723 $stat[9] & 0xffff,
724 $stat[10] >> 16 & 0xffff,
725 $stat[10] & 0xffff,
726 $stat[7],
727 $stat[2],
728 $stat[1] >> 16 & 0xffff,
729 $stat[1] & 0xffff
731 "Perl script to produce output suitable for use with `file-attributes'
732 on the remote file system.
733 Escape sequence %s is replaced with name of Perl binary.
737 "%s -e '
740 @list = readdir(DIR);
741 closedir(DIR);
742 $n = scalar(@list);
744 for($i = 0; $i < $n; $i++)
745 {
746 $filename = $list[$i];
747 @stat = lstat($filename);
748 if (($stat[2] & 0170000) == 0120000)
749 {
750 $type = readlink($filename);
752 }
753 elsif (($stat[2] & 0170000) == 040000)
754 {
756 }
757 else
758 {
760 };
763 printf(
764 \"(\\\"%%s\\\" %%s %%u %%s %%s (%%u %%u) (%%u %%u) (%%u %%u) %%u.0 %%u t (%%u . %%u) (%%u . %%u))\\n\",
765 $filename,
766 $type,
767 $stat[3],
768 $uid,
769 $gid,
770 $stat[8] >> 16 & 0xffff,
771 $stat[8] & 0xffff,
772 $stat[9] >> 16 & 0xffff,
773 $stat[9] & 0xffff,
774 $stat[10] >> 16 & 0xffff,
775 $stat[10] & 0xffff,
776 $stat[7],
777 $stat[2],
778 $stat[1] >> 16 & 0xffff,
779 $stat[1] & 0xffff,
780 $stat[0] >> 16 & 0xffff,
781 $stat[0] & 0xffff);
782 }
784 "Perl script implementing `directory-files-attributes' as Lisp `read'able
785 output.
786 Escape sequence %s is replaced with name of Perl binary.
789 ;; These two use base64 encoding.
791 "%s -MMIME::Base64 -0777 -ne 'print encode_base64($_)' 2>/dev/null"
792 "Perl program to use for encoding a file.
793 Escape sequence %s is replaced with name of Perl binary.
794 This string is passed to `format', so percent characters need to be doubled.
795 This implementation requires the MIME::Base64 Perl module to be installed
799 "%s -MMIME::Base64 -0777 -ne 'print decode_base64($_)' 2>/dev/null"
800 "Perl program to use for decoding a file.
801 Escape sequence %s is replaced with name of Perl binary.
802 This string is passed to `format', so percent characters need to be doubled.
803 This implementation requires the MIME::Base64 Perl module to be installed
807 "%s -e '
808 # This script contributed by Juanma Barranquero <lektu@terra.es>.
809 # Copyright (C) 2002-2011 Free Software Foundation, Inc.
810 use strict;
812 my %%trans = do {
813 my $i = 0;
814 map {(substr(unpack(q(B8), chr $i++), 2, 6), $_)}
815 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/);
816 };
820 # We read in chunks of 54 bytes, to generate output lines
821 # of 72 chars (plus end of line)
824 while (my $data = <STDIN>) {
825 my $pad = q();
827 # Only for the last chunk, and only if did not fill the last three-byte packet
828 if (eof) {
829 my $mod = length($data) %% 3;
830 $pad = q(=) x (3 - $mod) if $mod;
831 }
833 # Not the fastest method, but it is simple: unpack to binary string, split
834 # by groups of 6 bits and convert back from binary to byte; then map into
835 # the translation table
836 print
837 join q(),
838 map($trans{$_},
839 (substr(unpack(q(B*), $data) . q(00000), 0, 432) =~ /....../g)),
840 $pad,
842 }' 2>/dev/null"
843 "Perl program to use for encoding a file.
844 Escape sequence %s is replaced with name of Perl binary.
848 "%s -e '
849 # This script contributed by Juanma Barranquero <lektu@terra.es>.
850 # Copyright (C) 2002-2011 Free Software Foundation, Inc.
851 use strict;
853 my %%trans = do {
854 my $i = 0;
855 map {($_, substr(unpack(q(B8), chr $i++), 2, 6))}
856 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/)
857 };
859 my %%bytes = map {(unpack(q(B8), chr $_), chr $_)} 0 .. 255;
863 # We are going to accumulate into $pending to accept any line length
864 # (we do not check they are <= 76 chars as the RFC says)
865 my $pending = q();
867 while (my $data = <STDIN>) {
868 chomp $data;
870 # If we find one or two =, we have reached the end and
871 # any following data is to be discarded
872 my $finished = $data =~ s/(==?).*/$1/;
873 $pending .= $data;
875 my $len = length($pending);
876 my $chunk = substr($pending, 0, $len & ~3);
877 $pending = substr($pending, $len & ~3 + 1);
879 # Easy method: translate from chars to (pregenerated) six-bit packets, join,
880 # split in 8-bit chunks and convert back to char.
881 print join q(),
882 map $bytes{$_},
883 ((join q(), map {$trans{$_} || q()} split //, $chunk) =~ /......../g);
885 last if $finished;
886 }' 2>/dev/null"
887 "Perl program to use for decoding a file.
888 Escape sequence %s is replaced with name of Perl binary.
893 while read file; do
896 else
898 fi
901 else
903 fi
904 done
906 "Script to check existence of VC related files.
907 It must be send formatted with two strings; the tests for file
908 existence, and file readability. Input shall be read via
909 here-document, otherwise the command could exceed maximum length
928 "A list of file types returned from the `stat' system call.
931 ;; New handlers should be added here. The following operations can be
932 ;; handled using the normal primitives: file-name-sans-versions,
933 ;; get-file-buffer.
954 . tramp-sh-handle-directory-files-and-attributes)
967 ;; `executable-find' is not official yet.
979 . tramp-sh-handle-insert-file-contents-literally)
986 . tramp-sh-handle-dired-recursive-delete-directory)
993 "Alist of handler functions.
996 ;; This must be the last entry, because `identity' always matches.
997 ;;;###tramp-autoload
1001 ;;; File Name Handler Functions:
1005 "Like `make-symbolic-link' for Tramp files.
1006 If LINKNAME is a non-Tramp file, it is used verbatim as the target of
1007 the symlink. If LINKNAME is a Tramp file, only the localname component is
1008 used as the target of the symlink.
1010 If LINKNAME is a Tramp file and the localname component is relative, then
1011 it is expanded first, before the localname component is taken. Note that
1012 this can give surprising results if the user/host for the source and
1013 target of the symlink differ."
1020 l 'file-error
1023 ;; Do the 'confirm if exists' thing.
1025 ;; What to do?
1030 "File %s already exists; make it a link anyway? "
1031 l-localname)))))
1036 ;; If FILENAME is a Tramp name, use just the localname component.
1045 ;; Right, they are on the same host, regardless of user, method, etc.
1046 ;; We now make the link on the remote machine. This will occur as the user
1047 ;; that FILENAME belongs to.
1049 l
1051 "cd %s && %s -sf %s %s"
1053 ln
1056 t))))
1059 "Like `file-truename' for Tramp files."
1065 ;; Use GNU readlink --canonicalize-missing where available.
1069 v
1074 ;; Use Perl implementation.
1082 v
1086 ;; Do it yourself. We bind `directory-sep-char' here for
1087 ;; XEmacs on Windows, which would otherwise use backslash.
1095 ;; Don't make the following value larger than
1096 ;; necessary. People expect an error message in a
1097 ;; timely fashion when something is wrong;
1098 ;; otherwise they might think that Emacs is hung.
1099 ;; Of course, correctness has to come first.
1101 symlink-target)
1112 method user host
1124 ;; It's a symlink, follow it.
1129 ;; If the symlink was absolute, we'll get a string like
1130 ;; "/user@host:/some/target"; extract the
1131 ;; "/some/target" part from it.
1135 v 'file-error
1141 steps)))
1143 ;; It's a file.
1147 v 'file-error
1150 ;; Combine list to form string.
1162 ;; Basic functions.
1165 "Like `file-exists-p' for Tramp files."
1173 v
1175 "%s %s"
1179 ;; CCC: This should check for an error condition and signal failure
1180 ;; when something goes wrong.
1181 ;; Daniel Pittman <daniel@danann.net>
1183 "Like `file-attributes' for Tramp files."
1185 ;; Don't modify `last-coding-system-used' by accident.
1191 v
1199 ;; The scripts could fail, for example with huge file size.
1203 "Implement `file-attributes' for Tramp files using the ls(1) command."
1205 res-inode res-filemodes res-numlinks
1206 res-uid res-gid res-size res-symlink-target)
1209 vec
1218 ;; parse `ls -l' output ...
1222 ;; ... inode
1238 ;; ... file mode flags
1240 ;; ... number links
1242 ;; ... uid and gid
1252 ;; ... size
1254 ;; From the file modes, figure out other stuff.
1257 ;; if symlink, find out file name pointed to
1261 ;; return data gathered
1263 ;; 0. t for directory, string (name linked to) for symbolic
1264 ;; link, or nil.
1266 ;; 1. Number of links to file.
1267 res-numlinks
1268 ;; 2. File uid.
1269 res-uid
1270 ;; 3. File gid.
1271 res-gid
1272 ;; 4. Last access time, as a list of two integers. First
1273 ;; integer has high-order 16 bits of time, second has low 16
1274 ;; bits.
1275 ;; 5. Last modification time, likewise.
1276 ;; 6. Last status change time, likewise.
1278 ;; 7. Size in bytes (-1, if number is out of range).
1279 res-size
1280 ;; 8. File modes, as a string of ten letters or dashes as in ls -l.
1281 res-filemodes
1282 ;; 9. t if file's gid would change if file were deleted and
1283 ;; recreated. Will be set in `tramp-convert-file-attributes'
1284 t
1285 ;; 10. inode number.
1286 res-inode
1287 ;; 11. Device number. Will be replaced by a virtual device number.
1288 -1
1289 )))))
1293 "Implement `file-attributes' for Tramp files using a Perl script."
1298 vec
1304 "Implement `file-attributes' for Tramp files using stat(1) command."
1307 vec
1309 ;; On Opsware, pdksh (which is the true name of ksh there) doesn't
1310 ;; parse correctly the sequence "((". Therefore, we add a space.
1311 "( (%s %s || %s -h %s) && %s -c '((\"%%N\") %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 \"%%A\" t %%ie0 -1)' %s || echo nil)"
1322 "Like `set-visited-file-modtime' for Tramp files."
1329 coding-system-used)
1332 ;; '(-1 65535) means file doesn't exists yet.
1336 ;; We use '(0 0) as a don't-know value. See also
1337 ;; `tramp-do-file-attributes-with-ls'.
1342 v
1352 nil)))))
1354 ;; This function makes the same assumption as
1355 ;; `tramp-sh-handle-set-visited-file-modtime'.
1357 "Like `verify-visited-file-modtime' for Tramp files.
1358 At the time `verify-visited-file-modtime' calls this function, we
1359 already know that the buffer is visiting a file and that
1360 `visited-file-modtime' does not return 0. Do not call this
1361 function directly, unless those two cases are already taken care
1362 of."
1365 ;; There is no file visiting the buffer, or the buffer has no
1366 ;; recorded last modification time, or there is no established
1367 ;; connection.
1371 t
1379 ;; File exists, and has a known modtime.
1382 modtime
1383 ;; For compatibility, deal with both the old
1384 ;; (HIGH . LOW) and the new (HIGH LOW) return
1385 ;; values of `visited-file-modtime'.
1388 mt)))
1390 ;; Modtime has the don't know value.
1393 v
1401 attr
1404 ;; If file does not exist, say it is not modified if and
1405 ;; only if that agrees with the buffer's record.
1409 "Like `set-file-modes' for Tramp files."
1412 ;; FIXME: extract the proper text from chmod's stderr.
1414 v
1421 "Like `set-file-times' for Tramp files."
1427 time))
1428 ;; With GNU Emacs, `format-time-string' has an optional
1429 ;; parameter UNIVERSAL. This is preferred, because we
1430 ;; could handle the case when the remote host is located
1431 ;; in a different time zone as the local host.
1441 ;; We handle also the local part, because in older Emacsen,
1442 ;; without `set-file-times', this function is an alias for this.
1443 ;; We are local, so we don't need the UTC settings.
1451 "Set the ownership for FILENAME.
1452 If UID and GID are provided, these values are used; otherwise uid
1453 and gid of the corresponding user is taken. Both parameters must be integers."
1454 ;; Modern Unices allow chown only for root. So we might need
1455 ;; another implementation, see `dired-do-chown'. OTOH, it is mostly
1456 ;; working with su(do)? when it is needed, so it shall succeed in
1457 ;; the majority of cases.
1458 ;; Don't modify `last-coding-system-used' by accident.
1463 ;; If we are root on the local host, we can do it directly.
1471 "chown %d:%d %s" uid gid
1474 ;; We handle also the local part, because there doesn't exist
1475 ;; `set-file-uid-gid'. On W32 "chown" might not work.
1479 "chown" nil nil nil
1483 "Check, whether SELINUX is enabled on the remote host."
1494 "Like `file-selinux-context' for Tramp files."
1503 "%s -d -Z %s"
1511 ;; Return the context.
1512 context))))
1515 "Like `set-file-selinux-context' for Tramp files."
1532 ;; We always return nil.
1533 nil)
1535 ;; Simple functions using the `test' command.
1538 "Like `file-executable-p' for Tramp files."
1541 ;; Examine `file-attributes' cache to see if request can be
1542 ;; satisfied without remote operation.
1547 "Like `file-readable-p' for Tramp files."
1550 ;; Examine `file-attributes' cache to see if request can be
1551 ;; satisfied without remote operation.
1555 ;; When the remote shell is started, it looks for a shell which groks
1556 ;; tilde expansion. Here, we assume that all shells which grok tilde
1557 ;; expansion will also provide a `test' command which groks `-nt' (for
1558 ;; newer than). If this breaks, tell me about it and I'll try to do
1559 ;; something smarter about it.
1561 "Like `file-newer-than-file-p' for Tramp files."
1563 nil)
1565 t)
1566 ;; We are sure both files exist at this point.
1569 ;; We try to get the mtime of both files. If they are not
1570 ;; equal to the "dont-know" value, then we subtract the times
1571 ;; and obtain the result.
1577 ;; If one of them is the dont-know value, then we can
1578 ;; still try to run a shell command on the remote host.
1579 ;; However, this only works if both files are Tramp
1580 ;; files and both have the same method, same user, same
1581 ;; host.
1586 v 'file-error
1587 "Files %s and %s must have same method, user, host"
1588 file1 file2)))
1593 ;; Functions implemented using the basic functions above.
1596 "Like `file-directory-p' for Tramp files."
1597 ;; Care must be taken that this function returns `t' for symlinks
1598 ;; pointing to directories. Surely the most obvious implementation
1599 ;; would be `test -d', but that returns false for such symlinks.
1600 ;; CCC: Stefan Monnier says that `test -d' follows symlinks. And
1601 ;; I now think he's right. So we could be using `test -d', couldn't
1602 ;; we?
1603 ;;
1604 ;; Alternatives: `cd %s', `test -d %s'
1610 "Like `file-writable-p' for Tramp files."
1614 ;; Examine `file-attributes' cache to see if request can be
1615 ;; satisfied without remote operation.
1618 ;; If file doesn't exist, check if directory is writable.
1623 "Like `file-ownership-preserved-p' for Tramp files."
1627 ;; Return t if the file doesn't exist, since it's true that no
1628 ;; information would be lost by an (attempted) delete and create.
1632 ;; Directory listings.
1636 "Like `directory-files-and-attributes' for Tramp files."
1644 v localname
1654 v localname id-format))
1657 v localname id-format)))))))))
1658 result item)
1668 result
1673 "Implement `directory-files-and-attributes' for Tramp files using a Perl script."
1676 vec tramp-perl-directory-files-and-attributes
1680 vec
1684 object))
1688 "Implement `directory-files-and-attributes' for Tramp files using stat(1) command."
1691 vec
1694 ;; We must care about filenames with spaces, or starting with
1695 ;; "-"; this would confuse xargs. "ls -aQ" might be a solution,
1696 ;; but it does not work on all remote systems. Therefore, we
1697 ;; quote the filenames via sed.
1707 ;; This function should return "foo/" for directories and "bar" for
1708 ;; files.
1710 "Like `file-name-all-completions' for Tramp files."
1715 filename
1717 'list
1719 ;; Try cache entries for filename, filename with last
1720 ;; character removed, filename with last two characters
1721 ;; removed, ..., and finally the empty string - all
1722 ;; concatenated to the local directory name.
1725 tramp-completion-reread-directory-timeout)))
1727 ;; This is inefficient for very long filenames, pity
1728 ;; `reduce' is not available...
1731 'append
1736 v
1738 "file-name-all-completions"
1739 nil)))
1741 ;; We cannot use a length of 0, because file properties
1742 ;; for "foo" and "foo/" are identical.
1745 ;; Cache expired or no matching cache entry found so we need
1746 ;; to perform a remote operation.
1748 ;; Get a list of directories and files, including reliably
1749 ;; tagging the directories with a trailing '/'. Because I
1750 ;; rock. --daniel@danann.net
1752 ;; Changed to perform `cd' in the same remote op and only
1753 ;; get entries starting with `filename'. Capture any `cd'
1754 ;; error messages. Ensure any `cd' and `echo' aliases are
1755 ;; ignored.
1757 v
1761 v tramp-perl-file-name-all-completions
1767 ;; `read-file-name-completion-ignore-case'
1768 ;; is introduced with Emacs 22.1.
1771 'read-file-name-completion-ignore-case
1777 ;; `ls' with wildcard might fail with `Argument
1778 ;; list too long' error in some corner cases; if
1779 ;; `ls' fails after `cd' succeeded, chances are
1780 ;; that's the case, so let's retry without
1781 ;; wildcard. This will return "too many" entries
1782 ;; but that isn't harmful.
1783 " || %s -a 2>/dev/null)"
1784 " | while read f; do"
1790 ;; When `filename' is empty, just `ls' without
1791 ;; filename argument is more efficient than `ls *'
1792 ;; for very large directories and might avoid the
1793 ;; `Argument list too long' error.
1794 ;;
1795 ;; With and only with wildcard, we need to add
1796 ;; `-d' to prevent `ls' from descending into
1797 ;; sub-directories.
1799 "."
1804 ;; Now grab the output.
1808 ;; Check result code, found in last line of output.
1812 ;; Grab error message from line before last line
1813 ;; (it was put there by `cd 2>&1').
1816 v 'file-error
1817 "tramp-sh-handle-file-name-all-completions: %s"
1819 ;; For peace of mind, if buffer doesn't end in `fail'
1820 ;; then it should end in `ok'. If neither are in the
1821 ;; buffer something went seriously wrong on the remote
1822 ;; side.
1825 v 'file-error
1826 "\
1827 tramp-sh-handle-file-name-all-completions: internal error accessing `%s': `%s'"
1833 ;; Because the remote op went through OK we know the
1834 ;; directory we `cd'-ed to exists.
1837 ;; Because the remote op went through OK we know every
1838 ;; file listed by `ls' exists.
1842 result)
1844 ;; Store result in the cache.
1849 ;; cp, mv and ln
1853 "Like `add-name-to-file' for Tramp files."
1858 v 'file-error
1859 "add-name-to-file: %s"
1869 "File %s already exists; make it a new name anyway? "
1870 newname)))
1872 v2 'file-error
1877 v1
1880 "error with add-name-to-file, see buffer `%s' for details"
1885 preserve-uid-gid preserve-selinux-context)
1886 "Like `copy-file' for Tramp files."
1890 ;; At least one file a Tramp file?
1894 'copy filename newname ok-if-already-exists keep-date
1895 preserve-uid-gid preserve-selinux-context))
1896 ;; Compat section.
1899 'copy-file
1901 preserve-uid-gid preserve-selinux-context)))
1904 'copy-file
1912 "Like `copy-directory' for Tramp files."
1917 ;; When DIRNAME and NEWNAME are remote, they must have
1918 ;; the same method.
1923 ;; scp or rsync DTRT.
1937 ;; We must do it file-wise.
1941 ;; When newname did exist, we have wrong cached values.
1949 "Like `rename-file' for Tramp files."
1950 ;; Check if both files are local -- invoke normal rename-file.
1951 ;; Otherwise, use Tramp from local system.
1954 ;; At least one file a Tramp file?
1964 preserve-uid-gid preserve-selinux-context)
1965 "Copy or rename a remote file.
1966 OP must be `copy' or `rename' and indicates the operation to perform.
1967 FILENAME specifies the file to copy or rename, NEWNAME is the name of
1968 the new file (for copy) or the new name of the file (for rename).
1969 OK-IF-ALREADY-EXISTS means don't barf if NEWNAME exists already.
1970 KEEP-DATE means to make sure that NEWNAME has the same timestamp
1971 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
1972 the uid and gid if both files are on the same host.
1973 PRESERVE-SELINUX-CONTEXT activates selinux commands.
1975 This function is invoked by `tramp-sh-handle-copy-file' and
1976 `tramp-sh-handle-rename-file'. It is an error if OP is neither
1977 of `copy' and `rename'. FILENAME and NEWNAME must be absolute
1978 file names."
1985 pr tm)
1995 filename newname)
1998 ;; Both are Tramp files.
2003 ;; Shortcut: if method, host, user are the same for
2004 ;; both files, we invoke `cp' or `mv' on the remote
2005 ;; host directly.
2008 op filename newname
2009 ok-if-already-exists keep-date preserve-uid-gid))
2011 ;; Try out-of-band operation.
2015 op filename newname keep-date))
2017 ;; No shortcut was possible. So we copy the file
2018 ;; first. If the operation was `rename', we go back
2019 ;; and delete the original file (if the copy was
2020 ;; successful). The approach is simple-minded: we
2021 ;; create a new buffer, insert the contents of the
2022 ;; source file into it, then write out the buffer to
2023 ;; the target file. The advantage is that it doesn't
2024 ;; matter which filename handlers are used for the
2025 ;; source and target file.
2028 op filename newname keep-date))))))
2030 ;; One file is a Tramp file, the other one is local.
2033 ;; Fast track on local machine.
2036 op filename newname
2037 ok-if-already-exists keep-date preserve-uid-gid))
2039 ;; If the Tramp file has an out-of-band method, the
2040 ;; corresponding copy-program can be invoked.
2044 op filename newname keep-date))
2046 ;; Use the inline method via a Tramp buffer.
2048 op filename newname keep-date))))
2051 ;; One of them must be a Tramp file.
2054 ;; Handle `preserve-selinux-context'.
2057 ;; In case of `rename', we must flush the cache of the source file.
2063 ;; When newname did exist, we have wrong cached values.
2070 "Use an Emacs buffer to copy or rename a file.
2071 First arg OP is either `copy' or `rename' and indicates the operation.
2072 FILENAME is the source file, NEWNAME the target file.
2073 KEEP-DATE is non-nil if NEWNAME should have the same timestamp as FILENAME."
2075 ;; We must disable multibyte, because binary data shall not be
2076 ;; converted.
2081 ;; We don't want the target file to be compressed, so we let-bind
2082 ;; `jka-compr-inhibit' to t.
2086 ;; KEEP-DATE handling.
2088 ;; Set the mode.
2090 ;; If the operation was `rename', delete the original file.
2095 "Invokes `cp' or `mv' on the remote system.
2096 OP must be one of `copy' or `rename', indicating `cp' or `mv',
2097 respectively. FILENAME specifies the file to copy or rename,
2098 NEWNAME is the name of the new file (for copy) or the new name of
2099 the file (for rename). Both files must reside on the same host.
2100 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2101 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2102 the uid and gid from FILENAME."
2112 v 'file-error
2113 "Unknown operation `%s', must be `copy' or `rename'"
2114 op))))
2118 filename))
2122 newname))
2124 cmd-result)
2127 ;; Both files are on a remote host, with same user.
2139 ;; Mask cp -f error.
2141 tramp-operation-not-permitted-regexp nil t))
2142 cmd-result)
2144 nil v 'file-error
2145 "Copying directly failed, see buffer `%s' for details."
2148 ;; We are on the local host.
2151 ;; We can do it directly.
2159 localname1 localname2 ok-if-already-exists
2160 keep-date preserve-uid-gid)
2164 ;; We can do it directly with `tramp-send-command'
2172 ok-if-already-exists keep-date t)
2173 ;; We must change the ownership to the local user.
2179 ;; We need a temporary file in between.
2181 ;; Create the temporary file.
2189 "%s %s %s" cmd
2192 "Copying directly failed, see buffer `%s' for details."
2194 ;; We must change the ownership as remote user.
2195 ;; Since this does not work reliable, we also
2196 ;; give read permissions.
2207 localname1 tmpfile t
2208 keep-date preserve-uid-gid)
2210 'rename-file
2212 ;; We must change the ownership as local user.
2213 ;; Since this does not work reliable, we also
2214 ;; give read permissions.
2218 tmpfile
2222 ;; Move the temporary file to its destination.
2227 "cp -f -p %s %s"
2230 "Copying directly failed, see buffer `%s' for details."
2234 'rename-file
2237 ;; Save exit.
2240 ;; Set the time and mode. Mask possible errors.
2247 "Invoke rcp program to copy.
2248 The method used must be an out-of-band method."
2252 copy-program copy-args copy-env copy-keep-date port spec
2253 source target)
2258 ;; Both are Tramp files. We shall optimize it when the
2259 ;; methods for filename and newname are the same.
2269 op filename tmpfile keep-date)
2272 ;; Save exit.
2279 ;; Set variables for computing the prompt for reading
2280 ;; password.
2285 ;; Expand hops. Might be necessary for gateway methods.
2289 ;; Check which ones of source and target are Tramp files.
2296 'file-name-directory
2300 ;; Check for host and port number. We cannot use
2301 ;; `tramp-file-name-port', because this returns also
2302 ;; `tramp-default-port', which might clash with settings in
2303 ;; "~/.ssh/config".
2310 ;; Compose copy command.
2312 ?h host ?u user ?p port
2320 copy-args
2322 ;; " " has either been a replacement of "%k" (when
2323 ;; keep-date argument is non-nil), or a replacement
2324 ;; for the whole keep-date sublist.
2325 " "
2329 copy-args)
2332 copy-args
2335 copy-env
2337 nil
2344 ;; Check for program.
2353 ;; The default directory must be remote.
2357 ;; Set the transfer process properties.
2367 ;; Use an asynchronous process. By this, password can
2368 ;; be handled. The default directory must be local, in
2369 ;; order to apply the correct `copy-program'. We don't
2370 ;; set a timeout, because the copying of large files can
2371 ;; last longer than 60 secs.
2377 copy-program
2384 p v nil tramp-actions-copy-out-of-band)))
2386 ;; Reset the transfer process properties.
2391 ;; Handle KEEP-DATE argument.
2395 ;; Set the mode.
2400 ;; If the operation was `rename', delete the original file.
2407 "Like `make-directory' for Tramp files."
2419 "Like `delete-directory' for Tramp files."
2431 "Like `delete-file' for Tramp files."
2442 ;; Dired.
2444 ;; CCC: This does not seem to be enough. Something dies when
2445 ;; we try and delete two directories under Tramp :/
2447 "Recursively delete the directory given.
2448 This is like `dired-recursive-delete-directory' for Tramp files."
2450 ;; Run a shell command 'rm -r <localname>'
2451 ;; Code shamelessly stolen from the dired implementation and, um, hacked :)
2454 ;; Which is better, -r or -R? (-r works for me <daniel@danann.net>)
2456 v
2458 ;; Don't read the output, do it explicitly.
2459 nil t)
2460 ;; Wait for the remote system to return to us...
2461 ;; This might take a while, allow it plenty of time.
2463 ;; Make sure that it worked...
2471 "Like `dired-compress-file' for Tramp files."
2472 ;; OK-FLAG is valid for XEmacs only, but not implemented.
2473 ;; Code stolen mainly from dired-aux.el.
2479 ;; Emacs case
2481 ;; XEmacs has `dired-compression-method-alist', which is
2482 ;; transformed into `dired-compress-file-suffixes' structure.
2486 nil
2489 suffix)
2490 ;; See if any suffix rule matches this file name.
2498 nil)
2500 ;; We found an uncompression rule.
2506 ;; `dired-remove-file' is not defined in XEmacs.
2511 ;; We don't recognize the file as compressed, so compress it.
2512 ;; Try gzip.
2517 ;; `dired-remove-file' is not defined in XEmacs.
2527 "Like `insert-directory' for Tramp files."
2553 ;; If `full-directory-p', we just say `ls -l FILENAME'.
2554 ;; Else we chdir to the parent directory, then say `ls -ld BASENAME'.
2557 v
2560 switches
2562 localname
2565 v
2569 "Couldn't `cd %s'"
2573 v
2576 switches
2581 ""
2586 ;; We cannot use `insert-buffer-substring' because the Tramp
2587 ;; buffer changes its contents before insertion due to calling
2588 ;; `expand-file' and alike.
2593 ;; Check for "--dired" output.
2600 ;; Now read the numeric positions of file names.
2606 ;; End is followed by \n or by " -> ".
2608 ;; Remove trailing lines.
2614 ;; Some busyboxes are reluctant to discard colors.
2620 ;; The inserted file could be from somewhere else.
2627 "."
2634 ;; Canonicalization of file names.
2637 "Like `expand-file-name' for Tramp files.
2639 the result will be a local, non-Tramp, filename."
2640 ;; If DIR is not given, use DEFAULT-DIRECTORY or "/".
2642 ;; Unless NAME is absolute, concat DIR and NAME.
2645 ;; If NAME is not a Tramp file, run the real handler.
2648 ;; Dissect NAME.
2652 ;; Tilde expansion if necessary. This needs a shell which
2653 ;; groks tilde expansion! The function `tramp-find-shell' is
2654 ;; supposed to find such a shell on the remote host. Please
2655 ;; tell me about it when this doesn't work on your system.
2659 ;; We cannot simply apply "~/", because under sudo "~/" is
2660 ;; expanded to the local user home directory but to the
2661 ;; root home directory. On the other hand, using always
2662 ;; the default user name for tilde expansion is not
2663 ;; appropriate either, because ssh and companions might
2664 ;; use a user name from the config file.
2676 ;; There might be a double slash, for example when "~/"
2677 ;; expands to "/". Remove this.
2680 ;; No tilde characters in file name, do normal
2681 ;; `expand-file-name' (this does "/./" and "/../"). We bind
2682 ;; `directory-sep-char' here for XEmacs on Windows, which would
2683 ;; otherwise use backslash. `default-directory' is bound,
2684 ;; because on Windows there would be problems with UNC shares or
2685 ;; Cygwin mounts.
2689 method user host
2694 ;;; Remote commands:
2697 "Like `executable-find' for Tramp files."
2702 "Flush file caches."
2710 ;; We use BUFFER also as connection buffer during setup. Because of
2711 ;; this, its original contents must be saved, and restored once
2712 ;; connection has been setup.
2714 "Like `start-file-process' for Tramp files."
2716 ;; When PROGRAM is nil, we just provide a tty.
2721 ;; Use a human-friendly prompt, for example for `shell'.
2725 tramp-initial-end-of-output))
2737 ;; BUFFER can be nil. We use a temporary buffer.
2740 ;; NAME must be unique as process name.
2744 ;; Set the new process properties.
2747 ;; Activate narrowing in order to save BUFFER contents.
2748 ;; Clear also the modification time; otherwise we might
2749 ;; be interrupted by `verify-visited-file-modtime'.
2755 ;; Send the command.
2757 ;; Check, whether a pty is associated.
2762 v 'file-error
2765 ;; Set query flag for this process.
2767 ;; Return process.
2768 p)))
2769 ;; Save exit.
2781 "Like `process-file' for Tramp files."
2782 ;; The implementation is not complete yet.
2788 ;; Compute command.
2791 ;; Determine input.
2796 ;; INFILE is on the same remote host.
2798 ;; INFILE must be copied to remote host.
2804 ;; Determine output.
2806 ;; Just a buffer.
2809 ;; A buffer name.
2812 ;; (REAL-DESTINATION ERROR-DESTINATION)
2814 ;; output.
2822 ;; stderr.
2827 ;; stderr is on the same remote host.
2830 ;; stderr must be copied to remote host. The temporary
2831 ;; file must be deleted after execution.
2834 method user host stderr))))
2835 ;; stderr to be discarded.
2838 ;; 't
2843 ;; Send the command. It might not return in time, so we protect
2844 ;; it. Call it in a subshell, in order to preserve working
2845 ;; directory.
2852 command)
2853 t t)
2855 ;; We should show the output anyway.
2862 ;; When the user did interrupt, we should do it also. We use
2863 ;; return code -1 as marker.
2867 ;; Handle errors.
2872 ;; Provide error file.
2875 ;; Cleanup. We remove all file cache values for the connection,
2876 ;; because the remote process could have changed them.
2879 ;; `process-file-side-effects' has been introduced with GNU
2880 ;; Emacs 23.2. If set to `nil', no remote file will be changed
2881 ;; by `program'. If it doesn't exist, we assume its default
2882 ;; value `t'.
2887 ;; Return exit status.
2890 ret))))
2894 "Like `call-process-region' for Tramp files."
2903 "Like `file-local-copy' for Tramp files."
2907 v 'file-error
2917 ;; `copy-file' handles direct copy and out-of-band methods.
2922 ;; Use inline encoding for file transfer.
2932 ;; If local decoding is a function, we call it. We
2933 ;; must disable multibyte, because
2934 ;; `uudecode-decode-region' doesn't handle it
2935 ;; correctly.
2941 filename loc-dec)
2943 ;; Unset `file-name-handler-alist'. Otherwise,
2944 ;; epa-file gets confused.
2949 ;; If tramp-decoding-function is not defined for this
2950 ;; method, we invoke tramp-decoding-command instead.
2952 ;; Unset `file-name-handler-alist'. Otherwise,
2953 ;; epa-file gets confused.
2959 filename loc-dec)
2962 loc-dec tmpfile2 tmpfile)
2965 ;; Set proper permissions.
2967 ;; Set local user ownership.
2970 ;; Oops, I don't know what to do.
2974 ;; Error handling.
2980 tmpfile)))
2982 ;; This is needed for XEmacs only. Code stolen from files.el.
2985 "Like `insert-file-contents-literally' for Tramp files."
2993 nil))
3000 ;; Save exit.
3006 "Like `make-auto-save-file-name' for Tramp files.
3007 Returns a file name in `tramp-auto-save-directory' for autosaving this file."
3018 ;; File name must be unique. This is ensured with Emacs 22 (see
3019 ;; UNIQUIFY element of `auto-save-file-name-transforms'); but for
3020 ;; all other cases we must do it ourselves.
3030 ;; Create directory.
3036 ;; Run plain `make-auto-save-file-name'. There might be an advice when
3037 ;; it is not a magic file name operation (since Emacs 22).
3038 ;; We must deactivate it temporarily.
3041 ;; else
3047 ;; CCC grok LOCKNAME
3050 "Like `write-region' for Tramp files."
3053 ;; Following part commented out because we don't know what to do about
3054 ;; file locking, and it does not appear to be a problem to ignore it.
3055 ;; Ange-ftp ignores it, too.
3056 ;; (when (and lockname (stringp lockname))
3057 ;; (setq lockname (expand-file-name lockname)))
3058 ;; (unless (or (eq lockname nil)
3059 ;; (string= lockname filename))
3060 ;; (error
3061 ;; "tramp-sh-handle-write-region: LOCKNAME must be nil or equal FILENAME"))
3063 ;; XEmacs takes a coding system as the seventh argument, not `confirm'.
3074 ;; `file-writable-p' calls `file-expand-file-name'. We
3075 ;; cannot use `tramp-run-real-handler' therefore.
3081 ;; Short track: if we are on the local host, we can run directly.
3083 'write-region
3087 ;; We use this to save the value of
3088 ;; `last-coding-system-used' after writing the tmp
3089 ;; file. At the end of the function, we set
3090 ;; `last-coding-system-used' to this saved value. This
3091 ;; way, any intermediary coding systems used while
3092 ;; talking to the remote shell or suchlike won't hose
3093 ;; this variable. This approach was snarfed from
3094 ;; ange-ftp.el.
3095 coding-system-used
3096 ;; Write region into a tmp file. This isn't really
3097 ;; needed if we use an encoding function, but currently
3098 ;; we use it always because this makes the logic
3099 ;; simpler.
3103 ;; If `append' is non-nil, we copy the file locally, and let
3104 ;; the native `write-region' implementation do the job.
3107 ;; We say `no-message' here because we don't want the
3108 ;; visited file modtime data to be clobbered from the temp
3109 ;; file. We call `set-visited-file-modtime' ourselves later
3110 ;; on. We must ensure that `file-coding-system-alist'
3111 ;; matches `tmpfile'.
3117 'write-region
3124 ;; Now, `last-coding-system-used' has the right value. Remember it.
3129 ;; The permissions of the temporary file should be set. If
3130 ;; filename does not exist (eq modes nil) it has been
3131 ;; renamed to the backup file. This case `save-buffer'
3132 ;; handles permissions.
3133 ;; Ensure that it is still readable.
3136 tmpfile
3139 ;; This is a bit lengthy due to the different methods
3140 ;; possible for file transfer. First, we check whether the
3141 ;; method uses an rcp program. If so, we call it.
3142 ;; Otherwise, both encoding and decoding command must be
3143 ;; specified. However, if the method _also_ specifies an
3144 ;; encoding function, then that is used for encoding the
3145 ;; contents of the tmp file.
3150 ;; `copy-file' handles direct copy and out-of-band methods.
3161 ;; We keep the local file for performance
3162 ;; reasons, useful for "rsync".
3169 ;; Don't rename, in order to keep context in SELinux.
3174 ;; Use inline file transfer.
3176 ;; Encode tmpfile.
3180 ;; Use encoding function or command.
3184 loc-enc)
3187 ;; The following `let' is a workaround for the
3188 ;; base64.el that comes with pgnus-0.84. If
3189 ;; both of the following conditions are
3190 ;; satisfied, it tries to write to a local
3191 ;; file in default-directory, but at this
3192 ;; point, default-directory is remote.
3193 ;; (`call-process-region' can't write to
3194 ;; remote files, it seems.) The file in
3195 ;; question is a tmp file anyway.
3202 loc-enc)
3204 loc-enc tmpfile t))
3206 v 'file-error
3209 filename loc-enc))))
3211 ;; Send buffer into remote decoding command which
3212 ;; writes to remote file. Because this happens on
3213 ;; the remote host, we cannot use the function.
3215 v 3
3220 v
3226 v nil
3227 "Couldn't write region to `%s', decode using `%s' failed"
3228 filename rem-dec)
3229 ;; When `file-precious-flag' is set, the region is
3230 ;; written to a temporary file. Check that the
3231 ;; checksum is equal to that from the local tmpfile.
3235 ;; cksum runs locally, if possible.
3237 ;; cksum runs remotely.
3239 v
3242 ;; ... they are different.
3249 v 'file-error
3252 filename rem-dec)))))
3254 ;; Save exit.
3257 ;; That's not expected.
3260 v 'file-error
3263 method))))
3265 ;; Make `last-coding-system-used' have the right value.
3272 ;; We must protect `last-coding-system-used', now we have set it
3273 ;; to its correct value.
3275 ;; Set file modification time.
3279 ;; We must pass modtime explicitly, because filename can
3280 ;; be different from (buffer-file-name), f.e. if
3281 ;; `file-precious-flag' is set.
3287 ;; Set the ownership.
3297 ;; VC backends check for the existence of various different special
3298 ;; files. This is very time consuming, because every single check
3299 ;; requires a remote command (the file cache must be invalidated).
3300 ;; Therefore, we apply a kind of optimization. We install the file
3301 ;; name handler `tramp-vc-file-name-handler', which does nothing but
3302 ;; remembers all file names for which `file-exists-p' or
3303 ;; `file-readable-p' has been applied. A first run of `vc-registered'
3304 ;; is performed. Afterwards, a script is applied for all collected
3305 ;; file names, using just one remote command. The result of this
3306 ;; script is used to fill the file cache with actual values. Now we
3307 ;; can reset the file name handlers, and we make a second run of
3308 ;; `vc-registered', which returns the expected result without sending
3309 ;; any other remote command.
3311 "Like `vc-registered' for Tramp files."
3317 ;; There could be new files, created by the vc backend. We
3318 ;; cannot reuse the old cache entries, therefore.
3324 ;; Here we collect only file names, which need an operation.
3328 ;; Send just one command, in order to fill the cache.
3331 v
3340 v
3344 tramp-vc-registered-file-names
3350 ;; Second run. Now all `file-exists-p' or `file-readable-p'
3351 ;; calls shall be answered from the file cache. We unset
3352 ;; `process-file-side-effects' in order to keep the cache when
3353 ;; `process-file' calls appear.
3357 ;;;###tramp-autoload
3359 "Invoke remote-shell Tramp file name handler.
3360 Fall back to normal file name handler if no Tramp handler exists."
3377 "Invoke special file name handler, which collects files to be handled."
3385 ;; That's what we want: file names, for which checks are
3386 ;; applied. We assume that VC uses only `file-exists-p' and
3387 ;; `file-readable-p' checks; otherwise we must extend the
3388 ;; list. We do not perform any action, but return nil, in
3389 ;; order to keep `vc-registered' running.
3392 nil)
3393 ;; Tramp file name handlers like `expand-file-name'. They
3394 ;; must still work.
3397 ;; Default file name handlers, we don't care.
3400 ;;; Internal Functions:
3403 "Define in remote shell function NAME implemented as SCRIPT.
3404 Only send the definition if it has not already been done."
3405 ;; We cannot let-bind (tramp-get-connection-process vec) because it
3406 ;; might be nil.
3411 ;; The script could contain a call of Perl. This is masked with `%s'.
3413 vec
3424 auto-save-default)
3432 "Run `test' on the remote system, given a SWITCH and a FILENAME.
3433 Returns the exit code of the `test' program."
3436 v
3438 "%s %s %s"
3440 switch
3444 "Run `test'-like program on the remote system, given FILE1, FILE2.
3445 FORMAT-STRING contains the program name, switches, and place holders.
3446 Returns the exit code of the `test' program. Barfs if the methods,
3447 hosts, or files, disagree."
3451 v 'file-error
3456 v1
3463 "Searches for PROGNAME in $PATH and all directories mentioned in DIRLIST.
3464 First arg VEC specifies the connection, PROGNAME is the program
3465 to search for, and DIRLIST gives the list of directories to
3466 search. If IGNORE-TILDE is non-nil, directory names starting
3467 with `~' will be ignored. If IGNORE-PATH is non-nil, searches
3468 only in DIRLIST.
3470 Returns the absolute file name of PROGNAME, if found, and nil otherwise.
3472 This function expects to be in the right *tramp* buffer."
3475 ;; Check whether the executable is in $PATH. "which(1)" does not
3476 ;; report always a correct error code; therefore we check the
3477 ;; number of words it returns.
3485 ;; Remove all ~/foo directories from dirlist. In XEmacs,
3486 ;; `remove' is in CL, and we want to avoid CL dependencies.
3495 vec
3497 "do if test -x $d/%s -a -f $d/%s; "
3498 "then echo tramp_executable $d/%s; "
3507 result)))
3510 "Sets the remote environment PATH to existing directories.
3511 I.e., for each directory in `tramp-remote-path', it is tested
3512 whether it exists and if so, it is added to the environment
3513 variable PATH."
3519 ;; ------------------------------------------------------------
3520 ;; -- Communication with external shell --
3521 ;; ------------------------------------------------------------
3524 "Find a command on the remote host for checking if a file exists.
3525 Here, we are looking for a command which has zero exit status if the
3526 file exists and nonzero exit status otherwise."
3530 result)
3531 ;; The algorithm is as follows: we try a list of several commands.
3532 ;; For each command, we first run `$cmd /' -- this should return
3533 ;; true, as the root directory always exists. And then we run
3534 ;; `$cmd /this\ file\ does\ not\ exist ', hoping that the file indeed
3535 ;; does not exist. This should return false. We use the first
3536 ;; command we find that seems to work.
3537 ;; The list of commands to try is as follows:
3538 ;; `ls -d' This works on most systems, but NetBSD 1.4
3539 ;; has a bug: `ls' always returns zero exit
3540 ;; status, even for files which don't exist.
3541 ;; `test -e' Some Bourne shells have a `test' builtin
3542 ;; which does not know the `-e' option.
3543 ;; `/bin/test -e' For those, the `test' binary on disk normally
3544 ;; provides the option. Alas, the binary
3545 ;; is sometimes `/bin/test' and sometimes it's
3546 ;; `/usr/bin/test'.
3547 ;; `/usr/bin/test -e' In case `/bin/test' does not exist.
3571 result))
3574 "Opens shell SHELL."
3577 ;; Find arguments for this shell.
3580 item extra-args)
3589 t))
3590 ;; Setting prompts.
3598 "Opens a shell on the remote host which groks tilde expansion."
3605 ;; The default shell (ksh93) of OpenSolaris and Solaris
3606 ;; is buggy. We've got reports for "SunOS 5.10" and
3607 ;; "SunOS 5.11" so far.
3617 vec 'file-error
3626 vec "remote-shell"
3630 ;; Utility functions.
3633 "Wait for shell prompt and barf if none appears.
3634 Looks at process PROC to see if a shell prompt appears in TIMEOUT
3635 seconds. If not, it produces an error message with the given ERROR-ARGS."
3638 proc timeout
3644 "Set up an interactive shell.
3645 Mainly sets the prompt and the echo correctly. PROC is the shell
3646 process to set up. VEC specifies the connection."
3648 ;; It is useful to set the prompt in the following command because
3649 ;; some people have a setting for $PS1 which /bin/sh doesn't know
3650 ;; about and thus /bin/sh will display a strange prompt. For
3651 ;; example, if $PS1 has "${CWD}" in the value, then ksh will
3652 ;; display the current working directory but /bin/sh will display
3653 ;; a dollar sign. The following command line sets $PS1 to a sane
3654 ;; value, and works under Bourne-ish shells as well as csh-like
3655 ;; shells. Daniel Pittman reports that the unusual positioning of
3656 ;; the single quotes makes it work under `rc', too. We also unset
3657 ;; the variable $ENV because that is read by some sh
3658 ;; implementations (eg, bash when called as sh) on startup; this
3659 ;; way, we avoid the startup file clobbering $PS1. $PROMPT_COMMAND
3660 ;; is another way to set the prompt in /bin/bash, it must be
3661 ;; discarded as well.
3663 vec
3667 ;; Disable echo.
3670 ;; Check whether the echo has really been disabled. Some
3671 ;; implementations, like busybox of embedded GNU/Linux, don't
3672 ;; support disabling.
3679 ;; Make sure backspaces and their echo are enabled and no line
3680 ;; width magic interferes with them.
3690 ;; Try to set up the coding system correctly.
3691 ;; CCC this can't be the right way to do it. Hm.
3697 ;; Use MULE to select the right EOL convention for communicating
3698 ;; with the process.
3701 cs-decode cs-encode)
3716 ;; Look for ^M and do something useful if found.
3718 ;; We have found a ^M but cannot frob the process coding system
3719 ;; because we're running on a non-MULE Emacs. Let's try
3720 ;; stty, instead.
3725 ;; Check whether the output of "uname -sr" has been changed. If
3726 ;; yes, this is a strong indication that we must expire all
3727 ;; connection properties. We start again with
3728 ;; `tramp-maybe-open-connection', it will be catched there.
3733 vec "uname"
3737 ;; Keep the debug buffer.
3744 ;; We call `tramp-get-buffer' in order to keep the debug buffer.
3747 vec 3
3748 "Connection reset, because remote host changed from `%s' to `%s'"
3749 old-uname new-uname)
3752 ;; Check whether the remote host suffers from buggy
3753 ;; `send-process-string'. This is known for FreeBSD (see comment in
3754 ;; `send_process', file process.c). I've tested sending 624 bytes
3755 ;; successfully, sending 625 bytes failed. Emacs makes a hack when
3756 ;; this host type is detected locally. It cannot handle remote
3757 ;; hosts, though.
3761 tramp-chunksize)
3769 ;; Set remote PATH variable.
3772 ;; Search for a good shell before searching for a command which
3773 ;; checks if a file exists. This is done because Tramp wants to use
3774 ;; "test foo; echo $?" to check if various conditions hold, and
3775 ;; there are buggy /bin/sh implementations which don't execute the
3776 ;; "echo $?" part if the "test" part has an error. In particular,
3777 ;; the OpenSolaris /bin/sh is a problem. There are also other
3778 ;; problems with /bin/sh of OpenSolaris, like redirection of stderr
3779 ;; in function declarations, or changing HISTFILE in place.
3780 ;; Therefore, OpenSolaris' /bin/sh is replaced by bash, when
3781 ;; detected.
3784 ;; Disable unexpected output.
3787 ;; IRIX64 bash expands "!" even when in single quotes. This
3788 ;; destroys our shell functions, we must disable it. See
3789 ;; <http://stackoverflow.com/questions/3291692/irix-bash-shell-expands-expression-in-single-quotes-yet-shouldnt>.
3793 ;; On BSD-like systems, ?\t is expanded to spaces. Suppress this.
3798 ;; Set `remote-tty' process property.
3803 ;; Dump stty settings in the traces.
3807 ;; Set the environment.
3811 unset item)
3824 ;; CCC: We should either implement a Perl version of base64 encoding
3825 ;; and decoding. Then we just use that in the last item. The other
3826 ;; alternative is to use the Perl version of UU encoding. But then
3827 ;; we need a Lisp version of uuencode.
3828 ;;
3829 ;; Old text from documentation of tramp-methods:
3830 ;; Using a uuencode/uudecode inline method is discouraged, please use one
3831 ;; of the base64 methods instead since base64 encoding is much more
3832 ;; reliable and the commands are more standardized between the different
3833 ;; Unix versions. But if you can't use base64 for some reason, please
3834 ;; note that the default uudecode command does not work well for some
3835 ;; Unices, in particular AIX and Irix. For AIX, you might want to use
3836 ;; the following command for uudecode:
3837 ;;
3838 ;; sed '/^begin/d;/^[` ]$/d;/^end/d' | iconv -f uucode -t ISO8859-1
3839 ;;
3840 ;; For Irix, no solution is known yet.
3848 "perl -e 'binmode STDIN; binmode STDOUT; print pack(q{u*}, join q{}, <>)'"
3850 "List of local coding commands for inline transfer.
3851 Each item is a list that looks like this:
3853 \(FORMAT ENCODING DECODING\)
3855 FORMAT is symbol describing the encoding/decoding format. It can be
3856 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
3858 ENCODING and DECODING can be strings, giving commands, or symbols,
3859 giving functions. If they are strings, then they can contain
3861 filename will be put into the command line at that spot. If the
3862 specifier is not present, the input should be read from standard
3863 input.
3865 If they are functions, they will be called with two arguments, start
3866 and end of region, and are expected to replace the region contents
3871 ;; "-i" is more robust with older base64 from GNU coreutils.
3872 ;; However, I don't know whether all base64 versions do supports
3873 ;; this option.
3885 "perl -e 'binmode STDIN; binmode STDOUT; print pack(q{u*}, join q{}, <>)'"
3887 "List of remote coding commands for inline transfer.
3888 Each item is a list that looks like this:
3890 \(FORMAT ENCODING DECODING\)
3892 FORMAT is symbol describing the encoding/decoding format. It can be
3893 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
3895 ENCODING and DECODING can be strings, giving commands, or symbols,
3896 giving variables. If they are strings, then they can contain
3898 filename will be put into the command line at that spot. If the
3899 specifier is not present, the input should be read from standard
3900 input.
3902 If they are variables, this variable is a string containing a Perl
3903 implementation for this functionality. This Perl program will be transferred
3907 "Find an inline transfer encoding that works.
3908 Goes through the list `tramp-local-coding-commands' and
3909 `tramp-remote-coding-commands'."
3913 loc-enc loc-dec rem-enc rem-dec litem ritem found)
3921 ;; If the local encoder or decoder is a string, the
3922 ;; corresponding command has to work locally.
3929 loc-enc nil nil))
3937 loc-dec nil nil))
3939 ;; Search for remote coding commands with the same format
3946 ;; Check if remote encoding and decoding commands can be
3947 ;; called remotely with null input and output. This makes
3948 ;; sure there are no syntax errors and the command is really
3949 ;; found. Note that we do not redirect stdout to /dev/null,
3950 ;; for two reasons: when checking the decoding command, we
3951 ;; actually check the output it gives. And also, when
3952 ;; redirecting "mimencode" output to /dev/null, then as root
3953 ;; it might change the permissions of /dev/null!
3961 vec 5
3974 vec 5
3977 vec
3979 t)
3987 ;; `rem-enc' and `rem-dec' could be a string meanwhile.
3992 ;; Did we find something?
3997 ;; Set connection properties.
4008 "Call the local encoding or decoding command.
4010 Otherwise, INPUT is passed via standard input.
4011 INPUT can also be nil which means `/dev/null'.
4012 OUTPUT can be a string (which specifies a filename), or t (which
4013 means standard output and thus the current buffer), or nil (which
4014 means discard it)."
4016 tramp-encoding-shell
4019 nil
4020 tramp-encoding-command-switch
4030 "List of compress and decompress commands for inline transfer.
4031 Each item is a list that looks like this:
4033 \(COMPRESS DECOMPRESS\)
4038 "Find an inline transfer compress command that works.
4039 Goes through the list `tramp-inline-compress-commands'."
4043 item compress decompress
4044 found)
4051 vec 5
4052 "Checking local compress command `%s', `%s' for sanity"
4053 compress decompress)
4058 ;; Windows shells need the program file name after
4059 ;; the pipe symbol be quoted if they use forward
4060 ;; slashes as directory separators.
4067 vec 5
4068 "Checking remote compress command `%s', `%s' for sanity"
4069 compress decompress)
4075 ;; Did we find something?
4078 ;; Set connection properties.
4092 "Expands VEC according to `tramp-default-proxies-alist'.
4093 Gateway hops are already opened."
4096 item proxy)
4098 ;; Look for proxy hosts to be passed.
4103 ;; host
4106 ;; user
4110 ;; No more hops needed.
4112 ;; Replace placeholders.
4115 proxy
4120 ;; Add the hop.
4122 ;; Start next search.
4125 ;; Handle gateways.
4132 ;; Is the method prepared for gateways?
4135 vec 'file-error
4137 ;; Open the gateway connection.
4139 'target-alist
4143 ;; For the password prompt, we need the correct values.
4144 ;; Therefore, we must remember the gateway vector. But we
4145 ;; cannot do it as connection property, because it shouldn't
4146 ;; be persistent. And we have no started process yet either.
4149 ;; Foreign and out-of-band methods are not supported for multi-hops.
4162 vec 'file-error
4163 "Method `%s' is not supported for multi-hops."
4166 ;; In case the host name is not used for the remote shell
4167 ;; command, the user could be misguided by applying a random
4168 ;; hostname.
4174 ;; There are multi-hops.
4176 ;; The host name is used for the remote shell command.
4179 ;; The host is local. We cannot use `tramp-local-host-p'
4180 ;; here, because it opens a connection as well.
4183 v 'file-error
4184 "Host `%s' looks like a remote host, `%s' can only use the local host"
4185 host method)))
4187 ;; Result.
4188 target-alist))
4191 "Maybe open a connection VEC.
4192 Does not do anything if a connection is already open, but re-opens the
4193 connection if a previous connection has died for some reason."
4200 ;; If too much time has passed since last command was sent, look
4201 ;; whether process is still alive. If it isn't, kill it. When
4202 ;; using ssh, it can sometimes happen that the remote end has
4203 ;; hung up but the local ssh client doesn't recognize this until
4204 ;; it tries to send some data to the remote end. So that's why
4205 ;; we try to send a command from time to time, then look again
4206 ;; whether the process is really alive.
4217 ;; The error will be catched locally.
4225 ;; New connection must be opened.
4228 ;; We call `tramp-get-buffer' in order to get a debug buffer for
4229 ;; messages from the beginning.
4232 vec 3
4242 ;; Start new process.
4253 ;; This must be done in order to avoid our file name handler.
4257 'start-process
4262 tramp-encoding-command-interactive)
4265 ;; Set sentinel and query flag.
4273 ;; Check whether process is alive.
4277 ;; Now do all the connections as specified.
4298 ;; We don't create the temporary file. In fact,
4299 ;; it is just a prefix for the ControlPath option
4300 ;; of ssh; the real temporary file has another
4301 ;; name, and it is created and protected by ssh.
4302 ;; It is also removed by ssh when the connection
4303 ;; is closed.
4306 p "temp-file"
4309 tramp-temp-name-prefix
4311 spec)
4313 ;; Add arguments for asynchrononous processes.
4317 ;; Add gateway arguments if necessary.
4321 ;; Check for port number. Until now, there's no need
4322 ;; for handling like method, user, host.
4327 ;; Set variables for computing the prompt for reading
4328 ;; password. They can also be derived from a gateway.
4333 ;; Replace login-args place holders.
4339 ?h l-host ?u l-user ?p l-port ?t tmpfile)
4340 command
4342 ;; We do not want to see the trailing local prompt in
4343 ;; `start-file-process'.
4345 command " "
4351 ;; Local shell could be a Windows COMSPEC. It
4352 ;; doesn't know the ";" syntax, but we must exit
4353 ;; always for `start-file-process'. "exec" does not
4354 ;; work either.
4357 ;; Send the command.
4363 ;; Next hop.
4366 ;; Make initial shell settings.
4370 "Send the COMMAND to connection VEC.
4371 Erases temporary buffer before sending the command. If optional
4372 arg NEVEROPEN is non-nil, never try to open the connection. This
4373 is meant to be used from `tramp-maybe-open-connection' only. The
4374 function waits for output unless NOOUTPUT is set."
4378 ;; We mark the command string that it can be erased in the output buffer.
4382 ;; Unset $PS1 when using here documents, in order to avoid
4383 ;; multiple prompts.
4385 ;; Send the command.
4391 "Wait for output from remote command."
4397 ;; be leading escape sequences, which must be ignored.
4399 ;; Sometimes, the commands do not return a newline but a
4400 ;; null byte before the shell prompt, for example "git
4401 ;; ls-files -c -z ...".
4406 ;; A simple-minded busybox has sent " ^H" sequences.
4407 ;; Delete them.
4412 ;; Delete the prompt.
4418 proc 'file-error
4419 "[[Remote prompt `%s' not found in %d secs]]"
4420 tramp-end-of-output timeout)
4422 proc 'file-error
4424 ;; Return value is whether end-of-output sentinel was found.
4425 found)))
4429 "Run COMMAND and check its exit status.
4430 Sends `echo $?' along with the COMMAND for checking the exit status. If
4431 COMMAND is nil, just sends `echo $?'. Returns the exit status found.
4433 If the optional argument SUBSHELL is non-nil, the command is
4434 executed in a subshell, ie surrounded by parentheses. If
4435 DONT-SUPPRESS-ERR is non-nil, stderr won't be sent to /dev/null."
4437 vec
4439 command
4441 "echo tramp_exit_status $?"
4455 "Run COMMAND, check exit status, throw error if exit status not okay.
4456 Similar to `tramp-send-command-and-check' but accepts two more arguments
4457 FMT and ARGS which are passed to `error'."
4462 "Run COMMAND and return the output, which must be a Lisp expression.
4463 In case there is no valid Lisp expression and NOERROR is nil, it
4464 raises an error."
4470 ;; Read the expression.
4474 ;; Error handling.
4479 vec 'file-error
4480 "`%s' does not return a valid Lisp expression: `%s'"
4484 "Convert file-attributes ATTR generated by perl script, stat or ls.
4485 Convert file mode bits to string and set virtual device number.
4486 Return ATTR."
4488 ;; Remove color escape sequences from symlink.
4492 ;; Convert last access time.
4497 ;; Convert last modification time.
4502 ;; Convert last status change time.
4507 ;; Convert file size.
4513 ;; Convert file mode bits to string.
4518 ;; Convert directory indication bit.
4521 ;; Convert symlink from `tramp-do-file-attributes-with-stat'.
4527 ;; Set file's gid change bit.
4535 ;; Convert inode.
4541 ;; Inodes can be incredible huge. We must hide this.
4543 ;; Set virtual device number.
4546 attr))
4549 "Check `file-attributes' caches for VEC.
4550 Return t if according to the cache access type ACCESS is known to
4551 be granted."
4559 result
4561 result
4573 file-attr
4575 ;; Not a symlink
4579 ;; World accessible.
4581 ;; User accessible and owned by user.
4585 ;; Group accessible and owned by user's
4586 ;; principal group.
4592 "Turn an integer representing a file mode into an ls(1)-like string."
4607 "Convert a permission bitset into a string.
4608 This is used internally by `tramp-file-mode-from-int'."
4619 "Converts STRING to shell glob pattern which ignores case."
4625 string
4629 "Create a file name suitable to be passed to `rcp' and workalikes."
4639 "Return t if this is an out-of-band method, nil otherwise."
4641 ;; It shall be an out-of-band method.
4643 ;; There must be a size, otherwise the file doesn't exist.
4645 ;; Either the file size is large enough, or (in rare cases) there
4646 ;; does not exist a remote encoding.
4651 ;; Variables local to connection.
4655 ;; When `tramp-own-remote-path' is in `tramp-remote-path', we
4656 ;; cache the result for the session only. Otherwise, the result
4657 ;; is cached persistently.
4660 vec)
4661 "remote-path"
4670 ;; Default if "getconf" is not available.
4673 vec 3
4684 nil)))))
4686 ;; Replace place holder `tramp-default-remote-path'.
4694 ;; Replace place holder `tramp-own-remote-path'.
4702 ;; Remove double entries.
4709 ;; Remove non-existing directories.
4711 nil
4721 x))
4722 x))
4723 remote-path)))))
4732 result)
4734 ;; Check parameters. On busybox, "ls" output coloring is
4735 ;; enabled by default sometimes. So we try to disable it
4736 ;; when possible. $LS_COLORING is not supported there.
4737 ;; Some "ls" versions are sensible wrt the order of
4738 ;; arguments, they fail when "-al" is after the
4739 ;; "--color=never" argument (for example on FreeBSD).
4754 ;; Some "ls" versions are sensible wrt the order of arguments,
4755 ;; they fail when "-al" is after the "--dired" argument (for
4756 ;; example on FreeBSD).
4764 "test"
4768 ;; Does `test A -nt B' work? Use abominable `find' construct if it
4769 ;; doesn't. BSD/OS 4.0 wants the parentheses around the command,
4770 ;; for otherwise the shell crashes.
4782 vec
4805 ;; We must check also for some Perl modules.
4813 result)))
4820 tmp)
4821 ;; Check whether stat(1) returns usable syntax. "%s" does not
4822 ;; work on older AIX systems.
4831 result)))
4841 result))))
4854 result)
4856 ;; Check POSIX parameter.
4865 vec
4871 ;; The command might not always return a number.
4877 vec
4883 ;; The command might not always return a number.
4892 ;; Some predefined connection properties.
4894 "Return the compress command related to PROP.
4895 PROP is either `inline-compress' or `inline-decompress'. SIZE is
4896 the length of the file to be compressed.
4898 If no corresponding command is found, nil is returned."
4906 "Return the coding command related to PROP.
4907 PROP is either `remote-encoding', `remode-decoding',
4908 `local-encoding' or `local-decoding'.
4910 SIZE is the length of the file to be coded. Depending on SIZE,
4911 compression might be applied.
4913 If no corresponding command is found, nil is returned.
4914 Otherwise, either a string is returned which contains a `%s' mark
4915 to be used for the respective input or output file; or a Lisp
4916 function cell is returned to be applied on a buffer."
4917 ;; We must catch the errors, because we want to return `nil', when
4918 ;; no inline coding is found.
4926 compress)
4927 ;; The connection property might have been cached. So we must
4928 ;; send the script to the remote side - maybe.
4936 ;; Check for the `compress' command.
4938 ;; Return the value.
4954 'call-process-region beg end
4959 coding)
4962 ;; Windows shells need the program file name after
4963 ;; the pipe symbol be quoted if they use forward
4964 ;; slashes as directory separators.
4969 coding compress))
4972 ;; Windows shells need the program file name after
4973 ;; the pipe symbol be quoted if they use forward
4974 ;; slashes as directory separators.
4979 compress coding))
4985 ;;; Integration of eshell.el:
4990 ;; eshell.el keeps the path in `eshell-path-env'. We must change it
4991 ;; when `default-directory' points to another host.
4993 "Set `eshell-path-env' to $PATH of the host related to `default-directory'."
4998 'identity
5019 ;;; TODO:
5021 ;; * Don't use globbing for directories with many files, as this is
5022 ;; likely to produce long command lines, and some shells choke on
5023 ;; long command lines.
5024 ;; * Make it work for different encodings, and for different file name
5025 ;; encodings, too. (Daniel Pittman)
5026 ;; * Don't search for perl5 and perl. Instead, only search for perl and
5027 ;; then look if it's the right version (with `perl -v').
5028 ;; * When editing a remote CVS controlled file as a different user, VC
5029 ;; gets confused about the file locking status. Try to find out why
5030 ;; the workaround doesn't work.
5031 ;; * Allow out-of-band methods as _last_ multi-hop. Open a connection
5032 ;; until the last but one hop via `start-file-process'. Apply it
5033 ;; also for ftp and smb.
5034 ;; * WIBNI if we had a command "trampclient"? If I was editing in
5035 ;; some shell with root priviledges, it would be nice if I could
5036 ;; just call
5037 ;; trampclient filename.c
5038 ;; as an editor, and the _current_ shell would connect to an Emacs
5039 ;; server and would be used in an existing non-priviledged Emacs
5040 ;; session for doing the editing in question.
5041 ;; That way, I need not tell Emacs my password again and be afraid
5042 ;; that it makes it into core dumps or other ugly stuff (I had Emacs
5043 ;; once display a just typed password in the context of a keyboard
5044 ;; sequence prompt for a question immediately following in a shell
5045 ;; script run within Emacs -- nasty).
5046 ;; And if I have some ssh session running to a different computer,
5047 ;; having the possibility of passing a local file there to a local
5048 ;; Emacs session (in case I can arrange for a connection back) would
5049 ;; be nice.
5050 ;; Likely the corresponding Tramp server should not allow the
5051 ;; equivalent of the emacsclient -eval option in order to make this
5052 ;; reasonably unproblematic. And maybe trampclient should have some
5053 ;; way of passing credentials, like by using an SSL socket or
5054 ;; something. (David Kastrup)
5055 ;; * Reconnect directly to a compliant shell without first going
5056 ;; through the user's default shell. (Pete Forman)
5057 ;; * How can I interrupt the remote process with a signal
5058 ;; (interrupt-process seems not to work)? (Markus Triska)
5059 ;; * Avoid the local shell entirely for starting remote processes. If
5060 ;; so, I think even a signal, when delivered directly to the local
5061 ;; SSH instance, would correctly be propagated to the remote process
5062 ;; automatically; possibly SSH would have to be started with
5063 ;; "-t". (Markus Triska)
5064 ;; * It makes me wonder if tramp couldn't fall back to ssh when scp
5065 ;; isn't on the remote host. (Mark A. Hershberger)
5066 ;; * Use lsh instead of ssh. (Alfred M. Szmidt)
5067 ;; * Optimize out-of-band copying when both methods are scp-like (not
5068 ;; rsync).
5069 ;; * Keep a second connection open for out-of-band methods like scp or
5070 ;; rsync.
5071 ;; * Try telnet+curl as new method. It might be useful for busybox,
5072 ;; without built-in uuencode/uudecode.
5074 ;;; tramp-sh.el ends here