| blob | 4fe44a98c269fe53733e215bd909d1129971353b |
1 ;;; tramp-sh.el --- Tramp access functions for (s)sh-like connections
3 ;; Copyright (C) 1998-2015 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
71 ;; ksh on OpenBSD 4.5 requires that $PS1 contains a `#' character for
72 ;; root users. It uses the `$' character for other users. In order
73 ;; to guarantee a proper prompt, we use "#$ " for the prompt.
77 "///%s#$"
79 "String used to recognize end of output.
80 The '$' character at the end is quoted; the string cannot be
83 ;;;###tramp-autoload
90 ;; Initialize `tramp-methods' with the supported methods.
91 ;;;###tramp-autoload
102 ;;;###tramp-autoload
112 ;;;###tramp-autoload
129 ;;;###tramp-autoload
147 ;;;###tramp-autoload
162 ;;;###tramp-autoload
169 ;;;###tramp-autoload
176 ;;;###tramp-autoload
189 ;;;###tramp-autoload
202 ;;;###tramp-autoload
210 ;;;###tramp-autoload
218 ;; We use "-v" for better error tracking.
221 ;; We use "-p" as required for newer busyboxes. For older
222 ;; busybox/nc versions, the value must be (("-l") ("%r")). This
223 ;; can be achieved by tweaking `tramp-connection-properties'.
226 ;;;###tramp-autoload
234 ;;;###tramp-autoload
239 ;; Local $SHELL could be a nasty one, like zsh or fish. Let's override it.
244 ;;;###tramp-autoload
252 ;;;###tramp-autoload
259 ;;;###tramp-autoload
263 ;; ("%h") must be a single element, see `tramp-compute-multi-hops'.
267 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
268 tramp-terminal-type
269 tramp-initial-end-of-output))
274 ;;;###tramp-autoload
280 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
281 tramp-terminal-type
282 tramp-initial-end-of-output))
286 ;;;###tramp-autoload
293 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
294 tramp-terminal-type
295 tramp-initial-end-of-output))
305 ;;;###tramp-autoload
312 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
313 tramp-terminal-type
314 tramp-initial-end-of-output))
323 ;;;###tramp-autoload
334 ;;;###tramp-autoload
338 ;;;###tramp-autoload
342 ;; Do not add "ssh" based methods, otherwise ~/.ssh/config would be ignored.
343 ;; Do not add "plink" based methods, they ask interactively for the user.
344 ;;;###tramp-autoload
353 ;;;###tramp-autoload
359 ;;;###tramp-autoload
375 ;;;###tramp-autoload
380 ;;;###tramp-autoload
385 ;;;###tramp-autoload
393 ;;;###tramp-autoload
420 ;; "getconf PATH" yields:
421 ;; HP-UX: /usr/bin:/usr/ccs/bin:/opt/ansic/bin:/opt/langtools/bin:/opt/fortran/bin
422 ;; Solaris: /usr/xpg4/bin:/usr/ccs/bin:/usr/bin:/opt/SUNWspro/bin
423 ;; GNU/Linux (Debian, Suse): /bin:/usr/bin
424 ;; FreeBSD: /usr/bin:/bin:/usr/sbin:/sbin: - beware trailing ":"!
425 ;; IRIX64: /usr/bin
426 ;;;###tramp-autoload
432 "List of directories to search for executables on remote host.
433 For every remote host, this variable will be set buffer local,
434 keeping the list of existing directories on that host.
436 You can use `~' in this list, but when searching for a shell which groks
437 tilde expansion, all directory names starting with `~' will be ignored.
439 `Default Directories' represent the list of directories given by
441 entry on top of this list, because these are the default
442 directories for POSIX compatible commands. On remote hosts which
443 do not offer the getconf command (like cygwin), the value
446 `Private Directories' are the settings of the $PATH environment,
447 as given in your `~/.profile'."
454 ;;;###tramp-autoload
462 "List of environment variables to be set on the remote host.
464 Each element should be a string of the form ENVVARNAME=VALUE. An
465 entry ENVVARNAME= disables the corresponding environment variable,
466 which might have been set in the init files like ~/.profile.
468 Special handling is applied to the PATH environment, which should
469 not be set here. Instead, it should be set via `tramp-remote-path'."
475 "Alist specifying extra arguments to pass to the remote shell.
476 Entries are (REGEXP . ARGS) where REGEXP is a regular expression
477 matching the shell file name and ARGS is a string specifying the
478 arguments.
480 This variable is only used when Tramp needs to start up another shell
481 for tilde expansion. The extra arguments should typically prevent the
482 shell from reading its init file."
484 ;; This might be the wrong way to test whether the widget type
485 ;; `alist' is available. Who knows the right way to test it?
500 "List of pattern/action pairs.
501 Whenever a pattern matches, the corresponding action is performed.
502 Each item looks like (PATTERN ACTION).
504 The PATTERN should be a symbol, a variable. The value of this
505 variable gives the regular expression to search for. Note that the
507 appended to it.
509 The ACTION should also be a symbol, but a function. When the
517 "List of pattern/action pairs.
518 This list is used for copying/renaming with out-of-band methods.
523 "(echo begin 600 %t; tail -n +2) | uudecode
524 cat %t
525 rm -f %t"
526 "Shell function to implement `uudecode' to standard output.
527 Many systems support `uudecode -o /dev/stdout' or `uudecode -o -'
528 for this or `uudecode -p', but some systems don't, and for them
532 "%s -e '
533 use File::Spec;
536 sub recursive {
537 my ($volume, @dirs) = @_;
538 my $real = realpath(File::Spec->catpath(
540 if ($real) {
541 my ($vol, $dir) = File::Spec->splitpath($real, 1);
542 return ($vol, File::Spec->splitdir($dir));
543 }
544 else {
545 my $last = pop(@dirs);
546 ($volume, @dirs) = recursive($volume, @dirs);
547 push(@dirs, $last);
548 return ($volume, @dirs);
549 }
550 }
552 $result = realpath($ARGV[0]);
553 if (!$result) {
554 my ($vol, $dir) = File::Spec->splitpath($ARGV[0], 1);
555 ($vol, @dirs) = recursive($vol, File::Spec->splitdir($dir));
558 }
562 }
566 "Perl script to produce output suitable for use with `file-truename'
567 on the remote file system.
568 Escape sequence %s is replaced with name of Perl binary.
572 "%s -e 'sub case {
573 my $str = shift;
574 if ($ARGV[2]) {
575 return lc($str);
576 }
577 else {
578 return $str;
579 }
580 }
582 @files = readdir(d); closedir(d);
583 foreach $f (@files) {
584 if (case(substr($f, 0, length($ARGV[1]))) eq case($ARGV[1])) {
587 }
588 else {
590 }
591 }
592 }
595 "Perl script to produce output suitable for use with
596 `file-name-all-completions' on the remote file system. Escape
597 sequence %s is replaced with name of Perl binary. This string is
600 ;; Perl script to implement `file-attributes' in a Lisp `read'able
601 ;; output. If you are hacking on this, note that you get *no* output
602 ;; unless this spits out a complete line, including the '\n' at the
603 ;; end.
604 ;; The device number is returned as "-1", because there will be a virtual
605 ;; device number set in `tramp-sh-handle-file-attributes'.
607 "%s -e '
608 @stat = lstat($ARGV[0]);
609 if (!@stat) {
611 exit 0;
612 }
613 if (($stat[2] & 0170000) == 0120000)
614 {
615 $type = readlink($ARGV[0]);
617 }
618 elsif (($stat[2] & 0170000) == 040000)
619 {
621 }
622 else
623 {
625 };
628 printf(
630 $type,
631 $stat[3],
632 $uid,
633 $gid,
634 $stat[8] >> 16 & 0xffff,
635 $stat[8] & 0xffff,
636 $stat[9] >> 16 & 0xffff,
637 $stat[9] & 0xffff,
638 $stat[10] >> 16 & 0xffff,
639 $stat[10] & 0xffff,
640 $stat[7],
641 $stat[2],
642 $stat[1] >> 16 & 0xffff,
643 $stat[1] & 0xffff
645 "Perl script to produce output suitable for use with `file-attributes'
646 on the remote file system.
647 Escape sequence %s is replaced with name of Perl binary.
651 "%s -e '
654 @list = readdir(DIR);
655 closedir(DIR);
656 $n = scalar(@list);
658 for($i = 0; $i < $n; $i++)
659 {
660 $filename = $list[$i];
661 @stat = lstat($filename);
662 if (($stat[2] & 0170000) == 0120000)
663 {
664 $type = readlink($filename);
666 }
667 elsif (($stat[2] & 0170000) == 040000)
668 {
670 }
671 else
672 {
674 };
677 printf(
678 \"(\\\"%%s\\\" %%s %%u %%s %%s (%%u %%u) (%%u %%u) (%%u %%u) %%u.0 %%u t (%%u . %%u) (%%u . %%u))\\n\",
679 $filename,
680 $type,
681 $stat[3],
682 $uid,
683 $gid,
684 $stat[8] >> 16 & 0xffff,
685 $stat[8] & 0xffff,
686 $stat[9] >> 16 & 0xffff,
687 $stat[9] & 0xffff,
688 $stat[10] >> 16 & 0xffff,
689 $stat[10] & 0xffff,
690 $stat[7],
691 $stat[2],
692 $stat[1] >> 16 & 0xffff,
693 $stat[1] & 0xffff,
694 $stat[0] >> 16 & 0xffff,
695 $stat[0] & 0xffff);
696 }
698 "Perl script implementing `directory-files-attributes' as Lisp `read'able
699 output.
700 Escape sequence %s is replaced with name of Perl binary.
703 ;; These two use base64 encoding.
705 "%s -MMIME::Base64 -0777 -ne 'print encode_base64($_)' 2>/dev/null"
706 "Perl program to use for encoding a file.
707 Escape sequence %s is replaced with name of Perl binary.
708 This string is passed to `format', so percent characters need to be doubled.
709 This implementation requires the MIME::Base64 Perl module to be installed
713 "%s -MMIME::Base64 -0777 -ne 'print decode_base64($_)' 2>/dev/null"
714 "Perl program to use for decoding a file.
715 Escape sequence %s is replaced with name of Perl binary.
716 This string is passed to `format', so percent characters need to be doubled.
717 This implementation requires the MIME::Base64 Perl module to be installed
721 "%s -e '
722 # This script contributed by Juanma Barranquero <lektu@terra.es>.
723 # Copyright (C) 2002-2014 Free Software Foundation, Inc.
724 use strict;
726 my %%trans = do {
727 my $i = 0;
728 map {(substr(unpack(q(B8), chr $i++), 2, 6), $_)}
729 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/);
730 };
731 my $data;
733 # We read in chunks of 54 bytes, to generate output lines
734 # of 72 chars (plus end of line)
735 while (read STDIN, $data, 54) {
736 my $pad = q();
738 # Only for the last chunk, and only if did not fill the last three-byte packet
739 if (eof) {
740 my $mod = length($data) %% 3;
741 $pad = q(=) x (3 - $mod) if $mod;
742 }
744 # Not the fastest method, but it is simple: unpack to binary string, split
745 # by groups of 6 bits and convert back from binary to byte; then map into
746 # the translation table
747 print
748 join q(),
749 map($trans{$_},
750 (substr(unpack(q(B*), $data) . q(00000), 0, 432) =~ /....../g)),
751 $pad,
753 }' 2>/dev/null"
754 "Perl program to use for encoding a file.
755 Escape sequence %s is replaced with name of Perl binary.
759 "%s -e '
760 # This script contributed by Juanma Barranquero <lektu@terra.es>.
761 # Copyright (C) 2002-2014 Free Software Foundation, Inc.
762 use strict;
764 my %%trans = do {
765 my $i = 0;
766 map {($_, substr(unpack(q(B8), chr $i++), 2, 6))}
767 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/)
768 };
770 my %%bytes = map {(unpack(q(B8), chr $_), chr $_)} 0 .. 255;
774 # We are going to accumulate into $pending to accept any line length
775 # (we do not check they are <= 76 chars as the RFC says)
776 my $pending = q();
778 while (my $data = <STDIN>) {
779 chomp $data;
781 # If we find one or two =, we have reached the end and
782 # any following data is to be discarded
783 my $finished = $data =~ s/(==?).*/$1/;
784 $pending .= $data;
786 my $len = length($pending);
787 my $chunk = substr($pending, 0, $len & ~3);
788 $pending = substr($pending, $len & ~3 + 1);
790 # Easy method: translate from chars to (pregenerated) six-bit packets, join,
791 # split in 8-bit chunks and convert back to char.
792 print join q(),
793 map $bytes{$_},
794 ((join q(), map {$trans{$_} || q()} split //, $chunk) =~ /......../g);
796 last if $finished;
797 }' 2>/dev/null"
798 "Perl program to use for decoding a file.
799 Escape sequence %s is replaced with name of Perl binary.
803 "%s -e 'binmode STDIN; binmode STDOUT; print pack(q{u*}, join q{}, <>)'"
804 "Perl program to use for encoding a file.
808 "%s -e 'binmode STDIN; binmode STDOUT; print unpack(q{u*}, join q{}, <>)'"
809 "Perl program to use for decoding a file.
814 while read file; do
817 else
819 fi
822 else
824 fi
825 done
827 "Script to check existence of VC related files.
828 It must be send formatted with two strings; the tests for file
829 existence, and file readability. Input shall be read via
830 here-document, otherwise the command could exceed maximum length
833 ;; New handlers should be added here.
837 ;; `byte-compiler-base-file-name' performed by default handler.
842 ;; `diff-latest-backup-file' performed by default handler.
846 . tramp-sh-handle-directory-files-and-attributes)
847 ;; `dired-call-process' performed by default handler.
850 . tramp-sh-handle-dired-recursive-delete-directory)
857 ;; `file-equal-p' performed by default handler.
860 ;; `file-in-directory-p' performed by default handler.
868 ;; `file-name-sans-versions' performed by default handler.
881 ;; `find-file-noselect' performed by default handler.
882 ;; `get-file-buffer' performed by default handler.
886 . tramp-sh-handle-insert-file-contents-literally)
905 "Alist of handler functions.
908 ;; This must be the last entry, because `identity' always matches.
909 ;;;###tramp-autoload
913 ;;; File Name Handler Functions:
917 "Like `make-symbolic-link' for Tramp files.
918 If LINKNAME is a non-Tramp file, it is used verbatim as the target of
919 the symlink. If LINKNAME is a Tramp file, only the localname component is
920 used as the target of the symlink.
922 If LINKNAME is a Tramp file and the localname component is relative, then
923 it is expanded first, before the localname component is taken. Note that
924 this can give surprising results if the user/host for the source and
925 target of the symlink differ."
932 l 'file-error
935 ;; Do the 'confirm if exists' thing.
937 ;; What to do?
942 "File %s already exists; make it a link anyway? "
943 l-localname)))))
948 ;; If FILENAME is a Tramp name, use just the localname component.
957 ;; Right, they are on the same host, regardless of user, method,
958 ;; etc. We now make the link on the remote machine. This will
959 ;; occur as the user that FILENAME belongs to.
961 l
963 "cd %s && %s -sf %s %s"
965 ln
968 t))))
971 "Like `file-truename' for Tramp files."
973 "%s%s"
976 method user host
981 ;; Use GNU readlink --canonicalize-missing where available.
984 v
992 ;; Use Perl implementation.
1000 v
1004 ;; Do it yourself. We bind `directory-sep-char' here for
1005 ;; XEmacs on Windows, which would otherwise use backslash.
1013 ;; Don't make the following value larger than
1014 ;; necessary. People expect an error message in
1015 ;; a timely fashion when something is wrong;
1016 ;; otherwise they might think that Emacs is hung.
1017 ;; Of course, correctness has to come first.
1019 symlink-target)
1030 method user host
1042 ;; It's a symlink, follow it.
1048 ;; If the symlink was absolute, we'll get a
1049 ;; string like "/user@host:/some/target";
1050 ;; extract the "/some/target" part from it.
1054 v 'file-error
1055 "Symlink target `%s' on wrong host"
1056 symlink-target))
1061 steps)))
1063 ;; It's a file.
1067 v 'file-error
1070 ;; Combine list to form string.
1081 result))))
1083 ;; Preserve trailing "/".
1086 ;; Basic functions.
1089 "Like `file-exists-p' for Tramp files."
1097 v
1099 "%s %s"
1104 "Like `file-attributes' for Tramp files."
1107 ;; Don't modify `last-coding-system-used' by accident.
1114 v
1122 ;; The scripts could fail, for example with huge file size.
1126 "Implement `file-attributes' for Tramp files using the ls(1) command."
1128 res-inode res-filemodes res-numlinks
1129 res-uid res-gid res-size res-symlink-target)
1132 vec
1141 ;; parse `ls -l' output ...
1145 ;; ... inode
1161 ;; ... file mode flags
1163 ;; ... number links
1165 ;; ... uid and gid
1175 ;; ... size
1177 ;; From the file modes, figure out other stuff.
1180 ;; if symlink, find out file name pointed to
1184 ;; return data gathered
1186 ;; 0. t for directory, string (name linked to) for symbolic
1187 ;; link, or nil.
1189 ;; 1. Number of links to file.
1190 res-numlinks
1191 ;; 2. File uid.
1192 res-uid
1193 ;; 3. File gid.
1194 res-gid
1195 ;; 4. Last access time, as a list of integers. Normally this
1196 ;; would be in the same format as `current-time', but the
1197 ;; subseconds part is not currently implemented, and (0 0)
1198 ;; denotes an unknown time.
1199 ;; 5. Last modification time, likewise.
1200 ;; 6. Last status change time, likewise.
1202 ;; 7. Size in bytes (-1, if number is out of range).
1203 res-size
1204 ;; 8. File modes, as a string of ten letters or dashes as in ls -l.
1205 res-filemodes
1206 ;; 9. t if file's gid would change if file were deleted and
1207 ;; recreated. Will be set in `tramp-convert-file-attributes'
1208 t
1209 ;; 10. inode number.
1210 res-inode
1211 ;; 11. Device number. Will be replaced by a virtual device number.
1212 -1
1213 )))))
1217 "Implement `file-attributes' for Tramp files using a Perl script."
1222 vec
1228 "Implement `file-attributes' for Tramp files using stat(1) command."
1231 vec
1233 ;; On Opsware, pdksh (which is the true name of ksh there) doesn't
1234 ;; parse correctly the sequence "((". Therefore, we add a space.
1235 "( (%s %s || %s -h %s) && %s -c '((\"%%N\") %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 \"%%A\" t %%ie0 -1)' %s || echo nil)"
1246 "Like `set-visited-file-modtime' for Tramp files."
1253 coding-system-used)
1257 ;; '(-1 65535) means file doesn't exists yet.
1261 ;; We use '(0 0) as a don't-know value. See also
1262 ;; `tramp-do-file-attributes-with-ls'.
1267 v
1276 nil)))))
1278 ;; This function makes the same assumption as
1279 ;; `tramp-sh-handle-set-visited-file-modtime'.
1281 "Like `verify-visited-file-modtime' for Tramp files.
1282 At the time `verify-visited-file-modtime' calls this function, we
1283 already know that the buffer is visiting a file and that
1284 `visited-file-modtime' does not return 0. Do not call this
1285 function directly, unless those two cases are already taken care
1286 of."
1289 ;; There is no file visiting the buffer, or the buffer has no
1290 ;; recorded last modification time, or there is no established
1291 ;; connection.
1295 t
1303 ;; File exists, and has a known modtime.
1306 modtime
1307 ;; For compatibility, deal with both the old
1308 ;; (HIGH . LOW) and the new (HIGH LOW) return
1309 ;; values of `visited-file-modtime'.
1312 mt)))
1314 ;; Modtime has the don't know value.
1317 v
1324 attr
1327 ;; If file does not exist, say it is not modified if and
1328 ;; only if that agrees with the buffer's record.
1332 "Like `set-file-modes' for Tramp files."
1335 ;; FIXME: extract the proper text from chmod's stderr.
1337 v
1344 "Like `set-file-times' for Tramp files."
1351 time))
1352 ;; With GNU Emacs, `format-time-string' has an
1353 ;; optional parameter UNIVERSAL. This is preferred,
1354 ;; because we could handle the case when the remote
1355 ;; host is located in a different time zone as the
1356 ;; local host.
1360 "%s %s %s %s"
1371 ;; We handle also the local part, because in older Emacsen,
1372 ;; without `set-file-times', this function is an alias for this.
1373 ;; We are local, so we don't need the UTC settings.
1381 "Set the ownership for FILENAME.
1382 If UID and GID are provided, these values are used; otherwise uid
1383 and gid of the corresponding user is taken. Both parameters must
1384 be non-negative integers."
1385 ;; Modern Unices allow chown only for root. So we might need
1386 ;; another implementation, see `dired-do-chown'. OTOH, it is mostly
1387 ;; working with su(do)? when it is needed, so it shall succeed in
1388 ;; the majority of cases.
1389 ;; Don't modify `last-coding-system-used' by accident.
1394 ;; If we are root on the local host, we can do it directly.
1402 "chown %d:%d %s" uid gid
1405 ;; We handle also the local part, because there doesn't exist
1406 ;; `set-file-uid-gid'. On W32 "chown" might not work.
1410 nil "chown" nil nil nil
1414 "Check, whether SELINUX is enabled on the remote host."
1426 "Like `file-selinux-context' for Tramp files."
1435 "%s -d -Z %s"
1443 ;; Return the context.
1444 context))))
1447 "Like `set-file-selinux-context' for Tramp files."
1464 t)
1466 nil)))
1469 "Check, whether ACL is enabled on the remote host."
1474 "Like `file-acl' for Tramp files."
1480 "getfacl -ac %s 2>/dev/null"
1490 "Like `set-file-acl' for Tramp files."
1497 tramp-end-of-heredoc
1498 acl-string
1499 tramp-end-of-heredoc))
1501 ;; Success.
1504 t)
1505 ;; In case of errors, we return `nil'.
1507 nil)))
1509 ;; Simple functions using the `test' command.
1512 "Like `file-executable-p' for Tramp files."
1515 ;; Examine `file-attributes' cache to see if request can be
1516 ;; satisfied without remote operation.
1521 "Like `file-readable-p' for Tramp files."
1524 ;; Examine `file-attributes' cache to see if request can be
1525 ;; satisfied without remote operation.
1529 ;; When the remote shell is started, it looks for a shell which groks
1530 ;; tilde expansion. Here, we assume that all shells which grok tilde
1531 ;; expansion will also provide a `test' command which groks `-nt' (for
1532 ;; newer than). If this breaks, tell me about it and I'll try to do
1533 ;; something smarter about it.
1535 "Like `file-newer-than-file-p' for Tramp files."
1537 nil)
1539 t)
1540 ;; We are sure both files exist at this point.
1543 ;; We try to get the mtime of both files. If they are not
1544 ;; equal to the "dont-know" value, then we subtract the times
1545 ;; and obtain the result.
1551 ;; If one of them is the dont-know value, then we can
1552 ;; still try to run a shell command on the remote host.
1553 ;; However, this only works if both files are Tramp
1554 ;; files and both have the same method, same user, same
1555 ;; host.
1560 v 'file-error
1561 "Files %s and %s must have same method, user, host"
1562 file1 file2)))
1567 ;; Functions implemented using the basic functions above.
1570 "Like `file-directory-p' for Tramp files."
1572 ;; `file-directory-p' is used as predicate for file name completion.
1573 ;; Sometimes, when a connection is not established yet, it is
1574 ;; desirable to return t immediately for "/method:foo:". It can
1575 ;; be expected that this is always a directory.
1581 "Like `file-writable-p' for Tramp files."
1585 ;; Examine `file-attributes' cache to see if request can be
1586 ;; satisfied without remote operation.
1589 ;; If file doesn't exist, check if directory is writable.
1594 "Like `file-ownership-preserved-p' for Tramp files."
1598 ;; Return t if the file doesn't exist, since it's true that no
1599 ;; information would be lost by an (attempted) delete and create.
1606 ;; Directory listings.
1610 "Like `directory-files-and-attributes' for Tramp files."
1614 directory full match nosort id-format)
1616 ;; Do it directly.
1624 v localname
1634 v localname id-format))
1637 v localname id-format)))))))))
1638 result item)
1648 result
1653 "Implement `directory-files-and-attributes' for Tramp files using a Perl script."
1656 vec tramp-perl-directory-files-and-attributes
1660 vec
1664 object))
1668 "Implement `directory-files-and-attributes' for Tramp files using stat(1) command."
1671 vec
1674 ;; We must care about file names with spaces, or starting with
1675 ;; "-"; this would confuse xargs. "ls -aQ" might be a solution,
1676 ;; but it does not work on all remote systems. Therefore, we
1677 ;; quote the file names via sed.
1679 "xargs %s -c "
1688 ;; This function should return "foo/" for directories and "bar" for
1689 ;; files.
1691 "Like `file-name-all-completions' for Tramp files."
1696 filename
1698 'list
1700 ;; Try cache entries for `filename', `filename' with last
1701 ;; character removed, `filename' with last two characters
1702 ;; removed, ..., and finally the empty string - all
1703 ;; concatenated to the local directory name.
1706 tramp-completion-reread-directory-timeout)))
1708 ;; This is inefficient for very long file names, pity
1709 ;; `reduce' is not available...
1712 'append
1717 v
1719 "file-name-all-completions"
1720 nil)))
1722 ;; We cannot use a length of 0, because file properties
1723 ;; for "foo" and "foo/" are identical.
1726 ;; Cache expired or no matching cache entry found so we need
1727 ;; to perform a remote operation.
1729 ;; Get a list of directories and files, including reliably
1730 ;; tagging the directories with a trailing '/'. Because I
1731 ;; rock. --daniel@danann.net
1733 ;; Changed to perform `cd' in the same remote op and only
1734 ;; get entries starting with `filename'. Capture any `cd'
1735 ;; error messages. Ensure any `cd' and `echo' aliases are
1736 ;; ignored.
1738 v
1742 v tramp-perl-file-name-all-completions
1748 ;; `read-file-name-completion-ignore-case'
1749 ;; is introduced with Emacs 22.1.
1752 'read-file-name-completion-ignore-case
1758 ;; `ls' with wildcard might fail with `Argument
1759 ;; list too long' error in some corner cases; if
1760 ;; `ls' fails after `cd' succeeded, chances are
1761 ;; that's the case, so let's retry without
1762 ;; wildcard. This will return "too many" entries
1763 ;; but that isn't harmful.
1764 " || %s -a 2>/dev/null)"
1765 " | while IFS= read f; do"
1771 ;; When `filename' is empty, just `ls' without
1772 ;; `filename' argument is more efficient than `ls *'
1773 ;; for very large directories and might avoid the
1774 ;; `Argument list too long' error.
1775 ;;
1776 ;; With and only with wildcard, we need to add
1777 ;; `-d' to prevent `ls' from descending into
1778 ;; sub-directories.
1780 "."
1785 ;; Now grab the output.
1789 ;; Check result code, found in last line of output.
1793 ;; Grab error message from line before last line
1794 ;; (it was put there by `cd 2>&1').
1797 v 'file-error
1798 "tramp-sh-handle-file-name-all-completions: %s"
1800 ;; For peace of mind, if buffer doesn't end in `fail'
1801 ;; then it should end in `ok'. If neither are in the
1802 ;; buffer something went seriously wrong on the remote
1803 ;; side.
1806 v 'file-error
1807 "\
1808 tramp-sh-handle-file-name-all-completions: internal error accessing `%s': `%s'"
1814 ;; Because the remote op went through OK we know the
1815 ;; directory we `cd'-ed to exists.
1818 ;; Because the remote op went through OK we know every
1819 ;; file listed by `ls' exists.
1823 result)
1825 ;; Store result in the cache.
1830 ;; cp, mv and ln
1834 "Like `add-name-to-file' for Tramp files."
1839 v 'file-error
1840 "add-name-to-file: %s"
1849 "File %s already exists; make it a new name anyway? "
1850 newname)))
1857 v1
1861 "error with add-name-to-file, see buffer `%s' for details"
1866 preserve-uid-gid preserve-extended-attributes)
1867 "Like `copy-file' for Tramp files."
1871 ;; At least one file a Tramp file?
1875 'copy filename newname ok-if-already-exists keep-date
1876 preserve-uid-gid preserve-extended-attributes))
1877 ;; Compat section.
1880 'copy-file
1882 preserve-uid-gid preserve-extended-attributes)))
1885 'copy-file
1893 "Like `copy-directory' for Tramp files."
1899 ;; When DIRNAME and NEWNAME are remote, they must have
1900 ;; the same method.
1906 ;; scp or rsync DTRT.
1920 ;; We must do it file-wise.
1922 'copy-directory
1927 ;; When newname did exist, we have wrong cached values.
1935 "Like `rename-file' for Tramp files."
1936 ;; Check if both files are local -- invoke normal rename-file.
1937 ;; Otherwise, use Tramp from local system.
1940 ;; At least one file a Tramp file?
1950 preserve-uid-gid preserve-extended-attributes)
1951 "Copy or rename a remote file.
1952 OP must be `copy' or `rename' and indicates the operation to perform.
1953 FILENAME specifies the file to copy or rename, NEWNAME is the name of
1954 the new file (for copy) or the new name of the file (for rename).
1955 OK-IF-ALREADY-EXISTS means don't barf if NEWNAME exists already.
1956 KEEP-DATE means to make sure that NEWNAME has the same timestamp
1957 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
1958 the uid and gid if both files are on the same host.
1959 PRESERVE-EXTENDED-ATTRIBUTES activates selinux and acl commands.
1961 This function is invoked by `tramp-sh-handle-copy-file' and
1962 `tramp-sh-handle-rename-file'. It is an error if OP is neither
1963 of `copy' and `rename'. FILENAME and NEWNAME must be absolute
1964 file names."
1981 filename newname)
1984 ;; Both are Tramp files.
1989 ;; Shortcut: if method, host, user are the same for
1990 ;; both files, we invoke `cp' or `mv' on the remote
1991 ;; host directly.
1994 op filename newname
1995 ok-if-already-exists keep-date preserve-uid-gid))
1997 ;; Try out-of-band operation.
2002 op filename newname keep-date))
2004 ;; No shortcut was possible. So we copy the file
2005 ;; first. If the operation was `rename', we go back
2006 ;; and delete the original file (if the copy was
2007 ;; successful). The approach is simple-minded: we
2008 ;; create a new buffer, insert the contents of the
2009 ;; source file into it, then write out the buffer to
2010 ;; the target file. The advantage is that it doesn't
2011 ;; matter which file name handlers are used for the
2012 ;; source and target file.
2015 op filename newname keep-date))))))
2017 ;; One file is a Tramp file, the other one is local.
2020 ;; Fast track on local machine.
2023 op filename newname
2024 ok-if-already-exists keep-date preserve-uid-gid))
2026 ;; If the Tramp file has an out-of-band method, the
2027 ;; corresponding copy-program can be invoked.
2030 op filename newname keep-date))
2032 ;; Use the inline method via a Tramp buffer.
2034 op filename newname keep-date))))
2037 ;; One of them must be a Tramp file.
2040 ;; Handle `preserve-extended-attributes'. We ignore possible
2041 ;; errors, because ACL strings could be incompatible.
2046 ;; In case of `rename', we must flush the cache of the source file.
2052 ;; When newname did exist, we have wrong cached values.
2059 "Use an Emacs buffer to copy or rename a file.
2060 First arg OP is either `copy' or `rename' and indicates the operation.
2061 FILENAME is the source file, NEWNAME the target file.
2062 KEEP-DATE is non-nil if NEWNAME should have the same timestamp as FILENAME."
2064 ;; We must disable multibyte, because binary data shall not be
2065 ;; converted. We remove `tramp-file-name-handler' from
2066 ;; `inhibit-file-name-handlers'; otherwise the file name handler
2067 ;; for `insert-file-contents' might be deactivated in some corner
2068 ;; cases.
2075 ;; We don't want the target file to be compressed, so we let-bind
2076 ;; `jka-compr-inhibit' to t.
2080 ;; KEEP-DATE handling.
2082 ;; Set the mode.
2084 ;; If the operation was `rename', delete the original file.
2089 "Invokes `cp' or `mv' on the remote system.
2090 OP must be one of `copy' or `rename', indicating `cp' or `mv',
2091 respectively. FILENAME specifies the file to copy or rename,
2092 NEWNAME is the name of the new file (for copy) or the new name of
2093 the file (for rename). Both files must reside on the same host.
2094 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2095 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2096 the uid and gid from FILENAME."
2106 v 'file-error
2107 "Unknown operation `%s', must be `copy' or `rename'"
2108 op))))
2112 filename))
2116 newname))
2118 cmd-result)
2121 ;; Both files are on a remote host, with same user.
2133 ;; Mask cp -f error.
2135 tramp-operation-not-permitted-regexp nil t))
2136 cmd-result)
2138 nil v 'file-error
2139 "Copying directly failed, see buffer `%s' for details."
2142 ;; We are on the local host.
2145 ;; We can do it directly.
2148 ;; No sticky bit when renaming.
2159 localname1 localname2 ok-if-already-exists
2160 keep-date preserve-uid-gid)
2164 ;; We can do it directly with `tramp-send-command'
2172 ok-if-already-exists keep-date t)
2173 ;; We must change the ownership to the local user.
2179 ;; We need a temporary file in between.
2181 ;; Create the temporary file.
2189 "%s %s %s" cmd
2192 "Copying directly failed, see buffer `%s' for details."
2194 ;; We must change the ownership as remote user.
2195 ;; Since this does not work reliable, we also
2196 ;; give read permissions.
2207 localname1 tmpfile t
2208 keep-date preserve-uid-gid)
2210 'rename-file
2212 ;; We must change the ownership as local user.
2213 ;; Since this does not work reliable, we also
2214 ;; give read permissions.
2218 tmpfile
2222 ;; Move the temporary file to its destination.
2227 "cp -f -p %s %s"
2230 "Copying directly failed, see buffer `%s' for details."
2234 'rename-file
2237 ;; Save exit.
2240 ;; Set the time and mode. Mask possible errors.
2247 "Invoke `scp' program to copy.
2248 The method used must be an out-of-band method."
2252 copy-program copy-args copy-env copy-keep-date port listener spec
2253 options source target remote-copy-program remote-copy-args)
2258 ;; Both are Tramp files. We shall optimize it when the
2259 ;; methods for FILENAME and NEWNAME are the same.
2269 op filename tmpfile keep-date)
2272 ;; Save exit.
2279 ;; Set variables for computing the prompt for reading
2280 ;; password.
2287 ;; Expand hops. Might be necessary for gateway methods.
2291 ;; Check which ones of source and target are Tramp files.
2300 'file-name-directory
2306 ;; Check for host and port number. We cannot use
2307 ;; `tramp-file-name-port', because this returns also
2308 ;; `tramp-default-port', which might clash with settings in
2309 ;; "~/.ssh/config".
2316 ;; Check for user. There might be an interactive setting.
2320 ;; Check for listener port.
2327 ;; Compose copy command.
2337 spec)
2339 ?h host ?u user ?p port ?r listener ?c options
2346 copy-args
2348 ;; " " has either been a replacement of "%k" (when
2349 ;; keep-date argument is non-nil), or a replacement
2350 ;; for the whole keep-date sublist.
2351 " "
2355 copy-args)
2358 copy-args
2362 copy-env
2364 nil
2371 remote-copy-program
2381 remote-copy-args
2385 ;; Check for local copy program.
2390 ;; Install listener on the remote side. The prompt must be
2391 ;; consumed later on, when the process does not listen anymore.
2398 v 'file-error
2402 'identity
2410 v 'file-error
2411 "Listener process not running on remote host: `%s'"
2412 remote-copy-program))
2420 ;; The default directory must be remote.
2424 ;; Set the transfer process properties.
2434 copy-args
2436 copy-args
2441 ;; Use an asynchronous process. By this, password can
2442 ;; be handled. We don't set a timeout, because the
2443 ;; copying of large files can last longer than 60
2444 ;; secs.
2448 copy-program
2450 copy-args
2459 ;; We must adapt `tramp-local-end-of-line' for
2460 ;; sending the password.
2463 p v nil tramp-actions-copy-out-of-band))
2465 ;; Check the return code.
2470 orig-vec 'file-error
2471 "Couldn't find exit status of `%s'"
2477 orig-vec 'file-error
2478 "Error copying: `%s'"
2481 ;; Reset the transfer process properties.
2484 ;; Clear the remote prompt.
2487 ;; Houston, we have a problem! Likely, the listener is
2488 ;; still running, so let's clear everything (but the
2489 ;; cached password).
2492 ;; Handle KEEP-DATE argument.
2496 ;; Set the mode.
2501 ;; If the operation was `rename', delete the original file.
2508 "Like `make-directory' for Tramp files."
2520 "Like `delete-directory' for Tramp files."
2532 "Like `delete-file' for Tramp files."
2543 ;; Dired.
2545 ;; CCC: This does not seem to be enough. Something dies when
2546 ;; we try and delete two directories under Tramp :/
2548 "Recursively delete the directory given.
2549 This is like `dired-recursive-delete-directory' for Tramp files."
2551 ;; Run a shell command 'rm -r <localname>'.
2552 ;; Code shamelessly stolen from the dired implementation and, um, hacked :)
2555 ;; Which is better, -r or -R? (-r works for me <daniel@danann.net>).
2557 v
2559 ;; Don't read the output, do it explicitly.
2560 nil t)
2561 ;; Wait for the remote system to return to us...
2562 ;; This might take a while, allow it plenty of time.
2564 ;; Make sure that it worked...
2572 "Like `dired-compress-file' for Tramp files."
2573 ;; OK-FLAG is valid for XEmacs only, but not implemented.
2574 ;; Code stolen mainly from dired-aux.el.
2580 ;; Emacs case
2582 ;; XEmacs has `dired-compression-method-alist', which is
2583 ;; transformed into `dired-compress-file-suffixes' structure.
2587 nil
2590 suffix)
2591 ;; See if any suffix rule matches this file name.
2599 nil)
2601 ;; We found an uncompression rule.
2607 ;; `dired-remove-file' is not defined in XEmacs.
2612 ;; We don't recognize the file as compressed, so compress it.
2613 ;; Try gzip.
2618 ;; `dired-remove-file' is not defined in XEmacs.
2628 "Like `insert-directory' for Tramp files."
2635 filename switches wildcard full-directory-p)
2655 ;; If `full-directory-p', we just say `ls -l FILENAME'.
2656 ;; Else we chdir to the parent directory, then say `ls -ld BASENAME'.
2659 v
2662 switches
2664 localname
2667 v
2671 "Couldn't `cd %s'"
2675 v
2678 switches
2683 ""
2691 ;; We cannot use `insert-buffer-substring' because the Tramp
2692 ;; buffer changes its contents before insertion due to calling
2693 ;; `expand-file' and alike.
2698 ;; Check for "--dired" output.
2705 ;; Now read the numeric positions of file names.
2711 ;; End is followed by \n or by " -> ".
2713 ;; Remove trailing lines.
2719 ;; Some busyboxes are reluctant to discard colors.
2726 ;; Decode the output, it could be multibyte.
2733 ;; The inserted file could be from somewhere else.
2740 "."
2747 ;; Canonicalization of file names.
2750 "Like `expand-file-name' for Tramp files.
2752 the result will be a local, non-Tramp, file name."
2753 ;; If DIR is not given, use `default-directory' or "/".
2755 ;; Unless NAME is absolute, concat DIR and NAME.
2758 ;; If NAME is not a Tramp file, run the real handler.
2761 ;; Dissect NAME.
2765 ;; Tilde expansion if necessary. This needs a shell which
2766 ;; groks tilde expansion! The function `tramp-find-shell' is
2767 ;; supposed to find such a shell on the remote host. Please
2768 ;; tell me about it when this doesn't work on your system.
2772 ;; We cannot simply apply "~/", because under sudo "~/" is
2773 ;; expanded to the local user home directory but to the
2774 ;; root home directory. On the other hand, using always
2775 ;; the default user name for tilde expansion is not
2776 ;; appropriate either, because ssh and companions might
2777 ;; use a user name from the config file.
2789 ;; There might be a double slash, for example when "~/"
2790 ;; expands to "/". Remove this.
2793 ;; No tilde characters in file name, do normal
2794 ;; `expand-file-name' (this does "/./" and "/../"). We bind
2795 ;; `directory-sep-char' here for XEmacs on Windows, which would
2796 ;; otherwise use backslash. `default-directory' is bound,
2797 ;; because on Windows there would be problems with UNC shares or
2798 ;; Cygwin mounts.
2802 method user host
2806 hop)))))
2808 ;;; Remote commands:
2811 "Flush file caches."
2819 ;; We use BUFFER also as connection buffer during setup. Because of
2820 ;; this, its original contents must be saved, and restored once
2821 ;; connection has been setup.
2823 "Like `start-file-process' for Tramp files."
2826 ;; it might be that the arguments exceed the command line
2827 ;; length. Therefore, we modify the command.
2832 ;; When PROGRAM is nil, we just provide a tty.
2838 args
2847 ;; Use a human-friendly prompt, for example for `shell'.
2851 tramp-initial-end-of-output))
2862 ;; We do not want to raise an error when
2863 ;; `start-file-process' has been started several times in
2864 ;; `eshell' and friends.
2868 ;; BUFFER can be nil. We use a temporary buffer.
2871 ;; NAME must be unique as process name.
2875 ;; Set the new process properties.
2881 ;; We catch this event. Otherwise, `start-process' could
2882 ;; be called on the local host.
2885 ;; Activate narrowing in order to save BUFFER
2886 ;; contents. Clear also the modification time;
2887 ;; otherwise we might be interrupted by
2888 ;; `verify-visited-file-modtime'.
2894 ;; We call `tramp-maybe-open-connection', in order
2895 ;; to cleanup the prompt afterwards.
2901 ;; Now do it.
2903 ;; Send the command.
2905 ;; Check, whether a pty is associated.
2909 v 'file-error
2912 ;; Set query flag and process marker for this
2913 ;; process. We ignore errors, because the process
2914 ;; could have finished already.
2918 ;; Return process.
2919 p))))
2921 ;; Save exit.
2932 "Like `process-file' for Tramp files."
2933 ;; The implementation is not complete yet.
2939 ;; Compute command.
2942 ;; Determine input.
2947 ;; INFILE is on the same remote host.
2949 ;; INFILE must be copied to remote host.
2955 ;; Determine output.
2957 ;; Just a buffer.
2960 ;; A buffer name.
2963 ;; (REAL-DESTINATION ERROR-DESTINATION)
2965 ;; output.
2973 ;; stderr.
2978 ;; stderr is on the same remote host.
2981 ;; stderr must be copied to remote host. The temporary
2982 ;; file must be deleted after execution.
2985 method user host stderr))))
2986 ;; stderr to be discarded.
2989 ;; 't
2994 ;; Send the command. It might not return in time, so we protect
2995 ;; it. Call it in a subshell, in order to preserve working
2996 ;; directory.
3003 command)
3004 t t)
3006 ;; We should add the output anyway.
3013 ;; When the user did interrupt, we should do it also. We use
3014 ;; return code -1 as marker.
3018 ;; Handle errors.
3023 ;; Provide error file.
3026 ;; Cleanup. We remove all file cache values for the connection,
3027 ;; because the remote process could have changed them.
3030 ;; `process-file-side-effects' has been introduced with GNU
3031 ;; Emacs 23.2. If set to `nil', no remote file will be changed
3032 ;; by `program'. If it doesn't exist, we assume its default
3033 ;; value `t'.
3038 ;; Return exit status.
3041 ret))))
3044 "Like `file-local-copy' for Tramp files."
3048 v 'file-error
3058 ;; `copy-file' handles direct copy and out-of-band methods.
3063 ;; Use inline encoding for file transfer.
3067 v 3
3075 tmpfile loc-dec)
3077 ;; If local decoding is a function, we call it.
3078 ;; We must disable multibyte, because
3079 ;; `uudecode-decode-region' doesn't handle it
3080 ;; correctly.
3085 ;; Unset `file-name-handler-alist'. Otherwise,
3086 ;; epa-file gets confused.
3092 ;; If tramp-decoding-function is not defined for this
3093 ;; method, we invoke tramp-decoding-command instead.
3095 ;; Unset `file-name-handler-alist'. Otherwise,
3096 ;; epa-file gets confused.
3104 loc-dec tmpfile2 tmpfile)
3107 ;; Set proper permissions.
3109 ;; Set local user ownership.
3112 ;; Oops, I don't know what to do.
3116 ;; Error handling.
3122 tmpfile)))
3124 ;; This is needed for XEmacs only. Code stolen from files.el.
3127 "Like `insert-file-contents-literally' for Tramp files."
3135 nil))
3142 ;; Save exit.
3147 ;; CCC grok LOCKNAME
3150 "Like `write-region' for Tramp files."
3153 ;; Following part commented out because we don't know what to do about
3154 ;; file locking, and it does not appear to be a problem to ignore it.
3155 ;; Ange-ftp ignores it, too.
3156 ;; (when (and lockname (stringp lockname))
3157 ;; (setq lockname (expand-file-name lockname)))
3158 ;; (unless (or (eq lockname nil)
3159 ;; (string= lockname filename))
3160 ;; (error
3161 ;; "tramp-sh-handle-write-region: LOCKNAME must be nil or equal FILENAME"))
3163 ;; XEmacs takes a coding system as the seventh argument, not `confirm'.
3174 ;; `file-writable-p' calls `file-expand-file-name'. We
3175 ;; cannot use `tramp-run-real-handler' therefore.
3181 ;; Short track: if we are on the local host, we can run directly.
3183 'write-region
3187 ;; We use this to save the value of
3188 ;; `last-coding-system-used' after writing the tmp
3189 ;; file. At the end of the function, we set
3190 ;; `last-coding-system-used' to this saved value. This
3191 ;; way, any intermediary coding systems used while
3192 ;; talking to the remote shell or suchlike won't hose
3193 ;; this variable. This approach was snarfed from
3194 ;; ange-ftp.el.
3195 coding-system-used
3196 ;; Write region into a tmp file. This isn't really
3197 ;; needed if we use an encoding function, but currently
3198 ;; we use it always because this makes the logic
3199 ;; simpler. We must also set `temporary-file-directory',
3200 ;; because it could point to a remote directory.
3206 ;; If `append' is non-nil, we copy the file locally, and let
3207 ;; the native `write-region' implementation do the job.
3210 ;; We say `no-message' here because we don't want the
3211 ;; visited file modtime data to be clobbered from the temp
3212 ;; file. We call `set-visited-file-modtime' ourselves later
3213 ;; on. We must ensure that `file-coding-system-alist'
3214 ;; matches `tmpfile'.
3220 'write-region
3227 ;; Now, `last-coding-system-used' has the right value. Remember it.
3232 ;; The permissions of the temporary file should be set. If
3233 ;; FILENAME does not exist (eq modes nil) it has been
3234 ;; renamed to the backup file. This case `save-buffer'
3235 ;; handles permissions.
3236 ;; Ensure that it is still readable.
3239 tmpfile
3242 ;; This is a bit lengthy due to the different methods
3243 ;; possible for file transfer. First, we check whether the
3244 ;; method uses an scp program. If so, we call it.
3245 ;; Otherwise, both encoding and decoding command must be
3246 ;; specified. However, if the method _also_ specifies an
3247 ;; encoding function, then that is used for encoding the
3248 ;; contents of the tmp file.
3253 ;; `copy-file' handles direct copy and out-of-band methods.
3264 ;; We keep the local file for performance
3265 ;; reasons, useful for "rsync".
3272 ;; Don't rename, in order to keep context in SELinux.
3277 ;; Use inline file transfer.
3279 ;; Encode tmpfile.
3283 ;; Use encoding function or command.
3286 tmpfile loc-enc)
3288 ;; The following `let' is a workaround for
3289 ;; the base64.el that comes with pgnus-0.84.
3290 ;; If both of the following conditions are
3291 ;; satisfied, it tries to write to a local
3292 ;; file in default-directory, but at this
3293 ;; point, default-directory is remote.
3294 ;; (`call-process-region' can't write to
3295 ;; remote files, it seems.) The file in
3296 ;; question is a tmp file anyway.
3304 loc-enc tmpfile t))
3306 v 'file-error
3309 filename loc-enc))))
3311 ;; Send buffer into remote decoding command which
3312 ;; writes to remote file. Because this happens on
3313 ;; the remote host, we cannot use the function.
3316 filename rem-dec)
3320 v
3324 tramp-end-of-heredoc
3326 tramp-end-of-heredoc))
3328 v nil
3329 "Couldn't write region to `%s', decode using `%s' failed"
3330 filename rem-dec)
3331 ;; When `file-precious-flag' is set, the region is
3332 ;; written to a temporary file. Check that the
3333 ;; checksum is equal to that from the local tmpfile.
3337 ;; cksum runs locally, if possible.
3339 ;; cksum runs remotely.
3341 v
3344 ;; ... they are different.
3351 v 'file-error
3354 filename rem-dec)))))
3356 ;; Save exit.
3359 ;; That's not expected.
3362 v 'file-error
3365 method))))
3367 ;; Make `last-coding-system-used' have the right value.
3374 ;; We must protect `last-coding-system-used', now we have set it
3375 ;; to its correct value.
3377 ;; Set file modification time.
3381 ;; We must pass modtime explicitly, because FILENAME can
3382 ;; be different from (buffer-file-name), f.e. if
3383 ;; `file-precious-flag' is set.
3389 ;; Set the ownership.
3399 ;; VC backends check for the existence of various different special
3400 ;; files. This is very time consuming, because every single check
3401 ;; requires a remote command (the file cache must be invalidated).
3402 ;; Therefore, we apply a kind of optimization. We install the file
3403 ;; name handler `tramp-vc-file-name-handler', which does nothing but
3404 ;; remembers all file names for which `file-exists-p' or
3405 ;; `file-readable-p' has been applied. A first run of `vc-registered'
3406 ;; is performed. Afterwards, a script is applied for all collected
3407 ;; file names, using just one remote command. The result of this
3408 ;; script is used to fill the file cache with actual values. Now we
3409 ;; can reset the file name handlers, and we make a second run of
3410 ;; `vc-registered', which returns the expected result without sending
3411 ;; any other remote command.
3413 "Like `vc-registered' for Tramp files."
3419 ;; There could be new files, created by the vc backend. We
3420 ;; cannot reuse the old cache entries, therefore. In
3421 ;; `tramp-get-file-property', `remote-file-name-inhibit-cache'
3422 ;; could also be a timestamp as `current-time' returns. This
3423 ;; means invalidate all cache entries with an older timestamp.
3429 ;; Here we collect only file names, which need an operation.
3433 ;; Send just one command, in order to fill the cache.
3436 v
3445 ;; We cannot use `tramp-send-command-and-read',
3446 ;; because this does not cooperate well with
3447 ;; heredoc documents.
3449 v
3452 tramp-end-of-heredoc
3454 tramp-vc-registered-file-names
3456 tramp-end-of-heredoc))
3458 ;; Read the expression.
3465 ;; Second run. Now all `file-exists-p' or `file-readable-p'
3466 ;; calls shall be answered from the file cache. We unset
3467 ;; `process-file-side-effects' and `remote-file-name-inhibit-cache'
3468 ;; in order to keep the cache.
3470 remote-file-name-inhibit-cache process-file-side-effects)
3471 ;; Reduce `vc-handled-backends' in order to minimize process calls.
3490 ;; Run.
3494 ;;;###tramp-autoload
3496 "Invoke remote-shell Tramp file name handler.
3497 Fall back to normal file name handler if no Tramp handler exists."
3515 "Invoke special file name handler, which collects files to be handled."
3523 ;; That's what we want: file names, for which checks are
3524 ;; applied. We assume that VC uses only `file-exists-p' and
3525 ;; `file-readable-p' checks; otherwise we must extend the
3526 ;; list. We do not perform any action, but return nil, in
3527 ;; order to keep `vc-registered' running.
3530 nil)
3531 ;; `process-file' and `start-file-process' shall be ignored.
3534 ;; Tramp file name handlers like `expand-file-name'. They
3535 ;; must still work.
3537 ;; Default file name handlers, we don't care.
3541 "Like `file-notify-add-watch' for Tramp files."
3545 command events filter p sequence)
3547 ;; gvfs-monitor-dir.
3551 ;; inotifywait.
3554 events
3561 ;; None.
3563 v 'file-notify-error
3564 "No file notification program found on %s"
3566 ;; Start process.
3568 'start-file-process
3572 sequence))
3573 ;; Return the process object as watch-descriptor.
3576 v 'file-notify-error
3577 "`%s' failed to start on remote host"
3583 p))))
3595 ;; Attribute change is returned in unused wording.
3605 string)
3608 proc
3612 ;; File names are returned as absolute paths. We must
3613 ;; add the remote prefix.
3618 ;; Usually, we would add an Emacs event now. Unfortunately,
3619 ;; `unread-command-events' does not accept several events at
3620 ;; once. Therefore, we apply the callback directly.
3623 ;; Save rest of the string.
3632 ;; Check, whether there is a problem.
3638 line)
3643 proc
3650 ;; Usually, we would add an Emacs event now. Unfortunately,
3651 ;; `unread-command-events' does not accept several events at
3652 ;; once. Therefore, we apply the callback directly.
3655 ;;; Internal Functions:
3658 "Define in remote shell function NAME implemented as SCRIPT.
3659 Only send the definition if it has not already been done."
3660 ;; We cannot let-bind (tramp-get-connection-process vec) because it
3661 ;; might be nil.
3666 ;; The script could contain a call of Perl. This is masked with `%s'.
3671 vec
3682 auto-save-default)
3690 "Run `test' on the remote system, given a SWITCH and a FILENAME.
3691 Returns the exit code of the `test' program."
3694 v
3696 "%s %s %s"
3698 switch
3702 "Run `test'-like program on the remote system, given FILE1, FILE2.
3703 FORMAT-STRING contains the program name, switches, and place holders.
3704 Returns the exit code of the `test' program. Barfs if the methods,
3705 hosts, or files, disagree."
3709 v 'file-error
3714 v1
3721 "Searches for PROGNAME in $PATH and all directories mentioned in DIRLIST.
3722 First arg VEC specifies the connection, PROGNAME is the program
3723 to search for, and DIRLIST gives the list of directories to
3724 search. If IGNORE-TILDE is non-nil, directory names starting
3725 with `~' will be ignored. If IGNORE-PATH is non-nil, searches
3726 only in DIRLIST.
3728 Returns the absolute file name of PROGNAME, if found, and nil otherwise.
3730 This function expects to be in the right *tramp* buffer."
3733 ;; Check whether the executable is in $PATH. "which(1)" does not
3734 ;; report always a correct error code; therefore we check the
3735 ;; number of words it returns. "SunOS 5.10" (and maybe "SunOS
3736 ;; 5.11") have problems with this command, we disable the call
3737 ;; therefore.
3748 ;; Remove all ~/foo directories from dirlist. In XEmacs,
3749 ;; `remove' is in CL, and we want to avoid CL dependencies.
3758 vec
3760 "do if test -x $d/%s -a -f $d/%s; "
3761 "then echo tramp_executable $d/%s; "
3764 progname progname progname
3765 tramp-end-of-heredoc
3767 tramp-end-of-heredoc))
3773 result)))
3776 "Sets the remote environment PATH to existing directories.
3777 I.e., for each directory in `tramp-remote-path', it is tested
3778 whether it exists and if so, it is added to the environment
3779 variable PATH."
3785 ;; ------------------------------------------------------------
3786 ;; -- Communication with external shell --
3787 ;; ------------------------------------------------------------
3790 "Find a command on the remote host for checking if a file exists.
3791 Here, we are looking for a command which has zero exit status if the
3792 file exists and nonzero exit status otherwise."
3796 result)
3797 ;; The algorithm is as follows: we try a list of several commands.
3798 ;; For each command, we first run `$cmd /' -- this should return
3799 ;; true, as the root directory always exists. And then we run
3800 ;; `$cmd /this\ file\ does\ not\ exist ', hoping that the file indeed
3801 ;; does not exist. This should return false. We use the first
3802 ;; command we find that seems to work.
3803 ;; The list of commands to try is as follows:
3804 ;; `ls -d' This works on most systems, but NetBSD 1.4
3805 ;; has a bug: `ls' always returns zero exit
3806 ;; status, even for files which don't exist.
3807 ;; `test -e' Some Bourne shells have a `test' builtin
3808 ;; which does not know the `-e' option.
3809 ;; `/bin/test -e' For those, the `test' binary on disk normally
3810 ;; provides the option. Alas, the binary
3811 ;; is sometimes `/bin/test' and sometimes it's
3812 ;; `/usr/bin/test'.
3813 ;; `/usr/bin/test -e' In case `/bin/test' does not exist.
3841 result))
3844 "Opens shell SHELL."
3847 ;; Find arguments for this shell.
3849 item extra-args)
3854 ;; It is useful to set the prompt in the following command
3855 ;; because some people have a setting for $PS1 which /bin/sh
3856 ;; doesn't know about and thus /bin/sh will display a strange
3857 ;; prompt. For example, if $PS1 has "${CWD}" in the value, then
3858 ;; ksh will display the current working directory but /bin/sh
3859 ;; will display a dollar sign. The following command line sets
3860 ;; $PS1 to a sane value, and works under Bourne-ish shells as
3861 ;; well as csh-like shells. We also unset the variable $ENV
3862 ;; because that is read by some sh implementations (eg, bash
3863 ;; when called as sh) on startup; this way, we avoid the startup
3864 ;; file clobbering $PS1. $PROMPT_COMMAND is another way to set
3865 ;; the prompt in /bin/bash, it must be discarded as well.
3868 "exec env ENV='' HISTFILE=/dev/null PROMPT_COMMAND='' PS1=%s PS2='' PS3='' %s %s"
3871 t))
3876 "Opens a shell on the remote host which groks tilde expansion."
3884 shell)
3887 ;; CCC: "root" does not exist always, see QNAP 459.
3888 ;; Which check could we apply instead?
3891 ;; The default shell (ksh93) of OpenSolaris and
3892 ;; Solaris is buggy. We've got reports for
3893 ;; "SunOS 5.10" and "SunOS 5.11" so far.
3902 ;; Maybe it works at least for some other commands.
3904 default-shell
3906 vec 2
3908 "Couldn't find a remote shell which groks tilde "
3910 default-shell)))
3912 default-shell)))
3914 ;; Open a new shell if needed.
3920 ;; Utility functions.
3923 "Wait for shell prompt and barf if none appears.
3924 Looks at process PROC to see if a shell prompt appears in TIMEOUT
3925 seconds. If not, it produces an error message with the given ERROR-ARGS."
3929 proc timeout
3938 "Set up an interactive shell.
3939 Mainly sets the prompt and the echo correctly. PROC is the shell
3940 process to set up. VEC specifies the connection."
3943 vec
3948 ;; Disable echo.
3951 ;; Check whether the echo has really been disabled. Some
3952 ;; implementations, like busybox of embedded GNU/Linux, don't
3953 ;; support disabling.
3960 ;; Make sure backspaces and their echo are enabled and no line
3961 ;; width magic interferes with them.
3969 ;; Try to set up the coding system correctly.
3970 ;; CCC this can't be the right way to do it. Hm.
3974 ;; Use MULE to select the right EOL convention for communicating
3975 ;; with the process.
3981 cs-decode cs-encode)
3998 ;; Look for ^M and do something useful if found.
4000 ;; We have found a ^M but cannot frob the process coding system
4001 ;; because we're running on a non-MULE Emacs. Let's try
4002 ;; stty, instead.
4007 ;; Check whether the output of "uname -sr" has been changed. If
4008 ;; yes, this is a strong indication that we must expire all
4009 ;; connection properties. We start again with
4010 ;; `tramp-maybe-open-connection', it will be caught there.
4015 vec "uname"
4019 vec 3
4020 "Connection reset, because remote host changed from `%s' to `%s'"
4021 old-uname new-uname)
4022 ;; We want to keep the password.
4026 ;; Check whether the remote host suffers from buggy
4027 ;; `send-process-string'. This is known for FreeBSD (see comment in
4028 ;; `send_process', file process.c). I've tested sending 624 bytes
4029 ;; successfully, sending 625 bytes failed. Emacs makes a hack when
4030 ;; this host type is detected locally. It cannot handle remote
4031 ;; hosts, though.
4035 tramp-chunksize)
4043 ;; Set remote PATH variable.
4046 ;; Search for a good shell before searching for a command which
4047 ;; checks if a file exists. This is done because Tramp wants to use
4048 ;; "test foo; echo $?" to check if various conditions hold, and
4049 ;; there are buggy /bin/sh implementations which don't execute the
4050 ;; "echo $?" part if the "test" part has an error. In particular,
4051 ;; the OpenSolaris /bin/sh is a problem. There are also other
4052 ;; problems with /bin/sh of OpenSolaris, like redirection of stderr
4053 ;; in function declarations, or changing HISTFILE in place.
4054 ;; Therefore, OpenSolaris' /bin/sh is replaced by bash, when
4055 ;; detected.
4058 ;; Disable unexpected output.
4061 ;; IRIX64 bash expands "!" even when in single quotes. This
4062 ;; destroys our shell functions, we must disable it. See
4063 ;; <http://stackoverflow.com/questions/3291692/irix-bash-shell-expands-expression-in-single-quotes-yet-shouldnt>.
4067 ;; On BSD-like systems, ?\t is expanded to spaces. Suppress this.
4072 ;; Set `remote-tty' process property.
4077 ;; Dump stty settings in the traces.
4081 ;; Set the environment.
4086 unset vars item)
4096 vec
4098 tramp-end-of-heredoc
4100 tramp-end-of-heredoc)
4101 t))
4106 ;; Old text from documentation of tramp-methods:
4107 ;; Using a uuencode/uudecode inline method is discouraged, please use one
4108 ;; of the base64 methods instead since base64 encoding is much more
4109 ;; reliable and the commands are more standardized between the different
4110 ;; Unix versions. But if you can't use base64 for some reason, please
4111 ;; note that the default uudecode command does not work well for some
4112 ;; Unices, in particular AIX and Irix. For AIX, you might want to use
4113 ;; the following command for uudecode:
4114 ;;
4115 ;; sed '/^begin/d;/^[` ]$/d;/^end/d' | iconv -f uucode -t ISO8859-1
4116 ;;
4117 ;; For Irix, no solution is known yet.
4125 "List of local coding commands for inline transfer.
4126 Each item is a list that looks like this:
4128 \(FORMAT ENCODING DECODING\)
4130 FORMAT is symbol describing the encoding/decoding format. It can be
4131 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4133 ENCODING and DECODING can be strings, giving commands, or symbols,
4134 giving functions. If they are strings, then they can contain
4136 file name will be put into the command line at that spot. If the
4137 specifier is not present, the input should be read from standard
4138 input.
4140 If they are functions, they will be called with two arguments, start
4141 and end of region, and are expected to replace the region contents
4146 ;; "-i" is more robust with older base64 from GNU coreutils.
4147 ;; However, I don't know whether all base64 versions do supports
4148 ;; this option.
4160 "List of remote coding commands for inline transfer.
4161 Each item is a list that looks like this:
4163 \(FORMAT ENCODING DECODING [TEST]\)
4165 FORMAT is a symbol describing the encoding/decoding format. It can be
4166 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4168 ENCODING and DECODING can be strings, giving commands, or symbols,
4169 giving variables. If they are strings, then they can contain
4171 file name will be put into the command line at that spot. If the
4172 specifier is not present, the input should be read from standard
4173 input.
4175 If they are variables, this variable is a string containing a
4176 Perl or Shell implementation for this functionality. This
4177 program will be transferred to the remote host, and it is
4179 specifier in the variable value denotes a temporary file.
4181 The optional TEST command can be used for further tests, whether
4185 "Find an inline transfer encoding that works.
4186 Goes through the list `tramp-local-coding-commands' and
4187 `tramp-remote-coding-commands'."
4192 loc-enc loc-dec rem-enc rem-dec rem-test litem ritem found)
4200 ;; If the local encoder or decoder is a string, the
4201 ;; corresponding command has to work locally.
4208 loc-enc nil nil))
4216 loc-dec nil nil))
4218 ;; Search for remote coding commands with the same format
4226 ;; Check the remote test command if exists.
4232 ;; Check if remote perl exists when necessary.
4236 ;; Check if remote encoding and decoding commands can be
4237 ;; called remotely with null input and output. This makes
4238 ;; sure there are no syntax errors and the command is really
4239 ;; found. Note that we do not redirect stdout to /dev/null,
4240 ;; for two reasons: when checking the decoding command, we
4241 ;; actually check the output it gives. And also, when
4242 ;; redirecting "mimencode" output to /dev/null, then as root
4243 ;; it might change the permissions of /dev/null!
4251 vec 5
4260 tmpfile)
4267 tramp-temp-name-prefix
4269 value
4271 value
4273 ?t
4279 vec 5
4282 vec
4284 t)
4292 ;; `rem-enc' and `rem-dec' could be a string meanwhile.
4298 ;; Set connection properties. Since the commands are risky
4299 ;; (due to output direction), we cache them in the process cache.
4310 "Call the local encoding or decoding command.
4312 Otherwise, INPUT is passed via standard input.
4313 INPUT can also be nil which means `/dev/null'.
4314 OUTPUT can be a string (which specifies a file name), or t (which
4315 means standard output and thus the current buffer), or nil (which
4316 means discard it)."
4318 nil tramp-encoding-shell
4321 nil
4322 tramp-encoding-command-switch
4332 "List of compress and decompress commands for inline transfer.
4333 Each item is a list that looks like this:
4335 \(COMPRESS DECOMPRESS\)
4340 "Find an inline transfer compress command that works.
4341 Goes through the list `tramp-inline-compress-commands'."
4346 item compress decompress found)
4353 vec 5
4354 "Checking local compress commands `%s', `%s' for sanity"
4355 compress decompress)
4360 ;; Windows shells need the program file name after
4361 ;; the pipe symbol be quoted if they use forward
4362 ;; slashes as directory separators.
4369 vec 5
4370 "Checking remote compress commands `%s', `%s' for sanity"
4371 compress decompress)
4377 ;; Did we find something?
4380 ;; Set connection properties. Since the commands are
4381 ;; risky (due to output direction), we cache them in the
4382 ;; process cache.
4396 "Expands VEC according to `tramp-default-proxies-alist'.
4397 Gateway hops are already opened."
4401 choices proxy)
4403 ;; Ad-hoc proxy definitions.
4408 tramp-prefix-format proxy tramp-postfix-host-format)))
4413 proxy)
4414 ;; Add the hop.
4416 'tramp-default-proxies-alist
4419 proxy))
4421 ;; Save the new value.
4426 ;; Look for proxy hosts to be passed.
4432 ;; Host.
4435 ;; User.
4439 ;; No more hops needed.
4441 ;; Replace placeholders.
4444 proxy
4449 ;; Add the hop.
4451 ;; Start next search.
4454 ;; Handle gateways.
4462 ;; Is the method prepared for gateways?
4465 vec 'file-error
4467 ;; Open the gateway connection.
4472 target-alist)
4473 ;; For the password prompt, we need the correct values.
4474 ;; Therefore, we must remember the gateway vector. But we
4475 ;; cannot do it as connection property, because it shouldn't
4476 ;; be persistent. And we have no started process yet either.
4480 ;; Foreign and out-of-band methods are not supported for multi-hops.
4493 vec 'file-error
4494 "Method `%s' is not supported for multi-hops."
4497 ;; In case the host name is not used for the remote shell
4498 ;; command, the user could be misguided by applying a random
4499 ;; hostname.
4505 ;; There are multi-hops.
4507 ;; The host name is used for the remote shell command.
4510 ;; The host is local. We cannot use `tramp-local-host-p'
4511 ;; here, because it opens a connection as well.
4514 v 'file-error
4515 "Host `%s' looks like a remote host, `%s' can only use the local host"
4516 host method)))
4518 ;; Result.
4519 target-alist))
4522 "Maybe open a connection VEC.
4523 Does not do anything if a connection is already open, but re-opens the
4524 connection if a previous connection has died for some reason."
4532 ;; If Tramp opens the same connection within a short time frame,
4533 ;; there is a problem. We shall signal this.
4542 ;; If too much time has passed since last command was sent, look
4543 ;; whether process is still alive. If it isn't, kill it. When
4544 ;; using ssh, it can sometimes happen that the remote end has hung
4545 ;; up but the local ssh client doesn't recognize this until it
4546 ;; tries to send some data to the remote end. So that's why we
4547 ;; try to send a command from time to time, then look again
4548 ;; whether the process is really alive.
4559 ;; The error will be caught locally.
4565 ;; New connection must be opened.
4569 ;; If `non-essential' is non-nil, don't reopen a new connection.
4574 vec 3
4585 ;; Start new process.
4594 ;; We will apply `tramp-ssh-controlmaster-options'
4595 ;; only for the first hop.
4601 ;; This must be done in order to avoid our file
4602 ;; name handler.
4606 'start-process
4611 tramp-encoding-command-interactive)
4614 ;; Set sentinel and query flag.
4625 ;; Check whether process is alive.
4627 p 10
4630 ;; Now do all the connections as specified.
4660 ;; We don't create the temporary file. In
4661 ;; fact, it is just a prefix for the
4662 ;; ControlPath option of ssh; the real
4663 ;; temporary file has another name, and it is
4664 ;; created and protected by ssh. It is also
4665 ;; removed by ssh when the connection is
4666 ;; closed. The temporary file name is cached
4667 ;; in the main connection process, therefore
4668 ;; we cannot use `tramp-get-connection-process'.
4674 tramp-temp-name-prefix
4676 spec r-shell)
4678 ;; Add arguments for asynchronous processes.
4682 ;; Add gateway arguments if necessary.
4688 ;; Check for port number. Until now, there's no
4689 ;; need for handling like method, user, host.
4694 ;; Check, whether there is a restricted shell.
4699 ;; Set variables for computing the prompt for
4700 ;; reading password. They can also be derived
4701 ;; from a gateway.
4706 ;; Add login environment.
4709 login-env
4714 login-env))
4718 "%s=%s %s"
4721 command)))
4724 ;; Replace `login-args' place holders.
4732 ?h l-host ?u l-user ?p l-port ?c options)
4733 command
4735 ;; We do not want to see the trailing local
4736 ;; prompt in `start-file-process'.
4738 command " "
4744 ;; Local shell could be a Windows COMSPEC. It
4745 ;; doesn't know the ";" syntax, but we must exit
4746 ;; always for `start-file-process'. It could
4747 ;; also be a restricted shell, which does not
4748 ;; allow "exec".
4751 ;; Send the command.
4755 p vec pos tramp-actions-before-shell
4759 ;; Next hop.
4763 ;; Make initial shell settings.
4766 ;; When the user did interrupt, we must cleanup.
4769 ;; Propagate the quit signal.
4773 "Send the COMMAND to connection VEC.
4774 Erases temporary buffer before sending the command. If optional
4775 arg NEVEROPEN is non-nil, never try to open the connection. This
4776 is meant to be used from `tramp-maybe-open-connection' only. The
4777 function waits for output unless NOOUTPUT is set."
4781 ;; We mark the command string that it can be erased in the output buffer.
4783 ;; If we put `tramp-echo-mark' after a trailing newline (which
4784 ;; is assumed to be unquoted) `tramp-send-string' doesn't see
4785 ;; that newline and adds `tramp-rsh-end-of-line' right after
4786 ;; `tramp-echo-mark', so the remote shell sees two consecutive
4787 ;; trailing line endings and sends two prompts after executing
4788 ;; the command, which confuses `tramp-wait-for-output'.
4792 ;; No need to restore a trailing newline here since `tramp-send-string'
4793 ;; makes sure that the string ends in `tramp-rsh-end-of-line', anyway.
4795 ;; Send the command.
4801 "Wait for output from remote command."
4807 ;; be leading escape sequences, which must be ignored.
4809 ;; Sometimes, the commands do not return a newline but a
4810 ;; null byte before the shell prompt, for example "git
4811 ;; ls-files -c -z ...".
4816 ;; A simple-minded busybox has sent " ^H" sequences.
4817 ;; Delete them.
4822 ;; Delete the prompt.
4828 proc 'file-error
4829 "[[Remote prompt `%s' not found in %d secs]]"
4830 tramp-end-of-output timeout)
4832 proc 'file-error
4834 ;; Return value is whether end-of-output sentinel was found.
4835 found)))
4839 "Run COMMAND and check its exit status.
4840 Sends `echo $?' along with the COMMAND for checking the exit status.
4841 If COMMAND is nil, just sends `echo $?'. Returns `t' if the exit
4842 status is 0, and `nil' otherwise.
4844 If the optional argument SUBSHELL is non-nil, the command is
4845 executed in a subshell, ie surrounded by parentheses. If
4846 DONT-SUPPRESS-ERR is non-nil, stderr won't be sent to /dev/null."
4848 vec
4850 command
4852 "echo tramp_exit_status $?"
4866 "Run COMMAND, check exit status, throw error if exit status not okay.
4867 Similar to `tramp-send-command-and-check' but accepts two more arguments
4868 FMT and ARGS which are passed to `error'."
4873 "Run COMMAND and return the output, which must be a Lisp expression.
4874 If MARKER is a regexp, read the output after that string.
4875 In case there is no valid Lisp expression and NOERROR is nil, it
4876 raises an error."
4883 ;; Read the marker.
4889 vec 'file-error
4890 "`%s' does not return the marker `%s': `%s'"
4892 ;; Read the expression.
4895 ;; Error handling.
4900 vec 'file-error
4901 "`%s' does not return a valid Lisp expression: `%s'"
4905 "Convert `file-attributes' ATTR generated by perl script, stat or ls.
4906 Convert file mode bits to string and set virtual device number.
4907 Return ATTR."
4909 ;; Remove color escape sequences from symlink.
4913 ;; Convert uid and gid. Use -1 as indication of unusable value.
4924 ;; Convert last access time.
4929 ;; Convert last modification time.
4934 ;; Convert last status change time.
4939 ;; Convert file size.
4945 ;; Convert file mode bits to string.
4950 ;; Convert directory indication bit.
4953 ;; Convert symlink from `tramp-do-file-attributes-with-stat'.
4959 ;; Set file's gid change bit.
4967 ;; Convert inode.
4973 ;; Inodes can be incredible huge. We must hide this.
4975 ;; Set virtual device number.
4978 attr))
4981 "Converts STRING to shell glob pattern which ignores case."
4987 string
4991 "Create a file name suitable to be passed to `scp' or `nc' and workalikes."
4999 localname)
5005 "Return t if this is an out-of-band method, nil otherwise."
5007 ;; It shall be an out-of-band method.
5009 ;; There must be a size, otherwise the file doesn't exist.
5011 ;; Either the file size is large enough, or (in rare cases) there
5012 ;; does not exist a remote encoding.
5017 ;; Variables local to connection.
5021 ;; When `tramp-own-remote-path' is in `tramp-remote-path', we
5022 ;; cache the result for the session only. Otherwise, the result
5023 ;; is cached persistently.
5026 vec)
5027 "remote-path"
5036 ;; Default if "getconf" is not available.
5039 vec 3
5044 ;; The login shell could return more than just the $PATH
5045 ;; string. So we use `tramp-end-of-heredoc' as marker.
5048 vec
5054 'identity
5061 ;; Replace place holder `tramp-default-remote-path'.
5069 ;; Replace place holder `tramp-own-remote-path'.
5077 ;; Remove double entries.
5084 ;; Remove non-existing directories.
5086 nil
5096 x))
5097 x))
5098 remote-path)))))
5104 locale)
5110 candidates nil)
5112 ;; Return value.
5122 result)
5124 ;; Check parameters. On busybox, "ls" output coloring is
5125 ;; enabled by default sometimes. So we try to disable it
5126 ;; when possible. $LS_COLORING is not supported there.
5127 ;; Some "ls" versions are sensible wrt the order of
5128 ;; arguments, they fail when "-al" is after the
5129 ;; "--color=never" argument (for example on FreeBSD).
5144 ;; Some "ls" versions are sensible wrt the order of arguments,
5145 ;; they fail when "-al" is after the "--dired" argument (for
5146 ;; example on FreeBSD).
5154 "test"
5158 ;; Does `test A -nt B' work? Use abominable `find' construct if it
5159 ;; doesn't. BSD/OS 4.0 wants the parentheses around the command,
5160 ;; for otherwise the shell crashes.
5172 vec
5195 ;; We must check also for some Perl modules.
5203 result)))
5210 tmp)
5211 ;; Check whether stat(1) returns usable syntax. "%s" does not
5212 ;; work on older AIX systems.
5221 result)))
5231 result))))
5247 ;; Busyboxes do support the "-t" option only when they have been
5248 ;; built with the DESKTOP config option. Let's check it.
5251 vec "touch-t"
5253 vec
5255 "%s -t %s %s"
5256 result
5260 result)))
5279 result)
5281 ;; Check POSIX parameter.
5288 vec
5297 vec
5301 "print $>"
5313 vec
5317 "import os; print (os.getuid())"
5331 ;; Ensure there is a valid result.
5339 vec
5348 vec
5357 vec
5361 "import os; print (os.getgid())"
5375 ;; Ensure there is a valid result.
5381 ;; Some predefined connection properties.
5383 "Return the compress command related to PROP.
5384 PROP is either `inline-compress' or `inline-decompress'. SIZE is
5385 the length of the file to be compressed.
5387 If no corresponding command is found, nil is returned."
5396 "Return the coding command related to PROP.
5397 PROP is either `remote-encoding', `remote-decoding',
5398 `local-encoding' or `local-decoding'.
5400 SIZE is the length of the file to be coded. Depending on SIZE,
5401 compression might be applied.
5403 If no corresponding command is found, nil is returned.
5404 Otherwise, either a string is returned which contains a `%s' mark
5405 to be used for the respective input or output file; or a Lisp
5406 function cell is returned to be applied on a buffer."
5407 ;; We must catch the errors, because we want to return `nil', when
5408 ;; no inline coding is found.
5418 compress)
5419 ;; The connection property might have been cached. So we must
5420 ;; send the script to the remote side - maybe.
5428 ;; Check for the `compress' command.
5430 ;; Return the value.
5446 'call-process-region beg end
5451 coding)
5454 ;; Windows shells need the program file name after
5455 ;; the pipe symbol be quoted if they use forward
5456 ;; slashes as directory separators.
5463 coding compress))
5466 ;; Windows shells need the program file name after
5467 ;; the pipe symbol be quoted if they use forward
5468 ;; slashes as directory separators.
5473 compress coding))
5487 ;;; TODO:
5489 ;; * Don't use globbing for directories with many files, as this is
5490 ;; likely to produce long command lines, and some shells choke on
5491 ;; long command lines.
5492 ;; * Make it work for different encodings, and for different file name
5493 ;; encodings, too. (Daniel Pittman)
5494 ;; * Don't search for perl5 and perl. Instead, only search for perl and
5495 ;; then look if it's the right version (with `perl -v').
5496 ;; * When editing a remote CVS controlled file as a different user, VC
5497 ;; gets confused about the file locking status. Try to find out why
5498 ;; the workaround doesn't work.
5499 ;; * Allow out-of-band methods as _last_ multi-hop. Open a connection
5500 ;; until the last but one hop via `start-file-process'. Apply it
5501 ;; also for ftp and smb.
5502 ;; * WIBNI if we had a command "trampclient"? If I was editing in
5503 ;; some shell with root privileges, it would be nice if I could
5504 ;; just call
5505 ;; trampclient filename.c
5506 ;; as an editor, and the _current_ shell would connect to an Emacs
5507 ;; server and would be used in an existing non-privileged Emacs
5508 ;; session for doing the editing in question.
5509 ;; That way, I need not tell Emacs my password again and be afraid
5510 ;; that it makes it into core dumps or other ugly stuff (I had Emacs
5511 ;; once display a just typed password in the context of a keyboard
5512 ;; sequence prompt for a question immediately following in a shell
5513 ;; script run within Emacs -- nasty).
5514 ;; And if I have some ssh session running to a different computer,
5515 ;; having the possibility of passing a local file there to a local
5516 ;; Emacs session (in case I can arrange for a connection back) would
5517 ;; be nice.
5518 ;; Likely the corresponding Tramp server should not allow the
5519 ;; equivalent of the emacsclient -eval option in order to make this
5520 ;; reasonably unproblematic. And maybe trampclient should have some
5521 ;; way of passing credentials, like by using an SSL socket or
5522 ;; something. (David Kastrup)
5523 ;; * Reconnect directly to a compliant shell without first going
5524 ;; through the user's default shell. (Pete Forman)
5525 ;; * How can I interrupt the remote process with a signal
5526 ;; (interrupt-process seems not to work)? (Markus Triska)
5527 ;; * Avoid the local shell entirely for starting remote processes. If
5528 ;; so, I think even a signal, when delivered directly to the local
5529 ;; SSH instance, would correctly be propagated to the remote process
5530 ;; automatically; possibly SSH would have to be started with
5531 ;; "-t". (Markus Triska)
5532 ;; * It makes me wonder if tramp couldn't fall back to ssh when scp
5533 ;; isn't on the remote host. (Mark A. Hershberger)
5534 ;; * Use lsh instead of ssh. (Alfred M. Szmidt)
5535 ;; * Optimize out-of-band copying when both methods are scp-like (not
5536 ;; rsync).
5537 ;; * Keep a second connection open for out-of-band methods like scp or
5538 ;; rsync.
5540 ;;; tramp-sh.el ends here