| blob | cb4aca12edbe5ccd66ca28dc69861fc4836ffdf5 |
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:
33 ;; Pacify byte-compiler. The function is needed on XEmacs only. I'm
34 ;; not sure at all that this is the right way to do it, but let's hope
35 ;; it works for now, and wait for a guru to point out the Right Way to
36 ;; achieve this.
37 ;;(eval-when-compile
38 ;; (unless (fboundp 'dired-insert-set-properties)
39 ;; (fset 'dired-insert-set-properties 'ignore)))
40 ;; Gerd suggests this:
42 ;; Note that dired is required at run-time, too, when it is needed.
43 ;; It is only needed on XEmacs for the function
44 ;; `dired-insert-set-properties'.
47 "*The minimum size of compressing where inline transfer.
48 When inline transfer, compress transfered data of file
49 whose size is this value or above (up to `tramp-copy-size-limit').
50 If it is nil, no compression at all will be applied."
55 "*The maximum file size where inline copying is preferred over an out-of-the-band copy.
56 If it is nil, inline out-of-the-band copy will be used without a check."
60 ;;;###tramp-autoload
62 "*Value of TERM environment variable for logging in to remote host.
63 Because Tramp wants to parse the output of the remote shell, it is easily
64 confused by ANSI color escape sequences and suchlike. Often, shell init
65 files conditionalize this setup based on the TERM environment variable."
69 ;; ksh on OpenBSD 4.5 requires that $PS1 contains a `#' character for
70 ;; root users. It uses the `$' character for other users. In order
71 ;; to guarantee a proper prompt, we use "#$ " for the prompt.
75 "///%s#$"
77 "String used to recognize end of output.
78 The '$' character at the end is quoted; the string cannot be
81 ;;;###tramp-autoload
85 ;; Initialize `tramp-methods' with the supported methods.
86 ;;;###tramp-autoload
96 ;;;###tramp-autoload
105 ;;;###tramp-autoload
120 ;;;###tramp-autoload
136 ;;;###tramp-autoload
152 ;;;###tramp-autoload
172 ;;;###tramp-autoload
189 ;;;###tramp-autoload
197 ;;;###tramp-autoload
209 ;;;###tramp-autoload
223 "ssh"
224 " -o ControlPath=%t.%%r@%%h:%%p"
229 ;;;###tramp-autoload
235 ;;;###tramp-autoload
241 ;;;###tramp-autoload
252 ;;;###tramp-autoload
264 ;;;###tramp-autoload
276 ;;;###tramp-autoload
289 ;;;###tramp-autoload
296 ;;;###tramp-autoload
302 ;;;###tramp-autoload
308 ;;;###tramp-autoload
314 ;;;###tramp-autoload
320 ;;;###tramp-autoload
328 ;;;###tramp-autoload
336 ;;;###tramp-autoload
340 ;; ("%h") must be a single element, see
341 ;; `tramp-compute-multi-hops'.
344 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
345 tramp-terminal-type
346 tramp-initial-end-of-output))
349 ;;;###tramp-autoload
362 ;;;###tramp-autoload
374 ;;;###tramp-autoload
384 ;;;###tramp-autoload
388 ;;;###tramp-autoload
392 ;; Do not add "ssh" based methods, otherwise ~/.ssh/config would be ignored.
393 ;;;###tramp-autoload
465 ;; "getconf PATH" yields:
466 ;; HP-UX: /usr/bin:/usr/ccs/bin:/opt/ansic/bin:/opt/langtools/bin:/opt/fortran/bin
467 ;; Solaris: /usr/xpg4/bin:/usr/ccs/bin:/usr/bin:/opt/SUNWspro/bin
468 ;; GNU/Linux (Debian, Suse): /bin:/usr/bin
469 ;; FreeBSD: /usr/bin:/bin:/usr/sbin:/sbin: - beware trailing ":"!
470 ;; IRIX64: /usr/bin
475 "*List of directories to search for executables on remote host.
476 For every remote host, this variable will be set buffer local,
477 keeping the list of existing directories on that host.
479 You can use `~' in this list, but when searching for a shell which groks
480 tilde expansion, all directory names starting with `~' will be ignored.
482 `Default Directories' represent the list of directories given by
484 entry on top of this list, because these are the default
485 directories for POSIX compatible commands. On remote hosts which
486 do not offer the getconf command (like cygwin), the value
489 `Private Directories' are the settings of the $PATH environment,
490 as given in your `~/.profile'."
505 "*List of environment variables to be set on the remote host.
507 Each element should be a string of the form ENVVARNAME=VALUE. An
508 entry ENVVARNAME= diables the corresponding environment variable,
509 which might have been set in the init files like ~/.profile.
511 Special handling is applied to the PATH environment, which should
512 not be set here. Instead, it should be set via `tramp-remote-path'."
517 "*Alist specifying extra arguments to pass to the remote shell.
518 Entries are (REGEXP . ARGS) where REGEXP is a regular expression
519 matching the shell file name and ARGS is a string specifying the
520 arguments.
522 This variable is only used when Tramp needs to start up another shell
523 for tilde expansion. The extra arguments should typically prevent the
524 shell from reading its init file."
526 ;; This might be the wrong way to test whether the widget type
527 ;; `alist' is available. Who knows the right way to test it?
542 "List of pattern/action pairs.
543 Whenever a pattern matches, the corresponding action is performed.
544 Each item looks like (PATTERN ACTION).
546 The PATTERN should be a symbol, a variable. The value of this
547 variable gives the regular expression to search for. Note that the
549 appended to it.
551 The ACTION should also be a symbol, but a function. When the
559 "List of pattern/action pairs.
560 This list is used for copying/renaming with out-of-band methods.
565 "(echo begin 600 /tmp/tramp.$$; tail +2) | uudecode
566 cat /tmp/tramp.$$
567 rm -f /tmp/tramp.$$"
568 "Shell function to implement `uudecode' to standard output.
569 Many systems support `uudecode -o /dev/stdout' or `uudecode -o -'
570 for this or `uudecode -p', but some systems don't, and for them
574 "%s -e '
575 use File::Spec;
578 sub recursive {
579 my ($volume, @dirs) = @_;
580 my $real = realpath(File::Spec->catpath(
582 if ($real) {
583 my ($vol, $dir) = File::Spec->splitpath($real, 1);
584 return ($vol, File::Spec->splitdir($dir));
585 }
586 else {
587 my $last = pop(@dirs);
588 ($volume, @dirs) = recursive($volume, @dirs);
589 push(@dirs, $last);
590 return ($volume, @dirs);
591 }
592 }
594 $result = realpath($ARGV[0]);
595 if (!$result) {
596 my ($vol, $dir) = File::Spec->splitpath($ARGV[0], 1);
597 ($vol, @dirs) = recursive($vol, File::Spec->splitdir($dir));
600 }
604 }
608 "Perl script to produce output suitable for use with `file-truename'
609 on the remote file system.
610 Escape sequence %s is replaced with name of Perl binary.
614 "%s -e 'sub case {
615 my $str = shift;
616 if ($ARGV[2]) {
617 return lc($str);
618 }
619 else {
620 return $str;
621 }
622 }
624 @files = readdir(d); closedir(d);
625 foreach $f (@files) {
626 if (case(substr($f, 0, length($ARGV[1]))) eq case($ARGV[1])) {
629 }
630 else {
632 }
633 }
634 }
637 "Perl script to produce output suitable for use with
638 `file-name-all-completions' on the remote file system. Escape
639 sequence %s is replaced with name of Perl binary. This string is
642 ;; Perl script to implement `file-attributes' in a Lisp `read'able
643 ;; output. If you are hacking on this, note that you get *no* output
644 ;; unless this spits out a complete line, including the '\n' at the
645 ;; end.
646 ;; The device number is returned as "-1", because there will be a virtual
647 ;; device number set in `tramp-sh-handle-file-attributes'.
649 "%s -e '
650 @stat = lstat($ARGV[0]);
651 if (!@stat) {
653 exit 0;
654 }
655 if (($stat[2] & 0170000) == 0120000)
656 {
657 $type = readlink($ARGV[0]);
659 }
660 elsif (($stat[2] & 0170000) == 040000)
661 {
663 }
664 else
665 {
667 };
670 printf(
672 $type,
673 $stat[3],
674 $uid,
675 $gid,
676 $stat[8] >> 16 & 0xffff,
677 $stat[8] & 0xffff,
678 $stat[9] >> 16 & 0xffff,
679 $stat[9] & 0xffff,
680 $stat[10] >> 16 & 0xffff,
681 $stat[10] & 0xffff,
682 $stat[7],
683 $stat[2],
684 $stat[1] >> 16 & 0xffff,
685 $stat[1] & 0xffff
687 "Perl script to produce output suitable for use with `file-attributes'
688 on the remote file system.
689 Escape sequence %s is replaced with name of Perl binary.
693 "%s -e '
696 @list = readdir(DIR);
697 closedir(DIR);
698 $n = scalar(@list);
700 for($i = 0; $i < $n; $i++)
701 {
702 $filename = $list[$i];
703 @stat = lstat($filename);
704 if (($stat[2] & 0170000) == 0120000)
705 {
706 $type = readlink($filename);
708 }
709 elsif (($stat[2] & 0170000) == 040000)
710 {
712 }
713 else
714 {
716 };
719 printf(
720 \"(\\\"%%s\\\" %%s %%u %%s %%s (%%u %%u) (%%u %%u) (%%u %%u) %%u.0 %%u t (%%u . %%u) (%%u . %%u))\\n\",
721 $filename,
722 $type,
723 $stat[3],
724 $uid,
725 $gid,
726 $stat[8] >> 16 & 0xffff,
727 $stat[8] & 0xffff,
728 $stat[9] >> 16 & 0xffff,
729 $stat[9] & 0xffff,
730 $stat[10] >> 16 & 0xffff,
731 $stat[10] & 0xffff,
732 $stat[7],
733 $stat[2],
734 $stat[1] >> 16 & 0xffff,
735 $stat[1] & 0xffff,
736 $stat[0] >> 16 & 0xffff,
737 $stat[0] & 0xffff);
738 }
740 "Perl script implementing `directory-files-attributes' as Lisp `read'able
741 output.
742 Escape sequence %s is replaced with name of Perl binary.
745 ;; These two use base64 encoding.
747 "%s -MMIME::Base64 -0777 -ne 'print encode_base64($_)' 2>/dev/null"
748 "Perl program to use for encoding a file.
749 Escape sequence %s is replaced with name of Perl binary.
750 This string is passed to `format', so percent characters need to be doubled.
751 This implementation requires the MIME::Base64 Perl module to be installed
755 "%s -MMIME::Base64 -0777 -ne 'print decode_base64($_)' 2>/dev/null"
756 "Perl program to use for decoding a file.
757 Escape sequence %s is replaced with name of Perl binary.
758 This string is passed to `format', so percent characters need to be doubled.
759 This implementation requires the MIME::Base64 Perl module to be installed
763 "%s -e '
764 # This script contributed by Juanma Barranquero <lektu@terra.es>.
765 # Copyright (C) 2002-2011 Free Software Foundation, Inc.
766 use strict;
768 my %%trans = do {
769 my $i = 0;
770 map {(substr(unpack(q(B8), chr $i++), 2, 6), $_)}
771 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/);
772 };
776 # We read in chunks of 54 bytes, to generate output lines
777 # of 72 chars (plus end of line)
780 while (my $data = <STDIN>) {
781 my $pad = q();
783 # Only for the last chunk, and only if did not fill the last three-byte packet
784 if (eof) {
785 my $mod = length($data) %% 3;
786 $pad = q(=) x (3 - $mod) if $mod;
787 }
789 # Not the fastest method, but it is simple: unpack to binary string, split
790 # by groups of 6 bits and convert back from binary to byte; then map into
791 # the translation table
792 print
793 join q(),
794 map($trans{$_},
795 (substr(unpack(q(B*), $data) . q(00000), 0, 432) =~ /....../g)),
796 $pad,
798 }' 2>/dev/null"
799 "Perl program to use for encoding a file.
800 Escape sequence %s is replaced with name of Perl binary.
804 "%s -e '
805 # This script contributed by Juanma Barranquero <lektu@terra.es>.
806 # Copyright (C) 2002-2011 Free Software Foundation, Inc.
807 use strict;
809 my %%trans = do {
810 my $i = 0;
811 map {($_, substr(unpack(q(B8), chr $i++), 2, 6))}
812 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/)
813 };
815 my %%bytes = map {(unpack(q(B8), chr $_), chr $_)} 0 .. 255;
819 # We are going to accumulate into $pending to accept any line length
820 # (we do not check they are <= 76 chars as the RFC says)
821 my $pending = q();
823 while (my $data = <STDIN>) {
824 chomp $data;
826 # If we find one or two =, we have reached the end and
827 # any following data is to be discarded
828 my $finished = $data =~ s/(==?).*/$1/;
829 $pending .= $data;
831 my $len = length($pending);
832 my $chunk = substr($pending, 0, $len & ~3);
833 $pending = substr($pending, $len & ~3 + 1);
835 # Easy method: translate from chars to (pregenerated) six-bit packets, join,
836 # split in 8-bit chunks and convert back to char.
837 print join q(),
838 map $bytes{$_},
839 ((join q(), map {$trans{$_} || q()} split //, $chunk) =~ /......../g);
841 last if $finished;
842 }' 2>/dev/null"
843 "Perl program to use for decoding a file.
844 Escape sequence %s is replaced with name of Perl binary.
849 while read file; do
852 else
854 fi
857 else
859 fi
860 done
862 "Script to check existence of VC related files.
863 It must be send formatted with two strings; the tests for file
864 existence, and file readability. Input shall be read via
865 here-document, otherwise the command could exceed maximum length
884 "A list of file types returned from the `stat' system call.
887 ;; New handlers should be added here. The following operations can be
888 ;; handled using the normal primitives: file-name-sans-versions,
889 ;; get-file-buffer.
910 . tramp-sh-handle-directory-files-and-attributes)
923 ;; `executable-find' is not official yet.
935 . tramp-sh-handle-insert-file-contents-literally)
942 . tramp-sh-handle-dired-recursive-delete-directory)
949 "Alist of handler functions.
952 ;; This must be the last entry, because `identity' always matches.
953 ;;;###tramp-autoload
957 ;;; File Name Handler Functions:
961 "Like `make-symbolic-link' for Tramp files.
962 If LINKNAME is a non-Tramp file, it is used verbatim as the target of
963 the symlink. If LINKNAME is a Tramp file, only the localname component is
964 used as the target of the symlink.
966 If LINKNAME is a Tramp file and the localname component is relative, then
967 it is expanded first, before the localname component is taken. Note that
968 this can give surprising results if the user/host for the source and
969 target of the symlink differ."
976 l 'file-error
979 ;; Do the 'confirm if exists' thing.
981 ;; What to do?
986 "File %s already exists; make it a link anyway? "
987 l-localname)))))
992 ;; If FILENAME is a Tramp name, use just the localname component.
1001 ;; Right, they are on the same host, regardless of user, method, etc.
1002 ;; We now make the link on the remote machine. This will occur as the user
1003 ;; that FILENAME belongs to.
1005 l
1007 "cd %s && %s -sf %s %s"
1009 ln
1012 t))))
1015 "Like `file-truename' for Tramp files."
1021 ;; Use GNU readlink --canonicalize-missing where available.
1025 v
1030 ;; Use Perl implementation.
1038 v
1042 ;; Do it yourself. We bind `directory-sep-char' here for
1043 ;; XEmacs on Windows, which would otherwise use backslash.
1051 ;; Don't make the following value larger than
1052 ;; necessary. People expect an error message in a
1053 ;; timely fashion when something is wrong;
1054 ;; otherwise they might think that Emacs is hung.
1055 ;; Of course, correctness has to come first.
1057 symlink-target)
1068 method user host
1080 ;; It's a symlink, follow it.
1085 ;; If the symlink was absolute, we'll get a string like
1086 ;; "/user@host:/some/target"; extract the
1087 ;; "/some/target" part from it.
1091 v 'file-error
1097 steps)))
1099 ;; It's a file.
1103 v 'file-error
1106 ;; Combine list to form string.
1118 ;; Basic functions.
1121 "Like `file-exists-p' for Tramp files."
1129 v
1131 "%s %s"
1135 ;; CCC: This should check for an error condition and signal failure
1136 ;; when something goes wrong.
1137 ;; Daniel Pittman <daniel@danann.net>
1139 "Like `file-attributes' for Tramp files."
1141 ;; Don't modify `last-coding-system-used' by accident.
1147 v
1155 ;; The scripts could fail, for example with huge file size.
1159 "Implement `file-attributes' for Tramp files using the ls(1) command."
1161 res-inode res-filemodes res-numlinks
1162 res-uid res-gid res-size res-symlink-target)
1165 vec
1174 ;; parse `ls -l' output ...
1178 ;; ... inode
1194 ;; ... file mode flags
1196 ;; ... number links
1198 ;; ... uid and gid
1208 ;; ... size
1210 ;; From the file modes, figure out other stuff.
1213 ;; if symlink, find out file name pointed to
1217 ;; return data gathered
1219 ;; 0. t for directory, string (name linked to) for symbolic
1220 ;; link, or nil.
1222 ;; 1. Number of links to file.
1223 res-numlinks
1224 ;; 2. File uid.
1225 res-uid
1226 ;; 3. File gid.
1227 res-gid
1228 ;; 4. Last access time, as a list of two integers. First
1229 ;; integer has high-order 16 bits of time, second has low 16
1230 ;; bits.
1231 ;; 5. Last modification time, likewise.
1232 ;; 6. Last status change time, likewise.
1234 ;; 7. Size in bytes (-1, if number is out of range).
1235 res-size
1236 ;; 8. File modes, as a string of ten letters or dashes as in ls -l.
1237 res-filemodes
1238 ;; 9. t if file's gid would change if file were deleted and
1239 ;; recreated. Will be set in `tramp-convert-file-attributes'
1240 t
1241 ;; 10. inode number.
1242 res-inode
1243 ;; 11. Device number. Will be replaced by a virtual device number.
1244 -1
1245 )))))
1249 "Implement `file-attributes' for Tramp files using a Perl script."
1254 vec
1260 "Implement `file-attributes' for Tramp files using stat(1) command."
1263 vec
1265 ;; On Opsware, pdksh (which is the true name of ksh there) doesn't
1266 ;; parse correctly the sequence "((". Therefore, we add a space.
1267 "( (%s %s || %s -h %s) && %s -c '((\"%%N\") %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 \"%%A\" t %%ie0 -1)' %s || echo nil)"
1278 "Like `set-visited-file-modtime' for Tramp files."
1285 coding-system-used)
1288 ;; '(-1 65535) means file doesn't exists yet.
1292 ;; We use '(0 0) as a don't-know value. See also
1293 ;; `tramp-do-file-attributes-with-ls'.
1298 v
1308 nil)))))
1310 ;; This function makes the same assumption as
1311 ;; `tramp-sh-handle-set-visited-file-modtime'.
1313 "Like `verify-visited-file-modtime' for Tramp files.
1314 At the time `verify-visited-file-modtime' calls this function, we
1315 already know that the buffer is visiting a file and that
1316 `visited-file-modtime' does not return 0. Do not call this
1317 function directly, unless those two cases are already taken care
1318 of."
1321 ;; There is no file visiting the buffer, or the buffer has no
1322 ;; recorded last modification time, or there is no established
1323 ;; connection.
1327 t
1335 ;; File exists, and has a known modtime.
1338 modtime
1339 ;; For compatibility, deal with both the old
1340 ;; (HIGH . LOW) and the new (HIGH LOW) return
1341 ;; values of `visited-file-modtime'.
1344 mt)))
1346 ;; Modtime has the don't know value.
1349 v
1357 attr
1360 ;; If file does not exist, say it is not modified if and
1361 ;; only if that agrees with the buffer's record.
1365 "Like `set-file-modes' for Tramp files."
1368 ;; FIXME: extract the proper text from chmod's stderr.
1370 v
1377 "Like `set-file-times' for Tramp files."
1383 time))
1384 ;; With GNU Emacs, `format-time-string' has an optional
1385 ;; parameter UNIVERSAL. This is preferred, because we
1386 ;; could handle the case when the remote host is located
1387 ;; in a different time zone as the local host.
1397 ;; We handle also the local part, because in older Emacsen,
1398 ;; without `set-file-times', this function is an alias for this.
1399 ;; We are local, so we don't need the UTC settings.
1407 "Set the ownership for FILENAME.
1408 If UID and GID are provided, these values are used; otherwise uid
1409 and gid of the corresponding user is taken. Both parameters must be integers."
1410 ;; Modern Unices allow chown only for root. So we might need
1411 ;; another implementation, see `dired-do-chown'. OTOH, it is mostly
1412 ;; working with su(do)? when it is needed, so it shall succeed in
1413 ;; the majority of cases.
1414 ;; Don't modify `last-coding-system-used' by accident.
1419 ;; If we are root on the local host, we can do it directly.
1427 "chown %d:%d %s" uid gid
1430 ;; We handle also the local part, because there doesn't exist
1431 ;; `set-file-uid-gid'. On W32 "chown" might not work.
1435 "chown" nil nil nil
1439 "Check, whether SELINUX is enabled on the remote host."
1450 "Like `file-selinux-context' for Tramp files."
1459 "%s -d -Z %s"
1467 ;; Return the context.
1468 context))))
1471 "Like `set-file-selinux-context' for Tramp files."
1488 ;; We always return nil.
1489 nil)
1491 ;; Simple functions using the `test' command.
1494 "Like `file-executable-p' for Tramp files."
1497 ;; Examine `file-attributes' cache to see if request can be
1498 ;; satisfied without remote operation.
1503 "Like `file-readable-p' for Tramp files."
1506 ;; Examine `file-attributes' cache to see if request can be
1507 ;; satisfied without remote operation.
1511 ;; When the remote shell is started, it looks for a shell which groks
1512 ;; tilde expansion. Here, we assume that all shells which grok tilde
1513 ;; expansion will also provide a `test' command which groks `-nt' (for
1514 ;; newer than). If this breaks, tell me about it and I'll try to do
1515 ;; something smarter about it.
1517 "Like `file-newer-than-file-p' for Tramp files."
1519 nil)
1521 t)
1522 ;; We are sure both files exist at this point.
1525 ;; We try to get the mtime of both files. If they are not
1526 ;; equal to the "dont-know" value, then we subtract the times
1527 ;; and obtain the result.
1533 ;; If one of them is the dont-know value, then we can
1534 ;; still try to run a shell command on the remote host.
1535 ;; However, this only works if both files are Tramp
1536 ;; files and both have the same method, same user, same
1537 ;; host.
1542 v 'file-error
1543 "Files %s and %s must have same method, user, host"
1544 file1 file2)))
1549 ;; Functions implemented using the basic functions above.
1552 "Like `file-directory-p' for Tramp files."
1553 ;; Care must be taken that this function returns `t' for symlinks
1554 ;; pointing to directories. Surely the most obvious implementation
1555 ;; would be `test -d', but that returns false for such symlinks.
1556 ;; CCC: Stefan Monnier says that `test -d' follows symlinks. And
1557 ;; I now think he's right. So we could be using `test -d', couldn't
1558 ;; we?
1559 ;;
1560 ;; Alternatives: `cd %s', `test -d %s'
1566 "Like `file-writable-p' for Tramp files."
1570 ;; Examine `file-attributes' cache to see if request can be
1571 ;; satisfied without remote operation.
1574 ;; If file doesn't exist, check if directory is writable.
1579 "Like `file-ownership-preserved-p' for Tramp files."
1583 ;; Return t if the file doesn't exist, since it's true that no
1584 ;; information would be lost by an (attempted) delete and create.
1588 ;; Directory listings.
1592 "Like `directory-files-and-attributes' for Tramp files."
1600 v localname
1610 v localname id-format))
1613 v localname id-format)))))))))
1614 result item)
1624 result
1629 "Implement `directory-files-and-attributes' for Tramp files using a Perl script."
1632 vec tramp-perl-directory-files-and-attributes
1636 vec
1640 object))
1644 "Implement `directory-files-and-attributes' for Tramp files using stat(1) command."
1647 vec
1650 ;; We must care about filenames with spaces, or starting with
1651 ;; "-"; this would confuse xargs. "ls -aQ" might be a solution,
1652 ;; but it does not work on all remote systems. Therefore, we
1653 ;; quote the filenames via sed.
1663 ;; This function should return "foo/" for directories and "bar" for
1664 ;; files.
1666 "Like `file-name-all-completions' for Tramp files."
1671 filename
1673 'list
1675 ;; Try cache entries for filename, filename with last
1676 ;; character removed, filename with last two characters
1677 ;; removed, ..., and finally the empty string - all
1678 ;; concatenated to the local directory name.
1681 tramp-completion-reread-directory-timeout)))
1683 ;; This is inefficient for very long filenames, pity
1684 ;; `reduce' is not available...
1687 'append
1692 v
1694 "file-name-all-completions"
1695 nil)))
1699 ;; Cache expired or no matching cache entry found so we need
1700 ;; to perform a remote operation.
1702 ;; Get a list of directories and files, including reliably
1703 ;; tagging the directories with a trailing '/'. Because I
1704 ;; rock. --daniel@danann.net
1706 ;; Changed to perform `cd' in the same remote op and only
1707 ;; get entries starting with `filename'. Capture any `cd'
1708 ;; error messages. Ensure any `cd' and `echo' aliases are
1709 ;; ignored.
1711 v
1715 v tramp-perl-file-name-all-completions
1721 ;; `read-file-name-completion-ignore-case'
1722 ;; is introduced with Emacs 22.1.
1725 'read-file-name-completion-ignore-case
1731 ;; `ls' with wildcard might fail with `Argument
1732 ;; list too long' error in some corner cases; if
1733 ;; `ls' fails after `cd' succeeded, chances are
1734 ;; that's the case, so let's retry without
1735 ;; wildcard. This will return "too many" entries
1736 ;; but that isn't harmful.
1737 " || %s -a 2>/dev/null)"
1738 " | while read f; do"
1744 ;; When `filename' is empty, just `ls' without
1745 ;; filename argument is more efficient than `ls *'
1746 ;; for very large directories and might avoid the
1747 ;; `Argument list too long' error.
1748 ;;
1749 ;; With and only with wildcard, we need to add
1750 ;; `-d' to prevent `ls' from descending into
1751 ;; sub-directories.
1753 "."
1758 ;; Now grab the output.
1762 ;; Check result code, found in last line of output
1766 ;; Grab error message from line before last line
1767 ;; (it was put there by `cd 2>&1')
1770 v 'file-error
1771 "tramp-sh-handle-file-name-all-completions: %s"
1773 ;; For peace of mind, if buffer doesn't end in `fail'
1774 ;; then it should end in `ok'. If neither are in the
1775 ;; buffer something went seriously wrong on the remote
1776 ;; side.
1779 v 'file-error
1780 "\
1781 tramp-sh-handle-file-name-all-completions: internal error accessing `%s': `%s'"
1787 ;; Because the remote op went through OK we know the
1788 ;; directory we `cd'-ed to exists
1792 ;; Because the remote op went through OK we know every
1793 ;; file listed by `ls' exists.
1797 result)
1799 ;; Store result in the cache
1802 "file-name-all-completions"
1803 result))))))))
1805 ;; cp, mv and ln
1809 "Like `add-name-to-file' for Tramp files."
1814 v 'file-error
1815 "add-name-to-file: %s"
1825 "File %s already exists; make it a new name anyway? "
1826 newname)))
1828 v2 'file-error
1833 v1
1836 "error with add-name-to-file, see buffer `%s' for details"
1841 preserve-uid-gid preserve-selinux-context)
1842 "Like `copy-file' for Tramp files."
1846 ;; At least one file a Tramp file?
1850 'copy filename newname ok-if-already-exists keep-date
1851 preserve-uid-gid preserve-selinux-context))
1852 ;; Compat section.
1855 'copy-file
1857 preserve-uid-gid preserve-selinux-context)))
1860 'copy-file
1868 "Like `copy-directory' for Tramp files."
1873 ;; When DIRNAME and NEWNAME are remote, they must have
1874 ;; the same method.
1879 ;; scp or rsync DTRT.
1893 ;; We must do it file-wise.
1897 ;; When newname did exist, we have wrong cached values.
1905 "Like `rename-file' for Tramp files."
1906 ;; Check if both files are local -- invoke normal rename-file.
1907 ;; Otherwise, use Tramp from local system.
1910 ;; At least one file a Tramp file?
1920 preserve-uid-gid preserve-selinux-context)
1921 "Copy or rename a remote file.
1922 OP must be `copy' or `rename' and indicates the operation to perform.
1923 FILENAME specifies the file to copy or rename, NEWNAME is the name of
1924 the new file (for copy) or the new name of the file (for rename).
1925 OK-IF-ALREADY-EXISTS means don't barf if NEWNAME exists already.
1926 KEEP-DATE means to make sure that NEWNAME has the same timestamp
1927 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
1928 the uid and gid if both files are on the same host.
1929 PRESERVE-SELINUX-CONTEXT activates selinux commands.
1931 This function is invoked by `tramp-sh-handle-copy-file' and
1932 `tramp-sh-handle-rename-file'. It is an error if OP is neither
1933 of `copy' and `rename'. FILENAME and NEWNAME must be absolute
1934 file names."
1941 pr tm)
1951 filename newname)
1954 ;; Both are Tramp files.
1959 ;; Shortcut: if method, host, user are the same for
1960 ;; both files, we invoke `cp' or `mv' on the remote
1961 ;; host directly.
1964 op filename newname
1965 ok-if-already-exists keep-date preserve-uid-gid))
1967 ;; Try out-of-band operation.
1971 op filename newname keep-date))
1973 ;; No shortcut was possible. So we copy the file
1974 ;; first. If the operation was `rename', we go back
1975 ;; and delete the original file (if the copy was
1976 ;; successful). The approach is simple-minded: we
1977 ;; create a new buffer, insert the contents of the
1978 ;; source file into it, then write out the buffer to
1979 ;; the target file. The advantage is that it doesn't
1980 ;; matter which filename handlers are used for the
1981 ;; source and target file.
1984 op filename newname keep-date))))))
1986 ;; One file is a Tramp file, the other one is local.
1989 ;; Fast track on local machine.
1992 op filename newname
1993 ok-if-already-exists keep-date preserve-uid-gid))
1995 ;; If the Tramp file has an out-of-band method, the
1996 ;; corresponding copy-program can be invoked.
2000 op filename newname keep-date))
2002 ;; Use the inline method via a Tramp buffer.
2004 op filename newname keep-date))))
2007 ;; One of them must be a Tramp file.
2010 ;; Handle `preserve-selinux-context'.
2013 ;; In case of `rename', we must flush the cache of the source file.
2019 ;; When newname did exist, we have wrong cached values.
2026 "Use an Emacs buffer to copy or rename a file.
2027 First arg OP is either `copy' or `rename' and indicates the operation.
2028 FILENAME is the source file, NEWNAME the target file.
2029 KEEP-DATE is non-nil if NEWNAME should have the same timestamp as FILENAME."
2031 ;; We must disable multibyte, because binary data shall not be
2032 ;; converted.
2037 ;; We don't want the target file to be compressed, so we let-bind
2038 ;; `jka-compr-inhibit' to t.
2042 ;; KEEP-DATE handling.
2044 ;; Set the mode.
2046 ;; If the operation was `rename', delete the original file.
2051 "Invokes `cp' or `mv' on the remote system.
2052 OP must be one of `copy' or `rename', indicating `cp' or `mv',
2053 respectively. FILENAME specifies the file to copy or rename,
2054 NEWNAME is the name of the new file (for copy) or the new name of
2055 the file (for rename). Both files must reside on the same host.
2056 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2057 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2058 the uid and gid from FILENAME."
2068 v 'file-error
2069 "Unknown operation `%s', must be `copy' or `rename'"
2070 op))))
2074 filename))
2078 newname))
2080 cmd-result)
2083 ;; Both files are on a remote host, with same user.
2095 ;; Mask cp -f error.
2097 tramp-operation-not-permitted-regexp nil t))
2098 cmd-result)
2100 nil v 'file-error
2101 "Copying directly failed, see buffer `%s' for details."
2104 ;; We are on the local host.
2107 ;; We can do it directly.
2115 localname1 localname2 ok-if-already-exists
2116 keep-date preserve-uid-gid)
2120 ;; We can do it directly with `tramp-send-command'
2128 ok-if-already-exists keep-date t)
2129 ;; We must change the ownership to the local user.
2135 ;; We need a temporary file in between.
2137 ;; Create the temporary file.
2145 "%s %s %s" cmd
2148 "Copying directly failed, see buffer `%s' for details."
2150 ;; We must change the ownership as remote user.
2151 ;; Since this does not work reliable, we also
2152 ;; give read permissions.
2163 localname1 tmpfile t
2164 keep-date preserve-uid-gid)
2166 'rename-file
2168 ;; We must change the ownership as local user.
2169 ;; Since this does not work reliable, we also
2170 ;; give read permissions.
2174 tmpfile
2178 ;; Move the temporary file to its destination.
2183 "cp -f -p %s %s"
2186 "Copying directly failed, see buffer `%s' for details."
2190 'rename-file
2193 ;; Save exit.
2196 ;; Set the time and mode. Mask possible errors.
2203 "Invoke rcp program to copy.
2204 The method used must be an out-of-band method."
2208 copy-program copy-args copy-env copy-keep-date port spec
2209 source target)
2214 ;; Both are Tramp files. We shall optimize it when the
2215 ;; methods for filename and newname are the same.
2225 op filename tmpfile keep-date)
2228 ;; Save exit.
2235 ;; Set variables for computing the prompt for reading
2236 ;; password.
2241 ;; Expand hops. Might be necessary for gateway methods.
2245 ;; Check which ones of source and target are Tramp files.
2252 'file-name-directory
2256 ;; Check for host and port number. We cannot use
2257 ;; `tramp-file-name-port', because this returns also
2258 ;; `tramp-default-port', which might clash with settings in
2259 ;; "~/.ssh/config".
2266 ;; Compose copy command.
2268 ?h host ?u user ?p port
2276 copy-args
2278 ;; " " has either been a replacement of "%k" (when
2279 ;; keep-date argument is non-nil), or a replacement
2280 ;; for the whole keep-date sublist.
2281 " "
2285 copy-args)
2288 copy-args
2291 copy-env
2293 nil
2300 ;; Check for program.
2309 ;; The default directory must be remote.
2313 ;; Set the transfer process properties.
2323 ;; Use an asynchronous process. By this, password can
2324 ;; be handled. The default directory must be local, in
2325 ;; order to apply the correct `copy-program'. We don't
2326 ;; set a timeout, because the copying of large files can
2327 ;; last longer than 60 secs.
2333 copy-program
2341 ;; Reset the transfer process properties.
2346 ;; Handle KEEP-DATE argument.
2350 ;; Set the mode.
2355 ;; If the operation was `rename', delete the original file.
2362 "Like `make-directory' for Tramp files."
2374 "Like `delete-directory' for Tramp files."
2386 "Like `delete-file' for Tramp files."
2397 ;; Dired.
2399 ;; CCC: This does not seem to be enough. Something dies when
2400 ;; we try and delete two directories under Tramp :/
2402 "Recursively delete the directory given.
2403 This is like `dired-recursive-delete-directory' for Tramp files."
2405 ;; Run a shell command 'rm -r <localname>'
2406 ;; Code shamelessly stolen from the dired implementation and, um, hacked :)
2409 ;; Which is better, -r or -R? (-r works for me <daniel@danann.net>)
2411 v
2413 ;; Don't read the output, do it explicitly.
2414 nil t)
2415 ;; Wait for the remote system to return to us...
2416 ;; This might take a while, allow it plenty of time.
2418 ;; Make sure that it worked...
2426 "Like `dired-compress-file' for Tramp files."
2427 ;; OK-FLAG is valid for XEmacs only, but not implemented.
2428 ;; Code stolen mainly from dired-aux.el.
2434 ;; Emacs case
2436 ;; XEmacs has `dired-compression-method-alist', which is
2437 ;; transformed into `dired-compress-file-suffixes' structure.
2441 nil
2444 suffix)
2445 ;; See if any suffix rule matches this file name.
2453 nil)
2455 ;; We found an uncompression rule.
2460 ;; `dired-remove-file' is not defined in XEmacs.
2465 ;; We don't recognize the file as compressed, so compress it.
2466 ;; Try gzip.
2471 ;; `dired-remove-file' is not defined in XEmacs.
2481 "Like `insert-directory' for Tramp files."
2507 ;; If `full-directory-p', we just say `ls -l FILENAME'.
2508 ;; Else we chdir to the parent directory, then say `ls -ld BASENAME'.
2511 v
2514 switches
2516 localname
2519 v
2523 "Couldn't `cd %s'"
2527 v
2530 switches
2535 ""
2540 ;; We cannot use `insert-buffer-substring' because the Tramp
2541 ;; buffer changes its contents before insertion due to calling
2542 ;; `expand-file' and alike.
2547 ;; Check for "--dired" output.
2554 ;; Now read the numeric positions of file names.
2560 ;; End is followed by \n or by " -> ".
2562 ;; Remove trailing lines.
2568 ;; The inserted file could be from somewhere else.
2575 "."
2582 ;; Canonicalization of file names.
2585 "Like `expand-file-name' for Tramp files.
2587 the result will be a local, non-Tramp, filename."
2588 ;; If DIR is not given, use DEFAULT-DIRECTORY or "/".
2590 ;; Unless NAME is absolute, concat DIR and NAME.
2593 ;; If NAME is not a Tramp file, run the real handler.
2596 ;; Dissect NAME.
2600 ;; Tilde expansion if necessary. This needs a shell which
2601 ;; groks tilde expansion! The function `tramp-find-shell' is
2602 ;; supposed to find such a shell on the remote host. Please
2603 ;; tell me about it when this doesn't work on your system.
2607 ;; We cannot simply apply "~/", because under sudo "~/" is
2608 ;; expanded to the local user home directory but to the
2609 ;; root home directory. On the other hand, using always
2610 ;; the default user name for tilde expansion is not
2611 ;; appropriate either, because ssh and companions might
2612 ;; use a user name from the config file.
2624 ;; There might be a double slash, for example when "~/"
2625 ;; expands to "/". Remove this.
2628 ;; No tilde characters in file name, do normal
2629 ;; `expand-file-name' (this does "/./" and "/../"). We bind
2630 ;; `directory-sep-char' here for XEmacs on Windows, which would
2631 ;; otherwise use backslash. `default-directory' is bound,
2632 ;; because on Windows there would be problems with UNC shares or
2633 ;; Cygwin mounts.
2637 method user host
2642 ;;; Remote commands:
2645 "Like `executable-find' for Tramp files."
2650 "Flush file caches."
2657 ;; We use BUFFER also as connection buffer during setup. Because of
2658 ;; this, its original contents must be saved, and restored once
2659 ;; connection has been setup.
2661 "Like `start-file-process' for Tramp files."
2663 ;; When PROGRAM is nil, we just provide a tty.
2679 ;; BUFFER can be nil. We use a temporary buffer.
2682 ;; NAME must be unique as process name.
2686 ;; Set the new process properties.
2689 ;; Activate narrowing in order to save BUFFER contents.
2690 ;; Clear also the modification time; otherwise we might
2691 ;; be interrupted by `verify-visited-file-modtime'.
2697 ;; Send the command.
2699 ;; Check, whether a pty is associated.
2704 v 'file-error
2707 ;; Set sentinel and query flag for this process.
2711 ;; Return process.
2712 p)))
2713 ;; Save exit.
2725 "Like `process-file' for Tramp files."
2726 ;; The implementation is not complete yet.
2732 ;; Compute command.
2735 ;; Determine input.
2740 ;; INFILE is on the same remote host.
2742 ;; INFILE must be copied to remote host.
2748 ;; Determine output.
2750 ;; Just a buffer.
2753 ;; A buffer name.
2756 ;; (REAL-DESTINATION ERROR-DESTINATION)
2758 ;; output.
2766 ;; stderr.
2771 ;; stderr is on the same remote host.
2774 ;; stderr must be copied to remote host. The temporary
2775 ;; file must be deleted after execution.
2778 method user host stderr))))
2779 ;; stderr to be discarded.
2782 ;; 't
2787 ;; Send the command. It might not return in time, so we protect
2788 ;; it. Call it in a subshell, in order to preserve working
2789 ;; directory.
2796 command)
2797 t t)
2799 ;; We should show the output anyway.
2806 ;; When the user did interrupt, we should do it also. We use
2807 ;; return code -1 as marker.
2811 ;; Handle errors.
2816 ;; Provide error file.
2819 ;; Cleanup. We remove all file cache values for the connection,
2820 ;; because the remote process could have changed them.
2823 ;; `process-file-side-effects' has been introduced with GNU
2824 ;; Emacs 23.2. If set to `nil', no remote file will be changed
2825 ;; by `program'. If it doesn't exist, we assume its default
2826 ;; value 't'.
2831 ;; Return exit status.
2834 ret))))
2838 "Like `call-process-region' for Tramp files."
2848 "Like `shell-command' for Tramp files."
2850 ;; We cannot use `shell-file-name' and `shell-command-switch',
2851 ;; they are variables of the local host.
2858 current-buffer-p
2868 "*Async Shell Command*"
2878 output-buffer))
2881 ;; Check whether there is another process running. Tramp does not
2882 ;; support 2 (asynchronous) processes in parallel.
2898 ;; Run the process.
2900 ;; Display output.
2906 ;; Run the process.
2908 ;; Insert error messages if they were separated.
2914 ;; This is like exchange-point-and-mark, but doesn't
2915 ;; activate the mark. It is cleaner to avoid activation,
2916 ;; even though the command loop would deactivate the mark
2917 ;; because we inserted text.
2921 ;; There's some output, display it.
2928 "Like `file-local-copy' for Tramp files."
2932 v 'file-error
2942 ;; `copy-file' handles direct copy and out-of-band methods.
2947 ;; Use inline encoding for file transfer.
2957 ;; If local decoding is a function, we call it. We
2958 ;; must disable multibyte, because
2959 ;; `uudecode-decode-region' doesn't handle it
2960 ;; correctly.
2966 filename loc-dec)
2968 ;; Unset `file-name-handler-alist'. Otherwise,
2969 ;; epa-file gets confused.
2974 ;; If tramp-decoding-function is not defined for this
2975 ;; method, we invoke tramp-decoding-command instead.
2977 ;; Unset `file-name-handler-alist'. Otherwise,
2978 ;; epa-file gets confused.
2984 filename loc-dec)
2987 loc-dec tmpfile2 tmpfile)
2990 ;; Set proper permissions.
2992 ;; Set local user ownership.
2995 ;; Oops, I don't know what to do.
2999 ;; Error handling.
3005 tmpfile)))
3007 ;; This is needed for XEmacs only. Code stolen from files.el.
3010 "Like `insert-file-contents-literally' for Tramp files."
3018 nil))
3025 ;; Save exit.
3031 "Like `make-auto-save-file-name' for Tramp files.
3032 Returns a file name in `tramp-auto-save-directory' for autosaving this file."
3043 ;; File name must be unique. This is ensured with Emacs 22 (see
3044 ;; UNIQUIFY element of `auto-save-file-name-transforms'); but for
3045 ;; all other cases we must do it ourselves.
3055 ;; Create directory.
3061 ;; Run plain `make-auto-save-file-name'. There might be an advice when
3062 ;; it is not a magic file name operation (since Emacs 22).
3063 ;; We must deactivate it temporarily.
3066 ;; else
3072 ;; CCC grok LOCKNAME
3075 "Like `write-region' for Tramp files."
3078 ;; Following part commented out because we don't know what to do about
3079 ;; file locking, and it does not appear to be a problem to ignore it.
3080 ;; Ange-ftp ignores it, too.
3081 ;; (when (and lockname (stringp lockname))
3082 ;; (setq lockname (expand-file-name lockname)))
3083 ;; (unless (or (eq lockname nil)
3084 ;; (string= lockname filename))
3085 ;; (error
3086 ;; "tramp-sh-handle-write-region: LOCKNAME must be nil or equal FILENAME"))
3088 ;; XEmacs takes a coding system as the seventh argument, not `confirm'.
3099 ;; `file-writable-p' calls `file-expand-file-name'. We
3100 ;; cannot use `tramp-run-real-handler' therefore.
3106 ;; Short track: if we are on the local host, we can run directly.
3108 'write-region
3112 ;; We use this to save the value of
3113 ;; `last-coding-system-used' after writing the tmp
3114 ;; file. At the end of the function, we set
3115 ;; `last-coding-system-used' to this saved value. This
3116 ;; way, any intermediary coding systems used while
3117 ;; talking to the remote shell or suchlike won't hose
3118 ;; this variable. This approach was snarfed from
3119 ;; ange-ftp.el.
3120 coding-system-used
3121 ;; Write region into a tmp file. This isn't really
3122 ;; needed if we use an encoding function, but currently
3123 ;; we use it always because this makes the logic
3124 ;; simpler.
3128 ;; If `append' is non-nil, we copy the file locally, and let
3129 ;; the native `write-region' implementation do the job.
3132 ;; We say `no-message' here because we don't want the
3133 ;; visited file modtime data to be clobbered from the temp
3134 ;; file. We call `set-visited-file-modtime' ourselves later
3135 ;; on. We must ensure that `file-coding-system-alist'
3136 ;; matches `tmpfile'.
3142 'write-region
3149 ;; Now, `last-coding-system-used' has the right value. Remember it.
3154 ;; The permissions of the temporary file should be set. If
3155 ;; filename does not exist (eq modes nil) it has been
3156 ;; renamed to the backup file. This case `save-buffer'
3157 ;; handles permissions.
3158 ;; Ensure that it is still readable.
3161 tmpfile
3164 ;; This is a bit lengthy due to the different methods
3165 ;; possible for file transfer. First, we check whether the
3166 ;; method uses an rcp program. If so, we call it.
3167 ;; Otherwise, both encoding and decoding command must be
3168 ;; specified. However, if the method _also_ specifies an
3169 ;; encoding function, then that is used for encoding the
3170 ;; contents of the tmp file.
3175 ;; `copy-file' handles direct copy and out-of-band methods.
3186 ;; We keep the local file for performance
3187 ;; reasons, useful for "rsync".
3194 ;; Don't rename, in order to keep context in SELinux.
3199 ;; Use inline file transfer.
3201 ;; Encode tmpfile.
3205 ;; Use encoding function or command.
3209 loc-enc)
3212 ;; The following `let' is a workaround for the
3213 ;; base64.el that comes with pgnus-0.84. If
3214 ;; both of the following conditions are
3215 ;; satisfied, it tries to write to a local
3216 ;; file in default-directory, but at this
3217 ;; point, default-directory is remote.
3218 ;; (`call-process-region' can't write to
3219 ;; remote files, it seems.) The file in
3220 ;; question is a tmp file anyway.
3227 loc-enc)
3229 loc-enc tmpfile t))
3231 v 'file-error
3234 filename loc-enc))))
3236 ;; Send buffer into remote decoding command which
3237 ;; writes to remote file. Because this happens on
3238 ;; the remote host, we cannot use the function.
3240 v 3
3245 v
3251 v nil
3252 "Couldn't write region to `%s', decode using `%s' failed"
3253 filename rem-dec)
3254 ;; When `file-precious-flag' is set, the region is
3255 ;; written to a temporary file. Check that the
3256 ;; checksum is equal to that from the local tmpfile.
3260 ;; cksum runs locally, if possible.
3262 ;; cksum runs remotely.
3264 v
3267 ;; ... they are different.
3274 v 'file-error
3277 filename rem-dec)))))
3279 ;; Save exit.
3282 ;; That's not expected.
3285 v 'file-error
3288 method))))
3290 ;; Make `last-coding-system-used' have the right value.
3297 ;; We must protect `last-coding-system-used', now we have set it
3298 ;; to its correct value.
3300 ;; Set file modification time.
3304 ;; We must pass modtime explicitly, because filename can
3305 ;; be different from (buffer-file-name), f.e. if
3306 ;; `file-precious-flag' is set.
3312 ;; Set the ownership.
3322 ;; VC backends check for the existence of various different special
3323 ;; files. This is very time consuming, because every single check
3324 ;; requires a remote command (the file cache must be invalidated).
3325 ;; Therefore, we apply a kind of optimization. We install the file
3326 ;; name handler `tramp-vc-file-name-handler', which does nothing but
3327 ;; remembers all file names for which `file-exists-p' or
3328 ;; `file-readable-p' has been applied. A first run of `vc-registered'
3329 ;; is performed. Afterwards, a script is applied for all collected
3330 ;; file names, using just one remote command. The result of this
3331 ;; script is used to fill the file cache with actual values. Now we
3332 ;; can reset the file name handlers, and we make a second run of
3333 ;; `vc-registered', which returns the expected result without sending
3334 ;; any other remote command.
3336 "Like `vc-registered' for Tramp files."
3342 ;; There could be new files, created by the vc backend. We
3343 ;; cannot reuse the old cache entries, therefore.
3349 ;; Here we collect only file names, which need an operation.
3353 ;; Send just one command, in order to fill the cache.
3356 v
3365 v
3369 tramp-vc-registered-file-names
3375 ;; Second run. Now all `file-exists-p' or `file-readable-p'
3376 ;; calls shall be answered from the file cache. We unset
3377 ;; `process-file-side-effects' in order to keep the cache when
3378 ;; `process-file' calls appear.
3382 ;;;###tramp-autoload
3384 "Invoke remote-shell Tramp file name handler.
3385 Fall back to normal file name handler if no Tramp handler exists."
3402 "Invoke special file name handler, which collects files to be handled."
3410 ;; That's what we want: file names, for which checks are
3411 ;; applied. We assume that VC uses only `file-exists-p' and
3412 ;; `file-readable-p' checks; otherwise we must extend the
3413 ;; list. We do not perform any action, but return nil, in
3414 ;; order to keep `vc-registered' running.
3417 nil)
3418 ;; Tramp file name handlers like `expand-file-name'. They
3419 ;; must still work.
3422 ;; Default file name handlers, we don't care.
3425 ;;; Internal Functions:
3428 "Define in remote shell function NAME implemented as SCRIPT.
3429 Only send the definition if it has not already been done."
3434 ;; The script could contain a call of Perl. This is masked with `%s'.
3436 vec
3446 auto-save-default)
3454 "Run `test' on the remote system, given a SWITCH and a FILENAME.
3455 Returns the exit code of the `test' program."
3458 v
3460 "%s %s %s"
3462 switch
3466 "Run `test'-like program on the remote system, given FILE1, FILE2.
3467 FORMAT-STRING contains the program name, switches, and place holders.
3468 Returns the exit code of the `test' program. Barfs if the methods,
3469 hosts, or files, disagree."
3473 v 'file-error
3478 v1
3485 "Searches for PROGNAME in $PATH and all directories mentioned in DIRLIST.
3486 First arg VEC specifies the connection, PROGNAME is the program
3487 to search for, and DIRLIST gives the list of directories to
3488 search. If IGNORE-TILDE is non-nil, directory names starting
3489 with `~' will be ignored. If IGNORE-PATH is non-nil, searches
3490 only in DIRLIST.
3492 Returns the absolute file name of PROGNAME, if found, and nil otherwise.
3494 This function expects to be in the right *tramp* buffer."
3497 ;; Check whether the executable is in $PATH. "which(1)" does not
3498 ;; report always a correct error code; therefore we check the
3499 ;; number of words it returns.
3507 ;; Remove all ~/foo directories from dirlist. In XEmacs,
3508 ;; `remove' is in CL, and we want to avoid CL dependencies.
3517 vec
3519 "do if test -x $d/%s -a -f $d/%s; "
3520 "then echo tramp_executable $d/%s; "
3529 result)))
3532 "Sets the remote environment PATH to existing directories.
3533 I.e., for each directory in `tramp-remote-path', it is tested
3534 whether it exists and if so, it is added to the environment
3535 variable PATH."
3541 ;; ------------------------------------------------------------
3542 ;; -- Communication with external shell --
3543 ;; ------------------------------------------------------------
3546 "Find a command on the remote host for checking if a file exists.
3547 Here, we are looking for a command which has zero exit status if the
3548 file exists and nonzero exit status otherwise."
3552 result)
3553 ;; The algorithm is as follows: we try a list of several commands.
3554 ;; For each command, we first run `$cmd /' -- this should return
3555 ;; true, as the root directory always exists. And then we run
3556 ;; `$cmd /this\ file\ does\ not\ exist ', hoping that the file indeed
3557 ;; does not exist. This should return false. We use the first
3558 ;; command we find that seems to work.
3559 ;; The list of commands to try is as follows:
3560 ;; `ls -d' This works on most systems, but NetBSD 1.4
3561 ;; has a bug: `ls' always returns zero exit
3562 ;; status, even for files which don't exist.
3563 ;; `test -e' Some Bourne shells have a `test' builtin
3564 ;; which does not know the `-e' option.
3565 ;; `/bin/test -e' For those, the `test' binary on disk normally
3566 ;; provides the option. Alas, the binary
3567 ;; is sometimes `/bin/test' and sometimes it's
3568 ;; `/usr/bin/test'.
3569 ;; `/usr/bin/test -e' In case `/bin/test' does not exist.
3593 result))
3596 "Opens shell SHELL."
3598 ;; Find arguments for this shell.
3601 item extra-args)
3610 t))
3611 ;; Setting prompts.
3619 "Opens a shell on the remote host which groks tilde expansion."
3626 ;; The default shell (ksh93) of OpenSolaris is buggy.
3636 vec 'file-error
3645 vec "remote-shell"
3649 ;; Utility functions.
3652 "Wait for shell prompt and barf if none appears.
3653 Looks at process PROC to see if a shell prompt appears in TIMEOUT
3654 seconds. If not, it produces an error message with the given ERROR-ARGS."
3657 proc timeout
3663 "Set up an interactive shell.
3664 Mainly sets the prompt and the echo correctly. PROC is the shell
3665 process to set up. VEC specifies the connection."
3667 ;; It is useful to set the prompt in the following command because
3668 ;; some people have a setting for $PS1 which /bin/sh doesn't know
3669 ;; about and thus /bin/sh will display a strange prompt. For
3670 ;; example, if $PS1 has "${CWD}" in the value, then ksh will
3671 ;; display the current working directory but /bin/sh will display
3672 ;; a dollar sign. The following command line sets $PS1 to a sane
3673 ;; value, and works under Bourne-ish shells as well as csh-like
3674 ;; shells. Daniel Pittman reports that the unusual positioning of
3675 ;; the single quotes makes it work under `rc', too. We also unset
3676 ;; the variable $ENV because that is read by some sh
3677 ;; implementations (eg, bash when called as sh) on startup; this
3678 ;; way, we avoid the startup file clobbering $PS1. $PROMPT_COMMAND
3679 ;; is another way to set the prompt in /bin/bash, it must be
3680 ;; discarded as well.
3682 vec
3685 ;; Disable echo.
3688 ;; Check whether the echo has really been disabled. Some
3689 ;; implementations, like busybox of embedded GNU/Linux, don't
3690 ;; support disabling.
3697 ;; Make sure backspaces and their echo are enabled and no line
3698 ;; width magic interferes with them.
3708 ;; Try to set up the coding system correctly.
3709 ;; CCC this can't be the right way to do it. Hm.
3715 ;; Use MULE to select the right EOL convention for communicating
3716 ;; with the process.
3719 cs-decode cs-encode)
3734 ;; Look for ^M and do something useful if found.
3736 ;; We have found a ^M but cannot frob the process coding system
3737 ;; because we're running on a non-MULE Emacs. Let's try
3738 ;; stty, instead.
3743 ;; Check whether the output of "uname -sr" has been changed. If
3744 ;; yes, this is a strong indication that we must expire all
3745 ;; connection properties. We start again with
3746 ;; `tramp-maybe-open-connection', it will be catched there.
3751 vec "uname"
3755 ;; Keep the debug buffer.
3762 ;; We call `tramp-get-buffer' in order to keep the debug buffer.
3765 vec 3
3766 "Connection reset, because remote host changed from `%s' to `%s'"
3767 old-uname new-uname)
3770 ;; Check whether the remote host suffers from buggy
3771 ;; `send-process-string'. This is known for FreeBSD (see comment in
3772 ;; `send_process', file process.c). I've tested sending 624 bytes
3773 ;; successfully, sending 625 bytes failed. Emacs makes a hack when
3774 ;; this host type is detected locally. It cannot handle remote
3775 ;; hosts, though.
3779 tramp-chunksize)
3787 ;; Set remote PATH variable.
3790 ;; Search for a good shell before searching for a command which
3791 ;; checks if a file exists. This is done because Tramp wants to use
3792 ;; "test foo; echo $?" to check if various conditions hold, and
3793 ;; there are buggy /bin/sh implementations which don't execute the
3794 ;; "echo $?" part if the "test" part has an error. In particular,
3795 ;; the OpenSolaris /bin/sh is a problem. There are also other
3796 ;; problems with /bin/sh of OpenSolaris, like redirection of stderr
3797 ;; in function declarations, or changing HISTFILE in place.
3798 ;; Therefore, OpenSolaris' /bin/sh is replaced by bash, when
3799 ;; detected.
3802 ;; Disable unexpected output.
3805 ;; IRIX64 bash expands "!" even when in single quotes. This
3806 ;; destroys our shell functions, we must disable it. See
3807 ;; <http://stackoverflow.com/questions/3291692/irix-bash-shell-expands-expression-in-single-quotes-yet-shouldnt>.
3811 ;; On BSD-like systems, ?\t is expanded to spaces. Suppress this.
3816 ;; Set `remote-tty' process property.
3822 ;; Dump stty settings in the traces.
3826 ;; Set the environment.
3830 unset item)
3843 ;; CCC: We should either implement a Perl version of base64 encoding
3844 ;; and decoding. Then we just use that in the last item. The other
3845 ;; alternative is to use the Perl version of UU encoding. But then
3846 ;; we need a Lisp version of uuencode.
3847 ;;
3848 ;; Old text from documentation of tramp-methods:
3849 ;; Using a uuencode/uudecode inline method is discouraged, please use one
3850 ;; of the base64 methods instead since base64 encoding is much more
3851 ;; reliable and the commands are more standardized between the different
3852 ;; Unix versions. But if you can't use base64 for some reason, please
3853 ;; note that the default uudecode command does not work well for some
3854 ;; Unices, in particular AIX and Irix. For AIX, you might want to use
3855 ;; the following command for uudecode:
3856 ;;
3857 ;; sed '/^begin/d;/^[` ]$/d;/^end/d' | iconv -f uucode -t ISO8859-1
3858 ;;
3859 ;; For Irix, no solution is known yet.
3867 "perl -e 'binmode STDIN; binmode STDOUT; print pack(q{u*}, join q{}, <>)'"
3869 "List of local coding commands for inline transfer.
3870 Each item is a list that looks like this:
3872 \(FORMAT ENCODING DECODING\)
3874 FORMAT is symbol describing the encoding/decoding format. It can be
3875 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
3877 ENCODING and DECODING can be strings, giving commands, or symbols,
3878 giving functions. If they are strings, then they can contain
3880 filename will be put into the command line at that spot. If the
3881 specifier is not present, the input should be read from standard
3882 input.
3884 If they are functions, they will be called with two arguments, start
3885 and end of region, and are expected to replace the region contents
3890 ;; "-i" is more robust with older base64 from GNU coreutils.
3891 ;; However, I don't know whether all base64 versions do supports
3892 ;; this option.
3904 "perl -e 'binmode STDIN; binmode STDOUT; print pack(q{u*}, join q{}, <>)'"
3906 "List of remote coding commands for inline transfer.
3907 Each item is a list that looks like this:
3909 \(FORMAT ENCODING DECODING\)
3911 FORMAT is symbol describing the encoding/decoding format. It can be
3912 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
3914 ENCODING and DECODING can be strings, giving commands, or symbols,
3915 giving variables. If they are strings, then they can contain
3917 filename will be put into the command line at that spot. If the
3918 specifier is not present, the input should be read from standard
3919 input.
3921 If they are variables, this variable is a string containing a Perl
3922 implementation for this functionality. This Perl program will be transferred
3926 "Find an inline transfer encoding that works.
3927 Goes through the list `tramp-local-coding-commands' and
3928 `tramp-remote-coding-commands'."
3932 loc-enc loc-dec rem-enc rem-dec litem ritem found)
3940 ;; If the local encoder or decoder is a string, the
3941 ;; corresponding command has to work locally.
3948 loc-enc nil nil))
3956 loc-dec nil nil))
3958 ;; Search for remote coding commands with the same format
3965 ;; Check if remote encoding and decoding commands can be
3966 ;; called remotely with null input and output. This makes
3967 ;; sure there are no syntax errors and the command is really
3968 ;; found. Note that we do not redirect stdout to /dev/null,
3969 ;; for two reasons: when checking the decoding command, we
3970 ;; actually check the output it gives. And also, when
3971 ;; redirecting "mimencode" output to /dev/null, then as root
3972 ;; it might change the permissions of /dev/null!
3980 vec 5
3993 vec 5
3996 vec
3998 t)
4006 ;; `rem-enc' and `rem-dec' could be a string meanwhile.
4011 ;; Did we find something?
4016 ;; Set connection properties.
4027 "Call the local encoding or decoding command.
4029 Otherwise, INPUT is passed via standard input.
4030 INPUT can also be nil which means `/dev/null'.
4031 OUTPUT can be a string (which specifies a filename), or t (which
4032 means standard output and thus the current buffer), or nil (which
4033 means discard it)."
4035 tramp-encoding-shell
4038 nil
4039 tramp-encoding-command-switch
4048 "List of compress and decompress commands for inline transfer.
4049 Each item is a list that looks like this:
4051 \(COMPRESS DECOMPRESS\)
4056 "Find an inline transfer compress command that works.
4057 Goes through the list `tramp-inline-compress-commands'."
4061 item compress decompress
4062 found)
4069 vec 5
4070 "Checking local compress command `%s', `%s' for sanity"
4071 compress decompress)
4076 ;; Windows shells need the program file name after
4077 ;; the pipe symbol be quoted if they use forward
4078 ;; slashes as directory separators.
4085 vec 5
4086 "Checking remote compress command `%s', `%s' for sanity"
4087 compress decompress)
4093 ;; Did we find something?
4096 ;; Set connection properties.
4110 "Expands VEC according to `tramp-default-proxies-alist'.
4111 Gateway hops are already opened."
4114 item proxy)
4116 ;; Look for proxy hosts to be passed.
4121 ;; host
4124 ;; user
4128 ;; No more hops needed.
4130 ;; Replace placeholders.
4133 proxy
4138 ;; Add the hop.
4140 ;; Start next search.
4143 ;; Handle gateways.
4150 ;; Is the method prepared for gateways?
4153 vec 'file-error
4155 ;; Open the gateway connection.
4157 'target-alist
4161 ;; For the password prompt, we need the correct values.
4162 ;; Therefore, we must remember the gateway vector. But we
4163 ;; cannot do it as connection property, because it shouldn't
4164 ;; be persistent. And we have no started process yet either.
4167 ;; Foreign and out-of-band methods are not supported for multi-hops.
4180 vec 'file-error
4181 "Method `%s' is not supported for multi-hops."
4184 ;; In case the host name is not used for the remote shell
4185 ;; command, the user could be misguided by applying a random
4186 ;; hostname.
4192 ;; There are multi-hops.
4194 ;; The host name is used for the remote shell command.
4197 ;; The host is local. We cannot use `tramp-local-host-p'
4198 ;; here, because it opens a connection as well.
4201 v 'file-error
4202 "Host `%s' looks like a remote host, `%s' can only use the local host"
4203 host method)))
4205 ;; Result.
4206 target-alist))
4209 "Maybe open a connection VEC.
4210 Does not do anything if a connection is already open, but re-opens the
4211 connection if a previous connection has died for some reason."
4217 ;; If too much time has passed since last command was sent, look
4218 ;; whether process is still alive. If it isn't, kill it. When
4219 ;; using ssh, it can sometimes happen that the remote end has
4220 ;; hung up but the local ssh client doesn't recognize this until
4221 ;; it tries to send some data to the remote end. So that's why
4222 ;; we try to send a command from time to time, then look again
4223 ;; whether the process is really alive.
4234 ;; The error will be catched locally.
4242 ;; New connection must be opened.
4245 ;; We call `tramp-get-buffer' in order to get a debug buffer for
4246 ;; messages from the beginning.
4249 vec 3
4259 ;; Start new process.
4270 ;; This must be done in order to avoid our file name handler.
4276 tramp-encoding-shell))))
4281 ;; Check whether process is alive.
4286 ;; Now do all the connections as specified.
4307 ;; We don't create the temporary file. In fact,
4308 ;; it is just a prefix for the ControlPath option
4309 ;; of ssh; the real temporary file has another
4310 ;; name, and it is created and protected by ssh.
4311 ;; It is also removed by ssh when the connection
4312 ;; is closed.
4315 p "temp-file"
4318 tramp-temp-name-prefix
4320 spec)
4322 ;; Add arguments for asynchrononous processes.
4326 ;; Add gateway arguments if necessary.
4330 ;; Check for port number. Until now, there's no need
4331 ;; for handling like method, user, host.
4336 ;; Set variables for computing the prompt for reading
4337 ;; password. They can also be derived from a gateway.
4342 ;; Replace login-args place holders.
4348 ?h l-host ?u l-user ?p l-port ?t tmpfile)
4349 command
4351 ;; We do not want to see the trailing local prompt in
4352 ;; `start-file-process'.
4354 command " "
4360 ;; Local shell could be a Windows COMSPEC. It
4361 ;; doesn't know the ";" syntax, but we must exit
4362 ;; always for `start-file-process'. "exec" does not
4363 ;; work either.
4366 ;; Send the command.
4372 ;; Next hop.
4375 ;; Make initial shell settings.
4379 "Send the COMMAND to connection VEC.
4380 Erases temporary buffer before sending the command. If optional
4381 arg NEVEROPEN is non-nil, never try to open the connection. This
4382 is meant to be used from `tramp-maybe-open-connection' only. The
4383 function waits for output unless NOOUTPUT is set."
4387 ;; We mark the command string that it can be erased in the output buffer.
4391 ;; Unset $PS1 when using here documents, in order to avoid
4392 ;; multiple prompts.
4394 ;; Send the command.
4400 "Wait for output from remote command."
4406 ;; be leading escape sequences, which must be ignored.
4408 ;; Sometimes, the commands do not return a newline but a
4409 ;; null byte before the shell prompt, for example "git
4410 ;; ls-files -c -z ...".
4415 ;; A simple-minded busybox has sent " ^H" sequences.
4416 ;; Delete them.
4421 ;; Delete the prompt.
4427 proc 'file-error
4428 "[[Remote prompt `%s' not found in %d secs]]"
4429 tramp-end-of-output timeout)
4431 proc 'file-error
4433 ;; Return value is whether end-of-output sentinel was found.
4434 found)))
4438 "Run COMMAND and check its exit status.
4439 Sends `echo $?' along with the COMMAND for checking the exit status. If
4440 COMMAND is nil, just sends `echo $?'. Returns the exit status found.
4442 If the optional argument SUBSHELL is non-nil, the command is
4443 executed in a subshell, ie surrounded by parentheses. If
4444 DONT-SUPPRESS-ERR is non-nil, stderr won't be sent to /dev/null."
4446 vec
4448 command
4450 "echo tramp_exit_status $?"
4464 "Run COMMAND, check exit status, throw error if exit status not okay.
4465 Similar to `tramp-send-command-and-check' but accepts two more arguments
4466 FMT and ARGS which are passed to `error'."
4471 "Run COMMAND and return the output, which must be a Lisp expression.
4472 In case there is no valid Lisp expression, it raises an error"
4475 ;; Read the expression.
4479 ;; Error handling.
4483 vec 'file-error
4484 "`%s' does not return a valid Lisp expression: `%s'"
4488 "Convert file-attributes ATTR generated by perl script, stat or ls.
4489 Convert file mode bits to string and set virtual device number.
4490 Return ATTR."
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 ;; Either the file size is large enough, or (in rare cases) there
4644 ;; does not exist a remote encoding.
4649 ;; Variables local to connection.
4653 ;; When `tramp-own-remote-path' is in `tramp-remote-path', we
4654 ;; cache the result for the session only. Otherwise, the result
4655 ;; is cached persistently.
4658 vec)
4659 "remote-path"
4667 vec
4669 ;; Default if "getconf" is not available.
4672 vec 3
4683 nil)))))
4685 ;; Replace place holder `tramp-default-remote-path'.
4693 ;; Replace place holder `tramp-own-remote-path'.
4701 ;; Remove double entries.
4708 ;; Remove non-existing directories.
4710 nil
4720 x))
4721 x))
4722 remote-path)))))
4731 dir
4741 result)
4743 ;; Check parameters. On busybox, "ls" output coloring is
4744 ;; enabled by default sometimes. So we try to disable it
4745 ;; when possible. $LS_COLORING is not supported there.
4746 ;; Some "ls" versions are sensible wrt the order of
4747 ;; arguments, they fail when "-al" is after the
4748 ;; "--color=never" argument (for example on FreeBSD).
4763 ;; Some "ls" versions are sensible wrt the order of arguments,
4764 ;; they fail when "-al" is after the "--dired" argument (for
4765 ;; example on FreeBSD).
4773 "test"
4777 ;; Does `test A -nt B' work? Use abominable `find' construct if it
4778 ;; doesn't. BSD/OS 4.0 wants the parentheses around the command,
4779 ;; for otherwise the shell crashes.
4791 vec
4814 ;; We must check also for some Perl modules.
4822 result)))
4829 tmp)
4830 ;; Check whether stat(1) returns usable syntax. %s does not
4831 ;; work on older AIX systems.
4834 ;; We don't want to display an error message.
4843 result)))
4851 ;; We don't want to display an error message.
4856 result))))
4869 result)
4871 ;; Check POSIX parameter.
4880 vec
4886 ;; The command might not always return a number.
4892 vec
4898 ;; The command might not always return a number.
4907 ;; Some predefined connection properties.
4909 "Return the compress command related to PROP.
4910 PROP is either `inline-compress' or `inline-decompress'. SIZE is
4911 the length of the file to be compressed.
4913 If no corresponding command is found, nil is returned."
4921 "Return the coding command related to PROP.
4922 PROP is either `remote-encoding', `remode-decoding',
4923 `local-encoding' or `local-decoding'.
4925 SIZE is the length of the file to be coded. Depending on SIZE,
4926 compression might be applied.
4928 If no corresponding command is found, nil is returned.
4929 Otherwise, either a string is returned which contains a `%s' mark
4930 to be used for the respective input or output file; or a Lisp
4931 function cell is returned to be applied on a buffer."
4932 ;; We must catch the errors, because we want to return `nil', when
4933 ;; no inline coding is found.
4941 compress)
4942 ;; The connection property might have been cached. So we must
4943 ;; send the script to the remote side - maybe.
4951 ;; Check for the `compress' command.
4953 ;; Return the value.
4969 'call-process-region beg end
4974 coding)
4977 ;; Windows shells need the program file name after
4978 ;; the pipe symbol be quoted if they use forward
4979 ;; slashes as directory separators.
4984 coding compress))
4987 ;; Windows shells need the program file name after
4988 ;; the pipe symbol be quoted if they use forward
4989 ;; slashes as directory separators.
4994 compress coding))
5000 ;;; Integration of eshell.el:
5005 ;; eshell.el keeps the path in `eshell-path-env'. We must change it
5006 ;; when `default-directory' points to another host.
5008 "Set `eshell-path-env' to $PATH of the host related to `default-directory'."
5013 'identity
5034 ;;; TODO:
5036 ;; * Don't use globbing for directories with many files, as this is
5037 ;; likely to produce long command lines, and some shells choke on
5038 ;; long command lines.
5039 ;; * Make it work for different encodings, and for different file name
5040 ;; encodings, too. (Daniel Pittman)
5041 ;; * Don't search for perl5 and perl. Instead, only search for perl and
5042 ;; then look if it's the right version (with `perl -v').
5043 ;; * When editing a remote CVS controlled file as a different user, VC
5044 ;; gets confused about the file locking status. Try to find out why
5045 ;; the workaround doesn't work.
5046 ;; * Allow out-of-band methods as _last_ multi-hop. Open a connection
5047 ;; until the last but one hop via `start-file-process'. Apply it
5048 ;; also for ftp and smb.
5049 ;; * WIBNI if we had a command "trampclient"? If I was editing in
5050 ;; some shell with root priviledges, it would be nice if I could
5051 ;; just call
5052 ;; trampclient filename.c
5053 ;; as an editor, and the _current_ shell would connect to an Emacs
5054 ;; server and would be used in an existing non-priviledged Emacs
5055 ;; session for doing the editing in question.
5056 ;; That way, I need not tell Emacs my password again and be afraid
5057 ;; that it makes it into core dumps or other ugly stuff (I had Emacs
5058 ;; once display a just typed password in the context of a keyboard
5059 ;; sequence prompt for a question immediately following in a shell
5060 ;; script run within Emacs -- nasty).
5061 ;; And if I have some ssh session running to a different computer,
5062 ;; having the possibility of passing a local file there to a local
5063 ;; Emacs session (in case I can arrange for a connection back) would
5064 ;; be nice.
5065 ;; Likely the corresponding Tramp server should not allow the
5066 ;; equivalent of the emacsclient -eval option in order to make this
5067 ;; reasonably unproblematic. And maybe trampclient should have some
5068 ;; way of passing credentials, like by using an SSL socket or
5069 ;; something. (David Kastrup)
5070 ;; * Reconnect directly to a compliant shell without first going
5071 ;; through the user's default shell. (Pete Forman)
5072 ;; * How can I interrupt the remote process with a signal
5073 ;; (interrupt-process seems not to work)? (Markus Triska)
5074 ;; * Avoid the local shell entirely for starting remote processes. If
5075 ;; so, I think even a signal, when delivered directly to the local
5076 ;; SSH instance, would correctly be propagated to the remote process
5077 ;; automatically; possibly SSH would have to be started with
5078 ;; "-t". (Markus Triska)
5079 ;; * It makes me wonder if tramp couldn't fall back to ssh when scp
5080 ;; isn't on the remote host. (Mark A. Hershberger)
5081 ;; * Use lsh instead of ssh. (Alfred M. Szmidt)
5082 ;; * Optimize out-of-band copying when both methods are scp-like (not
5083 ;; rsync).
5084 ;; * Keep a second connection open for out-of-band methods like scp or
5085 ;; rsync.
5086 ;; * Try telnet+curl as new method. It might be useful for busybox,
5087 ;; without built-in uuencode/uudecode.
5089 ;;; tramp-sh.el ends here