| blob | c639af3c230aaa67c518116ad45553467a8c49f9 |
1 ;;; tramp-sh.el --- Tramp access functions for (s)sh-like connections
3 ;; Copyright (C) 1998-2014 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:
31 ;; Pacify byte-compiler.
44 "The minimum size of compressing where inline transfer.
45 When inline transfer, compress transferred data of file
46 whose size is this value or above (up to `tramp-copy-size-limit').
47 If it is nil, no compression at all will be applied."
52 "The maximum file size where inline copying is preferred over an \
53 out-of-the-band copy.
54 If it is nil, out-of-the-band copy will be used without a check."
58 ;;;###tramp-autoload
60 "Value of TERM environment variable for logging in to remote host.
61 Because Tramp wants to parse the output of the remote shell, it is easily
62 confused by ANSI color escape sequences and suchlike. Often, shell init
63 files conditionalize this setup based on the TERM environment variable."
67 ;;;###tramp-autoload
69 "Whether the HISTFILE should be overridden to something. Set
70 to nil to disable the override."
76 ;;;###tramp-autoload
80 ;; ksh on OpenBSD 4.5 requires that $PS1 contains a `#' character for
81 ;; root users. It uses the `$' character for other users. In order
82 ;; to guarantee a proper prompt, we use "#$ " for the prompt.
86 "///%s#$"
88 "String used to recognize end of output.
89 The '$' character at the end is quoted; the string cannot be
92 ;;;###tramp-autoload
99 ;; Initialize `tramp-methods' with the supported methods.
100 ;;;###tramp-autoload
111 ;;;###tramp-autoload
121 ;;;###tramp-autoload
138 ;;;###tramp-autoload
156 ;;;###tramp-autoload
171 ;;;###tramp-autoload
178 ;;;###tramp-autoload
185 ;;;###tramp-autoload
198 ;;;###tramp-autoload
211 ;;;###tramp-autoload
219 ;;;###tramp-autoload
227 ;; We use "-v" for better error tracking.
230 ;; We use "-p" as required for newer busyboxes. For older
231 ;; busybox/nc versions, the value must be (("-l") ("%r")). This
232 ;; can be achieved by tweaking `tramp-connection-properties'.
235 ;;;###tramp-autoload
243 ;;;###tramp-autoload
248 ;; Local $SHELL could be a nasty one, like zsh or fish. Let's override it.
253 ;;;###tramp-autoload
261 ;;;###tramp-autoload
268 ;;;###tramp-autoload
272 ;; ("%h") must be a single element, see `tramp-compute-multi-hops'.
276 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
277 tramp-terminal-type
278 tramp-initial-end-of-output))
283 ;;;###tramp-autoload
289 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
290 tramp-terminal-type
291 tramp-initial-end-of-output))
295 ;;;###tramp-autoload
302 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
303 tramp-terminal-type
304 tramp-initial-end-of-output))
314 ;;;###tramp-autoload
321 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
322 tramp-terminal-type
323 tramp-initial-end-of-output))
332 ;;;###tramp-autoload
343 ;;;###tramp-autoload
347 ;;;###tramp-autoload
351 ;; Do not add "ssh" based methods, otherwise ~/.ssh/config would be ignored.
352 ;; Do not add "plink" based methods, they ask interactively for the user.
353 ;;;###tramp-autoload
362 ;;;###tramp-autoload
368 ;;;###tramp-autoload
384 ;;;###tramp-autoload
389 ;;;###tramp-autoload
394 ;;;###tramp-autoload
402 ;;;###tramp-autoload
429 ;; "getconf PATH" yields:
430 ;; HP-UX: /usr/bin:/usr/ccs/bin:/opt/ansic/bin:/opt/langtools/bin:/opt/fortran/bin
431 ;; Solaris: /usr/xpg4/bin:/usr/ccs/bin:/usr/bin:/opt/SUNWspro/bin
432 ;; GNU/Linux (Debian, Suse): /bin:/usr/bin
433 ;; FreeBSD: /usr/bin:/bin:/usr/sbin:/sbin: - beware trailing ":"!
434 ;; IRIX64: /usr/bin
435 ;;;###tramp-autoload
441 "List of directories to search for executables on remote host.
442 For every remote host, this variable will be set buffer local,
443 keeping the list of existing directories on that host.
445 You can use `~' in this list, but when searching for a shell which groks
446 tilde expansion, all directory names starting with `~' will be ignored.
448 `Default Directories' represent the list of directories given by
450 entry on top of this list, because these are the default
451 directories for POSIX compatible commands. On remote hosts which
452 do not offer the getconf command (like cygwin), the value
455 `Private Directories' are the settings of the $PATH environment,
456 as given in your `~/.profile'."
463 ;;;###tramp-autoload
471 "List of environment variables to be set on the remote host.
473 Each element should be a string of the form ENVVARNAME=VALUE. An
474 entry ENVVARNAME= disables the corresponding environment variable,
475 which might have been set in the init files like ~/.profile.
477 Special handling is applied to the PATH environment, which should
478 not be set here. Instead, it should be set via `tramp-remote-path'."
484 "Alist specifying extra arguments to pass to the remote shell.
485 Entries are (REGEXP . ARGS) where REGEXP is a regular expression
486 matching the shell file name and ARGS is a string specifying the
487 arguments.
489 This variable is only used when Tramp needs to start up another shell
490 for tilde expansion. The extra arguments should typically prevent the
491 shell from reading its init file."
493 ;; This might be the wrong way to test whether the widget type
494 ;; `alist' is available. Who knows the right way to test it?
509 "List of pattern/action pairs.
510 Whenever a pattern matches, the corresponding action is performed.
511 Each item looks like (PATTERN ACTION).
513 The PATTERN should be a symbol, a variable. The value of this
514 variable gives the regular expression to search for. Note that the
516 appended to it.
518 The ACTION should also be a symbol, but a function. When the
526 "List of pattern/action pairs.
527 This list is used for copying/renaming with out-of-band methods.
532 "(echo begin 600 %t; tail -n +2) | uudecode
533 cat %t
534 rm -f %t"
535 "Shell function to implement `uudecode' to standard output.
536 Many systems support `uudecode -o /dev/stdout' or `uudecode -o -'
537 for this or `uudecode -p', but some systems don't, and for them
541 "%s -e '
542 use File::Spec;
545 sub recursive {
546 my ($volume, @dirs) = @_;
547 my $real = realpath(File::Spec->catpath(
549 if ($real) {
550 my ($vol, $dir) = File::Spec->splitpath($real, 1);
551 return ($vol, File::Spec->splitdir($dir));
552 }
553 else {
554 my $last = pop(@dirs);
555 ($volume, @dirs) = recursive($volume, @dirs);
556 push(@dirs, $last);
557 return ($volume, @dirs);
558 }
559 }
561 $result = realpath($ARGV[0]);
562 if (!$result) {
563 my ($vol, $dir) = File::Spec->splitpath($ARGV[0], 1);
564 ($vol, @dirs) = recursive($vol, File::Spec->splitdir($dir));
567 }
571 }
575 "Perl script to produce output suitable for use with `file-truename'
576 on the remote file system.
577 Escape sequence %s is replaced with name of Perl binary.
581 "%s -e 'sub case {
582 my $str = shift;
583 if ($ARGV[2]) {
584 return lc($str);
585 }
586 else {
587 return $str;
588 }
589 }
591 @files = readdir(d); closedir(d);
592 foreach $f (@files) {
593 if (case(substr($f, 0, length($ARGV[1]))) eq case($ARGV[1])) {
596 }
597 else {
599 }
600 }
601 }
604 "Perl script to produce output suitable for use with
605 `file-name-all-completions' on the remote file system. Escape
606 sequence %s is replaced with name of Perl binary. This string is
609 ;; Perl script to implement `file-attributes' in a Lisp `read'able
610 ;; output. If you are hacking on this, note that you get *no* output
611 ;; unless this spits out a complete line, including the '\n' at the
612 ;; end.
613 ;; The device number is returned as "-1", because there will be a virtual
614 ;; device number set in `tramp-sh-handle-file-attributes'.
616 "%s -e '
617 @stat = lstat($ARGV[0]);
618 if (!@stat) {
620 exit 0;
621 }
622 if (($stat[2] & 0170000) == 0120000)
623 {
624 $type = readlink($ARGV[0]);
626 }
627 elsif (($stat[2] & 0170000) == 040000)
628 {
630 }
631 else
632 {
634 };
637 printf(
639 $type,
640 $stat[3],
641 $uid,
642 $gid,
643 $stat[8] >> 16 & 0xffff,
644 $stat[8] & 0xffff,
645 $stat[9] >> 16 & 0xffff,
646 $stat[9] & 0xffff,
647 $stat[10] >> 16 & 0xffff,
648 $stat[10] & 0xffff,
649 $stat[7],
650 $stat[2],
651 $stat[1] >> 16 & 0xffff,
652 $stat[1] & 0xffff
654 "Perl script to produce output suitable for use with `file-attributes'
655 on the remote file system.
656 Escape sequence %s is replaced with name of Perl binary.
660 "%s -e '
663 @list = readdir(DIR);
664 closedir(DIR);
665 $n = scalar(@list);
667 for($i = 0; $i < $n; $i++)
668 {
669 $filename = $list[$i];
670 @stat = lstat($filename);
671 if (($stat[2] & 0170000) == 0120000)
672 {
673 $type = readlink($filename);
675 }
676 elsif (($stat[2] & 0170000) == 040000)
677 {
679 }
680 else
681 {
683 };
686 printf(
687 \"(\\\"%%s\\\" %%s %%u %%s %%s (%%u %%u) (%%u %%u) (%%u %%u) %%u.0 %%u t (%%u . %%u) (%%u . %%u))\\n\",
688 $filename,
689 $type,
690 $stat[3],
691 $uid,
692 $gid,
693 $stat[8] >> 16 & 0xffff,
694 $stat[8] & 0xffff,
695 $stat[9] >> 16 & 0xffff,
696 $stat[9] & 0xffff,
697 $stat[10] >> 16 & 0xffff,
698 $stat[10] & 0xffff,
699 $stat[7],
700 $stat[2],
701 $stat[1] >> 16 & 0xffff,
702 $stat[1] & 0xffff,
703 $stat[0] >> 16 & 0xffff,
704 $stat[0] & 0xffff);
705 }
707 "Perl script implementing `directory-files-attributes' as Lisp `read'able
708 output.
709 Escape sequence %s is replaced with name of Perl binary.
712 ;; These two use base64 encoding.
714 "%s -MMIME::Base64 -0777 -ne 'print encode_base64($_)' 2>/dev/null"
715 "Perl program to use for encoding a file.
716 Escape sequence %s is replaced with name of Perl binary.
717 This string is passed to `format', so percent characters need to be doubled.
718 This implementation requires the MIME::Base64 Perl module to be installed
722 "%s -MMIME::Base64 -0777 -ne 'print decode_base64($_)' 2>/dev/null"
723 "Perl program to use for decoding a file.
724 Escape sequence %s is replaced with name of Perl binary.
725 This string is passed to `format', so percent characters need to be doubled.
726 This implementation requires the MIME::Base64 Perl module to be installed
730 "%s -e '
731 # This script contributed by Juanma Barranquero <lektu@terra.es>.
732 # Copyright (C) 2002-2014 Free Software Foundation, Inc.
733 use strict;
735 my %%trans = do {
736 my $i = 0;
737 map {(substr(unpack(q(B8), chr $i++), 2, 6), $_)}
738 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/);
739 };
740 my $data;
742 # We read in chunks of 54 bytes, to generate output lines
743 # of 72 chars (plus end of line)
744 while (read STDIN, $data, 54) {
745 my $pad = q();
747 # Only for the last chunk, and only if did not fill the last three-byte packet
748 if (eof) {
749 my $mod = length($data) %% 3;
750 $pad = q(=) x (3 - $mod) if $mod;
751 }
753 # Not the fastest method, but it is simple: unpack to binary string, split
754 # by groups of 6 bits and convert back from binary to byte; then map into
755 # the translation table
756 print
757 join q(),
758 map($trans{$_},
759 (substr(unpack(q(B*), $data) . q(00000), 0, 432) =~ /....../g)),
760 $pad,
762 }' 2>/dev/null"
763 "Perl program to use for encoding a file.
764 Escape sequence %s is replaced with name of Perl binary.
768 "%s -e '
769 # This script contributed by Juanma Barranquero <lektu@terra.es>.
770 # Copyright (C) 2002-2014 Free Software Foundation, Inc.
771 use strict;
773 my %%trans = do {
774 my $i = 0;
775 map {($_, substr(unpack(q(B8), chr $i++), 2, 6))}
776 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/)
777 };
779 my %%bytes = map {(unpack(q(B8), chr $_), chr $_)} 0 .. 255;
783 # We are going to accumulate into $pending to accept any line length
784 # (we do not check they are <= 76 chars as the RFC says)
785 my $pending = q();
787 while (my $data = <STDIN>) {
788 chomp $data;
790 # If we find one or two =, we have reached the end and
791 # any following data is to be discarded
792 my $finished = $data =~ s/(==?).*/$1/;
793 $pending .= $data;
795 my $len = length($pending);
796 my $chunk = substr($pending, 0, $len & ~3);
797 $pending = substr($pending, $len & ~3 + 1);
799 # Easy method: translate from chars to (pregenerated) six-bit packets, join,
800 # split in 8-bit chunks and convert back to char.
801 print join q(),
802 map $bytes{$_},
803 ((join q(), map {$trans{$_} || q()} split //, $chunk) =~ /......../g);
805 last if $finished;
806 }' 2>/dev/null"
807 "Perl program to use for decoding a file.
808 Escape sequence %s is replaced with name of Perl binary.
812 "%s -e 'binmode STDIN; binmode STDOUT; print pack(q{u*}, join q{}, <>)'"
813 "Perl program to use for encoding a file.
817 "%s -e 'binmode STDIN; binmode STDOUT; print unpack(q{u*}, join q{}, <>)'"
818 "Perl program to use for decoding a file.
823 while read file; do
826 else
828 fi
831 else
833 fi
834 done
836 "Script to check existence of VC related files.
837 It must be send formatted with two strings; the tests for file
838 existence, and file readability. Input shall be read via
839 here-document, otherwise the command could exceed maximum length
842 ;; New handlers should be added here.
846 ;; `byte-compiler-base-file-name' performed by default handler.
851 ;; `diff-latest-backup-file' performed by default handler.
855 . tramp-sh-handle-directory-files-and-attributes)
856 ;; `dired-call-process' performed by default handler.
859 . tramp-sh-handle-dired-recursive-delete-directory)
866 ;; `file-equal-p' performed by default handler.
869 ;; `file-in-directory-p' performed by default handler.
877 ;; `file-name-sans-versions' performed by default handler.
890 ;; `find-file-noselect' performed by default handler.
891 ;; `get-file-buffer' performed by default handler.
895 . tramp-sh-handle-insert-file-contents-literally)
914 "Alist of handler functions.
917 ;; This must be the last entry, because `identity' always matches.
918 ;;;###tramp-autoload
922 ;;; File Name Handler Functions:
926 "Like `make-symbolic-link' for Tramp files.
927 If LINKNAME is a non-Tramp file, it is used verbatim as the target of
928 the symlink. If LINKNAME is a Tramp file, only the localname component is
929 used as the target of the symlink.
931 If LINKNAME is a Tramp file and the localname component is relative, then
932 it is expanded first, before the localname component is taken. Note that
933 this can give surprising results if the user/host for the source and
934 target of the symlink differ."
941 l 'file-error
944 ;; Do the 'confirm if exists' thing.
946 ;; What to do?
951 "File %s already exists; make it a link anyway? "
952 l-localname)))))
957 ;; If FILENAME is a Tramp name, use just the localname component.
966 ;; Right, they are on the same host, regardless of user, method,
967 ;; etc. We now make the link on the remote machine. This will
968 ;; occur as the user that FILENAME belongs to.
970 l
972 "cd %s && %s -sf %s %s"
974 ln
977 t))))
980 "Like `file-truename' for Tramp files."
982 "%s%s"
985 method user host
990 ;; Use GNU readlink --canonicalize-missing where available.
993 v
1001 ;; Use Perl implementation.
1009 v
1013 ;; Do it yourself. We bind `directory-sep-char' here for
1014 ;; XEmacs on Windows, which would otherwise use backslash.
1022 ;; Don't make the following value larger than
1023 ;; necessary. People expect an error message in
1024 ;; a timely fashion when something is wrong;
1025 ;; otherwise they might think that Emacs is hung.
1026 ;; Of course, correctness has to come first.
1028 symlink-target)
1039 method user host
1051 ;; It's a symlink, follow it.
1057 ;; If the symlink was absolute, we'll get a
1058 ;; string like "/user@host:/some/target";
1059 ;; extract the "/some/target" part from it.
1063 v 'file-error
1064 "Symlink target `%s' on wrong host"
1065 symlink-target))
1070 steps)))
1072 ;; It's a file.
1076 v 'file-error
1079 ;; Combine list to form string.
1090 result))))
1092 ;; Preserve trailing "/".
1095 ;; Basic functions.
1098 "Like `file-exists-p' for Tramp files."
1106 v
1108 "%s %s"
1113 "Like `file-attributes' for Tramp files."
1116 ;; Don't modify `last-coding-system-used' by accident.
1123 v
1131 ;; The scripts could fail, for example with huge file size.
1135 "Implement `file-attributes' for Tramp files using the ls(1) command."
1137 res-inode res-filemodes res-numlinks
1138 res-uid res-gid res-size res-symlink-target)
1141 vec
1150 ;; parse `ls -l' output ...
1154 ;; ... inode
1170 ;; ... file mode flags
1172 ;; ... number links
1174 ;; ... uid and gid
1184 ;; ... size
1186 ;; From the file modes, figure out other stuff.
1189 ;; if symlink, find out file name pointed to
1193 ;; return data gathered
1195 ;; 0. t for directory, string (name linked to) for symbolic
1196 ;; link, or nil.
1198 ;; 1. Number of links to file.
1199 res-numlinks
1200 ;; 2. File uid.
1201 res-uid
1202 ;; 3. File gid.
1203 res-gid
1204 ;; 4. Last access time, as a list of integers. Normally this
1205 ;; would be in the same format as `current-time', but the
1206 ;; subseconds part is not currently implemented, and (0 0)
1207 ;; denotes an unknown time.
1208 ;; 5. Last modification time, likewise.
1209 ;; 6. Last status change time, likewise.
1211 ;; 7. Size in bytes (-1, if number is out of range).
1212 res-size
1213 ;; 8. File modes, as a string of ten letters or dashes as in ls -l.
1214 res-filemodes
1215 ;; 9. t if file's gid would change if file were deleted and
1216 ;; recreated. Will be set in `tramp-convert-file-attributes'
1217 t
1218 ;; 10. inode number.
1219 res-inode
1220 ;; 11. Device number. Will be replaced by a virtual device number.
1221 -1
1222 )))))
1226 "Implement `file-attributes' for Tramp files using a Perl script."
1231 vec
1237 "Implement `file-attributes' for Tramp files using stat(1) command."
1240 vec
1242 ;; On Opsware, pdksh (which is the true name of ksh there) doesn't
1243 ;; parse correctly the sequence "((". Therefore, we add a space.
1244 "( (%s %s || %s -h %s) && %s -c '((\"%%N\") %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 \"%%A\" t %%ie0 -1)' %s || echo nil)"
1255 "Like `set-visited-file-modtime' for Tramp files."
1262 coding-system-used)
1266 ;; '(-1 65535) means file doesn't exists yet.
1270 ;; We use '(0 0) as a don't-know value. See also
1271 ;; `tramp-do-file-attributes-with-ls'.
1276 v
1285 nil)))))
1287 ;; This function makes the same assumption as
1288 ;; `tramp-sh-handle-set-visited-file-modtime'.
1290 "Like `verify-visited-file-modtime' for Tramp files.
1291 At the time `verify-visited-file-modtime' calls this function, we
1292 already know that the buffer is visiting a file and that
1293 `visited-file-modtime' does not return 0. Do not call this
1294 function directly, unless those two cases are already taken care
1295 of."
1298 ;; There is no file visiting the buffer, or the buffer has no
1299 ;; recorded last modification time, or there is no established
1300 ;; connection.
1304 t
1312 ;; File exists, and has a known modtime.
1315 modtime
1316 ;; For compatibility, deal with both the old
1317 ;; (HIGH . LOW) and the new (HIGH LOW) return
1318 ;; values of `visited-file-modtime'.
1321 mt)))
1323 ;; Modtime has the don't know value.
1326 v
1333 attr
1336 ;; If file does not exist, say it is not modified if and
1337 ;; only if that agrees with the buffer's record.
1341 "Like `set-file-modes' for Tramp files."
1344 ;; FIXME: extract the proper text from chmod's stderr.
1346 v
1353 "Like `set-file-times' for Tramp files."
1360 time))
1361 ;; With GNU Emacs, `format-time-string' has an
1362 ;; optional parameter UNIVERSAL. This is preferred,
1363 ;; because we could handle the case when the remote
1364 ;; host is located in a different time zone as the
1365 ;; local host.
1369 "%s %s %s %s"
1380 ;; We handle also the local part, because in older Emacsen,
1381 ;; without `set-file-times', this function is an alias for this.
1382 ;; We are local, so we don't need the UTC settings.
1390 "Set the ownership for FILENAME.
1391 If UID and GID are provided, these values are used; otherwise uid
1392 and gid of the corresponding user is taken. Both parameters must
1393 be non-negative integers."
1394 ;; Modern Unices allow chown only for root. So we might need
1395 ;; another implementation, see `dired-do-chown'. OTOH, it is mostly
1396 ;; working with su(do)? when it is needed, so it shall succeed in
1397 ;; the majority of cases.
1398 ;; Don't modify `last-coding-system-used' by accident.
1403 ;; If we are root on the local host, we can do it directly.
1411 "chown %d:%d %s" uid gid
1414 ;; We handle also the local part, because there doesn't exist
1415 ;; `set-file-uid-gid'. On W32 "chown" might not work.
1419 nil "chown" nil nil nil
1423 "Check, whether SELINUX is enabled on the remote host."
1435 "Like `file-selinux-context' for Tramp files."
1444 "%s -d -Z %s"
1452 ;; Return the context.
1453 context))))
1456 "Like `set-file-selinux-context' for Tramp files."
1473 t)
1475 nil)))
1478 "Check, whether ACL is enabled on the remote host."
1483 "Like `file-acl' for Tramp files."
1489 "getfacl -ac %s 2>/dev/null"
1499 "Like `set-file-acl' for Tramp files."
1506 tramp-end-of-heredoc
1507 acl-string
1508 tramp-end-of-heredoc))
1510 ;; Success.
1513 t)
1514 ;; In case of errors, we return `nil'.
1516 nil)))
1518 ;; Simple functions using the `test' command.
1521 "Like `file-executable-p' for Tramp files."
1524 ;; Examine `file-attributes' cache to see if request can be
1525 ;; satisfied without remote operation.
1530 "Like `file-readable-p' for Tramp files."
1533 ;; Examine `file-attributes' cache to see if request can be
1534 ;; satisfied without remote operation.
1538 ;; When the remote shell is started, it looks for a shell which groks
1539 ;; tilde expansion. Here, we assume that all shells which grok tilde
1540 ;; expansion will also provide a `test' command which groks `-nt' (for
1541 ;; newer than). If this breaks, tell me about it and I'll try to do
1542 ;; something smarter about it.
1544 "Like `file-newer-than-file-p' for Tramp files."
1546 nil)
1548 t)
1549 ;; We are sure both files exist at this point.
1552 ;; We try to get the mtime of both files. If they are not
1553 ;; equal to the "dont-know" value, then we subtract the times
1554 ;; and obtain the result.
1560 ;; If one of them is the dont-know value, then we can
1561 ;; still try to run a shell command on the remote host.
1562 ;; However, this only works if both files are Tramp
1563 ;; files and both have the same method, same user, same
1564 ;; host.
1569 v 'file-error
1570 "Files %s and %s must have same method, user, host"
1571 file1 file2)))
1576 ;; Functions implemented using the basic functions above.
1579 "Like `file-directory-p' for Tramp files."
1581 ;; `file-directory-p' is used as predicate for file name completion.
1582 ;; Sometimes, when a connection is not established yet, it is
1583 ;; desirable to return t immediately for "/method:foo:". It can
1584 ;; be expected that this is always a directory.
1590 "Like `file-writable-p' for Tramp files."
1594 ;; Examine `file-attributes' cache to see if request can be
1595 ;; satisfied without remote operation.
1598 ;; If file doesn't exist, check if directory is writable.
1603 "Like `file-ownership-preserved-p' for Tramp files."
1607 ;; Return t if the file doesn't exist, since it's true that no
1608 ;; information would be lost by an (attempted) delete and create.
1615 ;; Directory listings.
1619 "Like `directory-files-and-attributes' for Tramp files."
1623 directory full match nosort id-format)
1625 ;; Do it directly.
1633 v localname
1643 v localname id-format))
1646 v localname id-format)))))))))
1647 result item)
1657 result
1662 "Implement `directory-files-and-attributes' for Tramp files using a Perl script."
1665 vec tramp-perl-directory-files-and-attributes
1669 vec
1673 object))
1677 "Implement `directory-files-and-attributes' for Tramp files using stat(1) command."
1680 vec
1683 ;; We must care about file names with spaces, or starting with
1684 ;; "-"; this would confuse xargs. "ls -aQ" might be a solution,
1685 ;; but it does not work on all remote systems. Therefore, we
1686 ;; quote the file names via sed.
1688 "xargs %s -c "
1697 ;; This function should return "foo/" for directories and "bar" for
1698 ;; files.
1700 "Like `file-name-all-completions' for Tramp files."
1705 filename
1707 'list
1709 ;; Try cache entries for `filename', `filename' with last
1710 ;; character removed, `filename' with last two characters
1711 ;; removed, ..., and finally the empty string - all
1712 ;; concatenated to the local directory name.
1715 tramp-completion-reread-directory-timeout)))
1717 ;; This is inefficient for very long file names, pity
1718 ;; `reduce' is not available...
1721 'append
1726 v
1728 "file-name-all-completions"
1729 nil)))
1731 ;; We cannot use a length of 0, because file properties
1732 ;; for "foo" and "foo/" are identical.
1735 ;; Cache expired or no matching cache entry found so we need
1736 ;; to perform a remote operation.
1738 ;; Get a list of directories and files, including reliably
1739 ;; tagging the directories with a trailing '/'. Because I
1740 ;; rock. --daniel@danann.net
1742 ;; Changed to perform `cd' in the same remote op and only
1743 ;; get entries starting with `filename'. Capture any `cd'
1744 ;; error messages. Ensure any `cd' and `echo' aliases are
1745 ;; ignored.
1747 v
1751 v tramp-perl-file-name-all-completions
1757 ;; `read-file-name-completion-ignore-case'
1758 ;; is introduced with Emacs 22.1.
1761 'read-file-name-completion-ignore-case
1767 ;; `ls' with wildcard might fail with `Argument
1768 ;; list too long' error in some corner cases; if
1769 ;; `ls' fails after `cd' succeeded, chances are
1770 ;; that's the case, so let's retry without
1771 ;; wildcard. This will return "too many" entries
1772 ;; but that isn't harmful.
1773 " || %s -a 2>/dev/null)"
1774 " | while IFS= read f; do"
1780 ;; When `filename' is empty, just `ls' without
1781 ;; `filename' argument is more efficient than `ls *'
1782 ;; for very large directories and might avoid the
1783 ;; `Argument list too long' error.
1784 ;;
1785 ;; With and only with wildcard, we need to add
1786 ;; `-d' to prevent `ls' from descending into
1787 ;; sub-directories.
1789 "."
1794 ;; Now grab the output.
1798 ;; Check result code, found in last line of output.
1802 ;; Grab error message from line before last line
1803 ;; (it was put there by `cd 2>&1').
1806 v 'file-error
1807 "tramp-sh-handle-file-name-all-completions: %s"
1809 ;; For peace of mind, if buffer doesn't end in `fail'
1810 ;; then it should end in `ok'. If neither are in the
1811 ;; buffer something went seriously wrong on the remote
1812 ;; side.
1815 v 'file-error
1816 "\
1817 tramp-sh-handle-file-name-all-completions: internal error accessing `%s': `%s'"
1823 ;; Because the remote op went through OK we know the
1824 ;; directory we `cd'-ed to exists.
1827 ;; Because the remote op went through OK we know every
1828 ;; file listed by `ls' exists.
1832 result)
1834 ;; Store result in the cache.
1839 ;; cp, mv and ln
1843 "Like `add-name-to-file' for Tramp files."
1848 v 'file-error
1849 "add-name-to-file: %s"
1858 "File %s already exists; make it a new name anyway? "
1859 newname)))
1866 v1
1870 "error with add-name-to-file, see buffer `%s' for details"
1875 preserve-uid-gid preserve-extended-attributes)
1876 "Like `copy-file' for Tramp files."
1880 ;; At least one file a Tramp file?
1884 'copy filename newname ok-if-already-exists keep-date
1885 preserve-uid-gid preserve-extended-attributes))
1886 ;; Compat section.
1889 'copy-file
1891 preserve-uid-gid preserve-extended-attributes)))
1894 'copy-file
1902 "Like `copy-directory' for Tramp files."
1908 ;; When DIRNAME and NEWNAME are remote, they must have
1909 ;; the same method.
1915 ;; scp or rsync DTRT.
1929 ;; We must do it file-wise.
1931 'copy-directory
1936 ;; When newname did exist, we have wrong cached values.
1944 "Like `rename-file' for Tramp files."
1945 ;; Check if both files are local -- invoke normal rename-file.
1946 ;; Otherwise, use Tramp from local system.
1949 ;; At least one file a Tramp file?
1959 preserve-uid-gid preserve-extended-attributes)
1960 "Copy or rename a remote file.
1961 OP must be `copy' or `rename' and indicates the operation to perform.
1962 FILENAME specifies the file to copy or rename, NEWNAME is the name of
1963 the new file (for copy) or the new name of the file (for rename).
1964 OK-IF-ALREADY-EXISTS means don't barf if NEWNAME exists already.
1965 KEEP-DATE means to make sure that NEWNAME has the same timestamp
1966 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
1967 the uid and gid if both files are on the same host.
1968 PRESERVE-EXTENDED-ATTRIBUTES activates selinux and acl commands.
1970 This function is invoked by `tramp-sh-handle-copy-file' and
1971 `tramp-sh-handle-rename-file'. It is an error if OP is neither
1972 of `copy' and `rename'. FILENAME and NEWNAME must be absolute
1973 file names."
1990 filename newname)
1993 ;; Both are Tramp files.
1998 ;; Shortcut: if method, host, user are the same for
1999 ;; both files, we invoke `cp' or `mv' on the remote
2000 ;; host directly.
2003 op filename newname
2004 ok-if-already-exists keep-date preserve-uid-gid))
2006 ;; Try out-of-band operation.
2011 op filename newname keep-date))
2013 ;; No shortcut was possible. So we copy the file
2014 ;; first. If the operation was `rename', we go back
2015 ;; and delete the original file (if the copy was
2016 ;; successful). The approach is simple-minded: we
2017 ;; create a new buffer, insert the contents of the
2018 ;; source file into it, then write out the buffer to
2019 ;; the target file. The advantage is that it doesn't
2020 ;; matter which file name handlers are used for the
2021 ;; source and target file.
2024 op filename newname keep-date))))))
2026 ;; One file is a Tramp file, the other one is local.
2029 ;; Fast track on local machine.
2032 op filename newname
2033 ok-if-already-exists keep-date preserve-uid-gid))
2035 ;; If the Tramp file has an out-of-band method, the
2036 ;; corresponding copy-program can be invoked.
2039 op filename newname keep-date))
2041 ;; Use the inline method via a Tramp buffer.
2043 op filename newname keep-date))))
2046 ;; One of them must be a Tramp file.
2049 ;; Handle `preserve-extended-attributes'. We ignore possible
2050 ;; errors, because ACL strings could be incompatible.
2055 ;; In case of `rename', we must flush the cache of the source file.
2061 ;; When newname did exist, we have wrong cached values.
2068 "Use an Emacs buffer to copy or rename a file.
2069 First arg OP is either `copy' or `rename' and indicates the operation.
2070 FILENAME is the source file, NEWNAME the target file.
2071 KEEP-DATE is non-nil if NEWNAME should have the same timestamp as FILENAME."
2073 ;; We must disable multibyte, because binary data shall not be
2074 ;; converted. We remove `tramp-file-name-handler' from
2075 ;; `inhibit-file-name-handlers'; otherwise the file name handler
2076 ;; for `insert-file-contents' might be deactivated in some corner
2077 ;; cases.
2084 ;; We don't want the target file to be compressed, so we let-bind
2085 ;; `jka-compr-inhibit' to t.
2089 ;; KEEP-DATE handling.
2091 ;; Set the mode.
2093 ;; If the operation was `rename', delete the original file.
2098 "Invokes `cp' or `mv' on the remote system.
2099 OP must be one of `copy' or `rename', indicating `cp' or `mv',
2100 respectively. FILENAME specifies the file to copy or rename,
2101 NEWNAME is the name of the new file (for copy) or the new name of
2102 the file (for rename). Both files must reside on the same host.
2103 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2104 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2105 the uid and gid from FILENAME."
2115 v 'file-error
2116 "Unknown operation `%s', must be `copy' or `rename'"
2117 op))))
2121 filename))
2125 newname))
2127 cmd-result)
2130 ;; Both files are on a remote host, with same user.
2142 ;; Mask cp -f error.
2144 tramp-operation-not-permitted-regexp nil t))
2145 cmd-result)
2147 nil v 'file-error
2148 "Copying directly failed, see buffer `%s' for details."
2151 ;; We are on the local host.
2154 ;; We can do it directly.
2157 ;; No sticky bit when renaming.
2168 localname1 localname2 ok-if-already-exists
2169 keep-date preserve-uid-gid)
2173 ;; We can do it directly with `tramp-send-command'
2181 ok-if-already-exists keep-date t)
2182 ;; We must change the ownership to the local user.
2188 ;; We need a temporary file in between.
2190 ;; Create the temporary file.
2198 "%s %s %s" cmd
2201 "Copying directly failed, see buffer `%s' for details."
2203 ;; We must change the ownership as remote user.
2204 ;; Since this does not work reliable, we also
2205 ;; give read permissions.
2216 localname1 tmpfile t
2217 keep-date preserve-uid-gid)
2219 'rename-file
2221 ;; We must change the ownership as local user.
2222 ;; Since this does not work reliable, we also
2223 ;; give read permissions.
2227 tmpfile
2231 ;; Move the temporary file to its destination.
2236 "cp -f -p %s %s"
2239 "Copying directly failed, see buffer `%s' for details."
2243 'rename-file
2246 ;; Save exit.
2249 ;; Set the time and mode. Mask possible errors.
2256 "Invoke `scp' program to copy.
2257 The method used must be an out-of-band method."
2261 copy-program copy-args copy-env copy-keep-date port listener spec
2262 options source target remote-copy-program remote-copy-args)
2267 ;; Both are Tramp files. We shall optimize it when the
2268 ;; methods for FILENAME and NEWNAME are the same.
2278 op filename tmpfile keep-date)
2281 ;; Save exit.
2288 ;; Set variables for computing the prompt for reading
2289 ;; password.
2296 ;; Expand hops. Might be necessary for gateway methods.
2300 ;; Check which ones of source and target are Tramp files.
2309 'file-name-directory
2315 ;; Check for host and port number. We cannot use
2316 ;; `tramp-file-name-port', because this returns also
2317 ;; `tramp-default-port', which might clash with settings in
2318 ;; "~/.ssh/config".
2325 ;; Check for user. There might be an interactive setting.
2329 ;; Check for listener port.
2336 ;; Compose copy command.
2346 spec)
2348 ?h host ?u user ?p port ?r listener ?c options
2355 copy-args
2357 ;; " " has either been a replacement of "%k" (when
2358 ;; keep-date argument is non-nil), or a replacement
2359 ;; for the whole keep-date sublist.
2360 " "
2364 copy-args)
2367 copy-args
2371 copy-env
2373 nil
2380 remote-copy-program
2390 remote-copy-args
2394 ;; Check for local copy program.
2399 ;; Install listener on the remote side. The prompt must be
2400 ;; consumed later on, when the process does not listen anymore.
2407 v 'file-error
2411 'identity
2419 v 'file-error
2420 "Listener process not running on remote host: `%s'"
2421 remote-copy-program))
2429 ;; The default directory must be remote.
2433 ;; Set the transfer process properties.
2443 copy-args
2445 copy-args
2450 ;; Use an asynchronous process. By this, password can
2451 ;; be handled. We don't set a timeout, because the
2452 ;; copying of large files can last longer than 60
2453 ;; secs.
2457 copy-program
2459 copy-args
2468 p v nil tramp-actions-copy-out-of-band)
2470 ;; Check the return code.
2475 orig-vec 'file-error
2476 "Couldn't find exit status of `%s'"
2482 orig-vec 'file-error
2483 "Error copying: `%s'"
2486 ;; Reset the transfer process properties.
2489 ;; Clear the remote prompt.
2492 ;; Houston, we have a problem! Likely, the listener is
2493 ;; still running, so let's clear everything (but the
2494 ;; cached password).
2497 ;; Handle KEEP-DATE argument.
2501 ;; Set the mode.
2506 ;; If the operation was `rename', delete the original file.
2513 "Like `make-directory' for Tramp files."
2525 "Like `delete-directory' for Tramp files."
2537 "Like `delete-file' for Tramp files."
2548 ;; Dired.
2550 ;; CCC: This does not seem to be enough. Something dies when
2551 ;; we try and delete two directories under Tramp :/
2553 "Recursively delete the directory given.
2554 This is like `dired-recursive-delete-directory' for Tramp files."
2556 ;; Run a shell command 'rm -r <localname>'.
2557 ;; Code shamelessly stolen from the dired implementation and, um, hacked :)
2560 ;; Which is better, -r or -R? (-r works for me <daniel@danann.net>).
2562 v
2564 ;; Don't read the output, do it explicitly.
2565 nil t)
2566 ;; Wait for the remote system to return to us...
2567 ;; This might take a while, allow it plenty of time.
2569 ;; Make sure that it worked...
2577 "Like `dired-compress-file' for Tramp files."
2578 ;; OK-FLAG is valid for XEmacs only, but not implemented.
2579 ;; Code stolen mainly from dired-aux.el.
2585 ;; Emacs case
2587 ;; XEmacs has `dired-compression-method-alist', which is
2588 ;; transformed into `dired-compress-file-suffixes' structure.
2592 nil
2595 suffix)
2596 ;; See if any suffix rule matches this file name.
2604 nil)
2606 ;; We found an uncompression rule.
2612 ;; `dired-remove-file' is not defined in XEmacs.
2617 ;; We don't recognize the file as compressed, so compress it.
2618 ;; Try gzip.
2623 ;; `dired-remove-file' is not defined in XEmacs.
2633 "Like `insert-directory' for Tramp files."
2640 filename switches wildcard full-directory-p)
2660 ;; If `full-directory-p', we just say `ls -l FILENAME'.
2661 ;; Else we chdir to the parent directory, then say `ls -ld BASENAME'.
2664 v
2667 switches
2669 localname
2672 v
2676 "Couldn't `cd %s'"
2680 v
2683 switches
2688 ""
2696 ;; We cannot use `insert-buffer-substring' because the Tramp
2697 ;; buffer changes its contents before insertion due to calling
2698 ;; `expand-file' and alike.
2703 ;; Check for "--dired" output.
2710 ;; Now read the numeric positions of file names.
2716 ;; End is followed by \n or by " -> ".
2718 ;; Remove trailing lines.
2724 ;; Some busyboxes are reluctant to discard colors.
2731 ;; Decode the output, it could be multibyte.
2738 ;; The inserted file could be from somewhere else.
2745 "."
2752 ;; Canonicalization of file names.
2755 "Like `expand-file-name' for Tramp files.
2757 the result will be a local, non-Tramp, file name."
2758 ;; If DIR is not given, use `default-directory' or "/".
2760 ;; Unless NAME is absolute, concat DIR and NAME.
2763 ;; If NAME is not a Tramp file, run the real handler.
2766 ;; Dissect NAME.
2770 ;; Tilde expansion if necessary. This needs a shell which
2771 ;; groks tilde expansion! The function `tramp-find-shell' is
2772 ;; supposed to find such a shell on the remote host. Please
2773 ;; tell me about it when this doesn't work on your system.
2777 ;; We cannot simply apply "~/", because under sudo "~/" is
2778 ;; expanded to the local user home directory but to the
2779 ;; root home directory. On the other hand, using always
2780 ;; the default user name for tilde expansion is not
2781 ;; appropriate either, because ssh and companions might
2782 ;; use a user name from the config file.
2794 ;; There might be a double slash, for example when "~/"
2795 ;; expands to "/". Remove this.
2798 ;; No tilde characters in file name, do normal
2799 ;; `expand-file-name' (this does "/./" and "/../"). We bind
2800 ;; `directory-sep-char' here for XEmacs on Windows, which would
2801 ;; otherwise use backslash. `default-directory' is bound,
2802 ;; because on Windows there would be problems with UNC shares or
2803 ;; Cygwin mounts.
2807 method user host
2811 hop)))))
2813 ;;; Remote commands:
2816 "Flush file caches."
2824 ;; We use BUFFER also as connection buffer during setup. Because of
2825 ;; this, its original contents must be saved, and restored once
2826 ;; connection has been setup.
2828 "Like `start-file-process' for Tramp files."
2831 ;; it might be that the arguments exceed the command line
2832 ;; length. Therefore, we modify the command.
2837 ;; When PROGRAM is nil, we just provide a tty.
2843 args
2847 ;; Use a human-friendly prompt, for example for `shell'.
2851 tramp-initial-end-of-output)))
2852 ;; We use as environment the difference to toplevel
2853 ;; `process-environment'.
2854 env
2859 env)
2878 ;; We do not want to raise an error when
2879 ;; `start-file-process' has been started several time in
2880 ;; `eshell' and friends.
2884 ;; BUFFER can be nil. We use a temporary buffer.
2887 ;; NAME must be unique as process name.
2891 ;; Set the new process properties.
2897 ;; We catch this event. Otherwise, `start-process' could
2898 ;; be called on the local host.
2901 ;; Activate narrowing in order to save BUFFER
2902 ;; contents. Clear also the modification time;
2903 ;; otherwise we might be interrupted by
2904 ;; `verify-visited-file-modtime'.
2910 ;; We call `tramp-maybe-open-connection', in order
2911 ;; to cleanup the prompt afterwards.
2917 ;; Now do it.
2919 ;; Send the command.
2921 ;; Check, whether a pty is associated.
2925 v 'file-error
2928 ;; Set query flag and process marker for this
2929 ;; process. We ignore errors, because the process
2930 ;; could have finished already.
2934 ;; Return process.
2935 p))))
2937 ;; Save exit.
2948 "Like `process-file' for Tramp files."
2949 ;; The implementation is not complete yet.
2955 ;; Compute command.
2958 ;; We use as environment the difference to toplevel `process-environment'.
2966 "env %s %s"
2968 ;; Determine input.
2973 ;; INFILE is on the same remote host.
2975 ;; INFILE must be copied to remote host.
2981 ;; Determine output.
2983 ;; Just a buffer.
2986 ;; A buffer name.
2989 ;; (REAL-DESTINATION ERROR-DESTINATION)
2991 ;; output.
2999 ;; stderr.
3004 ;; stderr is on the same remote host.
3007 ;; stderr must be copied to remote host. The temporary
3008 ;; file must be deleted after execution.
3011 method user host stderr))))
3012 ;; stderr to be discarded.
3015 ;; 't
3020 ;; Send the command. It might not return in time, so we protect
3021 ;; it. Call it in a subshell, in order to preserve working
3022 ;; directory.
3029 command)
3030 t t)
3032 ;; We should add the output anyway.
3039 ;; When the user did interrupt, we should do it also. We use
3040 ;; return code -1 as marker.
3044 ;; Handle errors.
3049 ;; Provide error file.
3052 ;; Cleanup. We remove all file cache values for the connection,
3053 ;; because the remote process could have changed them.
3056 ;; `process-file-side-effects' has been introduced with GNU
3057 ;; Emacs 23.2. If set to `nil', no remote file will be changed
3058 ;; by `program'. If it doesn't exist, we assume its default
3059 ;; value `t'.
3064 ;; Return exit status.
3067 ret))))
3070 "Like `file-local-copy' for Tramp files."
3074 v 'file-error
3084 ;; `copy-file' handles direct copy and out-of-band methods.
3089 ;; Use inline encoding for file transfer.
3093 v 3
3101 tmpfile loc-dec)
3103 ;; If local decoding is a function, we call it.
3104 ;; We must disable multibyte, because
3105 ;; `uudecode-decode-region' doesn't handle it
3106 ;; correctly.
3111 ;; Unset `file-name-handler-alist'. Otherwise,
3112 ;; epa-file gets confused.
3118 ;; If tramp-decoding-function is not defined for this
3119 ;; method, we invoke tramp-decoding-command instead.
3121 ;; Unset `file-name-handler-alist'. Otherwise,
3122 ;; epa-file gets confused.
3130 loc-dec tmpfile2 tmpfile)
3133 ;; Set proper permissions.
3135 ;; Set local user ownership.
3138 ;; Oops, I don't know what to do.
3142 ;; Error handling.
3148 tmpfile)))
3150 ;; This is needed for XEmacs only. Code stolen from files.el.
3153 "Like `insert-file-contents-literally' for Tramp files."
3161 nil))
3168 ;; Save exit.
3173 ;; CCC grok LOCKNAME
3176 "Like `write-region' for Tramp files."
3179 ;; Following part commented out because we don't know what to do about
3180 ;; file locking, and it does not appear to be a problem to ignore it.
3181 ;; Ange-ftp ignores it, too.
3182 ;; (when (and lockname (stringp lockname))
3183 ;; (setq lockname (expand-file-name lockname)))
3184 ;; (unless (or (eq lockname nil)
3185 ;; (string= lockname filename))
3186 ;; (error
3187 ;; "tramp-sh-handle-write-region: LOCKNAME must be nil or equal FILENAME"))
3189 ;; XEmacs takes a coding system as the seventh argument, not `confirm'.
3200 ;; `file-writable-p' calls `file-expand-file-name'. We
3201 ;; cannot use `tramp-run-real-handler' therefore.
3207 ;; Short track: if we are on the local host, we can run directly.
3209 'write-region
3213 ;; We use this to save the value of
3214 ;; `last-coding-system-used' after writing the tmp
3215 ;; file. At the end of the function, we set
3216 ;; `last-coding-system-used' to this saved value. This
3217 ;; way, any intermediary coding systems used while
3218 ;; talking to the remote shell or suchlike won't hose
3219 ;; this variable. This approach was snarfed from
3220 ;; ange-ftp.el.
3221 coding-system-used
3222 ;; Write region into a tmp file. This isn't really
3223 ;; needed if we use an encoding function, but currently
3224 ;; we use it always because this makes the logic
3225 ;; simpler. We must also set `temporary-file-directory',
3226 ;; because it could point to a remote directory.
3232 ;; If `append' is non-nil, we copy the file locally, and let
3233 ;; the native `write-region' implementation do the job.
3236 ;; We say `no-message' here because we don't want the
3237 ;; visited file modtime data to be clobbered from the temp
3238 ;; file. We call `set-visited-file-modtime' ourselves later
3239 ;; on. We must ensure that `file-coding-system-alist'
3240 ;; matches `tmpfile'.
3246 'write-region
3253 ;; Now, `last-coding-system-used' has the right value. Remember it.
3258 ;; The permissions of the temporary file should be set. If
3259 ;; FILENAME does not exist (eq modes nil) it has been
3260 ;; renamed to the backup file. This case `save-buffer'
3261 ;; handles permissions.
3262 ;; Ensure that it is still readable.
3265 tmpfile
3268 ;; This is a bit lengthy due to the different methods
3269 ;; possible for file transfer. First, we check whether the
3270 ;; method uses an scp program. If so, we call it.
3271 ;; Otherwise, both encoding and decoding command must be
3272 ;; specified. However, if the method _also_ specifies an
3273 ;; encoding function, then that is used for encoding the
3274 ;; contents of the tmp file.
3279 ;; `copy-file' handles direct copy and out-of-band methods.
3290 ;; We keep the local file for performance
3291 ;; reasons, useful for "rsync".
3298 ;; Don't rename, in order to keep context in SELinux.
3303 ;; Use inline file transfer.
3305 ;; Encode tmpfile.
3309 ;; Use encoding function or command.
3312 tmpfile loc-enc)
3314 ;; The following `let' is a workaround for
3315 ;; the base64.el that comes with pgnus-0.84.
3316 ;; If both of the following conditions are
3317 ;; satisfied, it tries to write to a local
3318 ;; file in default-directory, but at this
3319 ;; point, default-directory is remote.
3320 ;; (`call-process-region' can't write to
3321 ;; remote files, it seems.) The file in
3322 ;; question is a tmp file anyway.
3330 loc-enc tmpfile t))
3332 v 'file-error
3335 filename loc-enc))))
3337 ;; Send buffer into remote decoding command which
3338 ;; writes to remote file. Because this happens on
3339 ;; the remote host, we cannot use the function.
3342 filename rem-dec)
3346 v
3350 tramp-end-of-heredoc
3352 tramp-end-of-heredoc))
3354 v nil
3355 "Couldn't write region to `%s', decode using `%s' failed"
3356 filename rem-dec)
3357 ;; When `file-precious-flag' is set, the region is
3358 ;; written to a temporary file. Check that the
3359 ;; checksum is equal to that from the local tmpfile.
3363 ;; cksum runs locally, if possible.
3365 ;; cksum runs remotely.
3367 v
3370 ;; ... they are different.
3377 v 'file-error
3380 filename rem-dec)))))
3382 ;; Save exit.
3385 ;; That's not expected.
3388 v 'file-error
3391 method))))
3393 ;; Make `last-coding-system-used' have the right value.
3400 ;; We must protect `last-coding-system-used', now we have set it
3401 ;; to its correct value.
3403 ;; Set file modification time.
3407 ;; We must pass modtime explicitly, because FILENAME can
3408 ;; be different from (buffer-file-name), f.e. if
3409 ;; `file-precious-flag' is set.
3415 ;; Set the ownership.
3425 ;; VC backends check for the existence of various different special
3426 ;; files. This is very time consuming, because every single check
3427 ;; requires a remote command (the file cache must be invalidated).
3428 ;; Therefore, we apply a kind of optimization. We install the file
3429 ;; name handler `tramp-vc-file-name-handler', which does nothing but
3430 ;; remembers all file names for which `file-exists-p' or
3431 ;; `file-readable-p' has been applied. A first run of `vc-registered'
3432 ;; is performed. Afterwards, a script is applied for all collected
3433 ;; file names, using just one remote command. The result of this
3434 ;; script is used to fill the file cache with actual values. Now we
3435 ;; can reset the file name handlers, and we make a second run of
3436 ;; `vc-registered', which returns the expected result without sending
3437 ;; any other remote command.
3439 "Like `vc-registered' for Tramp files."
3445 ;; There could be new files, created by the vc backend. We
3446 ;; cannot reuse the old cache entries, therefore. In
3447 ;; `tramp-get-file-property', `remote-file-name-inhibit-cache'
3448 ;; could also be a timestamp as `current-time' returns. This
3449 ;; means invalidate all cache entries with an older timestamp.
3455 ;; Here we collect only file names, which need an operation.
3459 ;; Send just one command, in order to fill the cache.
3462 v
3471 ;; We cannot use `tramp-send-command-and-read',
3472 ;; because this does not cooperate well with
3473 ;; heredoc documents.
3475 v
3478 tramp-end-of-heredoc
3480 tramp-vc-registered-file-names
3482 tramp-end-of-heredoc))
3484 ;; Read the expression.
3491 ;; Second run. Now all `file-exists-p' or `file-readable-p'
3492 ;; calls shall be answered from the file cache. We unset
3493 ;; `process-file-side-effects' and `remote-file-name-inhibit-cache'
3494 ;; in order to keep the cache.
3496 remote-file-name-inhibit-cache process-file-side-effects)
3497 ;; Reduce `vc-handled-backends' in order to minimize process calls.
3516 ;; Run.
3520 ;;;###tramp-autoload
3522 "Invoke remote-shell Tramp file name handler.
3523 Fall back to normal file name handler if no Tramp handler exists."
3541 "Invoke special file name handler, which collects files to be handled."
3549 ;; That's what we want: file names, for which checks are
3550 ;; applied. We assume that VC uses only `file-exists-p' and
3551 ;; `file-readable-p' checks; otherwise we must extend the
3552 ;; list. We do not perform any action, but return nil, in
3553 ;; order to keep `vc-registered' running.
3556 nil)
3557 ;; `process-file' and `start-file-process' shall be ignored.
3560 ;; Tramp file name handlers like `expand-file-name'. They
3561 ;; must still work.
3563 ;; Default file name handlers, we don't care.
3567 "Like `file-notify-add-watch' for Tramp files."
3571 command events filter p sequence)
3573 ;; gvfs-monitor-dir.
3577 ;; inotifywait.
3580 events
3587 ;; None.
3589 v 'file-notify-error
3590 "No file notification program found on %s"
3592 ;; Start process.
3594 'start-file-process
3598 sequence))
3599 ;; Return the process object as watch-descriptor.
3602 v 'file-notify-error
3603 "`%s' failed to start on remote host"
3609 p))))
3621 ;; Attribute change is returned in unused wording.
3631 string)
3634 proc
3638 ;; File names are returned as absolute paths. We must
3639 ;; add the remote prefix.
3644 ;; Usually, we would add an Emacs event now. Unfortunately,
3645 ;; `unread-command-events' does not accept several events at
3646 ;; once. Therefore, we apply the callback directly.
3649 ;; Save rest of the string.
3658 ;; Check, whether there is a problem.
3664 line)
3669 proc
3676 ;; Usually, we would add an Emacs event now. Unfortunately,
3677 ;; `unread-command-events' does not accept several events at
3678 ;; once. Therefore, we apply the callback directly.
3681 ;;; Internal Functions:
3684 "Define in remote shell function NAME implemented as SCRIPT.
3685 Only send the definition if it has not already been done."
3686 ;; We cannot let-bind (tramp-get-connection-process vec) because it
3687 ;; might be nil.
3692 ;; The script could contain a call of Perl. This is masked with `%s'.
3697 vec
3708 auto-save-default)
3716 "Run `test' on the remote system, given a SWITCH and a FILENAME.
3717 Returns the exit code of the `test' program."
3720 v
3722 "%s %s %s"
3724 switch
3728 "Run `test'-like program on the remote system, given FILE1, FILE2.
3729 FORMAT-STRING contains the program name, switches, and place holders.
3730 Returns the exit code of the `test' program. Barfs if the methods,
3731 hosts, or files, disagree."
3735 v 'file-error
3740 v1
3747 "Searches for PROGNAME in $PATH and all directories mentioned in DIRLIST.
3748 First arg VEC specifies the connection, PROGNAME is the program
3749 to search for, and DIRLIST gives the list of directories to
3750 search. If IGNORE-TILDE is non-nil, directory names starting
3751 with `~' will be ignored. If IGNORE-PATH is non-nil, searches
3752 only in DIRLIST.
3754 Returns the absolute file name of PROGNAME, if found, and nil otherwise.
3756 This function expects to be in the right *tramp* buffer."
3759 ;; Check whether the executable is in $PATH. "which(1)" does not
3760 ;; report always a correct error code; therefore we check the
3761 ;; number of words it returns. "SunOS 5.10" (and maybe "SunOS
3762 ;; 5.11") have problems with this command, we disable the call
3763 ;; therefore.
3774 ;; Remove all ~/foo directories from dirlist. In XEmacs,
3775 ;; `remove' is in CL, and we want to avoid CL dependencies.
3784 vec
3786 "do if test -x $d/%s -a -f $d/%s; "
3787 "then echo tramp_executable $d/%s; "
3790 progname progname progname
3791 tramp-end-of-heredoc
3793 tramp-end-of-heredoc))
3799 result)))
3802 "Sets the remote environment PATH to existing directories.
3803 I.e., for each directory in `tramp-remote-path', it is tested
3804 whether it exists and if so, it is added to the environment
3805 variable PATH."
3811 ;; ------------------------------------------------------------
3812 ;; -- Communication with external shell --
3813 ;; ------------------------------------------------------------
3816 "Find a command on the remote host for checking if a file exists.
3817 Here, we are looking for a command which has zero exit status if the
3818 file exists and nonzero exit status otherwise."
3822 result)
3823 ;; The algorithm is as follows: we try a list of several commands.
3824 ;; For each command, we first run `$cmd /' -- this should return
3825 ;; true, as the root directory always exists. And then we run
3826 ;; `$cmd /this\ file\ does\ not\ exist ', hoping that the file indeed
3827 ;; does not exist. This should return false. We use the first
3828 ;; command we find that seems to work.
3829 ;; The list of commands to try is as follows:
3830 ;; `ls -d' This works on most systems, but NetBSD 1.4
3831 ;; has a bug: `ls' always returns zero exit
3832 ;; status, even for files which don't exist.
3833 ;; `test -e' Some Bourne shells have a `test' builtin
3834 ;; which does not know the `-e' option.
3835 ;; `/bin/test -e' For those, the `test' binary on disk normally
3836 ;; provides the option. Alas, the binary
3837 ;; is sometimes `/bin/test' and sometimes it's
3838 ;; `/usr/bin/test'.
3839 ;; `/usr/bin/test -e' In case `/bin/test' does not exist.
3867 result))
3870 "Opens shell SHELL."
3873 ;; Find arguments for this shell.
3875 item extra-args)
3880 ;; It is useful to set the prompt in the following command
3881 ;; because some people have a setting for $PS1 which /bin/sh
3882 ;; doesn't know about and thus /bin/sh will display a strange
3883 ;; prompt. For example, if $PS1 has "${CWD}" in the value, then
3884 ;; ksh will display the current working directory but /bin/sh
3885 ;; will display a dollar sign. The following command line sets
3886 ;; $PS1 to a sane value, and works under Bourne-ish shells as
3887 ;; well as csh-like shells. We also unset the variable $ENV
3888 ;; because that is read by some sh implementations (eg, bash
3889 ;; when called as sh) on startup; this way, we avoid the startup
3890 ;; file clobbering $PS1. $PROMPT_COMMAND is another way to set
3891 ;; the prompt in /bin/bash, it must be discarded as well.
3894 "exec env ENV=''%s PROMPT_COMMAND='' PS1=%s PS2='' PS3='' %s %s"
3900 t))
3905 "Opens a shell on the remote host which groks tilde expansion."
3913 shell)
3916 ;; CCC: "root" does not exist always, see QNAP 459.
3917 ;; Which check could we apply instead?
3920 ;; The default shell (ksh93) of OpenSolaris and
3921 ;; Solaris is buggy. We've got reports for
3922 ;; "SunOS 5.10" and "SunOS 5.11" so far.
3931 ;; Maybe it works at least for some other commands.
3933 default-shell
3935 vec 2
3937 "Couldn't find a remote shell which groks tilde "
3939 default-shell)))
3941 default-shell)))
3943 ;; Open a new shell if needed.
3949 ;; Utility functions.
3952 "Wait for shell prompt and barf if none appears.
3953 Looks at process PROC to see if a shell prompt appears in TIMEOUT
3954 seconds. If not, it produces an error message with the given ERROR-ARGS."
3958 proc timeout
3967 "Set up an interactive shell.
3968 Mainly sets the prompt and the echo correctly. PROC is the shell
3969 process to set up. VEC specifies the connection."
3972 vec
3977 ;; Disable echo.
3980 ;; Check whether the echo has really been disabled. Some
3981 ;; implementations, like busybox of embedded GNU/Linux, don't
3982 ;; support disabling.
3989 ;; Make sure backspaces and their echo are enabled and no line
3990 ;; width magic interferes with them.
3998 ;; Try to set up the coding system correctly.
3999 ;; CCC this can't be the right way to do it. Hm.
4003 ;; Use MULE to select the right EOL convention for communicating
4004 ;; with the process.
4010 cs-decode cs-encode)
4027 ;; Look for ^M and do something useful if found.
4029 ;; We have found a ^M but cannot frob the process coding system
4030 ;; because we're running on a non-MULE Emacs. Let's try
4031 ;; stty, instead.
4036 ;; Check whether the output of "uname -sr" has been changed. If
4037 ;; yes, this is a strong indication that we must expire all
4038 ;; connection properties. We start again with
4039 ;; `tramp-maybe-open-connection', it will be caught there.
4044 vec "uname"
4048 vec 3
4049 "Connection reset, because remote host changed from `%s' to `%s'"
4050 old-uname new-uname)
4051 ;; We want to keep the password.
4055 ;; Check whether the remote host suffers from buggy
4056 ;; `send-process-string'. This is known for FreeBSD (see comment in
4057 ;; `send_process', file process.c). I've tested sending 624 bytes
4058 ;; successfully, sending 625 bytes failed. Emacs makes a hack when
4059 ;; this host type is detected locally. It cannot handle remote
4060 ;; hosts, though.
4064 tramp-chunksize)
4072 ;; Set remote PATH variable.
4075 ;; Search for a good shell before searching for a command which
4076 ;; checks if a file exists. This is done because Tramp wants to use
4077 ;; "test foo; echo $?" to check if various conditions hold, and
4078 ;; there are buggy /bin/sh implementations which don't execute the
4079 ;; "echo $?" part if the "test" part has an error. In particular,
4080 ;; the OpenSolaris /bin/sh is a problem. There are also other
4081 ;; problems with /bin/sh of OpenSolaris, like redirection of stderr
4082 ;; in function declarations, or changing HISTFILE in place.
4083 ;; Therefore, OpenSolaris' /bin/sh is replaced by bash, when
4084 ;; detected.
4087 ;; Disable unexpected output.
4090 ;; IRIX64 bash expands "!" even when in single quotes. This
4091 ;; destroys our shell functions, we must disable it. See
4092 ;; <http://stackoverflow.com/questions/3291692/irix-bash-shell-expands-expression-in-single-quotes-yet-shouldnt>.
4096 ;; On BSD-like systems, ?\t is expanded to spaces. Suppress this.
4101 ;; Set `remote-tty' process property.
4106 ;; Dump stty settings in the traces.
4110 ;; Set the environment.
4115 unset vars item)
4125 vec
4127 tramp-end-of-heredoc
4129 tramp-end-of-heredoc)
4130 t))
4135 ;; Old text from documentation of tramp-methods:
4136 ;; Using a uuencode/uudecode inline method is discouraged, please use one
4137 ;; of the base64 methods instead since base64 encoding is much more
4138 ;; reliable and the commands are more standardized between the different
4139 ;; Unix versions. But if you can't use base64 for some reason, please
4140 ;; note that the default uudecode command does not work well for some
4141 ;; Unices, in particular AIX and Irix. For AIX, you might want to use
4142 ;; the following command for uudecode:
4143 ;;
4144 ;; sed '/^begin/d;/^[` ]$/d;/^end/d' | iconv -f uucode -t ISO8859-1
4145 ;;
4146 ;; For Irix, no solution is known yet.
4154 "List of local coding commands for inline transfer.
4155 Each item is a list that looks like this:
4157 \(FORMAT ENCODING DECODING\)
4159 FORMAT is symbol describing the encoding/decoding format. It can be
4160 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4162 ENCODING and DECODING can be strings, giving commands, or symbols,
4163 giving functions. If they are strings, then they can contain
4165 file name will be put into the command line at that spot. If the
4166 specifier is not present, the input should be read from standard
4167 input.
4169 If they are functions, they will be called with two arguments, start
4170 and end of region, and are expected to replace the region contents
4175 ;; "-i" is more robust with older base64 from GNU coreutils.
4176 ;; However, I don't know whether all base64 versions do supports
4177 ;; this option.
4189 "List of remote coding commands for inline transfer.
4190 Each item is a list that looks like this:
4192 \(FORMAT ENCODING DECODING [TEST]\)
4194 FORMAT is a symbol describing the encoding/decoding format. It can be
4195 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4197 ENCODING and DECODING can be strings, giving commands, or symbols,
4198 giving variables. If they are strings, then they can contain
4200 file name will be put into the command line at that spot. If the
4201 specifier is not present, the input should be read from standard
4202 input.
4204 If they are variables, this variable is a string containing a
4205 Perl or Shell implementation for this functionality. This
4206 program will be transferred to the remote host, and it is
4208 specifier in the variable value denotes a temporary file.
4210 The optional TEST command can be used for further tests, whether
4214 "Find an inline transfer encoding that works.
4215 Goes through the list `tramp-local-coding-commands' and
4216 `tramp-remote-coding-commands'."
4221 loc-enc loc-dec rem-enc rem-dec rem-test litem ritem found)
4229 ;; If the local encoder or decoder is a string, the
4230 ;; corresponding command has to work locally.
4237 loc-enc nil nil))
4245 loc-dec nil nil))
4247 ;; Search for remote coding commands with the same format
4255 ;; Check the remote test command if exists.
4261 ;; Check if remote perl exists when necessary.
4265 ;; Check if remote encoding and decoding commands can be
4266 ;; called remotely with null input and output. This makes
4267 ;; sure there are no syntax errors and the command is really
4268 ;; found. Note that we do not redirect stdout to /dev/null,
4269 ;; for two reasons: when checking the decoding command, we
4270 ;; actually check the output it gives. And also, when
4271 ;; redirecting "mimencode" output to /dev/null, then as root
4272 ;; it might change the permissions of /dev/null!
4280 vec 5
4289 tmpfile)
4296 tramp-temp-name-prefix
4298 value
4300 value
4302 ?t
4308 vec 5
4311 vec
4313 t)
4321 ;; `rem-enc' and `rem-dec' could be a string meanwhile.
4327 ;; Set connection properties. Since the commands are risky
4328 ;; (due to output direction), we cache them in the process cache.
4339 "Call the local encoding or decoding command.
4341 Otherwise, INPUT is passed via standard input.
4342 INPUT can also be nil which means `/dev/null'.
4343 OUTPUT can be a string (which specifies a file name), or t (which
4344 means standard output and thus the current buffer), or nil (which
4345 means discard it)."
4347 nil tramp-encoding-shell
4350 nil
4351 tramp-encoding-command-switch
4361 "List of compress and decompress commands for inline transfer.
4362 Each item is a list that looks like this:
4364 \(COMPRESS DECOMPRESS\)
4369 "Find an inline transfer compress command that works.
4370 Goes through the list `tramp-inline-compress-commands'."
4375 item compress decompress found)
4382 vec 5
4383 "Checking local compress commands `%s', `%s' for sanity"
4384 compress decompress)
4389 ;; Windows shells need the program file name after
4390 ;; the pipe symbol be quoted if they use forward
4391 ;; slashes as directory separators.
4398 vec 5
4399 "Checking remote compress commands `%s', `%s' for sanity"
4400 compress decompress)
4406 ;; Did we find something?
4409 ;; Set connection properties. Since the commands are
4410 ;; risky (due to output direction), we cache them in the
4411 ;; process cache.
4425 "Expands VEC according to `tramp-default-proxies-alist'.
4426 Gateway hops are already opened."
4430 choices proxy)
4432 ;; Ad-hoc proxy definitions.
4437 tramp-prefix-format proxy tramp-postfix-host-format)))
4442 proxy)
4443 ;; Add the hop.
4445 'tramp-default-proxies-alist
4448 proxy))
4450 ;; Save the new value.
4455 ;; Look for proxy hosts to be passed.
4461 ;; Host.
4464 ;; User.
4468 ;; No more hops needed.
4470 ;; Replace placeholders.
4473 proxy
4478 ;; Add the hop.
4480 ;; Start next search.
4483 ;; Handle gateways.
4491 ;; Is the method prepared for gateways?
4494 vec 'file-error
4496 ;; Open the gateway connection.
4501 target-alist)
4502 ;; For the password prompt, we need the correct values.
4503 ;; Therefore, we must remember the gateway vector. But we
4504 ;; cannot do it as connection property, because it shouldn't
4505 ;; be persistent. And we have no started process yet either.
4508 ;; Foreign and out-of-band methods are not supported for multi-hops.
4521 vec 'file-error
4522 "Method `%s' is not supported for multi-hops."
4525 ;; In case the host name is not used for the remote shell
4526 ;; command, the user could be misguided by applying a random
4527 ;; hostname.
4533 ;; There are multi-hops.
4535 ;; The host name is used for the remote shell command.
4538 ;; The host is local. We cannot use `tramp-local-host-p'
4539 ;; here, because it opens a connection as well.
4542 v 'file-error
4543 "Host `%s' looks like a remote host, `%s' can only use the local host"
4544 host method)))
4546 ;; Result.
4547 target-alist))
4550 "Maybe open a connection VEC.
4551 Does not do anything if a connection is already open, but re-opens the
4552 connection if a previous connection has died for some reason."
4560 ;; If Tramp opens the same connection within a short time frame,
4561 ;; there is a problem. We shall signal this.
4570 ;; If too much time has passed since last command was sent, look
4571 ;; whether process is still alive. If it isn't, kill it. When
4572 ;; using ssh, it can sometimes happen that the remote end has hung
4573 ;; up but the local ssh client doesn't recognize this until it
4574 ;; tries to send some data to the remote end. So that's why we
4575 ;; try to send a command from time to time, then look again
4576 ;; whether the process is really alive.
4587 ;; The error will be caught locally.
4593 ;; New connection must be opened.
4597 ;; If `non-essential' is non-nil, don't reopen a new connection.
4602 vec 3
4613 ;; Start new process.
4623 ;; We will apply `tramp-ssh-controlmaster-options'
4624 ;; only for the first hop.
4630 ;; This must be done in order to avoid our file
4631 ;; name handler.
4635 'start-process
4640 tramp-encoding-command-interactive)
4643 ;; Set sentinel and query flag.
4654 ;; Check whether process is alive.
4656 p 10
4659 ;; Now do all the connections as specified.
4688 ;; We don't create the temporary file. In
4689 ;; fact, it is just a prefix for the
4690 ;; ControlPath option of ssh; the real
4691 ;; temporary file has another name, and it is
4692 ;; created and protected by ssh. It is also
4693 ;; removed by ssh when the connection is
4694 ;; closed. The temporary file name is cached
4695 ;; in the main connection process, therefore
4696 ;; we cannot use `tramp-get-connection-process'.
4702 tramp-temp-name-prefix
4704 spec r-shell)
4706 ;; Add arguments for asynchronous processes.
4710 ;; Add gateway arguments if necessary.
4714 ;; Check for port number. Until now, there's no
4715 ;; need for handling like method, user, host.
4720 ;; Check, whether there is a restricted shell.
4725 ;; Set variables for computing the prompt for
4726 ;; reading password. They can also be derived
4727 ;; from a gateway.
4732 ;; Add login environment.
4735 login-env
4740 login-env))
4744 "%s=%s %s"
4747 command)))
4750 ;; Replace `login-args' place holders.
4758 ?h l-host ?u l-user ?p l-port ?c options)
4759 command
4761 ;; We do not want to see the trailing local
4762 ;; prompt in `start-file-process'.
4764 command " "
4770 ;; Local shell could be a Windows COMSPEC. It
4771 ;; doesn't know the ";" syntax, but we must exit
4772 ;; always for `start-file-process'. It could
4773 ;; also be a restricted shell, which does not
4774 ;; allow "exec".
4777 ;; Send the command.
4781 p vec pos tramp-actions-before-shell
4785 ;; Next hop.
4789 ;; Make initial shell settings.
4792 ;; When the user did interrupt, we must cleanup.
4795 ;; Propagate the quit signal.
4799 "Send the COMMAND to connection VEC.
4800 Erases temporary buffer before sending the command. If optional
4801 arg NEVEROPEN is non-nil, never try to open the connection. This
4802 is meant to be used from `tramp-maybe-open-connection' only. The
4803 function waits for output unless NOOUTPUT is set."
4807 ;; We mark the command string that it can be erased in the output buffer.
4809 ;; If we put `tramp-echo-mark' after a trailing newline (which
4810 ;; is assumed to be unquoted) `tramp-send-string' doesn't see
4811 ;; that newline and adds `tramp-rsh-end-of-line' right after
4812 ;; `tramp-echo-mark', so the remote shell sees two consecutive
4813 ;; trailing line endings and sends two prompts after executing
4814 ;; the command, which confuses `tramp-wait-for-output'.
4818 ;; No need to restore a trailing newline here since `tramp-send-string'
4819 ;; makes sure that the string ends in `tramp-rsh-end-of-line', anyway.
4821 ;; Send the command.
4827 "Wait for output from remote command."
4833 ;; be leading escape sequences, which must be ignored.
4835 ;; Sometimes, the commands do not return a newline but a
4836 ;; null byte before the shell prompt, for example "git
4837 ;; ls-files -c -z ...".
4842 ;; A simple-minded busybox has sent " ^H" sequences.
4843 ;; Delete them.
4848 ;; Delete the prompt.
4854 proc 'file-error
4855 "[[Remote prompt `%s' not found in %d secs]]"
4856 tramp-end-of-output timeout)
4858 proc 'file-error
4860 ;; Return value is whether end-of-output sentinel was found.
4861 found)))
4865 "Run COMMAND and check its exit status.
4866 Sends `echo $?' along with the COMMAND for checking the exit status.
4867 If COMMAND is nil, just sends `echo $?'. Returns `t' if the exit
4868 status is 0, and `nil' otherwise.
4870 If the optional argument SUBSHELL is non-nil, the command is
4871 executed in a subshell, ie surrounded by parentheses. If
4872 DONT-SUPPRESS-ERR is non-nil, stderr won't be sent to /dev/null."
4874 vec
4876 command
4878 "echo tramp_exit_status $?"
4892 "Run COMMAND, check exit status, throw error if exit status not okay.
4893 Similar to `tramp-send-command-and-check' but accepts two more arguments
4894 FMT and ARGS which are passed to `error'."
4899 "Run COMMAND and return the output, which must be a Lisp expression.
4900 In case there is no valid Lisp expression and NOERROR is nil, it
4901 raises an error."
4907 ;; Read the expression.
4911 ;; Error handling.
4916 vec 'file-error
4917 "`%s' does not return a valid Lisp expression: `%s'"
4921 "Convert `file-attributes' ATTR generated by perl script, stat or ls.
4922 Convert file mode bits to string and set virtual device number.
4923 Return ATTR."
4925 ;; Remove color escape sequences from symlink.
4929 ;; Convert uid and gid. Use -1 as indication of unusable value.
4940 ;; Convert last access time.
4945 ;; Convert last modification time.
4950 ;; Convert last status change time.
4955 ;; Convert file size.
4961 ;; Convert file mode bits to string.
4966 ;; Convert directory indication bit.
4969 ;; Convert symlink from `tramp-do-file-attributes-with-stat'.
4975 ;; Set file's gid change bit.
4983 ;; Convert inode.
4989 ;; Inodes can be incredible huge. We must hide this.
4991 ;; Set virtual device number.
4994 attr))
4997 "Converts STRING to shell glob pattern which ignores case."
5003 string
5007 "Create a file name suitable to be passed to `scp' or `nc' and workalikes."
5015 localname)
5021 "Return t if this is an out-of-band method, nil otherwise."
5023 ;; It shall be an out-of-band method.
5025 ;; There must be a size, otherwise the file doesn't exist.
5027 ;; Either the file size is large enough, or (in rare cases) there
5028 ;; does not exist a remote encoding.
5033 ;; Variables local to connection.
5037 ;; When `tramp-own-remote-path' is in `tramp-remote-path', we
5038 ;; cache the result for the session only. Otherwise, the result
5039 ;; is cached persistently.
5042 vec)
5043 "remote-path"
5052 ;; Default if "getconf" is not available.
5055 vec 3
5060 ;; We cannot apply `tramp-send-command-and-read' because
5061 ;; the login shell could return more than just the $PATH
5062 ;; string. So we emulate that function.
5065 vec
5071 'identity
5080 ;; Replace place holder `tramp-default-remote-path'.
5088 ;; Replace place holder `tramp-own-remote-path'.
5096 ;; Remove double entries.
5103 ;; Remove non-existing directories.
5105 nil
5115 x))
5116 x))
5117 remote-path)))))
5123 locale)
5129 candidates nil)
5131 ;; Return value.
5141 result)
5143 ;; Check parameters. On busybox, "ls" output coloring is
5144 ;; enabled by default sometimes. So we try to disable it
5145 ;; when possible. $LS_COLORING is not supported there.
5146 ;; Some "ls" versions are sensible wrt the order of
5147 ;; arguments, they fail when "-al" is after the
5148 ;; "--color=never" argument (for example on FreeBSD).
5163 ;; Some "ls" versions are sensible wrt the order of arguments,
5164 ;; they fail when "-al" is after the "--dired" argument (for
5165 ;; example on FreeBSD).
5173 "test"
5177 ;; Does `test A -nt B' work? Use abominable `find' construct if it
5178 ;; doesn't. BSD/OS 4.0 wants the parentheses around the command,
5179 ;; for otherwise the shell crashes.
5191 vec
5214 ;; We must check also for some Perl modules.
5222 result)))
5229 tmp)
5230 ;; Check whether stat(1) returns usable syntax. "%s" does not
5231 ;; work on older AIX systems.
5240 result)))
5250 result))))
5266 ;; Busyboxes do support the "-t" option only when they have been
5267 ;; built with the DESKTOP config option. Let's check it.
5270 vec "touch-t"
5272 vec
5274 "%s -t %s %s"
5275 result
5279 result)))
5298 result)
5300 ;; Check POSIX parameter.
5307 vec
5316 vec
5320 "print $>"
5332 vec
5336 "import os; print (os.getuid())"
5350 ;; Ensure there is a valid result.
5358 vec
5367 vec
5376 vec
5380 "import os; print (os.getgid())"
5394 ;; Ensure there is a valid result.
5400 ;; Some predefined connection properties.
5402 "Return the compress command related to PROP.
5403 PROP is either `inline-compress' or `inline-decompress'. SIZE is
5404 the length of the file to be compressed.
5406 If no corresponding command is found, nil is returned."
5415 "Return the coding command related to PROP.
5416 PROP is either `remote-encoding', `remote-decoding',
5417 `local-encoding' or `local-decoding'.
5419 SIZE is the length of the file to be coded. Depending on SIZE,
5420 compression might be applied.
5422 If no corresponding command is found, nil is returned.
5423 Otherwise, either a string is returned which contains a `%s' mark
5424 to be used for the respective input or output file; or a Lisp
5425 function cell is returned to be applied on a buffer."
5426 ;; We must catch the errors, because we want to return `nil', when
5427 ;; no inline coding is found.
5437 compress)
5438 ;; The connection property might have been cached. So we must
5439 ;; send the script to the remote side - maybe.
5447 ;; Check for the `compress' command.
5449 ;; Return the value.
5465 'call-process-region beg end
5470 coding)
5473 ;; Windows shells need the program file name after
5474 ;; the pipe symbol be quoted if they use forward
5475 ;; slashes as directory separators.
5482 coding compress))
5485 ;; Windows shells need the program file name after
5486 ;; the pipe symbol be quoted if they use forward
5487 ;; slashes as directory separators.
5492 compress coding))
5506 ;;; TODO:
5508 ;; * Don't use globbing for directories with many files, as this is
5509 ;; likely to produce long command lines, and some shells choke on
5510 ;; long command lines.
5511 ;; * Make it work for different encodings, and for different file name
5512 ;; encodings, too. (Daniel Pittman)
5513 ;; * Don't search for perl5 and perl. Instead, only search for perl and
5514 ;; then look if it's the right version (with `perl -v').
5515 ;; * When editing a remote CVS controlled file as a different user, VC
5516 ;; gets confused about the file locking status. Try to find out why
5517 ;; the workaround doesn't work.
5518 ;; * Allow out-of-band methods as _last_ multi-hop. Open a connection
5519 ;; until the last but one hop via `start-file-process'. Apply it
5520 ;; also for ftp and smb.
5521 ;; * WIBNI if we had a command "trampclient"? If I was editing in
5522 ;; some shell with root privileges, it would be nice if I could
5523 ;; just call
5524 ;; trampclient filename.c
5525 ;; as an editor, and the _current_ shell would connect to an Emacs
5526 ;; server and would be used in an existing non-privileged Emacs
5527 ;; session for doing the editing in question.
5528 ;; That way, I need not tell Emacs my password again and be afraid
5529 ;; that it makes it into core dumps or other ugly stuff (I had Emacs
5530 ;; once display a just typed password in the context of a keyboard
5531 ;; sequence prompt for a question immediately following in a shell
5532 ;; script run within Emacs -- nasty).
5533 ;; And if I have some ssh session running to a different computer,
5534 ;; having the possibility of passing a local file there to a local
5535 ;; Emacs session (in case I can arrange for a connection back) would
5536 ;; be nice.
5537 ;; Likely the corresponding Tramp server should not allow the
5538 ;; equivalent of the emacsclient -eval option in order to make this
5539 ;; reasonably unproblematic. And maybe trampclient should have some
5540 ;; way of passing credentials, like by using an SSL socket or
5541 ;; something. (David Kastrup)
5542 ;; * Reconnect directly to a compliant shell without first going
5543 ;; through the user's default shell. (Pete Forman)
5544 ;; * How can I interrupt the remote process with a signal
5545 ;; (interrupt-process seems not to work)? (Markus Triska)
5546 ;; * Avoid the local shell entirely for starting remote processes. If
5547 ;; so, I think even a signal, when delivered directly to the local
5548 ;; SSH instance, would correctly be propagated to the remote process
5549 ;; automatically; possibly SSH would have to be started with
5550 ;; "-t". (Markus Triska)
5551 ;; * It makes me wonder if tramp couldn't fall back to ssh when scp
5552 ;; isn't on the remote host. (Mark A. Hershberger)
5553 ;; * Use lsh instead of ssh. (Alfred M. Szmidt)
5554 ;; * Optimize out-of-band copying when both methods are scp-like (not
5555 ;; rsync).
5556 ;; * Keep a second connection open for out-of-band methods like scp or
5557 ;; rsync.
5559 ;;; tramp-sh.el ends here