| blob | 51fc6e295f0f3cc9917daa8459e27194abbc7626 |
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= disables 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."
1066 ;; Use GNU readlink --canonicalize-missing where available.
1070 v
1075 ;; Use Perl implementation.
1083 v
1087 ;; Do it yourself. We bind `directory-sep-char' here for
1088 ;; XEmacs on Windows, which would otherwise use backslash.
1096 ;; Don't make the following value larger than
1097 ;; necessary. People expect an error message in
1098 ;; a timely fashion when something is wrong;
1099 ;; otherwise they might think that Emacs is hung.
1100 ;; Of course, correctness has to come first.
1102 symlink-target)
1113 method user host
1125 ;; It's a symlink, follow it.
1131 ;; If the symlink was absolute, we'll get a
1132 ;; string like "/user@host:/some/target";
1133 ;; extract the "/some/target" part from it.
1137 v 'file-error
1138 "Symlink target `%s' on wrong host"
1139 symlink-target))
1144 steps)))
1146 ;; It's a file.
1150 v 'file-error
1153 ;; Combine list to form string.
1164 result)))))
1166 ;; Basic functions.
1169 "Like `file-exists-p' for Tramp files."
1177 v
1179 "%s %s"
1183 ;; CCC: This should check for an error condition and signal failure
1184 ;; when something goes wrong.
1185 ;; Daniel Pittman <daniel@danann.net>
1187 "Like `file-attributes' for Tramp files."
1189 ;; Don't modify `last-coding-system-used' by accident.
1195 v
1203 ;; The scripts could fail, for example with huge file size.
1207 "Implement `file-attributes' for Tramp files using the ls(1) command."
1209 res-inode res-filemodes res-numlinks
1210 res-uid res-gid res-size res-symlink-target)
1213 vec
1222 ;; parse `ls -l' output ...
1226 ;; ... inode
1242 ;; ... file mode flags
1244 ;; ... number links
1246 ;; ... uid and gid
1256 ;; ... size
1258 ;; From the file modes, figure out other stuff.
1261 ;; if symlink, find out file name pointed to
1265 ;; return data gathered
1267 ;; 0. t for directory, string (name linked to) for symbolic
1268 ;; link, or nil.
1270 ;; 1. Number of links to file.
1271 res-numlinks
1272 ;; 2. File uid.
1273 res-uid
1274 ;; 3. File gid.
1275 res-gid
1276 ;; 4. Last access time, as a list of two integers. First
1277 ;; integer has high-order 16 bits of time, second has low 16
1278 ;; bits.
1279 ;; 5. Last modification time, likewise.
1280 ;; 6. Last status change time, likewise.
1282 ;; 7. Size in bytes (-1, if number is out of range).
1283 res-size
1284 ;; 8. File modes, as a string of ten letters or dashes as in ls -l.
1285 res-filemodes
1286 ;; 9. t if file's gid would change if file were deleted and
1287 ;; recreated. Will be set in `tramp-convert-file-attributes'
1288 t
1289 ;; 10. inode number.
1290 res-inode
1291 ;; 11. Device number. Will be replaced by a virtual device number.
1292 -1
1293 )))))
1297 "Implement `file-attributes' for Tramp files using a Perl script."
1302 vec
1308 "Implement `file-attributes' for Tramp files using stat(1) command."
1311 vec
1313 ;; On Opsware, pdksh (which is the true name of ksh there) doesn't
1314 ;; parse correctly the sequence "((". Therefore, we add a space.
1315 "( (%s %s || %s -h %s) && %s -c '((\"%%N\") %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 \"%%A\" t %%ie0 -1)' %s || echo nil)"
1326 "Like `set-visited-file-modtime' for Tramp files."
1333 coding-system-used)
1336 ;; '(-1 65535) means file doesn't exists yet.
1340 ;; We use '(0 0) as a don't-know value. See also
1341 ;; `tramp-do-file-attributes-with-ls'.
1346 v
1356 nil)))))
1358 ;; This function makes the same assumption as
1359 ;; `tramp-sh-handle-set-visited-file-modtime'.
1361 "Like `verify-visited-file-modtime' for Tramp files.
1362 At the time `verify-visited-file-modtime' calls this function, we
1363 already know that the buffer is visiting a file and that
1364 `visited-file-modtime' does not return 0. Do not call this
1365 function directly, unless those two cases are already taken care
1366 of."
1369 ;; There is no file visiting the buffer, or the buffer has no
1370 ;; recorded last modification time, or there is no established
1371 ;; connection.
1375 t
1383 ;; File exists, and has a known modtime.
1386 modtime
1387 ;; For compatibility, deal with both the old
1388 ;; (HIGH . LOW) and the new (HIGH LOW) return
1389 ;; values of `visited-file-modtime'.
1392 mt)))
1394 ;; Modtime has the don't know value.
1397 v
1405 attr
1408 ;; If file does not exist, say it is not modified if and
1409 ;; only if that agrees with the buffer's record.
1413 "Like `set-file-modes' for Tramp files."
1416 ;; FIXME: extract the proper text from chmod's stderr.
1418 v
1425 "Like `set-file-times' for Tramp files."
1431 time))
1432 ;; With GNU Emacs, `format-time-string' has an optional
1433 ;; parameter UNIVERSAL. This is preferred, because we
1434 ;; could handle the case when the remote host is located
1435 ;; in a different time zone as the local host.
1445 ;; We handle also the local part, because in older Emacsen,
1446 ;; without `set-file-times', this function is an alias for this.
1447 ;; We are local, so we don't need the UTC settings.
1455 "Set the ownership for FILENAME.
1456 If UID and GID are provided, these values are used; otherwise uid
1457 and gid of the corresponding user is taken. Both parameters must be integers."
1458 ;; Modern Unices allow chown only for root. So we might need
1459 ;; another implementation, see `dired-do-chown'. OTOH, it is mostly
1460 ;; working with su(do)? when it is needed, so it shall succeed in
1461 ;; the majority of cases.
1462 ;; Don't modify `last-coding-system-used' by accident.
1467 ;; If we are root on the local host, we can do it directly.
1475 "chown %d:%d %s" uid gid
1478 ;; We handle also the local part, because there doesn't exist
1479 ;; `set-file-uid-gid'. On W32 "chown" might not work.
1483 "chown" nil nil nil
1487 "Check, whether SELINUX is enabled on the remote host."
1498 "Like `file-selinux-context' for Tramp files."
1507 "%s -d -Z %s"
1515 ;; Return the context.
1516 context))))
1519 "Like `set-file-selinux-context' for Tramp files."
1536 ;; We always return nil.
1537 nil)
1539 ;; Simple functions using the `test' command.
1542 "Like `file-executable-p' for Tramp files."
1545 ;; Examine `file-attributes' cache to see if request can be
1546 ;; satisfied without remote operation.
1551 "Like `file-readable-p' for Tramp files."
1554 ;; Examine `file-attributes' cache to see if request can be
1555 ;; satisfied without remote operation.
1559 ;; When the remote shell is started, it looks for a shell which groks
1560 ;; tilde expansion. Here, we assume that all shells which grok tilde
1561 ;; expansion will also provide a `test' command which groks `-nt' (for
1562 ;; newer than). If this breaks, tell me about it and I'll try to do
1563 ;; something smarter about it.
1565 "Like `file-newer-than-file-p' for Tramp files."
1567 nil)
1569 t)
1570 ;; We are sure both files exist at this point.
1573 ;; We try to get the mtime of both files. If they are not
1574 ;; equal to the "dont-know" value, then we subtract the times
1575 ;; and obtain the result.
1581 ;; If one of them is the dont-know value, then we can
1582 ;; still try to run a shell command on the remote host.
1583 ;; However, this only works if both files are Tramp
1584 ;; files and both have the same method, same user, same
1585 ;; host.
1590 v 'file-error
1591 "Files %s and %s must have same method, user, host"
1592 file1 file2)))
1597 ;; Functions implemented using the basic functions above.
1600 "Like `file-directory-p' for Tramp files."
1602 ;; `file-directory-p' is used as predicate for filename completion.
1603 ;; Sometimes, when a connection is not established yet, it is
1604 ;; desirable to return t immediately for "/method:foo:". It can
1605 ;; be expected that this is always a directory.
1611 "Like `file-writable-p' for Tramp files."
1615 ;; Examine `file-attributes' cache to see if request can be
1616 ;; satisfied without remote operation.
1619 ;; If file doesn't exist, check if directory is writable.
1624 "Like `file-ownership-preserved-p' for Tramp files."
1628 ;; Return t if the file doesn't exist, since it's true that no
1629 ;; information would be lost by an (attempted) delete and create.
1633 ;; Directory listings.
1637 "Like `directory-files-and-attributes' for Tramp files."
1645 v localname
1655 v localname id-format))
1658 v localname id-format)))))))))
1659 result item)
1669 result
1674 "Implement `directory-files-and-attributes' for Tramp files using a Perl script."
1677 vec tramp-perl-directory-files-and-attributes
1681 vec
1685 object))
1689 "Implement `directory-files-and-attributes' for Tramp files using stat(1) command."
1692 vec
1695 ;; We must care about filenames with spaces, or starting with
1696 ;; "-"; this would confuse xargs. "ls -aQ" might be a solution,
1697 ;; but it does not work on all remote systems. Therefore, we
1698 ;; quote the filenames via sed.
1708 ;; This function should return "foo/" for directories and "bar" for
1709 ;; files.
1711 "Like `file-name-all-completions' for Tramp files."
1716 filename
1718 'list
1720 ;; Try cache entries for filename, filename with last
1721 ;; character removed, filename with last two characters
1722 ;; removed, ..., and finally the empty string - all
1723 ;; concatenated to the local directory name.
1726 tramp-completion-reread-directory-timeout)))
1728 ;; This is inefficient for very long filenames, pity
1729 ;; `reduce' is not available...
1732 'append
1737 v
1739 "file-name-all-completions"
1740 nil)))
1742 ;; We cannot use a length of 0, because file properties
1743 ;; for "foo" and "foo/" are identical.
1746 ;; Cache expired or no matching cache entry found so we need
1747 ;; to perform a remote operation.
1749 ;; Get a list of directories and files, including reliably
1750 ;; tagging the directories with a trailing '/'. Because I
1751 ;; rock. --daniel@danann.net
1753 ;; Changed to perform `cd' in the same remote op and only
1754 ;; get entries starting with `filename'. Capture any `cd'
1755 ;; error messages. Ensure any `cd' and `echo' aliases are
1756 ;; ignored.
1758 v
1762 v tramp-perl-file-name-all-completions
1768 ;; `read-file-name-completion-ignore-case'
1769 ;; is introduced with Emacs 22.1.
1772 'read-file-name-completion-ignore-case
1778 ;; `ls' with wildcard might fail with `Argument
1779 ;; list too long' error in some corner cases; if
1780 ;; `ls' fails after `cd' succeeded, chances are
1781 ;; that's the case, so let's retry without
1782 ;; wildcard. This will return "too many" entries
1783 ;; but that isn't harmful.
1784 " || %s -a 2>/dev/null)"
1785 " | while read f; do"
1791 ;; When `filename' is empty, just `ls' without
1792 ;; filename argument is more efficient than `ls *'
1793 ;; for very large directories and might avoid the
1794 ;; `Argument list too long' error.
1795 ;;
1796 ;; With and only with wildcard, we need to add
1797 ;; `-d' to prevent `ls' from descending into
1798 ;; sub-directories.
1800 "."
1805 ;; Now grab the output.
1809 ;; Check result code, found in last line of output.
1813 ;; Grab error message from line before last line
1814 ;; (it was put there by `cd 2>&1').
1817 v 'file-error
1818 "tramp-sh-handle-file-name-all-completions: %s"
1820 ;; For peace of mind, if buffer doesn't end in `fail'
1821 ;; then it should end in `ok'. If neither are in the
1822 ;; buffer something went seriously wrong on the remote
1823 ;; side.
1826 v 'file-error
1827 "\
1828 tramp-sh-handle-file-name-all-completions: internal error accessing `%s': `%s'"
1834 ;; Because the remote op went through OK we know the
1835 ;; directory we `cd'-ed to exists.
1838 ;; Because the remote op went through OK we know every
1839 ;; file listed by `ls' exists.
1843 result)
1845 ;; Store result in the cache.
1850 ;; cp, mv and ln
1854 "Like `add-name-to-file' for Tramp files."
1859 v 'file-error
1860 "add-name-to-file: %s"
1870 "File %s already exists; make it a new name anyway? "
1871 newname)))
1873 v2 'file-error
1878 v1
1881 "error with add-name-to-file, see buffer `%s' for details"
1886 preserve-uid-gid preserve-selinux-context)
1887 "Like `copy-file' for Tramp files."
1891 ;; At least one file a Tramp file?
1895 'copy filename newname ok-if-already-exists keep-date
1896 preserve-uid-gid preserve-selinux-context))
1897 ;; Compat section.
1900 'copy-file
1902 preserve-uid-gid preserve-selinux-context)))
1905 'copy-file
1913 "Like `copy-directory' for Tramp files."
1918 ;; When DIRNAME and NEWNAME are remote, they must have
1919 ;; the same method.
1924 ;; scp or rsync DTRT.
1938 ;; We must do it file-wise.
1942 ;; When newname did exist, we have wrong cached values.
1950 "Like `rename-file' for Tramp files."
1951 ;; Check if both files are local -- invoke normal rename-file.
1952 ;; Otherwise, use Tramp from local system.
1955 ;; At least one file a Tramp file?
1965 preserve-uid-gid preserve-selinux-context)
1966 "Copy or rename a remote file.
1967 OP must be `copy' or `rename' and indicates the operation to perform.
1968 FILENAME specifies the file to copy or rename, NEWNAME is the name of
1969 the new file (for copy) or the new name of the file (for rename).
1970 OK-IF-ALREADY-EXISTS means don't barf if NEWNAME exists already.
1971 KEEP-DATE means to make sure that NEWNAME has the same timestamp
1972 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
1973 the uid and gid if both files are on the same host.
1974 PRESERVE-SELINUX-CONTEXT activates selinux commands.
1976 This function is invoked by `tramp-sh-handle-copy-file' and
1977 `tramp-sh-handle-rename-file'. It is an error if OP is neither
1978 of `copy' and `rename'. FILENAME and NEWNAME must be absolute
1979 file names."
1986 pr tm)
1996 filename newname)
1999 ;; Both are Tramp files.
2004 ;; Shortcut: if method, host, user are the same for
2005 ;; both files, we invoke `cp' or `mv' on the remote
2006 ;; host directly.
2009 op filename newname
2010 ok-if-already-exists keep-date preserve-uid-gid))
2012 ;; Try out-of-band operation.
2016 op filename newname keep-date))
2018 ;; No shortcut was possible. So we copy the file
2019 ;; first. If the operation was `rename', we go back
2020 ;; and delete the original file (if the copy was
2021 ;; successful). The approach is simple-minded: we
2022 ;; create a new buffer, insert the contents of the
2023 ;; source file into it, then write out the buffer to
2024 ;; the target file. The advantage is that it doesn't
2025 ;; matter which filename handlers are used for the
2026 ;; source and target file.
2029 op filename newname keep-date))))))
2031 ;; One file is a Tramp file, the other one is local.
2034 ;; Fast track on local machine.
2037 op filename newname
2038 ok-if-already-exists keep-date preserve-uid-gid))
2040 ;; If the Tramp file has an out-of-band method, the
2041 ;; corresponding copy-program can be invoked.
2045 op filename newname keep-date))
2047 ;; Use the inline method via a Tramp buffer.
2049 op filename newname keep-date))))
2052 ;; One of them must be a Tramp file.
2055 ;; Handle `preserve-selinux-context'.
2058 ;; In case of `rename', we must flush the cache of the source file.
2064 ;; When newname did exist, we have wrong cached values.
2071 "Use an Emacs buffer to copy or rename a file.
2072 First arg OP is either `copy' or `rename' and indicates the operation.
2073 FILENAME is the source file, NEWNAME the target file.
2074 KEEP-DATE is non-nil if NEWNAME should have the same timestamp as FILENAME."
2076 ;; We must disable multibyte, because binary data shall not be
2077 ;; converted.
2082 ;; We don't want the target file to be compressed, so we let-bind
2083 ;; `jka-compr-inhibit' to t.
2087 ;; KEEP-DATE handling.
2089 ;; Set the mode.
2091 ;; If the operation was `rename', delete the original file.
2096 "Invokes `cp' or `mv' on the remote system.
2097 OP must be one of `copy' or `rename', indicating `cp' or `mv',
2098 respectively. FILENAME specifies the file to copy or rename,
2099 NEWNAME is the name of the new file (for copy) or the new name of
2100 the file (for rename). Both files must reside on the same host.
2101 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2102 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2103 the uid and gid from FILENAME."
2113 v 'file-error
2114 "Unknown operation `%s', must be `copy' or `rename'"
2115 op))))
2119 filename))
2123 newname))
2125 cmd-result)
2128 ;; Both files are on a remote host, with same user.
2140 ;; Mask cp -f error.
2142 tramp-operation-not-permitted-regexp nil t))
2143 cmd-result)
2145 nil v 'file-error
2146 "Copying directly failed, see buffer `%s' for details."
2149 ;; We are on the local host.
2152 ;; We can do it directly.
2160 localname1 localname2 ok-if-already-exists
2161 keep-date preserve-uid-gid)
2165 ;; We can do it directly with `tramp-send-command'
2173 ok-if-already-exists keep-date t)
2174 ;; We must change the ownership to the local user.
2180 ;; We need a temporary file in between.
2182 ;; Create the temporary file.
2190 "%s %s %s" cmd
2193 "Copying directly failed, see buffer `%s' for details."
2195 ;; We must change the ownership as remote user.
2196 ;; Since this does not work reliable, we also
2197 ;; give read permissions.
2208 localname1 tmpfile t
2209 keep-date preserve-uid-gid)
2211 'rename-file
2213 ;; We must change the ownership as local user.
2214 ;; Since this does not work reliable, we also
2215 ;; give read permissions.
2219 tmpfile
2223 ;; Move the temporary file to its destination.
2228 "cp -f -p %s %s"
2231 "Copying directly failed, see buffer `%s' for details."
2235 'rename-file
2238 ;; Save exit.
2241 ;; Set the time and mode. Mask possible errors.
2248 "Invoke rcp program to copy.
2249 The method used must be an out-of-band method."
2253 copy-program copy-args copy-env copy-keep-date port spec
2254 source target)
2259 ;; Both are Tramp files. We shall optimize it when the
2260 ;; methods for filename and newname are the same.
2270 op filename tmpfile keep-date)
2273 ;; Save exit.
2280 ;; Set variables for computing the prompt for reading
2281 ;; password.
2286 ;; Expand hops. Might be necessary for gateway methods.
2290 ;; Check which ones of source and target are Tramp files.
2297 'file-name-directory
2301 ;; Check for host and port number. We cannot use
2302 ;; `tramp-file-name-port', because this returns also
2303 ;; `tramp-default-port', which might clash with settings in
2304 ;; "~/.ssh/config".
2311 ;; Compose copy command.
2313 ?h host ?u user ?p port
2321 copy-args
2323 ;; " " has either been a replacement of "%k" (when
2324 ;; keep-date argument is non-nil), or a replacement
2325 ;; for the whole keep-date sublist.
2326 " "
2330 copy-args)
2333 copy-args
2336 copy-env
2338 nil
2345 ;; Check for program.
2354 ;; The default directory must be remote.
2358 ;; Set the transfer process properties.
2368 ;; Use an asynchronous process. By this, password can
2369 ;; be handled. The default directory must be local, in
2370 ;; order to apply the correct `copy-program'. We don't
2371 ;; set a timeout, because the copying of large files can
2372 ;; last longer than 60 secs.
2378 copy-program
2385 p v nil tramp-actions-copy-out-of-band)))
2387 ;; Reset the transfer process properties.
2392 ;; Handle KEEP-DATE argument.
2396 ;; Set the mode.
2401 ;; If the operation was `rename', delete the original file.
2408 "Like `make-directory' for Tramp files."
2420 "Like `delete-directory' for Tramp files."
2432 "Like `delete-file' for Tramp files."
2443 ;; Dired.
2445 ;; CCC: This does not seem to be enough. Something dies when
2446 ;; we try and delete two directories under Tramp :/
2448 "Recursively delete the directory given.
2449 This is like `dired-recursive-delete-directory' for Tramp files."
2451 ;; Run a shell command 'rm -r <localname>'
2452 ;; Code shamelessly stolen from the dired implementation and, um, hacked :)
2455 ;; Which is better, -r or -R? (-r works for me <daniel@danann.net>)
2457 v
2459 ;; Don't read the output, do it explicitly.
2460 nil t)
2461 ;; Wait for the remote system to return to us...
2462 ;; This might take a while, allow it plenty of time.
2464 ;; Make sure that it worked...
2472 "Like `dired-compress-file' for Tramp files."
2473 ;; OK-FLAG is valid for XEmacs only, but not implemented.
2474 ;; Code stolen mainly from dired-aux.el.
2480 ;; Emacs case
2482 ;; XEmacs has `dired-compression-method-alist', which is
2483 ;; transformed into `dired-compress-file-suffixes' structure.
2487 nil
2490 suffix)
2491 ;; See if any suffix rule matches this file name.
2499 nil)
2501 ;; We found an uncompression rule.
2507 ;; `dired-remove-file' is not defined in XEmacs.
2512 ;; We don't recognize the file as compressed, so compress it.
2513 ;; Try gzip.
2518 ;; `dired-remove-file' is not defined in XEmacs.
2528 "Like `insert-directory' for Tramp files."
2554 ;; If `full-directory-p', we just say `ls -l FILENAME'.
2555 ;; Else we chdir to the parent directory, then say `ls -ld BASENAME'.
2558 v
2561 switches
2563 localname
2566 v
2570 "Couldn't `cd %s'"
2574 v
2577 switches
2582 ""
2587 ;; We cannot use `insert-buffer-substring' because the Tramp
2588 ;; buffer changes its contents before insertion due to calling
2589 ;; `expand-file' and alike.
2594 ;; Check for "--dired" output.
2601 ;; Now read the numeric positions of file names.
2607 ;; End is followed by \n or by " -> ".
2609 ;; Remove trailing lines.
2615 ;; Some busyboxes are reluctant to discard colors.
2621 ;; The inserted file could be from somewhere else.
2628 "."
2635 ;; Canonicalization of file names.
2638 "Like `expand-file-name' for Tramp files.
2640 the result will be a local, non-Tramp, filename."
2641 ;; If DIR is not given, use DEFAULT-DIRECTORY or "/".
2643 ;; Unless NAME is absolute, concat DIR and NAME.
2646 ;; If NAME is not a Tramp file, run the real handler.
2649 ;; Dissect NAME.
2653 ;; Tilde expansion if necessary. This needs a shell which
2654 ;; groks tilde expansion! The function `tramp-find-shell' is
2655 ;; supposed to find such a shell on the remote host. Please
2656 ;; tell me about it when this doesn't work on your system.
2660 ;; We cannot simply apply "~/", because under sudo "~/" is
2661 ;; expanded to the local user home directory but to the
2662 ;; root home directory. On the other hand, using always
2663 ;; the default user name for tilde expansion is not
2664 ;; appropriate either, because ssh and companions might
2665 ;; use a user name from the config file.
2677 ;; There might be a double slash, for example when "~/"
2678 ;; expands to "/". Remove this.
2681 ;; No tilde characters in file name, do normal
2682 ;; `expand-file-name' (this does "/./" and "/../"). We bind
2683 ;; `directory-sep-char' here for XEmacs on Windows, which would
2684 ;; otherwise use backslash. `default-directory' is bound,
2685 ;; because on Windows there would be problems with UNC shares or
2686 ;; Cygwin mounts.
2690 method user host
2695 ;;; Remote commands:
2698 "Like `executable-find' for Tramp files."
2703 "Flush file caches."
2711 ;; We use BUFFER also as connection buffer during setup. Because of
2712 ;; this, its original contents must be saved, and restored once
2713 ;; connection has been setup.
2715 "Like `start-file-process' for Tramp files."
2717 ;; When PROGRAM is nil, we just provide a tty.
2722 ;; Use a human-friendly prompt, for example for `shell'.
2726 tramp-initial-end-of-output))
2738 ;; BUFFER can be nil. We use a temporary buffer.
2741 ;; NAME must be unique as process name.
2745 ;; Set the new process properties.
2748 ;; Activate narrowing in order to save BUFFER contents.
2749 ;; Clear also the modification time; otherwise we might
2750 ;; be interrupted by `verify-visited-file-modtime'.
2756 ;; Send the command.
2758 ;; Check, whether a pty is associated.
2763 v 'file-error
2766 ;; Set query flag for this process.
2768 ;; Return process.
2769 p)))
2770 ;; Save exit.
2782 "Like `process-file' for Tramp files."
2783 ;; The implementation is not complete yet.
2789 ;; Compute command.
2792 ;; Determine input.
2797 ;; INFILE is on the same remote host.
2799 ;; INFILE must be copied to remote host.
2805 ;; Determine output.
2807 ;; Just a buffer.
2810 ;; A buffer name.
2813 ;; (REAL-DESTINATION ERROR-DESTINATION)
2815 ;; output.
2823 ;; stderr.
2828 ;; stderr is on the same remote host.
2831 ;; stderr must be copied to remote host. The temporary
2832 ;; file must be deleted after execution.
2835 method user host stderr))))
2836 ;; stderr to be discarded.
2839 ;; 't
2844 ;; Send the command. It might not return in time, so we protect
2845 ;; it. Call it in a subshell, in order to preserve working
2846 ;; directory.
2853 command)
2854 t t)
2856 ;; We should show the output anyway.
2863 ;; When the user did interrupt, we should do it also. We use
2864 ;; return code -1 as marker.
2868 ;; Handle errors.
2873 ;; Provide error file.
2876 ;; Cleanup. We remove all file cache values for the connection,
2877 ;; because the remote process could have changed them.
2880 ;; `process-file-side-effects' has been introduced with GNU
2881 ;; Emacs 23.2. If set to `nil', no remote file will be changed
2882 ;; by `program'. If it doesn't exist, we assume its default
2883 ;; value `t'.
2888 ;; Return exit status.
2891 ret))))
2895 "Like `call-process-region' for Tramp files."
2904 "Like `file-local-copy' for Tramp files."
2908 v 'file-error
2918 ;; `copy-file' handles direct copy and out-of-band methods.
2923 ;; Use inline encoding for file transfer.
2933 ;; If local decoding is a function, we call it. We
2934 ;; must disable multibyte, because
2935 ;; `uudecode-decode-region' doesn't handle it
2936 ;; correctly.
2942 filename loc-dec)
2944 ;; Unset `file-name-handler-alist'. Otherwise,
2945 ;; epa-file gets confused.
2950 ;; If tramp-decoding-function is not defined for this
2951 ;; method, we invoke tramp-decoding-command instead.
2953 ;; Unset `file-name-handler-alist'. Otherwise,
2954 ;; epa-file gets confused.
2960 filename loc-dec)
2963 loc-dec tmpfile2 tmpfile)
2966 ;; Set proper permissions.
2968 ;; Set local user ownership.
2971 ;; Oops, I don't know what to do.
2975 ;; Error handling.
2981 tmpfile)))
2983 ;; This is needed for XEmacs only. Code stolen from files.el.
2986 "Like `insert-file-contents-literally' for Tramp files."
2994 nil))
3001 ;; Save exit.
3007 "Like `make-auto-save-file-name' for Tramp files.
3008 Returns a file name in `tramp-auto-save-directory' for autosaving this file."
3019 ;; File name must be unique. This is ensured with Emacs 22 (see
3020 ;; UNIQUIFY element of `auto-save-file-name-transforms'); but for
3021 ;; all other cases we must do it ourselves.
3031 ;; Create directory.
3037 ;; Run plain `make-auto-save-file-name'. There might be an advice when
3038 ;; it is not a magic file name operation (since Emacs 22).
3039 ;; We must deactivate it temporarily.
3042 ;; else
3048 ;; CCC grok LOCKNAME
3051 "Like `write-region' for Tramp files."
3054 ;; Following part commented out because we don't know what to do about
3055 ;; file locking, and it does not appear to be a problem to ignore it.
3056 ;; Ange-ftp ignores it, too.
3057 ;; (when (and lockname (stringp lockname))
3058 ;; (setq lockname (expand-file-name lockname)))
3059 ;; (unless (or (eq lockname nil)
3060 ;; (string= lockname filename))
3061 ;; (error
3062 ;; "tramp-sh-handle-write-region: LOCKNAME must be nil or equal FILENAME"))
3064 ;; XEmacs takes a coding system as the seventh argument, not `confirm'.
3075 ;; `file-writable-p' calls `file-expand-file-name'. We
3076 ;; cannot use `tramp-run-real-handler' therefore.
3082 ;; Short track: if we are on the local host, we can run directly.
3084 'write-region
3088 ;; We use this to save the value of
3089 ;; `last-coding-system-used' after writing the tmp
3090 ;; file. At the end of the function, we set
3091 ;; `last-coding-system-used' to this saved value. This
3092 ;; way, any intermediary coding systems used while
3093 ;; talking to the remote shell or suchlike won't hose
3094 ;; this variable. This approach was snarfed from
3095 ;; ange-ftp.el.
3096 coding-system-used
3097 ;; Write region into a tmp file. This isn't really
3098 ;; needed if we use an encoding function, but currently
3099 ;; we use it always because this makes the logic
3100 ;; simpler.
3104 ;; If `append' is non-nil, we copy the file locally, and let
3105 ;; the native `write-region' implementation do the job.
3108 ;; We say `no-message' here because we don't want the
3109 ;; visited file modtime data to be clobbered from the temp
3110 ;; file. We call `set-visited-file-modtime' ourselves later
3111 ;; on. We must ensure that `file-coding-system-alist'
3112 ;; matches `tmpfile'.
3118 'write-region
3125 ;; Now, `last-coding-system-used' has the right value. Remember it.
3130 ;; The permissions of the temporary file should be set. If
3131 ;; filename does not exist (eq modes nil) it has been
3132 ;; renamed to the backup file. This case `save-buffer'
3133 ;; handles permissions.
3134 ;; Ensure that it is still readable.
3137 tmpfile
3140 ;; This is a bit lengthy due to the different methods
3141 ;; possible for file transfer. First, we check whether the
3142 ;; method uses an rcp program. If so, we call it.
3143 ;; Otherwise, both encoding and decoding command must be
3144 ;; specified. However, if the method _also_ specifies an
3145 ;; encoding function, then that is used for encoding the
3146 ;; contents of the tmp file.
3151 ;; `copy-file' handles direct copy and out-of-band methods.
3162 ;; We keep the local file for performance
3163 ;; reasons, useful for "rsync".
3170 ;; Don't rename, in order to keep context in SELinux.
3175 ;; Use inline file transfer.
3177 ;; Encode tmpfile.
3181 ;; Use encoding function or command.
3185 loc-enc)
3188 ;; The following `let' is a workaround for the
3189 ;; base64.el that comes with pgnus-0.84. If
3190 ;; both of the following conditions are
3191 ;; satisfied, it tries to write to a local
3192 ;; file in default-directory, but at this
3193 ;; point, default-directory is remote.
3194 ;; (`call-process-region' can't write to
3195 ;; remote files, it seems.) The file in
3196 ;; question is a tmp file anyway.
3203 loc-enc)
3205 loc-enc tmpfile t))
3207 v 'file-error
3210 filename loc-enc))))
3212 ;; Send buffer into remote decoding command which
3213 ;; writes to remote file. Because this happens on
3214 ;; the remote host, we cannot use the function.
3216 v 3
3221 v
3227 v nil
3228 "Couldn't write region to `%s', decode using `%s' failed"
3229 filename rem-dec)
3230 ;; When `file-precious-flag' is set, the region is
3231 ;; written to a temporary file. Check that the
3232 ;; checksum is equal to that from the local tmpfile.
3236 ;; cksum runs locally, if possible.
3238 ;; cksum runs remotely.
3240 v
3243 ;; ... they are different.
3250 v 'file-error
3253 filename rem-dec)))))
3255 ;; Save exit.
3258 ;; That's not expected.
3261 v 'file-error
3264 method))))
3266 ;; Make `last-coding-system-used' have the right value.
3273 ;; We must protect `last-coding-system-used', now we have set it
3274 ;; to its correct value.
3276 ;; Set file modification time.
3280 ;; We must pass modtime explicitly, because filename can
3281 ;; be different from (buffer-file-name), f.e. if
3282 ;; `file-precious-flag' is set.
3288 ;; Set the ownership.
3298 ;; VC backends check for the existence of various different special
3299 ;; files. This is very time consuming, because every single check
3300 ;; requires a remote command (the file cache must be invalidated).
3301 ;; Therefore, we apply a kind of optimization. We install the file
3302 ;; name handler `tramp-vc-file-name-handler', which does nothing but
3303 ;; remembers all file names for which `file-exists-p' or
3304 ;; `file-readable-p' has been applied. A first run of `vc-registered'
3305 ;; is performed. Afterwards, a script is applied for all collected
3306 ;; file names, using just one remote command. The result of this
3307 ;; script is used to fill the file cache with actual values. Now we
3308 ;; can reset the file name handlers, and we make a second run of
3309 ;; `vc-registered', which returns the expected result without sending
3310 ;; any other remote command.
3312 "Like `vc-registered' for Tramp files."
3318 ;; There could be new files, created by the vc backend. We
3319 ;; cannot reuse the old cache entries, therefore.
3325 ;; Here we collect only file names, which need an operation.
3329 ;; Send just one command, in order to fill the cache.
3332 v
3341 v
3345 tramp-vc-registered-file-names
3351 ;; Second run. Now all `file-exists-p' or `file-readable-p'
3352 ;; calls shall be answered from the file cache. We unset
3353 ;; `process-file-side-effects' in order to keep the cache when
3354 ;; `process-file' calls appear.
3358 ;;;###tramp-autoload
3360 "Invoke remote-shell Tramp file name handler.
3361 Fall back to normal file name handler if no Tramp handler exists."
3378 "Invoke special file name handler, which collects files to be handled."
3386 ;; That's what we want: file names, for which checks are
3387 ;; applied. We assume that VC uses only `file-exists-p' and
3388 ;; `file-readable-p' checks; otherwise we must extend the
3389 ;; list. We do not perform any action, but return nil, in
3390 ;; order to keep `vc-registered' running.
3393 nil)
3394 ;; Tramp file name handlers like `expand-file-name'. They
3395 ;; must still work.
3398 ;; Default file name handlers, we don't care.
3401 ;;; Internal Functions:
3404 "Define in remote shell function NAME implemented as SCRIPT.
3405 Only send the definition if it has not already been done."
3406 ;; We cannot let-bind (tramp-get-connection-process vec) because it
3407 ;; might be nil.
3412 ;; The script could contain a call of Perl. This is masked with `%s'.
3414 vec
3425 auto-save-default)
3433 "Run `test' on the remote system, given a SWITCH and a FILENAME.
3434 Returns the exit code of the `test' program."
3437 v
3439 "%s %s %s"
3441 switch
3445 "Run `test'-like program on the remote system, given FILE1, FILE2.
3446 FORMAT-STRING contains the program name, switches, and place holders.
3447 Returns the exit code of the `test' program. Barfs if the methods,
3448 hosts, or files, disagree."
3452 v 'file-error
3457 v1
3464 "Searches for PROGNAME in $PATH and all directories mentioned in DIRLIST.
3465 First arg VEC specifies the connection, PROGNAME is the program
3466 to search for, and DIRLIST gives the list of directories to
3467 search. If IGNORE-TILDE is non-nil, directory names starting
3468 with `~' will be ignored. If IGNORE-PATH is non-nil, searches
3469 only in DIRLIST.
3471 Returns the absolute file name of PROGNAME, if found, and nil otherwise.
3473 This function expects to be in the right *tramp* buffer."
3476 ;; Check whether the executable is in $PATH. "which(1)" does not
3477 ;; report always a correct error code; therefore we check the
3478 ;; number of words it returns.
3486 ;; Remove all ~/foo directories from dirlist. In XEmacs,
3487 ;; `remove' is in CL, and we want to avoid CL dependencies.
3496 vec
3498 "do if test -x $d/%s -a -f $d/%s; "
3499 "then echo tramp_executable $d/%s; "
3508 result)))
3511 "Sets the remote environment PATH to existing directories.
3512 I.e., for each directory in `tramp-remote-path', it is tested
3513 whether it exists and if so, it is added to the environment
3514 variable PATH."
3520 ;; ------------------------------------------------------------
3521 ;; -- Communication with external shell --
3522 ;; ------------------------------------------------------------
3525 "Find a command on the remote host for checking if a file exists.
3526 Here, we are looking for a command which has zero exit status if the
3527 file exists and nonzero exit status otherwise."
3531 result)
3532 ;; The algorithm is as follows: we try a list of several commands.
3533 ;; For each command, we first run `$cmd /' -- this should return
3534 ;; true, as the root directory always exists. And then we run
3535 ;; `$cmd /this\ file\ does\ not\ exist ', hoping that the file indeed
3536 ;; does not exist. This should return false. We use the first
3537 ;; command we find that seems to work.
3538 ;; The list of commands to try is as follows:
3539 ;; `ls -d' This works on most systems, but NetBSD 1.4
3540 ;; has a bug: `ls' always returns zero exit
3541 ;; status, even for files which don't exist.
3542 ;; `test -e' Some Bourne shells have a `test' builtin
3543 ;; which does not know the `-e' option.
3544 ;; `/bin/test -e' For those, the `test' binary on disk normally
3545 ;; provides the option. Alas, the binary
3546 ;; is sometimes `/bin/test' and sometimes it's
3547 ;; `/usr/bin/test'.
3548 ;; `/usr/bin/test -e' In case `/bin/test' does not exist.
3572 result))
3575 "Opens shell SHELL."
3578 ;; Find arguments for this shell.
3581 item extra-args)
3590 t))
3591 ;; Setting prompts.
3599 "Opens a shell on the remote host which groks tilde expansion."
3606 ;; The default shell (ksh93) of OpenSolaris and Solaris
3607 ;; is buggy. We've got reports for "SunOS 5.10" and
3608 ;; "SunOS 5.11" so far.
3618 vec 'file-error
3627 vec "remote-shell"
3631 ;; Utility functions.
3634 "Wait for shell prompt and barf if none appears.
3635 Looks at process PROC to see if a shell prompt appears in TIMEOUT
3636 seconds. If not, it produces an error message with the given ERROR-ARGS."
3639 proc timeout
3645 "Set up an interactive shell.
3646 Mainly sets the prompt and the echo correctly. PROC is the shell
3647 process to set up. VEC specifies the connection."
3649 ;; It is useful to set the prompt in the following command because
3650 ;; some people have a setting for $PS1 which /bin/sh doesn't know
3651 ;; about and thus /bin/sh will display a strange prompt. For
3652 ;; example, if $PS1 has "${CWD}" in the value, then ksh will
3653 ;; display the current working directory but /bin/sh will display
3654 ;; a dollar sign. The following command line sets $PS1 to a sane
3655 ;; value, and works under Bourne-ish shells as well as csh-like
3656 ;; shells. Daniel Pittman reports that the unusual positioning of
3657 ;; the single quotes makes it work under `rc', too. We also unset
3658 ;; the variable $ENV because that is read by some sh
3659 ;; implementations (eg, bash when called as sh) on startup; this
3660 ;; way, we avoid the startup file clobbering $PS1. $PROMPT_COMMAND
3661 ;; is another way to set the prompt in /bin/bash, it must be
3662 ;; discarded as well.
3664 vec
3668 ;; Disable echo.
3671 ;; Check whether the echo has really been disabled. Some
3672 ;; implementations, like busybox of embedded GNU/Linux, don't
3673 ;; support disabling.
3680 ;; Make sure backspaces and their echo are enabled and no line
3681 ;; width magic interferes with them.
3691 ;; Try to set up the coding system correctly.
3692 ;; CCC this can't be the right way to do it. Hm.
3698 ;; Use MULE to select the right EOL convention for communicating
3699 ;; with the process.
3702 cs-decode cs-encode)
3717 ;; Look for ^M and do something useful if found.
3719 ;; We have found a ^M but cannot frob the process coding system
3720 ;; because we're running on a non-MULE Emacs. Let's try
3721 ;; stty, instead.
3726 ;; Check whether the output of "uname -sr" has been changed. If
3727 ;; yes, this is a strong indication that we must expire all
3728 ;; connection properties. We start again with
3729 ;; `tramp-maybe-open-connection', it will be catched there.
3734 vec "uname"
3738 ;; Keep the debug buffer.
3745 ;; We call `tramp-get-buffer' in order to keep the debug buffer.
3748 vec 3
3749 "Connection reset, because remote host changed from `%s' to `%s'"
3750 old-uname new-uname)
3753 ;; Check whether the remote host suffers from buggy
3754 ;; `send-process-string'. This is known for FreeBSD (see comment in
3755 ;; `send_process', file process.c). I've tested sending 624 bytes
3756 ;; successfully, sending 625 bytes failed. Emacs makes a hack when
3757 ;; this host type is detected locally. It cannot handle remote
3758 ;; hosts, though.
3762 tramp-chunksize)
3770 ;; Set remote PATH variable.
3773 ;; Search for a good shell before searching for a command which
3774 ;; checks if a file exists. This is done because Tramp wants to use
3775 ;; "test foo; echo $?" to check if various conditions hold, and
3776 ;; there are buggy /bin/sh implementations which don't execute the
3777 ;; "echo $?" part if the "test" part has an error. In particular,
3778 ;; the OpenSolaris /bin/sh is a problem. There are also other
3779 ;; problems with /bin/sh of OpenSolaris, like redirection of stderr
3780 ;; in function declarations, or changing HISTFILE in place.
3781 ;; Therefore, OpenSolaris' /bin/sh is replaced by bash, when
3782 ;; detected.
3785 ;; Disable unexpected output.
3788 ;; IRIX64 bash expands "!" even when in single quotes. This
3789 ;; destroys our shell functions, we must disable it. See
3790 ;; <http://stackoverflow.com/questions/3291692/irix-bash-shell-expands-expression-in-single-quotes-yet-shouldnt>.
3794 ;; On BSD-like systems, ?\t is expanded to spaces. Suppress this.
3799 ;; Set `remote-tty' process property.
3804 ;; Dump stty settings in the traces.
3808 ;; Set the environment.
3812 unset item)
3825 ;; CCC: We should either implement a Perl version of base64 encoding
3826 ;; and decoding. Then we just use that in the last item. The other
3827 ;; alternative is to use the Perl version of UU encoding. But then
3828 ;; we need a Lisp version of uuencode.
3829 ;;
3830 ;; Old text from documentation of tramp-methods:
3831 ;; Using a uuencode/uudecode inline method is discouraged, please use one
3832 ;; of the base64 methods instead since base64 encoding is much more
3833 ;; reliable and the commands are more standardized between the different
3834 ;; Unix versions. But if you can't use base64 for some reason, please
3835 ;; note that the default uudecode command does not work well for some
3836 ;; Unices, in particular AIX and Irix. For AIX, you might want to use
3837 ;; the following command for uudecode:
3838 ;;
3839 ;; sed '/^begin/d;/^[` ]$/d;/^end/d' | iconv -f uucode -t ISO8859-1
3840 ;;
3841 ;; For Irix, no solution is known yet.
3849 "perl -e 'binmode STDIN; binmode STDOUT; print pack(q{u*}, join q{}, <>)'"
3851 "List of local coding commands for inline transfer.
3852 Each item is a list that looks like this:
3854 \(FORMAT ENCODING DECODING\)
3856 FORMAT is symbol describing the encoding/decoding format. It can be
3857 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
3859 ENCODING and DECODING can be strings, giving commands, or symbols,
3860 giving functions. If they are strings, then they can contain
3862 filename will be put into the command line at that spot. If the
3863 specifier is not present, the input should be read from standard
3864 input.
3866 If they are functions, they will be called with two arguments, start
3867 and end of region, and are expected to replace the region contents
3872 ;; "-i" is more robust with older base64 from GNU coreutils.
3873 ;; However, I don't know whether all base64 versions do supports
3874 ;; this option.
3886 "perl -e 'binmode STDIN; binmode STDOUT; print pack(q{u*}, join q{}, <>)'"
3888 "List of remote coding commands for inline transfer.
3889 Each item is a list that looks like this:
3891 \(FORMAT ENCODING DECODING\)
3893 FORMAT is symbol describing the encoding/decoding format. It can be
3894 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
3896 ENCODING and DECODING can be strings, giving commands, or symbols,
3897 giving variables. If they are strings, then they can contain
3899 filename will be put into the command line at that spot. If the
3900 specifier is not present, the input should be read from standard
3901 input.
3903 If they are variables, this variable is a string containing a Perl
3904 implementation for this functionality. This Perl program will be transferred
3908 "Find an inline transfer encoding that works.
3909 Goes through the list `tramp-local-coding-commands' and
3910 `tramp-remote-coding-commands'."
3914 loc-enc loc-dec rem-enc rem-dec litem ritem found)
3922 ;; If the local encoder or decoder is a string, the
3923 ;; corresponding command has to work locally.
3930 loc-enc nil nil))
3938 loc-dec nil nil))
3940 ;; Search for remote coding commands with the same format
3947 ;; Check if remote encoding and decoding commands can be
3948 ;; called remotely with null input and output. This makes
3949 ;; sure there are no syntax errors and the command is really
3950 ;; found. Note that we do not redirect stdout to /dev/null,
3951 ;; for two reasons: when checking the decoding command, we
3952 ;; actually check the output it gives. And also, when
3953 ;; redirecting "mimencode" output to /dev/null, then as root
3954 ;; it might change the permissions of /dev/null!
3962 vec 5
3975 vec 5
3978 vec
3980 t)
3988 ;; `rem-enc' and `rem-dec' could be a string meanwhile.
3993 ;; Did we find something?
3998 ;; Set connection properties.
4009 "Call the local encoding or decoding command.
4011 Otherwise, INPUT is passed via standard input.
4012 INPUT can also be nil which means `/dev/null'.
4013 OUTPUT can be a string (which specifies a filename), or t (which
4014 means standard output and thus the current buffer), or nil (which
4015 means discard it)."
4017 tramp-encoding-shell
4020 nil
4021 tramp-encoding-command-switch
4031 "List of compress and decompress commands for inline transfer.
4032 Each item is a list that looks like this:
4034 \(COMPRESS DECOMPRESS\)
4039 "Find an inline transfer compress command that works.
4040 Goes through the list `tramp-inline-compress-commands'."
4044 item compress decompress
4045 found)
4052 vec 5
4053 "Checking local compress command `%s', `%s' for sanity"
4054 compress decompress)
4059 ;; Windows shells need the program file name after
4060 ;; the pipe symbol be quoted if they use forward
4061 ;; slashes as directory separators.
4068 vec 5
4069 "Checking remote compress command `%s', `%s' for sanity"
4070 compress decompress)
4076 ;; Did we find something?
4079 ;; Set connection properties.
4093 "Expands VEC according to `tramp-default-proxies-alist'.
4094 Gateway hops are already opened."
4097 item proxy)
4099 ;; Look for proxy hosts to be passed.
4104 ;; host
4107 ;; user
4111 ;; No more hops needed.
4113 ;; Replace placeholders.
4116 proxy
4121 ;; Add the hop.
4123 ;; Start next search.
4126 ;; Handle gateways.
4133 ;; Is the method prepared for gateways?
4136 vec 'file-error
4138 ;; Open the gateway connection.
4140 'target-alist
4144 ;; For the password prompt, we need the correct values.
4145 ;; Therefore, we must remember the gateway vector. But we
4146 ;; cannot do it as connection property, because it shouldn't
4147 ;; be persistent. And we have no started process yet either.
4150 ;; Foreign and out-of-band methods are not supported for multi-hops.
4163 vec 'file-error
4164 "Method `%s' is not supported for multi-hops."
4167 ;; In case the host name is not used for the remote shell
4168 ;; command, the user could be misguided by applying a random
4169 ;; hostname.
4175 ;; There are multi-hops.
4177 ;; The host name is used for the remote shell command.
4180 ;; The host is local. We cannot use `tramp-local-host-p'
4181 ;; here, because it opens a connection as well.
4184 v 'file-error
4185 "Host `%s' looks like a remote host, `%s' can only use the local host"
4186 host method)))
4188 ;; Result.
4189 target-alist))
4192 "Maybe open a connection VEC.
4193 Does not do anything if a connection is already open, but re-opens the
4194 connection if a previous connection has died for some reason."
4201 ;; If too much time has passed since last command was sent, look
4202 ;; whether process is still alive. If it isn't, kill it. When
4203 ;; using ssh, it can sometimes happen that the remote end has
4204 ;; hung up but the local ssh client doesn't recognize this until
4205 ;; it tries to send some data to the remote end. So that's why
4206 ;; we try to send a command from time to time, then look again
4207 ;; whether the process is really alive.
4218 ;; The error will be catched locally.
4226 ;; New connection must be opened.
4229 ;; We call `tramp-get-buffer' in order to get a debug buffer for
4230 ;; messages from the beginning.
4233 vec 3
4243 ;; Start new process.
4254 ;; This must be done in order to avoid our file name handler.
4258 'start-process
4263 tramp-encoding-command-interactive)
4266 ;; Set sentinel and query flag.
4274 ;; Check whether process is alive.
4278 ;; Now do all the connections as specified.
4299 ;; We don't create the temporary file. In fact,
4300 ;; it is just a prefix for the ControlPath option
4301 ;; of ssh; the real temporary file has another
4302 ;; name, and it is created and protected by ssh.
4303 ;; It is also removed by ssh when the connection
4304 ;; is closed.
4307 p "temp-file"
4310 tramp-temp-name-prefix
4312 spec)
4314 ;; Add arguments for asynchronous processes.
4318 ;; Add gateway arguments if necessary.
4322 ;; Check for port number. Until now, there's no need
4323 ;; for handling like method, user, host.
4328 ;; Set variables for computing the prompt for reading
4329 ;; password. They can also be derived from a gateway.
4334 ;; Replace login-args place holders.
4340 ?h l-host ?u l-user ?p l-port ?t tmpfile)
4341 command
4343 ;; We do not want to see the trailing local prompt in
4344 ;; `start-file-process'.
4346 command " "
4352 ;; Local shell could be a Windows COMSPEC. It
4353 ;; doesn't know the ";" syntax, but we must exit
4354 ;; always for `start-file-process'. "exec" does not
4355 ;; work either.
4358 ;; Send the command.
4364 ;; Next hop.
4367 ;; Make initial shell settings.
4371 "Send the COMMAND to connection VEC.
4372 Erases temporary buffer before sending the command. If optional
4373 arg NEVEROPEN is non-nil, never try to open the connection. This
4374 is meant to be used from `tramp-maybe-open-connection' only. The
4375 function waits for output unless NOOUTPUT is set."
4379 ;; We mark the command string that it can be erased in the output buffer.
4383 ;; Unset $PS1 when using here documents, in order to avoid
4384 ;; multiple prompts.
4386 ;; Send the command.
4392 "Wait for output from remote command."
4398 ;; be leading escape sequences, which must be ignored.
4400 ;; Sometimes, the commands do not return a newline but a
4401 ;; null byte before the shell prompt, for example "git
4402 ;; ls-files -c -z ...".
4407 ;; A simple-minded busybox has sent " ^H" sequences.
4408 ;; Delete them.
4413 ;; Delete the prompt.
4419 proc 'file-error
4420 "[[Remote prompt `%s' not found in %d secs]]"
4421 tramp-end-of-output timeout)
4423 proc 'file-error
4425 ;; Return value is whether end-of-output sentinel was found.
4426 found)))
4430 "Run COMMAND and check its exit status.
4431 Sends `echo $?' along with the COMMAND for checking the exit status. If
4432 COMMAND is nil, just sends `echo $?'. Returns the exit status found.
4434 If the optional argument SUBSHELL is non-nil, the command is
4435 executed in a subshell, ie surrounded by parentheses. If
4436 DONT-SUPPRESS-ERR is non-nil, stderr won't be sent to /dev/null."
4438 vec
4440 command
4442 "echo tramp_exit_status $?"
4456 "Run COMMAND, check exit status, throw error if exit status not okay.
4457 Similar to `tramp-send-command-and-check' but accepts two more arguments
4458 FMT and ARGS which are passed to `error'."
4463 "Run COMMAND and return the output, which must be a Lisp expression.
4464 In case there is no valid Lisp expression and NOERROR is nil, it
4465 raises an error."
4471 ;; Read the expression.
4475 ;; Error handling.
4480 vec 'file-error
4481 "`%s' does not return a valid Lisp expression: `%s'"
4485 "Convert file-attributes ATTR generated by perl script, stat or ls.
4486 Convert file mode bits to string and set virtual device number.
4487 Return ATTR."
4489 ;; Remove color escape sequences from symlink.
4493 ;; Convert last access time.
4498 ;; Convert last modification time.
4503 ;; Convert last status change time.
4508 ;; Convert file size.
4514 ;; Convert file mode bits to string.
4519 ;; Convert directory indication bit.
4522 ;; Convert symlink from `tramp-do-file-attributes-with-stat'.
4528 ;; Set file's gid change bit.
4536 ;; Convert inode.
4542 ;; Inodes can be incredible huge. We must hide this.
4544 ;; Set virtual device number.
4547 attr))
4550 "Check `file-attributes' caches for VEC.
4551 Return t if according to the cache access type ACCESS is known to
4552 be granted."
4560 result
4562 result
4574 file-attr
4576 ;; Not a symlink
4580 ;; World accessible.
4582 ;; User accessible and owned by user.
4586 ;; Group accessible and owned by user's
4587 ;; principal group.
4593 "Turn an integer representing a file mode into an ls(1)-like string."
4608 "Convert a permission bitset into a string.
4609 This is used internally by `tramp-file-mode-from-int'."
4620 "Converts STRING to shell glob pattern which ignores case."
4626 string
4630 "Create a file name suitable to be passed to `rcp' and workalikes."
4640 "Return t if this is an out-of-band method, nil otherwise."
4642 ;; It shall be an out-of-band method.
4644 ;; There must be a size, otherwise the file doesn't exist.
4646 ;; Either the file size is large enough, or (in rare cases) there
4647 ;; does not exist a remote encoding.
4652 ;; Variables local to connection.
4656 ;; When `tramp-own-remote-path' is in `tramp-remote-path', we
4657 ;; cache the result for the session only. Otherwise, the result
4658 ;; is cached persistently.
4661 vec)
4662 "remote-path"
4671 ;; Default if "getconf" is not available.
4674 vec 3
4685 nil)))))
4687 ;; Replace place holder `tramp-default-remote-path'.
4695 ;; Replace place holder `tramp-own-remote-path'.
4703 ;; Remove double entries.
4710 ;; Remove non-existing directories.
4712 nil
4722 x))
4723 x))
4724 remote-path)))))
4733 result)
4735 ;; Check parameters. On busybox, "ls" output coloring is
4736 ;; enabled by default sometimes. So we try to disable it
4737 ;; when possible. $LS_COLORING is not supported there.
4738 ;; Some "ls" versions are sensible wrt the order of
4739 ;; arguments, they fail when "-al" is after the
4740 ;; "--color=never" argument (for example on FreeBSD).
4755 ;; Some "ls" versions are sensible wrt the order of arguments,
4756 ;; they fail when "-al" is after the "--dired" argument (for
4757 ;; example on FreeBSD).
4765 "test"
4769 ;; Does `test A -nt B' work? Use abominable `find' construct if it
4770 ;; doesn't. BSD/OS 4.0 wants the parentheses around the command,
4771 ;; for otherwise the shell crashes.
4783 vec
4806 ;; We must check also for some Perl modules.
4814 result)))
4821 tmp)
4822 ;; Check whether stat(1) returns usable syntax. "%s" does not
4823 ;; work on older AIX systems.
4832 result)))
4842 result))))
4855 result)
4857 ;; Check POSIX parameter.
4866 vec
4872 ;; The command might not always return a number.
4878 vec
4884 ;; The command might not always return a number.
4893 ;; Some predefined connection properties.
4895 "Return the compress command related to PROP.
4896 PROP is either `inline-compress' or `inline-decompress'. SIZE is
4897 the length of the file to be compressed.
4899 If no corresponding command is found, nil is returned."
4907 "Return the coding command related to PROP.
4908 PROP is either `remote-encoding', `remode-decoding',
4909 `local-encoding' or `local-decoding'.
4911 SIZE is the length of the file to be coded. Depending on SIZE,
4912 compression might be applied.
4914 If no corresponding command is found, nil is returned.
4915 Otherwise, either a string is returned which contains a `%s' mark
4916 to be used for the respective input or output file; or a Lisp
4917 function cell is returned to be applied on a buffer."
4918 ;; We must catch the errors, because we want to return `nil', when
4919 ;; no inline coding is found.
4927 compress)
4928 ;; The connection property might have been cached. So we must
4929 ;; send the script to the remote side - maybe.
4937 ;; Check for the `compress' command.
4939 ;; Return the value.
4955 'call-process-region beg end
4960 coding)
4963 ;; Windows shells need the program file name after
4964 ;; the pipe symbol be quoted if they use forward
4965 ;; slashes as directory separators.
4970 coding compress))
4973 ;; Windows shells need the program file name after
4974 ;; the pipe symbol be quoted if they use forward
4975 ;; slashes as directory separators.
4980 compress coding))
4986 ;;; Integration of eshell.el:
4991 ;; eshell.el keeps the path in `eshell-path-env'. We must change it
4992 ;; when `default-directory' points to another host.
4994 "Set `eshell-path-env' to $PATH of the host related to `default-directory'."
4999 'identity
5020 ;;; TODO:
5022 ;; * Don't use globbing for directories with many files, as this is
5023 ;; likely to produce long command lines, and some shells choke on
5024 ;; long command lines.
5025 ;; * Make it work for different encodings, and for different file name
5026 ;; encodings, too. (Daniel Pittman)
5027 ;; * Don't search for perl5 and perl. Instead, only search for perl and
5028 ;; then look if it's the right version (with `perl -v').
5029 ;; * When editing a remote CVS controlled file as a different user, VC
5030 ;; gets confused about the file locking status. Try to find out why
5031 ;; the workaround doesn't work.
5032 ;; * Allow out-of-band methods as _last_ multi-hop. Open a connection
5033 ;; until the last but one hop via `start-file-process'. Apply it
5034 ;; also for ftp and smb.
5035 ;; * WIBNI if we had a command "trampclient"? If I was editing in
5036 ;; some shell with root privileges, it would be nice if I could
5037 ;; just call
5038 ;; trampclient filename.c
5039 ;; as an editor, and the _current_ shell would connect to an Emacs
5040 ;; server and would be used in an existing non-privileged Emacs
5041 ;; session for doing the editing in question.
5042 ;; That way, I need not tell Emacs my password again and be afraid
5043 ;; that it makes it into core dumps or other ugly stuff (I had Emacs
5044 ;; once display a just typed password in the context of a keyboard
5045 ;; sequence prompt for a question immediately following in a shell
5046 ;; script run within Emacs -- nasty).
5047 ;; And if I have some ssh session running to a different computer,
5048 ;; having the possibility of passing a local file there to a local
5049 ;; Emacs session (in case I can arrange for a connection back) would
5050 ;; be nice.
5051 ;; Likely the corresponding Tramp server should not allow the
5052 ;; equivalent of the emacsclient -eval option in order to make this
5053 ;; reasonably unproblematic. And maybe trampclient should have some
5054 ;; way of passing credentials, like by using an SSL socket or
5055 ;; something. (David Kastrup)
5056 ;; * Reconnect directly to a compliant shell without first going
5057 ;; through the user's default shell. (Pete Forman)
5058 ;; * How can I interrupt the remote process with a signal
5059 ;; (interrupt-process seems not to work)? (Markus Triska)
5060 ;; * Avoid the local shell entirely for starting remote processes. If
5061 ;; so, I think even a signal, when delivered directly to the local
5062 ;; SSH instance, would correctly be propagated to the remote process
5063 ;; automatically; possibly SSH would have to be started with
5064 ;; "-t". (Markus Triska)
5065 ;; * It makes me wonder if tramp couldn't fall back to ssh when scp
5066 ;; isn't on the remote host. (Mark A. Hershberger)
5067 ;; * Use lsh instead of ssh. (Alfred M. Szmidt)
5068 ;; * Optimize out-of-band copying when both methods are scp-like (not
5069 ;; rsync).
5070 ;; * Keep a second connection open for out-of-band methods like scp or
5071 ;; rsync.
5072 ;; * Try telnet+curl as new method. It might be useful for busybox,
5073 ;; without built-in uuencode/uudecode.
5075 ;;; tramp-sh.el ends here