| blob | ba7b7d95a4ba04514cad24d04d0accdda23598f5 |
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 "When invoking a shell, override the HISTFILE with this value.
71 is special on Unix systems and indicates the shell history should
72 not be logged (this avoids clutter due to Tramp commands).
74 If you set this variable to nil, however, the *override* is
75 disabled, so the history will go to the default storage
83 ;;;###tramp-autoload
87 ;; ksh on OpenBSD 4.5 requires that $PS1 contains a `#' character for
88 ;; root users. It uses the `$' character for other users. In order
89 ;; to guarantee a proper prompt, we use "#$ " for the prompt.
93 "///%s#$"
95 "String used to recognize end of output.
96 The '$' character at the end is quoted; the string cannot be
99 ;;;###tramp-autoload
106 ;; Initialize `tramp-methods' with the supported methods.
107 ;;;###tramp-autoload
118 ;;;###tramp-autoload
128 ;;;###tramp-autoload
145 ;;;###tramp-autoload
163 ;;;###tramp-autoload
178 ;;;###tramp-autoload
185 ;;;###tramp-autoload
192 ;;;###tramp-autoload
205 ;;;###tramp-autoload
218 ;;;###tramp-autoload
226 ;;;###tramp-autoload
234 ;; We use "-v" for better error tracking.
237 ;; We use "-p" as required for newer busyboxes. For older
238 ;; busybox/nc versions, the value must be (("-l") ("%r")). This
239 ;; can be achieved by tweaking `tramp-connection-properties'.
242 ;;;###tramp-autoload
250 ;;;###tramp-autoload
255 ;; Local $SHELL could be a nasty one, like zsh or fish. Let's override it.
260 ;;;###tramp-autoload
268 ;;;###tramp-autoload
275 ;;;###tramp-autoload
279 ;; ("%h") must be a single element, see `tramp-compute-multi-hops'.
283 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
284 tramp-terminal-type
285 tramp-initial-end-of-output))
290 ;;;###tramp-autoload
296 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
297 tramp-terminal-type
298 tramp-initial-end-of-output))
302 ;;;###tramp-autoload
309 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
310 tramp-terminal-type
311 tramp-initial-end-of-output))
321 ;;;###tramp-autoload
328 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
329 tramp-terminal-type
330 tramp-initial-end-of-output))
339 ;;;###tramp-autoload
350 ;;;###tramp-autoload
354 ;;;###tramp-autoload
358 ;; Do not add "ssh" based methods, otherwise ~/.ssh/config would be ignored.
359 ;; Do not add "plink" based methods, they ask interactively for the user.
360 ;;;###tramp-autoload
369 ;;;###tramp-autoload
375 ;;;###tramp-autoload
391 ;;;###tramp-autoload
396 ;;;###tramp-autoload
401 ;;;###tramp-autoload
409 ;;;###tramp-autoload
436 ;; "getconf PATH" yields:
437 ;; HP-UX: /usr/bin:/usr/ccs/bin:/opt/ansic/bin:/opt/langtools/bin:/opt/fortran/bin
438 ;; Solaris: /usr/xpg4/bin:/usr/ccs/bin:/usr/bin:/opt/SUNWspro/bin
439 ;; GNU/Linux (Debian, Suse): /bin:/usr/bin
440 ;; FreeBSD: /usr/bin:/bin:/usr/sbin:/sbin: - beware trailing ":"!
441 ;; IRIX64: /usr/bin
442 ;;;###tramp-autoload
448 "List of directories to search for executables on remote host.
449 For every remote host, this variable will be set buffer local,
450 keeping the list of existing directories on that host.
452 You can use `~' in this list, but when searching for a shell which groks
453 tilde expansion, all directory names starting with `~' will be ignored.
455 `Default Directories' represent the list of directories given by
457 entry on top of this list, because these are the default
458 directories for POSIX compatible commands. On remote hosts which
459 do not offer the getconf command (like cygwin), the value
462 `Private Directories' are the settings of the $PATH environment,
463 as given in your `~/.profile'."
470 ;;;###tramp-autoload
478 "List of environment variables to be set on the remote host.
480 Each element should be a string of the form ENVVARNAME=VALUE. An
481 entry ENVVARNAME= disables the corresponding environment variable,
482 which might have been set in the init files like ~/.profile.
484 Special handling is applied to the PATH environment, which should
485 not be set here. Instead, it should be set via `tramp-remote-path'."
491 "Alist specifying extra arguments to pass to the remote shell.
492 Entries are (REGEXP . ARGS) where REGEXP is a regular expression
493 matching the shell file name and ARGS is a string specifying the
494 arguments.
496 This variable is only used when Tramp needs to start up another shell
497 for tilde expansion. The extra arguments should typically prevent the
498 shell from reading its init file."
500 ;; This might be the wrong way to test whether the widget type
501 ;; `alist' is available. Who knows the right way to test it?
516 "List of pattern/action pairs.
517 Whenever a pattern matches, the corresponding action is performed.
518 Each item looks like (PATTERN ACTION).
520 The PATTERN should be a symbol, a variable. The value of this
521 variable gives the regular expression to search for. Note that the
523 appended to it.
525 The ACTION should also be a symbol, but a function. When the
533 "List of pattern/action pairs.
534 This list is used for copying/renaming with out-of-band methods.
539 "(echo begin 600 %t; tail -n +2) | uudecode
540 cat %t
541 rm -f %t"
542 "Shell function to implement `uudecode' to standard output.
543 Many systems support `uudecode -o /dev/stdout' or `uudecode -o -'
544 for this or `uudecode -p', but some systems don't, and for them
548 "%s -e '
549 use File::Spec;
552 sub recursive {
553 my ($volume, @dirs) = @_;
554 my $real = realpath(File::Spec->catpath(
556 if ($real) {
557 my ($vol, $dir) = File::Spec->splitpath($real, 1);
558 return ($vol, File::Spec->splitdir($dir));
559 }
560 else {
561 my $last = pop(@dirs);
562 ($volume, @dirs) = recursive($volume, @dirs);
563 push(@dirs, $last);
564 return ($volume, @dirs);
565 }
566 }
568 $result = realpath($ARGV[0]);
569 if (!$result) {
570 my ($vol, $dir) = File::Spec->splitpath($ARGV[0], 1);
571 ($vol, @dirs) = recursive($vol, File::Spec->splitdir($dir));
574 }
578 }
582 "Perl script to produce output suitable for use with `file-truename'
583 on the remote file system.
584 Escape sequence %s is replaced with name of Perl binary.
588 "%s -e 'sub case {
589 my $str = shift;
590 if ($ARGV[2]) {
591 return lc($str);
592 }
593 else {
594 return $str;
595 }
596 }
598 @files = readdir(d); closedir(d);
599 foreach $f (@files) {
600 if (case(substr($f, 0, length($ARGV[1]))) eq case($ARGV[1])) {
603 }
604 else {
606 }
607 }
608 }
611 "Perl script to produce output suitable for use with
612 `file-name-all-completions' on the remote file system. Escape
613 sequence %s is replaced with name of Perl binary. This string is
616 ;; Perl script to implement `file-attributes' in a Lisp `read'able
617 ;; output. If you are hacking on this, note that you get *no* output
618 ;; unless this spits out a complete line, including the '\n' at the
619 ;; end.
620 ;; The device number is returned as "-1", because there will be a virtual
621 ;; device number set in `tramp-sh-handle-file-attributes'.
623 "%s -e '
624 @stat = lstat($ARGV[0]);
625 if (!@stat) {
627 exit 0;
628 }
629 if (($stat[2] & 0170000) == 0120000)
630 {
631 $type = readlink($ARGV[0]);
633 }
634 elsif (($stat[2] & 0170000) == 040000)
635 {
637 }
638 else
639 {
641 };
644 printf(
646 $type,
647 $stat[3],
648 $uid,
649 $gid,
650 $stat[8] >> 16 & 0xffff,
651 $stat[8] & 0xffff,
652 $stat[9] >> 16 & 0xffff,
653 $stat[9] & 0xffff,
654 $stat[10] >> 16 & 0xffff,
655 $stat[10] & 0xffff,
656 $stat[7],
657 $stat[2],
658 $stat[1] >> 16 & 0xffff,
659 $stat[1] & 0xffff
661 "Perl script to produce output suitable for use with `file-attributes'
662 on the remote file system.
663 Escape sequence %s is replaced with name of Perl binary.
667 "%s -e '
670 @list = readdir(DIR);
671 closedir(DIR);
672 $n = scalar(@list);
674 for($i = 0; $i < $n; $i++)
675 {
676 $filename = $list[$i];
677 @stat = lstat($filename);
678 if (($stat[2] & 0170000) == 0120000)
679 {
680 $type = readlink($filename);
682 }
683 elsif (($stat[2] & 0170000) == 040000)
684 {
686 }
687 else
688 {
690 };
693 printf(
694 \"(\\\"%%s\\\" %%s %%u %%s %%s (%%u %%u) (%%u %%u) (%%u %%u) %%u.0 %%u t (%%u . %%u) (%%u . %%u))\\n\",
695 $filename,
696 $type,
697 $stat[3],
698 $uid,
699 $gid,
700 $stat[8] >> 16 & 0xffff,
701 $stat[8] & 0xffff,
702 $stat[9] >> 16 & 0xffff,
703 $stat[9] & 0xffff,
704 $stat[10] >> 16 & 0xffff,
705 $stat[10] & 0xffff,
706 $stat[7],
707 $stat[2],
708 $stat[1] >> 16 & 0xffff,
709 $stat[1] & 0xffff,
710 $stat[0] >> 16 & 0xffff,
711 $stat[0] & 0xffff);
712 }
714 "Perl script implementing `directory-files-attributes' as Lisp `read'able
715 output.
716 Escape sequence %s is replaced with name of Perl binary.
719 ;; These two use base64 encoding.
721 "%s -MMIME::Base64 -0777 -ne 'print encode_base64($_)' 2>/dev/null"
722 "Perl program to use for encoding a file.
723 Escape sequence %s is replaced with name of Perl binary.
724 This string is passed to `format', so percent characters need to be doubled.
725 This implementation requires the MIME::Base64 Perl module to be installed
729 "%s -MMIME::Base64 -0777 -ne 'print decode_base64($_)' 2>/dev/null"
730 "Perl program to use for decoding a file.
731 Escape sequence %s is replaced with name of Perl binary.
732 This string is passed to `format', so percent characters need to be doubled.
733 This implementation requires the MIME::Base64 Perl module to be installed
737 "%s -e '
738 # This script contributed by Juanma Barranquero <lektu@terra.es>.
739 # Copyright (C) 2002-2014 Free Software Foundation, Inc.
740 use strict;
742 my %%trans = do {
743 my $i = 0;
744 map {(substr(unpack(q(B8), chr $i++), 2, 6), $_)}
745 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/);
746 };
747 my $data;
749 # We read in chunks of 54 bytes, to generate output lines
750 # of 72 chars (plus end of line)
751 while (read STDIN, $data, 54) {
752 my $pad = q();
754 # Only for the last chunk, and only if did not fill the last three-byte packet
755 if (eof) {
756 my $mod = length($data) %% 3;
757 $pad = q(=) x (3 - $mod) if $mod;
758 }
760 # Not the fastest method, but it is simple: unpack to binary string, split
761 # by groups of 6 bits and convert back from binary to byte; then map into
762 # the translation table
763 print
764 join q(),
765 map($trans{$_},
766 (substr(unpack(q(B*), $data) . q(00000), 0, 432) =~ /....../g)),
767 $pad,
769 }' 2>/dev/null"
770 "Perl program to use for encoding a file.
771 Escape sequence %s is replaced with name of Perl binary.
775 "%s -e '
776 # This script contributed by Juanma Barranquero <lektu@terra.es>.
777 # Copyright (C) 2002-2014 Free Software Foundation, Inc.
778 use strict;
780 my %%trans = do {
781 my $i = 0;
782 map {($_, substr(unpack(q(B8), chr $i++), 2, 6))}
783 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/)
784 };
786 my %%bytes = map {(unpack(q(B8), chr $_), chr $_)} 0 .. 255;
790 # We are going to accumulate into $pending to accept any line length
791 # (we do not check they are <= 76 chars as the RFC says)
792 my $pending = q();
794 while (my $data = <STDIN>) {
795 chomp $data;
797 # If we find one or two =, we have reached the end and
798 # any following data is to be discarded
799 my $finished = $data =~ s/(==?).*/$1/;
800 $pending .= $data;
802 my $len = length($pending);
803 my $chunk = substr($pending, 0, $len & ~3);
804 $pending = substr($pending, $len & ~3 + 1);
806 # Easy method: translate from chars to (pregenerated) six-bit packets, join,
807 # split in 8-bit chunks and convert back to char.
808 print join q(),
809 map $bytes{$_},
810 ((join q(), map {$trans{$_} || q()} split //, $chunk) =~ /......../g);
812 last if $finished;
813 }' 2>/dev/null"
814 "Perl program to use for decoding a file.
815 Escape sequence %s is replaced with name of Perl binary.
819 "%s -e 'binmode STDIN; binmode STDOUT; print pack(q{u*}, join q{}, <>)'"
820 "Perl program to use for encoding a file.
824 "%s -e 'binmode STDIN; binmode STDOUT; print unpack(q{u*}, join q{}, <>)'"
825 "Perl program to use for decoding a file.
830 while read file; do
833 else
835 fi
838 else
840 fi
841 done
843 "Script to check existence of VC related files.
844 It must be send formatted with two strings; the tests for file
845 existence, and file readability. Input shall be read via
846 here-document, otherwise the command could exceed maximum length
849 ;; New handlers should be added here.
853 ;; `byte-compiler-base-file-name' performed by default handler.
858 ;; `diff-latest-backup-file' performed by default handler.
862 . tramp-sh-handle-directory-files-and-attributes)
863 ;; `dired-call-process' performed by default handler.
866 . tramp-sh-handle-dired-recursive-delete-directory)
873 ;; `file-equal-p' performed by default handler.
876 ;; `file-in-directory-p' performed by default handler.
884 ;; `file-name-sans-versions' performed by default handler.
897 ;; `find-file-noselect' performed by default handler.
898 ;; `get-file-buffer' performed by default handler.
902 . tramp-sh-handle-insert-file-contents-literally)
921 "Alist of handler functions.
924 ;; This must be the last entry, because `identity' always matches.
925 ;;;###tramp-autoload
929 ;;; File Name Handler Functions:
933 "Like `make-symbolic-link' for Tramp files.
934 If LINKNAME is a non-Tramp file, it is used verbatim as the target of
935 the symlink. If LINKNAME is a Tramp file, only the localname component is
936 used as the target of the symlink.
938 If LINKNAME is a Tramp file and the localname component is relative, then
939 it is expanded first, before the localname component is taken. Note that
940 this can give surprising results if the user/host for the source and
941 target of the symlink differ."
948 l 'file-error
951 ;; Do the 'confirm if exists' thing.
953 ;; What to do?
958 "File %s already exists; make it a link anyway? "
959 l-localname)))))
964 ;; If FILENAME is a Tramp name, use just the localname component.
973 ;; Right, they are on the same host, regardless of user, method,
974 ;; etc. We now make the link on the remote machine. This will
975 ;; occur as the user that FILENAME belongs to.
977 l
979 "cd %s && %s -sf %s %s"
981 ln
984 t))))
987 "Like `file-truename' for Tramp files."
989 "%s%s"
992 method user host
997 ;; Use GNU readlink --canonicalize-missing where available.
1000 v
1008 ;; Use Perl implementation.
1016 v
1020 ;; Do it yourself. We bind `directory-sep-char' here for
1021 ;; XEmacs on Windows, which would otherwise use backslash.
1029 ;; Don't make the following value larger than
1030 ;; necessary. People expect an error message in
1031 ;; a timely fashion when something is wrong;
1032 ;; otherwise they might think that Emacs is hung.
1033 ;; Of course, correctness has to come first.
1035 symlink-target)
1046 method user host
1058 ;; It's a symlink, follow it.
1064 ;; If the symlink was absolute, we'll get a
1065 ;; string like "/user@host:/some/target";
1066 ;; extract the "/some/target" part from it.
1070 v 'file-error
1071 "Symlink target `%s' on wrong host"
1072 symlink-target))
1077 steps)))
1079 ;; It's a file.
1083 v 'file-error
1086 ;; Combine list to form string.
1097 result))))
1099 ;; Preserve trailing "/".
1102 ;; Basic functions.
1105 "Like `file-exists-p' for Tramp files."
1113 v
1115 "%s %s"
1120 "Like `file-attributes' for Tramp files."
1123 ;; Don't modify `last-coding-system-used' by accident.
1130 v
1138 ;; The scripts could fail, for example with huge file size.
1142 "Implement `file-attributes' for Tramp files using the ls(1) command."
1144 res-inode res-filemodes res-numlinks
1145 res-uid res-gid res-size res-symlink-target)
1148 vec
1157 ;; parse `ls -l' output ...
1161 ;; ... inode
1177 ;; ... file mode flags
1179 ;; ... number links
1181 ;; ... uid and gid
1191 ;; ... size
1193 ;; From the file modes, figure out other stuff.
1196 ;; if symlink, find out file name pointed to
1200 ;; return data gathered
1202 ;; 0. t for directory, string (name linked to) for symbolic
1203 ;; link, or nil.
1205 ;; 1. Number of links to file.
1206 res-numlinks
1207 ;; 2. File uid.
1208 res-uid
1209 ;; 3. File gid.
1210 res-gid
1211 ;; 4. Last access time, as a list of integers. Normally this
1212 ;; would be in the same format as `current-time', but the
1213 ;; subseconds part is not currently implemented, and (0 0)
1214 ;; denotes an unknown time.
1215 ;; 5. Last modification time, likewise.
1216 ;; 6. Last status change time, likewise.
1218 ;; 7. Size in bytes (-1, if number is out of range).
1219 res-size
1220 ;; 8. File modes, as a string of ten letters or dashes as in ls -l.
1221 res-filemodes
1222 ;; 9. t if file's gid would change if file were deleted and
1223 ;; recreated. Will be set in `tramp-convert-file-attributes'
1224 t
1225 ;; 10. inode number.
1226 res-inode
1227 ;; 11. Device number. Will be replaced by a virtual device number.
1228 -1
1229 )))))
1233 "Implement `file-attributes' for Tramp files using a Perl script."
1238 vec
1244 "Implement `file-attributes' for Tramp files using stat(1) command."
1247 vec
1249 ;; On Opsware, pdksh (which is the true name of ksh there) doesn't
1250 ;; parse correctly the sequence "((". Therefore, we add a space.
1251 "( (%s %s || %s -h %s) && %s -c '((\"%%N\") %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 \"%%A\" t %%ie0 -1)' %s || echo nil)"
1262 "Like `set-visited-file-modtime' for Tramp files."
1269 coding-system-used)
1273 ;; '(-1 65535) means file doesn't exists yet.
1277 ;; We use '(0 0) as a don't-know value. See also
1278 ;; `tramp-do-file-attributes-with-ls'.
1283 v
1292 nil)))))
1294 ;; This function makes the same assumption as
1295 ;; `tramp-sh-handle-set-visited-file-modtime'.
1297 "Like `verify-visited-file-modtime' for Tramp files.
1298 At the time `verify-visited-file-modtime' calls this function, we
1299 already know that the buffer is visiting a file and that
1300 `visited-file-modtime' does not return 0. Do not call this
1301 function directly, unless those two cases are already taken care
1302 of."
1305 ;; There is no file visiting the buffer, or the buffer has no
1306 ;; recorded last modification time, or there is no established
1307 ;; connection.
1311 t
1319 ;; File exists, and has a known modtime.
1322 modtime
1323 ;; For compatibility, deal with both the old
1324 ;; (HIGH . LOW) and the new (HIGH LOW) return
1325 ;; values of `visited-file-modtime'.
1328 mt)))
1330 ;; Modtime has the don't know value.
1333 v
1340 attr
1343 ;; If file does not exist, say it is not modified if and
1344 ;; only if that agrees with the buffer's record.
1348 "Like `set-file-modes' for Tramp files."
1351 ;; FIXME: extract the proper text from chmod's stderr.
1353 v
1360 "Like `set-file-times' for Tramp files."
1367 time))
1368 ;; With GNU Emacs, `format-time-string' has an
1369 ;; optional parameter UNIVERSAL. This is preferred,
1370 ;; because we could handle the case when the remote
1371 ;; host is located in a different time zone as the
1372 ;; local host.
1376 "%s %s %s %s"
1387 ;; We handle also the local part, because in older Emacsen,
1388 ;; without `set-file-times', this function is an alias for this.
1389 ;; We are local, so we don't need the UTC settings.
1397 "Set the ownership for FILENAME.
1398 If UID and GID are provided, these values are used; otherwise uid
1399 and gid of the corresponding user is taken. Both parameters must
1400 be non-negative integers."
1401 ;; Modern Unices allow chown only for root. So we might need
1402 ;; another implementation, see `dired-do-chown'. OTOH, it is mostly
1403 ;; working with su(do)? when it is needed, so it shall succeed in
1404 ;; the majority of cases.
1405 ;; Don't modify `last-coding-system-used' by accident.
1410 ;; If we are root on the local host, we can do it directly.
1418 "chown %d:%d %s" uid gid
1421 ;; We handle also the local part, because there doesn't exist
1422 ;; `set-file-uid-gid'. On W32 "chown" might not work.
1426 nil "chown" nil nil nil
1430 "Check, whether SELINUX is enabled on the remote host."
1442 "Like `file-selinux-context' for Tramp files."
1451 "%s -d -Z %s"
1459 ;; Return the context.
1460 context))))
1463 "Like `set-file-selinux-context' for Tramp files."
1480 t)
1482 nil)))
1485 "Check, whether ACL is enabled on the remote host."
1490 "Like `file-acl' for Tramp files."
1496 "getfacl -ac %s 2>/dev/null"
1506 "Like `set-file-acl' for Tramp files."
1513 tramp-end-of-heredoc
1514 acl-string
1515 tramp-end-of-heredoc))
1517 ;; Success.
1520 t)
1521 ;; In case of errors, we return `nil'.
1523 nil)))
1525 ;; Simple functions using the `test' command.
1528 "Like `file-executable-p' for Tramp files."
1531 ;; Examine `file-attributes' cache to see if request can be
1532 ;; satisfied without remote operation.
1537 "Like `file-readable-p' for Tramp files."
1540 ;; Examine `file-attributes' cache to see if request can be
1541 ;; satisfied without remote operation.
1545 ;; When the remote shell is started, it looks for a shell which groks
1546 ;; tilde expansion. Here, we assume that all shells which grok tilde
1547 ;; expansion will also provide a `test' command which groks `-nt' (for
1548 ;; newer than). If this breaks, tell me about it and I'll try to do
1549 ;; something smarter about it.
1551 "Like `file-newer-than-file-p' for Tramp files."
1553 nil)
1555 t)
1556 ;; We are sure both files exist at this point.
1559 ;; We try to get the mtime of both files. If they are not
1560 ;; equal to the "dont-know" value, then we subtract the times
1561 ;; and obtain the result.
1567 ;; If one of them is the dont-know value, then we can
1568 ;; still try to run a shell command on the remote host.
1569 ;; However, this only works if both files are Tramp
1570 ;; files and both have the same method, same user, same
1571 ;; host.
1576 v 'file-error
1577 "Files %s and %s must have same method, user, host"
1578 file1 file2)))
1583 ;; Functions implemented using the basic functions above.
1586 "Like `file-directory-p' for Tramp files."
1588 ;; `file-directory-p' is used as predicate for file name completion.
1589 ;; Sometimes, when a connection is not established yet, it is
1590 ;; desirable to return t immediately for "/method:foo:". It can
1591 ;; be expected that this is always a directory.
1597 "Like `file-writable-p' for Tramp files."
1601 ;; Examine `file-attributes' cache to see if request can be
1602 ;; satisfied without remote operation.
1605 ;; If file doesn't exist, check if directory is writable.
1610 "Like `file-ownership-preserved-p' for Tramp files."
1614 ;; Return t if the file doesn't exist, since it's true that no
1615 ;; information would be lost by an (attempted) delete and create.
1622 ;; Directory listings.
1626 "Like `directory-files-and-attributes' for Tramp files."
1630 directory full match nosort id-format)
1632 ;; Do it directly.
1640 v localname
1650 v localname id-format))
1653 v localname id-format)))))))))
1654 result item)
1664 result
1669 "Implement `directory-files-and-attributes' for Tramp files using a Perl script."
1672 vec tramp-perl-directory-files-and-attributes
1676 vec
1680 object))
1684 "Implement `directory-files-and-attributes' for Tramp files using stat(1) command."
1687 vec
1690 ;; We must care about file names with spaces, or starting with
1691 ;; "-"; this would confuse xargs. "ls -aQ" might be a solution,
1692 ;; but it does not work on all remote systems. Therefore, we
1693 ;; quote the file names via sed.
1695 "xargs %s -c "
1704 ;; This function should return "foo/" for directories and "bar" for
1705 ;; files.
1707 "Like `file-name-all-completions' for Tramp files."
1712 filename
1714 'list
1716 ;; Try cache entries for `filename', `filename' with last
1717 ;; character removed, `filename' with last two characters
1718 ;; removed, ..., and finally the empty string - all
1719 ;; concatenated to the local directory name.
1722 tramp-completion-reread-directory-timeout)))
1724 ;; This is inefficient for very long file names, pity
1725 ;; `reduce' is not available...
1728 'append
1733 v
1735 "file-name-all-completions"
1736 nil)))
1738 ;; We cannot use a length of 0, because file properties
1739 ;; for "foo" and "foo/" are identical.
1742 ;; Cache expired or no matching cache entry found so we need
1743 ;; to perform a remote operation.
1745 ;; Get a list of directories and files, including reliably
1746 ;; tagging the directories with a trailing '/'. Because I
1747 ;; rock. --daniel@danann.net
1749 ;; Changed to perform `cd' in the same remote op and only
1750 ;; get entries starting with `filename'. Capture any `cd'
1751 ;; error messages. Ensure any `cd' and `echo' aliases are
1752 ;; ignored.
1754 v
1758 v tramp-perl-file-name-all-completions
1764 ;; `read-file-name-completion-ignore-case'
1765 ;; is introduced with Emacs 22.1.
1768 'read-file-name-completion-ignore-case
1774 ;; `ls' with wildcard might fail with `Argument
1775 ;; list too long' error in some corner cases; if
1776 ;; `ls' fails after `cd' succeeded, chances are
1777 ;; that's the case, so let's retry without
1778 ;; wildcard. This will return "too many" entries
1779 ;; but that isn't harmful.
1780 " || %s -a 2>/dev/null)"
1781 " | while IFS= read f; do"
1787 ;; When `filename' is empty, just `ls' without
1788 ;; `filename' argument is more efficient than `ls *'
1789 ;; for very large directories and might avoid the
1790 ;; `Argument list too long' error.
1791 ;;
1792 ;; With and only with wildcard, we need to add
1793 ;; `-d' to prevent `ls' from descending into
1794 ;; sub-directories.
1796 "."
1801 ;; Now grab the output.
1805 ;; Check result code, found in last line of output.
1809 ;; Grab error message from line before last line
1810 ;; (it was put there by `cd 2>&1').
1813 v 'file-error
1814 "tramp-sh-handle-file-name-all-completions: %s"
1816 ;; For peace of mind, if buffer doesn't end in `fail'
1817 ;; then it should end in `ok'. If neither are in the
1818 ;; buffer something went seriously wrong on the remote
1819 ;; side.
1822 v 'file-error
1823 "\
1824 tramp-sh-handle-file-name-all-completions: internal error accessing `%s': `%s'"
1830 ;; Because the remote op went through OK we know the
1831 ;; directory we `cd'-ed to exists.
1834 ;; Because the remote op went through OK we know every
1835 ;; file listed by `ls' exists.
1839 result)
1841 ;; Store result in the cache.
1846 ;; cp, mv and ln
1850 "Like `add-name-to-file' for Tramp files."
1855 v 'file-error
1856 "add-name-to-file: %s"
1865 "File %s already exists; make it a new name anyway? "
1866 newname)))
1873 v1
1877 "error with add-name-to-file, see buffer `%s' for details"
1882 preserve-uid-gid preserve-extended-attributes)
1883 "Like `copy-file' for Tramp files."
1887 ;; At least one file a Tramp file?
1891 'copy filename newname ok-if-already-exists keep-date
1892 preserve-uid-gid preserve-extended-attributes))
1893 ;; Compat section.
1896 'copy-file
1898 preserve-uid-gid preserve-extended-attributes)))
1901 'copy-file
1909 "Like `copy-directory' for Tramp files."
1915 ;; When DIRNAME and NEWNAME are remote, they must have
1916 ;; the same method.
1922 ;; scp or rsync DTRT.
1936 ;; We must do it file-wise.
1938 'copy-directory
1943 ;; When newname did exist, we have wrong cached values.
1951 "Like `rename-file' for Tramp files."
1952 ;; Check if both files are local -- invoke normal rename-file.
1953 ;; Otherwise, use Tramp from local system.
1956 ;; At least one file a Tramp file?
1966 preserve-uid-gid preserve-extended-attributes)
1967 "Copy or rename a remote file.
1968 OP must be `copy' or `rename' and indicates the operation to perform.
1969 FILENAME specifies the file to copy or rename, NEWNAME is the name of
1970 the new file (for copy) or the new name of the file (for rename).
1971 OK-IF-ALREADY-EXISTS means don't barf if NEWNAME exists already.
1972 KEEP-DATE means to make sure that NEWNAME has the same timestamp
1973 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
1974 the uid and gid if both files are on the same host.
1975 PRESERVE-EXTENDED-ATTRIBUTES activates selinux and acl commands.
1977 This function is invoked by `tramp-sh-handle-copy-file' and
1978 `tramp-sh-handle-rename-file'. It is an error if OP is neither
1979 of `copy' and `rename'. FILENAME and NEWNAME must be absolute
1980 file names."
1997 filename newname)
2000 ;; Both are Tramp files.
2005 ;; Shortcut: if method, host, user are the same for
2006 ;; both files, we invoke `cp' or `mv' on the remote
2007 ;; host directly.
2010 op filename newname
2011 ok-if-already-exists keep-date preserve-uid-gid))
2013 ;; Try out-of-band operation.
2018 op filename newname keep-date))
2020 ;; No shortcut was possible. So we copy the file
2021 ;; first. If the operation was `rename', we go back
2022 ;; and delete the original file (if the copy was
2023 ;; successful). The approach is simple-minded: we
2024 ;; create a new buffer, insert the contents of the
2025 ;; source file into it, then write out the buffer to
2026 ;; the target file. The advantage is that it doesn't
2027 ;; matter which file name handlers are used for the
2028 ;; source and target file.
2031 op filename newname keep-date))))))
2033 ;; One file is a Tramp file, the other one is local.
2036 ;; Fast track on local machine.
2039 op filename newname
2040 ok-if-already-exists keep-date preserve-uid-gid))
2042 ;; If the Tramp file has an out-of-band method, the
2043 ;; corresponding copy-program can be invoked.
2046 op filename newname keep-date))
2048 ;; Use the inline method via a Tramp buffer.
2050 op filename newname keep-date))))
2053 ;; One of them must be a Tramp file.
2056 ;; Handle `preserve-extended-attributes'. We ignore possible
2057 ;; errors, because ACL strings could be incompatible.
2062 ;; In case of `rename', we must flush the cache of the source file.
2068 ;; When newname did exist, we have wrong cached values.
2075 "Use an Emacs buffer to copy or rename a file.
2076 First arg OP is either `copy' or `rename' and indicates the operation.
2077 FILENAME is the source file, NEWNAME the target file.
2078 KEEP-DATE is non-nil if NEWNAME should have the same timestamp as FILENAME."
2080 ;; We must disable multibyte, because binary data shall not be
2081 ;; converted. We remove `tramp-file-name-handler' from
2082 ;; `inhibit-file-name-handlers'; otherwise the file name handler
2083 ;; for `insert-file-contents' might be deactivated in some corner
2084 ;; cases.
2091 ;; We don't want the target file to be compressed, so we let-bind
2092 ;; `jka-compr-inhibit' to t.
2096 ;; KEEP-DATE handling.
2098 ;; Set the mode.
2100 ;; If the operation was `rename', delete the original file.
2105 "Invokes `cp' or `mv' on the remote system.
2106 OP must be one of `copy' or `rename', indicating `cp' or `mv',
2107 respectively. FILENAME specifies the file to copy or rename,
2108 NEWNAME is the name of the new file (for copy) or the new name of
2109 the file (for rename). Both files must reside on the same host.
2110 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2111 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2112 the uid and gid from FILENAME."
2122 v 'file-error
2123 "Unknown operation `%s', must be `copy' or `rename'"
2124 op))))
2128 filename))
2132 newname))
2134 cmd-result)
2137 ;; Both files are on a remote host, with same user.
2149 ;; Mask cp -f error.
2151 tramp-operation-not-permitted-regexp nil t))
2152 cmd-result)
2154 nil v 'file-error
2155 "Copying directly failed, see buffer `%s' for details."
2158 ;; We are on the local host.
2161 ;; We can do it directly.
2164 ;; No sticky bit when renaming.
2175 localname1 localname2 ok-if-already-exists
2176 keep-date preserve-uid-gid)
2180 ;; We can do it directly with `tramp-send-command'
2188 ok-if-already-exists keep-date t)
2189 ;; We must change the ownership to the local user.
2195 ;; We need a temporary file in between.
2197 ;; Create the temporary file.
2205 "%s %s %s" cmd
2208 "Copying directly failed, see buffer `%s' for details."
2210 ;; We must change the ownership as remote user.
2211 ;; Since this does not work reliable, we also
2212 ;; give read permissions.
2223 localname1 tmpfile t
2224 keep-date preserve-uid-gid)
2226 'rename-file
2228 ;; We must change the ownership as local user.
2229 ;; Since this does not work reliable, we also
2230 ;; give read permissions.
2234 tmpfile
2238 ;; Move the temporary file to its destination.
2243 "cp -f -p %s %s"
2246 "Copying directly failed, see buffer `%s' for details."
2250 'rename-file
2253 ;; Save exit.
2256 ;; Set the time and mode. Mask possible errors.
2263 "Invoke `scp' program to copy.
2264 The method used must be an out-of-band method."
2268 copy-program copy-args copy-env copy-keep-date port listener spec
2269 options source target remote-copy-program remote-copy-args)
2274 ;; Both are Tramp files. We shall optimize it when the
2275 ;; methods for FILENAME and NEWNAME are the same.
2285 op filename tmpfile keep-date)
2288 ;; Save exit.
2295 ;; Set variables for computing the prompt for reading
2296 ;; password.
2303 ;; Expand hops. Might be necessary for gateway methods.
2307 ;; Check which ones of source and target are Tramp files.
2316 'file-name-directory
2322 ;; Check for host and port number. We cannot use
2323 ;; `tramp-file-name-port', because this returns also
2324 ;; `tramp-default-port', which might clash with settings in
2325 ;; "~/.ssh/config".
2332 ;; Check for user. There might be an interactive setting.
2336 ;; Check for listener port.
2343 ;; Compose copy command.
2353 spec)
2355 ?h host ?u user ?p port ?r listener ?c options
2362 copy-args
2364 ;; " " has either been a replacement of "%k" (when
2365 ;; keep-date argument is non-nil), or a replacement
2366 ;; for the whole keep-date sublist.
2367 " "
2371 copy-args)
2374 copy-args
2378 copy-env
2380 nil
2387 remote-copy-program
2397 remote-copy-args
2401 ;; Check for local copy program.
2406 ;; Install listener on the remote side. The prompt must be
2407 ;; consumed later on, when the process does not listen anymore.
2414 v 'file-error
2418 'identity
2426 v 'file-error
2427 "Listener process not running on remote host: `%s'"
2428 remote-copy-program))
2436 ;; The default directory must be remote.
2440 ;; Set the transfer process properties.
2450 copy-args
2452 copy-args
2457 ;; Use an asynchronous process. By this, password can
2458 ;; be handled. We don't set a timeout, because the
2459 ;; copying of large files can last longer than 60
2460 ;; secs.
2464 copy-program
2466 copy-args
2475 p v nil tramp-actions-copy-out-of-band)
2477 ;; Check the return code.
2482 orig-vec 'file-error
2483 "Couldn't find exit status of `%s'"
2489 orig-vec 'file-error
2490 "Error copying: `%s'"
2493 ;; Reset the transfer process properties.
2496 ;; Clear the remote prompt.
2499 ;; Houston, we have a problem! Likely, the listener is
2500 ;; still running, so let's clear everything (but the
2501 ;; cached password).
2504 ;; Handle KEEP-DATE argument.
2508 ;; Set the mode.
2513 ;; If the operation was `rename', delete the original file.
2520 "Like `make-directory' for Tramp files."
2532 "Like `delete-directory' for Tramp files."
2544 "Like `delete-file' for Tramp files."
2555 ;; Dired.
2557 ;; CCC: This does not seem to be enough. Something dies when
2558 ;; we try and delete two directories under Tramp :/
2560 "Recursively delete the directory given.
2561 This is like `dired-recursive-delete-directory' for Tramp files."
2563 ;; Run a shell command 'rm -r <localname>'.
2564 ;; Code shamelessly stolen from the dired implementation and, um, hacked :)
2567 ;; Which is better, -r or -R? (-r works for me <daniel@danann.net>).
2569 v
2571 ;; Don't read the output, do it explicitly.
2572 nil t)
2573 ;; Wait for the remote system to return to us...
2574 ;; This might take a while, allow it plenty of time.
2576 ;; Make sure that it worked...
2584 "Like `dired-compress-file' for Tramp files."
2585 ;; OK-FLAG is valid for XEmacs only, but not implemented.
2586 ;; Code stolen mainly from dired-aux.el.
2592 ;; Emacs case
2594 ;; XEmacs has `dired-compression-method-alist', which is
2595 ;; transformed into `dired-compress-file-suffixes' structure.
2599 nil
2602 suffix)
2603 ;; See if any suffix rule matches this file name.
2611 nil)
2613 ;; We found an uncompression rule.
2619 ;; `dired-remove-file' is not defined in XEmacs.
2624 ;; We don't recognize the file as compressed, so compress it.
2625 ;; Try gzip.
2630 ;; `dired-remove-file' is not defined in XEmacs.
2640 "Like `insert-directory' for Tramp files."
2647 filename switches wildcard full-directory-p)
2667 ;; If `full-directory-p', we just say `ls -l FILENAME'.
2668 ;; Else we chdir to the parent directory, then say `ls -ld BASENAME'.
2671 v
2674 switches
2676 localname
2679 v
2683 "Couldn't `cd %s'"
2687 v
2690 switches
2695 ""
2703 ;; We cannot use `insert-buffer-substring' because the Tramp
2704 ;; buffer changes its contents before insertion due to calling
2705 ;; `expand-file' and alike.
2710 ;; Check for "--dired" output.
2717 ;; Now read the numeric positions of file names.
2723 ;; End is followed by \n or by " -> ".
2725 ;; Remove trailing lines.
2731 ;; Some busyboxes are reluctant to discard colors.
2738 ;; Decode the output, it could be multibyte.
2745 ;; The inserted file could be from somewhere else.
2752 "."
2759 ;; Canonicalization of file names.
2762 "Like `expand-file-name' for Tramp files.
2764 the result will be a local, non-Tramp, file name."
2765 ;; If DIR is not given, use `default-directory' or "/".
2767 ;; Unless NAME is absolute, concat DIR and NAME.
2770 ;; If NAME is not a Tramp file, run the real handler.
2773 ;; Dissect NAME.
2777 ;; Tilde expansion if necessary. This needs a shell which
2778 ;; groks tilde expansion! The function `tramp-find-shell' is
2779 ;; supposed to find such a shell on the remote host. Please
2780 ;; tell me about it when this doesn't work on your system.
2784 ;; We cannot simply apply "~/", because under sudo "~/" is
2785 ;; expanded to the local user home directory but to the
2786 ;; root home directory. On the other hand, using always
2787 ;; the default user name for tilde expansion is not
2788 ;; appropriate either, because ssh and companions might
2789 ;; use a user name from the config file.
2801 ;; There might be a double slash, for example when "~/"
2802 ;; expands to "/". Remove this.
2805 ;; No tilde characters in file name, do normal
2806 ;; `expand-file-name' (this does "/./" and "/../"). We bind
2807 ;; `directory-sep-char' here for XEmacs on Windows, which would
2808 ;; otherwise use backslash. `default-directory' is bound,
2809 ;; because on Windows there would be problems with UNC shares or
2810 ;; Cygwin mounts.
2814 method user host
2818 hop)))))
2820 ;;; Remote commands:
2823 "Flush file caches."
2831 ;; We use BUFFER also as connection buffer during setup. Because of
2832 ;; this, its original contents must be saved, and restored once
2833 ;; connection has been setup.
2835 "Like `start-file-process' for Tramp files."
2838 ;; it might be that the arguments exceed the command line
2839 ;; length. Therefore, we modify the command.
2844 ;; When PROGRAM is nil, we just provide a tty.
2850 args
2854 ;; Use a human-friendly prompt, for example for `shell'.
2858 tramp-initial-end-of-output)))
2859 ;; We use as environment the difference to toplevel
2860 ;; `process-environment'.
2861 env
2866 env)
2885 ;; We do not want to raise an error when
2886 ;; `start-file-process' has been started several time in
2887 ;; `eshell' and friends.
2891 ;; BUFFER can be nil. We use a temporary buffer.
2894 ;; NAME must be unique as process name.
2898 ;; Set the new process properties.
2904 ;; We catch this event. Otherwise, `start-process' could
2905 ;; be called on the local host.
2908 ;; Activate narrowing in order to save BUFFER
2909 ;; contents. Clear also the modification time;
2910 ;; otherwise we might be interrupted by
2911 ;; `verify-visited-file-modtime'.
2917 ;; We call `tramp-maybe-open-connection', in order
2918 ;; to cleanup the prompt afterwards.
2924 ;; Now do it.
2926 ;; Send the command.
2928 ;; Check, whether a pty is associated.
2932 v 'file-error
2935 ;; Set query flag and process marker for this
2936 ;; process. We ignore errors, because the process
2937 ;; could have finished already.
2941 ;; Return process.
2942 p))))
2944 ;; Save exit.
2955 "Like `process-file' for Tramp files."
2956 ;; The implementation is not complete yet.
2962 ;; Compute command.
2965 ;; We use as environment the difference to toplevel `process-environment'.
2973 "env %s %s"
2975 ;; Determine input.
2980 ;; INFILE is on the same remote host.
2982 ;; INFILE must be copied to remote host.
2988 ;; Determine output.
2990 ;; Just a buffer.
2993 ;; A buffer name.
2996 ;; (REAL-DESTINATION ERROR-DESTINATION)
2998 ;; output.
3006 ;; stderr.
3011 ;; stderr is on the same remote host.
3014 ;; stderr must be copied to remote host. The temporary
3015 ;; file must be deleted after execution.
3018 method user host stderr))))
3019 ;; stderr to be discarded.
3022 ;; 't
3027 ;; Send the command. It might not return in time, so we protect
3028 ;; it. Call it in a subshell, in order to preserve working
3029 ;; directory.
3036 command)
3037 t t)
3039 ;; We should add the output anyway.
3046 ;; When the user did interrupt, we should do it also. We use
3047 ;; return code -1 as marker.
3051 ;; Handle errors.
3056 ;; Provide error file.
3059 ;; Cleanup. We remove all file cache values for the connection,
3060 ;; because the remote process could have changed them.
3063 ;; `process-file-side-effects' has been introduced with GNU
3064 ;; Emacs 23.2. If set to `nil', no remote file will be changed
3065 ;; by `program'. If it doesn't exist, we assume its default
3066 ;; value `t'.
3071 ;; Return exit status.
3074 ret))))
3077 "Like `file-local-copy' for Tramp files."
3081 v 'file-error
3091 ;; `copy-file' handles direct copy and out-of-band methods.
3096 ;; Use inline encoding for file transfer.
3100 v 3
3108 tmpfile loc-dec)
3110 ;; If local decoding is a function, we call it.
3111 ;; We must disable multibyte, because
3112 ;; `uudecode-decode-region' doesn't handle it
3113 ;; correctly.
3118 ;; Unset `file-name-handler-alist'. Otherwise,
3119 ;; epa-file gets confused.
3125 ;; If tramp-decoding-function is not defined for this
3126 ;; method, we invoke tramp-decoding-command instead.
3128 ;; Unset `file-name-handler-alist'. Otherwise,
3129 ;; epa-file gets confused.
3137 loc-dec tmpfile2 tmpfile)
3140 ;; Set proper permissions.
3142 ;; Set local user ownership.
3145 ;; Oops, I don't know what to do.
3149 ;; Error handling.
3155 tmpfile)))
3157 ;; This is needed for XEmacs only. Code stolen from files.el.
3160 "Like `insert-file-contents-literally' for Tramp files."
3168 nil))
3175 ;; Save exit.
3180 ;; CCC grok LOCKNAME
3183 "Like `write-region' for Tramp files."
3186 ;; Following part commented out because we don't know what to do about
3187 ;; file locking, and it does not appear to be a problem to ignore it.
3188 ;; Ange-ftp ignores it, too.
3189 ;; (when (and lockname (stringp lockname))
3190 ;; (setq lockname (expand-file-name lockname)))
3191 ;; (unless (or (eq lockname nil)
3192 ;; (string= lockname filename))
3193 ;; (error
3194 ;; "tramp-sh-handle-write-region: LOCKNAME must be nil or equal FILENAME"))
3196 ;; XEmacs takes a coding system as the seventh argument, not `confirm'.
3207 ;; `file-writable-p' calls `file-expand-file-name'. We
3208 ;; cannot use `tramp-run-real-handler' therefore.
3214 ;; Short track: if we are on the local host, we can run directly.
3216 'write-region
3220 ;; We use this to save the value of
3221 ;; `last-coding-system-used' after writing the tmp
3222 ;; file. At the end of the function, we set
3223 ;; `last-coding-system-used' to this saved value. This
3224 ;; way, any intermediary coding systems used while
3225 ;; talking to the remote shell or suchlike won't hose
3226 ;; this variable. This approach was snarfed from
3227 ;; ange-ftp.el.
3228 coding-system-used
3229 ;; Write region into a tmp file. This isn't really
3230 ;; needed if we use an encoding function, but currently
3231 ;; we use it always because this makes the logic
3232 ;; simpler. We must also set `temporary-file-directory',
3233 ;; because it could point to a remote directory.
3239 ;; If `append' is non-nil, we copy the file locally, and let
3240 ;; the native `write-region' implementation do the job.
3243 ;; We say `no-message' here because we don't want the
3244 ;; visited file modtime data to be clobbered from the temp
3245 ;; file. We call `set-visited-file-modtime' ourselves later
3246 ;; on. We must ensure that `file-coding-system-alist'
3247 ;; matches `tmpfile'.
3253 'write-region
3260 ;; Now, `last-coding-system-used' has the right value. Remember it.
3265 ;; The permissions of the temporary file should be set. If
3266 ;; FILENAME does not exist (eq modes nil) it has been
3267 ;; renamed to the backup file. This case `save-buffer'
3268 ;; handles permissions.
3269 ;; Ensure that it is still readable.
3272 tmpfile
3275 ;; This is a bit lengthy due to the different methods
3276 ;; possible for file transfer. First, we check whether the
3277 ;; method uses an scp program. If so, we call it.
3278 ;; Otherwise, both encoding and decoding command must be
3279 ;; specified. However, if the method _also_ specifies an
3280 ;; encoding function, then that is used for encoding the
3281 ;; contents of the tmp file.
3286 ;; `copy-file' handles direct copy and out-of-band methods.
3297 ;; We keep the local file for performance
3298 ;; reasons, useful for "rsync".
3305 ;; Don't rename, in order to keep context in SELinux.
3310 ;; Use inline file transfer.
3312 ;; Encode tmpfile.
3316 ;; Use encoding function or command.
3319 tmpfile loc-enc)
3321 ;; The following `let' is a workaround for
3322 ;; the base64.el that comes with pgnus-0.84.
3323 ;; If both of the following conditions are
3324 ;; satisfied, it tries to write to a local
3325 ;; file in default-directory, but at this
3326 ;; point, default-directory is remote.
3327 ;; (`call-process-region' can't write to
3328 ;; remote files, it seems.) The file in
3329 ;; question is a tmp file anyway.
3337 loc-enc tmpfile t))
3339 v 'file-error
3342 filename loc-enc))))
3344 ;; Send buffer into remote decoding command which
3345 ;; writes to remote file. Because this happens on
3346 ;; the remote host, we cannot use the function.
3349 filename rem-dec)
3353 v
3357 tramp-end-of-heredoc
3359 tramp-end-of-heredoc))
3361 v nil
3362 "Couldn't write region to `%s', decode using `%s' failed"
3363 filename rem-dec)
3364 ;; When `file-precious-flag' is set, the region is
3365 ;; written to a temporary file. Check that the
3366 ;; checksum is equal to that from the local tmpfile.
3370 ;; cksum runs locally, if possible.
3372 ;; cksum runs remotely.
3374 v
3377 ;; ... they are different.
3384 v 'file-error
3387 filename rem-dec)))))
3389 ;; Save exit.
3392 ;; That's not expected.
3395 v 'file-error
3398 method))))
3400 ;; Make `last-coding-system-used' have the right value.
3407 ;; We must protect `last-coding-system-used', now we have set it
3408 ;; to its correct value.
3410 ;; Set file modification time.
3414 ;; We must pass modtime explicitly, because FILENAME can
3415 ;; be different from (buffer-file-name), f.e. if
3416 ;; `file-precious-flag' is set.
3422 ;; Set the ownership.
3432 ;; VC backends check for the existence of various different special
3433 ;; files. This is very time consuming, because every single check
3434 ;; requires a remote command (the file cache must be invalidated).
3435 ;; Therefore, we apply a kind of optimization. We install the file
3436 ;; name handler `tramp-vc-file-name-handler', which does nothing but
3437 ;; remembers all file names for which `file-exists-p' or
3438 ;; `file-readable-p' has been applied. A first run of `vc-registered'
3439 ;; is performed. Afterwards, a script is applied for all collected
3440 ;; file names, using just one remote command. The result of this
3441 ;; script is used to fill the file cache with actual values. Now we
3442 ;; can reset the file name handlers, and we make a second run of
3443 ;; `vc-registered', which returns the expected result without sending
3444 ;; any other remote command.
3446 "Like `vc-registered' for Tramp files."
3452 ;; There could be new files, created by the vc backend. We
3453 ;; cannot reuse the old cache entries, therefore. In
3454 ;; `tramp-get-file-property', `remote-file-name-inhibit-cache'
3455 ;; could also be a timestamp as `current-time' returns. This
3456 ;; means invalidate all cache entries with an older timestamp.
3462 ;; Here we collect only file names, which need an operation.
3466 ;; Send just one command, in order to fill the cache.
3469 v
3478 ;; We cannot use `tramp-send-command-and-read',
3479 ;; because this does not cooperate well with
3480 ;; heredoc documents.
3482 v
3485 tramp-end-of-heredoc
3487 tramp-vc-registered-file-names
3489 tramp-end-of-heredoc))
3491 ;; Read the expression.
3498 ;; Second run. Now all `file-exists-p' or `file-readable-p'
3499 ;; calls shall be answered from the file cache. We unset
3500 ;; `process-file-side-effects' and `remote-file-name-inhibit-cache'
3501 ;; in order to keep the cache.
3503 remote-file-name-inhibit-cache process-file-side-effects)
3504 ;; Reduce `vc-handled-backends' in order to minimize process calls.
3523 ;; Run.
3527 ;;;###tramp-autoload
3529 "Invoke remote-shell Tramp file name handler.
3530 Fall back to normal file name handler if no Tramp handler exists."
3548 "Invoke special file name handler, which collects files to be handled."
3556 ;; That's what we want: file names, for which checks are
3557 ;; applied. We assume that VC uses only `file-exists-p' and
3558 ;; `file-readable-p' checks; otherwise we must extend the
3559 ;; list. We do not perform any action, but return nil, in
3560 ;; order to keep `vc-registered' running.
3563 nil)
3564 ;; `process-file' and `start-file-process' shall be ignored.
3567 ;; Tramp file name handlers like `expand-file-name'. They
3568 ;; must still work.
3570 ;; Default file name handlers, we don't care.
3574 "Like `file-notify-add-watch' for Tramp files."
3578 command events filter p sequence)
3580 ;; gvfs-monitor-dir.
3584 ;; inotifywait.
3587 events
3594 ;; None.
3596 v 'file-notify-error
3597 "No file notification program found on %s"
3599 ;; Start process.
3601 'start-file-process
3605 sequence))
3606 ;; Return the process object as watch-descriptor.
3609 v 'file-notify-error
3610 "`%s' failed to start on remote host"
3616 p))))
3628 ;; Attribute change is returned in unused wording.
3638 string)
3641 proc
3645 ;; File names are returned as absolute paths. We must
3646 ;; add the remote prefix.
3651 ;; Usually, we would add an Emacs event now. Unfortunately,
3652 ;; `unread-command-events' does not accept several events at
3653 ;; once. Therefore, we apply the callback directly.
3656 ;; Save rest of the string.
3665 ;; Check, whether there is a problem.
3671 line)
3676 proc
3683 ;; Usually, we would add an Emacs event now. Unfortunately,
3684 ;; `unread-command-events' does not accept several events at
3685 ;; once. Therefore, we apply the callback directly.
3688 ;;; Internal Functions:
3691 "Define in remote shell function NAME implemented as SCRIPT.
3692 Only send the definition if it has not already been done."
3693 ;; We cannot let-bind (tramp-get-connection-process vec) because it
3694 ;; might be nil.
3699 ;; The script could contain a call of Perl. This is masked with `%s'.
3704 vec
3715 auto-save-default)
3723 "Run `test' on the remote system, given a SWITCH and a FILENAME.
3724 Returns the exit code of the `test' program."
3727 v
3729 "%s %s %s"
3731 switch
3735 "Run `test'-like program on the remote system, given FILE1, FILE2.
3736 FORMAT-STRING contains the program name, switches, and place holders.
3737 Returns the exit code of the `test' program. Barfs if the methods,
3738 hosts, or files, disagree."
3742 v 'file-error
3747 v1
3754 "Searches for PROGNAME in $PATH and all directories mentioned in DIRLIST.
3755 First arg VEC specifies the connection, PROGNAME is the program
3756 to search for, and DIRLIST gives the list of directories to
3757 search. If IGNORE-TILDE is non-nil, directory names starting
3758 with `~' will be ignored. If IGNORE-PATH is non-nil, searches
3759 only in DIRLIST.
3761 Returns the absolute file name of PROGNAME, if found, and nil otherwise.
3763 This function expects to be in the right *tramp* buffer."
3766 ;; Check whether the executable is in $PATH. "which(1)" does not
3767 ;; report always a correct error code; therefore we check the
3768 ;; number of words it returns. "SunOS 5.10" (and maybe "SunOS
3769 ;; 5.11") have problems with this command, we disable the call
3770 ;; therefore.
3781 ;; Remove all ~/foo directories from dirlist. In XEmacs,
3782 ;; `remove' is in CL, and we want to avoid CL dependencies.
3791 vec
3793 "do if test -x $d/%s -a -f $d/%s; "
3794 "then echo tramp_executable $d/%s; "
3797 progname progname progname
3798 tramp-end-of-heredoc
3800 tramp-end-of-heredoc))
3806 result)))
3809 "Sets the remote environment PATH to existing directories.
3810 I.e., for each directory in `tramp-remote-path', it is tested
3811 whether it exists and if so, it is added to the environment
3812 variable PATH."
3818 ;; ------------------------------------------------------------
3819 ;; -- Communication with external shell --
3820 ;; ------------------------------------------------------------
3823 "Find a command on the remote host for checking if a file exists.
3824 Here, we are looking for a command which has zero exit status if the
3825 file exists and nonzero exit status otherwise."
3829 result)
3830 ;; The algorithm is as follows: we try a list of several commands.
3831 ;; For each command, we first run `$cmd /' -- this should return
3832 ;; true, as the root directory always exists. And then we run
3833 ;; `$cmd /this\ file\ does\ not\ exist ', hoping that the file indeed
3834 ;; does not exist. This should return false. We use the first
3835 ;; command we find that seems to work.
3836 ;; The list of commands to try is as follows:
3837 ;; `ls -d' This works on most systems, but NetBSD 1.4
3838 ;; has a bug: `ls' always returns zero exit
3839 ;; status, even for files which don't exist.
3840 ;; `test -e' Some Bourne shells have a `test' builtin
3841 ;; which does not know the `-e' option.
3842 ;; `/bin/test -e' For those, the `test' binary on disk normally
3843 ;; provides the option. Alas, the binary
3844 ;; is sometimes `/bin/test' and sometimes it's
3845 ;; `/usr/bin/test'.
3846 ;; `/usr/bin/test -e' In case `/bin/test' does not exist.
3874 result))
3877 "Opens shell SHELL."
3880 ;; Find arguments for this shell.
3882 item extra-args)
3887 ;; It is useful to set the prompt in the following command
3888 ;; because some people have a setting for $PS1 which /bin/sh
3889 ;; doesn't know about and thus /bin/sh will display a strange
3890 ;; prompt. For example, if $PS1 has "${CWD}" in the value, then
3891 ;; ksh will display the current working directory but /bin/sh
3892 ;; will display a dollar sign. The following command line sets
3893 ;; $PS1 to a sane value, and works under Bourne-ish shells as
3894 ;; well as csh-like shells. We also unset the variable $ENV
3895 ;; because that is read by some sh implementations (eg, bash
3896 ;; when called as sh) on startup; this way, we avoid the startup
3897 ;; file clobbering $PS1. $PROMPT_COMMAND is another way to set
3898 ;; the prompt in /bin/bash, it must be discarded as well.
3901 "exec env ENV=''%s PROMPT_COMMAND='' PS1=%s PS2='' PS3='' %s %s"
3907 t))
3912 "Opens a shell on the remote host which groks tilde expansion."
3920 shell)
3923 ;; CCC: "root" does not exist always, see QNAP 459.
3924 ;; Which check could we apply instead?
3927 ;; The default shell (ksh93) of OpenSolaris and
3928 ;; Solaris is buggy. We've got reports for
3929 ;; "SunOS 5.10" and "SunOS 5.11" so far.
3938 ;; Maybe it works at least for some other commands.
3940 default-shell
3942 vec 2
3944 "Couldn't find a remote shell which groks tilde "
3946 default-shell)))
3948 default-shell)))
3950 ;; Open a new shell if needed.
3956 ;; Utility functions.
3959 "Wait for shell prompt and barf if none appears.
3960 Looks at process PROC to see if a shell prompt appears in TIMEOUT
3961 seconds. If not, it produces an error message with the given ERROR-ARGS."
3965 proc timeout
3974 "Set up an interactive shell.
3975 Mainly sets the prompt and the echo correctly. PROC is the shell
3976 process to set up. VEC specifies the connection."
3979 vec
3984 ;; Disable echo.
3987 ;; Check whether the echo has really been disabled. Some
3988 ;; implementations, like busybox of embedded GNU/Linux, don't
3989 ;; support disabling.
3996 ;; Make sure backspaces and their echo are enabled and no line
3997 ;; width magic interferes with them.
4005 ;; Try to set up the coding system correctly.
4006 ;; CCC this can't be the right way to do it. Hm.
4010 ;; Use MULE to select the right EOL convention for communicating
4011 ;; with the process.
4017 cs-decode cs-encode)
4034 ;; Look for ^M and do something useful if found.
4036 ;; We have found a ^M but cannot frob the process coding system
4037 ;; because we're running on a non-MULE Emacs. Let's try
4038 ;; stty, instead.
4043 ;; Check whether the output of "uname -sr" has been changed. If
4044 ;; yes, this is a strong indication that we must expire all
4045 ;; connection properties. We start again with
4046 ;; `tramp-maybe-open-connection', it will be caught there.
4051 vec "uname"
4055 vec 3
4056 "Connection reset, because remote host changed from `%s' to `%s'"
4057 old-uname new-uname)
4058 ;; We want to keep the password.
4062 ;; Check whether the remote host suffers from buggy
4063 ;; `send-process-string'. This is known for FreeBSD (see comment in
4064 ;; `send_process', file process.c). I've tested sending 624 bytes
4065 ;; successfully, sending 625 bytes failed. Emacs makes a hack when
4066 ;; this host type is detected locally. It cannot handle remote
4067 ;; hosts, though.
4071 tramp-chunksize)
4079 ;; Set remote PATH variable.
4082 ;; Search for a good shell before searching for a command which
4083 ;; checks if a file exists. This is done because Tramp wants to use
4084 ;; "test foo; echo $?" to check if various conditions hold, and
4085 ;; there are buggy /bin/sh implementations which don't execute the
4086 ;; "echo $?" part if the "test" part has an error. In particular,
4087 ;; the OpenSolaris /bin/sh is a problem. There are also other
4088 ;; problems with /bin/sh of OpenSolaris, like redirection of stderr
4089 ;; in function declarations, or changing HISTFILE in place.
4090 ;; Therefore, OpenSolaris' /bin/sh is replaced by bash, when
4091 ;; detected.
4094 ;; Disable unexpected output.
4097 ;; IRIX64 bash expands "!" even when in single quotes. This
4098 ;; destroys our shell functions, we must disable it. See
4099 ;; <http://stackoverflow.com/questions/3291692/irix-bash-shell-expands-expression-in-single-quotes-yet-shouldnt>.
4103 ;; On BSD-like systems, ?\t is expanded to spaces. Suppress this.
4108 ;; Set `remote-tty' process property.
4113 ;; Dump stty settings in the traces.
4117 ;; Set the environment.
4122 unset vars item)
4132 vec
4134 tramp-end-of-heredoc
4136 tramp-end-of-heredoc)
4137 t))
4142 ;; Old text from documentation of tramp-methods:
4143 ;; Using a uuencode/uudecode inline method is discouraged, please use one
4144 ;; of the base64 methods instead since base64 encoding is much more
4145 ;; reliable and the commands are more standardized between the different
4146 ;; Unix versions. But if you can't use base64 for some reason, please
4147 ;; note that the default uudecode command does not work well for some
4148 ;; Unices, in particular AIX and Irix. For AIX, you might want to use
4149 ;; the following command for uudecode:
4150 ;;
4151 ;; sed '/^begin/d;/^[` ]$/d;/^end/d' | iconv -f uucode -t ISO8859-1
4152 ;;
4153 ;; For Irix, no solution is known yet.
4161 "List of local coding commands for inline transfer.
4162 Each item is a list that looks like this:
4164 \(FORMAT ENCODING DECODING\)
4166 FORMAT is symbol describing the encoding/decoding format. It can be
4167 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4169 ENCODING and DECODING can be strings, giving commands, or symbols,
4170 giving functions. If they are strings, then they can contain
4172 file name will be put into the command line at that spot. If the
4173 specifier is not present, the input should be read from standard
4174 input.
4176 If they are functions, they will be called with two arguments, start
4177 and end of region, and are expected to replace the region contents
4182 ;; "-i" is more robust with older base64 from GNU coreutils.
4183 ;; However, I don't know whether all base64 versions do supports
4184 ;; this option.
4196 "List of remote coding commands for inline transfer.
4197 Each item is a list that looks like this:
4199 \(FORMAT ENCODING DECODING [TEST]\)
4201 FORMAT is a symbol describing the encoding/decoding format. It can be
4202 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
4204 ENCODING and DECODING can be strings, giving commands, or symbols,
4205 giving variables. If they are strings, then they can contain
4207 file name will be put into the command line at that spot. If the
4208 specifier is not present, the input should be read from standard
4209 input.
4211 If they are variables, this variable is a string containing a
4212 Perl or Shell implementation for this functionality. This
4213 program will be transferred to the remote host, and it is
4215 specifier in the variable value denotes a temporary file.
4217 The optional TEST command can be used for further tests, whether
4221 "Find an inline transfer encoding that works.
4222 Goes through the list `tramp-local-coding-commands' and
4223 `tramp-remote-coding-commands'."
4228 loc-enc loc-dec rem-enc rem-dec rem-test litem ritem found)
4236 ;; If the local encoder or decoder is a string, the
4237 ;; corresponding command has to work locally.
4244 loc-enc nil nil))
4252 loc-dec nil nil))
4254 ;; Search for remote coding commands with the same format
4262 ;; Check the remote test command if exists.
4268 ;; Check if remote perl exists when necessary.
4272 ;; Check if remote encoding and decoding commands can be
4273 ;; called remotely with null input and output. This makes
4274 ;; sure there are no syntax errors and the command is really
4275 ;; found. Note that we do not redirect stdout to /dev/null,
4276 ;; for two reasons: when checking the decoding command, we
4277 ;; actually check the output it gives. And also, when
4278 ;; redirecting "mimencode" output to /dev/null, then as root
4279 ;; it might change the permissions of /dev/null!
4287 vec 5
4296 tmpfile)
4303 tramp-temp-name-prefix
4305 value
4307 value
4309 ?t
4315 vec 5
4318 vec
4320 t)
4328 ;; `rem-enc' and `rem-dec' could be a string meanwhile.
4334 ;; Set connection properties. Since the commands are risky
4335 ;; (due to output direction), we cache them in the process cache.
4346 "Call the local encoding or decoding command.
4348 Otherwise, INPUT is passed via standard input.
4349 INPUT can also be nil which means `/dev/null'.
4350 OUTPUT can be a string (which specifies a file name), or t (which
4351 means standard output and thus the current buffer), or nil (which
4352 means discard it)."
4354 nil tramp-encoding-shell
4357 nil
4358 tramp-encoding-command-switch
4368 "List of compress and decompress commands for inline transfer.
4369 Each item is a list that looks like this:
4371 \(COMPRESS DECOMPRESS\)
4376 "Find an inline transfer compress command that works.
4377 Goes through the list `tramp-inline-compress-commands'."
4382 item compress decompress found)
4389 vec 5
4390 "Checking local compress commands `%s', `%s' for sanity"
4391 compress decompress)
4396 ;; Windows shells need the program file name after
4397 ;; the pipe symbol be quoted if they use forward
4398 ;; slashes as directory separators.
4405 vec 5
4406 "Checking remote compress commands `%s', `%s' for sanity"
4407 compress decompress)
4413 ;; Did we find something?
4416 ;; Set connection properties. Since the commands are
4417 ;; risky (due to output direction), we cache them in the
4418 ;; process cache.
4432 "Expands VEC according to `tramp-default-proxies-alist'.
4433 Gateway hops are already opened."
4437 choices proxy)
4439 ;; Ad-hoc proxy definitions.
4444 tramp-prefix-format proxy tramp-postfix-host-format)))
4449 proxy)
4450 ;; Add the hop.
4452 'tramp-default-proxies-alist
4455 proxy))
4457 ;; Save the new value.
4462 ;; Look for proxy hosts to be passed.
4468 ;; Host.
4471 ;; User.
4475 ;; No more hops needed.
4477 ;; Replace placeholders.
4480 proxy
4485 ;; Add the hop.
4487 ;; Start next search.
4490 ;; Handle gateways.
4498 ;; Is the method prepared for gateways?
4501 vec 'file-error
4503 ;; Open the gateway connection.
4508 target-alist)
4509 ;; For the password prompt, we need the correct values.
4510 ;; Therefore, we must remember the gateway vector. But we
4511 ;; cannot do it as connection property, because it shouldn't
4512 ;; be persistent. And we have no started process yet either.
4515 ;; Foreign and out-of-band methods are not supported for multi-hops.
4528 vec 'file-error
4529 "Method `%s' is not supported for multi-hops."
4532 ;; In case the host name is not used for the remote shell
4533 ;; command, the user could be misguided by applying a random
4534 ;; hostname.
4540 ;; There are multi-hops.
4542 ;; The host name is used for the remote shell command.
4545 ;; The host is local. We cannot use `tramp-local-host-p'
4546 ;; here, because it opens a connection as well.
4549 v 'file-error
4550 "Host `%s' looks like a remote host, `%s' can only use the local host"
4551 host method)))
4553 ;; Result.
4554 target-alist))
4557 "Maybe open a connection VEC.
4558 Does not do anything if a connection is already open, but re-opens the
4559 connection if a previous connection has died for some reason."
4567 ;; If Tramp opens the same connection within a short time frame,
4568 ;; there is a problem. We shall signal this.
4577 ;; If too much time has passed since last command was sent, look
4578 ;; whether process is still alive. If it isn't, kill it. When
4579 ;; using ssh, it can sometimes happen that the remote end has hung
4580 ;; up but the local ssh client doesn't recognize this until it
4581 ;; tries to send some data to the remote end. So that's why we
4582 ;; try to send a command from time to time, then look again
4583 ;; whether the process is really alive.
4594 ;; The error will be caught locally.
4600 ;; New connection must be opened.
4604 ;; If `non-essential' is non-nil, don't reopen a new connection.
4609 vec 3
4620 ;; Start new process.
4630 ;; We will apply `tramp-ssh-controlmaster-options'
4631 ;; only for the first hop.
4637 ;; This must be done in order to avoid our file
4638 ;; name handler.
4642 'start-process
4647 tramp-encoding-command-interactive)
4650 ;; Set sentinel and query flag.
4661 ;; Check whether process is alive.
4663 p 10
4666 ;; Now do all the connections as specified.
4695 ;; We don't create the temporary file. In
4696 ;; fact, it is just a prefix for the
4697 ;; ControlPath option of ssh; the real
4698 ;; temporary file has another name, and it is
4699 ;; created and protected by ssh. It is also
4700 ;; removed by ssh when the connection is
4701 ;; closed. The temporary file name is cached
4702 ;; in the main connection process, therefore
4703 ;; we cannot use `tramp-get-connection-process'.
4709 tramp-temp-name-prefix
4711 spec r-shell)
4713 ;; Add arguments for asynchronous processes.
4717 ;; Add gateway arguments if necessary.
4721 ;; Check for port number. Until now, there's no
4722 ;; need for handling like method, user, host.
4727 ;; Check, whether there is a restricted shell.
4732 ;; Set variables for computing the prompt for
4733 ;; reading password. They can also be derived
4734 ;; from a gateway.
4739 ;; Add login environment.
4742 login-env
4747 login-env))
4751 "%s=%s %s"
4754 command)))
4757 ;; Replace `login-args' place holders.
4765 ?h l-host ?u l-user ?p l-port ?c options)
4766 command
4768 ;; We do not want to see the trailing local
4769 ;; prompt in `start-file-process'.
4771 command " "
4777 ;; Local shell could be a Windows COMSPEC. It
4778 ;; doesn't know the ";" syntax, but we must exit
4779 ;; always for `start-file-process'. It could
4780 ;; also be a restricted shell, which does not
4781 ;; allow "exec".
4784 ;; Send the command.
4788 p vec pos tramp-actions-before-shell
4792 ;; Next hop.
4796 ;; Make initial shell settings.
4799 ;; When the user did interrupt, we must cleanup.
4802 ;; Propagate the quit signal.
4806 "Send the COMMAND to connection VEC.
4807 Erases temporary buffer before sending the command. If optional
4808 arg NEVEROPEN is non-nil, never try to open the connection. This
4809 is meant to be used from `tramp-maybe-open-connection' only. The
4810 function waits for output unless NOOUTPUT is set."
4814 ;; We mark the command string that it can be erased in the output buffer.
4816 ;; If we put `tramp-echo-mark' after a trailing newline (which
4817 ;; is assumed to be unquoted) `tramp-send-string' doesn't see
4818 ;; that newline and adds `tramp-rsh-end-of-line' right after
4819 ;; `tramp-echo-mark', so the remote shell sees two consecutive
4820 ;; trailing line endings and sends two prompts after executing
4821 ;; the command, which confuses `tramp-wait-for-output'.
4825 ;; No need to restore a trailing newline here since `tramp-send-string'
4826 ;; makes sure that the string ends in `tramp-rsh-end-of-line', anyway.
4828 ;; Send the command.
4834 "Wait for output from remote command."
4840 ;; be leading escape sequences, which must be ignored.
4842 ;; Sometimes, the commands do not return a newline but a
4843 ;; null byte before the shell prompt, for example "git
4844 ;; ls-files -c -z ...".
4849 ;; A simple-minded busybox has sent " ^H" sequences.
4850 ;; Delete them.
4855 ;; Delete the prompt.
4861 proc 'file-error
4862 "[[Remote prompt `%s' not found in %d secs]]"
4863 tramp-end-of-output timeout)
4865 proc 'file-error
4867 ;; Return value is whether end-of-output sentinel was found.
4868 found)))
4872 "Run COMMAND and check its exit status.
4873 Sends `echo $?' along with the COMMAND for checking the exit status.
4874 If COMMAND is nil, just sends `echo $?'. Returns `t' if the exit
4875 status is 0, and `nil' otherwise.
4877 If the optional argument SUBSHELL is non-nil, the command is
4878 executed in a subshell, ie surrounded by parentheses. If
4879 DONT-SUPPRESS-ERR is non-nil, stderr won't be sent to /dev/null."
4881 vec
4883 command
4885 "echo tramp_exit_status $?"
4899 "Run COMMAND, check exit status, throw error if exit status not okay.
4900 Similar to `tramp-send-command-and-check' but accepts two more arguments
4901 FMT and ARGS which are passed to `error'."
4906 "Run COMMAND and return the output, which must be a Lisp expression.
4907 In case there is no valid Lisp expression and NOERROR is nil, it
4908 raises an error."
4914 ;; Read the expression.
4918 ;; Error handling.
4923 vec 'file-error
4924 "`%s' does not return a valid Lisp expression: `%s'"
4928 "Convert `file-attributes' ATTR generated by perl script, stat or ls.
4929 Convert file mode bits to string and set virtual device number.
4930 Return ATTR."
4932 ;; Remove color escape sequences from symlink.
4936 ;; Convert uid and gid. Use -1 as indication of unusable value.
4947 ;; Convert last access time.
4952 ;; Convert last modification time.
4957 ;; Convert last status change time.
4962 ;; Convert file size.
4968 ;; Convert file mode bits to string.
4973 ;; Convert directory indication bit.
4976 ;; Convert symlink from `tramp-do-file-attributes-with-stat'.
4982 ;; Set file's gid change bit.
4990 ;; Convert inode.
4996 ;; Inodes can be incredible huge. We must hide this.
4998 ;; Set virtual device number.
5001 attr))
5004 "Converts STRING to shell glob pattern which ignores case."
5010 string
5014 "Create a file name suitable to be passed to `scp' or `nc' and workalikes."
5022 localname)
5028 "Return t if this is an out-of-band method, nil otherwise."
5030 ;; It shall be an out-of-band method.
5032 ;; There must be a size, otherwise the file doesn't exist.
5034 ;; Either the file size is large enough, or (in rare cases) there
5035 ;; does not exist a remote encoding.
5040 ;; Variables local to connection.
5044 ;; When `tramp-own-remote-path' is in `tramp-remote-path', we
5045 ;; cache the result for the session only. Otherwise, the result
5046 ;; is cached persistently.
5049 vec)
5050 "remote-path"
5059 ;; Default if "getconf" is not available.
5062 vec 3
5067 ;; We cannot apply `tramp-send-command-and-read' because
5068 ;; the login shell could return more than just the $PATH
5069 ;; string. So we emulate that function.
5072 vec
5078 'identity
5087 ;; Replace place holder `tramp-default-remote-path'.
5095 ;; Replace place holder `tramp-own-remote-path'.
5103 ;; Remove double entries.
5110 ;; Remove non-existing directories.
5112 nil
5122 x))
5123 x))
5124 remote-path)))))
5130 locale)
5136 candidates nil)
5138 ;; Return value.
5148 result)
5150 ;; Check parameters. On busybox, "ls" output coloring is
5151 ;; enabled by default sometimes. So we try to disable it
5152 ;; when possible. $LS_COLORING is not supported there.
5153 ;; Some "ls" versions are sensible wrt the order of
5154 ;; arguments, they fail when "-al" is after the
5155 ;; "--color=never" argument (for example on FreeBSD).
5170 ;; Some "ls" versions are sensible wrt the order of arguments,
5171 ;; they fail when "-al" is after the "--dired" argument (for
5172 ;; example on FreeBSD).
5180 "test"
5184 ;; Does `test A -nt B' work? Use abominable `find' construct if it
5185 ;; doesn't. BSD/OS 4.0 wants the parentheses around the command,
5186 ;; for otherwise the shell crashes.
5198 vec
5221 ;; We must check also for some Perl modules.
5229 result)))
5236 tmp)
5237 ;; Check whether stat(1) returns usable syntax. "%s" does not
5238 ;; work on older AIX systems.
5247 result)))
5257 result))))
5273 ;; Busyboxes do support the "-t" option only when they have been
5274 ;; built with the DESKTOP config option. Let's check it.
5277 vec "touch-t"
5279 vec
5281 "%s -t %s %s"
5282 result
5286 result)))
5305 result)
5307 ;; Check POSIX parameter.
5314 vec
5323 vec
5327 "print $>"
5339 vec
5343 "import os; print (os.getuid())"
5357 ;; Ensure there is a valid result.
5365 vec
5374 vec
5383 vec
5387 "import os; print (os.getgid())"
5401 ;; Ensure there is a valid result.
5407 ;; Some predefined connection properties.
5409 "Return the compress command related to PROP.
5410 PROP is either `inline-compress' or `inline-decompress'. SIZE is
5411 the length of the file to be compressed.
5413 If no corresponding command is found, nil is returned."
5422 "Return the coding command related to PROP.
5423 PROP is either `remote-encoding', `remote-decoding',
5424 `local-encoding' or `local-decoding'.
5426 SIZE is the length of the file to be coded. Depending on SIZE,
5427 compression might be applied.
5429 If no corresponding command is found, nil is returned.
5430 Otherwise, either a string is returned which contains a `%s' mark
5431 to be used for the respective input or output file; or a Lisp
5432 function cell is returned to be applied on a buffer."
5433 ;; We must catch the errors, because we want to return `nil', when
5434 ;; no inline coding is found.
5444 compress)
5445 ;; The connection property might have been cached. So we must
5446 ;; send the script to the remote side - maybe.
5454 ;; Check for the `compress' command.
5456 ;; Return the value.
5472 'call-process-region beg end
5477 coding)
5480 ;; Windows shells need the program file name after
5481 ;; the pipe symbol be quoted if they use forward
5482 ;; slashes as directory separators.
5489 coding compress))
5492 ;; Windows shells need the program file name after
5493 ;; the pipe symbol be quoted if they use forward
5494 ;; slashes as directory separators.
5499 compress coding))
5513 ;;; TODO:
5515 ;; * Don't use globbing for directories with many files, as this is
5516 ;; likely to produce long command lines, and some shells choke on
5517 ;; long command lines.
5518 ;; * Make it work for different encodings, and for different file name
5519 ;; encodings, too. (Daniel Pittman)
5520 ;; * Don't search for perl5 and perl. Instead, only search for perl and
5521 ;; then look if it's the right version (with `perl -v').
5522 ;; * When editing a remote CVS controlled file as a different user, VC
5523 ;; gets confused about the file locking status. Try to find out why
5524 ;; the workaround doesn't work.
5525 ;; * Allow out-of-band methods as _last_ multi-hop. Open a connection
5526 ;; until the last but one hop via `start-file-process'. Apply it
5527 ;; also for ftp and smb.
5528 ;; * WIBNI if we had a command "trampclient"? If I was editing in
5529 ;; some shell with root privileges, it would be nice if I could
5530 ;; just call
5531 ;; trampclient filename.c
5532 ;; as an editor, and the _current_ shell would connect to an Emacs
5533 ;; server and would be used in an existing non-privileged Emacs
5534 ;; session for doing the editing in question.
5535 ;; That way, I need not tell Emacs my password again and be afraid
5536 ;; that it makes it into core dumps or other ugly stuff (I had Emacs
5537 ;; once display a just typed password in the context of a keyboard
5538 ;; sequence prompt for a question immediately following in a shell
5539 ;; script run within Emacs -- nasty).
5540 ;; And if I have some ssh session running to a different computer,
5541 ;; having the possibility of passing a local file there to a local
5542 ;; Emacs session (in case I can arrange for a connection back) would
5543 ;; be nice.
5544 ;; Likely the corresponding Tramp server should not allow the
5545 ;; equivalent of the emacsclient -eval option in order to make this
5546 ;; reasonably unproblematic. And maybe trampclient should have some
5547 ;; way of passing credentials, like by using an SSL socket or
5548 ;; something. (David Kastrup)
5549 ;; * Reconnect directly to a compliant shell without first going
5550 ;; through the user's default shell. (Pete Forman)
5551 ;; * How can I interrupt the remote process with a signal
5552 ;; (interrupt-process seems not to work)? (Markus Triska)
5553 ;; * Avoid the local shell entirely for starting remote processes. If
5554 ;; so, I think even a signal, when delivered directly to the local
5555 ;; SSH instance, would correctly be propagated to the remote process
5556 ;; automatically; possibly SSH would have to be started with
5557 ;; "-t". (Markus Triska)
5558 ;; * It makes me wonder if tramp couldn't fall back to ssh when scp
5559 ;; isn't on the remote host. (Mark A. Hershberger)
5560 ;; * Use lsh instead of ssh. (Alfred M. Szmidt)
5561 ;; * Optimize out-of-band copying when both methods are scp-like (not
5562 ;; rsync).
5563 ;; * Keep a second connection open for out-of-band methods like scp or
5564 ;; rsync.
5566 ;;; tramp-sh.el ends here